Add timestamp fields to resource objects

Update CRDs to include timestamp fields. Add timestamp fields for Git and Bundle results.
shipwright-io · Jan 18, 2024 · 1cc6f3f · 1cc6f3f
1 parent e4f2965
commit 1cc6f3f
Show file tree

Hide file tree

Showing 12 changed files with 243 additions and 87 deletions.
diff --git a/deploy/crds/shipwright.io_buildruns.yaml b/deploy/crds/shipwright.io_buildruns.yaml
@@ -6313,6 +6313,15 @@ spec:
                         digest:
                           description: Digest hold the image digest result
                           type: string
+                        image_timestamp:
+                          description: ImageTimestamp holds the (bundle) image timestamp
+                            result
+                          type: string
+                        source_timestamp:
+                          description: SourceTimestamp holds the source timestamp,
+                            meaning the most recent timestamp of all files that are
+                            used as source
+                          type: string
                       type: object
                     git:
                       description: Git holds the results emitted from from the step
@@ -6330,6 +6339,10 @@ spec:
                         commitSha:
                           description: CommitSha holds the commit sha of git source
                           type: string
+                        commitTimestamp:
+                          description: CommitTimestamp holds the commit timestamp
+                            of a git source
+                          type: string
                       type: object
                     name:
                       description: Name is the name of source
@@ -12543,6 +12556,10 @@ spec:
                       commitSha:
                         description: CommitSha holds the commit sha of git source
                         type: string
+                      commitTimestamp:
+                        description: CommitTimestamp holds the commit timestamp of
+                          a git source
+                        type: string
                     type: object
                   ociArtifact:
                     description: OciArtifact holds the results emitted from the source
@@ -12551,6 +12568,15 @@ spec:
                       digest:
                         description: Digest hold the image digest result
                         type: string
+                      image_timestamp:
+                        description: ImageTimestamp holds the (bundle) image timestamp
+                          result
+                        type: string
+                      source_timestamp:
+                        description: SourceTimestamp holds the source timestamp, meaning
+                          the most recent timestamp of all files that are used as
+                          source
+                        type: string
                     type: object
                 type: object
               startTime:

