boxen 2.9.0 → 3.0.0.beta1

data/lib/boxen/command/project/install.rb

@@ -0,0 +1,33 @@
+require "boxen/command/project"
+
+class Boxen::Command::Project::Install < Boxen::Command::Project
+  def self.detailed_help
+    <<-EOS
+
+    boxen project:install <project1> [<project2> ...]
+
+        Install one or more Boxen-managed projects.
+
+EOS
+  end
+
+  def self.help
+    "Install one or more projects"
+  end
+
+  def run
+    File.open("#{config.repodir}/.projects", "w+") do |f|
+      f.truncate 0
+      f.write projects
+    end
+
+    Boxen::Command.invoke 'run', config
+  end
+
+  def projects
+    @args.join ','
+  end
+end
+
+Boxen::Command.register :"project:install",  Boxen::Command::Project::Install
+Boxen::Command.register :"projects:install", Boxen::Command::Project::Install

data/lib/boxen/command/run.rb

@@ -0,0 +1,199 @@
+require "boxen/command"
+
+class Boxen::Command::Run < Boxen::Command
+  preflight \
+    Boxen::Preflight::OS,
+    Boxen::Preflight::Directories,
+    Boxen::Preflight::EtcMyCnf,
+    Boxen::Preflight::Homebrew,
+    Boxen::Preflight::Rbenv,
+    Boxen::Preflight::RVM,
+    Boxen::Preflight::Offline,
+    Boxen::Preflight::Creds,
+    Boxen::Preflight::Identity,
+    Boxen::Preflight::Update,
+    Boxen::Preflight::Facts
+
+  postflight \
+    Boxen::Postflight::Active,
+    Boxen::Postflight::Hooks,
+    Boxen::Postflight::GithubIssue,
+    Boxen::Postflight::Env
+
+  def self.help
+    "run Boxen's managed puppet environment"
+  end
+
+  def self.detailed_help
+    <<-EOS
+
+    boxen run [options]
+
+        Runs Puppet via Boxen's environment.
+
+        Some options you may find useful:
+
+            --debug                 Be really, really verbose. Like incredibly verbose.
+            --no-issue              Don't file an issue if the Boxen run fails.
+            --no-color              Don't output any colored text to the tty.
+            --report                Generate graphs and catalog data from Puppet.
+            --profile               Display very high-level performance details from the Puppet run.
+            --future-parser         Use Puppet's upcoming future parser
+            --graph                 Enable puppet dependency graph output
+
+    boxen run:noop [options]
+
+        The same thing as run, but acts as a dry run where no changes are made.
+
+EOS
+  end
+
+  def run
+    info "Updating librarian-puppet modules"
+    create_clean_working_environment
+    run_librarian_puppet
+
+    warn command.join(" ") if debug?
+
+    info "Running puppet"
+    Boxen::Util.sudo(*command)
+
+    Boxen::CommandStatus.new($?.exitstatus, [0, 2])
+  end
+
+  def noop
+    false
+  end
+
+  def report?
+    @args.include? "--report"
+  end
+
+  def profile?
+    @args.include? "--profile"
+  end
+
+  def future_parser?
+    @args.include? "--future-parser"
+  end
+
+  def graph?
+    @args.include? "--graph"
+  end
+
+  def debug?
+    @args.include? "--debug"
+  end
+
+  def no_color?
+    @args.include? "--no-color"
+  end
+
+  private
+  def command
+    [
+     "#{config.repodir}/bin/puppet",
+     "apply",
+     puppet_flags,
+     "#{config.repodir}/manifests/site.pp"
+    ].flatten
+  end
+
+  def run_librarian_puppet
+    if File.file? "#{config.repodir}/Puppetfile"
+      librarian = "#{config.repodir}/bin/librarian-puppet"
+
+      unless config.enterprise?
+        ENV["GITHUB_API_TOKEN"] = config.token
+      end
+
+      librarian_command = [librarian, "install", "--path=#{config.repodir}/shared"]
+      librarian_command << "--verbose" if debug?
+
+      warn librarian_command.join(" ") if debug?
+      unless system(*librarian_command)
+        abort "Can't run Puppet, fetching dependencies with librarian failed."
+      end
+    end
+  end
+
+  def create_clean_working_environment
+    FileUtils.mkdir_p config.puppetdir
+
+    FileUtils.rm_f config.logfile
+
+    FileUtils.rm_rf "#{config.puppetdir}/var/reports" if report?
+
+    FileUtils.mkdir_p File.dirname config.logfile
+    FileUtils.touch config.logfile
+  end
+
+  def hiera_config
+    hiera_yaml = "#{config.repodir}/config/hiera.yaml"
+
+    File.exists?(hiera_yaml) ? hiera_yaml : "/dev/null"
+  end
+
+  def puppet_flags
+    _flags = []
+    root  = File.expand_path "../../..", __FILE__
+
+    _flags << ["--group",          "admin"]
+    _flags << ["--confdir",        "#{config.puppetdir}/conf"]
+    _flags << ["--vardir",         "#{config.puppetdir}/var"]
+    _flags << ["--libdir",         "#{config.repodir}/lib"]#:#{root}/lib"]
+    _flags << ["--libdir",         "#{root}/lib"]
+    _flags << ["--manifestdir",    "#{config.repodir}/manifests"]
+    _flags << ["--modulepath",     "#{config.repodir}/modules:#{config.repodir}/shared"]
+    _flags << ["--hiera_config",   hiera_config]
+    _flags << ["--logdest",        "#{config.repodir}/log/puppet.log"]
+    _flags << ["--logdest",        "console"]
+    _flags << ["--pluginfactdest", "#{config.homedir}/facts.d"]
+
+    _flags << "--no-report" unless report?
+    _flags << "--detailed-exitcodes"
+
+    _flags << "--show_diff"
+
+    if profile?
+      _flags << "--evaltrace"
+      _flags << "--summarize"
+    end
+
+    _flags << "--parser=future" if future_parser?
+    _flags << "--graph" if graph?
+
+    _flags << "--debug" if debug?
+    _flags << "--noop"  if noop
+
+    _flags << "--color=false" if no_color?
+
+    _flags.flatten
+  end
+end
+
+class Boxen::Command::Run::Noop < Boxen::Command::Run
+  preflight \
+    Boxen::Preflight::OS,
+    Boxen::Preflight::Directories,
+    Boxen::Preflight::EtcMyCnf,
+    Boxen::Preflight::Homebrew,
+    Boxen::Preflight::Rbenv,
+    Boxen::Preflight::RVM,
+    Boxen::Preflight::Offline,
+    Boxen::Preflight::Creds,
+    Boxen::Preflight::Identity,
+    Boxen::Preflight::Update,
+    Boxen::Preflight::Facts
+
+  postflight \
+    Boxen::Postflight::Active,
+    Boxen::Postflight::Env
+
+  def noop
+    true
+  end
+end
+
+Boxen::Command.register :run, Boxen::Command::Run
+Boxen::Command.register :"run:noop", Boxen::Command::Run::Noop

