vanagon 0.15.19 → 0.15.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: b71ba52fd3a026248d25a3a10a0570960d552585a8cc3e114c2bb366583c2bbb
-  data.tar.gz: 726ddf77c6137b9f09adf974dd981eae1f654f063a32f56181c1ca630f3fd04b
+SHA1:
+  metadata.gz: 468fb182c6b20bdf8a1257d1f90a89c5f3c501e7
+  data.tar.gz: 4b9937671809e342dece2d5f296ee4b1b8d7dc12
 SHA512:
-  metadata.gz: 4afb19e20c1e81500c9ed9cde575ed93679dd2fca0407d86a9b67aa4bf0cbcadb65b3a74d0dc9e9439a5686e285792c571b6e2fa1faecb1a646409edbc527b48
-  data.tar.gz: 53b39a73763a1c30cde5cd75ff17356ace19390518cd4bb9d490a00316d72d91d7ecea9565ebf50c36f0cd48ebbc61c6e645922d0574e4b77b9c6d6bddd12fd2
+  metadata.gz: cdf0afd337b97afbd7f265319a0f238f946871b57be2e10d43462c77fd10635ca75cfb4c0bc5cc67705e305722fc2abbd31c1f90c442cc473f567c07713c5779
+  data.tar.gz: f1ddb2ea14f6167c36b32a8a454bdcbc208e31a3fc5acd99834b7723080efe92cf28bc96bc78858ba72ca4bbfa6529ecffa784f21424509d115bb719fb9a6242

data/lib/vanagon/component.rb

@@ -163,6 +163,7 @@ class Vanagon
       @check = []
       @patches = []
       @files = Set.new
+      @ghost_files = Set.new
       @directories = []
       @replaces = []
       @provides = []
@@ -188,6 +189,16 @@ class Vanagon
       @files.add file
     end
 
+    # Adds the given file to the list of %ghost files to be added to an
+    # rpm spec's %files.
+    #
+    # @param file [Vanagon::Common::Pathname] file to add to the ghost file set.
+    # @return [Set, nil] Returns @ghost_files if the file is successfully added
+    #   to @ghost_files or nil if the file already exists.
+    def add_rpm_ghost_file(file)
+      @ghost_files.add file
+    end
+
     # Deletes the given file from the list of files and returns @files.
     #
     # @param file [String] path of file to delete from a component's list of files
@@ -213,6 +224,14 @@ class Vanagon
       @files.select(&:configfile?)
     end
 
+    # Retrieve all the files intended as %ghost entries for an rpm spec
+    # %files section.
+    #
+    # @return [Array] of all the rpm %ghost files.
+    def rpm_ghost_files
+      @ghost_files.to_a
+    end
+
     # @return [Set] a list of unique mirror URIs that should be used to
     #   retrieve the upstream source before attempting to retrieve from
     #   whatever URI was defined for #uri. If no mirrors are set and the

data/lib/vanagon/component/dsl.rb

@@ -281,6 +281,16 @@ class Vanagon
         @component.add_file Vanagon::Common::Pathname.file(target)
       end
 
+      # Add a %ghost entry to the rpm %files section.
+      # This indicates a file that is tracked in the rpm database (the package
+      # manages it), but not installed. Used, for example, when setting up
+      # alternative packages for use with update-alternatives.
+      #
+      # @param path [String] installed path of the file.
+      def add_rpm_ghost_file(path)
+        @component.add_rpm_ghost_file(Vanagon::Common::Pathname.file(path))
+      end
+
       # Sets the version for the component
       #
       # @param ver [String] version of the component

data/lib/vanagon/driver.rb

@@ -140,7 +140,7 @@ class Vanagon
       @project.make_bill_of_materials(workdir)
       # Don't generate packaging artifacts if no_packaging is set
       @project.generate_packaging_artifacts(workdir) unless @project.no_packaging
-      @project.save_manifest_json
+      @project.save_manifest_json(@platform)
       @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)

data/lib/vanagon/project.rb

@@ -236,6 +236,16 @@ class Vanagon
       files.flatten.uniq
     end
 
+    # Collects any rpm %ghost files supplied by components
+    #
+    # @return [Array] array of all files to be specified as %ghost entries
+    #   in an rpm %files section.
+    def get_rpm_ghost_files
+      files = []
+      files.push components.flat_map(&:rpm_ghost_files)
+      files.flatten.uniq
+    end
+
     # Returns a filtered out set of components only including those
     # components necessary to build a specific component. This is a
     # recursive function that will call itself until it gets to a
@@ -683,14 +693,22 @@ class Vanagon
       end
     end
 
-    # Writes a json file at `ext/build_metadata.json` containing information
+    # Writes a json file at `ext/build_metadata.<project>.<platform>.json` containing information
     # about what went into a built artifact
     #
     # @return [Hash] of build information
-    def save_manifest_json
+    def save_manifest_json(platform)
       manifest = build_manifest_json(true)
-      FileUtils.mkdir_p 'ext'
-      File.open(File.join('ext', 'build_metadata.json'), 'w') do |f|
+      ext_directory = 'ext'
+      FileUtils.mkdir_p ext_directory
+
+      metadata_file_name = "build_metadata.#{name}.#{platform.name}.json"
+      File.open(File.join(ext_directory, metadata_file_name), 'w') do |f|
+        f.write(manifest)
+      end
+
+      ## VANAGON-132 Backwards compatibility: make a 'build_metadata.json' file
+      File.open(File.join(ext_directory, 'build_metadata.json'), 'w') do |f|
         f.write(manifest)
       end
     end

data/resources/rpm/project.spec.erb

