ruby-terraform 0.27.0.pre.pre.2 → 0.29.0.pre.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43df990032f6e8413504a6784282f980fefc1d3364acac5c0635d032796ba0fa
-  data.tar.gz: d910ad3417915dd5a3ed6b8811dc4ca8224275bda6955a13c27a832adc575dc4
+  metadata.gz: 74107c0345d78776629e585ed00cdbc3fd74a8170740a63827ca1004357aed9e
+  data.tar.gz: b5cdca917a58b422cf047de27c3f705c83dd779573892e3b2b0f57df84100ba3
 SHA512:
-  metadata.gz: 9ad88937ac68228c0eb51587c6ad900ddd9da3b1b147fcdc4a350e17f07b44bfa491838cf81761c4d193b4f5d2fb3e4a1559a15edb092fc03a4ebcc81351ff86
-  data.tar.gz: 73c543d4bfda6cad6f5fd92264fba13bd38c2c53d9f9d3fb0edc2b7c8cc669bba27f678b7ae075500f1d646d8cdd209e19cb75b1fe4f48db3773de9553b71bc4
+  metadata.gz: aa73debf4732ee55b3b2c71d67ffc7919f28e021b4c31d3bc9e8c5564549484dc530735c57ff6b6ef6465295b75a202e17fbe9265e70f4b16c94648fecf8b04d
+  data.tar.gz: bc838afc7bd52bf784f2c7474be28885489923939a9bc7e363ebe4debb604d9b0afee66a6c6ebd354961fcd69008516e09d71e0b2967ecd15256038b9b90b2dc

data/.circleci/config.yml

@@ -3,14 +3,14 @@ jobs:
   test:
     working_directory: ~/ruby-terraform
     docker:
-    - image: ruby:2.3.8
+    - image: ruby:2.4.7
     steps:
     - checkout
     - run: ./scripts/ci/steps/test.sh
   prerelease:
     working_directory: ~/ruby-terraform
     docker:
-    - image: ruby:2.3.8
+    - image: ruby:2.4.7
     steps:
     - checkout
     - run: ./scripts/ci/common/install-git-crypt.sh
@@ -21,7 +21,7 @@ jobs:
   release:
     working_directory: ~/ruby-terraform
     docker:
-    - image: ruby:2.3.8
+    - image: ruby:2.4.7
     steps:
     - checkout
     - run: ./scripts/ci/common/install-git-crypt.sh

data/.ruby-version

@@ -1 +1 @@
-2.3.8
+2.4.7

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.27.0 (September 25th, 2019)
+
+IMPROVEMENTS:
+
+* Add configurable logger and standard streams.
+
 ## 0.12.0 (June 5th, 2018)
 
 IMPROVEMENTS:

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    ruby-terraform (0.27.0.pre.pre.2)
+    ruby-terraform (0.29.0.pre.pre.1)
       lino (~> 1.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    concurrent-ruby (1.1.3)
+    concurrent-ruby (1.1.5)
     diff-lcs (1.3)
     gem-release (2.0.1)
     hamster (3.0.0)
@@ -35,11 +35,11 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.16)
+  bundler (~> 2.0)
   gem-release (~> 2.0)
   rake (~> 12.3)
   rspec (~> 3.8)
   ruby-terraform!
 
 BUNDLED WITH
-   1.17.3
+   2.0.2

data/README.md