diff --git a/pkg/apis/build/v1alpha1/buildrun_types.go b/pkg/apis/build/v1alpha1/buildrun_types.go
@@ -123,6 +123,13 @@ type SourceResult struct {
 type BundleSourceResult struct {
 	// Digest hold the image digest result
 	Digest string `json:"digest,omitempty"`
+
+	// ImageTimestamp holds the (bundle) image timestamp result
+	ImageTimestamp string `json:"image_timestamp,omitempty"`
+
+	// SourceTimestamp holds the source timestamp, meaning the most recent
+	// timestamp of all files that are used as source
+	SourceTimestamp string `json:"source_timestamp,omitempty"`
 }
 
 // GitSourceResult holds the results emitted from the git source
@@ -133,6 +140,9 @@ type GitSourceResult struct {
 	// CommitAuthor holds the commit author of a git source
 	CommitAuthor string `json:"commitAuthor,omitempty"`
 
+	// CommitTimestamp holds the commit timestamp of a git source
+	CommitTimestamp string `json:"commitTimestamp,omitempty"`
+
 	// BranchName holds the default branch name of the git source
 	// this will be set only when revision is not specified in Build object
 	BranchName string `json:"branchName,omitempty"`

diff --git a/pkg/apis/build/v1beta1/buildrun_types.go b/pkg/apis/build/v1beta1/buildrun_types.go
@@ -128,6 +128,13 @@ type SourceResult struct {
 type OciArtifactSourceResult struct {
 	// Digest hold the image digest result
 	Digest string `json:"digest,omitempty"`
+
+	// ImageTimestamp holds the (bundle) image timestamp result
+	ImageTimestamp string `json:"image_timestamp,omitempty"`
+
+	// SourceTimestamp holds the source timestamp, meaning the most recent
+	// timestamp of all files that are used as source
+	SourceTimestamp string `json:"source_timestamp,omitempty"`
 }
 
 // GitSourceResult holds the results emitted from the git source
@@ -138,6 +145,9 @@ type GitSourceResult struct {
 	// CommitAuthor holds the commit author of a git source
 	CommitAuthor string `json:"commitAuthor,omitempty"`
 
+	// CommitTimestamp holds the commit timestamp of a git source
+	CommitTimestamp string `json:"commitTimestamp,omitempty"`
+
 	// BranchName holds the default branch name of the git source
 	// this will be set only when revision is not specified in Build object
 	//

diff --git a/pkg/reconciler/buildrun/resources/sources/bundle.go b/pkg/reconciler/buildrun/resources/sources/bundle.go
@@ -24,10 +24,20 @@ func AppendBundleStep(
 	name string,
 ) {
 	// append the result
-	taskSpec.Results = append(taskSpec.Results, pipelineapi.TaskResult{
-		Name:        fmt.Sprintf("%s-source-%s-image-digest", prefixParamsResultsVolumes, name),
-		Description: "The digest of the bundle image.",
-	})
+	taskSpec.Results = append(taskSpec.Results,
+		pipelineapi.TaskResult{
+			Name:        fmt.Sprintf("%s-source-%s-image-digest", prefixParamsResultsVolumes, name),
+			Description: "The digest of the bundle image.",
+		},
+		pipelineapi.TaskResult{
+			Name:        fmt.Sprintf("%s-source-%s-image-timestamp", prefixParamsResultsVolumes, name),
+			Description: "The timestamp of the bundle image.",
+		},
+		pipelineapi.TaskResult{
+			Name:        fmt.Sprintf("%s-source-%s-source-timestamp", prefixParamsResultsVolumes, name),
+			Description: "The timestamp of the most recent source file.",
+		},
+	)
 
 	// initialize the step from the template and the build-specific arguments
 	bundleStep := pipelineapi.Step{
@@ -39,6 +49,8 @@ func AppendBundleStep(
 			"--image", source.BundleContainer.Image,
 			"--target", fmt.Sprintf("$(params.%s-%s)", prefixParamsResultsVolumes, paramSourceRoot),
 			"--result-file-image-digest", fmt.Sprintf("$(results.%s-source-%s-image-digest.path)", prefixParamsResultsVolumes, name),
+			"--result-file-image-timestamp", fmt.Sprintf("$(results.%s-source-%s-image-timestamp.path)", prefixParamsResultsVolumes, name),
+			"--result-file-source-timestamp", fmt.Sprintf("$(results.%s-source-%s-source-timestamp.path)", prefixParamsResultsVolumes, name),
 		},
 		Env:              cfg.BundleContainerTemplate.Env,
 		ComputeResources: cfg.BundleContainerTemplate.Resources,
@@ -76,12 +88,19 @@ func AppendBundleStep(
 // AppendBundleResult append bundle source result to build run
 func AppendBundleResult(buildRun *build.BuildRun, name string, results []pipelineapi.TaskRunResult) {
 	imageDigest := findResultValue(results, fmt.Sprintf("%s-source-%s-image-digest", prefixParamsResultsVolumes, name))
+	imageTimestamp := findResultValue(results, fmt.Sprintf("%s-source-%s-image-timestamp", prefixParamsResultsVolumes, name))
+	sourceTimestamp := findResultValue(results, fmt.Sprintf("%s-source-%s-source-timestamp", prefixParamsResultsVolumes, name))
+
+	if strings.TrimSpace(imageDigest) != "" ||
+		strings.TrimSpace(imageTimestamp) != "" ||
+		strings.TrimSpace(sourceTimestamp) != "" {
 
-	if strings.TrimSpace(imageDigest) != "" {
 		buildRun.Status.Sources = append(buildRun.Status.Sources, build.SourceResult{
 			Name: name,
 			Bundle: &build.BundleSourceResult{
-				Digest: imageDigest,
+				Digest:          imageDigest,
+				ImageTimestamp:  imageTimestamp,
+				SourceTimestamp: sourceTimestamp,
 			},
 		})
 	}

diff --git a/pkg/reconciler/buildrun/resources/sources/git.go b/pkg/reconciler/buildrun/resources/sources/git.go
@@ -15,9 +15,10 @@ import (
 )
 
 const (
-	commitSHAResult    = "commit-sha"
-	commitAuthorResult = "commit-author"
-	branchName         = "branch-name"
+	commitSHAResult       = "commit-sha"
+	commitAuthorResult    = "commit-author"
+	commitTimestampResult = "commit-timestamp"
+	branchName            = "branch-name"
 )
 
 // AppendGitStep appends the Git step and results and volume if needed to the TaskSpec
@@ -28,16 +29,24 @@ func AppendGitStep(
 	name string,
 ) {
 	// append the result
-	taskSpec.Results = append(taskSpec.Results, pipelineapi.TaskResult{
-		Name:        fmt.Sprintf("%s-source-%s-%s", prefixParamsResultsVolumes, name, commitSHAResult),
-		Description: "The commit SHA of the cloned source.",
-	}, pipelineapi.TaskResult{
-		Name:        fmt.Sprintf("%s-source-%s-%s", prefixParamsResultsVolumes, name, commitAuthorResult),
-		Description: "The author of the last commit of the cloned source.",
-	}, pipelineapi.TaskResult{
-		Name:        fmt.Sprintf("%s-source-%s-%s", prefixParamsResultsVolumes, name, branchName),
-		Description: "The name of the branch used of the cloned source.",
-	})
+	taskSpec.Results = append(taskSpec.Results,
+		pipelineapi.TaskResult{
+			Name:        fmt.Sprintf("%s-source-%s-%s", prefixParamsResultsVolumes, name, commitSHAResult),
+			Description: "The commit SHA of the cloned source.",
+		},
+		pipelineapi.TaskResult{
+			Name:        fmt.Sprintf("%s-source-%s-%s", prefixParamsResultsVolumes, name, commitAuthorResult),
+			Description: "The author of the last commit of the cloned source.",
+		},
+		pipelineapi.TaskResult{
+			Name:        fmt.Sprintf("%s-source-%s-%s", prefixParamsResultsVolumes, name, commitTimestampResult),
+			Description: "The commit timestamp of the last commit of the cloned source.",
+		},
+		pipelineapi.TaskResult{
+			Name:        fmt.Sprintf("%s-source-%s-%s", prefixParamsResultsVolumes, name, branchName),
+			Description: "The name of the branch used of the cloned source.",
+		},
+	)
 
 	// initialize the step from the template and the build-specific arguments
 	gitStep := pipelineapi.Step{
@@ -46,20 +55,14 @@ func AppendGitStep(
 		ImagePullPolicy: cfg.GitContainerTemplate.ImagePullPolicy,
 		Command:         cfg.GitContainerTemplate.Command,
 		Args: []string{
-			"--url",
-			*source.URL,
-			"--target",
-			fmt.Sprintf("$(params.%s-%s)", prefixParamsResultsVolumes, paramSourceRoot),
-			"--result-file-commit-sha",
-			fmt.Sprintf("$(results.%s-source-%s-%s.path)", prefixParamsResultsVolumes, name, commitSHAResult),
-			"--result-file-commit-author",
-			fmt.Sprintf("$(results.%s-source-%s-%s.path)", prefixParamsResultsVolumes, name, commitAuthorResult),
-			"--result-file-branch-name",
-			fmt.Sprintf("$(results.%s-source-%s-%s.path)", prefixParamsResultsVolumes, name, branchName),
-			"--result-file-error-message",
-			fmt.Sprintf("$(results.%s-error-message.path)", prefixParamsResultsVolumes),
-			"--result-file-error-reason",
-			fmt.Sprintf("$(results.%s-error-reason.path)", prefixParamsResultsVolumes),
+			"--url", *source.URL,
+			"--target", fmt.Sprintf("$(params.%s-%s)", prefixParamsResultsVolumes, paramSourceRoot),
+			"--result-file-commit-sha", fmt.Sprintf("$(results.%s-source-%s-%s.path)", prefixParamsResultsVolumes, name, commitSHAResult),
+			"--result-file-commit-author", fmt.Sprintf("$(results.%s-source-%s-%s.path)", prefixParamsResultsVolumes, name, commitAuthorResult),
+			"--result-file-commit-timestamp", fmt.Sprintf("$(results.%s-source-%s-%s.path)", prefixParamsResultsVolumes, name, commitTimestampResult),
+			"--result-file-branch-name", fmt.Sprintf("$(results.%s-source-%s-%s.path)", prefixParamsResultsVolumes, name, branchName),
+			"--result-file-error-message", fmt.Sprintf("$(results.%s-error-message.path)", prefixParamsResultsVolumes),
+			"--result-file-error-reason", fmt.Sprintf("$(results.%s-error-reason.path)", prefixParamsResultsVolumes),
 		},
 		Env:              cfg.GitContainerTemplate.Env,
 		ComputeResources: cfg.GitContainerTemplate.Resources,
@@ -111,15 +114,17 @@ func AppendGitStep(
 func AppendGitResult(buildRun *buildv1alpha1.BuildRun, name string, results []pipelineapi.TaskRunResult) {
 	commitAuthor := findResultValue(results, fmt.Sprintf("%s-source-%s-%s", prefixParamsResultsVolumes, name, commitAuthorResult))
 	commitSha := findResultValue(results, fmt.Sprintf("%s-source-%s-%s", prefixParamsResultsVolumes, name, commitSHAResult))
+	commitTimestamp := findResultValue(results, fmt.Sprintf("%s-source-%s-%s", prefixParamsResultsVolumes, name, commitTimestampResult))
 	branchName := findResultValue(results, fmt.Sprintf("%s-source-%s-%s", prefixParamsResultsVolumes, name, branchName))
 
-	if strings.TrimSpace(commitAuthor) != "" || strings.TrimSpace(commitSha) != "" || strings.TrimSpace(branchName) != "" {
+	if strings.TrimSpace(commitAuthor) != "" || strings.TrimSpace(commitSha) != "" || strings.TrimSpace(branchName) != "" || strings.TrimSpace(commitTimestamp) != "" {
 		buildRun.Status.Sources = append(buildRun.Status.Sources, buildv1alpha1.SourceResult{
 			Name: name,
 			Git: &buildv1alpha1.GitSourceResult{
-				CommitAuthor: commitAuthor,
-				CommitSha:    commitSha,
-				BranchName:   branchName,
+				CommitAuthor:    commitAuthor,
+				CommitSha:       commitSha,
+				CommitTimestamp: commitTimestamp,
+				BranchName:      branchName,
 			},
 		})
 	}

diff --git a/pkg/reconciler/buildrun/resources/sources/git_test.go b/pkg/reconciler/buildrun/resources/sources/git_test.go
@@ -36,31 +36,26 @@ var _ = Describe("Git", func() {
 		})
 
 		It("adds results for the commit sha, commit author and branch name", func() {
-			Expect(len(taskSpec.Results)).To(Equal(3))
+			Expect(len(taskSpec.Results)).To(Equal(4))
 			Expect(taskSpec.Results[0].Name).To(Equal("shp-source-default-commit-sha"))
 			Expect(taskSpec.Results[1].Name).To(Equal("shp-source-default-commit-author"))
-			Expect(taskSpec.Results[2].Name).To(Equal("shp-source-default-branch-name"))
+			Expect(taskSpec.Results[2].Name).To(Equal("shp-source-default-commit-timestamp"))
+			Expect(taskSpec.Results[3].Name).To(Equal("shp-source-default-branch-name"))
 		})
 
 		It("adds a step", func() {
 			Expect(len(taskSpec.Steps)).To(Equal(1))
 			Expect(taskSpec.Steps[0].Name).To(Equal("source-default"))
 			Expect(taskSpec.Steps[0].Image).To(Equal(cfg.GitContainerTemplate.Image))
 			Expect(taskSpec.Steps[0].Args).To(Equal([]string{
-				"--url",
-				"https://github.com/shipwright-io/build",
-				"--target",
-				"$(params.shp-source-root)",
-				"--result-file-commit-sha",
-				"$(results.shp-source-default-commit-sha.path)",
-				"--result-file-commit-author",
-				"$(results.shp-source-default-commit-author.path)",
-				"--result-file-branch-name",
-				"$(results.shp-source-default-branch-name.path)",
-				"--result-file-error-message",
-				"$(results.shp-error-message.path)",
-				"--result-file-error-reason",
-				"$(results.shp-error-reason.path)",
+				"--url", "https://github.com/shipwright-io/build",
+				"--target", "$(params.shp-source-root)",
+				"--result-file-commit-sha", "$(results.shp-source-default-commit-sha.path)",
+				"--result-file-commit-author", "$(results.shp-source-default-commit-author.path)",
+				"--result-file-commit-timestamp", "$(results.shp-source-default-commit-timestamp.path)",
+				"--result-file-branch-name", "$(results.shp-source-default-branch-name.path)",
+				"--result-file-error-message", "$(results.shp-error-message.path)",
+				"--result-file-error-reason", "$(results.shp-error-reason.path)",
 			}))
 		})
 	})
@@ -83,10 +78,11 @@ var _ = Describe("Git", func() {
 		})
 
 		It("adds results for the commit sha, commit author and branch name", func() {
-			Expect(len(taskSpec.Results)).To(Equal(3))
+			Expect(len(taskSpec.Results)).To(Equal(4))
 			Expect(taskSpec.Results[0].Name).To(Equal("shp-source-default-commit-sha"))
 			Expect(taskSpec.Results[1].Name).To(Equal("shp-source-default-commit-author"))
-			Expect(taskSpec.Results[2].Name).To(Equal("shp-source-default-branch-name"))
+			Expect(taskSpec.Results[2].Name).To(Equal("shp-source-default-commit-timestamp"))
+			Expect(taskSpec.Results[3].Name).To(Equal("shp-source-default-branch-name"))
 		})
 
 		It("adds a volume for the secret", func() {
@@ -101,22 +97,15 @@ var _ = Describe("Git", func() {
 			Expect(taskSpec.Steps[0].Name).To(Equal("source-default"))
 			Expect(taskSpec.Steps[0].Image).To(Equal(cfg.GitContainerTemplate.Image))
 			Expect(taskSpec.Steps[0].Args).To(Equal([]string{
-				"--url",
-				"[email protected]:shipwright-io/build.git",
-				"--target",
-				"$(params.shp-source-root)",
-				"--result-file-commit-sha",
-				"$(results.shp-source-default-commit-sha.path)",
-				"--result-file-commit-author",
-				"$(results.shp-source-default-commit-author.path)",
-				"--result-file-branch-name",
-				"$(results.shp-source-default-branch-name.path)",
-				"--result-file-error-message",
-				"$(results.shp-error-message.path)",
-				"--result-file-error-reason",
-				"$(results.shp-error-reason.path)",
-				"--secret-path",
-				"/workspace/shp-source-secret",
+				"--url", "[email protected]:shipwright-io/build.git",
+				"--target", "$(params.shp-source-root)",
+				"--result-file-commit-sha", "$(results.shp-source-default-commit-sha.path)",
+				"--result-file-commit-author", "$(results.shp-source-default-commit-author.path)",
+				"--result-file-commit-timestamp", "$(results.shp-source-default-commit-timestamp.path)",
+				"--result-file-branch-name", "$(results.shp-source-default-branch-name.path)",
+				"--result-file-error-message", "$(results.shp-error-message.path)",
+				"--result-file-error-reason", "$(results.shp-error-reason.path)",
+				"--secret-path", "/workspace/shp-source-secret",
 			}))
 			Expect(len(taskSpec.Steps[0].VolumeMounts)).To(Equal(1))
 			Expect(taskSpec.Steps[0].VolumeMounts[0].Name).To(Equal("shp-a-secret"))

diff --git a/pkg/reconciler/buildrun/resources/taskrun_test.go b/pkg/reconciler/buildrun/resources/taskrun_test.go
@@ -84,20 +84,14 @@ var _ = Describe("GenerateTaskrun", func() {
 				Expect(got.Steps[0].Name).To(Equal("source-default"))
 				Expect(got.Steps[0].Command[0]).To(Equal("/ko-app/git"))
 				Expect(got.Steps[0].Args).To(Equal([]string{
-					"--url",
-					*build.Spec.Source.URL,
-					"--target",
-					"$(params.shp-source-root)",
-					"--result-file-commit-sha",
-					"$(results.shp-source-default-commit-sha.path)",
-					"--result-file-commit-author",
-					"$(results.shp-source-default-commit-author.path)",
-					"--result-file-branch-name",
-					"$(results.shp-source-default-branch-name.path)",
-					"--result-file-error-message",
-					"$(results.shp-error-message.path)",
-					"--result-file-error-reason",
-					"$(results.shp-error-reason.path)",
+					"--url", *build.Spec.Source.URL,
+					"--target", "$(params.shp-source-root)",
+					"--result-file-commit-sha", "$(results.shp-source-default-commit-sha.path)",
+					"--result-file-commit-author", "$(results.shp-source-default-commit-author.path)",
+					"--result-file-commit-timestamp", "$(results.shp-source-default-commit-timestamp.path)",
+					"--result-file-branch-name", "$(results.shp-source-default-branch-name.path)",
+					"--result-file-error-message", "$(results.shp-error-message.path)",
+					"--result-file-error-reason", "$(results.shp-error-reason.path)",
 				}))
 			})
 

diff --git a/test/integration/build_to_buildruns_test.go b/test/integration/build_to_buildruns_test.go
@@ -39,6 +39,7 @@ var _ = Describe("Integration tests Build and BuildRuns", func() {
 		Expect(err).To(BeNil())
 
 	})
+
 	// Delete the ClusterBuildStrategies after each test case
 	AfterEach(func() {
 

diff --git a/test/integration/build_to_git_test.go b/test/integration/build_to_git_test.go
@@ -7,10 +7,12 @@ package integration_test
 import (
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
-	"github.com/shipwright-io/build/pkg/apis/build/v1alpha1"
-	test "github.com/shipwright-io/build/test/v1alpha1_samples"
+
 	corev1 "k8s.io/api/core/v1"
 	"k8s.io/utils/pointer"
+
+	"github.com/shipwright-io/build/pkg/apis/build/v1alpha1"
+	test "github.com/shipwright-io/build/test/v1alpha1_samples"
 )
 
 var _ = Describe("Integration tests Build and referenced Source url", func() {