omnibus 3.0.0 → 3.1.0

data/lib/omnibus/fetchers/git_fetcher.rb

@@ -1,6 +1,5 @@
 #
-# Copyright:: Copyright (c) 2012-2014 Chef Software, Inc.
-# License:: Apache License, Version 2.0
+# Copyright 2012-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,13 +14,9 @@
 # limitations under the License.
 #
 
-require 'omnibus/exceptions'
-
 module Omnibus
   # Fetcher implementation for projects in git.
   class GitFetcher < Fetcher
-    name :git
-
     attr_reader :source
     attr_reader :project_dir
     attr_reader :version
@@ -31,13 +26,14 @@ module Omnibus
       @source       = software.source
       @version      = software.version
       @project_dir  = software.project_dir
+      super
     end
 
     def description
-      <<-E
-repo URI:       #{@source[:git]}
-local location: #{@project_dir}
-E
+      <<-EOH.gsub(/^ {8}/, '').strip
+        repo URI:       #{@source[:git]}
+        local location: #{@project_dir}
+      EOH
     end
 
     def version_guid
@@ -47,11 +43,8 @@ E
 
     def clean
       if existing_git_clone?
-        log 'cleaning existing build'
-        clean_cmd = 'git clean -fdx'
-        shell = Mixlib::ShellOut.new(clean_cmd, live_stream: STDOUT, cwd: project_dir)
-        shell.run_command
-        shell.error!
+        log.info(log_key) { 'Cleaning existing build' }
+        quiet_shellout!('git clean -fdx', cwd: project_dir)
       end
     rescue Exception => e
       ErrorReporter.new(e, self).explain("Failed to clean git repository '#{@source[:git]}'")
@@ -78,37 +71,43 @@ E
         # Deal with github failing all the time :(
         time_to_sleep = 5 * (2**retries)
         retries += 1
-        log "git clone/fetch failed for #{@source} #{retries} time(s), retrying in #{time_to_sleep}s"
+        log.warn(log_key) do
+          "git clone/fetch failed for #{@source} #{retries} time(s). " \
+          "Retrying in #{time_to_sleep}s..."
+        end
         sleep(time_to_sleep)
         retry
       end
     end
 
+    # Return the target sha to be used during build caching
+    # This overrides the cases where software.version is similar to
+    # master, 11-stable etc..
+    def version_for_cache
+      target_revision
+    end
+
     private
 
     def clone
-      puts 'cloning the source from git'
-      clone_cmd = "git clone #{@source[:git]} #{project_dir}"
-      shell = Mixlib::ShellOut.new(clone_cmd, live_stream: STDOUT)
-      shell.run_command
-      shell.error!
+      log.info(log_key) { 'Cloning the source from git' }
+      quiet_shellout!("git clone #{@source[:git]} #{project_dir}")
     end
 
     def checkout
       sha_ref = target_revision
-
-      checkout_cmd = "git checkout #{sha_ref}"
-      shell = Mixlib::ShellOut.new(checkout_cmd, live_stream: STDOUT, cwd: project_dir)
-      shell.run_command
-      shell.error!
+      quiet_shellout!("git checkout #{sha_ref}", cwd: project_dir)
     end
 
     def fetch_updates
-      puts "fetching updates and resetting to revision #{target_revision}"
-      fetch_cmd = "git fetch origin && git fetch origin --tags && git reset --hard #{target_revision}"
-      shell = Mixlib::ShellOut.new(fetch_cmd, live_stream: STDOUT, cwd: project_dir)
-      shell.run_command
-      shell.error!
+      log.info(log_key) do
+        "Fetching updates and resetting to revision '#{target_revision}'"
+      end
+
+      fetch_cmd = "git fetch origin && " \
+                  "git fetch origin --tags && " \
+                  "git reset --hard #{target_revision}"
+      quiet_shellout!(fetch_cmd, cwd: project_dir)
     end
 
     def existing_git_clone?
@@ -120,24 +119,20 @@ E
     end
 
     def current_revision
-      @current_rev ||= begin
-                         rev_cmd = 'git rev-parse HEAD'
-                         shell = Mixlib::ShellOut.new(rev_cmd, live_stream: STDOUT, cwd: project_dir)
-                         shell.run_command
-                         shell.error!
-                         output = shell.stdout
+      return @current_rev if @current_rev
 
-                         sha_hash?(output) ? output : nil
-                       end
+      cmd = quiet_shellout!('git rev-parse HEAD', cwd: project_dir)
+      stdout = cmd.stdout
+
+      @current_rev = sha_hash?(stdout) ? stdout : nil
+      @current_rev
     end
 
     def target_revision
