Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use a set for the list to avoid duplicates #12

Merged
merged 1 commit into from
Nov 22, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 2 additions & 17 deletions cmd/ghactions/list.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,8 @@ package ghactions
import (
"encoding/json"
"fmt"
"path/filepath"

"github.com/go-git/go-billy/v5/osfs"
"github.com/spf13/cobra"
"gopkg.in/yaml.v3"

"github.com/stacklok/frizbee/pkg/ghactions"
)
Expand All @@ -49,21 +46,9 @@ Example:
func list(cmd *cobra.Command, _ []string) error {
dir := cmd.Flag("dir").Value.String()

base := filepath.Base(dir)
bfs := osfs.New(filepath.Dir(dir), osfs.WithBoundOS())
actions := []ghactions.Action{}

err := ghactions.TraverseGitHubActionWorkflows(bfs, base, func(path string, wflow *yaml.Node) error {
wfActions, err := ghactions.ListActionsInYAML(wflow)
if err != nil {
return fmt.Errorf("failed to get actions from YAML file %s: %w", path, err)
}
actions = append(actions, wfActions...)

return nil
})
actions, err := ghactions.ListActionsInDirectory(dir)
if err != nil {
return err
return fmt.Errorf("failed to list actions: %w", err)
}

jsonBytes, err := json.MarshalIndent(actions, "", " ")
Expand Down
1 change: 1 addition & 0 deletions go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ require (
require (
github.com/cyphar/filepath-securejoin v0.2.4 // indirect
github.com/davecgh/go-spew v1.1.1 // indirect
github.com/deckarep/golang-set/v2 v2.3.1 // indirect
github.com/google/go-querystring v1.1.0 // indirect
github.com/inconshreveable/mousetrap v1.1.0 // indirect
github.com/pmezard/go-difflib v1.0.0 // indirect
Expand Down
2 changes: 2 additions & 0 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ github.com/cyphar/filepath-securejoin v0.2.4 h1:Ugdm7cg7i6ZK6x3xDF1oEu1nfkyfH53E
github.com/cyphar/filepath-securejoin v0.2.4/go.mod h1:aPGpWjXOXUn2NCNjFvBE6aRxGGx79pTxQpKOJNYHHl4=
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/deckarep/golang-set/v2 v2.3.1 h1:vjmkvJt/IV27WXPyYQpAh4bRyWJc5Y435D17XQ9QU5A=
github.com/deckarep/golang-set/v2 v2.3.1/go.mod h1:VAky9rY/yGXJOLEDv3OMci+7wtDpOF4IN+y82NBOac4=
github.com/go-git/go-billy/v5 v5.5.0 h1:yEY4yhzCDuMGSv83oGxiBotRzhwhNr8VZyphhiu+mTU=
github.com/go-git/go-billy/v5 v5.5.0/go.mod h1:hmexnoNsr2SJU1Ju67OaNz5ASJY3+sHgFRpCtpDCKow=
github.com/google/go-cmp v0.5.2/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
Expand Down
56 changes: 50 additions & 6 deletions pkg/ghactions/ghactions.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,11 @@ package ghactions
import (
"context"
"fmt"
"path/filepath"
"strings"

mapset "github.com/deckarep/golang-set/v2"
"github.com/go-git/go-billy/v5/osfs"
"github.com/google/go-github/v56/github"
"gopkg.in/yaml.v3"

Expand Down Expand Up @@ -139,8 +142,8 @@ type Action struct {
}

// ListActionsInYAML returns a list of actions referenced in the given YAML structure.
func ListActionsInYAML(node *yaml.Node) ([]Action, error) {
var uses []Action
func setOfActions(node *yaml.Node) (mapset.Set[Action], error) {
actions := mapset.NewSet[Action]()
foundUses := false

for _, v := range node.Content {
Expand All @@ -156,19 +159,60 @@ func ListActionsInYAML(node *yaml.Node) ([]Action, error) {
return nil, fmt.Errorf("failed to parse action reference '%s': %w", v.Value, err)
}

uses = append(uses, *a)
actions.Add(*a)
continue
}

// Otherwise recursively look more
childUses, err := ListActionsInYAML(v)
childUses, err := setOfActions(v)
if err != nil {
return nil, err
}
uses = append(uses, childUses...)
actions = actions.Union(childUses)
}

return actions, nil
}

// ListActionsInYAML returns a list of actions referenced in the given YAML structure.
func ListActionsInYAML(node *yaml.Node) ([]Action, error) {
// just convert the set to a slice
actions, err := setOfActions(node)
if err != nil {
return nil, err
}

return setAsSlice[Action](actions), nil
}

// ListActionsInDirectory returns a list of actions referenced in the given directory.
func ListActionsInDirectory(dir string) ([]Action, error) {
base := filepath.Base(dir)
bfs := osfs.New(filepath.Dir(dir), osfs.WithBoundOS())
actions := mapset.NewSet[Action]()

err := TraverseGitHubActionWorkflows(bfs, base, func(path string, wflow *yaml.Node) error {
wfActions, err := setOfActions(wflow)
if err != nil {
return fmt.Errorf("failed to get actions from YAML file %s: %w", path, err)
}

actions = actions.Union(wfActions)
return nil
})
if err != nil {
return nil, err
}

return uses, nil
return setAsSlice[Action](actions), nil
}

func setAsSlice[T comparable](s mapset.Set[T]) []T {
res := make([]T, 0, s.Cardinality())
for item := range s.Iter() {
res = append(res, item) // Type assertion to T
}
return res
}

func parseValue(val string) (*Action, error) {
Expand Down