Merge pull request #653 from inspec/CHEF-12251-v2-MAGIC-MODULE-apigee…

…_v1-Organizations__instances__attachment

CHEF-12251-v2-MAGIC-MODULE-apigee_v1-Organizations__instances__attachment - Resource Implementation

README.md

@@ -199,6 +199,7 @@ The following resources are available in the InSpec GCP Profile
 | [google_access_context_manager_service_perimeter](docs/resources/google_access_context_manager_service_perimeter.md) | [google_access_context_manager_service_perimeters](docs/resources/google_access_context_manager_service_perimeters.md)         |
 | [google_apigee_endpoint_attachment](docs/resources/google_apigee_endpoint_attachment.md)            | [google_apigee_endpoint_attachments](docs/resources/google_apigee_endpoint_attachments.md)                     |
 | [google_apigee_organization_envgroup](docs/resources/google_apigee_organization_envgroup.md)            | [google_apigee_organization_envgroups](docs/resources/google_apigee_organization_envgroups.md)                     |
+| [google_apigee_organization_instance_attachment](docs/resources/google_apigee_organization_instance_attachment.md)   | [google_apigee_organization_instance_attachments](docs/resources/google_apigee_organization_instance_attachments.md)           |
 | [google_apigee_organization_envgroup_attachment](docs/resources/google_apigee_organization_envgroup_attachment.md)   | [google_apigee_organization_envgroup_attachments](docs/resources/google_apigee_organization_envgroup_attachments.md)           |
 | [google_appengine_standard_app_version](docs/resources/google_appengine_standard_app_version.md)                     | [google_appengine_standard_app_versions](docs/resources/google_appengine_standard_app_versions.md)                             |
 | [google_bigquery_dataset](docs/resources/google_bigquery_dataset.md)                                                 | [google_bigquery_datasets](docs/resources/google_bigquery_datasets.md)                                                         |

docs/resources/google_apigee_organization_instance_attachment.md

