kitchen-terraform 5.1.1 → 5.6.0

data/lib/kitchen/terraform/command_flag.rb

@@ -0,0 +1,23 @@
+# 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
+    # CommandFlag is the namespace for command flags.
+    module CommandFlag
+    end
+  end
+end

data/lib/kitchen/terraform/command_flag/backend_config.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 CommandFlag
+      # BackendConfig is the class of objects which control the arguments to the backend configuration.
+      class BackendConfig
+        # #initialize prepares a new instance of the class.
+        #
+        # @param arguments [Hash{String=>String}] the arguments.
+        # @return [Kitchen::Terraform::CommandFlag::BackendConfig]
+        def initialize(arguments:)
+          self.arguments = arguments
+        end
+
+        # @return [String] the backend configuration flag.
+        def to_s
+          arguments.map do |key, value|
+            "-backend-config=\"#{key}=#{value}\""
+          end.join " "
+        end
+
+        private
+
+        attr_accessor :arguments
+      end
+    end
+  end
+end

data/lib/kitchen/terraform/command_flag/color.rb

@@ -0,0 +1,45 @@
+# 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 CommandFlag
+      # Color is the class of objects which control coloured output.
+      class Color
+        # #initialize prepares a new instance of the class.
+        #
+        # @param enabled [Boolean] a toggle to enable or disable color.
+        # @return [Kitchen::Terraform::CommandFlag::Color]
+        def initialize(enabled:)
+          self.enabled = enabled
+        end
+
+        # @return [String] the color flag.
+        def to_s
+          if enabled
+            ""
+          else
+            "-no-color"
+          end
+        end
+
+        private
+
+        attr_accessor :enabled
+      end
+    end
+  end
+end

data/lib/kitchen/terraform/command_flag/lock_timeout.rb

@@ -0,0 +1,42 @@
+# 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 CommandFlag
+      # LockTimeout is the class of objects which control the duration in which to retry the acquisition of the state
+      # lock.
+      class LockTimeout
+        # #initialize prepares a new instance of the class.
+        #
+        # @param duration [Integer] the duration in seconds.
+        # @return [Kitchen::Terraform::CommandFlag::LockTimeout]
+        def initialize(duration:)
+          self.duration = duration
+        end
+
+        # @return [String] the backend configuration flag.
+        def to_s
+          "-lock-timeout=#{duration}s"
+        end
+
+        private
+
+        attr_accessor :duration
+      end
+    end
+  end
+end

data/lib/kitchen/terraform/command_flag/plugin_dir.rb

@@ -0,0 +1,47 @@
+# 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 "shellwords"
+
+module Kitchen
+  module Terraform
+    module CommandFlag
+      # PluginDir is the class of objects which control the location of the directory which contains plugin binaries.
+      class PluginDir
+        # #initialize prepares a new instance of the class.
+        #
+        # @param pathname [String] the pathname of the directory.
+        # @return [Kitchen::Terraform::CommandFlag::PluginDir]
+        def initialize(pathname:)
+          self.pathname = pathname.to_s
+        end
+
+        # @return [String] the plugin directory flag.
+        def to_s
+          if pathname.empty?
+            ""
+          else
+            "-plugin-dir=\"#{::Shellwords.shelljoin ::Shellwords.shellsplit pathname}\""
+          end
+        end
+
+        private
+
+        attr_accessor :pathname
+      end
+    end
+  end
+end

data/lib/kitchen/terraform/command_flag/upgrade.rb

@@ -0,0 +1,45 @@
+# 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 CommandFlag
+      # Upgrade is the class of objects which control the upgrade of existing modules and plugins.
+      class Upgrade
+        # #initialize prepares a new instance of the class.
+        #
+        # @param enabled [Boolean] a toggle to enable or disable the upgrade.
+        # @return [Kitchen::Terraform::CommandFlag::Upgrade]
+        def initialize(enabled:)
+          self.enabled = enabled
+        end
+
+        # @return [String] the upgrade flag.
+        def to_s
+          if enabled
+            "-upgrade"
+          else
+            ""
+          end
+        end
+
+        private
+
+        attr_accessor :enabled
+      end
+    end
+  end
+end

data/lib/kitchen/terraform/command_flag/var.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 CommandFlag
+      # Var is the class of objects which control the configuration variables.
+      class Var
+        # #initialize prepares a new instance of the class.
+        #
+        # @param arguments [Hash{String=>String}] the arguments.
+        # @return [Kitchen::Terraform::CommandFlag::Var]
+        def initialize(arguments:)
+          self.arguments = arguments
+        end
+
+        # @return [String] the backend configuration flag.
+        def to_s
+          arguments.map do |key, value|
+            "-var=\"#{key}=#{value}\""
+          end.join " "
+        end
+
+        private
+
+        attr_accessor :arguments
+      end
+    end
+  end
+end

