tfrb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1062c33e29d17913b910e607fc5a3b14e2c2a9907c51e53e6641e3abf529761d
+  data.tar.gz: 47a20f47aab5abb3e39ab89f65ad50af71a2ebad3d19d9da91eaf106b65d7982
+SHA512:
+  metadata.gz: a1c5edcab90a0311656d77396e38414ff99f7cc23c1d27b6d5074ece57601de78cc6966ad8a32071a42f99171faee27898933ec97cd324d38132ad5741b81832
+  data.tar.gz: cdf678dd0b1e92e5338b2372ab5505246fbfefa5a6f0f89acd1881397ea96bbd6bcd6f8462906f2bcd119b237c62e04676f14cc35c29556b5754c34a34ffe97e

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-gemset

@@ -0,0 +1 @@
+tfrb

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.5.3

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 2.0.1

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    tfrb (0.1.0)
+      aws-sdk (~> 2)
+      mixlib-shellout
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aws-eventstream (1.0.2)
+    aws-sdk (2.11.256)
+      aws-sdk-resources (= 2.11.256)
+    aws-sdk-core (2.11.256)
+      aws-sigv4 (~> 1.0)
+      jmespath (~> 1.0)
+    aws-sdk-resources (2.11.256)
+      aws-sdk-core (= 2.11.256)
+    aws-sigv4 (1.1.0)
+      aws-eventstream (~> 1.0, >= 1.0.2)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    jmespath (1.4.0)
+    method_source (0.9.2)
+    mixlib-shellout (2.4.4)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    thor (0.20.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  tfrb!
+
+BUNDLED WITH
+   2.0.1

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,35 @@
+# tfrb
+
+Ruby DSL for Terraform
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tfrb'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tfrb
+
+## Usage
+
+    $ tfrm --help
+
+## 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.
+
+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/Granicus/tfrb.
+
+Please feel free to fork and modify if it does not suit your needs!

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'tfrb'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/tfrb

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'tfrb/cli'
+
+Tfrb::CLI.start

data/lib/tfrb/base.rb

@@ -0,0 +1,198 @@
+require_relative 'version'
+require_relative 'block'
+require_relative 'config'
+
+require 'mixlib/shellout'
+
+class Tfrb::Base
+  attr_accessor :block
+  attr_accessor :path
+  attr_accessor :temp_path
+  attr_accessor :environments
+  attr_accessor :state
+  attr_accessor :skip_import
+
+  def initialize(block, environments)
+    @skip_import = false
+    @block = block
+    @path = Tfrb::Config[:path]
+    @temp_path = File.join(Tfrb::Config[:temp_path], block)
+    Dir.mkdir(@temp_path) unless Dir.exist?(@temp_path)
+    @environments = environments.each_with_object({}) do |environment, hash|
+      hash[environment] = Tfrb::Block.load(environment)
+    end
+    @state = {}
+  end
+
+  def write!
+    @environments.each do |environment_name, environment|
+      File.open(File.join(temp_path, "#{environment_name}.tf.json"), 'w') do |file|
+        file.write(JSON.pretty_generate(environment, indent: '  '))
+      end
+    end
+  end
+
+  def init!
+    tf_init = Mixlib::ShellOut.new('terraform', 'init', shell_opts)
+    tf_init.run_command
+    tf_init.error!
+  end
+
+  def load_state!
+    return if skip_import
+    return unless s3_state?
+    tf_pullstate = Mixlib::ShellOut.new('terraform', 'state', 'pull', { cwd: temp_path })
+    tf_pullstate.run_command
+    tf_pullstate.error!
+    pulled_state = JSON.parse(tf_pullstate.stdout)
+    if pulled_state['modules']
+      pulled_state['modules'].each do |state_module|
+        if state_module['resources'] && state_module['resources'].size >= 1
+          state_module['resources'].each do |resource_key, resource_state|
+            next if resource_key =~ /^data\./
+            resource_type = resource_state['type']
+            resource_name = resource_key.sub(/^#{resource_type}./, '')
+            state[resource_type] = {} unless state.has_key?(resource_type)
+            state[resource_type][resource_name] = resource_state['primary']['attributes'] unless state[resource_type].has_key?(resource_name)
+          end
+        end
+      end
+    end
+  end
+
+  def import!(resource, name, id)
+    return if skip_import
+    if resource !~ /^postgresql/
+      environments_backup = Marshal.load(Marshal.dump(@environments))
+      @environments.each do |environment_name, environment|
+        if environment.has_key?('provider')
+          environment['provider'].delete('postgresql') if environment['provider'].has_key?('postgresql')
+          environment.delete('provider') if environment['provider'].empty?
+        end
+        if environment.has_key?('resource')
+          environment['resource'].delete_if { |resource, _| resource =~ /^postgresql/ }
+          environment.delete('resource') if environment['resource'].empty?
+        end
+      end
+      write!
+    end
+    providers = @environments.find { |_, e| e['resource'] && e['resource'][resource] && e['resource'][resource][name] && e['resource'][resource][name]['provider'] }
+    if providers && provider = providers[1]['resource'][resource][name]['provider']
+      tf_import = Mixlib::ShellOut.new('terraform', 'import', "-provider=#{provider}", "#{resource}.#{name}", id, cwd: temp_path)
+    else
+      tf_import = Mixlib::ShellOut.new('terraform', 'import', "#{resource}.#{name}", id, cwd: temp_path)
+    end
+    tf_import.run_command
+    tf_import.error!
+    state[resource] ||= {}
+    state[resource][name] = Tfrb::Resource.get_state(self, resource, name)
+    printf "\033[1;32mImported %s.%s from %s\033[0m\n", resource, name, id
+    if resource !~ /^postgresql/
+      @environments = environments_backup
+      write!
+    end
+  end
+
+  def staterm!(resource_id)
+    printf "\033[1;32mRemoving #{resource_id} from state...\033[0m\n"
+    tf_staterm = Mixlib::ShellOut.new('terraform', 'state', 'rm', resource_id, shell_opts)
+    tf_staterm.run_command
+    tf_staterm.error!
+  end
+
+  def taint!(resource_id)
+    printf "\033[1;32mTainting #{resource_id}...\033[0m\n"
+    tf_taint = Mixlib::ShellOut.new('terraform', 'taint', resource_id, shell_opts)
+    tf_taint.run_command
+    tf_taint.error!
+  end
+
+  def unlock!(lock_id)
+    printf "\033[1;32mForce unlocking state...\033[0m\n"
+    tf_unlock = Mixlib::ShellOut.new('terraform', 'force-unlock', lock_id, shell_opts.merge(input: 'yes'))
+    tf_unlock.run_command
+    tf_unlock.error!
+  end
+
+  def plan!
+    printf "\033[1;32mCalculating plan...\033[0m\n"
+    tf_plan = Mixlib::ShellOut.new('terraform', 'plan', '-out=plan.cache', shell_opts)
+    tf_plan.run_command
+    tf_plan.error!
+  end
+
+  def apply!
+    printf "\033[1;32mApplying plan...\033[0m\n"
+    tf_apply = Mixlib::ShellOut.new('terraform', 'apply', '-auto-approve', 'plan.cache', shell_opts)
+    tf_apply.run_command
+    tf_apply.error!
+    plan_cache = File.join(temp_path, 'plan.cache')
+    File.delete(plan_cache) if File.exist?(plan_cache)
+  end
+
+  def clean!
+    %w(*.tf.json).each do |glob|
+      Dir.glob(File.join(temp_path, glob)).each do |file|
+        File.delete(file) if File.exist?(file)
+      end
+    end
+  end
+
+  def s3_state?
+    environments.find { |k,v| v['terraform'] && v['terraform']['backend'] && v['terraform']['backend']['s3'] }
+  end
+
+  def shell_opts
+    {
+      cwd: temp_path,
+      live_stderr: $stderr,
+      live_stdout: $stdout,
+      timeout: 3600
+    }
+  end
+
+  class << self
+    def load(block, environments, skip_import = false)
+      Tfrb::Resource.load_helpers!
+
+      printf "\033[1;32mLoading %s...\033[0m\n", block
+      tfrb = self.new(block, environments)
+
+      # Set skip_import
+      tfrb.skip_import = skip_import
+
+      # Clean temporary files before starting
+      tfrb.clean!
+
+      # Load providers using extend (allows providers to fill in credentials, etc.)
+      Tfrb::Provider.load(tfrb)
+
+      # Write the .tf.json files to pick up any injection performed by providers
+      tfrb.write!
+
+      # Run terraform init if necessary
+      tfrb.init! unless Dir.exist?(File.join(tfrb.temp_path, '.terraform'))
+
+      # Load state
+      tfrb.load_state!
+
+      # Preload resources
+      Tfrb::Resource.preload(tfrb)
+
+      # Write the .tf.json files so terraform import can be run by custom resources
+      tfrb.write!
+
+      # Load resources using extend (allows them to locate existing entities and run terraform import)
+      Tfrb::Resource.load(tfrb)
+
+      # Write the .tf.json files again to pick up any injection performed by resources
+      tfrb.write!
+
+      # Return a fully loaded tfrb instance
+      tfrb
+    end
+  end
+end
+
+require_relative 'provider'
+require_relative 'resource'

data/lib/tfrb/block.rb

@@ -0,0 +1,44 @@
+module Tfrb
+  class Block
+    Tfrb::Config[:extra_modules].each do |extra_module|
+      include(extra_module)
+    end
+
+    def initialize
+      @data = {}
+    end
+
+    def to_h
+      @data
+    end
+
+    def import(filename, params = {})
+      instance_eval(IO.read(File.join(Tfrb::Config[:path], "#{filename}.rb")), filename)
+    end
+
+    def method_missing(method_name, *args, &block)
+      method_name = method_name.to_s.gsub(/_$/, '').to_sym if method_name.to_s =~ /_$/
+      if block_given?
+        @data[method_name.to_s] ||= {}
+        instance = self.class.new
+        instance.instance_eval(&block)
+        if args && args.size > 0
+          hash = args[0..-2].reduce(@data[method_name.to_s]) { |h, v| h[v] ||= {} }
+          hash[args.last] = instance.to_h
+        else
+          @data[method_name.to_s] = instance.to_h
+        end
+        # puts "method missing called for #{method_name}[#{args}] with block: #{instance.to_h}"
+      else
+        @data.merge!({ method_name.to_s => args[0] })
+        # puts "method missing called for #{method_name}[#{args}] without block"
+      end
+    end
+
+    def self.load(filename)
+      instance = self.new
+      instance.import(filename)
+      instance.to_h
+    end
+  end
+end