Skip to content
New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Fix CLI usage with no pre-set context/config #420

Merged
merged 12 commits into from
Sep 19, 2024
Merged

Fix CLI usage with no pre-set context/config #420

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
c4a1684
Separate existence concern from fetching concern
tstirrat15 Sep 19, 2024
6953f57
Add tests that captured behavior
tstirrat15 Sep 19, 2024
3f13864
Use IfExists form
tstirrat15 Sep 19, 2024
c57f1cb
Add handling for no config case
tstirrat15 Sep 19, 2024
3dfd468
Add existence function for config
tstirrat15 Sep 19, 2024
5b857c3
Finish writing tests
tstirrat15 Sep 19, 2024
ddf0f62
Remove test that's hard to isolate
tstirrat15 Sep 19, 2024
ca7c55d
Gofumpt
tstirrat15 Sep 19, 2024
1948291
Update comment
tstirrat15 Sep 19, 2024
75a4c78
Update internal/client/client_test.go
tstirrat15 Sep 19, 2024
05907d8
Use errors.is, flatten chain
tstirrat15 Sep 19, 2024
d7a9a00
Remove unused value
tstirrat15 Sep 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion internal/client/client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ func newClientForCurrentContext(cmd *cobra.Command) (Client, error) {
}

func newClientForContext(cmd *cobra.Command, contextName string, secretStore storage.SecretStore) (*authzed.Client, error) {
currentToken, err := storage.GetToken(contextName, secretStore)
currentToken, err := storage.GetTokenIfExists(contextName, secretStore)
if err != nil {
return nil, err
}
Expand All @@ -74,6 +74,14 @@ func newClientForContext(cmd *cobra.Command, contextName string, secretStore sto

// GetCurrentTokenWithCLIOverride returns the current token, but overridden by any parameter specified via CLI args
func GetCurrentTokenWithCLIOverride(cmd *cobra.Command, configStore storage.ConfigStore, secretStore storage.SecretStore) (storage.Token, error) {
// Handle the no-config case separately
configExists, err := configStore.Exists()
if err != nil {
return storage.Token{}, err
}
if !configExists {
return GetTokenWithCLIOverride(cmd, storage.Token{})
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

shouldn't CLI override... override the context?

}
token, err := storage.CurrentToken(
configStore,
secretStore,
Expand Down
90 changes: 74 additions & 16 deletions internal/client/client_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package client_test

import (
"os"
"path"
"testing"

"github.com/authzed/zed/internal/client"
Expand All @@ -12,10 +13,11 @@ import (
)

func TestGetTokenWithCLIOverride(t *testing.T) {
require := require.New(t)
testCert, err := os.CreateTemp("", "")
require.NoError(t, err)
require.NoError(err)
_, err = testCert.Write([]byte("hi"))
require.NoError(t, err)
require.NoError(err)
cmd := zedtesting.CreateTestCobraCommandWithFlagValue(t,
zedtesting.StringFlag{FlagName: "token", FlagValue: "t1", Changed: true},
zedtesting.StringFlag{FlagName: "certificate-path", FlagValue: testCert.Name(), Changed: true},
Expand All @@ -29,13 +31,13 @@ func TestGetTokenWithCLIOverride(t *testing.T) {

// cli args take precedence when defined
to, err := client.GetTokenWithCLIOverride(cmd, storage.Token{})
require.NoError(t, err)
require.True(t, to.AnyValue())
require.Equal(t, "t1", to.APIToken)
require.Equal(t, "e1", to.Endpoint)
require.Equal(t, []byte("hi"), to.CACert)
require.Equal(t, &bTrue, to.Insecure)
require.Equal(t, &bTrue, to.NoVerifyCA)
require.NoError(err)
require.True(to.AnyValue())
require.Equal("t1", to.APIToken)
require.Equal("e1", to.Endpoint)
require.Equal([]byte("hi"), to.CACert)
require.Equal(&bTrue, to.Insecure)
require.Equal(&bTrue, to.NoVerifyCA)

// storage token takes precedence when defined
cmd = zedtesting.CreateTestCobraCommandWithFlagValue(t,
Expand All @@ -52,11 +54,67 @@ func TestGetTokenWithCLIOverride(t *testing.T) {
Insecure: &bFalse,
NoVerifyCA: &bFalse,
})
require.NoError(t, err)
require.True(t, to.AnyValue())
require.Equal(t, "t2", to.APIToken)
require.Equal(t, "e2", to.Endpoint)
require.Equal(t, []byte("bye"), to.CACert)
require.Equal(t, &bFalse, to.Insecure)
require.Equal(t, &bFalse, to.NoVerifyCA)
require.NoError(err)
require.True(to.AnyValue())
require.Equal("t2", to.APIToken)
require.Equal("e2", to.Endpoint)
require.Equal([]byte("bye"), to.CACert)
require.Equal(&bFalse, to.Insecure)
require.Equal(&bFalse, to.NoVerifyCA)
}

func TestGetCurrentTokenWithCLIOverrideWithoutConfigFile(t *testing.T) {
// When we refactored the token setting logic, we broke the workflow where zed is used without a saved
// configuration. This asserts that that workflow works.
require := require.New(t)
cmd := zedtesting.CreateTestCobraCommandWithFlagValue(t,
zedtesting.StringFlag{FlagName: "token", FlagValue: "t1", Changed: true},
zedtesting.StringFlag{FlagName: "endpoint", FlagValue: "e1", Changed: true},
zedtesting.StringFlag{FlagName: "certificate-path", FlagValue: "", Changed: false},
zedtesting.BoolFlag{FlagName: "insecure", FlagValue: true, Changed: true},
)

bTrue := true

configStore := &storage.JSONConfigStore{ConfigPath: "/not/a/valid/path"}
secretStore := &storage.KeychainSecretStore{ConfigPath: "/not/a/valid/path"}
token, err := client.GetCurrentTokenWithCLIOverride(cmd, configStore, secretStore)

// cli args take precedence when defined
require.NoError(err)
require.True(token.AnyValue())
require.Equal("t1", token.APIToken)
require.Equal("e1", token.Endpoint)
require.Equal(&bTrue, token.Insecure)
tstirrat15 marked this conversation as resolved.
Show resolved Hide resolved
}

func TestGetCurrentTokenWithCLIOverrideWithoutSecretFile(t *testing.T) {
// When we refactored the token setting logic, we broke the workflow where zed is used without a saved
// context. This asserts that that workflow works.
require := require.New(t)
cmd := zedtesting.CreateTestCobraCommandWithFlagValue(t,
zedtesting.StringFlag{FlagName: "token", FlagValue: "t1", Changed: true},
zedtesting.StringFlag{FlagName: "endpoint", FlagValue: "e1", Changed: true},
zedtesting.StringFlag{FlagName: "certificate-path", FlagValue: "", Changed: false},
zedtesting.BoolFlag{FlagName: "insecure", FlagValue: true, Changed: true},
)

bTrue := true

tmpDir, err := os.MkdirTemp("", "")
require.NoError(err)
configPath := path.Join(tmpDir, "config.json")
err = os.WriteFile(configPath, []byte("{}"), 0o600)
require.NoError(err)

configStore := &storage.JSONConfigStore{ConfigPath: tmpDir}
secretStore := &storage.KeychainSecretStore{ConfigPath: "/not/a/valid/path"}
token, err := client.GetCurrentTokenWithCLIOverride(cmd, configStore, secretStore)

// cli args take precedence when defined
require.NoError(err)
require.True(token.AnyValue())
require.Equal("t1", token.APIToken)
require.Equal("e1", token.Endpoint)
require.Equal(&bTrue, token.Insecure)
}
26 changes: 23 additions & 3 deletions internal/storage/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ const configFileName = "config.json"
// ErrConfigNotFound is returned if there is no Config in a ConfigStore.
var ErrConfigNotFound = errors.New("config did not exist")

// ErrTokenNotFound is returned if there is no Token in a ConfigStore.
var ErrTokenNotFound = errors.New("token does not exist")

// Config represents the contents of a zed configuration file.
type Config struct {
Version string
Expand All @@ -25,6 +28,7 @@ type Config struct {
type ConfigStore interface {
Get() (Config, error)
Put(Config) error
Exists() (bool, error)
}

// TokenWithOverride returns a Token that retrieves its values from the reference Token, and has its values overridden
Expand Down Expand Up @@ -69,23 +73,28 @@ func TokenWithOverride(overrideToken Token, referenceToken Token) (Token, error)

// CurrentToken is a convenient way to obtain the CurrentToken field from the
// current Config.
func CurrentToken(cs ConfigStore, ss SecretStore) (Token, error) {
func CurrentToken(cs ConfigStore, ss SecretStore) (token Token, err error) {
cfg, err := cs.Get()
if err != nil {
return Token{}, err
}

return GetToken(cfg.CurrentToken, ss)
return GetTokenIfExists(cfg.CurrentToken, ss)
}

// SetCurrentToken is a convenient way to set the CurrentToken field in a
// the current config.
func SetCurrentToken(name string, cs ConfigStore, ss SecretStore) error {
// Ensure the token exists
if _, err := GetToken(name, ss); err != nil {
exists, err := TokenExists(name, ss)
if err != nil {
return err
}

if !exists {
return ErrTokenNotFound
}

cfg, err := cs.Get()
if err != nil {
if errors.Is(err, ErrConfigNotFound) {
Expand Down Expand Up @@ -139,6 +148,17 @@ func (s JSONConfigStore) Put(cfg Config) error {
return atomicWriteFile(filepath.Join(s.ConfigPath, configFileName), cfgBytes, 0o774)
}

func (s JSONConfigStore) Exists() (bool, error) {
_, err := os.Stat(filepath.Join(s.ConfigPath, configFileName))
if err != nil {
if os.IsNotExist(err) {
return false, nil
}
return false, err
}
return true, nil
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

purely a style nit, but I'm used to seeing this written more like:

Suggested change
_, err := os.Stat(filepath.Join(s.ConfigPath, configFileName))
if err != nil {
if os.IsNotExist(err) {
return false, nil
}
return false, err
}
return true, nil
if _, err := os.Stat(filepath.Join(s.ConfigPath, configFileName)); errors.Is(err, fs.ErrNotExist) {
} else if err != nil {
} else {
}

also apparently IsNotExist is soft-deprecated in favor of errors.Is: https://github.com/golang/go/blob/master/src/os/error.go#L88-L89

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I dig

}

// atomicWriteFile writes data to filename+some suffix, then renames it into
// filename.
//
Expand Down
23 changes: 18 additions & 5 deletions internal/storage/secrets.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,6 @@ import (
"github.com/authzed/zed/internal/console"
)

// ErrTokenNotFound is returned if there is no Token in a ConfigStore.
var ErrTokenNotFound = errors.New("token does not exist")

type Token struct {
Name string
Endpoint string
Expand Down Expand Up @@ -72,7 +69,8 @@ type SecretStore interface {
Put(s Secrets) error
}

func GetToken(name string, ss SecretStore) (Token, error) {
// Returns an empty token if no token exists.
func GetTokenIfExists(name string, ss SecretStore) (Token, error) {
secrets, err := ss.Get()
if err != nil {
return Token{}, err
Expand All @@ -84,7 +82,22 @@ func GetToken(name string, ss SecretStore) (Token, error) {
}
}

return Token{}, ErrTokenNotFound
return Token{}, nil
}

func TokenExists(name string, ss SecretStore) (bool, error) {
secrets, err := ss.Get()
if err != nil {
return false, err
}

for _, token := range secrets.Tokens {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is fine but makes me think Tokens should just be a map[string]Token instead of []Token

Also maybe this would make sense as a method on SecretStore?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, as I was going through this there were a bunch of things that seemed like they could be reorganized. I want to get the fix out and then loop back.

if name == token.Name {
return true, nil
}
}

return false, nil
}

func PutToken(t Token, ss SecretStore) error {
Expand Down
Loading