diff --git a/examples/azure/terraform-azure-datafactory-example/main.tf b/examples/azure/terraform-azure-datafactory-example/main.tf new file mode 100644 index 000000000..934e6bba3 --- /dev/null +++ b/examples/azure/terraform-azure-datafactory-example/main.tf @@ -0,0 +1,49 @@ +# --------------------------------------------------------------------------------------------------------------------- +# DEPLOY AN AZURE DATA FACTORY +# This is an example of how to deploy an AZURE Data Factory +# See test/terraform_azure_example_test.go for how to write automated tests for this code. +# --------------------------------------------------------------------------------------------------------------------- + + +# --------------------------------------------------------------------------------------------------------------------- +# CONFIGURE OUR AZURE CONNECTION +# --------------------------------------------------------------------------------------------------------------------- + +provider "azurerm" { + version = "~>2.29.0" + features {} +} + +# --------------------------------------------------------------------------------------------------------------------- +# CREATE RANDOM PASSWORD +# --------------------------------------------------------------------------------------------------------------------- + +# Random password is used as an example to simplify the deployment and improve the security of the database. +# This is not as a production recommendation as the password is stored in the Terraform state file. +resource "random_password" "password" { + length = 16 + override_special = "-_%@" + min_upper = "1" + min_lower = "1" + min_numeric = "1" + min_special = "1" +} + +# --------------------------------------------------------------------------------------------------------------------- +# DEPLOY A RESOURCE GROUP +# --------------------------------------------------------------------------------------------------------------------- + +resource "azurerm_resource_group" "datafactory_rg" { + name = "terratest-datafactory-${var.postfix}" + location = var.location +} + +# --------------------------------------------------------------------------------------------------------------------- +# DEPLOY A DATA FACTORY +# --------------------------------------------------------------------------------------------------------------------- + +resource "azurerm_data_factory" "data_factory" { + name = "datafactory${var.postfix}" + location = azurerm_resource_group.datafactory_rg.location + resource_group_name = azurerm_resource_group.datafactory_rg.name +} \ No newline at end of file diff --git a/examples/azure/terraform-azure-datafactory-example/outputs.tf b/examples/azure/terraform-azure-datafactory-example/outputs.tf new file mode 100644 index 000000000..f1b4c328f --- /dev/null +++ b/examples/azure/terraform-azure-datafactory-example/outputs.tf @@ -0,0 +1,7 @@ +output "resource_group_name" { + value = azurerm_resource_group.datafactory_rg.name +} + +output "datafactory_name" { + value = azurerm_data_factory.data_factory.name +} diff --git a/examples/azure/terraform-azure-datafactory-example/variables.tf b/examples/azure/terraform-azure-datafactory-example/variables.tf new file mode 100644 index 000000000..45feecbaa --- /dev/null +++ b/examples/azure/terraform-azure-datafactory-example/variables.tf @@ -0,0 +1,31 @@ +# --------------------------------------------------------------------------------------------------------------------- +# ENVIRONMENT VARIABLES +# Define these secrets as environment variables +# --------------------------------------------------------------------------------------------------------------------- + +# ARM_CLIENT_ID +# ARM_CLIENT_SECRET +# ARM_SUBSCRIPTION_ID +# ARM_TENANT_ID + +# --------------------------------------------------------------------------------------------------------------------- +# REQUIRED PARAMETERS +# You must provide a value for each of these parameters. +# --------------------------------------------------------------------------------------------------------------------- + +# --------------------------------------------------------------------------------------------------------------------- +# OPTIONAL PARAMETERS +# These parameters have reasonable defaults. +# --------------------------------------------------------------------------------------------------------------------- + +variable "location" { + description = "The supported azure location where the resource exists" + type = string + default = "usgovvirginia" +} + +variable "postfix" { + description = "A postfix string to centrally mitigate resource name collisions." + type = string + default = "resource" +} diff --git a/go.mod b/go.mod index 35b98bbb4..6c3ba29d5 100644 --- a/go.mod +++ b/go.mod @@ -5,7 +5,7 @@ go 1.19 require ( cloud.google.com/go v0.105.0 // indirect cloud.google.com/go/storage v1.27.0 - github.com/Azure/azure-sdk-for-go v50.2.0+incompatible + github.com/Azure/azure-sdk-for-go v51.0.0+incompatible github.com/Azure/go-autorest/autorest v0.11.20 github.com/Azure/go-autorest/autorest/azure/auth v0.5.8 github.com/Azure/go-autorest/autorest/to v0.4.0 // indirect @@ -53,6 +53,7 @@ require ( ) require ( + cloud.google.com/go v0.105.0 // indirect cloud.google.com/go/compute v1.12.1 // indirect cloud.google.com/go/compute/metadata v0.2.1 // indirect cloud.google.com/go/iam v0.7.0 // indirect diff --git a/go.sum b/go.sum index e2a86b5ec..2b2b7c3bc 100644 --- a/go.sum +++ b/go.sum @@ -191,8 +191,8 @@ cloud.google.com/go/workflows v1.6.0/go.mod h1:6t9F5h/unJz41YqfBmqSASJSXccBLtD1V cloud.google.com/go/workflows v1.7.0/go.mod h1:JhSrZuVZWuiDfKEFxU0/F1PQjmpnpcoISEXH2bcHC3M= dmitri.shuralyov.com/gpu/mtl v0.0.0-20190408044501-666a987793e9/go.mod h1:H6x//7gZCb22OMCxBHrMx7a5I7Hp++hsVxbQ4BYO7hU= github.com/Azure/azure-sdk-for-go v16.2.1+incompatible/go.mod h1:9XXNKU+eRnpl9moKnB4QOLf1HestfXbmab5FXxiDBjc= -github.com/Azure/azure-sdk-for-go v50.2.0+incompatible h1:w9EF1btRfLLWbNEp6XvkMjeA6nQ3e1GZ2KNDqB/SjOQ= -github.com/Azure/azure-sdk-for-go v50.2.0+incompatible/go.mod h1:9XXNKU+eRnpl9moKnB4QOLf1HestfXbmab5FXxiDBjc= +github.com/Azure/azure-sdk-for-go v51.0.0+incompatible h1:p7blnyJSjJqf5jflHbSGhIhEpXIgIFmYZNg5uwqweso= +github.com/Azure/azure-sdk-for-go v51.0.0+incompatible/go.mod h1:9XXNKU+eRnpl9moKnB4QOLf1HestfXbmab5FXxiDBjc= github.com/Azure/go-ansiterm v0.0.0-20170929234023-d6e3b3328b78/go.mod h1:LmzpDX56iTiv29bbRTIsUNlaFfuhWRQBWjQdVyAevI8= github.com/Azure/go-autorest v10.8.1+incompatible/go.mod h1:r+4oMnoxhatjLLJ6zxSWATqVooLgysK6ZNox3g/xq24= github.com/Azure/go-autorest v14.2.0+incompatible h1:V5VMDjClD3GiElqLWO7mz2MxNAK/vTfRHdAubSIPRgs= diff --git a/modules/azure/client_factory.go b/modules/azure/client_factory.go index 383ff8980..421175639 100644 --- a/modules/azure/client_factory.go +++ b/modules/azure/client_factory.go @@ -24,6 +24,7 @@ import ( "github.com/Azure/azure-sdk-for-go/services/containerinstance/mgmt/2018-10-01/containerinstance" "github.com/Azure/azure-sdk-for-go/services/containerregistry/mgmt/2019-05-01/containerregistry" "github.com/Azure/azure-sdk-for-go/services/containerservice/mgmt/2019-11-01/containerservice" + "github.com/Azure/azure-sdk-for-go/services/datafactory/mgmt/2018-06-01/datafactory" kvmng "github.com/Azure/azure-sdk-for-go/services/keyvault/mgmt/2016-10-01/keyvault" "github.com/Azure/azure-sdk-for-go/services/network/mgmt/2019-09-01/network" "github.com/Azure/azure-sdk-for-go/services/resources/mgmt/2019-06-01/subscriptions" @@ -771,6 +772,35 @@ func CreateFrontDoorFrontendEndpointClientE(subscriptionID string) (*frontdoor.F return &client, nil } +// CreateDataFactoriesClientE is a helper function that will setup a synapse client. +func CreateDataFactoriesClientE(subscriptionID string) (*datafactory.FactoriesClient, error) { + // Validate Azure subscription ID + subscriptionID, err := getTargetAzureSubscription(subscriptionID) + if err != nil { + return nil, err + } + + // Lookup environment URI + baseURI, err := getBaseURI() + if err != nil { + return nil, err + } + + // Create a synapse client + dataFactoryClient := datafactory.NewFactoriesClientWithBaseURI(baseURI, subscriptionID) + + // Create an authorizer + authorizer, err := NewAuthorizer() + if err != nil { + return nil, err + } + + // Attach authorizer to the client + dataFactoryClient.Authorizer = *authorizer + + return &dataFactoryClient, nil +} + // GetKeyVaultURISuffixE returns the proper KeyVault URI suffix for the configured Azure environment. // This function would fail the test if there is an error. func GetKeyVaultURISuffixE() (string, error) { diff --git a/modules/azure/datafactory.go b/modules/azure/datafactory.go new file mode 100644 index 000000000..4d88c2d7b --- /dev/null +++ b/modules/azure/datafactory.go @@ -0,0 +1,36 @@ +package azure + +import ( + "context" + + "github.com/Azure/azure-sdk-for-go/services/datafactory/mgmt/2018-06-01/datafactory" + "github.com/gruntwork-io/terratest/modules/testing" + "github.com/stretchr/testify/require" +) + +// GetSynapseWorkspace is a helper function that gets the synapse workspace. +// This function would fail the test if there is an error. +func GetDataFactory(t testing.TestingT, resGroupName string, factoryName string, subscriptionID string) *datafactory.Factory { + Workspace, err := GetDataFactoryE(t, subscriptionID, resGroupName, factoryName) + require.NoError(t, err) + + return Workspace +} + +// GetDataFactoryE is a helper function that gets the workspace. +func GetDataFactoryE(t testing.TestingT, subscriptionID string, resGroupName string, factoryName string) (*datafactory.Factory, error) { + // Create a datafactory client + datafactoryClient, err := CreateDataFactoriesClientE(subscriptionID) + if err != nil { + return nil, err + } + + // Get the corresponding synapse workspace + dataFactory, err := datafactoryClient.Get(context.Background(), resGroupName, factoryName, "") + if err != nil { + return nil, err + } + + //Return synapse workspace + return &dataFactory, nil +} diff --git a/modules/azure/datafactory_test.go b/modules/azure/datafactory_test.go new file mode 100644 index 000000000..b3f688aa4 --- /dev/null +++ b/modules/azure/datafactory_test.go @@ -0,0 +1,23 @@ +package azure + +import ( + "testing" + + "github.com/stretchr/testify/require" +) + +/* +The below tests are currently stubbed out, with the expectation that they will throw errors. +If/when CRUD methods are introduced for Azure Synapse, these tests can be extended +*/ + +func TestGetDataFactoryE(t *testing.T) { + t.Parallel() + + resGroupName := "terratest-datafactory-resource" + subscriptionID := "00fb78cc-7201-4e1c-8203-2b2e1390309a" + dataFactoryName := "datafactoryresource" + + _, err := GetDataFactoryE(t, subscriptionID, resGroupName, dataFactoryName) + require.Error(t, err) +} diff --git a/test/azure/terraform_azure_datafactory_example_test.go b/test/azure/terraform_azure_datafactory_example_test.go new file mode 100644 index 000000000..cd3d99260 --- /dev/null +++ b/test/azure/terraform_azure_datafactory_example_test.go @@ -0,0 +1,46 @@ +package test + +import ( + "strings" + "testing" + + "github.com/gruntwork-io/terratest/modules/azure" + "github.com/gruntwork-io/terratest/modules/random" + "github.com/gruntwork-io/terratest/modules/terraform" + "github.com/stretchr/testify/assert" +) + +func TestTerraformAzureDataFactoryExample(t *testing.T) { + t.Parallel() + + uniquePostfix := strings.ToLower(random.UniqueId()) + expectedDataFactoryProvisioningState := "Succeeded" + expectedLocation := "usgovvirginia" + + // website::tag::1:: Configure Terraform setting up a path to Terraform code. + terraformOptions := &terraform.Options{ + // The path to where our Terraform code is located + TerraformDir: "../../examples/azure/terraform-azure-datafactory-example", + Vars: map[string]interface{}{ + "postfix": uniquePostfix, + "location": expectedLocation, + }, + } + + // website::tag::4:: At the end of the test, run `terraform destroy` to clean up any resources that were created + defer terraform.Destroy(t, terraformOptions) + + // website::tag::2:: Run `terraform init` and `terraform apply`. Fail the test if there are any errors. + terraform.InitAndApply(t, terraformOptions) + + // website::tag::3:: Run `terraform output` to get the values of output variables + expectedResourceGroupName := terraform.Output(t, terraformOptions, "resource_group_name") + expectedDataFactoryName := terraform.Output(t, terraformOptions, "datafactory_name") + + // // website::tag::4:: Get synapse details and assert them against the terraform output + actualDataFactory := azure.GetDataFactory(t, expectedResourceGroupName, expectedDataFactoryName, "") + + assert.Equal(t, expectedDataFactoryName, *actualDataFactory.Name) + assert.Equal(t, expectedDataFactoryProvisioningState, *actualDataFactory.FactoryProperties.ProvisioningState) + +}