omnibus 3.0.0 → 3.1.0

data/lib/omnibus/cli.rb

@@ -1,6 +1,5 @@
 #
-# Copyright:: Copyright (c) 2012-2014 Chef Software, Inc.
-# License:: Apache License, Version 2.0
+# Copyright 2014 Chef Software, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,19 +14,124 @@
 # limitations under the License.
 #
 
-require 'omnibus/cli/application'
-require 'omnibus/cli/base'
-require 'omnibus/cli/build'
+require 'thor'
+require 'omnibus'
 
 module Omnibus
-  module CLI
-    class Error < StandardError
-      attr_reader :original
+  class CLI < Command::Base
+    # This is the main entry point for the CLI. It exposes the method
+    # {#execute!} to start the CLI.
+    #
+    # @note the arity of {#initialize} and {#execute!} are extremely important
+    # for testing purposes. It is a requirement to perform in-process testing
+    # with Aruba. In process testing is much faster than spawning a new Ruby
+    # process for each test.
+    class Runner
+      include Logging
 
-      def initialize(msg, original = nil)
-        super(msg)
-        @original = original
+      def initialize(argv, stdin = STDIN, stdout = STDOUT, stderr = STDERR, kernel = Kernel)
+        @argv, @stdin, @stdout, @stderr, @kernel = argv, stdin, stdout, stderr, kernel
       end
+
+      def execute!
+        $stdin  = @stdin
+        $stdout = @stdout
+        $stderr = @stderr
+
+        Omnibus::CLI.start(@argv)
+        @kernel.exit(0)
+      rescue => e
+        error = Omnibus.ui.set_color(e.message, :red)
+        Omnibus.ui.error(error)
+
+        if log.debug?
+          backtrace = Omnibus.ui.set_color("\n" + e.backtrace.join("\n  "), :red)
+          Omnibus.ui.error(backtrace)
+        end
+
+        if e.respond_to?(:status_code)
+          @kernel.exit(e.status_code)
+        else
+          @kernel.exit(1)
+        end
+      end
+    end
+
+    map %w(-v --version) => 'version'
+
+    #
+    # Build an Omnibus project or software definition.
+    #
+    #   $ omnibus build chefdk
+    #
+    # @todo Support regular expressions (+$ omnibus build chef*+)
+    #
+    desc 'build PROJECT', 'Build the given Omnibus project'
+    def build(name)
+      project = Omnibus.project(name)
+      raise ProjectNotFound.new(name) unless project
+
+      say("Building #{project.name} #{project.build_version}...")
+      project.build_me
+    end
+
+    #
+    # Perform cache management functions.
+    #
+    #   $ omnibus cache list
+    #
+    register(Command::Cache, 'cache', 'cache [COMMAND]', 'Manage the cache')
+    CLI.tasks['cache'].options = Command::Cache.class_options
+
+    #
+    # Clean the Omnibus project.
+    #
+    #   $ omnibus clean chefdk
+    #
+    register(Cleaner, 'clean', 'clean PROJECT', 'Clean the Omnibus project')
+    CLI.tasks['clean'].options = Cleaner.class_options
+
+    #
+    # Initialize a new Omnibus project.
+    #
+    #   $ omnibus new NAME
+    #
+    register(Generator, 'new', 'new NAME', 'Initialize a new Omnibus project')
+    CLI.tasks['new'].options = Generator.class_options
+
+    #
+    # List the Omnibus projects available from "here".
+    #
+    #   $ omnibus list
+    #
+    desc 'list', 'List the Omnibus projects'
+    def list
+      if Omnibus.projects.empty?
+        say('There are no Omnibus projects!')
+      else
+        say('Omnibus projects:')
+        Omnibus.projects.sort.each do |project|
+          say("  * #{project.name} (#{project.build_version})")
+        end
+      end
+    end
+
+    #
+    # Publish Omnibus package(s) to a backend.
+    #
+    #   $ omnibus release --project chefdk
+    #
+    register(Command::Release, 'release', 'release', 'Publish Omnibus packages')
+    CLI.tasks['clean'].options = Command::Release.class_options
+
+    #
+    # Display version information.
+    #
+    #   $ omnibus version
+    #
+    desc 'version', 'Display version information', hide: true
+    def version
+      say("Omnibus v#{Omnibus::VERSION}")
     end
   end
 end

data/lib/omnibus/cli/base.rb

@@ -1,6 +1,5 @@
 #
-# Copyright:: Copyright (c) 2013-2014 Chef Software, Inc.
-# License:: Apache License, Version 2.0
+# Copyright 2013-2014 Chef Software, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,101 +14,103 @@
 # limitations under the License.
 #
 