@@ -366,6 +366,9 @@ fi
 <%- get_files.each do |file| -%>
 %attr(<%= file.mode || "-" %>, <%= file.owner || "-" %>, <%= file.group || "-" %>) <%= file.path %>
 <%- end -%>
+<%- get_rpm_ghost_files.each do |file| -%>
+%ghost <%= file.path %>
+<%- end -%>
 
 %changelog
 * <%= Time.now.strftime("%a %b %d %Y") %> <%= @vendor %> -  <%= @version %>-<%= @release %>

data/spec/lib/vanagon/component/dsl_spec.rb

@@ -1,5 +1,6 @@
 require 'vanagon/component/dsl'
 require 'vanagon/common'
+require 'vanagon/platform'
 require 'json'
 
 describe 'Vanagon::Component::DSL' do
@@ -859,4 +860,13 @@ end" }
       expect(comp._component.directories.first).to eq(Vanagon::Common::Pathname.new('/a/b/c', mode: '0400', owner: 'olivia', group: 'release-engineering'))
     end
   end
+
+  describe '#add_rpm_ghost_file' do
+    let(:comp) { Vanagon::Component::DSL.new('ghost-test', {}, platform) }
+
+    it 'adds a ghost file as a Pathname object' do
+      comp.add_rpm_ghost_file('ghost')
+      expect(comp._component.rpm_ghost_files).to eq([Vanagon::Common::Pathname.file('ghost')])
+    end
+  end
 end

data/spec/lib/vanagon/component_spec.rb

@@ -241,4 +241,27 @@ describe "Vanagon::Component" do
       end
     end
   end
+
+  describe 'rpm ghost files' do
+    let(:component) { Vanagon::Component.new('ghost-test', {}, {}) }
+
+    it 'initializes an empty set' do
+      expect(component.rpm_ghost_files).to eq([])
+    end
+
+    it 'adds a ghost file' do
+      expect(component.add_rpm_ghost_file('ghost')).to eq(Set.new(['ghost']))
+    end
+
+    it 'returns an array of ghost files' do
+      component.add_rpm_ghost_file('ghost')
+      expect(component.rpm_ghost_files).to eq(['ghost'])
+    end
+
+    it 'ignores duplicates' do
+      component.add_rpm_ghost_file('ghost')
+      component.add_rpm_ghost_file('ghost')
+      expect(component.rpm_ghost_files).to eq(['ghost'])
+    end
+  end
 end

data/spec/lib/vanagon/project_spec.rb

@@ -1,6 +1,7 @@
 require 'vanagon/project'
 require 'vanagon/driver'
 require 'vanagon/errors'
+require 'fakefs/spec_helpers'
 
 describe 'Vanagon::Project' do
   let(:component) { double(Vanagon::Component) }
@@ -413,6 +414,50 @@ describe 'Vanagon::Project' do
     end
   end
 
+  describe '#save_manifest_json' do
+    include FakeFS::SpecHelpers
+    let(:platform_name) { 'el-7-x86_64' }
+    let(:platform) { Vanagon::Platform.new(platform_name) }
+    before(:each) do
+      class Vanagon
+        class Project
+          BUILD_TIME = '2018-07-10T13:34:25-07:00'
+          VANAGON_VERSION = '0.0.0-rspec'
+        end
+      end
+
+      @proj = Vanagon::Project.new('test-project', platform)
+    end
+
+    it 'should generate a file with the expected build metadata' do
+      correct_sample_metadata = {
+        'packaging_type' => { 'vanagon' => '0.0.0-rspec' },
+        'version' => '123abcde',
+        'components' => { 'test-component-10' => { 'version' => '1.2.3' } },
+        'build_time' => '2018-07-10T13:34:25-07:00',
+      }
+      bad_sample_metadata = {
+        'BAD KEY' => 'BAD VALUE'
+      }
+      comp1 = Vanagon::Component.new('test-component-10', {}, {})
+      comp1.version = '1.2.3'
+      @proj.components << comp1
+      @proj.version = '123abcde'
+      FakeFS do
+        @proj.save_manifest_json(platform)
+
+        old_style_metadata = JSON.parse(File.read('ext/build_metadata.json'))
+        expect(old_style_metadata).to eq(correct_sample_metadata)
+
+        metadata_with_project_and_platform = JSON.parse(
+          File.read("ext/build_metadata.test-project.#{platform_name}.json"))
+        expect(metadata_with_project_and_platform).to eq(correct_sample_metadata)
+        expect(metadata_with_project_and_platform).not_to eq(bad_sample_metadata)
+      end
+    end
+  end
+
+
   describe '#publish_yaml_settings' do
     let(:platform_name) { 'aix-7.2-ppc' }
     let(:platform) { Vanagon::Platform.new(platform_name) }
@@ -498,4 +543,19 @@ describe 'Vanagon::Project' do
       expect(proj._project.generate_package).to eq([])
     end
   end
+
+  describe '#get_rpm_ghost_files' do
+    it 'returns an empty array when there are no ghost files' do
+      proj = Vanagon::Project.new('test-ghost', {})
+      expect(proj.get_rpm_ghost_files).to eq([])
+    end
+
+    it 'returns ghost files when some are set' do
+      proj = Vanagon::Project.new('test-ghosts', {})
+      comp = Vanagon::Component.new('ghosts', {}, {})
+      comp.add_rpm_ghost_file('ghost')
+      proj.components << comp
+      expect(proj.get_rpm_ghost_files).to eq(['ghost'])
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vanagon
 version: !ruby/object:Gem::Version
-  version: 0.15.19
+  version: 0.15.20
 platform: ruby
 authors:
 - Puppet Labs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-20 00:00:00.000000000 Z
+date: 2019-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -261,7 +261,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.6.9
 signing_key: 
 specification_version: 3
 summary: All of your packages will fit into this van with this one simple trick.