feat: add local build workflow and debug options

Adds support for local, remote workflow generation and debug
configuration via command-line flags.

Workflow name and registry login can be configured via flags
too. Debug mode adds workflow_dispatch trigger and func CLI
caching for rapid iterations on workflow runs.

Config creation refactored to use cobra flags.

Issue SRVOCF-744

Signed-off-by: Stanislav Jakuschevskij <sjakusch@redhat.com>

Author: twoGiants

cmd/ci/config.go

@@ -1,6 +1,11 @@
 package ci
 
-import "path/filepath"
+import (
+	"path/filepath"
+
+	"github.com/spf13/cobra"
+	"github.com/spf13/viper"
+)
 
 // CIConfig readonly configuration
 type CIConfig struct {
@@ -12,7 +17,9 @@ type CIConfig struct {
 	registryUserSecretKey,
 	registryPassSecretKey string
 	useRegistryLogin,
-	selfHostedRunner bool
+	useRemoteBuild,
+	selfHostedRunner,
+	debug bool
 }
 
 func (cc *CIConfig) FnGithubWorkflowDir(fnRoot string) string {
@@ -31,10 +38,18 @@ func (cc *CIConfig) UseRegistryLogin() bool {
 	return cc.useRegistryLogin
 }
 
+func (cc *CIConfig) UseRemoteBuild() bool {
+	return cc.useRemoteBuild
+}
+
 func (cc *CIConfig) SelfHostedRunner() bool {
 	return cc.selfHostedRunner
 }
 
+func (cc *CIConfig) UseDebug() bool {
+	return cc.debug
+}
+
 func (cc *CIConfig) KubeconfigSecretKey() string {
 	return cc.kubeconfigSecretKey
 }
@@ -67,7 +82,9 @@ func NewCIConfigBuilder() *ciConfigBuilder {
 			registryUserSecretKey:  "REGISTRY_USERNAME",
 			registryPassSecretKey:  "REGISTRY_PASSWORD",
 			useRegistryLogin:       true,
+			useRemoteBuild:         false,
 			selfHostedRunner:       false,
+			debug:                  false,
 		},
 	}
 }
@@ -97,8 +114,13 @@ func (b *ciConfigBuilder) WithRegistryPassKey(key string) *ciConfigBuilder {
 	return b
 }
 
