chore: add go fuzz support #39
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| //go:build go1.18 | ||
|
|
||
| package cli | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "strings" | ||
| "testing" | ||
|
|
||
| "github.com/mineiros-io/terradoc/internal/parsers/docparser" | ||
| "github.com/mineiros-io/terradoc/internal/renderers/markdown" | ||
| ) | ||
|
|
||
| func FuzzGenerate(f *testing.F) { | ||
| seedCorpus := []string{ | ||
| `section { | ||
| title = "test" | ||
| variable "module_enabled" { | ||
| type = bool | ||
| } | ||
| }`, | ||
| `section { | ||
| title = "test" | ||
| section { | ||
| a = 1 | ||
| } | ||
| }`, | ||
| `section { | ||
| variable "local_secondary_indexes" { | ||
| type = any | ||
| readme_type = "list(local_secondary_index)" | ||
| } | ||
| }`, | ||
| } | ||
|
|
||
| for _, seed := range seedCorpus { | ||
| f.Add(seed) | ||
| } | ||
|
|
||
| f.Fuzz(func(t *testing.T, str string) { | ||
| r := strings.NewReader(str) | ||
| w := bytes.Buffer{} | ||
|
|
||
| def, err := docparser.Parse(r, "in.hcl") | ||
| if err != nil { | ||
| return | ||
| } | ||
|
|
||
| _ = markdown.Render(&w, def) | ||
| }) | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| go test fuzz v1 | ||
| string("section{\nvariable\"\"{\ntype=\"\"\n}\n}") |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
hmm maybe one property to check here is that if parsing worked, calling render should always write something on
wif the return err is nil (not 100% sure this is always true, so maybe @thiesen can confirm). Like if the render suceeded, I think it always renders something, there is no scenario for empty rendering on terradoc I think 🤔 . But this can be done later anyway.