feat(applicationset): add short sha to PR generator #9668

applicationset/generators/pull_request.go

@@ -80,12 +80,19 @@ func (g *PullRequestGenerator) GenerateParams(appSetGenerator *argoprojiov1alpha
 		"_": "-",
 	}
 
+	var shortSHALength int
 	for _, pull := range pulls {
+		shortSHALength = 8
+		if len(pull.HeadSHA) < 8 {
+			shortSHALength = len(pull.HeadSHA)
+		}
+
 		params = append(params, map[string]string{
-			"number":      strconv.Itoa(pull.Number),
-			"branch":      pull.Branch,
-			"branch_slug": slug.Make(pull.Branch),
-			"head_sha":    pull.HeadSHA,
+			"number":         strconv.Itoa(pull.Number),
+			"branch":         pull.Branch,
+			"branch_slug":    slug.Make(pull.Branch),
+			"head_sha":       pull.HeadSHA,
+			"head_short_sha": pull.HeadSHA[:shortSHALength],
 		})
 	}
 	return params, nil

applicationset/generators/pull_request_test.go

@@ -37,10 +37,11 @@ func TestPullRequestGithubGenerateParams(t *testing.T) {
 			},
 			expected: []map[string]string{
 				{
-					"number":      "1",
-					"branch":      "branch1",
-					"branch_slug": "branch1",
-					"head_sha":    "089d92cbf9ff857a39e6feccd32798ca700fb958",
+					"number":         "1",
+					"branch":         "branch1",
+					"branch_slug":    "branch1",
+					"head_sha":       "089d92cbf9ff857a39e6feccd32798ca700fb958",
+					"head_short_sha": "089d92cb",
 				},
 			},
 			expectedErr: nil,
@@ -61,10 +62,36 @@ func TestPullRequestGithubGenerateParams(t *testing.T) {
 			},
 			expected: []map[string]string{
 				{
-					"number":      "2",
-					"branch":      "feat/areally+long_pull_request_name_to_test_argo_slugification_and_branch_name_shortening_feature",
-					"branch_slug": "feat-areally-long-pull-request-name-to-test-argo",
-					"head_sha":    "9b34ff5bd418e57d58891eb0aa0728043ca1e8be",
+					"number":         "2",
+					"branch":         "feat/areally+long_pull_request_name_to_test_argo_slugification_and_branch_name_shortening_feature",
+					"branch_slug":    "feat-areally-long-pull-request-name-to-test-argo",
+					"head_sha":       "9b34ff5bd418e57d58891eb0aa0728043ca1e8be",
+					"head_short_sha": "9b34ff5b",
+				},
+			},
+			expectedErr: nil,
+		},
+		{
+			selectFunc: func(context.Context, *argoprojiov1alpha1.PullRequestGenerator, *argoprojiov1alpha1.ApplicationSet) (pullrequest.PullRequestService, error) {
+				return pullrequest.NewFakeService(
+					ctx,
+					[]*pullrequest.PullRequest{
+						&pullrequest.PullRequest{
+							Number:  1,
+							Branch:  "a-very-short-sha",
+							HeadSHA: "abcd",
+						},
+					},
+					nil,
+				)
+			},
+			expected: []map[string]string{
+				{
+					"number":         "1",
+					"branch":         "a-very-short-sha",
+					"branch_slug":    "a-very-short-sha",
+					"head_sha":       "abcd",
+					"head_short_sha": "abcd",
 				},
 			},
 			expectedErr: nil,

applicationset/generators/scm_provider.go

@@ -120,13 +120,20 @@ func (g *SCMProviderGenerator) GenerateParams(appSetGenerator *argoprojiov1alpha
 		return nil, fmt.Errorf("error listing repos: %v", err)
 	}
 	params := make([]map[string]string, 0, len(repos))
+	var shortSHALength int
 	for _, repo := range repos {
+		shortSHALength = 8
+		if len(repo.SHA) < 8 {
+			shortSHALength = len(repo.SHA)
+		}
+
 		params = append(params, map[string]string{
 			"organization":     repo.Organization,
 			"repository":       repo.Repository,
 			"url":              repo.URL,
 			"branch":           repo.Branch,
 			"sha":              repo.SHA,
+			"short_sha":        repo.SHA[:shortSHALength],
 			"labels":           strings.Join(repo.Labels, ","),
 			"branchNormalized": sanitizeName(repo.Branch),
 		})

applicationset/generators/scm_provider_test.go

@@ -87,15 +87,15 @@ func TestSCMProviderGenerateParams(t *testing.T) {
 				Repository:   "repo1",
 				URL:          "git@github.com:myorg/repo1.git",
 				Branch:       "main",
-				SHA:          "abcd1234",
+				SHA:          "0bc57212c3cbbec69d20b34c507284bd300def5b",
 				Labels:       []string{"prod", "staging"},
 			},
 			{
 				Organization: "myorg",
 				Repository:   "repo2",
 				URL:          "git@github.com:myorg/repo2.git",
 				Branch:       "main",
-				SHA:          "00000000",
+				SHA:          "59d0",
 			},
 		},
 	}
