Skip to content

Commit 719342a

Browse files
fatihfatih
authored
Merge pull request #136 from planetscale/fatih/org-switch
cmd: improve configuration sourcing and `pscale org` commands
2 parents 269a555 + 19e0d7e commit 719342a

File tree

8 files changed

+233
-126
lines changed

8 files changed

+233
-126
lines changed

‎internal/cmd/auth/login.go

+18-6
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,10 @@ func LoginCmd(cfg *config.Config) *cobra.Command {
9696

9797
func writeDefaultOrganization(ctx context.Context, accessToken, authURL string) error {
9898
// After successfully logging in, attempt to set the org by default.
99-
client, err := planetscale.NewClient(planetscale.WithAccessToken(accessToken), planetscale.WithBaseURL(authURL))
99+
client, err := planetscale.NewClient(
100+
planetscale.WithAccessToken(accessToken),
101+
planetscale.WithBaseURL(authURL),
102+
)
100103
if err != nil {
101104
return err
102105
}
@@ -108,7 +111,7 @@ func writeDefaultOrganization(ctx context.Context, accessToken, authURL string)
108111

109112
if len(orgs) > 0 {
110113
defaultOrg := orgs[0].Name
111-
writableConfig := &config.GlobalConfig{
114+
writableConfig := &config.FileConfig{
112115
Organization: defaultOrg,
113116
}
114117

@@ -121,20 +124,29 @@ func writeDefaultOrganization(ctx context.Context, accessToken, authURL string)
121124
return nil
122125
}
123126

124-
// TODO(iheanyi): Double-check the file permissions in this function.
125127
func writeAccessToken(ctx context.Context, accessToken string) error {
126-
_, err := os.Stat(config.ConfigDir())
128+
configDir, err := config.ConfigDir()
129+
if err != nil {
130+
return err
131+
}
132+
133+
_, err = os.Stat(configDir)
127134
if os.IsNotExist(err) {
128-
err := os.MkdirAll(config.ConfigDir(), 0771)
135+
err := os.MkdirAll(configDir, 0771)
129136
if err != nil {
130137
return errors.Wrap(err, "error creating config directory")
131138
}
132139
} else if err != nil {
133140
return err
134141
}
135142

143+
tokenPath, err := config.AccessTokenPath()
144+
if err != nil {
145+
return err
146+
}
147+
136148
tokenBytes := []byte(accessToken)
137-
err = ioutil.WriteFile(config.AccessTokenPath(), tokenBytes, 0666)
149+
err = ioutil.WriteFile(tokenPath, tokenBytes, 0666)
138150
if err != nil {
139151
return errors.Wrap(err, "error writing token")
140152
}

‎internal/cmd/auth/logout.go

+19-12
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,9 @@ func LogoutCmd(cfg *config.Config) *cobra.Command {
2020
var apiURL string
2121

2222
cmd := &cobra.Command{
23-
Use: "logout",
24-
Args: cobra.ExactArgs(0),
25-
Short: "Log out of the PlanetScale API",
26-
Long: "TODO",
27-
Example: "TODO",
23+
Use: "logout",
24+
Args: cobra.NoArgs,
25+
Short: "Log out of the PlanetScale API",
2826
RunE: func(cmd *cobra.Command, args []string) error {
2927
if cfg.AccessToken == "" {
3028
fmt.Println("Already logged out. Exiting...")
@@ -66,22 +64,31 @@ func LogoutCmd(cfg *config.Config) *cobra.Command {
6664
}
6765

6866
func deleteAccessToken() error {
69-
_, err := os.Stat(config.AccessTokenPath())
67+
tokenPath, err := config.AccessTokenPath()
7068
if err != nil {
71-
if os.IsNotExist(err) {
72-
return nil
73-
}
7469
return err
7570
}
7671

77-
err = os.Remove(config.AccessTokenPath())
72+
err = os.Remove(tokenPath)
7873
if err != nil {
74+
if os.IsNotExist(err) {
75+
fmt.Println("yooo tokenpath")
76+
}
77+
fmt.Printf("err = %+v\n", err)
7978
return errors.Wrap(err, "error removing access token file")
8079
}
8180

82-
err = os.Remove(config.DefaultGlobalConfigPath())
81+
configFile, err := config.DefaultConfigPath()
8382
if err != nil {
84-
return errors.Wrap(err, "error removing config file")
83+
return err
84+
}
85+
86+
err = os.Remove(configFile)
87+
if err != nil {
88+
if os.IsNotExist(err) {
89+
fmt.Println("yooo configFile")
90+
}
91+
return errors.Wrap(err, "error removing default config file")
8592
}
8693

8794
return nil

‎internal/cmd/branch/switch.go

+15-9
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@ func SwitchCmd(cfg *config.Config) *cobra.Command {
3030
return err
3131
}
3232

33-
fmt.Printf("Finding branch %s on database %s\n", cmdutil.BoldBlue(branch), cmdutil.BoldBlue(cfg.Database))
33+
fmt.Printf("Finding branch %s on database %s\n",
34+
cmdutil.BoldBlue(branch), cmdutil.BoldBlue(cfg.Database))
3435

3536
_, err = client.DatabaseBranches.Get(ctx, &planetscale.GetDatabaseBranchRequest{
3637
Organization: cfg.Organization,
@@ -66,12 +67,13 @@ func SwitchCmd(cfg *config.Config) *cobra.Command {
6667
end()
6768
}
6869

69-
cfg := config.WritableProjectConfig{
70-
Database: cfg.Database,
71-
Branch: branch,
70+
cfg := config.FileConfig{
71+
Organization: cfg.Organization,
72+
Database: cfg.Database,
73+
Branch: branch,
7274
}
7375

74-
if err := cfg.WriteDefault(); err != nil {
76+
if err := cfg.WriteProject(); err != nil {
7577
return errors.Wrap(err, "error writing project configuration file")
7678
}
7779

@@ -81,10 +83,14 @@ func SwitchCmd(cfg *config.Config) *cobra.Command {
8183
},
8284
}
8385

84-
cmd.PersistentFlags().StringVar(&cfg.Organization, "org", cfg.Organization, "The organization for the current user")
85-
cmd.PersistentFlags().StringVar(&cfg.Database, "database", cfg.Database, "The database this project is using")
86-
cmd.Flags().StringVar(&parentBranch, "parent-branch", "main", "parent branch to inherit from if a new branch is being created")
87-
cmd.Flags().BoolVar(&autoCreate, "create", false, "if enabled, will automatically create the branch if it does not exist")
86+
cmd.PersistentFlags().StringVar(&cfg.Organization, "org", cfg.Organization,
87+
"The organization for the current user")
88+
cmd.PersistentFlags().StringVar(&cfg.Database, "database", cfg.Database,
89+
"The database this project is using")
90+
cmd.Flags().StringVar(&parentBranch, "parent-branch", "main",
91+
"parent branch to inherit from if a new branch is being created")
92+
cmd.Flags().BoolVar(&autoCreate, "create", false,
93+
"if enabled, will automatically create the branch if it does not exist")
8894

8995
cmd.MarkPersistentFlagRequired("database") // nolint:errcheck
9096
return cmd

‎internal/cmd/org/show.go

+21-3
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ import (
55
"fmt"
66
"os"
77

8+
"github.com/planetscale/cli/internal/cmdutil"
89
"github.com/planetscale/cli/internal/config"
910

1011
"github.com/spf13/cobra"
@@ -16,9 +17,26 @@ func ShowCmd(cfg *config.Config) *cobra.Command {
1617
Short: "Display the currently active organization",
1718
Args: cobra.NoArgs,
1819
RunE: func(cmd *cobra.Command, args []string) error {
19-
cfg, err := config.DefaultGlobalConfig()
20+
configFile, err := config.ProjectConfigPath()
21+
if err != nil {
22+
return err
23+
}
24+
25+
cfg, err := config.NewFileConfig(configFile)
2026
if os.IsNotExist(err) {
21-
return errors.New("not authenticated, please authenticate with: \"pscale auth login\"")
27+
configFile, err = config.DefaultConfigPath()
28+
if err != nil {
29+
return err
30+
}
31+
32+
cfg, err = config.NewFileConfig(configFile)
33+
if os.IsNotExist(err) {
34+
return errors.New("not authenticated, please authenticate with: \"pscale auth login\"")
35+
}
36+
37+
if err != nil {
38+
return err
39+
}
2240
}
2341

2442
if err != nil {
@@ -29,7 +47,7 @@ func ShowCmd(cfg *config.Config) *cobra.Command {
2947
return errors.New("config file exists, but organization is not set")
3048
}
3149

32-
fmt.Println(cfg.Organization)
50+
fmt.Printf("%s (from file: %s)", cmdutil.Bold(cfg.Organization), configFile)
3351

3452
return nil
3553
},

‎internal/cmd/org/switch.go

+46-4
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@ import (
1616
)
1717

1818
func SwitchCmd(cfg *config.Config) *cobra.Command {
19+
var flags struct {
20+
filepath string
21+
}
1922
cmd := &cobra.Command{
2023
Use: "switch <organization>",
2124
Short: "Switch the currently active organization",
@@ -76,19 +79,58 @@ func SwitchCmd(cfg *config.Config) *cobra.Command {
7679
return cmd.Usage()
7780
}
7881

79-
globalCfg := &config.GlobalConfig{
80-
Organization: organization,
82+
filePath, _ := config.ProjectConfigPath()
83+
if _, err := os.Stat(filePath); err != nil {
84+
// clear the filePath if the file doesn't exist. We only switch
85+
// if the user explicilty is using a project specific file
86+
// configuration.
87+
filePath = ""
88+
}
89+
90+
// if the user defined it explicitly, use it
91+
if flags.filepath != "" {
92+
filePath = flags.filepath
8193
}
8294

83-
err = globalCfg.WriteDefault()
95+
// fallback to the default global configuration path if nothing is
96+
// set.
97+
if filePath == "" {
98+
filePath, err = config.DefaultConfigPath()
99+
if err != nil {
100+
return err
101+
}
102+
}
103+
104+
// check if a file already exists, we don't want to accidently
105+
// overwrite other values of the file config
106+
fileCfg, err := config.NewFileConfig(filePath)
107+
if os.IsNotExist(err) {
108+
// create a new file
109+
fileCfg = &config.FileConfig{
110+
Organization: organization,
111+
}
112+
} else {
113+
fileCfg.Organization = organization
114+
// TODO(fatih): check whether the branch/database exists for
115+
// the given organization and warn the user. The
116+
// branch/database combination will NOT be empty for a project
117+
// configuratin residing inside a Git repository.
118+
}
119+
120+
err = fileCfg.Write(filePath)
84121
if err != nil {
85122
return err
86123
}
87124

88-
fmt.Printf("Successfully switched to organization %s\n", cmdutil.Bold(organization))
125+
fmt.Printf("Successfully switched to organization %s (using file: %s)\n",
126+
cmdutil.Bold(organization), filePath,
127+
)
89128
return nil
90129
},
91130
}
92131

132+
cmd.PersistentFlags().StringVar(&flags.filepath, "save-config", "",
133+
"Path to store the organization. By default the configuration is deducted automatically based on where pscale is executed.")
134+
93135
return cmd
94136
}

‎internal/cmd/root.go

+18-22
Original file line numberDiff line numberDiff line change
@@ -48,33 +48,26 @@ var rootCmd = &cobra.Command{
4848
Short: "A CLI for PlanetScale",
4949
Long: `pscale is a CLI library for communicating with PlanetScale's API.`,
5050
TraverseChildren: true,
51-
// Uncomment the following line if your bare application
52-
// has an action associated with it:
53-
// Run: func(cmd *cobra.Command, args []string) { },
5451
}
5552

5653
// Execute adds all child commands to the root command and sets flags appropriately.
5754
// This is called by main.main(). It only needs to happen once to the rootCmd.
5855
func Execute(ver, commit, buildDate string) error {
5956
cobra.OnInitialize(initConfig)
6057

61-
// Here you will define your flags and configuration settings.
62-
// Cobra supports persistent flags, which, if defined here,
63-
// will be global for your application.
64-
65-
rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is $HOME/.config/planetscale/config.yaml)")
66-
58+
rootCmd.PersistentFlags().StringVar(&cfgFile, "config",
59+
"", "Config file (default is $HOME/.config/planetscale/pscale.yml)")
6760
rootCmd.SilenceUsage = true
68-
// Cobra also supports local flags, which will only run
69-
// when this action is called directly.
70-
rootCmd.Flags().BoolP("toggle", "t", false, "Help message for toggle")
7161

7262
v := version.Format(ver, commit, buildDate)
7363
rootCmd.SetVersionTemplate(v)
7464
rootCmd.Version = v
7565
rootCmd.Flags().Bool("version", false, "Show pscale version")
7666

77-
cfg := config.New()
67+
cfg, err := config.New()
68+
if err != nil {
69+
return err
70+
}
7871

7972
rootCmd.PersistentFlags().StringVar(&cfg.BaseURL,
8073
"api-url", ps.DefaultBaseURL, "The base URL for the PlanetScale API.")
@@ -130,20 +123,23 @@ func initConfig() {
130123
// Use config file from the flag.
131124
viper.SetConfigFile(cfgFile)
132125
} else {
126+
defaultConfigDir, err := config.ConfigDir()
127+
if err != nil {
128+
fmt.Println(err)
129+
os.Exit(1)
130+
}
131+
133132
// Order of preference for configuration files:
134-
// (1) $PWD/.planetscale
135-
// (2) $HOME/config/planetscale
136-
viper.AddConfigPath(".planetscale")
137-
viper.AddConfigPath(config.ConfigDir())
138-
viper.SetConfigName("config")
139-
viper.SetConfigType("yaml")
133+
// (1) $HOME/.config/planetscale
134+
viper.AddConfigPath(defaultConfigDir)
135+
viper.SetConfigName("pscale")
136+
viper.SetConfigType("yml")
140137
}
141138

142139
viper.SetEnvPrefix("planetscale")
143140
viper.AutomaticEnv() // read in environment variables that match
144141

145142
// If a config file is found, read it in.
146-
147143
if err := viper.ReadInConfig(); err != nil {
148144
if _, ok := err.(viper.ConfigFileNotFoundError); !ok {
149145
// Only handle errors when it's something unrelated to the config file not
@@ -155,9 +151,9 @@ func initConfig() {
155151

156152
// Check for a project-local configuration file to merge in if the user
157153
// has not specified a config file
158-
if rootDir, err := config.GetRootGitRepoDir(); err == nil && cfgFile == "" {
154+
if rootDir, err := config.RootGitRepoDir(); err == nil && cfgFile == "" {
159155
viper.AddConfigPath(rootDir)
160-
viper.SetConfigName(config.GetProjectConfigFile())
156+
viper.SetConfigName(config.ProjectConfigFile())
161157
viper.MergeInConfig() // nolint:errcheck
162158
}
163159

0 commit comments

Comments
 (0)