omnibus 2.0.2 → 3.0.0

data/lib/omnibus/s3_cacher.rb

@@ -122,13 +122,10 @@ module Omnibus
 
     def bucket
       @bucket ||= begin
-        if @client.exists?('/')
-          @client.bucket
-        else
-          b = UberS3::Bucket.new(@client, @client.bucket)
-          @client.connection.put('/')
-          b
-        end
+        b = UberS3::Bucket.new(@client, @client.bucket)
+        # creating the bucket is idempotent, make sure it's created:
+        @client.connection.put('/')
+        b
       end
     end
   end

data/lib/omnibus/software.rb

@@ -26,13 +26,11 @@ require 'omnibus/fetcher'
 require 'omnibus/builder'
 require 'omnibus/config'
 
-require 'rake'
+require 'fileutils'
 
 module Omnibus
   # Omnibus software DSL reader
   class Software
-    include Rake::DSL
-
     NULL_ARG = Object.new
     UNINITIALIZED = Object.new
 
@@ -55,6 +53,8 @@ module Omnibus
 
     attr_reader :whitelist_files
 
+    attr_reader :source_config
+
     def self.load(filename, project, repo_overrides = {})
       new(IO.read(filename), filename, project, repo_overrides)
     end
@@ -91,8 +91,6 @@ module Omnibus
       @dependencies = []
       @whitelist_files = []
       instance_eval(io, filename, 0)
-
-      render_tasks
     end
 
     # Retrieves the override_version
@@ -286,6 +284,7 @@ module Omnibus
 
     # @return [Boolean]
     def always_build?
+      return true if project.dirty_cache
       # Should do !!(@always_build)
       @always_build
     end
@@ -359,18 +358,6 @@ module Omnibus
       @relative_path ? "#{source_dir}/#{@relative_path}" : "#{source_dir}/#{@name}"
     end
 
-    # @todo all the *_file methods should be next to each other for
-    #   better logical grouping
-    def manifest_file
-      manifest_file_from_name(@name)
-    end
-
-    # @todo Seems like this should be a private method, since it's
-    #   just used internally
-    def manifest_file_from_name(software_name)
-      "#{build_dir}/#{software_name}.manifest"
-    end
-
     # The name of the sentinel file that marks the most recent fetch
     # time of the software
     #
@@ -431,6 +418,42 @@ module Omnibus
       OHAI.kernel['machine'] =~ /sun/ ? 'sparc' : 'intel'
     end
 
+    # Actually build the software package
+    def build_me
+      # Fetch the source
+      fetcher = fetch_me
+
+      # Build if we need to
+      if always_build?
+        execute_build(fetcher)
+      else
+        if Omnibus::InstallPathCache.new(install_dir, self).restore
+          true
+        else
+          execute_build(fetcher)
+        end
+      end
+      true
+    end
+
+    # Fetch the software
+    def fetch_me
+      # Create the directories we need
+      [build_dir, source_dir, cache_dir, project_dir].each do |dir|
+        FileUtils.mkdir_p dir
+      end
+
+      fetcher = Fetcher.for(self)
+
+      if !File.exist?(fetch_file) || fetcher.fetch_required?
+        # force build to run if we need to do an updated fetch
+        fetcher.fetch
+        touch fetch_file
+      end
+
+      fetcher
+    end
+
     private
 
     # Apply overrides in the @overrides hash that mask instance variables
@@ -457,74 +480,15 @@ module Omnibus
     def execute_build(fetcher)
       fetcher.clean
       @builder.build
-      touch manifest_file
+      puts "[software:#{name}] caching build"
+      Omnibus::InstallPathCache.new(install_dir, self).incremental
+      puts "[software:#{name}] has dirtied the cache"
+      project.dirty_cache = true
     end
 
-    def render_tasks
-      namespace "projects:#{@project.name}" do
-        namespace :software do
-          fetcher = Fetcher.for(self)
-
-          #
-          # set up inter-project dependencies
-          #
-          (@dependencies - [@name]).uniq.each do |dep|
-            task @name => dep
-            file manifest_file => manifest_file_from_name(dep)
-          end
-
-          directory source_dir
-          directory cache_dir
-          directory build_dir
-          directory project_dir
-          namespace @name do
-            task fetch: [build_dir, source_dir, cache_dir, project_dir] do
-              if !File.exist?(fetch_file) || fetcher.fetch_required?
-                # force build to run if we need to do an updated fetch
-                fetcher.fetch
-                touch fetch_file
-              end
-            end
-
-            task build: :fetch do
-              if !always_build? && uptodate?(manifest_file, [fetch_file])
-                # if any direct deps have been built for any reason, we will need to
-                # clean/build ourselves
-                (@dependencies - [@name]).uniq.each do |dep|
-                  unless uptodate?(manifest_file, [manifest_file_from_name(dep)])
-                    execute_build(fetcher)
-                    break
-                  end
-                end
-
-              else
-                # if fetch has occurred, or the component is configured to
-                # always build, do a clean and build.
-                execute_build(fetcher)
-              end
-            end
-          end
-
-          #
-          # make the manifest file dependent on the latest file in the
-          # source tree in order to shrink the multi-thousand-node
-          # dependency graph that Rake was generating
-          #
-          latest_file = FileList["#{project_dir}/**/*"].sort do |a, b|
-            File.mtime(a) <=> File.mtime(b)
-          end.last
-
-          file manifest_file => (file latest_file)
-
-          file fetch_file => "#{name}:fetch"
-          file manifest_file => "#{name}:build"
-
-          file fetch_file => (file @source_config)
-          file manifest_file => (file fetch_file)
-
-          desc "fetch and build #{@name} for #{@project.name}"
-          task @name => manifest_file
-        end
+    def touch(file)
+      File.open(file, 'w') do |f|
+        f.print ''
       end
     end
   end

