omnibus 5.4.0 → 5.5.0

data/spec/functional/licensing_spec.rb

@@ -5,9 +5,10 @@ module Omnibus
     let(:license) { nil }
     let(:license_file_path) { nil }
     let(:license_file) { nil }
+    let(:zlib_version_override) { nil }
 
-    let(:install_dir) { File.join(tmp_path, "install_dir")}
-    let(:software_project_dir) { File.join(tmp_path, "software_project_dir")}
+    let(:install_dir) { File.join(tmp_path, "install_dir") }
+    let(:software_project_dir) { File.join(tmp_path, "software_project_dir") }
 
     let(:expected_project_license_path) { "LICENSE" }
     let(:expected_project_license) { "Unspecified" }
@@ -18,7 +19,7 @@ module Omnibus
       FileUtils.mkdir_p(software_project_dir)
 
       allow_any_instance_of(Software).to receive(:project_dir).and_return(software_project_dir)
-      %w{LICENSE NOTICE}.each do |file|
+      %w{LICENSE NOTICE APACHE}.each do |file|
         File.open(File.join(software_project_dir, file), "w+") do |f|
           f.puts "This file is #{file}."
         end
@@ -35,11 +36,16 @@ module Omnibus
         expect(project_license).to match /#{expected_project_license_content}/
         expect(project_license).to match /This product bundles private_code 1.7.2,\nwhich is available under a "Unspecified"/
         expect(project_license).to match /This product bundles snoopy 1.0.0,\nwhich is available under a "GPL v2"/
-        expect(project_license).to match /This product bundles zlib 1.7.2,\nwhich is available under a "Zlib"/
         expect(project_license).not_to match /preparation/
         expect(project_license).to match /LICENSES\/snoopy-artistic.html/
         expect(project_license).to match /LICENSES\/snoopy-NOTICE/
-        expect(project_license).to match /LICENSES\/zlib-LICENSE/
+        if zlib_version_override
+          expect(project_license).to match /This product bundles zlib 1.8.0,\nwhich is available under a "Apache-2.0"/
+          expect(project_license).to match /LICENSES\/zlib-APACHE/
+        else
+          expect(project_license).to match /This product bundles zlib 1.7.2,\nwhich is available under a "Zlib"/
+          expect(project_license).to match /LICENSES\/zlib-LICENSE/
+        end
       end
 
       it "creates the license files of software components correctly" do
@@ -47,9 +53,17 @@ module Omnibus
         license_dir = File.join(install_dir, "LICENSES")
         expect(Dir.glob("#{license_dir}/**/*").length).to be(3)
 
-        %w{snoopy-NOTICE zlib-LICENSE}.each do |software_license|
+        license_names = [ "snoopy-NOTICE" ]
+        if zlib_version_override
+          license_names << "zlib-APACHE"
+        else
+          license_names << "zlib-LICENSE"
+        end
+
+        license_names.each do |software_license|
           license_path = File.join(license_dir, software_license)
           expect(File.exist?(license_path)).to be(true)
+          expect(File.world_readable?(license_path)).to be_truthy
           expect(File.read(license_path)).to match /#{software_license.split("-").last}/
         end
 
@@ -72,35 +86,48 @@ module Omnibus
 
     let(:project) do
       Project.new.tap do |project|
-        project.name('test-project')
+        project.name("test-project")
         project.install_dir(install_dir)
         project.license(license) unless license.nil?
         project.license_file_path(license_file_path) unless license_file_path.nil?
         project.license_file(license_file) unless license_file.nil?
-        project.build_version('1.2.3')
+        project.build_version("1.2.3")
+        if zlib_version_override
+          project.override :zlib, version: zlib_version_override
+        end
       end
     end
 
     let(:private_code) do
-      Software.new(project, 'private_code.rb').evaluate do
-        name 'private_code'
-        default_version '1.7.2'
+      Software.new(project, "private_code.rb").evaluate do
+        name "private_code"
+        default_version "1.7.2"
+        skip_transitive_dependency_licensing true
       end
     end
 
     let(:zlib) do
