jenkins/sap-jenkins-library
1
0
Fork 0
mirror of https://github.com/SAP/jenkins-library.git synced 2024-12-12 10:55:20 +02:00
Code Issues Releases Activity

GitHub steps: convenience updates (#2026)

Browse Source 
* GitHub steps: convenience updates

* update generated files

* Update cmd/githubCheckBranchProtection.go

Co-authored-by: Christopher Fenner <26137398+CCFenner@users.noreply.github.com>

* Update cmd/githubCheckBranchProtection.go

Co-authored-by: Christopher Fenner <26137398+CCFenner@users.noreply.github.com>

* Update cmd/githubCheckBranchProtection.go

Co-authored-by: Christopher Fenner <26137398+CCFenner@users.noreply.github.com>
This commit is contained in:
Oliver Nocon 2020-09-15 17:50:55 +02:00 committed by GitHub
parent c1852dbc17
commit 328ee34369
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
12 changed files with 60 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
cmd/githubCheckBranchProtection.go
View File

@ -39,7 +39,10 @@ func runGithubCheckBranchProtection(ctx context.Context, config *githubCheckBran
// validate required status checks
for _, check := range config.RequiredChecks {
var found bool
foundContexts := ghProtection.GetRequiredStatusChecks().Contexts
foundContexts := []string{}
if requiredStatusChecks := ghProtection.GetRequiredStatusChecks(); requiredStatusChecks != nil {
foundContexts = requiredStatusChecks.Contexts
}
for _, context := range foundContexts {
if check == context {
found = true

6
cmd/githubCheckBranchProtection_generated.go
View File

@ -83,7 +83,7 @@ It can for example be used to verify if certain status checks are mandatory. Thi
func addGithubCheckBranchProtectionFlags(cmd *cobra.Command, stepConfig *githubCheckBranchProtectionOptions) {
cmd.Flags().StringVar(&stepConfig.APIURL, "apiUrl", `https://api.github.com`, "Set the GitHub API url.")
cmd.Flags().StringVar(&stepConfig.Branch, "branch", os.Getenv("PIPER_branch"), "The name of the branch for which the protection settings should be checked.")
cmd.Flags().StringVar(&stepConfig.Branch, "branch", `master`, "The name of the branch for which the protection settings should be checked.")
cmd.Flags().StringVar(&stepConfig.Owner, "owner", os.Getenv("PIPER_owner"), "Name of the GitHub organization.")
cmd.Flags().StringVar(&stepConfig.Repository, "repository", os.Getenv("PIPER_repository"), "Name of the GitHub repository.")
cmd.Flags().StringSliceVar(&stepConfig.RequiredChecks, "requiredChecks", []string{}, "List of checks which have to be set to 'required' in the GitHub repository configuration.")
@ -126,7 +126,7 @@ func githubCheckBranchProtectionMetadata() config.StepData {
},
{
Name: "owner",
ResourceRef: []config.ResourceReference{},
ResourceRef: []config.ResourceReference{{Name: "commonPipelineEnvironment", Param: "github/owner"}},
Scope: []string{"PARAMETERS", "STAGES", "STEPS"},
Type: "string",
Mandatory: true,
@ -134,7 +134,7 @@ func githubCheckBranchProtectionMetadata() config.StepData {
},
{
Name: "repository",
ResourceRef: []config.ResourceReference{},
ResourceRef: []config.ResourceReference{{Name: "commonPipelineEnvironment", Param: "github/repository"}},
Scope: []string{"PARAMETERS", "STAGES", "STEPS"},
Type: "string",
Mandatory: true,

9
cmd/githubCheckBranchProtection_test.go
View File

@ -69,6 +69,15 @@ func TestRunGithubCheckBranchProtection(t *testing.T) {
assert.Equal(t, config.Repository, ghRepo.repo)
})
t.Run("no status checks", func(t *testing.T) {
config := githubCheckBranchProtectionOptions{
RequiredChecks: []string{"check1", "check2"},
}
ghRepo := ghCheckBranchRepoService{protection: github.Protection{}}
err := runGithubCheckBranchProtection(ctx, &config, &telemetryData, &ghRepo)
assert.Contains(t, fmt.Sprint(err), "required status check 'check1' not found")
})
t.Run("status check missing", func(t *testing.T) {
config := githubCheckBranchProtectionOptions{
RequiredChecks: []string{"check1", "check2"},

4
cmd/githubCreatePullRequest_generated.go
View File

@ -160,7 +160,7 @@ func githubCreatePullRequestMetadata() config.StepData {
},
{
Name: "owner",
ResourceRef: []config.ResourceReference{},
ResourceRef: []config.ResourceReference{{Name: "commonPipelineEnvironment", Param: "github/owner"}},
Scope: []string{"PARAMETERS", "STAGES", "STEPS"},
Type: "string",
Mandatory: true,
@ -168,7 +168,7 @@ func githubCreatePullRequestMetadata() config.StepData {
},
{
Name: "repository",
ResourceRef: []config.ResourceReference{},
ResourceRef: []config.ResourceReference{{Name: "commonPipelineEnvironment", Param: "github/repository"}},
Scope: []string{"PARAMETERS", "STAGES", "STEPS"},
Type: "string",
Mandatory: true,

2
cmd/githubSetCommitStatus.go
View File

@ -29,7 +29,7 @@ func githubSetCommitStatus(config githubSetCommitStatusOptions, telemetryData *t
}
func runGithubSetCommitStatus(ctx context.Context, config *githubSetCommitStatusOptions, telemetryData *telemetry.CustomData, ghRepositoriesService gitHubCommitStatusRepositoriesService) error {
status := github.RepoStatus{State: &config.Status, TargetURL: &config.TargetURL}
status := github.RepoStatus{Context: &config.Context, Description: &config.Description, State: &config.Status, TargetURL: &config.TargetURL}
_, _, err := ghRepositoriesService.CreateStatus(ctx, config.Owner, config.Repository, config.CommitID, &status)
if err != nil {
return errors.Wrapf(err, "failed to set status '%v' on commitId '%v'", config.Status, config.CommitID)

6
cmd/githubSetCommitStatus_generated.go
View File

@ -129,7 +129,7 @@ func githubSetCommitStatusMetadata() config.StepData {
},
{
Name: "commitId",
ResourceRef: []config.ResourceReference{},
ResourceRef: []config.ResourceReference{{Name: "commonPipelineEnvironment", Param: "git/commitId"}},
Scope: []string{"PARAMETERS", "STAGES", "STEPS"},
Type: "string",
Mandatory: true,
@ -153,7 +153,7 @@ func githubSetCommitStatusMetadata() config.StepData {
},
{
Name: "owner",
ResourceRef: []config.ResourceReference{},
ResourceRef: []config.ResourceReference{{Name: "commonPipelineEnvironment", Param: "github/owner"}},
Scope: []string{"PARAMETERS", "STAGES", "STEPS"},
Type: "string",
Mandatory: true,
@ -161,7 +161,7 @@ func githubSetCommitStatusMetadata() config.StepData {
},
{
Name: "repository",
ResourceRef: []config.ResourceReference{},
ResourceRef: []config.ResourceReference{{Name: "commonPipelineEnvironment", Param: "github/repository"}},
Scope: []string{"PARAMETERS", "STAGES", "STEPS"},
Type: "string",
Mandatory: true,

4
cmd/githubSetCommitStatus_test.go
View File

@ -33,10 +33,10 @@ func TestRunGithubSetCommitStatus(t *testing.T) {
telemetryData := telemetry.CustomData{}
t.Run("success case", func(t *testing.T) {
config := githubSetCommitStatusOptions{CommitID: "testSha", Owner: "testOrg", Repository: "testRepo", Status: "success", TargetURL: "https://test.url"}
config := githubSetCommitStatusOptions{CommitID: "testSha", Context: "test /context", Description: "testDescription", Owner: "testOrg", Repository: "testRepo", Status: "success", TargetURL: "https://test.url"}
ghRepo := ghSetCommitRepoService{}
err := runGithubSetCommitStatus(ctx, &config, &telemetryData, &ghRepo)
expectedStatus := github.RepoStatus{State: &config.Status, TargetURL: &config.TargetURL}
expectedStatus := github.RepoStatus{Context: &config.Context, Description: &config.Description, State: &config.Status, TargetURL: &config.TargetURL}
assert.NoError(t, err)
assert.Equal(t, config.CommitID, ghRepo.ref)
assert.Equal(t, config.Owner, ghRepo.owner)

13
documentation/docs/steps/githubCreatePullRequest.md Normal file
View File

@ -0,0 +1,13 @@
# ${docGenStepName}
## Prerequisites
You need to create a personal access token within GitHub and add this to the Jenkins credentials store.
Please see [GitHub documentation for details about creating the personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/).
## ${docGenParameters}
## ${docGenConfiguration}
## ${docGenDescription}

1
documentation/mkdocs.yml
View File

@ -81,6 +81,7 @@ nav:
- gctsExecuteABAPUnitTests: steps/gctsExecuteABAPUnitTests.md
- gctsRollback: steps/gctsRollback.md
- githubCheckBranchProtection: steps/githubCheckBranchProtection.md
- githubCreatePullRequest: steps/githubCreatePullRequest.md
- githubPublishRelease: steps/githubPublishRelease.md
- githubSetCommitStatus: steps/githubSetCommitStatus.md
- hadolintExecute: steps/hadolintExecute.md

7
resources/metadata/githubbranchprotection.yaml
View File

@ -31,11 +31,15 @@ spec:
- STAGES
- STEPS
type: string
default: master
mandatory: true
- name: owner
aliases:
- name: githubOrg
description: Name of the GitHub organization.
resourceRef:
- name: commonPipelineEnvironment
param: github/owner
scope:
- PARAMETERS
- STAGES
@ -46,6 +50,9 @@ spec:
aliases:
- name: githubRepo
description: Name of the GitHub repository.
resourceRef:
- name: commonPipelineEnvironment
param: github/repository
scope:
- PARAMETERS
- STAGES

6
resources/metadata/githubcreatepr.yaml
View File

@ -59,6 +59,9 @@ spec:
aliases:
- name: githubOrg
description: Name of the GitHub organization.
resourceRef:
- name: commonPipelineEnvironment
param: github/owner
scope:
- PARAMETERS
- STAGES
@ -69,6 +72,9 @@ spec:
aliases:
- name: githubRepo
description: Name of the GitHub repository.
resourceRef:
- name: commonPipelineEnvironment
param: github/repository
scope:
- PARAMETERS
- STAGES

9
resources/metadata/githubstatus.yaml
View File

@ -33,6 +33,9 @@ spec:
mandatory: true
- name: commitId
description: The commitId for which the status should be set.
resourceRef:
- name: commonPipelineEnvironment
param: git/commitId
scope:
- PARAMETERS
- STAGES
@ -58,6 +61,9 @@ spec:
aliases:
- name: githubOrg
description: Name of the GitHub organization.
resourceRef:
- name: commonPipelineEnvironment
param: github/owner
scope:
- PARAMETERS
- STAGES
@ -68,6 +74,9 @@ spec:
aliases:
- name: githubRepo
description: Name of the GitHub repository.
resourceRef:
- name: commonPipelineEnvironment
param: github/repository
scope:
- PARAMETERS
- STAGES