omnibus 1.0.0

data/lib/omnibus/version.rb

@@ -0,0 +1,20 @@
+#
+# 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.
+#
+
+module Omnibus
+  VERSION = "1.0.0"
+end

data/omnibus.gemspec

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'omnibus/version'
+
+Gem::Specification.new do |gem|
+  gem.name           = "omnibus"
+  gem.version        = Omnibus::VERSION
+  gem.license        = "Apache 2.0"
+  gem.author         = "Opscode"
+  gem.email          = "info@opscode.com"
+  gem.description    = "Omnibus helps you build self-installing, full-stack software builds."
+  gem.summary        = gem.description
+  gem.homepage       = "https://github.com/opscode/opscode-ruby"
+
+  gem.required_ruby_version = ">= 1.9.1"
+
+  gem.files = `git ls-files`.split($/)
+  gem.bindir = "bin"
+  gem.executables = %w(omnibus)
+  gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "mixlib-shellout", "~> 1.0"
+  gem.add_dependency "mixlib-config", "~> 1.1.2"
+  gem.add_dependency "ohai", ">= 0.6.12"
+  gem.add_dependency "rake", ">= 0.9"
+  gem.add_dependency "fpm", "= 0.3.11"
+  gem.add_dependency "uber-s3"
+  gem.add_dependency "thor", ">= 0.16.0"
+
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "rspec_junit_formatter"
+end

data/spec/build_version_spec.rb

