omnibus-sonian 1.2.0.1

data/lib/omnibus/cli/release.rb

@@ -0,0 +1,49 @@
+#
+# 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/cli/application'
+require 'omnibus/package_release'
+require 'json'
+
+module Omnibus
+  module CLI
+
+
+    class Release < Base
+
+      namespace :release
+
+      def initialize(args, options, config)
+        super(args, options, config)
+      end
+
+      desc "package PATH", "Upload a single package to S3"
+      option :public, :type => :boolean, :default => false, :desc => "Make S3 object publicly readable"
+      def package(path)
+        access_policy = options[:public] ? :public_read : :private
+
+        uploader = PackageRelease.new(path, :access => access_policy) do |uploaded_item|
+          say("Uploaded #{uploaded_item}", :green)
+        end
+        uploader.release
+      end
+
+    end
+  end
+end
+

data/lib/omnibus/config.rb

@@ -0,0 +1,224 @@
+#
+# 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'
+require 'json'
+
+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 S3 Release Parameters
+
+    # @!attribute [rw] release_s3_bucket
+    #   The name of the S3 bucket you want to release artifacts to.
+    #
+    #   Defaults to `nil`.  Must be set to use `release package` command.
+    #
+    #   @return [String, nil]
+    release_s3_bucket nil
+
+    # @!attribute [rw] release_s3_access_key
+    #   The S3 access key to use for S3 artifact release.
+    #
+    #   Defaults to `nil`.  Must be set to use `release package` command.
+    #
+    #   @return [String, nil]
+    release_s3_access_key nil
+
+    # @!attribute [rw] release_s3_secret_key
+    #   The S3 secret key to use for S3 artifact release
+    #
+    #   Defaults to `nil`.  Must be set to use `release package` command.
+    #
+    #   @return [String, nil]
+    release_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 Build Version Parameters
+
+    # @!attribute [rw] append_timestamp
+    #
+    #   @return [Boolean]
+    append_timestamp true
+
+    # # @!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,143 @@
+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
+
+  class NoPackageFile < RuntimeError
+    def initialize(package_path)
+      @package_path = package_path
+    end
+
+    def to_s
+      """
+      Cannot locate or access the package at the given path:
+
+        #{@package_path}
+      """
+    end
+  end
+
+  class NoPackageMetadataFile < RuntimeError
+    def initialize(package_metadata_path)
+      @package_metadata_path = package_metadata_path
+    end
+
+    def to_s
+      """
+      Cannot locate or access the package metadata file at the given path:
+
+        #{@package_metadata_path}
+      """
+    end
+  end
+
+  class InvalidS3ReleaseConfiguration < 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:
+
+          release_s3_bucket     => #{@s3_bucket.inspect}
+          release_s3_access_key => #{@s3_access_key.inspect}
+          release_s3_secret_key => #{@s3_secret_key.inspect}
+
+      To release a package to S3, add the following values to your
+      config file:
+
+          release_s3_bucket      ENV['S3_BUCKET_NAME']
+          release_s3_access_key  ENV['S3_ACCESS_KEY']
+          release_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
+
+  class MissingPatch < RuntimeError
+    def initialize(patch_name, search_paths)
+      @patch_name, @search_paths = patch_name, search_paths
+    end
+
+    def to_s
+      """
+      Attempting to apply the patch #{@patch_name}, but it was not
+      found at any of the following locations:
+
+      #{@search_paths.join("\n      ")}
+      """
+    end
+  end
+
+  class MissingProjectDependency < RuntimeError
+    def initialize(dep_name, search_paths)
+      @dep_name, @search_paths = dep_name, search_paths
+    end
+
+    def to_s
+      """
+      Attempting to load the project dependency '#{@dep_name}', but it was
+      not found at any of the following locations:
+
+      #{@search_paths.join("\n      ")}
+      """
+    end
+  end
+end

data/lib/omnibus/fetcher.rb

