terraform_inventory 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 752923f38af589a6e9df6232e9892d9759bcff3a
+  data.tar.gz: d4748a2f30ff7599c733eb049e9657cc82b2eb82
+SHA512:
+  metadata.gz: 941355c9930033fe7eb6218fc2df8c7aa11e2d2902fcf26feea113bcdc79948824b754ad7082abf99758313d19ac4826374bcf006066892e83d2b2f8b91883df
+  data.tar.gz: 725b48d538389aa18264e3ecc45a0488e83c1dedff1e08b6998972966e020274d86ad55965f16ffa86738bcb90814ce10d8936f47e31d8abd4bdbfdb5ec2a1f5

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Tyler Cross
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,11 @@
+terraform_inventory
+=========
+
+Create an Ansible inventory file from a Terraform state file.
+
+This tool was written so that Terraform can be used for only creating infrastructure and then Ansible for configuration management.
+
+#### Example
+```
+tinventory --map=aws_instance.web:web aws_instance.web.1:db ./inventory
+```

data/Thorfile

@@ -0,0 +1,40 @@
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+
+require "bundler"
+require "thor/rake_compat"
+
+class Default < Thor
+  include Thor::RakeCompat
+  Bundler::GemHelper.install_tasks
+
+  desc "build", "Build terraform_inventory-#{TerraformInventory::VERSION}.gem into the pkg directory"
+  def build
+    Rake::Task["build"].execute
+  end
+
+  desc "install", "Build and install terraform_inventory-#{TerraformInventory::VERSION}.gem into system gems"
+  def install
+    Rake::Task["install"].execute
+  end
+
+  desc "release", "Create tag v#{TerraformInventory::VERSION} and build and push terraform_inventory-#{TerraformInventory::VERSION}.gem to Rubygems"
+  def release
+    Rake::Task["release"].execute
+  end
+
+  desc "rubocop", "Run Rubocop on all Ruby files"
+  def rubocop
+    exec "rubocop"
+  end
+
+  desc "spec", "Run tests."
+  def spec
+    exec "rspec spec"
+  end
+
+  desc "check", "Lint, style, and test."
+  def check
+    invoke :rubocop
+    invoke :spec
+  end
+end

data/bin/tinventory

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require "terraform_inventory/cli"
+TerraformInventory::Cli.start

data/lib/terraform_inventory.rb

@@ -0,0 +1,5 @@
+require "terraform_inventory/version"
+
+module TerraformInventory
+  autoload :TerraformState, "terraform_inventory/terraform_state"
+end

data/lib/terraform_inventory/cli.rb

@@ -0,0 +1,37 @@
+require "thor"
+require "terraform_inventory/terraform_state"
+
+module TerraformInventory
+  class Cli < Thor
+    include Thor::Actions
+
+    source_root(File.join(File.dirname(File.dirname(__dir__)), "templates"))
+
+    desc "create", "Creates an Ansible inventory file from a Terraform state file"
+    option :map, {
+      required: true,
+      type: :hash,
+      banner: "resource_selector:host_group",
+      desc: "Maps between Terraform resource selector and Ansible host group."
+    }
+    option :state, {
+      banner: "<path to state file>",
+      desc: "Path to a Terraform state file.",
+      default: File.join(Dir.pwd, "terraform.tfstate")
+    }
+    def create(inventory_path)
+      state = TerraformState.new `terraform show -no-color #{options[:state]}`
+
+      @groups = state.group_by_host(options[:map])
+      @ungrouped_resources = @groups[:none] || []
+      @groups.delete(:none)
+
+      template(
+        "inventory.erb",
+        inventory_path
+      )
+    end
+
+    default_task :create
+  end
+end

data/lib/terraform_inventory/exception.rb

@@ -0,0 +1,15 @@
+module TerraformInventory
+  module Exception
+    class ResourceNotFoundException < StandardError
+      def initialize(resource_selector)
+        super("Resource not found using selector: '#{resource_selector}'")
+      end
+    end
+
+    class InvalidResourceSelectorException < StandardError
+      def initialize(resource_selector)
+        super("Invalid resource selector: '#{resource_selector}'")
+      end
+    end
+  end
+end

