vanagon 0.15.9 → 0.15.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d495893440327f099e0b318c1d7e5966a7c186e6
-  data.tar.gz: c626b8ca9a1e48dbe0d08d6bc3857e7226223233
+  metadata.gz: c881a94010be196e7f3ca83630dcd5992942e05e
+  data.tar.gz: aa92f93959346079d3860751d901319a5b94c86d
 SHA512:
-  metadata.gz: 78aee1207d6b21ac432bf07bda73f9491d1b19ae80271b545fad51e1cffcf27e8b3f5adba2a3b70bf1713c555feb5000a6b8f50a0f40b0fc184d9e49b3c21127
-  data.tar.gz: b81d5f2cf49c8de57cbbc4d5b952eaecaed7af319a03b500c9aaa1c001b91cff03584e20976470caf84dccae6858cf1572dad59e2f26553ee5c1c1939b00a51f
+  metadata.gz: 614fb484ead28a97271a5de18fa03a2772b6026a2af72c64666afbb01fb06d0e866528c0ae3dc623ab2b51ad87e0b3a63bd29807be2b019424143c46785c5397
+  data.tar.gz: a330ed57d45a948ab45d8949e078f9d9efbefa0a33d1c0b21c8a96993a076b3c5e1487e83def372b66f074b603bc0962de22e4c4ee6232ed4c9ca4a8cef96dcc

data/lib/vanagon/driver.rb

@@ -144,6 +144,7 @@ class Vanagon
       @engine.ship_workdir(workdir)
       @engine.dispatch("(cd #{@engine.remote_workdir}; #{@platform.make} #{make_target})")
       @engine.retrieve_built_artifact(@project.artifacts_to_fetch, @project.no_packaging)
+      @project.publish_yaml_settings(@platform)
 
       if %i[never on-failure].include? @preserve
         @engine.teardown

data/lib/vanagon/project.rb

@@ -61,6 +61,9 @@ class Vanagon
     # !refactor
     attr_accessor :version_file
 
+    # Store whether Vanagon should write the project's settings to a yaml file during builds
+    attr_accessor :yaml_settings
+
     # Stores the location for the bill-of-materials (a receipt of all
     # files written during) project package assembly
     attr_accessor :bill_of_materials
@@ -145,6 +148,7 @@ class Vanagon
       @source_artifacts = false
       @compiled_archive = false
       @generate_packages = true
+      @yaml_settings = false
       @no_packaging = false
       @artifacts_to_fetch = []
     end
@@ -665,6 +669,28 @@ class Vanagon
       end
     end
 
+    # Writes a yaml file at `output/<name>-<version>.<platform>.settings.yaml`
+    # containing settings used to build the current project on the platform
+    # provided (and a corresponding sha1sum file) if `yaml_settings` has been
+    # set in the project definition.
+    #
+    # @param [Vanagon::Platform] the platform to publish settings for
+    def publish_yaml_settings(platform)
+      return unless yaml_settings
+      raise(Vanagon::Error, "You must specify a project version") unless version
+
+      filename = "#{name}-#{version}.#{platform.name}.settings.yaml"
+      filepath = File.join('output', filename)
+
+      File.open(filepath, 'w') do |f|
+        f.write(@settings.to_yaml)
+      end
+
+      File.open("#{filepath}.sha1", 'w') do |f|
+        f.write(system("#{platform.shasum} #{filepath}", err: File::NULL))
+      end
+    end
+
     # Load the settings hash from an upstream vanagon project.
     # This will clone a git repo at a specified branch and load the specified
     # vanagon project (with no components). The settings hash of the upstream
@@ -692,5 +718,37 @@ class Vanagon
         upstream_project.cleanup
       end
     end
