omnibus 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6427537f543b5620032efc95fa829432edf0456d
-  data.tar.gz: d4a4c594566f3eecc07a16e101b8dbe9470b3a3d
+  metadata.gz: 6f254e32b62632576547008173adf8f36379a0e5
+  data.tar.gz: b70de72741324c2e54d43ec75b96ffac86d87ae1
 SHA512:
-  metadata.gz: 2e858eb5ac89e4afbaac538092d8c156880d7b2229a3b5a529abec7a6216d06110bbe6891a3621aee3d7eb7e3e8877f0afdaafaadffce4c85f7defa698c4b0cb
-  data.tar.gz: e2b5b330bd7fcad489db76806f5855a22b337f7fa467e3ad587d0c98796eae3d7d026300b410771efd838fa0fabca3196e816ae110b0e29c2f82d5e73a20f9c2
+  metadata.gz: caafe9673d611c76b973ef63fffc557cc103d28881207b971a31fd7db59e15e3056df5e188b5010a334a1a3d9901ac7ac893803cfd9e9638b6eea69f65fc81a5
+  data.tar.gz: e16d7149c5e098e47ee46791590f94fd7b3e510e8bec736aa4d89b0cfbd24fe00fb29a4aa29ede52aef2b99b91c950f38b4314a138fd4e8408b78475427d2391

data/.rubocop.yml

@@ -1,11 +1,19 @@
-ClassAndModuleChildren:
+AllCops:
+  Exclude:
+    - spec/data/**/*
+
+AlignParameters:
   Enabled: false
 ClassLength:
   Enabled: false
+ClassAndModuleChildren:
+  Enabled: false
 CyclomaticComplexity:
   Max: 20
 Documentation:
   Enabled: false
+DoubleNegation:
+  Enabled: false
 GlobalVars:
   Enabled: false
 Encoding:
@@ -24,9 +32,17 @@ ParameterLists:
   Max: 6
 RaiseArgs:
   Enabled: false
+RedundantSelf:
+  Enabled: false
 RescueException:
   Enabled: false
+SignalException:
+  EnforcedStyle: only_raise
+SpecialGlobalVars:
+  Enabled: false
 TrailingComma:
   EnforcedStyleForMultiline: comma
 TrivialAccessors:
   Enabled: false
+StringLiterals:
+  Enabled: false

data/.travis.yml

@@ -1,7 +1,9 @@
 rvm:
   - 1.9.3
+  - 2.0.0
+  - 2.1
 
-bundler_args: --jobs 7 --without docs
+bundler_args: --jobs 7 --without docs local
 
 branches:
   only:
@@ -11,6 +13,12 @@ script: bundle exec rake travis:ci
 
 notifications:
   hipchat:
+    on_change: true
+    on_failure: true
+    on_success: false
+    on_pull_requests: false
     rooms:
-      - secure: JdLOITSPHW5xk8eoFOmH1Js5PT6iFgswUG8fIqNq69ie2Qws2K58hPDR6HW2NBEsBb7dW1S5jT6V9RHhm0ykekvEJVa5AjebO3EsZa+Cu/VahFMg4DL+SGYgKlKrZQosd+EgVQQ3C9gj0dApGtKqf2Ej7RNESwCPY8SOduTC6d8= # Build Statuses
-      - secure: PmOaqp2DFyy79VpCuvSYILblK6tP0eDa9fDG9X2j+wggoosBkmlGfnSxp3A2TXlUyK62mr6/B89dRkL2aDWTJ/gqaZ34Elx2rV5S2A5YJIx9stA2+4iXeSlOF2YMNKGwBVmF/kp/nNoG2FqUkUBrRurWAOXZnwxKIhQ7+kLVb/0= # Release Engineering
+      # Build Statuses
+      - secure: JdLOITSPHW5xk8eoFOmH1Js5PT6iFgswUG8fIqNq69ie2Qws2K58hPDR6HW2NBEsBb7dW1S5jT6V9RHhm0ykekvEJVa5AjebO3EsZa+Cu/VahFMg4DL+SGYgKlKrZQosd+EgVQQ3C9gj0dApGtKqf2Ej7RNESwCPY8SOduTC6d8=
+      # Release Engineering
+      - secure: PmOaqp2DFyy79VpCuvSYILblK6tP0eDa9fDG9X2j+wggoosBkmlGfnSxp3A2TXlUyK62mr6/B89dRkL2aDWTJ/gqaZ34Elx2rV5S2A5YJIx9stA2+4iXeSlOF2YMNKGwBVmF/kp/nNoG2FqUkUBrRurWAOXZnwxKIhQ7+kLVb/0=

