Add more env specific colors for switch-roles and introduce ordering of profiles (#64)

* upgrade to go 1.18

* upgrade go version in gh actions

* upgrade golanci lint version

* update dependencies

* update vendor

* add more environment specific colors

* add ordered flag

* add function to order a slice of profiles

* order vault profiles

* order switch-roles profiles

* update tests

* vendor

* update docs

* fix order generation

* add tests for ordering

* add an ✨oxford comma✨🎓

Co-authored-by: Mica Beneke <[email protected]>

Co-authored-by: Mica Beneke <[email protected]>

Author: oppermax

Diff for: README.md

@@ -89,6 +89,7 @@ OPTIONAL
                                    except the source profile and generated config
 --use-role-name-in-profile=false   Append the role name to the profile name
 --role=STRING                      If set, then a profile with this role will be generated for every account in the organization, in addition to the roles that the user has permissions to assume
+--ordered=true                     Saves the profiles according to alphabetical order, stage, and uniqueness
 ```
 
 Note: When using the `--role` flag we do not check to see if the user has permission to assume that role. This is useful
@@ -125,6 +126,8 @@ REQUIRED
 OPTIONAL
 
 --color="00ff7f"                    The hexcode color that should be set for each profile
+--dev-color="00d619"                The hexcode color that should be set for each profile which name ends in 'dev' or 'poc'
+--int-color="ffea00"                The hexcode color that should be set for each profile which name ends in 'int' or 'stg'
 --prd-color="ff0000"                The hexcode color that should be set for each profile which name ends in 'prd' or 'global'
 --use-role-name-in-profile=false    Append the role name to the profile name
 ```

Diff for: go.mod

@@ -6,6 +6,7 @@ require (
 	github.com/alecthomas/kong v0.6.1
 	github.com/aws/aws-sdk-go v1.44.52
 	github.com/rs/zerolog v1.27.0
+	golang.org/x/exp v0.0.0-20220706164943-b4a6d9510983
 	gopkg.in/ini.v1 v1.66.6
 )
 

Diff for: go.sum

@@ -26,6 +26,8 @@ github.com/rs/zerolog v1.27.0/go.mod h1:7frBqO0oezxmnO7GF86FY++uy8I0Tk/If5ni1G9Q
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/testify v1.7.2 h1:4jaiDzPyXQvSd7D0EjG45355tLlV3VOECpq10pLC+8s=
 github.com/stretchr/testify v1.7.2/go.mod h1:R6va5+xMeoiuVRoj+gSkQ7d3FALtqAAGI1FQKckRals=
+golang.org/x/exp v0.0.0-20220706164943-b4a6d9510983 h1:sUweFwmLOje8KNfXAVqGGAsmgJ/F8jJ6wBLJDt4BTKY=
+golang.org/x/exp v0.0.0-20220706164943-b4a6d9510983/go.mod h1:Kr81I6Kryrl9sr8s2FK3vxD90NdsKWRuOIl2O4CvYbA=
 golang.org/x/net v0.0.0-20220127200216-cd36cc0744dd/go.mod h1:CfG3xpIq0wQ8r1q4Su4UZFWDARRcnwPjda9FqA0JpMk=
 golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=

Diff for: pkg/cmd/cli.go

@@ -19,4 +19,5 @@ type CLI struct {
 	SwitchRoles SwitchRolesCmd `cmd help:"generates a config for aws-extend-switch-roles"`
 	Debug       bool           `help:"set the log level to debug" default:"false"`
 	Role        string         `help:"If set, then a profile with this role will be generated for every account in the organization, in addition to the roles that the user has permissions to assume"`
+	Ordered     bool           `help:"disable ordering based on alphabet, stage and uniqueness" default:"true"`
 }

Diff for: pkg/cmd/cmd_test.go

@@ -66,7 +66,7 @@ include_profile = default
 					KeepCustomConfig:     false,
 					UseRoleNameInProfile: false,
 					Region:               "",
-				})
+				}, true)
 			},
 		},
 		{
@@ -87,7 +87,7 @@ include_profile = default
 					KeepCustomConfig:     false,
 					UseRoleNameInProfile: false,
 					Region:               "",
-				})
+				}, true)
 			},
 		},
 		{
@@ -108,7 +108,7 @@ include_profile = default
 					KeepCustomConfig:     false,
 					UseRoleNameInProfile: false,
 					Region:               "",
-				})
+				}, true)
 			},
 		},
 		{
@@ -129,7 +129,7 @@ include_profile = my-profile
 					KeepCustomConfig:     false,
 					UseRoleNameInProfile: false,
 					Region:               "",
-				})
+				}, true)
 			},
 		},
 		{
@@ -150,7 +150,7 @@ include_profile = default
 					KeepCustomConfig:     false,
 					UseRoleNameInProfile: true,
 					Region:               "",
-				})
+				}, true)
 			},
 		},
 		{
@@ -185,7 +185,7 @@ include_profile = default
 					KeepCustomConfig:     true,
 					UseRoleNameInProfile: true,
 					Region:               "",
-				})
+				}, true)
 			},
 		},
 		{
@@ -217,7 +217,7 @@ include_profile = default
 					KeepCustomConfig:     false,
 					UseRoleNameInProfile: true,
 					Region:               "",
-				})
+				}, true)
 			},
 		},
 		{
@@ -239,7 +239,7 @@ region          = eu-central-1
 					KeepCustomConfig:     false,
 					UseRoleNameInProfile: true,
 					Region:               "eu-central-1",
-				})
+				}, true)
 			},
 		},
 		{
@@ -256,7 +256,7 @@ color          = ffffff
 					OutputFile:           filename,
 					UseRoleNameInProfile: false,
 					Color:                "ffffff",
-				})
+				}, true)
 			},
 		},
 		{
@@ -273,7 +273,7 @@ color          = ffffff
 					OutputFile:           filename,
 					UseRoleNameInProfile: true,
 					Color:                "ffffff",
-				})
+				}, true)
 			},
 		},
 		{
@@ -290,7 +290,7 @@ color          = ffffff
 					OutputFile:           filename,
 					UseRoleNameInProfile: false,
 					Color:                "ffffff",
-				})
+				}, true)
 			},
 		},
 	}