-      Software.new(project, 'zlib.rb').evaluate do
-        name 'zlib'
-        default_version '1.7.2'
+      Software.new(project, "zlib.rb").evaluate do
+        name "zlib"
+        default_version "1.7.2"
+        skip_transitive_dependency_licensing true
+
         license "Zlib"
         license_file "LICENSE"
+
+        version "1.8.0" do
+          license "Apache-2.0"
+          license_file "APACHE"
+        end
       end
     end
 
     let(:snoopy) do
-      Software.new(project, 'snoopy.rb').evaluate do
-        name 'snoopy'
-        default_version '1.0.0'
+      Software.new(project, "snoopy.rb").evaluate do
+        name "snoopy"
+        default_version "1.0.0"
+        skip_transitive_dependency_licensing true
+
         license "GPL v2"
         license_file "http://dev.perl.org/licenses/artistic.html"
         license_file "NOTICE"
@@ -108,23 +135,51 @@ module Omnibus
     end
 
     let(:preparation) do
-      Software.new(project, 'preparation.rb').evaluate do
-        name 'preparation'
-        default_version '1.0.0'
+      Software.new(project, "preparation.rb").evaluate do
+        name "preparation"
+        default_version "1.0.0"
         license :project_license
+        skip_transitive_dependency_licensing true
       end
     end
 
     let(:software_with_warnings) { nil }
 
+    let(:softwares) do
+      s = [preparation, snoopy, zlib, private_code]
+      s << software_with_warnings if software_with_warnings
+      s
+    end
+
     def create_licenses
-      project.library.component_added(preparation)
-      project.library.component_added(snoopy)
-      project.library.component_added(zlib)
-      project.library.component_added(private_code)
-      project.library.component_added(software_with_warnings) if software_with_warnings
+      softwares.each { |s| project.library.component_added(s) }
+
+      Licensing.create_incrementally(project) do |licensing|
+        project.softwares.each do |software|
+          licensing.execute_post_build(software)
+        end
+      end
+    end
+
+    describe "prepare step" do
+
+      let(:licenses_dir) { File.join(install_dir, "LICENSES") }
+      let(:dot_gitkeep) { File.join(licenses_dir, ".gitkeep") }
+      let(:cache_dir) { File.join(install_dir, "license-cache") }
+      let(:cache_dot_gitkeep) { File.join(cache_dir, ".gitkeep") }
+
+      it "creates a LICENSES dir with a .gitkeep file inside the install directory" do
+        Licensing.new(project).prepare
+        expect(File).to exist(licenses_dir)
+        expect(File).to exist(dot_gitkeep)
+      end
+
+      it "creates a licenses-cache dir with a .gitkeep file inside the install directory" do
+        Licensing.new(project).prepare
+        expect(File).to exist(cache_dir)
+        expect(File).to exist(cache_dot_gitkeep)
+      end
 
-      Licensing.create!(project)
     end
 
     describe "without license definitions in the project" do
@@ -161,14 +216,21 @@ module Omnibus
         output = capture_logging { create_licenses }
         expect(output).to include("Project 'test-project' is using 'Custom Chef' which is not one of the standard licenses")
       end
+
+      context "with a version override" do
+        let(:zlib_version_override) { "1.8.0" }
+
+        it_behaves_like "correctly created licenses"
+      end
     end
 
     describe "with a local license file that does not exist" do
       let(:software_with_warnings) do
-        Software.new(project, 'problematic.rb').evaluate do
-          name 'problematic'
-          default_version '0.10.2'
+        Software.new(project, "problematic.rb").evaluate do
+          name "problematic"
+          default_version "0.10.2"
           license_file "NOT_EXISTS"
+          skip_transitive_dependency_licensing true
         end
       end
 
@@ -186,10 +248,11 @@ module Omnibus
       end
 
       let(:software_with_warnings) do
