kitchen-terraform 5.1.1 → 5.6.0

data/lib/kitchen/terraform/command/init.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+# Copyright 2016-2019 New Context, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require "kitchen/terraform/command_flag/backend_config"
+require "kitchen/terraform/command_flag/color"
+require "kitchen/terraform/command_flag/lock_timeout"
+require "kitchen/terraform/command_flag/plugin_dir"
+require "kitchen/terraform/command_flag/upgrade"
+
+module Kitchen
+  module Terraform
+    module Command
+      # The working directory is initialized by running a command like the following example:
+      #   terraform init \
+      #     -input=false \
+      #     -lock=<lock> \
+      #     -lock-timeout=<lock_timeout>s \
+      #     [-no-color] \
+      #     [-upgrade] \
+      #     -force-copy \
+      #     -backend=true \
+      #     [-backend-config=<backend_configurations[0]> ...] \
+      #     -get=true \
+      #     -get-plugins=true \
+      #     [-plugin-dir=<plugin_directory>] \
+      #     -verify-plugins=true \
+      #     <root_module_directory>
+      class Init
+        # #initialize prepares a new instance of the class.
+        #
+        # @param config [Hash] the configuration of the driver.
+        # @option config [Hash{String=>String}] :backend_configurations Terraform backend configuration arguments to
+        #   complete a partial backend configuration.
+        # @option config [Boolean] :color a toggle of colored output from the Terraform client.
+        # @option config [Integer] :command_timeout the the number of seconds to wait for the command to finish running.
+        # @option config [Boolean] :lock a toggle of locking for the Terraform state file.
+        # @option config [Integer] :lock_timeout the number of seconds that the Terraform client will wait for a lock
+        #   on the state to be obtained during operations.
+        # @option config [String] :plugin_directory the pathname of the directory which contains
+        #   customized Terraform provider plugins to install in place of the official Terraform provider plugins.
+        # @option config [String] :root_module_directory the pathname of the directory which contains the root
+        #   Terraform module.
+        # @option config [Boolean] :upgrade_during_init a toggle for upgrading modules and plugins.
+        # @return [Kitchen::Terraform::Command::Init]
+        def initialize(config:)
+          self.backend_config = ::Kitchen::Terraform::CommandFlag::BackendConfig.new arguments: config.fetch(
+            :backend_configurations
+          )
+          self.color = ::Kitchen::Terraform::CommandFlag::Color.new enabled: config.fetch(:color)
+          self.lock = config.fetch :lock
+          self.lock_timeout = ::Kitchen::Terraform::CommandFlag::LockTimeout.new duration: config.fetch(:lock_timeout)
+          self.plugin_dir = ::Kitchen::Terraform::CommandFlag::PluginDir.new pathname: config.fetch(
+            :plugin_directory
+          )
+          self.upgrade = ::Kitchen::Terraform::CommandFlag::Upgrade.new enabled: config.fetch(:upgrade_during_init)
+        end
+
+        # @return [String] the command with flags.
+        def to_s
+          "init " \
+          "-input=false " \
+          "-lock=#{lock} " \
+          "#{lock_timeout} " \
+          "#{color} " \
+          "#{upgrade} " \
+          "-force-copy " \
+          "-backend=true " \
+          "#{backend_config} " \
+          "-get=true " \
+          "-get-plugins=true " \
+          "#{plugin_dir} " \
+          "-verify-plugins=true"
+        end
+
+        private
+
+        attr_accessor(
+          :backend_config,
+          :color,
+          :lock,
+          :lock_timeout,
+          :options,
+          :plugin_dir,
+          :upgrade,
+        )
+      end
+    end
+  end
+end