data/lib/boxen/command/service.rb

@@ -0,0 +1,61 @@
+require "boxen/command"
+require "boxen/service"
+
+class Boxen::Command::Service < Boxen::Command
+  def self.detailed_help
+    <<-EOS
+
+    boxen service
+
+        Display all services Boxen knows about.
+
+    boxen service:enable <service1> [<service2> ...]
+
+        Enable and start a Boxen-managed service. If none are given,
+        enables and starts all Boxen-managed services.
+
+    boxen service:disable <service1> [<service2> ...]
+
+        Disable and stop a Boxen-managed service. If none are given,
+        disables and stops all Boxen-managed services.
+
+    boxen service:restart [<service1> <service2> ...]
+
+        Restart a Boxen-managed service. If none are given, restarts all
+        Boxen-managed services.
+
+    NOTE: 'boxen service' is aliased to 'services' for convenience
+
+EOS
+  end
+
+  def self.help
+    "Show and manage Boxen services."
+  end
+
+  def run
+    @args = [] # we don't care about args here
+
+    puts "Boxen manages the following services:\n\n"
+
+    services.each do |service|
+      puts "    #{service.name}"
+    end
+
+    Boxen::CommandStatus.new(0)
+  end
+
+  def services
+    @services ||= if @args.any?
+                    @args.map { |s| Boxen::Service.new(s) }
+                  else
+                    Boxen::Service.list
+                  end
+  end
+end
+
+require "boxen/command/service/enable"
+require "boxen/command/service/disable"
+require "boxen/command/service/restart"
+
+Boxen::Command.register :service, Boxen::Command::Service, :services

data/lib/boxen/command/service/disable.rb