+
+    # Load the settings hash for the current project/platform combination from a
+    # yaml file as produced by `publish_yaml_settings`. file:// and http:// URIs
+    # are accepted. If the URI uses http://, a sha1 URI is also required.
+    #
+    # @param settings_uri [String] A URI to a yaml settings file
+    # @param settings_sha1_uri [String] A URI to a sha1sum file for the yaml settings file
+    # @raise [Vanagon::Error] when the settings file can't be found
+    def load_yaml_settings(settings_uri, settings_sha1_uri = nil) # rubocop:disable Metrics/AbcSize
+      source_type = Vanagon::Component::Source.determine_source_type(settings_uri)
+
+      if %i[unknown git].include?(source_type)
+        message = "Can't inherit settings from '#{settings_uri}'. Only http and file URIs are valid."
+        if settings_uri =~ /^file/
+          message = "Tried to load YAML settings from '#{settings_uri}', but the file doesn't exist."
+        end
+        raise Vanagon::Error, message
+      end
+
+      if (source_type == :http) && !settings_sha1_uri
+        raise Vanagon::Error, "You must provide a sha1sum URI for the YAML file when inheriting YAML settings over http"
+      end
+
+      Dir.mktmpdir do |working_directory|
+        source = Vanagon::Component::Source.source(settings_uri,
+                                                   workdir: working_directory,
+                                                   sum: settings_sha1_uri,
+                                                   sum_type: 'sha1')
+        source.fetch
+        @settings.merge!(YAML.safe_load(File.read(File.join(working_directory, source.file)), [Symbol]))
+      end
+    end
   end
 end

data/lib/vanagon/project/dsl.rb

@@ -1,8 +1,10 @@
+require 'vanagon/errors'
 require 'vanagon/project'
 require 'vanagon/utilities'
 require 'vanagon/component/source'
-require 'set'
 require 'git/rev_list'
+require 'set'
+require 'yaml'
 
 class Vanagon
   class Project
@@ -302,6 +304,11 @@ class Vanagon
         @project.version_file = Vanagon::Common::Pathname.file(target)
       end
 
+      # This method will write the project's settings (per-platform) to the output directory as yaml after building
+      def publish_yaml_settings
+        @project.yaml_settings = true
+      end
+
       # This method will write the project's bill-of-materials to a designated directory during package creation.
       # @param target [String] a full path to the directory for the bill-of-materials for the project
       def bill_of_materials(target)
@@ -322,6 +329,15 @@ class Vanagon
         @project.load_upstream_settings(upstream_project_name, upstream_git_url, upstream_git_branch)
       end
 
+      # Inherit the settings hash for the current project and platform from a
+      # yaml file as generated by `publish_yaml_settings`
+      #
+      # @param yaml_settings_uri [String] URI (file://... or http://...) to a file containing a yaml representation of vanagon settings
+      # @param yaml_settings_sha1_uri [String] URI (file://... or http://...) to a file the sha1sum for the settings file
+      def inherit_yaml_settings(yaml_settings_uri, yaml_settings_sha1_uri = nil)
+        @project.load_yaml_settings(yaml_settings_uri, yaml_settings_sha1_uri)
+      end
+
       # Set a package override. Will call the platform-specific implementation
       # This will get set in the spec file, deb rules, etc.
       #

data/resources/rpm/project.spec.erb

@@ -161,7 +161,7 @@ install -d %{buildroot}
 # Here we turn all dirs in the file-list into %dir entries to avoid duplicate files
 while read entry; do
   if [ -n "$entry" -a -d "$entry" -a ! -L "$entry" ]; then
-    PATH=/opt/freeware/bin:$PATH <%= @platform.sed %> -i "s|^\($entry\)\$|%dir \1|g" %{SOURCE1}
+    <%= @platform.sed %> -i "\|^$entry\$|s|^|%dir |" %{SOURCE1}
   fi
 done < %{SOURCE1}
 

data/spec/lib/vanagon/project_spec.rb

@@ -1,5 +1,6 @@
 require 'vanagon/project'
 require 'vanagon/driver'
+require 'vanagon/errors'
 
 describe 'Vanagon::Project' do
   let(:component) { double(Vanagon::Component) }
@@ -126,6 +127,75 @@ describe 'Vanagon::Project' do
     end
   end
 
