Merge pull request #678 from chef/sersut/fatal-licensing

Add :fatal_licensing_warnings configuration option

lib/omnibus/config.rb

@@ -446,7 +446,7 @@ def reset!
     #
     # For example:
     #
-    #     /PATH/files/my_map_file 
+    #     /PATH/files/my_map_file
     #
     # @return [String, nil]
     default(:solaris_linker_mapfile, "files/mapfiles/solaris")
@@ -509,6 +509,11 @@ def reset!
       end
     end
 
+    # Fail the build or warn when build encounters a licensing warning.
+    #
+    # @return [true, false]
+    default(:fatal_licensing_warnings, false)
+
     # --------------------------------------------------
     # @!endgroup
     #

lib/omnibus/exceptions.rb

@@ -335,4 +335,20 @@ def initialize
       super("Failed to sign Windows Package.")
     end
   end
+
+  class LicensingError < Error
+    def initialize(errors)
+      @errors = errors
+    end
+
+    def to_s
+      <<-EOH
+Encountered error(s) with project's licensing information.
+Failing the build because :fatal_licensing_warnings is set in the configuration.
+Error(s):
+
+    #{@errors.join("\n    ")}
+EOH
+    end
+  end
 end

lib/omnibus/licensing.rb

@@ -40,12 +40,20 @@ def create!(project)
     #
     attr_reader :project
 
+    #
+    # The warnings encountered while preparing the licensing information
+    #
+    # @return [Array<String>]
+    #
+    attr_reader :licensing_warnings
+
     #
     # @param [Project] project
     #   the project to create licenses for.
     #
     def initialize(project)
       @project = project
+      @licensing_warnings = []
     end
 
     #
@@ -59,6 +67,10 @@ def create!
       validate_license_info
       create_software_license_files
       create_project_license_file
+
+      if Config.fatal_licensing_warnings && !licensing_warnings.empty?
+        raise LicensingError.new(licensing_warnings)
+      end
     end
 
     #
@@ -92,7 +104,7 @@ def validate_license_info
 
       # Check used license is a standard license
       if project.license != "Unspecified" && !STANDARD_LICENSES.include?(project.license)
-        licensing_warning("Project '#{project.name}' is using '#{project.license}' which is not one of the standard licenses identified in https://opensource.org/licenses/alphabetical. Consider using one of the standard licenses.")
+        licensing_info("Project '#{project.name}' is using '#{project.license}' which is not one of the standard licenses identified in https://opensource.org/licenses/alphabetical. Consider using one of the standard licenses.")
       end
 
       # Now let's check the licensing info for software components
@@ -109,7 +121,7 @@ def validate_license_info
 
         # Check if the software license is one of the standard licenses
         if license_info[:license] != "Unspecified" && !STANDARD_LICENSES.include?(license_info[:license])
-          licensing_warning("Software '#{software_name}' uses license '#{license_info[:license]}' which is not one of the standard licenses identified in https://opensource.org/licenses/alphabetical. Consider using one of the standard licenses.")
+          licensing_info("Software '#{software_name}' uses license '#{license_info[:license]}' which is not one of the standard licenses identified in https://opensource.org/licenses/alphabetical. Consider using one of the standard licenses.")
         end
       end
     end
@@ -294,11 +306,26 @@ def local?(license)
     end
 
     #
-    # Logs the given message as warning.
+    # Logs the given message as info.
+    #
+    # This method should only be used for detecting in a license is known or not.
+    # In the future, we will introduce a configurable way to whitelist or blacklist
+    # the allowed licenses. Once we implement that we need to stop using this method.
+    #
+    # @param [String] message
+    #   message to log as warning
+    def licensing_info(message)
+      log.info(log_key) { message }
+    end
+
+    #
+    # Logs the given message as warning or fails the build depending on the
+    # :fatal_licensing_warnings configuration setting.
     #
     # @param [String] message
     #   message to log as warning
     def licensing_warning(message)
+      licensing_warnings << message
       log.warn(log_key) { message }
     end
 

spec/functional/licensing_spec.rb

@@ -261,5 +261,15 @@ def create_licenses
         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
   end
 end

spec/unit/config_spec.rb

@@ -44,6 +44,7 @@ module Omnibus
     include_examples 'a configurable', :use_git_caching, true
     include_examples 'a configurable', :fetcher_read_timeout, 60
     include_examples 'a configurable', :fetcher_retries, 5
+    include_examples 'a configurable', :fatal_licensing_warnings, false
 
     describe '#workers' do
       context 'when the Ohai data is not present' do