boxci 0.0.30

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a475fe47696c8556909205cd4298df0c1daff83f
+  data.tar.gz: c13165f012d2e9baeace5c45c4fc6ff8d4432df5
+SHA512:
+  metadata.gz: d95af11773c6c3c0f56a663d976b8b708e62f17fcf31f408ddc6058e9274aaa3031e6a7bcdbcf614eaa85a2f6fb0372518e5afd54bb177b982bb47d53efc37fb
+  data.tar.gz: a3ed46d45eb0bfa6f2d6d1bad7716611bd5bc3d520bd893f23174d2395a4c74d0449f2b026ceda0544058a0af0edc192bf65bba88d9b7914d76046efd2bc5b65

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store
+.vagrant

data/.ruby-version

@@ -0,0 +1 @@
+2.1.0

data/CHANGELOG.md

@@ -0,0 +1,146 @@
+# ChangeLog
+
+The following are lists of the notable changes included with each release.
+This is intended to help keep people informed about notable changes between
+versions as well as provide a rough history.
+
+#### Next Release
+
+#### v0.0.30
+
+- Renamed project from `shanty` to `boxci`
+- Moved all `TODO.txt` items to GitHub Issues
+- Corrected author emails in the gemspec
+
+#### v0.0.29
+
+- Made Initializer not inherit from Thor
+- Made Bulder not inherit from Thor
+- Made Tester not inherit from Thor
+
+#### v0.0.28
+
+- Remove vagrant debugging from test subcommand cleanup
+
+#### v0.0.27
+
+- Included stderr on test subcomand cleanup logging
+
+#### v0.0.26
+
+- Added logging to the test subcommand cleanup
+
+#### v0.0.25
+
+- Moved workspace cleanup dir rm out of workspace folder block
+
+#### v0.0.24
+
+- Hid output of cleanup commands
+
+#### v0.0.23
+
+- Set SIGPIPE handler to `SIG_IGN`
+
+#### v0.0.22
+
+- Cleaned up hackish logging a bit
+
+#### v0.0.21
+
+- Switched rescue exception handling to StandardError
+
+#### v0.0.20
+
+- Added better exception logging
+
+#### v0.0.19
+
+- Added Errno::EPIPE swallowing in SIGTERM handler
+
+#### v0.0.18
+
+- Added rescue handler for cleanup in SIGTERM handler
+
+#### v0.0.17
+
+- Added Errno::EPIPE exception swallowing
+
+#### v0.0.16
+
+- Added Tester globalish exception logging
+
+#### v0.0.15
+
+- Fix few issues with the hack logging from `v0.0.14`
+
+#### v0.0.14
+
+- Added hack logging to verify signal handling
+
+#### v0.0.13
+
+- Added SIGPIPE swallowing to handle CI servers that kill stdout & stderr on
+  build stop.
+
+#### v0.0.12
+
+- Remove top level exception handler
+
+#### v0.0.11
+
+- Wrapped test subcommand with unhandled exception handler
+
+#### v0.0.10
+
+- Added `--version` option to shanty
+
+#### v0.0.9
+
+- Added SIGTINT handler to run cleanup in test subcommand
+- Added SIGTERM handler to run cleanup in test subcommand
+
+#### v0.0.8
+
+- Reworked init subcommand's provider option to match test subcommand
+- Made it default to empty global config if not found
+- Remove all the puts debugging added in v0.0.5 for Bamboo
+- Add rake version constraint to gemspec
+
+#### v0.0.7
+
+- Made exceptino handler re-raise so thor exits when an exception happens
+
+#### v0.0.6
+
+- Added exception reporting around the initial config load in tester
+
+#### v0.0.5
+
+- Added puts around everything to see what was happening in Bamboo
+
+#### v0.0.4
+
+- Replaced test subcommand with puts to verify in Bamboo
+
+#### v0.0.3
+
+- Added thor exit on failure
+
+#### v0.0.2
+
+- Fixed bug where openstack node names had underscores
+- Added artifact gathering and downloading
+- Added `box_size` option to the `.shanty.yml`
+- Fixed multiple script hook calls bug
+- Made vagrant destroy forced so it doesn't prompt the user
+- Fixed cd'ing issue before untar of code
+- Bubble up exit code from test suite
+- Added new test runner generator
+- Added basic config permutations handling for rbenv
+- Made virtualbox the default provider
+- Added virtualbox support so can test things locally
+
+#### v0.0.1
+
+- Initial release

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in shanty.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 ReachLocal, Inc.
+
+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,118 @@
+# boxci: standardizing virtual development & ci environments
+
+Boxci makes creating a virtualized development & continuous integration
+environments as easy as possible.
+
+It does this by focusing on implementing standards around the use of 
+[Vagrant](http://www.vagrantup.com/) for managing your development
+and continuous integration environment. This means that it helps you
+configure and setup [Vagrant](http://www.vagrantup.com/), generate a well
+structured initial puppet manifest, and handles spinning up your puppet
+managed continuous integration environment up in the cloud and running your
+automated test suites.
+
+## Installation
+
+Install it by running the following:
+
+    $ gem install boxci
+
+## Set up your project
+
+Setting a new or existing project up with Boxci is done with the following
+steps.
+
+1. Setup initial `boxci` configs & skeletons
+2. Update the generated configs
+3. Build your base `boxci` puppet manifest
+4. Iterate on your `boxci` puppet manifest
+5. Run your test suite using `boxci`
+
+### Setup initial boxci configs & skeletons
+
+To *boxcify* your project you need to run the `boxci init <language>` command.
+This command will create an initial `.boxci.yml` config for you in the current
+working directory. Therefore, you should run this command from the root of
+your project. It will also handle creating your user level `boxci`
+configurations in the `~/.boxci` direcotry. An example of this can be seen as
+follows:
+
+    $ boxci init ruby
+
+*Note:* The above will create user level configs using the default provider
+`virtualbox`. If you want to use `boxci` always with a cloud provider simply
+rerun the `init` command specifying one of the supported providers. The
+following is an example:
+
+    $ boxci init -p openstack ruby
+
+This will go through and setup the proper directory stucture and create the
+config files just as before. However, when it identifies conflicts with the
+existing files it will prompt you and ask you if you want to overwrite, diff
+the files, not overwrite, etc.
+
+This means that you can rerun the command over and over again and not worry
+about it overwriting your configs unless you tell it too. This is also useful
+in the scenarios where a new version of `boxci` has come out and added config
+options because then you can rerun it and choose to diff them to see what was
+added.
+
+### Update the generated configs
+
+Now that the initial configs and skeleton have been generated. We need to go
+through the configs and update them.
+
+### Build your base Boxci
+
+### Iterate on your Boxci
+
+### Run your Test Suite using Boxci
+
+To run your automated test suite in the cloud or locally in a `boxci` managed
+virtual machine simply run the following from the project's root directory.
+
+    $ boxci test
+
+To see more output on what is happening, pass the "-v" flag for verbose:
+
+    $ boxci test -v
+
+For details on other options you can set for test runs run the following
+command:
+
+    $ boxci help test
+
+## Get Help
+
+`boxci` provides a useful help system within the command line tool. You can
+see these messages by using the help command as follows:
+
+    $ boxci help
+
+The above shows you the top level `boxci help` including a break down of it's
+subcommands. You can get detailed help on each subcommand by running the
+following:
+
+    $ boxci help SUBCOMMAND
+
+For example if you wanted the detailed help on `init` you would run the
+following:
+
+    $ boxci help init
+
+## Config Breakdown
+
+### .boxci.yml
+
+After initializing, you need to configure the `.boxci.yml` in the root of your
+project.
+
+See the generated `.boxci.yml` file for help with configuration.
+
+## Contributing
+
+1. Fork it ( http://github.com/reachlocal/boxci/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+
+# Add a simple console for debugging.
+#
+# Start it with:
+# bundle exec rake console
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'shanty'
+  ARGV.clear
+  IRB.start
+end

data/bin/boxci

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift ::File.expand_path(::File.dirname(__FILE__) + '/../lib')
+
+require "boxci"
+
+Boxci::CLI.start

data/boxci.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'boxci/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "boxci"
+  spec.version       = Boxci::VERSION
+  spec.authors       = ["Andrew De Ponte", "Brian Miller", "Russell Cloak"]
+  spec.email         = ["cyphactor@gmail.com", "brimil01@gmail.com", "russcloak@gmail.cm"]
+  spec.summary       = %q{Tool simplifying Vagrant based development & continuous integration environments.}
+  spec.description   = %q{Boxci is focused on defining standards and building tooling around using Vagrant for development & continuous integration environments to make using them as easy as possible.}
+  spec.homepage      = "http://github.com/reachlocal/boxci"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "thor", "~> 0.18"
+  spec.add_runtime_dependency "net-ssh", "~> 2.7"
+  spec.add_runtime_dependency "net-scp", "~> 1.1"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rspec", "~> 2.14"
+  spec.add_development_dependency "rake", "~> 10.1"
+end

data/lib/boxci/builder.rb

@@ -0,0 +1,29 @@
+require "thor"
+
+module Boxci
+  class Builder
+    include Thor::Base
+    include Thor::Actions
+
+    source_root(File.dirname(__FILE__))
+
+    def build
+      generate_project_vagrantfile
+      generate_starter_puppet_manifest
+    end
+
+    def generate_project_vagrantfile
+      dependency_checker = Boxci::DependencyChecker.new
+      dependency_checker.verify_boxci_config
+
+      @project_config = Boxci.project_config
+      template "templates/Vagrantfile", File.join(Boxci.project_path, "Vagrantfile")
+    end
+
+    def generate_starter_puppet_manifest
+      directory "templates/puppet", File.join(Boxci.project_path, "puppet")
+      language = Boxci::LanguageFactory.build(Boxci.project_config.language)
+      language.generate_starter_puppet_manifest
+    end
+  end
+end

data/lib/boxci/cli.rb

@@ -0,0 +1,70 @@
+module Boxci
+  class CLI < Thor
+    include Thor::Actions
+    
+    DEFAULT_PROVIDER='virtualbox'
+    DEFAULT_REVISION='HEAD'
+
+    desc "init [-p PROVIDER] LANGUAGE", "Initializes boxci in the present working directory"
+    long_desc <<-LONGDESC
+      `boxci init [-p PROVIDER] LANGUAGE` will create a .boxci directory in
+      your user's home directory, create a provider specific config (ex:
+      ~/.boxci/providers/virtualbox.yml), set the default provider in
+      (~/.boxci/global_config.yml), and create a project config (.boxci.yml)
+      in the current working directory.
+
+      LANGUAGE is required, it is the language of your project, see supported
+      languages below.
+
+      --provider (-p) is optional. If omitted, it will use your configured
+      default provider (#{Boxci.default_provider}). If you don't have a
+      default provider configured it will default to '#{DEFAULT_PROVIDER}'.
+
+      Supported Languages: #{Boxci::Language.supported_languages.join(", ")}
+      \005Supported Providers: #{Boxci::Provider.supported_providers.join(", ")}
+    LONGDESC
+    option :provider, :type => :string, :aliases => "-p", :default => Boxci.default_provider
+    def init(language)
+      initializer = Boxci::Initializer.new
+      initializer.init(language, options['provider'])
+    end
+
+    desc "build", "Generates Vagrantfile & starter Puppet manifest"
+    long_desc <<-LONGDESC
+      `boxci build` will interpret your project config (.boxci.yml) and create
+      a starting Vagrantfile and puppet setup in the current working directory.
+    LONGDESC
+    def build
+      builder = Boxci::Builder.new
+      builder.build
+    end
+
+    desc "test [-v] [-p PROVIDER] [REVISION]", "Spins up the boxci, runs the tests, then destroys the boxci"
+    long_desc <<-LONGDESC
+      `boxci test [-v] [-p PROVIDER] [REVISION]` will spin up a new VM using
+      the PROVIDER and run the given test steps against the REVISION.
+
+      --verbose (or -v) is optional. If added, there will be much more output
+      a lot of debugging information, as well as explain exactly which commands
+      are being run.
+
+      --provider (-p) is optional. If omitted, it will use your configured
+      default provider (#{Boxci.default_provider}). If you don't have a
+      default provider configured it will default to '#{DEFAULT_PROVIDER}'.
+
+      REVISION is optional, and if omitted will default to '#{DEFAULT_REVISION}'.
+    LONGDESC
+    option :verbose, :type => :boolean, :aliases => "-v"
+    option :provider, :type => :string, :aliases => "-p", :default => Boxci.default_provider
+    def test(revision=DEFAULT_REVISION)
+      tester = Boxci::Tester.new
+      tester.test(options.merge({"revision" => revision}))
+    end
+
+    map "--version" => :version
+    desc "--version", "Output the version of boxci being executed"
+    def version
+      puts "v#{Boxci::VERSION}"
+    end
+  end
+end

data/lib/boxci/config_permutation.rb

@@ -0,0 +1,15 @@
+module Boxci
+  class ConfigPermutation
+    def initialize(components)
+      @components = components
+    end
+
+    def switch_to_script
+      component_scripts = []
+      @components.each do |component|
+        component_scripts << component.switch_to_script
+      end
+      return component_scripts.join("\n")
+    end
+  end
+end

data/lib/boxci/config_permutation_component.rb

@@ -0,0 +1,11 @@
+module Boxci
+  class ConfigPermutationComponent
+    def initialize(val)
+      @val = val
+    end
+
+    def switch_to_script
+      raise Boxci::PureVirtualMethod, "'switch_to_script' must be implemented by Boxci::ConfigPermutationComponent classes."
+    end
+  end
+end

data/lib/boxci/config_permutation_component_factory.rb

@@ -0,0 +1,7 @@
+module Boxci
+  module ConfigPermutationComponentFactory
+    def self.build(key, val)
+      Boxci::ConfigPermutationComponents.const_get(key.capitalize).new(val)
+    end
+  end
+end

data/lib/boxci/config_permutation_components/rbenv.rb

@@ -0,0 +1,13 @@
+module Boxci
+  module ConfigPermutationComponents
+    class Rbenv < Boxci::ConfigPermutationComponent
+      def switch_to_script
+        <<SCRIPT
+echo "Switching to ruby #{@val}"
+rbenv local #{@val}
+echo "Swithed to ruby `ruby --version`"
+SCRIPT
+      end
+    end
+  end
+end

data/lib/boxci/dependency_checker.rb

@@ -0,0 +1,55 @@
+module Boxci
+  class DependencyChecker < Thor
+    include Thor::Actions
+
+    no_commands do
+      def verify_all
+        begin
+          self.verify_vagrant
+          self.verify_cloud_provider_config
+          self.verify_repo_puppet_directory
+          self.verify_vagrantfile
+          # List other dependencies here
+        rescue Boxci::MissingDependency => e
+          puts e.message
+          exit
+        end
+      end
+
+      def verify_vagrant
+        if !system("which vagrant > /dev/null")
+          raise Boxci::MissingDependency, "It looks like you don't have Vagrant installed. Please install it now with: \"brew install vagrant\""
+        end
+      end
+
+      def verify_cloud_provider_config
+        if !File.exists?(File.join(File.expand_path(ENV["HOME"]), ".boxci", "cloud_provider_config.yml"))
+          raise Boxci::MissingDependency, "It looks like you don't have the Cloud Provider Config setup. Generate an example with: \"boxci generate cloud_provider_config\""
+        end
+      end
+
+      def verify_repo_puppet_directory
+        puppet_directory = File.join(Boxci.project_path, "puppet")
+        error_message = "It looks like you don't have Puppet files setup for your repository. You can generate example files by running: \"boxci init\""
+
+        if !File.directory?(puppet_directory)
+          raise Boxci::MissingDependency, error_message
+        end
+      end
+
+      def verify_vagrantfile
+        vagrant_file = File.join(Boxci.project_path, "Vagrantfile")
+        if !File.exists?(vagrant_file)
+          raise Boxci::MissingDependency, "It looks like you don't have a Vagrantfile setup for your repository. You can generate an example file by running: \"boxci generate vagrantfile\" "
+        end
+      end
+
+      def verify_boxci_config
+        config_file = File.join(Boxci.project_path, ".boxci.yml")
+        if !File.exists?(config_file)
+          raise Boxci::MissingDependency, "It looks like you're missing the Boxci configuration file. You can generate an example file by running: \"boxci init\" "
+        end
+      end
+    end
+  end
+end

data/lib/boxci/global_config.rb

@@ -0,0 +1,26 @@
+module Boxci
+  class GlobalConfig
+    def initialize
+      @global_config = {}
+    end
+
+    def load
+      @global_config.merge!(read_global_config_hash)
+    end
+
+    def default_provider
+      @global_config['default_provider']
+    end
+
+    private
+
+    def read_global_config_hash
+      global_config_path = File.join(ENV['HOME'], '/.boxci/global_config.yml')
+      if File.exist?(global_config_path)
+        global_config = YAML::load_file(global_config_path)
+      else
+        global_config = {}
+      end
+    end
+  end
+end

data/lib/boxci/initializer.rb

@@ -0,0 +1,41 @@
+require "thor"
+
+module Boxci
+  class Initializer
+    include Thor::Base
+    include Thor::Actions
+    source_root(File.dirname(__FILE__))
+
+    def init(language, provider)
+      create_provider_config(provider)
+      set_default_provider(provider)
+      create_project_config(language)
+    end
+
+    def create_provider_config(provider)
+      template "templates/providers/#{provider}.yml.tt", "~/.boxci/providers/#{provider}.yml"
+    end
+
+    # TODO: Change this name to create_global_config
+    def set_default_provider(provider)
+      @provider = provider
+      template "templates/boxci/global_config.yml.tt", "~/.boxci/global_config.yml"
+    end
+
+    def create_project_config(language)
+      boxci_file = File.join(Boxci.project_path, ".boxci.yml")
+      @language = language
+      @current_ruby_version = dot_ruby_version
+      template "templates/dot_boxci.yml.tt", boxci_file
+    end
+
+    def dot_ruby_version
+      dot_ruby_version_file_path = File.join(Boxci.project_path, ".ruby-version")
+      return nil unless File.exist?(dot_ruby_version_file_path)
+      dot_ruby_version_content = File.read(dot_ruby_version_file_path).strip
+      if dot_ruby_version_content =~ /(?:ruby-)?(\d+\.\d+\.\d+(?:-p\d+)?)(?:@[\w\-]+)?/
+        return $1
+      end
+    end
+  end
+end

data/lib/boxci/language.rb

@@ -0,0 +1,35 @@
+module Boxci
+  class Language < Thor
+    include Thor::Actions
+
+    no_commands do
+      def self.source_root
+        File.dirname(__FILE__)
+      end
+
+      def self.supported_languages
+        @@supported_languages ||= []
+      end
+
+      def self.inherited(subclass)
+        self.supported_languages << subclass.to_s.split('::').last.downcase
+      end
+
+      def before_permutation_switch
+        ""
+      end
+
+      def after_permutation_switch
+        ""
+      end
+
+      def default_script
+        raise ::Boxci::PureVirtualMethod, "'default_script' must be implemented on Boxci::Language subclasses"
+      end
+
+      def generate_starter_puppet_manifest
+        raise ::Boxci::PureVirtualMethod, "'generate_starter_puppet_manifest' must be implemented on Boxci::Language subclasses"
+      end
+    end
+  end
+end