-func (b *ciConfigBuilder) WithRegistryLogin(useLogin bool) *ciConfigBuilder {
-	b.result.useRegistryLogin = useLogin
+func (b *ciConfigBuilder) WithoutRegistryLogin() *ciConfigBuilder {
+	b.result.useRegistryLogin = false
+	return b
+}
+
+func (b *ciConfigBuilder) WithRemoteBuild() *ciConfigBuilder {
+	b.result.useRemoteBuild = true
 	return b
 }
 
@@ -107,6 +129,50 @@ func (b *ciConfigBuilder) WithSelfHosted(useSelfHosted bool) *ciConfigBuilder {
 	return b
 }
 
+func (b *ciConfigBuilder) WithDebug() *ciConfigBuilder {
+	b.result.debug = true
+	return b
+}
+
 func (b *ciConfigBuilder) Build() CIConfig {
 	return b.result
 }
+
+const (
+	UseRegistryLoginOption       = "use-registry-login"
+	DefaultUseRegistryLoginValue = true
+
+	WorkflowNameOption  = "workflow-name"
+	DefaultWorkflowName = "Remote Build and Deploy"
+)
+
+func NewCiGithubConfigViaViper() CIConfig {
+	result := NewCIConfigBuilder().
+		WithWorkflowName(viper.GetString(WorkflowNameOption))
+
+	if !viper.GetBool(UseRegistryLoginOption) {
+		result.WithoutRegistryLogin()
+	}
+
+	return result.Build()
+}
+
+func NewCiGithubConfigVia(cmd *cobra.Command) (CIConfig, error) {
+	result := NewCIConfigBuilder()
+
+	workflowName, err := cmd.Flags().GetString(WorkflowNameOption)
+	if err != nil {
+		return CIConfig{}, err
+	}
+	result.WithWorkflowName(workflowName)
+
+	useRegistryLogin, err := cmd.Flags().GetBool(UseRegistryLoginOption)
+	if err != nil {
+		return CIConfig{}, err
+	}
+	if !useRegistryLogin {
+		result.WithoutRegistryLogin()
+	}
+
+	return result.Build(), nil
+}

cmd/ci/workflow.go

@@ -1,6 +1,7 @@
 package ci
 
 import (
+	"bytes"
 	"fmt"
 	"os"
 	"path/filepath"
@@ -13,14 +14,31 @@ const (
 	filePerm = 0644 // o: rw,  g|u: r
 )
 
+// TODO(twoGiants)
+//   - encapsulate => create Interface and defaultGithubWorkflow struct
+//   - provide printers for configurable properties
+//   - provide toYamlString for checks in tests
 type GithubWorkflow struct {
 	Name string           `yaml:"name"`
 	On   WorkflowTriggers `yaml:"on"`
 	Jobs map[string]Job   `yaml:"jobs"`
 }
 
 type WorkflowTriggers struct {
-	Push *PushTrigger `yaml:"push,omitempty"`
+	Push             *PushTrigger `yaml:"push,omitempty"`
+	WorkflowDispatch *struct{}    `yaml:"workflow_dispatch,omitempty"`
+}
+
+func newPushTrigger(branch string, debug bool) WorkflowTriggers {
+	result := WorkflowTriggers{
+		Push: &PushTrigger{Branches: []string{branch}},
+	}
+
+	if debug {
+		result.WorkflowDispatch = &struct{}{}
+	}
+
+	return result
 }
 
 type PushTrigger struct {
@@ -34,6 +52,8 @@ type Job struct {
 
 type Step struct {
 	Name string            `yaml:"name,omitempty"`
+	ID   string            `yaml:"id,omitempty"`
+	If   string            `yaml:"if,omitempty"`
 	Uses string            `yaml:"uses,omitempty"`
 	Run  string            `yaml:"run,omitempty"`
 	With map[string]string `yaml:"with,omitempty"`
@@ -43,6 +63,16 @@ func newStep(name string) *Step {
 	return &Step{Name: name}
 }
 
+func (s *Step) withID(id string) *Step {
+	s.ID = id
+	return s
+}
+
+func (s *Step) withIf(ifCond string) *Step {
+	s.If = ifCond
+	return s
+}
+
 func (s *Step) withUses(u string) *Step {
 	s.Uses = u
 	return s
@@ -70,13 +100,17 @@ func NewGithubWorkflow(
 	registryUserSecretKey,
 	registryPassSecretKey string,
 	useRegistryLogin,
-	selfHosted bool,
+	useRemoteBuild,
+	selfHosted,
+	useDebug bool,
 ) *GithubWorkflow {
 	runsOn := "ubuntu-latest"
 	if selfHosted {
 		runsOn = "self-hosted"
 	}
 
+	pushTrigger := newPushTrigger("main", useDebug)
+
 	var steps []Step
 	checkoutCode := newStep("Checkout code").
 		withUses("actions/checkout@v4")
@@ -97,21 +131,35 @@ func NewGithubWorkflow(
 		steps = append(steps, *loginToContainerRegistry)
 	}
 
+	if useDebug {
+		funcCliCache := newStep("Restore func cli from cache").
+			withID("func-cli-cache").
+			withUses("actions/cache@v4").
+			withActionConfig("path", "func").
+			withActionConfig("key", "func-cli-knative-v1.19.1")
+		steps = append(steps, *funcCliCache)
+	}
+
 	installFuncCli := newStep("Install func cli").
 		withUses("gauron99/knative-func-action@main").
 		withActionConfig("version", "knative-v1.19.1").
 		withActionConfig("name", "func")
+	if useDebug {
+		installFuncCli.withIf("${{ steps.func-cli-cache.outputs.cache-hit != 'true' }}")
+	}
 	steps = append(steps, *installFuncCli)
 
+	runFuncDeploy := "func deploy"
+	if useRemoteBuild {
+		runFuncDeploy += " --remote"
+	}
 	deployFunc := newStep("Deploy function").
-		withRun("func deploy --remote --registry=" + newSecret(registryUrlSecretKey) + " -v")
+		withRun(runFuncDeploy + " --registry=" + newSecret(registryUrlSecretKey) + " -v")
 	steps = append(steps, *deployFunc)
 
 	return &GithubWorkflow{
 		Name: name,
-		On: WorkflowTriggers{
-			Push: &PushTrigger{Branches: []string{"main"}},
-		},
+		On:   pushTrigger,
 		Jobs: map[string]Job{
 			"deploy": {
 				RunsOn: runsOn,
@@ -136,7 +184,7 @@ func NewGithubWorkflowFromPath(path string) (*GithubWorkflow, error) {
 }
 
 func (gw *GithubWorkflow) Persist(path string) error {
-	raw, err := yaml.Marshal(gw)
+	raw, err := gw.toYaml()
 	if err != nil {
 		return err
 	}
@@ -153,14 +201,27 @@ func (gw *GithubWorkflow) Persist(path string) error {
 }
 
 func (gw *GithubWorkflow) YamlString() (string, error) {
-	raw, err := yaml.Marshal(gw)
+	raw, err := gw.toYaml()
 	if err != nil {
 		return "", err
 	}
 
 	return string(raw), nil
 }
 
+func (gw *GithubWorkflow) toYaml() ([]byte, error) {
+	var buf bytes.Buffer
+	encoder := yaml.NewEncoder(&buf)
+	encoder.SetIndent(2)
+
+	if err := encoder.Encode(gw); err != nil {
+		return nil, err
+	}
+	encoder.Close()
+
+	return buf.Bytes(), nil
+}
+
 func newSecret(key string) string {
 	return fmt.Sprintf("${{ secrets.%s }}", key)
 }

cmd/ci/workflow_test.go

@@ -16,6 +16,8 @@ func TestGithubWorkflow_PersistAndLoad(t *testing.T) {
 		"REGISTRY_USERNAME",
 		"REGISTRY_PASSWORD",
 		false,
+		false,
+		false,
 		false)
 	tempDir := t.TempDir()
 	targetPath := tempDir + "/" + gw.Name + ".yaml"

cmd/config_ci.go

@@ -10,20 +10,42 @@ import (
 func NewConfigCICmd(loaderSaver common.FunctionLoaderSaver, ciConfig ci.CIConfig) *cobra.Command {
 	cmd := &cobra.Command{
 		Use: "ci",
+		// TODO(twoGiants): needs fix => see comment in runConfigCIGithub
+		PreRunE: bindEnv(ci.UseRegistryLoginOption, ci.WorkflowNameOption),
 		RunE: func(cmd *cobra.Command, args []string) (err error) {
-			return runConfigCIGithub(loaderSaver, ciConfig)
+			return runConfigCIGithub(cmd, loaderSaver, ciConfig)
 		},
 	}
 
 	addGithubFlag(cmd)
+	cmd.Flags().Bool(
+		ci.UseRegistryLoginOption,
+		ci.DefaultUseRegistryLoginValue,
+		"Add a registry login step in the github workflow",
+	)
+	cmd.Flags().String(
+		ci.WorkflowNameOption,
+		ci.DefaultWorkflowName,
+		"Use a custom workflow name",
+	)
 
 	return cmd
 }
 
 func runConfigCIGithub(
+	cmd *cobra.Command,
 	fnLoaderSaver common.FunctionLoaderSaver,
 	ciConfig ci.CIConfig,
 ) error {
+
+	// TODO(twoGiants): broken => can't test with flags --use-registry-login
+	// or --workflow-name => flags aren't propagated to viper
+	// _ = ci.NewCiGithubConfigViaViper()
+	cfg, err := ci.NewCiGithubConfigVia(cmd)
+	if err != nil {
+		return err
+	}
+
 	f, err := initConfigCommand(fnLoaderSaver)
 	if err != nil {
 		return err
@@ -35,8 +57,10 @@ func runConfigCIGithub(
 		ciConfig.RegistryUrlSecretKey(),
 		ciConfig.RegistryUserSecretKey(),
 		ciConfig.RegistryPassSecretKey(),
-		ciConfig.UseRegistryLogin(),
+		cfg.UseRegistryLogin(),
+		ciConfig.UseRemoteBuild(),
 		ciConfig.SelfHostedRunner(),
+		ciConfig.UseDebug(),
 	)
 	if err := githubWorkflow.Persist(ciConfig.FnGithubWorkflowFilepath(f.Root)); err != nil {
 		return err
@@ -46,9 +70,8 @@ func runConfigCIGithub(
 }
 
 func addGithubFlag(cmd *cobra.Command) {
-	cmd.Flags().BoolP(
+	cmd.Flags().Bool(
 		"github",
-		"",
 		false,
 		"Generate GitHub Action ci workflow",
 	)