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

data/Rakefile

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'yaml'
+require 'yard'
 require 'rake_circle_ci'
 require 'rake_github'
 require 'rake_ssh'
@@ -46,6 +47,11 @@ end
 
 RuboCop::RakeTask.new
 
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb']
+  t.options = ['--embed-mixins', '--output-dir', 'docs']
+end
+
 namespace :library do
   desc 'Run all checks of the library'
   task check: [:rubocop]
@@ -54,6 +60,25 @@ namespace :library do
   task fix: [:'rubocop:auto_correct']
 end
 
+namespace :documentation do
+  desc 'Generate documentation'
+  task generate: [:yard]
+
+  desc 'Commit documentation'
+  task :commit, [:skip] do |_, args|
+    args.with_defaults(skip: 'true')
+
+    skip_ci = args.skip == 'true'
+
+    sh('git', 'commit',
+       '-a',
+       '-m', "Generate latest documentation#{skip_ci ? ' [ci skip]' : ''}")
+  end
+
+  desc 'Update documentation'
+  task update: %i[generate commit]
+end
+
 namespace :test do
   RSpec::Core::RakeTask.new(:unit)
 end

data/lib/ruby_terraform.rb

@@ -23,6 +23,8 @@ module RubyTerraform
     end
   end
 
+  # rubocop:disable Metrics/ModuleLength
+
   module ClassMethods
     # Invokes the +terraform apply+ command which creates or updates
     # infrastructure according to terraform configuration files in the provided
@@ -34,10 +36,11 @@ module RubyTerraform
     # actions described in that plan without any confirmation prompt.
     #
     # @param parameters The parameters used to invoke the command
-    # @option parameters [String] :directory The directory containing terraform
-    #   configuration; required unless +:plan+ is provided.
+    # @option parameters [String] :directory The path to a directory containing
+    #   terraform configuration (deprecated in terraform 0.14, removed in
+    #   terraform 0.15, use +:chdir+ instead).
     # @option parameters [String] :plan The path to a pre-computed plan to be
-    #   applied; required unless +:directory+ is provided.
+    #   applied.
     # @option parameters [String] :chdir The path of a working directory to
     #   switch to before executing the given subcommand.
     # @option parameters [Boolean] :auto_approve (false) If +true+, skips
@@ -101,8 +104,9 @@ module RubyTerraform
     # infrastructure.
     #
     # @param parameters The parameters used to invoke the command
-    # @option parameters [String] :directory The directory containing terraform
-    #   configuration; required.
+    # @option parameters [String] :directory The path to a directory containing
+    #   terraform configuration (deprecated in terraform 0.14, removed in
+    #   terraform 0.15, use +:chdir+ instead).
     # @option parameters [String] :chdir The path of a working directory to
     #   switch to before executing the given subcommand.
     # @option parameters [Boolean] :auto_approve (false) If +true+, skips
@@ -174,6 +178,9 @@ module RubyTerraform
     # @param parameters The parameters used to invoke the command
     # @option parameters [String] :lock_id The lock ID output when attempting an
     #   operation that failed due to a lock; required.
+    # @option parameters [String] :directory The path to a directory containing
+    #   terraform configuration (deprecated in terraform 0.14, removed in
+    #   terraform 0.15, use +:chdir+ instead).
     # @option parameters [String] :chdir The path of a working directory to
     #   switch to before executing the given subcommand.
     # @option parameters [Boolean] :force (false) If +true+, does not ask for
@@ -199,8 +206,9 @@ module RubyTerraform
     # terraform language native syntax; JSON is not supported.
     #
     # @param parameters The parameters used to invoke the command
-    # @option parameters [String] :directory The directory containing terraform
-    #   configuration.
+    # @option parameters [String] :directory The path to a directory containing
+    #   terraform configuration (deprecated in terraform 0.14, removed in
+    #   terraform 0.15, use +:chdir+ instead).
     # @option parameters [String] :chdir The path of a working directory to
     #   switch to before executing the given subcommand.
     # @option parameters [Boolean] :list (false) If +true+, lists files whose
@@ -212,6 +220,8 @@ module RubyTerraform
     # @option parameters [Boolean] :check (false) If +true+, checks if the input
     #   is formatted; if any input is not properly formatted, an
     #   {RubyTerraform::Errors::ExecutionError} will be thrown.
+    # @option parameters [Boolean] :no_color (false) Whether or not the output
+    #   from the command should be in color.
     # @option parameters [Boolean] :recursive (false) If +true+, also processes
     #   files in subdirectories; by default, only the provided +:directory+ is
     #   processed.
@@ -223,6 +233,7 @@ module RubyTerraform
     def format(parameters = {})
       exec(RubyTerraform::Commands::Format, parameters)
     end
+    alias fmt format
 
     # Invokes the +terraform get+ command which downloads and installs modules
     # needed for the given configuration.
@@ -236,8 +247,9 @@ module RubyTerraform
     # separately.
     #
     # @param parameters The parameters used to invoke the command