data/lib/kitchen/terraform/command_flag/var_file.rb

@@ -0,0 +1,45 @@
+# 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 "shellwords"
+
+module Kitchen
+  module Terraform
+    module CommandFlag
+      # VarFile is the class of objects which control the locations of configuration variables files.
+      class VarFile
+        # #initialize prepares a new instance of the class.
+        #
+        # @param pathnames [Array[String]] the pathnames.
+        # @return [Kitchen::Terraform::CommandFlag::VarFile]
+        def initialize(pathnames:)
+          self.pathnames = pathnames
+        end
+
+        # @return [String] the backend configuration flag.
+        def to_s
+          pathnames.map do |path|
+            "-var-file=\"#{::Shellwords.shelljoin ::Shellwords.shellsplit path}\""
+          end.join " "
+        end
+
+        private
+
+        attr_accessor :pathnames
+      end
+    end
+  end
+end

data/lib/kitchen/terraform/config_attribute.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,71 +14,74 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "kitchen/terraform"
 require "kitchen/terraform/config_attribute_cacher"
 require "kitchen/terraform/config_attribute_definer"
 
-# This class applies the behaviour of a configuration attribute to a module which must be included by a plugin class.
-class ::Kitchen::Terraform::ConfigAttribute
-  # This method applies the configuration attribute behaviour to a module.
-  #
-  # @param config_attribute [::Module] a module.
-  # @return [self]
-  def apply(config_attribute:)
-    self.config_attribute = config_attribute
-    define_singleton_included
-    define_singleton_to_sym
-    define_config_attribute_default_value
-    self
-  end
+module Kitchen
+  module Terraform
+    # ConfigAttribute is the class of objects which apply the behaviour of a configuration attribute to a module which must
+    # be included by a plugin class.
+    class ConfigAttribute
+      # #apply applies the configuration attribute behaviour to a module.
+      #
+      # @param config_attribute [Module] a module.
+      # @return [self]
+      def apply(config_attribute:)
+        self.config_attribute = config_attribute
+        define_singleton_included
+        define_singleton_to_sym
+        define_config_attribute_default_value
+
+        self
+      end
 
-  private
+      # #initialize prepares a new instance of the class.
+      #
+      # @param attribute [Symbol] the name of the attribute.
+      # @param default_value [Proc] a block which returns the default value for the attribute.
+      # @param schema [Dry::Validation::Schema] the schema of the attribute.
+      def initialize(attribute:, default_value:, schema:)
+        self.attribute = attribute
+        self.default_value = default_value
+        self.schema = schema
+      end
 
-  attr_accessor(
-    :attribute,
-    :config_attribute,
-    :default_value,
-    :schema
-  )
+      private
 
-  # @api private
-  def define_config_attribute_default_value
-    config_attribute
-      .send(
-        :define_method,
-        "config_#{attribute}_default_value",
-        &default_value
+      attr_accessor(
+        :attribute,
+        :config_attribute,
+        :default_value,
+        :schema
       )
-  end
 
-  # @api private
-  def define_singleton_included
-    local_schema = schema
+      def define_config_attribute_default_value
+        config_attribute
+          .send(
+            :define_method,
+            "config_#{attribute}_default_value",
+            &default_value
+          )
+      end
 
-    config_attribute.define_singleton_method :included do |plugin_class|
-      ::Kitchen::Terraform::ConfigAttributeDefiner
-        .new(
-          attribute: self,
-          schema: local_schema,
-        ).define plugin_class: plugin_class
-    end
-  end
+      def define_singleton_included
+        local_schema = schema
 
-  # @api private
-  def define_singleton_to_sym
-    local_attribute = attribute
+        config_attribute.define_singleton_method :included do |plugin_class|
+          ::Kitchen::Terraform::ConfigAttributeDefiner.new(attribute: self, schema: local_schema).define(
+            plugin_class: plugin_class,
+          )
+        end
+      end
 
-    config_attribute.define_singleton_method :to_sym do
-      local_attribute
-    end
-
-    config_attribute.extend ::Kitchen::Terraform::ConfigAttributeCacher
-  end
+      def define_singleton_to_sym
+        local_attribute = attribute
 
-  # @api private
-  def initialize(attribute:, default_value:, schema:)
-    self.attribute = attribute
-    self.default_value = default_value
-    self.schema = schema
+        config_attribute.define_singleton_method :to_sym do
+          local_attribute
+        end
+        config_attribute.extend ::Kitchen::Terraform::ConfigAttributeCacher
+      end
+    end
   end
 end