boxen23 3.1.3a

data/script/build-keychain-helper

@@ -0,0 +1,6 @@
+#!/bin/sh
+
+set -e
+
+cd $(dirname "$0")/..
+cc -g -O2 -Wall -framework Security -framework CoreFoundation -mmacosx-version-min=10.6 -o script/Boxen src/keychain-helper.c

data/script/release

@@ -0,0 +1,38 @@
+#!/bin/sh
+# Tag and push a release.
+
+set -e
+
+# Make sure we're in the project root.
+
+cd $(dirname "$0")/..
+
+# Build a new gem archive.
+
+rm -rf boxen-*.gem
+gem build -q boxen.gemspec
+
+# Make sure we're on the master branch.
+
+(git branch | grep -q '* master') || {
+  echo "Only release from the master branch."
+  exit 1
+}
+
+# Figure out what version we're releasing.
+
+tag=v`ls boxen-*.gem | sed 's/^boxen-\(.*\)\.gem$/\1/'`
+
+# Make sure we haven't released this version before.
+
+git fetch -t origin
+
+(git tag -l | grep -q "$tag") && {
+  echo "Whoops, there's already a '${tag}' tag."
+  exit 1
+}
+
+# Tag it and bag it.
+
+gem push boxen-*.gem && git tag "$tag" &&
+  git push origin master && git push origin "$tag"

data/script/tests

@@ -0,0 +1,10 @@
+#!/bin/sh
+# Run the unit tests.
+
+cd "$(dirname $0)"/..
+
+script/bootstrap &&
+  ruby -rubygems -Ilib:test \
+    -e 'require "bundler/setup"' \
+    -e 'tests = ARGV.empty? ? Dir["test/**/*_test.rb"] : ARGV' \
+    -e 'tests.each { |f| load f }' "$@"

data/src/keychain-helper.c

@@ -0,0 +1,85 @@
+#include <stdio.h>
+#include <stdlib.h>
+#include <Security/Security.h>
+#include <CoreFoundation/CFString.h>
+
+#define REPORT_KEYCHAIN_ERROR(err_val)  do { \
+fprintf(stderr, "Boxen Keychain Helper: Encountered error code: %d\n", err_val); \
+fprintf(stderr, "Error: %s\n", CFStringGetCStringPtr(SecCopyErrorMessageString(err_val, NULL), kCFStringEncodingMacRoman)); \
+} while(0)
+
+int key_exists_p(
+  const char *service,
+  const char *login,
+  SecKeychainItemRef *item
+) {
+  void *buf;
+  UInt32 len;
+
+  OSStatus ret = SecKeychainFindGenericPassword(
+    NULL, strlen(service), service, strlen(login), login, &len, &buf, item
+  );
+
+  if (ret == errSecSuccess) {
+    return 0;
+  } else {
+    if (ret != errSecItemNotFound) {
+       // Item not found is not an error in predicate method context.
+       REPORT_KEYCHAIN_ERROR(ret);
+    }
+    return ret;
+  }
+}
+
+int main(int argc, char **argv) {
+  if ((argc < 3) || (argc > 4)) {
+    printf("Usage: %s <service> <account> [<password>]\n", argv[0]);
+    return 1;
+  }
+
+  const char *service  = argv[1];
+  const char *login    = argv[2];
+  const char *password = argc == 4 ? argv[3] : NULL;
+
+  void *buf;
+  UInt32 len;
+  SecKeychainItemRef item;
+
+  if (password != NULL && strlen(password) != 0) {
+    if (key_exists_p(service, login, &item) == 0) {
+      SecKeychainItemDelete(item);
+    }
+
+    OSStatus create_key = SecKeychainAddGenericPassword(
+      NULL, strlen(service), service, strlen(login), login, strlen(password),
+      password, &item
+    );
+
+    if (create_key != 0) {
+      REPORT_KEYCHAIN_ERROR(create_key);
+      return 1;
+    }
+  } else if (password != NULL && strlen(password) == 0) {
+    if (key_exists_p(service, login, &item) == 0) {
+      OSStatus ret = SecKeychainItemDelete(item);
+      if (ret != errSecSuccess) {
+        REPORT_KEYCHAIN_ERROR(ret);
+      }
+    }
+  } else {
+    OSStatus find_key = SecKeychainFindGenericPassword(
+      NULL, strlen(service), service, strlen(login), login, &len, &buf, &item);
+
+    if (find_key == errSecItemNotFound) {
+      return find_key;
+    }
+    if (find_key != 0) {
+      REPORT_KEYCHAIN_ERROR(find_key);
+      return 1;
+    }
+
+    fwrite(buf, 1, len, stdout);
+  }
+
+  return 0;
+}

