Merge pull request #190 from deviceinsight/feature/config-fallback

project config files

.gitignore

@@ -14,6 +14,7 @@ dist
 kafkactl
 
 ### Configs
+.kafkactl.yml
 kafkactl.yml
 
 ### Snap

CHANGELOG.md

@@ -6,6 +6,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+- [#190](https://github.com/deviceinsight/kafkactl/pull/190) Improve handling of project config files
+
 ## 4.0.0 - 2024-01-18
 
 ### Added

README.adoc

@@ -163,21 +163,48 @@ contexts:
       # optional: isolationLevel (defaults to ReadCommitted)
       isolationLevel: ReadUncommitted
 
+# optional for project config files
 current-context: default
 ----
 
+[#_config_file_read_order]
 The config file location is resolved by
 
 . checking for a provided commandline argument: `--config-file=$PATH_TO_CONFIG`
 . evaluating the environment variable: `export KAFKA_CTL_CONFIG=$PATH_TO_CONFIG`
-. checking for a config file in the working directory i.e. `$PWD/kafkactl.yml`
+. checking for a project config file in the working directory (see <<_project_config_files>>)
 . as default the config file is looked up from one of the following locations:
  ** `$HOME/.config/kafkactl/config.yml`
  ** `$HOME/.kafkactl/config.yml`
  ** `$SNAP_REAL_HOME/.kafkactl/config.yml`
  ** `$SNAP_DATA/kafkactl/config.yml`
  ** `/etc/kafkactl/config.yml`
 
+[#_project_config_files]
+==== Project config files
+
+In addition to the config file locations above, _kafkactl_ allows to create a config file on project level.
+A project config file is meant to be placed at the root level of a git repo and declares the kafka configuration
+for this repository/project.
+
+In order to identify the config file as belonging to _kafkactl_ the following names can be used:
+
+* `kafkactl.yml`
+* `.kafkactl.yml`
+
+During initialization _kafkactl_ starts from the current working directory and recursively looks for a project level
+config file. The recursive lookup ends at the boundary of a git repository (i.e. if a `.git` folder is found).
+This way, _kafkactl_ can be used conveniently anywhere in the git repository.
+
+Additionally, project config files have a special feature to use them read-only. Topically, if you configure more than
+one context in a config file, and you switch the context with `kafkactl config use-context xy` this will lead to a write
+operation on the config file to save the _current context_.
+
+In order to avoid this for project config files, one can just omit the `current-context` parameter from the config file.
+In this case _kafkactl_ will delegate read and write operations for the _current context_ to the next configuration file
+according to <<_config_file_read_order, the config file read order>>.
+
+
 === Auto completion
 
 ==== bash

cmd/alter/alter-partition.go

@@ -36,14 +36,14 @@ func newAlterPartitionCmd() *cobra.Command {
 				}
 			}
 		},
-		PreRunE: func(cmd *cobra.Command, args []string) error {
+		PreRunE: func(cmd *cobra.Command, _ []string) error {
 			return validation.ValidateAtLeastOneRequiredFlag(cmd)
 		},
 		ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
 			if len(args) == 0 {
 				return topic.CompleteTopicNames(cmd, args, toComplete)
 			} else if len(args) == 1 {
-				return partition.CompletePartitionIds(cmd, args, toComplete)
+				return partition.CompletePartitionIDs(cmd, args, toComplete)
 			}
 			return nil, cobra.ShellCompDirectiveNoFileComp
 		},

cmd/alter/alter-partition_test.go

@@ -61,7 +61,7 @@ func TestAlterPartitionReplicationFactorIntegration(t *testing.T) {
 		return
 	}
 
-	checkReplicas := func(attempt uint) error {
+	checkReplicas := func(_ uint) error {
 		_, err := kafkaCtl.Execute("describe", "topic", topicName, "-o", "yaml")
 
 		if err != nil {

cmd/alter/alter-topic.go

@@ -23,7 +23,7 @@ func newAlterTopicCmd() *cobra.Command {
 				}
 			}
 		},
-		PreRunE: func(cmd *cobra.Command, args []string) error {
+		PreRunE: func(cmd *cobra.Command, _ []string) error {
 			return validation.ValidateAtLeastOneRequiredFlag(cmd)
 		},
 		ValidArgsFunction: topic.CompleteTopicNames,

cmd/alter/alter-topic_test.go

@@ -51,7 +51,7 @@ func TestAlterTopicPartitionsIntegration(t *testing.T) {
 		t.Fatalf("failed to execute command: %v", err)
 	}
 
-	getPartitions := func(attempt uint) error {
+	getPartitions := func(_ uint) error {
 		_, err := kafkaCtl.Execute("describe", "topic", topicName, "-o", "yaml")
 
 		if err != nil {
@@ -93,7 +93,7 @@ func TestAlterTopicIncreaseReplicationFactorIntegration(t *testing.T) {
 		return
 	}
 
-	checkReplicas := func(attempt uint) error {
+	checkReplicas := func(_ uint) error {
 		_, err := kafkaCtl.Execute("describe", "topic", topicName, "-o", "yaml")
 
 		if err != nil {
@@ -137,7 +137,7 @@ func TestAlterTopicDecreaseReplicationFactorIntegration(t *testing.T) {
 		return
 	}
 
-	checkReplicas := func(attempt uint) error {
+	checkReplicas := func(_ uint) error {
 		_, err := kafkaCtl.Execute("describe", "topic", topicName, "-o", "yaml")
 
 		if err != nil {

cmd/attach/attach.go

@@ -12,7 +12,7 @@ func NewAttachCmd() *cobra.Command {
 		Use:   "attach",
 		Short: "run kafkactl pod in kubernetes and attach to it",
 		Args:  cobra.NoArgs,
-		Run: func(cobraCmd *cobra.Command, args []string) {
+		Run: func(_ *cobra.Command, _ []string) {
 			if err := k8s.NewOperation().Attach(); err != nil {
 				output.Fail(err)
 			}

cmd/clone/clone-topic_test.go

@@ -29,7 +29,7 @@ func TestCloneTopicIntegration(t *testing.T) {
 
 	testutil.AssertEquals(t, fmt.Sprintf("topic %s cloned to %s", srcTopic, targetTopic), kafkaCtl.GetStdOut())
 
-	getTopic := func(attempt uint) error {
+	getTopic := func(_ uint) error {
 		_, err := kafkaCtl.Execute("describe", "topic", targetTopic, "-o", "yaml")
 
 		if err != nil {

cmd/config/currentContext.go

@@ -1,9 +1,9 @@
 package config
 
 import (
+	"github.com/deviceinsight/kafkactl/internal/global"
 	"github.com/deviceinsight/kafkactl/output"
 	"github.com/spf13/cobra"
-	"github.com/spf13/viper"
 )
 
 func newCurrentContextCmd() *cobra.Command {
@@ -12,8 +12,8 @@ func newCurrentContextCmd() *cobra.Command {
 		Aliases: []string{"currentContext"},
 		Short:   "show current context",
 		Long:    `Displays the name of context that is currently active`,
-		Run: func(cmd *cobra.Command, args []string) {
-			context := viper.GetString("current-context")
+		Run: func(_ *cobra.Command, _ []string) {
+			context := global.GetCurrentContext()
 			output.Infof("%s", context)
 		},
 	}

cmd/config/getContexts.go

@@ -1,6 +1,7 @@
 package config
 
 import (
+	"github.com/deviceinsight/kafkactl/internal/global"
 	"github.com/deviceinsight/kafkactl/output"
 
 	"github.com/spf13/cobra"
@@ -16,9 +17,9 @@ func newGetContextsCmd() *cobra.Command {
 		Aliases: []string{"getContexts"},
 		Short:   "list configured contexts",
 		Long:    `Output names of all configured contexts`,
-		Run: func(cmd *cobra.Command, args []string) {
+		Run: func(_ *cobra.Command, _ []string) {
 			contexts := viper.GetStringMap("contexts")
-			currentContext := viper.GetString("current-context")
+			currentContext := global.GetCurrentContext()
 
 			if outputFormat == "compact" {
 				for name := range contexts {

cmd/config/useContext.go

@@ -3,6 +3,8 @@ package config
 import (
 	"sort"
 
+	"github.com/deviceinsight/kafkactl/internal/global"
+
 	"github.com/deviceinsight/kafkactl/output"
 	"github.com/pkg/errors"
 
@@ -20,7 +22,7 @@ func newUseContextCmd() *cobra.Command {
 		Short:   "switch active context",
 		Long:    `command to switch active context`,
 		Args:    cobra.MinimumNArgs(1),
-		Run: func(cmd *cobra.Command, args []string) {
+		Run: func(_ *cobra.Command, args []string) {
 
 			context := strings.Join(args, " ")
 
@@ -31,13 +33,11 @@ func newUseContextCmd() *cobra.Command {
 				output.Fail(errors.Errorf("not a valid context: %s", context))
 			}
 
-			viper.Set("current-context", context)
-
-			if err := viper.WriteConfig(); err != nil {
+			if err := global.SetCurrentContext(context); err != nil {
 				output.Fail(errors.Wrap(err, "unable to write config"))
 			}
 		},
-		ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
+		ValidArgsFunction: func(_ *cobra.Command, args []string, _ string) ([]string, cobra.ShellCompDirective) {
 			if len(args) != 0 {
 				return nil, cobra.ShellCompDirectiveNoFileComp
 			}

cmd/config/view.go

@@ -15,7 +15,7 @@ func newViewCmd() *cobra.Command {
 		Use:   "view",
 		Short: "show contents of config file",
 		Long:  `Shows the contents of the config file that is currently used`,
-		Run: func(cmd *cobra.Command, args []string) {
+		Run: func(_ *cobra.Command, _ []string) {
 
 			yamlFile, err := os.ReadFile(viper.ConfigFileUsed())
 			if err != nil {

cmd/create/create-acl.go

@@ -47,11 +47,11 @@ func newCreateACLCmd() *cobra.Command {
 	_ = cmdCreateACL.MarkFlagRequired("principal")
 	_ = cmdCreateACL.MarkFlagRequired("operation")
 
-	_ = cmdCreateACL.RegisterFlagCompletionFunc("pattern", func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
+	_ = cmdCreateACL.RegisterFlagCompletionFunc("pattern", func(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective) {
 		return []string{"match", "prefixed", "literal"}, cobra.ShellCompDirectiveDefault
 	})
 
-	_ = cmdCreateACL.RegisterFlagCompletionFunc("operation", func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
+	_ = cmdCreateACL.RegisterFlagCompletionFunc("operation", func(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective) {
 		return []string{"any", "all", "read", "write", "create", "delete", "alter", "describe", "clusteraction", "describeconfigs", "alterconfigs", "idempotentwrite"}, cobra.ShellCompDirectiveDefault
 	})
 

cmd/create/create-topic_test.go

@@ -110,7 +110,7 @@ partitions:
 }
 
 func describeTopic(t *testing.T, kafkaCtl testutil.KafkaCtlTestCommand, topicName string) {
-	describeTopic := func(attempt uint) error {
+	describeTopic := func(_ uint) error {
 		_, err := kafkaCtl.Execute("describe", "topic", topicName, "-o", "yaml")
 		return err
 	}

cmd/deletion/delete-acl.go

@@ -42,11 +42,11 @@ func newDeleteACLCmd() *cobra.Command {
 	_ = cmdDeleteACL.MarkFlagRequired("operation")
 	_ = cmdDeleteACL.MarkFlagRequired("pattern")
 
-	_ = cmdDeleteACL.RegisterFlagCompletionFunc("operation", func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
+	_ = cmdDeleteACL.RegisterFlagCompletionFunc("operation", func(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective) {
 		return []string{"any", "all", "read", "write", "create", "delete", "alter", "describe", "clusteraction", "describeconfigs", "alterconfigs", "idempotentwrite"}, cobra.ShellCompDirectiveDefault
 	})
 
-	_ = cmdDeleteACL.RegisterFlagCompletionFunc("pattern", func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
+	_ = cmdDeleteACL.RegisterFlagCompletionFunc("pattern", func(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective) {
 		return []string{"any", "match", "prefixed", "literal"}, cobra.ShellCompDirectiveDefault
 	})
 

cmd/deletion/delete-consumer-group-offset_test.go

@@ -188,7 +188,7 @@ func failedToDeleteMessage(groupName string, topic string, partition int32) stri
 }
 
 func checkOffsetDeleted(kafkaCtl testutil.KafkaCtlTestCommand, groupName string, topic string, partition int32) error {
-	checkOffsetDeleted := func(attempt uint) error {
+	checkOffsetDeleted := func(_ uint) error {
 		_, err := kafkaCtl.Execute("describe", "consumer-group", groupName, "-o", "yaml")
 
 		if err != nil {

cmd/deletion/delete-consumer-group_test.go

@@ -83,7 +83,7 @@ func TestDeleteConsumerGroupAutoCompletionIntegration(t *testing.T) {
 
 func verifyConsumerGroupDeleted(t *testing.T, kafkaCtl testutil.KafkaCtlTestCommand, groupName string) {
 
-	checkConsumerGrouDeleted := func(attempt uint) error {
+	checkConsumerGrouDeleted := func(_ uint) error {
 		_, err := kafkaCtl.Execute("get", "consumer-groups", "-o", "compact")
 
 		if err != nil {

cmd/deletion/delete-topic_test.go

@@ -83,7 +83,7 @@ func TestDeleteTopicAutoCompletionIntegration(t *testing.T) {
 
 func verifyTopicDeleted(t *testing.T, kafkaCtl testutil.KafkaCtlTestCommand, topicName string) {
 
-	checkTopicDeleted := func(attempt uint) error {
+	checkTopicDeleted := func(_ uint) error {
 		_, err := kafkaCtl.Execute("get", "topics", "-o", "compact")
 
 		if err != nil {

cmd/describe/describe-broker.go

@@ -30,7 +30,7 @@ func newDescribeBrokerCmd() *cobra.Command {
 				}
 			}
 		},
-		ValidArgsFunction: broker.CompleteBrokerIds,
+		ValidArgsFunction: broker.CompleteBrokerIDs,
 	}
 
 	cmdDescribeBroker.Flags().StringVarP(&flags.OutputFormat, "output", "o", flags.OutputFormat, "output format. One of: json|yaml|wide")

cmd/describe/describe-consumer-group.go

@@ -24,7 +24,7 @@ func newDescribeConsumerGroupCmd() *cobra.Command {
 				}
 			}
 		},
-		ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
+		ValidArgsFunction: func(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective) {
 			return consumergroups.CompleteConsumerGroupsFiltered(flags)
 		},
 	}

cmd/docs.go

@@ -22,7 +22,7 @@ func newDocsCmd() *cobra.Command {
 		Short:  "Generate documentation as markdown or man pages",
 		Long:   docsDesc,
 		Hidden: true,
-		Run: func(cmd *cobra.Command, args []string) {
+		Run: func(cmd *cobra.Command, _ []string) {
 			if err := (&internal.DocsOperation{}).GenerateDocs(cmd.Root(), flags); err != nil {
 				output.Fail(err)
 			}

cmd/get/get-acl.go

@@ -39,11 +39,11 @@ func newGetACLCmd() *cobra.Command {
 
 	cmdGetAcls.Flags().StringVarP(&flags.OutputFormat, "output", "o", flags.OutputFormat, "output format. One of: json|yaml")
 
-	_ = cmdGetAcls.RegisterFlagCompletionFunc("operation", func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
+	_ = cmdGetAcls.RegisterFlagCompletionFunc("operation", func(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective) {
 		return []string{"any", "all", "read", "write", "create", "delete", "alter", "describe", "clusteraction", "describeconfigs", "alterconfigs", "idempotentwrite"}, cobra.ShellCompDirectiveDefault
 	})
 
-	_ = cmdGetAcls.RegisterFlagCompletionFunc("pattern", func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
+	_ = cmdGetAcls.RegisterFlagCompletionFunc("pattern", func(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective) {
 		return []string{"any", "match", "prefixed", "literal"}, cobra.ShellCompDirectiveDefault
 	})