omnibus 2.0.2 → 3.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6427537f543b5620032efc95fa829432edf0456d
+  data.tar.gz: d4a4c594566f3eecc07a16e101b8dbe9470b3a3d
+SHA512:
+  metadata.gz: 2e858eb5ac89e4afbaac538092d8c156880d7b2229a3b5a529abec7a6216d06110bbe6891a3621aee3d7eb7e3e8877f0afdaafaadffce4c85f7defa698c4b0cb
+  data.tar.gz: e2b5b330bd7fcad489db76806f5855a22b337f7fa467e3ad587d0c98796eae3d7d026300b410771efd838fa0fabca3196e816ae110b0e29c2f82d5e73a20f9c2

data/.rubocop.yml

@@ -1,3 +1,5 @@
+ClassAndModuleChildren:
+  Enabled: false
 ClassLength:
   Enabled: false
 CyclomaticComplexity:

data/.travis.yml

@@ -5,8 +5,6 @@ bundler_args: --jobs 7 --without docs
 
 branches:
   only:
-    - 2.0-stable
-    - 3.0-stable
     - master
 
 script: bundle exec rake travis:ci

data/CHANGELOG.md

@@ -1,12 +1,32 @@
 Omnibus Ruby CHANGELOG
 ======================
 
-v2.0.2 (September 16, 2014)
------------------------
-- Ensure default package user and group are `root`.
-- Fix S3 bucket retrieval.
-- Add metadata to support modern publishers.
-- Downgrade FPM to ~> 0.4 
+v3.0.0 (TBD)
+------------
+### New Features
+
+- **No more rake!** Software definitions are incrementally built and cached using git instead. Software dependency build has been rewritten to leverage git caching. This means compiled software definitions are cached, so future Omnibus project builds are much faster. However, this does introduce some potential breaking changes.
+
+  - Project-level software dependencies are built **last**.
+  - it is assumed that project-level software dependencies are most frequently changed, and thus Omnibus optimize for such a case.
+  - If you have software definitions that hard code `always_build`, you will probably want to turn that off now.
+  - Blank directories are not cached. If you would like a blank directory to be cached, add a `.gitkeep` file to the folder.
+  - The build order is compiled in a different way, which might result in a different ordered-installation than previous versions of omnibus.
+  - For an example of you you might need to update your project, please see [opscode/omnibus-software@02d06a](https://github.com/opscode/omnibus-software/commit/02d06a74c02340b592e1864e7ab843bc14fa352a)
+
+- Support for building DMGs (OSX Disk Images)
+- Update generator to create assets for pkg/dmg resources
+- There's a fancy new logo
+- Added Chef Sugar integration
+- Improved documentation
+- Improved test coverage
+
+### Bug fixes
+
+- Project generators now include apt/yum as development cookbooks
+- Added libc++.1.dylib as a whitelist healthcheck
+- Added libgcc_s.so,1 as a whitelist healthcheck on Solaris
+- Fix a bug where `extra_package_files` would break FPM
 
 v2.0.1 (March 18, 2014)
 -----------------------

data/Gemfile

@@ -10,3 +10,10 @@ end
 group :test do
   gem 'fauxhai'
 end
+
+group :local do
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-rubocop'
+  gem 'ruby_gntp'
+end

data/Guardfile

@@ -0,0 +1,10 @@
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/omnibus/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb') { 'spec' }
+end
+
+guard :rubocop do
+  watch(%r{.+\.rb$})
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+end

data/README.md

@@ -1,58 +1,45 @@
-## Omnibus
-
+![Omnibus Icon](lib/omnibus/assets/README-logo.png) Omnibus
+===========================================================
 [![Build Status](https://travis-ci.org/opscode/omnibus-ruby.png?branch=master)](https://travis-ci.org/opscode/omnibus-ruby)
-[![Code Climate](https://codeclimate.com/github/opscode/omnibus-ruby.png)](https://codeclimate.com/github/opscode/omnibus-ruby)
 
-Easily create full-stack installers for your project across a variety
-of platforms.
+Easily create full-stack installers for your project across a variety of platforms.
 
-Seth Chisamore and Christopher Maier of Opscode gave an introductory
-talk on Omnibus at ChefConf 2013, entitled **Eat the Whole Bowl:
-Building a Full-Stack Installer with Omnibus**
-([video](http://www.youtube.com/watch?v=q8iJAntXCNY),
-[slides](https://speakerdeck.com/schisamo/eat-the-whole-bowl-building-a-full-stack-installer-with-omnibus)).
+Seth Chisamore and Christopher Maier of CHEF gave an introductory talk on Omnibus at ChefConf 2013, entitled **Eat the Whole Bowl: Building a Full-Stack Installer with Omnibus**:
+  - [Video](http://www.youtube.com/watch?v=q8iJAntXCNY)
+  - [Slides](https://speakerdeck.com/schisamo/eat-the-whole-bowl-building-a-full-stack-installer-with-omnibus)
 
 This project is managed by the CHEF Release Engineering team. For more information on the Release Engineering team's contribution, triage, and release process, please consult the [CHEF Release Engineering OSS Management Guide](https://docs.google.com/a/opscode.com/document/d/1oJB0vZb_3bl7_ZU2YMDBkMFdL-EWplW1BJv_FXTUOzg/edit).
 
-## Prerequisites
-
-Omnibus is designed to run with a minimal set of prerequisites. You'll
-need the following:
 
-- Ruby 1.9 or later (http://ruby-lang.org)
-- Bundler (http://gembundler.com, http://rubygems.org/gems/bundler)
+Prerequisites
+-------------
+Omnibus is designed to run with a minimal set of prerequisites. You will need the following:
 
-Though not *strictly* necessary, Vagrant makes using Omnibus easier,
-and is highly recommended.
-- Vagrant 1.2.1 or later (http://www.vagrantup.com)
-- the vagrant-berkshelf plugin (https://github.com/RiotGames/vagrant-berkshelf)
-- the vagrant-omnibus plugin (https://github.com/schisamo/vagrant-omnibus)
+- Ruby 1.9+
+- Bundler
 
-## Get Started
 
-Omnibus provides both a DSL for defining Omnibus projects for your
-software, as well as a command-line tool for generating installer
-artifacts from that definition.
+Get Started
+-----------
+Omnibus provides both a DSL for defining Omnibus projects for your software, as well as a command-line tool for generating installer artifacts from that definition.
 
 To get started, install Omnibus locally on your workstation.
 
-```
+```bash
 $ gem install omnibus
 ```
 
-You can now create an Omnibus project in your current directory by
-using the project generator feature.
+You can now create an Omnibus project in your current directory by using the project generator feature.
 
-```
+```bash
 $ omnibus project $MY_PROJECT_NAME
 ```
 
-This will generate a complete project skeleton in the directory
-`omnibus-$MY_PROJECT_NAME`
+This will generate a complete project skeleton in the directory `omnibus-$MY_PROJECT_NAME`
 
 This minimal project will actually build.
 
-``` shell
+```bash
 $ cd omnibus-$MY_PROJECT_NAME
 $ bundle install --binstubs
 $ bin/omnibus build project $MY_PROJECT_NAME
@@ -60,187 +47,142 @@ $ bin/omnibus build project $MY_PROJECT_NAME
 
 More details can be found in the generated project README file.
 
-## Configuration DSL
 
-Though the template project will build, it won't do anything exciting.
-For that, you'll need to use the Omnibus DSL to define the specifics
-of your own application.
+More documentation
+------------------
+If you are creating OSX packages, please see the [OSX-specifc documentation](docs/Building on OSX.md).
+
+
+Configuration DSL
+------------------
+Though the template project will build, it won't do anything exciting. For that, you'll need to use the Omnibus DSL to define the specifics of your own application.
 
 ### Software
+Omnibus "software" files define individual software components that go into making your overall package. They are the building blocks of your application. The Software DSL provides a way to define where to retrieve the software sources, how to build them, and what dependencies they have. These dependencies are also defined in their own Software DSL files, thus forming the basis for a dependency-aware build ordering.
+
+All Software definitions should go in the `config/software` directory of your Omnibus project repository.
 
-Omnibus "software" files define individual software components that go
-into making your overall package.  They are the building blocks of
-your application.  The Software DSL provides a way to define where to
-retrieve the software sources, how to build them, and what
-dependencies they have.  These dependencies are also defined in their
-own Software DSL files, thus forming the basis for a dependency-aware
-build ordering.
-
-All Software definitions should go in the `config/software` directory
-of your Omnibus project repository.
-
-Opscode has created software definitions for a number of
-commonly-needed components, available in the
-[omnibus-software](https://github.com/opscode/omnibus-software.git)
-repository.  When you create a new project skeleton using Omnibus,
-this is automatically added to the project's Gemfile, making all these
-software definitions available to you.  (If you prefer, however, you
-can write your own versions of these same definitions in your project
-repository; local copies in `config/software` have precedence over
-anything from the `omnibus-software` repository.)
+CHEF has created software definitions for a number of commonly-needed components, available in the [omnibus-software](https://github.com/opscode/omnibus-software.git)
+repository. When you create a new project skeleton using Omnibus, this is automatically added to the project's Gemfile, making all these software definitions available to you.  (If you prefer, however, you can write your own versions of these same definitions in your project repository; local copies in `config/software` have precedence over anything from the `omnibus-software` repository.)
 
 An example:
 
 ```ruby
-name            "ruby"
-default_version "1.9.2-p290"
-source          :url => "http://ftp.ruby-lang.org/pub/ruby/1.9/ruby-#{version}.tar.gz",
-                :md5 => "604da71839a6ae02b5b5b5e1b792d5eb"
+name 'ruby'
+default_version '1.9.2-p290'
+source url: 'http://ftp.ruby-lang.org/pub/ruby/1.9/ruby-#{version}.tar.gz',
+       md5: '604da71839a6ae02b5b5b5e1b792d5eb'
 
-dependency "zlib"
-dependency "ncurses"
-dependency "openssl"
+dependency 'zlib'
+dependency 'ncurses'
+dependency 'openssl'
 
 relative_path "ruby-#{version}"
 
 build do
-  command "./configure"
-  command "make"
-  command "make install"
+  command './configure'
+  command 'make'
+  command 'make install'
 end
 ```
 
 Some of the DSL methods available include:
 
-**name**: The name of the software component (this should come first).
+| DSL Method        | Description                                |
+| :---------------: | -------------------------------------------|
+| `name`            | The name of the software component (this should come first) |
+| `default_version` | The version of the software component      |
+| `source`          | Directions to the location of the source   |
+| `dependency`      | An Omnibus software-defined component that this software depends on |
+| `relative_path`   | The relative path of the extracted tarball |
+| `build`           | The build instructions                     |
+| `command`         | An individual build step                   |
 
-**default_version**: The version of the software component.
 
-**source**: Directions to the location of the source.
+You can support building multiple verisons of the same software in the same software definition file using the `version` method and giving a block:
 
-**dependency**: An Omnibus software-defined component that this software depends on.
+```ruby
+name 'ruby'
+default_version '1.9.2-p290'
 
-**relative_path**: The relative path of the extracted tarball.
+version '1.9.2-p290' do
+  source url: 'http://ftp.ruby-lang.org/pub/ruby/1.9/ruby-#{version}.tar.gz',
+         md5: '604da71839a6ae02b5b5b5e1b792d5eb'
+end
 
-**build**: The build instructions.
+version '2.1.1' do
+  source url: 'http://ftp.ruby-lang.org/pub/ruby/2.1/ruby-#{version}.tar.gz',
+         md5: 'e57fdbb8ed56e70c43f39c79da1654b2'
+end
+```
 
-**command**: An individual build step.
+Since the software definitions are simply ruby code, you can conditionally execute anything by wrapping it with pure ruby that tests for the version number.
 
-For more, consult the documentation.
+For more DSL methods, please consult the documentation.
 
 ### Projects
+A Project DSL file defines your actual application; this is the thing you are creating a full-stack installer for in the first place. It provides a means to define the dependencies of the project (again, as specified in Software DSL definition files), as well as ways to set installer package metadata.
 
-A Project DSL file defines your actual application; this is the thing
-you are creating a full-stack installer for in the first place.  It
-provides a means to define the dependencies of the project (again, as
-specified in Software DSL definition files), as well as ways to set
-installer package metadata.
-
-All Project definitions (yes, you can have more than one) should go in
-the `config/projects` directory of your Omnibus project repository.
+All Project definitions (yes, you can have more than one) should go in the `config/projects` directory of your Omnibus project repository.
 
 ```ruby
-name            "chef-full"
-maintainer      "YOUR NAME"
-homepage        "http://yoursite.com"
+name            'chef-full'
+maintainer      'YOUR NAME'
+homepage        'http://yoursite.com'
 
-install_path    "/opt/chef"
-build_version   "0.10.8"
+install_path    '/opt/chef'
+build_version   '0.10.8'
 build_iteration 4
 
-dependency "chef"
+dependency 'chef'
 ```
 
 Some DSL methods available include:
 
-**name:** The name of the project.
-
-**install_path:** The desired install location of the package.
+| DSL Method        | Description                                 |
+| :---------------: | --------------------------------------------|
+| `name`            | The name of the project                     |
+| `install_path`    | The desired install location of the package |
+| `build_version`   | The package version                         |
+| `build_iteration` | The package iteration number                |
+| `dependency`      | An Omnibus software-defined component to include in this package |
 
-**build_version:** The package version.
+For more information, please see the documentation.
 
-**build_iteration:** The package iteration number.
 
-**dependency**: An Omnibus software-defined component to include in this package.
+Caveats
+-------
+### A note on builds
+As stated above, the generated project skeleton can run "as-is". However, Omnibus determines the platform for which to build an installer based on *the platform it is currently running on*. That is, you can only generate a `.deb` file for Ubuntu if you're actually running Omnibus *on Ubuntu*.
 
-For more, see the documentation.
+This is currently achieved using [Test Kitchen](http://kitchen.ci), which is included with any newly generated Omnibus project.
 
-## A Note On Builds
 
-As stated above, the generated project skeleton can run "as-is".
-However, Omnibus determines the platform for which to build an
-installer based on *the platform it is currently running on*.  That
-is, you can only generate a `.deb` file for Ubuntu if you're actually
-running Omnibus *on Ubuntu*.
-
-This is currently achieved using [Vagrant](http://www.vagrantup.com).
-A valid `Vagrantfile` for generating builds on Ubuntu and Centos
-platforms (though Omnibus is not limited to just those!) is created
-for each project that you generate using `omnibus project
-$MY_PROJECT_NAME`
-
-## Multiple Software Versions and Version Overrides
-
-You can support building multiple verisons of the same software in the same
-software definition file:
+### Overrides
+The project definitions can override specific software dependencies by passing in `override` to use the correct version:
 
 ```ruby
-name    "ruby"
-default_version "1.9.2-p290"
-
-version "1.9.2-p290" do
-  source  :url => "http://ftp.ruby-lang.org/pub/ruby/1.9/ruby-#{version}.tar.gz",
-          :md5 => "604da71839a6ae02b5b5b5e1b792d5eb"
-end
-
-version "2.1.1" do
-  source  :url => "http://ftp.ruby-lang.org/pub/ruby/2.1/ruby-#{version}.tar.gz",
-          :md5 => "e57fdbb8ed56e70c43f39c79da1654b2"
-end
+name 'chef-full'
+# <snip>
 
+# This will override the default version of "chef"
+override :chef, version: '2.1.1'
 
-dependency "zlib"
-dependency "ncurses"
-dependency "openssl"
-
-relative_path "ruby-#{version}"
-
-build do
-  command "./configure"
-  command "make"
-  command "make install"
-end
+dependency 'chef'
 ```
 
-Since the software definitions are simply ruby code, you can conditionally
-execute anything by wrapping it with pure ruby that tests for the version number.
+There is no checking that the version override that you supply has been provided in a version override block in the software definition.
 
-The project definitions can then take advange of this by passing in overrides
-to use the correct version:
+### Git caching
+As of Omnibus 3.0.0, projects are no longer built using rake. Instead, we have rewritten the software dependencies to leverage git caching. This means we cache compiled software definitions, so future Omnibus project builds are much faster.
 
-```ruby
-name            "chef-full"
-maintainer      "YOUR NAME"
-homepage        "http://yoursite.com"
+For more information on potential breaking changes, please see the CHANGELOG entry for Omnibus 3.0.0.
 
-install_path    "/opt/chef"
-build_version   "0.10.8"
-build_iteration 4
-
-override :chef, version: "2.1.1"
-
-dependency "chef"
-```
 
-There is no checking that the version override that you supply has been
-provided in a version override block in the software definition.
-
-## License
-
-See the LICENSE and NOTICE files for more information.
-
-Copyright: Copyright (c) 2012--2013-2014 Chef Software, Inc.
-License: Apache License, Version 2.0
+License
+-------
+```text
+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.
@@ -253,3 +195,4 @@ 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.
+```

data/Rakefile

@@ -2,7 +2,12 @@ require 'bundler/setup'
 require 'bundler/gem_tasks'
 
 require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:unit)
+RSpec::Core::RakeTask.new(:unit) do |t|
+  t.pattern = 'spec/unit/**/*_spec.rb'
+end
+RSpec::Core::RakeTask.new(:functional) do |t|
+  t.pattern = 'spec/functional/**/*_spec.rb'
+end
 
 require 'rubocop/rake_task'
 desc 'Run Ruby style checks'