+  describe "#load_yaml_settings" do
+    subject(:project) do
+      project = Vanagon::Project.new('yaml-inheritance-test', Vanagon::Platform.new('aix-7.2-ppc'))
+      project.settings = { merged: 'nope', original: 'original' }
+      project
+    end
+
+    let(:yaml_filename) { 'settings.yaml' }
+    let(:sha1_filename) { "#{yaml_filename}.sha1" }
+
+    let(:yaml_path) { "/path/to/#{yaml_filename}" }
+    let(:sha1_path) { "/path/to/#{sha1_filename}" }
+
+    let(:yaml_content) { { other: 'other', merged: 'yup' }.to_yaml }
+
+    let(:local_yaml_uri) { "file://#{yaml_path}" }
+    let(:http_yaml_uri) { "http:/#{yaml_path}" }
+
+    before(:each) do
+      allow(Dir).to receive(:mktmpdir) { |&block| block.yield '' }
+    end
+
+    it "fails for a local source if the settings file doesn't exist" do
+      expect { project.load_yaml_settings(local_yaml_uri) }.to raise_error(Vanagon::Error)
+    end
+
+    it "fails if given a git source" do
+      expect { project.load_yaml_settings('git://some/repo.uri') }.to raise_error(Vanagon::Error)
+    end
+
+    it "fails when given an unknown source" do
+      expect { project.load_yaml_settings("fake://source.uri") }.to raise_error(Vanagon::Error)
+    end
+
+    it "fails if downloading over HTTP without a valid sha1sum URI" do
+      allow(Vanagon::Component::Source::Http).to receive(:valid_url?).with(http_yaml_uri).and_return(true)
+      http_source = instance_double(Vanagon::Component::Source::Http)
+      allow(Vanagon::Component::Source).to receive(:source).and_return(http_source)
+
+      expect { project.load_yaml_settings(http_yaml_uri) }.to raise_error(Vanagon::Error)
+    end
+
+    context "given a valid source" do
+      before(:each) do
+        local_source = instance_double(Vanagon::Component::Source::Local)
+        allow(local_source).to receive(:fetch)
+        allow(local_source).to receive(:file).and_return(yaml_path)
+
+        allow(Vanagon::Component::Source).to receive(:determine_source_type).and_return(:local)
+        allow(Vanagon::Component::Source).to receive(:source).and_return(local_source)
+        allow(File).to receive(:read).with(yaml_path).and_return(yaml_content)
+
+        expect { project.load_yaml_settings(local_yaml_uri) }.not_to raise_exception
+      end
+
+      it "overwrites the current project's settings when they conflict" do
+        expect(project.settings[:merged]).to eq('yup')
+      end
+
+      it "adopts new settings found in the other project" do
+        expect(project.settings[:other]).to eq('other')
+      end
+
+      it "keeps its own settings when there are no conflicts" do
+        expect(project.settings[:original]).to eq('original')
+      end
+    end
+  end
+
   describe "#filter_component" do
 
     # All of the following tests should be run with one project level
@@ -308,6 +378,50 @@ describe 'Vanagon::Project' do
     end
   end
 
+  describe '#publish_yaml_settings' do
+    let(:platform_name) { 'aix-7.2-ppc' }
+    let(:platform) { Vanagon::Platform.new(platform_name) }
+
+    subject(:project) do
+      project = Vanagon::Project.new('test-project', platform)
+      project.settings = { key: 'value' }
+      project.version = 'version'
+      project.yaml_settings = true
+      project
+    end
+
+    let(:yaml_output_path) { "output/test-project-version.#{platform_name}.settings.yaml" }
+    let(:sha1_output_path) { "output/test-project-version.#{platform_name}.settings.yaml.sha1" }
+
+    let(:yaml_file) { double('yaml_file') }
+    let(:sha1_file) { double('sha1_file') }
+
+    it 'writes project settings as yaml and a sha1sum for the settings to the output directory' do
+      expect(File).to receive(:open).with(yaml_output_path, "w").and_yield(yaml_file)
+      expect(File).to receive(:open).with(sha1_output_path, "w").and_yield(sha1_file)
+      expect(yaml_file).to receive(:write).with({key: 'value'}.to_yaml)
+      expect(sha1_file).to receive(:write)
+      expect { project.publish_yaml_settings(platform) }.not_to raise_error
+    end
+
+    it 'does not write yaml settings or a sha1sum unless told to' do
+      project.yaml_settings = false
+      expect(File).not_to receive(:open)
+      expect { project.publish_yaml_settings(platform) }.not_to raise_error
+    end
+
+    it "fails if the output directory doesn't exist" do
+      allow_any_instance_of(File).to receive(:open).with(yaml_output_path).and_raise(Errno::ENOENT)
+      allow_any_instance_of(File).to receive(:open).with(sha1_output_path).and_raise(Errno::ENOENT)
+      expect { project.publish_yaml_settings(platform) }.to raise_error(Errno::ENOENT)
+    end
+
+    it "fails unless the project has a version" do
+      project.version = nil
+      expect { project.publish_yaml_settings(platform) }.to raise_error(Vanagon::Error)
+    end
+  end
+
   describe '#generate_package' do
     it "builds packages by default" do
       platform = Vanagon::Platform::DSL.new('el-7-x86_64')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vanagon
 version: !ruby/object:Gem::Version