data/lib/kitchen/terraform/command/output.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016 New Context Services, Inc.
+# Copyright 2016-2019 New Context, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -14,55 +14,16 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "json"
-require "kitchen"
-require "kitchen/terraform/command"
-require "kitchen/terraform/error"
-require "kitchen/terraform/shell_out"
-
-# Behaviour to run the `terraform output` command.
-module ::Kitchen::Terraform::Command::Output
-  class << self
-    # Runs the command with JSON foramtting.
-    #
-    # @option options [::String] :cwd the directory in which to run the command.
-    # @option options [::Kitchen::Logger] :live_stream a Test Kitchen logger to capture the output from running the
-    #   command.
-    # @option options [::Integer] :timeout the maximum duration in seconds to run the command.
-    # @param client [::String] the pathname of the Terraform client.
-    # @param options [::Hash] options which adjust the execution of the command.
-    # @yieldparam output [::Hash] the standard output of the command parsed as JSON.
-    def run(client:, options:, &block)
-      run_shell_out client: client, options: options, &block
-    rescue ::JSON::ParserError => error
-      handle_json_parser error: error
-    rescue ::Kitchen::Terraform::Error => error
-      handle_kitchen_terraform(
-        error: error,
-        &block
-      )
-    end
-
-    private
-
-    # @api private
-    def handle_json_parser(error:)
-      raise(
-        ::Kitchen::Terraform::Error,
-        "Parsing Terraform output as JSON failed: #{error.message}"
-      )
-    end
-
-    # @api private
-    def handle_kitchen_terraform(error:)
-      /no\\ outputs\\ defined/.match ::Regexp.escape error.to_s or raise error
-      yield outputs: {}
-    end
-
-    # @api private
-    def run_shell_out(client:, options:)
-      ::Kitchen::Terraform::ShellOut.run client: client, command: "output -json", options: options do |standard_output:|
-        yield outputs: ::Kitchen::Util.stringified_hash(::JSON.parse(standard_output))
+module Kitchen
+  module Terraform
+    module Command
+      # The outputs are retrieved by running a command like the following example:
+      #   terraform output -json
+      class Output
+        # @return [String] the command with flags.
+        def to_s
+          "output -json"
+        end
       end
     end
   end

data/lib/kitchen/terraform/command/validate.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+# Copyright 2016-2019 New Context, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require "kitchen/terraform/command_flag/color"
+require "kitchen/terraform/command_flag/var_file"
+require "kitchen/terraform/command_flag/var"
+require "shellwords"
+
+module Kitchen
+  module Terraform
+    module Command
+      # The root module is validated by running a command like the following example:
+      #   terraform validate \
+      #     [-no-color] \
+      #     [-var=<variables.first>...] \
+      #     [-var-file=<variable_files.first>...] \
+      #     <directory>
+      class Validate
+        # #initialize prepares a new instance of the class.
+        #
+        # @param config [Hash] the configuration of the driver.
+        # @option config [Boolean] :color a toggle of colored output from the Terraform client.
+        # @option config [Array<String>] :variable_files a list of pathnames of Terraform variable files to evaluate.
+        # @option config [Hash{String=>String}] :variables a mapping of Terraform variables to evaluate.
+        # @return [Kitchen::Terraform::Command::Validate]
+        def initialize(config:)
+          self.color = ::Kitchen::Terraform::CommandFlag::Color.new enabled: config.fetch(:color)
+          self.var_file = ::Kitchen::Terraform::CommandFlag::VarFile.new pathnames: config.fetch(:variable_files)
+          self.var = ::Kitchen::Terraform::CommandFlag::Var.new arguments: config.fetch(:variables)
+        end
+
+        # @return [String] the command with flags.
+        def to_s
+          "validate " \
+          "#{color} " \
+          "#{var} " \
+          "#{var_file}"
+        end
+
+        private
+
+        attr_accessor(
+          :color,
+          :var_file,
+          :var,
+        )
+      end
+    end
+  end
+end

data/lib/kitchen/terraform/command/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2016 New Context Services, Inc.
+# Copyright 2016-2019 New Context, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -14,51 +14,14 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "kitchen"
-require "kitchen/terraform/error"
-require "rubygems"
-
 module Kitchen
   module Terraform
     module Command
       # Version is the class of objects which represent the <tt>terraform version</tt> command.
-      class Version < ::Gem::Version
-        extend ::Kitchen::Logging
-        extend ::Kitchen::ShellOut
-
-        class << self
-          # The command is run by shelling out in an environment which is optimized for automating Terraform.
-          #
-          # @raise [::Kitchen::Terraform::Error] if the result of running the command is a failure.
-          # @return [::Kitchen::Terraform::Command::Version] an instance initialized with the output of the command.
-          # @yieldparam version [::Kitchen::Terraform::Command::Version] an instance initialized with the output of the
-          #   command.
-          def run
-            new(
-              run_command(
-                "terraform version",
-                environment: {
-                  "LC_ALL" => nil,
-                  "TF_IN_AUTOMATION" => "true",
-                  "TF_WARN_OUTPUT_ERRORS" => "true",
-                },
-              )
-            ).tap do |version|
-              yield version: version
-            end
-          rescue ::Kitchen::ShellOut::ShellCommandFailed, ::Kitchen::Error => error
-            raise ::Kitchen::Terraform::Error, error.message
-          end
-
-          def logger
-            ::Kitchen.logger
-          end
-        end
-
-        private
-
-        def initialize(version)
-          super version.slice(/Terraform v(\d+\.\d+\.\d+)/, 1)
+      class Version
+        # @return [String] the command.
+        def to_s
+          "version"
         end
       end
     end