@@ -0,0 +1,15 @@
+require "boxen/command/service"
+
+class Boxen::Command::Service::Disable < Boxen::Command::Service
+  def run
+    services.each do |service|
+      puts "Disabling service: #{service.name}"
+      service.disable
+    end
+
+    Boxen::CommandStatus.new(0)
+  end
+end
+
+Boxen::Command.register :"service:disable", Boxen::Command::Service::Disable
+Boxen::Command.register :"services:disable", Boxen::Command::Service::Disable

data/lib/boxen/command/service/enable.rb

@@ -0,0 +1,15 @@
+require "boxen/command/service"
+
+class Boxen::Command::Service::Enable < Boxen::Command::Service
+  def run
+    services.each do |service|
+      puts "Enabling service: #{service.name}"
+      service.enable
+    end
+
+    Boxen::CommandStatus.new(0)
+  end
+end
+
+Boxen::Command.register :"service:enable", Boxen::Command::Service::Enable
+Boxen::Command.register :"services:enable", Boxen::Command::Service::Enable

data/lib/boxen/command/service/restart.rb

@@ -0,0 +1,24 @@
+require "boxen/command/service"
+
+class Boxen::Command::Service::Restart < Boxen::Command::Service
+  def run
+    services.each do |service|
+      puts "Restarting service: #{service.name}"
+      service.disable
+      service.enable
+    end
+
+    Boxen::CommandStatus.new(0)
+  end
+
+  def services
+    @services ||= if @args.any?
+                    @args.map { |s| Boxen::Service.new(s) }
+                  else
+                    Boxen::Service.list_enabled
+                  end
+  end
+end
+
+Boxen::Command.register :"service:restart", Boxen::Command::Service::Restart
+Boxen::Command.register :"services:restart", Boxen::Command::Service::Restart

data/lib/boxen/command/version.rb

@@ -0,0 +1,29 @@
+require "boxen/command"
+require "boxen/version"
+
+class Boxen::Command::Version < Boxen::Command
+  def self.help
+    "Displays the current version of Boxen"
+  end
+
+  def self.detailed_help
+    <<-EOS
+
+    boxen version
+
+        Display the current version of the Boxen gem.
+
+EOS
+  end
+
+  def run
+    puts "Boxen #{version}"
+    Boxen::CommandStatus.new(0)
+  end
+
+  def version
+    Boxen::VERSION
+  end
+end
+
+Boxen::Command.register :version, Boxen::Command::Version, :"-v", :"--version"

data/lib/boxen/command_status.rb

@@ -0,0 +1,15 @@
+module Boxen
+  class CommandStatus
+    attr_reader :code, :successful_on
+
+    def initialize(code, successful_on = [0])
+      @successful_on = successful_on
+      @code = code
+    end
+
+    def success?
+      successful_on.member? code
+    end
+
+  end
+end

data/lib/boxen/config.rb

@@ -25,9 +25,6 @@ module Boxen
           end
         end
 
-        keychain        = Boxen::Keychain.new config.user
-        config.token    = keychain.token
-
         if config.enterprise?
           # configure to talk to GitHub Enterprise
           Octokit.configure do |c|
@@ -80,10 +77,19 @@ module Boxen
     def initialize(&block)
       @fde  = true
       @pull = true
+      @debug = false
 
       yield self if block_given?
     end
 
+    def keychain
+      @keychain ||= Boxen::Keychain.new self.user
+    end
+
+    def token
+      @token ||= keychain.token
+    end
+
     # Create an API instance using the current user creds. A new
     # instance is created any time `token` changes.
 
@@ -94,11 +100,32 @@ module Boxen
     # Spew a bunch of debug logging? Default is `false`.
 
     def debug?
+      # TODO: fix this
       !!@debug
     end
 
     attr_writer :debug
 
+    def offline?
+      @offline ||= false
+    end
+
+    attr_writer :offline
+
+    def report?
+      # TODO: Actually make this a thing
+      @report = false
+    end
+
+    attr_writer :report
+
+    def profile?
+      #TODO: Actually make this a thing
+      @profile = true
+    end
+
+    attr_writer :profile
+
     # A GitHub user's public email.
 
     attr_accessor :email
@@ -122,7 +149,7 @@ module Boxen
     # `BOXEN_HOME` environment variable.
 
     def homedir
-      @homedir || ENV["BOXEN_HOME"] || "/opt/boxen"
+      @homedir ||= (ENV["BOXEN_HOME"] || "/opt/boxen")
     end
 
     attr_writer :homedir
@@ -132,7 +159,7 @@ module Boxen
     # overwritten on every run.
 
     def logfile
