feat: Add an output value denoting the type of the blueprint (#184)

* Update outputs.tf

* Remove version from blueprint type.

* Fix lint.

* Add version suffix to blueprint type and regen docs.

* Add tests.

* Move blueprint type value to local in versions.tf

README.md

@@ -81,6 +81,7 @@ module "secured_data_warehouse" {
 
 | Name | Description |
 |------|-------------|
+| blueprint\_type | Type of blueprint this module represents. |
 | cmek\_bigquery\_crypto\_key | The Customer Managed Crypto Key for the BigQuery service. |
 | cmek\_confidential\_bigquery\_crypto\_key | The Customer Managed Crypto Key for the confidential BigQuery service. |
 | cmek\_data\_ingestion\_crypto\_key | The Customer Managed Crypto Key for the data ingestion crypto boundary. |

examples/simple-example/README.md

@@ -22,6 +22,7 @@ This example illustrates how to use the `secured-data-warehouse` module.
 
 | Name | Description |
 |------|-------------|
+| blueprint\_type | Type of blueprint this module represents. |
 | cmek\_bigquery\_crypto\_key | The Customer Managed Crypto Key for the BigQuery service. |
 | cmek\_confidential\_bigquery\_crypto\_key | The Customer Managed Crypto Key for the confidential BigQuery service. |
 | cmek\_data\_ingestion\_crypto\_key | The Customer Managed Crypto Key for the data ingestion crypto boundary. |

examples/simple-example/outputs.tf

@@ -74,3 +74,8 @@ output "cmek_confidential_bigquery_crypto_key" {
   description = "The Customer Managed Crypto Key for the confidential BigQuery service."
   value       = module.secured_data_warehouse.cmek_confidential_bigquery_crypto_key
 }
+
+output "blueprint_type" {
+  description = "Type of blueprint this module represents."
+  value       = module.secured_data_warehouse.blueprint_type
+}

outputs.tf

@@ -152,3 +152,8 @@ output "cmek_confidential_bigquery_crypto_key" {
     time_sleep.wait_for_bridge_propagation
   ]
 }
+
+output "blueprint_type" {
+  description = "Type of blueprint this module represents."
+  value       = local.blueprint_type
+}

test/fixtures/simple-example/outputs.tf

@@ -99,3 +99,8 @@ output "cmek_confidential_bigquery_crypto_key" {
   description = "The Customer Managed Crypto Key for the confidential BigQuery service."
   value       = module.simple_example.cmek_confidential_bigquery_crypto_key
 }
+
+output "blueprint_type" {
+  description = "Type of blueprint this module represents."
+  value       = module.simple_example.blueprint_type
+}

test/integration/simple-example/controls/gcloud.rb

@@ -13,6 +13,7 @@
 # limitations under the License.
 
 project_id = attribute('project_id')
+blueprint_type = attribute('blueprint_type')
 
 boolean_policy_constraints = [
   'constraints/iam.disableServiceAccountCreation',
@@ -27,7 +28,7 @@
 ]
 
 control 'gcloud' do
-  title 'organization boolean and list policy tests'
+  title 'boolean and list organization policy and output tests'
 
   boolean_policy_constraints.each do |constraint|
     describe command("gcloud beta resource-manager org-policies list --project=#{project_id} --format=json") do
@@ -82,4 +83,10 @@
       end
     end
   end
+
+  describe "check blueprint_type #{blueprint_type}" do
+    it 'should have expected value' do
+      expect("#{blueprint_type}" ).to eq 'blueprints/terraform/terraform-google-secured-data-warehouse/v1.0.0'
+    end
+  end
 end

test/integration/simple-example/inspec.yml

@@ -69,3 +69,6 @@ attributes:
   - name: cmek_confidential_bigquery_crypto_key
     required: true
     type: string
+  - name: blueprint_type
+    required: true
+    type: string

versions.tf

@@ -55,3 +55,7 @@ terraform {
   }
 
 }
+
+locals {
+  blueprint_type = "blueprints/terraform/terraform-google-secured-data-warehouse/v1.0.0"
+}