data/CHANGELOG.md

@@ -1,7 +1,45 @@
 Omnibus Ruby CHANGELOG
 ======================
 
-v3.0.0 (TBD)
+v3.1.0 (May 14, 2014)
+-------------------------
+### New Features
+- `friendly_name` is added to project DSL to be able to configure the name on packagers.
+- `resources_path` is added to project DSL to be able to specify project specific resource files for packagers.
+- Add the ability to "sign" OSX packages
+- Allow packagers to have project-specific resources
+- MSI packager for windows
+- Added helpers for generating platform-specific paths
+- New build_version DSL
+- All new CLI that uses LazyLoading and a much nicer interface (BC-compat)
+- Create a real logger object - Omnibus now supports --log-level
+- Warn when incorrectly using `replaces` in a project
+
+### Bug fixes
+- Fix Windows bugs in the new git caching feature
+- Use the git sha in the git caching so that the software matches "master"
+- Force the detaching of all disks before building an OSX DMG
+- Remove references to now non-existent Vagrantfile
+- Fix an issue where softwares that are both top-level and transitive dependencies were built in the wrong order (see #140 for more information)
+- Use `source` when creating software uris and checksums
+- Fix invalid cache operations by ensuring the bucket exists
+- Add tag output git describe to include lightweight tags
+- Remove explicit instance_eval from line 0
+- Remove libz and libgcc_s from the health check whitelist
+
+### Miscellaneous Changes
+- Add CoreServices to OSX whitelist for healthcheck
+- Bump the version of the generated Gemfile to Berkshelf ~> 3.0
+- Add test coverage for overridding software source
+- Improved test coverage for Omnibus project/software loading
+- Refactor and updated Thor
+- Add cucumber/aruba for testing the CLI
+- Lazy load Ohai and Mixlib::Config default values
+- Consistent deprecation warnings
+- Updated README badges
+
+
+v3.0.0 (March 27, 2014)
 ------------
 ### New Features
 

data/Gemfile

@@ -7,10 +7,6 @@ group :docs do
   gem 'github-markup', '~> 0.7'
 end
 
-group :test do
-  gem 'fauxhai'
-end
-
 group :local do
   gem 'guard'
   gem 'guard-rspec'

data/README.md

@@ -1,6 +1,10 @@
 ![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)
+[![Gem Version](http://img.shields.io/gem/v/omnibus.svg)][gem]
+[![Build Status](http://img.shields.io/travis/opscode/omnibus-ruby.svg)][travis]
+
+[gem]: https://rubygems.org/gems/omnibus
+[travis]: http://travis-ci.org/opscode/omnibus-ruby
 
 Easily create full-stack installers for your project across a variety of platforms.
 
@@ -32,17 +36,15 @@ $ gem install omnibus
 You can now create an Omnibus project in your current directory by using the project generator feature.
 
 ```bash
-$ omnibus project $MY_PROJECT_NAME
+$ omnibus new $MY_PROJECT_NAME
 ```
 
-This will generate a complete project skeleton in the directory `omnibus-$MY_PROJECT_NAME`
-
-This minimal project will actually build.
+This will generate a complete project skeleton in the directory `$MY_PROJECT_NAME`
 
 ```bash
-$ cd omnibus-$MY_PROJECT_NAME
+$ cd $MY_PROJECT_NAME
 $ bundle install --binstubs
-$ bin/omnibus build project $MY_PROJECT_NAME
+$ bin/omnibus build $MY_PROJECT_NAME
 ```
 
 More details can be found in the generated project README file.
@@ -50,7 +52,7 @@ More details can be found in the generated project README file.
 
 More documentation
 ------------------
-If you are creating OSX packages, please see the [OSX-specifc documentation](docs/Building on OSX.md).
+If you are creating OSX packages, please see the [OSX-specific documentation](docs/Building on OSX.md).
 
 
 Configuration DSL

data/Rakefile

@@ -1,12 +1,23 @@
-require 'bundler/setup'
 require 'bundler/gem_tasks'
 
 require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:unit) do |t|
-  t.pattern = 'spec/unit/**/*_spec.rb'
+[:unit, :functional].each do |type|
+  RSpec::Core::RakeTask.new(type) do |t|
+    t.pattern = "spec/#{type}/**/*_spec.rb"
+    t.rspec_opts = [].tap do |a|
+      a.push('--color')
+      a.push('--format progress')
+    end.join(' ')
+  end
 end
-RSpec::Core::RakeTask.new(:functional) do |t|
-  t.pattern = 'spec/functional/**/*_spec.rb'
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:acceptance) do |t|
+  t.cucumber_opts = [].tap do |a|
+    a.push('--color')
+    a.push('--format progress')
+    a.push('--strict')
+  end.join(' ')
 end
 
 require 'rubocop/rake_task'
@@ -15,7 +26,7 @@ Rubocop::RakeTask.new(:style)
 
 namespace :travis do
   desc 'Run tests on Travis'
-  task ci: ['unit', 'style']
+  task ci: %w(unit acceptance style)
 end
 
-task default: ['travis:ci']
+task default: %w(travis:ci)

data/bin/omnibus

@@ -4,8 +4,8 @@
 # https://twitter.com/mitchellh/status/283014103189053442
 Signal.trap('INT') { exit 1 }
 
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+$:.push File.expand_path('../../lib', __FILE__)
+$stdout.sync = true
 
 require 'omnibus/cli'
-
-Omnibus::CLI::Application.start
+Omnibus::CLI::Runner.new(ARGV.dup).execute!

data/docs/Building on Windows.md

@@ -0,0 +1,98 @@
+Building Omnibus Packages for Windows
+=====================================
+This document describes the requirements and configurables for building
+omnibus packages on Windows. Omnibus builds MSI packages on Windows systems.
+
+Requirements
+------------
+In order to build an omnibus package on Windows you need:
+
+* Open Source Windows Installer Toolset: [WIX](http://wixtoolset.org/)
+* In order to use built in semantic versioning:
+  [Git for Windows](http://msysgit.github.io/)
+
+MSI Source Files
+----------------
+In order to create an MSI package, we will need to have some source files that
+can be used by WIX toolset to be able to build the MSI. Omnibus creates some
+skeletal MSI source files for you to help you get started.
+
+When you execute `omnibus project <<project_name>>` these files will be created
+to be able to build MSIs:
+
+```
+C:\> omnibus project demo
+  ...
+  create  omnibus-demo/files/windows_msi/Resources/localization-en-us.wxl.erb
+  create  omnibus-demo/files/windows_msi/Resources/parameters.wxi.erb
+  create  omnibus-demo/files/windows_msi/Resources/source.wxs
+  create  omnibus-demo/files/windows_msi/Resources/assets/LICENSE.rtf
+  create  omnibus-demo/files/windows_msi/Resources/assets/banner_background.bmp
+  create  omnibus-demo/files/windows_msi/Resources/assets/dialog_background.bmp
+  create  omnibus-demo/files/windows_msi/Resources/assets/project.ico
+  create  omnibus-demo/files/windows_msi/Resources/assets/project_16x16.ico
+  create  omnibus-demo/files/windows_msi/Resources/assets/project_32x32.ico
+  ...
+```
+- `localization-en-us.wxl.erb` => File that contains the strings that are being
+  used in the MSI user interface.
+- `parameters.wxi.erb` => File that contains the dynamic information needed for
+  the MSI e.g. version numbers.
+- `assets/LICENSE.rtf` => License text in Rich Text Format that is displayed
+  during MSI installation.
+- `assets/*.bmp` => Bitmaps that are displayed during installation.
+- `assets/*.ico` => Icons that are used in the system for your application.
+
+Omnibus requires `wxl`, `wxs` and `wxi` files to be present on the system in
+order to build an MSI. You can also create these files as erb templates and
+omnibus will render them before starting building the MSI.
+
+These files are XML files that are created based on Windows WIX Schema. By
+default they will package the files under configured `install_dir` and present
+a UI that lets users to choose an installation location for the packaged files.
+You can modify these XML files based on the documentation
+  [here](http://wixtoolset.org/documentation/manual/v3/xsd/).
+
+Configurables
+-------------
+You can use `msi_parameters` DSL option in your Omnibus project files to pass
+dynamic information to your MSI source templates. You can specify a hash or a
+block for this option. When block is specified, it is executed at the time of
+rendering and it is expected to return a hash. Here is an example:
+
+```ruby
+# config/projects/my_project.rb
+name 'my_project'
+
+...
+
+msi_parameters do
+  # Set the upgrade code dynamically
+  params = { }
+  params[:upgrade_code] = determine_upgrade_code()
+  params
+end
+```
+
+```xml
+<!-- files/windows_msi/Resources/parameters.wxi.erb -->
+
+<?xml version="1.0" encoding="utf-8"?>
+<Include>
+  <!--
+    Versioning. These have to be changed for upgrades.
+  -->
+  <?define VersionNumber="<%= @msi_version %>" ?>
+  <?define DisplayVersionNumber="<%= @msi_display_version %>" ?>
+
+  <?define UpgradeCode="<%= msi_parameters[:upgrade_code] %>" ?>
+</Include>
+```
+
+MSI Creation
+------------
+To create an MSI you would normally run:
+
+```
+C:\> omnibus build project <name>
+```

data/features/commands/_deprecated.feature

@@ -0,0 +1,46 @@
+Feature: Backwards-compatible deprecated commands
+  Background:
+    * I have an omnibus project named "hamlet"
+
+  Scenario: When "build project" is given
+    * I run `omnibus build project hamlet`
+    * the output should contain:
+      """
+      The interface for building a project has changed. Please use 'omnibus build hamlet' instead.
+      """
+
+  Scenario: When "build software" is given
+    * I run `omnibus build software preparation`
+    * the output should contain:
+      """
+      Building individual software definitions is no longer supported!
+      """
+    * the exit status should not be 0
+
+  Scenario: When --timestamp is given
+    * I run `omnibus build hamlet --timestamp`
+    * the output should contain:
+      """
+      The '--timestamp' option has been deprecated! Please use '--override append_timestamp:true' instead.
+      """
+
+  Scenario: When -t is given
+    * I run `omnibus build hamlet -t`
+    * the output should contain:
+      """
+      The '--timestamp' option has been deprecated! Please use '--override append_timestamp:true' instead.
+      """
+
+  Scenario: When --no-timestamp is given
+    * I run `omnibus build hamlet --no-timestamp`
+    * the output should contain:
+      """
+      The '--no-timestamp' option has been deprecated! Please use '--override append_timestamp:false' instead.
+      """
+
+  Scenario: When "project PROJECT" is given
+    * I run `omnibus project hamlet`
+    * the output should contain:
+      """
+      The project generator has been renamed to 'omnibus new'. Please use 'omnibus new' in the future.
+      """

data/features/commands/build.feature

@@ -0,0 +1,9 @@
+Feature: omnibus build
+  Scenario: When the project does not exist
+    * I have an omnibus project named "hamlet"
+    * I run `omnibus build bacon`
+    * the output should contain:
+      """
+      I could not find an Omnibus project named 'bacon'! Valid projects are:
+        * hamlet
+      """

data/features/commands/clean.feature

@@ -0,0 +1,21 @@
+Feature: omnibus clean
+  Scenario: When a bad name is given
+    * I run `omnibus clean hamlet`
+    * the output should contain:
+      """
+      I could not find an Omnibus project named 'hamlet'!
+      """
+    * the exit status should not be 0
+
+  Scenario: When the --purge option is given
+    * I have an omnibus project named "hamlet"
+    * I successfully run `omnibus clean hamlet --purge`
+    * the output should contain "remove  local/build/hamlet"
+
+  Scenario: When no options are given
+    * I have an omnibus project named "hamlet"
+    * I successfully run `omnibus clean hamlet`
+    * the output should not contain:
+      """
+      remove  local/build/hamlet
+      """

data/features/commands/list.feature

@@ -0,0 +1,16 @@
+Feature: omnibus list
+  Scenario: When there are Omnibus projects
+    * I have an omnibus project named "hamlet"
+    * I successfully run `omnibus list`
+    * the output should contain:
+      """
+      Omnibus projects:
+        * hamlet (1.0.0)
+      """
+
+  Scenario: When there are no Omnibus projects
+    * I successfully run `omnibus list`
+    * the output should contain:
+      """
+      There are no Omnibus projects!
+      """

data/features/commands/new.feature

@@ -0,0 +1,8 @@
+Feature: omnibus new
+  Scenario: When the --path option is given
+    * I successfully run `omnibus new hamlet --path nested/path`
+    * a file named "nested/path/omnibus-hamlet/config/projects/hamlet.rb" should exist
+
+  Scenario: When no options are given
+    * I successfully run `omnibus new hamlet`
+    * a file named "omnibus-hamlet/config/projects/hamlet.rb" should exist

data/features/commands/version.feature

@@ -0,0 +1,12 @@
+Feature: omnibus version
+  Scenario: When the -v flag is specified
+    * I successfully run `omnibus -v`
+    * the output should match /^Omnibus v(.+)$/
+
+  Scenario: When the --version flag is specified
+    * I successfully run `omnibus --version`
+    * the output should match /^Omnibus v(.+)$/
+
+  Scenario: When the version command is given
+    * I successfully run `omnibus version`
+    * the output should match /^Omnibus v(.+)$/