ruby-terraform 0.65.0.pre.15 → 1.0.0.pre.1

data/lib/ruby_terraform/commands.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require_relative 'commands/apply'
-require_relative 'commands/clean'
 require_relative 'commands/destroy'
 require_relative 'commands/force_unlock'
 require_relative 'commands/format'
@@ -18,7 +17,6 @@ require_relative 'commands/providers_lock'
 require_relative 'commands/providers_mirror'
 require_relative 'commands/providers_schema'
 require_relative 'commands/refresh'
-require_relative 'commands/remote_config'
 require_relative 'commands/show'
 require_relative 'commands/state_list'
 require_relative 'commands/state_move'

data/lib/ruby_terraform/commands/apply.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'base'
-require_relative '../options/common'
+require_relative '../options/global'
 
 module RubyTerraform
   module Commands
@@ -19,10 +19,10 @@ module RubyTerraform
     # When executing an instance of {Apply} via {#execute}, the following
     # options are supported:
     #
-    # * +:directory+: the directory containing terraform configuration;
-    #   required unless +:plan+ is provided.
-    # * +:plan+: the path to a pre-computed plan to be applied;
-    #   required unless +:directory+ is provided.
+    # * +:directory+: the path to a directory containing terraform
+    #   configuration (deprecated in terraform 0.14, removed in terraform 0.15,
+    #   use +:chdir+ instead).
+    # * +:plan+: the path to a pre-computed plan to be applied.
     # * +:chdir+: the path of a working directory to switch to before executing
     #   the given subcommand.
     # * +:auto_approve+: if +true+, skips interactive approval of the generated
@@ -71,7 +71,7 @@ module RubyTerraform
     #     })
     #
     class Apply < Base
-      include RubyTerraform::Options::Common
+      include RubyTerraform::Options::Global
 
       # @!visibility private
       def subcommands
