CLOUDP-204057: support for vectorSearch (#2442)

Ciprian Tibulca · web-flow · commit 03b30697cb61 · 2023-11-16T19:00:13.000Z
diff --git a/docs/atlascli/command/atlas-clusters-search-indexes-describe.txt b/docs/atlascli/command/atlas-clusters-search-indexes-describe.txt
@@ -93,8 +93,8 @@ If the command succeeds, the CLI returns output similar to the following sample.
 
 .. code-block::
 
-   ID          NAME     DATABASE     COLLECTION
-   <IndexID>   <Name>   <Database>   <CollectionName>
+   ID          NAME     DATABASE     COLLECTION         TYPE
+   <IndexID>   <Name>   <Database>   <CollectionName>   <Type>
    
 
 Examples
diff --git a/docs/atlascli/command/atlas-clusters-search-indexes-list.txt b/docs/atlascli/command/atlas-clusters-search-indexes-list.txt
@@ -78,6 +78,17 @@ Inherited Options
      - false
      - Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.
 
+Output
+------
+
+If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.
+
+.. code-block::
+
+   ID          NAME     DATABASE     COLLECTION         TYPE
+   <IndexID>   <Name>   <Database>   <CollectionName>   <Type>
+   
+
 Examples
 --------
 
diff --git a/docs/atlascli/command/atlas-deployments-list.txt b/docs/atlascli/command/atlas-deployments-list.txt
@@ -67,7 +67,7 @@ If the command succeeds, the CLI returns output similar to the following sample.
 
 .. code-block::
 
-   NAME               TYPE     MDB VER            STATE
-   {{range .><Name>   <Type>   <MongoDBVersion>   <StateName>
+   NAME     TYPE     MDB VER            STATE
+   <Name>   <Type>   <MongoDBVersion>   <StateName>
    
 
diff --git a/docs/atlascli/command/atlas-deployments-search-indexes-describe.txt b/docs/atlascli/command/atlas-deployments-search-indexes-describe.txt
@@ -95,7 +95,7 @@ If the command succeeds, the CLI returns output similar to the following sample.
 
 .. code-block::
 
-   ID          NAME     DATABASE     COLLECTION         STATUS
-   <IndexID>   <Name>   <Database>   <CollectionName>   <Status>
+   ID          NAME     DATABASE     COLLECTION         STATUS     TYPE
+   <IndexID>   <Name>   <Database>   <CollectionName>   <Status>   <Type>
    
 
diff --git a/docs/atlascli/command/atlas-deployments-search-indexes-list.txt b/docs/atlascli/command/atlas-deployments-search-indexes-list.txt
@@ -87,7 +87,7 @@ If the command succeeds, the CLI returns output similar to the following sample.
 
 .. code-block::
 
-   ID          NAME     DATABASE     COLLECTION         STATUS{{range .>
-   <IndexID>   <Name>   <Database>   <CollectionName>   <Status>
+   ID          NAME     DATABASE     COLLECTION         STATUS     TYPE
+   <IndexID>   <Name>   <Database>   <CollectionName>   <Status>   <Type>
    
 
diff --git a/docs/mongocli/command/mongocli-atlas-clusters-search-indexes-describe.txt b/docs/mongocli/command/mongocli-atlas-clusters-search-indexes-describe.txt
@@ -93,8 +93,8 @@ If the command succeeds, the CLI returns output similar to the following sample.
 
 .. code-block::
 
-   ID          NAME     DATABASE     COLLECTION
-   <IndexID>   <Name>   <Database>   <CollectionName>
+   ID          NAME     DATABASE     COLLECTION         TYPE
+   <IndexID>   <Name>   <Database>   <CollectionName>   <Type>
    
 
 Examples
diff --git a/docs/mongocli/command/mongocli-atlas-clusters-search-indexes-list.txt b/docs/mongocli/command/mongocli-atlas-clusters-search-indexes-list.txt
@@ -78,6 +78,17 @@ Inherited Options
      - false
      - Name of the profile to use from your configuration file. To learn about profiles for MongoCLI, see https://dochub.mongodb.org/core/atlas-cli-configuration-file.
 
+Output
+------
+
+If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.
+
+.. code-block::
+
+   ID          NAME     DATABASE     COLLECTION         TYPE
+   <IndexID>   <Name>   <Database>   <CollectionName>   <Type>
+   
+
 Examples
 --------
 
diff --git a/go.mod b/go.mod
@@ -32,7 +32,7 @@ require (
 	github.com/klauspost/compress v1.17.2
 	github.com/mattn/go-isatty v0.0.20
 	github.com/mongodb-forks/digest v1.0.5
-	github.com/mongodb-labs/cobra2snooty v0.16.0
+	github.com/mongodb-labs/cobra2snooty v0.17.0
 	github.com/mongodb/mongodb-atlas-kubernetes v1.9.0
 	github.com/pelletier/go-toml v1.9.5
 	github.com/pkg/browser v0.0.0-20210911075715-681adbf594b8
diff --git a/go.sum b/go.sum
@@ -420,8 +420,8 @@ github.com/modern-go/reflect2 v1.0.2 h1:xBagoLtFs94CBntxluKeaWgTMpvLxC4ur3nMaC9G
 github.com/modern-go/reflect2 v1.0.2/go.mod h1:yWuevngMOJpCy52FWWMvUC8ws7m/LJsjYzDa0/r8luk=
 github.com/mongodb-forks/digest v1.0.5 h1:EJu3wtLZcA0HCvsZpX5yuD193/sW9tHiNvrEM5apXMk=
 github.com/mongodb-forks/digest v1.0.5/go.mod h1:rb+EX8zotClD5Dj4NdgxnJXG9nwrlx3NWKJ8xttz1Dg=
-github.com/mongodb-labs/cobra2snooty v0.16.0 h1:+q89WQ6KCBWKaxKoXnVmgpPk7DsIJv2LTcvMqCSgOD4=
-github.com/mongodb-labs/cobra2snooty v0.16.0/go.mod h1:eZYlGRCR9pVAqS6Wwz2eVQ9i3Dy4EtcG8jVkcfFWS7Y=
+github.com/mongodb-labs/cobra2snooty v0.17.0 h1:Os4RpsIHViw2fT6Wk5d5cG/rItRS0c8Za8sKKhw3oc8=
+github.com/mongodb-labs/cobra2snooty v0.17.0/go.mod h1:TgFBJczSy1fdW6HY5ZGQfC9EOlhrD1ZJ9hWRldG5gTI=
 github.com/mongodb/mongodb-atlas-kubernetes v1.9.0 h1:G0W00WwOMf00slHjQG5I6JhQPzN2zAjee1rQJxA9t+w=
 github.com/mongodb/mongodb-atlas-kubernetes v1.9.0/go.mod h1:S7JpgyRq6Asp/PBNFWppwUTwao7EIFgFau3ltpt3rpA=
 github.com/montanaflynn/stats v0.0.0-20171201202039-1bf9dbcd8cbe/go.mod h1:wL8QJuTMNUDYhXwkmfOly8iTdp5TEcJFWZD2D7SIkUc=
diff --git a/internal/cli/atlas/deployments/search/indexes/create_test.go b/internal/cli/atlas/deployments/search/indexes/create_test.go
@@ -30,6 +30,7 @@ import (
 	"github.com/mongodb/mongodb-atlas-cli/internal/flag"
 	"github.com/mongodb/mongodb-atlas-cli/internal/mocks"
 	"github.com/mongodb/mongodb-atlas-cli/internal/mongodbclient"
+	"github.com/mongodb/mongodb-atlas-cli/internal/pointer"
 	"github.com/mongodb/mongodb-atlas-cli/internal/test"
 	"github.com/stretchr/testify/assert"
 	atlasv2 "go.mongodb.org/atlas-sdk/v20231115002/admin"
@@ -126,6 +127,7 @@ func TestCreate_RunLocal(t *testing.T) {
 		},
 		Name:           opts.Name,
 		SearchAnalyzer: &opts.SearchAnalyzer,
+		Type:           pointer.Get(search.DefaultType),
 	}
 
 	indexWithID := &atlasv2.ClusterSearchIndex{
@@ -139,6 +141,7 @@ func TestCreate_RunLocal(t *testing.T) {
 		Name:           opts.Name,
 		SearchAnalyzer: &opts.SearchAnalyzer,
 		IndexID:        &indexID,
+		Type:           pointer.Get(search.DefaultType),
 	}
 
 	mockDB.
@@ -308,6 +311,7 @@ func TestCreate_RunAtlas(t *testing.T) {
 		},
 		Name:           opts.Name,
 		SearchAnalyzer: &opts.SearchAnalyzer,
+		Type:           pointer.Get(search.DefaultType),
 	}
 
 	indexWithID := &atlasv2.ClusterSearchIndex{
diff --git a/internal/cli/atlas/deployments/search/indexes/describe.go b/internal/cli/atlas/deployments/search/indexes/describe.go
@@ -19,6 +19,7 @@ import (
 
 	"github.com/mongodb/mongodb-atlas-cli/internal/cli"
 	"github.com/mongodb/mongodb-atlas-cli/internal/cli/atlas/deployments/options"
+	"github.com/mongodb/mongodb-atlas-cli/internal/cli/atlas/search"
 	"github.com/mongodb/mongodb-atlas-cli/internal/cli/require"
 	"github.com/mongodb/mongodb-atlas-cli/internal/config"
 	"github.com/mongodb/mongodb-atlas-cli/internal/flag"
@@ -28,8 +29,8 @@ import (
 	"github.com/spf13/cobra"
 )
 
-var describeTemplate = `ID	NAME	DATABASE	COLLECTION	STATUS
-{{.IndexID}}	{{.Name}}	{{.Database}}	{{.CollectionName}}	{{.Status}}
+var describeTemplate = `ID	NAME	DATABASE	COLLECTION	STATUS	TYPE
+{{.IndexID}}	{{.Name}}	{{.Database}}	{{.CollectionName}}	{{.Status}}	{{if .Type}}{{.Type}}{{else}}` + search.DefaultType + `{{end}}
 `
 
 type DescribeOpts struct {
diff --git a/internal/cli/atlas/deployments/search/indexes/describe_test.go b/internal/cli/atlas/deployments/search/indexes/describe_test.go
@@ -46,6 +46,7 @@ func TestDescribe_RunLocal(t *testing.T) {
 		expectedDB              = "db1"
 		expectedCollection      = "col1"
 		expectedStatus          = "STEADY"
+		expectedType            = "search"
 	)
 
 	deploymentTest := fixture.NewMockLocalDeploymentOpts(ctrl, expectedLocalDeployment)
@@ -111,6 +112,7 @@ func TestDescribe_RunLocal(t *testing.T) {
 		CollectionName: "coll",
 		Database:       "db",
 		Status:         pointer.GetStringPointerIfNotEmpty(expectedStatus),
+		Type:           pointer.GetStringPointerIfNotEmpty(expectedType),
 	}
 
 	mockMongodbClient.
@@ -123,8 +125,8 @@ func TestDescribe_RunLocal(t *testing.T) {
 		t.Fatalf("Run() unexpected error: %v", err)
 	}
 
-	assert.Equal(t, `ID     NAME   DATABASE   COLLECTION   STATUS
-test   name   db         coll         STEADY
+	assert.Equal(t, `ID     NAME   DATABASE   COLLECTION   STATUS   TYPE
+test   name   db         coll         STEADY   search
 `, buf.String())
 	t.Log(buf.String())
 }
diff --git a/internal/cli/atlas/deployments/search/indexes/list.go b/internal/cli/atlas/deployments/search/indexes/list.go
@@ -29,8 +29,8 @@ import (
 	"github.com/spf13/cobra"
 )
 
-var listTemplate = `ID	NAME	DATABASE	COLLECTION	STATUS{{range .}}
-{{.IndexID}}	{{.Name}}	{{.Database}}	{{.CollectionName}}	{{.Status}}{{end}}
+var listTemplate = `ID	NAME	DATABASE	COLLECTION	STATUS	TYPE{{range .}}
+{{.IndexID}}	{{.Name}}	{{.Database}}	{{.CollectionName}}	{{.Status}}	{{if .Type}}{{.Type}}{{else}}` + search.DefaultType + `{{end}}{{end}}
 `
 
 type ListOpts struct {
diff --git a/internal/cli/atlas/deployments/search/indexes/list_test.go b/internal/cli/atlas/deployments/search/indexes/list_test.go
@@ -49,6 +49,7 @@ func TestList_RunLocal(t *testing.T) {
 		expectedName            = "test"
 		expectedID              = "1"
 		expectedStatus          = "STEADY"
+		expectedType            = "search"
 	)
 
 	buf := new(bytes.Buffer)
@@ -123,6 +124,7 @@ func TestList_RunLocal(t *testing.T) {
 			CollectionName: expectedCollection,
 			Database:       expectedDB,
 			Status:         pointer.GetStringPointerIfNotEmpty(expectedStatus),
+			Type:           pointer.GetStringPointerIfNotEmpty(expectedType),
 		},
 	}
 
@@ -136,9 +138,9 @@ func TestList_RunLocal(t *testing.T) {
 		t.Fatalf("Run() unexpected error: %v", err)
 	}
 
-	assert.Equal(t, fmt.Sprintf(`ID    NAME   DATABASE   COLLECTION   STATUS
-%s     %s   %s        %s         %s
-`, expectedID, expectedName, expectedDB, expectedCollection, expectedStatus), buf.String())
+	assert.Equal(t, fmt.Sprintf(`ID    NAME   DATABASE   COLLECTION   STATUS   TYPE
+%s     %s   %s        %s         %s   %s
+`, expectedID, expectedName, expectedDB, expectedCollection, expectedStatus, expectedType), buf.String())
 	t.Log(buf.String())
 }
 
diff --git a/internal/cli/atlas/search/describe.go b/internal/cli/atlas/search/describe.go
@@ -44,8 +44,8 @@ func (opts *DescribeOpts) initStore(ctx context.Context) func() error {
 	}
 }
 
-var describeTemplate = `ID	NAME	DATABASE	COLLECTION
-{{.IndexID}}	{{.Name}}	{{.Database}}	{{.CollectionName}}
+var describeTemplate = `ID	NAME	DATABASE	COLLECTION	TYPE
+{{.IndexID}}	{{.Name}}	{{.Database}}	{{.CollectionName}}	{{if .Type }}{{.Type}}{{else}}` + DefaultType + `{{end}}
 `
 
 func (opts *DescribeOpts) Run() error {
diff --git a/internal/cli/atlas/search/index_opts.go b/internal/cli/atlas/search/index_opts.go
@@ -20,13 +20,17 @@ import (
 	"strings"
 
 	"github.com/mongodb/mongodb-atlas-cli/internal/file"
+	"github.com/mongodb/mongodb-atlas-cli/internal/pointer"
 	"github.com/spf13/afero"
 	atlasv2 "go.mongodb.org/atlas-sdk/v20231115002/admin"
 )
 
 const DefaultAnalyzer = "lucene.standard"
 const deprecatedFlagMessage = "please use --file instead"
 const failedToLoadIndexMessage = "failed to parse JSON file due to %s"
+const SearchIndexType = "search"
+const VectorSearchIndexType = "vectorSearch"
+const DefaultType = SearchIndexType
 
 type IndexOpts struct {
 	Name           string
@@ -80,6 +84,11 @@ func (opts *IndexOpts) NewSearchIndex() (*atlasv2.ClusterSearchIndex, error) {
 		if err := file.Load(opts.Fs, opts.Filename, index); err != nil {
 			return nil, fmt.Errorf(failedToLoadIndexMessage, err.Error())
 		}
+
+		if index.Type == nil {
+			index.Type = pointer.Get(DefaultType)
+		}
+
 		return index, nil
 	}
 
@@ -102,6 +111,8 @@ func (opts *IndexOpts) NewSearchIndex() (*atlasv2.ClusterSearchIndex, error) {
 		},
 		Name:           opts.Name,
 		SearchAnalyzer: &opts.SearchAnalyzer,
+		// only search indexes can be created using flags
+		Type: pointer.Get(SearchIndexType),
 	}
 	return i, nil
 }
diff --git a/internal/cli/atlas/search/list.go b/internal/cli/atlas/search/list.go
@@ -45,8 +45,8 @@ func (opts *ListOpts) initStore(ctx context.Context) func() error {
 	}
 }
 
-var listTemplate = `ID	NAME	DATABASE	COLLECTION{{range .}}
-{{.IndexID}}	{{.Name}}	{{.Database}}	{{.CollectionName}}{{end}}
+var listTemplate = `ID	NAME	DATABASE	COLLECTION	TYPE{{range .}}
+{{.IndexID}}	{{.Name}}	{{.Database}}	{{.CollectionName}}	{{if .Type }}{{.Type}}{{else}}` + DefaultType + `{{end}}{{end}}
 `
 
 func (opts *ListOpts) Run() error {
@@ -62,9 +62,12 @@ func (opts *ListOpts) Run() error {
 func ListBuilder() *cobra.Command {
 	opts := &ListOpts{}
 	cmd := &cobra.Command{
-		Use:     "list",
-		Short:   "List all Atlas Search indexes for a cluster.",
-		Long:    fmt.Sprintf(usage.RequiredRole, "Project Data Access Read/Write"),
+		Use:   "list",
+		Short: "List all Atlas Search indexes for a cluster.",
+		Long:  fmt.Sprintf(usage.RequiredRole, "Project Data Access Read/Write"),
+		Annotations: map[string]string{
+			"output": listTemplate,
+		},
 		Aliases: []string{"ls"},
 		Args:    require.NoArgs,
 		Example: fmt.Sprintf(`  # Return the JSON-formatted list of Atlas search indexes on the sample_mflix.movies database in the cluster named myCluster:
diff --git a/internal/mongodbclient/search_index.go b/internal/mongodbclient/search_index.go
@@ -70,7 +70,7 @@ func (o *database) CreateSearchIndex(ctx context.Context, collection string, idx
 	}
 
 	// Empty these fields so that they are not included into the index definition for the MongoDB command
-	index = removeFields(index, "id", "collectionName", "database")
+	index = removeFields(index, "id", "collectionName", "database", "type")
 
 	indexCommand := bson.D{
 		{
