/
install.go
242 lines (216 loc) · 5.69 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
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
// 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"
"path"
"github.com/ossf/scorecard-action/install/github"
"github.com/ossf/scorecard-action/install/options"
)
const (
commitMessage = ".github: Add scorecard workflow"
pullRequestBranch = "scorecard-action-install"
workflowBase = ".github/workflows"
workflowFile = "scorecards.yml"
workflowFileDeprecated = "scorecards-analysis.yml"
)
var (
branchReference = fmt.Sprintf("refs/heads/%s", pullRequestBranch)
pullRequestDescription = `This pull request was generated using the installer tool for scorecard's GitHub Action.
To report any issues with this tool, see [here](https://github.com/ossf/scorecard-action).
`
pullRequestTitle = commitMessage
workflowFilePath = path.Join(workflowBase, workflowFile)
workflowFiles = []string{
workflowFilePath,
path.Join(workflowBase, 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.
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 := github.New(ctx)
// If not provided, get all repositories under organization.
if len(o.Repositories) == 0 {
log.Print("No repositories provided. Fetching all repositories under organization.")
repos, _, err := gh.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 {
log.Printf("Processing repository: %s", repoName)
err := processRepo(ctx, gh, o.Owner, repoName, workflowContent)
if err != nil {
log.Printf("processing repository: %+v", err)
}
log.Printf(
"finished processing repository %s",
repoName,
)
}
return nil
}
func processRepo(
ctx context.Context,
gh *github.Client,
owner, repoName string,
workflowContent []byte,
) error {
// Get repo metadata.
log.Printf("getting repo metadata for %s", repoName)
repo, _, err := gh.GetRepository(ctx, owner, repoName)
if err != nil {
return fmt.Errorf(
"getting repository: %w",
err,
)
}
// Get head commit SHA of default branch.
// TODO: Capture branch access errors
defaultBranch, _, err := gh.GetBranch(
ctx,
owner,
repoName,
*repo.DefaultBranch,
true,
)
if err != nil {
return fmt.Errorf(
"getting default branch for %s: %w",
repoName,
err,
)
}
defaultBranchSHA := defaultBranch.Commit.SHA
// Skip if scorecard file already exists in workflows folder.
workflowExists := false
for i, f := range workflowFiles {
log.Printf(
"checking for scorecard workflow file (%s)",
f,
)
scoreFileContent, _, _, err := gh.GetContents(
ctx,
owner,
repoName,
f,
github.CreateRepositoryContentGetOptions(),
)
if scoreFileContent != nil {
log.Printf(
"skipping repo (%s) since scorecard workflow already exists: %s",
repoName,
f,
)
workflowExists = true
break
}
if err != nil && i == len(workflowFiles)-1 {
log.Printf("could not find a scorecard workflow file: %+v", err)
}
}
if !workflowExists {
// Skip if branch scorecard already exists.
scorecardBranch, _, err := gh.GetBranch(
ctx,
owner,
repoName,
pullRequestBranch,
true,
)
if scorecardBranch != nil || err == nil {
log.Printf(
"skipping repo (%s) since the scorecard action installation branch already exists",
repoName,
)
return nil
}
// Create new branch using a reference that stores the new commit hash.
// TODO: Capture ref creation errors
ref := github.CreateGitRefOptions(branchReference, defaultBranchSHA)
_, _, err = gh.CreateGitRef(ctx, owner, repoName, ref)
if err != nil {
return fmt.Errorf(
"creating scorecard action installation branch for %s: %w",
repoName,
err,
)
}
// Create file in repository.
// TODO: Capture file creation errors
opts := github.CreateRepositoryContentFileOptions(
workflowContent,
commitMessage,
pullRequestBranch,
)
_, _, err = gh.CreateFile(
ctx,
owner,
repoName,
workflowFilePath,
opts,
)
if err != nil {
return fmt.Errorf(
"creating scorecard workflow file for %s: %w",
repoName,
err,
)
}
// Create pull request.
// TODO: Capture pull request creation errors
_, err = gh.CreatePullRequest(
ctx,
owner,
repoName,
*defaultBranch.Name,
pullRequestBranch,
pullRequestTitle,
pullRequestDescription,
)
if err != nil {
return fmt.Errorf(
"creating pull request for %s: %w",
repoName,
err,
)
}
}
return nil
}