-    # @option parameters [String] :directory The directory containing terraform
-    #   configuration; required.
+    # @option parameters [String] :directory The path to a directory containing
+    #   terraform configuration (deprecated in terraform 0.14, removed in
+    #   terraform 0.15, use +:chdir+ instead).
     # @option parameters [String] :chdir The path of a working directory to
     #   switch to before executing the given subcommand.
     # @option parameters [Boolean] :update (false) If +true+, checks
@@ -269,6 +281,9 @@ module RubyTerraform
     # passed as an argument.
     #
     # @param parameters The parameters used to invoke the command
+    # @option parameters [String] :directory The path to a directory containing
+    #   terraform configuration (deprecated in terraform 0.14, removed in
+    #   terraform 0.15, use +:chdir+ instead).
     # @option parameters [String] :chdir The path of a working directory to
     #   switch to before executing the given subcommand.
     # @option parameters [String] :plan Render the graph using the specified
@@ -317,10 +332,9 @@ module RubyTerraform
     # being imported.
     #
     # @param parameters The parameters used to invoke the command
-    # @option parameters [String] :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.
+    # @option parameters [String] :directory The path to a directory containing
+    #   terraform configuration (deprecated in terraform 0.14, removed in
+    #   terraform 0.15, use +:chdir+ instead).
     # @option parameters [String] :address The address to import the resource
     #   to; required.
     # @option parameters [String] :id The resource-specific ID identifying the
@@ -331,6 +345,8 @@ module RubyTerraform
     #   file before modifying; defaults to the +:state_out+ path with
     #   +".backup"+ extension; set +:no_backup+ to +true+ to skip backups
     #   entirely (legacy).
+    # @option parameters [Boolean] :allow_missing_config (false) Whether or not
+    #   to allow import when no resource configuration block exists.
     # @option parameters [Boolean] :input (true) When +false+, will not ask for
     #   input for variables not directly set.
     # @option parameters [Boolean] :lock (true) When +true+, locks the state
@@ -397,7 +413,8 @@ module RubyTerraform
     #
     # @param parameters The parameters used to invoke the command
     # @option parameters [String] :path The path to initialize; defaults to the
-    #   current directory.
+    #   current directory (deprecated in terraform 0.14, removed in terraform
+    #   0.15, use +:chdir+ instead).
     # @option parameters [String] :chdir The path of a working directory to
     #   switch to before executing the given subcommand.
     # @option parameters [Boolean] :backend (true) Whether or not to configure
@@ -424,7 +441,14 @@ module RubyTerraform
     #   from the command should be in color.
     # @option parameters [String] :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.
+    #   and prevents the automatic installation of plugins; if both
+    #   +:plugin_dir+ and +:plugin_dirs+ are provided, all plugin directories
+    #   will be passed to Terraform.
+    # @option parameters [Array<String>] :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.
     # @option parameters [Boolean] :reconfigure (false) If +true+, reconfigures
     #   the backend, ignoring any saved configuration.
     # @option parameters [Boolean] :upgrade (false) If +true+, when installing
@@ -433,6 +457,8 @@ module RubyTerraform
     # @option parameters [Boolean] :verify_plugins (true) Whether or not to
     #   verify plugins for this configuration (deprecated, removed in terraform
     #   0.15).
+    # @option parameters [String] :lockfile Sets a dependency lockfile mode;
+    #   currently only "readonly" is valid.
     #
     # @example Basic Invocation
     #   RubyTerraform.init(
@@ -520,8 +546,9 @@ module RubyTerraform
     # the {#apply} command to perform exactly the actions described in the plan.
     #
     # @param parameters The parameters used to invoke the command
-    # @option parameters [String] :plan The path to output the plan if it should
-    #   be saved to a file.
+    # @option parameters [String] :plan The path to a directory containing
+    #   terraform configuration (deprecated in terraform 0.14, removed in
+    #   terraform 0.15, use +:chdir+ instead).
     # @option parameters [String] :chdir The path of a working directory to
     #   switch to before executing the given subcommand.
     # @option parameters [Boolean] :compact_warnings (false) When +true+, if
@@ -587,6 +614,9 @@ module RubyTerraform
     # plugins are needed and why particular versions are selected.
     #
     # @param parameters The parameters used to invoke the command
+    # @option parameters [String] :directory The path to a directory containing
+    #   terraform configuration (deprecated in terraform 0.14, removed in
+    #   terraform 0.15, use +:chdir+ instead).
     # @option parameters [String] :chdir The path of a working directory to
     #   switch to before executing the given subcommand.
     #
@@ -619,6 +649,13 @@ module RubyTerraform
     # more provider source addresses on the command line.
     #
     # @param parameters The parameters used to invoke the command
+    # @option parameters [String] :provider The provider source address for
+    #   which the lock file should be updated; if both +:provider+ and
+    #   +:providers+ are provided, all providers will be passed to Terraform.
+    # @option parameters [Array<String>] :providers An array of provider source
+    #   addresses for which the lock file should be updated; if both +:provider+
+    #   and +:providers+ are provided, all providers will be passed to
+    #   Terraform.
     # @option parameters [String] :providers The provider source addresses for
     #   which the lock file should be updated.
     # @option parameters [String] :chdir The path of a working directory to
