vanagon 0.12.2 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9edf9922c6e47b100e228f38190ebc1e0d01a102
-  data.tar.gz: 8267580682ab771c77615f4ba936d389680a62c7
+  metadata.gz: 1862a2a62a15ce507d5fade3b65736fcfc1e4b90
+  data.tar.gz: b317b66ef360dd1c87c73d6a743b2677bc0f108b
 SHA512:
-  metadata.gz: 399f46811612f5200dcf9a056bd2a37f6b242abaf3b4f98642de37e257fd55408b6e64c4a392bb1eb0a313b6de7745c7b7a8afcd5dd1841d429032d8def06c95
-  data.tar.gz: 0d0fee8345a6116531ce908ee02cd841b6fc4c4f41332cb39eb39dcd9c32d20543ee4e9c448050904b0e8bd37128a47bcb733c4474348b4024f72467733762a9
+  metadata.gz: da5849324a741b84e3db25778605fc5eb60cc81bbd7cf6fa17989ee6ff634245cf06570ef55eff70df46075e03156a16019d13b6abdd1b7a4162e05e17b9a68d
+  data.tar.gz: 7f1a382f3b438022825ff6e43955b65ba5a8dffd51029281dc175d859ccac408876646a29023af53422c9d61eb336d7e983f01d59c148b2a4d30e1ac2bb549b5

data/lib/vanagon.rb

@@ -1,5 +1,9 @@
+require 'time'
+
 LIBDIR = File.expand_path(File.dirname(__FILE__))
 VANAGON_ROOT = File.join(File.expand_path(File.dirname(__FILE__)), "..")
+BUILD_TIME = Time.now.iso8601
+VANAGON_VERSION = Gem.loaded_specs["vanagon"].version.to_s
 
 $:.unshift(LIBDIR) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(LIBDIR)

data/lib/vanagon/component.rb

@@ -289,6 +289,10 @@ class Vanagon
       end
     end
 
+    def get_dependency_hash
+      { name => { 'version' => version, 'ref' => options[:ref] }.delete_if { |_, v| !v } }
+    end
+
     # Fetches secondary sources for the component. These are just dumped into the workdir currently.
     #
     # @param workdir [String] working directory to put the source into

data/lib/vanagon/driver.rb

@@ -124,6 +124,7 @@ class Vanagon
       @project.make_makefile(@workdir)
       @project.make_bill_of_materials(@workdir)
       @project.generate_packaging_artifacts(@workdir)
+      @project.save_manifest_json
       @engine.ship_workdir(@workdir)
       @engine.dispatch("(cd #{@engine.remote_workdir}; #{@platform.make})")
       @engine.retrieve_built_artifact

data/lib/vanagon/project.rb

@@ -475,5 +475,44 @@ class Vanagon
     def generate_packaging_artifacts(workdir)
       @platform.generate_packaging_artifacts(workdir, @name, binding)
     end
+
+    # Generate a json hash which lists all of the dependant components of the
+    # project.
+    #
+    # @return [Hash] where the top level keys are components and their values
+    #   are hashes with additional information on the component.
+    def generate_dependencies_info
+      @components.each_with_object({}) do |component, hsh|
+        hsh.merge!(component.get_dependency_hash)
+      end
+    end
+
+    # Generate a hash which contains relevant information regarding components
+    # of a package, what vanagon built the package, time of build, as well as
+    # version of the thing we were building.
+    #
+    # @return [Hash] of information which is useful to know about how a package
+    #   was built and what went into the package.
+    def build_manifest_json
+      manifest = {
+        "packaging_type" => {
+          "vanagon" => VANAGON_VERSION,
+        },
+        "version" => version,
+        "components" => generate_dependencies_info,
+        "build_time" => BUILD_TIME,
+      }
+    end
+
+    # Writes a json file at `ext/build_metadata.json` containing information
+    # about what went into a built artifact
+    #
+    # @return [Hash] of build information
+    def save_manifest_json
+      manifest = build_manifest_json
+      File.open(File.join('ext', 'build_metadata.json'), 'w') do |f|
+        f.write(JSON.pretty_generate(manifest))
+      end
+    end
   end
 end

data/spec/lib/vanagon/project_spec.rb

@@ -115,4 +115,55 @@ describe 'Vanagon::Project' do
       expect(@proj.filter_component(comp1.name)).to eq([comp1, comp2, comp3])
     end
   end
+
+  describe '#generate_dependencies_info' do
+    before(:each) do
+      @proj = Vanagon::Project.new('test-project', {})
+    end
+
+    it "returns a hash of components and their versions" do
+      comp1 = Vanagon::Component.new('test-component1', {}, {})
+      comp1.version = '1.0.0'
+      comp2 = Vanagon::Component.new('test-component2', {}, {})
+      comp2.version = '2.0.0'
+      comp2.options[:ref] = '123abcd'
+      comp3 = Vanagon::Component.new('test-component3', {}, {})
+      @proj.components << comp1
+      @proj.components << comp2
+      @proj.components << comp3
+
+      expect(@proj.generate_dependencies_info()).to eq({
+        'test-component1' => { 'version' => '1.0.0' },
+        'test-component2' => { 'version' => '2.0.0', 'ref' => '123abcd' },
+        'test-component3' => {},
+      })
+    end
+  end
+
+  describe '#build_manifest_json' do
+    before(:each) do
+      class Vanagon
+        class Project
+          BUILD_TIME = '2017-07-10T13:34:25-07:00'
+          VANAGON_VERSION = '0.0.0-rspec'
+        end
+      end
+
+      @proj = Vanagon::Project.new('test-project', {})
+    end
+
+    it 'should generate a hash with the expected build metadata' do
+      comp1 = Vanagon::Component.new('test-component1', {}, {})
+      comp1.version = '1.0.0'
+      @proj.components << comp1
+      @proj.version = '123abcde'
+
+      expect(@proj.build_manifest_json()).to eq({
+        'packaging_type' => { 'vanagon' => '0.0.0-rspec' },
+        'version' => '123abcde',
+        'components' => { 'test-component1' => { 'version' => '1.0.0' } },
+        'build_time' => '2017-07-10T13:34:25-07:00',
+      })
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vanagon
 version: !ruby/object:Gem::Version
-  version: 0.12.2
+  version: 0.13.0
 platform: ruby
 authors:
 - Puppet Labs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-29 00:00:00.000000000 Z
+date: 2017-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -239,7 +239,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.2.5
 signing_key: 
 specification_version: 3
 summary: All of your packages will fit into this van with this one simple trick.