vanagon 0.15.3 → 0.15.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 507a58974dda3aa6cf97fe0d8a8e2f1329ce1662
-  data.tar.gz: 6e5308dd84de5909fe9620838977d1f16814269d
+  metadata.gz: 3744e8372acb3ce656a75a360273b489ad3a5607
+  data.tar.gz: 61d3c29607c0d2f6a70317a6220dac9f766f8117
 SHA512:
-  metadata.gz: 7d22c6b298644338b4d4e1164749d40620f59425d23179cf8a4d4d0c66eb45ae40cce5f8bc4cefa96488e172a4ddc5d92acdf5f4073bd38e18a4eacb2ac433a5
-  data.tar.gz: 7a7980280d44cd994ff4b7c8e41ac337240e9a3762bfd3409ccf1dbdbf10c5380fb056a0f940f1e84bf54c3df69378b0578421fa4d4a8d1c474bed8f0363cb6a
+  metadata.gz: e8b86569bdea4ffd7a45299cfefe30aff38c9dafe55af28ba3d05d8aa6ceb95abab3fc83c013ba0c62288f01a1f01ad8332bd5950831036a797ced98b17370b6
+  data.tar.gz: b3215529d393fdfd7af5f46ec116c90b79996f71b30654a87cf6caabd1ae790e8ae46d371be0dbe8394fe634364856ff7e694cf6ba7397cdd39aa84b91f1ebb6

data/lib/git/rev_list.rb

@@ -0,0 +1,36 @@
+require 'git'
+
+module LibRevList
+  def rev_list(committish = nil, opts = {})
+    arr_opts = []
+
+    opts.each do |k, v|
+      # allow for passing, say, :max-count or :max_count
+      k = k.to_s
+      k.tr!('_', '-')
+      if v && v.to_s.downcase == 'true'
+        arr_opts << "--#{k}"
+      elsif v
+        arr_opts << "--#{k}=#{v}"
+      end
+    end
+
+    arr_opts << committish if committish
+
+    command('rev-list', arr_opts)
+  end
+end
+
+module Git
+  class Lib
+    include LibRevList
+  end
+end
+
+module Git
+  class Base
+    def rev_list(committish = nil, opts = {})
+      lib.rev_list(committish, opts)
+    end
+  end
+end

data/lib/vanagon/component.rb

@@ -5,6 +5,7 @@ require 'vanagon/component/source/rewrite'
 
 class Vanagon
   class Component
+    include Vanagon::Utilities
     # @!attribute [r] files
     #   @return [Set] the list of files marked for installation
 
@@ -326,6 +327,9 @@ class Vanagon
         )
         src.fetch
         src.verify
+        if source.erb
+          erb_file(src.file, File.join(File.dirname(src.file), File.basename(src.file, ".erb")), true)
+        end
         # set src.file to only be populated with the basename instead of entire file path
         src.file = File.basename(src.url)
         extract_with << src.extract(platform.tar) if src.respond_to? :extract

data/lib/vanagon/component/dsl.rb

@@ -368,6 +368,7 @@ class Vanagon
       # @param [Hash] options optional keyword arguments used to instatiate a new source
       #   @option opts [String] :sum
       #   @option opts [String] :ref
+      #   @option opts [Bool] :erb set to 'true' to specify that the source file should be translated by erb
       def add_source(uri, **options)
         @component.sources << OpenStruct.new(options.merge({ url: uri }))
       end

data/lib/vanagon/driver.rb

@@ -116,14 +116,20 @@ class Vanagon
       end
     end
 
-    def run # rubocop:disable Metrics/AbcSize
+    def run # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity
       # Simple sanity check for the project
       if @project.version.nil? or @project.version.empty?
         raise Vanagon::Error, "Project requires a version set, all is lost."
       end
 
-      @engine.startup(workdir)
+      # if no_packaging has been set in the project, don't execute the
+      # whole makefile. Instead just perform the installation.
+      make_target = ''
+      if @project.no_packaging
+        make_target = @project.name + '-project'
+      end
 
