terraform 0.0.1 → 0.0.2

data/README.markdown

@@ -1,11 +1,12 @@
-Terraform is a small goal-oriented DSL for setting up a machine, similar in purpose to Chef and
-Puppet. Its design is inspired by Babushka, but it's simpler and tailored specifically for provisioning a machine for a webapp.
+Terraform is a small goal-oriented DSL for setting up a machine, similar in purpose to Chef and Puppet. Its
+design is inspired by Babushka, but it's simpler and tailored specifically for provisioning a machine for a
+webapp.
 
 Usage
 -----
 
     require "terraform_dsl"
-    include TerraformDsl
+    include Terraform::Dsl
     dep "my library" do
       met? { (check if your dependency is met) }
       meet { (install your dependency) }
@@ -15,10 +16,11 @@ A more detailed README is coming shortly.
 
 Contribute
 ----------
-When editing this gem, to test your changes, you can load your local copy of the gem in your project by using this in your Gemfile:
+When editing this gem, to test your changes, you can load your local copy of the gem in your project by using
+this in your Gemfile:
 
 gem "terraform", :path => "~/p/terraform"
 
 Credits
 -------
-Dmac -- thanks for the name!
+Dmac -- thanks for the name!

data/Rakefile

@@ -1 +1,11 @@
 require "bundler/gem_tasks"
+require "rake/testtask"
+
+task :test => ["test:units"]
+
+namespace :test do
+  Rake::TestTask.new(:units) do |task|
+    task.libs << "test"
+    task.test_files = FileList["test/unit/**/*_test.rb"]
+  end
+end

data/lib/terraform.rb

@@ -5,6 +5,6 @@ module Terraform
   # Writes the terraform_dsl.rb to the given file or directory.
   def self.write_dsl_file(path)
     path = File.join(path, "terraform_dsl.rb") if File.directory?(path)
-    FileUtils.cp(File.expand_path(File.join(File.dirname(__FILE__), "terraform/terraform_dsl.rb")), path)
+    FileUtils.cp(File.expand_path(File.join(File.dirname(__FILE__), "terraform/dsl.rb")), path)
   end
 end

data/lib/terraform/dsl.rb

