ruby-terraform 0.65.0.pre.9 → 0.65.0.pre.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d49c234d709a37f69ac311de2f0beb7123e88a70053af2a30955d28ffa712b54
-  data.tar.gz: 5cc7e8f312bc8217e4fc3e0fdcb28a44911580c93893ccb82b1e11d6e999f026
+  metadata.gz: 897da01f6ce70cf4c6f38c95d50a49c620da02e78078c1da7a14daa2f7f15f11
+  data.tar.gz: 476f49771b6acd39233c7b36987b397556ada57fc5bf5d4eeccec42bfe414ea0
 SHA512:
-  metadata.gz: 6abdb8f924a32c688c32b56e7908debfb9ebf1dd089b1ecab345239e15dca795d1cf722e3b0c66b2d8014f32e3a55acea945ff8fb6d52b2e0bb57fd5f64b0282
-  data.tar.gz: 543a406f62b65901a6b62479b919784774c7ced3bf1a4d1bae1c5f218367ecae8fc0bd4a16470a73addbc0e69033fd833c85fa41ae774448147aa62839adf809
+  metadata.gz: 98e74c44146a22196085aaa288c9ac93cf94ebb17aacd9e16473de232c0e9e87f59682df2978c8902f561f2e4ae040e57398f550c7a3fc359fba80e184615fb9
+  data.tar.gz: 98f3870cf241284aa5197012e72d7132e6e5a52f9e70724b07a65231c8605a7020aaa064b9920240d4e02585df0cd05cd664c411113589e79fc288cc5b24845c

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    ruby-terraform (0.65.0.pre.9)
-      lino (>= 2.3)
+    ruby-terraform (0.65.0.pre.14)
+      immutable-struct (>= 2.4)
+      lino (>= 2.5)
 
 GEM
   remote: https://rubygems.org/
@@ -21,14 +22,18 @@ GEM
     concurrent-ruby (1.1.8)
     diff-lcs (1.4.4)
     docile (1.3.5)
-    excon (0.79.0)
+    excon (0.80.1)
     faker (2.17.0)
       i18n (>= 1.6, < 2)
-    faraday (1.3.0)
+    faraday (1.4.1)
+      faraday-excon (~> 1.1)
       faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
       multipart-post (>= 1.2, < 3)
-      ruby2_keywords
+      ruby2_keywords (>= 0.0.4)
+    faraday-excon (1.1.0)
     faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.1.0)
     ffi (1.15.0)
     formatador (0.2.5)
     gem-release (2.2.1)
@@ -50,7 +55,8 @@ GEM
       concurrent-ruby (~> 1.0)
     i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    lino (2.3.0)
+    immutable-struct (2.4.1)
+    lino (2.5.0)
       hamster (~> 3.0)
       open4 (~> 1.3)
     listen (3.5.1)
@@ -69,9 +75,9 @@ GEM
       sawyer (~> 0.8.0, >= 0.5.3)
     open4 (1.3.4)
     parallel (1.20.1)
-    parser (3.0.0.0)
+    parser (3.0.1.0)
       ast (~> 2.4.1)
-    pry (0.14.0)
+    pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
     public_suffix (4.0.6)
@@ -115,7 +121,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    rubocop (1.12.1)
+    rubocop (1.13.0)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
@@ -150,6 +156,7 @@ GEM
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.0.0)
+    yard (0.9.26)
     zeitwerk (2.4.2)
 
 PLATFORMS
@@ -172,6 +179,7 @@ DEPENDENCIES
   rubocop-rspec (~> 2.2)
   ruby-terraform!
   simplecov (~> 0.21)
+  yard (~> 0.9)
 
 BUNDLED WITH
-   2.2.15
+   2.2.16

data/lib/ruby_terraform.rb

@@ -24,26 +24,144 @@ module RubyTerraform
   end
 
   module ClassMethods