@@ -109,7 +109,9 @@ func TestSCMProviderGenerateParams(t *testing.T) {
 	assert.Equal(t, "repo1", params[0]["repository"])
 	assert.Equal(t, "git@github.com:myorg/repo1.git", params[0]["url"])
 	assert.Equal(t, "main", params[0]["branch"])
-	assert.Equal(t, "abcd1234", params[0]["sha"])
+	assert.Equal(t, "0bc57212c3cbbec69d20b34c507284bd300def5b", params[0]["sha"])
+	assert.Equal(t, "0bc57212", params[0]["short_sha"])
+	assert.Equal(t, "59d0", params[1]["short_sha"])
 	assert.Equal(t, "prod,staging", params[0]["labels"])
 	assert.Equal(t, "repo2", params[1]["repository"])
 }

docs/operator-manual/applicationset/Generators-Pull-Request.md

@@ -16,9 +16,9 @@ spec:
 ```
 
 !!! note
-    Know the security implications of PR generators in ApplicationSets. 
+    Know the security implications of PR generators in ApplicationSets.
     [Only admins may create ApplicationSets](./Security.md#only-admins-may-createupdatedelete-applicationsets) to avoid
-    leaking Secrets, and [only admins may create PRs](./Security.md#templated-project-field) if the `project` field of 
+    leaking Secrets, and [only admins may create PRs](./Security.md#templated-project-field) if the `project` field of
     an ApplicationSet with a PR generator is templated, to avoid granting management of out-of-bounds resources.
 
 ## GitHub
@@ -82,7 +82,7 @@ spec:
         # Labels is used to filter the MRs that you want to target. (optional)
         labels:
         - preview
-        # MR state is used to filter MRs only with a certain state. (optional) 
+        # MR state is used to filter MRs only with a certain state. (optional)
         pullRequestState: opened
   requeueAfterSeconds: 1800
   template:
@@ -263,8 +263,9 @@ spec:
 
 * `number`: The ID number of the pull request.
 * `branch`: The name of the branch of the pull request head.
-* `branch_slug`: The branch name will be cleaned to be conform to the DNS label standard as defined in [RFC 1123](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names), and truncated to 50 characters to give room to append/suffix-ing it with 13 more characters. 
+* `branch_slug`: The branch name will be cleaned to be conform to the DNS label standard as defined in [RFC 1123](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names), and truncated to 50 characters to give room to append/suffix-ing it with 13 more characters.
 * `head_sha`: This is the SHA of the head of the pull request.
+* `head_short_sha`: This is the short SHA of the head of the pull request (8 characters long or the length of the head SHA if it's shorter).
 
 ## Webhook Configuration
 

docs/operator-manual/applicationset/Generators-SCM-Provider.md

@@ -20,9 +20,9 @@ spec:
 * `cloneProtocol`: Which protocol to use for the SCM URL. Default is provider-specific but ssh if possible. Not all providers necessarily support all protocols, see provider documentation below for available options.
 
 !!! note
-    Know the security implications of using SCM generators. [Only admins may create ApplicationSets](./Security.md#only-admins-may-createupdatedelete-applicationsets) 
-    to avoid leaking Secrets, and [only admins may create repos/branches](./Security.md#templated-project-field) if the 
-    `project` field of an ApplicationSet with an SCM generator is templated, to avoid granting management of 
+    Know the security implications of using SCM generators. [Only admins may create ApplicationSets](./Security.md#only-admins-may-createupdatedelete-applicationsets)
+    to avoid leaking Secrets, and [only admins may create repos/branches](./Security.md#templated-project-field) if the
+    `project` field of an ApplicationSet with an SCM generator is templated, to avoid granting management of
     out-of-bounds resources.
 
 ## GitHub
@@ -180,7 +180,7 @@ Available clone protocols are `ssh` and `https`.
 
 ## Azure DevOps
 
-Uses the Azure DevOps API to look up eligible repositories based on a team project within an Azure DevOps organization. 
+Uses the Azure DevOps API to look up eligible repositories based on a team project within an Azure DevOps organization.
 The default Azure DevOps URL is `https://dev.azure.com`, but this can be overridden with the field `azureDevOps.api`.
 
 ```yaml
@@ -277,6 +277,7 @@ spec:
 * `repository`: The name of the repository.
 * `url`: The clone URL for the repository.
 * `branch`: The default branch of the repository.
-* `sha`: The Git commit SHA for the branch
-* `labels`: A comma-separated list of repository labels
+* `sha`: The Git commit SHA for the branch.
+* `short_sha`: The abbreviated Git commit SHA for the branch (8 chars or the length of the `sha` if it's shorter).
+* `labels`: A comma-separated list of repository labels.
 * `branchNormalized`: The value of `branch` normalized to contain only lowercase alphanumeric characters, '-' or '.'.