+      @engine.startup(workdir)
       warn "Target is #{@engine.target}"
       Vanagon::Utilities.retry_with_timeout(retry_count, timeout) do
         install_build_dependencies
@@ -132,11 +138,12 @@ class Vanagon
 
       @project.make_makefile(workdir)
       @project.make_bill_of_materials(workdir)
-      @project.generate_packaging_artifacts(workdir)
+      # Don't generate packaging artifacts if no_packaging is set
+      @project.generate_packaging_artifacts(workdir) unless @project.no_packaging
       @project.save_manifest_json
       @engine.ship_workdir(workdir)
-      @engine.dispatch("(cd #{@engine.remote_workdir}; #{@platform.make})")
-      @engine.retrieve_built_artifact
+      @engine.dispatch("(cd #{@engine.remote_workdir}; #{@platform.make} #{make_target})")
+      @engine.retrieve_built_artifact(@project.artifacts_to_fetch, @project.no_packaging)
 
       if %i[never on-failure].include? @preserve
         @engine.teardown

data/lib/vanagon/engine/base.rb

@@ -73,9 +73,15 @@ class Vanagon
         Vanagon::Utilities.rsync_to("#{workdir}/*", "#{@target_user}@#{@target}", @remote_workdir, @platform.ssh_port)
       end
 
-      def retrieve_built_artifact
-        FileUtils.mkdir_p("output")
-        Vanagon::Utilities.rsync_from("#{@remote_workdir}/output/*", "#{@target_user}@#{@target}", "output/", @platform.ssh_port)
+      def retrieve_built_artifact(artifacts_to_fetch, no_packaging)
+        output_path = 'output/'
+        FileUtils.mkdir_p(output_path)
+        unless no_packaging
+          artifacts_to_fetch << "#{@remote_workdir}/output/*"
+        end
+        artifacts_to_fetch.each do |path|
+          Vanagon::Utilities.rsync_from(path, "#{@target_user}@#{@target}", output_path, @platform.ssh_port)
+        end
       end
 
       # Ensures that the platform defines the attributes that the engine needs to function.

data/lib/vanagon/project.rb

@@ -90,6 +90,17 @@ class Vanagon
     # Should we generate platform-specific packages (rpm, deb, dmg, msi, etc)
     attr_accessor :generate_packages
 
+    # Additional File(s) to retrieve from the system after the installation
+    # steps are all complete.
+    attr_accessor :artifacts_to_fetch
+
+    # Specify that the project should not perform the packaging steps in vanagon
+    # and instead just stop after installation.
+    #
+    # Useful alongside fetch_artifact when you don't need vanagon's packaging system and
+    # you just want to perform installation and pull down a file.
+    attr_accessor :no_packaging
+
     # Loads a given project from the configdir
     #
     # @param name [String] the name of the project
@@ -134,6 +145,8 @@ class Vanagon
       @source_artifacts = false
       @compiled_archive = false
       @generate_packages = true
+      @no_packaging = false
+      @artifacts_to_fetch = []
     end
 
     # Magic getter to retrieve settings in the project

data/lib/vanagon/project/dsl.rb

@@ -2,6 +2,7 @@ require 'vanagon/project'
 require 'vanagon/utilities'
 require 'vanagon/component/source'
 require 'set'
+require 'git/rev_list'
 
 class Vanagon
   class Project
@@ -171,6 +172,18 @@ class Vanagon
         @project.compiled_archive = archive
       end
 
+      # Sets the release for the project to the number of commits since the
+      # last tag. Requires that a git tag be present
+      # and reachable from the current commit in that repository.
+      #
+      def release_from_git
+        repo_object = Git.open(File.expand_path("..", Vanagon::Driver.configdir))
+        last_tag = repo_object.describe('HEAD', { :abbrev => 0 })
+        release(repo_object.rev_list("#{last_tag}..HEAD", { :count => true }))
+      rescue Git::GitExecuteError
+        warn "Directory '#{dirname}' cannot be versioned by git. Maybe it hasn't been tagged yet?"
+      end
+
       # Sets the version for the project based on a git describe of the
       # directory that holds the configs. Requires that a git tag be present
       # and reachable from the current commit in that repository.
