Add mindev ruletype init to kick off a rule type
#5228
Conversation
This helps folks set up the basic skeleton for ruletype writing. Signed-off-by: Juan Antonio Osorio <[email protected]>
JAORMX
force-pushed
the
ruletype-scaffold
branch
from
213adf2 to
daa24a2
Compare
| } | ||
|
|
||
| func createRuleTypeFile(fileName, name string) error { | ||
| return createFileWithContent(fileName, fmt.Sprintf(`--- |
There was a problem hiding this comment.
It feels like we should use text/template here rather than fmt.Sprintf, particularly if we start to input more data before outputting the rule.
| # http: | ||
| # body_file: HTTP_BODY_FILE | ||
| # git: | ||
| # repo_base: REPO_BASE_PATH |
There was a problem hiding this comment.
It feels like these could benefit from a bit more documentation in a comment, e.g.
| # http: | |
| # body_file: HTTP_BODY_FILE | |
| # git: | |
| # repo_base: REPO_BASE_PATH | |
| # When testing a rule, additional content can be supplied | |
| # from files in the `{{ .RuleName }}.testdata` directory. | |
| # File paths below are relative to this directory. | |
| # http: | |
| # # Input from the `http` ingest type. | |
| # body_file: HTTP_BODY_FILE | |
| # git: | |
| # # Input from the `git` ingest type. Base paths contain | |
| # # directory contents, but do not actually need to be a | |
| # # git repository. | |
| # repo_base: REPO_BASE_PATH |
| file, err := os.Create(filepath.Clean(fileName)) | ||
| if err != nil { | ||
| return fmt.Errorf("error creating file %s: %w", fileName, err) | ||
| } | ||
| defer file.Close() | ||
|
|
||
| if _, err := file.WriteString(content); err != nil { | ||
| return fmt.Errorf("error writing to file %s: %w", fileName, err) | ||
| } | ||
|
|
||
| return nil |
There was a problem hiding this comment.
Can we simply use os.WriteFile(fileName, byte[](content), 0644) for this?
| func assertFilesDontExist(files ...string) error { | ||
| for _, file := range files { | ||
| if _, err := os.Stat(file); err == nil { | ||
|
|
| for _, file := range files { | ||
| if _, err := os.Stat(file); err == nil { | ||
|
|
||
| return fmt.Errorf("file %s already exists", file) |
There was a problem hiding this comment.
Not sure if you want to check os.IsExist(err) here before returning this error -- there could be a different reason the stat fails, like a missing parent directory.
| return errors.New("name cannot be empty") | ||
| } | ||
|
|
||
| validName := regexp.MustCompile(`^[a-zA-Z0-9_]+$`) |
There was a problem hiding this comment.
This is a different regex from https://github.com/mindersec/minder/blob/main/proto/minder/v1/minder.proto#L2496. Not sure if we want to try to re-use that validation?
| return initCmd | ||
| } | ||
|
|
||
| func initCmdRun(cmd *cobra.Command, args []string) error { |
There was a problem hiding this comment.
What do you think about having this operate in a more "wizard" style in terms of prompting for missing data rather than people needing to figure out the flag arguments up front and then getting a file with a bunch of comments to fill in?
Summary
This helps folks set up the basic skeleton for ruletype writing.
Fixes #(related issue)
Change Type
Mark the type of change your PR introduces:
Testing
Outline how the changes were tested, including steps to reproduce and any relevant configurations.
Attach screenshots if helpful.
Review Checklist: