Merge pull request #99 from modular-magician/pubsub-addition

Pubsub subscription + topic

.rubocop.yml

@@ -1,5 +1,6 @@
 ---
 AllCops:
+  TargetRubyVersion: 2.4
   Exclude:
   - Gemfile
   - Rakefile

docs/resources/google_pubsub_subscription.md

@@ -0,0 +1,32 @@
+---
+title: About the Subscription resource
+platform: gcp
+---
+
+
+## Syntax
+A `google_pubsub_subscription` is used to test a Google Subscription resource
+
+## Examples
+```
+describe google_pubsub_subscription(project: 'chef-gcp-inspec', name: 'inspec-gcp-subscription') do
+  it { should exist }
+end
+
+describe google_pubsub_subscription(project: 'chef-gcp-inspec', name: 'nonexistent') do
+  it { should_not exist }
+end
+```
+
+## Properties
+Properties that can be accessed from the `google_pubsub_subscription` resource:
+
+  * `name`: Name of the subscription.
+
+  * `topic`: A reference to a Topic resource.
+
+  * `push_config`: If push delivery is used with this subscription, this field is used to configure it. An empty pushConfig signifies that the subscriber will pull and ack messages using API methods.
+
+    * `pushEndpoint`: A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push".
+
+  * `ack_deadline_seconds`: This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis).  For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call subscriptions.modifyAckDeadline with the corresponding ackId if using pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used.  For push delivery, this value is also used to set the request timeout for the call to the push endpoint.  If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message.

docs/resources/google_pubsub_subscriptions.md

@@ -0,0 +1,36 @@
+---
+title: About the Subscription resource
+platform: gcp
+---
+
+
+## Syntax
+A `google_pubsub_subscriptions` is used to test a Google Subscription resource
+
+## Examples
+```
+describe google_pubsub_subscriptions(project: 'chef-gcp-inspec') do
+  it { should exist }
+  its('count') { should eq 1 }
+end
+
+google_pubsub_subscriptions(project: 'chef-gcp-inspec').names.each do |subscription_name|
+  describe google_pubsub_subscription(project: 'chef-gcp-inspec', name: subscription_name) do
+    it { should exist }
+  end
+end
+
+```
+
+## Properties
+Properties that can be accessed from the `google_pubsub_subscriptions` resource:
+
+See [google_pubsub_subscription.md](google_pubsub_subscription.md) for more detailed information
+  * `names`: an array of `google_pubsub_subscription` name
+  * `topics`: an array of `google_pubsub_subscription` topic
+  * `push_configs`: an array of `google_pubsub_subscription` push_config
+  * `ack_deadline_seconds`: an array of `google_pubsub_subscription` ack_deadline_seconds
+
+## 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.

docs/resources/google_pubsub_topic.md

@@ -0,0 +1,24 @@
+---
+title: About the Topic resource
+platform: gcp
+---
+
+
+## Syntax
+A `google_pubsub_topic` is used to test a Google Topic resource
+
+## Examples
+```
+describe google_pubsub_topic(project: 'chef-gcp-inspec', name: 'inspec-gcp-topic') do
+  it { should exist }
+end
+
+describe google_pubsub_topic(project: 'chef-gcp-inspec', name: 'nonexistent') do
+  it { should_not exist }
+end
+```
+
+## Properties
+Properties that can be accessed from the `google_pubsub_topic` resource:
+
+  * `name`: Name of the topic.

docs/resources/google_pubsub_topics.md

@@ -0,0 +1,34 @@
+---
+title: About the Topic resource
+platform: gcp
+---
+
+
+## Syntax
+A `google_pubsub_topics` is used to test a Google Topic resource
+
+## Examples
+```
+describe google_pubsub_topics(project: 'chef-gcp-inspec') do
+  it { should exist }
+  its('names') { should include 'inspec-gcp-topic' }
+  its('count') { should eq 1 }
+end
+
+google_pubsub_topics(project: 'chef-gcp-inspec').names.each do |topic_name|
+  describe google_pubsub_topic(project: 'chef-gcp-inspec', name: topic_name) do
+    its('name') { should eq 'inspec-gcp-topic' }
+  end
+end
+
+```
+
+## Properties
+Properties that can be accessed from the `google_pubsub_topics` resource:
+
+See [google_pubsub_topic.md](google_pubsub_topic.md) for more detailed information
+  * `names`: an array of `google_pubsub_topic` name
+
+## 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.

libraries/gcp_backend.rb

@@ -44,6 +44,10 @@ def create_resource_methods(object)
     dm = GcpResourceDynamicMethods.new
     dm.create_methods(self, object)
   end
+
+  def name_from_self_link(property)
+    property&.split('/')&.last
+  end
 end
 # end
 
@@ -193,7 +197,7 @@ def initialize
   def fetch_auth
     unless @service_account_file.nil?
       return Network::Authorization.new.for!(
-        ['https://www.googleapis.com/auth/compute.readonly'],
+        ['https://www.googleapis.com/auth/compute.readonly', 'https://www.googleapis.com/auth/pubsub'],
       ).from_service_account_json!(
         @service_account_file,
       )