data/lib/kitchen/terraform/command/workspace_delete.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# Copyright 2016-2019 New Context, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Kitchen
+  module Terraform
+    module Command
+      # The workspace is deleted by running a command like the following example:
+      #   terraform workspace delete <name>
+      class WorkspaceDelete
+        # @param config [Hash] the configuration of the driver.
+        # @option config [String] :workspace_name the name of the Terraform workspace.
+        # @return [Kitchen::Terraform::Command::WorkspaceDelete]
+        def initialize(config:)
+          self.workspace_name = config.fetch :workspace_name
+        end
+
+        # @return [String] the command.
+        def to_s
+          "workspace delete #{workspace_name}"
+        end
+
+        private
+
+        attr_accessor :workspace_name
+      end
+    end
+  end
+end

data/lib/kitchen/terraform/command/workspace_new.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# Copyright 2016-2019 New Context, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Kitchen
+  module Terraform
+    module Command
+      # The workspace is created by running a command like the following example:
+      #   terraform workspace new <name>
+      class WorkspaceNew
+        # #initialize prepares a new instance of the class.
+        #
+        # @param config [Hash] the configuration of the driver.
+        # @option config [String] :workspace_name the name of the Terraform workspace.
+        # @return [Kitchen::Terraform::Command::WorkspaceNew]
+        def initialize(config:)
+          self.workspace_name = config.fetch :workspace_name
+        end
+
+        # @return [String] the command.
+        def to_s
+          "workspace new #{workspace_name}"
+        end
+
+        private
+
+        attr_accessor :workspace_name
+      end
+    end
+  end
+end

data/lib/kitchen/terraform/command/workspace_select.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# Copyright 2016-2019 New Context, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Kitchen
+  module Terraform
+    module Command
+      # The workspace is selected by running a command like the following example:
+      #   terraform workspace select <name>
+      class WorkspaceSelect
+        # #initialize prepares a new instance of the class.
+        #
+        # @param config [Hash] the configuration of the driver.
+        # @option config [String] :workspace_name the name of the Terraform workspace.
+        # @return [Kitchen::Terraform::Command::WorkspaceSelect]
+        def initialize(config:)
+          self.workspace_name = config.fetch :workspace_name
+        end
+
+        # @return [String] the command.
+        def to_s
+          "workspace select #{workspace_name}"
+        end
+
+        private
+
+        attr_accessor :workspace_name
+      end
+    end
+  end
+end

data/lib/kitchen/terraform/command_executor.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+# Copyright 2016-2019 New Context, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require "kitchen"
+require "kitchen/terraform/shell_out"
+
+module Kitchen
+  module Terraform
+    # CommandExecutor is the class of objects which execute Terraform CLI commands.
+    class CommandExecutor
+      # #initialize prepares a new instance of the class.
+      #
+      # @param client [String] the pathname of the Terraform client.
+      # @param logger [Kitchen::Logger] a logger for logging messages.
+      # @return [Kitchen::Terraform::CommandExecutor]
+      def initialize(client:, logger:)
+        self.client = client
+        self.logger = logger
+      end
+
+      # #run executes a client command.
+      #
+      # @param command [String] the command to run.
+      # @param options [Hash] options which adjust the execution of the command.
+      # @option options [Integer] :timeout the maximum duration in seconds to run the command.
+      # @option options [String] :cwd the directory in which to run the command.
+      # @yieldparam standard_output [String] the standard output of the command.
+      # @raise [Kitchen::TransientFailure] if running the command results in failure.
+      # @return [self]
+      def run(command:, options:)
+        ::Kitchen::Terraform::ShellOut.new(
+          command: "#{client} #{command}",
+          logger: logger,
+          options: options,
+        ).run do |standard_output:|
+          yield standard_output: standard_output
+        end
+
+        self
+      end
+
+      private
+
+      attr_accessor :client, :logger
+    end
+  end
+end