-  version: 0.15.9
+  version: 0.15.10
 platform: ruby
 authors:
 - Puppet Labs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-09 00:00:00.000000000 Z
+date: 2018-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -264,41 +264,41 @@ signing_key:
 specification_version: 3
 summary: All of your packages will fit into this van with this one simple trick.
 test_files:
-- spec/lib/git/rev_list_spec.rb
-- spec/lib/makefile_spec.rb
-- spec/lib/vanagon/common/pathname_spec.rb
-- spec/lib/vanagon/common/user_spec.rb
-- spec/lib/vanagon/component/dsl_spec.rb
-- spec/lib/vanagon/component/rules_spec.rb
-- spec/lib/vanagon/component/source/git_spec.rb
-- spec/lib/vanagon/component/source/http_spec.rb
-- spec/lib/vanagon/component/source/local_spec.rb
-- spec/lib/vanagon/component/source/rewrite_spec.rb
-- spec/lib/vanagon/component/source_spec.rb
 - spec/lib/vanagon/component_spec.rb
+- spec/lib/vanagon/project_spec.rb
+- spec/lib/vanagon/optparse_spec.rb
 - spec/lib/vanagon/driver_spec.rb
-- spec/lib/vanagon/engine/always_be_scheduling_spec.rb
-- spec/lib/vanagon/engine/base_spec.rb
-- spec/lib/vanagon/engine/docker_spec.rb
-- spec/lib/vanagon/engine/ec2_spec.rb
-- spec/lib/vanagon/engine/hardware_spec.rb
-- spec/lib/vanagon/engine/local_spec.rb
-- spec/lib/vanagon/engine/pooler_spec.rb
 - spec/lib/vanagon/environment_spec.rb
-- spec/lib/vanagon/extensions/ostruct/json_spec.rb
-- spec/lib/vanagon/extensions/set/json_spec.rb
-- spec/lib/vanagon/extensions/string_spec.rb
-- spec/lib/vanagon/optparse_spec.rb
-- spec/lib/vanagon/platform/deb_spec.rb
+- spec/lib/vanagon/platform/windows_spec.rb
+- spec/lib/vanagon/platform/solaris_11_spec.rb
+- spec/lib/vanagon/platform/solaris_10_spec.rb
 - spec/lib/vanagon/platform/dsl_spec.rb
 - spec/lib/vanagon/platform/osx_spec.rb
-- spec/lib/vanagon/platform/rpm/aix_spec.rb
+- spec/lib/vanagon/platform/deb_spec.rb
 - spec/lib/vanagon/platform/rpm_spec.rb
-- spec/lib/vanagon/platform/solaris_10_spec.rb
-- spec/lib/vanagon/platform/solaris_11_spec.rb
-- spec/lib/vanagon/platform/windows_spec.rb
-- spec/lib/vanagon/platform_spec.rb
+- spec/lib/vanagon/platform/rpm/aix_spec.rb
+- spec/lib/vanagon/component/source/rewrite_spec.rb
+- spec/lib/vanagon/component/source/git_spec.rb
+- spec/lib/vanagon/component/source/local_spec.rb
+- spec/lib/vanagon/component/source/http_spec.rb
+- spec/lib/vanagon/component/dsl_spec.rb
+- spec/lib/vanagon/component/source_spec.rb
+- spec/lib/vanagon/component/rules_spec.rb
+- spec/lib/vanagon/extensions/string_spec.rb
+- spec/lib/vanagon/extensions/set/json_spec.rb
+- spec/lib/vanagon/extensions/ostruct/json_spec.rb
 - spec/lib/vanagon/project/dsl_spec.rb
-- spec/lib/vanagon/project_spec.rb
 - spec/lib/vanagon/utilities/shell_utilities_spec.rb
 - spec/lib/vanagon/utilities_spec.rb
+- spec/lib/vanagon/common/pathname_spec.rb
+- spec/lib/vanagon/common/user_spec.rb
+- spec/lib/vanagon/platform_spec.rb
+- spec/lib/vanagon/engine/always_be_scheduling_spec.rb
+- spec/lib/vanagon/engine/docker_spec.rb
+- spec/lib/vanagon/engine/ec2_spec.rb
+- spec/lib/vanagon/engine/hardware_spec.rb
+- spec/lib/vanagon/engine/local_spec.rb
+- spec/lib/vanagon/engine/base_spec.rb
+- spec/lib/vanagon/engine/pooler_spec.rb
+- spec/lib/makefile_spec.rb
+- spec/lib/git/rev_list_spec.rb