@@ -299,7 +299,12 @@ color          = ffffff
 		t.Run(fmt.Sprintf("%s %s", testCase.describe, testCase.it), func(t *testing.T) {
 
 			filename := setup(testCase.originalConfig)
-			defer os.Remove(filename)
+			defer func() {
+				err := os.Remove(filename)
+				if err != nil {
+					log.Panic(err)
+				}
+			}()
 
 			testCase.run(filename)
 

Diff for: pkg/cmd/switch_roles.go

@@ -24,32 +24,48 @@ import (
 // nolint:govet // we need the bare `required` tag here
 type SwitchRolesCmd struct {
 	Color                string `help:"The hexcode color that should be set for each profile which name doesn't end in 'prd' or 'global'" default:"00ff7f"`
+	DevColor             string `help:"The hexcode color that should be set for each profile which name ends in 'dev' or 'poc'" default:"00d619"`
+	IntColor             string `help:"The hexcode color that should be set for each profile which name ends in 'int' or 'stg'" default:"ffea00"`
 	PrdColor             string `help:"The hexcode color that should be set for each profile which name ends in 'prd' or 'global'" default:"ff0000"`
 	OutputFile           string `help:"Where to save the config." required`
 	UseRoleNameInProfile bool   `help:"Append the role name to the profile name" default:false`
 }
 
 func (swc *SwitchRolesCmd) Run(cli *CLI) error {
 	roleArns, accountMap := util.GetAWSContext().GetRolesAndAccounts(cli.Role)
-	generateSwitchRolesProfile(accountMap, roleArns, cli.SwitchRoles)
+	generateSwitchRolesProfile(accountMap, roleArns, cli.SwitchRoles, cli.Ordered)
 
 	return nil
 }
 
 func envSpecificColor(profileName string, cmdOptions SwitchRolesCmd) string {
 	lowerKeyProfileName := strings.ToLower(profileName)
 
+	if strings.HasSuffix(lowerKeyProfileName, "dev") || strings.HasSuffix(lowerKeyProfileName, "poc") {
+		return cmdOptions.DevColor
+	}
+
+	if strings.HasSuffix(lowerKeyProfileName, "int") || strings.HasSuffix(lowerKeyProfileName, "stg") {
+		return cmdOptions.IntColor
+	}
+
 	if strings.HasSuffix(lowerKeyProfileName, "prd") || strings.HasSuffix(lowerKeyProfileName, "global") {
 		return cmdOptions.PrdColor
 	}
 
 	return cmdOptions.Color
 }
 
-func generateSwitchRolesProfile(accountMap map[string]string, roleArns []string, cmdOptions SwitchRolesCmd) {
+func generateSwitchRolesProfile(accountMap map[string]string, roleArns []string, cmdOptions SwitchRolesCmd, ordered bool) {
 	config := ini.Empty()
 
-	for _, profile := range util.GetProfiles("", accountMap, roleArns, cmdOptions.UseRoleNameInProfile) {
+	profiles := util.GetProfiles("", accountMap, roleArns, cmdOptions.UseRoleNameInProfile)
+
+	if ordered {
+		profiles = util.OrderProfiles(profiles)
+	}
+
+	for _, profile := range profiles {
 		profileSection := config.Section(profile.ProfileName)
 
 		setKey := util.GetKeySetter(profileSection)

Diff for: pkg/cmd/vault.go

@@ -32,12 +32,12 @@ type VaultCmd struct {
 
 func (vc *VaultCmd) Run(cli *CLI) error {
 	roleArns, accountMap := util.GetAWSContext().GetRolesAndAccounts(cli.Role)
-	generateVaultProfile(accountMap, roleArns, cli.Vault)
+	generateVaultProfile(accountMap, roleArns, cli.Vault, cli.Ordered)
 
 	return nil
 }
 
-func generateVaultProfile(accountMap map[string]string, roleArns []string, cmdOptions VaultCmd) {
+func generateVaultProfile(accountMap map[string]string, roleArns []string, cmdOptions VaultCmd, ordered bool) {
 	config, err := ini.Load(cmdOptions.VaultConfigPath)
 	if err != nil {
 		log.Panic().Err(err).Str("file-path", cmdOptions.VaultConfigPath).Msg("could not load config")
@@ -68,8 +68,13 @@ func generateVaultProfile(accountMap map[string]string, roleArns []string, cmdOp
 
 		config = newConfig
 	}
+	profiles := util.GetProfiles("profile ", accountMap, roleArns, cmdOptions.UseRoleNameInProfile)
 
-	for _, profile := range util.GetProfiles("profile ", accountMap, roleArns, cmdOptions.UseRoleNameInProfile) {
+	if ordered {
+		profiles = util.OrderProfiles(profiles)
+	}
+
+	for _, profile := range profiles {
 		profileSection := config.Section(profile.ProfileName)
 
 		setKey := util.GetKeySetter(profileSection)

Diff for: pkg/util/order.go

@@ -0,0 +1,52 @@
+package util
+
+/*
+  Copyright 2021 MOIA GmbH
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+      http://www.apache.org/licenses/LICENSE-2.0
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+*/
+
+import (
+	"golang.org/x/exp/slices"
+	"strings"
+)
+
+var stages = []string{"poc", "stg", "dev", "int", "prd"}
+
+func profileLess(x, y Profile) bool {
+	return x.ProfileName < y.ProfileName
+}
+
+func OrderProfiles(unorderedProfiles []Profile) []Profile {
+	var singleProfiles, stagedProfiles []Profile
+
+	for _, profile := range unorderedProfiles {
+		if isStageProfile(profile) {
+			stagedProfiles = append(stagedProfiles, profile)
+		} else {
+			singleProfiles = append(singleProfiles, profile)
+		}
+
+	}
+
+	slices.SortFunc(singleProfiles, profileLess)
+	slices.SortFunc(stagedProfiles, profileLess)
+
+	return append(singleProfiles, stagedProfiles...)
+}
+
+func isStageProfile(profile Profile) bool {
+	for _, stage := range stages {
+		if strings.HasSuffix(profile.ProfileName, stage) {
+			return true
+		}
+	}
+	return false
+}

Diff for: pkg/util/order_test.go

@@ -0,0 +1,100 @@
+package util
+
+import (
+	"reflect"
+	"testing"
+)
+
+func TestOrderProfiles(t *testing.T) {
+
+	tests := []struct {
+		name              string
+		unorderedProfiles []Profile
+		want              []Profile
+	}{
+		{name: "mixed profile list",
+			unorderedProfiles: []Profile{
+				{ProfileName: "bar.int"},
+				{ProfileName: "tools"},
+				{ProfileName: "foo.dev"},
+				{ProfileName: "cookies"},
+				{ProfileName: "bar.prd"},
+				{ProfileName: "gears"},
+			},
+			want: []Profile{
+				{ProfileName: "cookies"},
+				{ProfileName: "gears"},
+				{ProfileName: "tools"},
+				{ProfileName: "bar.int"},
+				{ProfileName: "bar.prd"},
+				{ProfileName: "foo.dev"},
+			}},
+		{name: "only single profiles",
+			unorderedProfiles: []Profile{
+				{ProfileName: "bar"},
+				{ProfileName: "tools"},
+				{ProfileName: "foo"},
+				{ProfileName: "cookies"},
+				{ProfileName: "bikes"},
+				{ProfileName: "gears"},
+			},
+			want: []Profile{
+				{ProfileName: "bar"},
+				{ProfileName: "bikes"},
+				{ProfileName: "cookies"},
+				{ProfileName: "foo"},
+				{ProfileName: "gears"},
+				{ProfileName: "tools"},
+			}},
+		{name: "only staged profiles",
+			unorderedProfiles: []Profile{
+				{ProfileName: "bar.int"},
+				{ProfileName: "tools.prd"},
+				{ProfileName: "foo.dev"},
+				{ProfileName: "cookies.dev"},
+				{ProfileName: "bar.prd"},
+				{ProfileName: "gears.poc"},
+			},
+			want: []Profile{
+				{ProfileName: "bar.int"},
+				{ProfileName: "bar.prd"},
+				{ProfileName: "cookies.dev"},
+				{ProfileName: "foo.dev"},
+				{ProfileName: "gears.poc"},
+				{ProfileName: "tools.prd"},
+			}},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			if got := OrderProfiles(tt.unorderedProfiles); !reflect.DeepEqual(got, tt.want) {
+				t.Errorf("OrderProfiles() = %v, want %v", got, tt.want)
+			}
+		})
+	}
+}
+
+func Test_isStageProfile(t *testing.T) {
+
+	tests := []struct {
+		name    string
+		profile Profile
+		want    bool
+	}{
+		{name: "unique account",
+			profile: Profile{ProfileName: "cookies"},
+			want:    false},
+		{name: "dev account",
+			profile: Profile{ProfileName: "cookies.dev"},
+			want:    true},
+		{name: "global account",
+			profile: Profile{ProfileName: "tools.global"},
+			want:    false},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			if got := isStageProfile(tt.profile); got != tt.want {
+				t.Errorf("isStageProfile() = %v, want %v", got, tt.want)
+			}
+		})
+	}
+}