tflat 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1189d180d63682ea5c7309d7845769052627f5d415952568bcdb915a88c72a31
+  data.tar.gz: 67a9c1e389e40bd8c7b344b9bd3dc65831976b06fd1fe211d4f8a035f57086cd
+SHA512:
+  metadata.gz: 6ef47e4daa22441e2b489f97f7e3f54cb50aadae05e825c75129b767ca367d39f0085839bfc3be57843401467b434c081e503c3620801f6b2cd9d33ff1626a8f
+  data.tar.gz: 8b90644eec0736eda05f8fdb4de93c9e62dfed9aaa2cbe3c2d2e4fd337d7b442b656464989cd96c2bca400de37a1e3966a441d9ef63705081cd956ed188557be

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 1.16.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at paulo@parruda.net. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in tflat.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    tflat (0.1.0)
+      ptools (~> 1.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    ptools (1.3.5)
+    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)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  tflat!
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Paulo Arruda
+
+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,122 @@
+# TFlat
+
+Aren't you tired of copy and pasting?
+
+I love Terraform, but HCL really gets in the way sometimes.
+
+How many times you wish you could just write a simple IF or CASE statement inside a .tf file? Any attempt of having minimal flow control with HCL results in a massive oneliner mess. Sometimes it feels like writing PERL one-liners. Hard to read equals hard to debug.
+
+Also, you can't use subfolders with Terraform, so you often end up at one of the three scenarios below:
+- You have a few `.tf` files with a lot of code in it. Ugly and not organized.
+- You create lots of different `.tf` files in a single directory, which makes it really hard to stay organized.
+- You separate everything in modules, so you have to keep passing variables downstream. And if you try to be *DRY*, good luck passing 1 million variables downstream to submodules!
+
+TFlat does 2 things to solve this problem:
+* Separate your Terraform code in subdirectories.
+* It allows you to write Ruby code in `.tf` files using ERB templates. Hurray!
+
+## How does TFlat make Terraform read subdirectories?
+It doesn't. This is what happens when you run it:
+1. Create a folder `.tflat` inside the current folder if it doesn't exist yet. If it does exist, delete all files from this folder non-recursively.
+2. Make a recursive list of all files in the current directory and move one by one to the `.tflat` folder.
+3. Replace all non-binary files in `.tflat/` with its ERB rendered version.
+4. Execute `terraform` with the arguments you passed to `tflat`.
+
+For example, say you have the following file structure:
+```
+|_ config
+  |_ providers.tf
+  |_ state.tf
+|_ ec2
+  |_ files
+    |_ user_data.sh
+  |_ instances.tf
+  |_ keypairs.tf
+|_ outputs.tf
+|_ variables.tf
+```
+TFlat will create the following files inside `./.tflat/`
+
+```
+config#providers.tf
+config#state.tf
+ec2#files#user_data.sh
+ec2#instances.tf
+ec2#keypairs.tf
+outputs.tf
+variables.tf
+```
+
+Then it will `cd` into `.tflat` and run `terraform` with the arguments you passed to `tflat`.
+
+*IMPORTANT* The `.terraform` folder will live at `.tflat/.terraform`, so make sure you don't delete that folder if you are storing the terraform state locally!
+
+There's only one more thing you have to pay attention to: handling file references.
+
+### Handling file references
+Because TFlat will actually copy and rename files to make it work with subdirectories, you need to pass file references in a different way. For example, imagine you are rendering a terraform template like this:
+
+files/userdata.tpl
+```
+#!/bin/bash
+# ...
+CONSUL_ADDRESS=${consul_address}
+# ...
+```
+main.tf
+```
+# ...
+data "template_file" "ec2_userdata" {
+  template = "${file("files/userdata.tpl")}"
+
+  vars {
+    consul_address = "${aws_instance.consul.private_ip}"
+  }
+}
+
+# Create a web server
+resource "aws_instance" "web" {
+  # ...
+
+  user_data = "${data.template_file.ec2_userdata.rendered}"
+}
+# ...
+```
+
+The line `template = "${file("files/userdata.tpl")}"` has to be written the in one of the following ways to work with TFlat:
+
+```
+# Let Ruby load the file content using the 'file' helper method (easier to read)
+template = "<%= file('files/userdata.tpl') %>"
+
+# Let Terraform load the file content using the 'f' helper method (quoting nightmare!)
+template = "${file("<%= f('files/userdata.tpl') %>")}"
+```
+It is up to you to choose what you like. Try both and look inside `.tflat/main.tf` to see the difference between the two ways.
+
+## Installation
+
+```
+$ gem install tflat
+```
+
+## Usage
+TFlat takes the same arguments from Terraform. It actually hands off the execution to Terraform after processing the files. So:
+
+```
+terraform plan
+```
+Becomes:
+```
+tflat plan
+```
+That's it!
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/parruda/tflat. 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](https://opensource.org/licenses/MIT).

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 "tflat"
+
+# 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/tflat

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'tflat'
+
+Tflat::Terraform.new(args: ARGV, directory: '.').run!

data/lib/tflat.rb

@@ -0,0 +1,76 @@
+require "tflat/version"
+require 'erb'
+require 'fileutils'
+require 'ptools'
+
+module Tflat
+  class Terraform
+    attr_accessor :destination, :all_files, :args, :directory
+    def initialize(args:, directory: '.')
+      @args = args.join(' ')
+      @directory = directory
+      @all_files = Dir.glob("#{directory}/**/*").select{|e| File.file?(e) && !e.match(/^\.tflat\/.+$/)}
+      @destination = "#{directory}/.tflat"
+    end
+    def run!
+      if args.empty?
+        puts `terraform`
+        puts "\n\n- [tflat] Notice: You must run tflat with terraform arguments.\n\n"
+        return
+      end
+      setup
+      print "- [tflat] Generating files..."
+      flatten_directories
+      parse_erb
+      puts " done!"
+      puts "- [tflat] Running: terraform #{args}"
+      execute
+    end
+
+    def setup
+      FileUtils.mkdir_p(destination)
+      Dir.glob('.tflat/*').each do |entry|
+        next unless File.file?(entry)
+        FileUtils.rm_f entry
+      end
+    end
+
+    def flatten_directories
+      all_files.each do |entry|
+        new_name = entry.sub(/^#{directory}\//,'').gsub('/', '#')
+        if new_name =~ /^#/ # Skip files/directories that start with a hash sign
+          puts "- [tflat] Skipping: #{entry}"
+          next
+        end
+        FileUtils.cp(entry, ".tflat/#{new_name}")
+      end
+    end
+
+    def parse_erb
+      Dir.glob(".tflat/*").each do |entry|
+        next unless File.file?(entry)
+        next if File.binary?(entry)
+        rendered = render(entry)
+        File.write(entry, rendered)
+      end
+    end
+
+    def f(file)
+      file.sub(/^\.\//, "").gsub('/', '#')
+    end
+
+    def file(file)
+      f = ".tflat/#{f(file)}"
+      File.read(f).inspect[1...-1]
+    end
+
+    def render(file)
+      template = File.read(file)
+      ERB.new(template).result(binding)
+    end
+
+    def execute
+      exec "cd .tflat && terraform #{args}"
+    end
+  end
+end

data/lib/tflat/version.rb

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

data/tflat.gemspec

@@ -0,0 +1,39 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "tflat/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "tflat"
+  spec.version       = Tflat::VERSION
+  spec.authors       = ["Paulo Arruda"]
+  spec.email         = ["parrudaj@gmail.com"]
+
+  spec.summary       = %q{Terraform + Ruby + ERB = DRY infrastructure code!}
+  spec.description   = %q{tflat is a Terraform wrapper that allows you to write Ruby code in .tf files. It also allows you to use subdirectories! Huray!}
+  spec.homepage      = "https://github.com/parruda/tflat"
+  spec.license       = "MIT"
+  spec.add_runtime_dependency 'ptools', "~> 1.3"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: tflat
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Paulo Arruda
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ptools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: tflat is a Terraform wrapper that allows you to write Ruby code in .tf
+  files. It also allows you to use subdirectories! Huray!
+email:
+- parrudaj@gmail.com
+executables:
+- tflat
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/tflat
+- lib/tflat.rb
+- lib/tflat/version.rb
+- tflat.gemspec
+homepage: https://github.com/parruda/tflat
+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.7.7
+signing_key: 
+specification_version: 4
+summary: Terraform + Ruby + ERB = DRY infrastructure code!
+test_files: []