Added --vector-optimized and --graph-analytics-plugin flags (#114)

* Added `--vector-optimized` and `--graph-analytics-plugin` flags

* Add validation for type and graph analytics plugin

Author: darrellwarde

.changes/unreleased/Added-20250227-161757.yaml

@@ -0,0 +1,3 @@
+kind: Added
+body: Added boolean `--vector-optimized` and `--graph-analytics-plugin` flags for instance creation
+time: 2025-02-27T16:17:57.308325Z

neo4j-cli/aura/internal/subcommands/instance/create.go

@@ -2,6 +2,7 @@ package instance
 
 import (
 	"encoding/json"
+	"errors"
 	"fmt"
 	"net/http"
 
@@ -22,6 +23,8 @@ func NewCreateCmd(cfg *clicfg.Config) *cobra.Command {
 		tenantId             string
 		cloudProvider        flags.CloudProvider
 		customerManagedKeyId string
+		vectorOptimized      bool
+		graphAnalyticsPlugin bool
 		await                bool
 	)
 
@@ -34,6 +37,8 @@ func NewCreateCmd(cfg *clicfg.Config) *cobra.Command {
 		tenantIdFlag             = "tenant-id"
 		cloudProviderFlag        = "cloud-provider"
 		customerManagedKeyIdFlag = "customer-managed-key-id"
+		vectorOptimizedFlag      = "vector-optimized"
+		graphAnalyticsPluginFlag = "graph-analytics-plugin"
 		awaitFlag                = "await"
 	)
 
@@ -72,6 +77,10 @@ For Enterprise instances you can specify a --customer-managed-key-id flag to use
 				return fmt.Errorf(`invalid argument "%s" for "--version" flag: must be one of "4" or "5"`, version)
 			}
 
+			if graphAnalyticsPlugin && _type != "professional-db" {
+				return errors.New(`"--graph-analytics-plugin" flag can only be set when "--type" flag is set to "professional-db"`)
+			}
+
 			if cfg.Aura.DefaultTenant() == "" {
 				cmd.MarkFlagRequired(tenantIdFlag)
 			}
@@ -101,6 +110,11 @@ For Enterprise instances you can specify a --customer-managed-key-id flag to use
 			} else {
 				body["memory"] = memory
 				body["region"] = region
+				body["vector_optimized"] = vectorOptimized
+			}
+
+			if _type == "professional-db" {
+				body["graph_analytics_plugin"] = graphAnalyticsPlugin
 			}
 
 			if customerManagedKeyId != "" {
@@ -157,6 +171,11 @@ For Enterprise instances you can specify a --customer-managed-key-id flag to use
 	cmd.Flags().Var(&cloudProvider, cloudProviderFlag, "The cloud provider hosting the instance.")
 
 	cmd.Flags().StringVar(&customerManagedKeyId, customerManagedKeyIdFlag, "", "An optional customer managed key to be used for instance creation.")
+
+	cmd.Flags().BoolVar(&vectorOptimized, vectorOptimizedFlag, false, "An optional vector optimization configuration to be set during instance creation")
+
+	cmd.Flags().BoolVar(&graphAnalyticsPlugin, graphAnalyticsPluginFlag, false, "An optional graph analytics plugin configuration to be set during instance creation")
+
 	cmd.Flags().BoolVar(&await, awaitFlag, false, "Waits until created instance is ready.")
 
 	return cmd

neo4j-cli/aura/internal/subcommands/instance/create_test.go

@@ -62,15 +62,16 @@ func TestCreateProfessionalInstance(t *testing.T) {
 				"cloud_provider": "gcp",
 				"region": "europe-west1",
 				"type": "professional-db",
-				"name": "Instance01"
+				"name": "Instance01",
+    			"vector_optimized": false
 			}
 		}`)
 
 	helper.ExecuteCommand("instance create --region europe-west1 --name Instance01 --type professional-db --tenant-id YOUR_TENANT_ID --cloud-provider gcp --memory 4GB")
 
 	mockHandler.AssertCalledTimes(1)
 	mockHandler.AssertCalledWithMethod(http.MethodPost)
-	mockHandler.AssertCalledWithBody(`{"cloud_provider":"gcp","memory":"4GB","name":"Instance01","region":"europe-west1","tenant_id":"YOUR_TENANT_ID","type":"professional-db","version":"5"}`)
+	mockHandler.AssertCalledWithBody(`{"cloud_provider":"gcp","memory":"4GB","name":"Instance01","region":"europe-west1","tenant_id":"YOUR_TENANT_ID","type":"professional-db","version":"5","vector_optimized":false,"graph_analytics_plugin":false}`)
 
 	helper.AssertOutJson(`{
 	  "data": {
@@ -82,7 +83,49 @@ func TestCreateProfessionalInstance(t *testing.T) {
 		"region": "europe-west1",
 		"tenant_id": "YOUR_TENANT_ID",
 		"type": "professional-db",
-		"username": "neo4j"
+		"username": "neo4j",
+    	"vector_optimized": false
+	  }
+	}`)
+}
+
+func TestCreateProfessionalInstanceVectorOptimizedGraphAnalyticsPlugin(t *testing.T) {
+	helper := testutils.NewAuraTestHelper(t)
+	defer helper.Close()
+
+	mockHandler := helper.NewRequestHandlerMock("/v1/instances", http.StatusAccepted, `{
+			"data": {
+				"id": "db1d1234",
+				"connection_url": "YOUR_CONNECTION_URL",
+				"username": "neo4j",
+				"password": "letMeIn123!",
+				"tenant_id": "YOUR_TENANT_ID",
+				"cloud_provider": "gcp",
+				"region": "europe-west1",
+				"type": "professional-db",
+				"name": "Instance01",
+    			"vector_optimized": true
+			}
+		}`)
+
+	helper.ExecuteCommand("instance create --region europe-west1 --name Instance01 --type professional-db --tenant-id YOUR_TENANT_ID --cloud-provider gcp --memory 4GB --vector-optimized --graph-analytics-plugin")
+
+	mockHandler.AssertCalledTimes(1)
+	mockHandler.AssertCalledWithMethod(http.MethodPost)
+	mockHandler.AssertCalledWithBody(`{"cloud_provider":"gcp","memory":"4GB","name":"Instance01","region":"europe-west1","tenant_id":"YOUR_TENANT_ID","type":"professional-db","version":"5","vector_optimized":true,"graph_analytics_plugin":true}`)
+
+	helper.AssertOutJson(`{
+	  "data": {
+		"cloud_provider": "gcp",
+		"connection_url": "YOUR_CONNECTION_URL",
+		"id": "db1d1234",
+		"name": "Instance01",
+		"password": "letMeIn123!",
+		"region": "europe-west1",
+		"tenant_id": "YOUR_TENANT_ID",
+		"type": "professional-db",
+		"username": "neo4j",
+		"vector_optimized": true
 	  }
 	}`)
 }
@@ -157,6 +200,20 @@ func TestCreateProfessionalInstanceInvalidInstanceType(t *testing.T) {
 `)
 }
 
