boxen 0.0.0

data/.gitignore

@@ -0,0 +1,4 @@
+/.bundle
+/.rbenv-version
+/bin
+/boxen-*.gem

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    boxen (0.0.0)
+      ansi (~> 1.4)
+      highline (~> 1.6)
+      json_pure (~> 1.7)
+      octokit (~> 1.15)
+      puppet (~> 3.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.2)
+    ansi (1.4.3)
+    facter (1.6.12)
+    faraday (0.8.4)
+      multipart-post (~> 1.1)
+    faraday_middleware (0.8.8)
+      faraday (>= 0.7.4, < 0.9)
+    hashie (1.2.0)
+    hiera (1.1.0.rc1)
+      json
+    highline (1.6.15)
+    json (1.7.5)
+    json_pure (1.7.5)
+    metaclass (0.0.1)
+    minitest (3.5.0)
+    mocha (0.12.6)
+      metaclass (~> 0.0.1)
+    multi_json (1.3.6)
+    multipart-post (1.1.5)
+    octokit (1.15.1)
+      addressable (~> 2.2)
+      faraday (~> 0.8)
+      faraday_middleware (~> 0.8)
+      hashie (~> 1.2)
+      multi_json (~> 1.3)
+    puppet (3.0.0)
+      facter (>= 1.6.11)
+      hiera (>= 1.0.0rc)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  boxen!
+  minitest (= 3.5.0)
+  mocha (~> 0.12)

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 GitHub, Inc.
+
+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,7 @@
+# Boxen
+
+Manage development boxes with love (and Puppet).
+
+## Contributing
+
+Use the OS X system Ruby (1.8.7). Run `script/tests` often. Open PR's.

data/boxen.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |gem|
+  gem.name          = "boxen"
+  gem.version       = "0.0.0"
+  gem.authors       = ["John Barnette", "Will Farrington"]
+  gem.email         = ["jbarnette@github.com", "wfarr@github.com"]
+  gem.description   = "Manage Mac development boxes with love (and Puppet)."
+  gem.summary       = "You know, for laptops and stuff."
+  gem.homepage      = "https://github.com/boxen/boxen"
+
+  gem.files         = `git ls-files`.split $/
+  gem.test_files    = gem.files.grep /^test/
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "ansi",      "~> 1.4"
+  gem.add_dependency "highline",  "~> 1.6"
+  gem.add_dependency "json_pure", "~> 1.7"
+  gem.add_dependency "octokit",   "~> 1.15"
+  gem.add_dependency "puppet",    "~> 3.0"
+
+  gem.add_development_dependency "minitest", "3.5.0" # pinned for mocha
+  gem.add_development_dependency "mocha", "~> 0.12"
+end

data/lib/boxen/check.rb

@@ -0,0 +1,72 @@
+require "ansi"
+
+module Boxen
+
+  # The superclass for preflight and postflight sanity checks.
+
+  class Check
+
+    # A collection of preflight instances for `config`. An instance is
+    # created for every constant under `self` that's also a
+    # subclass of `self`.
+
+    def self.checks(config)
+      constants.map { |n| const_get n }.
+        select { |c| c < self }.
+        map { |c| c.new config }
+    end
+
+    # Search `dir` and load all Ruby files under it.
+
+    def self.register(dir)
+      Dir["#{dir}/*.rb"].sort.each { |f| load f }
+    end
+
+    # Check each instance against `config`.
+
+    def self.run(config)
+      checks(config).each { |check| check.run unless check.ok? }
+    end
+
+    attr_reader :config
+
+    def initialize(config)
+      @config = config
+    end
+
+    # Is everything good to go? Implemented by subclasses.
+
+    def ok?
+      raise "Subclasses must implement this method."
+    end
+
+    # Warn, fix, or abort. Implemented by subclasses.
+
+    def run
+      raise "Subclasses must implement this method."
+    end
+
+    # A fancier `abort` and `warn`. This will probably really annoy
+    # someone at some point because it's overriding a Kernel method,
+    # but it's limited to checks.
+
+    def abort(message, *extras)
+      extras << { :color => :red }
+      warn message, *extras
+      exit 1
+    end
+
+    def warn(message, *extras)
+      options = Hash === extras.last ? extras.pop : {}
+      color   = options[:color] || :yellow
+
+      $stderr.puts ANSI.send(color) { "--> #{message}" }
+
+      unless extras.empty?
+        extras.each { |line| $stderr.puts "    #{line}" }
+      end
+
+      $stderr.puts
+    end
+  end
+end