+    # Invokes the +terraform apply+ command which creates or updates
+    # infrastructure according to terraform configuration files in the provided
+    # directory.
+    #
+    # By default, terraform will generate a new plan and present it for approval
+    # before taking any action. Alternatively, the command accepts a plan file
+    # created by a previous invocation, in which case terraform will take the
+    # 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] :plan The path to a pre-computed plan to be
+    #   applied; required unless +:directory+ is provided.
+    # @option parameters [Boolean] :auto_approve (false) If +true+, skips
+    #   interactive approval of the generated plan before applying.
+    # @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 [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
+    #   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.
+    # @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).
+    # @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 [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.apply(
+    #     directory: 'infra/networking',
+    #     vars: {
+    #       region: 'eu-central'
+    #     })
+    #
+    def apply(parameters = {})
+      exec(RubyTerraform::Commands::Apply, parameters)
+    end
+
     {
-      apply: RubyTerraform::Commands::Apply,
       clean: RubyTerraform::Commands::Clean,
       destroy: RubyTerraform::Commands::Destroy,
       format: RubyTerraform::Commands::Format,
+      force_unlock: RubyTerraform::Commands::ForceUnlock,
       get: RubyTerraform::Commands::Get,
+      graph: RubyTerraform::Commands::Graph,
       import: RubyTerraform::Commands::Import,
       init: RubyTerraform::Commands::Init,
+      login: RubyTerraform::Commands::Login,
+      logout: RubyTerraform::Commands::Logout,
       output: RubyTerraform::Commands::Output,
       plan: RubyTerraform::Commands::Plan,
+      providers: RubyTerraform::Commands::Providers,
+      providers_lock: RubyTerraform::Commands::ProvidersLock,
+      providers_mirror: RubyTerraform::Commands::ProvidersMirror,
+      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: RubyTerraform::Commands::Workspace
+      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 = {}|
-        command_class.new.execute(parameters)
+        exec(command_class, parameters)
+      end
+    end
+
+    def workspace(parameters = {}) # rubocop:disable Metrics/MethodLength
+      case parameters[:operation]
+      when nil, 'list'
+        exec(RubyTerraform::Commands::WorkspaceList, parameters)
+      when 'select'
+        exec(RubyTerraform::Commands::WorkspaceSelect, parameters)
+      when 'new'
+        exec(RubyTerraform::Commands::WorkspaceNew, parameters)
+      when 'delete'
+        exec(RubyTerraform::Commands::WorkspaceDelete, parameters)
+      when 'show'
+        exec(RubyTerraform::Commands::WorkspaceShow, parameters)
+      else
+        raise(
+          "Invalid operation '#{parameters[:operation]}' supplied to workspace"
+        )
       end
     end
+
+    private
+
+    def exec(command_class, parameters)
+      command_class.new.execute(parameters)
+    end
   end
   extend ClassMethods
 
@@ -52,7 +170,7 @@ module RubyTerraform
   end
 
   class Configuration
-    attr_accessor :binary, :logger, :stdin, :stdout, :stderr
+    attr_accessor :binary, :logger, :options, :stdin, :stdout, :stderr
 
     def default_logger
       logger = Logger.new($stdout)
@@ -60,9 +178,14 @@ module RubyTerraform
       logger
     end
 
+    def default_options
+      Options::Factory.new(Options::DEFINITIONS)
+    end
+
     def initialize
       @binary = 'terraform'
       @logger = default_logger
+      @options = default_options
       @stdin = ''
       @stdout = $stdout
       @stderr = $stderr
@@ -81,5 +204,9 @@ module RubyTerraform
     def close
       @targets.each(&:close)
     end
+
+    def reopen(*args)
+      @targets.each { |t| t.reopen(*args) }
+    end
   end
 end

data/lib/ruby_terraform/commands.rb

@@ -1,19 +1,40 @@
 # frozen_string_literal: true
 
-require_relative 'commands/clean'
-require_relative 'commands/init'
-require_relative 'commands/get'
-require_relative 'commands/validate'
-require_relative 'commands/plan'
 require_relative 'commands/apply'
+require_relative 'commands/clean'
 require_relative 'commands/destroy'
+require_relative 'commands/force_unlock'
+require_relative 'commands/format'
+require_relative 'commands/get'
+require_relative 'commands/graph'
+require_relative 'commands/import'
+require_relative 'commands/init'
+require_relative 'commands/login'
+require_relative 'commands/logout'
 require_relative 'commands/output'
+require_relative 'commands/plan'
+require_relative 'commands/providers'
+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/workspace'
-require_relative 'commands/import'
-require_relative 'commands/format'
+require_relative 'commands/state_list'
+require_relative 'commands/state_move'
+require_relative 'commands/state_pull'
+require_relative 'commands/state_push'
+require_relative 'commands/state_replace_provider'
+require_relative 'commands/state_remove'
+require_relative 'commands/state_show'
+require_relative 'commands/taint'
+require_relative 'commands/untaint'
+require_relative 'commands/validate'
+require_relative 'commands/workspace_delete'
+require_relative 'commands/workspace_list'
+require_relative 'commands/workspace_new'
+require_relative 'commands/workspace_select'
+require_relative 'commands/workspace_show'
 
 module RubyTerraform
   module Commands

data/lib/ruby_terraform/commands/apply.rb

@@ -1,39 +1,118 @@
 # frozen_string_literal: true
 
 require_relative 'base'
+require_relative '../options/common'
 
 module RubyTerraform
   module Commands
+    # Wraps the +terraform apply+ command which creates or updates
+    # infrastructure according to terraform configuration files in the provided
+    # directory.
+    #
+    # By default, terraform will generate a new plan and present it for approval
+    # before taking any action. Alternatively, the command accepts a plan file
+    # created by a previous invocation, in which case terraform will take the
+    # actions described in that plan without any confirmation prompt.
+    #
+    # For options accepted on construction, see {#initialize}.
+    #
+    # 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.
+    # * +:auto_approve+: if +true+, skips interactive approval of the generated
+    #   plan before applying; defaults to +false+.
+    # * +: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.
+    # * +:chdir+: the path of a working directory to switch to before executing
+    #   the given subcommand.
+    # * +:compact_warnings+: 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; 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;
+    #   when +false+, does not lock the state file; defaults to +true+.
+    # * +:lock_timeout+: the duration to retry a state lock; defaults to +"0s"+.
+    # * +:no_backup+: when +true+, no backup file will be written; defaults to
+    #   +false+.
+    # * +:no_color+: whether or not the output from the command should be in
+    #   color; defaults to +false+.
+    # * +:parallelism+: the number of parallel resource operations; defaults to
+    #   +10+.
+    # * +:refresh+: when +true+, updates state prior to checking for
+    #   differences; when +false+ uses locally available state; defaults to
+    #   +true+; this has no effect when +:plan+ is provided.
+    # * +: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"+.
+    # * +:state_out+: the path to write state to that is different than
+    #   +:state+; this can be used to preserve the old state.
+    # * +:target+: the address of a resource to target; if both +:target+ and
+    #   +:targets+ are provided, all targets will be passed to terraform.
+    # * +:targets+: an array of resource addresses to target; if both +:target+
+    #   and +:targets+ are provided, all targets will be passed to terraform.
+    # * +:vars+: a map of variables to be passed to the terraform configuration.
+    # * +: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.
+    # * +: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::Commands::Apply.new.execute(
+    #     directory: 'infra/networking',
+    #     vars: {
+    #       region: 'eu-central'
+    #     })
+    #
     class Apply < Base
-      def subcommands(_values)
+      include RubyTerraform::Options::Common
+
+      # @!visibility private
+      def subcommands
         %w[apply]
       end
 
       # rubocop:disable Metrics/MethodLength
+
+      # @!visibility private
       def options
         %w[
-          -auto-approve
           -backup
-          -input
+          -compact-warnings
           -lock
           -lock-timeout
+          -input
+          -auto-approve
           -no-color
+          -parallelism
+          -refresh
           -state
+          -state-out
           -target
           -var
           -var-file
-        ]
+        ] + super
       end