data/lib/omnibus/sugar.rb

@@ -0,0 +1,49 @@
+#
+# 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 'chef/sugar/architecture'
+require 'chef/sugar/cloud'
+# NOTE: We cannot include the constraints library because of the conflicting
+# +version+ attribute would screw things up. You can still use the
+# +Chef::Sugar::Constraint.version('1.2.3') for comparing versions.
+#
+# require 'chef/sugar/constraints'
+require 'chef/sugar/ip'
+require 'chef/sugar/platform'
+require 'chef/sugar/platform_family'
+require 'chef/sugar/ruby'
+require 'chef/sugar/shell'
+require 'chef/sugar/vagrant'
+
+require 'omnibus/project'
+
+module Omnibus
+  class Project
+    private
+
+    # This method is used by Chef Sugar to easily add the DSL. By mimicing
+    # Chef's +node+ object, we can easily include the existing DSL into
+    # Omnibus project as if it were Chef. Otherwise, we would need to rewrite
+    # all the DSL methods.
+    def node
+      OHAI
+    end
+  end
+end
+
+# Include everything in Omnibus
+Omnibus::Project.send(:include, Chef::Sugar::DSL)
+Omnibus::Software.send(:include, Chef::Sugar::DSL)

data/lib/omnibus/templates/.kitchen.yml.erb

@@ -11,8 +11,11 @@ provisioner:
 
 platforms:
   - name: ubuntu-12.04
+    run_list: apt::default
   - name: ubuntu-11.04
+    run_list: apt::default
   - name: ubuntu-10.04
+    run_list: apt::default
   - name: centos-5.10
   - name: centos-6.5
 

data/lib/omnibus/templates/Berksfile.erb

@@ -1,5 +1,9 @@
 source 'https://api.berkshelf.com'
 
+# The apt cookbook is required to bring the apt cache up-to-date on Ubuntu
+# systems, since the cache can become stale on older boxes.
+cookbook 'apt', '~> 2.0'
+
 cookbook 'omnibus'
 
 # Uncomment to use the latest version of the Omnibus cookbook from GitHub

data/lib/omnibus/templates/Gemfile.erb

@@ -4,7 +4,7 @@ source 'https://rubygems.org'
 gem 'berkshelf', '~> 3.0.0.beta'
 
 # Install omnibus software
-gem 'omnibus', '~> 2.0'
+gem 'omnibus', '~> <%= Omnibus::VERSION.split('.')[0...-1].join('.') %>'
 gem 'omnibus-software', github: 'opscode/omnibus-software'
 
 # Use Test Kitchen with Vagrant for convering the build environment

data/lib/omnibus/templates/mac_pkg/license.html.erb

@@ -0,0 +1 @@
+All Rights Reserved

data/lib/omnibus/templates/mac_pkg/welcome.html.erb

@@ -0,0 +1,9 @@
+This will install <%= config[:name] %> on your Mac.
+
+--------------------------------------------------
+
+This is a basic welcome message that is generated for every Omnibus project. You should customize this message by editing the file at files/mac_pkg/welcome.html.
+
+If you are not the developer of <%= config[:name] %>, the presence of this message is likely a bug and should be reported to the creator.
+
+Thank you for choosing Omnibus! Have a fantastic day!

data/lib/omnibus/templates/omnibus.rb.example.erb

@@ -1,6 +1,33 @@
-# s3_access_key 'something'
-# s3_secret_key 'something'
-# s3_bucket 'some-bucket'
+#
+# This file is used to configure the <%= config[:name] %> project. It contains
+# come minimal configuration examples for working with Omnibus. For a full list
+# of configurable options, please see the documentation for +omnibus/config.rb+.
+#
+
+# Build internally
+# ------------------------------
+# By default, Omnibus uses system folders (like +/var+ and +/opt+) to build and
+# cache compontents. If you would to build everything internally, you can
+# uncomment the following options. This will prevent the need for root
+# permissions in most cases. You will also need to update the <%= config[:name] %>
+# project configuration to build at +./local/omnibus/build+ instead of
+# +<%= config[:install_path] %>+
+#
+# cache_dir              './local/omnibus/cache'
+# install_path_cache_dir './local/omnibus/cache/install_path'
+# source_dir             './local/omnibus/src'
+# build_dir              './local/omnibus/build'
+# package_dir            './local/omnibus/pkg'
+# package_tmp            './local/omnibus/pkg-tmp'
+
+# Enable S3 asset caching
+# ------------------------------
 # use_s3_caching true
