Add name filtering to ListSecrets API (#4341)

* #4340 add name filter to ListSecrets API

Signed-off-by: Martin Scott <[email protected]>

Author: Martin Scott

api/external/secrets/secrets.pb.go

@@ -138,7 +138,7 @@ service SecretsService {
 	Makes a list of secrets.
 	Supports filtering, pagination, and sorting.
 	Adding a filter narrows the list of secrets to only those that match the filter or filters.
-	Supported filters: type
+	Supported filters: type, name
 	Supported sort types: name, type, last modified
 
 	Example:

api/external/secrets/secrets.proto

@@ -18,8 +18,8 @@ import (
 	"github.com/golang/protobuf/ptypes"
 
 	"github.com/chef/automate/api/external/common/query"
-	"github.com/chef/automate/api/external/secrets"
 	"github.com/chef/automate/api/external/lib/errorutils"
+	"github.com/chef/automate/api/external/secrets"
 	"github.com/chef/automate/lib/stringutils"
 )
 
@@ -333,6 +333,7 @@ func (secretsDb *DB) GetSecrets(sortField string, insortOrder secrets.Query_Orde
 
 var secretsFilterField = map[string]string{
 	"type": "type",
+	"name": "name",
 }
 
 func validateSecretFilters(filters []*query.Filter) error {
@@ -351,7 +352,7 @@ func validateSecretFilters(filters []*query.Filter) error {
 
 func isValidSecretType(secretType string) bool {
 	switch secretType {
-	case "ssh", "winrm", "sudo", "aws", "azure", "service_now":
+	case "ssh", "winrm", "sudo", "aws", "azure", "service_now", "data_feed":
 		return true
 	default:
 		return false

api/external/secrets/secrets.swagger.json

@@ -301,3 +301,142 @@ func TestListSecretPaging(t *testing.T) {
 
 	deleteAllSecrets()
 }
+
+func TestListSecretFilterByName(t *testing.T) {
+	ctx := context.Background()
+
+	testData := struct {
+		order         secrets.Query_OrderType
+		sort          string
+		inputSecrets  []*secrets.Secret
+		outputSecrets []*secrets.Secret
+		message       string
+	}{
+
+		order: secrets.Query_ASC,
+		sort:  "name",
+		inputSecrets: []*secrets.Secret{
+			{
+				Name: "data feed secret",
+				Type: "data_feed",
+				Data: appendKvs(
+					&query.Kv{Key: "username", Value: "username"},
+					&query.Kv{Key: "password", Value: "password"}),
+			},
+			{
+				Name: "service now secret",
+				Type: "service_now",
+				Data: appendKvs(
+					&query.Kv{Key: "username", Value: "username"},
+					&query.Kv{Key: "password", Value: "password"}),
+			},
+		},
+		outputSecrets: []*secrets.Secret{
+			{
+				Name: "data feed secret",
+				Type: "data_feed",
+			},
+		},
+		message: "Order asc",
+	}
+
+	for _, secret := range testData.inputSecrets {
+		id, err := secretsServer.Create(ctx, secret)
+		assert.NoError(t, err)
+		assert.NotNil(t, id)
+	}
+
+	nameFilter := &query.Filter{
+		Key:    "name",
+		Values: []string{"data feed secret"},
+	}
+	req := &secrets.Query{
+		Order:   testData.order,
+		Sort:    testData.sort,
+		Filters: []*query.Filter{nameFilter},
+	}
+
+	responseSecrets, err := secretsServer.List(ctx, req)
+	assert.NoError(t, err, testData.message)
+	assert.NotNil(t, responseSecrets)
+	assert.Equal(t, len(testData.outputSecrets), int(responseSecrets.Total), testData.message)
+
+	for index, actualSecret := range responseSecrets.Secrets {
+		expectedSecret := testData.outputSecrets[index]
+		assert.Equal(t, actualSecret.Name, expectedSecret.Name, testData.message)
+		assert.Equal(t, actualSecret.Type, expectedSecret.Type, testData.message)
+	}
+
+	deleteAllSecrets()
+
+}
+
+
+func TestListSecretFilterByType(t *testing.T) {
+	ctx := context.Background()
+
+	testData := struct {
+		order         secrets.Query_OrderType
+		sort          string
+		inputSecrets  []*secrets.Secret
+		outputSecrets []*secrets.Secret
+		message       string
+	}{
+
+		order: secrets.Query_ASC,
+		sort:  "name",
+		inputSecrets: []*secrets.Secret{
+			{
+				Name: "data feed secret",
+				Type: "data_feed",
+				Data: appendKvs(
+					&query.Kv{Key: "username", Value: "username"},
+					&query.Kv{Key: "password", Value: "password"}),
+			},
+			{
+				Name: "service now secret",
+				Type: "service_now",
+				Data: appendKvs(
+					&query.Kv{Key: "username", Value: "username"},
+					&query.Kv{Key: "password", Value: "password"}),
+			},
+		},
+		outputSecrets: []*secrets.Secret{
+			{
+				Name: "data feed secret",
+				Type: "data_feed",
+			},
+		},
+		message: "Order asc",
+	}
+
+	for _, secret := range testData.inputSecrets {
+		id, err := secretsServer.Create(ctx, secret)
+		assert.NoError(t, err)
+		assert.NotNil(t, id)
+	}
+
+	typeFilter := &query.Filter{
+		Key:    "type",
+		Values: []string{"data_feed"},
+	}
+	req := &secrets.Query{
+		Order:   testData.order,
+		Sort:    testData.sort,
+		Filters: []*query.Filter{typeFilter},
+	}
+
+	responseSecrets, err := secretsServer.List(ctx, req)
+	assert.NoError(t, err, testData.message)
+	assert.NotNil(t, responseSecrets)
+	assert.Equal(t, len(testData.outputSecrets), int(responseSecrets.Total), testData.message)
+
+	for index, actualSecret := range responseSecrets.Secrets {
+		expectedSecret := testData.outputSecrets[index]
+		assert.Equal(t, actualSecret.Name, expectedSecret.Name, testData.message)
+		assert.Equal(t, actualSecret.Type, expectedSecret.Type, testData.message)
+	}
+
+	deleteAllSecrets()
+
+}