-        Software.new(project, 'problematic.rb').evaluate do
-          name 'problematic'
-          default_version '0.10.2'
+        Software.new(project, "problematic.rb").evaluate do
+          name "problematic"
+          default_version "0.10.2"
           license_file "https://downloads.chef.io/LICENSE"
+          skip_transitive_dependency_licensing true
         end
       end
 
@@ -204,10 +267,11 @@ module Omnibus
 
     describe "with a software with no license files" do
       let(:software_with_warnings) do
-        Software.new(project, 'problematic.rb').evaluate do
-          name 'problematic'
-          default_version '0.10.2'
+        Software.new(project, "problematic.rb").evaluate do
+          name "problematic"
+          default_version "0.10.2"
           license "Zlib"
+          skip_transitive_dependency_licensing true
         end
       end
 
@@ -233,5 +297,250 @@ module Omnibus
         expect(output).to include("Project 'test-project' does not point to a license file.")
       end
     end
+
+    describe "with :fatal_licensing_warnings set and without license definitions in the project" do
+      before do
+        Omnibus::Config.fatal_licensing_warnings(true)
+      end
+
+      it "fails the omnibus build" do
+        expect { create_licenses }.to raise_error(Omnibus::LicensingError, /Project 'test-project' does not contain licensing information.\s{1,}Software 'private_code' does not contain licensing information./)
+      end
+    end
+
+    describe "when all software is setting skip_transitive_dependency_licensing " do
+      # This is achieved by the default values of the let() parameters
+
+      it "does not collect transitive licensing info for any software" do
+        softwares.each { |s| project.library.component_added(s) }
+
+        Licensing.create_incrementally(project) do |licensing|
+          expect(licensing).not_to receive(:collect_transitive_dependency_licenses_for)
+
+          project.softwares.each do |software|
+            licensing.execute_post_build(software)
+          end
+        end
+      end
+    end
+
+    describe "when a project has transitive dependencies" do
+      let(:license) { "Custom Chef" }
+      let(:license_file_path) { "CHEF.LICENSE" }
+      let(:license_file) { "CUSTOM_CHEF" }
+
+      let(:expected_project_license_path) { license_file_path }
+
+      let(:softwares) { [zlib] }
+
+      before do
+        File.open(File.join(Config.project_root, license_file), "w+") do |f|
+          f.puts "Chef Custom License is awesome."
+        end
+      end
+
+      after do
+        FileUtils.rm_rf(license_file)
+      end
+
+      let(:zlib) do
+        Software.new(project, "zlib.rb").evaluate do
+          name "zlib"
+          default_version "1.7.2"
+
+          license "Zlib"
+          license_file "LICENSE"
+        end
+      end
+
+      let(:snoopy) do
+        Software.new(project, "snoopy.rb").evaluate do
+          name "snoopy"
+          default_version "1.0.0"
+
+          license "GPL v2"
+          license_file "NOTICE"
+        end
+      end
+
+      let(:license_fixtures_path) { File.join(fixtures_path, "licensing/license_scout") }
+
+      describe "when project type is not supported" do
+
+        before do
+          allow_any_instance_of(LicenseScout::Collector).to receive(:run) do
+            raise LicenseScout::Exceptions::UnsupportedProjectType.new("/path/to/project")
+          end
+        end
+
+        it "does not raise an error" do
+          expect { create_licenses }.not_to raise_error
+        end
+
+        it "logs a warning message" do
+          output = capture_logging { create_licenses }
+          expect(output).to include("is not supported project type for transitive dependency license collection")
+        end
+
+        context "with :fatal_licensing_warnings" do
+
+          before do
+            Omnibus::Config.fatal_licensing_warnings(true)
+          end
+
+          it "does not fail omnibus build" do
+            expect { create_licenses }.not_to raise_error
+          end
+        end
+
+        context "with :fatal_transitive_dependency_licensing_warnings" do
+
+          before do
+            Omnibus::Config.fatal_transitive_dependency_licensing_warnings(true)
+          end
+
+          it "fails omnibus build" do
+            expect { create_licenses }.to raise_error(Omnibus::LicensingError, /is not supported project type for transitive dependency license collection/)
+          end
+        end
+      end
+
+      describe "when there are warnings in the licensing info" do
+        before do
+          allow_any_instance_of(LicenseScout::Collector).to receive(:run)
+          allow_any_instance_of(LicenseScout::Collector).to receive(:issue_report).and_return(["This is a licensing warning!!!"])
+        end
+
+        it "logs the warnings" do
+          output = capture_logging { create_licenses }
+          expect(output).to include("This is a licensing warning!!!")
+        end
+      end
+
+      describe "when there are no warnings in the licensing info" do
+        before do
+          allow_any_instance_of(LicenseScout::Collector).to receive(:run) do
+            FileUtils.cp_r(File.join(license_fixtures_path, "zlib"), File.join(install_dir, "license-cache/"))
+          end
+
+          allow_any_instance_of(LicenseScout::Collector).to receive(:issue_report).and_return([])
+        end
+
+        let(:expected_license_files) {
+          %w{
+            ruby_bundler-inifile-3.0.0-README.md
+            ruby_bundler-mime-types-3.1-Licence.rdoc
+            ruby_bundler-mini_portile2-2.1.0-LICENSE.txt
+          }
+        }
+
+        let(:expected_license_texts) {
+          [
+            <<-EOH,
+This product includes inifile 3.0.0
+which is a 'ruby_bundler' dependency of 'zlib',
+and which is available under a 'MIT' License.
+For details, see:
+#{install_dir}/LICENSES/ruby_bundler-inifile-3.0.0-README.md
+EOH
+            <<-EOH,
+This product includes mime-types 3.1
+which is a 'ruby_bundler' dependency of 'zlib',
+and which is available under a 'MIT' License.
+For details, see:
+#{install_dir}/LICENSES/ruby_bundler-mime-types-3.1-Licence.rdoc
+EOH
+            <<-EOH,
+This product includes mini_portile2 2.1.0
+which is a 'ruby_bundler' dependency of 'zlib',
+and which is available under a 'MIT' License.
+For details, see:
+#{install_dir}/LICENSES/ruby_bundler-mini_portile2-2.1.0-LICENSE.txt
+EOH
+          ]
+        }
+
+        it "includes transitive dependency license information in the project license information" do
+          create_licenses
+
+          project_license = File.join(install_dir, expected_project_license_path)
+          expect(File.exist?(project_license)).to be(true)
+          project_license_content = File.read(project_license)
+
+          expected_license_texts.each { |t| expect(project_license_content).to include(t) }
+          expected_license_files.each { |f| expect(File).to exist(File.join(install_dir, "LICENSES", f)) }
+          expect(File).not_to exist(File.join(install_dir, "license-cache"))
+        end
+      end
+
+      describe "with multiple softwares that have dependencies" do
+        let(:softwares) { [zlib, snoopy] }
+
+        before do
+          allow_any_instance_of(LicenseScout::Collector).to receive(:run) do
+            FileUtils.cp_r(File.join(license_fixtures_path, "zlib"), File.join(install_dir, "license-cache/"))
+            FileUtils.cp_r(File.join(license_fixtures_path, "snoopy"), File.join(install_dir, "license-cache/"))
+          end
+
+          allow_any_instance_of(LicenseScout::Collector).to receive(:issue_report).and_return([])
+        end
+
+        let(:expected_license_files) {
+          %w{
+            ruby_bundler-inifile-3.0.0-README.md
+            ruby_bundler-mime-types-3.1-Licence.rdoc
+            ruby_bundler-mini_portile2-2.1.0-LICENSE.txt
+          }
+        }
+
+        let(:expected_license_texts) {
+          [
+            <<-EOH,
+This product includes inifile 3.0.0
+which is a 'ruby_bundler' dependency of 'snoopy', 'zlib',
+and which is available under a 'MIT' License.
+For details, see:
+#{install_dir}/LICENSES/ruby_bundler-inifile-3.0.0-README.md
+EOH
+            <<-EOH,
+This product includes mime-types 3.1
+which is a 'ruby_bundler' dependency of 'zlib',
+and which is available under a 'MIT' License.
+For details, see:
+#{install_dir}/LICENSES/ruby_bundler-mime-types-3.1-Licence.rdoc
+EOH
+            <<-EOH,
+This product includes mini_portile2 2.1.0
+which is a 'ruby_bundler' dependency of 'zlib',
+and which is available under a 'MIT' License.
+For details, see:
+#{install_dir}/LICENSES/ruby_bundler-mini_portile2-2.1.0-LICENSE.txt
+EOH
+            <<-EOH,
+This product includes bundler-audit 0.5.0
+which is a 'ruby_bundler' dependency of 'snoopy',
+and which is available under a 'GPLv3' License.
+For details, see:
+#{install_dir}/LICENSES/ruby_bundler-bundler-audit-0.5.0-COPYING.txt
+EOH
+
+          ]
+        }
+
+        it "includes merged licensing information from multiple software definitions" do
+          create_licenses
+
+          project_license = File.join(install_dir, expected_project_license_path)
+          expect(File.exist?(project_license)).to be(true)
+          project_license_content = File.read(project_license)
+
+          expected_license_texts.each { |t| expect(project_license_content).to include(t) }
+          expected_license_files.each { |f| expect(File).to exist(File.join(install_dir, "LICENSES", f)) }
+          expect(File).not_to exist(File.join(install_dir, "license-cache"))
+        end
+
+      end
+
+    end
   end
 end

