feat: expose prerelease info (#1472)

Signed-off-by: Miguel Martinez <miguel@chainloop.dev>

Author: migmartri

app/cli/cmd/attestation_init.go

@@ -31,6 +31,7 @@ func newAttestationInitCmd() *cobra.Command {
 		workflowName            string
 		projectName             string
 		projectVersion          string
+		projectVersionRelease   bool
 		newWorkflowcontractName string
 	)
 
@@ -60,6 +61,10 @@ func newAttestationInitCmd() *cobra.Command {
 				projectVersion = cfg.ProjectVersion
 			}
 
+			if projectVersion == "" && projectVersionRelease {
+				return errors.New("project version is required when using --release")
+			}
+
 			return nil
 		},
 		RunE: func(cmd *cobra.Command, _ []string) error {
@@ -77,11 +82,12 @@ func newAttestationInitCmd() *cobra.Command {
 
 			// Initialize it
 			attestationID, err := a.Run(cmd.Context(), &action.AttestationInitRunOpts{
-				ContractRevision:        contractRevision,
-				ProjectName:             projectName,
-				ProjectVersion:          projectVersion,
-				WorkflowName:            workflowName,
-				NewWorkflowContractName: newWorkflowcontractName,
+				ContractRevision:             contractRevision,
+				ProjectName:                  projectName,
+				ProjectVersion:               projectVersion,
+				WorkflowName:                 workflowName,
+				NewWorkflowContractName:      newWorkflowcontractName,
+				ProjectVersionMarkAsReleased: projectVersionRelease,
 			})
 
 			if err != nil {
@@ -136,6 +142,7 @@ func newAttestationInitCmd() *cobra.Command {
 	cmd.Flags().StringVar(&newWorkflowcontractName, "contract", "", "name of an existing contract to attach it to the auto-created workflow (it doesn't update an existing one)")
 
 	cmd.Flags().StringVar(&projectVersion, "version", "", "project version, i.e 0.1.0")
+	cmd.Flags().BoolVar(&projectVersionRelease, "release", false, "promote the provided version as a release")
 
 	return cmd
 }

app/cli/cmd/attestation_status.go

@@ -84,9 +84,9 @@ func attestationStatusTableOutput(status *action.AttestationStatusResult, full b
 	gt.AppendRow(table.Row{"Organization", meta.Organization})
 	gt.AppendRow(table.Row{"Name", meta.Name})
 	gt.AppendRow(table.Row{"Project", meta.Project})
-	projectVersion := "none"
-	if meta.ProjectVersion != "" {
-		projectVersion = meta.ProjectVersion
+	projectVersion := versionStringAttestation(meta.ProjectVersion)
+	if projectVersion == "" {
+		projectVersion = "none"
 	}
 
 	gt.AppendRow(table.Row{"Version", projectVersion})
@@ -206,3 +206,22 @@ func hBool(b bool) string {
 
 	return "No"
 }
+
+// Version information to be shown during the attestation process
+func versionStringAttestation(p *action.ProjectVersion) string {
+	if p.Version == "" {
+		return ""
+	}
+
+	// We are releasing a pre-release at the end of the attestation
+	if p.MarkAsReleased && p.Prerelease {
+		return fmt.Sprintf("%s (will release)", p.Version)
+	}
+
+	// The version loaded is a already released version
+	if !p.Prerelease {
+		return fmt.Sprintf("%s (released)", p.Version)
+	}
+
+	return fmt.Sprintf("%s (prerelease)", p.Version)
+}

app/cli/cmd/attestation_status_test.go

@@ -0,0 +1,79 @@
+// 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.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package cmd
+
+import (
+	"testing"
+
+	"github.com/chainloop-dev/chainloop/app/cli/internal/action"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestVersionStringAttestation(t *testing.T) {
+	testCases := []struct {
+		name     string
+		version  *action.ProjectVersion
+		expected string
+	}{
+		{
+			name: "empty version",
+			version: &action.ProjectVersion{
+				Version: "",
+			},
+			expected: "",
+		},
+		{
+			name: "prerelease version to be released",
+			version: &action.ProjectVersion{
+				Version:        "1.0.0",
+				Prerelease:     true,
+				MarkAsReleased: true,
+			},
+			expected: "1.0.0 (will release)",
+		},
+		{
+			name: "already released version",
+			version: &action.ProjectVersion{
+				Version:    "1.0.0",
+				Prerelease: false,
+			},
+			expected: "1.0.0 (released)",
+		},
+		{
+			name: "prerelease version",
+			version: &action.ProjectVersion{
+				Version:    "1.0.0-rc1",
+				Prerelease: true,
+			},
+			expected: "1.0.0-rc1 (prerelease)",
+		},
+		{
+			name: "prerelease version not marked for release",
+			version: &action.ProjectVersion{
+				Version:        "2.0.0-beta",
+				Prerelease:     true,
+				MarkAsReleased: false,
+			},
+			expected: "2.0.0-beta (prerelease)",
+		},
+	}
+
+	for _, tc := range testCases {
+		t.Run(tc.name, func(t *testing.T) {
+			result := versionStringAttestation(tc.version)
+			assert.Equal(t, tc.expected, result)
+		})
+	}
+}

app/cli/cmd/workflow_workflow_run_list.go

@@ -95,7 +95,7 @@ func workflowRunListTableOutput(runs []*action.WorkflowRunItem) error {
 		return nil
 	}
 
-	header := table.Row{"ID", "Workflow", "Version", "State", "Created At", "Runner"}
+	header := table.Row{"ID", "Workflow", "Version", "Prerelease", "State", "Created At", "Runner"}
 	if full {
 		header = append(header, "Finished At", "Failure reason")
 	}
@@ -105,7 +105,7 @@ func workflowRunListTableOutput(runs []*action.WorkflowRunItem) error {
 
 	for _, p := range runs {
 		wf := p.Workflow
-		r := table.Row{p.ID, wf.NamespacedName(), p.ProjectVersion.Version, p.State, p.CreatedAt.Format(time.RFC822), p.RunnerType}
+		r := table.Row{p.ID, wf.NamespacedName(), versionString(p.ProjectVersion), p.State, p.CreatedAt.Format(time.RFC822), p.RunnerType}
 
 		if full {
 			var finishedAt string
@@ -121,6 +121,19 @@ func workflowRunListTableOutput(runs []*action.WorkflowRunItem) error {
 	return nil
 }
 
+func versionString(p *action.ProjectVersion) string {
+	versionString := p.Version
+	if versionString == "" {
+		return ""
+	}
+
+	if !p.Prerelease {
+		return versionString
+	}
+
+	return fmt.Sprintf("%s (prerelease)", p.Version)
+}
+
 // listAvailableWorkflowStatusFlag returns a list of available workflow status flags
 func listAvailableWorkflowStatusFlag() []string {
 	m := action.WorkflowRunStatus()

app/cli/internal/action/attestation_init.go

@@ -74,11 +74,12 @@ func NewAttestationInit(cfg *AttestationInitOpts) (*AttestationInit, error) {
 
 // returns the attestation ID
 type AttestationInitRunOpts struct {
-	ContractRevision        int
-	ProjectName             string
-	ProjectVersion          string
-	WorkflowName            string
-	NewWorkflowContractName string
+	ContractRevision             int
+	ProjectName                  string
+	ProjectVersion               string
+	ProjectVersionMarkAsReleased bool
+	WorkflowName                 string
+	NewWorkflowContractName      string
 }
 
 func (action *AttestationInit) Run(ctx context.Context, opts *AttestationInitRunOpts) (string, error) {
@@ -124,7 +125,10 @@ func (action *AttestationInit) Run(ctx context.Context, opts *AttestationInitRun
 		Project:        workflow.GetProject(),
 		Team:           workflow.GetTeam(),
 		SchemaRevision: strconv.Itoa(int(contractVersion.GetRevision())),
-		ProjectVersion: opts.ProjectVersion,
+		ProjectVersion: &clientAPI.ProjectVersion{
+			Version:        opts.ProjectVersion,
+			MarkAsReleased: opts.ProjectVersionMarkAsReleased,
+		},
 	}
 
 	action.Logger.Debug().Msg("workflow contract and metadata retrieved from the control plane")
@@ -165,6 +169,7 @@ func (action *AttestationInit) Run(ctx context.Context, opts *AttestationInitRun
 		workflowRun := runResp.GetResult().GetWorkflowRun()
 		workflowMeta.WorkflowRunId = workflowRun.GetId()
 		workflowMeta.Organization = runResp.GetResult().GetOrganization()
+		workflowMeta.ProjectVersion.Prerelease = runResp.GetResult().GetWorkflowRun().Version.GetPrerelease()
 		action.Logger.Debug().Str("workflow-run-id", workflowRun.GetId()).Msg("attestation initialized in the control plane")
 		attestationID = workflowRun.GetId()
 	}

app/cli/internal/action/attestation_push.go

@@ -78,7 +78,10 @@ func (action *AttestationPush) Run(ctx context.Context, attestationID string, ru
 	}
 
 	// Retrieve attestation status
-	statusAction, err := NewAttestationStatus(&AttestationStatusOpts{ActionsOpts: action.ActionsOpts, UseAttestationRemoteState: useRemoteState})
+	statusAction, err := NewAttestationStatus(&AttestationStatusOpts{
+		ActionsOpts: action.ActionsOpts, UseAttestationRemoteState: useRemoteState, SkipReleaseInfo: true,
+	})
+
 	if err != nil {
 		return nil, fmt.Errorf("creating status action: %w", err)
 	}
@@ -172,7 +175,9 @@ func (action *AttestationPush) Run(ctx context.Context, attestationID string, ru
 		return attestationResult, nil
 	}
 
-	attestationResult.Digest, err = pushToControlPlane(ctx, action.ActionsOpts.CPConnection, envelope, crafter.CraftingState.Attestation.GetWorkflow().GetWorkflowRunId())
+	workflow := crafter.CraftingState.Attestation.GetWorkflow()
+
+	attestationResult.Digest, err = pushToControlPlane(ctx, action.ActionsOpts.CPConnection, envelope, workflow.GetWorkflowRunId(), workflow.GetProjectVersion().GetMarkAsReleased())
 	if err != nil {
 		return nil, fmt.Errorf("pushing to control plane: %w", err)
 	}
@@ -187,16 +192,17 @@ func (action *AttestationPush) Run(ctx context.Context, attestationID string, ru
 	return attestationResult, nil
 }
 
-func pushToControlPlane(ctx context.Context, conn *grpc.ClientConn, envelope *dsse.Envelope, workflowRunID string) (string, error) {
+func pushToControlPlane(ctx context.Context, conn *grpc.ClientConn, envelope *dsse.Envelope, workflowRunID string, markVersionAsReleased bool) (string, error) {
 	encodedAttestation, err := encodeEnvelope(envelope)
 	if err != nil {
 		return "", fmt.Errorf("encoding attestation: %w", err)
 	}
 
 	client := pb.NewAttestationServiceClient(conn)
 	resp, err := client.Store(ctx, &pb.AttestationServiceStoreRequest{
-		Attestation:   encodedAttestation,
-		WorkflowRunId: workflowRunID,
+		Attestation:           encodedAttestation,
+		WorkflowRunId:         workflowRunID,
+		MarkVersionAsReleased: &markVersionAsReleased,
 	})
 
 	if err != nil {

app/cli/internal/action/attestation_status.go

@@ -28,11 +28,14 @@ import (
 type AttestationStatusOpts struct {
 	*ActionsOpts
 	UseAttestationRemoteState bool
+	SkipReleaseInfo           bool
 }
 
 type AttestationStatus struct {
 	*ActionsOpts
 	c *crafter.Crafter
+	// Do not show information about the project version release status
+	skipReleaseInfo bool
 }
 
 type AttestationStatusResult struct {
@@ -52,7 +55,8 @@ type AttestationResultRunnerContext struct {
 }
 
 type AttestationStatusWorkflowMeta struct {
-	WorkflowID, Name, Team, Project, ContractRevision, Organization, ProjectVersion string
+	WorkflowID, Name, Team, Project, ContractRevision, Organization string
+	ProjectVersion                                                  *ProjectVersion
 }
 
 type AttestationStatusResultMaterial struct {
@@ -67,8 +71,9 @@ func NewAttestationStatus(cfg *AttestationStatusOpts) (*AttestationStatus, error
 	}
 
 	return &AttestationStatus{
-		ActionsOpts: cfg.ActionsOpts,
-		c:           c,
+		ActionsOpts:     cfg.ActionsOpts,
+		c:               c,
+		skipReleaseInfo: cfg.SkipReleaseInfo,
 	}, nil
 }
 
@@ -98,13 +103,20 @@ func (action *AttestationStatus) Run(ctx context.Context, attestationID string)
 			Project:          workflowMeta.GetProject(),
 			Team:             workflowMeta.GetTeam(),
 			ContractRevision: workflowMeta.GetSchemaRevision(),
-			ProjectVersion:   workflowMeta.GetProjectVersion(),
+			ProjectVersion: &ProjectVersion{
+				Version: workflowMeta.GetProjectVersion().GetVersion(),
+			},
 		},
 		InitializedAt: toTimePtr(att.InitializedAt.AsTime()),
 		DryRun:        c.CraftingState.DryRun,
 		Annotations:   pbAnnotationsToAction(c.CraftingState.InputSchema.GetAnnotations()),
 	}
 
+	if !action.skipReleaseInfo {
+		res.WorkflowMeta.ProjectVersion.Prerelease = workflowMeta.ProjectVersion.Prerelease
+		res.WorkflowMeta.ProjectVersion.MarkAsReleased = workflowMeta.ProjectVersion.MarkAsReleased
+	}
+
 	// Let's perform the following steps in order to show all possible materials:
 	// 1. Populate the materials that are defined in the contract schema
 	// 2. Populate the materials that are not defined in the contract schema, added inline in the attestation

app/cli/internal/action/workflow_run_list.go

@@ -55,8 +55,10 @@ type WorkflowRunItem struct {
 }
 
 type ProjectVersion struct {
-	ID      string `json:"id"`
-	Version string `json:"version,omitempty"`
+	ID             string `json:"id"`
+	Version        string `json:"version,omitempty"`
+	Prerelease     bool   `json:"prerelease"`
+	MarkAsReleased bool   `json:"markAsRelease"`
 }
 
 type PaginatedWorkflowRunItem struct {
@@ -126,8 +128,9 @@ func pbWorkflowRunItemToAction(in *pb.WorkflowRunItem) *WorkflowRunItem {
 		ContractRevisionUsed:   int(in.GetContractRevisionUsed()),
 		ContractRevisionLatest: int(in.GetContractRevisionLatest()),
 		ProjectVersion: &ProjectVersion{
-			ID:      in.GetVersion().GetId(),
-			Version: in.GetVersion().GetVersion(),
+			ID:         in.GetVersion().GetId(),
+			Version:    in.GetVersion().GetVersion(),
+			Prerelease: in.GetVersion().GetPrerelease(),
 		},
 	}