feat: require project name on workflow management (#1378)

Signed-off-by: Miguel Martinez <[email protected]>

Author: migmartri

app/cli/cmd/attestation_init.go

@@ -29,6 +29,7 @@ func newAttestationInitCmd() *cobra.Command {
 		contractRevision  int
 		attestationDryRun bool
 		workflowName      string
+		projectName       string
 	)
 
 	cmd := &cobra.Command{
@@ -37,14 +38,14 @@ func newAttestationInitCmd() *cobra.Command {
 		Annotations: map[string]string{
 			useAPIToken: "true",
 		},
-		PreRunE: func(cmd *cobra.Command, args []string) error {
+		PreRunE: func(_ *cobra.Command, _ []string) error {
 			if workflowName == "" {
-				return errors.New("workflow name is required, set it via --name flag")
+				return errors.New("workflow name is required, set it via --workflow flag")
 			}
 
 			return nil
 		},
-		RunE: func(cmd *cobra.Command, args []string) error {
+		RunE: func(cmd *cobra.Command, _ []string) error {
 			a, err := action.NewAttestationInit(
 				&action.AttestationInitOpts{
 					ActionsOpts:    actionOpts,
@@ -58,7 +59,7 @@ func newAttestationInitCmd() *cobra.Command {
 			}
 
 			// Initialize it
-			attestationID, err := a.Run(cmd.Context(), contractRevision, workflowName)
+			attestationID, err := a.Run(cmd.Context(), contractRevision, projectName, workflowName)
 			if err != nil {
 				if errors.Is(err, action.ErrAttestationAlreadyExist) {
 					return err
@@ -86,7 +87,11 @@ func newAttestationInitCmd() *cobra.Command {
 				logger.Info().Msg("The attestation is being crafted in dry-run mode. It will not get stored once rendered")
 			}
 
-			return encodeOutput(res, simpleStatusTable)
+			if projectName == "" {
+				logger.Warn().Msg("DEPRECATION WARNING: --project not set, this will be required in the near future")
+			}
+
+			return encodeOutput(res, fullStatusTable)
 		},
 	}
 
@@ -96,10 +101,10 @@ func newAttestationInitCmd() *cobra.Command {
 	cmd.Flags().IntVar(&contractRevision, "contract-revision", 0, "revision of the contract to retrieve, \"latest\" by default")
 	cmd.Flags().BoolVar(&useAttestationRemoteState, "remote-state", false, "Store the attestation state remotely")
 
-	// workflow-name has been replaced by --name flag
-	cmd.Flags().StringVar(&workflowName, "workflow-name", "", "name of the workflow to run the attestation")
-	cobra.CheckErr(cmd.Flags().MarkHidden("workflow-name"))
+	// name has been replaced by --workflow flag
+	cmd.Flags().StringVar(&workflowName, "workflow", "", "name of the workflow to run the attestation")
 	cmd.Flags().StringVar(&workflowName, "name", "", "name of the workflow to run the attestation")
-
+	cobra.CheckErr(cmd.Flags().MarkDeprecated("name", "please use --workflow instead"))
+	cmd.Flags().StringVar(&projectName, "project", "", "name of the project of this workflow")
 	return cmd
 }

app/cli/cmd/attestation_status.go

@@ -81,8 +81,8 @@ func attestationStatusTableOutput(status *action.AttestationStatusResult, full b
 	gt.AppendSeparator()
 	meta := status.WorkflowMeta
 	gt.AppendRow(table.Row{"Attestation ID", status.AttestationID})
+	gt.AppendRow(table.Row{"Organization", meta.Organization})
 	gt.AppendRow(table.Row{"Name", meta.Name})
-	gt.AppendRow(table.Row{"Team", meta.Team})
 	gt.AppendRow(table.Row{"Project", meta.Project})
 	gt.AppendRow(table.Row{"Contract Revision", meta.ContractRevision})
 	if status.RunnerContext.JobURL != "" {

app/cli/cmd/workflow_delete.go

@@ -21,15 +21,15 @@ import (
 )
 
 func newWorkflowDeleteCmd() *cobra.Command {
-	var name string
+	var name, projectName string
 
 	cmd := &cobra.Command{
 		Use:   "delete",
 		Short: "Delete an existing workflow",
 		RunE: func(cmd *cobra.Command, args []string) error {
-			err := action.NewWorkflowDelete(actionOpts).Run(name)
+			err := action.NewWorkflowDelete(actionOpts).Run(name, projectName)
 			if err == nil {
-				logger.Info().Msg("Workload deleted!")
+				logger.Info().Msg("Workflow deleted!")
 			}
 			return err
 		},
@@ -38,5 +38,8 @@ func newWorkflowDeleteCmd() *cobra.Command {
 	cmd.Flags().StringVar(&name, "name", "", "workflow name")
 	cobra.CheckErr(cmd.MarkFlagRequired("name"))
 
+	cmd.Flags().StringVar(&projectName, "project", "", "project name")
+	cobra.CheckErr(cmd.MarkFlagRequired("project"))
+
 	return cmd
 }

app/cli/cmd/workflow_describe.go

@@ -21,13 +21,13 @@ import (
 )
 
 func newWorkflowDescribeCmd() *cobra.Command {
-	var workflowName string
+	var workflowName, projectName string
 
 	cmd := &cobra.Command{
 		Use:   "describe",
 		Short: "Describe an existing workflow",
 		RunE: func(cmd *cobra.Command, args []string) error {
-			wf, err := action.NewWorkflowDescribe(actionOpts).Run(cmd.Context(), workflowName)
+			wf, err := action.NewWorkflowDescribe(actionOpts).Run(cmd.Context(), workflowName, projectName)
 			if err != nil {
 				return err
 			}
@@ -39,5 +39,7 @@ func newWorkflowDescribeCmd() *cobra.Command {
 	cmd.Flags().StringVar(&workflowName, "name", "", "workflow name")
 	cobra.CheckErr(cmd.MarkFlagRequired("name"))
 
+	cmd.Flags().StringVar(&projectName, "project", "", "project name")
+	cobra.CheckErr(cmd.MarkFlagRequired("project"))
 	return cmd
 }

app/cli/cmd/workflow_update.go

@@ -1,5 +1,5 @@
 //
-// Copyright 2023 The Chainloop Authors.
+// Copyright 2024 The Chainloop Authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -34,9 +34,6 @@ func newWorkflowUpdateCmd() *cobra.Command {
 			if cmd.Flags().Changed("team") {
 				opts.Team = &team
 			}
-			if cmd.Flags().Changed("project") {
-				opts.Project = &project
-			}
 			if cmd.Flags().Changed("public") {
 				opts.Public = &public
 			}
@@ -49,7 +46,7 @@ func newWorkflowUpdateCmd() *cobra.Command {
 				opts.ContractName = &contractName
 			}
 
-			res, err := action.NewWorkflowUpdate(actionOpts).Run(context.Background(), name, opts)
+			res, err := action.NewWorkflowUpdate(actionOpts).Run(context.Background(), name, project, opts)
 			if err != nil {
 				return err
 			}
@@ -61,10 +58,11 @@ func newWorkflowUpdateCmd() *cobra.Command {
 
 	cmd.Flags().StringVar(&name, "name", "", "workflow name")
 	cobra.CheckErr(cmd.MarkFlagRequired("name"))
+	cmd.Flags().StringVar(&project, "project", "", "project name")
+	cobra.CheckErr(cmd.MarkFlagRequired("project"))
 
 	cmd.Flags().StringVar(&description, "description", "", "workflow description")
 	cmd.Flags().StringVar(&team, "team", "", "team name")
-	cmd.Flags().StringVar(&project, "project", "", "project name")
 	cmd.Flags().BoolVar(&public, "public", false, "is the workflow public")
 	cmd.Flags().StringVar(&contractName, "contract", "", "the name of an existing contract")
 

app/cli/cmd/workflow_workflow_run_list.go

@@ -31,7 +31,7 @@ func newWorkflowWorkflowRunListCmd() *cobra.Command {
 		DefaultLimit: 20,
 	}
 
-	var workflowName, status string
+	var workflowName, projectName, status string
 
 	cmd := &cobra.Command{
 		Use:     "list",
@@ -48,6 +48,7 @@ func newWorkflowWorkflowRunListCmd() *cobra.Command {
 			res, err := action.NewWorkflowRunList(actionOpts).Run(
 				&action.WorkflowRunListOpts{
 					WorkflowName: workflowName,
+					ProjectName:  projectName,
 					Pagination: &action.PaginationOpts{
 						Limit:      paginationOpts.Limit,
 						NextCursor: paginationOpts.NextCursor,
@@ -79,6 +80,7 @@ func newWorkflowWorkflowRunListCmd() *cobra.Command {
 	}
 
 	cmd.Flags().StringVar(&workflowName, "workflow", "", "workflow name")
+	cmd.Flags().StringVar(&projectName, "project", "", "project name")
 	cmd.Flags().BoolVar(&full, "full", false, "full report")
 	cmd.Flags().StringVar(&status, "status", "", fmt.Sprintf("filter by workflow run status: %v", listAvailableWorkflowStatusFlag()))
 	// Add pagination flags

app/cli/internal/action/attestation_init.go

@@ -70,7 +70,7 @@ func NewAttestationInit(cfg *AttestationInitOpts) (*AttestationInit, error) {
 }
 
 // returns the attestation ID
-func (action *AttestationInit) Run(ctx context.Context, contractRevision int, workflowName string) (string, error) {
+func (action *AttestationInit) Run(ctx context.Context, contractRevision int, projectName, workflowName string) (string, error) {
 	if action.dryRun && action.useRemoteState {
 		return "", errors.New("remote state is not compatible with dry-run mode")
 	}
@@ -89,6 +89,7 @@ func (action *AttestationInit) Run(ctx context.Context, contractRevision int, wo
 	contractResp, err := client.GetContract(ctx, &pb.AttestationServiceGetContractRequest{
 		ContractRevision: int32(contractRevision),
 		WorkflowName:     workflowName,
+		ProjectName:      projectName,
 	})
 	if err != nil {
 		return "", err
@@ -127,6 +128,7 @@ func (action *AttestationInit) Run(ctx context.Context, contractRevision int, wo
 				ContractRevision: int32(contractRevision),
 				// send the workflow name explicitly provided by the user to detect that functional case
 				WorkflowName: workflowName,
+				ProjectName:  projectName,
 			},
 		)
 		if err != nil {

app/cli/internal/action/attestation_status.go

@@ -52,7 +52,7 @@ type AttestationResultRunnerContext struct {
 }
 
 type AttestationStatusWorkflowMeta struct {
-	WorkflowID, Name, Team, Project, ContractRevision string
+	WorkflowID, Name, Team, Project, ContractRevision, Organization string
 }
 
 type AttestationStatusResultMaterial struct {
@@ -94,6 +94,7 @@ func (action *AttestationStatus) Run(ctx context.Context, attestationID string)
 		WorkflowMeta: &AttestationStatusWorkflowMeta{
 			WorkflowID:       workflowMeta.GetWorkflowId(),
 			Name:             workflowMeta.GetName(),
+			Organization:     workflowMeta.GetOrganization(),
 			Project:          workflowMeta.GetProject(),
 			Team:             workflowMeta.GetTeam(),
 			ContractRevision: workflowMeta.GetSchemaRevision(),

app/cli/internal/action/workflow_create.go

@@ -37,7 +37,7 @@ type NewWorkflowCreateOpts struct {
 func (action *WorkflowCreate) Run(opts *NewWorkflowCreateOpts) (*WorkflowItem, error) {
 	client := pb.NewWorkflowServiceClient(action.cfg.CPConnection)
 	resp, err := client.Create(context.Background(), &pb.WorkflowServiceCreateRequest{
-		Name: opts.Name, Project: opts.Project, Team: opts.Team, ContractName: opts.ContractName,
+		Name: opts.Name, ProjectName: opts.Project, Team: opts.Team, ContractName: opts.ContractName,
 		Description: opts.Description,
 		Public:      opts.Public,
 	})

app/cli/internal/action/workflow_delete.go

@@ -29,9 +29,9 @@ func NewWorkflowDelete(cfg *ActionsOpts) *WorkflowDelete {
 	return &WorkflowDelete{cfg}
 }
 
-func (action *WorkflowDelete) Run(name string) error {
+func (action *WorkflowDelete) Run(name, projectName string) error {
 	client := pb.NewWorkflowServiceClient(action.cfg.CPConnection)
-	if _, err := client.Delete(context.Background(), &pb.WorkflowServiceDeleteRequest{Name: name}); err != nil {
+	if _, err := client.Delete(context.Background(), &pb.WorkflowServiceDeleteRequest{Name: name, ProjectName: projectName}); err != nil {
 		return err
 	}