Skip to content

Commit

Permalink
fix: quiet flag to stop credential process errors (#160)
Browse files Browse the repository at this point in the history 
* fix: quiet flag to stop credential process errors

* Remove redundant flag

The quiet flag and alias are sufficient for the need and the redundant non-interactive flag can be left out

Co-authored-by: Tim Heurich <theurichde@users.noreply.github.com>

* Whitespace correction in README

Fixes #159 

---------

Co-authored-by: Josh Rivers <josh@joshrivers.me>
Co-authored-by: Tim Heurich <theurichde@users.noreply.github.com>
  • Loading branch information
@joshrivers @theurichde
3 people authored Jan 4, 2024
1 parent 8a3018a commit 07ecbd0
Show file tree
Hide file tree
Showing 8 changed files with 160 additions and 20 deletions.
4 changes: 4 additions & 0 deletions .github/workflows/build-and-test.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,5 +35,9 @@ jobs:
go vet github.com/theurichde/go-aws-sso/internal
- name: Tests
run: |
go clean -r -testcache
go clean -r -x -modcache
go clean -r -x -testcache
go clean -r -x -cache
go test -v ./...
go test -v github.com/theurichde/go-aws-sso/internal
19 changes: 10 additions & 9 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67,15 +67,16 @@ DESCRIPTION:
Assume directly into an account and SSO role
OPTIONS:
--start-url value, -u value set / override the SSO login start-url. (Example: https://my-login.awsapps.com/start#/)
--region value, -r value set / override the AWS region
--profile value, -p value the profile name you want to set in your ~/.aws/credentials file (default: "default")
--persist whether or not you want to write your short-living credentials to ~/.aws/credentials (default: false)
--force removes the temporary access token and forces the retrieval of a new token (default: false)
--debug enables debug logging (default: false)
--role-name value, -n value The role name you want to assume
--account-id value, -a value The account id where your role lives in
--help, -h show help
--start-url value, -u value set / override the SSO login start-url. (Example: https://my-login.awsapps.com/start#/)
--region value, -r value set / override the AWS region
--profile value, -p value the profile name you want to set in your ~/.aws/credentials file (default: "default")
--persist whether or not you want to write your short-living credentials to ~/.aws/credentials (default: false)
--force removes the temporary access token and forces the retrieval of a new token (default: false)
--debug enables debug logging (default: false)
--role-name value, -n value The role name you want to assume
--account-id value, -a value The account id where your role lives in
--quiet, -q disables logger output (default: false)
--help, -h show help
```

* Execute `go-aws-sso assume --account-id YOUR_ID --role-name YOUR_ROLE_NAME`
Expand Down
12 changes: 12 additions & 0 deletions cmd/go-aws-sso/main.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,14 @@ func main() {
Aliases: []string{"a"},
Usage: "The account id where your role lives in",
}),
&cli.BoolFlag{
Name: "quiet",
Usage: "disables logger output",
Aliases: []string{"q"},
Value: false,
Hidden: false,
Required: false,
},
}...),
},
}
Expand Down Expand Up @@ -256,6 +264,10 @@ func applyForceFlag(context *cli.Context) {
}

func initializeLogger(context *cli.Context) {
if context.Bool("quiet") {
zap.ReplaceGlobals(zap.NewNop())
return
}
config := zap.NewProductionEncoderConfig()
config.EncodeTime = zapcore.TimeEncoderOfLayout("2006-01-02 15:04:05")

Expand Down
130 changes: 126 additions & 4 deletions cmd/go-aws-sso/main_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ package main

import (
"flag"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
"os"
"testing"
"time"
Expand Down Expand Up @@ -61,10 +63,14 @@ func (t mockTime) Now() time.Time {
}

func Test_start(t *testing.T) {

os.Remove(os.TempDir() + "/go-aws-sso.lock")
temp, err := os.CreateTemp("", "go-aws-sso_start")
check(err)
CredentialsFilePath = temp.Name()
defer func(path string) {
os.RemoveAll(path)
os.Remove(os.TempDir() + "/go-aws-sso.lock")
}(CredentialsFilePath)

dummyInt := int64(132465)
dummy := "dummy"
Expand Down Expand Up @@ -153,9 +159,6 @@ func Test_start(t *testing.T) {
if got != want {
t.Errorf("Got: %v, but wanted: %v", got, want)
}

defer os.RemoveAll(CredentialsFilePath)

}

type mockPromptUISelector struct {
Expand All @@ -168,3 +171,122 @@ func (receiver mockPromptUISelector) Select(_ string, _ []string, _ func(input s
func (receiver mockPromptUISelector) Prompt(_ string, _ string) string {
return ""
}

func Test_initializeLogger(t *testing.T) {
type levelsEnabled struct {
fatal bool
error bool
warn bool
info bool
debug bool
}
tests := []struct {
name string
flags []string
want levelsEnabled
}{
{
name: "default",
flags: []string{},
want: levelsEnabled{
fatal: true,
error: true,
warn: true,
info: true,
debug: false,
},
},
{
name: "debug flag only",
flags: []string{"--debug"},
want: levelsEnabled{
fatal: true,
error: true,
warn: true,
info: true,
debug: true,
},
},
{
name: "quiet flag only",
flags: []string{"--quiet"},
want: levelsEnabled{
fatal: false,
error: false,
warn: false,
info: false,
debug: false,
},
},
{
name: "quiet flag alias only",
flags: []string{"-q"},
want: levelsEnabled{
fatal: false,
error: false,
warn: false,
info: false,
debug: false,
},
},
{
name: "quiet flag alternate alias only",
flags: []string{"--non-interactive"},
want: levelsEnabled{
fatal: false,
error: false,
warn: false,
info: false,
debug: false,
},
},
{
name: "quiet flag overrides debug flag",
flags: []string{"--debug", "--quiet"},
want: levelsEnabled{
fatal: false,
error: false,
warn: false,
info: false,
debug: false,
},
},
}
// replace the zap logger with a temporary instance
emptyLogger := &zap.Logger{}
reset := zap.ReplaceGlobals(emptyLogger)
defer reset()
for _, tt := range tests {
zap.ReplaceGlobals(emptyLogger)
t.Run(tt.name, func(t *testing.T) {
flagSet := flag.NewFlagSet("test-set", flag.ContinueOnError)
flagSet.Bool("debug", false, "")
flagPtr := flagSet.Bool("quiet", false, "")
flagSet.BoolVar(flagPtr, "q", false, "")
flagSet.BoolVar(flagPtr, "non-interactive", false, "")

err := flagSet.Parse(tt.flags)
if err != nil {
t.Fatal(err)
}
context := cli.NewContext(nil, flagSet, nil)

initializeLogger(context)
initializedLogger := zap.L()
if initializedLogger == emptyLogger {
t.Errorf("initializeLogger() did not initialize the logger")
}
// check if the logger is enabled for the desired levels
gotLevels := levelsEnabled{
fatal: initializedLogger.Core().Enabled(zapcore.FatalLevel),
error: initializedLogger.Core().Enabled(zapcore.ErrorLevel),
warn: initializedLogger.Core().Enabled(zapcore.WarnLevel),
info: initializedLogger.Core().Enabled(zapcore.InfoLevel),
debug: initializedLogger.Core().Enabled(zapcore.DebugLevel),
}
if tt.want != gotLevels {
t.Errorf("Got: %v, but wanted: %v", gotLevels, tt.want)
}
})
}
}
7 changes: 5 additions & 2 deletions internal/assume_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,14 @@ func (m mockSSOClient) GetRoleCredentials(*sso.GetRoleCredentialsInput) (*sso.Ge
}

func TestAssumeDirectly(t *testing.T) {

os.Remove(os.TempDir() + "/go-aws-sso.lock")
temp, err := os.CreateTemp("", "go-aws-sso-assume-directly_")
check(err)
CredentialsFilePath = temp.Name()
defer func(path string) {
os.RemoveAll(path)
os.Remove(os.TempDir() + "/go-aws-sso.lock")
}(CredentialsFilePath)

dummyInt := int64(132465)
dummy := "dummy_assume_directly"
Expand Down Expand Up @@ -97,7 +101,6 @@ func TestAssumeDirectly(t *testing.T) {
AssumeDirectly(oidcClient, ssoClient, ctx)

content, _ := os.ReadFile(CredentialsFilePath)
defer os.RemoveAll(CredentialsFilePath)
got := string(content)
want := "[default]\naws_access_key_id = dummy_assume_directly\naws_secret_access_key = dummy_assume_directly\naws_session_token = dummy_assume_directly\nregion = eu-central-1\n"

Expand Down
3 changes: 1 addition & 2 deletions internal/config_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ import (
"flag"
"github.com/urfave/cli/v2"
"gopkg.in/yaml.v3"
"io/ioutil"
"os"
"path"
"reflect"
Expand Down Expand Up @@ -52,7 +51,7 @@ func TestWriteConfig(t *testing.T) {
configFile, err := os.Open(tempFile)
fail(err, t)

bytes, err := ioutil.ReadFile(configFile.Name())
bytes, err := os.ReadFile(configFile.Name())
fail(err, t)

gotAppConfig := AppConfig{}
Expand Down
2 changes: 1 addition & 1 deletion pkg/sso/file_system.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ func ProcessCredentialProcessTemplate(accountId string, roleName string, region
exeName, err := os.Executable()
check(err)
profileTemplate := CredentialsFileTemplate{
CredentialProcess: fmt.Sprintf("%s assume -a %s -n %s", exeName, accountId, roleName),
CredentialProcess: fmt.Sprintf("%s assume -q -a %s -n %s", exeName, accountId, roleName),
Region: region,
}
return profileTemplate
Expand Down
3 changes: 1 addition & 2 deletions pkg/sso/file_system_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ package sso
import (
"encoding/json"
"gopkg.in/ini.v1"
"io/ioutil"
"os"
"reflect"
"testing"
Expand Down Expand Up @@ -75,7 +74,7 @@ func TestWriteClientInfoToFile(t *testing.T) {
}

got := ClientInformation{}
content, _ := ioutil.ReadFile(tt.args.dest)
content, _ := os.ReadFile(tt.args.dest)
err = json.Unmarshal(content, &got)
if err != nil {
t.Error(err)
Expand Down

0 comments on commit 07ecbd0

Please sign in to comment.