omnibus 1.0.0

data/lib/omnibus/cli/base.rb

@@ -0,0 +1,112 @@
+#
+# Copyright:: Copyright (c) 2013 Opscode, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'omnibus/util'
+require 'thor'
+
+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
+        return if config[:current_command].name == "help"
+
+        if path = @options[:path]
+          if (config = @options[:config]) && File.exist?(@options[:config])
+            say("Using Omnibus configuration file #{config}", :green)
+            Omnibus.load_configuration(config)
+          end
+
+          # TODO: merge in all relevant CLI options here, as they should
+          # override anything from a configuration file.
+          Omnibus::Config.project_root(path)
+
+          unless Omnibus.project_files.any?
+            raise 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
+
+      end
+
+      ##################################################################
+      # Thor Overrides/Tweaks
+      ##################################################################
+
+      # Used by {Thor::Actions#template} to locate ERB templates
+      # @return [String]
+      def self.source_root
+        File.expand_path(File.join(File.dirname(__FILE__), '..', 'templates'))
+      end
+
+      # Forces command to exit with a 1 on any failure...so raise away.
+      def self.exit_on_failure?
+        true
+      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
+        if (self.namespace.split(':').last != 'application') || self.subcommands.empty?
+          subcommand = true
+        end
+        "#{basename} #{command.formatted_usage(self, $thor_runner, subcommand)}"
+      end
+
+      protected
+
+      ##################################################################
+      # Omnibus Helpers (should these be in Omnibus::Util?)
+      ##################################################################
+
+      def load_project!(project_name)
+        project = Omnibus.project(project_name)
+        unless project
+          error_msg = "I don't know anythinga about project '#{project_name}'."
+          error_msg << " Valid project names include: #{Omnibus.project_names.join(', ')}"
+          raise Omnibus::CLI::Error, error_msg
+        end
+        project
+      end
+
+    end
+  end
+end

data/lib/omnibus/cli/build.rb

@@ -0,0 +1,66 @@
+#
+# Copyright:: Copyright (c) 2013 Opscode, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'omnibus/cli/base'
+
+module Omnibus
+  module CLI
+    class Build < Base
+
+      namespace :build
+
+      class_option :path,
+        :aliases => [:p],
+        :type => :string,
+        :default => Dir.pwd,
+        :desc => "Path to the Omnibus project root."
+
+      method_option :timestamp,
+        :aliases => [:t],
+        :type => :boolean,
+        :default => true,
+        :desc => "Append timestamp information to the version identifier? Add a timestamp for build versions; leave it off for release and pre-release versions"
+      desc "project PROJECT", "Build the given Omnibus project"
+      def project(project_name)
+        project = load_project!(project_name)
+        project_task_name = "projects:#{project.name}"
+
+        say("Building #{project.name}", :green)
+        unless options[:timestamp]
+          say("I won't append a timestamp to the version identifier.", :yellow)
+        end
+
+        # Until we have time to integrate the CLI deeply into the Omnibus codebase
+        # this will have to suffice! (sadpanda)
+        ENV['OMNIBUS_APPEND_TIMESTAMP'] = options[:timestamp].to_s
+
+        Rake::Task[project_task_name].invoke
+      end
+
+      desc "software PROJECT SOFTWARE", "Build the given software component"
+      def software(project_name, software_name)
+        project = load_project!(project_name)
+        software_task_name = "projects:#{project.name}:software:#{software_name}"
+
+        say("Building #{software_name} for #{project.name} project", :green)
+
+        Rake::Task[software_task_name].invoke
+      end
+
+    end
+  end
+end

data/lib/omnibus/cli/cache.rb

@@ -0,0 +1,60 @@
+#
+# Copyright:: Copyright (c) 2013 Opscode, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# 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
+
+      desc "list", "List all cached files (by S3 key)"
+      def list
+        S3Cache.new.list_by_key.each {|k| puts k}
+      end
+
+      desc "missing", "Lists source packages that are required but not yet cached"
+      def missing
+        S3Cache.new.missing.each {|s| puts s.name}
+      end
+
+      desc "fetch", "Fetches missing source packages to local tmp dir"
+      def fetch
+        S3Cache.new.fetch_missing
+      end
+
+      desc "populate", "Populate the S3 Cache"
+      def populate
+        S3Cache.new.populate
+      end
+
+    end
+  end
+end

data/lib/omnibus/config.rb