@@ -83,12 +83,12 @@ module RubyTerraform
       # @!visibility private
       def options
         %w[
+          -auto-approve
           -backup
           -compact-warnings
           -lock
           -lock-timeout
           -input
-          -auto-approve
           -no-color
           -parallelism
           -refresh

data/lib/ruby_terraform/commands/base.rb

@@ -24,6 +24,9 @@ module RubyTerraform
 
       # Executes the command instance.
       #
+      # @param [Hash<String, Object>] parameters The parameters used to
+      #   invoke the command. See subclass documentation for details of
+      #   supported options.
       def execute(parameters = {})
         do_before(parameters)
         build_and_execute_command(parameters)
@@ -68,7 +71,7 @@ module RubyTerraform
           .with_option_separator('=')
           .with_appliables(@options.resolve(options, parameters))
           .with_subcommands(subcommands)
-          .with_arguments(arguments(parameters)).build
+          .with_arguments(arguments(parameters).compact.flatten).build
       end
 
       def resolve_parameters(parameters)

data/lib/ruby_terraform/commands/destroy.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'base'
-require_relative '../options/common'
+require_relative '../options/global'
 
 module RubyTerraform
   module Commands
@@ -13,8 +13,9 @@ module RubyTerraform
     # When executing an instance of {Destroy} via {#execute}, the following
     # options are supported:
     #
-    # * +:directory+: the directory containing terraform configuration;
-    #   required.
+    # * +:directory+: the path to a directory containing terraform
+    #   configuration (deprecated in terraform 0.14, removed in terraform 0.15,
+    #   use +:chdir+ instead).
     # * +:chdir+: the path of a working directory to switch to before executing
     #   the given subcommand.
     # * +:auto_approve+: if +true+, skips interactive approval before
@@ -63,7 +64,7 @@ module RubyTerraform
     #     })
     #
     class Destroy < Base
-      include RubyTerraform::Options::Common
+      include RubyTerraform::Options::Global
 
       # @!visibility private
       def subcommands
@@ -75,12 +76,12 @@ module RubyTerraform
       # @!visibility private
       def options
         %w[
+          -auto-approve
           -backup
           -compact-warnings
           -lock
           -lock-timeout
           -input
-          -auto-approve
           -no-color
           -parallelism
           -refresh

data/lib/ruby_terraform/commands/force_unlock.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'base'
-require_relative '../options/common'
+require_relative '../options/global'
 
 module RubyTerraform
   module Commands
@@ -20,6 +20,9 @@ module RubyTerraform
     #
     # * +:lock_id+: the lock ID output when attempting an operation that failed
     #   due to a lock; required.
+    # * +:directory+: the path to a directory containing terraform
+    #   configuration (deprecated in terraform 0.14, removed in terraform 0.15,
+    #   use +:chdir+ instead).
     # * +:chdir+: the path of a working directory to switch to before executing
     #   the given subcommand.
     # * +:force+: If +true+, does not ask for input for unlock confirmation;
@@ -30,7 +33,7 @@ module RubyTerraform
     #     lock_id: '50e844a7-ebb0-fcfd-da85-5cce5bd1ec90')
     #
     class ForceUnlock < Base
-      include RubyTerraform::Options::Common
+      include RubyTerraform::Options::Global
 
       # @!visibility private
       def subcommands
@@ -43,9 +46,8 @@ module RubyTerraform
       end
 
       # @!visibility private
-      # @todo Add directory option.
       def arguments(parameters)
-        [parameters[:lock_id]]
+        [parameters[:lock_id], parameters[:directory]]
       end
     end
   end

data/lib/ruby_terraform/commands/format.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'base'
-require_relative '../options/common'
+require_relative '../options/global'
 
 module RubyTerraform
   module Commands
@@ -21,7 +21,9 @@ module RubyTerraform
     # When executing an instance of {Format} via {#execute}, the following
     # options are supported:
     #
-    # * +:directory+: the directory containing terraform configuration.
+    # * +:directory+: the path to a directory containing terraform
+    #   configuration (deprecated in terraform 0.14, removed in terraform 0.15,
+    #   use +:chdir+ instead).
     # * +:chdir+: the path of a working directory to switch to before executing
     #   the given subcommand.
     # * +:list+: If +true+, lists files whose formatting differs; defaults to
@@ -33,6 +35,8 @@ module RubyTerraform
     # * +:check+: If +true+, checks if the input is formatted; if any input is
     #   not properly formatted, an {RubyTerraform::Errors::ExecutionError} will
     #   be thrown; defaults to +false+.
+    # * +:no_color+: whether or not the output from the command should be in
+    #   color; defaults to +false+.
     # * +:recursive+: If +true+, also processes files in subdirectories;
     #   defaults to +false+ such that only the provided +:directory+ is
     #   processed.
@@ -41,7 +45,7 @@ module RubyTerraform
     #   RubyTerraform::Commands::Format.new.execute(
     #     directory: 'infra/networking')
     class Format < Base
-      include RubyTerraform::Options::Common
+      include RubyTerraform::Options::Global
 
       # @!visibility private
       def subcommands
@@ -49,13 +53,13 @@ module RubyTerraform
       end
 
       # @!visibility private
-      # @todo Add no_color option.
       def options
         %w[
           -list
           -write
           -diff
           -check
+          -no-color
           -recursive
         ] + super
       end

data/lib/ruby_terraform/commands/get.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'base'
-require_relative '../options/common'
+require_relative '../options/global'
 
 module RubyTerraform
   module Commands
@@ -21,8 +21,9 @@ module RubyTerraform
     # When executing an instance of {Get} via {#execute}, the following options
     # are supported:
     #
-    # * +:directory+: the directory containing terraform configuration;
-    #   required.
+    # * +:directory+: the path to a directory containing terraform
+    #   configuration (deprecated in terraform 0.14, removed in terraform 0.15,
+    #   use +:chdir+ instead).
     # * +:chdir+: the path of a working directory to switch to before executing
     #   the given subcommand.
     # * +:update+: if +true+, checks already-downloaded modules for available
@@ -33,8 +34,9 @@ module RubyTerraform
     # @example Basic Invocation
     #   RubyTerraform::Commands::Get.new.execute(
     #     directory: 'infra/networking')
+    #
     class Get < Base
-      include RubyTerraform::Options::Common
+      include RubyTerraform::Options::Global
 
       # @!visibility private
       def subcommands

data/lib/ruby_terraform/commands/graph.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'base'
-require_relative '../options/common'
+require_relative '../options/global'
 
 module RubyTerraform
   module Commands
@@ -24,6 +24,9 @@ module RubyTerraform
     # When executing an instance of {Graph} via {#execute}, the following
     # options are supported:
     #
+    # * +:directory+: the path to a directory containing terraform
+    #   configuration (deprecated in terraform 0.14, removed in terraform 0.15,
+    #   use +:chdir+ instead).
     # * +:chdir+: the path of a working directory to switch to before executing
     #   the given subcommand.
     # * +:plan+: render the graph using the specified plan file instead of the
@@ -41,7 +44,7 @@ module RubyTerraform
     #   RubyTerraform::Commands::Graph.new.execute
     #
     class Graph < Base
-      include RubyTerraform::Options::Common
+      include RubyTerraform::Options::Global
 
       # @!visibility private
       def subcommands
@@ -49,14 +52,19 @@ module RubyTerraform
       end
 
       # @!visibility private
-      # @todo Add plan option.
       def options
         %w[
+          -plan
           -draw-cycles
           -type
           -module-depth
         ] + super
       end
+
+      # @!visibility private
+      def arguments(parameters)
+        [parameters[:directory]]
+      end
     end
   end
 end

data/lib/ruby_terraform/commands/import.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'base'
-require_relative '../options/common'
+require_relative '../options/global'
 
 module RubyTerraform
   module Commands
@@ -36,10 +36,9 @@ module RubyTerraform
     # When executing an instance of {Import} via {#execute}, the following
     # options are supported:
     #
-    # * +:directory+: the path to a directory of terraform configuration files
-    #   to use to configure the provider; defaults to the current directory; if
-    #   no config files are present, they must be provided via the input prompts
-    #   or env vars.
+    # * +:directory+: the path to a directory containing terraform configuration
+    #   (deprecated in terraform 0.14, removed in terraform 0.15, use +:chdir+
+    #   instead).
     # * +:address+: the address to import the resource to; required.
     # * +:id+: the resource-specific ID identifying the resource being imported;
     #   required.
@@ -48,6 +47,8 @@ module RubyTerraform
     # * +:backup+: (legacy) the path to backup the existing state file before
     #   modifying; defaults to the +:state_out+ path with +".backup"+ extension;
     #   set +:no_backup+ to +true+ to skip backups entirely.
+    # * +:allow_missing_config+: whether or not to allow import when no resource
+    #   configuration block exists; defaults to +false+.
     # * +:input+: when +false+, will not ask for input for variables not
     #   directly set; defaults to +true+.
     # * +:lock+: when +true+, locks the state file when locking is supported;
@@ -90,7 +91,7 @@ module RubyTerraform
     #     })
     #
     class Import < Base
-      include RubyTerraform::Options::Common
+      include RubyTerraform::Options::Global
 
       # @!visibility private
       def subcommands
@@ -100,10 +101,10 @@ module RubyTerraform
       # rubocop:disable Metrics/MethodLength
 
       # @!visibility private
-      # @todo Add allow_missing_config option.
       def options
         %w[
           -config
+          -allow-missing-config
           -backup
           -input
           -lock

data/lib/ruby_terraform/commands/init.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'base'
-require_relative '../options/common'
+require_relative '../options/global'
 
 module RubyTerraform
   module Commands
@@ -24,7 +24,9 @@ module RubyTerraform
     # When executing an instance of {Init} via {#execute}, the following
     # options are supported:
     #
-    # * +:path+: the path to initialize; defaults to the current directory.
+    # * +:path+: the path to initialize; defaults to the current directory
+    #   (deprecated in terraform 0.14, removed in terraform 0.15, use +:chdir+
+    #   instead).
     # * +:chdir+: the path of a working directory to switch to before executing
     #   the given subcommand.
     # * +:backend+: whether or not to configure the backend for this
@@ -51,7 +53,14 @@ module RubyTerraform
     #   color; defaults to +false+.
     # * +:plugin_dir+: the path to a directory containing plugin binaries; this
     #   overrides all default search paths for plugins, and prevents the
-    #   automatic installation of plugins.
+    #   automatic installation of plugins; if both +:plugin_dir+ and
+    #   +:plugin_dirs+ are provided, all plugin directories will be passed to
+    #   Terraform.
+    # * +:plugin_dirs+: an array of paths to directories containing plugin
+    #   binaries; this overrides all default search paths for plugins, and
+    #   prevents the automatic installation of plugins; if both +:plugin_dir+
+    #   and +:plugin_dirs+ are provided, all plugin directories will be passed
+    #   to Terraform.
     # * +:reconfigure+: if +true+, reconfigures the backend, ignoring any saved
     #   configuration; defaults to +false+.
     # * +:upgrade+: if +true+, when installing modules or plugins, ignores
@@ -60,6 +69,8 @@ module RubyTerraform
     # * +:verify_plugins+: whether or not to verify plugins for this
     #   configuration; defaults to +true+ (deprecated, removed in terraform
     #   0.15).
+    # * +:lockfile+: sets a dependency lockfile mode; currently only "readonly"
+    #   is valid.
     #
     # @example Basic Invocation
     #   RubyTerraform::Commands::Init.new.execute(
@@ -67,7 +78,7 @@ module RubyTerraform
     #     path: 'infra/module')
     #
     class Init < Base
-      include RubyTerraform::Options::Common
+      include RubyTerraform::Options::Global
 
       # @!visibility private
       def subcommands
@@ -77,8 +88,6 @@ module RubyTerraform
       # rubocop:disable Metrics/MethodLength
 
       # @!visibility private
-      # @todo Add lockfile option.
-      # @todo Make plugin_dir option plural
       def options
         %w[
           -backend
@@ -95,6 +104,7 @@ module RubyTerraform
           -reconfigure
           -upgrade
           -verify-plugins
+          -lockfile
         ] + super
       end
 

data/lib/ruby_terraform/commands/login.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'base'
-require_relative '../options/common'
+require_relative '../options/global'
 
 module RubyTerraform
   module Commands
@@ -28,7 +28,7 @@ module RubyTerraform
     #   RubyTerraform::Commands::Login.new.execute
     #
     class Login < Base
-      include RubyTerraform::Options::Common
+      include RubyTerraform::Options::Global
 
       # @!visibility private
       def subcommands

data/lib/ruby_terraform/commands/logout.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'base'
-require_relative '../options/common'
+require_relative '../options/global'
 
 module RubyTerraform
   module Commands
@@ -25,7 +25,7 @@ module RubyTerraform
     #   RubyTerraform::Commands::Logout.new.execute
     #
     class Logout < Base
-      include RubyTerraform::Options::Common
+      include RubyTerraform::Options::Global
 
       # @!visibility private
       def subcommands