data/lib/boxen/cli.rb

@@ -0,0 +1,79 @@
+require "boxen/config"
+require "boxen/flags"
+require "boxen/postflight"
+require "boxen/preflight"
+require "boxen/puppeteer"
+
+module Boxen
+  class CLI
+    attr_reader :config
+    attr_reader :flags
+    attr_reader :puppet
+
+    def initialize(config, flags)
+      @config = config
+      @flags  = flags
+      @puppet = Boxen::Puppeteer.new @config
+    end
+
+    def run
+
+      # --env prints out the current BOXEN_ env vars.
+
+      exec "env | grep ^BOXEN_ | sort" if flags.env?
+
+      # --help prints some CLI help and exits.
+
+      abort "#{flags}\n" if flags.help?
+
+      # --projects prints a list of available projects and exits.
+
+      if flags.projects?
+        config.projects.each do |project|
+          prefix = project.installed? ? "*" : " "
+          puts "#{prefix} #{project.name}"
+        end
+
+        exit
+      end
+
+      status = puppet.run
+
+      return status
+    end
+
+    # Run Boxen by wiring together the command-line flags, config,
+    # preflights, Puppet execution, and postflights. Returns Puppet's
+    # exit code.
+
+    def self.run(*args)
+      config = Boxen::Config.load
+      flags  = Boxen::Flags.new args
+
+      # Apply command-line flags to the config in case we're changing or
+      # overriding anything.
+
+      flags.apply config
+
+      # Run the preflight checks.
+
+      Boxen::Preflight.run config
+
+      # Save the config for Puppet (and next time).
+
+      Boxen::Config.save config
+
+      # Make the magic happen.
+
+      status = Boxen::CLI.new(config, flags).run
+
+      # Run the postflight checks.
+
+      Boxen::Postflight.run config if status.zero?
+
+      # Return Puppet's exit status.
+
+      return status
+    end
+  end
+end

data/lib/boxen/config.rb