@@ -654,7 +691,7 @@ module RubyTerraform
     #   RubyTerraform.providers_lock(
     #     fs_mirror: "/usr/local/terraform/providers",
     #     platforms: ["windows_amd64", "darwin_amd64", "linux_amd64"],
-    #     providers: "tf.example.com/ourcompany/ourplatform")
+    #     provider: "tf.example.com/ourcompany/ourplatform")
     #
     def providers_lock(parameters = {})
       exec(RubyTerraform::Commands::ProvidersLock, parameters)
@@ -693,7 +730,7 @@ module RubyTerraform
     #   to Terraform.
     #
     # @example Basic Invocation
-    #   RubyTerraform.platforms_mirror(
+    #   RubyTerraform.providers_mirror(
     #     directory: './plugins',
     #     platforms: ["windows_amd64", "darwin_amd64", "linux_amd64"])
     #
@@ -701,34 +738,654 @@ module RubyTerraform
       exec(RubyTerraform::Commands::ProvidersMirror, parameters)
     end
 
-    {
-      clean: RubyTerraform::Commands::Clean,
-      providers_schema: RubyTerraform::Commands::ProvidersSchema,
-      refresh: RubyTerraform::Commands::Refresh,
-      remote_config: RubyTerraform::Commands::RemoteConfig,
-      show: RubyTerraform::Commands::Show,
-      state_list: RubyTerraform::Commands::StateList,
-      state_mv: RubyTerraform::Commands::StateMove,
-      state_pull: RubyTerraform::Commands::StatePull,
-      state_push: RubyTerraform::Commands::StatePush,
-      state_replace_provider: RubyTerraform::Commands::StateReplaceProvider,
-      state_rm: RubyTerraform::Commands::StateRemove,
-      state_show: RubyTerraform::Commands::StateShow,
-      taint: RubyTerraform::Commands::Taint,
-      untaint: RubyTerraform::Commands::Untaint,
-      validate: RubyTerraform::Commands::Validate,
-      workspace_list: RubyTerraform::Commands::WorkspaceList,
-      workspace_select: RubyTerraform::Commands::WorkspaceSelect,
-      workspace_new: RubyTerraform::Commands::WorkspaceNew,
-      workspace_delete: RubyTerraform::Commands::WorkspaceDelete,
-      workspace_show: RubyTerraform::Commands::WorkspaceShow
-    }.each do |method, command_class|
-      define_method(method) do |parameters = {}|
-        exec(command_class, parameters)
-      end
+    # Invokes the +terraform providers schema+ command which prints out a json
+    # representation of the schemas for all providers used in the current
+    # configuration.
+    #
+    # @param parameters The parameters used to invoke the command
+    # @option parameters [String] :chdir The path of a working directory to
+    #   switch to before executing the given subcommand.
+    #
+    # @example Basic Invocation
+    #   RubyTerraform.providers_schema(
+    #     directory: 'infra/networking')
+    #
+    def providers_schema(parameters = {})
+      exec(RubyTerraform::Commands::ProvidersSchema, parameters)
+    end
+
+    # Invokes the +terraform refresh+ command which updates the state file of
+    # your infrastructure with metadata that matches the physical resources they
+    # are tracking.
+    #
+    # This will not modify your infrastructure, but it can modify your state
+    # file to update metadata. This metadata might cause new changes to occur
+    # when you generate a plan or call apply next.
+    #
+    # @param parameters The parameters used to invoke the command
+    # @option parameters [String] :directory The path to a directory containing
+    #   terraform configuration (deprecated in terraform 0.14, removed in
+    #   terraform 0.15, use +:chdir+ instead).
+    # @option parameters [String] :chdir The path of a working directory to
+    #   switch to before executing the given subcommand.
+    # @option parameters [String] :backup 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 (legacy).
+    # @option parameters [Boolean] :compact_warnings (false) When +true+, if
+    #   terraform produces any warnings that are not accompanied by errors,
+    #   they are shown in a more compact form that includes only the summary
+    #   messages.
+    # @option parameters [Boolean] :input (true) When +false+, will not ask for
+    #   input for variables not directly set.
+    # @option parameters [Boolean] :lock (true) When +true+, locks the state
+    #   file when locking is supported; when +false+, does not lock the state
+    #   file.
+    # @option parameters [String] :lock_timeout ("0s") The duration to retry a
+    #   state lock.
+    # @option parameters [Boolean] :no_backup (false) When +true+, no backup
+    #   file will be written (legacy).
+    # @option parameters [Boolean] :no_color (false) Whether or not the output
+    #   from the command should be in color.
+    # @option parameters [Integer] :parallelism (10) The number of parallel
+    #   resource operations.
+    # @option parameters [Boolean] :refresh (true) When +true+, updates state
+    #   prior to checking for differences; when +false+ uses locally available
+    #   state; this has no effect when +:plan+ is provided.
+    # @option parameters [String] :state ("terraform.tfstate") The path to the
+    #   state file from which to read state and in which to store state (unless
+    #   +:state_out+ is specified) (legacy).
+    # @option parameters [String] :state_out The path to write state to that is
+    #   different than +:state+; this can be used to preserve the old state
+    #   (legacy).
+    # @option parameters [String] :target The address of a resource to target;
+    #   if both +:target+ and +:targets+ are provided, all targets will be
+    #   passed to terraform.
+    # @option parameters [Array<String>] :targets An array of resource addresses
+    #   to target; if both +:target+ and +:targets+ are provided, all targets
+    #   will be passed to terraform.
+    # @option parameters [Hash<String, Object>] :vars A map of variables to be
+    #   passed to the terraform configuration.
+    # @option parameters [String] :var_file The path to a terraform var file;
+    #   if both +:var_file+ and +:var_files+ are provided, all var files will be
+    #   passed to terraform.
+    # @option parameters [Array<String>] :var_files An array of paths to
+    #   terraform var files; if both +:var_file+ and +:var_files+ are provided,
+    #   all var files will be passed to terraform.
+    #
+    # @example Basic Invocation
+    #   RubyTerraform.refresh(
+    #     directory: 'infra/networking',
+    #     vars: {
+    #       region: 'eu-central'
+    #     })
+    #
+    def refresh(parameters = {})
+      exec(RubyTerraform::Commands::Refresh, parameters)
+    end
+
+    # Invokes the +terraform show+ command which reads and outputs a Terraform
+    # state or plan file in a human-readable form. If no path is specified, the
+    # current state will be shown.
+    #
+    # @param parameters The parameters used to invoke the command
+    # @option parameters [String] :path The path to a state file or plan to
+    #   show.
+    # @option parameters [String] :chdir The path of a working directory to
+    #   switch to before executing the given subcommand.
+    # @option parameters [Boolean] :no_color (false) Whether or not the output
+    #   from the command should be in color.
+    # @option parameters [Boolean] :json (false) If +true+, outputs the
+    #   Terraform plan or state in a machine-readable form.
+    #
+    # @example Basic Invocation
+    #   RubyTerraform.show
+    #
+    def show(parameters = {})
+      exec(RubyTerraform::Commands::Show, parameters)
+    end
+
+    # Invokes the +terraform state list+ command which lists resources in the
+    # Terraform state.
+    #
+    # This command lists resource instances in the Terraform state. The address
+    # option can be used to filter the instances by resource or module. If no
+    # pattern is given, all resource instances are listed.
+    #
+    # The addresses must either be module addresses or absolute resource
+    # addresses, such as:
+    #
+    # * +aws_instance.example+
+    # * +module.example+
+    # * +module.example.module.child+
+    # * +module.example.aws_instance.example+
+    #
+    # An {RubyTerraform::Errors::ExecutionError} will be raised if any of the
+    # resources or modules given as filter addresses do not exist in the state.
+    #
+    # @param parameters The parameters used to invoke the command
+    # @option parameters [String] :address The module address or absolute
+    #   resource address to filter by; if both +:address+ and +:addresses+ are
+    #   provided, all addresses will be passed to Terraform.
+    # @option parameters [Array<String>] :addresses An array of module addresses
+    #   or absolute resource addresses to filter by; if both +:address+ and
+    #   +:addresses+ are provided, all addresses will be passed to Terraform.
+    # @option parameters [String] :chdir The path of a working directory to
+    #   switch to before executing the given subcommand.
+    # @option parameters [String] :state The path to a Terraform state file to
+    #   use to look up Terraform-managed resources; by default, Terraform will
+    #   consult the state of the currently-selected workspace.
+    # @option parameters [String] :id When provided, filters the results to
+    #   include only instances whose resource types have an attribute named "id"
+    #   whose value equals the given id string.
+    #
+    # @example Basic Invocation
+    #   RubyTerraform.state_list
+    #
+    def state_list(parameters = {})
+      exec(RubyTerraform::Commands::StateList, parameters)
+    end
+
+    # Invokes the +terraform state mv+ command which moves an item in the state.
+    #
+    # This command will move an item matched by the address given to the
+    # destination address. This command can also move to a destination address
+    # in a completely different state file.
+    #
+    # This can be used for simple resource renaming, moving items to and from
+    # a module, moving entire modules, and more. And because this command can
+    # also move data to a completely new state, it can also be used for
+    # refactoring one configuration into multiple separately managed Terraform
+    # configurations.
+    #
+    # This command will output a backup copy of the state prior to saving any
+    # changes. The backup cannot be disabled. Due to the destructive nature
+    # of this command, backups are required.
+    #
+    # If you're moving an item to a different state file, a backup will be
+    # created for each state file.
+    #
+    # @param parameters The parameters used to invoke the command
+    # @option parameters [String] :source The source address of the item to
+    #   move; required.
+    # @option parameters [String] :destination The destination address to move
+    #   the item to; required.
+    # @option parameters [String] :chdir The path of a working directory to
+    #   switch to before executing the given subcommand.
+    # @option parameters [Boolean] :dry_run (false) When +true+, prints out what
+    #   would've been moved but doesn't actually move anything.
+    # @option parameters [String] :backup The path where Terraform should write
+    #   the backup for the original state; this can't be disabled; if not set,
+    #   Terraform will write it to the same path as the state file with a
+    #   +".backup"+ extension.
+    # @option parameters [String] :backup_out The path where Terraform should
+    #   write the backup for the destination state; this can't be disabled; if
+    #   not set, Terraform will write it to the same path as the destination
+    #   state file with a +".backup"+ extension; this only needs to be specified
+    #   if +:state_out+ is set to a different path than +:state+.
+    # @option parameters [Boolean] :lock (true) When +true+, locks the state
+    #   file when locking is supported; when +false+, does not lock the state
+    #   file.
+    # @option parameters [String] :lock_timeout ("0s") The duration to retry a
+    #   state lock.
+    # @option parameters [String] :state the path to the source state file;
+    #   defaults to the configured backend, or +"terraform.tfstate"+.
+    # @option parameters [String] :state_out The path to the destination state
+    #   file to write to; if this isn't specified, the source state file will be
+    #   used; this can be a new or existing path.
+    # @option parameters [Boolean] :ignore_remote_version (false) Whether or not
+    #   to continue even if remote and local Terraform versions are
+    #   incompatible; this may result in an unusable workspace, and should be
+    #   used with extreme caution.
+    #
+    # @example Basic Invocation
+    #   RubyTerraform.state_move(
+    #     source: 'packet_device.worker',
+    #     destination: 'packet_device.helper')
+    #
+    def state_move(parameters = {})
+      exec(RubyTerraform::Commands::StateMove, parameters)
+    end
+    alias state_mv state_move
+
+    # Invokes the +terraform state pull+ command which pulls the state from its
+    # location, upgrades the local copy, and outputs it to stdout.
+    #
+    # This command "pulls" the current state and outputs it to stdout. As part
+    # of this process, Terraform will upgrade the state format of the local copy
+    # to the current version.
+    #
+    # The primary use of this is for state stored remotely. This command will
+    # still work with local state but is less useful for this.
+    #
+    # @param parameters The parameters used to invoke the command
+    # @option parameters [String] :chdir The path of a working directory to
+    #   switch to before executing the given subcommand.
+    #
+    # @example Basic Invocation
+    #   RubyTerraform.state_pull
+    #
+    def state_pull(parameters = {})
+      exec(RubyTerraform::Commands::StatePull, parameters)
+    end
+
+    # Invokes the +terraform state push+ command which updates remote state from
+    # a local state file.
+    #
+    # This command "pushes" a local state and overwrites remote state with a
+    # local state file. The command will protect you against writing
+    # an older serial or a different state file lineage unless you pass +true+
+    # for the +:force+ option.
+    #
+    # This command works with local state (it will overwrite the local state),
+    # but is less useful for this use case.
+    #
+    # If +:path+ is +"-"+, then this command will read the state to push from
+    # stdin. Data from stdin is not streamed to the backend: it is loaded
+    # completely (until pipe close), verified, and then pushed.
+    #
+    # @param parameters The parameters used to invoke the command
+    # @option parameters [String] :path The path to the state file to push; when
+    #   passed +"-"+ will read state from standard input.
+    # @option parameters [String] :chdir The path of a working directory to
+    #   switch to before executing the given subcommand.
+    # @option parameters [Boolean] :force (false) When +true+, writes the state
+    #   even if lineages don't match or the remote serial is higher.
+    # @option parameters [Boolean] :lock (true) When +true+, locks the state
+    #   file when locking is supported; when +false+, does not lock the state
+    #   file.
+    # @option parameters [String] :lock_timeout ("0s") The duration to retry a
+    #   state lock.
+    # @option parameters [Boolean] :ignore_remote_version Whether or not to
+    #   continue even if remote and local Terraform versions are incompatible;
+    #   this may result in an unusable workspace, and should be used with
+    #   extreme caution.
+    #
+    # @example Basic Invocation
+    #   RubyTerraform.state_push(
+    #     path: 'some/statefile.tfstate')
+    #
+    def state_push(parameters = {})
+      exec(RubyTerraform::Commands::StatePush, parameters)
+    end
+
+    # Invokes the +terraform state rm+ command which removes one or more items
+    # from the Terraform state, causing Terraform to "forget" those items
+    # without first destroying them in the remote system.
+    #
+    # This command removes one or more resource instances from the Terraform
+    # state based on the addresses given. You can view and list the available
+    # instances with {#state_list}.
+    #
+    # If you give the address of an entire module then all of the instances in
+    # that module and any of its child modules will be removed from the state.
+    #
+    # If you give the address of a resource that has "count" or "for_each" set,
+    # all of the instances of that resource will be removed from the state.
+    #
+    # @param parameters The parameters used to invoke the command
+    # @option parameters [String] :address The module address or absolute
+    #   resource address of the resource instance to remove; required unless
+    #   +:addresses+ is supplied; if both +:address+ and +:addresses+ are
+    #   provided, all addresses will be passed to Terraform.
+    # @option parameters [Array<String>] :addresses An array of module addresses
+    #   or absolute resource addresses of the resource instances to remove;
+    #   required unless +:address+ is supplied; if both +:address+ and
+    #   +:addresses+ are provided, all addresses will be passed to Terraform.
+    # @option parameters [String] :chdir The path of a working directory to
+    #   switch to before executing the given subcommand.
+    # @option parameters [Boolean] :dry+run (false) When +true+, prints out what
+    #   would've been removed but doesn't actually remove anything.
+    # @option parameters [String] :backup The path where Terraform should
+    #   write the backup state.
+    # @option parameters [Boolean] :lock (true) When +true+, locks the state
+    #   file when locking is supported; when +false+, does not lock the state
+    #   file.
+    # @option parameters [String] :lock_timeout ("0s") The duration to retry a
+    #   state lock.
+    # @option parameters [String] :state The path to the state file to update;
+    #   defaults to the current workspace state.
+    # @option parameters [Boolean] :ignore_remote_version (false) Whether or not
+    #   to continue even if remote and local Terraform versions are
+    #   incompatible; this may result in an unusable workspace, and should be
+    #   used with extreme caution.
+    #
+    # @example Basic Invocation
+    #   RubyTerraform.state_remove(
+    #     address: 'packet_device.worker')
+    #
+    def state_remove(parameters = {})
+      exec(RubyTerraform::Commands::StateRemove, parameters)
+    end
+    alias state_rm state_remove
+
+    # Invoke the +terraform state replace-provider+ command which replaces
+    # provider for resources in the Terraform state.
+    #
+    # @param parameters The parameters used to invoke the command
+    # @option parameters [String] :from The fully qualified name of the provider
+    #   to be replaced; required.
+    # @option parameters [String] :to The fully qualified name of the provider
+    #   to replace with; required.
+    # @option parameters [String] :chdir The path of a working directory to
+    #   switch to before executing the given subcommand.
+    # @option parameters [Boolean] :auto_approve (false) If +true+, skips
+    #   interactive approval.
+    # @option parameters [String] :backup The path where Terraform should write
+    #   the backup for the state file; this can't be disabled; if not set,
+    # 	Terraform will write it to the same path as the state file with a
+    # 	".backup" extension.
+    # @option parameters [Boolean] :lock (true) When +true+, locks the state
+    #   file when locking is supported; when +false+, does not lock the state
+    #   file.
+    # @option parameters [String] :lock_timeout ("0s") The duration to retry a
+    #   state lock.
+    # @option parameters [String] :state The path to the state file to update;
+    #   defaults to the current workspace state.
+    # @option parameters [Boolean] :ignore_remote_version (false) Whether or not
+    #   to continue even if remote and local Terraform versions are
+    #   incompatible; this may result in an unusable workspace, and should be
+    #   used with extreme caution.
+    #
+    # @example Basic Invocation
+    #   RubyTerraform.state_replace_provider(
+    #     from: 'hashicorp/aws',
+    #     to: 'registry.acme.corp/acme/aws')
+    #
+    def state_replace_provider(parameters = {})
+      exec(RubyTerraform::Commands::StateReplaceProvider, parameters)
+    end
+
+    # Invokes the +terraform state show+ command which shows the attributes of a
+    # resource in the Terraform state.
+    #
+    # This command shows the attributes of a single resource in the Terraform
+    # state. The +:address+ argument must be used to specify a single resource.
+    # You can view the list of available resources with {#state_list}.
+    #
+    # @param parameters The parameters used to invoke the command
+    # @option parameters [String] :address The module address or absolute
+    #   resource address of the resource instance to show; required.
+    # @option parameters [String] :chdir The path of a working directory to
+    #   switch to before executing the given subcommand.
+    #
+    # @example Basic Invocation
+    #   RubyTerraform.state_show(
+    #     address: 'packet_device.worker')
+    #
+    def state_show(parameters = {})
+      exec(RubyTerraform::Commands::StateShow, parameters)
+    end
+
+    # Invokes the +terraform taint+ command which marks a resource instance as
+    # not fully functional.
+    #
+    # Terraform uses the term "tainted" to describe a resource instance which
+    # may not be fully functional, either because its creation partially failed
+    # or because you've manually marked it as such using this command.
+    #
+    # This will not modify your infrastructure directly, but subsequent
+    # Terraform plans will include actions to destroy the remote object and
+    # create a new object to replace it.
+    #
+    # You can remove the "taint" state from a resource instance using the
+    # {#untaint} command.
+    #
+    # The address is in the usual resource address syntax, such as:
+    #
+    # * +aws_instance.foo+
+    # * <tt>aws_instance.bar[1]</tt>
+    # * +module.foo.module.bar.aws_instance.baz+
+    #
+    # Use your shell's quoting or escaping syntax to ensure that the address
+    # will reach Terraform correctly, without any special interpretation.
+    #
+    # @param parameters The parameters used to invoke the command
+    # @option parameters [String] :address The module address or absolute
+    #   resource address of the resource instance to taint; required.
+    # @option parameters [String] :chdir The path of a working directory to
+    #   switch to before executing the given subcommand.
+    # @option parameters [Boolean] :allow_missing (false) If +true+, the command
+    #   will succeed (i.e., will not throw an
+    #   {RubyTerraform::Errors::ExecutionError}) even if the resource is
+    #   missing.
+    # @option parameters [String] :backup 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.
+    # @option parameters [Boolean] :lock (true) When +true+, locks the state
+    #   file when locking is supported; when +false+, does not lock the state
+    #   file.
+    # @option parameters [String] :lock_timeout ("0s") The duration to retry a
+    #   state lock.
+    # @option parameters [Boolean] :no_backup (false) When +true+, no backup
+    #   file will be written.
+    # @option parameters [String] :state The path to the state file from which
+    #   to read state and in which to store state (unless +:state_out+ is
+    #   specified); defaults to +"terraform.tfstate"+.
+    # @option parameters [String] :state_out The path to write state to that is
+    #   different than +:state+; this can be used to preserve the old state.
+    # @option parameters [Boolean] :ignore_remote_version (false) Whether or not
+    #   to continue even if remote and local Terraform versions are
+    #   incompatible; this may result in an unusable workspace, and should be
+    #   used with extreme caution.
+    #
+    # @example Basic Invocation
+    #   RubyTerraform.taint(
+    #     address: 'aws_security_group.allow_all')
+    #
+    def taint(parameters = {})
+      exec(RubyTerraform::Commands::Taint, parameters)
     end
 