-require 'omnibus/util'
-require 'thor'
-
+#
+# This is the base class that all commands and subcommands should extend from.
+# It handles all of the Thor nastiness and method mutating, as well as defining
+# the global configuration options.
+#
 module Omnibus
-  module CLI
-    class Base < Thor
-      include Thor::Actions
-
-      class_option :config,
-                   aliases: [:c],
-                   type: :string,
-                   default: File.join(Dir.pwd, Omnibus::DEFAULT_CONFIG_FILENAME),
-                   desc: 'Path to the Omnibus configuration file to use.'
-
-      def initialize(args, options, config)
-        super(args, options, config)
-        $stdout.sync = true
-
-        # Don't try to initialize the Omnibus project for help commands.#
-        # current_task renamed to current_command in Thor 0.18.0
-        current_command = config[:current_command] ? config[:current_command].name : config[:current_task].name
-        return if current_command == 'help'
-
-        if (config = @options[:config])
-          if config && File.exist?(@options[:config])
-            say("Using Omnibus configuration file #{config}", :green)
-            Omnibus.load_configuration(config)
-          elsif config
-            say("No configuration file `#{config}', using defaults", :yellow)
-          end
+  class Command::Base < Thor
+    class << self
+      def dispatch(m, args, options, config)
+        # Handle the case where Thor thinks a trailing --help is actually an
+        # argument and blows up...
+        if args.length > 1 && !(args & Thor::HELP_MAPPINGS).empty?
+          args.unshift('help')
         end
 
-        if (path = @options[:path])
-          # TODO: merge in all relevant CLI options here, as they should
-          # override anything from a configuration file.
-          Omnibus::Config.project_root(path)
-          Omnibus::Config.append_timestamp(@options[:timestamp]) if @options.key?('timestamp')
-
-          unless Omnibus.project_files.any?
-            fail Omnibus::CLI::Error, "Given path '#{path}' does not appear to be a valid Omnibus project root."
-          end
-
-          begin
-            Omnibus.process_configuration
-          rescue => e
-            error_msg = 'Could not load the Omnibus projects.'
-            raise Omnibus::CLI::Error.new(error_msg, e)
-          end
-        end
+        super
       end
+    end
+
+    include Logging
 
-      ##################################################################
-      # Thor Overrides/Tweaks
-      ##################################################################
+    def initialize(args, options, config)
+      super(args, options, config)
 
-      # Used by {Thor::Actions#template} to locate ERB templates
-      # @return [String]
-      def self.source_root
-        File.expand_path(File.join(File.dirname(__FILE__), '..', 'templates'))
+      # Set the log_level
+      if @options[:log_level]
+        Omnibus.logger.level = @options[:log_level]
       end
 
-      # Forces command to exit with a 1 on any failure...so raise away.
-      def self.exit_on_failure?
-        true
+      # Do not load the Omnibus config if we are asking for help or the version
+      if %w(help version).include?(config[:current_command].name)
+        log.debug { 'Skipping Omnibus loading (detected help or version)' }
+        return
       end
 
-      # For some strange reason the +subcommand+ argument is disregarded when
-      # +Thor.banner+ is called by +Thor.command_help+:
-      #
-      #   https://github.com/wycats/thor/blob/master/lib/thor.rb#L163-L164
-      #
-      # We'll override +Thor.banner+ and ensure subcommand is true when called
-      # for subcommands.
-      def self.banner(command, namespace = nil, subcommand = false)
-        # Main commands have an effective namespace of 'application' OR
-        # contain subcommands
-        subcommand = self.namespace.split(':').last != 'application' || subcommands.empty?
-        "#{basename} #{command.formatted_usage(self, $thor_runner, subcommand) }"
+      if File.exist?(@options[:config])
+        log.info { "Using config from '#{@options[:config]}'" }
+        Omnibus.load_configuration(@options[:config])
+      else
+        if @options[:config] == Omnibus::DEFAULT_CONFIG
+          log.debug { 'Config file not given - using defaults' }
+        else
+          raise "The given config file '#{@options[:config]}' does not exist!"
+        end
       end
 
-      protected
+      @options[:override].each do |key, value|
+        if %w(true false nil).include?(value)
+          log.debug { "Detected #{value.inspect} should be an object" }
+          value = { 'true' => true, 'false' => false, 'nil' => nil }[value]
+        end
 
-      ##################################################################
-      # Omnibus Helpers (should these be in Omnibus::Util?)
-      ##################################################################
+        if value =~ /\A[[:digit:]]+\Z/
+          log.debug { "Detected #{value.inspect} should be an integer" }
+          value = value.to_i
+        end
 
