Merge branch 'trunk' of github.com:cli/cli into 7771-list-all-run-jobs

* 'trunk' of github.com:cli/cli:
  Add JSON output flags to workflow list command (#7902)
  Add config clear-cache command (#7693)
  Allow --disable-wiki flag with --template flag in repo create command (#7886)
  Reword token invalid message (#7906)
  🐛 (repo create)execute clone when readme option is enabled (#7837)
  Use go-gh prompter package (#7896)
  pr checks return distinct exit code for PENDING checks (#7866)
  Properly rename remote for GHES hosts (#7890)
  Add verbose flag to api cmd (#7826)
  Fix up Nix installation instructions (#7891)
This commit is contained in:
Harvey Sanders 2023-08-31 09:34:47 -04:00
commit 656d83848b
33 changed files with 660 additions and 771 deletions

View file

@ -23,6 +23,7 @@ type HTTPClientOptions struct {
EnableCache bool
Log io.Writer
LogColorize bool
LogVerboseHTTP bool
SkipAcceptHeaders bool
}
@ -35,10 +36,15 @@ func NewHTTPClient(opts HTTPClientOptions) (*http.Client, error) {
LogIgnoreEnv: true,
}
if debugEnabled, debugValue := utils.IsDebugEnabled(); debugEnabled {
debugEnabled, debugValue := utils.IsDebugEnabled()
if strings.Contains(debugValue, "api") {
opts.LogVerboseHTTP = true
}
if opts.LogVerboseHTTP || debugEnabled {
clientOpts.Log = opts.Log
clientOpts.LogColorize = opts.LogColorize
clientOpts.LogVerboseHTTP = strings.Contains(debugValue, "api")
clientOpts.LogVerboseHTTP = opts.LogVerboseHTTP
}
headers := map[string]string{

View file

@ -6,7 +6,6 @@ import (
"io"
"net/http"
"net/http/httptest"
"os"
"regexp"
"strings"
"testing"
@ -19,16 +18,14 @@ import (
func TestNewHTTPClient(t *testing.T) {
type args struct {
config tokenGetter
appVersion string
setAccept bool
config tokenGetter
appVersion string
setAccept bool
logVerboseHTTP bool
}
tests := []struct {
name string
args args
envDebug string
setGhDebug bool
envGhDebug string
host string
wantHeader map[string]string
wantStderr string
@ -36,9 +33,10 @@ func TestNewHTTPClient(t *testing.T) {
{
name: "github.com with Accept header",
args: args{
config: tinyConfig{"github.com:oauth_token": "MYTOKEN"},
appVersion: "v1.2.3",
setAccept: true,
config: tinyConfig{"github.com:oauth_token": "MYTOKEN"},
appVersion: "v1.2.3",
setAccept: true,
logVerboseHTTP: false,
},
host: "github.com",
wantHeader: map[string]string{
@ -51,9 +49,10 @@ func TestNewHTTPClient(t *testing.T) {
{
name: "github.com no Accept header",
args: args{
config: tinyConfig{"github.com:oauth_token": "MYTOKEN"},
appVersion: "v1.2.3",
setAccept: false,
config: tinyConfig{"github.com:oauth_token": "MYTOKEN"},
appVersion: "v1.2.3",
setAccept: false,
logVerboseHTTP: false,
},
host: "github.com",
wantHeader: map[string]string{
@ -66,9 +65,10 @@ func TestNewHTTPClient(t *testing.T) {
{
name: "github.com no authentication token",
args: args{
config: tinyConfig{"example.com:oauth_token": "MYTOKEN"},
appVersion: "v1.2.3",
setAccept: true,
config: tinyConfig{"example.com:oauth_token": "MYTOKEN"},
appVersion: "v1.2.3",
setAccept: true,
logVerboseHTTP: false,
},
host: "github.com",
wantHeader: map[string]string{
@ -81,45 +81,12 @@ func TestNewHTTPClient(t *testing.T) {
{
name: "github.com in verbose mode",
args: args{
config: tinyConfig{"github.com:oauth_token": "MYTOKEN"},
appVersion: "v1.2.3",
setAccept: true,
config: tinyConfig{"github.com:oauth_token": "MYTOKEN"},
appVersion: "v1.2.3",
setAccept: true,
logVerboseHTTP: true,
},
host: "github.com",
envDebug: "api",
setGhDebug: false,
wantHeader: map[string]string{
"authorization": "token MYTOKEN",
"user-agent": "GitHub CLI v1.2.3",
"accept": "application/vnd.github.merge-info-preview+json, application/vnd.github.nebula-preview",
},
wantStderr: heredoc.Doc(`
* Request at <time>
* Request to http://<host>:<port>
> GET / HTTP/1.1
> Host: github.com
> Accept: application/vnd.github.merge-info-preview+json, application/vnd.github.nebula-preview
> Authorization: token
> Content-Type: application/json; charset=utf-8
> Time-Zone: <timezone>
> User-Agent: GitHub CLI v1.2.3
< HTTP/1.1 204 No Content
< Date: <time>
* Request took <duration>
`),
},
{
name: "github.com in verbose mode",
args: args{
config: tinyConfig{"github.com:oauth_token": "MYTOKEN"},
appVersion: "v1.2.3",
setAccept: true,
},
host: "github.com",
envGhDebug: "api",
setGhDebug: true,
host: "github.com",
wantHeader: map[string]string{
"authorization": "token MYTOKEN",
"user-agent": "GitHub CLI v1.2.3",
@ -168,19 +135,13 @@ func TestNewHTTPClient(t *testing.T) {
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
t.Setenv("DEBUG", tt.envDebug)
if tt.setGhDebug {
t.Setenv("GH_DEBUG", tt.envGhDebug)
} else {
os.Unsetenv("GH_DEBUG")
}
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,
})
require.NoError(t, err)

View file

@ -34,10 +34,11 @@ var updaterEnabled = ""
type exitCode int
const (
exitOK exitCode = 0
exitError exitCode = 1
exitCancel exitCode = 2
exitAuth exitCode = 4
exitOK exitCode = 0
exitError exitCode = 1
exitCancel exitCode = 2
exitAuth exitCode = 4
exitPending exitCode = 8
)
func main() {
@ -113,6 +114,8 @@ func mainRun() exitCode {
var authError *root.AuthError
if err == cmdutil.SilentError {
return exitError
} else if err == cmdutil.PendingError {
return exitPending
} else if cmdutil.IsUserCancellation(err) {
if errors.Is(err, terminal.InterruptErr) {
// ensure the next shell prompt will start on its own line

View file

@ -197,10 +197,10 @@ kiss b github-cli && kiss i github-cli
### Nix/NixOS
Nix/NixOS users can install from [nixpkgs](https://search.nixos.org/packages?show=gitAndTools.gh&query=gh&from=0&size=30&sort=relevance&channel=20.03#disabled):
Nix/NixOS users can install from [nixpkgs](https://search.nixos.org/packages?query=gh&sort=relevance&show=gh):
```bash
nix-env -iA nixos.gitAndTools.gh
nix-env -iA nixos.gh
```
### openSUSE Tumbleweed

11
go.mod
View file

@ -7,9 +7,9 @@ require (
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.5.1-0.20220727184942-e70ff2d969da
github.com/charmbracelet/glamour v0.6.0
github.com/charmbracelet/lipgloss v0.5.0
github.com/cli/go-gh/v2 v2.1.0
github.com/cli/go-gh/v2 v2.3.0
github.com/cli/oauth v1.0.1
github.com/cli/safeexec v1.0.1
github.com/cpuguy83/go-md2man/v2 v2.0.2
@ -49,6 +49,7 @@ require (
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/aymerick/douceur v0.2.0 // indirect
github.com/cli/browser v1.2.0 // indirect
github.com/cli/shurcooL-graphql v0.0.3 // indirect
@ -68,9 +69,9 @@ require (
github.com/kr/text v0.2.0 // 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.20 // indirect
github.com/microcosm-cc/bluemonday v1.0.21 // indirect
github.com/muesli/reflow v0.3.0 // indirect
github.com/muesli/termenv v0.12.0 // indirect
github.com/muesli/termenv v0.13.0 // 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
@ -78,7 +79,7 @@ require (
github.com/shurcooL/graphql v0.0.0-20220606043923-3cf50f8a0a29 // indirect
github.com/stretchr/objx v0.5.0 // indirect
github.com/thlib/go-timezone-local v0.0.0-20210907160436-ef149e42d28e // indirect
github.com/yuin/goldmark v1.4.13 // indirect
github.com/yuin/goldmark v1.5.2 // indirect
github.com/yuin/goldmark-emoji v1.0.1 // indirect
golang.org/x/net v0.9.0 // indirect
golang.org/x/sys v0.8.0 // indirect

27
go.sum
View file

@ -8,14 +8,16 @@ github.com/alecthomas/chroma v0.10.0 h1:7XDcGkCQopCNKjZHfYrNLraA+M7e0fMiJ/Mfikbf
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/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/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/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.5.1-0.20220727184942-e70ff2d969da h1:FGz53GWQRiKQ/5xUsoCCkewSQIC7u81Scaxx2nUy3nM=
github.com/charmbracelet/glamour v0.5.1-0.20220727184942-e70ff2d969da/go.mod h1:HXz79SMFnF9arKxqeoHWxmo1BhplAH7wehlRhKQIL94=
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/cli/browser v1.0.0/go.mod h1:IEWkHYbLjkhtjwwWlwTHW2lGxeS5gezEQBMLTwDHf5Q=
@ -23,8 +25,8 @@ 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.1.0 h1:JzYEJyv3VOoU+O9prmoAb3q4JvCwx8dGgLjJF992+18=
github.com/cli/go-gh/v2 v2.1.0/go.mod h1:DwqlWB1TCBcKmDt/9/81EnlbGG7elLoevF4ypt5BnzE=
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/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=
@ -113,16 +115,14 @@ github.com/mattn/go-runewidth v0.0.14/go.mod h1:Jdepj2loyihRzMpdS35Xk/zdY8IAYHsh
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.19/go.mod h1:QNzV2UbLK2/53oIIwTOyLUSABMkjZ4tqiyC1g/DyqxE=
github.com/microcosm-cc/bluemonday v1.0.20 h1:flpzsq4KU3QIYAYGV/szUat7H+GPOXR0B2JU5A1Wp8Y=
github.com/microcosm-cc/bluemonday v1.0.20/go.mod h1:yfBmMi8mxvaZut3Yytv+jTXRY8mxyjJ0/kQBTElld50=
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/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.0/go.mod h1:Bd5NYQ7pd+SrtBSrSNoBBmXlcY8+Xj4BMJgh8qcZrvs=
github.com/muesli/termenv v0.11.1-0.20220204035834-5ac8409525e0/go.mod h1:Bd5NYQ7pd+SrtBSrSNoBBmXlcY8+Xj4BMJgh8qcZrvs=
github.com/muesli/termenv v0.12.0 h1:KuQRUE3PgxRFWhq4gHvZtPSLCGDqM5q/cYr1pZ39ytc=
github.com/muesli/termenv v0.12.0/go.mod h1:WCCv32tusQ/EEZ5S8oUIIrC/nIuBcxCVqlN4Xfkv+7A=
github.com/muesli/termenv v0.13.0 h1:wK20DRpJdDX8b7Ek2QfhvqhRQFZ237RGRO0RQ/Iqdy0=
github.com/muesli/termenv v0.13.0/go.mod h1:sP1+uffeLaEYpyOTb8pLCUctGcGLnoFjSn4YJK5e2bc=
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=
@ -165,9 +165,9 @@ github.com/thlib/go-timezone-local v0.0.0-20210907160436-ef149e42d28e h1:Buzhfgf
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/yuin/goldmark v1.4.4/go.mod h1:rmuwmfZ0+bvzB24eSC//bk1R1Zp3hM0OXYv/G2LIilg=
github.com/yuin/goldmark v1.4.13 h1:fVcFKWvrslecOb/tg+Cc05dkeYx540o0FuFt3nUVDoE=
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=
@ -176,10 +176,10 @@ golang.org/x/mod v0.6.0-dev.0.20220106191415-9b9b3d81d5e3/go.mod h1:3p9vT2HGsQu2
golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4=
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-20210614182718-04defd469f4e/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
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.9.0 h1:aWJ/m6xSmxWBx+V0XRHTlrYrPG56jKsLdTFmsSsCzOM=
golang.org/x/net v0.9.0/go.mod h1:d48xBJpPfHeWQsugry2m+kC02ZBRGRgulfHnEXEuWns=
golang.org/x/oauth2 v0.4.0 h1:NF0gk8LVPg1Ml7SSbGyySuoxdsXitj7TvgvuRxIMc/M=
@ -198,7 +198,6 @@ golang.org/x/sys v0.0.0-20210616045830-e2b7044e8c71/go.mod h1:oPkhp1MJrh7nUepCBc
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-20220209214540-3681064d5158/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-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.0.0-20220728004956-3c1f35247d10/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=

View file

@ -2,132 +2,74 @@ package prompter
import (
"fmt"
"io"
"strings"
"github.com/AlecAivazis/survey/v2"
"github.com/cli/cli/v2/internal/ghinstance"
"github.com/cli/cli/v2/internal/text"
"github.com/cli/cli/v2/pkg/surveyext"
ghPrompter "github.com/cli/go-gh/v2/pkg/prompter"
)
//go:generate moq -rm -out prompter_mock.go . Prompter
type Prompter interface {
// generic prompts from go-gh
Select(string, string, []string) (int, error)
MultiSelect(prompt string, defaults []string, options []string) ([]int, error)
Input(string, string) (string, error)
InputHostname() (string, error)
Password(string) (string, error)
AuthToken() (string, error)
Confirm(string, bool) (bool, error)
// gh specific prompts
AuthToken() (string, error)
ConfirmDeletion(string) error
InputHostname() (string, error)
MarkdownEditor(string, string, bool) (string, error)
}
type fileWriter interface {
io.Writer
Fd() uintptr
}
type fileReader interface {
io.Reader
Fd() uintptr
}
func New(editorCmd string, stdin fileReader, stdout fileWriter, stderr io.Writer) Prompter {
func New(editorCmd string, stdin ghPrompter.FileReader, stdout ghPrompter.FileWriter, stderr ghPrompter.FileWriter) Prompter {
return &surveyPrompter{
editorCmd: editorCmd,
prompter: ghPrompter.New(stdin, stdout, stderr),
stdin: stdin,
stdout: stdout,
stderr: stderr,
editorCmd: editorCmd,
}
}
type surveyPrompter struct {
prompter *ghPrompter.Prompter
stdin ghPrompter.FileReader
stdout ghPrompter.FileWriter
stderr ghPrompter.FileWriter
editorCmd string
stdin fileReader
stdout fileWriter
stderr io.Writer
}
// LatinMatchingFilter returns whether the value matches the input filter.
// The strings are compared normalized in case.
// The filter's diactritics are kept as-is, but the value's are normalized,
// so that a missing diactritic in the filter still returns a result.
func LatinMatchingFilter(filter, value string, index int) bool {
filter = strings.ToLower(filter)
value = strings.ToLower(value)
// include this option if it matches.
return strings.Contains(value, filter) || strings.Contains(text.RemoveDiacritics(value), filter)
func (p *surveyPrompter) Select(prompt, defaultValue string, options []string) (int, error) {
return p.prompter.Select(prompt, defaultValue, options)
}
func (p *surveyPrompter) Select(message, defaultValue string, options []string) (result int, err error) {
q := &survey.Select{
Message: message,
Options: options,
PageSize: 20,
Filter: LatinMatchingFilter,
}
if defaultValue != "" {
// in some situations, defaultValue ends up not being a valid option; do
// not set default in that case as it will make survey panic
for _, o := range options {
if o == defaultValue {
q.Default = defaultValue
break
}
}
}
err = p.ask(q, &result)
return
func (p *surveyPrompter) MultiSelect(prompt string, defaultValues, options []string) ([]int, error) {
return p.prompter.MultiSelect(prompt, defaultValues, options)
}
func (p *surveyPrompter) MultiSelect(message string, defaultValues, options []string) (result []int, err error) {
q := &survey.MultiSelect{
Message: message,
Options: options,
PageSize: 20,
Filter: LatinMatchingFilter,
}
if len(defaultValues) > 0 {
// TODO I don't actually know that this is needed, just being extra cautious
validatedDefault := []string{}
for _, x := range defaultValues {
for _, y := range options {
if x == y {
validatedDefault = append(validatedDefault, x)
}
}
}
q.Default = validatedDefault
}
err = p.ask(q, &result)
return
func (p *surveyPrompter) Input(prompt, defaultValue string) (string, error) {
return p.prompter.Input(prompt, defaultValue)
}
func (p *surveyPrompter) ask(q survey.Prompt, response interface{}, opts ...survey.AskOpt) error {
opts = append(opts, survey.WithStdio(p.stdin, p.stdout, p.stderr))
err := survey.AskOne(q, response, opts...)
if err == nil {
return nil
}
return fmt.Errorf("could not prompt: %w", err)
func (p *surveyPrompter) Password(prompt string) (string, error) {
return p.prompter.Password(prompt)
}
func (p *surveyPrompter) Input(prompt, defaultValue string) (result string, err error) {
err = p.ask(&survey.Input{
Message: prompt,
Default: defaultValue,
}, &result)
func (p *surveyPrompter) Confirm(prompt string, defaultValue bool) (bool, error) {
return p.prompter.Confirm(prompt, defaultValue)
}
return
func (p *surveyPrompter) AuthToken() (string, error) {
var result string
err := p.ask(&survey.Password{
Message: "Paste your authentication token:",
}, &result, survey.WithValidator(survey.Required))
return result, err
}
func (p *surveyPrompter) ConfirmDeletion(requiredValue string) error {
@ -146,54 +88,38 @@ func (p *surveyPrompter) ConfirmDeletion(requiredValue string) error {
}))
}
func (p *surveyPrompter) InputHostname() (result string, err error) {
err = p.ask(
func (p *surveyPrompter) InputHostname() (string, error) {
var result string
err := p.ask(
&survey.Input{
Message: "GHE hostname:",
}, &result, survey.WithValidator(func(v interface{}) error {
return ghinstance.HostnameValidator(v.(string))
}))
return
return result, err
}
func (p *surveyPrompter) Password(prompt string) (result string, err error) {
err = p.ask(&survey.Password{
Message: prompt,
}, &result)
return
}
func (p *surveyPrompter) Confirm(prompt string, defaultValue bool) (result bool, err error) {
err = p.ask(&survey.Confirm{
Message: prompt,
Default: defaultValue,
}, &result)
return
}
func (p *surveyPrompter) MarkdownEditor(message, defaultValue string, blankAllowed bool) (result string, err error) {
err = p.ask(&surveyext.GhEditor{
func (p *surveyPrompter) MarkdownEditor(prompt, defaultValue string, blankAllowed bool) (string, error) {
var result string
err := p.ask(&surveyext.GhEditor{
BlankAllowed: blankAllowed,
EditorCommand: p.editorCmd,
Editor: &survey.Editor{
Message: message,
Message: prompt,
Default: defaultValue,
FileName: "*.md",
HideDefault: true,
AppendDefault: true,
},
}, &result)
return
return result, err
}
func (p *surveyPrompter) AuthToken() (result string, err error) {
err = p.ask(&survey.Password{
Message: "Paste your authentication token:",
}, &result, survey.WithValidator(survey.Required))
return
func (p *surveyPrompter) ask(q survey.Prompt, response interface{}, opts ...survey.AskOpt) error {
opts = append(opts, survey.WithStdio(p.stdin, p.stdout, p.stderr))
err := survey.AskOne(q, response, opts...)
if err == nil {
return nil
}
return fmt.Errorf("could not prompt: %w", err)
}

View file

@ -1,78 +0,0 @@
package prompter
import (
"testing"
"github.com/stretchr/testify/assert"
)
func TestFilterDiacritics(t *testing.T) {
tests := []struct {
name string
filter string
value string
want bool
}{
{
name: "exact match no diacritics",
filter: "Mikelis",
value: "Mikelis",
want: true,
},
{
name: "exact match no diacritics",
filter: "Mikelis",
value: "Mikelis",
want: true,
},
{
name: "exact match diacritics",
filter: "Miķelis",
value: "Miķelis",
want: true,
},
{
name: "partial match diacritics",
filter: "Miķe",
value: "Miķelis",
want: true,
},
{
name: "exact match diacritics in value",
filter: "Mikelis",
value: "Miķelis",
want: true,
},
{
name: "partial match diacritics in filter",
filter: "Miķe",
value: "Miķelis",
want: true,
},
{
name: "no match when removing diacritics in filter",
filter: "Mielis",
value: "Mikelis",
want: false,
},
{
name: "no match when removing diacritics in value",
filter: "Mikelis",
value: "Mielis",
want: false,
},
{
name: "no match diacritics in filter",
filter: "Miķelis",
value: "Mikelis",
want: false,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
assert.Equal(t, LatinMatchingFilter(tt.filter, tt.value, 0), tt.want)
})
}
}

View file

@ -5,10 +5,132 @@ import (
"strings"
"testing"
ghPrompter "github.com/cli/go-gh/v2/pkg/prompter"
"github.com/stretchr/testify/assert"
)
// Test helpers
func NewMockPrompter(t *testing.T) *MockPrompter {
m := &MockPrompter{
t: t,
PrompterMock: *ghPrompter.NewMock(t),
authTokenStubs: []authTokenStub{},
confirmDeletionStubs: []confirmDeletionStub{},
inputHostnameStubs: []inputHostnameStub{},
markdownEditorStubs: []markdownEditorStub{},
}
t.Cleanup(m.Verify)
return m
}
type MockPrompter struct {
t *testing.T
ghPrompter.PrompterMock
authTokenStubs []authTokenStub
confirmDeletionStubs []confirmDeletionStub
inputHostnameStubs []inputHostnameStub
markdownEditorStubs []markdownEditorStub
}
type authTokenStub struct {
fn func() (string, error)
}
type confirmDeletionStub struct {
prompt string
fn func(string) error
}
type inputHostnameStub struct {
fn func() (string, error)
}
type markdownEditorStub struct {
prompt string
fn func(string, string, bool) (string, error)
}
func (m *MockPrompter) AuthToken() (string, error) {
var s authTokenStub
if len(m.authTokenStubs) == 0 {
return "", NoSuchPromptErr("AuthToken")
}
s = m.authTokenStubs[0]
m.authTokenStubs = m.authTokenStubs[1:len(m.authTokenStubs)]
return s.fn()
}
func (m *MockPrompter) ConfirmDeletion(prompt string) error {
var s confirmDeletionStub
if len(m.confirmDeletionStubs) == 0 {
return NoSuchPromptErr("ConfirmDeletion")
}
s = m.confirmDeletionStubs[0]
m.confirmDeletionStubs = m.confirmDeletionStubs[1:len(m.confirmDeletionStubs)]
return s.fn(prompt)
}
func (m *MockPrompter) InputHostname() (string, error) {
var s inputHostnameStub
if len(m.inputHostnameStubs) == 0 {
return "", NoSuchPromptErr("InputHostname")
}
s = m.inputHostnameStubs[0]
m.inputHostnameStubs = m.inputHostnameStubs[1:len(m.inputHostnameStubs)]
return s.fn()
}
func (m *MockPrompter) MarkdownEditor(prompt, defaultValue string, blankAllowed bool) (string, error) {
var s markdownEditorStub
if len(m.markdownEditorStubs) == 0 {
return "", NoSuchPromptErr(prompt)
}
s = m.markdownEditorStubs[0]
m.markdownEditorStubs = m.markdownEditorStubs[1:len(m.markdownEditorStubs)]
if s.prompt != prompt {
return "", NoSuchPromptErr(prompt)
}
return s.fn(prompt, defaultValue, blankAllowed)
}
func (m *MockPrompter) RegisterAuthToken(stub func() (string, error)) {
m.authTokenStubs = append(m.authTokenStubs, authTokenStub{fn: stub})
}
func (m *MockPrompter) RegisterConfirmDeletion(prompt string, stub func(string) error) {
m.confirmDeletionStubs = append(m.confirmDeletionStubs, confirmDeletionStub{prompt: prompt, fn: stub})
}
func (m *MockPrompter) RegisterInputHostname(stub func() (string, error)) {
m.inputHostnameStubs = append(m.inputHostnameStubs, inputHostnameStub{fn: stub})
}
func (m *MockPrompter) RegisterMarkdownEditor(prompt string, stub func(string, string, bool) (string, error)) {
m.markdownEditorStubs = append(m.markdownEditorStubs, markdownEditorStub{prompt: prompt, fn: stub})
}
func (m *MockPrompter) Verify() {
errs := []string{}
if len(m.authTokenStubs) > 0 {
errs = append(errs, "AuthToken")
}
if len(m.confirmDeletionStubs) > 0 {
errs = append(errs, "ConfirmDeletion")
}
if len(m.inputHostnameStubs) > 0 {
errs = append(errs, "inputHostname")
}
if len(m.markdownEditorStubs) > 0 {
errs = append(errs, "markdownEditorStubs")
}
if len(errs) > 0 {
m.t.Helper()
m.t.Errorf("%d unmatched calls to %s", len(errs), strings.Join(errs, ","))
}
}
func AssertOptions(t *testing.T, expected, actual []string) {
assert.Equal(t, expected, actual)
}
func IndexFor(options []string, answer string) (int, error) {
for ix, a := range options {
@ -19,267 +141,10 @@ func IndexFor(options []string, answer string) (int, error) {
return -1, NoSuchAnswerErr(answer)
}
func AssertOptions(t *testing.T, expected, actual []string) {
assert.Equal(t, expected, actual)
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 NoSuchPromptErr(prompt string) error {
return fmt.Errorf("no such prompt '%s'", prompt)
}
type SelectStub struct {
Prompt string
ExpectedOpts []string
Fn func(string, string, []string) (int, error)
}
type InputStub struct {
Prompt string
Fn func(string, string) (string, error)
}
type ConfirmStub struct {
Prompt string
Fn func(string, bool) (bool, error)
}
type MultiSelectStub struct {
Prompt string
ExpectedOpts []string
Fn func(string, []string, []string) ([]int, error)
}
type InputHostnameStub struct {
Fn func() (string, error)
}
type PasswordStub struct {
Prompt string
Fn func(string) (string, error)
}
type AuthTokenStub struct {
Fn func() (string, error)
}
type ConfirmDeletionStub struct {
Prompt string
Fn func(string) error
}
type MockPrompter struct {
PrompterMock
t *testing.T
SelectStubs []SelectStub
InputStubs []InputStub
ConfirmStubs []ConfirmStub
MultiSelectStubs []MultiSelectStub
InputHostnameStubs []InputHostnameStub
PasswordStubs []PasswordStub
AuthTokenStubs []AuthTokenStub
ConfirmDeletionStubs []ConfirmDeletionStub
}
func NewMockPrompter(t *testing.T) *MockPrompter {
m := &MockPrompter{
t: t,
SelectStubs: []SelectStub{},
InputStubs: []InputStub{},
ConfirmStubs: []ConfirmStub{},
MultiSelectStubs: []MultiSelectStub{},
InputHostnameStubs: []InputHostnameStub{},
PasswordStubs: []PasswordStub{},
AuthTokenStubs: []AuthTokenStub{},
ConfirmDeletionStubs: []ConfirmDeletionStub{},
}
t.Cleanup(m.Verify)
m.SelectFunc = func(p, d string, opts []string) (int, error) {
var s SelectStub
if len(m.SelectStubs) > 0 {
s = m.SelectStubs[0]
m.SelectStubs = m.SelectStubs[1:len(m.SelectStubs)]
} else {
return -1, NoSuchPromptErr(p)
}
if s.Prompt != p {
return -1, NoSuchPromptErr(p)
}
AssertOptions(m.t, s.ExpectedOpts, opts)
return s.Fn(p, d, opts)
}
m.MultiSelectFunc = func(p string, d, opts []string) ([]int, error) {
var s MultiSelectStub
if len(m.MultiSelectStubs) > 0 {
s = m.MultiSelectStubs[0]
m.MultiSelectStubs = m.MultiSelectStubs[1:len(m.MultiSelectStubs)]
} else {
return []int{}, NoSuchPromptErr(p)
}
if s.Prompt != p {
return []int{}, NoSuchPromptErr(p)
}
AssertOptions(m.t, s.ExpectedOpts, opts)
return s.Fn(p, d, opts)
}
m.InputFunc = func(p, d string) (string, error) {
var s InputStub
if len(m.InputStubs) > 0 {
s = m.InputStubs[0]
m.InputStubs = m.InputStubs[1:len(m.InputStubs)]
} else {
return "", NoSuchPromptErr(p)
}
if s.Prompt != p {
return "", NoSuchPromptErr(p)
}
return s.Fn(p, d)
}
m.ConfirmFunc = func(p string, d bool) (bool, error) {
var s ConfirmStub
if len(m.ConfirmStubs) > 0 {
s = m.ConfirmStubs[0]
m.ConfirmStubs = m.ConfirmStubs[1:len(m.ConfirmStubs)]
} else {
return false, NoSuchPromptErr(p)
}
if s.Prompt != p {
return false, NoSuchPromptErr(p)
}
return s.Fn(p, d)
}
m.InputHostnameFunc = func() (string, error) {
var s InputHostnameStub
if len(m.InputHostnameStubs) > 0 {
s = m.InputHostnameStubs[0]
m.InputHostnameStubs = m.InputHostnameStubs[1:len(m.InputHostnameStubs)]
} else {
return "", NoSuchPromptErr("InputHostname")
}
return s.Fn()
}
m.PasswordFunc = func(p string) (string, error) {
var s PasswordStub
if len(m.PasswordStubs) > 0 {
s = m.PasswordStubs[0]
m.PasswordStubs = m.PasswordStubs[1:len(m.PasswordStubs)]
} else {
return "", NoSuchPromptErr(p)
}
if s.Prompt != p {
return "", NoSuchPromptErr(p)
}
return s.Fn(p)
}
m.AuthTokenFunc = func() (string, error) {
var s AuthTokenStub
if len(m.AuthTokenStubs) > 0 {
s = m.AuthTokenStubs[0]
m.AuthTokenStubs = m.AuthTokenStubs[1:len(m.AuthTokenStubs)]
} else {
return "", NoSuchPromptErr("AuthToken")
}
return s.Fn()
}
m.ConfirmDeletionFunc = func(p string) error {
var s ConfirmDeletionStub
if len(m.ConfirmDeletionStubs) > 0 {
s = m.ConfirmDeletionStubs[0]
m.ConfirmDeletionStubs = m.ConfirmDeletionStubs[1:len(m.ConfirmDeletionStubs)]
} else {
return NoSuchPromptErr("ConfirmDeletion")
}
return s.Fn(p)
}
// TODO MarkdownEditor(string, string, bool) (string, error)
return m
}
func (m *MockPrompter) RegisterSelect(prompt string, opts []string, stub func(_, _ string, _ []string) (int, error)) {
m.SelectStubs = append(m.SelectStubs, SelectStub{
Prompt: prompt,
ExpectedOpts: opts,
Fn: stub})
}
func (m *MockPrompter) RegisterMultiSelect(prompt string, d, opts []string, stub func(_ string, _, _ []string) ([]int, error)) {
m.MultiSelectStubs = append(m.MultiSelectStubs, MultiSelectStub{
Prompt: prompt,
ExpectedOpts: opts,
Fn: stub})
}
func (m *MockPrompter) RegisterInput(prompt string, stub func(_, _ string) (string, error)) {
m.InputStubs = append(m.InputStubs, InputStub{Prompt: prompt, Fn: stub})
}
func (m *MockPrompter) RegisterConfirm(prompt string, stub func(_ string, _ bool) (bool, error)) {
m.ConfirmStubs = append(m.ConfirmStubs, ConfirmStub{Prompt: prompt, Fn: stub})
}
func (m *MockPrompter) RegisterInputHostname(stub func() (string, error)) {
m.InputHostnameStubs = append(m.InputHostnameStubs, InputHostnameStub{Fn: stub})
}
func (m *MockPrompter) RegisterPassword(prompt string, stub func(string) (string, error)) {
m.PasswordStubs = append(m.PasswordStubs, PasswordStub{Prompt: prompt, Fn: stub})
}
func (m *MockPrompter) RegisterConfirmDeletion(prompt string, stub func(string) error) {
m.ConfirmDeletionStubs = append(m.ConfirmDeletionStubs, ConfirmDeletionStub{Prompt: prompt, Fn: stub})
}
func (m *MockPrompter) Verify() {
errs := []string{}
if len(m.SelectStubs) > 0 {
errs = append(errs, "Select")
}
if len(m.InputStubs) > 0 {
errs = append(errs, "Input")
}
if len(m.ConfirmStubs) > 0 {
errs = append(errs, "Confirm")
}
// TODO other prompt types
if len(errs) > 0 {
m.t.Helper()
m.t.Errorf("%d unmatched calls to %s", len(errs), strings.Join(errs, ","))
}
}

View file

@ -6,14 +6,10 @@ import (
"regexp"
"strings"
"time"
"unicode"
"github.com/cli/go-gh/v2/pkg/text"
"golang.org/x/text/cases"
"golang.org/x/text/language"
"golang.org/x/text/runes"
"golang.org/x/text/transform"
"golang.org/x/text/unicode/norm"
)
var whitespaceRE = regexp.MustCompile(`\s+`)
@ -79,16 +75,5 @@ func DisplayURL(urlStr string) string {
// RemoveDiacritics returns the input value without "diacritics", or accent marks
func RemoveDiacritics(value string) string {
// Mn = "Mark, nonspacing" unicode character category
removeMnTransfomer := runes.Remove(runes.In(unicode.Mn))
// 1/ Decompose the text into characters and diacritical marks,
// 2/ Remove the diacriticals marks
// 3/ Recompose the text
t := transform.Chain(norm.NFD, removeMnTransfomer, norm.NFC)
normalized, _, err := transform.String(t, value)
if err != nil {
return value
}
return normalized
return text.RemoveDiacritics(value)
}

View file

@ -54,57 +54,3 @@ func TestFuzzyAgoAbbr(t *testing.T) {
assert.Equal(t, expected, fuzzy)
}
}
func TestRemoveDiacritics(t *testing.T) {
tests := [][]string{
// no diacritics
{"e", "e"},
{"و", "و"},
{"И", "И"},
{"ж", "ж"},
{"私", "私"},
{"万", "万"},
// diacritics test sets
{"à", "a"},
{"é", "e"},
{"è", "e"},
{"ô", "o"},
{"ᾳ", "α"},
{"εͅ", "ε"},
{"ῃ", "η"},
{"ιͅ", "ι"},
{"ؤ", "و"},
{"ā", "a"},
{"č", "c"},
{"ģ", "g"},
{"ķ", "k"},
{"ņ", "n"},
{"š", "s"},
{"ž", "z"},
{"ŵ", "w"},
{"ŷ", "y"},
{"ä", "a"},
{"ÿ", "y"},
{"á", "a"},
{"ẁ", "w"},
{"ỳ", "y"},
{"ō", "o"},
// full words
{"Miķelis", "Mikelis"},
{"François", "Francois"},
{"žluťoučký", "zlutoucky"},
{"învățătorița", "invatatorita"},
{"Kękę przy łóżku", "Keke przy łozku"},
}
for _, tt := range tests {
t.Run(RemoveDiacritics(tt[0]), func(t *testing.T) {
assert.Equal(t, tt[1], RemoveDiacritics(tt[0]))
})
}
}

View file

@ -30,7 +30,12 @@ import (
)
type ApiOptions struct {
IO *iostreams.IOStreams
AppVersion string
BaseRepo func() (ghrepo.Interface, error)
Branch func() (string, error)
Config func() (config.Config, error)
HttpClient func() (*http.Client, error)
IO *iostreams.IOStreams
Hostname string
RequestMethod string
@ -47,20 +52,16 @@ type ApiOptions struct {
Template string
CacheTTL time.Duration
FilterOutput string
Config func() (config.Config, error)
HttpClient func() (*http.Client, error)
BaseRepo func() (ghrepo.Interface, error)
Branch func() (string, error)
Verbose bool
}
func NewCmdApi(f *cmdutil.Factory, runF func(*ApiOptions) error) *cobra.Command {
opts := ApiOptions{
IO: f.IOStreams,
Config: f.Config,
HttpClient: f.HttpClient,
AppVersion: f.AppVersion,
BaseRepo: f.BaseRepo,
Branch: f.Branch,
Config: f.Config,
IO: f.IOStreams,
}
cmd := &cobra.Command{
@ -209,7 +210,8 @@ func NewCmdApi(f *cmdutil.Factory, runF func(*ApiOptions) error) *cobra.Command
}
if err := cmdutil.MutuallyExclusive(
"only one of `--template`, `--jq`, or `--silent` may be used",
"only one of `--template`, `--jq`, `--silent`, or `--verbose` may be used",
opts.Verbose,
opts.Silent,
opts.FilterOutput != "",
opts.Template != "",
@ -237,6 +239,7 @@ func NewCmdApi(f *cmdutil.Factory, runF func(*ApiOptions) error) *cobra.Command
cmd.Flags().StringVarP(&opts.Template, "template", "t", "", "Format JSON output using a Go template; see \"gh help formatting\"")
cmd.Flags().StringVarP(&opts.FilterOutput, "jq", "q", "", "Query to select values from the response using jq syntax")
cmd.Flags().DurationVar(&opts.CacheTTL, "cache", 0, "Cache the response, e.g. \"3600s\", \"60m\", \"1h\"")
cmd.Flags().BoolVar(&opts.Verbose, "verbose", false, "Include full HTTP request and response in the output")
return cmd
}
@ -283,12 +286,33 @@ func apiRun(opts *ApiOptions) error {
requestHeaders = append(requestHeaders, "Accept: "+previewNamesToMIMETypes(opts.Previews))
}
httpClient, err := opts.HttpClient()
cfg, err := opts.Config()
if err != nil {
return err
}
if opts.CacheTTL > 0 {
httpClient = api.NewCachedHTTPClient(httpClient, opts.CacheTTL)
if opts.HttpClient == nil {
opts.HttpClient = func() (*http.Client, error) {
log := opts.IO.ErrOut
if opts.Verbose {
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,
}
return api.NewHTTPClient(opts)
}
}
httpClient, err := opts.HttpClient()
if err != nil {
return err
}
if !opts.Silent {
@ -304,10 +328,10 @@ func apiRun(opts *ApiOptions) error {
if opts.Silent {
bodyWriter = io.Discard
}
cfg, err := opts.Config()
if err != nil {
return err
if opts.Verbose {
// httpClient handles output when verbose flag is specified.
bodyWriter = io.Discard
headersWriter = io.Discard
}
host, _ := cfg.Authentication().DefaultHost()

View file

@ -52,6 +52,7 @@ func Test_NewCmdApi(t *testing.T) {
CacheTTL: 0,
Template: "",
FilterOutput: "",
Verbose: false,
},
wantsErr: false,
},
@ -73,6 +74,7 @@ func Test_NewCmdApi(t *testing.T) {
CacheTTL: 0,
Template: "",
FilterOutput: "",
Verbose: false,
},
wantsErr: false,
},
@ -94,6 +96,7 @@ func Test_NewCmdApi(t *testing.T) {
CacheTTL: 0,
Template: "",
FilterOutput: "",
Verbose: false,
},
wantsErr: false,
},
@ -115,6 +118,7 @@ func Test_NewCmdApi(t *testing.T) {
CacheTTL: 0,
Template: "",
FilterOutput: "",
Verbose: false,
},
wantsErr: false,
},
@ -136,6 +140,7 @@ func Test_NewCmdApi(t *testing.T) {
CacheTTL: 0,
Template: "",
FilterOutput: "",
Verbose: false,
},
wantsErr: false,
},
@ -157,6 +162,7 @@ func Test_NewCmdApi(t *testing.T) {
CacheTTL: 0,
Template: "",
FilterOutput: "",
Verbose: false,
},
wantsErr: false,
},
@ -183,6 +189,7 @@ func Test_NewCmdApi(t *testing.T) {
CacheTTL: 0,
Template: "",
FilterOutput: "",
Verbose: false,
},
wantsErr: false,
},
@ -209,6 +216,7 @@ func Test_NewCmdApi(t *testing.T) {
CacheTTL: 0,
Template: "",
FilterOutput: "",
Verbose: false,
},
wantsErr: false,
},
@ -235,6 +243,7 @@ func Test_NewCmdApi(t *testing.T) {
CacheTTL: 0,
Template: "",
FilterOutput: "",
Verbose: false,
},
wantsErr: false,
},
@ -256,6 +265,7 @@ func Test_NewCmdApi(t *testing.T) {
CacheTTL: time.Minute * 5,
Template: "",
FilterOutput: "",
Verbose: false,
},
wantsErr: false,
},
@ -277,6 +287,7 @@ func Test_NewCmdApi(t *testing.T) {
CacheTTL: 0,
Template: "hello {{.name}}",
FilterOutput: "",
Verbose: false,
},
wantsErr: false,
},
@ -298,6 +309,7 @@ func Test_NewCmdApi(t *testing.T) {
CacheTTL: 0,
Template: "",
FilterOutput: ".name",
Verbose: false,
},
wantsErr: false,
},
@ -316,6 +328,28 @@ func Test_NewCmdApi(t *testing.T) {
cli: "user --jq .foo -t '{{.foo}}'",
wantsErr: true,
},
{
name: "with verbose",
cli: "user --verbose",
wants: ApiOptions{
Hostname: "",
RequestMethod: "GET",
RequestMethodPassed: false,
RequestPath: "user",
RequestInputFile: "",
RawFields: []string(nil),
MagicFields: []string(nil),
RequestHeaders: []string(nil),
ShowResponseHeaders: false,
Paginate: false,
Silent: false,
CacheTTL: 0,
Template: "",
FilterOutput: "",
Verbose: true,
},
wantsErr: false,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
@ -352,6 +386,7 @@ func Test_NewCmdApi(t *testing.T) {
assert.Equal(t, tt.wants.CacheTTL, opts.CacheTTL)
assert.Equal(t, tt.wants.Template, opts.Template)
assert.Equal(t, tt.wants.FilterOutput, opts.FilterOutput)
assert.Equal(t, tt.wants.Verbose, opts.Verbose)
})
}
}

View file

@ -108,7 +108,7 @@ func statusRun(opts *StatusOptions) error {
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 no longer valid.", cs.Bold(hostname), tokenSource)
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))

View file

@ -160,7 +160,7 @@ func Test_statusRun(t *testing.T) {
wantErrOut: heredoc.Doc(`
joel.miller
X joel.miller: authentication failed
- The joel.miller token in GH_CONFIG_DIR/hosts.yml is no longer valid.
- 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

View file

@ -0,0 +1,51 @@
package clearcache
import (
"fmt"
"os"
"github.com/MakeNowJust/heredoc"
"github.com/cli/cli/v2/pkg/cmdutil"
"github.com/cli/cli/v2/pkg/iostreams"
"github.com/cli/go-gh/v2/pkg/config"
"github.com/spf13/cobra"
)
type ClearCacheOptions struct {
IO *iostreams.IOStreams
CacheDir string
}
func NewCmdConfigClearCache(f *cmdutil.Factory, runF func(*ClearCacheOptions) error) *cobra.Command {
opts := &ClearCacheOptions{
IO: f.IOStreams,
CacheDir: config.CacheDir(),
}
cmd := &cobra.Command{
Use: "clear-cache",
Short: "Clear the cli cache",
Example: heredoc.Doc(`
# Clear the cli cache
$ gh config clear-cache
`),
Args: cobra.ExactArgs(0),
RunE: func(_ *cobra.Command, _ []string) error {
if runF != nil {
return runF(opts)
}
return clearCacheRun(opts)
},
}
return cmd
}
func clearCacheRun(opts *ClearCacheOptions) error {
if err := os.RemoveAll(opts.CacheDir); err != nil {
return err
}
cs := opts.IO.ColorScheme()
fmt.Fprintf(opts.IO.Out, "%s Cleared the cache\n", cs.SuccessIcon())
return nil
}

View file

@ -0,0 +1,32 @@
package clearcache
import (
"fmt"
"os"
"path/filepath"
"testing"
"github.com/cli/cli/v2/pkg/iostreams"
"github.com/stretchr/testify/assert"
)
func TestClearCacheRun(t *testing.T) {
cacheDir := filepath.Join(t.TempDir(), "gh-cli-cache")
ios, _, stdout, stderr := iostreams.Test()
opts := &ClearCacheOptions{
IO: ios,
CacheDir: cacheDir,
}
if err := os.Mkdir(opts.CacheDir, 0600); err != nil {
assert.NoError(t, err)
}
if err := clearCacheRun(opts); err != nil {
assert.NoError(t, err)
}
assert.NoDirExistsf(t, opts.CacheDir, fmt.Sprintf("Cache dir: %s still exists", opts.CacheDir))
assert.Equal(t, "✓ Cleared the cache\n", stdout.String())
assert.Equal(t, "", stderr.String())
}

View file

@ -5,6 +5,7 @@ import (
"strings"
"github.com/cli/cli/v2/internal/config"
cmdClearCache "github.com/cli/cli/v2/pkg/cmd/config/clear-cache"
cmdGet "github.com/cli/cli/v2/pkg/cmd/config/get"
cmdList "github.com/cli/cli/v2/pkg/cmd/config/list"
cmdSet "github.com/cli/cli/v2/pkg/cmd/config/set"
@ -35,6 +36,7 @@ func NewCmdConfig(f *cmdutil.Factory) *cobra.Command {
cmd.AddCommand(cmdGet.NewCmdConfigGet(f, nil))
cmd.AddCommand(cmdSet.NewCmdConfigSet(f, nil))
cmd.AddCommand(cmdList.NewCmdConfigList(f, nil))
cmd.AddCommand(cmdClearCache.NewCmdConfigClearCache(f, nil))
return cmd
}

View file

@ -25,6 +25,7 @@ var ssoURLRE = regexp.MustCompile(`\burl=([^;]+)`)
func New(appVersion string) *cmdutil.Factory {
f := &cmdutil.Factory{
AppVersion: appVersion,
Config: configFunc(), // No factory dependencies
ExecutableName: "gh",
}

View file

@ -216,8 +216,10 @@ func checksRun(opts *ChecksOptions) error {
}
}
if counts.Failed+counts.Pending > 0 {
if counts.Failed > 0 {
return cmdutil.SilentError
} else if counts.Pending > 0 {
return cmdutil.PendingError
}
return nil

View file

@ -180,7 +180,7 @@ func Test_checksRun(t *testing.T) {
)
},
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",
wantErr: "SilentError",
wantErr: "PendingError",
},
{
name: "all passing tty",
@ -275,7 +275,7 @@ func Test_checksRun(t *testing.T) {
)
},
wantOut: "cool tests\tpass\t1m26s\tsweet link\t\nrad tests\tpass\t1m26s\tsweet link\t\nslow tests\tpending\t1m26s\tsweet link\t\n",
wantErr: "SilentError",
wantErr: "PendingError",
},
{
name: "all passing",

View file

@ -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 || opts.DisableWiki) {
return cmdutil.FlagErrorf("the `--template` option is not supported with `--homepage`, `--team`, `--disable-issues`, or `--disable-wiki`")
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.IncludeAllBranches {
@ -396,7 +396,7 @@ func createFromScratch(opts *CreateOptions) error {
remoteURL := ghrepo.FormatRemoteURL(repo, protocol)
if opts.LicenseTemplate == "" && opts.GitIgnoreTemplate == "" && opts.Template == "" {
if !opts.AddReadme && opts.LicenseTemplate == "" && opts.GitIgnoreTemplate == "" && opts.Template == "" {
// cloning empty repository or template
if err := localInit(opts.GitClient, remoteURL, repo.RepoName()); err != nil {
return err

View file

@ -602,6 +602,35 @@ func Test_createRun(t *testing.T) {
},
wantStdout: "https://github.com/OWNER/REPO\n",
},
{
name: "noninteractive clone with readme",
opts: &CreateOptions{
Interactive: false,
Name: "ElliotAlderson",
Visibility: "PRIVATE",
Clone: true,
AddReadme: true,
},
tty: false,
httpStubs: func(reg *httpmock.Registry) {
reg.Register(
httpmock.REST("POST", "user/repos"),
httpmock.RESTPayload(200, "{\"name\":\"ElliotAlderson\", \"owner\":{\"login\": \"OWNER\"}, \"html_url\":\"https://github.com/OWNER/ElliotAlderson\"}",
func(payload map[string]interface{}) {
payload["name"] = "ElliotAlderson"
payload["owner"] = map[string]interface{}{"login": "OWNER"}
payload["auto_init"] = true
payload["private"] = true
},
),
)
},
execStubs: func(cs *run.CommandStubber) {
cs.Register(`git clone https://github.com/OWNER/ElliotAlderson`, 128, "")
cs.Register(`git clone https://github.com/OWNER/ElliotAlderson`, 0, "")
},
wantStdout: "https://github.com/OWNER/ElliotAlderson\n",
},
{
name: "noninteractive create from template with retry",
opts: &CreateOptions{

View file

@ -64,6 +64,11 @@ type cloneTemplateRepositoryInput struct {
IncludeAllBranches bool `json:"includeAllBranches"`
}
type updateRepositoryInput struct {
RepositoryID string `json:"repositoryId"`
HasWikiEnabled bool `json:"hasWikiEnabled"`
}
// repoCreate creates a new GitHub repository
func repoCreate(client *http.Client, hostname string, input repoCreateInput) (*api.Repository, error) {
isOrg := false
@ -133,6 +138,27 @@ func repoCreate(client *http.Client, hostname string, input repoCreateInput) (*a
return nil, err
}
if !input.HasWikiEnabled {
updateVariables := map[string]interface{}{
"input": updateRepositoryInput{
RepositoryID: response.CloneTemplateRepository.Repository.ID,
HasWikiEnabled: input.HasWikiEnabled,
},
}
if err := apiClient.GraphQL(hostname, `
mutation UpdateRepository($input: UpdateRepositoryInput!) {
updateRepository(input: $input) {
repository {
id
}
}
}
`, updateVariables, nil); err != nil {
return nil, err
}
}
return api.InitRepoHostname(&response.CloneTemplateRepository.Repository, hostname), nil
}

View file

@ -231,6 +231,70 @@ func Test_repoCreate(t *testing.T) {
},
wantRepo: "https://github.com/OWNER/REPO",
},
{
name: "create personal repo from template repo, and disable wiki",
hostname: "github.com",
input: repoCreateInput{
Name: "gen-project",
Description: "my generated project",
Visibility: "private",
TemplateRepositoryID: "TPLID",
HasIssuesEnabled: true,
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",
"hasWikiEnabled": false,
}, inputs)
}),
)
},
wantRepo: "https://github.com/OWNER/REPO",
},
{
name: "create org repo from template repo",
hostname: "github.com",

View file

@ -124,8 +124,6 @@ func renameRun(opts *RenameOptions) error {
return err
}
renamedRepo := ghrepo.New(newRepo.Owner.Login, newRepo.Name)
cs := opts.IO.ColorScheme()
if opts.IO.IsStdoutTTY() {
fmt.Fprintf(opts.IO.Out, "%s Renamed repository %s\n", cs.SuccessIcon(), ghrepo.FullName(newRepo))
@ -135,7 +133,7 @@ func renameRun(opts *RenameOptions) error {
return nil
}
remote, err := updateRemote(currRepo, renamedRepo, opts)
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)
} else if opts.IO.IsStdoutTTY() {

View file

@ -2,12 +2,10 @@ package root
import (
"fmt"
"net/http"
"os"
"strings"
"github.com/MakeNowJust/heredoc"
"github.com/cli/cli/v2/api"
actionsCmd "github.com/cli/cli/v2/pkg/cmd/actions"
aliasCmd "github.com/cli/cli/v2/pkg/cmd/alias"
"github.com/cli/cli/v2/pkg/cmd/alias/shared"
@ -150,13 +148,7 @@ func NewCmdRoot(f *cmdutil.Factory, version, buildDate string) (*cobra.Command,
cmd.AddCommand(workflowCmd.NewCmdWorkflow(&repoResolvingCmdFactory))
cmd.AddCommand(labelCmd.NewCmdLabel(&repoResolvingCmdFactory))
cmd.AddCommand(cacheCmd.NewCmdCache(&repoResolvingCmdFactory))
// the `api` command should not inherit any extra HTTP headers
bareHTTPCmdFactory := *f
bareHTTPCmdFactory.HttpClient = bareHTTPClient(f, version)
bareHTTPCmdFactory.BaseRepo = factory.SmartBaseRepoFunc(&bareHTTPCmdFactory)
cmd.AddCommand(apiCmd.NewCmdApi(&bareHTTPCmdFactory, nil))
cmd.AddCommand(apiCmd.NewCmdApi(&repoResolvingCmdFactory, nil))
// Help topics
var referenceCmd *cobra.Command
@ -222,20 +214,3 @@ func NewCmdRoot(f *cmdutil.Factory, version, buildDate string) (*cobra.Command,
referenceCmd.SetHelpFunc(longPager(f.IOStreams))
return cmd, nil
}
func bareHTTPClient(f *cmdutil.Factory, version string) func() (*http.Client, error) {
return func() (*http.Client, error) {
cfg, err := f.Config()
if err != nil {
return nil, err
}
opts := api.HTTPClientOptions{
AppVersion: version,
Config: cfg.Authentication(),
Log: f.IOStreams.ErrOut,
LogColorize: f.IOStreams.ColorEnabled(),
SkipAcceptHeaders: true,
}
return api.NewHTTPClient(opts)
}
}

View file

@ -6,10 +6,10 @@ import (
"github.com/cli/cli/v2/api"
"github.com/cli/cli/v2/internal/ghrepo"
"github.com/cli/cli/v2/internal/tableprinter"
"github.com/cli/cli/v2/pkg/cmd/workflow/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"
)
@ -19,13 +19,19 @@ type ListOptions struct {
IO *iostreams.IOStreams
HttpClient func() (*http.Client, error)
BaseRepo func() (ghrepo.Interface, error)
PlainOutput bool
Exporter cmdutil.Exporter
All bool
Limit int
}
var workflowFields = []string{
"id",
"name",
"path",
"state",
}
func NewCmdList(f *cmdutil.Factory, runF func(*ListOptions) error) *cobra.Command {
opts := &ListOptions{
IO: f.IOStreams,
@ -42,9 +48,6 @@ func NewCmdList(f *cmdutil.Factory, runF func(*ListOptions) error) *cobra.Comman
// support `-R, --repo` override
opts.BaseRepo = f.BaseRepo
terminal := opts.IO.IsStdoutTTY() && opts.IO.IsStdinTTY()
opts.PlainOutput = !terminal
if opts.Limit < 1 {
return cmdutil.FlagErrorf("invalid limit: %v", opts.Limit)
}
@ -58,8 +61,8 @@ func NewCmdList(f *cmdutil.Factory, runF func(*ListOptions) error) *cobra.Comman
}
cmd.Flags().IntVarP(&opts.Limit, "limit", "L", defaultLimit, "Maximum number of workflows to fetch")
cmd.Flags().BoolVarP(&opts.All, "all", "a", false, "Also show disabled workflows")
cmd.Flags().BoolVarP(&opts.All, "all", "a", false, "Include disabled workflows")
cmdutil.AddJSONFlags(cmd, &opts.Exporter, workflowFields)
return cmd
}
@ -82,7 +85,18 @@ func listRun(opts *ListOptions) error {
return fmt.Errorf("could not get workflows: %w", err)
}
if len(workflows) == 0 {
var filteredWorkflows []shared.Workflow
if opts.All {
filteredWorkflows = workflows
} else {
for _, workflow := range workflows {
if !workflow.Disabled() {
filteredWorkflows = append(filteredWorkflows, workflow)
}
}
}
if len(filteredWorkflows) == 0 {
return cmdutil.NewNoResultsError("no workflows found")
}
@ -92,17 +106,18 @@ func listRun(opts *ListOptions) error {
fmt.Fprintf(opts.IO.ErrOut, "failed to start pager: %v\n", err)
}
//nolint:staticcheck // SA1019: utils.NewTablePrinter is deprecated: use internal/tableprinter
tp := utils.NewTablePrinter(opts.IO)
cs := opts.IO.ColorScheme()
if opts.Exporter != nil {
return opts.Exporter.Write(opts.IO, filteredWorkflows)
}
for _, workflow := range workflows {
if workflow.Disabled() && !opts.All {
continue
}
tp.AddField(workflow.Name, nil, cs.Bold)
tp.AddField(string(workflow.State), nil, nil)
tp.AddField(fmt.Sprintf("%d", workflow.ID), nil, cs.Cyan)
cs := opts.IO.ColorScheme()
tp := tableprinter.New(opts.IO)
tp.HeaderRow("Name", "State", "ID")
for _, workflow := range filteredWorkflows {
tp.AddField(workflow.Name)
tp.AddField(string(workflow.State))
tp.AddField(fmt.Sprintf("%d", workflow.ID), tableprinter.WithColor(cs.Cyan))
tp.EndRow()
}

View file

@ -16,48 +16,37 @@ import (
"github.com/stretchr/testify/assert"
)
func Test_NewCmdList(t *testing.T) {
func TestNewCmdList(t *testing.T) {
tests := []struct {
name string
cli string
tty bool
wants ListOptions
wantsErr bool
}{
{
name: "blank tty",
tty: true,
name: "no arguments",
wants: ListOptions{
Limit: defaultLimit,
},
},
{
name: "blank nontty",
wants: ListOptions{
Limit: defaultLimit,
PlainOutput: true,
},
},
{
name: "all",
name: "all flag",
cli: "--all",
wants: ListOptions{
Limit: defaultLimit,
PlainOutput: true,
All: true,
Limit: defaultLimit,
All: true,
},
},
{
name: "limit",
name: "limit flag",
cli: "--limit 100",
wants: ListOptions{
Limit: 100,
PlainOutput: true,
Limit: 100,
},
},
{
name: "bad limit",
cli: "--limit hi",
name: "invalid limit flag",
cli: "--limit 0",
wantsErr: true,
},
}
@ -65,8 +54,6 @@ func Test_NewCmdList(t *testing.T) {
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
ios, _, _, _ := iostreams.Test()
ios.SetStdinTTY(tt.tty)
ios.SetStdoutTTY(tt.tty)
f := &cmdutil.Factory{
IOStreams: ios,
@ -80,6 +67,7 @@ func Test_NewCmdList(t *testing.T) {
gotOpts = opts
return nil
})
cmd.SetArgs(argv)
cmd.SetIn(&bytes.Buffer{})
cmd.SetOut(io.Discard)
@ -91,8 +79,9 @@ func Test_NewCmdList(t *testing.T) {
return
}
assert.NoError(t, err)
assert.Equal(t, tt.wants.Limit, gotOpts.Limit)
assert.Equal(t, tt.wants.PlainOutput, gotOpts.PlainOutput)
assert.Equal(t, tt.wants.All, gotOpts.All)
})
}
}
@ -127,23 +116,52 @@ func TestListRun(t *testing.T) {
tty bool
}{
{
name: "blank tty",
tty: true,
name: "lists worrkflows nontty",
opts: &ListOptions{
Limit: defaultLimit,
},
wantOut: "Go active 707\nLinter active 666\n",
},
{
name: "blank nontty",
opts: &ListOptions{
Limit: defaultLimit,
PlainOutput: true,
},
wantOut: "Go\tactive\t707\nLinter\tactive\t666\n",
},
{
name: "pagination",
name: "lists workflows tty",
opts: &ListOptions{
Limit: defaultLimit,
},
tty: true,
wantOut: "NAME STATE ID\nGo active 707\nLinter active 666\n",
},
{
name: "lists workflows with limit tty",
opts: &ListOptions{
Limit: 1,
},
tty: true,
wantOut: "NAME STATE ID\nGo active 707\n",
},
{
name: "show all workflows tty",
opts: &ListOptions{
Limit: defaultLimit,
All: true,
},
tty: true,
wantOut: "NAME STATE ID\nGo active 707\nLinter active 666\nRelease disabled_manually 451\n",
},
{
name: "no results nontty",
opts: &ListOptions{
Limit: defaultLimit,
},
stubs: func(reg *httpmock.Registry) {
reg.Register(
httpmock.REST("GET", "repos/OWNER/REPO/actions/workflows"),
httpmock.JSONResponse(shared.WorkflowsPayload{}),
)
},
wantErr: true,
},
{
name: "paginates workflows nontty",
opts: &ListOptions{
Limit: 101,
},
@ -170,38 +188,6 @@ func TestListRun(t *testing.T) {
},
wantOut: longOutput,
},
{
name: "no results",
opts: &ListOptions{
Limit: defaultLimit,
PlainOutput: true,
},
stubs: func(reg *httpmock.Registry) {
reg.Register(
httpmock.REST("GET", "repos/OWNER/REPO/actions/workflows"),
httpmock.JSONResponse(shared.WorkflowsPayload{}),
)
},
wantErr: true,
},
{
name: "show all workflows",
opts: &ListOptions{
Limit: defaultLimit,
All: true,
},
tty: true,
wantOut: "Go active 707\nLinter active 666\nRelease disabled_manually 451\n",
},
{
name: "respects limit",
opts: &ListOptions{
Limit: 1,
All: true,
},
tty: true,
wantOut: "Go active 707\n",
},
}
for _, tt := range tests {
@ -224,6 +210,7 @@ func TestListRun(t *testing.T) {
ios, _, stdout, stderr := iostreams.Test()
ios.SetStdoutTTY(tt.tty)
tt.opts.IO = ios
tt.opts.BaseRepo = func() (ghrepo.Interface, error) {
return ghrepo.FromFullName("OWNER/REPO")
}

View file

@ -8,6 +8,7 @@ import (
"io"
"net/url"
"path"
"reflect"
"strconv"
"strings"
@ -49,6 +50,24 @@ func (w *Workflow) Base() string {
return path.Base(w.Path)
}
func (w *Workflow) ExportData(fields []string) map[string]interface{} {
fieldByName := func(v reflect.Value, field string) reflect.Value {
return v.FieldByNameFunc(func(s string) bool {
return strings.EqualFold(field, s)
})
}
v := reflect.ValueOf(w).Elem()
data := map[string]interface{}{}
for _, f := range fields {
switch f {
default:
sf := fieldByName(v, f)
data[f] = sf.Interface()
}
}
return data
}
func GetWorkflows(client *api.Client, repo ghrepo.Interface, limit int) ([]Workflow, error) {
perPage := limit
page := 1

View file

@ -37,6 +37,9 @@ var SilentError = errors.New("SilentError")
// CancelError signals user-initiated cancellation
var CancelError = errors.New("CancelError")
// PendingError signals nothing failed but something is pending
var PendingError = errors.New("PendingError")
func IsUserCancellation(err error) bool {
return errors.Is(err, CancelError) || errors.Is(err, terminal.InterruptErr)
}

View file

@ -17,19 +17,20 @@ import (
)
type Factory struct {
IOStreams *iostreams.IOStreams
Prompter prompter.Prompter
Browser browser.Browser
GitClient *git.Client
HttpClient func() (*http.Client, error)
BaseRepo func() (ghrepo.Interface, error)
Remotes func() (context.Remotes, error)
Config func() (config.Config, error)
Branch func() (string, error)
AppVersion string
ExecutableName string
Browser browser.Browser
ExtensionManager extensions.ExtensionManager
ExecutableName string
GitClient *git.Client
IOStreams *iostreams.IOStreams
Prompter prompter.Prompter
BaseRepo func() (ghrepo.Interface, error)
Branch func() (string, error)
Config func() (config.Config, error)
HttpClient func() (*http.Client, error)
Remotes func() (context.Remotes, error)
}
// Executable is the path to the currently invoked binary

View file

@ -51,7 +51,7 @@ type IOStreams struct {
In fileReader
Out fileWriter
ErrOut io.Writer
ErrOut fileWriter
terminalTheme string
@ -396,19 +396,30 @@ func System() *IOStreams {
var stdout fileWriter = os.Stdout
// On Windows with no virtual terminal processing support, translate ANSI escape
// sequences to console syscalls
// sequences to console syscalls.
if colorableStdout := colorable.NewColorable(os.Stdout); colorableStdout != os.Stdout {
// ensure that the file descriptor of the original stdout is preserved
// Ensure that the file descriptor of the original stdout is preserved.
stdout = &fdWriter{
fd: os.Stdout.Fd(),
Writer: colorableStdout,
}
}
var stderr fileWriter = os.Stderr
// On Windows with no virtual terminal processing support, translate ANSI escape
// sequences to console syscalls.
if colorableStderr := colorable.NewColorable(os.Stderr); colorableStderr != os.Stderr {
// Ensure that the file descriptor of the original stderr is preserved.
stderr = &fdWriter{
fd: os.Stderr.Fd(),
Writer: colorableStderr,
}
}
io := &IOStreams{
In: os.Stdin,
Out: stdout,
ErrOut: colorable.NewColorable(os.Stderr),
ErrOut: stderr,
pagerCommand: os.Getenv("PAGER"),
term: &terminal,
}
@ -463,7 +474,7 @@ func Test() (*IOStreams, *bytes.Buffer, *bytes.Buffer, *bytes.Buffer) {
ReadCloser: io.NopCloser(in),
},
Out: &fdWriter{fd: 1, Writer: out},
ErrOut: errOut,
ErrOut: &fdWriter{fd: 2, Writer: errOut},
term: &fakeTerm{},
}
io.SetStdinTTY(false)