@@ -0,0 +1,54 @@
++++
+
+title = "google_apigee_organization_instance_attachment Resource"
+platform = "gcp"
+draft = false
+gh_repo = "inspec-gcp"
+
+
+[menu.inspec]
+
+title = "google_apigee_organization_instance_attachment"
+identifier = "inspec/resources/gcp/google_apigee_organization_instance_attachment Resource"
+parent = "inspec/resources/gcp"
++++
+
+Use the `google_apigee_organization_instance_attachment` InSpec audit resource to test the properties of a test a Google OrganizationInstanceAttachment.
+
+## Installation
+{{% inspec_gcp_install %}}
+
+## Syntax
+A `google_apigee_organization_instance_attachment` is used to test a Google OrganizationInstanceAttachment resource
+
+## Examples
+```
+describe google_apigee_organization_instance_attachment(parent:'value_parent', name:'value_name') do
+	it { should exist }
+	its('name') { should cmp 'value_name' }
+	its('environment') { should cmp 'value_environment' }
+	its('created_at') { should cmp 'value_createdat' }
+end
+
+describe google_apigee_organization_instance_attachment(parent:'value_parent',name: "does-not-exit") do
+	it { should_not exist }
+end
+```
+
+## Parameters
+Properties that can be accessed from the `google_apigee_organization_instance_attachment` resource:
+
+## Properties
+Properties that can be accessed from the `google_apigee_organization_instance_attachment` resource:
+
+
+  * `name`: Output only. ID of the attachment.
+
+  * `environment`: ID of the attached environment.
+
+  * `created_at`: Output only. Time the attachment was created in milliseconds since epoch.
+
+
+## GCP Permissions
+
+Ensure the [Apigee API](https://console.cloud.google.com/apis/library/apigee.googleapis.com/) is enabled for the current project.

docs/resources/google_apigee_organization_instance_attachments.md

@@ -0,0 +1,55 @@
++++
+
+title = "google_apigee_organization_instance_attachments Resource"
+platform = "gcp"
+draft = false
+gh_repo = "inspec-gcp"
+
+
+[menu.inspec]
+
+title = "google_apigee_organization_instance_attachments"
+identifier = "inspec/resources/gcp/google_apigee_organization_instance_attachments Resource"
+parent = "inspec/resources/gcp"
++++
+
+Use the `google_apigee_organization_instance_attachments` InSpec audit resource to test the properties of a test a Google OrganizationInstanceAttachment.
+
+## Installation
+{{% inspec_gcp_install %}}
+
+## Syntax
+A `google_apigee_organization_instance_attachments` is used to test a Google OrganizationInstanceAttachment resource
+
+## Examples
+```
+  describe google_apigee_organization_instance_attachments(parent: 'value_parent') do
+    it { should exist }
+    its('names') { should include 'value_name' }
+	  its('environments') { should include 'value_environment' }
+	  its('created_ats') { should include 'value_createdat' }
+  end
+```
+
+## Parameters
+Properties that can be accessed from the `google_apigee_organization_instance_attachments` resource:
+
+See [google_apigee_organization_instance_attachment.md](google_apigee_organization_instance_attachment.md) for more detailed information
+* `names`: an array of `google_apigee_organization_instance_attachment` name
+* `environments`: an array of `google_apigee_organization_instance_attachment` environment
+* `created_ats`: an array of `google_apigee_organization_instance_attachment` created_at
+## Properties
+Properties that can be accessed from the `google_apigee_organization_instance_attachments` resource:
+
+See [google_apigee_organization_instance_attachment.md](google_apigee_organization_instance_attachment.md) for more detailed information
+* `names`: an array of `google_apigee_organization_instance_attachment` name
+* `environments`: an array of `google_apigee_organization_instance_attachment` environment
+* `created_ats`: an array of `google_apigee_organization_instance_attachment` created_at
+
+## Filter Criteria
+This resource supports all of the above properties as filter criteria, which can be used
+with `where` as a block or a method.
+
+## GCP Permissions
+
+Ensure the [Apigee API](https://console.cloud.google.com/apis/library/apigee.googleapis.com/) is enabled for the current project.

libraries/google_apigee_organization_instance_attachment.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: false
+
+# ----------------------------------------------------------------------------
+#
+#     ***     AUTO GENERATED CODE    ***    Type: MMv1     ***
+#
+# ----------------------------------------------------------------------------
+#
+#     This file is automatically generated by Magic Modules and manual
+#     changes will be clobbered when the file is regenerated.
+#
+#     Please read more about how to change this file in README.md and
+#     CONTRIBUTING.md located at the root of this package.
+#
+# ----------------------------------------------------------------------------
+require 'gcp_backend'
+
+# A provider to manage Apigee resources.
+class ApigeeOrganizationInstanceAttachment < GcpResourceBase
+  name 'google_apigee_organization_instance_attachment'
+  desc 'OrganizationInstanceAttachment'
+  supports platform: 'gcp'
+
+  attr_reader :params
+  attr_reader :name
+  attr_reader :environment
+  attr_reader :created_at
+
+  def initialize(params)
+    super(params.merge({ use_http_transport: true }))
+    @params = params
+    @fetched = @connection.fetch(product_url(params[:beta]), resource_base_url, params, 'Get')
+    parse unless @fetched.nil?
+  end
+
+  def parse
+    @name = @fetched['name']
+    @environment = @fetched['environment']
+    @created_at = @fetched['createdAt']
+  end
+
+  def exists?
+    !@fetched.nil?
+  end
+
+  def to_s
+    "OrganizationInstanceAttachment #{@params[:name]}"
+  end
+
+  private
+
+  def product_url(_ = nil)
+    'https://apigee.googleapis.com/v1/'
+  end
+
+  def resource_base_url
+    '{{parent}}/attachments/{{name}}'
+  end
+end

libraries/google_apigee_organization_instance_attachments.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: false
+
+# ----------------------------------------------------------------------------
+#
+#     ***     AUTO GENERATED CODE    ***    Type: MMv1     ***
+#
+# ----------------------------------------------------------------------------
+#
+#     This file is automatically generated by Magic Modules and manual
+#     changes will be clobbered when the file is regenerated.
+#
+#     Please read more about how to change this file in README.md and
+#     CONTRIBUTING.md located at the root of this package.
+#
+# ----------------------------------------------------------------------------
+require 'gcp_backend'
+class ApigeeOrganizationInstanceAttachments < GcpResourceBase
+  name 'google_apigee_organization_instance_attachments'
+  desc 'OrganizationInstanceAttachment plural resource'
+  supports platform: 'gcp'
+
+  attr_reader :table
+
+  filter_table_config = FilterTable.create
+
+  filter_table_config.add(:names, field: :name)
+  filter_table_config.add(:environments, field: :environment)
+  filter_table_config.add(:created_ats, field: :created_at)
+
+  filter_table_config.connect(self, :table)
+
+  def initialize(params = {})
+    super(params.merge({ use_http_transport: true }))
+    @params = params
+    @table = fetch_wrapped_resource('attachments')
+  end
+
+  def fetch_wrapped_resource(wrap_path)
+    # fetch_resource returns an array of responses (to handle pagination)
+    result = @connection.fetch_all(product_url, resource_base_url, @params, 'Get')
+    return if result.nil?
+
+    # Conversion of string -> object hash to symbol -> object hash that InSpec needs
+    converted = []
+    result.each do |response|
+      next if response.nil? || !response.key?(wrap_path)
+      response[wrap_path].each do |hash|
+        hash_with_symbols = {}
+        hash.each_key do |key|
+          name, value = transform(key, hash)
+          hash_with_symbols[name] = value
+        end
+        converted.push(hash_with_symbols)
+      end
+    end
+
+    converted
+  end
+
+  def transform(key, value)
+    return transformers[key].call(value) if transformers.key?(key)
+
+    [key.to_sym, value]
+  end
+
+  def transformers
+    {
+      'name' => ->(obj) { [:name, obj['name']] },
+      'environment' => ->(obj) { [:environment, obj['environment']] },
+      'createdAt' => ->(obj) { [:created_at, obj['createdAt']] },
+    }
+  end
+
+  private
+
+  def product_url(_ = nil)
+    'https://apigee.googleapis.com/v1/'
+  end
+
+  def resource_base_url
+    '{{parent}}/attachments'
+  end
+end

test/integration/build/gcp-mm.tf

@@ -1716,6 +1716,21 @@ resource "google_apigee_envgroup_attachment" "engroup_attachment" {
   envgroup_id  = var.apigee_organization_envgroup_attachment.envgroup_id
   environment  = var.apigee_organization_envgroup_attachment.environment
 }
+resource "google_apigee_instance" "apigee_instance" {
+  name     = var.apigee_instance_attachment.instance
+  location = var.apigee_instance_attachment.location
+  org_id   = var.gcp_project_name
+}
+resource "google_apigee_environment" "apigee_env" {
+  org_id   = var.gcp_project_name
+  name         = var.apigee_instance_attachment.environment
+  description  = var.apigee_instance_attachment.description
+  display_name = var.apigee_instance_attachment.environment
+}
+resource "google_apigee_instance_attachment" "iapigee_instance_attachment" {
+  instance_id  = google_apigee_instance.apigee_instance.id
+  environment  = google_apigee_environment.apigee_env.name
+}
 resource "google_compute_region_network_endpoint_group" "region_network_endpoint_group" {
   name                  = var.region_network_endpoint_group.name
   network_endpoint_type = var.region_network_endpoint_group.network_endpoint_type

test/integration/configuration/mm-attributes.yml

@@ -731,3 +731,12 @@ dataproc_metastore_service:
 dataproc_metastore_federation:
   federation_id: "inspec-federation"
   location: "us-central1"
+
+apigee_instance_attachment:
+  name : "inspec-test-instance-attachment"
+  location: "us-central"
+  instance : "inspec-test-instance"
+  environment: "inspec-test-environment"
+  description: "InSpec Apigee Instances"
+  parent : "organizations/ppradhan"
+  api_proxy_type : "PROGRAMMABLE"

test/integration/verify/controls/google_apigee_organization_instance_attachment.rb

@@ -0,0 +1,40 @@
+# ----------------------------------------------------------------------------
+#
+#     ***     AUTO GENERATED CODE    ***    Type: MMv1     ***
+#
+# ----------------------------------------------------------------------------
+#
+#     This file is automatically generated by Magic Modules and manual
+#     changes will be clobbered when the file is regenerated.
+#
+#     Please read more about how to change this file in README.md and
+#     CONTRIBUTING.md located at the root of this package.
+#
+# ----------------------------------------------------------------------------
+
+title 'Test GCP google_apigee_organization_instance_attachment resource.'
+
+gcp_project_id = input(:gcp_project_id, value: 'gcp_project_id', description: 'The GCP project identifier.')
+
+  organization_instance_attachment = input('organization_instance_attachment', value: {
+  "name": "c4452279-f4dd-473c-b50d-de21bec8147b",
+  "parent": "organizations/ppradhan/instances/us-central1",
+  "environment": "inspec-test-env",
+  "created_at": "1728297911815"
+}, description: 'organization_instance_attachment description')
+control 'google_apigee_organization_instance_attachment-1.0' do
+  impact 1.0
+  title 'google_apigee_organization_instance_attachment resource test'
+
+  describe google_apigee_organization_instance_attachment(name: organization_instance_attachment['name']) do
+  	it { should exist }
+  	its('name') { should cmp organization_instance_attachment['name'] }
+  	its('environment') { should cmp organization_instance_attachment['environment'] }
+  	its('created_at') { should cmp organization_instance_attachment['created_at'] }
+
+  end
+
+  describe google_apigee_organization_instance_attachment(name: "does_not_exit") do
+  	it { should_not exist }
+  end
+end

test/integration/verify/controls/google_apigee_organization_instance_attachments.rb

@@ -0,0 +1,35 @@
+# ----------------------------------------------------------------------------
+#
+#     ***     AUTO GENERATED CODE    ***    Type: MMv1     ***
+#
+# ----------------------------------------------------------------------------
+#
+#     This file is automatically generated by Magic Modules and manual
+#     changes will be clobbered when the file is regenerated.
+#
+#     Please read more about how to change this file in README.md and
+#     CONTRIBUTING.md located at the root of this package.
+#
+# ----------------------------------------------------------------------------
+
+title 'Test GCP google_apigee_organization_instance_attachments resource.'
+
+gcp_project_id = input(:gcp_project_id, value: 'gcp_project_id', description: 'The GCP project identifier.')
+
+  organization_instance_attachment = input('organization_instance_attachment', value: {
+  "name": "c4452279-f4dd-473c-b50d-de21bec8147b",
+  "parent": "organizations/ppradhan/instances/us-central1",
+  "environment": "inspec-test-env",
+  "created_at": "1728297911815"
+}, description: 'organization_instance_attachment description')
+control 'google_apigee_organization_instance_attachments-1.0' do
+  impact 1.0
+  title 'google_apigee_organization_instance_attachments resource test'
+
+    describe google_apigee_organization_instance_attachments(parent: organization_instance_attachment['parent']) do
+      it { should exist }
+      its('name') { should include organization_instance_attachment['name'] }
+      its('environment') { should include organization_instance_attachment['environment'] }
+      its('created_at') { should include organization_instance_attachment['created_at'] }
+    end
+end