@@ -0,0 +1,186 @@
+#
+# Copyright:: Copyright (c) 2012 Opscode, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'mixlib/config'
+require 'omnibus/exceptions'
+
+module Omnibus
+
+  # Global configuration object for Omnibus runs.
+  #
+  # @todo Write a {http://yardoc.org/guides/extending-yard/writing-handlers.html
+  #   Yard handler} for Mixlib::Config-style DSL methods.  I'd like
+  #   the default value to show up in the docs without having to type
+  #   it out twice, which I'm doing now for benefit of viewers of the Yard docs.
+  class Config
+    extend Mixlib::Config
+
+    # @!group Directory Configuration Parameters
+
+    # @!attribute [rw] cache_dir
+    #   The absolute path to the directory on the virtual machine where
+    #   code will be cached.
+    #
+    #   Defaults to `"/var/cache/omnibus/cache"`.
+    #
+    #   @return [String]
+    cache_dir "/var/cache/omnibus/cache"
+
+    # @!attribute [rw] source_dir
+    #   The absolute path to the directory on the virtual machine where
+    #   source code will be downloaded.
+    #
+    #   Defaults to `"/var/cache/omnibus/src"`.
+    #
+    #   @return [String]
+    source_dir "/var/cache/omnibus/src"
+
+    # @!attribute [rw] build_dir
+    #   The absolute path to the directory on the virtual machine where
+    #   software will be built.
+    #
+    #   Defaults to `"/var/cache/omnibus/build"`.
+    #
+    #   @return [String]
+    build_dir "/var/cache/omnibus/build"
+
+    # @!attribute [rw] package_dir
+    #   The absolute path to the directory on the virtual machine where
+    #   packages will be constructed.
+    #
+    #   Defaults to `"/var/cache/omnibus/pkg"`.
+    #
+    #   @return [String]
+    package_dir "/var/cache/omnibus/pkg"
+
+    # @!attribute [rw] project_dir
+    #   The relative path of the directory containing {Omnibus::Project}
+    #   DSL files.  This is relative to {#project_root}.
+    #
+    #   Defaults to `"config/projects"`.
+    #
+    #   @return [String]
+    project_dir "config/projects"
+
+    # @!attribute [rw] software_dir
+    #   The relative path of the directory containing {Omnibus::Software}
+    #   DSL files.  This is relative {#project_root}.
+    #
+    #   Defaults to `"config/software"`.
+    #
+    #   @return [String]
+    software_dir "config/software"
+
+    # @!attribute [rw] project_root
+    #   The root directory in which to look for {Omnibus::Project} and
+    #   {Omnibus::Software} DSL files.
+    #
+    #   Defaults to the current working directory.
+    #
+    #   @return [String]
+    project_root Dir.pwd
+
+    # @!attribute [rw] install_dir
+    #   Installation directory
+    #
+    #   Defaults to `"/opt/chef"`.
+    #
+    #   @todo This appears to be unused, and actually conflated with
+    #     {Omnibus::Project#install_path}
+    #
+    #   @return [String]
+    install_dir "/opt/chef"
+
+    # @!endgroup
+
+    # @!group S3 Caching Configuration Parameters
+
+    # @!attribute [rw] use_s3_caching
+    #   Indicate if you wish to cache software artifacts in S3 for
+    #   quicker build times.  Requires {#s3_bucket}, {#s3_access_key},
+    #   and {#s3_secret_key} to be set if this is set to `true`.
+    #
+    #   Defaults to `false`.
+    #
+    #   @return [Boolean]
+    use_s3_caching false
+
+    # @!attribute [rw] s3_bucket
+    #   The name of the S3 bucket you want to cache software artifacts in.
+    #
+    #   Defaults to `nil`.  Must be set if {#use_s3_caching} is `true`.
+    #
+    #   @return [String, nil]
+    s3_bucket nil
+
+    # @!attribute [rw] s3_access_key
+    #   The S3 access key to use with S3 caching.
+    #
+    #   Defaults to `nil`.  Must be set if {#use_s3_caching} is `true`.
+    #
+    #   @return [String, nil]
+    s3_access_key nil
+
+    # @!attribute [rw] s3_secret_key
+    #   The S3 secret key to use with S3 caching.
+    #
+    #   Defaults to `nil`.  Must be set if {#use_s3_caching} is `true.`
+    #
+    #   @return [String, nil]
+    s3_secret_key nil
+
+    # @!endgroup
+
+    # @!group Miscellaneous Configuration Parameters
+
+    # @!attribute [rw] override_file
+    #
+    #   @return [Boolean]
+    override_file nil
+
+    # @!attribute [rw] solaris_compiler
+    #
+    #   @return [String, nil]
+    solaris_compiler nil
+
+    # @!endgroup
+
+    # @!group Validation Methods
+
+    # Asserts that the Config object is in a valid state.  If invalid
+    # for any reason, an exception will be thrown.
+    #
+    # @raise [RuntimeError]
+    # @return [void]
+    def self.validate
+      valid_s3_config?
+      # add other validation methods as needed
+    end
+
+    # @raise [InvalidS3Configuration]
+    def self.valid_s3_config?
+      if use_s3_caching
+        unless s3_bucket
+          raise InvalidS3Configuration.new(s3_bucket, s3_access_key, s3_secret_key)
+        end
+      end
+    end
+
+    # @!endgroup
+
+  end # Config
+end # Omnibus

data/lib/omnibus/exceptions.rb

@@ -0,0 +1,54 @@
+module Omnibus
+
+  class InvalidS3Configuration < RuntimeError
+    def initialize(s3_bucket, s3_access_key, s3_secret_key)
+      @s3_bucket, @s3_access_key, @s3_secret_key = s3_bucket, s3_access_key, s3_secret_key
+    end
+
+    def to_s
+      """
+      One or more required S3 configuration values is missing.
+
+      Your effective configuration was the following:
+
+          s3_bucket     => #{@s3_bucket.inspect}
+          s3_access_key => #{@s3_access_key.inspect}
+          s3_secret_key => #{@s3_secret_key.inspect}
+
+      If you truly do want S3 caching, you should add values similar
+      to the following in your Omnibus config file:
+
+            s3_bucket      ENV['S3_BUCKET_NAME']
+            s3_access_key  ENV['S3_ACCESS_KEY']
+            s3_secret_key  ENV['S3_SECRET_KEY']
+
+      Note that you are not required to use environment variables as
+      illustrated (and the ones listed have no special significance in
+      Omnibus), but it is encouraged to prevent spread of sensitive
+      information and inadvertent check-in of same to version control
+      systems.
+
+      """
+    end
+  end
+
+  # Raise this error if a needed Project configuration value has not
+  # been set.
+  class MissingProjectConfiguration < RuntimeError
+    def initialize(parameter_name, sample_value)
+      @parameter_name, @sample_value = parameter_name, sample_value
+    end
+
+    def to_s
+      """
+      You are attempting to build a project, but have not specified
+      a value for '#{@parameter_name}'!
+
+      Please add code similar to the following to your project DSL file:
+
+         #{@parameter_name} '#{@sample_value}'
+
+      """
+    end
+  end
+end