@@ -0,0 +1,184 @@
+#
+# 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 'pp'
+
+module Omnibus
+
+  # Base class for classes that fetch project sources from the internet.
+  #
+  # @abstract Subclass and override the {#clean}, {#description},
+  #   {#fetch}, {#fetch_required?}, and {#version_guid} methods
+  #
+  # @todo Is this class supposed to be abstract or not?  Pretty sure
+  #   it's supposed to be abstract
+  class Fetcher
+
+    # Given an error and a fetcher that generated the error, print a
+    # formatted report of the error and stacktrace, along with fetcher
+    # details to stderr.
+    #
+    # @note Does not rethrow the error; that must currently be done manually.
+    #
+    # @todo Since this is always called from within a fetcher, and
+    #   since the fetcher always passes itself in in the {#initialize}
+    #   method, this really ought to be encapsulated in a method call on
+    #   {Omnibus::Fetcher}.
+    # @todo Also, since we always 'raise' after calling {#explain}, we
+    #   should just go ahead and exit from here.  No need to raise,
+    #   since we're already outputting the real error and stacktrace
+    #   here.
+    class ErrorReporter
+
+      def initialize(error, fetcher)
+        @error, @fetcher = error, fetcher
+      end
+
+      # @todo Why not just make an attribute for error?
+      #
+      # @todo And for that matter, why not make an attribute for the
+      #   fetcher as well?  Or why not just use `@error` like we use
+      #   `@fetcher`?
+      def e
+        @error
+      end
+
+      # @todo If {Omnibus::Fetcher#description} is meant to show
+      #   parameters (presumably the kind of fetcher and the software it
+      #   is fetching?),
+      def explain(why)
+        $stderr.puts "* " * 40
+        $stderr.puts why
+        $stderr.puts "Fetcher params:"
+        $stderr.puts indent(@fetcher.description, 2)
+        $stderr.puts "Exception:"
+        $stderr.puts indent("#{e.class}: #{e.message.strip}", 2)
+        Array(e.backtrace).each {|l| $stderr.puts indent(l, 4) }
+        $stderr.puts "* " * 40
+      end
+
+      private
+
+      # Indent each line of a string with `n` spaces.
+      #
+      # Splits the string at `\n` characters and then pads the left
+      # side with `n` spaces.  Rejoins them all again with `\n`.
+      #
+      # @param string [String] the string to indent
+      # @param n [Fixnum] the number of " " characters to indent each line.
+      # @return [String]
+      def indent(string, n)
+        string.split("\n").map {|l| " ".rjust(n) << l }.join("\n")
+      end
+
+    end
+
+    class UnsupportedSourceLocation < ArgumentError
+    end
+
+    NULL_ARG = Object.new
+
+    # Returns an implementation of {Fetcher} that can retrieve the
+    # given software.
+    #
+    # @param software [Omnibus::Software] the software the Fetcher should fetch
+    # @return [Omnibus::Fetcher]
+    def self.for(software)
+      if software.source
+        if software.source[:url] && Omnibus.config.use_s3_caching
+          S3CacheFetcher.new(software)
+        else
+          without_caching_for(software)
+        end
+      else
+        Fetcher.new(software)
+      end
+    end
+
+    # @param software [Omnibus::Software] the software to fetch
+    # @raise [UnsupportedSourceLocation] if the software's source is not
+    #   one of `:url`, `:git`, or `:path`
+    # @see Omnibus::Software#source
+    # @todo Define an enumeration of the acceptable software types
+    # @todo This probably ought to be folded into {#for} method above.
+    #   It looks like this is called explicitly in
+    #   {Omnibus::S3Cache#fetch}, but that could be handled by having a
+    #   second optional parameter that always disables caching.
+    # @todo Since the software determines what fetcher must be used to
+    #   fetch it, perhaps this should be a method on {Omnibus::Software}
+    #   instead.
+    def self.without_caching_for(software)
+      if software.source[:url]
+        NetFetcher.new(software)
+      elsif software.source[:git]
+        GitFetcher.new(software)
+      elsif software.source[:path]
+        PathFetcher.new(software)
+      else
+        raise UnsupportedSourceLocation, "Don't know how to fetch software project #{software}"
+      end
+    end
+
+    def self.name(name=NULL_ARG)
+      @name = name unless name.equal?(NULL_ARG)
+      @name
+    end
+
+    attr_reader :name
+
+    # @todo What is this?  It doesn't appear to be used anywhere
+    attr_reader :source_timefile
+
+    def initialize(software)
+    end
+
+    def log(message)
+      puts "[fetcher:#{self.class.name}::#{name}] #{message}"
+    end
+
+    # @!group Methods for Subclasses to Implement
+
+    # @todo All extenders of this class override this method.  Since
+    #   this class appears to be intended as an abstract one, this
+    #   should raise a NotImplementedError
+    def description
+      # Not as pretty as we'd like, but it's a sane default:
+      inspect
+    end
+
+    # @todo All extenders of this class override this method.  Since
+    #   this class appears to be intended as an abstract one, this
+    #   should raise a NotImplementedError
+    def fetch_required?
+      false
+    end
+
+    # @todo Empty method is very suspicious; raise NotImplementedError instead.
+    def clean
+    end
+
+    # @todo Empty method is very suspicious; raise NotImplementedError instead.
+    def fetch
+    end
+
+    # @todo Empty method is very suspicious; raise NotImplementedError instead.
+    def version_guid
+    end
+
+    # !@endgroup
+  end
+end