support directory walking and multiple documents per file #244
Conversation
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 extends the directory support to include recursive directories for further organization. Additionally, this adds support for multiple yaml documents in a single file which allows for simple organization without cluttering folders. Signed-off-by: Mike Mason <[email protected]>
jnschaeffer
requested changes
Apr 16, 2024
cmd/schema.go
Outdated
Comment on lines
79
to
101
| err := filepath.WalkDir(cfg.SpiceDB.PolicyDir, func(path string, entry fs.DirEntry, err error) error { | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| for _, file := range files { | ||
| if !file.IsDir() && (strings.EqualFold(filepath.Ext(file.Name()), ".yml") || strings.EqualFold(filepath.Ext(file.Name()), ".yaml")) { | ||
| filePaths = append(filePaths, cfg.SpiceDB.PolicyDir+"/"+file.Name()) | ||
| if entry.IsDir() { | ||
| return nil | ||
| } | ||
|
|
||
| ext := filepath.Ext(entry.Name()) | ||
|
|
||
| if strings.EqualFold(ext, ".yml") || strings.EqualFold(ext, ".yaml") { | ||
| filePaths = append(filePaths, path) | ||
| } | ||
|
|
||
| return nil | ||
| }) | ||
|
|
||
| if err != nil { | ||
| logger.Fatalw("failed to read policy files from directory", "error", err) | ||
| } | ||
|
|
||
| outputPolicyMermaid(filePaths, viper.GetBool("mermaid-markdown")) |
There was a problem hiding this comment.
It looks like this code path ultimately leads to creating a policy anyway. Can we just use NewPolicyFromDirectory here rather than duplicate logic?
There was a problem hiding this comment.
We cannot, as NewPolicyFromDirectory returns a Policy which is a compiled policy, where as the mermaid document works off the raw PolicyDocument structure.
Once converted to a Policy we lose some helpful details for generating the mermaid document.
However we could just create NewPolicyDocumentFromDirectory which contains the logic that both NewPolicyFromDirectory and the mermaid code could use.
There was a problem hiding this comment.
Split this out into LoadPolicyDocumentFromDirectory which now both can use.
…w policies and mermaid to remove duplicate code Signed-off-by: Mike Mason <[email protected]>
jnschaeffer
approved these changes
Apr 17, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This extends the directory support to include recursive directories for further organization.
Additionally, this adds support for multiple yaml documents in a single file which allows for simple organization without cluttering folders unnecessarily.