boxes 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 61968a830b3bc14160ec9f1da648d4d25692e4de
+  data.tar.gz: 9488c5e6f4b90c8f8cbdc163b919cfecfca86a05
+SHA512:
+  metadata.gz: 9055590e48fa44358ecf33105e2329b29383c6ea1dbf2612d1eb8630abcb2c320578d53af38ca32c6cbdf97a3924389fe50bc4be43a08aaeea2f7e9320d44e0a
+  data.tar.gz: a29840bdc11b837c7d53e50c072b8ab28d0a855a54e407c827044a394df078d84f89cbe9774fc6b439e9d5cc37fff129104d3aca028e4cb994fa4e671899129d

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+output-*
+*.box
+packer_cache/

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2.2

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# CHANGELOG
+
+## 2.0.0 (10/10/2015)
+
+* Conversion to being a command line tool distributed through Ruby Gems.
+* Basic test coverage using Specs and Feature tests.
+* Maintains an environment for running builds.
+* Parses, validates and combines arguments.
+* Allows the building of all of the previous styles of boxes.

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Nick Charlton
+
+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,51 @@
+# boxes
+
+[boxes][] takes the complexity out of building custom [Vagrant][] boxes.
+
+It's a command line tool which provides a set of templates and scripts to
+combine as you need. There are also a set of pre-build boxes which are
+regenerated regularly.
+
+## Installation & Requirements
+
+```shell
+[sudo] gem install boxes
+```
+
+boxes leans on [Packer][] and [VirtualBox][], [VMware Fusion][fusion] or
+[VMware Workstation][workstation] for building boxes and these will need to
+available in your `$PATH`.
+
+## Usage
+
+boxes is driven by the `boxes` command line tool, and works with artifacts
+inside it's own working directory. You need to specify a name for the build,
+a template to work with and the output provider. Something like so:
+
+```shell
+boxes build --name=trusty64-empty --template=ubuntu/trusty64 --provider=vmware
+```
+
+This will build a file called `trusty64-empty.box` in the current directory.
+
+There's lots more to `boxes` than building simple empty Vagrant boxes like
+this, which can be see in the inline help.
+
+## Contributing
+
+1. Fork it ( https://github.com/nickcharlton/boxes/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 a new Pull Request
+
+## Author
+
+Copyright (c) 2013 Nick Charlton <nick@nickcharlton.net>
+
+[boxes]: http://boxes.io
+[Vagrant]: http://vagrantup.com
+[Packer]: https://packer.io
+[VirtualBox]: https://www.virtualbox.org
+[fusion]: https://www.vmware.com/products/fusion/features.html
+[workstation]: https://www.vmware.com/products/workstation/features.html

data/Rakefile

@@ -0,0 +1,34 @@
+#!/usr/bin/env rake
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'bundler/gem_tasks'
+
+##
+# Configure the test suite.
+##
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+##
+# Cucumber for feature testing.
+##
+require 'rake/clean'
+require 'cucumber'
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = 'features --format pretty -x'
+  t.fork = false
+end
+
+##
+# By default, just run the tests.
+##
+task default: :spec

data/bin/boxes

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'boxes'
+
+Boxes::Command.run(ARGV)

data/boxes.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'boxes/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'boxes'
+  spec.version       = Boxes::VERSION
+  spec.authors       = ['Nick Charlton']
+  spec.email         = ['nick@nickcharlton.net']
+
+  spec.summary       = 'A command line tool to take the complexity out of '\
+                       'building Vagrant boxes.'
+  spec.description   = <<-EOF
+    boxes takes the complexity out of building custom Vagrant boxes.
+
+    It's a command line tool which provides a set of templates and scripts to
+    combine as you need. There are also a set of pre-build boxes which are
+    regenerated regularly.'
+  EOF
+  spec.homepage      = 'https://github.com/nickcharlton/boxes'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($RS)
+  spec.executables   = spec.files.grep(/^bin/) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)/)
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'claide', '~> 0.9'
+  spec.add_dependency 'colored', '~> 1.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'rake', '~> 10.4'
+  spec.add_development_dependency 'rspec', '~> 3.3'
+  spec.add_development_dependency 'cucumber', '~> 1.3'
+  spec.add_development_dependency 'aruba', '~> 0.8'
+  spec.add_development_dependency 'fakefs', '~> 0.6'
+  spec.add_development_dependency 'pry'
+end

