chore: add contract name (#1048)

Signed-off-by: Miguel Martinez Trivino <miguel@chainloop.dev>
chainloop-dev · Jun 27, 2024 · f4cebf8 · f4cebf8
1 parent b6fb604
commit f4cebf8
Show file tree

Hide file tree

Showing 10 changed files with 267 additions and 263 deletions.
diff --git a/app/cli/cmd/workflow_list.go b/app/cli/cmd/workflow_list.go
@@ -55,7 +55,7 @@ func WorkflowListTableOutput(workflows []*action.WorkflowItem) error {
 	}
 
 	headerRow := table.Row{"Name", "Project", "Public", "Runner", "Last Run status", "Created At"}
-	headerRowFull := table.Row{"Name", "Description", "Project", "Team", "Public", "Runner", "Last Run status", "Contract ID", "Created At"}
+	headerRowFull := table.Row{"Name", "Description", "Project", "Team", "Public", "Runner", "Last Run status", "Contract", "Created At"}
 
 	t := newTableWriter()
 	if full {
@@ -82,7 +82,7 @@ func WorkflowListTableOutput(workflows []*action.WorkflowItem) error {
 			row = table.Row{
 				p.Name, p.Description, p.Project, p.Team, p.Public,
 				lastRunRunner, lastRunState,
-				p.ContractID,
+				p.ContractName,
 				p.CreatedAt.Format(time.RFC822),
 			}
 		}

diff --git a/app/cli/internal/action/workflow_list.go b/app/cli/internal/action/workflow_list.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.
@@ -35,7 +35,7 @@ type WorkflowItem struct {
 	Project                string           `json:"project,omitempty"`
 	CreatedAt              *time.Time       `json:"createdAt"`
 	RunsCount              int32            `json:"runsCount"`
-	ContractID             string           `json:"contractID,omitempty"`
+	ContractName           string           `json:"contractName,omitempty"`
 	ContractRevisionLatest int32            `json:"contractRevisionLatest,omitempty"`
 	LastRun                *WorkflowRunItem `json:"lastRun,omitempty"`
 	// A public workflow means that any user can
@@ -71,7 +71,7 @@ func pbWorkflowItemToAction(wf *pb.WorkflowItem) *WorkflowItem {
 	res := &WorkflowItem{
 		Name: wf.Name, ID: wf.Id, CreatedAt: toTimePtr(wf.CreatedAt.AsTime()),
 		Project: wf.Project, Team: wf.Team, RunsCount: wf.RunsCount,
-		ContractID:             wf.ContractId,
+		ContractName:           wf.ContractName,
 		ContractRevisionLatest: wf.ContractRevisionLatest,
 		LastRun:                pbWorkflowRunItemToAction(wf.LastRun),
 		Public:                 wf.Public,

diff --git a/app/controlplane/api/controlplane/v1/response_messages.pb.go b/app/controlplane/api/controlplane/v1/response_messages.pb.go
diff --git a/app/controlplane/api/controlplane/v1/response_messages.proto b/app/controlplane/api/controlplane/v1/response_messages.proto
@@ -32,7 +32,7 @@ message WorkflowItem {
   int32 runs_count = 6;
 
   WorkflowRunItem last_run = 7;
-  string contract_id = 8;
+  string contract_name = 8;
   // Current, latest revision of the contract
   int32 contract_revision_latest = 11;
   // A public workflow means that any user can
@@ -196,4 +196,4 @@ enum UserWithNoMembershipError {
   option (errors.default_code) = 500;
   USER_WITH_NO_MEMBERSHIP_ERROR_UNSPECIFIED = 0;
   USER_WITH_NO_MEMBERSHIP_ERROR_NOT_IN_ORG = 1 [(errors.code) = 403];
-}
+}
diff --git a/app/controlplane/api/gen/frontend/controlplane/v1/response_messages.ts b/app/controlplane/api/gen/frontend/controlplane/v1/response_messages.ts
diff --git a/app/controlplane/internal/service/workflow.go b/app/controlplane/internal/service/workflow.go
@@ -150,7 +150,7 @@ func bizWorkflowToPb(wf *biz.Workflow) *pb.WorkflowItem {
 	}
 
 	if wf.ContractID != uuid.Nil {
-		item.ContractId = wf.ContractID.String()
+		item.ContractName = wf.ContractName
 	}
 
 	if wf.LastRun != nil {

diff --git a/app/controlplane/internal/service/workflowcontract.go b/app/controlplane/internal/service/workflowcontract.go
@@ -70,7 +70,7 @@ func (s *WorkflowContractService) Describe(ctx context.Context, req *pb.Workflow
 		return nil, errors.NotFound("not found", "contract not found")
 	}
 
-	contractWithVersion, err := s.contractUseCase.Describe(ctx, currentOrg.ID, contract.Name, int(req.GetRevision()))
+	contractWithVersion, err := s.contractUseCase.Describe(ctx, currentOrg.ID, contract.ID.String(), int(req.GetRevision()))
 	if err != nil {
 		return nil, handleUseCaseErr(err, s.log)
 	} else if contractWithVersion == nil {

diff --git a/app/controlplane/pkg/biz/workflow.go b/app/controlplane/pkg/biz/workflow.go
@@ -31,6 +31,7 @@ type Workflow struct {
 	RunsCounter                      int
 	LastRun                          *WorkflowRun
 	ID, ContractID, OrgID            uuid.UUID
+	ContractName                     string
 	// Latest available contract revision
 	ContractRevisionLatest int
 	// Public means that the associated workflow runs, attestations and materials

diff --git a/app/controlplane/pkg/biz/workflow_integration_test.go b/app/controlplane/pkg/biz/workflow_integration_test.go
@@ -164,6 +164,8 @@ func (s *workflowIntegrationTestSuite) TestCreate() {
 			s.Equal(tc.opts.Description, got.Description)
 			s.Equal(tc.opts.Team, got.Team)
 			s.Equal(tc.opts.Project, got.Project)
+			s.NotEmpty(got.ContractID)
+			s.NotEmpty(got.ContractName)
 		})
 	}
 }
@@ -293,7 +295,7 @@ func (s *workflowIntegrationTestSuite) TestUpdate() {
 			s.NoError(err)
 
 			if diff := cmp.Diff(tc.want, got,
-				cmpopts.IgnoreFields(biz.Workflow{}, "Name", "CreatedAt", "ID", "OrgID", "ContractID", "ContractRevisionLatest"),
+				cmpopts.IgnoreFields(biz.Workflow{}, "Name", "CreatedAt", "ID", "OrgID", "ContractName", "ContractID", "ContractRevisionLatest"),
 			); diff != "" {
 				s.Failf("mismatch (-want +got):\n%s", diff)
 			}

diff --git a/app/controlplane/pkg/data/workflow.go b/app/controlplane/pkg/data/workflow.go
@@ -242,6 +242,7 @@ func entWFToBizWF(w *ent.Workflow, r *ent.WorkflowRun) (*biz.Workflow, error) {
 
 	if contract := w.Edges.Contract; contract != nil {
 		wf.ContractID = contract.ID
+		wf.ContractName = contract.Name
 		lv, err := latestVersion(context.Background(), contract)
 		if err != nil {
 			return nil, fmt.Errorf("finding contract version: %w", err)