inspec-cloudformation 0.0.1 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0bac1eaa6b1118ac6bb8066a77210d81199502aa46c8c6d0a66280f098fd0fca
-  data.tar.gz: 93fb485ae89f6c423a3dc815b1acd5a892e8d9849487d5ba562526b0b421cad9
+  metadata.gz: 84d84c23a0a26abdbb5043ef7d209f0ca47021be1d83c4713e68a380f1750937
+  data.tar.gz: bf790958e6ff825b7e88f18137466b88dcbb5acdfe561b1ac9efa7eb5d089bd5
 SHA512:
-  metadata.gz: af62285f8c803d4e32303a271469412ecd78f28d6534a1e198d721ab264bf13b8da5130755dd14e54440b9e47bbcc25211e9796930e2a120ddd568d00dc882c0
-  data.tar.gz: 2b3692f7fbd654e8de573e58a8708dbbaade5e43658aefad4aeea1bcb0bb5bbab30e6673e0f16c7c53f11e65c519cea3edebbb775a68ef86c764460ff712939b
+  metadata.gz: 3be38104a21d39f805b88a6c1e76e68ec323720bcfcddc7ad8c2559919c878d34d6582deb1268426891d83c92235d13e78758b1a56f99d908edb742aff063443
+  data.tar.gz: b6a097f49229b9c574f7a2c81e4cf540408c2f3e908a4756f86782637214f350170305340fa40a93c6e4bd964348d8e7732b324725d7269a7b7ee07f14cf41d9

data/Gemfile

@@ -2,10 +2,9 @@ source "https://rubygems.org"
 
 gemspec
 
-# gem "inspec-bin"
 gem 'rake-release'
-
-
+gem 'gem-release'
+gem 'rubygems-update'
 
 group :development do
   gem "chefstyle", "2.2.0"

data/README.md

@@ -1 +1,10 @@
 # inspec-cloudformation
+
+
+## Release Process
+
+- make your changes
+- `git ca`
+- `gem tag`
+- `gem release`
+- `gem bump`

data/inspec-cloudformation.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.name          = "inspec-cloudformation"
 
   # It is polite to namespace your plugin under InspecPlugins::YourPluginInCamelCase
-  spec.version       = InspecPlugins::Vault::VERSION
+  spec.version       = InspecPlugins::CloudFormation::VERSION
   spec.authors       = ["Andy Boutte"]
   spec.email         = ["andyboutte@gmail.com"]
   spec.summary       = "Use CloudFormation Outputs in your InSpec profiles"

data/lib/inspec-cloudformation/input.rb

@@ -1,28 +1,16 @@
 require 'aws-sdk-cloudformation'
 
-
-
-
-
-
-
-
-
-
 # See https://github.com/inspec/inspec/blob/master/docs/dev/plugins.md#implementing-input-plugins
 
-module InspecPlugins::Vault
+module InspecPlugins::CloudFormation
   class Input < Inspec.plugin(2, :input)
 
-    VALID_PATTERNS = [
-      Regexp.new("^databag://[^/]+/[^/]+/.+$"),
-      Regexp.new("^node://[^/]*/attributes/.+$"),
-    ].freeze
+    # VALID_PATTERNS = [
+    #   Regexp.new("^databag://[^/]+/[^/]+/.+$"),
+    #   Regexp.new("^node://[^/]*/attributes/.+$"),
+    # ].freeze
 
     attr_reader :plugin_conf
-    # attr_reader :mount_point
-    # attr_reader :path_prefix
-    # attr_reader :vault
     attr_reader :priority
     attr_reader :input_name
     attr_reader :logger
@@ -39,10 +27,7 @@ module InspecPlugins::Vault
       # We need priority to be numeric; even though env vars or JSON may present it as string - hence the to_i
       @priority = fetch_plugin_setting("priority", 60).to_i
 
-      # @vault = Vault::Client.new(
-      #   address: fetch_vault_setting("vault_addr"),
-      #   token: fetch_vault_setting("vault_token")
-      # )
+
     end
 
     # What priority should an input value recieve from us?
@@ -52,33 +37,20 @@ module InspecPlugins::Vault
     def default_priority
       priority
     end
-
-    # returns Array of input names as strings
-    # def list_inputs(profile_name)
-    #   vault.with_retries(Vault::HTTPConnectionError) do
-    #     path = logical_path_for_profile(profile_name)
-    #     doc = vault.logical.read(path)
-    #     return [] unless doc
-
-    #     return doc.data[:data].keys.map(&:to_s)
-    #   end
-    # end
-
-    # Fetch a value of a single input from Vault
     
     def fetch(profile_name, input_name)
