omnibus-sonian 1.2.0.1

data/lib/omnibus/clean_tasks.rb

@@ -0,0 +1,30 @@
+#
+# 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.
+#
+
+# Adds source and build artifacts to Rake's CLEAN list, and install
+# and cache artifacts to its CLOBBER list, ensuring that the `clean`
+# and `clobber` Rake tasks do the right thing for Omnibus projects.
+#
+# @see https://github.com/jimweirich/rake/blob/master/lib/rake/clean.rb
+
+require 'rake/clean'
+
+::CLEAN.include("#{Omnibus.config.source_dir}/**/*",
+                "#{Omnibus.config.build_dir}/**/*")
+
+::CLOBBER.include("#{Omnibus.config.cache_dir}/**/*",
+                  "#{Omnibus.config.package_dir}/**/*")

data/lib/omnibus/cli.rb

@@ -0,0 +1,35 @@
+#
+# 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 'omnibus/cli/application'
+require 'omnibus/cli/base'
+require 'omnibus/cli/build'
+
+module Omnibus
+  module CLI
+
+    class Error < StandardError
+      attr_reader :original
+
+      def initialize(msg, original=nil)
+        super(msg)
+        @original = original
+      end
+    end
+
+  end
+end

data/lib/omnibus/cli/application.rb

@@ -0,0 +1,140 @@
+#
+# 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'
+require 'omnibus/cli/base'
+require 'omnibus/cli/build'
+require 'omnibus/cli/cache'
+require 'omnibus/cli/release'
+
+module Omnibus
+  module CLI
+    class Application < Base
+
+      method_option :purge,
+        :type => :boolean,
+        :default => false,
+        :desc => "Remove ALL files generated during the build (including packages)."
+      method_option :path,
+        :aliases => [:p],
+        :type => :string,
+        :default => Dir.pwd,
+        :desc => "Path to the Omnibus project root."
+      desc "clean PROJECT", "Remove temporary files generated during the build process."
+      def clean(project_name)
+        project = load_project!(project_name)
+
+        deletion_list = []
+        deletion_list << Dir.glob("#{Omnibus.config.source_dir}/**/*")
+        deletion_list << Dir.glob("#{Omnibus.config.build_dir}/**/*")
+
+        if options[:purge]
+          deletion_list << Dir.glob("#{Omnibus.config.package_dir}/**/*")
+          deletion_list << Dir.glob("#{Omnibus.config.cache_dir}/**/*")
+          deletion_list << project.install_path if File.exist?(project.install_path)
+        end
+
+        deletion_list.flatten!
+        deletion_list.each{|f| remove_file(f) }
+      end
+
+      desc "project PROJECT", "Creates a skeletal Omnibus project"
+      def project(name)
+        name = name.chomp("/") # remove trailing slash if present
+        target = File.join(Dir.pwd, "omnibus-#{name}")
+        install_path = File.join("/opt", name)
+        opts = {
+          :name => name,
+          :install_path => install_path
+        }
+
+        # core project files
+        template(File.join("Gemfile.erb"), File.join(target, "Gemfile"), opts)
+        template(File.join("gitignore.erb"), File.join(target, ".gitignore"), opts)
+        template(File.join("README.md.erb"), File.join(target, "README.md"), opts)
+        template(File.join("omnibus.rb.example.erb"), File.join(target, "omnibus.rb.example"), opts)
+
+        # project definition
+        template(File.join("project.rb.erb"), File.join(target, "config", "projects", "#{name}.rb"), opts)
+
+        # example software definitions
+        config_software = File.join(target, "config", "software")
+        template(File.join("software", "c-example.rb.erb"),
+                 File.join(config_software, "c-example.rb"), opts)
+        template(File.join("software", "erlang-example.rb.erb"),
+                 File.join(config_software, "erlang-example.rb"), opts)
+        template(File.join("software", "ruby-example.rb.erb"),
+                 File.join(config_software, "ruby-example.rb"), opts)
+
+        # Vagrant build lab
+        template(File.join("Berksfile.erb"), File.join(target, "Berksfile"), opts)
+        template(File.join("Vagrantfile.erb"), File.join(target, "Vagrantfile"), opts)
+
+        # render out stub packge scripts
+        %w{ makeselfinst postinst postrm }.each do |package_script|
+          script_path = File.join(target, "package-scripts", name, package_script)
+          template_path = File.join("package_scripts", "#{package_script}.erb")
+          # render the package script
+          template(template_path, script_path, opts)
+          # ensure the package script is executable
+          FileUtils.chmod(0755, script_path)
+        end
+      end
+
+      desc "version", "Display version information"
+      def version
+        say("Omnibus: #{Omnibus::VERSION}", :yellow)
+      end
+
+      ###########################################################################
+      # Subcommands
+      ###########################################################################
+
+      desc "build [COMMAND]", "Perform build-related tasks"
+      subcommand "build", Omnibus::CLI::Build
+
+      desc "cache [COMMAND]", "Perform cache management tasks"
+      subcommand "cache", Omnibus::CLI::Cache
+
+      desc "release [COMMAND]", "Perform release tasks"
+      subcommand "release", Omnibus::CLI::Release
+
+      ###########################################################################
+      # Class Methods
+      ###########################################################################
+
+      # Override start so we can catch and process any exceptions bubbling up
+      def self.start(*args)
+        begin
+          super
+        rescue => e
+          error_msg = "Something went wrong...the Omnibus just ran off the road!"
+          error_msg << "\n\nError raised was:\n\n\t#{$!}"
+          error_msg << "\n\nBacktrace:\n\n\t#{e.backtrace.join("\n\t")}"
+          if e.respond_to?(:original) && e.original
+            error_msg << "\n\nOriginal Error:\n\n\t#{e.original}"
+            error_msg << "\n\nOriginal Backtrace:\n\n\t#{e.original.backtrace.join("\n\t")}"
+          end
+          # TODO - we need a proper UI class
+          Thor::Base.shell.new.say(error_msg, :red)
+          exit 1
+        end
+      end
+
+    end
+  end
+end

data/lib/omnibus/cli/base.rb

@@ -0,0 +1,118 @@
+#
+# 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. 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
+        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?
+            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 anything 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,62 @@
+#
+# 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}"
+
+        unless options[:timestamp]
+          say("I won't append a timestamp to the version identifier.", :yellow)
+        end
+        say("Building #{project.name} #{project.build_version}", :green)
+
+        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