@@ -317,6 +330,20 @@ class Vanagon
         platform = @project.platform
         platform.package_override(self._project, var)
       end
+
+      # Set additional artifacts to fetch from the build
+      #
+      # @param [String] path to artifact to fetch from builder
+      def fetch_artifact(path)
+        @project.artifacts_to_fetch << path
+      end
+
+      # Set to true to skip packaging steps during the vanagon build
+      #
+      # @param [Boolean] var whether or not execute packaging steps during build
+      def no_packaging(var)
+        @project.no_packaging = var
+      end
     end
   end
 end

data/spec/lib/git/rev_list_spec.rb

@@ -0,0 +1,26 @@
+require 'git/rev_list'
+include LibRevList
+
+describe 'Git::LibRevList' do
+  describe '#rev_list' do
+    it 'calls command' do
+      expect(LibRevList).to receive(:command).with('rev-list', [])
+      LibRevList.rev_list
+    end
+
+    it 'calls command with commitish' do
+      expect(LibRevList).to receive(:command).with('rev-list', ['HEAD'])
+      LibRevList.rev_list('HEAD')
+    end
+
+    it 'calls command with commitish and a boolean option' do
+      expect(LibRevList).to receive(:command).with('rev-list', ['--count', 'HEAD'])
+      LibRevList.rev_list('HEAD', { :count => true })
+    end
+
+    it 'calls command with commitish and an option that uses a param' do
+      expect(LibRevList).to receive(:command).with('rev-list', ['--max-age=200', 'HEAD'])
+      LibRevList.rev_list('HEAD', { :max_age => 200 })
+    end
+  end
+end

data/spec/lib/vanagon/component_spec.rb

@@ -102,6 +102,7 @@ describe "Vanagon::Component" do
       @workdir = Dir.mktmpdir
       @file_name = 'fake_file.txt'
       @fake_file = "file://spec/fixtures/files/#{@file_name}"
+      @fake_erb_file = "file://spec/fixtures/files/#{@file_name}.erb"
       @fake_dir = 'fake_dir'
       @fake_tar = "file://spec/fixtures/files/#{@fake_dir}.tar.gz"
     end
@@ -142,5 +143,54 @@ describe "Vanagon::Component" do
       expect(File.exist?(File.join(@workdir, "#{@fake_dir}.tar.gz"))).to be true
       expect(subject.extract_with.join(" && ")).to match "#{@fake_dir}.tar.gz"
     end
+
+    it "Performs an erb translation when erb: is true" do
+      # Initialize a new instance of Vanagon::Component and define a
+      # new secondary source that's *compressed*. We can now reason about
+      # this instance and test behavior for retrieving secondary sources.
+      plat = Vanagon::Platform::DSL.new('el-5-x86_64')
+      plat.instance_eval("platform 'el-5-x86_64' do |plat| end")
+      @platform = plat._platform
+
+      comp = Vanagon::Component::DSL.new('build-dir-test', {}, @platform)
+      comp.add_source  @fake_erb_file, erb: true
+      subject = comp._component
+
+      file_path = File.join(@workdir, File.basename(@fake_erb_file))
+      expect(subject).to receive(:erb_file).with(Pathname.new(file_path), file_path.gsub('.erb', ''), true)
+      subject.get_sources(@workdir)
+    end
+
+    it "Does not perform an erb transformation when erb: is false" do
+      # Initialize a new instance of Vanagon::Component and define a
+      # new secondary source that's *compressed*. We can now reason about
+      # this instance and test behavior for retrieving secondary sources.
+      plat = Vanagon::Platform::DSL.new('el-5-x86_64')
+      plat.instance_eval("platform 'el-5-x86_64' do |plat| end")
+      @platform = plat._platform
+
+      comp = Vanagon::Component::DSL.new('build-dir-test', {}, @platform)
+      comp.add_source  @fake_file, erb: false
+      subject = comp._component
+
+      expect(subject).to_not receive(:erb_file)
+      subject.get_sources(@workdir)
+    end
+
+    it "Does not perform an erb transformation when erb: is nil (not set)" do
+      # Initialize a new instance of Vanagon::Component and define a
+      # new secondary source that's *compressed*. We can now reason about
+      # this instance and test behavior for retrieving secondary sources.
+      plat = Vanagon::Platform::DSL.new('el-5-x86_64')
+      plat.instance_eval("platform 'el-5-x86_64' do |plat| end")
+      @platform = plat._platform
+
+      comp = Vanagon::Component::DSL.new('build-dir-test', {}, @platform)
+      comp.add_source  @fake_file
+      subject = comp._component
+
+      expect(subject).to_not receive(:erb_file)
+      subject.get_sources(@workdir)
+    end
   end
 end

