/
install.go
221 lines (193 loc) · 5.11 KB
/
install.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
// Copyright 2022 OpenSSF 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.
//
// SPDX-License-Identifier: Apache-2.0
package install
import (
"context"
"fmt"
"log"
"os"
"github.com/google/go-github/v42/github"
scagh "github.com/ossf/scorecard-action/install/github"
"github.com/ossf/scorecard-action/install/options"
)
const (
workflowFile = ".github/workflows/scorecards.yml"
workflowFileDeprecated = ".github/workflows/scorecards-analysis.yml"
)
var workflowFiles = []string{
workflowFile,
workflowFileDeprecated,
}
// Run adds the OpenSSF Scorecard workflow to all repositories under the given
// organization.
// TODO(install): Improve description.
// TODO(install): Accept a context instead of setting one.
// TODO(lint): cognitive complexity 31 of func `Run` is high (> 30) (gocognit).
//
// TODO(lint): cognitive complexity 31 of func `Run` is high (> 30) (gocognit).
//
//nolint:gocognit
func Run(o *options.Options) error {
err := o.Validate()
if err != nil {
return fmt.Errorf("validating installation options: %w", err)
}
// Get github user client.
ctx := context.Background()
gh := scagh.New()
client := gh.Client()
// If not provided, get all repositories under organization.
if len(o.Repositories) == 0 {
repos, _, err := client.GetRepositoriesByOrg(ctx, o.Owner)
if err != nil {
return fmt.Errorf("getting repos for owner (%s): %w", o.Owner, err)
}
// Convert to list of repository names.
for _, repo := range repos {
o.Repositories = append(o.Repositories, *repo.Name)
}
}
// Get yml file into byte array.
workflowContent, err := os.ReadFile(o.ConfigPath)
if err != nil {
return fmt.Errorf("reading scorecard workflow file: %w", err)
}
// Process each repository.
// TODO: Capture repo access errors
for _, repoName := range o.Repositories {
// Get repo metadata.
repo, _, err := client.GetRepository(ctx, o.Owner, repoName)
if err != nil {
log.Printf(
"skipped repo (%s) because it does not exist or could not be accessed: %+v",
repoName,
err,
)
continue
}
// Get head commit SHA of default branch.
// TODO: Capture branch access errors
defaultBranch, _, err := client.GetBranch(
ctx,
o.Owner,
repoName,
*repo.DefaultBranch,
true,
)
if err != nil {
log.Printf(
"skipped repo (%s) because its default branch could not be accessed: %+v",
repoName,
err,
)
continue
}
defaultBranchSHA := defaultBranch.Commit.SHA
// Skip if scorecard file already exists in workflows folder.
for _, f := range workflowFiles {
scoreFileContent, _, _, err := client.GetContents(
ctx,
o.Owner,
repoName,
f,
&github.RepositoryContentGetOptions{},
)
if scoreFileContent != nil || err == nil {
log.Printf(
"skipped repo (%s) since scorecard workflow already exists",
repoName,
)
continue
}
}
// Skip if branch scorecard already exists.
scorecardBranch, _, err := client.GetBranch(
ctx,
o.Owner,
repoName,
"scorecard",
true,
)
if scorecardBranch != nil || err == nil {
log.Printf(
"skipped repo (%s) since the scorecard branch already exists",
repoName,
)
continue
}
// Create new branch using a reference that stores the new commit hash.
// TODO: Capture ref creation errors
ref := &github.Reference{
Ref: github.String("refs/heads/scorecard"),
Object: &github.GitObject{SHA: defaultBranchSHA},
}
_, _, err = client.CreateGitRef(ctx, o.Owner, repoName, ref)
if err != nil {
log.Printf(
"skipped repo (%s) because new branch could not be created: %+v",
repoName,
err,
)
continue
}
// Create file in repository.
// TODO: Capture file creation errors
opts := &github.RepositoryContentFileOptions{
Message: github.String("Adding scorecard workflow"),
Content: workflowContent,
Branch: github.String("scorecard"),
}
_, _, err = client.CreateFile(
ctx,
o.Owner,
repoName,
workflowFile,
opts,
)
if err != nil {
log.Printf(
"skipped repo (%s) because new file could not be created: %+v",
repoName,
err,
)
continue
}
// Create pull request.
// TODO: Capture pull request creation errors
_, err = client.CreatePullRequest(
ctx,
o.Owner,
repoName,
*defaultBranch.Name,
"scorecard",
"Added Scorecard Workflow",
"Added the workflow for OpenSSF's Security Scorecard",
)
if err != nil {
log.Printf(
"skipped repo (%s) because pull request could not be created: %+v",
repoName,
err,
)
continue
}
log.Printf(
"Created a pull request to add the scorecard workflow to %s",
repoName,
)
}
return nil
}