data/test/boxen/test.rb

@@ -0,0 +1,7 @@
+require "minitest/autorun"
+require "mocha/setup"
+
+module Boxen
+  class Test < MiniTest::Unit::TestCase
+  end
+end

data/test/boxen_check_test.rb

@@ -0,0 +1,55 @@
+require "boxen/test"
+require "boxen/check"
+
+class BoxenCheckTest < Boxen::Test
+  def test_initialize
+    check = Boxen::Check.new :config
+    assert_equal :config, check.config
+  end
+
+  def test_ok?
+    ex = assert_raises RuntimeError do
+      Boxen::Check.new(:config).ok?
+    end
+
+    assert_match "must implement", ex.message
+  end
+
+  def test_run
+    ex = assert_raises RuntimeError do
+      Boxen::Check.new(:config).run
+    end
+
+    assert_match "must implement", ex.message
+  end
+
+  def test_self_checks
+    subclass = Class.new Boxen::Check
+    Boxen::Check.const_set :TestCheck, subclass
+
+    assert Boxen::Check.checks(:config).any? { |c| subclass === c },
+      "an instance of TestCheck exists in checks"
+  end
+
+  def test_self_checks_subclasses
+    klass = Struct.new :config
+    Boxen::Check.const_set :TestBadCheck, klass
+
+    refute Boxen::Check.checks(:config).any? { |c| klass === c },
+      "checks are subclasses of Boxen::Check"
+  end
+
+  def test_self_run
+    willrun = mock do
+      expects(:ok?).returns false
+      expects(:run)
+    end
+
+    wontrun = mock do
+      expects(:ok?).returns true
+    end
+
+    Boxen::Check.expects(:checks).with(:config).returns [willrun, wontrun]
+    Boxen::Check.run :config
+  end
+end

data/test/boxen_checkout_test.rb

@@ -0,0 +1,42 @@
+require "boxen/test"
+require "boxen/checkout"
+
+class BoxenCheckoutTest < Boxen::Test
+  def setup
+    @config   = Boxen::Config.new { |c|  c.repodir = 'test/fixtures/repo' }
+    @checkout = Boxen::Checkout.new @config
+  end
+
+  def test_initialize
+    checkout = Boxen::Checkout.new :config
+    assert_equal :config, checkout.config
+  end
+
+  def test_sha
+    sha = 'deadbeef'
+    @checkout.expects(:"`").with("git rev-parse HEAD").returns("#{sha}\n")
+    assert_equal sha, @checkout.sha
+  end
+
+  def test_master?
+    @checkout.stubs(:"`").with("git symbolic-ref HEAD").returns("refs/heads/topic\n")
+    assert !@checkout.master?
+
+    @checkout.stubs(:"`").with("git symbolic-ref HEAD").returns("refs/heads/master\n")
+    assert @checkout.master?
+  end
+
+  def test_changes
+    changes = '   maybe a bunch of stuff happened   '
+    @checkout.expects(:"`").with("git status --porcelain").returns(changes)
+    assert_equal changes.strip, @checkout.changes
+  end
+
+  def test_dirty?
+    @checkout.stubs(:changes).returns('stuff happened')
+    assert @checkout.dirty?
+
+    @checkout.stubs(:changes).returns('')
+    assert !@checkout.dirty?
+  end
+end

data/test/boxen_cli_test.rb