@@ -3,6 +3,7 @@
 A simple wrapper around the Terraform binary to allow execution from within
 a Ruby program or Rakefile.
 
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -32,7 +33,7 @@ RubyTerraform.configure do |config|
 end
 ```
 
-In addition, each command that requires the terraform binary (all except 
+In addition, each command that requires the terraform binary (all except
 `clean`) takes a `binary` keyword argument at initialisation that overrides the
 global configuration value.
 
@@ -43,9 +44,11 @@ Currently, there is partial support for the following commands:
 * `RubyTerraform::Commands::Get`: executes `terraform get`
 * `RubyTerraform::Commands::Plan`: executes `terraform plan`
 * `RubyTerraform::Commands::Apply`: executes `terraform apply`
+* `RubyTerraform::Commands::Show`: executes `terraform show`
 * `RubyTerraform::Commands::Destroy`: executes `terraform destroy`
 * `RubyTerraform::Commands::Output`: executes `terraform output`
 * `RubyTerraform::Commands::RemoteConfig`: executes `terraform remote config`
+* `RubyTerraform::Commands::Validate`: executes `terraform validate`
 * `RubyTerraform::Commands::Workspace`: executes `terraform workspace`
 
 ### RubyTerraform::Commands::Clean
@@ -66,7 +69,7 @@ removes the specified directory.
 
 ### RubyTerraform::Commands::Init
 
-The init command will initialise a terraform environment. It can be called in 
+The init command will initialise a terraform environment. It can be called in
 the following ways:
 
 ```ruby
@@ -74,12 +77,12 @@ RubyTerraform.init
 RubyTerraform.init(source: 'some/module/path', path: 'infra/module')
 RubyTerraform::Commands::Init.new.execute
 RubyTerraform::Commands::Init.new.execute(
-    source: 'some/module/path', 
+    source: 'some/module/path',
     path: 'infra/module')
 ```
 
 The init command supports the following options passed as keyword arguments:
-* `source`: the source module to use to initialise; required if `path` is 
+* `source`: the source module to use to initialise; required if `path` is
   specified
 * `path`: the path to initialise.
 * `backend`: `true`/`false`, whether or not to configure the backend.
@@ -103,12 +106,12 @@ RubyTerraform::Commands::Get.new.execute(directory: 'infra/networking')
 
 The get command supports the following options passed as keyword arguments:
 * `directory`: the directory containing terraform configuration; required.
-* `update`: whether or not already downloaded modules should be updated; 
+* `update`: whether or not already downloaded modules should be updated;
   defaults to `false`.
 * `no_color`: whether or not the output from the command should be in color;
   defaults to `false`.
-  
-  
+
+
 ### RubyTerraform::Commands::Plan
 
 The plan command will generate the execution plan in the provided
@@ -116,7 +119,7 @@ configuration directory. It can be called in the following ways:
 
 ```ruby
 RubyTerraform.plan(
-  directory: 'infra/networking', 
+  directory: 'infra/networking',
   vars: {
     region: 'eu-central'
   })
