Joesirianni/bpop 3615 GitHub action set user agent and enhance error logging (#72)

* chore: Additional debug logging and user-agent

* fix glob regression

* refactor glob handling

* refactor glob handling

* Return after applying globbed files

Author: jsirianni

README.md

@@ -28,7 +28,8 @@ Bindplane requires a license. You can request a free license [here](https://obse
 | token                         |          | The Github token that will be used to read and write to the repo. Usually secrets.GITHUB_TOKEN is sufficient. Requires the `contents.write` permission. Alternatively, you can set `github_url`, which should contain your access token. |
 | enable_auto_rollout           | `false`  | When enabled, the action will trigger a rollout for any configuration that has been updated.                                                                                                                                             |
 | tls_ca_cert                   |          | The contents of a TLS certificate authority, usually from a secret. See the [TLS](#tls) section.                                                                                                                                         |
-| github_url                    |          | Optional URL to use when cloning the repository. Should be of the form `"https://{GITHUB_ACTOR}:{TOKEN}@{GITHUB_HOST}/{GITHUB_REPOSITORY}.git`. When set, `token` will not be used.                                                      |
+| github_url                    |          | Optional URL to use when cloning the repository. Should be of the form `"https://{GITHUB_ACTOR}:{TOKEN}@{GITHUB_HOST}/{GITHUB_REPOSITORY}.git". When set, `token` will not be used.                                                      |
+| user_agent                    | `bindplane-op-action` | The user agent string to use when making requests to BindPlane.                                                                                                                                                                           |
 
 ## Usage
 

action.yml

@@ -38,6 +38,9 @@ inputs:
     description: 'The CA certificate to use when connecting to Bindplane'
   github_url:
     description: 'The GitHub URL to use when connecting to GitHub'
+  user_agent:
+    description: 'The user agent string to use when making requests to BindPlane'
+    default: 'bindplane-op-action'
 
 runs:
   using: 'docker'
@@ -60,3 +63,4 @@ runs:
     - ${{ inputs.source_path }}
     - ${{ inputs.processor_path }}
     - ${{ inputs.github_url }}
+    - ${{ inputs.user_agent }}

action/action.go

@@ -14,6 +14,7 @@ import (
 	"github.com/observiq/bindplane-op-action/internal/client/config"
 	"github.com/observiq/bindplane-op-action/internal/client/model"
 	"github.com/observiq/bindplane-op-action/internal/client/version"
+	"github.com/observiq/bindplane-op-action/internal/glob"
 	"github.com/observiq/bindplane-op-action/internal/repo"
 	"gopkg.in/yaml.v3"
 
@@ -139,6 +140,13 @@ func WithConfigurationOutputBranch(b string) Option {
 	}
 }
 
+// WithUserAgent sets the user agent for the BindPlane client
+func WithUserAgent(ua string) Option {
+	return func(a *Action) {
+		a.config.Network.UserAgent = ua
+	}
+}
+
 // New creates a new Action with a configured bindPlane client
 func New(logger *zap.Logger, opts ...Option) (*Action, error) {
 	action := &Action{}
@@ -286,41 +294,60 @@ func (a *Action) Apply() error {
 
 // applyAll takes a file or directory path and applies all resources.
 // It recursively walks through all subdirectories and applies YAML files.
+// It also supports glob patterns like "*.yaml" or "./resources/*.yaml".
 func (a *Action) applyAll(path string) error {
 	info, err := os.Stat(path)
-	if err != nil {
+	switch {
+	case err != nil:
+		if glob.ContainsGlobChars(path) {
+			matches, err := filepath.Glob(path)
+			if err != nil {
+				return fmt.Errorf("glob path %s: %w", path, err)
+			}
+			if len(matches) == 0 {
+				return fmt.Errorf("no matching files found when globbing %s", path)
+			}
+
+			a.Logger.Info("Applying globbed resources", zap.String("path", path), zap.Int("matches", len(matches)))
+
+			for _, match := range matches {
+				if err := a.apply(match); err != nil {
+					return err
+				}
+			}
+			return nil
+		}
 		return fmt.Errorf("stat path %s: %w", path, err)
-	}
 
-	if !info.IsDir() {
+	case !info.IsDir():
 		return a.apply(path)
-	}
 
-	a.Logger.Info("Walking directory", zap.String("path", path))
+	default:
+		a.Logger.Info("Walking directory", zap.String("path", path))
 
-	err = filepath.Walk(path, func(p string, info os.FileInfo, err error) error {
-		if err != nil {
-			a.Logger.Error("Error walking path", zap.String("path", p), zap.Error(err))
-			return err
-		}
+		err = filepath.Walk(path, func(p string, info os.FileInfo, err error) error {
+			if err != nil {
+				a.Logger.Error("Error walking path", zap.String("path", p), zap.Error(err))
+				return err
+			}
 
-		if info.IsDir() {
-			return nil
-		}
+			if info.IsDir() {
+				return nil
+			}
 
-		ext := filepath.Ext(p)
-		if ext != ".yaml" && ext != ".yml" {
-			return nil
-		}
+			ext := filepath.Ext(p)
+			if ext != ".yaml" && ext != ".yml" {
+				return nil
+			}
 
-		if err := a.apply(p); err != nil {
-			return err
-		}
+			return a.apply(p)
+		})
 
+		if err != nil {
+			return fmt.Errorf("walk path %s: %w", path, err)
+		}
 		return nil
-	})
-
-	return err
+	}
 }
 
 // apply takes a file path and applies it to the BindPlane API.
@@ -337,7 +364,7 @@ func (a *Action) apply(path string) error {
 	}
 
 	if resp == nil {
-		return fmt.Errorf("nil response from client: %s", BugError)
+		return fmt.Errorf("nil response from client while applying path %s: %s", path, BugError)
 	}
 
 	for _, s := range resp {

action/action_test.go

@@ -109,6 +109,46 @@ func TestWithBindPlaneUsername(t *testing.T) {
 	}
 }
 
+func TestWithUserAgent(t *testing.T) {
+	cases := []struct {
+		name   string
+		input  string
+		expect *Action
+	}{
+		{
+			"Set user agent",
+			"my-custom-agent",
+			&Action{
+				config: config.Config{
+					Network: config.Network{
+						UserAgent: "my-custom-agent",
+					},
+				},
+			},
+		},
+		{
+			"Set empty user agent",
+			"",
+			&Action{
+				config: config.Config{
+					Network: config.Network{
+						UserAgent: "",
+					},
+				},
+			},
+		},
+	}
+
+	for _, tc := range cases {
+		t.Run(tc.name, func(t *testing.T) {
+			a := &Action{}
+			opt := WithUserAgent(tc.input)
+			opt(a)
+			require.Equal(t, tc.expect, a)
+		})
+	}
+}
+
 func TestWithBindPlanePassword(t *testing.T) {
 	cases := []struct {
 		name   string

cmd/action/args.go

@@ -18,7 +18,7 @@ func parseArgs() error {
 	// Add one to account for arg 0 being the binary name
 	count := argCount + 1
 	if len(args) != count {
-		return fmt.Errorf("Not enough arguments, expected 17, got %d. %s.", len(args), action.BugError)
+		return fmt.Errorf("Not enough arguments, expected 18, got %d. %s.", len(args), action.BugError)
 	}
 
 	// First arg is always the binary name, so we skip it. We could
@@ -64,6 +64,7 @@ func parseArgs() error {
 	source_path = args[14]
 	processor_path = args[15]
 	github_url = args[16]
+	user_agent = args[17]
 
 	return nil
 }

cmd/action/main.go

@@ -16,7 +16,7 @@ import (
 // include the binary name itself (which is returned by os.Args[0]).
 // When adding new arguments to the action, this number should be updated
 // and new global variables should be declared and handled in parseArgs().
-const argCount = 16
+const argCount = 17
 
 // Global variables will be used when creating the action configuration. These
 // are the options set by the user. Their order in parseArgs() is important.
@@ -37,6 +37,7 @@ var (
 	source_path                   string
 	processor_path                string
 	github_url                    string
+	user_agent                    string
 )
 
 const (
@@ -100,6 +101,7 @@ func main() {
 		action.WithBindPlaneUsername(bindplane_username),
 		action.WithBindPlanePassword(bindplane_password),
 		action.WithTLSCACert(tls_ca_cert),
+		action.WithUserAgent(user_agent),
 
 		// Base action options for reading resources
 		// from the repo, to apply to bindplane

cmd/action/validate.go

@@ -4,9 +4,11 @@ import (
 	"fmt"
 	"net/url"
 	"os"
+	"path/filepath"
 
 	"github.com/observiq/bindplane-op-action/action"
 	"github.com/observiq/bindplane-op-action/internal/client/model"
+	"github.com/observiq/bindplane-op-action/internal/glob"
 )
 
 func validate() error {
@@ -136,12 +138,23 @@ func validateFilePaths() error {
 			continue
 		}
 
-		_, err := os.Stat(path)
-		if err != nil {
-			if os.IsNotExist(err) {
-				return fmt.Errorf("%s path %s does not exist", kind, path)
+		// Check if the path contains glob pattern characters
+		if glob.ContainsGlobChars(path) {
+			matches, err := filepath.Glob(path)
+			if err != nil {
+				return fmt.Errorf("globbing %s path %s: %w", kind, path, err)
+			}
+			if len(matches) == 0 {
+				return fmt.Errorf("%s path %s does not match any files", kind, path)
+			}
+		} else {
+			_, err := os.Stat(path)
+			if err != nil {
+				if os.IsNotExist(err) {
+					return fmt.Errorf("%s path %s does not exist", kind, path)
+				}
+				return fmt.Errorf("stat %s path %s: %w", kind, path, err)
 			}
-			return fmt.Errorf("stat %s path %s: %w", kind, path, err)
 		}
 	}
 

internal/client/client.go

@@ -19,7 +19,8 @@ import (
 const (
 	KeyHeader = "X-Bindplane-Api-Key"
 
-	DefaultTimeout = time.Second * 60
+	DefaultTimeout   = time.Second * 60
+	DefaultUserAgent = "bindplane-op-action"
 )
 
 type BindPlane struct {
@@ -44,6 +45,12 @@ func NewBindPlane(config *config.Config, logger *zap.Logger) (*BindPlane, error)
 
 	restryClient.SetBaseURL(fmt.Sprintf("%s/v1", config.Network.RemoteURL))
 
+	userAgent := DefaultUserAgent
+	if config.Network.UserAgent != "" {
+		userAgent = config.Network.UserAgent
+	}
+	restryClient.SetHeader("User-Agent", userAgent)
+
 	tlsConfig := &tls.Config{
 		MinVersion: tls.VersionTLS13,
 	}

internal/client/config/config.go

@@ -14,6 +14,7 @@ type Auth struct {
 type Network struct {
 	RemoteURL            string
 	CertificateAuthority []string
+	UserAgent            string
 	TLS
 }
 

internal/glob/glob.go

@@ -0,0 +1,8 @@
+package glob
+
+import "strings"
+
+// ContainsGlobChars checks if a path contains glob pattern characters
+func ContainsGlobChars(path string) bool {
+	return strings.ContainsAny(path, "*?[")
+}