data/lib/terraform_inventory/terraform_state.rb

@@ -0,0 +1,80 @@
+require "yaml"
+require "terraform_inventory/exception"
+
+module TerraformInventory
+  class TerraformState
+    # Find a resource given a resource selector.
+    #
+    # A resource selector is composed of the following:
+    #   resource_type (ex. aws_instance)
+    #   resource_name (ex. web)
+    #   resource_number (ex. 1)
+    #
+    # Here are a few examples of resource selectors:
+    #   aws_instance.web.1  -  selects a specific aws_instance resource named web
+    #   aws_instance.web    -  selects all aws_instance resources named web
+    #
+    def find_resource(resource_selector)
+      resource_type, resource_name, resource_number = parse_resource_selector(resource_selector)
+
+      if resource_number
+        [@state[resource_type][resource_name][resource_number]]
+      else
+        @state[resource_type][resource_name]
+      end
+    end
+
+    def group_by_host(resource_host_group_mapping)
+      resource_host_group_mapping.reduce({}) do |data, (resource_selector, host_group)| # rubocop:disable Style/EachWithObject
+        data[host_group.to_sym] ||= []
+        data[host_group.to_sym].concat find_resource(resource_selector)
+
+        data
+      end
+    end
+
+    def initialize(stateText)
+      @state = split_state(
+        YAML.load(
+          stateText
+            .gsub(/\e\[(\d+)m/, "") # Hack to get rid of ASCII color codes in Terraform output
+            .gsub(/\s=\s/, ": ")    # Use colons so we can parse as YAML
+            .gsub(/: \n/, ": ''\n") # Need to have quotes in order to parse as YAML
+            .split(/\n\n/)          # Grab only text that is related to resource state (exclude outputs)
+            .first                  # We only want the first match
+        )
+      )
+    end
+
+  private
+
+    def parse_resource_selector(resource_selector)
+      resource_selector_regex = /^(\w+)\.(\w+)(?:\.(\d+))?$/
+      matches = resource_selector_regex.match(resource_selector)
+
+      raise Exception::InvalidResourceSelectorException, resource_selector if matches.nil?
+
+      resource_type = matches[1]
+      resource_name = matches[2]
+      resource_number = if matches[3].nil?
+        nil
+      else
+        matches[3].to_i
+      end
+
+      [resource_type, resource_name, resource_number]
+    end
+
+    def split_state(state)
+      state.reduce({}) do |data, (resource_selector, resource_attributes)| # rubocop:disable Style/EachWithObject
+        resource_type, resource_name, _resource_number = parse_resource_selector(resource_selector)
+
+        data[resource_type] ||= {}
+        data[resource_type][resource_name] ||= []
+        data[resource_type][resource_name] << resource_attributes
+
+        data
+      end
+    end
+  end
+end

data/lib/terraform_inventory/version.rb

@@ -0,0 +1,3 @@
+module TerraformInventory
+  VERSION = "0.1.0"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require "rubygems"
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+
+require "terraform_inventory"
+require "rspec"

data/spec/terraform_inventory/terraform_state_spec.rb

@@ -0,0 +1,81 @@
+require "spec_helper"
+
+# rubocop:disable Style/TrailingWhitespace
+terraform_show_output = %(
+aws_instance.web.0:
+  id = i-1299293e
+  ami = ami-e84d8480
+  availability_zone = us-east-1a
+  instance_type = m3.medium
+  key_name = some-key
+  private_dns = ip-10-63-149-246.ec2.internal
+  private_ip = 10.63.149.246
+  public_dns = ec2-54-167-40-22.compute-1.amazonaws.com
+  public_ip = 54.167.40.22
+  security_groups.# = 1
+  security_groups.0 = ansible-managed
+  subnet_id = 
+aws_instance.web.1:
+  id = i-b69b2b9a
+  ami = ami-e84d8480
+  availability_zone = us-east-1a
+  instance_type = m3.medium
+  key_name = some-key
+  private_dns = ip-10-179-191-171.ec2.internal
+  private_ip = 10.179.191.171
+  public_dns = ec2-54-83-95-180.compute-1.amazonaws.com
+  public_ip = 54.83.95.180
+  security_groups.# = 1
+  security_groups.0 = ansible-managed
+  subnet_id = 
+heroku_app.default:
+  id = some-heroku-app
+  config_vars.# = 1
+  config_vars.0.PORT = 80
+  git_url = git@heroku.com:some-heroku-app.git
+  heroku_hostname = some-heroku-app.herokuapp.com
+  name = some-heroku-app
+  region = us
+  stack = cedar
+  web_url = http://some-heroku-app.herokuapp.com/
+
+Outputs:
+
+some-output = ADDRESS<54.167.40.22,54.83.95.180> USER<ubuntu>
+)
+
+describe TerraformInventory::TerraformState do
+  let(:state) { TerraformInventory::TerraformState.new terraform_show_output }
+
+  describe "#find_resource" do
+    context "using a resource_selector without resource_number" do
+      let(:resources) { state.find_resource("aws_instance.web") }
+
+      it "returns the correct resources" do
+        expect(resources.size).to eq(2)
+        expect(resources.first["id"]).to eq("i-1299293e")
+        expect(resources[1]["id"]).to eq("i-b69b2b9a")
+      end
+    end
+
+    context "using a resource_selector with a resource_number" do
+      let(:resources) { state.find_resource("aws_instance.web.1") }
+
+      it "returns the correct resources" do
+        expect(resources.size).to eq(1)
+        expect(resources.first["id"]).to eq("i-b69b2b9a")
+      end
+    end
+  end
+
+  describe "#group_by_host" do
+    let(:groups) { state.group_by_host Hash["aws_instance.web", "web"] }
+
+    it "properly groups resources" do
+      expect(groups.keys.size).to eq(1)
+      expect(groups.keys.first).to eq(:web)
+      expect(groups[:web].first["id"]).to eq("i-1299293e")
+      expect(groups[:web][1]["id"]).to eq("i-b69b2b9a")
+    end
+  end
+end

data/templates/inventory.erb

@@ -0,0 +1,6 @@
+<% for resource in @ungrouped_resources %><%= resource["public_ip"] %><% end %>
+<% for group_name, resources in @groups %>
+[<%= group_name %>]
+<% for resource in resources %><%= resource["public_ip"] %>
+<% end %>
+<% end %>

data/terraform_inventory.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "terraform_inventory/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "terraform_inventory"
+  spec.version       = TerraformInventory::VERSION
+  spec.authors       = ["Tyler Cross"]
+  spec.email         = ["tcross@bandwidth.com"]
+  spec.description   = %q(Map Terraform state to an Ansible inventory file)
+  spec.summary       = spec.description
+  spec.homepage      = "https://github.com/bandwidthcom/terraform-inventory"
+  spec.licenses      = %w[MIT]
+
+  spec.executables   = %w[tinventory]
+
+  spec.files         = %w[LICENSE.md README.md Thorfile terraform_inventory.gemspec]
+  spec.files        += Dir.glob("bin/**/*")
+  spec.files        += Dir.glob("lib/**/*.rb")
+  spec.files        += Dir.glob("spec/**/*")
+  spec.files        += Dir.glob("templates/**/*")
+
+  spec.test_files    = Dir.glob("spec/**/*")
+
+  spec.require_paths = %w[lib]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "thor"
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: terraform_inventory
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tyler Cross
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Map Terraform state to an Ansible inventory file
+email:
+- tcross@bandwidth.com
+executables:
+- tinventory
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- Thorfile
+- bin/tinventory
+- lib/terraform_inventory.rb
+- lib/terraform_inventory/cli.rb
+- lib/terraform_inventory/exception.rb
+- lib/terraform_inventory/terraform_state.rb
+- lib/terraform_inventory/version.rb
+- spec/spec_helper.rb
+- spec/terraform_inventory/terraform_state_spec.rb
+- templates/inventory.erb
+- terraform_inventory.gemspec
+homepage: https://github.com/bandwidthcom/terraform-inventory
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Map Terraform state to an Ansible inventory file
+test_files:
+- spec/terraform_inventory/terraform_state_spec.rb
+- spec/spec_helper.rb