+func TestCreateProfessionalInstanceInvalidVersion(t *testing.T) {
+	helper := testutils.NewAuraTestHelper(t)
+	defer helper.Close()
+
+	mockHandler := helper.NewRequestHandlerMock("/v1/instances", http.StatusOK, "")
+
+	helper.ExecuteCommand("instance create --region europe-west1 --name Instance01 --type professional-db --memory 1GB --cloud-provider gcp --tenant-id YOUR_TENANT_ID --version 6")
+
+	mockHandler.AssertCalledTimes(0)
+
+	helper.AssertErr(`Error: invalid argument "6" for "--version" flag: must be one of "4" or "5"
+`)
+}
+
 func TestCreateFreeInstanceWithMemory(t *testing.T) {
 	helper := testutils.NewAuraTestHelper(t)
 	defer helper.Close()
@@ -199,6 +256,20 @@ func TestCreateFreeInstanceWithCloudProvider(t *testing.T) {
 `)
 }
 
+func TestCreateFreeInstanceWithGraphAnalyticsPlugin(t *testing.T) {
+	helper := testutils.NewAuraTestHelper(t)
+	defer helper.Close()
+
+	mockHandler := helper.NewRequestHandlerMock("/v1/instances", http.StatusOK, "")
+
+	helper.ExecuteCommand("instance create --name Instance01 --type free-db --graph-analytics-plugin --tenant-id YOUR_TENANT_ID")
+
+	mockHandler.AssertCalledTimes(0)
+
+	helper.AssertErr(`Error: "--graph-analytics-plugin" flag can only be set when "--type" flag is set to "professional-db"
+`)
+}
+
 func TestCreateInstanceError(t *testing.T) {
 	testCases := []struct {
 		statusCode    int
@@ -272,7 +343,7 @@ func TestInstanceWithCmkId(t *testing.T) {
 
 	mockHandler.AssertCalledTimes(1)
 	mockHandler.AssertCalledWithMethod(http.MethodPost)
-	mockHandler.AssertCalledWithBody(`{"cloud_provider":"gcp","memory":"16GB","name":"Instance01","region":"europe-west1","tenant_id":"YOUR_TENANT_ID","type":"enterprise-db","version":"5","customer_managed_key_id":"UUID_OF_YOUR_KEY"}`)
+	mockHandler.AssertCalledWithBody(`{"cloud_provider":"gcp","memory":"16GB","name":"Instance01","region":"europe-west1","tenant_id":"YOUR_TENANT_ID","type":"enterprise-db","version":"5","customer_managed_key_id":"UUID_OF_YOUR_KEY","vector_optimized":false}`)
 
 	helper.AssertOutJson(`{
 	  "data": {