@@ -130,20 +133,21 @@ RubyTerraform::Commands::Plan.new.execute(
 The plan command supports the following options passed as keyword arguments:
 * `directory`: the directory containing terraform configuration; required.
 * `vars`: a map of vars to be passed in to the terraform configuration.
-* `var_file`: the path to a terraform var file; if both `var_file` and 
+* `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`: 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.
 * `state`: the path to the state file in which to store state; defaults to
   terraform.tfstate in the working directory or the remote state if configured.
 * `plan`: the name of the file in which to save the generated plan.
-* `input`: when `false`, will not ask for input for variables not directly set; defaults to `true`.
+* `input`: when `false`, will not ask for input for variables not directly set; 
+  defaults to `true`.
 * `destroy`: when `true`, a plan will be generated to destroy all resources
   managed by the given configuration and state; defaults to `false`.
 * `no_color`: whether or not the output from the command should be in color;
   defaults to `false`.
-  
-  
+
+
 ### RubyTerraform::Commands::Apply
 
 The apply command applies terraform configuration in the provided terraform
@@ -151,7 +155,7 @@ configuration directory. It can be called in the following ways:
 
 ```ruby
 RubyTerraform.apply(
-  directory: 'infra/networking', 
+  directory: 'infra/networking',
   vars: {
     region: 'eu-central'
   })
@@ -165,19 +169,20 @@ RubyTerraform::Commands::Apply.new.execute(
 The apply command supports the following options passed as keyword arguments:
 * `directory`: the directory containing terraform configuration; required.
 * `vars`: a map of vars to be passed in to the terraform configuration.
-* `var_file`: the path to a terraform var file; if both `var_file` and 
+* `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.
-* `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. 
 * `state`: the path to the state file in which to store state; defaults to
   terraform.tfstate in the working directory or the remote state if configured.
 * `backup`: the path to the backup file in which to store the state backup.
-* `input`: when `false`, will not ask for input for variables not directly set; defaults to `true`.
+* `input`: when `false`, will not ask for input for variables not directly set; 
+  defaults to `true`.
 * `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`.
-* `auto_approve`: if `true`, the command applys without prompting the user to confirm
-  the changes; defaults to `false`.
+* `auto_approve`: if `true`, the command applys without prompting the user to 
+  confirm the changes; defaults to `false`.
 
 
 ### RubyTerraform::Commands::Destroy
@@ -188,7 +193,7 @@ called in the following ways:
 
 ```ruby
 RubyTerraform.destroy(
-  directory: 'infra/networking', 
+  directory: 'infra/networking',
   vars: {
     region: 'eu-central'
   })
@@ -202,10 +207,10 @@ RubyTerraform::Commands::Destroy.new.execute(
 The destroy command supports the following options passed as keyword arguments:
 * `directory`: the directory containing terraform configuration; required.
 * `vars`: a map of vars to be passed in to the terraform configuration.
-* `var_file`: the path to a terraform var file; if both `var_file` and 
+* `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.
-* `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. 
 * `state`: the path to the state file containing the current state; defaults to
   terraform.tfstate in the working directory or the remote state if configured.
 * `force`: if `true`, the command destroys without prompting the user to confirm
@@ -260,32 +265,113 @@ RubyTerraform::Commands::RemoteConfig.new.execute(
 The remote config command supports the following options passed as keyword
 arguments:
 * `backend`: the type of backend to use; required.
-* `backend_config`: a map of backend specific configuration parameters; 
+* `backend_config`: a map of backend specific configuration parameters;
   required.
 * `no_color`: whether or not the output from the command should be in color;
   defaults to `false`.
 
+
 ### RubyTerraform::Commands::Workspace
 
-The `workspace` command configures [Terraform Workspaces](https://www.terraform.io/docs/state/workspaces.html#using-workspaces). It can be used as follows:
+The `workspace` command configures 
+[Terraform Workspaces](https://www.terraform.io/docs/state/workspaces.html#using-workspaces). 
+It can be used as follows:
 
 ```ruby
-RubyTerraform.workspace(operation: 'list') # terraform workspace list
-RubyTerraform.workspace(operation: 'new', workspace: 'staging') # terraform workspace new staging
-RubyTerraform.workspace(operation: 'select', workspace: 'staging') # terraform workspace select staging
-RubyTerraform.workspace(operation: 'list') # terraform workspace list
-RubyTerraform.workspace(operation: 'select', workspace: 'default') # terraform workspace select default
-RubyTerraform.workspace(operation: 'delete', workspace: 'staging') # terraform workspace delete staging
+RubyTerraform.workspace(operation: 'list')
+RubyTerraform.workspace(operation: 'new', workspace: 'staging')
+RubyTerraform.workspace(operation: 'select', workspace: 'staging')
+RubyTerraform.workspace(operation: 'list')
+RubyTerraform.workspace(operation: 'select', workspace: 'default')
+RubyTerraform.workspace(operation: 'delete', workspace: 'staging')
 ```
 
-The workspace command supports the following options passed as keyword arguments:
-* `directory`: the directory containing terraform configuration, the default is the current path.
+arguments:
+* `directory`: the directory containing terraform configuration, the default is 
+  the current path.
 * `operation`: `list`, `select`, `new` or `delete`. default `list`.
 * `workspace`: Workspace name.
 
+
+## Configuration
+
+In addition to configuring the location of the terraform binary, RubyTerraform 
+offers configuration of logging and standard streams. By default standard
+streams map to `$stdin`, `$stdout` and `$stderr` and all logging goes to 
+`$stdout`.  
+
+### Logging
+
+By default, RubyTerraform logs to `$stdout` with level `info`.
+
+To configure a custom logger:
+
+``` ruby
+require 'logger'
+
+logger = Logger.new($stdout)
+logger.level = Logger::DEBUG
+
+RubyTerraform.configure do |config|
+  config.logger = logger
+end
+```
+
+RubyTerraform supports logging to multiple different outputs at once, 
+for example:
+
+``` ruby
+require 'logger'
+
+log_file = File.open('path/to/some/ruby_terraform.log', 'a')
+logger = Logger.new(
+  RubyTerraform::MultiIO.new($stdout, log_file))
+logger.level = Logger::DEBUG
+
+RubyTerraform.configure do |config|
+  config.logger = logger
+end
+```
+
+Configured in this way, any logging performed by RubyTerraform will log to both 
+`STDOUT` and the provided `log_file`.
+
+### Standard Streams
+
+By default, RubyTerraform uses streams `$stdin`, `$stdout` and `$stderr`.
+
+To configure custom output and error streams:
+
+``` ruby
+log_file = File.open('path/to/some/ruby_terraform.log', 'a')
+
+RubyTerraform.configure do |config|
+  config.stdout = log_file
+  config.stderr = log_file
+end
+```
+
+In this way, both outputs will be redirected to `log_file`.
+
+Similarly, a custom input stream can be configured:
+
+``` ruby
+require 'stringio'
+
+input = StringIO.new("user\ninput\n")
+
+RubyTerraform.configure do |config|
+  config.stdin = input
+end
+``` 
+
+In this way, terraform can be driven by input from somewhere other than 
+interactive input from the terminal.
+
+
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, 
+After checking out the repo, run `bin/setup` to install dependencies. Then,
 run `rake spec` to run the tests. You can also run `bin/console` for an
 interactive prompt that will allow you to experiment.
 
@@ -320,7 +406,7 @@ openssl aes-256-cbc \
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at 
+Bug reports and pull requests are welcome on GitHub at
 https://github.com/infrablocks/ruby_terraform. This project is intended to be a
 safe, welcoming space for collaboration, and contributors are expected to adhere
 to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
@@ -328,5 +414,5 @@ to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
-The gem is available as open source under the terms of the 
+The gem is available as open source under the terms of the
 [MIT License](http://opensource.org/licenses/MIT).

data/lib/ruby_terraform.rb

@@ -80,11 +80,20 @@ module RubyTerraform
   end
 
   class Configuration
-    attr_accessor :binary, :logger
+    attr_accessor :binary, :logger, :stdin, :stdout, :stderr
+
+    def default_logger
+      logger = Logger.new($stdout)
+      logger.level = Logger::INFO
+      logger
+    end
 
     def initialize
       @binary = 'terraform'
-      @logger = Logger.new(STDOUT, level: :info)
+      @logger = default_logger
+      @stdin = $stdin
+      @stdout = $stdout
+      @stderr = $stderr
     end
   end
 

data/lib/ruby_terraform/commands/base.rb

@@ -5,21 +5,24 @@ module RubyTerraform
     class Base
       attr_reader :binary
 
-      def initialize(binary: nil, logger: nil)
+      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
       end
 
       def stdin
-        ''
+        @stdin
       end
 
       def stdout
-        $stdout
+        @stdout
       end
 
       def stderr
-        $stderr
+        @stderr
       end
 
       def execute(opts = {})

data/lib/ruby_terraform/commands/output.rb

@@ -6,7 +6,8 @@ module RubyTerraform
   module Commands
     class Output < Base
       def stdout
-        @stdout ||= StringIO.new
+        @stdout = StringIO.new unless
+            defined?(@stdout) && @stdout.respond_to?(:string)
       end
 
       def configure_command(builder, opts)
@@ -27,7 +28,7 @@ module RubyTerraform
       end
 
       def do_after(opts)
-        result = stdout.string
+        result = @stdout.string
         opts[:name] ? result.chomp : result
       end
     end

data/lib/ruby_terraform/commands/plan.rb

@@ -18,7 +18,8 @@ module RubyTerraform
         builder
             .with_subcommand('plan') do |sub|
               vars.each do |key, value|
-                sub = sub.with_option('-var', "'#{key}=#{value}'", separator: ' ')
+                sub = sub.with_option(
+                    '-var', "'#{key}=#{value}'", separator: ' ')
               end
               sub = sub.with_option('-var-file', var_file) if var_file
               var_files.each do |file|

data/lib/ruby_terraform/commands/refresh.rb

@@ -10,16 +10,15 @@ module RubyTerraform
         var_file = opts[:var_file]
         var_files = opts[:var_files] || []
         state = opts[:state]
-        refresh = opts[:refresh]
         input = opts[:input]
         target = opts[:target]
-        destroy = opts[:destroy]
         no_color = opts[:no_color]
 
         builder
             .with_subcommand('refresh') do |sub|
               vars.each do |key, value|
-                sub = sub.with_option('-var', "'#{key}=#{value}'", separator: ' ')
+                sub = sub.with_option(
+                    '-var', "'#{key}=#{value}'", separator: ' ')
               end
               sub = sub.with_option('-var-file', var_file) if var_file
               var_files.each do |file|

data/lib/ruby_terraform/commands/remote_config.rb

@@ -14,7 +14,8 @@ module RubyTerraform
             .with_subcommand('config') do |sub|
               sub = sub.with_option('-backend', backend) if backend
               backend_config.each do |key, value|
-                sub = sub.with_option('-backend-config', "'#{key}=#{value}'", separator: ' ')
+                sub = sub.with_option(
+                    '-backend-config', "'#{key}=#{value}'", separator: ' ')
               end
 
               sub = sub.with_flag('-no-color') if no_color

data/lib/ruby_terraform/commands/show.rb

@@ -5,7 +5,6 @@ require_relative 'base'
 
 module RubyTerraform
   module Commands
-    # Supports the `terraform show` directive
     class Show < Base
       def configure_command(builder, opts)
         no_color = opts[:no_color]

data/lib/ruby_terraform/commands/validate.rb

@@ -16,14 +16,16 @@ module RubyTerraform
         builder
             .with_subcommand('validate') do |sub|
               vars.each do |key, value|
-                sub = sub.with_option('-var', "'#{key}=#{value}'", separator: ' ')
+                sub = sub.with_option(
+                    '-var', "'#{key}=#{value}'", separator: ' ')
               end
               sub = sub.with_option('-var-file', var_file) if var_file
               var_files.each do |file|
                 sub = sub.with_option('-var-file', file)
               end
               sub = sub.with_option('-state', state) if state
-              sub = sub.with_option('-check-variables', check_variables) unless check_variables.nil?
+              sub = sub.with_option('-check-variables', check_variables) unless
+                  check_variables.nil?
               sub = sub.with_flag('-no-color') if no_color
               sub
             end

data/lib/ruby_terraform/commands/workspace.rb

@@ -13,8 +13,11 @@ module RubyTerraform
             .with_subcommand('workspace')
             .with_subcommand(operation)
 
-        builder = builder.with_subcommand(workspace) if workspace && operation != 'list'
+        builder = builder.with_subcommand(workspace) if
+            workspace && operation != 'list'
         builder = builder.with_argument(directory)
+
+        builder
       end
     end
   end

data/lib/ruby_terraform/version.rb

@@ -1,3 +1,3 @@
 module RubyTerraform
-  VERSION = "0.27.0-pre.2"
+  VERSION = "0.29.0-pre.1"
 end

data/ruby_terraform.gemspec

@@ -23,11 +23,11 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) {|f| File.basename(f)}
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.3.8'
+  spec.required_ruby_version = '>= 2.4.7'
 
   spec.add_dependency 'lino', '~> 1.1'
 
-  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'rake', '~> 12.3'
   spec.add_development_dependency 'rspec', '~> 3.8'
   spec.add_development_dependency 'gem-release', '~> 2.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-terraform
 version: !ruby/object:Gem::Version
-  version: 0.27.0.pre.pre.2
+  version: 0.29.0.pre.pre.1
 platform: ruby
 authors:
 - Toby Clemson
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -152,7 +152,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.8
+      version: 2.4.7
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"