prepare cli for the versioning feature

Author: kerak19

.gitignore

@@ -7,6 +7,7 @@
 *.dll
 *.so
 *.dylib
+cycloid-cli
 
 # Test binary, built with `go test -c`
 *.test
@@ -30,4 +31,3 @@ gst
 # direnv
 .direnv
 
-cycloid-cli

Makefile

@@ -152,4 +152,3 @@ ci-test:
 
 .git/hooks/pre-commit:
 	pre-commit-install
-

cmd/cycloid/beta/config/interpolate.go

@@ -25,6 +25,7 @@ func NewInterpolateCmd() *cobra.Command {
 	cyargs.AddStackRefFlag(cmd)
 	cyargs.AddCyContext(cmd)
 	cyargs.AddStackFormsInputFlags(cmd)
+	cyargs.AddStackVersionFlags(cmd)
 	return cmd
 }
 
@@ -57,8 +58,14 @@ func interpolate(cmd *cobra.Command, args []string) error {
 	api := common.NewAPI()
 	m := middleware.NewMiddleware(api)
 
+	// Get the stack version flags
+	tag, branch, hash, err := cyargs.GetStackVersionFlags(cmd)
+	if err != nil {
+		return errors.Wrap(err, "failed to read stack version flags")
+	}
+
 	// Get default to stacks
-	stackConfig, err := m.GetComponentStackConfig(org, project, env, component, useCase)
+	stackConfig, err := m.GetComponentStackConfig(org, project, env, component, useCase, tag, branch, hash)
 	if err != nil {
 		return err
 	}

cmd/cycloid/components/create.go

@@ -27,8 +27,9 @@ func NewCreateComponentCommand() *cobra.Command {
 	cyargs.AddNameFlag(cmd)
 	cyargs.AddComponentDescriptionFlag(cmd)
 	cmd.MarkFlagRequired(cyargs.AddUseCaseFlag(cmd))
+	cyargs.AddStackVersionFlags(cmd)
 	cyargs.AddCloudProviderFlag(cmd)
-	cyargs.AddComponentStackRefFlag(cmd)
+	cmd.MarkFlagRequired(cyargs.AddComponentStackRefFlag(cmd))
 	cyargs.AddStackFormsInputFlags(cmd)
 	cmd.Flags().Bool("update", false, "If the component exists, update it.")
 	return cmd
@@ -83,6 +84,12 @@ func createComponent(cmd *cobra.Command, args []string) error {
 	api := common.NewAPI()
 	m := middleware.NewMiddleware(api)
 
+	// Get the stack version flags
+	tag, branch, hash, err := cyargs.GetStackVersionFlags(cmd)
+	if err != nil {
+		return errors.Wrap(err, "failed to read stack version flags")
+	}
+
 	p, err := factory.GetPrinter(output)
 	if err != nil {
 		return errors.Wrap(err, "unable to get printer")
@@ -115,7 +122,7 @@ func createComponent(cmd *cobra.Command, args []string) error {
 			}
 
 			// ConfigureComponent will reconfigure the component
-			componentOutput, err := m.CreateAndConfigureComponent(org, project, env, component, *description, &name, stackRef, useCase, *cloudProvider, inputs)
+			componentOutput, err := m.CreateAndConfigureComponent(org, project, env, component, *description, name, stackRef, tag, branch, hash, useCase, *cloudProvider, inputs)
 			if err != nil {
 				return printer.SmartPrint(p, nil, err, "failed to configure component '"+component+"'", printer.Options{}, cmd.OutOrStderr())
 			}
@@ -134,7 +141,7 @@ func createComponent(cmd *cobra.Command, args []string) error {
 		return err
 	}
 
-	componentOutput, err := m.CreateAndConfigureComponent(org, project, env, component, *description, &name, stackRef, useCase, *cloudProvider, inputs)
+	componentOutput, err := m.CreateAndConfigureComponent(org, project, env, component, *description, name, stackRef, tag, branch, hash, useCase, *cloudProvider, inputs)
 	if err != nil {
 		return printer.SmartPrint(p, nil, err, "failed to create and configure component '"+component+"'", printer.Options{}, cmd.OutOrStderr())
 	}

cmd/cycloid/components/update.go

@@ -25,9 +25,11 @@ func NewUpdateComponentCommand() *cobra.Command {
 	cyargs.AddNameFlag(cmd)
 	cyargs.AddComponentDescriptionFlag(cmd)
 	cyargs.AddUseCaseFlag(cmd)
+	cyargs.AddStackVersionFlags(cmd)
 	cyargs.AddStackFormsInputFlags(cmd)
 	cyargs.AddStackRefFlag(cmd)
 	cyargs.AddCloudProviderFlag(cmd)
+
 	return cmd
 }
 
@@ -42,6 +44,11 @@ func updateComponent(cmd *cobra.Command, args []string) error {
 		return err
 	}
 
+	if name == "" {
+		// if name is empty, use the canonical
+		name = component
+	}
+
 	description, err := cyargs.GetComponentDescription(cmd)
 	if err != nil {
 		return err
@@ -90,6 +97,12 @@ func updateComponent(cmd *cobra.Command, args []string) error {
 		useCase = currentComponent.UseCase
 	}
 
+	// Get the stack version flags
+	tag, branch, hash, err := cyargs.GetStackVersionFlags(cmd)
+	if err != nil {
+		return errors.Wrap(err, "failed to read stack version flags")
+	}
+
 	var currentConfig = make(models.FormVariables)
 	if currentComponent.IsConfigured {
 		currentConfig, err = m.GetComponentConfig(org, project, env, component)
@@ -104,7 +117,7 @@ func updateComponent(cmd *cobra.Command, args []string) error {
 	}
 
 	// CreateComponent will reconfigure the component if it already exists
-	updatedComponent, err := m.CreateAndConfigureComponent(org, project, env, component, *description, &name, stackRef, useCase, *cloudProvider, inputs)
+	updatedComponent, err := m.CreateAndConfigureComponent(org, project, env, component, *description, name, stackRef, tag, branch, hash, useCase, *cloudProvider, inputs)
 	if err != nil {
 		return printer.SmartPrint(p, nil, err, "failed to configure component '"+component+"'", printer.Options{}, cmd.OutOrStderr())
 	}

cmd/cycloid/middleware/component_pipelines_test.go

@@ -2,17 +2,18 @@ package middleware_test
 
 import (
 	"fmt"
-	"reflect"
 	"strconv"
 	"testing"
 	"time"
+
+	"github.com/stretchr/testify/require"
 )
 
 func TestComponentPipeline(t *testing.T) {
 	m := config.Middleware
 
 	component, err := config.NewTestComponent(
-		*config.Project.Canonical, *config.Environment.Canonical, t.Name(), config.Org+":"+pipelineTestStackCanonical, pipelineTestStackUseCase, pipelineTestDefaultVars,
+		*config.Project.Canonical, *config.Environment.Canonical, t.Name(), config.Org+":"+pipelineTestStackCanonical, pipelineTestStackUseCase, "", "", *config.CatalogRepoVersionStacks.CommitHash, pipelineTestDefaultVars,
 	)
 	if err != nil {
 		t.Errorf("failed to setup base component for test %q: %v", t.Name(), err)
@@ -26,9 +27,8 @@ func TestComponentPipeline(t *testing.T) {
 			return
 		}
 
-		if !reflect.DeepEqual(*got.Component, *component) {
-			t.Fatalf("component in pipeline doesn't match, got:\n%v\nexpect: %v", *got.Component, *component)
-		}
+		got.Component.Project.Owner = component.Project.Owner
+		require.Equal(t, *got.Component, *component)
 	})
 
 	t.Run("PausePipeline", func(t *testing.T) {
@@ -129,15 +129,15 @@ jobs:
 
 			err = m.AbortBuild(config.Org, *config.Project.Canonical, *config.Environment.Canonical, *component.Canonical, *updatedPipeline.Name, *pipelineJobs[0].Name, buildIDStr)
 			if err != nil {
-				t.Fatalf("failed to abort build '%s': %s", buildIDStr, err)
+				t.Errorf("failed to abort build '%s': %s", buildIDStr, err)
 			}
 
 			// // Add a bit of time, concourse seems to not like it
 			// time.Sleep(3 * time.Second)
 			//
 			// _, err = m.RerunBuild(config.Org, *config.Project.Canonical, *config.Environment.Canonical, *component.Canonical, *updatedPipeline.Name, *pipelineJobs[0].Name, buildIDStr)
 			// if err != nil {
-			// 	t.Fatalf("failed to re-run build '%s': %s", buildIDStr, err)
+			// 	t.Errorf("failed to re-run build '%s': %s", buildIDStr, err)
 			// }
 		})
 	})

cmd/cycloid/middleware/infra_policies.go

@@ -44,7 +44,7 @@ func (m *middleware) CreateInfraPolicy(org, policyFile, policyCanonical, descrip
 	// Reads file content and converts it into string
 	policyFileContent, err := os.ReadFile(policyFile)
 	if err != nil {
-		return nil, fmt.Errorf("unable to read rego file: %v", err)
+		return nil, fmt.Errorf("unable to read rego file: %w", err)
 	}
 	// If canonical empty,use the default one
 	if policyCanonical == "" {
@@ -64,7 +64,7 @@ func (m *middleware) CreateInfraPolicy(org, policyFile, policyCanonical, descrip
 
 	err = body.Validate(strfmt.Default)
 	if err != nil {
-		return nil, fmt.Errorf("InfraPolicy invalid: %v", err)
+		return nil, fmt.Errorf("InfraPolicy invalid: %w", err)
 	}
 
 	params.SetBody(body)
@@ -131,7 +131,7 @@ func (m *middleware) UpdateInfraPolicy(org, infraPolicy, policyFile, description
 	// Reads file content and converts it into string
 	policyFileContent, err := os.ReadFile(policyFile)
 	if err != nil {
-		return nil, fmt.Errorf("unable to read rego file: %v", err)
+		return nil, fmt.Errorf("unable to read rego file: %w", err)
 	}
 	policyBody := string(policyFileContent)
 
@@ -146,7 +146,7 @@ func (m *middleware) UpdateInfraPolicy(org, infraPolicy, policyFile, description
 
 	err = body.Validate(strfmt.Default)
 	if err != nil {
-		return nil, fmt.Errorf("InfraPolicy invalid: %v", err)
+		return nil, fmt.Errorf("InfraPolicy invalid: %w", err)
 	}
 
 	params.SetBody(body)

cmd/cycloid/middleware/init_first_org.go

@@ -14,8 +14,8 @@ import (
 // current console.
 // If apiKeyCanonical != nil, will also create an api key admin and add it to a
 // credential.
-func (m *middleware) InitFirstOrg(org, username, fullName, email, password, licence string, apiKeyCanonical *string) (*FirstOrgData, error) {
-	err := m.UserSignup(username, email, password, fullName)
+func (m *middleware) InitFirstOrg(org, userName, fullName, email, password, licence string, apiKeyCanonical *string) (*FirstOrgData, error) {
+	err := m.UserSignup(userName, email, password, fullName)
 	var signupErr *APIError
 	if errors.As(err, &signupErr) {
 		if signupErr.HTTPCode != "409" && err != nil {
@@ -50,7 +50,7 @@ func (m *middleware) InitFirstOrg(org, username, fullName, email, password, lice
 
 	output := &FirstOrgData{
 		Org:      org,
-		Username: username,
+		Username: userName,
 		FullName: fullName,
 		Email:    email,
 		Password: password,

cmd/cycloid/middleware/middleware.go

@@ -35,7 +35,8 @@ type Middleware interface {
 	GetStack(org, ref string) (*models.ServiceCatalog, error)
 	UpdateStack(org, ref, teamCanonical string, visibility *string) (*models.ServiceCatalog, error)
 	ListStacks(org string) ([]*models.ServiceCatalog, error)
-	ListStackUseCases(org, ref string) ([]*models.StackUseCase, error)
+	ListStackUseCases(org, ref, versionTag, versionBranch, versionCommitHash string) ([]*models.StackUseCase, error)
+	ListStackVersions(org, ref string) ([]*models.ServiceCatalogSourceVersion, error)
 	ListBlueprints(org string) ([]*models.ServiceCatalog, error)
 	CreateStackFromBlueprint(org, blueprintRef, name, stack, catalogRepository, useCase string) (*models.ServiceCatalog, error)
 
@@ -133,16 +134,16 @@ type Middleware interface {
 	DeleteEnv(org, project, env string) error
 
 	// Component
-	CreateComponent(org, project, env, component, description string, componentName, serviceCatalogRef *string, cloudProviderCanonical string) (*models.Component, error)
+	CreateComponent(org, project, env, component, description, componentName, serviceCatalogRef, versionTag, versionBranch, versionCommitHash, cloudProviderCanonical string) (*models.Component, error)
 	UpdateComponent(org, project, env, component, description string, componentName *string) (*models.Component, error)
-	CreateAndConfigureComponent(org, project, env, component, description string, componentName *string, serviceCatalogRef, useCase, cloudProviderCanonical string, vars models.FormVariables) (*models.Component, error)
+	CreateAndConfigureComponent(org, project, env, component, description, componentName, serviceCatalogRef, versionTag, versionBranch, versionCommitHash, useCase, cloudProviderCanonical string, vars models.FormVariables) (*models.Component, error)
 	ConfigureComponent(org, project, env, component, useCase string, vars models.FormVariables) error
 	ListComponents(org, project, env string) ([]*models.Component, error)
 	GetComponent(org, project, env, component string) (*models.Component, error)
 	MigrateComponent(org, project, env, component, targetProject, targetEnv, newCanonical, newName string) (*models.Component, error)
 	DeleteComponent(org, project, env, component string) error
 	GetComponentConfig(org, project, env, component string) (models.FormVariables, error)
-	GetComponentStackConfig(org, project, env, component, useCase string) (models.ServiceCatalogConfigs, error)
+	GetComponentStackConfig(org, project, env, component, useCase, versionTag, versionBranch, versionCommitHash string) (models.ServiceCatalogConfigs, error)
 
 	DeleteRole(org, role string) error
 	GetRole(org, role string) (*models.Role, error)
@@ -170,7 +171,7 @@ type Middleware interface {
 	CostEstimation(org string, plan []byte) (*models.CostEstimationResult, error)
 
 	// Extra actions out of the api
-	InitFirstOrg(org, username, fullName, email, password, licence string, apiKeyCanonical *string) (*FirstOrgData, error)
+	InitFirstOrg(org, userName, fullName, email, password, licence string, apiKeyCanonical *string) (*FirstOrgData, error)
 }
 
 type FirstOrgData struct {

cmd/cycloid/middleware/middleware_test.go

@@ -20,7 +20,7 @@ func runMain(ctx context.Context, main *testing.M) (int, error) {
 	config, err = testcfg.NewConfig("middleware")
 	defer config.Cleanup()
 	if err != nil {
-		return 1, fmt.Errorf("Config setup failed for package middleware: %v", err)
+		return 1, fmt.Errorf("config setup failed for package middleware: %w", err)
 	}
 
 	os.Setenv("CY_API_URL", config.APIUrl)