@@ -0,0 +1,144 @@
+require "fileutils"
+require "digest/md5"
+
+module Terraform
+  module Dsl
+    def dep(name)
+      @dependencies ||= []
+      # If a dep gets required or defined twice, only run it once.
+      return if @dependencies.find { |dep| dep[:name] == name }
+      @dependencies.push(@current_dependency = { :name => name })
+      yield
+      fail_and_exit "Error: no 'met?' block defined for dep '#{name}'." unless @current_dependency[:met?]
+      fail_and_exit "Error: no 'meet' block defined for dep '#{name}'." unless @current_dependency[:meet]
+    end
+    def met?(&block) @current_dependency[:met?] = block end
+    def meet(&block) @current_dependency[:meet] = block end
+    def in_path?(command) `which #{command}`.size > 0 end
+    def fail_and_exit(message) puts message; exit 1 end
+
+    # Runs a command and raises an exception if its exit status was nonzero.
+    # - silent: if false, log the command being run and its stdout. False by default.
+    # - check_exit_code: raises an error if the command had a non-zero exit code. True by default.
+    def shell(command, options = {})
+      silent = (options[:silent] != false)
+      puts command unless silent
+      output = `#{command}`
+      puts output unless output.empty? || silent
+      raise "#{command} had a failure exit status of #{$?.to_i}" unless $?.to_i == 0
+      true
+    end
+
+    def satisfy_dependencies
+      STDOUT.sync = true # Ensure that we flush logging output as we go along.
+      @dependencies.each do |dep|
+        unless dep[:met?].call
+          puts "* Dependency #{dep[:name]} is not met. Meeting it."
+          dep[:meet].call
+          fail_and_exit %Q("met?" for #{dep[:name]} is still false after running "meet".) unless dep[:met?].call
+        end
+      end
+    end
+
+    #
+    # These are very common tasks which are needed by almost everyone, and so they're bundled with this DSL.
+    #
+
+    def package_installed?(package) `dpkg -s #{package} 2> /dev/null | grep Status`.match(/\sinstalled/) end
+    def install_package(package)
+      # Specify a noninteractive frontend, so dpkg won't prompt you for info. -q is quiet; -y is "answer yes".
+      shell "sudo DEBIAN_FRONTEND=noninteractive apt-get install -qy #{package}"
+    end
+
+    def ensure_packages(*packages) packages.each { |package| ensure_package(package) } end
+    def ensure_package(package)
+      dep "package: #{package}" do
+        met? { package_installed?(package) }
+        meet { install_package(package) }
+      end
+    end
+
+    # Ensure an Ubuntu PPA is installed. The argument is the ppa location, in the form ppa:[USER]/[NAME]
+    def ensure_ppa(ppa)
+      ppa_part, location = ppa.split(":", 2)
+      fail_and_exit("PPA location must be of the form ppa:[USER]/[NAME]") unless (ppa_part == "ppa") && location
+      # The python-software-properties package provides the add-apt-repository convenience tool for editing
+      # the list of apt's source repositories.
+      ensure_package("python-software-properties")
+      dep "ppa: #{location}" do
+        met? { !`apt-cache policy 2> /dev/null | grep ppa.launchpad.net/#{location}/`.empty? }
+        meet do
+          shell "sudo add-apt-repository #{ppa}"#, :silent => true
+          shell "sudo apt-get update"#, :silent => true
+        end
+      end
+    end
+
+    def gem_installed?(gem) `gem list '#{gem}'`.include?(gem) end
+
+    def ensure_gem(gem)
+      dep "gem: #{gem}" do
+        met? { gem_installed?(gem) }
+        meet { shell "gem install #{gem} --no-ri --no-rdoc" }
+      end
+    end
+
+    # Ensures the file at dest_path is exactly the same as the one in source_path.
+    # Invokes the given block if the file is changed. Use this block to restart a service, for instance.
+    def ensure_file(source_path, dest_path, &on_change)
+      dep "file: #{dest_path}" do
+        met? do
+          raise "This file does not exist: #{source_path}" unless File.exists?(source_path)
+          File.exists?(dest_path) && (Digest::MD5.file(source_path) == Digest::MD5.file(dest_path))
+        end
+        meet do
+          FileUtils.cp(source_path, dest_path)
+          on_change.call if on_change
+        end
+      end
+    end
+
+    # A task which must be run once to be 'met'. For instance, this might be the DB migration script.
+    def ensure_run_once(name, &block)
+      dep "run task once: #{name}" do
+        has_run_once = false
+        met? { has_run_once }
+        meet do
+          yield
+          has_run_once = true
+        end
+      end
+    end
+
+    def ensure_rbenv
+      ensure_package "git-core"
+      dep "rbenv" do
+        met? { in_path?("rbenv") }
+        meet do
+          # These instructions are from https://github.com/sstephenson/rbenv/wiki/Using-rbenv-in-Production
+          shell "wget -q -O - https://raw.github.com/fesplugas/rbenv-installer/master/bin/rbenv-installer | bash"
+          # We need to run rbenv init after install, which adjusts the path. If exec is causing us problems
+          # down the road, we can perhaps simulate running rbenv init without execing.
+          unless ARGV.include?("--forked-after-rbenv") # To guard against an infinite forking loop.
+            exec "bash -c 'source ~/.bashrc; #{$0} --forked-after-rbenv'" # $0 is the current process's name.
+          end
+        end
+      end
+    end
+
+    # ruby_version is a rbenv ruby version string like "1.9.2-p290".
+    def ensure_rbenv_ruby(ruby_version)
+      ensure_rbenv
+      ensure_packages "curl", "build-essential", "libxslt1-dev", "libxml2-dev", "libssl-dev"
+
+      dep "rbenv ruby: #{ruby_version}" do
+        met? { `which ruby`.include?("rbenv") && `ruby -v`.include?(ruby_version.gsub("-", "")) }
+        meet do
+          puts "Compiling Ruby will take a few minutes."
+          shell "rbenv install #{ruby_version}"
+          shell "rbenv rehash"
+        end
+      end
+    end
+  end
+end

data/lib/terraform/version.rb

@@ -1,3 +1,3 @@
 module Terraform
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/terraform.gemspec

@@ -15,6 +15,9 @@ Gem::Specification.new do |s|
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ["lib"]
+
+  s.add_development_dependency "scope", "~> 0.2.3"
+  s.add_development_dependency "rr", "~> 1.0.4"
 end

data/test/test_helper.rb

@@ -0,0 +1,24 @@
+require "bundler/setup"
+require "minitest/autorun"
+require "scope"
+require "rr"
+require "stringio"
+
+$:.unshift(File.join(File.dirname(__FILE__), "../lib"))
+
+module Scope
+  class TestCase
+    include RR::Adapters::MiniTest
+  end
+end
+
+module Kernel
+  def capture_output
+    result = StringIO.new
+    $stdout = result
+    yield
+    result.string
+  ensure
+    $stdout = STDOUT
+  end
+end

data/test/unit/terraform/dsl_test.rb

@@ -0,0 +1,97 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "../../test_helper.rb"))
+require "terraform/dsl"
+
+class DslTest < Scope::TestCase
+  include Terraform::Dsl
+
+  class ProcessExit < StandardError; end
+
+  # Methods to mock for met? and meet blocks
+  def do_met() end
+  def do_meet() end
+
+  setup do
+    stub(self).fail_and_exit(anything) { raise ProcessExit }
+  end
+
+  context "dep declarations" do
+    should "fail if there is no met? or meet given" do
+      assert_raises(ProcessExit) do
+        dep("no met?") { meet {} }
+      end
+      assert_raises(ProcessExit) do
+        dep("no meet") { met? {} }
+      end
+    end
+
+    should "not run meet if met? is satisfied" do
+      mock(self).do_met { true }
+      mock(self).do_meet.never
+      dep "foo" do
+        met? { do_met }
+        meet { do_meet }
+      end
+      satisfy_dependencies
+    end
+
+    should "run meet if met? is not satisfied" do
+      met_run = false
+      mock(self).do_met.twice { result = met_run; met_run = true; result }
+      mock(self).do_meet
+      dep "foo" do
+        met? { do_met }
+        meet { do_meet }
+      end
+      message = capture_output { satisfy_dependencies }
+      assert_match /Dependency foo is not met/, message
+    end
+
+    should "only meet a dep once" do
+      met_run = false
+      mock(self).do_met.twice { result = met_run; met_run = true; result }
+      mock(self).do_meet
+      2.times do
+        dep "foo" do
+          met? { do_met }
+          meet { do_meet }
+        end
+      end
+      capture_output { satisfy_dependencies }
+    end
+
+    should "fail if met? still fails after running meet" do
+      mock(self).do_met.twice { false }
+      mock(self).do_meet
+      dep "foo" do
+        met? { do_met }
+        meet { do_meet }
+      end
+      assert_raises(ProcessExit) { capture_output { satisfy_dependencies } }
+    end
+  end
+
+  context "ensure_ppa" do
+    should "fail if the PPA name is not the expected form" do
+      assert_raises(ProcessExit) { ensure_ppa("blah") }
+      assert_raises(ProcessExit) { ensure_ppa("http://some.ppa.url") }
+    end
+
+    # TODO(caleb): Add more unit tests. Having trouble coming up with unit tests that don't feel
+    # fragile/artificial. For helpers like these, integration tests of some kind that run on a vagrant box or
+    # something may prove more useful.
+  end
+
+  context "ensure_run_once" do
+    should "run a task exactly once" do
+      mock(self).do_meet.never
+      meet_run = false
+      ensure_run_once("foo") { meet_run = true }
+      dep "run task once: foo" do
+        met? { do_met }
+        meet { do_meet }
+      end
+      capture_output { satisfy_dependencies }
+      assert meet_run
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: terraform
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Phil Crosby
@@ -15,10 +15,41 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-24 00:00:00 -07:00
+date: 2012-03-27 00:00:00 -07:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: scope
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 17
+        segments: 
+        - 0
+        - 2
+        - 3
+        version: 0.2.3
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rr
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 1
+        - 0
+        - 4
+        version: 1.0.4
+  type: :development
+  version_requirements: *id002
 description: 
 email: 
 - phil.crosby@gmail.com
