Skip to content

Apply updates for GitHub AE. #51

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 20, 2021
Merged

Apply updates for GitHub AE. #51

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ From a machine with access to both GitHub.com and GitHub Enterprise Server use t

**Required Arguments:**
* `--destination-url` - The URL of the GitHub Enterprise Server instance to push the Action to.
* `--destination-token` - A [Personal Access Token](https://docs.github.com/en/enterprise/user/github/authenticating-to-github/creating-a-personal-access-token) for the destination GitHub Enterprise Server instance. The token should be granted at least the `public_repo` scope. If the destination repository is in an organization that does not yet exist or that you are not an owner of, your token will need to have the `site_admin` scope in order to create the organization. The organization can also be created manually or an existing organization used.
* `--destination-token` - A [Personal Access Token](https://docs.github.com/en/enterprise/user/github/authenticating-to-github/creating-a-personal-access-token) for the destination GitHub Enterprise Server instance. If the destination repository is in an organization that does not yet exist or that you are not an owner of, your token will need to have the `site_admin` scope in order to create the organization or update the repository in it. The organization can also be created manually or an existing organization that you own can be used, in which case the `repo` and `workflow` scopes are sufficient.

**Optional Arguments:**
* `--cache-dir` - A temporary directory in which to store data downloaded from GitHub.com before it is uploaded to GitHub Enterprise Server. If not specified a directory next to the sync tool will be used.
Expand All @@ -43,7 +43,7 @@ Now use the `./codeql-action-sync push` command to upload the CodeQL Action and

**Required Arguments:**
* `--destination-url` - The URL of the GitHub Enterprise Server instance to push the Action to.
* `--destination-token` - A [Personal Access Token](https://docs.github.com/en/enterprise/user/github/authenticating-to-github/creating-a-personal-access-token) for the destination GitHub Enterprise Server instance. The token should be granted at least the `public_repo` scope. If the destination repository is in an organization that does not yet exist or that you are not an owner of, your token will need to have the `site_admin` scope in order to create the organization. The organization can also be created manually or an existing organization used.
* `--destination-token` - A [Personal Access Token](https://docs.github.com/en/enterprise/user/github/authenticating-to-github/creating-a-personal-access-token) for the destination GitHub Enterprise Server instance. If the destination repository is in an organization that does not yet exist or that you are not an owner of, your token will need to have the `site_admin` scope in order to create the organization or update the repository in it. The organization can also be created manually or an existing organization that you own can be used, in which case the `repo` and `workflow` scopes are sufficient.

**Optional Arguments:**
* `--cache-dir` - The directory to which the Action was previously downloaded.
Expand Down
32 changes: 26 additions & 6 deletions internal/push/push.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ const errorInvalidDestinationToken = "The destination token you've provided is n

const enterpriseAPIPath = "/api/v3"
const enterpriseUploadsPath = "/api/uploads"
const enterpriseVersionHeaderKey = "X-GitHub-Enterprise-Version"
const enterpriseAegisVersionHeaderValue = "GitHub AE"

type pushService struct {
ctx context.Context
Expand All @@ -48,11 +50,21 @@ type pushService struct {
destinationRepositoryOwner string
destinationToken *oauth2.Token
actionsAdminUser string
aegis bool
force bool
pushSSH bool
}

func (pushService *pushService) createRepository() (*github.Repository, error) {
minimumRepositoryScope := "public_repo"
acceptableRepositoryScopes := []string{"public_repo", "repo"}
desiredVisibility := "public"
if pushService.aegis {
minimumRepositoryScope = "repo"
acceptableRepositoryScopes = []string{"repo"}
desiredVisibility = "internal"
}

log.Debug("Ensuring repository exists...")
user, response, err := pushService.githubEnterpriseClient.Users.Get(pushService.ctx, "")
if err != nil {
Expand Down Expand Up @@ -93,7 +105,7 @@ func (pushService *pushService) createRepository() (*github.Repository, error) {
}
if err != nil && githubapiutil.HasAnyScope(response, "site_admin") {
log.Debugf("No access to destination organization. Switching to impersonation token for %s...", pushService.actionsAdminUser)
impersonationToken, _, err := pushService.githubEnterpriseClient.Admin.CreateUserImpersonation(pushService.ctx, pushService.actionsAdminUser, &github.ImpersonateUserOptions{Scopes: []string{"public_repo", "workflow"}})
impersonationToken, _, err := pushService.githubEnterpriseClient.Admin.CreateUserImpersonation(pushService.ctx, pushService.actionsAdminUser, &github.ImpersonateUserOptions{Scopes: []string{minimumRepositoryScope, "workflow"}})
if err != nil {
return nil, errors.Wrap(err, "Failed to impersonate Actions admin user.")
}
Expand All @@ -117,22 +129,28 @@ func (pushService *pushService) createRepository() (*github.Repository, error) {
HasWiki: github.Bool(false),
HasDownloads: github.Bool(false),
Archived: github.Bool(false),
Private: github.Bool(false),
}
if repository.GetVisibility() != desiredVisibility {
// For some reason if you provide a visibility it must be different than the current visibility.
// It seems to be the only property that behaves this way, so we have to treat is specially...
desiredRepositoryProperties.Visibility = github.String(desiredVisibility)
}
if response.StatusCode == http.StatusNotFound {
log.Debug("Repository does not exist. Creating it...")
repository, response, err = pushService.githubEnterpriseClient.Repositories.Create(pushService.ctx, destinationOrganization, &desiredRepositoryProperties)
if err != nil {
if response.StatusCode == http.StatusNotFound && !githubapiutil.HasAnyScope(response, "public_repo", "repo") {
return nil, usererrors.New("The destination token you have provided does not have the `public_repo` scope.")
if response.StatusCode == http.StatusNotFound && !githubapiutil.HasAnyScope(response, acceptableRepositoryScopes...) {
return nil, fmt.Errorf("The destination token you have provided does not have the `%s` scope.", minimumRepositoryScope)
}
return nil, errors.Wrap(err, "Error creating destination repository.")
}
} else {
log.Debug("Repository already exists. Updating its metadata...")
repository, response, err = pushService.githubEnterpriseClient.Repositories.Edit(pushService.ctx, pushService.destinationRepositoryOwner, pushService.destinationRepositoryName, &desiredRepositoryProperties)
if err != nil {
if response.StatusCode == http.StatusNotFound {
if !githubapiutil.HasAnyScope(response, "public_repo", "repo") {
return nil, usererrors.New("The destination token you have provided does not have the `public_repo` scope.")
if !githubapiutil.HasAnyScope(response, acceptableRepositoryScopes...) {
return nil, fmt.Errorf("The destination token you have provided does not have the `%s` scope.", minimumRepositoryScope)
} else {
return nil, fmt.Errorf("You don't have permission to update the repository at %s/%s. If you wish to update the bundled CodeQL Action please provide a token with the `site_admin` scope.", pushService.destinationRepositoryOwner, pushService.destinationRepositoryName)
}
Expand Down Expand Up @@ -389,6 +407,7 @@ func Push(ctx context.Context, cacheDirectory cachedirectory.CacheDirectory, des
return errors.Wrap(err, "Error creating GitHub Enterprise client.")
}
}
aegis := rootResponse.Header.Get(enterpriseVersionHeaderKey) == enterpriseAegisVersionHeaderValue

destinationRepositorySplit := strings.Split(destinationRepository, "/")
destinationRepositoryOwner := destinationRepositorySplit[0]
Expand All @@ -402,6 +421,7 @@ func Push(ctx context.Context, cacheDirectory cachedirectory.CacheDirectory, des
destinationRepositoryName: destinationRepositoryName,
destinationToken: &token,
actionsAdminUser: actionsAdminUser,
aegis: aegis,
force: force,
pushSSH: pushSSH,
}
Expand Down