diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index c9de19da2..20bf83882 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -1,5 +1,5 @@ { - "image": "mcr.microsoft.com/devcontainers/go:1.19", + "image": "mcr.microsoft.com/devcontainers/go:1.22", "features": { "ghcr.io/devcontainers/features/sshd:1": {} }, diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 4b9029313..40683d917 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,5 +1,10 @@ * @cli/code-reviewers pkg/cmd/codespace/ @cli/codespaces -pkg/liveshare/ @cli/codespaces internal/codespaces/ @cli/codespaces + +# Limit Package Security team ownership to the attestation command package and related integration tests +pkg/cmd/attestation/ @cli/package-security +test/integration/attestation-cmd @cli/package-security + +pkg/cmd/attestation/verification/embed/tuf-repo.github.com/ @cli/tuf-root-reviewers diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 10f17a2fc..9f5d56376 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -16,6 +16,7 @@ Please do: Please avoid: * Opening pull requests for issues marked `needs-design`, `needs-investigation`, or `blocked`. +* Opening pull requests that haven't been approved for work in an issue * Adding installation instructions specifically for your OS/package manager. * Opening pull requests for any issue marked `core`. These issues require additional context from the core CLI team at GitHub and any external pull requests will not be accepted. @@ -23,7 +24,7 @@ Please avoid: ## Building the project Prerequisites: -- Go 1.21+ +- Go 1.22+ Build with: * Unix-like systems: `make` diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml index 4aa93810d..8cd5ecbee 100644 --- a/.github/workflows/codeql.yml +++ b/.github/workflows/codeql.yml @@ -21,13 +21,18 @@ jobs: steps: - name: Check out code - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Initialize CodeQL - uses: github/codeql-action/init@v2 + uses: github/codeql-action/init@v3 with: languages: go queries: security-and-quality + - name: Setup Go + uses: actions/setup-go@v5 + with: + go-version-file: 'go.mod' + - name: Perform CodeQL Analysis - uses: github/codeql-action/analyze@v2 + uses: github/codeql-action/analyze@v3 diff --git a/.github/workflows/deployment.yml b/.github/workflows/deployment.yml index 95f0f145c..9655d19bf 100644 --- a/.github/workflows/deployment.yml +++ b/.github/workflows/deployment.yml @@ -1,4 +1,5 @@ name: Deployment +run-name: ${{ inputs.tag_name }} / ${{ inputs.environment }} concurrency: group: ${{ github.workflow }}-${{ github.ref_name }} @@ -16,9 +17,6 @@ on: environment: default: production type: environment - go_version: - default: "1.21" - type: string platforms: default: "linux,macos,windows" type: string @@ -34,13 +32,13 @@ jobs: if: contains(inputs.platforms, 'linux') steps: - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Set up Go - uses: actions/setup-go@v4 + uses: actions/setup-go@v5 with: - go-version: ${{ inputs.go_version }} + go-version-file: 'go.mod' - name: Install GoReleaser - uses: goreleaser/goreleaser-action@v4 + uses: goreleaser/goreleaser-action@v5 with: version: "~1.17.1" install-only: true @@ -52,7 +50,7 @@ jobs: run: | go run ./cmd/gen-docs --website --doc-path dist/manual tar -czvf dist/manual.tar.gz -C dist -- manual - - uses: actions/upload-artifact@v3 + - uses: actions/upload-artifact@v4 with: name: linux if-no-files-found: error @@ -68,11 +66,11 @@ jobs: if: contains(inputs.platforms, 'macos') steps: - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Set up Go - uses: actions/setup-go@v4 + uses: actions/setup-go@v5 with: - go-version: ${{ inputs.go_version }} + go-version-file: 'go.mod' - name: Configure macOS signing if: inputs.environment == 'production' env: @@ -92,7 +90,7 @@ jobs: security set-key-partition-list -S "apple-tool:,apple:,codesign:" -s -k "$keychain_password" "$keychain" rm "$RUNNER_TEMP/cert.p12" - name: Install GoReleaser - uses: goreleaser/goreleaser-action@v4 + uses: goreleaser/goreleaser-action@v5 with: version: "~1.17.1" install-only: true @@ -123,7 +121,7 @@ jobs: run: | shopt -s failglob script/pkgmacos "$TAG_NAME" - - uses: actions/upload-artifact@v3 + - uses: actions/upload-artifact@v4 with: name: macos if-no-files-found: error @@ -139,35 +137,52 @@ jobs: if: contains(inputs.platforms, 'windows') steps: - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Set up Go - uses: actions/setup-go@v4 + uses: actions/setup-go@v5 with: - go-version: ${{ inputs.go_version }} - - name: Obtain signing certificate - id: obtain_cert - if: inputs.environment == 'production' - shell: bash - run: | - base64 -d <<<"$CERT_CONTENTS" > ./cert.pfx - printf "cert-file=%s\n" ".\\cert.pfx" >> $GITHUB_OUTPUT - env: - CERT_CONTENTS: ${{ secrets.WINDOWS_CERT_PFX }} + go-version-file: 'go.mod' - name: Install GoReleaser - uses: goreleaser/goreleaser-action@v4 + uses: goreleaser/goreleaser-action@v5 with: version: "~1.17.1" install-only: true + - name: Install Azure Code Signing Client + shell: pwsh + env: + ACS_DIR: ${{ runner.temp }}\acs + ACS_ZIP: ${{ runner.temp }}\acs.zip + CORRELATION_ID: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} + METADATA_PATH: ${{ runner.temp }}\acs\metadata.json + run: | + # Download Azure Code Signing client containing the DLL needed for signtool in script/sign + Invoke-WebRequest -Uri https://www.nuget.org/api/v2/package/Azure.CodeSigning.Client/1.0.43 -OutFile $Env:ACS_ZIP -Verbose + Expand-Archive $Env:ACS_ZIP -Destination $Env:ACS_DIR -Force -Verbose + + # Generate metadata file for signtool, used in signing box .exe and .msi + @{ + CertificateProfileName = "GitHubInc" + CodeSigningAccountName = "GitHubInc" + CorrelationId = $Env:CORRELATION_ID + Endpoint = "https://wus.codesigning.azure.net/" + } | ConvertTo-Json | Out-File -FilePath $Env:METADATA_PATH + + # Azure Code Signing leverages the environment variables for secrets that complement the metadata.json + # file generated above (AZURE_CLIENT_ID, AZURE_CLIENT_SECRET, AZURE_TENANT_ID) + # For more information, see https://learn.microsoft.com/en-us/dotnet/api/azure.identity.defaultazurecredential?view=azure-dotnet - name: Build release binaries shell: bash env: + AZURE_CLIENT_ID: ${{ secrets.SPN_GITHUB_CLI_SIGNING_CLIENT_ID }} + AZURE_CLIENT_SECRET: ${{ secrets.SPN_GITHUB_CLI_SIGNING }} + AZURE_TENANT_ID: ${{ secrets.SPN_GITHUB_CLI_SIGNING_TENANT_ID }} + DLIB_PATH: ${{ runner.temp }}\acs\bin\x64\Azure.CodeSigning.Dlib.dll + METADATA_PATH: ${{ runner.temp }}\acs\metadata.json TAG_NAME: ${{ inputs.tag_name }} - CERT_FILE: ${{ steps.obtain_cert.outputs.cert-file }} - CERT_PASSWORD: ${{ secrets.WINDOWS_CERT_PASSWORD }} run: script/release --local "$TAG_NAME" --platform windows - name: Set up MSBuild id: setupmsbuild - uses: microsoft/setup-msbuild@v1.3.1 + uses: microsoft/setup-msbuild@v2.0.0 - name: Build MSI shell: bash env: @@ -198,17 +213,20 @@ jobs: esac "${MSBUILD_PATH}\MSBuild.exe" ./build/windows/gh.wixproj -p:SourceDir="$source_dir" -p:OutputPath="$PWD/dist" -p:OutputName="$MSI_NAME" -p:ProductVersion="${MSI_VERSION#v}" -p:Platform="$platform" done - - name: Sign MSI + - name: Sign .msi release binaries if: inputs.environment == 'production' shell: pwsh + env: + AZURE_CLIENT_ID: ${{ secrets.SPN_GITHUB_CLI_SIGNING_CLIENT_ID }} + AZURE_CLIENT_SECRET: ${{ secrets.SPN_GITHUB_CLI_SIGNING }} + AZURE_TENANT_ID: ${{ secrets.SPN_GITHUB_CLI_SIGNING_TENANT_ID }} + DLIB_PATH: ${{ runner.temp }}\acs\bin\x64\Azure.CodeSigning.Dlib.dll + METADATA_PATH: ${{ runner.temp }}\acs\metadata.json run: | Get-ChildItem -Path .\dist -Filter *.msi | ForEach-Object { - .\script\sign $_.FullName + .\script\sign.ps1 $_.FullName } - env: - CERT_FILE: ${{ steps.obtain_cert.outputs.cert-file }} - CERT_PASSWORD: ${{ secrets.WINDOWS_CERT_PASSWORD }} - - uses: actions/upload-artifact@v3 + - uses: actions/upload-artifact@v4 with: name: windows if-no-files-found: error @@ -220,14 +238,15 @@ jobs: release: runs-on: ubuntu-latest needs: [linux, macos, windows] + environment: ${{ inputs.environment }} if: inputs.release steps: - name: Checkout cli/cli - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Merge built artifacts - uses: actions/download-artifact@v3 + uses: actions/download-artifact@v4 - name: Checkout documentation site - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: repository: github/cli.github.com path: site @@ -350,12 +369,12 @@ jobs: git diff --name-status @{upstream}.. fi - name: Bump homebrew-core formula - uses: mislav/bump-homebrew-formula-action@v2 + uses: mislav/bump-homebrew-formula-action@v3 if: inputs.environment == 'production' && !contains(inputs.tag_name, '-') with: formula-name: gh formula-path: Formula/g/gh.rb tag-name: ${{ inputs.tag_name }} - push-to: cli/homebrew-core + push-to: williammartin/homebrew-core env: COMMITTER_TOKEN: ${{ secrets.HOMEBREW_PR_PAT }} diff --git a/.github/workflows/go.yml b/.github/workflows/go.yml index a375e2d8f..0757b1a12 100644 --- a/.github/workflows/go.yml +++ b/.github/workflows/go.yml @@ -1,4 +1,4 @@ -name: Tests +name: Unit and Integration Tests on: [push, pull_request] permissions: @@ -13,27 +13,45 @@ jobs: runs-on: ${{ matrix.os }} steps: - - name: Set up Go 1.21 - uses: actions/setup-go@v4 - with: - go-version: 1.21 - - name: Check out code - uses: actions/checkout@v3 + uses: actions/checkout@v4 - - name: Restore Go modules cache - uses: actions/cache@v3 + - name: Set up Go + uses: actions/setup-go@v5 with: - path: ~/go/pkg/mod - key: go-${{ runner.os }}-${{ hashFiles('go.mod') }} - restore-keys: | - go-${{ runner.os }}- + go-version-file: "go.mod" - name: Download dependencies run: go mod download - - name: Run tests - run: go test -race ./... + - name: Run unit and integration tests + run: go test -race -tags=integration ./... - name: Build run: go build -v ./cmd/gh + + integration-tests: + env: + GH_TOKEN: ${{ github.token }} + strategy: + fail-fast: false + matrix: + os: [ubuntu-latest, windows-latest, macos-latest] + runs-on: ${{ matrix.os }} + + steps: + - name: Check out code + uses: actions/checkout@v4 + + - name: Set up Go + uses: actions/setup-go@v5 + with: + go-version-file: "go.mod" + + - name: Build executable + run: make + + - name: Run attestation command integration Tests + run: | + ./test/integration/attestation-cmd/download-and-verify-package-attestation.sh + ./test/integration/attestation-cmd/verify-sigstore-bundle-versions.sh diff --git a/.github/workflows/homebrew-bump.yml b/.github/workflows/homebrew-bump.yml new file mode 100644 index 000000000..2bc395a1e --- /dev/null +++ b/.github/workflows/homebrew-bump.yml @@ -0,0 +1,26 @@ +name: homebrew-bump-debug + +permissions: + contents: write + +on: + workflow_dispatch: + inputs: + tag_name: + required: true + type: string + environment: + default: production + type: environment +jobs: + bump: + runs-on: ubuntu-latest + steps: + - name: Bump homebrew-core formula + uses: mislav/bump-homebrew-formula-action@v3 + if: inputs.environment == 'production' && !contains(inputs.tag_name, '-') + with: + formula-name: gh + tag-name: ${{ inputs.tag_name }} + env: + COMMITTER_TOKEN: ${{ secrets.HOMEBREW_PR_PAT }} diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index c8defbf3a..4a97da25b 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -19,21 +19,13 @@ jobs: runs-on: ubuntu-latest steps: - - name: Set up Go 1.21 - uses: actions/setup-go@v4 - with: - go-version: 1.21 - - name: Check out code - uses: actions/checkout@v3 + uses: actions/checkout@v4 - - name: Restore Go modules cache - uses: actions/cache@v3 + - name: Set up Go + uses: actions/setup-go@v5 with: - path: ~/go/pkg/mod - key: go-${{ runner.os }}-${{ hashFiles('go.mod') }} - restore-keys: | - go-${{ runner.os }}- + go-version-file: 'go.mod' - name: Verify dependencies run: | diff --git a/.github/workflows/triage.yml b/.github/workflows/triage.yml new file mode 100644 index 000000000..6cd9d981d --- /dev/null +++ b/.github/workflows/triage.yml @@ -0,0 +1,67 @@ +name: Discussion Triage +run-name: ${{ github.event_name == 'issues' && github.event.issue.title || github.event.pull_request.title }} +on: + issues: + types: + - labeled + pull_request_target: + types: + - labeled +env: + TARGET_REPO: github/cli +jobs: + issue: + runs-on: ubuntu-latest + if: github.event_name == 'issues' && github.event.action == 'labeled' && github.event.label.name == 'discuss' + steps: + - name: Create issue based on source issue + env: + BODY: ${{ github.event.issue.body }} + CREATED: ${{ github.event.issue.created_at }} + GH_TOKEN: ${{ secrets.CLI_DISCUSSION_TRIAGE_TOKEN }} + LINK: ${{ github.repository }}#${{ github.event.issue.number }} + TITLE: ${{ github.event.issue.title }} + TRIGGERED_BY: ${{ github.triggering_actor }} + run: | + # Markdown quote source body by replacing newlines for newlines and markdown quoting + BODY="${BODY//$'\n'/$'\n'> }" + + # Create issue using dynamically constructed body within heredoc + cat << EOF | gh issue create --title "Triage issue \"$TITLE\"" --body-file - --repo "$TARGET_REPO" --label triage + **Title:** $TITLE + **Issue:** $LINK + **Created:** $CREATED + **Triggered by:** @$TRIGGERED_BY + + --- + + > $BODY + EOF + + pull_request: + runs-on: ubuntu-latest + if: github.event_name == 'pull_request_target' && github.event.action == 'labeled' && github.event.label.name == 'discuss' + steps: + - name: Create issue based on source pull request + env: + BODY: ${{ github.event.pull_request.body }} + CREATED: ${{ github.event.pull_request.created_at }} + GH_TOKEN: ${{ secrets.CLI_DISCUSSION_TRIAGE_TOKEN }} + LINK: ${{ github.repository }}#${{ github.event.pull_request.number }} + TITLE: ${{ github.event.pull_request.title }} + TRIGGERED_BY: ${{ github.triggering_actor }} + run: | + # Markdown quote source body by replacing newlines for newlines and markdown quoting + BODY="${BODY//$'\n'/$'\n'> }" + + # Create issue using dynamically constructed body within heredoc + cat << EOF | gh issue create --title "Triage PR \"$TITLE\"" --body-file - --repo "$TARGET_REPO" --label triage + **Title:** $TITLE + **Pull request:** $LINK + **Created:** $CREATED + **Triggered by:** @$TRIGGERED_BY + + --- + + > $BODY + EOF diff --git a/.goreleaser.yml b/.goreleaser.yml index 7e7424292..cafb5eb05 100644 --- a/.goreleaser.yml +++ b/.goreleaser.yml @@ -41,7 +41,7 @@ builds: hooks: post: - cmd: >- - {{ if eq .Runtime.Goos "windows" }}.\script\sign{{ else }}./script/sign{{ end }} '{{ .Path }}' + {{ if eq .Runtime.Goos "windows" }}pwsh .\script\sign.ps1{{ else }}./script/sign{{ end }} '{{ .Path }}' output: true binary: bin/gh main: ./cmd/gh diff --git a/README.md b/README.md index 9ffc6d720..6e0c7de6a 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ ![screenshot of gh pr status](https://user-images.githubusercontent.com/98482/84171218-327e7a80-aa40-11ea-8cd1-5177fc2d0e72.png) -GitHub CLI is available for repositories hosted on GitHub.com and GitHub Enterprise Server 2.20+, and to install on macOS, Windows, and Linux. +GitHub CLI is supported for users on GitHub.com and GitHub Enterprise Server 2.20+ with support for macOS, Windows, and Linux. ## Documentation @@ -21,7 +21,7 @@ If you are a hubber and are interested in shipping new commands for the CLI, che ### macOS -`gh` is available via [Homebrew][], [MacPorts][], [Conda][], [Spack][], and as a downloadable binary from the [releases page][]. +`gh` is available via [Homebrew][], [MacPorts][], [Conda][], [Spack][], [Webi][], and as a downloadable binary from the [releases page][]. #### Homebrew @@ -49,19 +49,27 @@ Additional Conda installation options available on the [gh-feedstock page](https | ------------------ | ---------------------------------------- | | `spack install gh` | `spack uninstall gh && spack install gh` | +#### Webi + +| Install: | Upgrade: | +| ----------------------------------- | ---------------- | +| `curl -sS https://webi.sh/gh \| sh` | `webi gh@stable` | + +For more information about the Webi installer see [its homepage](https://webinstall.dev/). + ### Linux & BSD `gh` is available via: - [our Debian and RPM repositories](./docs/install_linux.md); - community-maintained repositories in various Linux distros; -- OS-agnostic package managers such as [Homebrew](#homebrew), [Conda](#conda), and [Spack](#spack); and +- OS-agnostic package managers such as [Homebrew](#homebrew), [Conda](#conda), [Spack](#spack), [Webi](#webi); and - our [releases page][] as precompiled binaries. For more information, see [Linux & BSD installation](./docs/install_linux.md). ### Windows -`gh` is available via [WinGet][], [scoop][], [Chocolatey][], [Conda](#conda), and as downloadable MSI. +`gh` is available via [WinGet][], [scoop][], [Chocolatey][], [Conda](#conda), [Webi](#webi), and as downloadable MSI. #### WinGet @@ -125,6 +133,7 @@ tool. Check out our [more detailed explanation][gh-vs-hub] to learn more. [Chocolatey]: https://chocolatey.org [Conda]: https://docs.conda.io/en/latest/ [Spack]: https://spack.io +[Webi]: https://webinstall.dev [releases page]: https://github.com/cli/cli/releases/latest [hub]: https://github.com/github/hub [contributing]: ./.github/CONTRIBUTING.md diff --git a/api/client_test.go b/api/client_test.go index 0f36e3f69..1701a17a9 100644 --- a/api/client_test.go +++ b/api/client_test.go @@ -234,10 +234,9 @@ func TestHTTPHeaders(t *testing.T) { ios, _, _, stderr := iostreams.Test() httpClient, err := NewHTTPClient(HTTPClientOptions{ - AppVersion: "v1.2.3", - Config: tinyConfig{ts.URL[7:] + ":oauth_token": "MYTOKEN"}, - Log: ios.ErrOut, - SkipAcceptHeaders: false, + AppVersion: "v1.2.3", + Config: tinyConfig{ts.URL[7:] + ":oauth_token": "MYTOKEN"}, + Log: ios.ErrOut, }) assert.NoError(t, err) client := NewClientFromHTTP(httpClient) diff --git a/api/export_pr.go b/api/export_pr.go index c2ddb4277..bb3310811 100644 --- a/api/export_pr.go +++ b/api/export_pr.go @@ -23,7 +23,8 @@ func (issue *Issue) ExportData(fields []string) map[string]interface{} { items := make([]map[string]interface{}, 0, len(issue.ProjectItems.Nodes)) for _, n := range issue.ProjectItems.Nodes { items = append(items, map[string]interface{}{ - "title": n.Project.Title, + "status": n.Status, + "title": n.Project.Title, }) } data[f] = items @@ -108,7 +109,8 @@ func (pr *PullRequest) ExportData(fields []string) map[string]interface{} { items := make([]map[string]interface{}, 0, len(pr.ProjectItems.Nodes)) for _, n := range pr.ProjectItems.Nodes { items = append(items, map[string]interface{}{ - "title": n.Project.Title, + "status": n.Status, + "title": n.Project.Title, }) } data[f] = items diff --git a/api/export_pr_test.go b/api/export_pr_test.go index e7d930078..b7f4dcddb 100644 --- a/api/export_pr_test.go +++ b/api/export_pr_test.go @@ -85,6 +85,10 @@ func TestIssue_ExportData(t *testing.T) { "project": { "id": "PVT_id", "title": "Some Project" + }, + "status": { + "name": "Todo", + "optionId": "abc123" } } ] } } @@ -93,6 +97,10 @@ func TestIssue_ExportData(t *testing.T) { { "projectItems": [ { + "status": { + "optionId": "abc123", + "name": "Todo" + }, "title": "Some Project" } ] @@ -205,6 +213,38 @@ func TestPullRequest_ExportData(t *testing.T) { } `), }, + { + name: "project items", + fields: []string{"projectItems"}, + inputJSON: heredoc.Doc(` + { "projectItems": { "nodes": [ + { + "id": "PVTPR_id", + "project": { + "id": "PVT_id", + "title": "Some Project" + }, + "status": { + "name": "Todo", + "optionId": "abc123" + } + } + ] } } + `), + outputJSON: heredoc.Doc(` + { + "projectItems": [ + { + "status": { + "optionId": "abc123", + "name": "Todo" + }, + "title": "Some Project" + } + ] + } + `), + }, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { diff --git a/api/http_client.go b/api/http_client.go index 9f2d59ce3..f6e133f1f 100644 --- a/api/http_client.go +++ b/api/http_client.go @@ -13,18 +13,17 @@ import ( ) type tokenGetter interface { - Token(string) (string, string) + ActiveToken(string) (string, string) } type HTTPClientOptions struct { - AppVersion string - CacheTTL time.Duration - Config tokenGetter - EnableCache bool - Log io.Writer - LogColorize bool - LogVerboseHTTP bool - SkipAcceptHeaders bool + AppVersion string + CacheTTL time.Duration + Config tokenGetter + EnableCache bool + Log io.Writer + LogColorize bool + LogVerboseHTTP bool } func NewHTTPClient(opts HTTPClientOptions) (*http.Client, error) { @@ -50,9 +49,6 @@ func NewHTTPClient(opts HTTPClientOptions) (*http.Client, error) { headers := map[string]string{ userAgent: fmt.Sprintf("GitHub CLI %s", opts.AppVersion), } - if opts.SkipAcceptHeaders { - headers[accept] = "" - } clientOpts.Headers = headers if opts.EnableCache { @@ -103,7 +99,7 @@ func AddAuthTokenHeader(rt http.RoundTripper, cfg tokenGetter) http.RoundTripper // If the host has changed during a redirect do not add the authentication token header. if !redirectHostnameChange { hostname := ghinstance.NormalizeHostname(getHost(req)) - if token, _ := cfg.Token(hostname); token != "" { + if token, _ := cfg.ActiveToken(hostname); token != "" { req.Header.Set(authorization, fmt.Sprintf("token %s", token)) } } diff --git a/api/http_client_test.go b/api/http_client_test.go index b1e84e582..ce20a2684 100644 --- a/api/http_client_test.go +++ b/api/http_client_test.go @@ -20,7 +20,6 @@ func TestNewHTTPClient(t *testing.T) { type args struct { config tokenGetter appVersion string - setAccept bool logVerboseHTTP bool } tests := []struct { @@ -31,11 +30,10 @@ func TestNewHTTPClient(t *testing.T) { wantStderr string }{ { - name: "github.com with Accept header", + name: "github.com", args: args{ config: tinyConfig{"github.com:oauth_token": "MYTOKEN"}, appVersion: "v1.2.3", - setAccept: true, logVerboseHTTP: false, }, host: "github.com", @@ -47,18 +45,16 @@ func TestNewHTTPClient(t *testing.T) { wantStderr: "", }, { - name: "github.com no Accept header", + name: "GHES", args: args{ - config: tinyConfig{"github.com:oauth_token": "MYTOKEN"}, - appVersion: "v1.2.3", - setAccept: false, - logVerboseHTTP: false, + config: tinyConfig{"example.com:oauth_token": "GHETOKEN"}, + appVersion: "v1.2.3", }, - host: "github.com", + host: "example.com", wantHeader: map[string]string{ - "authorization": "token MYTOKEN", + "authorization": "token GHETOKEN", "user-agent": "GitHub CLI v1.2.3", - "accept": "", + "accept": "application/vnd.github.merge-info-preview+json, application/vnd.github.nebula-preview", }, wantStderr: "", }, @@ -67,7 +63,6 @@ func TestNewHTTPClient(t *testing.T) { args: args{ config: tinyConfig{"example.com:oauth_token": "MYTOKEN"}, appVersion: "v1.2.3", - setAccept: true, logVerboseHTTP: false, }, host: "github.com", @@ -78,12 +73,26 @@ func TestNewHTTPClient(t *testing.T) { }, wantStderr: "", }, + { + name: "GHES no authentication token", + args: args{ + config: tinyConfig{"github.com:oauth_token": "MYTOKEN"}, + appVersion: "v1.2.3", + logVerboseHTTP: false, + }, + host: "example.com", + wantHeader: map[string]string{ + "authorization": "", + "user-agent": "GitHub CLI v1.2.3", + "accept": "application/vnd.github.merge-info-preview+json, application/vnd.github.nebula-preview", + }, + wantStderr: "", + }, { name: "github.com in verbose mode", args: args{ config: tinyConfig{"github.com:oauth_token": "MYTOKEN"}, appVersion: "v1.2.3", - setAccept: true, logVerboseHTTP: true, }, host: "github.com", @@ -109,21 +118,6 @@ func TestNewHTTPClient(t *testing.T) { * Request took `), }, - { - name: "GHES Accept header", - args: args{ - config: tinyConfig{"example.com:oauth_token": "GHETOKEN"}, - appVersion: "v1.2.3", - setAccept: true, - }, - host: "example.com", - wantHeader: map[string]string{ - "authorization": "token GHETOKEN", - "user-agent": "GitHub CLI v1.2.3", - "accept": "application/vnd.github.merge-info-preview+json, application/vnd.github.nebula-preview", - }, - wantStderr: "", - }, } var gotReq *http.Request @@ -137,11 +131,10 @@ func TestNewHTTPClient(t *testing.T) { t.Run(tt.name, func(t *testing.T) { ios, _, _, stderr := iostreams.Test() client, err := NewHTTPClient(HTTPClientOptions{ - AppVersion: tt.args.appVersion, - Config: tt.args.config, - Log: ios.ErrOut, - SkipAcceptHeaders: !tt.args.setAccept, - LogVerboseHTTP: tt.args.logVerboseHTTP, + AppVersion: tt.args.appVersion, + Config: tt.args.config, + Log: ios.ErrOut, + LogVerboseHTTP: tt.args.logVerboseHTTP, }) require.NoError(t, err) @@ -229,7 +222,7 @@ func TestHTTPClientSanitizeJSONControlCharactersC0(t *testing.T) { err = json.Unmarshal(body, &issue) require.NoError(t, err) assert.Equal(t, "^[[31mRed Title^[[0m", issue.Title) - assert.Equal(t, "1^A 2^B 3^C 4^D 5^E 6^F 7^G 8^H 9\t A\r\n B\v C^L D\r\n E^N F^O", issue.Body) + assert.Equal(t, "1^A 2^B 3^C 4^D 5^E 6^F 7^G 8\b 9\t A\r\n B\v C\f D\r\n E^N F^O", issue.Body) assert.Equal(t, "10^P 11^Q 12^R 13^S 14^T 15^U 16^V 17^W 18^X 19^Y 1A^Z 1B^[ 1C^\\ 1D^] 1E^^ 1F^_", issue.Author.Name) assert.Equal(t, "monalisa \\u00^[", issue.Author.Login) assert.Equal(t, "Escaped ^[ \\^[ \\^[ \\\\^[", issue.ActiveLockReason) @@ -272,7 +265,7 @@ func TestHTTPClientSanitizeControlCharactersC1(t *testing.T) { type tinyConfig map[string]string -func (c tinyConfig) Token(host string) (string, string) { +func (c tinyConfig) ActiveToken(host string) (string, string) { return c[fmt.Sprintf("%s:%s", host, "oauth_token")], "oauth_token" } diff --git a/api/queries_issue.go b/api/queries_issue.go index 58053f8df..62531e84e 100644 --- a/api/queries_issue.go +++ b/api/queries_issue.go @@ -102,10 +102,18 @@ type ProjectInfo struct { type ProjectV2Item struct { ID string `json:"id"` - Project struct { - ID string `json:"id"` - Title string `json:"title"` - } + Project ProjectV2ItemProject + Status ProjectV2ItemStatus +} + +type ProjectV2ItemProject struct { + ID string `json:"id"` + Title string `json:"title"` +} + +type ProjectV2ItemStatus struct { + OptionID string `json:"optionId"` + Name string `json:"name"` } func (p ProjectCards) ProjectNames() []string { diff --git a/api/queries_org.go b/api/queries_org.go index 0a6689b35..f2e93342e 100644 --- a/api/queries_org.go +++ b/api/queries_org.go @@ -1,6 +1,7 @@ package api import ( + "fmt" "github.com/cli/cli/v2/internal/ghrepo" "github.com/shurcooL/githubv4" ) @@ -47,6 +48,31 @@ type OrgTeam struct { Slug string } +// OrganizationTeam fetch the team in an organization with the given slug +func OrganizationTeam(client *Client, hostname string, org string, teamSlug string) (*OrgTeam, error) { + type responseData struct { + Organization struct { + Team OrgTeam `graphql:"team(slug: $teamSlug)"` + } `graphql:"organization(login: $owner)"` + } + + variables := map[string]interface{}{ + "owner": githubv4.String(org), + "teamSlug": githubv4.String(teamSlug), + } + + var query responseData + err := client.Query(hostname, "OrganizationTeam", &query, variables) + if err != nil { + return nil, err + } + if query.Organization.Team.ID == "" { + return nil, fmt.Errorf("could not resolve to a Team with the slug of '%s'", teamSlug) + } + + return &query.Organization.Team, nil +} + // OrganizationTeams fetches all the teams in an organization func OrganizationTeams(client *Client, repo ghrepo.Interface) ([]OrgTeam, error) { type responseData struct { diff --git a/api/queries_projects_v2.go b/api/queries_projects_v2.go index a602653af..f1f07af7a 100644 --- a/api/queries_projects_v2.go +++ b/api/queries_projects_v2.go @@ -23,6 +23,7 @@ type ProjectV2 struct { Number int `json:"number"` ResourcePath string `json:"resourcePath"` Closed bool `json:"closed"` + URL string `json:"url"` } // UpdateProjectV2Items uses the addProjectV2ItemById and the deleteProjectV2Item mutations @@ -61,11 +62,27 @@ func UpdateProjectV2Items(client *Client, repo ghrepo.Interface, addProjectItems // ProjectsV2ItemsForIssue fetches all ProjectItems for an issue. func ProjectsV2ItemsForIssue(client *Client, repo ghrepo.Interface, issue *Issue) error { + type projectV2ItemStatus struct { + StatusFragment struct { + OptionID string `json:"optionId"` + Name string `json:"name"` + } `graphql:"... on ProjectV2ItemFieldSingleSelectValue"` + } + + type projectV2Item struct { + ID string `json:"id"` + Project struct { + ID string `json:"id"` + Title string `json:"title"` + } + Status projectV2ItemStatus `graphql:"status:fieldValueByName(name: \"Status\")"` + } + type response struct { Repository struct { Issue struct { ProjectItems struct { - Nodes []*ProjectV2Item + Nodes []*projectV2Item PageInfo struct { HasNextPage bool EndCursor string @@ -87,7 +104,20 @@ func ProjectsV2ItemsForIssue(client *Client, repo ghrepo.Interface, issue *Issue if err != nil { return err } - items.Nodes = append(items.Nodes, query.Repository.Issue.ProjectItems.Nodes...) + for _, projectItemNode := range query.Repository.Issue.ProjectItems.Nodes { + items.Nodes = append(items.Nodes, &ProjectV2Item{ + ID: projectItemNode.ID, + Project: ProjectV2ItemProject{ + ID: projectItemNode.Project.ID, + Title: projectItemNode.Project.Title, + }, + Status: ProjectV2ItemStatus{ + OptionID: projectItemNode.Status.StatusFragment.OptionID, + Name: projectItemNode.Status.StatusFragment.Name, + }, + }) + } + if !query.Repository.Issue.ProjectItems.PageInfo.HasNextPage { break } @@ -99,11 +129,27 @@ func ProjectsV2ItemsForIssue(client *Client, repo ghrepo.Interface, issue *Issue // ProjectsV2ItemsForPullRequest fetches all ProjectItems for a pull request. func ProjectsV2ItemsForPullRequest(client *Client, repo ghrepo.Interface, pr *PullRequest) error { + type projectV2ItemStatus struct { + StatusFragment struct { + OptionID string `json:"optionId"` + Name string `json:"name"` + } `graphql:"... on ProjectV2ItemFieldSingleSelectValue"` + } + + type projectV2Item struct { + ID string `json:"id"` + Project struct { + ID string `json:"id"` + Title string `json:"title"` + } + Status projectV2ItemStatus `graphql:"status:fieldValueByName(name: \"Status\")"` + } + type response struct { Repository struct { PullRequest struct { ProjectItems struct { - Nodes []*ProjectV2Item + Nodes []*projectV2Item PageInfo struct { HasNextPage bool EndCursor string @@ -125,7 +171,21 @@ func ProjectsV2ItemsForPullRequest(client *Client, repo ghrepo.Interface, pr *Pu if err != nil { return err } - items.Nodes = append(items.Nodes, query.Repository.PullRequest.ProjectItems.Nodes...) + + for _, projectItemNode := range query.Repository.PullRequest.ProjectItems.Nodes { + items.Nodes = append(items.Nodes, &ProjectV2Item{ + ID: projectItemNode.ID, + Project: ProjectV2ItemProject{ + ID: projectItemNode.Project.ID, + Title: projectItemNode.Project.Title, + }, + Status: ProjectV2ItemStatus{ + OptionID: projectItemNode.Status.StatusFragment.OptionID, + Name: projectItemNode.Status.StatusFragment.Name, + }, + }) + } + if !query.Repository.PullRequest.ProjectItems.PageInfo.HasNextPage { break } diff --git a/api/queries_projects_v2_test.go b/api/queries_projects_v2_test.go index bf6a618ba..fae49c926 100644 --- a/api/queries_projects_v2_test.go +++ b/api/queries_projects_v2_test.go @@ -11,6 +11,7 @@ import ( "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/pkg/httpmock" "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" ) func TestUpdateProjectV2Items(t *testing.T) { @@ -185,6 +186,61 @@ func TestProjectsV2ItemsForPullRequest(t *testing.T) { }, expectError: true, }, + { + name: "retrieves project items that have status columns", + httpStubs: func(reg *httpmock.Registry) { + reg.Register( + httpmock.GraphQL(`query PullRequestProjectItems\b`), + httpmock.GraphQLQuery(`{ + "data": { + "repository": { + "pullRequest": { + "projectItems": { + "nodes": [ + { + "id": "PVTI_lADOB-vozM4AVk16zgK6U50", + "project": { + "id": "PVT_kwDOB-vozM4AVk16", + "title": "Test Project" + }, + "status": { + "optionId": "47fc9ee4", + "name": "In Progress" + } + } + ], + "pageInfo": { + "hasNextPage": false, + "endCursor": "MQ" + } + } + } + } + } + }`, + func(query string, inputs map[string]interface{}) { + require.Equal(t, float64(1), inputs["number"]) + require.Equal(t, "OWNER", inputs["owner"]) + require.Equal(t, "REPO", inputs["name"]) + }), + ) + }, + expectItems: ProjectItems{ + Nodes: []*ProjectV2Item{ + { + ID: "PVTI_lADOB-vozM4AVk16zgK6U50", + Project: ProjectV2ItemProject{ + ID: "PVT_kwDOB-vozM4AVk16", + Title: "Test Project", + }, + Status: ProjectV2ItemStatus{ + OptionID: "47fc9ee4", + Name: "In Progress", + }, + }, + }, + }, + }, } for _, tt := range tests { @@ -199,11 +255,11 @@ func TestProjectsV2ItemsForPullRequest(t *testing.T) { pr := &PullRequest{Number: 1} err := ProjectsV2ItemsForPullRequest(client, repo, pr) if tt.expectError { - assert.Error(t, err) + require.Error(t, err) } else { - assert.NoError(t, err) + require.NoError(t, err) } - assert.Equal(t, tt.expectItems, pr.ProjectItems) + require.Equal(t, tt.expectItems, pr.ProjectItems) }) } } diff --git a/api/queries_repo.go b/api/queries_repo.go index ba94edef1..32cb5ff3b 100644 --- a/api/queries_repo.go +++ b/api/queries_repo.go @@ -124,6 +124,9 @@ type Repository struct { Projects struct { Nodes []RepoProject } + ProjectsV2 struct { + Nodes []ProjectV2 + } // pseudo-field that keeps track of host name of this repo hostname string @@ -548,7 +551,7 @@ func ForkRepo(client *Client, repo ghrepo.Interface, org, newName string, defaul // The GitHub API will happily return a HTTP 200 when attempting to fork own repo even though no forking // actually took place. Ensure that we raise an error instead. if ghrepo.IsSame(repo, newRepo) { - return newRepo, fmt.Errorf("%s cannot be forked", ghrepo.FullName(repo)) + return newRepo, fmt.Errorf("%s cannot be forked. A single user account cannot own both a parent and fork.", ghrepo.FullName(repo)) } return newRepo, nil diff --git a/api/queries_repo_test.go b/api/queries_repo_test.go index 1c790e3d8..026fa4591 100644 --- a/api/queries_repo_test.go +++ b/api/queries_repo_test.go @@ -1,6 +1,7 @@ package api import ( + "fmt" "io" "net/http" "strings" @@ -9,6 +10,7 @@ import ( "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/pkg/httpmock" "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" ) func TestGitHubRepo_notFound(t *testing.T) { @@ -537,3 +539,30 @@ func TestRepoExists(t *testing.T) { }) } } + +func TestForkRepoReturnsErrorWhenForkIsNotPossible(t *testing.T) { + // Given our API returns 202 with a Fork that is the same as + // the repo we provided + repoName := "test-repo" + ownerLogin := "test-owner" + stubbedForkResponse := repositoryV3{ + Name: repoName, + Owner: struct{ Login string }{ + Login: ownerLogin, + }, + } + + reg := &httpmock.Registry{} + reg.Register( + httpmock.REST("POST", fmt.Sprintf("repos/%s/%s/forks", ownerLogin, repoName)), + httpmock.StatusJSONResponse(202, stubbedForkResponse), + ) + + client := newTestClient(reg) + + // When we fork the repo + _, err := ForkRepo(client, ghrepo.New(ownerLogin, repoName), ownerLogin, "", false) + + // Then it provides a useful error message + require.Equal(t, fmt.Errorf("%s/%s cannot be forked. A single user account cannot own both a parent and fork.", ownerLogin, repoName), err) +} diff --git a/api/query_builder.go b/api/query_builder.go index bd2d2ece5..3ccc1ff2e 100644 --- a/api/query_builder.go +++ b/api/query_builder.go @@ -318,7 +318,7 @@ func IssueGraphQL(fields []string) string { case "projectCards": q = append(q, `projectCards(first:100){nodes{project{name}column{name}},totalCount}`) case "projectItems": - q = append(q, `projectItems(first:100){nodes{id, project{id,title}},totalCount}`) + q = append(q, `projectItems(first:100){nodes{id, project{id,title}, status:fieldValueByName(name: "Status") { ... on ProjectV2ItemFieldSingleSelectValue{optionId,name}}},totalCount}`) case "milestone": q = append(q, `milestone{number,title,description,dueOn}`) case "reactionGroups": @@ -442,6 +442,7 @@ var RepositoryFields = []string{ "assignableUsers", "mentionableUsers", "projects", + "projectsV2", // "branchProtectionRules", // too complex to expose // "collaborators", // does it make sense to expose without affiliation filter? @@ -487,6 +488,8 @@ func RepositoryGraphQL(fields []string) string { q = append(q, "mentionableUsers(first:100){nodes{id,login,name}}") case "projects": q = append(q, "projects(first:100,states:OPEN){nodes{id,name,number,body,resourcePath}}") + case "projectsV2": + q = append(q, "projectsV2(first:100,query:\"is:open\"){nodes{id,number,title,resourcePath,closed,url}}") case "watchers": q = append(q, "watchers{totalCount}") case "issues": diff --git a/api/query_builder_test.go b/api/query_builder_test.go index 7048b63fb..e39b08269 100644 --- a/api/query_builder_test.go +++ b/api/query_builder_test.go @@ -33,6 +33,11 @@ func TestPullRequestGraphQL(t *testing.T) { fields: []string{"isPinned", "stateReason", "number"}, want: "number", }, + { + name: "projectItems", + fields: []string{"projectItems"}, + want: `projectItems(first:100){nodes{id, project{id,title}, status:fieldValueByName(name: "Status") { ... on ProjectV2ItemFieldSingleSelectValue{optionId,name}}},totalCount}`, + }, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { @@ -69,6 +74,11 @@ func TestIssueGraphQL(t *testing.T) { fields: []string{"files"}, want: "files(first: 100) {nodes {additions,deletions,path}}", }, + { + name: "projectItems", + fields: []string{"projectItems"}, + want: `projectItems(first:100){nodes{id, project{id,title}, status:fieldValueByName(name: "Status") { ... on ProjectV2ItemFieldSingleSelectValue{optionId,name}}},totalCount}`, + }, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { diff --git a/cmd/gen-docs/main.go b/cmd/gen-docs/main.go index aa5c013ff..0c9590fac 100644 --- a/cmd/gen-docs/main.go +++ b/cmd/gen-docs/main.go @@ -9,6 +9,7 @@ import ( "github.com/cli/cli/v2/internal/config" "github.com/cli/cli/v2/internal/docs" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/pkg/cmd/root" "github.com/cli/cli/v2/pkg/cmdutil" @@ -48,7 +49,7 @@ func run(args []string) error { rootCmd, _ := root.NewCmdRoot(&cmdutil.Factory{ IOStreams: ios, Browser: &browser{}, - Config: func() (config.Config, error) { + Config: func() (gh.Config, error) { return config.NewFromString(""), nil }, ExtensionManager: &em{}, diff --git a/cmd/gen-docs/main_test.go b/cmd/gen-docs/main_test.go index 312f7bc99..98f9f2fd5 100644 --- a/cmd/gen-docs/main_test.go +++ b/cmd/gen-docs/main_test.go @@ -18,7 +18,7 @@ func Test_run(t *testing.T) { if err != nil { t.Fatalf("error reading `gh-issue-create.1`: %v", err) } - if !strings.Contains(string(manPage), `\fB\fCgh issue create`) { + if !strings.Contains(string(manPage), `\fBgh issue create`) { t.Fatal("man page corrupted") } diff --git a/cmd/gh/main.go b/cmd/gh/main.go index bcce3b427..0b9af0215 100644 --- a/cmd/gh/main.go +++ b/cmd/gh/main.go @@ -17,6 +17,7 @@ import ( "github.com/cli/cli/v2/api" "github.com/cli/cli/v2/internal/build" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/config/migration" "github.com/cli/cli/v2/internal/update" "github.com/cli/cli/v2/pkg/cmd/factory" "github.com/cli/cli/v2/pkg/cmd/root" @@ -56,6 +57,14 @@ func mainRun() exitCode { ctx := context.Background() + if cfg, err := cmdFactory.Config(); err == nil { + var m migration.MultiAccount + if err := cfg.Migrate(m); err != nil { + fmt.Fprintln(stderr, err) + return exitError + } + } + updateCtx, updateCancel := context.WithCancel(ctx) defer updateCancel() updateMessageChan := make(chan *update.ReleaseInfo) diff --git a/context/context.go b/context/context.go index 7030a557f..06ef8ca7d 100644 --- a/context/context.go +++ b/context/context.go @@ -4,6 +4,7 @@ package context import ( "errors" "fmt" + "slices" "sort" "github.com/cli/cli/v2/api" @@ -116,9 +117,11 @@ func (r *ResolvedRemotes) HeadRepos() ([]*api.Repository, error) { } var results []*api.Repository + var ids []string // Check if repo duplicates for _, repo := range r.network.Repositories { - if repo != nil && repo.ViewerCanPush() { + if repo != nil && repo.ViewerCanPush() && !slices.Contains(ids, repo.ID) { results = append(results, repo) + ids = append(ids, repo.ID) } } return results, nil diff --git a/context/remote.go b/context/remote.go index 3540ad95d..6094179f4 100644 --- a/context/remote.go +++ b/context/remote.go @@ -31,7 +31,7 @@ func (r Remotes) FindByRepo(owner, name string) (*Remote, error) { return rem, nil } } - return nil, fmt.Errorf("no matching remote found") + return nil, fmt.Errorf("no matching remote found; looking for %s/%s", owner, name) } // Filter remotes by given hostnames, maintains original order diff --git a/context/remote_test.go b/context/remote_test.go index 7db0473a0..d57e2e1e1 100644 --- a/context/remote_test.go +++ b/context/remote_test.go @@ -28,6 +28,71 @@ func Test_Remotes_FindByName(t *testing.T) { assert.Error(t, err, "no GitHub remotes found") } +func Test_Remotes_FindByRepo(t *testing.T) { + list := Remotes{ + &Remote{Remote: &git.Remote{Name: "remote-0"}, Repo: ghrepo.New("owner", "repo")}, + &Remote{Remote: &git.Remote{Name: "remote-1"}, Repo: ghrepo.New("another-owner", "another-repo")}, + } + + tests := []struct { + name string + owner string + repo string + wantsRemote *Remote + wantsError string + }{ + { + name: "exact match (owner/repo)", + owner: "owner", + repo: "repo", + wantsRemote: list[0], + }, + { + name: "exact match (another-owner/another-repo)", + owner: "another-owner", + repo: "another-repo", + wantsRemote: list[1], + }, + { + name: "case-insensitive match", + owner: "OWNER", + repo: "REPO", + wantsRemote: list[0], + }, + { + name: "non-match (owner)", + owner: "unknown-owner", + repo: "repo", + wantsError: "no matching remote found; looking for unknown-owner/repo", + }, + { + name: "non-match (repo)", + owner: "owner", + repo: "unknown-repo", + wantsError: "no matching remote found; looking for owner/unknown-repo", + }, + { + name: "non-match (owner, repo)", + owner: "unknown-owner", + repo: "unknown-repo", + wantsError: "no matching remote found; looking for unknown-owner/unknown-repo", + }, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + r, err := list.FindByRepo(tt.owner, tt.repo) + if tt.wantsError != "" { + assert.Error(t, err, tt.wantsError) + assert.Nil(t, r) + } else { + assert.NoError(t, err) + assert.Equal(t, r, tt.wantsRemote) + } + }) + } +} + type identityTranslator struct{} func (it identityTranslator) Translate(u *url.URL) *url.URL { diff --git a/docs/codespaces.md b/docs/codespaces.md new file mode 100644 index 000000000..842b37e4c --- /dev/null +++ b/docs/codespaces.md @@ -0,0 +1,36 @@ +# Guide to working with Codespaces using the CLI + +For more information on Codespaces, see [Codespaces section in GitHub Docs](https://docs.github.com/en/codespaces). + +## Access to other repositories + +The codespace creation process will prompt you to review and authorize additional permissions defined in +`devcontainer.json` at creation time: + +```json +{ + "customizations": { + "codespaces": { + "repositories": { + "my_org/my_repo": { + "permissions": { + "issues": "write" + } + } + } + } + } +} +``` + +However, any changes to `codespaces` customizations will not be re-evaluated for an existing +codespace. This requires you to create a new codespace in order to authorize the new +permissions using `gh codespace create`. + +For more information, see ["Repository access"](https://docs.github.com/en/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces). + +If additional access is needed for an existing codespace or access to a repository outside of +your user or organization account, the use of a fine-grained personal access token as an +environment variable or Codespaces secret might be considered. + +For more information, see ["Authenticating to repositories"](https://docs.github.com/en/codespaces/troubleshooting/troubleshooting-authentication-to-a-repository). diff --git a/docs/install_linux.md b/docs/install_linux.md index 82d3c1a77..454e880e0 100644 --- a/docs/install_linux.md +++ b/docs/install_linux.md @@ -14,10 +14,11 @@ our release schedule. Install: ```bash -type -p curl >/dev/null || (sudo apt update && sudo apt install curl -y) -curl -fsSL https://cli.github.com/packages/githubcli-archive-keyring.gpg | sudo dd of=/usr/share/keyrings/githubcli-archive-keyring.gpg \ -&& sudo chmod go+r /usr/share/keyrings/githubcli-archive-keyring.gpg \ -&& echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/githubcli-archive-keyring.gpg] https://cli.github.com/packages stable main" | sudo tee /etc/apt/sources.list.d/github-cli.list > /dev/null \ +(type -p wget >/dev/null || (sudo apt update && sudo apt-get install wget -y)) \ +&& sudo mkdir -p -m 755 /etc/apt/keyrings \ +&& wget -qO- https://cli.github.com/packages/githubcli-archive-keyring.gpg | sudo tee /etc/apt/keyrings/githubcli-archive-keyring.gpg > /dev/null \ +&& sudo chmod go+r /etc/apt/keyrings/githubcli-archive-keyring.gpg \ +&& echo "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/githubcli-archive-keyring.gpg] https://cli.github.com/packages stable main" | sudo tee /etc/apt/sources.list.d/github-cli.list > /dev/null \ && sudo apt update \ && sudo apt install gh -y ``` @@ -105,7 +106,7 @@ There are [so many issues with Snap](https://github.com/casperdcl/cli/issues/7) ### Arch Linux -Arch Linux users can install from the [community repo][arch linux repo]: +Arch Linux users can install from the [extra repo][arch linux repo]: ```bash sudo pacman -S github-cli @@ -234,6 +235,6 @@ sudo xbps-install github-cli ``` [releases page]: https://github.com/cli/cli/releases/latest -[arch linux repo]: https://www.archlinux.org/packages/community/x86_64/github-cli +[arch linux repo]: https://www.archlinux.org/packages/extra/x86_64/github-cli [arch linux aur]: https://aur.archlinux.org/packages/github-cli-git [^1]: https://wiki.alpinelinux.org/wiki/Package_management#Repository_pinning diff --git a/docs/multiple-accounts.md b/docs/multiple-accounts.md new file mode 100644 index 000000000..29c83b703 --- /dev/null +++ b/docs/multiple-accounts.md @@ -0,0 +1,211 @@ +# Multiple Accounts with the CLI - v2.40.0 + +Since its creation, `gh` has enforced a mapping of one account per host. Functionally, this meant that when targeting a +single host (e.g. github.com) each `auth login` would replace the token being used for API requests, and for git +operations when `gh` was configured as a git credential manager. Removing this limitation has been a [long requested +feature](https://github.com/cli/cli/issues/326), with many community members offering workarounds for a variety of use cases. +A particular shoutout to @gabe565 and his long term community support for https://github.com/gabe565/gh-profile in this space. + +With the release of `v2.40.0`, `gh` has begun supporting multiple accounts for some use cases on github.com and +in GitHub Enterprise. We recognise that there are a number of missing quality of life features, and we've opted +not to address the use case of automatic account switching based on some context (e.g. `pwd`, `git remote`). +However, we hope many of those using these custom solutions will now find it easier to obtain and update tokens (via the standard +OAuth flow rather than as a PAT), and to store them securely in the system keyring managed by `gh`. + +We are by no means excluding these things from ever being native to `gh` but we wanted to ship this MVP and get more +feedback so that we can iterate on it with the community. + +## What is in scope for this release? + +The support for multiple accounts in this release is focused around `auth login` becoming additive in behaviour. +This allows for multiple accounts to be easily switched between using the new `auth switch` command. Switching the "active" +user for a host will swap the token used by `gh` for API requests, and for git operations when `gh` was configured as a +git credential manager. + +We have extended the `auth logout` command to switch account where possible if the currently active user is the target +of the `logout`. Finally we have extended `auth token`, `auth switch`, and `auth logout` with a +`--user` flag. This new flag in combination with `--hostname` can be used to disambiguate accounts when running +non-interactively. + +Here's an example usage. First, we can see that I have a single account `wilmartin_microsoft` logged in, and +`auth status` reports that this is the active account: + +``` +➜ gh auth status +github.com + ✓ Logged in to github.com account wilmartin_microsoft (keyring) + - Active account: true + - Git operations protocol: https + - Token: gho_************************************ + - Token scopes: 'gist', 'read:org', 'repo', 'workflow' +``` + +Running `auth login` and proceeding through the browser based OAuth flow as `williammartin`, we can see that +`auth status` now reports two accounts under `github.com`, and our new account is now marked as active. + +``` +➜ gh auth login +? What account do you want to log into? GitHub.com +? What is your preferred protocol for Git operations on this host? HTTPS +? How would you like to authenticate GitHub CLI? Login with a web browser + +! First copy your one-time code: A1F4-3B3C +Press Enter to open github.com in your browser... +✓ Authentication complete. +- gh config set -h github.com git_protocol https +✓ Configured git protocol +✓ Logged in as williammartin + +➜ gh auth status +github.com + ✓ Logged in to github.com account williammartin (keyring) + - Active account: true + - Git operations protocol: https + - Token: gho_************************************ + - Token scopes: 'gist', 'read:org', 'repo', 'workflow' + + ✓ Logged in to github.com account wilmartin_microsoft (keyring) + - Active account: false + - Git operations protocol: https + - Token: gho_************************************ + - Token scopes: 'gist', 'read:org', 'repo', 'workflow' +``` + +Fetching our username from the API shows that our active token correctly corresponds to `williammartin`: + +``` +➜ gh api /user | jq .login +"williammartin" +``` + +Now we can easily switch accounts using `gh auth switch`, and hitting the API shows that the active token has been +changed: + +``` +➜ gh auth switch +✓ Switched active account for github.com to wilmartin_microsoft + +➜ gh api /user | jq .login +"wilmartin_microsoft" +``` + +We can use `gh auth token --user` to get a specific token for a user (which should be handy for automated switching +solutions): + +``` +➜ GH_TOKEN=$(gh auth token --user williammartin) gh api /user | jq .login +"williammartin" +``` + +Finally, running `gh auth logout` presents a prompt when there are multiple choices for logout, and switches account +if there are any remaining logged into the host: + +``` +➜ gh auth logout +? What account do you want to log out of? wilmartin_microsoft (github.com) +✓ Logged out of github.com account wilmartin_microsoft +✓ Switched active account for github.com to williammartin +``` + +## What is out of scope for this release? + +As mentioned above, we know that this only addresses some of the requests around supporting multiple accounts. While +these are not out of scope forever, for this release some of the big things we have intentionally not included are: + * Automatic account switching based on some context (e.g. `pwd`, `git remote`) + * Automatic configuration of git config such as `user.name` and `user.email` when switching + * User level configuration e.g. `williammartin` uses `vim` but `wilmartin_microsoft` uses `emacs` + +## What are some sharp edges in this release? + +As in any MVP there are going to be some sharp edges that need to be smoothed out over time. Here are a list of known +sharp edges in this release. + +### Data Migration + +The trickiest piece of this work was that the `hosts.yml` file only supported a mapping of one-to-one in the host to +account relationship. Having persistent data on disk that required a schema change presented a compatibility challenge +both backwards for those who use [`go-gh`](https://github.com/cli/go-gh/) outside of `gh`, and forward for `gh` itself +where we try to ensure that it's possible to use older versions in case we accidentally make a breaking change for users. + +As such, from this release, running any command will attempt to migrate this data into a new format, and will +additionally add a `version` field into the `config.yml` to aid in our future maintainability. While we have tried +to maintain forward compatibility (except in one edge case outlined below), and in the worst case you should be able +to remove these files and start from scratch, if you are concerned about the data in these files, we advise you to take +a backup. + +#### Forward Compatibility Exclusion + +There is one known case using `--insecure-storage` that we don't maintain complete forward and backward compatibility. +This occurs if you `auth login --insecure-storage`, upgrade to this release (which performs the data migration), run +`auth login --insecure-storage` again on an older release, then at some time later use `auth switch` to make this +account active. The symptom here would be usage of an older token (which may for example have different scopes). + +This occurs because we will only perform the data migration once, moving the original insecure token to a place where +it would later be used by `auth switch`. + +#### Immutable Config Users + +Some of our users lean on tools to manage their application configuration in an immutable manner for example using +https://github.com/nix-community/home-manager. These users will hit an error when we attempt to persist the new +`version` field to the `config.yml`. They will need to ensure that the `home-manager` configuration scripts are updated +to add `version: 1`. + +See https://github.com/nix-community/home-manager/issues/4744 for more details. + +### Auth Refresh + +Although this has always been possible, the multi account flow increases the likelihood of doing something surprising +with `auth refresh`. This command allows for a token to be updated with additional or fewer scopes. For example, +in the following example we add the `read:project` scope to the scopes for our currently active user `williammartin`, +and proceed through the OAuth browser flow as `williammartin`: + +``` +➜ gh auth refresh -s read:project +? What account do you want to refresh auth for? github.com + +! First copy your one-time code: E79E-5FA2 +Press Enter to open github.com in your browser... +✓ Authentication complete. + +➜ gh auth status +github.com + ✓ Logged in to github.com account williammartin (keyring) + - Active account: true + - Git operations protocol: https + - Token: gho_************************************ + - Token scopes: 'gist', 'read:org', 'read:project', 'repo', 'workflow' + + ✓ Logged in to github.com account wilmartin_microsoft (keyring) + + ✓ Logged in to github.com account wilmartin_microsoft (keyring) + - Active account: false + - Git operations protocol: https + - Token: gho_************************************ + - Token scopes: 'gist', 'read:org', 'repo', 'workflow' +``` + +However, what happens if I try to remove the `workflow` scope from my active user `williammartin` but proceed through +the OAuth browser flow as `wilmartin_microsoft`? + +``` +➜ gh auth refresh -r workflow + +! First copy your one-time code: EEA3-091C +Press Enter to open github.com in your browser... +error refreshing credentials for williammartin, received credentials for wilmartin_microsoft, did you use the correct account in the browser? +``` + +When adding or removing scopes for a user, the CLI gets the scopes for the current token and then requests a new token with the requested amended scopes. Unfortunately, when we go through the account switcher flow as a different user, we end up getting a token for the wrong user with surprising scopes. We don't believe that starting and ending a `refresh` as different accounts is +a use case we wish to support and has the potential for misuse. As such, we have begun erroring in this case. + +Note that a token has still been minted on the platform but `gh` will refuse to store it. We are investigating +alternative approaches with the platform team to put some better guardrails in place earlier in the flow. + +### Account Switcher on GitHub Enterprise + +When using `auth login` with github.com, if a user has multiple accounts in the browser, they should be presented +with an interstitial page that allows for proceeding as any of their accounts. However, for Device Control Flow OAuth +flows, this feature has not yet made it into GHES. + +For the moment, if you have multiple accounts on GHES that you wish to log in as, you will need to ensure that you +are authenticated as the correct user in the browser before running `auth login`. diff --git a/docs/source.md b/docs/source.md index cc1605b8c..d2b7c5b31 100644 --- a/docs/source.md +++ b/docs/source.md @@ -1,6 +1,6 @@ # Installation from source -1. Verify that you have Go 1.21+ installed +1. Verify that you have Go 1.22+ installed ```sh $ go version diff --git a/docs/triage.md b/docs/triage.md index da69c892e..ae9b0c15c 100644 --- a/docs/triage.md +++ b/docs/triage.md @@ -6,7 +6,7 @@ triage role. The initial expectation is that the person in the role for the week ## Expectations for incoming issues -All incoming issues need either an `enhancement`, `bug`, or `docs` label. +Review and label [open issues missing either the `enhancement`, `bug`, or `docs` label](https://github.com/cli/cli/issues?q=is%3Aopen+is%3Aissue+-label%3Abug%2Cenhancement%2Cdocs+). To be considered triaged, `enhancement` issues require at least one of the following additional labels: diff --git a/git/client.go b/git/client.go index a029c8ba6..b0194affc 100644 --- a/git/client.go +++ b/git/client.go @@ -20,6 +20,26 @@ import ( var remoteRE = regexp.MustCompile(`(.+)\s+(.+)\s+\((push|fetch)\)`) +// This regexp exists to match lines of the following form: +// 6a6872b918c601a0e730710ad8473938a7516d30\u0000title 1\u0000Body 1\u0000\n +// 7a6872b918c601a0e730710ad8473938a7516d31\u0000title 2\u0000Body 2\u0000 +// +// This is the format we use when collecting commit information, +// with null bytes as separators. Using null bytes this way allows for us +// to easily maintain newlines that might be in the body. +// +// The ?m modifier is the multi-line modifier, meaning that ^ and $ +// match the beginning and end of lines, respectively. +// +// The [\S\s] matches any whitespace or non-whitespace character, +// which is different from .* because it allows for newlines as well. +// +// The ? following .* and [\S\s] is a lazy modifier, meaning that it will +// match as few characters as possible while still satisfying the rest of the regexp. +// This is important because it allows us to match the first null byte after the title and body, +// rather than the last null byte in the entire string. +var commitLogRE = regexp.MustCompile(`(?m)^[0-9a-fA-F]{7,40}\x00.*?\x00[\S\s]*?\x00$`) + type errWithExitCode interface { ExitCode() int } @@ -228,7 +248,12 @@ func (c *Client) UncommittedChangeCount(ctx context.Context) (int, error) { } func (c *Client) Commits(ctx context.Context, baseRef, headRef string) ([]*Commit, error) { - args := []string{"-c", "log.ShowSignature=false", "log", "--pretty=format:%H,%s", "--cherry", fmt.Sprintf("%s...%s", baseRef, headRef)} + // The formatting directive %x00 indicates that git should include the null byte as a separator. + // We use this because it is not a valid character to include in a commit message. Previously, + // commas were used here but when we Split on them, we would get incorrect results if commit titles + // happened to contain them. + // https://git-scm.com/docs/pretty-formats#Documentation/pretty-formats.txt-emx00em + args := []string{"-c", "log.ShowSignature=false", "log", "--pretty=format:%H%x00%s%x00%b%x00", "--cherry", fmt.Sprintf("%s...%s", baseRef, headRef)} cmd, err := c.Command(ctx, args...) if err != nil { return nil, err @@ -237,22 +262,33 @@ func (c *Client) Commits(ctx context.Context, baseRef, headRef string) ([]*Commi if err != nil { return nil, err } + commits := []*Commit{} - sha := 0 - title := 1 - for _, line := range outputLines(out) { - split := strings.SplitN(line, ",", 2) - if len(split) != 2 { - continue - } + commitLogs := commitLogRE.FindAllString(string(out), -1) + for _, commitLog := range commitLogs { + // Each line looks like this: + // 6a6872b918c601a0e730710ad8473938a7516d30\u0000title 1\u0000Body 1\u0000\n + + // Or with an optional body: + // 6a6872b918c601a0e730710ad8473938a7516d30\u0000title 1\u0000\u0000\n + + // Therefore after splitting we will have: + // ["6a6872b918c601a0e730710ad8473938a7516d30", "title 1", "Body 1", ""] + + // Or with an optional body: + // ["6a6872b918c601a0e730710ad8473938a7516d30", "title 1", "", ""] + commitLogParts := strings.Split(commitLog, "\u0000") commits = append(commits, &Commit{ - Sha: split[sha], - Title: split[title], + Sha: commitLogParts[0], + Title: commitLogParts[1], + Body: commitLogParts[2], }) } + if len(commits) == 0 { return nil, fmt.Errorf("could not find any commits between %s and %s", baseRef, headRef) } + return commits, nil } @@ -322,6 +358,19 @@ func (c *Client) ReadBranchConfig(ctx context.Context, branch string) (cfg Branc return } +func (c *Client) DeleteLocalTag(ctx context.Context, tag string) error { + args := []string{"tag", "-d", tag} + cmd, err := c.Command(ctx, args...) + if err != nil { + return err + } + _, err = cmd.Output() + if err != nil { + return err + } + return nil +} + func (c *Client) DeleteLocalBranch(ctx context.Context, branch string) error { args := []string{"branch", "-D", branch} cmd, err := c.Command(ctx, args...) @@ -459,6 +508,39 @@ func (c *Client) SetRemoteBranches(ctx context.Context, remote string, refspec s return nil } +func (c *Client) AddRemote(ctx context.Context, name, urlStr string, trackingBranches []string) (*Remote, error) { + args := []string{"remote", "add"} + for _, branch := range trackingBranches { + args = append(args, "-t", branch) + } + args = append(args, name, urlStr) + cmd, err := c.Command(ctx, args...) + if err != nil { + return nil, err + } + if _, err := cmd.Output(); err != nil { + return nil, err + } + var urlParsed *url.URL + if strings.HasPrefix(urlStr, "https") { + urlParsed, err = url.Parse(urlStr) + if err != nil { + return nil, err + } + } else { + urlParsed, err = ParseURL(urlStr) + if err != nil { + return nil, err + } + } + remote := &Remote{ + Name: name, + FetchURL: urlParsed, + PushURL: urlParsed, + } + return remote, nil +} + // Below are commands that make network calls and need authentication credentials supplied from gh. func (c *Client) Fetch(ctx context.Context, remote string, refspec string, mods ...CommandModifier) error { @@ -528,42 +610,6 @@ func (c *Client) Clone(ctx context.Context, cloneURL string, args []string, mods return target, nil } -func (c *Client) AddRemote(ctx context.Context, name, urlStr string, trackingBranches []string, mods ...CommandModifier) (*Remote, error) { - args := []string{"remote", "add"} - for _, branch := range trackingBranches { - args = append(args, "-t", branch) - } - args = append(args, name, urlStr) - cmd, err := c.Command(ctx, args...) - if err != nil { - return nil, err - } - for _, mod := range mods { - mod(cmd) - } - if _, err := cmd.Output(); err != nil { - return nil, err - } - var urlParsed *url.URL - if strings.HasPrefix(urlStr, "https") { - urlParsed, err = url.Parse(urlStr) - if err != nil { - return nil, err - } - } else { - urlParsed, err = ParseURL(urlStr) - if err != nil { - return nil, err - } - } - remote := &Remote{ - Name: name, - FetchURL: urlParsed, - PushURL: urlParsed, - } - return remote, nil -} - func resolveGitPath() (string, error) { path, err := safeexec.LookPath("git") if err != nil { diff --git a/git/client_test.go b/git/client_test.go index 5e96bb1b7..420683659 100644 --- a/git/client_test.go +++ b/git/client_test.go @@ -3,6 +3,7 @@ package git import ( "bytes" "context" + "encoding/json" "errors" "fmt" "os" @@ -13,6 +14,7 @@ import ( "testing" "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" ) func TestClientCommand(t *testing.T) { @@ -458,57 +460,233 @@ func TestClientUncommittedChangeCount(t *testing.T) { } } +type stubbedCommit struct { + Sha string + Title string + Body string +} + +type stubbedCommitsCommandData struct { + ExitStatus int + + ErrMsg string + + Commits []stubbedCommit +} + func TestClientCommits(t *testing.T) { tests := []struct { - name string - cmdExitStatus int - cmdStdout string - cmdStderr string - wantCmdArgs string - wantCommits []*Commit - wantErrorMsg string + name string + testData stubbedCommitsCommandData + wantCmdArgs string + wantCommits []*Commit + wantErrorMsg string }{ { - name: "get commits", - cmdStdout: "6a6872b918c601a0e730710ad8473938a7516d30,testing testability test", - wantCmdArgs: `path/to/git -c log.ShowSignature=false log --pretty=format:%H,%s --cherry SHA1...SHA2`, + name: "single commit no body", + testData: stubbedCommitsCommandData{ + Commits: []stubbedCommit{ + { + Sha: "6a6872b918c601a0e730710ad8473938a7516d30", + Title: "testing testability test", + Body: "", + }, + }, + }, + wantCmdArgs: `path/to/git -c log.ShowSignature=false log --pretty=format:%H%x00%s%x00%b%x00 --cherry SHA1...SHA2`, wantCommits: []*Commit{{ Sha: "6a6872b918c601a0e730710ad8473938a7516d30", Title: "testing testability test", }}, }, { - name: "no commits between SHAs", - wantCmdArgs: `path/to/git -c log.ShowSignature=false log --pretty=format:%H,%s --cherry SHA1...SHA2`, + name: "single commit with body", + testData: stubbedCommitsCommandData{ + Commits: []stubbedCommit{ + { + Sha: "6a6872b918c601a0e730710ad8473938a7516d30", + Title: "testing testability test", + Body: "This is the body", + }, + }, + }, + wantCmdArgs: `path/to/git -c log.ShowSignature=false log --pretty=format:%H%x00%s%x00%b%x00 --cherry SHA1...SHA2`, + wantCommits: []*Commit{{ + Sha: "6a6872b918c601a0e730710ad8473938a7516d30", + Title: "testing testability test", + Body: "This is the body", + }}, + }, + { + name: "multiple commits with bodies", + testData: stubbedCommitsCommandData{ + Commits: []stubbedCommit{ + { + Sha: "6a6872b918c601a0e730710ad8473938a7516d30", + Title: "testing testability test", + Body: "This is the body", + }, + { + Sha: "7a6872b918c601a0e730710ad8473938a7516d31", + Title: "testing testability test 2", + Body: "This is the body 2", + }, + }, + }, + wantCmdArgs: `path/to/git -c log.ShowSignature=false log --pretty=format:%H%x00%s%x00%b%x00 --cherry SHA1...SHA2`, + wantCommits: []*Commit{ + { + Sha: "6a6872b918c601a0e730710ad8473938a7516d30", + Title: "testing testability test", + Body: "This is the body", + }, + { + Sha: "7a6872b918c601a0e730710ad8473938a7516d31", + Title: "testing testability test 2", + Body: "This is the body 2", + }, + }, + }, + { + name: "multiple commits mixed bodies", + testData: stubbedCommitsCommandData{ + Commits: []stubbedCommit{ + { + Sha: "6a6872b918c601a0e730710ad8473938a7516d30", + Title: "testing testability test", + }, + { + Sha: "7a6872b918c601a0e730710ad8473938a7516d31", + Title: "testing testability test 2", + Body: "This is the body 2", + }, + }, + }, + wantCmdArgs: `path/to/git -c log.ShowSignature=false log --pretty=format:%H%x00%s%x00%b%x00 --cherry SHA1...SHA2`, + wantCommits: []*Commit{ + { + Sha: "6a6872b918c601a0e730710ad8473938a7516d30", + Title: "testing testability test", + }, + { + Sha: "7a6872b918c601a0e730710ad8473938a7516d31", + Title: "testing testability test 2", + Body: "This is the body 2", + }, + }, + }, + { + name: "multiple commits newlines in bodies", + testData: stubbedCommitsCommandData{ + Commits: []stubbedCommit{ + { + Sha: "6a6872b918c601a0e730710ad8473938a7516d30", + Title: "testing testability test", + Body: "This is the body\nwith a newline", + }, + { + Sha: "7a6872b918c601a0e730710ad8473938a7516d31", + Title: "testing testability test 2", + Body: "This is the body 2", + }, + }, + }, + wantCmdArgs: `path/to/git -c log.ShowSignature=false log --pretty=format:%H%x00%s%x00%b%x00 --cherry SHA1...SHA2`, + wantCommits: []*Commit{ + { + Sha: "6a6872b918c601a0e730710ad8473938a7516d30", + Title: "testing testability test", + Body: "This is the body\nwith a newline", + }, + { + Sha: "7a6872b918c601a0e730710ad8473938a7516d31", + Title: "testing testability test 2", + Body: "This is the body 2", + }, + }, + }, + { + name: "no commits between SHAs", + testData: stubbedCommitsCommandData{ + Commits: []stubbedCommit{}, + }, + wantCmdArgs: `path/to/git -c log.ShowSignature=false log --pretty=format:%H%x00%s%x00%b%x00 --cherry SHA1...SHA2`, wantErrorMsg: "could not find any commits between SHA1 and SHA2", }, { - name: "git error", - cmdExitStatus: 1, - cmdStderr: "git error message", - wantCmdArgs: `path/to/git -c log.ShowSignature=false log --pretty=format:%H,%s --cherry SHA1...SHA2`, - wantErrorMsg: "failed to run git: git error message", + name: "git error", + testData: stubbedCommitsCommandData{ + ErrMsg: "git error message", + ExitStatus: 1, + }, + wantCmdArgs: `path/to/git -c log.ShowSignature=false log --pretty=format:%H%x00%s%x00%b%x00 --cherry SHA1...SHA2`, + wantErrorMsg: "failed to run git: git error message", }, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { - cmd, cmdCtx := createCommandContext(t, tt.cmdExitStatus, tt.cmdStdout, tt.cmdStderr) + cmd, cmdCtx := createCommitsCommandContext(t, tt.testData) client := Client{ GitPath: "path/to/git", commandContext: cmdCtx, } commits, err := client.Commits(context.Background(), "SHA1", "SHA2") - assert.Equal(t, tt.wantCmdArgs, strings.Join(cmd.Args[3:], " ")) + require.Equal(t, tt.wantCmdArgs, strings.Join(cmd.Args[3:], " ")) if tt.wantErrorMsg != "" { - assert.EqualError(t, err, tt.wantErrorMsg) + require.EqualError(t, err, tt.wantErrorMsg) } else { - assert.NoError(t, err) + require.NoError(t, err) } - assert.Equal(t, tt.wantCommits, commits) + require.Equal(t, tt.wantCommits, commits) }) } } +func TestCommitsHelperProcess(t *testing.T) { + if os.Getenv("GH_WANT_HELPER_PROCESS") != "1" { + return + } + + var td stubbedCommitsCommandData + _ = json.Unmarshal([]byte(os.Getenv("GH_COMMITS_TEST_DATA")), &td) + + if td.ErrMsg != "" { + fmt.Fprint(os.Stderr, td.ErrMsg) + } else { + var sb strings.Builder + for _, commit := range td.Commits { + sb.WriteString(commit.Sha) + sb.WriteString("\u0000") + sb.WriteString(commit.Title) + sb.WriteString("\u0000") + sb.WriteString(commit.Body) + sb.WriteString("\u0000") + sb.WriteString("\n") + } + fmt.Fprint(os.Stdout, sb.String()) + } + + os.Exit(td.ExitStatus) +} + +func createCommitsCommandContext(t *testing.T, testData stubbedCommitsCommandData) (*exec.Cmd, commandCtx) { + t.Helper() + + b, err := json.Marshal(testData) + require.NoError(t, err) + + cmd := exec.CommandContext(context.Background(), os.Args[0], "-test.run=TestCommitsHelperProcess", "--") + cmd.Env = []string{ + "GH_WANT_HELPER_PROCESS=1", + "GH_COMMITS_TEST_DATA=" + string(b), + } + return cmd, func(ctx context.Context, exe string, args ...string) *exec.Cmd { + cmd.Args = append(cmd.Args, exe) + cmd.Args = append(cmd.Args, args...) + return cmd + } +} + func TestClientLastCommit(t *testing.T) { client := Client{ RepoDir: "./fixtures/simple.git", @@ -558,6 +736,45 @@ func TestClientReadBranchConfig(t *testing.T) { } } +func TestClientDeleteLocalTag(t *testing.T) { + tests := []struct { + name string + cmdExitStatus int + cmdStdout string + cmdStderr string + wantCmdArgs string + wantErrorMsg string + }{ + { + name: "delete local tag", + wantCmdArgs: `path/to/git tag -d v1.0`, + }, + { + name: "git error", + cmdExitStatus: 1, + cmdStderr: "git error message", + wantCmdArgs: `path/to/git tag -d v1.0`, + wantErrorMsg: "failed to run git: git error message", + }, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + cmd, cmdCtx := createCommandContext(t, tt.cmdExitStatus, tt.cmdStdout, tt.cmdStderr) + client := Client{ + GitPath: "path/to/git", + commandContext: cmdCtx, + } + err := client.DeleteLocalTag(context.Background(), "v1.0") + assert.Equal(t, tt.wantCmdArgs, strings.Join(cmd.Args[3:], " ")) + if tt.wantErrorMsg == "" { + assert.NoError(t, err) + } else { + assert.EqualError(t, err, tt.wantErrorMsg) + } + }) + } +} + func TestClientDeleteLocalBranch(t *testing.T) { tests := []struct { name string diff --git a/git/objects.go b/git/objects.go index 952b6c335..c33d92b7c 100644 --- a/git/objects.go +++ b/git/objects.go @@ -67,6 +67,7 @@ func (r TrackingRef) String() string { type Commit struct { Sha string Title string + Body string } type BranchConfig struct { diff --git a/git/url.go b/git/url.go index 1a3e97fd6..18d92122a 100644 --- a/git/url.go +++ b/git/url.go @@ -26,7 +26,7 @@ func isPossibleProtocol(u string) bool { } // ParseURL normalizes git remote urls -func ParseURL(rawURL string) (u *url.URL, err error) { +func ParseURL(rawURL string) (*url.URL, error) { if !isPossibleProtocol(rawURL) && strings.ContainsRune(rawURL, ':') && // not a Windows path @@ -35,30 +35,27 @@ func ParseURL(rawURL string) (u *url.URL, err error) { rawURL = "ssh://" + strings.Replace(rawURL, ":", "/", 1) } - u, err = url.Parse(rawURL) + u, err := url.Parse(rawURL) if err != nil { - return + return nil, err } - if u.Scheme == "git+ssh" { + switch u.Scheme { + case "git+https": + u.Scheme = "https" + case "git+ssh": u.Scheme = "ssh" } - if u.Scheme == "git+https" { - u.Scheme = "https" - } - if u.Scheme != "ssh" { - return + return u, nil } if strings.HasPrefix(u.Path, "//") { u.Path = strings.TrimPrefix(u.Path, "/") } - if idx := strings.Index(u.Host, ":"); idx >= 0 { - u.Host = u.Host[0:idx] - } + u.Host = strings.TrimSuffix(u.Host, ":"+u.Port()) - return + return u, nil } diff --git a/git/url_test.go b/git/url_test.go index f5b3b50d0..25f18a3f7 100644 --- a/git/url_test.go +++ b/git/url_test.go @@ -1,6 +1,11 @@ package git -import "testing" +import ( + "testing" + + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" +) func TestIsURL(t *testing.T) { tests := []struct { @@ -56,9 +61,7 @@ func TestIsURL(t *testing.T) { } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { - if got := IsURL(tt.url); got != tt.want { - t.Errorf("IsURL() = %v, want %v", got, tt.want) - } + assert.Equal(t, tt.want, IsURL(tt.url)) }) } } @@ -126,6 +129,26 @@ func TestParseURL(t *testing.T) { Path: "/owner/repo.git", }, }, + { + name: "ssh, ipv6", + url: "ssh://git@[::1]/owner/repo.git", + want: url{ + Scheme: "ssh", + User: "git", + Host: "[::1]", + Path: "/owner/repo.git", + }, + }, + { + name: "ssh with port, ipv6", + url: "ssh://git@[::1]:22/owner/repo.git", + want: url{ + Scheme: "ssh", + User: "git", + Host: "[::1]", + Path: "/owner/repo.git", + }, + }, { name: "git+ssh", url: "git+ssh://example.com/owner/repo.git", @@ -196,25 +219,24 @@ func TestParseURL(t *testing.T) { Path: "", }, }, + { + name: "fails to parse", + url: "ssh://git@[/tmp/git-repo", + wantErr: true, + }, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { u, err := ParseURL(tt.url) - if (err != nil) != tt.wantErr { - t.Fatalf("got error: %v", err) - } - if u.Scheme != tt.want.Scheme { - t.Errorf("expected scheme %q, got %q", tt.want.Scheme, u.Scheme) - } - if u.User.Username() != tt.want.User { - t.Errorf("expected user %q, got %q", tt.want.User, u.User.Username()) - } - if u.Host != tt.want.Host { - t.Errorf("expected host %q, got %q", tt.want.Host, u.Host) - } - if u.Path != tt.want.Path { - t.Errorf("expected path %q, got %q", tt.want.Path, u.Path) + if tt.wantErr { + require.Error(t, err) + return } + + assert.Equal(t, u.Scheme, tt.want.Scheme) + assert.Equal(t, u.User.Username(), tt.want.User) + assert.Equal(t, u.Host, tt.want.Host) + assert.Equal(t, u.Path, tt.want.Path) }) } } diff --git a/go.mod b/go.mod index 4a97a0e94..b39baffd0 100644 --- a/go.mod +++ b/go.mod @@ -1,90 +1,168 @@ module github.com/cli/cli/v2 -go 1.21 +go 1.22 + +toolchain go1.22.2 require ( github.com/AlecAivazis/survey/v2 v2.3.7 github.com/MakeNowJust/heredoc v1.0.0 github.com/briandowns/spinner v1.18.1 github.com/cenkalti/backoff/v4 v4.2.1 - github.com/charmbracelet/glamour v0.6.0 - github.com/charmbracelet/lipgloss v0.5.0 - github.com/cli/go-gh/v2 v2.3.0 + github.com/charmbracelet/glamour v0.7.0 + github.com/charmbracelet/lipgloss v0.10.1-0.20240413172830-d0be07ea6b9c + github.com/cli/go-gh/v2 v2.9.0 github.com/cli/oauth v1.0.1 github.com/cli/safeexec v1.0.1 - github.com/cpuguy83/go-md2man/v2 v2.0.2 - github.com/creack/pty v1.1.18 - github.com/gabriel-vasile/mimetype v1.4.2 + github.com/cpuguy83/go-md2man/v2 v2.0.4 + github.com/creack/pty v1.1.21 + github.com/distribution/reference v0.5.0 + github.com/gabriel-vasile/mimetype v1.4.3 github.com/gdamore/tcell/v2 v2.5.4 - github.com/google/go-cmp v0.5.9 + github.com/google/go-cmp v0.6.0 + github.com/google/go-containerregistry v0.19.1 github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510 - github.com/gorilla/websocket v1.4.2 + github.com/gorilla/websocket v1.5.1 github.com/hashicorp/go-multierror v1.1.1 github.com/hashicorp/go-version v1.3.0 - github.com/henvic/httpretty v0.1.2 + github.com/henvic/httpretty v0.1.3 + github.com/in-toto/in-toto-golang v0.9.0 github.com/joho/godotenv v1.5.1 github.com/kballard/go-shellquote v0.0.0-20180428030007-95032a82bc51 github.com/mattn/go-colorable v0.1.13 - github.com/mattn/go-isatty v0.0.19 + github.com/mattn/go-isatty v0.0.20 github.com/mgutz/ansi v0.0.0-20200706080929-d51e80ef957d + github.com/microsoft/dev-tunnels v0.0.25 github.com/muhammadmuzzammil1998/jsonc v0.0.0-20201229145248-615b0916ca38 - github.com/opentracing/opentracing-go v1.1.0 + github.com/opentracing/opentracing-go v1.2.0 github.com/rivo/tview v0.0.0-20221029100920-c4a7e501810d github.com/shurcooL/githubv4 v0.0.0-20230704064427-599ae7bbf278 - github.com/sourcegraph/jsonrpc2 v0.1.0 - github.com/spf13/cobra v1.6.1 + github.com/sigstore/protobuf-specs v0.3.2 + github.com/sigstore/sigstore-go v0.3.0 + github.com/spf13/cobra v1.8.0 github.com/spf13/pflag v1.0.5 - github.com/stretchr/testify v1.8.4 - github.com/zalando/go-keyring v0.2.3 - golang.org/x/crypto v0.12.0 - golang.org/x/sync v0.1.0 - golang.org/x/term v0.11.0 - golang.org/x/text v0.12.0 - google.golang.org/grpc v1.53.0 - google.golang.org/protobuf v1.28.1 + github.com/stretchr/testify v1.9.0 + github.com/zalando/go-keyring v0.2.4 + golang.org/x/crypto v0.22.0 + golang.org/x/sync v0.6.0 + golang.org/x/term v0.19.0 + golang.org/x/text v0.14.0 + google.golang.org/grpc v1.62.2 + google.golang.org/protobuf v1.34.1 gopkg.in/h2non/gock.v1 v1.1.2 gopkg.in/yaml.v3 v3.0.1 ) require ( - github.com/alecthomas/chroma v0.10.0 // indirect - github.com/alessio/shellescape v1.4.1 // indirect - github.com/aymanbagabas/go-osc52 v1.0.3 // indirect + github.com/alecthomas/chroma/v2 v2.8.0 // indirect + github.com/alessio/shellescape v1.4.2 // indirect + github.com/asaskevich/govalidator v0.0.0-20230301143203-a9d515a09cc2 // indirect + github.com/aymanbagabas/go-osc52/v2 v2.0.1 // indirect github.com/aymerick/douceur v0.2.0 // indirect - github.com/cli/browser v1.2.0 // indirect - github.com/cli/shurcooL-graphql v0.0.3 // indirect - github.com/danieljoos/wincred v1.2.0 // indirect - github.com/davecgh/go-spew v1.1.1 // indirect + github.com/blang/semver v3.5.1+incompatible // indirect + github.com/charmbracelet/x/exp/term v0.0.0-20240425164147-ba2a9512b05f // indirect + github.com/cli/browser v1.3.0 // indirect + github.com/cli/shurcooL-graphql v0.0.4 // indirect + github.com/containerd/stargz-snapshotter/estargz v0.14.3 // indirect + github.com/cyberphone/json-canonicalization v0.0.0-20220623050100-57a0ce2678a7 // indirect + github.com/danieljoos/wincred v1.2.1 // indirect + github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect + github.com/digitorus/pkcs7 v0.0.0-20230818184609-3a137a874352 // indirect + github.com/digitorus/timestamp v0.0.0-20231217203849-220c5c2851b7 // indirect github.com/dlclark/regexp2 v1.4.0 // indirect - github.com/fatih/color v1.7.0 // indirect + github.com/docker/cli v24.0.0+incompatible // indirect + github.com/docker/distribution v2.8.2+incompatible // indirect + github.com/docker/docker v24.0.9+incompatible // indirect + github.com/docker/docker-credential-helpers v0.7.0 // indirect + github.com/fatih/color v1.14.1 // indirect + github.com/fsnotify/fsnotify v1.7.0 // indirect github.com/gdamore/encoding v1.0.0 // indirect + github.com/go-chi/chi v4.1.2+incompatible // indirect + github.com/go-logr/logr v1.4.1 // indirect + github.com/go-logr/stdr v1.2.2 // indirect + github.com/go-openapi/analysis v0.23.0 // indirect + github.com/go-openapi/errors v0.22.0 // indirect + github.com/go-openapi/jsonpointer v0.21.0 // indirect + github.com/go-openapi/jsonreference v0.21.0 // indirect + github.com/go-openapi/loads v0.22.0 // indirect + github.com/go-openapi/runtime v0.28.0 // indirect + github.com/go-openapi/spec v0.21.0 // indirect + github.com/go-openapi/strfmt v0.23.0 // indirect + github.com/go-openapi/swag v0.23.0 // indirect + github.com/go-openapi/validate v0.24.0 // indirect github.com/godbus/dbus/v5 v5.1.0 // indirect - github.com/golang/protobuf v1.5.2 // indirect + github.com/golang/protobuf v1.5.4 // indirect + github.com/google/certificate-transparency-go v1.1.8 // indirect + github.com/google/uuid v1.6.0 // indirect github.com/gorilla/css v1.0.0 // indirect github.com/h2non/parth v0.0.0-20190131123155-b4df798d6542 // indirect - github.com/hashicorp/errwrap v1.0.0 // indirect - github.com/inconshreveable/mousetrap v1.0.1 // indirect - github.com/itchyny/gojq v0.12.13 // indirect + github.com/hashicorp/errwrap v1.1.0 // indirect + github.com/hashicorp/go-cleanhttp v0.5.2 // indirect + github.com/hashicorp/go-retryablehttp v0.7.5 // indirect + github.com/hashicorp/hcl v1.0.0 // indirect + github.com/inconshreveable/mousetrap v1.1.0 // indirect + github.com/itchyny/gojq v0.12.15 // indirect github.com/itchyny/timefmt-go v0.1.5 // indirect - github.com/kr/text v0.2.0 // indirect + github.com/jedisct1/go-minisign v0.0.0-20211028175153-1c139d1cc84b // indirect + github.com/josharian/intern v1.0.0 // indirect + github.com/klauspost/compress v1.17.4 // indirect + github.com/letsencrypt/boulder v0.0.0-20230907030200-6d76a0f91e1e // indirect github.com/lucasb-eyer/go-colorful v1.2.0 // indirect - github.com/mattn/go-runewidth v0.0.14 // indirect - github.com/microcosm-cc/bluemonday v1.0.21 // indirect + github.com/magiconair/properties v1.8.7 // indirect + github.com/mailru/easyjson v0.7.7 // indirect + github.com/mattn/go-runewidth v0.0.15 // indirect + github.com/microcosm-cc/bluemonday v1.0.26 // indirect + github.com/mitchellh/go-homedir v1.1.0 // indirect + github.com/mitchellh/mapstructure v1.5.0 // indirect github.com/muesli/reflow v0.3.0 // indirect - github.com/muesli/termenv v0.13.0 // indirect + github.com/muesli/termenv v0.15.2 // indirect + github.com/oklog/ulid v1.3.1 // indirect github.com/olekukonko/tablewriter v0.0.5 // indirect - github.com/pmezard/go-difflib v1.0.0 // indirect - github.com/rivo/uniseg v0.4.4 // indirect + github.com/opencontainers/go-digest v1.0.0 // indirect + github.com/opencontainers/image-spec v1.1.0-rc5 // indirect + github.com/pelletier/go-toml/v2 v2.1.0 // indirect + github.com/pkg/errors v0.9.1 // indirect + github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect + github.com/rivo/uniseg v0.4.7 // indirect + github.com/rodaine/table v1.0.1 // indirect github.com/russross/blackfriday/v2 v2.1.0 // indirect + github.com/sagikazarmark/locafero v0.4.0 // indirect + github.com/sagikazarmark/slog-shim v0.1.0 // indirect + github.com/sassoftware/relic v7.2.1+incompatible // indirect + github.com/secure-systems-lab/go-securesystemslib v0.8.0 // indirect + github.com/shibumi/go-pathspec v1.3.0 // indirect github.com/shurcooL/graphql v0.0.0-20230722043721-ed46e5a46466 // indirect - github.com/stretchr/objx v0.5.0 // indirect + github.com/sigstore/rekor v1.3.6 // indirect + github.com/sigstore/sigstore v1.8.3 // indirect + github.com/sigstore/timestamp-authority v1.2.2 // indirect + github.com/sirupsen/logrus v1.9.3 // indirect + github.com/sourcegraph/conc v0.3.0 // indirect + github.com/spf13/afero v1.11.0 // indirect + github.com/spf13/cast v1.6.0 // indirect + github.com/spf13/viper v1.18.2 // indirect + github.com/stretchr/objx v0.5.2 // indirect + github.com/subosito/gotenv v1.6.0 // indirect + github.com/theupdateframework/go-tuf v0.7.0 // indirect + github.com/theupdateframework/go-tuf/v2 v2.0.0-20240223092044-1e7978e83f63 // indirect github.com/thlib/go-timezone-local v0.0.0-20210907160436-ef149e42d28e // indirect - github.com/yuin/goldmark v1.5.2 // indirect - github.com/yuin/goldmark-emoji v1.0.1 // indirect - golang.org/x/net v0.14.0 // indirect - golang.org/x/sys v0.11.0 // indirect - google.golang.org/genproto v0.0.0-20230110181048-76db0878b65f // indirect - gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 // indirect + github.com/titanous/rocacheck v0.0.0-20171023193734-afe73141d399 // indirect + github.com/transparency-dev/merkle v0.0.2 // indirect + github.com/vbatts/tar-split v0.11.3 // indirect + github.com/yuin/goldmark v1.5.4 // indirect + github.com/yuin/goldmark-emoji v1.0.2 // indirect + go.mongodb.org/mongo-driver v1.14.0 // indirect + go.opentelemetry.io/otel v1.24.0 // indirect + go.opentelemetry.io/otel/metric v1.24.0 // indirect + go.opentelemetry.io/otel/trace v1.24.0 // indirect + go.uber.org/multierr v1.11.0 // indirect + go.uber.org/zap v1.27.0 // indirect + golang.org/x/exp v0.0.0-20231006140011-7918f672742d // indirect + golang.org/x/mod v0.17.0 // indirect + golang.org/x/net v0.23.0 // indirect + golang.org/x/sys v0.19.0 // indirect + google.golang.org/genproto/googleapis/api v0.0.0-20240311173647-c811ad7063a7 // indirect + google.golang.org/genproto/googleapis/rpc v0.0.0-20240318140521-94a12d6c2237 // indirect + gopkg.in/go-jose/go-jose.v2 v2.6.3 // indirect + gopkg.in/ini.v1 v1.67.0 // indirect + k8s.io/klog/v2 v2.120.1 // indirect ) - -replace golang.org/x/crypto => github.com/cli/crypto v0.0.0-20210929142629-6be313f59b03 diff --git a/go.sum b/go.sum index e2996530f..1af962cac 100644 --- a/go.sum +++ b/go.sum @@ -1,247 +1,568 @@ +cloud.google.com/go v0.112.1 h1:uJSeirPke5UNZHIb4SxfZklVSiWWVqW4oXlETwZziwM= +cloud.google.com/go/compute v1.25.0 h1:H1/4SqSUhjPFE7L5ddzHOfY2bCAvjwNRZPNl6Ni5oYU= +cloud.google.com/go/compute v1.25.0/go.mod h1:GR7F0ZPZH8EhChlMo9FkLd7eUTwEymjqQagxzilIxIE= +cloud.google.com/go/compute/metadata v0.2.3 h1:mg4jlk7mCAj6xXp9UJ4fjI9VUI5rubuGBW5aJ7UnBMY= +cloud.google.com/go/compute/metadata v0.2.3/go.mod h1:VAV5nSsACxMJvgaAuX6Pk2AawlZn8kiOGuCv6gTkwuA= +cloud.google.com/go/iam v1.1.6 h1:bEa06k05IO4f4uJonbB5iAgKTPpABy1ayxaIZV/GHVc= +cloud.google.com/go/iam v1.1.6/go.mod h1:O0zxdPeGBoFdWW3HWmBxJsk0pfvNM/p/qa82rWOGTwI= +cloud.google.com/go/kms v1.15.8 h1:szIeDCowID8th2i8XE4uRev5PMxQFqW+JjwYxL9h6xs= +cloud.google.com/go/kms v1.15.8/go.mod h1:WoUHcDjD9pluCg7pNds131awnH429QGvRM3N/4MyoVs= +filippo.io/edwards25519 v1.1.0 h1:FNf4tywRC1HmFuKW5xopWpigGjJKiJSV0Cqo0cJWDaA= +filippo.io/edwards25519 v1.1.0/go.mod h1:BxyFTGdWcka3PhytdK4V28tE5sGfRvvvRV7EaN4VDT4= +github.com/AdamKorcz/go-fuzz-headers-1 v0.0.0-20230919221257-8b5d3ce2d11d h1:zjqpY4C7H15HjRPEenkS4SAn3Jy2eRRjkjZbGR30TOg= +github.com/AdamKorcz/go-fuzz-headers-1 v0.0.0-20230919221257-8b5d3ce2d11d/go.mod h1:XNqJ7hv2kY++g8XEHREpi+JqZo3+0l+CH2egBVN4yqM= github.com/AlecAivazis/survey/v2 v2.3.7 h1:6I/u8FvytdGsgonrYsVn2t8t4QiRnh6QSTqkkhIiSjQ= github.com/AlecAivazis/survey/v2 v2.3.7/go.mod h1:xUTIdE4KCOIjsBAE1JYsUPoCqYdZ1reCfTwbto0Fduo= +github.com/Azure/azure-sdk-for-go/sdk/azcore v1.10.0 h1:n1DH8TPV4qqPTje2RcUBYwtrTWlabVp4n46+74X2pn4= +github.com/Azure/azure-sdk-for-go/sdk/azcore v1.10.0/go.mod h1:HDcZnuGbiyppErN6lB+idp4CKhjbc8gwjto6OPpyggM= +github.com/Azure/azure-sdk-for-go/sdk/azidentity v1.5.1 h1:sO0/P7g68FrryJzljemN+6GTssUXdANk6aJ7T1ZxnsQ= +github.com/Azure/azure-sdk-for-go/sdk/azidentity v1.5.1/go.mod h1:h8hyGFDsU5HMivxiS2iYFZsgDbU9OnnJ163x5UGVKYo= +github.com/Azure/azure-sdk-for-go/sdk/internal v1.5.2 h1:LqbJ/WzJUwBf8UiaSzgX7aMclParm9/5Vgp+TY51uBQ= +github.com/Azure/azure-sdk-for-go/sdk/internal v1.5.2/go.mod h1:yInRyqWXAuaPrgI7p70+lDDgh3mlBohis29jGMISnmc= +github.com/Azure/azure-sdk-for-go/sdk/security/keyvault/azkeys v1.1.0 h1:DRiANoJTiW6obBQe3SqZizkuV1PEgfiiGivmVocDy64= +github.com/Azure/azure-sdk-for-go/sdk/security/keyvault/azkeys v1.1.0/go.mod h1:qLIye2hwb/ZouqhpSD9Zn3SJipvpEnz1Ywl3VUk9Y0s= +github.com/Azure/azure-sdk-for-go/sdk/security/keyvault/internal v1.0.0 h1:D3occbWoio4EBLkbkevetNMAVX197GkzbUMtqjGWn80= +github.com/Azure/azure-sdk-for-go/sdk/security/keyvault/internal v1.0.0/go.mod h1:bTSOgj05NGRuHHhQwAdPnYr9TOdNmKlZTgGLL6nyAdI= +github.com/AzureAD/microsoft-authentication-library-for-go v1.2.2 h1:XHOnouVk1mxXfQidrMEnLlPk9UMeRtyBTnEFtxkV0kU= +github.com/AzureAD/microsoft-authentication-library-for-go v1.2.2/go.mod h1:wP83P5OoQ5p6ip3ScPr0BAq0BvuPAvacpEuSzyouqAI= +github.com/BurntSushi/toml v1.2.1/go.mod h1:CxXYINrC8qIiEnFrOxCa7Jy5BFHlXnUU2pbicEuybxQ= github.com/MakeNowJust/heredoc v1.0.0 h1:cXCdzVdstXyiTqTvfqk9SDHpKNjxuom+DOlyEeQ4pzQ= github.com/MakeNowJust/heredoc v1.0.0/go.mod h1:mG5amYoWBHf8vpLOuehzbGGw0EHxpZZ6lCpQ4fNJ8LE= github.com/Netflix/go-expect v0.0.0-20220104043353-73e0943537d2 h1:+vx7roKuyA63nhn5WAunQHLTznkw5W8b1Xc0dNjp83s= github.com/Netflix/go-expect v0.0.0-20220104043353-73e0943537d2/go.mod h1:HBCaDeC1lPdgDeDbhX8XFpy1jqjK0IBG8W5K+xYqA0w= -github.com/alecthomas/chroma v0.10.0 h1:7XDcGkCQopCNKjZHfYrNLraA+M7e0fMiJ/Mfikbfjek= -github.com/alecthomas/chroma v0.10.0/go.mod h1:jtJATyUxlIORhUOFNA9NZDWGAQ8wpxQQqNSB4rjA/1s= -github.com/alessio/shellescape v1.4.1 h1:V7yhSDDn8LP4lc4jS8pFkt0zCnzVJlG5JXy9BVKJUX0= -github.com/alessio/shellescape v1.4.1/go.mod h1:PZAiSCk0LJaZkiCSkPv8qIobYglO3FPpyFjDCtHLS30= -github.com/aymanbagabas/go-osc52 v1.0.3 h1:DTwqENW7X9arYimJrPeGZcV0ln14sGMt3pHZspWD+Mg= -github.com/aymanbagabas/go-osc52 v1.0.3/go.mod h1:zT8H+Rk4VSabYN90pWyugflM3ZhpTZNC7cASDfUCdT4= +github.com/alecthomas/assert/v2 v2.2.1 h1:XivOgYcduV98QCahG8T5XTezV5bylXe+lBxLG2K2ink= +github.com/alecthomas/assert/v2 v2.2.1/go.mod h1:pXcQ2Asjp247dahGEmsZ6ru0UVwnkhktn7S0bBDLxvQ= +github.com/alecthomas/chroma/v2 v2.8.0 h1:w9WJUjFFmHHB2e8mRpL9jjy3alYDlU0QLDezj1xE264= +github.com/alecthomas/chroma/v2 v2.8.0/go.mod h1:yrkMI9807G1ROx13fhe1v6PN2DDeaR73L3d+1nmYQtw= +github.com/alecthomas/repr v0.2.0 h1:HAzS41CIzNW5syS8Mf9UwXhNH1J9aix/BvDRf1Ml2Yk= +github.com/alecthomas/repr v0.2.0/go.mod h1:Fr0507jx4eOXV7AlPV6AVZLYrLIuIeSOWtW57eE/O/4= +github.com/alessio/shellescape v1.4.2 h1:MHPfaU+ddJ0/bYWpgIeUnQUqKrlJ1S7BfEYPM4uEoM0= +github.com/alessio/shellescape v1.4.2/go.mod h1:PZAiSCk0LJaZkiCSkPv8qIobYglO3FPpyFjDCtHLS30= +github.com/asaskevich/govalidator v0.0.0-20230301143203-a9d515a09cc2 h1:DklsrG3dyBCFEj5IhUbnKptjxatkF07cF2ak3yi77so= +github.com/asaskevich/govalidator v0.0.0-20230301143203-a9d515a09cc2/go.mod h1:WaHUgvxTVq04UNunO+XhnAqY/wQc+bxr74GqbsZ/Jqw= +github.com/aws/aws-sdk-go v1.51.6 h1:Ld36dn9r7P9IjU8WZSaswQ8Y/XUCRpewim5980DwYiU= +github.com/aws/aws-sdk-go v1.51.6/go.mod h1:LF8svs817+Nz+DmiMQKTO3ubZ/6IaTpq3TjupRn3Eqk= +github.com/aws/aws-sdk-go-v2 v1.26.0 h1:/Ce4OCiM3EkpW7Y+xUnfAFpchU78K7/Ug01sZni9PgA= +github.com/aws/aws-sdk-go-v2 v1.26.0/go.mod h1:35hUlJVYd+M++iLI3ALmVwMOyRYMmRqUXpTtRGW+K9I= +github.com/aws/aws-sdk-go-v2/config v1.27.9 h1:gRx/NwpNEFSk+yQlgmk1bmxxvQ5TyJ76CWXs9XScTqg= +github.com/aws/aws-sdk-go-v2/config v1.27.9/go.mod h1:dK1FQfpwpql83kbD873E9vz4FyAxuJtR22wzoXn3qq0= +github.com/aws/aws-sdk-go-v2/credentials v1.17.9 h1:N8s0/7yW+h8qR8WaRlPQeJ6czVMNQVNtNdUqf6cItao= +github.com/aws/aws-sdk-go-v2/credentials v1.17.9/go.mod h1:446YhIdmSV0Jf/SLafGZalQo+xr2iw7/fzXGDPTU1yQ= +github.com/aws/aws-sdk-go-v2/feature/ec2/imds v1.16.0 h1:af5YzcLf80tv4Em4jWVD75lpnOHSBkPUZxZfGkrI3HI= +github.com/aws/aws-sdk-go-v2/feature/ec2/imds v1.16.0/go.mod h1:nQ3how7DMnFMWiU1SpECohgC82fpn4cKZ875NDMmwtA= +github.com/aws/aws-sdk-go-v2/internal/configsources v1.3.4 h1:0ScVK/4qZ8CIW0k8jOeFVsyS/sAiXpYxRBLolMkuLQM= +github.com/aws/aws-sdk-go-v2/internal/configsources v1.3.4/go.mod h1:84KyjNZdHC6QZW08nfHI6yZgPd+qRgaWcYsyLUo3QY8= +github.com/aws/aws-sdk-go-v2/internal/endpoints/v2 v2.6.4 h1:sHmMWWX5E7guWEFQ9SVo6A3S4xpPrWnd77a6y4WM6PU= +github.com/aws/aws-sdk-go-v2/internal/endpoints/v2 v2.6.4/go.mod h1:WjpDrhWisWOIoS9n3nk67A3Ll1vfULJ9Kq6h29HTD48= +github.com/aws/aws-sdk-go-v2/internal/ini v1.8.0 h1:hT8rVHwugYE2lEfdFE0QWVo81lF7jMrYJVDWI+f+VxU= +github.com/aws/aws-sdk-go-v2/internal/ini v1.8.0/go.mod h1:8tu/lYfQfFe6IGnaOdrpVgEL2IrrDOf6/m9RQum4NkY= +github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v1.11.1 h1:EyBZibRTVAs6ECHZOw5/wlylS9OcTzwyjeQMudmREjE= +github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v1.11.1/go.mod h1:JKpmtYhhPs7D97NL/ltqz7yCkERFW5dOlHyVl66ZYF8= +github.com/aws/aws-sdk-go-v2/service/internal/presigned-url v1.11.6 h1:b+E7zIUHMmcB4Dckjpkapoy47W6C9QBv/zoUP+Hn8Kc= +github.com/aws/aws-sdk-go-v2/service/internal/presigned-url v1.11.6/go.mod h1:S2fNV0rxrP78NhPbCZeQgY8H9jdDMeGtwcfZIRxzBqU= +github.com/aws/aws-sdk-go-v2/service/kms v1.30.0 h1:yS0JkEdV6h9JOo8sy2JSpjX+i7vsKifU8SIeHrqiDhU= +github.com/aws/aws-sdk-go-v2/service/kms v1.30.0/go.mod h1:+I8VUUSVD4p5ISQtzpgSva4I8cJ4SQ4b1dcBcof7O+g= +github.com/aws/aws-sdk-go-v2/service/sso v1.20.3 h1:mnbuWHOcM70/OFUlZZ5rcdfA8PflGXXiefU/O+1S3+8= +github.com/aws/aws-sdk-go-v2/service/sso v1.20.3/go.mod h1:5HFu51Elk+4oRBZVxmHrSds5jFXmFj8C3w7DVF2gnrs= +github.com/aws/aws-sdk-go-v2/service/ssooidc v1.23.3 h1:uLq0BKatTmDzWa/Nu4WO0M1AaQDaPpwTKAeByEc6WFM= +github.com/aws/aws-sdk-go-v2/service/ssooidc v1.23.3/go.mod h1:b+qdhjnxj8GSR6t5YfphOffeoQSQ1KmpoVVuBn+PWxs= +github.com/aws/aws-sdk-go-v2/service/sts v1.28.5 h1:J/PpTf/hllOjx8Xu9DMflff3FajfLxqM5+tepvVXmxg= +github.com/aws/aws-sdk-go-v2/service/sts v1.28.5/go.mod h1:0ih0Z83YDH/QeQ6Ori2yGE2XvWYv/Xm+cZc01LC6oK0= +github.com/aws/smithy-go v1.20.1 h1:4SZlSlMr36UEqC7XOyRVb27XMeZubNcBNN+9IgEPIQw= +github.com/aws/smithy-go v1.20.1/go.mod h1:krry+ya/rV9RDcV/Q16kpu6ypI4K2czasz0NC3qS14E= +github.com/aymanbagabas/go-osc52/v2 v2.0.1 h1:HwpRHbFMcZLEVr42D4p7XBqjyuxQH5SMiErDT4WkJ2k= +github.com/aymanbagabas/go-osc52/v2 v2.0.1/go.mod h1:uYgXzlJ7ZpABp8OJ+exZzJJhRNQ2ASbcXHWsFqH8hp8= github.com/aymerick/douceur v0.2.0 h1:Mv+mAeH1Q+n9Fr+oyamOlAkUNPWPlA8PPGR0QAaYuPk= github.com/aymerick/douceur v0.2.0/go.mod h1:wlT5vV2O3h55X9m7iVYN0TBM0NH/MmbLnd30/FjWUq4= +github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM= +github.com/beorn7/perks v1.0.1/go.mod h1:G2ZrVWU2WbWT9wwq4/hrbKbnv/1ERSJQ0ibhJ6rlkpw= +github.com/blang/semver v3.5.1+incompatible h1:cQNTCjp13qL8KC3Nbxr/y2Bqb63oX6wdnnjpJbkM4JQ= +github.com/blang/semver v3.5.1+incompatible/go.mod h1:kRBLl5iJ+tD4TcOOxsy/0fnwebNt5EWlYSAyrTnjyyk= github.com/briandowns/spinner v1.18.1 h1:yhQmQtM1zsqFsouh09Bk/jCjd50pC3EOGsh28gLVvwY= github.com/briandowns/spinner v1.18.1/go.mod h1:mQak9GHqbspjC/5iUx3qMlIho8xBS/ppAL/hX5SmPJU= +github.com/cenkalti/backoff/v3 v3.2.2 h1:cfUAAO3yvKMYKPrvhDuHSwQnhZNk/RMHKdZqKTxfm6M= +github.com/cenkalti/backoff/v3 v3.2.2/go.mod h1:cIeZDE3IrqwwJl6VUwCN6trj1oXrTS4rc0ij+ULvLYs= github.com/cenkalti/backoff/v4 v4.2.1 h1:y4OZtCnogmCPw98Zjyt5a6+QwPLGkiQsYW5oUqylYbM= github.com/cenkalti/backoff/v4 v4.2.1/go.mod h1:Y3VNntkOUPxTVeUxJ/G5vcM//AlwfmyYozVcomhLiZE= -github.com/charmbracelet/glamour v0.6.0 h1:wi8fse3Y7nfcabbbDuwolqTqMQPMnVPeZhDM273bISc= -github.com/charmbracelet/glamour v0.6.0/go.mod h1:taqWV4swIMMbWALc0m7AfE9JkPSU8om2538k9ITBxOc= -github.com/charmbracelet/lipgloss v0.5.0 h1:lulQHuVeodSgDez+3rGiuxlPVXSnhth442DATR2/8t8= -github.com/charmbracelet/lipgloss v0.5.0/go.mod h1:EZLha/HbzEt7cYqdFPovlqy5FZPj0xFhg5SaqxScmgs= +github.com/cespare/xxhash/v2 v2.2.0 h1:DC2CZ1Ep5Y4k3ZQ899DldepgrayRUGE6BBZ/cd9Cj44= +github.com/cespare/xxhash/v2 v2.2.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs= +github.com/charmbracelet/glamour v0.7.0 h1:2BtKGZ4iVJCDfMF229EzbeR1QRKLWztO9dMtjmqZSng= +github.com/charmbracelet/glamour v0.7.0/go.mod h1:jUMh5MeihljJPQbJ/wf4ldw2+yBP59+ctV36jASy7ps= +github.com/charmbracelet/lipgloss v0.10.1-0.20240413172830-d0be07ea6b9c h1:0FwZb0wTiyalb8QQlILWyIuh3nF5wok6j9D9oUQwfQY= +github.com/charmbracelet/lipgloss v0.10.1-0.20240413172830-d0be07ea6b9c/go.mod h1:EPP2QJ0ectp3zo6gx9f8oJGq8keirqPJ3XpYEI8wrrs= +github.com/charmbracelet/x/exp/term v0.0.0-20240425164147-ba2a9512b05f h1:1BXkZqDueTOBECyDoFGRi0xMYgjJ6vvoPIkWyKOwzTc= +github.com/charmbracelet/x/exp/term v0.0.0-20240425164147-ba2a9512b05f/go.mod h1:yQqGHmheaQfkqiJWjklPHVAq1dKbk8uGbcoS/lcKCJ0= github.com/cli/browser v1.0.0/go.mod h1:IEWkHYbLjkhtjwwWlwTHW2lGxeS5gezEQBMLTwDHf5Q= -github.com/cli/browser v1.2.0 h1:yvU7e9qf97kZqGFX6n2zJPHsmSObY9ske+iCvKelvXg= -github.com/cli/browser v1.2.0/go.mod h1:xFFnXLVcAyW9ni0cuo6NnrbCP75JxJ0RO7VtCBiH/oI= -github.com/cli/crypto v0.0.0-20210929142629-6be313f59b03 h1:3f4uHLfWx4/WlnMPXGai03eoWAI+oGHJwr+5OXfxCr8= -github.com/cli/crypto v0.0.0-20210929142629-6be313f59b03/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= -github.com/cli/go-gh/v2 v2.3.0 h1:FAQAP4PaWSAJf4VSxFEIYDQ1oBIs+bKB4GXQAiRr2sQ= -github.com/cli/go-gh/v2 v2.3.0/go.mod h1:6WBUuf7LUVAc+eXYYX/nYTYURRc6M03K9cJNwBKvwT0= +github.com/cli/browser v1.3.0 h1:LejqCrpWr+1pRqmEPDGnTZOjsMe7sehifLynZJuqJpo= +github.com/cli/browser v1.3.0/go.mod h1:HH8s+fOAxjhQoBUAsKuPCbqUuxZDhQ2/aD+SzsEfBTk= +github.com/cli/go-gh/v2 v2.9.0 h1:D3lTjEneMYl54M+WjZ+kRPrR5CEJ5BHS05isBPOV3LI= +github.com/cli/go-gh/v2 v2.9.0/go.mod h1:MeRoKzXff3ygHu7zP+NVTT+imcHW6p3tpuxHAzRM2xE= github.com/cli/oauth v1.0.1 h1:pXnTFl/qUegXHK531Dv0LNjW4mLx626eS42gnzfXJPA= github.com/cli/oauth v1.0.1/go.mod h1:qd/FX8ZBD6n1sVNQO3aIdRxeu5LGw9WhKnYhIIoC2A4= github.com/cli/safeexec v1.0.0/go.mod h1:Z/D4tTN8Vs5gXYHDCbaM1S/anmEDnJb1iW0+EJ5zx3Q= github.com/cli/safeexec v1.0.1 h1:e/C79PbXF4yYTN/wauC4tviMxEV13BwljGj0N9j+N00= github.com/cli/safeexec v1.0.1/go.mod h1:Z/D4tTN8Vs5gXYHDCbaM1S/anmEDnJb1iW0+EJ5zx3Q= -github.com/cli/shurcooL-graphql v0.0.3 h1:CtpPxyGDs136/+ZeyAfUKYmcQBjDlq5aqnrDCW5Ghh8= -github.com/cli/shurcooL-graphql v0.0.3/go.mod h1:tlrLmw/n5Q/+4qSvosT+9/W5zc8ZMjnJeYBxSdb4nWA= -github.com/cpuguy83/go-md2man/v2 v2.0.2 h1:p1EgwI/C7NhT0JmVkwCD2ZBK8j4aeHQX2pMHHBfMQ6w= +github.com/cli/shurcooL-graphql v0.0.4 h1:6MogPnQJLjKkaXPyGqPRXOI2qCsQdqNfUY1QSJu2GuY= +github.com/cli/shurcooL-graphql v0.0.4/go.mod h1:3waN4u02FiZivIV+p1y4d0Jo1jc6BViMA73C+sZo2fk= +github.com/codahale/rfc6979 v0.0.0-20141003034818-6a90f24967eb h1:EDmT6Q9Zs+SbUoc7Ik9EfrFqcylYqgPZ9ANSbTAntnE= +github.com/codahale/rfc6979 v0.0.0-20141003034818-6a90f24967eb/go.mod h1:ZjrT6AXHbDs86ZSdt/osfBi5qfexBrKUdONk989Wnk4= +github.com/containerd/stargz-snapshotter/estargz v0.14.3 h1:OqlDCK3ZVUO6C3B/5FSkDwbkEETK84kQgEeFwDC+62k= +github.com/containerd/stargz-snapshotter/estargz v0.14.3/go.mod h1:KY//uOCIkSuNAHhJogcZtrNHdKrA99/FCCRjE3HD36o= github.com/cpuguy83/go-md2man/v2 v2.0.2/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o= -github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E= +github.com/cpuguy83/go-md2man/v2 v2.0.3/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o= +github.com/cpuguy83/go-md2man/v2 v2.0.4 h1:wfIWP927BUkWJb2NmU/kNDYIBTh/ziUX91+lVfRxZq4= +github.com/cpuguy83/go-md2man/v2 v2.0.4/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o= github.com/creack/pty v1.1.17/go.mod h1:MOBLtS5ELjhRRrroQr9kyvTxUAFNvYEK993ew/Vr4O4= -github.com/creack/pty v1.1.18 h1:n56/Zwd5o6whRC5PMGretI4IdRLlmBXYNjScPaBgsbY= -github.com/creack/pty v1.1.18/go.mod h1:MOBLtS5ELjhRRrroQr9kyvTxUAFNvYEK993ew/Vr4O4= -github.com/danieljoos/wincred v1.2.0 h1:ozqKHaLK0W/ii4KVbbvluM91W2H3Sh0BncbUNPS7jLE= -github.com/danieljoos/wincred v1.2.0/go.mod h1:FzQLLMKBFdvu+osBrnFODiv32YGwCfx0SkRa/eYHgec= +github.com/creack/pty v1.1.21 h1:1/QdRyBaHHJP61QkWMXlOIBfsgdDeeKfK8SYVUWJKf0= +github.com/creack/pty v1.1.21/go.mod h1:MOBLtS5ELjhRRrroQr9kyvTxUAFNvYEK993ew/Vr4O4= +github.com/cyberphone/json-canonicalization v0.0.0-20220623050100-57a0ce2678a7 h1:vU+EP9ZuFUCYE0NYLwTSob+3LNEJATzNfP/DC7SWGWI= +github.com/cyberphone/json-canonicalization v0.0.0-20220623050100-57a0ce2678a7/go.mod h1:uzvlm1mxhHkdfqitSA92i7Se+S9ksOn3a3qmv/kyOCw= +github.com/danieljoos/wincred v1.2.1 h1:dl9cBrupW8+r5250DYkYxocLeZ1Y4vB1kxgtjxw8GQs= +github.com/danieljoos/wincred v1.2.1/go.mod h1:uGaFL9fDn3OLTvzCGulzE+SzjEe5NGlh5FdCcyfPwps= github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= -github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc h1:U9qPSI2PIWSS1VwoXQT9A3Wy9MM3WgvqSxFWenqJduM= +github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/digitorus/pkcs7 v0.0.0-20230713084857-e76b763bdc49/go.mod h1:SKVExuS+vpu2l9IoOc0RwqE7NYnb0JlcFHFnEJkVDzc= +github.com/digitorus/pkcs7 v0.0.0-20230818184609-3a137a874352 h1:ge14PCmCvPjpMQMIAH7uKg0lrtNSOdpYsRXlwk3QbaE= +github.com/digitorus/pkcs7 v0.0.0-20230818184609-3a137a874352/go.mod h1:SKVExuS+vpu2l9IoOc0RwqE7NYnb0JlcFHFnEJkVDzc= +github.com/digitorus/timestamp v0.0.0-20231217203849-220c5c2851b7 h1:lxmTCgmHE1GUYL7P0MlNa00M67axePTq+9nBSGddR8I= +github.com/digitorus/timestamp v0.0.0-20231217203849-220c5c2851b7/go.mod h1:GvWntX9qiTlOud0WkQ6ewFm0LPy5JUR1Xo0Ngbd1w6Y= +github.com/distribution/reference v0.5.0 h1:/FUIFXtfc/x2gpa5/VGfiGLuOIdYa1t65IKK2OFGvA0= +github.com/distribution/reference v0.5.0/go.mod h1:BbU0aIcezP1/5jX/8MP0YiH4SdvB5Y4f/wlDRiLyi3E= github.com/dlclark/regexp2 v1.4.0 h1:F1rxgk7p4uKjwIQxBs9oAXe5CqrXlCduYEJvrF4u93E= github.com/dlclark/regexp2 v1.4.0/go.mod h1:2pZnwuY/m+8K6iRw6wQdMtk+rH5tNGR1i55kozfMjCc= -github.com/fatih/color v1.7.0 h1:DkWD4oS2D8LGGgTQ6IvwJJXSL5Vp2ffcQg58nFV38Ys= +github.com/docker/cli v24.0.0+incompatible h1:0+1VshNwBQzQAx9lOl+OYCTCEAD8fKs/qeXMx3O0wqM= +github.com/docker/cli v24.0.0+incompatible/go.mod h1:JLrzqnKDaYBop7H2jaqPtU4hHvMKP+vjCwu2uszcLI8= +github.com/docker/distribution v2.8.2+incompatible h1:T3de5rq0dB1j30rp0sA2rER+m322EBzniBPB6ZIzuh8= +github.com/docker/distribution v2.8.2+incompatible/go.mod h1:J2gT2udsDAN96Uj4KfcMRqY0/ypR+oyYUYmja8H+y+w= +github.com/docker/docker v24.0.9+incompatible h1:HPGzNmwfLZWdxHqK9/II92pyi1EpYKsAqcl4G0Of9v0= +github.com/docker/docker v24.0.9+incompatible/go.mod h1:eEKB0N0r5NX/I1kEveEz05bcu8tLC/8azJZsviup8Sk= +github.com/docker/docker-credential-helpers v0.7.0 h1:xtCHsjxogADNZcdv1pKUHXryefjlVRqWqIhk/uXJp0A= +github.com/docker/docker-credential-helpers v0.7.0/go.mod h1:rETQfLdHNT3foU5kuNkFR1R1V12OJRRO5lzt2D1b5X0= github.com/fatih/color v1.7.0/go.mod h1:Zm6kSWBoL9eyXnKyktHP6abPY2pDugNf5KwzbycvMj4= -github.com/gabriel-vasile/mimetype v1.4.2 h1:w5qFW6JKBz9Y393Y4q372O9A7cUSequkh1Q7OhCmWKU= -github.com/gabriel-vasile/mimetype v1.4.2/go.mod h1:zApsH/mKG4w07erKIaJPFiX0Tsq9BFQgN3qGY5GnNgA= +github.com/fatih/color v1.14.1 h1:qfhVLaG5s+nCROl1zJsZRxFeYrHLqWroPOQ8BWiNb4w= +github.com/fatih/color v1.14.1/go.mod h1:2oHN61fhTpgcxD3TSWCgKDiH1+x4OiDVVGH8WlgGZGg= +github.com/felixge/httpsnoop v1.0.4 h1:NFTV2Zj1bL4mc9sqWACXbQFVBBg2W3GPvqp8/ESS2Wg= +github.com/felixge/httpsnoop v1.0.4/go.mod h1:m8KPJKqk1gH5J9DgRY2ASl2lWCfGKXixSwevea8zH2U= +github.com/frankban/quicktest v1.14.6 h1:7Xjx+VpznH+oBnejlPUj8oUpdxnVs4f8XU8WnHkI4W8= +github.com/frankban/quicktest v1.14.6/go.mod h1:4ptaffx2x8+WTWXmUCuVU6aPUX1/Mz7zb5vbUoiM6w0= +github.com/fsnotify/fsnotify v1.7.0 h1:8JEhPFa5W2WU7YfeZzPNqzMP6Lwt7L2715Ggo0nosvA= +github.com/fsnotify/fsnotify v1.7.0/go.mod h1:40Bi/Hjc2AVfZrqy+aj+yEI+/bRxZnMJyTJwOpGvigM= +github.com/gabriel-vasile/mimetype v1.4.3 h1:in2uUcidCuFcDKtdcBxlR0rJ1+fsokWf+uqxgUFjbI0= +github.com/gabriel-vasile/mimetype v1.4.3/go.mod h1:d8uq/6HKRL6CGdk+aubisF/M5GcPfT7nKyLpA0lbSSk= github.com/gdamore/encoding v1.0.0 h1:+7OoQ1Bc6eTm5niUzBa0Ctsh6JbMW6Ra+YNuAtDBdko= github.com/gdamore/encoding v1.0.0/go.mod h1:alR0ol34c49FCSBLjhosxzcPHQbf2trDkoo5dl+VrEg= github.com/gdamore/tcell/v2 v2.5.4 h1:TGU4tSjD3sCL788vFNeJnTdzpNKIw1H5dgLnJRQVv/k= github.com/gdamore/tcell/v2 v2.5.4/go.mod h1:dZgRy5v4iMobMEcWNYBtREnDZAT9DYmfqIkrgEMxLyw= +github.com/go-chi/chi v4.1.2+incompatible h1:fGFk2Gmi/YKXk0OmGfBh0WgmN3XB8lVnEyNz34tQRec= +github.com/go-chi/chi v4.1.2+incompatible/go.mod h1:eB3wogJHnLi3x/kFX2A+IbTBlXxmMeXJVKy9tTv1XzQ= +github.com/go-jose/go-jose/v3 v3.0.3 h1:fFKWeig/irsp7XD2zBxvnmA/XaRWp5V3CBsZXJF7G7k= +github.com/go-jose/go-jose/v3 v3.0.3/go.mod h1:5b+7YgP7ZICgJDBdfjZaIt+H/9L9T/YQrVfLAMboGkQ= +github.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A= +github.com/go-logr/logr v1.4.1 h1:pKouT5E8xu9zeFC39JXRDukb6JFQPXM5p5I91188VAQ= +github.com/go-logr/logr v1.4.1/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY= +github.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag= +github.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE= +github.com/go-openapi/analysis v0.23.0 h1:aGday7OWupfMs+LbmLZG4k0MYXIANxcuBTYUC03zFCU= +github.com/go-openapi/analysis v0.23.0/go.mod h1:9mz9ZWaSlV8TvjQHLl2mUW2PbZtemkE8yA5v22ohupo= +github.com/go-openapi/errors v0.22.0 h1:c4xY/OLxUBSTiepAg3j/MHuAv5mJhnf53LLMWFB+u/w= +github.com/go-openapi/errors v0.22.0/go.mod h1:J3DmZScxCDufmIMsdOuDHxJbdOGC0xtUynjIx092vXE= +github.com/go-openapi/jsonpointer v0.21.0 h1:YgdVicSA9vH5RiHs9TZW5oyafXZFc6+2Vc1rr/O9oNQ= +github.com/go-openapi/jsonpointer v0.21.0/go.mod h1:IUyH9l/+uyhIYQ/PXVA41Rexl+kOkAPDdXEYns6fzUY= +github.com/go-openapi/jsonreference v0.21.0 h1:Rs+Y7hSXT83Jacb7kFyjn4ijOuVGSvOdF2+tg1TRrwQ= +github.com/go-openapi/jsonreference v0.21.0/go.mod h1:LmZmgsrTkVg9LG4EaHeY8cBDslNPMo06cago5JNLkm4= +github.com/go-openapi/loads v0.22.0 h1:ECPGd4jX1U6NApCGG1We+uEozOAvXvJSF4nnwHZ8Aco= +github.com/go-openapi/loads v0.22.0/go.mod h1:yLsaTCS92mnSAZX5WWoxszLj0u+Ojl+Zs5Stn1oF+rs= +github.com/go-openapi/runtime v0.28.0 h1:gpPPmWSNGo214l6n8hzdXYhPuJcGtziTOgUpvsFWGIQ= +github.com/go-openapi/runtime v0.28.0/go.mod h1:QN7OzcS+XuYmkQLw05akXk0jRH/eZ3kb18+1KwW9gyc= +github.com/go-openapi/spec v0.21.0 h1:LTVzPc3p/RzRnkQqLRndbAzjY0d0BCL72A6j3CdL9ZY= +github.com/go-openapi/spec v0.21.0/go.mod h1:78u6VdPw81XU44qEWGhtr982gJ5BWg2c0I5XwVMotYk= +github.com/go-openapi/strfmt v0.23.0 h1:nlUS6BCqcnAk0pyhi9Y+kdDVZdZMHfEKQiS4HaMgO/c= +github.com/go-openapi/strfmt v0.23.0/go.mod h1:NrtIpfKtWIygRkKVsxh7XQMDQW5HKQl6S5ik2elW+K4= +github.com/go-openapi/swag v0.23.0 h1:vsEVJDUo2hPJ2tu0/Xc+4noaxyEffXNIs3cOULZ+GrE= +github.com/go-openapi/swag v0.23.0/go.mod h1:esZ8ITTYEsH1V2trKHjAN8Ai7xHb8RV+YSZ577vPjgQ= +github.com/go-openapi/validate v0.24.0 h1:LdfDKwNbpB6Vn40xhTdNZAnfLECL81w+VX3BumrGD58= +github.com/go-openapi/validate v0.24.0/go.mod h1:iyeX1sEufmv3nPbBdX3ieNviWnOZaJ1+zquzJEf2BAQ= +github.com/go-test/deep v1.1.0 h1:WOcxcdHcvdgThNXjw0t76K42FXTU7HpNQWHpA2HHNlg= +github.com/go-test/deep v1.1.0/go.mod h1:5C2ZWiW0ErCdrYzpqxLbTX7MG14M9iiw8DgHncVwcsE= github.com/godbus/dbus/v5 v5.1.0 h1:4KLkAxT3aOY8Li4FRJe/KvhoNFFxo0m6fNuFUO8QJUk= github.com/godbus/dbus/v5 v5.1.0/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA= -github.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaSAoJOfIk= -github.com/golang/protobuf v1.5.2 h1:ROPKBNFfQgOUMifHyP+KYbvpjbdoFNs+aK7DXlji0Tw= -github.com/golang/protobuf v1.5.2/go.mod h1:XVQd3VNwM+JqD3oG2Ue2ip4fOMUkwXdXDdiuN0vRsmY= -github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= -github.com/google/go-cmp v0.5.9 h1:O2Tfq5qg4qc4AmwVlvv0oLiVAGB7enBSJ2x2DqQFi38= -github.com/google/go-cmp v0.5.9/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY= +github.com/golang-jwt/jwt/v5 v5.2.1 h1:OuVbFODueb089Lh128TAcimifWaLhJwVflnrgM17wHk= +github.com/golang-jwt/jwt/v5 v5.2.1/go.mod h1:pqrtFR0X4osieyHYxtmOUWsAWrfe1Q5UVIyoH402zdk= +github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da h1:oI5xCqsCo564l8iNU+DwB5epxmsaqB+rhGL0m5jtYqE= +github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da/go.mod h1:cIg4eruTrX1D+g88fzRXU5OdNfaM+9IcxsU14FzY7Hc= +github.com/golang/protobuf v1.5.4 h1:i7eJL8qZTpSEXOPTxNKhASYpMn+8e5Q6AdndVa1dWek= +github.com/golang/protobuf v1.5.4/go.mod h1:lnTiLA8Wa4RWRcIUkrtSVa5nRhsEGBg48fD6rSs7xps= +github.com/google/certificate-transparency-go v1.1.8 h1:LGYKkgZF7satzgTak9R4yzfJXEeYVAjV6/EAEJOf1to= +github.com/google/certificate-transparency-go v1.1.8/go.mod h1:bV/o8r0TBKRf1X//iiiSgWrvII4d7/8OiA+3vG26gI8= +github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI= +github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY= +github.com/google/go-containerregistry v0.19.1 h1:yMQ62Al6/V0Z7CqIrrS1iYoA5/oQCm88DeNujc7C1KY= +github.com/google/go-containerregistry v0.19.1/go.mod h1:YCMFNQeeXeLF+dnhhWkqDItx/JSkH01j1Kis4PsjzFI= +github.com/google/gofuzz v1.2.0 h1:xRy4A+RhZaiKjJ1bPfwQ8sedCA+YS2YcCHW6ec7JMi0= +github.com/google/gofuzz v1.2.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg= +github.com/google/s2a-go v0.1.7 h1:60BLSyTrOV4/haCDW4zb1guZItoSq8foHCXrAnjBo/o= +github.com/google/s2a-go v0.1.7/go.mod h1:50CgR4k1jNlWBu4UfS4AcfhVe1r6pdZPygJ3R8F0Qdw= github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510 h1:El6M4kTTCOh6aBiKaUGG7oYTSPP8MxqL4YI3kZKwcP4= github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510/go.mod h1:pupxD2MaaD3pAXIBCelhxNneeOaAeabZDe5s4K6zSpQ= +github.com/google/tink/go v1.7.0 h1:6Eox8zONGebBFcCBqkVmt60LaWZa6xg1cl/DwAh/J1w= +github.com/google/tink/go v1.7.0/go.mod h1:GAUOd+QE3pgj9q8VKIGTCP33c/B7eb4NhxLcgTJZStM= +github.com/google/trillian v1.6.0 h1:jMBeDBIkINFvS2n6oV5maDqfRlxREAc6CW9QYWQ0qT4= +github.com/google/trillian v1.6.0/go.mod h1:Yu3nIMITzNhhMJEHjAtp6xKiu+H/iHu2Oq5FjV2mCWI= +github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0= +github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= +github.com/googleapis/enterprise-certificate-proxy v0.3.2 h1:Vie5ybvEvT75RniqhfFxPRy3Bf7vr3h0cechB90XaQs= +github.com/googleapis/enterprise-certificate-proxy v0.3.2/go.mod h1:VLSiSSBs/ksPL8kq3OBOQ6WRI2QnaFynd1DCjZ62+V0= +github.com/googleapis/gax-go/v2 v2.12.3 h1:5/zPPDvw8Q1SuXjrqrZslrqT7dL/uJT2CQii/cLCKqA= +github.com/googleapis/gax-go/v2 v2.12.3/go.mod h1:AKloxT6GtNbaLm8QTNSidHUVsHYcBHwWRvkNFJUQcS4= github.com/gorilla/css v1.0.0 h1:BQqNyPTi50JCFMTw/b67hByjMVXZRwGha6wxVGkeihY= github.com/gorilla/css v1.0.0/go.mod h1:Dn721qIggHpt4+EFCcTLTU/vk5ySda2ReITrtgBl60c= -github.com/gorilla/websocket v1.4.1/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE= -github.com/gorilla/websocket v1.4.2 h1:+/TMaTYc4QFitKJxsQ7Yye35DkWvkdLcvGKqM+x0Ufc= -github.com/gorilla/websocket v1.4.2/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE= +github.com/gorilla/websocket v1.5.1 h1:gmztn0JnHVt9JZquRuzLw3g4wouNVzKL15iLr/zn/QY= +github.com/gorilla/websocket v1.5.1/go.mod h1:x3kM2JMyaluk02fnUJpQuwD2dCS5NDG2ZHL0uE0tcaY= github.com/h2non/parth v0.0.0-20190131123155-b4df798d6542 h1:2VTzZjLZBgl62/EtslCrtky5vbi9dd7HrQPQIx6wqiw= github.com/h2non/parth v0.0.0-20190131123155-b4df798d6542/go.mod h1:Ow0tF8D4Kplbc8s8sSb3V2oUCygFHVp8gC3Dn6U4MNI= -github.com/hashicorp/errwrap v1.0.0 h1:hLrqtEDnRye3+sgx6z4qVLNuviH3MR5aQ0ykNJa/UYA= github.com/hashicorp/errwrap v1.0.0/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brvKWEqk/Jc4= +github.com/hashicorp/errwrap v1.1.0 h1:OxrOeh75EUXMY8TBjag2fzXGZ40LB6IKw45YeGUDY2I= +github.com/hashicorp/errwrap v1.1.0/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brvKWEqk/Jc4= +github.com/hashicorp/go-cleanhttp v0.5.2 h1:035FKYIWjmULyFRBKPs8TBQoi0x6d9G4xc9neXJWAZQ= +github.com/hashicorp/go-cleanhttp v0.5.2/go.mod h1:kO/YDlP8L1346E6Sodw+PrpBSV4/SoxCXGY6BqNFT48= +github.com/hashicorp/go-hclog v0.9.2/go.mod h1:5CU+agLiy3J7N7QjHK5d05KxGsuXiQLrjA0H7acj2lQ= +github.com/hashicorp/go-hclog v1.5.0 h1:bI2ocEMgcVlz55Oj1xZNBsVi900c7II+fWDyV9o+13c= +github.com/hashicorp/go-hclog v1.5.0/go.mod h1:W4Qnvbt70Wk/zYJryRzDRU/4r0kIg0PVHBcfoyhpF5M= github.com/hashicorp/go-multierror v1.1.1 h1:H5DkEtf6CXdFp0N0Em5UCwQpXMWke8IA0+lD48awMYo= github.com/hashicorp/go-multierror v1.1.1/go.mod h1:iw975J/qwKPdAO1clOe2L8331t/9/fmwbPZ6JB6eMoM= +github.com/hashicorp/go-retryablehttp v0.7.5 h1:bJj+Pj19UZMIweq/iie+1u5YCdGrnxCT9yvm0e+Nd5M= +github.com/hashicorp/go-retryablehttp v0.7.5/go.mod h1:Jy/gPYAdjqffZ/yFGCFV2doI5wjtH1ewM9u8iYVjtX8= +github.com/hashicorp/go-rootcerts v1.0.2 h1:jzhAVGtqPKbwpyCPELlgNWhE1znq+qwJtW5Oi2viEzc= +github.com/hashicorp/go-rootcerts v1.0.2/go.mod h1:pqUvnprVnM5bf7AOirdbb01K4ccR319Vf4pU3K5EGc8= +github.com/hashicorp/go-secure-stdlib/parseutil v0.1.7 h1:UpiO20jno/eV1eVZcxqWnUohyKRe1g8FPV/xH1s/2qs= +github.com/hashicorp/go-secure-stdlib/parseutil v0.1.7/go.mod h1:QmrqtbKuxxSWTN3ETMPuB+VtEiBJ/A9XhoYGv8E1uD8= +github.com/hashicorp/go-secure-stdlib/strutil v0.1.2 h1:kes8mmyCpxJsI7FTwtzRqEy9CdjCtrXrXGuOpxEA7Ts= +github.com/hashicorp/go-secure-stdlib/strutil v0.1.2/go.mod h1:Gou2R9+il93BqX25LAKCLuM+y9U2T4hlwvT1yprcna4= +github.com/hashicorp/go-sockaddr v1.0.2 h1:ztczhD1jLxIRjVejw8gFomI1BQZOe2WoVOu0SyteCQc= +github.com/hashicorp/go-sockaddr v1.0.2/go.mod h1:rB4wwRAUzs07qva3c5SdrY/NEtAUjGlgmH/UkBUC97A= github.com/hashicorp/go-version v1.3.0 h1:McDWVJIU/y+u1BRV06dPaLfLCaT7fUTJLp5r04x7iNw= github.com/hashicorp/go-version v1.3.0/go.mod h1:fltr4n8CU8Ke44wwGCBoEymUuxUHl09ZGVZPK5anwXA= -github.com/henvic/httpretty v0.1.2 h1:EQo556sO0xeXAjP10eB+BZARMuvkdGqtfeS4Ntjvkiw= -github.com/henvic/httpretty v0.1.2/go.mod h1:ViEsly7wgdugYtymX54pYp6Vv2wqZmNHayJ6q8tlKCc= +github.com/hashicorp/hcl v1.0.0 h1:0Anlzjpi4vEasTeNFn2mLJgTSwt0+6sfsiTG8qcWGx4= +github.com/hashicorp/hcl v1.0.0/go.mod h1:E5yfLk+7swimpb2L/Alb/PJmXilQ/rhwaUYs4T20WEQ= +github.com/hashicorp/vault/api v1.12.2 h1:7YkCTE5Ni90TcmYHDBExdt4WGJxhpzaHqR6uGbQb/rE= +github.com/hashicorp/vault/api v1.12.2/go.mod h1:LSGf1NGT1BnvFFnKVtnvcaLBM2Lz+gJdpL6HUYed8KE= +github.com/henvic/httpretty v0.1.3 h1:4A6vigjz6Q/+yAfTD4wqipCv+Px69C7Th/NhT0ApuU8= +github.com/henvic/httpretty v0.1.3/go.mod h1:UUEv7c2kHZ5SPQ51uS3wBpzPDibg2U3Y+IaXyHy5GBg= +github.com/hexops/gotextdiff v1.0.3 h1:gitA9+qJrrTCsiCl7+kh75nPqQt1cx4ZkudSTLoUqJM= +github.com/hexops/gotextdiff v1.0.3/go.mod h1:pSWU5MAI3yDq+fZBTazCSJysOMbxWL1BSow5/V2vxeg= github.com/hinshun/vt10x v0.0.0-20220119200601-820417d04eec h1:qv2VnGeEQHchGaZ/u7lxST/RaJw+cv273q79D81Xbog= github.com/hinshun/vt10x v0.0.0-20220119200601-820417d04eec/go.mod h1:Q48J4R4DvxnHolD5P8pOtXigYlRuPLGl6moFx3ulM68= -github.com/inconshreveable/mousetrap v1.0.1 h1:U3uMjPSQEBMNp1lFxmllqCPM6P5u/Xq7Pgzkat/bFNc= -github.com/inconshreveable/mousetrap v1.0.1/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw= -github.com/itchyny/gojq v0.12.13 h1:IxyYlHYIlspQHHTE0f3cJF0NKDMfajxViuhBLnHd/QU= -github.com/itchyny/gojq v0.12.13/go.mod h1:JzwzAqenfhrPUuwbmEz3nu3JQmFLlQTQMUcOdnu/Sf4= +github.com/howeyc/gopass v0.0.0-20210920133722-c8aef6fb66ef h1:A9HsByNhogrvm9cWb28sjiS3i7tcKCkflWFEkHfuAgM= +github.com/howeyc/gopass v0.0.0-20210920133722-c8aef6fb66ef/go.mod h1:lADxMC39cJJqL93Duh1xhAs4I2Zs8mKS89XWXFGp9cs= +github.com/in-toto/in-toto-golang v0.9.0 h1:tHny7ac4KgtsfrG6ybU8gVOZux2H8jN05AXJ9EBM1XU= +github.com/in-toto/in-toto-golang v0.9.0/go.mod h1:xsBVrVsHNsB61++S6Dy2vWosKhuA3lUTQd+eF9HdeMo= +github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8= +github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw= +github.com/itchyny/gojq v0.12.15 h1:WC1Nxbx4Ifw5U2oQWACYz32JK8G9qxNtHzrvW4KEcqI= +github.com/itchyny/gojq v0.12.15/go.mod h1:uWAHCbCIla1jiNxmeT5/B5mOjSdfkCq6p8vxWg+BM10= github.com/itchyny/timefmt-go v0.1.5 h1:G0INE2la8S6ru/ZI5JecgyzbbJNs5lG1RcBqa7Jm6GE= github.com/itchyny/timefmt-go v0.1.5/go.mod h1:nEP7L+2YmAbT2kZ2HfSs1d8Xtw9LY8D2stDBckWakZ8= +github.com/jedisct1/go-minisign v0.0.0-20211028175153-1c139d1cc84b h1:ZGiXF8sz7PDk6RgkP+A/SFfUD0ZR/AgG6SpRNEDKZy8= +github.com/jedisct1/go-minisign v0.0.0-20211028175153-1c139d1cc84b/go.mod h1:hQmNrgofl+IY/8L+n20H6E6PWBBTokdsv+q49j0QhsU= +github.com/jellydator/ttlcache/v3 v3.2.0 h1:6lqVJ8X3ZaUwvzENqPAobDsXNExfUJd61u++uW8a3LE= +github.com/jellydator/ttlcache/v3 v3.2.0/go.mod h1:hi7MGFdMAwZna5n2tuvh63DvFLzVKySzCVW6+0gA2n4= +github.com/jmespath/go-jmespath v0.4.0 h1:BEgLn5cpjn8UN1mAw4NjwDrS35OdebyEtFe+9YPoQUg= +github.com/jmespath/go-jmespath v0.4.0/go.mod h1:T8mJZnbsbmF+m6zOOFylbeCJqk5+pHWvzYPziyZiYoo= +github.com/jmhodges/clock v1.2.0 h1:eq4kys+NI0PLngzaHEe7AmPT90XMGIEySD1JfV1PDIs= +github.com/jmhodges/clock v1.2.0/go.mod h1:qKjhA7x7u/lQpPB1XAqX1b1lCI/w3/fNuYpI/ZjLynI= github.com/joho/godotenv v1.5.1 h1:7eLL/+HRGLY0ldzfGMeQkb7vMd0as4CfYvUVzLqw0N0= github.com/joho/godotenv v1.5.1/go.mod h1:f4LDr5Voq0i2e/R5DDNOoa2zzDfwtkZa6DnEwAbqwq4= +github.com/josharian/intern v1.0.0 h1:vlS4z54oSdjm0bgjRigI+G1HpF+tI+9rE5LLzOg8HmY= +github.com/josharian/intern v1.0.0/go.mod h1:5DoeVV0s6jJacbCEi61lwdGj/aVlrQvzHFFd8Hwg//Y= github.com/kballard/go-shellquote v0.0.0-20180428030007-95032a82bc51 h1:Z9n2FFNUXsshfwJMBgNA0RU6/i7WVaAegv3PtuIHPMs= github.com/kballard/go-shellquote v0.0.0-20180428030007-95032a82bc51/go.mod h1:CzGEWj7cYgsdH8dAjBGEr58BoE7ScuLd+fwFZ44+/x8= -github.com/kr/pretty v0.1.0 h1:L/CwN0zerZDmRFUapSPitk6f+Q3+0za1rQkzVuMiMFI= -github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo= +github.com/klauspost/compress v1.17.4 h1:Ej5ixsIri7BrIjBkRZLTo6ghwrEtHFk7ijlczPW4fZ4= +github.com/klauspost/compress v1.17.4/go.mod h1:/dCuZOvVtNoHsyb+cuJD3itjs3NbnF6KH9zAO4BDxPM= +github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE= +github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk= github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY= github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE= +github.com/kylelemons/godebug v1.1.0 h1:RPNrshWIDI6G2gRW9EHilWtl7Z6Sb1BR0xunSBf0SNc= +github.com/kylelemons/godebug v1.1.0/go.mod h1:9/0rRGxNHcop5bhtWyNeEfOS8JIWk580+fNqagV/RAw= +github.com/letsencrypt/boulder v0.0.0-20230907030200-6d76a0f91e1e h1:RLTpX495BXToqxpM90Ws4hXEo4Wfh81jr9DX1n/4WOo= +github.com/letsencrypt/boulder v0.0.0-20230907030200-6d76a0f91e1e/go.mod h1:EAuqr9VFWxBi9nD5jc/EA2MT1RFty9288TF6zdtYoCU= github.com/lucasb-eyer/go-colorful v1.2.0 h1:1nnpGOrhyZZuNyfu1QjKiUICQ74+3FNCN69Aj6K7nkY= github.com/lucasb-eyer/go-colorful v1.2.0/go.mod h1:R4dSotOR9KMtayYi1e77YzuveK+i7ruzyGqttikkLy0= +github.com/magiconair/properties v1.8.7 h1:IeQXZAiQcpL9mgcAe1Nu6cX9LLw6ExEHKjN0VQdvPDY= +github.com/magiconair/properties v1.8.7/go.mod h1:Dhd985XPs7jluiymwWYZ0G4Z61jb3vdS329zhj2hYo0= +github.com/mailru/easyjson v0.7.7 h1:UGYAvKxe3sBsEDzO8ZeWOSlIQfWFlxbzLZe7hwFURr0= +github.com/mailru/easyjson v0.7.7/go.mod h1:xzfreul335JAWq5oZzymOObrkdz5UnU4kGfJJLY9Nlc= github.com/mattn/go-colorable v0.1.2/go.mod h1:U0ppj6V5qS13XJ6of8GYAs25YV2eR4EVcfRqFIhoBtE= github.com/mattn/go-colorable v0.1.13 h1:fFA4WZxdEF4tXPZVKMLwD8oUnCTTo08duU7wxecdEvA= github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovkB8vQcUbaXHg= github.com/mattn/go-isatty v0.0.8/go.mod h1:Iq45c/XA43vh69/j3iqttzPXn0bhXyGjM0Hdxcsrc5s= -github.com/mattn/go-isatty v0.0.14/go.mod h1:7GGIvUiUoEMVVmxf/4nioHXj79iQHKdU27kJ6hsGG94= github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM= -github.com/mattn/go-isatty v0.0.19 h1:JITubQf0MOLdlGRuRq+jtsDlekdYPia9ZFsB8h/APPA= -github.com/mattn/go-isatty v0.0.19/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= +github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY= +github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= github.com/mattn/go-runewidth v0.0.9/go.mod h1:H031xJmbD/WCDINGzjvQ9THkh0rPKHF+m2gUSrubnMI= -github.com/mattn/go-runewidth v0.0.10/go.mod h1:RAqKPSqVFrSLVXbA8x7dzmKdmGzieGRCM46jaSJTDAk= github.com/mattn/go-runewidth v0.0.12/go.mod h1:RAqKPSqVFrSLVXbA8x7dzmKdmGzieGRCM46jaSJTDAk= -github.com/mattn/go-runewidth v0.0.13/go.mod h1:Jdepj2loyihRzMpdS35Xk/zdY8IAYHsh153qUoGf23w= -github.com/mattn/go-runewidth v0.0.14 h1:+xnbZSEeDbOIg5/mE6JF0w6n9duR1l3/WmbinWVwUuU= github.com/mattn/go-runewidth v0.0.14/go.mod h1:Jdepj2loyihRzMpdS35Xk/zdY8IAYHsh153qUoGf23w= +github.com/mattn/go-runewidth v0.0.15 h1:UNAjwbU9l54TA3KzvqLGxwWjHmMgBUVhBiTjelZgg3U= +github.com/mattn/go-runewidth v0.0.15/go.mod h1:Jdepj2loyihRzMpdS35Xk/zdY8IAYHsh153qUoGf23w= github.com/mgutz/ansi v0.0.0-20170206155736-9520e82c474b/go.mod h1:01TrycV0kFyexm33Z7vhZRXopbI8J3TDReVlkTgMUxE= github.com/mgutz/ansi v0.0.0-20200706080929-d51e80ef957d h1:5PJl274Y63IEHC+7izoQE9x6ikvDFZS2mDVS3drnohI= github.com/mgutz/ansi v0.0.0-20200706080929-d51e80ef957d/go.mod h1:01TrycV0kFyexm33Z7vhZRXopbI8J3TDReVlkTgMUxE= -github.com/microcosm-cc/bluemonday v1.0.21 h1:dNH3e4PSyE4vNX+KlRGHT5KrSvjeUkoNPwEORjffHJg= -github.com/microcosm-cc/bluemonday v1.0.21/go.mod h1:ytNkv4RrDrLJ2pqlsSI46O6IVXmZOBBD4SaJyDwwTkM= -github.com/muesli/reflow v0.2.1-0.20210115123740-9e1d0d53df68/go.mod h1:Xk+z4oIWdQqJzsxyjgl3P22oYZnHdZ8FFTHAQQt5BMQ= +github.com/microcosm-cc/bluemonday v1.0.26 h1:xbqSvqzQMeEHCqMi64VAs4d8uy6Mequs3rQ0k/Khz58= +github.com/microcosm-cc/bluemonday v1.0.26/go.mod h1:JyzOCs9gkyQyjs+6h10UEVSe02CGwkhd72Xdqh78TWs= +github.com/microsoft/dev-tunnels v0.0.25 h1:UlMKUI+2O8cSu4RlB52ioSyn1LthYSVkJA+CSTsdKoA= +github.com/microsoft/dev-tunnels v0.0.25/go.mod h1:frU++12T/oqxckXkDpTuYa427ncguEOodSPZcGCCrzQ= +github.com/mitchellh/go-homedir v1.1.0 h1:lukF9ziXFxDFPkA1vsr5zpc1XuPDn/wFntq5mG+4E0Y= +github.com/mitchellh/go-homedir v1.1.0/go.mod h1:SfyaCUpYCn1Vlf4IUYiD9fPX4A5wJrkLzIz1N1q0pr0= +github.com/mitchellh/mapstructure v1.5.0 h1:jeMsZIYE/09sWLaz43PL7Gy6RuMjD2eJVyuac5Z2hdY= +github.com/mitchellh/mapstructure v1.5.0/go.mod h1:bFUtVrKA4DC2yAKiSyO/QUcy7e+RRV2QTWOzhPopBRo= github.com/muesli/reflow v0.3.0 h1:IFsN6K9NfGtjeggFP+68I4chLZV2yIKsXJFNZ+eWh6s= github.com/muesli/reflow v0.3.0/go.mod h1:pbwTDkVPibjO2kyvBQRBxTWEEGDGq0FlB1BIKtnHY/8= -github.com/muesli/termenv v0.11.1-0.20220204035834-5ac8409525e0/go.mod h1:Bd5NYQ7pd+SrtBSrSNoBBmXlcY8+Xj4BMJgh8qcZrvs= -github.com/muesli/termenv v0.13.0 h1:wK20DRpJdDX8b7Ek2QfhvqhRQFZ237RGRO0RQ/Iqdy0= -github.com/muesli/termenv v0.13.0/go.mod h1:sP1+uffeLaEYpyOTb8pLCUctGcGLnoFjSn4YJK5e2bc= +github.com/muesli/termenv v0.15.2 h1:GohcuySI0QmI3wN8Ok9PtKGkgkFIk7y6Vpb5PvrY+Wo= +github.com/muesli/termenv v0.15.2/go.mod h1:Epx+iuz8sNs7mNKhxzH4fWXGNpZwUaJKRS1noLXviQ8= github.com/muhammadmuzzammil1998/jsonc v0.0.0-20201229145248-615b0916ca38 h1:0FrBxrkJ0hVembTb/e4EU5Ml6vLcOusAqymmYISg5Uo= github.com/muhammadmuzzammil1998/jsonc v0.0.0-20201229145248-615b0916ca38/go.mod h1:saF2fIVw4banK0H4+/EuqfFLpRnoy5S+ECwTOCcRcSU= github.com/nbio/st v0.0.0-20140626010706-e9e8d9816f32 h1:W6apQkHrMkS0Muv8G/TipAy/FJl/rCYT0+EuS8+Z0z4= github.com/nbio/st v0.0.0-20140626010706-e9e8d9816f32/go.mod h1:9wM+0iRr9ahx58uYLpLIr5fm8diHn0JbqRycJi6w0Ms= +github.com/oklog/ulid v1.3.1 h1:EGfNDEx6MqHz8B3uNV6QAib1UR2Lm97sHi3ocA6ESJ4= +github.com/oklog/ulid v1.3.1/go.mod h1:CirwcVhetQ6Lv90oh/F+FBtV6XMibvdAFo93nm5qn4U= github.com/olekukonko/tablewriter v0.0.5 h1:P2Ga83D34wi1o9J6Wh1mRuqd4mF/x/lgBS7N7AbDhec= github.com/olekukonko/tablewriter v0.0.5/go.mod h1:hPp6KlRPjbx+hW8ykQs1w3UBbZlj6HuIJcUGPhkA7kY= -github.com/opentracing/opentracing-go v1.1.0 h1:pWlfV3Bxv7k65HYwkikxat0+s3pV4bsqf19k25Ur8rU= -github.com/opentracing/opentracing-go v1.1.0/go.mod h1:UkNAQd3GIcIGf0SeVgPpRdFStlNbqXla1AfSYxPUl2o= -github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/opencontainers/go-digest v1.0.0 h1:apOUWs51W5PlhuyGyz9FCeeBIOUDA/6nW8Oi/yOhh5U= +github.com/opencontainers/go-digest v1.0.0/go.mod h1:0JzlMkj0TRzQZfJkVvzbP0HBR3IKzErnv2BNG4W4MAM= +github.com/opencontainers/image-spec v1.1.0-rc5 h1:Ygwkfw9bpDvs+c9E34SdgGOj41dX/cbdlwvlWt0pnFI= +github.com/opencontainers/image-spec v1.1.0-rc5/go.mod h1:X4pATf0uXsnn3g5aiGIsVnJBR4mxhKzfwmvK/B2NTm8= +github.com/opentracing/opentracing-go v1.2.0 h1:uEJPy/1a5RIPAJ0Ov+OIO8OxWu77jEv+1B0VhjKrZUs= +github.com/opentracing/opentracing-go v1.2.0/go.mod h1:GxEUsuufX4nBwe+T+Wl9TAgYrxe9dPLANfrWvHYVTgc= +github.com/pelletier/go-toml/v2 v2.1.0 h1:FnwAJ4oYMvbT/34k9zzHuZNrhlz48GB3/s6at6/MHO4= +github.com/pelletier/go-toml/v2 v2.1.0/go.mod h1:tJU2Z3ZkXwnxa4DPO899bsyIoywizdUvyaeZurnPPDc= +github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c h1:+mdjkGKdHQG3305AYmdv1U2eRNDiU2ErMBj1gwrq8eQ= +github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c/go.mod h1:7rwL4CYBLnjLxUqIJNnCWiEdr3bn6IUYi15bNlnbCCU= +github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4= +github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 h1:Jamvg5psRIccs7FGNTlIRMkT8wgtp5eCXdBlqhYGL6U= +github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/prometheus/client_golang v1.19.0 h1:ygXvpU1AoN1MhdzckN+PyD9QJOSD4x7kmXYlnfbA6JU= +github.com/prometheus/client_golang v1.19.0/go.mod h1:ZRM9uEAypZakd+q/x7+gmsvXdURP+DABIEIjnmDdp+k= +github.com/prometheus/client_model v0.5.0 h1:VQw1hfvPvk3Uv6Qf29VrPF32JB6rtbgI6cYPYQjL0Qw= +github.com/prometheus/client_model v0.5.0/go.mod h1:dTiFglRmd66nLR9Pv9f0mZi7B7fk5Pm3gvsjB5tr+kI= +github.com/prometheus/common v0.48.0 h1:QO8U2CdOzSn1BBsmXJXduaaW+dY/5QLjfB8svtSzKKE= +github.com/prometheus/common v0.48.0/go.mod h1:0/KsvlIEfPQCQ5I2iNSAWKPZziNCvRs5EC6ILDTlAPc= +github.com/prometheus/procfs v0.12.0 h1:jluTpSng7V9hY0O2R9DzzJHYb2xULk9VTR1V1R/k6Bo= +github.com/prometheus/procfs v0.12.0/go.mod h1:pcuDEFsWDnvcgNzo4EEweacyhjeA9Zk3cnaOZAZEfOo= github.com/rivo/tview v0.0.0-20221029100920-c4a7e501810d h1:jKIUJdMcIVGOSHi6LSqJqw9RqblyblE2ZrHvFbWR3S0= github.com/rivo/tview v0.0.0-20221029100920-c4a7e501810d/go.mod h1:YX2wUZOcJGOIycErz2s9KvDaP0jnWwRCirQMPLPpQ+Y= github.com/rivo/uniseg v0.1.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc= github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc= -github.com/rivo/uniseg v0.4.4 h1:8TfxU8dW6PdqD27gjM8MVNuicgxIjxpm4K7x4jp8sis= -github.com/rivo/uniseg v0.4.4/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88= +github.com/rivo/uniseg v0.4.7 h1:WUdvkW8uEhrYfLC4ZzdpI2ztxP1I582+49Oc5Mq64VQ= +github.com/rivo/uniseg v0.4.7/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88= +github.com/rodaine/table v1.0.1 h1:U/VwCnUxlVYxw8+NJiLIuCxA/xa6jL38MY3FYysVWWQ= +github.com/rodaine/table v1.0.1/go.mod h1:UVEtfBsflpeEcD56nF4F5AocNFta0ZuolpSVdPtlmP4= +github.com/rogpeppe/go-internal v1.11.0 h1:cWPaGQEPrBb5/AsnsZesgZZ9yb1OQ+GOISoDNXVBh4M= +github.com/rogpeppe/go-internal v1.11.0/go.mod h1:ddIwULY96R17DhadqLgMfk9H9tvdUzkipdSkR5nkCZA= github.com/russross/blackfriday/v2 v2.1.0 h1:JIOH55/0cWyOuilr9/qlrm0BSXldqnqwMsf35Ld67mk= github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= +github.com/ryanuber/go-glob v1.0.0 h1:iQh3xXAumdQ+4Ufa5b25cRpC5TYKlno6hsv6Cb3pkBk= +github.com/ryanuber/go-glob v1.0.0/go.mod h1:807d1WSdnB0XRJzKNil9Om6lcp/3a0v4qIHxIXzX/Yc= +github.com/sagikazarmark/locafero v0.4.0 h1:HApY1R9zGo4DBgr7dqsTH/JJxLTTsOt7u6keLGt6kNQ= +github.com/sagikazarmark/locafero v0.4.0/go.mod h1:Pe1W6UlPYUk/+wc/6KFhbORCfqzgYEpgQ3O5fPuL3H4= +github.com/sagikazarmark/slog-shim v0.1.0 h1:diDBnUNK9N/354PgrxMywXnAwEr1QZcOr6gto+ugjYE= +github.com/sagikazarmark/slog-shim v0.1.0/go.mod h1:SrcSrq8aKtyuqEI1uvTDTK1arOWRIczQRv+GVI1AkeQ= +github.com/sassoftware/relic v7.2.1+incompatible h1:Pwyh1F3I0r4clFJXkSI8bOyJINGqpgjJU3DYAZeI05A= +github.com/sassoftware/relic v7.2.1+incompatible/go.mod h1:CWfAxv73/iLZ17rbyhIEq3K9hs5w6FpNMdUT//qR+zk= +github.com/sassoftware/relic/v7 v7.6.2 h1:rS44Lbv9G9eXsukknS4mSjIAuuX+lMq/FnStgmZlUv4= +github.com/sassoftware/relic/v7 v7.6.2/go.mod h1:kjmP0IBVkJZ6gXeAu35/KCEfca//+PKM6vTAsyDPY+k= +github.com/secure-systems-lab/go-securesystemslib v0.8.0 h1:mr5An6X45Kb2nddcFlbmfHkLguCE9laoZCUzEEpIZXA= +github.com/secure-systems-lab/go-securesystemslib v0.8.0/go.mod h1:UH2VZVuJfCYR8WgMlCU1uFsOUU+KeyrTWcSS73NBOzU= +github.com/sergi/go-diff v1.3.1 h1:xkr+Oxo4BOQKmkn/B9eMK0g5Kg/983T9DqqPHwYqD+8= +github.com/sergi/go-diff v1.3.1/go.mod h1:aMJSSKb2lpPvRNec0+w3fl7LP9IOFzdc9Pa4NFbPK1I= +github.com/shibumi/go-pathspec v1.3.0 h1:QUyMZhFo0Md5B8zV8x2tesohbb5kfbpTi9rBnKh5dkI= +github.com/shibumi/go-pathspec v1.3.0/go.mod h1:Xutfslp817l2I1cZvgcfeMQJG5QnU2lh5tVaaMCl3jE= github.com/shurcooL/githubv4 v0.0.0-20230704064427-599ae7bbf278 h1:kdEGVAV4sO46DPtb8k793jiecUEhaX9ixoIBt41HEGU= github.com/shurcooL/githubv4 v0.0.0-20230704064427-599ae7bbf278/go.mod h1:zqMwyHmnN/eDOZOdiTohqIUKUrTFX62PNlu7IJdu0q8= github.com/shurcooL/graphql v0.0.0-20230722043721-ed46e5a46466 h1:17JxqqJY66GmZVHkmAsGEkcIu0oCe3AM420QDgGwZx0= github.com/shurcooL/graphql v0.0.0-20230722043721-ed46e5a46466/go.mod h1:9dIRpgIY7hVhoqfe0/FcYp0bpInZaT7dc3BYOprrIUE= -github.com/sourcegraph/jsonrpc2 v0.1.0 h1:ohJHjZ+PcaLxDUjqk2NC3tIGsVa5bXThe1ZheSXOjuk= -github.com/sourcegraph/jsonrpc2 v0.1.0/go.mod h1:ZafdZgk/axhT1cvZAPOhw+95nz2I/Ra5qMlU4gTRwIo= -github.com/spf13/cobra v1.6.1 h1:o94oiPyS4KD1mPy2fmcYYHHfCxLqYjJOhGsCHFZtEzA= -github.com/spf13/cobra v1.6.1/go.mod h1:IOw/AERYS7UzyrGinqmz6HLUo219MORXGxhbaJUqzrY= +github.com/sigstore/protobuf-specs v0.3.2 h1:nCVARCN+fHjlNCk3ThNXwrZRqIommIeNKWwQvORuRQo= +github.com/sigstore/protobuf-specs v0.3.2/go.mod h1:RZ0uOdJR4OB3tLQeAyWoJFbNCBFrPQdcokntde4zRBA= +github.com/sigstore/rekor v1.3.6 h1:QvpMMJVWAp69a3CHzdrLelqEqpTM3ByQRt5B5Kspbi8= +github.com/sigstore/rekor v1.3.6/go.mod h1:JDTSNNMdQ/PxdsS49DJkJ+pRJCO/83nbR5p3aZQteXc= +github.com/sigstore/sigstore v1.8.3 h1:G7LVXqL+ekgYtYdksBks9B38dPoIsbscjQJX/MGWkA4= +github.com/sigstore/sigstore v1.8.3/go.mod h1:mqbTEariiGA94cn6G3xnDiV6BD8eSLdL/eA7bvJ0fVs= +github.com/sigstore/sigstore-go v0.3.0 h1:SxYqfonBrEhw8bNDelMieymxhdv7R9itiNZmtjOwKKU= +github.com/sigstore/sigstore-go v0.3.0/go.mod h1:oJOH7UP8aTjAGnIVwq9sDif8M4CSCik84yN1vBuESbE= +github.com/sigstore/sigstore/pkg/signature/kms/aws v1.8.3 h1:LTfPadUAo+PDRUbbdqbeSl2OuoFQwUFTnJ4stu+nwWw= +github.com/sigstore/sigstore/pkg/signature/kms/aws v1.8.3/go.mod h1:QV/Lxlxm0POyhfyBtIbTWxNeF18clMlkkyL9mu45y18= +github.com/sigstore/sigstore/pkg/signature/kms/azure v1.8.3 h1:xgbPRCr2npmmsuVVteJqi/ERw9+I13Wou7kq0Yk4D8g= +github.com/sigstore/sigstore/pkg/signature/kms/azure v1.8.3/go.mod h1:G4+I83FILPX6MtnoaUdmv/bRGEVtR3JdLeJa/kXdk/0= +github.com/sigstore/sigstore/pkg/signature/kms/gcp v1.8.3 h1:vDl2fqPT0h3D/k6NZPlqnKFd1tz3335wm39qjvpZNJc= +github.com/sigstore/sigstore/pkg/signature/kms/gcp v1.8.3/go.mod h1:9uOJXbXEXj+M6QjMKH5PaL5WDMu43rHfbIMgXzA8eKI= +github.com/sigstore/sigstore/pkg/signature/kms/hashivault v1.8.3 h1:h9G8j+Ds21zqqulDbA/R/ft64oQQIyp8S7wJYABYSlg= +github.com/sigstore/sigstore/pkg/signature/kms/hashivault v1.8.3/go.mod h1:zgCeHOuqF6k7A7TTEvftcA9V3FRzB7mrPtHOhXAQBnc= +github.com/sigstore/timestamp-authority v1.2.2 h1:X4qyutnCQqJ0apMewFyx+3t7Tws00JQ/JonBiu3QvLE= +github.com/sigstore/timestamp-authority v1.2.2/go.mod h1:nEah4Eq4wpliDjlY342rXclGSO7Kb9hoRrl9tqLW13A= +github.com/sirupsen/logrus v1.9.0/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ= +github.com/sirupsen/logrus v1.9.3 h1:dueUQJ1C2q9oE3F7wvmSGAaVtTmUizReu6fjN8uqzbQ= +github.com/sirupsen/logrus v1.9.3/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ= +github.com/sourcegraph/conc v0.3.0 h1:OQTbbt6P72L20UqAkXXuLOj79LfEanQ+YQFNpLA9ySo= +github.com/sourcegraph/conc v0.3.0/go.mod h1:Sdozi7LEKbFPqYX2/J+iBAM6HpqSLTASQIKqDmF7Mt0= +github.com/spf13/afero v1.11.0 h1:WJQKhtpdm3v2IzqG8VMqrr6Rf3UYpEF239Jy9wNepM8= +github.com/spf13/afero v1.11.0/go.mod h1:GH9Y3pIexgf1MTIWtNGyogA5MwRIDXGUr+hbWNoBjkY= +github.com/spf13/cast v1.6.0 h1:GEiTHELF+vaR5dhz3VqZfFSzZjYbgeKDpBxQVS4GYJ0= +github.com/spf13/cast v1.6.0/go.mod h1:ancEpBxwJDODSW/UG4rDrAqiKolqNNh2DX3mk86cAdo= +github.com/spf13/cobra v1.8.0 h1:7aJaZx1B85qltLMc546zn58BxxfZdR/W22ej9CFoEf0= +github.com/spf13/cobra v1.8.0/go.mod h1:WXLWApfZ71AjXPya3WOlMsY9yMs7YeiHhFVlvLyhcho= github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA= github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg= +github.com/spf13/viper v1.18.2 h1:LUXCnvUvSM6FXAsj6nnfc8Q2tp1dIgUfY9Kc8GsSOiQ= +github.com/spf13/viper v1.18.2/go.mod h1:EKmWIqdnk5lOcmR72yw6hS+8OPYcwD0jteitLMVB+yk= github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw= -github.com/stretchr/objx v0.5.0 h1:1zr/of2m5FGMsad5YfcqgdqdWrIhu+EBEJRhR1U7z/c= github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo= +github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY= +github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= +github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= +github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU= -github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk= +github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4= github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo= +github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg= +github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= +github.com/subosito/gotenv v1.6.0 h1:9NlTDc1FTs4qu0DDq7AEtTPNw6SVm7uBMsUCUjABIf8= +github.com/subosito/gotenv v1.6.0/go.mod h1:Dk4QP5c2W3ibzajGcXpNraDfq2IrhjMIvMSWPKKo0FU= +github.com/theupdateframework/go-tuf v0.7.0 h1:CqbQFrWo1ae3/I0UCblSbczevCCbS31Qvs5LdxRWqRI= +github.com/theupdateframework/go-tuf v0.7.0/go.mod h1:uEB7WSY+7ZIugK6R1hiBMBjQftaFzn7ZCDJcp1tCUug= +github.com/theupdateframework/go-tuf/v2 v2.0.0-20240223092044-1e7978e83f63 h1:27XWhDZHPD+cufF6qSdYx6PgGQvD2jJ6pq9sDvR6VBk= +github.com/theupdateframework/go-tuf/v2 v2.0.0-20240223092044-1e7978e83f63/go.mod h1:+gWwqe1pk4nvGeOKosGJqPgD+N/kbD9M0QVLL9TGIYU= github.com/thlib/go-timezone-local v0.0.0-20210907160436-ef149e42d28e h1:BuzhfgfWQbX0dWzYzT1zsORLnHRv3bcRcsaUk0VmXA8= github.com/thlib/go-timezone-local v0.0.0-20210907160436-ef149e42d28e/go.mod h1:/Tnicc6m/lsJE0irFMA0LfIwTBo4QP7A8IfyIv4zZKI= -github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74= -github.com/yuin/goldmark v1.4.1/go.mod h1:mwnBkeHKe2W/ZEtQ+71ViKU8L12m81fl3OWwC1Zlc8k= +github.com/titanous/rocacheck v0.0.0-20171023193734-afe73141d399 h1:e/5i7d4oYZ+C1wj2THlRK+oAhjeS/TRQwMfkIuet3w0= +github.com/titanous/rocacheck v0.0.0-20171023193734-afe73141d399/go.mod h1:LdwHTNJT99C5fTAzDz0ud328OgXz+gierycbcIx2fRs= +github.com/transparency-dev/merkle v0.0.2 h1:Q9nBoQcZcgPamMkGn7ghV8XiTZ/kRxn1yCG81+twTK4= +github.com/transparency-dev/merkle v0.0.2/go.mod h1:pqSy+OXefQ1EDUVmAJ8MUhHB9TXGuzVAT58PqBoHz1A= +github.com/urfave/cli v1.22.12/go.mod h1:sSBEIC79qR6OvcmsD4U3KABeOTxDqQtdDnaFuUN30b8= +github.com/vbatts/tar-split v0.11.3 h1:hLFqsOLQ1SsppQNTMpkpPXClLDfC2A3Zgy9OUU+RVck= +github.com/vbatts/tar-split v0.11.3/go.mod h1:9QlHN18E+fEH7RdG+QAJJcuya3rqT7eXSTY7wGrAokY= +github.com/yuin/goldmark v1.3.7/go.mod h1:mwnBkeHKe2W/ZEtQ+71ViKU8L12m81fl3OWwC1Zlc8k= github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY= -github.com/yuin/goldmark v1.5.2 h1:ALmeCk/px5FSm1MAcFBAsVKZjDuMVj8Tm7FFIlMJnqU= -github.com/yuin/goldmark v1.5.2/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY= -github.com/yuin/goldmark-emoji v1.0.1 h1:ctuWEyzGBwiucEqxzwe0SOYDXPAucOrE9NQC18Wa1os= -github.com/yuin/goldmark-emoji v1.0.1/go.mod h1:2w1E6FEWLcDQkoTE+7HU6QF1F6SLlNGjRIBbIZQFqkQ= -github.com/zalando/go-keyring v0.2.3 h1:v9CUu9phlABObO4LPWycf+zwMG7nlbb3t/B5wa97yms= -github.com/zalando/go-keyring v0.2.3/go.mod h1:HL4k+OXQfJUWaMnqyuSOc0drfGPX2b51Du6K+MRgZMk= -golang.org/x/mod v0.6.0-dev.0.20220106191415-9b9b3d81d5e3/go.mod h1:3p9vT2HGsQu2K1YbXdKPJLVgG5VJdoTa1poYQBtP1AY= +github.com/yuin/goldmark v1.5.4 h1:2uY/xC0roWy8IBEGLgB1ywIoEJFGmRrX21YQcvGZzjU= +github.com/yuin/goldmark v1.5.4/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY= +github.com/yuin/goldmark-emoji v1.0.2 h1:c/RgTShNgHTtc6xdz2KKI74jJr6rWi7FPgnP9GAsO5s= +github.com/yuin/goldmark-emoji v1.0.2/go.mod h1:RhP/RWpexdp+KHs7ghKnifRoIs/Bq4nDS7tRbCkOwKY= +github.com/zalando/go-keyring v0.2.4 h1:wi2xxTqdiwMKbM6TWwi+uJCG/Tum2UV0jqaQhCa9/68= +github.com/zalando/go-keyring v0.2.4/go.mod h1:HL4k+OXQfJUWaMnqyuSOc0drfGPX2b51Du6K+MRgZMk= +go.mongodb.org/mongo-driver v1.14.0 h1:P98w8egYRjYe3XDjxhYJagTokP/H6HzlsnojRgZRd80= +go.mongodb.org/mongo-driver v1.14.0/go.mod h1:Vzb0Mk/pa7e6cWw85R4F/endUC3u0U9jGcNU603k65c= +go.opencensus.io v0.24.0 h1:y73uSU6J157QMP2kn2r30vwW1A2W2WFwSCGnAVxeaD0= +go.opencensus.io v0.24.0/go.mod h1:vNK8G9p7aAivkbmorf4v+7Hgx+Zs0yY+0fOtgBfjQKo= +go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.49.0 h1:4Pp6oUg3+e/6M4C0A/3kJ2VYa++dsWVTtGgLVj5xtHg= +go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.49.0/go.mod h1:Mjt1i1INqiaoZOMGR1RIUJN+i3ChKoFRqzrRQhlkbs0= +go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.49.0 h1:jq9TW8u3so/bN+JPT166wjOI6/vQPF6Xe7nMNIltagk= +go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.49.0/go.mod h1:p8pYQP+m5XfbZm9fxtSKAbM6oIllS7s2AfxrChvc7iw= +go.opentelemetry.io/otel v1.24.0 h1:0LAOdjNmQeSTzGBzduGe/rU4tZhMwL5rWgtp9Ku5Jfo= +go.opentelemetry.io/otel v1.24.0/go.mod h1:W7b9Ozg4nkF5tWI5zsXkaKKDjdVjpD4oAt9Qi/MArHo= +go.opentelemetry.io/otel/metric v1.24.0 h1:6EhoGWWK28x1fbpA4tYTOWBkPefTDQnb8WSGXlc88kI= +go.opentelemetry.io/otel/metric v1.24.0/go.mod h1:VYhLe1rFfxuTXLgj4CBiyz+9WYBA8pNGJgDcSFRKBco= +go.opentelemetry.io/otel/sdk v1.24.0 h1:YMPPDNymmQN3ZgczicBY3B6sf9n62Dlj9pWD3ucgoDw= +go.opentelemetry.io/otel/sdk v1.24.0/go.mod h1:KVrIYw6tEubO9E96HQpcmpTKDVn9gdv35HoYiQWGDFg= +go.opentelemetry.io/otel/trace v1.24.0 h1:CsKnnL4dUAr/0llH9FKuc698G04IrpWV0MQA/Y1YELI= +go.opentelemetry.io/otel/trace v1.24.0/go.mod h1:HPc3Xr/cOApsBI154IU0OI0HJexz+aw5uPdbs3UCjNU= +go.step.sm/crypto v0.44.2 h1:t3p3uQ7raP2jp2ha9P6xkQF85TJZh+87xmjSLaib+jk= +go.step.sm/crypto v0.44.2/go.mod h1:x1439EnFhadzhkuaGX7sz03LEMQ+jV4gRamf5LCZJQQ= +go.uber.org/goleak v1.3.0 h1:2K3zAYmnTNqV73imy9J1T3WC+gmCePx2hEGkimedGto= +go.uber.org/goleak v1.3.0/go.mod h1:CoHD4mav9JJNrW/WLlf7HGZPjdw8EucARQHekz1X6bE= +go.uber.org/multierr v1.11.0 h1:blXXJkSxSSfBVBlC76pxqeO+LN3aDfLQo+309xJstO0= +go.uber.org/multierr v1.11.0/go.mod h1:20+QtiLqy0Nd6FdQB9TLXag12DsQkrbs3htMFfDN80Y= +go.uber.org/zap v1.27.0 h1:aJMhYGrd5QSmlpLMr2MftRKl7t8J8PTZPA732ud/XR8= +go.uber.org/zap v1.27.0/go.mod h1:GB2qFLM7cTU87MWRP2mPIjqfIDnGu+VIO4V/SdhGo2E= +golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= +golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= +golang.org/x/crypto v0.22.0 h1:g1v0xeRhjcugydODzvb3mEM9SQ0HGp9s/nh3COQ/C30= +golang.org/x/crypto v0.22.0/go.mod h1:vr6Su+7cTlO45qkww3VDJlzDn0ctJvRgYbC2NvXHt+M= +golang.org/x/exp v0.0.0-20231006140011-7918f672742d h1:jtJma62tbqLibJ5sFQz8bKtEM8rJBtfilJ2qTU199MI= +golang.org/x/exp v0.0.0-20231006140011-7918f672742d/go.mod h1:ldy0pHrwJyGW56pPQzzkH36rKxoZW1tw7ZJpeKx+hdo= golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4= +golang.org/x/mod v0.17.0 h1:zY54UmvipHiNd+pm+m0x9KhZ9hl1/7QNMyxXbc6ICqA= +golang.org/x/mod v0.17.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c= golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= -golang.org/x/net v0.0.0-20211015210444-4f30a5c0130f/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c= -golang.org/x/net v0.0.0-20220923203811-8be639271d50/go.mod h1:YDH+HFinaLZZlnHAfSS6ZXJJ9M9t4Dl22yv3iI2vPwk= -golang.org/x/net v0.0.0-20221002022538-bcab6841153b/go.mod h1:YDH+HFinaLZZlnHAfSS6ZXJJ9M9t4Dl22yv3iI2vPwk= -golang.org/x/net v0.14.0 h1:BONx9s002vGdD9umnlX1Po8vOZmrgH34qlHcD1MfK14= -golang.org/x/net v0.14.0/go.mod h1:PpSgVXXLK0OxS0F31C1/tv6XNguvCrnXIDrFMspZIUI= -golang.org/x/oauth2 v0.4.0 h1:NF0gk8LVPg1Ml7SSbGyySuoxdsXitj7TvgvuRxIMc/M= -golang.org/x/oauth2 v0.4.0/go.mod h1:RznEsdpjGAINPTOF0UH/t+xJ75L18YO3Ho6Pyn+uRec= +golang.org/x/net v0.23.0 h1:7EYJ93RZ9vYSZAIb2x3lnuvqO5zneoD6IvWjuhfxjTs= +golang.org/x/net v0.23.0/go.mod h1:JKghWKKOSdJwpW2GEx0Ja7fmaKnMsbu+MWVZTokSYmg= +golang.org/x/oauth2 v0.18.0 h1:09qnuIAgzdx1XplqJvW6CQqMCtGZykZWcXzPMPUusvI= +golang.org/x/oauth2 v0.18.0/go.mod h1:Wf7knwG0MPoWIMMBgFlEaSUDaKskp0dCfrlJRJXbBi8= golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= -golang.org/x/sync v0.0.0-20210220032951-036812b2e83c/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= -golang.org/x/sync v0.1.0 h1:wsuoTGHzEhffawBOhz5CYhcrV4IdKZbEyZjBMuTp12o= -golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.6.0 h1:5BMeUDZ7vkXGfEr1x9B4bRcTH4lpkTkpdh0T/J+qjbQ= +golang.org/x/sync v0.6.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk= golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20190222072716-a9d3bda3a223/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= -golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.0.0-20210616045830-e2b7044e8c71/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20210831042530-f4d43177bf5e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.0.0-20211019181941-9d821ace8654/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.0.0-20220728004956-3c1f35247d10/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20220906165534-d0df966e6959/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.11.0 h1:eG7RXZHdqOJ1i+0lgLgCpSXAp6M3LYlAo6osgSi0xOM= -golang.org/x/sys v0.11.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.19.0 h1:q5f1RH2jigJ1MoAWp2KTp3gm5zAGFUTarQZ5U386+4o= +golang.org/x/sys v0.19.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= -golang.org/x/term v0.11.0 h1:F9tnn/DA/Im8nCwm+fX+1/eBwi4qFjRT++MhtVC4ZX0= -golang.org/x/term v0.11.0/go.mod h1:zC9APTIj3jG3FdV/Ons+XE1riIZXG4aZ4GTHiPZJPIU= +golang.org/x/term v0.19.0 h1:+ThwsDv+tYfnJFhF4L8jITxu1tdTWRTZpdsWgEgjL6Q= +golang.org/x/term v0.19.0/go.mod h1:2CuTdWZ7KHSQwUzKva0cbMg6q2DMI3Mmxp+gKJbskEk= golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= -golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ= golang.org/x/text v0.4.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= golang.org/x/text v0.5.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= -golang.org/x/text v0.12.0 h1:k+n5B8goJNdU7hSvEtMUz3d1Q6D/XW4COJSJR6fN0mc= -golang.org/x/text v0.12.0/go.mod h1:TvPlkZtksWOMsz7fbANvkp4WM8x/WCo/om8BMLbz+aE= +golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ= +golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU= +golang.org/x/time v0.5.0 h1:o7cqy6amK/52YcAKIPlM3a+Fpj35zvRj2TP+e1xFSfk= +golang.org/x/time v0.5.0/go.mod h1:3BpzKBy/shNhVucY/MWOyx10tF3SFh9QdLuxbVysPQM= golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= -golang.org/x/tools v0.1.10/go.mod h1:Uh6Zz+xoGYZom868N8YTex3t7RhtHDBrE8Gzo9bV56E= golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc= -golang.org/x/tools v0.6.0 h1:BOw41kyTf3PuCW1pVQf8+Cyg8pMlkYB1oo9iJ6D/lKM= -golang.org/x/tools v0.6.0/go.mod h1:Xwgl3UAJ/d3gWutnCtw505GrjyAbvKui8lOU390QaIU= +golang.org/x/tools v0.16.1 h1:TLyB3WofjdOEepBHAU20JdNC1Zbg87elYofWYAY5oZA= +golang.org/x/tools v0.16.1/go.mod h1:kYVVN6I1mBNoB1OX+noeBjbRk4IUEPa7JJ+TJMEooJ0= golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= -golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= -golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= -golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= -google.golang.org/appengine v1.6.7 h1:FZR1q0exgwxzPzp/aF+VccGrSfxfPpkBqjIIEq3ru6c= -google.golang.org/appengine v1.6.7/go.mod h1:8WjMMxjGQR8xUklV/ARdw2HLXBOI7O7uCIDZVag1xfc= -google.golang.org/genproto v0.0.0-20230110181048-76db0878b65f h1:BWUVssLB0HVOSY78gIdvk1dTVYtT1y8SBWtPYuTJ/6w= -google.golang.org/genproto v0.0.0-20230110181048-76db0878b65f/go.mod h1:RGgjbofJ8xD9Sq1VVhDM1Vok1vRONV+rg+CjzG4SZKM= -google.golang.org/grpc v1.53.0 h1:LAv2ds7cmFV/XTS3XG1NneeENYrXGmorPxsBbptIjNc= -google.golang.org/grpc v1.53.0/go.mod h1:OnIrk0ipVdj4N5d9IUoFUx72/VlD7+jUsHwZgwSMQpw= -google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw= -google.golang.org/protobuf v1.26.0/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc= -google.golang.org/protobuf v1.28.1 h1:d0NfwRgPtno5B1Wa6L2DAG+KivqkdutMf1UhdNx175w= -google.golang.org/protobuf v1.28.1/go.mod h1:HV8QOd/L58Z+nl8r43ehVNZIU/HEI6OcFqwMG9pJV4I= +google.golang.org/api v0.172.0 h1:/1OcMZGPmW1rX2LCu2CmGUD1KXK1+pfzxotxyRUCCdk= +google.golang.org/api v0.172.0/go.mod h1:+fJZq6QXWfa9pXhnIzsjx4yI22d4aI9ZpLb58gvXjis= +google.golang.org/appengine v1.6.8 h1:IhEN5q69dyKagZPYMSdIjS2HqprW324FRQZJcGqPAsM= +google.golang.org/appengine v1.6.8/go.mod h1:1jJ3jBArFh5pcgW8gCtRJnepW8FzD1V44FJffLiz/Ds= +google.golang.org/genproto v0.0.0-20240311173647-c811ad7063a7 h1:ImUcDPHjTrAqNhlOkSocDLfG9rrNHH7w7uoKWPaWZ8s= +google.golang.org/genproto v0.0.0-20240311173647-c811ad7063a7/go.mod h1:/3XmxOjePkvmKrHuBy4zNFw7IzxJXtAgdpXi8Ll990U= +google.golang.org/genproto/googleapis/api v0.0.0-20240311173647-c811ad7063a7 h1:oqta3O3AnlWbmIE3bFnWbu4bRxZjfbWCp0cKSuZh01E= +google.golang.org/genproto/googleapis/api v0.0.0-20240311173647-c811ad7063a7/go.mod h1:VQW3tUculP/D4B+xVCo+VgSq8As6wA9ZjHl//pmk+6s= +google.golang.org/genproto/googleapis/rpc v0.0.0-20240318140521-94a12d6c2237 h1:NnYq6UN9ReLM9/Y01KWNOWyI5xQ9kbIms5GGJVwS/Yc= +google.golang.org/genproto/googleapis/rpc v0.0.0-20240318140521-94a12d6c2237/go.mod h1:WtryC6hu0hhx87FDGxWCDptyssuo68sk10vYjF+T9fY= +google.golang.org/grpc v1.62.2 h1:iEIj1U5qjyBjzkM5nk3Fq+S1IbjbXSyqeULZ1Nfo4AA= +google.golang.org/grpc v1.62.2/go.mod h1:IWTG0VlJLCh1SkC58F7np9ka9mx/WNkjl4PGJaiq+QE= +google.golang.org/protobuf v1.34.1 h1:9ddQBjfCyZPOHPUiPxpYESBLc+T8P3E+Vo4IbKZgFWg= +google.golang.org/protobuf v1.34.1/go.mod h1:c6P6GXX6sHbq/GpV6MGZEdwhWPcYBgnhAHhKbcUYpos= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= -gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 h1:YR8cESwS4TdDjEe65xsg0ogRM/Nc3DYOhEAlW+xobZo= -gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk= +gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q= +gopkg.in/go-jose/go-jose.v2 v2.6.3 h1:nt80fvSDlhKWQgSWyHyy5CfmlQr+asih51R8PTWNKKs= +gopkg.in/go-jose/go-jose.v2 v2.6.3/go.mod h1:zzZDPkNNw/c9IE7Z9jr11mBZQhKQTMzoEEIoEdZlFBI= gopkg.in/h2non/gock.v1 v1.1.2 h1:jBbHXgGBK/AoPVfJh5x4r/WxIrElvbLel8TCZkkZJoY= gopkg.in/h2non/gock.v1 v1.1.2/go.mod h1:n7UGz/ckNChHiK05rDoiC4MYSunEC/lyaUm2WWaDva0= +gopkg.in/ini.v1 v1.67.0 h1:Dgnx+6+nfE+IfzjUEISNeydPJh9AXNNsWbGP9KzCsOA= +gopkg.in/ini.v1 v1.67.0/go.mod h1:pNLf8WUiyNEtQjuu5G5vTm06TEv9tsIgeAvK8hOrP4k= +gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ= gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= +gotest.tools/v3 v3.0.3 h1:4AuOwCGf4lLR9u3YOe2awrHygurzhO/HeQ6laiA6Sx0= +gotest.tools/v3 v3.0.3/go.mod h1:Z7Lb0S5l+klDB31fvDQX8ss/FlKDxtlFlw3Oa8Ymbl8= +k8s.io/klog/v2 v2.120.1 h1:QXU6cPEOIslTGvZaXvFWiP9VKyeet3sawzTOvdXb4Vw= +k8s.io/klog/v2 v2.120.1/go.mod h1:3Jpz1GvMt720eyJH1ckRHK1EDfpxISzJ7I9OYgaDtPE= +sigs.k8s.io/yaml v1.4.0 h1:Mk1wCc2gy/F0THH0TAp1QYyJNzRm2KCLy3o5ASXVI5E= +sigs.k8s.io/yaml v1.4.0/go.mod h1:Ejl7/uTz7PSA4eKMyQCUTnhZYNmLIl+5c2lQPGR2BPY= +software.sslmate.com/src/go-pkcs12 v0.4.0 h1:H2g08FrTvSFKUj+D309j1DPfk5APnIdAQAB8aEykJ5k= +software.sslmate.com/src/go-pkcs12 v0.4.0/go.mod h1:Qiz0EyvDRJjjxGyUQa2cCNZn/wMyzrRJ/qcDXOQazLI= diff --git a/internal/authflow/flow.go b/internal/authflow/flow.go index ddac948cd..370e08784 100644 --- a/internal/authflow/flow.go +++ b/internal/authflow/flow.go @@ -109,7 +109,7 @@ type cfg struct { token string } -func (c cfg) Token(hostname string) (string, string) { +func (c cfg) ActiveToken(hostname string) (string, string) { return c.token, "oauth_token" } diff --git a/internal/build/build.go b/internal/build/build.go index 267315ad2..3f0152b04 100644 --- a/internal/build/build.go +++ b/internal/build/build.go @@ -20,7 +20,7 @@ func init() { // Signal the tcell library to skip its expensive `init` block. This saves 30-40ms in startup // time for the gh process. The downside is that some Unicode glyphs from user-generated - // content might cause mis-alignment in tcell-enabled views. + // content might cause misalignment in tcell-enabled views. // // https://github.com/gdamore/tcell/commit/2f889d79bd61b1fd2f43372529975a65b792a7ae _ = os.Setenv("TCELL_MINIMIZE", "1") diff --git a/internal/codespaces/api/api.go b/internal/codespaces/api/api.go index d6b21c304..9e79eafe1 100644 --- a/internal/codespaces/api/api.go +++ b/internal/codespaces/api/api.go @@ -201,6 +201,7 @@ type Codespace struct { GitStatus CodespaceGitStatus `json:"git_status"` Connection CodespaceConnection `json:"connection"` Machine CodespaceMachine `json:"machine"` + RuntimeConstraints RuntimeConstraints `json:"runtime_constraints"` VSCSTarget string `json:"vscs_target"` PendingOperation bool `json:"pending_operation"` PendingOperationDisabledReason string `json:"pending_operation_disabled_reason"` @@ -246,11 +247,20 @@ const ( ) type CodespaceConnection struct { - SessionID string `json:"sessionId"` - SessionToken string `json:"sessionToken"` - RelayEndpoint string `json:"relayEndpoint"` - RelaySAS string `json:"relaySas"` - HostPublicKeys []string `json:"hostPublicKeys"` + TunnelProperties TunnelProperties `json:"tunnelProperties"` +} + +type TunnelProperties struct { + ConnectAccessToken string `json:"connectAccessToken"` + ManagePortsAccessToken string `json:"managePortsAccessToken"` + ServiceUri string `json:"serviceUri"` + TunnelId string `json:"tunnelId"` + ClusterId string `json:"clusterId"` + Domain string `json:"domain"` +} + +type RuntimeConstraints struct { + AllowedPortPrivacySettings []string `json:"allowed_port_privacy_settings"` } // ListCodespaceFields is the list of exportable fields for a codespace when using the `gh cs list` command. @@ -629,6 +639,45 @@ func (a *API) GetCodespacesMachines(ctx context.Context, repoID int, branch, loc return response.Machines, nil } +// GetCodespacesPermissionsCheck returns a bool indicating whether the user has accepted permissions for the given repo and devcontainer path. +func (a *API) GetCodespacesPermissionsCheck(ctx context.Context, repoID int, branch string, devcontainerPath string) (bool, error) { + reqURL := fmt.Sprintf("%s/repositories/%d/codespaces/permissions_check", a.githubAPI, repoID) + req, err := http.NewRequest(http.MethodGet, reqURL, nil) + if err != nil { + return false, fmt.Errorf("error creating request: %w", err) + } + + q := req.URL.Query() + q.Add("ref", branch) + q.Add("devcontainer_path", devcontainerPath) + req.URL.RawQuery = q.Encode() + + a.setHeaders(req) + resp, err := a.do(ctx, req, "/repositories/*/codespaces/permissions_check") + if err != nil { + return false, fmt.Errorf("error making request: %w", err) + } + defer resp.Body.Close() + + if resp.StatusCode != http.StatusOK { + return false, api.HandleHTTPError(resp) + } + + b, err := io.ReadAll(resp.Body) + if err != nil { + return false, fmt.Errorf("error reading response body: %w", err) + } + + var response struct { + Accepted bool `json:"accepted"` + } + if err := json.Unmarshal(b, &response); err != nil { + return false, fmt.Errorf("error unmarshalling response: %w", err) + } + + return response.Accepted, nil +} + // RepoSearchParameters are the optional parameters for searching for repositories. type RepoSearchParameters struct { // The maximum number of repos to return. At most 100 repos are returned even if this value is greater than 100. @@ -1162,3 +1211,13 @@ func (a *API) withRetry(f func() (*http.Response, error)) (*http.Response, error return nil, fmt.Errorf("received response with status code %d", resp.StatusCode) }, backoff.WithMaxRetries(bo, 3)) } + +// HTTPClient returns the HTTP client used to make requests to the API. +func (a *API) HTTPClient() (*http.Client, error) { + httpClient, err := a.client() + if err != nil { + return nil, err + } + + return httpClient, nil +} diff --git a/internal/codespaces/api/api_test.go b/internal/codespaces/api/api_test.go index 65852cc79..9d06dcdaf 100644 --- a/internal/codespaces/api/api_test.go +++ b/internal/codespaces/api/api_test.go @@ -12,6 +12,8 @@ import ( "testing" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" + ghmock "github.com/cli/cli/v2/internal/gh/mock" "github.com/cli/cli/v2/pkg/cmdutil" ) @@ -137,13 +139,13 @@ func createHttpClient() (*http.Client, error) { func TestNew_APIURL_dotcomConfig(t *testing.T) { t.Setenv("GITHUB_API_URL", "") t.Setenv("GITHUB_SERVER_URL", "https://github.com") - cfg := &config.ConfigMock{ - AuthenticationFunc: func() *config.AuthConfig { + cfg := &ghmock.ConfigMock{ + AuthenticationFunc: func() gh.AuthConfig { return &config.AuthConfig{} }, } f := &cmdutil.Factory{ - Config: func() (config.Config, error) { + Config: func() (gh.Config, error) { return cfg, nil }, } @@ -160,15 +162,15 @@ func TestNew_APIURL_dotcomConfig(t *testing.T) { func TestNew_APIURL_customConfig(t *testing.T) { t.Setenv("GITHUB_API_URL", "") t.Setenv("GITHUB_SERVER_URL", "https://github.mycompany.com") - cfg := &config.ConfigMock{ - AuthenticationFunc: func() *config.AuthConfig { + cfg := &ghmock.ConfigMock{ + AuthenticationFunc: func() gh.AuthConfig { authCfg := &config.AuthConfig{} authCfg.SetDefaultHost("github.mycompany.com", "GH_HOST") return authCfg }, } f := &cmdutil.Factory{ - Config: func() (config.Config, error) { + Config: func() (gh.Config, error) { return cfg, nil }, } @@ -185,13 +187,13 @@ func TestNew_APIURL_customConfig(t *testing.T) { func TestNew_APIURL_env(t *testing.T) { t.Setenv("GITHUB_API_URL", "https://api.mycompany.com") t.Setenv("GITHUB_SERVER_URL", "https://mycompany.com") - cfg := &config.ConfigMock{ - AuthenticationFunc: func() *config.AuthConfig { + cfg := &ghmock.ConfigMock{ + AuthenticationFunc: func() gh.AuthConfig { return &config.AuthConfig{} }, } f := &cmdutil.Factory{ - Config: func() (config.Config, error) { + Config: func() (gh.Config, error) { return cfg, nil }, } @@ -208,7 +210,7 @@ func TestNew_APIURL_env(t *testing.T) { func TestNew_APIURL_dotcomFallback(t *testing.T) { t.Setenv("GITHUB_API_URL", "") f := &cmdutil.Factory{ - Config: func() (config.Config, error) { + Config: func() (gh.Config, error) { return nil, errors.New("Failed to load") }, } @@ -222,13 +224,13 @@ func TestNew_APIURL_dotcomFallback(t *testing.T) { func TestNew_ServerURL_dotcomConfig(t *testing.T) { t.Setenv("GITHUB_SERVER_URL", "") t.Setenv("GITHUB_API_URL", "https://api.github.com") - cfg := &config.ConfigMock{ - AuthenticationFunc: func() *config.AuthConfig { + cfg := &ghmock.ConfigMock{ + AuthenticationFunc: func() gh.AuthConfig { return &config.AuthConfig{} }, } f := &cmdutil.Factory{ - Config: func() (config.Config, error) { + Config: func() (gh.Config, error) { return cfg, nil }, } @@ -245,15 +247,15 @@ func TestNew_ServerURL_dotcomConfig(t *testing.T) { func TestNew_ServerURL_customConfig(t *testing.T) { t.Setenv("GITHUB_SERVER_URL", "") t.Setenv("GITHUB_API_URL", "https://github.mycompany.com/api/v3") - cfg := &config.ConfigMock{ - AuthenticationFunc: func() *config.AuthConfig { + cfg := &ghmock.ConfigMock{ + AuthenticationFunc: func() gh.AuthConfig { authCfg := &config.AuthConfig{} authCfg.SetDefaultHost("github.mycompany.com", "GH_HOST") return authCfg }, } f := &cmdutil.Factory{ - Config: func() (config.Config, error) { + Config: func() (gh.Config, error) { return cfg, nil }, } @@ -270,13 +272,13 @@ func TestNew_ServerURL_customConfig(t *testing.T) { func TestNew_ServerURL_env(t *testing.T) { t.Setenv("GITHUB_SERVER_URL", "https://mycompany.com") t.Setenv("GITHUB_API_URL", "https://api.mycompany.com") - cfg := &config.ConfigMock{ - AuthenticationFunc: func() *config.AuthConfig { + cfg := &ghmock.ConfigMock{ + AuthenticationFunc: func() gh.AuthConfig { return &config.AuthConfig{} }, } f := &cmdutil.Factory{ - Config: func() (config.Config, error) { + Config: func() (gh.Config, error) { return cfg, nil }, } @@ -293,7 +295,7 @@ func TestNew_ServerURL_env(t *testing.T) { func TestNew_ServerURL_dotcomFallback(t *testing.T) { t.Setenv("GITHUB_SERVER_URL", "") f := &cmdutil.Factory{ - Config: func() (config.Config, error) { + Config: func() (gh.Config, error) { return nil, errors.New("Failed to load") }, } @@ -565,7 +567,7 @@ func TestRetries(t *testing.T) { t.Fatalf("expected codespace name to be %q but got %q", csName, cs.Name) } callCount = 0 - handler = func(w http.ResponseWriter, r *http.Request) { + handler = func(w http.ResponseWriter, _ *http.Request) { callCount++ err := json.NewEncoder(w).Encode(Codespace{ Name: csName, @@ -755,7 +757,7 @@ func TestAPI_EditCodespace(t *testing.T) { } } -func createFakeEditPendingOpServer(t *testing.T) *httptest.Server { +func createFakeEditPendingOpServer() *httptest.Server { return httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { if r.Method == http.MethodPatch { w.WriteHeader(http.StatusUnprocessableEntity) @@ -776,7 +778,7 @@ func createFakeEditPendingOpServer(t *testing.T) *httptest.Server { } func TestAPI_EditCodespacePendingOperation(t *testing.T) { - svr := createFakeEditPendingOpServer(t) + svr := createFakeEditPendingOpServer() defer svr.Close() a := &API{ diff --git a/internal/codespaces/codespaces.go b/internal/codespaces/codespaces.go index 8834f0e6c..da2eacd44 100644 --- a/internal/codespaces/codespaces.go +++ b/internal/codespaces/codespaces.go @@ -5,24 +5,32 @@ import ( "errors" "fmt" "net" + "net/http" "time" "github.com/cenkalti/backoff/v4" "github.com/cli/cli/v2/internal/codespaces/api" - "github.com/cli/cli/v2/pkg/liveshare" + "github.com/cli/cli/v2/internal/codespaces/connection" ) func connectionReady(codespace *api.Codespace) bool { - return codespace.Connection.SessionID != "" && - codespace.Connection.SessionToken != "" && - codespace.Connection.RelayEndpoint != "" && - codespace.Connection.RelaySAS != "" && - codespace.State == api.CodespaceStateAvailable + // If the codespace is not available, it is not ready + if codespace.State != api.CodespaceStateAvailable { + return false + } + + return codespace.Connection.TunnelProperties.ConnectAccessToken != "" && + codespace.Connection.TunnelProperties.ManagePortsAccessToken != "" && + codespace.Connection.TunnelProperties.ServiceUri != "" && + codespace.Connection.TunnelProperties.TunnelId != "" && + codespace.Connection.TunnelProperties.ClusterId != "" && + codespace.Connection.TunnelProperties.Domain != "" } type apiClient interface { GetCodespace(ctx context.Context, name string, includeConnection bool) (*api.Codespace, error) StartCodespace(ctx context.Context, name string) error + HTTPClient() (*http.Client, error) } type progressIndicator interface { @@ -30,11 +38,6 @@ type progressIndicator interface { StopProgressIndicator() } -type logger interface { - Println(v ...interface{}) - Printf(f string, v ...interface{}) -} - type TimeoutError struct { message string } @@ -43,9 +46,27 @@ func (e *TimeoutError) Error() string { return e.message } -// ConnectToLiveshare waits for a Codespace to become running, -// and connects to it using a Live Share session. -func ConnectToLiveshare(ctx context.Context, progress progressIndicator, sessionLogger logger, apiClient apiClient, codespace *api.Codespace) (*liveshare.Session, error) { +// GetCodespaceConnection waits until a codespace is able +// to be connected to and initializes a connection to it. +func GetCodespaceConnection(ctx context.Context, progress progressIndicator, apiClient apiClient, codespace *api.Codespace) (*connection.CodespaceConnection, error) { + codespace, err := waitUntilCodespaceConnectionReady(ctx, progress, apiClient, codespace) + if err != nil { + return nil, err + } + + progress.StartProgressIndicatorWithLabel("Connecting to codespace") + defer progress.StopProgressIndicator() + + httpClient, err := apiClient.HTTPClient() + if err != nil { + return nil, fmt.Errorf("error getting http client: %w", err) + } + + return connection.NewCodespaceConnection(ctx, codespace, httpClient) +} + +// waitUntilCodespaceConnectionReady waits for a Codespace to be running and is able to be connected to. +func waitUntilCodespaceConnectionReady(ctx context.Context, progress progressIndicator, apiClient apiClient, codespace *api.Codespace) (*api.Codespace, error) { if codespace.State != api.CodespaceStateAvailable { progress.StartProgressIndicatorWithLabel("Starting codespace") defer progress.StopProgressIndicator() @@ -83,17 +104,7 @@ func ConnectToLiveshare(ctx context.Context, progress progressIndicator, session } } - progress.StartProgressIndicatorWithLabel("Connecting to codespace") - defer progress.StopProgressIndicator() - - return liveshare.Connect(ctx, liveshare.Options{ - SessionID: codespace.Connection.SessionID, - SessionToken: codespace.Connection.SessionToken, - RelaySAS: codespace.Connection.RelaySAS, - RelayEndpoint: codespace.Connection.RelayEndpoint, - HostPublicKeys: codespace.Connection.HostPublicKeys, - Logger: sessionLogger, - }) + return codespace, nil } // ListenTCP starts a localhost tcp listener on 127.0.0.1 (unless allInterfaces is true) and returns the listener and bound port diff --git a/internal/codespaces/connection/connection.go b/internal/codespaces/connection/connection.go new file mode 100644 index 000000000..36fef3e17 --- /dev/null +++ b/internal/codespaces/connection/connection.go @@ -0,0 +1,168 @@ +package connection + +import ( + "context" + "fmt" + "io" + "log" + "net/http" + "net/url" + "sync" + + "github.com/cli/cli/v2/internal/codespaces/api" + "github.com/microsoft/dev-tunnels/go/tunnels" +) + +const ( + clientName = "gh" +) + +type TunnelClient struct { + *tunnels.Client + connected bool + mu sync.Mutex +} + +type CodespaceConnection struct { + tunnelProperties api.TunnelProperties + TunnelManager *tunnels.Manager + TunnelClient *TunnelClient + Options *tunnels.TunnelRequestOptions + Tunnel *tunnels.Tunnel + AllowedPortPrivacySettings []string +} + +// NewCodespaceConnection initializes a connection to a codespace. +// This connections allows for port forwarding which enables the +// use of most features of the codespace command. +func NewCodespaceConnection(ctx context.Context, codespace *api.Codespace, httpClient *http.Client) (connection *CodespaceConnection, err error) { + // Get the tunnel properties + tunnelProperties := codespace.Connection.TunnelProperties + + // Create the tunnel manager + tunnelManager, err := getTunnelManager(tunnelProperties, httpClient) + if err != nil { + return nil, fmt.Errorf("error getting tunnel management client: %w", err) + } + + // Calculate allowed port privacy settings + allowedPortPrivacySettings := codespace.RuntimeConstraints.AllowedPortPrivacySettings + + // Get the access tokens + connectToken := tunnelProperties.ConnectAccessToken + managementToken := tunnelProperties.ManagePortsAccessToken + + // Create the tunnel definition + tunnel := &tunnels.Tunnel{ + AccessTokens: map[tunnels.TunnelAccessScope]string{tunnels.TunnelAccessScopeConnect: connectToken, tunnels.TunnelAccessScopeManagePorts: managementToken}, + TunnelID: tunnelProperties.TunnelId, + ClusterID: tunnelProperties.ClusterId, + Domain: tunnelProperties.Domain, + } + + // Create options + options := &tunnels.TunnelRequestOptions{ + IncludePorts: true, + } + + // Create the tunnel client (not connected yet) + tunnelClient, err := getTunnelClient(ctx, tunnelManager, tunnel, options) + if err != nil { + return nil, fmt.Errorf("error getting tunnel client: %w", err) + } + + return &CodespaceConnection{ + tunnelProperties: tunnelProperties, + TunnelManager: tunnelManager, + TunnelClient: tunnelClient, + Options: options, + Tunnel: tunnel, + AllowedPortPrivacySettings: allowedPortPrivacySettings, + }, nil +} + +// Connect connects the client to the tunnel. +func (c *CodespaceConnection) Connect(ctx context.Context) error { + // Lock the mutex to prevent race conditions with the underlying SSH connection + c.TunnelClient.mu.Lock() + defer c.TunnelClient.mu.Unlock() + + // If already connected, return + if c.TunnelClient.connected { + return nil + } + + // Connect to the tunnel + if err := c.TunnelClient.Client.Connect(ctx, ""); err != nil { + return fmt.Errorf("error connecting to tunnel: %w", err) + } + + // Set the connected flag so we know we're connected + c.TunnelClient.connected = true + + return nil +} + +// Close closes the underlying tunnel client SSH connection. +func (c *CodespaceConnection) Close() error { + // Lock the mutex to prevent race conditions with the underlying SSH connection + c.TunnelClient.mu.Lock() + defer c.TunnelClient.mu.Unlock() + + // Don't close if we're not connected + if c.TunnelClient != nil && c.TunnelClient.connected { + if err := c.TunnelClient.Close(); err != nil { + return fmt.Errorf("failed to close tunnel client connection: %w", err) + } + + c.TunnelClient.connected = false + } + + return nil +} + +// getTunnelManager creates a tunnel manager for the given codespace. +// The tunnel manager is used to get the tunnel hosted in the codespace that we +// want to connect to and perform operations on ports (add, remove, list, etc.). +func getTunnelManager(tunnelProperties api.TunnelProperties, httpClient *http.Client) (tunnelManager *tunnels.Manager, err error) { + userAgent := []tunnels.UserAgent{{Name: clientName}} + url, err := url.Parse(tunnelProperties.ServiceUri) + if err != nil { + return nil, fmt.Errorf("error parsing tunnel service uri: %w", err) + } + + // Create the tunnel manager + tunnelManager, err = tunnels.NewManager(userAgent, nil, url, httpClient) + if err != nil { + return nil, fmt.Errorf("error creating tunnel manager: %w", err) + } + + return tunnelManager, nil +} + +// getTunnelClient creates a tunnel client for the given tunnel. +// The tunnel client is used to connect to the tunnel and allows +// for ports to be forwarded locally. +func getTunnelClient(ctx context.Context, tunnelManager *tunnels.Manager, tunnel *tunnels.Tunnel, options *tunnels.TunnelRequestOptions) (tunnelClient *TunnelClient, err error) { + // Get the tunnel that we want to connect to + codespaceTunnel, err := tunnelManager.GetTunnel(ctx, tunnel, options) + if err != nil { + return nil, fmt.Errorf("error getting tunnel: %w", err) + } + + // Copy the access tokens from the tunnel definition + codespaceTunnel.AccessTokens = tunnel.AccessTokens + + // We need to pass false for accept local connections because we don't want to automatically connect to all forwarded ports + client, err := tunnels.NewClient(log.New(io.Discard, "", log.LstdFlags), codespaceTunnel, false) + if err != nil { + return nil, fmt.Errorf("error creating tunnel client: %w", err) + } + + tunnelClient = &TunnelClient{ + Client: client, + connected: false, + } + + return tunnelClient, nil +} diff --git a/internal/codespaces/connection/connection_test.go b/internal/codespaces/connection/connection_test.go new file mode 100644 index 000000000..a444b8cc6 --- /dev/null +++ b/internal/codespaces/connection/connection_test.go @@ -0,0 +1,81 @@ +package connection + +import ( + "context" + "reflect" + "testing" + + "github.com/cli/cli/v2/internal/codespaces/api" + "github.com/microsoft/dev-tunnels/go/tunnels" +) + +func TestNewCodespaceConnection(t *testing.T) { + ctx := context.Background() + + // Create a mock codespace + connection := api.CodespaceConnection{ + TunnelProperties: api.TunnelProperties{ + ConnectAccessToken: "connect-token", + ManagePortsAccessToken: "manage-ports-token", + ServiceUri: "http://global.rel.tunnels.api.visualstudio.com/", + TunnelId: "tunnel-id", + ClusterId: "usw2", + Domain: "domain.com", + }, + } + allowedPortPrivacySettings := []string{"public", "private"} + codespace := &api.Codespace{ + Connection: connection, + RuntimeConstraints: api.RuntimeConstraints{AllowedPortPrivacySettings: allowedPortPrivacySettings}, + } + + // Create the mock HTTP client + httpClient, err := NewMockHttpClient() + if err != nil { + t.Fatalf("NewHttpClient returned an error: %v", err) + } + + // Create the connection + conn, err := NewCodespaceConnection(ctx, codespace, httpClient) + if err != nil { + t.Fatalf("NewCodespaceConnection returned an error: %v", err) + } + + // Verify closing before connected doesn't throw + err = conn.Close() + if err != nil { + t.Fatalf("Close returned an error: %v", err) + } + + // Check that the connection was created successfully + if conn == nil { + t.Fatal("NewCodespaceConnection returned nil") + } + + // Verify that the connection contains the expected tunnel properties + if conn.tunnelProperties != connection.TunnelProperties { + t.Fatalf("NewCodespaceConnection returned a connection with unexpected tunnel properties: %+v", conn.tunnelProperties) + } + + // Verify that the connection contains the expected tunnel + expectedTunnel := &tunnels.Tunnel{ + AccessTokens: map[tunnels.TunnelAccessScope]string{tunnels.TunnelAccessScopeConnect: connection.TunnelProperties.ConnectAccessToken, tunnels.TunnelAccessScopeManagePorts: connection.TunnelProperties.ManagePortsAccessToken}, + TunnelID: connection.TunnelProperties.TunnelId, + ClusterID: connection.TunnelProperties.ClusterId, + Domain: connection.TunnelProperties.Domain, + } + if !reflect.DeepEqual(conn.Tunnel, expectedTunnel) { + t.Fatalf("NewCodespaceConnection returned a connection with unexpected tunnel: %+v", conn.Tunnel) + } + + // Verify that the connection contains the expected tunnel options + expectedOptions := &tunnels.TunnelRequestOptions{IncludePorts: true} + if !reflect.DeepEqual(conn.Options, expectedOptions) { + t.Fatalf("NewCodespaceConnection returned a connection with unexpected options: %+v", conn.Options) + } + + // Verify that the connection contains the expected allowed port privacy settings + if !reflect.DeepEqual(conn.AllowedPortPrivacySettings, allowedPortPrivacySettings) { + t.Fatalf("NewCodespaceConnection returned a connection with unexpected allowed port privacy settings: %+v", conn.AllowedPortPrivacySettings) + } +} diff --git a/internal/codespaces/connection/tunnels_api_server_mock.go b/internal/codespaces/connection/tunnels_api_server_mock.go new file mode 100644 index 000000000..cf8f05cfa --- /dev/null +++ b/internal/codespaces/connection/tunnels_api_server_mock.go @@ -0,0 +1,396 @@ +package connection + +import ( + "context" + "crypto/rand" + "crypto/rsa" + "crypto/x509" + "encoding/json" + "encoding/pem" + "fmt" + "io" + "log" + "net/http" + "net/http/httptest" + "net/url" + "regexp" + "strings" + "sync" + "time" + + "github.com/gorilla/websocket" + "github.com/microsoft/dev-tunnels/go/tunnels" + tunnelssh "github.com/microsoft/dev-tunnels/go/tunnels/ssh" + "github.com/microsoft/dev-tunnels/go/tunnels/ssh/messages" + "golang.org/x/crypto/ssh" +) + +func NewMockHttpClient() (*http.Client, error) { + accessToken := "tunnel access-token" + relayServer, err := newMockrelayServer(withAccessToken(accessToken)) + if err != nil { + return nil, fmt.Errorf("NewrelayServer returned an error: %w", err) + } + + hostURL := strings.Replace(relayServer.URL(), "http://", "ws://", 1) + mockServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + var response []byte + if r.URL.Path == "/api/v1/tunnels/tunnel-id" { + tunnel := &tunnels.Tunnel{ + AccessTokens: map[tunnels.TunnelAccessScope]string{ + tunnels.TunnelAccessScopeConnect: accessToken, + }, + Endpoints: []tunnels.TunnelEndpoint{ + { + HostID: "host1", + TunnelRelayTunnelEndpoint: tunnels.TunnelRelayTunnelEndpoint{ + ClientRelayURI: hostURL, + }, + }, + }, + } + + response, err = json.Marshal(*tunnel) + if err != nil { + log.Fatalf("json.Marshal returned an error: %v", err) + } + } else if strings.HasPrefix(r.URL.Path, "/api/v1/tunnels/tunnel-id/ports") { + // Use regex to check if the path ends with a number + match, err := regexp.MatchString(`\/\d+$`, r.URL.Path) + if err != nil { + log.Fatalf("regexp.MatchString returned an error: %v", err) + } + + // If the path ends with a number, it's a request for a specific port + if match || r.Method == http.MethodPost { + if r.Method == http.MethodDelete { + w.WriteHeader(http.StatusOK) + return + } + + tunnelPort := &tunnels.TunnelPort{ + AccessControl: &tunnels.TunnelAccessControl{ + Entries: []tunnels.TunnelAccessControlEntry{}, + }, + } + + // Convert the tunnel to JSON and write it to the response + response, err = json.Marshal(*tunnelPort) + if err != nil { + log.Fatalf("json.Marshal returned an error: %v", err) + } + } else { + // If the path doesn't end with a number and we aren't making a POST request, return an array of ports + tunnelPorts := []tunnels.TunnelPort{ + { + AccessControl: &tunnels.TunnelAccessControl{ + Entries: []tunnels.TunnelAccessControlEntry{}, + }, + }, + } + + response, err = json.Marshal(tunnelPorts) + if err != nil { + log.Fatalf("json.Marshal returned an error: %v", err) + } + } + + } else { + w.WriteHeader(http.StatusNotFound) + return + } + + // Write the response + _, _ = w.Write(response) + })) + + url, err := url.Parse(mockServer.URL) + if err != nil { + return nil, fmt.Errorf("url.Parse returned an error: %w", err) + } + return &http.Client{ + Transport: &http.Transport{ + Proxy: http.ProxyURL(url), + }, + }, nil +} + +type relayServer struct { + httpServer *httptest.Server + errc chan error + sshConfig *ssh.ServerConfig + channels map[string]channelHandler + accessToken string + + serverConn *ssh.ServerConn +} + +type relayServerOption func(*relayServer) +type channelHandler func(context.Context, ssh.NewChannel) error + +func newMockrelayServer(opts ...relayServerOption) (*relayServer, error) { + server := &relayServer{ + errc: make(chan error), + sshConfig: &ssh.ServerConfig{ + NoClientAuth: true, + }, + } + + // Create a private key with the crypto package + key, err := rsa.GenerateKey(rand.Reader, 2048) + if err != nil { + return nil, fmt.Errorf("failed to generate key: %w", err) + } + + privateKeyPEM := pem.EncodeToMemory( + &pem.Block{ + Type: "RSA PRIVATE KEY", + Bytes: x509.MarshalPKCS1PrivateKey(key), + }, + ) + + // Parse the private key + sshPrivateKey, err := ssh.ParsePrivateKey(privateKeyPEM) + if err != nil { + return nil, fmt.Errorf("failed to parse private key: %w", err) + } + + server.sshConfig.AddHostKey(ssh.Signer(sshPrivateKey)) + + server.httpServer = httptest.NewServer(http.HandlerFunc(makeConnection(server))) + + for _, opt := range opts { + opt(server) + } + + return server, nil +} + +func withAccessToken(accessToken string) func(*relayServer) { + return func(server *relayServer) { + server.accessToken = accessToken + } +} + +func (rs *relayServer) URL() string { + return rs.httpServer.URL +} + +func (rs *relayServer) Err() <-chan error { + return rs.errc +} + +func (rs *relayServer) sendError(err error) { + select { + case rs.errc <- err: + default: + // channel is blocked with a previous error, so we ignore this one + } +} + +func (rs *relayServer) ForwardPort(ctx context.Context, port uint16) error { + pfr := messages.NewPortForwardRequest("127.0.0.1", uint32(port)) + b, err := pfr.Marshal() + if err != nil { + return fmt.Errorf("error marshaling port forward request: %w", err) + } + + replied, data, err := rs.serverConn.SendRequest(messages.PortForwardRequestType, true, b) + if err != nil { + return fmt.Errorf("error sending port forward request: %w", err) + } + + if !replied { + return fmt.Errorf("port forward request not replied") + } + + if data == nil { + return fmt.Errorf("no data returned") + } + + return nil +} + +func makeConnection(server *relayServer) http.HandlerFunc { + return func(w http.ResponseWriter, r *http.Request) { + ctx, cancel := context.WithCancel(context.Background()) + defer cancel() + + if server.accessToken != "" { + if r.Header.Get("Authorization") != server.accessToken { + server.sendError(fmt.Errorf("invalid access token")) + return + } + } + + upgrader := websocket.Upgrader{} + c, err := upgrader.Upgrade(w, r, nil) + if err != nil { + server.sendError(fmt.Errorf("error upgrading to websocket: %w", err)) + return + } + defer func() { + if err := c.Close(); err != nil { + server.sendError(fmt.Errorf("error closing websocket: %w", err)) + } + }() + + socketConn := newSocketConn(c) + serverConn, chans, reqs, err := ssh.NewServerConn(socketConn, server.sshConfig) + if err != nil { + server.sendError(fmt.Errorf("error creating ssh server conn: %w", err)) + return + } + + go handleRequests(ctx, convertRequests(reqs)) + + server.serverConn = serverConn + if err := handleChannels(ctx, server, chans); err != nil { + server.sendError(fmt.Errorf("error handling channels: %w", err)) + return + } + } +} + +func (sr *sshRequest) Type() string { + return sr.request.Type +} + +type sshRequest struct { + request *ssh.Request +} + +// Reply method for sshRequest to satisfy the tunnelssh.SSHRequest interface +func (sr *sshRequest) Reply(success bool, message []byte) error { + return sr.request.Reply(success, message) +} + +// convertRequests function +func convertRequests(reqs <-chan *ssh.Request) <-chan tunnelssh.SSHRequest { + out := make(chan tunnelssh.SSHRequest) + go func() { + for req := range reqs { + out <- &sshRequest{req} + } + close(out) + }() + return out +} + +func handleChannels(ctx context.Context, server *relayServer, chans <-chan ssh.NewChannel) error { + errc := make(chan error, 1) + go func() { + for ch := range chans { + if handler, ok := server.channels[ch.ChannelType()]; ok { + if err := handler(ctx, ch); err != nil { + errc <- err + return + } + } else { + // generic accept of the channel to not block + _, _, err := ch.Accept() + if err != nil { + errc <- fmt.Errorf("error accepting channel: %w", err) + return + } + } + } + }() + return awaitError(ctx, errc) +} + +func handleRequests(ctx context.Context, reqs <-chan tunnelssh.SSHRequest) { + for { + select { + case <-ctx.Done(): + return + case req, ok := <-reqs: + if !ok { + return + } + + if req.Type() == "RefreshPorts" { + _ = req.Reply(true, nil) + continue + } else { + _ = req.Reply(false, nil) + } + } + } +} + +func awaitError(ctx context.Context, errc <-chan error) error { + select { + case <-ctx.Done(): + return ctx.Err() + case err := <-errc: + return err + } +} + +type socketConn struct { + *websocket.Conn + + reader io.Reader + writeMutex sync.Mutex + readMutex sync.Mutex +} + +func newSocketConn(conn *websocket.Conn) *socketConn { + return &socketConn{Conn: conn} +} + +func (s *socketConn) Read(b []byte) (int, error) { + s.readMutex.Lock() + defer s.readMutex.Unlock() + + if s.reader == nil { + msgType, r, err := s.Conn.NextReader() + if err != nil { + return 0, fmt.Errorf("error getting next reader: %w", err) + } + if msgType != websocket.BinaryMessage { + return 0, fmt.Errorf("invalid message type") + } + s.reader = r + } + + bytesRead, err := s.reader.Read(b) + if err != nil { + s.reader = nil + + if err == io.EOF { + err = nil + } + } + + return bytesRead, err +} + +func (s *socketConn) Write(b []byte) (int, error) { + s.writeMutex.Lock() + defer s.writeMutex.Unlock() + + w, err := s.Conn.NextWriter(websocket.BinaryMessage) + if err != nil { + return 0, fmt.Errorf("error getting next writer: %w", err) + } + + n, err := w.Write(b) + if err != nil { + return 0, fmt.Errorf("error writing: %w", err) + } + + if err := w.Close(); err != nil { + return 0, fmt.Errorf("error closing writer: %w", err) + } + + return n, nil +} + +func (s *socketConn) SetDeadline(deadline time.Time) error { + if err := s.Conn.SetReadDeadline(deadline); err != nil { + return err + } + return s.Conn.SetWriteDeadline(deadline) +} diff --git a/internal/codespaces/portforwarder/port_forwarder.go b/internal/codespaces/portforwarder/port_forwarder.go new file mode 100644 index 000000000..b62d13715 --- /dev/null +++ b/internal/codespaces/portforwarder/port_forwarder.go @@ -0,0 +1,414 @@ +package portforwarder + +import ( + "context" + "fmt" + "io" + "net" + "strings" + + "github.com/cli/cli/v2/internal/codespaces/connection" + "github.com/microsoft/dev-tunnels/go/tunnels" +) + +const ( + githubSubjectId = "1" + InternalPortTag = "InternalPort" + UserForwardedPortTag = "UserForwardedPort" +) + +const ( + PrivatePortVisibility = "private" + OrgPortVisibility = "org" + PublicPortVisibility = "public" +) + +const ( + trafficTypeInput = "input" + trafficTypeOutput = "output" +) + +type ForwardPortOpts struct { + Port int + Internal bool + KeepAlive bool + Visibility string +} + +type CodespacesPortForwarder struct { + connection connection.CodespaceConnection + keepAliveReason chan string +} + +type PortForwarder interface { + ForwardPortToListener(ctx context.Context, opts ForwardPortOpts, listener *net.TCPListener) error + ForwardPort(ctx context.Context, opts ForwardPortOpts) error + ConnectToForwardedPort(ctx context.Context, conn io.ReadWriteCloser, opts ForwardPortOpts) error + ListPorts(ctx context.Context) ([]*tunnels.TunnelPort, error) + UpdatePortVisibility(ctx context.Context, remotePort int, visibility string) error + KeepAlive(reason string) + GetKeepAliveReason() string + Close() error +} + +// NewPortForwarder returns a new PortForwarder for the specified codespace. +func NewPortForwarder(ctx context.Context, codespaceConnection *connection.CodespaceConnection) (fwd PortForwarder, err error) { + return &CodespacesPortForwarder{ + connection: *codespaceConnection, + keepAliveReason: make(chan string, 1), + }, nil +} + +// ForwardPortToListener forwards the specified port to the given TCP listener. +func (fwd *CodespacesPortForwarder) ForwardPortToListener(ctx context.Context, opts ForwardPortOpts, listener *net.TCPListener) error { + err := fwd.ForwardPort(ctx, opts) + if err != nil { + return fmt.Errorf("error forwarding port: %w", err) + } + + done := make(chan error) + go func() { + // Convert the port number to a uint16 + port, err := convertIntToUint16(opts.Port) + if err != nil { + done <- fmt.Errorf("error converting port: %w", err) + return + } + + // Ensure the port is forwarded before connecting + err = fwd.connection.TunnelClient.WaitForForwardedPort(ctx, port) + if err != nil { + done <- fmt.Errorf("wait for forwarded port failed: %v", err) + return + } + + // Connect to the forwarded port + err = fwd.connectListenerToForwardedPort(ctx, opts, listener) + if err != nil { + done <- fmt.Errorf("connect to forwarded port failed: %v", err) + } + }() + + select { + case err := <-done: + if err != nil { + return fmt.Errorf("error connecting to tunnel: %w", err) + } + return nil + case <-ctx.Done(): + return nil + } +} + +// ForwardPort informs the host that we would like to forward the given port. +func (fwd *CodespacesPortForwarder) ForwardPort(ctx context.Context, opts ForwardPortOpts) error { + // Convert the port number to a uint16 + port, err := convertIntToUint16(opts.Port) + if err != nil { + return fmt.Errorf("error converting port: %w", err) + } + + tunnelPort := tunnels.NewTunnelPort(port, "", "", tunnels.TunnelProtocolHttp) + + // If no visibility is provided, Dev Tunnels will use the default (private) + if opts.Visibility != "" { + // Check if the requested visibility is allowed + allowed := false + for _, allowedVisibility := range fwd.connection.AllowedPortPrivacySettings { + if allowedVisibility == opts.Visibility { + allowed = true + break + } + } + + // If the requested visibility is not allowed, return an error + if !allowed { + return fmt.Errorf("visibility %s is not allowed", opts.Visibility) + } + + accessControlEntries := visibilityToAccessControlEntries(opts.Visibility) + if len(accessControlEntries) > 0 { + tunnelPort.AccessControl = &tunnels.TunnelAccessControl{ + Entries: accessControlEntries, + } + } + } + + // Tag the port as internal or user forwarded so we know if it needs to be shown in the UI + if opts.Internal { + tunnelPort.Tags = []string{InternalPortTag} + } else { + tunnelPort.Tags = []string{UserForwardedPortTag} + } + + // Create the tunnel port + _, err = fwd.connection.TunnelManager.CreateTunnelPort(ctx, fwd.connection.Tunnel, tunnelPort, fwd.connection.Options) + if err != nil && !strings.Contains(err.Error(), "409") { + return fmt.Errorf("create tunnel port failed: %v", err) + } + + // Connect to the tunnel + err = fwd.connection.Connect(ctx) + if err != nil { + return fmt.Errorf("connect failed: %v", err) + } + + // Inform the host that we've forwarded the port locally + err = fwd.connection.TunnelClient.RefreshPorts(ctx) + if err != nil { + return fmt.Errorf("refresh ports failed: %v", err) + } + + return nil +} + +// connectListenerToForwardedPort connects to the forwarded port via a local TCP port. +func (fwd *CodespacesPortForwarder) connectListenerToForwardedPort(ctx context.Context, opts ForwardPortOpts, listener *net.TCPListener) (err error) { + errc := make(chan error, 1) + sendError := func(err error) { + // Use non-blocking send, to avoid goroutines getting + // stuck in case of concurrent or sequential errors. + select { + case errc <- err: + default: + } + } + go func() { + for { + conn, err := listener.AcceptTCP() + if err != nil { + sendError(err) + return + } + + // Connect to the forwarded port in a goroutine so we can accept new connections + go func() { + if err := fwd.ConnectToForwardedPort(ctx, conn, opts); err != nil { + sendError(err) + } + }() + } + }() + + // Wait for an error or for the context to be cancelled + select { + case err := <-errc: + return err + case <-ctx.Done(): + return ctx.Err() // canceled + } +} + +// ConnectToForwardedPort connects to the forwarded port via a given ReadWriteCloser. +// Optionally, it detects traffic over the connection and sends activity signals to the server to keep the codespace from shutting down. +func (fwd *CodespacesPortForwarder) ConnectToForwardedPort(ctx context.Context, conn io.ReadWriteCloser, opts ForwardPortOpts) error { + // Create a traffic monitor to keep the session alive + if opts.KeepAlive { + conn = newTrafficMonitor(conn, fwd) + } + + // Convert the port number to a uint16 + port, err := convertIntToUint16(opts.Port) + if err != nil { + return fmt.Errorf("error converting port: %w", err) + } + + // Connect to the forwarded port + err = fwd.connection.TunnelClient.ConnectToForwardedPort(ctx, conn, port) + if err != nil { + return fmt.Errorf("error connecting to forwarded port: %w", err) + } + + return nil +} + +// ListPorts fetches the list of ports that are currently forwarded. +func (fwd *CodespacesPortForwarder) ListPorts(ctx context.Context) (ports []*tunnels.TunnelPort, err error) { + ports, err = fwd.connection.TunnelManager.ListTunnelPorts(ctx, fwd.connection.Tunnel, fwd.connection.Options) + if err != nil { + return nil, fmt.Errorf("error listing ports: %w", err) + } + + return ports, nil +} + +// UpdatePortVisibility changes the visibility (private, org, public) of the specified port. +func (fwd *CodespacesPortForwarder) UpdatePortVisibility(ctx context.Context, remotePort int, visibility string) error { + tunnelPort, err := fwd.connection.TunnelManager.GetTunnelPort(ctx, fwd.connection.Tunnel, remotePort, fwd.connection.Options) + if err != nil { + return fmt.Errorf("error getting tunnel port: %w", err) + } + + // If the port visibility isn't changing, don't do anything + if AccessControlEntriesToVisibility(tunnelPort.AccessControl.Entries) == visibility { + return nil + } + + // Delete the existing tunnel port to update + err = fwd.connection.TunnelManager.DeleteTunnelPort(ctx, fwd.connection.Tunnel, uint16(remotePort), fwd.connection.Options) + if err != nil { + return fmt.Errorf("error deleting tunnel port: %w", err) + } + + done := make(chan error) + go func() { + // Connect to the tunnel + err = fwd.connection.Connect(ctx) + if err != nil { + done <- fmt.Errorf("connect failed: %v", err) + return + } + + // Inform the host that we've deleted the port + err = fwd.connection.TunnelClient.RefreshPorts(ctx) + if err != nil { + done <- fmt.Errorf("refresh ports failed: %v", err) + return + } + + // Re-forward the port with the updated visibility + err = fwd.ForwardPort(ctx, ForwardPortOpts{Port: remotePort, Visibility: visibility}) + if err != nil { + done <- fmt.Errorf("error forwarding port: %w", err) + return + } + + done <- nil + }() + + // Wait for the done channel to be closed + select { + case err := <-done: + if err != nil { + // If we fail to re-forward the port, we need to forward again with the original visibility so the port is still accessible + _ = fwd.ForwardPort(ctx, ForwardPortOpts{Port: remotePort, Visibility: AccessControlEntriesToVisibility(tunnelPort.AccessControl.Entries)}) + + return fmt.Errorf("error connecting to tunnel: %w", err) + } + + return nil + case <-ctx.Done(): + return nil + } +} + +// KeepAlive accepts a reason that is retained if there is no active reason +// to send to the server. +func (fwd *CodespacesPortForwarder) KeepAlive(reason string) { + select { + case fwd.keepAliveReason <- reason: + default: + // there is already an active keep alive reason + // so we can ignore this one + } +} + +// GetKeepAliveReason fetches the keep alive reason from the channel and returns it. +func (fwd *CodespacesPortForwarder) GetKeepAliveReason() string { + return <-fwd.keepAliveReason +} + +// Close closes the port forwarder's tunnel client connection. +func (fwd *CodespacesPortForwarder) Close() error { + return fwd.connection.Close() +} + +// AccessControlEntriesToVisibility converts the access control entries used by Dev Tunnels to a friendly visibility value. +func AccessControlEntriesToVisibility(accessControlEntries []tunnels.TunnelAccessControlEntry) string { + for _, entry := range accessControlEntries { + // If we have the anonymous type (and we're not denying it), it's public + if (entry.Type == tunnels.TunnelAccessControlEntryTypeAnonymous) && (!entry.IsDeny) { + return PublicPortVisibility + } + + // If we have the organizations type (and we're not denying it), it's org + if (entry.Provider == string(tunnels.TunnelAuthenticationSchemeGitHub)) && (!entry.IsDeny) { + return OrgPortVisibility + } + } + + // Else, it's private + return PrivatePortVisibility +} + +// visibilityToAccessControlEntries converts the given visibility to access control entries that can be used by Dev Tunnels. +func visibilityToAccessControlEntries(visibility string) []tunnels.TunnelAccessControlEntry { + switch visibility { + case PublicPortVisibility: + return []tunnels.TunnelAccessControlEntry{{ + Type: tunnels.TunnelAccessControlEntryTypeAnonymous, + Subjects: []string{}, + Scopes: []string{string(tunnels.TunnelAccessScopeConnect)}, + }} + case OrgPortVisibility: + return []tunnels.TunnelAccessControlEntry{{ + Type: tunnels.TunnelAccessControlEntryTypeOrganizations, + Subjects: []string{githubSubjectId}, + Scopes: []string{ + string(tunnels.TunnelAccessScopeConnect), + }, + Provider: string(tunnels.TunnelAuthenticationSchemeGitHub), + }} + default: + // The tunnel manager doesn't accept empty access control entries, so we need to return a deny entry + return []tunnels.TunnelAccessControlEntry{{ + Type: tunnels.TunnelAccessControlEntryTypeOrganizations, + Subjects: []string{githubSubjectId}, + Scopes: []string{}, + IsDeny: true, + }} + } +} + +// IsInternalPort returns true if the port is internal. +func IsInternalPort(port *tunnels.TunnelPort) bool { + for _, tag := range port.Tags { + if strings.EqualFold(tag, InternalPortTag) { + return true + } + } + + return false +} + +// convertIntToUint16 converts the given int to a uint16. +func convertIntToUint16(port int) (uint16, error) { + var updatedPort uint16 + if port >= 0 && port <= 65535 { + updatedPort = uint16(port) + } else { + return 0, fmt.Errorf("invalid port number: %d", port) + } + + return updatedPort, nil +} + +// trafficMonitor implements io.Reader. It keeps the session alive by notifying +// it of the traffic type during Read operations. +type trafficMonitor struct { + rwc io.ReadWriteCloser + fwd PortForwarder +} + +// newTrafficMonitor returns a trafficMonitor for the specified codespace connection. +// It wraps the provided io.ReaderWriteCloser with its own Read/Write/Close methods. +func newTrafficMonitor(rwc io.ReadWriteCloser, fwd PortForwarder) *trafficMonitor { + return &trafficMonitor{rwc, fwd} +} + +// Read wraps the underlying ReadWriteCloser's Read method and keeps the session alive with the "input" traffic type. +func (t *trafficMonitor) Read(p []byte) (n int, err error) { + t.fwd.KeepAlive(trafficTypeInput) + return t.rwc.Read(p) +} + +// Write wraps the underlying ReadWriteCloser's Write method and keeps the session alive with the "output" traffic type. +func (t *trafficMonitor) Write(p []byte) (n int, err error) { + t.fwd.KeepAlive(trafficTypeOutput) + return t.rwc.Write(p) +} + +// Close closes the underlying ReadWriteCloser. +func (t *trafficMonitor) Close() error { + return t.rwc.Close() +} diff --git a/internal/codespaces/portforwarder/port_forwarder_test.go b/internal/codespaces/portforwarder/port_forwarder_test.go new file mode 100644 index 000000000..d107afec4 --- /dev/null +++ b/internal/codespaces/portforwarder/port_forwarder_test.go @@ -0,0 +1,139 @@ +package portforwarder + +import ( + "context" + "testing" + + "github.com/cli/cli/v2/internal/codespaces/api" + "github.com/cli/cli/v2/internal/codespaces/connection" + "github.com/microsoft/dev-tunnels/go/tunnels" +) + +func TestNewPortForwarder(t *testing.T) { + ctx := context.Background() + + // Create a mock codespace + codespace := &api.Codespace{ + Connection: api.CodespaceConnection{ + TunnelProperties: api.TunnelProperties{ + ConnectAccessToken: "connect-token", + ManagePortsAccessToken: "manage-ports-token", + ServiceUri: "http://global.rel.tunnels.api.visualstudio.com/", + TunnelId: "tunnel-id", + ClusterId: "usw2", + Domain: "domain.com", + }, + }, + RuntimeConstraints: api.RuntimeConstraints{ + AllowedPortPrivacySettings: []string{"public", "private"}, + }, + } + + // Create the mock HTTP client + httpClient, err := connection.NewMockHttpClient() + if err != nil { + t.Fatalf("NewHttpClient returned an error: %v", err) + } + + // Call the function being tested + conn, err := connection.NewCodespaceConnection(ctx, codespace, httpClient) + if err != nil { + t.Fatalf("NewCodespaceConnection returned an error: %v", err) + } + + // Create the new port forwarder + portForwarder, err := NewPortForwarder(ctx, conn) + if err != nil { + t.Fatalf("NewPortForwarder returned an error: %v", err) + } + + // Check that the port forwarder was created successfully + if portForwarder == nil { + t.Fatal("NewPortForwarder returned nil") + } +} + +func TestAccessControlEntriesToVisibility(t *testing.T) { + publicAccessControlEntry := []tunnels.TunnelAccessControlEntry{{ + Type: tunnels.TunnelAccessControlEntryTypeAnonymous, + }} + orgAccessControlEntry := []tunnels.TunnelAccessControlEntry{{ + Provider: string(tunnels.TunnelAuthenticationSchemeGitHub), + }} + privateAccessControlEntry := []tunnels.TunnelAccessControlEntry{} + orgIsDenyAccessControlEntry := []tunnels.TunnelAccessControlEntry{{ + Provider: string(tunnels.TunnelAuthenticationSchemeGitHub), + IsDeny: true, + }} + + tests := []struct { + name string + accessControlEntries []tunnels.TunnelAccessControlEntry + expected string + }{ + { + name: "public", + accessControlEntries: publicAccessControlEntry, + expected: PublicPortVisibility, + }, + { + name: "org", + accessControlEntries: orgAccessControlEntry, + expected: OrgPortVisibility, + }, + { + name: "private", + accessControlEntries: privateAccessControlEntry, + expected: PrivatePortVisibility, + }, + { + name: "orgIsDeny", + accessControlEntries: orgIsDenyAccessControlEntry, + expected: PrivatePortVisibility, + }, + } + + for _, test := range tests { + t.Run(test.name, func(t *testing.T) { + visibility := AccessControlEntriesToVisibility(test.accessControlEntries) + if visibility != test.expected { + t.Errorf("expected %q, got %q", test.expected, visibility) + } + }) + } +} + +func TestIsInternalPort(t *testing.T) { + internalPort := &tunnels.TunnelPort{ + Tags: []string{"InternalPort"}, + } + userForwardedPort := &tunnels.TunnelPort{ + Tags: []string{"UserForwardedPort"}, + } + + tests := []struct { + name string + port *tunnels.TunnelPort + expected bool + }{ + { + name: "internal", + port: internalPort, + expected: true, + }, + { + name: "user-forwarded", + port: userForwardedPort, + expected: false, + }, + } + + for _, test := range tests { + t.Run(test.name, func(t *testing.T) { + isInternal := IsInternalPort(test.port) + if isInternal != test.expected { + t.Errorf("expected %v, got %v", test.expected, isInternal) + } + }) + } +} diff --git a/internal/codespaces/rpc/invoker.go b/internal/codespaces/rpc/invoker.go index 39ae5ab19..a0830d2fc 100644 --- a/internal/codespaces/rpc/invoker.go +++ b/internal/codespaces/rpc/invoker.go @@ -12,10 +12,10 @@ import ( "strings" "time" + "github.com/cli/cli/v2/internal/codespaces/portforwarder" "github.com/cli/cli/v2/internal/codespaces/rpc/codespace" "github.com/cli/cli/v2/internal/codespaces/rpc/jupyter" "github.com/cli/cli/v2/internal/codespaces/rpc/ssh" - "github.com/cli/cli/v2/pkg/liveshare" "google.golang.org/grpc" "google.golang.org/grpc/credentials/insecure" "google.golang.org/grpc/metadata" @@ -31,6 +31,7 @@ const ( codespacesInternalSessionName = "CodespacesInternal" clientName = "gh" connectedEventName = "connected" + keepAliveEventName = "keepAlive" ) type StartSSHServerOptions struct { @@ -43,24 +44,26 @@ type Invoker interface { RebuildContainer(ctx context.Context, full bool) error StartSSHServer(ctx context.Context) (int, string, error) StartSSHServerWithOptions(ctx context.Context, options StartSSHServerOptions) (int, string, error) + KeepAlive() } type invoker struct { - conn *grpc.ClientConn - session liveshare.LiveshareSession - listener net.Listener - jupyterClient jupyter.JupyterServerHostClient - codespaceClient codespace.CodespaceHostClient - sshClient ssh.SshServerHostClient - cancelPF context.CancelFunc + conn *grpc.ClientConn + fwd portforwarder.PortForwarder + listener net.Listener + jupyterClient jupyter.JupyterServerHostClient + codespaceClient codespace.CodespaceHostClient + sshClient ssh.SshServerHostClient + cancelPF context.CancelFunc + keepAliveOverride bool } // Connects to the internal RPC server and returns a new invoker for it -func CreateInvoker(ctx context.Context, session liveshare.LiveshareSession) (Invoker, error) { +func CreateInvoker(ctx context.Context, fwd portforwarder.PortForwarder) (Invoker, error) { ctx, cancel := context.WithTimeout(ctx, ConnectionTimeout) defer cancel() - invoker, err := connect(ctx, session) + invoker, err := connect(ctx, fwd) if err != nil { return nil, fmt.Errorf("error connecting to internal server: %w", err) } @@ -69,7 +72,7 @@ func CreateInvoker(ctx context.Context, session liveshare.LiveshareSession) (Inv } // Finds a free port to listen on and creates a new RPC invoker that connects to that port -func connect(ctx context.Context, session liveshare.LiveshareSession) (Invoker, error) { +func connect(ctx context.Context, fwd portforwarder.PortForwarder) (Invoker, error) { listener, err := listenTCP() if err != nil { return nil, err @@ -77,7 +80,7 @@ func connect(ctx context.Context, session liveshare.LiveshareSession) (Invoker, localAddress := listener.Addr().String() invoker := &invoker{ - session: session, + fwd: fwd, listener: listener, } @@ -100,8 +103,12 @@ func connect(ctx context.Context, session liveshare.LiveshareSession) (Invoker, // Tunnel the remote gRPC server port to the local port go func() { - fwd := liveshare.NewPortForwarder(session, codespacesInternalSessionName, codespacesInternalPort, true) - ch <- fwd.ForwardToListener(pfctx, listener) + // Start forwarding the port locally + opts := portforwarder.ForwardPortOpts{ + Port: codespacesInternalPort, + Internal: true, + } + ch <- fwd.ForwardPortToListener(pfctx, opts, listener) }() var conn *grpc.ClientConn @@ -252,6 +259,12 @@ func listenTCP() (*net.TCPListener, error) { return listener, nil } +// KeepAlive sets a flag to continuously send activity signals to +// the codespace even if there is no other activity (e.g. stdio) +func (i *invoker) KeepAlive() { + i.keepAliveOverride = true +} + // Periodically check whether there is a reason to keep the connection alive, and if so, notify the codespace to do so func (i *invoker) heartbeat(ctx context.Context, interval time.Duration) { ticker := time.NewTicker(interval) @@ -262,7 +275,15 @@ func (i *invoker) heartbeat(ctx context.Context, interval time.Duration) { case <-ctx.Done(): return case <-ticker.C: - reason := i.session.GetKeepAliveReason() + reason := "" + + // If the keep alive override flag is set, we don't need to check for activity on the forwarder + // Otherwise, grab the reason from the forwarder + if i.keepAliveOverride { + reason = keepAliveEventName + } else { + reason = i.fwd.GetKeepAliveReason() + } _ = i.notifyCodespaceOfClientActivity(ctx, reason) } } diff --git a/internal/codespaces/rpc/invoker_test.go b/internal/codespaces/rpc/invoker_test.go index ba3e13ac3..d9b271c54 100644 --- a/internal/codespaces/rpc/invoker_test.go +++ b/internal/codespaces/rpc/invoker_test.go @@ -72,7 +72,8 @@ func createTestInvoker(t *testing.T, server *mockServer) (Invoker, func(), error listener.Close() } - invoker, err := CreateInvoker(context.Background(), &rpctest.Session{}) + // Create a new invoker with a mock port forwarder + invoker, err := CreateInvoker(context.Background(), rpctest.PortForwarder{}) if err != nil { close() return nil, nil, fmt.Errorf("error connecting to internal server: %w", err) diff --git a/internal/codespaces/rpc/test/channel.go b/internal/codespaces/rpc/test/channel.go deleted file mode 100644 index eef42c4aa..000000000 --- a/internal/codespaces/rpc/test/channel.go +++ /dev/null @@ -1,34 +0,0 @@ -package test - -import ( - "io" - "net" -) - -type Channel struct { - conn net.Conn -} - -func (c *Channel) Read(data []byte) (int, error) { - return c.conn.Read(data) -} - -func (c *Channel) Write(data []byte) (int, error) { - return c.conn.Write(data) -} - -func (c *Channel) Close() error { - return c.conn.Close() -} - -func (c *Channel) CloseWrite() error { - return nil -} - -func (c *Channel) SendRequest(name string, wantReply bool, payload []byte) (bool, error) { - return false, nil -} - -func (c *Channel) Stderr() io.ReadWriter { - return nil -} diff --git a/internal/codespaces/rpc/test/port_forwarder.go b/internal/codespaces/rpc/test/port_forwarder.go new file mode 100644 index 000000000..6930988cc --- /dev/null +++ b/internal/codespaces/rpc/test/port_forwarder.go @@ -0,0 +1,78 @@ +package test + +import ( + "context" + "fmt" + "io" + "net" + + "github.com/cli/cli/v2/internal/codespaces/portforwarder" + "github.com/microsoft/dev-tunnels/go/tunnels" +) + +type PortForwarder struct{} + +// Close implements portforwarder.PortForwarder. +func (PortForwarder) Close() error { + return nil +} + +// ConnectToForwardedPort implements portforwarder.PortForwarder. +func (PortForwarder) ConnectToForwardedPort(ctx context.Context, conn io.ReadWriteCloser, opts portforwarder.ForwardPortOpts) error { + panic("unimplemented") +} + +// ForwardPort implements portforwarder.PortForwarder. +func (PortForwarder) ForwardPort(ctx context.Context, opts portforwarder.ForwardPortOpts) error { + panic("unimplemented") +} + +// GetKeepAliveReason implements portforwarder.PortForwarder. +func (PortForwarder) GetKeepAliveReason() string { + panic("unimplemented") +} + +// KeepAlive implements portforwarder.PortForwarder. +func (PortForwarder) KeepAlive(reason string) { + panic("unimplemented") +} + +// ForwardPortToListener implements portforwarder.PortForwarder. +func (PortForwarder) ForwardPortToListener(ctx context.Context, opts portforwarder.ForwardPortOpts, listener *net.TCPListener) error { + // Start forwarding the port locally + hostConn, err := net.Dial("tcp", fmt.Sprintf("127.0.0.1:%d", opts.Port)) + if err != nil { + return err + } + + // Accept the connection from the listener + listenerConn, err := listener.Accept() + if err != nil { + return err + } + + // Copy data between the two connections + go func() { + _, _ = io.Copy(hostConn, listenerConn) + hostConn.Close() + }() + go func() { + _, _ = io.Copy(listenerConn, hostConn) + listenerConn.Close() + }() + + // ForwardPortToListener typically blocks until the context is cancelled so we need to do the same + <-ctx.Done() + + return nil +} + +// ListPorts implements portforwarder.PortForwarder. +func (PortForwarder) ListPorts(ctx context.Context) ([]*tunnels.TunnelPort, error) { + panic("unimplemented") +} + +// UpdatePortVisibility implements portforwarder.PortForwarder. +func (PortForwarder) UpdatePortVisibility(ctx context.Context, remotePort int, visibility string) error { + panic("unimplemented") +} diff --git a/internal/codespaces/rpc/test/session.go b/internal/codespaces/rpc/test/session.go deleted file mode 100644 index 531d4c33f..000000000 --- a/internal/codespaces/rpc/test/session.go +++ /dev/null @@ -1,43 +0,0 @@ -package test - -import ( - "context" - "fmt" - "net" - - "github.com/cli/cli/v2/pkg/liveshare" - "golang.org/x/crypto/ssh" -) - -type Session struct { - channel ssh.Channel -} - -func (*Session) Close() error { - panic("unimplemented") -} - -func (*Session) GetSharedServers(context.Context) ([]*liveshare.Port, error) { - panic("unimplemented") -} - -func (s *Session) KeepAlive(reason string) { -} - -func (s *Session) GetKeepAliveReason() string { - return "" -} - -func (s *Session) StartSharing(ctx context.Context, sessionName string, port int) (liveshare.ChannelID, error) { - conn, err := net.Dial("tcp", fmt.Sprintf("127.0.0.1:%d", port)) - if err != nil { - return liveshare.ChannelID{}, err - } - s.channel = &Channel{conn} - return liveshare.ChannelID{}, nil -} - -// Creates mock SSH channel connected to the mock gRPC server -func (s *Session) OpenStreamingChannel(ctx context.Context, id liveshare.ChannelID) (ssh.Channel, error) { - return s.channel, nil -} diff --git a/internal/codespaces/ssh.go b/internal/codespaces/ssh.go index a623d36f9..abffdbf81 100644 --- a/internal/codespaces/ssh.go +++ b/internal/codespaces/ssh.go @@ -19,9 +19,9 @@ type printer interface { // port-forwarding session. It runs until the shell is terminated // (including by cancellation of the context). func Shell( - ctx context.Context, p printer, sshArgs []string, port int, destination string, printConnDetails bool, + ctx context.Context, p printer, sshArgs []string, command []string, port int, destination string, printConnDetails bool, ) error { - cmd, connArgs, err := newSSHCommand(ctx, port, destination, sshArgs) + cmd, connArgs, err := newSSHCommand(ctx, port, destination, sshArgs, command) if err != nil { return fmt.Errorf("failed to create ssh command: %w", err) } @@ -51,30 +51,24 @@ func Copy(ctx context.Context, scpArgs []string, port int, destination string) e // NewRemoteCommand returns an exec.Cmd that will securely run a shell // command on the remote machine. func NewRemoteCommand(ctx context.Context, tunnelPort int, destination string, sshArgs ...string) (*exec.Cmd, error) { - cmd, _, err := newSSHCommand(ctx, tunnelPort, destination, sshArgs) + sshArgs, command, err := ParseSSHArgs(sshArgs) + if err != nil { + return nil, err + } + + cmd, _, err := newSSHCommand(ctx, tunnelPort, destination, sshArgs, command) return cmd, err } // newSSHCommand populates an exec.Cmd to run a command (or if blank, // an interactive shell) over ssh. -func newSSHCommand(ctx context.Context, port int, dst string, cmdArgs []string) (*exec.Cmd, []string, error) { +func newSSHCommand(ctx context.Context, port int, dst string, cmdArgs []string, command []string) (*exec.Cmd, []string, error) { connArgs := []string{ "-p", strconv.Itoa(port), "-o", "NoHostAuthenticationForLocalhost=yes", "-o", "PasswordAuthentication=no", } - // The ssh command syntax is: ssh [flags] user@host command [args...] - // There is no way to specify the user@host destination as a flag. - // Unfortunately, that means we need to know which user-provided words are - // SSH flags and which are command arguments so that we can place - // them before or after the destination, and that means we need to know all - // the flags and their arities. - cmdArgs, command, err := parseSSHArgs(cmdArgs) - if err != nil { - return nil, nil, err - } - cmdArgs = append(cmdArgs, connArgs...) cmdArgs = append(cmdArgs, "-C") // Compression cmdArgs = append(cmdArgs, dst) // user@host @@ -96,7 +90,14 @@ func newSSHCommand(ctx context.Context, port int, dst string, cmdArgs []string) return cmd, connArgs, nil } -func parseSSHArgs(args []string) (cmdArgs, command []string, err error) { +// ParseSSHArgs parses the given array of arguments into two distinct slices of flags and command. +// The ssh command syntax is: ssh [flags] user@host command [args...] +// There is no way to specify the user@host destination as a flag. +// Unfortunately, that means we need to know which user-provided words are +// SSH flags and which are command arguments so that we can place +// them before or after the destination, and that means we need to know all +// the flags and their arities. +func ParseSSHArgs(args []string) (cmdArgs, command []string, err error) { return parseArgs(args, "bcDeFIiLlmOopRSWw") } diff --git a/internal/codespaces/ssh_test.go b/internal/codespaces/ssh_test.go index 7389bd2f9..faea74ae2 100644 --- a/internal/codespaces/ssh_test.go +++ b/internal/codespaces/ssh_test.go @@ -74,7 +74,7 @@ func TestParseSSHArgs(t *testing.T) { } for _, tcase := range testCases { - args, command, err := parseSSHArgs(tcase.Args) + args, command, err := ParseSSHArgs(tcase.Args) checkParseResult(t, tcase, args, command, err) } diff --git a/internal/codespaces/states.go b/internal/codespaces/states.go index 3a2872365..ab673dd2c 100644 --- a/internal/codespaces/states.go +++ b/internal/codespaces/states.go @@ -6,13 +6,12 @@ import ( "encoding/json" "fmt" "io" - "log" "time" "github.com/cli/cli/v2/internal/codespaces/api" + "github.com/cli/cli/v2/internal/codespaces/portforwarder" "github.com/cli/cli/v2/internal/codespaces/rpc" "github.com/cli/cli/v2/internal/text" - "github.com/cli/cli/v2/pkg/liveshare" ) // PostCreateStateStatus is a string value representing the different statuses a state can have. @@ -39,17 +38,16 @@ type PostCreateState struct { // and calls the supplied poller for each batch of state changes. // It runs until it encounters an error, including cancellation of the context. func PollPostCreateStates(ctx context.Context, progress progressIndicator, apiClient apiClient, codespace *api.Codespace, poller func([]PostCreateState)) (err error) { - noopLogger := log.New(io.Discard, "", 0) - - session, err := ConnectToLiveshare(ctx, progress, noopLogger, apiClient, codespace) + codespaceConnection, err := GetCodespaceConnection(ctx, progress, apiClient, codespace) if err != nil { - return fmt.Errorf("connect to codespace: %w", err) + return fmt.Errorf("error connecting to codespace: %w", err) } - defer func() { - if closeErr := session.Close(); err == nil { - err = closeErr - } - }() + + fwd, err := portforwarder.NewPortForwarder(ctx, codespaceConnection) + if err != nil { + return fmt.Errorf("failed to create port forwarder: %w", err) + } + defer safeClose(fwd, &err) // Ensure local port is listening before client (getPostCreateOutput) connects. listen, localPort, err := ListenTCP(0, false) @@ -58,7 +56,7 @@ func PollPostCreateStates(ctx context.Context, progress progressIndicator, apiCl } progress.StartProgressIndicatorWithLabel("Fetching SSH Details") - invoker, err := rpc.CreateInvoker(ctx, session) + invoker, err := rpc.CreateInvoker(ctx, fwd) if err != nil { return err } @@ -73,8 +71,11 @@ func PollPostCreateStates(ctx context.Context, progress progressIndicator, apiCl progress.StartProgressIndicatorWithLabel("Fetching status") tunnelClosed := make(chan error, 1) // buffered to avoid sender stuckness go func() { - fwd := liveshare.NewPortForwarder(session, "sshd", remoteSSHServerPort, false) - tunnelClosed <- fwd.ForwardToListener(ctx, listen) // error is non-nil + opts := portforwarder.ForwardPortOpts{ + Port: remoteSSHServerPort, + Internal: true, + } + tunnelClosed <- fwd.ForwardPortToListener(ctx, opts, listen) }() t := time.NewTicker(1 * time.Second) diff --git a/internal/config/auth_config_test.go b/internal/config/auth_config_test.go new file mode 100644 index 000000000..ed000ff18 --- /dev/null +++ b/internal/config/auth_config_test.go @@ -0,0 +1,869 @@ +package config + +import ( + "errors" + "testing" + + "github.com/cli/cli/v2/internal/config/migration" + "github.com/cli/cli/v2/internal/keyring" + ghConfig "github.com/cli/go-gh/v2/pkg/config" + "github.com/stretchr/testify/require" +) + +// Note that NewIsolatedTestConfig sets up a Mock keyring as well +func newTestAuthConfig(t *testing.T) *AuthConfig { + cfg, _ := NewIsolatedTestConfig(t) + return &AuthConfig{cfg: cfg.cfg} +} + +func TestTokenFromKeyring(t *testing.T) { + // Given a keyring that contains a token for a host + authCfg := newTestAuthConfig(t) + require.NoError(t, keyring.Set(keyringServiceName("github.com"), "", "test-token")) + + // When we get the token from the auth config + token, err := authCfg.TokenFromKeyring("github.com") + + // Then it returns successfully with the correct token + require.NoError(t, err) + require.Equal(t, "test-token", token) +} + +func TestTokenFromKeyringForUser(t *testing.T) { + // Given a keyring that contains a token for a host with a specific user + authCfg := newTestAuthConfig(t) + require.NoError(t, keyring.Set(keyringServiceName("github.com"), "test-user", "test-token")) + + // When we get the token from the auth config + token, err := authCfg.TokenFromKeyringForUser("github.com", "test-user") + + // Then it returns successfully with the correct token + require.NoError(t, err) + require.Equal(t, "test-token", token) +} + +func TestTokenFromKeyringForUserErrorsIfUsernameIsBlank(t *testing.T) { + authCfg := newTestAuthConfig(t) + + // When we get the token from the keyring for an empty username + _, err := authCfg.TokenFromKeyringForUser("github.com", "") + + // Then it returns an error + require.ErrorContains(t, err, "username cannot be blank") +} + +func TestTokenStoredInConfig(t *testing.T) { + // When the user has logged in insecurely + authCfg := newTestAuthConfig(t) + _, err := authCfg.Login("github.com", "test-user", "test-token", "", false) + require.NoError(t, err) + + // When we get the token + token, source := authCfg.ActiveToken("github.com") + + // Then the token is successfully fetched + // and the source is set to oauth_token but this isn't great: + // https://github.com/cli/go-gh/issues/94 + require.Equal(t, "test-token", token) + require.Equal(t, oauthTokenKey, source) +} + +func TestTokenStoredInEnv(t *testing.T) { + // When the user is authenticated via env var + authCfg := newTestAuthConfig(t) + t.Setenv("GH_TOKEN", "test-token") + + // When we get the token + token, source := authCfg.ActiveToken("github.com") + + // Then the token is successfully fetched + // and the source is set to the name of the env var + require.Equal(t, "test-token", token) + require.Equal(t, "GH_TOKEN", source) +} + +func TestTokenStoredInKeyring(t *testing.T) { + // When the user has logged in securely + authCfg := newTestAuthConfig(t) + _, err := authCfg.Login("github.com", "test-user", "test-token", "", true) + require.NoError(t, err) + + // When we get the token + token, source := authCfg.ActiveToken("github.com") + + // Then the token is successfully fetched + // and the source is set to keyring + require.Equal(t, "test-token", token) + require.Equal(t, "keyring", source) +} + +func TestTokenFromKeyringNonExistent(t *testing.T) { + // Given a keyring that doesn't contain any tokens + authCfg := newTestAuthConfig(t) + + // When we try to get a token from the auth config + _, err := authCfg.TokenFromKeyring("github.com") + + // Then it returns failure bubbling the ErrNotFound + require.ErrorContains(t, err, "secret not found in keyring") +} + +func TestHasEnvTokenWithoutAnyEnvToken(t *testing.T) { + // Given we have no env set + authCfg := newTestAuthConfig(t) + + // When we check if it has an env token + hasEnvToken := authCfg.HasEnvToken() + + // Then it returns false + require.False(t, hasEnvToken, "expected not to have env token") +} + +func TestHasEnvTokenWithEnvToken(t *testing.T) { + // Given we have an env token set + // Note that any valid env var for tokens will do, not just GH_ENTERPRISE_TOKEN + authCfg := newTestAuthConfig(t) + t.Setenv("GH_ENTERPRISE_TOKEN", "test-token") + + // When we check if it has an env token + hasEnvToken := authCfg.HasEnvToken() + + // Then it returns true + require.True(t, hasEnvToken, "expected to have env token") +} + +func TestHasEnvTokenWithNoEnvTokenButAConfigVar(t *testing.T) { + t.Skip("this test is explicitly breaking some implementation assumptions") + + // Given a token in the config + authCfg := newTestAuthConfig(t) + // Using example.com here will cause the token to be returned from the config + _, err := authCfg.Login("example.com", "test-user", "test-token", "", false) + require.NoError(t, err) + + // When we check if it has an env token + hasEnvToken := authCfg.HasEnvToken() + + // Then it SHOULD return false + require.False(t, hasEnvToken, "expected not to have env token") +} + +func TestUserNotLoggedIn(t *testing.T) { + // Given we have not logged in + authCfg := newTestAuthConfig(t) + + // When we get the user + _, err := authCfg.ActiveUser("github.com") + + // Then it returns failure, bubbling the KeyNotFoundError + var keyNotFoundError *ghConfig.KeyNotFoundError + require.ErrorAs(t, err, &keyNotFoundError) +} + +func TestHostsIncludesEnvVar(t *testing.T) { + // Given the GH_HOST env var is set + authCfg := newTestAuthConfig(t) + t.Setenv("GH_HOST", "ghe.io") + + // When we get the hosts + hosts := authCfg.Hosts() + + // Then the host in the env var is included + require.Contains(t, hosts, "ghe.io") +} + +func TestDefaultHostFromEnvVar(t *testing.T) { + // Given the GH_HOST env var is set + authCfg := newTestAuthConfig(t) + t.Setenv("GH_HOST", "ghe.io") + + // When we get the DefaultHost + defaultHost, source := authCfg.DefaultHost() + + // Then the returned host and source are using the env var + require.Equal(t, "ghe.io", defaultHost) + require.Equal(t, "GH_HOST", source) +} + +func TestDefaultHostNotLoggedIn(t *testing.T) { + // Given we are not logged in + authCfg := newTestAuthConfig(t) + + // When we get the DefaultHost + defaultHost, source := authCfg.DefaultHost() + + // Then the returned host is always github.com + require.Equal(t, "github.com", defaultHost) + require.Equal(t, "default", source) +} + +func TestDefaultHostLoggedInToOnlyOneHost(t *testing.T) { + // Given we are logged into one host (not github.com to differentiate from the fallback) + authCfg := newTestAuthConfig(t) + _, err := authCfg.Login("ghe.io", "test-user", "test-token", "", false) + require.NoError(t, err) + + // When we get the DefaultHost + defaultHost, source := authCfg.DefaultHost() + + // Then the returned host is that logged in host and the source is the hosts config + require.Equal(t, "ghe.io", defaultHost) + require.Equal(t, hostsKey, source) +} + +func TestLoginSecureStorageUsesKeyring(t *testing.T) { + // Given a usable keyring + authCfg := newTestAuthConfig(t) + host := "github.com" + user := "test-user" + token := "test-token" + + // When we login with secure storage + insecureStorageUsed, err := authCfg.Login(host, user, token, "", true) + + // Then it returns success, notes that insecure storage was not used, and stores the token in the keyring + require.NoError(t, err) + require.False(t, insecureStorageUsed, "expected to use secure storage") + + gotToken, err := keyring.Get(keyringServiceName(host), "") + require.NoError(t, err) + require.Equal(t, token, gotToken) + + gotToken, err = keyring.Get(keyringServiceName(host), user) + require.NoError(t, err) + require.Equal(t, token, gotToken) +} + +func TestLoginSecureStorageRemovesOldInsecureConfigToken(t *testing.T) { + // Given a usable keyring and an oauth token in the config + authCfg := newTestAuthConfig(t) + authCfg.cfg.Set([]string{hostsKey, "github.com", oauthTokenKey}, "old-token") + + // When we login with secure storage + _, err := authCfg.Login("github.com", "test-user", "test-token", "", true) + + // Then it returns success, having also removed the old token from the config + require.NoError(t, err) + requireNoKey(t, authCfg.cfg, []string{hostsKey, "github.com", oauthTokenKey}) +} + +func TestLoginSecureStorageWithErrorFallsbackAndReports(t *testing.T) { + // Given a keyring that errors + authCfg := newTestAuthConfig(t) + keyring.MockInitWithError(errors.New("test-explosion")) + + // When we login with secure storage + insecureStorageUsed, err := authCfg.Login("github.com", "test-user", "test-token", "", true) + + // Then it returns success, reports that insecure storage was used, and stores the token in the config + require.NoError(t, err) + + require.True(t, insecureStorageUsed, "expected to use insecure storage") + requireKeyWithValue(t, authCfg.cfg, []string{hostsKey, "github.com", oauthTokenKey}, "test-token") +} + +func TestLoginInsecureStorage(t *testing.T) { + // Given we are not logged in + authCfg := newTestAuthConfig(t) + + // When we login with insecure storage + insecureStorageUsed, err := authCfg.Login("github.com", "test-user", "test-token", "", false) + + // Then it returns success, notes that insecure storage was used, and stores the token in the config + require.NoError(t, err) + + require.True(t, insecureStorageUsed, "expected to use insecure storage") + requireKeyWithValue(t, authCfg.cfg, []string{hostsKey, "github.com", oauthTokenKey}, "test-token") +} + +func TestLoginSetsUserForProvidedHost(t *testing.T) { + // Given we are not logged in + authCfg := newTestAuthConfig(t) + + // When we login + _, err := authCfg.Login("github.com", "test-user", "test-token", "ssh", false) + + // Then it returns success and the user is set + require.NoError(t, err) + + user, err := authCfg.ActiveUser("github.com") + require.NoError(t, err) + require.Equal(t, "test-user", user) +} + +func TestLoginSetsGitProtocolForProvidedHost(t *testing.T) { + // Given we are logged in + authCfg := newTestAuthConfig(t) + _, err := authCfg.Login("github.com", "test-user", "test-token", "ssh", false) + require.NoError(t, err) + + // When we get the host git protocol + hostProtocol, err := authCfg.cfg.Get([]string{hostsKey, "github.com", gitProtocolKey}) + require.NoError(t, err) + + // Then it returns the git protocol we provided on login + require.Equal(t, "ssh", hostProtocol) +} + +func TestLoginAddsHostIfNotAlreadyAdded(t *testing.T) { + // Given we are logged in + authCfg := newTestAuthConfig(t) + _, err := authCfg.Login("github.com", "test-user", "test-token", "ssh", false) + require.NoError(t, err) + + // When we get the hosts + hosts := authCfg.Hosts() + + // Then it includes our logged in host + require.Contains(t, hosts, "github.com") +} + +// This test mimics the behaviour of logging in with a token, not providing +// a git protocol, and using secure storage. +func TestLoginAddsUserToConfigWithoutGitProtocolAndWithSecureStorage(t *testing.T) { + // Given we are not logged in + authCfg := newTestAuthConfig(t) + + // When we log in without git protocol and with secure storage + _, err := authCfg.Login("github.com", "test-user", "test-token", "", true) + require.NoError(t, err) + + // Then the username is added under the users config + users, err := authCfg.cfg.Keys([]string{hostsKey, "github.com", usersKey}) + require.NoError(t, err) + require.Contains(t, users, "test-user") +} + +func TestLogoutRemovesHostAndKeyringToken(t *testing.T) { + // Given we are logged into a host + authCfg := newTestAuthConfig(t) + host := "github.com" + user := "test-user" + token := "test-token" + + _, err := authCfg.Login(host, user, token, "ssh", true) + require.NoError(t, err) + + // When we logout + err = authCfg.Logout(host, user) + + // Then we return success, and the host and token are removed from the config and keyring + require.NoError(t, err) + + requireNoKey(t, authCfg.cfg, []string{hostsKey, host}) + _, err = keyring.Get(keyringServiceName(host), "") + require.ErrorContains(t, err, "secret not found in keyring") + _, err = keyring.Get(keyringServiceName(host), user) + require.ErrorContains(t, err, "secret not found in keyring") +} + +func TestLogoutOfActiveUserSwitchesUserIfPossible(t *testing.T) { + // Given we have two accounts logged into a host + authCfg := newTestAuthConfig(t) + _, err := authCfg.Login("github.com", "inactive-user", "test-token-1", "ssh", true) + require.NoError(t, err) + + _, err = authCfg.Login("github.com", "active-user", "test-token-2", "https", true) + require.NoError(t, err) + + // When we logout of the active user + err = authCfg.Logout("github.com", "active-user") + + // Then we return success and the inactive user is now active + require.NoError(t, err) + activeUser, err := authCfg.ActiveUser("github.com") + require.NoError(t, err) + require.Equal(t, "inactive-user", activeUser) + + token, err := authCfg.TokenFromKeyring("github.com") + require.NoError(t, err) + require.Equal(t, "test-token-1", token) + + usersForHost := authCfg.UsersForHost("github.com") + require.NotContains(t, "active-user", usersForHost) +} + +func TestLogoutOfInactiveUserDoesNotSwitchUser(t *testing.T) { + // Given we have two accounts logged into a host + authCfg := newTestAuthConfig(t) + _, err := authCfg.Login("github.com", "inactive-user-1", "test-token-1.1", "ssh", true) + require.NoError(t, err) + + _, err = authCfg.Login("github.com", "inactive-user-2", "test-token-1.2", "ssh", true) + require.NoError(t, err) + + _, err = authCfg.Login("github.com", "active-user", "test-token-2", "https", true) + require.NoError(t, err) + + // When we logout of an inactive user + err = authCfg.Logout("github.com", "inactive-user-1") + + // Then we return success and the active user is still active + require.NoError(t, err) + activeUser, err := authCfg.ActiveUser("github.com") + require.NoError(t, err) + require.Equal(t, "active-user", activeUser) +} + +// Note that I'm not sure this test enforces particularly desirable behaviour +// since it leads users to believe a token has been removed when really +// that might have failed for some reason. +// +// The original intention here is that if the logout fails, the user can't +// really do anything to recover. On the other hand, a user might +// want to rectify this manually, for example if there were on a shared machine. +func TestLogoutIgnoresErrorsFromConfigAndKeyring(t *testing.T) { + // Given we have keyring that errors, and a config that + // doesn't even have a hosts key (which would cause Remove to fail) + keyring.MockInitWithError(errors.New("test-explosion")) + authCfg := newTestAuthConfig(t) + + // When we logout + err := authCfg.Logout("github.com", "test-user") + + // Then it returns success anyway, suppressing the errors + require.NoError(t, err) +} + +func TestSwitchUserMakesSecureTokenActive(t *testing.T) { + // Given we have a user with a secure token + authCfg := newTestAuthConfig(t) + _, err := authCfg.Login("github.com", "test-user-1", "test-token-1", "ssh", true) + require.NoError(t, err) + _, err = authCfg.Login("github.com", "test-user-2", "test-token-2", "ssh", true) + require.NoError(t, err) + + // When we switch to that user + require.NoError(t, authCfg.SwitchUser("github.com", "test-user-1")) + + // Their secure token is now active + token, err := authCfg.TokenFromKeyring("github.com") + require.NoError(t, err) + require.Equal(t, "test-token-1", token) +} + +func TestSwitchUserMakesInsecureTokenActive(t *testing.T) { + // Given we have a user with an insecure token + authCfg := newTestAuthConfig(t) + _, err := authCfg.Login("github.com", "test-user-1", "test-token-1", "ssh", false) + require.NoError(t, err) + _, err = authCfg.Login("github.com", "test-user-2", "test-token-2", "ssh", false) + require.NoError(t, err) + + // When we switch to that user + require.NoError(t, authCfg.SwitchUser("github.com", "test-user-1")) + + // Their insecure token is now active + token, source := authCfg.ActiveToken("github.com") + require.Equal(t, "test-token-1", token) + require.Equal(t, oauthTokenKey, source) +} + +func TestSwitchUserUpdatesTheActiveUser(t *testing.T) { + // Given we have two users logged into a host + authCfg := newTestAuthConfig(t) + _, err := authCfg.Login("github.com", "test-user-1", "test-token-1", "ssh", false) + require.NoError(t, err) + _, err = authCfg.Login("github.com", "test-user-2", "test-token-2", "ssh", false) + require.NoError(t, err) + + // When we switch to the other user + require.NoError(t, authCfg.SwitchUser("github.com", "test-user-1")) + + // Then the active user is updated + activeUser, err := authCfg.ActiveUser("github.com") + require.NoError(t, err) + require.Equal(t, "test-user-1", activeUser) +} + +func TestSwitchUserErrorsImmediatelyIfTheActiveTokenComesFromEnvironment(t *testing.T) { + // Given we have a token in the env + authCfg := newTestAuthConfig(t) + t.Setenv("GH_TOKEN", "unimportant-test-value") + _, err := authCfg.Login("github.com", "test-user-1", "test-token-1", "ssh", true) + require.NoError(t, err) + _, err = authCfg.Login("github.com", "test-user-2", "test-token-2", "ssh", true) + require.NoError(t, err) + + // When we switch to a user + err = authCfg.SwitchUser("github.com", "test-user-1") + + // Then it errors immediately with an informative message + require.ErrorContains(t, err, "currently active token for github.com is from GH_TOKEN") +} + +func TestSwitchUserErrorsAndRestoresUserAndInsecureConfigUnderFailure(t *testing.T) { + // Given we have a user but no token can be found (because we deleted them, simulating an error case) + authCfg := newTestAuthConfig(t) + _, err := authCfg.Login("github.com", "test-user-1", "test-token-1", "ssh", true) + require.NoError(t, err) + _, err = authCfg.Login("github.com", "test-user-2", "test-token-2", "ssh", false) + require.NoError(t, err) + + require.NoError(t, keyring.Delete(keyringServiceName("github.com"), "test-user-1")) + + // When we switch to the user + err = authCfg.SwitchUser("github.com", "test-user-1") + + // Then it returns an error + require.EqualError(t, err, "no token found for test-user-1") + + // And restores the previous state + activeUser, err := authCfg.ActiveUser("github.com") + require.NoError(t, err) + require.Equal(t, "test-user-2", activeUser) + + token, source := authCfg.ActiveToken("github.com") + require.Equal(t, "test-token-2", token) + require.Equal(t, "oauth_token", source) +} + +func TestSwitchUserErrorsAndRestoresUserAndKeyringUnderFailure(t *testing.T) { + // Given we have a user but no token can be found (because we deleted them, simulating an error case) + authCfg := newTestAuthConfig(t) + _, err := authCfg.Login("github.com", "test-user-1", "test-token-1", "ssh", false) + require.NoError(t, err) + _, err = authCfg.Login("github.com", "test-user-2", "test-token-2", "ssh", true) + require.NoError(t, err) + + require.NoError(t, authCfg.cfg.Remove([]string{hostsKey, "github.com", usersKey, "test-user-1", oauthTokenKey})) + + // When we switch to the user + err = authCfg.SwitchUser("github.com", "test-user-1") + + // Then it returns an error + require.EqualError(t, err, "no token found for test-user-1") + + // And restores the previous state + activeUser, err := authCfg.ActiveUser("github.com") + require.NoError(t, err) + require.Equal(t, "test-user-2", activeUser) + + token, source := authCfg.ActiveToken("github.com") + require.Equal(t, "test-token-2", token) + require.Equal(t, "keyring", source) +} + +func TestSwitchClearsActiveSecureTokenWhenSwitchingToInsecureUser(t *testing.T) { + // Given we have an active secure token + authCfg := newTestAuthConfig(t) + _, err := authCfg.Login("github.com", "test-user-1", "test-token-1", "ssh", false) + require.NoError(t, err) + _, err = authCfg.Login("github.com", "test-user-2", "test-token-2", "ssh", true) + require.NoError(t, err) + + // When we switch to an insecure user + require.NoError(t, authCfg.SwitchUser("github.com", "test-user-1")) + + // Then the active secure token is cleared + _, err = authCfg.TokenFromKeyring("github.com") + require.Error(t, err) +} + +func TestSwitchClearsActiveInsecureTokenWhenSwitchingToSecureUser(t *testing.T) { + // Given we have an active insecure token + authCfg := newTestAuthConfig(t) + _, err := authCfg.Login("github.com", "test-user-1", "test-token-1", "ssh", true) + require.NoError(t, err) + _, err = authCfg.Login("github.com", "test-user-2", "test-token-2", "ssh", false) + require.NoError(t, err) + + // When we switch to a secure user + require.NoError(t, authCfg.SwitchUser("github.com", "test-user-1")) + + // Then the active insecure token is cleared + requireNoKey(t, authCfg.cfg, []string{hostsKey, "github.com", oauthTokenKey}) +} + +func TestUsersForHostNoHost(t *testing.T) { + // Given we have a config with no hosts + authCfg := newTestAuthConfig(t) + + // When we get the users for a host that doesn't exist + users := authCfg.UsersForHost("github.com") + + // Then it returns nil + require.Nil(t, users) +} + +func TestUsersForHostWithUsers(t *testing.T) { + // Given we have a config with a host and users + authCfg := newTestAuthConfig(t) + _, err := authCfg.Login("github.com", "test-user-1", "test-token", "ssh", false) + require.NoError(t, err) + _, err = authCfg.Login("github.com", "test-user-2", "test-token", "ssh", false) + require.NoError(t, err) + + // When we get the users for that host + users := authCfg.UsersForHost("github.com") + + // Then it succeeds and returns the users + require.Equal(t, []string{"test-user-1", "test-user-2"}, users) +} + +func TestTokenForUserSecureLogin(t *testing.T) { + // Given a user has logged in securely + authCfg := newTestAuthConfig(t) + _, err := authCfg.Login("github.com", "test-user-1", "test-token", "ssh", true) + require.NoError(t, err) + + // When we get the token + token, source, err := authCfg.TokenForUser("github.com", "test-user-1") + + // Then it returns the token and the source as keyring + require.NoError(t, err) + require.Equal(t, "test-token", token) + require.Equal(t, "keyring", source) +} + +func TestTokenForUserInsecureLogin(t *testing.T) { + // Given a user has logged in insecurely + authCfg := newTestAuthConfig(t) + _, err := authCfg.Login("github.com", "test-user-1", "test-token", "ssh", false) + require.NoError(t, err) + + // When we get the token + token, source, err := authCfg.TokenForUser("github.com", "test-user-1") + + // Then it returns the token and the source as oauth_token + require.NoError(t, err) + require.Equal(t, "test-token", token) + require.Equal(t, "oauth_token", source) +} + +func TestTokenForUserNotFoundErrors(t *testing.T) { + // Given a user has not logged in + authCfg := newTestAuthConfig(t) + + // When we get the token + _, _, err := authCfg.TokenForUser("github.com", "test-user-1") + + // Then it returns an error + require.EqualError(t, err, "no token found for 'test-user-1'") +} + +func requireKeyWithValue(t *testing.T, cfg *ghConfig.Config, keys []string, value string) { + t.Helper() + + actual, err := cfg.Get(keys) + require.NoError(t, err) + + require.Equal(t, value, actual) +} + +func requireNoKey(t *testing.T, cfg *ghConfig.Config, keys []string) { + t.Helper() + + _, err := cfg.Get(keys) + var keyNotFoundError *ghConfig.KeyNotFoundError + require.ErrorAs(t, err, &keyNotFoundError) +} + +// Post migration tests + +func TestUserWorksRightAfterMigration(t *testing.T) { + // Given we have logged in before migration + authCfg := newTestAuthConfig(t) + _, err := preMigrationLogin(authCfg, "github.com", "test-user", "test-token", "ssh", false) + require.NoError(t, err) + + // When we migrate + var m migration.MultiAccount + c := cfg{authCfg.cfg} + require.NoError(t, c.Migrate(m)) + + // Then we can still get the user correctly + user, err := authCfg.ActiveUser("github.com") + require.NoError(t, err) + require.Equal(t, "test-user", user) +} + +func TestGitProtocolWorksRightAfterMigration(t *testing.T) { + // Given we have logged in before migration with a non-default git protocol + authCfg := newTestAuthConfig(t) + _, err := preMigrationLogin(authCfg, "github.com", "test-user", "test-token", "ssh", false) + require.NoError(t, err) + + // When we migrate + var m migration.MultiAccount + c := cfg{authCfg.cfg} + require.NoError(t, c.Migrate(m)) + + // Then we can still get the git protocol correctly + gitProtocol, err := authCfg.cfg.Get([]string{hostsKey, "github.com", gitProtocolKey}) + require.NoError(t, err) + require.Equal(t, "ssh", gitProtocol) +} + +func TestHostsWorksRightAfterMigration(t *testing.T) { + // Given we have logged in before migration + authCfg := newTestAuthConfig(t) + _, err := preMigrationLogin(authCfg, "ghe.io", "test-user", "test-token", "ssh", false) + require.NoError(t, err) + + // When we migrate + var m migration.MultiAccount + c := cfg{authCfg.cfg} + require.NoError(t, c.Migrate(m)) + + // Then we can still get the hosts correctly + hosts := authCfg.Hosts() + require.Contains(t, hosts, "ghe.io") +} + +func TestDefaultHostWorksRightAfterMigration(t *testing.T) { + // Given we have logged in before migration to an enterprise host + authCfg := newTestAuthConfig(t) + _, err := preMigrationLogin(authCfg, "ghe.io", "test-user", "test-token", "ssh", false) + require.NoError(t, err) + + // When we migrate + var m migration.MultiAccount + c := cfg{authCfg.cfg} + require.NoError(t, c.Migrate(m)) + + // Then the default host is still the enterprise host + defaultHost, source := authCfg.DefaultHost() + require.Equal(t, "ghe.io", defaultHost) + require.Equal(t, hostsKey, source) +} + +func TestTokenWorksRightAfterMigration(t *testing.T) { + // Given we have logged in before migration + authCfg := newTestAuthConfig(t) + _, err := preMigrationLogin(authCfg, "github.com", "test-user", "test-token", "ssh", false) + require.NoError(t, err) + + // When we migrate + var m migration.MultiAccount + c := cfg{authCfg.cfg} + require.NoError(t, c.Migrate(m)) + + // Then we can still get the token correctly + token, source := authCfg.ActiveToken("github.com") + require.Equal(t, "test-token", token) + require.Equal(t, oauthTokenKey, source) +} + +func TestLogoutRightAfterMigrationRemovesHost(t *testing.T) { + // Given we have logged in before migration + authCfg := newTestAuthConfig(t) + host := "github.com" + user := "test-user" + token := "test-token" + + _, err := preMigrationLogin(authCfg, host, user, token, "ssh", false) + require.NoError(t, err) + + // When we migrate and logout + var m migration.MultiAccount + c := cfg{authCfg.cfg} + require.NoError(t, c.Migrate(m)) + + require.NoError(t, authCfg.Logout(host, user)) + + // Then the host is removed from the config + requireNoKey(t, authCfg.cfg, []string{hostsKey, "github.com"}) +} + +func TestLoginInsecurePostMigrationUsesConfigForToken(t *testing.T) { + // Given we have not logged in + authCfg := newTestAuthConfig(t) + + // When we migrate and login with insecure storage + var m migration.MultiAccount + c := cfg{authCfg.cfg} + require.NoError(t, c.Migrate(m)) + + insecureStorageUsed, err := authCfg.Login("github.com", "test-user", "test-token", "", false) + + // Then it returns success, notes that insecure storage was used, and stores the token in the config + // both under the host and under the user + require.NoError(t, err) + + require.True(t, insecureStorageUsed, "expected to use insecure storage") + requireKeyWithValue(t, authCfg.cfg, []string{hostsKey, "github.com", oauthTokenKey}, "test-token") + requireKeyWithValue(t, authCfg.cfg, []string{hostsKey, "github.com", usersKey, "test-user", oauthTokenKey}, "test-token") +} + +func TestLoginPostMigrationSetsGitProtocol(t *testing.T) { + // Given we have logged in after migration + authCfg := newTestAuthConfig(t) + + var m migration.MultiAccount + c := cfg{authCfg.cfg} + require.NoError(t, c.Migrate(m)) + + _, err := authCfg.Login("github.com", "test-user", "test-token", "ssh", false) + require.NoError(t, err) + + // When we get the host git protocol + hostProtocol, err := authCfg.cfg.Get([]string{hostsKey, "github.com", gitProtocolKey}) + require.NoError(t, err) + + // Then it returns the git protocol we provided on login + require.Equal(t, "ssh", hostProtocol) +} + +func TestLoginPostMigrationSetsUser(t *testing.T) { + // Given we have logged in after migration + authCfg := newTestAuthConfig(t) + + var m migration.MultiAccount + c := cfg{authCfg.cfg} + require.NoError(t, c.Migrate(m)) + + _, err := authCfg.Login("github.com", "test-user", "test-token", "ssh", false) + require.NoError(t, err) + + // When we get the user + user, err := authCfg.ActiveUser("github.com") + + // Then it returns success and the user we provided on login + require.NoError(t, err) + require.Equal(t, "test-user", user) +} + +func TestLoginSecurePostMigrationRemovesTokenFromConfig(t *testing.T) { + // Given we have logged in insecurely + authCfg := newTestAuthConfig(t) + _, err := preMigrationLogin(authCfg, "github.com", "test-user", "test-token", "", false) + require.NoError(t, err) + + // When we migrate and login again with secure storage + var m migration.MultiAccount + c := cfg{authCfg.cfg} + require.NoError(t, c.Migrate(m)) + + _, err = authCfg.Login("github.com", "test-user", "test-token", "", true) + + // Then it returns success, having removed the old insecure oauth token entry + require.NoError(t, err) + requireNoKey(t, authCfg.cfg, []string{hostsKey, "github.com", oauthTokenKey}) + requireNoKey(t, authCfg.cfg, []string{hostsKey, "github.com", usersKey, "test-user", oauthTokenKey}) +} + +// Copied and pasted directly from the trunk branch before doing any work on +// login, plus the addition of AuthConfig as the first arg since it is a method +// receiver in the real implementation. +func preMigrationLogin(c *AuthConfig, hostname, username, token, gitProtocol string, secureStorage bool) (bool, error) { + var setErr error + if secureStorage { + if setErr = keyring.Set(keyringServiceName(hostname), "", token); setErr == nil { + // Clean up the previous oauth_token from the config file. + _ = c.cfg.Remove([]string{hostsKey, hostname, oauthTokenKey}) + } + } + insecureStorageUsed := false + if !secureStorage || setErr != nil { + c.cfg.Set([]string{hostsKey, hostname, oauthTokenKey}, token) + insecureStorageUsed = true + } + + c.cfg.Set([]string{hostsKey, hostname, userKey}, username) + + if gitProtocol != "" { + c.cfg.Set([]string{hostsKey, hostname, gitProtocolKey}, gitProtocol) + } + return insecureStorageUsed, ghConfig.Write(c.cfg) +} diff --git a/internal/config/config.go b/internal/config/config.go index bf14a1aa0..fbdcdef95 100644 --- a/internal/config/config.go +++ b/internal/config/config.go @@ -1,35 +1,36 @@ package config import ( + "errors" + "fmt" "os" "path/filepath" + "slices" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/keyring" + o "github.com/cli/cli/v2/pkg/option" ghAuth "github.com/cli/go-gh/v2/pkg/auth" ghConfig "github.com/cli/go-gh/v2/pkg/config" ) const ( - aliases = "aliases" - hosts = "hosts" - oauthToken = "oauth_token" + aliasesKey = "aliases" + browserKey = "browser" + editorKey = "editor" + gitProtocolKey = "git_protocol" + hostsKey = "hosts" + httpUnixSocketKey = "http_unix_socket" + oauthTokenKey = "oauth_token" + pagerKey = "pager" + promptKey = "prompt" + userKey = "user" + usersKey = "users" + versionKey = "version" ) -// This interface describes interacting with some persistent configuration for gh. -// -//go:generate moq -rm -out config_mock.go . Config -type Config interface { - Get(string, string) (string, error) - GetOrDefault(string, string) (string, error) - Set(string, string, string) - Write() error - - Aliases() *AliasConfig - Authentication() *AuthConfig -} - -func NewConfig() (Config, error) { - c, err := ghConfig.Read() +func NewConfig() (gh.Config, error) { + c, err := ghConfig.Read(fallbackConfig()) if err != nil { return nil, err } @@ -41,37 +42,44 @@ type cfg struct { cfg *ghConfig.Config } -func (c *cfg) Get(hostname, key string) (string, error) { +func (c *cfg) get(hostname, key string) o.Option[string] { if hostname != "" { - val, err := c.cfg.Get([]string{hosts, hostname, key}) + val, err := c.cfg.Get([]string{hostsKey, hostname, key}) if err == nil { - return val, err + return o.Some(val) } } - return c.cfg.Get([]string{key}) + val, err := c.cfg.Get([]string{key}) + if err == nil { + return o.Some(val) + } + + return o.None[string]() } -func (c *cfg) GetOrDefault(hostname, key string) (string, error) { - var val string - var err error - if hostname != "" { - val, err = c.cfg.Get([]string{hosts, hostname, key}) - if err == nil { - return val, err - } +func (c *cfg) GetOrDefault(hostname, key string) o.Option[gh.ConfigEntry] { + if val := c.get(hostname, key); val.IsSome() { + // Map the Option[string] to Option[gh.ConfigEntry] with a source of ConfigUserProvided + return o.Map(val, toConfigEntry(gh.ConfigUserProvided)) } - val, err = c.cfg.Get([]string{key}) - if err == nil { - return val, err + if defaultVal := defaultFor(key); defaultVal.IsSome() { + // Map the Option[string] to Option[gh.ConfigEntry] with a source of ConfigDefaultProvided + return o.Map(defaultVal, toConfigEntry(gh.ConfigDefaultProvided)) } - if defaultExists(key) { - return defaultFor(key), nil - } + return o.None[gh.ConfigEntry]() +} - return val, err +// toConfigEntry is a helper function to convert a string value to a ConfigEntry with a given source. +// +// It's a bit of FP style but it allows us to map an Option[string] to Option[gh.ConfigEntry] without +// unwrapping the it and rewrapping it. +func toConfigEntry(source gh.ConfigSource) func(val string) gh.ConfigEntry { + return func(val string) gh.ConfigEntry { + return gh.ConfigEntry{Value: val, Source: source} + } } func (c *cfg) Set(hostname, key, value string) { @@ -79,37 +87,100 @@ func (c *cfg) Set(hostname, key, value string) { c.cfg.Set([]string{key}, value) return } - c.cfg.Set([]string{hosts, hostname, key}, value) + + c.cfg.Set([]string{hostsKey, hostname, key}, value) + + if user, _ := c.cfg.Get([]string{hostsKey, hostname, userKey}); user != "" { + c.cfg.Set([]string{hostsKey, hostname, usersKey, user, key}, value) + } } func (c *cfg) Write() error { return ghConfig.Write(c.cfg) } -func (c *cfg) Aliases() *AliasConfig { +func (c *cfg) Aliases() gh.AliasConfig { return &AliasConfig{cfg: c.cfg} } -func (c *cfg) Authentication() *AuthConfig { +func (c *cfg) Authentication() gh.AuthConfig { return &AuthConfig{cfg: c.cfg} } -func defaultFor(key string) string { - for _, co := range configOptions { - if co.Key == key { - return co.DefaultValue - } - } - return "" +func (c *cfg) Browser(hostname string) gh.ConfigEntry { + // Intentionally panic if there is no user provided value or default value (which would be a programmer error) + return c.GetOrDefault(hostname, browserKey).Unwrap() } -func defaultExists(key string) bool { - for _, co := range configOptions { +func (c *cfg) Editor(hostname string) gh.ConfigEntry { + // Intentionally panic if there is no user provided value or default value (which would be a programmer error) + return c.GetOrDefault(hostname, editorKey).Unwrap() +} + +func (c *cfg) GitProtocol(hostname string) gh.ConfigEntry { + // Intentionally panic if there is no user provided value or default value (which would be a programmer error) + return c.GetOrDefault(hostname, gitProtocolKey).Unwrap() +} + +func (c *cfg) HTTPUnixSocket(hostname string) gh.ConfigEntry { + // Intentionally panic if there is no user provided value or default value (which would be a programmer error) + return c.GetOrDefault(hostname, httpUnixSocketKey).Unwrap() +} + +func (c *cfg) Pager(hostname string) gh.ConfigEntry { + // Intentionally panic if there is no user provided value or default value (which would be a programmer error) + return c.GetOrDefault(hostname, pagerKey).Unwrap() +} + +func (c *cfg) Prompt(hostname string) gh.ConfigEntry { + // Intentionally panic if there is no user provided value or default value (which would be a programmer error) + return c.GetOrDefault(hostname, promptKey).Unwrap() +} + +func (c *cfg) Version() o.Option[string] { + return c.get("", versionKey) +} + +func (c *cfg) Migrate(m gh.Migration) error { + // If there is no version entry we must never have applied a migration, and the following conditional logic + // handles the version as an empty string correctly. + version := c.Version().UnwrapOrZero() + + // If migration has already occurred then do not attempt to migrate again. + if m.PostVersion() == version { + return nil + } + + // If migration is incompatible with current version then return an error. + if m.PreVersion() != version { + return fmt.Errorf("failed to migrate as %q pre migration version did not match config version %q", m.PreVersion(), version) + } + + if err := m.Do(c.cfg); err != nil { + return fmt.Errorf("failed to migrate config: %s", err) + } + + c.Set("", versionKey, m.PostVersion()) + + // Then write out our migrated config. + if err := c.Write(); err != nil { + return fmt.Errorf("failed to write config after migration: %s", err) + } + + return nil +} + +func (c *cfg) CacheDir() string { + return ghConfig.CacheDir() +} + +func defaultFor(key string) o.Option[string] { + for _, co := range Options { if co.Key == key { - return true + return o.Some(co.DefaultValue) } } - return false + return o.None[string]() } // AuthConfig is used for interacting with some persistent configuration for gh, @@ -122,10 +193,10 @@ type AuthConfig struct { tokenOverride func(string) (string, string) } -// Token will retrieve the auth token for the given hostname, +// ActiveToken will retrieve the active auth token for the given hostname, // searching environment variables, plain text config, and // lastly encrypted storage. -func (c *AuthConfig) Token(hostname string) (string, string) { +func (c *AuthConfig) ActiveToken(hostname string) (string, string) { if c.tokenOverride != nil { return c.tokenOverride(hostname) } @@ -153,13 +224,17 @@ func (c *AuthConfig) HasEnvToken() bool { return true } } + // TODO: This is _extremely_ knowledgeable about the implementation of TokenFromEnvOrConfig + // It has to use a hostname that is not going to be found in the hosts so that it + // can guarantee that tokens will only be returned from a set env var. + // Discussed here, but maybe worth revisiting: https://github.com/cli/cli/pull/7169#discussion_r1136979033 token, _ := ghAuth.TokenFromEnvOrConfig(hostname) return token != "" } -// SetToken will override any token resolution and return the given -// token and source for all calls to Token. Use for testing purposes only. -func (c *AuthConfig) SetToken(token, source string) { +// SetActiveToken will override any token resolution and return the given +// token and source for all calls to ActiveToken. Use for testing purposes only. +func (c *AuthConfig) SetActiveToken(token, source string) { c.tokenOverride = func(_ string) (string, string) { return token, source } @@ -171,20 +246,24 @@ func (c *AuthConfig) TokenFromKeyring(hostname string) (string, error) { return keyring.Get(keyringServiceName(hostname), "") } -// User will retrieve the username for the logged in user at the given hostname. -func (c *AuthConfig) User(hostname string) (string, error) { - return c.cfg.Get([]string{hosts, hostname, "user"}) +// TokenFromKeyringForUser will retrieve the auth token for the given hostname +// and username, only searching in encrypted storage. +// +// An empty username will return an error because the potential to return +// the currently active token under surprising cases is just too high to risk +// compared to the utility of having the function being smart. +func (c *AuthConfig) TokenFromKeyringForUser(hostname, username string) (string, error) { + if username == "" { + return "", errors.New("username cannot be blank") + } + + return keyring.Get(keyringServiceName(hostname), username) } -// GitProtocol will retrieve the git protocol for the logged in user at the given hostname. -// If none is set it will return the default value. -func (c *AuthConfig) GitProtocol(hostname string) (string, error) { - key := "git_protocol" - val, err := c.cfg.Get([]string{hosts, hostname, key}) - if err == nil { - return val, err - } - return defaultFor(key), nil +// ActiveUser will retrieve the username for the active user at the given hostname. +// This will not be accurate if the oauth token is set from an environment variable. +func (c *AuthConfig) ActiveUser(hostname string) (string, error) { + return c.cfg.Get([]string{hostsKey, hostname, userKey}) } func (c *AuthConfig) Hosts() []string { @@ -220,35 +299,162 @@ func (c *AuthConfig) SetDefaultHost(host, source string) { // Login will set user, git protocol, and auth token for the given hostname. // If the encrypt option is specified it will first try to store the auth token // in encrypted storage and will fall back to the plain text config file. -func (c *AuthConfig) Login(hostname, username, token, gitProtocol string, secureStorage bool) error { +func (c *AuthConfig) Login(hostname, username, token, gitProtocol string, secureStorage bool) (bool, error) { + // In this section we set up the users config var setErr error if secureStorage { - if setErr = keyring.Set(keyringServiceName(hostname), "", token); setErr == nil { - // Clean up the previous oauth_token from the config file. - _ = c.cfg.Remove([]string{hosts, hostname, oauthToken}) + // Try to set the token for this user in the encrypted storage for later switching + setErr = keyring.Set(keyringServiceName(hostname), username, token) + if setErr == nil { + // Clean up the previous oauth_token from the config file, if there were one + _ = c.cfg.Remove([]string{hostsKey, hostname, usersKey, username, oauthTokenKey}) } } + insecureStorageUsed := false if !secureStorage || setErr != nil { - c.cfg.Set([]string{hosts, hostname, oauthToken}, token) - } - if username != "" { - c.cfg.Set([]string{hosts, hostname, "user"}, username) + // And set the oauth token under the user for later switching + c.cfg.Set([]string{hostsKey, hostname, usersKey, username, oauthTokenKey}, token) + insecureStorageUsed = true } + if gitProtocol != "" { - c.cfg.Set([]string{hosts, hostname, "git_protocol"}, gitProtocol) + // Set the host level git protocol + // Although it might be expected that this is handled by switch, git protocol + // is currently a host level config and not a user level config, so any change + // will overwrite the protocol for all users on the host. + c.cfg.Set([]string{hostsKey, hostname, gitProtocolKey}, gitProtocol) } - return ghConfig.Write(c.cfg) + + // Create the username key with an empty value so it will be + // written even when there are no keys set under it. + if _, getErr := c.cfg.Get([]string{hostsKey, hostname, usersKey, username}); getErr != nil { + c.cfg.Set([]string{hostsKey, hostname, usersKey, username}, "") + } + + // Then we activate the new user + return insecureStorageUsed, c.activateUser(hostname, username) +} + +func (c *AuthConfig) SwitchUser(hostname, user string) error { + previouslyActiveUser, err := c.ActiveUser(hostname) + if err != nil { + return fmt.Errorf("failed to get active user: %s", err) + } + + previouslyActiveToken, previousSource := c.ActiveToken(hostname) + if previousSource != "keyring" && previousSource != "oauth_token" { + return fmt.Errorf("currently active token for %s is from %s", hostname, previousSource) + } + + err = c.activateUser(hostname, user) + if err != nil { + // Given that activateUser can only fail before the config is written, or when writing the config + // we know for sure that the config has not been written. However, we still should restore it back + // to its previous clean state just in case something else tries to make use of the config, or tries + // to write it again. + if previousSource == "keyring" { + if setErr := keyring.Set(keyringServiceName(hostname), "", previouslyActiveToken); setErr != nil { + err = errors.Join(err, setErr) + } + } + + if previousSource == "oauth_token" { + c.cfg.Set([]string{hostsKey, hostname, oauthTokenKey}, previouslyActiveToken) + } + c.cfg.Set([]string{hostsKey, hostname, userKey}, previouslyActiveUser) + + return err + } + + return nil } // Logout will remove user, git protocol, and auth token for the given hostname. // It will remove the auth token from the encrypted storage if it exists there. -func (c *AuthConfig) Logout(hostname string) error { - if hostname == "" { +func (c *AuthConfig) Logout(hostname, username string) error { + users := c.UsersForHost(hostname) + + // If there is only one (or zero) users, then we remove the host + // and unset the keyring tokens. + if len(users) < 2 { + _ = c.cfg.Remove([]string{hostsKey, hostname}) + _ = keyring.Delete(keyringServiceName(hostname), "") + _ = keyring.Delete(keyringServiceName(hostname), username) + return ghConfig.Write(c.cfg) + } + + // Otherwise, we remove the user from this host + _ = c.cfg.Remove([]string{hostsKey, hostname, usersKey, username}) + + // This error is ignorable because we already know there is an active user for the host + activeUser, _ := c.ActiveUser(hostname) + + // If the user we're removing isn't active, then we just write the config + if activeUser != username { + return ghConfig.Write(c.cfg) + } + + // Otherwise we get the first user in the slice that isn't the user we're removing + switchUserIdx := slices.IndexFunc(users, func(n string) bool { + return n != username + }) + + // And activate them + return c.activateUser(hostname, users[switchUserIdx]) +} + +func (c *AuthConfig) activateUser(hostname, user string) error { + // We first need to idempotently clear out any set tokens for the host + _ = keyring.Delete(keyringServiceName(hostname), "") + _ = c.cfg.Remove([]string{hostsKey, hostname, oauthTokenKey}) + + // Then we'll move the keyring token or insecure token as necessary, only one of the + // following branches should be true. + + // If there is a token in the secure keyring for the user, move it to the active slot + var tokenSwitched bool + if token, err := keyring.Get(keyringServiceName(hostname), user); err == nil { + if err = keyring.Set(keyringServiceName(hostname), "", token); err != nil { + return fmt.Errorf("failed to move active token in keyring: %v", err) + } + tokenSwitched = true + } + + // If there is a token in the insecure config for the user, move it to the active field + if token, err := c.cfg.Get([]string{hostsKey, hostname, usersKey, user, oauthTokenKey}); err == nil { + c.cfg.Set([]string{hostsKey, hostname, oauthTokenKey}, token) + tokenSwitched = true + } + + if !tokenSwitched { + return fmt.Errorf("no token found for %s", user) + } + + // Then we'll update the active user for the host + c.cfg.Set([]string{hostsKey, hostname, userKey}, user) + + return ghConfig.Write(c.cfg) +} + +func (c *AuthConfig) UsersForHost(hostname string) []string { + users, err := c.cfg.Keys([]string{hostsKey, hostname, usersKey}) + if err != nil { return nil } - _ = c.cfg.Remove([]string{hosts, hostname}) - _ = keyring.Delete(keyringServiceName(hostname), "") - return ghConfig.Write(c.cfg) + + return users +} + +func (c *AuthConfig) TokenForUser(hostname, user string) (string, string, error) { + if token, err := keyring.Get(keyringServiceName(hostname), user); err == nil { + return token, "keyring", nil + } + + if token, err := c.cfg.Get([]string{hostsKey, hostname, usersKey, user, oauthTokenKey}); err == nil { + return token, "oauth_token", nil + } + + return "", "default", fmt.Errorf("no token found for '%s'", user) } func keyringServiceName(hostname string) string { @@ -260,76 +466,121 @@ type AliasConfig struct { } func (a *AliasConfig) Get(alias string) (string, error) { - return a.cfg.Get([]string{aliases, alias}) + return a.cfg.Get([]string{aliasesKey, alias}) } func (a *AliasConfig) Add(alias, expansion string) { - a.cfg.Set([]string{aliases, alias}, expansion) + a.cfg.Set([]string{aliasesKey, alias}, expansion) } func (a *AliasConfig) Delete(alias string) error { - return a.cfg.Remove([]string{aliases, alias}) + return a.cfg.Remove([]string{aliasesKey, alias}) } func (a *AliasConfig) All() map[string]string { out := map[string]string{} - keys, err := a.cfg.Keys([]string{aliases}) + keys, err := a.cfg.Keys([]string{aliasesKey}) if err != nil { return out } for _, key := range keys { - val, _ := a.cfg.Get([]string{aliases, key}) + val, _ := a.cfg.Get([]string{aliasesKey, key}) out[key] = val } return out } +func fallbackConfig() *ghConfig.Config { + return ghConfig.ReadFromString(defaultConfigStr) +} + +// The schema version in here should match the PostVersion of whatever the +// last migration we decided to run is. Therefore, if we run a new migration, +// this should be bumped. +const defaultConfigStr = ` +# The default config file, auto-generated by gh. Run 'gh environment' to learn more about +# environment variables respected by gh and their precedence. + +# The current version of the config schema +version: 1 +# What protocol to use when performing git operations. Supported values: ssh, https +git_protocol: https +# What editor gh should run when creating issues, pull requests, etc. If blank, will refer to environment. +editor: +# When to interactively prompt. This is a global config that cannot be overridden by hostname. Supported values: enabled, disabled +prompt: enabled +# A pager program to send command output to, e.g. "less". If blank, will refer to environment. Set the value to "cat" to disable the pager. +pager: +# Aliases allow you to create nicknames for gh commands +aliases: + co: pr checkout +# The path to a unix socket through which send HTTP connections. If blank, HTTP traffic will be handled by net/http.DefaultTransport. +http_unix_socket: +# What web browser gh should use when opening URLs. If blank, will refer to environment. +browser: +` + type ConfigOption struct { Key string Description string DefaultValue string AllowedValues []string + CurrentValue func(c gh.Config, hostname string) string } -var configOptions = []ConfigOption{ +var Options = []ConfigOption{ { - Key: "git_protocol", + Key: gitProtocolKey, Description: "the protocol to use for git clone and push operations", DefaultValue: "https", AllowedValues: []string{"https", "ssh"}, + CurrentValue: func(c gh.Config, hostname string) string { + return c.GitProtocol(hostname).Value + }, }, { - Key: "editor", + Key: editorKey, Description: "the text editor program to use for authoring text", DefaultValue: "", + CurrentValue: func(c gh.Config, hostname string) string { + return c.Editor(hostname).Value + }, }, { - Key: "prompt", + Key: promptKey, Description: "toggle interactive prompting in the terminal", DefaultValue: "enabled", AllowedValues: []string{"enabled", "disabled"}, + CurrentValue: func(c gh.Config, hostname string) string { + return c.Prompt(hostname).Value + }, }, { - Key: "pager", + Key: pagerKey, Description: "the terminal pager program to send standard output to", DefaultValue: "", + CurrentValue: func(c gh.Config, hostname string) string { + return c.Pager(hostname).Value + }, }, { - Key: "http_unix_socket", + Key: httpUnixSocketKey, Description: "the path to a Unix socket through which to make an HTTP connection", DefaultValue: "", + CurrentValue: func(c gh.Config, hostname string) string { + return c.HTTPUnixSocket(hostname).Value + }, }, { - Key: "browser", + Key: browserKey, Description: "the web browser to use for opening URLs", DefaultValue: "", + CurrentValue: func(c gh.Config, hostname string) string { + return c.Browser(hostname).Value + }, }, } -func ConfigOptions() []ConfigOption { - return configOptions -} - func HomeDirPath(subdir string) (string, error) { homeDir, err := os.UserHomeDir() if err != nil { diff --git a/internal/config/config_mock.go b/internal/config/config_mock.go deleted file mode 100644 index 6fd76dc55..000000000 --- a/internal/config/config_mock.go +++ /dev/null @@ -1,297 +0,0 @@ -// Code generated by moq; DO NOT EDIT. -// github.com/matryer/moq - -package config - -import ( - "sync" -) - -// Ensure, that ConfigMock does implement Config. -// If this is not the case, regenerate this file with moq. -var _ Config = &ConfigMock{} - -// ConfigMock is a mock implementation of Config. -// -// func TestSomethingThatUsesConfig(t *testing.T) { -// -// // make and configure a mocked Config -// mockedConfig := &ConfigMock{ -// AliasesFunc: func() *AliasConfig { -// panic("mock out the Aliases method") -// }, -// AuthenticationFunc: func() *AuthConfig { -// panic("mock out the Authentication method") -// }, -// GetFunc: func(s1 string, s2 string) (string, error) { -// panic("mock out the Get method") -// }, -// GetOrDefaultFunc: func(s1 string, s2 string) (string, error) { -// panic("mock out the GetOrDefault method") -// }, -// SetFunc: func(s1 string, s2 string, s3 string) { -// panic("mock out the Set method") -// }, -// WriteFunc: func() error { -// panic("mock out the Write method") -// }, -// } -// -// // use mockedConfig in code that requires Config -// // and then make assertions. -// -// } -type ConfigMock struct { - // AliasesFunc mocks the Aliases method. - AliasesFunc func() *AliasConfig - - // AuthenticationFunc mocks the Authentication method. - AuthenticationFunc func() *AuthConfig - - // GetFunc mocks the Get method. - GetFunc func(s1 string, s2 string) (string, error) - - // GetOrDefaultFunc mocks the GetOrDefault method. - GetOrDefaultFunc func(s1 string, s2 string) (string, error) - - // SetFunc mocks the Set method. - SetFunc func(s1 string, s2 string, s3 string) - - // WriteFunc mocks the Write method. - WriteFunc func() error - - // calls tracks calls to the methods. - calls struct { - // Aliases holds details about calls to the Aliases method. - Aliases []struct { - } - // Authentication holds details about calls to the Authentication method. - Authentication []struct { - } - // Get holds details about calls to the Get method. - Get []struct { - // S1 is the s1 argument value. - S1 string - // S2 is the s2 argument value. - S2 string - } - // GetOrDefault holds details about calls to the GetOrDefault method. - GetOrDefault []struct { - // S1 is the s1 argument value. - S1 string - // S2 is the s2 argument value. - S2 string - } - // Set holds details about calls to the Set method. - Set []struct { - // S1 is the s1 argument value. - S1 string - // S2 is the s2 argument value. - S2 string - // S3 is the s3 argument value. - S3 string - } - // Write holds details about calls to the Write method. - Write []struct { - } - } - lockAliases sync.RWMutex - lockAuthentication sync.RWMutex - lockGet sync.RWMutex - lockGetOrDefault sync.RWMutex - lockSet sync.RWMutex - lockWrite sync.RWMutex -} - -// Aliases calls AliasesFunc. -func (mock *ConfigMock) Aliases() *AliasConfig { - if mock.AliasesFunc == nil { - panic("ConfigMock.AliasesFunc: method is nil but Config.Aliases was just called") - } - callInfo := struct { - }{} - mock.lockAliases.Lock() - mock.calls.Aliases = append(mock.calls.Aliases, callInfo) - mock.lockAliases.Unlock() - return mock.AliasesFunc() -} - -// AliasesCalls gets all the calls that were made to Aliases. -// Check the length with: -// -// len(mockedConfig.AliasesCalls()) -func (mock *ConfigMock) AliasesCalls() []struct { -} { - var calls []struct { - } - mock.lockAliases.RLock() - calls = mock.calls.Aliases - mock.lockAliases.RUnlock() - return calls -} - -// Authentication calls AuthenticationFunc. -func (mock *ConfigMock) Authentication() *AuthConfig { - if mock.AuthenticationFunc == nil { - panic("ConfigMock.AuthenticationFunc: method is nil but Config.Authentication was just called") - } - callInfo := struct { - }{} - mock.lockAuthentication.Lock() - mock.calls.Authentication = append(mock.calls.Authentication, callInfo) - mock.lockAuthentication.Unlock() - return mock.AuthenticationFunc() -} - -// AuthenticationCalls gets all the calls that were made to Authentication. -// Check the length with: -// -// len(mockedConfig.AuthenticationCalls()) -func (mock *ConfigMock) AuthenticationCalls() []struct { -} { - var calls []struct { - } - mock.lockAuthentication.RLock() - calls = mock.calls.Authentication - mock.lockAuthentication.RUnlock() - return calls -} - -// Get calls GetFunc. -func (mock *ConfigMock) Get(s1 string, s2 string) (string, error) { - if mock.GetFunc == nil { - panic("ConfigMock.GetFunc: method is nil but Config.Get was just called") - } - callInfo := struct { - S1 string - S2 string - }{ - S1: s1, - S2: s2, - } - mock.lockGet.Lock() - mock.calls.Get = append(mock.calls.Get, callInfo) - mock.lockGet.Unlock() - return mock.GetFunc(s1, s2) -} - -// GetCalls gets all the calls that were made to Get. -// Check the length with: -// -// len(mockedConfig.GetCalls()) -func (mock *ConfigMock) GetCalls() []struct { - S1 string - S2 string -} { - var calls []struct { - S1 string - S2 string - } - mock.lockGet.RLock() - calls = mock.calls.Get - mock.lockGet.RUnlock() - return calls -} - -// GetOrDefault calls GetOrDefaultFunc. -func (mock *ConfigMock) GetOrDefault(s1 string, s2 string) (string, error) { - if mock.GetOrDefaultFunc == nil { - panic("ConfigMock.GetOrDefaultFunc: method is nil but Config.GetOrDefault was just called") - } - callInfo := struct { - S1 string - S2 string - }{ - S1: s1, - S2: s2, - } - mock.lockGetOrDefault.Lock() - mock.calls.GetOrDefault = append(mock.calls.GetOrDefault, callInfo) - mock.lockGetOrDefault.Unlock() - return mock.GetOrDefaultFunc(s1, s2) -} - -// GetOrDefaultCalls gets all the calls that were made to GetOrDefault. -// Check the length with: -// -// len(mockedConfig.GetOrDefaultCalls()) -func (mock *ConfigMock) GetOrDefaultCalls() []struct { - S1 string - S2 string -} { - var calls []struct { - S1 string - S2 string - } - mock.lockGetOrDefault.RLock() - calls = mock.calls.GetOrDefault - mock.lockGetOrDefault.RUnlock() - return calls -} - -// Set calls SetFunc. -func (mock *ConfigMock) Set(s1 string, s2 string, s3 string) { - if mock.SetFunc == nil { - panic("ConfigMock.SetFunc: method is nil but Config.Set was just called") - } - callInfo := struct { - S1 string - S2 string - S3 string - }{ - S1: s1, - S2: s2, - S3: s3, - } - mock.lockSet.Lock() - mock.calls.Set = append(mock.calls.Set, callInfo) - mock.lockSet.Unlock() - mock.SetFunc(s1, s2, s3) -} - -// SetCalls gets all the calls that were made to Set. -// Check the length with: -// -// len(mockedConfig.SetCalls()) -func (mock *ConfigMock) SetCalls() []struct { - S1 string - S2 string - S3 string -} { - var calls []struct { - S1 string - S2 string - S3 string - } - mock.lockSet.RLock() - calls = mock.calls.Set - mock.lockSet.RUnlock() - return calls -} - -// Write calls WriteFunc. -func (mock *ConfigMock) Write() error { - if mock.WriteFunc == nil { - panic("ConfigMock.WriteFunc: method is nil but Config.Write was just called") - } - callInfo := struct { - }{} - mock.lockWrite.Lock() - mock.calls.Write = append(mock.calls.Write, callInfo) - mock.lockWrite.Unlock() - return mock.WriteFunc() -} - -// WriteCalls gets all the calls that were made to Write. -// Check the length with: -// -// len(mockedConfig.WriteCalls()) -func (mock *ConfigMock) WriteCalls() []struct { -} { - var calls []struct { - } - mock.lockWrite.RLock() - calls = mock.calls.Write - mock.lockWrite.RUnlock() - return calls -} diff --git a/internal/config/config_test.go b/internal/config/config_test.go new file mode 100644 index 000000000..fef87ddc6 --- /dev/null +++ b/internal/config/config_test.go @@ -0,0 +1,182 @@ +package config + +import ( + "fmt" + "testing" + + "github.com/stretchr/testify/require" + + "github.com/cli/cli/v2/internal/gh" + ghConfig "github.com/cli/go-gh/v2/pkg/config" +) + +func newTestConfig() *cfg { + return &cfg{ + cfg: ghConfig.ReadFromString(""), + } +} + +func TestNewConfigProvidesFallback(t *testing.T) { + var spiedCfg *ghConfig.Config + ghConfig.Read = func(fallback *ghConfig.Config) (*ghConfig.Config, error) { + spiedCfg = fallback + return fallback, nil + } + _, err := NewConfig() + require.NoError(t, err) + requireKeyWithValue(t, spiedCfg, []string{versionKey}, "1") + requireKeyWithValue(t, spiedCfg, []string{gitProtocolKey}, "https") + requireKeyWithValue(t, spiedCfg, []string{editorKey}, "") + requireKeyWithValue(t, spiedCfg, []string{promptKey}, "enabled") + requireKeyWithValue(t, spiedCfg, []string{pagerKey}, "") + requireKeyWithValue(t, spiedCfg, []string{aliasesKey, "co"}, "pr checkout") + requireKeyWithValue(t, spiedCfg, []string{httpUnixSocketKey}, "") + requireKeyWithValue(t, spiedCfg, []string{browserKey}, "") +} + +func TestGetOrDefaultApplicationDefaults(t *testing.T) { + tests := []struct { + key string + expectedDefault string + }{ + {gitProtocolKey, "https"}, + {editorKey, ""}, + {promptKey, "enabled"}, + {pagerKey, ""}, + {httpUnixSocketKey, ""}, + {browserKey, ""}, + } + + for _, tt := range tests { + t.Run(tt.key, func(t *testing.T) { + // Given we have no top level configuration + cfg := newTestConfig() + + // When we get a key that has no value, but has a default + optionalEntry := cfg.GetOrDefault("", tt.key) + + // Then there is an entry with the default value, and source set as default + entry := optionalEntry.Expect(fmt.Sprintf("expected there to be a value for %s", tt.key)) + require.Equal(t, tt.expectedDefault, entry.Value) + require.Equal(t, gh.ConfigDefaultProvided, entry.Source) + }) + } +} + +func TestGetOrDefaultNonExistentKey(t *testing.T) { + // Given we have no top level configuration + cfg := newTestConfig() + + // When we get a key that has no value + optionalEntry := cfg.GetOrDefault("", "non-existent-key") + + // Then it returns a None variant + require.True(t, optionalEntry.IsNone(), "expected there to be no value") +} + +func TestGetOrDefaultNonExistentHostSpecificKey(t *testing.T) { + // Given have no top level configuration + cfg := newTestConfig() + + // When we get a key for a host that has no value + optionalEntry := cfg.GetOrDefault("non-existent-host", "non-existent-key") + + // Then it returns a None variant + require.True(t, optionalEntry.IsNone(), "expected there to be no value") +} + +func TestGetOrDefaultExistingTopLevelKey(t *testing.T) { + // Given have a top level config entry + cfg := newTestConfig() + cfg.Set("", "top-level-key", "top-level-value") + + // When we get that key + optionalEntry := cfg.GetOrDefault("non-existent-host", "top-level-key") + + // Then it returns a Some variant containing the correct value and a source of user + entry := optionalEntry.Expect("expected there to be a value") + require.Equal(t, "top-level-value", entry.Value) + require.Equal(t, gh.ConfigUserProvided, entry.Source) +} + +func TestGetOrDefaultExistingHostSpecificKey(t *testing.T) { + // Given have a host specific config entry + cfg := newTestConfig() + cfg.Set("github.com", "host-specific-key", "host-specific-value") + + // When we get that key + optionalEntry := cfg.GetOrDefault("github.com", "host-specific-key") + + // Then it returns a Some variant containing the correct value and a source of user + entry := optionalEntry.Expect("expected there to be a value") + require.Equal(t, "host-specific-value", entry.Value) + require.Equal(t, gh.ConfigUserProvided, entry.Source) +} + +func TestGetOrDefaultHostnameSpecificKeyFallsBackToTopLevel(t *testing.T) { + // Given have a top level config entry + cfg := newTestConfig() + cfg.Set("", "key", "value") + + // When we get that key on a specific host + optionalEntry := cfg.GetOrDefault("github.com", "key") + + // Then it returns a Some variant containing the correct value by falling back + // to the top level config, with a source of user + entry := optionalEntry.Expect("expected there to be a value") + require.Equal(t, "value", entry.Value) + require.Equal(t, gh.ConfigUserProvided, entry.Source) +} + +func TestFallbackConfig(t *testing.T) { + cfg := fallbackConfig() + requireKeyWithValue(t, cfg, []string{gitProtocolKey}, "https") + requireKeyWithValue(t, cfg, []string{editorKey}, "") + requireKeyWithValue(t, cfg, []string{promptKey}, "enabled") + requireKeyWithValue(t, cfg, []string{pagerKey}, "") + requireKeyWithValue(t, cfg, []string{aliasesKey, "co"}, "pr checkout") + requireKeyWithValue(t, cfg, []string{httpUnixSocketKey}, "") + requireKeyWithValue(t, cfg, []string{browserKey}, "") + requireNoKey(t, cfg, []string{"unknown"}) +} + +func TestSetTopLevelKey(t *testing.T) { + c := newTestConfig() + host := "" + key := "top-level-key" + val := "top-level-value" + c.Set(host, key, val) + requireKeyWithValue(t, c.cfg, []string{key}, val) +} + +func TestSetHostSpecificKey(t *testing.T) { + c := newTestConfig() + host := "github.com" + key := "host-level-key" + val := "host-level-value" + c.Set(host, key, val) + requireKeyWithValue(t, c.cfg, []string{hostsKey, host, key}, val) +} + +func TestSetUserSpecificKey(t *testing.T) { + c := newTestConfig() + host := "github.com" + user := "test-user" + c.cfg.Set([]string{hostsKey, host, userKey}, user) + + key := "host-level-key" + val := "host-level-value" + c.Set(host, key, val) + requireKeyWithValue(t, c.cfg, []string{hostsKey, host, key}, val) + requireKeyWithValue(t, c.cfg, []string{hostsKey, host, usersKey, user, key}, val) +} + +func TestSetUserSpecificKeyNoUserPresent(t *testing.T) { + c := newTestConfig() + host := "github.com" + key := "host-level-key" + val := "host-level-value" + c.Set(host, key, val) + requireKeyWithValue(t, c.cfg, []string{hostsKey, host, key}, val) + requireNoKey(t, c.cfg, []string{hostsKey, host, usersKey}) +} diff --git a/internal/config/migrate_test.go b/internal/config/migrate_test.go new file mode 100644 index 000000000..783f605a2 --- /dev/null +++ b/internal/config/migrate_test.go @@ -0,0 +1,262 @@ +package config + +import ( + "bytes" + "errors" + "io" + "os" + "path/filepath" + "testing" + + ghmock "github.com/cli/cli/v2/internal/gh/mock" + ghConfig "github.com/cli/go-gh/v2/pkg/config" + "github.com/stretchr/testify/require" +) + +func TestMigrationAppliedSuccessfully(t *testing.T) { + readConfig := StubWriteConfig(t) + + // Given we have a migrator that writes some keys to the top level config + // and hosts key + c := ghConfig.ReadFromString(testFullConfig()) + + topLevelKey := []string{"toplevelkey"} + newHostKey := []string{hostsKey, "newhost"} + + migration := mockMigration(func(config *ghConfig.Config) error { + config.Set(topLevelKey, "toplevelvalue") + config.Set(newHostKey, "newhostvalue") + return nil + }) + + // When we run the migration + conf := cfg{c} + require.NoError(t, conf.Migrate(migration)) + + // Then our original config is updated with the migration applied + requireKeyWithValue(t, c, topLevelKey, "toplevelvalue") + requireKeyWithValue(t, c, newHostKey, "newhostvalue") + + // And our config / hosts changes are persisted to their relevant files + // Note that this is real janky. We have writers that represent the + // top level config and the hosts key but we don't merge them back together + // so when we look into the hosts data, we don't nest the key we're + // looking for under the hosts key ¯\_(ツ)_/¯ + var configBuf bytes.Buffer + var hostsBuf bytes.Buffer + readConfig(&configBuf, &hostsBuf) + persistedCfg := ghConfig.ReadFromString(configBuf.String()) + persistedHosts := ghConfig.ReadFromString(hostsBuf.String()) + + requireKeyWithValue(t, persistedCfg, topLevelKey, "toplevelvalue") + requireKeyWithValue(t, persistedHosts, []string{"newhost"}, "newhostvalue") +} + +func TestMigrationAppliedBumpsVersion(t *testing.T) { + readConfig := StubWriteConfig(t) + + // Given we have a migration with a pre version that matches + // the version in the config + c := ghConfig.ReadFromString(testFullConfig()) + c.Set([]string{versionKey}, "expected-pre-version") + topLevelKey := []string{"toplevelkey"} + + migration := &ghmock.MigrationMock{ + DoFunc: func(config *ghConfig.Config) error { + config.Set(topLevelKey, "toplevelvalue") + return nil + }, + PreVersionFunc: func() string { + return "expected-pre-version" + }, + PostVersionFunc: func() string { + return "expected-post-version" + }, + } + + // When we migrate + conf := cfg{c} + require.NoError(t, conf.Migrate(migration)) + + // Then our original config is updated with the migration applied + requireKeyWithValue(t, c, topLevelKey, "toplevelvalue") + requireKeyWithValue(t, c, []string{versionKey}, "expected-post-version") + + // And our config / hosts changes are persisted to their relevant files + var configBuf bytes.Buffer + readConfig(&configBuf, io.Discard) + persistedCfg := ghConfig.ReadFromString(configBuf.String()) + + requireKeyWithValue(t, persistedCfg, topLevelKey, "toplevelvalue") + requireKeyWithValue(t, persistedCfg, []string{versionKey}, "expected-post-version") +} + +func TestMigrationIsNoopWhenAlreadyApplied(t *testing.T) { + // Given we have a migration with a post version that matches + // the version in the config + c := ghConfig.ReadFromString(testFullConfig()) + c.Set([]string{versionKey}, "expected-post-version") + + migration := &ghmock.MigrationMock{ + DoFunc: func(config *ghConfig.Config) error { + return errors.New("is not called") + }, + PreVersionFunc: func() string { + return "is not called" + }, + PostVersionFunc: func() string { + return "expected-post-version" + }, + } + + // When we run Migrate + conf := cfg{c} + err := conf.Migrate(migration) + + // Then there is nothing done and the config is not modified + require.NoError(t, err) + requireKeyWithValue(t, c, []string{versionKey}, "expected-post-version") +} + +func TestMigrationErrorsWhenPreVersionMismatch(t *testing.T) { + StubWriteConfig(t) + + // Given we have a migration with a pre version that does not match + // the version in the config + c := ghConfig.ReadFromString(testFullConfig()) + c.Set([]string{versionKey}, "not-expected-pre-version") + topLevelKey := []string{"toplevelkey"} + + migration := &ghmock.MigrationMock{ + DoFunc: func(config *ghConfig.Config) error { + config.Set(topLevelKey, "toplevelvalue") + return nil + }, + PreVersionFunc: func() string { + return "expected-pre-version" + }, + PostVersionFunc: func() string { + return "not-expected" + }, + } + + // When we run Migrate + conf := cfg{c} + err := conf.Migrate(migration) + + // Then there is an error the migration is not applied and the version is not modified + require.ErrorContains(t, err, `failed to migrate as "expected-pre-version" pre migration version did not match config version "not-expected-pre-version"`) + requireNoKey(t, c, topLevelKey) + requireKeyWithValue(t, c, []string{versionKey}, "not-expected-pre-version") +} + +func TestMigrationErrorWritesNoFiles(t *testing.T) { + tempDir := t.TempDir() + t.Setenv("GH_CONFIG_DIR", tempDir) + + // Given we have a migrator that errors + c := ghConfig.ReadFromString(testFullConfig()) + migration := mockMigration(func(config *ghConfig.Config) error { + return errors.New("failed to migrate in test") + }) + + // When we run the migration + conf := cfg{c} + err := conf.Migrate(migration) + + // Then the error is wrapped and bubbled + require.EqualError(t, err, "failed to migrate config: failed to migrate in test") + + // And no files are written to disk + files, err := os.ReadDir(tempDir) + require.NoError(t, err) + require.Len(t, files, 0) +} + +func TestMigrationWriteErrors(t *testing.T) { + tests := []struct { + name string + unwriteableFile string + wantErrContains string + }{ + { + name: "failure to write hosts", + unwriteableFile: "hosts.yml", + wantErrContains: "failed to write config after migration", + }, + { + name: "failure to write config", + unwriteableFile: "config.yml", + wantErrContains: "failed to write config after migration", + }, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + tempDir := t.TempDir() + t.Setenv("GH_CONFIG_DIR", tempDir) + + // Given we error when writing the files (because we chmod the files as trickery) + makeFileUnwriteable(t, filepath.Join(tempDir, tt.unwriteableFile)) + + c := ghConfig.ReadFromString(testFullConfig()) + topLevelKey := []string{"toplevelkey"} + hostsKey := []string{hostsKey, "newhost"} + + migration := mockMigration(func(someCfg *ghConfig.Config) error { + someCfg.Set(topLevelKey, "toplevelvalue") + someCfg.Set(hostsKey, "newhostvalue") + return nil + }) + + // When we run the migration + conf := cfg{c} + err := conf.Migrate(migration) + + // Then the error is wrapped and bubbled + require.ErrorContains(t, err, tt.wantErrContains) + }) + } +} + +func makeFileUnwriteable(t *testing.T, file string) { + t.Helper() + + f, err := os.Create(file) + require.NoError(t, err) + f.Close() + + require.NoError(t, os.Chmod(file, 0000)) +} + +func mockMigration(doFunc func(config *ghConfig.Config) error) *ghmock.MigrationMock { + return &ghmock.MigrationMock{ + DoFunc: doFunc, + PreVersionFunc: func() string { + return "" + }, + PostVersionFunc: func() string { + return "not-expected" + }, + } + +} + +func testFullConfig() string { + var data = ` +git_protocol: ssh +editor: +prompt: enabled +pager: less +hosts: + github.com: + user: user1 + oauth_token: xxxxxxxxxxxxxxxxxxxx + git_protocol: ssh + enterprise.com: + user: user2 + oauth_token: yyyyyyyyyyyyyyyyyyyy + git_protocol: https +` + return data +} diff --git a/internal/config/migration/multi_account.go b/internal/config/migration/multi_account.go new file mode 100644 index 000000000..209912781 --- /dev/null +++ b/internal/config/migration/multi_account.go @@ -0,0 +1,224 @@ +package migration + +import ( + "errors" + "fmt" + "net/http" + + "github.com/cli/cli/v2/internal/keyring" + ghAPI "github.com/cli/go-gh/v2/pkg/api" + "github.com/cli/go-gh/v2/pkg/config" +) + +var noTokenError = errors.New("no token found") + +type CowardlyRefusalError struct { + err error +} + +func (e CowardlyRefusalError) Error() string { + // Consider whether we should add a call to action here like "open an issue with the contents of your redacted hosts.yml" + return fmt.Sprintf("cowardly refusing to continue with multi account migration: %s", e.err.Error()) +} + +var hostsKey = []string{"hosts"} + +type tokenSource struct { + token string + inKeyring bool +} + +// This migration exists to take a hosts section of the following structure: +// +// github.com: +// user: williammartin +// git_protocol: https +// editor: vim +// github.localhost: +// user: monalisa +// git_protocol: https +// oauth_token: xyz +// +// We want this to migrate to something like: +// +// github.com: +// user: williammartin +// git_protocol: https +// editor: vim +// users: +// williammartin: +// +// github.localhost: +// user: monalisa +// git_protocol: https +// oauth_token: xyz +// users: +// monalisa: +// oauth_token: xyz +// +// For each hosts, we will create a new key `users` with the value of the host level +// `user` key as a list entry. If there is a host level `oauth_token` we will +// put that under the new user entry, otherwise there will be no value for the +// new user key. No other host level configuration will be copied to the new user. +// +// The reason for this is that we can then add new users under a host. +// Note that we are only copying the config under a new users key, and +// under a specific user. The original config is left alone. This is to +// allow forward compatibility for older versions of gh and also to avoid +// breaking existing users of go-gh which looks at a specific location +// in the config for oauth tokens that are stored insecurely. + +type MultiAccount struct { + // Allow injecting a transport layer in tests. + Transport http.RoundTripper +} + +func (m MultiAccount) PreVersion() string { + // It is expected that there is no version key since this migration + // introduces it. + return "" +} + +func (m MultiAccount) PostVersion() string { + return "1" +} + +func (m MultiAccount) Do(c *config.Config) error { + hostnames, err := c.Keys(hostsKey) + // [github.com, github.localhost] + // We wouldn't expect to have a hosts key when this is the first time anyone + // is logging in with the CLI. + var keyNotFoundError *config.KeyNotFoundError + if errors.As(err, &keyNotFoundError) { + return nil + } + if err != nil { + return CowardlyRefusalError{errors.New("couldn't get hosts configuration")} + } + + // If there are no hosts then it doesn't matter whether we migrate or not, + // so lets avoid any confusion and say there's no migration required. + if len(hostnames) == 0 { + return nil + } + + // Otherwise let's get to the business of migrating! + for _, hostname := range hostnames { + tokenSource, err := getToken(c, hostname) + // If no token existed for this host we'll remove the entry from the hosts file + // by deleting it and moving on to the next one. + if errors.Is(err, noTokenError) { + // The only error that can be returned here is the key not existing, which + // we know can't be true. + _ = c.Remove(append(hostsKey, hostname)) + continue + } + // For any other error we'll error out + if err != nil { + return CowardlyRefusalError{fmt.Errorf("couldn't find oauth token for %q: %w", hostname, err)} + } + + username, err := getUsername(c, hostname, tokenSource.token, m.Transport) + if err != nil { + issueURL := "https://github.com/cli/cli/issues/8441" + return CowardlyRefusalError{fmt.Errorf("couldn't get user name for %q please visit %s for help: %w", hostname, issueURL, err)} + } + + if err := migrateConfig(c, hostname, username); err != nil { + return CowardlyRefusalError{fmt.Errorf("couldn't migrate config for %q: %w", hostname, err)} + } + + if err := migrateToken(hostname, username, tokenSource); err != nil { + return CowardlyRefusalError{fmt.Errorf("couldn't migrate oauth token for %q: %w", hostname, err)} + } + } + + return nil +} + +func getToken(c *config.Config, hostname string) (tokenSource, error) { + if token, _ := c.Get(append(hostsKey, hostname, "oauth_token")); token != "" { + return tokenSource{token: token, inKeyring: false}, nil + } + token, err := keyring.Get(keyringServiceName(hostname), "") + + // If we have an error and it's not relating to there being no token + // then we'll return the error cause that's really unexpected. + if err != nil && !errors.Is(err, keyring.ErrNotFound) { + return tokenSource{}, err + } + + // Otherwise we'll return a sentinel error + if err != nil || token == "" { + return tokenSource{}, noTokenError + } + + return tokenSource{ + token: token, + inKeyring: true, + }, nil +} + +func getUsername(c *config.Config, hostname, token string, transport http.RoundTripper) (string, error) { + username, _ := c.Get(append(hostsKey, hostname, "user")) + if username != "" && username != "x-access-token" { + return username, nil + } + opts := ghAPI.ClientOptions{ + Host: hostname, + AuthToken: token, + Transport: transport, + } + client, err := ghAPI.NewGraphQLClient(opts) + if err != nil { + return "", err + } + var query struct { + Viewer struct { + Login string + } + } + err = client.Query("CurrentUser", &query, nil) + if err != nil { + return "", err + } + return query.Viewer.Login, nil +} + +func migrateToken(hostname, username string, tokenSource tokenSource) error { + // If token is not currently stored in the keyring do not migrate it, + // as it is being stored in the config and is being handled when migrating the config. + if !tokenSource.inKeyring { + return nil + } + return keyring.Set(keyringServiceName(hostname), username, tokenSource.token) +} + +func migrateConfig(c *config.Config, hostname, username string) error { + // Set the user key in case it was previously an anonymous user. + c.Set(append(hostsKey, hostname, "user"), username) + // Create the username key with an empty value so it will be + // written even if there are no keys set under it. + c.Set(append(hostsKey, hostname, "users", username), "") + + insecureToken, err := c.Get(append(hostsKey, hostname, "oauth_token")) + var keyNotFoundError *config.KeyNotFoundError + // If there is no token then we're done here + if errors.As(err, &keyNotFoundError) { + return nil + } + + // If there's another error (current implementation doesn't have any other error but we'll be defensive) + // then bubble something up. + if err != nil { + return fmt.Errorf("couldn't get oauth token for %s: %s", hostname, err) + } + + // Otherwise we'll set the token under the new key + c.Set(append(hostsKey, hostname, "users", username, "oauth_token"), insecureToken) + return nil +} + +func keyringServiceName(hostname string) string { + return "gh:" + hostname +} diff --git a/internal/config/migration/multi_account_test.go b/internal/config/migration/multi_account_test.go new file mode 100644 index 000000000..8feb853bd --- /dev/null +++ b/internal/config/migration/multi_account_test.go @@ -0,0 +1,249 @@ +package migration_test + +import ( + "errors" + "fmt" + "testing" + + "github.com/cli/cli/v2/internal/config/migration" + "github.com/cli/cli/v2/internal/keyring" + "github.com/cli/cli/v2/pkg/httpmock" + "github.com/cli/go-gh/v2/pkg/config" + "github.com/stretchr/testify/require" +) + +func TestMigration(t *testing.T) { + cfg := config.ReadFromString(` +hosts: + github.com: + user: user1 + oauth_token: xxxxxxxxxxxxxxxxxxxx + git_protocol: ssh + enterprise.com: + user: user2 + oauth_token: yyyyyyyyyyyyyyyyyyyy + git_protocol: https +`) + + var m migration.MultiAccount + require.NoError(t, m.Do(cfg)) + + // First we'll check that the oauth tokens have been moved to their new locations + requireKeyWithValue(t, cfg, []string{"hosts", "github.com", "users", "user1", "oauth_token"}, "xxxxxxxxxxxxxxxxxxxx") + requireKeyWithValue(t, cfg, []string{"hosts", "enterprise.com", "users", "user2", "oauth_token"}, "yyyyyyyyyyyyyyyyyyyy") + + // Then we'll check that the old data has been left alone + requireKeyWithValue(t, cfg, []string{"hosts", "github.com", "user"}, "user1") + requireKeyWithValue(t, cfg, []string{"hosts", "github.com", "oauth_token"}, "xxxxxxxxxxxxxxxxxxxx") + requireKeyWithValue(t, cfg, []string{"hosts", "github.com", "git_protocol"}, "ssh") + + requireKeyWithValue(t, cfg, []string{"hosts", "enterprise.com", "user"}, "user2") + requireKeyWithValue(t, cfg, []string{"hosts", "enterprise.com", "oauth_token"}, "yyyyyyyyyyyyyyyyyyyy") + requireKeyWithValue(t, cfg, []string{"hosts", "enterprise.com", "git_protocol"}, "https") +} + +func TestMigrationSecureStorage(t *testing.T) { + cfg := config.ReadFromString(` +hosts: + github.com: + user: userOne + git_protocol: ssh + enterprise.com: + user: userTwo + git_protocol: https +`) + + userOneToken := "userOne-token" + userTwoToken := "userTwo-token" + + keyring.MockInit() + require.NoError(t, keyring.Set("gh:github.com", "", userOneToken)) + require.NoError(t, keyring.Set("gh:enterprise.com", "", userTwoToken)) + + var m migration.MultiAccount + require.NoError(t, m.Do(cfg)) + + // Verify token gets stored with host and username + gotUserOneToken, err := keyring.Get("gh:github.com", "userOne") + require.NoError(t, err) + require.Equal(t, userOneToken, gotUserOneToken) + + // Verify token still exists with only host + gotUserOneToken, err = keyring.Get("gh:github.com", "") + require.NoError(t, err) + require.Equal(t, userOneToken, gotUserOneToken) + + // Verify token gets stored with host and username + gotUserTwoToken, err := keyring.Get("gh:enterprise.com", "userTwo") + require.NoError(t, err) + require.Equal(t, userTwoToken, gotUserTwoToken) + + // Verify token still exists with only host + gotUserTwoToken, err = keyring.Get("gh:enterprise.com", "") + require.NoError(t, err) + require.Equal(t, userTwoToken, gotUserTwoToken) + + // First we'll check that the users have been created with no config underneath them + requireKeyExists(t, cfg, []string{"hosts", "github.com", "users", "userOne"}) + requireKeyExists(t, cfg, []string{"hosts", "enterprise.com", "users", "userTwo"}) + + // Then we'll check that the old data has been left alone + requireKeyWithValue(t, cfg, []string{"hosts", "github.com", "user"}, "userOne") + requireKeyWithValue(t, cfg, []string{"hosts", "github.com", "git_protocol"}, "ssh") + + requireKeyWithValue(t, cfg, []string{"hosts", "enterprise.com", "user"}, "userTwo") + requireKeyWithValue(t, cfg, []string{"hosts", "enterprise.com", "git_protocol"}, "https") +} + +func TestPreVersionIsEmptyString(t *testing.T) { + var m migration.MultiAccount + require.Equal(t, "", m.PreVersion()) +} + +func TestPostVersion(t *testing.T) { + var m migration.MultiAccount + require.Equal(t, "1", m.PostVersion()) +} + +func TestMigrationReturnsSuccessfullyWhenNoHostsEntry(t *testing.T) { + cfg := config.ReadFromString(``) + + var m migration.MultiAccount + require.NoError(t, m.Do(cfg)) +} + +func TestMigrationReturnsSuccessfullyWhenEmptyHosts(t *testing.T) { + cfg := config.ReadFromString(` +hosts: +`) + + var m migration.MultiAccount + require.NoError(t, m.Do(cfg)) +} + +func TestMigrationReturnsSuccessfullyWhenAnonymousUserExists(t *testing.T) { + // Simulates config that gets generated when a user logs + // in with a token and git protocol is not specified and + // secure storage is used. + token := "test-token" + keyring.MockInit() + require.NoError(t, keyring.Set("gh:github.com", "", token)) + + cfg := config.ReadFromString(` +hosts: + github.com: + user: x-access-token +`) + + reg := &httpmock.Registry{} + defer reg.Verify(t) + reg.Register( + httpmock.GraphQL(`query CurrentUser\b`), + httpmock.StringResponse(`{"data":{"viewer":{"login":"monalisa"}}}`), + ) + + m := migration.MultiAccount{Transport: reg} + require.NoError(t, m.Do(cfg)) + + require.Equal(t, fmt.Sprintf("token %s", token), reg.Requests[0].Header.Get("Authorization")) + requireKeyWithValue(t, cfg, []string{"hosts", "github.com", "user"}, "monalisa") + // monalisa key gets created with no value + users, err := cfg.Keys([]string{"hosts", "github.com", "users"}) + require.NoError(t, err) + require.Equal(t, []string{"monalisa"}, users) + + // Verify token gets stored with host and username + gotToken, err := keyring.Get("gh:github.com", "monalisa") + require.NoError(t, err) + require.Equal(t, token, gotToken) + + // Verify token still exists with only host + gotToken, err = keyring.Get("gh:github.com", "") + require.NoError(t, err) + require.Equal(t, token, gotToken) +} + +func TestMigrationReturnsSuccessfullyWhenAnonymousUserExistsAndInsecureStorage(t *testing.T) { + // Simulates config that gets generated when a user logs + // in with a token and git protocol is specified and + // secure storage is not used. + cfg := config.ReadFromString(` +hosts: + github.com: + user: x-access-token + oauth_token: test-token + git_protocol: ssh +`) + + reg := &httpmock.Registry{} + defer reg.Verify(t) + reg.Register( + httpmock.GraphQL(`query CurrentUser\b`), + httpmock.StringResponse(`{"data":{"viewer":{"login":"monalisa"}}}`), + ) + + m := migration.MultiAccount{Transport: reg} + require.NoError(t, m.Do(cfg)) + + require.Equal(t, "token test-token", reg.Requests[0].Header.Get("Authorization")) + requireKeyWithValue(t, cfg, []string{"hosts", "github.com", "user"}, "monalisa") + requireKeyWithValue(t, cfg, []string{"hosts", "github.com", "users", "monalisa", "oauth_token"}, "test-token") +} + +func TestMigrationRemovesHostsWithInvalidTokens(t *testing.T) { + // Simulates config when user is logged in securely + // but no token entry is in the keyring. + keyring.MockInit() + cfg := config.ReadFromString(` +hosts: + github.com: + user: user1 + git_protocol: ssh +`) + + m := migration.MultiAccount{} + require.NoError(t, m.Do(cfg)) + + requireNoKey(t, cfg, []string{"hosts", "github.com"}) +} + +func TestMigrationErrorsWhenUnableToGetExpectedSecureToken(t *testing.T) { + // Simulates config when user is logged in securely + // but no token entry is in the keyring. + keyring.MockInitWithError(errors.New("keyring test error")) + cfg := config.ReadFromString(` +hosts: + github.com: + user: user1 + git_protocol: ssh +`) + + m := migration.MultiAccount{} + err := m.Do(cfg) + + require.ErrorContains(t, err, `couldn't find oauth token for "github.com": keyring test error`) +} + +func requireKeyExists(t *testing.T, cfg *config.Config, keys []string) { + t.Helper() + + _, err := cfg.Get(keys) + require.NoError(t, err) +} + +func requireKeyWithValue(t *testing.T, cfg *config.Config, keys []string, value string) { + t.Helper() + + actual, err := cfg.Get(keys) + require.NoError(t, err) + + require.Equal(t, value, actual) +} + +func requireNoKey(t *testing.T, cfg *config.Config, keys []string) { + t.Helper() + + _, err := cfg.Get(keys) + var keyNotFoundError *config.KeyNotFoundError + require.ErrorAs(t, err, &keyNotFoundError) +} diff --git a/internal/config/stub.go b/internal/config/stub.go index 5e37a8ccb..c89868721 100644 --- a/internal/config/stub.go +++ b/internal/config/stub.go @@ -6,38 +6,22 @@ import ( "path/filepath" "testing" + "github.com/cli/cli/v2/internal/gh" + ghmock "github.com/cli/cli/v2/internal/gh/mock" + "github.com/cli/cli/v2/internal/keyring" + o "github.com/cli/cli/v2/pkg/option" ghConfig "github.com/cli/go-gh/v2/pkg/config" ) -func NewBlankConfig() *ConfigMock { - defaultStr := ` -# What protocol to use when performing git operations. Supported values: ssh, https -git_protocol: https -# What editor gh should run when creating issues, pull requests, etc. If blank, will refer to environment. -editor: -# When to interactively prompt. This is a global config that cannot be overridden by hostname. Supported values: enabled, disabled -prompt: enabled -# A pager program to send command output to, e.g. "less". Set the value to "cat" to disable the pager. -pager: -# Aliases allow you to create nicknames for gh commands -aliases: - co: pr checkout -# The path to a unix socket through which send HTTP connections. If blank, HTTP traffic will be handled by net/http.DefaultTransport. -http_unix_socket: -# What web browser gh should use when opening URLs. If blank, will refer to environment. -browser: -` - return NewFromString(defaultStr) +func NewBlankConfig() *ghmock.ConfigMock { + return NewFromString(defaultConfigStr) } -func NewFromString(cfgStr string) *ConfigMock { +func NewFromString(cfgStr string) *ghmock.ConfigMock { c := ghConfig.ReadFromString(cfgStr) cfg := cfg{c} - mock := &ConfigMock{} - mock.GetFunc = func(host, key string) (string, error) { - return cfg.Get(host, key) - } - mock.GetOrDefaultFunc = func(host, key string) (string, error) { + mock := &ghmock.ConfigMock{} + mock.GetOrDefaultFunc = func(host, key string) o.Option[gh.ConfigEntry] { return cfg.GetOrDefault(host, key) } mock.SetFunc = func(host, key, value string) { @@ -46,28 +30,86 @@ func NewFromString(cfgStr string) *ConfigMock { mock.WriteFunc = func() error { return cfg.Write() } - mock.AliasesFunc = func() *AliasConfig { + mock.MigrateFunc = func(m gh.Migration) error { + return cfg.Migrate(m) + } + mock.AliasesFunc = func() gh.AliasConfig { return &AliasConfig{cfg: c} } - mock.AuthenticationFunc = func() *AuthConfig { + mock.AuthenticationFunc = func() gh.AuthConfig { return &AuthConfig{ cfg: c, defaultHostOverride: func() (string, string) { return "github.com", "default" }, hostsOverride: func() []string { - keys, _ := c.Keys([]string{"hosts"}) + keys, _ := c.Keys([]string{hostsKey}) return keys }, tokenOverride: func(hostname string) (string, string) { - token, _ := c.Get([]string{hosts, hostname, oauthToken}) - return token, "oauth_token" + token, _ := c.Get([]string{hostsKey, hostname, oauthTokenKey}) + return token, oauthTokenKey }, } } + mock.BrowserFunc = func(hostname string) gh.ConfigEntry { + return cfg.Browser(hostname) + } + mock.EditorFunc = func(hostname string) gh.ConfigEntry { + return cfg.Editor(hostname) + } + mock.GitProtocolFunc = func(hostname string) gh.ConfigEntry { + return cfg.GitProtocol(hostname) + } + mock.HTTPUnixSocketFunc = func(hostname string) gh.ConfigEntry { + return cfg.HTTPUnixSocket(hostname) + } + mock.PagerFunc = func(hostname string) gh.ConfigEntry { + return cfg.Pager(hostname) + } + mock.PromptFunc = func(hostname string) gh.ConfigEntry { + return cfg.Prompt(hostname) + } + mock.VersionFunc = func() o.Option[string] { + return cfg.Version() + } + mock.CacheDirFunc = func() string { + return cfg.CacheDir() + } return mock } +// NewIsolatedTestConfig sets up a Mock keyring, creates a blank config +// overwrites the ghConfig.Read function that returns a singleton config +// in the real implementation, sets the GH_CONFIG_DIR env var so that +// any call to Write goes to a different location on disk, and then returns +// the blank config and a function that reads any data written to disk. +func NewIsolatedTestConfig(t *testing.T) (*cfg, func(io.Writer, io.Writer)) { + keyring.MockInit() + + c := ghConfig.ReadFromString("") + cfg := cfg{c} + + // The real implementation of config.Read uses a sync.Once + // to read config files and initialise package level variables + // that are used from then on. + // + // This means that tests can't be isolated from each other, so + // we swap out the function here to return a new config each time. + ghConfig.Read = func(_ *ghConfig.Config) (*ghConfig.Config, error) { + return c, nil + } + + // The config.Write method isn't defined in the same way as Read to allow + // the function to be swapped out and it does try to write to disk. + // + // We should consider whether it makes sense to change that but in the meantime + // we can use GH_CONFIG_DIR env var to ensure the tests remain isolated. + readConfigs := StubWriteConfig(t) + + return &cfg, readConfigs +} + // StubWriteConfig stubs out the filesystem where config file are written. // It then returns a function that will read in the config files into io.Writers. // It automatically cleans up environment variables and written files. diff --git a/internal/docs/docs_test.go b/internal/docs/docs_test.go index ad1b32631..71c0186a9 100644 --- a/internal/docs/docs_test.go +++ b/internal/docs/docs_test.go @@ -26,6 +26,10 @@ func init() { printCmd.Flags().IntP("intthree", "i", 345, "help message for flag intthree") printCmd.Flags().BoolP("boolthree", "b", true, "help message for flag boolthree") + jsonCmd.Flags().StringSlice("json", nil, "help message for flag json") + + aliasCmd.Flags().StringSlice("yang", nil, "help message for flag yang") + echoCmd.AddCommand(timesCmd, echoSubCmd, deprecatedCmd) rootCmd.AddCommand(printCmd, echoCmd, dummyCmd) } @@ -73,6 +77,21 @@ var printCmd = &cobra.Command{ Long: `an absolutely utterly useless command for testing.`, } +var aliasCmd = &cobra.Command{ + Use: "ying [yang]", + Short: "The ying and yang of it all", + Long: "an absolutely utterly useless command for testing aliases!.", + Aliases: []string{"yoo", "foo"}, +} + +var jsonCmd = &cobra.Command{ + Use: "blah --json ", + Short: "View details in JSON", + Annotations: map[string]string{ + "help:json-fields": "foo,bar,baz", + }, +} + var dummyCmd = &cobra.Command{ Use: "dummy [action]", Short: "Performs a dummy action", diff --git a/internal/docs/man.go b/internal/docs/man.go index 4864140f1..5ac353a46 100644 --- a/internal/docs/man.go +++ b/internal/docs/man.go @@ -10,6 +10,7 @@ import ( "strings" "time" + "github.com/cli/cli/v2/internal/text" "github.com/cli/cli/v2/pkg/cmd/root" "github.com/cpuguy83/go-md2man/v2/md2man" "github.com/spf13/cobra" @@ -149,10 +150,15 @@ func manPrintFlags(buf *bytes.Buffer, flags *pflag.FlagSet) { } else { buf.WriteString(fmt.Sprintf("`--%s`", flag.Name)) } - if varname == "" { + + defval := getDefaultValueDisplayString(flag) + + if varname == "" && defval != "" { + buf.WriteString(fmt.Sprintf(" `%s`\n", strings.TrimSpace(defval))) + } else if varname == "" { buf.WriteString("\n") } else { - buf.WriteString(fmt.Sprintf(" `<%s>`\n", varname)) + buf.WriteString(fmt.Sprintf(" `<%s>%s`\n", varname, defval)) } buf.WriteString(fmt.Sprintf(": %s\n\n", usage)) }) @@ -173,6 +179,25 @@ func manPrintOptions(buf *bytes.Buffer, command *cobra.Command) { } } +func manPrintAliases(buf *bytes.Buffer, command *cobra.Command) { + if len(command.Aliases) > 0 { + buf.WriteString("# ALIASES\n") + buf.WriteString(strings.Join(root.BuildAliasList(command, command.Aliases), ", ")) + buf.WriteString("\n") + } +} + +func manPrintJSONFields(buf *bytes.Buffer, command *cobra.Command) { + raw, ok := command.Annotations["help:json-fields"] + if !ok { + return + } + + buf.WriteString("# JSON FIELDS\n") + buf.WriteString(text.FormatSlice(strings.Split(raw, ","), 0, 0, "`", "`", true)) + buf.WriteString("\n") +} + func genMan(cmd *cobra.Command, header *GenManHeader) []byte { cmd.InitDefaultHelpCmd() cmd.InitDefaultHelpFlag() @@ -190,6 +215,8 @@ func genMan(cmd *cobra.Command, header *GenManHeader) []byte { } } manPrintOptions(buf, cmd) + manPrintAliases(buf, cmd) + manPrintJSONFields(buf, cmd) if len(cmd.Example) > 0 { buf.WriteString("# EXAMPLE\n") buf.WriteString(fmt.Sprintf("```\n%s\n```\n", cmd.Example)) diff --git a/internal/docs/man_test.go b/internal/docs/man_test.go index 84fc8cc57..2a0f6a7f7 100644 --- a/internal/docs/man_test.go +++ b/internal/docs/man_test.go @@ -98,6 +98,37 @@ func TestGenManSeeAlso(t *testing.T) { } } +func TestGenManAliases(t *testing.T) { + buf := new(bytes.Buffer) + header := &GenManHeader{} + if err := renderMan(aliasCmd, header, buf); err != nil { + t.Fatal(err) + } + + output := buf.String() + + checkStringContains(t, output, translate(aliasCmd.Name())) + checkStringContains(t, output, "ALIASES") + checkStringContains(t, output, "foo") + checkStringContains(t, output, "yoo") +} + +func TestGenManJSONFields(t *testing.T) { + buf := new(bytes.Buffer) + header := &GenManHeader{} + if err := renderMan(jsonCmd, header, buf); err != nil { + t.Fatal(err) + } + + output := buf.String() + + checkStringContains(t, output, translate(jsonCmd.Name())) + checkStringContains(t, output, "JSON FIELDS") + checkStringContains(t, output, "foo") + checkStringContains(t, output, "bar") + checkStringContains(t, output, "baz") +} + func TestManPrintFlagsHidesShortDeprecated(t *testing.T) { c := &cobra.Command{} c.Flags().StringP("foo", "f", "default", "Foo flag") @@ -107,7 +138,7 @@ func TestManPrintFlagsHidesShortDeprecated(t *testing.T) { manPrintFlags(buf, c.Flags()) got := buf.String() - expected := "`--foo` ``\n: Foo flag\n\n" + expected := "`--foo` ` (default \"default\")`\n: Foo flag\n\n" if got != expected { t.Errorf("Expected %q, got %q", expected, got) } @@ -130,6 +161,107 @@ func TestGenManTree(t *testing.T) { } } +func TestManPrintFlagsShowsDefaultValues(t *testing.T) { + type TestOptions struct { + Limit int + Template string + Fork bool + NoArchive bool + Topic []string + } + opts := TestOptions{} + // Int flag should show it + c := &cobra.Command{} + c.Flags().IntVar(&opts.Limit, "limit", 30, "Some limit") + + buf := new(bytes.Buffer) + manPrintFlags(buf, c.Flags()) + + got := buf.String() + expected := "`--limit` ` (default 30)`\n: Some limit\n\n" + if got != expected { + t.Errorf("Expected %q, got %q", expected, got) + } + + // Bool flag should hide it if default is false + c = &cobra.Command{} + c.Flags().BoolVar(&opts.Fork, "fork", false, "Show only forks") + + buf = new(bytes.Buffer) + manPrintFlags(buf, c.Flags()) + + got = buf.String() + expected = "`--fork`\n: Show only forks\n\n" + if got != expected { + t.Errorf("Expected %q, got %q", expected, got) + } + + // Bool flag should show it if default is true + c = &cobra.Command{} + c.Flags().BoolVar(&opts.NoArchive, "no-archived", true, "Hide archived") + + buf = new(bytes.Buffer) + manPrintFlags(buf, c.Flags()) + + got = buf.String() + expected = "`--no-archived` `(default true)`\n: Hide archived\n\n" + if got != expected { + t.Errorf("Expected %q, got %q", expected, got) + } + + // String flag should show it if default is not an empty string + c = &cobra.Command{} + c.Flags().StringVar(&opts.Template, "template", "T1", "Some template") + + buf = new(bytes.Buffer) + manPrintFlags(buf, c.Flags()) + + got = buf.String() + expected = "`--template` ` (default \"T1\")`\n: Some template\n\n" + if got != expected { + t.Errorf("Expected %q, got %q", expected, got) + } + + // String flag should hide it if default is an empty string + c = &cobra.Command{} + c.Flags().StringVar(&opts.Template, "template", "", "Some template") + + buf = new(bytes.Buffer) + manPrintFlags(buf, c.Flags()) + + got = buf.String() + expected = "`--template` ``\n: Some template\n\n" + if got != expected { + t.Errorf("Expected %q, got %q", expected, got) + } + + // String slice flag should hide it if default is an empty slice + c = &cobra.Command{} + c.Flags().StringSliceVar(&opts.Topic, "topic", nil, "Some topics") + + buf = new(bytes.Buffer) + manPrintFlags(buf, c.Flags()) + + got = buf.String() + expected = "`--topic` ``\n: Some topics\n\n" + if got != expected { + t.Errorf("Expected %q, got %q", expected, got) + } + + // String slice flag should show it if default is not an empty slice + c = &cobra.Command{} + c.Flags().StringSliceVar(&opts.Topic, "topic", []string{"apples", "oranges"}, "Some topics") + + buf = new(bytes.Buffer) + manPrintFlags(buf, c.Flags()) + + got = buf.String() + expected = "`--topic` ` (default [apples,oranges])`\n: Some topics\n\n" + if got != expected { + t.Errorf("Expected %q, got %q", expected, got) + } +} + func assertLineFound(scanner *bufio.Scanner, expectedLine string) error { for scanner.Scan() { line := scanner.Text() diff --git a/internal/docs/markdown.go b/internal/docs/markdown.go index 41fe3a1fd..825db931c 100644 --- a/internal/docs/markdown.go +++ b/internal/docs/markdown.go @@ -8,12 +8,33 @@ import ( "path/filepath" "strings" + "github.com/cli/cli/v2/internal/text" "github.com/cli/cli/v2/pkg/cmd/root" "github.com/spf13/cobra" "github.com/spf13/cobra/doc" "github.com/spf13/pflag" ) +func printJSONFields(w io.Writer, cmd *cobra.Command) { + raw, ok := cmd.Annotations["help:json-fields"] + if !ok { + return + } + + fmt.Fprint(w, "### JSON Fields\n\n") + fmt.Fprint(w, text.FormatSlice(strings.Split(raw, ","), 0, 0, "`", "`", true)) + fmt.Fprint(w, "\n\n") +} + +func printAliases(w io.Writer, cmd *cobra.Command) { + if len(cmd.Aliases) > 0 { + fmt.Fprintf(w, "### ALIASES\n\n") + fmt.Fprint(w, text.FormatSlice(strings.Split(strings.Join(root.BuildAliasList(cmd, cmd.Aliases), ", "), ","), 0, 0, "", "", true)) + fmt.Fprint(w, "\n\n") + } + +} + func printOptions(w io.Writer, cmd *cobra.Command) error { flags := cmd.NonInheritedFlags() flags.SetOutput(w) @@ -46,17 +67,43 @@ func hasNonHelpFlags(fs *pflag.FlagSet) (found bool) { return } +var hiddenFlagDefaults = map[string]bool{ + "false": true, + "": true, + "[]": true, + "0s": true, +} + +var defaultValFormats = map[string]string{ + "string": " (default \"%s\")", + "duration": " (default \"%s\")", +} + +func getDefaultValueDisplayString(f *pflag.Flag) string { + + if hiddenFlagDefaults[f.DefValue] || hiddenFlagDefaults[f.Value.Type()] { + return "" + } + + if dvf, found := defaultValFormats[f.Value.Type()]; found { + return fmt.Sprintf(dvf, f.Value) + } + return fmt.Sprintf(" (default %s)", f.Value) + +} + type flagView struct { Name string Varname string Shorthand string + DefValue string Usage string } var flagsTemplate = `
{{ range . }} -
{{ if .Shorthand }}-{{.Shorthand}}, {{ end -}} - --{{.Name}}{{ if .Varname }} <{{.Varname}}>{{ end }}
+
{{ if .Shorthand }}-{{.Shorthand}}, {{ end }} + --{{.Name}}{{ if .Varname }} <{{.Varname}}>{{ end }}{{.DefValue}}
{{.Usage}}
{{ end }}
` @@ -70,10 +117,12 @@ func printFlagsHTML(w io.Writer, fs *pflag.FlagSet) error { return } varname, usage := pflag.UnquoteUsage(f) + flags = append(flags, flagView{ Name: f.Name, Varname: varname, Shorthand: f.Shorthand, + DefValue: getDefaultValueDisplayString(f), Usage: usage, }) }) @@ -107,6 +156,8 @@ func genMarkdownCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string) if err := printOptions(w, cmd); err != nil { return err } + printAliases(w, cmd) + printJSONFields(w, cmd) fmt.Fprint(w, "{% endraw %}\n") if len(cmd.Example) > 0 { diff --git a/internal/docs/markdown_test.go b/internal/docs/markdown_test.go index 997029205..59cb2b34d 100644 --- a/internal/docs/markdown_test.go +++ b/internal/docs/markdown_test.go @@ -70,6 +70,35 @@ func TestGenMdNoHiddenParents(t *testing.T) { checkStringOmits(t, output, "Options inherited from parent commands") } +func TestGenMdAliases(t *testing.T) { + buf := new(bytes.Buffer) + if err := genMarkdownCustom(aliasCmd, buf, nil); err != nil { + t.Fatal(err) + } + output := buf.String() + + checkStringContains(t, output, aliasCmd.Long) + checkStringContains(t, output, jsonCmd.Example) + checkStringContains(t, output, "ALIASES") + checkStringContains(t, output, "yoo") + checkStringContains(t, output, "foo") +} + +func TestGenMdJSONFields(t *testing.T) { + buf := new(bytes.Buffer) + if err := genMarkdownCustom(jsonCmd, buf, nil); err != nil { + t.Fatal(err) + } + output := buf.String() + + checkStringContains(t, output, jsonCmd.Long) + checkStringContains(t, output, jsonCmd.Example) + checkStringContains(t, output, "JSON Fields") + checkStringContains(t, output, "`foo`") + checkStringContains(t, output, "`bar`") + checkStringContains(t, output, "`baz`") +} + func TestGenMdTree(t *testing.T) { c := &cobra.Command{Use: "do [OPTIONS] arg1 arg2"} tmpdir, err := os.MkdirTemp("", "test-gen-md-tree") @@ -103,3 +132,115 @@ func BenchmarkGenMarkdownToFile(b *testing.B) { } } } + +func TestPrintFlagsHTMLShowsDefaultValues(t *testing.T) { + + type TestOptions struct { + Limit int + Template string + Fork bool + NoArchive bool + Topic []string + } + opts := TestOptions{} + + // Int flag should show it + c := &cobra.Command{} + c.Flags().IntVar(&opts.Limit, "limit", 30, "Some limit") + flags := c.NonInheritedFlags() + buf := new(bytes.Buffer) + flags.SetOutput(buf) + + if err := printFlagsHTML(buf, flags); err != nil { + t.Fatalf("printFlagsHTML failed: %s", err.Error()) + } + output := buf.String() + + checkStringContains(t, output, "(default 30)") + + // Bool flag should hide it if default is false + c = &cobra.Command{} + c.Flags().BoolVar(&opts.Fork, "fork", false, "Show only forks") + + flags = c.NonInheritedFlags() + buf = new(bytes.Buffer) + flags.SetOutput(buf) + + if err := printFlagsHTML(buf, flags); err != nil { + t.Fatalf("printFlagsHTML failed: %s", err.Error()) + } + output = buf.String() + + checkStringOmits(t, output, "(default ") + + // Bool flag should show it if default is true + c = &cobra.Command{} + c.Flags().BoolVar(&opts.NoArchive, "no-archived", true, "Hide archived") + flags = c.NonInheritedFlags() + buf = new(bytes.Buffer) + flags.SetOutput(buf) + + if err := printFlagsHTML(buf, flags); err != nil { + t.Fatalf("printFlagsHTML failed: %s", err.Error()) + } + output = buf.String() + + checkStringContains(t, output, "(default true)") + + // String flag should show it if default is not an empty string + c = &cobra.Command{} + c.Flags().StringVar(&opts.Template, "template", "T1", "Some template") + flags = c.NonInheritedFlags() + buf = new(bytes.Buffer) + flags.SetOutput(buf) + + if err := printFlagsHTML(buf, flags); err != nil { + t.Fatalf("printFlagsHTML failed: %s", err.Error()) + } + output = buf.String() + + checkStringContains(t, output, "(default "T1")") + + // String flag should hide it if default is an empty string + c = &cobra.Command{} + c.Flags().StringVar(&opts.Template, "template", "", "Some template") + + flags = c.NonInheritedFlags() + buf = new(bytes.Buffer) + flags.SetOutput(buf) + + if err := printFlagsHTML(buf, flags); err != nil { + t.Fatalf("printFlagsHTML failed: %s", err.Error()) + } + output = buf.String() + + checkStringOmits(t, output, "(default ") + + // String slice flag should hide it if default is an empty slice + c = &cobra.Command{} + c.Flags().StringSliceVar(&opts.Topic, "topic", nil, "Some topics") + flags = c.NonInheritedFlags() + buf = new(bytes.Buffer) + flags.SetOutput(buf) + + if err := printFlagsHTML(buf, flags); err != nil { + t.Fatalf("printFlagsHTML failed: %s", err.Error()) + } + output = buf.String() + + checkStringOmits(t, output, "(default ") + + // String slice flag should show it if default is not an empty slice + c = &cobra.Command{} + c.Flags().StringSliceVar(&opts.Topic, "topic", []string{"apples", "oranges"}, "Some topics") + flags = c.NonInheritedFlags() + buf = new(bytes.Buffer) + flags.SetOutput(buf) + + if err := printFlagsHTML(buf, flags); err != nil { + t.Fatalf("printFlagsHTML failed: %s", err.Error()) + } + output = buf.String() + + checkStringContains(t, output, "(default [apples,oranges])") +} diff --git a/internal/featuredetection/feature_detection.go b/internal/featuredetection/feature_detection.go index d289d025f..396d1eb5b 100644 --- a/internal/featuredetection/feature_detection.go +++ b/internal/featuredetection/feature_detection.go @@ -25,7 +25,7 @@ var allIssueFeatures = IssueFeatures{ type PullRequestFeatures struct { MergeQueue bool // CheckRunAndStatusContextCounts indicates whether the API supports - // the checkRunCount, checkRunCountsByState, statusContextCount and stausContextCountsByState + // the checkRunCount, checkRunCountsByState, statusContextCount and statusContextCountsByState // fields on the StatusCheckRollupContextConnection CheckRunAndStatusContextCounts bool CheckRunEvent bool diff --git a/internal/gh/gh.go b/internal/gh/gh.go new file mode 100644 index 000000000..a6db43d66 --- /dev/null +++ b/internal/gh/gh.go @@ -0,0 +1,171 @@ +// Package gh provides types that represent the domain of the CLI application. +// +// For example, the CLI expects to be able to get and set user configuration in order to perform its functionality, +// so the Config interface is defined here, though the concrete implementation lives elsewhere. Though the current +// implementation of config writes to certain files on disk, that is an implementation detail compared to the contract +// laid out in the interface here. +// +// Currently this package is in an early state but we could imagine other domain concepts living here for interacting +// with git or GitHub. +package gh + +import ( + o "github.com/cli/cli/v2/pkg/option" + ghConfig "github.com/cli/go-gh/v2/pkg/config" +) + +type ConfigSource string + +const ( + ConfigDefaultProvided ConfigSource = "default" + ConfigUserProvided ConfigSource = "user" +) + +type ConfigEntry struct { + Value string + Source ConfigSource +} + +// A Config implements persistent storage and modification of application configuration. +// +//go:generate moq -rm -pkg ghmock -out mock/config.go . Config +type Config interface { + // GetOrDefault provides primitive access for fetching configuration values, optionally scoped by host. + GetOrDefault(hostname string, key string) o.Option[ConfigEntry] + // Set provides primitive access for setting configuration values, optionally scoped by host. + Set(hostname string, key string, value string) + + // Browser returns the configured browser, optionally scoped by host. + Browser(hostname string) ConfigEntry + // Editor returns the configured editor, optionally scoped by host. + Editor(hostname string) ConfigEntry + // GitProtocol returns the configured git protocol, optionally scoped by host. + GitProtocol(hostname string) ConfigEntry + // HTTPUnixSocket returns the configured HTTP unix socket, optionally scoped by host. + HTTPUnixSocket(hostname string) ConfigEntry + // Pager returns the configured Pager, optionally scoped by host. + Pager(hostname string) ConfigEntry + // Prompt returns the configured prompt, optionally scoped by host. + Prompt(hostname string) ConfigEntry + + // Aliases provides persistent storage and modification of command aliases. + Aliases() AliasConfig + + // Authentication provides persistent storage and modification of authentication configuration. + Authentication() AuthConfig + + // CacheDir returns the directory where the cacheable artifacts can be persisted. + CacheDir() string + + // Migrate applies a migration to the configuration. + Migrate(Migration) error + + // Version returns the current schema version of the configuration. + Version() o.Option[string] + + // Write persists modifications to the configuration. + Write() error +} + +// Migration is the interface that config migrations must implement. +// +// Migrations will receive a copy of the config, and should modify that copy +// as necessary. After migration has completed, the modified config contents +// will be used. +// +// The calling code is expected to verify that the current version of the config +// matches the PreVersion of the migration before calling Do, and will set the +// config version to the PostVersion after the migration has completed successfully. +// +//go:generate moq -rm -pkg ghmock -out mock/migration.go . Migration +type Migration interface { + // PreVersion is the required config version for this to be applied + PreVersion() string + // PostVersion is the config version that must be applied after migration + PostVersion() string + // Do is expected to apply any necessary changes to the config in place + Do(*ghConfig.Config) error +} + +// AuthConfig is used for interacting with some persistent configuration for gh, +// with knowledge on how to access encrypted storage when neccesarry. +// Behavior is scoped to authentication specific tasks. +type AuthConfig interface { + // ActiveToken will retrieve the active auth token for the given hostname, searching environment variables, + // general configuration, and finally encrypted storage. + ActiveToken(hostname string) (token string, source string) + + // HasEnvToken returns true when a token has been specified in an environment variable, else returns false. + HasEnvToken() bool + + // TokenFromKeyring will retrieve the auth token for the given hostname, only searching in encrypted storage. + TokenFromKeyring(hostname string) (token string, err error) + + // TokenFromKeyringForUser will retrieve the auth token for the given hostname and username, only searching + // in encrypted storage. + // + // An empty username will return an error because the potential to return the currently active token under + // surprising cases is just too high to risk compared to the utility of having the function being smart. + TokenFromKeyringForUser(hostname, username string) (token string, err error) + + // ActiveUser will retrieve the username for the active user at the given hostname. + // + // This will not be accurate if the oauth token is set from an environment variable. + ActiveUser(hostname string) (username string, err error) + + // Hosts retrieves a list of known hosts. + Hosts() []string + + // DefaultHost retrieves the default host. + DefaultHost() (host string, source string) + + // Login will set user, git protocol, and auth token for the given hostname. + // + // If the encrypt option is specified it will first try to store the auth token + // in encrypted storage and will fall back to the general insecure configuration. + Login(hostname, username, token, gitProtocol string, secureStorage bool) (insecureStorageUsed bool, err error) + + // SwitchUser switches the active user for a given hostname. + SwitchUser(hostname, user string) error + + // Logout will remove user, git protocol, and auth token for the given hostname. + // It will remove the auth token from the encrypted storage if it exists there. + Logout(hostname, username string) error + + // UsersForHost retrieves a list of users configured for a specific host. + UsersForHost(hostname string) []string + + // TokenForUser retrieves the authentication token and its source for a specified user and hostname. + TokenForUser(hostname, user string) (token string, source string, err error) + + // The following methods are only for testing and that is a design smell we should consider fixing. + + // SetActiveToken will override any token resolution and return the given token and source for all calls to + // ActiveToken. + // Use for testing purposes only. + SetActiveToken(token, source string) + + // SetHosts will override any hosts resolution and return the given hosts for all calls to Hosts. + // Use for testing purposes only. + SetHosts(hosts []string) + + // SetDefaultHost will override any host resolution and return the given host and source for all calls to + // DefaultHost. + // Use for testing purposes only. + SetDefaultHost(host, source string) +} + +// AliasConfig defines an interface for managing command aliases. +type AliasConfig interface { + // Get retrieves the expansion for a specified alias. + Get(alias string) (expansion string, err error) + + // Add adds a new alias with the specified expansion. + Add(alias, expansion string) + + // Delete removes an alias. + Delete(alias string) error + + // All returns a map of all aliases to their corresponding expansions. + All() map[string]string +} diff --git a/internal/gh/mock/config.go b/internal/gh/mock/config.go new file mode 100644 index 000000000..502047240 --- /dev/null +++ b/internal/gh/mock/config.go @@ -0,0 +1,631 @@ +// Code generated by moq; DO NOT EDIT. +// github.com/matryer/moq + +package ghmock + +import ( + "github.com/cli/cli/v2/internal/gh" + o "github.com/cli/cli/v2/pkg/option" + "sync" +) + +// Ensure, that ConfigMock does implement gh.Config. +// If this is not the case, regenerate this file with moq. +var _ gh.Config = &ConfigMock{} + +// ConfigMock is a mock implementation of gh.Config. +// +// func TestSomethingThatUsesConfig(t *testing.T) { +// +// // make and configure a mocked gh.Config +// mockedConfig := &ConfigMock{ +// AliasesFunc: func() gh.AliasConfig { +// panic("mock out the Aliases method") +// }, +// AuthenticationFunc: func() gh.AuthConfig { +// panic("mock out the Authentication method") +// }, +// BrowserFunc: func(hostname string) gh.ConfigEntry { +// panic("mock out the Browser method") +// }, +// CacheDirFunc: func() string { +// panic("mock out the CacheDir method") +// }, +// EditorFunc: func(hostname string) gh.ConfigEntry { +// panic("mock out the Editor method") +// }, +// GetOrDefaultFunc: func(hostname string, key string) o.Option[gh.ConfigEntry] { +// panic("mock out the GetOrDefault method") +// }, +// GitProtocolFunc: func(hostname string) gh.ConfigEntry { +// panic("mock out the GitProtocol method") +// }, +// HTTPUnixSocketFunc: func(hostname string) gh.ConfigEntry { +// panic("mock out the HTTPUnixSocket method") +// }, +// MigrateFunc: func(migration gh.Migration) error { +// panic("mock out the Migrate method") +// }, +// PagerFunc: func(hostname string) gh.ConfigEntry { +// panic("mock out the Pager method") +// }, +// PromptFunc: func(hostname string) gh.ConfigEntry { +// panic("mock out the Prompt method") +// }, +// SetFunc: func(hostname string, key string, value string) { +// panic("mock out the Set method") +// }, +// VersionFunc: func() o.Option[string] { +// panic("mock out the Version method") +// }, +// WriteFunc: func() error { +// panic("mock out the Write method") +// }, +// } +// +// // use mockedConfig in code that requires gh.Config +// // and then make assertions. +// +// } +type ConfigMock struct { + // AliasesFunc mocks the Aliases method. + AliasesFunc func() gh.AliasConfig + + // AuthenticationFunc mocks the Authentication method. + AuthenticationFunc func() gh.AuthConfig + + // BrowserFunc mocks the Browser method. + BrowserFunc func(hostname string) gh.ConfigEntry + + // CacheDirFunc mocks the CacheDir method. + CacheDirFunc func() string + + // EditorFunc mocks the Editor method. + EditorFunc func(hostname string) gh.ConfigEntry + + // GetOrDefaultFunc mocks the GetOrDefault method. + GetOrDefaultFunc func(hostname string, key string) o.Option[gh.ConfigEntry] + + // GitProtocolFunc mocks the GitProtocol method. + GitProtocolFunc func(hostname string) gh.ConfigEntry + + // HTTPUnixSocketFunc mocks the HTTPUnixSocket method. + HTTPUnixSocketFunc func(hostname string) gh.ConfigEntry + + // MigrateFunc mocks the Migrate method. + MigrateFunc func(migration gh.Migration) error + + // PagerFunc mocks the Pager method. + PagerFunc func(hostname string) gh.ConfigEntry + + // PromptFunc mocks the Prompt method. + PromptFunc func(hostname string) gh.ConfigEntry + + // SetFunc mocks the Set method. + SetFunc func(hostname string, key string, value string) + + // VersionFunc mocks the Version method. + VersionFunc func() o.Option[string] + + // WriteFunc mocks the Write method. + WriteFunc func() error + + // calls tracks calls to the methods. + calls struct { + // Aliases holds details about calls to the Aliases method. + Aliases []struct { + } + // Authentication holds details about calls to the Authentication method. + Authentication []struct { + } + // Browser holds details about calls to the Browser method. + Browser []struct { + // Hostname is the hostname argument value. + Hostname string + } + // CacheDir holds details about calls to the CacheDir method. + CacheDir []struct { + } + // Editor holds details about calls to the Editor method. + Editor []struct { + // Hostname is the hostname argument value. + Hostname string + } + // GetOrDefault holds details about calls to the GetOrDefault method. + GetOrDefault []struct { + // Hostname is the hostname argument value. + Hostname string + // Key is the key argument value. + Key string + } + // GitProtocol holds details about calls to the GitProtocol method. + GitProtocol []struct { + // Hostname is the hostname argument value. + Hostname string + } + // HTTPUnixSocket holds details about calls to the HTTPUnixSocket method. + HTTPUnixSocket []struct { + // Hostname is the hostname argument value. + Hostname string + } + // Migrate holds details about calls to the Migrate method. + Migrate []struct { + // Migration is the migration argument value. + Migration gh.Migration + } + // Pager holds details about calls to the Pager method. + Pager []struct { + // Hostname is the hostname argument value. + Hostname string + } + // Prompt holds details about calls to the Prompt method. + Prompt []struct { + // Hostname is the hostname argument value. + Hostname string + } + // Set holds details about calls to the Set method. + Set []struct { + // Hostname is the hostname argument value. + Hostname string + // Key is the key argument value. + Key string + // Value is the value argument value. + Value string + } + // Version holds details about calls to the Version method. + Version []struct { + } + // Write holds details about calls to the Write method. + Write []struct { + } + } + lockAliases sync.RWMutex + lockAuthentication sync.RWMutex + lockBrowser sync.RWMutex + lockCacheDir sync.RWMutex + lockEditor sync.RWMutex + lockGetOrDefault sync.RWMutex + lockGitProtocol sync.RWMutex + lockHTTPUnixSocket sync.RWMutex + lockMigrate sync.RWMutex + lockPager sync.RWMutex + lockPrompt sync.RWMutex + lockSet sync.RWMutex + lockVersion sync.RWMutex + lockWrite sync.RWMutex +} + +// Aliases calls AliasesFunc. +func (mock *ConfigMock) Aliases() gh.AliasConfig { + if mock.AliasesFunc == nil { + panic("ConfigMock.AliasesFunc: method is nil but Config.Aliases was just called") + } + callInfo := struct { + }{} + mock.lockAliases.Lock() + mock.calls.Aliases = append(mock.calls.Aliases, callInfo) + mock.lockAliases.Unlock() + return mock.AliasesFunc() +} + +// AliasesCalls gets all the calls that were made to Aliases. +// Check the length with: +// +// len(mockedConfig.AliasesCalls()) +func (mock *ConfigMock) AliasesCalls() []struct { +} { + var calls []struct { + } + mock.lockAliases.RLock() + calls = mock.calls.Aliases + mock.lockAliases.RUnlock() + return calls +} + +// Authentication calls AuthenticationFunc. +func (mock *ConfigMock) Authentication() gh.AuthConfig { + if mock.AuthenticationFunc == nil { + panic("ConfigMock.AuthenticationFunc: method is nil but Config.Authentication was just called") + } + callInfo := struct { + }{} + mock.lockAuthentication.Lock() + mock.calls.Authentication = append(mock.calls.Authentication, callInfo) + mock.lockAuthentication.Unlock() + return mock.AuthenticationFunc() +} + +// AuthenticationCalls gets all the calls that were made to Authentication. +// Check the length with: +// +// len(mockedConfig.AuthenticationCalls()) +func (mock *ConfigMock) AuthenticationCalls() []struct { +} { + var calls []struct { + } + mock.lockAuthentication.RLock() + calls = mock.calls.Authentication + mock.lockAuthentication.RUnlock() + return calls +} + +// Browser calls BrowserFunc. +func (mock *ConfigMock) Browser(hostname string) gh.ConfigEntry { + if mock.BrowserFunc == nil { + panic("ConfigMock.BrowserFunc: method is nil but Config.Browser was just called") + } + callInfo := struct { + Hostname string + }{ + Hostname: hostname, + } + mock.lockBrowser.Lock() + mock.calls.Browser = append(mock.calls.Browser, callInfo) + mock.lockBrowser.Unlock() + return mock.BrowserFunc(hostname) +} + +// BrowserCalls gets all the calls that were made to Browser. +// Check the length with: +// +// len(mockedConfig.BrowserCalls()) +func (mock *ConfigMock) BrowserCalls() []struct { + Hostname string +} { + var calls []struct { + Hostname string + } + mock.lockBrowser.RLock() + calls = mock.calls.Browser + mock.lockBrowser.RUnlock() + return calls +} + +// CacheDir calls CacheDirFunc. +func (mock *ConfigMock) CacheDir() string { + if mock.CacheDirFunc == nil { + panic("ConfigMock.CacheDirFunc: method is nil but Config.CacheDir was just called") + } + callInfo := struct { + }{} + mock.lockCacheDir.Lock() + mock.calls.CacheDir = append(mock.calls.CacheDir, callInfo) + mock.lockCacheDir.Unlock() + return mock.CacheDirFunc() +} + +// CacheDirCalls gets all the calls that were made to CacheDir. +// Check the length with: +// +// len(mockedConfig.CacheDirCalls()) +func (mock *ConfigMock) CacheDirCalls() []struct { +} { + var calls []struct { + } + mock.lockCacheDir.RLock() + calls = mock.calls.CacheDir + mock.lockCacheDir.RUnlock() + return calls +} + +// Editor calls EditorFunc. +func (mock *ConfigMock) Editor(hostname string) gh.ConfigEntry { + if mock.EditorFunc == nil { + panic("ConfigMock.EditorFunc: method is nil but Config.Editor was just called") + } + callInfo := struct { + Hostname string + }{ + Hostname: hostname, + } + mock.lockEditor.Lock() + mock.calls.Editor = append(mock.calls.Editor, callInfo) + mock.lockEditor.Unlock() + return mock.EditorFunc(hostname) +} + +// EditorCalls gets all the calls that were made to Editor. +// Check the length with: +// +// len(mockedConfig.EditorCalls()) +func (mock *ConfigMock) EditorCalls() []struct { + Hostname string +} { + var calls []struct { + Hostname string + } + mock.lockEditor.RLock() + calls = mock.calls.Editor + mock.lockEditor.RUnlock() + return calls +} + +// GetOrDefault calls GetOrDefaultFunc. +func (mock *ConfigMock) GetOrDefault(hostname string, key string) o.Option[gh.ConfigEntry] { + if mock.GetOrDefaultFunc == nil { + panic("ConfigMock.GetOrDefaultFunc: method is nil but Config.GetOrDefault was just called") + } + callInfo := struct { + Hostname string + Key string + }{ + Hostname: hostname, + Key: key, + } + mock.lockGetOrDefault.Lock() + mock.calls.GetOrDefault = append(mock.calls.GetOrDefault, callInfo) + mock.lockGetOrDefault.Unlock() + return mock.GetOrDefaultFunc(hostname, key) +} + +// GetOrDefaultCalls gets all the calls that were made to GetOrDefault. +// Check the length with: +// +// len(mockedConfig.GetOrDefaultCalls()) +func (mock *ConfigMock) GetOrDefaultCalls() []struct { + Hostname string + Key string +} { + var calls []struct { + Hostname string + Key string + } + mock.lockGetOrDefault.RLock() + calls = mock.calls.GetOrDefault + mock.lockGetOrDefault.RUnlock() + return calls +} + +// GitProtocol calls GitProtocolFunc. +func (mock *ConfigMock) GitProtocol(hostname string) gh.ConfigEntry { + if mock.GitProtocolFunc == nil { + panic("ConfigMock.GitProtocolFunc: method is nil but Config.GitProtocol was just called") + } + callInfo := struct { + Hostname string + }{ + Hostname: hostname, + } + mock.lockGitProtocol.Lock() + mock.calls.GitProtocol = append(mock.calls.GitProtocol, callInfo) + mock.lockGitProtocol.Unlock() + return mock.GitProtocolFunc(hostname) +} + +// GitProtocolCalls gets all the calls that were made to GitProtocol. +// Check the length with: +// +// len(mockedConfig.GitProtocolCalls()) +func (mock *ConfigMock) GitProtocolCalls() []struct { + Hostname string +} { + var calls []struct { + Hostname string + } + mock.lockGitProtocol.RLock() + calls = mock.calls.GitProtocol + mock.lockGitProtocol.RUnlock() + return calls +} + +// HTTPUnixSocket calls HTTPUnixSocketFunc. +func (mock *ConfigMock) HTTPUnixSocket(hostname string) gh.ConfigEntry { + if mock.HTTPUnixSocketFunc == nil { + panic("ConfigMock.HTTPUnixSocketFunc: method is nil but Config.HTTPUnixSocket was just called") + } + callInfo := struct { + Hostname string + }{ + Hostname: hostname, + } + mock.lockHTTPUnixSocket.Lock() + mock.calls.HTTPUnixSocket = append(mock.calls.HTTPUnixSocket, callInfo) + mock.lockHTTPUnixSocket.Unlock() + return mock.HTTPUnixSocketFunc(hostname) +} + +// HTTPUnixSocketCalls gets all the calls that were made to HTTPUnixSocket. +// Check the length with: +// +// len(mockedConfig.HTTPUnixSocketCalls()) +func (mock *ConfigMock) HTTPUnixSocketCalls() []struct { + Hostname string +} { + var calls []struct { + Hostname string + } + mock.lockHTTPUnixSocket.RLock() + calls = mock.calls.HTTPUnixSocket + mock.lockHTTPUnixSocket.RUnlock() + return calls +} + +// Migrate calls MigrateFunc. +func (mock *ConfigMock) Migrate(migration gh.Migration) error { + if mock.MigrateFunc == nil { + panic("ConfigMock.MigrateFunc: method is nil but Config.Migrate was just called") + } + callInfo := struct { + Migration gh.Migration + }{ + Migration: migration, + } + mock.lockMigrate.Lock() + mock.calls.Migrate = append(mock.calls.Migrate, callInfo) + mock.lockMigrate.Unlock() + return mock.MigrateFunc(migration) +} + +// MigrateCalls gets all the calls that were made to Migrate. +// Check the length with: +// +// len(mockedConfig.MigrateCalls()) +func (mock *ConfigMock) MigrateCalls() []struct { + Migration gh.Migration +} { + var calls []struct { + Migration gh.Migration + } + mock.lockMigrate.RLock() + calls = mock.calls.Migrate + mock.lockMigrate.RUnlock() + return calls +} + +// Pager calls PagerFunc. +func (mock *ConfigMock) Pager(hostname string) gh.ConfigEntry { + if mock.PagerFunc == nil { + panic("ConfigMock.PagerFunc: method is nil but Config.Pager was just called") + } + callInfo := struct { + Hostname string + }{ + Hostname: hostname, + } + mock.lockPager.Lock() + mock.calls.Pager = append(mock.calls.Pager, callInfo) + mock.lockPager.Unlock() + return mock.PagerFunc(hostname) +} + +// PagerCalls gets all the calls that were made to Pager. +// Check the length with: +// +// len(mockedConfig.PagerCalls()) +func (mock *ConfigMock) PagerCalls() []struct { + Hostname string +} { + var calls []struct { + Hostname string + } + mock.lockPager.RLock() + calls = mock.calls.Pager + mock.lockPager.RUnlock() + return calls +} + +// Prompt calls PromptFunc. +func (mock *ConfigMock) Prompt(hostname string) gh.ConfigEntry { + if mock.PromptFunc == nil { + panic("ConfigMock.PromptFunc: method is nil but Config.Prompt was just called") + } + callInfo := struct { + Hostname string + }{ + Hostname: hostname, + } + mock.lockPrompt.Lock() + mock.calls.Prompt = append(mock.calls.Prompt, callInfo) + mock.lockPrompt.Unlock() + return mock.PromptFunc(hostname) +} + +// PromptCalls gets all the calls that were made to Prompt. +// Check the length with: +// +// len(mockedConfig.PromptCalls()) +func (mock *ConfigMock) PromptCalls() []struct { + Hostname string +} { + var calls []struct { + Hostname string + } + mock.lockPrompt.RLock() + calls = mock.calls.Prompt + mock.lockPrompt.RUnlock() + return calls +} + +// Set calls SetFunc. +func (mock *ConfigMock) Set(hostname string, key string, value string) { + if mock.SetFunc == nil { + panic("ConfigMock.SetFunc: method is nil but Config.Set was just called") + } + callInfo := struct { + Hostname string + Key string + Value string + }{ + Hostname: hostname, + Key: key, + Value: value, + } + mock.lockSet.Lock() + mock.calls.Set = append(mock.calls.Set, callInfo) + mock.lockSet.Unlock() + mock.SetFunc(hostname, key, value) +} + +// SetCalls gets all the calls that were made to Set. +// Check the length with: +// +// len(mockedConfig.SetCalls()) +func (mock *ConfigMock) SetCalls() []struct { + Hostname string + Key string + Value string +} { + var calls []struct { + Hostname string + Key string + Value string + } + mock.lockSet.RLock() + calls = mock.calls.Set + mock.lockSet.RUnlock() + return calls +} + +// Version calls VersionFunc. +func (mock *ConfigMock) Version() o.Option[string] { + if mock.VersionFunc == nil { + panic("ConfigMock.VersionFunc: method is nil but Config.Version was just called") + } + callInfo := struct { + }{} + mock.lockVersion.Lock() + mock.calls.Version = append(mock.calls.Version, callInfo) + mock.lockVersion.Unlock() + return mock.VersionFunc() +} + +// VersionCalls gets all the calls that were made to Version. +// Check the length with: +// +// len(mockedConfig.VersionCalls()) +func (mock *ConfigMock) VersionCalls() []struct { +} { + var calls []struct { + } + mock.lockVersion.RLock() + calls = mock.calls.Version + mock.lockVersion.RUnlock() + return calls +} + +// Write calls WriteFunc. +func (mock *ConfigMock) Write() error { + if mock.WriteFunc == nil { + panic("ConfigMock.WriteFunc: method is nil but Config.Write was just called") + } + callInfo := struct { + }{} + mock.lockWrite.Lock() + mock.calls.Write = append(mock.calls.Write, callInfo) + mock.lockWrite.Unlock() + return mock.WriteFunc() +} + +// WriteCalls gets all the calls that were made to Write. +// Check the length with: +// +// len(mockedConfig.WriteCalls()) +func (mock *ConfigMock) WriteCalls() []struct { +} { + var calls []struct { + } + mock.lockWrite.RLock() + calls = mock.calls.Write + mock.lockWrite.RUnlock() + return calls +} diff --git a/internal/gh/mock/migration.go b/internal/gh/mock/migration.go new file mode 100644 index 000000000..e534ef5c4 --- /dev/null +++ b/internal/gh/mock/migration.go @@ -0,0 +1,150 @@ +// Code generated by moq; DO NOT EDIT. +// github.com/matryer/moq + +package ghmock + +import ( + "github.com/cli/cli/v2/internal/gh" + ghConfig "github.com/cli/go-gh/v2/pkg/config" + "sync" +) + +// Ensure, that MigrationMock does implement gh.Migration. +// If this is not the case, regenerate this file with moq. +var _ gh.Migration = &MigrationMock{} + +// MigrationMock is a mock implementation of gh.Migration. +// +// func TestSomethingThatUsesMigration(t *testing.T) { +// +// // make and configure a mocked gh.Migration +// mockedMigration := &MigrationMock{ +// DoFunc: func(config *ghConfig.Config) error { +// panic("mock out the Do method") +// }, +// PostVersionFunc: func() string { +// panic("mock out the PostVersion method") +// }, +// PreVersionFunc: func() string { +// panic("mock out the PreVersion method") +// }, +// } +// +// // use mockedMigration in code that requires gh.Migration +// // and then make assertions. +// +// } +type MigrationMock struct { + // DoFunc mocks the Do method. + DoFunc func(config *ghConfig.Config) error + + // PostVersionFunc mocks the PostVersion method. + PostVersionFunc func() string + + // PreVersionFunc mocks the PreVersion method. + PreVersionFunc func() string + + // calls tracks calls to the methods. + calls struct { + // Do holds details about calls to the Do method. + Do []struct { + // Config is the config argument value. + Config *ghConfig.Config + } + // PostVersion holds details about calls to the PostVersion method. + PostVersion []struct { + } + // PreVersion holds details about calls to the PreVersion method. + PreVersion []struct { + } + } + lockDo sync.RWMutex + lockPostVersion sync.RWMutex + lockPreVersion sync.RWMutex +} + +// Do calls DoFunc. +func (mock *MigrationMock) Do(config *ghConfig.Config) error { + if mock.DoFunc == nil { + panic("MigrationMock.DoFunc: method is nil but Migration.Do was just called") + } + callInfo := struct { + Config *ghConfig.Config + }{ + Config: config, + } + mock.lockDo.Lock() + mock.calls.Do = append(mock.calls.Do, callInfo) + mock.lockDo.Unlock() + return mock.DoFunc(config) +} + +// DoCalls gets all the calls that were made to Do. +// Check the length with: +// +// len(mockedMigration.DoCalls()) +func (mock *MigrationMock) DoCalls() []struct { + Config *ghConfig.Config +} { + var calls []struct { + Config *ghConfig.Config + } + mock.lockDo.RLock() + calls = mock.calls.Do + mock.lockDo.RUnlock() + return calls +} + +// PostVersion calls PostVersionFunc. +func (mock *MigrationMock) PostVersion() string { + if mock.PostVersionFunc == nil { + panic("MigrationMock.PostVersionFunc: method is nil but Migration.PostVersion was just called") + } + callInfo := struct { + }{} + mock.lockPostVersion.Lock() + mock.calls.PostVersion = append(mock.calls.PostVersion, callInfo) + mock.lockPostVersion.Unlock() + return mock.PostVersionFunc() +} + +// PostVersionCalls gets all the calls that were made to PostVersion. +// Check the length with: +// +// len(mockedMigration.PostVersionCalls()) +func (mock *MigrationMock) PostVersionCalls() []struct { +} { + var calls []struct { + } + mock.lockPostVersion.RLock() + calls = mock.calls.PostVersion + mock.lockPostVersion.RUnlock() + return calls +} + +// PreVersion calls PreVersionFunc. +func (mock *MigrationMock) PreVersion() string { + if mock.PreVersionFunc == nil { + panic("MigrationMock.PreVersionFunc: method is nil but Migration.PreVersion was just called") + } + callInfo := struct { + }{} + mock.lockPreVersion.Lock() + mock.calls.PreVersion = append(mock.calls.PreVersion, callInfo) + mock.lockPreVersion.Unlock() + return mock.PreVersionFunc() +} + +// PreVersionCalls gets all the calls that were made to PreVersion. +// Check the length with: +// +// len(mockedMigration.PreVersionCalls()) +func (mock *MigrationMock) PreVersionCalls() []struct { +} { + var calls []struct { + } + mock.lockPreVersion.RLock() + calls = mock.calls.PreVersion + mock.lockPreVersion.RUnlock() + return calls +} diff --git a/internal/keyring/keyring.go b/internal/keyring/keyring.go index afb5025e6..f873c6436 100644 --- a/internal/keyring/keyring.go +++ b/internal/keyring/keyring.go @@ -2,11 +2,14 @@ package keyring import ( + "errors" "time" "github.com/zalando/go-keyring" ) +var ErrNotFound = errors.New("secret not found in keyring") + type TimeoutError struct { message string } @@ -46,6 +49,9 @@ func Get(service, user string) (string, error) { }() select { case res := <-ch: + if errors.Is(res.err, keyring.ErrNotFound) { + return "", ErrNotFound + } return res.val, res.err case <-time.After(3 * time.Second): return "", &TimeoutError{"timeout while trying to get secret from keyring"} @@ -66,3 +72,11 @@ func Delete(service, user string) error { return &TimeoutError{"timeout while trying to delete secret from keyring"} } } + +func MockInit() { + keyring.MockInit() +} + +func MockInitWithError(err error) { + keyring.MockInitWithError(err) +} diff --git a/internal/prompter/prompter_mock.go b/internal/prompter/prompter_mock.go index 9a59a7bd1..b817a491f 100644 --- a/internal/prompter/prompter_mock.go +++ b/internal/prompter/prompter_mock.go @@ -35,7 +35,7 @@ var _ Prompter = &PrompterMock{} // MarkdownEditorFunc: func(s1 string, s2 string, b bool) (string, error) { // panic("mock out the MarkdownEditor method") // }, -// MultiSelectFunc: func(s string, strings1 []string, strings2 []string) ([]int, error) { +// MultiSelectFunc: func(prompt string, defaults []string, options []string) ([]int, error) { // panic("mock out the MultiSelect method") // }, // PasswordFunc: func(s string) (string, error) { @@ -70,7 +70,7 @@ type PrompterMock struct { MarkdownEditorFunc func(s1 string, s2 string, b bool) (string, error) // MultiSelectFunc mocks the MultiSelect method. - MultiSelectFunc func(s string, strings1 []string, strings2 []string) ([]int, error) + MultiSelectFunc func(prompt string, defaults []string, options []string) ([]int, error) // PasswordFunc mocks the Password method. PasswordFunc func(s string) (string, error) @@ -116,12 +116,12 @@ type PrompterMock struct { } // MultiSelect holds details about calls to the MultiSelect method. MultiSelect []struct { - // S is the s argument value. - S string - // Strings1 is the strings1 argument value. - Strings1 []string - // Strings2 is the strings2 argument value. - Strings2 []string + // Prompt is the prompt argument value. + Prompt string + // Defaults is the defaults argument value. + Defaults []string + // Options is the options argument value. + Options []string } // Password holds details about calls to the Password method. Password []struct { @@ -348,23 +348,23 @@ func (mock *PrompterMock) MarkdownEditorCalls() []struct { } // MultiSelect calls MultiSelectFunc. -func (mock *PrompterMock) MultiSelect(s string, strings1 []string, strings2 []string) ([]int, error) { +func (mock *PrompterMock) MultiSelect(prompt string, defaults []string, options []string) ([]int, error) { if mock.MultiSelectFunc == nil { panic("PrompterMock.MultiSelectFunc: method is nil but Prompter.MultiSelect was just called") } callInfo := struct { - S string - Strings1 []string - Strings2 []string + Prompt string + Defaults []string + Options []string }{ - S: s, - Strings1: strings1, - Strings2: strings2, + Prompt: prompt, + Defaults: defaults, + Options: options, } mock.lockMultiSelect.Lock() mock.calls.MultiSelect = append(mock.calls.MultiSelect, callInfo) mock.lockMultiSelect.Unlock() - return mock.MultiSelectFunc(s, strings1, strings2) + return mock.MultiSelectFunc(prompt, defaults, options) } // MultiSelectCalls gets all the calls that were made to MultiSelect. @@ -372,14 +372,14 @@ func (mock *PrompterMock) MultiSelect(s string, strings1 []string, strings2 []st // // len(mockedPrompter.MultiSelectCalls()) func (mock *PrompterMock) MultiSelectCalls() []struct { - S string - Strings1 []string - Strings2 []string + Prompt string + Defaults []string + Options []string } { var calls []struct { - S string - Strings1 []string - Strings2 []string + Prompt string + Defaults []string + Options []string } mock.lockMultiSelect.RLock() calls = mock.calls.MultiSelect diff --git a/internal/prompter/test.go b/internal/prompter/test.go index af55c084d..04375ce76 100644 --- a/internal/prompter/test.go +++ b/internal/prompter/test.go @@ -138,13 +138,13 @@ func IndexFor(options []string, answer string) (int, error) { return ix, nil } } - return -1, NoSuchAnswerErr(answer) + return -1, NoSuchAnswerErr(answer, options) } func NoSuchPromptErr(prompt string) error { return fmt.Errorf("no such prompt '%s'", prompt) } -func NoSuchAnswerErr(answer string) error { - return fmt.Errorf("no such answer '%s'", answer) +func NoSuchAnswerErr(answer string, options []string) error { + return fmt.Errorf("no such answer '%s' in [%s]", answer, strings.Join(options, ", ")) } diff --git a/internal/tableprinter/table_printer.go b/internal/tableprinter/table_printer.go index 1cd7c7d6e..e1454170f 100644 --- a/internal/tableprinter/table_printer.go +++ b/internal/tableprinter/table_printer.go @@ -1,6 +1,7 @@ package tableprinter import ( + "io" "strings" "time" @@ -12,42 +13,90 @@ import ( type TablePrinter struct { tableprinter.TablePrinter isTTY bool + cs *iostreams.ColorScheme } -func (t *TablePrinter) HeaderRow(columns ...string) { - if !t.isTTY { - return - } - for _, col := range columns { - t.AddField(strings.ToUpper(col)) - } - t.EndRow() +// IsTTY gets whether the TablePrinter will render to a terminal. +func (t *TablePrinter) IsTTY() bool { + return t.isTTY } -// In tty mode display the fuzzy time difference between now and t. -// In nontty mode just display t with the time.RFC3339 format. +// AddTimeField in TTY mode displays the fuzzy time difference between now and t. +// In non-TTY mode it just displays t with the time.RFC3339 format. func (tp *TablePrinter) AddTimeField(now, t time.Time, c func(string) string) { - tf := t.Format(time.RFC3339) + var tf string if tp.isTTY { tf = text.FuzzyAgo(now, t) + } else { + tf = t.Format(time.RFC3339) } - tp.AddField(tf, tableprinter.WithColor(c)) + tp.AddField(tf, WithColor(c)) } var ( - WithTruncate = tableprinter.WithTruncate WithColor = tableprinter.WithColor + WithPadding = tableprinter.WithPadding + WithTruncate = tableprinter.WithTruncate ) -func New(ios *iostreams.IOStreams) *TablePrinter { +type headerOption struct { + columns []string +} + +// New creates a TablePrinter from an IOStreams. +func New(ios *iostreams.IOStreams, headers headerOption) *TablePrinter { maxWidth := 80 isTTY := ios.IsStdoutTTY() if isTTY { maxWidth = ios.TerminalWidth() } - tp := tableprinter.New(ios.Out, isTTY, maxWidth) - return &TablePrinter{ - TablePrinter: tp, - isTTY: isTTY, - } + + return NewWithWriter(ios.Out, isTTY, maxWidth, ios.ColorScheme(), headers) } + +// NewWithWriter creates a TablePrinter from a Writer, whether the output is a terminal, the terminal width, and more. +func NewWithWriter(w io.Writer, isTTY bool, maxWidth int, cs *iostreams.ColorScheme, headers headerOption) *TablePrinter { + tp := &TablePrinter{ + TablePrinter: tableprinter.New(w, isTTY, maxWidth), + isTTY: isTTY, + cs: cs, + } + + if isTTY && len(headers.columns) > 0 { + // Make sure all headers are uppercase, taking a copy of the headers to avoid modifying the original slice. + upperCasedHeaders := make([]string, len(headers.columns)) + for i := range headers.columns { + upperCasedHeaders[i] = strings.ToUpper(headers.columns[i]) + } + + // Make sure all header columns are padded - even the last one. Previously, the last header column + // was not padded. In tests cs.Enabled() is false which allows us to avoid having to fix up + // numerous tests that verify header padding. + var paddingFunc func(int, string) string + if cs.Enabled() { + paddingFunc = text.PadRight + } + + tp.AddHeader( + upperCasedHeaders, + WithPadding(paddingFunc), + WithColor(cs.LightGrayUnderline), + ) + } + + return tp +} + +// WithHeader defines the column names for a table. +// Panics if columns is nil or empty. +func WithHeader(columns ...string) headerOption { + if len(columns) == 0 { + panic("must define header columns") + } + return headerOption{columns} +} + +// NoHeader disable printing or checking for a table header. +// +// Deprecated: use WithHeader unless required otherwise. +var NoHeader = headerOption{} diff --git a/internal/tableprinter/table_printer_test.go b/internal/tableprinter/table_printer_test.go new file mode 100644 index 000000000..840c46456 --- /dev/null +++ b/internal/tableprinter/table_printer_test.go @@ -0,0 +1,22 @@ +package tableprinter_test + +import ( + "testing" + + "github.com/cli/cli/v2/internal/tableprinter" + "github.com/cli/cli/v2/pkg/iostreams" + "github.com/stretchr/testify/require" +) + +func TestHeadersAreNotMutated(t *testing.T) { + // Given a TTY environment so that headers are included in the table + ios, _, _, _ := iostreams.Test() + ios.SetStdoutTTY(true) + + // When creating a new table printer + headers := []string{"one", "two", "three"} + _ = tableprinter.New(ios, tableprinter.WithHeader(headers...)) + + // The provided headers should not be mutated + require.Equal(t, []string{"one", "two", "three"}, headers) +} diff --git a/internal/text/text.go b/internal/text/text.go index 6eb541584..c14071c32 100644 --- a/internal/text/text.go +++ b/internal/text/text.go @@ -2,8 +2,10 @@ package text import ( "fmt" + "math" "net/url" "regexp" + "slices" "strings" "time" @@ -77,3 +79,68 @@ func DisplayURL(urlStr string) string { func RemoveDiacritics(value string) string { return text.RemoveDiacritics(value) } + +func PadRight(maxWidth int, s string) string { + return text.PadRight(maxWidth, s) +} + +// FormatSlice concatenates elements of the given string slice into a +// well-formatted, possibly multiline, string with specific line length limit. +// Elements can be optionally surrounded by custom strings (e.g., quotes or +// brackets). If the lineLength argument is non-positive, no line length limit +// will be applied. +func FormatSlice(values []string, lineLength uint, indent uint, prependWith string, appendWith string, sort bool) string { + if lineLength <= 0 { + lineLength = math.MaxInt + } + + sortedValues := values + if sort { + sortedValues = slices.Clone(values) + slices.Sort(sortedValues) + } + + pre := strings.Repeat(" ", int(indent)) + if len(sortedValues) == 0 { + return pre + } else if len(sortedValues) == 1 { + return pre + sortedValues[0] + } + + builder := strings.Builder{} + currentLineLength := 0 + sep := "," + ws := " " + + for i := 0; i < len(sortedValues); i++ { + v := prependWith + sortedValues[i] + appendWith + isLast := i == -1+len(sortedValues) + + if currentLineLength == 0 { + builder.WriteString(pre) + builder.WriteString(v) + currentLineLength += len(v) + if !isLast { + builder.WriteString(sep) + currentLineLength += len(sep) + } + } else { + if !isLast && currentLineLength+len(ws)+len(v)+len(sep) > int(lineLength) || + isLast && currentLineLength+len(ws)+len(v) > int(lineLength) { + currentLineLength = 0 + builder.WriteString("\n") + i-- + continue + } + + builder.WriteString(ws) + builder.WriteString(v) + currentLineLength += len(ws) + len(v) + if !isLast { + builder.WriteString(sep) + currentLineLength += len(sep) + } + } + } + return builder.String() +} diff --git a/internal/text/text_test.go b/internal/text/text_test.go index 98f16da5d..46566bbf8 100644 --- a/internal/text/text_test.go +++ b/internal/text/text_test.go @@ -54,3 +54,95 @@ func TestFuzzyAgoAbbr(t *testing.T) { assert.Equal(t, expected, fuzzy) } } + +func TestFormatSlice(t *testing.T) { + tests := []struct { + name string + values []string + indent uint + lineLength uint + prependWith string + appendWith string + sort bool + wants string + }{ + { + name: "empty", + lineLength: 10, + values: []string{}, + wants: "", + }, + { + name: "empty with indent", + lineLength: 10, + indent: 2, + values: []string{}, + wants: " ", + }, + { + name: "single", + lineLength: 10, + values: []string{"foo"}, + wants: "foo", + }, + { + name: "single with indent", + lineLength: 10, + indent: 2, + values: []string{"foo"}, + wants: " foo", + }, + { + name: "long single with indent", + lineLength: 10, + indent: 2, + values: []string{"some-long-value"}, + wants: " some-long-value", + }, + { + name: "exact line length", + lineLength: 4, + values: []string{"a", "b"}, + wants: "a, b", + }, + { + name: "values longer than line length", + lineLength: 4, + values: []string{"long-value", "long-value"}, + wants: "long-value,\nlong-value", + }, + { + name: "zero line length (no wrapping expected)", + lineLength: 0, + values: []string{"foo", "bar"}, + wants: "foo, bar", + }, + { + name: "simple", + lineLength: 10, + values: []string{"foo", "bar", "baz", "foo", "bar", "baz"}, + wants: "foo, bar,\nbaz, foo,\nbar, baz", + }, + { + name: "simple, surrounded", + lineLength: 13, + prependWith: "<", + appendWith: ">", + values: []string{"foo", "bar", "baz", "foo", "bar", "baz"}, + wants: ", ,\n, ,\n, ", + }, + { + name: "sort", + lineLength: 99, + sort: true, + values: []string{"c", "b", "a"}, + wants: "a, b, c", + }, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + assert.Equal(t, tt.wants, FormatSlice(tt.values, tt.lineLength, tt.indent, tt.prependWith, tt.appendWith, tt.sort)) + }) + } +} diff --git a/pkg/cmd/actions/actions.go b/pkg/cmd/actions/actions.go index f8087aa6d..663866844 100644 --- a/pkg/cmd/actions/actions.go +++ b/pkg/cmd/actions/actions.go @@ -26,36 +26,36 @@ func actionsExplainer(cs *iostreams.ColorScheme) string { header := cs.Bold("Welcome to GitHub Actions on the command line.") runHeader := cs.Bold("Interacting with workflow runs") workflowHeader := cs.Bold("Interacting with workflow files") - cacheHeader := cs.Bold("Interacting with the Actions cache") + cacheHeader := cs.Bold("Interacting with the GitHub Actions cache") return heredoc.Docf(` - %s + %[2]s - GitHub CLI integrates with Actions to help you manage runs and workflows. + GitHub CLI integrates with GitHub Actions to help you manage runs and workflows. - %s + %[3]s gh run list: List recent workflow runs gh run view: View details for a workflow run or one of its jobs gh run watch: Watch a workflow run while it executes gh run rerun: Rerun a failed workflow run gh run download: Download artifacts generated by runs - To see more help, run 'gh help run ' + To see more help, run %[1]sgh help run %[1]s - %s + %[4]s gh workflow list: List workflow files in your repository gh workflow view: View details for a workflow file gh workflow enable: Enable a workflow file gh workflow disable: Disable a workflow file gh workflow run: Trigger a workflow_dispatch run for a workflow file - To see more help, run 'gh help workflow ' + To see more help, run %[1]sgh help workflow %[1]s - %s - gh cache list: List all the caches saved in Actions for a repository - gh cache delete: Delete one or all saved caches in Actions for a repository + %[5]s + gh cache list: List all the caches saved in GitHub Actions for a repository + gh cache delete: Delete one or all saved caches in GitHub Actions for a repository - To see more help, run 'gh help cache ' + To see more help, run %[1]sgh help cache %[1]s - `, header, runHeader, workflowHeader, cacheHeader) + `, "`", header, runHeader, workflowHeader, cacheHeader) } diff --git a/pkg/cmd/alias/alias.go b/pkg/cmd/alias/alias.go index 713e7d1db..d91b4dc2d 100644 --- a/pkg/cmd/alias/alias.go +++ b/pkg/cmd/alias/alias.go @@ -14,11 +14,11 @@ func NewCmdAlias(f *cmdutil.Factory) *cobra.Command { cmd := &cobra.Command{ Use: "alias ", Short: "Create command shortcuts", - Long: heredoc.Doc(` + Long: heredoc.Docf(` Aliases can be used to make shortcuts for gh commands or to compose multiple commands. - Run "gh help alias set" to learn more. - `), + Run %[1]sgh help alias set%[1]s to learn more. + `, "`"), } cmdutil.DisableAuthCheck(cmd) diff --git a/pkg/cmd/alias/delete/delete.go b/pkg/cmd/alias/delete/delete.go index daaaa2435..da69504a8 100644 --- a/pkg/cmd/alias/delete/delete.go +++ b/pkg/cmd/alias/delete/delete.go @@ -2,18 +2,20 @@ package delete import ( "fmt" + "sort" - "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" "github.com/spf13/cobra" ) type DeleteOptions struct { - Config func() (config.Config, error) + Config func() (gh.Config, error) IO *iostreams.IOStreams Name string + All bool } func NewCmdDelete(f *cmdutil.Factory, runF func(*DeleteOptions) error) *cobra.Command { @@ -23,12 +25,19 @@ func NewCmdDelete(f *cmdutil.Factory, runF func(*DeleteOptions) error) *cobra.Co } cmd := &cobra.Command{ - Use: "delete ", - Short: "Delete an alias", - Args: cobra.ExactArgs(1), + Use: "delete { | --all}", + Short: "Delete set aliases", + Args: cobra.MaximumNArgs(1), RunE: func(cmd *cobra.Command, args []string) error { - opts.Name = args[0] - + if len(args) == 0 && !opts.All { + return cmdutil.FlagErrorf("specify an alias to delete or `--all`") + } + if len(args) > 0 && opts.All { + return cmdutil.FlagErrorf("cannot use `--all` with alias name") + } + if len(args) > 0 { + opts.Name = args[0] + } if runF != nil { return runF(opts) } @@ -36,6 +45,8 @@ func NewCmdDelete(f *cmdutil.Factory, runF func(*DeleteOptions) error) *cobra.Co }, } + cmd.Flags().BoolVar(&opts.All, "all", false, "Delete all aliases") + return cmd } @@ -47,25 +58,40 @@ func deleteRun(opts *DeleteOptions) error { aliasCfg := cfg.Aliases() - expansion, err := aliasCfg.Get(opts.Name) - if err != nil { - return fmt.Errorf("no such alias %s", opts.Name) - + aliases := make(map[string]string) + if opts.All { + aliases = aliasCfg.All() + if len(aliases) == 0 { + return cmdutil.NewNoResultsError("no aliases configured") + } + } else { + expansion, err := aliasCfg.Get(opts.Name) + if err != nil { + return fmt.Errorf("no such alias %s", opts.Name) + } + aliases[opts.Name] = expansion } - err = aliasCfg.Delete(opts.Name) - if err != nil { - return fmt.Errorf("failed to delete alias %s: %w", opts.Name, err) + for name := range aliases { + if err := aliasCfg.Delete(name); err != nil { + return fmt.Errorf("failed to delete alias %s: %w", name, err) + } } - err = cfg.Write() - if err != nil { + if err := cfg.Write(); err != nil { return err } if opts.IO.IsStdoutTTY() { cs := opts.IO.ColorScheme() - fmt.Fprintf(opts.IO.ErrOut, "%s Deleted alias %s; was %s\n", cs.SuccessIconWithColor(cs.Red), opts.Name, expansion) + keys := make([]string, 0, len(aliases)) + for k := range aliases { + keys = append(keys, k) + } + sort.Strings(keys) + for _, k := range keys { + fmt.Fprintf(opts.IO.ErrOut, "%s Deleted alias %s; was %s\n", cs.SuccessIconWithColor(cs.Red), k, aliases[k]) + } } return nil diff --git a/pkg/cmd/alias/delete/delete_test.go b/pkg/cmd/alias/delete/delete_test.go index d6c7098b1..845119a80 100644 --- a/pkg/cmd/alias/delete/delete_test.go +++ b/pkg/cmd/alias/delete/delete_test.go @@ -7,82 +7,179 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" "github.com/google/shlex" "github.com/stretchr/testify/assert" - "github.com/stretchr/testify/require" ) -func TestAliasDelete(t *testing.T) { - _ = config.StubWriteConfig(t) - +func TestNewCmdDelete(t *testing.T) { tests := []struct { - name string - config string - cli string - isTTY bool - wantStdout string - wantStderr string - wantErr string + name string + input string + output DeleteOptions + wantErr bool + errMsg string }{ { - name: "no aliases", - config: "", - cli: "co", - isTTY: true, - wantStdout: "", - wantStderr: "", - wantErr: "no such alias co", + name: "no arguments", + input: "", + wantErr: true, + errMsg: "specify an alias to delete or `--all`", }, { - name: "delete one", + name: "specified alias", + input: "co", + output: DeleteOptions{ + Name: "co", + }, + }, + { + name: "all flag", + input: "--all", + output: DeleteOptions{ + All: true, + }, + }, + { + name: "specified alias and all flag", + input: "co --all", + wantErr: true, + errMsg: "cannot use `--all` with alias name", + }, + { + name: "too many arguments", + input: "il co", + wantErr: true, + errMsg: "accepts at most 1 arg(s), received 2", + }, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + ios, _, _, _ := iostreams.Test() + f := &cmdutil.Factory{ + IOStreams: ios, + } + argv, err := shlex.Split(tt.input) + assert.NoError(t, err) + var gotOpts *DeleteOptions + cmd := NewCmdDelete(f, func(opts *DeleteOptions) error { + gotOpts = opts + return nil + }) + cmd.SetArgs(argv) + cmd.SetIn(&bytes.Buffer{}) + cmd.SetOut(io.Discard) + cmd.SetErr(io.Discard) + _, err = cmd.ExecuteC() + if tt.wantErr { + assert.EqualError(t, err, tt.errMsg) + return + } + assert.NoError(t, err) + assert.Equal(t, tt.output.Name, gotOpts.Name) + assert.Equal(t, tt.output.All, gotOpts.All) + }) + } +} + +func TestDeleteRun(t *testing.T) { + tests := []struct { + name string + config string + isTTY bool + opts *DeleteOptions + wantAliases map[string]string + wantStdout string + wantStderr string + wantErrMsg string + }{ + { + name: "delete alias", config: heredoc.Doc(` aliases: il: issue list co: pr checkout `), - cli: "co", - isTTY: true, - wantStdout: "", + isTTY: true, + opts: &DeleteOptions{ + Name: "co", + All: false, + }, + wantAliases: map[string]string{ + "il": "issue list", + }, wantStderr: "✓ Deleted alias co; was pr checkout\n", }, + { + name: "delete all aliases", + config: heredoc.Doc(` + aliases: + il: issue list + co: pr checkout + `), + isTTY: true, + opts: &DeleteOptions{ + All: true, + }, + wantAliases: map[string]string{}, + wantStderr: "✓ Deleted alias co; was pr checkout\n✓ Deleted alias il; was issue list\n", + }, + { + name: "delete alias that does not exist", + config: heredoc.Doc(` + aliases: + il: issue list + co: pr checkout + `), + isTTY: true, + opts: &DeleteOptions{ + Name: "unknown", + }, + wantAliases: map[string]string{ + "il": "issue list", + "co": "pr checkout", + }, + wantErrMsg: "no such alias unknown", + }, + { + name: "delete all aliases when none exist", + isTTY: true, + opts: &DeleteOptions{ + All: true, + }, + wantAliases: map[string]string{}, + wantErrMsg: "no aliases configured", + }, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { - cfg := config.NewFromString(tt.config) - ios, _, stdout, stderr := iostreams.Test() - ios.SetStdoutTTY(tt.isTTY) ios.SetStdinTTY(tt.isTTY) + ios.SetStdoutTTY(tt.isTTY) ios.SetStderrTTY(tt.isTTY) + tt.opts.IO = ios - factory := &cmdutil.Factory{ - IOStreams: ios, - Config: func() (config.Config, error) { - return cfg, nil - }, + cfg := config.NewFromString(tt.config) + tt.opts.Config = func() (gh.Config, error) { + return cfg, nil } - cmd := NewCmdDelete(factory, nil) - - argv, err := shlex.Split(tt.cli) - require.NoError(t, err) - cmd.SetArgs(argv) - - cmd.SetIn(&bytes.Buffer{}) - cmd.SetOut(io.Discard) - cmd.SetErr(io.Discard) - - _, err = cmd.ExecuteC() - if tt.wantErr != "" { - assert.EqualError(t, err, tt.wantErr) - return + err := deleteRun(tt.opts) + if tt.wantErrMsg != "" { + assert.EqualError(t, err, tt.wantErrMsg) + writeCalls := cfg.WriteCalls() + assert.Equal(t, 0, len(writeCalls)) + } else { + assert.NoError(t, err) + writeCalls := cfg.WriteCalls() + assert.Equal(t, 1, len(writeCalls)) } - require.NoError(t, err) assert.Equal(t, tt.wantStdout, stdout.String()) assert.Equal(t, tt.wantStderr, stderr.String()) + assert.Equal(t, tt.wantAliases, cfg.Aliases().All()) }) } } diff --git a/pkg/cmd/alias/imports/import.go b/pkg/cmd/alias/imports/import.go index ef2176d45..78959ece3 100644 --- a/pkg/cmd/alias/imports/import.go +++ b/pkg/cmd/alias/imports/import.go @@ -6,7 +6,7 @@ import ( "strings" "github.com/MakeNowJust/heredoc" - "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/pkg/cmd/alias/shared" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" @@ -15,7 +15,7 @@ import ( ) type ImportOptions struct { - Config func() (config.Config, error) + Config func() (gh.Config, error) IO *iostreams.IOStreams Filename string @@ -34,7 +34,7 @@ func NewCmdImport(f *cmdutil.Factory, runF func(*ImportOptions) error) *cobra.Co cmd := &cobra.Command{ Use: "import [ | -]", Short: "Import aliases from a YAML file", - Long: heredoc.Doc(` + Long: heredoc.Docf(` Import aliases from the contents of a YAML file. Aliases should be defined as a map in YAML, where the keys represent aliases and @@ -47,12 +47,12 @@ func NewCmdImport(f *cmdutil.Factory, runF func(*ImportOptions) error) *cobra.Co issue list --label=enhancement - Use "-" to read aliases (in YAML format) from standard input. + Use %[1]s-%[1]s to read aliases (in YAML format) from standard input. - The output from the gh command "alias list" can be used to produce a YAML file + The output from %[1]sgh alias list%[1]s can be used to produce a YAML file containing your aliases, which you can use to import them from one machine to - another. Run "gh help alias list" to learn more. - `), + another. Run %[1]sgh help alias list%[1]s to learn more. + `, "`"), Example: heredoc.Doc(` # Import aliases from a file $ gh alias import aliases.yml diff --git a/pkg/cmd/alias/imports/import_test.go b/pkg/cmd/alias/imports/import_test.go index 024f52f02..c2ae16e7a 100644 --- a/pkg/cmd/alias/imports/import_test.go +++ b/pkg/cmd/alias/imports/import_test.go @@ -11,6 +11,7 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/pkg/cmd/alias/shared" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" @@ -309,7 +310,7 @@ func TestImportRun(t *testing.T) { readConfigs := config.StubWriteConfig(t) cfg := config.NewFromString(tt.initConfig) - tt.opts.Config = func() (config.Config, error) { + tt.opts.Config = func() (gh.Config, error) { return cfg, nil } diff --git a/pkg/cmd/alias/list/list.go b/pkg/cmd/alias/list/list.go index 2f17ed195..c648b2e6d 100644 --- a/pkg/cmd/alias/list/list.go +++ b/pkg/cmd/alias/list/list.go @@ -2,7 +2,7 @@ package list import ( "github.com/MakeNowJust/heredoc" - "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" "github.com/spf13/cobra" @@ -10,7 +10,7 @@ import ( ) type ListOptions struct { - Config func() (config.Config, error) + Config func() (gh.Config, error) IO *iostreams.IOStreams } diff --git a/pkg/cmd/alias/list/list_test.go b/pkg/cmd/alias/list/list_test.go index 2f8af41cd..0af36a38d 100644 --- a/pkg/cmd/alias/list/list_test.go +++ b/pkg/cmd/alias/list/list_test.go @@ -7,6 +7,7 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" "github.com/stretchr/testify/assert" @@ -66,7 +67,7 @@ func TestAliasList(t *testing.T) { factory := &cmdutil.Factory{ IOStreams: ios, - Config: func() (config.Config, error) { + Config: func() (gh.Config, error) { return cfg, nil }, } diff --git a/pkg/cmd/alias/set/set.go b/pkg/cmd/alias/set/set.go index 77de9ca5d..c09f7c0cc 100644 --- a/pkg/cmd/alias/set/set.go +++ b/pkg/cmd/alias/set/set.go @@ -6,7 +6,7 @@ import ( "strings" "github.com/MakeNowJust/heredoc" - "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/pkg/cmd/alias/shared" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" @@ -14,7 +14,7 @@ import ( ) type SetOptions struct { - Config func() (config.Config, error) + Config func() (gh.Config, error) IO *iostreams.IOStreams Name string @@ -35,21 +35,21 @@ func NewCmdSet(f *cmdutil.Factory, runF func(*SetOptions) error) *cobra.Command cmd := &cobra.Command{ Use: "set ", Short: "Create a shortcut for a gh command", - Long: heredoc.Doc(` + Long: heredoc.Docf(` Define a word that will expand to a full gh command when invoked. The expansion may specify additional arguments and flags. If the expansion includes - positional placeholders such as "$1", extra arguments that follow the alias will be + positional placeholders such as %[1]s$1%[1]s, extra arguments that follow the alias will be inserted appropriately. Otherwise, extra arguments will be appended to the expanded command. - Use "-" as expansion argument to read the expansion string from standard input. This + Use %[1]s-%[1]s as expansion argument to read the expansion string from standard input. This is useful to avoid quoting issues when defining expansions. - If the expansion starts with "!" or if "--shell" was given, the expansion is a shell - expression that will be evaluated through the "sh" interpreter when the alias is + If the expansion starts with %[1]s!%[1]s or if %[1]s--shell%[1]s was given, the expansion is a shell + expression that will be evaluated through the %[1]ssh%[1]s interpreter when the alias is invoked. This allows for chaining multiple commands via piping and redirection. - `), + `, "`"), Example: heredoc.Doc(` # note: Command Prompt on Windows requires using double quotes for arguments $ gh alias set pv 'pr view' diff --git a/pkg/cmd/alias/set/set_test.go b/pkg/cmd/alias/set/set_test.go index 4acb8b8b0..40198d878 100644 --- a/pkg/cmd/alias/set/set_test.go +++ b/pkg/cmd/alias/set/set_test.go @@ -6,6 +6,7 @@ import ( "testing" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/pkg/cmd/alias/shared" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" @@ -284,7 +285,7 @@ func TestSetRun(t *testing.T) { cfg.WriteFunc = func() error { return nil } - tt.opts.Config = func() (config.Config, error) { + tt.opts.Config = func() (gh.Config, error) { return cfg, nil } diff --git a/pkg/cmd/api/api.go b/pkg/cmd/api/api.go index 38b6278b4..b44cef2d4 100644 --- a/pkg/cmd/api/api.go +++ b/pkg/cmd/api/api.go @@ -17,7 +17,7 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/api" - "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghinstance" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/pkg/cmd/factory" @@ -29,11 +29,15 @@ import ( "github.com/spf13/cobra" ) +const ( + ttyIndent = " " +) + type ApiOptions struct { AppVersion string BaseRepo func() (ghrepo.Interface, error) Branch func() (string, error) - Config func() (config.Config, error) + Config func() (gh.Config, error) HttpClient func() (*http.Client, error) IO *iostreams.IOStreams @@ -48,6 +52,7 @@ type ApiOptions struct { Previews []string ShowResponseHeaders bool Paginate bool + Slurp bool Silent bool Template string CacheTTL time.Duration @@ -71,50 +76,52 @@ func NewCmdApi(f *cmdutil.Factory, runF func(*ApiOptions) error) *cobra.Command Makes an authenticated HTTP request to the GitHub API and prints the response. The endpoint argument should either be a path of a GitHub API v3 endpoint, or - "graphql" to access the GitHub API v4. + %[1]sgraphql%[1]s to access the GitHub API v4. - Placeholder values "{owner}", "{repo}", and "{branch}" in the endpoint + Placeholder values %[1]s{owner}%[1]s, %[1]s{repo}%[1]s, and %[1]s{branch}%[1]s in the endpoint argument will get replaced with values from the repository of the current - directory or the repository specified in the GH_REPO environment variable. + directory or the repository specified in the %[1]sGH_REPO%[1]s environment variable. Note that in some shells, for example PowerShell, you may need to enclose - any value that contains "{...}" in quotes to prevent the shell from + any value that contains %[1]s{...}%[1]s in quotes to prevent the shell from applying special meaning to curly braces. - The default HTTP request method is "GET" normally and "POST" if any parameters + The default HTTP request method is %[1]sGET%[1]s normally and %[1]sPOST%[1]s if any parameters were added. Override the method with %[1]s--method%[1]s. - Pass one or more %[1]s-f/--raw-field%[1]s values in "key=value" format to add static string + Pass one or more %[1]s-f/--raw-field%[1]s values in %[1]skey=value%[1]s format to add static string parameters to the request payload. To add non-string or placeholder-determined values, see - %[1]s--field%[1]s below. Note that adding request parameters will automatically switch the - request method to POST. To send the parameters as a GET query string instead, use + %[1]s-F/--field%[1]s below. Note that adding request parameters will automatically switch the + request method to %[1]sPOST%[1]s. To send the parameters as a %[1]sGET%[1]s query string instead, use %[1]s--method GET%[1]s. The %[1]s-F/--field%[1]s flag has magic type conversion based on the format of the value: - - literal values "true", "false", "null", and integer numbers get converted to + - literal values %[1]strue%[1]s, %[1]sfalse%[1]s, %[1]snull%[1]s, and integer numbers get converted to appropriate JSON types; - - placeholder values "{owner}", "{repo}", and "{branch}" get populated with values + - placeholder values %[1]s{owner}%[1]s, %[1]s{repo}%[1]s, and %[1]s{branch}%[1]s get populated with values from the repository of the current directory; - - if the value starts with "@", the rest of the value is interpreted as a - filename to read the value from. Pass "-" to read from standard input. + - if the value starts with %[1]s@%[1]s, the rest of the value is interpreted as a + filename to read the value from. Pass %[1]s-%[1]s to read from standard input. - For GraphQL requests, all fields other than "query" and "operationName" are + For GraphQL requests, all fields other than %[1]squery%[1]s and %[1]soperationName%[1]s are interpreted as GraphQL variables. - To pass nested parameters in the request payload, use "key[subkey]=value" syntax when + To pass nested parameters in the request payload, use %[1]skey[subkey]=value%[1]s syntax when declaring fields. To pass nested values as arrays, declare multiple fields with the - syntax "key[]=value1", "key[]=value2". To pass an empty array, use "key[]" without a + syntax %[1]skey[]=value1%[1]s, %[1]skey[]=value2%[1]s. To pass an empty array, use %[1]skey[]%[1]s without a value. To pass pre-constructed JSON or payloads in other formats, a request body may be read - from file specified by %[1]s--input%[1]s. Use "-" to read from standard input. When passing the + from file specified by %[1]s--input%[1]s. Use %[1]s-%[1]s to read from standard input. When passing the request body this way, any parameters specified via field flags are added to the query string of the endpoint URL. In %[1]s--paginate%[1]s mode, all pages of results will sequentially be requested until there are no more pages of results. For GraphQL requests, this requires that the original query accepts an %[1]s$endCursor: String%[1]s variable and that it fetches the - %[1]spageInfo{ hasNextPage, endCursor }%[1]s set of fields from a collection. + %[1]spageInfo{ hasNextPage, endCursor }%[1]s set of fields from a collection. Each page is a separate + JSON array or object. Pass %[1]s--slurp%[1]s to wrap all pages of JSON arrays or objects + into an outer JSON array. `, "`"), Example: heredoc.Doc(` # list releases in the current repository @@ -142,6 +149,13 @@ func NewCmdApi(f *cmdutil.Factory, runF func(*ApiOptions) error) *cobra.Command $ gh api repos/{owner}/{repo}/issues --template \ '{{range .}}{{.title}} ({{.labels | pluck "name" | join ", " | color "yellow"}}){{"\n"}}{{end}}' + # update allowed values of the "environment" custom property in a deeply nested array + gh api --PATCH /orgs/{org}/properties/schema \ + -F 'properties[][property_name]=environment' \ + -F 'properties[][default_value]=production' \ + -F 'properties[][allowed_values][]=staging' \ + -F 'properties[][allowed_values][]=production' + # list releases with GraphQL $ gh api graphql -F owner='{owner}' -F name='{repo}' -f query=' query($name: String!, $owner: String!) { @@ -167,6 +181,22 @@ func NewCmdApi(f *cmdutil.Factory, runF func(*ApiOptions) error) *cobra.Command } } ' + + # get the percentage of forks for the current user + $ gh api graphql --paginate --slurp -f query=' + query($endCursor: String) { + viewer { + repositories(first: 100, after: $endCursor) { + nodes { isFork } + pageInfo { + hasNextPage + endCursor + } + } + } + } + ' | jq 'def count(e): reduce e as $_ (0;.+1); + [.[].data.viewer.repositories.nodes[]] as $r | count(select($r[].isFork))/count($r[])' `), Annotations: map[string]string{ "help:environment": heredoc.Doc(` @@ -209,6 +239,19 @@ func NewCmdApi(f *cmdutil.Factory, runF func(*ApiOptions) error) *cobra.Command return err } + if opts.Slurp && !opts.Paginate { + return cmdutil.FlagErrorf("`--paginate` required when passing `--slurp`") + } + + if err := cmdutil.MutuallyExclusive( + "the `--slurp` option is not supported with `--jq` or `--template`", + opts.Slurp, + opts.FilterOutput != "", + opts.Template != "", + ); err != nil { + return err + } + if err := cmdutil.MutuallyExclusive( "only one of `--template`, `--jq`, `--silent`, or `--verbose` may be used", opts.Verbose, @@ -233,6 +276,7 @@ func NewCmdApi(f *cmdutil.Factory, runF func(*ApiOptions) error) *cobra.Command cmd.Flags().StringArrayVarP(&opts.RequestHeaders, "header", "H", nil, "Add a HTTP request header in `key:value` format") cmd.Flags().StringSliceVarP(&opts.Previews, "preview", "p", nil, "GitHub API preview `names` to request (without the \"-preview\" suffix)") cmd.Flags().BoolVarP(&opts.ShowResponseHeaders, "include", "i", false, "Include HTTP response status line and headers in the output") + cmd.Flags().BoolVar(&opts.Slurp, "slurp", false, "Use with \"--paginate\" to return an array of all pages of either JSON arrays or objects") cmd.Flags().BoolVar(&opts.Paginate, "paginate", false, "Make additional HTTP requests to fetch all pages of results") cmd.Flags().StringVar(&opts.RequestInputFile, "input", "", "The `file` to use as body for the HTTP request (use \"-\" to read from standard input)") cmd.Flags().BoolVar(&opts.Silent, "silent", false, "Do not print the response body") @@ -265,10 +309,40 @@ func apiRun(opts *ApiOptions) error { method = "POST" } + if !opts.Silent { + if err := opts.IO.StartPager(); err == nil { + defer opts.IO.StopPager() + } else { + fmt.Fprintf(opts.IO.ErrOut, "failed to start pager: %v\n", err) + } + } + + var bodyWriter io.Writer = opts.IO.Out + var headersWriter io.Writer = opts.IO.Out + if opts.Silent { + bodyWriter = io.Discard + } + if opts.Verbose { + // httpClient handles output when verbose flag is specified. + bodyWriter = io.Discard + headersWriter = io.Discard + } + if opts.Paginate && !isGraphQL { requestPath = addPerPage(requestPath, 100, params) } + // Similar to `jq --slurp`, write all pages JSON arrays or objects into a JSON array. + if opts.Paginate && opts.Slurp { + w := &jsonArrayWriter{ + Writer: bodyWriter, + color: opts.IO.ColorEnabled(), + } + defer w.Close() + + bodyWriter = w + } + if opts.RequestInputFile != "" { file, size, err := openUserFile(opts.RequestInputFile, opts.IO.In) if err != nil { @@ -298,14 +372,13 @@ func apiRun(opts *ApiOptions) error { log = opts.IO.Out } opts := api.HTTPClientOptions{ - AppVersion: opts.AppVersion, - CacheTTL: opts.CacheTTL, - Config: cfg.Authentication(), - EnableCache: opts.CacheTTL > 0, - Log: log, - LogColorize: opts.IO.ColorEnabled(), - LogVerboseHTTP: opts.Verbose, - SkipAcceptHeaders: true, + AppVersion: opts.AppVersion, + CacheTTL: opts.CacheTTL, + Config: cfg.Authentication(), + EnableCache: opts.CacheTTL > 0, + Log: log, + LogColorize: opts.IO.ColorEnabled(), + LogVerboseHTTP: opts.Verbose, } return api.NewHTTPClient(opts) } @@ -315,25 +388,6 @@ func apiRun(opts *ApiOptions) error { return err } - if !opts.Silent { - if err := opts.IO.StartPager(); err == nil { - defer opts.IO.StopPager() - } else { - fmt.Fprintf(opts.IO.ErrOut, "failed to start pager: %v\n", err) - } - } - - var bodyWriter io.Writer = opts.IO.Out - var headersWriter io.Writer = opts.IO.Out - if opts.Silent { - bodyWriter = io.Discard - } - if opts.Verbose { - // httpClient handles output when verbose flag is specified. - bodyWriter = io.Discard - headersWriter = io.Discard - } - host, _ := cfg.Authentication().DefaultHost() if opts.Hostname != "" { @@ -359,6 +413,12 @@ func apiRun(opts *ApiOptions) error { requestBody = nil // prevent repeating GET parameters } + // Tell optional jsonArrayWriter to start a new page. + err = startPage(bodyWriter) + if err != nil { + return err + } + endCursor, err := processResponse(resp, opts, bodyWriter, headersWriter, tmpl, isFirstPage, !hasNextPage) if err != nil { return err @@ -418,7 +478,7 @@ func processResponse(resp *http.Response, opts *ApiOptions, bodyWriter, headersW // TODO: reuse parsed query across pagination invocations indent := "" if opts.IO.IsStdoutTTY() { - indent = " " + indent = ttyIndent } err = jq.EvaluateFormatted(responseBody, bodyWriter, opts.FilterOutput, indent, opts.IO.ColorEnabled()) if err != nil { @@ -430,9 +490,9 @@ func processResponse(resp *http.Response, opts *ApiOptions, bodyWriter, headersW return } } else if isJSON && opts.IO.ColorEnabled() { - err = jsoncolor.Write(bodyWriter, responseBody, " ") + err = jsoncolor.Write(bodyWriter, responseBody, ttyIndent) } else { - if isJSON && opts.Paginate && !isGraphQLPaginate && !opts.ShowResponseHeaders { + if isJSON && opts.Paginate && !opts.Slurp && !isGraphQLPaginate && !opts.ShowResponseHeaders { responseBody = &paginatedArrayReader{ Reader: responseBody, isFirstPage: isFirstPage, diff --git a/pkg/cmd/api/api_test.go b/pkg/cmd/api/api_test.go index 178bebd86..a565312cd 100644 --- a/pkg/cmd/api/api_test.go +++ b/pkg/cmd/api/api_test.go @@ -6,8 +6,8 @@ import ( "fmt" "io" "net/http" + "net/http/httptest" "os" - "path/filepath" "runtime" "strings" "testing" @@ -16,6 +16,8 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/git" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" + ghmock "github.com/cli/cli/v2/internal/gh/mock" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" @@ -328,6 +330,21 @@ func Test_NewCmdApi(t *testing.T) { cli: "user --jq .foo -t '{{.foo}}'", wantsErr: true, }, + { + name: "--slurp without --paginate", + cli: "user --slurp", + wantsErr: true, + }, + { + name: "slurp with --jq", + cli: "user --paginate --slurp --jq .foo", + wantsErr: true, + }, + { + name: "slurp with --template", + cli: "user --paginate --slurp --template '{{.foo}}'", + wantsErr: true, + }, { name: "with verbose", cli: "user --verbose", @@ -551,6 +568,34 @@ func Test_apiRun(t *testing.T) { stderr: ``, isatty: false, }, + { + name: "output template with range", + options: ApiOptions{ + Template: `{{range .}}{{.title}} ({{.labels | pluck "name" | join ", " }}){{"\n"}}{{end}}`, + }, + httpResponse: &http.Response{ + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(`[ + { + "title": "First title", + "labels": [{"name":"bug"}, {"name":"help wanted"}] + }, + { + "title": "Second but not last" + }, + { + "title": "Alas, tis' the end", + "labels": [{}, {"name":"feature"}] + } + ]`)), + Header: http.Header{"Content-Type": []string{"application/json"}}, + }, + stdout: heredoc.Doc(` + First title (bug, help wanted) + Second but not last () + Alas, tis' the end (, feature) + `), + }, { name: "output template when REST error", options: ApiOptions{ @@ -619,7 +664,7 @@ func Test_apiRun(t *testing.T) { ios.SetStdoutTTY(tt.isatty) tt.options.IO = ios - tt.options.Config = func() (config.Config, error) { return config.NewBlankConfig(), nil } + tt.options.Config = func() (gh.Config, error) { return config.NewBlankConfig(), nil } tt.options.HttpClient = func() (*http.Client, error) { var tr roundTripper = func(req *http.Request) (*http.Response, error) { resp := tt.httpResponse @@ -650,23 +695,36 @@ func Test_apiRun_paginationREST(t *testing.T) { requestCount := 0 responses := []*http.Response{ { + Proto: "HTTP/1.1", + Status: "200 OK", StatusCode: 200, Body: io.NopCloser(bytes.NewBufferString(`{"page":1}`)), Header: http.Header{ - "Link": []string{`; rel="next", ; rel="last"`}, + "Content-Type": []string{"application/json"}, + "Link": []string{`; rel="next", ; rel="last"`}, + "X-Github-Request-Id": []string{"1"}, }, }, { + Proto: "HTTP/1.1", + Status: "200 OK", StatusCode: 200, Body: io.NopCloser(bytes.NewBufferString(`{"page":2}`)), Header: http.Header{ - "Link": []string{`; rel="next", ; rel="last"`}, + "Content-Type": []string{"application/json"}, + "Link": []string{`; rel="next", ; rel="last"`}, + "X-Github-Request-Id": []string{"2"}, }, }, { + Proto: "HTTP/1.1", + Status: "200 OK", StatusCode: 200, Body: io.NopCloser(bytes.NewBufferString(`{"page":3}`)), - Header: http.Header{}, + Header: http.Header{ + "Content-Type": []string{"application/json"}, + "X-Github-Request-Id": []string{"3"}, + }, }, } @@ -681,7 +739,7 @@ func Test_apiRun_paginationREST(t *testing.T) { } return &http.Client{Transport: tr}, nil }, - Config: func() (config.Config, error) { + Config: func() (gh.Config, error) { return config.NewBlankConfig(), nil }, @@ -753,7 +811,7 @@ func Test_apiRun_arrayPaginationREST(t *testing.T) { } return &http.Client{Transport: tr}, nil }, - Config: func() (config.Config, error) { + Config: func() (gh.Config, error) { return config.NewBlankConfig(), nil }, @@ -775,36 +833,42 @@ func Test_apiRun_arrayPaginationREST(t *testing.T) { assert.Equal(t, "https://api.github.com/repositories/1227/issues?page=3", responses[2].Request.URL.String()) } -func Test_apiRun_paginationGraphQL(t *testing.T) { +func Test_apiRun_arrayPaginationREST_with_headers(t *testing.T) { ios, _, stdout, stderr := iostreams.Test() requestCount := 0 responses := []*http.Response{ { + Proto: "HTTP/1.1", + Status: "200 OK", StatusCode: 200, - Header: http.Header{"Content-Type": []string{`application/json`}}, - Body: io.NopCloser(bytes.NewBufferString(`{ - "data": { - "nodes": ["page one"], - "pageInfo": { - "endCursor": "PAGE1_END", - "hasNextPage": true - } - } - }`)), + Body: io.NopCloser(bytes.NewBufferString(`[{"page":1}]`)), + Header: http.Header{ + "Content-Type": []string{"application/json"}, + "Link": []string{`; rel="next", ; rel="last"`}, + "X-Github-Request-Id": []string{"1"}, + }, }, { + Proto: "HTTP/1.1", + Status: "200 OK", StatusCode: 200, - Header: http.Header{"Content-Type": []string{`application/json`}}, - Body: io.NopCloser(bytes.NewBufferString(`{ - "data": { - "nodes": ["page two"], - "pageInfo": { - "endCursor": "PAGE2_END", - "hasNextPage": false - } - } - }`)), + Body: io.NopCloser(bytes.NewBufferString(`[{"page":2}]`)), + Header: http.Header{ + "Content-Type": []string{"application/json"}, + "Link": []string{`; rel="next", ; rel="last"`}, + "X-Github-Request-Id": []string{"2"}, + }, + }, + { + Proto: "HTTP/1.1", + Status: "200 OK", + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(`[{"page":3}]`)), + Header: http.Header{ + "Content-Type": []string{"application/json"}, + "X-Github-Request-Id": []string{"3"}, + }, }, } @@ -819,7 +883,76 @@ func Test_apiRun_paginationGraphQL(t *testing.T) { } return &http.Client{Transport: tr}, nil }, - Config: func() (config.Config, error) { + Config: func() (gh.Config, error) { + return config.NewBlankConfig(), nil + }, + + RequestMethod: "GET", + RequestMethodPassed: true, + RequestPath: "issues", + Paginate: true, + RawFields: []string{"per_page=50", "page=1"}, + ShowResponseHeaders: true, + } + + err := apiRun(&options) + assert.NoError(t, err) + + assert.Equal(t, "HTTP/1.1 200 OK\nContent-Type: application/json\r\nLink: ; rel=\"next\", ; rel=\"last\"\r\nX-Github-Request-Id: 1\r\n\r\n[{\"page\":1}]\nHTTP/1.1 200 OK\nContent-Type: application/json\r\nLink: ; rel=\"next\", ; rel=\"last\"\r\nX-Github-Request-Id: 2\r\n\r\n[{\"page\":2}]\nHTTP/1.1 200 OK\nContent-Type: application/json\r\nX-Github-Request-Id: 3\r\n\r\n[{\"page\":3}]", stdout.String(), "stdout") + assert.Equal(t, "", stderr.String(), "stderr") + + assert.Equal(t, "https://api.github.com/issues?page=1&per_page=50", responses[0].Request.URL.String()) + assert.Equal(t, "https://api.github.com/repositories/1227/issues?page=2", responses[1].Request.URL.String()) + assert.Equal(t, "https://api.github.com/repositories/1227/issues?page=3", responses[2].Request.URL.String()) +} + +func Test_apiRun_paginationGraphQL(t *testing.T) { + ios, _, stdout, stderr := iostreams.Test() + + requestCount := 0 + responses := []*http.Response{ + { + StatusCode: 200, + Header: http.Header{"Content-Type": []string{`application/json`}}, + Body: io.NopCloser(bytes.NewBufferString(heredoc.Doc(` + { + "data": { + "nodes": ["page one"], + "pageInfo": { + "endCursor": "PAGE1_END", + "hasNextPage": true + } + } + }`))), + }, + { + StatusCode: 200, + Header: http.Header{"Content-Type": []string{`application/json`}}, + Body: io.NopCloser(bytes.NewBufferString(heredoc.Doc(` + { + "data": { + "nodes": ["page two"], + "pageInfo": { + "endCursor": "PAGE2_END", + "hasNextPage": false + } + } + }`))), + }, + } + + options := ApiOptions{ + IO: ios, + HttpClient: func() (*http.Client, error) { + var tr roundTripper = func(req *http.Request) (*http.Response, error) { + resp := responses[requestCount] + resp.Request = req + requestCount++ + return resp, nil + } + return &http.Client{Transport: tr}, nil + }, + Config: func() (gh.Config, error) { return config.NewBlankConfig(), nil }, @@ -832,8 +965,127 @@ func Test_apiRun_paginationGraphQL(t *testing.T) { err := apiRun(&options) require.NoError(t, err) - assert.Contains(t, stdout.String(), `"page one"`) - assert.Contains(t, stdout.String(), `"page two"`) + assert.Equal(t, heredoc.Doc(` + { + "data": { + "nodes": ["page one"], + "pageInfo": { + "endCursor": "PAGE1_END", + "hasNextPage": true + } + } + }{ + "data": { + "nodes": ["page two"], + "pageInfo": { + "endCursor": "PAGE2_END", + "hasNextPage": false + } + } + }`), stdout.String()) + assert.Equal(t, "", stderr.String(), "stderr") + + var requestData struct { + Variables map[string]interface{} + } + + bb, err := io.ReadAll(responses[0].Request.Body) + require.NoError(t, err) + err = json.Unmarshal(bb, &requestData) + require.NoError(t, err) + _, hasCursor := requestData.Variables["endCursor"].(string) + assert.Equal(t, false, hasCursor) + + bb, err = io.ReadAll(responses[1].Request.Body) + require.NoError(t, err) + err = json.Unmarshal(bb, &requestData) + require.NoError(t, err) + endCursor, hasCursor := requestData.Variables["endCursor"].(string) + assert.Equal(t, true, hasCursor) + assert.Equal(t, "PAGE1_END", endCursor) +} + +func Test_apiRun_paginationGraphQL_slurp(t *testing.T) { + ios, _, stdout, stderr := iostreams.Test() + + requestCount := 0 + responses := []*http.Response{ + { + StatusCode: 200, + Header: http.Header{"Content-Type": []string{`application/json`}}, + Body: io.NopCloser(bytes.NewBufferString(heredoc.Doc(` + { + "data": { + "nodes": ["page one"], + "pageInfo": { + "endCursor": "PAGE1_END", + "hasNextPage": true + } + } + }`))), + }, + { + StatusCode: 200, + Header: http.Header{"Content-Type": []string{`application/json`}}, + Body: io.NopCloser(bytes.NewBufferString(heredoc.Doc(` + { + "data": { + "nodes": ["page two"], + "pageInfo": { + "endCursor": "PAGE2_END", + "hasNextPage": false + } + } + }`))), + }, + } + + options := ApiOptions{ + IO: ios, + HttpClient: func() (*http.Client, error) { + var tr roundTripper = func(req *http.Request) (*http.Response, error) { + resp := responses[requestCount] + resp.Request = req + requestCount++ + return resp, nil + } + return &http.Client{Transport: tr}, nil + }, + Config: func() (gh.Config, error) { + return config.NewBlankConfig(), nil + }, + + RawFields: []string{"foo=bar"}, + RequestMethod: "POST", + RequestPath: "graphql", + Paginate: true, + Slurp: true, + } + + err := apiRun(&options) + require.NoError(t, err) + + assert.JSONEq(t, stdout.String(), `[ + { + "data": { + "nodes": ["page one"], + "pageInfo": { + "endCursor": "PAGE1_END", + "hasNextPage": true + } + } + }, + { + + "data": { + "nodes": ["page two"], + "pageInfo": { + "endCursor": "PAGE2_END", + "hasNextPage": false + } + } + } + ]`) assert.Equal(t, "", stderr.String(), "stderr") var requestData struct { @@ -911,7 +1163,7 @@ func Test_apiRun_paginated_template(t *testing.T) { } return &http.Client{Transport: tr}, nil }, - Config: func() (config.Config, error) { + Config: func() (gh.Config, error) { return config.NewBlankConfig(), nil }, @@ -958,7 +1210,7 @@ func Test_apiRun_DELETE(t *testing.T) { var gotRequest *http.Request err := apiRun(&ApiOptions{ IO: ios, - Config: func() (config.Config, error) { + Config: func() (gh.Config, error) { return config.NewBlankConfig(), nil }, HttpClient: func() (*http.Client, error) { @@ -1043,7 +1295,7 @@ func Test_apiRun_inputFile(t *testing.T) { } return &http.Client{Transport: tr}, nil }, - Config: func() (config.Config, error) { + Config: func() (gh.Config, error) { return config.NewBlankConfig(), nil }, } @@ -1063,40 +1315,41 @@ func Test_apiRun_inputFile(t *testing.T) { } func Test_apiRun_cache(t *testing.T) { - ios, _, stdout, stderr := iostreams.Test() - + // Given we have a test server that spies on the number of requests it receives requestCount := 0 + s := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + requestCount++ + w.WriteHeader(http.StatusNoContent) + })) + t.Cleanup(s.Close) + + ios, _, stdout, stderr := iostreams.Test() options := ApiOptions{ IO: ios, - HttpClient: func() (*http.Client, error) { - var tr roundTripper = func(req *http.Request) (*http.Response, error) { - requestCount++ - return &http.Response{ - Request: req, - StatusCode: 204, - }, nil - } - return &http.Client{Transport: tr}, nil + Config: func() (gh.Config, error) { + return &ghmock.ConfigMock{ + AuthenticationFunc: func() gh.AuthConfig { + return &config.AuthConfig{} + }, + // Cached responses are stored in a tempdir that gets automatically cleaned up + CacheDirFunc: func() string { + return t.TempDir() + }, + }, nil }, - Config: func() (config.Config, error) { - return config.NewBlankConfig(), nil - }, - - RequestPath: "issues", + // You might think that we want to set Host: s.URL here, but you'd be wrong. + // The host field is later used to evaluate an API URL e.g. https://api.host.com/graphql + // The RequestPath field is used exactly as is, for the request if it includes a host. + RequestPath: s.URL, CacheTTL: time.Minute, } - t.Cleanup(func() { - cacheDir := filepath.Join(os.TempDir(), "gh-cli-cache") - os.RemoveAll(cacheDir) - }) + // When we run the API behaviour twice + require.NoError(t, apiRun(&options)) + require.NoError(t, apiRun(&options)) - err := apiRun(&options) - assert.NoError(t, err) - err = apiRun(&options) - assert.NoError(t, err) - - assert.Equal(t, 2, requestCount) + // We only get one request to the http server because it uses the cached response + assert.Equal(t, 1, requestCount) assert.Equal(t, "", stdout.String(), "stdout") assert.Equal(t, "", stderr.String(), "stderr") } @@ -1455,3 +1708,58 @@ func Test_parseErrorResponse(t *testing.T) { }) } } + +func Test_apiRun_acceptHeader(t *testing.T) { + tests := []struct { + name string + options ApiOptions + wantAcceptHeader string + }{ + { + name: "sets default accept header", + options: ApiOptions{}, + wantAcceptHeader: "*/*", + }, + { + name: "does not override user accept header", + options: ApiOptions{ + RequestHeaders: []string{"Accept: testing"}, + }, + wantAcceptHeader: "testing", + }, + { + name: "does not override preview names", + options: ApiOptions{ + Previews: []string{"nebula"}, + }, + wantAcceptHeader: "application/vnd.github.nebula-preview+json", + }, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + ios, _, _, _ := iostreams.Test() + tt.options.IO = ios + + tt.options.Config = func() (gh.Config, error) { + return config.NewBlankConfig(), nil + } + + var gotReq *http.Request + tt.options.HttpClient = func() (*http.Client, error) { + var tr roundTripper = func(req *http.Request) (*http.Response, error) { + gotReq = req + resp := &http.Response{ + StatusCode: 200, + Request: req, + Body: io.NopCloser(bytes.NewBufferString("")), + } + return resp, nil + } + return &http.Client{Transport: tr}, nil + } + + assert.NoError(t, apiRun(&tt.options)) + assert.Equal(t, tt.wantAcceptHeader, gotReq.Header.Get("Accept")) + }) + } +} diff --git a/pkg/cmd/api/fields.go b/pkg/cmd/api/fields.go index 40167c498..024eb12ca 100644 --- a/pkg/cmd/api/fields.go +++ b/pkg/cmd/api/fields.go @@ -2,6 +2,7 @@ package api import ( "fmt" + "reflect" "strconv" "strings" ) @@ -98,6 +99,9 @@ func parseFields(opts *ApiOptions) (map[string]interface{}, error) { } } } else { + if _, exists := destMap[subkey]; exists { + return fmt.Errorf("unexpected override existing field under %q", subkey) + } destMap[subkey] = value } return nil @@ -136,6 +140,8 @@ func addParamsSlice(m map[string]interface{}, prevkey, newkey string) (map[strin if lastMap, ok := lastItem.(map[string]interface{}); ok { if _, keyExists := lastMap[newkey]; !keyExists { return lastMap, nil + } else if reflect.TypeOf(lastMap[newkey]).Kind() == reflect.Slice { + return lastMap, nil } } } diff --git a/pkg/cmd/api/fields_test.go b/pkg/cmd/api/fields_test.go index 6fd051209..73bc7463c 100644 --- a/pkg/cmd/api/fields_test.go +++ b/pkg/cmd/api/fields_test.go @@ -11,6 +11,7 @@ import ( "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/pkg/iostreams" "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" ) func Test_parseFields(t *testing.T) { @@ -61,8 +62,14 @@ func Test_parseFields_nested(t *testing.T) { "robots[]=Dependabot", "labels[][name]=bug", "labels[][color]=red", + "labels[][colorOptions][]=red", + "labels[][colorOptions][]=blue", "labels[][name]=feature", "labels[][color]=green", + "labels[][colorOptions][]=red", + "labels[][colorOptions][]=green", + "labels[][colorOptions][]=yellow", + "nested[][key1][key2][key3]=value", "empty[]", }, MagicFields: []string{ @@ -96,13 +103,31 @@ func Test_parseFields_nested(t *testing.T) { "labels": [ { "color": "red", + "colorOptions": [ + "red", + "blue" + ], "name": "bug" }, { "color": "green", + "colorOptions": [ + "red", + "green", + "yellow" + ], "name": "feature" } ], + "nested": [ + { + "key1": { + "key2": { + "key3": "value" + } + } + } + ], "robots": [ "Hubot", "Dependabot" @@ -111,6 +136,91 @@ func Test_parseFields_nested(t *testing.T) { `), "\n"), string(jsonData)) } +func Test_parseFields_errors(t *testing.T) { + ios, stdin, _, _ := iostreams.Test() + fmt.Fprint(stdin, "pasted contents") + + tests := []struct { + name string + opts *ApiOptions + expected string + }{ + { + name: "cannot overwrite string to array", + opts: &ApiOptions{ + IO: ios, + RawFields: []string{ + "object[field]=A", + "object[field][]=this should be an error", + }, + }, + expected: `expected array type under "field", got string`, + }, + { + name: "cannot overwrite string to object", + opts: &ApiOptions{ + IO: ios, + RawFields: []string{ + "object[field]=B", + "object[field][field2]=this should be an error", + }, + }, + expected: `expected map type under "field", got string`, + }, + { + name: "cannot overwrite object to string", + opts: &ApiOptions{ + IO: ios, + RawFields: []string{ + "object[field][field2]=C", + "object[field]=this should be an error", + }, + }, + expected: `unexpected override existing field under "field"`, + }, + { + name: "cannot overwrite object to array", + opts: &ApiOptions{ + IO: ios, + RawFields: []string{ + "object[field][field2]=D", + "object[field][]=this should be an error", + }, + }, + expected: `expected array type under "field", got map[string]interface {}`, + }, + { + name: "cannot overwrite array to string", + opts: &ApiOptions{ + IO: ios, + RawFields: []string{ + "object[field][]=E", + "object[field]=this should be an error", + }, + }, + expected: `unexpected override existing field under "field"`, + }, + { + name: "cannot overwrite array to object", + opts: &ApiOptions{ + IO: ios, + RawFields: []string{ + "object[field][]=F", + "object[field][field2]=this should be an error", + }, + }, + expected: `expected map type under "field", got []interface {}`, + }, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + _, err := parseFields(tt.opts) + require.EqualError(t, err, tt.expected) + }) + } +} + func Test_magicFieldValue(t *testing.T) { f, err := os.CreateTemp(t.TempDir(), "gh-test") if err != nil { diff --git a/pkg/cmd/api/http.go b/pkg/cmd/api/http.go index 3d6bb240e..b1b503cc2 100644 --- a/pkg/cmd/api/http.go +++ b/pkg/cmd/api/http.go @@ -74,6 +74,9 @@ func httpRequest(client *http.Client, hostname string, method string, p string, if bodyIsJSON && req.Header.Get("Content-Type") == "" { req.Header.Set("Content-Type", "application/json; charset=utf-8") } + if req.Header.Get("Accept") == "" { + req.Header.Set("Accept", "*/*") + } return client.Do(req) } diff --git a/pkg/cmd/api/http_test.go b/pkg/cmd/api/http_test.go index f63566490..2778ea38c 100644 --- a/pkg/cmd/api/http_test.go +++ b/pkg/cmd/api/http_test.go @@ -126,7 +126,25 @@ func Test_httpRequest(t *testing.T) { method: "GET", u: "https://api.github.com/repos/octocat/spoon-knife", body: "", - headers: "", + headers: "Accept: */*\r\n", + }, + }, + { + name: "GET with accept header", + args: args{ + client: &httpClient, + host: "github.com", + method: "GET", + p: "repos/octocat/spoon-knife", + params: nil, + headers: []string{"Accept: testing"}, + }, + wantErr: false, + want: expects{ + method: "GET", + u: "https://api.github.com/repos/octocat/spoon-knife", + body: "", + headers: "Accept: testing\r\n", }, }, { @@ -144,7 +162,7 @@ func Test_httpRequest(t *testing.T) { method: "GET", u: "https://api.github.com/repos/octocat/spoon-knife", body: "", - headers: "", + headers: "Accept: */*\r\n", }, }, { @@ -162,7 +180,7 @@ func Test_httpRequest(t *testing.T) { method: "GET", u: "https://api.github.com/repos/octocat/spoon-knife", body: "", - headers: "", + headers: "Accept: */*\r\n", }, }, { @@ -180,7 +198,7 @@ func Test_httpRequest(t *testing.T) { method: "GET", u: "https://example.org/api/v3/repos/octocat/spoon-knife", body: "", - headers: "", + headers: "Accept: */*\r\n", }, }, { @@ -200,7 +218,7 @@ func Test_httpRequest(t *testing.T) { method: "GET", u: "https://api.github.com/repos/octocat/spoon-knife?a=b", body: "", - headers: "", + headers: "Accept: */*\r\n", }, }, { @@ -220,7 +238,7 @@ func Test_httpRequest(t *testing.T) { method: "POST", u: "https://api.github.com/repos", body: `{"a":"b"}`, - headers: "Content-Type: application/json; charset=utf-8\r\n", + headers: "Accept: */*\r\nContent-Type: application/json; charset=utf-8\r\n", }, }, { @@ -240,7 +258,7 @@ func Test_httpRequest(t *testing.T) { method: "POST", u: "https://api.github.com/graphql", body: `{"variables":{"a":"b"}}`, - headers: "Content-Type: application/json; charset=utf-8\r\n", + headers: "Accept: */*\r\nContent-Type: application/json; charset=utf-8\r\n", }, }, { @@ -258,7 +276,7 @@ func Test_httpRequest(t *testing.T) { method: "POST", u: "https://example.org/api/graphql", body: `{}`, - headers: "Content-Type: application/json; charset=utf-8\r\n", + headers: "Accept: */*\r\nContent-Type: application/json; charset=utf-8\r\n", }, }, { diff --git a/pkg/cmd/api/pagination.go b/pkg/cmd/api/pagination.go index 057a5a7fa..bf4a2f794 100644 --- a/pkg/cmd/api/pagination.go +++ b/pkg/cmd/api/pagination.go @@ -8,6 +8,8 @@ import ( "net/url" "regexp" "strings" + + "github.com/cli/cli/v2/pkg/jsoncolor" ) var linkRE = regexp.MustCompile(`<([^>]+)>;\s*rel="([^"]+)"`) @@ -146,3 +148,94 @@ func (r *paginatedArrayReader) Read(p []byte) (int, error) { r.isSubsequentRead = true return n, err } + +// jsonArrayWriter wraps a Writer which writes multiple pages of both JSON arrays +// and objects. Call Close to write the end of the array. +type jsonArrayWriter struct { + io.Writer + started bool + color bool +} + +func (w *jsonArrayWriter) Preface() []json.Delim { + if w.started { + return []json.Delim{'['} + } + return nil +} + +// ReadFrom implements io.ReaderFrom to write more data than read, +// which otherwise results in an error from io.Copy(). +func (w *jsonArrayWriter) ReadFrom(r io.Reader) (int64, error) { + var written int64 + buf := make([]byte, 4069) + for { + n, err := r.Read(buf) + if n > 0 { + n, err := w.Write(buf[:n]) + written += int64(n) + + if err != nil { + return written, err + } + } + if err == io.EOF { + break + } + if err != nil { + return written, err + } + } + + return written, nil +} + +func (w *jsonArrayWriter) Close() error { + var delims string + if w.started { + delims = "]" + } else { + delims = "[]" + } + + w.started = false + if w.color { + return jsoncolor.WriteDelims(w, delims, ttyIndent) + } + + _, err := w.Writer.Write([]byte(delims)) + return err +} + +func startPage(w io.Writer) error { + if jaw, ok := w.(*jsonArrayWriter); ok { + var delims string + var indent bool + + if !jaw.started { + delims = "[" + jaw.started = true + } else { + delims = "," + indent = true + } + + if jaw.color { + if indent { + _, err := jaw.Write([]byte(ttyIndent)) + if err != nil { + return err + } + } + + return jsoncolor.WriteDelims(w, delims, ttyIndent) + } + + _, err := jaw.Write([]byte(delims)) + if err != nil { + return err + } + } + + return nil +} diff --git a/pkg/cmd/api/pagination_test.go b/pkg/cmd/api/pagination_test.go index 3bb1a8ec5..746a73c4a 100644 --- a/pkg/cmd/api/pagination_test.go +++ b/pkg/cmd/api/pagination_test.go @@ -5,6 +5,9 @@ import ( "io" "net/http" "testing" + + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" ) func Test_findNextPage(t *testing.T) { @@ -167,3 +170,107 @@ func Test_addPerPage(t *testing.T) { }) } } + +func TestJsonArrayWriter(t *testing.T) { + tests := []struct { + name string + pages []string + want string + }{ + { + name: "empty", + pages: nil, + want: "[]", + }, + { + name: "single array", + pages: []string{`[1,2]`}, + want: `[[1,2]]`, + }, + { + name: "multiple arrays", + pages: []string{`[1,2]`, `[3]`}, + want: `[[1,2],[3]]`, + }, + { + name: "single object", + pages: []string{`{"foo":1,"bar":"a"}`}, + want: `[{"foo":1,"bar":"a"}]`, + }, + { + name: "multiple pages", + pages: []string{`{"foo":1,"bar":"a"}`, `{"foo":2,"bar":"b"}`}, + want: `[{"foo":1,"bar":"a"},{"foo":2,"bar":"b"}]`, + }, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + buf := &bytes.Buffer{} + w := &jsonArrayWriter{ + Writer: buf, + } + + for _, page := range tt.pages { + require.NoError(t, startPage(w)) + + n, err := w.Write([]byte(page)) + require.NoError(t, err) + assert.Equal(t, len(page), n) + } + + require.NoError(t, w.Close()) + assert.Equal(t, tt.want, buf.String()) + }) + } +} + +func TestJsonArrayWriter_Copy(t *testing.T) { + tests := []struct { + name string + limit int + }{ + { + name: "unlimited", + }, + { + name: "limited", + limit: 2, + }, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + buf := &bytes.Buffer{} + w := &jsonArrayWriter{ + Writer: buf, + } + + r := &noWriteToReader{ + Reader: bytes.NewBufferString(`[1,2]`), + limit: tt.limit, + } + + require.NoError(t, startPage(w)) + + n, err := io.Copy(w, r) + require.NoError(t, err) + assert.Equal(t, int64(5), n) + + require.NoError(t, w.Close()) + assert.Equal(t, `[[1,2]]`, buf.String()) + }) + } +} + +type noWriteToReader struct { + io.Reader + limit int +} + +func (r *noWriteToReader) Read(p []byte) (int, error) { + if r.limit > 0 { + p = p[:r.limit] + } + return r.Reader.Read(p) +} diff --git a/pkg/cmd/attestation/api/attestation.go b/pkg/cmd/attestation/api/attestation.go new file mode 100644 index 000000000..2b96a51fc --- /dev/null +++ b/pkg/cmd/attestation/api/attestation.go @@ -0,0 +1,33 @@ +package api + +import ( + "fmt" + + "github.com/sigstore/sigstore-go/pkg/bundle" +) + +const ( + GetAttestationByRepoAndSubjectDigestPath = "repos/%s/attestations/%s" + GetAttestationByOwnerAndSubjectDigestPath = "orgs/%s/attestations/%s" +) + +type ErrNoAttestations struct { + name string + digest string +} + +func (e ErrNoAttestations) Error() string { + return fmt.Sprintf("no attestations found for digest %s in %s", e.name, e.digest) +} + +func newErrNoAttestations(name, digest string) ErrNoAttestations { + return ErrNoAttestations{name, digest} +} + +type Attestation struct { + Bundle *bundle.ProtobufBundle `json:"bundle"` +} + +type AttestationsResponse struct { + Attestations []*Attestation `json:"attestations"` +} diff --git a/pkg/cmd/attestation/api/client.go b/pkg/cmd/attestation/api/client.go new file mode 100644 index 000000000..b0cafa6e9 --- /dev/null +++ b/pkg/cmd/attestation/api/client.go @@ -0,0 +1,104 @@ +package api + +import ( + "fmt" + "io" + "net/http" + "strings" + + "github.com/cli/cli/v2/api" + ioconfig "github.com/cli/cli/v2/pkg/cmd/attestation/io" + "github.com/cli/go-gh/v2/pkg/auth" +) + +const ( + DefaultLimit = 30 + maxLimitForFlag = 1000 + maxLimitForFetch = 100 +) + +type apiClient interface { + RESTWithNext(hostname, method, p string, body io.Reader, data interface{}) (string, error) +} + +type Client interface { + GetByRepoAndDigest(repo, digest string, limit int) ([]*Attestation, error) + GetByOwnerAndDigest(owner, digest string, limit int) ([]*Attestation, error) +} + +type LiveClient struct { + api apiClient + host string + logger *ioconfig.Handler +} + +func NewLiveClient(hc *http.Client, l *ioconfig.Handler) *LiveClient { + host, _ := auth.DefaultHost() + + return &LiveClient{ + api: api.NewClientFromHTTP(hc), + host: strings.TrimSuffix(host, "/"), + logger: l, + } +} + +func (c *LiveClient) BuildRepoAndDigestURL(repo, digest string) string { + repo = strings.Trim(repo, "/") + return fmt.Sprintf(GetAttestationByRepoAndSubjectDigestPath, repo, digest) +} + +// GetByRepoAndDigest fetches the attestation by repo and digest +func (c *LiveClient) GetByRepoAndDigest(repo, digest string, limit int) ([]*Attestation, error) { + url := c.BuildRepoAndDigestURL(repo, digest) + return c.getAttestations(url, repo, digest, limit) +} + +func (c *LiveClient) BuildOwnerAndDigestURL(owner, digest string) string { + owner = strings.Trim(owner, "/") + return fmt.Sprintf(GetAttestationByOwnerAndSubjectDigestPath, owner, digest) +} + +// GetByOwnerAndDigest fetches attestation by owner and digest +func (c *LiveClient) GetByOwnerAndDigest(owner, digest string, limit int) ([]*Attestation, error) { + url := c.BuildOwnerAndDigestURL(owner, digest) + return c.getAttestations(url, owner, digest, limit) +} + +func (c *LiveClient) getAttestations(url, name, digest string, limit int) ([]*Attestation, error) { + c.logger.VerbosePrintf("Fetching attestations for artifact digest %s\n\n", digest) + + perPage := limit + if perPage <= 0 || perPage > maxLimitForFlag { + return nil, fmt.Errorf("limit must be greater than 0 and less than or equal to %d", maxLimitForFlag) + } + + if perPage > maxLimitForFetch { + perPage = maxLimitForFetch + } + + // ref: https://github.com/cli/go-gh/blob/d32c104a9a25c9de3d7c7b07a43ae0091441c858/example_gh_test.go#L96 + url = fmt.Sprintf("%s?per_page=%d", url, perPage) + + var attestations []*Attestation + var resp AttestationsResponse + var err error + // if no attestation or less than limit, then keep fetching + for url != "" && len(attestations) < limit { + url, err = c.api.RESTWithNext(c.host, http.MethodGet, url, nil, &resp) + if err != nil { + return nil, err + } + + attestations = append(attestations, resp.Attestations...) + } + + if len(attestations) == 0 { + return nil, newErrNoAttestations(name, digest) + } + + if len(attestations) > limit { + return attestations[:limit], nil + } + + return attestations, nil +} diff --git a/pkg/cmd/attestation/api/client_test.go b/pkg/cmd/attestation/api/client_test.go new file mode 100644 index 000000000..7044a1cc5 --- /dev/null +++ b/pkg/cmd/attestation/api/client_test.go @@ -0,0 +1,174 @@ +package api + +import ( + "testing" + + "github.com/cli/cli/v2/pkg/cmd/attestation/io" + + "github.com/stretchr/testify/require" +) + +const ( + testRepo = "github/example" + testOwner = "github" + testDigest = "sha256:12313213" +) + +func NewClientWithMockGHClient(hasNextPage bool) Client { + fetcher := mockDataGenerator{ + NumAttestations: 5, + } + l := io.NewTestHandler() + + if hasNextPage { + return &LiveClient{ + api: mockAPIClient{ + OnRESTWithNext: fetcher.OnRESTSuccessWithNextPage, + }, + logger: l, + } + } + + return &LiveClient{ + api: mockAPIClient{ + OnRESTWithNext: fetcher.OnRESTSuccess, + }, + logger: l, + } +} + +func TestGetURL(t *testing.T) { + c := LiveClient{} + + testData := []struct { + repo string + digest string + expected string + }{ + {repo: "/github/example/", digest: "sha256:12313213", expected: "repos/github/example/attestations/sha256:12313213"}, + {repo: "/github/example", digest: "sha256:12313213", expected: "repos/github/example/attestations/sha256:12313213"}, + } + + for _, data := range testData { + s := c.BuildRepoAndDigestURL(data.repo, data.digest) + require.Equal(t, data.expected, s) + } +} + +func TestGetByDigest(t *testing.T) { + c := NewClientWithMockGHClient(false) + attestations, err := c.GetByRepoAndDigest(testRepo, testDigest, DefaultLimit) + require.NoError(t, err) + + require.Equal(t, 5, len(attestations)) + bundle := (attestations)[0].Bundle + require.Equal(t, bundle.GetMediaType(), "application/vnd.dev.sigstore.bundle+json;version=0.1") + + attestations, err = c.GetByOwnerAndDigest(testOwner, testDigest, DefaultLimit) + require.NoError(t, err) + + require.Equal(t, 5, len(attestations)) + bundle = (attestations)[0].Bundle + require.Equal(t, bundle.GetMediaType(), "application/vnd.dev.sigstore.bundle+json;version=0.1") +} + +func TestGetByDigestGreaterThanLimit(t *testing.T) { + c := NewClientWithMockGHClient(false) + + limit := 3 + // The method should return five results when the limit is not set + attestations, err := c.GetByRepoAndDigest(testRepo, testDigest, limit) + require.NoError(t, err) + + require.Equal(t, 3, len(attestations)) + bundle := (attestations)[0].Bundle + require.Equal(t, bundle.GetMediaType(), "application/vnd.dev.sigstore.bundle+json;version=0.1") + + attestations, err = c.GetByOwnerAndDigest(testOwner, testDigest, limit) + require.NoError(t, err) + + require.Equal(t, len(attestations), limit) + bundle = (attestations)[0].Bundle + require.Equal(t, bundle.GetMediaType(), "application/vnd.dev.sigstore.bundle+json;version=0.1") +} + +func TestGetByDigestWithNextPage(t *testing.T) { + c := NewClientWithMockGHClient(true) + attestations, err := c.GetByRepoAndDigest(testRepo, testDigest, DefaultLimit) + require.NoError(t, err) + + require.Equal(t, len(attestations), 10) + bundle := (attestations)[0].Bundle + require.Equal(t, bundle.GetMediaType(), "application/vnd.dev.sigstore.bundle+json;version=0.1") + + attestations, err = c.GetByOwnerAndDigest(testOwner, testDigest, DefaultLimit) + require.NoError(t, err) + + require.Equal(t, len(attestations), 10) + bundle = (attestations)[0].Bundle + require.Equal(t, bundle.GetMediaType(), "application/vnd.dev.sigstore.bundle+json;version=0.1") +} + +func TestGetByDigestGreaterThanLimitWithNextPage(t *testing.T) { + c := NewClientWithMockGHClient(true) + + limit := 7 + // The method should return five results when the limit is not set + attestations, err := c.GetByRepoAndDigest(testRepo, testDigest, limit) + require.NoError(t, err) + + require.Equal(t, len(attestations), limit) + bundle := (attestations)[0].Bundle + require.Equal(t, bundle.GetMediaType(), "application/vnd.dev.sigstore.bundle+json;version=0.1") + + attestations, err = c.GetByOwnerAndDigest(testOwner, testDigest, limit) + require.NoError(t, err) + + require.Equal(t, len(attestations), limit) + bundle = (attestations)[0].Bundle + require.Equal(t, bundle.GetMediaType(), "application/vnd.dev.sigstore.bundle+json;version=0.1") +} + +func TestGetByDigest_NoAttestationsFound(t *testing.T) { + fetcher := mockDataGenerator{ + NumAttestations: 5, + } + + c := LiveClient{ + api: mockAPIClient{ + OnRESTWithNext: fetcher.OnRESTWithNextNoAttestations, + }, + logger: io.NewTestHandler(), + } + + attestations, err := c.GetByRepoAndDigest(testRepo, testDigest, DefaultLimit) + require.Error(t, err) + require.IsType(t, ErrNoAttestations{}, err) + require.Nil(t, attestations) + + attestations, err = c.GetByOwnerAndDigest(testOwner, testDigest, DefaultLimit) + require.Error(t, err) + require.IsType(t, ErrNoAttestations{}, err) + require.Nil(t, attestations) +} + +func TestGetByDigest_Error(t *testing.T) { + fetcher := mockDataGenerator{ + NumAttestations: 5, + } + + c := LiveClient{ + api: mockAPIClient{ + OnRESTWithNext: fetcher.OnRESTWithNextError, + }, + logger: io.NewTestHandler(), + } + + attestations, err := c.GetByRepoAndDigest(testRepo, testDigest, DefaultLimit) + require.Error(t, err) + require.Nil(t, attestations) + + attestations, err = c.GetByOwnerAndDigest(testOwner, testDigest, DefaultLimit) + require.Error(t, err) + require.Nil(t, attestations) +} diff --git a/pkg/cmd/attestation/api/mock_apiClient_test.go b/pkg/cmd/attestation/api/mock_apiClient_test.go new file mode 100644 index 000000000..1d4f61cd9 --- /dev/null +++ b/pkg/cmd/attestation/api/mock_apiClient_test.go @@ -0,0 +1,89 @@ +package api + +import ( + "encoding/json" + "errors" + "fmt" + "io" + "strings" +) + +type mockAPIClient struct { + OnRESTWithNext func(hostname, method, p string, body io.Reader, data interface{}) (string, error) +} + +func (m mockAPIClient) RESTWithNext(hostname, method, p string, body io.Reader, data interface{}) (string, error) { + return m.OnRESTWithNext(hostname, method, p, body, data) +} + +type mockDataGenerator struct { + NumAttestations int +} + +func (m mockDataGenerator) OnRESTSuccess(hostname, method, p string, body io.Reader, data interface{}) (string, error) { + return m.OnRESTWithNextSuccessHelper(hostname, method, p, body, data, false) +} + +func (m mockDataGenerator) OnRESTSuccessWithNextPage(hostname, method, p string, body io.Reader, data interface{}) (string, error) { + // if path doesn't contain after, it means first time hitting the mock server + // so return the first page and return the link header in the response + if !strings.Contains(p, "after") { + return m.OnRESTWithNextSuccessHelper(hostname, method, p, body, data, true) + } + + // if path contain after, it means second time hitting the mock server and will not return the link header + return m.OnRESTWithNextSuccessHelper(hostname, method, p, body, data, false) +} + +func (m mockDataGenerator) OnRESTWithNextSuccessHelper(hostname, method, p string, body io.Reader, data interface{}, hasNext bool) (string, error) { + atts := make([]*Attestation, m.NumAttestations) + for j := 0; j < m.NumAttestations; j++ { + att := makeTestAttestation() + atts[j] = &att + } + + resp := AttestationsResponse{ + Attestations: atts, + } + + // // Convert the attestations to JSON + b, err := json.Marshal(resp) + if err != nil { + return "", err + } + + err = json.Unmarshal(b, &data) + if err != nil { + return "", err + } + + if hasNext { + // return a link header with the next page + return fmt.Sprintf("<%s&after=2>; rel=\"next\"", p), nil + } + + return "", nil +} + +func (m mockDataGenerator) OnRESTWithNextNoAttestations(hostname, method, p string, body io.Reader, data interface{}) (string, error) { + resp := AttestationsResponse{ + Attestations: make([]*Attestation, 0), + } + + // // Convert the attestations to JSON + b, err := json.Marshal(resp) + if err != nil { + return "", err + } + + err = json.Unmarshal(b, &data) + if err != nil { + return "", err + } + + return "", nil +} + +func (m mockDataGenerator) OnRESTWithNextError(hostname, method, p string, body io.Reader, data interface{}) (string, error) { + return "", errors.New("failed to get attestations") +} diff --git a/pkg/cmd/attestation/api/mock_client.go b/pkg/cmd/attestation/api/mock_client.go new file mode 100644 index 000000000..edb51ee6e --- /dev/null +++ b/pkg/cmd/attestation/api/mock_client.go @@ -0,0 +1,58 @@ +package api + +import ( + "fmt" + + "github.com/cli/cli/v2/pkg/cmd/attestation/test/data" +) + +type MockClient struct { + OnGetByRepoAndDigest func(repo, digest string, limit int) ([]*Attestation, error) + OnGetByOwnerAndDigest func(owner, digest string, limit int) ([]*Attestation, error) +} + +func (m MockClient) GetByRepoAndDigest(repo, digest string, limit int) ([]*Attestation, error) { + return m.OnGetByRepoAndDigest(repo, digest, limit) +} + +func (m MockClient) GetByOwnerAndDigest(owner, digest string, limit int) ([]*Attestation, error) { + return m.OnGetByOwnerAndDigest(owner, digest, limit) +} + +func makeTestAttestation() Attestation { + return Attestation{Bundle: data.SigstoreBundle(nil)} +} + +func OnGetByRepoAndDigestSuccess(repo, digest string, limit int) ([]*Attestation, error) { + att1 := makeTestAttestation() + att2 := makeTestAttestation() + return []*Attestation{&att1, &att2}, nil +} + +func OnGetByRepoAndDigestFailure(repo, digest string, limit int) ([]*Attestation, error) { + return nil, fmt.Errorf("failed to fetch by repo and digest") +} + +func OnGetByOwnerAndDigestSuccess(owner, digest string, limit int) ([]*Attestation, error) { + att1 := makeTestAttestation() + att2 := makeTestAttestation() + return []*Attestation{&att1, &att2}, nil +} + +func OnGetByOwnerAndDigestFailure(owner, digest string, limit int) ([]*Attestation, error) { + return nil, fmt.Errorf("failed to fetch by owner and digest") +} + +func NewTestClient() *MockClient { + return &MockClient{ + OnGetByRepoAndDigest: OnGetByRepoAndDigestSuccess, + OnGetByOwnerAndDigest: OnGetByOwnerAndDigestSuccess, + } +} + +func NewFailTestClient() *MockClient { + return &MockClient{ + OnGetByRepoAndDigest: OnGetByRepoAndDigestFailure, + OnGetByOwnerAndDigest: OnGetByOwnerAndDigestFailure, + } +} diff --git a/pkg/cmd/attestation/artifact/artifact.go b/pkg/cmd/attestation/artifact/artifact.go new file mode 100644 index 000000000..de354b947 --- /dev/null +++ b/pkg/cmd/attestation/artifact/artifact.go @@ -0,0 +1,79 @@ +package artifact + +import ( + "fmt" + "net/url" + "os" + "path/filepath" + "strings" + + "github.com/cli/cli/v2/pkg/cmd/attestation/artifact/oci" +) + +type artifactType int + +const ( + ociArtifactType artifactType = iota + fileArtifactType +) + +// DigestedArtifact abstracts the software artifact being verified +type DigestedArtifact struct { + URL string + digest string + digestAlg string +} + +func normalizeReference(reference string, pathSeparator rune) (normalized string, artifactType artifactType, err error) { + switch { + case strings.HasPrefix(reference, "oci://"): + return reference[6:], ociArtifactType, nil + case strings.HasPrefix(reference, "file://"): + uri, err := url.ParseRequestURI(reference) + if err != nil { + return "", 0, fmt.Errorf("failed to parse reference URI: %v", err) + } + var path string + if pathSeparator == '/' { + // Unix paths use forward slashes like URIs, so no need to modify + path = uri.Path + } else { + // Windows paths should be normalized to use backslashes + path = strings.ReplaceAll(uri.Path, "/", string(pathSeparator)) + // Remove leading slash from Windows paths if present + if strings.HasPrefix(path, string(pathSeparator)) { + path = path[1:] + } + } + return filepath.Clean(path), fileArtifactType, nil + } + // Treat any other reference as a local file path + return filepath.Clean(reference), fileArtifactType, nil +} + +func NewDigestedArtifact(client oci.Client, reference, digestAlg string) (artifact *DigestedArtifact, err error) { + normalized, artifactType, err := normalizeReference(reference, os.PathSeparator) + if err != nil { + return nil, err + } + if artifactType == ociArtifactType { + // TODO: should we allow custom digestAlg for OCI artifacts? + return digestContainerImageArtifact(normalized, client) + } + return digestLocalFileArtifact(normalized, digestAlg) +} + +// Digest returns the artifact's digest +func (a *DigestedArtifact) Digest() string { + return a.digest +} + +// Algorithm returns the artifact's algorithm +func (a *DigestedArtifact) Algorithm() string { + return a.digestAlg +} + +// DigestWithAlg returns the digest:algorithm of the artifact +func (a *DigestedArtifact) DigestWithAlg() string { + return fmt.Sprintf("%s:%s", a.digestAlg, a.digest) +} diff --git a/pkg/cmd/attestation/artifact/artifact_posix_test.go b/pkg/cmd/attestation/artifact/artifact_posix_test.go new file mode 100644 index 000000000..31e9cb7e7 --- /dev/null +++ b/pkg/cmd/attestation/artifact/artifact_posix_test.go @@ -0,0 +1,99 @@ +//go:build !windows +// +build !windows + +package artifact + +import ( + "testing" + + "github.com/stretchr/testify/require" +) + +func TestNormalizeReference(t *testing.T) { + testCases := []struct { + name string + reference string + pathSeparator rune + expectedResult string + expectedType artifactType + expectedError bool + }{ + { + name: "file reference without scheme", + reference: "/path/to/file", + pathSeparator: '/', + expectedResult: "/path/to/file", + expectedType: fileArtifactType, + expectedError: false, + }, + { + name: "file scheme uri with %20", + reference: "file:///path/to/file%20with%20spaces", + pathSeparator: '/', + expectedResult: "/path/to/file with spaces", + expectedType: fileArtifactType, + expectedError: false, + }, + { + name: "windows file reference without scheme", + reference: `c:\path\to\file`, + pathSeparator: '\\', + expectedResult: `c:\path\to\file`, + expectedType: fileArtifactType, + expectedError: false, + }, + { + name: "file reference with scheme", + reference: "file:///path/to/file", + pathSeparator: '/', + expectedResult: "/path/to/file", + expectedType: fileArtifactType, + expectedError: false, + }, + { + name: "windows path", + reference: "file:///C:/path/to/file", + pathSeparator: '\\', + expectedResult: `C:\path\to\file`, + expectedType: fileArtifactType, + expectedError: false, + }, + { + name: "windows path with backslashes", + reference: "file:///C:\\path\\to\\file", + pathSeparator: '\\', + expectedResult: `C:\path\to\file`, + expectedType: fileArtifactType, + expectedError: false, + }, + { + name: "oci reference", + reference: "oci://example.com/repo:tag", + pathSeparator: '/', + expectedResult: "example.com/repo:tag", + expectedType: ociArtifactType, + expectedError: false, + }, + { + name: "oci reference with digest", + reference: "oci://example.com/repo@sha256:abcdef1234567890", + pathSeparator: '/', + expectedResult: "example.com/repo@sha256:abcdef1234567890", + expectedType: ociArtifactType, + expectedError: false, + }, + } + + for _, tc := range testCases { + t.Run(tc.name, func(t *testing.T) { + result, artifactType, err := normalizeReference(tc.reference, tc.pathSeparator) + if tc.expectedError { + require.Error(t, err) + } else { + require.NoError(t, err) + require.Equal(t, tc.expectedResult, result) + require.Equal(t, tc.expectedType, artifactType) + } + }) + } +} diff --git a/pkg/cmd/attestation/artifact/artifact_windows_test.go b/pkg/cmd/attestation/artifact/artifact_windows_test.go new file mode 100644 index 000000000..46995f226 --- /dev/null +++ b/pkg/cmd/attestation/artifact/artifact_windows_test.go @@ -0,0 +1,59 @@ +//go:build windows +// +build windows + +package artifact + +import ( + "testing" + + "github.com/stretchr/testify/require" +) + +func TestNormalizeReference(t *testing.T) { + testCases := []struct { + name string + reference string + pathSeparator rune + expectedResult string + expectedType artifactType + expectedError bool + }{ + { + name: "windows file reference without scheme", + reference: `c:\path\to\file`, + pathSeparator: '\\', + expectedResult: `c:\path\to\file`, + expectedType: fileArtifactType, + expectedError: false, + }, + { + name: "windows path", + reference: "file:///C:/path/to/file", + pathSeparator: '\\', + expectedResult: `C:\path\to\file`, + expectedType: fileArtifactType, + expectedError: false, + }, + { + name: "windows path with backslashes", + reference: "file:///C:\\path\\to\\file", + pathSeparator: '\\', + expectedResult: `C:\path\to\file`, + expectedType: fileArtifactType, + expectedError: false, + }, + } + + for _, tc := range testCases { + t.Run(tc.name, func(t *testing.T) { + result, artifactType, err := normalizeReference(tc.reference, tc.pathSeparator) + if tc.expectedError { + require.Error(t, err) + } else { + require.NoError(t, err) + require.Equal(t, tc.expectedResult, result) + require.Equal(t, tc.expectedType, artifactType) + } + }) + } +} diff --git a/pkg/cmd/attestation/artifact/digest/digest.go b/pkg/cmd/attestation/artifact/digest/digest.go new file mode 100644 index 000000000..e48fb1d0d --- /dev/null +++ b/pkg/cmd/attestation/artifact/digest/digest.go @@ -0,0 +1,53 @@ +package digest + +import ( + "crypto/sha256" + "crypto/sha512" + "encoding/hex" + "fmt" + "hash" + "io" +) + +const ( + SHA256DigestAlgorithm = "sha256" + SHA512DigestAlgorithm = "sha512" +) + +var ( + errUnsupportedAlgorithm = fmt.Errorf("unsupported digest algorithm") + validDigestAlgorithms = [...]string{SHA256DigestAlgorithm, SHA512DigestAlgorithm} +) + +// IsValidDigestAlgorithm returns true if the provided algorithm is supported +func IsValidDigestAlgorithm(alg string) bool { + for _, a := range validDigestAlgorithms { + if a == alg { + return true + } + } + return false +} + +// ValidDigestAlgorithms returns a list of supported digest algorithms +func ValidDigestAlgorithms() []string { + return validDigestAlgorithms[:] +} + +func CalculateDigestWithAlgorithm(r io.Reader, alg string) (string, error) { + var h hash.Hash + switch alg { + case SHA256DigestAlgorithm: + h = sha256.New() + case SHA512DigestAlgorithm: + h = sha512.New() + default: + return "", errUnsupportedAlgorithm + } + + if _, err := io.Copy(h, r); err != nil { + return "", fmt.Errorf("failed to calculate digest: %v", err) + } + digest := h.Sum(nil) + return hex.EncodeToString(digest), nil +} diff --git a/pkg/cmd/attestation/artifact/digest/digest_test.go b/pkg/cmd/attestation/artifact/digest/digest_test.go new file mode 100644 index 000000000..bcfd2c1ac --- /dev/null +++ b/pkg/cmd/attestation/artifact/digest/digest_test.go @@ -0,0 +1,46 @@ +package digest + +import ( + "strings" + "testing" + + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" +) + +func TestArtifactDigestWithAlgorithm(t *testing.T) { + testString := "deadbeef" + sha512TestDigest := "113a3bc783d851fc0373214b19ea7be9fa3de541ecb9fe026d52c603e8ea19c174cc0e9705f8b90d312212c0c3a6d8453ddfb3e3141409cf4bedc8ef033590b4" + sha256TestDigest := "2baf1f40105d9501fe319a8ec463fdf4325a2a5df445adf3f572f626253678c9" + + t.Run("sha256", func(t *testing.T) { + reader := strings.NewReader(testString) + digest, err := CalculateDigestWithAlgorithm(reader, "sha256") + assert.Nil(t, err) + assert.Equal(t, sha256TestDigest, digest) + }) + + t.Run("sha512", func(t *testing.T) { + reader := strings.NewReader(testString) + digest, err := CalculateDigestWithAlgorithm(reader, "sha512") + assert.Nil(t, err) + assert.Equal(t, sha512TestDigest, digest) + }) + + t.Run("fail with sha384", func(t *testing.T) { + reader := strings.NewReader(testString) + _, err := CalculateDigestWithAlgorithm(reader, "sha384") + require.Error(t, err) + require.ErrorAs(t, err, &errUnsupportedAlgorithm) + }) +} + +func TestValidDigestAlgorithms(t *testing.T) { + t.Run("includes sha256", func(t *testing.T) { + assert.Contains(t, ValidDigestAlgorithms(), "sha256") + }) + + t.Run("includes sha512", func(t *testing.T) { + assert.Contains(t, ValidDigestAlgorithms(), "sha512") + }) +} diff --git a/pkg/cmd/attestation/artifact/file.go b/pkg/cmd/attestation/artifact/file.go new file mode 100644 index 000000000..789a92a5d --- /dev/null +++ b/pkg/cmd/attestation/artifact/file.go @@ -0,0 +1,25 @@ +package artifact + +import ( + "fmt" + "os" + + "github.com/cli/cli/v2/pkg/cmd/attestation/artifact/digest" +) + +func digestLocalFileArtifact(filename, digestAlg string) (*DigestedArtifact, error) { + data, err := os.Open(filename) + if err != nil { + return nil, fmt.Errorf("failed to get open local artifact: %v", err) + } + defer data.Close() + digest, err := digest.CalculateDigestWithAlgorithm(data, digestAlg) + if err != nil { + return nil, fmt.Errorf("failed to calculate local artifact digest: %v", err) + } + return &DigestedArtifact{ + URL: fmt.Sprintf("file://%s", filename), + digest: digest, + digestAlg: digestAlg, + }, nil +} diff --git a/pkg/cmd/attestation/artifact/image.go b/pkg/cmd/attestation/artifact/image.go new file mode 100644 index 000000000..2af13e723 --- /dev/null +++ b/pkg/cmd/attestation/artifact/image.go @@ -0,0 +1,28 @@ +package artifact + +import ( + "fmt" + + "github.com/cli/cli/v2/pkg/cmd/attestation/artifact/oci" + "github.com/distribution/reference" +) + +func digestContainerImageArtifact(url string, client oci.Client) (*DigestedArtifact, error) { + // try to parse the url as a valid registry reference + named, err := reference.Parse(url) + if err != nil { + // cannot be parsed as a registry reference + return nil, fmt.Errorf("artifact %s is not a valid registry reference: %v", url, err) + } + + digest, err := client.GetImageDigest(named.String()) + if err != nil { + return nil, err + } + + return &DigestedArtifact{ + URL: fmt.Sprintf("oci://%s", named.String()), + digest: digest.Hex, + digestAlg: digest.Algorithm, + }, nil +} diff --git a/pkg/cmd/attestation/artifact/image_test.go b/pkg/cmd/attestation/artifact/image_test.go new file mode 100644 index 000000000..5ea5f9a37 --- /dev/null +++ b/pkg/cmd/attestation/artifact/image_test.go @@ -0,0 +1,52 @@ +package artifact + +import ( + "fmt" + "testing" + + "github.com/cli/cli/v2/pkg/cmd/attestation/artifact/oci" + "github.com/stretchr/testify/require" +) + +func TestDigestContainerImageArtifact(t *testing.T) { + expectedDigest := "1234567890abcdef" + client := oci.MockClient{} + url := "example.com/repo:tag" + digestedArtifact, err := digestContainerImageArtifact(url, client) + require.NoError(t, err) + require.Equal(t, fmt.Sprintf("oci://%s", url), digestedArtifact.URL) + require.Equal(t, expectedDigest, digestedArtifact.digest) + require.Equal(t, "sha256", digestedArtifact.digestAlg) +} + +func TestParseImageRefFailure(t *testing.T) { + client := oci.ReferenceFailClient{} + url := "example.com/repo:tag" + _, err := digestContainerImageArtifact(url, client) + require.Error(t, err) +} + +func TestFetchImageFailure(t *testing.T) { + testcase := []struct { + name string + client oci.Client + expectedErr error + }{ + { + name: "Fail to authorize with registry", + client: oci.AuthFailClient{}, + expectedErr: oci.ErrRegistryAuthz, + }, + { + name: "Fail to fetch image due to denial", + client: oci.DeniedClient{}, + expectedErr: oci.ErrDenied, + }, + } + + for _, tc := range testcase { + url := "example.com/repo:tag" + _, err := digestContainerImageArtifact(url, tc.client) + require.ErrorIs(t, err, tc.expectedErr) + } +} diff --git a/pkg/cmd/attestation/artifact/oci/client.go b/pkg/cmd/attestation/artifact/oci/client.go new file mode 100644 index 000000000..5b8d8cf7a --- /dev/null +++ b/pkg/cmd/attestation/artifact/oci/client.go @@ -0,0 +1,70 @@ +package oci + +import ( + "errors" + "fmt" + + "github.com/google/go-containerregistry/pkg/authn" + "github.com/google/go-containerregistry/pkg/name" + "github.com/google/go-containerregistry/pkg/v1" + "github.com/google/go-containerregistry/pkg/v1/remote" + "github.com/google/go-containerregistry/pkg/v1/remote/transport" +) + +var ErrDenied = errors.New("the provided token was denied access to the requested resource, please check the token's expiration and repository access") +var ErrRegistryAuthz = errors.New("remote registry authorization failed, please authenticate with the registry and try again") + +type Client interface { + GetImageDigest(imgName string) (*v1.Hash, error) +} + +func checkForUnauthorizedOrDeniedErr(err transport.Error) error { + for _, diagnostic := range err.Errors { + switch diagnostic.Code { + case transport.UnauthorizedErrorCode: + return ErrRegistryAuthz + case transport.DeniedErrorCode: + return ErrDenied + } + } + return nil +} + +type LiveClient struct { + parseReference func(string, ...name.Option) (name.Reference, error) + get func(name.Reference, ...remote.Option) (*remote.Descriptor, error) +} + +// where name is formed like ghcr.io/github/my-image-repo +func (c LiveClient) GetImageDigest(imgName string) (*v1.Hash, error) { + name, err := c.parseReference(imgName) + if err != nil { + return nil, fmt.Errorf("failed to create image tag: %v", err) + } + + // The user must already be authenticated with the container registry + // The authn.DefaultKeychain argument indicates that Get should checks the + // user's configuration for the registry credentials + desc, err := c.get(name, remote.WithAuthFromKeychain(authn.DefaultKeychain)) + if err != nil { + var transportErr *transport.Error + if errors.As(err, &transportErr) { + if accessErr := checkForUnauthorizedOrDeniedErr(*transportErr); accessErr != nil { + return nil, accessErr + } + } + return nil, fmt.Errorf("failed to fetch remote image: %v", err) + } + + return &desc.Digest, nil +} + +// Unlike other parts of this command set, we cannot pass a custom HTTP client +// to the go-containerregistry library. This means we have limited visibility +// into the HTTP requests being made to container registries. +func NewLiveClient() *LiveClient { + return &LiveClient{ + parseReference: name.ParseReference, + get: remote.Get, + } +} diff --git a/pkg/cmd/attestation/artifact/oci/client_test.go b/pkg/cmd/attestation/artifact/oci/client_test.go new file mode 100644 index 000000000..9aa415c47 --- /dev/null +++ b/pkg/cmd/attestation/artifact/oci/client_test.go @@ -0,0 +1,83 @@ +package oci + +import ( + "fmt" + "testing" + + "github.com/google/go-containerregistry/pkg/name" + "github.com/google/go-containerregistry/pkg/v1" + "github.com/google/go-containerregistry/pkg/v1/remote" + "github.com/google/go-containerregistry/pkg/v1/remote/transport" + + "github.com/stretchr/testify/require" +) + +func TestGetImageDigest_Success(t *testing.T) { + expectedDigest := v1.Hash{ + Hex: "1234567890abcdef", + Algorithm: "sha256", + } + + c := LiveClient{ + parseReference: func(string, ...name.Option) (name.Reference, error) { + return name.Tag{}, nil + }, + get: func(name.Reference, ...remote.Option) (*remote.Descriptor, error) { + d := remote.Descriptor{} + d.Digest = expectedDigest + + return &d, nil + }, + } + + digest, err := c.GetImageDigest("test") + require.NoError(t, err) + require.Equal(t, &expectedDigest, digest) +} + +func TestGetImageDigest_ReferenceFail(t *testing.T) { + c := LiveClient{ + parseReference: func(string, ...name.Option) (name.Reference, error) { + return nil, fmt.Errorf("failed to parse reference") + }, + get: func(name.Reference, ...remote.Option) (*remote.Descriptor, error) { + return nil, nil + }, + } + + digest, err := c.GetImageDigest("test") + require.Error(t, err) + require.Nil(t, digest) +} + +func TestGetImageDigest_AuthFail(t *testing.T) { + c := LiveClient{ + parseReference: func(string, ...name.Option) (name.Reference, error) { + return name.Tag{}, nil + }, + get: func(name.Reference, ...remote.Option) (*remote.Descriptor, error) { + return nil, &transport.Error{Errors: []transport.Diagnostic{{Code: transport.UnauthorizedErrorCode}}} + }, + } + + digest, err := c.GetImageDigest("test") + require.Error(t, err) + require.ErrorIs(t, err, ErrRegistryAuthz) + require.Nil(t, digest) +} + +func TestGetImageDigest_Denied(t *testing.T) { + c := LiveClient{ + parseReference: func(string, ...name.Option) (name.Reference, error) { + return name.Tag{}, nil + }, + get: func(name.Reference, ...remote.Option) (*remote.Descriptor, error) { + return nil, &transport.Error{Errors: []transport.Diagnostic{{Code: transport.DeniedErrorCode}}} + }, + } + + digest, err := c.GetImageDigest("test") + require.Error(t, err) + require.ErrorIs(t, err, ErrDenied) + require.Nil(t, digest) +} diff --git a/pkg/cmd/attestation/artifact/oci/mock_client.go b/pkg/cmd/attestation/artifact/oci/mock_client.go new file mode 100644 index 000000000..24368dec8 --- /dev/null +++ b/pkg/cmd/attestation/artifact/oci/mock_client.go @@ -0,0 +1,34 @@ +package oci + +import ( + "fmt" + + "github.com/google/go-containerregistry/pkg/v1" +) + +type MockClient struct{} + +func (c MockClient) GetImageDigest(imgName string) (*v1.Hash, error) { + return &v1.Hash{ + Hex: "1234567890abcdef", + Algorithm: "sha256", + }, nil +} + +type ReferenceFailClient struct{} + +func (c ReferenceFailClient) GetImageDigest(imgName string) (*v1.Hash, error) { + return nil, fmt.Errorf("failed to parse reference") +} + +type AuthFailClient struct{} + +func (c AuthFailClient) GetImageDigest(imgName string) (*v1.Hash, error) { + return nil, ErrRegistryAuthz +} + +type DeniedClient struct{} + +func (c DeniedClient) GetImageDigest(imgName string) (*v1.Hash, error) { + return nil, ErrDenied +} diff --git a/pkg/cmd/attestation/attestation.go b/pkg/cmd/attestation/attestation.go new file mode 100644 index 000000000..423de1807 --- /dev/null +++ b/pkg/cmd/attestation/attestation.go @@ -0,0 +1,32 @@ +package attestation + +import ( + "github.com/MakeNowJust/heredoc" + "github.com/cli/cli/v2/pkg/cmd/attestation/download" + "github.com/cli/cli/v2/pkg/cmd/attestation/inspect" + "github.com/cli/cli/v2/pkg/cmd/attestation/tufrootverify" + "github.com/cli/cli/v2/pkg/cmd/attestation/verify" + "github.com/cli/cli/v2/pkg/cmdutil" + + "github.com/spf13/cobra" +) + +func NewCmdAttestation(f *cmdutil.Factory) *cobra.Command { + root := &cobra.Command{ + Use: "attestation [subcommand]", + Short: "Work with artifact attestations", + Aliases: []string{"at"}, + Long: heredoc.Doc(` + ### NOTE: This feature is currently in beta, and subject to change. + + Download and verify artifact attestations. + `), + } + + root.AddCommand(download.NewDownloadCmd(f, nil)) + root.AddCommand(inspect.NewInspectCmd(f, nil)) + root.AddCommand(verify.NewVerifyCmd(f, nil)) + root.AddCommand(tufrootverify.NewTUFRootVerifyCmd(f, nil)) + + return root +} diff --git a/pkg/cmd/attestation/auth/host.go b/pkg/cmd/attestation/auth/host.go new file mode 100644 index 000000000..1b5a344ea --- /dev/null +++ b/pkg/cmd/attestation/auth/host.go @@ -0,0 +1,21 @@ +package auth + +import ( + "errors" + + "github.com/cli/cli/v2/internal/ghinstance" + "github.com/cli/go-gh/v2/pkg/auth" +) + +var ErrUnsupportedHost = errors.New("An unsupported host was detected. Note that gh attestation does not currently support GHES") + +func IsHostSupported() error { + host, _ := auth.DefaultHost() + + // Note that this check is slightly redundant as Tenancy should not be considered Enterprise + // but the ghinstance package has not been updated to reflect this yet. + if ghinstance.IsEnterprise(host) && !ghinstance.IsTenancy(host) { + return ErrUnsupportedHost + } + return nil +} diff --git a/pkg/cmd/attestation/auth/host_test.go b/pkg/cmd/attestation/auth/host_test.go new file mode 100644 index 000000000..1d84888c4 --- /dev/null +++ b/pkg/cmd/attestation/auth/host_test.go @@ -0,0 +1,49 @@ +package auth + +import ( + "testing" + + "github.com/stretchr/testify/require" +) + +func TestIsHostSupported(t *testing.T) { + testcases := []struct { + name string + expectedErr bool + host string + }{ + { + name: "Default github.com host", + expectedErr: false, + host: "github.com", + }, + { + name: "Localhost", + expectedErr: false, + host: "github.localhost", + }, + { + name: "No host set", + expectedErr: false, + host: "", + }, + { + name: "GHE tenant host", + expectedErr: false, + host: "some-tenant.ghe.com", + }, + } + + for _, tc := range testcases { + t.Run(tc.name, func(t *testing.T) { + t.Setenv("GH_HOST", tc.host) + + err := IsHostSupported() + if tc.expectedErr { + require.ErrorIs(t, err, ErrUnsupportedHost) + } else { + require.NoError(t, err) + } + }) + } +} diff --git a/pkg/cmd/attestation/download/download.go b/pkg/cmd/attestation/download/download.go new file mode 100644 index 000000000..3af3b6200 --- /dev/null +++ b/pkg/cmd/attestation/download/download.go @@ -0,0 +1,161 @@ +package download + +import ( + "errors" + "fmt" + + "github.com/cli/cli/v2/pkg/cmd/attestation/api" + "github.com/cli/cli/v2/pkg/cmd/attestation/artifact" + "github.com/cli/cli/v2/pkg/cmd/attestation/artifact/oci" + "github.com/cli/cli/v2/pkg/cmd/attestation/auth" + "github.com/cli/cli/v2/pkg/cmd/attestation/io" + "github.com/cli/cli/v2/pkg/cmd/attestation/verification" + "github.com/cli/cli/v2/pkg/cmdutil" + + "github.com/MakeNowJust/heredoc" + "github.com/spf13/cobra" +) + +func NewDownloadCmd(f *cmdutil.Factory, runF func(*Options) error) *cobra.Command { + opts := &Options{} + downloadCmd := &cobra.Command{ + Use: "download [ | oci://] [--owner | --repo]", + Args: cmdutil.ExactArgs(1, "must specify file path or container image URI, as well as one of --owner or --repo"), + Short: "Download an artifact's attestations for offline use", + Long: heredoc.Docf(` + ### NOTE: This feature is currently in beta, and subject to change. + + Download attestations associated with an artifact for offline use. + + The command requires either: + * a file path to an artifact, or + * a container image URI (e.g. %[1]soci://%[1]s) + * (note that if you provide an OCI URL, you must already be authenticated with + its container registry) + + In addition, the command requires either: + * the %[1]s--repo%[1]s flag (e.g. --repo github/example). + * the %[1]s--owner%[1]s flag (e.g. --owner github), or + + The %[1]s--repo%[1]s flag value must match the name of the GitHub repository + that the artifact is linked with. + + The %[1]s--owner%[1]s flag value must match the name of the GitHub organization + that the artifact's linked repository belongs to. + + Any associated bundle(s) will be written to a file in the + current directory named after the artifact's digest. For example, if the + digest is "sha256:1234", the file will be named "sha256:1234.jsonl". + `, "`"), + Example: heredoc.Doc(` + # Download attestations for a local artifact linked with an organization + $ gh attestation download example.bin -o github + + # Download attestations for a local artifact linked with a repository + $ gh attestation download example.bin -R github/example + + # Download attestations for an OCI image linked with an organization + $ gh attestation download oci://example.com/foo/bar:latest -o github + `), + // PreRunE is used to validate flags before the command is run + // If an error is returned, its message will be printed to the terminal + // along with information about how use the command + PreRunE: func(cmd *cobra.Command, args []string) error { + // Create a logger for use throughout the download command + opts.Logger = io.NewHandler(f.IOStreams) + + // set the artifact path + opts.ArtifactPath = args[0] + + // check that the provided flags are valid + if err := opts.AreFlagsValid(); err != nil { + return err + } + return nil + }, + RunE: func(cmd *cobra.Command, args []string) error { + hc, err := f.HttpClient() + if err != nil { + return err + } + opts.APIClient = api.NewLiveClient(hc, opts.Logger) + + opts.OCIClient = oci.NewLiveClient() + + opts.Store = NewLiveStore("") + + if err := auth.IsHostSupported(); err != nil { + return err + } + + if runF != nil { + return runF(opts) + } + + if err := runDownload(opts); err != nil { + return fmt.Errorf("Failed to download the artifact's bundle(s): %v", err) + } + return nil + }, + } + + downloadCmd.Flags().StringVarP(&opts.Owner, "owner", "o", "", "a GitHub organization to scope attestation lookup by") + downloadCmd.Flags().StringVarP(&opts.Repo, "repo", "R", "", "Repository name in the format /") + downloadCmd.MarkFlagsMutuallyExclusive("owner", "repo") + downloadCmd.MarkFlagsOneRequired("owner", "repo") + downloadCmd.Flags().StringVarP(&opts.PredicateType, "predicate-type", "", "", "Filter attestations by provided predicate type") + cmdutil.StringEnumFlag(downloadCmd, &opts.DigestAlgorithm, "digest-alg", "d", "sha256", []string{"sha256", "sha512"}, "The algorithm used to compute a digest of the artifact") + downloadCmd.Flags().IntVarP(&opts.Limit, "limit", "L", api.DefaultLimit, "Maximum number of attestations to fetch") + + return downloadCmd +} + +func runDownload(opts *Options) error { + artifact, err := artifact.NewDigestedArtifact(opts.OCIClient, opts.ArtifactPath, opts.DigestAlgorithm) + if err != nil { + return fmt.Errorf("failed to digest artifact: %v", err) + } + + opts.Logger.VerbosePrintf("Downloading trusted metadata for artifact %s\n\n", opts.ArtifactPath) + + c := verification.FetchAttestationsConfig{ + APIClient: opts.APIClient, + Digest: artifact.DigestWithAlg(), + Limit: opts.Limit, + Owner: opts.Owner, + Repo: opts.Repo, + } + attestations, err := verification.GetRemoteAttestations(c) + if err != nil { + if errors.Is(err, api.ErrNoAttestations{}) { + fmt.Fprintf(opts.Logger.IO.Out, "No attestations found for %s\n", opts.ArtifactPath) + return nil + } + return fmt.Errorf("failed to fetch attestations: %v", err) + } + + // Apply predicate type filter to returned attestations + if opts.PredicateType != "" { + filteredAttestations := verification.FilterAttestations(opts.PredicateType, attestations) + + if len(filteredAttestations) == 0 { + return fmt.Errorf("no attestations found with predicate type: %s", opts.PredicateType) + } + + attestations = filteredAttestations + } + + metadataFilePath, err := opts.Store.createMetadataFile(artifact.DigestWithAlg(), attestations) + if err != nil { + return fmt.Errorf("failed to write attestation: %v", err) + } + fmt.Fprintf(opts.Logger.IO.Out, "Wrote attestations to file %s.\nAny previous content has been overwritten\n\n", metadataFilePath) + + fmt.Fprint(opts.Logger.IO.Out, + opts.Logger.ColorScheme.Greenf( + "The trusted metadata is now available at %s\n", metadataFilePath, + ), + ) + + return nil +} diff --git a/pkg/cmd/attestation/download/download_test.go b/pkg/cmd/attestation/download/download_test.go new file mode 100644 index 000000000..0762a29da --- /dev/null +++ b/pkg/cmd/attestation/download/download_test.go @@ -0,0 +1,314 @@ +package download + +import ( + "bytes" + "fmt" + "net/http" + "strings" + "testing" + + "github.com/cli/cli/v2/pkg/cmd/attestation/api" + "github.com/cli/cli/v2/pkg/cmd/attestation/artifact" + "github.com/cli/cli/v2/pkg/cmd/attestation/artifact/oci" + "github.com/cli/cli/v2/pkg/cmd/attestation/io" + "github.com/cli/cli/v2/pkg/cmd/attestation/test" + "github.com/cli/cli/v2/pkg/cmdutil" + + "github.com/cli/cli/v2/pkg/httpmock" + "github.com/cli/cli/v2/pkg/iostreams" + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" +) + +var artifactPath = test.NormalizeRelativePath("../test/data/sigstore-js-2.1.0.tgz") + +func TestNewDownloadCmd(t *testing.T) { + testIO, _, _, _ := iostreams.Test() + f := &cmdutil.Factory{ + IOStreams: testIO, + HttpClient: func() (*http.Client, error) { + reg := &httpmock.Registry{} + client := &http.Client{} + httpmock.ReplaceTripper(client, reg) + return client, nil + }, + } + + store := &LiveStore{ + outputPath: t.TempDir(), + } + + testcases := []struct { + name string + cli string + wants Options + wantsErr bool + }{ + { + name: "Invalid digest-alg flag", + cli: fmt.Sprintf("%s --owner sigstore --digest-alg sha384", artifactPath), + wants: Options{ + ArtifactPath: artifactPath, + APIClient: api.NewTestClient(), + OCIClient: oci.MockClient{}, + DigestAlgorithm: "sha384", + Owner: "sigstore", + Store: store, + Limit: 30, + }, + wantsErr: true, + }, + { + name: "Missing digest-alg flag", + cli: fmt.Sprintf("%s --owner sigstore", artifactPath), + wants: Options{ + ArtifactPath: artifactPath, + APIClient: api.NewTestClient(), + OCIClient: oci.MockClient{}, + DigestAlgorithm: "sha256", + Owner: "sigstore", + Store: store, + Limit: 30, + }, + wantsErr: false, + }, + { + name: "Missing owner and repo flags", + cli: artifactPath, + wants: Options{ + ArtifactPath: artifactPath, + APIClient: api.NewTestClient(), + OCIClient: oci.MockClient{}, + DigestAlgorithm: "sha256", + Owner: "sigstore", + Store: store, + Limit: 30, + }, + wantsErr: true, + }, + { + name: "Has both owner and repo flags", + cli: fmt.Sprintf("%s --owner sigstore --repo sigstore/sigstore-js", artifactPath), + wants: Options{ + ArtifactPath: artifactPath, + APIClient: api.NewTestClient(), + OCIClient: oci.MockClient{}, + DigestAlgorithm: "sha256", + Owner: "sigstore", + Store: store, + Repo: "sigstore/sigstore-js", + Limit: 30, + }, + wantsErr: true, + }, + { + name: "Uses default limit flag", + cli: fmt.Sprintf("%s --owner sigstore", artifactPath), + wants: Options{ + ArtifactPath: artifactPath, + APIClient: api.NewTestClient(), + OCIClient: oci.MockClient{}, + DigestAlgorithm: "sha256", + Owner: "sigstore", + Store: store, + Limit: 30, + }, + wantsErr: false, + }, + { + name: "Uses custom limit flag", + cli: fmt.Sprintf("%s --owner sigstore --limit 101", artifactPath), + wants: Options{ + ArtifactPath: artifactPath, + APIClient: api.NewTestClient(), + OCIClient: oci.MockClient{}, + DigestAlgorithm: "sha256", + Owner: "sigstore", + Store: store, + Limit: 101, + }, + wantsErr: false, + }, + { + name: "Uses invalid limit flag", + cli: fmt.Sprintf("%s --owner sigstore --limit 0", artifactPath), + wants: Options{ + ArtifactPath: artifactPath, + APIClient: api.NewTestClient(), + OCIClient: oci.MockClient{}, + DigestAlgorithm: "sha256", + Owner: "sigstore", + Store: store, + Limit: 0, + }, + wantsErr: true, + }, + } + + for _, tc := range testcases { + t.Run(tc.name, func(t *testing.T) { + var opts *Options + cmd := NewDownloadCmd(f, func(o *Options) error { + opts = o + return nil + }) + + argv := strings.Split(tc.cli, " ") + cmd.SetArgs(argv) + cmd.SetIn(&bytes.Buffer{}) + cmd.SetOut(&bytes.Buffer{}) + cmd.SetErr(&bytes.Buffer{}) + _, err := cmd.ExecuteC() + if tc.wantsErr { + assert.Error(t, err) + return + } + assert.NoError(t, err) + + assert.Equal(t, tc.wants.DigestAlgorithm, opts.DigestAlgorithm) + assert.Equal(t, tc.wants.Limit, opts.Limit) + assert.Equal(t, tc.wants.Owner, opts.Owner) + assert.Equal(t, tc.wants.Repo, opts.Repo) + assert.NotNil(t, opts.APIClient) + assert.NotNil(t, opts.OCIClient) + assert.NotNil(t, opts.Logger) + assert.NotNil(t, opts.Store) + }) + } +} + +func TestRunDownload(t *testing.T) { + tempDir := t.TempDir() + store := &LiveStore{ + outputPath: tempDir, + } + + baseOpts := Options{ + ArtifactPath: artifactPath, + APIClient: api.NewTestClient(), + OCIClient: oci.MockClient{}, + DigestAlgorithm: "sha512", + Owner: "sigstore", + Store: store, + Limit: 30, + Logger: io.NewTestHandler(), + } + + t.Run("fetch and store attestations successfully with owner", func(t *testing.T) { + err := runDownload(&baseOpts) + require.NoError(t, err) + + artifact, err := artifact.NewDigestedArtifact(baseOpts.OCIClient, baseOpts.ArtifactPath, baseOpts.DigestAlgorithm) + require.NoError(t, err) + + require.FileExists(t, fmt.Sprintf("%s/%s.jsonl", tempDir, artifact.DigestWithAlg())) + + actualLineCount, err := countLines(fmt.Sprintf("%s/%s.jsonl", tempDir, artifact.DigestWithAlg())) + require.NoError(t, err) + + expectedLineCount := 2 + require.Equal(t, expectedLineCount, actualLineCount) + }) + + t.Run("fetch and store attestations successfully with repo", func(t *testing.T) { + opts := baseOpts + opts.Owner = "" + opts.Repo = "sigstore/sigstore-js" + + err := runDownload(&opts) + require.NoError(t, err) + + artifact, err := artifact.NewDigestedArtifact(opts.OCIClient, opts.ArtifactPath, opts.DigestAlgorithm) + require.NoError(t, err) + + require.FileExists(t, fmt.Sprintf("%s/%s.jsonl", tempDir, artifact.DigestWithAlg())) + + actualLineCount, err := countLines(fmt.Sprintf("%s/%s.jsonl", tempDir, artifact.DigestWithAlg())) + require.NoError(t, err) + + expectedLineCount := 2 + require.Equal(t, expectedLineCount, actualLineCount) + }) + + t.Run("download OCI image attestations successfully", func(t *testing.T) { + opts := baseOpts + opts.ArtifactPath = "oci://ghcr.io/github/test" + + err := runDownload(&opts) + require.NoError(t, err) + + artifact, err := artifact.NewDigestedArtifact(opts.OCIClient, opts.ArtifactPath, opts.DigestAlgorithm) + require.NoError(t, err) + + require.FileExists(t, fmt.Sprintf("%s/%s.jsonl", tempDir, artifact.DigestWithAlg())) + + actualLineCount, err := countLines(fmt.Sprintf("%s/%s.jsonl", tempDir, artifact.DigestWithAlg())) + require.NoError(t, err) + + expectedLineCount := 2 + require.Equal(t, expectedLineCount, actualLineCount) + }) + + t.Run("cannot find artifact", func(t *testing.T) { + opts := baseOpts + opts.ArtifactPath = "../test/data/not-real.zip" + + err := runDownload(&opts) + require.Error(t, err) + }) + + t.Run("no attestations found", func(t *testing.T) { + opts := baseOpts + opts.APIClient = api.MockClient{ + OnGetByOwnerAndDigest: func(repo, digest string, limit int) ([]*api.Attestation, error) { + return nil, api.ErrNoAttestations{} + }, + } + + err := runDownload(&opts) + require.NoError(t, err) + + artifact, err := artifact.NewDigestedArtifact(opts.OCIClient, opts.ArtifactPath, opts.DigestAlgorithm) + require.NoError(t, err) + require.NoFileExists(t, artifact.DigestWithAlg()) + }) + + t.Run("failed to fetch attestations", func(t *testing.T) { + opts := baseOpts + opts.APIClient = api.MockClient{ + OnGetByOwnerAndDigest: func(repo, digest string, limit int) ([]*api.Attestation, error) { + return nil, fmt.Errorf("failed to fetch attestations") + }, + } + + err := runDownload(&opts) + require.Error(t, err) + }) + + t.Run("cannot download OCI artifact", func(t *testing.T) { + opts := baseOpts + opts.ArtifactPath = "oci://ghcr.io/github/test" + opts.OCIClient = oci.ReferenceFailClient{} + + err := runDownload(&opts) + require.Error(t, err) + require.ErrorContains(t, err, "failed to digest artifact") + }) + + t.Run("with missing API client", func(t *testing.T) { + customOpts := baseOpts + customOpts.APIClient = nil + require.Error(t, runDownload(&customOpts)) + }) + + t.Run("fail to write attestations to metadata file", func(t *testing.T) { + opts := baseOpts + opts.Store = &MockStore{ + OnCreateMetadataFile: OnCreateMetadataFileFailure, + } + + err := runDownload(&opts) + require.Error(t, err) + require.ErrorAs(t, err, &ErrAttestationFileCreation) + }) +} diff --git a/pkg/cmd/attestation/download/metadata.go b/pkg/cmd/attestation/download/metadata.go new file mode 100644 index 000000000..4096be001 --- /dev/null +++ b/pkg/cmd/attestation/download/metadata.go @@ -0,0 +1,70 @@ +package download + +import ( + "encoding/json" + "errors" + "fmt" + "os" + + "github.com/cli/cli/v2/pkg/cmd/attestation/api" +) + +var ErrAttestationFileCreation = fmt.Errorf("failed to write attestations to file") + +type MetadataStore interface { + createMetadataFile(artifactDigest string, attestationsResp []*api.Attestation) (string, error) +} + +type LiveStore struct { + outputPath string +} + +func (s *LiveStore) createJSONLinesFilePath(artifact string) string { + path := fmt.Sprintf("%s.jsonl", artifact) + if s.outputPath != "" { + return fmt.Sprintf("%s/%s", s.outputPath, path) + } + return path +} + +func (s *LiveStore) createMetadataFile(artifactDigest string, attestationsResp []*api.Attestation) (string, error) { + metadataFilePath := s.createJSONLinesFilePath(artifactDigest) + + f, err := os.Create(metadataFilePath) + if err != nil { + return "", errors.Join(ErrAttestationFileCreation, fmt.Errorf("failed to create file: %v", err)) + } + + for _, resp := range attestationsResp { + bundle := resp.Bundle + attBytes, err := json.Marshal(bundle) + if err != nil { + if err = f.Close(); err != nil { + return "", errors.Join(ErrAttestationFileCreation, fmt.Errorf("failed to close file while marshalling JSON: %v", err)) + } + return "", errors.Join(ErrAttestationFileCreation, fmt.Errorf("failed to marshall attestation to JSON while writing to file: %v", err)) + } + + withNewline := fmt.Sprintf("%s\n", attBytes) + _, err = f.Write([]byte(withNewline)) + if err != nil { + if err = f.Close(); err != nil { + return "", errors.Join(ErrAttestationFileCreation, fmt.Errorf("failed to close file while handling write error: %v", err)) + } + + return "", errors.Join(ErrAttestationFileCreation, fmt.Errorf("failed to write attestations: %v", err)) + } + } + + if err = f.Close(); err != nil { + return "", errors.Join(ErrAttestationFileCreation, fmt.Errorf("failed to close file after writing attestations: %v", err)) + } + + return metadataFilePath, nil +} + +func NewLiveStore(outputPath string) *LiveStore { + return &LiveStore{ + outputPath: outputPath, + } +} diff --git a/pkg/cmd/attestation/download/metadata_test.go b/pkg/cmd/attestation/download/metadata_test.go new file mode 100644 index 000000000..8ee3b2a45 --- /dev/null +++ b/pkg/cmd/attestation/download/metadata_test.go @@ -0,0 +1,87 @@ +package download + +import ( + "bufio" + "fmt" + "os" + "path" + "testing" + + "github.com/cli/cli/v2/pkg/cmd/attestation/api" + "github.com/cli/cli/v2/pkg/cmd/attestation/artifact" + "github.com/cli/cli/v2/pkg/cmd/attestation/artifact/oci" + + "github.com/stretchr/testify/require" +) + +type MockStore struct { + OnCreateMetadataFile func(artifactDigest string, attestationsResp []*api.Attestation) (string, error) +} + +func (s *MockStore) createMetadataFile(artifact string, attestationsResp []*api.Attestation) (string, error) { + return s.OnCreateMetadataFile(artifact, attestationsResp) +} + +func OnCreateMetadataFileFailure(artifactDigest string, attestationsResp []*api.Attestation) (string, error) { + return "", fmt.Errorf("failed to create trusted metadata file") +} + +func TestCreateJSONLinesFilePath(t *testing.T) { + tempDir := t.TempDir() + artifact, err := artifact.NewDigestedArtifact(oci.MockClient{}, "../test/data/sigstore-js-2.1.0.tgz", "sha512") + require.NoError(t, err) + + outputFileName := fmt.Sprintf("%s.jsonl", artifact.DigestWithAlg()) + + testCases := []struct { + name string + outputPath string + expected string + }{ + { + name: "with output path", + outputPath: tempDir, + expected: path.Join(tempDir, outputFileName), + }, + { + name: "with nested output path", + outputPath: path.Join(tempDir, "subdir"), + expected: path.Join(tempDir, "subdir", outputFileName), + }, + { + name: "with output path with beginning slash", + outputPath: path.Join("/", tempDir, "subdir"), + expected: path.Join("/", tempDir, "subdir", outputFileName), + }, + { + name: "without output path", + outputPath: "", + expected: outputFileName, + }, + } + + for _, tc := range testCases { + store := LiveStore{ + tc.outputPath, + } + + actualPath := store.createJSONLinesFilePath(artifact.DigestWithAlg()) + require.Equal(t, tc.expected, actualPath) + } +} + +func countLines(path string) (int, error) { + f, err := os.Open(path) + if err != nil { + return 0, err + } + defer f.Close() + + counter := 0 + scanner := bufio.NewScanner(f) + for scanner.Scan() { + counter += 1 + } + + return counter, nil +} diff --git a/pkg/cmd/attestation/download/options.go b/pkg/cmd/attestation/download/options.go new file mode 100644 index 000000000..cc1c4d3b5 --- /dev/null +++ b/pkg/cmd/attestation/download/options.go @@ -0,0 +1,36 @@ +package download + +import ( + "fmt" + + "github.com/cli/cli/v2/pkg/cmd/attestation/api" + "github.com/cli/cli/v2/pkg/cmd/attestation/artifact/oci" + "github.com/cli/cli/v2/pkg/cmd/attestation/io" +) + +const ( + minLimit = 1 + maxLimit = 1000 +) + +type Options struct { + APIClient api.Client + ArtifactPath string + DigestAlgorithm string + Logger *io.Handler + Limit int + Store MetadataStore + OCIClient oci.Client + Owner string + PredicateType string + Repo string +} + +func (opts *Options) AreFlagsValid() error { + // Check that limit is between 1 and 1000 + if opts.Limit < minLimit || opts.Limit > maxLimit { + return fmt.Errorf("limit %d not allowed, must be between %d and %d", opts.Limit, minLimit, maxLimit) + } + + return nil +} diff --git a/pkg/cmd/attestation/download/options_test.go b/pkg/cmd/attestation/download/options_test.go new file mode 100644 index 000000000..800691d79 --- /dev/null +++ b/pkg/cmd/attestation/download/options_test.go @@ -0,0 +1,34 @@ +package download + +import ( + "fmt" + "testing" + + "github.com/stretchr/testify/require" +) + +func TestAreFlagsValid(t *testing.T) { + tests := []struct { + name string + limit int + }{ + { + name: "Limit is too low", + limit: 0, + }, + { + name: "Limit is too high", + limit: 1001, + }, + } + for _, tc := range tests { + opts := Options{ + Limit: tc.limit, + } + + err := opts.AreFlagsValid() + require.Error(t, err) + expectedErrMsg := fmt.Sprintf("limit %d not allowed, must be between 1 and 1000", tc.limit) + require.ErrorContains(t, err, expectedErrMsg) + } +} diff --git a/pkg/cmd/attestation/inspect/bundle.go b/pkg/cmd/attestation/inspect/bundle.go new file mode 100644 index 000000000..283b2c14e --- /dev/null +++ b/pkg/cmd/attestation/inspect/bundle.go @@ -0,0 +1,128 @@ +package inspect + +import ( + "encoding/json" + "fmt" + "strings" + + "github.com/cli/cli/v2/pkg/cmd/attestation/api" + "github.com/cli/cli/v2/pkg/cmd/attestation/verification" +) + +type workflow struct { + Repository string `json:"repository"` +} + +type externalParameters struct { + Workflow workflow `json:"workflow"` +} + +type githubInfo struct { + RepositoryID string `json:"repository_id"` + RepositoryOwnerId string `json:"repository_owner_id"` +} + +type internalParameters struct { + GitHub githubInfo `json:"github"` +} + +type buildDefinition struct { + ExternalParameters externalParameters `json:"externalParameters"` + InternalParameters internalParameters `json:"internalParameters"` +} + +type metadata struct { + InvocationID string `json:"invocationId"` +} + +type runDetails struct { + Metadata metadata `json:"metadata"` +} + +// Predicate captures the predicate of a given attestation +type Predicate struct { + BuildDefinition buildDefinition `json:"buildDefinition"` + RunDetails runDetails `json:"runDetails"` +} + +// AttestationDetail captures attestation source details +// that will be returned by the inspect command +type AttestationDetail struct { + OrgName string `json:"orgName"` + OrgID string `json:"orgId"` + RepositoryName string `json:"repositoryName"` + RepositoryID string `json:"repositoryId"` + WorkflowID string `json:"workflowId"` +} + +func getOrgAndRepo(repoURL string) (string, string, error) { + after, found := strings.CutPrefix(repoURL, "https://github.com/") + if !found { + return "", "", fmt.Errorf("failed to get org and repo from %s", repoURL) + } + + parts := strings.Split(after, "/") + return parts[0], parts[1], nil +} + +func getAttestationDetail(attr api.Attestation) (AttestationDetail, error) { + envelope, err := attr.Bundle.Envelope() + if err != nil { + return AttestationDetail{}, fmt.Errorf("failed to get envelope from bundle: %v", err) + } + + statement, err := envelope.EnvelopeContent().Statement() + if err != nil { + return AttestationDetail{}, fmt.Errorf("failed to get statement from envelope: %v", err) + } + + var predicate Predicate + predicateJson, err := json.Marshal(statement.Predicate) + if err != nil { + return AttestationDetail{}, fmt.Errorf("failed to marshal predicate: %v", err) + } + + err = json.Unmarshal(predicateJson, &predicate) + if err != nil { + return AttestationDetail{}, fmt.Errorf("failed to unmarshal predicate: %v", err) + } + + org, repo, err := getOrgAndRepo(predicate.BuildDefinition.ExternalParameters.Workflow.Repository) + if err != nil { + return AttestationDetail{}, fmt.Errorf("failed to parse attestation content: %v", err) + } + + return AttestationDetail{ + OrgName: org, + OrgID: predicate.BuildDefinition.InternalParameters.GitHub.RepositoryOwnerId, + RepositoryName: repo, + RepositoryID: predicate.BuildDefinition.InternalParameters.GitHub.RepositoryID, + WorkflowID: predicate.RunDetails.Metadata.InvocationID, + }, nil +} + +func getDetailsAsSlice(results []*verification.AttestationProcessingResult) ([][]string, error) { + details := make([][]string, len(results)) + + for i, result := range results { + detail, err := getAttestationDetail(*result.Attestation) + if err != nil { + return nil, fmt.Errorf("failed to get attestation detail: %v", err) + } + details[i] = []string{detail.RepositoryName, detail.RepositoryID, detail.OrgName, detail.OrgID, detail.WorkflowID} + } + return details, nil +} + +func getAttestationDetails(results []*verification.AttestationProcessingResult) ([]AttestationDetail, error) { + details := make([]AttestationDetail, len(results)) + + for i, result := range results { + detail, err := getAttestationDetail(*result.Attestation) + if err != nil { + return nil, fmt.Errorf("failed to get attestation detail: %v", err) + } + details[i] = detail + } + return details, nil +} diff --git a/pkg/cmd/attestation/inspect/bundle_test.go b/pkg/cmd/attestation/inspect/bundle_test.go new file mode 100644 index 000000000..d7e9babd8 --- /dev/null +++ b/pkg/cmd/attestation/inspect/bundle_test.go @@ -0,0 +1,46 @@ +package inspect + +import ( + "testing" + + "github.com/cli/cli/v2/pkg/cmd/attestation/test" + "github.com/cli/cli/v2/pkg/cmd/attestation/verification" + + "github.com/stretchr/testify/require" +) + +func TestGetOrgAndRepo(t *testing.T) { + t.Run("with valid source URL", func(t *testing.T) { + sourceURL := "https://github.com/github/gh-attestation" + org, repo, err := getOrgAndRepo(sourceURL) + require.Nil(t, err) + require.Equal(t, "github", org) + require.Equal(t, "gh-attestation", repo) + }) + + t.Run("with invalid source URL", func(t *testing.T) { + sourceURL := "hub.com/github/gh-attestation" + org, repo, err := getOrgAndRepo(sourceURL) + require.Error(t, err) + require.Zero(t, org) + require.Zero(t, repo) + }) +} + +func TestGetAttestationDetail(t *testing.T) { + bundlePath := test.NormalizeRelativePath("../test/data/sigstore-js-2.1.0-bundle.json") + + attestations, err := verification.GetLocalAttestations(bundlePath) + require.Len(t, attestations, 1) + require.NoError(t, err) + + attestation := attestations[0] + detail, err := getAttestationDetail(*attestation) + require.NoError(t, err) + + require.Equal(t, "sigstore", detail.OrgName) + require.Equal(t, "71096353", detail.OrgID) + require.Equal(t, "sigstore-js", detail.RepositoryName) + require.Equal(t, "495574555", detail.RepositoryID) + require.Equal(t, "https://github.com/sigstore/sigstore-js/actions/runs/6014488666/attempts/1", detail.WorkflowID) +} diff --git a/pkg/cmd/attestation/inspect/inspect.go b/pkg/cmd/attestation/inspect/inspect.go new file mode 100644 index 000000000..2731ee7a4 --- /dev/null +++ b/pkg/cmd/attestation/inspect/inspect.go @@ -0,0 +1,161 @@ +package inspect + +import ( + "fmt" + + "github.com/cli/cli/v2/internal/tableprinter" + "github.com/cli/cli/v2/pkg/cmd/attestation/artifact" + "github.com/cli/cli/v2/pkg/cmd/attestation/artifact/oci" + "github.com/cli/cli/v2/pkg/cmd/attestation/auth" + "github.com/cli/cli/v2/pkg/cmd/attestation/io" + "github.com/cli/cli/v2/pkg/cmd/attestation/verification" + "github.com/cli/cli/v2/pkg/cmdutil" + + "github.com/MakeNowJust/heredoc" + "github.com/spf13/cobra" +) + +func NewInspectCmd(f *cmdutil.Factory, runF func(*Options) error) *cobra.Command { + opts := &Options{} + inspectCmd := &cobra.Command{ + Use: "inspect [ | oci://] --bundle ", + Args: cmdutil.ExactArgs(1, "must specify file path or container image URI, as well --bundle"), + Hidden: true, + Short: "Inspect a sigstore bundle", + Long: heredoc.Docf(` + ### NOTE: This feature is currently in beta, and subject to change. + + Inspect a downloaded Sigstore bundle for a given artifact. + + The command requires either: + * a relative path to a local artifact, or + * a container image URI (e.g. %[1]soci://%[1]s) + + Note that if you provide an OCI URI for the artifact you must already + be authenticated with a container registry. + + The command also requires the %[1]s--bundle%[1]s flag, which provides a file + path to a previously downloaded Sigstore bundle. (See also the %[1]sdownload%[1]s + command). + + By default, the command will print information about the bundle in a table format. + If the %[1]s--json-result%[1]s flag is provided, the command will print the + information in JSON format. + `, "`"), + Example: heredoc.Doc(` + # Inspect a Sigstore bundle and print the results in table format + $ gh attestation inspect --bundle + + # Inspect a Sigstore bundle and print the results in JSON format + $ gh attestation inspect --bundle --json-result + + # Inspect a Sigsore bundle for an OCI artifact, and print the results in table format + $ gh attestation inspect oci:// --bundle + `), + PreRunE: func(cmd *cobra.Command, args []string) error { + // Create a logger for use throughout the inspect command + opts.Logger = io.NewHandler(f.IOStreams) + + // set the artifact path + opts.ArtifactPath = args[0] + + // Clean file path options + // opts.Clean() + + return nil + }, + RunE: func(cmd *cobra.Command, args []string) error { + opts.OCIClient = oci.NewLiveClient() + + if err := auth.IsHostSupported(); err != nil { + return err + } + + if runF != nil { + return runF(opts) + } + + config := verification.SigstoreConfig{ + Logger: opts.Logger, + } + + opts.SigstoreVerifier = verification.NewLiveSigstoreVerifier(config) + + if err := runInspect(opts); err != nil { + return fmt.Errorf("Failed to inspect the artifact and bundle: %w", err) + } + return nil + }, + } + + inspectCmd.Flags().StringVarP(&opts.BundlePath, "bundle", "b", "", "Path to bundle on disk, either a single bundle in a JSON file or a JSON lines file with multiple bundles") + inspectCmd.MarkFlagRequired("bundle") //nolint:errcheck + cmdutil.StringEnumFlag(inspectCmd, &opts.DigestAlgorithm, "digest-alg", "d", "sha256", []string{"sha256", "sha512"}, "The algorithm used to compute a digest of the artifact") + cmdutil.AddFormatFlags(inspectCmd, &opts.exporter) + + return inspectCmd +} + +func runInspect(opts *Options) error { + artifact, err := artifact.NewDigestedArtifact(opts.OCIClient, opts.ArtifactPath, opts.DigestAlgorithm) + if err != nil { + return fmt.Errorf("failed to digest artifact: %s", err) + } + + opts.Logger.Printf("Verifying attestations for the artifact found at %s\n\n", artifact.URL) + + attestations, err := verification.GetLocalAttestations(opts.BundlePath) + if err != nil { + return fmt.Errorf("failed to read attestations for subject: %s", artifact.DigestWithAlg()) + } + + policy, err := buildPolicy(*artifact) + if err != nil { + return fmt.Errorf("failed to build policy: %v", err) + } + + res := opts.SigstoreVerifier.Verify(attestations, policy) + if res.Error != nil { + return fmt.Errorf("at least one attestation failed to verify against Sigstore: %v", res.Error) + } + + opts.Logger.VerbosePrint(opts.Logger.ColorScheme.Green( + "Successfully verified all attestations against Sigstore!\n\n", + )) + + // If the user provides the --format=json flag, print the results in JSON format + if opts.exporter != nil { + details, err := getAttestationDetails(res.VerifyResults) + if err != nil { + return fmt.Errorf("failed to get attestation detail: %v", err) + } + + // print the results to the terminal as an array of JSON objects + if err = opts.exporter.Write(opts.Logger.IO, details); err != nil { + return fmt.Errorf("failed to write JSON output") + } + return nil + } + + // otherwise, print results in a table + details, err := getDetailsAsSlice(res.VerifyResults) + if err != nil { + return fmt.Errorf("failed to parse attestation details: %v", err) + } + + headers := []string{"Repo Name", "Repo ID", "Org Name", "Org ID", "Workflow ID"} + t := tableprinter.New(opts.Logger.IO, tableprinter.WithHeader(headers...)) + + for _, row := range details { + for _, field := range row { + t.AddField(field, tableprinter.WithTruncate(nil)) + } + t.EndRow() + } + + if err = t.Render(); err != nil { + return fmt.Errorf("failed to print output: %v", err) + } + + return nil +} diff --git a/pkg/cmd/attestation/inspect/inspect_test.go b/pkg/cmd/attestation/inspect/inspect_test.go new file mode 100644 index 000000000..368cc54f5 --- /dev/null +++ b/pkg/cmd/attestation/inspect/inspect_test.go @@ -0,0 +1,187 @@ +package inspect + +import ( + "bytes" + "encoding/json" + "fmt" + "net/http" + "strings" + "testing" + + "github.com/cli/cli/v2/pkg/cmd/attestation/artifact/oci" + "github.com/cli/cli/v2/pkg/cmd/attestation/io" + "github.com/cli/cli/v2/pkg/cmd/attestation/test" + "github.com/cli/cli/v2/pkg/cmd/attestation/verification" + "github.com/cli/cli/v2/pkg/cmdutil" + + "github.com/cli/cli/v2/pkg/httpmock" + "github.com/cli/cli/v2/pkg/iostreams" + + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" +) + +const ( + SigstoreSanValue = "https://github.com/sigstore/sigstore-js/.github/workflows/release.yml@refs/heads/main" + SigstoreSanRegex = "^https://github.com/sigstore/sigstore-js/" +) + +var ( + artifactPath = test.NormalizeRelativePath("../test/data/sigstore-js-2.1.0.tgz") + bundlePath = test.NormalizeRelativePath("../test/data/sigstore-js-2.1.0-bundle.json") +) + +func TestNewInspectCmd(t *testing.T) { + testIO, _, _, _ := iostreams.Test() + f := &cmdutil.Factory{ + IOStreams: testIO, + HttpClient: func() (*http.Client, error) { + reg := &httpmock.Registry{} + client := &http.Client{} + httpmock.ReplaceTripper(client, reg) + return client, nil + }, + } + + testcases := []struct { + name string + cli string + wants Options + wantsErr bool + wantsExporter bool + }{ + { + name: "Invalid digest-alg flag", + cli: fmt.Sprintf("%s --bundle %s --digest-alg sha384", artifactPath, bundlePath), + wants: Options{ + ArtifactPath: artifactPath, + BundlePath: bundlePath, + DigestAlgorithm: "sha384", + OCIClient: oci.MockClient{}, + SigstoreVerifier: verification.NewMockSigstoreVerifier(t), + }, + wantsErr: true, + }, + { + name: "Use default digest-alg value", + cli: fmt.Sprintf("%s --bundle %s", artifactPath, bundlePath), + wants: Options{ + ArtifactPath: artifactPath, + BundlePath: bundlePath, + DigestAlgorithm: "sha256", + OCIClient: oci.MockClient{}, + SigstoreVerifier: verification.NewMockSigstoreVerifier(t), + }, + wantsErr: false, + }, + { + name: "Use custom digest-alg value", + cli: fmt.Sprintf("%s --bundle %s --digest-alg sha512", artifactPath, bundlePath), + wants: Options{ + ArtifactPath: artifactPath, + BundlePath: bundlePath, + DigestAlgorithm: "sha512", + OCIClient: oci.MockClient{}, + SigstoreVerifier: verification.NewMockSigstoreVerifier(t), + }, + wantsErr: false, + }, + { + name: "Missing bundle flag", + cli: artifactPath, + wants: Options{ + ArtifactPath: artifactPath, + DigestAlgorithm: "sha256", + OCIClient: oci.MockClient{}, + SigstoreVerifier: verification.NewMockSigstoreVerifier(t), + }, + wantsErr: true, + }, + { + name: "Prints output in JSON format", + cli: fmt.Sprintf("%s --bundle %s --format json", artifactPath, bundlePath), + wants: Options{ + ArtifactPath: artifactPath, + BundlePath: bundlePath, + DigestAlgorithm: "sha256", + OCIClient: oci.MockClient{}, + SigstoreVerifier: verification.NewMockSigstoreVerifier(t), + }, + wantsExporter: true, + }, + } + + for _, tc := range testcases { + t.Run(tc.name, func(t *testing.T) { + var opts *Options + cmd := NewInspectCmd(f, func(o *Options) error { + opts = o + return nil + }) + + argv := strings.Split(tc.cli, " ") + cmd.SetArgs(argv) + cmd.SetIn(&bytes.Buffer{}) + cmd.SetOut(&bytes.Buffer{}) + cmd.SetErr(&bytes.Buffer{}) + _, err := cmd.ExecuteC() + if tc.wantsErr { + assert.Error(t, err) + return + } + assert.NoError(t, err) + + assert.Equal(t, tc.wants.ArtifactPath, opts.ArtifactPath) + assert.Equal(t, tc.wants.BundlePath, opts.BundlePath) + assert.Equal(t, tc.wants.DigestAlgorithm, opts.DigestAlgorithm) + assert.NotNil(t, opts.Logger) + assert.NotNil(t, opts.OCIClient) + assert.Equal(t, tc.wantsExporter, opts.exporter != nil) + }) + } +} + +func TestRunInspect(t *testing.T) { + opts := Options{ + ArtifactPath: artifactPath, + BundlePath: bundlePath, + DigestAlgorithm: "sha512", + Logger: io.NewTestHandler(), + OCIClient: oci.MockClient{}, + SigstoreVerifier: verification.NewMockSigstoreVerifier(t), + } + + t.Run("with valid artifact and bundle", func(t *testing.T) { + require.Nil(t, runInspect(&opts)) + }) + + t.Run("with missing artifact path", func(t *testing.T) { + customOpts := opts + customOpts.ArtifactPath = test.NormalizeRelativePath("../test/data/non-existent-artifact.zip") + require.Error(t, runInspect(&customOpts)) + }) + + t.Run("with missing bundle path", func(t *testing.T) { + customOpts := opts + customOpts.BundlePath = test.NormalizeRelativePath("../test/data/non-existent-sigstoreBundle.json") + require.Error(t, runInspect(&customOpts)) + }) +} + +func TestJSONOutput(t *testing.T) { + testIO, _, out, _ := iostreams.Test() + opts := Options{ + ArtifactPath: artifactPath, + BundlePath: bundlePath, + DigestAlgorithm: "sha512", + Logger: io.NewHandler(testIO), + OCIClient: oci.MockClient{}, + SigstoreVerifier: verification.NewMockSigstoreVerifier(t), + exporter: cmdutil.NewJSONExporter(), + } + require.Nil(t, runInspect(&opts)) + + var target []AttestationDetail + err := json.Unmarshal(out.Bytes(), &target) + require.NoError(t, err) +} diff --git a/pkg/cmd/attestation/inspect/options.go b/pkg/cmd/attestation/inspect/options.go new file mode 100644 index 000000000..b9c8819c4 --- /dev/null +++ b/pkg/cmd/attestation/inspect/options.go @@ -0,0 +1,26 @@ +package inspect + +import ( + "path/filepath" + + "github.com/cli/cli/v2/pkg/cmd/attestation/artifact/oci" + "github.com/cli/cli/v2/pkg/cmd/attestation/io" + "github.com/cli/cli/v2/pkg/cmd/attestation/verification" + "github.com/cli/cli/v2/pkg/cmdutil" +) + +// Options captures the options for the inspect command +type Options struct { + ArtifactPath string + BundlePath string + DigestAlgorithm string + Logger *io.Handler + OCIClient oci.Client + SigstoreVerifier verification.SigstoreVerifier + exporter cmdutil.Exporter +} + +// Clean cleans the file path option values +func (opts *Options) Clean() { + opts.BundlePath = filepath.Clean(opts.BundlePath) +} diff --git a/pkg/cmd/attestation/inspect/policy.go b/pkg/cmd/attestation/inspect/policy.go new file mode 100644 index 000000000..49313d35a --- /dev/null +++ b/pkg/cmd/attestation/inspect/policy.go @@ -0,0 +1,18 @@ +package inspect + +import ( + "github.com/cli/cli/v2/pkg/cmd/attestation/artifact" + "github.com/cli/cli/v2/pkg/cmd/attestation/verification" + + sigstoreVerify "github.com/sigstore/sigstore-go/pkg/verify" +) + +func buildPolicy(a artifact.DigestedArtifact) (sigstoreVerify.PolicyBuilder, error) { + artifactDigestPolicyOption, err := verification.BuildDigestPolicyOption(a) + if err != nil { + return sigstoreVerify.PolicyBuilder{}, err + } + + policy := sigstoreVerify.NewPolicy(artifactDigestPolicyOption, sigstoreVerify.WithoutIdentitiesUnsafe()) + return policy, nil +} diff --git a/pkg/cmd/attestation/io/handler.go b/pkg/cmd/attestation/io/handler.go new file mode 100644 index 000000000..07be3d1df --- /dev/null +++ b/pkg/cmd/attestation/io/handler.go @@ -0,0 +1,78 @@ +package io + +import ( + "fmt" + + "github.com/cli/cli/v2/internal/tableprinter" + "github.com/cli/cli/v2/pkg/iostreams" + "github.com/cli/cli/v2/utils" +) + +type Handler struct { + ColorScheme *iostreams.ColorScheme + IO *iostreams.IOStreams + debugEnabled bool +} + +func NewHandler(io *iostreams.IOStreams) *Handler { + enabled, _ := utils.IsDebugEnabled() + + return &Handler{ + ColorScheme: io.ColorScheme(), + IO: io, + debugEnabled: enabled, + } +} + +func NewTestHandler() *Handler { + testIO, _, _, _ := iostreams.Test() + return NewHandler(testIO) +} + +// Printf writes the formatted arguments to the stderr writer. +func (h *Handler) Printf(f string, v ...interface{}) (int, error) { + if !h.IO.IsStdoutTTY() { + return 0, nil + } + return fmt.Fprintf(h.IO.ErrOut, f, v...) +} + +// Println writes the arguments to the stderr writer with a newline at the end. +func (h *Handler) Println(v ...interface{}) (int, error) { + if !h.IO.IsStdoutTTY() { + return 0, nil + } + return fmt.Fprintln(h.IO.ErrOut, v...) +} + +func (h *Handler) VerbosePrint(msg string) (int, error) { + if !h.debugEnabled || !h.IO.IsStdoutTTY() { + return 0, nil + } + + return fmt.Fprintln(h.IO.ErrOut, msg) +} + +func (h *Handler) VerbosePrintf(f string, v ...interface{}) (int, error) { + if !h.debugEnabled || !h.IO.IsStdoutTTY() { + return 0, nil + } + + return fmt.Fprintf(h.IO.ErrOut, f, v...) +} + +func (h *Handler) PrintTable(headers []string, rows [][]string) error { + t := tableprinter.New(h.IO, tableprinter.WithHeader(headers...)) + + for _, row := range rows { + for _, field := range row { + t.AddField(field, tableprinter.WithTruncate(nil)) + } + t.EndRow() + } + + if err := t.Render(); err != nil { + return fmt.Errorf("failed to print output: %v", err) + } + return nil +} diff --git a/pkg/cmd/attestation/test/data/data.go b/pkg/cmd/attestation/test/data/data.go new file mode 100644 index 000000000..77f07e60c --- /dev/null +++ b/pkg/cmd/attestation/test/data/data.go @@ -0,0 +1,17 @@ +package data + +import ( + _ "embed" + "testing" + + "github.com/sigstore/sigstore-go/pkg/bundle" + sgData "github.com/sigstore/sigstore-go/pkg/testing/data" +) + +//go:embed sigstore-js-2.1.0-bundle.json +var SigstoreBundleRaw []byte + +// SigstoreBundle returns a test *sigstore.Bundle +func SigstoreBundle(t *testing.T) *bundle.ProtobufBundle { + return sgData.TestBundle(t, SigstoreBundleRaw) +} diff --git a/pkg/cmd/attestation/test/data/github_provenance_demo-0.0.12-py3-none-any-bundle-missing-cert.jsonl b/pkg/cmd/attestation/test/data/github_provenance_demo-0.0.12-py3-none-any-bundle-missing-cert.jsonl new file mode 100644 index 000000000..e07ec7eda --- /dev/null +++ b/pkg/cmd/attestation/test/data/github_provenance_demo-0.0.12-py3-none-any-bundle-missing-cert.jsonl @@ -0,0 +1 @@ +{"mediaType":"application/vnd.dev.sigstore.bundle+json;version=0.2","verificationMaterial":{"publicKey":{},"timestampVerificationData":{"rfc3161Timestamps":[{"signedTimestamp":"MIIC0jADAgEAMIICyQYJKoZIhvcNAQcCoIICujCCArYCAQMxDTALBglghkgBZQMEAgIwgbwGCyqGSIb3DQEJEAEEoIGsBIGpMIGmAgEBBgkrBgEEAYO/MAIwMTANBglghkgBZQMEAgEFAAQgGIbhbjwKQeOttAHpYr4ZdztGymTk4PPmJo1M4wwN9s8CFQDfGDV1B9hFrCLmzlcmvopZMaQOpxgPMjAyNDA0MjIxNzMzMjZaMAMCAQGgNqQ0MDIxFTATBgNVBAoTDEdpdEh1YiwgSW5jLjEZMBcGA1UEAxMQVFNBIFRpbWVzdGFtcGluZ6AAMYIB3zCCAdsCAQEwSjAyMRUwEwYDVQQKEwxHaXRIdWIsIEluYy4xGTAXBgNVBAMTEFRTQSBpbnRlcm1lZGlhdGUCFDQ1ZZrWbr6Lo5+CsIgv6MSK/IcQMAsGCWCGSAFlAwQCAqCCAQUwGgYJKoZIhvcNAQkDMQ0GCyqGSIb3DQEJEAEEMBwGCSqGSIb3DQEJBTEPFw0yNDA0MjIxNzMzMjZaMD8GCSqGSIb3DQEJBDEyBDAGSn57m09Ro452Mj6xp7ld68UOS58CRbsUAX0K7Oesj8Kcpo2xKRMwapTRYFWZF84wgYcGCyqGSIb3DQEJEAIvMXgwdjB0MHIEIC4X67ezV4q0OFecnkRUAx6sVRjb/Q6nZYy0cfMfHKgBME4wNqQ0MDIxFTATBgNVBAoTDEdpdEh1YiwgSW5jLjEZMBcGA1UEAxMQVFNBIGludGVybWVkaWF0ZQIUNDVlmtZuvoujn4KwiC/oxIr8hxAwCgYIKoZIzj0EAwMEaDBmAjEA0DIXC6giK74kBGL9WRcy99QAvkKWM2N20fNLFxTVrPglT0oNrTzTiyVQgIN6w1/gAjEAqxEuJp/bRj/ADIHoCBp2+K+zI2opxLbD4rj3jLaezHnoNOYpLwP3lIwFDhYU1a8a"}]}}} diff --git a/pkg/cmd/attestation/test/data/github_provenance_demo-0.0.12-py3-none-any-bundle-missing-verification-material.jsonl b/pkg/cmd/attestation/test/data/github_provenance_demo-0.0.12-py3-none-any-bundle-missing-verification-material.jsonl new file mode 100644 index 000000000..935bc9ce8 --- /dev/null +++ b/pkg/cmd/attestation/test/data/github_provenance_demo-0.0.12-py3-none-any-bundle-missing-verification-material.jsonl @@ -0,0 +1 @@ +{"mediaType":"application/vnd.dev.sigstore.bundle+json;version=0.2","dsseEnvelope":{"payload":"eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2l0aHViX3Byb3ZlbmFuY2VfZGVtby0wLjAuMTItcHkzLW5vbmUtYW55LndobCIsImRpZ2VzdCI6eyJzaGEyNTYiOiJhZTU3OTM2ZGVmNTliYzRjNzVlZGQzYTgzN2Q4OWJjZWZjNmQzYTVlMzFkNTVhNmZhN2E3MTYyNGY5MmMzYzNiIn19XSwicHJlZGljYXRlVHlwZSI6Imh0dHBzOi8vc2xzYS5kZXYvcHJvdmVuYW5jZS92MSIsInByZWRpY2F0ZSI6eyJidWlsZERlZmluaXRpb24iOnsiYnVpbGRUeXBlIjoiaHR0cHM6Ly9zbHNhLWZyYW1ld29yay5naXRodWIuaW8vZ2l0aHViLWFjdGlvbnMtYnVpbGR0eXBlcy93b3JrZmxvdy92MSIsImV4dGVybmFsUGFyYW1ldGVycyI6eyJ3b3JrZmxvdyI6eyJyZWYiOiJyZWZzL2hlYWRzL21haW4iLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvYXR0ZXN0LWRlbW8iLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvYnVpbGQtcHl0aG9uLnltbCJ9fSwiaW50ZXJuYWxQYXJhbWV0ZXJzIjp7ImdpdGh1YiI6eyJldmVudF9uYW1lIjoid29ya2Zsb3dfZGlzcGF0Y2giLCJyZXBvc2l0b3J5X2lkIjoiNzYzMjg3NTMyIiwicmVwb3NpdG9yeV9vd25lcl9pZCI6IjQ0MDM2NTYyIn19LCJyZXNvbHZlZERlcGVuZGVuY2llcyI6W3sidXJpIjoiZ2l0K2h0dHBzOi8vZ2l0aHViLmNvbS9hY3Rpb25zL2F0dGVzdC1kZW1vQHJlZnMvaGVhZHMvbWFpbiIsImRpZ2VzdCI6eyJnaXRDb21taXQiOiJhNmMyM2I5ODA2YzU5MzY2NGY2ODYzN2M4ZjlkNDVkZmNmOThiMmRiIn19XX0sInJ1bkRldGFpbHMiOnsiYnVpbGRlciI6eyJpZCI6Imh0dHBzOi8vZ2l0aHViLmNvbS9hY3Rpb25zL3J1bm5lci9naXRodWItaG9zdGVkIn0sIm1ldGFkYXRhIjp7Imludm9jYXRpb25JZCI6Imh0dHBzOi8vZ2l0aHViLmNvbS9hY3Rpb25zL2F0dGVzdC1kZW1vL2FjdGlvbnMvcnVucy84Nzg4Mzg5NjAxL2F0dGVtcHRzLzEifX19fQ==","payloadType":"application/vnd.in-toto+json","signatures":[{"sig":"MEUCIAgJYzFW0xtAGqTzSn8UWxvT16QLL1qLolcylZsN39U/AiEA/HSUE5sCPEkEHuZgsPS7LkZ9SkMlHGHhpMU3RsV/cYw="}]}} diff --git a/pkg/cmd/attestation/test/data/github_provenance_demo-0.0.12-py3-none-any-bundle.jsonl b/pkg/cmd/attestation/test/data/github_provenance_demo-0.0.12-py3-none-any-bundle.jsonl new file mode 100644 index 000000000..209b2373e --- /dev/null +++ b/pkg/cmd/attestation/test/data/github_provenance_demo-0.0.12-py3-none-any-bundle.jsonl @@ -0,0 +1 @@ +{"mediaType":"application/vnd.dev.sigstore.bundle+json;version=0.2","verificationMaterial":{"x509CertificateChain":{"certificates":[{"rawBytes":"MIIGZjCCBeygAwIBAgIUZCNUZ8MMbrK0CrXtb6QFhFMAA6wwCgYIKoZIzj0EAwMwODEVMBMGA1UEChMMR2l0SHViLCBJbmMuMR8wHQYDVQQDExZGdWxjaW8gSW50ZXJtZWRpYXRlIGwyMB4XDTI0MDQyMjE3MzMyNloXDTI0MDQyMjE3NDMyNlowADBZMBMGByqGSM49AgEGCCqGSM49AwEHA0IABLq8PHWv71CECMctIxOYXeUm893MJEazyiLqAJPmEHx8oJsk+vYt8zvEjfL6OAiUpR60Cfk5moqCrr4WwvM3jPujggUKMIIFBjAOBgNVHQ8BAf8EBAMCB4AwEwYDVR0lBAwwCgYIKwYBBQUHAwMwHQYDVR0OBBYEFK10jC8CJcrMLDA80Jf4joCWq+H5MB8GA1UdIwQYMBaAFJtL5A5EGdvYbrWHWsiaGyEZn/4jMGcGA1UdEQEB/wRdMFuGWWh0dHBzOi8vZ2l0aHViLmNvbS9hY3Rpb25zL2F0dGVzdC1kZW1vLy5naXRodWIvd29ya2Zsb3dzL2J1aWxkLXB5dGhvbi55bWxAcmVmcy9oZWFkcy9tYWluMDkGCisGAQQBg78wAQEEK2h0dHBzOi8vdG9rZW4uYWN0aW9ucy5naXRodWJ1c2VyY29udGVudC5jb20wHwYKKwYBBAGDvzABAgQRd29ya2Zsb3dfZGlzcGF0Y2gwNgYKKwYBBAGDvzABAwQoYTZjMjNiOTgwNmM1OTM2NjRmNjg2MzdjOGY5ZDQ1ZGZjZjk4YjJkYjAvBgorBgEEAYO/MAEEBCFCdWlsZCBwYWNrYWdlIGFuZCBwdWJsaXNoIHRvIFB5UEkwIQYKKwYBBAGDvzABBQQTYWN0aW9ucy9hdHRlc3QtZGVtbzAdBgorBgEEAYO/MAEGBA9yZWZzL2hlYWRzL21haW4wOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMGkGCisGAQQBg78wAQkEWwxZaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvYXR0ZXN0LWRlbW8vLmdpdGh1Yi93b3JrZmxvd3MvYnVpbGQtcHl0aG9uLnltbEByZWZzL2hlYWRzL21haW4wOAYKKwYBBAGDvzABCgQqDChhNmMyM2I5ODA2YzU5MzY2NGY2ODYzN2M4ZjlkNDVkZmNmOThiMmRiMB0GCisGAQQBg78wAQsEDwwNZ2l0aHViLWhvc3RlZDA2BgorBgEEAYO/MAEMBCgMJmh0dHBzOi8vZ2l0aHViLmNvbS9hY3Rpb25zL2F0dGVzdC1kZW1vMDgGCisGAQQBg78wAQ0EKgwoYTZjMjNiOTgwNmM1OTM2NjRmNjg2MzdjOGY5ZDQ1ZGZjZjk4YjJkYjAfBgorBgEEAYO/MAEOBBEMD3JlZnMvaGVhZHMvbWFpbjAZBgorBgEEAYO/MAEPBAsMCTc2MzI4NzUzMjAqBgorBgEEAYO/MAEQBBwMGmh0dHBzOi8vZ2l0aHViLmNvbS9hY3Rpb25zMBgGCisGAQQBg78wAREECgwINDQwMzY1NjIwaQYKKwYBBAGDvzABEgRbDFlodHRwczovL2dpdGh1Yi5jb20vYWN0aW9ucy9hdHRlc3QtZGVtby8uZ2l0aHViL3dvcmtmbG93cy9idWlsZC1weXRob24ueW1sQHJlZnMvaGVhZHMvbWFpbjA4BgorBgEEAYO/MAETBCoMKGE2YzIzYjk4MDZjNTkzNjY0ZjY4NjM3YzhmOWQ0NWRmY2Y5OGIyZGIwIQYKKwYBBAGDvzABFAQTDBF3b3JrZmxvd19kaXNwYXRjaDBZBgorBgEEAYO/MAEVBEsMSWh0dHBzOi8vZ2l0aHViLmNvbS9hY3Rpb25zL2F0dGVzdC1kZW1vL2FjdGlvbnMvcnVucy84Nzg4Mzg5NjAxL2F0dGVtcHRzLzEwFwYKKwYBBAGDvzABFgQJDAdwcml2YXRlMAoGCCqGSM49BAMDA2gAMGUCME4MEsuiTVolcvctwKJn7TEfi9mIXxhfBRcV0Nox1UPvdc4EyO/gjYPqfWVbqi74CgIxANLkoV0aAeOaIuA1srkA1uIGmhuA820pXs0kbqW06cNuJie4+3B4PydoYoJjy1BZCQ=="}]},"timestampVerificationData":{"rfc3161Timestamps":[{"signedTimestamp":"MIIC0jADAgEAMIICyQYJKoZIhvcNAQcCoIICujCCArYCAQMxDTALBglghkgBZQMEAgIwgbwGCyqGSIb3DQEJEAEEoIGsBIGpMIGmAgEBBgkrBgEEAYO/MAIwMTANBglghkgBZQMEAgEFAAQgGIbhbjwKQeOttAHpYr4ZdztGymTk4PPmJo1M4wwN9s8CFQDfGDV1B9hFrCLmzlcmvopZMaQOpxgPMjAyNDA0MjIxNzMzMjZaMAMCAQGgNqQ0MDIxFTATBgNVBAoTDEdpdEh1YiwgSW5jLjEZMBcGA1UEAxMQVFNBIFRpbWVzdGFtcGluZ6AAMYIB3zCCAdsCAQEwSjAyMRUwEwYDVQQKEwxHaXRIdWIsIEluYy4xGTAXBgNVBAMTEFRTQSBpbnRlcm1lZGlhdGUCFDQ1ZZrWbr6Lo5+CsIgv6MSK/IcQMAsGCWCGSAFlAwQCAqCCAQUwGgYJKoZIhvcNAQkDMQ0GCyqGSIb3DQEJEAEEMBwGCSqGSIb3DQEJBTEPFw0yNDA0MjIxNzMzMjZaMD8GCSqGSIb3DQEJBDEyBDAGSn57m09Ro452Mj6xp7ld68UOS58CRbsUAX0K7Oesj8Kcpo2xKRMwapTRYFWZF84wgYcGCyqGSIb3DQEJEAIvMXgwdjB0MHIEIC4X67ezV4q0OFecnkRUAx6sVRjb/Q6nZYy0cfMfHKgBME4wNqQ0MDIxFTATBgNVBAoTDEdpdEh1YiwgSW5jLjEZMBcGA1UEAxMQVFNBIGludGVybWVkaWF0ZQIUNDVlmtZuvoujn4KwiC/oxIr8hxAwCgYIKoZIzj0EAwMEaDBmAjEA0DIXC6giK74kBGL9WRcy99QAvkKWM2N20fNLFxTVrPglT0oNrTzTiyVQgIN6w1/gAjEAqxEuJp/bRj/ADIHoCBp2+K+zI2opxLbD4rj3jLaezHnoNOYpLwP3lIwFDhYU1a8a"}]}},"dsseEnvelope":{"payload":"eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2l0aHViX3Byb3ZlbmFuY2VfZGVtby0wLjAuMTItcHkzLW5vbmUtYW55LndobCIsImRpZ2VzdCI6eyJzaGEyNTYiOiJhZTU3OTM2ZGVmNTliYzRjNzVlZGQzYTgzN2Q4OWJjZWZjNmQzYTVlMzFkNTVhNmZhN2E3MTYyNGY5MmMzYzNiIn19XSwicHJlZGljYXRlVHlwZSI6Imh0dHBzOi8vc2xzYS5kZXYvcHJvdmVuYW5jZS92MSIsInByZWRpY2F0ZSI6eyJidWlsZERlZmluaXRpb24iOnsiYnVpbGRUeXBlIjoiaHR0cHM6Ly9zbHNhLWZyYW1ld29yay5naXRodWIuaW8vZ2l0aHViLWFjdGlvbnMtYnVpbGR0eXBlcy93b3JrZmxvdy92MSIsImV4dGVybmFsUGFyYW1ldGVycyI6eyJ3b3JrZmxvdyI6eyJyZWYiOiJyZWZzL2hlYWRzL21haW4iLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvYXR0ZXN0LWRlbW8iLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvYnVpbGQtcHl0aG9uLnltbCJ9fSwiaW50ZXJuYWxQYXJhbWV0ZXJzIjp7ImdpdGh1YiI6eyJldmVudF9uYW1lIjoid29ya2Zsb3dfZGlzcGF0Y2giLCJyZXBvc2l0b3J5X2lkIjoiNzYzMjg3NTMyIiwicmVwb3NpdG9yeV9vd25lcl9pZCI6IjQ0MDM2NTYyIn19LCJyZXNvbHZlZERlcGVuZGVuY2llcyI6W3sidXJpIjoiZ2l0K2h0dHBzOi8vZ2l0aHViLmNvbS9hY3Rpb25zL2F0dGVzdC1kZW1vQHJlZnMvaGVhZHMvbWFpbiIsImRpZ2VzdCI6eyJnaXRDb21taXQiOiJhNmMyM2I5ODA2YzU5MzY2NGY2ODYzN2M4ZjlkNDVkZmNmOThiMmRiIn19XX0sInJ1bkRldGFpbHMiOnsiYnVpbGRlciI6eyJpZCI6Imh0dHBzOi8vZ2l0aHViLmNvbS9hY3Rpb25zL3J1bm5lci9naXRodWItaG9zdGVkIn0sIm1ldGFkYXRhIjp7Imludm9jYXRpb25JZCI6Imh0dHBzOi8vZ2l0aHViLmNvbS9hY3Rpb25zL2F0dGVzdC1kZW1vL2FjdGlvbnMvcnVucy84Nzg4Mzg5NjAxL2F0dGVtcHRzLzEifX19fQ==","payloadType":"application/vnd.in-toto+json","signatures":[{"sig":"MEUCIAgJYzFW0xtAGqTzSn8UWxvT16QLL1qLolcylZsN39U/AiEA/HSUE5sCPEkEHuZgsPS7LkZ9SkMlHGHhpMU3RsV/cYw="}]}} diff --git a/pkg/cmd/attestation/test/data/github_provenance_demo-0.0.12-py3-none-any.whl b/pkg/cmd/attestation/test/data/github_provenance_demo-0.0.12-py3-none-any.whl new file mode 100644 index 000000000..67fa195e0 Binary files /dev/null and b/pkg/cmd/attestation/test/data/github_provenance_demo-0.0.12-py3-none-any.whl differ diff --git a/pkg/cmd/attestation/test/data/sigstore-js-2.1.0-bundle.json b/pkg/cmd/attestation/test/data/sigstore-js-2.1.0-bundle.json new file mode 100644 index 000000000..d91176e09 --- /dev/null +++ b/pkg/cmd/attestation/test/data/sigstore-js-2.1.0-bundle.json @@ -0,0 +1,61 @@ +{ + "mediaType": "application/vnd.dev.sigstore.bundle+json;version=0.1", + "verificationMaterial": { + "x509CertificateChain": { + "certificates": [ + { + "rawBytes": "MIIGtDCCBjugAwIBAgIUCJLipSt09KLFc0JYfuDrSan//LswCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjMwODI5MTU0MDIzWhcNMjMwODI5MTU1MDIzWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEPfm6LPXQeJTC89UOqiNWmnZYGmX4T3iLZGi0EV4bfOoM86Hza94XqyuwxAoWpCPecFCEbAe8l2dg/er3O9LEFqOCBVowggVWMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUeqpCXHr3pcUaL3EFKR+KsmuKQqowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wYwYDVR0RAQH/BFkwV4ZVaHR0cHM6Ly9naXRodWIuY29tL3NpZ3N0b3JlL3NpZ3N0b3JlLWpzLy5naXRodWIvd29ya2Zsb3dzL3JlbGVhc2UueW1sQHJlZnMvaGVhZHMvbWFpbjA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMBIGCisGAQQBg78wAQIEBHB1c2gwNgYKKwYBBAGDvzABAwQoMjZkMTY1MTMzODZmZmFhNzkwYjFjMzJmOTI3NTQ0ZjEzMjJlNDE5NDAVBgorBgEEAYO/MAEEBAdSZWxlYXNlMCIGCisGAQQBg78wAQUEFHNpZ3N0b3JlL3NpZ3N0b3JlLWpzMB0GCisGAQQBg78wAQYED3JlZnMvaGVhZHMvbWFpbjA7BgorBgEEAYO/MAEIBC0MK2h0dHBzOi8vdG9rZW4uYWN0aW9ucy5naXRodWJ1c2VyY29udGVudC5jb20wZQYKKwYBBAGDvzABCQRXDFVodHRwczovL2dpdGh1Yi5jb20vc2lnc3RvcmUvc2lnc3RvcmUtanMvLmdpdGh1Yi93b3JrZmxvd3MvcmVsZWFzZS55bWxAcmVmcy9oZWFkcy9tYWluMDgGCisGAQQBg78wAQoEKgwoMjZkMTY1MTMzODZmZmFhNzkwYjFjMzJmOTI3NTQ0ZjEzMjJlNDE5NDAdBgorBgEEAYO/MAELBA8MDWdpdGh1Yi1ob3N0ZWQwNwYKKwYBBAGDvzABDAQpDCdodHRwczovL2dpdGh1Yi5jb20vc2lnc3RvcmUvc2lnc3RvcmUtanMwOAYKKwYBBAGDvzABDQQqDCgyNmQxNjUxMzM4NmZmYWE3OTBiMWMzMmY5Mjc1NDRmMTMyMmU0MTk0MB8GCisGAQQBg78wAQ4EEQwPcmVmcy9oZWFkcy9tYWluMBkGCisGAQQBg78wAQ8ECwwJNDk1NTc0NTU1MCsGCisGAQQBg78wARAEHQwbaHR0cHM6Ly9naXRodWIuY29tL3NpZ3N0b3JlMBgGCisGAQQBg78wAREECgwINzEwOTYzNTMwZQYKKwYBBAGDvzABEgRXDFVodHRwczovL2dpdGh1Yi5jb20vc2lnc3RvcmUvc2lnc3RvcmUtanMvLmdpdGh1Yi93b3JrZmxvd3MvcmVsZWFzZS55bWxAcmVmcy9oZWFkcy9tYWluMDgGCisGAQQBg78wARMEKgwoMjZkMTY1MTMzODZmZmFhNzkwYjFjMzJmOTI3NTQ0ZjEzMjJlNDE5NDAUBgorBgEEAYO/MAEUBAYMBHB1c2gwWgYKKwYBBAGDvzABFQRMDEpodHRwczovL2dpdGh1Yi5jb20vc2lnc3RvcmUvc2lnc3RvcmUtanMvYWN0aW9ucy9ydW5zLzYwMTQ0ODg2NjYvYXR0ZW1wdHMvMTAWBgorBgEEAYO/MAEWBAgMBnB1YmxpYzCBigYKKwYBBAHWeQIEAgR8BHoAeAB2AN09MGrGxxEyYxkeHJlnNwKiSl643jyt/4eKcoAvKe6OAAABikHz+vwAAAQDAEcwRQIgZEo8c0eCZHEh4uzzJzFz9T+EfSTNTtB2FIH18vXpkOsCIQDE1MTti9RoDnRO3SET1Zkad6FoTx/k6ztQcwIDPmnRxTAKBggqhkjOPQQDAwNnADBkAjBB06fmNXx6ToaClFg2kOxnfLGgrvoR3F5GjDtvDBB8m9SWQNzL211jYmS/g+YbbyUCMC+ad6jIK+efe4XOIlhLcWxeZbBtMjKSrPxmm4jR3BFQQOBR+8r27CioyhxoSqvLuw==" + } + ] + }, + "tlogEntries": [ + { + "logIndex": "33351527", + "logId": { + "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" + }, + "kindVersion": { + "kind": "intoto", + "version": "0.0.2" + }, + "integratedTime": "1693323623", + "inclusionPromise": { + "signedEntryTimestamp": "MEYCIQDhWvNSLvnq5ZS3qTIgC7K2uQFeA0g8FEEjNo1UQxeubAIhALDrD1uIiUkk3tQNp/4gKT/9j8zEyyxi9Ti+qaD8q2vI" + }, + "inclusionProof": { + "logIndex": "29188096", + "rootHash": "fbEijQTFeiQCldZqez/u/WcrNPk4nxXI5ihofHYjFUA=", + "treeSize": "29188099", + "hashes": [ + "z7VKeAC2d2x18Vtxt7n40GS3gtc1xfRwjjxxzpy/Trw=", + "/Kd8ZuCLZ7MukSwpjaSgxKFl5X2vdHWk6/qpNrkiUJo=", + "vvkKs7IShUI15nVb9c5olPgBnL9r4uP7+d5KzV0hSjs=", + "Fg4p0WJZw8Lghrpxkx1SXgzfroTeIIrEgEbfgr9IdXY=", + "bH8NahqE+hQ58Qxhg0V5fYusFQ1xsaQ/rK6slWVRT5k=", + "HplNgZ3/afEHq52zcfL2s1AKisOYDdMCWK1jOu1tGyw=", + "uOPuC2YDmwZe989ZN3Lgh5CKMXh9HETrSNgf0jV0WkM=", + "eVsvWKnEZ1+Xo3Ba15DfEiIhhmlrEaIeb+VfYmx8KhY=", + "uLuBRins5nkqq2rqd17R27pQTUF+xetttC6MsmlUzd0=", + "jRUq4D8O+FI47Wbw96s7yHCu4qzWUxpIVfxQEeprDmc=", + "rXEsmEJN4PEoTU8US4qVtdIsGB1MCiRlGOepoiC99kM=" + ], + "checkpoint": { + "envelope": "rekor.sigstore.dev - 2605736670972794746\n29188099\nfbEijQTFeiQCldZqez/u/WcrNPk4nxXI5ihofHYjFUA=\nTimestamp: 1693323623528968756\n\n— rekor.sigstore.dev wNI9ajBEAiAK0YTbxRlhOZeeP+844Y+W7iz+hsFIF8x2NYsmuaxifAIgYUFSurlKwN7j5jCwpqSVrkbouQoYIYlyWU9Om16svmI=\n" + } + }, + "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjIiLCJraW5kIjoiaW50b3RvIiwic3BlYyI6eyJjb250ZW50Ijp7ImVudmVsb3BlIjp7InBheWxvYWRUeXBlIjoiYXBwbGljYXRpb24vdm5kLmluLXRvdG8ranNvbiIsInNpZ25hdHVyZXMiOlt7InB1YmxpY0tleSI6IkxTMHRMUzFDUlVkSlRpQkRSVkpVU1VaSlEwRlVSUzB0TFMwdENrMUpTVWQwUkVORFFtcDFaMEYzU1VKQlowbFZRMHBNYVhCVGREQTVTMHhHWXpCS1dXWjFSSEpUWVc0dkwweHpkME5uV1VsTGIxcEplbW93UlVGM1RYY0tUbnBGVmsxQ1RVZEJNVlZGUTJoTlRXTXliRzVqTTFKMlkyMVZkVnBIVmpKTlVqUjNTRUZaUkZaUlVVUkZlRlo2WVZka2VtUkhPWGxhVXpGd1ltNVNiQXBqYlRGc1drZHNhR1JIVlhkSWFHTk9UV3BOZDA5RVNUVk5WRlV3VFVSSmVsZG9ZMDVOYWsxM1QwUkpOVTFVVlRGTlJFbDZWMnBCUVUxR2EzZEZkMWxJQ2t0dldrbDZhakJEUVZGWlNVdHZXa2w2YWpCRVFWRmpSRkZuUVVWUVptMDJURkJZVVdWS1ZFTTRPVlZQY1dsT1YyMXVXbGxIYlZnMFZETnBURnBIYVRBS1JWWTBZbVpQYjAwNE5raDZZVGswV0hGNWRYZDRRVzlYY0VOUVpXTkdRMFZpUVdVNGJESmtaeTlsY2pOUE9VeEZSbkZQUTBKV2IzZG5aMVpYVFVFMFJ3cEJNVlZrUkhkRlFpOTNVVVZCZDBsSVowUkJWRUpuVGxaSVUxVkZSRVJCUzBKblozSkNaMFZHUWxGalJFRjZRV1JDWjA1V1NGRTBSVVpuVVZWbGNYQkRDbGhJY2pOd1kxVmhURE5GUmt0U0swdHpiWFZMVVhGdmQwaDNXVVJXVWpCcVFrSm5kMFp2UVZVek9WQndlakZaYTBWYVlqVnhUbXB3UzBaWGFYaHBORmtLV2tRNGQxbDNXVVJXVWpCU1FWRklMMEpHYTNkV05GcFdZVWhTTUdOSVRUWk1lVGx1WVZoU2IyUlhTWFZaTWpsMFRETk9jRm96VGpCaU0wcHNURE5PY0FwYU0wNHdZak5LYkV4WGNIcE1lVFZ1WVZoU2IyUlhTWFprTWpsNVlUSmFjMkl6WkhwTU0wcHNZa2RXYUdNeVZYVmxWekZ6VVVoS2JGcHVUWFpoUjFab0NscElUWFppVjBad1ltcEJOVUpuYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQUtZVWhXYVdSWVRteGpiVTUyWW01U2JHSnVVWFZaTWpsMFRVSkpSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkNTRUl4WXpKbmQwNW5XVXRMZDFsQ1FrRkhSQXAyZWtGQ1FYZFJiMDFxV210TlZGa3hUVlJOZWs5RVdtMWFiVVpvVG5wcmQxbHFSbXBOZWtwdFQxUkpNMDVVVVRCYWFrVjZUV3BLYkU1RVJUVk9SRUZXQ2tKbmIzSkNaMFZGUVZsUEwwMUJSVVZDUVdSVFdsZDRiRmxZVG14TlEwbEhRMmx6UjBGUlVVSm5OemgzUVZGVlJVWklUbkJhTTA0d1lqTktiRXd6VG5BS1dqTk9NR0l6U214TVYzQjZUVUl3UjBOcGMwZEJVVkZDWnpjNGQwRlJXVVZFTTBwc1dtNU5kbUZIVm1oYVNFMTJZbGRHY0dKcVFUZENaMjl5UW1kRlJRcEJXVTh2VFVGRlNVSkRNRTFMTW1nd1pFaENlazlwT0haa1J6bHlXbGMwZFZsWFRqQmhWemwxWTNrMWJtRllVbTlrVjBveFl6SldlVmt5T1hWa1IxWjFDbVJETldwaU1qQjNXbEZaUzB0M1dVSkNRVWRFZG5wQlFrTlJVbGhFUmxadlpFaFNkMk42YjNaTU1tUndaRWRvTVZscE5XcGlNakIyWXpKc2JtTXpVbllLWTIxVmRtTXliRzVqTTFKMlkyMVZkR0Z1VFhaTWJXUndaRWRvTVZscE9UTmlNMHB5V20xNGRtUXpUWFpqYlZaeldsZEdlbHBUTlRWaVYzaEJZMjFXYlFwamVUbHZXbGRHYTJONU9YUlpWMngxVFVSblIwTnBjMGRCVVZGQ1p6YzRkMEZSYjBWTFozZHZUV3BhYTAxVVdURk5WRTE2VDBSYWJWcHRSbWhPZW10M0NsbHFSbXBOZWtwdFQxUkpNMDVVVVRCYWFrVjZUV3BLYkU1RVJUVk9SRUZrUW1kdmNrSm5SVVZCV1U4dlRVRkZURUpCT0UxRVYyUndaRWRvTVZscE1XOEtZak5PTUZwWFVYZE9kMWxMUzNkWlFrSkJSMFIyZWtGQ1JFRlJjRVJEWkc5a1NGSjNZM3B2ZGt3eVpIQmtSMmd4V1drMWFtSXlNSFpqTW14dVl6TlNkZ3BqYlZWMll6SnNibU16VW5aamJWVjBZVzVOZDA5QldVdExkMWxDUWtGSFJIWjZRVUpFVVZGeFJFTm5lVTV0VVhoT2FsVjRUWHBOTkU1dFdtMVpWMFV6Q2s5VVFtbE5WMDE2VFcxWk5VMXFZekZPUkZKdFRWUk5lVTF0VlRCTlZHc3dUVUk0UjBOcGMwZEJVVkZDWnpjNGQwRlJORVZGVVhkUVkyMVdiV041T1c4S1dsZEdhMk41T1hSWlYyeDFUVUpyUjBOcGMwZEJVVkZDWnpjNGQwRlJPRVZEZDNkS1RrUnJNVTVVWXpCT1ZGVXhUVU56UjBOcGMwZEJVVkZDWnpjNGR3cEJVa0ZGU0ZGM1ltRklVakJqU0UwMlRIazVibUZZVW05a1YwbDFXVEk1ZEV3elRuQmFNMDR3WWpOS2JFMUNaMGREYVhOSFFWRlJRbWMzT0hkQlVrVkZDa05uZDBsT2VrVjNUMVJaZWs1VVRYZGFVVmxMUzNkWlFrSkJSMFIyZWtGQ1JXZFNXRVJHVm05a1NGSjNZM3B2ZGt3eVpIQmtSMmd4V1drMWFtSXlNSFlLWXpKc2JtTXpVblpqYlZWMll6SnNibU16VW5aamJWVjBZVzVOZGt4dFpIQmtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbU50Vm5OYVYwWjZXbE0xTlFwaVYzaEJZMjFXYldONU9XOWFWMFpyWTNrNWRGbFhiSFZOUkdkSFEybHpSMEZSVVVKbk56aDNRVkpOUlV0bmQyOU5hbHByVFZSWk1VMVVUWHBQUkZwdENscHRSbWhPZW10M1dXcEdhazE2U20xUFZFa3pUbFJSTUZwcVJYcE5ha3BzVGtSRk5VNUVRVlZDWjI5eVFtZEZSVUZaVHk5TlFVVlZRa0ZaVFVKSVFqRUtZekpuZDFkbldVdExkMWxDUWtGSFJIWjZRVUpHVVZKTlJFVndiMlJJVW5kamVtOTJUREprY0dSSGFERlphVFZxWWpJd2RtTXliRzVqTTFKMlkyMVZkZ3BqTW14dVl6TlNkbU50VlhSaGJrMTJXVmRPTUdGWE9YVmplVGw1WkZjMWVreDZXWGROVkZFd1QwUm5NazVxV1haWldGSXdXbGN4ZDJSSVRYWk5WRUZYQ2tKbmIzSkNaMFZGUVZsUEwwMUJSVmRDUVdkTlFtNUNNVmx0ZUhCWmVrTkNhV2RaUzB0M1dVSkNRVWhYWlZGSlJVRm5VamhDU0c5QlpVRkNNa0ZPTURrS1RVZHlSM2g0UlhsWmVHdGxTRXBzYms1M1MybFRiRFkwTTJwNWRDODBaVXRqYjBGMlMyVTJUMEZCUVVKcGEwaDZLM1ozUVVGQlVVUkJSV04zVWxGSlp3cGFSVzg0WXpCbFExcElSV2cwZFhwNlNucEdlamxVSzBWbVUxUk9WSFJDTWtaSlNERTRkbGh3YTA5elEwbFJSRVV4VFZSMGFUbFNiMFJ1VWs4elUwVlVDakZhYTJGa05rWnZWSGd2YXpaNmRGRmpkMGxFVUcxdVVuaFVRVXRDWjJkeGFHdHFUMUJSVVVSQmQwNXVRVVJDYTBGcVFrSXdObVp0VGxoNE5sUnZZVU1LYkVabk1tdFBlRzVtVEVkbmNuWnZVak5HTlVkcVJIUjJSRUpDT0cwNVUxZFJUbnBNTWpFeGFsbHRVeTluSzFsaVlubFZRMDFESzJGa05tcEpTeXRsWmdwbE5GaFBTV3hvVEdOWGVHVmFZa0owVFdwTFUzSlFlRzF0TkdwU00wSkdVVkZQUWxJck9ISXlOME5wYjNsb2VHOVRjWFpNZFhjOVBRb3RMUzB0TFVWT1JDQkRSVkpVU1VaSlEwRlVSUzB0TFMwdCIsInNpZyI6IlRVVlJRMGxEWVhSb2JsUkljMlJtV25GSWNUTnBXRXhxVFdVd1ZGVTViRXhaYmxJeGVtazNNM0JSZFZobU5VdElRV2xDTWpOS2FDdG5VMll4VVVWRGJrRlRSMlZ3TW1VeVRVZHVVRmhwYjFWTVZqUjJRMGxUU2tKdWEwcGFaejA5In1dfSwiaGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjFiZDg4ZTA1NGY2OGE3ZDE3MzkzNjcyYjAzZmExOGZkNjRmMGRjZDVmY2M1NDAzNWMxOWZlNjQwMWNmMmNmNWUifSwicGF5bG9hZEhhc2giOnsiYWxnb3JpdGhtIjoic2hhMjU2IiwidmFsdWUiOiI4Y2ViNGFiODEyNzczMTQ3M2E5ZWM4MTE0MGNiNjg0OWNmOGU5NzBjZGEzMmJhZWYwOTlkZjQ4YmEzMjY0NDQyIn19fX0=" + } + ], + "timestampVerificationData": null + }, + "dsseEnvelope": { + "payload": "eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoicGtnOm5wbS9zaWdzdG9yZUAyLjEuMCIsImRpZ2VzdCI6eyJzaGE1MTIiOiI5MGYyMjNmOTkyZTRjODhkZDA2OGNkMmE1ZmM1N2Y5ZDJiMzA3OTgzNDNkZDZlMzhmMjljMjQwZTA0YmEwOTBlZjgzMWY4NDQ5MDg0N2M0ZTgyYjkyMzJjNzhlOGEyNTg0NjNiMWU1NWMwZjc0NjlmNzMwMjY1MDA4ZmE2NjMzZiJ9fV0sInByZWRpY2F0ZVR5cGUiOiJodHRwczovL3Nsc2EuZGV2L3Byb3ZlbmFuY2UvdjEiLCJwcmVkaWNhdGUiOnsiYnVpbGREZWZpbml0aW9uIjp7ImJ1aWxkVHlwZSI6Imh0dHBzOi8vc2xzYS1mcmFtZXdvcmsuZ2l0aHViLmlvL2dpdGh1Yi1hY3Rpb25zLWJ1aWxkdHlwZXMvd29ya2Zsb3cvdjEiLCJleHRlcm5hbFBhcmFtZXRlcnMiOnsid29ya2Zsb3ciOnsicmVmIjoicmVmcy9oZWFkcy9tYWluIiwicmVwb3NpdG9yeSI6Imh0dHBzOi8vZ2l0aHViLmNvbS9zaWdzdG9yZS9zaWdzdG9yZS1qcyIsInBhdGgiOiIuZ2l0aHViL3dvcmtmbG93cy9yZWxlYXNlLnltbCJ9fSwiaW50ZXJuYWxQYXJhbWV0ZXJzIjp7ImdpdGh1YiI6eyJldmVudF9uYW1lIjoicHVzaCIsInJlcG9zaXRvcnlfaWQiOiI0OTU1NzQ1NTUiLCJyZXBvc2l0b3J5X293bmVyX2lkIjoiNzEwOTYzNTMifX0sInJlc29sdmVkRGVwZW5kZW5jaWVzIjpbeyJ1cmkiOiJnaXQraHR0cHM6Ly9naXRodWIuY29tL3NpZ3N0b3JlL3NpZ3N0b3JlLWpzQHJlZnMvaGVhZHMvbWFpbiIsImRpZ2VzdCI6eyJnaXRDb21taXQiOiIyNmQxNjUxMzM4NmZmYWE3OTBiMWMzMmY5Mjc1NDRmMTMyMmU0MTk0In19XX0sInJ1bkRldGFpbHMiOnsiYnVpbGRlciI6eyJpZCI6Imh0dHBzOi8vZ2l0aHViLmNvbS9hY3Rpb25zL3J1bm5lci9naXRodWItaG9zdGVkIn0sIm1ldGFkYXRhIjp7Imludm9jYXRpb25JZCI6Imh0dHBzOi8vZ2l0aHViLmNvbS9zaWdzdG9yZS9zaWdzdG9yZS1qcy9hY3Rpb25zL3J1bnMvNjAxNDQ4ODY2Ni9hdHRlbXB0cy8xIn19fX0=", + "payloadType": "application/vnd.in-toto+json", + "signatures": [ + { + "sig": "MEQCICathnTHsdfZqHq3iXLjMe0TU9lLYnR1zi73pQuXf5KHAiB23Jh+gSf1QECnASGep2e2MGnPXioULV4vCISJBnkJZg==", + "keyid": "" + } + ] + } + } diff --git a/pkg/cmd/attestation/test/data/sigstore-js-2.1.0.tgz b/pkg/cmd/attestation/test/data/sigstore-js-2.1.0.tgz new file mode 100644 index 000000000..390b823fd Binary files /dev/null and b/pkg/cmd/attestation/test/data/sigstore-js-2.1.0.tgz differ diff --git a/pkg/cmd/attestation/test/data/sigstore-js-2.1.0_with_2_bundles.jsonl b/pkg/cmd/attestation/test/data/sigstore-js-2.1.0_with_2_bundles.jsonl new file mode 100644 index 000000000..a4aca34d0 --- /dev/null +++ b/pkg/cmd/attestation/test/data/sigstore-js-2.1.0_with_2_bundles.jsonl @@ -0,0 +1,2 @@ +{"mediaType":"application/vnd.dev.sigstore.bundle+json;version=0.1","verificationMaterial":{"x509CertificateChain":{"certificates":[{"rawBytes":"MIIGtDCCBjugAwIBAgIUCJLipSt09KLFc0JYfuDrSan//LswCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjMwODI5MTU0MDIzWhcNMjMwODI5MTU1MDIzWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEPfm6LPXQeJTC89UOqiNWmnZYGmX4T3iLZGi0EV4bfOoM86Hza94XqyuwxAoWpCPecFCEbAe8l2dg/er3O9LEFqOCBVowggVWMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUeqpCXHr3pcUaL3EFKR+KsmuKQqowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wYwYDVR0RAQH/BFkwV4ZVaHR0cHM6Ly9naXRodWIuY29tL3NpZ3N0b3JlL3NpZ3N0b3JlLWpzLy5naXRodWIvd29ya2Zsb3dzL3JlbGVhc2UueW1sQHJlZnMvaGVhZHMvbWFpbjA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMBIGCisGAQQBg78wAQIEBHB1c2gwNgYKKwYBBAGDvzABAwQoMjZkMTY1MTMzODZmZmFhNzkwYjFjMzJmOTI3NTQ0ZjEzMjJlNDE5NDAVBgorBgEEAYO/MAEEBAdSZWxlYXNlMCIGCisGAQQBg78wAQUEFHNpZ3N0b3JlL3NpZ3N0b3JlLWpzMB0GCisGAQQBg78wAQYED3JlZnMvaGVhZHMvbWFpbjA7BgorBgEEAYO/MAEIBC0MK2h0dHBzOi8vdG9rZW4uYWN0aW9ucy5naXRodWJ1c2VyY29udGVudC5jb20wZQYKKwYBBAGDvzABCQRXDFVodHRwczovL2dpdGh1Yi5jb20vc2lnc3RvcmUvc2lnc3RvcmUtanMvLmdpdGh1Yi93b3JrZmxvd3MvcmVsZWFzZS55bWxAcmVmcy9oZWFkcy9tYWluMDgGCisGAQQBg78wAQoEKgwoMjZkMTY1MTMzODZmZmFhNzkwYjFjMzJmOTI3NTQ0ZjEzMjJlNDE5NDAdBgorBgEEAYO/MAELBA8MDWdpdGh1Yi1ob3N0ZWQwNwYKKwYBBAGDvzABDAQpDCdodHRwczovL2dpdGh1Yi5jb20vc2lnc3RvcmUvc2lnc3RvcmUtanMwOAYKKwYBBAGDvzABDQQqDCgyNmQxNjUxMzM4NmZmYWE3OTBiMWMzMmY5Mjc1NDRmMTMyMmU0MTk0MB8GCisGAQQBg78wAQ4EEQwPcmVmcy9oZWFkcy9tYWluMBkGCisGAQQBg78wAQ8ECwwJNDk1NTc0NTU1MCsGCisGAQQBg78wARAEHQwbaHR0cHM6Ly9naXRodWIuY29tL3NpZ3N0b3JlMBgGCisGAQQBg78wAREECgwINzEwOTYzNTMwZQYKKwYBBAGDvzABEgRXDFVodHRwczovL2dpdGh1Yi5jb20vc2lnc3RvcmUvc2lnc3RvcmUtanMvLmdpdGh1Yi93b3JrZmxvd3MvcmVsZWFzZS55bWxAcmVmcy9oZWFkcy9tYWluMDgGCisGAQQBg78wARMEKgwoMjZkMTY1MTMzODZmZmFhNzkwYjFjMzJmOTI3NTQ0ZjEzMjJlNDE5NDAUBgorBgEEAYO/MAEUBAYMBHB1c2gwWgYKKwYBBAGDvzABFQRMDEpodHRwczovL2dpdGh1Yi5jb20vc2lnc3RvcmUvc2lnc3RvcmUtanMvYWN0aW9ucy9ydW5zLzYwMTQ0ODg2NjYvYXR0ZW1wdHMvMTAWBgorBgEEAYO/MAEWBAgMBnB1YmxpYzCBigYKKwYBBAHWeQIEAgR8BHoAeAB2AN09MGrGxxEyYxkeHJlnNwKiSl643jyt/4eKcoAvKe6OAAABikHz+vwAAAQDAEcwRQIgZEo8c0eCZHEh4uzzJzFz9T+EfSTNTtB2FIH18vXpkOsCIQDE1MTti9RoDnRO3SET1Zkad6FoTx/k6ztQcwIDPmnRxTAKBggqhkjOPQQDAwNnADBkAjBB06fmNXx6ToaClFg2kOxnfLGgrvoR3F5GjDtvDBB8m9SWQNzL211jYmS/g+YbbyUCMC+ad6jIK+efe4XOIlhLcWxeZbBtMjKSrPxmm4jR3BFQQOBR+8r27CioyhxoSqvLuw=="}]},"tlogEntries":[{"logIndex":"33351527","logId":{"keyId":"wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0="},"kindVersion":{"kind":"intoto","version":"0.0.2"},"integratedTime":"1693323623","inclusionPromise":{"signedEntryTimestamp":"MEYCIQDhWvNSLvnq5ZS3qTIgC7K2uQFeA0g8FEEjNo1UQxeubAIhALDrD1uIiUkk3tQNp/4gKT/9j8zEyyxi9Ti+qaD8q2vI"},"inclusionProof":{"logIndex":"29188096","rootHash":"fbEijQTFeiQCldZqez/u/WcrNPk4nxXI5ihofHYjFUA=","treeSize":"29188099","hashes":["z7VKeAC2d2x18Vtxt7n40GS3gtc1xfRwjjxxzpy/Trw=","/Kd8ZuCLZ7MukSwpjaSgxKFl5X2vdHWk6/qpNrkiUJo=","vvkKs7IShUI15nVb9c5olPgBnL9r4uP7+d5KzV0hSjs=","Fg4p0WJZw8Lghrpxkx1SXgzfroTeIIrEgEbfgr9IdXY=","bH8NahqE+hQ58Qxhg0V5fYusFQ1xsaQ/rK6slWVRT5k=","HplNgZ3/afEHq52zcfL2s1AKisOYDdMCWK1jOu1tGyw=","uOPuC2YDmwZe989ZN3Lgh5CKMXh9HETrSNgf0jV0WkM=","eVsvWKnEZ1+Xo3Ba15DfEiIhhmlrEaIeb+VfYmx8KhY=","uLuBRins5nkqq2rqd17R27pQTUF+xetttC6MsmlUzd0=","jRUq4D8O+FI47Wbw96s7yHCu4qzWUxpIVfxQEeprDmc=","rXEsmEJN4PEoTU8US4qVtdIsGB1MCiRlGOepoiC99kM="],"checkpoint":{"envelope":"rekor.sigstore.dev - 2605736670972794746\n29188099\nfbEijQTFeiQCldZqez/u/WcrNPk4nxXI5ihofHYjFUA=\nTimestamp: 1693323623528968756\n\n— rekor.sigstore.dev wNI9ajBEAiAK0YTbxRlhOZeeP+844Y+W7iz+hsFIF8x2NYsmuaxifAIgYUFSurlKwN7j5jCwpqSVrkbouQoYIYlyWU9Om16svmI=\n"}},"canonicalizedBody":"eyJhcGlWZXJzaW9uIjoiMC4wLjIiLCJraW5kIjoiaW50b3RvIiwic3BlYyI6eyJjb250ZW50Ijp7ImVudmVsb3BlIjp7InBheWxvYWRUeXBlIjoiYXBwbGljYXRpb24vdm5kLmluLXRvdG8ranNvbiIsInNpZ25hdHVyZXMiOlt7InB1YmxpY0tleSI6IkxTMHRMUzFDUlVkSlRpQkRSVkpVU1VaSlEwRlVSUzB0TFMwdENrMUpTVWQwUkVORFFtcDFaMEYzU1VKQlowbFZRMHBNYVhCVGREQTVTMHhHWXpCS1dXWjFSSEpUWVc0dkwweHpkME5uV1VsTGIxcEplbW93UlVGM1RYY0tUbnBGVmsxQ1RVZEJNVlZGUTJoTlRXTXliRzVqTTFKMlkyMVZkVnBIVmpKTlVqUjNTRUZaUkZaUlVVUkZlRlo2WVZka2VtUkhPWGxhVXpGd1ltNVNiQXBqYlRGc1drZHNhR1JIVlhkSWFHTk9UV3BOZDA5RVNUVk5WRlV3VFVSSmVsZG9ZMDVOYWsxM1QwUkpOVTFVVlRGTlJFbDZWMnBCUVUxR2EzZEZkMWxJQ2t0dldrbDZhakJEUVZGWlNVdHZXa2w2YWpCRVFWRmpSRkZuUVVWUVptMDJURkJZVVdWS1ZFTTRPVlZQY1dsT1YyMXVXbGxIYlZnMFZETnBURnBIYVRBS1JWWTBZbVpQYjAwNE5raDZZVGswV0hGNWRYZDRRVzlYY0VOUVpXTkdRMFZpUVdVNGJESmtaeTlsY2pOUE9VeEZSbkZQUTBKV2IzZG5aMVpYVFVFMFJ3cEJNVlZrUkhkRlFpOTNVVVZCZDBsSVowUkJWRUpuVGxaSVUxVkZSRVJCUzBKblozSkNaMFZHUWxGalJFRjZRV1JDWjA1V1NGRTBSVVpuVVZWbGNYQkRDbGhJY2pOd1kxVmhURE5GUmt0U0swdHpiWFZMVVhGdmQwaDNXVVJXVWpCcVFrSm5kMFp2UVZVek9WQndlakZaYTBWYVlqVnhUbXB3UzBaWGFYaHBORmtLV2tRNGQxbDNXVVJXVWpCU1FWRklMMEpHYTNkV05GcFdZVWhTTUdOSVRUWk1lVGx1WVZoU2IyUlhTWFZaTWpsMFRETk9jRm96VGpCaU0wcHNURE5PY0FwYU0wNHdZak5LYkV4WGNIcE1lVFZ1WVZoU2IyUlhTWFprTWpsNVlUSmFjMkl6WkhwTU0wcHNZa2RXYUdNeVZYVmxWekZ6VVVoS2JGcHVUWFpoUjFab0NscElUWFppVjBad1ltcEJOVUpuYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQUtZVWhXYVdSWVRteGpiVTUyWW01U2JHSnVVWFZaTWpsMFRVSkpSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkNTRUl4WXpKbmQwNW5XVXRMZDFsQ1FrRkhSQXAyZWtGQ1FYZFJiMDFxV210TlZGa3hUVlJOZWs5RVdtMWFiVVpvVG5wcmQxbHFSbXBOZWtwdFQxUkpNMDVVVVRCYWFrVjZUV3BLYkU1RVJUVk9SRUZXQ2tKbmIzSkNaMFZGUVZsUEwwMUJSVVZDUVdSVFdsZDRiRmxZVG14TlEwbEhRMmx6UjBGUlVVSm5OemgzUVZGVlJVWklUbkJhTTA0d1lqTktiRXd6VG5BS1dqTk9NR0l6U214TVYzQjZUVUl3UjBOcGMwZEJVVkZDWnpjNGQwRlJXVVZFTTBwc1dtNU5kbUZIVm1oYVNFMTJZbGRHY0dKcVFUZENaMjl5UW1kRlJRcEJXVTh2VFVGRlNVSkRNRTFMTW1nd1pFaENlazlwT0haa1J6bHlXbGMwZFZsWFRqQmhWemwxWTNrMWJtRllVbTlrVjBveFl6SldlVmt5T1hWa1IxWjFDbVJETldwaU1qQjNXbEZaUzB0M1dVSkNRVWRFZG5wQlFrTlJVbGhFUmxadlpFaFNkMk42YjNaTU1tUndaRWRvTVZscE5XcGlNakIyWXpKc2JtTXpVbllLWTIxVmRtTXliRzVqTTFKMlkyMVZkR0Z1VFhaTWJXUndaRWRvTVZscE9UTmlNMHB5V20xNGRtUXpUWFpqYlZaeldsZEdlbHBUTlRWaVYzaEJZMjFXYlFwamVUbHZXbGRHYTJONU9YUlpWMngxVFVSblIwTnBjMGRCVVZGQ1p6YzRkMEZSYjBWTFozZHZUV3BhYTAxVVdURk5WRTE2VDBSYWJWcHRSbWhPZW10M0NsbHFSbXBOZWtwdFQxUkpNMDVVVVRCYWFrVjZUV3BLYkU1RVJUVk9SRUZrUW1kdmNrSm5SVVZCV1U4dlRVRkZURUpCT0UxRVYyUndaRWRvTVZscE1XOEtZak5PTUZwWFVYZE9kMWxMUzNkWlFrSkJSMFIyZWtGQ1JFRlJjRVJEWkc5a1NGSjNZM3B2ZGt3eVpIQmtSMmd4V1drMWFtSXlNSFpqTW14dVl6TlNkZ3BqYlZWMll6SnNibU16VW5aamJWVjBZVzVOZDA5QldVdExkMWxDUWtGSFJIWjZRVUpFVVZGeFJFTm5lVTV0VVhoT2FsVjRUWHBOTkU1dFdtMVpWMFV6Q2s5VVFtbE5WMDE2VFcxWk5VMXFZekZPUkZKdFRWUk5lVTF0VlRCTlZHc3dUVUk0UjBOcGMwZEJVVkZDWnpjNGQwRlJORVZGVVhkUVkyMVdiV041T1c4S1dsZEdhMk41T1hSWlYyeDFUVUpyUjBOcGMwZEJVVkZDWnpjNGQwRlJPRVZEZDNkS1RrUnJNVTVVWXpCT1ZGVXhUVU56UjBOcGMwZEJVVkZDWnpjNGR3cEJVa0ZGU0ZGM1ltRklVakJqU0UwMlRIazVibUZZVW05a1YwbDFXVEk1ZEV3elRuQmFNMDR3WWpOS2JFMUNaMGREYVhOSFFWRlJRbWMzT0hkQlVrVkZDa05uZDBsT2VrVjNUMVJaZWs1VVRYZGFVVmxMUzNkWlFrSkJSMFIyZWtGQ1JXZFNXRVJHVm05a1NGSjNZM3B2ZGt3eVpIQmtSMmd4V1drMWFtSXlNSFlLWXpKc2JtTXpVblpqYlZWMll6SnNibU16VW5aamJWVjBZVzVOZGt4dFpIQmtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbU50Vm5OYVYwWjZXbE0xTlFwaVYzaEJZMjFXYldONU9XOWFWMFpyWTNrNWRGbFhiSFZOUkdkSFEybHpSMEZSVVVKbk56aDNRVkpOUlV0bmQyOU5hbHByVFZSWk1VMVVUWHBQUkZwdENscHRSbWhPZW10M1dXcEdhazE2U20xUFZFa3pUbFJSTUZwcVJYcE5ha3BzVGtSRk5VNUVRVlZDWjI5eVFtZEZSVUZaVHk5TlFVVlZRa0ZaVFVKSVFqRUtZekpuZDFkbldVdExkMWxDUWtGSFJIWjZRVUpHVVZKTlJFVndiMlJJVW5kamVtOTJUREprY0dSSGFERlphVFZxWWpJd2RtTXliRzVqTTFKMlkyMVZkZ3BqTW14dVl6TlNkbU50VlhSaGJrMTJXVmRPTUdGWE9YVmplVGw1WkZjMWVreDZXWGROVkZFd1QwUm5NazVxV1haWldGSXdXbGN4ZDJSSVRYWk5WRUZYQ2tKbmIzSkNaMFZGUVZsUEwwMUJSVmRDUVdkTlFtNUNNVmx0ZUhCWmVrTkNhV2RaUzB0M1dVSkNRVWhYWlZGSlJVRm5VamhDU0c5QlpVRkNNa0ZPTURrS1RVZHlSM2g0UlhsWmVHdGxTRXBzYms1M1MybFRiRFkwTTJwNWRDODBaVXRqYjBGMlMyVTJUMEZCUVVKcGEwaDZLM1ozUVVGQlVVUkJSV04zVWxGSlp3cGFSVzg0WXpCbFExcElSV2cwZFhwNlNucEdlamxVSzBWbVUxUk9WSFJDTWtaSlNERTRkbGh3YTA5elEwbFJSRVV4VFZSMGFUbFNiMFJ1VWs4elUwVlVDakZhYTJGa05rWnZWSGd2YXpaNmRGRmpkMGxFVUcxdVVuaFVRVXRDWjJkeGFHdHFUMUJSVVVSQmQwNXVRVVJDYTBGcVFrSXdObVp0VGxoNE5sUnZZVU1LYkVabk1tdFBlRzVtVEVkbmNuWnZVak5HTlVkcVJIUjJSRUpDT0cwNVUxZFJUbnBNTWpFeGFsbHRVeTluSzFsaVlubFZRMDFESzJGa05tcEpTeXRsWmdwbE5GaFBTV3hvVEdOWGVHVmFZa0owVFdwTFUzSlFlRzF0TkdwU00wSkdVVkZQUWxJck9ISXlOME5wYjNsb2VHOVRjWFpNZFhjOVBRb3RMUzB0TFVWT1JDQkRSVkpVU1VaSlEwRlVSUzB0TFMwdCIsInNpZyI6IlRVVlJRMGxEWVhSb2JsUkljMlJtV25GSWNUTnBXRXhxVFdVd1ZGVTViRXhaYmxJeGVtazNNM0JSZFZobU5VdElRV2xDTWpOS2FDdG5VMll4VVVWRGJrRlRSMlZ3TW1VeVRVZHVVRmhwYjFWTVZqUjJRMGxUU2tKdWEwcGFaejA5In1dfSwiaGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjFiZDg4ZTA1NGY2OGE3ZDE3MzkzNjcyYjAzZmExOGZkNjRmMGRjZDVmY2M1NDAzNWMxOWZlNjQwMWNmMmNmNWUifSwicGF5bG9hZEhhc2giOnsiYWxnb3JpdGhtIjoic2hhMjU2IiwidmFsdWUiOiI4Y2ViNGFiODEyNzczMTQ3M2E5ZWM4MTE0MGNiNjg0OWNmOGU5NzBjZGEzMmJhZWYwOTlkZjQ4YmEzMjY0NDQyIn19fX0="}],"timestampVerificationData":null},"dsseEnvelope":{"payload":"eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoicGtnOm5wbS9zaWdzdG9yZUAyLjEuMCIsImRpZ2VzdCI6eyJzaGE1MTIiOiI5MGYyMjNmOTkyZTRjODhkZDA2OGNkMmE1ZmM1N2Y5ZDJiMzA3OTgzNDNkZDZlMzhmMjljMjQwZTA0YmEwOTBlZjgzMWY4NDQ5MDg0N2M0ZTgyYjkyMzJjNzhlOGEyNTg0NjNiMWU1NWMwZjc0NjlmNzMwMjY1MDA4ZmE2NjMzZiJ9fV0sInByZWRpY2F0ZVR5cGUiOiJodHRwczovL3Nsc2EuZGV2L3Byb3ZlbmFuY2UvdjEiLCJwcmVkaWNhdGUiOnsiYnVpbGREZWZpbml0aW9uIjp7ImJ1aWxkVHlwZSI6Imh0dHBzOi8vc2xzYS1mcmFtZXdvcmsuZ2l0aHViLmlvL2dpdGh1Yi1hY3Rpb25zLWJ1aWxkdHlwZXMvd29ya2Zsb3cvdjEiLCJleHRlcm5hbFBhcmFtZXRlcnMiOnsid29ya2Zsb3ciOnsicmVmIjoicmVmcy9oZWFkcy9tYWluIiwicmVwb3NpdG9yeSI6Imh0dHBzOi8vZ2l0aHViLmNvbS9zaWdzdG9yZS9zaWdzdG9yZS1qcyIsInBhdGgiOiIuZ2l0aHViL3dvcmtmbG93cy9yZWxlYXNlLnltbCJ9fSwiaW50ZXJuYWxQYXJhbWV0ZXJzIjp7ImdpdGh1YiI6eyJldmVudF9uYW1lIjoicHVzaCIsInJlcG9zaXRvcnlfaWQiOiI0OTU1NzQ1NTUiLCJyZXBvc2l0b3J5X293bmVyX2lkIjoiNzEwOTYzNTMifX0sInJlc29sdmVkRGVwZW5kZW5jaWVzIjpbeyJ1cmkiOiJnaXQraHR0cHM6Ly9naXRodWIuY29tL3NpZ3N0b3JlL3NpZ3N0b3JlLWpzQHJlZnMvaGVhZHMvbWFpbiIsImRpZ2VzdCI6eyJnaXRDb21taXQiOiIyNmQxNjUxMzM4NmZmYWE3OTBiMWMzMmY5Mjc1NDRmMTMyMmU0MTk0In19XX0sInJ1bkRldGFpbHMiOnsiYnVpbGRlciI6eyJpZCI6Imh0dHBzOi8vZ2l0aHViLmNvbS9hY3Rpb25zL3J1bm5lci9naXRodWItaG9zdGVkIn0sIm1ldGFkYXRhIjp7Imludm9jYXRpb25JZCI6Imh0dHBzOi8vZ2l0aHViLmNvbS9zaWdzdG9yZS9zaWdzdG9yZS1qcy9hY3Rpb25zL3J1bnMvNjAxNDQ4ODY2Ni9hdHRlbXB0cy8xIn19fX0=","payloadType":"application/vnd.in-toto+json","signatures":[{"sig":"MEQCICathnTHsdfZqHq3iXLjMe0TU9lLYnR1zi73pQuXf5KHAiB23Jh+gSf1QECnASGep2e2MGnPXioULV4vCISJBnkJZg==","keyid":""}]}} +{"mediaType":"application/vnd.dev.sigstore.bundle+json;version=0.1","verificationMaterial":{"x509CertificateChain":{"certificates":[{"rawBytes":"MIIGtDCCBjugAwIBAgIUCJLipSt09KLFc0JYfuDrSan//LswCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjMwODI5MTU0MDIzWhcNMjMwODI5MTU1MDIzWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEPfm6LPXQeJTC89UOqiNWmnZYGmX4T3iLZGi0EV4bfOoM86Hza94XqyuwxAoWpCPecFCEbAe8l2dg/er3O9LEFqOCBVowggVWMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUeqpCXHr3pcUaL3EFKR+KsmuKQqowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wYwYDVR0RAQH/BFkwV4ZVaHR0cHM6Ly9naXRodWIuY29tL3NpZ3N0b3JlL3NpZ3N0b3JlLWpzLy5naXRodWIvd29ya2Zsb3dzL3JlbGVhc2UueW1sQHJlZnMvaGVhZHMvbWFpbjA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMBIGCisGAQQBg78wAQIEBHB1c2gwNgYKKwYBBAGDvzABAwQoMjZkMTY1MTMzODZmZmFhNzkwYjFjMzJmOTI3NTQ0ZjEzMjJlNDE5NDAVBgorBgEEAYO/MAEEBAdSZWxlYXNlMCIGCisGAQQBg78wAQUEFHNpZ3N0b3JlL3NpZ3N0b3JlLWpzMB0GCisGAQQBg78wAQYED3JlZnMvaGVhZHMvbWFpbjA7BgorBgEEAYO/MAEIBC0MK2h0dHBzOi8vdG9rZW4uYWN0aW9ucy5naXRodWJ1c2VyY29udGVudC5jb20wZQYKKwYBBAGDvzABCQRXDFVodHRwczovL2dpdGh1Yi5jb20vc2lnc3RvcmUvc2lnc3RvcmUtanMvLmdpdGh1Yi93b3JrZmxvd3MvcmVsZWFzZS55bWxAcmVmcy9oZWFkcy9tYWluMDgGCisGAQQBg78wAQoEKgwoMjZkMTY1MTMzODZmZmFhNzkwYjFjMzJmOTI3NTQ0ZjEzMjJlNDE5NDAdBgorBgEEAYO/MAELBA8MDWdpdGh1Yi1ob3N0ZWQwNwYKKwYBBAGDvzABDAQpDCdodHRwczovL2dpdGh1Yi5jb20vc2lnc3RvcmUvc2lnc3RvcmUtanMwOAYKKwYBBAGDvzABDQQqDCgyNmQxNjUxMzM4NmZmYWE3OTBiMWMzMmY5Mjc1NDRmMTMyMmU0MTk0MB8GCisGAQQBg78wAQ4EEQwPcmVmcy9oZWFkcy9tYWluMBkGCisGAQQBg78wAQ8ECwwJNDk1NTc0NTU1MCsGCisGAQQBg78wARAEHQwbaHR0cHM6Ly9naXRodWIuY29tL3NpZ3N0b3JlMBgGCisGAQQBg78wAREECgwINzEwOTYzNTMwZQYKKwYBBAGDvzABEgRXDFVodHRwczovL2dpdGh1Yi5jb20vc2lnc3RvcmUvc2lnc3RvcmUtanMvLmdpdGh1Yi93b3JrZmxvd3MvcmVsZWFzZS55bWxAcmVmcy9oZWFkcy9tYWluMDgGCisGAQQBg78wARMEKgwoMjZkMTY1MTMzODZmZmFhNzkwYjFjMzJmOTI3NTQ0ZjEzMjJlNDE5NDAUBgorBgEEAYO/MAEUBAYMBHB1c2gwWgYKKwYBBAGDvzABFQRMDEpodHRwczovL2dpdGh1Yi5jb20vc2lnc3RvcmUvc2lnc3RvcmUtanMvYWN0aW9ucy9ydW5zLzYwMTQ0ODg2NjYvYXR0ZW1wdHMvMTAWBgorBgEEAYO/MAEWBAgMBnB1YmxpYzCBigYKKwYBBAHWeQIEAgR8BHoAeAB2AN09MGrGxxEyYxkeHJlnNwKiSl643jyt/4eKcoAvKe6OAAABikHz+vwAAAQDAEcwRQIgZEo8c0eCZHEh4uzzJzFz9T+EfSTNTtB2FIH18vXpkOsCIQDE1MTti9RoDnRO3SET1Zkad6FoTx/k6ztQcwIDPmnRxTAKBggqhkjOPQQDAwNnADBkAjBB06fmNXx6ToaClFg2kOxnfLGgrvoR3F5GjDtvDBB8m9SWQNzL211jYmS/g+YbbyUCMC+ad6jIK+efe4XOIlhLcWxeZbBtMjKSrPxmm4jR3BFQQOBR+8r27CioyhxoSqvLuw=="}]},"tlogEntries":[{"logIndex":"33351527","logId":{"keyId":"wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0="},"kindVersion":{"kind":"intoto","version":"0.0.2"},"integratedTime":"1693323623","inclusionPromise":{"signedEntryTimestamp":"MEYCIQDhWvNSLvnq5ZS3qTIgC7K2uQFeA0g8FEEjNo1UQxeubAIhALDrD1uIiUkk3tQNp/4gKT/9j8zEyyxi9Ti+qaD8q2vI"},"inclusionProof":{"logIndex":"29188096","rootHash":"fbEijQTFeiQCldZqez/u/WcrNPk4nxXI5ihofHYjFUA=","treeSize":"29188099","hashes":["z7VKeAC2d2x18Vtxt7n40GS3gtc1xfRwjjxxzpy/Trw=","/Kd8ZuCLZ7MukSwpjaSgxKFl5X2vdHWk6/qpNrkiUJo=","vvkKs7IShUI15nVb9c5olPgBnL9r4uP7+d5KzV0hSjs=","Fg4p0WJZw8Lghrpxkx1SXgzfroTeIIrEgEbfgr9IdXY=","bH8NahqE+hQ58Qxhg0V5fYusFQ1xsaQ/rK6slWVRT5k=","HplNgZ3/afEHq52zcfL2s1AKisOYDdMCWK1jOu1tGyw=","uOPuC2YDmwZe989ZN3Lgh5CKMXh9HETrSNgf0jV0WkM=","eVsvWKnEZ1+Xo3Ba15DfEiIhhmlrEaIeb+VfYmx8KhY=","uLuBRins5nkqq2rqd17R27pQTUF+xetttC6MsmlUzd0=","jRUq4D8O+FI47Wbw96s7yHCu4qzWUxpIVfxQEeprDmc=","rXEsmEJN4PEoTU8US4qVtdIsGB1MCiRlGOepoiC99kM="],"checkpoint":{"envelope":"rekor.sigstore.dev - 2605736670972794746\n29188099\nfbEijQTFeiQCldZqez/u/WcrNPk4nxXI5ihofHYjFUA=\nTimestamp: 1693323623528968756\n\n— rekor.sigstore.dev wNI9ajBEAiAK0YTbxRlhOZeeP+844Y+W7iz+hsFIF8x2NYsmuaxifAIgYUFSurlKwN7j5jCwpqSVrkbouQoYIYlyWU9Om16svmI=\n"}},"canonicalizedBody":"eyJhcGlWZXJzaW9uIjoiMC4wLjIiLCJraW5kIjoiaW50b3RvIiwic3BlYyI6eyJjb250ZW50Ijp7ImVudmVsb3BlIjp7InBheWxvYWRUeXBlIjoiYXBwbGljYXRpb24vdm5kLmluLXRvdG8ranNvbiIsInNpZ25hdHVyZXMiOlt7InB1YmxpY0tleSI6IkxTMHRMUzFDUlVkSlRpQkRSVkpVU1VaSlEwRlVSUzB0TFMwdENrMUpTVWQwUkVORFFtcDFaMEYzU1VKQlowbFZRMHBNYVhCVGREQTVTMHhHWXpCS1dXWjFSSEpUWVc0dkwweHpkME5uV1VsTGIxcEplbW93UlVGM1RYY0tUbnBGVmsxQ1RVZEJNVlZGUTJoTlRXTXliRzVqTTFKMlkyMVZkVnBIVmpKTlVqUjNTRUZaUkZaUlVVUkZlRlo2WVZka2VtUkhPWGxhVXpGd1ltNVNiQXBqYlRGc1drZHNhR1JIVlhkSWFHTk9UV3BOZDA5RVNUVk5WRlV3VFVSSmVsZG9ZMDVOYWsxM1QwUkpOVTFVVlRGTlJFbDZWMnBCUVUxR2EzZEZkMWxJQ2t0dldrbDZhakJEUVZGWlNVdHZXa2w2YWpCRVFWRmpSRkZuUVVWUVptMDJURkJZVVdWS1ZFTTRPVlZQY1dsT1YyMXVXbGxIYlZnMFZETnBURnBIYVRBS1JWWTBZbVpQYjAwNE5raDZZVGswV0hGNWRYZDRRVzlYY0VOUVpXTkdRMFZpUVdVNGJESmtaeTlsY2pOUE9VeEZSbkZQUTBKV2IzZG5aMVpYVFVFMFJ3cEJNVlZrUkhkRlFpOTNVVVZCZDBsSVowUkJWRUpuVGxaSVUxVkZSRVJCUzBKblozSkNaMFZHUWxGalJFRjZRV1JDWjA1V1NGRTBSVVpuVVZWbGNYQkRDbGhJY2pOd1kxVmhURE5GUmt0U0swdHpiWFZMVVhGdmQwaDNXVVJXVWpCcVFrSm5kMFp2UVZVek9WQndlakZaYTBWYVlqVnhUbXB3UzBaWGFYaHBORmtLV2tRNGQxbDNXVVJXVWpCU1FWRklMMEpHYTNkV05GcFdZVWhTTUdOSVRUWk1lVGx1WVZoU2IyUlhTWFZaTWpsMFRETk9jRm96VGpCaU0wcHNURE5PY0FwYU0wNHdZak5LYkV4WGNIcE1lVFZ1WVZoU2IyUlhTWFprTWpsNVlUSmFjMkl6WkhwTU0wcHNZa2RXYUdNeVZYVmxWekZ6VVVoS2JGcHVUWFpoUjFab0NscElUWFppVjBad1ltcEJOVUpuYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQUtZVWhXYVdSWVRteGpiVTUyWW01U2JHSnVVWFZaTWpsMFRVSkpSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkNTRUl4WXpKbmQwNW5XVXRMZDFsQ1FrRkhSQXAyZWtGQ1FYZFJiMDFxV210TlZGa3hUVlJOZWs5RVdtMWFiVVpvVG5wcmQxbHFSbXBOZWtwdFQxUkpNMDVVVVRCYWFrVjZUV3BLYkU1RVJUVk9SRUZXQ2tKbmIzSkNaMFZGUVZsUEwwMUJSVVZDUVdSVFdsZDRiRmxZVG14TlEwbEhRMmx6UjBGUlVVSm5OemgzUVZGVlJVWklUbkJhTTA0d1lqTktiRXd6VG5BS1dqTk9NR0l6U214TVYzQjZUVUl3UjBOcGMwZEJVVkZDWnpjNGQwRlJXVVZFTTBwc1dtNU5kbUZIVm1oYVNFMTJZbGRHY0dKcVFUZENaMjl5UW1kRlJRcEJXVTh2VFVGRlNVSkRNRTFMTW1nd1pFaENlazlwT0haa1J6bHlXbGMwZFZsWFRqQmhWemwxWTNrMWJtRllVbTlrVjBveFl6SldlVmt5T1hWa1IxWjFDbVJETldwaU1qQjNXbEZaUzB0M1dVSkNRVWRFZG5wQlFrTlJVbGhFUmxadlpFaFNkMk42YjNaTU1tUndaRWRvTVZscE5XcGlNakIyWXpKc2JtTXpVbllLWTIxVmRtTXliRzVqTTFKMlkyMVZkR0Z1VFhaTWJXUndaRWRvTVZscE9UTmlNMHB5V20xNGRtUXpUWFpqYlZaeldsZEdlbHBUTlRWaVYzaEJZMjFXYlFwamVUbHZXbGRHYTJONU9YUlpWMngxVFVSblIwTnBjMGRCVVZGQ1p6YzRkMEZSYjBWTFozZHZUV3BhYTAxVVdURk5WRTE2VDBSYWJWcHRSbWhPZW10M0NsbHFSbXBOZWtwdFQxUkpNMDVVVVRCYWFrVjZUV3BLYkU1RVJUVk9SRUZrUW1kdmNrSm5SVVZCV1U4dlRVRkZURUpCT0UxRVYyUndaRWRvTVZscE1XOEtZak5PTUZwWFVYZE9kMWxMUzNkWlFrSkJSMFIyZWtGQ1JFRlJjRVJEWkc5a1NGSjNZM3B2ZGt3eVpIQmtSMmd4V1drMWFtSXlNSFpqTW14dVl6TlNkZ3BqYlZWMll6SnNibU16VW5aamJWVjBZVzVOZDA5QldVdExkMWxDUWtGSFJIWjZRVUpFVVZGeFJFTm5lVTV0VVhoT2FsVjRUWHBOTkU1dFdtMVpWMFV6Q2s5VVFtbE5WMDE2VFcxWk5VMXFZekZPUkZKdFRWUk5lVTF0VlRCTlZHc3dUVUk0UjBOcGMwZEJVVkZDWnpjNGQwRlJORVZGVVhkUVkyMVdiV041T1c4S1dsZEdhMk41T1hSWlYyeDFUVUpyUjBOcGMwZEJVVkZDWnpjNGQwRlJPRVZEZDNkS1RrUnJNVTVVWXpCT1ZGVXhUVU56UjBOcGMwZEJVVkZDWnpjNGR3cEJVa0ZGU0ZGM1ltRklVakJqU0UwMlRIazVibUZZVW05a1YwbDFXVEk1ZEV3elRuQmFNMDR3WWpOS2JFMUNaMGREYVhOSFFWRlJRbWMzT0hkQlVrVkZDa05uZDBsT2VrVjNUMVJaZWs1VVRYZGFVVmxMUzNkWlFrSkJSMFIyZWtGQ1JXZFNXRVJHVm05a1NGSjNZM3B2ZGt3eVpIQmtSMmd4V1drMWFtSXlNSFlLWXpKc2JtTXpVblpqYlZWMll6SnNibU16VW5aamJWVjBZVzVOZGt4dFpIQmtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbU50Vm5OYVYwWjZXbE0xTlFwaVYzaEJZMjFXYldONU9XOWFWMFpyWTNrNWRGbFhiSFZOUkdkSFEybHpSMEZSVVVKbk56aDNRVkpOUlV0bmQyOU5hbHByVFZSWk1VMVVUWHBQUkZwdENscHRSbWhPZW10M1dXcEdhazE2U20xUFZFa3pUbFJSTUZwcVJYcE5ha3BzVGtSRk5VNUVRVlZDWjI5eVFtZEZSVUZaVHk5TlFVVlZRa0ZaVFVKSVFqRUtZekpuZDFkbldVdExkMWxDUWtGSFJIWjZRVUpHVVZKTlJFVndiMlJJVW5kamVtOTJUREprY0dSSGFERlphVFZxWWpJd2RtTXliRzVqTTFKMlkyMVZkZ3BqTW14dVl6TlNkbU50VlhSaGJrMTJXVmRPTUdGWE9YVmplVGw1WkZjMWVreDZXWGROVkZFd1QwUm5NazVxV1haWldGSXdXbGN4ZDJSSVRYWk5WRUZYQ2tKbmIzSkNaMFZGUVZsUEwwMUJSVmRDUVdkTlFtNUNNVmx0ZUhCWmVrTkNhV2RaUzB0M1dVSkNRVWhYWlZGSlJVRm5VamhDU0c5QlpVRkNNa0ZPTURrS1RVZHlSM2g0UlhsWmVHdGxTRXBzYms1M1MybFRiRFkwTTJwNWRDODBaVXRqYjBGMlMyVTJUMEZCUVVKcGEwaDZLM1ozUVVGQlVVUkJSV04zVWxGSlp3cGFSVzg0WXpCbFExcElSV2cwZFhwNlNucEdlamxVSzBWbVUxUk9WSFJDTWtaSlNERTRkbGh3YTA5elEwbFJSRVV4VFZSMGFUbFNiMFJ1VWs4elUwVlVDakZhYTJGa05rWnZWSGd2YXpaNmRGRmpkMGxFVUcxdVVuaFVRVXRDWjJkeGFHdHFUMUJSVVVSQmQwNXVRVVJDYTBGcVFrSXdObVp0VGxoNE5sUnZZVU1LYkVabk1tdFBlRzVtVEVkbmNuWnZVak5HTlVkcVJIUjJSRUpDT0cwNVUxZFJUbnBNTWpFeGFsbHRVeTluSzFsaVlubFZRMDFESzJGa05tcEpTeXRsWmdwbE5GaFBTV3hvVEdOWGVHVmFZa0owVFdwTFUzSlFlRzF0TkdwU00wSkdVVkZQUWxJck9ISXlOME5wYjNsb2VHOVRjWFpNZFhjOVBRb3RMUzB0TFVWT1JDQkRSVkpVU1VaSlEwRlVSUzB0TFMwdCIsInNpZyI6IlRVVlJRMGxEWVhSb2JsUkljMlJtV25GSWNUTnBXRXhxVFdVd1ZGVTViRXhaYmxJeGVtazNNM0JSZFZobU5VdElRV2xDTWpOS2FDdG5VMll4VVVWRGJrRlRSMlZ3TW1VeVRVZHVVRmhwYjFWTVZqUjJRMGxUU2tKdWEwcGFaejA5In1dfSwiaGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjFiZDg4ZTA1NGY2OGE3ZDE3MzkzNjcyYjAzZmExOGZkNjRmMGRjZDVmY2M1NDAzNWMxOWZlNjQwMWNmMmNmNWUifSwicGF5bG9hZEhhc2giOnsiYWxnb3JpdGhtIjoic2hhMjU2IiwidmFsdWUiOiI4Y2ViNGFiODEyNzczMTQ3M2E5ZWM4MTE0MGNiNjg0OWNmOGU5NzBjZGEzMmJhZWYwOTlkZjQ4YmEzMjY0NDQyIn19fX0="}],"timestampVerificationData":null},"dsseEnvelope":{"payload":"eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoicGtnOm5wbS9zaWdzdG9yZUAyLjEuMCIsImRpZ2VzdCI6eyJzaGE1MTIiOiI5MGYyMjNmOTkyZTRjODhkZDA2OGNkMmE1ZmM1N2Y5ZDJiMzA3OTgzNDNkZDZlMzhmMjljMjQwZTA0YmEwOTBlZjgzMWY4NDQ5MDg0N2M0ZTgyYjkyMzJjNzhlOGEyNTg0NjNiMWU1NWMwZjc0NjlmNzMwMjY1MDA4ZmE2NjMzZiJ9fV0sInByZWRpY2F0ZVR5cGUiOiJodHRwczovL3Nsc2EuZGV2L3Byb3ZlbmFuY2UvdjEiLCJwcmVkaWNhdGUiOnsiYnVpbGREZWZpbml0aW9uIjp7ImJ1aWxkVHlwZSI6Imh0dHBzOi8vc2xzYS1mcmFtZXdvcmsuZ2l0aHViLmlvL2dpdGh1Yi1hY3Rpb25zLWJ1aWxkdHlwZXMvd29ya2Zsb3cvdjEiLCJleHRlcm5hbFBhcmFtZXRlcnMiOnsid29ya2Zsb3ciOnsicmVmIjoicmVmcy9oZWFkcy9tYWluIiwicmVwb3NpdG9yeSI6Imh0dHBzOi8vZ2l0aHViLmNvbS9zaWdzdG9yZS9zaWdzdG9yZS1qcyIsInBhdGgiOiIuZ2l0aHViL3dvcmtmbG93cy9yZWxlYXNlLnltbCJ9fSwiaW50ZXJuYWxQYXJhbWV0ZXJzIjp7ImdpdGh1YiI6eyJldmVudF9uYW1lIjoicHVzaCIsInJlcG9zaXRvcnlfaWQiOiI0OTU1NzQ1NTUiLCJyZXBvc2l0b3J5X293bmVyX2lkIjoiNzEwOTYzNTMifX0sInJlc29sdmVkRGVwZW5kZW5jaWVzIjpbeyJ1cmkiOiJnaXQraHR0cHM6Ly9naXRodWIuY29tL3NpZ3N0b3JlL3NpZ3N0b3JlLWpzQHJlZnMvaGVhZHMvbWFpbiIsImRpZ2VzdCI6eyJnaXRDb21taXQiOiIyNmQxNjUxMzM4NmZmYWE3OTBiMWMzMmY5Mjc1NDRmMTMyMmU0MTk0In19XX0sInJ1bkRldGFpbHMiOnsiYnVpbGRlciI6eyJpZCI6Imh0dHBzOi8vZ2l0aHViLmNvbS9hY3Rpb25zL3J1bm5lci9naXRodWItaG9zdGVkIn0sIm1ldGFkYXRhIjp7Imludm9jYXRpb25JZCI6Imh0dHBzOi8vZ2l0aHViLmNvbS9zaWdzdG9yZS9zaWdzdG9yZS1qcy9hY3Rpb25zL3J1bnMvNjAxNDQ4ODY2Ni9hdHRlbXB0cy8xIn19fX0=","payloadType":"application/vnd.in-toto+json","signatures":[{"sig":"MEQCICathnTHsdfZqHq3iXLjMe0TU9lLYnR1zi73pQuXf5KHAiB23Jh+gSf1QECnASGep2e2MGnPXioULV4vCISJBnkJZg==","keyid":""}]}} diff --git a/pkg/cmd/attestation/test/data/sigstoreBundle-invalid-signature.json b/pkg/cmd/attestation/test/data/sigstoreBundle-invalid-signature.json new file mode 100644 index 000000000..b1275cebc --- /dev/null +++ b/pkg/cmd/attestation/test/data/sigstoreBundle-invalid-signature.json @@ -0,0 +1,48 @@ +{ + "mediaType": "application/vnd.dev.sigstore.bundle+json;version=0.1", + "verificationMaterial": { + "tlogEntries": [ + { + "logIndex": "6751924", + "logId": { + "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" + }, + "kindVersion": { + "kind": "intoto", + "version": "0.0.2" + }, + "integratedTime": "1667948287", + "inclusionPromise": { + "signedEntryTimestamp": "MEQCIEzguFRaGzOpMw9JJGUfqSJQ11qlzpcyVCkZfZYPwpLCAiBzdU4LnjtVKYCfyoTImFh3OLFWeOKygtS47Z8fp1GYHg==" + }, + "canonicalizedBody": "eyJhcGlWZXJzaW9uIjoiMC4wLjIiLCJraW5kIjoiaW50b3RvIiwic3BlYyI6eyJjb250ZW50Ijp7ImVudmVsb3BlIjp7InBheWxvYWRUeXBlIjoidGV4dC9wbGFpbiIsInNpZ25hdHVyZXMiOlt7InB1YmxpY0tleSI6IkxTMHRMUzFDUlVkSlRpQkRSVkpVU1VaSlEwRlVSUzB0TFMwdENrMUpTVU51ZWtORFFXbFhaMEYzU1VKQlowbFZWa2gzWldoUGRFZHVORXRUUkRGSU9GSkpOVGd4VFdaaWVXVjNkME5uV1VsTGIxcEplbW93UlVGM1RYY0tUbnBGVmsxQ1RVZEJNVlZGUTJoTlRXTXliRzVqTTFKMlkyMVZkVnBIVmpKTlVqUjNTRUZaUkZaUlVVUkZlRlo2WVZka2VtUkhPWGxhVXpGd1ltNVNiQXBqYlRGc1drZHNhR1JIVlhkSWFHTk9UV3BKZUUxVVFUUk5ha2t4VDBSQk1sZG9ZMDVOYWtsNFRWUkJORTFxVFhkUFJFRXlWMnBCUVUxR2EzZEZkMWxJQ2t0dldrbDZhakJEUVZGWlNVdHZXa2w2YWpCRVFWRmpSRkZuUVVWSFp6WklhbmgwTWxWT2FVb3hhM2QzY1RWWVVVbEpkMDFhYmtwbVZsRXpZa1l3TVhVS1drdDBaVTFrWTFZdk0zRm9RMjFYVDJWamIzaFNjWGR5WWxsVWMyaEhaemxPZVZoalFtSjJaVFo2UzNkYVZsUk1aWEZQUTBGVlVYZG5aMFpCVFVFMFJ3cEJNVlZrUkhkRlFpOTNVVVZCZDBsSVowUkJWRUpuVGxaSVUxVkZSRVJCUzBKblozSkNaMFZHUWxGalJFRjZRV1JDWjA1V1NGRTBSVVpuVVZVM1YzQlNDall3YzBOd1oyWjFNRFIzWTNOcWRrTkdlSFF3WmsxcmQwaDNXVVJXVWpCcVFrSm5kMFp2UVZVek9WQndlakZaYTBWYVlqVnhUbXB3UzBaWGFYaHBORmtLV2tRNGQwaDNXVVJXVWpCU1FWRklMMEpDVlhkRk5FVlNXVzVLY0ZsWE5VRmFSMVp2V1ZjeGJHTnBOV3BpTWpCM1RFRlpTMHQzV1VKQ1FVZEVkbnBCUWdwQlVWRmxZVWhTTUdOSVRUWk1lVGx1WVZoU2IyUlhTWFZaTWpsMFRESjRkbG95YkhWTU1qbG9aRmhTYjAxSlIwcENaMjl5UW1kRlJVRmtXalZCWjFGRENrSkljMFZsVVVJelFVaFZRVE5VTUhkaGMySklSVlJLYWtkU05HTnRWMk16UVhGS1MxaHlhbVZRU3pNdmFEUndlV2RET0hBM2J6UkJRVUZIUlZkWVkxSUtPRUZCUVVKQlRVRlNha0pGUVdsQ1VsUnlSMFUxV1RGRmJsbHVhV0ZLUWl0dWMzWTRPVlpoV1hnelVWcHFiMk5GYVc0emNqa3hkMlpyUVVsblRYTnpLd3BtYzNOMU5WTk1VV3R1TjFkRVZFdFlaMjkzTjFONFlraFpVMXBxTTNscmVFRnlWbTUxZWtWM1EyZFpTVXR2V2tsNmFqQkZRWGROUkdGQlFYZGFVVWw0Q2tGUWFsTkhaR1JNU1haNVZVMUhTV3RhSzNVMlNtaEZPWEF4VG1wME0yUkZkSGRaYTAxNFptNUZWakpyTjAxSU1VSldiWGhuT1ZCelNtcHhlV05tYVNzS1pVRkpkMFJoUzI0eVEyUlBlRXR6ZUdObldVNXBORWgyYVVWdVduRjRiV1ZFZVc4eVdVWkpkSHB3U0daSlRWRnRZMUpUYkRreFZXVlBVME00SzFCMVJ3cG5kMDFMQ2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIiwic2lnIjoiVFVWVlEwbERWV2hCVm1WM1puZExiR3MxWmxaNmNGSkVWVkJvUlhjNVR6aEpNbkI0UXpWdVZHNVFabGxFUW5OUFFXbEZRVEJhUm5Gek9UbFJaMUk1YlVGMFJrMVhkRmR5VDJwdFZVTTBOM3BuWVc5dmJFdEpiMHhJTDA5M1pFMDkifV19LCJoYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiZGNiNDkyNTljODY2MDdjMzQ2MzVkYWJiNDQzMWYwNjVlOWE3YTczNDcwNGNiNzNmMGFhMGY2YWFhMzg5NmEwNCJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjY4ZTY1NmIyNTFlNjdlODM1OGJlZjg0ODNhYjBkNTFjNjYxOWYzZTdhMWE5ZjBlNzU4MzhkNDFmZjM2OGY3MjgifX19fQ==" + } + ], + "timestampVerificationData": { + "rfc3161Timestamps": [] + }, + "x509CertificateChain": { + "certificates": [ + { + "rawBytes": "MIICnzCCAiWgAwIBAgIUVHwehOtGn4KSD1H8RI581MfbyewwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjIxMTA4MjI1ODA2WhcNMjIxMTA4MjMwODA2WjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEGg6Hjxt2UNiJ1kwwq5XQIIwMZnJfVQ3bF01uZKteMdcV/3qhCmWOecoxRqwrbYTshGg9NyXcBbve6zKwZVTLeqOCAUQwggFAMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQU7WpR60sCpgfu04wcsjvCFxt0fMkwHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wHwYDVR0RAQH/BBUwE4ERYnJpYW5AZGVoYW1lci5jb20wLAYKKwYBBAGDvzABAQQeaHR0cHM6Ly9naXRodWIuY29tL2xvZ2luL29hdXRoMIGJBgorBgEEAdZ5AgQCBHsEeQB3AHUA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGEWXcR8AAABAMARjBEAiBRTrGE5Y1EnYniaJB+nsv89VaYx3QZjocEin3r91wfkAIgMss+fssu5SLQkn7WDTKXgow7SxbHYSZj3ykxArVnuzEwCgYIKoZIzj0EAwMDaAAwZQIxAPjSGddLIvyUMGIkZ+u6JhE9p1Njt3dEtwYkMxfnEV2k7MH1BVmxg9PsJjqycfi+eAIwDaKn2CdOxKsxcgYNi4HviEnZqxmeDyo2YFItzpHfIMQmcRSl91UeOSC8+PuGgwMK" + }, + { + "rawBytes": "MIICGjCCAaGgAwIBAgIUALnViVfnU0brJasmRkHrn/UnfaQwCgYIKoZIzj0EAwMwKjEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MREwDwYDVQQDEwhzaWdzdG9yZTAeFw0yMjA0MTMyMDA2MTVaFw0zMTEwMDUxMzU2NThaMDcxFTATBgNVBAoTDHNpZ3N0b3JlLmRldjEeMBwGA1UEAxMVc2lnc3RvcmUtaW50ZXJtZWRpYXRlMHYwEAYHKoZIzj0CAQYFK4EEACIDYgAE8RVS/ysH+NOvuDZyPIZtilgUF9NlarYpAd9HP1vBBH1U5CV77LSS7s0ZiH4nE7Hv7ptS6LvvR/STk798LVgMzLlJ4HeIfF3tHSaexLcYpSASr1kS0N/RgBJz/9jWCiXno3sweTAOBgNVHQ8BAf8EBAMCAQYwEwYDVR0lBAwwCgYIKwYBBQUHAwMwEgYDVR0TAQH/BAgwBgEB/wIBADAdBgNVHQ4EFgQU39Ppz1YkEZb5qNjpKFWixi4YZD8wHwYDVR0jBBgwFoAUWMAeX5FFpWapesyQoZMi0CrFxfowCgYIKoZIzj0EAwMDZwAwZAIwPCsQK4DYiZYDPIaDi5HFKnfxXx6ASSVmERfsynYBiX2X6SJRnZU84/9DZdnFvvxmAjBOt6QpBlc4J/0DxvkTCqpclvziL6BCCPnjdlIB3Pu3BxsPmygUY7Ii2zbdCdliiow=" + }, + { + "rawBytes": "MIIB9zCCAXygAwIBAgIUALZNAPFdxHPwjeDloDwyYChAO/4wCgYIKoZIzj0EAwMwKjEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MREwDwYDVQQDEwhzaWdzdG9yZTAeFw0yMTEwMDcxMzU2NTlaFw0zMTEwMDUxMzU2NThaMCoxFTATBgNVBAoTDHNpZ3N0b3JlLmRldjERMA8GA1UEAxMIc2lnc3RvcmUwdjAQBgcqhkjOPQIBBgUrgQQAIgNiAAT7XeFT4rb3PQGwS4IajtLk3/OlnpgangaBclYpsYBr5i+4ynB07ceb3LP0OIOZdxexX69c5iVuyJRQ+Hz05yi+UF3uBWAlHpiS5sh0+H2GHE7SXrk1EC5m1Tr19L9gg92jYzBhMA4GA1UdDwEB/wQEAwIBBjAPBgNVHRMBAf8EBTADAQH/MB0GA1UdDgQWBBRYwB5fkUWlZql6zJChkyLQKsXF+jAfBgNVHSMEGDAWgBRYwB5fkUWlZql6zJChkyLQKsXF+jAKBggqhkjOPQQDAwNpADBmAjEAj1nHeXZp+13NWBNa+EDsDP8G1WWg1tCMWP/WHPqpaVo0jhsweNFZgSs0eE7wYI4qAjEA2WB9ot98sIkoF3vZYdd3/VtWB5b9TNMea7Ix/stJ5TfcLLeABLE4BNJOsQ4vnBHJ" + } + ] + } + }, + "dsseEnvelope": { + "payload": "aGVsbG8sIHdvcmxkIQ==", + "payloadType": "text/plain", + "signatures": [ + { + "sig": "NEUCICUhAVewfwKlk5fVzpRDUPhEw9O8I2pxC5nTnPfYDBsOAiEA0ZFqs99QgR9mAtFMWtWrOjmUC47zgaoolKIoLH/OwdM=", + "keyid": "" + } + ] + } +} diff --git a/pkg/cmd/attestation/test/data/trusted_root.json b/pkg/cmd/attestation/test/data/trusted_root.json new file mode 100644 index 000000000..b8706cb3e --- /dev/null +++ b/pkg/cmd/attestation/test/data/trusted_root.json @@ -0,0 +1,90 @@ +{ + "mediaType": "application/vnd.dev.sigstore.trustedroot+json;version=0.1", + "tlogs": [ + { + "baseUrl": "https://rekor.sigstore.dev", + "hashAlgorithm": "SHA2_256", + "publicKey": { + "rawBytes": "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE2G2Y+2tabdTV5BcGiBIx0a9fAFwrkBbmLSGtks4L3qX6yYY0zufBnhC8Ur/iy55GhWP/9A/bY2LhC30M9+RYtw==", + "keyDetails": "PKIX_ECDSA_P256_SHA_256", + "validFor": { + "start": "2021-01-12T11:53:27.000Z" + } + }, + "logId": { + "keyId": "wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0=" + } + } + ], + "certificateAuthorities": [ + { + "subject": { + "organization": "sigstore.dev", + "commonName": "sigstore" + }, + "uri": "https://fulcio.sigstore.dev", + "certChain": { + "certificates": [ + { + "rawBytes": "MIIB+DCCAX6gAwIBAgITNVkDZoCiofPDsy7dfm6geLbuhzAKBggqhkjOPQQDAzAqMRUwEwYDVQQKEwxzaWdzdG9yZS5kZXYxETAPBgNVBAMTCHNpZ3N0b3JlMB4XDTIxMDMwNzAzMjAyOVoXDTMxMDIyMzAzMjAyOVowKjEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MREwDwYDVQQDEwhzaWdzdG9yZTB2MBAGByqGSM49AgEGBSuBBAAiA2IABLSyA7Ii5k+pNO8ZEWY0ylemWDowOkNa3kL+GZE5Z5GWehL9/A9bRNA3RbrsZ5i0JcastaRL7Sp5fp/jD5dxqc/UdTVnlvS16an+2Yfswe/QuLolRUCrcOE2+2iA5+tzd6NmMGQwDgYDVR0PAQH/BAQDAgEGMBIGA1UdEwEB/wQIMAYBAf8CAQEwHQYDVR0OBBYEFMjFHQBBmiQpMlEk6w2uSu1KBtPsMB8GA1UdIwQYMBaAFMjFHQBBmiQpMlEk6w2uSu1KBtPsMAoGCCqGSM49BAMDA2gAMGUCMH8liWJfMui6vXXBhjDgY4MwslmN/TJxVe/83WrFomwmNf056y1X48F9c4m3a3ozXAIxAKjRay5/aj/jsKKGIkmQatjI8uupHr/+CxFvaJWmpYqNkLDGRU+9orzh5hI2RrcuaQ==" + } + ] + }, + "validFor": { + "start": "2021-03-07T03:20:29.000Z", + "end": "2022-12-31T23:59:59.999Z" + } + }, + { + "subject": { + "organization": "sigstore.dev", + "commonName": "sigstore" + }, + "uri": "https://fulcio.sigstore.dev", + "certChain": { + "certificates": [ + { + "rawBytes": "MIICGjCCAaGgAwIBAgIUALnViVfnU0brJasmRkHrn/UnfaQwCgYIKoZIzj0EAwMwKjEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MREwDwYDVQQDEwhzaWdzdG9yZTAeFw0yMjA0MTMyMDA2MTVaFw0zMTEwMDUxMzU2NThaMDcxFTATBgNVBAoTDHNpZ3N0b3JlLmRldjEeMBwGA1UEAxMVc2lnc3RvcmUtaW50ZXJtZWRpYXRlMHYwEAYHKoZIzj0CAQYFK4EEACIDYgAE8RVS/ysH+NOvuDZyPIZtilgUF9NlarYpAd9HP1vBBH1U5CV77LSS7s0ZiH4nE7Hv7ptS6LvvR/STk798LVgMzLlJ4HeIfF3tHSaexLcYpSASr1kS0N/RgBJz/9jWCiXno3sweTAOBgNVHQ8BAf8EBAMCAQYwEwYDVR0lBAwwCgYIKwYBBQUHAwMwEgYDVR0TAQH/BAgwBgEB/wIBADAdBgNVHQ4EFgQU39Ppz1YkEZb5qNjpKFWixi4YZD8wHwYDVR0jBBgwFoAUWMAeX5FFpWapesyQoZMi0CrFxfowCgYIKoZIzj0EAwMDZwAwZAIwPCsQK4DYiZYDPIaDi5HFKnfxXx6ASSVmERfsynYBiX2X6SJRnZU84/9DZdnFvvxmAjBOt6QpBlc4J/0DxvkTCqpclvziL6BCCPnjdlIB3Pu3BxsPmygUY7Ii2zbdCdliiow=" + }, + { + "rawBytes": "MIIB9zCCAXygAwIBAgIUALZNAPFdxHPwjeDloDwyYChAO/4wCgYIKoZIzj0EAwMwKjEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MREwDwYDVQQDEwhzaWdzdG9yZTAeFw0yMTEwMDcxMzU2NTlaFw0zMTEwMDUxMzU2NThaMCoxFTATBgNVBAoTDHNpZ3N0b3JlLmRldjERMA8GA1UEAxMIc2lnc3RvcmUwdjAQBgcqhkjOPQIBBgUrgQQAIgNiAAT7XeFT4rb3PQGwS4IajtLk3/OlnpgangaBclYpsYBr5i+4ynB07ceb3LP0OIOZdxexX69c5iVuyJRQ+Hz05yi+UF3uBWAlHpiS5sh0+H2GHE7SXrk1EC5m1Tr19L9gg92jYzBhMA4GA1UdDwEB/wQEAwIBBjAPBgNVHRMBAf8EBTADAQH/MB0GA1UdDgQWBBRYwB5fkUWlZql6zJChkyLQKsXF+jAfBgNVHSMEGDAWgBRYwB5fkUWlZql6zJChkyLQKsXF+jAKBggqhkjOPQQDAwNpADBmAjEAj1nHeXZp+13NWBNa+EDsDP8G1WWg1tCMWP/WHPqpaVo0jhsweNFZgSs0eE7wYI4qAjEA2WB9ot98sIkoF3vZYdd3/VtWB5b9TNMea7Ix/stJ5TfcLLeABLE4BNJOsQ4vnBHJ" + } + ] + }, + "validFor": { + "start": "2022-04-13T20:06:15.000Z" + } + } + ], + "ctlogs": [ + { + "baseUrl": "https://ctfe.sigstore.dev/test", + "hashAlgorithm": "SHA2_256", + "publicKey": { + "rawBytes": "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEbfwR+RJudXscgRBRpKX1XFDy3PyudDxz/SfnRi1fT8ekpfBd2O1uoz7jr3Z8nKzxA69EUQ+eFCFI3zeubPWU7w==", + "keyDetails": "PKIX_ECDSA_P256_SHA_256", + "validFor": { + "start": "2021-03-14T00:00:00.000Z", + "end": "2022-10-31T23:59:59.999Z" + } + }, + "logId": { + "keyId": "CGCS8ChS/2hF0dFrJ4ScRWcYrBY9wzjSbea8IgY2b3I=" + } + }, + { + "baseUrl": "https://ctfe.sigstore.dev/2022", + "hashAlgorithm": "SHA2_256", + "publicKey": { + "rawBytes": "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEiPSlFi0CmFTfEjCUqF9HuCEcYXNKAaYalIJmBZ8yyezPjTqhxrKBpMnaocVtLJBI1eM3uXnQzQGAJdJ4gs9Fyw==", + "keyDetails": "PKIX_ECDSA_P256_SHA_256", + "validFor": { + "start": "2022-10-20T00:00:00.000Z" + } + }, + "logId": { + "keyId": "3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4=" + } + } + ] +} diff --git a/pkg/cmd/attestation/test/path.go b/pkg/cmd/attestation/test/path.go new file mode 100644 index 000000000..5b6282b7d --- /dev/null +++ b/pkg/cmd/attestation/test/path.go @@ -0,0 +1,13 @@ +package test + +import ( + "runtime" + "strings" +) + +func NormalizeRelativePath(posixPath string) string { + if runtime.GOOS == "windows" { + return strings.ReplaceAll(posixPath, "/", "\\") + } + return posixPath +} diff --git a/pkg/cmd/attestation/tufrootverify/tufrootverify.go b/pkg/cmd/attestation/tufrootverify/tufrootverify.go new file mode 100644 index 000000000..b7fac9efe --- /dev/null +++ b/pkg/cmd/attestation/tufrootverify/tufrootverify.go @@ -0,0 +1,87 @@ +package tufrootverify + +import ( + "fmt" + "os" + + "github.com/cli/cli/v2/pkg/cmd/attestation/auth" + "github.com/cli/cli/v2/pkg/cmd/attestation/verification" + "github.com/cli/cli/v2/pkg/cmdutil" + + "github.com/MakeNowJust/heredoc" + "github.com/sigstore/sigstore-go/pkg/tuf" + "github.com/spf13/cobra" +) + +type tufClientInstantiator func(o *tuf.Options) (*tuf.Client, error) + +func NewTUFRootVerifyCmd(f *cmdutil.Factory, runF func() error) *cobra.Command { + var mirror string + var root string + var cmd = cobra.Command{ + Use: "tuf-root-verify --mirror --root ", + Args: cobra.ExactArgs(0), + Short: "Verify the TUF repository from a provided TUF root", + Hidden: true, + Long: heredoc.Docf(` + ### NOTE: This feature is currently in beta, and subject to change. + + Verify a TUF repository with a local TUF root. + + The command requires you provide the %[1]s--mirror%[1]s flag, which should be the URL + of the TUF repository mirror. + + The command also requires you provide the %[1]s--root%[1]s flag, which should be the + path to the TUF root file. + + GitHub relies on TUF to securely deliver the trust root for our signing authority. + For more information on TUF, see the official documentation: . + `, "`"), + Example: heredoc.Doc(` + # Verify the TUF repository from a provided TUF root + gh attestation tuf-root-verify --mirror https://tuf-repo.github.com --root /path/to/1.root.json + `), + RunE: func(cmd *cobra.Command, args []string) error { + if err := auth.IsHostSupported(); err != nil { + return err + } + + if runF != nil { + return runF() + } + + if err := tufRootVerify(tuf.New, mirror, root); err != nil { + return fmt.Errorf("Failed to verify the TUF repository: %w", err) + } + + io := f.IOStreams + fmt.Sprintln(io.Out, io.ColorScheme().Green("Successfully verified the TUF repository")) + return nil + }, + } + + cmd.Flags().StringVarP(&mirror, "mirror", "m", "", "URL to the TUF repository mirror") + cmd.MarkFlagRequired("mirror") //nolint:errcheck + cmd.Flags().StringVarP(&root, "root", "r", "", "Path to the TUF root file on disk") + cmd.MarkFlagRequired("root") //nolint:errcheck + + return &cmd +} + +func tufRootVerify(makeTUF tufClientInstantiator, mirror, root string) error { + rb, err := os.ReadFile(root) + if err != nil { + return fmt.Errorf("failed to read root file %s: %v", root, err) + } + opts := verification.GitHubTUFOptions() + opts.Root = rb + opts.RepositoryBaseURL = mirror + // The purpose is the verify the TUF root and repository, make + // sure there is no caching enabled + opts.CacheValidity = 0 + if _, err = makeTUF(opts); err != nil { + return fmt.Errorf("failed to create TUF client: %v", err) + } + + return nil +} diff --git a/pkg/cmd/attestation/tufrootverify/tufrootverify_test.go b/pkg/cmd/attestation/tufrootverify/tufrootverify_test.go new file mode 100644 index 000000000..fb4d90cdb --- /dev/null +++ b/pkg/cmd/attestation/tufrootverify/tufrootverify_test.go @@ -0,0 +1,96 @@ +package tufrootverify + +import ( + "bytes" + "fmt" + "strings" + "testing" + + "github.com/cli/cli/v2/pkg/cmd/attestation/test" + "github.com/cli/cli/v2/pkg/cmdutil" + "github.com/cli/cli/v2/pkg/iostreams" + "github.com/sigstore/sigstore-go/pkg/tuf" + + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" +) + +func TestNewTUFRootVerifyCmd(t *testing.T) { + testIO, _, _, _ := iostreams.Test() + f := &cmdutil.Factory{ + IOStreams: testIO, + } + + testcases := []struct { + name string + cli string + wantsErr bool + }{ + { + name: "Missing mirror flag", + cli: "--root ../verification/embed/tuf-repo.github.com/root.json", + wantsErr: true, + }, + { + name: "Missing root flag", + cli: "--mirror https://tuf-repo.github.com", + wantsErr: true, + }, + { + name: "Has all required flags", + cli: "--mirror https://tuf-repo.github.com --root ../verification/embed/tuf-repo.github.com/root.json", + wantsErr: false, + }, + } + + for _, tc := range testcases { + t.Run(tc.name, func(t *testing.T) { + cmd := NewTUFRootVerifyCmd(f, func() error { + return nil + }) + + argv := strings.Split(tc.cli, " ") + cmd.SetArgs(argv) + cmd.SetIn(&bytes.Buffer{}) + cmd.SetOut(&bytes.Buffer{}) + cmd.SetErr(&bytes.Buffer{}) + _, err := cmd.ExecuteC() + if tc.wantsErr { + assert.Error(t, err) + return + } + assert.NoError(t, err) + }) + } +} + +var newTUFMockClient tufClientInstantiator = func(o *tuf.Options) (*tuf.Client, error) { + return &tuf.Client{}, nil +} + +var newTUFErrClient tufClientInstantiator = func(o *tuf.Options) (*tuf.Client, error) { + return nil, fmt.Errorf("failed to create TUF client") +} + +func TestTUFRootVerify(t *testing.T) { + mirror := "https://tuf-repo.github.com" + root := test.NormalizeRelativePath("../verification/embed/tuf-repo.github.com/root.json") + + t.Run("successfully verifies TUF root", func(t *testing.T) { + err := tufRootVerify(newTUFMockClient, mirror, root) + require.NoError(t, err) + }) + + t.Run("fails because the root cannot be found", func(t *testing.T) { + notFoundRoot := test.NormalizeRelativePath("./does/not/exist/root.json") + err := tufRootVerify(newTUFMockClient, mirror, notFoundRoot) + require.Error(t, err) + require.ErrorContains(t, err, "failed to read root file") + }) + + t.Run("failed to create TUF root", func(t *testing.T) { + err := tufRootVerify(newTUFErrClient, mirror, root) + require.Error(t, err) + require.ErrorContains(t, err, "failed to create TUF client") + }) +} diff --git a/pkg/cmd/attestation/verification/attestation.go b/pkg/cmd/attestation/verification/attestation.go new file mode 100644 index 000000000..0b6499ece --- /dev/null +++ b/pkg/cmd/attestation/verification/attestation.go @@ -0,0 +1,144 @@ +package verification + +import ( + "bufio" + "encoding/json" + "errors" + "fmt" + "os" + "path/filepath" + + "github.com/cli/cli/v2/pkg/cmd/attestation/api" + protobundle "github.com/sigstore/protobuf-specs/gen/pb-go/bundle/v1" + "github.com/sigstore/sigstore-go/pkg/bundle" +) + +var ErrUnrecognisedBundleExtension = errors.New("bundle file extension not supported, must be json or jsonl") + +type FetchAttestationsConfig struct { + APIClient api.Client + BundlePath string + Digest string + Limit int + Owner string + Repo string +} + +func (c *FetchAttestationsConfig) IsBundleProvided() bool { + return c.BundlePath != "" +} + +func GetAttestations(c FetchAttestationsConfig) ([]*api.Attestation, error) { + if c.IsBundleProvided() { + return GetLocalAttestations(c.BundlePath) + } + return GetRemoteAttestations(c) +} + +// GetLocalAttestations returns a slice of attestations read from a local bundle file. +func GetLocalAttestations(path string) ([]*api.Attestation, error) { + fileExt := filepath.Ext(path) + switch fileExt { + case ".json": + attestations, err := loadBundleFromJSONFile(path) + if err != nil { + return nil, fmt.Errorf("bundle could not be loaded from JSON file: %v", err) + } + return attestations, nil + case ".jsonl": + attestations, err := loadBundlesFromJSONLinesFile(path) + if err != nil { + return nil, fmt.Errorf("bundles could not be loaded from JSON lines file: %v", err) + } + return attestations, nil + } + return nil, ErrUnrecognisedBundleExtension +} + +func loadBundleFromJSONFile(path string) ([]*api.Attestation, error) { + localAttestation, err := bundle.LoadJSONFromPath(path) + if err != nil { + return nil, err + } + + return []*api.Attestation{{Bundle: localAttestation}}, nil +} + +func loadBundlesFromJSONLinesFile(path string) ([]*api.Attestation, error) { + file, err := os.Open(path) + if err != nil { + return nil, fmt.Errorf("could not open file: %v", err) + } + defer file.Close() + + attestations := []*api.Attestation{} + + scanner := bufio.NewScanner(file) + for scanner.Scan() { + b := scanner.Bytes() + var bundle bundle.ProtobufBundle + bundle.Bundle = new(protobundle.Bundle) + err = bundle.UnmarshalJSON(b) + if err != nil { + return nil, fmt.Errorf("failed to unmarshal bundle from JSON: %v", err) + } + a := api.Attestation{Bundle: &bundle} + attestations = append(attestations, &a) + } + + if err := scanner.Err(); err != nil { + return nil, err + } + + return attestations, nil +} + +func GetRemoteAttestations(c FetchAttestationsConfig) ([]*api.Attestation, error) { + if c.APIClient == nil { + return nil, fmt.Errorf("api client must be provided") + } + // check if Repo is set first because if Repo has been set, Owner will be set using the value of Repo. + // If Repo is not set, the field will remain empty. It will not be populated using the value of Owner. + if c.Repo != "" { + attestations, err := c.APIClient.GetByRepoAndDigest(c.Repo, c.Digest, c.Limit) + if err != nil { + return nil, fmt.Errorf("failed to fetch attestations from %s: %w", c.Repo, err) + } + return attestations, nil + } else if c.Owner != "" { + attestations, err := c.APIClient.GetByOwnerAndDigest(c.Owner, c.Digest, c.Limit) + if err != nil { + return nil, fmt.Errorf("failed to fetch attestations from %s: %w", c.Owner, err) + } + return attestations, nil + } + return nil, fmt.Errorf("owner or repo must be provided") +} + +type IntotoStatement struct { + PredicateType string `json:"predicateType"` +} + +func FilterAttestations(predicateType string, attestations []*api.Attestation) []*api.Attestation { + filteredAttestations := []*api.Attestation{} + + for _, each := range attestations { + dsseEnvelope := each.Bundle.GetDsseEnvelope() + if dsseEnvelope != nil { + if dsseEnvelope.PayloadType != "application/vnd.in-toto+json" { + // Don't fail just because an entry isn't intoto + continue + } + var intotoStatement IntotoStatement + if err := json.Unmarshal([]byte(dsseEnvelope.Payload), &intotoStatement); err != nil { + // Don't fail just because a single entry can't be unmarshalled + continue + } + if intotoStatement.PredicateType == predicateType { + filteredAttestations = append(filteredAttestations, each) + } + } + } + + return filteredAttestations +} diff --git a/pkg/cmd/attestation/verification/attestation_test.go b/pkg/cmd/attestation/verification/attestation_test.go new file mode 100644 index 000000000..87a91cea9 --- /dev/null +++ b/pkg/cmd/attestation/verification/attestation_test.go @@ -0,0 +1,102 @@ +package verification + +import ( + "testing" + + protobundle "github.com/sigstore/protobuf-specs/gen/pb-go/bundle/v1" + dsse "github.com/sigstore/protobuf-specs/gen/pb-go/dsse" + "github.com/sigstore/sigstore-go/pkg/bundle" + "github.com/stretchr/testify/require" + + "github.com/cli/cli/v2/pkg/cmd/attestation/api" +) + +func TestLoadBundlesFromJSONLinesFile(t *testing.T) { + path := "../test/data/sigstore-js-2.1.0_with_2_bundles.jsonl" + attestations, err := loadBundlesFromJSONLinesFile(path) + + require.NoError(t, err) + require.Len(t, attestations, 2) +} + +func TestLoadBundleFromJSONFile(t *testing.T) { + path := "../test/data/sigstore-js-2.1.0-bundle.json" + attestations, err := loadBundleFromJSONFile(path) + + require.NoError(t, err) + require.Len(t, attestations, 1) +} + +func TestGetLocalAttestations(t *testing.T) { + t.Run("with JSON file containing one bundle", func(t *testing.T) { + path := "../test/data/sigstore-js-2.1.0-bundle.json" + attestations, err := GetLocalAttestations(path) + + require.NoError(t, err) + require.Len(t, attestations, 1) + }) + + t.Run("with JSON lines file containing multiple bundles", func(t *testing.T) { + path := "../test/data/sigstore-js-2.1.0_with_2_bundles.jsonl" + attestations, err := GetLocalAttestations(path) + + require.NoError(t, err) + require.Len(t, attestations, 2) + }) + + t.Run("with file with unrecognized extension", func(t *testing.T) { + path := "../test/data/sigstore-js-2.1.0-bundles.tgz" + attestations, err := GetLocalAttestations(path) + + require.ErrorIs(t, err, ErrUnrecognisedBundleExtension) + require.Nil(t, attestations) + }) +} + +func TestFilterAttestations(t *testing.T) { + attestations := []*api.Attestation{ + { + Bundle: &bundle.ProtobufBundle{ + Bundle: &protobundle.Bundle{ + Content: &protobundle.Bundle_DsseEnvelope{ + DsseEnvelope: &dsse.Envelope{ + PayloadType: "application/vnd.in-toto+json", + Payload: []byte("{\"predicateType\": \"https://slsa.dev/provenance/v1\"}"), + }, + }, + }, + }, + }, + { + Bundle: &bundle.ProtobufBundle{ + Bundle: &protobundle.Bundle{ + Content: &protobundle.Bundle_DsseEnvelope{ + DsseEnvelope: &dsse.Envelope{ + PayloadType: "application/vnd.something-other-than-in-toto+json", + Payload: []byte("{\"predicateType\": \"https://slsa.dev/provenance/v1\"}"), + }, + }, + }, + }, + }, + { + Bundle: &bundle.ProtobufBundle{ + Bundle: &protobundle.Bundle{ + Content: &protobundle.Bundle_DsseEnvelope{ + DsseEnvelope: &dsse.Envelope{ + PayloadType: "application/vnd.in-toto+json", + Payload: []byte("{\"predicateType\": \"https://spdx.dev/Document/v2.3\"}"), + }, + }, + }, + }, + }, + } + + filtered := FilterAttestations("https://slsa.dev/provenance/v1", attestations) + + require.Len(t, filtered, 1) + + filtered = FilterAttestations("NonExistentPredicate", attestations) + require.Len(t, filtered, 0) +} diff --git a/pkg/cmd/attestation/verification/embed/tuf-repo.github.com/root.json b/pkg/cmd/attestation/verification/embed/tuf-repo.github.com/root.json new file mode 100644 index 000000000..2990a2665 --- /dev/null +++ b/pkg/cmd/attestation/verification/embed/tuf-repo.github.com/root.json @@ -0,0 +1,163 @@ +{ + "signatures": [ + { + "keyid": "a10513a5ab61acd0c6b6fbe0504856ead18f3b17c4fabbe3fa848c79a5a187cf", + "sig": "304402203c8f5f7443f7052923e82f9ca0b1bb61a33498444076a2f43e1285a47f6e562d022014de99a7e5413440896b6804944e3c49390cfe6e617211b8dc42a8e67675bc13" + }, + { + "keyid": "d6a89e23fb22801a0d1186bf1bdd007e228f65a8aa9964d24d06cb5fbb0ce91c", + "sig": "3044022009a20307f974af7e05cc9564eea497f45062e3b21272d1062713b3d22c868298022059d032ad973a28bdbd03959cf96b21398b6b6e2ca618c17ce6c13712246343a2" + }, + { + "keyid": "539dde44014c850fe6eeb8b299eb7dae2e1f4bf83454b949e98aa73542cdc65a", + "sig": "3045022100edd270d36d0c8468b9a1f2ef1c81a270c72ffd50c65bca0ed1ebd424df09f64b022002b27ffafd7bc5bdfc25281b5b9b597cf2d67d4eeb4af2ff45eb3e666b860c21" + }, + { + "keyid": "88737ccdac7b49cc237e9aaead81be2a40278b886a693d8149a19cf543f093d3", + "sig": "30460221008d7d95434e576d5876b2db30fd645505ca546618bbc7a8e4b39f64e6a36df9ad022100c00a5294e4ddd02d48d28918b87a06bdfdeccd0618ecdcec29bb2597a05fe474" + }, + { + "keyid": "5e01c9a0b2641a8965a4a74e7df0bc7b2d8278a2c3ca0cf7a3f2f783d3c69800", + "sig": "30450220215fb3d19d94560a3a2a6067a71c92daf867d13700c9500c4c32d8009a48a634022100df9fb6cee786313bf6c363daac4de39b3dd531f211f81d2391c41bd2d0f91a80" + }, + { + "keyid": "4f4d1dd75f2d7f3860e3a068d7bed90dec5f0faafcbe1ace7fb7d95d29e07228", + "sig": "304502204091ac5e61b6462d262ecc8442781dd09843bed39942a95a4884c8c6a2c212ef022100dcee86392748f48950d04d539ac1a6643ed1f0b4bd6856f8aeb5a135826c846f" + }, + { + "keyid": "eb8eff37f93af2faaba519f341decec3cecd3eeafcace32966db9723842c8a62", + "sig": "30460221009188548601a43b501223caeefca4876ae892e18a85c885004b4c8aeeb05a4421022100abdcc72d94597f8297d6297897ff96f285168dbe6b3d57f846dbc7a2948d2935" + }, + { + "keyid": "8b498a80a1b7af188c10c9abdf6aade81d14faaffcde2abcd6063baa673ebd12", + "sig": "3046022100b440561545d48759dc4140cda9f8af7c9405a101d6136dd0a26edd6562b7064f022100cafa917ed90350494e47d226b64a8ec63ef5ceebb8ba4d2dec2ce018e4ad402a" + } + ], + "signed": { + "_type": "root", + "consistent_snapshot": true, + "expires": "2024-06-23T08:29:18Z", + "keys": { + "4f4d1dd75f2d7f3860e3a068d7bed90dec5f0faafcbe1ace7fb7d95d29e07228": { + "keytype": "ecdsa", + "keyval": { + "public": "-----BEGIN PUBLIC KEY-----\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAENki7aZVips5SgRzCd/Om0CGzQKY/\nnv84giqVDmdwb2ys82Z6soFLasvYYEEQcwqaC170n9gr93wHUgPc796uJA==\n-----END PUBLIC KEY-----\n" + }, + "scheme": "ecdsa-sha2-nistp256", + "x-tuf-on-ci-keyowner": "@ashtom" + }, + "539dde44014c850fe6eeb8b299eb7dae2e1f4bf83454b949e98aa73542cdc65a": { + "keytype": "ecdsa", + "keyval": { + "public": "-----BEGIN PUBLIC KEY-----\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAElD0o2sOZN9n3RKQ7PtMLAoXj+2Ai\nn4PKT/pfnzDlNLrD3VTQwCc4sR4t+OLu4KQ+qk+kXkR9YuBsu3bdJZ1OWw==\n-----END PUBLIC KEY-----\n" + }, + "scheme": "ecdsa-sha2-nistp256", + "x-tuf-on-ci-keyowner": "@nerdneha" + }, + "5e01c9a0b2641a8965a4a74e7df0bc7b2d8278a2c3ca0cf7a3f2f783d3c69800": { + "keytype": "ecdsa", + "keyval": { + "public": "-----BEGIN PUBLIC KEY-----\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEC9RNAsuDCNO6T7qA7Y5F8orw2tIW\nr7rUr4ffxvzTMrbkVtjR/trtE0q0+T0zQ8TWLyI6EYMwb947ej2ItfkOyA==\n-----END PUBLIC KEY-----\n" + }, + "scheme": "ecdsa-sha2-nistp256", + "x-tuf-on-ci-keyowner": "@jacobdepriest" + }, + "88737ccdac7b49cc237e9aaead81be2a40278b886a693d8149a19cf543f093d3": { + "keytype": "ecdsa", + "keyval": { + "public": "-----BEGIN PUBLIC KEY-----\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEBagkskNOpOTbetTX5CdnvMy+LiWn\nonRrNrqAHL4WgiebH7Uig7GLhC3bkeA/qgb926/vr9qhOPG9Buj2HatrPw==\n-----END PUBLIC KEY-----\n" + }, + "scheme": "ecdsa-sha2-nistp256", + "x-tuf-on-ci-keyowner": "@gregose" + }, + "8b498a80a1b7af188c10c9abdf6aade81d14faaffcde2abcd6063baa673ebd12": { + "keytype": "ecdsa", + "keyval": { + "public": "-----BEGIN PUBLIC KEY-----\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE7IEoVNwrprchXGhT5sAhSax7SOd3\n8duuISghCzfmHdKJWSbV2wJRamRiUVRtmA83K/qm5cT20WXMCT5QeM/D3A==\n-----END PUBLIC KEY-----\n" + }, + "scheme": "ecdsa-sha2-nistp256", + "x-tuf-on-ci-keyowner": "@trevrosen" + }, + "a10513a5ab61acd0c6b6fbe0504856ead18f3b17c4fabbe3fa848c79a5a187cf": { + "keytype": "ecdsa", + "keyval": { + "public": "-----BEGIN PUBLIC KEY-----\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEC2wJ3xscyXxBLybJ9FVjwkyQMe53\nRHUz77AjMO8MzVaT8xw6ZvJqdNZiytYtigWULlINxw6frNsWJKb/f7lC8A==\n-----END PUBLIC KEY-----\n" + }, + "scheme": "ecdsa-sha2-nistp256", + "x-tuf-on-ci-keyowner": "@kommendorkapten" + }, + "d6a89e23fb22801a0d1186bf1bdd007e228f65a8aa9964d24d06cb5fbb0ce91c": { + "keytype": "ecdsa", + "keyval": { + "public": "-----BEGIN PUBLIC KEY-----\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEDdORwcruW3gqAgaLjH/nNdGMB4kQ\nAvA+wD6DyO4P/wR8ee2ce83NZHq1ZADKhve0rlYKaKy3CqyQ5SmlZ36Zhw==\n-----END PUBLIC KEY-----\n" + }, + "scheme": "ecdsa-sha2-nistp256", + "x-tuf-on-ci-keyowner": "@krukow" + }, + "eb8eff37f93af2faaba519f341decec3cecd3eeafcace32966db9723842c8a62": { + "keytype": "ecdsa", + "keyval": { + "public": "-----BEGIN PUBLIC KEY-----\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAENynVdQnM9h7xU71G7PiJpQaDemub\nkbjsjYwLlPJTQVuxQO8WeIpJf8MEh5rf01t2dDIuCsZ5gRx+QvDv0UzfsA==\n-----END PUBLIC KEY-----\n" + }, + "scheme": "ecdsa-sha2-nistp256", + "x-tuf-on-ci-keyowner": "@mph4" + }, + "eb9799b483affac9da87ef4c9ea467928415c961349e607e5e6e485679b07f8f": { + "keytype": "ecdsa", + "keyval": { + "public": "-----BEGIN PUBLIC KEY-----\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAENKNcNcX+d73lS1TRFb9Vnp8JvOoh\nzYQ+in43iGenbG8RGo9L/6FJ2hoRbVU6xskvyuErcdPbCdI4GxrQ5i8hkw==\n-----END PUBLIC KEY-----\n" + }, + "scheme": "ecdsa-sha2-nistp256", + "x-tuf-on-ci-online-uri": "azurekms://production-tuf-root.vault.azure.net/keys/Online-Key/aaf375fd8ed24acb949a5cc173700b05" + } + }, + "roles": { + "root": { + "keyids": [ + "a10513a5ab61acd0c6b6fbe0504856ead18f3b17c4fabbe3fa848c79a5a187cf", + "4f4d1dd75f2d7f3860e3a068d7bed90dec5f0faafcbe1ace7fb7d95d29e07228", + "88737ccdac7b49cc237e9aaead81be2a40278b886a693d8149a19cf543f093d3", + "5e01c9a0b2641a8965a4a74e7df0bc7b2d8278a2c3ca0cf7a3f2f783d3c69800", + "d6a89e23fb22801a0d1186bf1bdd007e228f65a8aa9964d24d06cb5fbb0ce91c", + "eb8eff37f93af2faaba519f341decec3cecd3eeafcace32966db9723842c8a62", + "8b498a80a1b7af188c10c9abdf6aade81d14faaffcde2abcd6063baa673ebd12", + "539dde44014c850fe6eeb8b299eb7dae2e1f4bf83454b949e98aa73542cdc65a" + ], + "threshold": 3 + }, + "snapshot": { + "keyids": [ + "eb9799b483affac9da87ef4c9ea467928415c961349e607e5e6e485679b07f8f" + ], + "threshold": 1, + "x-tuf-on-ci-expiry-period": 21, + "x-tuf-on-ci-signing-period": 7 + }, + "targets": { + "keyids": [ + "a10513a5ab61acd0c6b6fbe0504856ead18f3b17c4fabbe3fa848c79a5a187cf", + "4f4d1dd75f2d7f3860e3a068d7bed90dec5f0faafcbe1ace7fb7d95d29e07228", + "88737ccdac7b49cc237e9aaead81be2a40278b886a693d8149a19cf543f093d3", + "5e01c9a0b2641a8965a4a74e7df0bc7b2d8278a2c3ca0cf7a3f2f783d3c69800", + "d6a89e23fb22801a0d1186bf1bdd007e228f65a8aa9964d24d06cb5fbb0ce91c", + "eb8eff37f93af2faaba519f341decec3cecd3eeafcace32966db9723842c8a62", + "8b498a80a1b7af188c10c9abdf6aade81d14faaffcde2abcd6063baa673ebd12", + "539dde44014c850fe6eeb8b299eb7dae2e1f4bf83454b949e98aa73542cdc65a" + ], + "threshold": 3 + }, + "timestamp": { + "keyids": [ + "eb9799b483affac9da87ef4c9ea467928415c961349e607e5e6e485679b07f8f" + ], + "threshold": 1, + "x-tuf-on-ci-expiry-period": 7, + "x-tuf-on-ci-signing-period": 6 + } + }, + "spec_version": "1.0.31", + "version": 1, + "x-tuf-on-ci-expiry-period": 240, + "x-tuf-on-ci-signing-period": 60 + } +} diff --git a/pkg/cmd/attestation/verification/mock_verifier.go b/pkg/cmd/attestation/verification/mock_verifier.go new file mode 100644 index 000000000..a8579b578 --- /dev/null +++ b/pkg/cmd/attestation/verification/mock_verifier.go @@ -0,0 +1,58 @@ +package verification + +import ( + "fmt" + "testing" + + "github.com/cli/cli/v2/pkg/cmd/attestation/api" + "github.com/cli/cli/v2/pkg/cmd/attestation/test/data" + "github.com/sigstore/sigstore-go/pkg/fulcio/certificate" + + "github.com/in-toto/in-toto-golang/in_toto" + "github.com/sigstore/sigstore-go/pkg/verify" +) + +const SLSAPredicateType = "https://slsa.dev/provenance/v1" + +type MockSigstoreVerifier struct { + t *testing.T +} + +func (v *MockSigstoreVerifier) Verify(attestations []*api.Attestation, policy verify.PolicyBuilder) *SigstoreResults { + statement := &in_toto.Statement{} + statement.PredicateType = SLSAPredicateType + + result := AttestationProcessingResult{ + Attestation: &api.Attestation{ + Bundle: data.SigstoreBundle(v.t), + }, + VerificationResult: &verify.VerificationResult{ + Statement: statement, + Signature: &verify.SignatureVerificationResult{ + Certificate: &certificate.Summary{ + Extensions: certificate.Extensions{ + BuildSignerURI: "https://github.com/github/example/.github/workflows/release.yml@refs/heads/main", + }, + }, + }, + }, + } + + results := []*AttestationProcessingResult{&result} + + return &SigstoreResults{ + VerifyResults: results, + } +} + +func NewMockSigstoreVerifier(t *testing.T) *MockSigstoreVerifier { + return &MockSigstoreVerifier{t} +} + +type FailSigstoreVerifier struct{} + +func (v *FailSigstoreVerifier) Verify(attestations []*api.Attestation, policy verify.PolicyBuilder) *SigstoreResults { + return &SigstoreResults{ + Error: fmt.Errorf("failed to verify attestations"), + } +} diff --git a/pkg/cmd/attestation/verification/policy.go b/pkg/cmd/attestation/verification/policy.go new file mode 100644 index 000000000..91b54c75e --- /dev/null +++ b/pkg/cmd/attestation/verification/policy.go @@ -0,0 +1,20 @@ +package verification + +import ( + "encoding/hex" + + "github.com/cli/cli/v2/pkg/cmd/attestation/artifact" + + "github.com/sigstore/sigstore-go/pkg/verify" +) + +// BuildDigestPolicyOption builds a verify.ArtifactPolicyOption +// from the given artifact digest and digest algorithm +func BuildDigestPolicyOption(a artifact.DigestedArtifact) (verify.ArtifactPolicyOption, error) { + // sigstore-go expects the artifact digest to be decoded from hex + decoded, err := hex.DecodeString(a.Digest()) + if err != nil { + return nil, err + } + return verify.WithArtifactDigest(a.Algorithm(), decoded), nil +} diff --git a/pkg/cmd/attestation/verification/sigstore.go b/pkg/cmd/attestation/verification/sigstore.go new file mode 100644 index 000000000..a55f4510d --- /dev/null +++ b/pkg/cmd/attestation/verification/sigstore.go @@ -0,0 +1,208 @@ +package verification + +import ( + "fmt" + + "github.com/cli/cli/v2/pkg/cmd/attestation/api" + "github.com/cli/cli/v2/pkg/cmd/attestation/io" + + "github.com/sigstore/sigstore-go/pkg/bundle" + "github.com/sigstore/sigstore-go/pkg/root" + "github.com/sigstore/sigstore-go/pkg/tuf" + "github.com/sigstore/sigstore-go/pkg/verify" +) + +const ( + PublicGoodIssuerOrg = "sigstore.dev" + GitHubIssuerOrg = "GitHub, Inc." +) + +// AttestationProcessingResult captures processing a given attestation's signature verification and policy evaluation +type AttestationProcessingResult struct { + Attestation *api.Attestation `json:"attestation"` + VerificationResult *verify.VerificationResult `json:"verificationResult"` +} + +type SigstoreResults struct { + VerifyResults []*AttestationProcessingResult + Error error +} + +type SigstoreConfig struct { + CustomTrustedRoot string + Logger *io.Handler + NoPublicGood bool +} + +type SigstoreVerifier interface { + Verify(attestations []*api.Attestation, policy verify.PolicyBuilder) *SigstoreResults +} + +type LiveSigstoreVerifier struct { + config SigstoreConfig +} + +// NewLiveSigstoreVerifier creates a new LiveSigstoreVerifier struct +// that is used to verify artifacts and attestations against the +// Public Good, GitHub, or a custom trusted root. +func NewLiveSigstoreVerifier(config SigstoreConfig) *LiveSigstoreVerifier { + return &LiveSigstoreVerifier{ + config: config, + } +} + +func (v *LiveSigstoreVerifier) chooseVerifier(b *bundle.ProtobufBundle) (*verify.SignedEntityVerifier, string, error) { + verifyContent, err := b.VerificationContent() + if err != nil { + return nil, "", fmt.Errorf("failed to get bundle verification content: %v", err) + } + leafCert, ok := verifyContent.HasCertificate() + if !ok { + return nil, "", fmt.Errorf("leaf cert not found") + } + if len(leafCert.Issuer.Organization) != 1 { + return nil, "", fmt.Errorf("expected the leaf certificate issuer to only have one organization") + } + issuer := leafCert.Issuer.Organization[0] + + // if user provided a custom trusted root file path, use the custom verifier + if v.config.CustomTrustedRoot != "" { + customVerifier, err := newCustomVerifier(v.config.CustomTrustedRoot) + if err != nil { + return nil, "", fmt.Errorf("failed to create custom verifier: %v", err) + } + return customVerifier, issuer, nil + } + + if leafCert.Issuer.Organization[0] == PublicGoodIssuerOrg && !v.config.NoPublicGood { + publicGoodVerifier, err := newPublicGoodVerifier() + if err != nil { + return nil, "", fmt.Errorf("failed to create Public Good Sigstore verifier: %v", err) + } + + return publicGoodVerifier, issuer, nil + } else if leafCert.Issuer.Organization[0] == GitHubIssuerOrg || v.config.NoPublicGood { + ghVerifier, err := newGitHubVerifier() + if err != nil { + return nil, "", fmt.Errorf("failed to create GitHub Sigstore verifier: %v", err) + } + + return ghVerifier, issuer, nil + } + + return nil, "", fmt.Errorf("leaf certificate issuer is not recognized") +} + +func (v *LiveSigstoreVerifier) Verify(attestations []*api.Attestation, policy verify.PolicyBuilder) *SigstoreResults { + // initialize the processing results before attempting to verify + // with multiple verifiers + results := make([]*AttestationProcessingResult, len(attestations)) + for i, att := range attestations { + apr := &AttestationProcessingResult{ + Attestation: att, + } + results[i] = apr + } + + totalAttestations := len(attestations) + for i, apr := range results { + v.config.Logger.VerbosePrintf("Verifying attestation %d/%d against the configured Sigstore trust roots\n", i+1, totalAttestations) + + // determine which verifier should attempt verification against the bundle + verifier, issuer, err := v.chooseVerifier(apr.Attestation.Bundle) + if err != nil { + return &SigstoreResults{ + Error: fmt.Errorf("failed to find recognized issuer from bundle content: %v", err), + } + } + + v.config.Logger.VerbosePrintf("Attempting verification against issuer \"%s\"\n", issuer) + // attempt to verify the attestation + result, err := verifier.Verify(apr.Attestation.Bundle, policy) + // if verification fails, create the error and exit verification early + if err != nil { + v.config.Logger.VerbosePrint(v.config.Logger.ColorScheme.Redf( + "Failed to verify against issuer \"%s\" \n\n", issuer, + )) + + return &SigstoreResults{ + Error: fmt.Errorf("verifying with issuer \"%s\": %v", issuer, err), + } + } + + // if verification is successful, add the result + // to the AttestationProcessingResult entry + v.config.Logger.VerbosePrint(v.config.Logger.ColorScheme.Greenf( + "SUCCESS - attestation signature verified with \"%s\"\n", issuer, + )) + apr.VerificationResult = result + } + + return &SigstoreResults{ + VerifyResults: results, + } +} + +func newCustomVerifier(trustedRootFilePath string) (*verify.SignedEntityVerifier, error) { + trustedRoot, err := root.NewTrustedRootFromPath(trustedRootFilePath) + if err != nil { + return nil, fmt.Errorf("failed to create trusted root from file %s: %v", trustedRootFilePath, err) + } + + verifierConfig := []verify.VerifierOption{} + verifierConfig = append(verifierConfig, verify.WithSignedCertificateTimestamps(1)) + verifierConfig = append(verifierConfig, verify.WithObserverTimestamps(1)) + + // Infer verification options from contents of trusted root + if len(trustedRoot.TimestampingAuthorities()) > 0 { + verifierConfig = append(verifierConfig, verify.WithSignedTimestamps(1)) + } + + if len(trustedRoot.RekorLogs()) > 0 { + verifierConfig = append(verifierConfig, verify.WithTransparencyLog(1)) + } + + gv, err := verify.NewSignedEntityVerifier(trustedRoot, verifierConfig...) + if err != nil { + return nil, fmt.Errorf("failed to create custom verifier: %v", err) + } + + return gv, nil +} + +func newGitHubVerifier() (*verify.SignedEntityVerifier, error) { + opts := GitHubTUFOptions() + client, err := tuf.New(opts) + if err != nil { + return nil, fmt.Errorf("failed to create TUF client: %v", err) + } + trustedRoot, err := root.GetTrustedRoot(client) + if err != nil { + return nil, err + } + gv, err := verify.NewSignedEntityVerifier(trustedRoot, verify.WithSignedTimestamps(1)) + if err != nil { + return nil, fmt.Errorf("failed to create GitHub verifier: %v", err) + } + + return gv, nil +} + +func newPublicGoodVerifier() (*verify.SignedEntityVerifier, error) { + opts := DefaultOptionsWithCacheSetting() + client, err := tuf.New(opts) + if err != nil { + return nil, fmt.Errorf("failed to create TUF client: %v", err) + } + trustedRoot, err := root.GetTrustedRoot(client) + if err != nil { + return nil, fmt.Errorf("failed to get trusted root: %v", err) + } + + sv, err := verify.NewSignedEntityVerifier(trustedRoot, verify.WithSignedCertificateTimestamps(1), verify.WithTransparencyLog(1), verify.WithObserverTimestamps(1)) + if err != nil { + return nil, fmt.Errorf("failed to create Public Good verifier: %v", err) + } + + return sv, nil +} diff --git a/pkg/cmd/attestation/verification/sigstore_integration_test.go b/pkg/cmd/attestation/verification/sigstore_integration_test.go new file mode 100644 index 000000000..aa6dd3e74 --- /dev/null +++ b/pkg/cmd/attestation/verification/sigstore_integration_test.go @@ -0,0 +1,131 @@ +//go:build integration + +package verification + +import ( + "testing" + + "github.com/cli/cli/v2/pkg/cmd/attestation/api" + "github.com/cli/cli/v2/pkg/cmd/attestation/artifact" + "github.com/cli/cli/v2/pkg/cmd/attestation/io" + "github.com/cli/cli/v2/pkg/cmd/attestation/test" + + "github.com/sigstore/sigstore-go/pkg/verify" + "github.com/stretchr/testify/require" +) + +func TestLiveSigstoreVerifier(t *testing.T) { + t.Run("with invalid signature", func(t *testing.T) { + attestations := getAttestationsFor(t, "../test/data/sigstoreBundle-invalid-signature.json") + require.NotNil(t, attestations) + + verifier := NewLiveSigstoreVerifier(SigstoreConfig{ + Logger: io.NewTestHandler(), + }) + + res := verifier.Verify(attestations, publicGoodPolicy(t)) + require.Error(t, res.Error) + require.ErrorContains(t, res.Error, "verifying with issuer \"sigstore.dev\"") + require.Nil(t, res.VerifyResults) + }) + + t.Run("with valid artifact and JSON lines file containing multiple Sigstore bundles", func(t *testing.T) { + attestations := getAttestationsFor(t, "../test/data/sigstore-js-2.1.0_with_2_bundles.jsonl") + require.Len(t, attestations, 2) + + verifier := NewLiveSigstoreVerifier(SigstoreConfig{ + Logger: io.NewTestHandler(), + }) + + res := verifier.Verify(attestations, publicGoodPolicy(t)) + require.Len(t, res.VerifyResults, 2) + require.NoError(t, res.Error) + }) + + t.Run("with missing verification material", func(t *testing.T) { + attestations := getAttestationsFor(t, "../test/data/github_provenance_demo-0.0.12-py3-none-any-bundle-missing-verification-material.jsonl") + require.NotNil(t, attestations) + + verifier := NewLiveSigstoreVerifier(SigstoreConfig{ + Logger: io.NewTestHandler(), + }) + + res := verifier.Verify(attestations, publicGoodPolicy(t)) + require.Error(t, res.Error) + require.ErrorContains(t, res.Error, "failed to get bundle verification content") + require.Nil(t, res.VerifyResults) + }) + + t.Run("with missing verification certificate", func(t *testing.T) { + attestations := getAttestationsFor(t, "../test/data/github_provenance_demo-0.0.12-py3-none-any-bundle-missing-cert.jsonl") + require.NotNil(t, attestations) + + verifier := NewLiveSigstoreVerifier(SigstoreConfig{ + Logger: io.NewTestHandler(), + }) + + res := verifier.Verify(attestations, publicGoodPolicy(t)) + require.Error(t, res.Error) + require.ErrorContains(t, res.Error, "leaf cert not found") + require.Nil(t, res.VerifyResults) + }) + + t.Run("with GitHub Sigstore artifact", func(t *testing.T) { + githubArtifactPath := test.NormalizeRelativePath("../test/data/github_provenance_demo-0.0.12-py3-none-any.whl") + githubArtifact, err := artifact.NewDigestedArtifact(nil, githubArtifactPath, "sha256") + require.NoError(t, err) + + githubPolicy := buildPolicy(t, *githubArtifact) + + attestations := getAttestationsFor(t, "../test/data/github_provenance_demo-0.0.12-py3-none-any-bundle.jsonl") + + verifier := NewLiveSigstoreVerifier(SigstoreConfig{ + Logger: io.NewTestHandler(), + }) + + res := verifier.Verify(attestations, githubPolicy) + require.Len(t, res.VerifyResults, 1) + require.NoError(t, res.Error) + }) + + t.Run("with custom trusted root", func(t *testing.T) { + attestations := getAttestationsFor(t, "../test/data/sigstore-js-2.1.0_with_2_bundles.jsonl") + + verifier := NewLiveSigstoreVerifier(SigstoreConfig{ + Logger: io.NewTestHandler(), + CustomTrustedRoot: test.NormalizeRelativePath("../test/data/trusted_root.json"), + }) + + res := verifier.Verify(attestations, publicGoodPolicy(t)) + require.Len(t, res.VerifyResults, 2) + require.NoError(t, res.Error) + }) +} + +func publicGoodPolicy(t *testing.T) verify.PolicyBuilder { + t.Helper() + + artifactPath := test.NormalizeRelativePath("../test/data/sigstore-js-2.1.0.tgz") + publicGoodArtifact, err := artifact.NewDigestedArtifact(nil, artifactPath, "sha512") + require.NoError(t, err) + + return buildPolicy(t, *publicGoodArtifact) +} + +func buildPolicy(t *testing.T, artifact artifact.DigestedArtifact) verify.PolicyBuilder { + t.Helper() + + artifactDigestPolicyOption, err := BuildDigestPolicyOption(artifact) + require.NoError(t, err) + + return verify.NewPolicy(artifactDigestPolicyOption, verify.WithoutIdentitiesUnsafe()) +} + +func getAttestationsFor(t *testing.T, bundlePath string) []*api.Attestation { + t.Helper() + + attestations, err := GetLocalAttestations(bundlePath) + require.NoError(t, err) + + return attestations +} diff --git a/pkg/cmd/attestation/verification/tuf.go b/pkg/cmd/attestation/verification/tuf.go new file mode 100644 index 000000000..f46a483d8 --- /dev/null +++ b/pkg/cmd/attestation/verification/tuf.go @@ -0,0 +1,44 @@ +package verification + +import ( + _ "embed" + "os" + "path/filepath" + + "github.com/cli/go-gh/v2/pkg/config" + "github.com/sigstore/sigstore-go/pkg/tuf" +) + +//go:embed embed/tuf-repo.github.com/root.json +var githubRoot []byte + +const GitHubTUFMirror = "https://tuf-repo.github.com" + +func DefaultOptionsWithCacheSetting() *tuf.Options { + opts := tuf.DefaultOptions() + + // The CODESPACES environment variable will be set to true in a Codespaces workspace + if os.Getenv("CODESPACES") == "true" { + // if the tool is being used in a Codespace, disable the local cache + // because there is a permissions issue preventing the tuf library + // from writing the Sigstore cache to the home directory + opts.DisableLocalCache = true + } + + // Set the cache path to a directory owned by the CLI + opts.CachePath = filepath.Join(config.CacheDir(), ".sigstore", "root") + + // Allow TUF cache for 1 day + opts.CacheValidity = 1 + + return opts +} + +func GitHubTUFOptions() *tuf.Options { + opts := DefaultOptionsWithCacheSetting() + + opts.Root = githubRoot + opts.RepositoryBaseURL = GitHubTUFMirror + + return opts +} diff --git a/pkg/cmd/attestation/verification/tuf_test.go b/pkg/cmd/attestation/verification/tuf_test.go new file mode 100644 index 000000000..7d816bf82 --- /dev/null +++ b/pkg/cmd/attestation/verification/tuf_test.go @@ -0,0 +1,20 @@ +package verification + +import ( + "os" + "path/filepath" + "testing" + + "github.com/cli/go-gh/v2/pkg/config" + "github.com/stretchr/testify/require" +) + +func TestGitHubTUFOptions(t *testing.T) { + os.Setenv("CODESPACES", "true") + opts := GitHubTUFOptions() + + require.Equal(t, GitHubTUFMirror, opts.RepositoryBaseURL) + require.NotNil(t, opts.Root) + require.True(t, opts.DisableLocalCache) + require.Equal(t, filepath.Join(config.CacheDir(), ".sigstore", "root"), opts.CachePath) +} diff --git a/pkg/cmd/attestation/verify/options.go b/pkg/cmd/attestation/verify/options.go new file mode 100644 index 000000000..bfa03f16e --- /dev/null +++ b/pkg/cmd/attestation/verify/options.go @@ -0,0 +1,86 @@ +package verify + +import ( + "fmt" + "path/filepath" + "strings" + + "github.com/cli/cli/v2/pkg/cmd/attestation/api" + "github.com/cli/cli/v2/pkg/cmd/attestation/artifact/oci" + "github.com/cli/cli/v2/pkg/cmd/attestation/io" + "github.com/cli/cli/v2/pkg/cmd/attestation/verification" + "github.com/cli/cli/v2/pkg/cmdutil" +) + +// Options captures the options for the verify command +type Options struct { + ArtifactPath string + BundlePath string + CustomTrustedRoot string + DenySelfHostedRunner bool + DigestAlgorithm string + Limit int + NoPublicGood bool + OIDCIssuer string + Owner string + PredicateType string + Repo string + SAN string + SANRegex string + APIClient api.Client + Logger *io.Handler + OCIClient oci.Client + SigstoreVerifier verification.SigstoreVerifier + exporter cmdutil.Exporter +} + +// Clean cleans the file path option values +func (opts *Options) Clean() { + if opts.BundlePath != "" { + opts.BundlePath = filepath.Clean(opts.BundlePath) + } +} + +func (opts *Options) SetPolicyFlags() { + // check that Repo is in the expected format if provided + if opts.Repo != "" { + // we expect the repo argument to be in the format / + splitRepo := strings.Split(opts.Repo, "/") + + // if Repo is provided but owner is not, set the OWNER portion of the Repo value + // to Owner + opts.Owner = splitRepo[0] + + if opts.SAN == "" && opts.SANRegex == "" { + opts.SANRegex = expandToGitHubURL(opts.Repo) + } + return + } + if opts.SAN == "" && opts.SANRegex == "" { + opts.SANRegex = expandToGitHubURL(opts.Owner) + } +} + +// AreFlagsValid checks that the provided flag combination is valid +// and returns an error otherwise +func (opts *Options) AreFlagsValid() error { + // check that Repo is in the expected format if provided + if opts.Repo != "" { + // we expect the repo argument to be in the format / + splitRepo := strings.Split(opts.Repo, "/") + if len(splitRepo) != 2 { + return fmt.Errorf("invalid value provided for repo: %s", opts.Repo) + } + } + + // Check that limit is between 1 and 1000 + if opts.Limit < 1 || opts.Limit > 1000 { + return fmt.Errorf("limit %d not allowed, must be between 1 and 1000", opts.Limit) + } + + return nil +} + +func expandToGitHubURL(ownerOrRepo string) string { + return fmt.Sprintf("^https://github.com/%s/", ownerOrRepo) +} diff --git a/pkg/cmd/attestation/verify/options_test.go b/pkg/cmd/attestation/verify/options_test.go new file mode 100644 index 000000000..a7430017e --- /dev/null +++ b/pkg/cmd/attestation/verify/options_test.go @@ -0,0 +1,119 @@ +package verify + +import ( + "testing" + + "github.com/cli/cli/v2/pkg/cmd/attestation/test" + + "github.com/stretchr/testify/require" +) + +var ( + publicGoodArtifactPath = test.NormalizeRelativePath("../test/data/sigstore-js-2.1.0.tgz") + publicGoodBundlePath = test.NormalizeRelativePath("../test/data/psigstore-js-2.1.0-bundle.json") +) + +func TestAreFlagsValid(t *testing.T) { + t.Run("has invalid Repo value", func(t *testing.T) { + opts := Options{ + ArtifactPath: publicGoodArtifactPath, + DigestAlgorithm: "sha512", + OIDCIssuer: "some issuer", + Repo: "sigstoresigstore-js", + } + + err := opts.AreFlagsValid() + require.Error(t, err) + require.ErrorContains(t, err, "invalid value provided for repo") + }) + + t.Run("invalid limit < 0", func(t *testing.T) { + opts := Options{ + ArtifactPath: publicGoodArtifactPath, + BundlePath: publicGoodBundlePath, + DigestAlgorithm: "sha512", + Owner: "sigstore", + OIDCIssuer: "some issuer", + Limit: 0, + } + + err := opts.AreFlagsValid() + require.Error(t, err) + require.ErrorContains(t, err, "limit 0 not allowed, must be between 1 and 1000") + }) + + t.Run("invalid limit > 1000", func(t *testing.T) { + opts := Options{ + ArtifactPath: publicGoodArtifactPath, + BundlePath: publicGoodBundlePath, + DigestAlgorithm: "sha512", + Owner: "sigstore", + OIDCIssuer: "some issuer", + Limit: 1001, + } + + err := opts.AreFlagsValid() + require.Error(t, err) + require.ErrorContains(t, err, "limit 1001 not allowed, must be between 1 and 1000") + }) +} + +func TestSetPolicyFlags(t *testing.T) { + t.Run("sets Owner and SANRegex when Repo is provided", func(t *testing.T) { + opts := Options{ + ArtifactPath: publicGoodArtifactPath, + DigestAlgorithm: "sha512", + OIDCIssuer: "some issuer", + Repo: "sigstore/sigstore-js", + } + + opts.SetPolicyFlags() + require.Equal(t, "sigstore", opts.Owner) + require.Equal(t, "sigstore/sigstore-js", opts.Repo) + require.Equal(t, "^https://github.com/sigstore/sigstore-js/", opts.SANRegex) + }) + + t.Run("does not set SANRegex when SANRegex and Repo are provided", func(t *testing.T) { + opts := Options{ + ArtifactPath: publicGoodArtifactPath, + DigestAlgorithm: "sha512", + OIDCIssuer: "some issuer", + Repo: "sigstore/sigstore-js", + SANRegex: "^https://github/foo", + } + + opts.SetPolicyFlags() + require.Equal(t, "sigstore", opts.Owner) + require.Equal(t, "sigstore/sigstore-js", opts.Repo) + require.Equal(t, "^https://github/foo", opts.SANRegex) + }) + + t.Run("sets SANRegex when Owner is provided", func(t *testing.T) { + opts := Options{ + ArtifactPath: publicGoodArtifactPath, + BundlePath: publicGoodBundlePath, + DigestAlgorithm: "sha512", + OIDCIssuer: "some issuer", + Owner: "sigstore", + } + + opts.SetPolicyFlags() + require.Equal(t, "sigstore", opts.Owner) + require.Equal(t, "^https://github.com/sigstore/", opts.SANRegex) + }) + + t.Run("does not set SANRegex when SANRegex and Owner are provided", func(t *testing.T) { + opts := Options{ + ArtifactPath: publicGoodArtifactPath, + BundlePath: publicGoodBundlePath, + DigestAlgorithm: "sha512", + OIDCIssuer: "some issuer", + Owner: "sigstore", + SANRegex: "^https://github/foo", + } + + opts.SetPolicyFlags() + require.Equal(t, "sigstore", opts.Owner) + require.Equal(t, "^https://github/foo", opts.SANRegex) + }) +} diff --git a/pkg/cmd/attestation/verify/policy.go b/pkg/cmd/attestation/verify/policy.go new file mode 100644 index 000000000..34a56294b --- /dev/null +++ b/pkg/cmd/attestation/verify/policy.go @@ -0,0 +1,95 @@ +package verify + +import ( + "fmt" + + "github.com/sigstore/sigstore-go/pkg/fulcio/certificate" + "github.com/sigstore/sigstore-go/pkg/verify" + + "github.com/cli/cli/v2/pkg/cmd/attestation/artifact" + "github.com/cli/cli/v2/pkg/cmd/attestation/verification" +) + +const ( + GitHubOIDCIssuer = "https://token.actions.githubusercontent.com" + // represents the GitHub hosted runner in the certificate RunnerEnvironment extension + GitHubRunner = "github-hosted" +) + +func buildSANMatcher(san, sanRegex string) (verify.SubjectAlternativeNameMatcher, error) { + if san == "" && sanRegex == "" { + return verify.SubjectAlternativeNameMatcher{}, nil + } + + sanMatcher, err := verify.NewSANMatcher(san, "", sanRegex) + if err != nil { + return verify.SubjectAlternativeNameMatcher{}, err + } + return sanMatcher, nil +} + +func buildCertExtensions(opts *Options, runnerEnv string) certificate.Extensions { + extensions := certificate.Extensions{ + Issuer: opts.OIDCIssuer, + SourceRepositoryOwnerURI: fmt.Sprintf("https://github.com/%s", opts.Owner), + RunnerEnvironment: runnerEnv, + } + + // if opts.Repo is set, set the SourceRepositoryURI field before returning the extensions + if opts.Repo != "" { + extensions.SourceRepositoryURI = fmt.Sprintf("https://github.com/%s", opts.Repo) + } + return extensions +} + +func buildCertificateIdentityOption(opts *Options, runnerEnv string) (verify.PolicyOption, error) { + sanMatcher, err := buildSANMatcher(opts.SAN, opts.SANRegex) + if err != nil { + return nil, err + } + + extensions := buildCertExtensions(opts, runnerEnv) + + certId, err := verify.NewCertificateIdentity(sanMatcher, extensions) + if err != nil { + return nil, err + } + + return verify.WithCertificateIdentity(certId), nil +} + +func buildVerifyCertIdOption(opts *Options) (verify.PolicyOption, error) { + if opts.DenySelfHostedRunner { + withGHRunner, err := buildCertificateIdentityOption(opts, GitHubRunner) + if err != nil { + return nil, err + } + + return withGHRunner, nil + } + + // if Extensions.RunnerEnvironment value is set to the empty string + // through the second function argument, + // no certificate matching will happen on the RunnerEnvironment field + withAnyRunner, err := buildCertificateIdentityOption(opts, "") + if err != nil { + return nil, err + } + + return withAnyRunner, nil +} + +func buildVerifyPolicy(opts *Options, a artifact.DigestedArtifact) (verify.PolicyBuilder, error) { + artifactDigestPolicyOption, err := verification.BuildDigestPolicyOption(a) + if err != nil { + return verify.PolicyBuilder{}, err + } + + certIdOption, err := buildVerifyCertIdOption(opts) + if err != nil { + return verify.PolicyBuilder{}, err + } + + policy := verify.NewPolicy(artifactDigestPolicyOption, certIdOption) + return policy, nil +} diff --git a/pkg/cmd/attestation/verify/policy_test.go b/pkg/cmd/attestation/verify/policy_test.go new file mode 100644 index 000000000..f15144314 --- /dev/null +++ b/pkg/cmd/attestation/verify/policy_test.go @@ -0,0 +1,31 @@ +package verify + +import ( + "testing" + + "github.com/cli/cli/v2/pkg/cmd/attestation/artifact" + "github.com/cli/cli/v2/pkg/cmd/attestation/artifact/oci" + + "github.com/stretchr/testify/require" +) + +// This tests that a policy can be built from a valid artifact +// Note that policy use is tested in verify_test.go in this package +func TestBuildPolicy(t *testing.T) { + ociClient := oci.MockClient{} + artifactPath := "../test/data/sigstore-js-2.1.0.tgz" + digestAlg := "sha256" + + artifact, err := artifact.NewDigestedArtifact(ociClient, artifactPath, digestAlg) + require.NoError(t, err) + + opts := &Options{ + ArtifactPath: artifactPath, + OIDCIssuer: GitHubOIDCIssuer, + Owner: "sigstore", + SANRegex: "^https://github.com/sigstore/", + } + + _, err = buildVerifyPolicy(opts, *artifact) + require.NoError(t, err) +} diff --git a/pkg/cmd/attestation/verify/verify.go b/pkg/cmd/attestation/verify/verify.go new file mode 100644 index 000000000..182a85722 --- /dev/null +++ b/pkg/cmd/attestation/verify/verify.go @@ -0,0 +1,288 @@ +package verify + +import ( + "errors" + "fmt" + "regexp" + + "github.com/cli/cli/v2/internal/text" + "github.com/cli/cli/v2/pkg/cmd/attestation/api" + "github.com/cli/cli/v2/pkg/cmd/attestation/artifact" + "github.com/cli/cli/v2/pkg/cmd/attestation/artifact/oci" + "github.com/cli/cli/v2/pkg/cmd/attestation/auth" + "github.com/cli/cli/v2/pkg/cmd/attestation/io" + "github.com/cli/cli/v2/pkg/cmd/attestation/verification" + "github.com/cli/cli/v2/pkg/cmdutil" + + "github.com/MakeNowJust/heredoc" + "github.com/spf13/cobra" +) + +func NewVerifyCmd(f *cmdutil.Factory, runF func(*Options) error) *cobra.Command { + opts := &Options{} + verifyCmd := &cobra.Command{ + Use: "verify [ | oci://] [--owner | --repo]", + Args: cmdutil.ExactArgs(1, "must specify file path or container image URI, as well as one of --owner or --repo"), + Short: "Verify an artifact's integrity using attestations", + Long: heredoc.Docf(` + ### NOTE: This feature is currently in beta, and subject to change. + + Verify the integrity and provenance of an artifact using its associated + cryptographically signed attestations. + + The command requires either: + * a file path to an artifact, or + * a container image URI (e.g. %[1]soci://%[1]s) + * (note that if you provide an OCI URL, you must already be authenticated with + its container registry) + + In addition, the command requires either: + * the %[1]s--repo%[1]s flag (e.g. --repo github/example). + * the %[1]s--owner%[1]s flag (e.g. --owner github), or + + The %[1]s--repo%[1]s flag value must match the name of the GitHub repository + that the artifact is linked with. + + The %[1]s--owner%[1]s flag value must match the name of the GitHub organization + that the artifact's linked repository belongs to. + + By default, the verify command will attempt to fetch attestations associated + with the provided artifact from the GitHub API. If you would prefer to verify + the artifact using attestations stored on disk (c.f. the %[1]sdownload%[1]s command), + provide a path to the %[1]s--bundle%[1]s flag. + + To see the full results that are generated upon successful verification, i.e. + for use with a policy engine, provide the %[1]s--json-result%[1]s flag. + + The attestation's certificate's Subject Alternative Name (SAN) identifies the entity + responsible for creating the attestation, which most of the time will be a GitHub + Actions workflow file located inside your repository. By default, this command uses + either the %[1]s--repo%[1]s or the %[1]s--owner%[1]s flag value to validate the SAN. + + However, if you generate attestations with a reusable workflow then the SAN will + identify the reusable workflow – which may or may not be located inside your %[1]s--repo%[1]s + or %[1]s--owner%[1]s. In these situations, you can use the %[1]s--cert-identity%[1]s or + %[1]s--cert-identity-regex%[1]s flags to specify the reusable workflow's URI. + + For more policy verification options, see the other available flags. + `, "`"), + Example: heredoc.Doc(` + # Verify a local artifact linked with a repository + $ gh attestation verify example.bin --repo github/example + + # Verify a local artifact linked with an organization + $ gh attestation verify example.bin --owner github + + # Verify an OCI image using locally stored attestations + $ gh attestation verify oci:// --owner github --bundle sha256:foo.jsonl + `), + // PreRunE is used to validate flags before the command is run + // If an error is returned, its message will be printed to the terminal + // along with information about how use the command + PreRunE: func(cmd *cobra.Command, args []string) error { + // Create a logger for use throughout the verify command + opts.Logger = io.NewHandler(f.IOStreams) + + // set the artifact path + opts.ArtifactPath = args[0] + + // Check that the given flag combination is valid + if err := opts.AreFlagsValid(); err != nil { + return err + } + + // Clean file path options + opts.Clean() + + // set policy flags based on what has been provided + opts.SetPolicyFlags() + + return nil + }, + RunE: func(cmd *cobra.Command, args []string) error { + hc, err := f.HttpClient() + if err != nil { + return err + } + opts.APIClient = api.NewLiveClient(hc, opts.Logger) + + opts.OCIClient = oci.NewLiveClient() + + if err := auth.IsHostSupported(); err != nil { + return err + } + + if runF != nil { + return runF(opts) + } + + config := verification.SigstoreConfig{ + CustomTrustedRoot: opts.CustomTrustedRoot, + Logger: opts.Logger, + NoPublicGood: opts.NoPublicGood, + } + + opts.SigstoreVerifier = verification.NewLiveSigstoreVerifier(config) + + if err := runVerify(opts); err != nil { + return fmt.Errorf("\nError: %v", err) + } + return nil + }, + } + + // general flags + verifyCmd.Flags().StringVarP(&opts.BundlePath, "bundle", "b", "", "Path to bundle on disk, either a single bundle in a JSON file or a JSON lines file with multiple bundles") + cmdutil.DisableAuthCheckFlag(verifyCmd.Flags().Lookup("bundle")) + cmdutil.StringEnumFlag(verifyCmd, &opts.DigestAlgorithm, "digest-alg", "d", "sha256", []string{"sha256", "sha512"}, "The algorithm used to compute a digest of the artifact") + verifyCmd.Flags().StringVarP(&opts.Owner, "owner", "o", "", "GitHub organization to scope attestation lookup by") + verifyCmd.Flags().StringVarP(&opts.Repo, "repo", "R", "", "Repository name in the format /") + verifyCmd.MarkFlagsMutuallyExclusive("owner", "repo") + verifyCmd.MarkFlagsOneRequired("owner", "repo") + verifyCmd.Flags().StringVarP(&opts.PredicateType, "predicate-type", "", "", "Filter attestations by provided predicate type") + verifyCmd.Flags().BoolVarP(&opts.NoPublicGood, "no-public-good", "", false, "Only verify attestations signed with GitHub's Sigstore instance") + verifyCmd.Flags().StringVarP(&opts.CustomTrustedRoot, "custom-trusted-root", "", "", "Path to a custom trustedroot.json file to use for verification") + verifyCmd.Flags().IntVarP(&opts.Limit, "limit", "L", api.DefaultLimit, "Maximum number of attestations to fetch") + cmdutil.AddFormatFlags(verifyCmd, &opts.exporter) + // policy enforcement flags + verifyCmd.Flags().BoolVarP(&opts.DenySelfHostedRunner, "deny-self-hosted-runners", "", false, "Fail verification for attestations generated on self-hosted runners") + verifyCmd.Flags().StringVarP(&opts.SAN, "cert-identity", "", "", "Enforce that the certificate's subject alternative name matches the provided value exactly") + verifyCmd.Flags().StringVarP(&opts.SANRegex, "cert-identity-regex", "i", "", "Enforce that the certificate's subject alternative name matches the provided regex") + verifyCmd.MarkFlagsMutuallyExclusive("cert-identity", "cert-identity-regex") + verifyCmd.Flags().StringVarP(&opts.OIDCIssuer, "cert-oidc-issuer", "", GitHubOIDCIssuer, "Issuer of the OIDC token") + + return verifyCmd +} + +func runVerify(opts *Options) error { + artifact, err := artifact.NewDigestedArtifact(opts.OCIClient, opts.ArtifactPath, opts.DigestAlgorithm) + if err != nil { + opts.Logger.Printf(opts.Logger.ColorScheme.Red("✗ Loading digest for %s failed\n"), opts.ArtifactPath) + return err + } + + opts.Logger.Printf("Loaded digest %s for %s\n", artifact.DigestWithAlg(), artifact.URL) + + c := verification.FetchAttestationsConfig{ + APIClient: opts.APIClient, + BundlePath: opts.BundlePath, + Digest: artifact.DigestWithAlg(), + Limit: opts.Limit, + Owner: opts.Owner, + Repo: opts.Repo, + } + attestations, err := verification.GetAttestations(c) + if err != nil { + if ok := errors.Is(err, api.ErrNoAttestations{}); ok { + opts.Logger.Printf(opts.Logger.ColorScheme.Red("✗ No attestations found for subject %s\n"), artifact.DigestWithAlg()) + return err + } + + if c.IsBundleProvided() { + opts.Logger.Printf(opts.Logger.ColorScheme.Red("✗ Loading attestations from %s failed\n"), artifact.URL) + } else { + opts.Logger.Println(opts.Logger.ColorScheme.Red("✗ Loading attestations from GitHub API failed")) + } + return err + } + + pluralAttestation := text.Pluralize(len(attestations), "attestation") + if c.IsBundleProvided() { + opts.Logger.Printf("Loaded %s from %s\n", pluralAttestation, opts.BundlePath) + } else { + opts.Logger.Printf("Loaded %s from GitHub API\n", pluralAttestation) + } + + // Apply predicate type filter to returned attestations + if opts.PredicateType != "" { + filteredAttestations := verification.FilterAttestations(opts.PredicateType, attestations) + + if len(filteredAttestations) == 0 { + opts.Logger.Printf(opts.Logger.ColorScheme.Red("✗ No attestations found with predicate type: %s\n"), opts.PredicateType) + return err + } + + attestations = filteredAttestations + } + + policy, err := buildVerifyPolicy(opts, *artifact) + if err != nil { + opts.Logger.Println(opts.Logger.ColorScheme.Red("✗ Failed to build verification policy")) + return err + } + + sigstoreRes := opts.SigstoreVerifier.Verify(attestations, policy) + if sigstoreRes.Error != nil { + opts.Logger.Println(opts.Logger.ColorScheme.Red("✗ Verification failed")) + return sigstoreRes.Error + } + + opts.Logger.Println(opts.Logger.ColorScheme.Green("✓ Verification succeeded!\n")) + + // If an exporter is provided with the --json flag, write the results to the terminal in JSON format + if opts.exporter != nil { + // print the results to the terminal as an array of JSON objects + if err = opts.exporter.Write(opts.Logger.IO, sigstoreRes.VerifyResults); err != nil { + opts.Logger.Println(opts.Logger.ColorScheme.Red("✗ Failed to write JSON output")) + return err + } + return nil + } + + opts.Logger.Printf("%s was attested by:\n", artifact.DigestWithAlg()) + + // Otherwise print the results to the terminal in a table + tableContent, err := buildTableVerifyContent(sigstoreRes.VerifyResults) + if err != nil { + opts.Logger.Println(opts.Logger.ColorScheme.Red("failed to parse results")) + return err + } + + headers := []string{"repo", "predicate_type", "workflow"} + if err = opts.Logger.PrintTable(headers, tableContent); err != nil { + opts.Logger.Println(opts.Logger.ColorScheme.Red("failed to print attestation details to table")) + return err + } + + // All attestations passed verification and policy evaluation + return nil +} + +func extractAttestationDetail(builderSignerURI string) (string, string, error) { + // If given a build signer URI like + // https://github.com/foo/bar/.github/workflows/release.yml@refs/heads/main + // We want to extract: + // * foo/bar + // * .github/workflows/release.yml@refs/heads/main + orgAndRepoRegexp := regexp.MustCompile(`https://github\.com/([^/]+/[^/]+)/`) + match := orgAndRepoRegexp.FindStringSubmatch(builderSignerURI) + if len(match) < 2 { + return "", "", fmt.Errorf("no match found for org and repo") + } + repoAndOrg := match[1] + + workflowRegexp := regexp.MustCompile(`https://github\.com/[^/]+/[^/]+/(.+)`) + match = workflowRegexp.FindStringSubmatch(builderSignerURI) + if len(match) < 2 { + return "", "", fmt.Errorf("no match found for workflow") + } + workflow := match[1] + + return repoAndOrg, workflow, nil +} + +func buildTableVerifyContent(results []*verification.AttestationProcessingResult) ([][]string, error) { + content := make([][]string, len(results)) + + for i, res := range results { + builderSignerURI := res.VerificationResult.Signature.Certificate.Extensions.BuildSignerURI + repoAndOrg, workflow, err := extractAttestationDetail(builderSignerURI) + if err != nil { + return nil, err + } + predicateType := res.VerificationResult.Statement.PredicateType + content[i] = []string{repoAndOrg, predicateType, workflow} + } + + return content, nil +} diff --git a/pkg/cmd/attestation/verify/verify_integration_test.go b/pkg/cmd/attestation/verify/verify_integration_test.go new file mode 100644 index 000000000..7cc1c8110 --- /dev/null +++ b/pkg/cmd/attestation/verify/verify_integration_test.go @@ -0,0 +1,82 @@ +//go:build integration + +package verify + +import ( + "testing" + + "github.com/cli/cli/v2/pkg/cmd/attestation/api" + "github.com/cli/cli/v2/pkg/cmd/attestation/artifact/oci" + "github.com/cli/cli/v2/pkg/cmd/attestation/io" + "github.com/cli/cli/v2/pkg/cmd/attestation/verification" + "github.com/cli/cli/v2/pkg/cmd/factory" + "github.com/stretchr/testify/require" +) + +func TestVerifyIntegration(t *testing.T) { + logger := io.NewTestHandler() + + sigstoreConfig := verification.SigstoreConfig{ + Logger: logger, + } + + cmdFactory := factory.New("test") + + hc, err := cmdFactory.HttpClient() + if err != nil { + t.Fatal(err) + } + + publicGoodOpts := Options{ + APIClient: api.NewLiveClient(hc, logger), + ArtifactPath: artifactPath, + BundlePath: bundlePath, + DigestAlgorithm: "sha512", + Logger: logger, + OCIClient: oci.NewLiveClient(), + OIDCIssuer: GitHubOIDCIssuer, + Owner: "sigstore", + SANRegex: "^https://github.com/sigstore/", + SigstoreVerifier: verification.NewLiveSigstoreVerifier(sigstoreConfig), + } + + t.Run("with valid owner", func(t *testing.T) { + err := runVerify(&publicGoodOpts) + require.NoError(t, err) + }) + + t.Run("with valid repo", func(t *testing.T) { + opts := publicGoodOpts + opts.Repo = "sigstore/sigstore-js" + + err := runVerify(&opts) + require.NoError(t, err) + }) + + t.Run("with valid owner and invalid repo", func(t *testing.T) { + opts := publicGoodOpts + opts.Repo = "sigstore/fakerepo" + + err := runVerify(&opts) + require.Error(t, err) + require.ErrorContains(t, err, "verifying with issuer \"sigstore.dev\": failed to verify certificate identity: no matching certificate identity found") + }) + + t.Run("with invalid owner", func(t *testing.T) { + opts := publicGoodOpts + opts.Owner = "fakeowner" + + err := runVerify(&opts) + require.Error(t, err) + require.ErrorContains(t, err, "verifying with issuer \"sigstore.dev\": failed to verify certificate identity: no matching certificate identity found") + }) + + t.Run("with invalid owner and invalid repo", func(t *testing.T) { + opts := publicGoodOpts + opts.Repo = "fakeowner/fakerepo" + + err := runVerify(&opts) + require.Error(t, err) + require.ErrorContains(t, err, "verifying with issuer \"sigstore.dev\": failed to verify certificate identity: no matching certificate identity found") + }) +} diff --git a/pkg/cmd/attestation/verify/verify_test.go b/pkg/cmd/attestation/verify/verify_test.go new file mode 100644 index 000000000..ef778f454 --- /dev/null +++ b/pkg/cmd/attestation/verify/verify_test.go @@ -0,0 +1,448 @@ +package verify + +import ( + "bytes" + "encoding/json" + "fmt" + "net/http" + "strings" + "testing" + + "github.com/cli/cli/v2/pkg/cmd/attestation/api" + "github.com/cli/cli/v2/pkg/cmd/attestation/artifact/oci" + "github.com/cli/cli/v2/pkg/cmd/attestation/io" + "github.com/cli/cli/v2/pkg/cmd/attestation/test" + "github.com/cli/cli/v2/pkg/cmd/attestation/verification" + "github.com/cli/cli/v2/pkg/cmdutil" + "github.com/spf13/cobra" + + "github.com/cli/cli/v2/pkg/httpmock" + "github.com/cli/cli/v2/pkg/iostreams" + "github.com/stretchr/testify/assert" + + "github.com/stretchr/testify/require" +) + +const ( + SigstoreSanValue = "https://github.com/sigstore/sigstore-js/.github/workflows/release.yml@refs/heads/main" + SigstoreSanRegex = "^https://github.com/sigstore/sigstore-js/" +) + +var ( + artifactPath = test.NormalizeRelativePath("../test/data/sigstore-js-2.1.0.tgz") + bundlePath = test.NormalizeRelativePath("../test/data/sigstore-js-2.1.0-bundle.json") +) + +func TestNewVerifyCmd(t *testing.T) { + testIO, _, _, _ := iostreams.Test() + f := &cmdutil.Factory{ + IOStreams: testIO, + HttpClient: func() (*http.Client, error) { + reg := &httpmock.Registry{} + client := &http.Client{} + httpmock.ReplaceTripper(client, reg) + return client, nil + }, + } + + testcases := []struct { + name string + cli string + wants Options + wantsErr bool + wantsExporter bool + }{ + { + name: "Invalid digest-alg flag", + cli: fmt.Sprintf("%s --bundle %s --digest-alg sha384 --owner sigstore", artifactPath, bundlePath), + wants: Options{ + ArtifactPath: test.NormalizeRelativePath("../test/data/sigstore-js-2.1.0.tgz"), + BundlePath: test.NormalizeRelativePath("../test/data/sigstore-js-2.1.0-bundle.json"), + DigestAlgorithm: "sha384", + Limit: 30, + OIDCIssuer: GitHubOIDCIssuer, + Owner: "sigstore", + SigstoreVerifier: verification.NewMockSigstoreVerifier(t), + }, + wantsErr: true, + }, + { + name: "Use default digest-alg value", + cli: fmt.Sprintf("%s --bundle %s --owner sigstore", artifactPath, bundlePath), + wants: Options{ + ArtifactPath: test.NormalizeRelativePath("../test/data/sigstore-js-2.1.0.tgz"), + BundlePath: test.NormalizeRelativePath("../test/data/sigstore-js-2.1.0-bundle.json"), + DigestAlgorithm: "sha256", + Limit: 30, + OIDCIssuer: GitHubOIDCIssuer, + Owner: "sigstore", + SANRegex: "^https://github.com/sigstore/", + SigstoreVerifier: verification.NewMockSigstoreVerifier(t), + }, + wantsErr: false, + }, + { + name: "Use custom digest-alg value", + cli: fmt.Sprintf("%s --bundle %s --owner sigstore --digest-alg sha512", artifactPath, bundlePath), + wants: Options{ + ArtifactPath: test.NormalizeRelativePath("../test/data/sigstore-js-2.1.0.tgz"), + BundlePath: test.NormalizeRelativePath("../test/data/sigstore-js-2.1.0-bundle.json"), + DigestAlgorithm: "sha512", + Limit: 30, + OIDCIssuer: GitHubOIDCIssuer, + Owner: "sigstore", + SANRegex: "^https://github.com/sigstore/", + SigstoreVerifier: verification.NewMockSigstoreVerifier(t), + }, + wantsErr: false, + }, + { + name: "Missing owner and repo flags", + cli: artifactPath, + wants: Options{ + ArtifactPath: test.NormalizeRelativePath("../test/data/sigstore-js-2.1.0.tgz"), + DigestAlgorithm: "sha256", + OIDCIssuer: GitHubOIDCIssuer, + Owner: "sigstore", + Limit: 30, + SANRegex: "^https://github.com/sigstore/", + SigstoreVerifier: verification.NewMockSigstoreVerifier(t), + }, + wantsErr: true, + }, + { + name: "Has both owner and repo flags", + cli: fmt.Sprintf("%s --owner sigstore --repo sigstore/sigstore-js", artifactPath), + wants: Options{ + ArtifactPath: artifactPath, + DigestAlgorithm: "sha256", + OIDCIssuer: GitHubOIDCIssuer, + Owner: "sigstore", + Repo: "sigstore/sigstore-js", + Limit: 30, + SigstoreVerifier: verification.NewMockSigstoreVerifier(t), + }, + wantsErr: true, + }, + { + name: "Uses default limit flag", + cli: fmt.Sprintf("%s --owner sigstore", artifactPath), + wants: Options{ + ArtifactPath: artifactPath, + DigestAlgorithm: "sha256", + Limit: 30, + OIDCIssuer: GitHubOIDCIssuer, + Owner: "sigstore", + SANRegex: "^https://github.com/sigstore/", + SigstoreVerifier: verification.NewMockSigstoreVerifier(t), + }, + wantsErr: false, + }, + { + name: "Uses custom limit flag", + cli: fmt.Sprintf("%s --owner sigstore --limit 101", artifactPath), + wants: Options{ + ArtifactPath: artifactPath, + DigestAlgorithm: "sha256", + OIDCIssuer: GitHubOIDCIssuer, + Owner: "sigstore", + Limit: 101, + SANRegex: "^https://github.com/sigstore/", + SigstoreVerifier: verification.NewMockSigstoreVerifier(t), + }, + wantsErr: false, + }, + { + name: "Uses invalid limit flag", + cli: fmt.Sprintf("%s --owner sigstore --limit 0", artifactPath), + wants: Options{ + ArtifactPath: artifactPath, + DigestAlgorithm: "sha256", + OIDCIssuer: GitHubOIDCIssuer, + Owner: "sigstore", + Limit: 0, + SANRegex: "^https://github.com/sigstore/", + SigstoreVerifier: verification.NewMockSigstoreVerifier(t), + }, + wantsErr: true, + }, + { + name: "Has both cert-identity and cert-identity-regex flags", + cli: fmt.Sprintf("%s --owner sigstore --cert-identity https://github.com/sigstore/ --cert-identity-regex ^https://github.com/sigstore/", artifactPath), + wants: Options{ + ArtifactPath: artifactPath, + DigestAlgorithm: "sha256", + Limit: 30, + OIDCIssuer: GitHubOIDCIssuer, + Owner: "sigstore", + SAN: "https://github.com/sigstore/", + SANRegex: "^https://github.com/sigstore/", + SigstoreVerifier: verification.NewMockSigstoreVerifier(t), + }, + wantsErr: true, + }, + { + name: "Prints output in JSON format", + cli: fmt.Sprintf("%s --bundle %s --owner sigstore --format json", artifactPath, bundlePath), + wants: Options{ + ArtifactPath: artifactPath, + BundlePath: bundlePath, + DigestAlgorithm: "sha256", + Limit: 30, + OIDCIssuer: GitHubOIDCIssuer, + Owner: "sigstore", + SANRegex: "^https://github.com/sigstore/", + SigstoreVerifier: verification.NewMockSigstoreVerifier(t), + }, + wantsExporter: true, + }, + } + + for _, tc := range testcases { + t.Run(tc.name, func(t *testing.T) { + var opts *Options + cmd := NewVerifyCmd(f, func(o *Options) error { + opts = o + return nil + }) + + argv := strings.Split(tc.cli, " ") + cmd.SetArgs(argv) + cmd.SetIn(&bytes.Buffer{}) + cmd.SetOut(&bytes.Buffer{}) + cmd.SetErr(&bytes.Buffer{}) + _, err := cmd.ExecuteC() + if tc.wantsErr { + assert.Error(t, err) + return + } + assert.NoError(t, err) + + assert.Equal(t, tc.wants.ArtifactPath, opts.ArtifactPath) + assert.Equal(t, tc.wants.BundlePath, opts.BundlePath) + assert.Equal(t, tc.wants.CustomTrustedRoot, opts.CustomTrustedRoot) + assert.Equal(t, tc.wants.DenySelfHostedRunner, opts.DenySelfHostedRunner) + assert.Equal(t, tc.wants.DigestAlgorithm, opts.DigestAlgorithm) + assert.Equal(t, tc.wants.Limit, opts.Limit) + assert.Equal(t, tc.wants.NoPublicGood, opts.NoPublicGood) + assert.Equal(t, tc.wants.OIDCIssuer, opts.OIDCIssuer) + assert.Equal(t, tc.wants.Owner, opts.Owner) + assert.Equal(t, tc.wants.Repo, opts.Repo) + assert.Equal(t, tc.wants.SAN, opts.SAN) + assert.Equal(t, tc.wants.SANRegex, opts.SANRegex) + assert.NotNil(t, opts.APIClient) + assert.NotNil(t, opts.Logger) + assert.NotNil(t, opts.OCIClient) + assert.Equal(t, tc.wantsExporter, opts.exporter != nil) + }) + } +} + +func TestVerifyCmdAuthChecks(t *testing.T) { + f := &cmdutil.Factory{} + + t.Run("by default auth check is required", func(t *testing.T) { + cmd := NewVerifyCmd(f, func(o *Options) error { + return nil + }) + + // IsAuthCheckEnabled assumes commands under test are subcommands + parent := &cobra.Command{Use: "root"} + parent.AddCommand(cmd) + + require.NoError(t, cmd.ParseFlags([]string{})) + require.True(t, cmdutil.IsAuthCheckEnabled(cmd), "expected auth check to be required") + }) + + t.Run("when --bundle flag is provided, auth check is not required", func(t *testing.T) { + cmd := NewVerifyCmd(f, func(o *Options) error { + return nil + }) + + // IsAuthCheckEnabled assumes commands under test are subcommands + parent := &cobra.Command{Use: "root"} + parent.AddCommand(cmd) + + require.NoError(t, cmd.ParseFlags([]string{"--bundle", "not-important"})) + require.False(t, cmdutil.IsAuthCheckEnabled(cmd), "expected auth check not to be required due to --bundle flag") + }) +} + +func TestJSONOutput(t *testing.T) { + testIO, _, out, _ := iostreams.Test() + opts := Options{ + ArtifactPath: artifactPath, + BundlePath: bundlePath, + DigestAlgorithm: "sha512", + APIClient: api.NewTestClient(), + Logger: io.NewHandler(testIO), + OCIClient: oci.MockClient{}, + OIDCIssuer: GitHubOIDCIssuer, + Owner: "sigstore", + SANRegex: "^https://github.com/sigstore/", + SigstoreVerifier: verification.NewMockSigstoreVerifier(t), + exporter: cmdutil.NewJSONExporter(), + } + require.Nil(t, runVerify(&opts)) + + var target []*verification.AttestationProcessingResult + err := json.Unmarshal(out.Bytes(), &target) + require.NoError(t, err) +} + +func TestRunVerify(t *testing.T) { + logger := io.NewTestHandler() + + publicGoodOpts := Options{ + ArtifactPath: artifactPath, + BundlePath: bundlePath, + DigestAlgorithm: "sha512", + APIClient: api.NewTestClient(), + Logger: logger, + OCIClient: oci.MockClient{}, + OIDCIssuer: GitHubOIDCIssuer, + Owner: "sigstore", + SANRegex: "^https://github.com/sigstore/", + SigstoreVerifier: verification.NewMockSigstoreVerifier(t), + } + + t.Run("with valid artifact and bundle", func(t *testing.T) { + require.Nil(t, runVerify(&publicGoodOpts)) + }) + + t.Run("with failing OCI artifact fetch", func(t *testing.T) { + opts := publicGoodOpts + opts.ArtifactPath = "oci://ghcr.io/github/test" + opts.OCIClient = oci.ReferenceFailClient{} + + err := runVerify(&opts) + require.Error(t, err) + require.ErrorContains(t, err, "failed to parse reference") + }) + + t.Run("with missing artifact path", func(t *testing.T) { + opts := publicGoodOpts + opts.ArtifactPath = "../test/data/non-existent-artifact.zip" + require.Error(t, runVerify(&opts)) + }) + + t.Run("with missing bundle path", func(t *testing.T) { + opts := publicGoodOpts + opts.BundlePath = "../test/data/non-existent-sigstoreBundle.json" + require.Error(t, runVerify(&opts)) + }) + + t.Run("with owner", func(t *testing.T) { + opts := publicGoodOpts + opts.BundlePath = "" + opts.Owner = "sigstore" + + require.Nil(t, runVerify(&opts)) + }) + + t.Run("with repo", func(t *testing.T) { + opts := publicGoodOpts + opts.BundlePath = "" + opts.Repo = "github/example" + + require.Nil(t, runVerify(&opts)) + }) + + t.Run("with invalid repo", func(t *testing.T) { + opts := publicGoodOpts + opts.BundlePath = "" + opts.Repo = "wrong/example" + opts.APIClient = api.NewFailTestClient() + + err := runVerify(&opts) + require.Error(t, err) + require.ErrorContains(t, err, "failed to fetch attestations from wrong/example") + }) + + t.Run("with invalid owner", func(t *testing.T) { + opts := publicGoodOpts + opts.BundlePath = "" + opts.APIClient = api.NewFailTestClient() + opts.Owner = "wrong-owner" + + err := runVerify(&opts) + require.Error(t, err) + require.ErrorContains(t, err, "failed to fetch attestations from wrong-owner") + }) + + // TODO: this test can only be tested with a live SigstoreVerifier + // add integration tests or HTTP mocked sigstore verifier tests + // to test this case + t.Run("with invalid OIDC issuer", func(t *testing.T) { + t.Skip() + opts := publicGoodOpts + opts.OIDCIssuer = "not-a-real-issuer" + require.Error(t, runVerify(&opts)) + }) + + // TODO: this test can only be tested with a live SigstoreVerifier + // add integration tests or HTTP mocked sigstore verifier tests + // to test this case + t.Run("with SAN enforcement", func(t *testing.T) { + t.Skip() + opts := Options{ + ArtifactPath: artifactPath, + BundlePath: bundlePath, + APIClient: api.NewTestClient(), + DigestAlgorithm: "sha512", + Logger: logger, + OIDCIssuer: GitHubOIDCIssuer, + Owner: "sigstore", + SAN: SigstoreSanValue, + SigstoreVerifier: verification.NewMockSigstoreVerifier(t), + } + require.Nil(t, runVerify(&opts)) + }) + + // TODO: this test can only be tested with a live SigstoreVerifier + // add integration tests or HTTP mocked sigstore verifier tests + // to test this case + t.Run("with invalid SAN", func(t *testing.T) { + t.Skip() + opts := publicGoodOpts + opts.SAN = "fake san" + require.Error(t, runVerify(&opts)) + }) + + // TODO: this test can only be tested with a live SigstoreVerifier + // add integration tests or HTTP mocked sigstore verifier tests + // to test this case + t.Run("with SAN regex enforcement", func(t *testing.T) { + t.Skip() + opts := publicGoodOpts + opts.SANRegex = SigstoreSanRegex + require.Nil(t, runVerify(&opts)) + }) + + // TODO: this test can only be tested with a live SigstoreVerifier + // add integration tests or HTTP mocked sigstore verifier tests + // to test this case + t.Run("with invalid SAN regex", func(t *testing.T) { + t.Skip() + opts := publicGoodOpts + opts.SANRegex = "^https://github.com/sigstore/not-real/" + require.Error(t, runVerify(&opts)) + }) + + // TODO: this test can only be tested with a live SigstoreVerifier + // add integration tests or HTTP mocked sigstore verifier tests + // to test this case + t.Run("with no matching OIDC issuer", func(t *testing.T) { + t.Skip() + opts := publicGoodOpts + opts.OIDCIssuer = "some-other-issuer" + require.Error(t, runVerify(&opts)) + }) + + t.Run("with missing API client", func(t *testing.T) { + customOpts := publicGoodOpts + customOpts.APIClient = nil + customOpts.BundlePath = "" + require.Error(t, runVerify(&customOpts)) + }) +} diff --git a/pkg/cmd/auth/auth.go b/pkg/cmd/auth/auth.go index c003049eb..70e01653f 100644 --- a/pkg/cmd/auth/auth.go +++ b/pkg/cmd/auth/auth.go @@ -7,6 +7,7 @@ import ( authRefreshCmd "github.com/cli/cli/v2/pkg/cmd/auth/refresh" authSetupGitCmd "github.com/cli/cli/v2/pkg/cmd/auth/setupgit" authStatusCmd "github.com/cli/cli/v2/pkg/cmd/auth/status" + authSwitchCmd "github.com/cli/cli/v2/pkg/cmd/auth/switch" authTokenCmd "github.com/cli/cli/v2/pkg/cmd/auth/token" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/spf13/cobra" @@ -28,6 +29,7 @@ func NewCmdAuth(f *cmdutil.Factory) *cobra.Command { cmd.AddCommand(gitCredentialCmd.NewCmdCredential(f, nil)) cmd.AddCommand(authSetupGitCmd.NewCmdSetupGit(f, nil)) cmd.AddCommand(authTokenCmd.NewCmdToken(f, nil)) + cmd.AddCommand(authSwitchCmd.NewCmdSwitch(f, nil)) return cmd } diff --git a/pkg/cmd/auth/gitcredential/helper.go b/pkg/cmd/auth/gitcredential/helper.go index fcceaf186..9b64f74b9 100644 --- a/pkg/cmd/auth/gitcredential/helper.go +++ b/pkg/cmd/auth/gitcredential/helper.go @@ -14,8 +14,8 @@ import ( const tokenUser = "x-access-token" type config interface { - Token(string) (string, string) - User(string) (string, error) + ActiveToken(string) (string, string) + ActiveUser(string) (string, error) } type CredentialOptions struct { @@ -112,16 +112,16 @@ func helperRun(opts *CredentialOptions) error { lookupHost := wants["host"] var gotUser string - gotToken, source := cfg.Token(lookupHost) + gotToken, source := cfg.ActiveToken(lookupHost) if gotToken == "" && strings.HasPrefix(lookupHost, "gist.") { lookupHost = strings.TrimPrefix(lookupHost, "gist.") - gotToken, source = cfg.Token(lookupHost) + gotToken, source = cfg.ActiveToken(lookupHost) } if strings.HasSuffix(source, "_TOKEN") { gotUser = tokenUser } else { - gotUser, _ = cfg.User(lookupHost) + gotUser, _ = cfg.ActiveUser(lookupHost) if gotUser == "" { gotUser = tokenUser } diff --git a/pkg/cmd/auth/gitcredential/helper_test.go b/pkg/cmd/auth/gitcredential/helper_test.go index f66df1d16..a3c6e2056 100644 --- a/pkg/cmd/auth/gitcredential/helper_test.go +++ b/pkg/cmd/auth/gitcredential/helper_test.go @@ -10,11 +10,11 @@ import ( type tinyConfig map[string]string -func (c tinyConfig) Token(host string) (string, string) { +func (c tinyConfig) ActiveToken(host string) (string, string) { return c[fmt.Sprintf("%s:%s", host, "oauth_token")], c["_source"] } -func (c tinyConfig) User(host string) (string, error) { +func (c tinyConfig) ActiveUser(host string) (string, error) { return c[fmt.Sprintf("%s:%s", host, "user")], nil } diff --git a/pkg/cmd/auth/login/login.go b/pkg/cmd/auth/login/login.go index 84894bf10..9e27f28ac 100644 --- a/pkg/cmd/auth/login/login.go +++ b/pkg/cmd/auth/login/login.go @@ -9,9 +9,10 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/git" "github.com/cli/cli/v2/internal/browser" - "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghinstance" "github.com/cli/cli/v2/pkg/cmd/auth/shared" + "github.com/cli/cli/v2/pkg/cmd/auth/shared/gitcredentials" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" ghAuth "github.com/cli/go-gh/v2/pkg/auth" @@ -20,7 +21,7 @@ import ( type LoginOptions struct { IO *iostreams.IOStreams - Config func() (config.Config, error) + Config func() (gh.Config, error) HttpClient func() (*http.Client, error) GitClient *git.Client Prompter shared.Prompt @@ -30,12 +31,13 @@ type LoginOptions struct { Interactive bool - Hostname string - Scopes []string - Token string - Web bool - GitProtocol string - InsecureStorage bool + Hostname string + Scopes []string + Token string + Web bool + GitProtocol string + InsecureStorage bool + SkipSSHKeyPrompt bool } func NewCmdLogin(f *cmdutil.Factory, runF func(*LoginOptions) error) *cobra.Command { @@ -53,30 +55,41 @@ func NewCmdLogin(f *cmdutil.Factory, runF func(*LoginOptions) error) *cobra.Comm cmd := &cobra.Command{ Use: "login", Args: cobra.ExactArgs(0), - Short: "Authenticate with a GitHub host", + Short: "Log in to a GitHub account", Long: heredoc.Docf(` Authenticate with a GitHub host. The default authentication mode is a web-based browser flow. After completion, an - authentication token will be stored internally. + authentication token will be stored securely in the system credential store. + If a credential store is not found or there is an issue using it gh will fallback + to writing the token to a plain text file. See %[1]sgh auth status%[1]s for its + stored location. Alternatively, use %[1]s--with-token%[1]s to pass in a token on standard input. - The minimum required scopes for the token are: "repo", "read:org". + The minimum required scopes for the token are: %[1]srepo%[1]s, %[1]sread:org%[1]s, and %[1]sgist%[1]s. Alternatively, gh will use the authentication token found in environment variables. This method is most suitable for "headless" use of gh such as in automation. See %[1]sgh help environment%[1]s for more info. - To use gh in GitHub Actions, add %[1]sGH_TOKEN: ${{ github.token }}%[1]s to "env". + To use gh in GitHub Actions, add %[1]sGH_TOKEN: ${{ github.token }}%[1]s to %[1]senv%[1]s. + + The git protocol to use for git operations on this host can be set with %[1]s--git-protocol%[1]s, + or during the interactive prompting. Although login is for a single account on a host, setting + the git protocol will take effect for all users on the host. + + Specifying %[1]sssh%[1]s for the git protocol will detect existing SSH keys to upload, + prompting to create and upload a new key if one is not found. This can be skipped with + %[1]s--skip-ssh-key%[1]s flag. `, "`"), Example: heredoc.Doc(` - # start interactive setup + # Start interactive setup $ gh auth login - # authenticate against github.com by reading the token from a file + # Authenticate against github.com by reading the token from a file $ gh auth login --with-token < mytoken.txt - # authenticate with a specific GitHub instance + # Authenticate with specific host $ gh auth login --hostname enterprise.internal `), RunE: func(cmd *cobra.Command, args []string) error { @@ -123,7 +136,7 @@ func NewCmdLogin(f *cmdutil.Factory, runF func(*LoginOptions) error) *cobra.Comm cmd.Flags().StringSliceVarP(&opts.Scopes, "scopes", "s", nil, "Additional authentication scopes to request") cmd.Flags().BoolVar(&tokenStdin, "with-token", false, "Read token from standard input") cmd.Flags().BoolVarP(&opts.Web, "web", "w", false, "Open a browser to authenticate") - cmdutil.StringEnumFlag(cmd, &opts.GitProtocol, "git-protocol", "p", "", []string{"ssh", "https"}, "The protocol to use for git operations") + cmdutil.StringEnumFlag(cmd, &opts.GitProtocol, "git-protocol", "p", "", []string{"ssh", "https"}, "The protocol to use for git operations on this host") // secure storage became the default on 2023/4/04; this flag is left as a no-op for backwards compatibility var secureStorage bool @@ -131,6 +144,7 @@ func NewCmdLogin(f *cmdutil.Factory, runF func(*LoginOptions) error) *cobra.Comm _ = cmd.Flags().MarkHidden("secure-storage") cmd.Flags().BoolVar(&opts.InsecureStorage, "insecure-storage", false, "Save authentication credentials in plain text instead of credential store") + cmd.Flags().BoolVar(&opts.SkipSSHKeyPrompt, "skip-ssh-key", false, "Skip generate/upload SSH key prompt") return cmd } @@ -171,37 +185,39 @@ func loginRun(opts *LoginOptions) error { if err := shared.HasMinimumScopes(httpClient, hostname, opts.Token); err != nil { return fmt.Errorf("error validating token: %w", err) } - // Adding a user key ensures that a nonempty host section gets written to the config file. - return authCfg.Login(hostname, "x-access-token", opts.Token, opts.GitProtocol, !opts.InsecureStorage) - } - - existingToken, _ := authCfg.Token(hostname) - if existingToken != "" && opts.Interactive { - if err := shared.HasMinimumScopes(httpClient, hostname, existingToken); err == nil { - keepGoing, err := opts.Prompter.Confirm(fmt.Sprintf("You're already logged into %s. Do you want to re-authenticate?", hostname), false) - if err != nil { - return err - } - if !keepGoing { - return nil - } + username, err := shared.GetCurrentLogin(httpClient, hostname, opts.Token) + if err != nil { + return fmt.Errorf("error retrieving current user: %w", err) } + + // Adding a user key ensures that a nonempty host section gets written to the config file. + _, loginErr := authCfg.Login(hostname, username, opts.Token, opts.GitProtocol, !opts.InsecureStorage) + return loginErr } return shared.Login(&shared.LoginOptions{ - IO: opts.IO, - Config: authCfg, - HTTPClient: httpClient, - Hostname: hostname, - Interactive: opts.Interactive, - Web: opts.Web, - Scopes: opts.Scopes, - Executable: opts.MainExecutable, - GitProtocol: opts.GitProtocol, - Prompter: opts.Prompter, - GitClient: opts.GitClient, - Browser: opts.Browser, - SecureStorage: !opts.InsecureStorage, + IO: opts.IO, + Config: authCfg, + HTTPClient: httpClient, + Hostname: hostname, + Interactive: opts.Interactive, + Web: opts.Web, + Scopes: opts.Scopes, + GitProtocol: opts.GitProtocol, + Prompter: opts.Prompter, + Browser: opts.Browser, + CredentialFlow: &shared.GitCredentialFlow{ + Prompter: opts.Prompter, + HelperConfig: &gitcredentials.HelperConfig{ + SelfExecutablePath: opts.MainExecutable, + GitClient: opts.GitClient, + }, + Updater: &gitcredentials.Updater{ + GitClient: opts.GitClient, + }, + }, + SecureStorage: !opts.InsecureStorage, + SkipSSHKeyPrompt: opts.SkipSSHKeyPrompt, }) } diff --git a/pkg/cmd/auth/login/login_test.go b/pkg/cmd/auth/login/login_test.go index 72d796a39..d53dd3f0b 100644 --- a/pkg/cmd/auth/login/login_test.go +++ b/pkg/cmd/auth/login/login_test.go @@ -10,6 +10,7 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/git" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/prompter" "github.com/cli/cli/v2/internal/run" "github.com/cli/cli/v2/pkg/cmdutil" @@ -17,7 +18,7 @@ import ( "github.com/cli/cli/v2/pkg/iostreams" "github.com/google/shlex" "github.com/stretchr/testify/assert" - "github.com/zalando/go-keyring" + "github.com/stretchr/testify/require" ) func stubHomeDir(t *testing.T, dir string) { @@ -42,17 +43,16 @@ func Test_NewCmdLogin(t *testing.T) { wantsErr bool }{ { - name: "nontty, with-token", - stdin: "abc123\n", - cli: "--with-token", - defaultHost: "github.com", + name: "nontty, with-token", + stdin: "abc123\n", + cli: "--with-token", wants: LoginOptions{ Hostname: "github.com", Token: "abc123", }, }, { - name: "nontty, Enterprise host", + name: "nontty, with-token, enterprise default host", stdin: "abc123\n", cli: "--with-token", defaultHost: "git.example.com", @@ -205,10 +205,32 @@ func Test_NewCmdLogin(t *testing.T) { InsecureStorage: true, }, }, + { + name: "tty skip-ssh-key", + stdinTTY: true, + cli: "--skip-ssh-key", + wants: LoginOptions{ + SkipSSHKeyPrompt: true, + Interactive: true, + }, + }, + { + name: "nontty skip-ssh-key", + cli: "--skip-ssh-key", + wants: LoginOptions{ + Hostname: "github.com", + SkipSSHKeyPrompt: true, + }, + }, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { + // Make sure there is a default host set so that + // the local configuration file never read from. + if tt.defaultHost == "" { + tt.defaultHost = "github.com" + } t.Setenv("GH_HOST", tt.defaultHost) ios, stdin, _, _ := iostreams.Test() @@ -258,8 +280,9 @@ func Test_loginRun_nontty(t *testing.T) { tests := []struct { name string opts *LoginOptions + env map[string]string httpStubs func(*httpmock.Registry) - cfgStubs func(*config.ConfigMock) + cfgStubs func(*testing.T, gh.Config) wantHosts string wantErr string wantStderr string @@ -274,8 +297,11 @@ func Test_loginRun_nontty(t *testing.T) { }, httpStubs: func(reg *httpmock.Registry) { reg.Register(httpmock.REST("GET", ""), httpmock.ScopesResponder("repo,read:org")) + reg.Register( + httpmock.GraphQL(`query UserCurrent\b`), + httpmock.StringResponse(`{"data":{"viewer":{"login":"monalisa"}}}`)) }, - wantHosts: "github.com:\n oauth_token: abc123\n user: x-access-token\n", + wantHosts: "github.com:\n users:\n monalisa:\n oauth_token: abc123\n oauth_token: abc123\n user: monalisa\n", }, { name: "insecure with token and https git-protocol", @@ -287,8 +313,11 @@ func Test_loginRun_nontty(t *testing.T) { }, httpStubs: func(reg *httpmock.Registry) { reg.Register(httpmock.REST("GET", ""), httpmock.ScopesResponder("repo,read:org")) + reg.Register( + httpmock.GraphQL(`query UserCurrent\b`), + httpmock.StringResponse(`{"data":{"viewer":{"login":"monalisa"}}}`)) }, - wantHosts: "github.com:\n oauth_token: abc123\n user: x-access-token\n git_protocol: https\n", + wantHosts: "github.com:\n users:\n monalisa:\n oauth_token: abc123\n git_protocol: https\n oauth_token: abc123\n user: monalisa\n", }, { name: "with token and non-default host", @@ -299,8 +328,11 @@ func Test_loginRun_nontty(t *testing.T) { }, httpStubs: func(reg *httpmock.Registry) { reg.Register(httpmock.REST("GET", "api/v3/"), httpmock.ScopesResponder("repo,read:org")) + reg.Register( + httpmock.GraphQL(`query UserCurrent\b`), + httpmock.StringResponse(`{"data":{"viewer":{"login":"monalisa"}}}`)) }, - wantHosts: "albert.wesker:\n oauth_token: abc123\n user: x-access-token\n", + wantHosts: "albert.wesker:\n users:\n monalisa:\n oauth_token: abc123\n oauth_token: abc123\n user: monalisa\n", }, { name: "missing repo scope", @@ -333,8 +365,11 @@ func Test_loginRun_nontty(t *testing.T) { }, httpStubs: func(reg *httpmock.Registry) { reg.Register(httpmock.REST("GET", ""), httpmock.ScopesResponder("repo,admin:org")) + reg.Register( + httpmock.GraphQL(`query UserCurrent\b`), + httpmock.StringResponse(`{"data":{"viewer":{"login":"monalisa"}}}`)) }, - wantHosts: "github.com:\n oauth_token: abc456\n user: x-access-token\n", + wantHosts: "github.com:\n users:\n monalisa:\n oauth_token: abc456\n oauth_token: abc456\n user: monalisa\n", }, { name: "github.com token from environment", @@ -342,18 +377,12 @@ func Test_loginRun_nontty(t *testing.T) { Hostname: "github.com", Token: "abc456", }, - cfgStubs: func(c *config.ConfigMock) { - authCfg := c.Authentication() - authCfg.SetToken("value_from_env", "GH_TOKEN") - c.AuthenticationFunc = func() *config.AuthConfig { - return authCfg - } - }, + env: map[string]string{"GH_TOKEN": "value_from_env"}, wantErr: "SilentError", wantStderr: heredoc.Doc(` - The value of the GH_TOKEN environment variable is being used for authentication. - To have GitHub CLI store credentials instead, first clear the value from the environment. - `), + The value of the GH_TOKEN environment variable is being used for authentication. + To have GitHub CLI store credentials instead, first clear the value from the environment. + `), }, { name: "GHE token from environment", @@ -361,18 +390,12 @@ func Test_loginRun_nontty(t *testing.T) { Hostname: "ghe.io", Token: "abc456", }, - cfgStubs: func(c *config.ConfigMock) { - authCfg := c.Authentication() - authCfg.SetToken("value_from_env", "GH_ENTERPRISE_TOKEN") - c.AuthenticationFunc = func() *config.AuthConfig { - return authCfg - } - }, + env: map[string]string{"GH_ENTERPRISE_TOKEN": "value_from_env"}, wantErr: "SilentError", wantStderr: heredoc.Doc(` - The value of the GH_ENTERPRISE_TOKEN environment variable is being used for authentication. - To have GitHub CLI store credentials instead, first clear the value from the environment. - `), + The value of the GH_ENTERPRISE_TOKEN environment variable is being used for authentication. + To have GitHub CLI store credentials instead, first clear the value from the environment. + `), }, { name: "with token and secure storage", @@ -382,10 +405,40 @@ func Test_loginRun_nontty(t *testing.T) { }, httpStubs: func(reg *httpmock.Registry) { reg.Register(httpmock.REST("GET", ""), httpmock.ScopesResponder("repo,read:org")) + reg.Register( + httpmock.GraphQL(`query UserCurrent\b`), + httpmock.StringResponse(`{"data":{"viewer":{"login":"monalisa"}}}`)) }, - wantHosts: "github.com:\n user: x-access-token\n", + wantHosts: "github.com:\n users:\n monalisa:\n user: monalisa\n", wantSecureToken: "abc123", }, + { + name: "given we are already logged in, and log in as a new user, it is added to the config", + opts: &LoginOptions{ + Hostname: "github.com", + Token: "newUserToken", + }, + cfgStubs: func(t *testing.T, c gh.Config) { + _, err := c.Authentication().Login("github.com", "monalisa", "abc123", "https", false) + require.NoError(t, err) + }, + httpStubs: func(reg *httpmock.Registry) { + reg.Register(httpmock.REST("GET", ""), httpmock.ScopesResponder("repo,read:org")) + reg.Register( + httpmock.GraphQL(`query UserCurrent\b`), + httpmock.StringResponse(`{"data":{"viewer":{"login":"newUser"}}}`)) + }, + wantHosts: heredoc.Doc(` + github.com: + users: + monalisa: + oauth_token: abc123 + newUser: + git_protocol: https + user: newUser + `), + wantSecureToken: "newUserToken", + }, } for _, tt := range tests { @@ -395,13 +448,11 @@ func Test_loginRun_nontty(t *testing.T) { ios.SetStdoutTTY(false) tt.opts.IO = ios - keyring.MockInit() - readConfigs := config.StubWriteConfig(t) - cfg := config.NewBlankConfig() + cfg, readConfigs := config.NewIsolatedTestConfig(t) if tt.cfgStubs != nil { - tt.cfgStubs(cfg) + tt.cfgStubs(t, cfg) } - tt.opts.Config = func() (config.Config, error) { + tt.opts.Config = func() (gh.Config, error) { return cfg, nil } @@ -414,6 +465,10 @@ func Test_loginRun_nontty(t *testing.T) { tt.httpStubs(reg) } + for k, v := range tt.env { + t.Setenv(k, v) + } + _, restoreRun := run.Stub() defer restoreRun(t) @@ -446,37 +501,11 @@ func Test_loginRun_Survey(t *testing.T) { httpStubs func(*httpmock.Registry) prompterStubs func(*prompter.PrompterMock) runStubs func(*run.CommandStubber) - cfgStubs func(*config.ConfigMock) + cfgStubs func(*testing.T, gh.Config) wantHosts string wantErrOut *regexp.Regexp wantSecureToken string }{ - { - name: "already authenticated", - opts: &LoginOptions{ - Interactive: true, - }, - cfgStubs: func(c *config.ConfigMock) { - authCfg := c.Authentication() - authCfg.SetToken("ghi789", "oauth_token") - c.AuthenticationFunc = func() *config.AuthConfig { - return authCfg - } - }, - httpStubs: func(reg *httpmock.Registry) { - reg.Register(httpmock.REST("GET", ""), httpmock.ScopesResponder("repo,read:org")) - }, - prompterStubs: func(pm *prompter.PrompterMock) { - pm.SelectFunc = func(prompt, _ string, opts []string) (int, error) { - if prompt == "What account do you want to log into?" { - return prompter.IndexFor(opts, "GitHub.com") - } - return -1, prompter.NoSuchPromptErr(prompt) - } - }, - wantHosts: "", - wantErrOut: nil, - }, { name: "hostname set", opts: &LoginOptions{ @@ -485,15 +514,18 @@ func Test_loginRun_Survey(t *testing.T) { InsecureStorage: true, }, wantHosts: heredoc.Doc(` - rebecca.chambers: - oauth_token: def456 - user: jillv - git_protocol: https - `), + rebecca.chambers: + users: + jillv: + oauth_token: def456 + git_protocol: https + oauth_token: def456 + user: jillv + `), prompterStubs: func(pm *prompter.PrompterMock) { pm.SelectFunc = func(prompt, _ string, opts []string) (int, error) { switch prompt { - case "What is your preferred protocol for Git operations?": + case "What is your preferred protocol for Git operations on this host?": return prompter.IndexFor(opts, "HTTPS") case "How would you like to authenticate GitHub CLI?": return prompter.IndexFor(opts, "Paste an authentication token") @@ -516,11 +548,14 @@ func Test_loginRun_Survey(t *testing.T) { { name: "choose enterprise", wantHosts: heredoc.Doc(` - brad.vickers: - oauth_token: def456 - user: jillv - git_protocol: https - `), + brad.vickers: + users: + jillv: + oauth_token: def456 + git_protocol: https + oauth_token: def456 + user: jillv + `), opts: &LoginOptions{ Interactive: true, InsecureStorage: true, @@ -530,7 +565,7 @@ func Test_loginRun_Survey(t *testing.T) { switch prompt { case "What account do you want to log into?": return prompter.IndexFor(opts, "GitHub Enterprise Server") - case "What is your preferred protocol for Git operations?": + case "What is your preferred protocol for Git operations on this host?": return prompter.IndexFor(opts, "HTTPS") case "How would you like to authenticate GitHub CLI?": return prompter.IndexFor(opts, "Paste an authentication token") @@ -556,11 +591,14 @@ func Test_loginRun_Survey(t *testing.T) { { name: "choose github.com", wantHosts: heredoc.Doc(` - github.com: - oauth_token: def456 - user: jillv - git_protocol: https - `), + github.com: + users: + jillv: + oauth_token: def456 + git_protocol: https + oauth_token: def456 + user: jillv + `), opts: &LoginOptions{ Interactive: true, InsecureStorage: true, @@ -570,7 +608,7 @@ func Test_loginRun_Survey(t *testing.T) { switch prompt { case "What account do you want to log into?": return prompter.IndexFor(opts, "GitHub.com") - case "What is your preferred protocol for Git operations?": + case "What is your preferred protocol for Git operations on this host?": return prompter.IndexFor(opts, "HTTPS") case "How would you like to authenticate GitHub CLI?": return prompter.IndexFor(opts, "Paste an authentication token") @@ -587,11 +625,14 @@ func Test_loginRun_Survey(t *testing.T) { { name: "sets git_protocol", wantHosts: heredoc.Doc(` - github.com: - oauth_token: def456 - user: jillv - git_protocol: ssh - `), + github.com: + users: + jillv: + oauth_token: def456 + git_protocol: ssh + oauth_token: def456 + user: jillv + `), opts: &LoginOptions{ Interactive: true, InsecureStorage: true, @@ -601,7 +642,7 @@ func Test_loginRun_Survey(t *testing.T) { switch prompt { case "What account do you want to log into?": return prompter.IndexFor(opts, "GitHub.com") - case "What is your preferred protocol for Git operations?": + case "What is your preferred protocol for Git operations on this host?": return prompter.IndexFor(opts, "SSH") case "How would you like to authenticate GitHub CLI?": return prompter.IndexFor(opts, "Paste an authentication token") @@ -620,7 +661,7 @@ func Test_loginRun_Survey(t *testing.T) { prompterStubs: func(pm *prompter.PrompterMock) { pm.SelectFunc = func(prompt, _ string, opts []string) (int, error) { switch prompt { - case "What is your preferred protocol for Git operations?": + case "What is your preferred protocol for Git operations on this host?": return prompter.IndexFor(opts, "HTTPS") case "How would you like to authenticate GitHub CLI?": return prompter.IndexFor(opts, "Paste an authentication token") @@ -633,13 +674,58 @@ func Test_loginRun_Survey(t *testing.T) { rs.Register(`git config credential\.helper`, 1, "") }, wantHosts: heredoc.Doc(` - github.com: - user: jillv - git_protocol: https - `), + github.com: + git_protocol: https + users: + jillv: + user: jillv + `), wantErrOut: regexp.MustCompile("Logged in as jillv"), wantSecureToken: "def456", }, + { + name: "given we log in as a user that is already in the config, we get an informational message", + opts: &LoginOptions{ + Hostname: "github.com", + Interactive: true, + InsecureStorage: true, + }, + prompterStubs: func(pm *prompter.PrompterMock) { + pm.SelectFunc = func(prompt, _ string, opts []string) (int, error) { + switch prompt { + case "What is your preferred protocol for Git operations on this host?": + return prompter.IndexFor(opts, "HTTPS") + case "How would you like to authenticate GitHub CLI?": + return prompter.IndexFor(opts, "Paste an authentication token") + } + return -1, prompter.NoSuchPromptErr(prompt) + } + }, + cfgStubs: func(t *testing.T, c gh.Config) { + _, err := c.Authentication().Login("github.com", "monalisa", "abc123", "https", false) + require.NoError(t, err) + }, + runStubs: func(rs *run.CommandStubber) { + rs.Register(`git config credential\.https:/`, 1, "") + rs.Register(`git config credential\.helper`, 1, "") + }, + httpStubs: func(reg *httpmock.Registry) { + reg.Register(httpmock.REST("GET", ""), httpmock.ScopesResponder("repo,read:org")) + reg.Register( + httpmock.GraphQL(`query UserCurrent\b`), + httpmock.StringResponse(`{"data":{"viewer":{"login":"monalisa"}}}`)) + }, + wantHosts: heredoc.Doc(` + github.com: + users: + monalisa: + oauth_token: def456 + git_protocol: https + user: monalisa + oauth_token: def456 + `), + wantErrOut: regexp.MustCompile(`! You were already logged in to this account`), + }, } for _, tt := range tests { @@ -655,14 +741,11 @@ func Test_loginRun_Survey(t *testing.T) { tt.opts.IO = ios - keyring.MockInit() - readConfigs := config.StubWriteConfig(t) - - cfg := config.NewBlankConfig() + cfg, readConfigs := config.NewIsolatedTestConfig(t) if tt.cfgStubs != nil { - tt.cfgStubs(cfg) + tt.cfgStubs(t, cfg) } - tt.opts.Config = func() (config.Config, error) { + tt.opts.Config = func() (gh.Config, error) { return cfg, nil } diff --git a/pkg/cmd/auth/logout/logout.go b/pkg/cmd/auth/logout/logout.go index c871a5333..ef978ebac 100644 --- a/pkg/cmd/auth/logout/logout.go +++ b/pkg/cmd/auth/logout/logout.go @@ -1,12 +1,12 @@ package logout import ( + "errors" "fmt" - "net/http" + "slices" "github.com/MakeNowJust/heredoc" - "github.com/cli/cli/v2/api" - "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/pkg/cmd/auth/shared" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" @@ -14,41 +14,41 @@ import ( ) type LogoutOptions struct { - HttpClient func() (*http.Client, error) - IO *iostreams.IOStreams - Config func() (config.Config, error) - Prompter shared.Prompt - Hostname string + IO *iostreams.IOStreams + Config func() (gh.Config, error) + Prompter shared.Prompt + Hostname string + Username string } func NewCmdLogout(f *cmdutil.Factory, runF func(*LogoutOptions) error) *cobra.Command { opts := &LogoutOptions{ - HttpClient: f.HttpClient, - IO: f.IOStreams, - Config: f.Config, - Prompter: f.Prompter, + IO: f.IOStreams, + Config: f.Config, + Prompter: f.Prompter, } cmd := &cobra.Command{ Use: "logout", Args: cobra.ExactArgs(0), - Short: "Log out of a GitHub host", - Long: heredoc.Doc(`Remove authentication for a GitHub host. + Short: "Log out of a GitHub account", + Long: heredoc.Doc(` + Remove authentication for a GitHub account. - This command removes the authentication configuration for a host either specified - interactively or via --hostname. + This command removes the stored authentication configuration + for an account. The authentication configuration is only + removed locally. + + This command does not invalidate authentication tokens. `), Example: heredoc.Doc(` + # Select what host and account to log out of via a prompt $ gh auth logout - # => select what host to log out of via a prompt - $ gh auth logout --hostname enterprise.internal - # => log out of specified host + # Log out of a specific host and specific account + $ gh auth logout --hostname enterprise.internal --user monalisa `), RunE: func(cmd *cobra.Command, args []string) error { - if opts.Hostname == "" && !opts.IO.CanPrompt() { - return cmdutil.FlagErrorf("--hostname required when not running interactively") - } if runF != nil { return runF(opts) } @@ -58,12 +58,14 @@ func NewCmdLogout(f *cmdutil.Factory, runF func(*LogoutOptions) error) *cobra.Co } cmd.Flags().StringVarP(&opts.Hostname, "hostname", "h", "", "The hostname of the GitHub instance to log out of") + cmd.Flags().StringVarP(&opts.Username, "user", "u", "", "The account to log out of") return cmd } func logoutRun(opts *LogoutOptions) error { hostname := opts.Hostname + username := opts.Username cfg, err := opts.Config() if err != nil { @@ -71,70 +73,88 @@ func logoutRun(opts *LogoutOptions) error { } authCfg := cfg.Authentication() - candidates := authCfg.Hosts() - if len(candidates) == 0 { + knownHosts := authCfg.Hosts() + if len(knownHosts) == 0 { return fmt.Errorf("not logged in to any hosts") } - if hostname == "" { - if len(candidates) == 1 { - hostname = candidates[0] - } else { - selected, err := opts.Prompter.Select( - "What account do you want to log out of?", "", candidates) - if err != nil { - return fmt.Errorf("could not prompt: %w", err) - } - hostname = candidates[selected] - } - } else { - var found bool - for _, c := range candidates { - if c == hostname { - found = true - break - } + if hostname != "" { + if !slices.Contains(knownHosts, hostname) { + return fmt.Errorf("not logged in to %s", hostname) } - if !found { - return fmt.Errorf("not logged into %s", hostname) + if username != "" { + knownUsers := cfg.Authentication().UsersForHost(hostname) + if !slices.Contains(knownUsers, username) { + return fmt.Errorf("not logged in to %s account %s", hostname, username) + } } } + type hostUser struct { + host string + user string + } + var candidates []hostUser + + for _, host := range knownHosts { + if hostname != "" && host != hostname { + continue + } + knownUsers := cfg.Authentication().UsersForHost(host) + for _, user := range knownUsers { + if username != "" && user != username { + continue + } + candidates = append(candidates, hostUser{host: host, user: user}) + } + } + + if len(candidates) == 0 { + return errors.New("no accounts matched that criteria") + } else if len(candidates) == 1 { + hostname = candidates[0].host + username = candidates[0].user + } else if !opts.IO.CanPrompt() { + return errors.New("unable to determine which account to log out of, please specify `--hostname` and `--user`") + } else { + prompts := make([]string, len(candidates)) + for i, c := range candidates { + prompts[i] = fmt.Sprintf("%s (%s)", c.user, c.host) + } + selected, err := opts.Prompter.Select( + "What account do you want to log out of?", "", prompts) + if err != nil { + return fmt.Errorf("could not prompt: %w", err) + } + hostname = candidates[selected].host + username = candidates[selected].user + } + if src, writeable := shared.AuthTokenWriteable(authCfg, hostname); !writeable { fmt.Fprintf(opts.IO.ErrOut, "The value of the %s environment variable is being used for authentication.\n", src) fmt.Fprint(opts.IO.ErrOut, "To erase credentials stored in GitHub CLI, first clear the value from the environment.\n") return cmdutil.SilentError } - httpClient, err := opts.HttpClient() - if err != nil { + // We can ignore the error here because a host must always have an active user + preLogoutActiveUser, _ := authCfg.ActiveUser(hostname) + + if err := authCfg.Logout(hostname, username); err != nil { return err } - apiClient := api.NewClientFromHTTP(httpClient) - username, err := api.CurrentLoginName(apiClient, hostname) - if err != nil { - // suppressing; the user is trying to delete this token and it might be bad. - // we'll see if the username is in the config and fall back to that. - username, _ = authCfg.User(hostname) - } + postLogoutActiveUser, _ := authCfg.ActiveUser(hostname) + hasSwitchedToNewUser := preLogoutActiveUser != postLogoutActiveUser && + postLogoutActiveUser != "" - usernameStr := "" - if username != "" { - usernameStr = fmt.Sprintf(" account '%s'", username) - } + cs := opts.IO.ColorScheme() + fmt.Fprintf(opts.IO.ErrOut, "%s Logged out of %s account %s\n", + cs.SuccessIcon(), hostname, cs.Bold(username)) - if err := authCfg.Logout(hostname); err != nil { - return fmt.Errorf("failed to write config, authentication configuration not updated: %w", err) - } - - isTTY := opts.IO.IsStdinTTY() && opts.IO.IsStdoutTTY() - - if isTTY { - cs := opts.IO.ColorScheme() - fmt.Fprintf(opts.IO.ErrOut, "%s Logged out of %s%s\n", - cs.SuccessIcon(), cs.Bold(hostname), usernameStr) + if hasSwitchedToNewUser { + fmt.Fprintf(opts.IO.ErrOut, "%s Switched active account for %s to %s\n", + cs.SuccessIcon(), hostname, cs.Bold(postLogoutActiveUser)) } return nil diff --git a/pkg/cmd/auth/logout/logout_test.go b/pkg/cmd/auth/logout/logout_test.go index 75c215aaa..02386c55b 100644 --- a/pkg/cmd/auth/logout/logout_test.go +++ b/pkg/cmd/auth/logout/logout_test.go @@ -2,58 +2,86 @@ package logout import ( "bytes" - "fmt" - "net/http" + "io" "regexp" "testing" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/prompter" "github.com/cli/cli/v2/pkg/cmdutil" - "github.com/cli/cli/v2/pkg/httpmock" "github.com/cli/cli/v2/pkg/iostreams" "github.com/google/shlex" - "github.com/stretchr/testify/assert" - "github.com/zalando/go-keyring" + "github.com/stretchr/testify/require" ) func Test_NewCmdLogout(t *testing.T) { tests := []struct { - name string - cli string - wants LogoutOptions - wantsErr bool - tty bool + name string + cli string + wants LogoutOptions + tty bool }{ { - name: "nontty no arguments", - cli: "", - wantsErr: true, + name: "nontty no arguments", + cli: "", + wants: LogoutOptions{}, }, { - name: "tty no arguments", - tty: true, - cli: "", - wants: LogoutOptions{ - Hostname: "", - }, + name: "tty no arguments", + tty: true, + cli: "", + wants: LogoutOptions{}, }, { name: "tty with hostname", tty: true, - cli: "--hostname harry.mason", + cli: "--hostname github.com", wants: LogoutOptions{ - Hostname: "harry.mason", + Hostname: "github.com", }, }, { name: "nontty with hostname", - cli: "--hostname harry.mason", + cli: "--hostname github.com", wants: LogoutOptions{ - Hostname: "harry.mason", + Hostname: "github.com", + }, + }, + { + name: "tty with user", + tty: true, + cli: "--user monalisa", + wants: LogoutOptions{ + Username: "github.com", + }, + }, + { + name: "nontty with user", + cli: "--user monalisa", + wants: LogoutOptions{ + Username: "github.com", + }, + }, + { + name: "tty with hostname and user", + tty: true, + cli: "--hostname github.com --user monalisa", + wants: LogoutOptions{ + Hostname: "github.com", + Username: "monalisa", + }, + }, + { + name: "nontty with hostname and user", + cli: "--hostname github.com --user monalisa", + wants: LogoutOptions{ + Hostname: "github.com", + Username: "monalisa", }, }, } + for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { ios, _, _, _ := iostreams.Test() @@ -64,7 +92,7 @@ func Test_NewCmdLogout(t *testing.T) { ios.SetStdoutTTY(tt.tty) argv, err := shlex.Split(tt.cli) - assert.NoError(t, err) + require.NoError(t, err) var gotOpts *LogoutOptions cmd := NewCmdLogout(f, func(opts *LogoutOptions) error { @@ -80,89 +108,222 @@ func Test_NewCmdLogout(t *testing.T) { cmd.SetErr(&bytes.Buffer{}) _, err = cmd.ExecuteC() - if tt.wantsErr { - assert.Error(t, err) - return - } - assert.NoError(t, err) + require.NoError(t, err) - assert.Equal(t, tt.wants.Hostname, gotOpts.Hostname) + require.Equal(t, tt.wants.Hostname, gotOpts.Hostname) }) - } } +type user struct { + name string + token string +} + +type hostUsers struct { + host string + users []user +} + +type tokenAssertion func(t *testing.T, cfg gh.Config) + func Test_logoutRun_tty(t *testing.T) { tests := []struct { name string opts *LogoutOptions prompterStubs func(*prompter.PrompterMock) - cfgHosts []string + cfgHosts []hostUsers secureStorage bool wantHosts string + assertToken tokenAssertion wantErrOut *regexp.Regexp wantErr string }{ { - name: "no arguments, multiple hosts", - opts: &LogoutOptions{}, - cfgHosts: []string{"cheryl.mason", "github.com"}, - wantHosts: "cheryl.mason:\n oauth_token: abc123\n", + name: "logs out prompted user when multiple known hosts with one user each", + opts: &LogoutOptions{}, + cfgHosts: []hostUsers{ + {"ghe.io", []user{ + {"monalisa-ghe", "abc123"}, + }}, + {"github.com", []user{ + {"monalisa", "abc123"}, + }}, + }, prompterStubs: func(pm *prompter.PrompterMock) { pm.SelectFunc = func(_, _ string, opts []string) (int, error) { - return prompter.IndexFor(opts, "github.com") + return prompter.IndexFor(opts, "monalisa (github.com)") } }, - wantErrOut: regexp.MustCompile(`Logged out of github.com account 'cybilb'`), + assertToken: hasNoToken("github.com"), + wantHosts: "ghe.io:\n users:\n monalisa-ghe:\n oauth_token: abc123\n git_protocol: ssh\n oauth_token: abc123\n user: monalisa-ghe\n", + wantErrOut: regexp.MustCompile(`Logged out of github.com account monalisa`), }, { - name: "no arguments, one host", - opts: &LogoutOptions{}, - cfgHosts: []string{"github.com"}, - wantHosts: "{}\n", - wantErrOut: regexp.MustCompile(`Logged out of github.com account 'cybilb'`), + name: "logs out prompted user when multiple known hosts with multiple users each", + opts: &LogoutOptions{}, + cfgHosts: []hostUsers{ + {"ghe.io", []user{ + {"monalisa-ghe", "abc123"}, + {"monalisa-ghe2", "abc123"}, + }}, + {"github.com", []user{ + {"monalisa", "monalisa-token"}, + {"monalisa2", "monalisa2-token"}, + }}, + }, + prompterStubs: func(pm *prompter.PrompterMock) { + pm.SelectFunc = func(_, _ string, opts []string) (int, error) { + return prompter.IndexFor(opts, "monalisa (github.com)") + } + }, + assertToken: hasActiveToken("github.com", "monalisa2-token"), + wantHosts: "ghe.io:\n users:\n monalisa-ghe:\n oauth_token: abc123\n monalisa-ghe2:\n oauth_token: abc123\n git_protocol: ssh\n user: monalisa-ghe2\n oauth_token: abc123\ngithub.com:\n users:\n monalisa2:\n oauth_token: monalisa2-token\n git_protocol: ssh\n user: monalisa2\n oauth_token: monalisa2-token\n", + wantErrOut: regexp.MustCompile(`Logged out of github.com account monalisa`), }, { - name: "no arguments, no hosts", + name: "logs out only logged in user", + opts: &LogoutOptions{}, + cfgHosts: []hostUsers{ + {"github.com", []user{ + {"monalisa", "abc123"}, + }}, + }, + wantHosts: "{}\n", + assertToken: hasNoToken("github.com"), + wantErrOut: regexp.MustCompile(`Logged out of github.com account monalisa`), + }, + { + name: "logs out prompted user when one known host with multiple users", + opts: &LogoutOptions{}, + cfgHosts: []hostUsers{ + {"github.com", []user{ + {"monalisa", "monalisa-token"}, + {"monalisa2", "monalisa2-token"}, + }}, + }, + prompterStubs: func(pm *prompter.PrompterMock) { + pm.SelectFunc = func(_, _ string, opts []string) (int, error) { + return prompter.IndexFor(opts, "monalisa (github.com)") + } + }, + wantHosts: "github.com:\n users:\n monalisa2:\n oauth_token: monalisa2-token\n git_protocol: ssh\n user: monalisa2\n oauth_token: monalisa2-token\n", + assertToken: hasActiveToken("github.com", "monalisa2-token"), + wantErrOut: regexp.MustCompile(`Logged out of github.com account monalisa`), + }, + { + name: "logs out specified user when multiple known hosts with one user each", + opts: &LogoutOptions{ + Hostname: "ghe.io", + Username: "monalisa-ghe", + }, + cfgHosts: []hostUsers{ + {"ghe.io", []user{ + {"monalisa-ghe", "abc123"}, + }}, + {"github.com", []user{ + {"monalisa", "abc123"}, + }}, + }, + wantHosts: "github.com:\n users:\n monalisa:\n oauth_token: abc123\n git_protocol: ssh\n oauth_token: abc123\n user: monalisa\n", + assertToken: hasNoToken("ghe.io"), + wantErrOut: regexp.MustCompile(`Logged out of ghe.io account monalisa-ghe`), + }, + { + name: "logs out specified user that is using secure storage", + secureStorage: true, + opts: &LogoutOptions{ + Hostname: "github.com", + Username: "monalisa", + }, + cfgHosts: []hostUsers{ + {"github.com", []user{ + {"monalisa", "abc123"}, + }}, + }, + wantHosts: "{}\n", + assertToken: hasNoToken("github.com"), + wantErrOut: regexp.MustCompile(`Logged out of github.com account monalisa`), + }, + { + name: "errors when no known hosts", opts: &LogoutOptions{}, wantErr: `not logged in to any hosts`, }, { - name: "hostname", + name: "errors when specified host is not a known host", opts: &LogoutOptions{ - Hostname: "cheryl.mason", + Hostname: "ghe.io", + Username: "monalisa-ghe", }, - cfgHosts: []string{"cheryl.mason", "github.com"}, - wantHosts: "github.com:\n oauth_token: abc123\n", - wantErrOut: regexp.MustCompile(`Logged out of cheryl.mason account 'cybilb'`), + cfgHosts: []hostUsers{ + {"github.com", []user{ + {"monalisa", "abc123"}, + }}, + }, + wantErr: "not logged in to ghe.io", }, { - name: "secure storage", - secureStorage: true, + name: "errors when specified user is not logged in on specified host", + opts: &LogoutOptions{ + Hostname: "ghe.io", + Username: "unknown-user", + }, + cfgHosts: []hostUsers{ + {"ghe.io", []user{ + {"monalisa-ghe", "abc123"}, + }}, + }, + wantErr: "not logged in to ghe.io account unknown-user", + }, + { + name: "errors when user is specified but doesn't exist on any host", + opts: &LogoutOptions{ + Username: "unknown-user", + }, + cfgHosts: []hostUsers{ + {"ghe.io", []user{ + {"monalisa-ghe", "abc123"}, + }}, + {"github.com", []user{ + {"monalisa", "abc123"}, + }}, + }, + wantErr: "no accounts matched that criteria", + }, + { + name: "switches user if there is another one available", opts: &LogoutOptions{ Hostname: "github.com", + Username: "monalisa2", }, - cfgHosts: []string{"github.com"}, - wantHosts: "{}\n", - wantErrOut: regexp.MustCompile(`Logged out of github.com account 'cybilb'`), + cfgHosts: []hostUsers{ + {"github.com", []user{ + {"monalisa", "monalisa-token"}, + {"monalisa2", "monalisa2-token"}, + }}, + }, + wantHosts: "github.com:\n users:\n monalisa:\n oauth_token: monalisa-token\n git_protocol: ssh\n user: monalisa\n oauth_token: monalisa-token\n", + assertToken: hasActiveToken("github.com", "monalisa-token"), + wantErrOut: regexp.MustCompile("✓ Switched active account for github.com to monalisa"), }, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { - keyring.MockInit() - readConfigs := config.StubWriteConfig(t) - cfg := config.NewFromString("") - for _, hostname := range tt.cfgHosts { - if tt.secureStorage { - cfg.Set(hostname, "user", "monalisa") - _ = keyring.Set(fmt.Sprintf("gh:%s", hostname), "", "abc123") - cfg.Authentication().SetToken("abc123", "keyring") - } else { - cfg.Set(hostname, "oauth_token", "abc123") + cfg, readConfigs := config.NewIsolatedTestConfig(t) + + for _, hostUsers := range tt.cfgHosts { + for _, user := range hostUsers.users { + _, _ = cfg.Authentication().Login( + string(hostUsers.host), + user.name, + user.token, "ssh", tt.secureStorage, + ) } } - tt.opts.Config = func() (config.Config, error) { + + tt.opts.Config = func() (gh.Config, error) { return cfg, nil } @@ -171,15 +332,6 @@ func Test_logoutRun_tty(t *testing.T) { ios.SetStdoutTTY(true) tt.opts.IO = ios - reg := &httpmock.Registry{} - reg.Register( - httpmock.GraphQL(`query UserCurrent\b`), - httpmock.StringResponse(`{"data":{"viewer":{"login":"cybilb"}}}`), - ) - tt.opts.HttpClient = func() (*http.Client, error) { - return &http.Client{Transport: reg}, nil - } - pm := &prompter.PrompterMock{} if tt.prompterStubs != nil { tt.prompterStubs(pm) @@ -188,26 +340,26 @@ func Test_logoutRun_tty(t *testing.T) { err := logoutRun(tt.opts) if tt.wantErr != "" { - assert.EqualError(t, err, tt.wantErr) + require.EqualError(t, err, tt.wantErr) return } else { - assert.NoError(t, err) + require.NoError(t, err) } if tt.wantErrOut == nil { - assert.Equal(t, "", stderr.String()) + require.Equal(t, "", stderr.String()) } else { - assert.True(t, tt.wantErrOut.MatchString(stderr.String())) + require.True(t, tt.wantErrOut.MatchString(stderr.String()), stderr.String()) } - mainBuf := bytes.Buffer{} hostsBuf := bytes.Buffer{} - readConfigs(&mainBuf, &hostsBuf) - secureToken, _ := cfg.Authentication().TokenFromKeyring(tt.opts.Hostname) + readConfigs(io.Discard, &hostsBuf) - assert.Equal(t, tt.wantHosts, hostsBuf.String()) - assert.Equal(t, "", secureToken) - reg.Verify(t) + require.Equal(t, tt.wantHosts, hostsBuf.String()) + + if tt.assertToken != nil { + tt.assertToken(t, cfg) + } }) } } @@ -216,61 +368,156 @@ func Test_logoutRun_nontty(t *testing.T) { tests := []struct { name string opts *LogoutOptions - cfgHosts []string + cfgHosts []hostUsers secureStorage bool - ghtoken string wantHosts string + assertToken tokenAssertion + wantErrOut *regexp.Regexp wantErr string }{ { - name: "hostname, one host", + name: "logs out specified user when one known host", opts: &LogoutOptions{ - Hostname: "harry.mason", + Hostname: "github.com", + Username: "monalisa", }, - cfgHosts: []string{"harry.mason"}, - wantHosts: "{}\n", + cfgHosts: []hostUsers{ + {"github.com", []user{ + {"monalisa", "abc123"}, + }}, + }, + wantHosts: "{}\n", + assertToken: hasNoToken("github.com"), + wantErrOut: regexp.MustCompile(`Logged out of github.com account monalisa`), }, { - name: "hostname, multiple hosts", + name: "logs out specified user when multiple known hosts", opts: &LogoutOptions{ - Hostname: "harry.mason", + Hostname: "github.com", + Username: "monalisa", }, - cfgHosts: []string{"harry.mason", "cheryl.mason"}, - wantHosts: "cheryl.mason:\n oauth_token: abc123\n", + cfgHosts: []hostUsers{ + {"github.com", []user{ + {"monalisa", "abc123"}, + }}, + {"ghe.io", []user{ + {"monalisa-ghe", "abc123"}, + }}, + }, + wantHosts: "ghe.io:\n users:\n monalisa-ghe:\n oauth_token: abc123\n git_protocol: ssh\n oauth_token: abc123\n user: monalisa-ghe\n", + assertToken: hasNoToken("github.com"), + wantErrOut: regexp.MustCompile(`Logged out of github.com account monalisa`), }, { - name: "hostname, no hosts", + name: "logs out specified user that is using secure storage", + secureStorage: true, opts: &LogoutOptions{ - Hostname: "harry.mason", + Hostname: "github.com", + Username: "monalisa", + }, + cfgHosts: []hostUsers{ + {"github.com", []user{ + {"monalisa", "abc123"}, + }}, + }, + wantHosts: "{}\n", + assertToken: hasNoToken("github.com"), + wantErrOut: regexp.MustCompile(`Logged out of github.com account monalisa`), + }, + { + name: "errors when no known hosts", + opts: &LogoutOptions{ + Hostname: "github.com", + Username: "monalisa", }, wantErr: `not logged in to any hosts`, }, { - name: "secure storage", - secureStorage: true, + name: "errors when specified host is not a known host", opts: &LogoutOptions{ - Hostname: "harry.mason", + Hostname: "ghe.io", + Username: "monalisa-ghe", }, - cfgHosts: []string{"harry.mason"}, - wantHosts: "{}\n", + cfgHosts: []hostUsers{ + {"github.com", []user{ + {"monalisa", "abc123"}, + }}, + }, + wantErr: "not logged in to ghe.io", + }, + { + name: "errors when specified user is not logged in on specified host", + opts: &LogoutOptions{ + Hostname: "ghe.io", + Username: "unknown-user", + }, + cfgHosts: []hostUsers{ + {"ghe.io", []user{ + {"monalisa-ghe", "abc123"}, + }}, + }, + wantErr: "not logged in to ghe.io account unknown-user", + }, + { + name: "errors when host is specified but user is ambiguous", + opts: &LogoutOptions{ + Hostname: "ghe.io", + }, + cfgHosts: []hostUsers{ + {"ghe.io", []user{ + {"monalisa-ghe", "abc123"}, + {"monalisa-ghe2", "abc123"}, + }}, + }, + wantErr: "unable to determine which account to log out of, please specify `--hostname` and `--user`", + }, + { + name: "errors when user is specified but host is ambiguous", + opts: &LogoutOptions{ + Username: "monalisa", + }, + cfgHosts: []hostUsers{ + {"github.com", []user{ + {"monalisa", "abc123"}, + }}, + {"ghe.io", []user{ + {"monalisa", "abc123"}, + }}, + }, + wantErr: "unable to determine which account to log out of, please specify `--hostname` and `--user`", + }, + { + name: "switches user if there is another one available", + opts: &LogoutOptions{ + Hostname: "github.com", + Username: "monalisa2", + }, + cfgHosts: []hostUsers{ + {"github.com", []user{ + {"monalisa", "monalisa-token"}, + {"monalisa2", "monalisa2-token"}, + }}, + }, + wantHosts: "github.com:\n users:\n monalisa:\n oauth_token: monalisa-token\n git_protocol: ssh\n user: monalisa\n oauth_token: monalisa-token\n", + assertToken: hasActiveToken("github.com", "monalisa-token"), + wantErrOut: regexp.MustCompile("✓ Switched active account for github.com to monalisa"), }, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { - keyring.MockInit() - readConfigs := config.StubWriteConfig(t) - cfg := config.NewFromString("") - for _, hostname := range tt.cfgHosts { - if tt.secureStorage { - cfg.Set(hostname, "user", "monalisa") - _ = keyring.Set(fmt.Sprintf("gh:%s", hostname), "", "abc123") - cfg.Authentication().SetToken("abc123", "keyring") - } else { - cfg.Set(hostname, "oauth_token", "abc123") + cfg, readConfigs := config.NewIsolatedTestConfig(t) + + for _, hostUsers := range tt.cfgHosts { + for _, user := range hostUsers.users { + _, _ = cfg.Authentication().Login( + string(hostUsers.host), + user.name, + user.token, "ssh", tt.secureStorage, + ) } } - tt.opts.Config = func() (config.Config, error) { + tt.opts.Config = func() (gh.Config, error) { return cfg, nil } @@ -279,28 +526,46 @@ func Test_logoutRun_nontty(t *testing.T) { ios.SetStdoutTTY(false) tt.opts.IO = ios - reg := &httpmock.Registry{} - tt.opts.HttpClient = func() (*http.Client, error) { - return &http.Client{Transport: reg}, nil - } - err := logoutRun(tt.opts) if tt.wantErr != "" { - assert.EqualError(t, err, tt.wantErr) + require.EqualError(t, err, tt.wantErr) + return } else { - assert.NoError(t, err) + require.NoError(t, err) } - assert.Equal(t, "", stderr.String()) + if tt.wantErrOut == nil { + require.Equal(t, "", stderr.String()) + } else { + require.True(t, tt.wantErrOut.MatchString(stderr.String()), stderr.String()) + } - mainBuf := bytes.Buffer{} hostsBuf := bytes.Buffer{} - readConfigs(&mainBuf, &hostsBuf) - secureToken, _ := cfg.Authentication().TokenFromKeyring(tt.opts.Hostname) + readConfigs(io.Discard, &hostsBuf) - assert.Equal(t, tt.wantHosts, hostsBuf.String()) - assert.Equal(t, "", secureToken) - reg.Verify(t) + require.Equal(t, tt.wantHosts, hostsBuf.String()) + + if tt.assertToken != nil { + tt.assertToken(t, cfg) + } }) } } + +func hasNoToken(hostname string) tokenAssertion { + return func(t *testing.T, cfg gh.Config) { + t.Helper() + + token, _ := cfg.Authentication().ActiveToken(hostname) + require.Empty(t, token) + } +} + +func hasActiveToken(hostname string, expectedToken string) tokenAssertion { + return func(t *testing.T, cfg gh.Config) { + t.Helper() + + token, _ := cfg.Authentication().ActiveToken(hostname) + require.Equal(t, expectedToken, token) + } +} diff --git a/pkg/cmd/auth/refresh/refresh.go b/pkg/cmd/auth/refresh/refresh.go index 4debd0a45..4b8a7e4c0 100644 --- a/pkg/cmd/auth/refresh/refresh.go +++ b/pkg/cmd/auth/refresh/refresh.go @@ -8,17 +8,21 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/git" "github.com/cli/cli/v2/internal/authflow" - "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/pkg/cmd/auth/shared" + "github.com/cli/cli/v2/pkg/cmd/auth/shared/gitcredentials" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" "github.com/cli/cli/v2/pkg/set" "github.com/spf13/cobra" ) +type token string +type username string + type RefreshOptions struct { IO *iostreams.IOStreams - Config func() (config.Config, error) + Config func() (gh.Config, error) HttpClient *http.Client GitClient *git.Client Prompter shared.Prompt @@ -29,7 +33,7 @@ type RefreshOptions struct { Scopes []string RemoveScopes []string ResetScopes bool - AuthFlow func(*config.AuthConfig, *iostreams.IOStreams, string, []string, bool, bool) error + AuthFlow func(*iostreams.IOStreams, string, []string, bool) (token, username, error) Interactive bool InsecureStorage bool @@ -39,16 +43,9 @@ func NewCmdRefresh(f *cmdutil.Factory, runF func(*RefreshOptions) error) *cobra. opts := &RefreshOptions{ IO: f.IOStreams, Config: f.Config, - AuthFlow: func(authCfg *config.AuthConfig, io *iostreams.IOStreams, hostname string, scopes []string, interactive, secureStorage bool) error { - if secureStorage { - cs := io.ColorScheme() - fmt.Fprintf(io.ErrOut, "%s Using secure storage could break installed extensions", cs.WarningIcon()) - } - token, username, err := authflow.AuthFlow(hostname, io, "", scopes, interactive, f.Browser) - if err != nil { - return err - } - return authCfg.Login(hostname, username, token, "", secureStorage) + AuthFlow: func(io *iostreams.IOStreams, hostname string, scopes []string, interactive bool) (token, username, error) { + t, u, err := authflow.AuthFlow(hostname, io, "", scopes, interactive, f.Browser) + return token(t), username(u), err }, HttpClient: &http.Client{}, GitClient: f.GitClient, @@ -59,19 +56,23 @@ func NewCmdRefresh(f *cmdutil.Factory, runF func(*RefreshOptions) error) *cobra. Use: "refresh", Args: cobra.ExactArgs(0), Short: "Refresh stored authentication credentials", - Long: heredoc.Doc(`Expand or fix the permission scopes for stored credentials. + Long: heredoc.Docf(`Expand or fix the permission scopes for stored credentials for active account. - The --scopes flag accepts a comma separated list of scopes you want + The %[1]s--scopes%[1]s flag accepts a comma separated list of scopes you want your gh credentials to have. If no scopes are provided, the command maintains previously added scopes. - The --remove-scopes flag accepts a comma separated list of scopes you + The %[1]s--remove-scopes%[1]s flag accepts a comma separated list of scopes you want to remove from your gh credentials. Scope removal is idempotent. - The minimum set of scopes ("repo", "read:org" and "gist") cannot be removed. + The minimum set of scopes (%[1]srepo%[1]s, %[1]sread:org%[1]s, and %[1]sgist%[1]s) cannot be removed. - The --reset-scopes flag resets the scopes for your gh credentials to + The %[1]s--reset-scopes%[1]s flag resets the scopes for your gh credentials to the default set of scopes for your auth flow. - `), + + If you have multiple accounts in %[1]sgh auth status%[1]s and want to refresh the credentials for an + inactive account, you will have to use %[1]sgh auth switch%[1]s to that account first before using + this command, and then switch back when you are done. + `, "`"), Example: heredoc.Doc(` $ gh auth refresh --scopes write:org,read:public_key # => open a browser to add write:org and read:public_key scopes @@ -160,7 +161,7 @@ func refreshRun(opts *RefreshOptions) error { additionalScopes := set.NewStringSet() if !opts.ResetScopes { - if oldToken, _ := authCfg.Token(hostname); oldToken != "" { + if oldToken, _ := authCfg.ActiveToken(hostname); oldToken != "" { if oldScopes, err := shared.GetScopes(opts.HttpClient, hostname, oldToken); err == nil { for _, s := range strings.Split(oldScopes, ",") { s = strings.TrimSpace(s) @@ -173,11 +174,16 @@ func refreshRun(opts *RefreshOptions) error { } credentialFlow := &shared.GitCredentialFlow{ - Executable: opts.MainExecutable, - Prompter: opts.Prompter, - GitClient: opts.GitClient, + Prompter: opts.Prompter, + HelperConfig: &gitcredentials.HelperConfig{ + SelfExecutablePath: opts.MainExecutable, + GitClient: opts.GitClient, + }, + Updater: &gitcredentials.Updater{ + GitClient: opts.GitClient, + }, } - gitProtocol, _ := authCfg.GitProtocol(hostname) + gitProtocol := cfg.GitProtocol(hostname).Value if opts.Interactive && gitProtocol == "https" { if err := credentialFlow.Prompt(hostname); err != nil { return err @@ -189,7 +195,15 @@ func refreshRun(opts *RefreshOptions) error { additionalScopes.RemoveValues(opts.RemoveScopes) - if err := opts.AuthFlow(authCfg, opts.IO, hostname, additionalScopes.ToSlice(), opts.Interactive, !opts.InsecureStorage); err != nil { + authedToken, authedUser, err := opts.AuthFlow(opts.IO, hostname, additionalScopes.ToSlice(), opts.Interactive) + if err != nil { + return err + } + activeUser, _ := authCfg.ActiveUser(hostname) + if activeUser != "" && username(activeUser) != authedUser { + return fmt.Errorf("error refreshing credentials for %s, received credentials for %s, did you use the correct account in the browser?", activeUser, authedUser) + } + if _, err := authCfg.Login(hostname, string(authedUser), string(authedToken), "", !opts.InsecureStorage); err != nil { return err } @@ -197,8 +211,8 @@ func refreshRun(opts *RefreshOptions) error { fmt.Fprintf(opts.IO.ErrOut, "%s Authentication complete.\n", cs.SuccessIcon()) if credentialFlow.ShouldSetup() { - username, _ := authCfg.User(hostname) - password, _ := authCfg.Token(hostname) + username, _ := authCfg.ActiveUser(hostname) + password, _ := authCfg.ActiveToken(hostname) if err := credentialFlow.Setup(hostname, username, password); err != nil { return err } diff --git a/pkg/cmd/auth/refresh/refresh_test.go b/pkg/cmd/auth/refresh/refresh_test.go index c87c2bcb8..dfc52d949 100644 --- a/pkg/cmd/auth/refresh/refresh_test.go +++ b/pkg/cmd/auth/refresh/refresh_test.go @@ -8,12 +8,13 @@ import ( "testing" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/prompter" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/httpmock" "github.com/cli/cli/v2/pkg/iostreams" "github.com/google/shlex" - "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" ) func Test_NewCmdRefresh(t *testing.T) { @@ -142,7 +143,7 @@ func Test_NewCmdRefresh(t *testing.T) { ios.SetNeverPrompt(tt.neverPrompt) argv, err := shlex.Split(tt.cli) - assert.NoError(t, err) + require.NoError(t, err) var gotOpts *RefreshOptions cmd := NewCmdRefresh(f, func(opts *RefreshOptions) error { @@ -159,12 +160,12 @@ func Test_NewCmdRefresh(t *testing.T) { _, err = cmd.ExecuteC() if tt.wantsErr { - assert.Error(t, err) + require.Error(t, err) return } - assert.NoError(t, err) - assert.Equal(t, tt.wants.Hostname, gotOpts.Hostname) - assert.Equal(t, tt.wants.Scopes, gotOpts.Scopes) + require.NoError(t, err) + require.Equal(t, tt.wants.Hostname, gotOpts.Hostname) + require.Equal(t, tt.wants.Scopes, gotOpts.Scopes) }) } } @@ -176,13 +177,19 @@ type authArgs struct { secureStorage bool } +type authOut struct { + username string + token string + err error +} + func Test_refreshRun(t *testing.T) { tests := []struct { name string opts *RefreshOptions prompterStubs func(*prompter.PrompterMock) cfgHosts []string - config config.Config + authOut authOut oldScopes string wantErr string nontty bool @@ -194,7 +201,7 @@ func Test_refreshRun(t *testing.T) { wantErr: `not logged in to any hosts`, }, { - name: "hostname given but dne", + name: "hostname given but not previously authenticated with it", cfgHosts: []string{ "github.com", "aline.cedrac", @@ -404,28 +411,38 @@ func Test_refreshRun(t *testing.T) { secureStorage: true, }, }, + { + name: "errors when active user does not match user returned by auth flow", + cfgHosts: []string{ + "github.com", + }, + authOut: authOut{ + username: "not-test-user", + token: "xyz456", + }, + opts: &RefreshOptions{}, + wantErr: "error refreshing credentials for test-user, received credentials for not-test-user, did you use the correct account in the browser?", + }, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { aa := authArgs{} - tt.opts.AuthFlow = func(_ *config.AuthConfig, _ *iostreams.IOStreams, hostname string, scopes []string, interactive, secureStorage bool) error { + tt.opts.AuthFlow = func(_ *iostreams.IOStreams, hostname string, scopes []string, interactive bool) (token, username, error) { aa.hostname = hostname aa.scopes = scopes aa.interactive = interactive - aa.secureStorage = secureStorage - return nil + if tt.authOut != (authOut{}) { + return token(tt.authOut.token), username(tt.authOut.username), tt.authOut.err + } + return token("xyz456"), username("test-user"), nil } - var cfg config.Config - if tt.config != nil { - cfg = tt.config - } else { - cfg = config.NewFromString("") - for _, hostname := range tt.cfgHosts { - cfg.Set(hostname, "oauth_token", "abc123") - } + cfg, _ := config.NewIsolatedTestConfig(t) + for _, hostname := range tt.cfgHosts { + _, err := cfg.Authentication().Login(hostname, "test-user", "abc123", "https", false) + require.NoError(t, err) } - tt.opts.Config = func() (config.Config, error) { + tt.opts.Config = func() (gh.Config, error) { return cfg, nil } @@ -462,17 +479,21 @@ func Test_refreshRun(t *testing.T) { err := refreshRun(tt.opts) if tt.wantErr != "" { - if assert.Error(t, err) { - assert.Contains(t, err.Error(), tt.wantErr) - } - } else { - assert.NoError(t, err) + require.Contains(t, err.Error(), tt.wantErr) + return } - assert.Equal(t, tt.wantAuthArgs.hostname, aa.hostname) - assert.Equal(t, tt.wantAuthArgs.scopes, aa.scopes) - assert.Equal(t, tt.wantAuthArgs.interactive, aa.interactive) - assert.Equal(t, tt.wantAuthArgs.secureStorage, aa.secureStorage) + require.NoError(t, err) + + require.Equal(t, tt.wantAuthArgs.hostname, aa.hostname) + require.Equal(t, tt.wantAuthArgs.scopes, aa.scopes) + require.Equal(t, tt.wantAuthArgs.interactive, aa.interactive) + + authCfg := cfg.Authentication() + activeUser, _ := authCfg.ActiveUser(aa.hostname) + activeToken, _ := authCfg.ActiveToken(aa.hostname) + require.Equal(t, "test-user", activeUser) + require.Equal(t, "xyz456", activeToken) }) } } diff --git a/pkg/cmd/auth/setupgit/setupgit.go b/pkg/cmd/auth/setupgit/setupgit.go index a3c991f4f..c1200b475 100644 --- a/pkg/cmd/auth/setupgit/setupgit.go +++ b/pkg/cmd/auth/setupgit/setupgit.go @@ -5,22 +5,23 @@ import ( "strings" "github.com/MakeNowJust/heredoc" - "github.com/cli/cli/v2/internal/config" - "github.com/cli/cli/v2/pkg/cmd/auth/shared" + "github.com/cli/cli/v2/internal/gh" + "github.com/cli/cli/v2/pkg/cmd/auth/shared/gitcredentials" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" "github.com/spf13/cobra" ) -type gitConfigurator interface { - Setup(hostname, username, authToken string) error +type gitCredentialsConfigurer interface { + ConfigureOurs(hostname string) error } type SetupGitOptions struct { - IO *iostreams.IOStreams - Config func() (config.Config, error) - Hostname string - gitConfigure gitConfigurator + IO *iostreams.IOStreams + Config func() (gh.Config, error) + Hostname string + Force bool + CredentialsHelperConfig gitCredentialsConfigurer } func NewCmdSetupGit(f *cmdutil.Factory, runF func(*SetupGitOptions) error) *cobra.Command { @@ -33,7 +34,7 @@ func NewCmdSetupGit(f *cmdutil.Factory, runF func(*SetupGitOptions) error) *cobr Use: "setup-git", Short: "Setup git with GitHub CLI", Long: heredoc.Docf(` - This command configures git to use GitHub CLI as a credential helper. + This command configures %[1]sgit%[1]s to use GitHub CLI as a credential helper. For more information on git credential helpers please reference: https://git-scm.com/docs/gitcredentials. @@ -51,11 +52,13 @@ func NewCmdSetupGit(f *cmdutil.Factory, runF func(*SetupGitOptions) error) *cobr $ gh auth setup-git --hostname enterprise.internal `), RunE: func(cmd *cobra.Command, args []string) error { - opts.gitConfigure = &shared.GitCredentialFlow{ - Executable: f.Executable(), - GitClient: f.GitClient, + opts.CredentialsHelperConfig = &gitcredentials.HelperConfig{ + SelfExecutablePath: f.Executable(), + GitClient: f.GitClient, + } + if opts.Hostname == "" && opts.Force { + return cmdutil.FlagErrorf("`--force` must be used in conjunction with `--hostname`") } - if runF != nil { return runF(opts) } @@ -64,6 +67,7 @@ func NewCmdSetupGit(f *cmdutil.Factory, runF func(*SetupGitOptions) error) *cobr } cmd.Flags().StringVarP(&opts.Hostname, "hostname", "h", "", "The hostname to configure git for") + cmd.Flags().BoolVarP(&opts.Force, "force", "f", false, "Force setup even if the host is not known. Must be used in conjunction with `--hostname`") return cmd } @@ -74,12 +78,28 @@ func setupGitRun(opts *SetupGitOptions) error { return err } authCfg := cfg.Authentication() - hostnames := authCfg.Hosts() stderr := opts.IO.ErrOut cs := opts.IO.ColorScheme() + // If a hostname was provided, we'll set up just that one + if opts.Hostname != "" { + if !opts.Force && !has(opts.Hostname, hostnames) { + return fmt.Errorf("You are not logged into the GitHub host %q. Run %s to authenticate or provide `--force`", + opts.Hostname, + cs.Bold(fmt.Sprintf("gh auth login -h %s", opts.Hostname)), + ) + } + + if err := opts.CredentialsHelperConfig.ConfigureOurs(opts.Hostname); err != nil { + return fmt.Errorf("failed to set up git credential helper: %s", err) + } + + return nil + } + + // Otherwise we'll set up any known hosts if len(hostnames) == 0 { fmt.Fprintf( stderr, @@ -90,18 +110,9 @@ func setupGitRun(opts *SetupGitOptions) error { return cmdutil.SilentError } - hostnamesToSetup := hostnames - - if opts.Hostname != "" { - if !has(opts.Hostname, hostnames) { - return fmt.Errorf("You are not logged into the GitHub host %q\n", opts.Hostname) - } - hostnamesToSetup = []string{opts.Hostname} - } - - for _, hostname := range hostnamesToSetup { - if err := opts.gitConfigure.Setup(hostname, "", ""); err != nil { - return fmt.Errorf("failed to set up git credential helper: %w", err) + for _, hostname := range hostnames { + if err := opts.CredentialsHelperConfig.ConfigureOurs(hostname); err != nil { + return fmt.Errorf("failed to set up git credential helper: %s", err) } } diff --git a/pkg/cmd/auth/setupgit/setupgit_test.go b/pkg/cmd/auth/setupgit/setupgit_test.go index 635cece8c..8d9dc2d21 100644 --- a/pkg/cmd/auth/setupgit/setupgit_test.go +++ b/pkg/cmd/auth/setupgit/setupgit_test.go @@ -1,131 +1,167 @@ package setupgit import ( + "bytes" + "errors" "fmt" + "io" "testing" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" + "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" - "github.com/stretchr/testify/assert" + "github.com/google/shlex" + "github.com/stretchr/testify/require" ) -type mockGitConfigurer struct { +type gitCredentialsConfigurerSpy struct { + hosts []string setupErr error } -func (gf *mockGitConfigurer) Setup(hostname, username, authToken string) error { +func (gf *gitCredentialsConfigurerSpy) ConfigureOurs(hostname string) error { + gf.hosts = append(gf.hosts, hostname) return gf.setupErr } +func TestNewCmdSetupGit(t *testing.T) { + tests := []struct { + name string + cli string + wantsErr bool + errMsg string + }{ + { + name: "--force without hostname", + cli: "--force", + wantsErr: true, + errMsg: "`--force` must be used in conjunction with `--hostname`", + }, + { + name: "no error when --force used with hostname", + cli: "--force --hostname ghe.io", + wantsErr: false, + }, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + f := &cmdutil.Factory{} + + argv, err := shlex.Split(tt.cli) + require.NoError(t, err) + + cmd := NewCmdSetupGit(f, func(opts *SetupGitOptions) error { + return nil + }) + + // TODO cobra hack-around + cmd.Flags().BoolP("help", "x", false, "") + + cmd.SetArgs(argv) + cmd.SetIn(&bytes.Buffer{}) + cmd.SetOut(io.Discard) + cmd.SetErr(io.Discard) + + _, err = cmd.ExecuteC() + if tt.wantsErr { + require.Error(t, err) + require.Equal(t, err.Error(), tt.errMsg) + return + } + + require.NoError(t, err) + }) + } +} func Test_setupGitRun(t *testing.T) { tests := []struct { - name string - opts *SetupGitOptions - expectedErr string - expectedErrOut string + name string + opts *SetupGitOptions + setupErr error + cfgStubs func(*testing.T, gh.Config) + expectedHostsSetup []string + expectedErr error + expectedErrOut string }{ { name: "opts.Config returns an error", opts: &SetupGitOptions{ - Config: func() (config.Config, error) { + Config: func() (gh.Config, error) { return nil, fmt.Errorf("oops") }, }, - expectedErr: "oops", + expectedErr: errors.New("oops"), }, { - name: "no authenticated hostnames", + name: "when an unknown hostname is provided without forcing, return an error", opts: &SetupGitOptions{ - Config: func() (config.Config, error) { - cfg := &config.ConfigMock{} - cfg.AuthenticationFunc = func() *config.AuthConfig { - authCfg := &config.AuthConfig{} - authCfg.SetHosts([]string{}) - return authCfg - } - return cfg, nil - }, + Hostname: "ghe.io", }, - expectedErr: "SilentError", + cfgStubs: func(t *testing.T, cfg gh.Config) { + login(t, cfg, "github.com", "test-user", "gho_ABCDEFG", "https", false) + }, + expectedErr: errors.New("You are not logged into the GitHub host \"ghe.io\". Run gh auth login -h ghe.io to authenticate or provide `--force`"), + }, + { + name: "when an unknown hostname is provided with forcing, set it up", + opts: &SetupGitOptions{ + Hostname: "ghe.io", + Force: true, + }, + expectedHostsSetup: []string{"ghe.io"}, + }, + { + name: "when a known hostname is provided without forcing, set it up", + opts: &SetupGitOptions{ + Hostname: "ghe.io", + }, + cfgStubs: func(t *testing.T, cfg gh.Config) { + login(t, cfg, "ghe.io", "test-user", "gho_ABCDEFG", "https", false) + }, + expectedHostsSetup: []string{"ghe.io"}, + }, + { + name: "when a hostname is provided but setting it up errors, that error is bubbled", + opts: &SetupGitOptions{ + Hostname: "ghe.io", + }, + setupErr: fmt.Errorf("broken"), + cfgStubs: func(t *testing.T, cfg gh.Config) { + login(t, cfg, "ghe.io", "test-user", "gho_ABCDEFG", "https", false) + }, + expectedErr: errors.New("failed to set up git credential helper: broken"), + expectedErrOut: "", + }, + { + name: "when there are no known hosts and no hostname is provided, return an error", + opts: &SetupGitOptions{}, + expectedErr: cmdutil.SilentError, expectedErrOut: "You are not logged into any GitHub hosts. Run gh auth login to authenticate.\n", }, { - name: "not authenticated with the hostname given as flag", - opts: &SetupGitOptions{ - Hostname: "foo", - Config: func() (config.Config, error) { - cfg := &config.ConfigMock{} - cfg.AuthenticationFunc = func() *config.AuthConfig { - authCfg := &config.AuthConfig{} - authCfg.SetHosts([]string{"bar"}) - return authCfg - } - return cfg, nil - }, + name: "when there are known hosts, and no hostname is provided, set them all up", + opts: &SetupGitOptions{}, + cfgStubs: func(t *testing.T, cfg gh.Config) { + login(t, cfg, "ghe.io", "test-user", "gho_ABCDEFG", "https", false) + login(t, cfg, "github.com", "test-user", "gho_ABCDEFG", "https", false) }, - expectedErr: "You are not logged into the GitHub host \"foo\"\n", + expectedHostsSetup: []string{"github.com", "ghe.io"}, + }, + { + name: "when no hostname is provided but setting one up errors, that error is bubbled", + opts: &SetupGitOptions{}, + setupErr: fmt.Errorf("broken"), + cfgStubs: func(t *testing.T, cfg gh.Config) { + login(t, cfg, "ghe.io", "test-user", "gho_ABCDEFG", "https", false) + }, + expectedErr: errors.New("failed to set up git credential helper: broken"), expectedErrOut: "", }, - { - name: "error setting up git for hostname", - opts: &SetupGitOptions{ - gitConfigure: &mockGitConfigurer{ - setupErr: fmt.Errorf("broken"), - }, - Config: func() (config.Config, error) { - cfg := &config.ConfigMock{} - cfg.AuthenticationFunc = func() *config.AuthConfig { - authCfg := &config.AuthConfig{} - authCfg.SetHosts([]string{"bar"}) - return authCfg - } - return cfg, nil - }, - }, - expectedErr: "failed to set up git credential helper: broken", - expectedErrOut: "", - }, - { - name: "no hostname option given. Setup git for each hostname in config", - opts: &SetupGitOptions{ - gitConfigure: &mockGitConfigurer{}, - Config: func() (config.Config, error) { - cfg := &config.ConfigMock{} - cfg.AuthenticationFunc = func() *config.AuthConfig { - authCfg := &config.AuthConfig{} - authCfg.SetHosts([]string{"bar"}) - return authCfg - } - return cfg, nil - }, - }, - }, - { - name: "setup git for the hostname given via options", - opts: &SetupGitOptions{ - Hostname: "yes", - gitConfigure: &mockGitConfigurer{}, - Config: func() (config.Config, error) { - cfg := &config.ConfigMock{} - cfg.AuthenticationFunc = func() *config.AuthConfig { - authCfg := &config.AuthConfig{} - authCfg.SetHosts([]string{"bar", "yes"}) - return authCfg - } - return cfg, nil - }, - }, - }, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { - if tt.opts.Config == nil { - tt.opts.Config = func() (config.Config, error) { - return &config.ConfigMock{}, nil - } - } - ios, _, _, stderr := iostreams.Test() ios.SetStdinTTY(true) @@ -133,14 +169,38 @@ func Test_setupGitRun(t *testing.T) { ios.SetStdoutTTY(true) tt.opts.IO = ios - err := setupGitRun(tt.opts) - if tt.expectedErr != "" { - assert.EqualError(t, err, tt.expectedErr) - } else { - assert.NoError(t, err) + cfg, _ := config.NewIsolatedTestConfig(t) + if tt.cfgStubs != nil { + tt.cfgStubs(t, cfg) } - assert.Equal(t, tt.expectedErrOut, stderr.String()) + if tt.opts.Config == nil { + tt.opts.Config = func() (gh.Config, error) { + return cfg, nil + } + } + + credentialsConfigurerSpy := &gitCredentialsConfigurerSpy{setupErr: tt.setupErr} + tt.opts.CredentialsHelperConfig = credentialsConfigurerSpy + + err := setupGitRun(tt.opts) + if tt.expectedErr != nil { + require.Equal(t, err, tt.expectedErr) + } else { + require.NoError(t, err) + } + + if tt.expectedHostsSetup != nil { + require.Equal(t, tt.expectedHostsSetup, credentialsConfigurerSpy.hosts) + } + + require.Equal(t, tt.expectedErrOut, stderr.String()) }) } } + +func login(t *testing.T, c gh.Config, hostname, username, token, gitProtocol string, secureStorage bool) { + t.Helper() + _, err := c.Authentication().Login(hostname, username, token, gitProtocol, secureStorage) + require.NoError(t, err) +} diff --git a/pkg/cmd/auth/shared/contract/helper_config.go b/pkg/cmd/auth/shared/contract/helper_config.go new file mode 100644 index 000000000..d507e1091 --- /dev/null +++ b/pkg/cmd/auth/shared/contract/helper_config.go @@ -0,0 +1,64 @@ +package contract + +import ( + "testing" + + "github.com/cli/cli/v2/pkg/cmd/auth/shared" + "github.com/stretchr/testify/require" +) + +// This HelperConfig contract exist to ensure that any HelperConfig implementation conforms to this behaviour. +// This is useful because we can swap in fake implementations for testing, rather than requiring our tests to be +// isolated from git. +// +// See for example, TestAuthenticatingGitCredentials for LoginFlow. +type HelperConfig struct { + NewHelperConfig func(t *testing.T) shared.HelperConfig + ConfigureHelper func(t *testing.T, hostname string) +} + +func (contract HelperConfig) Test(t *testing.T) { + t.Run("when there are no credential helpers, configures gh for repo and gist host", func(t *testing.T) { + hc := contract.NewHelperConfig(t) + require.NoError(t, hc.ConfigureOurs("github.com")) + + repoHelper, err := hc.ConfiguredHelper("github.com") + require.NoError(t, err) + require.True(t, repoHelper.IsConfigured(), "expected our helper to be configured") + require.True(t, repoHelper.IsOurs(), "expected the helper to be ours but was %q", repoHelper.Cmd) + + gistHelper, err := hc.ConfiguredHelper("gist.github.com") + require.NoError(t, err) + require.True(t, gistHelper.IsConfigured(), "expected our helper to be configured") + require.True(t, gistHelper.IsOurs(), "expected the helper to be ours but was %q", gistHelper.Cmd) + }) + + t.Run("when there is a global credential helper, it should be configured but not ours", func(t *testing.T) { + hc := contract.NewHelperConfig(t) + contract.ConfigureHelper(t, "credential.helper") + + helper, err := hc.ConfiguredHelper("github.com") + require.NoError(t, err) + require.True(t, helper.IsConfigured(), "expected helper to be configured") + require.False(t, helper.IsOurs(), "expected the helper not to be ours but was %q", helper.Cmd) + }) + + t.Run("when there is a host credential helper, it should be configured but not ours", func(t *testing.T) { + hc := contract.NewHelperConfig(t) + contract.ConfigureHelper(t, "credential.https://github.com.helper") + + helper, err := hc.ConfiguredHelper("github.com") + require.NoError(t, err) + require.True(t, helper.IsConfigured(), "expected helper to be configured") + require.False(t, helper.IsOurs(), "expected the helper not to be ours but was %q", helper.Cmd) + }) + + t.Run("returns non configured helper when no helpers are configured", func(t *testing.T) { + hc := contract.NewHelperConfig(t) + + helper, err := hc.ConfiguredHelper("github.com") + require.NoError(t, err) + require.False(t, helper.IsConfigured(), "expected no helper to be configured") + require.False(t, helper.IsOurs(), "expected the helper not to be ours but was %q", helper.Cmd) + }) +} diff --git a/pkg/cmd/auth/shared/git_credential.go b/pkg/cmd/auth/shared/git_credential.go index 8624cf00b..e3136de43 100644 --- a/pkg/cmd/auth/shared/git_credential.go +++ b/pkg/cmd/auth/shared/git_credential.go @@ -1,37 +1,43 @@ package shared import ( - "bytes" - "context" "errors" - "fmt" - "path/filepath" - "strings" - "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/git" - "github.com/cli/cli/v2/internal/ghinstance" - "github.com/google/shlex" + "github.com/cli/cli/v2/pkg/cmd/auth/shared/gitcredentials" ) +type HelperConfig interface { + ConfigureOurs(hostname string) error + ConfiguredHelper(hostname string) (gitcredentials.Helper, error) +} + type GitCredentialFlow struct { - Executable string - Prompter Prompt - GitClient *git.Client + Prompter Prompt + + HelperConfig HelperConfig + Updater *gitcredentials.Updater shouldSetup bool - helper string + helper gitcredentials.Helper scopes []string } func (flow *GitCredentialFlow) Prompt(hostname string) error { - var gitErr error - flow.helper, gitErr = gitCredentialHelper(flow.GitClient, hostname) - if isOurCredentialHelper(flow.helper) { + // First we'll fetch the credential helper that would be used for this host + var configuredHelperErr error + flow.helper, configuredHelperErr = flow.HelperConfig.ConfiguredHelper(hostname) + // If the helper is gh itself, then we don't need to ask the user if they want to update their git credentials + // because it will happen automatically by virtue of the fact that gh will return the active token. + // + // Since gh is the helper, this token may be used for git operations, so we'll additionally request the workflow + // scope to ensure that git push operations that include workflow changes succeed. + if flow.helper.IsOurs() { flow.scopes = append(flow.scopes, "workflow") return nil } + // Prompt the user for whether they want to configure git with the newly obtained token result, err := flow.Prompter.Confirm("Authenticate Git with your GitHub credentials?", true) if err != nil { return err @@ -39,9 +45,24 @@ func (flow *GitCredentialFlow) Prompt(hostname string) error { flow.shouldSetup = result if flow.shouldSetup { - if isGitMissing(gitErr) { - return gitErr + // If the user does want to configure git, we'll check the error returned from fetching the configured helper + // above. If the error indicates that git isn't installed, we'll return an error now to ensure that the auth + // flow is aborted before the user goes any further. + // + // Note that this is _slightly_ naive because there may be other reasons that fetching the configured helper + // fails that might cause later failures but this code has existed for a long time and I don't want to change + // it as part of a refactoring. + // + // Refs: + // * https://git-scm.com/docs/git-config#_description + // * https://github.com/cli/cli/pull/4109 + var errNotInstalled *git.NotInstalled + if errors.As(configuredHelperErr, &errNotInstalled) { + return configuredHelperErr } + + // On the other hand, if the user has requested setup we'll additionally request the workflow + // scope to ensure that git push operations that include workflow changes succeed. flow.scopes = append(flow.scopes, "workflow") } @@ -57,131 +78,12 @@ func (flow *GitCredentialFlow) ShouldSetup() bool { } func (flow *GitCredentialFlow) Setup(hostname, username, authToken string) error { - return flow.gitCredentialSetup(hostname, username, authToken) -} - -func (flow *GitCredentialFlow) gitCredentialSetup(hostname, username, password string) error { - gitClient := flow.GitClient - ctx := context.Background() - - if flow.helper == "" { - credHelperKeys := []string{ - gitCredentialHelperKey(hostname), - } - - gistHost := strings.TrimSuffix(ghinstance.GistHost(hostname), "/") - if strings.HasPrefix(gistHost, "gist.") { - credHelperKeys = append(credHelperKeys, gitCredentialHelperKey(gistHost)) - } - - var configErr error - - for _, credHelperKey := range credHelperKeys { - if configErr != nil { - break - } - // first use a blank value to indicate to git we want to sever the chain of credential helpers - preConfigureCmd, err := gitClient.Command(ctx, "config", "--global", "--replace-all", credHelperKey, "") - if err != nil { - configErr = err - break - } - if _, err = preConfigureCmd.Output(); err != nil { - configErr = err - break - } - - // second configure the actual helper for this host - configureCmd, err := gitClient.Command(ctx, - "config", "--global", "--add", - credHelperKey, - fmt.Sprintf("!%s auth git-credential", shellQuote(flow.Executable)), - ) - if err != nil { - configErr = err - } else { - _, configErr = configureCmd.Output() - } - } - - return configErr - } - - // clear previous cached credentials - rejectCmd, err := gitClient.Command(ctx, "credential", "reject") - if err != nil { - return err - } - - rejectCmd.Stdin = bytes.NewBufferString(heredoc.Docf(` - protocol=https - host=%s - `, hostname)) - - _, err = rejectCmd.Output() - if err != nil { - return err - } - - approveCmd, err := gitClient.Command(ctx, "credential", "approve") - if err != nil { - return err - } - - approveCmd.Stdin = bytes.NewBufferString(heredoc.Docf(` - protocol=https - host=%s - username=%s - password=%s - `, hostname, username, password)) - - _, err = approveCmd.Output() - if err != nil { - return err - } - - return nil -} - -func gitCredentialHelperKey(hostname string) string { - host := strings.TrimSuffix(ghinstance.HostPrefix(hostname), "/") - return fmt.Sprintf("credential.%s.helper", host) -} - -func gitCredentialHelper(gitClient *git.Client, hostname string) (helper string, err error) { - ctx := context.Background() - helper, err = gitClient.Config(ctx, gitCredentialHelperKey(hostname)) - if helper != "" { - return - } - helper, err = gitClient.Config(ctx, "credential.helper") - return -} - -func isOurCredentialHelper(cmd string) bool { - if !strings.HasPrefix(cmd, "!") { - return false - } - - args, err := shlex.Split(cmd[1:]) - if err != nil || len(args) == 0 { - return false - } - - return strings.TrimSuffix(filepath.Base(args[0]), ".exe") == "gh" -} - -func isGitMissing(err error) bool { - if err == nil { - return false - } - var errNotInstalled *git.NotInstalled - return errors.As(err, &errNotInstalled) -} - -func shellQuote(s string) string { - if strings.ContainsAny(s, " $\\") { - return "'" + s + "'" - } - return s + // If there is no credential helper configured then we will set ourselves up as + // the credential helper for this host. + if !flow.helper.IsConfigured() { + return flow.HelperConfig.ConfigureOurs(hostname) + } + + // Otherwise, we'll tell git to inform the existing credential helper of the new credentials. + return flow.Updater.Update(hostname, username, authToken) } diff --git a/pkg/cmd/auth/shared/git_credential_test.go b/pkg/cmd/auth/shared/git_credential_test.go index 9d3e90cc4..19ab9b752 100644 --- a/pkg/cmd/auth/shared/git_credential_test.go +++ b/pkg/cmd/auth/shared/git_credential_test.go @@ -5,22 +5,24 @@ import ( "github.com/cli/cli/v2/git" "github.com/cli/cli/v2/internal/run" + "github.com/cli/cli/v2/pkg/cmd/auth/shared/gitcredentials" ) -func TestGitCredentialSetup_configureExisting(t *testing.T) { +func TestSetup_configureExisting(t *testing.T) { cs, restoreRun := run.Stub() defer restoreRun(t) cs.Register(`git credential reject`, 0, "") cs.Register(`git credential approve`, 0, "") f := GitCredentialFlow{ - Executable: "gh", - helper: "osxkeychain", - GitClient: &git.Client{GitPath: "some/path/git"}, + helper: gitcredentials.Helper{Cmd: "osxkeychain"}, + Updater: &gitcredentials.Updater{ + GitClient: &git.Client{GitPath: "some/path/git"}, + }, } - if err := f.gitCredentialSetup("example.com", "monalisa", "PASSWD"); err != nil { - t.Errorf("GitCredentialSetup() error = %v", err) + if err := f.Setup("example.com", "monalisa", "PASSWD"); err != nil { + t.Errorf("Setup() error = %v", err) } } @@ -61,18 +63,20 @@ func TestGitCredentialsSetup_setOurs_GH(t *testing.T) { }) f := GitCredentialFlow{ - Executable: "/path/to/gh", - helper: "", - GitClient: &git.Client{GitPath: "some/path/git"}, + helper: gitcredentials.Helper{}, + HelperConfig: &gitcredentials.HelperConfig{ + SelfExecutablePath: "/path/to/gh", + GitClient: &git.Client{GitPath: "some/path/git"}, + }, } - if err := f.gitCredentialSetup("github.com", "monalisa", "PASSWD"); err != nil { - t.Errorf("GitCredentialSetup() error = %v", err) + if err := f.Setup("github.com", "monalisa", "PASSWD"); err != nil { + t.Errorf("Setup() error = %v", err) } } -func TestGitCredentialSetup_setOurs_nonGH(t *testing.T) { +func TestSetup_setOurs_nonGH(t *testing.T) { cs, restoreRun := run.Stub() defer restoreRun(t) cs.Register(`git config --global --replace-all credential\.`, 0, "", func(args []string) { @@ -93,53 +97,14 @@ func TestGitCredentialSetup_setOurs_nonGH(t *testing.T) { }) f := GitCredentialFlow{ - Executable: "/path/to/gh", - helper: "", - GitClient: &git.Client{GitPath: "some/path/git"}, + helper: gitcredentials.Helper{}, + HelperConfig: &gitcredentials.HelperConfig{ + SelfExecutablePath: "/path/to/gh", + GitClient: &git.Client{GitPath: "some/path/git"}, + }, } - if err := f.gitCredentialSetup("example.com", "monalisa", "PASSWD"); err != nil { - t.Errorf("GitCredentialSetup() error = %v", err) - } -} - -func Test_isOurCredentialHelper(t *testing.T) { - tests := []struct { - name string - arg string - want bool - }{ - { - name: "blank", - arg: "", - want: false, - }, - { - name: "invalid", - arg: "!", - want: false, - }, - { - name: "osxkeychain", - arg: "osxkeychain", - want: false, - }, - { - name: "looks like gh but isn't", - arg: "gh auth", - want: false, - }, - { - name: "ours", - arg: "!/path/to/gh auth", - want: true, - }, - } - for _, tt := range tests { - t.Run(tt.name, func(t *testing.T) { - if got := isOurCredentialHelper(tt.arg); got != tt.want { - t.Errorf("isOurCredentialHelper() = %v, want %v", got, tt.want) - } - }) + if err := f.Setup("example.com", "monalisa", "PASSWD"); err != nil { + t.Errorf("Setup() error = %v", err) } } diff --git a/pkg/cmd/auth/shared/gitcredentials/fake_helper_config.go b/pkg/cmd/auth/shared/gitcredentials/fake_helper_config.go new file mode 100644 index 000000000..f6ae2f2c0 --- /dev/null +++ b/pkg/cmd/auth/shared/gitcredentials/fake_helper_config.go @@ -0,0 +1,49 @@ +package gitcredentials + +import ( + "fmt" + "strings" + + "github.com/cli/cli/v2/internal/ghinstance" +) + +type FakeHelperConfig struct { + SelfExecutablePath string + Helpers map[string]Helper +} + +// ConfigureOurs sets up the git credential helper chain to use the GitHub CLI credential helper for git repositories +// including gists. +func (hc *FakeHelperConfig) ConfigureOurs(hostname string) error { + credHelperKeys := []string{ + keyFor(hostname), + } + + gistHost := strings.TrimSuffix(ghinstance.GistHost(hostname), "/") + if strings.HasPrefix(gistHost, "gist.") { + credHelperKeys = append(credHelperKeys, keyFor(gistHost)) + } + + for _, credHelperKey := range credHelperKeys { + hc.Helpers[credHelperKey] = Helper{ + Cmd: fmt.Sprintf("!%s auth git-credential", shellQuote(hc.SelfExecutablePath)), + } + } + + return nil +} + +// ConfiguredHelper returns the configured git credential helper for a given hostname. +func (hc *FakeHelperConfig) ConfiguredHelper(hostname string) (Helper, error) { + helper, ok := hc.Helpers[keyFor(hostname)] + if ok { + return helper, nil + } + + helper, ok = hc.Helpers["credential.helper"] + if ok { + return helper, nil + } + + return Helper{}, nil +} diff --git a/pkg/cmd/auth/shared/gitcredentials/fake_helper_config_test.go b/pkg/cmd/auth/shared/gitcredentials/fake_helper_config_test.go new file mode 100644 index 000000000..441972aff --- /dev/null +++ b/pkg/cmd/auth/shared/gitcredentials/fake_helper_config_test.go @@ -0,0 +1,32 @@ +package gitcredentials_test + +import ( + "testing" + + "github.com/cli/cli/v2/pkg/cmd/auth/shared" + "github.com/cli/cli/v2/pkg/cmd/auth/shared/contract" + "github.com/cli/cli/v2/pkg/cmd/auth/shared/gitcredentials" +) + +func TestFakeHelperConfigContract(t *testing.T) { + // Note that this being mutated by `NewHelperConfig` makes these tests not parallelizable + var fhc *gitcredentials.FakeHelperConfig + + contract.HelperConfig{ + NewHelperConfig: func(t *testing.T) shared.HelperConfig { + // Mutate the closed over fhc so that ConfigureHelper is able to configure helpers + // for tests. An alternative would be to provide the Helper as an argument back to ConfigureHelper + // but then we'd have to type assert it back to *FakeHelperConfig, which is probably more trouble than + // it's worth to parallelize these tests, sinced it's not even possible to parallelize the real Helperconfig + // ones due to them using t.Setenv + fhc = &gitcredentials.FakeHelperConfig{ + SelfExecutablePath: "/path/to/gh", + Helpers: map[string]gitcredentials.Helper{}, + } + return fhc + }, + ConfigureHelper: func(t *testing.T, hostname string) { + fhc.Helpers[hostname] = gitcredentials.Helper{Cmd: "test-helper"} + }, + }.Test(t) +} diff --git a/pkg/cmd/auth/shared/gitcredentials/helper_config.go b/pkg/cmd/auth/shared/gitcredentials/helper_config.go new file mode 100644 index 000000000..9e9b4eaad --- /dev/null +++ b/pkg/cmd/auth/shared/gitcredentials/helper_config.go @@ -0,0 +1,124 @@ +package gitcredentials + +import ( + "context" + "fmt" + "path/filepath" + "strings" + + "github.com/cli/cli/v2/git" + "github.com/cli/cli/v2/internal/ghinstance" + "github.com/google/shlex" +) + +// A HelperConfig is used to configure and inspect the state of git credential helpers. +type HelperConfig struct { + SelfExecutablePath string + GitClient *git.Client +} + +// ConfigureOurs sets up the git credential helper chain to use the GitHub CLI credential helper for git repositories +// including gists. +func (hc *HelperConfig) ConfigureOurs(hostname string) error { + ctx := context.TODO() + + credHelperKeys := []string{ + keyFor(hostname), + } + + gistHost := strings.TrimSuffix(ghinstance.GistHost(hostname), "/") + if strings.HasPrefix(gistHost, "gist.") { + credHelperKeys = append(credHelperKeys, keyFor(gistHost)) + } + + var configErr error + + for _, credHelperKey := range credHelperKeys { + if configErr != nil { + break + } + // first use a blank value to indicate to git we want to sever the chain of credential helpers + preConfigureCmd, err := hc.GitClient.Command(ctx, "config", "--global", "--replace-all", credHelperKey, "") + if err != nil { + configErr = err + break + } + if _, err = preConfigureCmd.Output(); err != nil { + configErr = err + break + } + + // second configure the actual helper for this host + configureCmd, err := hc.GitClient.Command(ctx, + "config", "--global", "--add", + credHelperKey, + fmt.Sprintf("!%s auth git-credential", shellQuote(hc.SelfExecutablePath)), + ) + if err != nil { + configErr = err + } else { + _, configErr = configureCmd.Output() + } + } + + return configErr +} + +// A Helper represents a git credential helper configuration. +type Helper struct { + Cmd string +} + +// IsConfigured returns true if the helper has a non-empty command, i.e. the git config had an entry +func (h Helper) IsConfigured() bool { + return h.Cmd != "" +} + +// IsOurs returns true if the helper command is the GitHub CLI credential helper +func (h Helper) IsOurs() bool { + if !strings.HasPrefix(h.Cmd, "!") { + return false + } + + args, err := shlex.Split(h.Cmd[1:]) + if err != nil || len(args) == 0 { + return false + } + + return strings.TrimSuffix(filepath.Base(args[0]), ".exe") == "gh" +} + +// ConfiguredHelper returns the configured git credential helper for a given hostname. +func (hc *HelperConfig) ConfiguredHelper(hostname string) (Helper, error) { + ctx := context.TODO() + + hostHelperCmd, err := hc.GitClient.Config(ctx, keyFor(hostname)) + if hostHelperCmd != "" { + // TODO: This is a direct refactoring removing named and naked returns + // but we should probably look closer at the error handling here + return Helper{ + Cmd: hostHelperCmd, + }, err + } + + globalHelperCmd, err := hc.GitClient.Config(ctx, "credential.helper") + if globalHelperCmd != "" { + return Helper{ + Cmd: globalHelperCmd, + }, err + } + + return Helper{}, nil +} + +func keyFor(hostname string) string { + host := strings.TrimSuffix(ghinstance.HostPrefix(hostname), "/") + return fmt.Sprintf("credential.%s.helper", host) +} + +func shellQuote(s string) string { + if strings.ContainsAny(s, " $\\") { + return "'" + s + "'" + } + return s +} diff --git a/pkg/cmd/auth/shared/gitcredentials/helper_config_test.go b/pkg/cmd/auth/shared/gitcredentials/helper_config_test.go new file mode 100644 index 000000000..80ffac85a --- /dev/null +++ b/pkg/cmd/auth/shared/gitcredentials/helper_config_test.go @@ -0,0 +1,125 @@ +package gitcredentials_test + +import ( + "context" + "path/filepath" + "runtime" + "testing" + + "github.com/cli/cli/v2/git" + "github.com/cli/cli/v2/pkg/cmd/auth/shared" + "github.com/cli/cli/v2/pkg/cmd/auth/shared/contract" + "github.com/cli/cli/v2/pkg/cmd/auth/shared/gitcredentials" + "github.com/stretchr/testify/require" +) + +func withIsolatedGitConfig(t *testing.T) { + t.Helper() + + // https://git-scm.com/docs/git-config#ENVIRONMENT + // Set the global git config to a temporary file + tmpDir := t.TempDir() + configFile := filepath.Join(tmpDir, ".gitconfig") + t.Setenv("GIT_CONFIG_GLOBAL", configFile) + + // And disable git reading the system config + t.Setenv("GIT_CONFIG_NOSYSTEM", "true") +} + +func configureTestCredentialHelper(t *testing.T, key string) { + t.Helper() + + gc := &git.Client{} + cmd, err := gc.Command(context.Background(), "config", "--global", "--add", key, "test-helper") + require.NoError(t, err) + require.NoError(t, cmd.Run()) +} + +func TestHelperConfigContract(t *testing.T) { + contract.HelperConfig{ + NewHelperConfig: func(t *testing.T) shared.HelperConfig { + withIsolatedGitConfig(t) + + return &gitcredentials.HelperConfig{ + SelfExecutablePath: "/path/to/gh", + GitClient: &git.Client{}, + } + }, + ConfigureHelper: func(t *testing.T, hostname string) { + configureTestCredentialHelper(t, hostname) + }, + }.Test(t) +} + +// This is a whitebox test unlike the contract because although we don't use the exact configured command, it's +// important that it is exactly right since git uses it. +func TestSetsCorrectCommandInGitConfig(t *testing.T) { + withIsolatedGitConfig(t) + + gc := &git.Client{} + hc := &gitcredentials.HelperConfig{ + SelfExecutablePath: "/path/to/gh", + GitClient: gc, + } + require.NoError(t, hc.ConfigureOurs("github.com")) + + // Check that the correct command was set in the git config + cmd, err := gc.Command(context.Background(), "config", "--get", "credential.https://github.com.helper") + require.NoError(t, err) + output, err := cmd.Output() + require.NoError(t, err) + require.Equal(t, "!/path/to/gh auth git-credential\n", string(output)) +} + +func TestHelperIsOurs(t *testing.T) { + tests := []struct { + name string + cmd string + want bool + windowsOnly bool + }{ + { + name: "blank", + cmd: "", + want: false, + }, + { + name: "invalid", + cmd: "!", + want: false, + }, + { + name: "osxkeychain", + cmd: "osxkeychain", + want: false, + }, + { + name: "looks like gh but isn't", + cmd: "gh auth", + want: false, + }, + { + name: "ours", + cmd: "!/path/to/gh auth", + want: true, + }, + { + name: "ours - Windows edition", + cmd: `!'C:\Program Files\GitHub CLI\gh.exe' auth git-credential`, + want: true, + windowsOnly: true, + }, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + if tt.windowsOnly && runtime.GOOS != "windows" { + t.Skip("skipping test on non-Windows platform") + } + + h := gitcredentials.Helper{Cmd: tt.cmd} + if got := h.IsOurs(); got != tt.want { + t.Errorf("IsOurs() = %v, want %v", got, tt.want) + } + }) + } +} diff --git a/pkg/cmd/auth/shared/gitcredentials/updater.go b/pkg/cmd/auth/shared/gitcredentials/updater.go new file mode 100644 index 000000000..9ffa443e7 --- /dev/null +++ b/pkg/cmd/auth/shared/gitcredentials/updater.go @@ -0,0 +1,55 @@ +package gitcredentials + +import ( + "bytes" + "context" + + "github.com/MakeNowJust/heredoc" + "github.com/cli/cli/v2/git" +) + +// An Updater is used to update the git credentials for a given hostname. +type Updater struct { + GitClient *git.Client +} + +// Update updates the git credentials for a given hostname, first by rejecting any existing credentials and then +// approving the new credentials. +func (u *Updater) Update(hostname, username, password string) error { + ctx := context.TODO() + + // clear previous cached credentials + rejectCmd, err := u.GitClient.Command(ctx, "credential", "reject") + if err != nil { + return err + } + + rejectCmd.Stdin = bytes.NewBufferString(heredoc.Docf(` + protocol=https + host=%s + `, hostname)) + + _, err = rejectCmd.Output() + if err != nil { + return err + } + + approveCmd, err := u.GitClient.Command(ctx, "credential", "approve") + if err != nil { + return err + } + + approveCmd.Stdin = bytes.NewBufferString(heredoc.Docf(` + protocol=https + host=%s + username=%s + password=%s + `, hostname, username, password)) + + _, err = approveCmd.Output() + if err != nil { + return err + } + + return nil +} diff --git a/pkg/cmd/auth/shared/gitcredentials/updater_test.go b/pkg/cmd/auth/shared/gitcredentials/updater_test.go new file mode 100644 index 000000000..10a9c5c6c --- /dev/null +++ b/pkg/cmd/auth/shared/gitcredentials/updater_test.go @@ -0,0 +1,85 @@ +package gitcredentials_test + +import ( + "bytes" + "context" + "fmt" + "path/filepath" + "testing" + + "github.com/MakeNowJust/heredoc" + "github.com/cli/cli/v2/git" + "github.com/cli/cli/v2/pkg/cmd/auth/shared/gitcredentials" + "github.com/stretchr/testify/require" +) + +func configureStoreCredentialHelper(t *testing.T) { + t.Helper() + tmpCredentialsFile := filepath.Join(t.TempDir(), "credentials") + + gc := &git.Client{} + // Use `--file` to store credentials in a temporary file that gets cleaned up when the test has finished running + cmd, err := gc.Command(context.Background(), "config", "--global", "--add", "credential.helper", fmt.Sprintf("store --file %s", tmpCredentialsFile)) + require.NoError(t, err) + require.NoError(t, cmd.Run()) +} + +func fillCredentials(t *testing.T) string { + gc := &git.Client{} + fillCmd, err := gc.Command(context.Background(), "credential", "fill") + require.NoError(t, err) + + fillCmd.Stdin = bytes.NewBufferString(heredoc.Docf(` + protocol=https + host=%s + `, "github.com")) + + b, err := fillCmd.Output() + require.NoError(t, err) + + return string(b) +} + +func TestUpdateAddsNewCredentials(t *testing.T) { + // Given we have an isolated git config and we're using the built in store credential helper + // https://git-scm.com/docs/git-credential-store + withIsolatedGitConfig(t) + configureStoreCredentialHelper(t) + + // When we add new credentials + u := &gitcredentials.Updater{ + GitClient: &git.Client{}, + } + require.NoError(t, u.Update("github.com", "monalisa", "password")) + + // Then our credential description is successfully filled + require.Equal(t, heredoc.Doc(` +protocol=https +host=github.com +username=monalisa +password=password +`), fillCredentials(t)) +} + +func TestUpdateReplacesOldCredentials(t *testing.T) { + // Given we have an isolated git config and we're using the built in store credential helper + // https://git-scm.com/docs/git-credential-store + // and we have existing credentials + withIsolatedGitConfig(t) + configureStoreCredentialHelper(t) + + // When we replace old credentials + u := &gitcredentials.Updater{ + GitClient: &git.Client{}, + } + require.NoError(t, u.Update("github.com", "monalisa", "old-password")) + require.NoError(t, u.Update("github.com", "monalisa", "new-password")) + + // Then our credential description is successfully filled + require.Equal(t, heredoc.Doc(` +protocol=https +host=github.com +username=monalisa +password=new-password +`), fillCredentials(t)) +} diff --git a/pkg/cmd/auth/shared/login_flow.go b/pkg/cmd/auth/shared/login_flow.go index 48cccd3b2..93455e8ee 100644 --- a/pkg/cmd/auth/shared/login_flow.go +++ b/pkg/cmd/auth/shared/login_flow.go @@ -6,11 +6,11 @@ import ( "fmt" "net/http" "os" + "slices" "strings" "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/api" - "github.com/cli/cli/v2/git" "github.com/cli/cli/v2/internal/authflow" "github.com/cli/cli/v2/internal/browser" "github.com/cli/cli/v2/internal/ghinstance" @@ -22,23 +22,24 @@ import ( const defaultSSHKeyTitle = "GitHub CLI" type iconfig interface { - Login(string, string, string, string, bool) error + Login(string, string, string, string, bool) (bool, error) + UsersForHost(string) []string } type LoginOptions struct { - IO *iostreams.IOStreams - Config iconfig - HTTPClient *http.Client - GitClient *git.Client - Hostname string - Interactive bool - Web bool - Scopes []string - Executable string - GitProtocol string - Prompter Prompt - Browser browser.Browser - SecureStorage bool + IO *iostreams.IOStreams + Config iconfig + HTTPClient *http.Client + Hostname string + Interactive bool + Web bool + Scopes []string + GitProtocol string + Prompter Prompt + Browser browser.Browser + CredentialFlow *GitCredentialFlow + SecureStorage bool + SkipSSHKeyPrompt bool sshContext ssh.Context } @@ -56,7 +57,7 @@ func Login(opts *LoginOptions) error { "SSH", } result, err := opts.Prompter.Select( - "What is your preferred protocol for Git operations?", + "What is your preferred protocol for Git operations on this host?", options[0], options) if err != nil { @@ -68,21 +69,16 @@ func Login(opts *LoginOptions) error { var additionalScopes []string - credentialFlow := &GitCredentialFlow{ - Executable: opts.Executable, - Prompter: opts.Prompter, - GitClient: opts.GitClient, - } if opts.Interactive && gitProtocol == "https" { - if err := credentialFlow.Prompt(hostname); err != nil { + if err := opts.CredentialFlow.Prompt(hostname); err != nil { return err } - additionalScopes = append(additionalScopes, credentialFlow.Scopes()...) + additionalScopes = append(additionalScopes, opts.CredentialFlow.Scopes()...) } var keyToUpload string keyTitle := defaultSSHKeyTitle - if opts.Interactive && gitProtocol == "ssh" { + if opts.Interactive && !opts.SkipSSHKeyPrompt && gitProtocol == "ssh" { pubKeys, err := opts.sshContext.LocalPublicKeys() if err != nil { return err @@ -108,7 +104,7 @@ func Login(opts *LoginOptions) error { if sshChoice { passphrase, err := opts.Prompter.Password( - "Enter a passphrase for your new SSH key (Optional)") + "Enter a passphrase for your new SSH key (Optional):") if err != nil { return err } @@ -177,23 +173,36 @@ func Login(opts *LoginOptions) error { if username == "" { var err error - username, err = getCurrentLogin(httpClient, hostname, authToken) + username, err = GetCurrentLogin(httpClient, hostname, authToken) if err != nil { - return fmt.Errorf("error using api: %w", err) + return fmt.Errorf("error retrieving current user: %w", err) } } + // Get these users before adding the new one, so that we can + // check whether the user was already logged in later. + // + // In this case we ignore the error if the host doesn't exist + // because that can occur when the user is logging into a host + // for the first time. + usersForHost := cfg.UsersForHost(hostname) + userWasAlreadyLoggedIn := slices.Contains(usersForHost, username) + if gitProtocol != "" { fmt.Fprintf(opts.IO.ErrOut, "- gh config set -h %s git_protocol %s\n", hostname, gitProtocol) fmt.Fprintf(opts.IO.ErrOut, "%s Configured git protocol\n", cs.SuccessIcon()) } - if err := cfg.Login(hostname, username, authToken, gitProtocol, opts.SecureStorage); err != nil { + insecureStorageUsed, err := cfg.Login(hostname, username, authToken, gitProtocol, opts.SecureStorage) + if err != nil { return err } + if insecureStorageUsed { + fmt.Fprintf(opts.IO.ErrOut, "%s Authentication credentials saved in plain text\n", cs.Yellow("!")) + } - if credentialFlow.ShouldSetup() { - err := credentialFlow.Setup(hostname, username, authToken) + if opts.CredentialFlow.ShouldSetup() { + err := opts.CredentialFlow.Setup(hostname, username, authToken) if err != nil { return err } @@ -213,6 +222,10 @@ func Login(opts *LoginOptions) error { } fmt.Fprintf(opts.IO.ErrOut, "%s Logged in as %s\n", cs.SuccessIcon(), cs.Bold(username)) + if userWasAlreadyLoggedIn { + fmt.Fprintf(opts.IO.ErrOut, "%s You were already logged in to this account\n", cs.WarningIcon()) + } + return nil } @@ -234,7 +247,7 @@ func sshKeyUpload(httpClient *http.Client, hostname, keyFile string, title strin return add.SSHKeyUpload(httpClient, hostname, f, title) } -func getCurrentLogin(httpClient httpClient, hostname, authToken string) (string, error) { +func GetCurrentLogin(httpClient httpClient, hostname, authToken string) (string, error) { query := `query UserCurrent{viewer{login}}` reqBody, err := json.Marshal(map[string]interface{}{"query": query}) if err != nil { diff --git a/pkg/cmd/auth/shared/login_flow_test.go b/pkg/cmd/auth/shared/login_flow_test.go index 15cc3d2d6..8c8ba5d72 100644 --- a/pkg/cmd/auth/shared/login_flow_test.go +++ b/pkg/cmd/auth/shared/login_flow_test.go @@ -10,109 +10,338 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/internal/prompter" "github.com/cli/cli/v2/internal/run" + "github.com/cli/cli/v2/pkg/cmd/auth/shared/gitcredentials" "github.com/cli/cli/v2/pkg/httpmock" "github.com/cli/cli/v2/pkg/iostreams" "github.com/cli/cli/v2/pkg/ssh" "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" ) type tinyConfig map[string]string -func (c tinyConfig) Login(host, username, token, gitProtocol string, encrypt bool) error { +func (c tinyConfig) Login(host, username, token, gitProtocol string, encrypt bool) (bool, error) { c[fmt.Sprintf("%s:%s", host, "user")] = username c[fmt.Sprintf("%s:%s", host, "oauth_token")] = token c[fmt.Sprintf("%s:%s", host, "git_protocol")] = gitProtocol + return false, nil +} + +func (c tinyConfig) UsersForHost(hostname string) []string { return nil } -func TestLogin_ssh(t *testing.T) { - dir := t.TempDir() - ios, _, stdout, stderr := iostreams.Test() +func TestLogin(t *testing.T) { + tests := []struct { + name string + opts LoginOptions + httpStubs func(*testing.T, *httpmock.Registry) + runStubs func(*testing.T, *run.CommandStubber, *LoginOptions) + wantsConfig map[string]string + wantsErr string + stdout string + stderr string + stderrAssert func(*testing.T, *LoginOptions, string) + }{ + { + name: "tty, prompt (protocol: ssh, create key: yes)", + opts: LoginOptions{ + Prompter: &prompter.PrompterMock{ + SelectFunc: func(prompt, _ string, opts []string) (int, error) { + switch prompt { + case "What is your preferred protocol for Git operations on this host?": + return prompter.IndexFor(opts, "SSH") + case "How would you like to authenticate GitHub CLI?": + return prompter.IndexFor(opts, "Paste an authentication token") + } + return -1, prompter.NoSuchPromptErr(prompt) + }, + PasswordFunc: func(_ string) (string, error) { + return "monkey", nil + }, + ConfirmFunc: func(prompt string, _ bool) (bool, error) { + return true, nil + }, + AuthTokenFunc: func() (string, error) { + return "ATOKEN", nil + }, + InputFunc: func(_, _ string) (string, error) { + return "Test Key", nil + }, + }, - tr := httpmock.Registry{} - defer tr.Verify(t) + Hostname: "example.com", + Interactive: true, + }, + httpStubs: func(t *testing.T, reg *httpmock.Registry) { + reg.Register( + httpmock.REST("GET", "api/v3/"), + httpmock.ScopesResponder("repo,read:org")) + reg.Register( + httpmock.GraphQL(`query UserCurrent\b`), + httpmock.StringResponse(`{"data":{"viewer":{ "login": "monalisa" }}}`)) + reg.Register( + httpmock.REST("GET", "api/v3/user/keys"), + httpmock.StringResponse(`[]`)) + reg.Register( + httpmock.REST("POST", "api/v3/user/keys"), + httpmock.StringResponse(`{}`)) + }, + runStubs: func(t *testing.T, cs *run.CommandStubber, opts *LoginOptions) { + dir := t.TempDir() + keyFile := filepath.Join(dir, "id_ed25519") + cs.Register(`ssh-keygen`, 0, "", func(args []string) { + expected := []string{ + "ssh-keygen", "-t", "ed25519", + "-C", "", + "-N", "monkey", + "-f", keyFile, + } + assert.Equal(t, expected, args) + // simulate that the public key file has been generated + _ = os.WriteFile(keyFile+".pub", []byte("PUBKEY asdf"), 0600) + }) + opts.sshContext = ssh.Context{ + ConfigDir: dir, + KeygenExe: "ssh-keygen", + } + }, + wantsConfig: map[string]string{ + "example.com:user": "monalisa", + "example.com:oauth_token": "ATOKEN", + "example.com:git_protocol": "ssh", + }, + stderrAssert: func(t *testing.T, opts *LoginOptions, stderr string) { + assert.Equal(t, heredoc.Docf(` + Tip: you can generate a Personal Access Token here https://example.com/settings/tokens + The minimum required scopes are 'repo', 'read:org', 'admin:public_key'. + - gh config set -h example.com git_protocol ssh + ✓ Configured git protocol + ✓ Uploaded the SSH key to your GitHub account: %s + ✓ Logged in as monalisa + `, filepath.Join(opts.sshContext.ConfigDir, "id_ed25519.pub")), stderr) + }, + }, + { + name: "tty, --git-protocol ssh, prompt (create key: yes)", + opts: LoginOptions{ + Prompter: &prompter.PrompterMock{ + SelectFunc: func(prompt, _ string, opts []string) (int, error) { + switch prompt { + case "How would you like to authenticate GitHub CLI?": + return prompter.IndexFor(opts, "Paste an authentication token") + } + return -1, prompter.NoSuchPromptErr(prompt) + }, + PasswordFunc: func(_ string) (string, error) { + return "monkey", nil + }, + ConfirmFunc: func(prompt string, _ bool) (bool, error) { + return true, nil + }, + AuthTokenFunc: func() (string, error) { + return "ATOKEN", nil + }, + InputFunc: func(_, _ string) (string, error) { + return "Test Key", nil + }, + }, - tr.Register( + Hostname: "example.com", + Interactive: true, + GitProtocol: "SSH", + }, + httpStubs: func(t *testing.T, reg *httpmock.Registry) { + reg.Register( + httpmock.REST("GET", "api/v3/"), + httpmock.ScopesResponder("repo,read:org")) + reg.Register( + httpmock.GraphQL(`query UserCurrent\b`), + httpmock.StringResponse(`{"data":{"viewer":{ "login": "monalisa" }}}`)) + reg.Register( + httpmock.REST("GET", "api/v3/user/keys"), + httpmock.StringResponse(`[]`)) + reg.Register( + httpmock.REST("POST", "api/v3/user/keys"), + httpmock.StringResponse(`{}`)) + }, + runStubs: func(t *testing.T, cs *run.CommandStubber, opts *LoginOptions) { + dir := t.TempDir() + keyFile := filepath.Join(dir, "id_ed25519") + cs.Register(`ssh-keygen`, 0, "", func(args []string) { + expected := []string{ + "ssh-keygen", "-t", "ed25519", + "-C", "", + "-N", "monkey", + "-f", keyFile, + } + assert.Equal(t, expected, args) + // simulate that the public key file has been generated + _ = os.WriteFile(keyFile+".pub", []byte("PUBKEY asdf"), 0600) + }) + opts.sshContext = ssh.Context{ + ConfigDir: dir, + KeygenExe: "ssh-keygen", + } + }, + wantsConfig: map[string]string{ + "example.com:user": "monalisa", + "example.com:oauth_token": "ATOKEN", + "example.com:git_protocol": "ssh", + }, + stderrAssert: func(t *testing.T, opts *LoginOptions, stderr string) { + assert.Equal(t, heredoc.Docf(` + Tip: you can generate a Personal Access Token here https://example.com/settings/tokens + The minimum required scopes are 'repo', 'read:org', 'admin:public_key'. + - gh config set -h example.com git_protocol ssh + ✓ Configured git protocol + ✓ Uploaded the SSH key to your GitHub account: %s + ✓ Logged in as monalisa + `, filepath.Join(opts.sshContext.ConfigDir, "id_ed25519.pub")), stderr) + }, + }, + { + name: "tty, --git-protocol ssh, --skip-ssh-key", + opts: LoginOptions{ + Prompter: &prompter.PrompterMock{ + SelectFunc: func(prompt, _ string, opts []string) (int, error) { + if prompt == "How would you like to authenticate GitHub CLI?" { + return prompter.IndexFor(opts, "Paste an authentication token") + } + return -1, prompter.NoSuchPromptErr(prompt) + }, + AuthTokenFunc: func() (string, error) { + return "ATOKEN", nil + }, + }, + + Hostname: "example.com", + Interactive: true, + GitProtocol: "SSH", + SkipSSHKeyPrompt: true, + }, + httpStubs: func(t *testing.T, reg *httpmock.Registry) { + reg.Register( + httpmock.REST("GET", "api/v3/"), + httpmock.ScopesResponder("repo,read:org")) + reg.Register( + httpmock.GraphQL(`query UserCurrent\b`), + httpmock.StringResponse(`{"data":{"viewer":{ "login": "monalisa" }}}`)) + }, + wantsConfig: map[string]string{ + "example.com:user": "monalisa", + "example.com:oauth_token": "ATOKEN", + "example.com:git_protocol": "ssh", + }, + stderr: heredoc.Doc(` + Tip: you can generate a Personal Access Token here https://example.com/settings/tokens + The minimum required scopes are 'repo', 'read:org'. + - gh config set -h example.com git_protocol ssh + ✓ Configured git protocol + ✓ Logged in as monalisa + `), + }, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + reg := &httpmock.Registry{} + defer reg.Verify(t) + if tt.httpStubs != nil { + tt.httpStubs(t, reg) + } + + cfg := tinyConfig{} + ios, _, stdout, stderr := iostreams.Test() + + tt.opts.IO = ios + tt.opts.Config = &cfg + tt.opts.HTTPClient = &http.Client{Transport: reg} + tt.opts.CredentialFlow = &GitCredentialFlow{ + // Intentionally not instantiating anything in here because the tests do not hit this code path. + // Right now it's better to panic if we write a test that hits the code than say, start calling + // out to git unintentionally. + } + + if tt.runStubs != nil { + rs, runRestore := run.Stub() + defer runRestore(t) + tt.runStubs(t, rs, &tt.opts) + } + + err := Login(&tt.opts) + + if tt.wantsErr != "" { + assert.EqualError(t, err, tt.wantsErr) + } else { + assert.NoError(t, err) + assert.Equal(t, tt.wantsConfig, map[string]string(cfg)) + } + + assert.Equal(t, tt.stdout, stdout.String()) + + if tt.stderrAssert != nil { + tt.stderrAssert(t, &tt.opts, stderr.String()) + } else { + assert.Equal(t, tt.stderr, stderr.String()) + } + }) + } +} + +func TestAuthenticatingGitCredentials(t *testing.T) { + // Given we have no host or global credential helpers configured + // And given they have chosen https as their git protocol + // When they choose to authenticate git with their GitHub credentials + // Then gh is configured as their credential helper for that host + ios, _, _, _ := iostreams.Test() + + reg := &httpmock.Registry{} + defer reg.Verify(t) + reg.Register( httpmock.REST("GET", "api/v3/"), httpmock.ScopesResponder("repo,read:org")) - tr.Register( + reg.Register( httpmock.GraphQL(`query UserCurrent\b`), httpmock.StringResponse(`{"data":{"viewer":{ "login": "monalisa" }}}`)) - tr.Register( - httpmock.REST("GET", "api/v3/user/keys"), - httpmock.StringResponse(`[]`)) - tr.Register( - httpmock.REST("POST", "api/v3/user/keys"), - httpmock.StringResponse(`{}`)) - pm := &prompter.PrompterMock{} - pm.SelectFunc = func(prompt, _ string, opts []string) (int, error) { - switch prompt { - case "What is your preferred protocol for Git operations?": - return prompter.IndexFor(opts, "SSH") - case "How would you like to authenticate GitHub CLI?": - return prompter.IndexFor(opts, "Paste an authentication token") - } - return -1, prompter.NoSuchPromptErr(prompt) - } - pm.PasswordFunc = func(_ string) (string, error) { - return "monkey", nil - } - pm.ConfirmFunc = func(prompt string, _ bool) (bool, error) { - return true, nil - } - pm.AuthTokenFunc = func() (string, error) { - return "ATOKEN", nil - } - pm.InputFunc = func(_, _ string) (string, error) { - return "Test Key", nil - } - - rs, runRestore := run.Stub() - defer runRestore(t) - - keyFile := filepath.Join(dir, "id_ed25519") - rs.Register(`ssh-keygen`, 0, "", func(args []string) { - expected := []string{ - "ssh-keygen", "-t", "ed25519", - "-C", "", - "-N", "monkey", - "-f", keyFile, - } - assert.Equal(t, expected, args) - // simulate that the public key file has been generated - _ = os.WriteFile(keyFile+".pub", []byte("PUBKEY asdf"), 0600) - }) - - cfg := tinyConfig{} - - err := Login(&LoginOptions{ + opts := &LoginOptions{ IO: ios, - Config: &cfg, - Prompter: pm, - HTTPClient: &http.Client{Transport: &tr}, + Config: tinyConfig{}, + HTTPClient: &http.Client{Transport: reg}, Hostname: "example.com", Interactive: true, - sshContext: ssh.Context{ - ConfigDir: dir, - KeygenExe: "ssh-keygen", + GitProtocol: "https", + Prompter: &prompter.PrompterMock{ + SelectFunc: func(prompt, _ string, opts []string) (int, error) { + if prompt == "How would you like to authenticate GitHub CLI?" { + return prompter.IndexFor(opts, "Paste an authentication token") + } + return -1, prompter.NoSuchPromptErr(prompt) + }, + AuthTokenFunc: func() (string, error) { + return "ATOKEN", nil + }, }, - }) - assert.NoError(t, err) + CredentialFlow: &GitCredentialFlow{ + Prompter: &prompter.PrompterMock{ + ConfirmFunc: func(prompt string, _ bool) (bool, error) { + return true, nil + }, + }, + HelperConfig: &gitcredentials.FakeHelperConfig{ + SelfExecutablePath: "/path/to/gh", + Helpers: map[string]gitcredentials.Helper{}, + }, + // Updater not required for this test as we will be setting gh as the helper + }, + } - assert.Equal(t, "", stdout.String()) - assert.Equal(t, heredoc.Docf(` - Tip: you can generate a Personal Access Token here https://example.com/settings/tokens - The minimum required scopes are 'repo', 'read:org', 'admin:public_key'. - - gh config set -h example.com git_protocol ssh - ✓ Configured git protocol - ✓ Uploaded the SSH key to your GitHub account: %s.pub - ✓ Logged in as monalisa - `, keyFile), stderr.String()) + require.NoError(t, Login(opts)) - assert.Equal(t, "monalisa", cfg["example.com:user"]) - assert.Equal(t, "ATOKEN", cfg["example.com:oauth_token"]) - assert.Equal(t, "ssh", cfg["example.com:git_protocol"]) + helper, err := opts.CredentialFlow.HelperConfig.ConfiguredHelper("example.com") + require.NoError(t, err) + require.True(t, helper.IsOurs(), "expected gh to be the configured helper") } func Test_scopesSentence(t *testing.T) { diff --git a/pkg/cmd/auth/shared/writeable.go b/pkg/cmd/auth/shared/writeable.go index cf8e678e4..381c7e02a 100644 --- a/pkg/cmd/auth/shared/writeable.go +++ b/pkg/cmd/auth/shared/writeable.go @@ -3,10 +3,10 @@ package shared import ( "strings" - "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" ) -func AuthTokenWriteable(authCfg *config.AuthConfig, hostname string) (string, bool) { - token, src := authCfg.Token(hostname) +func AuthTokenWriteable(authCfg gh.AuthConfig, hostname string) (string, bool) { + token, src := authCfg.ActiveToken(hostname) return src, (token == "" || !strings.HasSuffix(src, "_TOKEN")) } diff --git a/pkg/cmd/auth/status/status.go b/pkg/cmd/auth/status/status.go index 1739cfe09..153c03c04 100644 --- a/pkg/cmd/auth/status/status.go +++ b/pkg/cmd/auth/status/status.go @@ -3,23 +3,129 @@ package status import ( "errors" "fmt" + "net" "net/http" "path/filepath" + "slices" "strings" "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/api" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/pkg/cmd/auth/shared" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" "github.com/spf13/cobra" ) +type validEntry struct { + active bool + host string + user string + token string + tokenSource string + gitProtocol string + scopes string +} + +func (e validEntry) String(cs *iostreams.ColorScheme) string { + var sb strings.Builder + + sb.WriteString( + fmt.Sprintf(" %s Logged in to %s account %s (%s)\n", cs.SuccessIcon(), e.host, cs.Bold(e.user), e.tokenSource), + ) + activeStr := fmt.Sprintf("%v", e.active) + sb.WriteString(fmt.Sprintf(" - Active account: %s\n", cs.Bold(activeStr))) + sb.WriteString(fmt.Sprintf(" - Git operations protocol: %s\n", cs.Bold(e.gitProtocol))) + sb.WriteString(fmt.Sprintf(" - Token: %s\n", cs.Bold(e.token))) + + if expectScopes(e.token) { + sb.WriteString(fmt.Sprintf(" - Token scopes: %s\n", cs.Bold(displayScopes(e.scopes)))) + if err := shared.HeaderHasMinimumScopes(e.scopes); err != nil { + var missingScopesError *shared.MissingScopesError + if errors.As(err, &missingScopesError) { + missingScopes := strings.Join(missingScopesError.MissingScopes, ",") + sb.WriteString(fmt.Sprintf(" %s Missing required token scopes: %s\n", + cs.WarningIcon(), + cs.Bold(displayScopes(missingScopes)))) + refreshInstructions := fmt.Sprintf("gh auth refresh -h %s", e.host) + sb.WriteString(fmt.Sprintf(" - To request missing scopes, run: %s\n", cs.Bold(refreshInstructions))) + } + } + } + + return sb.String() +} + +type invalidTokenEntry struct { + active bool + host string + user string + tokenSource string + tokenIsWriteable bool +} + +func (e invalidTokenEntry) String(cs *iostreams.ColorScheme) string { + var sb strings.Builder + + if e.user != "" { + sb.WriteString(fmt.Sprintf(" %s Failed to log in to %s account %s (%s)\n", cs.Red("X"), e.host, cs.Bold(e.user), e.tokenSource)) + } else { + sb.WriteString(fmt.Sprintf(" %s Failed to log in to %s using token (%s)\n", cs.Red("X"), e.host, e.tokenSource)) + } + activeStr := fmt.Sprintf("%v", e.active) + sb.WriteString(fmt.Sprintf(" - Active account: %s\n", cs.Bold(activeStr))) + sb.WriteString(fmt.Sprintf(" - The token in %s is invalid.\n", e.tokenSource)) + if e.tokenIsWriteable { + loginInstructions := fmt.Sprintf("gh auth login -h %s", e.host) + logoutInstructions := fmt.Sprintf("gh auth logout -h %s -u %s", e.host, e.user) + sb.WriteString(fmt.Sprintf(" - To re-authenticate, run: %s\n", cs.Bold(loginInstructions))) + sb.WriteString(fmt.Sprintf(" - To forget about this account, run: %s\n", cs.Bold(logoutInstructions))) + } + + return sb.String() +} + +type timeoutErrorEntry struct { + active bool + host string + user string + tokenSource string +} + +func (e timeoutErrorEntry) String(cs *iostreams.ColorScheme) string { + var sb strings.Builder + + if e.user != "" { + sb.WriteString(fmt.Sprintf(" %s Timeout trying to log in to %s account %s (%s)\n", cs.Red("X"), e.host, cs.Bold(e.user), e.tokenSource)) + } else { + sb.WriteString(fmt.Sprintf(" %s Timeout trying to log in to %s using token (%s)\n", cs.Red("X"), e.host, e.tokenSource)) + } + activeStr := fmt.Sprintf("%v", e.active) + sb.WriteString(fmt.Sprintf(" - Active account: %s\n", cs.Bold(activeStr))) + + return sb.String() +} + +type Entry interface { + String(cs *iostreams.ColorScheme) string +} + +type Entries []Entry + +func (e Entries) Strings(cs *iostreams.ColorScheme) []string { + var out []string + for _, entry := range e { + out = append(out, entry.String(cs)) + } + return out +} + type StatusOptions struct { HttpClient func() (*http.Client, error) IO *iostreams.IOStreams - Config func() (config.Config, error) + Config func() (gh.Config, error) Hostname string ShowToken bool @@ -35,12 +141,14 @@ func NewCmdStatus(f *cmdutil.Factory, runF func(*StatusOptions) error) *cobra.Co cmd := &cobra.Command{ Use: "status", Args: cobra.ExactArgs(0), - Short: "View authentication status", - Long: heredoc.Doc(`Verifies and displays information about your authentication state. + Short: "Display active account and authentication state on each known GitHub host", + Long: heredoc.Docf(` + Display active account and authentication state on each known GitHub host. - This command will test your authentication state for each GitHub host that gh knows about and - report on any issues. - `), + For each host, the authentication state of each known account is tested and any issues are included in + the output. Each host section will indicate the active account, which will be used when targeting that host. + To change the active account for a host, see %[1]sgh auth switch%[1]s. + `, "`"), RunE: func(cmd *cobra.Command, args []string) error { if runF != nil { return runF(opts) @@ -63,18 +171,22 @@ func statusRun(opts *StatusOptions) error { } authCfg := cfg.Authentication() - // TODO check tty - stderr := opts.IO.ErrOut stdout := opts.IO.Out cs := opts.IO.ColorScheme() - statusInfo := map[string][]string{} + statuses := make(map[string]Entries) hostnames := authCfg.Hosts() if len(hostnames) == 0 { fmt.Fprintf(stderr, - "You are not logged into any GitHub hosts. Run %s to authenticate.\n", cs.Bold("gh auth login")) + "You are not logged into any GitHub hosts. To log in, run: %s\n", cs.Bold("gh auth login")) + return cmdutil.SilentError + } + + if opts.Hostname != "" && !slices.Contains(hostnames, opts.Hostname) { + fmt.Fprintf(stderr, + "You are not logged into any accounts on %s\n", opts.Hostname) return cmdutil.SilentError } @@ -83,110 +195,60 @@ func statusRun(opts *StatusOptions) error { return err } - var failed bool - var isHostnameFound bool - for _, hostname := range hostnames { if opts.Hostname != "" && opts.Hostname != hostname { continue } - isHostnameFound = true - token, tokenSource := authCfg.Token(hostname) - if tokenSource == "oauth_token" { - // The go-gh function TokenForHost returns this value as source for tokens read from the - // config file, but we want the file path instead. This attempts to reconstruct it. - tokenSource = filepath.Join(config.ConfigDir(), "hosts.yml") + var activeUser string + gitProtocol := cfg.GitProtocol(hostname).Value + activeUserToken, activeUserTokenSource := authCfg.ActiveToken(hostname) + if authTokenWriteable(activeUserTokenSource) { + activeUser, _ = authCfg.ActiveUser(hostname) } - _, tokenIsWriteable := shared.AuthTokenWriteable(authCfg, hostname) + entry := buildEntry(httpClient, buildEntryOptions{ + active: true, + gitProtocol: gitProtocol, + hostname: hostname, + showToken: opts.ShowToken, + token: activeUserToken, + tokenSource: activeUserTokenSource, + username: activeUser, + }) + statuses[hostname] = append(statuses[hostname], entry) - statusInfo[hostname] = []string{} - addMsg := func(x string, ys ...interface{}) { - statusInfo[hostname] = append(statusInfo[hostname], fmt.Sprintf(x, ys...)) + users := authCfg.UsersForHost(hostname) + for _, username := range users { + if username == activeUser { + continue + } + token, tokenSource, _ := authCfg.TokenForUser(hostname, username) + entry := buildEntry(httpClient, buildEntryOptions{ + active: false, + gitProtocol: gitProtocol, + hostname: hostname, + showToken: opts.ShowToken, + token: token, + tokenSource: tokenSource, + username: username, + }) + statuses[hostname] = append(statuses[hostname], entry) } - - scopesHeader, err := shared.GetScopes(httpClient, hostname, token) - if err != nil { - addMsg("%s %s: authentication failed", cs.Red("X"), hostname) - addMsg("- The %s token in %s is invalid.", cs.Bold(hostname), tokenSource) - if tokenIsWriteable { - addMsg("- To re-authenticate, run: %s %s", - cs.Bold("gh auth login -h"), cs.Bold(hostname)) - addMsg("- To forget about this host, run: %s %s", - cs.Bold("gh auth logout -h"), cs.Bold(hostname)) - } - failed = true - continue - } - - if err := shared.HeaderHasMinimumScopes(scopesHeader); err != nil { - var missingScopes *shared.MissingScopesError - if errors.As(err, &missingScopes) { - addMsg("%s %s: the token in %s is %s", cs.Red("X"), hostname, tokenSource, err) - if tokenIsWriteable { - addMsg("- To request missing scopes, run: %s %s", - cs.Bold("gh auth refresh -h"), - cs.Bold(hostname)) - } - } - failed = true - } else { - apiClient := api.NewClientFromHTTP(httpClient) - username, err := api.CurrentLoginName(apiClient, hostname) - if err != nil { - addMsg("%s %s: api call failed: %s", cs.Red("X"), hostname, err) - failed = true - } - - addMsg("%s Logged in to %s as %s (%s)", cs.SuccessIcon(), hostname, cs.Bold(username), tokenSource) - proto, _ := authCfg.GitProtocol(hostname) - if proto != "" { - addMsg("%s Git operations for %s configured to use %s protocol.", - cs.SuccessIcon(), hostname, cs.Bold(proto)) - } - addMsg("%s Token: %s", cs.SuccessIcon(), displayToken(token, opts.ShowToken)) - - if scopesHeader != "" { - addMsg("%s Token scopes: %s", cs.SuccessIcon(), scopesHeader) - } else if expectScopes(token) { - addMsg("%s Token scopes: none", cs.Red("X")) - } - } - } - - if !isHostnameFound { - fmt.Fprintf(stderr, - "Hostname %q not found among authenticated GitHub hosts\n", opts.Hostname) - return cmdutil.SilentError } prevEntry := false for _, hostname := range hostnames { - lines, ok := statusInfo[hostname] + entries, ok := statuses[hostname] if !ok { continue } - if prevEntry && failed { - fmt.Fprint(stderr, "\n") - } else if prevEntry && !failed { + + if prevEntry { fmt.Fprint(stdout, "\n") } prevEntry = true - if failed { - fmt.Fprintf(stderr, "%s\n", cs.Bold(hostname)) - for _, line := range lines { - fmt.Fprintf(stderr, " %s\n", line) - } - } else { - fmt.Fprintf(stdout, "%s\n", cs.Bold(hostname)) - for _, line := range lines { - fmt.Fprintf(stdout, " %s\n", line) - } - } - } - - if failed { - return cmdutil.SilentError + fmt.Fprintf(stdout, "%s\n", cs.Bold(hostname)) + fmt.Fprintf(stdout, "%s", strings.Join(entries.Strings(cs), "\n")) } return nil @@ -205,6 +267,92 @@ func displayToken(token string, printRaw bool) string { return strings.Repeat("*", len(token)) } +func displayScopes(scopes string) string { + if scopes == "" { + return "none" + } + list := strings.Split(scopes, ",") + for i, s := range list { + list[i] = fmt.Sprintf("'%s'", strings.TrimSpace(s)) + } + return strings.Join(list, ", ") +} + func expectScopes(token string) bool { return strings.HasPrefix(token, "ghp_") || strings.HasPrefix(token, "gho_") } + +type buildEntryOptions struct { + active bool + gitProtocol string + hostname string + showToken bool + token string + tokenSource string + username string +} + +func buildEntry(httpClient *http.Client, opts buildEntryOptions) Entry { + tokenIsWriteable := authTokenWriteable(opts.tokenSource) + + if opts.tokenSource == "oauth_token" { + // The go-gh function TokenForHost returns this value as source for tokens read from the + // config file, but we want the file path instead. This attempts to reconstruct it. + opts.tokenSource = filepath.Join(config.ConfigDir(), "hosts.yml") + } + + // If token is not writeable, then it came from an environment variable and + // we need to fetch the username as it won't be stored in the config. + if !tokenIsWriteable { + // The httpClient will automatically use the correct token here as + // the token from the environment variable take highest precedence. + apiClient := api.NewClientFromHTTP(httpClient) + var err error + opts.username, err = api.CurrentLoginName(apiClient, opts.hostname) + if err != nil { + return invalidTokenEntry{ + active: opts.active, + host: opts.hostname, + user: opts.username, + tokenIsWriteable: tokenIsWriteable, + tokenSource: opts.tokenSource, + } + } + } + + // Get scopes for token. + scopesHeader, err := shared.GetScopes(httpClient, opts.hostname, opts.token) + if err != nil { + var networkError net.Error + if errors.As(err, &networkError) && networkError.Timeout() { + return timeoutErrorEntry{ + active: opts.active, + host: opts.hostname, + user: opts.username, + tokenSource: opts.tokenSource, + } + } + + return invalidTokenEntry{ + active: opts.active, + host: opts.hostname, + user: opts.username, + tokenIsWriteable: tokenIsWriteable, + tokenSource: opts.tokenSource, + } + } + + return validEntry{ + active: opts.active, + gitProtocol: opts.gitProtocol, + host: opts.hostname, + scopes: scopesHeader, + token: displayToken(opts.token, opts.showToken), + tokenSource: opts.tokenSource, + user: opts.username, + } +} + +func authTokenWriteable(src string) bool { + return !strings.HasSuffix(src, "_TOKEN") +} diff --git a/pkg/cmd/auth/status/status_test.go b/pkg/cmd/auth/status/status_test.go index 07cbe0be8..ce4897978 100644 --- a/pkg/cmd/auth/status/status_test.go +++ b/pkg/cmd/auth/status/status_test.go @@ -2,6 +2,7 @@ package status import ( "bytes" + "context" "net/http" "path/filepath" "strings" @@ -9,11 +10,13 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/httpmock" "github.com/cli/cli/v2/pkg/iostreams" "github.com/google/shlex" "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" ) func Test_NewCmdStatus(t *testing.T) { @@ -73,110 +76,104 @@ func Test_NewCmdStatus(t *testing.T) { } func Test_statusRun(t *testing.T) { - readConfigs := config.StubWriteConfig(t) - tests := []struct { name string - opts *StatusOptions + opts StatusOptions + env map[string]string httpStubs func(*httpmock.Registry) - cfgStubs func(*config.ConfigMock) - wantErr string + cfgStubs func(*testing.T, gh.Config) + wantErr error wantOut string wantErrOut string }{ { - name: "hostname set", - opts: &StatusOptions{ - Hostname: "joel.miller", + name: "timeout error", + opts: StatusOptions{ + Hostname: "github.com", }, - cfgStubs: func(c *config.ConfigMock) { - c.Set("joel.miller", "oauth_token", "abc123") - c.Set("github.com", "oauth_token", "abc123") + cfgStubs: func(t *testing.T, c gh.Config) { + login(t, c, "github.com", "monalisa", "abc123", "https") + }, + httpStubs: func(reg *httpmock.Registry) { + reg.Register(httpmock.REST("GET", ""), func(req *http.Request) (*http.Response, error) { + // timeout error + return nil, context.DeadlineExceeded + }) + }, + wantOut: heredoc.Doc(` + github.com + X Timeout trying to log in to github.com account monalisa (GH_CONFIG_DIR/hosts.yml) + - Active account: true + `), + }, + { + name: "hostname set", + opts: StatusOptions{ + Hostname: "ghe.io", + }, + cfgStubs: func(t *testing.T, c gh.Config) { + login(t, c, "github.com", "monalisa", "gho_abc123", "https") + login(t, c, "ghe.io", "monalisa-ghe", "gho_abc123", "https") }, httpStubs: func(reg *httpmock.Registry) { // mocks for HeaderHasMinimumScopes api requests to a non-github.com host reg.Register(httpmock.REST("GET", "api/v3/"), httpmock.ScopesResponder("repo,read:org")) - // mock for CurrentLoginName - reg.Register( - httpmock.GraphQL(`query UserCurrent\b`), - httpmock.StringResponse(`{"data":{"viewer":{"login":"tess"}}}`)) }, wantOut: heredoc.Doc(` - joel.miller - ✓ Logged in to joel.miller as tess (GH_CONFIG_DIR/hosts.yml) - ✓ Git operations for joel.miller configured to use https protocol. - ✓ Token: ****** - ✓ Token scopes: repo,read:org + ghe.io + ✓ Logged in to ghe.io account monalisa-ghe (GH_CONFIG_DIR/hosts.yml) + - Active account: true + - Git operations protocol: https + - Token: gho_****** + - Token scopes: 'repo', 'read:org' `), }, { name: "missing scope", - opts: &StatusOptions{}, - cfgStubs: func(c *config.ConfigMock) { - c.Set("joel.miller", "oauth_token", "abc123") - c.Set("github.com", "oauth_token", "abc123") + opts: StatusOptions{}, + cfgStubs: func(t *testing.T, c gh.Config) { + login(t, c, "ghe.io", "monalisa-ghe", "gho_abc123", "https") }, httpStubs: func(reg *httpmock.Registry) { // mocks for HeaderHasMinimumScopes api requests to a non-github.com host reg.Register(httpmock.REST("GET", "api/v3/"), httpmock.ScopesResponder("repo")) - // mocks for HeaderHasMinimumScopes api requests to github.com host - reg.Register(httpmock.REST("GET", ""), httpmock.ScopesResponder("repo,read:org")) - // mock for CurrentLoginName - reg.Register( - httpmock.GraphQL(`query UserCurrent\b`), - httpmock.StringResponse(`{"data":{"viewer":{"login":"tess"}}}`)) }, - wantErr: "SilentError", - wantErrOut: heredoc.Doc(` - joel.miller - X joel.miller: the token in GH_CONFIG_DIR/hosts.yml is missing required scope 'read:org' - - To request missing scopes, run: gh auth refresh -h joel.miller - - github.com - ✓ Logged in to github.com as tess (GH_CONFIG_DIR/hosts.yml) - ✓ Git operations for github.com configured to use https protocol. - ✓ Token: ****** - ✓ Token scopes: repo,read:org + wantOut: heredoc.Doc(` + ghe.io + ✓ Logged in to ghe.io account monalisa-ghe (GH_CONFIG_DIR/hosts.yml) + - Active account: true + - Git operations protocol: https + - Token: gho_****** + - Token scopes: 'repo' + ! Missing required token scopes: 'read:org' + - To request missing scopes, run: gh auth refresh -h ghe.io `), }, { name: "bad token", - opts: &StatusOptions{}, - cfgStubs: func(c *config.ConfigMock) { - c.Set("joel.miller", "oauth_token", "abc123") - c.Set("github.com", "oauth_token", "abc123") + opts: StatusOptions{}, + cfgStubs: func(t *testing.T, c gh.Config) { + login(t, c, "ghe.io", "monalisa-ghe", "gho_abc123", "https") }, httpStubs: func(reg *httpmock.Registry) { // mock for HeaderHasMinimumScopes api requests to a non-github.com host reg.Register(httpmock.REST("GET", "api/v3/"), httpmock.StatusStringResponse(400, "no bueno")) - // mock for HeaderHasMinimumScopes api requests to github.com - reg.Register(httpmock.REST("GET", ""), httpmock.ScopesResponder("repo,read:org")) - // mock for CurrentLoginName - reg.Register( - httpmock.GraphQL(`query UserCurrent\b`), - httpmock.StringResponse(`{"data":{"viewer":{"login":"tess"}}}`)) }, - wantErr: "SilentError", - wantErrOut: heredoc.Doc(` - joel.miller - X joel.miller: authentication failed - - The joel.miller token in GH_CONFIG_DIR/hosts.yml is invalid. - - To re-authenticate, run: gh auth login -h joel.miller - - To forget about this host, run: gh auth logout -h joel.miller - - github.com - ✓ Logged in to github.com as tess (GH_CONFIG_DIR/hosts.yml) - ✓ Git operations for github.com configured to use https protocol. - ✓ Token: ****** - ✓ Token scopes: repo,read:org + wantOut: heredoc.Doc(` + ghe.io + X Failed to log in to ghe.io account monalisa-ghe (GH_CONFIG_DIR/hosts.yml) + - Active account: true + - The token in GH_CONFIG_DIR/hosts.yml is invalid. + - To re-authenticate, run: gh auth login -h ghe.io + - To forget about this account, run: gh auth logout -h ghe.io -u monalisa-ghe `), }, { name: "all good", - opts: &StatusOptions{}, - cfgStubs: func(c *config.ConfigMock) { - c.Set("github.com", "oauth_token", "gho_abc123") - c.Set("joel.miller", "oauth_token", "gho_abc123") + opts: StatusOptions{}, + cfgStubs: func(t *testing.T, c gh.Config) { + login(t, c, "github.com", "monalisa", "gho_abc123", "https") + login(t, c, "ghe.io", "monalisa-ghe", "gho_abc123", "ssh") }, httpStubs: func(reg *httpmock.Registry) { // mocks for HeaderHasMinimumScopes api requests to github.com @@ -187,141 +184,222 @@ func Test_statusRun(t *testing.T) { reg.Register( httpmock.REST("GET", "api/v3/"), httpmock.WithHeader(httpmock.ScopesResponder("repo,read:org"), "X-Oauth-Scopes", "")) - // mock for CurrentLoginName, one for each host - reg.Register( - httpmock.GraphQL(`query UserCurrent\b`), - httpmock.StringResponse(`{"data":{"viewer":{"login":"tess"}}}`)) - reg.Register( - httpmock.GraphQL(`query UserCurrent\b`), - httpmock.StringResponse(`{"data":{"viewer":{"login":"tess"}}}`)) }, wantOut: heredoc.Doc(` github.com - ✓ Logged in to github.com as tess (GH_CONFIG_DIR/hosts.yml) - ✓ Git operations for github.com configured to use https protocol. - ✓ Token: gho_****** - ✓ Token scopes: repo, read:org - - joel.miller - ✓ Logged in to joel.miller as tess (GH_CONFIG_DIR/hosts.yml) - ✓ Git operations for joel.miller configured to use https protocol. - ✓ Token: gho_****** - X Token scopes: none + ✓ Logged in to github.com account monalisa (GH_CONFIG_DIR/hosts.yml) + - Active account: true + - Git operations protocol: https + - Token: gho_****** + - Token scopes: 'repo', 'read:org' + + ghe.io + ✓ Logged in to ghe.io account monalisa-ghe (GH_CONFIG_DIR/hosts.yml) + - Active account: true + - Git operations protocol: ssh + - Token: gho_****** + - Token scopes: none + `), + }, + { + name: "token from env", + opts: StatusOptions{}, + env: map[string]string{"GH_TOKEN": "gho_abc123"}, + cfgStubs: func(t *testing.T, c gh.Config) {}, + httpStubs: func(reg *httpmock.Registry) { + reg.Register( + httpmock.REST("GET", ""), + httpmock.ScopesResponder("")) + reg.Register( + httpmock.GraphQL(`query UserCurrent\b`), + httpmock.StringResponse(`{"data":{"viewer":{"login":"monalisa"}}}`)) + }, + wantOut: heredoc.Doc(` + github.com + ✓ Logged in to github.com account monalisa (GH_TOKEN) + - Active account: true + - Git operations protocol: https + - Token: gho_****** + - Token scopes: none `), }, { name: "server-to-server token", - opts: &StatusOptions{}, - cfgStubs: func(c *config.ConfigMock) { - c.Set("github.com", "oauth_token", "ghs_xxx") + opts: StatusOptions{}, + cfgStubs: func(t *testing.T, c gh.Config) { + login(t, c, "github.com", "monalisa", "ghs_abc123", "https") }, httpStubs: func(reg *httpmock.Registry) { // mocks for HeaderHasMinimumScopes api requests to github.com reg.Register( httpmock.REST("GET", ""), httpmock.ScopesResponder("")) - // mock for CurrentLoginName - reg.Register( - httpmock.GraphQL(`query UserCurrent\b`), - httpmock.StringResponse(`{"data":{"viewer":{"login":"tess"}}}`)) }, wantOut: heredoc.Doc(` github.com - ✓ Logged in to github.com as tess (GH_CONFIG_DIR/hosts.yml) - ✓ Git operations for github.com configured to use https protocol. - ✓ Token: ghs_*** + ✓ Logged in to github.com account monalisa (GH_CONFIG_DIR/hosts.yml) + - Active account: true + - Git operations protocol: https + - Token: ghs_****** `), }, { name: "PAT V2 token", - opts: &StatusOptions{}, - cfgStubs: func(c *config.ConfigMock) { - c.Set("github.com", "oauth_token", "github_pat_xxx") + opts: StatusOptions{}, + cfgStubs: func(t *testing.T, c gh.Config) { + login(t, c, "github.com", "monalisa", "github_pat_abc123", "https") }, httpStubs: func(reg *httpmock.Registry) { // mocks for HeaderHasMinimumScopes api requests to github.com reg.Register( httpmock.REST("GET", ""), httpmock.ScopesResponder("")) - // mock for CurrentLoginName - reg.Register( - httpmock.GraphQL(`query UserCurrent\b`), - httpmock.StringResponse(`{"data":{"viewer":{"login":"tess"}}}`)) }, wantOut: heredoc.Doc(` github.com - ✓ Logged in to github.com as tess (GH_CONFIG_DIR/hosts.yml) - ✓ Git operations for github.com configured to use https protocol. - ✓ Token: github_pat_*** + ✓ Logged in to github.com account monalisa (GH_CONFIG_DIR/hosts.yml) + - Active account: true + - Git operations protocol: https + - Token: github_pat_****** `), }, { name: "show token", - opts: &StatusOptions{ + opts: StatusOptions{ ShowToken: true, }, - cfgStubs: func(c *config.ConfigMock) { - c.Set("github.com", "oauth_token", "xyz456") - c.Set("joel.miller", "oauth_token", "abc123") + cfgStubs: func(t *testing.T, c gh.Config) { + login(t, c, "github.com", "monalisa", "gho_abc123", "https") + login(t, c, "ghe.io", "monalisa-ghe", "gho_xyz456", "https") }, httpStubs: func(reg *httpmock.Registry) { // mocks for HeaderHasMinimumScopes on a non-github.com host reg.Register(httpmock.REST("GET", "api/v3/"), httpmock.ScopesResponder("repo,read:org")) // mocks for HeaderHasMinimumScopes on github.com reg.Register(httpmock.REST("GET", ""), httpmock.ScopesResponder("repo,read:org")) - // mock for CurrentLoginName, one for each host - reg.Register( - httpmock.GraphQL(`query UserCurrent\b`), - httpmock.StringResponse(`{"data":{"viewer":{"login":"tess"}}}`)) - reg.Register( - httpmock.GraphQL(`query UserCurrent\b`), - httpmock.StringResponse(`{"data":{"viewer":{"login":"tess"}}}`)) }, wantOut: heredoc.Doc(` github.com - ✓ Logged in to github.com as tess (GH_CONFIG_DIR/hosts.yml) - ✓ Git operations for github.com configured to use https protocol. - ✓ Token: xyz456 - ✓ Token scopes: repo,read:org - - joel.miller - ✓ Logged in to joel.miller as tess (GH_CONFIG_DIR/hosts.yml) - ✓ Git operations for joel.miller configured to use https protocol. - ✓ Token: abc123 - ✓ Token scopes: repo,read:org + ✓ Logged in to github.com account monalisa (GH_CONFIG_DIR/hosts.yml) + - Active account: true + - Git operations protocol: https + - Token: gho_abc123 + - Token scopes: 'repo', 'read:org' + + ghe.io + ✓ Logged in to ghe.io account monalisa-ghe (GH_CONFIG_DIR/hosts.yml) + - Active account: true + - Git operations protocol: https + - Token: gho_xyz456 + - Token scopes: 'repo', 'read:org' `), }, { name: "missing hostname", - opts: &StatusOptions{ + opts: StatusOptions{ Hostname: "github.example.com", }, - cfgStubs: func(c *config.ConfigMock) { - c.Set("github.com", "oauth_token", "abc123") + cfgStubs: func(t *testing.T, c gh.Config) { + login(t, c, "github.com", "monalisa", "abc123", "https") }, httpStubs: func(reg *httpmock.Registry) {}, - wantErr: "SilentError", - wantErrOut: "Hostname \"github.example.com\" not found among authenticated GitHub hosts\n", + wantErr: cmdutil.SilentError, + wantErrOut: "You are not logged into any accounts on github.example.com\n", + }, + { + name: "multiple accounts on a host", + opts: StatusOptions{}, + cfgStubs: func(t *testing.T, c gh.Config) { + login(t, c, "github.com", "monalisa", "gho_abc123", "https") + login(t, c, "github.com", "monalisa-2", "gho_abc123", "https") + }, + httpStubs: func(reg *httpmock.Registry) { + reg.Register(httpmock.REST("GET", ""), httpmock.ScopesResponder("repo,read:org")) + reg.Register(httpmock.REST("GET", ""), httpmock.ScopesResponder("repo,read:org,project:read")) + }, + wantOut: heredoc.Doc(` + github.com + ✓ Logged in to github.com account monalisa-2 (GH_CONFIG_DIR/hosts.yml) + - Active account: true + - Git operations protocol: https + - Token: gho_****** + - Token scopes: 'repo', 'read:org' + + ✓ Logged in to github.com account monalisa (GH_CONFIG_DIR/hosts.yml) + - Active account: false + - Git operations protocol: https + - Token: gho_****** + - Token scopes: 'repo', 'read:org', 'project:read' + `), + }, + { + name: "multiple hosts with multiple accounts with environment tokens and with errors", + opts: StatusOptions{}, + env: map[string]string{"GH_ENTERPRISE_TOKEN": "gho_abc123"}, + cfgStubs: func(t *testing.T, c gh.Config) { + login(t, c, "github.com", "monalisa", "gho_def456", "https") + login(t, c, "github.com", "monalisa-2", "gho_ghi789", "https") + login(t, c, "ghe.io", "monalisa-ghe", "gho_xyz123", "ssh") + }, + httpStubs: func(reg *httpmock.Registry) { + // Get scopes for monalia-2 + reg.Register(httpmock.REST("GET", ""), httpmock.ScopesResponder("repo,read:org")) + // Get scopes for monalisa + reg.Register(httpmock.REST("GET", ""), httpmock.ScopesResponder("repo")) + // Get scopes for monalisa-ghe-2 + reg.Register(httpmock.REST("GET", "api/v3/"), httpmock.ScopesResponder("repo,read:org")) + // Error getting scopes for monalisa-ghe + reg.Register(httpmock.REST("GET", "api/v3/"), httpmock.StatusStringResponse(404, "{}")) + // Get username for monalisa-ghe-2 + reg.Register( + httpmock.GraphQL(`query UserCurrent\b`), + httpmock.StringResponse(`{"data":{"viewer":{"login":"monalisa-ghe-2"}}}`)) + }, + wantOut: heredoc.Doc(` + github.com + ✓ Logged in to github.com account monalisa-2 (GH_CONFIG_DIR/hosts.yml) + - Active account: true + - Git operations protocol: https + - Token: gho_****** + - Token scopes: 'repo', 'read:org' + + ✓ Logged in to github.com account monalisa (GH_CONFIG_DIR/hosts.yml) + - Active account: false + - Git operations protocol: https + - Token: gho_****** + - Token scopes: 'repo' + ! Missing required token scopes: 'read:org' + - To request missing scopes, run: gh auth refresh -h github.com + + ghe.io + ✓ Logged in to ghe.io account monalisa-ghe-2 (GH_ENTERPRISE_TOKEN) + - Active account: true + - Git operations protocol: ssh + - Token: gho_****** + - Token scopes: 'repo', 'read:org' + + X Failed to log in to ghe.io account monalisa-ghe (GH_CONFIG_DIR/hosts.yml) + - Active account: false + - The token in GH_CONFIG_DIR/hosts.yml is invalid. + - To re-authenticate, run: gh auth login -h ghe.io + - To forget about this account, run: gh auth logout -h ghe.io -u monalisa-ghe + `), }, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { - if tt.opts == nil { - tt.opts = &StatusOptions{} - } - ios, _, stdout, stderr := iostreams.Test() ios.SetStdinTTY(true) ios.SetStderrTTY(true) ios.SetStdoutTTY(true) tt.opts.IO = ios - cfg := config.NewFromString("") + cfg, _ := config.NewIsolatedTestConfig(t) if tt.cfgStubs != nil { - tt.cfgStubs(cfg) + tt.cfgStubs(t, cfg) } - tt.opts.Config = func() (config.Config, error) { + tt.opts.Config = func() (gh.Config, error) { return cfg, nil } @@ -334,24 +412,27 @@ func Test_statusRun(t *testing.T) { tt.httpStubs(reg) } - err := statusRun(tt.opts) - if tt.wantErr != "" { - assert.EqualError(t, err, tt.wantErr) + for k, v := range tt.env { + t.Setenv(k, v) + } + + err := statusRun(&tt.opts) + if tt.wantErr != nil { + require.Equal(t, err, tt.wantErr) } else { - assert.NoError(t, err) + require.NoError(t, err) } output := strings.ReplaceAll(stdout.String(), config.ConfigDir()+string(filepath.Separator), "GH_CONFIG_DIR/") errorOutput := strings.ReplaceAll(stderr.String(), config.ConfigDir()+string(filepath.Separator), "GH_CONFIG_DIR/") - assert.Equal(t, tt.wantErrOut, errorOutput) - assert.Equal(t, tt.wantOut, output) - - mainBuf := bytes.Buffer{} - hostsBuf := bytes.Buffer{} - readConfigs(&mainBuf, &hostsBuf) - - assert.Equal(t, "", mainBuf.String()) - assert.Equal(t, "", hostsBuf.String()) + require.Equal(t, tt.wantErrOut, errorOutput) + require.Equal(t, tt.wantOut, output) }) } } + +func login(t *testing.T, c gh.Config, hostname, username, protocol, token string) { + t.Helper() + _, err := c.Authentication().Login(hostname, username, protocol, token, false) + require.NoError(t, err) +} diff --git a/pkg/cmd/auth/switch/switch.go b/pkg/cmd/auth/switch/switch.go new file mode 100644 index 000000000..8822c407b --- /dev/null +++ b/pkg/cmd/auth/switch/switch.go @@ -0,0 +1,177 @@ +package authswitch + +import ( + "errors" + "fmt" + "slices" + + "github.com/MakeNowJust/heredoc" + "github.com/cli/cli/v2/internal/gh" + "github.com/cli/cli/v2/pkg/cmd/auth/shared" + "github.com/cli/cli/v2/pkg/cmdutil" + "github.com/cli/cli/v2/pkg/iostreams" + "github.com/spf13/cobra" +) + +type SwitchOptions struct { + IO *iostreams.IOStreams + Config func() (gh.Config, error) + Prompter shared.Prompt + Hostname string + Username string +} + +func NewCmdSwitch(f *cmdutil.Factory, runF func(*SwitchOptions) error) *cobra.Command { + opts := SwitchOptions{ + IO: f.IOStreams, + Config: f.Config, + Prompter: f.Prompter, + } + + cmd := &cobra.Command{ + Use: "switch", + Args: cobra.ExactArgs(0), + Short: "Switch active GitHub account", + Long: heredoc.Docf(` + Switch the active account for a GitHub host. + + This command changes the authentication configuration that will + be used when running commands targeting the specified GitHub host. + + If the specified host has two accounts, the active account will be switched + automatically. If there are more than two accounts, disambiguation will be + required either through the %[1]s--user%[1]s flag or an interactive prompt. + + For a list of authenticated accounts you can run %[1]sgh auth status%[1]s. + `, "`"), + Example: heredoc.Doc(` + # Select what host and account to switch to via a prompt + $ gh auth switch + + # Switch the active account on a specific host to a specific user + $ gh auth switch --hostname enterprise.internal --user monalisa + `), + RunE: func(c *cobra.Command, args []string) error { + if runF != nil { + return runF(&opts) + } + + return switchRun(&opts) + }, + } + + cmd.Flags().StringVarP(&opts.Hostname, "hostname", "h", "", "The hostname of the GitHub instance to switch account for") + cmd.Flags().StringVarP(&opts.Username, "user", "u", "", "The account to switch to") + + return cmd +} + +type hostUser struct { + host string + user string + active bool +} + +type candidates []hostUser + +func switchRun(opts *SwitchOptions) error { + hostname := opts.Hostname + username := opts.Username + + cfg, err := opts.Config() + if err != nil { + return err + } + authCfg := cfg.Authentication() + + knownHosts := authCfg.Hosts() + if len(knownHosts) == 0 { + return fmt.Errorf("not logged in to any hosts") + } + + if hostname != "" { + if !slices.Contains(knownHosts, hostname) { + return fmt.Errorf("not logged in to %s", hostname) + } + + if username != "" { + knownUsers := cfg.Authentication().UsersForHost(hostname) + if !slices.Contains(knownUsers, username) { + return fmt.Errorf("not logged in to %s account %s", hostname, username) + } + } + } + + var candidates candidates + + for _, host := range knownHosts { + if hostname != "" && host != hostname { + continue + } + hostActiveUser, err := authCfg.ActiveUser(host) + if err != nil { + return err + } + knownUsers := cfg.Authentication().UsersForHost(host) + for _, user := range knownUsers { + if username != "" && user != username { + continue + } + candidates = append(candidates, hostUser{host: host, user: user, active: user == hostActiveUser}) + } + } + + if len(candidates) == 0 { + return errors.New("no accounts matched that criteria") + } else if len(candidates) == 1 { + hostname = candidates[0].host + username = candidates[0].user + } else if len(candidates) == 2 && + candidates[0].host == candidates[1].host { + // If there is a single host with two users, automatically switch to the + // inactive user without prompting. + hostname = candidates[0].host + username = candidates[0].user + if candidates[0].active { + username = candidates[1].user + } + } else if !opts.IO.CanPrompt() { + return errors.New("unable to determine which account to switch to, please specify `--hostname` and `--user`") + } else { + prompts := make([]string, len(candidates)) + for i, c := range candidates { + prompt := fmt.Sprintf("%s (%s)", c.user, c.host) + if c.active { + prompt += " - active" + } + prompts[i] = prompt + } + selected, err := opts.Prompter.Select( + "What account do you want to switch to?", "", prompts) + if err != nil { + return fmt.Errorf("could not prompt: %w", err) + } + hostname = candidates[selected].host + username = candidates[selected].user + } + + if src, writeable := shared.AuthTokenWriteable(authCfg, hostname); !writeable { + fmt.Fprintf(opts.IO.ErrOut, "The value of the %s environment variable is being used for authentication.\n", src) + fmt.Fprint(opts.IO.ErrOut, "To have GitHub CLI manage credentials instead, first clear the value from the environment.\n") + return cmdutil.SilentError + } + + cs := opts.IO.ColorScheme() + + if err := authCfg.SwitchUser(hostname, username); err != nil { + fmt.Fprintf(opts.IO.ErrOut, "%s Failed to switch account for %s to %s\n", + cs.FailureIcon(), hostname, cs.Bold(username)) + + return err + } + + fmt.Fprintf(opts.IO.ErrOut, "%s Switched active account for %s to %s\n", + cs.SuccessIcon(), hostname, cs.Bold(username)) + + return nil +} diff --git a/pkg/cmd/auth/switch/switch_test.go b/pkg/cmd/auth/switch/switch_test.go new file mode 100644 index 000000000..6ca77f44c --- /dev/null +++ b/pkg/cmd/auth/switch/switch_test.go @@ -0,0 +1,440 @@ +package authswitch + +import ( + "bytes" + "errors" + "fmt" + "io" + "testing" + + "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" + "github.com/cli/cli/v2/internal/keyring" + "github.com/cli/cli/v2/internal/prompter" + "github.com/cli/cli/v2/pkg/cmdutil" + "github.com/cli/cli/v2/pkg/iostreams" + "github.com/google/shlex" + "github.com/stretchr/testify/require" +) + +func TestNewCmdSwitch(t *testing.T) { + tests := []struct { + name string + input string + expectedOpts SwitchOptions + expectedErrMsg string + }{ + { + name: "no flags", + input: "", + expectedOpts: SwitchOptions{}, + }, + { + name: "hostname flag", + input: "--hostname github.com", + expectedOpts: SwitchOptions{ + Hostname: "github.com", + }, + }, + { + name: "user flag", + input: "--user monalisa", + expectedOpts: SwitchOptions{ + Username: "monalisa", + }, + }, + { + name: "positional args is an error", + input: "some-positional-arg", + expectedErrMsg: "accepts 0 arg(s), received 1", + }, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + f := &cmdutil.Factory{} + argv, err := shlex.Split(tt.input) + require.NoError(t, err) + + var gotOpts *SwitchOptions + cmd := NewCmdSwitch(f, func(opts *SwitchOptions) error { + gotOpts = opts + return nil + }) + // Override the help flag as happens in production to allow -h flag + // to be used for hostname. + cmd.Flags().BoolP("help", "x", false, "") + + cmd.SetArgs(argv) + cmd.SetIn(&bytes.Buffer{}) + cmd.SetOut(&bytes.Buffer{}) + cmd.SetErr(&bytes.Buffer{}) + + _, err = cmd.ExecuteC() + if tt.expectedErrMsg != "" { + require.ErrorContains(t, err, tt.expectedErrMsg) + return + } + + require.NoError(t, err) + require.Equal(t, &tt.expectedOpts, gotOpts) + }) + } + +} + +func TestSwitchRun(t *testing.T) { + type user struct { + name string + token string + } + + type hostUsers struct { + host string + users []user + } + + type successfulExpectation struct { + switchedHost string + activeUser string + activeToken string + hostsCfg string + stderr string + } + + type failedExpectation struct { + err error + stderr string + } + + userWithMissingToken := "user-that-is-broken-by-the-test" + + tests := []struct { + name string + opts SwitchOptions + cfgHosts []hostUsers + env map[string]string + + expectedSuccess successfulExpectation + expectedFailure failedExpectation + + prompterStubs func(*prompter.PrompterMock) + }{ + { + name: "given one host with two users, switches to the other user", + opts: SwitchOptions{}, + cfgHosts: []hostUsers{ + {"github.com", []user{ + {"inactive-user", "inactive-user-token"}, + {"active-user", "active-user-token"}, + }}, + }, + expectedSuccess: successfulExpectation{ + switchedHost: "github.com", + activeUser: "inactive-user", + activeToken: "inactive-user-token", + hostsCfg: "github.com:\n git_protocol: ssh\n users:\n inactive-user:\n active-user:\n user: inactive-user\n", + stderr: "✓ Switched active account for github.com to inactive-user", + }, + }, + { + name: "given one host, with three users, switches to the specified user", + opts: SwitchOptions{ + Username: "inactive-user-2", + }, + cfgHosts: []hostUsers{ + {"github.com", []user{ + {"inactive-user-1", "inactive-user-1-token"}, + {"inactive-user-2", "inactive-user-2-token"}, + {"active-user", "active-user-token"}, + }}, + }, + expectedSuccess: successfulExpectation{ + switchedHost: "github.com", + activeUser: "inactive-user-2", + activeToken: "inactive-user-2-token", + hostsCfg: "github.com:\n git_protocol: ssh\n users:\n inactive-user-1:\n inactive-user-2:\n active-user:\n user: inactive-user-2\n", + stderr: "✓ Switched active account for github.com to inactive-user-2", + }, + }, + { + name: "given multiple hosts, with multiple users, switches to the specific user on the host", + opts: SwitchOptions{ + Hostname: "ghe.io", + Username: "inactive-user", + }, + cfgHosts: []hostUsers{ + {"github.com", []user{ + {"inactive-user", "inactive-user-token"}, + {"active-user", "active-user-token"}, + }}, + {"ghe.io", []user{ + {"inactive-user", "inactive-user-token"}, + {"active-user", "active-user-token"}, + }}, + }, + expectedSuccess: successfulExpectation{ + switchedHost: "ghe.io", + activeUser: "inactive-user", + activeToken: "inactive-user-token", + hostsCfg: "github.com:\n git_protocol: ssh\n users:\n inactive-user:\n active-user:\n user: active-user\nghe.io:\n git_protocol: ssh\n users:\n inactive-user:\n active-user:\n user: inactive-user\n", + stderr: "✓ Switched active account for ghe.io to inactive-user", + }, + }, + { + name: "given we're not logged into any hosts, provide an informative error", + opts: SwitchOptions{}, + cfgHosts: []hostUsers{}, + expectedFailure: failedExpectation{ + err: errors.New("not logged in to any hosts"), + }, + }, + { + name: "given we can't disambiguate users across hosts", + opts: SwitchOptions{ + Username: "inactive-user", + }, + cfgHosts: []hostUsers{ + {"github.com", []user{ + {"inactive-user", "inactive-user-token"}, + {"active-user", "active-user-token"}, + }}, + {"ghe.io", []user{ + {"inactive-user", "inactive-user-token"}, + {"active-user", "active-user-token"}, + }}, + }, + expectedFailure: failedExpectation{ + err: errors.New("unable to determine which account to switch to, please specify `--hostname` and `--user`"), + }, + }, + { + name: "given we can't disambiguate user on a single host", + opts: SwitchOptions{ + Hostname: "github.com", + }, + cfgHosts: []hostUsers{ + {"github.com", []user{ + {"inactive-user-1", "inactive-user-1-token"}, + {"inactive-user-2", "inactive-user-2-token"}, + {"active-user", "active-user-token"}, + }}, + }, + expectedFailure: failedExpectation{ + err: errors.New("unable to determine which account to switch to, please specify `--hostname` and `--user`"), + }, + }, + { + name: "given the auth token isn't writeable (e.g. a token env var is set)", + opts: SwitchOptions{}, + cfgHosts: []hostUsers{ + {"github.com", []user{ + {"inactive-user", "inactive-user-token"}, + {"active-user", "active-user-token"}, + }}, + }, + env: map[string]string{"GH_TOKEN": "unimportant-test-value"}, + expectedFailure: failedExpectation{ + err: cmdutil.SilentError, + stderr: "The value of the GH_TOKEN environment variable is being used for authentication.", + }, + }, + { + name: "specified hostname doesn't exist", + opts: SwitchOptions{ + Hostname: "ghe.io", + }, + cfgHosts: []hostUsers{ + {"github.com", []user{ + {"inactive-user", "inactive-user-token"}, + {"active-user", "active-user-token"}, + }}, + }, + expectedFailure: failedExpectation{ + err: errors.New("not logged in to ghe.io"), + }, + }, + { + name: "specified user doesn't exist on host", + opts: SwitchOptions{ + Hostname: "github.com", + Username: "non-existent-user", + }, + cfgHosts: []hostUsers{ + {"github.com", []user{ + {"inactive-user", "inactive-user-token"}, + {"active-user", "active-user-token"}, + }}, + }, + expectedFailure: failedExpectation{ + err: errors.New("not logged in to github.com account non-existent-user"), + }, + }, + { + name: "specified user doesn't exist on any host", + opts: SwitchOptions{ + Username: "non-existent-user", + }, + cfgHosts: []hostUsers{ + {"github.com", []user{ + {"active-user", "active-user-token"}, + }}, + {"ghe.io", []user{ + {"active-user", "active-user-token"}, + }}, + }, + expectedFailure: failedExpectation{ + err: errors.New("no accounts matched that criteria"), + }, + }, + { + name: "when options need to be disambiguated, the user is prompted with matrix of options including active users (if possible)", + opts: SwitchOptions{}, + cfgHosts: []hostUsers{ + {"github.com", []user{ + {"inactive-user", "inactive-user-token"}, + {"active-user", "active-user-token"}, + }}, + {"ghe.io", []user{ + {"inactive-user", "inactive-user-token"}, + {"active-user", "active-user-token"}, + }}, + }, + prompterStubs: func(pm *prompter.PrompterMock) { + pm.SelectFunc = func(prompt, _ string, opts []string) (int, error) { + require.Equal(t, "What account do you want to switch to?", prompt) + require.Equal(t, []string{ + "inactive-user (github.com)", + "active-user (github.com) - active", + "inactive-user (ghe.io)", + "active-user (ghe.io) - active", + }, opts) + + return prompter.IndexFor(opts, "inactive-user (ghe.io)") + } + }, + expectedSuccess: successfulExpectation{ + switchedHost: "ghe.io", + activeUser: "inactive-user", + activeToken: "inactive-user-token", + hostsCfg: "github.com:\n git_protocol: ssh\n users:\n inactive-user:\n active-user:\n user: active-user\nghe.io:\n git_protocol: ssh\n users:\n inactive-user:\n active-user:\n user: inactive-user\n", + stderr: "✓ Switched active account for ghe.io to inactive-user", + }, + }, + { + name: "options need to be disambiguated given two hosts, one with two users", + opts: SwitchOptions{}, + cfgHosts: []hostUsers{ + {"github.com", []user{ + {"inactive-user", "inactive-user-token"}, + {"active-user", "active-user-token"}, + }}, + {"ghe.io", []user{ + {"active-user", "active-user-token"}, + }}, + }, + prompterStubs: func(pm *prompter.PrompterMock) { + pm.SelectFunc = func(prompt, _ string, opts []string) (int, error) { + require.Equal(t, "What account do you want to switch to?", prompt) + require.Equal(t, []string{ + "inactive-user (github.com)", + "active-user (github.com) - active", + "active-user (ghe.io) - active", + }, opts) + + return prompter.IndexFor(opts, "inactive-user (github.com)") + } + }, + expectedSuccess: successfulExpectation{ + switchedHost: "github.com", + activeUser: "inactive-user", + activeToken: "inactive-user-token", + hostsCfg: "github.com:\n git_protocol: ssh\n users:\n inactive-user:\n active-user:\n user: inactive-user\nghe.io:\n git_protocol: ssh\n users:\n active-user:\n user: active-user\n", + stderr: "✓ Switched active account for github.com to inactive-user", + }, + }, + { + name: "when switching fails due to something other than user error, an informative message is printed to explain their new state", + opts: SwitchOptions{ + Username: userWithMissingToken, + }, + cfgHosts: []hostUsers{ + {"github.com", []user{ + {userWithMissingToken, "inactive-user-token"}, + {"active-user", "active-user-token"}, + }}, + }, + expectedFailure: failedExpectation{ + err: fmt.Errorf("no token found for %s", userWithMissingToken), + stderr: fmt.Sprintf("X Failed to switch account for github.com to %s", userWithMissingToken), + }, + }, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + cfg, readConfigs := config.NewIsolatedTestConfig(t) + + for k, v := range tt.env { + t.Setenv(k, v) + } + + isInteractive := tt.prompterStubs != nil + if isInteractive { + pm := &prompter.PrompterMock{} + tt.prompterStubs(pm) + tt.opts.Prompter = pm + defer func() { + require.Len(t, pm.SelectCalls(), 1) + }() + } + + for _, hostUsers := range tt.cfgHosts { + for _, user := range hostUsers.users { + _, err := cfg.Authentication().Login( + hostUsers.host, + user.name, + user.token, "ssh", true, + ) + require.NoError(t, err) + + if user.name == userWithMissingToken { + require.NoError(t, keyring.Delete(fmt.Sprintf("gh:%s", hostUsers.host), userWithMissingToken)) + } + } + } + + tt.opts.Config = func() (gh.Config, error) { + return cfg, nil + } + + ios, _, _, stderr := iostreams.Test() + ios.SetStdinTTY(isInteractive) + ios.SetStdoutTTY(isInteractive) + tt.opts.IO = ios + + err := switchRun(&tt.opts) + if tt.expectedFailure.err != nil { + require.Equal(t, tt.expectedFailure.err, err) + require.Contains(t, stderr.String(), tt.expectedFailure.stderr) + return + } + + require.NoError(t, err) + + activeUser, err := cfg.Authentication().ActiveUser(tt.expectedSuccess.switchedHost) + require.NoError(t, err) + require.Equal(t, tt.expectedSuccess.activeUser, activeUser) + + activeToken, _ := cfg.Authentication().TokenFromKeyring(tt.expectedSuccess.switchedHost) + require.Equal(t, tt.expectedSuccess.activeToken, activeToken) + + hostsBuf := bytes.Buffer{} + readConfigs(io.Discard, &hostsBuf) + + require.Equal(t, tt.expectedSuccess.hostsCfg, hostsBuf.String()) + + require.Contains(t, stderr.String(), tt.expectedSuccess.stderr) + }) + } +} diff --git a/pkg/cmd/auth/token/token.go b/pkg/cmd/auth/token/token.go index fee8dc638..9f4dcc1ac 100644 --- a/pkg/cmd/auth/token/token.go +++ b/pkg/cmd/auth/token/token.go @@ -3,7 +3,8 @@ package token import ( "fmt" - "github.com/cli/cli/v2/internal/config" + "github.com/MakeNowJust/heredoc" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" "github.com/spf13/cobra" @@ -11,9 +12,10 @@ import ( type TokenOptions struct { IO *iostreams.IOStreams - Config func() (config.Config, error) + Config func() (gh.Config, error) Hostname string + Username string SecureStorage bool } @@ -25,8 +27,15 @@ func NewCmdToken(f *cmdutil.Factory, runF func(*TokenOptions) error) *cobra.Comm cmd := &cobra.Command{ Use: "token", - Short: "Print the auth token gh is configured to use", - Args: cobra.ExactArgs(0), + Short: "Print the authentication token gh uses for a hostname and account", + Long: heredoc.Docf(` + This command outputs the authentication token for an account on a given GitHub host. + + Without the %[1]s--hostname%[1]s flag, the default host is chosen. + + Without the %[1]s--user%[1]s flag, the active account for the host is chosen. + `, "`"), + Args: cobra.ExactArgs(0), RunE: func(cmd *cobra.Command, args []string) error { if runF != nil { return runF(opts) @@ -37,6 +46,7 @@ func NewCmdToken(f *cmdutil.Factory, runF func(*TokenOptions) error) *cobra.Comm } cmd.Flags().StringVarP(&opts.Hostname, "hostname", "h", "", "The hostname of the GitHub instance authenticated with") + cmd.Flags().StringVarP(&opts.Username, "user", "u", "", "The account to output the token for") cmd.Flags().BoolVarP(&opts.SecureStorage, "secure-storage", "", false, "Search only secure credential store for authentication token") _ = cmd.Flags().MarkHidden("secure-storage") @@ -56,17 +66,34 @@ func tokenRun(opts *TokenOptions) error { } var val string + // If this conditional logic ends up being duplicated anywhere, + // we should consider making a factory function that returns the correct + // behavior. For now, keeping it all inline is simplest. if opts.SecureStorage { - val, _ = authCfg.TokenFromKeyring(hostname) + if opts.Username == "" { + val, _ = authCfg.TokenFromKeyring(hostname) + } else { + val, _ = authCfg.TokenFromKeyringForUser(hostname, opts.Username) + } } else { - val, _ = authCfg.Token(hostname) + if opts.Username == "" { + val, _ = authCfg.ActiveToken(hostname) + } else { + val, _, _ = authCfg.TokenForUser(hostname, opts.Username) + } } + if val == "" { - return fmt.Errorf("no oauth token") + errMsg := fmt.Sprintf("no oauth token found for %s", hostname) + if opts.Username != "" { + errMsg += fmt.Sprintf(" account %s", opts.Username) + } + return fmt.Errorf(errMsg) } if val != "" { fmt.Fprintf(opts.IO.Out, "%s\n", val) } + return nil } diff --git a/pkg/cmd/auth/token/token_test.go b/pkg/cmd/auth/token/token_test.go index 03324c0b2..1d731f2ed 100644 --- a/pkg/cmd/auth/token/token_test.go +++ b/pkg/cmd/auth/token/token_test.go @@ -5,11 +5,11 @@ import ( "testing" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" "github.com/google/shlex" - "github.com/stretchr/testify/assert" - "github.com/zalando/go-keyring" + "github.com/stretchr/testify/require" ) func TestNewCmdToken(t *testing.T) { @@ -30,6 +30,16 @@ func TestNewCmdToken(t *testing.T) { input: "--hostname github.mycompany.com", output: TokenOptions{Hostname: "github.mycompany.com"}, }, + { + name: "with user", + input: "--user test-user", + output: TokenOptions{Username: "test-user"}, + }, + { + name: "with shorthand user", + input: "-u test-user", + output: TokenOptions{Username: "test-user"}, + }, { name: "with shorthand hostname", input: "-h github.mycompany.com", @@ -47,13 +57,13 @@ func TestNewCmdToken(t *testing.T) { ios, _, _, _ := iostreams.Test() f := &cmdutil.Factory{ IOStreams: ios, - Config: func() (config.Config, error) { + Config: func() (gh.Config, error) { cfg := config.NewBlankConfig() return cfg, nil }, } argv, err := shlex.Split(tt.input) - assert.NoError(t, err) + require.NoError(t, err) var cmdOpts *TokenOptions cmd := NewCmdToken(f, func(opts *TokenOptions) error { @@ -70,14 +80,14 @@ func TestNewCmdToken(t *testing.T) { _, err = cmd.ExecuteC() if tt.wantErr { - assert.Error(t, err) - assert.EqualError(t, err, tt.wantErrMsg) + require.Error(t, err) + require.EqualError(t, err, tt.wantErrMsg) return } - assert.NoError(t, err) - assert.Equal(t, tt.output.Hostname, cmdOpts.Hostname) - assert.Equal(t, tt.output.SecureStorage, cmdOpts.SecureStorage) + require.NoError(t, err) + require.Equal(t, tt.output.Hostname, cmdOpts.Hostname) + require.Equal(t, tt.output.SecureStorage, cmdOpts.SecureStorage) }) } } @@ -86,75 +96,96 @@ func TestTokenRun(t *testing.T) { tests := []struct { name string opts TokenOptions + env map[string]string + cfgStubs func(*testing.T, gh.Config) wantStdout string wantErr bool wantErrMsg string }{ { name: "token", - opts: TokenOptions{ - Config: func() (config.Config, error) { - cfg := config.NewBlankConfig() - cfg.Set("github.com", "oauth_token", "gho_ABCDEFG") - return cfg, nil - }, + opts: TokenOptions{}, + cfgStubs: func(t *testing.T, cfg gh.Config) { + login(t, cfg, "github.com", "test-user", "gho_ABCDEFG", "https", false) }, wantStdout: "gho_ABCDEFG\n", }, { name: "token by hostname", opts: TokenOptions{ - Config: func() (config.Config, error) { - cfg := config.NewBlankConfig() - cfg.Set("github.com", "oauth_token", "gho_ABCDEFG") - cfg.Set("github.mycompany.com", "oauth_token", "gho_1234567") - return cfg, nil - }, Hostname: "github.mycompany.com", }, + cfgStubs: func(t *testing.T, cfg gh.Config) { + login(t, cfg, "github.com", "test-user", "gho_ABCDEFG", "https", false) + login(t, cfg, "github.mycompany.com", "test-user", "gho_1234567", "https", false) + }, wantStdout: "gho_1234567\n", }, { - name: "no token", + name: "no token", + opts: TokenOptions{}, + wantErr: true, + wantErrMsg: "no oauth token found for github.com", + }, + { + name: "no token for hostname user", opts: TokenOptions{ - Config: func() (config.Config, error) { - cfg := config.NewBlankConfig() - return cfg, nil - }, + Hostname: "ghe.io", + Username: "test-user", }, wantErr: true, - wantErrMsg: "no oauth token", + wantErrMsg: "no oauth token found for ghe.io account test-user", }, { name: "uses default host when one is not provided", - opts: TokenOptions{ - Config: func() (config.Config, error) { - cfg := config.NewBlankConfig() - cfg.AuthenticationFunc = func() *config.AuthConfig { - authCfg := &config.AuthConfig{} - authCfg.SetDefaultHost("github.mycompany.com", "GH_HOST") - authCfg.SetToken("gho_1234567", "default") - return authCfg - } - return cfg, nil - }, + opts: TokenOptions{}, + cfgStubs: func(t *testing.T, cfg gh.Config) { + login(t, cfg, "github.com", "test-user", "gho_ABCDEFG", "https", false) + login(t, cfg, "github.mycompany.com", "test-user", "gho_1234567", "https", false) }, + env: map[string]string{"GH_HOST": "github.mycompany.com"}, wantStdout: "gho_1234567\n", }, + { + name: "token for user", + opts: TokenOptions{ + Hostname: "github.com", + Username: "test-user", + }, + cfgStubs: func(t *testing.T, cfg gh.Config) { + login(t, cfg, "github.com", "test-user", "gho_ABCDEFG", "https", false) + login(t, cfg, "github.com", "test-user-2", "gho_1234567", "https", false) + }, + wantStdout: "gho_ABCDEFG\n", + }, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { ios, _, stdout, _ := iostreams.Test() tt.opts.IO = ios + + for k, v := range tt.env { + t.Setenv(k, v) + } + + cfg, _ := config.NewIsolatedTestConfig(t) + if tt.cfgStubs != nil { + tt.cfgStubs(t, cfg) + } + + tt.opts.Config = func() (gh.Config, error) { + return cfg, nil + } + err := tokenRun(&tt.opts) if tt.wantErr { - assert.Error(t, err) - assert.EqualError(t, err, tt.wantErrMsg) + require.Error(t, err) + require.EqualError(t, err, tt.wantErrMsg) return } - assert.NoError(t, err) - assert.Equal(t, tt.wantStdout, stdout.String()) + require.NoError(t, err) + require.Equal(t, tt.wantStdout, stdout.String()) }) } } @@ -163,60 +194,87 @@ func TestTokenRunSecureStorage(t *testing.T) { tests := []struct { name string opts TokenOptions + cfgStubs func(*testing.T, gh.Config) wantStdout string wantErr bool wantErrMsg string }{ { name: "token", - opts: TokenOptions{ - Config: func() (config.Config, error) { - cfg := config.NewBlankConfig() - _ = keyring.Set("gh:github.com", "", "gho_ABCDEFG") - return cfg, nil - }, + opts: TokenOptions{}, + cfgStubs: func(t *testing.T, cfg gh.Config) { + login(t, cfg, "github.com", "test-user", "gho_ABCDEFG", "https", true) }, wantStdout: "gho_ABCDEFG\n", }, { name: "token by hostname", opts: TokenOptions{ - Config: func() (config.Config, error) { - cfg := config.NewBlankConfig() - _ = keyring.Set("gh:mycompany.com", "", "gho_1234567") - return cfg, nil - }, Hostname: "mycompany.com", }, + cfgStubs: func(t *testing.T, cfg gh.Config) { + login(t, cfg, "mycompany.com", "test-user", "gho_1234567", "https", true) + }, wantStdout: "gho_1234567\n", }, { - name: "no token", + name: "no token", + opts: TokenOptions{}, + wantErr: true, + wantErrMsg: "no oauth token found for github.com", + }, + { + name: "no token for hostname user", opts: TokenOptions{ - Config: func() (config.Config, error) { - cfg := config.NewBlankConfig() - return cfg, nil - }, + Hostname: "ghe.io", + Username: "test-user", }, wantErr: true, - wantErrMsg: "no oauth token", + wantErrMsg: "no oauth token found for ghe.io account test-user", + }, + { + name: "token for user", + opts: TokenOptions{ + Hostname: "github.com", + Username: "test-user", + }, + cfgStubs: func(t *testing.T, cfg gh.Config) { + login(t, cfg, "github.com", "test-user", "gho_ABCDEFG", "https", true) + login(t, cfg, "github.com", "test-user-2", "gho_1234567", "https", true) + }, + wantStdout: "gho_ABCDEFG\n", }, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { - keyring.MockInit() ios, _, stdout, _ := iostreams.Test() tt.opts.IO = ios tt.opts.SecureStorage = true + + cfg, _ := config.NewIsolatedTestConfig(t) + if tt.cfgStubs != nil { + tt.cfgStubs(t, cfg) + } + + tt.opts.Config = func() (gh.Config, error) { + return cfg, nil + } + err := tokenRun(&tt.opts) if tt.wantErr { - assert.Error(t, err) - assert.EqualError(t, err, tt.wantErrMsg) + require.Error(t, err) + require.EqualError(t, err, tt.wantErrMsg) return } - assert.NoError(t, err) - assert.Equal(t, tt.wantStdout, stdout.String()) + require.NoError(t, err) + require.Equal(t, tt.wantStdout, stdout.String()) }) } } + +func login(t *testing.T, c gh.Config, hostname, username, token, gitProtocol string, secureStorage bool) { + t.Helper() + _, err := c.Authentication().Login(hostname, username, token, gitProtocol, secureStorage) + require.NoError(t, err) +} diff --git a/pkg/cmd/browse/browse.go b/pkg/cmd/browse/browse.go index b89434555..87ac5826b 100644 --- a/pkg/cmd/browse/browse.go +++ b/pkg/cmd/browse/browse.go @@ -5,6 +5,7 @@ import ( "fmt" "net/http" "net/url" + "os" "path" "path/filepath" "regexp" @@ -36,13 +37,14 @@ type BrowseOptions struct { SelectorArg string - Branch string - Commit string - ProjectsFlag bool - ReleasesFlag bool - SettingsFlag bool - WikiFlag bool - NoBrowserFlag bool + Branch string + Commit string + ProjectsFlag bool + ReleasesFlag bool + SettingsFlag bool + WikiFlag bool + NoBrowserFlag bool + HasRepoOverride bool } func NewCmdBrowse(f *cmdutil.Factory, runF func(*BrowseOptions) error) *cobra.Command { @@ -65,6 +67,9 @@ func NewCmdBrowse(f *cmdutil.Factory, runF func(*BrowseOptions) error) *cobra.Co $ gh browse #=> Open the home page of the current repository + $ gh browse script/ + #=> Open the script directory of the current repository + $ gh browse 217 #=> Open issue or pull request 217 @@ -129,8 +134,9 @@ func NewCmdBrowse(f *cmdutil.Factory, runF func(*BrowseOptions) error) *cobra.Co return cmdutil.FlagErrorf("%q is an invalid argument when using `--branch` or `--commit`", opts.SelectorArg) } - if cmd.Flags().Changed("repo") { + if cmd.Flags().Changed("repo") || os.Getenv("GH_REPO") != "" { opts.GitClient = &remoteGitClient{opts.BaseRepo, opts.HttpClient} + opts.HasRepoOverride = true } if runF != nil { @@ -275,7 +281,7 @@ func parseFile(opts BrowseOptions, f string) (p string, start int, end int, err } p = filepath.ToSlash(parts[0]) - if !path.IsAbs(p) { + if !path.IsAbs(p) && !opts.HasRepoOverride { p = path.Join(opts.PathFromRepoRoot(), p) if p == "." || strings.HasPrefix(p, "..") { p = "" diff --git a/pkg/cmd/browse/browse_test.go b/pkg/cmd/browse/browse_test.go index 67b920fdb..cceba045a 100644 --- a/pkg/cmd/browse/browse_test.go +++ b/pkg/cmd/browse/browse_test.go @@ -511,6 +511,20 @@ func Test_runBrowse(t *testing.T) { expectedURL: "https://github.com/bchadwic/gh-graph/tree/trunk/pkg/cmd/pr", wantsErr: false, }, + { + name: "does not use relative path when has repo override", + opts: BrowseOptions{ + SelectorArg: "README.md", + HasRepoOverride: true, + PathFromRepoRoot: func() string { + return "pkg/cmd/browse/" + }, + }, + baseRepo: ghrepo.New("bchadwic", "gh-graph"), + defaultBranch: "trunk", + expectedURL: "https://github.com/bchadwic/gh-graph/tree/trunk/README.md", + wantsErr: false, + }, { name: "use special characters in selector arg", opts: BrowseOptions{ diff --git a/pkg/cmd/cache/cache.go b/pkg/cmd/cache/cache.go index db62c5e81..897a3d9fd 100644 --- a/pkg/cmd/cache/cache.go +++ b/pkg/cmd/cache/cache.go @@ -11,8 +11,8 @@ import ( func NewCmdCache(f *cmdutil.Factory) *cobra.Command { cmd := &cobra.Command{ Use: "cache ", - Short: "Manage Github Actions caches", - Long: "Work with Github Actions caches.", + Short: "Manage GitHub Actions caches", + Long: "Work with GitHub Actions caches.", Example: heredoc.Doc(` $ gh cache list $ gh cache delete --all diff --git a/pkg/cmd/cache/delete/delete.go b/pkg/cmd/cache/delete/delete.go index c6d0672f8..4794d1fbe 100644 --- a/pkg/cmd/cache/delete/delete.go +++ b/pkg/cmd/cache/delete/delete.go @@ -4,6 +4,7 @@ import ( "errors" "fmt" "net/http" + "net/url" "strconv" "github.com/MakeNowJust/heredoc" @@ -33,9 +34,9 @@ func NewCmdDelete(f *cmdutil.Factory, runF func(*DeleteOptions) error) *cobra.Co cmd := &cobra.Command{ Use: "delete [| | --all]", - Short: "Delete Github Actions caches", + Short: "Delete GitHub Actions caches", Long: ` - Delete Github Actions caches. + Delete GitHub Actions caches. Deletion requires authorization with the "repo" scope. `, @@ -127,7 +128,7 @@ func deleteCaches(opts *DeleteOptions, client *api.Client, repo ghrepo.Interface if id, err := strconv.Atoi(cache); err == nil { path = fmt.Sprintf("%s/%d", base, id) } else { - path = fmt.Sprintf("%s?key=%s", base, cache) + path = fmt.Sprintf("%s?key=%s", base, url.QueryEscape(cache)) } err := client.REST(repo.RepoHost(), "DELETE", path, nil, nil) diff --git a/pkg/cmd/cache/delete/delete_test.go b/pkg/cmd/cache/delete/delete_test.go index d6cd4ac56..43fc7d213 100644 --- a/pkg/cmd/cache/delete/delete_test.go +++ b/pkg/cmd/cache/delete/delete_test.go @@ -3,6 +3,7 @@ package delete import ( "bytes" "net/http" + "net/url" "testing" "time" @@ -171,6 +172,20 @@ func TestDeleteRun(t *testing.T) { wantErr: true, wantErrMsg: "X Failed to delete cache: HTTP 500 (https://api.github.com/repos/OWNER/REPO/actions/caches/123)", }, + { + name: "keys must be percent-encoded before being used as query params", + opts: DeleteOptions{Identifier: "a weird＿cache+key"}, + stubs: func(reg *httpmock.Registry) { + reg.Register( + httpmock.QueryMatcher("DELETE", "repos/OWNER/REPO/actions/caches", url.Values{ + "key": []string{"a weird＿cache+key"}, + }), + httpmock.StatusStringResponse(204, ""), + ) + }, + tty: true, + wantStdout: "✓ Deleted 1 cache from OWNER/REPO\n", + }, } for _, tt := range tests { diff --git a/pkg/cmd/cache/list/list.go b/pkg/cmd/cache/list/list.go index d2f4aa10d..f5aa8fd5a 100644 --- a/pkg/cmd/cache/list/list.go +++ b/pkg/cmd/cache/list/list.go @@ -21,11 +21,14 @@ type ListOptions struct { BaseRepo func() (ghrepo.Interface, error) HttpClient func() (*http.Client, error) IO *iostreams.IOStreams + Exporter cmdutil.Exporter Now time.Time Limit int Order string Sort string + Key string + Ref string } func NewCmdList(f *cmdutil.Factory, runF func(*ListOptions) error) *cobra.Command { @@ -36,7 +39,7 @@ func NewCmdList(f *cmdutil.Factory, runF func(*ListOptions) error) *cobra.Comman cmd := &cobra.Command{ Use: "list", - Short: "List Github Actions caches", + Short: "List GitHub Actions caches", Example: heredoc.Doc(` # List caches for current repository $ gh cache list @@ -46,6 +49,15 @@ func NewCmdList(f *cmdutil.Factory, runF func(*ListOptions) error) *cobra.Comman # List caches sorted by least recently accessed $ gh cache list --sort last_accessed_at --order asc + + # List caches that have keys matching a prefix (or that match exactly) + $ gh cache list --key key-prefix + + # To list caches for a specific branch, replace with the actual branch name + $ gh cache list --ref refs/heads/ + + # To list caches for a specific pull request, replace with the actual pull request number + $ gh cache list --ref refs/pull//merge `), Aliases: []string{"ls"}, Args: cobra.NoArgs, @@ -68,6 +80,9 @@ func NewCmdList(f *cmdutil.Factory, runF func(*ListOptions) error) *cobra.Comman cmd.Flags().IntVarP(&opts.Limit, "limit", "L", 30, "Maximum number of caches to fetch") cmdutil.StringEnumFlag(cmd, &opts.Order, "order", "O", "desc", []string{"asc", "desc"}, "Order of caches returned") cmdutil.StringEnumFlag(cmd, &opts.Sort, "sort", "S", "last_accessed_at", []string{"created_at", "last_accessed_at", "size_in_bytes"}, "Sort fetched caches") + cmd.Flags().StringVarP(&opts.Key, "key", "k", "", "Filter by cache key prefix") + cmd.Flags().StringVarP(&opts.Ref, "ref", "r", "", "Filter by ref, formatted as refs/heads/ or refs/pull//merge") + cmdutil.AddJSONFlags(cmd, &opts.Exporter, shared.CacheFields) return cmd } @@ -85,7 +100,7 @@ func listRun(opts *ListOptions) error { client := api.NewClientFromHTTP(httpClient) opts.IO.StartProgressIndicator() - result, err := shared.GetCaches(client, repo, shared.GetCachesOptions{Limit: opts.Limit, Sort: opts.Sort, Order: opts.Order}) + result, err := shared.GetCaches(client, repo, shared.GetCachesOptions{Limit: opts.Limit, Sort: opts.Sort, Order: opts.Order, Key: opts.Key, Ref: opts.Ref}) opts.IO.StopProgressIndicator() if err != nil { return fmt.Errorf("%s Failed to get caches: %w", opts.IO.ColorScheme().FailureIcon(), err) @@ -101,6 +116,10 @@ func listRun(opts *ListOptions) error { fmt.Fprintf(opts.IO.Out, "Failed to start pager: %v\n", err) } + if opts.Exporter != nil { + return opts.Exporter.Write(opts.IO, result.ActionsCaches) + } + if opts.IO.IsStdoutTTY() { fmt.Fprintf(opts.IO.Out, "\nShowing %d of %s in %s\n\n", len(result.ActionsCaches), text.Pluralize(result.TotalCount, "cache"), ghrepo.FullName(repo)) } @@ -109,14 +128,13 @@ func listRun(opts *ListOptions) error { opts.Now = time.Now() } - tp := tableprinter.New(opts.IO) - tp.HeaderRow("ID", "KEY", "SIZE", "CREATED", "ACCESSED") + tp := tableprinter.New(opts.IO, tableprinter.WithHeader("ID", "KEY", "SIZE", "CREATED", "ACCESSED")) for _, cache := range result.ActionsCaches { tp.AddField(opts.IO.ColorScheme().Cyan(fmt.Sprintf("%d", cache.Id))) tp.AddField(cache.Key) tp.AddField(humanFileSize(cache.SizeInBytes)) - tp.AddTimeField(time.Now(), cache.CreatedAt, opts.IO.ColorScheme().Gray) - tp.AddTimeField(time.Now(), cache.LastAccessedAt, opts.IO.ColorScheme().Gray) + tp.AddTimeField(opts.Now, cache.CreatedAt, opts.IO.ColorScheme().Gray) + tp.AddTimeField(opts.Now, cache.LastAccessedAt, opts.IO.ColorScheme().Gray) tp.EndRow() } diff --git a/pkg/cmd/cache/list/list_test.go b/pkg/cmd/cache/list/list_test.go index 1129297ea..24d835bca 100644 --- a/pkg/cmd/cache/list/list_test.go +++ b/pkg/cmd/cache/list/list_test.go @@ -30,6 +30,8 @@ func TestNewCmdList(t *testing.T) { Limit: 30, Order: "desc", Sort: "last_accessed_at", + Key: "", + Ref: "", }, }, { @@ -39,6 +41,8 @@ func TestNewCmdList(t *testing.T) { Limit: 100, Order: "desc", Sort: "last_accessed_at", + Key: "", + Ref: "", }, }, { @@ -53,6 +57,8 @@ func TestNewCmdList(t *testing.T) { Limit: 30, Order: "desc", Sort: "created_at", + Key: "", + Ref: "", }, }, { @@ -62,6 +68,30 @@ func TestNewCmdList(t *testing.T) { Limit: 30, Order: "asc", Sort: "last_accessed_at", + Key: "", + Ref: "", + }, + }, + { + name: "with key", + input: "--key cache-key-prefix-", + wants: ListOptions{ + Limit: 30, + Order: "desc", + Sort: "last_accessed_at", + Key: "cache-key-prefix-", + Ref: "", + }, + }, + { + name: "with ref", + input: "--ref refs/heads/main", + wants: ListOptions{ + Limit: 30, + Order: "desc", + Sort: "last_accessed_at", + Key: "", + Ref: "refs/heads/main", }, }, } @@ -90,6 +120,7 @@ func TestNewCmdList(t *testing.T) { assert.Equal(t, tt.wants.Limit, gotOpts.Limit) assert.Equal(t, tt.wants.Sort, gotOpts.Sort) assert.Equal(t, tt.wants.Order, gotOpts.Order) + assert.Equal(t, tt.wants.Key, gotOpts.Key) }) } } @@ -171,6 +202,46 @@ ID KEY SIZE CREATED ACCESSED }, wantStdout: "1\tfoo\t100 B\t2021-01-01T01:01:01Z\t2022-01-01T01:01:01Z\n2\tbar\t1.00 KiB\t2021-01-01T01:01:01Z\t2022-01-01T01:01:01Z\n", }, + { + name: "only requests caches with the provided key prefix", + opts: ListOptions{ + Key: "test-key", + }, + stubs: func(reg *httpmock.Registry) { + reg.Register( + func(req *http.Request) bool { + return req.URL.Query().Get("key") == "test-key" + }, + httpmock.JSONResponse(shared.CachePayload{ + ActionsCaches: []shared.Cache{}, + TotalCount: 0, + })) + }, + // We could put anything here, we're really asserting that the key is passed + // to the API. + wantErr: true, + wantErrMsg: "No caches found in OWNER/REPO", + }, + { + name: "only requests caches with the provided ref", + opts: ListOptions{ + Ref: "refs/heads/main", + }, + stubs: func(reg *httpmock.Registry) { + reg.Register( + func(req *http.Request) bool { + return req.URL.Query().Get("ref") == "refs/heads/main" + }, + httpmock.JSONResponse(shared.CachePayload{ + ActionsCaches: []shared.Cache{}, + TotalCount: 0, + })) + }, + // We could put anything here, we're really asserting that the key is passed + // to the API. + wantErr: true, + wantErrMsg: "No caches found in OWNER/REPO", + }, { name: "displays no results", stubs: func(reg *httpmock.Registry) { diff --git a/pkg/cmd/cache/shared/shared.go b/pkg/cmd/cache/shared/shared.go index 271dee508..3e8096396 100644 --- a/pkg/cmd/cache/shared/shared.go +++ b/pkg/cmd/cache/shared/shared.go @@ -2,12 +2,24 @@ package shared import ( "fmt" + "net/url" "time" "github.com/cli/cli/v2/api" "github.com/cli/cli/v2/internal/ghrepo" + "github.com/cli/cli/v2/pkg/cmdutil" ) +var CacheFields = []string{ + "createdAt", + "id", + "key", + "lastAccessedAt", + "ref", + "sizeInBytes", + "version", +} + type Cache struct { CreatedAt time.Time `json:"created_at"` Id int `json:"id"` @@ -27,6 +39,8 @@ type GetCachesOptions struct { Limit int Order string Sort string + Key string + Ref string } // Return a list of caches for a repository. Pass a negative limit to request @@ -46,6 +60,12 @@ func GetCaches(client *api.Client, repo ghrepo.Interface, opts GetCachesOptions) if opts.Order != "" { path += fmt.Sprintf("&direction=%s", opts.Order) } + if opts.Key != "" { + path += fmt.Sprintf("&key=%s", url.QueryEscape(opts.Key)) + } + if opts.Ref != "" { + path += fmt.Sprintf("&ref=%s", url.QueryEscape(opts.Ref)) + } var result *CachePayload pagination: @@ -71,3 +91,7 @@ pagination: return result, nil } + +func (c *Cache) ExportData(fields []string) map[string]interface{} { + return cmdutil.StructExportData(c, fields) +} diff --git a/pkg/cmd/cache/shared/shared_test.go b/pkg/cmd/cache/shared/shared_test.go index 2b64fed28..b9afc3e6b 100644 --- a/pkg/cmd/cache/shared/shared_test.go +++ b/pkg/cmd/cache/shared/shared_test.go @@ -1,13 +1,19 @@ package shared import ( + "bytes" + "encoding/json" "net/http" + "strings" "testing" + "github.com/MakeNowJust/heredoc" + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" + "github.com/cli/cli/v2/api" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/pkg/httpmock" - "github.com/stretchr/testify/assert" ) func TestGetCaches(t *testing.T) { @@ -66,3 +72,74 @@ func TestGetCaches(t *testing.T) { }) } } + +func TestCache_ExportData(t *testing.T) { + src := heredoc.Doc( + ` + { + "id": 505, + "ref": "refs/heads/main", + "key": "Linux-node-958aff96db2d75d67787d1e634ae70b659de937b", + "version": "73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0", + "last_accessed_at": "2019-01-24T22:45:36.000Z", + "created_at": "2019-01-24T22:45:36.000Z", + "size_in_bytes": 1024 + } + `, + ) + + tests := []struct { + name string + fields []string + inputJSON string + outputJSON string + }{ + { + name: "basic", + fields: []string{"id", "key"}, + inputJSON: src, + outputJSON: heredoc.Doc( + ` + { + "id": 505, + "key": "Linux-node-958aff96db2d75d67787d1e634ae70b659de937b" + } + `, + ), + }, + { + name: "full", + fields: []string{"id", "ref", "key", "version", "lastAccessedAt", "createdAt", "sizeInBytes"}, + inputJSON: src, + outputJSON: heredoc.Doc( + ` + { + "createdAt": "2019-01-24T22:45:36Z", + "id": 505, + "key": "Linux-node-958aff96db2d75d67787d1e634ae70b659de937b", + "lastAccessedAt": "2019-01-24T22:45:36Z", + "ref": "refs/heads/main", + "sizeInBytes": 1024, + "version": "73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0" + } + `, + ), + }, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + var cache Cache + dec := json.NewDecoder(strings.NewReader(tt.inputJSON)) + require.NoError(t, dec.Decode(&cache)) + + exported := cache.ExportData(tt.fields) + + buf := bytes.Buffer{} + enc := json.NewEncoder(&buf) + enc.SetIndent("", "\t") + require.NoError(t, enc.Encode(exported)) + assert.Equal(t, tt.outputJSON, buf.String()) + }) + } +} diff --git a/pkg/cmd/codespace/common.go b/pkg/cmd/codespace/common.go index 006669151..fc70febee 100644 --- a/pkg/cmd/codespace/common.go +++ b/pkg/cmd/codespace/common.go @@ -8,6 +8,7 @@ import ( "fmt" "io" "log" + "net/http" "os" "sort" "strings" @@ -16,10 +17,8 @@ import ( "github.com/AlecAivazis/survey/v2/terminal" clicontext "github.com/cli/cli/v2/context" "github.com/cli/cli/v2/internal/browser" - "github.com/cli/cli/v2/internal/codespaces" "github.com/cli/cli/v2/internal/codespaces/api" "github.com/cli/cli/v2/pkg/iostreams" - "github.com/cli/cli/v2/pkg/liveshare" "github.com/spf13/cobra" "golang.org/x/term" ) @@ -64,28 +63,6 @@ func (a *App) RunWithProgress(label string, run func() error) error { return a.io.RunWithProgress(label, run) } -// Connects to a codespace using Live Share and returns that session -func startLiveShareSession(ctx context.Context, codespace *api.Codespace, a *App, debug bool, debugFile string) (session *liveshare.Session, err error) { - liveshareLogger := noopLogger() - if debug { - debugLogger, err := newFileLogger(debugFile) - if err != nil { - return nil, fmt.Errorf("couldn't create file logger: %w", err) - } - defer safeClose(debugLogger, &err) - - liveshareLogger = debugLogger.Logger - a.errLogger.Printf("Debug file located at: %s", debugLogger.Name()) - } - - session, err = codespaces.ConnectToLiveshare(ctx, a, liveshareLogger, a.apiClient, codespace) - if err != nil { - return nil, fmt.Errorf("failed to connect to Live Share: %w", err) - } - - return session, nil -} - //go:generate moq -fmt goimports -rm -skip-ensure -out mock_api.go . apiClient type apiClient interface { ServerURL() string @@ -99,11 +76,13 @@ type apiClient interface { CreateCodespace(ctx context.Context, params *api.CreateCodespaceParams) (*api.Codespace, error) EditCodespace(ctx context.Context, codespaceName string, params *api.EditCodespaceParams) (*api.Codespace, error) GetRepository(ctx context.Context, nwo string) (*api.Repository, error) - GetCodespacesMachines(ctx context.Context, repoID int, branch, location string, devcontainerPath string) ([]*api.Machine, error) + GetCodespacesMachines(ctx context.Context, repoID int, branch string, location string, devcontainerPath string) ([]*api.Machine, error) + GetCodespacesPermissionsCheck(ctx context.Context, repoID int, branch string, devcontainerPath string) (bool, error) GetCodespaceRepositoryContents(ctx context.Context, codespace *api.Codespace, path string) ([]byte, error) ListDevContainers(ctx context.Context, repoID int, branch string, limit int) (devcontainers []api.DevContainerEntry, err error) GetCodespaceRepoSuggestions(ctx context.Context, partialSearch string, params api.RepoSearchParameters) ([]string, error) GetCodespaceBillableOwner(ctx context.Context, nwo string) (*api.User, error) + HTTPClient() (*http.Client, error) } var errNoCodespaces = errors.New("you have no codespaces") @@ -135,10 +114,11 @@ func chooseCodespaceFromList(ctx context.Context, codespaces []*api.Codespace, i }, } + prompter := &Prompter{} var answers struct { Codespace int } - if err := ask(csSurvey, &answers); err != nil { + if err := prompter.Ask(csSurvey, &answers); err != nil { return nil, fmt.Errorf("error getting answers: %w", err) } @@ -166,9 +146,15 @@ func safeClose(closer io.Closer, err *error) { // It is not portable to assume stdin/stdout are fds 0 and 1. var hasTTY = term.IsTerminal(int(os.Stdin.Fd())) && term.IsTerminal(int(os.Stdout.Fd())) +type SurveyPrompter interface { + Ask(qs []*survey.Question, response interface{}) error +} + +type Prompter struct{} + // ask asks survey questions on the terminal, using standard options. // It fails unless hasTTY, but ideally callers should avoid calling it in that case. -func ask(qs []*survey.Question, response interface{}) error { +func (p *Prompter) Ask(qs []*survey.Question, response interface{}) error { if !hasTTY { return fmt.Errorf("no terminal") } @@ -199,10 +185,6 @@ func noArgsConstraint(cmd *cobra.Command, args []string) error { return nil } -func noopLogger() *log.Logger { - return log.New(io.Discard, "", 0) -} - type codespace struct { *api.Codespace } diff --git a/pkg/cmd/codespace/create.go b/pkg/cmd/codespace/create.go index 889f0b33b..67eb5461e 100644 --- a/pkg/cmd/codespace/create.go +++ b/pkg/cmd/codespace/create.go @@ -11,7 +11,6 @@ import ( "github.com/cli/cli/v2/internal/codespaces" "github.com/cli/cli/v2/internal/codespaces/api" "github.com/cli/cli/v2/internal/ghrepo" - "github.com/cli/cli/v2/internal/text" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/spf13/cobra" ) @@ -20,6 +19,15 @@ const ( DEVCONTAINER_PROMPT_DEFAULT = "Default Codespaces configuration" ) +const ( + permissionsPollingInterval = 5 * time.Second + permissionsPollingTimeout = 1 * time.Minute +) + +const ( + displayNameMaxLength = 48 // 48 is the max length of the display name in the API +) + var ( DEFAULT_DEVCONTAINER_DEFINITIONS = []string{".devcontainer.json", ".devcontainer/devcontainer.json"} ) @@ -106,7 +114,7 @@ func newCreateCmd(app *App) *cobra.Command { createCmd.Flags().DurationVar(&opts.idleTimeout, "idle-timeout", 0, "allowed inactivity before codespace is stopped, e.g. \"10m\", \"1h\"") createCmd.Flags().Var(&opts.retentionPeriod, "retention-period", "allowed time after shutting down before the codespace is automatically deleted (maximum 30 days), e.g. \"1h\", \"72h\"") createCmd.Flags().StringVar(&opts.devContainerPath, "devcontainer-path", "", "path to the devcontainer.json file to use when creating codespace") - createCmd.Flags().StringVarP(&opts.displayName, "display-name", "d", "", "display name for the codespace") + createCmd.Flags().StringVarP(&opts.displayName, "display-name", "d", "", fmt.Sprintf("display name for the codespace (%d characters or less)", displayNameMaxLength)) return createCmd } @@ -132,6 +140,7 @@ func (a *App) Create(ctx context.Context, opts createOptions) error { return a.browser.Browse(fmt.Sprintf("%s/codespaces/new", a.apiClient.ServerURL())) } + prompter := &Prompter{} promptForRepoAndBranch := userInputs.Repository == "" && !opts.useWeb if promptForRepoAndBranch { var defaultRepo string @@ -159,7 +168,7 @@ func (a *App) Create(ctx context.Context, opts createOptions) error { Validate: survey.Required, }, } - if err := ask(repoQuestions, &userInputs); err != nil { + if err := prompter.Ask(repoQuestions, &userInputs); err != nil { return fmt.Errorf("failed to prompt: %w", err) } } @@ -204,7 +213,7 @@ func (a *App) Create(ctx context.Context, opts createOptions) error { }, } - if err := ask(branchQuestions, &userInputs); err != nil { + if err := prompter.Ask(branchQuestions, &userInputs); err != nil { return fmt.Errorf("failed to prompt: %w", err) } } @@ -251,7 +260,7 @@ func (a *App) Create(ctx context.Context, opts createOptions) error { }, } - if err := ask([]*survey.Question{devContainerPathQuestion}, &devContainerPath); err != nil { + if err := prompter.Ask([]*survey.Question{devContainerPathQuestion}, &devContainerPath); err != nil { return fmt.Errorf("failed to prompt: %w", err) } } @@ -269,7 +278,7 @@ func (a *App) Create(ctx context.Context, opts createOptions) error { // web UI also provide a way to select machine type // therefore we let the user choose from the web UI instead of prompting from CLI if !(opts.useWeb && opts.machine == "") { - machine, err = getMachineName(ctx, a.apiClient, repository.ID, opts.machine, branch, userInputs.Location, devContainerPath) + machine, err = getMachineName(ctx, a.apiClient, prompter, repository.ID, opts.machine, branch, userInputs.Location, devContainerPath) if err != nil { return fmt.Errorf("error getting machine type: %w", err) } @@ -278,6 +287,10 @@ func (a *App) Create(ctx context.Context, opts createOptions) error { } } + if len(opts.displayName) > displayNameMaxLength { + return fmt.Errorf("error creating codespace: display name should contain a maximum of %d characters", displayNameMaxLength) + } + createParams := &api.CreateCodespaceParams{ RepositoryID: repository.ID, Branch: branch, @@ -308,7 +321,7 @@ func (a *App) Create(ctx context.Context, opts createOptions) error { return fmt.Errorf("error creating codespace: %w", err) } - codespace, err = a.handleAdditionalPermissions(ctx, createParams, aerr.AllowPermissionsURL) + codespace, err = a.handleAdditionalPermissions(ctx, prompter, createParams, aerr.AllowPermissionsURL) if err != nil { // this error could be a cmdutil.SilentError (in the case that the user opened the browser) so we don't want to wrap it return err @@ -332,17 +345,16 @@ func (a *App) Create(ctx context.Context, opts createOptions) error { return nil } -func (a *App) handleAdditionalPermissions(ctx context.Context, createParams *api.CreateCodespaceParams, allowPermissionsURL string) (*api.Codespace, error) { +func (a *App) handleAdditionalPermissions(ctx context.Context, prompter SurveyPrompter, createParams *api.CreateCodespaceParams, allowPermissionsURL string) (*api.Codespace, error) { var ( isInteractive = a.io.CanPrompt() cs = a.io.ColorScheme() - displayURL = text.DisplayURL(allowPermissionsURL) ) fmt.Fprintf(a.io.ErrOut, "You must authorize or deny additional permissions requested by this codespace before continuing.\n") if !isInteractive { - fmt.Fprintf(a.io.ErrOut, "%s in your browser to review and authorize additional permissions: %s\n", cs.Bold("Open this URL"), displayURL) + fmt.Fprintf(a.io.ErrOut, "%s in your browser to review and authorize additional permissions: %s\n", cs.Bold("Open this URL"), allowPermissionsURL) fmt.Fprintf(a.io.ErrOut, "Alternatively, you can run %q with the %q option to continue without authorizing additional permissions.\n", a.io.ColorScheme().Bold("create"), cs.Bold("--default-permissions")) return nil, cmdutil.SilentError } @@ -368,24 +380,25 @@ func (a *App) handleAdditionalPermissions(ctx context.Context, createParams *api Accept string } - if err := ask(permsSurvey, &answers); err != nil { + if err := prompter.Ask(permsSurvey, &answers); err != nil { return nil, fmt.Errorf("error getting answers: %w", err) } // if the user chose to continue in the browser, open the URL if answers.Accept == choices[0] { - fmt.Fprintln(a.io.ErrOut, "Please re-run the create request after accepting permissions in the browser.") if err := a.browser.Browse(allowPermissionsURL); err != nil { return nil, fmt.Errorf("error opening browser: %w", err) } - // browser opened successfully but we do not know if they accepted the permissions - // so we must exit and wait for the user to attempt the create again - return nil, cmdutil.SilentError - } - // if the user chose to create the codespace without the permissions, - // we can continue with the create opting out of the additional permissions - createParams.PermissionsOptOut = true + // Poll until the user has accepted the permissions or timeout + if err := a.pollForPermissions(ctx, createParams); err != nil { + return nil, fmt.Errorf("error polling for permissions: %w", err) + } + } else { + // If the user chose to create the codespace without the permissions, + // we can continue with the create opting out of the additional permissions + createParams.PermissionsOptOut = true + } var codespace *api.Codespace err := a.RunWithProgress("Creating codespace", func() (err error) { @@ -400,6 +413,39 @@ func (a *App) handleAdditionalPermissions(ctx context.Context, createParams *api return codespace, nil } +func (a *App) pollForPermissions(ctx context.Context, createParams *api.CreateCodespaceParams) error { + return a.RunWithProgress("Waiting for permissions to be accepted in the browser", func() (err error) { + ctx, cancel := context.WithTimeout(ctx, permissionsPollingTimeout) + defer cancel() + + done := make(chan error, 1) + go func() { + for { + accepted, err := a.apiClient.GetCodespacesPermissionsCheck(ctx, createParams.RepositoryID, createParams.Branch, createParams.DevContainerPath) + if err != nil { + done <- err + return + } + + if accepted { + done <- nil + return + } + + // Wait before polling again + time.Sleep(permissionsPollingInterval) + } + }() + + select { + case err := <-done: + return err + case <-ctx.Done(): + return fmt.Errorf("timed out waiting for permissions to be accepted in the browser") + } + }) +} + // showStatus polls the codespace for a list of post create states and their status. It will keep polling // until all states have finished. Once all states have finished, we poll once more to check if any new // states have been introduced and stop polling otherwise. @@ -465,7 +511,7 @@ func (a *App) showStatus(ctx context.Context, codespace *api.Codespace) error { } // getMachineName prompts the user to select the machine type, or validates the machine if non-empty. -func getMachineName(ctx context.Context, apiClient apiClient, repoID int, machine, branch, location string, devcontainerPath string) (string, error) { +func getMachineName(ctx context.Context, apiClient apiClient, prompter SurveyPrompter, repoID int, machine, branch, location string, devcontainerPath string) (string, error) { machines, err := apiClient.GetCodespacesMachines(ctx, repoID, branch, location, devcontainerPath) if err != nil { return "", fmt.Errorf("error requesting machine instance types: %w", err) @@ -516,7 +562,7 @@ func getMachineName(ctx context.Context, apiClient apiClient, repoID int, machin } var machineAnswers struct{ Machine string } - if err := ask(machineSurvey, &machineAnswers); err != nil { + if err := prompter.Ask(machineSurvey, &machineAnswers); err != nil { return "", fmt.Errorf("error getting machine: %w", err) } diff --git a/pkg/cmd/codespace/create_test.go b/pkg/cmd/codespace/create_test.go index caf6df271..6466d9be7 100644 --- a/pkg/cmd/codespace/create_test.go +++ b/pkg/cmd/codespace/create_test.go @@ -7,6 +7,7 @@ import ( "testing" "time" + "github.com/AlecAivazis/survey/v2" "github.com/cli/cli/v2/internal/browser" "github.com/cli/cli/v2/internal/codespaces/api" "github.com/cli/cli/v2/pkg/cmdutil" @@ -184,6 +185,25 @@ func TestApp_Create(t *testing.T) { wantStderr: " ✓ Codespaces usage for this repository is paid for by monalisa\n", wantErr: fmt.Errorf("error getting machine type: there is no such machine for the repository: %s\nAvailable machines: %v", "MEGA", []string{"GIGA", "TERA"}), }, + { + name: "create codespace with display name more than 48 characters results in error", + fields: fields{ + apiClient: apiCreateDefaults(&apiClientMock{ + CreateCodespaceFunc: func(ctx context.Context, params *api.CreateCodespaceParams) (*api.Codespace, error) { + return &api.Codespace{ + Name: "monalisa-dotfiles-abcd1234", + }, nil + }, + }), + }, + opts: createOptions{ + repo: "monalisa/dotfiles", + machine: "GIGA", + displayName: "this-is-very-long-display-name-with-49-characters", + }, + wantStderr: " ✓ Codespaces usage for this repository is paid for by monalisa\n", + wantErr: fmt.Errorf("error creating codespace: display name should contain a maximum of %d characters", displayNameMaxLength), + }, { name: "create codespace with devcontainer path results in selecting the correct machine type", fields: fields{ @@ -356,7 +376,39 @@ func TestApp_Create(t *testing.T) { wantErr: cmdutil.SilentError, wantStderr: ` ✓ Codespaces usage for this repository is paid for by monalisa You must authorize or deny additional permissions requested by this codespace before continuing. -Open this URL in your browser to review and authorize additional permissions: example.com/permissions +Open this URL in your browser to review and authorize additional permissions: https://example.com/permissions +Alternatively, you can run "create" with the "--default-permissions" option to continue without authorizing additional permissions. +`, + }, + { + name: "create codespace that requires accepting additional permissions for devcontainer path", + fields: fields{ + apiClient: apiCreateDefaults(&apiClientMock{ + CreateCodespaceFunc: func(ctx context.Context, params *api.CreateCodespaceParams) (*api.Codespace, error) { + if params.Branch != "feature-branch" { + return nil, fmt.Errorf("got branch %q, want %q", params.Branch, "main") + } + if params.IdleTimeoutMinutes != 30 { + return nil, fmt.Errorf("idle timeout minutes was %v", params.IdleTimeoutMinutes) + } + return &api.Codespace{}, api.AcceptPermissionsRequiredError{ + AllowPermissionsURL: "https://example.com/permissions?ref=feature-branch&devcontainer_path=.devcontainer/actions/devcontainer.json", + } + }, + }), + }, + opts: createOptions{ + repo: "monalisa/dotfiles", + branch: "feature-branch", + devContainerPath: ".devcontainer/actions/devcontainer.json", + machine: "GIGA", + showStatus: false, + idleTimeout: 30 * time.Minute, + }, + wantErr: cmdutil.SilentError, + wantStderr: ` ✓ Codespaces usage for this repository is paid for by monalisa +You must authorize or deny additional permissions requested by this codespace before continuing. +Open this URL in your browser to review and authorize additional permissions: https://example.com/permissions?ref=feature-branch&devcontainer_path=.devcontainer/actions/devcontainer.json Alternatively, you can run "create" with the "--default-permissions" option to continue without authorizing additional permissions. `, }, @@ -652,6 +704,127 @@ func TestBuildDisplayName(t *testing.T) { } } +type MockSurveyPrompter struct { + AskFunc func(qs []*survey.Question, response interface{}) error +} + +func (m *MockSurveyPrompter) Ask(qs []*survey.Question, response interface{}) error { + return m.AskFunc(qs, response) +} + +type MockBrowser struct { + Err error +} + +func (b *MockBrowser) Browse(url string) error { + if b.Err != nil { + return b.Err + } + + return nil +} + +func TestHandleAdditionalPermissions(t *testing.T) { + tests := []struct { + name string + isInteractive bool + accept string + permissionsOptOut bool + browserErr error + pollForPermissionsErr error + createCodespaceErr error + wantErr bool + }{ + { + name: "non-interactive", + isInteractive: false, + permissionsOptOut: false, + wantErr: true, + }, + { + name: "interactive, continue in browser, browser error", + isInteractive: true, + accept: "Continue in browser to review and authorize additional permissions (Recommended)", + permissionsOptOut: false, + browserErr: fmt.Errorf("browser error"), + wantErr: true, + }, + { + name: "interactive, continue in browser, poll for permissions error", + isInteractive: true, + accept: "Continue in browser to review and authorize additional permissions (Recommended)", + permissionsOptOut: false, + pollForPermissionsErr: fmt.Errorf("poll for permissions error"), + wantErr: true, + }, + { + name: "interactive, continue in browser, create codespace error", + isInteractive: true, + accept: "Continue in browser to review and authorize additional permissions (Recommended)", + permissionsOptOut: false, + createCodespaceErr: fmt.Errorf("create codespace error"), + wantErr: true, + }, + { + name: "interactive, continue without authorizing", + isInteractive: true, + accept: "Continue without authorizing additional permissions", + permissionsOptOut: true, + createCodespaceErr: fmt.Errorf("create codespace error"), + wantErr: true, + }, + { + name: "interactive, continue without authorizing, create codespace success", + isInteractive: true, + accept: "Continue without authorizing additional permissions", + permissionsOptOut: true, + }, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + ios, _, _, _ := iostreams.Test() + a := &App{ + io: ios, + browser: &MockBrowser{ + Err: tt.browserErr, + }, + apiClient: &apiClientMock{ + CreateCodespaceFunc: func(ctx context.Context, params *api.CreateCodespaceParams) (*api.Codespace, error) { + return nil, tt.createCodespaceErr + }, + GetCodespacesPermissionsCheckFunc: func(ctx context.Context, repoID int, branch string, devcontainerPath string) (bool, error) { + if tt.pollForPermissionsErr != nil { + return false, tt.pollForPermissionsErr + } + return true, nil + }, + }, + } + + if tt.isInteractive { + a.io.SetStdinTTY(true) + a.io.SetStdoutTTY(true) + a.io.SetStderrTTY(true) + } + + params := &api.CreateCodespaceParams{} + _, err := a.handleAdditionalPermissions(context.Background(), &MockSurveyPrompter{ + AskFunc: func(qs []*survey.Question, response interface{}) error { + *response.(*struct{ Accept string }) = struct{ Accept string }{Accept: tt.accept} + return nil + }, + }, params, "http://example.com") + if (err != nil) != tt.wantErr { + t.Errorf("handleAdditionalPermissions() error = %v, wantErr %v", err, tt.wantErr) + } + if tt.permissionsOptOut != params.PermissionsOptOut { + t.Errorf("handleAdditionalPermissions() permissionsOptOut = %v, want %v", params.PermissionsOptOut, tt.permissionsOptOut) + } + }) + } +} + func apiCreateDefaults(c *apiClientMock) *apiClientMock { if c.GetRepositoryFunc == nil { c.GetRepositoryFunc = func(ctx context.Context, nwo string) (*api.Repository, error) { diff --git a/pkg/cmd/codespace/delete.go b/pkg/cmd/codespace/delete.go index e54bf09fb..5da24a634 100644 --- a/pkg/cmd/codespace/delete.go +++ b/pkg/cmd/codespace/delete.go @@ -220,6 +220,7 @@ func confirmDeletion(p prompter, apiCodespace *api.Codespace, isInteractive bool type surveyPrompter struct{} func (p *surveyPrompter) Confirm(message string) (bool, error) { + prompter := &Prompter{} var confirmed struct { Confirmed bool } @@ -231,7 +232,7 @@ func (p *surveyPrompter) Confirm(message string) (bool, error) { }, }, } - if err := ask(q, &confirmed); err != nil { + if err := prompter.Ask(q, &confirmed); err != nil { return false, fmt.Errorf("failed to prompt: %w", err) } diff --git a/pkg/cmd/codespace/jupyter.go b/pkg/cmd/codespace/jupyter.go index 91c798eda..a27a34271 100644 --- a/pkg/cmd/codespace/jupyter.go +++ b/pkg/cmd/codespace/jupyter.go @@ -7,8 +7,8 @@ import ( "strings" "github.com/cli/cli/v2/internal/codespaces" + "github.com/cli/cli/v2/internal/codespaces/portforwarder" "github.com/cli/cli/v2/internal/codespaces/rpc" - "github.com/cli/cli/v2/pkg/liveshare" "github.com/spf13/cobra" ) @@ -39,11 +39,16 @@ func (a *App) Jupyter(ctx context.Context, selector *CodespaceSelector) (err err return err } - session, err := startLiveShareSession(ctx, codespace, a, false, "") + codespaceConnection, err := codespaces.GetCodespaceConnection(ctx, a, a.apiClient, codespace) if err != nil { - return err + return fmt.Errorf("error connecting to codespace: %w", err) } - defer safeClose(session, &err) + + fwd, err := portforwarder.NewPortForwarder(ctx, codespaceConnection) + if err != nil { + return fmt.Errorf("failed to create port forwarder: %w", err) + } + defer safeClose(fwd, &err) var ( invoker rpc.Invoker @@ -51,7 +56,7 @@ func (a *App) Jupyter(ctx context.Context, selector *CodespaceSelector) (err err serverUrl string ) err = a.RunWithProgress("Starting JupyterLab on codespace", func() (err error) { - invoker, err = rpc.CreateInvoker(ctx, session) + invoker, err = rpc.CreateInvoker(ctx, fwd) if err != nil { return } @@ -76,8 +81,10 @@ func (a *App) Jupyter(ctx context.Context, selector *CodespaceSelector) (err err tunnelClosed := make(chan error, 1) go func() { - fwd := liveshare.NewPortForwarder(session, "jupyter", serverPort, true) - tunnelClosed <- fwd.ForwardToListener(ctx, listen) // always non-nil + opts := portforwarder.ForwardPortOpts{ + Port: serverPort, + } + tunnelClosed <- fwd.ForwardPortToListener(ctx, opts, listen) }() // Server URL contains an authentication token that must be preserved diff --git a/pkg/cmd/codespace/list.go b/pkg/cmd/codespace/list.go index 4775e3db5..c1acccabb 100644 --- a/pkg/cmd/codespace/list.go +++ b/pkg/cmd/codespace/list.go @@ -7,9 +7,8 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/internal/codespaces/api" - "github.com/cli/cli/v2/internal/text" + "github.com/cli/cli/v2/internal/tableprinter" "github.com/cli/cli/v2/pkg/cmdutil" - "github.com/cli/cli/v2/utils" "github.com/spf13/cobra" ) @@ -116,25 +115,23 @@ func (a *App) List(ctx context.Context, opts *listOptions, exporter cmdutil.Expo return a.browser.Browse(fmt.Sprintf("%s/codespaces?repository_id=%d", a.apiClient.ServerURL(), codespaces[0].Repository.ID)) } - //nolint:staticcheck // SA1019: utils.NewTablePrinter is deprecated: use internal/tableprinter - tp := utils.NewTablePrinter(a.io) - if tp.IsTTY() { - tp.AddField("NAME", nil, nil) - tp.AddField("DISPLAY NAME", nil, nil) - if opts.orgName != "" { - tp.AddField("OWNER", nil, nil) - } - tp.AddField("REPOSITORY", nil, nil) - tp.AddField("BRANCH", nil, nil) - tp.AddField("STATE", nil, nil) - tp.AddField("CREATED AT", nil, nil) - - if hasNonProdVSCSTarget { - tp.AddField("VSCS TARGET", nil, nil) - } - - tp.EndRow() + headers := []string{ + "NAME", + "DISPLAY NAME", } + if opts.orgName != "" { + headers = append(headers, "OWNER") + } + headers = append(headers, + "REPOSITORY", + "BRANCH", + "STATE", + "CREATED AT", + ) + if hasNonProdVSCSTarget { + headers = append(headers, "VSCS TARGET") + } + tp := tableprinter.New(a.io, tableprinter.WithHeader(headers...)) cs := a.io.ColorScheme() for _, apiCodespace := range codespaces { @@ -158,31 +155,27 @@ func (a *App) List(ctx context.Context, opts *listOptions, exporter cmdutil.Expo nameColor = cs.Gray } - tp.AddField(formattedName, nil, nameColor) - tp.AddField(c.DisplayName, nil, nil) + tp.AddField(formattedName, tableprinter.WithColor(nameColor)) + tp.AddField(c.DisplayName) if opts.orgName != "" { - tp.AddField(c.Owner.Login, nil, nil) + tp.AddField(c.Owner.Login) } - tp.AddField(c.Repository.FullName, nil, nil) - tp.AddField(c.branchWithGitStatus(), nil, cs.Cyan) + tp.AddField(c.Repository.FullName) + tp.AddField(c.branchWithGitStatus(), tableprinter.WithColor(cs.Cyan)) if c.PendingOperation { - tp.AddField(c.PendingOperationDisabledReason, nil, nameColor) + tp.AddField(c.PendingOperationDisabledReason, tableprinter.WithColor(nameColor)) } else { - tp.AddField(c.State, nil, stateColor) + tp.AddField(c.State, tableprinter.WithColor(stateColor)) } - if tp.IsTTY() { - ct, err := time.Parse(time.RFC3339, c.CreatedAt) - if err != nil { - return fmt.Errorf("error parsing date %q: %w", c.CreatedAt, err) - } - tp.AddField(text.FuzzyAgoAbbr(time.Now(), ct), nil, cs.Gray) - } else { - tp.AddField(c.CreatedAt, nil, nil) + ct, err := time.Parse(time.RFC3339, c.CreatedAt) + if err != nil { + return fmt.Errorf("error parsing date %q: %w", c.CreatedAt, err) } + tp.AddTimeField(time.Now(), ct, cs.Gray) if hasNonProdVSCSTarget { - tp.AddField(c.VSCSTarget, nil, nil) + tp.AddField(c.VSCSTarget) } tp.EndRow() diff --git a/pkg/cmd/codespace/list_test.go b/pkg/cmd/codespace/list_test.go index 35f30581b..49bb0b4d2 100644 --- a/pkg/cmd/codespace/list_test.go +++ b/pkg/cmd/codespace/list_test.go @@ -85,6 +85,7 @@ func TestApp_List(t *testing.T) { return []*api.Codespace{ { DisplayName: "CS1", + CreatedAt: "2023-01-01T00:00:00Z", }, }, nil }, @@ -106,6 +107,7 @@ func TestApp_List(t *testing.T) { return []*api.Codespace{ { DisplayName: "CS1", + CreatedAt: "2023-01-01T00:00:00Z", }, }, nil }, @@ -129,6 +131,7 @@ func TestApp_List(t *testing.T) { return []*api.Codespace{ { DisplayName: "CS1", + CreatedAt: "2023-01-01T00:00:00Z", }, }, nil }, @@ -159,6 +162,7 @@ func TestApp_List(t *testing.T) { return []*api.Codespace{ { DisplayName: "CS1", + CreatedAt: "2023-01-01T00:00:00Z", }, }, nil }, diff --git a/pkg/cmd/codespace/logs.go b/pkg/cmd/codespace/logs.go index 3ec950849..37b301217 100644 --- a/pkg/cmd/codespace/logs.go +++ b/pkg/cmd/codespace/logs.go @@ -5,8 +5,8 @@ import ( "fmt" "github.com/cli/cli/v2/internal/codespaces" + "github.com/cli/cli/v2/internal/codespaces/portforwarder" "github.com/cli/cli/v2/internal/codespaces/rpc" - "github.com/cli/cli/v2/pkg/liveshare" "github.com/spf13/cobra" ) @@ -42,11 +42,16 @@ func (a *App) Logs(ctx context.Context, selector *CodespaceSelector, follow bool return err } - session, err := startLiveShareSession(ctx, codespace, a, false, "") + codespaceConnection, err := codespaces.GetCodespaceConnection(ctx, a, a.apiClient, codespace) if err != nil { - return err + return fmt.Errorf("error connecting to codespace: %w", err) } - defer safeClose(session, &err) + + fwd, err := portforwarder.NewPortForwarder(ctx, codespaceConnection) + if err != nil { + return fmt.Errorf("failed to create port forwarder: %w", err) + } + defer safeClose(fwd, &err) // Ensure local port is listening before client (getPostCreateOutput) connects. listen, localPort, err := codespaces.ListenTCP(0, false) @@ -57,7 +62,7 @@ func (a *App) Logs(ctx context.Context, selector *CodespaceSelector, follow bool remoteSSHServerPort, sshUser := 0, "" err = a.RunWithProgress("Fetching SSH Details", func() (err error) { - invoker, err := rpc.CreateInvoker(ctx, session) + invoker, err := rpc.CreateInvoker(ctx, fwd) if err != nil { return } @@ -85,8 +90,11 @@ func (a *App) Logs(ctx context.Context, selector *CodespaceSelector, follow bool tunnelClosed := make(chan error, 1) go func() { - fwd := liveshare.NewPortForwarder(session, "sshd", remoteSSHServerPort, false) - tunnelClosed <- fwd.ForwardToListener(ctx, listen) // error is non-nil + opts := portforwarder.ForwardPortOpts{ + Port: remoteSSHServerPort, + Internal: true, + } + tunnelClosed <- fwd.ForwardPortToListener(ctx, opts, listen) }() cmdDone := make(chan error, 1) diff --git a/pkg/cmd/codespace/mock_api.go b/pkg/cmd/codespace/mock_api.go index 7e211fd7c..e4de0ae7a 100644 --- a/pkg/cmd/codespace/mock_api.go +++ b/pkg/cmd/codespace/mock_api.go @@ -5,6 +5,7 @@ package codespace import ( "context" + "net/http" "sync" codespacesAPI "github.com/cli/cli/v2/internal/codespaces/api" @@ -40,24 +41,30 @@ import ( // GetCodespacesMachinesFunc: func(ctx context.Context, repoID int, branch string, location string, devcontainerPath string) ([]*codespacesAPI.Machine, error) { // panic("mock out the GetCodespacesMachines method") // }, +// GetCodespacesPermissionsCheckFunc: func(ctx context.Context, repoID int, branch string, devcontainerPath string) (bool, error) { +// panic("mock out the GetCodespacesPermissionsCheck method") +// }, // GetOrgMemberCodespaceFunc: func(ctx context.Context, orgName string, userName string, codespaceName string) (*codespacesAPI.Codespace, error) { // panic("mock out the GetOrgMemberCodespace method") // }, // GetRepositoryFunc: func(ctx context.Context, nwo string) (*codespacesAPI.Repository, error) { // panic("mock out the GetRepository method") // }, -// ServerURLFunc: func() string { -// panic("mock out the ServerURL method") -// }, // GetUserFunc: func(ctx context.Context) (*codespacesAPI.User, error) { // panic("mock out the GetUser method") // }, +// HTTPClientFunc: func() (*http.Client, error) { +// panic("mock out the HTTPClient method") +// }, // ListCodespacesFunc: func(ctx context.Context, opts codespacesAPI.ListCodespacesOptions) ([]*codespacesAPI.Codespace, error) { // panic("mock out the ListCodespaces method") // }, // ListDevContainersFunc: func(ctx context.Context, repoID int, branch string, limit int) ([]codespacesAPI.DevContainerEntry, error) { // panic("mock out the ListDevContainers method") // }, +// ServerURLFunc: func() string { +// panic("mock out the ServerURL method") +// }, // StartCodespaceFunc: func(ctx context.Context, name string) error { // panic("mock out the StartCodespace method") // }, @@ -95,24 +102,30 @@ type apiClientMock struct { // GetCodespacesMachinesFunc mocks the GetCodespacesMachines method. GetCodespacesMachinesFunc func(ctx context.Context, repoID int, branch string, location string, devcontainerPath string) ([]*codespacesAPI.Machine, error) + // GetCodespacesPermissionsCheckFunc mocks the GetCodespacesPermissionsCheck method. + GetCodespacesPermissionsCheckFunc func(ctx context.Context, repoID int, branch string, devcontainerPath string) (bool, error) + // GetOrgMemberCodespaceFunc mocks the GetOrgMemberCodespace method. GetOrgMemberCodespaceFunc func(ctx context.Context, orgName string, userName string, codespaceName string) (*codespacesAPI.Codespace, error) // GetRepositoryFunc mocks the GetRepository method. GetRepositoryFunc func(ctx context.Context, nwo string) (*codespacesAPI.Repository, error) - // ServerURLFunc mocks the ServerURL method. - ServerURLFunc func() string - // GetUserFunc mocks the GetUser method. GetUserFunc func(ctx context.Context) (*codespacesAPI.User, error) + // HTTPClientFunc mocks the HTTPClient method. + HTTPClientFunc func() (*http.Client, error) + // ListCodespacesFunc mocks the ListCodespaces method. ListCodespacesFunc func(ctx context.Context, opts codespacesAPI.ListCodespacesOptions) ([]*codespacesAPI.Codespace, error) // ListDevContainersFunc mocks the ListDevContainers method. ListDevContainersFunc func(ctx context.Context, repoID int, branch string, limit int) ([]codespacesAPI.DevContainerEntry, error) + // ServerURLFunc mocks the ServerURL method. + ServerURLFunc func() string + // StartCodespaceFunc mocks the StartCodespace method. StartCodespaceFunc func(ctx context.Context, name string) error @@ -195,6 +208,17 @@ type apiClientMock struct { // DevcontainerPath is the devcontainerPath argument value. DevcontainerPath string } + // GetCodespacesPermissionsCheck holds details about calls to the GetCodespacesPermissionsCheck method. + GetCodespacesPermissionsCheck []struct { + // Ctx is the ctx argument value. + Ctx context.Context + // RepoID is the repoID argument value. + RepoID int + // Branch is the branch argument value. + Branch string + // DevcontainerPath is the devcontainerPath argument value. + DevcontainerPath string + } // GetOrgMemberCodespace holds details about calls to the GetOrgMemberCodespace method. GetOrgMemberCodespace []struct { // Ctx is the ctx argument value. @@ -213,14 +237,14 @@ type apiClientMock struct { // Nwo is the nwo argument value. Nwo string } - // ServerURL holds details about calls to the ServerURL method. - ServerURL []struct { - } // GetUser holds details about calls to the GetUser method. GetUser []struct { // Ctx is the ctx argument value. Ctx context.Context } + // HTTPClient holds details about calls to the HTTPClient method. + HTTPClient []struct { + } // ListCodespaces holds details about calls to the ListCodespaces method. ListCodespaces []struct { // Ctx is the ctx argument value. @@ -239,6 +263,9 @@ type apiClientMock struct { // Limit is the limit argument value. Limit int } + // ServerURL holds details about calls to the ServerURL method. + ServerURL []struct { + } // StartCodespace holds details about calls to the StartCodespace method. StartCodespace []struct { // Ctx is the ctx argument value. @@ -266,12 +293,14 @@ type apiClientMock struct { lockGetCodespaceRepoSuggestions sync.RWMutex lockGetCodespaceRepositoryContents sync.RWMutex lockGetCodespacesMachines sync.RWMutex + lockGetCodespacesPermissionsCheck sync.RWMutex lockGetOrgMemberCodespace sync.RWMutex lockGetRepository sync.RWMutex - lockServerURL sync.RWMutex lockGetUser sync.RWMutex + lockHTTPClient sync.RWMutex lockListCodespaces sync.RWMutex lockListDevContainers sync.RWMutex + lockServerURL sync.RWMutex lockStartCodespace sync.RWMutex lockStopCodespace sync.RWMutex } @@ -600,6 +629,50 @@ func (mock *apiClientMock) GetCodespacesMachinesCalls() []struct { return calls } +// GetCodespacesPermissionsCheck calls GetCodespacesPermissionsCheckFunc. +func (mock *apiClientMock) GetCodespacesPermissionsCheck(ctx context.Context, repoID int, branch string, devcontainerPath string) (bool, error) { + if mock.GetCodespacesPermissionsCheckFunc == nil { + panic("apiClientMock.GetCodespacesPermissionsCheckFunc: method is nil but apiClient.GetCodespacesPermissionsCheck was just called") + } + callInfo := struct { + Ctx context.Context + RepoID int + Branch string + DevcontainerPath string + }{ + Ctx: ctx, + RepoID: repoID, + Branch: branch, + DevcontainerPath: devcontainerPath, + } + mock.lockGetCodespacesPermissionsCheck.Lock() + mock.calls.GetCodespacesPermissionsCheck = append(mock.calls.GetCodespacesPermissionsCheck, callInfo) + mock.lockGetCodespacesPermissionsCheck.Unlock() + return mock.GetCodespacesPermissionsCheckFunc(ctx, repoID, branch, devcontainerPath) +} + +// GetCodespacesPermissionsCheckCalls gets all the calls that were made to GetCodespacesPermissionsCheck. +// Check the length with: +// +// len(mockedapiClient.GetCodespacesPermissionsCheckCalls()) +func (mock *apiClientMock) GetCodespacesPermissionsCheckCalls() []struct { + Ctx context.Context + RepoID int + Branch string + DevcontainerPath string +} { + var calls []struct { + Ctx context.Context + RepoID int + Branch string + DevcontainerPath string + } + mock.lockGetCodespacesPermissionsCheck.RLock() + calls = mock.calls.GetCodespacesPermissionsCheck + mock.lockGetCodespacesPermissionsCheck.RUnlock() + return calls +} + // GetOrgMemberCodespace calls GetOrgMemberCodespaceFunc. func (mock *apiClientMock) GetOrgMemberCodespace(ctx context.Context, orgName string, userName string, codespaceName string) (*codespacesAPI.Codespace, error) { if mock.GetOrgMemberCodespaceFunc == nil { @@ -680,33 +753,6 @@ func (mock *apiClientMock) GetRepositoryCalls() []struct { return calls } -// ServerURL calls ServerURLFunc. -func (mock *apiClientMock) ServerURL() string { - if mock.ServerURLFunc == nil { - panic("apiClientMock.ServerURLFunc: method is nil but apiClient.ServerURL was just called") - } - callInfo := struct { - }{} - mock.lockServerURL.Lock() - mock.calls.ServerURL = append(mock.calls.ServerURL, callInfo) - mock.lockServerURL.Unlock() - return mock.ServerURLFunc() -} - -// ServerURLCalls gets all the calls that were made to ServerURL. -// Check the length with: -// -// len(mockedapiClient.ServerURLCalls()) -func (mock *apiClientMock) ServerURLCalls() []struct { -} { - var calls []struct { - } - mock.lockServerURL.RLock() - calls = mock.calls.ServerURL - mock.lockServerURL.RUnlock() - return calls -} - // GetUser calls GetUserFunc. func (mock *apiClientMock) GetUser(ctx context.Context) (*codespacesAPI.User, error) { if mock.GetUserFunc == nil { @@ -739,6 +785,33 @@ func (mock *apiClientMock) GetUserCalls() []struct { return calls } +// HTTPClient calls HTTPClientFunc. +func (mock *apiClientMock) HTTPClient() (*http.Client, error) { + if mock.HTTPClientFunc == nil { + panic("apiClientMock.HTTPClientFunc: method is nil but apiClient.HTTPClient was just called") + } + callInfo := struct { + }{} + mock.lockHTTPClient.Lock() + mock.calls.HTTPClient = append(mock.calls.HTTPClient, callInfo) + mock.lockHTTPClient.Unlock() + return mock.HTTPClientFunc() +} + +// HTTPClientCalls gets all the calls that were made to HTTPClient. +// Check the length with: +// +// len(mockedapiClient.HTTPClientCalls()) +func (mock *apiClientMock) HTTPClientCalls() []struct { +} { + var calls []struct { + } + mock.lockHTTPClient.RLock() + calls = mock.calls.HTTPClient + mock.lockHTTPClient.RUnlock() + return calls +} + // ListCodespaces calls ListCodespacesFunc. func (mock *apiClientMock) ListCodespaces(ctx context.Context, opts codespacesAPI.ListCodespacesOptions) ([]*codespacesAPI.Codespace, error) { if mock.ListCodespacesFunc == nil { @@ -819,6 +892,33 @@ func (mock *apiClientMock) ListDevContainersCalls() []struct { return calls } +// ServerURL calls ServerURLFunc. +func (mock *apiClientMock) ServerURL() string { + if mock.ServerURLFunc == nil { + panic("apiClientMock.ServerURLFunc: method is nil but apiClient.ServerURL was just called") + } + callInfo := struct { + }{} + mock.lockServerURL.Lock() + mock.calls.ServerURL = append(mock.calls.ServerURL, callInfo) + mock.lockServerURL.Unlock() + return mock.ServerURLFunc() +} + +// ServerURLCalls gets all the calls that were made to ServerURL. +// Check the length with: +// +// len(mockedapiClient.ServerURLCalls()) +func (mock *apiClientMock) ServerURLCalls() []struct { +} { + var calls []struct { + } + mock.lockServerURL.RLock() + calls = mock.calls.ServerURL + mock.lockServerURL.RUnlock() + return calls +} + // StartCodespace calls StartCodespaceFunc. func (mock *apiClientMock) StartCodespace(ctx context.Context, name string) error { if mock.StartCodespaceFunc == nil { diff --git a/pkg/cmd/codespace/ports.go b/pkg/cmd/codespace/ports.go index cbe48b7b3..0608f0732 100644 --- a/pkg/cmd/codespace/ports.go +++ b/pkg/cmd/codespace/ports.go @@ -6,26 +6,21 @@ import ( "encoding/json" "errors" "fmt" - "net/http" "strconv" "strings" "time" "github.com/cli/cli/v2/internal/codespaces" "github.com/cli/cli/v2/internal/codespaces/api" + "github.com/cli/cli/v2/internal/codespaces/portforwarder" + "github.com/cli/cli/v2/internal/tableprinter" "github.com/cli/cli/v2/pkg/cmdutil" - "github.com/cli/cli/v2/pkg/liveshare" - "github.com/cli/cli/v2/utils" + "github.com/microsoft/dev-tunnels/go/tunnels" "github.com/muhammadmuzzammil1998/jsonc" "github.com/spf13/cobra" "golang.org/x/sync/errgroup" ) -const ( - vscodeServerPortName = "VSCodeServerInternal" - codespacesInternalPortName = "CodespacesInternal" -) - // newPortsCmd returns a Cobra "ports" command that displays a table of available ports, // according to the specified flags. func newPortsCmd(app *App) *cobra.Command { @@ -62,15 +57,20 @@ func (a *App) ListPorts(ctx context.Context, selector *CodespaceSelector, export devContainerCh := getDevContainer(ctx, a.apiClient, codespace) - session, err := startLiveShareSession(ctx, codespace, a, false, "") + codespaceConnection, err := codespaces.GetCodespaceConnection(ctx, a, a.apiClient, codespace) if err != nil { - return err + return fmt.Errorf("error connecting to codespace: %w", err) } - defer safeClose(session, &err) - var ports []*liveshare.Port + fwd, err := portforwarder.NewPortForwarder(ctx, codespaceConnection) + if err != nil { + return fmt.Errorf("failed to create port forwarder: %w", err) + } + defer safeClose(fwd, &err) + + var ports []*tunnels.TunnelPort err = a.RunWithProgress("Fetching ports", func() (err error) { - ports, err = session.GetSharedServers(ctx) + ports, err = fwd.ListPorts(ctx) return }) if err != nil { @@ -87,9 +87,10 @@ func (a *App) ListPorts(ctx context.Context, selector *CodespaceSelector, export for _, p := range ports { // filter out internal ports from list - if strings.HasPrefix(p.SessionName, vscodeServerPortName) || strings.HasPrefix(p.SessionName, codespacesInternalPortName) { + if portforwarder.IsInternalPort(p) { continue } + portInfos = append(portInfos, &portInfo{ Port: p, codespace: codespace, @@ -107,40 +108,34 @@ func (a *App) ListPorts(ctx context.Context, selector *CodespaceSelector, export } cs := a.io.ColorScheme() - //nolint:staticcheck // SA1019: utils.NewTablePrinter is deprecated: use internal/tableprinter - tp := utils.NewTablePrinter(a.io) - - if tp.IsTTY() { - tp.AddField("LABEL", nil, nil) - tp.AddField("PORT", nil, nil) - tp.AddField("VISIBILITY", nil, nil) - tp.AddField("BROWSE URL", nil, nil) - tp.EndRow() - } + tp := tableprinter.New(a.io, tableprinter.WithHeader("LABEL", "PORT", "VISIBILITY", "BROWSE URL")) for _, port := range portInfos { - tp.AddField(port.Label(), nil, nil) - tp.AddField(strconv.Itoa(port.SourcePort), nil, cs.Yellow) - tp.AddField(port.Privacy, nil, nil) - tp.AddField(port.BrowseURL(), nil, nil) + // Convert the ACE to a friendly visibility string (private, org, public) + visibility := portforwarder.AccessControlEntriesToVisibility(port.Port.AccessControl.Entries) + + tp.AddField(port.Label()) + tp.AddField(cs.Yellow(fmt.Sprintf("%d", port.Port.PortNumber))) + tp.AddField(visibility) + tp.AddField(port.BrowseURL()) tp.EndRow() } return tp.Render() } type portInfo struct { - *liveshare.Port + Port *tunnels.TunnelPort codespace *api.Codespace devContainer *devContainer } func (pi *portInfo) BrowseURL() string { - return fmt.Sprintf("https://%s-%d.preview.app.github.dev", pi.codespace.Name, pi.Port.SourcePort) + return fmt.Sprintf("https://%s-%d.app.github.dev", pi.codespace.Name, pi.Port.PortNumber) } func (pi *portInfo) Label() string { if pi.devContainer != nil { - portStr := strconv.Itoa(pi.Port.SourcePort) + portStr := strconv.Itoa(int(pi.Port.PortNumber)) if attributes, ok := pi.devContainer.PortAttributes[portStr]; ok { return attributes.Label } @@ -150,7 +145,6 @@ func (pi *portInfo) Label() string { var portFields = []string{ "sourcePort", - // "destinationPort", // TODO(mislav): this appears to always be blank? "visibility", "label", "browseUrl", @@ -162,11 +156,9 @@ func (pi *portInfo) ExportData(fields []string) map[string]interface{} { for _, f := range fields { switch f { case "sourcePort": - data[f] = pi.Port.SourcePort - case "destinationPort": - data[f] = pi.Port.DestinationPort + data[f] = pi.Port.PortNumber case "visibility": - data[f] = pi.Port.Privacy + data[f] = portforwarder.AccessControlEntriesToVisibility(pi.Port.AccessControl.Entries) case "label": data[f] = pi.Label() case "browseUrl": @@ -235,30 +227,6 @@ func newPortsVisibilityCmd(app *App, selector *CodespaceSelector) *cobra.Command } } -type ErrUpdatingPortVisibility struct { - port int - visibility string - err error -} - -func newErrUpdatingPortVisibility(port int, visibility string, err error) *ErrUpdatingPortVisibility { - return &ErrUpdatingPortVisibility{ - port: port, - visibility: visibility, - err: err, - } -} - -func (e *ErrUpdatingPortVisibility) Error() string { - return fmt.Sprintf("error waiting for port %d to update to %s: %s", e.port, e.visibility, e.err) -} - -func (e *ErrUpdatingPortVisibility) Unwrap() error { - return e.err -} - -var errUpdatePortVisibilityForbidden = errors.New("organization admin has forbidden this privacy setting") - func (a *App) UpdatePortVisibility(ctx context.Context, selector *CodespaceSelector, args []string) (err error) { ports, err := a.parsePortVisibilities(args) if err != nil { @@ -270,47 +238,29 @@ func (a *App) UpdatePortVisibility(ctx context.Context, selector *CodespaceSelec return err } - session, err := codespaces.ConnectToLiveshare(ctx, a, noopLogger(), a.apiClient, codespace) + codespaceConnection, err := codespaces.GetCodespaceConnection(ctx, a, a.apiClient, codespace) if err != nil { return fmt.Errorf("error connecting to codespace: %w", err) } - defer safeClose(session, &err) + + fwd, err := portforwarder.NewPortForwarder(ctx, codespaceConnection) + if err != nil { + return fmt.Errorf("failed to create port forwarder: %w", err) + } + defer safeClose(fwd, &err) // TODO: check if port visibility can be updated in parallel instead of sequentially for _, port := range ports { err := a.RunWithProgress(fmt.Sprintf("Updating port %d visibility to: %s", port.number, port.visibility), func() (err error) { // wait for success or failure - g, ctx := errgroup.WithContext(ctx) ctx, cancel := context.WithTimeout(ctx, 30*time.Second) defer cancel() - g.Go(func() error { - updateNotif, err := session.WaitForPortNotification(ctx, port.number, liveshare.PortChangeKindUpdate) - if err != nil { - return fmt.Errorf("error waiting for port %d to update: %w", port.number, err) - - } - if !updateNotif.Success { - if updateNotif.StatusCode == http.StatusForbidden { - return newErrUpdatingPortVisibility(port.number, port.visibility, errUpdatePortVisibilityForbidden) - } - return newErrUpdatingPortVisibility(port.number, port.visibility, errors.New(updateNotif.ErrorDetail)) - - } - return nil // success - }) - - g.Go(func() error { - err := session.UpdateSharedServerPrivacy(ctx, port.number, port.visibility) - if err != nil { - return fmt.Errorf("error updating port %d to %s: %w", port.number, port.visibility, err) - } - return nil - }) - - // wait for success or failure - err = g.Wait() - return + err = fwd.UpdatePortVisibility(ctx, port.number, port.visibility) + if err != nil { + return fmt.Errorf("error updating port %d to %s: %w", port.number, port.visibility, err) + } + return nil }) if err != nil { return err @@ -367,11 +317,10 @@ func (a *App) ForwardPorts(ctx context.Context, selector *CodespaceSelector, por return err } - session, err := codespaces.ConnectToLiveshare(ctx, a, noopLogger(), a.apiClient, codespace) + codespaceConnection, err := codespaces.GetCodespaceConnection(ctx, a, a.apiClient, codespace) if err != nil { return fmt.Errorf("error connecting to codespace: %w", err) } - defer safeClose(session, &err) // Run forwarding of all ports concurrently, aborting all of // them at the first failure, including cancellation of the context. @@ -386,9 +335,16 @@ func (a *App) ForwardPorts(ctx context.Context, selector *CodespaceSelector, por defer listen.Close() a.errLogger.Printf("Forwarding ports: remote %d <=> local %d", pair.remote, pair.local) - name := fmt.Sprintf("share-%d", pair.remote) - fwd := liveshare.NewPortForwarder(session, name, pair.remote, false) - return fwd.ForwardToListener(ctx, listen) // error always non-nil + fwd, err := portforwarder.NewPortForwarder(ctx, codespaceConnection) + if err != nil { + return fmt.Errorf("failed to create port forwarder: %w", err) + } + defer safeClose(fwd, &err) + + opts := portforwarder.ForwardPortOpts{ + Port: pair.remote, + } + return fwd.ForwardPortToListener(ctx, opts, listen) }) } return group.Wait() // first error diff --git a/pkg/cmd/codespace/ports_test.go b/pkg/cmd/codespace/ports_test.go index bb7554238..034c15eb6 100644 --- a/pkg/cmd/codespace/ports_test.go +++ b/pkg/cmd/codespace/ports_test.go @@ -2,18 +2,34 @@ package codespace import ( "context" - "errors" "fmt" - "os" + "net/http" "testing" "github.com/cli/cli/v2/internal/codespaces/api" + "github.com/cli/cli/v2/internal/codespaces/connection" "github.com/cli/cli/v2/pkg/iostreams" - "github.com/cli/cli/v2/pkg/liveshare" - livesharetest "github.com/cli/cli/v2/pkg/liveshare/test" - "github.com/sourcegraph/jsonrpc2" ) +func TestListPorts(t *testing.T) { + ctx, cancel := context.WithCancel(context.Background()) + defer cancel() + + mockApi := GetMockApi(false) + ios, _, _, _ := iostreams.Test() + + a := &App{ + io: ios, + apiClient: mockApi, + } + + selector := &CodespaceSelector{api: a.apiClient, codespaceName: "codespace-name"} + err := a.ListPorts(ctx, selector, nil) + if err != nil { + t.Errorf("unexpected error: %v", err) + } +} + func TestPortsUpdateVisibilitySuccess(t *testing.T) { portVisibilities := []portVisibility{ { @@ -26,175 +42,35 @@ func TestPortsUpdateVisibilitySuccess(t *testing.T) { }, } - eventResponses := []string{ - "serverSharing.sharingSucceeded", - "serverSharing.sharingSucceeded", - } - - portsData := []liveshare.PortNotification{ - { - Success: true, - Port: 80, - ChangeKind: liveshare.PortChangeKindUpdate, - }, - { - Success: true, - Port: 9999, - ChangeKind: liveshare.PortChangeKindUpdate, - }, - } - - err := runUpdateVisibilityTest(t, portVisibilities, eventResponses, portsData) - + err := runUpdateVisibilityTest(t, portVisibilities, true) if err != nil { t.Errorf("unexpected error: %v", err) } } -func TestPortsUpdateVisibilityFailure403(t *testing.T) { - portVisibilities := []portVisibility{ - { - number: 80, - visibility: "org", - }, - { - number: 9999, - visibility: "public", - }, - } - - eventResponses := []string{ - "serverSharing.sharingSucceeded", - "serverSharing.sharingFailed", - } - - portsData := []liveshare.PortNotification{ - { - Success: true, - Port: 80, - ChangeKind: liveshare.PortChangeKindUpdate, - }, - { - Success: false, - Port: 9999, - ChangeKind: liveshare.PortChangeKindUpdate, - ErrorDetail: "test error", - StatusCode: 403, - }, - } - - err := runUpdateVisibilityTest(t, portVisibilities, eventResponses, portsData) - if err == nil { - t.Fatalf("runUpdateVisibilityTest succeeded unexpectedly") - } - - if errors.Unwrap(err) != errUpdatePortVisibilityForbidden { - t.Errorf("expected: %v, got: %v", errUpdatePortVisibilityForbidden, errors.Unwrap(err)) - } -} - func TestPortsUpdateVisibilityFailure(t *testing.T) { portVisibilities := []portVisibility{ - { - number: 80, - visibility: "org", - }, { number: 9999, visibility: "public", }, - } - - eventResponses := []string{ - "serverSharing.sharingSucceeded", - "serverSharing.sharingFailed", - } - - portsData := []liveshare.PortNotification{ { - Success: true, - Port: 80, - ChangeKind: liveshare.PortChangeKindUpdate, - }, - { - Success: false, - Port: 9999, - ChangeKind: liveshare.PortChangeKindUpdate, - ErrorDetail: "test error", + number: 80, + visibility: "org", }, } - err := runUpdateVisibilityTest(t, portVisibilities, eventResponses, portsData) + err := runUpdateVisibilityTest(t, portVisibilities, false) if err == nil { t.Fatalf("runUpdateVisibilityTest succeeded unexpectedly") } - - var expectedErr *ErrUpdatingPortVisibility - if !errors.As(err, &expectedErr) { - t.Errorf("expected: %v, got: %v", expectedErr, err) - } } -type joinWorkspaceResult struct { - SessionNumber int `json:"sessionNumber"` -} - -func runUpdateVisibilityTest(t *testing.T, portVisibilities []portVisibility, eventResponses []string, portsData []liveshare.PortNotification) error { - t.Helper() - if os.Getenv("GITHUB_ACTIONS") == "true" { - t.Skip("fails intermittently in CI: https://github.com/cli/cli/issues/5663") - } - - joinWorkspace := func(conn *jsonrpc2.Conn, req *jsonrpc2.Request) (interface{}, error) { - return joinWorkspaceResult{1}, nil - } - const sessionToken = "session-token" - - ch := make(chan *jsonrpc2.Conn, 1) - updateSharedVisibility := func(conn *jsonrpc2.Conn, rpcReq *jsonrpc2.Request) (interface{}, error) { - ch <- conn - return nil, nil - } - testServer, err := livesharetest.NewServer( - livesharetest.WithNonSecure(), - livesharetest.WithPassword(sessionToken), - livesharetest.WithService("workspace.joinWorkspace", joinWorkspace), - livesharetest.WithService("serverSharing.updateSharedServerPrivacy", updateSharedVisibility), - ) - if err != nil { - return fmt.Errorf("unable to create test server: %w", err) - } - +func runUpdateVisibilityTest(t *testing.T, portVisibilities []portVisibility, allowOrgPorts bool) error { ctx, cancel := context.WithCancel(context.Background()) defer cancel() - go func() { - for i, pd := range portsData { - select { - case <-ctx.Done(): - return - case conn := <-ch: - _, _ = conn.DispatchCall(ctx, eventResponses[i], pd, nil) - } - } - }() - - mockApi := &apiClientMock{ - GetCodespaceFunc: func(ctx context.Context, codespaceName string, includeConnection bool) (*api.Codespace, error) { - return &api.Codespace{ - Name: "codespace-name", - State: api.CodespaceStateAvailable, - Connection: api.CodespaceConnection{ - SessionID: "session-id", - SessionToken: sessionToken, - RelayEndpoint: testServer.URL(), - RelaySAS: "relay-sas", - HostPublicKeys: []string{livesharetest.SSHPublicKey}, - }, - }, nil - }, - } - + mockApi := GetMockApi(allowOrgPorts) ios, _, _, _ := iostreams.Test() a := &App{ @@ -251,6 +127,44 @@ func TestPendingOperationDisallowsForwardPorts(t *testing.T) { } } +func GetMockApi(allowOrgPorts bool) *apiClientMock { + return &apiClientMock{ + GetCodespaceFunc: func(ctx context.Context, codespaceName string, includeConnection bool) (*api.Codespace, error) { + allowedPortPrivacySettings := []string{"public", "private"} + if allowOrgPorts { + allowedPortPrivacySettings = append(allowedPortPrivacySettings, "org") + } + + return &api.Codespace{ + Name: "codespace-name", + State: api.CodespaceStateAvailable, + Connection: api.CodespaceConnection{ + TunnelProperties: api.TunnelProperties{ + ConnectAccessToken: "tunnel access-token", + ManagePortsAccessToken: "manage-ports-token", + ServiceUri: "http://global.rel.tunnels.api.visualstudio.com/", + TunnelId: "tunnel-id", + ClusterId: "usw2", + Domain: "domain.com", + }, + }, + RuntimeConstraints: api.RuntimeConstraints{ + AllowedPortPrivacySettings: allowedPortPrivacySettings, + }, + }, nil + }, + StartCodespaceFunc: func(ctx context.Context, codespaceName string) error { + return nil + }, + GetCodespaceRepositoryContentsFunc: func(ctx context.Context, codespace *api.Codespace, path string) ([]byte, error) { + return nil, nil + }, + HTTPClientFunc: func() (*http.Client, error) { + return connection.NewMockHttpClient() + }, + } +} + func testingPortsApp() *App { disabledCodespace := &api.Codespace{ Name: "disabledCodespace", diff --git a/pkg/cmd/codespace/rebuild.go b/pkg/cmd/codespace/rebuild.go index 17e00670b..93d43bf29 100644 --- a/pkg/cmd/codespace/rebuild.go +++ b/pkg/cmd/codespace/rebuild.go @@ -4,7 +4,9 @@ import ( "context" "fmt" + "github.com/cli/cli/v2/internal/codespaces" "github.com/cli/cli/v2/internal/codespaces/api" + "github.com/cli/cli/v2/internal/codespaces/portforwarder" "github.com/cli/cli/v2/internal/codespaces/rpc" "github.com/spf13/cobra" ) @@ -49,13 +51,18 @@ func (a *App) Rebuild(ctx context.Context, selector *CodespaceSelector, full boo return nil } - session, err := startLiveShareSession(ctx, codespace, a, false, "") + codespaceConnection, err := codespaces.GetCodespaceConnection(ctx, a, a.apiClient, codespace) if err != nil { - return fmt.Errorf("starting Live Share session: %w", err) + return fmt.Errorf("error connecting to codespace: %w", err) } - defer safeClose(session, &err) - invoker, err := rpc.CreateInvoker(ctx, session) + fwd, err := portforwarder.NewPortForwarder(ctx, codespaceConnection) + if err != nil { + return fmt.Errorf("failed to create port forwarder: %w", err) + } + defer safeClose(fwd, &err) + + invoker, err := rpc.CreateInvoker(ctx, fwd) if err != nil { return err } diff --git a/pkg/cmd/codespace/ssh.go b/pkg/cmd/codespace/ssh.go index 40eebcc63..571f74267 100644 --- a/pkg/cmd/codespace/ssh.go +++ b/pkg/cmd/codespace/ssh.go @@ -6,7 +6,7 @@ import ( "context" "errors" "fmt" - "log" + "io" "os" "os/exec" "path" @@ -18,10 +18,10 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/internal/codespaces" "github.com/cli/cli/v2/internal/codespaces/api" + "github.com/cli/cli/v2/internal/codespaces/portforwarder" "github.com/cli/cli/v2/internal/codespaces/rpc" "github.com/cli/cli/v2/internal/config" "github.com/cli/cli/v2/pkg/cmdutil" - "github.com/cli/cli/v2/pkg/liveshare" "github.com/cli/cli/v2/pkg/ssh" "github.com/cli/safeexec" "github.com/spf13/cobra" @@ -53,39 +53,39 @@ func newSSHCmd(app *App) *cobra.Command { sshCmd := &cobra.Command{ Use: "ssh [...] [-- ...] []", Short: "SSH into a codespace", - Long: heredoc.Doc(` - The 'ssh' command is used to SSH into a codespace. In its simplest form, you can - run 'gh cs ssh', select a codespace interactively, and connect. + Long: heredoc.Docf(` + The %[1]sssh%[1]s command is used to SSH into a codespace. In its simplest form, you can + run %[1]sgh cs ssh%[1]s, select a codespace interactively, and connect. - The 'ssh' command will automatically create a public/private ssh key pair in the - ~/.ssh directory if you do not have an existing valid key pair. When selecting the + The %[1]sssh%[1]s command will automatically create a public/private ssh key pair in the + %[1]s~/.ssh%[1]s directory if you do not have an existing valid key pair. When selecting the key pair to use, the preferred order is: - 1. Key specified by -i in + 1. Key specified by %[1]s-i%[1]s in %[1]s%[1]s 2. Automatic key, if it already exists - 3. First valid key pair in ssh config (according to ssh -G) + 3. First valid key pair in ssh config (according to %[1]sssh -G%[1]s) 4. Automatic key, newly created - The 'ssh' command also supports deeper integration with OpenSSH using a '--config' + The %[1]sssh%[1]s command also supports deeper integration with OpenSSH using a %[1]s--config%[1]s option that generates per-codespace ssh configuration in OpenSSH format. - Including this configuration in your ~/.ssh/config improves the user experience - of tools that integrate with OpenSSH, such as bash/zsh completion of ssh hostnames, - remote path completion for scp/rsync/sshfs, git ssh remotes, and so on. + Including this configuration in your %[1]s~/.ssh/config%[1]s improves the user experience + of tools that integrate with OpenSSH, such as Bash/Zsh completion of ssh hostnames, + remote path completion for %[1]sscp/rsync/sshfs%[1]s, %[1]sgit%[1]s ssh remotes, and so on. Once that is set up (see the second example below), you can ssh to codespaces as - if they were ordinary remote hosts (using 'ssh', not 'gh cs ssh'). + if they were ordinary remote hosts (using %[1]sssh%[1]s, not %[1]sgh cs ssh%[1]s). Note that the codespace you are connecting to must have an SSH server pre-installed. If the docker image being used for the codespace does not have an SSH server, - install it in your Dockerfile or, for codespaces that use Debian-based images, - you can add the following to your devcontainer.json: + install it in your %[1]sDockerfile%[1]s or, for codespaces that use Debian-based images, + you can add the following to your %[1]sdevcontainer.json%[1]s: - "features": { - "ghcr.io/devcontainers/features/sshd:1": { - "version": "latest" + "features": { + "ghcr.io/devcontainers/features/sshd:1": { + "version": "latest" + } } - } - `), + `, "`"), Example: heredoc.Doc(` $ gh codespace ssh @@ -144,6 +144,24 @@ func newSSHCmd(app *App) *cobra.Command { return sshCmd } +type combinedReadWriteHalfCloser struct { + io.ReadCloser + io.WriteCloser +} + +func (crwc *combinedReadWriteHalfCloser) Close() error { + werr := crwc.WriteCloser.Close() + rerr := crwc.ReadCloser.Close() + if werr != nil { + return werr + } + return rerr +} + +func (crwc *combinedReadWriteHalfCloser) CloseWrite() error { + return crwc.WriteCloser.Close() +} + // SSH opens an ssh session or runs an ssh command in a codespace. func (a *App) SSH(ctx context.Context, sshArgs []string, opts sshOptions) (err error) { // Ensure all child tasks (e.g. port forwarding) terminate before return. @@ -175,11 +193,16 @@ func (a *App) SSH(ctx context.Context, sshArgs []string, opts sshOptions) (err e return err } - session, err := startLiveShareSession(ctx, codespace, a, opts.debug, opts.debugFile) + codespaceConnection, err := codespaces.GetCodespaceConnection(ctx, a, a.apiClient, codespace) if err != nil { - return err + return fmt.Errorf("error connecting to codespace: %w", err) } - defer safeClose(session, &err) + + fwd, err := portforwarder.NewPortForwarder(ctx, codespaceConnection) + if err != nil { + return fmt.Errorf("failed to create port forwarder: %w", err) + } + defer safeClose(fwd, &err) var ( invoker rpc.Invoker @@ -187,7 +210,7 @@ func (a *App) SSH(ctx context.Context, sshArgs []string, opts sshOptions) (err e sshUser string ) err = a.RunWithProgress("Fetching SSH Details", func() (err error) { - invoker, err = rpc.CreateInvoker(ctx, session) + invoker, err = rpc.CreateInvoker(ctx, fwd) if err != nil { return } @@ -203,9 +226,25 @@ func (a *App) SSH(ctx context.Context, sshArgs []string, opts sshOptions) (err e } if opts.stdio { - fwd := liveshare.NewPortForwarder(session, "sshd", remoteSSHServerPort, true) - stdio := liveshare.NewReadWriteHalfCloser(os.Stdin, os.Stdout) - err := fwd.Forward(ctx, stdio) // always non-nil + stdio := &combinedReadWriteHalfCloser{os.Stdin, os.Stdout} + opts := portforwarder.ForwardPortOpts{ + Port: remoteSSHServerPort, + Internal: true, + KeepAlive: true, + } + + // Forward the port + err = fwd.ForwardPort(ctx, opts) + if err != nil { + return fmt.Errorf("failed to forward port: %w", err) + } + + // Connect to the forwarded port + err = fwd.ConnectToForwardedPort(ctx, stdio, opts) + if err != nil { + return fmt.Errorf("failed to connect to forwarded port: %w", err) + } + return fmt.Errorf("tunnel closed: %w", err) } @@ -227,22 +266,38 @@ func (a *App) SSH(ctx context.Context, sshArgs []string, opts sshOptions) (err e tunnelClosed := make(chan error, 1) go func() { - fwd := liveshare.NewPortForwarder(session, "sshd", remoteSSHServerPort, true) - tunnelClosed <- fwd.ForwardToListener(ctx, listen) // always non-nil + opts := portforwarder.ForwardPortOpts{ + Port: remoteSSHServerPort, + Internal: true, + KeepAlive: true, + } + tunnelClosed <- fwd.ForwardPortToListener(ctx, opts, listen) }() shellClosed := make(chan error, 1) go func() { - var err error if opts.scpArgs != nil { // args is the correct variable to use here, we just use scpArgs as the check for which command to run - err = codespaces.Copy(ctx, args, localSSHServerPort, connectDestination) + shellClosed <- codespaces.Copy(ctx, args, localSSHServerPort, connectDestination) } else { - err = codespaces.Shell( - ctx, a.errLogger, args, localSSHServerPort, connectDestination, opts.printConnDetails, + // Parse the ssh args to determine if the user specified a command + args, command, err := codespaces.ParseSSHArgs(args) + if err != nil { + shellClosed <- err + return + } + + // If the user specified a command, we need to keep the shell alive + // since it will be non-interactive and the codespace might shut down + // before the command finishes + if command != nil { + invoker.KeepAlive() + } + + shellClosed <- codespaces.Shell( + ctx, a.errLogger, args, command, localSSHServerPort, connectDestination, opts.printConnDetails, ) } - shellClosed <- err }() select { @@ -526,27 +581,37 @@ func (a *App) printOpenSSHConfig(ctx context.Context, opts sshOptions) (err erro result := sshResult{} defer wg.Done() - session, err := codespaces.ConnectToLiveshare(ctx, a, noopLogger(), a.apiClient, cs) + codespaceConnection, err := codespaces.GetCodespaceConnection(ctx, a, a.apiClient, cs) if err != nil { result.err = fmt.Errorf("error connecting to codespace: %w", err) - } else { - defer safeClose(session, &err) - - invoker, err := rpc.CreateInvoker(ctx, session) - if err != nil { - result.err = fmt.Errorf("error connecting to codespace: %w", err) - } else { - defer safeClose(invoker, &err) - - _, result.user, err = invoker.StartSSHServer(ctx) - if err != nil { - result.err = fmt.Errorf("error getting ssh server details: %w", err) - } else { - result.codespace = cs - } - } + sshUsers <- result + return } + fwd, err := portforwarder.NewPortForwarder(ctx, codespaceConnection) + if err != nil { + result.err = fmt.Errorf("failed to create port forwarder: %w", err) + sshUsers <- result + return + } + defer safeClose(fwd, &err) + + invoker, err := rpc.CreateInvoker(ctx, fwd) + if err != nil { + result.err = fmt.Errorf("error connecting to codespace: %w", err) + sshUsers <- result + return + } + defer safeClose(invoker, &err) + + _, result.user, err = invoker.StartSSHServer(ctx) + if err != nil { + result.err = fmt.Errorf("error getting ssh server details: %w", err) + sshUsers <- result + return + } + + result.codespace = cs sshUsers <- result }() } @@ -640,7 +705,7 @@ func newCpCmd(app *App) *cobra.Command { Use: "cp [-e] [-r] [-- [...]] ... ", Short: "Copy files between local and remote file systems", Long: heredoc.Docf(` - The cp command copies files between the local and remote file systems. + The %[1]scp%[1]s command copies files between the local and remote file systems. As with the UNIX %[1]scp%[1]s command, the first argument specifies the source and the last specifies the destination; additional sources may be specified after the first, @@ -648,7 +713,7 @@ func newCpCmd(app *App) *cobra.Command { The %[1]s--recursive%[1]s flag is required if any source is a directory. - A "remote:" prefix on any file name argument indicates that it refers to + A %[1]sremote:%[1]s prefix on any file name argument indicates that it refers to the file system of the remote (Codespace) machine. It is resolved relative to the home directory of the remote user. @@ -658,8 +723,8 @@ func newCpCmd(app *App) *cobra.Command { environment variables, and backticks. For security, do not use this flag with arguments provided by untrusted users; see for discussion. - By default, the 'cp' command will create a public/private ssh key pair to authenticate with - the codespace inside the ~/.ssh directory. + By default, the %[1]scp%[1]s command will create a public/private ssh key pair to authenticate with + the codespace inside the %[1]s~/.ssh directory%[1]s. `, "`"), Example: heredoc.Doc(` $ gh codespace cp -e README.md 'remote:/workspaces/$RepositoryName/' @@ -722,43 +787,3 @@ func (a *App) Copy(ctx context.Context, args []string, opts cpOptions) error { } return a.SSH(ctx, nil, opts.sshOptions) } - -// fileLogger is a wrapper around an log.Logger configured to write -// to a file. It exports two additional methods to get the log file name -// and close the file handle when the operation is finished. -type fileLogger struct { - *log.Logger - - f *os.File -} - -// newFileLogger creates a new fileLogger. It returns an error if the file -// cannot be created. The file is created on the specified path, if the path -// is empty it is created in the temporary directory. -func newFileLogger(file string) (fl *fileLogger, err error) { - var f *os.File - if file == "" { - f, err = os.CreateTemp("", "") - if err != nil { - return nil, fmt.Errorf("failed to create tmp file: %w", err) - } - } else { - f, err = os.Create(file) - if err != nil { - return nil, err - } - } - - return &fileLogger{ - Logger: log.New(f, "", log.LstdFlags), - f: f, - }, nil -} - -func (fl *fileLogger) Name() string { - return fl.f.Name() -} - -func (fl *fileLogger) Close() error { - return fl.f.Close() -} diff --git a/pkg/cmd/codespace/view.go b/pkg/cmd/codespace/view.go index 7fe4ae313..e212f0820 100644 --- a/pkg/cmd/codespace/view.go +++ b/pkg/cmd/codespace/view.go @@ -73,7 +73,8 @@ func (a *App) ViewCodespace(ctx context.Context, opts *viewOptions) error { return opts.exporter.Write(a.io, selectedCodespace) } - tp := tableprinter.New(a.io) + //nolint:staticcheck // SA1019: Showing NAME|VALUE headers adds nothing to table. + tp := tableprinter.New(a.io, tableprinter.NoHeader) c := codespace{selectedCodespace} formattedName := formatNameForVSCSTarget(c.Name, c.VSCSTarget) diff --git a/pkg/cmd/config/config.go b/pkg/cmd/config/config.go index cf374ec1f..2661c3369 100644 --- a/pkg/cmd/config/config.go +++ b/pkg/cmd/config/config.go @@ -17,10 +17,13 @@ func NewCmdConfig(f *cmdutil.Factory) *cobra.Command { longDoc := strings.Builder{} longDoc.WriteString("Display or change configuration settings for gh.\n\n") longDoc.WriteString("Current respected settings:\n") - for _, co := range config.ConfigOptions() { - longDoc.WriteString(fmt.Sprintf("- %s: %s", co.Key, co.Description)) + for _, co := range config.Options { + longDoc.WriteString(fmt.Sprintf("- `%s`: %s", co.Key, co.Description)) + if len(co.AllowedValues) > 0 { + longDoc.WriteString(fmt.Sprintf(" {%s}", strings.Join(co.AllowedValues, "|"))) + } if co.DefaultValue != "" { - longDoc.WriteString(fmt.Sprintf(" (default: %q)", co.DefaultValue)) + longDoc.WriteString(fmt.Sprintf(" (default %s)", co.DefaultValue)) } longDoc.WriteRune('\n') } diff --git a/pkg/cmd/config/get/get.go b/pkg/cmd/config/get/get.go index f391decc4..bec22a979 100644 --- a/pkg/cmd/config/get/get.go +++ b/pkg/cmd/config/get/get.go @@ -5,7 +5,7 @@ import ( "fmt" "github.com/MakeNowJust/heredoc" - "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" "github.com/spf13/cobra" @@ -13,7 +13,7 @@ import ( type GetOptions struct { IO *iostreams.IOStreams - Config config.Config + Config gh.Config Hostname string Key string @@ -56,7 +56,7 @@ func NewCmdConfigGet(f *cmdutil.Factory, runF func(*GetOptions) error) *cobra.Co func getRun(opts *GetOptions) error { // search keyring storage when fetching the `oauth_token` value if opts.Hostname != "" && opts.Key == "oauth_token" { - token, _ := opts.Config.Authentication().Token(opts.Hostname) + token, _ := opts.Config.Authentication().ActiveToken(opts.Hostname) if token == "" { return errors.New(`could not find key "oauth_token"`) } @@ -64,13 +64,22 @@ func getRun(opts *GetOptions) error { return nil } - val, err := opts.Config.GetOrDefault(opts.Hostname, opts.Key) - if err != nil { - return err + optionalEntry := opts.Config.GetOrDefault(opts.Hostname, opts.Key) + if optionalEntry.IsNone() { + return nonExistentKeyError{key: opts.Key} } + val := optionalEntry.Unwrap().Value if val != "" { fmt.Fprintf(opts.IO.Out, "%s\n", val) } return nil } + +type nonExistentKeyError struct { + key string +} + +func (e nonExistentKeyError) Error() string { + return fmt.Sprintf("could not find key \"%s\"", e.key) +} diff --git a/pkg/cmd/config/get/get_test.go b/pkg/cmd/config/get/get_test.go index baebb584a..6320ffa16 100644 --- a/pkg/cmd/config/get/get_test.go +++ b/pkg/cmd/config/get/get_test.go @@ -5,10 +5,12 @@ import ( "testing" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" "github.com/google/shlex" "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" ) func TestNewCmdConfigGet(t *testing.T) { @@ -41,7 +43,7 @@ func TestNewCmdConfigGet(t *testing.T) { for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { f := &cmdutil.Factory{ - Config: func() (config.Config, error) { + Config: func() (gh.Config, error) { return config.NewBlankConfig(), nil }, } @@ -76,17 +78,16 @@ func TestNewCmdConfigGet(t *testing.T) { func Test_getRun(t *testing.T) { tests := []struct { - name string - input *GetOptions - stdout string - stderr string - wantErr bool + name string + input *GetOptions + stdout string + err error }{ { name: "get key", input: &GetOptions{ Key: "editor", - Config: func() config.Config { + Config: func() gh.Config { cfg := config.NewBlankConfig() cfg.Set("", "editor", "ed") return cfg @@ -99,7 +100,7 @@ func Test_getRun(t *testing.T) { input: &GetOptions{ Hostname: "github.com", Key: "editor", - Config: func() config.Config { + Config: func() gh.Config { cfg := config.NewBlankConfig() cfg.Set("", "editor", "ed") cfg.Set("github.com", "editor", "vim") @@ -108,17 +109,24 @@ func Test_getRun(t *testing.T) { }, stdout: "vim\n", }, + { + name: "non-existent key", + input: &GetOptions{ + Key: "non-existent", + Config: config.NewBlankConfig(), + }, + err: nonExistentKeyError{key: "non-existent"}, + }, } for _, tt := range tests { - ios, _, stdout, stderr := iostreams.Test() + ios, _, stdout, _ := iostreams.Test() tt.input.IO = ios t.Run(tt.name, func(t *testing.T) { err := getRun(tt.input) - assert.NoError(t, err) - assert.Equal(t, tt.stdout, stdout.String()) - assert.Equal(t, tt.stderr, stderr.String()) + require.Equal(t, err, tt.err) + require.Equal(t, tt.stdout, stdout.String()) }) } } diff --git a/pkg/cmd/config/list/list.go b/pkg/cmd/config/list/list.go index 2faed3f15..1cfb92c87 100644 --- a/pkg/cmd/config/list/list.go +++ b/pkg/cmd/config/list/list.go @@ -4,6 +4,7 @@ import ( "fmt" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" "github.com/spf13/cobra" @@ -11,7 +12,7 @@ import ( type ListOptions struct { IO *iostreams.IOStreams - Config func() (config.Config, error) + Config func() (gh.Config, error) Hostname string } @@ -54,14 +55,8 @@ func listRun(opts *ListOptions) error { host, _ = cfg.Authentication().DefaultHost() } - configOptions := config.ConfigOptions() - - for _, key := range configOptions { - val, err := cfg.GetOrDefault(host, key.Key) - if err != nil { - return err - } - fmt.Fprintf(opts.IO.Out, "%s=%s\n", key.Key, val) + for _, option := range config.Options { + fmt.Fprintf(opts.IO.Out, "%s=%s\n", option.Key, option.CurrentValue(cfg, host)) } return nil diff --git a/pkg/cmd/config/list/list_test.go b/pkg/cmd/config/list/list_test.go index 945979414..b6a9d0fca 100644 --- a/pkg/cmd/config/list/list_test.go +++ b/pkg/cmd/config/list/list_test.go @@ -5,10 +5,12 @@ import ( "testing" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" "github.com/google/shlex" "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" ) func TestNewCmdConfigList(t *testing.T) { @@ -35,7 +37,7 @@ func TestNewCmdConfigList(t *testing.T) { for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { f := &cmdutil.Factory{ - Config: func() (config.Config, error) { + Config: func() (gh.Config, error) { return config.NewBlankConfig(), nil }, } @@ -71,13 +73,13 @@ func Test_listRun(t *testing.T) { tests := []struct { name string input *ListOptions - config config.Config + config gh.Config stdout string wantErr bool }{ { name: "list", - config: func() config.Config { + config: func() gh.Config { cfg := config.NewBlankConfig() cfg.Set("HOST", "git_protocol", "ssh") cfg.Set("HOST", "editor", "/usr/bin/vim") @@ -101,15 +103,14 @@ browser=brave for _, tt := range tests { ios, _, stdout, _ := iostreams.Test() tt.input.IO = ios - tt.input.Config = func() (config.Config, error) { + tt.input.Config = func() (gh.Config, error) { return tt.config, nil } t.Run(tt.name, func(t *testing.T) { err := listRun(tt.input) - assert.NoError(t, err) - assert.Equal(t, tt.stdout, stdout.String()) - //assert.Equal(t, tt.stderr, stderr.String()) + require.NoError(t, err) + require.Equal(t, tt.stdout, stdout.String()) }) } } diff --git a/pkg/cmd/config/set/set.go b/pkg/cmd/config/set/set.go index e99bfb17c..a1fb2bbe9 100644 --- a/pkg/cmd/config/set/set.go +++ b/pkg/cmd/config/set/set.go @@ -7,6 +7,7 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" "github.com/spf13/cobra" @@ -14,7 +15,7 @@ import ( type SetOptions struct { IO *iostreams.IOStreams - Config config.Config + Config gh.Config Key string Value string @@ -87,7 +88,7 @@ func setRun(opts *SetOptions) error { } func ValidateKey(key string) error { - for _, configKey := range config.ConfigOptions() { + for _, configKey := range config.Options { if key == configKey.Key { return nil } @@ -107,7 +108,7 @@ func (e InvalidValueError) Error() string { func ValidateValue(key, value string) error { var validValues []string - for _, v := range config.ConfigOptions() { + for _, v := range config.Options { if v.Key == key { validValues = v.AllowedValues break diff --git a/pkg/cmd/config/set/set_test.go b/pkg/cmd/config/set/set_test.go index 2e26fd044..adfb7ba74 100644 --- a/pkg/cmd/config/set/set_test.go +++ b/pkg/cmd/config/set/set_test.go @@ -5,6 +5,7 @@ import ( "testing" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" "github.com/google/shlex" @@ -49,7 +50,7 @@ func TestNewCmdConfigSet(t *testing.T) { _ = config.StubWriteConfig(t) f := &cmdutil.Factory{ - Config: func() (config.Config, error) { + Config: func() (gh.Config, error) { return config.NewBlankConfig(), nil }, } @@ -149,9 +150,10 @@ func Test_setRun(t *testing.T) { assert.Equal(t, tt.stdout, stdout.String()) assert.Equal(t, tt.stderr, stderr.String()) - val, err := tt.input.Config.GetOrDefault(tt.input.Hostname, tt.input.Key) - assert.NoError(t, err) - assert.Equal(t, tt.expectedValue, val) + optionalEntry := tt.input.Config.GetOrDefault(tt.input.Hostname, tt.input.Key) + entry := optionalEntry.Expect("expected a value to be set") + assert.Equal(t, tt.expectedValue, entry.Value) + assert.Equal(t, gh.ConfigUserProvided, entry.Source) }) } } diff --git a/pkg/cmd/extension/browse/browse.go b/pkg/cmd/extension/browse/browse.go index 47b3ea8b2..21d254956 100644 --- a/pkg/cmd/extension/browse/browse.go +++ b/pkg/cmd/extension/browse/browse.go @@ -13,7 +13,7 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/charmbracelet/glamour" "github.com/cli/cli/v2/git" - "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/pkg/extensions" "github.com/cli/cli/v2/pkg/iostreams" @@ -33,7 +33,7 @@ type ExtBrowseOpts struct { Em extensions.ExtensionManager Client *http.Client Logger *log.Logger - Cfg config.Config + Cfg gh.Config Rg *readmeGetter Debug bool SingleColumn bool diff --git a/pkg/cmd/extension/browse/browse_test.go b/pkg/cmd/extension/browse/browse_test.go index 3c4ae87ca..956ea0fc4 100644 --- a/pkg/cmd/extension/browse/browse_test.go +++ b/pkg/cmd/extension/browse/browse_test.go @@ -11,6 +11,7 @@ import ( "time" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/pkg/cmd/repo/view" "github.com/cli/cli/v2/pkg/extensions" @@ -76,7 +77,7 @@ func Test_getExtensionRepos(t *testing.T) { } cfg := config.NewBlankConfig() - cfg.AuthenticationFunc = func() *config.AuthConfig { + cfg.AuthenticationFunc = func() gh.AuthConfig { authCfg := &config.AuthConfig{} authCfg.SetDefaultHost("github.com", "") return authCfg diff --git a/pkg/cmd/extension/command.go b/pkg/cmd/extension/command.go index 6629e599d..b3c7b0c9f 100644 --- a/pkg/cmd/extension/command.go +++ b/pkg/cmd/extension/command.go @@ -18,10 +18,11 @@ import ( "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/extensions" "github.com/cli/cli/v2/pkg/search" - "github.com/cli/cli/v2/utils" "github.com/spf13/cobra" ) +var alreadyInstalledError = errors.New("alreadyInstalledError") + func NewCmdExtension(f *cmdutil.Factory) *cobra.Command { m := f.ExtensionManager io := f.IOStreams @@ -37,19 +38,19 @@ func NewCmdExtension(f *cmdutil.Factory) *cobra.Command { Long: heredoc.Docf(` GitHub CLI extensions are repositories that provide additional gh commands. - The name of the extension repository must start with "gh-" and it must contain an + The name of the extension repository must start with %[1]sgh-%[1]s and it must contain an executable of the same name. All arguments passed to the %[1]sgh %[1]s invocation will be forwarded to the %[1]sgh-%[1]s executable of the extension. An extension cannot override any of the core gh commands. If an extension name conflicts - with a core gh command you can use %[1]sgh extension exec %[1]s. + with a core gh command, you can use %[1]sgh extension exec %[1]s. - See the list of available extensions at . + For the list of available extensions, see . `, "`"), Aliases: []string{"extensions", "ext"}, } - upgradeFunc := func(name string, flagForce, flagDryRun bool) error { + upgradeFunc := func(name string, flagForce bool) error { cs := io.ColorScheme() err := m.Upgrade(name, flagForce) if err != nil { @@ -62,17 +63,11 @@ func NewCmdExtension(f *cmdutil.Factory) *cobra.Command { } return cmdutil.SilentError } + if io.IsStdoutTTY() { - successStr := "Successfully" - if flagDryRun { - successStr = "Would have" - } - extensionStr := "extension" - if name == "" { - extensionStr = "extensions" - } - fmt.Fprintf(io.Out, "%s %s upgraded %s\n", cs.SuccessIcon(), successStr, extensionStr) + fmt.Fprintf(io.Out, "%s Successfully checked extension upgrades\n", cs.SuccessIcon()) } + return nil } @@ -92,36 +87,36 @@ func NewCmdExtension(f *cmdutil.Factory) *cobra.Command { cmd := &cobra.Command{ Use: "search []", Short: "Search extensions to the GitHub CLI", - Long: heredoc.Doc(` + Long: heredoc.Docf(` Search for gh extensions. With no arguments, this command prints out the first 30 extensions available to install sorted by number of stars. More extensions can - be fetched by specifying a higher limit with the --limit flag. + be fetched by specifying a higher limit with the %[1]s--limit%[1]s flag. When connected to a terminal, this command prints out three columns. The first has a ✓ if the extension is already installed locally. The - second is the full name of the extension repository in NAME/OWNER + second is the full name of the extension repository in %[1]sOWNER/REPO%[1]s format. The third is the extension's description. When not connected to a terminal, the ✓ character is rendered as the word "installed" but otherwise the order and content of the columns - is the same. + are the same. - This command behaves similarly to 'gh search repos' but does not + This command behaves similarly to %[1]sgh search repos%[1]s but does not support as many search qualifiers. For a finer grained search of extensions, try using: gh search repos --topic "gh-extension" - and adding qualifiers as needed. See 'gh help search repos' to learn + and adding qualifiers as needed. See %[1]sgh help search repos%[1]s to learn more about repository search. For listing just the extensions that are already installed locally, see: gh ext list - `), + `, "`"), Example: heredoc.Doc(` # List the first 30 extensions sorted by star count, descending $ gh ext search @@ -215,9 +210,7 @@ func NewCmdExtension(f *cmdutil.Factory) *cobra.Command { return false } - tp := tableprinter.New(io) - tp.HeaderRow("", "REPO", "DESCRIPTION") - + tp := tableprinter.New(io, tableprinter.WithHeader("", "REPO", "DESCRIPTION")) for _, repo := range result.Items { if !strings.HasPrefix(repo.Name, "gh-") { continue @@ -268,8 +261,7 @@ func NewCmdExtension(f *cmdutil.Factory) *cobra.Command { return cmdutil.NewNoResultsError("no installed extensions found") } cs := io.ColorScheme() - //nolint:staticcheck // SA1019: utils.NewTablePrinter is deprecated: use internal/tableprinter - t := utils.NewTablePrinter(io) + t := tableprinter.New(io, tableprinter.WithHeader("NAME", "REPO", "VERSION")) for _, c := range cmds { // TODO consider a Repo() on Extension interface var repo string @@ -279,13 +271,13 @@ func NewCmdExtension(f *cmdutil.Factory) *cobra.Command { } } - t.AddField(fmt.Sprintf("gh %s", c.Name()), nil, nil) - t.AddField(repo, nil, nil) + t.AddField(fmt.Sprintf("gh %s", c.Name())) + t.AddField(repo) version := displayExtensionVersion(c, c.CurrentVersion()) if c.IsPinned() { - t.AddField(version, nil, cs.Cyan) + t.AddField(version, tableprinter.WithColor(cs.Cyan)) } else { - t.AddField(version, nil, nil) + t.AddField(version) } t.EndRow() @@ -299,17 +291,17 @@ func NewCmdExtension(f *cmdutil.Factory) *cobra.Command { cmd := &cobra.Command{ Use: "install ", Short: "Install a gh extension from a repository", - Long: heredoc.Doc(` + Long: heredoc.Docf(` Install a GitHub repository locally as a GitHub CLI extension. - The repository argument can be specified in "owner/repo" format as well as a full URL. + The repository argument can be specified in %[1]sOWNER/REPO%[1]s format as well as a full URL. The URL format is useful when the repository is not hosted on github.com. - To install an extension in development from the current directory, use "." as the + To install an extension in development from the current directory, use %[1]s.%[1]s as the value of the repository argument. - See the list of available extensions at . - `), + For the list of available extensions, see . + `, "`"), Example: heredoc.Doc(` $ gh extension install owner/gh-extension $ gh extension install https://git.example.com/owner/gh-extension @@ -333,17 +325,27 @@ func NewCmdExtension(f *cmdutil.Factory) *cobra.Command { return err } - if ext, err := checkValidExtension(cmd.Root(), m, repo.RepoName()); err != nil { + cs := io.ColorScheme() + + if ext, err := checkValidExtension(cmd.Root(), m, repo.RepoName(), repo.RepoOwner()); err != nil { // If an existing extension was found and --force was specified, attempt to upgrade. if forceFlag && ext != nil { - return upgradeFunc(ext.Name(), forceFlag, false) + return upgradeFunc(ext.Name(), forceFlag) + } + + if errors.Is(err, alreadyInstalledError) { + fmt.Fprintf(io.ErrOut, "%s Extension %s is already installed\n", cs.WarningIcon(), ghrepo.FullName(repo)) + return nil } return err } - cs := io.ColorScheme() - if err := m.Install(repo, pinFlag); err != nil { + io.StartProgressIndicator() + err = m.Install(repo, pinFlag) + io.StopProgressIndicator() + + if err != nil { if errors.Is(err, releaseNotFoundErr) { return fmt.Errorf("%s Could not find a release of %s for %s", cs.FailureIcon(), args[0], cs.Cyan(pinFlag)) @@ -397,7 +399,7 @@ func NewCmdExtension(f *cmdutil.Factory) *cobra.Command { if flagDryRun { m.EnableDryRunMode() } - return upgradeFunc(name, flagForce, flagDryRun) + return upgradeFunc(name, flagForce) }, } cmd.Flags().BoolVar(&flagAll, "all", false, "Upgrade all extensions") @@ -427,17 +429,17 @@ func NewCmdExtension(f *cmdutil.Factory) *cobra.Command { cmd := &cobra.Command{ Use: "browse", Short: "Enter a UI for browsing, adding, and removing extensions", - Long: heredoc.Doc(` + Long: heredoc.Docf(` This command will take over your terminal and run a fully interactive interface for browsing, adding, and removing gh extensions. A terminal width greater than 100 columns is recommended. - To learn how to control this interface, press ? after running to see + To learn how to control this interface, press %[1]s?%[1]s after running to see the help text. - Press q to quit. + Press %[1]sq%[1]s to quit. - Running this command with --single-column should make this command + Running this command with %[1]s--single-column%[1]s should make this command more intelligible for users who rely on assistive technology like screen readers or high zoom. @@ -445,8 +447,8 @@ func NewCmdExtension(f *cmdutil.Factory) *cobra.Command { gh ext search - along with gh ext install, gh ext remove, and gh repo view. - `), + along with %[1]sgh ext install%[1]s, %[1]sgh ext remove%[1]s, and %[1]sgh repo view%[1]s. + `, "`"), Args: cobra.NoArgs, RunE: func(cmd *cobra.Command, args []string) error { if !io.CanPrompt() { @@ -488,14 +490,14 @@ func NewCmdExtension(f *cmdutil.Factory) *cobra.Command { &cobra.Command{ Use: "exec [args]", Short: "Execute an installed extension", - Long: heredoc.Doc(` + Long: heredoc.Docf(` Execute an extension using the short name. For example, if the extension repository is - "owner/gh-extension", you should pass "extension". You can use this command when + %[1]sowner/gh-extension%[1]s, you should pass %[1]sextension%[1]s. You can use this command when the short name conflicts with a core gh command. All arguments after the extension name will be forwarded to the executable of the extension. - `), + `, "`"), Example: heredoc.Doc(` # execute a label extension instead of the core gh label command $ gh extension exec label @@ -637,7 +639,7 @@ func NewCmdExtension(f *cmdutil.Factory) *cobra.Command { return &extCmd } -func checkValidExtension(rootCmd *cobra.Command, m extensions.ExtensionManager, extName string) (extensions.Extension, error) { +func checkValidExtension(rootCmd *cobra.Command, m extensions.ExtensionManager, extName, extOwner string) (extensions.Extension, error) { if !strings.HasPrefix(extName, "gh-") { return nil, errors.New("extension repository name must start with `gh-`") } @@ -649,6 +651,9 @@ func checkValidExtension(rootCmd *cobra.Command, m extensions.ExtensionManager, for _, ext := range m.List() { if ext.Name() == commandName { + if ext.Owner() == extOwner { + return ext, alreadyInstalledError + } return ext, fmt.Errorf("there is already an installed extension that provides the %q command", commandName) } } diff --git a/pkg/cmd/extension/command_test.go b/pkg/cmd/extension/command_test.go index fd693d7e5..fc9c414a3 100644 --- a/pkg/cmd/extension/command_test.go +++ b/pkg/cmd/extension/command_test.go @@ -13,6 +13,7 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/internal/browser" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/internal/prompter" "github.com/cli/cli/v2/pkg/cmdutil" @@ -239,7 +240,7 @@ func TestNewCmdExtension(t *testing.T) { args: []string{"install", "owner/gh-existing-ext"}, managerStubs: func(em *extensions.ExtensionManagerMock) func(*testing.T) { em.ListFunc = func() []extensions.Extension { - e := &Extension{path: "owner2/gh-existing-ext"} + e := &Extension{path: "owner2/gh-existing-ext", owner: "owner2"} return []extensions.Extension{e} } return func(t *testing.T) { @@ -250,6 +251,21 @@ func TestNewCmdExtension(t *testing.T) { wantErr: true, errMsg: "there is already an installed extension that provides the \"existing-ext\" command", }, + { + name: "install an already installed extension", + args: []string{"install", "owner/gh-existing-ext"}, + managerStubs: func(em *extensions.ExtensionManagerMock) func(*testing.T) { + em.ListFunc = func() []extensions.Extension { + e := &Extension{path: "owner/gh-existing-ext", owner: "owner"} + return []extensions.Extension{e} + } + return func(t *testing.T) { + calls := em.ListCalls() + assert.Equal(t, 1, len(calls)) + } + }, + wantStderr: "! Extension owner/gh-existing-ext is already installed\n", + }, { name: "install local extension", args: []string{"install", "."}, @@ -316,7 +332,7 @@ func TestNewCmdExtension(t *testing.T) { } }, isTTY: true, - wantStdout: "✓ Successfully upgraded extension\n", + wantStdout: "✓ Successfully checked extension upgrades\n", }, { name: "upgrade an extension dry run", @@ -336,7 +352,7 @@ func TestNewCmdExtension(t *testing.T) { } }, isTTY: true, - wantStdout: "✓ Would have upgraded extension\n", + wantStdout: "✓ Successfully checked extension upgrades\n", }, { name: "upgrade an extension notty", @@ -369,7 +385,7 @@ func TestNewCmdExtension(t *testing.T) { } }, isTTY: true, - wantStdout: "✓ Successfully upgraded extension\n", + wantStdout: "✓ Successfully checked extension upgrades\n", }, { name: "upgrade extension error", @@ -404,7 +420,7 @@ func TestNewCmdExtension(t *testing.T) { } }, isTTY: true, - wantStdout: "✓ Successfully upgraded extension\n", + wantStdout: "✓ Successfully checked extension upgrades\n", }, { name: "upgrade an extension full name", @@ -420,7 +436,7 @@ func TestNewCmdExtension(t *testing.T) { } }, isTTY: true, - wantStdout: "✓ Successfully upgraded extension\n", + wantStdout: "✓ Successfully checked extension upgrades\n", }, { name: "upgrade all", @@ -436,7 +452,7 @@ func TestNewCmdExtension(t *testing.T) { } }, isTTY: true, - wantStdout: "✓ Successfully upgraded extensions\n", + wantStdout: "✓ Successfully checked extension upgrades\n", }, { name: "upgrade all dry run", @@ -456,7 +472,7 @@ func TestNewCmdExtension(t *testing.T) { } }, isTTY: true, - wantStdout: "✓ Would have upgraded extensions\n", + wantStdout: "✓ Successfully checked extension upgrades\n", }, { name: "upgrade all none installed", @@ -817,7 +833,7 @@ func TestNewCmdExtension(t *testing.T) { managerStubs: func(em *extensions.ExtensionManagerMock) func(*testing.T) { em.ListFunc = func() []extensions.Extension { return []extensions.Extension{ - &Extension{path: "owner/gh-hello"}, + &Extension{path: "owner/gh-hello", owner: "owner"}, } } em.InstallFunc = func(_ ghrepo.Interface, _ string) error { @@ -837,7 +853,7 @@ func TestNewCmdExtension(t *testing.T) { } }, isTTY: true, - wantStdout: "✓ Successfully upgraded extension\n", + wantStdout: "✓ Successfully checked extension upgrades\n", }, } @@ -873,7 +889,7 @@ func TestNewCmdExtension(t *testing.T) { } f := cmdutil.Factory{ - Config: func() (config.Config, error) { + Config: func() (gh.Config, error) { return config.NewBlankConfig(), nil }, IOStreams: ios, @@ -924,19 +940,22 @@ func Test_checkValidExtension(t *testing.T) { ListFunc: func() []extensions.Extension { return []extensions.Extension{ &extensions.ExtensionMock{ - NameFunc: func() string { return "screensaver" }, + OwnerFunc: func() string { return "monalisa" }, + NameFunc: func() string { return "screensaver" }, }, &extensions.ExtensionMock{ - NameFunc: func() string { return "triage" }, + OwnerFunc: func() string { return "monalisa" }, + NameFunc: func() string { return "triage" }, }, } }, } type args struct { - rootCmd *cobra.Command - manager extensions.ExtensionManager - extName string + rootCmd *cobra.Command + manager extensions.ExtensionManager + extName string + extOwner string } tests := []struct { name string @@ -946,42 +965,56 @@ func Test_checkValidExtension(t *testing.T) { { name: "valid extension", args: args{ - rootCmd: rootCmd, - manager: m, - extName: "gh-hello", + rootCmd: rootCmd, + manager: m, + extOwner: "monalisa", + extName: "gh-hello", }, }, { name: "invalid extension name", args: args{ - rootCmd: rootCmd, - manager: m, - extName: "gherkins", + rootCmd: rootCmd, + manager: m, + extOwner: "monalisa", + extName: "gherkins", }, wantError: "extension repository name must start with `gh-`", }, { name: "clashes with built-in command", args: args{ - rootCmd: rootCmd, - manager: m, - extName: "gh-auth", + rootCmd: rootCmd, + manager: m, + extOwner: "monalisa", + extName: "gh-auth", }, wantError: "\"auth\" matches the name of a built-in command or alias", }, { name: "clashes with an installed extension", args: args{ - rootCmd: rootCmd, - manager: m, - extName: "gh-triage", + rootCmd: rootCmd, + manager: m, + extOwner: "cli", + extName: "gh-triage", }, wantError: "there is already an installed extension that provides the \"triage\" command", }, + { + name: "clashes with same extension", + args: args{ + rootCmd: rootCmd, + manager: m, + extOwner: "monalisa", + extName: "gh-triage", + }, + wantError: "alreadyInstalledError", + }, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { - _, err := checkValidExtension(tt.args.rootCmd, tt.args.manager, tt.args.extName) + _, err := checkValidExtension(tt.args.rootCmd, tt.args.manager, tt.args.extName, tt.args.extOwner) if tt.wantError == "" { assert.NoError(t, err) } else { diff --git a/pkg/cmd/extension/extension.go b/pkg/cmd/extension/extension.go index 188687634..dc7ffa8c3 100644 --- a/pkg/cmd/extension/extension.go +++ b/pkg/cmd/extension/extension.go @@ -9,6 +9,7 @@ import ( "strings" "sync" + "github.com/cli/cli/v2/git" "github.com/cli/cli/v2/internal/ghrepo" "gopkg.in/yaml.v3" ) @@ -36,6 +37,7 @@ type Extension struct { isPinned *bool currentVersion string latestVersion string + owner string } func (e *Extension) Name() string { @@ -176,6 +178,38 @@ func (e *Extension) IsPinned() bool { return *e.isPinned } +func (e *Extension) Owner() string { + e.mu.RLock() + if e.owner != "" { + defer e.mu.RUnlock() + return e.owner + } + e.mu.RUnlock() + + var owner string + switch e.kind { + case LocalKind: + case BinaryKind: + if manifest, err := e.loadManifest(); err == nil { + owner = manifest.Owner + } + case GitKind: + if remoteURL, err := e.gitClient.Config("remote.origin.url"); err == nil { + if url, err := git.ParseURL(strings.TrimSpace(string(remoteURL))); err == nil { + if repo, err := ghrepo.FromURL(url); err == nil { + owner = repo.RepoOwner() + } + } + } + } + + e.mu.Lock() + e.owner = owner + e.mu.Unlock() + + return e.owner +} + func (e *Extension) UpdateAvailable() bool { if e.IsLocal() || e.CurrentVersion() == "" || diff --git a/pkg/cmd/extension/extension_test.go b/pkg/cmd/extension/extension_test.go index 9b56e0bee..6f0afc3a6 100644 --- a/pkg/cmd/extension/extension_test.go +++ b/pkg/cmd/extension/extension_test.go @@ -1,6 +1,7 @@ package extension import ( + "path/filepath" "testing" "github.com/stretchr/testify/assert" @@ -50,3 +51,54 @@ func TestUpdateAvailable(t *testing.T) { assert.True(t, e.UpdateAvailable()) } + +func TestOwnerLocalExtension(t *testing.T) { + tempDir := t.TempDir() + extPath := filepath.Join(tempDir, "extensions", "gh-local", "gh-local") + assert.NoError(t, stubLocalExtension(tempDir, extPath)) + e := &Extension{ + kind: LocalKind, + path: extPath, + } + + assert.Equal(t, "", e.Owner()) +} + +func TestOwnerBinaryExtension(t *testing.T) { + tempDir := t.TempDir() + extName := "gh-bin-ext" + extDir := filepath.Join(tempDir, "extensions", extName) + extPath := filepath.Join(extDir, extName) + bm := binManifest{ + Owner: "owner", + Name: "gh-bin-ext", + Host: "example.com", + Tag: "v1.0.1", + } + assert.NoError(t, stubBinaryExtension(extDir, bm)) + e := &Extension{ + kind: BinaryKind, + path: extPath, + } + + assert.Equal(t, "owner", e.Owner()) +} + +func TestOwnerGitExtension(t *testing.T) { + gc := &mockGitClient{} + gc.On("Config", "remote.origin.url").Return("git@github.com:owner/repo.git", nil).Once() + e := &Extension{ + kind: GitKind, + gitClient: gc, + } + + assert.Equal(t, "owner", e.Owner()) +} + +func TestOwnerCached(t *testing.T) { + e := &Extension{ + owner: "cli", + } + + assert.Equal(t, "cli", e.Owner()) +} diff --git a/pkg/cmd/extension/manager.go b/pkg/cmd/extension/manager.go index b19175880..0ab429c2e 100644 --- a/pkg/cmd/extension/manager.go +++ b/pkg/cmd/extension/manager.go @@ -17,6 +17,7 @@ import ( "github.com/cli/cli/v2/api" "github.com/cli/cli/v2/git" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/pkg/extensions" "github.com/cli/cli/v2/pkg/findsh" @@ -36,7 +37,7 @@ type Manager struct { platform func() (string, string) client *http.Client gitClient gitClient - config config.Config + config gh.Config io *iostreams.IOStreams dryRunMode bool } @@ -59,7 +60,7 @@ func NewManager(ios *iostreams.IOStreams, gc *git.Client) *Manager { } } -func (m *Manager) SetConfig(cfg config.Config) { +func (m *Manager) SetConfig(cfg gh.Config) { m.config = cfg } @@ -346,7 +347,7 @@ func writeManifest(dir, name string, data []byte) (writeErr error) { } func (m *Manager) installGit(repo ghrepo.Interface, target string) error { - protocol, _ := m.config.GetOrDefault(repo.RepoHost(), "git_protocol") + protocol := m.config.GitProtocol(repo.RepoHost()).Value cloneURL := ghrepo.FormatRemoteURL(repo, protocol) var commitSHA string diff --git a/pkg/cmd/factory/default.go b/pkg/cmd/factory/default.go index a24dc20fb..7abf3ca5f 100644 --- a/pkg/cmd/factory/default.go +++ b/pkg/cmd/factory/default.go @@ -13,6 +13,7 @@ import ( "github.com/cli/cli/v2/git" "github.com/cli/cli/v2/internal/browser" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/internal/prompter" "github.com/cli/cli/v2/pkg/cmd/extension" @@ -134,10 +135,10 @@ func newPrompter(f *cmdutil.Factory) prompter.Prompter { return prompter.New(editor, io.In, io.Out, io.ErrOut) } -func configFunc() func() (config.Config, error) { - var cachedConfig config.Config +func configFunc() func() (gh.Config, error) { + var cachedConfig gh.Config var configError error - return func() (config.Config, error) { + return func() (gh.Config, error) { if cachedConfig != nil || configError != nil { return cachedConfig, configError } @@ -184,7 +185,7 @@ func ioStreams(f *cmdutil.Factory) *iostreams.IOStreams { if _, ghPromptDisabled := os.LookupEnv("GH_PROMPT_DISABLED"); ghPromptDisabled { io.SetNeverPrompt(true) - } else if prompt, _ := cfg.GetOrDefault("", "prompt"); prompt == "disabled" { + } else if prompt := cfg.Prompt(""); prompt.Value == "disabled" { io.SetNeverPrompt(true) } @@ -194,8 +195,8 @@ func ioStreams(f *cmdutil.Factory) *iostreams.IOStreams { // 3. PAGER if ghPager, ghPagerExists := os.LookupEnv("GH_PAGER"); ghPagerExists { io.SetPager(ghPager) - } else if pager, _ := cfg.Get("", "pager"); pager != "" { - io.SetPager(pager) + } else if pager := cfg.Pager(""); pager.Value != "" { + io.SetPager(pager.Value) } return io diff --git a/pkg/cmd/factory/default_test.go b/pkg/cmd/factory/default_test.go index b58544b44..94955bb30 100644 --- a/pkg/cmd/factory/default_test.go +++ b/pkg/cmd/factory/default_test.go @@ -9,6 +9,8 @@ import ( "github.com/cli/cli/v2/git" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" + ghmock "github.com/cli/cli/v2/internal/gh/mock" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/httpmock" "github.com/cli/cli/v2/pkg/iostreams" @@ -69,16 +71,16 @@ func Test_BaseRepo(t *testing.T) { readRemotes: func() (git.RemoteSet, error) { return tt.remotes, nil }, - getConfig: func() (config.Config, error) { - cfg := &config.ConfigMock{} - cfg.AuthenticationFunc = func() *config.AuthConfig { + getConfig: func() (gh.Config, error) { + cfg := &ghmock.ConfigMock{} + cfg.AuthenticationFunc = func() gh.AuthConfig { authCfg := &config.AuthConfig{} hosts := []string{"nonsense.com"} if tt.override != "" { hosts = append([]string{tt.override}, hosts...) } authCfg.SetHosts(hosts) - authCfg.SetToken("", "") + authCfg.SetActiveToken("", "") authCfg.SetDefaultHost("nonsense.com", "hosts") if tt.override != "" { authCfg.SetDefaultHost(tt.override, "GH_HOST") @@ -207,16 +209,16 @@ func Test_SmartBaseRepo(t *testing.T) { readRemotes: func() (git.RemoteSet, error) { return tt.remotes, nil }, - getConfig: func() (config.Config, error) { - cfg := &config.ConfigMock{} - cfg.AuthenticationFunc = func() *config.AuthConfig { + getConfig: func() (gh.Config, error) { + cfg := &ghmock.ConfigMock{} + cfg.AuthenticationFunc = func() gh.AuthConfig { authCfg := &config.AuthConfig{} hosts := []string{"nonsense.com"} if tt.override != "" { hosts = append([]string{tt.override}, hosts...) } authCfg.SetHosts(hosts) - authCfg.SetToken("", "") + authCfg.SetActiveToken("", "") authCfg.SetDefaultHost("nonsense.com", "hosts") if tt.override != "" { authCfg.SetDefaultHost(tt.override, "GH_HOST") @@ -256,7 +258,7 @@ func Test_OverrideBaseRepo(t *testing.T) { tests := []struct { name string remotes git.RemoteSet - config config.Config + config gh.Config envOverride string argOverride string wantsErr bool @@ -300,7 +302,7 @@ func Test_OverrideBaseRepo(t *testing.T) { readRemotes: func() (git.RemoteSet, error) { return tt.remotes, nil }, - getConfig: func() (config.Config, error) { + getConfig: func() (gh.Config, error) { return tt.config, nil }, } @@ -323,7 +325,7 @@ func Test_ioStreams_pager(t *testing.T) { tests := []struct { name string env map[string]string - config config.Config + config gh.Config wantPager string }{ { @@ -374,7 +376,7 @@ func Test_ioStreams_pager(t *testing.T) { } } f := New("1") - f.Config = func() (config.Config, error) { + f.Config = func() (gh.Config, error) { if tt.config == nil { return config.NewBlankConfig(), nil } else { @@ -390,7 +392,7 @@ func Test_ioStreams_pager(t *testing.T) { func Test_ioStreams_prompt(t *testing.T) { tests := []struct { name string - config config.Config + config gh.Config promptDisabled bool env map[string]string }{ @@ -417,7 +419,7 @@ func Test_ioStreams_prompt(t *testing.T) { } } f := New("1") - f.Config = func() (config.Config, error) { + f.Config = func() (gh.Config, error) { if tt.config == nil { return config.NewBlankConfig(), nil } else { @@ -458,7 +460,7 @@ func TestSSOURL(t *testing.T) { for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { f := New("1") - f.Config = func() (config.Config, error) { + f.Config = func() (gh.Config, error) { return config.NewBlankConfig(), nil } ios, _, _, stderr := iostreams.Test() @@ -487,7 +489,7 @@ func TestSSOURL(t *testing.T) { func TestNewGitClient(t *testing.T) { tests := []struct { name string - config config.Config + config gh.Config executable string wantAuthHosts []string wantGhPath string @@ -503,7 +505,7 @@ func TestNewGitClient(t *testing.T) { for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { f := New("1") - f.Config = func() (config.Config, error) { + f.Config = func() (gh.Config, error) { if tt.config == nil { return config.NewBlankConfig(), nil } else { @@ -522,16 +524,16 @@ func TestNewGitClient(t *testing.T) { } } -func defaultConfig() *config.ConfigMock { +func defaultConfig() *ghmock.ConfigMock { cfg := config.NewFromString("") cfg.Set("nonsense.com", "oauth_token", "BLAH") return cfg } -func pagerConfig() config.Config { +func pagerConfig() gh.Config { return config.NewFromString("pager: CONFIG_PAGER") } -func disablePromptConfig() config.Config { +func disablePromptConfig() gh.Config { return config.NewFromString("prompt: disabled") } diff --git a/pkg/cmd/factory/remote_resolver.go b/pkg/cmd/factory/remote_resolver.go index 6ef7c5e02..7e27834e2 100644 --- a/pkg/cmd/factory/remote_resolver.go +++ b/pkg/cmd/factory/remote_resolver.go @@ -7,7 +7,7 @@ import ( "github.com/cli/cli/v2/context" "github.com/cli/cli/v2/git" - "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghinstance" "github.com/cli/cli/v2/pkg/set" "github.com/cli/go-gh/v2/pkg/ssh" @@ -19,7 +19,7 @@ const ( type remoteResolver struct { readRemotes func() (git.RemoteSet, error) - getConfig func() (config.Config, error) + getConfig func() (gh.Config, error) urlTranslator context.Translator } diff --git a/pkg/cmd/factory/remote_resolver_test.go b/pkg/cmd/factory/remote_resolver_test.go index a38470595..8d537826e 100644 --- a/pkg/cmd/factory/remote_resolver_test.go +++ b/pkg/cmd/factory/remote_resolver_test.go @@ -6,6 +6,8 @@ import ( "github.com/cli/cli/v2/git" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" + ghmock "github.com/cli/cli/v2/internal/gh/mock" "github.com/stretchr/testify/assert" ) @@ -19,7 +21,7 @@ func Test_remoteResolver(t *testing.T) { tests := []struct { name string remotes func() (git.RemoteSet, error) - config config.Config + config gh.Config output []string wantsErr bool }{ @@ -30,9 +32,9 @@ func Test_remoteResolver(t *testing.T) { git.NewRemote("origin", "https://github.com/owner/repo.git"), }, nil }, - config: func() config.Config { - cfg := &config.ConfigMock{} - cfg.AuthenticationFunc = func() *config.AuthConfig { + config: func() gh.Config { + cfg := &ghmock.ConfigMock{} + cfg.AuthenticationFunc = func() gh.AuthConfig { authCfg := &config.AuthConfig{} authCfg.SetHosts([]string{}) authCfg.SetDefaultHost("github.com", "default") @@ -47,9 +49,9 @@ func Test_remoteResolver(t *testing.T) { remotes: func() (git.RemoteSet, error) { return git.RemoteSet{}, nil }, - config: func() config.Config { - cfg := &config.ConfigMock{} - cfg.AuthenticationFunc = func() *config.AuthConfig { + config: func() gh.Config { + cfg := &ghmock.ConfigMock{} + cfg.AuthenticationFunc = func() gh.AuthConfig { authCfg := &config.AuthConfig{} authCfg.SetHosts([]string{"example.com"}) authCfg.SetDefaultHost("example.com", "hosts") @@ -66,12 +68,12 @@ func Test_remoteResolver(t *testing.T) { git.NewRemote("origin", "https://test.com/owner/repo.git"), }, nil }, - config: func() config.Config { - cfg := &config.ConfigMock{} - cfg.AuthenticationFunc = func() *config.AuthConfig { + config: func() gh.Config { + cfg := &ghmock.ConfigMock{} + cfg.AuthenticationFunc = func() gh.AuthConfig { authCfg := &config.AuthConfig{} authCfg.SetHosts([]string{"example.com"}) - authCfg.SetToken("", "") + authCfg.SetActiveToken("", "") authCfg.SetDefaultHost("example.com", "hosts") return authCfg } @@ -86,9 +88,9 @@ func Test_remoteResolver(t *testing.T) { git.NewRemote("origin", "https://github.com/owner/repo.git"), }, nil }, - config: func() config.Config { - cfg := &config.ConfigMock{} - cfg.AuthenticationFunc = func() *config.AuthConfig { + config: func() gh.Config { + cfg := &ghmock.ConfigMock{} + cfg.AuthenticationFunc = func() gh.AuthConfig { authCfg := &config.AuthConfig{} authCfg.SetHosts([]string{"example.com"}) authCfg.SetDefaultHost("example.com", "hosts") @@ -105,9 +107,9 @@ func Test_remoteResolver(t *testing.T) { git.NewRemote("origin", "https://example.com/owner/repo.git"), }, nil }, - config: func() config.Config { - cfg := &config.ConfigMock{} - cfg.AuthenticationFunc = func() *config.AuthConfig { + config: func() gh.Config { + cfg := &ghmock.ConfigMock{} + cfg.AuthenticationFunc = func() gh.AuthConfig { authCfg := &config.AuthConfig{} authCfg.SetHosts([]string{"example.com"}) authCfg.SetDefaultHost("example.com", "default") @@ -127,9 +129,9 @@ func Test_remoteResolver(t *testing.T) { git.NewRemote("fork", "https://example.com/owner/repo.git"), }, nil }, - config: func() config.Config { - cfg := &config.ConfigMock{} - cfg.AuthenticationFunc = func() *config.AuthConfig { + config: func() gh.Config { + cfg := &ghmock.ConfigMock{} + cfg.AuthenticationFunc = func() gh.AuthConfig { authCfg := &config.AuthConfig{} authCfg.SetHosts([]string{"example.com"}) authCfg.SetDefaultHost("example.com", "default") @@ -146,12 +148,12 @@ func Test_remoteResolver(t *testing.T) { git.NewRemote("origin", "https://test.com/owner/repo.git"), }, nil }, - config: func() config.Config { - cfg := &config.ConfigMock{} - cfg.AuthenticationFunc = func() *config.AuthConfig { + config: func() gh.Config { + cfg := &ghmock.ConfigMock{} + cfg.AuthenticationFunc = func() gh.AuthConfig { authCfg := &config.AuthConfig{} authCfg.SetHosts([]string{"example.com", "github.com"}) - authCfg.SetToken("", "") + authCfg.SetActiveToken("", "") authCfg.SetDefaultHost("example.com", "default") return authCfg } @@ -167,9 +169,9 @@ func Test_remoteResolver(t *testing.T) { git.NewRemote("origin", "https://example.com/owner/repo.git"), }, nil }, - config: func() config.Config { - cfg := &config.ConfigMock{} - cfg.AuthenticationFunc = func() *config.AuthConfig { + config: func() gh.Config { + cfg := &ghmock.ConfigMock{} + cfg.AuthenticationFunc = func() gh.AuthConfig { authCfg := &config.AuthConfig{} authCfg.SetHosts([]string{"example.com", "github.com"}) authCfg.SetDefaultHost("github.com", "default") @@ -190,9 +192,9 @@ func Test_remoteResolver(t *testing.T) { git.NewRemote("test", "https://test.com/owner/repo.git"), }, nil }, - config: func() config.Config { - cfg := &config.ConfigMock{} - cfg.AuthenticationFunc = func() *config.AuthConfig { + config: func() gh.Config { + cfg := &ghmock.ConfigMock{} + cfg.AuthenticationFunc = func() gh.AuthConfig { authCfg := &config.AuthConfig{} authCfg.SetHosts([]string{"example.com", "github.com"}) authCfg.SetDefaultHost("github.com", "default") @@ -209,9 +211,9 @@ func Test_remoteResolver(t *testing.T) { git.NewRemote("origin", "https://example.com/owner/repo.git"), }, nil }, - config: func() config.Config { - cfg := &config.ConfigMock{} - cfg.AuthenticationFunc = func() *config.AuthConfig { + config: func() gh.Config { + cfg := &ghmock.ConfigMock{} + cfg.AuthenticationFunc = func() gh.AuthConfig { authCfg := &config.AuthConfig{} authCfg.SetHosts([]string{"example.com"}) authCfg.SetDefaultHost("test.com", "GH_HOST") @@ -229,9 +231,9 @@ func Test_remoteResolver(t *testing.T) { git.NewRemote("origin", "https://test.com/owner/repo.git"), }, nil }, - config: func() config.Config { - cfg := &config.ConfigMock{} - cfg.AuthenticationFunc = func() *config.AuthConfig { + config: func() gh.Config { + cfg := &ghmock.ConfigMock{} + cfg.AuthenticationFunc = func() gh.AuthConfig { authCfg := &config.AuthConfig{} authCfg.SetHosts([]string{"example.com"}) authCfg.SetDefaultHost("test.com", "GH_HOST") @@ -250,9 +252,9 @@ func Test_remoteResolver(t *testing.T) { git.NewRemote("origin", "https://test.com/owner/repo.git"), }, nil }, - config: func() config.Config { - cfg := &config.ConfigMock{} - cfg.AuthenticationFunc = func() *config.AuthConfig { + config: func() gh.Config { + cfg := &ghmock.ConfigMock{} + cfg.AuthenticationFunc = func() gh.AuthConfig { authCfg := &config.AuthConfig{} authCfg.SetHosts([]string{"example.com", "test.com"}) authCfg.SetDefaultHost("test.com", "GH_HOST") @@ -268,7 +270,7 @@ func Test_remoteResolver(t *testing.T) { t.Run(tt.name, func(t *testing.T) { rr := &remoteResolver{ readRemotes: tt.remotes, - getConfig: func() (config.Config, error) { return tt.config, nil }, + getConfig: func() (gh.Config, error) { return tt.config, nil }, urlTranslator: identityTranslator{}, } resolver := rr.Resolver() diff --git a/pkg/cmd/gist/clone/clone.go b/pkg/cmd/gist/clone/clone.go index 9b75a309c..6fa6f226a 100644 --- a/pkg/cmd/gist/clone/clone.go +++ b/pkg/cmd/gist/clone/clone.go @@ -7,7 +7,7 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/git" - "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghinstance" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" @@ -18,7 +18,7 @@ import ( type CloneOptions struct { HttpClient func() (*http.Client, error) GitClient *git.Client - Config func() (config.Config, error) + Config func() (gh.Config, error) IO *iostreams.IOStreams GitArgs []string @@ -40,15 +40,15 @@ func NewCmdClone(f *cmdutil.Factory, runF func(*CloneOptions) error) *cobra.Comm Use: "clone [] [-- ...]", Args: cmdutil.MinimumArgs(1, "cannot clone: gist argument required"), Short: "Clone a gist locally", - Long: heredoc.Doc(` + Long: heredoc.Docf(` Clone a GitHub gist locally. A gist can be supplied as argument in either of the following formats: - - by ID, e.g. 5b0e0062eb8e9654adad7bb1d81cc75f - - by URL, e.g. "https://gist.github.com/OWNER/5b0e0062eb8e9654adad7bb1d81cc75f" + - by ID, e.g. %[1]s5b0e0062eb8e9654adad7bb1d81cc75f%[1]s + - by URL, e.g. %[1]shttps://gist.github.com/OWNER/5b0e0062eb8e9654adad7bb1d81cc75f%[1]s - Pass additional 'git clone' flags by listing them after '--'. - `), + Pass additional %[1]sgit clone%[1]s flags by listing them after %[1]s--%[1]s. + `, "`"), RunE: func(cmd *cobra.Command, args []string) error { opts.Gist = args[0] opts.GitArgs = args[1:] @@ -80,10 +80,7 @@ func cloneRun(opts *CloneOptions) error { return err } hostname, _ := cfg.Authentication().DefaultHost() - protocol, err := cfg.GetOrDefault(hostname, "git_protocol") - if err != nil { - return err - } + protocol := cfg.GitProtocol(hostname).Value gistURL = formatRemoteURL(hostname, gistURL, protocol) } diff --git a/pkg/cmd/gist/clone/clone_test.go b/pkg/cmd/gist/clone/clone_test.go index 58ce55b52..46ab53a0f 100644 --- a/pkg/cmd/gist/clone/clone_test.go +++ b/pkg/cmd/gist/clone/clone_test.go @@ -6,6 +6,7 @@ import ( "github.com/cli/cli/v2/git" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/run" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/httpmock" @@ -22,7 +23,7 @@ func runCloneCommand(httpClient *http.Client, cli string) (*test.CmdOut, error) HttpClient: func() (*http.Client, error) { return httpClient, nil }, - Config: func() (config.Config, error) { + Config: func() (gh.Config, error) { return config.NewBlankConfig(), nil }, GitClient: &git.Client{ diff --git a/pkg/cmd/gist/create/create.go b/pkg/cmd/gist/create/create.go index 4154acf9c..4403df9be 100644 --- a/pkg/cmd/gist/create/create.go +++ b/pkg/cmd/gist/create/create.go @@ -16,7 +16,7 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/api" "github.com/cli/cli/v2/internal/browser" - "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghinstance" "github.com/cli/cli/v2/internal/text" "github.com/cli/cli/v2/pkg/cmd/gist/shared" @@ -34,7 +34,7 @@ type CreateOptions struct { FilenameOverride string WebMode bool - Config func() (config.Config, error) + Config func() (gh.Config, error) HttpClient func() (*http.Client, error) Browser browser.Browser } @@ -50,14 +50,14 @@ func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Co cmd := &cobra.Command{ Use: "create [... | -]", Short: "Create a new gist", - Long: heredoc.Doc(` + Long: heredoc.Docf(` Create a new GitHub gist with given contents. - Gists can be created from one or multiple files. Alternatively, pass "-" as + Gists can be created from one or multiple files. Alternatively, pass %[1]s-%[1]s as file name to read from standard input. - By default, gists are secret; use '--public' to make publicly listed ones. - `), + By default, gists are secret; use %[1]s--public%[1]s to make publicly listed ones. + `, "`"), Example: heredoc.Doc(` # publish file 'hello.py' as a public gist $ gh gist create --public hello.py @@ -96,7 +96,7 @@ func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Co cmd.Flags().StringVarP(&opts.Description, "desc", "d", "", "A description for this gist") cmd.Flags().BoolVarP(&opts.WebMode, "web", "w", false, "Open the web browser with created gist") - cmd.Flags().BoolVarP(&opts.Public, "public", "p", false, "List the gist publicly (default: secret)") + cmd.Flags().BoolVarP(&opts.Public, "public", "p", false, "List the gist publicly (default \"secret\")") cmd.Flags().StringVarP(&opts.FilenameOverride, "filename", "f", "", "Provide a filename to be used when reading from standard input") return cmd } diff --git a/pkg/cmd/gist/create/create_test.go b/pkg/cmd/gist/create/create_test.go index 2302b96dd..40c89c0d8 100644 --- a/pkg/cmd/gist/create/create_test.go +++ b/pkg/cmd/gist/create/create_test.go @@ -13,6 +13,7 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/internal/browser" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/run" "github.com/cli/cli/v2/pkg/cmd/gist/shared" "github.com/cli/cli/v2/pkg/cmdutil" @@ -331,7 +332,7 @@ func Test_createRun(t *testing.T) { } tt.opts.HttpClient = mockClient - tt.opts.Config = func() (config.Config, error) { + tt.opts.Config = func() (gh.Config, error) { return config.NewBlankConfig(), nil } diff --git a/pkg/cmd/gist/delete/delete.go b/pkg/cmd/gist/delete/delete.go index 22d27b65d..0b5224c8a 100644 --- a/pkg/cmd/gist/delete/delete.go +++ b/pkg/cmd/gist/delete/delete.go @@ -7,7 +7,7 @@ import ( "strings" "github.com/cli/cli/v2/api" - "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/pkg/cmd/gist/shared" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" @@ -16,7 +16,7 @@ import ( type DeleteOptions struct { IO *iostreams.IOStreams - Config func() (config.Config, error) + Config func() (gh.Config, error) HttpClient func() (*http.Client, error) Selector string diff --git a/pkg/cmd/gist/delete/delete_test.go b/pkg/cmd/gist/delete/delete_test.go index a6cde9ae0..00d9ab961 100644 --- a/pkg/cmd/gist/delete/delete_test.go +++ b/pkg/cmd/gist/delete/delete_test.go @@ -6,6 +6,7 @@ import ( "testing" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/httpmock" "github.com/cli/cli/v2/pkg/iostreams" @@ -99,7 +100,7 @@ func Test_deleteRun(t *testing.T) { tt.opts.HttpClient = func() (*http.Client, error) { return &http.Client{Transport: reg}, nil } - tt.opts.Config = func() (config.Config, error) { + tt.opts.Config = func() (gh.Config, error) { return config.NewBlankConfig(), nil } ios, _, _, _ := iostreams.Test() diff --git a/pkg/cmd/gist/edit/edit.go b/pkg/cmd/gist/edit/edit.go index f2f04bd92..d777e9581 100644 --- a/pkg/cmd/gist/edit/edit.go +++ b/pkg/cmd/gist/edit/edit.go @@ -13,7 +13,7 @@ import ( "strings" "github.com/cli/cli/v2/api" - "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/prompter" "github.com/cli/cli/v2/pkg/cmd/gist/shared" "github.com/cli/cli/v2/pkg/cmdutil" @@ -27,7 +27,7 @@ var editNextOptions = []string{"Edit another file", "Submit", "Cancel"} type EditOptions struct { IO *iostreams.IOStreams HttpClient func() (*http.Client, error) - Config func() (config.Config, error) + Config func() (gh.Config, error) Prompter prompter.Prompter Edit func(string, string, string, *iostreams.IOStreams) (string, error) diff --git a/pkg/cmd/gist/edit/edit_test.go b/pkg/cmd/gist/edit/edit_test.go index b57fa41cc..11a32bc92 100644 --- a/pkg/cmd/gist/edit/edit_test.go +++ b/pkg/cmd/gist/edit/edit_test.go @@ -10,6 +10,7 @@ import ( "testing" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/prompter" "github.com/cli/cli/v2/pkg/cmd/gist/shared" "github.com/cli/cli/v2/pkg/cmdutil" @@ -554,7 +555,7 @@ func Test_editRun(t *testing.T) { tt.opts.IO = ios tt.opts.Selector = "1234" - tt.opts.Config = func() (config.Config, error) { + tt.opts.Config = func() (gh.Config, error) { return config.NewBlankConfig(), nil } diff --git a/pkg/cmd/gist/list/list.go b/pkg/cmd/gist/list/list.go index c49f1fffd..5d0e47150 100644 --- a/pkg/cmd/gist/list/list.go +++ b/pkg/cmd/gist/list/list.go @@ -6,18 +6,18 @@ import ( "strings" "time" - "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" + "github.com/cli/cli/v2/internal/tableprinter" "github.com/cli/cli/v2/internal/text" "github.com/cli/cli/v2/pkg/cmd/gist/shared" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" - "github.com/cli/cli/v2/utils" "github.com/spf13/cobra" ) type ListOptions struct { IO *iostreams.IOStreams - Config func() (config.Config, error) + Config func() (gh.Config, error) HttpClient func() (*http.Client, error) Limit int @@ -94,9 +94,7 @@ func listRun(opts *ListOptions) error { } cs := opts.IO.ColorScheme() - - //nolint:staticcheck // SA1019: utils.NewTablePrinter is deprecated: use internal/tableprinter - tp := utils.NewTablePrinter(opts.IO) + tp := tableprinter.New(opts.IO, tableprinter.WithHeader("ID", "DESCRIPTION", "FILES", "VISIBILITY", "UPDATED")) for _, gist := range gists { fileCount := len(gist.Files) @@ -118,16 +116,14 @@ func listRun(opts *ListOptions) error { } } - gistTime := gist.UpdatedAt.Format(time.RFC3339) - if tp.IsTTY() { - gistTime = text.FuzzyAgo(time.Now(), gist.UpdatedAt) - } - - tp.AddField(gist.ID, nil, nil) - tp.AddField(text.RemoveExcessiveWhitespace(description), nil, cs.Bold) - tp.AddField(text.Pluralize(fileCount, "file"), nil, nil) - tp.AddField(visibility, nil, visColor) - tp.AddField(gistTime, nil, cs.Gray) + tp.AddField(gist.ID) + tp.AddField( + text.RemoveExcessiveWhitespace(description), + tableprinter.WithColor(cs.Bold), + ) + tp.AddField(text.Pluralize(fileCount, "file")) + tp.AddField(visibility, tableprinter.WithColor(visColor)) + tp.AddTimeField(time.Now(), gist.UpdatedAt, cs.Gray) tp.EndRow() } diff --git a/pkg/cmd/gist/list/list_test.go b/pkg/cmd/gist/list/list_test.go index 54bb52eb1..a15bae6aa 100644 --- a/pkg/cmd/gist/list/list_test.go +++ b/pkg/cmd/gist/list/list_test.go @@ -9,6 +9,7 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/httpmock" "github.com/cli/cli/v2/pkg/iostreams" @@ -180,10 +181,11 @@ func Test_listRun(t *testing.T) { ) }, wantOut: heredoc.Doc(` - 1234567890 cool.txt 1 file public about 6 hours ago - 4567890123 1 file public about 6 hours ago - 2345678901 tea leaves thwart those who ... 2 files secret about 6 hours ago - 3456789012 short desc 11 files secret about 6 hours ago + ID DESCRIPTION FILES VISIBILITY UPDATED + 1234567890 cool.txt 1 file public about 6 hours ago + 4567890123 1 file public about 6 hours ago + 2345678901 tea leaves thwart those ... 2 files secret about 6 hours ago + 3456789012 short desc 11 files secret about 6 hours ago `), }, { @@ -214,8 +216,9 @@ func Test_listRun(t *testing.T) { ) }, wantOut: heredoc.Doc(` - 1234567890 cool.txt 1 file public about 6 hours ago - 4567890123 1 file public about 6 hours ago + ID DESCRIPTION FILES VISIBILITY UPDATED + 1234567890 cool.txt 1 file public about 6 hours ago + 4567890123 1 file public about 6 hours ago `), }, { @@ -261,8 +264,9 @@ func Test_listRun(t *testing.T) { ) }, wantOut: heredoc.Doc(` - 2345678901 tea leaves thwart those who ... 2 files secret about 6 hours ago - 3456789012 short desc 11 files secret about 6 hours ago + ID DESCRIPTION FILES VISIBILITY UPDATED + 2345678901 tea leaves thwart those ... 2 files secret about 6 hours ago + 3456789012 short desc 11 files secret about 6 hours ago `), }, { @@ -285,7 +289,10 @@ func Test_listRun(t *testing.T) { )), ) }, - wantOut: "1234567890 cool.txt 1 file public about 6 hours ago\n", + wantOut: heredoc.Doc(` + ID DESCRIPTION FILES VISIBILITY UPDATED + 1234567890 cool.txt 1 file public about 6 hours ago + `), }, { name: "nontty output", @@ -361,7 +368,7 @@ func Test_listRun(t *testing.T) { return &http.Client{Transport: reg}, nil } - tt.opts.Config = func() (config.Config, error) { + tt.opts.Config = func() (gh.Config, error) { return config.NewBlankConfig(), nil } diff --git a/pkg/cmd/gist/rename/rename.go b/pkg/cmd/gist/rename/rename.go index c23aca579..630e67019 100644 --- a/pkg/cmd/gist/rename/rename.go +++ b/pkg/cmd/gist/rename/rename.go @@ -10,7 +10,7 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/api" - "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/pkg/cmd/gist/shared" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" @@ -19,7 +19,7 @@ import ( type RenameOptions struct { IO *iostreams.IOStreams - Config func() (config.Config, error) + Config func() (gh.Config, error) HttpClient func() (*http.Client, error) Selector string diff --git a/pkg/cmd/gist/rename/rename_test.go b/pkg/cmd/gist/rename/rename_test.go index 5413d87c9..e835cc8a7 100644 --- a/pkg/cmd/gist/rename/rename_test.go +++ b/pkg/cmd/gist/rename/rename_test.go @@ -6,6 +6,7 @@ import ( "testing" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/pkg/cmd/gist/shared" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/httpmock" @@ -166,7 +167,7 @@ func TestRenameRun(t *testing.T) { tt.opts.NewFileName = "new.txt" tt.opts.IO = ios - tt.opts.Config = func() (config.Config, error) { + tt.opts.Config = func() (gh.Config, error) { return config.NewBlankConfig(), nil } diff --git a/pkg/cmd/gist/view/view.go b/pkg/cmd/gist/view/view.go index e4f5c84e1..2a19f5958 100644 --- a/pkg/cmd/gist/view/view.go +++ b/pkg/cmd/gist/view/view.go @@ -6,7 +6,7 @@ import ( "sort" "strings" - "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghinstance" "github.com/cli/cli/v2/internal/prompter" "github.com/cli/cli/v2/internal/text" @@ -23,7 +23,7 @@ type browser interface { type ViewOptions struct { IO *iostreams.IOStreams - Config func() (config.Config, error) + Config func() (gh.Config, error) HttpClient func() (*http.Client, error) Browser browser Prompter prompter.Prompter diff --git a/pkg/cmd/gist/view/view_test.go b/pkg/cmd/gist/view/view_test.go index c571422c5..52e616f7c 100644 --- a/pkg/cmd/gist/view/view_test.go +++ b/pkg/cmd/gist/view/view_test.go @@ -8,6 +8,7 @@ import ( "time" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/prompter" "github.com/cli/cli/v2/pkg/cmd/gist/shared" "github.com/cli/cli/v2/pkg/cmdutil" @@ -370,7 +371,7 @@ func Test_viewRun(t *testing.T) { return &http.Client{Transport: reg}, nil } - tt.opts.Config = func() (config.Config, error) { + tt.opts.Config = func() (gh.Config, error) { return config.NewBlankConfig(), nil } diff --git a/pkg/cmd/gpg-key/add/add.go b/pkg/cmd/gpg-key/add/add.go index 54482d029..35ee12736 100644 --- a/pkg/cmd/gpg-key/add/add.go +++ b/pkg/cmd/gpg-key/add/add.go @@ -8,7 +8,7 @@ import ( "os" "github.com/MakeNowJust/heredoc" - "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" "github.com/spf13/cobra" @@ -16,7 +16,7 @@ import ( type AddOptions struct { IO *iostreams.IOStreams - Config func() (config.Config, error) + Config func() (gh.Config, error) HTTPClient func() (*http.Client, error) KeyFile string diff --git a/pkg/cmd/gpg-key/add/add_test.go b/pkg/cmd/gpg-key/add/add_test.go index 3cce519cf..c6d7c18fb 100644 --- a/pkg/cmd/gpg-key/add/add_test.go +++ b/pkg/cmd/gpg-key/add/add_test.go @@ -6,6 +6,7 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/pkg/httpmock" "github.com/cli/cli/v2/pkg/iostreams" "github.com/stretchr/testify/assert" @@ -125,7 +126,7 @@ func Test_runAdd(t *testing.T) { if tt.httpStubs != nil { tt.httpStubs(reg) } - tt.opts.Config = func() (config.Config, error) { + tt.opts.Config = func() (gh.Config, error) { return config.NewBlankConfig(), nil } diff --git a/pkg/cmd/gpg-key/delete/delete.go b/pkg/cmd/gpg-key/delete/delete.go index 0f152297a..d0fb5c0d6 100644 --- a/pkg/cmd/gpg-key/delete/delete.go +++ b/pkg/cmd/gpg-key/delete/delete.go @@ -5,7 +5,7 @@ import ( "net/http" "strconv" - "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/prompter" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" @@ -14,7 +14,7 @@ import ( type DeleteOptions struct { IO *iostreams.IOStreams - Config func() (config.Config, error) + Config func() (gh.Config, error) HttpClient func() (*http.Client, error) KeyID string @@ -91,7 +91,7 @@ func deleteRun(opts *DeleteOptions) error { err = deleteGPGKey(httpClient, host, id) if err != nil { - return nil + return err } if opts.IO.IsStdoutTTY() { diff --git a/pkg/cmd/gpg-key/delete/delete_test.go b/pkg/cmd/gpg-key/delete/delete_test.go index a7f0fda67..115e72db2 100644 --- a/pkg/cmd/gpg-key/delete/delete_test.go +++ b/pkg/cmd/gpg-key/delete/delete_test.go @@ -6,10 +6,12 @@ import ( "testing" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/prompter" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/httpmock" "github.com/cli/cli/v2/pkg/iostreams" + "github.com/cli/go-gh/v2/pkg/api" "github.com/google/shlex" "github.com/stretchr/testify/assert" ) @@ -170,6 +172,19 @@ func Test_deleteRun(t *testing.T) { wantErr: true, wantErrMsg: "unable to delete GPG key ABC123: either the GPG key is not found or it is not owned by you", }, + { + name: "delete failed", + opts: DeleteOptions{KeyID: "ABC123", Confirmed: true}, + httpStubs: func(reg *httpmock.Registry) { + reg.Register(httpmock.REST("GET", "user/gpg_keys"), httpmock.StatusStringResponse(200, keysResp)) + reg.Register(httpmock.REST("DELETE", "user/gpg_keys/123"), httpmock.StatusJSONResponse(404, api.HTTPError{ + StatusCode: 404, + Message: "GPG key 123 not found", + })) + }, + wantErr: true, + wantErrMsg: "HTTP 404: GPG key 123 not found (https://api.github.com/user/gpg_keys/123)", + }, } for _, tt := range tests { @@ -187,7 +202,7 @@ func Test_deleteRun(t *testing.T) { tt.opts.HttpClient = func() (*http.Client, error) { return &http.Client{Transport: reg}, nil } - tt.opts.Config = func() (config.Config, error) { + tt.opts.Config = func() (gh.Config, error) { return config.NewBlankConfig(), nil } ios, _, stdout, _ := iostreams.Test() diff --git a/pkg/cmd/gpg-key/list/list.go b/pkg/cmd/gpg-key/list/list.go index 623cc63e6..9acf1d7b6 100644 --- a/pkg/cmd/gpg-key/list/list.go +++ b/pkg/cmd/gpg-key/list/list.go @@ -6,17 +6,16 @@ import ( "net/http" "time" - "github.com/cli/cli/v2/internal/config" - "github.com/cli/cli/v2/internal/text" + "github.com/cli/cli/v2/internal/gh" + "github.com/cli/cli/v2/internal/tableprinter" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" - "github.com/cli/cli/v2/utils" "github.com/spf13/cobra" ) type ListOptions struct { IO *iostreams.IOStreams - Config func() (config.Config, error) + Config func() (gh.Config, error) HTTPClient func() (*http.Client, error) } @@ -71,31 +70,15 @@ func listRun(opts *ListOptions) error { return cmdutil.NewNoResultsError("no GPG keys present in the GitHub account") } - //nolint:staticcheck // SA1019: utils.NewTablePrinter is deprecated: use internal/tableprinter - t := utils.NewTablePrinter(opts.IO) + t := tableprinter.New(opts.IO, tableprinter.WithHeader("EMAIL", "KEY ID", "PUBLIC KEY", "ADDED", "EXPIRES")) cs := opts.IO.ColorScheme() now := time.Now() - if t.IsTTY() { - t.AddField("EMAIL", nil, nil) - t.AddField("KEY ID", nil, nil) - t.AddField("PUBLIC KEY", nil, nil) - t.AddField("ADDED", nil, nil) - t.AddField("EXPIRES", nil, nil) - t.EndRow() - } - for _, gpgKey := range gpgKeys { - t.AddField(gpgKey.Emails.String(), nil, nil) - t.AddField(gpgKey.KeyID, nil, nil) - t.AddField(gpgKey.PublicKey, truncateMiddle, nil) - - createdAt := gpgKey.CreatedAt.Format(time.RFC3339) - if t.IsTTY() { - createdAt = text.FuzzyAgoAbbr(now, gpgKey.CreatedAt) - } - t.AddField(createdAt, nil, cs.Gray) - + t.AddField(gpgKey.Emails.String()) + t.AddField(gpgKey.KeyID) + t.AddField(gpgKey.PublicKey, tableprinter.WithTruncate(truncateMiddle)) + t.AddTimeField(now, gpgKey.CreatedAt, cs.Gray) expiresAt := gpgKey.ExpiresAt.Format(time.RFC3339) if t.IsTTY() { if gpgKey.ExpiresAt.IsZero() { @@ -104,8 +87,7 @@ func listRun(opts *ListOptions) error { expiresAt = gpgKey.ExpiresAt.Format("2006-01-02") } } - t.AddField(expiresAt, nil, cs.Gray) - + t.AddField(expiresAt, tableprinter.WithColor(cs.Gray)) t.EndRow() } diff --git a/pkg/cmd/gpg-key/list/list_test.go b/pkg/cmd/gpg-key/list/list_test.go index a596275d1..daf8c991d 100644 --- a/pkg/cmd/gpg-key/list/list_test.go +++ b/pkg/cmd/gpg-key/list/list_test.go @@ -8,6 +8,7 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/pkg/httpmock" "github.com/cli/cli/v2/pkg/iostreams" "github.com/stretchr/testify/assert" @@ -56,9 +57,9 @@ func Test_listRun(t *testing.T) { }}, isTTY: true, wantStdout: heredoc.Doc(` - EMAIL KEY ID PUBLIC KEY ADDED EXPIRES - johnny@test.com ABCDEF1234567890 xJMEWfoofoofoo 1d 2099-01-01 - monalisa@github.com 1234567890ABCDEF xJMEWbarbarbar 1d Never + EMAIL KEY ID PUBLIC KEY ADDED EXPIRES + johnny@test.com ABCDEF123456... xJMEWfoofoofoo about 1 day ago 2099-01-01 + monalisa@github... 1234567890AB... xJMEWbarbarbar about 1 day ago Never `), wantStderr: "", }, @@ -130,7 +131,7 @@ func Test_listRun(t *testing.T) { ios.SetStderrTTY(tt.isTTY) opts := tt.opts opts.IO = ios - opts.Config = func() (config.Config, error) { return config.NewBlankConfig(), nil } + opts.Config = func() (gh.Config, error) { return config.NewBlankConfig(), nil } err := listRun(&opts) if tt.wantErr { assert.Error(t, err) diff --git a/pkg/cmd/issue/close/close.go b/pkg/cmd/issue/close/close.go index 755363514..9197abff6 100644 --- a/pkg/cmd/issue/close/close.go +++ b/pkg/cmd/issue/close/close.go @@ -73,7 +73,7 @@ func closeRun(opts *CloseOptions) error { } if issue.State == "CLOSED" { - fmt.Fprintf(opts.IO.ErrOut, "%s Issue #%d (%s) is already closed\n", cs.Yellow("!"), issue.Number, issue.Title) + fmt.Fprintf(opts.IO.ErrOut, "%s Issue %s#%d (%s) is already closed\n", cs.Yellow("!"), ghrepo.FullName(baseRepo), issue.Number, issue.Title) return nil } @@ -98,7 +98,7 @@ func closeRun(opts *CloseOptions) error { return err } - fmt.Fprintf(opts.IO.ErrOut, "%s Closed issue #%d (%s)\n", cs.SuccessIconWithColor(cs.Red), issue.Number, issue.Title) + fmt.Fprintf(opts.IO.ErrOut, "%s Closed issue %s#%d (%s)\n", cs.SuccessIconWithColor(cs.Red), ghrepo.FullName(baseRepo), issue.Number, issue.Title) return nil } diff --git a/pkg/cmd/issue/close/close_test.go b/pkg/cmd/issue/close/close_test.go index 41a78d0d9..4d50e56b2 100644 --- a/pkg/cmd/issue/close/close_test.go +++ b/pkg/cmd/issue/close/close_test.go @@ -123,7 +123,7 @@ func TestCloseRun(t *testing.T) { }), ) }, - wantStderr: "✓ Closed issue #13 (The title of the issue)\n", + wantStderr: "✓ Closed issue OWNER/REPO#13 (The title of the issue)\n", }, { name: "close issue with comment", @@ -159,7 +159,7 @@ func TestCloseRun(t *testing.T) { }), ) }, - wantStderr: "✓ Closed issue #13 (The title of the issue)\n", + wantStderr: "✓ Closed issue OWNER/REPO#13 (The title of the issue)\n", }, { name: "close issue with reason", @@ -187,7 +187,7 @@ func TestCloseRun(t *testing.T) { }), ) }, - wantStderr: "✓ Closed issue #13 (The title of the issue)\n", + wantStderr: "✓ Closed issue OWNER/REPO#13 (The title of the issue)\n", }, { name: "close issue with reason when reason is not supported", @@ -214,7 +214,7 @@ func TestCloseRun(t *testing.T) { }), ) }, - wantStderr: "✓ Closed issue #13 (The title of the issue)\n", + wantStderr: "✓ Closed issue OWNER/REPO#13 (The title of the issue)\n", }, { name: "issue already closed", @@ -231,7 +231,7 @@ func TestCloseRun(t *testing.T) { } } }`), ) }, - wantStderr: "! Issue #13 (The title of the issue) is already closed\n", + wantStderr: "! Issue OWNER/REPO#13 (The title of the issue) is already closed\n", }, { name: "issues disabled", diff --git a/pkg/cmd/issue/create/create.go b/pkg/cmd/issue/create/create.go index 577f08728..c359df2a0 100644 --- a/pkg/cmd/issue/create/create.go +++ b/pkg/cmd/issue/create/create.go @@ -8,7 +8,7 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/api" "github.com/cli/cli/v2/internal/browser" - "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/internal/text" prShared "github.com/cli/cli/v2/pkg/cmd/pr/shared" @@ -19,7 +19,7 @@ import ( type CreateOptions struct { HttpClient func() (*http.Client, error) - Config func() (config.Config, error) + Config func() (gh.Config, error) IO *iostreams.IOStreams BaseRepo func() (ghrepo.Interface, error) Browser browser.Browser @@ -56,12 +56,12 @@ func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Co cmd := &cobra.Command{ Use: "create", Short: "Create a new issue", - Long: heredoc.Doc(` + Long: heredoc.Docf(` Create an issue on GitHub. - Adding an issue to projects requires authorization with the "project" scope. - To authorize, run "gh auth refresh -s project". - `), + Adding an issue to projects requires authorization with the %[1]sproject%[1]s scope. + To authorize, run %[1]sgh auth refresh -s project%[1]s. + `, "`"), Example: heredoc.Doc(` $ gh issue create --title "I found a bug" --body "Nothing works" $ gh issue create --label "bug,help wanted" diff --git a/pkg/cmd/issue/create/create_test.go b/pkg/cmd/issue/create/create_test.go index dcc4c7618..c70507327 100644 --- a/pkg/cmd/issue/create/create_test.go +++ b/pkg/cmd/issue/create/create_test.go @@ -14,6 +14,7 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/internal/browser" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/internal/prompter" "github.com/cli/cli/v2/internal/run" @@ -364,7 +365,7 @@ func runCommandWithRootDirOverridden(rt http.RoundTripper, isTTY bool, cli strin HttpClient: func() (*http.Client, error) { return &http.Client{Transport: rt}, nil }, - Config: func() (config.Config, error) { + Config: func() (gh.Config, error) { return config.NewBlankConfig(), nil }, BaseRepo: func() (ghrepo.Interface, error) { diff --git a/pkg/cmd/issue/delete/delete.go b/pkg/cmd/issue/delete/delete.go index cee367cb8..a70c6abb2 100644 --- a/pkg/cmd/issue/delete/delete.go +++ b/pkg/cmd/issue/delete/delete.go @@ -5,7 +5,7 @@ import ( "net/http" "github.com/cli/cli/v2/api" - "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/pkg/cmd/issue/shared" "github.com/cli/cli/v2/pkg/cmdutil" @@ -16,7 +16,7 @@ import ( type DeleteOptions struct { HttpClient func() (*http.Client, error) - Config func() (config.Config, error) + Config func() (gh.Config, error) IO *iostreams.IOStreams BaseRepo func() (ghrepo.Interface, error) Prompter iprompter @@ -76,7 +76,7 @@ func deleteRun(opts *DeleteOptions) error { return err } if issue.IsPullRequest() { - return fmt.Errorf("issue #%d is a pull request and cannot be deleted", issue.Number) + return fmt.Errorf("issue %s#%d is a pull request and cannot be deleted", ghrepo.FullName(baseRepo), issue.Number) } // When executed in an interactive shell, require confirmation, unless @@ -95,7 +95,7 @@ func deleteRun(opts *DeleteOptions) error { } if opts.IO.IsStdoutTTY() { - fmt.Fprintf(opts.IO.ErrOut, "%s Deleted issue #%d (%s).\n", cs.Red("✔"), issue.Number, issue.Title) + fmt.Fprintf(opts.IO.ErrOut, "%s Deleted issue %s#%d (%s).\n", cs.Red("✔"), ghrepo.FullName(baseRepo), issue.Number, issue.Title) } return nil diff --git a/pkg/cmd/issue/delete/delete_test.go b/pkg/cmd/issue/delete/delete_test.go index acc52af65..bd83c826f 100644 --- a/pkg/cmd/issue/delete/delete_test.go +++ b/pkg/cmd/issue/delete/delete_test.go @@ -9,6 +9,7 @@ import ( "testing" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/internal/prompter" "github.com/cli/cli/v2/pkg/cmdutil" @@ -31,7 +32,7 @@ func runCommand(rt http.RoundTripper, pm *prompter.MockPrompter, isTTY bool, cli HttpClient: func() (*http.Client, error) { return &http.Client{Transport: rt}, nil }, - Config: func() (config.Config, error) { + Config: func() (gh.Config, error) { return config.NewBlankConfig(), nil }, BaseRepo: func() (ghrepo.Interface, error) { @@ -86,7 +87,7 @@ func TestIssueDelete(t *testing.T) { t.Fatalf("error running command `issue delete`: %v", err) } - r := regexp.MustCompile(`Deleted issue #13 \(The title of the issue\)`) + r := regexp.MustCompile(`Deleted issue OWNER/REPO#13 \(The title of the issue\)`) if !r.MatchString(output.Stderr()) { t.Fatalf("output did not match regexp /%s/\n> output\n%q\n", r, output.Stderr()) @@ -118,7 +119,7 @@ func TestIssueDelete_confirm(t *testing.T) { t.Fatalf("error running command `issue delete`: %v", err) } - r := regexp.MustCompile(`Deleted issue #13 \(The title of the issue\)`) + r := regexp.MustCompile(`Deleted issue OWNER/REPO#13 \(The title of the issue\)`) if !r.MatchString(output.Stderr()) { t.Fatalf("output did not match regexp /%s/\n> output\n%q\n", r, output.Stderr()) diff --git a/pkg/cmd/issue/develop/develop.go b/pkg/cmd/issue/develop/develop.go index 1a100c9a1..32423af35 100644 --- a/pkg/cmd/issue/develop/develop.go +++ b/pkg/cmd/issue/develop/develop.go @@ -171,7 +171,7 @@ func developRunCreate(opts *DevelopOptions, apiClient *api.Client, issueRepo ghr return err } - fmt.Fprintf(opts.IO.Out, "%s/%s/%s/tree/%s\n", branchRepo.RepoHost(), branchRepo.RepoOwner(), branchRepo.RepoName(), branchName) + fmt.Fprintf(opts.IO.Out, "%s/%s/tree/%s\n", branchRepo.RepoHost(), ghrepo.FullName(branchRepo), branchName) return checkoutBranch(opts, branchRepo, branchName) } @@ -185,11 +185,11 @@ func developRunList(opts *DevelopOptions, apiClient *api.Client, issueRepo ghrep } if len(branches) == 0 { - return cmdutil.NewNoResultsError(fmt.Sprintf("no linked branches found for %s/%s#%d", issueRepo.RepoOwner(), issueRepo.RepoName(), issue.Number)) + return cmdutil.NewNoResultsError(fmt.Sprintf("no linked branches found for %s#%d", ghrepo.FullName(issueRepo), issue.Number)) } if opts.IO.IsStdoutTTY() { - fmt.Fprintf(opts.IO.Out, "\nShowing linked branches for %s/%s#%d\n\n", issueRepo.RepoOwner(), issueRepo.RepoName(), issue.Number) + fmt.Fprintf(opts.IO.Out, "\nShowing linked branches for %s#%d\n\n", ghrepo.FullName(issueRepo), issue.Number) } printLinkedBranches(opts.IO, branches) @@ -199,7 +199,7 @@ func developRunList(opts *DevelopOptions, apiClient *api.Client, issueRepo ghrep func printLinkedBranches(io *iostreams.IOStreams, branches []api.LinkedBranch) { cs := io.ColorScheme() - table := tableprinter.New(io) + table := tableprinter.New(io, tableprinter.WithHeader("BRANCH", "URL")) for _, branch := range branches { table.AddField(branch.BranchName, tableprinter.WithColor(cs.ColorFromString("cyan"))) table.AddField(branch.URL) diff --git a/pkg/cmd/issue/develop/develop_test.go b/pkg/cmd/issue/develop/develop_test.go index d4f8bce2d..7532ffb38 100644 --- a/pkg/cmd/issue/develop/develop_test.go +++ b/pkg/cmd/issue/develop/develop_test.go @@ -6,6 +6,7 @@ import ( "net/http" "testing" + "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/context" "github.com/cli/cli/v2/git" "github.com/cli/cli/v2/internal/ghrepo" @@ -245,7 +246,14 @@ func TestDevelopRun(t *testing.T) { assert.Equal(t, "REPO", inputs["name"]) })) }, - expectedOut: "\nShowing linked branches for OWNER/REPO#42\n\nfoo https://github.com/OWNER/REPO/tree/foo\nbar https://github.com/OWNER/OTHER-REPO/tree/bar\n", + expectedOut: heredoc.Doc(` + + Showing linked branches for OWNER/REPO#42 + + BRANCH URL + foo https://github.com/OWNER/REPO/tree/foo + bar https://github.com/OWNER/OTHER-REPO/tree/bar + `), }, { name: "list branches for an issue providing an issue url", @@ -311,7 +319,7 @@ func TestDevelopRun(t *testing.T) { expectedOut: "github.com/OWNER/REPO/tree/my-issue-1\n", }, { - name: "develop new branch in diffferent repo than issue", + name: "develop new branch in different repo than issue", opts: &DevelopOptions{ IssueSelector: "123", BranchRepo: "OWNER2/REPO", diff --git a/pkg/cmd/issue/edit/edit.go b/pkg/cmd/issue/edit/edit.go index 53400fb63..1b775f88b 100644 --- a/pkg/cmd/issue/edit/edit.go +++ b/pkg/cmd/issue/edit/edit.go @@ -50,12 +50,12 @@ func NewCmdEdit(f *cmdutil.Factory, runF func(*EditOptions) error) *cobra.Comman cmd := &cobra.Command{ Use: "edit { | }", Short: "Edit issues", - Long: heredoc.Doc(` + Long: heredoc.Docf(` Edit one or more issues within the same repository. - Editing issues' projects requires authorization with the "project" scope. - To authorize, run "gh auth refresh -s project". - `), + Editing issues' projects requires authorization with the %[1]sproject%[1]s scope. + To authorize, run %[1]sgh auth refresh -s project%[1]s. + `, "`"), Example: heredoc.Doc(` $ gh issue edit 23 --title "I found a bug" --body "Nothing works" $ gh issue edit 23 --add-label "bug,help wanted" --remove-label "core" diff --git a/pkg/cmd/issue/list/list.go b/pkg/cmd/issue/list/list.go index 20e77e141..47da51ae4 100644 --- a/pkg/cmd/issue/list/list.go +++ b/pkg/cmd/issue/list/list.go @@ -10,8 +10,8 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/api" "github.com/cli/cli/v2/internal/browser" - "github.com/cli/cli/v2/internal/config" fd "github.com/cli/cli/v2/internal/featuredetection" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/internal/text" issueShared "github.com/cli/cli/v2/pkg/cmd/issue/shared" @@ -24,7 +24,7 @@ import ( type ListOptions struct { HttpClient func() (*http.Client, error) - Config func() (config.Config, error) + Config func() (gh.Config, error) IO *iostreams.IOStreams BaseRepo func() (ghrepo.Interface, error) Browser browser.Browser diff --git a/pkg/cmd/issue/list/list_test.go b/pkg/cmd/issue/list/list_test.go index cf0624c87..e45fc76e4 100644 --- a/pkg/cmd/issue/list/list_test.go +++ b/pkg/cmd/issue/list/list_test.go @@ -8,8 +8,10 @@ import ( "time" "github.com/MakeNowJust/heredoc" + "github.com/cli/cli/v2/api" "github.com/cli/cli/v2/internal/browser" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/internal/run" prShared "github.com/cli/cli/v2/pkg/cmd/pr/shared" @@ -19,6 +21,7 @@ import ( "github.com/cli/cli/v2/test" "github.com/google/shlex" "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" ) func runCommand(rt http.RoundTripper, isTTY bool, cli string) (*test.CmdOut, error) { @@ -32,7 +35,7 @@ func runCommand(rt http.RoundTripper, isTTY bool, cli string) (*test.CmdOut, err HttpClient: func() (*http.Client, error) { return &http.Client{Transport: rt}, nil }, - Config: func() (config.Config, error) { + Config: func() (gh.Config, error) { return config.NewBlankConfig(), nil }, BaseRepo: func() (ghrepo.Interface, error) { @@ -104,9 +107,10 @@ func TestIssueList_tty(t *testing.T) { Showing 3 of 3 open issues in OWNER/REPO - #1 number won label about 1 day ago - #2 number too label about 1 month ago - #4 number fore label about 2 years ago + ID TITLE LABELS UPDATED + #1 number won label about 1 day ago + #2 number too label about 1 month ago + #4 number fore label about 2 years ago `), output.String()) assert.Equal(t, ``, output.Stderr()) } @@ -455,3 +459,151 @@ func Test_issueList(t *testing.T) { }) } } + +func TestIssueList_withProjectItems(t *testing.T) { + reg := &httpmock.Registry{} + defer reg.Verify(t) + + reg.Register( + httpmock.GraphQL(`query IssueList\b`), + httpmock.GraphQLQuery(`{ + "data": { + "repository": { + "hasIssuesEnabled": true, + "issues": { + "totalCount": 1, + "nodes": [ + { + "projectItems": { + "nodes": [ + { + "id": "PVTI_lAHOAA3WC84AW6WNzgJ8rnQ", + "project": { + "id": "PVT_kwHOAA3WC84AW6WN", + "title": "Test Public Project" + }, + "status": { + "optionId": "47fc9ee4", + "name": "In Progress" + } + } + ], + "totalCount": 1 + } + } + ] + } + } + } + }`, func(_ string, params map[string]interface{}) { + require.Equal(t, map[string]interface{}{ + "owner": "OWNER", + "repo": "REPO", + "limit": float64(30), + "states": []interface{}{"OPEN"}, + }, params) + })) + + client := &http.Client{Transport: reg} + issuesAndTotalCount, err := issueList( + client, + ghrepo.New("OWNER", "REPO"), + prShared.FilterOptions{ + Entity: "issue", + }, + 30, + ) + + require.NoError(t, err) + require.Len(t, issuesAndTotalCount.Issues, 1) + require.Len(t, issuesAndTotalCount.Issues[0].ProjectItems.Nodes, 1) + + require.Equal(t, issuesAndTotalCount.Issues[0].ProjectItems.Nodes[0].ID, "PVTI_lAHOAA3WC84AW6WNzgJ8rnQ") + + expectedProject := api.ProjectV2ItemProject{ + ID: "PVT_kwHOAA3WC84AW6WN", + Title: "Test Public Project", + } + require.Equal(t, issuesAndTotalCount.Issues[0].ProjectItems.Nodes[0].Project, expectedProject) + + expectedStatus := api.ProjectV2ItemStatus{ + OptionID: "47fc9ee4", + Name: "In Progress", + } + require.Equal(t, issuesAndTotalCount.Issues[0].ProjectItems.Nodes[0].Status, expectedStatus) +} + +func TestIssueList_Search_withProjectItems(t *testing.T) { + reg := &httpmock.Registry{} + defer reg.Verify(t) + + reg.Register( + httpmock.GraphQL(`query IssueSearch\b`), + httpmock.GraphQLQuery(`{ + "data": { + "repository": { + "hasIssuesEnabled": true + }, + "search": { + "issueCount": 1, + "nodes": [ + { + "projectItems": { + "nodes": [ + { + "id": "PVTI_lAHOAA3WC84AW6WNzgJ8rl0", + "project": { + "id": "PVT_kwHOAA3WC84AW6WN", + "title": "Test Public Project" + }, + "status": { + "optionId": "47fc9ee4", + "name": "In Progress" + } + } + ], + "totalCount": 1 + } + } + ] + } + } + }`, func(_ string, params map[string]interface{}) { + require.Equal(t, map[string]interface{}{ + "owner": "OWNER", + "repo": "REPO", + "type": "ISSUE", + "limit": float64(30), + "query": "just used to force the search API branch repo:OWNER/REPO type:issue", + }, params) + })) + + client := &http.Client{Transport: reg} + issuesAndTotalCount, err := issueList( + client, + ghrepo.New("OWNER", "REPO"), + prShared.FilterOptions{ + Entity: "issue", + Search: "just used to force the search API branch", + }, + 30, + ) + + require.NoError(t, err) + require.Len(t, issuesAndTotalCount.Issues, 1) + require.Len(t, issuesAndTotalCount.Issues[0].ProjectItems.Nodes, 1) + + require.Equal(t, issuesAndTotalCount.Issues[0].ProjectItems.Nodes[0].ID, "PVTI_lAHOAA3WC84AW6WNzgJ8rl0") + + expectedProject := api.ProjectV2ItemProject{ + ID: "PVT_kwHOAA3WC84AW6WN", + Title: "Test Public Project", + } + require.Equal(t, issuesAndTotalCount.Issues[0].ProjectItems.Nodes[0].Project, expectedProject) + + expectedStatus := api.ProjectV2ItemStatus{ + OptionID: "47fc9ee4", + Name: "In Progress", + } + require.Equal(t, issuesAndTotalCount.Issues[0].ProjectItems.Nodes[0].Status, expectedStatus) +} diff --git a/pkg/cmd/issue/lock/lock.go b/pkg/cmd/issue/lock/lock.go index e8329974d..4e0dac058 100644 --- a/pkg/cmd/issue/lock/lock.go +++ b/pkg/cmd/issue/lock/lock.go @@ -17,7 +17,7 @@ import ( "strings" "github.com/cli/cli/v2/api" - "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghrepo" issueShared "github.com/cli/cli/v2/pkg/cmd/issue/shared" "github.com/cli/cli/v2/pkg/cmdutil" @@ -92,7 +92,7 @@ func fields() []string { type LockOptions struct { HttpClient func() (*http.Client, error) - Config func() (config.Config, error) + Config func() (gh.Config, error) IO *iostreams.IOStreams BaseRepo func() (ghrepo.Interface, error) Prompter iprompter @@ -103,7 +103,7 @@ type LockOptions struct { Interactive bool } -func (opts *LockOptions) setCommonOptions(f *cmdutil.Factory, cmd *cobra.Command, args []string) { +func (opts *LockOptions) setCommonOptions(f *cmdutil.Factory, args []string) { opts.IO = f.IOStreams opts.HttpClient = f.HttpClient opts.Config = f.Config @@ -129,7 +129,7 @@ func NewCmdLock(f *cmdutil.Factory, parentName string, runF func(string, *LockOp Short: short, Args: cobra.ExactArgs(1), RunE: func(cmd *cobra.Command, args []string) error { - opts.setCommonOptions(f, cmd, args) + opts.setCommonOptions(f, args) reasonProvided := cmd.Flags().Changed("reason") if reasonProvided { @@ -172,7 +172,7 @@ func NewCmdUnlock(f *cmdutil.Factory, parentName string, runF func(string, *Lock Short: short, Args: cobra.ExactArgs(1), RunE: func(cmd *cobra.Command, args []string) error { - opts.setCommonOptions(f, cmd, args) + opts.setCommonOptions(f, args) if runF != nil { return runF(Unlock, opts) @@ -200,9 +200,9 @@ func reason(reason string) string { // is parameterized on a bunch of options. // // Example output: "Locked as RESOLVED: Issue #31 (Title of issue)" -func status(state string, lockable *api.Issue, opts *LockOptions) string { - return fmt.Sprintf("%sed%s: %s #%d (%s)", - state, reason(opts.Reason), alias[opts.ParentCmd].FullName, lockable.Number, lockable.Title) +func status(state string, lockable *api.Issue, baseRepo ghrepo.Interface, opts *LockOptions) string { + return fmt.Sprintf("%sed%s: %s %s#%d (%s)", + state, reason(opts.Reason), alias[opts.ParentCmd].FullName, ghrepo.FullName(baseRepo), lockable.Number, lockable.Title) } // lockRun will lock or unlock a conversation. @@ -224,10 +224,10 @@ func lockRun(state string, opts *LockOptions) error { currentType := alias[parent.Typename] correctType := alias[issuePr.Typename] - return fmt.Errorf("%s %s #%d not found, but found %s #%d. Use `gh %s %s %d` instead", + return fmt.Errorf("%s %s %s#%d not found, but found %s %s#%d. Use `gh %s %s %d` instead", cs.FailureIconWithColor(cs.Red), - currentType.FullName, issuePr.Number, - strings.ToLower(correctType.FullName), issuePr.Number, + currentType.FullName, ghrepo.FullName(baseRepo), issuePr.Number, + strings.ToLower(correctType.FullName), ghrepo.FullName(baseRepo), issuePr.Number, correctType.Name, strings.ToLower(state), issuePr.Number) } @@ -243,7 +243,7 @@ func lockRun(state string, opts *LockOptions) error { } successMsg := fmt.Sprintf("%s %s\n", - cs.SuccessIconWithColor(cs.Green), status(state, issuePr, opts)) + cs.SuccessIconWithColor(cs.Green), status(state, issuePr, baseRepo, opts)) switch state { case Lock: @@ -254,17 +254,17 @@ func lockRun(state string, opts *LockOptions) error { relocked, err = relockLockable(httpClient, baseRepo, issuePr, opts) if !relocked { - successMsg = fmt.Sprintf("%s #%d already locked%s. Nothing changed.\n", - parent.FullName, issuePr.Number, reason(issuePr.ActiveLockReason)) + successMsg = fmt.Sprintf("%s %s#%d already locked%s. Nothing changed.\n", + parent.FullName, ghrepo.FullName(baseRepo), issuePr.Number, reason(issuePr.ActiveLockReason)) } } case Unlock: if issuePr.Locked { - err = unlockLockable(httpClient, baseRepo, issuePr, opts) + err = unlockLockable(httpClient, baseRepo, issuePr) } else { - successMsg = fmt.Sprintf("%s #%d already unlocked. Nothing changed.\n", - parent.FullName, issuePr.Number) + successMsg = fmt.Sprintf("%s %s#%d already unlocked. Nothing changed.\n", + parent.FullName, ghrepo.FullName(baseRepo), issuePr.Number) } default: panic("bad state") @@ -303,7 +303,7 @@ func lockLockable(httpClient *http.Client, repo ghrepo.Interface, lockable *api. } // unlockLockable will unlock an issue or pull request -func unlockLockable(httpClient *http.Client, repo ghrepo.Interface, lockable *api.Issue, opts *LockOptions) error { +func unlockLockable(httpClient *http.Client, repo ghrepo.Interface, lockable *api.Issue) error { var mutation struct { UnlockLockable struct { @@ -334,8 +334,8 @@ func relockLockable(httpClient *http.Client, repo ghrepo.Interface, lockable *ap return false, errors.New("already locked") } - prompt := fmt.Sprintf("%s #%d already locked%s. Unlock and lock again%s?", - alias[opts.ParentCmd].FullName, lockable.Number, reason(lockable.ActiveLockReason), reason(opts.Reason)) + prompt := fmt.Sprintf("%s %s#%d already locked%s. Unlock and lock again%s?", + alias[opts.ParentCmd].FullName, ghrepo.FullName(repo), lockable.Number, reason(lockable.ActiveLockReason), reason(opts.Reason)) relocked, err := opts.Prompter.Confirm(prompt, true) if err != nil { @@ -344,7 +344,7 @@ func relockLockable(httpClient *http.Client, repo ghrepo.Interface, lockable *ap return relocked, nil } - err = unlockLockable(httpClient, repo, lockable, opts) + err = unlockLockable(httpClient, repo, lockable) if err != nil { return relocked, err } diff --git a/pkg/cmd/issue/lock/lock_test.go b/pkg/cmd/issue/lock/lock_test.go index c6eb902ef..f6dcb746d 100644 --- a/pkg/cmd/issue/lock/lock_test.go +++ b/pkg/cmd/issue/lock/lock_test.go @@ -234,7 +234,7 @@ func Test_runLock(t *testing.T) { return -1, prompter.NoSuchPromptErr(p) } }, - wantOut: "✓ Locked as TOO_HEATED: Issue #451 (traverse the library)\n", + wantOut: "✓ Locked as TOO_HEATED: Issue OWNER/REPO#451 (traverse the library)\n", }, { name: "lock issue with explicit reason tty", @@ -261,7 +261,7 @@ func Test_runLock(t *testing.T) { "lockedRecord": { "locked": true }}}}`)) }, - wantOut: "✓ Locked as OFF_TOPIC: Issue #451 (traverse the library)\n", + wantOut: "✓ Locked as OFF_TOPIC: Issue OWNER/REPO#451 (traverse the library)\n", }, { name: "unlock issue tty", @@ -288,7 +288,7 @@ func Test_runLock(t *testing.T) { "unlockedRecord": { "locked": false }}}}`)) }, - wantOut: "✓ Unlocked: Issue #451 (traverse the library)\n", + wantOut: "✓ Unlocked: Issue OWNER/REPO#451 (traverse the library)\n", }, { name: "unlock issue nontty", @@ -375,14 +375,14 @@ func Test_runLock(t *testing.T) { }, promptStubs: func(t *testing.T, pm *prompter.PrompterMock) { pm.ConfirmFunc = func(p string, d bool) (bool, error) { - if p == "Issue #451 already locked. Unlock and lock again as OFF_TOPIC?" { + if p == "Issue OWNER/REPO#451 already locked. Unlock and lock again as OFF_TOPIC?" { return true, nil } return false, prompter.NoSuchPromptErr(p) } }, - wantOut: "✓ Locked as OFF_TOPIC: Issue #451 (traverse the library)\n", + wantOut: "✓ Locked as OFF_TOPIC: Issue OWNER/REPO#451 (traverse the library)\n", }, { name: "relock issue nontty", @@ -462,7 +462,7 @@ func Test_runLock(t *testing.T) { return -1, prompter.NoSuchPromptErr(p) } }, - wantOut: "✓ Locked as TOO_HEATED: Pull request #451 (traverse the library)\n", + wantOut: "✓ Locked as TOO_HEATED: Pull request OWNER/REPO#451 (traverse the library)\n", }, { name: "lock pr with explicit reason tty", @@ -489,7 +489,7 @@ func Test_runLock(t *testing.T) { "lockedRecord": { "locked": true }}}}`)) }, - wantOut: "✓ Locked as OFF_TOPIC: Pull request #451 (traverse the library)\n", + wantOut: "✓ Locked as OFF_TOPIC: Pull request OWNER/REPO#451 (traverse the library)\n", }, { name: "lock pr with explicit nontty", @@ -566,7 +566,7 @@ func Test_runLock(t *testing.T) { "unlockedRecord": { "locked": false }}}}`)) }, - wantOut: "✓ Unlocked: Pull request #451 (traverse the library)\n", + wantOut: "✓ Unlocked: Pull request OWNER/REPO#451 (traverse the library)\n", }, { name: "relock pr tty", @@ -603,14 +603,14 @@ func Test_runLock(t *testing.T) { }, promptStubs: func(t *testing.T, pm *prompter.PrompterMock) { pm.ConfirmFunc = func(p string, d bool) (bool, error) { - if p == "Pull request #451 already locked. Unlock and lock again as OFF_TOPIC?" { + if p == "Pull request OWNER/REPO#451 already locked. Unlock and lock again as OFF_TOPIC?" { return true, nil } return false, prompter.NoSuchPromptErr(p) } }, - wantOut: "✓ Locked as OFF_TOPIC: Pull request #451 (traverse the library)\n", + wantOut: "✓ Locked as OFF_TOPIC: Pull request OWNER/REPO#451 (traverse the library)\n", }, { name: "relock pr nontty", diff --git a/pkg/cmd/issue/pin/pin.go b/pkg/cmd/issue/pin/pin.go index 3963cb8ee..dfb11a881 100644 --- a/pkg/cmd/issue/pin/pin.go +++ b/pkg/cmd/issue/pin/pin.go @@ -6,7 +6,7 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/api" - "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/pkg/cmd/issue/shared" "github.com/cli/cli/v2/pkg/cmdutil" @@ -17,7 +17,7 @@ import ( type PinOptions struct { HttpClient func() (*http.Client, error) - Config func() (config.Config, error) + Config func() (gh.Config, error) IO *iostreams.IOStreams BaseRepo func() (ghrepo.Interface, error) SelectorArg string @@ -79,7 +79,7 @@ func pinRun(opts *PinOptions) error { } if issue.IsPinned { - fmt.Fprintf(opts.IO.ErrOut, "%s Issue #%d (%s) is already pinned to %s\n", cs.Yellow("!"), issue.Number, issue.Title, ghrepo.FullName(baseRepo)) + fmt.Fprintf(opts.IO.ErrOut, "%s Issue %s#%d (%s) is already pinned\n", cs.Yellow("!"), ghrepo.FullName(baseRepo), issue.Number, issue.Title) return nil } @@ -88,7 +88,7 @@ func pinRun(opts *PinOptions) error { return err } - fmt.Fprintf(opts.IO.ErrOut, "%s Pinned issue #%d (%s) to %s\n", cs.SuccessIcon(), issue.Number, issue.Title, ghrepo.FullName(baseRepo)) + fmt.Fprintf(opts.IO.ErrOut, "%s Pinned issue %s#%d (%s)\n", cs.SuccessIcon(), ghrepo.FullName(baseRepo), issue.Number, issue.Title) return nil } diff --git a/pkg/cmd/issue/pin/pin_test.go b/pkg/cmd/issue/pin/pin_test.go index c78dfd414..d4979a30d 100644 --- a/pkg/cmd/issue/pin/pin_test.go +++ b/pkg/cmd/issue/pin/pin_test.go @@ -6,6 +6,7 @@ import ( "testing" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/httpmock" @@ -107,7 +108,7 @@ func TestPinRun(t *testing.T) { ) }, wantStdout: "", - wantStderr: "✓ Pinned issue #20 (Issue Title) to OWNER/REPO\n", + wantStderr: "✓ Pinned issue OWNER/REPO#20 (Issue Title)\n", }, { name: "issue already pinned", @@ -122,7 +123,7 @@ func TestPinRun(t *testing.T) { } } }`), ) }, - wantStderr: "! Issue #20 (Issue Title) is already pinned to OWNER/REPO\n", + wantStderr: "! Issue OWNER/REPO#20 (Issue Title) is already pinned\n", }, } for _, tt := range tests { @@ -139,7 +140,7 @@ func TestPinRun(t *testing.T) { ios.SetStdoutTTY(tt.tty) tt.opts.IO = ios - tt.opts.Config = func() (config.Config, error) { + tt.opts.Config = func() (gh.Config, error) { return config.NewBlankConfig(), nil } diff --git a/pkg/cmd/issue/reopen/reopen.go b/pkg/cmd/issue/reopen/reopen.go index cb2ccb5af..92f18a7d9 100644 --- a/pkg/cmd/issue/reopen/reopen.go +++ b/pkg/cmd/issue/reopen/reopen.go @@ -5,7 +5,7 @@ import ( "net/http" "github.com/cli/cli/v2/api" - "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/pkg/cmd/issue/shared" prShared "github.com/cli/cli/v2/pkg/cmd/pr/shared" @@ -17,7 +17,7 @@ import ( type ReopenOptions struct { HttpClient func() (*http.Client, error) - Config func() (config.Config, error) + Config func() (gh.Config, error) IO *iostreams.IOStreams BaseRepo func() (ghrepo.Interface, error) @@ -70,7 +70,7 @@ func reopenRun(opts *ReopenOptions) error { } if issue.State == "OPEN" { - fmt.Fprintf(opts.IO.ErrOut, "%s Issue #%d (%s) is already open\n", cs.Yellow("!"), issue.Number, issue.Title) + fmt.Fprintf(opts.IO.ErrOut, "%s Issue %s#%d (%s) is already open\n", cs.Yellow("!"), ghrepo.FullName(baseRepo), issue.Number, issue.Title) return nil } @@ -95,7 +95,7 @@ func reopenRun(opts *ReopenOptions) error { return err } - fmt.Fprintf(opts.IO.ErrOut, "%s Reopened issue #%d (%s)\n", cs.SuccessIconWithColor(cs.Green), issue.Number, issue.Title) + fmt.Fprintf(opts.IO.ErrOut, "%s Reopened issue %s#%d (%s)\n", cs.SuccessIconWithColor(cs.Green), ghrepo.FullName(baseRepo), issue.Number, issue.Title) return nil } diff --git a/pkg/cmd/issue/reopen/reopen_test.go b/pkg/cmd/issue/reopen/reopen_test.go index 1e799b6f3..4b8b33ee1 100644 --- a/pkg/cmd/issue/reopen/reopen_test.go +++ b/pkg/cmd/issue/reopen/reopen_test.go @@ -8,6 +8,7 @@ import ( "testing" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/httpmock" @@ -28,7 +29,7 @@ func runCommand(rt http.RoundTripper, isTTY bool, cli string) (*test.CmdOut, err HttpClient: func() (*http.Client, error) { return &http.Client{Transport: rt}, nil }, - Config: func() (config.Config, error) { + Config: func() (gh.Config, error) { return config.NewBlankConfig(), nil }, BaseRepo: func() (ghrepo.Interface, error) { @@ -80,7 +81,7 @@ func TestIssueReopen(t *testing.T) { t.Fatalf("error running command `issue reopen`: %v", err) } - r := regexp.MustCompile(`Reopened issue #2 \(The title of the issue\)`) + r := regexp.MustCompile(`Reopened issue OWNER/REPO#2 \(The title of the issue\)`) if !r.MatchString(output.Stderr()) { t.Fatalf("output did not match regexp /%s/\n> output\n%q\n", r, output.Stderr()) @@ -105,7 +106,7 @@ func TestIssueReopen_alreadyOpen(t *testing.T) { t.Fatalf("error running command `issue reopen`: %v", err) } - r := regexp.MustCompile(`Issue #2 \(The title of the issue\) is already open`) + r := regexp.MustCompile(`Issue OWNER/REPO#2 \(The title of the issue\) is already open`) if !r.MatchString(output.Stderr()) { t.Fatalf("output did not match regexp /%s/\n> output\n%q\n", r, output.Stderr()) @@ -181,7 +182,7 @@ func TestIssueReopen_withComment(t *testing.T) { t.Fatalf("error running command `issue reopen`: %v", err) } - r := regexp.MustCompile(`Reopened issue #2 \(The title of the issue\)`) + r := regexp.MustCompile(`Reopened issue OWNER/REPO#2 \(The title of the issue\)`) if !r.MatchString(output.Stderr()) { t.Fatalf("output did not match regexp /%s/\n> output\n%q\n", r, output.Stderr()) diff --git a/pkg/cmd/issue/shared/display.go b/pkg/cmd/issue/shared/display.go index efb8398ce..0c56ffd2c 100644 --- a/pkg/cmd/issue/shared/display.go +++ b/pkg/cmd/issue/shared/display.go @@ -7,33 +7,38 @@ import ( "time" "github.com/cli/cli/v2/api" + "github.com/cli/cli/v2/internal/tableprinter" "github.com/cli/cli/v2/internal/text" prShared "github.com/cli/cli/v2/pkg/cmd/pr/shared" "github.com/cli/cli/v2/pkg/iostreams" - "github.com/cli/cli/v2/utils" ) func PrintIssues(io *iostreams.IOStreams, now time.Time, prefix string, totalCount int, issues []api.Issue) { cs := io.ColorScheme() - //nolint:staticcheck // SA1019: utils.NewTablePrinter is deprecated: use internal/tableprinter - table := utils.NewTablePrinter(io) + isTTY := io.IsStdoutTTY() + headers := []string{"ID"} + if !isTTY { + headers = append(headers, "STATE") + } + headers = append(headers, + "TITLE", + "LABELS", + "UPDATED", + ) + table := tableprinter.New(io, tableprinter.WithHeader(headers...)) for _, issue := range issues { issueNum := strconv.Itoa(issue.Number) - if table.IsTTY() { + if isTTY { issueNum = "#" + issueNum } issueNum = prefix + issueNum - table.AddField(issueNum, nil, cs.ColorFromString(prShared.ColorForIssueState(issue))) - if !table.IsTTY() { - table.AddField(issue.State, nil, nil) - } - table.AddField(text.RemoveExcessiveWhitespace(issue.Title), nil, nil) - table.AddField(issueLabelList(&issue, cs, table.IsTTY()), nil, nil) - if table.IsTTY() { - table.AddField(text.FuzzyAgo(now, issue.UpdatedAt), nil, cs.Gray) - } else { - table.AddField(issue.UpdatedAt.String(), nil, nil) + table.AddField(issueNum, tableprinter.WithColor(cs.ColorFromString(prShared.ColorForIssueState(issue)))) + if !isTTY { + table.AddField(issue.State) } + table.AddField(text.RemoveExcessiveWhitespace(issue.Title)) + table.AddField(issueLabelList(&issue, cs, isTTY)) + table.AddTimeField(now, issue.UpdatedAt, cs.Gray) table.EndRow() } _ = table.Render() diff --git a/pkg/cmd/issue/shared/lookup.go b/pkg/cmd/issue/shared/lookup.go index 1aa58c951..f93b0867d 100644 --- a/pkg/cmd/issue/shared/lookup.go +++ b/pkg/cmd/issue/shared/lookup.go @@ -100,7 +100,7 @@ func IssuesFromArgsWithFields(httpClient *http.Client, baseRepoFn func() (ghrepo return issues, issuesRepo, nil } -var issueURLRE = regexp.MustCompile(`^/([^/]+)/([^/]+)/issues/(\d+)`) +var issueURLRE = regexp.MustCompile(`^/([^/]+)/([^/]+)/(?:issues|pull)/(\d+)`) func issueMetadataFromURL(s string) (int, ghrepo.Interface) { u, err := url.Parse(s) diff --git a/pkg/cmd/issue/shared/lookup_test.go b/pkg/cmd/issue/shared/lookup_test.go index 694a3fd05..44f496de4 100644 --- a/pkg/cmd/issue/shared/lookup_test.go +++ b/pkg/cmd/issue/shared/lookup_test.go @@ -79,6 +79,23 @@ func TestIssueFromArgWithFields(t *testing.T) { wantIssue: 13, wantRepo: "https://example.org/OWNER/REPO", }, + { + name: "PR URL argument", + args: args{ + selector: "https://example.org/OWNER/REPO/pull/13#comment-123", + baseRepoFn: nil, + }, + httpStub: func(r *httpmock.Registry) { + r.Register( + httpmock.GraphQL(`query IssueByNumber\b`), + httpmock.StringResponse(`{"data":{"repository":{ + "hasIssuesEnabled": true, + "issue":{"number":13} + }}}`)) + }, + wantIssue: 13, + wantRepo: "https://example.org/OWNER/REPO", + }, { name: "project cards permission issue", args: args{ diff --git a/pkg/cmd/issue/status/status.go b/pkg/cmd/issue/status/status.go index c9db94c98..a57cd7d9e 100644 --- a/pkg/cmd/issue/status/status.go +++ b/pkg/cmd/issue/status/status.go @@ -6,7 +6,7 @@ import ( "time" "github.com/cli/cli/v2/api" - "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghrepo" issueShared "github.com/cli/cli/v2/pkg/cmd/issue/shared" prShared "github.com/cli/cli/v2/pkg/cmd/pr/shared" @@ -17,7 +17,7 @@ import ( type StatusOptions struct { HttpClient func() (*http.Client, error) - Config func() (config.Config, error) + Config func() (gh.Config, error) IO *iostreams.IOStreams BaseRepo func() (ghrepo.Interface, error) diff --git a/pkg/cmd/issue/status/status_test.go b/pkg/cmd/issue/status/status_test.go index 297b45c06..6fddf3b0c 100644 --- a/pkg/cmd/issue/status/status_test.go +++ b/pkg/cmd/issue/status/status_test.go @@ -8,6 +8,7 @@ import ( "testing" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/httpmock" @@ -27,7 +28,7 @@ func runCommand(rt http.RoundTripper, isTTY bool, cli string) (*test.CmdOut, err HttpClient: func() (*http.Client, error) { return &http.Client{Transport: rt}, nil }, - Config: func() (config.Config, error) { + Config: func() (gh.Config, error) { return config.NewBlankConfig(), nil }, BaseRepo: func() (ghrepo.Interface, error) { diff --git a/pkg/cmd/issue/transfer/transfer.go b/pkg/cmd/issue/transfer/transfer.go index 46b7a6c38..140d02b91 100644 --- a/pkg/cmd/issue/transfer/transfer.go +++ b/pkg/cmd/issue/transfer/transfer.go @@ -5,7 +5,7 @@ import ( "net/http" "github.com/cli/cli/v2/api" - "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/pkg/cmd/issue/shared" "github.com/cli/cli/v2/pkg/cmdutil" @@ -16,7 +16,7 @@ import ( type TransferOptions struct { HttpClient func() (*http.Client, error) - Config func() (config.Config, error) + Config func() (gh.Config, error) IO *iostreams.IOStreams BaseRepo func() (ghrepo.Interface, error) @@ -62,7 +62,7 @@ func transferRun(opts *TransferOptions) error { return err } if issue.IsPullRequest() { - return fmt.Errorf("issue #%d is a pull request and cannot be transferred", issue.Number) + return fmt.Errorf("issue %s#%d is a pull request and cannot be transferred", ghrepo.FullName(baseRepo), issue.Number) } destRepo, err := ghrepo.FromFullNameWithHost(opts.DestRepoSelector, baseRepo.RepoHost()) diff --git a/pkg/cmd/issue/transfer/transfer_test.go b/pkg/cmd/issue/transfer/transfer_test.go index 1f2f665e0..eed9c5d85 100644 --- a/pkg/cmd/issue/transfer/transfer_test.go +++ b/pkg/cmd/issue/transfer/transfer_test.go @@ -7,6 +7,7 @@ import ( "testing" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/httpmock" @@ -24,7 +25,7 @@ func runCommand(rt http.RoundTripper, cli string) (*test.CmdOut, error) { HttpClient: func() (*http.Client, error) { return &http.Client{Transport: rt}, nil }, - Config: func() (config.Config, error) { + Config: func() (gh.Config, error) { return config.NewBlankConfig(), nil }, BaseRepo: func() (ghrepo.Interface, error) { diff --git a/pkg/cmd/issue/unpin/unpin.go b/pkg/cmd/issue/unpin/unpin.go index 8ce340124..3ac28d47c 100644 --- a/pkg/cmd/issue/unpin/unpin.go +++ b/pkg/cmd/issue/unpin/unpin.go @@ -6,7 +6,7 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/api" - "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/pkg/cmd/issue/shared" "github.com/cli/cli/v2/pkg/cmdutil" @@ -17,7 +17,7 @@ import ( type UnpinOptions struct { HttpClient func() (*http.Client, error) - Config func() (config.Config, error) + Config func() (gh.Config, error) IO *iostreams.IOStreams BaseRepo func() (ghrepo.Interface, error) SelectorArg string @@ -79,7 +79,7 @@ func unpinRun(opts *UnpinOptions) error { } if !issue.IsPinned { - fmt.Fprintf(opts.IO.ErrOut, "%s Issue #%d (%s) is not pinned to %s\n", cs.Yellow("!"), issue.Number, issue.Title, ghrepo.FullName(baseRepo)) + fmt.Fprintf(opts.IO.ErrOut, "%s Issue %s#%d (%s) is not pinned\n", cs.Yellow("!"), ghrepo.FullName(baseRepo), issue.Number, issue.Title) return nil } @@ -88,7 +88,7 @@ func unpinRun(opts *UnpinOptions) error { return err } - fmt.Fprintf(opts.IO.ErrOut, "%s Unpinned issue #%d (%s) from %s\n", cs.SuccessIconWithColor(cs.Red), issue.Number, issue.Title, ghrepo.FullName(baseRepo)) + fmt.Fprintf(opts.IO.ErrOut, "%s Unpinned issue %s#%d (%s)\n", cs.SuccessIconWithColor(cs.Red), ghrepo.FullName(baseRepo), issue.Number, issue.Title) return nil } diff --git a/pkg/cmd/issue/unpin/unpin_test.go b/pkg/cmd/issue/unpin/unpin_test.go index b8c5ee82e..70a018d94 100644 --- a/pkg/cmd/issue/unpin/unpin_test.go +++ b/pkg/cmd/issue/unpin/unpin_test.go @@ -6,6 +6,7 @@ import ( "testing" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/httpmock" @@ -107,7 +108,7 @@ func TestUnpinRun(t *testing.T) { ) }, wantStdout: "", - wantStderr: "✓ Unpinned issue #20 (Issue Title) from OWNER/REPO\n", + wantStderr: "✓ Unpinned issue OWNER/REPO#20 (Issue Title)\n", }, { name: "issue not pinned", @@ -122,7 +123,7 @@ func TestUnpinRun(t *testing.T) { } } }`), ) }, - wantStderr: "! Issue #20 (Issue Title) is not pinned to OWNER/REPO\n", + wantStderr: "! Issue OWNER/REPO#20 (Issue Title) is not pinned\n", }, } for _, tt := range tests { @@ -139,7 +140,7 @@ func TestUnpinRun(t *testing.T) { ios.SetStdoutTTY(tt.tty) tt.opts.IO = ios - tt.opts.Config = func() (config.Config, error) { + tt.opts.Config = func() (gh.Config, error) { return config.NewBlankConfig(), nil } diff --git a/pkg/cmd/issue/view/view.go b/pkg/cmd/issue/view/view.go index 83132291f..b188c6a4c 100644 --- a/pkg/cmd/issue/view/view.go +++ b/pkg/cmd/issue/view/view.go @@ -48,11 +48,11 @@ func NewCmdView(f *cmdutil.Factory, runF func(*ViewOptions) error) *cobra.Comman cmd := &cobra.Command{ Use: "view { | }", Short: "View an issue", - Long: heredoc.Doc(` + Long: heredoc.Docf(` Display the title, body, and other information about an issue. - With '--web', open the issue in a web browser instead. - `), + With %[1]s--web%[1]s flag, open the issue in a web browser instead. + `, "`"), Args: cobra.ExactArgs(1), RunE: func(cmd *cobra.Command, args []string) error { // support `-R, --repo` override @@ -103,7 +103,7 @@ func viewRun(opts *ViewOptions) error { opts.IO.DetectTerminalTheme() opts.IO.StartProgressIndicator() - issue, err := findIssue(httpClient, opts.BaseRepo, opts.SelectorArg, lookupFields.ToSlice()) + issue, baseRepo, err := findIssue(httpClient, opts.BaseRepo, opts.SelectorArg, lookupFields.ToSlice()) opts.IO.StopProgressIndicator() if err != nil { var loadErr *issueShared.PartialLoadError @@ -132,7 +132,7 @@ func viewRun(opts *ViewOptions) error { } if opts.IO.IsStdoutTTY() { - return printHumanIssuePreview(opts, issue) + return printHumanIssuePreview(opts, baseRepo, issue) } if opts.Comments { @@ -143,14 +143,14 @@ func viewRun(opts *ViewOptions) error { return printRawIssuePreview(opts.IO.Out, issue) } -func findIssue(client *http.Client, baseRepoFn func() (ghrepo.Interface, error), selector string, fields []string) (*api.Issue, error) { +func findIssue(client *http.Client, baseRepoFn func() (ghrepo.Interface, error), selector string, fields []string) (*api.Issue, ghrepo.Interface, error) { fieldSet := set.NewStringSet() fieldSet.AddValues(fields) fieldSet.Add("id") issue, repo, err := issueShared.IssueFromArgWithFields(client, baseRepoFn, selector, fieldSet.ToSlice()) if err != nil { - return issue, err + return issue, repo, err } if fieldSet.Contains("comments") { @@ -158,7 +158,7 @@ func findIssue(client *http.Client, baseRepoFn func() (ghrepo.Interface, error), // fetched in the previous request. err = preloadIssueComments(client, repo, issue) } - return issue, err + return issue, repo, err } func printRawIssuePreview(out io.Writer, issue *api.Issue) error { @@ -186,12 +186,12 @@ func printRawIssuePreview(out io.Writer, issue *api.Issue) error { return nil } -func printHumanIssuePreview(opts *ViewOptions, issue *api.Issue) error { +func printHumanIssuePreview(opts *ViewOptions, baseRepo ghrepo.Interface, issue *api.Issue) error { out := opts.IO.Out cs := opts.IO.ColorScheme() // Header (Title and State) - fmt.Fprintf(out, "%s #%d\n", cs.Bold(issue.Title), issue.Number) + fmt.Fprintf(out, "%s %s#%d\n", cs.Bold(issue.Title), ghrepo.FullName(baseRepo), issue.Number) fmt.Fprintf(out, "%s • %s opened %s • %s\n", issueStateTitleWithColor(cs, issue), diff --git a/pkg/cmd/issue/view/view_test.go b/pkg/cmd/issue/view/view_test.go index 2c4e7934e..2f91ba13e 100644 --- a/pkg/cmd/issue/view/view_test.go +++ b/pkg/cmd/issue/view/view_test.go @@ -10,6 +10,7 @@ import ( "github.com/cli/cli/v2/internal/browser" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/internal/run" "github.com/cli/cli/v2/pkg/cmdutil" @@ -31,7 +32,7 @@ func runCommand(rt http.RoundTripper, isTTY bool, cli string) (*test.CmdOut, err HttpClient: func() (*http.Client, error) { return &http.Client{Transport: rt}, nil }, - Config: func() (config.Config, error) { + Config: func() (gh.Config, error) { return config.NewBlankConfig(), nil }, BaseRepo: func() (ghrepo.Interface, error) { @@ -183,7 +184,7 @@ func TestIssueView_tty_Preview(t *testing.T) { "Open issue without metadata": { fixture: "./fixtures/issueView_preview.json", expectedOutputs: []string{ - `ix of coins #123`, + `ix of coins OWNER/REPO#123`, `Open.*marseilles opened about 9 years ago.*9 comments`, `bold story`, `View this issue on GitHub: https://github.com/OWNER/REPO/issues/123`, @@ -192,7 +193,7 @@ func TestIssueView_tty_Preview(t *testing.T) { "Open issue with metadata": { fixture: "./fixtures/issueView_previewWithMetadata.json", expectedOutputs: []string{ - `ix of coins #123`, + `ix of coins OWNER/REPO#123`, `Open.*marseilles opened about 9 years ago.*9 comments`, `8 \x{1f615} • 7 \x{1f440} • 6 \x{2764}\x{fe0f} • 5 \x{1f389} • 4 \x{1f604} • 3 \x{1f680} • 2 \x{1f44e} • 1 \x{1f44d}`, `Assignees:.*marseilles, monaco\n`, @@ -206,7 +207,7 @@ func TestIssueView_tty_Preview(t *testing.T) { "Open issue with empty body": { fixture: "./fixtures/issueView_previewWithEmptyBody.json", expectedOutputs: []string{ - `ix of coins #123`, + `ix of coins OWNER/REPO#123`, `Open.*marseilles opened about 9 years ago.*9 comments`, `No description provided`, `View this issue on GitHub: https://github.com/OWNER/REPO/issues/123`, @@ -215,7 +216,7 @@ func TestIssueView_tty_Preview(t *testing.T) { "Closed issue": { fixture: "./fixtures/issueView_previewClosedState.json", expectedOutputs: []string{ - `ix of coins #123`, + `ix of coins OWNER/REPO#123`, `Closed.*marseilles opened about 9 years ago.*9 comments`, `bold story`, `View this issue on GitHub: https://github.com/OWNER/REPO/issues/123`, @@ -329,7 +330,7 @@ func TestIssueView_tty_Comments(t *testing.T) { "IssueByNumber": "./fixtures/issueView_previewSingleComment.json", }, expectedOutputs: []string{ - `some title #123`, + `some title OWNER/REPO#123`, `some body`, `———————— Not showing 5 comments ————————`, `marseilles \(Collaborator\) • Jan 1, 2020 • Newest comment`, @@ -345,7 +346,7 @@ func TestIssueView_tty_Comments(t *testing.T) { "CommentsForIssue": "./fixtures/issueView_previewFullComments.json", }, expectedOutputs: []string{ - `some title #123`, + `some title OWNER/REPO#123`, `some body`, `monalisa • Jan 1, 2020 • Edited`, `1 \x{1f615} • 2 \x{1f440} • 3 \x{2764}\x{fe0f} • 4 \x{1f389} • 5 \x{1f604} • 6 \x{1f680} • 7 \x{1f44e} • 8 \x{1f44d}`, diff --git a/pkg/cmd/label/clone.go b/pkg/cmd/label/clone.go index 302de145a..81ab76958 100644 --- a/pkg/cmd/label/clone.go +++ b/pkg/cmd/label/clone.go @@ -34,7 +34,7 @@ func newCmdClone(f *cmdutil.Factory, runF func(*cloneOptions) error) *cobra.Comm cmd := &cobra.Command{ Use: "clone ", Short: "Clones labels from one repository to another", - Long: heredoc.Doc(` + Long: heredoc.Docf(` Clones labels from a source repository to a destination repository on GitHub. By default, the destination repository is the current repository. @@ -44,8 +44,8 @@ func newCmdClone(f *cmdutil.Factory, runF func(*cloneOptions) error) *cobra.Comm Labels from the source repository that already exist in the destination repository will be skipped. You can overwrite existing labels in the - destination repository using the --force flag. - `), + destination repository using the %[1]s--force%[1]s flag. + `, "`"), Example: heredoc.Doc(` # clone and overwrite labels from cli/cli repository into the current repository $ gh label clone cli/cli --force diff --git a/pkg/cmd/label/create.go b/pkg/cmd/label/create.go index 0a88fbcab..8db57a415 100644 --- a/pkg/cmd/label/create.go +++ b/pkg/cmd/label/create.go @@ -57,14 +57,14 @@ func newCmdCreate(f *cmdutil.Factory, runF func(*createOptions) error) *cobra.Co cmd := &cobra.Command{ Use: "create ", Short: "Create a new label", - Long: heredoc.Doc(` - Create a new label on GitHub, or updates an existing one with --force. + Long: heredoc.Docf(` + Create a new label on GitHub, or update an existing one with %[1]s--force%[1]s. Must specify name for the label. The description and color are optional. If a color isn't provided, a random one will be chosen. The label color needs to be 6 character hex value. - `), + `, "`"), Example: heredoc.Doc(` # create new bug label $ gh label create bug --description "Something isn't working" --color E99695 @@ -137,8 +137,7 @@ func createLabel(client *http.Client, repo ghrepo.Interface, opts *createOptions return err } requestBody := bytes.NewReader(requestByte) - result := label{} - err = apiClient.REST(repo.RepoHost(), "POST", path, requestBody, &result) + err = apiClient.REST(repo.RepoHost(), "POST", path, requestBody, nil) if httpError, ok := err.(api.HTTPError); ok && isLabelAlreadyExistsError(httpError) { err = errLabelAlreadyExists @@ -173,8 +172,7 @@ func updateLabel(apiClient *api.Client, repo ghrepo.Interface, opts *editOptions return err } requestBody := bytes.NewReader(requestByte) - result := label{} - err = apiClient.REST(repo.RepoHost(), "PATCH", path, requestBody, &result) + err = apiClient.REST(repo.RepoHost(), "PATCH", path, requestBody, nil) if httpError, ok := err.(api.HTTPError); ok && isLabelAlreadyExistsError(httpError) { err = errLabelAlreadyExists diff --git a/pkg/cmd/label/list.go b/pkg/cmd/label/list.go index 5ad056115..7b4c95ed1 100644 --- a/pkg/cmd/label/list.go +++ b/pkg/cmd/label/list.go @@ -7,10 +7,10 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/internal/browser" "github.com/cli/cli/v2/internal/ghrepo" + "github.com/cli/cli/v2/internal/tableprinter" "github.com/cli/cli/v2/internal/text" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" - "github.com/cli/cli/v2/utils" "github.com/spf13/cobra" ) @@ -134,13 +134,12 @@ func listRun(opts *listOptions) error { func printLabels(io *iostreams.IOStreams, labels []label) error { cs := io.ColorScheme() - //nolint:staticcheck // SA1019: utils.NewTablePrinter is deprecated: use internal/tableprinter - table := utils.NewTablePrinter(io) + table := tableprinter.New(io, tableprinter.WithHeader("NAME", "DESCRIPTION", "COLOR")) for _, label := range labels { - table.AddField(label.Name, nil, cs.ColorFromRGB(label.Color)) - table.AddField(label.Description, text.Truncate, nil) - table.AddField("#"+label.Color, nil, nil) + table.AddField(label.Name, tableprinter.WithColor(cs.ColorFromRGB(label.Color))) + table.AddField(label.Description) + table.AddField("#" + label.Color) table.EndRow() } diff --git a/pkg/cmd/label/list_test.go b/pkg/cmd/label/list_test.go index 7e7a9a93d..37f458439 100644 --- a/pkg/cmd/label/list_test.go +++ b/pkg/cmd/label/list_test.go @@ -215,7 +215,14 @@ func TestListRun(t *testing.T) { ), ) }, - wantStdout: "\nShowing 2 of 2 labels in OWNER/REPO\n\nbug This is a bug label #d73a4a\ndocs This is a docs label #ffa8da\n", + wantStdout: heredoc.Doc(` + + Showing 2 of 2 labels in OWNER/REPO + + NAME DESCRIPTION COLOR + bug This is a bug label #d73a4a + docs This is a docs label #ffa8da + `), }, { name: "lists labels notty", @@ -343,6 +350,7 @@ func TestListRun(t *testing.T) { Showing 2 of 2 labels in OWNER/REPO + NAME DESCRIPTION COLOR bug This is a bug label #d73a4a docs This is a docs label #ffa8da `), diff --git a/pkg/cmd/label/shared.go b/pkg/cmd/label/shared.go index b9886f914..a189721d7 100644 --- a/pkg/cmd/label/shared.go +++ b/pkg/cmd/label/shared.go @@ -1,9 +1,9 @@ package label import ( - "reflect" - "strings" "time" + + "github.com/cli/cli/v2/pkg/cmdutil" ) var labelFields = []string{ @@ -21,31 +21,13 @@ type label struct { Color string `json:"color"` CreatedAt time.Time `json:"createdAt"` Description string `json:"description"` - ID string `json:"node_id"` + ID string `json:"id"` IsDefault bool `json:"isDefault"` Name string `json:"name"` URL string `json:"url"` UpdatedAt time.Time `json:"updatedAt"` } -// ExportData implements cmdutil.exportable func (l *label) ExportData(fields []string) map[string]interface{} { - v := reflect.ValueOf(l).Elem() - data := map[string]interface{}{} - - for _, f := range fields { - switch f { - default: - sf := fieldByName(v, f) - data[f] = sf.Interface() - } - } - - return data -} - -func fieldByName(v reflect.Value, field string) reflect.Value { - return v.FieldByNameFunc(func(s string) bool { - return strings.EqualFold(field, s) - }) + return cmdutil.StructExportData(l, fields) } diff --git a/pkg/cmd/org/list/list.go b/pkg/cmd/org/list/list.go index 54e5daf5a..0c2b96f78 100644 --- a/pkg/cmd/org/list/list.go +++ b/pkg/cmd/org/list/list.go @@ -5,8 +5,7 @@ import ( "net/http" "github.com/MakeNowJust/heredoc" - "github.com/cli/cli/v2/internal/config" - "github.com/cli/cli/v2/internal/tableprinter" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/text" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" @@ -15,7 +14,7 @@ import ( type ListOptions struct { IO *iostreams.IOStreams - Config func() (config.Config, error) + Config func() (gh.Config, error) HttpClient func() (*http.Client, error) Limit int @@ -85,16 +84,8 @@ func listRun(opts *ListOptions) error { fmt.Fprintf(opts.IO.Out, "\n%s\n\n", header) } - table := tableprinter.New(opts.IO) - for _, org := range listResult.Organizations { - table.AddField(org.Login) - table.EndRow() - } - - err = table.Render() - if err != nil { - return err + fmt.Fprintln(opts.IO.Out, org.Login) } return nil diff --git a/pkg/cmd/org/list/list_test.go b/pkg/cmd/org/list/list_test.go index 8efc0a49e..3f81419e8 100644 --- a/pkg/cmd/org/list/list_test.go +++ b/pkg/cmd/org/list/list_test.go @@ -7,6 +7,7 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/httpmock" "github.com/cli/cli/v2/pkg/iostreams" @@ -95,7 +96,7 @@ func TestListRun(t *testing.T) { r.Register( httpmock.GraphQL(`query OrganizationList\b`), httpmock.StringResponse(` - { "data": { "user": { + { "data": { "user": { "organizations": { "nodes": [], "totalCount": 0 } } } }`, ), @@ -224,7 +225,7 @@ cli ios.SetStderrTTY(tt.isTTY) tt.opts.IO = ios - tt.opts.Config = func() (config.Config, error) { + tt.opts.Config = func() (gh.Config, error) { return config.NewBlankConfig(), nil } diff --git a/pkg/cmd/org/org.go b/pkg/cmd/org/org.go index 9c44cf48a..bc95e9082 100644 --- a/pkg/cmd/org/org.go +++ b/pkg/cmd/org/org.go @@ -11,7 +11,7 @@ func NewCmdOrg(f *cmdutil.Factory) *cobra.Command { cmd := &cobra.Command{ Use: "org ", Short: "Manage organizations", - Long: "Work with Github organizations.", + Long: "Work with GitHub organizations.", Example: heredoc.Doc(` $ gh org list `), diff --git a/pkg/cmd/pr/checkout/checkout.go b/pkg/cmd/pr/checkout/checkout.go index 193eea735..f566cbe1d 100644 --- a/pkg/cmd/pr/checkout/checkout.go +++ b/pkg/cmd/pr/checkout/checkout.go @@ -9,7 +9,7 @@ import ( "github.com/cli/cli/v2/api" cliContext "github.com/cli/cli/v2/context" "github.com/cli/cli/v2/git" - "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/pkg/cmd/pr/shared" "github.com/cli/cli/v2/pkg/cmdutil" @@ -20,7 +20,7 @@ import ( type CheckoutOptions struct { HttpClient func() (*http.Client, error) GitClient *git.Client - Config func() (config.Config, error) + Config func() (gh.Config, error) IO *iostreams.IOStreams Remotes func() (cliContext.Remotes, error) Branch func() (string, error) @@ -65,7 +65,7 @@ func NewCmdCheckout(f *cmdutil.Factory, runF func(*CheckoutOptions) error) *cobr cmd.Flags().BoolVarP(&opts.RecurseSubmodules, "recurse-submodules", "", false, "Update all submodules after checkout") cmd.Flags().BoolVarP(&opts.Force, "force", "f", false, "Reset the existing local branch to the latest state of the pull request") cmd.Flags().BoolVarP(&opts.Detach, "detach", "", false, "Checkout PR with a detached HEAD") - cmd.Flags().StringVarP(&opts.BranchName, "branch", "b", "", "Local branch name to use (default: the name of the head branch)") + cmd.Flags().StringVarP(&opts.BranchName, "branch", "b", "", "Local branch name to use (default [the name of the head branch])") return cmd } @@ -84,7 +84,7 @@ func checkoutRun(opts *CheckoutOptions) error { if err != nil { return err } - protocol, _ := cfg.GetOrDefault(baseRepo.RepoHost(), "git_protocol") + protocol := cfg.GitProtocol(baseRepo.RepoHost()).Value remotes, err := opts.Remotes() if err != nil { diff --git a/pkg/cmd/pr/checkout/checkout_test.go b/pkg/cmd/pr/checkout/checkout_test.go index cc9aed0f0..1eda5dda2 100644 --- a/pkg/cmd/pr/checkout/checkout_test.go +++ b/pkg/cmd/pr/checkout/checkout_test.go @@ -12,6 +12,7 @@ import ( "github.com/cli/cli/v2/context" "github.com/cli/cli/v2/git" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/internal/run" "github.com/cli/cli/v2/pkg/cmd/pr/shared" @@ -82,7 +83,7 @@ func Test_checkoutRun(t *testing.T) { finder := shared.NewMockFinder("123", pr, baseRepo) return finder }(), - Config: func() (config.Config, error) { + Config: func() (gh.Config, error) { return config.NewBlankConfig(), nil }, Branch: func() (string, error) { @@ -111,7 +112,7 @@ func Test_checkoutRun(t *testing.T) { finder := shared.NewMockFinder("123", pr, baseRepo) return finder }(), - Config: func() (config.Config, error) { + Config: func() (gh.Config, error) { return config.NewBlankConfig(), nil }, Branch: func() (string, error) { @@ -138,7 +139,7 @@ func Test_checkoutRun(t *testing.T) { finder := shared.NewMockFinder("123", pr, baseRepo) return finder }(), - Config: func() (config.Config, error) { + Config: func() (gh.Config, error) { return config.NewBlankConfig(), nil }, Branch: func() (string, error) { @@ -222,7 +223,7 @@ func runCommand(rt http.RoundTripper, remotes context.Remotes, branch string, cl HttpClient: func() (*http.Client, error) { return &http.Client{Transport: rt}, nil }, - Config: func() (config.Config, error) { + Config: func() (gh.Config, error) { return config.NewBlankConfig(), nil }, Remotes: func() (context.Remotes, error) { diff --git a/pkg/cmd/pr/checks/aggregate.go b/pkg/cmd/pr/checks/aggregate.go index f9f0b73cb..91cec4335 100644 --- a/pkg/cmd/pr/checks/aggregate.go +++ b/pkg/cmd/pr/checks/aggregate.go @@ -6,6 +6,7 @@ import ( "time" "github.com/cli/cli/v2/api" + "github.com/cli/cli/v2/pkg/cmdutil" ) type check struct { @@ -25,6 +26,11 @@ type checkCounts struct { Passed int Pending int Skipping int + Canceled int +} + +func (ch *check) ExportData(fields []string) map[string]interface{} { + return cmdutil.StructExportData(ch, fields) } func aggregateChecks(checkContexts []api.CheckContext, requiredChecks bool) (checks []check, counts checkCounts) { @@ -70,9 +76,12 @@ func aggregateChecks(checkContexts []api.CheckContext, requiredChecks bool) (che case "SKIPPED", "NEUTRAL": item.Bucket = "skipping" counts.Skipping++ - case "ERROR", "FAILURE", "CANCELLED", "TIMED_OUT", "ACTION_REQUIRED": + case "ERROR", "FAILURE", "TIMED_OUT", "ACTION_REQUIRED": item.Bucket = "fail" counts.Failed++ + case "CANCELLED": + item.Bucket = "cancel" + counts.Canceled++ default: // "EXPECTED", "REQUESTED", "WAITING", "QUEUED", "PENDING", "IN_PROGRESS", "STALE" item.Bucket = "pending" counts.Pending++ diff --git a/pkg/cmd/pr/checks/checks.go b/pkg/cmd/pr/checks/checks.go index 335226a9c..bbf2f453b 100644 --- a/pkg/cmd/pr/checks/checks.go +++ b/pkg/cmd/pr/checks/checks.go @@ -20,10 +20,23 @@ import ( const defaultInterval time.Duration = 10 * time.Second +var prCheckFields = []string{ + "name", + "state", + "startedAt", + "completedAt", + "link", + "bucket", + "event", + "workflow", + "description", +} + type ChecksOptions struct { HttpClient func() (*http.Client, error) IO *iostreams.IOStreams Browser browser.Browser + Exporter cmdutil.Exporter Finder shared.PRFinder Detector fd.Detector @@ -97,6 +110,8 @@ func NewCmdChecks(f *cmdutil.Factory, runF func(*ChecksOptions) error) *cobra.Co cmd.Flags().IntVarP(&interval, "interval", "i", 10, "Refresh interval in seconds when using `--watch` flag") cmd.Flags().BoolVar(&opts.Required, "required", false, "Only show checks that are required") + cmdutil.AddJSONFlags(cmd, &opts.Exporter, prCheckFields) + return cmd } @@ -161,6 +176,10 @@ func checksRun(opts *ChecksOptions) error { return err } + if opts.Exporter != nil { + return opts.Exporter.Write(opts.IO, checks) + } + if opts.Watch { opts.IO.StartAlternateScreenBuffer() } else { diff --git a/pkg/cmd/pr/checks/checks_test.go b/pkg/cmd/pr/checks/checks_test.go index 06377e516..cc21043ba 100644 --- a/pkg/cmd/pr/checks/checks_test.go +++ b/pkg/cmd/pr/checks/checks_test.go @@ -7,6 +7,7 @@ import ( "testing" "time" + "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/api" "github.com/cli/cli/v2/internal/browser" fd "github.com/cli/cli/v2/internal/featuredetection" @@ -167,9 +168,37 @@ func Test_checksRun(t *testing.T) { httpmock.FileResponse("./fixtures/someFailing.json"), ) }, - wantOut: "Some checks were not successful\n1 failing, 1 successful, 0 skipped, and 1 pending checks\n\nX sad tests 1m26s sweet link\n✓ cool tests 1m26s sweet link\n* slow tests 1m26s sweet link\n", + wantOut: heredoc.Doc(` + Some checks were not successful + 0 cancelled, 1 failing, 1 successful, 0 skipped, and 1 pending checks + + NAME DESCRIPTION ELAPSED URL + X sad tests 1m26s sweet link + ✓ cool tests 1m26s sweet link + * slow tests 1m26s sweet link + `), wantErr: "SilentError", }, + { + name: "some cancelled tty", + tty: true, + httpStubs: func(reg *httpmock.Registry) { + reg.Register( + httpmock.GraphQL(`query PullRequestStatusChecks\b`), + httpmock.FileResponse("./fixtures/someCancelled.json"), + ) + }, + wantOut: heredoc.Doc(` + Some checks were cancelled + 1 cancelled, 0 failing, 2 successful, 0 skipped, and 0 pending checks + + NAME DESCRIPTION ELAPSED URL + ✓ cool tests 1m26s sweet link + - sad tests 1m26s sweet link + ✓ awesome tests 1m26s sweet link + `), + wantErr: "", + }, { name: "some pending tty", tty: true, @@ -179,7 +208,16 @@ func Test_checksRun(t *testing.T) { httpmock.FileResponse("./fixtures/somePending.json"), ) }, - wantOut: "Some checks are still pending\n0 failing, 2 successful, 0 skipped, and 1 pending checks\n\n✓ cool tests 1m26s sweet link\n✓ rad tests 1m26s sweet link\n* slow tests 1m26s sweet link\n", + wantOut: heredoc.Doc(` + Some checks are still pending + 1 cancelled, 0 failing, 2 successful, 0 skipped, and 1 pending checks + + NAME DESCRIPTION ELAPSED URL + ✓ cool tests 1m26s sweet link + ✓ rad tests 1m26s sweet link + * slow tests 1m26s sweet link + - sad tests 1m26s sweet link + `), wantErr: "PendingError", }, { @@ -191,7 +229,15 @@ func Test_checksRun(t *testing.T) { httpmock.FileResponse("./fixtures/allPassing.json"), ) }, - wantOut: "All checks were successful\n0 failing, 3 successful, 0 skipped, and 0 pending checks\n\n✓ awesome tests 1m26s sweet link\n✓ cool tests 1m26s sweet link\n✓ rad tests 1m26s sweet link\n", + wantOut: heredoc.Doc(` + All checks were successful + 0 cancelled, 0 failing, 3 successful, 0 skipped, and 0 pending checks + + NAME DESCRIPTION ELAPSED URL + ✓ awesome tests 1m26s sweet link + ✓ cool tests 1m26s sweet link + ✓ rad tests 1m26s sweet link + `), wantErr: "", }, { @@ -204,7 +250,22 @@ func Test_checksRun(t *testing.T) { httpmock.FileResponse("./fixtures/allPassing.json"), ) }, - wantOut: "\x1b[?1049hAll checks were successful\n0 failing, 3 successful, 0 skipped, and 0 pending checks\n\n✓ awesome tests 1m26s sweet link\n✓ cool tests 1m26s sweet link\n✓ rad tests 1m26s sweet link\n\x1b[?1049lAll checks were successful\n0 failing, 3 successful, 0 skipped, and 0 pending checks\n\n✓ awesome tests 1m26s sweet link\n✓ cool tests 1m26s sweet link\n✓ rad tests 1m26s sweet link\n", + wantOut: heredoc.Docf(` + %[1]s[?1049hAll checks were successful + 0 cancelled, 0 failing, 3 successful, 0 skipped, and 0 pending checks + + NAME DESCRIPTION ELAPSED URL + ✓ awesome tests 1m26s sweet link + ✓ cool tests 1m26s sweet link + ✓ rad tests 1m26s sweet link + %[1]s[?1049lAll checks were successful + 0 cancelled, 0 failing, 3 successful, 0 skipped, and 0 pending checks + + NAME DESCRIPTION ELAPSED URL + ✓ awesome tests 1m26s sweet link + ✓ cool tests 1m26s sweet link + ✓ rad tests 1m26s sweet link + `, "\x1b"), wantErr: "", }, { @@ -218,7 +279,24 @@ func Test_checksRun(t *testing.T) { httpmock.FileResponse("./fixtures/someFailing.json"), ) }, - wantOut: "\x1b[?1049h\x1b[0;0H\x1b[JRefreshing checks status every 0 seconds. Press Ctrl+C to quit.\n\nSome checks were not successful\n1 failing, 1 successful, 0 skipped, and 1 pending checks\n\nX sad tests 1m26s sweet link\n✓ cool tests 1m26s sweet link\n* slow tests 1m26s sweet link\n\x1b[?1049lSome checks were not successful\n1 failing, 1 successful, 0 skipped, and 1 pending checks\n\nX sad tests 1m26s sweet link\n✓ cool tests 1m26s sweet link\n* slow tests 1m26s sweet link\n", + wantOut: heredoc.Docf(` + %[1]s[?1049h%[1]s[0;0H%[1]s[JRefreshing checks status every 0 seconds. Press Ctrl+C to quit. + + Some checks were not successful + 0 cancelled, 1 failing, 1 successful, 0 skipped, and 1 pending checks + + NAME DESCRIPTION ELAPSED URL + X sad tests 1m26s sweet link + ✓ cool tests 1m26s sweet link + * slow tests 1m26s sweet link + %[1]s[?1049lSome checks were not successful + 0 cancelled, 1 failing, 1 successful, 0 skipped, and 1 pending checks + + NAME DESCRIPTION ELAPSED URL + X sad tests 1m26s sweet link + ✓ cool tests 1m26s sweet link + * slow tests 1m26s sweet link + `, "\x1b"), wantErr: "SilentError", }, { @@ -230,7 +308,15 @@ func Test_checksRun(t *testing.T) { httpmock.FileResponse("./fixtures/withStatuses.json"), ) }, - wantOut: "Some checks were not successful\n1 failing, 2 successful, 0 skipped, and 0 pending checks\n\nX a status sweet link\n✓ cool tests 1m26s sweet link\n✓ rad tests 1m26s sweet link\n", + wantOut: heredoc.Doc(` + Some checks were not successful + 0 cancelled, 1 failing, 2 successful, 0 skipped, and 0 pending checks + + NAME DESCRIPTION ELAPSED URL + X a status sweet link + ✓ cool tests 1m26s sweet link + ✓ rad tests 1m26s sweet link + `), wantErr: "SilentError", }, { @@ -274,7 +360,7 @@ func Test_checksRun(t *testing.T) { httpmock.FileResponse("./fixtures/somePending.json"), ) }, - wantOut: "cool tests\tpass\t1m26s\tsweet link\t\nrad tests\tpass\t1m26s\tsweet link\t\nslow tests\tpending\t1m26s\tsweet link\t\n", + wantOut: "cool tests\tpass\t1m26s\tsweet link\t\nrad tests\tpass\t1m26s\tsweet link\t\nslow tests\tpending\t1m26s\tsweet link\t\nsad tests\tfail\t1m26s\tsweet link\t\n", wantErr: "PendingError", }, { @@ -308,7 +394,15 @@ func Test_checksRun(t *testing.T) { httpmock.FileResponse("./fixtures/someSkipping.json"), ) }, - wantOut: "All checks were successful\n0 failing, 1 successful, 2 skipped, and 0 pending checks\n\n✓ cool tests 1m26s sweet link\n- rad tests 1m26s sweet link\n- skip tests 1m26s sweet link\n", + wantOut: heredoc.Doc(` + All checks were successful + 0 cancelled, 0 failing, 1 successful, 2 skipped, and 0 pending checks + + NAME DESCRIPTION ELAPSED URL + ✓ cool tests 1m26s sweet link + - rad tests 1m26s sweet link + - skip tests 1m26s sweet link + `), wantErr: "", }, { @@ -332,7 +426,13 @@ func Test_checksRun(t *testing.T) { httpmock.FileResponse("./fixtures/onlyRequired.json"), ) }, - wantOut: "All checks were successful\n0 failing, 1 successful, 0 skipped, and 0 pending checks\n\n✓ cool tests 1m26s sweet link\n", + wantOut: heredoc.Doc(` + All checks were successful + 0 cancelled, 0 failing, 1 successful, 0 skipped, and 0 pending checks + + NAME DESCRIPTION ELAPSED URL + ✓ cool tests 1m26s sweet link + `), wantErr: "", }, { @@ -381,7 +481,15 @@ func Test_checksRun(t *testing.T) { httpmock.FileResponse("./fixtures/withDescriptions.json"), ) }, - wantOut: "All checks were successful\n0 failing, 3 successful, 0 skipped, and 0 pending checks\n\n✓ awesome tests awesome description 1m26s sweet link\n✓ cool tests cool description 1m26s sweet link\n✓ rad tests rad description 1m26s sweet link\n", + wantOut: heredoc.Doc(` + All checks were successful + 0 cancelled, 0 failing, 3 successful, 0 skipped, and 0 pending checks + + NAME DESCRIPTION ELAPSED URL + ✓ awesome tests awesome description 1m26s sweet link + ✓ cool tests cool description 1m26s sweet link + ✓ rad tests rad description 1m26s sweet link + `), wantErr: "", }, { @@ -404,7 +512,14 @@ func Test_checksRun(t *testing.T) { httpmock.FileResponse("./fixtures/withEvents.json"), ) }, - wantOut: "All checks were successful\n0 failing, 2 successful, 0 skipped, and 0 pending checks\n\n✓ tests/cool tests (pull_request) cool description 1m26s sweet link\n✓ tests/cool tests (push) cool description 1m26s sweet link\n", + wantOut: heredoc.Doc(` + All checks were successful + 0 cancelled, 0 failing, 2 successful, 0 skipped, and 0 pending checks + + NAME DESCRIPTION ELAPSED URL + ✓ tests/cool tests (pull_request) cool description 1m26s sweet link + ✓ tests/cool tests (push) cool description 1m26s sweet link + `), wantErr: "", }, { @@ -417,7 +532,13 @@ func Test_checksRun(t *testing.T) { httpmock.FileResponse("./fixtures/withoutEvents.json"), ) }, - wantOut: "All checks were successful\n0 failing, 1 successful, 0 skipped, and 0 pending checks\n\n✓ tests/cool tests cool description 1m26s sweet link\n", + wantOut: heredoc.Doc(` + All checks were successful + 0 cancelled, 0 failing, 1 successful, 0 skipped, and 0 pending checks + + NAME DESCRIPTION ELAPSED URL + ✓ tests/cool tests cool description 1m26s sweet link + `), wantErr: "", }, { diff --git a/pkg/cmd/pr/checks/fixtures/someCancelled.json b/pkg/cmd/pr/checks/fixtures/someCancelled.json new file mode 100644 index 000000000..5e321a5f3 --- /dev/null +++ b/pkg/cmd/pr/checks/fixtures/someCancelled.json @@ -0,0 +1,45 @@ +{ + "data": { + "node": { + "statusCheckRollup": { + "nodes": [ + { + "commit": { + "oid": "abc", + "statusCheckRollup": { + "contexts": { + "nodes": [ + { + "conclusion": "SUCCESS", + "status": "COMPLETED", + "name": "cool tests", + "completedAt": "2020-08-27T19:00:12Z", + "startedAt": "2020-08-27T18:58:46Z", + "detailsUrl": "sweet link" + }, + { + "conclusion": "CANCELLED", + "status": "COMPLETED", + "name": "sad tests", + "completedAt": "2020-08-27T19:00:12Z", + "startedAt": "2020-08-27T18:58:46Z", + "detailsUrl": "sweet link" + }, + { + "conclusion": "SUCCESS", + "status": "COMPLETED", + "name": "awesome tests", + "completedAt": "2020-08-27T19:00:12Z", + "startedAt": "2020-08-27T18:58:46Z", + "detailsUrl": "sweet link" + } + ] + } + } + } + } + ] + } + } + } +} diff --git a/pkg/cmd/pr/checks/fixtures/somePending.json b/pkg/cmd/pr/checks/fixtures/somePending.json index a96ea4fda..c10cb2f84 100644 --- a/pkg/cmd/pr/checks/fixtures/somePending.json +++ b/pkg/cmd/pr/checks/fixtures/somePending.json @@ -32,6 +32,14 @@ "completedAt": "2020-08-27T19:00:12Z", "startedAt": "2020-08-27T18:58:46Z", "detailsUrl": "sweet link" + }, + { + "conclusion": "CANCELLED", + "status": "COMPLETED", + "name": "sad tests", + "completedAt": "2020-08-27T19:00:12Z", + "startedAt": "2020-08-27T18:58:46Z", + "detailsUrl": "sweet link" } ] } diff --git a/pkg/cmd/pr/checks/output.go b/pkg/cmd/pr/checks/output.go index a1e3f889a..5d2f080c6 100644 --- a/pkg/cmd/pr/checks/output.go +++ b/pkg/cmd/pr/checks/output.go @@ -28,7 +28,7 @@ func addRow(tp *tableprinter.TablePrinter, io *iostreams.IOStreams, o check) { case "pending": mark = "*" markColor = cs.Yellow - case "skipping": + case "skipping", "cancel": mark = "-" markColor = cs.Gray } @@ -49,7 +49,11 @@ func addRow(tp *tableprinter.TablePrinter, io *iostreams.IOStreams, o check) { tp.AddField(o.Link) } else { tp.AddField(o.Name) - tp.AddField(o.Bucket) + if o.Bucket == "cancel" { + tp.AddField("fail") + } else { + tp.AddField(o.Bucket) + } if elapsed == "" { tp.AddField("0") } else { @@ -69,12 +73,14 @@ func printSummary(io *iostreams.IOStreams, counts checkCounts) { summary = "Some checks were not successful" } else if counts.Pending > 0 { summary = "Some checks are still pending" + } else if counts.Canceled > 0 { + summary = "Some checks were cancelled" } else { summary = "All checks were successful" } - tallies := fmt.Sprintf("%d failing, %d successful, %d skipped, and %d pending checks", - counts.Failed, counts.Passed, counts.Skipping, counts.Pending) + tallies := fmt.Sprintf("%d cancelled, %d failing, %d successful, %d skipped, and %d pending checks", + counts.Canceled, counts.Failed, counts.Passed, counts.Skipping, counts.Pending) summary = fmt.Sprintf("%s\n%s", io.ColorScheme().Bold(summary), tallies) } @@ -86,7 +92,14 @@ func printSummary(io *iostreams.IOStreams, counts checkCounts) { } func printTable(io *iostreams.IOStreams, checks []check) error { - tp := tableprinter.New(io) + var headers []string + if io.IsStdoutTTY() { + headers = []string{"", "NAME", "DESCRIPTION", "ELAPSED", "URL"} + } else { + headers = []string{"NAME", "STATUS", "ELAPSED", "URL", "DESCRIPTION"} + } + + tp := tableprinter.New(io, tableprinter.WithHeader(headers...)) sort.Slice(checks, func(i, j int) bool { b0 := checks[i].Bucket diff --git a/pkg/cmd/pr/close/close.go b/pkg/cmd/pr/close/close.go index 7e39005bd..ec5132377 100644 --- a/pkg/cmd/pr/close/close.go +++ b/pkg/cmd/pr/close/close.go @@ -75,10 +75,10 @@ func closeRun(opts *CloseOptions) error { } if pr.State == "MERGED" { - fmt.Fprintf(opts.IO.ErrOut, "%s Pull request #%d (%s) can't be closed because it was already merged\n", cs.FailureIcon(), pr.Number, pr.Title) + fmt.Fprintf(opts.IO.ErrOut, "%s Pull request %s#%d (%s) can't be closed because it was already merged\n", cs.FailureIcon(), ghrepo.FullName(baseRepo), pr.Number, pr.Title) return cmdutil.SilentError } else if !pr.IsOpen() { - fmt.Fprintf(opts.IO.ErrOut, "%s Pull request #%d (%s) is already closed\n", cs.WarningIcon(), pr.Number, pr.Title) + fmt.Fprintf(opts.IO.ErrOut, "%s Pull request %s#%d (%s) is already closed\n", cs.WarningIcon(), ghrepo.FullName(baseRepo), pr.Number, pr.Title) return nil } @@ -108,7 +108,7 @@ func closeRun(opts *CloseOptions) error { return fmt.Errorf("API call failed: %w", err) } - fmt.Fprintf(opts.IO.ErrOut, "%s Closed pull request #%d (%s)\n", cs.SuccessIconWithColor(cs.Red), pr.Number, pr.Title) + fmt.Fprintf(opts.IO.ErrOut, "%s Closed pull request %s#%d (%s)\n", cs.SuccessIconWithColor(cs.Red), ghrepo.FullName(baseRepo), pr.Number, pr.Title) if opts.DeleteBranch { ctx := context.Background() diff --git a/pkg/cmd/pr/close/close_test.go b/pkg/cmd/pr/close/close_test.go index b435fb8aa..f957581f8 100644 --- a/pkg/cmd/pr/close/close_test.go +++ b/pkg/cmd/pr/close/close_test.go @@ -123,7 +123,7 @@ func TestPrClose(t *testing.T) { output, err := runCommand(http, true, "96") assert.NoError(t, err) assert.Equal(t, "", output.String()) - assert.Equal(t, "✓ Closed pull request #96 (The title of the PR)\n", output.Stderr()) + assert.Equal(t, "✓ Closed pull request OWNER/REPO#96 (The title of the PR)\n", output.Stderr()) } func TestPrClose_alreadyClosed(t *testing.T) { @@ -138,7 +138,7 @@ func TestPrClose_alreadyClosed(t *testing.T) { output, err := runCommand(http, true, "96") assert.NoError(t, err) assert.Equal(t, "", output.String()) - assert.Equal(t, "! Pull request #96 (The title of the PR) is already closed\n", output.Stderr()) + assert.Equal(t, "! Pull request OWNER/REPO#96 (The title of the PR) is already closed\n", output.Stderr()) } func TestPrClose_deleteBranch_sameRepo(t *testing.T) { @@ -170,7 +170,7 @@ func TestPrClose_deleteBranch_sameRepo(t *testing.T) { assert.NoError(t, err) assert.Equal(t, "", output.String()) assert.Equal(t, heredoc.Doc(` - ✓ Closed pull request #96 (The title of the PR) + ✓ Closed pull request OWNER/REPO#96 (The title of the PR) ✓ Deleted branch blueberries `), output.Stderr()) } @@ -201,7 +201,7 @@ func TestPrClose_deleteBranch_crossRepo(t *testing.T) { assert.NoError(t, err) assert.Equal(t, "", output.String()) assert.Equal(t, heredoc.Doc(` - ✓ Closed pull request #96 (The title of the PR) + ✓ Closed pull request OWNER/REPO#96 (The title of the PR) ! Skipped deleting the remote branch of a pull request from fork ✓ Deleted branch blueberries `), output.Stderr()) @@ -237,7 +237,7 @@ func TestPrClose_deleteBranch_sameBranch(t *testing.T) { assert.NoError(t, err) assert.Equal(t, "", output.String()) assert.Equal(t, heredoc.Doc(` - ✓ Closed pull request #96 (The title of the PR) + ✓ Closed pull request OWNER/REPO#96 (The title of the PR) ✓ Deleted branch trunk and switched to branch main `), output.Stderr()) } @@ -270,7 +270,7 @@ func TestPrClose_deleteBranch_notInGitRepo(t *testing.T) { assert.NoError(t, err) assert.Equal(t, "", output.String()) assert.Equal(t, heredoc.Doc(` - ✓ Closed pull request #96 (The title of the PR) + ✓ Closed pull request OWNER/REPO#96 (The title of the PR) ! Skipped deleting the local branch since current directory is not a git repository ✓ Deleted branch trunk `), output.Stderr()) @@ -306,5 +306,5 @@ func TestPrClose_withComment(t *testing.T) { output, err := runCommand(http, true, "96 --comment 'closing comment'") assert.NoError(t, err) assert.Equal(t, "", output.String()) - assert.Equal(t, "✓ Closed pull request #96 (The title of the PR)\n", output.Stderr()) + assert.Equal(t, "✓ Closed pull request OWNER/REPO#96 (The title of the PR)\n", output.Stderr()) } diff --git a/pkg/cmd/pr/create/create.go b/pkg/cmd/pr/create/create.go index 7321d4f38..7c3faecc3 100644 --- a/pkg/cmd/pr/create/create.go +++ b/pkg/cmd/pr/create/create.go @@ -4,6 +4,7 @@ import ( "context" "errors" "fmt" + "io" "net/http" "net/url" "os" @@ -17,12 +18,13 @@ import ( ghContext "github.com/cli/cli/v2/context" "github.com/cli/cli/v2/git" "github.com/cli/cli/v2/internal/browser" - "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/internal/text" "github.com/cli/cli/v2/pkg/cmd/pr/shared" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" + "github.com/cli/cli/v2/pkg/markdown" "github.com/spf13/cobra" ) @@ -30,7 +32,7 @@ type CreateOptions struct { // This struct stores user input and factory functions HttpClient func() (*http.Client, error) GitClient *git.Client - Config func() (config.Config, error) + Config func() (gh.Config, error) IO *iostreams.IOStreams Remotes func() (ghContext.Remotes, error) Branch func() (string, error) @@ -45,6 +47,7 @@ type CreateOptions struct { RepoOverride string Autofill bool + FillVerbose bool FillFirst bool WebMode bool RecoverFile string @@ -63,6 +66,8 @@ type CreateOptions struct { MaintainerCanModify bool Template string + + DryRun bool } type CreateContext struct { @@ -105,8 +110,11 @@ func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Co to push the branch and offer an option to fork the base repository. Use %[1]s--head%[1]s to explicitly skip any forking or pushing behavior. - A prompt will also ask for the title and the body of the pull request. Use %[1]s--title%[1]s - and %[1]s--body%[1]s to skip this, or use %[1]s--fill%[1]s to autofill these values from git commits. + A prompt will also ask for the title and the body of the pull request. Use %[1]s--title%[1]s and + %[1]s--body%[1]s to skip this, or use %[1]s--fill%[1]s to autofill these values from git commits. + It's important to notice that if the %[1]s--title%[1]s and/or %[1]s--body%[1]s are also provided + alongside %[1]s--fill%[1]s, the values specified by %[1]s--title%[1]s and/or %[1]s--body%[1]s will + take precedence and overwrite any autofilled content. Link an issue to the pull request by referencing the issue in the body of the pull request. If the body text mentions %[1]sFixes #123%[1]s or %[1]sCloses #123%[1]s, the referenced issue @@ -115,8 +123,8 @@ func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Co By default, users with write access to the base repository can push new commits to the head branch of the pull request. Disable this with %[1]s--no-maintainer-edit%[1]s. - Adding a pull request to projects requires authorization with the "project" scope. - To authorize, run "gh auth refresh -s project". + Adding a pull request to projects requires authorization with the %[1]sproject%[1]s scope. + To authorize, run %[1]sgh auth refresh -s project%[1]s. `, "`"), Example: heredoc.Doc(` $ gh pr create --title "The bug is fixed" --body "Everything works again" @@ -160,6 +168,14 @@ func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Co return cmdutil.FlagErrorf("`--fill` is not supported with `--fill-first`") } + if opts.FillVerbose && opts.FillFirst { + return cmdutil.FlagErrorf("`--fill-verbose` is not supported with `--fill-first`") + } + + if opts.FillVerbose && opts.Autofill { + return cmdutil.FlagErrorf("`--fill-verbose` is not supported with `--fill`") + } + opts.BodyProvided = cmd.Flags().Changed("body") if bodyFile != "" { b, err := cmdutil.ReadFile(bodyFile, opts.IO.In) @@ -174,8 +190,12 @@ func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Co return cmdutil.FlagErrorf("`--template` is not supported when using `--body` or `--body-file`") } - if !opts.IO.CanPrompt() && !opts.WebMode && !(opts.Autofill || opts.FillFirst) && (!opts.TitleProvided || !opts.BodyProvided) { - return cmdutil.FlagErrorf("must provide `--title` and `--body` (or `--fill` or `fill-first`) when not running interactively") + if !opts.IO.CanPrompt() && !opts.WebMode && !(opts.FillVerbose || opts.Autofill || opts.FillFirst) && (!opts.TitleProvided || !opts.BodyProvided) { + return cmdutil.FlagErrorf("must provide `--title` and `--body` (or `--fill` or `fill-first` or `--fillverbose`) when not running interactively") + } + + if opts.DryRun && opts.WebMode { + return cmdutil.FlagErrorf("`--dry-run` is not supported when using `--web`") } if runF != nil { @@ -191,10 +211,11 @@ func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Co fl.StringVarP(&opts.Body, "body", "b", "", "Body for the pull request") fl.StringVarP(&bodyFile, "body-file", "F", "", "Read body text from `file` (use \"-\" to read from standard input)") fl.StringVarP(&opts.BaseBranch, "base", "B", "", "The `branch` into which you want your code merged") - fl.StringVarP(&opts.HeadBranch, "head", "H", "", "The `branch` that contains commits for your pull request (default: current branch)") + fl.StringVarP(&opts.HeadBranch, "head", "H", "", "The `branch` that contains commits for your pull request (default [current branch])") fl.BoolVarP(&opts.WebMode, "web", "w", false, "Open the web browser to create a pull request") - fl.BoolVarP(&opts.Autofill, "fill", "f", false, "Do not prompt for title/body and just use commit info") - fl.BoolVar(&opts.FillFirst, "fill-first", false, "Do not prompt for title/body and just use first commit info") + fl.BoolVarP(&opts.FillVerbose, "fill-verbose", "", false, "Use commits msg+body for description") + fl.BoolVarP(&opts.Autofill, "fill", "f", false, "Use commit info for title and body") + fl.BoolVar(&opts.FillFirst, "fill-first", false, "Use first commit info for title and body") fl.StringSliceVarP(&opts.Reviewers, "reviewer", "r", nil, "Request reviews from people or teams by their `handle`") fl.StringSliceVarP(&opts.Assignees, "assignee", "a", nil, "Assign people by their `login`. Use \"@me\" to self-assign.") fl.StringSliceVarP(&opts.Labels, "label", "l", nil, "Add labels by `name`") @@ -203,6 +224,7 @@ func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Co fl.Bool("no-maintainer-edit", false, "Disable maintainer's ability to modify pull request") fl.StringVar(&opts.RecoverFile, "recover", "", "Recover input from a failed run of create") fl.StringVarP(&opts.Template, "template", "T", "", "Template `file` to use as starting body text") + fl.BoolVar(&opts.DryRun, "dry-run", false, "Print details instead of creating the PR. May still push git changes.") _ = cmdutil.RegisterBranchCompletionFlags(f.GitClient, cmd, "base", "head") @@ -279,6 +301,9 @@ func createRun(opts *CreateOptions) (err error) { if state.Draft { message = "\nCreating draft pull request for %s into %s in %s\n\n" } + if opts.DryRun { + message = "\nDry Running pull request for %s into %s in %s\n\n" + } cs := opts.IO.ColorScheme() @@ -289,7 +314,7 @@ func createRun(opts *CreateOptions) (err error) { ghrepo.FullName(ctx.BaseRepo)) } - if opts.Autofill || opts.FillFirst || (opts.TitleProvided && opts.BodyProvided) { + if opts.FillVerbose || opts.Autofill || opts.FillFirst || (opts.TitleProvided && opts.BodyProvided) { err = handlePush(*opts, *ctx) if err != nil { return @@ -347,7 +372,7 @@ func createRun(opts *CreateOptions) (err error) { return } - allowPreview := !state.HasMetadata() && shared.ValidURL(openURL) + allowPreview := !state.HasMetadata() && shared.ValidURL(openURL) && !opts.DryRun allowMetadata := ctx.BaseRepo.ViewerCanTriage() action, err := shared.ConfirmPRSubmission(opts.Prompter, allowPreview, allowMetadata, state.Draft) if err != nil { @@ -366,7 +391,7 @@ func createRun(opts *CreateOptions) (err error) { return } - action, err = shared.ConfirmPRSubmission(opts.Prompter, !state.HasMetadata(), false, state.Draft) + action, err = shared.ConfirmPRSubmission(opts.Prompter, !state.HasMetadata() && !opts.DryRun, false, state.Draft) if err != nil { return } @@ -400,7 +425,9 @@ func createRun(opts *CreateOptions) (err error) { return } -func initDefaultTitleBody(ctx CreateContext, state *shared.IssueMetadataState, useFirstCommit bool) error { +var regexPattern = regexp.MustCompile(`(?m)^`) + +func initDefaultTitleBody(ctx CreateContext, state *shared.IssueMetadataState, useFirstCommit bool, addBody bool) error { baseRef := ctx.BaseTrackingBranch headRef := ctx.HeadBranch gitClient := ctx.GitClient @@ -409,19 +436,24 @@ func initDefaultTitleBody(ctx CreateContext, state *shared.IssueMetadataState, u if err != nil { return err } + if len(commits) == 1 || useFirstCommit { - commitIndex := len(commits) - 1 - state.Title = commits[commitIndex].Title - body, err := gitClient.CommitBody(context.Background(), commits[commitIndex].Sha) - if err != nil { - return err - } - state.Body = body + state.Title = commits[len(commits)-1].Title + state.Body = commits[len(commits)-1].Body } else { state.Title = humanize(headRef) var body strings.Builder for i := len(commits) - 1; i >= 0; i-- { - fmt.Fprintf(&body, "- %s\n", commits[i].Title) + fmt.Fprintf(&body, "- **%s**\n", commits[i].Title) + if addBody { + x := regexPattern.ReplaceAllString(commits[i].Body, " ") + fmt.Fprintf(&body, "%s", x) + + if i > 0 { + fmt.Fprintln(&body) + fmt.Fprintln(&body) + } + } } state.Body = body.String() } @@ -492,9 +524,9 @@ func NewIssueState(ctx CreateContext, opts CreateOptions) (*shared.IssueMetadata Draft: opts.IsDraft, } - if opts.Autofill || opts.FillFirst || !opts.TitleProvided || !opts.BodyProvided { - err := initDefaultTitleBody(ctx, state, opts.FillFirst) - if err != nil && (opts.Autofill || opts.FillFirst) { + if opts.FillVerbose || opts.Autofill || opts.FillFirst || !opts.TitleProvided || !opts.BodyProvided { + err := initDefaultTitleBody(ctx, state, opts.FillFirst, opts.FillVerbose) + if err != nil && (opts.FillVerbose || opts.Autofill || opts.FillFirst) { return nil, fmt.Errorf("could not compute title or body defaults: %w", err) } } @@ -656,7 +688,6 @@ func NewCreateContext(opts *CreateOptions) (*CreateContext, error) { Client: client, GitClient: gitClient, }, nil - } func getRemotes(opts *CreateOptions) (ghContext.Remotes, error) { @@ -693,6 +724,14 @@ func submitPR(opts CreateOptions, ctx CreateContext, state shared.IssueMetadataS return err } + if opts.DryRun { + if opts.IO.IsStdoutTTY() { + return renderPullRequestTTY(opts.IO, params, &state) + } else { + return renderPullRequestPlain(opts.IO.Out, params, &state) + } + } + opts.IO.StartProgressIndicator() pr, err := api.CreatePullRequest(client, ctx.BaseRepo, params) opts.IO.StopProgressIndicator() @@ -708,12 +747,85 @@ func submitPR(opts CreateOptions, ctx CreateContext, state shared.IssueMetadataS return nil } +func renderPullRequestPlain(w io.Writer, params map[string]interface{}, state *shared.IssueMetadataState) error { + fmt.Fprint(w, "Would have created a Pull Request with:\n") + fmt.Fprintf(w, "title:\t%s\n", params["title"]) + fmt.Fprintf(w, "draft:\t%t\n", params["draft"]) + fmt.Fprintf(w, "base:\t%s\n", params["baseRefName"]) + fmt.Fprintf(w, "head:\t%s\n", params["headRefName"]) + if len(state.Labels) != 0 { + fmt.Fprintf(w, "labels:\t%v\n", strings.Join(state.Labels, ", ")) + } + if len(state.Reviewers) != 0 { + fmt.Fprintf(w, "reviewers:\t%v\n", strings.Join(state.Reviewers, ", ")) + } + if len(state.Assignees) != 0 { + fmt.Fprintf(w, "assignees:\t%v\n", strings.Join(state.Assignees, ", ")) + } + if len(state.Milestones) != 0 { + fmt.Fprintf(w, "milestones:\t%v\n", strings.Join(state.Milestones, ", ")) + } + if len(state.Projects) != 0 { + fmt.Fprintf(w, "projects:\t%v\n", strings.Join(state.Projects, ", ")) + } + fmt.Fprintf(w, "maintainerCanModify:\t%t\n", params["maintainerCanModify"]) + fmt.Fprint(w, "body:\n") + if len(params["body"].(string)) != 0 { + fmt.Fprintln(w, params["body"]) + } + return nil +} + +func renderPullRequestTTY(io *iostreams.IOStreams, params map[string]interface{}, state *shared.IssueMetadataState) error { + iofmt := io.ColorScheme() + out := io.Out + + fmt.Fprint(out, "Would have created a Pull Request with:\n") + fmt.Fprintf(out, "%s: %s\n", iofmt.Bold("Title"), params["title"].(string)) + fmt.Fprintf(out, "%s: %t\n", iofmt.Bold("Draft"), params["draft"]) + fmt.Fprintf(out, "%s: %s\n", iofmt.Bold("Base"), params["baseRefName"]) + fmt.Fprintf(out, "%s: %s\n", iofmt.Bold("Head"), params["headRefName"]) + if len(state.Labels) != 0 { + fmt.Fprintf(out, "%s: %s\n", iofmt.Bold("Labels"), strings.Join(state.Labels, ", ")) + } + if len(state.Reviewers) != 0 { + fmt.Fprintf(out, "%s: %s\n", iofmt.Bold("Reviewers"), strings.Join(state.Reviewers, ", ")) + } + if len(state.Assignees) != 0 { + fmt.Fprintf(out, "%s: %s\n", iofmt.Bold("Assignees"), strings.Join(state.Assignees, ", ")) + } + if len(state.Milestones) != 0 { + fmt.Fprintf(out, "%s: %s\n", iofmt.Bold("Milestones"), strings.Join(state.Milestones, ", ")) + } + if len(state.Projects) != 0 { + fmt.Fprintf(out, "%s: %s\n", iofmt.Bold("Projects"), strings.Join(state.Projects, ", ")) + } + fmt.Fprintf(out, "%s: %t\n", iofmt.Bold("MaintainerCanModify"), params["maintainerCanModify"]) + + fmt.Fprintf(out, "%s\n", iofmt.Bold("Body:")) + // Body + var md string + var err error + if len(params["body"].(string)) == 0 { + md = fmt.Sprintf("%s\n", iofmt.Gray("No description provided")) + } else { + md, err = markdown.Render(params["body"].(string), + markdown.WithTheme(io.TerminalTheme()), + markdown.WithWrap(io.TerminalWidth())) + if err != nil { + return err + } + } + fmt.Fprintf(out, "%s", md) + + return nil +} + func previewPR(opts CreateOptions, openURL string) error { if opts.IO.IsStdinTTY() && opts.IO.IsStdoutTTY() { fmt.Fprintf(opts.IO.ErrOut, "Opening %s in your browser.\n", text.DisplayURL(openURL)) } return opts.Browser.Browse(openURL) - } func handlePush(opts CreateOptions, ctx CreateContext) error { @@ -758,7 +870,7 @@ func handlePush(opts CreateOptions, ctx CreateContext) error { return err } - cloneProtocol, _ := cfg.GetOrDefault(headRepo.RepoHost(), "git_protocol") + cloneProtocol := cfg.GitProtocol(headRepo.RepoHost()).Value headRepoURL := ghrepo.FormatRemoteURL(headRepo, cloneProtocol) gitClient := ctx.GitClient origin, _ := remotes.FindByName("origin") @@ -800,7 +912,7 @@ func handlePush(opts CreateOptions, ctx CreateContext) error { w := NewRegexpWriter(opts.IO.ErrOut, gitPushRegexp, "") defer w.Flush() gitClient := ctx.GitClient - ref := fmt.Sprintf("HEAD:%s", ctx.HeadBranch) + ref := fmt.Sprintf("HEAD:refs/heads/%s", ctx.HeadBranch) bo := backoff.NewConstantBackOff(2 * time.Second) ctx := context.Background() return backoff.Retry(func() error { diff --git a/pkg/cmd/pr/create/create_test.go b/pkg/cmd/pr/create/create_test.go index a8c10057a..3b64688c3 100644 --- a/pkg/cmd/pr/create/create_test.go +++ b/pkg/cmd/pr/create/create_test.go @@ -7,6 +7,7 @@ import ( "net/http" "os" "path/filepath" + "strings" "testing" "github.com/MakeNowJust/heredoc" @@ -15,6 +16,7 @@ import ( "github.com/cli/cli/v2/git" "github.com/cli/cli/v2/internal/browser" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/internal/prompter" "github.com/cli/cli/v2/internal/run" @@ -194,6 +196,12 @@ func TestNewCmdCreate(t *testing.T) { cli: "--fill --fill-first", wantsErr: true, }, + { + name: "dry-run and web", + tty: false, + cli: "--web --dry-run", + wantsErr: true, + }, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { @@ -250,16 +258,17 @@ func TestNewCmdCreate(t *testing.T) { func Test_createRun(t *testing.T) { tests := []struct { - name string - setup func(*CreateOptions, *testing.T) func() - cmdStubs func(*run.CommandStubber) - promptStubs func(*prompter.PrompterMock) - httpStubs func(*httpmock.Registry, *testing.T) - expectedOut string - expectedErrOut string - expectedBrowse string - wantErr string - tty bool + name string + setup func(*CreateOptions, *testing.T) func() + cmdStubs func(*run.CommandStubber) + promptStubs func(*prompter.PrompterMock) + httpStubs func(*httpmock.Registry, *testing.T) + expectedOutputs []string + expectedOut string + expectedErrOut string + expectedBrowse string + wantErr string + tty bool }{ { name: "nontty web", @@ -279,9 +288,9 @@ func Test_createRun(t *testing.T) { reg.Register( httpmock.GraphQL(`mutation PullRequestCreate\b`), httpmock.GraphQLMutation(` - { "data": { "createPullRequest": { "pullRequest": { - "URL": "https://github.com/OWNER/REPO/pull/12" - } } } }`, + { "data": { "createPullRequest": { "pullRequest": { + "URL": "https://github.com/OWNER/REPO/pull/12" + } } } }`, func(input map[string]interface{}) { assert.Equal(t, "REPOID", input["repositoryId"]) assert.Equal(t, "my title", input["title"]) @@ -300,6 +309,228 @@ func Test_createRun(t *testing.T) { }, expectedOut: "https://github.com/OWNER/REPO/pull/12\n", }, + { + name: "dry-run-nontty-with-default-base", + tty: false, + setup: func(opts *CreateOptions, t *testing.T) func() { + opts.TitleProvided = true + opts.BodyProvided = true + opts.Title = "my title" + opts.Body = "my body" + opts.HeadBranch = "feature" + opts.DryRun = true + return func() {} + }, + expectedOutputs: []string{ + "Would have created a Pull Request with:", + `title: my title`, + `draft: false`, + `base: master`, + `head: feature`, + `maintainerCanModify: false`, + `body:`, + `my body`, + ``, + }, + expectedErrOut: "", + }, + { + name: "dry-run-nontty-with-all-opts", + tty: false, + setup: func(opts *CreateOptions, t *testing.T) func() { + opts.TitleProvided = true + opts.BodyProvided = true + opts.Title = "TITLE" + opts.Body = "BODY" + opts.BaseBranch = "trunk" + opts.HeadBranch = "feature" + opts.Assignees = []string{"monalisa"} + opts.Labels = []string{"bug", "todo"} + opts.Projects = []string{"roadmap"} + opts.Reviewers = []string{"hubot", "monalisa", "/core", "/robots"} + opts.Milestone = "big one.oh" + opts.DryRun = true + return func() {} + }, + httpStubs: func(reg *httpmock.Registry, t *testing.T) { + reg.Register( + httpmock.GraphQL(`query RepositoryResolveMetadataIDs\b`), + httpmock.StringResponse(` + { "data": { + "u000": { "login": "MonaLisa", "id": "MONAID" }, + "u001": { "login": "hubot", "id": "HUBOTID" }, + "repository": { + "l000": { "name": "bug", "id": "BUGID" }, + "l001": { "name": "TODO", "id": "TODOID" } + }, + "organization": { + "t000": { "slug": "core", "id": "COREID" }, + "t001": { "slug": "robots", "id": "ROBOTID" } + } + } } + `)) + reg.Register( + httpmock.GraphQL(`query RepositoryMilestoneList\b`), + httpmock.StringResponse(` + { "data": { "repository": { "milestones": { + "nodes": [ + { "title": "GA", "id": "GAID" }, + { "title": "Big One.oh", "id": "BIGONEID" } + ], + "pageInfo": { "hasNextPage": false } + } } } } + `)) + mockRetrieveProjects(t, reg) + }, + expectedOutputs: []string{ + "Would have created a Pull Request with:", + `title: TITLE`, + `draft: false`, + `base: trunk`, + `head: feature`, + `labels: bug, todo`, + `reviewers: hubot, monalisa, /core, /robots`, + `assignees: monalisa`, + `milestones: big one.oh`, + `projects: roadmap`, + `maintainerCanModify: false`, + `body:`, + `BODY`, + ``, + }, + expectedErrOut: "", + }, + { + name: "dry-run-tty-with-default-base", + tty: true, + setup: func(opts *CreateOptions, t *testing.T) func() { + opts.TitleProvided = true + opts.BodyProvided = true + opts.Title = "my title" + opts.Body = "my body" + opts.HeadBranch = "feature" + opts.DryRun = true + return func() {} + }, + expectedOutputs: []string{ + `Would have created a Pull Request with:`, + `Title: my title`, + `Draft: false`, + `Base: master`, + `Head: feature`, + `MaintainerCanModify: false`, + `Body:`, + ``, + ` my body `, + ``, + ``, + }, + expectedErrOut: heredoc.Doc(` + + Dry Running pull request for feature into master in OWNER/REPO + + `), + }, + { + name: "dry-run-tty-with-all-opts", + tty: true, + setup: func(opts *CreateOptions, t *testing.T) func() { + opts.TitleProvided = true + opts.BodyProvided = true + opts.Title = "TITLE" + opts.Body = "BODY" + opts.BaseBranch = "trunk" + opts.HeadBranch = "feature" + opts.Assignees = []string{"monalisa"} + opts.Labels = []string{"bug", "todo"} + opts.Projects = []string{"roadmap"} + opts.Reviewers = []string{"hubot", "monalisa", "/core", "/robots"} + opts.Milestone = "big one.oh" + opts.DryRun = true + return func() {} + }, + httpStubs: func(reg *httpmock.Registry, t *testing.T) { + reg.Register( + httpmock.GraphQL(`query RepositoryResolveMetadataIDs\b`), + httpmock.StringResponse(` + { "data": { + "u000": { "login": "MonaLisa", "id": "MONAID" }, + "u001": { "login": "hubot", "id": "HUBOTID" }, + "repository": { + "l000": { "name": "bug", "id": "BUGID" }, + "l001": { "name": "TODO", "id": "TODOID" } + }, + "organization": { + "t000": { "slug": "core", "id": "COREID" }, + "t001": { "slug": "robots", "id": "ROBOTID" } + } + } } + `)) + reg.Register( + httpmock.GraphQL(`query RepositoryMilestoneList\b`), + httpmock.StringResponse(` + { "data": { "repository": { "milestones": { + "nodes": [ + { "title": "GA", "id": "GAID" }, + { "title": "Big One.oh", "id": "BIGONEID" } + ], + "pageInfo": { "hasNextPage": false } + } } } } + `)) + mockRetrieveProjects(t, reg) + }, + expectedOutputs: []string{ + `Would have created a Pull Request with:`, + `Title: TITLE`, + `Draft: false`, + `Base: trunk`, + `Head: feature`, + `Labels: bug, todo`, + `Reviewers: hubot, monalisa, /core, /robots`, + `Assignees: monalisa`, + `Milestones: big one.oh`, + `Projects: roadmap`, + `MaintainerCanModify: false`, + `Body:`, + ``, + ` BODY `, + ``, + ``, + }, + expectedErrOut: heredoc.Doc(` + + Dry Running pull request for feature into trunk in OWNER/REPO + + `), + }, + { + name: "dry-run-tty-with-empty-body", + tty: true, + setup: func(opts *CreateOptions, t *testing.T) func() { + opts.TitleProvided = true + opts.BodyProvided = true + opts.Title = "TITLE" + opts.Body = "" + opts.HeadBranch = "feature" + opts.DryRun = true + return func() {} + }, + expectedOut: heredoc.Doc(` + Would have created a Pull Request with: + Title: TITLE + Draft: false + Base: master + Head: feature + MaintainerCanModify: false + Body: + No description provided + `), + expectedErrOut: heredoc.Doc(` + + Dry Running pull request for feature into master in OWNER/REPO + + `), + }, { name: "survey", tty: true, @@ -318,9 +549,9 @@ func Test_createRun(t *testing.T) { reg.Register( httpmock.GraphQL(`mutation PullRequestCreate\b`), httpmock.GraphQLMutation(` - { "data": { "createPullRequest": { "pullRequest": { - "URL": "https://github.com/OWNER/REPO/pull/12" - } } } }`, func(input map[string]interface{}) { + { "data": { "createPullRequest": { "pullRequest": { + "URL": "https://github.com/OWNER/REPO/pull/12" + } } } }`, func(input map[string]interface{}) { assert.Equal(t, "REPOID", input["repositoryId"].(string)) assert.Equal(t, "my title", input["title"].(string)) assert.Equal(t, "my body", input["body"].(string)) @@ -332,7 +563,7 @@ func Test_createRun(t *testing.T) { cmdStubs: func(cs *run.CommandStubber) { cs.Register(`git config --get-regexp.+branch\\\.feature\\\.`, 0, "") cs.Register(`git show-ref --verify -- HEAD refs/remotes/origin/feature`, 0, "") - cs.Register(`git push --set-upstream origin HEAD:feature`, 0, "") + cs.Register(`git push --set-upstream origin HEAD:refs/heads/feature`, 0, "") }, promptStubs: func(pm *prompter.PrompterMock) { pm.SelectFunc = func(p, _ string, opts []string) (int, error) { @@ -366,11 +597,11 @@ func Test_createRun(t *testing.T) { reg.Register( httpmock.GraphQL(`mutation PullRequestCreate\b`), httpmock.GraphQLMutation(` - { "data": { "createPullRequest": { "pullRequest": { - "id": "PullRequest#1", - "URL": "https://github.com/OWNER/REPO/pull/12" - } } } } - `, func(input map[string]interface{}) { + { "data": { "createPullRequest": { "pullRequest": { + "id": "PullRequest#1", + "URL": "https://github.com/OWNER/REPO/pull/12" + } } } } + `, func(input map[string]interface{}) { assert.Equal(t, "REPOID", input["repositoryId"].(string)) assert.Equal(t, "my title", input["title"].(string)) assert.Equal(t, "my body", input["body"].(string)) @@ -381,10 +612,10 @@ func Test_createRun(t *testing.T) { reg.Register( httpmock.GraphQL(`mutation UpdateProjectV2Items\b`), httpmock.GraphQLQuery(` - { "data": { "add_000": { "item": { - "id": "1" - } } } } - `, func(mutations string, inputs map[string]interface{}) { + { "data": { "add_000": { "item": { + "id": "1" + } } } } + `, func(mutations string, inputs map[string]interface{}) { variables, err := json.Marshal(inputs) assert.NoError(t, err) expectedMutations := "mutation UpdateProjectV2Items($input_000: AddProjectV2ItemByIdInput!) {add_000: addProjectV2ItemById(input: $input_000) { item { id } }}" @@ -396,7 +627,7 @@ func Test_createRun(t *testing.T) { cmdStubs: func(cs *run.CommandStubber) { cs.Register(`git config --get-regexp.+branch\\\.feature\\\.`, 0, "") cs.Register(`git show-ref --verify -- HEAD refs/remotes/origin/feature`, 0, "") - cs.Register(`git push --set-upstream origin HEAD:feature`, 0, "") + cs.Register(`git push --set-upstream origin HEAD:refs/heads/feature`, 0, "") }, promptStubs: func(pm *prompter.PrompterMock) { pm.SelectFunc = func(p, _ string, opts []string) (int, error) { @@ -428,10 +659,10 @@ func Test_createRun(t *testing.T) { reg.Register( httpmock.GraphQL(`mutation PullRequestCreate\b`), httpmock.GraphQLMutation(` - { "data": { "createPullRequest": { "pullRequest": { - "URL": "https://github.com/OWNER/REPO/pull/12" - } } } } - `, func(input map[string]interface{}) { + { "data": { "createPullRequest": { "pullRequest": { + "URL": "https://github.com/OWNER/REPO/pull/12" + } } } } + `, func(input map[string]interface{}) { assert.Equal(t, false, input["maintainerCanModify"].(bool)) assert.Equal(t, "REPOID", input["repositoryId"].(string)) assert.Equal(t, "my title", input["title"].(string)) @@ -443,7 +674,7 @@ func Test_createRun(t *testing.T) { cmdStubs: func(cs *run.CommandStubber) { cs.Register(`git config --get-regexp.+branch\\\.feature\\\.`, 0, "") cs.Register(`git show-ref --verify -- HEAD refs/remotes/origin/feature`, 0, "") - cs.Register(`git push --set-upstream origin HEAD:feature`, 0, "") + cs.Register(`git push --set-upstream origin HEAD:refs/heads/feature`, 0, "") }, promptStubs: func(pm *prompter.PrompterMock) { pm.SelectFunc = func(p, _ string, opts []string) (int, error) { @@ -475,16 +706,16 @@ func Test_createRun(t *testing.T) { reg.Register( httpmock.REST("POST", "repos/OWNER/REPO/forks"), httpmock.StatusStringResponse(201, ` - { "node_id": "NODEID", - "name": "REPO", - "owner": {"login": "monalisa"} - }`)) + { "node_id": "NODEID", + "name": "REPO", + "owner": {"login": "monalisa"} + }`)) reg.Register( httpmock.GraphQL(`mutation PullRequestCreate\b`), httpmock.GraphQLMutation(` - { "data": { "createPullRequest": { "pullRequest": { - "URL": "https://github.com/OWNER/REPO/pull/12" - }}}}`, func(input map[string]interface{}) { + { "data": { "createPullRequest": { "pullRequest": { + "URL": "https://github.com/OWNER/REPO/pull/12" + }}}}`, func(input map[string]interface{}) { assert.Equal(t, "REPOID", input["repositoryId"].(string)) assert.Equal(t, "master", input["baseRefName"].(string)) assert.Equal(t, "monalisa:feature", input["headRefName"].(string)) @@ -495,7 +726,7 @@ func Test_createRun(t *testing.T) { cs.Register(`git show-ref --verify -- HEAD refs/remotes/origin/feature`, 0, "") cs.Register("git remote rename origin upstream", 0, "") cs.Register(`git remote add origin https://github.com/monalisa/REPO.git`, 0, "") - cs.Register(`git push --set-upstream origin HEAD:feature`, 0, "") + cs.Register(`git push --set-upstream origin HEAD:refs/heads/feature`, 0, "") }, promptStubs: func(pm *prompter.PrompterMock) { pm.SelectFunc = func(p, _ string, opts []string) (int, error) { @@ -541,9 +772,9 @@ func Test_createRun(t *testing.T) { reg.Register( httpmock.GraphQL(`mutation PullRequestCreate\b`), httpmock.GraphQLMutation(` - { "data": { "createPullRequest": { "pullRequest": { - "URL": "https://github.com/OWNER/REPO/pull/12" - } } } }`, func(input map[string]interface{}) { + { "data": { "createPullRequest": { "pullRequest": { + "URL": "https://github.com/OWNER/REPO/pull/12" + } } } }`, func(input map[string]interface{}) { assert.Equal(t, "REPOID", input["repositoryId"].(string)) assert.Equal(t, "master", input["baseRefName"].(string)) assert.Equal(t, "monalisa:feature", input["headRefName"].(string)) @@ -552,9 +783,9 @@ func Test_createRun(t *testing.T) { cmdStubs: func(cs *run.CommandStubber) { cs.Register(`git config --get-regexp \^branch\\\.feature\\\.`, 1, "") // determineTrackingBranch cs.Register("git show-ref --verify", 0, heredoc.Doc(` - deadbeef HEAD - deadb00f refs/remotes/upstream/feature - deadbeef refs/remotes/origin/feature`)) // determineTrackingBranch + deadbeef HEAD + deadb00f refs/remotes/upstream/feature + deadbeef refs/remotes/origin/feature`)) // determineTrackingBranch }, expectedOut: "https://github.com/OWNER/REPO/pull/12\n", expectedErrOut: "\nCreating pull request for monalisa:feature into master in OWNER/REPO\n\n", @@ -573,10 +804,10 @@ func Test_createRun(t *testing.T) { reg.Register( httpmock.GraphQL(`mutation PullRequestCreate\b`), httpmock.GraphQLMutation(` - { "data": { "createPullRequest": { "pullRequest": { - "URL": "https://github.com/OWNER/REPO/pull/12" - } } } } - `, func(input map[string]interface{}) { + { "data": { "createPullRequest": { "pullRequest": { + "URL": "https://github.com/OWNER/REPO/pull/12" + } } } } + `, func(input map[string]interface{}) { assert.Equal(t, "REPOID", input["repositoryId"].(string)) assert.Equal(t, "master", input["baseRefName"].(string)) assert.Equal(t, "my-feat2", input["headRefName"].(string)) @@ -584,13 +815,13 @@ func Test_createRun(t *testing.T) { }, cmdStubs: func(cs *run.CommandStubber) { cs.Register(`git config --get-regexp \^branch\\\.feature\\\.`, 0, heredoc.Doc(` - branch.feature.remote origin - branch.feature.merge refs/heads/my-feat2 - `)) // determineTrackingBranch + branch.feature.remote origin + branch.feature.merge refs/heads/my-feat2 + `)) // determineTrackingBranch cs.Register("git show-ref --verify", 0, heredoc.Doc(` - deadbeef HEAD - deadbeef refs/remotes/origin/my-feat2 - `)) // determineTrackingBranch + deadbeef HEAD + deadbeef refs/remotes/origin/my-feat2 + `)) // determineTrackingBranch }, expectedOut: "https://github.com/OWNER/REPO/pull/12\n", expectedErrOut: "\nCreating pull request for my-feat2 into master in OWNER/REPO\n\n", @@ -609,25 +840,25 @@ func Test_createRun(t *testing.T) { reg.Register( httpmock.GraphQL(`query PullRequestTemplates\b`), httpmock.StringResponse(` - { "data": { "repository": { "pullRequestTemplates": [ - { "filename": "template1", - "body": "this is a bug" }, - { "filename": "template2", - "body": "this is a enhancement" } - ] } } }`)) + { "data": { "repository": { "pullRequestTemplates": [ + { "filename": "template1", + "body": "this is a bug" }, + { "filename": "template2", + "body": "this is a enhancement" } + ] } } }`)) reg.Register( httpmock.GraphQL(`mutation PullRequestCreate\b`), httpmock.GraphQLMutation(` - { "data": { "createPullRequest": { "pullRequest": { - "URL": "https://github.com/OWNER/REPO/pull/12" - } } } } - `, func(input map[string]interface{}) { + { "data": { "createPullRequest": { "pullRequest": { + "URL": "https://github.com/OWNER/REPO/pull/12" + } } } } + `, func(input map[string]interface{}) { assert.Equal(t, "my title", input["title"].(string)) - assert.Equal(t, "- commit 1\n- commit 0\n\nthis is a bug", input["body"].(string)) + assert.Equal(t, "- **commit 1**\n- **commit 0**\n\nthis is a bug", input["body"].(string)) })) }, cmdStubs: func(cs *run.CommandStubber) { - cs.Register(`git( .+)? log( .+)? origin/master\.\.\.feature`, 0, "1234567890,commit 0\n2345678901,commit 1") + cs.Register(`git( .+)? log( .+)? origin/master\.\.\.feature`, 0, "d3476a1\u0000commit 0\u0000\u0000\n7a6ea13\u0000commit 1\u0000\u0000") }, promptStubs: func(pm *prompter.PrompterMock) { pm.MarkdownEditorFunc = func(p, d string, ba bool) (string, error) { @@ -671,39 +902,39 @@ func Test_createRun(t *testing.T) { reg.Register( httpmock.GraphQL(`query RepositoryResolveMetadataIDs\b`), httpmock.StringResponse(` - { "data": { - "u000": { "login": "MonaLisa", "id": "MONAID" }, - "u001": { "login": "hubot", "id": "HUBOTID" }, - "repository": { - "l000": { "name": "bug", "id": "BUGID" }, - "l001": { "name": "TODO", "id": "TODOID" } - }, - "organization": { - "t000": { "slug": "core", "id": "COREID" }, - "t001": { "slug": "robots", "id": "ROBOTID" } - } - } } - `)) + { "data": { + "u000": { "login": "MonaLisa", "id": "MONAID" }, + "u001": { "login": "hubot", "id": "HUBOTID" }, + "repository": { + "l000": { "name": "bug", "id": "BUGID" }, + "l001": { "name": "TODO", "id": "TODOID" } + }, + "organization": { + "t000": { "slug": "core", "id": "COREID" }, + "t001": { "slug": "robots", "id": "ROBOTID" } + } + } } + `)) reg.Register( httpmock.GraphQL(`query RepositoryMilestoneList\b`), httpmock.StringResponse(` - { "data": { "repository": { "milestones": { - "nodes": [ - { "title": "GA", "id": "GAID" }, - { "title": "Big One.oh", "id": "BIGONEID" } - ], - "pageInfo": { "hasNextPage": false } - } } } } - `)) + { "data": { "repository": { "milestones": { + "nodes": [ + { "title": "GA", "id": "GAID" }, + { "title": "Big One.oh", "id": "BIGONEID" } + ], + "pageInfo": { "hasNextPage": false } + } } } } + `)) mockRetrieveProjects(t, reg) reg.Register( httpmock.GraphQL(`mutation PullRequestCreate\b`), httpmock.GraphQLMutation(` - { "data": { "createPullRequest": { "pullRequest": { - "id": "NEWPULLID", - "URL": "https://github.com/OWNER/REPO/pull/12" - } } } } - `, func(inputs map[string]interface{}) { + { "data": { "createPullRequest": { "pullRequest": { + "id": "NEWPULLID", + "URL": "https://github.com/OWNER/REPO/pull/12" + } } } } + `, func(inputs map[string]interface{}) { assert.Equal(t, "TITLE", inputs["title"]) assert.Equal(t, "BODY", inputs["body"]) if v, ok := inputs["assigneeIds"]; ok { @@ -716,10 +947,10 @@ func Test_createRun(t *testing.T) { reg.Register( httpmock.GraphQL(`mutation PullRequestCreateMetadata\b`), httpmock.GraphQLMutation(` - { "data": { "updatePullRequest": { - "clientMutationId": "" - } } } - `, func(inputs map[string]interface{}) { + { "data": { "updatePullRequest": { + "clientMutationId": "" + } } } + `, func(inputs map[string]interface{}) { assert.Equal(t, "NEWPULLID", inputs["pullRequestId"]) assert.Equal(t, []interface{}{"MONAID"}, inputs["assigneeIds"]) assert.Equal(t, []interface{}{"BUGID", "TODOID"}, inputs["labelIds"]) @@ -729,10 +960,10 @@ func Test_createRun(t *testing.T) { reg.Register( httpmock.GraphQL(`mutation PullRequestCreateRequestReviews\b`), httpmock.GraphQLMutation(` - { "data": { "requestReviews": { - "clientMutationId": "" - } } } - `, func(inputs map[string]interface{}) { + { "data": { "requestReviews": { + "clientMutationId": "" + } } } + `, func(inputs map[string]interface{}) { assert.Equal(t, "NEWPULLID", inputs["pullRequestId"]) assert.Equal(t, []interface{}{"HUBOTID", "MONAID"}, inputs["userIds"]) assert.Equal(t, []interface{}{"COREID", "ROBOTID"}, inputs["teamIds"]) @@ -773,7 +1004,7 @@ func Test_createRun(t *testing.T) { cs.Register(`git config --get-regexp.+branch\\\.feature\\\.`, 0, "") cs.Register(`git show-ref --verify -- HEAD refs/remotes/origin/feature`, 0, "") cs.Register(`git( .+)? log( .+)? origin/master\.\.\.feature`, 0, "") - cs.Register(`git push --set-upstream origin HEAD:feature`, 0, "") + cs.Register(`git push --set-upstream origin HEAD:refs/heads/feature`, 0, "") }, promptStubs: func(pm *prompter.PrompterMock) { pm.SelectFunc = func(p, _ string, opts []string) (int, error) { @@ -806,8 +1037,7 @@ func Test_createRun(t *testing.T) { cs.Register(`git config --get-regexp.+branch\\\.feature\\\.`, 0, "") cs.Register(`git show-ref --verify -- HEAD refs/remotes/origin/feature`, 0, "") cs.Register(`git( .+)? log( .+)? origin/master\.\.\.feature`, 0, "") - cs.Register(`git push --set-upstream origin HEAD:feature`, 0, "") - + cs.Register(`git push --set-upstream origin HEAD:refs/heads/feature`, 0, "") }, promptStubs: func(pm *prompter.PrompterMock) { pm.SelectFunc = func(p, _ string, opts []string) (int, error) { @@ -834,25 +1064,25 @@ func Test_createRun(t *testing.T) { reg.Register( httpmock.GraphQL(`query PullRequestTemplates\b`), httpmock.StringResponse(` - { "data": { "repository": { "pullRequestTemplates": [ - { "filename": "template1", - "body": "this is a bug" }, - { "filename": "template2", - "body": "this is a enhancement" } - ] } } }`), + { "data": { "repository": { "pullRequestTemplates": [ + { "filename": "template1", + "body": "this is a bug" }, + { "filename": "template2", + "body": "this is a enhancement" } + ] } } }`), ) reg.Register( httpmock.GraphQL(`mutation PullRequestCreate\b`), httpmock.GraphQLMutation(` - { "data": { "createPullRequest": { "pullRequest": { - "URL": "https://github.com/OWNER/REPO/pull/12" - } } } } - `, func(input map[string]interface{}) { + { "data": { "createPullRequest": { "pullRequest": { + "URL": "https://github.com/OWNER/REPO/pull/12" + } } } } + `, func(input map[string]interface{}) { assert.Equal(t, true, input["draft"].(bool)) })) }, cmdStubs: func(cs *run.CommandStubber) { - cs.Register(`git -c log.ShowSignature=false log --pretty=format:%H,%s --cherry origin/master...feature`, 0, "") + cs.Register(`git -c log.ShowSignature=false log --pretty=format:%H%x00%s%x00%b%x00 --cherry origin/master...feature`, 0, "") cs.Register(`git rev-parse --show-toplevel`, 0, "") }, promptStubs: func(pm *prompter.PrompterMock) { @@ -884,28 +1114,28 @@ func Test_createRun(t *testing.T) { reg.Register( httpmock.GraphQL(`query RepositoryResolveMetadataIDs\b`), httpmock.StringResponse(` - { "data": { - "u000": { "login": "jillValentine", "id": "JILLID" }, - "repository": {}, - "organization": {} - } } - `)) + { "data": { + "u000": { "login": "jillValentine", "id": "JILLID" }, + "repository": {}, + "organization": {} + } } + `)) reg.Register( httpmock.GraphQL(`mutation PullRequestCreateRequestReviews\b`), httpmock.GraphQLMutation(` - { "data": { "requestReviews": { - "clientMutationId": "" - } } } - `, func(inputs map[string]interface{}) { + { "data": { "requestReviews": { + "clientMutationId": "" + } } } + `, func(inputs map[string]interface{}) { assert.Equal(t, []interface{}{"JILLID"}, inputs["userIds"]) })) reg.Register( httpmock.GraphQL(`mutation PullRequestCreate\b`), httpmock.GraphQLMutation(` - { "data": { "createPullRequest": { "pullRequest": { - "URL": "https://github.com/OWNER/REPO/pull/12" - } } } } - `, func(input map[string]interface{}) { + { "data": { "createPullRequest": { "pullRequest": { + "URL": "https://github.com/OWNER/REPO/pull/12" + } } } } + `, func(input map[string]interface{}) { assert.Equal(t, "recovered title", input["title"].(string)) assert.Equal(t, "recovered body", input["body"].(string)) })) @@ -989,13 +1219,87 @@ func Test_createRun(t *testing.T) { reg.Register( httpmock.GraphQL(`mutation PullRequestCreate\b`), httpmock.StringResponse(` - { "data": { "createPullRequest": { "pullRequest": { - "URL": "https://github.com/OWNER/REPO/pull/12" - } } } } - `)) + { "data": { "createPullRequest": { "pullRequest": { + "URL": "https://github.com/OWNER/REPO/pull/12" + } } } } + `)) }, expectedOut: "https://github.com/OWNER/REPO/pull/12\n", }, + { + name: "single commit title and body are used", + tty: true, + setup: func(opts *CreateOptions, t *testing.T) func() { + opts.HeadBranch = "feature" + return func() {} + }, + cmdStubs: func(cs *run.CommandStubber) { + cs.Register( + "git -c log.ShowSignature=false log --pretty=format:%H%x00%s%x00%b%x00 --cherry origin/master...feature", + 0, + "3a9b48085046d156c5acce8f3b3a0532cd706a4a\u0000first commit of pr\u0000first commit description\u0000\n", + ) + cs.Register(`git rev-parse --show-toplevel`, 0, "") + }, + promptStubs: func(pm *prompter.PrompterMock) { + pm.SelectFunc = func(p, _ string, opts []string) (int, error) { + if p == "Where should we push the 'feature' branch?" { + return 0, nil + } else { + return -1, prompter.NoSuchPromptErr(p) + } + } + + pm.InputFunc = func(p, d string) (string, error) { + if p == "Title" { + return d, nil + } else if p == "Body" { + return d, nil + } else { + return "", prompter.NoSuchPromptErr(p) + } + } + + pm.MarkdownEditorFunc = func(p, d string, ba bool) (string, error) { + if p == "Body" { + return d, nil + } else { + return "", prompter.NoSuchPromptErr(p) + } + } + + pm.SelectFunc = func(p, _ string, opts []string) (int, error) { + if p == "What's next?" { + return 0, nil + } else { + return -1, prompter.NoSuchPromptErr(p) + } + } + }, + httpStubs: func(reg *httpmock.Registry, t *testing.T) { + reg.Register( + httpmock.GraphQL(`query PullRequestTemplates\b`), + httpmock.StringResponse(`{ "data": { "repository": { "pullRequestTemplates": [] } } }`), + ) + reg.Register( + httpmock.GraphQL(`mutation PullRequestCreate\b`), + httpmock.GraphQLMutation(` + { + "data": { "createPullRequest": { "pullRequest": { + "URL": "https://github.com/OWNER/REPO/pull/12" + } } } + } + `, + func(input map[string]interface{}) { + assert.Equal(t, "first commit of pr", input["title"], "pr title should be first commit message") + assert.Equal(t, "first commit description", input["body"], "pr body should be first commit description") + }, + ), + ) + }, + expectedOut: "https://github.com/OWNER/REPO/pull/12\n", + expectedErrOut: "\nCreating pull request for feature into master in OWNER/REPO\n\n", + }, { name: "fill-first flag provided", tty: true, @@ -1006,25 +1310,20 @@ func Test_createRun(t *testing.T) { }, cmdStubs: func(cs *run.CommandStubber) { cs.Register( - "git -c log.ShowSignature=false log --pretty=format:%H,%s --cherry origin/master...feature", + "git -c log.ShowSignature=false log --pretty=format:%H%x00%s%x00%b%x00 --cherry origin/master...feature", 0, - "56b6f8bb7c9e3a30093cd17e48934ce354148e80,second commit of pr\n"+ - "343jdfe47c9e3a30093cd17e48934ce354148e80,first commit of pr", - ) - cs.Register( - "git -c log.ShowSignature=false show -s --pretty=format:%b 343jdfe47c9e3a30093cd17e48934ce354148e80", - 0, - "first commit description", + "56b6f8bb7c9e3a30093cd17e48934ce354148e80\u0000second commit of pr\u0000\u0000\n"+ + "3a9b48085046d156c5acce8f3b3a0532cd706a4a\u0000first commit of pr\u0000first commit description\u0000\n", ) }, httpStubs: func(reg *httpmock.Registry, t *testing.T) { reg.Register( httpmock.GraphQL(`mutation PullRequestCreate\b`), httpmock.GraphQLMutation(` - { + { "data": { "createPullRequest": { "pullRequest": { "URL": "https://github.com/OWNER/REPO/pull/12" - } } } + } } } } `, func(input map[string]interface{}) { @@ -1037,6 +1336,42 @@ func Test_createRun(t *testing.T) { expectedOut: "https://github.com/OWNER/REPO/pull/12\n", expectedErrOut: "\nCreating pull request for feature into master in OWNER/REPO\n\n", }, + { + name: "fillverbose flag provided", + tty: true, + setup: func(opts *CreateOptions, t *testing.T) func() { + opts.FillVerbose = true + opts.HeadBranch = "feature" + return func() {} + }, + cmdStubs: func(cs *run.CommandStubber) { + cs.Register( + "git -c log.ShowSignature=false log --pretty=format:%H%x00%s%x00%b%x00 --cherry origin/master...feature", + 0, + "56b6f8bb7c9e3a30093cd17e48934ce354148e80\u0000second commit of pr\u0000second commit description\u0000\n"+ + "3a9b48085046d156c5acce8f3b3a0532cd706a4a\u0000first commit of pr\u0000first commit with super long description, with super long description, with super long description, with super long description.\u0000\n", + ) + }, + httpStubs: func(reg *httpmock.Registry, t *testing.T) { + reg.Register( + httpmock.GraphQL(`mutation PullRequestCreate\b`), + httpmock.GraphQLMutation(` + { + "data": { "createPullRequest": { "pullRequest": { + "URL": "https://github.com/OWNER/REPO/pull/12" + } } } + } + `, + func(input map[string]interface{}) { + assert.Equal(t, "feature", input["title"], "pr title should be branch name") + assert.Equal(t, "- **first commit of pr**\n first commit with super long description, with super long description, with super long description, with super long description.\n\n- **second commit of pr**\n second commit description", input["body"], "pr body should be commits msg+body") + }, + ), + ) + }, + expectedOut: "https://github.com/OWNER/REPO/pull/12\n", + expectedErrOut: "\nCreating pull request for feature into master in OWNER/REPO\n\n", + }, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { @@ -1077,7 +1412,7 @@ func Test_createRun(t *testing.T) { opts.HttpClient = func() (*http.Client, error) { return &http.Client{Transport: reg}, nil } - opts.Config = func() (config.Config, error) { + opts.Config = func() (gh.Config, error) { return config.NewBlankConfig(), nil } opts.Remotes = func() (context.Remotes, error) { @@ -1115,7 +1450,12 @@ func Test_createRun(t *testing.T) { assert.EqualError(t, err, tt.wantErr) } else { assert.NoError(t, err) - assert.Equal(t, tt.expectedOut, output.String()) + if tt.expectedOut != "" { + assert.Equal(t, tt.expectedOut, output.String()) + } + if len(tt.expectedOutputs) > 0 { + assert.Equal(t, tt.expectedOutputs, strings.Split(output.String(), "\n")) + } assert.Equal(t, tt.expectedErrOut, output.Stderr()) assert.Equal(t, tt.expectedBrowse, output.BrowsedURL) } diff --git a/pkg/cmd/pr/diff/diff.go b/pkg/cmd/pr/diff/diff.go index ff09c6388..c837a530a 100644 --- a/pkg/cmd/pr/diff/diff.go +++ b/pkg/cmd/pr/diff/diff.go @@ -50,14 +50,14 @@ func NewCmdDiff(f *cmdutil.Factory, runF func(*DiffOptions) error) *cobra.Comman cmd := &cobra.Command{ Use: "diff [ | | ]", Short: "View changes in a pull request", - Long: heredoc.Doc(` + Long: heredoc.Docf(` View changes in a pull request. Without an argument, the pull request that belongs to the current branch is selected. - With '--web', open the pull request diff in a web browser instead. - `), + With %[1]s--web%[1]s flag, open the pull request diff in a web browser instead. + `, "`"), Args: cobra.MaximumNArgs(1), RunE: func(cmd *cobra.Command, args []string) error { opts.Finder = shared.NewFinder(f) diff --git a/pkg/cmd/pr/edit/edit.go b/pkg/cmd/pr/edit/edit.go index c606ae6bb..3f80aa80a 100644 --- a/pkg/cmd/pr/edit/edit.go +++ b/pkg/cmd/pr/edit/edit.go @@ -6,7 +6,7 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/api" - "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghrepo" shared "github.com/cli/cli/v2/pkg/cmd/pr/shared" "github.com/cli/cli/v2/pkg/cmdutil" @@ -47,15 +47,15 @@ func NewCmdEdit(f *cmdutil.Factory, runF func(*EditOptions) error) *cobra.Comman cmd := &cobra.Command{ Use: "edit [ | | ]", Short: "Edit a pull request", - Long: heredoc.Doc(` + Long: heredoc.Docf(` Edit a pull request. Without an argument, the pull request that belongs to the current branch is selected. - Editing a pull request's projects requires authorization with the "project" scope. - To authorize, run "gh auth refresh -s project". - `), + Editing a pull request's projects requires authorization with the %[1]sproject%[1]s scope. + To authorize, run %[1]sgh auth refresh -s project%[1]s. + `, "`"), Example: heredoc.Doc(` $ gh pr edit 23 --title "I found a bug" --body "Nothing works" $ gh pr edit 23 --add-label "bug,help wanted" --remove-label "core" @@ -309,7 +309,7 @@ type EditorRetriever interface { } type editorRetriever struct { - config func() (config.Config, error) + config func() (gh.Config, error) } func (e editorRetriever) Retrieve() (string, error) { diff --git a/pkg/cmd/pr/edit/edit_test.go b/pkg/cmd/pr/edit/edit_test.go index 1f422f9a8..0986797ea 100644 --- a/pkg/cmd/pr/edit/edit_test.go +++ b/pkg/cmd/pr/edit/edit_test.go @@ -305,7 +305,7 @@ func Test_editRun(t *testing.T) { tests := []struct { name string input *EditOptions - httpStubs func(*testing.T, *httpmock.Registry) + httpStubs func(*httpmock.Registry) stdout string stderr string }{ @@ -359,12 +359,12 @@ func Test_editRun(t *testing.T) { }, Fetcher: testFetcher{}, }, - httpStubs: func(t *testing.T, reg *httpmock.Registry) { - mockRepoMetadata(t, reg, false) - mockPullRequestUpdate(t, reg) - mockPullRequestReviewersUpdate(t, reg) - mockPullRequestUpdateLabels(t, reg) - mockProjectV2ItemUpdate(t, reg) + httpStubs: func(reg *httpmock.Registry) { + mockRepoMetadata(reg, false) + mockPullRequestUpdate(reg) + mockPullRequestReviewersUpdate(reg) + mockPullRequestUpdateLabels(reg) + mockProjectV2ItemUpdate(reg) }, stdout: "https://github.com/OWNER/REPO/pull/123\n", }, @@ -413,11 +413,11 @@ func Test_editRun(t *testing.T) { }, Fetcher: testFetcher{}, }, - httpStubs: func(t *testing.T, reg *httpmock.Registry) { - mockRepoMetadata(t, reg, true) - mockPullRequestUpdate(t, reg) - mockPullRequestUpdateLabels(t, reg) - mockProjectV2ItemUpdate(t, reg) + httpStubs: func(reg *httpmock.Registry) { + mockRepoMetadata(reg, true) + mockPullRequestUpdate(reg) + mockPullRequestUpdateLabels(reg) + mockProjectV2ItemUpdate(reg) }, stdout: "https://github.com/OWNER/REPO/pull/123\n", }, @@ -433,12 +433,12 @@ func Test_editRun(t *testing.T) { Fetcher: testFetcher{}, EditorRetriever: testEditorRetriever{}, }, - httpStubs: func(t *testing.T, reg *httpmock.Registry) { - mockRepoMetadata(t, reg, false) - mockPullRequestUpdate(t, reg) - mockPullRequestReviewersUpdate(t, reg) - mockPullRequestUpdateLabels(t, reg) - mockProjectV2ItemUpdate(t, reg) + httpStubs: func(reg *httpmock.Registry) { + mockRepoMetadata(reg, false) + mockPullRequestUpdate(reg) + mockPullRequestReviewersUpdate(reg) + mockPullRequestUpdateLabels(reg) + mockProjectV2ItemUpdate(reg) }, stdout: "https://github.com/OWNER/REPO/pull/123\n", }, @@ -454,11 +454,11 @@ func Test_editRun(t *testing.T) { Fetcher: testFetcher{}, EditorRetriever: testEditorRetriever{}, }, - httpStubs: func(t *testing.T, reg *httpmock.Registry) { - mockRepoMetadata(t, reg, true) - mockPullRequestUpdate(t, reg) - mockPullRequestUpdateLabels(t, reg) - mockProjectV2ItemUpdate(t, reg) + httpStubs: func(reg *httpmock.Registry) { + mockRepoMetadata(reg, true) + mockPullRequestUpdate(reg) + mockPullRequestUpdateLabels(reg) + mockProjectV2ItemUpdate(reg) }, stdout: "https://github.com/OWNER/REPO/pull/123\n", }, @@ -472,7 +472,7 @@ func Test_editRun(t *testing.T) { reg := &httpmock.Registry{} defer reg.Verify(t) - tt.httpStubs(t, reg) + tt.httpStubs(reg) httpClient := func() (*http.Client, error) { return &http.Client{Transport: reg}, nil } @@ -487,7 +487,7 @@ func Test_editRun(t *testing.T) { } } -func mockRepoMetadata(_ *testing.T, reg *httpmock.Registry, skipReviewers bool) { +func mockRepoMetadata(reg *httpmock.Registry, skipReviewers bool) { reg.Register( httpmock.GraphQL(`query RepositoryAssignableUsers\b`), httpmock.StringResponse(` @@ -595,19 +595,19 @@ func mockRepoMetadata(_ *testing.T, reg *httpmock.Registry, skipReviewers bool) } } -func mockPullRequestUpdate(t *testing.T, reg *httpmock.Registry) { +func mockPullRequestUpdate(reg *httpmock.Registry) { reg.Register( httpmock.GraphQL(`mutation PullRequestUpdate\b`), httpmock.StringResponse(`{}`)) } -func mockPullRequestReviewersUpdate(t *testing.T, reg *httpmock.Registry) { +func mockPullRequestReviewersUpdate(reg *httpmock.Registry) { reg.Register( httpmock.GraphQL(`mutation PullRequestUpdateRequestReviews\b`), httpmock.StringResponse(`{}`)) } -func mockPullRequestUpdateLabels(t *testing.T, reg *httpmock.Registry) { +func mockPullRequestUpdateLabels(reg *httpmock.Registry) { reg.Register( httpmock.GraphQL(`mutation LabelAdd\b`), httpmock.GraphQLMutation(` @@ -622,7 +622,7 @@ func mockPullRequestUpdateLabels(t *testing.T, reg *httpmock.Registry) { ) } -func mockProjectV2ItemUpdate(t *testing.T, reg *httpmock.Registry) { +func mockProjectV2ItemUpdate(reg *httpmock.Registry) { reg.Register( httpmock.GraphQL(`mutation UpdateProjectV2Items\b`), httpmock.GraphQLMutation(` diff --git a/pkg/cmd/pr/list/list.go b/pkg/cmd/pr/list/list.go index cea7c2b19..7721ecc1b 100644 --- a/pkg/cmd/pr/list/list.go +++ b/pkg/cmd/pr/list/list.go @@ -11,11 +11,11 @@ import ( "github.com/cli/cli/v2/api" "github.com/cli/cli/v2/internal/browser" "github.com/cli/cli/v2/internal/ghrepo" + "github.com/cli/cli/v2/internal/tableprinter" "github.com/cli/cli/v2/internal/text" "github.com/cli/cli/v2/pkg/cmd/pr/shared" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" - "github.com/cli/cli/v2/utils" "github.com/spf13/cobra" ) @@ -199,25 +199,32 @@ func listRun(opts *ListOptions) error { } cs := opts.IO.ColorScheme() - //nolint:staticcheck // SA1019: utils.NewTablePrinter is deprecated: use internal/tableprinter - table := utils.NewTablePrinter(opts.IO) + isTTY := opts.IO.IsStdoutTTY() + + headers := []string{ + "ID", + "TITLE", + "BRANCH", + } + if !isTTY { + headers = append(headers, "STATE") + } + headers = append(headers, "CREATED AT") + + table := tableprinter.New(opts.IO, tableprinter.WithHeader(headers...)) for _, pr := range listResult.PullRequests { prNum := strconv.Itoa(pr.Number) - if table.IsTTY() { + if isTTY { prNum = "#" + prNum } - table.AddField(prNum, nil, cs.ColorFromString(shared.ColorForPRState(pr))) - table.AddField(text.RemoveExcessiveWhitespace(pr.Title), nil, nil) - table.AddField(pr.HeadLabel(), nil, cs.Cyan) - if !table.IsTTY() { - table.AddField(prStateWithDraft(&pr), nil, nil) - } - if table.IsTTY() { - table.AddField(text.FuzzyAgo(opts.Now(), pr.CreatedAt), nil, cs.Gray) - } else { - table.AddField(pr.CreatedAt.String(), nil, nil) + table.AddField(prNum, tableprinter.WithColor(cs.ColorFromString(shared.ColorForPRState(pr)))) + table.AddField(text.RemoveExcessiveWhitespace(pr.Title)) + table.AddField(pr.HeadLabel(), tableprinter.WithColor(cs.Cyan)) + if !isTTY { + table.AddField(prStateWithDraft(&pr)) } + table.AddTimeField(opts.Now(), pr.CreatedAt, cs.Gray) table.EndRow() } err = table.Render() diff --git a/pkg/cmd/pr/list/list_test.go b/pkg/cmd/pr/list/list_test.go index bc661f104..869db9c38 100644 --- a/pkg/cmd/pr/list/list_test.go +++ b/pkg/cmd/pr/list/list_test.go @@ -9,15 +9,18 @@ import ( "time" "github.com/MakeNowJust/heredoc" + "github.com/cli/cli/v2/api" "github.com/cli/cli/v2/internal/browser" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/internal/run" + prShared "github.com/cli/cli/v2/pkg/cmd/pr/shared" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/httpmock" "github.com/cli/cli/v2/pkg/iostreams" "github.com/cli/cli/v2/test" "github.com/google/shlex" "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" ) func runCommand(rt http.RoundTripper, isTTY bool, cli string) (*test.CmdOut, error) { @@ -84,6 +87,7 @@ func TestPRList(t *testing.T) { Showing 3 of 3 open pull requests in OWNER/REPO + ID TITLE BRANCH CREATED AT #32 New feature feature about 3 hours ago #29 Fixed bad bug hubot:bug-fix about 1 month ago #28 Improve documentation docs about 2 years ago @@ -104,9 +108,9 @@ func TestPRList_nontty(t *testing.T) { assert.Equal(t, "", output.Stderr()) - assert.Equal(t, `32 New feature feature DRAFT 2022-08-24 20:01:12 +0000 UTC -29 Fixed bad bug hubot:bug-fix OPEN 2022-07-20 19:01:12 +0000 UTC -28 Improve documentation docs MERGED 2020-01-26 19:01:12 +0000 UTC + assert.Equal(t, `32 New feature feature DRAFT 2022-08-24T20:01:12Z +29 Fixed bad bug hubot:bug-fix OPEN 2022-07-20T19:01:12Z +28 Improve documentation docs MERGED 2020-01-26T19:01:12Z `, output.String()) } @@ -319,3 +323,146 @@ func TestPRList_web(t *testing.T) { }) } } + +func TestPRList_withProjectItems(t *testing.T) { + reg := &httpmock.Registry{} + defer reg.Verify(t) + + reg.Register( + httpmock.GraphQL(`query PullRequestList\b`), + httpmock.GraphQLQuery(`{ + "data": { + "repository": { + "pullRequests": { + "totalCount": 1, + "nodes": [ + { + "projectItems": { + "nodes": [ + { + "id": "PVTI_lAHOAA3WC84AW6WNzgJ8rnQ", + "project": { + "id": "PVT_kwHOAA3WC84AW6WN", + "title": "Test Public Project" + }, + "status": { + "optionId": "47fc9ee4", + "name": "In Progress" + } + } + ], + "totalCount": 1 + } + } + ] + } + } + } + }`, func(_ string, params map[string]interface{}) { + require.Equal(t, map[string]interface{}{ + "owner": "OWNER", + "repo": "REPO", + "limit": float64(30), + "state": []interface{}{"OPEN"}, + }, params) + })) + + client := &http.Client{Transport: reg} + prsAndTotalCount, err := listPullRequests( + client, + ghrepo.New("OWNER", "REPO"), + prShared.FilterOptions{ + Entity: "pr", + State: "open", + }, + 30, + ) + + require.NoError(t, err) + require.Len(t, prsAndTotalCount.PullRequests, 1) + require.Len(t, prsAndTotalCount.PullRequests[0].ProjectItems.Nodes, 1) + + require.Equal(t, prsAndTotalCount.PullRequests[0].ProjectItems.Nodes[0].ID, "PVTI_lAHOAA3WC84AW6WNzgJ8rnQ") + + expectedProject := api.ProjectV2ItemProject{ + ID: "PVT_kwHOAA3WC84AW6WN", + Title: "Test Public Project", + } + require.Equal(t, prsAndTotalCount.PullRequests[0].ProjectItems.Nodes[0].Project, expectedProject) + + expectedStatus := api.ProjectV2ItemStatus{ + OptionID: "47fc9ee4", + Name: "In Progress", + } + require.Equal(t, prsAndTotalCount.PullRequests[0].ProjectItems.Nodes[0].Status, expectedStatus) +} + +func TestPRList_Search_withProjectItems(t *testing.T) { + reg := &httpmock.Registry{} + defer reg.Verify(t) + + reg.Register( + httpmock.GraphQL(`query PullRequestSearch\b`), + httpmock.GraphQLQuery(`{ + "data": { + "search": { + "issueCount": 1, + "nodes": [ + { + "projectItems": { + "nodes": [ + { + "id": "PVTI_lAHOAA3WC84AW6WNzgJ8rl0", + "project": { + "id": "PVT_kwHOAA3WC84AW6WN", + "title": "Test Public Project" + }, + "status": { + "optionId": "47fc9ee4", + "name": "In Progress" + } + } + ], + "totalCount": 1 + } + } + ] + } + } + }`, func(_ string, params map[string]interface{}) { + require.Equal(t, map[string]interface{}{ + "limit": float64(30), + "q": "just used to force the search API branch repo:OWNER/REPO state:open type:pr", + }, params) + })) + + client := &http.Client{Transport: reg} + prsAndTotalCount, err := listPullRequests( + client, + ghrepo.New("OWNER", "REPO"), + prShared.FilterOptions{ + Entity: "pr", + State: "open", + Search: "just used to force the search API branch", + }, + 30, + ) + + require.NoError(t, err) + require.Len(t, prsAndTotalCount.PullRequests, 1) + require.Len(t, prsAndTotalCount.PullRequests[0].ProjectItems.Nodes, 1) + + require.Equal(t, prsAndTotalCount.PullRequests[0].ProjectItems.Nodes[0].ID, "PVTI_lAHOAA3WC84AW6WNzgJ8rl0") + + expectedProject := api.ProjectV2ItemProject{ + ID: "PVT_kwHOAA3WC84AW6WN", + Title: "Test Public Project", + } + require.Equal(t, prsAndTotalCount.PullRequests[0].ProjectItems.Nodes[0].Project, expectedProject) + + expectedStatus := api.ProjectV2ItemStatus{ + OptionID: "47fc9ee4", + Name: "In Progress", + } + require.Equal(t, prsAndTotalCount.PullRequests[0].ProjectItems.Nodes[0].Status, expectedStatus) +} diff --git a/pkg/cmd/pr/merge/merge.go b/pkg/cmd/pr/merge/merge.go index a23dc7390..1e7deabcb 100644 --- a/pkg/cmd/pr/merge/merge.go +++ b/pkg/cmd/pr/merge/merge.go @@ -10,7 +10,7 @@ import ( "github.com/cli/cli/v2/api" ghContext "github.com/cli/cli/v2/context" "github.com/cli/cli/v2/git" - "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/pkg/cmd/pr/shared" "github.com/cli/cli/v2/pkg/cmdutil" @@ -78,17 +78,17 @@ func NewCmdMerge(f *cmdutil.Factory, runF func(*MergeOptions) error) *cobra.Comm cmd := &cobra.Command{ Use: "merge [ | | ]", Short: "Merge a pull request", - Long: heredoc.Doc(` + Long: heredoc.Docf(` Merge a pull request on GitHub. Without an argument, the pull request that belongs to the current branch is selected. When targeting a branch that requires a merge queue, no merge strategy is required. - If required checks have not yet passed, AutoMerge will be enabled. + If required checks have not yet passed, auto-merge will be enabled. If required checks have passed, the pull request will be added to the merge queue. - To bypass a merge queue and merge directly, pass the '--admin' flag. - `), + To bypass a merge queue and merge directly, pass the %[1]s--admin%[1]s flag. + `, "`"), Args: cobra.MaximumNArgs(1), RunE: func(cmd *cobra.Command, args []string) error { opts.Finder = shared.NewFinder(f) @@ -207,14 +207,14 @@ func (m *mergeContext) disableAutoMerge() error { if err := disableAutoMerge(m.httpClient, m.baseRepo, m.pr.ID); err != nil { return err } - return m.infof("%s Auto-merge disabled for pull request #%d\n", m.cs.SuccessIconWithColor(m.cs.Green), m.pr.Number) + return m.infof("%s Auto-merge disabled for pull request %s#%d\n", m.cs.SuccessIconWithColor(m.cs.Green), ghrepo.FullName(m.baseRepo), m.pr.Number) } // Check if this pull request is in a merge queue func (m *mergeContext) inMergeQueue() error { // if the pull request is in a merge queue no further action is possible if m.pr.IsInMergeQueue { - _ = m.warnf("%s Pull request #%d is already queued to merge\n", m.cs.WarningIcon(), m.pr.Number) + _ = m.warnf("%s Pull request %s#%d is already queued to merge\n", m.cs.WarningIcon(), ghrepo.FullName(m.baseRepo), m.pr.Number) return ErrAlreadyInMergeQueue } return nil @@ -235,7 +235,7 @@ func (m *mergeContext) warnIfDiverged() { return } - _ = m.warnf("%s Pull request #%d (%s) has diverged from local branch\n", m.cs.Yellow("!"), m.pr.Number, m.pr.Title) + _ = m.warnf("%s Pull request %s#%d (%s) has diverged from local branch\n", m.cs.Yellow("!"), ghrepo.FullName(m.baseRepo), m.pr.Number, m.pr.Title) } // Check if the current state of the pull request allows for merging @@ -251,7 +251,7 @@ func (m *mergeContext) canMerge() error { return nil } - _ = m.warnf("%s Pull request #%d is not mergeable: %s.\n", m.cs.FailureIcon(), m.pr.Number, reason) + _ = m.warnf("%s Pull request %s#%d is not mergeable: %s.\n", m.cs.FailureIcon(), ghrepo.FullName(m.baseRepo), m.pr.Number, reason) _ = m.warnf("To have the pull request merged after all the requirements have been met, add the `--auto` flag.\n") if remote := remoteForMergeConflictResolution(m.baseRepo, m.pr, m.opts); remote != nil { mergeOrRebase := "merge" @@ -302,6 +302,8 @@ func (m *mergeContext) merge() error { return cmdutil.FlagErrorf("--merge, --rebase, or --squash required when not running interactively") } + _ = m.infof("Merging pull request %s#%d (%s)\n", ghrepo.FullName(m.baseRepo), m.pr.Number, m.pr.Title) + apiClient := api.NewClientFromHTTP(m.httpClient) r, err := api.GitHubRepo(apiClient, m.baseRepo) if err != nil { @@ -342,7 +344,7 @@ func (m *mergeContext) merge() error { } if m.shouldAddToMergeQueue() { - _ = m.infof("%s Pull request #%d will be added to the merge queue for %s when ready\n", m.cs.SuccessIconWithColor(m.cs.Green), m.pr.Number, m.pr.BaseRefName) + _ = m.infof("%s Pull request %s#%d will be added to the merge queue for %s when ready\n", m.cs.SuccessIconWithColor(m.cs.Green), ghrepo.FullName(m.baseRepo), m.pr.Number, m.pr.BaseRefName) return nil } @@ -354,7 +356,7 @@ func (m *mergeContext) merge() error { case PullRequestMergeMethodSquash: method = " via squash" } - return m.infof("%s Pull request #%d will be automatically merged%s when all requirements are met\n", m.cs.SuccessIconWithColor(m.cs.Green), m.pr.Number, method) + return m.infof("%s Pull request %s#%d will be automatically merged%s when all requirements are met\n", m.cs.SuccessIconWithColor(m.cs.Green), ghrepo.FullName(m.baseRepo), m.pr.Number, method) } action := "Merged" @@ -364,7 +366,7 @@ func (m *mergeContext) merge() error { case PullRequestMergeMethodSquash: action = "Squashed and merged" } - return m.infof("%s %s pull request #%d (%s)\n", m.cs.SuccessIconWithColor(m.cs.Magenta), action, m.pr.Number, m.pr.Title) + return m.infof("%s %s pull request %s#%d (%s)\n", m.cs.SuccessIconWithColor(m.cs.Magenta), action, ghrepo.FullName(m.baseRepo), m.pr.Number, m.pr.Title) } // Delete local branch if requested and if allowed. @@ -375,13 +377,13 @@ func (m *mergeContext) deleteLocalBranch() error { if m.merged { if m.opts.IO.CanPrompt() && !m.opts.IsDeleteBranchIndicated { - confirmed, err := m.opts.Prompter.Confirm(fmt.Sprintf("Pull request #%d was already merged. Delete the branch locally?", m.pr.Number), false) + confirmed, err := m.opts.Prompter.Confirm(fmt.Sprintf("Pull request %s#%d was already merged. Delete the branch locally?", ghrepo.FullName(m.baseRepo), m.pr.Number), false) if err != nil { return fmt.Errorf("could not prompt: %w", err) } m.deleteBranch = confirmed } else { - _ = m.warnf(fmt.Sprintf("%s Pull request #%d was already merged\n", m.cs.WarningIcon(), m.pr.Number)) + _ = m.warnf(fmt.Sprintf("%s Pull request %s#%d was already merged\n", m.cs.WarningIcon(), ghrepo.FullName(m.baseRepo), m.pr.Number)) } } @@ -678,7 +680,7 @@ func confirmSubmission(client *http.Client, opts *MergeOptions, action shared.Ac type userEditor struct { io *iostreams.IOStreams - config func() (config.Config, error) + config func() (gh.Config, error) } func (e *userEditor) Edit(filename, startingText string) (string, error) { diff --git a/pkg/cmd/pr/merge/merge_test.go b/pkg/cmd/pr/merge/merge_test.go index 5055bf8f4..21df882b4 100644 --- a/pkg/cmd/pr/merge/merge_test.go +++ b/pkg/cmd/pr/merge/merge_test.go @@ -337,7 +337,7 @@ func TestPrMerge(t *testing.T) { t.Fatalf("error running command `pr merge`: %v", err) } - r := regexp.MustCompile(`Merged pull request #1 \(The title of the PR\)`) + r := regexp.MustCompile(`Merged pull request OWNER/REPO#1 \(The title of the PR\)`) if !r.MatchString(output.Stderr()) { t.Fatalf("output did not match regexp /%s/\n> output\n%q\n", r, output.Stderr()) @@ -369,7 +369,7 @@ func TestPrMerge_blocked(t *testing.T) { assert.Equal(t, "", output.String()) assert.Equal(t, heredoc.Docf(` - X Pull request #1 is not mergeable: the base branch policy prohibits the merge. + X Pull request OWNER/REPO#1 is not mergeable: the base branch policy prohibits the merge. To have the pull request merged after all the requirements have been met, add the %[1]s--auto%[1]s flag. To use administrator privileges to immediately merge the pull request, add the %[1]s--admin%[1]s flag. `, "`"), output.Stderr()) @@ -402,7 +402,7 @@ func TestPrMerge_dirty(t *testing.T) { assert.Equal(t, "", output.String()) assert.Equal(t, heredoc.Docf(` - X Pull request #123 is not mergeable: the merge commit cannot be cleanly created. + X Pull request OWNER/REPO#123 is not mergeable: the merge commit cannot be cleanly created. To have the pull request merged after all the requirements have been met, add the %[1]s--auto%[1]s flag. Run the following to resolve the merge conflicts locally: gh pr checkout 123 && git fetch origin trunk && git merge origin/trunk @@ -518,7 +518,7 @@ func TestPrMerge_withRepoFlag(t *testing.T) { t.Fatalf("error running command `pr merge`: %v", err) } - r := regexp.MustCompile(`Merged pull request #1 \(The title of the PR\)`) + r := regexp.MustCompile(`Merged pull request OWNER/REPO#1 \(The title of the PR\)`) if !r.MatchString(output.Stderr()) { t.Fatalf("output did not match regexp /%s/\n> output\n%q\n", r, output.Stderr()) @@ -559,7 +559,7 @@ func TestPrMerge_withMatchCommitHeadFlag(t *testing.T) { t.Fatalf("error running command `pr merge`: %v", err) } - r := regexp.MustCompile(`Merged pull request #1 \(The title of the PR\)`) + r := regexp.MustCompile(`Merged pull request OWNER/REPO#1 \(The title of the PR\)`) if !r.MatchString(output.Stderr()) { t.Fatalf("output did not match regexp /%s/\n> output\n%q\n", r, output.Stderr()) @@ -601,7 +601,7 @@ func TestPrMerge_withAuthorFlag(t *testing.T) { t.Fatalf("error running command `pr merge`: %v", err) } - r := regexp.MustCompile(`Merged pull request #1 \(The title of the PR\)`) + r := regexp.MustCompile(`Merged pull request OWNER/REPO#1 \(The title of the PR\)`) if !r.MatchString(output.Stderr()) { t.Fatalf("output did not match regexp /%s/\n> output\n%q\n", r, output.Stderr()) @@ -653,7 +653,7 @@ func TestPrMerge_deleteBranch(t *testing.T) { assert.Equal(t, "", output.String()) assert.Equal(t, heredoc.Doc(` - ✓ Merged pull request #10 (Blueberries are a good fruit) + ✓ Merged pull request OWNER/REPO#10 (Blueberries are a good fruit) ✓ Deleted local branch blueberries and switched to branch main ✓ Deleted remote branch blueberries `), output.Stderr()) @@ -704,7 +704,7 @@ func TestPrMerge_deleteBranch_nonDefault(t *testing.T) { assert.Equal(t, "", output.String()) assert.Equal(t, heredoc.Doc(` - ✓ Merged pull request #10 (Blueberries are a good fruit) + ✓ Merged pull request OWNER/REPO#10 (Blueberries are a good fruit) ✓ Deleted local branch blueberries and switched to branch fruit ✓ Deleted remote branch blueberries `), output.Stderr()) @@ -753,7 +753,7 @@ func TestPrMerge_deleteBranch_onlyLocally(t *testing.T) { assert.Equal(t, "", output.String()) assert.Equal(t, heredoc.Doc(` - ✓ Merged pull request #10 (Blueberries are a good fruit) + ✓ Merged pull request OWNER/REPO#10 (Blueberries are a good fruit) ✓ Deleted local branch blueberries and switched to branch main `), output.Stderr()) } @@ -803,7 +803,7 @@ func TestPrMerge_deleteBranch_checkoutNewBranch(t *testing.T) { assert.Equal(t, "", output.String()) assert.Equal(t, heredoc.Doc(` - ✓ Merged pull request #10 (Blueberries are a good fruit) + ✓ Merged pull request OWNER/REPO#10 (Blueberries are a good fruit) ✓ Deleted local branch blueberries and switched to branch fruit ✓ Deleted remote branch blueberries `), output.Stderr()) @@ -850,7 +850,7 @@ func TestPrMerge_deleteNonCurrentBranch(t *testing.T) { assert.Equal(t, "", output.String()) assert.Equal(t, heredoc.Doc(` - ✓ Merged pull request #10 (Blueberries are a good fruit) + ✓ Merged pull request OWNER/REPO#10 (Blueberries are a good fruit) ✓ Deleted local branch blueberries ✓ Deleted remote branch blueberries `), output.Stderr()) @@ -892,7 +892,7 @@ func Test_nonDivergingPullRequest(t *testing.T) { } assert.Equal(t, heredoc.Doc(` - ✓ Merged pull request #10 (Blueberries are a good fruit) + ✓ Merged pull request OWNER/REPO#10 (Blueberries are a good fruit) `), output.Stderr()) } @@ -932,8 +932,8 @@ func Test_divergingPullRequestWarning(t *testing.T) { } assert.Equal(t, heredoc.Doc(` - ! Pull request #10 (Blueberries are a good fruit) has diverged from local branch - ✓ Merged pull request #10 (Blueberries are a good fruit) + ! Pull request OWNER/REPO#10 (Blueberries are a good fruit) has diverged from local branch + ✓ Merged pull request OWNER/REPO#10 (Blueberries are a good fruit) `), output.Stderr()) } @@ -972,7 +972,7 @@ func Test_pullRequestWithoutCommits(t *testing.T) { } assert.Equal(t, heredoc.Doc(` - ✓ Merged pull request #10 (Blueberries are a good fruit) + ✓ Merged pull request OWNER/REPO#10 (Blueberries are a good fruit) `), output.Stderr()) } @@ -1010,7 +1010,7 @@ func TestPrMerge_rebase(t *testing.T) { t.Fatalf("error running command `pr merge`: %v", err) } - r := regexp.MustCompile(`Rebased and merged pull request #2 \(The title of the PR\)`) + r := regexp.MustCompile(`Rebased and merged pull request OWNER/REPO#2 \(The title of the PR\)`) if !r.MatchString(output.Stderr()) { t.Fatalf("output did not match regexp /%s/\n> output\n%q\n", r, output.Stderr()) @@ -1053,7 +1053,7 @@ func TestPrMerge_squash(t *testing.T) { assert.Equal(t, "", output.String()) assert.Equal(t, heredoc.Doc(` - ✓ Squashed and merged pull request #3 (The title of the PR) + ✓ Squashed and merged pull request OWNER/REPO#3 (The title of the PR) `), output.Stderr()) } @@ -1085,7 +1085,7 @@ func TestPrMerge_alreadyMerged(t *testing.T) { pm := &prompter.PrompterMock{ ConfirmFunc: func(p string, d bool) (bool, error) { - if p == "Pull request #4 was already merged. Delete the branch locally?" { + if p == "Pull request OWNER/REPO#4 was already merged. Delete the branch locally?" { return true, nil } else { return false, prompter.NoSuchPromptErr(p) @@ -1129,7 +1129,7 @@ func TestPrMerge_alreadyMerged_withMergeStrategy(t *testing.T) { } assert.Equal(t, "", output.String()) - assert.Equal(t, "! Pull request #4 was already merged\n", output.Stderr()) + assert.Equal(t, "! Pull request OWNER/REPO#4 was already merged\n", output.Stderr()) } func TestPrMerge_alreadyMerged_withMergeStrategy_TTY(t *testing.T) { @@ -1156,7 +1156,7 @@ func TestPrMerge_alreadyMerged_withMergeStrategy_TTY(t *testing.T) { pm := &prompter.PrompterMock{ ConfirmFunc: func(p string, d bool) (bool, error) { - if p == "Pull request #4 was already merged. Delete the branch locally?" { + if p == "Pull request OWNER/REPO#4 was already merged. Delete the branch locally?" { return true, nil } else { return false, prompter.NoSuchPromptErr(p) @@ -1196,7 +1196,7 @@ func TestPrMerge_alreadyMerged_withMergeStrategy_crossRepo(t *testing.T) { pm := &prompter.PrompterMock{ ConfirmFunc: func(p string, d bool) (bool, error) { - if p == "Pull request #4 was already merged. Delete the branch locally?" { + if p == "Pull request OWNER/REPO#4 was already merged. Delete the branch locally?" { return d, nil } else { return false, prompter.NoSuchPromptErr(p) @@ -1275,7 +1275,7 @@ func TestPRMergeTTY(t *testing.T) { t.Fatalf("Got unexpected error running `pr merge` %s", err) } - assert.Equal(t, "✓ Merged pull request #3 (It was the best of times)\n", output.Stderr()) + assert.Equal(t, "Merging pull request OWNER/REPO#3 (It was the best of times)\n✓ Merged pull request OWNER/REPO#3 (It was the best of times)\n", output.Stderr()) } func TestPRMergeTTY_withDeleteBranch(t *testing.T) { @@ -1346,7 +1346,8 @@ func TestPRMergeTTY_withDeleteBranch(t *testing.T) { assert.Equal(t, "", output.String()) assert.Equal(t, heredoc.Doc(` - ✓ Merged pull request #3 (It was the best of times) + Merging pull request OWNER/REPO#3 (It was the best of times) + ✓ Merged pull request OWNER/REPO#3 (It was the best of times) ✓ Deleted local branch blueberries and switched to branch main ✓ Deleted remote branch blueberries `), output.Stderr()) @@ -1437,7 +1438,7 @@ func TestPRMergeTTY_squashEditCommitMsgAndSubject(t *testing.T) { assert.NoError(t, err) assert.Equal(t, "", stdout.String()) - assert.Equal(t, "✓ Squashed and merged pull request #123 (title)\n", stderr.String()) + assert.Equal(t, "Merging pull request OWNER/REPO#123 (title)\n✓ Squashed and merged pull request OWNER/REPO#123 (title)\n", stderr.String()) } func TestPRMergeEmptyStrategyNonTTY(t *testing.T) { @@ -1473,7 +1474,7 @@ func TestPRTTY_cancelled(t *testing.T) { shared.RunCommandFinder( "", - &api.PullRequest{ID: "THE-ID", Number: 123, MergeStateStatus: "CLEAN"}, + &api.PullRequest{ID: "THE-ID", Number: 123, Title: "title", MergeStateStatus: "CLEAN"}, ghrepo.New("OWNER", "REPO"), ) @@ -1516,7 +1517,7 @@ func TestPRTTY_cancelled(t *testing.T) { t.Fatalf("got error %v", err) } - assert.Equal(t, "Cancelled.\n", output.Stderr()) + assert.Equal(t, "Merging pull request OWNER/REPO#123 (title)\nCancelled.\n", output.Stderr()) } func Test_mergeMethodSurvey(t *testing.T) { @@ -1575,7 +1576,7 @@ func TestMergeRun_autoMerge(t *testing.T) { assert.NoError(t, err) assert.Equal(t, "", stdout.String()) - assert.Equal(t, "✓ Pull request #123 will be automatically merged via squash when all requirements are met\n", stderr.String()) + assert.Equal(t, "✓ Pull request OWNER/REPO#123 will be automatically merged via squash when all requirements are met\n", stderr.String()) } func TestMergeRun_autoMerge_directMerge(t *testing.T) { @@ -1613,7 +1614,7 @@ func TestMergeRun_autoMerge_directMerge(t *testing.T) { assert.NoError(t, err) assert.Equal(t, "", stdout.String()) - assert.Equal(t, "✓ Merged pull request #123 ()\n", stderr.String()) + assert.Equal(t, "✓ Merged pull request OWNER/REPO#123 ()\n", stderr.String()) } func TestMergeRun_disableAutoMerge(t *testing.T) { @@ -1648,7 +1649,7 @@ func TestMergeRun_disableAutoMerge(t *testing.T) { assert.NoError(t, err) assert.Equal(t, "", stdout.String()) - assert.Equal(t, "✓ Auto-merge disabled for pull request #123\n", stderr.String()) + assert.Equal(t, "✓ Auto-merge disabled for pull request OWNER/REPO#123\n", stderr.String()) } func TestPrInMergeQueue(t *testing.T) { @@ -1679,7 +1680,7 @@ func TestPrInMergeQueue(t *testing.T) { } assert.Equal(t, "", output.String()) - assert.Equal(t, "! Pull request #1 is already queued to merge\n", output.Stderr()) + assert.Equal(t, "! Pull request OWNER/REPO#1 is already queued to merge\n", output.Stderr()) } func TestPrAddToMergeQueueWithMergeMethod(t *testing.T) { @@ -1717,7 +1718,7 @@ func TestPrAddToMergeQueueWithMergeMethod(t *testing.T) { t.Fatalf("error running command `pr merge`: %v", err) } assert.Equal(t, "", output.String()) - assert.Equal(t, "! The merge strategy for main is set by the merge queue\n✓ Pull request #1 will be added to the merge queue for main when ready\n", output.Stderr()) + assert.Equal(t, "! The merge strategy for main is set by the merge queue\n✓ Pull request OWNER/REPO#1 will be added to the merge queue for main when ready\n", output.Stderr()) } func TestPrAddToMergeQueueClean(t *testing.T) { @@ -1757,7 +1758,7 @@ func TestPrAddToMergeQueueClean(t *testing.T) { } assert.Equal(t, "", output.String()) - assert.Equal(t, "✓ Pull request #1 will be added to the merge queue for main when ready\n", output.Stderr()) + assert.Equal(t, "✓ Pull request OWNER/REPO#1 will be added to the merge queue for main when ready\n", output.Stderr()) } func TestPrAddToMergeQueueBlocked(t *testing.T) { @@ -1797,7 +1798,7 @@ func TestPrAddToMergeQueueBlocked(t *testing.T) { } assert.Equal(t, "", output.String()) - assert.Equal(t, "✓ Pull request #1 will be added to the merge queue for main when ready\n", output.Stderr()) + assert.Equal(t, "✓ Pull request OWNER/REPO#1 will be added to the merge queue for main when ready\n", output.Stderr()) } func TestPrAddToMergeQueueAdmin(t *testing.T) { @@ -1866,7 +1867,7 @@ func TestPrAddToMergeQueueAdmin(t *testing.T) { } assert.Equal(t, "", output.String()) - assert.Equal(t, "✓ Merged pull request #1 (The title of the PR)\n", output.Stderr()) + assert.Equal(t, "Merging pull request OWNER/REPO#1 (The title of the PR)\n✓ Merged pull request OWNER/REPO#1 (The title of the PR)\n", output.Stderr()) } func TestPrAddToMergeQueueAdminWithMergeStrategy(t *testing.T) { @@ -1905,7 +1906,7 @@ func TestPrAddToMergeQueueAdminWithMergeStrategy(t *testing.T) { } assert.Equal(t, "", output.String()) - assert.Equal(t, "✓ Merged pull request #1 (The title of the PR)\n", output.Stderr()) + assert.Equal(t, "✓ Merged pull request OWNER/REPO#1 (The title of the PR)\n", output.Stderr()) } type testEditor struct{} diff --git a/pkg/cmd/pr/ready/ready.go b/pkg/cmd/pr/ready/ready.go index ee0cfe2fd..7b985a3ce 100644 --- a/pkg/cmd/pr/ready/ready.go +++ b/pkg/cmd/pr/ready/ready.go @@ -6,6 +6,7 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/api" + "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/pkg/cmd/pr/shared" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" @@ -31,14 +32,14 @@ func NewCmdReady(f *cmdutil.Factory, runF func(*ReadyOptions) error) *cobra.Comm cmd := &cobra.Command{ Use: "ready [ | | ]", Short: "Mark a pull request as ready for review", - Long: heredoc.Doc(` + Long: heredoc.Docf(` Mark a pull request as ready for review. Without an argument, the pull request that belongs to the current branch is marked as ready. - If supported by your plan, convert to draft with --undo - `), + If supported by your plan, convert to draft with %[1]s--undo%[1]s + `, "`"), Args: cobra.MaximumNArgs(1), RunE: func(cmd *cobra.Command, args []string) error { opts.Finder = shared.NewFinder(f) @@ -75,7 +76,7 @@ func readyRun(opts *ReadyOptions) error { } if !pr.IsOpen() { - fmt.Fprintf(opts.IO.ErrOut, "%s Pull request #%d is closed. Only draft pull requests can be marked as \"ready for review\"\n", cs.FailureIcon(), pr.Number) + fmt.Fprintf(opts.IO.ErrOut, "%s Pull request %s#%d is closed. Only draft pull requests can be marked as \"ready for review\"\n", cs.FailureIcon(), ghrepo.FullName(baseRepo), pr.Number) return cmdutil.SilentError } @@ -87,7 +88,7 @@ func readyRun(opts *ReadyOptions) error { if opts.Undo { // convert to draft if pr.IsDraft { - fmt.Fprintf(opts.IO.ErrOut, "%s Pull request #%d is already \"in draft\"\n", cs.WarningIcon(), pr.Number) + fmt.Fprintf(opts.IO.ErrOut, "%s Pull request %s#%d is already \"in draft\"\n", cs.WarningIcon(), ghrepo.FullName(baseRepo), pr.Number) return nil } err = api.ConvertPullRequestToDraft(apiClient, baseRepo, pr) @@ -95,10 +96,10 @@ func readyRun(opts *ReadyOptions) error { return fmt.Errorf("API call failed: %w", err) } - fmt.Fprintf(opts.IO.ErrOut, "%s Pull request #%d is converted to \"draft\"\n", cs.SuccessIconWithColor(cs.Green), pr.Number) + fmt.Fprintf(opts.IO.ErrOut, "%s Pull request %s#%d is converted to \"draft\"\n", cs.SuccessIconWithColor(cs.Green), ghrepo.FullName(baseRepo), pr.Number) } else { // mark as ready for review if !pr.IsDraft { - fmt.Fprintf(opts.IO.ErrOut, "%s Pull request #%d is already \"ready for review\"\n", cs.WarningIcon(), pr.Number) + fmt.Fprintf(opts.IO.ErrOut, "%s Pull request %s#%d is already \"ready for review\"\n", cs.WarningIcon(), ghrepo.FullName(baseRepo), pr.Number) return nil } @@ -107,7 +108,7 @@ func readyRun(opts *ReadyOptions) error { return fmt.Errorf("API call failed: %w", err) } - fmt.Fprintf(opts.IO.ErrOut, "%s Pull request #%d is marked as \"ready for review\"\n", cs.SuccessIconWithColor(cs.Green), pr.Number) + fmt.Fprintf(opts.IO.ErrOut, "%s Pull request %s#%d is marked as \"ready for review\"\n", cs.SuccessIconWithColor(cs.Green), ghrepo.FullName(baseRepo), pr.Number) } return nil diff --git a/pkg/cmd/pr/ready/ready_test.go b/pkg/cmd/pr/ready/ready_test.go index 449b9055f..9046ab3ac 100644 --- a/pkg/cmd/pr/ready/ready_test.go +++ b/pkg/cmd/pr/ready/ready_test.go @@ -142,7 +142,7 @@ func TestPRReady(t *testing.T) { output, err := runCommand(http, true, "123") assert.NoError(t, err) assert.Equal(t, "", output.String()) - assert.Equal(t, "✓ Pull request #123 is marked as \"ready for review\"\n", output.Stderr()) + assert.Equal(t, "✓ Pull request OWNER/REPO#123 is marked as \"ready for review\"\n", output.Stderr()) } func TestPRReady_alreadyReady(t *testing.T) { @@ -159,7 +159,7 @@ func TestPRReady_alreadyReady(t *testing.T) { output, err := runCommand(http, true, "123") assert.NoError(t, err) assert.Equal(t, "", output.String()) - assert.Equal(t, "! Pull request #123 is already \"ready for review\"\n", output.Stderr()) + assert.Equal(t, "! Pull request OWNER/REPO#123 is already \"ready for review\"\n", output.Stderr()) } func TestPRReadyUndo(t *testing.T) { @@ -184,7 +184,7 @@ func TestPRReadyUndo(t *testing.T) { output, err := runCommand(http, true, "123 --undo") assert.NoError(t, err) assert.Equal(t, "", output.String()) - assert.Equal(t, "✓ Pull request #123 is converted to \"draft\"\n", output.Stderr()) + assert.Equal(t, "✓ Pull request OWNER/REPO#123 is converted to \"draft\"\n", output.Stderr()) } func TestPRReadyUndo_alreadyDraft(t *testing.T) { @@ -201,7 +201,7 @@ func TestPRReadyUndo_alreadyDraft(t *testing.T) { output, err := runCommand(http, true, "123 --undo") assert.NoError(t, err) assert.Equal(t, "", output.String()) - assert.Equal(t, "! Pull request #123 is already \"in draft\"\n", output.Stderr()) + assert.Equal(t, "! Pull request OWNER/REPO#123 is already \"in draft\"\n", output.Stderr()) } func TestPRReady_closed(t *testing.T) { @@ -218,5 +218,5 @@ func TestPRReady_closed(t *testing.T) { output, err := runCommand(http, true, "123") assert.EqualError(t, err, "SilentError") assert.Equal(t, "", output.String()) - assert.Equal(t, "X Pull request #123 is closed. Only draft pull requests can be marked as \"ready for review\"\n", output.Stderr()) + assert.Equal(t, "X Pull request OWNER/REPO#123 is closed. Only draft pull requests can be marked as \"ready for review\"\n", output.Stderr()) } diff --git a/pkg/cmd/pr/reopen/reopen.go b/pkg/cmd/pr/reopen/reopen.go index 731a7251d..2aae2b8f5 100644 --- a/pkg/cmd/pr/reopen/reopen.go +++ b/pkg/cmd/pr/reopen/reopen.go @@ -64,12 +64,12 @@ func reopenRun(opts *ReopenOptions) error { } if pr.State == "MERGED" { - fmt.Fprintf(opts.IO.ErrOut, "%s Pull request #%d (%s) can't be reopened because it was already merged\n", cs.FailureIcon(), pr.Number, pr.Title) + fmt.Fprintf(opts.IO.ErrOut, "%s Pull request %s#%d (%s) can't be reopened because it was already merged\n", cs.FailureIcon(), ghrepo.FullName(baseRepo), pr.Number, pr.Title) return cmdutil.SilentError } if pr.IsOpen() { - fmt.Fprintf(opts.IO.ErrOut, "%s Pull request #%d (%s) is already open\n", cs.WarningIcon(), pr.Number, pr.Title) + fmt.Fprintf(opts.IO.ErrOut, "%s Pull request %s#%d (%s) is already open\n", cs.WarningIcon(), ghrepo.FullName(baseRepo), pr.Number, pr.Title) return nil } @@ -99,7 +99,7 @@ func reopenRun(opts *ReopenOptions) error { return fmt.Errorf("API call failed: %w", err) } - fmt.Fprintf(opts.IO.ErrOut, "%s Reopened pull request #%d (%s)\n", cs.SuccessIconWithColor(cs.Green), pr.Number, pr.Title) + fmt.Fprintf(opts.IO.ErrOut, "%s Reopened pull request %s#%d (%s)\n", cs.SuccessIconWithColor(cs.Green), ghrepo.FullName(baseRepo), pr.Number, pr.Title) return nil } diff --git a/pkg/cmd/pr/reopen/reopen_test.go b/pkg/cmd/pr/reopen/reopen_test.go index 3a4f1860f..856e19172 100644 --- a/pkg/cmd/pr/reopen/reopen_test.go +++ b/pkg/cmd/pr/reopen/reopen_test.go @@ -71,7 +71,7 @@ func TestPRReopen(t *testing.T) { output, err := runCommand(http, true, "123") assert.NoError(t, err) assert.Equal(t, "", output.String()) - assert.Equal(t, "✓ Reopened pull request #123 (The title of the PR)\n", output.Stderr()) + assert.Equal(t, "✓ Reopened pull request OWNER/REPO#123 (The title of the PR)\n", output.Stderr()) } func TestPRReopen_alreadyOpen(t *testing.T) { @@ -88,7 +88,7 @@ func TestPRReopen_alreadyOpen(t *testing.T) { output, err := runCommand(http, true, "123") assert.NoError(t, err) assert.Equal(t, "", output.String()) - assert.Equal(t, "! Pull request #123 (The title of the PR) is already open\n", output.Stderr()) + assert.Equal(t, "! Pull request OWNER/REPO#123 (The title of the PR) is already open\n", output.Stderr()) } func TestPRReopen_alreadyMerged(t *testing.T) { @@ -105,7 +105,7 @@ func TestPRReopen_alreadyMerged(t *testing.T) { output, err := runCommand(http, true, "123") assert.EqualError(t, err, "SilentError") assert.Equal(t, "", output.String()) - assert.Equal(t, "X Pull request #123 (The title of the PR) can't be reopened because it was already merged\n", output.Stderr()) + assert.Equal(t, "X Pull request OWNER/REPO#123 (The title of the PR) can't be reopened because it was already merged\n", output.Stderr()) } func TestPRReopen_withComment(t *testing.T) { @@ -141,5 +141,5 @@ func TestPRReopen_withComment(t *testing.T) { output, err := runCommand(http, true, "123 --comment 'reopening comment'") assert.NoError(t, err) assert.Equal(t, "", output.String()) - assert.Equal(t, "✓ Reopened pull request #123 (The title of the PR)\n", output.Stderr()) + assert.Equal(t, "✓ Reopened pull request OWNER/REPO#123 (The title of the PR)\n", output.Stderr()) } diff --git a/pkg/cmd/pr/review/review.go b/pkg/cmd/pr/review/review.go index d157633b9..4fa973a87 100644 --- a/pkg/cmd/pr/review/review.go +++ b/pkg/cmd/pr/review/review.go @@ -7,7 +7,8 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/api" - "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" + "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/internal/prompter" "github.com/cli/cli/v2/pkg/cmd/pr/shared" "github.com/cli/cli/v2/pkg/cmdutil" @@ -18,7 +19,7 @@ import ( type ReviewOptions struct { HttpClient func() (*http.Client, error) - Config func() (config.Config, error) + Config func() (gh.Config, error) IO *iostreams.IOStreams Prompter prompter.Prompter @@ -156,15 +157,11 @@ func reviewRun(opts *ReviewOptions) error { var reviewData *api.PullRequestReviewInput if opts.InteractiveMode { - editorCommand, err := cmdutil.DetermineEditor(opts.Config) + reviewData, err = reviewSurvey(opts) if err != nil { return err } - reviewData, err = reviewSurvey(opts, editorCommand) - if err != nil { - return err - } - if reviewData == nil && err == nil { + if reviewData == nil { fmt.Fprint(opts.IO.ErrOut, "Discarding.\n") return nil } @@ -194,17 +191,17 @@ func reviewRun(opts *ReviewOptions) error { switch reviewData.State { case api.ReviewComment: - fmt.Fprintf(opts.IO.ErrOut, "%s Reviewed pull request #%d\n", cs.Gray("-"), pr.Number) + fmt.Fprintf(opts.IO.ErrOut, "%s Reviewed pull request %s#%d\n", cs.Gray("-"), ghrepo.FullName(baseRepo), pr.Number) case api.ReviewApprove: - fmt.Fprintf(opts.IO.ErrOut, "%s Approved pull request #%d\n", cs.SuccessIcon(), pr.Number) + fmt.Fprintf(opts.IO.ErrOut, "%s Approved pull request %s#%d\n", cs.SuccessIcon(), ghrepo.FullName(baseRepo), pr.Number) case api.ReviewRequestChanges: - fmt.Fprintf(opts.IO.ErrOut, "%s Requested changes to pull request #%d\n", cs.Red("+"), pr.Number) + fmt.Fprintf(opts.IO.ErrOut, "%s Requested changes to pull request %s#%d\n", cs.Red("+"), ghrepo.FullName(baseRepo), pr.Number) } return nil } -func reviewSurvey(opts *ReviewOptions, editorCommand string) (*api.PullRequestReviewInput, error) { +func reviewSurvey(opts *ReviewOptions) (*api.PullRequestReviewInput, error) { options := []string{"Comment", "Approve", "Request Changes"} reviewType, err := opts.Prompter.Select( "What kind of review do you want to give?", diff --git a/pkg/cmd/pr/review/review_test.go b/pkg/cmd/pr/review/review_test.go index 9d1ad6ff9..f9e00c3b8 100644 --- a/pkg/cmd/pr/review/review_test.go +++ b/pkg/cmd/pr/review/review_test.go @@ -11,8 +11,8 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/api" - "github.com/cli/cli/v2/context" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/internal/prompter" "github.com/cli/cli/v2/pkg/cmd/pr/shared" @@ -166,7 +166,7 @@ func Test_NewCmdReview(t *testing.T) { } } -func runCommand(rt http.RoundTripper, prompter prompter.Prompter, remotes context.Remotes, isTTY bool, cli string) (*test.CmdOut, error) { +func runCommand(rt http.RoundTripper, prompter prompter.Prompter, isTTY bool, cli string) (*test.CmdOut, error) { ios, _, stdout, stderr := iostreams.Test() ios.SetStdoutTTY(isTTY) ios.SetStdinTTY(isTTY) @@ -177,7 +177,7 @@ func runCommand(rt http.RoundTripper, prompter prompter.Prompter, remotes contex HttpClient: func() (*http.Client, error) { return &http.Client{Transport: rt}, nil }, - Config: func() (config.Config, error) { + Config: func() (gh.Config, error) { return config.NewBlankConfig(), nil }, Prompter: prompter, @@ -249,7 +249,7 @@ func TestPRReview(t *testing.T) { }), ) - output, err := runCommand(http, nil, nil, false, tt.args) + output, err := runCommand(http, nil, false, tt.args) assert.NoError(t, err) assert.Equal(t, "", output.String()) assert.Equal(t, "", output.Stderr()) @@ -278,15 +278,15 @@ func TestPRReview_interactive(t *testing.T) { ConfirmFunc: func(_ string, _ bool) (bool, error) { return true, nil }, } - output, err := runCommand(http, pm, nil, true, "") + output, err := runCommand(http, pm, true, "") assert.NoError(t, err) assert.Equal(t, heredoc.Doc(` Got: cool story - + `), output.String()) - assert.Equal(t, "✓ Approved pull request #123\n", output.Stderr()) + assert.Equal(t, "✓ Approved pull request OWNER/REPO#123\n", output.Stderr()) } func TestPRReview_interactive_no_body(t *testing.T) { @@ -300,7 +300,7 @@ func TestPRReview_interactive_no_body(t *testing.T) { MarkdownEditorFunc: func(_, _ string, _ bool) (string, error) { return "", nil }, } - _, err := runCommand(http, pm, nil, true, "") + _, err := runCommand(http, pm, true, "") assert.EqualError(t, err, "this type of review cannot be blank") } @@ -325,8 +325,8 @@ func TestPRReview_interactive_blank_approve(t *testing.T) { ConfirmFunc: func(_ string, _ bool) (bool, error) { return true, nil }, } - output, err := runCommand(http, pm, nil, true, "") + output, err := runCommand(http, pm, true, "") assert.NoError(t, err) assert.Equal(t, "", output.String()) - assert.Equal(t, "✓ Approved pull request #123\n", output.Stderr()) + assert.Equal(t, "✓ Approved pull request OWNER/REPO#123\n", output.Stderr()) } diff --git a/pkg/cmd/pr/shared/commentable.go b/pkg/cmd/pr/shared/commentable.go index 808960b24..7a38286d2 100644 --- a/pkg/cmd/pr/shared/commentable.go +++ b/pkg/cmd/pr/shared/commentable.go @@ -8,7 +8,7 @@ import ( "net/http" "github.com/cli/cli/v2/api" - "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/internal/text" "github.com/cli/cli/v2/pkg/cmdutil" @@ -206,7 +206,7 @@ func CommentableConfirmSubmitSurvey(p Prompt) func() (bool, error) { } } -func CommentableInteractiveEditSurvey(cf func() (config.Config, error), io *iostreams.IOStreams) func(string) (string, error) { +func CommentableInteractiveEditSurvey(cf func() (gh.Config, error), io *iostreams.IOStreams) func(string) (string, error) { return func(initialValue string) (string, error) { editorCommand, err := cmdutil.DetermineEditor(cf) if err != nil { @@ -219,7 +219,7 @@ func CommentableInteractiveEditSurvey(cf func() (config.Config, error), io *iost } } -func CommentableEditSurvey(cf func() (config.Config, error), io *iostreams.IOStreams) func(string) (string, error) { +func CommentableEditSurvey(cf func() (gh.Config, error), io *iostreams.IOStreams) func(string) (string, error) { return func(initialValue string) (string, error) { editorCommand, err := cmdutil.DetermineEditor(cf) if err != nil { diff --git a/pkg/cmd/pr/shared/finder_test.go b/pkg/cmd/pr/shared/finder_test.go index 23138ed2d..6df8d3000 100644 --- a/pkg/cmd/pr/shared/finder_test.go +++ b/pkg/cmd/pr/shared/finder_test.go @@ -10,6 +10,7 @@ import ( "github.com/cli/cli/v2/git" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/pkg/httpmock" + "github.com/stretchr/testify/require" ) func TestFind(t *testing.T) { @@ -409,6 +410,68 @@ func TestFind(t *testing.T) { wantPR: 13, wantRepo: "https://github.com/OWNER/REPO", }, + { + name: "including project items", + args: args{ + selector: "", + fields: []string{"projectItems"}, + baseRepoFn: func() (ghrepo.Interface, error) { + return ghrepo.FromFullName("OWNER/REPO") + }, + branchFn: func() (string, error) { + return "blueberries", nil + }, + branchConfig: func(branch string) (c git.BranchConfig) { + c.MergeRef = "refs/pull/13/head" + return + }, + }, + httpStub: func(r *httpmock.Registry) { + r.Register( + httpmock.GraphQL(`query PullRequestByNumber\b`), + httpmock.StringResponse(`{"data":{"repository":{ + "pullRequest":{"number":13} + }}}`)) + + r.Register( + httpmock.GraphQL(`query PullRequestProjectItems\b`), + httpmock.GraphQLQuery(`{ + "data": { + "repository": { + "pullRequest": { + "projectItems": { + "nodes": [ + { + "id": "PVTI_lADOB-vozM4AVk16zgK6U50", + "project": { + "id": "PVT_kwDOB-vozM4AVk16", + "title": "Test Project" + }, + "status": { + "optionId": "47fc9ee4", + "name": "In Progress" + } + } + ], + "pageInfo": { + "hasNextPage": false, + "endCursor": "MQ" + } + } + } + } + } + }`, + func(query string, inputs map[string]interface{}) { + require.Equal(t, float64(13), inputs["number"]) + require.Equal(t, "OWNER", inputs["owner"]) + require.Equal(t, "REPO", inputs["name"]) + }), + ) + }, + wantPR: 13, + wantRepo: "https://github.com/OWNER/REPO", + }, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { diff --git a/pkg/cmd/pr/status/http.go b/pkg/cmd/pr/status/http.go index 755ccf30b..bd7eb6a78 100644 --- a/pkg/cmd/pr/status/http.go +++ b/pkg/cmd/pr/status/http.go @@ -59,7 +59,7 @@ func pullRequestStatus(httpClient *http.Client, repo ghrepo.Interface, options r fragments = fmt.Sprintf("fragment pr on PullRequest{%s}fragment prWithReviews on PullRequest{...pr}", gr) } else { var err error - fragments, err = pullRequestFragment(repo.RepoHost(), options.ConflictStatus, options.CheckRunAndStatusContextCountsSupported) + fragments, err = pullRequestFragment(options.ConflictStatus, options.CheckRunAndStatusContextCountsSupported) if err != nil { return nil, err } @@ -188,7 +188,7 @@ func pullRequestStatus(httpClient *http.Client, repo ghrepo.Interface, options r return &payload, nil } -func pullRequestFragment(hostname string, conflictStatus bool, statusCheckRollupWithCountByState bool) (string, error) { +func pullRequestFragment(conflictStatus bool, statusCheckRollupWithCountByState bool) (string, error) { fields := []string{ "number", "title", "state", "url", "isDraft", "isCrossRepository", "headRefName", "headRepositoryOwner", "mergeStateStatus", diff --git a/pkg/cmd/pr/status/status.go b/pkg/cmd/pr/status/status.go index bb7bb735d..2cd28f2ed 100644 --- a/pkg/cmd/pr/status/status.go +++ b/pkg/cmd/pr/status/status.go @@ -13,8 +13,8 @@ import ( "github.com/cli/cli/v2/api" ghContext "github.com/cli/cli/v2/context" "github.com/cli/cli/v2/git" - "github.com/cli/cli/v2/internal/config" fd "github.com/cli/cli/v2/internal/featuredetection" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/internal/text" "github.com/cli/cli/v2/pkg/cmd/pr/shared" @@ -26,7 +26,7 @@ import ( type StatusOptions struct { HttpClient func() (*http.Client, error) GitClient *git.Client - Config func() (config.Config, error) + Config func() (gh.Config, error) IO *iostreams.IOStreams BaseRepo func() (ghrepo.Interface, error) Remotes func() (ghContext.Remotes, error) diff --git a/pkg/cmd/pr/status/status_test.go b/pkg/cmd/pr/status/status_test.go index 3df048503..e8e487559 100644 --- a/pkg/cmd/pr/status/status_test.go +++ b/pkg/cmd/pr/status/status_test.go @@ -13,6 +13,7 @@ import ( "github.com/cli/cli/v2/git" "github.com/cli/cli/v2/internal/config" fd "github.com/cli/cli/v2/internal/featuredetection" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/internal/run" "github.com/cli/cli/v2/pkg/cmdutil" @@ -37,7 +38,7 @@ func runCommandWithDetector(rt http.RoundTripper, branch string, isTTY bool, cli HttpClient: func() (*http.Client, error) { return &http.Client{Transport: rt}, nil }, - Config: func() (config.Config, error) { + Config: func() (gh.Config, error) { return config.NewBlankConfig(), nil }, BaseRepo: func() (ghrepo.Interface, error) { diff --git a/pkg/cmd/pr/view/fixtures/prViewPreviewWithNilProject.json b/pkg/cmd/pr/view/fixtures/prViewPreviewWithNilProject.json new file mode 100644 index 000000000..9ed9b1166 --- /dev/null +++ b/pkg/cmd/pr/view/fixtures/prViewPreviewWithNilProject.json @@ -0,0 +1,33 @@ +{ + "data": { + "repository": { + "pullRequest": { + "number": 12, + "title": "Blueberries are from a fork", + "state": "MERGED", + "body": "**blueberries taste good**", + "url": "https://github.com/OWNER/REPO/pull/12", + "author": { + "login": "nobody" + }, + "commits": { + "totalCount": 12 + }, + "additions": 100, + "deletions": 10, + "baseRefName": "master", + "headRefName": "blueberries", + "headRepositoryOwner": { + "login": "hubot" + }, + "projectCards": { + "nodes": [ + null + ], + "totalCount": 1 + }, + "isCrossRepository": true + } + } + } +} diff --git a/pkg/cmd/pr/view/view.go b/pkg/cmd/pr/view/view.go index 4a69de2f4..ccad4fa77 100644 --- a/pkg/cmd/pr/view/view.go +++ b/pkg/cmd/pr/view/view.go @@ -10,6 +10,7 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/api" "github.com/cli/cli/v2/internal/browser" + "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/internal/text" "github.com/cli/cli/v2/pkg/cmd/pr/shared" "github.com/cli/cli/v2/pkg/cmdutil" @@ -42,14 +43,14 @@ func NewCmdView(f *cmdutil.Factory, runF func(*ViewOptions) error) *cobra.Comman cmd := &cobra.Command{ Use: "view [ | | ]", Short: "View a pull request", - Long: heredoc.Doc(` + Long: heredoc.Docf(` Display the title, body, and other information about a pull request. Without an argument, the pull request that belongs to the current branch is displayed. - With '--web', open the pull request in a web browser instead. - `), + With %[1]s--web%[1]s flag, open the pull request in a web browser instead. + `, "`"), Args: cobra.MaximumNArgs(1), RunE: func(cmd *cobra.Command, args []string) error { opts.Finder = shared.NewFinder(f) @@ -94,7 +95,7 @@ func viewRun(opts *ViewOptions) error { } else if opts.Exporter != nil { findOptions.Fields = opts.Exporter.Fields() } - pr, _, err := opts.Finder.Find(findOptions) + pr, baseRepo, err := opts.Finder.Find(findOptions) if err != nil { return err } @@ -121,7 +122,7 @@ func viewRun(opts *ViewOptions) error { } if connectedToTerminal { - return printHumanPrPreview(opts, pr) + return printHumanPrPreview(opts, baseRepo, pr) } if opts.Comments { @@ -173,12 +174,12 @@ func printRawPrPreview(io *iostreams.IOStreams, pr *api.PullRequest) error { return nil } -func printHumanPrPreview(opts *ViewOptions, pr *api.PullRequest) error { +func printHumanPrPreview(opts *ViewOptions, baseRepo ghrepo.Interface, pr *api.PullRequest) error { out := opts.IO.Out cs := opts.IO.ColorScheme() // Header (Title and State) - fmt.Fprintf(out, "%s #%d\n", cs.Bold(pr.Title), pr.Number) + fmt.Fprintf(out, "%s %s#%d\n", cs.Bold(pr.Title), ghrepo.FullName(baseRepo), pr.Number) fmt.Fprintf(out, "%s • %s wants to merge %s into %s from %s • %s\n", shared.StateTitleWithColor(cs, *pr), @@ -439,6 +440,9 @@ func prProjectList(pr api.PullRequest) string { projectNames := make([]string, 0, len(pr.ProjectCards.Nodes)) for _, project := range pr.ProjectCards.Nodes { + if project == nil { + continue + } colName := project.Column.Name if colName == "" { colName = "Awaiting triage" diff --git a/pkg/cmd/pr/view/view_test.go b/pkg/cmd/pr/view/view_test.go index 5e2c4b922..6fc955bc3 100644 --- a/pkg/cmd/pr/view/view_test.go +++ b/pkg/cmd/pr/view/view_test.go @@ -333,6 +333,16 @@ func TestPRView_Preview_nontty(t *testing.T) { `auto-merge:\tenabled\thubot\tsquash\n`, }, }, + "PR with nil project": { + branch: "master", + args: "12", + fixtures: map[string]string{ + "PullRequestByNumber": "./fixtures/prViewPreviewWithNilProject.json", + }, + expectedOutputs: []string{ + `projects:\t\n`, + }, + }, } for name, tc := range tests { @@ -371,7 +381,7 @@ func TestPRView_Preview(t *testing.T) { "PullRequestByNumber": "./fixtures/prViewPreview.json", }, expectedOutputs: []string{ - `Blueberries are from a fork #12`, + `Blueberries are from a fork OWNER/REPO#12`, `Open.*nobody wants to merge 12 commits into master from blueberries . about X years ago`, `.+100.-10`, `blueberries taste good`, @@ -385,7 +395,7 @@ func TestPRView_Preview(t *testing.T) { "PullRequestByNumber": "./fixtures/prViewPreviewWithMetadataByNumber.json", }, expectedOutputs: []string{ - `Blueberries are from a fork #12`, + `Blueberries are from a fork OWNER/REPO#12`, `Open.*nobody wants to merge 12 commits into master from blueberries . about X years ago`, `.+100.-10`, `Reviewers:.*1 \(.*Requested.*\)\n`, @@ -405,7 +415,7 @@ func TestPRView_Preview(t *testing.T) { "ReviewsForPullRequest": "./fixtures/prViewPreviewManyReviews.json", }, expectedOutputs: []string{ - `Blueberries are from a fork #12`, + `Blueberries are from a fork OWNER/REPO#12`, `Reviewers: DEF \(Commented\), def \(Changes requested\), ghost \(Approved\), hubot \(Commented\), xyz \(Approved\), 123 \(Requested\), abc \(Requested\), my-org\/team-1 \(Requested\)`, `blueberries taste good`, `View this pull request on GitHub: https://github.com/OWNER/REPO/pull/12`, @@ -418,7 +428,7 @@ func TestPRView_Preview(t *testing.T) { "PullRequestByNumber": "./fixtures/prViewPreviewClosedState.json", }, expectedOutputs: []string{ - `Blueberries are from a fork #12`, + `Blueberries are from a fork OWNER/REPO#12`, `Closed.*nobody wants to merge 12 commits into master from blueberries . about X years ago`, `.+100.-10`, `blueberries taste good`, @@ -432,7 +442,7 @@ func TestPRView_Preview(t *testing.T) { "PullRequestByNumber": "./fixtures/prViewPreviewMergedState.json", }, expectedOutputs: []string{ - `Blueberries are from a fork #12`, + `Blueberries are from a fork OWNER/REPO#12`, `Merged.*nobody wants to merge 12 commits into master from blueberries . about X years ago`, `.+100.-10`, `blueberries taste good`, @@ -446,7 +456,7 @@ func TestPRView_Preview(t *testing.T) { "PullRequestByNumber": "./fixtures/prViewPreviewDraftState.json", }, expectedOutputs: []string{ - `Blueberries are from a fork #12`, + `Blueberries are from a fork OWNER/REPO#12`, `Draft.*nobody wants to merge 12 commits into master from blueberries . about X years ago`, `.+100.-10`, `blueberries taste good`, @@ -460,7 +470,7 @@ func TestPRView_Preview(t *testing.T) { "PullRequestByNumber": "./fixtures/prViewPreviewWithAllChecksPassing.json", }, expectedOutputs: []string{ - `Blueberries are from a fork #12`, + `Blueberries are from a fork OWNER/REPO#12`, `Open.*nobody wants to merge 12 commits into master from blueberries . about X years ago`, `.+100.-10 • ✓ Checks passing`, `blueberries taste good`, @@ -474,7 +484,7 @@ func TestPRView_Preview(t *testing.T) { "PullRequestByNumber": "./fixtures/prViewPreviewWithAllChecksFailing.json", }, expectedOutputs: []string{ - `Blueberries are from a fork #12`, + `Blueberries are from a fork OWNER/REPO#12`, `Open.*nobody wants to merge 12 commits into master from blueberries . about X years ago`, `.+100.-10 • × All checks failing`, `blueberries taste good`, @@ -488,7 +498,7 @@ func TestPRView_Preview(t *testing.T) { "PullRequestByNumber": "./fixtures/prViewPreviewWithSomeChecksFailing.json", }, expectedOutputs: []string{ - `Blueberries are from a fork #12`, + `Blueberries are from a fork OWNER/REPO#12`, `Open.*nobody wants to merge 12 commits into master from blueberries . about X years ago`, `.+100.-10 • × 1/2 checks failing`, `blueberries taste good`, @@ -502,7 +512,7 @@ func TestPRView_Preview(t *testing.T) { "PullRequestByNumber": "./fixtures/prViewPreviewWithSomeChecksPending.json", }, expectedOutputs: []string{ - `Blueberries are from a fork #12`, + `Blueberries are from a fork OWNER/REPO#12`, `Open.*nobody wants to merge 12 commits into master from blueberries . about X years ago`, `.+100.-10 • - Checks pending`, `blueberries taste good`, @@ -516,7 +526,7 @@ func TestPRView_Preview(t *testing.T) { "PullRequestByNumber": "./fixtures/prViewPreviewWithNoChecks.json", }, expectedOutputs: []string{ - `Blueberries are from a fork #12`, + `Blueberries are from a fork OWNER/REPO#12`, `Open.*nobody wants to merge 12 commits into master from blueberries . about X years ago`, `.+100.-10 • No checks`, `blueberries taste good`, @@ -530,7 +540,7 @@ func TestPRView_Preview(t *testing.T) { "PullRequestByNumber": "./fixtures/prViewPreviewWithAutoMergeEnabled.json", }, expectedOutputs: []string{ - `Blueberries are from a fork #12\n`, + `Blueberries are from a fork OWNER/REPO#12\n`, `Open.*nobody wants to merge 12 commits into master from blueberries . about X years ago`, `Auto-merge:.*enabled.* by hubot, using squash and merge`, `blueberries taste good`, @@ -615,7 +625,7 @@ func TestPRView_tty_Comments(t *testing.T) { "ReviewsForPullRequest": "./fixtures/prViewPreviewReviews.json", }, expectedOutputs: []string{ - `some title #12`, + `some title OWNER/REPO#12`, `1 \x{1f615} • 2 \x{1f440} • 3 \x{2764}\x{fe0f}`, `some body`, `———————— Not showing 9 comments ————————`, @@ -635,7 +645,7 @@ func TestPRView_tty_Comments(t *testing.T) { "CommentsForPullRequest": "./fixtures/prViewPreviewFullComments.json", }, expectedOutputs: []string{ - `some title #12`, + `some title OWNER/REPO#12`, `some body`, `monalisa • Jan 1, 2020 • Edited`, `1 \x{1f615} • 2 \x{1f440} • 3 \x{2764}\x{fe0f} • 4 \x{1f389} • 5 \x{1f604} • 6 \x{1f680} • 7 \x{1f44e} • 8 \x{1f44d}`, diff --git a/pkg/cmd/project/close/close.go b/pkg/cmd/project/close/close.go index f4016fe50..d24278a23 100644 --- a/pkg/cmd/project/close/close.go +++ b/pkg/cmd/project/close/close.go @@ -6,7 +6,6 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/pkg/cmd/project/shared/client" - "github.com/cli/cli/v2/pkg/cmd/project/shared/format" "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" @@ -19,7 +18,7 @@ type closeOpts struct { owner string reopen bool projectID string - format string + exporter cmdutil.Exporter } type closeConfig struct { @@ -78,7 +77,7 @@ func NewCmdClose(f *cmdutil.Factory, runF func(config closeConfig) error) *cobra closeCmd.Flags().StringVar(&opts.owner, "owner", "", "Login of the owner. Use \"@me\" for the current user.") closeCmd.Flags().BoolVar(&opts.reopen, "undo", false, "Reopen a closed project") - closeCmd.Flags().StringVar(&opts.format, "format", "", "Output format, must be 'json'") + cmdutil.AddFormatFlags(closeCmd, &opts.exporter) return closeCmd } @@ -103,8 +102,8 @@ func runClose(config closeConfig) error { return err } - if config.opts.format == "json" { - return printJSON(config, *project) + if config.opts.exporter != nil { + return config.opts.exporter.Write(config.io, query.UpdateProjectV2.ProjectV2) } return printResults(config, query.UpdateProjectV2.ProjectV2) @@ -132,12 +131,3 @@ func printResults(config closeConfig, project queries.Project) error { _, err := fmt.Fprintf(config.io.Out, "%s\n", project.URL) return err } - -func printJSON(config closeConfig, project queries.Project) error { - b, err := format.JSONProject(project) - if err != nil { - return err - } - _, err = config.io.Out.Write(b) - return err -} diff --git a/pkg/cmd/project/close/close_test.go b/pkg/cmd/project/close/close_test.go index 96ec6ac50..92ca64bd0 100644 --- a/pkg/cmd/project/close/close_test.go +++ b/pkg/cmd/project/close/close_test.go @@ -13,11 +13,12 @@ import ( func TestNewCmdClose(t *testing.T) { tests := []struct { - name string - cli string - wants closeOpts - wantsErr bool - wantsErrMsg string + name string + cli string + wants closeOpts + wantsErr bool + wantsErrMsg string + wantsExporter bool }{ { name: "not-a-number", @@ -47,11 +48,9 @@ func TestNewCmdClose(t *testing.T) { }, }, { - name: "json", - cli: "--format json", - wants: closeOpts{ - format: "json", - }, + name: "json", + cli: "--format json", + wantsExporter: true, }, } @@ -84,7 +83,7 @@ func TestNewCmdClose(t *testing.T) { assert.Equal(t, tt.wants.number, gotOpts.number) assert.Equal(t, tt.wants.owner, gotOpts.owner) - assert.Equal(t, tt.wants.format, gotOpts.format) + assert.Equal(t, tt.wantsExporter, gotOpts.exporter != nil) }) } } @@ -453,3 +452,100 @@ func TestRunClose_Reopen(t *testing.T) { "http://a-url.com\n", stdout.String()) } + +func TestRunClose_JSON(t *testing.T) { + defer gock.Off() + // gock.Observe(gock.DumpRequest) + + // get user ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]interface{}{ + "login": "monalisa", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "id": "an ID", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"organization"}, + }, + }, + }) + + // get user project ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserProject.*", + "variables": map[string]interface{}{ + "login": "monalisa", + "number": 1, + "firstItems": 0, + "afterItems": nil, + "firstFields": 0, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "projectV2": map[string]string{ + "id": "an ID", + }, + }, + }, + }) + + // close project + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation CloseProjectV2.*"variables":{"afterFields":null,"afterItems":null,"firstFields":0,"firstItems":0,"input":{"projectId":"an ID","closed":true}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "updateProjectV2": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "number": 1, + "title": "a title", + "url": "http://a-url.com", + "owner": map[string]interface{}{ + "__typename": "User", + "login": "monalisa", + }, + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + config := closeConfig{ + io: ios, + opts: closeOpts{ + number: 1, + owner: "monalisa", + exporter: cmdutil.NewJSONExporter(), + }, + client: client, + } + + err := runClose(config) + assert.NoError(t, err) + assert.JSONEq( + t, + `{"number":1,"url":"http://a-url.com","shortDescription":"","public":false,"closed":false,"title":"a title","id":"","readme":"","items":{"totalCount":0},"fields":{"totalCount":0},"owner":{"type":"User","login":"monalisa"}}`, + stdout.String()) +} diff --git a/pkg/cmd/project/copy/copy.go b/pkg/cmd/project/copy/copy.go index d3e07424b..63047f0a3 100644 --- a/pkg/cmd/project/copy/copy.go +++ b/pkg/cmd/project/copy/copy.go @@ -6,7 +6,6 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/pkg/cmd/project/shared/client" - "github.com/cli/cli/v2/pkg/cmd/project/shared/format" "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" @@ -22,7 +21,7 @@ type copyOpts struct { sourceOwner string targetOwner string title string - format string + exporter cmdutil.Exporter } type copyConfig struct { @@ -79,7 +78,7 @@ func NewCmdCopy(f *cmdutil.Factory, runF func(config copyConfig) error) *cobra.C copyCmd.Flags().StringVar(&opts.targetOwner, "target-owner", "", "Login of the target owner. Use \"@me\" for the current user.") copyCmd.Flags().StringVar(&opts.title, "title", "", "Title for the new project") copyCmd.Flags().BoolVar(&opts.includeDraftIssues, "drafts", false, "Include draft issues when copying") - cmdutil.StringEnumFlag(copyCmd, &opts.format, "format", "", "", []string{"json"}, "Output format") + cmdutil.AddFormatFlags(copyCmd, &opts.exporter) _ = copyCmd.MarkFlagRequired("title") @@ -113,8 +112,8 @@ func runCopy(config copyConfig) error { return err } - if config.opts.format == "json" { - return printJSON(config, query.CopyProjectV2.ProjectV2) + if config.opts.exporter != nil { + return config.opts.exporter.Write(config.io, query.CopyProjectV2.ProjectV2) } return printResults(config, query.CopyProjectV2.ProjectV2) @@ -142,12 +141,3 @@ func printResults(config copyConfig, project queries.Project) error { _, err := fmt.Fprintf(config.io.Out, "%s\n", project.URL) return err } - -func printJSON(config copyConfig, project queries.Project) error { - b, err := format.JSONProject(project) - if err != nil { - return err - } - _, err = config.io.Out.Write(b) - return err -} diff --git a/pkg/cmd/project/copy/copy_test.go b/pkg/cmd/project/copy/copy_test.go index 3caec592d..f098818ea 100644 --- a/pkg/cmd/project/copy/copy_test.go +++ b/pkg/cmd/project/copy/copy_test.go @@ -13,11 +13,12 @@ import ( func TestNewCmdCopy(t *testing.T) { tests := []struct { - name string - cli string - wants copyOpts - wantsErr bool - wantsErrMsg string + name string + cli string + wants copyOpts + wantsErr bool + wantsErrMsg string + wantsExporter bool }{ { name: "not-a-number", @@ -68,9 +69,9 @@ func TestNewCmdCopy(t *testing.T) { name: "json", cli: "--format json --title t", wants: copyOpts{ - format: "json", - title: "t", + title: "t", }, + wantsExporter: true, }, } @@ -106,7 +107,7 @@ func TestNewCmdCopy(t *testing.T) { assert.Equal(t, tt.wants.targetOwner, gotOpts.targetOwner) assert.Equal(t, tt.wants.title, gotOpts.title) assert.Equal(t, tt.wants.includeDraftIssues, gotOpts.includeDraftIssues) - assert.Equal(t, tt.wants.format, gotOpts.format) + assert.Equal(t, tt.wantsExporter, gotOpts.exporter != nil) }) } } @@ -458,3 +459,128 @@ func TestRunCopy_Me(t *testing.T) { "http://a-url.com\n", stdout.String()) } + +func TestRunCopy_JSON(t *testing.T) { + defer gock.Off() + // gock.Observe(gock.DumpRequest) + + // get user project ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserProject.*", + "variables": map[string]interface{}{ + "login": "monalisa", + "number": 1, + "firstItems": 0, + "afterItems": nil, + "firstFields": 0, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "projectV2": map[string]string{ + "id": "an ID", + }, + }, + }, + }) + + // get source user ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]string{ + "login": "monalisa", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "id": "an ID", + "login": "monalisa", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"organization"}, + }, + }, + }) + + // get target user ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]string{ + "login": "monalisa", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "id": "an ID", + "login": "monalisa", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"organization"}, + }, + }, + }) + + // Copy project + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation CopyProjectV2.*","variables":{"afterFields":null,"afterItems":null,"firstFields":0,"firstItems":0,"input":{"projectId":"an ID","ownerId":"an ID","title":"a title","includeDraftIssues":false}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "copyProjectV2": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "number": 1, + "title": "a title", + "url": "http://a-url.com", + "owner": map[string]string{ + "login": "monalisa", + }, + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + config := copyConfig{ + io: ios, + opts: copyOpts{ + title: "a title", + sourceOwner: "monalisa", + targetOwner: "monalisa", + number: 1, + exporter: cmdutil.NewJSONExporter(), + }, + client: client, + } + + err := runCopy(config) + assert.NoError(t, err) + assert.JSONEq( + t, + `{"number":1,"url":"http://a-url.com","shortDescription":"","public":false,"closed":false,"title":"a title","id":"","readme":"","items":{"totalCount":0},"fields":{"totalCount":0},"owner":{"type":"","login":"monalisa"}}`, + stdout.String()) +} diff --git a/pkg/cmd/project/create/create.go b/pkg/cmd/project/create/create.go index 894a6e9ce..a261cb600 100644 --- a/pkg/cmd/project/create/create.go +++ b/pkg/cmd/project/create/create.go @@ -5,7 +5,6 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/pkg/cmd/project/shared/client" - "github.com/cli/cli/v2/pkg/cmd/project/shared/format" "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" @@ -14,10 +13,10 @@ import ( ) type createOpts struct { - title string - owner string - ownerID string - format string + title string + owner string + ownerID string + exporter cmdutil.Exporter } type createConfig struct { @@ -63,7 +62,7 @@ func NewCmdCreate(f *cmdutil.Factory, runF func(config createConfig) error) *cob createCmd.Flags().StringVar(&opts.title, "title", "", "Title for the project") createCmd.Flags().StringVar(&opts.owner, "owner", "", "Login of the owner. Use \"@me\" for the current user.") - cmdutil.StringEnumFlag(createCmd, &opts.format, "format", "", "", []string{"json"}, "Output format") + cmdutil.AddFormatFlags(createCmd, &opts.exporter) _ = createCmd.MarkFlagRequired("title") @@ -85,8 +84,8 @@ func runCreate(config createConfig) error { return err } - if config.opts.format == "json" { - return printJSON(config, query.CreateProjectV2.ProjectV2) + if config.opts.exporter != nil { + return config.opts.exporter.Write(config.io, query.CreateProjectV2.ProjectV2) } return printResults(config, query.CreateProjectV2.ProjectV2) @@ -113,13 +112,3 @@ func printResults(config createConfig, project queries.Project) error { _, err := fmt.Fprintf(config.io.Out, "%s\n", project.URL) return err } - -func printJSON(config createConfig, project queries.Project) error { - b, err := format.JSONProject(project) - if err != nil { - return err - } - - _, err = config.io.Out.Write(b) - return err -} diff --git a/pkg/cmd/project/create/create_test.go b/pkg/cmd/project/create/create_test.go index 74d1747b7..30f1a879f 100644 --- a/pkg/cmd/project/create/create_test.go +++ b/pkg/cmd/project/create/create_test.go @@ -13,11 +13,12 @@ import ( func TestNewCmdCreate(t *testing.T) { tests := []struct { - name string - cli string - wants createOpts - wantsErr bool - wantsErrMsg string + name string + cli string + wants createOpts + wantsErr bool + wantsErrMsg string + wantsExporter bool }{ { name: "title", @@ -38,9 +39,9 @@ func TestNewCmdCreate(t *testing.T) { name: "json", cli: "--title t --format json", wants: createOpts{ - format: "json", - title: "t", + title: "t", }, + wantsExporter: true, }, } @@ -73,7 +74,7 @@ func TestNewCmdCreate(t *testing.T) { assert.Equal(t, tt.wants.title, gotOpts.title) assert.Equal(t, tt.wants.owner, gotOpts.owner) - assert.Equal(t, tt.wants.format, gotOpts.format) + assert.Equal(t, tt.wantsExporter, gotOpts.exporter != nil) }) } } @@ -274,3 +275,74 @@ func TestRunCreate_Me(t *testing.T) { "http://a-url.com\n", stdout.String()) } + +func TestRunCreate_JSON(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + + // get user ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]string{ + "login": "monalisa", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "id": "an ID", + "login": "monalisa", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"organization"}, + }, + }, + }) + + // create project + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation CreateProjectV2.*"variables":{"afterFields":null,"afterItems":null,"firstFields":0,"firstItems":0,"input":{"ownerId":"an ID","title":"a title"}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "createProjectV2": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "number": 1, + "title": "a title", + "url": "http://a-url.com", + "owner": map[string]string{ + "login": "monalisa", + }, + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + config := createConfig{ + opts: createOpts{ + title: "a title", + owner: "monalisa", + exporter: cmdutil.NewJSONExporter(), + }, + client: client, + io: ios, + } + + err := runCreate(config) + assert.NoError(t, err) + assert.JSONEq( + t, + `{"number":1,"url":"http://a-url.com","shortDescription":"","public":false,"closed":false,"title":"a title","id":"","readme":"","items":{"totalCount":0},"fields":{"totalCount":0},"owner":{"type":"","login":"monalisa"}}`, + stdout.String()) +} diff --git a/pkg/cmd/project/delete/delete.go b/pkg/cmd/project/delete/delete.go index 674c30a97..4848a52ae 100644 --- a/pkg/cmd/project/delete/delete.go +++ b/pkg/cmd/project/delete/delete.go @@ -6,7 +6,6 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/pkg/cmd/project/shared/client" - "github.com/cli/cli/v2/pkg/cmd/project/shared/format" "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" @@ -18,7 +17,7 @@ type deleteOpts struct { owner string number int32 projectID string - format string + exporter cmdutil.Exporter } type deleteConfig struct { @@ -72,7 +71,7 @@ func NewCmdDelete(f *cmdutil.Factory, runF func(config deleteConfig) error) *cob } deleteCmd.Flags().StringVar(&opts.owner, "owner", "", "Login of the owner. Use \"@me\" for the current user.") - cmdutil.StringEnumFlag(deleteCmd, &opts.format, "format", "", "", []string{"json"}, "Output format") + cmdutil.AddFormatFlags(deleteCmd, &opts.exporter) return deleteCmd } @@ -96,8 +95,8 @@ func runDelete(config deleteConfig) error { return err } - if config.opts.format == "json" { - return printJSON(config, *project) + if config.opts.exporter != nil { + return config.opts.exporter.Write(config.io, query.DeleteProject.Project) } return printResults(config, query.DeleteProject.Project) @@ -124,13 +123,3 @@ func printResults(config deleteConfig, project queries.Project) error { _, err := fmt.Fprintf(config.io.Out, "Deleted project %d\n", project.Number) return err } - -func printJSON(config deleteConfig, project queries.Project) error { - b, err := format.JSONProject(project) - if err != nil { - return err - } - - _, err = config.io.Out.Write(b) - return err -} diff --git a/pkg/cmd/project/delete/delete_test.go b/pkg/cmd/project/delete/delete_test.go index 589ef72bc..bcd332934 100644 --- a/pkg/cmd/project/delete/delete_test.go +++ b/pkg/cmd/project/delete/delete_test.go @@ -13,11 +13,12 @@ import ( func TestNewCmdDelete(t *testing.T) { tests := []struct { - name string - cli string - wants deleteOpts - wantsErr bool - wantsErrMsg string + name string + cli string + wants deleteOpts + wantsErr bool + wantsErrMsg string + wantsExporter bool }{ { name: "not-a-number", @@ -40,11 +41,9 @@ func TestNewCmdDelete(t *testing.T) { }, }, { - name: "json", - cli: "--format json", - wants: deleteOpts{ - format: "json", - }, + name: "json", + cli: "--format json", + wantsExporter: true, }, } @@ -77,7 +76,7 @@ func TestNewCmdDelete(t *testing.T) { assert.Equal(t, tt.wants.number, gotOpts.number) assert.Equal(t, tt.wants.owner, gotOpts.owner) - assert.Equal(t, tt.wants.format, gotOpts.format) + assert.Equal(t, tt.wantsExporter, gotOpts.exporter != nil) }) } } @@ -347,3 +346,95 @@ func TestRunDelete_Me(t *testing.T) { "Deleted project 1\n", stdout.String()) } + +func TestRunDelete_JSON(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + + // get user ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]interface{}{ + "login": "monalisa", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "id": "an ID", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"organization"}, + }, + }, + }) + + // get project ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserProject.*", + "variables": map[string]interface{}{ + "login": "monalisa", + "number": 1, + "firstItems": 0, + "afterItems": nil, + "firstFields": 0, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "id": "an ID", + }, + }, + }, + }) + + // delete project + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation DeleteProject.*","variables":{"afterFields":null,"afterItems":null,"firstFields":0,"firstItems":0,"input":{"projectId":"an ID"}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "deleteProjectV2": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "id": "project ID", + "number": 1, + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + config := deleteConfig{ + opts: deleteOpts{ + owner: "monalisa", + number: 1, + exporter: cmdutil.NewJSONExporter(), + }, + client: client, + io: ios, + } + + err := runDelete(config) + assert.NoError(t, err) + assert.JSONEq( + t, + `{"number":1,"url":"","shortDescription":"","public":false,"closed":false,"title":"","id":"project ID","readme":"","items":{"totalCount":0},"fields":{"totalCount":0},"owner":{"type":"","login":""}}`, + stdout.String()) +} diff --git a/pkg/cmd/project/edit/edit.go b/pkg/cmd/project/edit/edit.go index 92fee3284..f303ce357 100644 --- a/pkg/cmd/project/edit/edit.go +++ b/pkg/cmd/project/edit/edit.go @@ -6,7 +6,6 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/pkg/cmd/project/shared/client" - "github.com/cli/cli/v2/pkg/cmd/project/shared/format" "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" @@ -22,7 +21,7 @@ type editOpts struct { visibility string shortDescription string projectID string - format string + exporter cmdutil.Exporter } type editConfig struct { @@ -86,7 +85,7 @@ func NewCmdEdit(f *cmdutil.Factory, runF func(config editConfig) error) *cobra.C editCmd.Flags().StringVar(&opts.title, "title", "", "New title for the project") editCmd.Flags().StringVar(&opts.readme, "readme", "", "New readme for the project") editCmd.Flags().StringVarP(&opts.shortDescription, "description", "d", "", "New description of the project") - cmdutil.StringEnumFlag(editCmd, &opts.format, "format", "", "", []string{"json"}, "Output format") + cmdutil.AddFormatFlags(editCmd, &opts.exporter) return editCmd } @@ -110,8 +109,8 @@ func runEdit(config editConfig) error { return err } - if config.opts.format == "json" { - return printJSON(config, *project) + if config.opts.exporter != nil { + return config.opts.exporter.Write(config.io, query.UpdateProjectV2.ProjectV2) } return printResults(config, query.UpdateProjectV2.ProjectV2) @@ -153,13 +152,3 @@ func printResults(config editConfig, project queries.Project) error { _, err := fmt.Fprintf(config.io.Out, "%s\n", project.URL) return err } - -func printJSON(config editConfig, project queries.Project) error { - b, err := format.JSONProject(project) - if err != nil { - return err - } - - _, err = config.io.Out.Write(b) - return err -} diff --git a/pkg/cmd/project/edit/edit_test.go b/pkg/cmd/project/edit/edit_test.go index da30b0935..3160eacde 100644 --- a/pkg/cmd/project/edit/edit_test.go +++ b/pkg/cmd/project/edit/edit_test.go @@ -13,11 +13,12 @@ import ( func TestNewCmdEdit(t *testing.T) { tests := []struct { - name string - cli string - wants editOpts - wantsErr bool - wantsErrMsg string + name string + cli string + wants editOpts + wantsErr bool + wantsErrMsg string + wantsExporter bool }{ { name: "not-a-number", @@ -85,9 +86,9 @@ func TestNewCmdEdit(t *testing.T) { name: "json", cli: "--format json --title t", wants: editOpts{ - format: "json", - title: "t", + title: "t", }, + wantsExporter: true, }, } @@ -124,7 +125,7 @@ func TestNewCmdEdit(t *testing.T) { assert.Equal(t, tt.wants.title, gotOpts.title) assert.Equal(t, tt.wants.readme, gotOpts.readme) assert.Equal(t, tt.wants.shortDescription, gotOpts.shortDescription) - assert.Equal(t, tt.wants.format, gotOpts.format) + assert.Equal(t, tt.wantsExporter, gotOpts.exporter != nil) }) } } @@ -508,3 +509,103 @@ func TestRunUpdate_OmitParams(t *testing.T) { "http://a-url.com\n", stdout.String()) } + +func TestRunUpdate_JSON(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + + // get user ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]interface{}{ + "login": "monalisa", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "id": "an ID", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"organization"}, + }, + }, + }) + + // get user project ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserProject.*", + "variables": map[string]interface{}{ + "login": "monalisa", + "number": 1, + "firstItems": 0, + "afterItems": nil, + "firstFields": 0, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "projectV2": map[string]string{ + "id": "an ID", + }, + }, + }, + }) + + // edit project + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation UpdateProjectV2.*"variables":{"afterFields":null,"afterItems":null,"firstFields":0,"firstItems":0,"input":{"projectId":"an ID","title":"a new title","shortDescription":"a new description","readme":"a new readme","public":true}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "updateProjectV2": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "number": 1, + "title": "a title", + "url": "http://a-url.com", + "owner": map[string]string{ + "login": "monalisa", + }, + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + config := editConfig{ + opts: editOpts{ + number: 1, + owner: "monalisa", + title: "a new title", + shortDescription: "a new description", + visibility: "PUBLIC", + readme: "a new readme", + exporter: cmdutil.NewJSONExporter(), + }, + client: client, + io: ios, + } + + err := runEdit(config) + assert.NoError(t, err) + assert.JSONEq( + t, + `{"number":1,"url":"http://a-url.com","shortDescription":"","public":false,"closed":false,"title":"a title","id":"","readme":"","items":{"totalCount":0},"fields":{"totalCount":0},"owner":{"type":"","login":"monalisa"}}`, + stdout.String()) +} diff --git a/pkg/cmd/project/field-create/field_create.go b/pkg/cmd/project/field-create/field_create.go index d369148ba..56a305480 100644 --- a/pkg/cmd/project/field-create/field_create.go +++ b/pkg/cmd/project/field-create/field_create.go @@ -6,7 +6,6 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/pkg/cmd/project/shared/client" - "github.com/cli/cli/v2/pkg/cmd/project/shared/format" "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" @@ -21,7 +20,7 @@ type createFieldOpts struct { singleSelectOptions []string number int32 projectID string - format string + exporter cmdutil.Exporter } type createFieldConfig struct { @@ -85,7 +84,7 @@ func NewCmdCreateField(f *cmdutil.Factory, runF func(config createFieldConfig) e createFieldCmd.Flags().StringVar(&opts.name, "name", "", "Name of the new field") cmdutil.StringEnumFlag(createFieldCmd, &opts.dataType, "data-type", "", "", []string{"TEXT", "SINGLE_SELECT", "DATE", "NUMBER"}, "DataType of the new field.") createFieldCmd.Flags().StringSliceVar(&opts.singleSelectOptions, "single-select-options", []string{}, "Options for SINGLE_SELECT data type") - cmdutil.StringEnumFlag(createFieldCmd, &opts.format, "format", "", "", []string{"json"}, "Output format") + cmdutil.AddFormatFlags(createFieldCmd, &opts.exporter) _ = createFieldCmd.MarkFlagRequired("name") _ = createFieldCmd.MarkFlagRequired("data-type") @@ -113,8 +112,8 @@ func runCreateField(config createFieldConfig) error { return err } - if config.opts.format == "json" { - return printJSON(config, query.CreateProjectV2Field.Field) + if config.opts.exporter != nil { + return config.opts.exporter.Write(config.io, query.CreateProjectV2Field.Field) } return printResults(config, query.CreateProjectV2Field.Field) @@ -151,13 +150,3 @@ func printResults(config createFieldConfig, field queries.ProjectField) error { _, err := fmt.Fprintf(config.io.Out, "Created field\n") return err } - -func printJSON(config createFieldConfig, field queries.ProjectField) error { - b, err := format.JSONProjectField(field) - if err != nil { - return err - } - - _, err = config.io.Out.Write(b) - return err -} diff --git a/pkg/cmd/project/field-create/field_create_test.go b/pkg/cmd/project/field-create/field_create_test.go index 01904d9e9..e900f2321 100644 --- a/pkg/cmd/project/field-create/field_create_test.go +++ b/pkg/cmd/project/field-create/field_create_test.go @@ -13,11 +13,12 @@ import ( func TestNewCmdCreateField(t *testing.T) { tests := []struct { - name string - cli string - wants createFieldOpts - wantsErr bool - wantsErrMsg string + name string + cli string + wants createFieldOpts + wantsErr bool + wantsErrMsg string + wantsExporter bool }{ { name: "missing-name-and-data-type", @@ -70,11 +71,11 @@ func TestNewCmdCreateField(t *testing.T) { name: "json", cli: "--format json --name n --data-type TEXT ", wants: createFieldOpts{ - format: "json", name: "n", dataType: "TEXT", singleSelectOptions: []string{}, }, + wantsExporter: true, }, } @@ -110,7 +111,7 @@ func TestNewCmdCreateField(t *testing.T) { assert.Equal(t, tt.wants.name, gotOpts.name) assert.Equal(t, tt.wants.dataType, gotOpts.dataType) assert.Equal(t, tt.wants.singleSelectOptions, gotOpts.singleSelectOptions) - assert.Equal(t, tt.wants.format, gotOpts.format) + assert.Equal(t, tt.wantsExporter, gotOpts.exporter != nil) }) } } @@ -628,3 +629,98 @@ func TestRunCreateField_NUMBER(t *testing.T) { "Created field\n", stdout.String()) } + +func TestRunCreateField_JSON(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + + // get user ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]interface{}{ + "login": "monalisa", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "id": "an ID", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"organization"}, + }, + }, + }) + + // get project ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserProject.*", + "variables": map[string]interface{}{ + "login": "monalisa", + "number": 1, + "firstItems": 0, + "afterItems": nil, + "firstFields": 0, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "id": "an ID", + }, + }, + }, + }) + + // create Field + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation CreateField.*","variables":{"input":{"projectId":"an ID","dataType":"TEXT","name":"a name"}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "createProjectV2Field": map[string]interface{}{ + "projectV2Field": map[string]interface{}{ + "__typename": "ProjectV2Field", + "id": "Field ID", + "name": "a name", + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + config := createFieldConfig{ + opts: createFieldOpts{ + name: "a name", + owner: "monalisa", + number: 1, + dataType: "TEXT", + exporter: cmdutil.NewJSONExporter(), + }, + client: client, + io: ios, + } + + err := runCreateField(config) + assert.NoError(t, err) + assert.JSONEq( + t, + `{"id":"Field ID","name":"a name","type":"ProjectV2Field"}`, + stdout.String()) +} diff --git a/pkg/cmd/project/field-delete/field_delete.go b/pkg/cmd/project/field-delete/field_delete.go index 3d3bb25ce..f8b97826b 100644 --- a/pkg/cmd/project/field-delete/field_delete.go +++ b/pkg/cmd/project/field-delete/field_delete.go @@ -4,7 +4,6 @@ import ( "fmt" "github.com/cli/cli/v2/pkg/cmd/project/shared/client" - "github.com/cli/cli/v2/pkg/cmd/project/shared/format" "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" @@ -13,8 +12,8 @@ import ( ) type deleteFieldOpts struct { - fieldID string - format string + fieldID string + exporter cmdutil.Exporter } type deleteFieldConfig struct { @@ -55,7 +54,7 @@ func NewCmdDeleteField(f *cmdutil.Factory, runF func(config deleteFieldConfig) e } deleteFieldCmd.Flags().StringVar(&opts.fieldID, "id", "", "ID of the field to delete") - cmdutil.StringEnumFlag(deleteFieldCmd, &opts.format, "format", "", "", []string{"json"}, "Output format") + cmdutil.AddFormatFlags(deleteFieldCmd, &opts.exporter) _ = deleteFieldCmd.MarkFlagRequired("id") @@ -70,8 +69,8 @@ func runDeleteField(config deleteFieldConfig) error { return err } - if config.opts.format == "json" { - return printJSON(config, query.DeleteProjectV2Field.Field) + if config.opts.exporter != nil { + return config.opts.exporter.Write(config.io, query.DeleteProjectV2Field.Field) } return printResults(config, query.DeleteProjectV2Field.Field) @@ -93,13 +92,3 @@ func printResults(config deleteFieldConfig, field queries.ProjectField) error { _, err := fmt.Fprintf(config.io.Out, "Deleted field\n") return err } - -func printJSON(config deleteFieldConfig, field queries.ProjectField) error { - b, err := format.JSONProjectField(field) - if err != nil { - return err - } - - _, err = config.io.Out.Write(b) - return err -} diff --git a/pkg/cmd/project/field-delete/field_delete_test.go b/pkg/cmd/project/field-delete/field_delete_test.go index 6b1e6c763..6d686c348 100644 --- a/pkg/cmd/project/field-delete/field_delete_test.go +++ b/pkg/cmd/project/field-delete/field_delete_test.go @@ -13,11 +13,12 @@ import ( func TestNewCmdDeleteField(t *testing.T) { tests := []struct { - name string - cli string - wants deleteFieldOpts - wantsErr bool - wantsErrMsg string + name string + cli string + wants deleteFieldOpts + wantsErr bool + wantsErrMsg string + wantsExporter bool }{ { name: "no id", @@ -36,9 +37,9 @@ func TestNewCmdDeleteField(t *testing.T) { name: "json", cli: "--id 123 --format json", wants: deleteFieldOpts{ - format: "json", fieldID: "123", }, + wantsExporter: true, }, } @@ -70,7 +71,7 @@ func TestNewCmdDeleteField(t *testing.T) { assert.NoError(t, err) assert.Equal(t, tt.wants.fieldID, gotOpts.fieldID) - assert.Equal(t, tt.wants.format, gotOpts.format) + assert.Equal(t, tt.wantsExporter, gotOpts.exporter != nil) }) } } @@ -113,3 +114,44 @@ func TestRunDeleteField(t *testing.T) { "Deleted field\n", stdout.String()) } + +func TestRunDeleteField_JSON(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + + // delete Field + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation DeleteField.*","variables":{"input":{"fieldId":"an ID"}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "deleteProjectV2Field": map[string]interface{}{ + "projectV2Field": map[string]interface{}{ + "__typename": "ProjectV2Field", + "id": "Field ID", + "name": "a name", + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + config := deleteFieldConfig{ + opts: deleteFieldOpts{ + fieldID: "an ID", + exporter: cmdutil.NewJSONExporter(), + }, + client: client, + io: ios, + } + + err := runDeleteField(config) + assert.NoError(t, err) + assert.JSONEq( + t, + `{"id":"Field ID","name":"a name","type":"ProjectV2Field"}`, + stdout.String()) +} diff --git a/pkg/cmd/project/field-list/field_list.go b/pkg/cmd/project/field-list/field_list.go index 152d90fcd..11964cb52 100644 --- a/pkg/cmd/project/field-list/field_list.go +++ b/pkg/cmd/project/field-list/field_list.go @@ -7,7 +7,6 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/internal/tableprinter" "github.com/cli/cli/v2/pkg/cmd/project/shared/client" - "github.com/cli/cli/v2/pkg/cmd/project/shared/format" "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" @@ -15,15 +14,14 @@ import ( ) type listOpts struct { - limit int - owner string - number int32 - format string + limit int + owner string + number int32 + exporter cmdutil.Exporter } type listConfig struct { io *iostreams.IOStreams - tp *tableprinter.TablePrinter client *queries.Client opts listOpts } @@ -52,10 +50,8 @@ func NewCmdList(f *cmdutil.Factory, runF func(config listConfig) error) *cobra.C opts.number = int32(num) } - t := tableprinter.New(f.IOStreams) config := listConfig{ io: f.IOStreams, - tp: t, client: client, opts: opts, } @@ -69,7 +65,7 @@ func NewCmdList(f *cmdutil.Factory, runF func(config listConfig) error) *cobra.C } listCmd.Flags().StringVar(&opts.owner, "owner", "", "Login of the owner. Use \"@me\" for the current user.") - cmdutil.StringEnumFlag(listCmd, &opts.format, "format", "", "", []string{"json"}, "Output format") + cmdutil.AddFormatFlags(listCmd, &opts.exporter) listCmd.Flags().IntVarP(&opts.limit, "limit", "L", queries.LimitDefault, "Maximum number of fields to fetch") return listCmd @@ -97,8 +93,8 @@ func runList(config listConfig) error { return err } - if config.opts.format == "json" { - return printJSON(config, project) + if config.opts.exporter != nil { + return config.opts.exporter.Write(config.io, project.Fields) } return printResults(config, project.Fields.Nodes, owner.Login) @@ -109,24 +105,14 @@ func printResults(config listConfig, fields []queries.ProjectField, login string return cmdutil.NewNoResultsError(fmt.Sprintf("Project %d for owner %s has no fields", config.opts.number, login)) } - config.tp.HeaderRow("Name", "Data type", "ID") + tp := tableprinter.New(config.io, tableprinter.WithHeader("Name", "Data type", "ID")) for _, f := range fields { - config.tp.AddField(f.Name()) - config.tp.AddField(f.Type()) - config.tp.AddField(f.ID(), tableprinter.WithTruncate(nil)) - config.tp.EndRow() + tp.AddField(f.Name()) + tp.AddField(f.Type()) + tp.AddField(f.ID(), tableprinter.WithTruncate(nil)) + tp.EndRow() } - return config.tp.Render() -} - -func printJSON(config listConfig, project *queries.Project) error { - b, err := format.JSONProjectFields(project) - if err != nil { - return err - } - - _, err = config.io.Out.Write(b) - return err + return tp.Render() } diff --git a/pkg/cmd/project/field-list/field_list_test.go b/pkg/cmd/project/field-list/field_list_test.go index c6c2f97c6..cc2aa49fc 100644 --- a/pkg/cmd/project/field-list/field_list_test.go +++ b/pkg/cmd/project/field-list/field_list_test.go @@ -3,7 +3,7 @@ package fieldlist import ( "testing" - "github.com/cli/cli/v2/internal/tableprinter" + "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" @@ -14,11 +14,12 @@ import ( func TestNewCmdList(t *testing.T) { tests := []struct { - name string - cli string - wants listOpts - wantsErr bool - wantsErrMsg string + name string + cli string + wants listOpts + wantsErr bool + wantsErrMsg string + wantsExporter bool }{ { name: "not-a-number", @@ -46,9 +47,9 @@ func TestNewCmdList(t *testing.T) { name: "json", cli: "--format json", wants: listOpts{ - format: "json", - limit: 30, + limit: 30, }, + wantsExporter: true, }, } @@ -82,11 +83,106 @@ func TestNewCmdList(t *testing.T) { assert.Equal(t, tt.wants.number, gotOpts.number) assert.Equal(t, tt.wants.owner, gotOpts.owner) assert.Equal(t, tt.wants.limit, gotOpts.limit) - assert.Equal(t, tt.wants.format, gotOpts.format) + assert.Equal(t, tt.wantsExporter, gotOpts.exporter != nil) }) } } +func TestRunList_User_tty(t *testing.T) { + defer gock.Off() + // gock.Observe(gock.DumpRequest) + + // get user ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]interface{}{ + "login": "monalisa", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "id": "an ID", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"organization"}, + }, + }, + }) + + // list project fields + gock.New("https://api.github.com"). + Post("/graphql"). + JSON(map[string]interface{}{ + "query": "query UserProject.*", + "variables": map[string]interface{}{ + "login": "monalisa", + "number": 1, + "firstItems": queries.LimitMax, + "afterItems": nil, + "firstFields": queries.LimitDefault, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "fields": map[string]interface{}{ + "nodes": []map[string]interface{}{ + { + "__typename": "ProjectV2Field", + "name": "FieldTitle", + "id": "field ID", + }, + { + "__typename": "ProjectV2SingleSelectField", + "name": "Status", + "id": "status ID", + }, + { + "__typename": "ProjectV2IterationField", + "name": "Iterations", + "id": "iteration ID", + }, + }, + }, + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + ios.SetStdoutTTY(true) + config := listConfig{ + opts: listOpts{ + number: 1, + owner: "monalisa", + }, + client: client, + io: ios, + } + + err := runList(config) + assert.NoError(t, err) + assert.Equal(t, heredoc.Doc(` + NAME DATA TYPE ID + FieldTitle ProjectV2Field field ID + Status ProjectV2SingleSelectField status ID + Iterations ProjectV2IterationField iteration ID + `), stdout.String()) +} + func TestRunList_User(t *testing.T) { defer gock.Off() // gock.Observe(gock.DumpRequest) @@ -163,7 +259,6 @@ func TestRunList_User(t *testing.T) { ios, _, stdout, _ := iostreams.Test() config := listConfig{ - tp: tableprinter.New(ios), opts: listOpts{ number: 1, owner: "monalisa", @@ -256,7 +351,6 @@ func TestRunList_Org(t *testing.T) { ios, _, stdout, _ := iostreams.Test() config := listConfig{ - tp: tableprinter.New(ios), opts: listOpts{ number: 1, owner: "github", @@ -339,7 +433,6 @@ func TestRunList_Me(t *testing.T) { ios, _, stdout, _ := iostreams.Test() config := listConfig{ - tp: tableprinter.New(ios), opts: listOpts{ number: 1, owner: "@me", @@ -406,7 +499,6 @@ func TestRunList_Empty(t *testing.T) { ios, _, _, _ := iostreams.Test() config := listConfig{ - tp: tableprinter.New(ios), opts: listOpts{ number: 1, owner: "@me", @@ -421,3 +513,97 @@ func TestRunList_Empty(t *testing.T) { err, "Project 1 for owner @me has no fields") } + +func TestRunList_JSON(t *testing.T) { + defer gock.Off() + // gock.Observe(gock.DumpRequest) + + // get user ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]interface{}{ + "login": "monalisa", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "id": "an ID", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"organization"}, + }, + }, + }) + + // list project fields + gock.New("https://api.github.com"). + Post("/graphql"). + JSON(map[string]interface{}{ + "query": "query UserProject.*", + "variables": map[string]interface{}{ + "login": "monalisa", + "number": 1, + "firstItems": queries.LimitMax, + "afterItems": nil, + "firstFields": queries.LimitDefault, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "fields": map[string]interface{}{ + "nodes": []map[string]interface{}{ + { + "__typename": "ProjectV2Field", + "name": "FieldTitle", + "id": "field ID", + }, + { + "__typename": "ProjectV2SingleSelectField", + "name": "Status", + "id": "status ID", + }, + { + "__typename": "ProjectV2IterationField", + "name": "Iterations", + "id": "iteration ID", + }, + }, + "totalCount": 3, + }, + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + config := listConfig{ + opts: listOpts{ + number: 1, + owner: "monalisa", + exporter: cmdutil.NewJSONExporter(), + }, + client: client, + io: ios, + } + + err := runList(config) + assert.NoError(t, err) + assert.JSONEq( + t, + `{"fields":[{"id":"field ID","name":"FieldTitle","type":"ProjectV2Field"},{"id":"status ID","name":"Status","type":"ProjectV2SingleSelectField"},{"id":"iteration ID","name":"Iterations","type":"ProjectV2IterationField"}],"totalCount":3}`, + stdout.String()) +} diff --git a/pkg/cmd/project/item-add/item_add.go b/pkg/cmd/project/item-add/item_add.go index 51c9ecfce..5e4eeff10 100644 --- a/pkg/cmd/project/item-add/item_add.go +++ b/pkg/cmd/project/item-add/item_add.go @@ -6,7 +6,6 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/pkg/cmd/project/shared/client" - "github.com/cli/cli/v2/pkg/cmd/project/shared/format" "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" @@ -20,7 +19,7 @@ type addItemOpts struct { itemURL string projectID string itemID string - format string + exporter cmdutil.Exporter } type addItemConfig struct { @@ -75,7 +74,7 @@ func NewCmdAddItem(f *cmdutil.Factory, runF func(config addItemConfig) error) *c addItemCmd.Flags().StringVar(&opts.owner, "owner", "", "Login of the owner. Use \"@me\" for the current user.") addItemCmd.Flags().StringVar(&opts.itemURL, "url", "", "URL of the issue or pull request to add to the project") - cmdutil.StringEnumFlag(addItemCmd, &opts.format, "format", "", "", []string{"json"}, "Output format") + cmdutil.AddFormatFlags(addItemCmd, &opts.exporter) _ = addItemCmd.MarkFlagRequired("url") @@ -107,8 +106,8 @@ func runAddItem(config addItemConfig) error { return err } - if config.opts.format == "json" { - return printJSON(config, query.CreateProjectItem.ProjectV2Item) + if config.opts.exporter != nil { + return config.opts.exporter.Write(config.io, query.CreateProjectItem.ProjectV2Item) } return printResults(config, query.CreateProjectItem.ProjectV2Item) @@ -132,13 +131,3 @@ func printResults(config addItemConfig, item queries.ProjectItem) error { _, err := fmt.Fprintf(config.io.Out, "Added item\n") return err } - -func printJSON(config addItemConfig, item queries.ProjectItem) error { - b, err := format.JSONProjectItem(item) - if err != nil { - return err - } - - _, err = config.io.Out.Write(b) - return err -} diff --git a/pkg/cmd/project/item-add/item_add_test.go b/pkg/cmd/project/item-add/item_add_test.go index 0beb1fed6..8d117a708 100644 --- a/pkg/cmd/project/item-add/item_add_test.go +++ b/pkg/cmd/project/item-add/item_add_test.go @@ -13,11 +13,12 @@ import ( func TestNewCmdaddItem(t *testing.T) { tests := []struct { - name string - cli string - wants addItemOpts - wantsErr bool - wantsErrMsg string + name string + cli string + wants addItemOpts + wantsErr bool + wantsErrMsg string + wantsExporter bool }{ { name: "missing-url", @@ -58,9 +59,9 @@ func TestNewCmdaddItem(t *testing.T) { name: "json", cli: "--format json --url github.com/cli/cli", wants: addItemOpts{ - format: "json", itemURL: "github.com/cli/cli", }, + wantsExporter: true, }, } @@ -94,7 +95,7 @@ func TestNewCmdaddItem(t *testing.T) { assert.Equal(t, tt.wants.number, gotOpts.number) assert.Equal(t, tt.wants.owner, gotOpts.owner) assert.Equal(t, tt.wants.itemURL, gotOpts.itemURL) - assert.Equal(t, tt.wants.format, gotOpts.format) + assert.Equal(t, tt.wantsExporter, gotOpts.exporter != nil) }) } } @@ -422,3 +423,119 @@ func TestRunAddItem_Me(t *testing.T) { "Added item\n", stdout.String()) } + +func TestRunAddItem_JSON(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + + // get user ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]interface{}{ + "login": "monalisa", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "id": "an ID", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"organization"}, + }, + }, + }) + + // get project ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserProject.*", + "variables": map[string]interface{}{ + "login": "monalisa", + "number": 1, + "firstItems": 0, + "afterItems": nil, + "firstFields": 0, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "id": "an ID", + }, + }, + }, + }) + + // get item ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query GetIssueOrPullRequest.*", + "variables": map[string]interface{}{ + "url": "https://github.com/cli/go-gh/issues/1", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "resource": map[string]interface{}{ + "id": "item ID", + "__typename": "Issue", + }, + }, + }) + + // create item + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation AddItem.*","variables":{"input":{"projectId":"an ID","contentId":"item ID"}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "addProjectV2ItemById": map[string]interface{}{ + "item": map[string]interface{}{ + "id": "item ID", + "content": map[string]interface{}{ + "__typename": "Issue", + "title": "a title", + }, + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + config := addItemConfig{ + opts: addItemOpts{ + owner: "monalisa", + number: 1, + itemURL: "https://github.com/cli/go-gh/issues/1", + exporter: cmdutil.NewJSONExporter(), + }, + client: client, + io: ios, + } + + err := runAddItem(config) + assert.NoError(t, err) + assert.JSONEq( + t, + `{"id":"item ID","title":"a title","body":"","type":"Issue"}`, + stdout.String()) +} diff --git a/pkg/cmd/project/item-archive/item_archive.go b/pkg/cmd/project/item-archive/item_archive.go index 7ae336242..18a820e86 100644 --- a/pkg/cmd/project/item-archive/item_archive.go +++ b/pkg/cmd/project/item-archive/item_archive.go @@ -6,7 +6,6 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/pkg/cmd/project/shared/client" - "github.com/cli/cli/v2/pkg/cmd/project/shared/format" "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" @@ -20,7 +19,7 @@ type archiveItemOpts struct { undo bool itemID string projectID string - format string + exporter cmdutil.Exporter } type archiveItemConfig struct { @@ -82,7 +81,7 @@ func NewCmdArchiveItem(f *cmdutil.Factory, runF func(config archiveItemConfig) e archiveItemCmd.Flags().StringVar(&opts.owner, "owner", "", "Login of the owner. Use \"@me\" for the current user.") archiveItemCmd.Flags().StringVar(&opts.itemID, "id", "", "ID of the item to archive") archiveItemCmd.Flags().BoolVar(&opts.undo, "undo", false, "Unarchive an item") - cmdutil.StringEnumFlag(archiveItemCmd, &opts.format, "format", "", "", []string{"json"}, "Output format") + cmdutil.AddFormatFlags(archiveItemCmd, &opts.exporter) _ = archiveItemCmd.MarkFlagRequired("id") @@ -109,8 +108,8 @@ func runArchiveItem(config archiveItemConfig) error { return err } - if config.opts.format == "json" { - return printJSON(config, query.UnarchiveProjectItem.ProjectV2Item) + if config.opts.exporter != nil { + return config.opts.exporter.Write(config.io, query.UnarchiveProjectItem.ProjectV2Item) } return printResults(config, query.UnarchiveProjectItem.ProjectV2Item) @@ -121,8 +120,8 @@ func runArchiveItem(config archiveItemConfig) error { return err } - if config.opts.format == "json" { - return printJSON(config, query.ArchiveProjectItem.ProjectV2Item) + if config.opts.exporter != nil { + return config.opts.exporter.Write(config.io, query.ArchiveProjectItem.ProjectV2Item) } return printResults(config, query.ArchiveProjectItem.ProjectV2Item) @@ -159,13 +158,3 @@ func printResults(config archiveItemConfig, item queries.ProjectItem) error { _, err := fmt.Fprintf(config.io.Out, "Archived item\n") return err } - -func printJSON(config archiveItemConfig, item queries.ProjectItem) error { - b, err := format.JSONProjectItem(item) - if err != nil { - return err - } - - _, err = config.io.Out.Write(b) - return err -} diff --git a/pkg/cmd/project/item-archive/item_archive_test.go b/pkg/cmd/project/item-archive/item_archive_test.go index 6eb8336f2..30473ff54 100644 --- a/pkg/cmd/project/item-archive/item_archive_test.go +++ b/pkg/cmd/project/item-archive/item_archive_test.go @@ -13,11 +13,12 @@ import ( func TestNewCmdarchiveItem(t *testing.T) { tests := []struct { - name string - cli string - wants archiveItemOpts - wantsErr bool - wantsErrMsg string + name string + cli string + wants archiveItemOpts + wantsErr bool + wantsErrMsg string + wantsExporter bool }{ { name: "missing-id", @@ -66,9 +67,9 @@ func TestNewCmdarchiveItem(t *testing.T) { name: "json", cli: "--format json --id 123", wants: archiveItemOpts{ - format: "json", itemID: "123", }, + wantsExporter: true, }, } @@ -103,7 +104,7 @@ func TestNewCmdarchiveItem(t *testing.T) { assert.Equal(t, tt.wants.owner, gotOpts.owner) assert.Equal(t, tt.wants.itemID, gotOpts.itemID) assert.Equal(t, tt.wants.undo, gotOpts.undo) - assert.Equal(t, tt.wants.format, gotOpts.format) + assert.Equal(t, tt.wantsExporter, gotOpts.exporter != nil) }) } } @@ -635,3 +636,99 @@ func TestRunArchive_Me_Undo(t *testing.T) { "Unarchived item\n", stdout.String()) } + +func TestRunArchive_JSON(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + + // get user ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]interface{}{ + "login": "monalisa", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "id": "an ID", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"organization"}, + }, + }, + }) + + // get project ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserProject.*", + "variables": map[string]interface{}{ + "login": "monalisa", + "number": 1, + "firstItems": 0, + "afterItems": nil, + "firstFields": 0, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "id": "an ID", + }, + }, + }, + }) + + // archive item + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation ArchiveProjectItem.*","variables":{"input":{"projectId":"an ID","itemId":"item ID"}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "archiveProjectV2Item": map[string]interface{}{ + "item": map[string]interface{}{ + "id": "item ID", + "content": map[string]interface{}{ + "__typename": "Issue", + "title": "a title", + }, + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + config := archiveItemConfig{ + opts: archiveItemOpts{ + owner: "monalisa", + number: 1, + itemID: "item ID", + exporter: cmdutil.NewJSONExporter(), + }, + client: client, + io: ios, + } + + err := runArchiveItem(config) + assert.NoError(t, err) + assert.JSONEq( + t, + `{"id":"item ID","title":"a title","body":"","type":"Issue"}`, + stdout.String()) +} diff --git a/pkg/cmd/project/item-create/item_create.go b/pkg/cmd/project/item-create/item_create.go index 6ee32e9f6..d1775172d 100644 --- a/pkg/cmd/project/item-create/item_create.go +++ b/pkg/cmd/project/item-create/item_create.go @@ -6,7 +6,6 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/pkg/cmd/project/shared/client" - "github.com/cli/cli/v2/pkg/cmd/project/shared/format" "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" @@ -20,7 +19,7 @@ type createItemOpts struct { owner string number int32 projectID string - format string + exporter cmdutil.Exporter } type createItemConfig struct { @@ -76,7 +75,7 @@ func NewCmdCreateItem(f *cmdutil.Factory, runF func(config createItemConfig) err createItemCmd.Flags().StringVar(&opts.owner, "owner", "", "Login of the owner. Use \"@me\" for the current user.") createItemCmd.Flags().StringVar(&opts.title, "title", "", "Title for the draft issue") createItemCmd.Flags().StringVar(&opts.body, "body", "", "Body for the draft issue") - cmdutil.StringEnumFlag(createItemCmd, &opts.format, "format", "", "", []string{"json"}, "Output format") + cmdutil.AddFormatFlags(createItemCmd, &opts.exporter) _ = createItemCmd.MarkFlagRequired("title") @@ -103,8 +102,8 @@ func runCreateItem(config createItemConfig) error { return err } - if config.opts.format == "json" { - return printJSON(config, query.CreateProjectDraftItem.ProjectV2Item) + if config.opts.exporter != nil { + return config.opts.exporter.Write(config.io, query.CreateProjectDraftItem.ProjectV2Item) } return printResults(config, query.CreateProjectDraftItem.ProjectV2Item) @@ -128,13 +127,3 @@ func printResults(config createItemConfig, item queries.ProjectItem) error { _, err := fmt.Fprintf(config.io.Out, "Created item\n") return err } - -func printJSON(config createItemConfig, item queries.ProjectItem) error { - b, err := format.JSONProjectItem(item) - if err != nil { - return err - } - - _, err = config.io.Out.Write(b) - return err -} diff --git a/pkg/cmd/project/item-create/item_create_test.go b/pkg/cmd/project/item-create/item_create_test.go index 1482fe268..085aa99f4 100644 --- a/pkg/cmd/project/item-create/item_create_test.go +++ b/pkg/cmd/project/item-create/item_create_test.go @@ -13,11 +13,12 @@ import ( func TestNewCmdCreateItem(t *testing.T) { tests := []struct { - name string - cli string - wants createItemOpts - wantsErr bool - wantsErrMsg string + name string + cli string + wants createItemOpts + wantsErr bool + wantsErrMsg string + wantsExporter bool }{ { name: "missing-title", @@ -66,9 +67,9 @@ func TestNewCmdCreateItem(t *testing.T) { name: "json", cli: "--format json --title t", wants: createItemOpts{ - format: "json", - title: "t", + title: "t", }, + wantsExporter: true, }, } @@ -102,7 +103,7 @@ func TestNewCmdCreateItem(t *testing.T) { assert.Equal(t, tt.wants.number, gotOpts.number) assert.Equal(t, tt.wants.owner, gotOpts.owner) assert.Equal(t, tt.wants.title, gotOpts.title) - assert.Equal(t, tt.wants.format, gotOpts.format) + assert.Equal(t, tt.wantsExporter, gotOpts.exporter != nil) }) } } @@ -370,3 +371,98 @@ func TestRunCreateItem_Draft_Me(t *testing.T) { "Created item\n", stdout.String()) } + +func TestRunCreateItem_JSON(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + // get user ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]interface{}{ + "login": "monalisa", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "id": "an ID", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"organization"}, + }, + }, + }) + + // get project ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserProject.*", + "variables": map[string]interface{}{ + "login": "monalisa", + "number": 1, + "firstItems": 0, + "afterItems": nil, + "firstFields": 0, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "id": "an ID", + }, + }, + }, + }) + + // create item + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation CreateDraftItem.*","variables":{"input":{"projectId":"an ID","title":"a title","body":""}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "addProjectV2DraftIssue": map[string]interface{}{ + "projectItem": map[string]interface{}{ + "id": "item ID", + "content": map[string]interface{}{ + "__typename": "Draft", + "title": "a title", + }, + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + config := createItemConfig{ + opts: createItemOpts{ + title: "a title", + owner: "monalisa", + number: 1, + exporter: cmdutil.NewJSONExporter(), + }, + client: client, + io: ios, + } + + err := runCreateItem(config) + assert.NoError(t, err) + assert.JSONEq( + t, + `{"id":"item ID","title":"","body":"","type":"Draft"}`, + stdout.String()) +} diff --git a/pkg/cmd/project/item-delete/item_delete.go b/pkg/cmd/project/item-delete/item_delete.go index 2717afedc..fc0d7c5ea 100644 --- a/pkg/cmd/project/item-delete/item_delete.go +++ b/pkg/cmd/project/item-delete/item_delete.go @@ -18,7 +18,7 @@ type deleteItemOpts struct { number int32 itemID string projectID string - format string + exporter cmdutil.Exporter } type deleteItemConfig struct { @@ -73,7 +73,7 @@ func NewCmdDeleteItem(f *cmdutil.Factory, runF func(config deleteItemConfig) err deleteItemCmd.Flags().StringVar(&opts.owner, "owner", "", "Login of the owner. Use \"@me\" for the current user.") deleteItemCmd.Flags().StringVar(&opts.itemID, "id", "", "ID of the item to delete") - cmdutil.StringEnumFlag(deleteItemCmd, &opts.format, "format", "", "", []string{"json"}, "Output format") + cmdutil.AddFormatFlags(deleteItemCmd, &opts.exporter) _ = deleteItemCmd.MarkFlagRequired("id") @@ -99,7 +99,7 @@ func runDeleteItem(config deleteItemConfig) error { return err } - if config.opts.format == "json" { + if config.opts.exporter != nil { return printJSON(config, query.DeleteProjectItem.DeletedItemId) } @@ -125,7 +125,9 @@ func printResults(config deleteItemConfig) error { return err } -func printJSON(config deleteItemConfig, ID githubv4.ID) error { - _, err := config.io.Out.Write([]byte(fmt.Sprintf(`{"id": "%s"}`, ID))) - return err +func printJSON(config deleteItemConfig, id githubv4.ID) error { + m := map[string]interface{}{ + "id": id, + } + return config.opts.exporter.Write(config.io, m) } diff --git a/pkg/cmd/project/item-delete/item_delete_test.go b/pkg/cmd/project/item-delete/item_delete_test.go index 4d3e97059..785f73edd 100644 --- a/pkg/cmd/project/item-delete/item_delete_test.go +++ b/pkg/cmd/project/item-delete/item_delete_test.go @@ -13,11 +13,12 @@ import ( func TestNewCmdDeleteItem(t *testing.T) { tests := []struct { - name string - cli string - wants deleteItemOpts - wantsErr bool - wantsErrMsg string + name string + cli string + wants deleteItemOpts + wantsErr bool + wantsErrMsg string + wantsExporter bool }{ { name: "missing-id", @@ -58,9 +59,9 @@ func TestNewCmdDeleteItem(t *testing.T) { name: "json", cli: "--format json --id 123", wants: deleteItemOpts{ - format: "json", itemID: "123", }, + wantsExporter: true, }, } @@ -94,7 +95,7 @@ func TestNewCmdDeleteItem(t *testing.T) { assert.Equal(t, tt.wants.number, gotOpts.number) assert.Equal(t, tt.wants.owner, gotOpts.owner) assert.Equal(t, tt.wants.itemID, gotOpts.itemID) - assert.Equal(t, tt.wants.format, gotOpts.format) + assert.Equal(t, tt.wantsExporter, gotOpts.exporter != nil) }) } } @@ -355,3 +356,92 @@ func TestRunDelete_Me(t *testing.T) { "Deleted item\n", stdout.String()) } + +func TestRunDelete_JSON(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + // get user ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]interface{}{ + "login": "monalisa", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "id": "an ID", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"organization"}, + }, + }, + }) + + // get project ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserProject.*", + "variables": map[string]interface{}{ + "login": "monalisa", + "number": 1, + "firstItems": 0, + "afterItems": nil, + "firstFields": 0, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "id": "an ID", + }, + }, + }, + }) + + // delete item + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation DeleteProjectItem.*","variables":{"input":{"projectId":"an ID","itemId":"item ID"}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "deleteProjectV2Item": map[string]interface{}{ + "deletedItemId": "item ID", + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + config := deleteItemConfig{ + opts: deleteItemOpts{ + owner: "monalisa", + number: 1, + itemID: "item ID", + exporter: cmdutil.NewJSONExporter(), + }, + client: client, + io: ios, + } + + err := runDeleteItem(config) + assert.NoError(t, err) + assert.JSONEq( + t, + `{"id":"item ID"}`, + stdout.String()) +} diff --git a/pkg/cmd/project/item-edit/item_edit.go b/pkg/cmd/project/item-edit/item_edit.go index 3bd479470..63dcb3b39 100644 --- a/pkg/cmd/project/item-edit/item_edit.go +++ b/pkg/cmd/project/item-edit/item_edit.go @@ -7,7 +7,6 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/pkg/cmd/project/shared/client" - "github.com/cli/cli/v2/pkg/cmd/project/shared/format" "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" @@ -28,8 +27,9 @@ type editItemOpts struct { date string singleSelectOptionID string iterationID string + clear bool // format - format string + exporter cmdutil.Exporter } type editItemConfig struct { @@ -50,19 +50,30 @@ type UpdateProjectV2FieldValue struct { } `graphql:"updateProjectV2ItemFieldValue(input:$input)"` } +type ClearProjectV2FieldValue struct { + Clear struct { + Item queries.ProjectItem `graphql:"projectV2Item"` + } `graphql:"clearProjectV2ItemFieldValue(input:$input)"` +} + func NewCmdEditItem(f *cmdutil.Factory, runF func(config editItemConfig) error) *cobra.Command { opts := editItemOpts{} editItemCmd := &cobra.Command{ Use: "item-edit", Short: "Edit an item in a project", - Long: heredoc.Doc(` + Long: heredoc.Docf(` Edit either a draft issue or a project item. Both usages require the ID of the item to edit. For non-draft issues, the ID of the project is also required, and only a single field value can be updated per invocation. - `), + + Remove project item field value using %[1]s--clear%[1]s flag. + `, "`"), Example: heredoc.Doc(` # edit an item's text field value gh project item-edit --id --field-id --project-id --text "new text" + + # clear an item's field value + gh project item-edit --id --field-id --project-id --clear `), RunE: func(cmd *cobra.Command, args []string) error { if err := cmdutil.MutuallyExclusive( @@ -76,6 +87,14 @@ func NewCmdEditItem(f *cmdutil.Factory, runF func(config editItemConfig) error) return err } + if err := cmdutil.MutuallyExclusive( + "cannot use `--text`, `--number`, `--date`, `--single-select-option-id` or `--iteration-id` in conjunction with `--clear`", + opts.text != "" || opts.number != 0 || opts.date != "" || opts.singleSelectOptionID != "" || opts.iterationID != "", + opts.clear, + ); err != nil { + return err + } + client, err := client.New(f) if err != nil { return err @@ -96,7 +115,7 @@ func NewCmdEditItem(f *cmdutil.Factory, runF func(config editItemConfig) error) } editItemCmd.Flags().StringVar(&opts.itemID, "id", "", "ID of the item to edit") - cmdutil.StringEnumFlag(editItemCmd, &opts.format, "format", "", "", []string{"json"}, "Output format") + cmdutil.AddFormatFlags(editItemCmd, &opts.exporter) editItemCmd.Flags().StringVar(&opts.title, "title", "", "Title of the draft issue item") editItemCmd.Flags().StringVar(&opts.body, "body", "", "Body of the draft issue item") @@ -108,6 +127,7 @@ func NewCmdEditItem(f *cmdutil.Factory, runF func(config editItemConfig) error) editItemCmd.Flags().StringVar(&opts.date, "date", "", "Date value for the field (YYYY-MM-DD)") editItemCmd.Flags().StringVar(&opts.singleSelectOptionID, "single-select-option-id", "", "ID of the single select option value to set on the field") editItemCmd.Flags().StringVar(&opts.iterationID, "iteration-id", "", "ID of the iteration value to set on the field") + editItemCmd.Flags().BoolVar(&opts.clear, "clear", false, "Remove field value") _ = editItemCmd.MarkFlagRequired("id") @@ -115,56 +135,19 @@ func NewCmdEditItem(f *cmdutil.Factory, runF func(config editItemConfig) error) } func runEditItem(config editItemConfig) error { + // when clear flag is used, remove value set to the corresponding field ID + if config.opts.clear { + return clearItemFieldValue(config) + } + // update draft issue if config.opts.title != "" || config.opts.body != "" { - if !strings.HasPrefix(config.opts.itemID, "DI_") { - return cmdutil.FlagErrorf("ID must be the ID of the draft issue content which is prefixed with `DI_`") - } - - query, variables := buildEditDraftIssue(config) - - err := config.client.Mutate("EditDraftIssueItem", query, variables) - if err != nil { - return err - } - - if config.opts.format == "json" { - return printDraftIssueJSON(config, query.UpdateProjectV2DraftIssue.DraftIssue) - } - - return printDraftIssueResults(config, query.UpdateProjectV2DraftIssue.DraftIssue) + return updateDraftIssue(config) } // update item values if config.opts.text != "" || config.opts.number != 0 || config.opts.date != "" || config.opts.singleSelectOptionID != "" || config.opts.iterationID != "" { - if config.opts.fieldID == "" { - return cmdutil.FlagErrorf("field-id must be provided") - } - if config.opts.projectID == "" { - // TODO: offer to fetch interactively - return cmdutil.FlagErrorf("project-id must be provided") - } - - var parsedDate time.Time - if config.opts.date != "" { - date, err := time.Parse("2006-01-02", config.opts.date) - if err != nil { - return err - } - parsedDate = date - } - - query, variables := buildUpdateItem(config, parsedDate) - err := config.client.Mutate("UpdateItemValues", query, variables) - if err != nil { - return err - } - - if config.opts.format == "json" { - return printItemJSON(config, &query.Update.Item) - } - - return printItemResults(config, &query.Update.Item) + return updateItemValues(config) } if _, err := fmt.Fprintln(config.io.ErrOut, "error: no changes to make"); err != nil { @@ -217,6 +200,16 @@ func buildUpdateItem(config editItemConfig, date time.Time) (*UpdateProjectV2Fie } } +func buildClearItem(config editItemConfig) (*ClearProjectV2FieldValue, map[string]interface{}) { + return &ClearProjectV2FieldValue{}, map[string]interface{}{ + "input": githubv4.ClearProjectV2ItemFieldValueInput{ + ProjectID: githubv4.ID(config.opts.projectID), + ItemID: githubv4.ID(config.opts.itemID), + FieldID: githubv4.ID(config.opts.fieldID), + }, + } +} + func printDraftIssueResults(config editItemConfig, item queries.DraftIssue) error { if !config.io.IsStdoutTTY() { return nil @@ -225,15 +218,6 @@ func printDraftIssueResults(config editItemConfig, item queries.DraftIssue) erro return err } -func printDraftIssueJSON(config editItemConfig, item queries.DraftIssue) error { - b, err := format.JSONProjectDraftIssue(item) - if err != nil { - return err - } - _, err = config.io.Out.Write(b) - return err -} - func printItemResults(config editItemConfig, item *queries.ProjectItem) error { if !config.io.IsStdoutTTY() { return nil @@ -242,12 +226,79 @@ func printItemResults(config editItemConfig, item *queries.ProjectItem) error { return err } -func printItemJSON(config editItemConfig, item *queries.ProjectItem) error { - b, err := format.JSONProjectItem(*item) +func clearItemFieldValue(config editItemConfig) error { + if err := fieldIdAndProjectIdPresence(config); err != nil { + return err + } + query, variables := buildClearItem(config) + err := config.client.Mutate("ClearItemFieldValue", query, variables) if err != nil { return err } - _, err = config.io.Out.Write(b) - return err + if config.opts.exporter != nil { + return config.opts.exporter.Write(config.io, &query.Clear.Item) + } + + return printItemResults(config, &query.Clear.Item) +} + +func updateDraftIssue(config editItemConfig) error { + if !strings.HasPrefix(config.opts.itemID, "DI_") { + return cmdutil.FlagErrorf("ID must be the ID of the draft issue content which is prefixed with `DI_`") + } + + query, variables := buildEditDraftIssue(config) + + err := config.client.Mutate("EditDraftIssueItem", query, variables) + if err != nil { + return err + } + + if config.opts.exporter != nil { + return config.opts.exporter.Write(config.io, query.UpdateProjectV2DraftIssue.DraftIssue) + } + + return printDraftIssueResults(config, query.UpdateProjectV2DraftIssue.DraftIssue) +} + +func updateItemValues(config editItemConfig) error { + if err := fieldIdAndProjectIdPresence(config); err != nil { + return err + } + + var parsedDate time.Time + if config.opts.date != "" { + date, err := time.Parse("2006-01-02", config.opts.date) + if err != nil { + return err + } + parsedDate = date + } + + query, variables := buildUpdateItem(config, parsedDate) + err := config.client.Mutate("UpdateItemValues", query, variables) + if err != nil { + return err + } + + if config.opts.exporter != nil { + return config.opts.exporter.Write(config.io, &query.Update.Item) + } + + return printItemResults(config, &query.Update.Item) +} + +func fieldIdAndProjectIdPresence(config editItemConfig) error { + if config.opts.fieldID == "" && config.opts.projectID == "" { + return cmdutil.FlagErrorf("field-id and project-id must be provided") + } + if config.opts.fieldID == "" { + return cmdutil.FlagErrorf("field-id must be provided") + } + if config.opts.projectID == "" { + // TODO: offer to fetch interactively + return cmdutil.FlagErrorf("project-id must be provided") + } + return nil } diff --git a/pkg/cmd/project/item-edit/item_edit_test.go b/pkg/cmd/project/item-edit/item_edit_test.go index 5cdc69b87..fb9097d19 100644 --- a/pkg/cmd/project/item-edit/item_edit_test.go +++ b/pkg/cmd/project/item-edit/item_edit_test.go @@ -13,11 +13,12 @@ import ( func TestNewCmdeditItem(t *testing.T) { tests := []struct { - name string - cli string - wants editItemOpts - wantsErr bool - wantsErrMsg string + name string + cli string + wants editItemOpts + wantsErr bool + wantsErrMsg string + wantsExporter bool }{ { name: "missing-id", @@ -94,13 +95,23 @@ func TestNewCmdeditItem(t *testing.T) { itemID: "123", }, }, + { + name: "clear", + cli: "--id 123 --field-id FIELD_ID --project-id PROJECT_ID --clear", + wants: editItemOpts{ + itemID: "123", + fieldID: "FIELD_ID", + projectID: "PROJECT_ID", + clear: true, + }, + }, { name: "json", cli: "--format json --id 123", wants: editItemOpts{ - format: "json", itemID: "123", }, + wantsExporter: true, }, } @@ -133,7 +144,7 @@ func TestNewCmdeditItem(t *testing.T) { assert.Equal(t, tt.wants.number, gotOpts.number) assert.Equal(t, tt.wants.itemID, gotOpts.itemID) - assert.Equal(t, tt.wants.format, gotOpts.format) + assert.Equal(t, tt.wantsExporter, gotOpts.exporter != nil) assert.Equal(t, tt.wants.title, gotOpts.title) assert.Equal(t, tt.wants.fieldID, gotOpts.fieldID) assert.Equal(t, tt.wants.projectID, gotOpts.projectID) @@ -142,6 +153,7 @@ func TestNewCmdeditItem(t *testing.T) { assert.Equal(t, tt.wants.date, gotOpts.date) assert.Equal(t, tt.wants.singleSelectOptionID, gotOpts.singleSelectOptionID) assert.Equal(t, tt.wants.iterationID, gotOpts.iterationID) + assert.Equal(t, tt.wants.clear, gotOpts.clear) }) } } @@ -472,3 +484,94 @@ func TestRunItemEdit_InvalidID(t *testing.T) { err := runEditItem(config) assert.Error(t, err, "ID must be the ID of the draft issue content which is prefixed with `DI_`") } + +func TestRunItemEdit_Clear(t *testing.T) { + defer gock.Off() + // gock.Observe(gock.DumpRequest) + + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation ClearItemFieldValue.*","variables":{"input":{"projectId":"project_id","itemId":"item_id","fieldId":"field_id"}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "clearProjectV2ItemFieldValue": map[string]interface{}{ + "projectV2Item": map[string]interface{}{ + "ID": "item_id", + "content": map[string]interface{}{ + "__typename": "Issue", + "body": "body", + "title": "title", + "number": 1, + "repository": map[string]interface{}{ + "nameWithOwner": "my-repo", + }, + }, + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + ios.SetStdoutTTY(true) + + config := editItemConfig{ + io: ios, + opts: editItemOpts{ + itemID: "item_id", + projectID: "project_id", + fieldID: "field_id", + clear: true, + }, + client: client, + } + + err := runEditItem(config) + assert.NoError(t, err) + assert.Equal(t, "Edited item \"title\"\n", stdout.String()) +} + +func TestRunItemEdit_JSON(t *testing.T) { + defer gock.Off() + // gock.Observe(gock.DumpRequest) + + // edit item + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation EditDraftIssueItem.*","variables":{"input":{"draftIssueId":"DI_item_id","title":"a title","body":"a new body"}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "updateProjectV2DraftIssue": map[string]interface{}{ + "draftIssue": map[string]interface{}{ + "id": "DI_item_id", + "title": "a title", + "body": "a new body", + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + config := editItemConfig{ + io: ios, + opts: editItemOpts{ + title: "a title", + body: "a new body", + itemID: "DI_item_id", + exporter: cmdutil.NewJSONExporter(), + }, + client: client, + } + + err := runEditItem(config) + assert.NoError(t, err) + assert.JSONEq( + t, + `{"id":"DI_item_id","title":"a title","body":"a new body","type":"DraftIssue"}`, + stdout.String()) +} diff --git a/pkg/cmd/project/item-list/item_list.go b/pkg/cmd/project/item-list/item_list.go index 4acc95dcb..d62eb2716 100644 --- a/pkg/cmd/project/item-list/item_list.go +++ b/pkg/cmd/project/item-list/item_list.go @@ -7,7 +7,6 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/internal/tableprinter" "github.com/cli/cli/v2/pkg/cmd/project/shared/client" - "github.com/cli/cli/v2/pkg/cmd/project/shared/format" "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" @@ -15,15 +14,14 @@ import ( ) type listOpts struct { - limit int - owner string - number int32 - format string + limit int + owner string + number int32 + exporter cmdutil.Exporter } type listConfig struct { io *iostreams.IOStreams - tp *tableprinter.TablePrinter client *queries.Client opts listOpts } @@ -52,10 +50,8 @@ func NewCmdList(f *cmdutil.Factory, runF func(config listConfig) error) *cobra.C opts.number = int32(num) } - t := tableprinter.New(f.IOStreams) config := listConfig{ io: f.IOStreams, - tp: t, client: client, opts: opts, } @@ -69,7 +65,7 @@ func NewCmdList(f *cmdutil.Factory, runF func(config listConfig) error) *cobra.C } listCmd.Flags().StringVar(&opts.owner, "owner", "", "Login of the owner. Use \"@me\" for the current user.") - cmdutil.StringEnumFlag(listCmd, &opts.format, "format", "", "", []string{"json"}, "Output format") + cmdutil.AddFormatFlags(listCmd, &opts.exporter) listCmd.Flags().IntVarP(&opts.limit, "limit", "L", queries.LimitDefault, "Maximum number of items to fetch") return listCmd @@ -96,8 +92,8 @@ func runList(config listConfig) error { return err } - if config.opts.format == "json" { - return printJSON(config, project) + if config.opts.exporter != nil { + return config.opts.exporter.Write(config.io, project.DetailedItems()) } return printResults(config, project.Items.Nodes, owner.Login) @@ -108,29 +104,20 @@ func printResults(config listConfig, items []queries.ProjectItem, login string) return cmdutil.NewNoResultsError(fmt.Sprintf("Project %d for owner %s has no items", config.opts.number, login)) } - config.tp.HeaderRow("Type", "Title", "Number", "Repository", "ID") + tp := tableprinter.New(config.io, tableprinter.WithHeader("Type", "Title", "Number", "Repository", "ID")) for _, i := range items { - config.tp.AddField(i.Type()) - config.tp.AddField(i.Title()) + tp.AddField(i.Type()) + tp.AddField(i.Title()) if i.Number() == 0 { - config.tp.AddField("") + tp.AddField("") } else { - config.tp.AddField(strconv.Itoa(i.Number())) + tp.AddField(strconv.Itoa(i.Number())) } - config.tp.AddField(i.Repo()) - config.tp.AddField(i.ID(), tableprinter.WithTruncate(nil)) - config.tp.EndRow() + tp.AddField(i.Repo()) + tp.AddField(i.ID(), tableprinter.WithTruncate(nil)) + tp.EndRow() } - return config.tp.Render() -} - -func printJSON(config listConfig, project *queries.Project) error { - b, err := format.JSONProjectDetailedItems(project) - if err != nil { - return err - } - _, err = config.io.Out.Write(b) - return err + return tp.Render() } diff --git a/pkg/cmd/project/item-list/item_list_test.go b/pkg/cmd/project/item-list/item_list_test.go index 490473691..e3f10e655 100644 --- a/pkg/cmd/project/item-list/item_list_test.go +++ b/pkg/cmd/project/item-list/item_list_test.go @@ -3,23 +3,24 @@ package itemlist import ( "testing" + "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" "github.com/google/shlex" - "github.com/cli/cli/v2/internal/tableprinter" "github.com/stretchr/testify/assert" "gopkg.in/h2non/gock.v1" ) func TestNewCmdList(t *testing.T) { tests := []struct { - name string - cli string - wants listOpts - wantsErr bool - wantsErrMsg string + name string + cli string + wants listOpts + wantsErr bool + wantsErrMsg string + wantsExporter bool }{ { name: "not-a-number", @@ -47,9 +48,9 @@ func TestNewCmdList(t *testing.T) { name: "json", cli: "--format json", wants: listOpts{ - format: "json", - limit: 30, + limit: 30, }, + wantsExporter: true, }, } @@ -82,12 +83,122 @@ func TestNewCmdList(t *testing.T) { assert.Equal(t, tt.wants.number, gotOpts.number) assert.Equal(t, tt.wants.owner, gotOpts.owner) - assert.Equal(t, tt.wants.format, gotOpts.format) + assert.Equal(t, tt.wantsExporter, gotOpts.exporter != nil) assert.Equal(t, tt.wants.limit, gotOpts.limit) }) } } +func TestRunList_User_tty(t *testing.T) { + defer gock.Off() + // gock.Observe(gock.DumpRequest) + + // get user ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]interface{}{ + "login": "monalisa", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "id": "an ID", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"organization"}, + }, + }, + }) + + // list project items + gock.New("https://api.github.com"). + Post("/graphql"). + JSON(map[string]interface{}{ + "query": "query UserProjectWithItems.*", + "variables": map[string]interface{}{ + "firstItems": queries.LimitDefault, + "afterItems": nil, + "firstFields": queries.LimitMax, + "afterFields": nil, + "login": "monalisa", + "number": 1, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "items": map[string]interface{}{ + "nodes": []map[string]interface{}{ + { + "id": "issue ID", + "content": map[string]interface{}{ + "__typename": "Issue", + "title": "an issue", + "number": 1, + "repository": map[string]string{ + "nameWithOwner": "cli/go-gh", + }, + }, + }, + { + "id": "pull request ID", + "content": map[string]interface{}{ + "__typename": "PullRequest", + "title": "a pull request", + "number": 2, + "repository": map[string]string{ + "nameWithOwner": "cli/go-gh", + }, + }, + }, + { + "id": "draft issue ID", + "content": map[string]interface{}{ + "id": "draft issue ID", + "title": "draft issue", + "__typename": "DraftIssue", + }, + }, + }, + }, + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + ios.SetStdoutTTY(true) + config := listConfig{ + opts: listOpts{ + number: 1, + owner: "monalisa", + }, + client: client, + io: ios, + } + + err := runList(config) + assert.NoError(t, err) + assert.Equal(t, heredoc.Doc(` + TYPE TITLE NUMBER REPOSITORY ID + Issue an issue 1 cli/go-gh issue ID + PullRequest a pull request 2 cli/go-gh pull request ID + DraftIssue draft issue draft issue ID + `), stdout.String()) +} + func TestRunList_User(t *testing.T) { defer gock.Off() // gock.Observe(gock.DumpRequest) @@ -163,6 +274,7 @@ func TestRunList_User(t *testing.T) { { "id": "draft issue ID", "content": map[string]interface{}{ + "id": "draft issue ID", "title": "draft issue", "__typename": "DraftIssue", }, @@ -178,7 +290,6 @@ func TestRunList_User(t *testing.T) { ios, _, stdout, _ := iostreams.Test() config := listConfig{ - tp: tableprinter.New(ios), opts: listOpts{ number: 1, owner: "monalisa", @@ -270,6 +381,7 @@ func TestRunList_Org(t *testing.T) { { "id": "draft issue ID", "content": map[string]interface{}{ + "id": "draft issue ID", "title": "draft issue", "__typename": "DraftIssue", }, @@ -285,7 +397,6 @@ func TestRunList_Org(t *testing.T) { ios, _, stdout, _ := iostreams.Test() config := listConfig{ - tp: tableprinter.New(ios), opts: listOpts{ number: 1, owner: "github", @@ -367,6 +478,7 @@ func TestRunList_Me(t *testing.T) { { "id": "draft issue ID", "content": map[string]interface{}{ + "id": "draft issue ID", "title": "draft issue", "__typename": "DraftIssue", }, @@ -382,7 +494,6 @@ func TestRunList_Me(t *testing.T) { ios, _, stdout, _ := iostreams.Test() config := listConfig{ - tp: tableprinter.New(ios), opts: listOpts{ number: 1, owner: "@me", @@ -398,3 +509,112 @@ func TestRunList_Me(t *testing.T) { "Issue\tan issue\t1\tcli/go-gh\tissue ID\nPullRequest\ta pull request\t2\tcli/go-gh\tpull request ID\nDraftIssue\tdraft issue\t\t\tdraft issue ID\n", stdout.String()) } + +func TestRunList_JSON(t *testing.T) { + defer gock.Off() + // gock.Observe(gock.DumpRequest) + + // get user ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]interface{}{ + "login": "monalisa", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "id": "an ID", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"organization"}, + }, + }, + }) + + // list project items + gock.New("https://api.github.com"). + Post("/graphql"). + JSON(map[string]interface{}{ + "query": "query UserProjectWithItems.*", + "variables": map[string]interface{}{ + "firstItems": queries.LimitDefault, + "afterItems": nil, + "firstFields": queries.LimitMax, + "afterFields": nil, + "login": "monalisa", + "number": 1, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "items": map[string]interface{}{ + "nodes": []map[string]interface{}{ + { + "id": "issue ID", + "content": map[string]interface{}{ + "__typename": "Issue", + "title": "an issue", + "number": 1, + "repository": map[string]string{ + "nameWithOwner": "cli/go-gh", + }, + }, + }, + { + "id": "pull request ID", + "content": map[string]interface{}{ + "__typename": "PullRequest", + "title": "a pull request", + "number": 2, + "repository": map[string]string{ + "nameWithOwner": "cli/go-gh", + }, + }, + }, + { + "id": "draft issue ID", + "content": map[string]interface{}{ + "id": "draft issue ID", + "title": "draft issue", + "__typename": "DraftIssue", + }, + }, + }, + "totalCount": 3, + }, + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + config := listConfig{ + opts: listOpts{ + number: 1, + owner: "monalisa", + exporter: cmdutil.NewJSONExporter(), + }, + client: client, + io: ios, + } + + err := runList(config) + assert.NoError(t, err) + assert.JSONEq( + t, + `{"items":[{"content":{"type":"Issue","body":"","title":"an issue","number":1,"repository":"cli/go-gh","url":""},"id":"issue ID"},{"content":{"type":"PullRequest","body":"","title":"a pull request","number":2,"repository":"cli/go-gh","url":""},"id":"pull request ID"},{"content":{"type":"DraftIssue","body":"","title":"draft issue","id":"draft issue ID"},"id":"draft issue ID"}],"totalCount":3}`, + stdout.String()) +} diff --git a/pkg/cmd/project/link/link.go b/pkg/cmd/project/link/link.go new file mode 100644 index 000000000..1e334af8c --- /dev/null +++ b/pkg/cmd/project/link/link.go @@ -0,0 +1,233 @@ +package link + +import ( + "fmt" + "net/http" + "strconv" + "strings" + + "github.com/MakeNowJust/heredoc" + "github.com/cli/cli/v2/api" + "github.com/cli/cli/v2/internal/gh" + "github.com/cli/cli/v2/internal/ghrepo" + "github.com/cli/cli/v2/pkg/cmd/project/shared/client" + "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" + "github.com/cli/cli/v2/pkg/cmdutil" + "github.com/cli/cli/v2/pkg/iostreams" + "github.com/spf13/cobra" +) + +type linkOpts struct { + number int32 + host string + owner string + repo string + team string + projectID string + projectTitle string + repoID string + teamID string +} + +type linkConfig struct { + httpClient func() (*http.Client, error) + config func() (gh.Config, error) + client *queries.Client + opts linkOpts + io *iostreams.IOStreams +} + +func NewCmdLink(f *cmdutil.Factory, runF func(config linkConfig) error) *cobra.Command { + opts := linkOpts{} + linkCmd := &cobra.Command{ + Short: "Link a project to a repository or a team", + Use: "link [] [flag]", + Example: heredoc.Doc(` + # link monalisa's project 1 to her repository "my_repo" + gh project link 1 --owner monalisa --repo my_repo + + # link monalisa's organization's project 1 to her team "my_team" + gh project link 1 --owner my_organization --team my_team + + # link monalisa's project 1 to the repository of current directory if neither --repo nor --team is specified + gh project link 1 + `), + RunE: func(cmd *cobra.Command, args []string) error { + client, err := client.New(f) + if err != nil { + return err + } + + if len(args) == 1 { + num, err := strconv.ParseInt(args[0], 10, 32) + if err != nil { + return cmdutil.FlagErrorf("invalid number: %v", args[0]) + } + opts.number = int32(num) + } + + if opts.repo == "" && opts.team == "" { + repo, err := f.BaseRepo() + if err != nil { + return err + } + opts.repo = repo.RepoName() + if opts.owner == "" { + opts.owner = repo.RepoOwner() + } + } + + if err := cmdutil.MutuallyExclusive("specify only one of `--repo` or `--team`", opts.repo != "", opts.team != ""); err != nil { + return err + } + + if err = validateRepoOrTeamFlag(&opts); err != nil { + return err + } + + config := linkConfig{ + httpClient: f.HttpClient, + config: f.Config, + client: client, + opts: opts, + io: f.IOStreams, + } + + // allow testing of the command without actually running it + if runF != nil { + return runF(config) + } + return runLink(config) + }, + } + + cmdutil.EnableRepoOverride(linkCmd, f) + linkCmd.Flags().StringVar(&opts.owner, "owner", "", "Login of the owner. Use \"@me\" for the current user.") + linkCmd.Flags().StringVarP(&opts.repo, "repo", "R", "", "The repository to be linked to this project") + linkCmd.Flags().StringVarP(&opts.team, "team", "T", "", "The team to be linked to this project") + + return linkCmd +} + +func validateRepoOrTeamFlag(opts *linkOpts) error { + + linkedTarget := "" + if opts.repo != "" { + linkedTarget = opts.repo + } else if opts.team != "" { + linkedTarget = opts.team + } + + if strings.Contains(linkedTarget, "/") { + nameArgs := strings.Split(linkedTarget, "/") + var host, owner, name string + + if len(nameArgs) == 2 { + owner = nameArgs[0] + name = nameArgs[1] + } else if len(nameArgs) == 3 { + host = nameArgs[0] + owner = nameArgs[1] + name = nameArgs[2] + } else { + if opts.repo != "" { + return fmt.Errorf("expected the \"[HOST/]OWNER/REPO\" or \"REPO\" format, got \"%s\"", linkedTarget) + } else if opts.team != "" { + return fmt.Errorf("expected the \"[HOST/]OWNER/TEAM\" or \"TEAM\" format, got \"%s\"", linkedTarget) + } + } + + if opts.owner != "" && opts.owner != owner { + return fmt.Errorf("'%s' has different owner from '%s'", linkedTarget, opts.owner) + } + + opts.owner = owner + opts.host = host + if opts.repo != "" { + opts.repo = name + } else if opts.team != "" { + opts.team = name + } + } + return nil +} + +func runLink(config linkConfig) error { + canPrompt := config.io.CanPrompt() + owner, err := config.client.NewOwner(canPrompt, config.opts.owner) + if err != nil { + return err + } + config.opts.owner = owner.Login + + project, err := config.client.NewProject(canPrompt, owner, config.opts.number, false) + if err != nil { + return err + } + config.opts.projectTitle = project.Title + config.opts.projectID = project.ID + if config.opts.number == 0 { + config.opts.number = project.Number + } + + httpClient, err := config.httpClient() + if err != nil { + return err + } + c := api.NewClientFromHTTP(httpClient) + + if config.opts.host == "" { + cfg, err := config.config() + if err != nil { + return err + } + host, _ := cfg.Authentication().DefaultHost() + config.opts.host = host + } + + if config.opts.repo != "" { + return linkRepo(c, config) + } else if config.opts.team != "" { + return linkTeam(c, config) + } + return nil +} + +func linkRepo(c *api.Client, config linkConfig) error { + repo, err := api.GitHubRepo(c, ghrepo.NewWithHost(config.opts.owner, config.opts.repo, config.opts.host)) + if err != nil { + return err + } + config.opts.repoID = repo.ID + + err = config.client.LinkProjectToRepository(config.opts.projectID, config.opts.repoID) + if err != nil { + return err + } + + return printResults(config, config.opts.repo) +} + +func linkTeam(c *api.Client, config linkConfig) error { + team, err := api.OrganizationTeam(c, config.opts.host, config.opts.owner, config.opts.team) + if err != nil { + return err + } + config.opts.teamID = team.ID + + err = config.client.LinkProjectToTeam(config.opts.projectID, config.opts.teamID) + if err != nil { + return err + } + + return printResults(config, config.opts.team) +} + +func printResults(config linkConfig, linkedTarget string) error { + if !config.io.IsStdoutTTY() { + return nil + } + + _, err := fmt.Fprintf(config.io.Out, "Linked '%s/%s' to project #%d '%s'\n", config.opts.owner, linkedTarget, config.opts.number, config.opts.projectTitle) + return err +} diff --git a/pkg/cmd/project/link/link_test.go b/pkg/cmd/project/link/link_test.go new file mode 100644 index 000000000..23fcfb106 --- /dev/null +++ b/pkg/cmd/project/link/link_test.go @@ -0,0 +1,406 @@ +package link + +import ( + "net/http" + "testing" + + "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" + "github.com/cli/cli/v2/internal/ghrepo" + "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" + "github.com/cli/cli/v2/pkg/cmdutil" + "github.com/cli/cli/v2/pkg/iostreams" + "github.com/google/shlex" + "github.com/stretchr/testify/require" + "gopkg.in/h2non/gock.v1" +) + +func TestNewCmdLink(t *testing.T) { + tests := []struct { + name string + cli string + wants linkOpts + wantsErr bool + wantsErrMsg string + wantsExporter bool + }{ + { + name: "not-a-number", + cli: "x", + wantsErr: true, + wantsErrMsg: "invalid number: x", + }, + { + name: "specify-repo-and-team", + cli: "--repo my-repo --team my-team", + wantsErr: true, + wantsErrMsg: "specify only one of `--repo` or `--team`", + }, + { + name: "specify-nothing", + cli: "", + wants: linkOpts{ + owner: "OWNER", + repo: "REPO", + }, + }, + { + name: "repo", + cli: "--repo my-repo", + wants: linkOpts{ + repo: "my-repo", + }, + }, + { + name: "repo-flag-contains-owner", + cli: "--repo monalisa/my-repo", + wants: linkOpts{ + owner: "monalisa", + repo: "my-repo", + }, + }, + { + name: "repo-flag-contains-owner-and-host", + cli: "--repo github.com/monalisa/my-repo", + wants: linkOpts{ + host: "github.com", + owner: "monalisa", + repo: "my-repo", + }, + }, + { + name: "repo-flag-contains-wrong-format", + cli: "--repo h/e/l/l/o", + wantsErr: true, + wantsErrMsg: "expected the \"[HOST/]OWNER/REPO\" or \"REPO\" format, got \"h/e/l/l/o\"", + }, + { + name: "repo-flag-with-owner-different-from-owner-flag", + cli: "--repo monalisa/my-repo --owner leonardo", + wantsErr: true, + wantsErrMsg: "'monalisa/my-repo' has different owner from 'leonardo'", + }, + { + name: "team", + cli: "--team my-team", + wants: linkOpts{ + team: "my-team", + }, + }, + { + name: "team-flag-contains-owner", + cli: "--team my-org/my-team", + wants: linkOpts{ + owner: "my-org", + team: "my-team", + }, + }, + { + name: "team-flag-contains-owner-and-host", + cli: "--team github.com/my-org/my-team", + wants: linkOpts{ + host: "github.com", + owner: "my-org", + team: "my-team", + }, + }, + { + name: "team-flag-contains-wrong-format", + cli: "--team h/e/l/l/o", + wantsErr: true, + wantsErrMsg: "expected the \"[HOST/]OWNER/TEAM\" or \"TEAM\" format, got \"h/e/l/l/o\"", + }, + { + name: "team-flag-with-owner-different-from-owner-flag", + cli: "--team my-org/my-team --owner her-org", + wantsErr: true, + wantsErrMsg: "'my-org/my-team' has different owner from 'her-org'", + }, + { + name: "number", + cli: "123 --repo my-repo", + wants: linkOpts{ + number: 123, + repo: "my-repo", + }, + }, + { + name: "owner-with-repo-flag", + cli: "--repo my-repo --owner monalisa", + wants: linkOpts{ + owner: "monalisa", + repo: "my-repo", + }, + }, + { + name: "owner-without-repo-flag", + cli: "--owner monalisa", + wants: linkOpts{ + owner: "monalisa", + repo: "REPO", + }, + }, + } + + t.Setenv("GH_TOKEN", "auth-token") + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + ios, _, _, _ := iostreams.Test() + f := &cmdutil.Factory{ + IOStreams: ios, + BaseRepo: func() (ghrepo.Interface, error) { + return ghrepo.New("OWNER", "REPO"), nil + }, + } + + argv, err := shlex.Split(tt.cli) + require.NoError(t, err) + + var gotOpts linkOpts + cmd := NewCmdLink(f, func(config linkConfig) error { + gotOpts = config.opts + return nil + }) + + cmd.SetArgs(argv) + _, err = cmd.ExecuteC() + if tt.wantsErr { + require.Error(t, err) + require.Equal(t, tt.wantsErrMsg, err.Error()) + return + } + require.NoError(t, err) + + require.Equal(t, tt.wants.number, gotOpts.number) + require.Equal(t, tt.wants.owner, gotOpts.owner) + require.Equal(t, tt.wants.repo, gotOpts.repo) + require.Equal(t, tt.wants.team, gotOpts.team) + require.Equal(t, tt.wants.projectID, gotOpts.projectID) + require.Equal(t, tt.wants.repoID, gotOpts.repoID) + require.Equal(t, tt.wants.teamID, gotOpts.teamID) + }) + } +} + +func TestRunLink_Repo(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + + // get user ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]string{ + "login": "monalisa", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "id": "an ID", + "login": "monalisa", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"organization"}, + }, + }, + }) + + // get user project ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserProject.*", + "variables": map[string]interface{}{ + "login": "monalisa", + "number": 1, + "firstItems": 0, + "afterItems": nil, + "firstFields": 0, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "projectV2": map[string]string{ + "id": "project-ID", + "title": "first-project", + }, + }, + }, + }) + + // link projectV2 to repository + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "mutation LinkProjectV2ToRepository.*", + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "linkProjectV2ToRepository": map[string]interface{}{}, + }, + }) + + // get repo ID + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`.*query RepositoryInfo.*`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "repository": map[string]interface{}{ + "id": "repo-ID", + }, + }, + }) + + ios, _, stdout, _ := iostreams.Test() + ios.SetStdoutTTY(true) + cfg := linkConfig{ + opts: linkOpts{ + number: 1, + repo: "my-repo", + owner: "monalisa", + }, + client: queries.NewTestClient(), + httpClient: func() (*http.Client, error) { + return http.DefaultClient, nil + }, + config: func() (gh.Config, error) { + return config.NewBlankConfig(), nil + }, + io: ios, + } + + err := runLink(cfg) + require.NoError(t, err) + require.Equal( + t, + "Linked 'monalisa/my-repo' to project #1 'first-project'\n", + stdout.String()) +} + +func TestRunLink_Team(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + + // get user ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]string{ + "login": "monalisa-org", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "id": "an ID", + "login": "monalisa-org", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"organization"}, + }, + }, + }) + + // get user project ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserProject.*", + "variables": map[string]interface{}{ + "login": "monalisa-org", + "number": 1, + "firstItems": 0, + "afterItems": nil, + "firstFields": 0, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "projectV2": map[string]string{ + "id": "project-ID", + "title": "first-project", + }, + }, + }, + }) + + // link projectV2 to team + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "mutation LinkProjectV2ToTeam.*", + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "linkProjectV2ToTeam": map[string]interface{}{}, + }, + }) + + // get team ID + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`.*query OrganizationTeam.*`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "organization": map[string]interface{}{ + "team": map[string]interface{}{ + "id": "team-ID", + }, + }, + }, + }) + + ios, _, stdout, _ := iostreams.Test() + ios.SetStdoutTTY(true) + cfg := linkConfig{ + opts: linkOpts{ + number: 1, + team: "my-team", + owner: "monalisa-org", + }, + client: queries.NewTestClient(), + httpClient: func() (*http.Client, error) { + return http.DefaultClient, nil + }, + config: func() (gh.Config, error) { + return config.NewBlankConfig(), nil + }, + io: ios, + } + + err := runLink(cfg) + require.NoError(t, err) + require.Equal( + t, + "Linked 'monalisa-org/my-team' to project #1 'first-project'\n", + stdout.String()) +} diff --git a/pkg/cmd/project/list/list.go b/pkg/cmd/project/list/list.go index c92434522..ba6e1d747 100644 --- a/pkg/cmd/project/list/list.go +++ b/pkg/cmd/project/list/list.go @@ -15,15 +15,14 @@ import ( ) type listOpts struct { - limit int - web bool - owner string - closed bool - format string + limit int + web bool + owner string + closed bool + exporter cmdutil.Exporter } type listConfig struct { - tp *tableprinter.TablePrinter client *queries.Client opts listOpts URLOpener func(string) error @@ -52,9 +51,8 @@ func NewCmdList(f *cmdutil.Factory, runF func(config listConfig) error) *cobra.C URLOpener := func(url string) error { return f.Browser.Browse(url) } - t := tableprinter.New(f.IOStreams) + config := listConfig{ - tp: t, client: client, opts: opts, URLOpener: URLOpener, @@ -68,11 +66,10 @@ func NewCmdList(f *cmdutil.Factory, runF func(config listConfig) error) *cobra.C return runList(config) }, } - listCmd.Flags().StringVar(&opts.owner, "owner", "", "Login of the owner") listCmd.Flags().BoolVarP(&opts.closed, "closed", "", false, "Include closed projects") listCmd.Flags().BoolVarP(&opts.web, "web", "w", false, "Open projects list in the browser") - cmdutil.StringEnumFlag(listCmd, &opts.format, "format", "", "", []string{"json"}, "Output format") + cmdutil.AddFormatFlags(listCmd, &opts.exporter) listCmd.Flags().IntVarP(&opts.limit, "limit", "L", queries.LimitDefault, "Maximum number of projects to fetch") return listCmd @@ -100,14 +97,14 @@ func runList(config listConfig) error { return err } - projects, totalCount, err := config.client.Projects(config.opts.owner, owner.Type, config.opts.limit, false) + projects, err := config.client.Projects(config.opts.owner, owner.Type, config.opts.limit, false) if err != nil { return err } projects = filterProjects(projects, config) - if config.opts.format == "json" { - return printJSON(config, projects, totalCount) + if config.opts.exporter != nil { + return config.opts.exporter.Write(config.io, projects) } return printResults(config, projects, owner.Login) @@ -141,47 +138,41 @@ func buildURL(config listConfig) (string, error) { return url, nil } -func filterProjects(nodes []queries.Project, config listConfig) []queries.Project { - projects := make([]queries.Project, 0, len(nodes)) - for _, p := range nodes { - if !config.opts.closed && p.Closed { +func filterProjects(nodes queries.Projects, config listConfig) queries.Projects { + filtered := queries.Projects{ + Nodes: make([]queries.Project, 0, len(nodes.Nodes)), + TotalCount: nodes.TotalCount, + } + for _, project := range nodes.Nodes { + if !config.opts.closed && project.Closed { continue } - projects = append(projects, p) + filtered.Nodes = append(filtered.Nodes, project) } - return projects + return filtered } -func printResults(config listConfig, projects []queries.Project, owner string) error { - if len(projects) == 0 { +func printResults(config listConfig, projects queries.Projects, owner string) error { + if len(projects.Nodes) == 0 { return cmdutil.NewNoResultsError(fmt.Sprintf("No projects found for %s", owner)) } - config.tp.HeaderRow("Number", "Title", "State", "ID") + tp := tableprinter.New(config.io, tableprinter.WithHeader("Number", "Title", "State", "ID")) - for _, p := range projects { - config.tp.AddField(strconv.Itoa(int(p.Number)), tableprinter.WithTruncate(nil)) - config.tp.AddField(p.Title) - var state string - if p.Closed { - state = "closed" - } else { - state = "open" - } - config.tp.AddField(state) - config.tp.AddField(p.ID, tableprinter.WithTruncate(nil)) - config.tp.EndRow() + cs := config.io.ColorScheme() + for _, p := range projects.Nodes { + tp.AddField( + strconv.Itoa(int(p.Number)), + tableprinter.WithTruncate(nil), + ) + tp.AddField(p.Title) + tp.AddField( + format.ProjectState(p), + tableprinter.WithColor(cs.ColorFromString(format.ColorForProjectState(p))), + ) + tp.AddField(p.ID, tableprinter.WithTruncate(nil)) + tp.EndRow() } - return config.tp.Render() -} - -func printJSON(config listConfig, projects []queries.Project, totalCount int) error { - b, err := format.JSONProjects(projects, totalCount) - if err != nil { - return err - } - - _, err = config.io.Out.Write(b) - return err + return tp.Render() } diff --git a/pkg/cmd/project/list/list_test.go b/pkg/cmd/project/list/list_test.go index 492d224b0..38cce4f22 100644 --- a/pkg/cmd/project/list/list_test.go +++ b/pkg/cmd/project/list/list_test.go @@ -4,7 +4,7 @@ import ( "bytes" "testing" - "github.com/cli/cli/v2/internal/tableprinter" + "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" @@ -15,11 +15,12 @@ import ( func TestNewCmdlist(t *testing.T) { tests := []struct { - name string - cli string - wants listOpts - wantsErr bool - wantsErrMsg string + name string + cli string + wants listOpts + wantsErr bool + wantsErrMsg string + wantsExporter bool }{ { name: "owner", @@ -49,9 +50,9 @@ func TestNewCmdlist(t *testing.T) { name: "json", cli: "--format json", wants: listOpts{ - format: "json", - limit: 30, + limit: 30, }, + wantsExporter: true, }, } @@ -86,11 +87,90 @@ func TestNewCmdlist(t *testing.T) { assert.Equal(t, tt.wants.closed, gotOpts.closed) assert.Equal(t, tt.wants.web, gotOpts.web) assert.Equal(t, tt.wants.limit, gotOpts.limit) - assert.Equal(t, tt.wants.format, gotOpts.format) + assert.Equal(t, tt.wantsExporter, gotOpts.exporter != nil) }) } } +func TestRunListTTY(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + // get user ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]interface{}{ + "login": "monalisa", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "id": "an ID", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"organization"}, + }, + }, + }) + + gock.New("https://api.github.com"). + Post("/graphql"). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "login": "monalisa", + "projectsV2": map[string]interface{}{ + "nodes": []interface{}{ + map[string]interface{}{ + "title": "Project 1", + "shortDescription": "Short description 1", + "url": "url1", + "closed": false, + "ID": "id-1", + "number": 1, + }, + map[string]interface{}{ + "title": "Project 2", + "shortDescription": "", + "url": "url2", + "closed": true, + "ID": "id-2", + "number": 2, + }, + }, + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + ios.SetStdoutTTY(true) + config := listConfig{ + opts: listOpts{ + owner: "monalisa", + }, + client: client, + io: ios, + } + + err := runList(config) + assert.NoError(t, err) + assert.Equal(t, heredoc.Doc(` + NUMBER TITLE STATE ID + 1 Project 1 open id-1 + `), stdout.String()) +} + func TestRunList(t *testing.T) { defer gock.Off() gock.Observe(gock.DumpRequest) @@ -154,7 +234,6 @@ func TestRunList(t *testing.T) { ios, _, stdout, _ := iostreams.Test() config := listConfig{ - tp: tableprinter.New(ios), opts: listOpts{ owner: "monalisa", }, @@ -170,6 +249,86 @@ func TestRunList(t *testing.T) { stdout.String()) } +func TestRunList_tty(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + // get user ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]interface{}{ + "login": "monalisa", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "id": "an ID", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"organization"}, + }, + }, + }) + + gock.New("https://api.github.com"). + Post("/graphql"). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "login": "monalisa", + "projectsV2": map[string]interface{}{ + "nodes": []interface{}{ + map[string]interface{}{ + "title": "Project 1", + "shortDescription": "Short description 1", + "url": "url1", + "closed": false, + "ID": "id-1", + "number": 1, + }, + map[string]interface{}{ + "title": "Project 2", + "shortDescription": "", + "url": "url2", + "closed": true, + "ID": "id-2", + "number": 2, + }, + }, + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + ios.SetStdoutTTY(true) + config := listConfig{ + opts: listOpts{ + owner: "monalisa", + }, + client: client, + io: ios, + } + + err := runList(config) + assert.NoError(t, err) + assert.Equal(t, heredoc.Doc(` + NUMBER TITLE STATE ID + 1 Project 1 open id-1 + `), + stdout.String()) +} + func TestRunList_Me(t *testing.T) { defer gock.Off() gock.Observe(gock.DumpRequest) @@ -225,7 +384,6 @@ func TestRunList_Me(t *testing.T) { ios, _, stdout, _ := iostreams.Test() config := listConfig{ - tp: tableprinter.New(ios), opts: listOpts{ owner: "@me", }, @@ -296,7 +454,6 @@ func TestRunListViewer(t *testing.T) { ios, _, stdout, _ := iostreams.Test() config := listConfig{ - tp: tableprinter.New(ios), opts: listOpts{}, client: client, io: ios, @@ -374,7 +531,6 @@ func TestRunListOrg(t *testing.T) { ios, _, stdout, _ := iostreams.Test() config := listConfig{ - tp: tableprinter.New(ios), opts: listOpts{ owner: "github", }, @@ -428,7 +584,6 @@ func TestRunListEmpty(t *testing.T) { ios, _, _, _ := iostreams.Test() config := listConfig{ - tp: tableprinter.New(ios), opts: listOpts{}, client: client, io: ios, @@ -504,7 +659,6 @@ func TestRunListWithClosed(t *testing.T) { ios, _, stdout, _ := iostreams.Test() config := listConfig{ - tp: tableprinter.New(ios), opts: listOpts{ owner: "monalisa", closed: true, @@ -733,3 +887,83 @@ func TestRunListWeb_Closed(t *testing.T) { assert.NoError(t, err) assert.Equal(t, "https://github.com/users/theviewer/projects?query=is%3Aclosed", buf.String()) } + +func TestRunList_JSON(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + // get user ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]interface{}{ + "login": "monalisa", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "id": "an ID", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"organization"}, + }, + }, + }) + + gock.New("https://api.github.com"). + Post("/graphql"). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "login": "monalisa", + "projectsV2": map[string]interface{}{ + "nodes": []interface{}{ + map[string]interface{}{ + "title": "Project 1", + "shortDescription": "Short description 1", + "url": "url1", + "closed": false, + "ID": "id-1", + "number": 1, + }, + map[string]interface{}{ + "title": "Project 2", + "shortDescription": "", + "url": "url2", + "closed": true, + "ID": "id-2", + "number": 2, + }, + }, + "totalCount": 2, + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + config := listConfig{ + opts: listOpts{ + owner: "monalisa", + exporter: cmdutil.NewJSONExporter(), + }, + client: client, + io: ios, + } + + err := runList(config) + assert.NoError(t, err) + assert.JSONEq( + t, + `{"projects":[{"number":1,"url":"url1","shortDescription":"Short description 1","public":false,"closed":false,"title":"Project 1","id":"id-1","readme":"","items":{"totalCount":0},"fields":{"totalCount":0},"owner":{"type":"","login":""}}],"totalCount":2}`, + stdout.String()) +} diff --git a/pkg/cmd/project/template/template.go b/pkg/cmd/project/mark-template/mark_template.go similarity index 69% rename from pkg/cmd/project/template/template.go rename to pkg/cmd/project/mark-template/mark_template.go index 9ef0732b9..025fe2838 100644 --- a/pkg/cmd/project/template/template.go +++ b/pkg/cmd/project/mark-template/mark_template.go @@ -1,4 +1,4 @@ -package template +package marktemplate import ( "fmt" @@ -6,7 +6,6 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/pkg/cmd/project/shared/client" - "github.com/cli/cli/v2/pkg/cmd/project/shared/format" "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" @@ -14,17 +13,17 @@ import ( "github.com/spf13/cobra" ) -type templateOpts struct { +type markTemplateOpts struct { owner string undo bool number int32 projectID string - format string + exporter cmdutil.Exporter } -type templateConfig struct { +type markTemplateConfig struct { client *queries.Client - opts templateOpts + opts markTemplateOpts io *iostreams.IOStreams } @@ -39,17 +38,17 @@ type unmarkProjectTemplateMutation struct { } `graphql:"unmarkProjectV2AsTemplate(input:$input)"` } -func NewCmdTemplate(f *cmdutil.Factory, runF func(config templateConfig) error) *cobra.Command { - opts := templateOpts{} - templateCmd := &cobra.Command{ +func NewCmdMarkTemplate(f *cmdutil.Factory, runF func(config markTemplateConfig) error) *cobra.Command { + opts := markTemplateOpts{} + markTemplateCmd := &cobra.Command{ Short: "Mark a project as a template", - Use: "template []", + Use: "mark-template []", Example: heredoc.Doc(` # mark the github org's project "1" as a template - gh project template 1 --owner "github" + gh project mark-template 1 --owner "github" # unmark the github org's project "1" as a template - gh project template 1 --owner "github" --undo + gh project mark-template 1 --owner "github" --undo `), Args: cobra.MaximumNArgs(1), RunE: func(cmd *cobra.Command, args []string) error { @@ -66,7 +65,7 @@ func NewCmdTemplate(f *cmdutil.Factory, runF func(config templateConfig) error) opts.number = int32(num) } - config := templateConfig{ + config := markTemplateConfig{ client: client, opts: opts, io: f.IOStreams, @@ -76,18 +75,18 @@ func NewCmdTemplate(f *cmdutil.Factory, runF func(config templateConfig) error) if runF != nil { return runF(config) } - return runTemplate(config) + return runMarkTemplate(config) }, } - templateCmd.Flags().StringVar(&opts.owner, "owner", "", "Login of the org owner.") - templateCmd.Flags().BoolVar(&opts.undo, "undo", false, "Unmark the project as a template.") - cmdutil.StringEnumFlag(templateCmd, &opts.format, "format", "", "", []string{"json"}, "Output format") + markTemplateCmd.Flags().StringVar(&opts.owner, "owner", "", "Login of the org owner.") + markTemplateCmd.Flags().BoolVar(&opts.undo, "undo", false, "Unmark the project as a template.") + cmdutil.AddFormatFlags(markTemplateCmd, &opts.exporter) - return templateCmd + return markTemplateCmd } -func runTemplate(config templateConfig) error { +func runMarkTemplate(config markTemplateConfig) error { canPrompt := config.io.CanPrompt() owner, err := config.client.NewOwner(canPrompt, config.opts.owner) if err != nil { @@ -107,8 +106,8 @@ func runTemplate(config templateConfig) error { return err } - if config.opts.format == "json" { - return printJSON(config, *project) + if config.opts.exporter != nil { + return config.opts.exporter.Write(config.io, *project) } return printResults(config, query.TemplateProject.Project) @@ -120,14 +119,14 @@ func runTemplate(config templateConfig) error { return err } - if config.opts.format == "json" { - return printJSON(config, *project) + if config.opts.exporter != nil { + return config.opts.exporter.Write(config.io, query.TemplateProject.Project) } return printResults(config, query.TemplateProject.Project) } -func markTemplateArgs(config templateConfig) (*markProjectTemplateMutation, map[string]interface{}) { +func markTemplateArgs(config markTemplateConfig) (*markProjectTemplateMutation, map[string]interface{}) { return &markProjectTemplateMutation{}, map[string]interface{}{ "input": githubv4.MarkProjectV2AsTemplateInput{ ProjectID: githubv4.ID(config.opts.projectID), @@ -139,7 +138,7 @@ func markTemplateArgs(config templateConfig) (*markProjectTemplateMutation, map[ } } -func unmarkTemplateArgs(config templateConfig) (*unmarkProjectTemplateMutation, map[string]interface{}) { +func unmarkTemplateArgs(config markTemplateConfig) (*unmarkProjectTemplateMutation, map[string]interface{}) { return &unmarkProjectTemplateMutation{}, map[string]interface{}{ "input": githubv4.UnmarkProjectV2AsTemplateInput{ ProjectID: githubv4.ID(config.opts.projectID), @@ -151,7 +150,7 @@ func unmarkTemplateArgs(config templateConfig) (*unmarkProjectTemplateMutation, } } -func printResults(config templateConfig, project queries.Project) error { +func printResults(config markTemplateConfig, project queries.Project) error { if !config.io.IsStdoutTTY() { return nil } @@ -164,13 +163,3 @@ func printResults(config templateConfig, project queries.Project) error { _, err := fmt.Fprintf(config.io.Out, "Marked project %d as a template.\n", project.Number) return err } - -func printJSON(config templateConfig, project queries.Project) error { - b, err := format.JSONProject(project) - if err != nil { - return err - } - - _, err = config.io.Out.Write(b) - return err -} diff --git a/pkg/cmd/project/template/template_test.go b/pkg/cmd/project/mark-template/mark_template_test.go similarity index 62% rename from pkg/cmd/project/template/template_test.go rename to pkg/cmd/project/mark-template/mark_template_test.go index df42ae5ca..91d2c8095 100644 --- a/pkg/cmd/project/template/template_test.go +++ b/pkg/cmd/project/mark-template/mark_template_test.go @@ -1,4 +1,4 @@ -package template +package marktemplate import ( "testing" @@ -11,13 +11,14 @@ import ( "gopkg.in/h2non/gock.v1" ) -func TestNewCmdTemplate(t *testing.T) { +func TestNewCmdMarkTemplate(t *testing.T) { tests := []struct { - name string - cli string - wants templateOpts - wantsErr bool - wantsErrMsg string + name string + cli string + wants markTemplateOpts + wantsErr bool + wantsErrMsg string + wantsExporter bool }{ { name: "not-a-number", @@ -28,31 +29,29 @@ func TestNewCmdTemplate(t *testing.T) { { name: "number", cli: "123", - wants: templateOpts{ + wants: markTemplateOpts{ number: 123, }, }, { name: "owner", cli: "--owner monalisa", - wants: templateOpts{ + wants: markTemplateOpts{ owner: "monalisa", }, }, { name: "undo", cli: "--undo", - wants: templateOpts{ + wants: markTemplateOpts{ undo: true, }, }, { - name: "json", - cli: "--format json", - wants: templateOpts{ - format: "json", - }, + name: "json", + cli: "--format json", + wantsExporter: true, }, } @@ -68,8 +67,8 @@ func TestNewCmdTemplate(t *testing.T) { argv, err := shlex.Split(tt.cli) assert.NoError(t, err) - var gotOpts templateOpts - cmd := NewCmdTemplate(f, func(config templateConfig) error { + var gotOpts markTemplateOpts + cmd := NewCmdMarkTemplate(f, func(config markTemplateConfig) error { gotOpts = config.opts return nil }) @@ -85,10 +84,11 @@ func TestNewCmdTemplate(t *testing.T) { assert.Equal(t, tt.wants.number, gotOpts.number) assert.Equal(t, tt.wants.owner, gotOpts.owner) - assert.Equal(t, tt.wants.format, gotOpts.format) + assert.Equal(t, tt.wantsExporter, gotOpts.exporter != nil) }) } } + func TestRunMarkTemplate_Org(t *testing.T) { defer gock.Off() gock.Observe(gock.DumpRequest) @@ -164,8 +164,8 @@ func TestRunMarkTemplate_Org(t *testing.T) { ios, _, stdout, _ := iostreams.Test() ios.SetStdoutTTY(true) - config := templateConfig{ - opts: templateOpts{ + config := markTemplateConfig{ + opts: markTemplateOpts{ owner: "github", number: 1, }, @@ -173,7 +173,7 @@ func TestRunMarkTemplate_Org(t *testing.T) { io: ios, } - err := runTemplate(config) + err := runMarkTemplate(config) assert.NoError(t, err) assert.Equal( t, @@ -256,8 +256,8 @@ func TestRunUnmarkTemplate_Org(t *testing.T) { ios, _, stdout, _ := iostreams.Test() ios.SetStdoutTTY(true) - config := templateConfig{ - opts: templateOpts{ + config := markTemplateConfig{ + opts: markTemplateOpts{ owner: "github", number: 1, undo: true, @@ -266,10 +266,106 @@ func TestRunUnmarkTemplate_Org(t *testing.T) { io: ios, } - err := runTemplate(config) + err := runMarkTemplate(config) assert.NoError(t, err) assert.Equal( t, "Unmarked project 1 as a template.\n", stdout.String()) } + +func TestRunMarkTemplate_JSON(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + + // get org ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]interface{}{ + "login": "github", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "organization": map[string]interface{}{ + "id": "an ID", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"user"}, + }, + }, + }) + + // get project ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query OrgProject.*", + "variables": map[string]interface{}{ + "login": "github", + "number": 1, + "firstItems": 0, + "afterItems": nil, + "firstFields": 0, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "organization": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "id": "an ID", + }, + }, + }, + }) + + // template project + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation MarkProjectTemplate.*","variables":{"afterFields":null,"afterItems":null,"firstFields":0,"firstItems":0,"input":{"projectId":"an ID"}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "markProjectV2AsTemplate": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "id": "project ID", + "number": 1, + "owner": map[string]interface{}{ + "__typename": "Organization", + "login": "github", + }, + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + config := markTemplateConfig{ + opts: markTemplateOpts{ + owner: "github", + number: 1, + exporter: cmdutil.NewJSONExporter(), + }, + client: client, + io: ios, + } + + err := runMarkTemplate(config) + assert.NoError(t, err) + assert.JSONEq( + t, + `{"number":1,"url":"","shortDescription":"","public":false,"closed":false,"title":"","id":"project ID","readme":"","items":{"totalCount":0},"fields":{"totalCount":0},"owner":{"type":"Organization","login":"github"}}`, + stdout.String()) +} diff --git a/pkg/cmd/project/project.go b/pkg/cmd/project/project.go index d9858953d..6dae4a897 100644 --- a/pkg/cmd/project/project.go +++ b/pkg/cmd/project/project.go @@ -16,8 +16,10 @@ import ( cmdItemDelete "github.com/cli/cli/v2/pkg/cmd/project/item-delete" cmdItemEdit "github.com/cli/cli/v2/pkg/cmd/project/item-edit" cmdItemList "github.com/cli/cli/v2/pkg/cmd/project/item-list" + cmdLink "github.com/cli/cli/v2/pkg/cmd/project/link" cmdList "github.com/cli/cli/v2/pkg/cmd/project/list" - cmdTemplate "github.com/cli/cli/v2/pkg/cmd/project/template" + cmdTemplate "github.com/cli/cli/v2/pkg/cmd/project/mark-template" + cmdUnlink "github.com/cli/cli/v2/pkg/cmd/project/unlink" cmdView "github.com/cli/cli/v2/pkg/cmd/project/view" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/spf13/cobra" @@ -43,8 +45,10 @@ func NewCmdProject(f *cmdutil.Factory) *cobra.Command { cmd.AddCommand(cmdClose.NewCmdClose(f, nil)) cmd.AddCommand(cmdDelete.NewCmdDelete(f, nil)) cmd.AddCommand(cmdEdit.NewCmdEdit(f, nil)) + cmd.AddCommand(cmdLink.NewCmdLink(f, nil)) cmd.AddCommand(cmdView.NewCmdView(f, nil)) - cmd.AddCommand(cmdTemplate.NewCmdTemplate(f, nil)) + cmd.AddCommand(cmdTemplate.NewCmdMarkTemplate(f, nil)) + cmd.AddCommand(cmdUnlink.NewCmdUnlink(f, nil)) // items cmd.AddCommand(cmdItemList.NewCmdList(f, nil)) diff --git a/pkg/cmd/project/shared/format/display.go b/pkg/cmd/project/shared/format/display.go new file mode 100644 index 000000000..498fd7f2b --- /dev/null +++ b/pkg/cmd/project/shared/format/display.go @@ -0,0 +1,19 @@ +package format + +import ( + "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" +) + +func ProjectState(project queries.Project) string { + if project.Closed { + return "closed" + } + return "open" +} + +func ColorForProjectState(project queries.Project) string { + if project.Closed { + return "gray" + } + return "green" +} diff --git a/pkg/cmd/project/shared/format/display_test.go b/pkg/cmd/project/shared/format/display_test.go new file mode 100644 index 000000000..0aa21623b --- /dev/null +++ b/pkg/cmd/project/shared/format/display_test.go @@ -0,0 +1,18 @@ +package format + +import ( + "testing" + + "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" + "github.com/stretchr/testify/assert" +) + +func TestProjectState(t *testing.T) { + assert.Equal(t, "open", ProjectState(queries.Project{})) + assert.Equal(t, "closed", ProjectState(queries.Project{Closed: true})) +} + +func TestColorForProjectState(t *testing.T) { + assert.Equal(t, "green", ColorForProjectState(queries.Project{})) + assert.Equal(t, "gray", ColorForProjectState(queries.Project{Closed: true})) +} diff --git a/pkg/cmd/project/shared/format/json.go b/pkg/cmd/project/shared/format/json.go deleted file mode 100644 index 7bfebdeda..000000000 --- a/pkg/cmd/project/shared/format/json.go +++ /dev/null @@ -1,372 +0,0 @@ -package format - -import ( - "encoding/json" - "strings" - - "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" -) - -// JSONProject serializes a Project to JSON. -func JSONProject(project queries.Project) ([]byte, error) { - return json.Marshal(projectJSON{ - Number: project.Number, - URL: project.URL, - ShortDescription: project.ShortDescription, - Public: project.Public, - Closed: project.Closed, - Template: project.Template, - Title: project.Title, - ID: project.ID, - Readme: project.Readme, - Items: struct { - TotalCount int `json:"totalCount"` - }{ - TotalCount: project.Items.TotalCount, - }, - Fields: struct { - TotalCount int `json:"totalCount"` - }{ - TotalCount: project.Fields.TotalCount, - }, - Owner: struct { - Type string `json:"type"` - Login string `json:"login"` - }{ - Type: project.OwnerType(), - Login: project.OwnerLogin(), - }, - }) -} - -// JSONProjects serializes a slice of Projects to JSON. -// JSON fields are `totalCount` and `projects`. -func JSONProjects(projects []queries.Project, totalCount int) ([]byte, error) { - var result []projectJSON - for _, p := range projects { - result = append(result, projectJSON{ - Number: p.Number, - URL: p.URL, - ShortDescription: p.ShortDescription, - Public: p.Public, - Closed: p.Closed, - Template: p.Template, - Title: p.Title, - ID: p.ID, - Readme: p.Readme, - Items: struct { - TotalCount int `json:"totalCount"` - }{ - TotalCount: p.Items.TotalCount, - }, - Fields: struct { - TotalCount int `json:"totalCount"` - }{ - TotalCount: p.Fields.TotalCount, - }, - Owner: struct { - Type string `json:"type"` - Login string `json:"login"` - }{ - Type: p.OwnerType(), - Login: p.OwnerLogin(), - }, - }) - } - - return json.Marshal(struct { - Projects []projectJSON `json:"projects"` - TotalCount int `json:"totalCount"` - }{ - Projects: result, - TotalCount: totalCount, - }) -} - -type projectJSON struct { - Number int32 `json:"number"` - URL string `json:"url"` - ShortDescription string `json:"shortDescription"` - Public bool `json:"public"` - Closed bool `json:"closed"` - Template bool `json:"template"` - Title string `json:"title"` - ID string `json:"id"` - Readme string `json:"readme"` - Items struct { - TotalCount int `json:"totalCount"` - } `graphql:"items(first: 100)" json:"items"` - Fields struct { - TotalCount int `json:"totalCount"` - } `graphql:"fields(first:100)" json:"fields"` - Owner struct { - Type string `json:"type"` - Login string `json:"login"` - } `json:"owner"` -} - -// JSONProjectField serializes a ProjectField to JSON. -func JSONProjectField(field queries.ProjectField) ([]byte, error) { - val := projectFieldJSON{ - ID: field.ID(), - Name: field.Name(), - Type: field.Type(), - } - for _, o := range field.Options() { - val.Options = append(val.Options, singleSelectOptionJSON{ - Name: o.Name, - ID: o.ID, - }) - } - - return json.Marshal(val) -} - -// JSONProjectFields serializes a slice of ProjectFields to JSON. -// JSON fields are `totalCount` and `fields`. -func JSONProjectFields(project *queries.Project) ([]byte, error) { - var result []projectFieldJSON - for _, f := range project.Fields.Nodes { - val := projectFieldJSON{ - ID: f.ID(), - Name: f.Name(), - Type: f.Type(), - } - for _, o := range f.Options() { - val.Options = append(val.Options, singleSelectOptionJSON{ - Name: o.Name, - ID: o.ID, - }) - } - - result = append(result, val) - } - - return json.Marshal(struct { - Fields []projectFieldJSON `json:"fields"` - TotalCount int `json:"totalCount"` - }{ - Fields: result, - TotalCount: project.Fields.TotalCount, - }) -} - -type projectFieldJSON struct { - ID string `json:"id"` - Name string `json:"name"` - Type string `json:"type"` - Options []singleSelectOptionJSON `json:"options,omitempty"` -} - -type singleSelectOptionJSON struct { - ID string `json:"id"` - Name string `json:"name"` -} - -// JSONProjectItem serializes a ProjectItem to JSON. -func JSONProjectItem(item queries.ProjectItem) ([]byte, error) { - return json.Marshal(projectItemJSON{ - ID: item.ID(), - Title: item.Title(), - Body: item.Body(), - Type: item.Type(), - URL: item.URL(), - }) -} - -type projectItemJSON struct { - ID string `json:"id"` - Title string `json:"title"` - Body string `json:"body"` - Type string `json:"type"` - URL string `json:"url,omitempty"` -} - -// JSONProjectDraftIssue serializes a DraftIssue to JSON. -// This is needed because the field for -// https://docs.github.com/en/graphql/reference/mutations#updateprojectv2draftissue -// is a DraftIssue https://docs.github.com/en/graphql/reference/objects#draftissue -// and not a ProjectV2Item https://docs.github.com/en/graphql/reference/objects#projectv2item -func JSONProjectDraftIssue(item queries.DraftIssue) ([]byte, error) { - - return json.Marshal(draftIssueJSON{ - ID: item.ID, - Title: item.Title, - Body: item.Body, - Type: "DraftIssue", - }) -} - -type draftIssueJSON struct { - ID string `json:"id"` - Title string `json:"title"` - Body string `json:"body"` - Type string `json:"type"` -} - -func projectItemContent(p queries.ProjectItem) any { - switch p.Content.TypeName { - case "DraftIssue": - return struct { - Type string `json:"type"` - Body string `json:"body"` - Title string `json:"title"` - }{ - Type: p.Type(), - Body: p.Body(), - Title: p.Title(), - } - case "Issue": - return struct { - Type string `json:"type"` - Body string `json:"body"` - Title string `json:"title"` - Number int `json:"number"` - Repository string `json:"repository"` - URL string `json:"url"` - }{ - Type: p.Type(), - Body: p.Body(), - Title: p.Title(), - Number: p.Number(), - Repository: p.Repo(), - URL: p.URL(), - } - case "PullRequest": - return struct { - Type string `json:"type"` - Body string `json:"body"` - Title string `json:"title"` - Number int `json:"number"` - Repository string `json:"repository"` - URL string `json:"url"` - }{ - Type: p.Type(), - Body: p.Body(), - Title: p.Title(), - Number: p.Number(), - Repository: p.Repo(), - URL: p.URL(), - } - } - - return nil -} - -func projectFieldValueData(v queries.FieldValueNodes) any { - switch v.Type { - case "ProjectV2ItemFieldDateValue": - return v.ProjectV2ItemFieldDateValue.Date - case "ProjectV2ItemFieldIterationValue": - return struct { - Title string `json:"title"` - StartDate string `json:"startDate"` - Duration int `json:"duration"` - }{ - Title: v.ProjectV2ItemFieldIterationValue.Title, - StartDate: v.ProjectV2ItemFieldIterationValue.StartDate, - Duration: v.ProjectV2ItemFieldIterationValue.Duration, - } - case "ProjectV2ItemFieldNumberValue": - return v.ProjectV2ItemFieldNumberValue.Number - case "ProjectV2ItemFieldSingleSelectValue": - return v.ProjectV2ItemFieldSingleSelectValue.Name - case "ProjectV2ItemFieldTextValue": - return v.ProjectV2ItemFieldTextValue.Text - case "ProjectV2ItemFieldMilestoneValue": - return struct { - Title string `json:"title"` - Description string `json:"description"` - DueOn string `json:"dueOn"` - }{ - Title: v.ProjectV2ItemFieldMilestoneValue.Milestone.Title, - Description: v.ProjectV2ItemFieldMilestoneValue.Milestone.Description, - DueOn: v.ProjectV2ItemFieldMilestoneValue.Milestone.DueOn, - } - case "ProjectV2ItemFieldLabelValue": - names := make([]string, 0) - for _, p := range v.ProjectV2ItemFieldLabelValue.Labels.Nodes { - names = append(names, p.Name) - } - return names - case "ProjectV2ItemFieldPullRequestValue": - urls := make([]string, 0) - for _, p := range v.ProjectV2ItemFieldPullRequestValue.PullRequests.Nodes { - urls = append(urls, p.Url) - } - return urls - case "ProjectV2ItemFieldRepositoryValue": - return v.ProjectV2ItemFieldRepositoryValue.Repository.Url - case "ProjectV2ItemFieldUserValue": - logins := make([]string, 0) - for _, p := range v.ProjectV2ItemFieldUserValue.Users.Nodes { - logins = append(logins, p.Login) - } - return logins - case "ProjectV2ItemFieldReviewerValue": - names := make([]string, 0) - for _, p := range v.ProjectV2ItemFieldReviewerValue.Reviewers.Nodes { - if p.Type == "Team" { - names = append(names, p.Team.Name) - } else if p.Type == "User" { - names = append(names, p.User.Login) - } - } - return names - - } - - return nil -} - -// serialize creates a map from field to field values -func serializeProjectWithItems(project *queries.Project) []map[string]any { - fields := make(map[string]string) - - // make a map of fields by ID - for _, f := range project.Fields.Nodes { - fields[f.ID()] = CamelCase(f.Name()) - } - itemsSlice := make([]map[string]any, 0) - - // for each value, look up the name by ID - // and set the value to the field value - for _, i := range project.Items.Nodes { - o := make(map[string]any) - o["id"] = i.Id - o["content"] = projectItemContent(i) - for _, v := range i.FieldValues.Nodes { - id := v.ID() - value := projectFieldValueData(v) - - o[fields[id]] = value - } - itemsSlice = append(itemsSlice, o) - } - return itemsSlice -} - -// JSONProjectWithItems returns a detailed JSON representation of project items. -// JSON fields are `totalCount` and `items`. -func JSONProjectDetailedItems(project *queries.Project) ([]byte, error) { - items := serializeProjectWithItems(project) - return json.Marshal(struct { - Items []map[string]any `json:"items"` - TotalCount int `json:"totalCount"` - }{ - Items: items, - TotalCount: project.Items.TotalCount, - }) -} - -// CamelCase converts a string to camelCase, which is useful for turning Go field names to JSON keys. -func CamelCase(s string) string { - if len(s) == 0 { - return "" - } - - if len(s) == 1 { - return strings.ToLower(s) - } - return strings.ToLower(s[0:1]) + s[1:] -} diff --git a/pkg/cmd/project/shared/format/json_test.go b/pkg/cmd/project/shared/queries/export_data_test.go similarity index 56% rename from pkg/cmd/project/shared/format/json_test.go rename to pkg/cmd/project/shared/queries/export_data_test.go index 9e75167c5..adfdce63f 100644 --- a/pkg/cmd/project/shared/format/json_test.go +++ b/pkg/cmd/project/shared/queries/export_data_test.go @@ -1,15 +1,15 @@ -package format +package queries import ( + "encoding/json" "testing" - "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" - "github.com/stretchr/testify/assert" ) +// Regression test from before ExportData was implemented. func TestJSONProject_User(t *testing.T) { - project := queries.Project{ + project := Project{ ID: "123", Number: 2, URL: "a url", @@ -22,35 +22,36 @@ func TestJSONProject_User(t *testing.T) { project.Fields.TotalCount = 2 project.Owner.TypeName = "User" project.Owner.User.Login = "monalisa" - b, err := JSONProject(project) + b, err := json.Marshal(project.ExportData(nil)) assert.NoError(t, err) - assert.Equal(t, `{"number":2,"url":"a url","shortDescription":"short description","public":true,"closed":false,"template":false,"title":"","id":"123","readme":"readme","items":{"totalCount":1},"fields":{"totalCount":2},"owner":{"type":"User","login":"monalisa"}}`, string(b)) + assert.JSONEq(t, `{"number":2,"url":"a url","shortDescription":"short description","public":true,"closed":false,"title":"","id":"123","readme":"readme","items":{"totalCount":1},"fields":{"totalCount":2},"owner":{"type":"User","login":"monalisa"}}`, string(b)) } +// Regression test from before ExportData was implemented. func TestJSONProject_Org(t *testing.T) { - project := queries.Project{ + project := Project{ ID: "123", Number: 2, URL: "a url", ShortDescription: "short description", Public: true, Readme: "readme", - Template: true, } project.Items.TotalCount = 1 project.Fields.TotalCount = 2 project.Owner.TypeName = "Organization" project.Owner.Organization.Login = "github" - b, err := JSONProject(project) + b, err := json.Marshal(project.ExportData(nil)) assert.NoError(t, err) - assert.Equal(t, `{"number":2,"url":"a url","shortDescription":"short description","public":true,"closed":false,"template":true,"title":"","id":"123","readme":"readme","items":{"totalCount":1},"fields":{"totalCount":2},"owner":{"type":"Organization","login":"github"}}`, string(b)) + assert.JSONEq(t, `{"number":2,"url":"a url","shortDescription":"short description","public":true,"closed":false,"title":"","id":"123","readme":"readme","items":{"totalCount":1},"fields":{"totalCount":2},"owner":{"type":"Organization","login":"github"}}`, string(b)) } +// Regression test from before ExportData was implemented. func TestJSONProjects(t *testing.T) { - userProject := queries.Project{ + userProject := Project{ ID: "123", Number: 2, URL: "a url", @@ -64,47 +65,51 @@ func TestJSONProjects(t *testing.T) { userProject.Owner.TypeName = "User" userProject.Owner.User.Login = "monalisa" - orgProject := queries.Project{ + orgProject := Project{ ID: "123", Number: 2, URL: "a url", ShortDescription: "short description", Public: true, Readme: "readme", - Template: true, } orgProject.Items.TotalCount = 1 orgProject.Fields.TotalCount = 2 orgProject.Owner.TypeName = "Organization" orgProject.Owner.Organization.Login = "github" - b, err := JSONProjects([]queries.Project{userProject, orgProject}, 2) + + projects := Projects{ + Nodes: []Project{userProject, orgProject}, + TotalCount: 2, + } + b, err := json.Marshal(projects.ExportData(nil)) assert.NoError(t, err) - assert.Equal( + assert.JSONEq( t, - `{"projects":[{"number":2,"url":"a url","shortDescription":"short description","public":true,"closed":false,"template":false,"title":"","id":"123","readme":"readme","items":{"totalCount":1},"fields":{"totalCount":2},"owner":{"type":"User","login":"monalisa"}},{"number":2,"url":"a url","shortDescription":"short description","public":true,"closed":false,"template":true,"title":"","id":"123","readme":"readme","items":{"totalCount":1},"fields":{"totalCount":2},"owner":{"type":"Organization","login":"github"}}],"totalCount":2}`, + `{"projects":[{"number":2,"url":"a url","shortDescription":"short description","public":true,"closed":false,"title":"","id":"123","readme":"readme","items":{"totalCount":1},"fields":{"totalCount":2},"owner":{"type":"User","login":"monalisa"}},{"number":2,"url":"a url","shortDescription":"short description","public":true,"closed":false,"title":"","id":"123","readme":"readme","items":{"totalCount":1},"fields":{"totalCount":2},"owner":{"type":"Organization","login":"github"}}],"totalCount":2}`, string(b)) } func TestJSONProjectField_FieldType(t *testing.T) { - field := queries.ProjectField{} + field := ProjectField{} field.TypeName = "ProjectV2Field" field.Field.ID = "123" field.Field.Name = "name" - b, err := JSONProjectField(field) + b, err := json.Marshal(field.ExportData(nil)) assert.NoError(t, err) assert.Equal(t, `{"id":"123","name":"name","type":"ProjectV2Field"}`, string(b)) } func TestJSONProjectField_SingleSelectType(t *testing.T) { - field := queries.ProjectField{} + field := ProjectField{} field.TypeName = "ProjectV2SingleSelectField" field.SingleSelectField.ID = "123" field.SingleSelectField.Name = "name" - field.SingleSelectField.Options = []queries.SingleSelectFieldOptions{ + field.SingleSelectField.Options = []SingleSelectFieldOptions{ { ID: "123", Name: "name", @@ -115,35 +120,35 @@ func TestJSONProjectField_SingleSelectType(t *testing.T) { }, } - b, err := JSONProjectField(field) + b, err := json.Marshal(field.ExportData(nil)) assert.NoError(t, err) - assert.Equal(t, `{"id":"123","name":"name","type":"ProjectV2SingleSelectField","options":[{"id":"123","name":"name"},{"id":"456","name":"name2"}]}`, string(b)) + assert.JSONEq(t, `{"id":"123","name":"name","type":"ProjectV2SingleSelectField","options":[{"id":"123","name":"name"},{"id":"456","name":"name2"}]}`, string(b)) } func TestJSONProjectField_ProjectV2IterationField(t *testing.T) { - field := queries.ProjectField{} + field := ProjectField{} field.TypeName = "ProjectV2IterationField" field.IterationField.ID = "123" field.IterationField.Name = "name" - b, err := JSONProjectField(field) + b, err := json.Marshal(field.ExportData(nil)) assert.NoError(t, err) assert.Equal(t, `{"id":"123","name":"name","type":"ProjectV2IterationField"}`, string(b)) } func TestJSONProjectFields(t *testing.T) { - field := queries.ProjectField{} + field := ProjectField{} field.TypeName = "ProjectV2Field" field.Field.ID = "123" field.Field.Name = "name" - field2 := queries.ProjectField{} + field2 := ProjectField{} field2.TypeName = "ProjectV2SingleSelectField" field2.SingleSelectField.ID = "123" field2.SingleSelectField.Name = "name" - field2.SingleSelectField.Options = []queries.SingleSelectFieldOptions{ + field2.SingleSelectField.Options = []SingleSelectFieldOptions{ { ID: "123", Name: "name", @@ -154,72 +159,72 @@ func TestJSONProjectFields(t *testing.T) { }, } - p := &queries.Project{ + p := &Project{ Fields: struct { TotalCount int - Nodes []queries.ProjectField - PageInfo queries.PageInfo + Nodes []ProjectField + PageInfo PageInfo }{ - Nodes: []queries.ProjectField{field, field2}, + Nodes: []ProjectField{field, field2}, TotalCount: 5, }, } - b, err := JSONProjectFields(p) + b, err := json.Marshal(p.Fields.ExportData(nil)) assert.NoError(t, err) - assert.Equal(t, `{"fields":[{"id":"123","name":"name","type":"ProjectV2Field"},{"id":"123","name":"name","type":"ProjectV2SingleSelectField","options":[{"id":"123","name":"name"},{"id":"456","name":"name2"}]}],"totalCount":5}`, string(b)) + assert.JSONEq(t, `{"fields":[{"id":"123","name":"name","type":"ProjectV2Field"},{"id":"123","name":"name","type":"ProjectV2SingleSelectField","options":[{"id":"123","name":"name"},{"id":"456","name":"name2"}]}],"totalCount":5}`, string(b)) } func TestJSONProjectItem_DraftIssue(t *testing.T) { - item := queries.ProjectItem{} + item := ProjectItem{} item.Content.TypeName = "DraftIssue" item.Id = "123" item.Content.DraftIssue.Title = "title" item.Content.DraftIssue.Body = "a body" - b, err := JSONProjectItem(item) + b, err := json.Marshal(item.ExportData(nil)) assert.NoError(t, err) - assert.Equal(t, `{"id":"123","title":"title","body":"a body","type":"DraftIssue"}`, string(b)) + assert.JSONEq(t, `{"id":"123","title":"title","body":"a body","type":"DraftIssue"}`, string(b)) } func TestJSONProjectItem_Issue(t *testing.T) { - item := queries.ProjectItem{} + item := ProjectItem{} item.Content.TypeName = "Issue" item.Id = "123" item.Content.Issue.Title = "title" item.Content.Issue.Body = "a body" item.Content.Issue.URL = "a-url" - b, err := JSONProjectItem(item) + b, err := json.Marshal(item.ExportData(nil)) assert.NoError(t, err) - assert.Equal(t, `{"id":"123","title":"title","body":"a body","type":"Issue","url":"a-url"}`, string(b)) + assert.JSONEq(t, `{"id":"123","title":"title","body":"a body","type":"Issue","url":"a-url"}`, string(b)) } func TestJSONProjectItem_PullRequest(t *testing.T) { - item := queries.ProjectItem{} + item := ProjectItem{} item.Content.TypeName = "PullRequest" item.Id = "123" item.Content.PullRequest.Title = "title" item.Content.PullRequest.Body = "a body" item.Content.PullRequest.URL = "a-url" - b, err := JSONProjectItem(item) + b, err := json.Marshal(item.ExportData(nil)) assert.NoError(t, err) - assert.Equal(t, `{"id":"123","title":"title","body":"a body","type":"PullRequest","url":"a-url"}`, string(b)) + assert.JSONEq(t, `{"id":"123","title":"title","body":"a body","type":"PullRequest","url":"a-url"}`, string(b)) } func TestJSONProjectDetailedItems(t *testing.T) { - p := &queries.Project{} + p := &Project{} p.Items.TotalCount = 5 - p.Items.Nodes = []queries.ProjectItem{ + p.Items.Nodes = []ProjectItem{ { Id: "issueId", - Content: queries.ProjectItemContent{ + Content: ProjectItemContent{ TypeName: "Issue", - Issue: queries.Issue{ + Issue: Issue{ Title: "Issue title", Body: "a body", Number: 1, @@ -234,9 +239,9 @@ func TestJSONProjectDetailedItems(t *testing.T) { }, { Id: "pullRequestId", - Content: queries.ProjectItemContent{ + Content: ProjectItemContent{ TypeName: "PullRequest", - PullRequest: queries.PullRequest{ + PullRequest: PullRequest{ Title: "Pull Request title", Body: "a body", Number: 2, @@ -251,9 +256,10 @@ func TestJSONProjectDetailedItems(t *testing.T) { }, { Id: "draftIssueId", - Content: queries.ProjectItemContent{ + Content: ProjectItemContent{ TypeName: "DraftIssue", - DraftIssue: queries.DraftIssue{ + DraftIssue: DraftIssue{ + ID: "draftIssueId", Title: "Pull Request title", Body: "a body", }, @@ -261,105 +267,100 @@ func TestJSONProjectDetailedItems(t *testing.T) { }, } - out, err := JSONProjectDetailedItems(p) + out, err := json.Marshal(p.DetailedItems()) assert.NoError(t, err) - assert.Equal( + assert.JSONEq( t, - `{"items":[{"content":{"type":"Issue","body":"a body","title":"Issue title","number":1,"repository":"cli/go-gh","url":"issue-url"},"id":"issueId"},{"content":{"type":"PullRequest","body":"a body","title":"Pull Request title","number":2,"repository":"cli/go-gh","url":"pr-url"},"id":"pullRequestId"},{"content":{"type":"DraftIssue","body":"a body","title":"Pull Request title"},"id":"draftIssueId"}],"totalCount":5}`, + `{"items":[{"content":{"type":"Issue","body":"a body","title":"Issue title","number":1,"repository":"cli/go-gh","url":"issue-url"},"id":"issueId"},{"content":{"type":"PullRequest","body":"a body","title":"Pull Request title","number":2,"repository":"cli/go-gh","url":"pr-url"},"id":"pullRequestId"},{"content":{"type":"DraftIssue","body":"a body","title":"Pull Request title","id":"draftIssueId"},"id":"draftIssueId"}],"totalCount":5}`, string(out)) } func TestJSONProjectDraftIssue(t *testing.T) { - item := queries.DraftIssue{} + item := DraftIssue{} item.ID = "123" item.Title = "title" item.Body = "a body" - b, err := JSONProjectDraftIssue(item) + b, err := json.Marshal(item.ExportData(nil)) assert.NoError(t, err) - assert.Equal(t, `{"id":"123","title":"title","body":"a body","type":"DraftIssue"}`, string(b)) + assert.JSONEq(t, `{"id":"123","title":"title","body":"a body","type":"DraftIssue"}`, string(b)) } func TestJSONProjectItem_DraftIssue_ProjectV2ItemFieldIterationValue(t *testing.T) { - iterationField := queries.ProjectField{TypeName: "ProjectV2IterationField"} + iterationField := ProjectField{TypeName: "ProjectV2IterationField"} iterationField.IterationField.ID = "sprint" iterationField.IterationField.Name = "Sprint" - iterationFieldValue := queries.FieldValueNodes{Type: "ProjectV2ItemFieldIterationValue"} + iterationFieldValue := FieldValueNodes{Type: "ProjectV2ItemFieldIterationValue"} iterationFieldValue.ProjectV2ItemFieldIterationValue.Title = "Iteration Title" iterationFieldValue.ProjectV2ItemFieldIterationValue.Field = iterationField - draftIssue := queries.ProjectItem{ + draftIssue := ProjectItem{ Id: "draftIssueId", - Content: queries.ProjectItemContent{ + Content: ProjectItemContent{ TypeName: "DraftIssue", - DraftIssue: queries.DraftIssue{ + DraftIssue: DraftIssue{ + ID: "draftIssueId", Title: "Pull Request title", Body: "a body", }, }, } - draftIssue.FieldValues.Nodes = []queries.FieldValueNodes{ + draftIssue.FieldValues.Nodes = []FieldValueNodes{ iterationFieldValue, } - p := &queries.Project{} - p.Fields.Nodes = []queries.ProjectField{iterationField} + p := &Project{} + p.Fields.Nodes = []ProjectField{iterationField} p.Items.TotalCount = 5 - p.Items.Nodes = []queries.ProjectItem{ + p.Items.Nodes = []ProjectItem{ draftIssue, } - out, err := JSONProjectDetailedItems(p) + out, err := json.Marshal(p.DetailedItems()) assert.NoError(t, err) assert.JSONEq( t, - `{"items":[{"sprint":{"title":"Iteration Title","startDate":"","duration":0},"content":{"type":"DraftIssue","body":"a body","title":"Pull Request title"},"id":"draftIssueId"}],"totalCount":5}`, + `{"items":[{"sprint":{"title":"Iteration Title","startDate":"","duration":0},"content":{"type":"DraftIssue","body":"a body","title":"Pull Request title","id":"draftIssueId"},"id":"draftIssueId"}],"totalCount":5}`, string(out)) } func TestJSONProjectItem_DraftIssue_ProjectV2ItemFieldMilestoneValue(t *testing.T) { - milestoneField := queries.ProjectField{TypeName: "ProjectV2IterationField"} + milestoneField := ProjectField{TypeName: "ProjectV2IterationField"} milestoneField.IterationField.ID = "milestone" milestoneField.IterationField.Name = "Milestone" - milestoneFieldValue := queries.FieldValueNodes{Type: "ProjectV2ItemFieldMilestoneValue"} + milestoneFieldValue := FieldValueNodes{Type: "ProjectV2ItemFieldMilestoneValue"} milestoneFieldValue.ProjectV2ItemFieldMilestoneValue.Milestone.Title = "Milestone Title" milestoneFieldValue.ProjectV2ItemFieldMilestoneValue.Field = milestoneField - draftIssue := queries.ProjectItem{ + draftIssue := ProjectItem{ Id: "draftIssueId", - Content: queries.ProjectItemContent{ + Content: ProjectItemContent{ TypeName: "DraftIssue", - DraftIssue: queries.DraftIssue{ + DraftIssue: DraftIssue{ + ID: "draftIssueId", Title: "Pull Request title", Body: "a body", }, }, } - draftIssue.FieldValues.Nodes = []queries.FieldValueNodes{ + draftIssue.FieldValues.Nodes = []FieldValueNodes{ milestoneFieldValue, } - p := &queries.Project{} - p.Fields.Nodes = []queries.ProjectField{milestoneField} + p := &Project{} + p.Fields.Nodes = []ProjectField{milestoneField} p.Items.TotalCount = 5 - p.Items.Nodes = []queries.ProjectItem{ + p.Items.Nodes = []ProjectItem{ draftIssue, } - out, err := JSONProjectDetailedItems(p) + out, err := json.Marshal(p.DetailedItems()) assert.NoError(t, err) assert.JSONEq( t, - `{"items":[{"milestone":{"title":"Milestone Title","dueOn":"","description":""},"content":{"type":"DraftIssue","body":"a body","title":"Pull Request title"},"id":"draftIssueId"}],"totalCount":5}`, + `{"items":[{"milestone":{"title":"Milestone Title","dueOn":"","description":""},"content":{"type":"DraftIssue","body":"a body","title":"Pull Request title","id":"draftIssueId"},"id":"draftIssueId"}],"totalCount":5}`, string(out)) } - -func TestCamelCase(t *testing.T) { - assert.Equal(t, "camelCase", CamelCase("camelCase")) - assert.Equal(t, "camelCase", CamelCase("CamelCase")) - assert.Equal(t, "c", CamelCase("C")) - assert.Equal(t, "", CamelCase("")) -} diff --git a/pkg/cmd/project/shared/queries/queries.go b/pkg/cmd/project/shared/queries/queries.go index ff68d4583..080a43097 100644 --- a/pkg/cmd/project/shared/queries/queries.go +++ b/pkg/cmd/project/shared/queries/queries.go @@ -29,16 +29,31 @@ func NewClient(httpClient *http.Client, hostname string, ios *iostreams.IOStream } } -func NewTestClient() *Client { +// TestClientOpt is a test option for the test client. +type TestClientOpt func(*Client) + +// WithPrompter is a test option to set the prompter for the test client. +func WithPrompter(p iprompter) TestClientOpt { + return func(c *Client) { + c.prompter = p + } +} + +func NewTestClient(opts ...TestClientOpt) *Client { apiClient := &hostScopedClient{ hostname: "github.com", Client: api.NewClientFromHTTP(http.DefaultClient), } - return &Client{ + c := &Client{ apiClient: apiClient, spinner: false, prompter: nil, } + + for _, o := range opts { + o(c) + } + return c } type iprompter interface { @@ -109,21 +124,27 @@ type Project struct { ShortDescription string Public bool Closed bool - Template bool - Title string - ID string - Readme string - Items struct { + // The Template field is commented out due to https://github.com/cli/cli/issues/8103. + // We released gh v2.34.0 without realizing the Template field does not exist + // on GHES 3.8 and older. This broke all project commands for users targeting GHES 3.8 + // and older. In order to fix this we will no longer query the Template field until + // GHES 3.8 gets deprecated on 2024-03-07. This solution was simpler and quicker + // than adding a feature detection measure to every place this query is used. + // It does have the negative consequence that we have had to remove the + // Template field when outputting projects to JSON using the --format flag supported + // by a number of project commands. See `pkg/cmd/project/shared/format/json.go` for + // implementation. + // Template bool + Title string + ID string + Readme string + Items struct { PageInfo PageInfo TotalCount int Nodes []ProjectItem } `graphql:"items(first: $firstItems, after: $afterItems)"` - Fields struct { - TotalCount int - Nodes []ProjectField - PageInfo PageInfo - } `graphql:"fields(first: $firstFields, after: $afterFields)"` - Owner struct { + Fields ProjectFields `graphql:"fields(first: $firstFields, after: $afterFields)"` + Owner struct { TypeName string `graphql:"__typename"` User struct { Login string @@ -134,6 +155,36 @@ type Project struct { } } +func (p Project) DetailedItems() map[string]interface{} { + return map[string]interface{}{ + "items": serializeProjectWithItems(&p), + "totalCount": p.Items.TotalCount, + } +} + +func (p Project) ExportData(_ []string) map[string]interface{} { + return map[string]interface{}{ + "number": p.Number, + "url": p.URL, + "shortDescription": p.ShortDescription, + "public": p.Public, + "closed": p.Closed, + "title": p.Title, + "id": p.ID, + "readme": p.Readme, + "items": map[string]interface{}{ + "totalCount": p.Items.TotalCount, + }, + "fields": map[string]interface{}{ + "totalCount": p.Fields.TotalCount, + }, + "owner": map[string]interface{}{ + "type": p.OwnerType(), + "login": p.OwnerLogin(), + }, + } +} + func (p Project) OwnerType() string { return p.Owner.TypeName } @@ -145,6 +196,22 @@ func (p Project) OwnerLogin() string { return p.Owner.Organization.Login } +type Projects struct { + Nodes []Project + TotalCount int +} + +func (p Projects) ExportData(_ []string) map[string]interface{} { + v := make([]map[string]interface{}, len(p.Nodes)) + for i := range p.Nodes { + v[i] = p.Nodes[i].ExportData(nil) + } + return map[string]interface{}{ + "projects": v, + "totalCount": p.TotalCount, + } +} + // ProjectItem is a ProjectV2Item GraphQL object https://docs.github.com/en/graphql/reference/objects#projectv2item. type ProjectItem struct { Content ProjectItemContent @@ -274,6 +341,19 @@ type DraftIssue struct { Title string } +func (i DraftIssue) ExportData(_ []string) map[string]interface{} { + v := map[string]interface{}{ + "title": i.Title, + "body": i.Body, + "type": "DraftIssue", + } + // Emulate omitempty. + if i.ID != "" { + v["id"] = i.ID + } + return v +} + type PullRequest struct { Body string Title string @@ -284,6 +364,17 @@ type PullRequest struct { } } +func (pr PullRequest) ExportData(_ []string) map[string]interface{} { + return map[string]interface{}{ + "type": "PullRequest", + "body": pr.Body, + "title": pr.Title, + "number": pr.Number, + "repository": pr.Repository.NameWithOwner, + "url": pr.URL, + } +} + type Issue struct { Body string Title string @@ -294,6 +385,51 @@ type Issue struct { } } +func (i Issue) ExportData(_ []string) map[string]interface{} { + return map[string]interface{}{ + "type": "Issue", + "body": i.Body, + "title": i.Title, + "number": i.Number, + "repository": i.Repository.NameWithOwner, + "url": i.URL, + } +} + +func (p ProjectItem) DetailedItem() exportable { + switch p.Type() { + case "DraftIssue": + return DraftIssue{ + ID: p.Content.DraftIssue.ID, + Body: p.Body(), + Title: p.Title(), + } + + case "Issue": + return Issue{ + Body: p.Body(), + Title: p.Title(), + Number: p.Number(), + Repository: struct{ NameWithOwner string }{ + NameWithOwner: p.Repo(), + }, + URL: p.URL(), + } + + case "PullRequest": + return PullRequest{ + Body: p.Body(), + Title: p.Title(), + Number: p.Number(), + Repository: struct{ NameWithOwner string }{ + NameWithOwner: p.Repo(), + }, + URL: p.URL(), + } + } + return nil +} + // Type is the underlying type of the project item. func (p ProjectItem) Type() string { return p.Content.TypeName @@ -364,6 +500,20 @@ func (p ProjectItem) URL() string { return "" } +func (p ProjectItem) ExportData(_ []string) map[string]interface{} { + v := map[string]interface{}{ + "id": p.ID(), + "title": p.Title(), + "body": p.Body(), + "type": p.Type(), + } + // Emulate omitempty. + if url := p.URL(); url != "" { + v["url"] = url + } + return v +} + // ProjectItems returns the items of a project. If the OwnerType is VIEWER, no login is required. // If limit is 0, the default limit is used. func (c *Client) ProjectItems(o *Owner, number int32, limit int) (*Project, error) { @@ -621,6 +771,13 @@ type SingleSelectFieldOptions struct { Name string } +func (f SingleSelectFieldOptions) ExportData(_ []string) map[string]interface{} { + return map[string]interface{}{ + "id": f.ID, + "name": f.Name, + } +} + func (p ProjectField) Options() []SingleSelectFieldOptions { if p.TypeName == "ProjectV2SingleSelectField" { var options []SingleSelectFieldOptions @@ -635,6 +792,40 @@ func (p ProjectField) Options() []SingleSelectFieldOptions { return nil } +func (p ProjectField) ExportData(_ []string) map[string]interface{} { + v := map[string]interface{}{ + "id": p.ID(), + "name": p.Name(), + "type": p.Type(), + } + // Emulate omitempty + if opts := p.Options(); len(opts) != 0 { + options := make([]map[string]interface{}, len(opts)) + for i, opt := range opts { + options[i] = opt.ExportData(nil) + } + v["options"] = options + } + return v +} + +type ProjectFields struct { + TotalCount int + Nodes []ProjectField + PageInfo PageInfo +} + +func (p ProjectFields) ExportData(_ []string) map[string]interface{} { + fields := make([]map[string]interface{}, len(p.Nodes)) + for i := range p.Nodes { + fields[i] = p.Nodes[i].ExportData(nil) + } + return map[string]interface{}{ + "fields": fields, + "totalCount": p.TotalCount, + } +} + // ProjectFields returns a project with fields. If the OwnerType is VIEWER, no login is required. // If limit is 0, the default limit is used. func (c *Client) ProjectFields(o *Owner, number int32, limit int) (*Project, error) { @@ -991,7 +1182,7 @@ type Owner struct { // NewOwner creates a project Owner // If canPrompt is false, login is required as we cannot prompt for it. // If login is not empty, it is used to lookup the project owner. -// If login is empty empty, interative mode is used to select an owner. +// If login is empty, interactive mode is used to select an owner. // from the current viewer and their organizations func (c *Client) NewOwner(canPrompt bool, login string) (*Owner, error) { if login != "" { @@ -1008,7 +1199,7 @@ func (c *Client) NewOwner(canPrompt bool, login string) (*Owner, error) { } if !canPrompt { - return nil, fmt.Errorf("login is required when not running interactively") + return nil, fmt.Errorf("owner is required when not running interactively") } logins, err := c.userOrgLogins() @@ -1074,17 +1265,17 @@ func (c *Client) NewProject(canPrompt bool, o *Owner, number int32, fields bool) return nil, fmt.Errorf("project number is required when not running interactively") } - projects, _, err := c.Projects(o.Login, o.Type, 0, fields) + projects, err := c.Projects(o.Login, o.Type, 0, fields) if err != nil { return nil, err } - if len(projects) == 0 { + if len(projects.Nodes) == 0 { return nil, fmt.Errorf("no projects found for %s", o.Login) } - options := make([]string, 0, len(projects)) - for _, p := range projects { + options := make([]string, 0, len(projects.Nodes)) + for _, p := range projects.Nodes { title := fmt.Sprintf("%s (#%d)", p.Title, p.Number) options = append(options, title) } @@ -1094,16 +1285,17 @@ func (c *Client) NewProject(canPrompt bool, o *Owner, number int32, fields bool) return nil, err } - return &projects[answerIndex], nil + return &projects.Nodes[answerIndex], nil } // Projects returns all the projects for an Owner. If the OwnerType is VIEWER, no login is required. // If limit is 0, the default limit is used. -func (c *Client) Projects(login string, t OwnerType, limit int, fields bool) ([]Project, int, error) { - projects := make([]Project, 0) +func (c *Client) Projects(login string, t OwnerType, limit int, fields bool) (Projects, error) { + projects := Projects{ + Nodes: make([]Project, 0), + } cursor := (*githubv4.String)(nil) hasNextPage := false - totalCount := 0 if limit == 0 { limit = LimitDefault @@ -1139,44 +1331,120 @@ func (c *Client) Projects(login string, t OwnerType, limit int, fields bool) ([] if t == UserOwner { var query userProjects if err := c.doQuery("UserProjects", &query, variables); err != nil { - return projects, 0, err + return projects, err } - projects = append(projects, query.Owner.Projects.Nodes...) + projects.Nodes = append(projects.Nodes, query.Owner.Projects.Nodes...) hasNextPage = query.Owner.Projects.PageInfo.HasNextPage cursor = &query.Owner.Projects.PageInfo.EndCursor - totalCount = query.Owner.Projects.TotalCount + projects.TotalCount = query.Owner.Projects.TotalCount } else if t == OrgOwner { var query orgProjects if err := c.doQuery("OrgProjects", &query, variables); err != nil { - return projects, 0, err + return projects, err } - projects = append(projects, query.Owner.Projects.Nodes...) + projects.Nodes = append(projects.Nodes, query.Owner.Projects.Nodes...) hasNextPage = query.Owner.Projects.PageInfo.HasNextPage cursor = &query.Owner.Projects.PageInfo.EndCursor - totalCount = query.Owner.Projects.TotalCount + projects.TotalCount = query.Owner.Projects.TotalCount } else if t == ViewerOwner { var query viewerProjects if err := c.doQuery("ViewerProjects", &query, variables); err != nil { - return projects, 0, err + return projects, err } - projects = append(projects, query.Owner.Projects.Nodes...) + projects.Nodes = append(projects.Nodes, query.Owner.Projects.Nodes...) hasNextPage = query.Owner.Projects.PageInfo.HasNextPage cursor = &query.Owner.Projects.PageInfo.EndCursor - totalCount = query.Owner.Projects.TotalCount + projects.TotalCount = query.Owner.Projects.TotalCount } - if !hasNextPage || len(projects) >= limit { - return projects, totalCount, nil + if !hasNextPage || len(projects.Nodes) >= limit { + return projects, nil } - if len(projects)+LimitMax > limit { - first := limit - len(projects) + if len(projects.Nodes)+LimitMax > limit { + first := limit - len(projects.Nodes) variables["first"] = githubv4.Int(first) } variables["after"] = cursor } } +type linkProjectToRepoMutation struct { + LinkProjectV2ToRepository struct { + ClientMutationId string `graphql:"clientMutationId"` + } `graphql:"linkProjectV2ToRepository(input:$input)"` +} + +type linkProjectToTeamMutation struct { + LinkProjectV2ToTeam struct { + ClientMutationId string `graphql:"clientMutationId"` + } `graphql:"linkProjectV2ToTeam(input:$input)"` +} + +type unlinkProjectFromRepoMutation struct { + UnlinkProjectV2FromRepository struct { + ClientMutationId string `graphql:"clientMutationId"` + } `graphql:"unlinkProjectV2FromRepository(input:$input)"` +} + +type unlinkProjectFromTeamMutation struct { + UnlinkProjectV2FromTeam struct { + ClientMutationId string `graphql:"clientMutationId"` + } `graphql:"unlinkProjectV2FromTeam(input:$input)"` +} + +// LinkProjectToRepository links a project to a repository. +func (c *Client) LinkProjectToRepository(projectID string, repoID string) error { + var mutation linkProjectToRepoMutation + variables := map[string]interface{}{ + "input": githubv4.LinkProjectV2ToRepositoryInput{ + ProjectID: githubv4.String(projectID), + RepositoryID: githubv4.ID(repoID), + }, + } + + return c.Mutate("LinkProjectV2ToRepository", &mutation, variables) +} + +// LinkProjectToTeam links a project to a team. +func (c *Client) LinkProjectToTeam(projectID string, teamID string) error { + var mutation linkProjectToTeamMutation + variables := map[string]interface{}{ + "input": githubv4.LinkProjectV2ToTeamInput{ + ProjectID: githubv4.String(projectID), + TeamID: githubv4.ID(teamID), + }, + } + + return c.Mutate("LinkProjectV2ToTeam", &mutation, variables) +} + +// UnlinkProjectFromRepository unlinks a project from a repository. +func (c *Client) UnlinkProjectFromRepository(projectID string, repoID string) error { + var mutation unlinkProjectFromRepoMutation + variables := map[string]interface{}{ + "input": githubv4.UnlinkProjectV2FromRepositoryInput{ + ProjectID: githubv4.String(projectID), + RepositoryID: githubv4.ID(repoID), + }, + } + + return c.Mutate("UnlinkProjectV2FromRepository", &mutation, variables) +} + +// UnlinkProjectFromTeam unlinks a project from a team. +func (c *Client) UnlinkProjectFromTeam(projectID string, teamID string) error { + var mutation unlinkProjectFromTeamMutation + variables := map[string]interface{}{ + "input": githubv4.UnlinkProjectV2FromTeamInput{ + ProjectID: githubv4.String(projectID), + TeamID: githubv4.ID(teamID), + }, + } + + return c.Mutate("UnlinkProjectV2FromTeam", &mutation, variables) +} + func handleError(err error) error { var gerr api.GraphQLError if errors.As(err, &gerr) { @@ -1213,3 +1481,107 @@ func requiredScopesFromServerMessage(msg string) []string { } return scopes } + +func projectFieldValueData(v FieldValueNodes) interface{} { + switch v.Type { + case "ProjectV2ItemFieldDateValue": + return v.ProjectV2ItemFieldDateValue.Date + case "ProjectV2ItemFieldIterationValue": + return map[string]interface{}{ + "title": v.ProjectV2ItemFieldIterationValue.Title, + "startDate": v.ProjectV2ItemFieldIterationValue.StartDate, + "duration": v.ProjectV2ItemFieldIterationValue.Duration, + } + case "ProjectV2ItemFieldNumberValue": + return v.ProjectV2ItemFieldNumberValue.Number + case "ProjectV2ItemFieldSingleSelectValue": + return v.ProjectV2ItemFieldSingleSelectValue.Name + case "ProjectV2ItemFieldTextValue": + return v.ProjectV2ItemFieldTextValue.Text + case "ProjectV2ItemFieldMilestoneValue": + return map[string]interface{}{ + "title": v.ProjectV2ItemFieldMilestoneValue.Milestone.Title, + "description": v.ProjectV2ItemFieldMilestoneValue.Milestone.Description, + "dueOn": v.ProjectV2ItemFieldMilestoneValue.Milestone.DueOn, + } + case "ProjectV2ItemFieldLabelValue": + names := make([]string, 0) + for _, p := range v.ProjectV2ItemFieldLabelValue.Labels.Nodes { + names = append(names, p.Name) + } + return names + case "ProjectV2ItemFieldPullRequestValue": + urls := make([]string, 0) + for _, p := range v.ProjectV2ItemFieldPullRequestValue.PullRequests.Nodes { + urls = append(urls, p.Url) + } + return urls + case "ProjectV2ItemFieldRepositoryValue": + return v.ProjectV2ItemFieldRepositoryValue.Repository.Url + case "ProjectV2ItemFieldUserValue": + logins := make([]string, 0) + for _, p := range v.ProjectV2ItemFieldUserValue.Users.Nodes { + logins = append(logins, p.Login) + } + return logins + case "ProjectV2ItemFieldReviewerValue": + names := make([]string, 0) + for _, p := range v.ProjectV2ItemFieldReviewerValue.Reviewers.Nodes { + if p.Type == "Team" { + names = append(names, p.Team.Name) + } else if p.Type == "User" { + names = append(names, p.User.Login) + } + } + return names + + } + + return nil +} + +// serialize creates a map from field to field values +func serializeProjectWithItems(project *Project) []map[string]interface{} { + fields := make(map[string]string) + + // make a map of fields by ID + for _, f := range project.Fields.Nodes { + fields[f.ID()] = camelCase(f.Name()) + } + itemsSlice := make([]map[string]interface{}, 0) + + // for each value, look up the name by ID + // and set the value to the field value + for _, i := range project.Items.Nodes { + o := make(map[string]interface{}) + o["id"] = i.Id + if projectItem := i.DetailedItem(); projectItem != nil { + o["content"] = projectItem.ExportData(nil) + } else { + o["content"] = nil + } + for _, v := range i.FieldValues.Nodes { + id := v.ID() + value := projectFieldValueData(v) + + o[fields[id]] = value + } + itemsSlice = append(itemsSlice, o) + } + return itemsSlice +} + +// camelCase converts a string to camelCase, which is useful for turning Go field names to JSON keys. +func camelCase(s string) string { + if len(s) == 0 { + return "" + } + if len(s) == 1 { + return strings.ToLower(s) + } + return strings.ToLower(s[0:1]) + s[1:] +} + +type exportable interface { + ExportData([]string) map[string]interface{} +} diff --git a/pkg/cmd/project/shared/queries/queries_test.go b/pkg/cmd/project/shared/queries/queries_test.go index e1cf8c68b..bfdd4d95c 100644 --- a/pkg/cmd/project/shared/queries/queries_test.go +++ b/pkg/cmd/project/shared/queries/queries_test.go @@ -361,7 +361,7 @@ func TestNewProject_nonTTY(t *testing.T) { func TestNewOwner_nonTTY(t *testing.T) { client := NewTestClient() _, err := client.NewOwner(false, "") - assert.EqualError(t, err, "login is required when not running interactively") + assert.EqualError(t, err, "owner is required when not running interactively") } @@ -428,3 +428,10 @@ func TestProjectItems_FieldTitle(t *testing.T) { assert.Equal(t, project.Items.Nodes[0].FieldValues.Nodes[0].ProjectV2ItemFieldIterationValue.Title, "Iteration Title 1") assert.Equal(t, project.Items.Nodes[0].FieldValues.Nodes[1].ProjectV2ItemFieldMilestoneValue.Milestone.Title, "Milestone Title 1") } + +func TestCamelCase(t *testing.T) { + assert.Equal(t, "camelCase", camelCase("camelCase")) + assert.Equal(t, "camelCase", camelCase("CamelCase")) + assert.Equal(t, "c", camelCase("C")) + assert.Equal(t, "", camelCase("")) +} diff --git a/pkg/cmd/project/unlink/unlink.go b/pkg/cmd/project/unlink/unlink.go new file mode 100644 index 000000000..7a75db6d1 --- /dev/null +++ b/pkg/cmd/project/unlink/unlink.go @@ -0,0 +1,233 @@ +package unlink + +import ( + "fmt" + "net/http" + "strconv" + "strings" + + "github.com/MakeNowJust/heredoc" + "github.com/cli/cli/v2/api" + "github.com/cli/cli/v2/internal/gh" + "github.com/cli/cli/v2/internal/ghrepo" + "github.com/cli/cli/v2/pkg/cmd/project/shared/client" + "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" + "github.com/cli/cli/v2/pkg/cmdutil" + "github.com/cli/cli/v2/pkg/iostreams" + "github.com/spf13/cobra" +) + +type unlinkOpts struct { + number int32 + host string + owner string + repo string + team string + projectID string + projectTitle string + repoID string + teamID string +} + +type unlinkConfig struct { + httpClient func() (*http.Client, error) + config func() (gh.Config, error) + client *queries.Client + opts unlinkOpts + io *iostreams.IOStreams +} + +func NewCmdUnlink(f *cmdutil.Factory, runF func(config unlinkConfig) error) *cobra.Command { + opts := unlinkOpts{} + linkCmd := &cobra.Command{ + Short: "Unlink a project from a repository or a team", + Use: "unlink [] [flag]", + Example: heredoc.Doc(` + # unlink monalisa's project 1 from her repository "my_repo" + gh project unlink 1 --owner monalisa --repo my_repo + + # unlink monalisa's organization's project 1 from her team "my_team" + gh project unlink 1 --owner my_organization --team my_team + + # unlink monalisa's project 1 from the repository of current directory if neither --repo nor --team is specified + gh project unlink 1 + `), + RunE: func(cmd *cobra.Command, args []string) error { + client, err := client.New(f) + if err != nil { + return err + } + + if len(args) == 1 { + num, err := strconv.ParseInt(args[0], 10, 32) + if err != nil { + return cmdutil.FlagErrorf("invalid number: %v", args[0]) + } + opts.number = int32(num) + } + + if opts.repo == "" && opts.team == "" { + repo, err := f.BaseRepo() + if err != nil { + return err + } + opts.repo = repo.RepoName() + if opts.owner == "" { + opts.owner = repo.RepoOwner() + } + } + + if err := cmdutil.MutuallyExclusive("specify only one of `--repo` or `--team`", opts.repo != "", opts.team != ""); err != nil { + return err + } + + if err = validateRepoOrTeamFlag(&opts); err != nil { + return err + } + + config := unlinkConfig{ + httpClient: f.HttpClient, + config: f.Config, + client: client, + opts: opts, + io: f.IOStreams, + } + + // allow testing of the command without actually running it + if runF != nil { + return runF(config) + } + return runUnlink(config) + }, + } + + cmdutil.EnableRepoOverride(linkCmd, f) + linkCmd.Flags().StringVar(&opts.owner, "owner", "", "Login of the owner. Use \"@me\" for the current user.") + linkCmd.Flags().StringVarP(&opts.repo, "repo", "R", "", "The repository to be unlinked from this project") + linkCmd.Flags().StringVarP(&opts.team, "team", "T", "", "The team to be unlinked from this project") + + return linkCmd +} + +func validateRepoOrTeamFlag(opts *unlinkOpts) error { + + unlinkedTarget := "" + if opts.repo != "" { + unlinkedTarget = opts.repo + } else if opts.team != "" { + unlinkedTarget = opts.team + } + + if strings.Contains(unlinkedTarget, "/") { + nameArgs := strings.Split(unlinkedTarget, "/") + var host, owner, name string + + if len(nameArgs) == 2 { + owner = nameArgs[0] + name = nameArgs[1] + } else if len(nameArgs) == 3 { + host = nameArgs[0] + owner = nameArgs[1] + name = nameArgs[2] + } else { + if opts.repo != "" { + return fmt.Errorf("expected the \"[HOST/]OWNER/REPO\" or \"REPO\" format, got \"%s\"", unlinkedTarget) + } else if opts.team != "" { + return fmt.Errorf("expected the \"[HOST/]OWNER/TEAM\" or \"TEAM\" format, got \"%s\"", unlinkedTarget) + } + } + + if opts.owner != "" && opts.owner != owner { + return fmt.Errorf("'%s' has different owner from '%s'", unlinkedTarget, opts.owner) + } + + opts.owner = owner + opts.host = host + if opts.repo != "" { + opts.repo = name + } else if opts.team != "" { + opts.team = name + } + } + return nil +} + +func runUnlink(config unlinkConfig) error { + canPrompt := config.io.CanPrompt() + owner, err := config.client.NewOwner(canPrompt, config.opts.owner) + if err != nil { + return err + } + config.opts.owner = owner.Login + + project, err := config.client.NewProject(canPrompt, owner, config.opts.number, false) + if err != nil { + return err + } + config.opts.projectTitle = project.Title + config.opts.projectID = project.ID + if config.opts.number == 0 { + config.opts.number = project.Number + } + + httpClient, err := config.httpClient() + if err != nil { + return err + } + c := api.NewClientFromHTTP(httpClient) + + if config.opts.host == "" { + cfg, err := config.config() + if err != nil { + return err + } + host, _ := cfg.Authentication().DefaultHost() + config.opts.host = host + } + + if config.opts.repo != "" { + return unlinkRepo(c, config) + } else if config.opts.team != "" { + return unlinkTeam(c, config) + } + return nil +} + +func unlinkRepo(c *api.Client, config unlinkConfig) error { + repo, err := api.GitHubRepo(c, ghrepo.NewWithHost(config.opts.owner, config.opts.repo, config.opts.host)) + if err != nil { + return err + } + config.opts.repoID = repo.ID + + err = config.client.UnlinkProjectFromRepository(config.opts.projectID, config.opts.repoID) + if err != nil { + return err + } + + return printResults(config, config.opts.repo) +} + +func unlinkTeam(c *api.Client, config unlinkConfig) error { + team, err := api.OrganizationTeam(c, config.opts.host, config.opts.owner, config.opts.team) + if err != nil { + return err + } + config.opts.teamID = team.ID + + err = config.client.UnlinkProjectFromTeam(config.opts.projectID, config.opts.teamID) + if err != nil { + return err + } + + return printResults(config, config.opts.team) +} + +func printResults(config unlinkConfig, linkedTarget string) error { + if !config.io.IsStdoutTTY() { + return nil + } + + _, err := fmt.Fprintf(config.io.Out, "Unlinked '%s/%s' from project #%d '%s'\n", config.opts.owner, linkedTarget, config.opts.number, config.opts.projectTitle) + return err +} diff --git a/pkg/cmd/project/unlink/unlink_test.go b/pkg/cmd/project/unlink/unlink_test.go new file mode 100644 index 000000000..0846d786a --- /dev/null +++ b/pkg/cmd/project/unlink/unlink_test.go @@ -0,0 +1,406 @@ +package unlink + +import ( + "net/http" + "testing" + + "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" + "github.com/cli/cli/v2/internal/ghrepo" + "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" + "github.com/cli/cli/v2/pkg/cmdutil" + "github.com/cli/cli/v2/pkg/iostreams" + "github.com/google/shlex" + "github.com/stretchr/testify/require" + "gopkg.in/h2non/gock.v1" +) + +func TestNewCmdUnlink(t *testing.T) { + tests := []struct { + name string + cli string + wants unlinkOpts + wantsErr bool + wantsErrMsg string + wantsExporter bool + }{ + { + name: "not-a-number", + cli: "x", + wantsErr: true, + wantsErrMsg: "invalid number: x", + }, + { + name: "specify-repo-and-team", + cli: "--repo my-repo --team my-team", + wantsErr: true, + wantsErrMsg: "specify only one of `--repo` or `--team`", + }, + { + name: "specify-nothing", + cli: "", + wants: unlinkOpts{ + repo: "REPO", + owner: "OWNER", + }, + }, + { + name: "repo", + cli: "--repo my-repo", + wants: unlinkOpts{ + repo: "my-repo", + }, + }, + { + name: "repo-flag-contains-owner", + cli: "--repo monalisa/my-repo", + wants: unlinkOpts{ + owner: "monalisa", + repo: "my-repo", + }, + }, + { + name: "repo-flag-contains-owner-and-host", + cli: "--repo github.com/monalisa/my-repo", + wants: unlinkOpts{ + host: "github.com", + owner: "monalisa", + repo: "my-repo", + }, + }, + { + name: "repo-flag-contains-wrong-format", + cli: "--repo h/e/l/l/o", + wantsErr: true, + wantsErrMsg: "expected the \"[HOST/]OWNER/REPO\" or \"REPO\" format, got \"h/e/l/l/o\"", + }, + { + name: "repo-flag-with-owner-different-from-owner-flag", + cli: "--repo monalisa/my-repo --owner leonardo", + wantsErr: true, + wantsErrMsg: "'monalisa/my-repo' has different owner from 'leonardo'", + }, + { + name: "team", + cli: "--team my-team", + wants: unlinkOpts{ + team: "my-team", + }, + }, + { + name: "team-flag-contains-owner", + cli: "--team my-org/my-team", + wants: unlinkOpts{ + owner: "my-org", + team: "my-team", + }, + }, + { + name: "team-flag-contains-owner-and-host", + cli: "--team github.com/my-org/my-team", + wants: unlinkOpts{ + host: "github.com", + owner: "my-org", + team: "my-team", + }, + }, + { + name: "team-flag-contains-wrong-format", + cli: "--team h/e/l/l/o", + wantsErr: true, + wantsErrMsg: "expected the \"[HOST/]OWNER/TEAM\" or \"TEAM\" format, got \"h/e/l/l/o\"", + }, + { + name: "team-flag-with-owner-different-from-owner-flag", + cli: "--team my-org/my-team --owner her-org", + wantsErr: true, + wantsErrMsg: "'my-org/my-team' has different owner from 'her-org'", + }, + { + name: "number", + cli: "123 --repo my-repo", + wants: unlinkOpts{ + number: 123, + repo: "my-repo", + }, + }, + { + name: "owner-with-repo-flag", + cli: "--repo my-repo --owner monalisa", + wants: unlinkOpts{ + owner: "monalisa", + repo: "my-repo", + }, + }, + { + name: "owner-without-repo-flag", + cli: "--owner monalisa", + wants: unlinkOpts{ + owner: "monalisa", + repo: "REPO", + }, + }, + } + + t.Setenv("GH_TOKEN", "auth-token") + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + ios, _, _, _ := iostreams.Test() + f := &cmdutil.Factory{ + IOStreams: ios, + BaseRepo: func() (ghrepo.Interface, error) { + return ghrepo.New("OWNER", "REPO"), nil + }, + } + + argv, err := shlex.Split(tt.cli) + require.NoError(t, err) + + var gotOpts unlinkOpts + cmd := NewCmdUnlink(f, func(config unlinkConfig) error { + gotOpts = config.opts + return nil + }) + + cmd.SetArgs(argv) + _, err = cmd.ExecuteC() + if tt.wantsErr { + require.Error(t, err) + require.Equal(t, tt.wantsErrMsg, err.Error()) + return + } + require.NoError(t, err) + + require.Equal(t, tt.wants.number, gotOpts.number) + require.Equal(t, tt.wants.owner, gotOpts.owner) + require.Equal(t, tt.wants.repo, gotOpts.repo) + require.Equal(t, tt.wants.team, gotOpts.team) + require.Equal(t, tt.wants.projectID, gotOpts.projectID) + require.Equal(t, tt.wants.repoID, gotOpts.repoID) + require.Equal(t, tt.wants.teamID, gotOpts.teamID) + }) + } +} + +func TestRunUnlink_Repo(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + + // get user ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]string{ + "login": "monalisa", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "id": "an ID", + "login": "monalisa", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"organization"}, + }, + }, + }) + + // get user project ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserProject.*", + "variables": map[string]interface{}{ + "login": "monalisa", + "number": 1, + "firstItems": 0, + "afterItems": nil, + "firstFields": 0, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "projectV2": map[string]string{ + "id": "project-ID", + "title": "first-project", + }, + }, + }, + }) + + // unlink projectV2 from repository + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "mutation UnlinkProjectV2FromRepository.*", + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "unlinkProjectV2FromRepository": map[string]interface{}{}, + }, + }) + + // get repo ID + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`.*query RepositoryInfo.*`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "repository": map[string]interface{}{ + "id": "repo-ID", + }, + }, + }) + + ios, _, stdout, _ := iostreams.Test() + ios.SetStdoutTTY(true) + cfg := unlinkConfig{ + opts: unlinkOpts{ + number: 1, + repo: "my-repo", + owner: "monalisa", + }, + client: queries.NewTestClient(), + httpClient: func() (*http.Client, error) { + return http.DefaultClient, nil + }, + config: func() (gh.Config, error) { + return config.NewBlankConfig(), nil + }, + io: ios, + } + + err := runUnlink(cfg) + require.NoError(t, err) + require.Equal( + t, + "Unlinked 'monalisa/my-repo' from project #1 'first-project'\n", + stdout.String()) +} + +func TestRunUnlink_Team(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + + // get user ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]string{ + "login": "monalisa-org", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "id": "an ID", + "login": "monalisa-org", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"organization"}, + }, + }, + }) + + // get user project ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserProject.*", + "variables": map[string]interface{}{ + "login": "monalisa-org", + "number": 1, + "firstItems": 0, + "afterItems": nil, + "firstFields": 0, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "projectV2": map[string]string{ + "id": "project-ID", + "title": "first-project", + }, + }, + }, + }) + + // unlink projectV2 from team + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "mutation UnlinkProjectV2FromTeam.*", + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "unlinkProjectV2FromTeam": map[string]interface{}{}, + }, + }) + + // get team ID + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`.*query OrganizationTeam.*`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "organization": map[string]interface{}{ + "team": map[string]interface{}{ + "id": "team-ID", + }, + }, + }, + }) + + ios, _, stdout, _ := iostreams.Test() + ios.SetStdoutTTY(true) + cfg := unlinkConfig{ + opts: unlinkOpts{ + number: 1, + team: "my-team", + owner: "monalisa-org", + }, + client: queries.NewTestClient(), + httpClient: func() (*http.Client, error) { + return http.DefaultClient, nil + }, + config: func() (gh.Config, error) { + return config.NewBlankConfig(), nil + }, + io: ios, + } + + err := runUnlink(cfg) + require.NoError(t, err) + require.Equal( + t, + "Unlinked 'monalisa-org/my-team' from project #1 'first-project'\n", + stdout.String()) +} diff --git a/pkg/cmd/project/view/view.go b/pkg/cmd/project/view/view.go index 36eb148e3..3d94b5af3 100644 --- a/pkg/cmd/project/view/view.go +++ b/pkg/cmd/project/view/view.go @@ -7,7 +7,6 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/pkg/cmd/project/shared/client" - "github.com/cli/cli/v2/pkg/cmd/project/shared/format" "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" @@ -16,10 +15,10 @@ import ( ) type viewOpts struct { - web bool - owner string - number int32 - format string + web bool + owner string + number int32 + exporter cmdutil.Exporter } type viewConfig struct { @@ -77,24 +76,12 @@ func NewCmdView(f *cmdutil.Factory, runF func(config viewConfig) error) *cobra.C viewCmd.Flags().StringVar(&opts.owner, "owner", "", "Login of the owner. Use \"@me\" for the current user.") viewCmd.Flags().BoolVarP(&opts.web, "web", "w", false, "Open a project in the browser") - cmdutil.StringEnumFlag(viewCmd, &opts.format, "format", "", "", []string{"json"}, "Output format") + cmdutil.AddFormatFlags(viewCmd, &opts.exporter) return viewCmd } func runView(config viewConfig) error { - if config.opts.web { - url, err := buildURL(config) - if err != nil { - return err - } - - if err := config.URLOpener(url); err != nil { - return err - } - return nil - } - canPrompt := config.io.CanPrompt() owner, err := config.client.NewOwner(canPrompt, config.opts.owner) if err != nil { @@ -106,38 +93,17 @@ func runView(config viewConfig) error { return err } - if config.opts.format == "json" { - return printJSON(config, *project) + if config.opts.web { + return config.URLOpener(project.URL) + } + + if config.opts.exporter != nil { + return config.opts.exporter.Write(config.io, *project) } return printResults(config, project) } -// TODO: support non-github.com hostnames -func buildURL(config viewConfig) (string, error) { - var url string - if config.opts.owner == "@me" { - owner, err := config.client.ViewerLoginName() - if err != nil { - return "", err - } - url = fmt.Sprintf("https://github.com/users/%s/projects/%d", owner, config.opts.number) - } else { - _, ownerType, err := config.client.OwnerIDAndType(config.opts.owner) - if err != nil { - return "", err - } - - if ownerType == queries.UserOwner { - url = fmt.Sprintf("https://github.com/users/%s/projects/%d", config.opts.owner, config.opts.number) - } else { - url = fmt.Sprintf("https://github.com/orgs/%s/projects/%d", config.opts.owner, config.opts.number) - } - } - - return url, nil -} - func printResults(config viewConfig, project *queries.Project) error { var sb strings.Builder sb.WriteString("# Title\n") @@ -191,13 +157,3 @@ func printResults(config viewConfig, project *queries.Project) error { _, err = fmt.Fprint(config.io.Out, out) return err } - -func printJSON(config viewConfig, project queries.Project) error { - b, err := format.JSONProject(project) - if err != nil { - return err - } - - _, err = config.io.Out.Write(b) - return err -} diff --git a/pkg/cmd/project/view/view_test.go b/pkg/cmd/project/view/view_test.go index 35f6dfc9b..557c9732f 100644 --- a/pkg/cmd/project/view/view_test.go +++ b/pkg/cmd/project/view/view_test.go @@ -4,6 +4,7 @@ import ( "bytes" "testing" + "github.com/cli/cli/v2/internal/prompter" "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" @@ -14,11 +15,12 @@ import ( func TestNewCmdview(t *testing.T) { tests := []struct { - name string - cli string - wants viewOpts - wantsErr bool - wantsErrMsg string + name string + cli string + wants viewOpts + wantsErr bool + wantsErrMsg string + wantsExporter bool }{ { name: "not-a-number", @@ -48,11 +50,9 @@ func TestNewCmdview(t *testing.T) { }, }, { - name: "json", - cli: "--format json", - wants: viewOpts{ - format: "json", - }, + name: "json", + cli: "--format json", + wantsExporter: true, }, } @@ -85,41 +85,12 @@ func TestNewCmdview(t *testing.T) { assert.Equal(t, tt.wants.number, gotOpts.number) assert.Equal(t, tt.wants.owner, gotOpts.owner) - assert.Equal(t, tt.wants.format, gotOpts.format) + assert.Equal(t, tt.wantsExporter, gotOpts.exporter != nil) assert.Equal(t, tt.wants.web, gotOpts.web) }) } } -func TestBuildURLViewer(t *testing.T) { - defer gock.Off() - - gock.New("https://api.github.com"). - Post("/graphql"). - Reply(200). - JSON(` - {"data": - {"viewer": - { - "login":"theviewer" - } - } - } - `) - - client := queries.NewTestClient() - - url, err := buildURL(viewConfig{ - opts: viewOpts{ - number: 1, - owner: "@me", - }, - client: client, - }) - assert.NoError(t, err) - assert.Equal(t, "https://github.com/users/theviewer/projects/1", url) -} - func TestRunView_User(t *testing.T) { defer gock.Off() @@ -224,6 +195,7 @@ func TestRunView_Viewer(t *testing.T) { "items": { "totalCount": 10 }, + "url":"https://github.com/orgs/github/projects/8", "readme": null, "fields": { "nodes": [ @@ -295,6 +267,7 @@ func TestRunView_Org(t *testing.T) { "items": { "totalCount": 10 }, + "url":"https://github.com/orgs/github/projects/8", "readme": null, "fields": { "nodes": [ @@ -362,10 +335,11 @@ func TestRunViewWeb_User(t *testing.T) { { "login":"monalisa", "projectV2": { - "number": 1, + "number": 8, "items": { "totalCount": 10 }, + "url":"https://github.com/users/monalisa/projects/8", "readme": null, "fields": { "nodes": [ @@ -382,6 +356,7 @@ func TestRunViewWeb_User(t *testing.T) { client := queries.NewTestClient() buf := bytes.Buffer{} + ios, _, _, _ := iostreams.Test() config := viewConfig{ opts: viewOpts{ owner: "monalisa", @@ -393,6 +368,7 @@ func TestRunViewWeb_User(t *testing.T) { return nil }, client: client, + io: ios, } err := runView(config) @@ -437,10 +413,11 @@ func TestRunViewWeb_Org(t *testing.T) { { "login":"github", "projectV2": { - "number": 1, + "number": 8, "items": { "totalCount": 10 }, + "url": "https://github.com/orgs/github/projects/8", "readme": null, "fields": { "nodes": [ @@ -457,6 +434,7 @@ func TestRunViewWeb_Org(t *testing.T) { client := queries.NewTestClient() buf := bytes.Buffer{} + ios, _, _, _ := iostreams.Test() config := viewConfig{ opts: viewOpts{ owner: "github", @@ -468,6 +446,7 @@ func TestRunViewWeb_Org(t *testing.T) { return nil }, client: client, + io: ios, } err := runView(config) @@ -497,18 +476,24 @@ func TestRunViewWeb_Me(t *testing.T) { gock.New("https://api.github.com"). Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query ViewerProject.*", + "variables": map[string]interface{}{"afterFields": nil, "afterItems": nil, "firstFields": 100, "firstItems": 0, "number": 8}, + }). Reply(200). JSON(` {"data": - {"user": + {"viewer": { "login":"github", "projectV2": { - "number": 1, + "number": 8, "items": { "totalCount": 10 }, "readme": null, + "url": "https://github.com/users/theviewer/projects/8", "fields": { "nodes": [ { @@ -524,6 +509,7 @@ func TestRunViewWeb_Me(t *testing.T) { client := queries.NewTestClient() buf := bytes.Buffer{} + ios, _, _, _ := iostreams.Test() config := viewConfig{ opts: viewOpts{ owner: "@me", @@ -535,9 +521,229 @@ func TestRunViewWeb_Me(t *testing.T) { return nil }, client: client, + io: ios, } err := runView(config) assert.NoError(t, err) assert.Equal(t, "https://github.com/users/theviewer/projects/8", buf.String()) } + +func TestRunViewWeb_TTY(t *testing.T) { + tests := []struct { + name string + setup func(*viewOpts, *testing.T) func() + promptStubs func(*prompter.PrompterMock) + gqlStubs func(*testing.T) + expectedBrowse string + tty bool + }{ + { + name: "Org project --web with tty", + tty: true, + setup: func(vo *viewOpts, t *testing.T) func() { + return func() { + vo.web = true + } + }, + gqlStubs: func(t *testing.T) { + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query ViewerLoginAndOrgs.*", + "variables": map[string]interface{}{ + "after": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "viewer": map[string]interface{}{ + "id": "monalisa-ID", + "login": "monalisa", + "organizations": map[string]interface{}{ + "nodes": []interface{}{ + map[string]interface{}{ + "login": "github", + "viewerCanCreateProjects": true, + }, + }, + }, + }, + }, + }) + + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query OrgProjects.*", + "variables": map[string]interface{}{ + "after": nil, + "afterFields": nil, + "afterItems": nil, + "first": 30, + "firstFields": 100, + "firstItems": 0, + "login": "github", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "organization": map[string]interface{}{ + "login": "github", + "projectsV2": map[string]interface{}{ + "nodes": []interface{}{ + map[string]interface{}{ + "id": "a-project-ID", + "title": "Get it done!", + "url": "https://github.com/orgs/github/projects/1", + "number": 1, + }, + }, + }, + }, + }, + }) + }, + promptStubs: func(pm *prompter.PrompterMock) { + pm.SelectFunc = func(prompt, _ string, opts []string) (int, error) { + switch prompt { + case "Which owner would you like to use?": + return prompter.IndexFor(opts, "github") + case "Which project would you like to use?": + return prompter.IndexFor(opts, "Get it done! (#1)") + default: + return -1, prompter.NoSuchPromptErr(prompt) + } + } + }, + expectedBrowse: "https://github.com/orgs/github/projects/1", + }, + { + name: "User project --web with tty", + tty: true, + setup: func(vo *viewOpts, t *testing.T) func() { + return func() { + vo.web = true + } + }, + gqlStubs: func(t *testing.T) { + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query ViewerLoginAndOrgs.*", + "variables": map[string]interface{}{ + "after": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "viewer": map[string]interface{}{ + "id": "monalisa-ID", + "login": "monalisa", + "organizations": map[string]interface{}{ + "nodes": []interface{}{ + map[string]interface{}{ + "login": "github", + "viewerCanCreateProjects": true, + }, + }, + }, + }, + }, + }) + + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query ViewerProjects.*", + "variables": map[string]interface{}{ + "after": nil, "afterFields": nil, "afterItems": nil, "first": 30, "firstFields": 100, "firstItems": 0, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "viewer": map[string]interface{}{ + "login": "monalisa", + "projectsV2": map[string]interface{}{ + "totalCount": 1, + "nodes": []interface{}{ + map[string]interface{}{ + "id": "a-project-ID", + "number": 1, + "title": "@monalia's first project", + "url": "https://github.com/users/monalisa/projects/1", + }, + }, + }, + }, + }, + }) + }, + promptStubs: func(pm *prompter.PrompterMock) { + pm.SelectFunc = func(prompt, _ string, opts []string) (int, error) { + switch prompt { + case "Which owner would you like to use?": + return prompter.IndexFor(opts, "monalisa") + case "Which project would you like to use?": + return prompter.IndexFor(opts, "@monalia's first project (#1)") + default: + return -1, prompter.NoSuchPromptErr(prompt) + } + } + }, + expectedBrowse: "https://github.com/users/monalisa/projects/1", + }, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + + if tt.gqlStubs != nil { + tt.gqlStubs(t) + } + + pm := &prompter.PrompterMock{} + if tt.promptStubs != nil { + tt.promptStubs(pm) + } + + opts := viewOpts{} + if tt.setup != nil { + tt.setup(&opts, t)() + } + + ios, _, _, _ := iostreams.Test() + ios.SetStdoutTTY(tt.tty) + ios.SetStdinTTY(tt.tty) + ios.SetStderrTTY(tt.tty) + + buf := bytes.Buffer{} + + client := queries.NewTestClient(queries.WithPrompter(pm)) + + config := viewConfig{ + opts: opts, + URLOpener: func(url string) error { + _, err := buf.WriteString(url) + return err + }, + client: client, + io: ios, + } + + err := runView(config) + assert.NoError(t, err) + assert.Equal(t, tt.expectedBrowse, buf.String()) + }) + } +} diff --git a/pkg/cmd/release/create/create.go b/pkg/cmd/release/create/create.go index a5a02fa31..a8e894d2a 100644 --- a/pkg/cmd/release/create/create.go +++ b/pkg/cmd/release/create/create.go @@ -11,7 +11,7 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/git" - "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/internal/text" "github.com/cli/cli/v2/pkg/cmd/release/shared" @@ -29,7 +29,7 @@ type iprompter interface { type CreateOptions struct { IO *iostreams.IOStreams - Config func() (config.Config, error) + Config func() (gh.Config, error) HttpClient func() (*http.Client, error) GitClient *git.Client BaseRepo func() (ghrepo.Interface, error) @@ -59,6 +59,7 @@ type CreateOptions struct { GenerateNotes bool NotesStartTag string VerifyTag bool + NotesFromTag bool } func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Command { @@ -92,10 +93,12 @@ func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Co To create a release from an annotated git tag, first create one locally with git, push the tag to GitHub, then run this command. + Use %[1]s--notes-from-tag%[1]s to automatically generate the release notes + from the annotated git tag. When using automatically generated release notes, a release title will also be automatically generated unless a title was explicitly passed. Additional release notes can be prepended to - automatically generated notes by using the notes parameter. + automatically generated notes by using the %[1]s--notes%[1]s flag. `, "`"), Example: heredoc.Doc(` Interactively create a release @@ -112,6 +115,9 @@ func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Co Use release notes from a file $ gh release create v1.2.3 -F changelog.md + + Don't mark the release as latest + $ gh release create v1.2.3 --latest=false Upload all tarballs in a directory as release assets $ gh release create v1.2.3 ./dist/*.tgz @@ -146,9 +152,17 @@ func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Co return cmdutil.FlagErrorf("tag required when not running interactively") } + if opts.NotesFromTag && (opts.GenerateNotes || opts.NotesStartTag != "") { + return cmdutil.FlagErrorf("using `--notes-from-tag` with `--generate-notes` or `--notes-start-tag` is not supported") + } + + if opts.NotesFromTag && opts.RepoOverride != "" { + return cmdutil.FlagErrorf("using `--notes-from-tag` with `--repo` is not supported") + } + opts.Concurrency = 5 - opts.BodyProvided = cmd.Flags().Changed("notes") || opts.GenerateNotes + opts.BodyProvided = cmd.Flags().Changed("notes") || opts.GenerateNotes || opts.NotesFromTag if notesFile != "" { b, err := cmdutil.ReadFile(notesFile, opts.IO.In) if err != nil { @@ -167,15 +181,16 @@ func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Co cmd.Flags().BoolVarP(&opts.Draft, "draft", "d", false, "Save the release as a draft instead of publishing it") cmd.Flags().BoolVarP(&opts.Prerelease, "prerelease", "p", false, "Mark the release as a prerelease") - cmd.Flags().StringVar(&opts.Target, "target", "", "Target `branch` or full commit SHA (default: main branch)") + cmd.Flags().StringVar(&opts.Target, "target", "", "Target `branch` or full commit SHA (default [main branch])") cmd.Flags().StringVarP(&opts.Name, "title", "t", "", "Release title") cmd.Flags().StringVarP(&opts.Body, "notes", "n", "", "Release notes") cmd.Flags().StringVarP(¬esFile, "notes-file", "F", "", "Read release notes from `file` (use \"-\" to read from standard input)") cmd.Flags().StringVarP(&opts.DiscussionCategory, "discussion-category", "", "", "Start a discussion in the specified category") cmd.Flags().BoolVarP(&opts.GenerateNotes, "generate-notes", "", false, "Automatically generate title and notes for the release") cmd.Flags().StringVar(&opts.NotesStartTag, "notes-start-tag", "", "Tag to use as the starting point for generating release notes") - cmdutil.NilBoolFlag(cmd, &opts.IsLatest, "latest", "", "Mark this release as \"Latest\" (default: automatic based on date and version)") + cmdutil.NilBoolFlag(cmd, &opts.IsLatest, "latest", "", "Mark this release as \"Latest\" (default [automatic based on date and version]). --latest=false to explicitly NOT set as latest") cmd.Flags().BoolVarP(&opts.VerifyTag, "verify-tag", "", false, "Abort in case the git tag doesn't already exist in the remote repository") + cmd.Flags().BoolVarP(&opts.NotesFromTag, "notes-from-tag", "", false, "Automatically generate notes from annotated tag") _ = cmdutil.RegisterBranchCompletionFlags(f.GitClient, cmd, "target") @@ -241,6 +256,12 @@ func createRun(opts *CreateOptions) error { var tagDescription string if opts.RepoOverride == "" { tagDescription, _ = gitTagInfo(opts.GitClient, opts.TagName) + + if opts.NotesFromTag && tagDescription == "" { + return fmt.Errorf("cannot generate release notes from tag %s as it does not exist locally", + opts.TagName) + } + // If there is a local tag with the same name as specified // the user may not want to create a new tag on the remote // as the local one might be annotated or signed. @@ -427,6 +448,13 @@ func createRun(opts *CreateOptions) error { params["generate_release_notes"] = true } } + if opts.NotesFromTag { + if opts.Body == "" { + params["body"] = tagDescription + } else { + params["body"] = fmt.Sprintf("%s\n%s", opts.Body, tagDescription) + } + } hasAssets := len(opts.Assets) > 0 draftWhileUploading := false @@ -474,7 +502,7 @@ func createRun(opts *CreateOptions) error { } if draftWhileUploading { - rel, err := publishRelease(httpClient, newRelease.APIURL, opts.DiscussionCategory) + rel, err := publishRelease(httpClient, newRelease.APIURL, opts.DiscussionCategory, opts.IsLatest) if err != nil { return cleanupDraftRelease(err) } diff --git a/pkg/cmd/release/create/create_test.go b/pkg/cmd/release/create/create_test.go index 69188f593..ed7d99c1e 100644 --- a/pkg/cmd/release/create/create_test.go +++ b/pkg/cmd/release/create/create_test.go @@ -12,6 +12,7 @@ import ( "github.com/cli/cli/v2/git" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/internal/prompter" "github.com/cli/cli/v2/internal/run" @@ -321,6 +322,30 @@ func Test_NewCmdCreate(t *testing.T) { VerifyTag: true, }, }, + { + name: "with --notes-from-tag", + args: "v1.2.3 --notes-from-tag", + isTTY: false, + want: CreateOptions{ + TagName: "v1.2.3", + BodyProvided: true, + Concurrency: 5, + Assets: []*shared.AssetForUpload(nil), + NotesFromTag: true, + }, + }, + { + name: "with --notes-from-tag and --generate-notes", + args: "v1.2.3 --notes-from-tag --generate-notes", + isTTY: false, + wantErr: "using `--notes-from-tag` with `--generate-notes` or `--notes-start-tag` is not supported", + }, + { + name: "with --notes-from-tag and --notes-start-tag", + args: "v1.2.3 --notes-from-tag --notes-start-tag v1.2.3", + isTTY: false, + wantErr: "using `--notes-from-tag` with `--generate-notes` or `--notes-start-tag` is not supported", + }, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { @@ -375,6 +400,7 @@ func Test_NewCmdCreate(t *testing.T) { assert.Equal(t, tt.want.NotesStartTag, opts.NotesStartTag) assert.Equal(t, tt.want.IsLatest, opts.IsLatest) assert.Equal(t, tt.want.VerifyTag, opts.VerifyTag) + assert.Equal(t, tt.want.NotesFromTag, opts.NotesFromTag) require.Equal(t, len(tt.want.Assets), len(opts.Assets)) for i := range tt.want.Assets { @@ -391,6 +417,7 @@ func Test_createRun(t *testing.T) { isTTY bool opts CreateOptions httpStubs func(t *testing.T, reg *httpmock.Registry) + runStubs func(rs *run.CommandStubber) wantErr string wantStdout string wantStderr string @@ -405,6 +432,9 @@ func Test_createRun(t *testing.T) { BodyProvided: true, Target: "", }, + runStubs: func(rs *run.CommandStubber) { + rs.Register(`git tag --list`, 0, "") + }, httpStubs: func(t *testing.T, reg *httpmock.Registry) { reg.Register(httpmock.REST("POST", "repos/OWNER/REPO/releases"), httpmock.RESTPayload(201, `{ "url": "https://api.github.com/releases/123", @@ -434,6 +464,9 @@ func Test_createRun(t *testing.T) { Target: "", DiscussionCategory: "General", }, + runStubs: func(rs *run.CommandStubber) { + rs.Register(`git tag --list`, 0, "") + }, httpStubs: func(t *testing.T, reg *httpmock.Registry) { reg.Register(httpmock.REST("POST", "repos/OWNER/REPO/releases"), httpmock.RESTPayload(201, `{ "url": "https://api.github.com/releases/123", @@ -463,6 +496,9 @@ func Test_createRun(t *testing.T) { BodyProvided: true, Target: "main", }, + runStubs: func(rs *run.CommandStubber) { + rs.Register(`git tag --list`, 0, "") + }, httpStubs: func(t *testing.T, reg *httpmock.Registry) { reg.Register(httpmock.REST("POST", "repos/OWNER/REPO/releases"), httpmock.RESTPayload(201, `{ "url": "https://api.github.com/releases/123", @@ -491,6 +527,9 @@ func Test_createRun(t *testing.T) { Draft: true, Target: "", }, + runStubs: func(rs *run.CommandStubber) { + rs.Register(`git tag --list`, 0, "") + }, httpStubs: func(t *testing.T, reg *httpmock.Registry) { reg.Register(httpmock.REST("POST", "repos/OWNER/REPO/releases"), httpmock.RESTPayload(201, `{ "url": "https://api.github.com/releases/123", @@ -519,6 +558,9 @@ func Test_createRun(t *testing.T) { BodyProvided: true, GenerateNotes: false, }, + runStubs: func(rs *run.CommandStubber) { + rs.Register(`git tag --list`, 0, "") + }, httpStubs: func(t *testing.T, reg *httpmock.Registry) { reg.Register(httpmock.REST("POST", "repos/OWNER/REPO/releases"), httpmock.RESTPayload(201, `{ "url": "https://api.github.com/releases/123", @@ -547,6 +589,9 @@ func Test_createRun(t *testing.T) { BodyProvided: true, GenerateNotes: true, }, + runStubs: func(rs *run.CommandStubber) { + rs.Register(`git tag --list`, 0, "") + }, httpStubs: func(t *testing.T, reg *httpmock.Registry) { reg.Register(httpmock.REST("POST", "repos/OWNER/REPO/releases"), httpmock.RESTPayload(201, `{ "url": "https://api.github.com/releases/123", @@ -576,6 +621,9 @@ func Test_createRun(t *testing.T) { GenerateNotes: true, NotesStartTag: "v1.1.0", }, + runStubs: func(rs *run.CommandStubber) { + rs.Register(`git tag --list`, 0, "") + }, httpStubs: func(t *testing.T, reg *httpmock.Registry) { reg.Register(httpmock.REST("POST", "repos/OWNER/REPO/releases/generate-notes"), httpmock.RESTPayload(200, `{ @@ -616,6 +664,9 @@ func Test_createRun(t *testing.T) { GenerateNotes: true, NotesStartTag: "v1.1.0", }, + runStubs: func(rs *run.CommandStubber) { + rs.Register(`git tag --list`, 0, "") + }, httpStubs: func(t *testing.T, reg *httpmock.Registry) { reg.Register(httpmock.REST("POST", "repos/OWNER/REPO/releases/generate-notes"), httpmock.RESTPayload(200, `{ @@ -664,6 +715,9 @@ func Test_createRun(t *testing.T) { }, Concurrency: 1, }, + runStubs: func(rs *run.CommandStubber) { + rs.Register(`git tag --list`, 0, "") + }, httpStubs: func(t *testing.T, reg *httpmock.Registry) { reg.Register(httpmock.REST("HEAD", "repos/OWNER/REPO/releases/tags/v1.2.3"), httpmock.StatusStringResponse(404, ``)) reg.Register(httpmock.REST("POST", "repos/OWNER/REPO/releases"), httpmock.RESTPayload(201, `{ @@ -701,6 +755,69 @@ func Test_createRun(t *testing.T) { wantStdout: "https://github.com/OWNER/REPO/releases/tag/v1.2.3-final\n", wantStderr: ``, }, + { + name: "publish after uploading files, but do not mark as latest", + isTTY: true, + opts: CreateOptions{ + TagName: "v1.2.3", + Name: "", + Body: "", + BodyProvided: true, + Draft: false, + IsLatest: boolPtr(false), + Target: "", + Assets: []*shared.AssetForUpload{ + { + Name: "ball.tgz", + Open: func() (io.ReadCloser, error) { + return io.NopCloser(bytes.NewBufferString(`TARBALL`)), nil + }, + }, + }, + Concurrency: 1, + }, + runStubs: func(rs *run.CommandStubber) { + rs.Register(`git tag --list`, 0, "") + }, + httpStubs: func(t *testing.T, reg *httpmock.Registry) { + reg.Register(httpmock.REST("HEAD", "repos/OWNER/REPO/releases/tags/v1.2.3"), httpmock.StatusStringResponse(404, ``)) + reg.Register(httpmock.REST("POST", "repos/OWNER/REPO/releases"), httpmock.RESTPayload(201, `{ + "url": "https://api.github.com/releases/123", + "upload_url": "https://api.github.com/assets/upload", + "html_url": "https://github.com/OWNER/REPO/releases/tag/v1.2.3" + }`, func(params map[string]interface{}) { + assert.Equal(t, map[string]interface{}{ + "tag_name": "v1.2.3", + "draft": true, + "prerelease": false, + "make_latest": "false", + }, params) + })) + reg.Register(httpmock.REST("POST", "assets/upload"), func(req *http.Request) (*http.Response, error) { + q := req.URL.Query() + assert.Equal(t, "ball.tgz", q.Get("name")) + assert.Equal(t, "", q.Get("label")) + return &http.Response{ + StatusCode: 201, + Request: req, + Body: io.NopCloser(bytes.NewBufferString(`{}`)), + Header: map[string][]string{ + "Content-Type": {"application/json"}, + }, + }, nil + }) + reg.Register(httpmock.REST("PATCH", "releases/123"), httpmock.RESTPayload(201, `{ + "html_url": "https://github.com/OWNER/REPO/releases/tag/v1.2.3-final" + }`, func(params map[string]interface{}) { + assert.Equal(t, map[string]interface{}{ + "draft": false, + "make_latest": "false", + }, params) + })) + }, + wantStdout: "https://github.com/OWNER/REPO/releases/tag/v1.2.3-final\n", + wantStderr: ``, + }, { name: "upload files but release already exists", isTTY: true, @@ -721,6 +838,9 @@ func Test_createRun(t *testing.T) { }, Concurrency: 1, }, + runStubs: func(rs *run.CommandStubber) { + rs.Register(`git tag --list`, 0, "") + }, httpStubs: func(t *testing.T, reg *httpmock.Registry) { reg.Register(httpmock.REST("HEAD", "repos/OWNER/REPO/releases/tags/v1.2.3"), httpmock.StatusStringResponse(200, ``)) }, @@ -748,6 +868,9 @@ func Test_createRun(t *testing.T) { }, Concurrency: 1, }, + runStubs: func(rs *run.CommandStubber) { + rs.Register(`git tag --list`, 0, "") + }, httpStubs: func(t *testing.T, reg *httpmock.Registry) { reg.Register(httpmock.REST("HEAD", "repos/OWNER/REPO/releases/tags/v1.2.3"), httpmock.StatusStringResponse(404, ``)) reg.Register(httpmock.REST("POST", "repos/OWNER/REPO/releases"), httpmock.StatusStringResponse(201, `{ @@ -782,6 +905,9 @@ func Test_createRun(t *testing.T) { }, Concurrency: 1, }, + runStubs: func(rs *run.CommandStubber) { + rs.Register(`git tag --list`, 0, "") + }, httpStubs: func(t *testing.T, reg *httpmock.Registry) { reg.Register(httpmock.REST("HEAD", "repos/OWNER/REPO/releases/tags/v1.2.3"), httpmock.StatusStringResponse(404, ``)) reg.Register(httpmock.REST("POST", "repos/OWNER/REPO/releases"), httpmock.StatusStringResponse(201, `{ @@ -817,6 +943,9 @@ func Test_createRun(t *testing.T) { }, Concurrency: 1, }, + runStubs: func(rs *run.CommandStubber) { + rs.Register(`git tag --list`, 0, "") + }, httpStubs: func(t *testing.T, reg *httpmock.Registry) { reg.Register(httpmock.REST("HEAD", "repos/OWNER/REPO/releases/tags/v1.2.3"), httpmock.StatusStringResponse(200, ``)) }, @@ -845,6 +974,9 @@ func Test_createRun(t *testing.T) { DiscussionCategory: "general", Concurrency: 1, }, + runStubs: func(rs *run.CommandStubber) { + rs.Register(`git tag --list`, 0, "") + }, httpStubs: func(t *testing.T, reg *httpmock.Registry) { reg.Register(httpmock.REST("HEAD", "repos/OWNER/REPO/releases/tags/v1.2.3"), httpmock.StatusStringResponse(404, ``)) reg.Register(httpmock.REST("POST", "repos/OWNER/REPO/releases"), httpmock.RESTPayload(201, `{ @@ -884,6 +1016,94 @@ func Test_createRun(t *testing.T) { wantStdout: "https://github.com/OWNER/REPO/releases/tag/v1.2.3-final\n", wantStderr: ``, }, + { + name: "with generate notes from tag", + isTTY: false, + opts: CreateOptions{ + TagName: "v1.2.3", + BodyProvided: true, + Concurrency: 5, + Assets: []*shared.AssetForUpload(nil), + NotesFromTag: true, + }, + runStubs: func(rs *run.CommandStubber) { + rs.Register(`git tag --list`, 0, "some tag message") + }, + httpStubs: func(t *testing.T, reg *httpmock.Registry) { + reg.Register( + httpmock.GraphQL("RepositoryFindRef"), + httpmock.StringResponse(`{"data":{"repository":{"ref": {"id": "tag id"}}}}`), + ) + reg.Register( + httpmock.REST("POST", "repos/OWNER/REPO/releases"), + httpmock.RESTPayload(201, `{ + "url": "https://api.github.com/releases/123", + "upload_url": "https://api.github.com/assets/upload", + "html_url": "https://github.com/OWNER/REPO/releases/tag/v1.2.3" + }`, func(payload map[string]interface{}) { + assert.Equal(t, map[string]interface{}{ + "tag_name": "v1.2.3", + "draft": false, + "prerelease": false, + "body": "some tag message", + }, payload) + })) + }, + wantStdout: "https://github.com/OWNER/REPO/releases/tag/v1.2.3\n", + wantStderr: "", + }, + { + name: "with generate notes from tag and notes provided", + isTTY: false, + opts: CreateOptions{ + TagName: "v1.2.3", + Body: "some notes here", + BodyProvided: true, + Concurrency: 5, + Assets: []*shared.AssetForUpload(nil), + NotesFromTag: true, + }, + runStubs: func(rs *run.CommandStubber) { + rs.Register(`git tag --list`, 0, "some tag message") + }, + httpStubs: func(t *testing.T, reg *httpmock.Registry) { + reg.Register( + httpmock.GraphQL("RepositoryFindRef"), + httpmock.StringResponse(`{"data":{"repository":{"ref": {"id": "tag id"}}}}`), + ) + reg.Register( + httpmock.REST("POST", "repos/OWNER/REPO/releases"), + httpmock.RESTPayload(201, `{ + "url": "https://api.github.com/releases/123", + "upload_url": "https://api.github.com/assets/upload", + "html_url": "https://github.com/OWNER/REPO/releases/tag/v1.2.3" + }`, func(payload map[string]interface{}) { + assert.Equal(t, map[string]interface{}{ + "tag_name": "v1.2.3", + "draft": false, + "prerelease": false, + "body": "some notes here\nsome tag message", + }, payload) + })) + }, + wantStdout: "https://github.com/OWNER/REPO/releases/tag/v1.2.3\n", + wantStderr: "", + }, + { + name: "with generate notes from tag and tag does not exist", + isTTY: false, + opts: CreateOptions{ + TagName: "v1.2.3", + BodyProvided: true, + Concurrency: 5, + Assets: []*shared.AssetForUpload(nil), + NotesFromTag: true, + }, + runStubs: func(rs *run.CommandStubber) { + rs.Register(`git tag --list`, 0, "") + }, + wantErr: "cannot generate release notes from tag v1.2.3 as it does not exist locally", + }, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { @@ -908,6 +1128,12 @@ func Test_createRun(t *testing.T) { tt.opts.GitClient = &git.Client{GitPath: "some/path/git"} + rs, teardown := run.Stub() + defer teardown(t) + if tt.runStubs != nil { + tt.runStubs(rs) + } + err := createRun(&tt.opts) if tt.wantErr != "" { require.EqualError(t, err, tt.wantErr) @@ -1451,34 +1677,34 @@ func Test_createRun_interactive(t *testing.T) { }, } for _, tt := range tests { - ios, _, stdout, stderr := iostreams.Test() - ios.SetStdoutTTY(true) - ios.SetStdinTTY(true) - ios.SetStderrTTY(true) - tt.opts.IO = ios - - reg := &httpmock.Registry{} - defer reg.Verify(t) - tt.httpStubs(reg) - tt.opts.HttpClient = func() (*http.Client, error) { - return &http.Client{Transport: reg}, nil - } - - tt.opts.BaseRepo = func() (ghrepo.Interface, error) { - return ghrepo.FromFullName("OWNER/REPO") - } - - tt.opts.Config = func() (config.Config, error) { - return config.NewBlankConfig(), nil - } - - tt.opts.Edit = func(_, _, val string, _ io.Reader, _, _ io.Writer) (string, error) { - return val, nil - } - - tt.opts.GitClient = &git.Client{GitPath: "some/path/git"} - t.Run(tt.name, func(t *testing.T) { + ios, _, stdout, stderr := iostreams.Test() + ios.SetStdoutTTY(true) + ios.SetStdinTTY(true) + ios.SetStderrTTY(true) + tt.opts.IO = ios + + reg := &httpmock.Registry{} + defer reg.Verify(t) + tt.httpStubs(reg) + tt.opts.HttpClient = func() (*http.Client, error) { + return &http.Client{Transport: reg}, nil + } + + tt.opts.BaseRepo = func() (ghrepo.Interface, error) { + return ghrepo.FromFullName("OWNER/REPO") + } + + tt.opts.Config = func() (gh.Config, error) { + return config.NewBlankConfig(), nil + } + + tt.opts.Edit = func(_, _, val string, _ io.Reader, _, _ io.Writer) (string, error) { + return val, nil + } + + tt.opts.GitClient = &git.Client{GitPath: "some/path/git"} + pm := prompter.NewMockPrompter(t) if tt.prompterStubs != nil { tt.prompterStubs(t, pm) diff --git a/pkg/cmd/release/create/http.go b/pkg/cmd/release/create/http.go index f970d46f1..84e95710f 100644 --- a/pkg/cmd/release/create/http.go +++ b/pkg/cmd/release/create/http.go @@ -189,12 +189,16 @@ func createRelease(httpClient *http.Client, repo ghrepo.Interface, params map[st return &newRelease, err } -func publishRelease(httpClient *http.Client, releaseURL string, discussionCategory string) (*shared.Release, error) { +func publishRelease(httpClient *http.Client, releaseURL string, discussionCategory string, isLatest *bool) (*shared.Release, error) { params := map[string]interface{}{"draft": false} if discussionCategory != "" { params["discussion_category_name"] = discussionCategory } + if isLatest != nil { + params["make_latest"] = fmt.Sprintf("%v", *isLatest) + } + bodyBytes, err := json.Marshal(params) if err != nil { return nil, err diff --git a/pkg/cmd/release/delete/delete.go b/pkg/cmd/release/delete/delete.go index 94b09cfcb..622b18893 100644 --- a/pkg/cmd/release/delete/delete.go +++ b/pkg/cmd/release/delete/delete.go @@ -6,6 +6,7 @@ import ( "net/http" "github.com/cli/cli/v2/api" + "github.com/cli/cli/v2/git" "github.com/cli/cli/v2/internal/ghinstance" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/pkg/cmd/release/shared" @@ -19,10 +20,12 @@ type iprompter interface { } type DeleteOptions struct { - HttpClient func() (*http.Client, error) - IO *iostreams.IOStreams - BaseRepo func() (ghrepo.Interface, error) - Prompter iprompter + HttpClient func() (*http.Client, error) + GitClient *git.Client + IO *iostreams.IOStreams + BaseRepo func() (ghrepo.Interface, error) + RepoOverride string + Prompter iprompter TagName string SkipConfirm bool @@ -33,6 +36,7 @@ func NewCmdDelete(f *cmdutil.Factory, runF func(*DeleteOptions) error) *cobra.Co opts := &DeleteOptions{ IO: f.IOStreams, HttpClient: f.HttpClient, + GitClient: f.GitClient, Prompter: f.Prompter, } @@ -43,6 +47,7 @@ func NewCmdDelete(f *cmdutil.Factory, runF func(*DeleteOptions) error) *cobra.Co RunE: func(cmd *cobra.Command, args []string) error { // support `-R, --repo` override opts.BaseRepo = f.BaseRepo + opts.RepoOverride, _ = cmd.Flags().GetString("repo") opts.TagName = args[0] @@ -93,12 +98,13 @@ func deleteRun(opts *DeleteOptions) error { } var cleanupMessage string - mustCleanupTag := opts.CleanupTag - if mustCleanupTag { - err = deleteTag(httpClient, baseRepo, release.TagName) - if err != nil { + if opts.CleanupTag { + if err := deleteTag(httpClient, baseRepo, release.TagName); err != nil { return err } + if opts.RepoOverride == "" { + _ = opts.GitClient.DeleteLocalTag(context.Background(), release.TagName) + } cleanupMessage = " and tag" } @@ -108,7 +114,7 @@ func deleteRun(opts *DeleteOptions) error { iofmt := opts.IO.ColorScheme() fmt.Fprintf(opts.IO.ErrOut, "%s Deleted release%s %s\n", iofmt.SuccessIconWithColor(iofmt.Red), cleanupMessage, release.TagName) - if !release.IsDraft && !mustCleanupTag { + if !release.IsDraft && !opts.CleanupTag { fmt.Fprintf(opts.IO.ErrOut, "%s Note that the %s git tag still remains in the repository\n", iofmt.WarningIcon(), release.TagName) } diff --git a/pkg/cmd/release/delete/delete_test.go b/pkg/cmd/release/delete/delete_test.go index c0c43f990..2787f247b 100644 --- a/pkg/cmd/release/delete/delete_test.go +++ b/pkg/cmd/release/delete/delete_test.go @@ -7,8 +7,10 @@ import ( "testing" "github.com/MakeNowJust/heredoc" + "github.com/cli/cli/v2/git" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/internal/prompter" + "github.com/cli/cli/v2/internal/run" "github.com/cli/cli/v2/pkg/cmd/release/shared" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/httpmock" @@ -110,6 +112,7 @@ func Test_deleteRun(t *testing.T) { isTTY bool opts DeleteOptions prompterStubs func(*prompter.PrompterMock) + runStubs func(*run.CommandStubber) wantErr string wantStdout string wantStderr string @@ -164,6 +167,9 @@ func Test_deleteRun(t *testing.T) { SkipConfirm: true, CleanupTag: true, }, + runStubs: func(rs *run.CommandStubber) { + rs.Register(`git tag -d v1.2.3`, 0, "") + }, wantStdout: ``, wantStderr: heredoc.Doc(` ✓ Deleted release and tag v1.2.3 @@ -177,6 +183,9 @@ func Test_deleteRun(t *testing.T) { SkipConfirm: false, CleanupTag: true, }, + runStubs: func(rs *run.CommandStubber) { + rs.Register(`git tag -d v1.2.3`, 0, "") + }, wantStdout: ``, wantStderr: ``, }, @@ -203,6 +212,12 @@ func Test_deleteRun(t *testing.T) { fakeHTTP.Register(httpmock.REST("DELETE", "repos/OWNER/REPO/releases/23456"), httpmock.StatusStringResponse(204, "")) fakeHTTP.Register(httpmock.REST("DELETE", "repos/OWNER/REPO/git/refs/tags/v1.2.3"), httpmock.StatusStringResponse(204, "")) + rs, teardown := run.Stub() + defer teardown(t) + if tt.runStubs != nil { + tt.runStubs(rs) + } + tt.opts.IO = ios tt.opts.Prompter = pm tt.opts.HttpClient = func() (*http.Client, error) { @@ -211,6 +226,7 @@ func Test_deleteRun(t *testing.T) { tt.opts.BaseRepo = func() (ghrepo.Interface, error) { return ghrepo.FromFullName("OWNER/REPO") } + tt.opts.GitClient = &git.Client{GitPath: "some/path/git"} err := deleteRun(&tt.opts) if tt.wantErr != "" { diff --git a/pkg/cmd/release/download/download.go b/pkg/cmd/release/download/download.go index bab6bd19b..bb0df7243 100644 --- a/pkg/cmd/release/download/download.go +++ b/pkg/cmd/release/download/download.go @@ -10,6 +10,9 @@ import ( "os" "path/filepath" "regexp" + "runtime" + "slices" + "strings" "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/api" @@ -46,12 +49,13 @@ func NewCmdDownload(f *cmdutil.Factory, runF func(*DownloadOptions) error) *cobr cmd := &cobra.Command{ Use: "download []", Short: "Download release assets", - Long: heredoc.Doc(` + Long: heredoc.Docf(` Download assets from a GitHub release. Without an explicit tag name argument, assets are downloaded from the - latest release in the project. In this case, '--pattern' is required. - `), + latest release in the project. In this case, %[1]s--pattern%[1]s or %[1]s--archive%[1]s + is required. + `, "`"), Example: heredoc.Doc(` # download all assets from a specific release $ gh release download v1.2.3 @@ -173,6 +177,12 @@ func downloadRun(opts *DownloadOptions) error { if len(opts.FilePatterns) > 0 && !matchAny(opts.FilePatterns, a.Name) { continue } + // Note that if we need to start checking for reserved filenames on + // more operating systems we should move to using a build constraints + // pattern rather than checking the operating system at runtime. + if runtime.GOOS == "windows" && isWindowsReservedFilename(a.Name) { + return fmt.Errorf("unable to download release due to asset with reserved filename %q", a.Name) + } toDownload = append(toDownload, a) } } @@ -390,3 +400,23 @@ func (w destinationWriter) Copy(name string, r io.Reader) (copyErr error) { _, copyErr = io.Copy(f, r) return } + +func isWindowsReservedFilename(filename string) bool { + // Windows terminals should prevent the creation of these files + // but that behavior is not enforced across terminals. Prevent + // the user from downloading files with these reserved names as + // they represent an exploit vector for bad actors. + // Reserved filenames defined at: + // https://learn.microsoft.com/en-us/windows/win32/fileio/naming-a-file#win32-file-namespaces + reservedFilenames := []string{"CON", "PRN", "AUX", "NUL", "COM0", + "COM1", "COM2", "COM3", "COM4", "COM5", + "COM6", "COM7", "COM8", "COM9", "COM¹", + "COM²", "COM³", "LPT0", "LPT1", "LPT2", + "LPT3", "LPT4", "LPT5", "LPT6", "LPT7", + "LPT8", "LPT9", "LPT¹", "LPT²", "LPT³"} + + // Normalize type case and remove file type extension from filename. + filename = strings.ToUpper(strings.Split(filename, ".")[0]) + + return slices.Contains(reservedFilenames, filename) +} diff --git a/pkg/cmd/release/download/download_test.go b/pkg/cmd/release/download/download_test.go index 782056314..78709dd57 100644 --- a/pkg/cmd/release/download/download_test.go +++ b/pkg/cmd/release/download/download_test.go @@ -6,6 +6,7 @@ import ( "net/http" "os" "path/filepath" + "runtime" "testing" "github.com/cli/cli/v2/internal/ghrepo" @@ -279,7 +280,7 @@ func Test_downloadRun(t *testing.T) { }, }, { - name: "download single asset from matching patter into output option", + name: "download single asset from matching pattern into output option", isTTY: true, opts: DownloadOptions{ OutputFile: "./tmp/my-tarball.tgz", @@ -295,7 +296,7 @@ func Test_downloadRun(t *testing.T) { }, }, { - name: "download single asset from matching patter into output 'stdout´", + name: "download single asset from matching pattern into output 'stdout´", isTTY: true, opts: DownloadOptions{ OutputFile: "-", @@ -553,6 +554,87 @@ func Test_downloadRun_cloberAndSkip(t *testing.T) { } } +func Test_downloadRun_windowsReservedFilename(t *testing.T) { + if runtime.GOOS != "windows" { + t.SkipNow() + } + + tagName := "v1.2.3" + + ios, _, _, _ := iostreams.Test() + + reg := &httpmock.Registry{} + defer reg.Verify(t) + + shared.StubFetchRelease(t, reg, "OWNER", "REPO", tagName, `{ + "assets": [ + { "name": "valid-asset.zip", "size": 12, + "url": "https://api.github.com/assets/1234" }, + { "name": "valid-asset-2.zip", "size": 34, + "url": "https://api.github.com/assets/3456" }, + { "name": "CON.tgz", "size": 56, + "url": "https://api.github.com/assets/5678" } + ], + "tarball_url": "https://api.github.com/repos/OWNER/REPO/tarball/v1.2.3", + "zipball_url": "https://api.github.com/repos/OWNER/REPO/zipball/v1.2.3" + }`) + + opts := &DownloadOptions{ + IO: ios, + HttpClient: func() (*http.Client, error) { + return &http.Client{Transport: reg}, nil + }, + BaseRepo: func() (ghrepo.Interface, error) { + return ghrepo.FromFullName("OWNER/REPO") + }, + TagName: tagName, + } + + err := downloadRun(opts) + + assert.EqualError(t, err, `unable to download release due to asset with reserved filename "CON.tgz"`) +} + +func TestIsWindowsReservedFilename(t *testing.T) { + tests := []struct { + name string + filename string + want bool + }{ + { + name: "non-reserved filename", + filename: "test", + want: false, + }, + { + name: "non-reserved filename with file type extension", + filename: "test.tar.gz", + want: false, + }, + { + name: "reserved filename", + filename: "NUL", + want: true, + }, + { + name: "reserved filename with file type extension", + filename: "NUL.tar.gz", + want: true, + }, + { + name: "reserved filename with mixed type case", + filename: "NuL", + want: true, + }, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + assert.Equal(t, tt.want, isWindowsReservedFilename(tt.filename)) + }) + } +} + func listFiles(dir string) ([]string, error) { var files []string err := filepath.Walk(dir, func(p string, f os.FileInfo, err error) error { diff --git a/pkg/cmd/release/edit/edit.go b/pkg/cmd/release/edit/edit.go index 0360911bf..245041bae 100644 --- a/pkg/cmd/release/edit/edit.go +++ b/pkg/cmd/release/edit/edit.go @@ -79,7 +79,7 @@ func NewCmdEdit(f *cmdutil.Factory, runF func(*EditOptions) error) *cobra.Comman cmdutil.NilStringFlag(cmd, &opts.Body, "notes", "n", "Release notes") cmdutil.NilStringFlag(cmd, &opts.Name, "title", "t", "Release title") cmdutil.NilStringFlag(cmd, &opts.DiscussionCategory, "discussion-category", "", "Start a discussion in the specified category when publishing a draft") - cmd.Flags().StringVar(&opts.Target, "target", "", "Target `branch` or full commit SHA (default: main branch)") + cmd.Flags().StringVar(&opts.Target, "target", "", "Target `branch` or full commit SHA (default [main branch])") cmd.Flags().StringVar(&opts.TagName, "tag", "", "The name of the tag") cmd.Flags().StringVarP(¬esFile, "notes-file", "F", "", "Read release notes from `file` (use \"-\" to read from standard input)") cmd.Flags().BoolVar(&opts.VerifyTag, "verify-tag", false, "Abort in case the git tag doesn't already exist in the remote repository") diff --git a/pkg/cmd/release/list/http.go b/pkg/cmd/release/list/http.go index 72ddcacf6..0d14df278 100644 --- a/pkg/cmd/release/list/http.go +++ b/pkg/cmd/release/list/http.go @@ -2,13 +2,25 @@ package list import ( "net/http" + "strings" "time" "github.com/cli/cli/v2/api" "github.com/cli/cli/v2/internal/ghrepo" + "github.com/cli/cli/v2/pkg/cmdutil" "github.com/shurcooL/githubv4" ) +var releaseFields = []string{ + "name", + "tagName", + "isDraft", + "isLatest", + "isPrerelease", + "createdAt", + "publishedAt", +} + type Release struct { Name string TagName string @@ -19,7 +31,11 @@ type Release struct { PublishedAt time.Time } -func fetchReleases(httpClient *http.Client, repo ghrepo.Interface, limit int, excludeDrafts bool, excludePreReleases bool) ([]Release, error) { +func (r *Release) ExportData(fields []string) map[string]interface{} { + return cmdutil.StructExportData(r, fields) +} + +func fetchReleases(httpClient *http.Client, repo ghrepo.Interface, limit int, excludeDrafts bool, excludePreReleases bool, order string) ([]Release, error) { type responseData struct { Repository struct { Releases struct { @@ -28,7 +44,7 @@ func fetchReleases(httpClient *http.Client, repo ghrepo.Interface, limit int, ex HasNextPage bool EndCursor string } - } `graphql:"releases(first: $perPage, orderBy: {field: CREATED_AT, direction: DESC}, after: $endCursor)"` + } `graphql:"releases(first: $perPage, orderBy: {field: CREATED_AT, direction: $direction}, after: $endCursor)"` } `graphql:"repository(owner: $owner, name: $name)"` } @@ -42,6 +58,7 @@ func fetchReleases(httpClient *http.Client, repo ghrepo.Interface, limit int, ex "name": githubv4.String(repo.RepoName()), "perPage": githubv4.Int(perPage), "endCursor": (*githubv4.String)(nil), + "direction": githubv4.OrderDirection(strings.ToUpper(order)), } gql := api.NewClientFromHTTP(httpClient) diff --git a/pkg/cmd/release/list/list.go b/pkg/cmd/release/list/list.go index f2258a933..24ec41840 100644 --- a/pkg/cmd/release/list/list.go +++ b/pkg/cmd/release/list/list.go @@ -18,9 +18,12 @@ type ListOptions struct { IO *iostreams.IOStreams BaseRepo func() (ghrepo.Interface, error) + Exporter cmdutil.Exporter + LimitResults int ExcludeDrafts bool ExcludePreReleases bool + Order string } func NewCmdList(f *cmdutil.Factory, runF func(*ListOptions) error) *cobra.Command { @@ -48,6 +51,8 @@ func NewCmdList(f *cmdutil.Factory, runF func(*ListOptions) error) *cobra.Comman cmd.Flags().IntVarP(&opts.LimitResults, "limit", "L", 30, "Maximum number of items to fetch") cmd.Flags().BoolVar(&opts.ExcludeDrafts, "exclude-drafts", false, "Exclude draft releases") cmd.Flags().BoolVar(&opts.ExcludePreReleases, "exclude-pre-releases", false, "Exclude pre-releases") + cmdutil.StringEnumFlag(cmd, &opts.Order, "order", "O", "desc", []string{"asc", "desc"}, "Order of releases returned") + cmdutil.AddJSONFlags(cmd, &opts.Exporter, releaseFields) return cmd } @@ -63,12 +68,12 @@ func listRun(opts *ListOptions) error { return err } - releases, err := fetchReleases(httpClient, baseRepo, opts.LimitResults, opts.ExcludeDrafts, opts.ExcludePreReleases) + releases, err := fetchReleases(httpClient, baseRepo, opts.LimitResults, opts.ExcludeDrafts, opts.ExcludePreReleases, opts.Order) if err != nil { return err } - if len(releases) == 0 { + if len(releases) == 0 && opts.Exporter == nil { return cmdutil.NewNoResultsError("no releases found") } @@ -78,9 +83,12 @@ func listRun(opts *ListOptions) error { fmt.Fprintf(opts.IO.ErrOut, "failed to start pager: %v\n", err) } - table := tableprinter.New(opts.IO) + if opts.Exporter != nil { + return opts.Exporter.Write(opts.IO, releases) + } + + table := tableprinter.New(opts.IO, tableprinter.WithHeader("Title", "Type", "Tag name", "Published")) iofmt := opts.IO.ColorScheme() - table.HeaderRow("Title", "Type", "Tag name", "Published") for _, rel := range releases { title := text.RemoveExcessiveWhitespace(rel.Name) if title == "" { diff --git a/pkg/cmd/release/list/list_test.go b/pkg/cmd/release/list/list_test.go index df883ead2..79d6a601c 100644 --- a/pkg/cmd/release/list/list_test.go +++ b/pkg/cmd/release/list/list_test.go @@ -34,6 +34,7 @@ func Test_NewCmdList(t *testing.T) { LimitResults: 30, ExcludeDrafts: false, ExcludePreReleases: false, + Order: "desc", }, }, { @@ -43,6 +44,7 @@ func Test_NewCmdList(t *testing.T) { LimitResults: 30, ExcludeDrafts: true, ExcludePreReleases: false, + Order: "desc", }, }, { @@ -52,6 +54,17 @@ func Test_NewCmdList(t *testing.T) { LimitResults: 30, ExcludeDrafts: false, ExcludePreReleases: true, + Order: "desc", + }, + }, + { + name: "with order", + args: "--order asc", + want: ListOptions{ + LimitResults: 30, + ExcludeDrafts: false, + ExcludePreReleases: false, + Order: "asc", }, }, } @@ -92,6 +105,7 @@ func Test_NewCmdList(t *testing.T) { assert.Equal(t, tt.want.LimitResults, opts.LimitResults) assert.Equal(t, tt.want.ExcludeDrafts, opts.ExcludeDrafts) assert.Equal(t, tt.want.ExcludePreReleases, opts.ExcludePreReleases) + assert.Equal(t, tt.want.Order, opts.Order) }) } } @@ -214,3 +228,24 @@ func Test_listRun(t *testing.T) { }) } } + +func TestExportReleases(t *testing.T) { + ios, _, stdout, _ := iostreams.Test() + createdAt, _ := time.Parse(time.RFC3339, "2024-01-01T00:00:00Z") + publishedAt, _ := time.Parse(time.RFC3339, "2024-02-01T00:00:00Z") + rs := []Release{{ + Name: "v1", + TagName: "tag", + IsDraft: true, + IsLatest: false, + IsPrerelease: true, + CreatedAt: createdAt, + PublishedAt: publishedAt, + }} + exporter := cmdutil.NewJSONExporter() + exporter.SetFields(releaseFields) + require.NoError(t, exporter.Write(ios, rs)) + require.JSONEq(t, + `[{"createdAt":"2024-01-01T00:00:00Z","isDraft":true,"isLatest":false,"isPrerelease":true,"name":"v1","publishedAt":"2024-02-01T00:00:00Z","tagName":"tag"}]`, + stdout.String()) +} diff --git a/pkg/cmd/release/upload/upload.go b/pkg/cmd/release/upload/upload.go index 12cba4542..42419ccf3 100644 --- a/pkg/cmd/release/upload/upload.go +++ b/pkg/cmd/release/upload/upload.go @@ -38,12 +38,12 @@ func NewCmdUpload(f *cmdutil.Factory, runF func(*UploadOptions) error) *cobra.Co cmd := &cobra.Command{ Use: "upload ...", Short: "Upload assets to a release", - Long: heredoc.Doc(` + Long: heredoc.Docf(` Upload asset files to a GitHub Release. - To define a display label for an asset, append text starting with '#' after the + To define a display label for an asset, append text starting with %[1]s#%[1]s after the file name. - `), + `, "`"), Args: cobra.MinimumNArgs(2), RunE: func(cmd *cobra.Command, args []string) error { // support `-R, --repo` override diff --git a/pkg/cmd/release/view/view.go b/pkg/cmd/release/view/view.go index 1f6fb6a34..a32482e65 100644 --- a/pkg/cmd/release/view/view.go +++ b/pkg/cmd/release/view/view.go @@ -10,12 +10,12 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/internal/ghrepo" + "github.com/cli/cli/v2/internal/tableprinter" "github.com/cli/cli/v2/internal/text" "github.com/cli/cli/v2/pkg/cmd/release/shared" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" "github.com/cli/cli/v2/pkg/markdown" - "github.com/cli/cli/v2/utils" "github.com/spf13/cobra" ) @@ -154,11 +154,11 @@ func renderReleaseTTY(io *iostreams.IOStreams, release *shared.Release) error { if len(release.Assets) > 0 { fmt.Fprintf(w, "%s\n", iofmt.Bold("Assets")) - //nolint:staticcheck // SA1019: utils.NewTablePrinter is deprecated: use internal/tableprinter - table := utils.NewTablePrinter(io) + //nolint:staticcheck // SA1019: Showing NAME|SIZE headers adds nothing to table. + table := tableprinter.New(io, tableprinter.NoHeader) for _, a := range release.Assets { - table.AddField(a.Name, nil, nil) - table.AddField(humanFileSize(a.Size), nil, nil) + table.AddField(a.Name) + table.AddField(humanFileSize(a.Size)) table.EndRow() } err := table.Render() diff --git a/pkg/cmd/repo/archive/archive.go b/pkg/cmd/repo/archive/archive.go index dbf2d209e..86e1a6df7 100644 --- a/pkg/cmd/repo/archive/archive.go +++ b/pkg/cmd/repo/archive/archive.go @@ -7,7 +7,7 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/api" - "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/internal/prompter" "github.com/cli/cli/v2/pkg/cmdutil" @@ -18,7 +18,7 @@ import ( type ArchiveOptions struct { HttpClient func() (*http.Client, error) - Config func() (config.Config, error) + Config func() (gh.Config, error) BaseRepo func() (ghrepo.Interface, error) Confirmed bool IO *iostreams.IOStreams diff --git a/pkg/cmd/repo/clone/clone.go b/pkg/cmd/repo/clone/clone.go index 8d04ac630..1466cd96a 100644 --- a/pkg/cmd/repo/clone/clone.go +++ b/pkg/cmd/repo/clone/clone.go @@ -4,12 +4,13 @@ import ( "context" "fmt" "net/http" + "net/url" "strings" "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/api" "github.com/cli/cli/v2/git" - "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" @@ -20,7 +21,7 @@ import ( type CloneOptions struct { HttpClient func() (*http.Client, error) GitClient *git.Client - Config func() (config.Config, error) + Config func() (gh.Config, error) IO *iostreams.IOStreams GitArgs []string @@ -44,16 +45,39 @@ func NewCmdClone(f *cmdutil.Factory, runF func(*CloneOptions) error) *cobra.Comm Short: "Clone a repository locally", Long: heredoc.Docf(` Clone a GitHub repository locally. Pass additional %[1]sgit clone%[1]s flags by listing - them after "--". + them after %[1]s--%[1]s. - If the "OWNER/" portion of the "OWNER/REPO" repository argument is omitted, it + If the %[1]sOWNER/%[1]s portion of the %[1]sOWNER/REPO%[1]s repository argument is omitted, it defaults to the name of the authenticating user. + When a protocol scheme is not provided in the repository argument, the %[1]sgit_protocol%[1]s will be + chosen from your configuration, which can be checked via %[1]sgh config get git_protocol%[1]s. If the protocol + scheme is provided, the repository will be cloned using the specified protocol. + If the repository is a fork, its parent repository will be added as an additional - git remote called "upstream". The remote name can be configured using %[1]s--upstream-remote-name%[1]s. - The %[1]s--upstream-remote-name%[1]s option supports an "@owner" value which will name + git remote called %[1]supstream%[1]s. The remote name can be configured using %[1]s--upstream-remote-name%[1]s. + The %[1]s--upstream-remote-name%[1]s option supports an %[1]s@owner%[1]s value which will name the remote after the owner of the parent repository. + + If the repository is a fork, its parent repository will be set as the default remote repository. `, "`"), + Example: heredoc.Doc(` + # Clone a repository from a specific org + $ gh repo clone cli/cli + + # Clone a repository from your own account + $ gh repo clone myrepo + + # Clone a repo, overriding git protocol configuration + $ gh repo clone https://github.com/cli/cli + $ gh repo clone git@github.com:cli/cli.git + + # Clone a repository to a custom directory + $ gh repo clone cli/cli workspace/cli + + # Clone a repository with additional git clone flags + $ gh repo clone cli/cli -- --depth=1 + `), RunE: func(cmd *cobra.Command, args []string) error { opts.Repository = args[0] opts.GitArgs = args[1:] @@ -97,10 +121,12 @@ func cloneRun(opts *CloneOptions) error { var protocol string if repositoryIsURL { - repoURL, err := git.ParseURL(opts.Repository) + initialURL, err := git.ParseURL(opts.Repository) if err != nil { return err } + + repoURL := simplifyURL(initialURL) repo, err = ghrepo.FromURL(repoURL) if err != nil { return err @@ -127,10 +153,7 @@ func cloneRun(opts *CloneOptions) error { return err } - protocol, err = cfg.GetOrDefault(repo.RepoHost(), "git_protocol") - if err != nil { - return err - } + protocol = cfg.GitProtocol(repo.RepoHost()).Value } wantsWiki := strings.HasSuffix(repo.RepoName(), ".wiki") @@ -162,12 +185,9 @@ func cloneRun(opts *CloneOptions) error { return err } - // If the repo is a fork, add the parent as an upstream + // If the repo is a fork, add the parent as an upstream remote and set the parent as the default repo. if canonicalRepo.Parent != nil { - protocol, err := cfg.GetOrDefault(canonicalRepo.Parent.RepoHost(), "git_protocol") - if err != nil { - return err - } + protocol := cfg.GitProtocol(canonicalRepo.Parent.RepoHost()).Value upstreamURL := ghrepo.FormatRemoteURL(canonicalRepo.Parent, protocol) upstreamName := opts.UpstreamName @@ -178,8 +198,7 @@ func cloneRun(opts *CloneOptions) error { gc := gitClient.Copy() gc.RepoDir = cloneDir - _, err = gc.AddRemote(ctx, upstreamName, upstreamURL, []string{canonicalRepo.Parent.DefaultBranchRef.Name}) - if err != nil { + if _, err := gc.AddRemote(ctx, upstreamName, upstreamURL, []string{canonicalRepo.Parent.DefaultBranchRef.Name}); err != nil { return err } @@ -190,6 +209,43 @@ func cloneRun(opts *CloneOptions) error { if err := gc.SetRemoteBranches(ctx, upstreamName, `*`); err != nil { return err } + + if err = gc.SetRemoteResolution(ctx, upstreamName, "base"); err != nil { + return err + } + + connectedToTerminal := opts.IO.IsStdoutTTY() + if connectedToTerminal { + cs := opts.IO.ColorScheme() + fmt.Fprintf(opts.IO.ErrOut, "%s Repository %s set as the default repository. To learn more about the default repository, run: gh repo set-default --help\n", cs.WarningIcon(), cs.Bold(ghrepo.FullName(canonicalRepo.Parent))) + } } return nil } + +// simplifyURL strips given URL of extra parts like extra path segments (i.e., +// anything beyond `/owner/repo`), query strings, or fragments. This function +// never returns an error. +// +// The rationale behind this function is to let users clone a repo with any +// URL related to the repo; like: +// - (Tree) github.com/owner/repo/blob/main/foo/bar +// - (Deep-link to line) github.com/owner/repo/blob/main/foo/bar#L168 +// - (Issue/PR comment) github.com/owner/repo/pull/999#issue-9999999999 +// - (Commit history) github.com/owner/repo/commits/main/?author=foo +func simplifyURL(u *url.URL) *url.URL { + result := &url.URL{ + Scheme: u.Scheme, + User: u.User, + Host: u.Host, + Path: u.Path, + } + + pathParts := strings.SplitN(strings.Trim(u.Path, "/"), "/", 3) + if len(pathParts) <= 2 { + return result + } + + result.Path = strings.Join(pathParts[0:2], "/") + return result +} diff --git a/pkg/cmd/repo/clone/clone_test.go b/pkg/cmd/repo/clone/clone_test.go index 0ea3a65af..471ed05dd 100644 --- a/pkg/cmd/repo/clone/clone_test.go +++ b/pkg/cmd/repo/clone/clone_test.go @@ -2,10 +2,12 @@ package clone import ( "net/http" + "net/url" "testing" "github.com/cli/cli/v2/git" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/run" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/httpmock" @@ -101,7 +103,7 @@ func runCloneCommand(httpClient *http.Client, cli string) (*test.CmdOut, error) HttpClient: func() (*http.Client, error) { return httpClient, nil }, - Config: func() (config.Config, error) { + Config: func() (gh.Config, error) { return config.NewBlankConfig(), nil }, GitClient: &git.Client{ @@ -163,6 +165,11 @@ func Test_RepoClone(t *testing.T) { args: "https://github.com/OWNER/REPO", want: "git clone https://github.com/OWNER/REPO.git", }, + { + name: "HTTPS URL with extra path parts", + args: "https://github.com/OWNER/REPO/extra/part?key=value#fragment", + want: "git clone https://github.com/OWNER/REPO.git", + }, { name: "SSH URL", args: "git@github.com:OWNER/REPO.git", @@ -183,6 +190,11 @@ func Test_RepoClone(t *testing.T) { args: "https://github.com/owner/repo.wiki", want: "git clone https://github.com/OWNER/REPO.wiki.git", }, + { + name: "wiki URL with extra path parts", + args: "https://github.com/owner/repo.wiki/extra/path?key=value#fragment", + want: "git clone https://github.com/OWNER/REPO.wiki.git", + }, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { @@ -219,6 +231,7 @@ func Test_RepoClone(t *testing.T) { func Test_RepoClone_hasParent(t *testing.T) { reg := &httpmock.Registry{} + defer reg.Verify(t) reg.Register( httpmock.GraphQL(`query RepositoryInfo\b`), httpmock.StringResponse(` @@ -248,6 +261,7 @@ func Test_RepoClone_hasParent(t *testing.T) { cs.Register(`git -C REPO remote add -t trunk upstream https://github.com/hubot/ORIG.git`, 0, "") cs.Register(`git -C REPO fetch upstream`, 0, "") cs.Register(`git -C REPO remote set-branches upstream *`, 0, "") + cs.Register(`git -C REPO config --add remote.upstream.gh-resolved base`, 0, "") _, err := runCloneCommand(httpClient, "OWNER/REPO") if err != nil { @@ -257,6 +271,7 @@ func Test_RepoClone_hasParent(t *testing.T) { func Test_RepoClone_hasParent_upstreamRemoteName(t *testing.T) { reg := &httpmock.Registry{} + defer reg.Verify(t) reg.Register( httpmock.GraphQL(`query RepositoryInfo\b`), httpmock.StringResponse(` @@ -286,6 +301,7 @@ func Test_RepoClone_hasParent_upstreamRemoteName(t *testing.T) { cs.Register(`git -C REPO remote add -t trunk test https://github.com/hubot/ORIG.git`, 0, "") cs.Register(`git -C REPO fetch test`, 0, "") cs.Register(`git -C REPO remote set-branches test *`, 0, "") + cs.Register(`git -C REPO config --add remote.test.gh-resolved base`, 0, "") _, err := runCloneCommand(httpClient, "OWNER/REPO --upstream-remote-name test") if err != nil { @@ -327,3 +343,56 @@ func Test_RepoClone_withoutUsername(t *testing.T) { assert.Equal(t, "", output.String()) assert.Equal(t, "", output.Stderr()) } + +func TestSimplifyURL(t *testing.T) { + tests := []struct { + name string + raw string + expectedRaw string + }{ + { + name: "empty", + raw: "", + expectedRaw: "", + }, + { + name: "no change, no path", + raw: "https://github.com", + expectedRaw: "https://github.com", + }, + { + name: "no change, single part path", + raw: "https://github.com/owner", + expectedRaw: "https://github.com/owner", + }, + { + name: "no change, two-part path", + raw: "https://github.com/owner/repo", + expectedRaw: "https://github.com/owner/repo", + }, + { + name: "no change, three-part path", + raw: "https://github.com/owner/repo/pulls", + expectedRaw: "https://github.com/owner/repo", + }, + { + name: "no change, two-part path, with query, with fragment", + raw: "https://github.com/owner/repo?key=value#fragment", + expectedRaw: "https://github.com/owner/repo", + }, + { + name: "no change, single part path, with query, with fragment", + raw: "https://github.com/owner?key=value#fragment", + expectedRaw: "https://github.com/owner", + }, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + u, err := url.Parse(tt.raw) + require.NoError(t, err) + result := simplifyURL(u) + assert.Equal(t, tt.expectedRaw, result.String()) + }) + } +} diff --git a/pkg/cmd/repo/create/create.go b/pkg/cmd/repo/create/create.go index 3cc1d2f62..48a331bdd 100644 --- a/pkg/cmd/repo/create/create.go +++ b/pkg/cmd/repo/create/create.go @@ -17,7 +17,7 @@ import ( "github.com/cenkalti/backoff/v4" "github.com/cli/cli/v2/api" "github.com/cli/cli/v2/git" - "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/pkg/cmd/repo/shared" "github.com/cli/cli/v2/pkg/cmdutil" @@ -38,7 +38,7 @@ type iprompter interface { type CreateOptions struct { HttpClient func() (*http.Client, error) GitClient *git.Client - Config func() (config.Config, error) + Config func() (gh.Config, error) IO *iostreams.IOStreams Prompter iprompter BackOff backoff.BackOff @@ -164,8 +164,8 @@ func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Co if cmd.Flags().Changed("enable-wiki") { opts.DisableWiki = !enableWiki } - if opts.Template != "" && (opts.Homepage != "" || opts.Team != "" || opts.DisableIssues) { - return cmdutil.FlagErrorf("the `--template` option is not supported with `--homepage`, `--team`, or `--disable-issues`") + if opts.Template != "" && opts.Team != "" { + return cmdutil.FlagErrorf("the `--template` option is not supported with `--team`") } if opts.Template == "" && opts.IncludeAllBranches { @@ -248,20 +248,26 @@ func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Co } func createRun(opts *CreateOptions) error { - fromScratch := opts.Source == "" - if opts.Interactive { - selected, err := opts.Prompter.Select("What would you like to do?", "", []string{ + answer, err := opts.Prompter.Select("What would you like to do?", "", []string{ "Create a new repository on GitHub from scratch", + "Create a new repository on GitHub from a template repository", "Push an existing local repository to GitHub", }) if err != nil { return err } - fromScratch = selected == 0 + switch answer { + case 0: + return createFromScratch(opts) + case 1: + return createFromTemplate(opts) + case 2: + return createFromLocal(opts) + } } - if fromScratch { + if opts.Source == "" { return createFromScratch(opts) } return createFromLocal(opts) @@ -373,9 +379,10 @@ func createFromScratch(opts *CreateOptions) error { isTTY := opts.IO.IsStdoutTTY() if isTTY { fmt.Fprintf(opts.IO.Out, - "%s Created repository %s on GitHub\n", + "%s Created repository %s on GitHub\n %s\n", cs.SuccessIconWithColor(cs.Green), - ghrepo.FullName(repo)) + ghrepo.FullName(repo), + repo.URL) } else { fmt.Fprintln(opts.IO.Out, repo.URL) } @@ -389,11 +396,7 @@ func createFromScratch(opts *CreateOptions) error { } if opts.Clone { - protocol, err := cfg.GetOrDefault(repo.RepoHost(), "git_protocol") - if err != nil { - return err - } - + protocol := cfg.GitProtocol(repo.RepoHost()).Value remoteURL := ghrepo.FormatRemoteURL(repo, protocol) if !opts.AddReadme && opts.LicenseTemplate == "" && opts.GitIgnoreTemplate == "" && opts.Template == "" { @@ -404,6 +407,99 @@ func createFromScratch(opts *CreateOptions) error { } else if err := cloneWithRetry(opts, remoteURL, templateRepoMainBranch); err != nil { return err } + + } + + return nil +} + +// create new repo on remote host from template repo +func createFromTemplate(opts *CreateOptions) error { + httpClient, err := opts.HttpClient() + if err != nil { + return err + } + + cfg, err := opts.Config() + if err != nil { + return err + } + + host, _ := cfg.Authentication().DefaultHost() + + opts.Name, opts.Description, opts.Visibility, err = interactiveRepoInfo(httpClient, host, opts.Prompter, "") + if err != nil { + return err + } + + if !strings.Contains(opts.Name, "/") { + username, _, err := userAndOrgs(httpClient, host) + if err != nil { + return err + } + opts.Name = fmt.Sprintf("%s/%s", username, opts.Name) + } + repoToCreate, err := ghrepo.FromFullName(opts.Name) + if err != nil { + return fmt.Errorf("argument error: %w", err) + } + + templateRepo, err := interactiveRepoTemplate(httpClient, host, repoToCreate.RepoOwner(), opts.Prompter) + if err != nil { + return err + } + input := repoCreateInput{ + Name: repoToCreate.RepoName(), + Visibility: opts.Visibility, + OwnerLogin: repoToCreate.RepoOwner(), + TeamSlug: opts.Team, + Description: opts.Description, + HomepageURL: opts.Homepage, + HasIssuesEnabled: !opts.DisableIssues, + HasWikiEnabled: !opts.DisableWiki, + GitIgnoreTemplate: opts.GitIgnoreTemplate, + LicenseTemplate: opts.LicenseTemplate, + IncludeAllBranches: opts.IncludeAllBranches, + InitReadme: opts.AddReadme, + TemplateRepositoryID: templateRepo.ID, + } + templateRepoMainBranch := templateRepo.DefaultBranchRef.Name + + targetRepo := shared.NormalizeRepoName(opts.Name) + if idx := strings.IndexRune(opts.Name, '/'); idx > 0 { + targetRepo = opts.Name[0:idx+1] + shared.NormalizeRepoName(opts.Name[idx+1:]) + } + confirmed, err := opts.Prompter.Confirm(fmt.Sprintf(`This will create "%s" as a %s repository on GitHub. Continue?`, targetRepo, strings.ToLower(opts.Visibility)), true) + if err != nil { + return err + } else if !confirmed { + return cmdutil.CancelError + } + + repo, err := repoCreate(httpClient, repoToCreate.RepoHost(), input) + if err != nil { + return err + } + + cs := opts.IO.ColorScheme() + fmt.Fprintf(opts.IO.Out, + "%s Created repository %s on GitHub\n %s\n", + cs.SuccessIconWithColor(cs.Green), + ghrepo.FullName(repo), + repo.URL) + + opts.Clone, err = opts.Prompter.Confirm("Clone the new repository locally?", true) + if err != nil { + return err + } + + if opts.Clone { + protocol := cfg.GitProtocol(repo.RepoHost()).Value + remoteURL := ghrepo.FormatRemoteURL(repo, protocol) + + if err := cloneWithRetry(opts, remoteURL, templateRepoMainBranch); err != nil { + return err + } } return nil @@ -513,18 +609,15 @@ func createFromLocal(opts *CreateOptions) error { if isTTY { fmt.Fprintf(stdout, - "%s Created repository %s on GitHub\n", + "%s Created repository %s on GitHub\n %s\n", cs.SuccessIconWithColor(cs.Green), - ghrepo.FullName(repo)) + ghrepo.FullName(repo), + repo.URL) } else { fmt.Fprintln(stdout, repo.URL) } - protocol, err := cfg.GetOrDefault(repo.RepoHost(), "git_protocol") - if err != nil { - return err - } - + protocol := cfg.GitProtocol(repo.RepoHost()).Value remoteURL := ghrepo.FormatRemoteURL(repo, protocol) if opts.Interactive { @@ -678,6 +771,27 @@ func localInit(gitClient *git.Client, remoteURL, path string) error { return nil } +func interactiveRepoTemplate(client *http.Client, hostname, owner string, prompter iprompter) (*api.Repository, error) { + templateRepos, err := listTemplateRepositories(client, hostname, owner) + if err != nil { + return nil, err + } + if len(templateRepos) == 0 { + return nil, fmt.Errorf("%s has no template repositories", owner) + } + + var templates []string + for _, repo := range templateRepos { + templates = append(templates, repo.Name) + } + + selected, err := prompter.Select("Choose a template repository", "", templates) + if err != nil { + return nil, err + } + return &templateRepos[selected], nil +} + func interactiveGitIgnore(client *http.Client, hostname string, prompter iprompter) (string, error) { confirmed, err := prompter.Confirm("Would you like to add a .gitignore?", false) if err != nil { diff --git a/pkg/cmd/repo/create/create_test.go b/pkg/cmd/repo/create/create_test.go index b0d21460e..e6576ebd0 100644 --- a/pkg/cmd/repo/create/create_test.go +++ b/pkg/cmd/repo/create/create_test.go @@ -9,6 +9,7 @@ import ( "github.com/cenkalti/backoff/v4" "github.com/cli/cli/v2/git" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/prompter" "github.com/cli/cli/v2/internal/run" "github.com/cli/cli/v2/pkg/cmdutil" @@ -200,7 +201,7 @@ func Test_createRun(t *testing.T) { name: "interactive create from scratch with gitignore and license", opts: &CreateOptions{Interactive: true}, tty: true, - wantStdout: "✓ Created repository OWNER/REPO on GitHub\n", + wantStdout: "✓ Created repository OWNER/REPO on GitHub\n https://github.com/OWNER/REPO\n", promptStubs: func(p *prompter.PrompterMock) { p.ConfirmFunc = func(message string, defaultValue bool) (bool, error) { switch message { @@ -266,7 +267,7 @@ func Test_createRun(t *testing.T) { name: "interactive create from scratch but with prompted owner", opts: &CreateOptions{Interactive: true}, tty: true, - wantStdout: "✓ Created repository org1/REPO on GitHub\n", + wantStdout: "✓ Created repository org1/REPO on GitHub\n https://github.com/org1/REPO\n", promptStubs: func(p *prompter.PrompterMock) { p.ConfirmFunc = func(message string, defaultValue bool) (bool, error) { switch message { @@ -440,7 +441,7 @@ func Test_createRun(t *testing.T) { cs.Register(`git -C . rev-parse --git-dir`, 0, ".git") cs.Register(`git -C . rev-parse HEAD`, 0, "commithash") }, - wantStdout: "✓ Created repository OWNER/REPO on GitHub\n", + wantStdout: "✓ Created repository OWNER/REPO on GitHub\n https://github.com/OWNER/REPO\n", }, { name: "interactive with existing repository public add remote and push", @@ -508,7 +509,132 @@ func Test_createRun(t *testing.T) { cs.Register(`git -C . remote add origin https://github.com/OWNER/REPO`, 0, "") cs.Register(`git -C . push --set-upstream origin HEAD`, 0, "") }, - wantStdout: "✓ Created repository OWNER/REPO on GitHub\n✓ Added remote https://github.com/OWNER/REPO.git\n✓ Pushed commits to https://github.com/OWNER/REPO.git\n", + wantStdout: "✓ Created repository OWNER/REPO on GitHub\n https://github.com/OWNER/REPO\n✓ Added remote https://github.com/OWNER/REPO.git\n✓ Pushed commits to https://github.com/OWNER/REPO.git\n", + }, + { + name: "interactive create from a template repository", + opts: &CreateOptions{Interactive: true}, + tty: true, + promptStubs: func(p *prompter.PrompterMock) { + p.ConfirmFunc = func(message string, defaultValue bool) (bool, error) { + switch message { + case `This will create "OWNER/REPO" as a private repository on GitHub. Continue?`: + return defaultValue, nil + case "Clone the new repository locally?": + return defaultValue, nil + default: + return false, fmt.Errorf("unexpected confirm prompt: %s", message) + } + } + p.InputFunc = func(message, defaultValue string) (string, error) { + switch message { + case "Repository name": + return "REPO", nil + case "Description": + return "my new repo", nil + default: + return "", fmt.Errorf("unexpected input prompt: %s", message) + } + } + p.SelectFunc = func(message, defaultValue string, options []string) (int, error) { + switch message { + case "Repository owner": + return prompter.IndexFor(options, "OWNER") + case "Choose a template repository": + return prompter.IndexFor(options, "REPO") + case "What would you like to do?": + return prompter.IndexFor(options, "Create a new repository on GitHub from a template repository") + case "Visibility": + return prompter.IndexFor(options, "Private") + default: + return 0, fmt.Errorf("unexpected select prompt: %s", message) + } + } + }, + httpStubs: func(reg *httpmock.Registry) { + reg.Register( + httpmock.GraphQL(`query UserCurrent\b`), + httpmock.StringResponse(`{"data":{"viewer":{"login":"OWNER","organizations":{"nodes": []}}}}`)) + reg.Register( + httpmock.GraphQL(`query UserCurrent\b`), + httpmock.StringResponse(`{"data":{"viewer":{"login":"OWNER","organizations":{"nodes": []}}}}`)) + reg.Register( + httpmock.GraphQL(`query RepositoryList\b`), + httpmock.FileResponse("./fixtures/repoTempList.json")) + reg.Register( + httpmock.REST("GET", "users/OWNER"), + httpmock.StringResponse(`{"login":"OWNER","type":"User"}`)) + reg.Register( + httpmock.GraphQL(`query UserCurrent\b`), + httpmock.StringResponse(`{"data":{"viewer":{"id":"OWNER"}}}`)) + reg.Register( + httpmock.GraphQL(`mutation CloneTemplateRepository\b`), + httpmock.StringResponse(` + { + "data": { + "cloneTemplateRepository": { + "repository": { + "id": "REPOID", + "name": "REPO", + "owner": {"login":"OWNER"}, + "url": "https://github.com/OWNER/REPO" + } + } + } + }`)) + }, + execStubs: func(cs *run.CommandStubber) { + cs.Register(`git clone --branch main https://github.com/OWNER/REPO`, 0, "") + }, + wantStdout: "✓ Created repository OWNER/REPO on GitHub\n https://github.com/OWNER/REPO\n", + }, + { + name: "interactive create from template repo but there are no template repos", + opts: &CreateOptions{Interactive: true}, + tty: true, + promptStubs: func(p *prompter.PrompterMock) { + p.ConfirmFunc = func(message string, defaultValue bool) (bool, error) { + switch message { + default: + return false, fmt.Errorf("unexpected confirm prompt: %s", message) + } + } + p.InputFunc = func(message, defaultValue string) (string, error) { + switch message { + case "Repository name": + return "REPO", nil + case "Description": + return "my new repo", nil + default: + return "", fmt.Errorf("unexpected input prompt: %s", message) + } + } + p.SelectFunc = func(message, defaultValue string, options []string) (int, error) { + switch message { + case "What would you like to do?": + return prompter.IndexFor(options, "Create a new repository on GitHub from a template repository") + case "Visibility": + return prompter.IndexFor(options, "Private") + default: + return 0, fmt.Errorf("unexpected select prompt: %s", message) + } + } + }, + httpStubs: func(reg *httpmock.Registry) { + reg.Register( + httpmock.GraphQL(`query UserCurrent\b`), + httpmock.StringResponse(`{"data":{"viewer":{"login":"OWNER","organizations":{"nodes": []}}}}`)) + reg.Register( + httpmock.GraphQL(`query UserCurrent\b`), + httpmock.StringResponse(`{"data":{"viewer":{"login":"OWNER","organizations":{"nodes": []}}}}`)) + reg.Register( + httpmock.GraphQL(`query RepositoryList\b`), + httpmock.StringResponse(`{"data":{"repositoryOwner":{"login":"OWNER","repositories":{"nodes":[]},"totalCount":0,"pageInfo":{"hasNextPage":false,"endCursor":""}}}}`)) + }, + execStubs: func(cs *run.CommandStubber) {}, + wantStdout: "", + wantErr: true, + errMsg: "OWNER has no template repositories", }, { name: "noninteractive create from scratch", @@ -706,7 +832,7 @@ func Test_createRun(t *testing.T) { tt.opts.HttpClient = func() (*http.Client, error) { return &http.Client{Transport: reg}, nil } - tt.opts.Config = func() (config.Config, error) { + tt.opts.Config = func() (gh.Config, error) { return config.NewBlankConfig(), nil } diff --git a/pkg/cmd/repo/create/fixtures/repoTempList.json b/pkg/cmd/repo/create/fixtures/repoTempList.json new file mode 100644 index 000000000..9fbe46c51 --- /dev/null +++ b/pkg/cmd/repo/create/fixtures/repoTempList.json @@ -0,0 +1,25 @@ +{ + "data": { + "repositoryOwner": { + "login": "OWNER", + "repositories": { + "nodes": [ + { + "id": "REPOID", + "name": "REPO", + "isTemplate": true, + "pushedAt": "2021-02-19T06:34:58Z", + "defaultBranchRef": { + "name": "main" + } + } + ] + }, + "totalCount": 0, + "pageInfo": { + "hasNextPage": false, + "endCursor": "" + } + } + } +} \ No newline at end of file diff --git a/pkg/cmd/repo/create/http.go b/pkg/cmd/repo/create/http.go index d3a077300..ffe9dbb6f 100644 --- a/pkg/cmd/repo/create/http.go +++ b/pkg/cmd/repo/create/http.go @@ -8,6 +8,7 @@ import ( "strings" "github.com/cli/cli/v2/api" + "github.com/shurcooL/githubv4" ) // repoCreateInput is input parameters for the repoCreate method @@ -65,8 +66,10 @@ type cloneTemplateRepositoryInput struct { } type updateRepositoryInput struct { - RepositoryID string `json:"repositoryId"` - HasWikiEnabled bool `json:"hasWikiEnabled"` + RepositoryID string `json:"repositoryId"` + HasWikiEnabled bool `json:"hasWikiEnabled"` + HasIssuesEnabled bool `json:"hasIssuesEnabled"` + HomepageURL string `json:"homepageUrl,omitempty"` } // repoCreate creates a new GitHub repository @@ -138,11 +141,13 @@ func repoCreate(client *http.Client, hostname string, input repoCreateInput) (*a return nil, err } - if !input.HasWikiEnabled { + if !input.HasWikiEnabled || !input.HasIssuesEnabled || input.HomepageURL != "" { updateVariables := map[string]interface{}{ "input": updateRepositoryInput{ - RepositoryID: response.CloneTemplateRepository.Repository.ID, - HasWikiEnabled: input.HasWikiEnabled, + RepositoryID: response.CloneTemplateRepository.Repository.ID, + HasWikiEnabled: input.HasWikiEnabled, + HasIssuesEnabled: input.HasIssuesEnabled, + HomepageURL: input.HomepageURL, }, } @@ -262,6 +267,73 @@ func resolveOrganizationTeam(client *api.Client, hostname, orgName, teamSlug str return &response, err } +func listTemplateRepositories(client *http.Client, hostname, owner string) ([]api.Repository, error) { + ownerConnection := "repositoryOwner(login: $owner)" + + variables := map[string]interface{}{ + "perPage": githubv4.Int(100), + "owner": githubv4.String(owner), + } + inputs := []string{"$perPage:Int!", "$endCursor:String", "$owner:String!"} + + type result struct { + RepositoryOwner struct { + Login string + Repositories struct { + Nodes []api.Repository + TotalCount int + PageInfo struct { + HasNextPage bool + EndCursor string + } + } + } + } + + query := fmt.Sprintf(`query RepositoryList(%s) { + %s { + login + repositories(first: $perPage, after: $endCursor, ownerAffiliations: OWNER, orderBy: { field: PUSHED_AT, direction: DESC }) { + nodes{ + id + name + isTemplate + defaultBranchRef { + name + } + } + totalCount + pageInfo{hasNextPage,endCursor} + } + } + }`, strings.Join(inputs, ","), ownerConnection) + + apiClient := api.NewClientFromHTTP(client) + var templateRepositories []api.Repository + for { + var res result + err := apiClient.GraphQL(hostname, query, variables, &res) + if err != nil { + return nil, err + } + + owner := res.RepositoryOwner + + for _, repo := range owner.Repositories.Nodes { + if repo.IsTemplate { + templateRepositories = append(templateRepositories, repo) + } + } + + if !owner.Repositories.PageInfo.HasNextPage { + break + } + variables["endCursor"] = githubv4.String(owner.Repositories.PageInfo.EndCursor) + } + + return templateRepositories, nil +} + // listGitIgnoreTemplates uses API v3 here because gitignore template isn't supported by GraphQL yet. func listGitIgnoreTemplates(httpClient *http.Client, hostname string) ([]string, error) { var gitIgnoreTemplates []string diff --git a/pkg/cmd/repo/create/http_test.go b/pkg/cmd/repo/create/http_test.go index 7ebeb93b8..cfe14563a 100644 --- a/pkg/cmd/repo/create/http_test.go +++ b/pkg/cmd/repo/create/http_test.go @@ -287,8 +287,206 @@ func Test_repoCreate(t *testing.T) { }`, func(inputs map[string]interface{}) { assert.Equal(t, map[string]interface{}{ - "repositoryId": "REPOID", - "hasWikiEnabled": false, + "repositoryId": "REPOID", + "hasIssuesEnabled": true, + "hasWikiEnabled": false, + }, inputs) + }), + ) + }, + wantRepo: "https://github.com/OWNER/REPO", + }, + { + name: "create personal repo from template repo, and disable issues", + hostname: "github.com", + input: repoCreateInput{ + Name: "gen-project", + Description: "my generated project", + Visibility: "private", + TemplateRepositoryID: "TPLID", + HasIssuesEnabled: false, + HasWikiEnabled: true, + IncludeAllBranches: false, + }, + stubs: func(t *testing.T, r *httpmock.Registry) { + r.Register( + httpmock.GraphQL(`query UserCurrent\b`), + httpmock.StringResponse(`{"data": {"viewer": {"id":"USERID"} } }`)) + r.Register( + httpmock.GraphQL(`mutation CloneTemplateRepository\b`), + httpmock.GraphQLMutation( + `{ + "data": { + "cloneTemplateRepository": { + "repository": { + "id": "REPOID", + "name": "REPO", + "owner": {"login":"OWNER"}, + "url": "the://URL" + } + } + } + }`, + func(inputs map[string]interface{}) { + assert.Equal(t, map[string]interface{}{ + "name": "gen-project", + "description": "my generated project", + "visibility": "PRIVATE", + "ownerId": "USERID", + "repositoryId": "TPLID", + "includeAllBranches": false, + }, inputs) + }), + ) + r.Register( + httpmock.GraphQL(`mutation UpdateRepository\b`), + httpmock.GraphQLMutation( + `{ + "data": { + "updateRepository": { + "repository": { + "id": "REPOID" + } + } + } + }`, + func(inputs map[string]interface{}) { + assert.Equal(t, map[string]interface{}{ + "repositoryId": "REPOID", + "hasIssuesEnabled": false, + "hasWikiEnabled": true, + }, inputs) + }), + ) + }, + wantRepo: "https://github.com/OWNER/REPO", + }, + { + name: "create personal repo from template repo, and disable both wiki and issues", + hostname: "github.com", + input: repoCreateInput{ + Name: "gen-project", + Description: "my generated project", + Visibility: "private", + TemplateRepositoryID: "TPLID", + HasIssuesEnabled: false, + HasWikiEnabled: false, + IncludeAllBranches: false, + }, + stubs: func(t *testing.T, r *httpmock.Registry) { + r.Register( + httpmock.GraphQL(`query UserCurrent\b`), + httpmock.StringResponse(`{"data": {"viewer": {"id":"USERID"} } }`)) + r.Register( + httpmock.GraphQL(`mutation CloneTemplateRepository\b`), + httpmock.GraphQLMutation( + `{ + "data": { + "cloneTemplateRepository": { + "repository": { + "id": "REPOID", + "name": "REPO", + "owner": {"login":"OWNER"}, + "url": "the://URL" + } + } + } + }`, + func(inputs map[string]interface{}) { + assert.Equal(t, map[string]interface{}{ + "name": "gen-project", + "description": "my generated project", + "visibility": "PRIVATE", + "ownerId": "USERID", + "repositoryId": "TPLID", + "includeAllBranches": false, + }, inputs) + }), + ) + r.Register( + httpmock.GraphQL(`mutation UpdateRepository\b`), + httpmock.GraphQLMutation( + `{ + "data": { + "updateRepository": { + "repository": { + "id": "REPOID" + } + } + } + }`, + func(inputs map[string]interface{}) { + assert.Equal(t, map[string]interface{}{ + "repositoryId": "REPOID", + "hasIssuesEnabled": false, + "hasWikiEnabled": false, + }, inputs) + }), + ) + }, + wantRepo: "https://github.com/OWNER/REPO", + }, + { + name: "create personal repo from template repo, and set homepage url", + hostname: "github.com", + input: repoCreateInput{ + Name: "gen-project", + Description: "my generated project", + Visibility: "private", + TemplateRepositoryID: "TPLID", + HasIssuesEnabled: true, + HasWikiEnabled: true, + IncludeAllBranches: false, + HomepageURL: "https://example.com", + }, + stubs: func(t *testing.T, r *httpmock.Registry) { + r.Register( + httpmock.GraphQL(`query UserCurrent\b`), + httpmock.StringResponse(`{"data": {"viewer": {"id":"USERID"} } }`)) + r.Register( + httpmock.GraphQL(`mutation CloneTemplateRepository\b`), + httpmock.GraphQLMutation( + `{ + "data": { + "cloneTemplateRepository": { + "repository": { + "id": "REPOID", + "name": "REPO", + "owner": {"login":"OWNER"}, + "url": "the://URL" + } + } + } + }`, + func(inputs map[string]interface{}) { + assert.Equal(t, map[string]interface{}{ + "name": "gen-project", + "description": "my generated project", + "visibility": "PRIVATE", + "ownerId": "USERID", + "repositoryId": "TPLID", + "includeAllBranches": false, + }, inputs) + }), + ) + r.Register( + httpmock.GraphQL(`mutation UpdateRepository\b`), + httpmock.GraphQLMutation( + `{ + "data": { + "updateRepository": { + "repository": { + "id": "REPOID" + } + } + } + }`, + func(inputs map[string]interface{}) { + assert.Equal(t, map[string]interface{}{ + "repositoryId": "REPOID", + "hasIssuesEnabled": true, + "hasWikiEnabled": true, + "homepageUrl": "https://example.com", }, inputs) }), ) diff --git a/pkg/cmd/repo/deploy-key/list/http.go b/pkg/cmd/repo/deploy-key/list/http.go index 2be4436bc..4470cec04 100644 --- a/pkg/cmd/repo/deploy-key/list/http.go +++ b/pkg/cmd/repo/deploy-key/list/http.go @@ -13,9 +13,9 @@ import ( ) type deployKey struct { - ID int - Key string - Title string + ID int `json:"id"` + Key string `json:"key"` + Title string `json:"title"` CreatedAt time.Time `json:"created_at"` ReadOnly bool `json:"read_only"` } diff --git a/pkg/cmd/repo/deploy-key/list/list.go b/pkg/cmd/repo/deploy-key/list/list.go index 9504b3725..0cf2861c1 100644 --- a/pkg/cmd/repo/deploy-key/list/list.go +++ b/pkg/cmd/repo/deploy-key/list/list.go @@ -7,10 +7,9 @@ import ( "time" "github.com/cli/cli/v2/internal/ghrepo" - "github.com/cli/cli/v2/internal/text" + "github.com/cli/cli/v2/internal/tableprinter" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" - "github.com/cli/cli/v2/utils" "github.com/spf13/cobra" ) @@ -18,6 +17,15 @@ type ListOptions struct { IO *iostreams.IOStreams HTTPClient func() (*http.Client, error) BaseRepo func() (ghrepo.Interface, error) + Exporter cmdutil.Exporter +} + +var deployKeyFields = []string{ + "id", + "key", + "title", + "createdAt", + "readOnly", } func NewCmdList(f *cmdutil.Factory, runF func(*ListOptions) error) *cobra.Command { @@ -40,7 +48,7 @@ func NewCmdList(f *cmdutil.Factory, runF func(*ListOptions) error) *cobra.Comman return listRun(opts) }, } - + cmdutil.AddJSONFlags(cmd, &opts.Exporter, deployKeyFields) return cmd } @@ -64,28 +72,25 @@ func listRun(opts *ListOptions) error { return cmdutil.NewNoResultsError(fmt.Sprintf("no deploy keys found in %s", ghrepo.FullName(repo))) } - //nolint:staticcheck // SA1019: utils.NewTablePrinter is deprecated: use internal/tableprinter - t := utils.NewTablePrinter(opts.IO) + if opts.Exporter != nil { + return opts.Exporter.Write(opts.IO, deployKeys) + } + + t := tableprinter.New(opts.IO, tableprinter.WithHeader("ID", "TITLE", "TYPE", "KEY", "CREATED AT")) cs := opts.IO.ColorScheme() now := time.Now() for _, deployKey := range deployKeys { sshID := strconv.Itoa(deployKey.ID) - t.AddField(sshID, nil, nil) - t.AddField(deployKey.Title, nil, nil) - + t.AddField(sshID) + t.AddField(deployKey.Title) sshType := "read-only" if !deployKey.ReadOnly { sshType = "read-write" } - t.AddField(sshType, nil, nil) - t.AddField(deployKey.Key, truncateMiddle, nil) - - createdAt := deployKey.CreatedAt.Format(time.RFC3339) - if t.IsTTY() { - createdAt = text.FuzzyAgoAbbr(now, deployKey.CreatedAt) - } - t.AddField(createdAt, nil, cs.Gray) + t.AddField(sshType) + t.AddField(deployKey.Key, tableprinter.WithTruncate(truncateMiddle)) + t.AddTimeField(now, deployKey.CreatedAt, cs.Gray) t.EndRow() } diff --git a/pkg/cmd/repo/deploy-key/list/list_test.go b/pkg/cmd/repo/deploy-key/list/list_test.go index 0cefd0eb2..0f6977db7 100644 --- a/pkg/cmd/repo/deploy-key/list/list_test.go +++ b/pkg/cmd/repo/deploy-key/list/list_test.go @@ -48,8 +48,9 @@ func TestListRun(t *testing.T) { ) }, wantStdout: heredoc.Doc(` - 1234 Mac read-only ssh-rsa AAAABbBB123 1d - 5678 hubot@Windows read-write ssh-rsa EEEEEEEK247 1d + ID TITLE TYPE KEY CREATED AT + 1234 Mac read-only ssh-rsa AAAABbBB123 about 1 day ago + 5678 hubot@Windows read-write ssh-rsa EEEEEEEK247 about 1 day ago `), wantStderr: "", }, diff --git a/pkg/cmd/repo/edit/edit.go b/pkg/cmd/repo/edit/edit.go index 112aa5131..508dea06c 100644 --- a/pkg/cmd/repo/edit/edit.go +++ b/pkg/cmd/repo/edit/edit.go @@ -101,7 +101,7 @@ func NewCmdEdit(f *cmdutil.Factory, runF func(options *EditOptions) error) *cobr Long: heredoc.Docf(` Edit repository settings. - To toggle a setting off, use the %[1]s--flag=false%[1]s syntax. + To toggle a setting off, use the %[1]s--=false%[1]s syntax. Note that changing repository visibility to private will cause loss of stars and watchers. `, "`"), diff --git a/pkg/cmd/repo/fork/fork.go b/pkg/cmd/repo/fork/fork.go index 0d2d1da69..a49f5d567 100644 --- a/pkg/cmd/repo/fork/fork.go +++ b/pkg/cmd/repo/fork/fork.go @@ -14,7 +14,7 @@ import ( "github.com/cli/cli/v2/api" ghContext "github.com/cli/cli/v2/context" "github.com/cli/cli/v2/git" - "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/pkg/cmd/repo/shared" "github.com/cli/cli/v2/pkg/cmdutil" @@ -32,7 +32,7 @@ type iprompter interface { type ForkOptions struct { HttpClient func() (*http.Client, error) GitClient *git.Client - Config func() (config.Config, error) + Config func() (gh.Config, error) IO *iostreams.IOStreams BaseRepo func() (ghrepo.Interface, error) Remotes func() (ghContext.Remotes, error) @@ -88,11 +88,13 @@ func NewCmdFork(f *cmdutil.Factory, runF func(*ForkOptions) error) *cobra.Comman With no argument, creates a fork of the current repository. Otherwise, forks the specified repository. - By default, the new fork is set to be your "origin" remote and any existing - origin remote is renamed to "upstream". To alter this behavior, you can set + By default, the new fork is set to be your %[1]sorigin%[1]s remote and any existing + origin remote is renamed to %[1]supstream%[1]s. To alter this behavior, you can set a name for the new fork's remote with %[1]s--remote-name%[1]s. - Additional git clone flags can be passed after %[1]s--%[1]s. + The %[1]supstream%[1]s remote will be set as the default remote repository. + + Additional %[1]sgit clone%[1]s flags can be passed after %[1]s--%[1]s. `, "`"), RunE: func(cmd *cobra.Command, args []string) error { promptOk := opts.IO.CanPrompt() @@ -241,7 +243,9 @@ func forkRun(opts *ForkOptions) error { if err != nil { return err } - protocol, _ := cfg.Get(repoToFork.RepoHost(), "git_protocol") + protocolConfig := cfg.GitProtocol(repoToFork.RepoHost()) + protocolIsConfiguredByUser := protocolConfig.Source == gh.ConfigUserProvided + protocol := protocolConfig.Value gitClient := opts.GitClient ctx := context.Background() @@ -252,7 +256,7 @@ func forkRun(opts *ForkOptions) error { return err } - if protocol == "" { // user has no set preference + if !protocolIsConfiguredByUser { if remote, err := remotes.FindByRepo(repoToFork.RepoOwner(), repoToFork.RepoName()); err == nil { scheme := "" if remote.FetchURL != nil { @@ -350,18 +354,26 @@ func forkRun(opts *ForkOptions) error { return fmt.Errorf("failed to clone fork: %w", err) } + gc := gitClient.Copy() + gc.RepoDir = cloneDir upstreamURL := ghrepo.FormatRemoteURL(repoToFork, protocol) - _, err = gitClient.AddRemote(ctx, "upstream", upstreamURL, []string{}, git.WithRepoDir(cloneDir)) - if err != nil { + upstreamRemote := "upstream" + + if _, err := gc.AddRemote(ctx, upstreamRemote, upstreamURL, []string{}); err != nil { return err } - if err := gitClient.Fetch(ctx, "upstream", "", git.WithRepoDir(cloneDir)); err != nil { + if err := gc.SetRemoteResolution(ctx, upstreamRemote, "base"); err != nil { + return err + } + + if err := gc.Fetch(ctx, upstreamRemote, ""); err != nil { return err } if connectedToTerminal { fmt.Fprintf(stderr, "%s Cloned fork\n", cs.SuccessIcon()) + fmt.Fprintf(stderr, "%s Repository %s set as the default repository. To learn more about the default repository, run: gh repo set-default --help\n", cs.WarningIcon(), cs.Bold(ghrepo.FullName(repoToFork))) } } } diff --git a/pkg/cmd/repo/fork/fork_test.go b/pkg/cmd/repo/fork/fork_test.go index f59fba1b7..0f94496f0 100644 --- a/pkg/cmd/repo/fork/fork_test.go +++ b/pkg/cmd/repo/fork/fork_test.go @@ -13,6 +13,7 @@ import ( "github.com/cli/cli/v2/context" "github.com/cli/cli/v2/git" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/internal/prompter" "github.com/cli/cli/v2/internal/run" @@ -211,7 +212,7 @@ func TestRepoFork(t *testing.T) { httpStubs func(*httpmock.Registry) execStubs func(*run.CommandStubber) promptStubs func(*prompter.MockPrompter) - cfgStubs func(*config.ConfigMock) + cfgStubs func(*testing.T, gh.Config) remotes []*context.Remote wantOut string wantErrOut string @@ -233,6 +234,9 @@ func TestRepoFork(t *testing.T) { Repo: ghrepo.New("OWNER", "REPO"), }, }, + cfgStubs: func(_ *testing.T, c gh.Config) { + c.Set("", "git_protocol", "https") + }, httpStubs: forkPost, execStubs: func(cs *run.CommandStubber) { cs.Register(`git remote add fork https://github\.com/someone/REPO\.git`, 0, "") @@ -254,9 +258,6 @@ func TestRepoFork(t *testing.T) { Repo: ghrepo.New("OWNER", "REPO"), }, }, - cfgStubs: func(c *config.ConfigMock) { - c.Set("", "git_protocol", "") - }, httpStubs: forkPost, execStubs: func(cs *run.CommandStubber) { cs.Register(`git remote add fork git@github\.com:someone/REPO\.git`, 0, "") @@ -442,8 +443,9 @@ func TestRepoFork(t *testing.T) { cs.Register(`git clone --depth 1 https://github.com/someone/REPO\.git`, 0, "") cs.Register(`git -C REPO remote add upstream https://github\.com/OWNER/REPO\.git`, 0, "") cs.Register(`git -C REPO fetch upstream`, 0, "") + cs.Register(`git -C REPO config --add remote.upstream.gh-resolved base`, 0, "") }, - wantErrOut: "✓ Created fork someone/REPO\n✓ Cloned fork\n", + wantErrOut: "✓ Created fork someone/REPO\n✓ Cloned fork\n! Repository OWNER/REPO set as the default repository. To learn more about the default repository, run: gh repo set-default --help\n", }, { name: "repo arg fork to org", @@ -473,8 +475,9 @@ func TestRepoFork(t *testing.T) { cs.Register(`git clone https://github.com/gamehendge/REPO\.git`, 0, "") cs.Register(`git -C REPO remote add upstream https://github\.com/OWNER/REPO\.git`, 0, "") cs.Register(`git -C REPO fetch upstream`, 0, "") + cs.Register(`git -C REPO config --add remote.upstream.gh-resolved base`, 0, "") }, - wantErrOut: "✓ Created fork gamehendge/REPO\n✓ Cloned fork\n", + wantErrOut: "✓ Created fork gamehendge/REPO\n✓ Cloned fork\n! Repository OWNER/REPO set as the default repository. To learn more about the default repository, run: gh repo set-default --help\n", }, { name: "repo arg url arg", @@ -488,8 +491,9 @@ func TestRepoFork(t *testing.T) { cs.Register(`git clone https://github.com/someone/REPO\.git`, 0, "") cs.Register(`git -C REPO remote add upstream https://github\.com/OWNER/REPO\.git`, 0, "") cs.Register(`git -C REPO fetch upstream`, 0, "") + cs.Register(`git -C REPO config --add remote.upstream.gh-resolved base`, 0, "") }, - wantErrOut: "✓ Created fork someone/REPO\n✓ Cloned fork\n", + wantErrOut: "✓ Created fork someone/REPO\n✓ Cloned fork\n! Repository OWNER/REPO set as the default repository. To learn more about the default repository, run: gh repo set-default --help\n", }, { name: "repo arg interactive no clone", @@ -523,8 +527,9 @@ func TestRepoFork(t *testing.T) { cs.Register(`git clone https://github.com/someone/REPO\.git`, 0, "") cs.Register(`git -C REPO remote add upstream https://github\.com/OWNER/REPO\.git`, 0, "") cs.Register(`git -C REPO fetch upstream`, 0, "") + cs.Register(`git -C REPO config --add remote.upstream.gh-resolved base`, 0, "") }, - wantErrOut: "✓ Created fork someone/REPO\n✓ Cloned fork\n", + wantErrOut: "✓ Created fork someone/REPO\n✓ Cloned fork\n! Repository OWNER/REPO set as the default repository. To learn more about the default repository, run: gh repo set-default --help\n", }, { name: "repo arg interactive already forked", @@ -546,8 +551,9 @@ func TestRepoFork(t *testing.T) { cs.Register(`git clone https://github.com/someone/REPO\.git`, 0, "") cs.Register(`git -C REPO remote add upstream https://github\.com/OWNER/REPO\.git`, 0, "") cs.Register(`git -C REPO fetch upstream`, 0, "") + cs.Register(`git -C REPO config --add remote.upstream.gh-resolved base`, 0, "") }, - wantErrOut: "! someone/REPO already exists\n✓ Cloned fork\n", + wantErrOut: "! someone/REPO already exists\n✓ Cloned fork\n! Repository OWNER/REPO set as the default repository. To learn more about the default repository, run: gh repo set-default --help\n", }, { name: "repo arg nontty no flags", @@ -581,6 +587,7 @@ func TestRepoFork(t *testing.T) { cs.Register(`git clone https://github.com/someone/REPO\.git`, 0, "") cs.Register(`git -C REPO remote add upstream https://github\.com/OWNER/REPO\.git`, 0, "") cs.Register(`git -C REPO fetch upstream`, 0, "") + cs.Register(`git -C REPO config --add remote.upstream.gh-resolved base`, 0, "") }, wantErrOut: "someone/REPO already exists\n", }, @@ -595,6 +602,7 @@ func TestRepoFork(t *testing.T) { cs.Register(`git clone https://github.com/someone/REPO\.git`, 0, "") cs.Register(`git -C REPO remote add upstream https://github\.com/OWNER/REPO\.git`, 0, "") cs.Register(`git -C REPO fetch upstream`, 0, "") + cs.Register(`git -C REPO config --add remote.upstream.gh-resolved base`, 0, "") }, }, { @@ -684,6 +692,7 @@ func TestRepoFork(t *testing.T) { cs.Register(`git clone https://github.com/someone/REPO\.git`, 0, "") cs.Register(`git -C REPO remote add upstream https://github\.com/OWNER/REPO\.git`, 0, "") cs.Register(`git -C REPO fetch upstream`, 0, "") + cs.Register(`git -C REPO config --add remote.upstream.gh-resolved base`, 0, "") }, }, { @@ -723,11 +732,11 @@ func TestRepoFork(t *testing.T) { return &http.Client{Transport: reg}, nil } - cfg := config.NewBlankConfig() + cfg, _ := config.NewIsolatedTestConfig(t) if tt.cfgStubs != nil { - tt.cfgStubs(cfg) + tt.cfgStubs(t, cfg) } - tt.opts.Config = func() (config.Config, error) { + tt.opts.Config = func() (gh.Config, error) { return cfg, nil } diff --git a/pkg/cmd/repo/garden/garden.go b/pkg/cmd/repo/garden/garden.go index 840d5adca..d9342f9cb 100644 --- a/pkg/cmd/repo/garden/garden.go +++ b/pkg/cmd/repo/garden/garden.go @@ -13,7 +13,7 @@ import ( "strings" "github.com/cli/cli/v2/api" - "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" @@ -90,7 +90,7 @@ type GardenOptions struct { HttpClient func() (*http.Client, error) IO *iostreams.IOStreams BaseRepo func() (ghrepo.Interface, error) - Config func() (config.Config, error) + Config func() (gh.Config, error) RepoArg string } @@ -236,16 +236,15 @@ func gardenRun(opts *GardenOptions) error { } }() -mainLoop: for { oldX := player.X oldY := player.Y d := <-dirc if d == Quit { - break mainLoop + break } else if !player.move(d) { - continue mainLoop + continue } underPlayer := garden[player.Y][player.X] diff --git a/pkg/cmd/repo/list/list.go b/pkg/cmd/repo/list/list.go index e5b031794..2cee2c480 100644 --- a/pkg/cmd/repo/list/list.go +++ b/pkg/cmd/repo/list/list.go @@ -6,20 +6,21 @@ import ( "strings" "time" + "github.com/MakeNowJust/heredoc" "github.com/spf13/cobra" "github.com/cli/cli/v2/api" - "github.com/cli/cli/v2/internal/config" fd "github.com/cli/cli/v2/internal/featuredetection" + "github.com/cli/cli/v2/internal/gh" + "github.com/cli/cli/v2/internal/tableprinter" "github.com/cli/cli/v2/internal/text" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" - "github.com/cli/cli/v2/utils" ) type ListOptions struct { HttpClient func() (*http.Client, error) - Config func() (config.Config, error) + Config func() (gh.Config, error) IO *iostreams.IOStreams Exporter cmdutil.Exporter Detector fd.Detector @@ -52,9 +53,16 @@ func NewCmdList(f *cmdutil.Factory, runF func(*ListOptions) error) *cobra.Comman ) cmd := &cobra.Command{ - Use: "list []", - Args: cobra.MaximumNArgs(1), - Short: "List repositories owned by user or organization", + Use: "list []", + Args: cobra.MaximumNArgs(1), + Short: "List repositories owned by user or organization", + Long: heredoc.Docf(` + List repositories owned by a user or organization. + + Note that the list will only include repositories owned by the provided argument, + and the %[1]s--fork%[1]s or %[1]s--source%[1]s flags will not traverse ownership boundaries. For example, + when listing the forks in an organization, the output would not include those owned by individual users. + `, "`"), Aliases: []string{"ls"}, RunE: func(c *cobra.Command, args []string) error { if opts.Limit < 1 { @@ -168,9 +176,9 @@ func listRun(opts *ListOptions) error { } cs := opts.IO.ColorScheme() - //nolint:staticcheck // SA1019: utils.NewTablePrinter is deprecated: use internal/tableprinter - tp := utils.NewTablePrinter(opts.IO) + tp := tableprinter.New(opts.IO, tableprinter.WithHeader("NAME", "DESCRIPTION", "INFO", "UPDATED")) + totalMatchCount := len(listResult.Repositories) for _, repo := range listResult.Repositories { info := repoInfo(repo) infoColor := cs.Gray @@ -184,14 +192,10 @@ func listRun(opts *ListOptions) error { t = &repo.CreatedAt } - tp.AddField(repo.NameWithOwner, nil, cs.Bold) - tp.AddField(text.RemoveExcessiveWhitespace(repo.Description), nil, nil) - tp.AddField(info, nil, infoColor) - if tp.IsTTY() { - tp.AddField(text.FuzzyAgoAbbr(opts.Now(), *t), nil, cs.Gray) - } else { - tp.AddField(t.Format(time.RFC3339), nil, nil) - } + tp.AddField(repo.NameWithOwner, tableprinter.WithColor(cs.Bold)) + tp.AddField(text.RemoveExcessiveWhitespace(repo.Description)) + tp.AddField(info, tableprinter.WithColor(infoColor)) + tp.AddTimeField(opts.Now(), *t, cs.Gray) tp.EndRow() } @@ -200,11 +204,15 @@ func listRun(opts *ListOptions) error { } if opts.IO.IsStdoutTTY() { hasFilters := filter.Visibility != "" || filter.Fork || filter.Source || filter.Language != "" || len(filter.Topic) > 0 - title := listHeader(listResult.Owner, len(listResult.Repositories), listResult.TotalCount, hasFilters) + title := listHeader(listResult.Owner, totalMatchCount, listResult.TotalCount, hasFilters) fmt.Fprintf(opts.IO.Out, "\n%s\n\n", title) } - return tp.Render() + if totalMatchCount > 0 { + return tp.Render() + } + + return nil } func listHeader(owner string, matchCount, totalMatchCount int, hasFilters bool) string { diff --git a/pkg/cmd/repo/list/list_test.go b/pkg/cmd/repo/list/list_test.go index 3a02cbb22..bd51cadfc 100644 --- a/pkg/cmd/repo/list/list_test.go +++ b/pkg/cmd/repo/list/list_test.go @@ -15,6 +15,7 @@ import ( "github.com/cli/cli/v2/internal/config" fd "github.com/cli/cli/v2/internal/featuredetection" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/httpmock" "github.com/cli/cli/v2/pkg/iostreams" @@ -282,7 +283,7 @@ func runCommand(rt http.RoundTripper, isTTY bool, cli string) (*test.CmdOut, err HttpClient: func() (*http.Client, error) { return &http.Client{Transport: rt}, nil }, - Config: func() (config.Config, error) { + Config: func() (gh.Config, error) { return config.NewBlankConfig(), nil }, } @@ -325,7 +326,7 @@ func TestRepoList_nontty(t *testing.T) { HttpClient: func() (*http.Client, error) { return &http.Client{Transport: httpReg}, nil }, - Config: func() (config.Config, error) { + Config: func() (gh.Config, error) { return config.NewBlankConfig(), nil }, Now: func() time.Time { @@ -366,7 +367,7 @@ func TestRepoList_tty(t *testing.T) { HttpClient: func() (*http.Client, error) { return &http.Client{Transport: httpReg}, nil }, - Config: func() (config.Config, error) { + Config: func() (gh.Config, error) { return config.NewBlankConfig(), nil }, Now: func() time.Time { @@ -385,9 +386,10 @@ func TestRepoList_tty(t *testing.T) { Showing 3 of 3 repositories in @octocat - octocat/hello-world My first repository public 8h - octocat/cli GitHub CLI public, fork 8h - octocat/testing private 7d + NAME DESCRIPTION INFO UPDATED + octocat/hello-world My first repository public about 8 hours ago + octocat/cli GitHub CLI public, fork about 8 hours ago + octocat/testing private about 7 days ago `), stdout.String()) } @@ -435,7 +437,7 @@ func TestRepoList_noVisibilityField(t *testing.T) { HttpClient: func() (*http.Client, error) { return &http.Client{Transport: reg}, nil }, - Config: func() (config.Config, error) { + Config: func() (gh.Config, error) { return config.NewBlankConfig(), nil }, Now: func() time.Time { @@ -473,7 +475,7 @@ func TestRepoList_invalidOwner(t *testing.T) { HttpClient: func() (*http.Client, error) { return &http.Client{Transport: reg}, nil }, - Config: func() (config.Config, error) { + Config: func() (gh.Config, error) { return config.NewBlankConfig(), nil }, Now: func() time.Time { diff --git a/pkg/cmd/repo/rename/rename.go b/pkg/cmd/repo/rename/rename.go index 973eb7bd6..3676f93fe 100644 --- a/pkg/cmd/repo/rename/rename.go +++ b/pkg/cmd/repo/rename/rename.go @@ -9,7 +9,7 @@ import ( "github.com/cli/cli/v2/api" ghContext "github.com/cli/cli/v2/context" "github.com/cli/cli/v2/git" - "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" @@ -26,7 +26,7 @@ type RenameOptions struct { GitClient *git.Client IO *iostreams.IOStreams Prompter iprompter - Config func() (config.Config, error) + Config func() (gh.Config, error) BaseRepo func() (ghrepo.Interface, error) Remotes func() (ghContext.Remotes, error) DoConfirm bool @@ -135,7 +135,11 @@ func renameRun(opts *RenameOptions) error { remote, err := updateRemote(currRepo, newRepo, opts) if err != nil { - fmt.Fprintf(opts.IO.ErrOut, "%s Warning: unable to update remote %q: %v\n", cs.WarningIcon(), remote.Name, err) + if remote != nil { + fmt.Fprintf(opts.IO.ErrOut, "%s Warning: unable to update remote %q: %v\n", cs.WarningIcon(), remote.Name, err) + } else { + fmt.Fprintf(opts.IO.ErrOut, "%s Warning: unable to update remote: %v\n", cs.WarningIcon(), err) + } } else if opts.IO.IsStdoutTTY() { fmt.Fprintf(opts.IO.Out, "%s Updated the %q remote\n", cs.SuccessIcon(), remote.Name) } @@ -149,10 +153,7 @@ func updateRemote(repo ghrepo.Interface, renamed ghrepo.Interface, opts *RenameO return nil, err } - protocol, err := cfg.GetOrDefault(repo.RepoHost(), "git_protocol") - if err != nil { - return nil, err - } + protocol := cfg.GitProtocol(repo.RepoHost()).Value remotes, err := opts.Remotes() if err != nil { diff --git a/pkg/cmd/repo/rename/rename_test.go b/pkg/cmd/repo/rename/rename_test.go index 68499b2fa..da40e51b0 100644 --- a/pkg/cmd/repo/rename/rename_test.go +++ b/pkg/cmd/repo/rename/rename_test.go @@ -8,6 +8,7 @@ import ( "github.com/cli/cli/v2/context" "github.com/cli/cli/v2/git" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/internal/prompter" "github.com/cli/cli/v2/internal/run" @@ -230,7 +231,7 @@ func TestRenameRun(t *testing.T) { return repo, nil } - tt.opts.Config = func() (config.Config, error) { + tt.opts.Config = func() (gh.Config, error) { return config.NewBlankConfig(), nil } diff --git a/pkg/cmd/repo/setdefault/setdefault.go b/pkg/cmd/repo/setdefault/setdefault.go index d5a03baf1..d54d3956a 100644 --- a/pkg/cmd/repo/setdefault/setdefault.go +++ b/pkg/cmd/repo/setdefault/setdefault.go @@ -29,7 +29,7 @@ func explainer() string { - viewing and creating pull requests - viewing and creating issues - viewing and creating releases - - working with Actions + - working with GitHub Actions - adding repository and environment secrets`) } diff --git a/pkg/cmd/repo/setdefault/setdefault_test.go b/pkg/cmd/repo/setdefault/setdefault_test.go index 58871f75b..a89effa14 100644 --- a/pkg/cmd/repo/setdefault/setdefault_test.go +++ b/pkg/cmd/repo/setdefault/setdefault_test.go @@ -379,7 +379,7 @@ func TestDefaultRun(t *testing.T) { } } }, - wantStdout: "This command sets the default remote repository to use when querying the\nGitHub API for the locally cloned repository.\n\ngh uses the default repository for things like:\n\n - viewing and creating pull requests\n - viewing and creating issues\n - viewing and creating releases\n - working with Actions\n - adding repository and environment secrets\n\n✓ Set OWNER2/REPO2 as the default repository for the current directory\n", + wantStdout: "This command sets the default remote repository to use when querying the\nGitHub API for the locally cloned repository.\n\ngh uses the default repository for things like:\n\n - viewing and creating pull requests\n - viewing and creating issues\n - viewing and creating releases\n - working with GitHub Actions\n - adding repository and environment secrets\n\n✓ Set OWNER2/REPO2 as the default repository for the current directory\n", }, { name: "interactive mode only one known host", @@ -453,7 +453,7 @@ func TestDefaultRun(t *testing.T) { } } }, - wantStdout: "This command sets the default remote repository to use when querying the\nGitHub API for the locally cloned repository.\n\ngh uses the default repository for things like:\n\n - viewing and creating pull requests\n - viewing and creating issues\n - viewing and creating releases\n - working with Actions\n - adding repository and environment secrets\n\n✓ Set OWNER2/REPO2 as the default repository for the current directory\n", + wantStdout: "This command sets the default remote repository to use when querying the\nGitHub API for the locally cloned repository.\n\ngh uses the default repository for things like:\n\n - viewing and creating pull requests\n - viewing and creating issues\n - viewing and creating releases\n - working with GitHub Actions\n - adding repository and environment secrets\n\n✓ Set OWNER2/REPO2 as the default repository for the current directory\n", }, } diff --git a/pkg/cmd/repo/sync/git.go b/pkg/cmd/repo/sync/git.go index 48429f2bb..1f18d0fdb 100644 --- a/pkg/cmd/repo/sync/git.go +++ b/pkg/cmd/repo/sync/git.go @@ -3,13 +3,11 @@ package sync import ( "context" "fmt" - "strings" "github.com/cli/cli/v2/git" ) type gitClient interface { - BranchRemote(string) (string, error) CurrentBranch() (string, error) UpdateBranch(string, string) error CreateBranch(string, string, string) error @@ -25,20 +23,6 @@ type gitExecuter struct { client *git.Client } -func (g *gitExecuter) BranchRemote(branch string) (string, error) { - args := []string{"rev-parse", "--symbolic-full-name", "--abbrev-ref", fmt.Sprintf("%s@{u}", branch)} - cmd, err := g.client.Command(context.Background(), args...) - if err != nil { - return "", err - } - out, err := cmd.Output() - if err != nil { - return "", err - } - parts := strings.SplitN(string(out), "/", 2) - return parts[0], nil -} - func (g *gitExecuter) UpdateBranch(branch, ref string) error { cmd, err := g.client.Command(context.Background(), "update-ref", fmt.Sprintf("refs/heads/%s", branch), ref) if err != nil { diff --git a/pkg/cmd/repo/sync/mocks.go b/pkg/cmd/repo/sync/mocks.go index 718a89054..c852e03f2 100644 --- a/pkg/cmd/repo/sync/mocks.go +++ b/pkg/cmd/repo/sync/mocks.go @@ -8,11 +8,6 @@ type mockGitClient struct { mock.Mock } -func (g *mockGitClient) BranchRemote(a string) (string, error) { - args := g.Called(a) - return args.String(0), args.Error(1) -} - func (g *mockGitClient) UpdateBranch(b, r string) error { args := g.Called(b, r) return args.Error(0) diff --git a/pkg/cmd/repo/sync/sync.go b/pkg/cmd/repo/sync/sync.go index dd52868d1..87badc7a1 100644 --- a/pkg/cmd/repo/sync/sync.go +++ b/pkg/cmd/repo/sync/sync.go @@ -46,7 +46,7 @@ func NewCmdSync(f *cmdutil.Factory, runF func(*SyncOptions) error) *cobra.Comman Use: "sync []", Short: "Sync a repository", Long: heredoc.Docf(` - Sync destination repository from source repository. Syncing uses the main branch + Sync destination repository from source repository. Syncing uses the default branch of the source repository to update the matching branch on the destination repository so they are equal. A fast forward update will be used except when the %[1]s--force%[1]s flag is specified, then the two branches will @@ -83,7 +83,7 @@ func NewCmdSync(f *cmdutil.Factory, runF func(*SyncOptions) error) *cobra.Comman } cmd.Flags().StringVarP(&opts.SrcArg, "source", "s", "", "Source repository") - cmd.Flags().StringVarP(&opts.Branch, "branch", "b", "", "Branch to sync (default: main branch)") + cmd.Flags().StringVarP(&opts.Branch, "branch", "b", "", "Branch to sync (default [default branch])") cmd.Flags().BoolVarP(&opts.Force, "force", "", false, "Hard reset the branch of the destination repository to match the source repository") return cmd } @@ -151,9 +151,6 @@ func syncLocalRepo(opts *SyncOptions) error { if errors.Is(err, divergingError) { return fmt.Errorf("can't sync because there are diverging changes; use `--force` to overwrite the destination branch") } - if errors.Is(err, mismatchRemotesError) { - return fmt.Errorf("can't sync because %s is not tracking %s", opts.Branch, ghrepo.FullName(srcRepo)) - } return err } @@ -220,7 +217,6 @@ func syncRemoteRepo(opts *SyncOptions) error { } var divergingError = errors.New("diverging changes") -var mismatchRemotesError = errors.New("branch remote does not match specified source") func executeLocalRepoSync(srcRepo ghrepo.Interface, remote string, opts *SyncOptions) error { git := opts.Git @@ -229,19 +225,10 @@ func executeLocalRepoSync(srcRepo ghrepo.Interface, remote string, opts *SyncOpt hasLocalBranch := git.HasLocalBranch(branch) if hasLocalBranch { - branchRemote, err := git.BranchRemote(branch) - if err != nil { - return err - } - if branchRemote != remote { - return mismatchRemotesError - } - fastForward, err := git.IsAncestor(branch, "FETCH_HEAD") if err != nil { return err } - if !fastForward && !useForce { return divergingError } diff --git a/pkg/cmd/repo/sync/sync_test.go b/pkg/cmd/repo/sync/sync_test.go index eafc0835e..8b9e4352f 100644 --- a/pkg/cmd/repo/sync/sync_test.go +++ b/pkg/cmd/repo/sync/sync_test.go @@ -122,12 +122,11 @@ func Test_SyncRun(t *testing.T) { httpmock.StringResponse(`{"data":{"repository":{"defaultBranchRef":{"name": "trunk"}}}}`)) }, gitStubs: func(mgc *mockGitClient) { - mgc.On("IsDirty").Return(false, nil).Once() mgc.On("Fetch", "origin", "refs/heads/trunk").Return(nil).Once() mgc.On("HasLocalBranch", "trunk").Return(true).Once() - mgc.On("BranchRemote", "trunk").Return("origin", nil).Once() mgc.On("IsAncestor", "trunk", "FETCH_HEAD").Return(true, nil).Once() mgc.On("CurrentBranch").Return("trunk", nil).Once() + mgc.On("IsDirty").Return(false, nil).Once() mgc.On("MergeFastForward", "FETCH_HEAD").Return(nil).Once() }, wantStdout: "✓ Synced the \"trunk\" branch from OWNER/REPO to local repository\n", @@ -139,12 +138,11 @@ func Test_SyncRun(t *testing.T) { Branch: "trunk", }, gitStubs: func(mgc *mockGitClient) { - mgc.On("IsDirty").Return(false, nil).Once() mgc.On("Fetch", "origin", "refs/heads/trunk").Return(nil).Once() mgc.On("HasLocalBranch", "trunk").Return(true).Once() - mgc.On("BranchRemote", "trunk").Return("origin", nil).Once() mgc.On("IsAncestor", "trunk", "FETCH_HEAD").Return(true, nil).Once() mgc.On("CurrentBranch").Return("trunk", nil).Once() + mgc.On("IsDirty").Return(false, nil).Once() mgc.On("MergeFastForward", "FETCH_HEAD").Return(nil).Once() }, wantStdout: "", @@ -157,12 +155,11 @@ func Test_SyncRun(t *testing.T) { SrcArg: "OWNER2/REPO2", }, gitStubs: func(mgc *mockGitClient) { - mgc.On("IsDirty").Return(false, nil).Once() mgc.On("Fetch", "upstream", "refs/heads/trunk").Return(nil).Once() mgc.On("HasLocalBranch", "trunk").Return(true).Once() - mgc.On("BranchRemote", "trunk").Return("upstream", nil).Once() mgc.On("IsAncestor", "trunk", "FETCH_HEAD").Return(true, nil).Once() mgc.On("CurrentBranch").Return("trunk", nil).Once() + mgc.On("IsDirty").Return(false, nil).Once() mgc.On("MergeFastForward", "FETCH_HEAD").Return(nil).Once() }, wantStdout: "✓ Synced the \"trunk\" branch from OWNER2/REPO2 to local repository\n", @@ -175,16 +172,33 @@ func Test_SyncRun(t *testing.T) { Force: true, }, gitStubs: func(mgc *mockGitClient) { - mgc.On("IsDirty").Return(false, nil).Once() mgc.On("Fetch", "origin", "refs/heads/trunk").Return(nil).Once() mgc.On("HasLocalBranch", "trunk").Return(true).Once() - mgc.On("BranchRemote", "trunk").Return("origin", nil).Once() mgc.On("IsAncestor", "trunk", "FETCH_HEAD").Return(false, nil).Once() mgc.On("CurrentBranch").Return("trunk", nil).Once() + mgc.On("IsDirty").Return(false, nil).Once() mgc.On("ResetHard", "FETCH_HEAD").Return(nil).Once() }, wantStdout: "✓ Synced the \"trunk\" branch from OWNER/REPO to local repository\n", }, + { + name: "sync local repo with specified source repo and force specified", + tty: true, + opts: &SyncOptions{ + Branch: "trunk", + SrcArg: "OWNER2/REPO2", + Force: true, + }, + gitStubs: func(mgc *mockGitClient) { + mgc.On("Fetch", "upstream", "refs/heads/trunk").Return(nil).Once() + mgc.On("HasLocalBranch", "trunk").Return(true).Once() + mgc.On("IsAncestor", "trunk", "FETCH_HEAD").Return(false, nil).Once() + mgc.On("CurrentBranch").Return("trunk", nil).Once() + mgc.On("IsDirty").Return(false, nil).Once() + mgc.On("ResetHard", "FETCH_HEAD").Return(nil).Once() + }, + wantStdout: "✓ Synced the \"trunk\" branch from OWNER2/REPO2 to local repository\n", + }, { name: "sync local repo with parent and not fast forward merge", tty: true, @@ -194,25 +208,25 @@ func Test_SyncRun(t *testing.T) { gitStubs: func(mgc *mockGitClient) { mgc.On("Fetch", "origin", "refs/heads/trunk").Return(nil).Once() mgc.On("HasLocalBranch", "trunk").Return(true).Once() - mgc.On("BranchRemote", "trunk").Return("origin", nil).Once() mgc.On("IsAncestor", "trunk", "FETCH_HEAD").Return(false, nil).Once() }, wantErr: true, errMsg: "can't sync because there are diverging changes; use `--force` to overwrite the destination branch", }, { - name: "sync local repo with parent and mismatching branch remotes", + name: "sync local repo with specified source repo and not fast forward merge", tty: true, opts: &SyncOptions{ Branch: "trunk", + SrcArg: "OWNER2/REPO2", }, gitStubs: func(mgc *mockGitClient) { - mgc.On("Fetch", "origin", "refs/heads/trunk").Return(nil).Once() + mgc.On("Fetch", "upstream", "refs/heads/trunk").Return(nil).Once() mgc.On("HasLocalBranch", "trunk").Return(true).Once() - mgc.On("BranchRemote", "trunk").Return("upstream", nil).Once() + mgc.On("IsAncestor", "trunk", "FETCH_HEAD").Return(false, nil).Once() }, wantErr: true, - errMsg: "can't sync because trunk is not tracking OWNER/REPO", + errMsg: "can't sync because there are diverging changes; use `--force` to overwrite the destination branch", }, { name: "sync local repo with parent and local changes", @@ -223,7 +237,6 @@ func Test_SyncRun(t *testing.T) { gitStubs: func(mgc *mockGitClient) { mgc.On("Fetch", "origin", "refs/heads/trunk").Return(nil).Once() mgc.On("HasLocalBranch", "trunk").Return(true).Once() - mgc.On("BranchRemote", "trunk").Return("origin", nil).Once() mgc.On("IsAncestor", "trunk", "FETCH_HEAD").Return(true, nil).Once() mgc.On("CurrentBranch").Return("trunk", nil).Once() mgc.On("IsDirty").Return(true, nil).Once() @@ -240,7 +253,6 @@ func Test_SyncRun(t *testing.T) { gitStubs: func(mgc *mockGitClient) { mgc.On("Fetch", "origin", "refs/heads/trunk").Return(nil).Once() mgc.On("HasLocalBranch", "trunk").Return(true).Once() - mgc.On("BranchRemote", "trunk").Return("origin", nil).Once() mgc.On("IsAncestor", "trunk", "FETCH_HEAD").Return(true, nil).Once() mgc.On("CurrentBranch").Return("test", nil).Once() mgc.On("UpdateBranch", "trunk", "FETCH_HEAD").Return(nil).Once() diff --git a/pkg/cmd/repo/unarchive/unarchive.go b/pkg/cmd/repo/unarchive/unarchive.go index 08108f211..74d84a779 100644 --- a/pkg/cmd/repo/unarchive/unarchive.go +++ b/pkg/cmd/repo/unarchive/unarchive.go @@ -7,7 +7,7 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/api" - "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/internal/prompter" "github.com/cli/cli/v2/pkg/cmdutil" @@ -17,7 +17,7 @@ import ( type UnarchiveOptions struct { HttpClient func() (*http.Client, error) - Config func() (config.Config, error) + Config func() (gh.Config, error) BaseRepo func() (ghrepo.Interface, error) Confirmed bool IO *iostreams.IOStreams diff --git a/pkg/cmd/repo/view/view.go b/pkg/cmd/repo/view/view.go index 3351d9cd9..136384152 100644 --- a/pkg/cmd/repo/view/view.go +++ b/pkg/cmd/repo/view/view.go @@ -11,7 +11,7 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/api" "github.com/cli/cli/v2/internal/browser" - "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/internal/text" "github.com/cli/cli/v2/pkg/cmdutil" @@ -26,7 +26,7 @@ type ViewOptions struct { BaseRepo func() (ghrepo.Interface, error) Browser browser.Browser Exporter cmdutil.Exporter - Config func() (config.Config, error) + Config func() (gh.Config, error) RepoArg string Web bool diff --git a/pkg/cmd/repo/view/view_test.go b/pkg/cmd/repo/view/view_test.go index 16b525783..a8361e9ef 100644 --- a/pkg/cmd/repo/view/view_test.go +++ b/pkg/cmd/repo/view/view_test.go @@ -10,6 +10,7 @@ import ( "github.com/cli/cli/v2/api" "github.com/cli/cli/v2/internal/browser" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/gh" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/internal/run" "github.com/cli/cli/v2/pkg/cmdutil" @@ -530,7 +531,7 @@ func Test_ViewRun_WithoutUsername(t *testing.T) { return &http.Client{Transport: reg}, nil }, IO: io, - Config: func() (config.Config, error) { + Config: func() (gh.Config, error) { return config.NewBlankConfig(), nil }, } diff --git a/pkg/cmd/root/help.go b/pkg/cmd/root/help.go index 860fb22c3..ee5db5e68 100644 --- a/pkg/cmd/root/help.go +++ b/pkg/cmd/root/help.go @@ -131,6 +131,10 @@ func rootHelpFunc(f *cmdutil.Factory, command *cobra.Command, args []string) { } helpEntries = append(helpEntries, helpEntry{"USAGE", command.UseLine()}) + if len(command.Aliases) > 0 { + helpEntries = append(helpEntries, helpEntry{"ALIASES", strings.Join(BuildAliasList(command, command.Aliases), ", ") + "\n"}) + } + for _, g := range GroupedCommands(command) { var names []string for _, c := range g.Commands { @@ -162,6 +166,10 @@ func rootHelpFunc(f *cmdutil.Factory, command *cobra.Command, args []string) { if inheritedFlagUsages != "" { helpEntries = append(helpEntries, helpEntry{"INHERITED FLAGS", dedent(inheritedFlagUsages)}) } + if _, ok := command.Annotations["help:json-fields"]; ok { + fields := strings.Split(command.Annotations["help:json-fields"], ",") + helpEntries = append(helpEntries, helpEntry{"JSON FIELDS", text.FormatSlice(fields, 80, 0, "", "", true)}) + } if _, ok := command.Annotations["help:arguments"]; ok { helpEntries = append(helpEntries, helpEntry{"ARGUMENTS", command.Annotations["help:arguments"]}) } @@ -171,9 +179,10 @@ func rootHelpFunc(f *cmdutil.Factory, command *cobra.Command, args []string) { if _, ok := command.Annotations["help:environment"]; ok { helpEntries = append(helpEntries, helpEntry{"ENVIRONMENT VARIABLES", command.Annotations["help:environment"]}) } - helpEntries = append(helpEntries, helpEntry{"LEARN MORE", ` -Use 'gh --help' for more information about a command. -Read the manual at https://cli.github.com/manual`}) + helpEntries = append(helpEntries, helpEntry{"LEARN MORE", heredoc.Docf(` + Use %[1]sgh --help%[1]s for more information about a command. + Read the manual at https://cli.github.com/manual + `, "`")}) out := f.IOStreams.Out for _, e := range helpEntries { @@ -293,3 +302,24 @@ func dedent(s string) string { } return strings.TrimSuffix(buf.String(), "\n") } + +func BuildAliasList(cmd *cobra.Command, aliases []string) []string { + if !cmd.HasParent() { + return aliases + } + + parentAliases := append(cmd.Parent().Aliases, cmd.Parent().Name()) + sort.Strings(parentAliases) + + var aliasesWithParentAliases []string + // e.g aliases = [ls] + for _, alias := range aliases { + // e.g parentAliases = [codespaces, cs] + for _, parentAlias := range parentAliases { + // e.g. aliasesWithParentAliases = [codespaces list, codespaces ls, cs list, cs ls] + aliasesWithParentAliases = append(aliasesWithParentAliases, fmt.Sprintf("%s %s", parentAlias, alias)) + } + } + + return BuildAliasList(cmd.Parent(), aliasesWithParentAliases) +} diff --git a/pkg/cmd/root/help_reference.go b/pkg/cmd/root/help_reference.go index 76e9db24e..fb2e74aa0 100644 --- a/pkg/cmd/root/help_reference.go +++ b/pkg/cmd/root/help_reference.go @@ -62,6 +62,12 @@ func cmdRef(w io.Writer, cmd *cobra.Command, depth int) { fmt.Fprintf(w, "```\n%s````\n\n", dedent(flagUsages)) } + // Aliases + if len(cmd.Aliases) > 0 { + fmt.Fprintf(w, "%s\n\n", "Aliases") + fmt.Fprintf(w, "\n%s\n\n", dedent(strings.Join(BuildAliasList(cmd, cmd.Aliases), ", "))) + } + // Subcommands for _, c := range cmd.Commands() { if c.Hidden { diff --git a/pkg/cmd/root/help_topic.go b/pkg/cmd/root/help_topic.go index 7db694668..f04a573fd 100644 --- a/pkg/cmd/root/help_topic.go +++ b/pkg/cmd/root/help_topic.go @@ -21,7 +21,7 @@ var HelpTopics = []helpTopic{ { name: "mintty", short: "Information about using gh with MinTTY", - long: heredoc.Doc(` + long: heredoc.Docf(` MinTTY is the terminal emulator that comes by default with Git for Windows. It has known issues with gh's ability to prompt a user for input. @@ -31,75 +31,75 @@ var HelpTopics = []helpTopic{ - Reinstall Git for Windows, checking "Enable experimental support for pseudo consoles". - Use a different terminal emulator with Git for Windows like Windows Terminal. - You can run "C:\Program Files\Git\bin\bash.exe" from any terminal emulator to continue + You can run %[1]sC:\Program Files\Git\bin\bash.exe%[1]s from any terminal emulator to continue using all of the tooling in Git For Windows without MinTTY. - - Prefix invocations of gh with winpty, eg: "winpty gh auth login". + - Prefix invocations of gh with %[1]swinpty%[1]s, eg: %[1]swinpty gh auth login%[1]s. NOTE: this can lead to some UI bugs. - `), + `, "`"), }, { name: "environment", short: "Environment variables that can be used with gh", - long: heredoc.Doc(` - GH_TOKEN, GITHUB_TOKEN (in order of precedence): an authentication token for github.com + long: heredoc.Docf(` + %[1]sGH_TOKEN%[1]s, %[1]sGITHUB_TOKEN%[1]s (in order of precedence): an authentication token for github.com API requests. Setting this avoids being prompted to authenticate and takes precedence over previously stored credentials. - GH_ENTERPRISE_TOKEN, GITHUB_ENTERPRISE_TOKEN (in order of precedence): an authentication - token for API requests to GitHub Enterprise. When setting this, also set GH_HOST. + %[1]sGH_ENTERPRISE_TOKEN%[1]s, %[1]sGITHUB_ENTERPRISE_TOKEN%[1]s (in order of precedence): an authentication + token for API requests to GitHub Enterprise. When setting this, also set %[1]sGH_HOST%[1]s. - GH_HOST: specify the GitHub hostname for commands that would otherwise assume the + %[1]sGH_HOST%[1]s: specify the GitHub hostname for commands that would otherwise assume the "github.com" host when not in a context of an existing repository. When setting this, - also set GH_ENTERPRISE_TOKEN. + also set %[1]sGH_ENTERPRISE_TOKEN%[1]s. - GH_REPO: specify the GitHub repository in the "[HOST/]OWNER/REPO" format for commands + %[1]sGH_REPO%[1]s: specify the GitHub repository in the %[1]s[HOST/]OWNER/REPO%[1]s format for commands that otherwise operate on a local repository. - GH_EDITOR, GIT_EDITOR, VISUAL, EDITOR (in order of precedence): the editor tool to use + %[1]sGH_EDITOR%[1]s, %[1]sGIT_EDITOR%[1]s, %[1]sVISUAL%[1]s, %[1]sEDITOR%[1]s (in order of precedence): the editor tool to use for authoring text. - GH_BROWSER, BROWSER (in order of precedence): the web browser to use for opening links. + %[1]sGH_BROWSER%[1]s, %[1]sBROWSER%[1]s (in order of precedence): the web browser to use for opening links. - GH_DEBUG: set to a truthy value to enable verbose output on standard error. Set to "api" + %[1]sGH_DEBUG%[1]s: set to a truthy value to enable verbose output on standard error. Set to %[1]sapi%[1]s to additionally log details of HTTP traffic. - DEBUG (deprecated): set to "1", "true", or "yes" to enable verbose output on standard + %[1]sDEBUG%[1]s (deprecated): set to %[1]s1%[1]s, %[1]strue%[1]s, or %[1]syes%[1]s to enable verbose output on standard error. - GH_PAGER, PAGER (in order of precedence): a terminal paging program to send standard output - to, e.g. "less". + %[1]sGH_PAGER%[1]s, %[1]sPAGER%[1]s (in order of precedence): a terminal paging program to send standard output + to, e.g. %[1]sless%[1]s. - GLAMOUR_STYLE: the style to use for rendering Markdown. See + %[1]sGLAMOUR_STYLE%[1]s: the style to use for rendering Markdown. See - NO_COLOR: set to any value to avoid printing ANSI escape sequences for color output. + %[1]sNO_COLOR%[1]s: set to any value to avoid printing ANSI escape sequences for color output. - CLICOLOR: set to "0" to disable printing ANSI colors in output. + %[1]sCLICOLOR%[1]s: set to %[1]s0%[1]s to disable printing ANSI colors in output. - CLICOLOR_FORCE: set to a value other than "0" to keep ANSI colors in output + %[1]sCLICOLOR_FORCE%[1]s: set to a value other than %[1]s0%[1]s to keep ANSI colors in output even when the output is piped. - GH_FORCE_TTY: set to any value to force terminal-style output even when the output is + %[1]sGH_FORCE_TTY%[1]s: set to any value to force terminal-style output even when the output is redirected. When the value is a number, it is interpreted as the number of columns available in the viewport. When the value is a percentage, it will be applied against the number of columns available in the current viewport. - GH_NO_UPDATE_NOTIFIER: set to any value to disable update notifications. By default, gh + %[1]sGH_NO_UPDATE_NOTIFIER%[1]s: set to any value to disable update notifications. By default, gh checks for new releases once every 24 hours and displays an upgrade notice on standard error if a newer version was found. - GH_CONFIG_DIR: the directory where gh will store configuration files. If not specified, + %[1]sGH_CONFIG_DIR%[1]s: the directory where gh will store configuration files. If not specified, the default value will be one of the following paths (in order of precedence): - - "$XDG_CONFIG_HOME/gh" (if $XDG_CONFIG_HOME is set), - - "$AppData/GitHub CLI" (on Windows if $AppData is set), or - - "$HOME/.config/gh". + - %[1]s$XDG_CONFIG_HOME/gh%[1]s (if %[1]s$XDG_CONFIG_HOME%[1]s is set), + - %[1]s$AppData/GitHub CLI%[1]s (on Windows if %[1]s$AppData%[1]s is set), or + - %[1]s$HOME/.config/gh%[1]s. - GH_PROMPT_DISABLED: set to any value to disable interactive prompting in the terminal. + %[1]sGH_PROMPT_DISABLED%[1]s: set to any value to disable interactive prompting in the terminal. - GH_PATH: set the path to the gh executable, useful for when gh can not properly determine + %[1]sGH_PATH%[1]s: set the path to the gh executable, useful for when gh can not properly determine its own path such as in the cygwin terminal. - `), + `, "`"), }, { name: "reference", @@ -122,10 +122,10 @@ var HelpTopics = []helpTopic{ The %[1]s--jq%[1]s flag requires a string argument in jq query syntax, and will only print those JSON values which match the query. jq queries can be used to select elements from an - array, fields from an object, create a new array, and more. The jq utility does not need + array, fields from an object, create a new array, and more. The %[1]sjq%[1]s utility does not need to be installed on the system to use this formatting directive. When connected to a terminal, the output is automatically pretty-printed. To learn about jq query syntax, see: - + The %[1]s--template%[1]s flag requires a string argument in Go template syntax, and will only print those JSON values which match the query. @@ -138,7 +138,7 @@ var HelpTopics = []helpTopic{ - %[1]stablerow ...%[1]s: aligns fields in output vertically as a table - %[1]stablerender%[1]s: renders fields added by tablerow in place - %[1]stimeago