-      @logfile || ENV["BOXEN_LOG_FILE"] || "#{repodir}/log/boxen.log"
+      @logfile ||= (ENV["BOXEN_LOG_FILE"] || "#{repodir}/log/boxen.log")
     end
 
     attr_writer :logfile
@@ -145,46 +172,6 @@ module Boxen
 
     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.
     #
@@ -208,7 +195,7 @@ module Boxen
     # `BOXEN_PUPPET_DIR` environment variable.
 
     def puppetdir
-      @puppetdir || ENV["BOXEN_PUPPET_DIR"] || "/tmp/boxen/puppet"
+      @puppetdir ||= (ENV["BOXEN_PUPPET_DIR"] || "/tmp/boxen/puppet")
     end
 
     attr_writer :puppetdir
@@ -217,7 +204,7 @@ module Boxen
     # `Dir.pwd`. Respects the `BOXEN_REPO_DIR` environment variable.
 
     def repodir
-      @repodir || ENV["BOXEN_REPO_DIR"] || Dir.pwd
+      @repodir ||= (ENV["BOXEN_REPO_DIR"] || Dir.pwd)
     end
 
     attr_writer :repodir
@@ -228,7 +215,7 @@ module Boxen
     # Respects the `BOXEN_REPO_NAME` environment variable.
 
     def reponame
-      override = @reponame || ENV["BOXEN_REPO_NAME"]
+      override = @reponame ||= ENV["BOXEN_REPO_NAME"]
       return override unless override.nil?
 
       if File.directory? repodir
@@ -238,7 +225,7 @@ module Boxen
         # 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$/, ""
+          @reponame = $1.sub(/\.git$/, "")
         end
       end
     end
@@ -248,7 +235,7 @@ module Boxen
     # GitHub location (public or GitHub Enterprise)
 
     def ghurl
-      @ghurl || ENV["BOXEN_GITHUB_ENTERPRISE_URL"] || "https://github.com"
+      @ghurl ||= (ENV["BOXEN_GITHUB_ENTERPRISE_URL"] || "https://github.com")
     end
 
     attr_writer :ghurl
@@ -256,8 +243,7 @@ module Boxen
     # Repository URL template (required for GitHub Enterprise)
 
     def repotemplate
-      default = 'https://github.com/%s'
-      @repotemplate || ENV["BOXEN_REPO_URL_TEMPLATE"] || default
+      @repotemplate ||= (ENV["BOXEN_REPO_URL_TEMPLATE"] || "https://github.com/%s")
     end
 
     attr_writer :repotemplate
@@ -272,7 +258,7 @@ module Boxen
     # `"/Users/#{user}/src"`.
 
     def srcdir
-      @srcdir || ENV["BOXEN_SRC_DIR"] || "/Users/#{user}/src"
+      @srcdir ||= (ENV["BOXEN_SRC_DIR"] || "/Users/#{user}/src")
     end
 
     attr_writer :srcdir
@@ -281,15 +267,11 @@ module Boxen
     # Respects the `BOXEN_NO_ISSUE` environment variable.
 
     def stealth?
-      !!ENV["BOXEN_NO_ISSUE"] || @stealth
+      @stealth ||= !!ENV["BOXEN_NO_ISSUE"]
     end
 
     attr_writer :stealth
 
-    # A GitHub OAuth token. Default is `nil`.
-
-    attr_reader :token
-
     def token=(token)
       @token = token
       @api = nil
@@ -298,7 +280,7 @@ module Boxen
     # A local user login. Default is the `USER` environment variable.
 
     def user
-      @user || ENV["USER"]
+      @user ||= ENV["USER"]
     end
 
     attr_writer :user
@@ -313,7 +295,7 @@ module Boxen
     # Respects the `BOXEN_S3_HOST` environment variable.
 
     def s3host
-      @s3host || ENV["BOXEN_S3_HOST"] || "s3.amazonaws.com"
+      @s3host ||= (ENV["BOXEN_S3_HOST"] || "s3.amazonaws.com")
     end
 
     attr_writer :s3host
@@ -322,7 +304,7 @@ module Boxen
     # Respects the `BOXEN_S3_BUCKET` environment variable.
 
     def s3bucket
-      @s3bucket || ENV["BOXEN_S3_BUCKET"] || "boxen-downloads"
+      @s3bucket ||= (ENV["BOXEN_S3_BUCKET"] || "boxen-downloads")
     end
 
     attr_writer :s3bucket