Add include defaults when describing topics

cmd/describe/describe-topic.go

@@ -28,6 +28,7 @@ func newDescribeTopicCmd() *cobra.Command {
 	cmdDescribeTopic.Flags().StringVarP(&flags.OutputFormat, "output", "o", flags.OutputFormat, "output format. One of: json|yaml|wide")
 	cmdDescribeTopic.Flags().BoolVarP(&flags.PrintConfigs, "print-configs", "c", true, "print configs")
 	cmdDescribeTopic.Flags().BoolVarP(&flags.SkipEmptyPartitions, "skip-empty", "s", false, "show only partitions that have a messages")
+	cmdDescribeTopic.Flags().BoolVarP(&flags.IncludeDefaults, "include-defaults", "i", false, "include default configs")
 
 	return cmdDescribeTopic
 }

internal/broker/broker-operation.go

@@ -77,7 +77,7 @@ func (operation *Operation) GetBrokers(flags GetBrokersFlags) error {
 			Name: fmt.Sprint(broker.ID()),
 		}
 
-		if configs, err = internal.ListConfigs(&admin, brokerConfig); err != nil {
+		if configs, err = internal.ListConfigs(&admin, brokerConfig, false); err != nil {
 			return err
 		}
 
@@ -153,7 +153,7 @@ func (operation *Operation) DescribeBroker(id int32, flags DescribeBrokerFlags)
 		Name: fmt.Sprint(broker.ID()),
 	}
 
-	if configs, err = internal.ListConfigs(&admin, brokerConfig); err != nil {
+	if configs, err = internal.ListConfigs(&admin, brokerConfig, false); err != nil {
 		return err
 	}
 

internal/common-operation.go

@@ -309,10 +309,9 @@ func TopicExists(client *sarama.Client, name string) (bool, error) {
 	return false, nil
 }
 
-func ListConfigs(admin *sarama.ClusterAdmin, resource sarama.ConfigResource) ([]Config, error) {
+func ListConfigs(admin *sarama.ClusterAdmin, resource sarama.ConfigResource, includeDefaults bool) ([]Config, error) {
 
 	var (
-		configs       = make([]Config, 0)
 		configEntries []sarama.ConfigEntry
 		err           error
 	)
@@ -321,15 +320,21 @@ func ListConfigs(admin *sarama.ClusterAdmin, resource sarama.ConfigResource) ([]
 		return nil, errors.Wrap(err, fmt.Sprintf("failed to describe %v config", getResourceTypeName(resource.Type)))
 	}
 
+	return listConfigsFromEntries(configEntries, includeDefaults), nil
+}
+
+func listConfigsFromEntries(configEntries []sarama.ConfigEntry, includeDefaults bool) []Config {
+	var configs = make([]Config, 0)
+
 	for _, configEntry := range configEntries {
 
-		if !configEntry.Default && configEntry.Source != sarama.SourceDefault {
+		if includeDefaults || (!configEntry.Default && configEntry.Source != sarama.SourceDefault) {
 			entry := Config{Name: configEntry.Name, Value: configEntry.Value}
 			configs = append(configs, entry)
 		}
 	}
 
-	return configs, nil
+	return configs
 }
 
 func getResourceTypeName(resourceType sarama.ConfigResourceType) string {

internal/common-operation_test.go

@@ -0,0 +1,83 @@
+package internal
+
+import (
+	"reflect"
+	"testing"
+
+	"github.com/IBM/sarama"
+)
+
+func TestListConfigsFromEntries(t *testing.T) {
+	testCases := []struct {
+		name            string
+		entries         []sarama.ConfigEntry
+		includeDefaults bool
+		configs         []Config
+	}{
+		{
+			name:    "not include defaults, empty entries",
+			entries: []sarama.ConfigEntry{},
+			configs: []Config{},
+		},
+		{
+			name: "not include defaults",
+			entries: []sarama.ConfigEntry{
+				{
+					Name:    "non_default",
+					Value:   "ND",
+					Default: false,
+					Source:  sarama.SourceUnknown,
+				},
+				{
+					Name:    "default",
+					Value:   "D",
+					Default: true,
+					Source:  sarama.SourceDefault,
+				},
+			},
+			configs: []Config{
+				{Name: "non_default", Value: "ND"},
+			},
+		},
+		{
+			name:            "include defaults, empty entries",
+			entries:         []sarama.ConfigEntry{},
+			configs:         []Config{},
+			includeDefaults: true,
+		},
+		{
+			name: "include defaults",
+			entries: []sarama.ConfigEntry{
+				{
+					Name:    "non_default",
+					Value:   "ND",
+					Default: false,
+					Source:  sarama.SourceUnknown,
+				},
+				{
+					Name:    "default",
+					Value:   "D",
+					Default: true,
+					Source:  sarama.SourceDefault,
+				},
+			},
+			configs: []Config{
+				{Name: "non_default", Value: "ND"},
+				{Name: "default", Value: "D"},
+			},
+			includeDefaults: true,
+		},
+	}
+
+	for _, tc := range testCases {
+		t.Run(tc.name, func(t *testing.T) {
+			configs := listConfigsFromEntries(tc.entries, tc.includeDefaults)
+
+			if len(configs) > 0 &&
+				len(tc.configs) > 0 &&
+				!reflect.DeepEqual(configs, tc.configs) {
+				t.Fatalf("expect: %v, got %v", tc.configs, configs)
+			}
+		})
+	}
+}

internal/topic/topic-operation.go

@@ -32,12 +32,13 @@ type Partition struct {
 }
 
 type requestedTopicFields struct {
-	partitionID       bool
-	partitionOffset   bool
-	partitionLeader   bool
-	partitionReplicas bool
-	partitionISRs     bool
-	config            bool
+	partitionID           bool
+	partitionOffset       bool
+	partitionLeader       bool
+	partitionReplicas     bool
+	partitionISRs         bool
+	config                bool
+	configIncludeDefaults bool
 }
 
 var allFields = requestedTopicFields{partitionID: true, partitionOffset: true, partitionLeader: true, partitionReplicas: true, partitionISRs: true, config: true}
@@ -64,6 +65,7 @@ type DescribeTopicFlags struct {
 	PrintConfigs        bool
 	SkipEmptyPartitions bool
 	OutputFormat        string
+	IncludeDefaults     bool
 }
 
 type Operation struct {
@@ -161,7 +163,10 @@ func (operation *Operation) DescribeTopic(topic string, flags DescribeTopicFlags
 		return errors.Wrap(err, "failed to create cluster admin")
 	}
 
-	if t, err = readTopic(&client, &admin, topic, allFields); err != nil {
+	fields := allFields
+	fields.configIncludeDefaults = flags.IncludeDefaults
+
+	if t, err = readTopic(&client, &admin, topic, fields); err != nil {
 		return errors.Wrap(err, "failed to read topic")
 	}
 
@@ -732,7 +737,7 @@ func readTopic(client *sarama.Client, admin *sarama.ClusterAdmin, name string, r
 			Name: name,
 		}
 
-		if top.Configs, err = internal.ListConfigs(admin, topicConfig); err != nil {
+		if top.Configs, err = internal.ListConfigs(admin, topicConfig, requestedFields.configIncludeDefaults); err != nil {
 			return top, err
 		}
 	}