feat: add config ci command and refactor interfaces

Add 'func config ci' command as foundation for GitHub Actions
workflow generation. Extract function loader/saver interfaces
into cmd/common package and create cmd/testing factory for
reusable test helpers.

Issue SRVOCF-744

Signed-off-by: Stanislav Jakuschevskij <[email protected]>

Author: twoGiants

cmd/common/common.go

@@ -0,0 +1,47 @@
+package common
+
+import (
+	"fmt"
+
+	fn "knative.dev/func/pkg/functions"
+)
+
+// DefaultLoaderSaver implements FunctionLoaderSaver composite interface
+var DefaultLoaderSaver standardLoaderSaver
+
+// FunctionLoader loads a function from a filesystem path.
+type FunctionLoader interface {
+	Load(path string) (fn.Function, error)
+}
+
+// FunctionSaver persists a function to storage.
+type FunctionSaver interface {
+	Save(f fn.Function) error
+}
+
+// FunctionLoaderSaver combines loading and saving capabilities for functions.
+type FunctionLoaderSaver interface {
+	FunctionLoader
+	FunctionSaver
+}
+
+type standardLoaderSaver struct{}
+
+// Load creates and validates a function from the given filesystem path.
+func (s standardLoaderSaver) Load(path string) (fn.Function, error) {
+	f, err := fn.NewFunction(path)
+	if err != nil {
+		return fn.Function{}, fmt.Errorf("failed to create new function (path: %q): %w", path, err)
+	}
+
+	if !f.Initialized() {
+		return fn.Function{}, fn.NewErrNotInitialized(f.Root)
+	}
+
+	return f, nil
+}
+
+// Save writes the function configuration to disk.
+func (s standardLoaderSaver) Save(f fn.Function) error {
+	return f.Write()
+}

cmd/common/common_test.go

@@ -0,0 +1,51 @@
+package common_test
+
+import (
+	"testing"
+
+	"gotest.tools/v3/assert"
+	"knative.dev/func/cmd/common"
+	cmdTest "knative.dev/func/cmd/testing"
+	fn "knative.dev/func/pkg/functions"
+	fnTest "knative.dev/func/pkg/testing"
+)
+
+func TestDefaultLoaderSaver_SuccessfulLoad(t *testing.T) {
+	existingFunc := cmdTest.CreateFuncInTempDir(t, "ls-func")
+
+	actualFunc, err := common.DefaultLoaderSaver.Load(existingFunc.Root)
+
+	assert.NilError(t, err)
+	assert.Equal(t, existingFunc.Name, actualFunc.Name)
+}
+
+func TestDefaultLoaderSaver_GenericFuncCreateError_WhenFuncPathInvalid(t *testing.T) {
+	_, err := common.DefaultLoaderSaver.Load("/non-existing-path")
+
+	assert.ErrorContains(t, err, "failed to create new function")
+}
+
+func TestDefaultLoaderSaver_IsNotInitializedError_WhenNoFuncAtPath(t *testing.T) {
+	expectedErrMsg := fn.NewErrNotInitialized(fnTest.Cwd()).Error()
+
+	_, err := common.DefaultLoaderSaver.Load(fnTest.Cwd())
+
+	assert.Error(t, err, expectedErrMsg)
+}
+
+func TestDefaultLoaderSaver_SuccessfulSave(t *testing.T) {
+	existingFunc := cmdTest.CreateFuncInTempDir(t, "")
+	name := "environment"
+	value := "test"
+	existingFunc.Run.Envs = append(existingFunc.Run.Envs, fn.Env{Name: &name, Value: &value})
+
+	err := common.DefaultLoaderSaver.Save(existingFunc)
+
+	assert.NilError(t, err)
+}
+
+func TestDefaultLoaderSaver_ForwardsSaveError(t *testing.T) {
+	err := common.DefaultLoaderSaver.Save(fn.Function{})
+
+	assert.Error(t, err, "function root path is required")
+}

cmd/config.go

@@ -7,43 +7,12 @@ import (
 	"github.com/ory/viper"
 	"github.com/spf13/cobra"
 
+	"knative.dev/func/cmd/common"
 	"knative.dev/func/pkg/config"
 	fn "knative.dev/func/pkg/functions"
 )
 
