Merge pull request #10 from jhrozek/list

Add ghactions list

cmd/ghactions/ghactions.go

@@ -51,6 +51,7 @@ for the given directory.
 
 	// sub-commands
 	cmd.AddCommand(CmdOne())
+	cmd.AddCommand(CmdList())
 
 	return cmd
 }

cmd/ghactions/list.go

@@ -0,0 +1,77 @@
+//
+// Copyright 2023 Stacklok, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+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"
+)
+
+// CmdList represents the one sub-command
+func CmdList() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "list",
+		Short: "Lists the used github actions",
+		Long: `This utility lists all the github actions used in the workflows
+
+Example: 
+	frizbee ghactions list
+`,
+		RunE:         list,
+		SilenceUsage: true,
+	}
+
+	cmd.Flags().StringP("dir", "d", ".github/workflows", "workflows directory")
+
+	return cmd
+}
+
+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
+	})
+	if err != nil {
+		return err
+	}
+
+	jsonBytes, err := json.MarshalIndent(actions, "", "  ")
+	if err != nil {
+		return fmt.Errorf("failed to marshal actions: %w", err)
+	}
+	jsonString := string(jsonBytes)
+
+	fmt.Fprintf(cmd.OutOrStdout(), "%s\n", jsonString)
+	return nil
+}

pkg/ghactions/ghactions.go

@@ -124,3 +124,61 @@ func ModifyReferencesInYAML(ctx context.Context, ghcli *github.Client, node *yam
 	}
 	return modified, nil
 }
+
+// Action represents an action reference.
+type Action struct {
+	Owner string
+	Repo  string
+	Ref   string
+}
+
+// ListActionsInYAML returns a list of actions referenced in the given YAML structure.
+func ListActionsInYAML(node *yaml.Node) ([]Action, error) {
+	var uses []Action
+	foundUses := false
+
+	for _, v := range node.Content {
+		if v.Value == "uses" {
+			foundUses = true
+			continue
+		}
+
+		if foundUses {
+			foundUses = false
+			a, err := parseValue(v.Value)
+			if err != nil {
+				return nil, fmt.Errorf("failed to parse action reference '%s': %w", v.Value, err)
+			}
+
+			uses = append(uses, *a)
+			continue
+		}
+
+		// Otherwise recursively look more
+		childUses, err := ListActionsInYAML(v)
+		if err != nil {
+			return nil, err
+		}
+		uses = append(uses, childUses...)
+	}
+
+	return uses, nil
+}
+
+func parseValue(val string) (*Action, error) {
+	action, ref, err := ParseActionReference(val)
+	if err != nil {
+		return nil, fmt.Errorf("failed to parse action reference '%s': %w", val, err)
+	}
+
+	owner, repo, err := parseActionFragments(action)
+	if err != nil {
+		return nil, fmt.Errorf("failed to parse action fragments '%s': %w", action, err)
+	}
+
+	return &Action{
+		Owner: owner,
+		Repo:  repo,
+		Ref:   ref,
+	}, nil
+}