-      def load_project!(project_name)
-        project = Omnibus.project(project_name)
-        unless project
-          error_msg = "I don't know anything about project '#{project_name}'."
-          error_msg << " Valid project names include: #{Omnibus.project_names.join(', ') }"
-          fail Omnibus::CLI::Error, error_msg
+        if Config.respond_to?(key)
+          log.debug { "Setting Config.#{key} = #{value.inspect}" }
+          Config.send(key, value)
+        else
+          log.debug { "Skipping option '#{key}' - not a config option" }
         end
-        project
       end
+
+      log.debug { 'Processing Omnibus configuration...' }
+      Omnibus.process_configuration
+    end
+
+    class_option :config,
+      desc: 'Path to the Omnibus config file',
+      aliases: '-c',
+      type: :string,
+      default: Omnibus::DEFAULT_CONFIG
+    class_option :log_level,
+      desc: 'The log level',
+      aliases: '-l',
+      type: :string,
+      enum: %w(fatal error warn info debug),
+      lazy_default: 'warn'
+    class_option :override,
+      desc: 'Override one or more Omnibus config options',
+      aliases: '-o',
+      type: :hash,
+      default: {}
+
+    #
+    # Hide the default help task to encourage people to use +-h+ instead of
+    # Thor's dumb way of asking for help.
+    #
+    desc 'help [COMMAND]', 'Show help output', hide: true
+    def help(*)
+      super
     end
   end
 end
+
+# Include the deprecations from previous versions of Omnibus. This should be
+# removed in the next major version of Omnibus.
+require_relative 'deprecated'

data/lib/omnibus/cli/cache.rb

@@ -1,6 +1,5 @@
 #
-# Copyright:: Copyright (c) 2013-2014 Chef Software, Inc.
-# License:: Apache License, Version 2.0
+# Copyright 2013-2014 Chef Software, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,44 +14,93 @@
 # limitations under the License.
 #
 
-require 'omnibus/cli/base'
-require 'omnibus/s3_cacher'
-
 module Omnibus
-  module CLI
-    class Cache < Base
-      class_option :path,
-                   aliases: [:p],
-                   type: :string,
-                   default: Dir.pwd,
-                   desc: 'Path to the Omnibus project root.'
-
-      namespace :cache
-
-      desc 'existing', 'List source packages which exist in the cache'
-      def existing
-        S3Cache.new.list.each { |s| puts s.name }
-      end
+  class Command::Cache < Command::Base
+    namespace :cache
 
-      desc 'list', 'List all cached files (by S3 key)'
-      def list
-        S3Cache.new.list_by_key.each { |k| puts k }
-      end
+    #
+    # List the existing source packages in the cache.
+    #
+    #   $ omnibus cache existing
+    #
+    desc 'existing', 'List source packages which exist in the cache'
+    def existing
+      result = cache.list
 
-      desc 'missing', 'Lists source packages that are required but not yet cached'
-      def missing
-        S3Cache.new.missing.each { |s| puts s.name }
+      if result.empty?
+        say('There are no packages in the cache!')
+      else
+        say('The following packages are in the cache:')
+        result.each do |source|
+          say("  * #{source.name}")
+        end
       end
+    end
 
-      desc 'fetch', 'Fetches missing source packages to local tmp dir'
-      def fetch
-        S3Cache.new.fetch_missing
+    #
+    # List all cached files (by S3 key).
+    #
+    #   $ omnibus cache list
+    #
+    desc 'list', 'List all cached files (by S3 key)'
+    def list
+      result = cache.list_by_key
+
+      if result.empty?
+        say('There is nothing in the cache!')
+      else
+        say('Cached files (by S3 key):')
+        result.each do |key|
+          say("  * #{key}")
+        end
       end
+    end
+
+    #
+    # List missing source packages.
+    #
+    #   $ omnibus cache missing
+    #
+    desc 'missing', 'Lists source packages that are required but not yet cached'
+    def missing
+      result = cache.missing
 
-      desc 'populate', 'Populate the S3 Cache'
-      def populate
-        S3Cache.new.populate
+      if result.empty?
+        say('There are no missing packages in the cache.')
+      else
+        say('The following packages are missing from the cache:')
+        result.each do |source|
+          say(source.name)
+        end
       end
     end
+
+    #
+    # Fetch missing source packages locally
+    #
+    #   $ omnibus cache fetch
+    #
+    desc 'fetch', 'Fetches missing source packages locally'
+    def fetch
+      say('Fetching missing packages...')
+      cache.fetch_missing
+    end
+
+    #
+    # Populate the remote S3 cache from local.
+    #
+    #   $ omnibus cache populate
+    #
+    desc 'populate', 'Populate the S3 Cache'
+    def populate
+      say('Populating the cache...')
+      cache.populate
+    end
+
+    private
+
+    def cache
+      @cache ||= S3Cache.new
+    end
   end
 end