-      @target_rev ||= begin
-                        if sha_hash?(version)
-                          version
-                        else
-                          revision_from_remote_reference(version)
-                        end
+      @target_rev ||= if sha_hash?(version)
+                        version
+                      else
+                        revision_from_remote_reference(version)
                       end
     end
 
@@ -153,14 +148,11 @@ E
       # allows us to return the SHA of the tagged commit for annotated
       # tags. We take care to only return exact matches in
       # process_remote_list.
-      cmd = "git ls-remote origin #{ref}*"
-      shell = Mixlib::ShellOut.new(cmd, live_stream: STDOUT, cwd: project_dir)
-      shell.run_command
-      shell.error!
-      commit_ref = process_remote_list(shell.stdout, ref)
+      cmd = quiet_shellout!("git ls-remote origin #{ref}*", cwd: project_dir)
+      commit_ref = process_remote_list(cmd.stdout, ref)
 
       unless commit_ref
-        fail UnresolvableGitReference.new("Could not resolve `#{ref}' to a SHA.")
+        raise UnresolvableGitReference.new("Could not resolve `#{ref}' to a SHA.")
       end
       commit_ref
     rescue UnresolvableGitReference => e # skip retries
@@ -174,12 +166,15 @@ E
     rescue Exception => e
       if retries >= 3
         ErrorReporter.new(e, self).explain("Failed to find any commits for the ref '#{ref}'")
-        fail
+        raise
       else
         # Deal with github failing all the time :(
         time_to_sleep = 5 * (2**retries)
         retries += 1
-        log "git ls-remote failed for #{@source} #{retries} time(s), retrying in #{time_to_sleep}s"
+        log.warn(log_key) do
+          "git ls-remote failed for #{@source} #{retries} time(s). " \
+          "Retrying in #{time_to_sleep}s..."
+        end
         sleep(time_to_sleep)
         retry
       end

data/lib/omnibus/fetchers/net_fetcher.rb

@@ -1,6 +1,5 @@
 #
-# Copyright:: Copyright (c) 2012-2014 Chef Software, Inc.
-# License:: Apache License, Version 2.0
+# Copyright 2012-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.
@@ -24,8 +23,6 @@ module Omnibus
 
   # Fetcher Implementation for HTTP and FTP hosted tarballs
   class NetFetcher < Fetcher
-    name :net
-
     attr_reader :name
     attr_reader :project_file
     attr_reader :source
@@ -41,14 +38,15 @@ module Omnibus
       @source_uri   = software.source_uri
       @source_dir   = software.source_dir
       @project_dir  = software.project_dir
+      super
     end
 
     def description
-      <<-E
-source URI:     #{source_uri}
-checksum:       #{@checksum}
-local location: #{@project_file}
-E
+      <<-EOH.gsub(/^ {8}/, '').strip
+        source URI:     #{source_uri}
+        checksum:       #{@checksum}
+        local location: #{@project_file}
+      EOH
     end
 
     def version_guid
@@ -61,7 +59,8 @@ E
 
     def clean
       if File.exist?(project_dir)
-        log "cleaning existing build from #{project_dir}"
+        log.info(log_key) { "Cleaning existing build from #{project_dir}" }
+
         FileUtils.rm_rf(project_dir)
       end
       extract
@@ -72,13 +71,13 @@ E
         download
         verify_checksum!
       else
-        log 'Cached copy of source tarball up to date'
+        log.debug(log_key) { 'Cached copy of source tarball up to date' }
       end
     end
 
     def get_with_redirect(url, headers, limit = 10)
-      fail ArgumentError, 'HTTP redirect too deep' if limit == 0
-      log "getting from #{url} with #{limit} redirects left"
+      raise ArgumentError, 'HTTP redirect too deep' if limit == 0
+      log.info(log_key) { "Getting from #{url} with #{limit} redirects left" }
 
       url = URI.parse(url) unless url.kind_of?(URI)
 
@@ -132,8 +131,8 @@ E
     def download
       tries = 5
       begin
-        log "\033[1;31m#{source[:warning]}\033[0m" if source.key?(:warning)
-        log "fetching #{project_file} from #{source_uri}"
+        log.warn(log_key) { source[:warning] } if source.key?(:warning)
+        log.info(log_key) { "Fetching #{project_file} from #{source_uri}" }
 
         case source_uri.scheme
         when /https?/
@@ -152,12 +151,12 @@ E
             ftp.close
           end
         else
-          fail UnsupportedURIScheme, "Don't know how to download from #{source_uri}"
+          raise UnsupportedURIScheme, "Don't know how to download from #{source_uri}"
         end
       rescue Exception
         tries -= 1
         if tries != 0