data/spec/functional/templating_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require "spec_helper"
 
 module Omnibus
   class RandomClass
@@ -9,12 +9,12 @@ module Omnibus
     subject { RandomClass.new }
 
     describe '#render_template' do
-      let(:source)      { File.join(tmp_path, 'source.erb') }
-      let(:destination) { File.join(tmp_path, 'final') }
+      let(:source)      { File.join(tmp_path, "source.erb") }
+      let(:destination) { File.join(tmp_path, "final") }
       let(:mode)        { 0644 }
-      let(:variables)   { { name: 'Name' } }
+      let(:variables)   { { name: "Name" } }
       let(:contents) do
-        <<-EOH.gsub(/^ {10}/, '')
+        <<-EOH.gsub(/^ {10}/, "")
           <%= name %>
 
           <% if false -%>
@@ -32,49 +32,49 @@ module Omnibus
       end
 
       before do
-        File.open(source, 'w') { |f| f.write(contents) }
+        File.open(source, "w") { |f| f.write(contents) }
       end
 
-      context 'when no destination is given' do
+      context "when no destination is given" do
         let(:destination) { nil }
 
-        it 'renders adjacent, without the erb extension' do
+        it "renders adjacent, without the erb extension" do
           subject.render_template(source, options)
-          expect(File.join(tmp_path, 'source')).to be_a_file
+          expect(File.join(tmp_path, "source")).to be_a_file
         end
       end
 