+      # skip any input name that is an invalid cloudformation stack name to keep things quick...no need to make the AWS API call.
       return nil if input_name.include?('_')
-
-
-      cf = Aws::CloudFormation::Client.new
+      return nil unless input_name.include?('/')
 
       # input format will be "cloudformation stack name / output name"
-
       stack_name = input_name.split('/').first
       output_name = input_name.split('/').last
 
-      logger.info format("The stack name is  %s", stack_name)
-      logger.info format("The output name is  %s", output_name)
+      logger.debug format("The stack name is  %s", stack_name)
+      logger.debug format("The output name is  %s", output_name)
+
+      cf = Aws::CloudFormation::Client.new
 
       name = { stack_name: stack_name }
       resp = cf.describe_stacks(name)
@@ -88,69 +60,21 @@ module InspecPlugins::Vault
           next unless output['output_key'] == output_name
           return output['output_value']
       end
-      
-      # stacks.each do |stack|
-      #     next if input(stack).nil? # If HRA addon was skipped we expect the input to be skipped also
-          
-      # end
-
-
-
-      # @input_name = input_name
 
-      # path = logical_path_for_profile(profile_name)
-      # item = input_name
-
-      # if absolute_path?
-      #   _empty, *path, item = input_name.split("/")
-      #   path = logical_path path.join("/")
-      # end
-
-      # logger.info format("Reading Vault secret from %s", path)
-      # vault.with_retries(Vault::HTTPConnectionError) do
-      #   doc = vault.logical.read(path)
-      #   # Keys from vault are always symbolized
-      #   return doc.data[:data][item.to_sym] if doc
-      # end
+      # if no CloudFormation output found
+      return nil
     end
 
     private
 
-    # # Assumption for profile based lookups: inputs have been stored on documents named
-    # # for their profiles, and each input has a key-value pair in the document.
-    # def logical_path_for_profile(profile_name)
-    #   logical_path(profile_name)
+    # def valid_plugin_input?(input)
+    #   VALID_PATTERNS.any? { |regex| regex.match? input }
     # end
 
-    # def logical_path(relative_path)
-    #   # When you actually read a value, on the KV2 backend you must
-    #   # read secret/data/path, not secret/path (as on the CLI)
-    #   # https://www.vaultproject.io/api/secret/kv/kv-v2.html#read-secret-version
-    #   # Is this true for all backends?
-    #   "#{mount_point}/data/#{prefix}#{relative_path}"
+    # def fetch_plugin_setting(setting_name, default = nil)
+    #   env_var_name = "INSPEC_CLOUDFORMATION_#{setting_name.upcase}"
+    #   ENV[env_var_name] || plugin_conf[setting_name] || default
     # end
 
-    # def prefix
-    #   return "#{path_prefix}/" unless absolute_path?
-
-    #   ""
-    # end
-
-    # def absolute_path?
-    #   input_name.start_with?("/")
-    # end
-
-    def valid_plugin_input?(input)
-      VALID_PATTERNS.any? { |regex| regex.match? input }
-    end
-
-    def fetch_plugin_setting(setting_name, default = nil)
-      env_var_name = "INSPEC_CLOUDFORMATION_#{setting_name.upcase}"
-      ENV[env_var_name] || plugin_conf[setting_name] || default
-    end
-
-    # def fetch_vault_setting(setting_name)
-    #   ENV[setting_name.upcase] || plugin_conf[setting_name]
-    # end
   end
 end

data/lib/inspec-cloudformation/plugin.rb

@@ -9,15 +9,15 @@
 # Presumably this is light
 require "inspec-cloudformation/version"
 module InspecPlugins
-  module Vault
+  module CloudFormation
     class Plugin < ::Inspec.plugin(2)
       # Internal machine name of the plugin. InSpec will use this in errors, etc.
       plugin_name :'inspec-cloudformation'
 
       # Define an Input plugin type.
-      input :vault do
+      input :cloudformation do
         require_relative "input"
-        InspecPlugins::Vault::Input
+        InspecPlugins::CloudFormation::Input
       end
 
     end

data/lib/inspec-cloudformation/version.rb

@@ -2,7 +2,7 @@
 # the version stamp, and provide a clean way for the gemspec
 # to learn the current version.
 module InspecPlugins
-  module Vault
-    VERSION = "0.0.1".freeze
+  module CloudFormation
+    VERSION = "0.0.4".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inspec-cloudformation
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.4
 platform: ruby
 authors:
 - Andy Boutte
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-01 00:00:00.000000000 Z
+date: 2022-07-05 00:00:00.000000000 Z
 dependencies: []
 description: This plugin allows InSpec 'inputs' to be provided by CloudFormation Outputs.
 email: