boxen-halyard 2.8.0.akerl9

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ac8e5374a808cca4dfea64707dce54651817b3c0
+  data.tar.gz: a3d4f295176a14dcc4db0f96be0220b8cb90cc28
+SHA512:
+  metadata.gz: c36e553d2f89ff62f98d6c0950f279ba569f7f45200d3a002c634cc75d5666a2932127a228901742d07af5a53d412b520db2ada93b232e41a00159551414fe8d
+  data.tar.gz: e6c42c58500bba2a6ca01c080a8bfd1dd5a8531c9f633508a155808b4de908ab8ef5b3e669865c3ae6f7ad1656ce05aaa80411ebc9cfab394381688d17f07dca

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle
+/.env.local.rb
+/.projects
+/.rbenv-version
+/Gemfile.lock
+/bin
+/boxen-*.gem
+/log
+/puppet
+/script/Boxen.dSYM
+/.ruby-version
+/pkg/

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

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,64 @@
+boxen
+==========
+
+[![Dependency Status](https://img.shields.io/gemnasium/halyard/boxen.svg)](https://gemnasium.com/halyard/boxen)
+[![Build Status](https://img.shields.io/circleci/project/halyard/boxen.svg)](https://circleci.com/gh/halyard/boxen)
+[![Coverage Status](https://img.shields.io/codecov/c/github/halyard/boxen.svg)](https://codecov.io/github/halyard/boxen)
+[![Code Quality](https://img.shields.io/codacy/51f97f9fdf8b45caa259ccbfa132164e.svg)](https://www.codacy.com/app/akerl/boxen)
+[![MIT Licensed](https://img.shields.io/badge/license-MIT-green.svg)](https://tldrlegal.com/license/mit-license)
+
+Manage Mac development boxes with love (and Puppet).
+
+## Changes from upstream
+
+* Switched to CircleCI builds
+* Update dependency versions, specifically targeting Puppet 4
+* Create a GitHub token with admin:public_key access
+* Add the verbose flag if run with debug enabled
+
+## Rules for Services
+
+0. Run on a nonstandard port, usually default port + 1000 or 10000.
+
+0. Install with a custom Boxen homebrew formula.
+
+0. Suffix the Homebrew package's version, starting with `-boxen1`.
+
+0. Run as a launchd service in the `dev` namespace, e.g.,
+   `dev.dnsmasq`.
+
+0. Store config, data, and log files in
+   `$BOXEN_HOME/{config,data,log}`. This will normally require
+   customization of a service's Homebrew formula.
+
+Sometimes it's not possible to follow these rules, but try hard.
+
+## Projects from the CLI
+
+We use a totally awful hack to do from-the-cli project installs of projects.
+We create a file in "$BOXEN_HOME/repodir" called .projects, with a single line.
+That line is made up of projects separated by commas.
+We then read that into a Puppet fact in Puppet-land, and that checks for
+classes that match those project names, and includes them in the catalog.
+
+We can't pass a `FACTER_` env var because sudo has `env_reset`
+and we can't just modify the sudoers file due to a chicken-egg problem.
+
+## Hooks
+
+0. All hooks must be in the namespace `Boxen::Hook::MyThing`.
+
+0. All hooks must subclass from `Boxen::Hook`
+
+0. All hooks must provide a private instance method `required_environment_variables` that returns an array with at least one entry.
+
+0. All hooks must provide a private instance method `#call`.
+
+## Contributing
+
+Use the OS X system Ruby (1.8.7 or 2.0.0). Run `script/tests` often. Open PR's.
+Use the CI.
+
+## Halp!
+
+Use Issues or #boxen on irc.freenode.net.

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+desc 'Run tests'
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Run Rubocop on the gem'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['lib/**/*.rb', 'spec/**/*.rb']
+  task.fail_on_error = true
+end
+
+task default: [:spec, :build, :install]

data/boxen.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+#
+
+Gem::Specification.new do |gem|
+  gem.name          = "boxen-halyard"
+  gem.version       = "2.8.0.akerl9"
+  gem.authors       = ["John Barnette", "Will Farrington", "David Goodlad", "Mike McQuaid"]
+  gem.email         = ["jbarnette@github.com", "wfarr@github.com", "dgoodlad@github.com", "mikemcquaid@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/halyard/boxen"
+  gem.license       = 'MIT'
+
+  gem.files         = `git ls-files`.split $/
+  gem.test_files    = gem.files.grep /^test/
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'ansi', '~> 1.5.0'
+  gem.add_dependency 'highline', '~> 1.7.0'
+  gem.add_dependency 'json_pure', '~> 1.8.0'
+  gem.add_dependency 'librarian-puppet', '~> 2.2.0'
+  gem.add_dependency 'octokit', '~> 4.2.0'
+  gem.add_dependency 'puppet', '~> 4.3.0'
+
+  gem.add_development_dependency 'rubocop', '~> 0.35.0'
+  gem.add_development_dependency 'rake', '~> 10.4.0'
+  gem.add_development_dependency 'codecov', '~> 0.1.1'
+  gem.add_development_dependency 'rspec', '~> 3.4.0'
+  gem.add_development_dependency 'fuubar', '~> 2.0.0'
+end

data/circle.yml

@@ -0,0 +1,8 @@
+dependencies:
+  override:
+    - 'rvm-exec 2.0.0-p645 bundle install'
+    - 'rvm-exec 2.2.3 bundle install'
+test:
+  override:
+    - 'rvm-exec 2.0.0-p645 bundle exec rake'
+    - 'rvm-exec 2.2.3 bundle exec rake'

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/checkout.rb

@@ -0,0 +1,25 @@
+module Boxen
+  class Checkout
+    attr_reader :config
+
+    def initialize(config)
+      @config = config
+    end
+
+    def sha
+      Dir.chdir(config.repodir) { `git rev-parse HEAD`.strip }
+    end
+
+    def master?
+      Dir.chdir(config.repodir) { `git symbolic-ref HEAD`.strip == 'refs/heads/master' }
+    end
+
+    def dirty?
+      !changes.empty?
+    end
+
+    def changes
+      Dir.chdir(config.repodir) { `git status --porcelain`.strip }
+    end
+  end
+end

data/lib/boxen/cli.rb

@@ -0,0 +1,61 @@
+require "boxen/config"
+require "boxen/flags"
+require "boxen/postflight"
+require "boxen/preflight"
+require "boxen/runner"
+require "boxen/util"
+
+module Boxen
+  class CLI
+    attr_reader :config
+    attr_reader :flags
+    attr_reader :runner
+
+    def initialize(config, flags)
+      @config = config
+      @flags  = flags
+      @runner = Boxen::Runner.new(@config, @flags)
+    end
+
+    def run
+      if flags.help?
+        puts flags
+        exit
+      end
+
+      runner.run
+    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
+
+      if flags.run?
+        # Run the preflight checks.
+        Boxen::Preflight.run config
+
+        # Save the config for Puppet (and next time).
+        Boxen::Config.save config
+      end
+
+      # Make the magic happen.
+      status = Boxen::CLI.new(config, flags).run
+
+      if flags.run?
+        # Run the postflight checks.
+        Boxen::Postflight.run config if status.success?
+      end
+
+      # Return Puppet's exit status.
+      return status.code
+    end
+  end
+end

data/lib/boxen/config.rb

@@ -0,0 +1,330 @@
+require "boxen/keychain"
+require "boxen/project"
+require "fileutils"
+require "json"
+require "octokit"
+require "shellwords"
+
+module Boxen
+
+  # All configuration for Boxen, whether it's loaded from command-line
+  # args, environment variables, config files, or the keychain.
+
+  class Config
+    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.nil? && config.respond_to?(selector = "#{key}=")
+              config.send selector, value
+            end
+          end
+        end
+
+        keychain        = Boxen::Keychain.new config.login, config.user
+        config.token    = keychain.token
+
+        if config.enterprise?
+          # configure to talk to GitHub Enterprise
+          Octokit.configure do |c|
+            c.api_endpoint = "#{config.ghurl}/api/v3"
+            c.web_endpoint = config.ghurl
+          end
+        end
+
+        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,
+        :fde          => config.fde?,
+        :homedir      => config.homedir,
+        :login        => config.login,
+        :name         => config.name,
+        :puppetdir    => config.puppetdir,
+        :repodir      => config.repodir,
+        :reponame     => config.reponame,
+        :ghurl        => config.ghurl,
+        :srcdir       => config.srcdir,
+        :user         => config.user,
+        :repotemplate => config.repotemplate,
+        :s3host       => config.s3host,
+        :s3bucket     => config.s3bucket
+      }
+
+      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
+
+      keychain          = Boxen::Keychain.new config.login, config.user
+      keychain.token    = config.token
+
+      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 `token` changes.
+
+    def api
+      @api ||= Octokit::Client.new :login => token, :password => 'x-oauth-basic'
+    end
+
+    # Spew a bunch of debug logging? Default is `false`.
+
+    def debug?
+      !!@debug
+    end
+
+    attr_writer :debug
+
+    # 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_accessor :login
+
+    # A GitHub user's profile name.
+
+    attr_accessor :name
+
+    # 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
+
+    # Enable the Puppet future parser? Default is `false`.
+
+    def future_parser?
+      !!@future_parser
+    end
+
+    attr_writer :future_parser
+
+    # Enable puppet reports ? Default is `false`.
+
+    def report?
+      !!@report
+    end
+
+    attr_writer :report
+
+    # Enable generation of dependency graphs.
+
+    def graph?
+      !!@graph
+    end
+
+    attr_writer :graph
+
+    # 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 repo on GitHub to use for error reports and automatic
+    # updates, in `owner/repo` format. Default is the `origin` of a
+    # Git repo in `repodir`, if it exists and points at GitHub.
+    # Respects the `BOXEN_REPO_NAME` environment variable.
+
+    def reponame
+      override = @reponame || ENV["BOXEN_REPO_NAME"]
+      return override unless override.nil?
+
+      if File.directory? repodir
+        ghuri = URI(ghurl)
+        url = Dir.chdir(repodir) { `git config remote.origin.url`.strip }
+
+        # find the path and strip off the .git suffix
+        repo_exp = Regexp.new Regexp.escape(ghuri.host) + "[/:]([^/]+/[^/]+)"
+        if $?.success? && repo_exp.match(url)
+          @reponame = $1.sub /\.git$/, ""
+        end
+      end
+    end
+
+    attr_writer :reponame
+
+    # GitHub location (public or GitHub Enterprise)
+
+    def ghurl
+      @ghurl || ENV["BOXEN_GITHUB_ENTERPRISE_URL"] || "https://github.com"
+    end
+
+    attr_writer :ghurl
+
+    # Repository URL template (required for GitHub Enterprise)
+
+    def repotemplate
+      default = 'https://github.com/%s'
+      @repotemplate || ENV["BOXEN_REPO_URL_TEMPLATE"] || default
+    end
+
+    attr_writer :repotemplate
+
+    # Does this Boxen use a GitHub Enterprise instance?
+
+    def enterprise?
+      ghurl != "https://github.com"
+    end
+
+    # The directory where repos live. Default is
+    # `"/Users/#{user}/src"`.
+
+    def srcdir
+      @srcdir || ENV["BOXEN_SRC_DIR"] || "/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 GitHub OAuth token. Default is `nil`.
+
+    attr_reader :token
+
+    def token=(token)
+      @token = token
+      @api = nil
+    end
+
+    # A local user login. Default is the `USER` environment variable.
+
+    def user
+      @user || ENV["USER"]
+    end
+
+    attr_writer :user
+
+    def color?
+      @color
+    end
+
+    attr_writer :color
+
+    # The S3 host name. Default is `"s3.amazonaws.com"`.
+    # Respects the `BOXEN_S3_HOST` environment variable.
+
+    def s3host
+      @s3host || ENV["BOXEN_S3_HOST"] || "s3.amazonaws.com"
+    end
+
+    attr_writer :s3host
+
+    # The S3 bucket name. Default is `"boxen-downloads"`.
+    # Respects the `BOXEN_S3_BUCKET` environment variable.
+
+    def s3bucket
+      @s3bucket || ENV["BOXEN_S3_BUCKET"] || "boxen-downloads"
+    end
+
+    attr_writer :s3bucket
+  end
+end