@@ -0,0 +1,39 @@
+require "boxen/test"
+require "boxen/cli"
+
+class BoxenCLITest < Boxen::Test
+  def setup
+    @config = Boxen::Config.new
+    @flags  = Boxen::Flags.new
+    @cli    = Boxen::CLI.new(@config, @flags)
+  end
+
+  def test_initialize
+    config = Boxen::Config.new
+    flags  = Boxen::Flags.new
+
+    cli = Boxen::CLI.new config, flags
+
+    assert_equal config, cli.config
+    assert_equal flags,  cli.flags
+
+    assert_equal config, cli.runner.config
+    assert_equal flags,  cli.runner.flags
+  end
+
+  def test_run
+    @cli.runner.expects(:run)
+    @cli.run
+  end
+
+  def test_help
+    $stdout.stubs(:write)
+
+    flags = Boxen::Flags.new('--help')
+    cli   = Boxen::CLI.new(@config, flags)
+    cli.runner.expects(:run).never
+    assert_raises SystemExit do
+      cli.run
+    end
+  end
+end

data/test/boxen_config_test.rb

@@ -0,0 +1,400 @@
+require "boxen/test"
+require "boxen/config"
+
+class BoxenConfigTest < Boxen::Test
+  def setup
+    @config = Boxen::Config.new
+    @config.repodir = "test/fixtures/repo"
+  end
+
+  def test_debug?
+    refute @config.debug?
+
+    @config.debug = true
+    assert @config.debug?
+  end
+
+  def test_email
+    assert_nil @config.email
+
+    @config.email = "foo"
+    assert_equal "foo", @config.email
+  end
+
+  def test_fde?
+    assert @config.fde?
+
+    @config.fde = false
+    refute @config.fde?
+  end
+
+  def test_fde_env_var
+    val = ENV["BOXEN_NO_FDE"]
+
+    ENV["BOXEN_NO_FDE"] = "1"
+    refute @config.fde?
+
+    ENV["BOXEN_NO_FDE"] = val
+  end
+
+  def test_homedir
+    val = ENV["BOXEN_HOME"]
+    ENV["BOXEN_HOME"] = nil
+
+    assert_equal "/opt/boxen", @config.homedir
+
+    @config.homedir = "foo"
+    assert_equal "foo", @config.homedir
+
+    ENV["BOXEN_HOME"] = val
+  end
+
+  def test_homedir_env_var_boxen_home
+    val = ENV["BOXEN_HOME"]
+
+    ENV["BOXEN_HOME"] = "foo"
+    assert_equal "foo", @config.homedir
+
+    ENV["BOXEN_HOME"] = val
+  end
+
+  def test_initialize
+    config = Boxen::Config.new do |c|
+      c.homedir = "foo"
+    end
+
+    assert_equal "foo", config.homedir
+  end
+
+  def test_logfile
+    assert_equal "#{@config.repodir}/log/boxen.log", @config.logfile
+
+    @config.logfile = "foo"
+    assert_equal "foo", @config.logfile
+  end
+
+  def test_logfile_env_var
+    val = ENV["BOXEN_LOG_FILE"]
+
+    ENV["BOXEN_LOG_FILE"] = "foo"
+    assert_equal "foo", @config.logfile
+
+    ENV["BOXEN_LOG_FILE"] = val
+  end
+
+  def test_login
+    assert_nil @config.login
+
+    @config.login = "foo"
+    assert_equal "foo", @config.login
+  end
+
+  def test_name
+    assert_nil @config.name
+
+    @config.name = "foo"
+    assert_equal "foo", @config.name
+  end
+
+  def test_pretend?
+    refute @config.pretend?
+
+    @config.pretend = true
+    assert @config.pretend?
+  end
+
+  def test_profile?
+    refute @config.profile?
+
+    @config.profile = true
+    assert @config.profile?
+  end
+
+  def test_future_parser?
+    refute @config.future_parser?
+
+    @config.future_parser = true
+    assert @config.future_parser?
+  end
+
+  def test_skip_puppetfile?
+    refute @config.skip_puppetfile?
+
+    @config.skip_puppetfile = true
+    assert @config.skip_puppetfile?
+  end
+
+  def test_projects
+    files = Dir["#{@config.repodir}/modules/projects/manifests/*.pp"]
+    assert_equal files.size, @config.projects.size
+  end
+
+  def test_puppetdir
+    assert_equal "/tmp/boxen/puppet", @config.puppetdir
+  end
+
+  def test_puppetdir_env_var
+    val = ENV["BOXEN_PUPPET_DIR"]
+
+    ENV["BOXEN_PUPPET_DIR"] = "foo"
+    assert_equal "foo", @config.puppetdir
+
+    ENV["BOXEN_PUPPET_DIR"] = val
+  end
+
+  def test_ghurl
+    @config.ghurl = "https://git.foo.com"
+    assert_equal "https://git.foo.com", @config.ghurl
+  end
+
+  def test_ghurl_blank
+    assert_equal "https://github.com", @config.ghurl
+  end
+
+  def test_gheurl_env_var
+    val = ENV['BOXEN_GITHUB_ENTERPRISE_URL']
+
+    ENV['BOXEN_GITHUB_ENTERPRISE_URL'] = 'https://git.foo.com'
+    assert_equal "https://git.foo.com", @config.ghurl
+
+    ENV['BOXEN_GITHUB_ENTERPRISE_URL'] = val
+  end
+
+  def test_enterprise_true
+    @config.ghurl = "https://git.foo.com"
+    assert @config.enterprise?
+  end
+
+  def test_enterprise_false
+    assert @config.enterprise? == false
+  end
+
+  def test_repotemplate
+    @config.repotemplate = 'https://git.foo.com/%s'
+    assert_equal 'https://git.foo.com/%s', @config.repotemplate
+  end
+
+  def test_repotemplate_blank
+    assert_equal 'https://github.com/%s', @config.repotemplate
+  end
+
+  def test_repotemplate_env_var
+    val = ENV['BOXEN_REPO_URL_TEMPLATE']
+
+    ENV['BOXEN_REPO_URL_TEMPLATE'] = 'https://git.foo.com/%s'
+    assert_equal 'https://git.foo.com/%s', @config.repotemplate
+
+    ENV['BOXEN_REPO_URL_TEMPLATE'] = val
+  end
+
+  def test_repodir
+    @config.repodir = nil
+    assert_equal Dir.pwd, @config.repodir
+
+    @config.repodir = "foo"
+    assert_equal "foo", @config.repodir
+  end
+
+  def test_repodir_env_var
+    @config.repodir = nil
+
+    val = ENV["BOXEN_REPO_DIR"]
+
+    ENV["BOXEN_REPO_DIR"] = "foo"
+    assert_equal "foo", @config.repodir
+
+    ENV["BOXEN_REPO_DIR"] = val
+  end
+
+  def test_reponame
+    @config.reponame = "something/explicit"
+    assert_equal "something/explicit", @config.reponame
+  end
+
+  def test_reponame_env_var
+    val = ENV["BOXEN_REPO_NAME"]
+
+    ENV["BOXEN_REPO_NAME"] = "env/var"
+    assert_equal "env/var", @config.reponame
+
+    ENV["BOXEN_REPO_NAME"] = val
+  end
+
+  def test_reponame_git_config
+    @config.expects(:"`").with("git config remote.origin.url").
+      returns "https://github.com/some-org/our-boxen\n"
+
+    assert_equal "some-org/our-boxen", @config.reponame
+  end
+
+  def test_reponame_git_config_ghurl
+    @config.ghurl = 'https://git.foo.com'
+    @config.expects(:"`").with("git config remote.origin.url").
+      returns "https://git.foo.com/some-org/our-boxen\n"
+
+    assert_equal "some-org/our-boxen", @config.reponame
+  end
+
+  def test_reponame_git_config_git_protocol
+    @config.expects(:"`").with("git config remote.origin.url").
+      returns "git@github.com:some-org/our-boxen.git\n"
+
+    assert_equal "some-org/our-boxen", @config.reponame
+  end
+
+  def test_reponame_git_config_git_protocol_ghurl
+    @config.ghurl = 'https://git.foo.com'
+    @config.expects(:"`").with("git config remote.origin.url").
+      returns "git@git.foo.com:some-org/our-boxen.git\n"
+
+    assert_equal "some-org/our-boxen", @config.reponame
+  end
+
+  def test_reponame_git_config_bad_exit
+    @config.expects(:"`").with("git config remote.origin.url").returns ""
+    $?.expects(:success?).returns false
+
+    assert_nil @config.reponame
+  end
+
+  def test_reponame_git_config_bad_url
+    @config.expects(:"`").with("git config remote.origin.url").
+      returns "https://spumco.com/some-org/our-boxen\n"
+    $?.expects(:success?).returns true
+
+    assert_nil @config.reponame
+  end
+
+  def test_reponame_git_config_bad_url_git_protocol
+    @config.expects(:"`").with("git config remote.origin.url").
+      returns "git@spumco.com:some-org/our-boxen.git\n"
+    $?.expects(:success?).returns true
+
+    assert_nil @config.reponame
+  end
+
+  def test_reponame_git_config_git_extension
+    @config.expects(:"`").with("git config remote.origin.url").
+      returns "https://github.com/some-org/our-boxen.git\n"
+    $?.expects(:success?).returns true
+
+    assert_equal "some-org/our-boxen", @config.reponame
+  end
+
+  def test_reponame_git_config_git_extension_ghurl
+    @config.ghurl = 'https://git.foo.com'
+    @config.expects(:"`").with("git config remote.origin.url").
+      returns "https://git.foo.com/some-org/our-boxen.git\n"
+    $?.expects(:success?).returns true
+
+    assert_equal "some-org/our-boxen", @config.reponame
+  end
+
+  def test_srcdir
+    val = ENV["BOXEN_SRC_DIR"]
+    ENV["BOXEN_SRC_DIR"] = nil
+
+    @config.expects(:user).returns "foo"
+    assert_equal "/Users/foo/src", @config.srcdir
+
+    @config.srcdir = "elsewhere"
+    assert_equal "elsewhere", @config.srcdir
+
+    ENV["BOXEN_SRC_DIR"] = val
+  end
+
+  def test_srcdir_env_var
+    @config.srcdir = nil
+
+    val = ENV["BOXEN_SRC_DIR"]
+
+    ENV["BOXEN_SRC_DIR"] = "Projects"
+    assert_equal "Projects", @config.srcdir
+
+    ENV["BOXEN_SRC_DIR"] = val
+  end
+
+  def test_stealth?
+    refute @config.stealth?
+
+    @config.stealth = true
+    assert @config.stealth?
+  end
+
+  def test_stealth_env_var
+    val = ENV["BOXEN_NO_ISSUE"]
+
+    ENV["BOXEN_NO_ISSUE"] = "1"
+    assert @config.stealth?
+
+    ENV["BOXEN_NO_ISSUE"] = val
+  end
+
+  def test_token
+    assert_nil @config.token
+
+    @config.token = "foo"
+    assert_equal "foo", @config.token
+  end
+
+  def test_user
+    ENV["USER"] = "foo"
+    assert_equal "foo", @config.user
+
+    @config.user = "bar"
+    assert_equal "bar", @config.user
+  end
+
+  def test_api
+    @config.token    = token = "s3kr!7"
+
+    api = Object.new
+    Octokit::Client.expects(:new).with(:login => token, :password => 'x-oauth-basic').once.returns(api)
+
+    assert_equal api, @config.api
+    assert_equal api, @config.api  # This extra call plus the `once` on the expectation is for the ivar cache.
+  end
+
+  def test_s3host
+    val = ENV["BOXEN_S3_HOST"]
+    ENV["BOXEN_S3_HOST"] = nil
+
+    assert_equal "s3.amazonaws.com", @config.s3host
+
+    @config.s3host = "example.com"
+    assert_equal "example.com", @config.s3host
+  ensure
+    ENV["BOXEN_S3_HOST"] = val
+  end
+
+  def test_s3host_env_var
+    val = ENV["BOXEN_S3_HOST"]
+
+    ENV["BOXEN_S3_HOST"] = "example.com"
+    assert_equal "example.com", @config.s3host
+
+  ensure
+    ENV["BOXEN_S3_HOST"] = val
+  end
+
+  def test_s3bucket
+    val = ENV["BOXEN_S3_BUCKET"]
+    ENV["BOXEN_S3_BUCKET"] = nil
+
+    assert_equal "boxen-downloads", @config.s3bucket
+
+    @config.s3bucket = "my-bucket"
+    assert_equal "my-bucket", @config.s3bucket
+  ensure
+    ENV["BOXEN_S3_BUCKET"] = val
+  end
+
+  def test_s3host_env_var
+    val = ENV["BOXEN_S3_BUCKET"]
+
+    ENV["BOXEN_S3_BUCKET"] = "my-bucket"
+    assert_equal "my-bucket", @config.s3bucket
+  ensure
+    ENV["BOXEN_S3_BUCKET"] = val
+  end
+end