libraries/google/pubsub/property/subscription_push_config.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: false
+
+# ----------------------------------------------------------------------------
+#
+#     ***     AUTO GENERATED CODE    ***    AUTO GENERATED CODE     ***
+#
+# ----------------------------------------------------------------------------
+#
+#     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.
+#
+# ----------------------------------------------------------------------------
+module GoogleInSpec
+  module Pubsub
+    module Property
+      class SubscriptionPushconfig
+        attr_reader :push_endpoint
+
+        def initialize(args = nil)
+          return if args.nil?
+          @push_endpoint = args['pushEndpoint']
+        end
+      end
+    end
+  end
+end

libraries/google_pubsub_subscription.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: false
+
+# ----------------------------------------------------------------------------
+#
+#     ***     AUTO GENERATED CODE    ***    AUTO GENERATED CODE     ***
+#
+# ----------------------------------------------------------------------------
+#
+#     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'
+require 'google/pubsub/property/subscription_push_config'
+
+# A provider to manage Google Cloud Pub/Sub resources.
+class Subscription < GcpResourceBase
+  name 'google_pubsub_subscription'
+  desc 'Subscription'
+  supports platform: 'gcp'
+
+  attr_reader :name
+  attr_reader :topic
+  attr_reader :push_config
+  attr_reader :ack_deadline_seconds
+  def base
+    'https://pubsub.googleapis.com/v1/'
+  end
+
+  def url
+    'projects/{{project}}/subscriptions/{{name}}'
+  end
+
+  def initialize(params)
+    super(params.merge({ use_http_transport: true }))
+    @fetched = @connection.fetch(base, url, params)
+    parse unless @fetched.nil?
+  end
+
+  def parse
+    @name = name_from_self_link(@fetched['name'])
+    @topic = @fetched['topic']
+    @push_config = GoogleInSpec::Pubsub::Property::SubscriptionPushconfig.new(@fetched['pushConfig'])
+    @ack_deadline_seconds = @fetched['ackDeadlineSeconds']
+  end
+
+  # Handles parsing RFC3339 time string
+  def parse_time_string(time_string)
+    time_string ? Time.parse(time_string) : nil
+  end
+
+  def exists?
+    !@fetched.nil?
+  end
+end

libraries/google_pubsub_subscriptions.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: false
+
+# ----------------------------------------------------------------------------
+#
+#     ***     AUTO GENERATED CODE    ***    AUTO GENERATED CODE     ***
+#
+# ----------------------------------------------------------------------------
+#
+#     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 Subscriptions < GcpResourceBase
+  name 'google_pubsub_subscriptions'
+  desc 'Subscription plural resource'
+  supports platform: 'gcp'
+
+  attr_reader :table
+
+  filter_table_config = FilterTable.create
+
+  filter_table_config.add(:names, field: :name)
+  filter_table_config.add(:topics, field: :topic)
+  filter_table_config.add(:push_configs, field: :pushConfig)
+  filter_table_config.add(:ack_deadline_seconds, field: :ackDeadlineSeconds)
+
+  filter_table_config.connect(self, :table)
+
+  def base
+    'https://pubsub.googleapis.com/v1/'
+  end
+
+  def url
+    'projects/{{project}}/subscriptions'
+  end
+
+  def initialize(params = {})
+    super(params.merge({ use_http_transport: true }))
+    @params = params
+    @table = fetch_wrapped_resource('subscriptions')
+  end
+
+  def fetch_wrapped_resource(wrap_path)
+    # fetch_resource returns an array of responses (to handle pagination)
+    result = @connection.fetch_all(base, url, @params)
+    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_pair { |k, v| hash_with_symbols[k.to_sym] = v }
+        hash_with_symbols[:name] = name_from_self_link(hash_with_symbols[:name])
+        converted.push(hash_with_symbols)
+      end
+    end
+
+    converted
+  end
+end

libraries/google_pubsub_topic.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: false
+
+# ----------------------------------------------------------------------------
+#
+#     ***     AUTO GENERATED CODE    ***    AUTO GENERATED CODE     ***
+#
+# ----------------------------------------------------------------------------
+#
+#     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 Google Cloud Pub/Sub resources.
+class Topic < GcpResourceBase
+  name 'google_pubsub_topic'
+  desc 'Topic'
+  supports platform: 'gcp'
+
+  attr_reader :name
+  def base
+    'https://pubsub.googleapis.com/v1/'
+  end
+
+  def url
+    'projects/{{project}}/topics/{{name}}'
+  end
+
+  def initialize(params)
+    super(params.merge({ use_http_transport: true }))
+    @fetched = @connection.fetch(base, url, params)
+    parse unless @fetched.nil?
+  end
+
+  def parse
+    @name = name_from_self_link(@fetched['name'])
+  end
+
+  # Handles parsing RFC3339 time string
+  def parse_time_string(time_string)
+    time_string ? Time.parse(time_string) : nil
+  end
+
+  def exists?
+    !@fetched.nil?
+  end
+end