+# s3_access_key  'something'
+# s3_secret_key  'something'
+# s3_bucket      'some-bucket'
+
+# Customize compiler bits
+# ------------------------------
 # solaris_compiler 'gcc'
-# build_retries 3
+# build_retries 5

data/lib/omnibus/version.rb

@@ -16,5 +16,5 @@
 #
 
 module Omnibus
-  VERSION = '2.0.2'
+  VERSION = '3.0.0'
 end

data/omnibus.gemspec

@@ -21,16 +21,17 @@ Gem::Specification.new do |gem|
   gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ['lib']
 
+  gem.add_dependency 'chef-sugar',      '~> 1.2'
   gem.add_dependency 'mixlib-shellout', '~> 1.3'
   gem.add_dependency 'mixlib-config',   '~> 2.1'
   gem.add_dependency 'ohai',            '~> 6.12'
-  gem.add_dependency 'rake'
-  gem.add_dependency 'fpm',             '~> 0.4'
+  gem.add_dependency 'fpm',             '~> 1.0.0'
   gem.add_dependency 'uber-s3'
   gem.add_dependency 'thor',            '>= 0.16.0'
 
-  gem.add_development_dependency 'rspec',   '~> 2.14.1'
-  gem.add_development_dependency 'rubocop', '~> 0.18.1'
+  gem.add_development_dependency 'rspec',   '~> 2.14'
+  gem.add_development_dependency 'rubocop', '~> 0.18'
+  gem.add_development_dependency 'rake'
 
   gem.add_development_dependency 'bundler'
 end

data/spec/fixtures/sample/files/mac_pkg/Resources/license.html

@@ -0,0 +1 @@
+All Rights Reserved

data/spec/fixtures/sample/files/mac_pkg/Resources/welcome.html

@@ -0,0 +1,9 @@
+This will install  on your Mac.
+
+--------------------------------------------------
+
+This is a basic welcome message that is generated for every Omnibus project. You should customize this message by editing the file at files/mac_pkg/welcome.html.
+
+If you are not the developer of , the presence of this message is likely a bug and should be reported to the creator.
+
+Thank you for choosing Omnibus! Have a fantastic day!

data/spec/functional/packagers/mac_spec.rb

@@ -0,0 +1,74 @@
+#
+# Copyright:: Copyright (c) 2014 Chef Software, 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 'spec_helper'
+
+module Omnibus
+  describe Packager::MacDmg, :functional do
+    let(:name) { 'sample' }
+    let(:version) { '12.4.0' }
+
+    let(:project) do
+      Project.new(<<-EOH, __FILE__)
+        name               '#{name}'
+        maintainer         'Chef'
+        homepage           'https://getchef.com'
+        build_version      '#{version}'
+        install_path       '#{tmp_path}/opt/#{name}'
+        mac_pkg_identifier 'test.pkg.#{name}'
+      EOH
+    end
+
+    let(:mac_packager) { Packager::MacPkg.new(project) }
+
+    before do
+      # Reset stale configuration
+      Omnibus.config.reset!
+
+      # Tell things to install into the cache directory
+      root = "#{tmp_path}/var/omnibus"
+      Omnibus.config.cache_dir "#{root}/cache"
+      Omnibus.config.install_path_cache_dir "#{root}/cache/install_path"
+      Omnibus.config.source_dir "#{root}/src"
+      Omnibus.config.build_dir "#{root}/build"
+      Omnibus.config.package_dir "#{root}/pkg"
+      Omnibus.config.package_tmp "#{root}/pkg-tmp"
+
+      # Enable DMG create
+      Omnibus.config.build_dmg true
+
+      # Point at our sample project fixture
+      Omnibus.config.project_root "#{fixtures_path}/sample"
+
+      # Create the target directory
+      FileUtils.mkdir_p(project.install_path)
+    end
+
+    it 'builds a pkg and a dmg' do
+      # Create the pkg resource
+      mac_packager.run!
+
+      # There is a tiny bit of hard-coding here, but I don't see a better
+      # solution for generating the package name
+      pkg = "#{project.package_dir}/#{name}-#{version}-1.mac_os_x.10.9.2.pkg"
+      dmg = "#{project.package_dir}/#{name}-#{version}-1.mac_os_x.10.9.2.dmg"
+
+      expect(File.exist?(pkg)).to be_true
+      expect(File.exist?(dmg)).to be_true
+    end
+  end
+end