data/spec/lib/vanagon/engine/base_spec.rb

@@ -37,4 +37,35 @@ describe 'Vanagon::Engine::Base' do
       expect(Vanagon::Engine::Base.new(platform).validate_platform).to be(true)
     end
   end
+
+  describe "#retrieve_built_artifact" do
+    it 'creates a new output dir' do
+      base = Vanagon::Engine::Base.new(platform)
+      allow(Vanagon::Utilities).to receive(:rsync_from)
+      expect(FileUtils).to receive(:mkdir_p)
+      base.retrieve_built_artifact([], false)
+    end
+
+    it 'rsync uses normal output dir when no_package param is false' do
+      base = Vanagon::Engine::Base.new(platform, 'abcd')
+      allow(FileUtils).to receive(:mkdir_p)
+      expect(Vanagon::Utilities).to receive(:rsync_from).with('/output/*', 'root@abcd', 'output/', 22)
+      base.retrieve_built_artifact([], false)
+    end
+
+    it 'rsync only contents of parameter if no_package is true' do
+      base = Vanagon::Engine::Base.new(platform, 'abcd')
+      allow(FileUtils).to receive(:mkdir_p)
+      expect(Vanagon::Utilities).to receive(:rsync_from).with('foo/bar/baz.file', 'root@abcd', 'output/', 22)
+      base.retrieve_built_artifact(['foo/bar/baz.file'], true)
+    end
+
+    it 'rsync only contents of parameter with multiple entries if no_package param is true' do
+      base = Vanagon::Engine::Base.new(platform, 'abcd')
+      allow(FileUtils).to receive(:mkdir_p)
+      expect(Vanagon::Utilities).to receive(:rsync_from).with('foo/bar/baz.file', 'root@abcd', 'output/', 22)
+      expect(Vanagon::Utilities).to receive(:rsync_from).with('foo/foobar/foobarbaz.file', 'root@abcd', 'output/', 22)
+      base.retrieve_built_artifact(['foo/bar/baz.file', 'foo/foobar/foobarbaz.file'], true)
+    end
+  end
 end

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

@@ -53,6 +53,35 @@ end" }
     end
   end
 