-type functionLoader interface {
-	Load(path string) (fn.Function, error)
-}
-
-type functionSaver interface {
-	Save(f fn.Function) error
-}
-
-type functionLoaderSaver interface {
-	functionLoader
-	functionSaver
-}
-
-type standardLoaderSaver struct{}
-
-func (s standardLoaderSaver) Load(path string) (fn.Function, error) {
-	f, err := fn.NewFunction(path)
-	if err != nil {
-		return fn.Function{}, fmt.Errorf("failed to create new function (path: %q): %w", path, err)
-	}
-	if !f.Initialized() {
-		return fn.Function{}, fn.NewErrNotInitialized(f.Root)
-	}
-	return f, nil
-}
-
-func (s standardLoaderSaver) Save(f fn.Function) error {
-	return f.Write()
-}
-
-var defaultLoaderSaver standardLoaderSaver
-
-func NewConfigCmd(loadSaver functionLoaderSaver, newClient ClientFactory) *cobra.Command {
+func NewConfigCmd(loadSaver common.FunctionLoaderSaver, newClient ClientFactory) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "config",
 		Short: "Configure a function",
@@ -69,13 +38,14 @@ or from the directory specified with --path.
 	cmd.AddCommand(NewConfigLabelsCmd(loadSaver))
 	cmd.AddCommand(NewConfigEnvsCmd(loadSaver))
 	cmd.AddCommand(NewConfigVolumesCmd())
+	cmd.AddCommand(NewConfigCICmd(loadSaver))
 
 	return cmd
 }
 
 func runConfigCmd(cmd *cobra.Command, args []string) (err error) {
 
-	function, err := initConfigCommand(defaultLoaderSaver)
+	function, err := initConfigCommand(common.DefaultLoaderSaver)
 	if err != nil {
 		return
 	}
@@ -117,7 +87,7 @@ func runConfigCmd(cmd *cobra.Command, args []string) (err error) {
 		case "Environment variables":
 			err = runAddEnvsPrompt(cmd.Context(), function)
 		case "Labels":
-			err = runAddLabelsPrompt(cmd.Context(), function, defaultLoaderSaver)
+			err = runAddLabelsPrompt(cmd.Context(), function, common.DefaultLoaderSaver)
 		case "Git":
 			err = runConfigGitSetCmd(cmd, NewClient)
 		}
@@ -128,7 +98,7 @@ func runConfigCmd(cmd *cobra.Command, args []string) (err error) {
 		case "Environment variables":
 			err = runRemoveEnvsPrompt(function)
 		case "Labels":
-			err = runRemoveLabelsPrompt(function, defaultLoaderSaver)
+			err = runRemoveLabelsPrompt(function, common.DefaultLoaderSaver)
 		case "Git":
 			err = runConfigGitRemoveCmd(cmd, NewClient)
 		}
@@ -163,7 +133,7 @@ func newConfigCmdConfig() configCmdConfig {
 	}
 }
 