@@ -0,0 +1,228 @@
+#
+# 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/build_version'
+require 'spec_helper'
+
+describe Omnibus::BuildVersion do
+
+  let(:git_describe){ "11.0.0-alpha1-207-g694b062" }
+  let(:valid_semver_regex){/^\d+\.\d+\.\d+(\-[\dA-Za-z\-\.]+)?(\+[\dA-Za-z\-\.]+)?$/}
+  let(:valid_git_describe_regex){/^\d+\.\d+\.\d+(\-[A-Za-z0-9\-\.]+)?(\-\d+\-g[0-9a-f]+)?$/}
+
+  subject(:build_version){ Omnibus::BuildVersion.new }
+
+  before :each do
+    ENV['BUILD_ID'] = nil
+    ENV['OMNIBUS_APPEND_TIMESTAMP'] = nil
+    Omnibus::BuildVersion.any_instance.stub(:shellout)
+                         .and_return(mock("ouput",
+                                          :stdout => git_describe,
+                                          :exitstatus => 0))
+  end
+
+  describe "git describe parsing" do
+
+    # we prefer our git tags to be SemVer compliant
+
+    # release version
+    context "11.0.1" do
+      let(:git_describe){ "11.0.1" }
+      its(:version_tag){ should == "11.0.1" }
+      its(:prerelease_tag){ should be_nil }
+      its(:git_sha_tag){ should be_nil }
+      its(:commits_since_tag){ should == 0 }
+      its(:development_version?){ should be_true }
+      its(:prerelease_version?){ should be_false }
+    end
+
+    # SemVer compliant prerelease version
+    context "11.0.0-alpha.2" do
+      let(:git_describe){ "11.0.0-alpha.2" }
+      its(:version_tag){ should == "11.0.0" }
+      its(:prerelease_tag){ should == "alpha.2" }
+      its(:git_sha_tag){ should be_nil }
+      its(:commits_since_tag){ should == 0 }
+      its(:development_version?){ should be_false }
+      its(:prerelease_version?){ should be_true }
+    end
+
+    # full git describe string
+    context "11.0.0-alpha.3-59-gf55b180" do
+      let(:git_describe){ "11.0.0-alpha.3-59-gf55b180" }
+      its(:version_tag){ should == "11.0.0" }
+      its(:prerelease_tag){ should == "alpha.3" }
+      its(:git_sha_tag){ should == "f55b180" }
+      its(:commits_since_tag){ should == 59 }
+      its(:development_version?){ should be_false }
+      its(:prerelease_version?){ should be_true }
+    end
+
+    # Degenerate git tag formats
+
+    # RubyGems compliant git tag
+    context "10.16.0.rc.0" do
+      let(:git_describe){ "10.16.0.rc.0" }
+      its(:version_tag){ should == "10.16.0" }
+      its(:prerelease_tag){ should == "rc.0" }
+      its(:git_sha_tag){ should be_nil }
+      its(:commits_since_tag){ should == 0 }
+      its(:development_version?){ should be_false }
+      its(:prerelease_version?){ should be_true }
+    end
+
+    # dash seperated prerelease
+    context "11.0.0-alpha-2" do
+      let(:git_describe){ "11.0.0-alpha-2" }
+      its(:version_tag){ should == "11.0.0" }
+      its(:prerelease_tag){ should == "alpha-2" }
+      its(:git_sha_tag){ should be_nil }
+      its(:commits_since_tag){ should == 0 }
+      its(:development_version?){ should be_false }
+      its(:prerelease_version?){ should be_true }
+    end
+
+    # dash seperated prerelease full git describe string
+    context "11.0.0-alpha-2-59-gf55b180" do
+      let(:git_describe){ "11.0.0-alpha-2-59-gf55b180" }
+      its(:version_tag){ should == "11.0.0" }
+      its(:prerelease_tag){ should == "alpha-2" }
+      its(:git_sha_tag){ should == "f55b180" }
+      its(:commits_since_tag){ should == 59 }
+      its(:development_version?){ should be_false }
+      its(:prerelease_version?){ should be_true }
+    end
+
+    # WTF git tag
+    context "11.0.0-alpha2" do
+      let(:git_describe){ "11.0.0-alpha2" }
+      its(:version_tag){ should == "11.0.0" }
+      its(:prerelease_tag){ should == "alpha2" }
+      its(:git_sha_tag){ should be_nil }
+      its(:commits_since_tag){ should == 0 }
+      its(:development_version?){ should be_false }
+      its(:prerelease_version?){ should be_true }
+    end
+  end
+
+  describe "semver output" do
+    let(:today_string){ Time.now.utc.strftime("%Y%m%d") }
+
+    it "generates a valid semver version" do
+      build_version.semver.should =~ valid_semver_regex
+    end
+
+    it "generates a version matching format 'MAJOR.MINOR.PATCH-PRERELEASE+TIMESTAMP.git.COMMITS_SINCE.GIT_SHA'" do
+      build_version.semver.should =~ /11.0.0-alpha1\+#{today_string}[0-9]+.git.207.694b062/
+    end
+
+    it "uses ENV['BUILD_ID'] to generate timestamp if set" do
+      ENV['BUILD_ID'] = "2012-12-25_16-41-40"
+      build_version.semver.should == "11.0.0-alpha1+20121225164140.git.207.694b062"
+    end
+
+    it "fails on invalid ENV['BUILD_ID'] values" do
+      ENV['BUILD_ID'] = "AAAA"
+      expect { build_version.semver }.to raise_error(ArgumentError)
+    end
+
+    context "prerelease version with dashes" do
+      let(:git_describe){ "11.0.0-alpha-3-207-g694b062" }
+
+      it "converts all dashes to dots" do
+        build_version.semver.should =~ /11.0.0-alpha.3\+#{today_string}[0-9]+.git.207.694b062/
+      end
+    end
+
+    context "exact version" do
+      let(:git_describe){ "11.0.0-alpha2" }
+
+      it "appends a timestamp with no git info" do
+        build_version.semver.should =~ /11.0.0-alpha2\+#{today_string}[0-9]+/
+      end
+    end
+
+    describe "ENV['OMNIBUS_APPEND_TIMESTAMP'] usage" do
+
+      let(:git_describe){ "11.0.0-alpha-3-207-g694b062" }
+
+      it "appends a timestamp if not set" do
+        build_version.semver.should =~ /11.0.0-alpha.3\+#{today_string}[0-9]+.git.207.694b062/
+      end
+
+      context "appends a timestamp if set to a truthy value" do
+        ["true","t","yes","y",1].each do |truthy|
+          let(:value) { truthy }
+          before { ENV['OMNIBUS_APPEND_TIMESTAMP'] = value.to_s }
+
+          it "with #{truthy}" do
+            build_version.semver.should =~ /11.0.0-alpha.3\+#{today_string}[0-9]+.git.207.694b062/
+          end
+        end
+      end
+
+      context "does not append a timestamp if set to a falsey value" do
+        ["false","f","no","n",0].each do |falsey|
+          let(:value) { falsey }
+          before { ENV['OMNIBUS_APPEND_TIMESTAMP'] = value.to_s }
+
+          it "with #{falsey}" do
+            build_version.semver.should =~ /11.0.0-alpha.3\+git.207.694b062/
+          end
+        end
+      end
+
+    end
+  end
+
+  describe "git describe output" do
+    it "generates a valid git describe version" do
+      build_version.git_describe.should =~ valid_git_describe_regex
+    end
+
+    it "generates a version matching format 'MAJOR.MINOR.PATCH-PRELEASE.COMMITS_SINCE-gGIT_SHA'" do
+      build_version.git_describe.should == git_describe
+    end
+  end
+
+  describe "deprecated full output" do
+    it "generates a valid git describe version" do
+      Omnibus::BuildVersion.full.should =~ valid_git_describe_regex
+    end
+
+    it "outputs a deprecation message" do
+      Omnibus::BuildVersion.should_receive(:puts).with(/is deprecated/)
+      Omnibus::BuildVersion.full
+    end
+  end
+
+  describe "`git describe` command failure" do
+    before do
+      stderr =<<-STDERR
+fatal: No tags can describe '809ea1afcce67e1148c1bf0822d40a7ef12c380e'.
+Try --always, or create some tags.
+      STDERR
+      build_version.stub(:shellout)
+                   .and_return(mock("ouput",
+                                    :stderr => stderr,
+                                    :exitstatus => 128))
+    end
+    it "sets the version to 0.0.0" do
+      build_version.git_describe.should eq("0.0.0")
+    end
+  end
+end