-      context 'when a destination is given' do
-        it 'renders at the destination' do
+      context "when a destination is given" do
+        it "renders at the destination" do
           subject.render_template(source, options)
           expect(destination).to be_a_file
         end
       end
 
-      context 'when a mode is given', :not_supported_on_windows do
+      context "when a mode is given", :not_supported_on_windows do
         let(:mode) { 0755 }
 
-        it 'renders the object with the mode' do
+        it "renders the object with the mode" do
           subject.render_template(source, options)
           expect(destination).to be_an_executable
         end
       end
 
-      context 'when an undefined variable is used' do
+      context "when an undefined variable is used" do
         let(:contents) { "<%= not_a_real_variable %>" }
 
-        it 'raise an exception' do
+        it "raise an exception" do
           expect do
             subject.render_template(source, options)
           end.to raise_error(NameError)
         end
       end
 
-      context 'when no variables are present' do
+      context "when no variables are present" do
         let(:content)   { "static content" }
         let(:variables) { {} }
 
-        it 'renders the template' do
+        it "renders the template" do
           subject.render_template(source, options)
           expect(destination).to be_a_file
         end

data/spec/spec_helper.rb

@@ -1,11 +1,11 @@
-require 'rspec'
-require 'rspec/its'
+require "rspec"
+require "rspec/its"
 require "rspec/json_expectations"
