-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
github.go
374 lines (339 loc) · 14.4 KB
/
github.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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
// Package cocogh to collect GitHub contents
package cocogh
import (
"context"
"fmt"
"net/http"
"strings"
"time"
"github.com/google/go-github/v57/github"
"github.com/shurcooL/githubv4"
)
// GHQueryForListFiles is a struct representing the GraphQL query for listing files in a GitHub repository.
// It contains the information necessary to make the query, including the owner, name, expression, and path of the repository.
type GHQueryForListFiles struct {
Repository struct {
Object struct {
Tree struct {
Entries []struct {
Name string
Path string
Type string
}
} `graphql:"... on Tree"`
} `graphql:"object(expression: $expression)"`
} `graphql:"repository(owner: $owner, name: $name)"`
}
// Paths represents a collection of file paths that have been added, removed, or modified.
type Paths struct {
Added []string
Removed []string
Modified []string
}
// GitHubFilter represents a filter used to narrow down the file paths in a GitHub repository based on the file path and file types.
type GitHubFilter struct {
FilePath string
FileTypes []string
}
// GitHubConfig represents the configuration for GitHub repositories.
//
// Owner represents the owner of the repositories.
// Repositories represents a list of repository names.
// DefaultBranch represents the default branch for the repositories.
// Filter represents the filter to apply when fetching file paths from the repositories.
type GitHubConfig struct {
Owner string
Repositories []string
DefaultBranch string
Filter GitHubFilter
}
// GitHub stores CommitOpsClient, GraphQLClient and configuration.
type GitHub struct {
Configuration GitHubConfig
graphQLClient GraphQLClient
commitOpsClient CommitOpsClient
}
// GraphQLClient is an interface to help test the GitHub GraphQLClient.
type GraphQLClient interface {
Query(ctx context.Context, q interface{}, variables map[string]interface{}) error
}
// CommitOpsClient is an interface to help test the GitHub GitHubCommitsOpsClient.
type CommitOpsClient interface {
ListCommits(ctx context.Context, owner, repo string, opts *github.CommitsListOptions) ([]*github.RepositoryCommit, *github.Response, error)
GetCommit(ctx context.Context, owner, repo, sha string, opts *github.ListOptions) (*github.RepositoryCommit, *github.Response, error)
}
// GitHubCommitsOpsClient is a type that represents an operations client for GitHub commits.
// It contains a pointer to a GitHub client from the go-github library.
type GitHubCommitsOpsClient struct {
GitHubClient *github.Client
}
// NewGitHubCommitsOpsClient creates a new GitHubCommitsOpsClient with the given http.Client.
// It initializes the GitHubClient inside GitHubCommitsOpsClient using the provided http.Client.
// The GitHubClient is responsible for interacting with the GitHub API.
func NewGitHubCommitsOpsClient(httpClient *http.Client) *GitHubCommitsOpsClient {
gc := github.NewClient(httpClient)
return &GitHubCommitsOpsClient{GitHubClient: gc}
}
// ListCommits fetches the list of commits for a specific repository.
func (gClient *GitHubCommitsOpsClient) ListCommits(ctx context.Context, owner, repo string, opts *github.CommitsListOptions) ([]*github.RepositoryCommit, *github.Response, error) {
return gClient.GitHubClient.Repositories.ListCommits(ctx, owner, repo, opts)
}
// GetCommit retrieves a specific commit from a repository.
//
// Parameters:
// - ctx: The context.Context used for the API call. It allows you to cancel
// the request, set deadlines, etc.
// - owner: The username or organization name of the repository owner. This
// string identifies the owner of the repository.
// - repo: The name of the repository. It specifies which repository's commit
// is being retrieved.
// - sha: The SHA hash of the commit. This string uniquely identifies the commit
// within the repository.
// - opts: Optional parameters for the API call, provided as a pointer to
// github.ListOptions. This includes pagination options.
//
// Returns:
// - *github.RepositoryCommit: The retrieved commit information, including details
// like the commit message, author, etc.
// - *github.Response: The HTTP response from the API call. This includes
// information like the status code and headers.
// - error: An error instance if an error occurs during the API call. It will be
// nil if the call is successful.
//
// Example:
//
// commit, resp, err := gClient.GetCommit(ctx, "octocat", "hello-world", "6dcb09b5b57875f334f61aebed695e2e4193db5e", nil)
func (gClient *GitHubCommitsOpsClient) GetCommit(ctx context.Context, owner, repo, sha string, opts *github.ListOptions) (*github.RepositoryCommit, *github.Response, error) {
return gClient.GitHubClient.Repositories.GetCommit(ctx, owner, repo, sha, opts)
}
// NewGitHubClient creates a new instance of the GitHub client.
// It takes a CommitOpsClient, GraphQLClient, and GitHubConfig as parameters and returns a pointer to a GitHub struct.
// The CommitOpsClient is responsible for making REST API calls to the GitHub API.
// The GraphQLClient is responsible for making GraphQL API calls to the GitHub API.
// The GitHubConfig contains the configuration parameters for the GitHub client, such as owner, repositories, default branch,
// and filter options.
// The new GitHub client is initialized with the provided CommitOpsClient, GraphQLClient, and GitHubConfig.
// The GitHub client can be used to interact with the GitHub API and perform various operations, such as retrieving file paths for repositories
// and getting changed file paths since a specified time.
// Usage:
//
// commitOpsClient := NewGitHubCommitsOpsClient()
// graphQLClient := NewGraphQLClient()
//
// config := GitHubConfig{
// Owner: "testowner",
// Repositories: []string{"repo1", "repo2"},
// DefaultBranch: "main",
// Filter: GitHubFilter{
// FilePath: "path/to/files",
// FileTypes: []string{".txt"},
// },
// }
//
// githubClient := NewGitHubClient(commitOpsClient, graphQLClient, config)
// filepaths, err := githubClient.GetFilePathsFromRepositories()
//
// if err != nil {
// log.Fatal(err)
// }
//
// for _, path := range filepaths {
// fmt.Println(path)
// }
func NewGitHubClient(commitOpsClient CommitOpsClient, graphQLClient GraphQLClient, configuration GitHubConfig) *GitHub {
return &GitHub{
commitOpsClient: commitOpsClient,
graphQLClient: graphQLClient,
Configuration: configuration,
}
}
// GetFilePathsFromRepositories retrieves the file paths for the repositories specified in the GitHub configuration.
// It iterates over each repository, calls the getFilePathsForRepo method to get the file paths, and appends them to the files slice.
// If there are no file types specified in the configuration, it returns the files directly.
// Otherwise, it filters the files based on the file types specified in the configuration and returns the filtered files.
// If there's an error during the process, it returns nil and the error.
//
// Usage:
//
// repos := []string{"repo1", "repo2", "repo3"}
// filePaths, err := GetFilePathsFromRepositories(repos)
// if err != nil {
// log.Fatal(err)
// }
//
// for _, paths := range filePaths {
// for _, path := range paths {
// fmt.Println(path)
// }
// }
func (c *GitHub) GetFilePathsFromRepositories() ([]string, error) {
var files []string
for _, repo := range c.Configuration.Repositories {
fs, err := c.getFilePathsForRepo(c.Configuration.Owner, repo, fmt.Sprintf("%s:%s", c.Configuration.DefaultBranch, c.Configuration.Filter.FilePath))
if err != nil {
return nil, err
}
files = append(files, fs...)
}
if len(c.Configuration.Filter.FileTypes) == 0 {
return files, nil
}
var filteredFiles []string
for i, file := range files {
if !c.hasFileType(file, c.Configuration.Filter.FileTypes) {
continue
}
filteredFiles = append(filteredFiles, files[i])
}
return filteredFiles, nil
}
// GetChangedFilePathsSince retrieves the list of file paths that have changed in the specified repositories
// within the specified time frame. The function iterates over repositories defined in the GitHub configuration
// and uses the GitHub commit operations client to fetch the commits and commit details for each repository.
// It aggregates the file paths from all repositories into a single Paths object. The function filters these file
// paths based on the directory filter and the specified time frame and file path filter defined in the GitHub
// configuration. The Paths object is populated with lists of added, removed, and modified file paths accordingly.
//
// Parameters:
// - hoursSince: An integer representing the number of hours since the specified time. This parameter is used
// to determine the time frame for fetching changed file paths.
//
// Returns:
// - Paths: A struct containing lists of added, removed, and modified file paths. This struct provides an
// organized way to access the changed files.
// - error: An error instance if an error occurs during the execution of the function. It will be nil if
// the function executes successfully.
//
// Usage:
//
// const sinceHours = 24
// changedFiles, err := c.GetChangedFilePathsSince(sinceHours)
// if err != nil {
// log.Fatal(err)
// }
//
// fmt.Println("Added files:", changedFiles.Added)
// fmt.Println("Modified files:", changedFiles.Modified)
// fmt.Println("Removed files:", changedFiles.Removed)
func (c *GitHub) GetChangedFilePathsSince(since time.Time) (Paths, error) {
ctx := context.Background()
opt := &github.CommitsListOptions{
Since: since,
Path: c.Configuration.Filter.FilePath,
ListOptions: github.ListOptions{
PerPage: 100,
},
}
var paths Paths
for _, repo := range c.Configuration.Repositories {
commitPaths, err := c.getChangedFilePathsForRepo(ctx, repo, opt)
if err != nil {
return Paths{}, err
}
paths.Added = append(paths.Added, commitPaths.Added...)
paths.Removed = append(paths.Removed, commitPaths.Removed...)
paths.Modified = append(paths.Modified, commitPaths.Modified...)
}
return paths, nil
}
// getFilePathsForRepo fetches the list of file paths for a specific repository, starting from the specified
// expression. It uses the GitHub GraphQL API to retrieve the repository tree entries and their types, and
// recursively traverses the repository tree. The function appends file paths to a slice, which is then returned.
// If an entry is a blob, its path is added to the files slice. For tree entries, the function recurses with
// the updated expression and appends the returned subfiles to the files slice. If any error occurs during
// the GraphQL query or traversal, the function returns nil and the error.
//
// Parameters:
// - owner: A string representing the username of the repository owner. This parameter specifies the owner
// of the repository for which file paths are being fetched.
// - name: A string representing the name of the repository. This parameter is used to specify the repository
// from which the file paths are retrieved.
// - expression: A string specifying the starting expression for traversing the repository tree. This
// expression determines the starting point of the file path retrieval process.
//
// Returns:
// - files: A slice of strings, each representing a file path in the repository. This slice includes paths
// to all files found in the repository starting from the given expression.
// - error: An error instance, if any error occurred during the GraphQL query or traversal. It will be nil
// if the function executes successfully.
//
// Example usage:
//
// filePaths, err := c.getFilePathsForRepo("octocat", "hello-world", "master:")
// if err != nil {
// log.Fatal(err)
// }
// for _, path := range filePaths {
// fmt.Println(path)
// }
func (c *GitHub) getFilePathsForRepo(owner, name, expression string) ([]string, error) {
var query GHQueryForListFiles
variables := map[string]interface{}{
"owner": githubv4.String(owner),
"name": githubv4.String(name),
"expression": githubv4.String(expression),
}
err := c.graphQLClient.Query(context.Background(), &query, variables)
if err != nil {
return nil, err
}
var files []string
for _, entry := range query.Repository.Object.Tree.Entries {
if entry.Type == "blob" {
files = append(files, entry.Path)
} else if entry.Type == "tree" {
subFiles, err := c.getFilePathsForRepo(owner, name, expression+"/"+entry.Name)
if err != nil {
return nil, err
}
files = append(files, subFiles...)
}
}
return files, nil
}
// hasFileType checks if the given fileName ends with any of the fileTypes.
func (c *GitHub) hasFileType(fileName string, fileTypes []string) bool {
for _, fileType := range fileTypes {
if strings.HasSuffix(fileName, fileType) {
return true
}
}
return false
}
// getChangedFilePathsForRepo fetches the paths of files that have been changed in a specific repository.
// It takes the repository name, a CommitsListOptions object for filtering commits, and returns a Paths struct with added, removed, and modified files.
// The method iterates through the commits in the repository, retrieves commit details, and checks each file in the commit against the filter path.
// Depending on the type of change (added, removed, modified, renamed, copied), the file path is appended to the respective list in the Paths struct.
// The method returns the Paths struct and an error, if any.
func (c *GitHub) getChangedFilePathsForRepo(ctx context.Context, repo string, opt *github.CommitsListOptions) (Paths, error) {
var paths Paths
commits, _, err := c.commitOpsClient.ListCommits(ctx, c.Configuration.Owner, repo, opt)
if err != nil {
return paths, err
}
directory := c.Configuration.Filter.FilePath
for _, commit := range commits {
commitDetails, _, err := c.commitOpsClient.GetCommit(ctx, c.Configuration.Owner, repo, *commit.SHA, nil)
if err != nil {
return paths, err
}
for _, file := range commitDetails.Files {
if strings.HasPrefix(file.GetFilename(), directory) {
switch file.GetStatus() {
case "removed":
paths.Removed = append(paths.Removed, file.GetFilename())
case "added":
paths.Added = append(paths.Added, file.GetFilename())
case "modified", "changed":
paths.Modified = append(paths.Modified, file.GetFilename())
case "renamed":
paths.Removed = append(paths.Removed, file.GetPreviousFilename())
paths.Added = append(paths.Added, file.GetFilename())
case "copied":
paths.Added = append(paths.Added, file.GetFilename())
}
}
}
}
return paths, nil
}