-func initConfigCommand(loader functionLoader) (fn.Function, error) {
+func initConfigCommand(loader common.FunctionLoader) (fn.Function, error) {
 	config := newConfigCmdConfig()
 
 	function, err := loader.Load(config.Path)

cmd/config_ci.go

@@ -0,0 +1,38 @@
+package cmd
+
+import (
+	"github.com/spf13/cobra"
+	"knative.dev/func/cmd/common"
+)
+
+func NewConfigCICmd(loaderSaver common.FunctionLoaderSaver) *cobra.Command {
+	cmd := &cobra.Command{
+		Use: "ci",
+		RunE: func(cmd *cobra.Command, args []string) (err error) {
+			return runConfigCIGithub(loaderSaver)
+		},
+	}
+
+	addGithubFlag(cmd)
+
+	return cmd
+}
+
+func runConfigCIGithub(
+	loaderSaver common.FunctionLoaderSaver,
+) error {
+	if _, err := initConfigCommand(loaderSaver); err != nil {
+		return err
+	}
+
+	return nil
+}
+
+func addGithubFlag(cmd *cobra.Command) {
+	cmd.Flags().BoolP(
+		"github",
+		"",
+		false,
+		"Generate GitHub Action ci workflow",
+	)
+}

cmd/config_ci_test.go

@@ -0,0 +1,73 @@
+package cmd_test
+
+import (
+	"testing"
+
+	"github.com/spf13/cobra"
+	"gotest.tools/v3/assert"
+	fnCmd "knative.dev/func/cmd"
+	"knative.dev/func/cmd/common"
+	cmdTest "knative.dev/func/cmd/testing"
+	fn "knative.dev/func/pkg/functions"
+	fnTest "knative.dev/func/pkg/testing"
+)
+
+func TestNewConfigCICmd_CommandExists(t *testing.T) {
+	opts := ciOpts{withMockLoaderSaver: true, args: []string{"ci", "--github"}}
+	cmd := configCIGithubCmd(t, opts)
+
+	err := cmd.Execute()
+
+	assert.NilError(t, err)
+}
+
+func TestNewConfigCICmd_FailsWhenNotInitialized(t *testing.T) {
+	expectedErrMsg := fn.NewErrNotInitialized(fnTest.Cwd()).Error()
+	cmd := configCIGithubCmd(t, ciOpts{})
+
+	err := cmd.Execute()
+
+	assert.Error(t, err, expectedErrMsg)
+}
+
+func TestNewConfigCICmd_SuccessWhenInitialized(t *testing.T) {
+	cmd := configCIGithubCmd(t, ciOpts{withFuncInTempDir: true})
+
+	err := cmd.Execute()
+
+	assert.NilError(t, err)
+}
+
+// START: Testing Framework
+// ------------------------
+type ciOpts struct {
+	withMockLoaderSaver bool     // default: false
+	withFuncInTempDir   bool     // default: false
+	args                []string // default: ci --github
+}
+
+func configCIGithubCmd(
+	t *testing.T,
+	opts ciOpts,
+) *cobra.Command {
+	t.Helper()
+
+	if opts.withFuncInTempDir {
+		_ = cmdTest.CreateFuncInTempDir(t, "github-ci-func")
+	}
+
+	var loaderSaver common.FunctionLoaderSaver = common.DefaultLoaderSaver
+	if opts.withMockLoaderSaver {
+		loaderSaver = newMockLoaderSaver()
+	}
+
+	args := opts.args
+	if len(opts.args) == 0 {
+		args = []string{"ci", "--github"}
+	}
+
+	result := fnCmd.NewConfigCmd(loaderSaver, fnCmd.NewClient)
+	result.SetArgs(args)
+
+	return result
+}

cmd/config_envs.go

@@ -13,13 +13,14 @@ import (
 	"github.com/ory/viper"
 	"github.com/spf13/cobra"
 
+	"knative.dev/func/cmd/common"
 	"knative.dev/func/pkg/config"
 	fn "knative.dev/func/pkg/functions"
 	"knative.dev/func/pkg/k8s"
 	"knative.dev/func/pkg/utils"
 )
 
-func NewConfigEnvsCmd(loadSaver functionLoaderSaver) *cobra.Command {
+func NewConfigEnvsCmd(loadSaver common.FunctionLoaderSaver) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "envs",
 		Short: "List and manage configured environment variable for a function",
@@ -64,7 +65,7 @@ the current directory or from the directory specified with --path.
 	return cmd
 }
 
-func NewConfigEnvsAddCmd(loadSaver functionLoaderSaver) *cobra.Command {
+func NewConfigEnvsAddCmd(loadSaver common.FunctionLoaderSaver) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "add",
 		Short: "Add environment variable to the function configuration",
@@ -139,7 +140,7 @@ set environment variable from a secret
 	return cmd
 }
 
-func NewConfigEnvsRemoveCmd(loadSaver functionLoaderSaver) *cobra.Command {
+func NewConfigEnvsRemoveCmd(loadSaver common.FunctionLoaderSaver) *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "remove",
 		Short: "Remove environment variable from the function configuration",

cmd/config_labels.go

@@ -11,12 +11,13 @@ import (
 	"github.com/ory/viper"
 	"github.com/spf13/cobra"
 
+	"knative.dev/func/cmd/common"
 	"knative.dev/func/pkg/config"
 	fn "knative.dev/func/pkg/functions"
 	"knative.dev/func/pkg/utils"
 )
 
-func NewConfigLabelsCmd(loaderSaver functionLoaderSaver) *cobra.Command {
+func NewConfigLabelsCmd(loaderSaver common.FunctionLoaderSaver) *cobra.Command {
 	var configLabelsCmd = &cobra.Command{
 		Use:   "labels",
 		Short: "List and manage configured labels for a function",
@@ -184,7 +185,7 @@ func listLabels(f fn.Function, w io.Writer, outputFormat Format) error {
 	}
 }
 
-func runAddLabelsPrompt(_ context.Context, f fn.Function, saver functionSaver) (err error) {
+func runAddLabelsPrompt(_ context.Context, f fn.Function, saver common.FunctionSaver) (err error) {
 
 	insertToIndex := 0
 
@@ -317,7 +318,7 @@ func runAddLabelsPrompt(_ context.Context, f fn.Function, saver functionSaver) (
 	return
 }
 
-func runRemoveLabelsPrompt(f fn.Function, saver functionSaver) (err error) {
+func runRemoveLabelsPrompt(f fn.Function, saver common.FunctionSaver) (err error) {
 	if len(f.Deploy.Labels) == 0 {
 		fmt.Println("There aren't any configured labels")
 		return