Updated the Cosmosdb module (#404)

* Add ADF module

* added the test harness for cosmosdb and resolved merge issued

* updated the Cosmosdb module

* deleted data factory

* removed the adf file from test harness from another PR and updated the httpGet in test to get nil in addition

* added default value for vnet_subnet_id

Co-authored-by: helayoty <[email protected]>
Co-authored-by: Mahsa Hanifi <[email protected]>

Author: 3 people

infra/modules/providers/azure/cosmosdb/.env.testing.template

@@ -1,3 +1,4 @@
-COSMOSDB_ACCOUNT_NAME="..."
-RESOURCE_GROUP_NAME="..."
-PRIMARY_REPLICA_LOCATION="..."
+COSMOSDB_ACCOUNT_NAME=""
+RESOURCE_GROUP_NAME=""
+PRIMARY_REPLICA_LOCATION=""
+ARM_SUBSCRIPTION_ID=""

infra/modules/providers/azure/cosmosdb/README.md

@@ -43,29 +43,4 @@ Supported arguments for this module are available in [variables.tf](./variables.
 
 ## Outputs
 
-Once the deployments are completed successfully, the output for the current module will be in the format mentioned below:
-
-``` json
-output "properties" {
-  description = "Properties of the deployed CosmosDB account."
-  type        = object({
-    cosmosdb = object({
-      id                     = string
-      endpoint               = string
-      primary_master_key     = string
-      connection_strings     = string
-    })
-  })
-}
-
-output "resource_group_name" {
-  description = "The name of the CosmosDB account."
-  type        = string
-}
-
-output "account_name" {
-  description = "Properties of the deployed cluster"
-  type        = string
-}
-```
-
+The output values for this module are available in [output.tf](output.tf)

infra/modules/providers/azure/cosmosdb/main.tf

@@ -1,15 +1,30 @@
+module "azure-provider" {
+  source = "../provider"
+}
+
 data "azurerm_resource_group" "cosmosdb" {
   name = var.resource_group_name
 }
 
+locals {
+  offer_type                         = "Standard"
+  ip_range_filter_Allow_Azure_Portal = "0.0.0.0"
+}
+
 resource "azurerm_cosmosdb_account" "cosmosdb" {
-  name                = var.name
+  name                = var.account_name
   location            = data.azurerm_resource_group.cosmosdb.location
   resource_group_name = data.azurerm_resource_group.cosmosdb.name
-  offer_type          = "Standard"
+  offer_type          = local.offer_type
   kind                = var.kind
 
-  enable_automatic_failover = var.automatic_failover
+  enable_automatic_failover         = var.automatic_failover
+  is_virtual_network_filter_enabled = true
+  ip_range_filter                   = local.ip_range_filter_Allow_Azure_Portal
+
+  virtual_network_rule {
+    id = var.vnet_subnet_id
+  }
 
   consistency_policy {
     consistency_level = var.consistency_level
@@ -25,7 +40,7 @@ resource "azurerm_cosmosdb_sql_database" "cosmos_dbs" {
   depends_on          = [azurerm_cosmosdb_account.cosmosdb]
   count               = length(var.databases)
   name                = var.databases[count.index].name
-  account_name        = var.name
+  account_name        = var.account_name
   resource_group_name = data.azurerm_resource_group.cosmosdb.name
   throughput          = var.databases[count.index].throughput
 }
@@ -34,7 +49,7 @@ resource "azurerm_cosmosdb_sql_container" "cosmos_collections" {
   depends_on          = [azurerm_cosmosdb_sql_database.cosmos_dbs]
   count               = length(var.sql_collections)
   name                = var.sql_collections[count.index].name
-  account_name        = var.name
+  account_name        = var.account_name
   database_name       = var.sql_collections[count.index].database_name
   resource_group_name = data.azurerm_resource_group.cosmosdb.name
   partition_key_path  = var.sql_collections[count.index].partition_key_path

infra/modules/providers/azure/cosmosdb/terraform.tfvars.template

@@ -0,0 +1,14 @@
+resource_group_name      = ""
+name                     = ""
+primary_replica_location = ""
+databases = [{
+  name       = ""
+  throughput = [400]
+}]
+sql_collections = [{
+  name               = ""
+  database_name      = ""
+  partition_key_path = ""
+  throughput         = [400]
+}]
+vnet_subnet_id = ""

infra/modules/providers/azure/cosmosdb/tests/integration/cosmos.go

@@ -1,18 +1,15 @@
 package integration
 
 import (
-	"os"
 	"testing"
 
 	"github.com/Azure/azure-sdk-for-go/services/cosmos-db/mgmt/2015-04-08/documentdb"
 	httpClient "github.com/gruntwork-io/terratest/modules/http-helper"
-	"github.com/microsoft/cobalt/test-harness/infratests"
 	"github.com/microsoft/cobalt/test-harness/terratest-extensions/modules/azure"
+	"github.com/microsoft/terratest-abstraction/integration"
 	"github.com/stretchr/testify/require"
 )
 
-var subscription = os.Getenv("ARM_SUBSCRIPTION_ID")
-
 // validateOutputs - Asserts that expected output values are present.
 func validateOutputs(t *testing.T, id string, endpoint string, primaryMasterKey string, connectionStrings []interface{}) {
 	require.NotEqual(t, "", id, "ID not returned.")
@@ -37,7 +34,7 @@ func validateFailOverPriority(t *testing.T, failOverPolicy documentdb.FailoverPo
 }
 
 // getModuleOutputs - Extracts the output variables from property map.
-func getModuleOutputs(output infratests.TerraformOutput, outputName string) (id string, endpoint string, primaryMasterKey string, connectionStrings []interface{}) {
+func getModuleOutputs(output integration.TerraformOutput, outputName string) (id string, endpoint string, primaryMasterKey string, connectionStrings []interface{}) {
 	properties := output[outputName].(map[string]interface{})
 	cosmosDBProperties := properties["cosmosdb"].(map[string]interface{})
 
@@ -50,20 +47,20 @@ func getModuleOutputs(output infratests.TerraformOutput, outputName string) (id
 }
 
 // validateServiceResponse - Attempt to perform a HTTP request to the live endpoint.
-func validateServiceResponse(t *testing.T, output infratests.TerraformOutput, outputName string) {
+func validateServiceResponse(t *testing.T, output integration.TerraformOutput, outputName string) {
 	_, endpoint, _, _ := getModuleOutputs(output, outputName)
-	statusCode, _ := httpClient.HttpGet(t, endpoint)
+	statusCode, _ := httpClient.HttpGet(t, endpoint, nil)
 
 	require.Equal(t, 401, statusCode, "Service did not respond with the expected Unauthorized status code.")
 }
 
 // InspectProvisionedCosmosDBAccount - Runs test assertions to validate that a provisioned CosmosDB Account
 // is operational.
-func InspectProvisionedCosmosDBAccount(resourceGroupOutputName, accountName, outputName string) func(t *testing.T, output infratests.TerraformOutput) {
-	return func(t *testing.T, output infratests.TerraformOutput) {
+func InspectProvisionedCosmosDBAccount(subscriptionID, resourceGroupOutputName, accountName, outputName string) func(t *testing.T, output integration.TerraformOutput) {
+	return func(t *testing.T, output integration.TerraformOutput) {
 		resourceGroupName := output[resourceGroupOutputName].(string)
 		accountName := output[accountName].(string)
-		result := azure.GetCosmosDBAccount(t, subscription, resourceGroupName, accountName)
+		result := azure.GetCosmosDBAccount(t, subscriptionID, resourceGroupName, accountName)
 
 		healthCheck(t, result.ProvisioningState)
 
@@ -78,8 +75,8 @@ func InspectProvisionedCosmosDBAccount(resourceGroupOutputName, accountName, out
 }
 
 // InspectCosmosDBModuleOutputs - Runs test assertions to validate that the module outputs are valid.
-func InspectCosmosDBModuleOutputs(outputName string) func(t *testing.T, output infratests.TerraformOutput) {
-	return func(t *testing.T, output infratests.TerraformOutput) {
+func InspectCosmosDBModuleOutputs(outputName string) func(t *testing.T, output integration.TerraformOutput) {
+	return func(t *testing.T, output integration.TerraformOutput) {
 		id, endpoint, primaryMasterKey, connectionStrings := getModuleOutputs(output, outputName)
 		validateOutputs(t, id, endpoint, primaryMasterKey, connectionStrings)
 	}

infra/modules/providers/azure/cosmosdb/tests/integration/cosmos_test.go

@@ -1,22 +1,25 @@
 package integration
 
 import (
+	"os"
 	"testing"
 
 	"github.com/microsoft/cobalt/infra/modules/providers/azure/cosmosdb/tests"
-	"github.com/microsoft/cobalt/test-harness/infratests"
+	"github.com/microsoft/terratest-abstraction/integration"
 )
 
+var subscriptionID = os.Getenv("ARM_SUBSCRIPTION_ID")
+
 func TestCosmosDeployment(t *testing.T) {
 
-	testFixture := infratests.IntegrationTestFixture{
+	testFixture := integration.IntegrationTestFixture{
 		GoTest:                t,
-		TfOptions:             tests.CosmosDBOptions,
+		TfOptions:             tests.CosmosDbTFOptions,
 		ExpectedTfOutputCount: 3,
-		TfOutputAssertions: []infratests.TerraformOutputValidation{
+		TfOutputAssertions: []integration.TerraformOutputValidation{
 			InspectCosmosDBModuleOutputs("properties"),
-			InspectProvisionedCosmosDBAccount("resource_group_name", "account_name", "properties"),
+			InspectProvisionedCosmosDBAccount(subscriptionID, "resource_group_name", "account_name", "properties"),
 		},
 	}
-	infratests.RunIntegrationTests(&testFixture)
+	integration.RunIntegrationTests(&testFixture)
 }

infra/modules/providers/azure/cosmosdb/tests/test.tfvars

@@ -0,0 +1,4 @@
+COSMOSDB_ACCOUNT_NAME    = ""
+RESOURCE_GROUP_NAME      = ""
+PRIMARY_REPLICA_LOCATION = ""
+ARM_SUBSCRIPTION_ID      = ""

infra/modules/providers/azure/cosmosdb/tests/tf_options.go

@@ -6,22 +6,11 @@ import (
 	"github.com/gruntwork-io/terratest/modules/terraform"
 )
 
-// CosmosDBAccountName the name of the Database account in CosmosDB
-var cosmosDBAccountName = os.Getenv("COSMOSDB_ACCOUNT_NAME")
+// ResourceGroupName - The Resource Group Name
+var ResourceGroupName = os.Getenv("RESOURCE_GROUP_NAME")
 
-// PrimaryReplicaLocation the Azure region for the primary replica
-var primaryReplicaLocation = os.Getenv("PRIMARY_REPLICA_LOCATION")
-
-// ResourceGroupName the name of the resource group
-var resourceGroupName = os.Getenv("RESOURCE_GROUP_NAME")
-
-// CosmosDBOptions terraform options used for cosmos integration testing
-var CosmosDBOptions = &terraform.Options{
+// CosmosDbTFOptions common terraform options used for unit and integration testing
+var CosmosDbTFOptions = &terraform.Options{
 	TerraformDir: "../../",
-	Upgrade:      true,
-	Vars: map[string]interface{}{
-		"name":                     cosmosDBAccountName,
-		"resource_group_name":      resourceGroupName,
-		"primary_replica_location": primaryReplicaLocation,
-	},
+	VarFiles:     []string{"./tests/test.tfvars"},
 }

infra/modules/providers/azure/cosmosdb/variables.tf

@@ -3,7 +3,7 @@ variable "resource_group_name" {
   type        = string
 }
 
-variable "name" {
+variable "account_name" {
   description = "The name that CosmosDB will be created with."
   type        = string
 }
@@ -48,4 +48,11 @@ variable "databases" {
     throughput = number
   }))
   default = []
+}
+
+# VNET Restriction (optional)
+variable "vnet_subnet_id" {
+  description = "The VNet integration subnet gateway identifier."
+  type        = string
+  default     = "10.2.0.0/16"
 }

test-harness/terratest-extensions/modules/azure/cosmos.go

@@ -0,0 +1,50 @@
+package azure
+
+import (
+	"context"
+	"testing"
+
+	"github.com/Azure/azure-sdk-for-go/services/cosmos-db/mgmt/2015-04-08/documentdb"
+)
+
+// cosmosClientE - Connects to the cosmos client
+func cosmosClientE(subscriptionID string) (*documentdb.DatabaseAccountsClient, error) {
+	authorizer, err := DeploymentServicePrincipalAuthorizer()
+	if err != nil {
+		return nil, err
+	}
+
+	client := documentdb.NewDatabaseAccountsClient(subscriptionID)
+	client.Authorizer = authorizer
+	// Appends given user agent value to header for all future http calls to cosmos server for duration of integ tests.
+	client.AddToUserAgent("integration-test-harness")
+	return &client, err
+}
+
+func getCosmosDBAccountE(subscriptionID string, resourceGroupName string, accountName string) (*documentdb.DatabaseAccount, error) {
+	client, err := cosmosClientE(subscriptionID)
+
+	if err != nil {
+		return nil, err
+	}
+
+	ctx := context.Background()
+	response, err := client.Get(ctx, resourceGroupName, accountName)
+
+	if err != nil {
+		return nil, err
+	}
+
+	return &response, nil
+}
+
+// GetCosmosDBAccount - Retrieves the properties of a CosmosDB Database Account.
+func GetCosmosDBAccount(t *testing.T, subscriptionID string, resourceGroupName string, accountName string) *documentdb.DatabaseAccount {
+	resource, err := getCosmosDBAccountE(subscriptionID, resourceGroupName, accountName)
+
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	return resource
+}