data/features/boxes.feature

@@ -0,0 +1,8 @@
+Feature: We can return the boxes help
+
+  Scenario: A successful response
+    When I run `boxes --help`
+    Then the output should contain "$ boxes"
+    Then the output should contain "Usage:"
+    Then the output should contain "Options:"
+    And the exit status should be 0

data/features/build.feature

@@ -0,0 +1,16 @@
+Feature: We can build boxes
+
+  Scenario: It will error without a name
+    When I run `boxes build --template=ubuntu/trusty64 --provider=vmware`
+    Then the output should contain "[!] A name is required!"
+    And the exit status should be 1
+
+  Scenario: It will error without a provider
+    When I run `boxes build --name=trusty64-standard --template=ubuntu/trusty64`
+    Then the output should contain "[!] A provider is required!"
+    And the exit status should be 1
+
+  Scenario: It will error without a template
+    When I run `boxes build --name=trusty64-standard --provider=vmware`
+    Then the output should contain "[!] A template is required!"
+    And the exit status should be 1

data/features/env.feature

@@ -0,0 +1,18 @@
+Feature: We can manage the boxes environment
+
+  Scenario: It shows the environment by default
+    When I run `boxes env`
+    Then the output should contain "Configuration:"
+    Then the output should contain "Environment Variables:"
+    And the exit status should be 0
+
+  Scenario: It has a show command
+    When I run `boxes env show`
+    Then the output should contain "Configuration:"
+    Then the output should contain "Environment Variables:"
+    And the exit status should be 0
+
+  Scenario: It can clean the environment
+    When I run `boxes env clean`
+    Then the directory named "~/.boxes/env" does not exist
+    And the exit status should be 0

data/features/support/env.rb

@@ -0,0 +1 @@
+require 'aruba/cucumber'

data/lib/boxes.rb

@@ -0,0 +1,28 @@
+require 'fileutils'
+require 'pathname'
+require 'yaml'
+require 'open3'
+require 'erb'
+
+require 'claide'
+require 'colored'
+
+require 'boxes/version'
+require 'boxes/errors'
+require 'boxes/config'
+require 'boxes/subprocess'
+require 'boxes/environment'
+require 'boxes/template'
+require 'boxes/builder'
+require 'boxes/command'
+
+# Toolkit for building Vagrantboxes, VM and cloud images.
+module Boxes
+  class << self
+    attr_reader :config
+
+    def config
+      @config ||= Config.new
+    end
+  end
+end

data/lib/boxes/builder.rb

@@ -0,0 +1,77 @@
+module Boxes
+  # Class which drives the build process.
+  class Builder
+    include Boxes::Errors
+
+    attr_accessor :name, :template, :scripts, :provider
+
+    # Initialise a new build.
+    #
+    # @param env [Boxes::Environment] environment to operate in.
+    # @param args [Hash]
+    # @param template [String] the name of the template.
+    # @param scripts [Array] scripts to include in the build.
+    def initialize(env, args) # rubocop:disable Metrics/MethodLength
+      @name = args[:name] || fail(MissingArgumentError,
+                                  'The name must be specified.')
+      @provider = args[:provider] || fail(MissingArgumentError,
+                                          'The provider must be specified.')
+      template = args[:template] || fail(MissingArgumentError,
+                                         'The template must be specified.')
+      scripts = args.fetch(:scripts, [])
+
+      @template = Template.new(env, template)
+      @scripts = scripts.collect do |c|
+        env.available_scripts.include?(c) ? c : fail(ScriptNotFoundError)
+      end
+    end
+
+    # Run the build.
+    def run # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      original_directory = FileUtils.pwd
+      box_name = ''
+
+      # render the template
+      rendered_template = template.render(name: name,
+                                          provider: provider,
+                                          scripts: scripts)
+
+      # write the template to a file
+      File.open(Boxes.config.working_dir + "#{build_name}.json", 'w') do |f|
+        f.puts rendered_template
+      end
+
+      # execute the packer command
+      FileUtils.chdir(Boxes.config.working_dir)
+      cmd = "packer build #{build_name}.json"
+      status = Subprocess.run(cmd) do |stdout, stderr, _thread|
+        puts stdout unless stdout.nil?
+        puts stderr unless stderr.nil?
+
+        # catch the name of the artifact
+        if stdout =~ /\.box/
+          box_name = stdout.gsub(/[a-zA-Z0-9:\-_]*?\.box/).first
+        end
+      end
+
+      if status.exitstatus == 0
+        FileUtils.mv(Boxes.config.working_dir + box_name,
+                     "#{original_directory}/#{name}.box")
+      else
+        fail BuildRunError,
+             'The build didn\'t complete successfully. Check the logs.'
+      end
+    end
+
+    # Clean any temporary files used during building.
+    def clean
+      FileUtils.rm("#{build_name}.json")
+    end
+
+    private
+
+    def build_name
+      @build_name ||= "#{@name}-#{Time.now.strftime('%Y%m%d%H%M%S')}"
+    end
+  end
+end