data/spec/data/overrides/bad_line.overrides

@@ -0,0 +1,3 @@
+foo 1.0.0
+THIS IS A BAD LINE
+bar 1.0.0

data/spec/data/overrides/good.overrides

@@ -0,0 +1,5 @@
+foo 1.2.3
+bar 0.0.1
+baz deadbeefdeadbeefdeadbeefdeadbeef
+spunky master
+monkey release

data/spec/data/overrides/with_dupes.overrides

@@ -0,0 +1,4 @@
+foo 1.0.0
+erchef 1.0.0
+bar 1.0.0
+erchef 2.0.0

data/spec/data/software/erchef.rb

@@ -0,0 +1,40 @@
+#
+# 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.
+#
+
+name "erchef"
+version "4b19a96d57bff9bbf4764d7323b92a0944009b9e"
+
+dependencies ["erlang", "rsync", "curl"]
+
+source :git => "git://github.com/opscode/erchef"
+
+relative_path "erchef"
+
+env = {
+  "PATH" => "#{install_dir}/embedded/bin:#{ENV["PATH"]}",
+  "LDFLAGS" => "-L#{install_dir}/embedded/lib -I#{install_dir}/embedded/include",
+  "CFLAGS" => "-L#{install_dir}/embedded/lib -I#{install_dir}/embedded/include",
+  "LD_RUN_PATH" => "#{install_dir}/embedded/lib"
+}
+
+build do
+  command "make distclean", :env => env
+  command "make rel", :env => env
+  command "mkdir -p #{install_dir}/embedded/service/erchef"
+  command "#{install_dir}/embedded/bin/rsync -a --delete --exclude=.git/*** --exclude=.gitignore ./rel/erchef/ #{install_dir}/embedded/service/erchef/"
+  command "rm -rf #{install_dir}/embedded/service/erchef/log"
+end

data/spec/overrides_spec.rb