-          log 'retrying failed download...'
+          log.debug(log_key) { "Retrying failed download (#{tries})..." }
           retry
         else
           raise
@@ -171,25 +170,26 @@ E
     def verify_checksum!
       actual_md5 = Digest::MD5.file(project_file)
       unless actual_md5 == @checksum
-        log "Invalid MD5 for #{@name}"
-        log "Expected: #{@checksum}"
-        log "Actual:   #{actual_md5}"
-        fail InvalidSourceFile, "Checksum of downloaded file #{project_file} doesn't match expected"
+        log.warn(log_key) { "Invalid MD5 for #{@name}" }
+        log.warn(log_key) { "Expected: #{@checksum}" }
+        log.warn(log_key) { "Actual:   #{actual_md5}" }
+        raise InvalidSourceFile, "Checksum of downloaded file #{project_file} doesn't match expected"
       end
     end
 
     def extract
-      log "extracting the source in #{project_file} to #{source_dir}"
+      log.info(log_key) do
+        "Extracting the source in '#{project_file}' to '#{source_dir}'"
+      end
+
       cmd = extract_cmd
       case cmd
       when Proc
         cmd.call
       when String
-        shell = Mixlib::ShellOut.new(cmd, live_stream: STDOUT)
-        shell.run_command
-        shell.error!
+        quiet_shellout!(cmd)
       else
-        fail "Don't know how to extract command for #{cmd.class} class"
+        raise "Don't know how to extract command for #{cmd.class} class"
       end
     rescue Exception => e
       ErrorReporter.new(e, self).explain("Failed to unpack archive at #{project_file} (#{e.class}: #{e.message.strip})")
@@ -210,7 +210,9 @@ E
       else
         # if we don't recognize the extension, simply copy over the file
         proc do
-          log "#{project_file} not an archive. Copying to #{project_dir}"
+          log.debug(log_key) do
+            "'#{project_file}' is not an archive. Copying to '#{project_dir}'..."
+          end
           # WARNING: hack hack hack, no project dir yet
           FileUtils.mkdir_p(project_dir)
           FileUtils.cp(project_file, project_dir)

data/lib/omnibus/fetchers/path_fetcher.rb

@@ -1,6 +1,5 @@
 #
-# Copyright:: Copyright (c) 2012-2014 Chef Software, Inc.
-# License:: Apache License, Version 2.0
+# Copyright 2012-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.
@@ -18,33 +17,31 @@
 module Omnibus
   # Fetcher implementation for projects on the filesystem
   class PathFetcher < Fetcher
-    name :path
-
     def initialize(software)
       @name = software.name
       @source = software.source
       @project_dir = software.project_dir
       @version = software.version
+      super
     end
 
     def description
-      <<-E
-source path:    #{@source[:path]}
-local location: #{@project_dir}
-E
+      <<-EOH.gsub(/^ {8}/, '').strip
+        source path:    #{@source[:path]}
+        local location: #{@project_dir}
+      EOH
     end
 
     def rsync
-      if OHAI.platform == 'windows'
+      if Ohai.platform == 'windows'
         # Robocopy's return code is 1 if it succesfully copies over the
         # files and 0 if the files are already existing at the destination
         sync_cmd = "robocopy #{@source[:path]}\\ #{@project_dir}\\ /MIR /S"
-        shell = Mixlib::ShellOut.new(sync_cmd, returns: [0, 1])
+        quiet_shellout!(sync_cmd, returns: [0, 1])
       else
         sync_cmd = "rsync --delete -a #{@source[:path]}/ #{@project_dir}/"
-        shell = Mixlib::ShellOut.new(sync_cmd)
+        quiet_shellout!(sync_cmd)
       end
-      shell.run_command
     end
 
     def clean

data/lib/omnibus/fetchers/s3_cache_fetcher.rb

@@ -1,6 +1,5 @@
 #
-# Copyright:: Copyright (c) 2012-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,22 +14,20 @@
 # limitations under the License.
 #
 
-require 'omnibus/fetcher'
-require 'omnibus/s3_cacher'
-
 module Omnibus
   class S3CacheFetcher < NetFetcher
     include SoftwareS3URLs
 
-    name :s3cache
-
     def initialize(software)
       @software = software
       super
     end
 
     def fetch
-      log "S3 Cache enabled, #{name} will be fetched from S3 cache"
+      log.info(log_key) do
+        "S3 Cache enabled, '#{name}' will be fetched from S3 cache"
+      end
+
       super
     end
 

data/lib/omnibus/generator.rb

