Support azure migrate assessments

README.md

@@ -164,6 +164,8 @@ The following is a list of static resources.
 - [azure_management_groups](docs/resources/azure_management_groups.md)
 - [azure_mariadb_server](docs/resources/azure_mariadb_server.md)
 - [azure_mariadb_servers](docs/resources/azure_mariadb_servers.md)
+- [azure_migrate_assessment](docs/resources/azure_migrate_assessment.md)
+- [azure_migrate_assessments](docs/resources/azure_migrate_assessments.md)
 - [azure_monitor_activity_log_alert](docs/resources/azure_monitor_activity_log_alert.md)
 - [azure_monitor_activity_log_alerts](docs/resources/azure_monitor_activity_log_alerts.md)
 - [azure_monitor_log_profile](docs/resources/azure_monitor_log_profile.md)

docs/resources/azure_migrate_assessment.md

@@ -0,0 +1,102 @@
+---
+title: About the azure_migrate_assessment Resource
+platform: azure
+---
+
+# azure_migrate_assessment
+
+Use the `azure_migrate_assessment` InSpec audit resource to test the properties related to Azure Migrate assessment.
+
+## Azure REST API version, Endpoint, and HTTP Client Parameters
+
+This resource interacts with API versions supported by the resource provider. The `api_version` is defined as a resource parameter.
+If not provided, the latest version is used. For more information, refer to [`azure_generic_resource`](azure_generic_resource.md).
+
+Unless defined, `azure_cloud` global endpoint and default values for the HTTP client are used. For more information, refer to the resource pack [README](../../README.md).
+
+## Availability
+
+### Installation
+
+This resource is available in the [InSpec Azure resource pack](https://github.com/inspec/inspec-azure). For an example, `inspec.yml` file and how to set up your Azure credentials, refer to resource pack [README](../../README.md#Service-Principal).
+
+## Syntax
+
+`name`, `resource_group`, `project_name`, and `group_name` are required parameters.
+
+```ruby
+describe azure_migrate_assessment(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', group_name: 'GROUP_NAME', NAME: 'ASSESSMENT_NAME') do
+  it                                      { should exist }
+  its('name')                             { should cmp 'ASSESSMENT_NAME' }
+  its('type')                             { should cmp 'Microsoft.Migrate/assessmentprojects/groups/assessments' }
+end
+```
+
+```ruby
+describe azure_migrate_assessment(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', group_name: 'GROUP_NAME', NAME: 'ASSESSMENT_NAME') do
+  it  { should exist }
+end
+```
+
+## Parameters
+
+| Name           | Description                                                                      |
+|----------------|----------------------------------------------------------------------------------|
+| name           | Name of the Azure Migrate assessment to test.                                    |
+| resource_group | Azure resource group where the targeted resource resides in.                     |
+| project_name   | Azure Migrate assessment project.                                                |
+| group_name     | Unique name of a group within a project.                                         |
+
+The parameter set should be provided for a valid query:
+
+- `resource_group`, `project_name`, `group_name`, and `name`.
+
+## Properties
+
+| Property                      | Description                                                      |
+|-------------------------------|------------------------------------------------------------------|
+| id                            | Path reference to the assessment.                                |
+| name                          | Unique name of an assessment.                                    |
+| type                          | Object type.                                                     |
+| eTag                          | For optimistic concurrency control.                              |
+| properties                    | Properties of the assessment.                                    |
+| properties.azureDiskType      | Storage type selected for this disk.                             |
+| properties.currency           | Currency to report prices in.                                    |
+| properties.sizingCriterion    | Assessment sizing criterion.                                     |
+| properties.reservedInstance   | Azure reserved instance.                                         |
+
+For properties applicable to all resources, such as `type`, `name`, `id`, and `properties`, refer to [`azure_generic_resource`](azure_generic_resource.md#properties).
+
+Refer to the [Azure documentation](https://docs.microsoft.com/en-us/rest/api/migrate/assessment/assessments/get) for a full list of available properties. Access any attribute in the response by separating the key names with a period (`.`).
+
+## Examples
+
+### Test that the migrate assessments has a minimum scaling factor
+
+```ruby
+describe azure_migrate_assessment(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', group_name: 'GROUP_NAME', NAME: 'ASSESSMENT_NAME') do
+  its('properties.scalingFactor') { should eq 1.0 }
+end
+```
+
+## Matchers
+
+This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](/inspec/matchers/).
+
+### exists
+
+```ruby
+# If a Migrate Assessments is found, it will exist
+describe azure_migrate_assessment(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', group_name: 'GROUP_NAME', NAME: 'ASSESSMENT_NAME') do
+  it { should exist }
+end
+
+# if Migrate Assessments are not found, it will not exist
+describe azure_migrate_assessment(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', group_name: 'GROUP_NAME', NAME: 'ASSESSMENT_NAME') do
+  it { should_not exist }
+end
+```
+
+## Azure Permissions
+
+Your [Service Principal](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-create-service-principal-portal) must be set up with a `contributor` role on the subscription you wish to test.

docs/resources/azure_migrate_assessments.md

@@ -0,0 +1,125 @@
+---
+title: About the azure_migrate_assessments Resource
+platform: azure
+---
+
+# azure_migrate_assessments
+
+Use the `azure_migrate_assessments` InSpec audit resource to test the properties related to all Azure Migrate assessments within a project.
+
+## Azure REST API version, Endpoint, and HTTP Client Parameters
+
+This resource interacts with API versions supported by the resource provider. The `api_version` is defined as a resource parameter.
+If not provided, the latest version is used. For more information, refer to [`azure_generic_resource`](azure_generic_resource.md).
+
+Unless defined, `azure_cloud` global endpoint and default values for the HTTP client is used. For more information, refer to the resource pack [README](../../README.md).
+
+## Availability
+
+### Installation
+
+This resource is available in the [InSpec Azure resource pack](https://github.com/inspec/inspec-azure). For an example, `inspec.yml` file and how to set up your Azure credentials, refer to resource pack [README](../../README.md#Service-Principal).
+
+## Syntax
+
+An `azure_migrate_assessments` resource block returns all Azure Migrate assessments within a project.
+
+```ruby
+describe azure_migrate_assessments(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME') do
+  #...
+end
+```
+
+## Parameters
+| Name           | Description                                                                      |
+|----------------|----------------------------------------------------------------------------------|
+| resource_group | Azure resource group that the targeted resource resides in.                      |
+| project_name   | Azure Migrate assessments project name.                                          |
+
+The parameter set should be provided for a valid query:
+- `resource_group` and `project_name`
+
+## Properties
+
+|Property                        | Description                                                            | Filter Criteria<superscript>*</superscript> |
+|--------------------------------|------------------------------------------------------------------------|-------------------------|
+| ids                            | Path reference to the assessments.                                     | `id`                    |
+| names                          | Unique names for all assessments.                                      | `name`                  |
+| types                          | Type of the objects.                                                   | `type`                  |
+| eTags                          | A list of eTags for all the assessments.                               | `eTag`                  |
+| properties                     | A list of Properties for all the assessments.                          | `properties`            |
+| azureDiskTypes                 | Storage type selected for the disk of all the assessments.             | `azureDiskType`         |
+| azureHybridUseBenefits         | AHUB discount on windows virtual machines of all the assessments.      | `azureHybridUseBenefit` |
+| azureLocations                 | Target Azure locations for which the machines should be assessed.      | `azureLocation`         |
+| azureOfferCodes                | Offer codes according to which cost estimation is done.                | `azureOfferCode`        |
+| azurePricingTiers              | Pricing tiers for Size evaluation.                                     | `azurePricingTier`      |
+| azureStorageRedundancies       | Storage Redundancy types offered by Azure.                             | `azureStorageRedundancy`|
+| azureVmFamilies                | List of azure VM families.                                             | `azureVmFamilies`       |
+| confidenceRatingInPercentages  | Confidence rating percentages for assessment.                          | `confidenceRatingInPercentage`|
+| createdTimestamps              | Time when this project is created.                                     | `createdTimestamp`      |
+| currencies                     | Currencies to report prices in.                                        | `currency`              |
+| discountPercentages            | Custom discount percentages to be applied on final costs.              | `discountPercentage`    |
+| eaSubscriptionIds              | Enterprise agreement subscription arm ids.                             | `eaSubscriptionId`      |
+| monthlyBandwidthCosts          | Monthly network cost estimates for the machines.                       | `monthlyBandwidthCost`  |
+| monthlyComputeCosts            | Monthly compute cost estimates for the machines.                       | `monthlyComputeCost`    |
+| monthlyPremiumStorageCosts     | Monthly premium storage cost estimates for the machines.               | `monthlyPremiumStorageCost`|
+| monthlyStandardSSDStorageCosts | Monthly standard SSD storage cost estimates for the machines.          | `monthlyStandardSSDStorageCost`|
+| monthlyStorageCosts            | Monthly storage cost estimates for the machines.                       | `monthlyStorageCost`    |
+| numberOfMachines               | Number of assessed machines part of the assessments.                   | `numberOfMachines`      |
+| percentiles                    | Percentiles of performance data used to recommend Azure size.          | `percentile`            |
+| perfDataEndTimes               | End times to consider performance data for assessments.                | `perfDataEndTime`       |
+| perfDataStartTimes             | Start times to consider performance data for assessments.              | `perfDataStartTime`     |
+| pricesTimestamps               | Times when the Azure Prices are queried.                               | `pricesTimestamp`       |
+| reservedInstances              | Azure reserved instances.                                              | `reservedInstance`      |
+| scalingFactors                 | Scaling factors used over utilization data to add a performance buffer for new machines to be created in Azure.| `scalingFactor` |
+| sizingCriterions               | Assessment sizing criterions.                                          | `sizingCriterion`       |
+| stages                         | User configurable setting that describes the status of the assessments.| `stage`                 |
+| statuses                       | Whether the assessments have been created and is valid.                | `status`                |
+| timeRanges                     | Time ranges of performance data used to recommend a size.              | `timeRange`             |
+| updatedTimestamps              | Times when the project is last updated.                                | `updatedTimestamp`      |
+| vmUptimes                      | Specify the durations for which the VMs are up in the on-premises environment.| `vmUptime`       |
+
+Refer to the [Azure Migrate assements documentation](https://docs.microsoft.com/en-us/rest/api/migrate/assessment/assessments/list-by-project) for additional information.
+<superscript>*</superscript> For information on how to use filter criteria on plural resources refer to [FilterTable usage](https://github.com/inspec/inspec/blob/master/dev-docs/filtertable-usage.md).
+
+## Examples
+
+### Loop through migrate assessments by their names
+
+```ruby
+azure_migrate_assessments(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME'.names.each do |name|
+  describe azure_container_group (resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME', group_name: 'GROUP_NAME', name: name) do
+    it { should exist }
+  end
+end
+```
+
+### Test to ensure migrate assessments exist with local redundancy
+
+```ruby
+describe azure_migrate_assessments(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME').where(azureStorageRedundancy: 'LocallyRedundant') do
+  it { should exist }
+end
+```
+
+## Matchers
+
+This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [Universal Matchers page](https://www.inspec.io/docs/reference/matchers/).
+
+### exists
+
+```ruby
+# Should not exist if no Migrate Assessments are present in the project and in the resource group
+describe azure_migrate_assessments(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME') do
+  it { should_not exist }
+end
+
+# Should exist if the filter returns at least one Migrate Assessment in the project and in the resource group
+describe azure_migrate_assessments(resource_group: 'RESOURCE_GROUP', project_name: 'PROJECT_NAME') do
+  it { should exist }
+end
+```
+
+## Azure Permissions
+
+Your [Service Principal](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-create-service-principal-portal) must be set up with a `contributor` role on the subscription you wish to test.

libraries/azure_backend.rb

@@ -601,7 +601,7 @@ def create_method(object, name, value)
     # Create the necessary method based on the var that has been passed
     # Test the value for its type so that the method can be setup correctly
     case value.class.to_s
-    when 'String', 'Integer', 'TrueClass', 'FalseClass', 'Fixnum', 'Time'
+    when 'String', 'Integer', 'TrueClass', 'FalseClass', 'Fixnum', 'Time', 'Bignum', 'Float'
       object.define_singleton_method name do
         value
       end

libraries/azure_migrate_assessment.rb

@@ -0,0 +1,24 @@
+require 'azure_generic_resource'
+
+class AzureMigrateAssessment < AzureGenericResource
+  name 'azure_migrate_assessment'
+  desc 'Retrieves and verifies the settings of a container group instance.'
+  example <<-EXAMPLE
+    describe azure_migrate_assessment(resource_group: 'migrated_vms', project_name: 'zoneA_migrate_assessment_project', group_name: 'zoneA_machines_group', name: 'zoneA_machines_migrate_assessment') do
+      it { should exist }
+    end
+  EXAMPLE
+
+  def initialize(opts = {})
+    raise ArgumentError, 'Parameters must be provided in an Hash object.' unless opts.is_a?(Hash)
+
+    opts[:resource_provider] = specific_resource_constraint('Microsoft.Migrate/assessmentProjects', opts)
+    opts[:required_parameters] = %i(project_name group_name name)
+    opts[:resource_path] = [opts[:project_name], 'groups', opts[:group_name], 'assessments'].join('/')
+    super(opts, true)
+  end
+
+  def to_s
+    super(AzureMigrateAssessment)
+  end
+end

libraries/azure_migrate_assessments.rb

@@ -0,0 +1,34 @@
+require 'azure_generic_resources'
+
+class AzureMigrateAssessments < AzureGenericResources
+  name 'azure_migrate_assessments'
+  desc 'Verifies settings for a collection of Azure Migrate Assessments in a project'
+  example <<-EXAMPLE
+    describe azure_migrate_assessments(resource_group: 'migrated_vms', project_name: 'zoneA_migrate_assessment_project') do
+        it { should exist }
+    end
+  EXAMPLE
+
+  def initialize(opts = {})
+    raise ArgumentError, 'Parameters must be provided in an Hash object.' unless opts.is_a?(Hash)
+    opts[:resource_provider] = specific_resource_constraint('Microsoft.Migrate/assessmentProjects', opts)
+    opts[:required_parameters] = %i(project_name)
+    opts[:resource_path] = [opts[:project_name], 'assessments'].join('/')
+    super(opts, true)
+    return if failed_resource?
+
+    populate_filter_table_from_response
+  end
+
+  def to_s
+    super(AzureMigrateAssessments)
+  end
+
+  private
+
+  def populate_table
+    @resources.each do |resource|
+      @table << resource.merge(resource[:properties])
+    end
+  end
+end

terraform/azure.tf

@@ -1340,14 +1340,15 @@ resource "azurerm_policy_assignment" "inspec_compliance_policy_assignment" {
 }
 
 resource "azurerm_bastion_host" "abh" {
-  name                = "test_bastion"
-  location            = azurerm_resource_group.rg.location
+  name = "test_bastion"
+  location = azurerm_resource_group.rg.location
   resource_group_name = azurerm_resource_group.rg.name
   ip_configuration {
-    name                 = "configuration"
-    subnet_id            = azurerm_subnet.subnet.id
+    name = "configuration"
+    subnet_id = azurerm_subnet.subnet.id
     public_ip_address_id = azurerm_public_ip.public_ip_address.id
   }
+}
 
 }
 

terraform/outputs.tf

@@ -489,3 +489,8 @@ output "inspec_virtual_wan" {
   description = "The resource name of the inspec virtual WAN"
   value = azurerm_virtual_wan.inspec-nw-wan.name
 }
+
+output "inspec_migrate_project_name" {
+  description = "The name of the Azure Migrate Project that was setup manually since there is no tf resource"
+  value = var.inspec_migrate_project_name
+}

terraform/variables.tf

@@ -167,6 +167,10 @@ variable "inspec_container_group_name" {
   default = "inspec_container_trial"
 }
 
+variable "inspec_migrate_project_name" {
+  default = "inspec-migrate-integ117eproject"
+}
+
 variable "sample_directory_object" {
   default = "adc07321-ef2b-44d5-a210-559aa5f10f2d"
 }

test/integration/verify/controls/azure_migrate_assessment.rb

@@ -0,0 +1,17 @@
+resource_group = input(:resource_group, value: '')
+project_name = input(:inspec_migrate_project_name, value: '')
+# either way these are manual values since there is no terraform resource available
+group_name = 'inspec-migrate-test-assement-group'
+name = 'inspec-migrate-test-assement'
+
+control 'verify a azure migrate assessment' do
+  describe azure_migrate_assessment(resource_group: resource_group, project_name: project_name, group_name: group_name, name: name) do
+    it { should exist }
+    its('name') { should eq name }
+    its('type') { should eq 'Microsoft.Migrate/assessmentprojects/groups/assessments' }
+    its('properties.azurePricingTier') { should eq 'Standard' }
+    its('properties.azureStorageRedundancy') { should eq 'LocallyRedundant' }
+    its('properties.groupType') { should eq 'Import' }
+    its('properties.scalingFactor') { should eq 1.0 }
+  end
+end

test/integration/verify/controls/azure_migrate_assessments.rb

@@ -0,0 +1,15 @@
+resource_group = input(:resource_group, value: '')
+project_name = input(:inspec_migrate_project_name, value: '')
+name = 'inspec-migrate-test-assement'
+
+control 'verify all azure migrate assessments in a project' do
+  describe azure_migrate_assessments(resource_group: resource_group, project_name: project_name) do
+    it { should exist }
+    its('names') { should include name }
+    its('types') { should include 'Microsoft.Migrate/assessmentprojects/groups/assessments' }
+    its('azurePricingTiers') { should include 'Standard' }
+    its('azureStorageRedundancies') { should include 'LocallyRedundant' }
+    its('groupTypes') { should include 'Import' }
+    its('scalingFactors') { should include 1.0 }
+  end
+end