ruby-terraform 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2502b0fc281c42c5e7b5a8fa6666fdbc6b36f648
-  data.tar.gz: d1f484f4b8bbe86bac2e2ea05ff466d0a8e3dec5
+  metadata.gz: 495ef01318ddc57c37fb25cf6c04c4e9db15cd28
+  data.tar.gz: 2809580c9ace7a4af184cb699b0ee94759421767
 SHA512:
-  metadata.gz: 9f4387d78ab1320336034fbd08ecfb654486b660ffbe19059e8f13c7f6a4813462708ae06fb609af80e09352c419affe557ee90fb36136aa0d7d7eab927e9736
-  data.tar.gz: fa88e7da09ac3f2e864424bcaa1bcfa22f35f74fcb1cf1e7a626a69a1c882147ff3b1fcf66244461d3543b82751ee84424e011a624d431dcbcbdea264c9a64b2
+  metadata.gz: 9181054e31a60c8c8c21e9f6dc69ce842db9b6eb0b7672ec3b1146e50fe2357ff437c055ade4682b1108661fc85001774ca206b259b4d80513572cdc8280460c
+  data.tar.gz: 474597664db46e457dbd770efed5a46d4b34d37017c64663d1da8a21b46b4f31c2632c0220aac216ae0c84ed7f4086f3076e90d1111b1f5c3fab6ae132858930

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    ruby-terraform (0.4.0)
+    ruby-terraform (0.5.0)
       lino (~> 1.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    concurrent-ruby (1.0.4)
+    concurrent-ruby (1.0.5)
     diff-lcs (1.3)
     gem-release (0.7.4)
     hamster (3.0.0)
@@ -42,4 +42,4 @@ DEPENDENCIES
   ruby-terraform!
 
 BUNDLED WITH
-   1.14.3
+   1.14.5

data/README.md

@@ -1,8 +1,7 @@
 # RubyTerraform
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ruby_terraform`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+A simple wrapper around the Terraform binary to allow execution from within
+a Ruby program or Rakefile.
 
 ## Installation
 
@@ -20,22 +19,198 @@ Or install it yourself as:
 
     $ gem install ruby_terraform
 
+
 ## Usage
 
-TODO: Write usage instructions here
+RubyTerraform needs to know where the terraform binary is located before it
+can do anything. By default, RubyTerraform looks on the path however this can
+be configured with:
+
+```ruby
+RubyTerraform.configure do |config|
+  config.binary = 'vendor/terraform/bin/terraform'
+end
+```
+
+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.
+
+Currently, there is partial support for the following commands:
+* `RubyTerraform::Commands::Clean`: clean up all locally held terraform state
+  and modules.
+* `RubyTerraform::Commands::Get`: executes `terraform get`
+* `RubyTerraform::Commands::Apply`: executes `terraform apply`
+* `RubyTerraform::Commands::Destroy`: executes `terraform destroy`
+* `RubyTerraform::Commands::Output`: executes `terraform output`
+* `RubyTerraform::Commands::RemoteConfig`: executes `terraform remote config`
+
+### RubyTerraform::Commands::Clean
+
+The clean command can be called in the following ways:
+
+```ruby
+RubyTerraform.clean
+RubyTerraform.clean(directory: 'infra/.terraform')
+RubyTerraform::Commands::Clean.new(base_directory: 'infra').execute
+RubyTerraform::Commands::Clean.new.execute(directory: 'infra/.terraform')
+```
+
+When called, it removes the contents of the .terraform directory in the
+working directory by default. If another directory is specified, it instead
+removes the specified directory. If the base directory is specified, it
+removes the .terraform directory from within the base directory.
+
+
+### RubyTerraform::Commands::Get
+
+The get command will fetch any modules referenced in the provided terraform
+configuration directory. It can be called in the following ways:
+
+```ruby
+RubyTerraform.get(directory: 'infra/networking')
+RubyTerraforn::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; 
+  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
+configuration directory. It can be called in the following ways:
+
+```ruby
+RubyTerraform.apply(
+  directory: 'infra/networking', 
+  vars: {
+    region: 'eu-central'
+  })
+RubyTerraform::Commands::Apply.new.execute(
+  directory: 'infra/networking',
+  vars: {
+    region: 'eu-central'
+  })
+```
+
+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.
+* `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.
+* `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`.
+
+
+### RubyTerraform::Commands::Destroy
+
+The destroy command destroys all resources defined in the terraform
+configuration in the provided terraform configuration directory. It can be
+called in the following ways:
+
+```ruby
+RubyTerraform.destroy(
+  directory: 'infra/networking', 
+  vars: {
+    region: 'eu-central'
+  })
+RubyTerraform::Commands::Destroy.new.execute(
+  directory: 'infra/networking',
+  vars: {
+    region: 'eu-central'
+  })
+```
+
+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.
+* `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
+  the destruction; defaults to `false`.
+* `backup`: the path to the backup file in which to store the state backup.
+* `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`.
+
+
+### RubyTerraform::Commands::Output
+
+The output command retrieves an output from a state file. It can be called in
+the following ways:
+
+```ruby
+RubyTerraform.output(name: 'vpc_id')
+RubyTerraform::Commands::Destroy.new.execute(name: 'vpc_id')
+```
+
+The output command supports the following options passed as keyword arguments:
+* `name`: the name of the output to retrieve; required.
+* `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.
+* `no_color`: whether or not the output from the command should be in color;
+  defaults to `false`.
+
+
+### RubyTerraform::Commands::RemoteConfig
+
+The remote config command configures storage of state using a remote backend. It
+can be called in the following ways:
+
+```ruby
+RubyTerraform.remote_config(
+  backend: 's3',
+  backend_config: {
+    bucket: 'example-state-bucket',
+    key: 'infra/terraform.tfstate',
+    region: 'eu-west-2'
+  })
+RubyTerraform::Commands::RemoteConfig.new.execute(
+  backend: 's3',
+  backend_config: {
+    bucket: 'example-state-bucket',
+    key: 'infra/terraform.tfstate',
+    region: 'eu-west-2'
+  })
+```
+
+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; 
+  required.
+* `no_color`: whether or not the output from the command should be in color;
+  defaults to `false`.
+
 
 ## Development
 
-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.
+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.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/Toby Clemson/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.
+Bug reports and pull requests are welcome on GitHub at 
+https://github.com/tobyclemson/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.
 
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-
+The gem is available as open source under the terms of the 
+[MIT License](http://opensource.org/licenses/MIT).

data/lib/ruby_terraform/commands/plan.rb

@@ -0,0 +1,30 @@
+require 'lino'
+require_relative 'base'
+
+module RubyTerraform
+  module Commands
+    class Plan < Base
+      def configure_command(builder, opts)
+        directory = opts[:directory]
+        vars = opts[:vars] || {}
+        state = opts[:state]
+        plan = opts[:plan]
+        destroy = opts[:destroy]
+        no_color = opts[:no_color]
+
+        builder
+            .with_subcommand('plan') do |sub|
+              vars.each do |key, value|
+                sub = sub.with_option('-var', "'#{key}=#{value}'", separator: ' ')
+              end
+              sub = sub.with_option('-state', state) if state
+              sub = sub.with_option('-out', plan) if plan
+              sub = sub.with_flag('-destroy') if destroy
+              sub = sub.with_flag('-no-color') if no_color
+              sub
+            end
+            .with_argument(directory)
+      end
+    end
+  end
+end

data/lib/ruby_terraform/commands.rb

@@ -1,5 +1,6 @@
 require_relative 'commands/clean'
 require_relative 'commands/get'
+require_relative 'commands/plan'
 require_relative 'commands/apply'
 require_relative 'commands/destroy'
 require_relative 'commands/output'

data/lib/ruby_terraform/version.rb

@@ -1,3 +1,3 @@
 module RubyTerraform
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/ruby_terraform.rb

@@ -24,6 +24,10 @@ module RubyTerraform
       Commands::Get.new.execute(opts)
     end
 
+    def plan(opts = {})
+      Commands::Plan.new.execute(opts)
+    end
+
     def apply(opts = {})
       Commands::Apply.new.execute(opts)
     end
@@ -39,6 +43,15 @@ module RubyTerraform
     def output(opts = {})
       Commands::Output.new.execute(opts)
     end
+
+    def output_from_remote(opts)
+      output_name = opts[:name]
+      remote_opts = opts[:remote]
+
+      clean
+      remote_config(remote_opts)
+      output(name: output_name)
+    end
   end
   extend ClassMethods
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-terraform
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Toby Clemson
@@ -108,6 +108,7 @@ files:
 - lib/ruby_terraform/commands/destroy.rb
 - lib/ruby_terraform/commands/get.rb
 - lib/ruby_terraform/commands/output.rb
+- lib/ruby_terraform/commands/plan.rb
 - lib/ruby_terraform/commands/remote_config.rb
 - lib/ruby_terraform/version.rb
 - ruby_terraform.gemspec
@@ -131,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.0.14.1
 signing_key: 
 specification_version: 4
 summary: A simple Ruby wrapper for invoking Terraform commands.