@@ -0,0 +1,251 @@
+require "fileutils"
+require "json"
+require "octokit"
+require "boxen/project"
+
+module Boxen
+
+  # All configuration for Boxen, whether it's loaded from command-line
+  # args, environment variables, config files, or the keychain.
+
+  class Config
+
+    # The service name to use when loading/saving config in the Keychain.
+
+    KEYCHAIN_SERVICE = "Boxen"
+
+    # Load config. Yields config if `block` is given.
+
+    def self.load(&block)
+      new do |config|
+        file = "#{config.homedir}/config/boxen/defaults.json"
+
+        if File.file? file
+          attrs = JSON.parse File.read file
+
+          attrs.each do |key, value|
+            if value && config.respond_to?(selector = "#{key}=")
+              config.send selector, value
+            end
+          end
+        end
+
+        cmd = "security find-generic-password " +
+          "-a #{config.user} -s '#{KEYCHAIN_SERVICE}' -w 2>/dev/null"
+
+        password = `#{cmd}`.strip
+        password = nil unless $?.success?
+
+        config.password = password
+
+        yield config if block_given?
+      end
+    end
+
+    # Save `config`. Returns `config`. Note that this only saves data,
+    # not flags. For example, `login` will be saved, but `stealth?`
+    # won't.
+
+    def self.save(config)
+      attrs = {
+        :email     => config.email,
+        :homedir   => config.homedir,
+        :login     => config.login,
+        :name      => config.name,
+        :puppetdir => config.puppetdir,
+        :repodir   => config.repodir,
+        :srcdir    => config.srcdir,
+        :user      => config.user
+      }
+
+      file = "#{config.homedir}/config/boxen/defaults.json"
+      FileUtils.mkdir_p File.dirname file
+
+      File.open file, "wb" do |f|
+        f.write JSON.generate Hash[attrs.reject { |k, v| v.nil? }]
+      end
+
+      cmd = ["security", "add-generic-password",
+             "-a", config.user, "-s", KEYCHAIN_SERVICE, "-U", "-w", config.password]
+
+      unless system *cmd
+        raise Boxen::Error, "Can't save config in the Keychain."
+      end
+
+      config
+    end
+
+    # Create a new instance. Yields `self` if `block` is given.
+
+    def initialize(&block)
+      @fde  = true
+      @pull = true
+
+      yield self if block_given?
+    end
+
+    # Create an API instance using the current user creds. A new
+    # instance is created any time `login` or `password` change.
+
+    def api
+      @api ||= Octokit::Client.new :login => login, :password => password
+    end
+
+    # Spew a bunch of debug logging? Default is `false`.
+
+    def debug?
+      !!@debug
+    end
+
+    attr_writer :debug
+
+    def dirty?
+      `git status --porcelain`.strip.empty?
+    end
+
+    # A GitHub user's public email.
+
+    attr_accessor :email
+
+    # The shell script that loads Boxen's environment.
+
+    def envfile
+      "#{homedir}/env.sh"
+    end
+
+    # Is full disk encryption required? Default is `true`. Respects
+    # the `BOXEN_NO_FDE` environment variable.
+
+    def fde?
+      !ENV["BOXEN_NO_FDE"] && @fde
+    end
+
+    attr_writer :fde
+
+    # Boxen's home directory. Default is `"/opt/boxen"`. Respects the
+    # `BOXEN_HOME` environment variable.
+
+    def homedir
+      @homedir || ENV["BOXEN_HOME"] || "/opt/boxen"
+    end
+
+    attr_writer :homedir
+
+    # Boxen's log file. Default is `"#{repodir}/log/boxen.log"`.
+    # Respects the `BOXEN_LOG_FILE` environment variable. The log is
+    # overwritten on every run.
+
+    def logfile
+      @logfile || ENV["BOXEN_LOG_FILE"] || "#{repodir}/log/boxen.log"
+    end
+
+    attr_writer :logfile
+
+    # A GitHub user login. Default is `nil`.
+
+    attr_reader :login
+
+    def login=(login)
+      @api = nil
+      @login = login
+    end
+
+    # Is Boxen running on the `master` branch?
+
+    def master?
+      `git symbolic-ref HEAD`.chomp == "refs/heads/master"
+    end
+
+    # A GitHub user's profile name.
+
+    attr_accessor :name
+
+    # A GitHub user password. Default is `nil`.
+
+    attr_reader :password
+
+    def password=(password)
+      @api = nil
+      @password = password
+    end
+
+    # Just go through the motions? Default is `false`.
+
+    def pretend?
+      !!@pretend
+    end
+
+    attr_writer :pretend
+
+    # Run a profiler on Puppet? Default is `false`.
+
+    def profile?
+      !!@profile
+    end
+
+    attr_writer :profile
+
+    # An Array of Boxen::Project entries, one for each project Boxen
+    # knows how to manage.
+    #
+    # FIX: Revisit this once we restructure template projects. It's
+    # broken for several reasons: It assumes paths that won't be
+    # right, and it assumes projects live in the same repo as this
+    # file.
+
+    def projects
+      files = Dir["#{repodir}/modules/projects/manifests/*.pp"]
+      names = files.map { |m| File.basename m, ".pp" }.sort
+
+      names.map do |name|
+        Boxen::Project.new "#{srcdir}/#{name}"
+      end
+    end
+
+    # The directory where Puppet expects configuration (which we don't
+    # use) and runtime information (which we generally don't care
+    # about). Default is `/tmp/boxen/puppet`. Respects the
+    # `BOXEN_PUPPET_DIR` environment variable.
+
+    def puppetdir
+      @puppetdir || ENV["BOXEN_PUPPET_DIR"] || "/tmp/boxen/puppet"
+    end
+
+    attr_writer :puppetdir
+
+    # The directory of the custom Boxen repo for an org. Default is
+    # `Dir.pwd`. Respects the `BOXEN_REPO_DIR` environment variable.
+
+    def repodir
+      @repodir || ENV["BOXEN_REPO_DIR"] || Dir.pwd
+    end
+
+    attr_writer :repodir
+
+    # The directory where repos live. Default is
+    # `"/Users/#{user}/src"`.
+
+    def srcdir
+      @srcdir || "/Users/#{user}/src"
+    end
+
+    attr_writer :srcdir
+
+    # Don't auto-create issues on failure? Default is `false`.
+    # Respects the `BOXEN_NO_ISSUE` environment variable.
+
+    def stealth?
+      !!ENV["BOXEN_NO_ISSUE"] || @stealth
+    end
+
+    attr_writer :stealth
+
+    # A local user login. Default is the `USER` environment variable.
+
+    def user
+      @user || ENV["USER"]
+    end
+
+    attr_writer :user
+  end
+end