+  describe '#release_from_git' do
+    it 'sets the release based on commits since last tag' do
+      repo = double
+      tag = double
+      log = double
+      diff = double
+      expect(Vanagon::Driver).to receive(:configdir).and_return(configdir)
+      proj = Vanagon::Project::DSL.new('test-fixture', {})
+      proj.instance_eval(project_block)
+      repo = double("repo")
+      expect(::Git)
+        .to receive(:open)
+        .and_return(repo)
+
+
+      expect(repo)
+        .to receive(:describe)
+        .and_return('1.2.3')
+
+      expect(repo)
+        .to receive(:rev_list)
+        .with('1.2.3..HEAD', { :count => true })
+        .and_return('999')
+
+      proj.release_from_git
+      expect(proj._project.release).to eq('999')
+    end
+  end
+
   describe '#version_from_branch' do
     it 'parses out versions from branch names' do
       branches = {
@@ -517,4 +546,75 @@ end"
       expect(proj._project.components).to_not include(component)
     end
   end
+
+  describe "#fetch_artifact" do
+    let(:project_block) {
+      "project 'test-fixture' do |proj|
+        proj.fetch_artifact 'foo/bar/baz.file'
+      end"
+    }
+    let(:project_block_multiple) {
+      "project 'test-fixture' do |proj|
+        proj.fetch_artifact 'foo/bar/baz.file'
+        proj.fetch_artifact 'foo/foobar/foobarbaz.file'
+      end"
+    }
+    let(:empty_project_block) {
+      "project 'test-fixture' do |proj|
+      end"
+    }
+
+    it 'has an empty project.fetch_artifact when fetch_artifact is not called' do
+      proj = Vanagon::Project::DSL.new('test-fixture', {}, [])
+      proj.instance_eval(empty_project_block)
+      expect(proj._project.artifacts_to_fetch).to eq([])
+    end
+
+    it 'Adds a path to project.fetch_artifact when fetch_artifact is called' do
+      proj = Vanagon::Project::DSL.new('test-fixture', {}, [])
+      proj.instance_eval(project_block)
+      expect(proj._project.artifacts_to_fetch).to eq(['foo/bar/baz.file'])
+    end
+
+    it 'Adds multiple paths to project.fetch_artifact when fetch_artifact is called more than once' do
+      proj = Vanagon::Project::DSL.new('test-fixture', {}, [])
+      proj.instance_eval(project_block_multiple)
+      expect(proj._project.artifacts_to_fetch).to eq(['foo/bar/baz.file', 'foo/foobar/foobarbaz.file'])
+    end
+  end
+
+  describe "#no_packaging" do
+    let(:project_block) {
+      "project 'test-fixture' do |proj|
+        proj.no_packaging true
+      end"
+    }
+    let(:project_block_false) {
+      "project 'test-fixture' do |proj|
+        proj.no_packaging false
+      end"
+    }
+    let(:empty_project_block) {
+      "project 'test-fixture' do |proj|
+      end"
+    }
+
+    it 'has no_packaging set to false by default' do
+      proj = Vanagon::Project::DSL.new('test-fixture', {}, [])
+      proj.instance_eval(empty_project_block)
+      expect(proj._project.no_packaging).to eq(false)
+    end
+
+    it 'sets no_packaging to true when proj.no_packaging true is called' do
+      proj = Vanagon::Project::DSL.new('test-fixture', {}, [])
+      proj.instance_eval(project_block)
+      expect(proj._project.no_packaging).to eq(true)
+    end
+
+    it 'sets no_packaging to false when proj.no_packaging false is called' do
+      proj = Vanagon::Project::DSL.new('test-fixture', {}, [])
+      proj.instance_eval(project_block_false)
+      expect(proj._project.no_packaging).to eq(false)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vanagon
 version: !ruby/object:Gem::Version
-  version: 0.15.3
+  version: 0.15.4
 platform: ruby
 authors:
 - Puppet Labs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-06 00:00:00.000000000 Z
+date: 2018-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -88,6 +88,7 @@ files:
 - bin/repo
 - bin/ship
 - lib/git/basic_submodules.rb
+- lib/git/rev_list.rb
 - lib/makefile.rb
 - lib/vanagon.rb
 - lib/vanagon/common.rb
@@ -169,6 +170,7 @@ files:
 - spec/fixtures/files/fake_dir.tar.gz
 - spec/fixtures/files/fake_dir/fake_file.txt
 - spec/fixtures/files/fake_file.txt
+- spec/fixtures/files/fake_file.txt.erb
 - spec/fixtures/files/fake_file_ext.7z
 - spec/fixtures/files/fake_file_ext.bz
 - spec/fixtures/files/fake_file_ext.bz2
@@ -196,6 +198,7 @@ files:
 - spec/fixtures/wix/resources/windows/wix/project.wxs
 - spec/fixtures/wix/resources/windows/wix/ui/bitmaps/bitmap.bmp
 - spec/fixtures/wix/resources/windows/wix/ui/ui-sample-1.wxs
+- 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
@@ -296,3 +299,4 @@ test_files:
 - 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