+
       # rubocop:enable Metrics/MethodLength
 
-      def arguments(values)
-        [values[:plan] || values[:directory]]
+      # @!visibility private
+      def arguments(parameters)
+        [parameters[:plan] || parameters[:directory]]
       end
 
+      # @!visibility private
       def parameter_defaults(_parameters)
         { vars: {}, var_files: [], targets: [] }
       end
 
+      # @!visibility private
       def parameter_overrides(parameters)
         { backup: parameters[:no_backup] ? '-' : parameters[:backup] }
       end

data/lib/ruby_terraform/commands/base.rb

@@ -3,22 +3,27 @@
 require 'lino'
 
 require_relative '../errors'
-require_relative '../options/factory'
 
 module RubyTerraform
   module Commands
     class Base
-      def initialize(
-        binary: nil, logger: nil, stdin: nil, stdout: nil, stderr: nil
-      )
-        @binary = binary || RubyTerraform.configuration.binary
-        @logger = logger || RubyTerraform.configuration.logger
-        @stdin = stdin || RubyTerraform.configuration.stdin
-        @stdout = stdout || RubyTerraform.configuration.stdout
-        @stderr = stderr || RubyTerraform.configuration.stderr
-        initialize_command
+      # rubocop:disable Metrics/AbcSize
+
+      # Constructs an instance of the command.
+      #
+      def initialize(**opts)
+        @binary  = opts[:binary]  || RubyTerraform.configuration.binary
+        @logger  = opts[:logger]  || RubyTerraform.configuration.logger
+        @options = opts[:options] || RubyTerraform.configuration.options
+        @stdin   = opts[:stdin]   || RubyTerraform.configuration.stdin
+        @stdout  = opts[:stdout]  || RubyTerraform.configuration.stdout
+        @stderr  = opts[:stderr]  || RubyTerraform.configuration.stderr
       end
 
+      # rubocop:enable Metrics/AbcSize
+
+      # Executes the command instance.
+      #
       def execute(parameters = {})
         do_before(parameters)
         build_and_execute_command(parameters)
@@ -35,6 +40,7 @@ module RubyTerraform
 
       def build_and_execute_command(parameters)
         command = build_command(parameters)
+
         logger.debug("Running '#{command}'.")
         command.execute(
           stdin: stdin,
@@ -53,8 +59,6 @@ module RubyTerraform
 
       private
 
-      def initialize_command; end
-
       def build_command(parameters)
         parameters = resolve_parameters(parameters)
 
@@ -62,10 +66,9 @@ module RubyTerraform
           .for_command(@binary)
           .with_options_after_subcommands
           .with_option_separator('=')
-          .with_appliables(Options::Factory.from(options, parameters))
-          .with_subcommands(subcommands(parameters))
-          .with_arguments(arguments(parameters))
-          .build
+          .with_appliables(@options.resolve(options, parameters))
+          .with_subcommands(subcommands)
+          .with_arguments(arguments(parameters)).build
       end
 
       def resolve_parameters(parameters)
@@ -82,7 +85,7 @@ module RubyTerraform
         {}
       end
 
-      def subcommands(_values)
+      def subcommands
         []
       end
 
@@ -90,7 +93,7 @@ module RubyTerraform
         []
       end
 
-      def arguments(_values)
+      def arguments(_parameters)
         []
       end
     end