@@ -0,0 +1,131 @@
+#
+# 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.
+# 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 'thor'
+
+module Omnibus
+  class Generator < Thor::Group
+    include Thor::Actions
+
+    namespace :new
+
+    argument :name,
+      banner: 'NAME',
+      desc: 'The name of the Omnibus project',
+      type: :string,
+      required: true
+
+    class_option :path,
+      banner: 'PATH',
+      aliases: '-p',
+      desc: 'The path to create the Omnibus project',
+      type: :string,
+      default: '.'
+
+    class << self
+      #
+      # Set the source root for Thor.
+      #
+      def source_root
+        File.expand_path('../generator_files', __FILE__)
+      end
+    end
+
+    def create_project_files
+      template('Gemfile.erb', "#{target}/Gemfile", template_options)
+      template('gitignore.erb', "#{target}/.gitignore", template_options)
+      template('README.md.erb', "#{target}/README.md", template_options)
+      template('omnibus.rb.example.erb', "#{target}/omnibus.rb.example", template_options)
+    end
+
+    def create_project_definition
+      template('project.rb.erb', "#{target}/config/projects/#{name}.rb", template_options)
+    end
+
+    def create_example_software_definitions
+      template('software/c-example.rb.erb', "#{target}/config/software/c-example.rb", template_options)
+      template('software/erlang-example.rb.erb', "#{target}/config/software/erlang-example.rb", template_options)
+      template('software/ruby-example.rb.erb', "#{target}/config/software/ruby-example.rb", template_options)
+    end
+
+    def create_kitchen_files
+      template('.kitchen.local.yml.erb', "#{target}/.kitchen.local.yml", template_options)
+      template('.kitchen.yml.erb', "#{target}/.kitchen.yml", template_options)
+      template('Berksfile.erb', "#{target}/Berksfile", template_options)
+    end
+
+    def create_package_scripts
+      %w(makeselfinst preinst prerm postinst postrm).each do |package_script|
+        script_path = "#{target}/package-scripts/#{name}/#{package_script}"
+        template("package_scripts/#{package_script}.erb", script_path, template_options)
+
+        # #nsure the package script is executable
+        chmod(script_path, 0755)
+      end
+    end
+
+    def create_pkg_assets
+      template('mac_pkg/license.html.erb', "#{target}/files/mac_pkg/Resources/license.html", template_options)
+      template('mac_pkg/welcome.html.erb', "#{target}/files/mac_pkg/Resources/welcome.html", template_options)
+      copy_file('mac_pkg/background.png', "#{target}/files/mac_pkg/Resources/background.png")
+    end
+
+    def create_dmg_assets
+      copy_file('mac_dmg/background.png', "#{target}/files/mac_dmg/Resources/background.png")
+      copy_file('mac_dmg/icon.png', "#{target}/files/mac_dmg/Resources/icon.png")
+    end
+
+    def create_windows_assets
+      # These ERB files are actually rendered as ERB files on the target system
+      # because the parameters are resolved at the build time for localization
+      # and parameters files.
+      copy_file('windows_msi/localization-en-us.wxl.erb', "#{target}/files/windows_msi/Resources/localization-en-us.wxl.erb")
+      copy_file('windows_msi/parameters.wxi.erb', "#{target}/files/windows_msi/Resources/parameters.wxi.erb")
+
+      template('windows_msi/source.wxs.erb', "#{target}/files/windows_msi/Resources/source.wxs", template_options)
+
+      copy_file('windows_msi/assets/LICENSE.rtf', "#{target}/files/windows_msi/Resources/assets/LICENSE.rtf")
+      copy_file('windows_msi/assets/banner_background.bmp', "#{target}/files/windows_msi/Resources/assets/banner_background.bmp")
+      copy_file('windows_msi/assets/dialog_background.bmp', "#{target}/files/windows_msi/Resources/assets/dialog_background.bmp")
+      copy_file('windows_msi/assets/project.ico', "#{target}/files/windows_msi/Resources/assets/project.ico")
+      copy_file('windows_msi/assets/project_16x16.ico', "#{target}/files/windows_msi/Resources/assets/project_16x16.ico")
+      copy_file('windows_msi/assets/project_32x32.ico', "#{target}/files/windows_msi/Resources/assets/project_32x32.ico")
+    end
+
+    private
+
+    #
+    # The target path to create the Omnibus project.
+    #
+    # @return [String]
+    #
+    def target
+      @target ||= File.join(File.expand_path(@options[:path]), "omnibus-#{name}")
+    end
+
+    #
+    # The list of options to pass to the template generators.
+    #
+    # @return [Hash]
+    #
+    def template_options
+      @template_options ||= {
+        name: name,
+        install_path: "/opt/#{name}",
+      }
+    end
+  end
+end