@@ -0,0 +1,114 @@
+require 'omnibus/overrides'
+require 'spec_helper'
+
+describe Omnibus::Overrides do
+  describe "#parse_file" do
+
+    let(:overrides){Omnibus::Overrides.parse_file(file)}
+    subject{overrides}
+
+    context "with a valid overrides file" do
+      let(:file){ overrides_path("good") }
+
+      its(:size){should eq(5)}
+      its(["foo"]){should eq("1.2.3")}
+      its(["bar"]){should eq("0.0.1")}
+      its(["baz"]){should eq("deadbeefdeadbeefdeadbeefdeadbeef")}
+      its(["spunky"]){should eq("master")}
+      its(["monkey"]){should eq("release")}
+    end
+
+    context "with an overrides file that contains a bad line" do
+      let(:file){ overrides_path("bad_line")}
+      
+      it "fails" do
+        expect{ overrides }.to raise_error(ArgumentError, "Invalid overrides line: 'THIS IS A BAD LINE'")
+      end
+    end
+
+    context "with an overrides file that contains duplicates" do
+      let(:file){ overrides_path("with_dupes") }
+      let(:duplicated_package){"erchef"}
+      it "fails" do
+        expect{ overrides }.to raise_error(ArgumentError, "Multiple overrides present for '#{duplicated_package}' in overrides file #{file}!")
+      end
+    end
+
+    context "when passed 'nil'" do
+      let(:file){nil}
+      it{should be_nil}
+    end
+  end #parse_file
+
+  describe "#resolve_override_file" do
+    before :each do
+      @original = ENV['OMNIBUS_OVERRIDE_FILE']
+      ENV['OMNIBUS_OVERRIDE_FILE'] = env_override_file
+    end
+    
+    after :each do
+      ENV['OMNIBUS_OVERRIDE_FILE'] = @original
+    end
+    
+    subject{ Omnibus::Overrides.resolve_override_file }
+    
+    context "with no environment variable set" do
+      let(:env_override_file){nil}
+
+      before :each do
+        stub_const("Omnibus::Overrides::DEFAULT_OVERRIDE_FILE_NAME", new_default_file)
+      end
+    
+      context "and a non-existent overrides file" do
+        let(:new_default_file){ "/this/file/totally/does/not/exist.txt" }
+        it{should be_nil}
+      end
+    
+      context "with an existing overrides file" do
+        let(:path){overrides_path("good")}
+        let(:new_default_file){ path }
+        it{should eq(path)}
+      end      
+    end # no environment variable
+
+    context "with OMNIBUS_OVERRIDE_FILE environment variable set" do
+      context "to an existing file" do
+        let(:path){ overrides_path("good") }
+        let(:env_override_file){ path  }
+        it{should eq(path)}
+      end
+
+      context "to a non-existent file" do
+        let(:env_override_file){ "/this/file/totally/does/not/exist.txt"}
+        it{should be_nil}
+      end
+
+      context "to a non-existent file, but with an existing DEFAULT_OVERRIDE_FILE_NAME file" do
+        let(:env_override_file){ "/this/file/totally/does/not/exist.txt"}
+        let(:new_default_file){overrides_path("good")}
+
+        it "should still return 'nil', because environment variable has priority" do
+          stub_const("Omnibus::Overrides::DEFAULT_OVERRIDE_FILE_NAME", new_default_file)
+
+          File.exist?(Omnibus::Overrides::DEFAULT_OVERRIDE_FILE_NAME).should be_true
+          ENV['OMNIBUS_OVERRIDE_FILE'].should_not be_nil
+          
+          subject.should be_nil
+        end
+      end
+    end
+  end
+
+  describe "#overrides" do
+    context "when an overrides file cannot be found" do
+      before :each do
+        Omnibus::Overrides.stub(:resolve_override_file).and_return(nil)
+      end
+      
+      it "returns an empty hash" do
+        Omnibus::Overrides.overrides.should eq({})
+      end
+    end
+  end
+  
+end