@@ -34,9 +65,11 @@ files:
 - README.markdown
 - Rakefile
 - lib/terraform.rb
-- lib/terraform/terraform_dsl.rb
+- lib/terraform/dsl.rb
 - lib/terraform/version.rb
 - terraform.gemspec
+- test/test_helper.rb
+- test/unit/terraform/dsl_test.rb
 has_rdoc: true
 homepage: http://github.com/philc/terraform
 licenses: []
@@ -71,5 +104,6 @@ rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Set up a cold, inhospitable system using Terraform.
-test_files: []
-
+test_files: 
+- test/test_helper.rb
+- test/unit/terraform/dsl_test.rb

data/lib/terraform/terraform_dsl.rb

@@ -1,125 +0,0 @@
-# This is small goal-oriented DSL for installing system components, similar in purpose to Chef and Puppet.
-# Its design is inspired by Babushka but it's simpler and tailored specifically for provisioning a machine
-# for a webapp.
-#
-# Usage:
-#
-# require "terraform_dsl"
-# include TerraformDsl
-# dep "my library" do
-#   met? { (check if your dependency is met) }
-#   meet { (install your dependency) }
-# end
-
-require "fileutils"
-require "digest/md5"
-
-module TerraformDsl
-  def dep(name)
-    @dependencies ||= []
-    # If a dep gets required or defined twice, only run it once.
-    return if @dependencies.find { |dep| dep[:name] == name }
-    @dependencies.push(@current_dependency = { :name => name })
-    yield
-  end
-  def met?(&block) @current_dependency[:met?] = block end
-  def meet(&block) @current_dependency[:meet] = block end
-  def in_path?(command) `which #{command}`.size > 0 end
-  def fail_and_exit(message) puts message; exit 1 end
-
-  # Runs a command and raises an exception if its exit status was nonzero.
-  # - silent: if false, log the command being run and its stdout. False by default.
-  # - check_exit_code: raises an error if the command had a non-zero exit code. True by default.
-  def shell(command, options = {})
-    silent = (options[:silent] != false)
-    puts command unless silent
-    output = `#{command}`
-    puts output unless output.empty? || silent
-    raise "#{command} had a failure exit status of #{$?.to_i}" unless $?.to_i == 0
-    true
-  end
-
-  def satisfy_dependencies
-    STDOUT.sync = true # Ensure that we flush logging output as we go along.
-    @dependencies.each do |dep|
-      unless dep[:met?].call
-        puts "* Dependency #{dep[:name]} is not met. Meeting it."
-        dep[:meet].call
-        fail_and_exit %Q("met?" for #{dep[:name]} is still false after running "meet".) unless dep[:met?].call
-      end
-    end
-  end
-
-  #
-  # These are very common tasks which are needed by almost everyone, and so they're bundled with this DSL.
-  #
-
-  def package_installed?(package) `dpkg -s #{package} 2> /dev/null | grep Status`.match(/\sinstalled/) end
-  def install_package(package)
-    # Specify a noninteractive frontend, so dpkg won't prompt you for info. -q is quiet; -y is "answer yes".
-    shell "sudo DEBIAN_FRONTEND=noninteractive apt-get install -qy #{package}"
-  end
-
-  def ensure_packages(*packages) packages.each { |package| ensure_package(package) } end
-  def ensure_package(package)
-    dep package do
-      met? { package_installed?(package) }
-      meet { install_package(package) }
-    end
-  end
-
-  def gem_installed?(gem) `gem list '#{gem}'`.include?(gem) end
-
-  def ensure_gem(gem)
-    dep gem do
-      met? { gem_installed?(gem) }
-      meet { shell "gem install #{gem} --no-ri --no-rdoc" }
-    end
-  end
-
-  # Ensures the file at dest_path is exactly the same as the one in source_path.
-  # Invokes the given block if the file is changed. Use this block to restart a service, for instance.
-  def ensure_file(source_path, dest_path, &on_change)
-    dep dest_path do
-      met? do
-        raise "This file does not exist: #{source_path}" unless File.exists?(source_path)
-        File.exists?(dest_path) && (Digest::MD5.file(source_path) == Digest::MD5.file(dest_path))
-      end
-      meet do
-        FileUtils.cp(source_path, dest_path)
-        on_change.call if on_change
-      end
-    end
-  end
-
-  def ensure_rbenv
-    ensure_package "git-core"
-    dep "rbenv" do
-      met? { in_path?("rbenv") }
-      meet do
-        # These instructions are from https://github.com/sstephenson/rbenv/wiki/Using-rbenv-in-Production
-        shell "wget -q -O - https://raw.github.com/fesplugas/rbenv-installer/master/bin/rbenv-installer | bash"
-        # We need to run rbenv init after install, which adjusts the path. If exec is causing us problems
-        # down the road, we can perhaps simulate running rbenv init without execing.
-        unless ARGV.include?("--forked-after-rbenv") # To guard against an infinite forking loop.
-          exec "bash -c 'source ~/.bashrc; #{$0} --forked-after-rbenv'" # $0 is the current process's name.
-        end
-      end
-    end
-  end
-
-  # ruby_version is a rbenv ruby version string like "1.9.2-p290".
-  def ensure_rbenv_ruby(ruby_version)
-    ensure_rbenv
-    ensure_packages "curl", "build-essential", "libxslt1-dev", "libxml2-dev", "libssl-dev"
-
-    dep "rbenv ruby #{ruby_version}" do
-      met? { `which ruby`.include?("rbenv") && `ruby -v`.include?(ruby_version.gsub("-", "")) }
-      meet do
-        puts "Compiling Ruby will take a few minutes."
-        shell "rbenv install #{ruby_version}"
-        shell "rbenv rehash"
-      end
-    end
-  end
-end