-require 'webmock/rspec'
+require "webmock/rspec"
 
-require 'cleanroom/rspec'
+require "cleanroom/rspec"
 
-require 'omnibus'
+require "omnibus"
 
 def windows?
   !!(RUBY_PLATFORM =~ /mswin|mingw|windows/)
@@ -17,31 +17,31 @@ end
 
 RSpec.configure do |config|
   # Custom matchers and shared examples
-  require_relative 'support/examples'
-  require_relative 'support/matchers'
+  require_relative "support/examples"
+  require_relative "support/matchers"
 
-  require_relative 'support/env_helpers'
+  require_relative "support/env_helpers"
   config.include(Omnibus::RSpec::EnvHelpers)
 
-  require_relative 'support/file_helpers'
+  require_relative "support/file_helpers"
   config.include(Omnibus::RSpec::FileHelpers)
 
-  require_relative 'support/git_helpers'
+  require_relative "support/git_helpers"
   config.include(Omnibus::RSpec::GitHelpers)
 
-  require_relative 'support/logging_helpers'
+  require_relative "support/logging_helpers"
   config.include(Omnibus::RSpec::LoggingHelpers)
 
-  require_relative 'support/ohai_helpers'
+  require_relative "support/ohai_helpers"
   config.include(Omnibus::RSpec::OhaiHelpers)
 
-  require_relative 'support/output_helpers'
+  require_relative "support/output_helpers"
   config.include(Omnibus::RSpec::OutputHelpers)
 
-  require_relative 'support/path_helpers'
+  require_relative "support/path_helpers"
   config.include(Omnibus::RSpec::PathHelpers)
 
-  require_relative 'support/shell_helpers'
+  require_relative "support/shell_helpers"
   config.include(Omnibus::RSpec::ShellHelpers)
 
   config.filter_run(focus: true)
@@ -55,7 +55,7 @@ RSpec.configure do |config|
     # Use the documentation formatter for detailed output,
     # unless a formatter has already been configured
     # (e.g. via a command-line flag).
-    config.default_formatter = 'doc'
+    config.default_formatter = "doc"
     config.color = true
   end
 
@@ -72,7 +72,7 @@ RSpec.configure do |config|
     FileUtils.mkdir_p(tmp_path)
 
     # Don't run Ohai - tests can still override this
-    stub_ohai(platform: 'ubuntu', version: '12.04')
+    stub_ohai(platform: "ubuntu", version: "12.04")
 
     # Default to real HTTP requests
     WebMock.allow_net_connect!
@@ -88,7 +88,7 @@ RSpec.configure do |config|
   end
 
   # Run specs in a random order
-  config.order = 'random'
+  config.order = "random"
 end
 
 #
@@ -99,7 +99,7 @@ end
 #     name 'foo'
 #   EOH
 #
-RSpec.shared_examples 'a cleanroom setter' do |id, string|
+RSpec.shared_examples "a cleanroom setter" do |id, string|
   it "for `#{id}'" do
     expect { subject.evaluate(string) }
       .to_not raise_error
@@ -112,7 +112,7 @@ end
 # @example
 #   it_behaves_like 'a cleanroom getter', :name
 #
-RSpec.shared_examples 'a cleanroom getter' do |id|
+RSpec.shared_examples "a cleanroom getter" do |id|
   it "for `#{id}'" do
     expect { subject.evaluate("#{id}") }.to_not raise_error
   end