data/lib/boxes/command.rb

@@ -0,0 +1,12 @@
+module Boxes
+  # Class which encapsulates the command line handling.
+  class Command < CLAide::Command
+    require 'boxes/command/build'
+    require 'boxes/command/env'
+
+    self.abstract_command = true
+    self.command = 'boxes'
+    self.version = VERSION
+    self.description = 'Toolkit for building Vagrantboxes, VM and cloud images.'
+  end
+end

data/lib/boxes/command/build.rb

@@ -0,0 +1,45 @@
+module Boxes
+  class Command
+    # Command handling for the box building functionality.
+    class Build < Command
+      self.summary = 'Build boxes'
+      self.description = 'Builds boxes using templates and scripts.'
+
+      def self.options
+        [
+          ['--name', 'The name for the build'],
+          ['--provider=[virtualbox|vmware]',
+           'The provider to build the box for'],
+          ['--template', 'Template to build the box with'],
+          ['--scripts', 'Scripts to apply to the box']
+        ].concat(super)
+      end
+
+      def initialize(argv)
+        @build = {}
+        @build[:name] = argv.option('name')
+        @build[:provider] = argv.option('provider')
+        @build[:template] = argv.option('template')
+        scripts = argv.option('scripts') || ''
+        @build[:scripts] = scripts.split(',')
+
+        super
+      end
+
+      def validate!
+        super
+
+        %w(name provider template).each do |key|
+          help! "A #{key} is required!" if @build[key.to_sym].nil?
+        end
+      end
+
+      def run
+        env = Boxes::Environment.new
+        builder = Boxes::Builder.new(env, @build)
+        builder.run
+        builder.clean
+      end
+    end
+  end
+end

data/lib/boxes/command/env.rb

@@ -0,0 +1,50 @@
+module Boxes
+  class Command
+    # Command handling for the environment used for building boxes.
+    class Env < Command
+      self.abstract_command = true
+      self.default_subcommand = 'show'
+
+      self.summary = 'Manage the build environment'
+      self.description = 'Expore the environment that boxes uses for building '\
+                         'inside of.'
+
+      # Prints out the environment and configuration.
+      class Show < Env
+        self.summary = 'Show the environment and configuration'
+        self.description = <<-DESC
+            This lists the environment variables and other parts of the
+            configuration that boxes uses to handle builds.
+        DESC
+
+        def run # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+          puts 'Configuration:'.underline
+          puts ''
+          puts "HOME_DIR=\"#{Boxes.config.home_dir}\""
+          puts "WORKING_DIR=\"#{Boxes.config.working_dir}\""
+          puts "TEMPLATE_PATHS=\"#{Boxes.config.template_paths.join(', ')}\""
+          puts "SCRIPT_PATHS=\"#{Boxes.config.script_paths.join(', ')}\""
+
+          puts ''
+          puts 'Environment Variables:'.underline
+          puts ''
+          Boxes.config.environment_vars.each do |e|
+            puts "#{e.keys.join}=\"#{e.values.join}\""
+          end
+        end
+      end
+
+      # Tidies up the working environment
+      class Clean < Env
+        self.summary = 'Clean up the environment.'
+        self.description = 'Removes any files from the working directory.'
+
+        def run
+          working_dir = Boxes.config.working_dir
+
+          FileUtils.rm_rf(working_dir) if working_dir.exist?
+        end
+      end
+    end
+  end
+end