-    def workspace(parameters = {}) # rubocop:disable Metrics/MethodLength
+    # Invokes the +terraform untaint+ command which removes the 'tainted' state
+    # from a resource instance.
+    #
+    # Terraform uses the term "tainted" to describe a resource instance
+    # which may not be fully functional, either because its creation partially
+    # failed or because you've manually marked it as such using the {#taint}
+    # command.
+    #
+    # This command removes that state from a resource instance, causing
+    # Terraform to see it as fully-functional and not in need of replacement.
+    #
+    # This will not modify your infrastructure directly. It only avoids
+    # Terraform planning to replace a tainted instance in a future operation.
+    #
+    # @param parameters The parameters used to invoke the command
+    # @option parameters [String] :name The name of the resource instance to
+    #   untaint; required.
+    # @option parameters [String] :chdir The path of a working directory to
+    #   switch to before executing the given subcommand.
+    # @option parameters [Boolean] :allow_missing (false) If +true+, the command
+    #   will succeed (i.e., will not throw an
+    #   {RubyTerraform::Errors::ExecutionError}) even if the resource is
+    #   missing.
+    # @option parameters [String] :backup 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.
+    # @option parameters [Boolean] :lock (true) When +true+, locks the state
+    #   file when locking is supported; when +false+, does not lock the state
+    #   file.
+    # @option parameters [String] :lock_timeout The duration to retry a state
+    #   lock; defaults to +"0s"+.
+    # @option parameters [Boolean] :no_backup (false) When +true+, no backup
+    #   file will be written.
+    # @option parameters [Boolean] :no_color (false) Whether or not the output
+    #   from the command should be in color.
+    # @option parameters [String] :state The path to the state file from which
+    #   to read state and in which to store state (unless +:state_out+ is
+    #   specified); defaults to +"terraform.tfstate"+.
+    # @option parameters [String] :state_out The path to write state to that is
+    #   different than +:state+; this can be used to preserve the old state.
+    # @option parameters [Boolean] :ignore_remote_version (false) Whether or not
+    #   to continue even if remote and local Terraform versions are
+    #   incompatible; this may result in an unusable workspace, and should be
+    #   used with extreme caution.
+    #
+    # @example Basic Invocation
+    #   RubyTerraform.untaint(
+    #     name: 'aws_security_group.allow_all')
+    #
+    def untaint(parameters = {})
+      exec(RubyTerraform::Commands::Untaint, parameters)
+    end
+
+    # Invokes the +terraform validate+ command which checks whether a
+    # configuration is valid.
+    #
+    # Validates the configuration files in a directory, referring only to the
+    # configuration and not accessing any remote services such as remote state,
+    # provider APIs, etc.
+    #
+    # Validate runs checks that verify whether a configuration is syntactically
+    # valid and internally consistent, regardless of any provided variables or
+    # existing state. It is thus primarily useful for general verification of
+    # reusable modules, including correctness of attribute names and value
+    # types.
+    #
+    # It is safe to run this command automatically, for example as a post-save
+    # check in a text editor or as a test step for a re-usable module in a CI
+    # system.
+    #
+    # Validation requires an initialized working directory with any referenced
+    # plugins and modules installed. To initialize a working directory for
+    # validation without accessing any configured remote backend, use the
+    # {#init} command passing +:backend+ as +false+.
+    #
+    # To verify configuration in the context of a particular run (a particular
+    # target workspace, input variable values, etc), use the {#plan} command
+    # instead, which includes an implied validation check.
+    #
+    # @param parameters The parameters used to invoke the command
+    # @option parameters [String] :directory The path to a directory containing
+    #   terraform configuration (deprecated in terraform 0.14, removed in
+    #   terraform 0.15, use +:chdir+ instead).
+    # @option parameters [String] :chdir The path of a working directory to
+    #   switch to before executing the given subcommand.
+    # @option parameters [Boolean] :json (false) Whether or not to produce
+    #   output in a machine-readable JSON format, suitable for use in text
+    #   editor integrations and other automated systems; always disables color.
+    # @option parameters [Boolean] :no_color (false) Whether or not the output
+    #   from the command should be in color.
+    #
+    # @example Basic Invocation
+    #   RubyTerraform.validate(
+    #     directory: 'infra/networking')
+    #
+    def validate(parameters = {})
+      exec(RubyTerraform::Commands::Validate, parameters)
+    end
+
+    # Invokes the +terraform workspace delete+ command which deletes a
+    # workspace.
+    #
+    # @param parameters The parameters used to invoke the command
+    # @option parameters [String] :name The name of the workspace to delete;
+    #   required.
+    # @option parameters [String] :directory The path to a directory containing
+    #   terraform configuration (deprecated in terraform 0.14, removed in
+    #   terraform 0.15, use +:chdir+ instead).
+    # @option parameters [String] :chdir The path of a working directory to
+    #   switch to before executing the given subcommand.
+    # @option parameters [Boolean] :force (false) Whether or not to remove a
+    #   non-empty workspace; defaults to +false+.
+    # @option parameters [Boolean] :lock (true) When +true+, locks the state
+    #   file when locking is supported; when +false+, does not lock the state
+    #   file.
+    # @option parameters [String] :lock_timeout ("0s") The duration to retry a
+    #   state lock.
+    #
+    # @example Basic Invocation
+    #   RubyTerraform.workspace_delete(
+    #     name: 'example')
+    #
+    def workspace_delete(parameters = {})
+      exec(RubyTerraform::Commands::WorkspaceDelete, parameters)
+    end
+
+    # Invokes the +terraform workspace list+ command which lists workspaces.
+    #
+    # @param parameters The parameters used to invoke the command
+    # @option parameters [String] :directory The path to a directory containing
+    #   terraform configuration (deprecated in terraform 0.14, removed in
+    #   terraform 0.15, use +:chdir+ instead).
+    # @option parameters [String] :chdir the path of a working directory to
+    #   switch to before executing the given subcommand.
+    #
+    # @example Basic Invocation
+    #   RubyTerraform.workspace_list(
+    #     directory: 'infra/networking')
+    #
+    def workspace_list(parameters = {})
+      exec(RubyTerraform::Commands::WorkspaceList, parameters)
+    end
+
+    # Invokes the +terraform workspace new+ command which creates a new
+    # workspace.
+    #
+    # @param parameters The parameters used to invoke the command
+    # @option parameters [String] :name The name of the workspace to create;
+    #   required.
+    # @option parameters [String] :directory The path to a directory containing
+    #   terraform configuration (deprecated in terraform 0.14, removed in
+    #   terraform 0.15, use +:chdir+ instead).
+    # @option parameters [String] :chdir The path of a working directory to
+    #   switch to before executing the given subcommand.
+    # @option parameters [Boolean] :lock (true) When +true+, locks the state
+    #   file when locking is supported; when +false+, does not lock the state
+    #   file.
+    # @option parameters [String] :lock_timeout ("0s") The duration to retry a
+    #   state lock.
+    # @option parameters [String] :state The path to a state file to copy into
+    #   the new workspace.
+    #
+    # @example Basic Invocation
+    #   RubyTerraform.workspace_new(
+    #     name: 'example')
+    #
+    def workspace_new(parameters = {})
+      exec(RubyTerraform::Commands::WorkspaceNew, parameters)
+    end
+
+    # Invokes the +terraform workspace select+ command which selects a
+    # workspace.
+    #
+    # @param parameters The parameters used to invoke the command
+    # @option parameters [String] :name The name of the workspace to select;
+    #   required.
+    # @option parameters [String] :directory The path to a directory containing
+    #   terraform configuration (deprecated in terraform 0.14, removed in
+    #   terraform 0.15, use +:chdir+ instead).
+    # @option parameters [String] :chdir The path of a working directory to
+    #   switch to before executing the given subcommand.
+    #
+    # @example BasicInvocation
+    #   RubyTerraform.workspace_select(
+    #     name: 'example')
+    #
+    def workspace_select(parameters = {})
+      exec(RubyTerraform::Commands::WorkspaceSelect, parameters)
+    end
+
+    # Invokes the +terraform workspace show+ command which shows the name of the
+    # current workspace.
+    #
+    # @param parameters The parameters used to invoke the command
+    # @option parameters [String] :chdir The path of a working directory to
+    #   switch to before executing the given subcommand.
+    #
+    # @example Basic Invocation
+    #   RubyTerraform.workspace_show
+    #
+    def workspace_show(parameters = {})
+      exec(RubyTerraform::Commands::WorkspaceShow, parameters)
+    end
+
+    # rubocop:disable Metrics/MethodLength
+
+    def workspace(parameters = {})
       case parameters[:operation]
       when nil, 'list'
         exec(RubyTerraform::Commands::WorkspaceList, parameters)
@@ -747,12 +1404,17 @@ module RubyTerraform
       end
     end
 
+    # rubocop:enable Metrics/MethodLength
+
     private
 
     def exec(command_class, parameters)
       command_class.new.execute(parameters)
     end
   end
+
+  # rubocop:enable Metrics/ModuleLength
+
   extend ClassMethods
 
   def self.included(other)