chore: add validation for module source URLs #406
Conversation
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 53b912b..eb3cf8b 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -63,8 +63,8 @@ jobs: - name: Set up Go uses: actions/setup-go@v5 with: - go-version: "1.23.2" - - name: Validate contributors + go-version: "1.25.0" + - name: Validate Reademde run: go build ./cmd/readmevalidation && ./readmevalidation - name: Remove build file artifact run: rm ./readmevalidation Signed-off-by: Muhammad Atif Ali <[email protected]>
98efa49 to
898e773
Compare
- Downgrade Go version in CI to 1.24 for consistency. - Fix naming and path issues in `readmevalidation` code. - Improve regex validation for module and namespace names. - Correct typos and improve comments for clarity.
898e773 to
3b6b1ba
Compare
| @@ -63,8 +63,8 @@ jobs: | |||
| - name: Set up Go | |||
| uses: actions/setup-go@v5 | |||
| with: | |||
| go-version: "1.23.2" | |||
| - name: Validate contributors | |||
| go-version: "1.24" | |||
There was a problem hiding this comment.
I was having weird issues with running Golang CI locally, and had to match the Go version.
There was a problem hiding this comment.
Tests generated by gemini CLI
cmd/readmevalidation/codermodules.go
Outdated
| return namespace, moduleName, nil | ||
| } | ||
|
|
||
| func validateModuleSourceURL(body string, filePath string) []error { |
There was a problem hiding this comment.
I wish I knew more about Coder templates. Do templates have a source field (or anything equivalent) that might need to be validated, too?
There was a problem hiding this comment.
no its not applicable to templates
cmd/readmevalidation/codermodules.go
Outdated
| if strings.HasPrefix(nextLine, "```") { | ||
| if strings.HasPrefix(nextLine, "```tf") && firstTerraformBlock { | ||
| isInsideTerraform = true | ||
| firstTerraformBlock = false | ||
| } else if isInsideTerraform { | ||
| // End of first terraform block. | ||
| break | ||
| } | ||
| continue | ||
| } |
There was a problem hiding this comment.
I think this can be rewritten as:
if strings.HasPrefix(nextLine, "```") {
if strings.HasPrefix(nextLine, "```tf") {
isInsideTerraform = true
continue
}
if isInsideTerraform {
break
}
}I don't see the point of the firstTerraformBlock variable. If we always break at the end of the first Terraform code block, we don't really need to track anything extra
There was a problem hiding this comment.
The goal is to check all tf blocks.
There was a problem hiding this comment.
Maybe I'm missing something obvious, then. What validation requirement(s) are we trying to fulfill?
I was under the impression that we wanted the first Terraform block to contain a source field, but that other sources could be valid for the other blocks. Are we trying to keep all sources fully "boxed in" for Coder templates?
Not saying that the current code is wrong, but I'm not fully sure what we're trying to protect against, so I just want to make sure I'm giving good feedback
There was a problem hiding this comment.
We want to make sure all sources for all codeblock in a module README.md are in correct format. This should not apply to templates if it does its probably a bug.
There was a problem hiding this comment.
Sorry, I meant "modules" instead of "templates"
But if the goal is to check all Terraform blocks, then we'll need to remove the firstTerraformBlock variable completely.
With how the code is currently set up, once we hit the end of the first block, we always hit the else if block and immediately break out of the loop. We would need to update the loop logic to keep going after reaching the end of a block – flipping isInsideTerraform back to false and then probably just continue
- Make regex more specific for registry.coder.com patterns only - Refactor to add namespace and resourceName fields to coderResourceReadme struct - Inline path parsing logic into parseCoderResourceReadme - Update validateModuleSourceURL to use struct fields instead of filePath parameter - Simplify Terraform block detection logic - Reduce nesting with early continue statements - Add comment explaining regex pattern - Extract registry.coder.com into a constant - Improve test readability with extracted variables - Remove redundant checks in tests - Replace custom contains function with strings.Contains Co-authored-by: matifali <[email protected]>
Would prevents issues like the one I fixed in #404
This change should have caught that error as