vanagon 0.8.2 → 0.9.1

data/lib/vanagon/platform/dsl.rb

@@ -68,8 +68,8 @@ class Vanagon
       # We only magically handle get_ methods, any other methods just get the
       # standard method_missing treatment.
       #
-      def method_missing(method, *args)
-        attribute_match = method.to_s.match(/get_(.*)/)
+      def method_missing(method_name, *args)
+        attribute_match = method_name.to_s.match(/get_(.*)/)
         if attribute_match
           attribute = attribute_match.captures.first
         else
@@ -79,6 +79,10 @@ class Vanagon
         @platform.send(attribute)
       end
 
+      def respond_to_missing?(method_name, include_private = false)
+        method_name.to_s.start_with?('get_') || super
+      end
+
       # Set the path to make for the platform
       #
       # @param make_cmd [String] Full path to the make command for the platform
@@ -221,6 +225,13 @@ class Vanagon
         self.vmpooler_template(name)
       end
 
+      # Set the name of this platform as always-be-scheduling (ABS) expects it
+      #
+      # @param name [String] name of the platform to request from always-be-scheduling
+      def abs_resource_name(name)
+        @platform.abs_resource_name = name
+      end
+
       # Set the name of the docker image to use
       #
       # @param name [String] name of the docker image to use

data/lib/vanagon/project.rb

@@ -54,10 +54,15 @@ class Vanagon
     end
 
     # Magic getter to retrieve settings in the project
-    def method_missing(method, *args)
-      if @settings.key?(method)
-        return @settings[method]
+    def method_missing(method_name, *args)
+      if @settings.key?(method_name)
+        return @settings[method_name]
       end
+      super
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      @settings.key?(method_name) || super
     end
 
     # Collects all sources and patches into the provided workdir
@@ -82,6 +87,39 @@ class Vanagon
       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
+    # component with no build requirements
+    #
+    # @param name [String] name of component to add. must be present in configdir/components and named $name.rb currently
+    # @return [Array] array of Vanagon::Component including only those required to build "name", or [] if there are none
+    def filter_component(name)
+      filtered_component = get_component(name)
+      return [] if filtered_component.nil?
+      included_components = [filtered_component]
+
+      unless filtered_component.build_requires.empty?
+        filtered_component.build_requires.each do |build_requirement|
+          unless get_component(build_requirement).nil?
+            included_components += filter_component(build_requirement)
+          end
+        end
+      end
+      included_components.uniq
+    end
+
+    # Gets the component with component.name = "name" from the list
+    # of project.components
+    #
+    # @param [String] component name
+    # @return [Vanagon::Component] the component with component.name = "name"
+    def get_component(name)
+      comps = @components.select { |comp| comp.name.to_s == name.to_s }
+      raise "ERROR: two or more components with the same name: #{comps.first.name}" if comps.size > 1
+      comps.first
+    end
+
     # Collects all of the requires for both the project and its components
     #
     # @return [Array] array of runtime requirements for the project

data/lib/vanagon/project/dsl.rb

@@ -44,18 +44,23 @@ class Vanagon
       # We only magically handle get_ methods, any other methods just get the
       # standard method_missing treatment.
       #
-      def method_missing(method, *args)
-        attribute_match = method.to_s.match(/get_(.*)/)
+      def method_missing(method_name, *args)
+        attribute_match = method_name.to_s.match(/get_(.*)/)
         if attribute_match
           attribute = attribute_match.captures.first
           @project.send(attribute)
-        elsif @project.settings.key?(method)
-          return @project.settings[method]
+        elsif @project.settings.key?(method_name)
+          return @project.settings[method_name]
         else
           super
         end
       end
 
+      def respond_to_missing?(method_name, include_private = false)
+        method_name.to_s.start_with?('get_') || @project.settings.key?(method_name) || super
+      end
+
+
       # Sets a key value pair on the settings hash of the project
       #
       # @param name [String] name of the setting

data/lib/vanagon/utilities.rb

@@ -16,6 +16,7 @@ class Vanagon
 
     # Utility to get the md5 sum of a file
     #
+    # @deprecated Please use #get_sum instead, this will be removed in a future vanagon release.
     # @param file [String] file to md5sum
     # @return [String] md5sum of the given file
     def get_md5sum(file)
@@ -25,21 +26,17 @@ class Vanagon
     # Generic file summing utility
     #
     # @param file [String] file to sum
-    # @param type [String] type of sum to provide
+    # @param type [String] type of sum to provide, defaults to md5
     # @return [String] sum of the given file
     # @raise [RuntimeError] raises an exception if the given sum type is not supported
-    def get_sum(file, type)
-      case type.downcase
-      when 'md5'
-        Digest::MD5.file(file).hexdigest.to_s
-      when 'sha256'
-        Digest::SHA256.file(file).hexdigest.to_s
-      when 'sha512'
-        Digest::SHA512.file(file).hexdigest.to_s
-      else
-        fail "Don't know how to produce a sum of type: '#{type}' for '#{file}'."
-      end
-    end
+    def get_sum(file, type = 'md5')
+      Digest.const_get(type.upcase).file(file).hexdigest.to_s
+
+    # If Digest::const_get fails, it'll raise a LoadError when it tries to
+    # pull in the subclass `type`. We catch that error, and fail instead.
+     rescue LoadError
+       fail "Don't know how to produce a sum of type: '#{type}' for '#{file}'"
+     end
 
     # Simple wrapper around Net::HTTP. Will make a request of the given type to
     # the given url and return the body as parsed by JSON.

data/resources/Makefile.erb

@@ -36,7 +36,7 @@ file-list: file-list-before-build <%= @name %>-project
 <%- end -%>
 
 <%- if @bill_of_materials -%>
-<%= @bill_of_materials %>:
+<%= @bill_of_materials.path %>:
 	mkdir -p '<%= @bill_of_materials.path %>'
 	mv bill-of-materials '<%= @bill_of_materials.path %>'
 <%- end -%>

data/resources/rpm/project.spec.erb

@@ -48,6 +48,15 @@ Autoreq: 0
 <%- get_requires.each do |requires| -%>
 Requires:  <%= requires %>
 <%- end -%>
+# All rpm packages built by vanagon have the pre-/post-install script
+# boilerplates (defined below). These require `mkdir` and `touch` but previously
+# did not specify a dependency on these.
+# In the future, we will supress pre/post scripts completely if there's nothing
+# specified by the project or the components.
+Requires(pre): /bin/mkdir
+Requires(pre): /bin/touch
+Requires(post): /bin/mkdir
+Requires(post): /bin/touch
 <%- if has_services? -%>
   <%- if @platform.servicetype == "systemd" -%>
     <%- if @platform.is_sles? -%>

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

@@ -53,15 +53,64 @@ end" }
     plat._platform
   }
 
-
-
   let(:platform) { double(Vanagon::Platform) }
 
+  # These TOTALLY VALID sums are computed against a passage from
+  # "The Hitchhiker's Guide to the Galaxy", by Douglas Adams (1979).
+  # Specifically, about humans assuming they are smarter than dolphins
+  # for exactly the same reason dolphins assume they are smart than
+  # humans. This seemed appropriate after the checksum refactoring
+  # broke all checksums and we discovered that they were untested.
+  let(:dummy_md5_sum) { "08b55473b59d2b43af8b61c9512ef5c6" }
+  let(:dummy_sha1_sum) { "fdaa03c3f506d7b71635f2c32dfd41b0cc8b904f" }
+  let(:dummy_sha256_sum) { "fd9c922702eb2e2fb26376c959753f0fc167bb6bc99c79262fcff7bcc8b34be1" }
+  let(:dummy_sha512_sum) { "8feda1e9896be618dd6c65120d10afafce93888df8569c598f52285083c23befd1477da5741939d4eae042f822e45ca2e45d8d4d18cf9224b7acaf71d883841e" }
+
   before do
     allow(platform).to receive(:install).and_return('install')
     allow(platform).to receive(:copy).and_return('cp')
   end
 
+  describe "#md5sum" do
+    it "sets a checksum value & type correctly" do
+      comp = Vanagon::Component::DSL.new('test-fixture', {}, {})
+      comp.md5sum(dummy_md5_sum)
+
+      expect(comp._component.options[:sum]).to eq(dummy_md5_sum)
+      expect(comp._component.options[:sum_type]).to eq('md5')
+    end
+  end
+
+  describe "#sha1sum" do
+    it "sets a checksum value & type correctly" do
+      comp = Vanagon::Component::DSL.new('test-fixture', {}, {})
+      comp.sha1sum(dummy_sha1_sum)
+
+      expect(comp._component.options[:sum]).to eq(dummy_sha1_sum)
+      expect(comp._component.options[:sum_type]).to eq('sha1')
+    end
+  end
+
+  describe "#sha256sum" do
+    it "sets a checksum value & type correctly" do
+      comp = Vanagon::Component::DSL.new('test-fixture', {}, {})
+      comp.sha256sum(dummy_sha256_sum)
+
+      expect(comp._component.options[:sum]).to eq(dummy_sha256_sum)
+      expect(comp._component.options[:sum_type]).to eq('sha256')
+    end
+  end
+
+  describe "#sha512sum" do
+    it "sets a checksum value & type correctly" do
+      comp = Vanagon::Component::DSL.new('test-fixture', {}, {})
+      comp.sha512sum(dummy_sha512_sum)
+
+      expect(comp._component.options[:sum]).to eq(dummy_sha512_sum)
+      expect(comp._component.options[:sum_type]).to eq('sha512')
+    end
+  end
+
   describe '#load_from_json' do
     it "sets the ref and url based on the json fixture" do
       comp = Vanagon::Component::DSL.new('test-fixture', {}, {})

data/spec/lib/vanagon/component/source/git_spec.rb

@@ -32,6 +32,14 @@ describe "Vanagon::Component::Source::Git" do
     end
   end
 
+  describe "#ref" do
+    it "returns a default value of HEAD when no explicit Git reference is provided" do
+      git_source = klass.new(url, workdir: workdir)
+      expect(git_source.ref)
+        .to eq('HEAD')
+    end
+  end
+
   describe "#fetch" do
     it "raises an error on checkout failure with a bad SHA" do
       expect { klass.new("#{url}", ref: bad_sha, workdir: workdir).fetch }

data/spec/lib/vanagon/component/source/http_spec.rb

@@ -12,7 +12,14 @@ describe "Vanagon::Component::Source::Http" do
   let (:md5sum) { 'abcdssasasa' }
   let (:sha256sum) { 'foobarbaz' }
   let (:sha512sum) { 'teststring' }
-  let (:workdir) { "/tmp" }
+  let (:workdir) { Dir.mktmpdir }
+
+  describe "#initialize" do
+    it "fails with a bad sum_type" do
+      expect { Vanagon::Component::Source::Http.new(plaintext_url, sum: md5sum, workdir: workdir, sum_type: "md4") }
+        .to raise_error(RuntimeError)
+    end
+  end
 
   describe "#dirname" do
     it "returns the name of the tarball, minus extension for archives" do
@@ -30,17 +37,10 @@ describe "Vanagon::Component::Source::Http" do
     end
   end
 
-  describe "verify" do
-    it "fails with a bad sum_type" do
-      http_source = Vanagon::Component::Source::Http.new(plaintext_url, sum: md5sum, workdir: workdir, sum_type: "md4")
-      expect(http_source).to receive(:download).and_return(plaintext_filename)
-      http_source.fetch
-      expect{ http_source.verify }.to raise_error(RuntimeError)
-    end
-
+  describe "#verify" do
     it "calls md5 digest when it's supposed to" do
-      Digest::MD5.any_instance.stub(:file).and_return(Digest::MD5.new)
-      Digest::MD5.any_instance.stub(:hexdigest).and_return(md5sum)
+      allow_any_instance_of(Digest::MD5).to receive(:file).and_return(Digest::MD5.new)
+      allow_any_instance_of(Digest::MD5).to receive(:hexdigest).and_return(md5sum)
       http_source = Vanagon::Component::Source::Http.new(plaintext_url, sum: md5sum, workdir: workdir, sum_type: "md5")
       expect(http_source).to receive(:download).and_return(plaintext_filename)
       http_source.fetch
@@ -48,8 +48,8 @@ describe "Vanagon::Component::Source::Http" do
     end
 
     it "calls sha256 digest when it's supposed to" do
-      Digest::SHA256.any_instance.stub(:file).and_return(Digest::SHA256.new)
-      Digest::SHA256.any_instance.stub(:hexdigest).and_return(sha256sum)
+      allow_any_instance_of(Digest::SHA256).to receive(:file).and_return(Digest::SHA256.new)
+      allow_any_instance_of(Digest::SHA256).to receive(:hexdigest).and_return(sha256sum)
       http_source = Vanagon::Component::Source::Http.new(plaintext_url, sum: sha256sum, workdir: workdir, sum_type: "sha256")
       expect(http_source).to receive(:download).and_return(plaintext_filename)
       http_source.fetch
@@ -57,8 +57,8 @@ describe "Vanagon::Component::Source::Http" do
     end
 
     it "calls sha512 digest when it's supposed to" do
-      Digest::SHA512.any_instance.stub(:file).and_return(Digest::SHA512.new)
-      Digest::SHA512.any_instance.stub(:hexdigest).and_return(sha512sum)
+      allow_any_instance_of(Digest::SHA512).to receive(:file).and_return(Digest::SHA512.new)
+      allow_any_instance_of(Digest::SHA512).to receive(:hexdigest).and_return(sha512sum)
       http_source = Vanagon::Component::Source::Http.new(plaintext_url, sum: sha512sum, workdir: workdir, sum_type: "sha512")
       expect(http_source).to receive(:download).and_return(plaintext_filename)
       http_source.fetch

data/spec/lib/vanagon/component/source/local_spec.rb

@@ -4,7 +4,9 @@ describe "Vanagon::Component::Source::File" do
   let (:file_base) { 'file://spec/fixtures/files/fake_file_ext' }
   let (:tar_filename) { 'file://spec/fixtures/files/fake_dir.tar.gz' }
   let (:plaintext_filename) { 'file://spec/fixtures/files/fake_file.txt' }
-  let (:workdir) { "/tmp" }
+  let (:workdir) { Dir.mktmpdir }
+  let (:simple_directory) { 'file://spec/fixtures/files/fake_dir/' }
+  let (:nested_directory) { 'file://spec/fixtures/files/fake_nested_dir/' }
 
   describe "#fetch" do
     it "puts the source file in to the workdir" do
@@ -12,6 +14,18 @@ describe "Vanagon::Component::Source::File" do
       file.fetch
       expect(File).to exist("#{workdir}/fake_file.txt")
     end
+
+    it "puts the source directory in to the workdir" do
+      file = Vanagon::Component::Source::Local.new(simple_directory, workdir: workdir)
+      file.fetch
+      expect(File).to exist("#{workdir}/fake_dir/fake_file.txt")
+    end
+
+    it "preserves nested directories when copying folders" do
+      file = Vanagon::Component::Source::Local.new(nested_directory, workdir: workdir)
+      file.fetch
+      expect(File).to exist("#{workdir}/fake_nested_dir/fake_dir/fake_file.txt")
+    end
   end
 
   describe "#dirname" do
@@ -20,7 +34,9 @@ describe "Vanagon::Component::Source::File" do
       file.fetch
       expect(file.dirname).to eq("fake_dir")
     end
+  end
 
+  describe "#ref" do
     it "returns the current directory for non-archive files" do
       file = Vanagon::Component::Source::Local.new(plaintext_filename, workdir: workdir)
       file.fetch

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

@@ -21,7 +21,7 @@ describe "Vanagon::Component::Source" do
 
     let(:ref) { "cafebeef" }
     let(:sum) { "abcd1234" }
-    let(:workdir) { "/tmp" }
+    let(:workdir) { Dir.mktmpdir }
 
     let(:original_git_url) { "git://things.and.stuff/foo-bar.git" }
     let(:rewritten_git_url) { "git://things.end.stuff/foo-ber.git" }

data/spec/lib/vanagon/driver_spec.rb

@@ -54,6 +54,39 @@ describe 'Vanagon::Driver' do
                               'engine' => 'hardware' })
     end
 
+    it 'returns the first build_host using the hardware engine when not using an engine, and not specifying an engine in the platform configuration' do
+      platform = eval_platform('aix-7.1-ppc', <<-END)
+        platform 'aix-7.1-ppc' do |plat|
+          plat.build_host ["pe-aix-71-01", "pe-aix-71-02"]
+        end
+      END
+
+      info = create_driver(platform).build_host_info
+
+      expect(info).to match({ 'name'   => 'pe-aix-71-01',
+                              'engine' => 'hardware' })
+    end
+
+    it 'returns the platform and the always_be_scheduling engine when using the always_be_scheduling engine' do
+      platform = eval_platform('aix-7.1-ppc', <<-END)
+        platform 'aix-7.1-ppc' do |plat|
+          plat.build_host ["pe-aix-71-01", "pe-aix-71-02"]
+        end
+      END
+
+      info = create_driver(platform, :engine => 'always_be_scheduling').build_host_info
+
+      expect(info).to match({ 'name'   => 'aix-7.1-ppc',
+                              'engine' => 'always_be_scheduling' })
+    end
+
+    it 'returns the vmpooler_template using the always_be_scheduling engine when using the always_be_scheduling engine' do
+      info = create_driver(redhat, :engine => 'always_be_scheduling').build_host_info
+
+      expect(info).to match({ 'name'   => 'centos-7-x86_64',
+                              'engine' => 'always_be_scheduling' })
+    end
+
     it 'returns the docker_image using the docker engine' do
       platform = eval_platform('el-7-x86_64', <<-END)
         platform 'el-7-x86_64' do |plat|
@@ -85,4 +118,3 @@ describe 'Vanagon::Driver' do
     end
   end
 end
-

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

@@ -0,0 +1,84 @@
+require 'vanagon/engine/always_be_scheduling'
+require 'vanagon/driver'
+require 'vanagon/platform'
+require 'logger'
+
+class Vanagon
+  class Driver
+    @@logger = Logger.new('/dev/null')
+  end
+end
+
+describe 'Vanagon::Engine::AlwaysBeScheduling' do
+  let (:platform) {
+    plat = Vanagon::Platform::DSL.new('aix-6.1-ppc')
+    plat.instance_eval("platform 'aix-6.1-ppc' do |plat|
+                      plat.build_host 'abcd'
+                    end")
+    plat._platform
+  }
+
+  let (:platform_with_vmpooler_template) {
+    plat = Vanagon::Platform::DSL.new('ubuntu-10.04-amd64 ')
+    plat.instance_eval("platform 'aix-6.1-ppc' do |plat|
+                      plat.build_host 'abcd'
+                      plat.vmpooler_template 'ubuntu-1004-amd64'
+                    end")
+    plat._platform
+  }
+
+  let (:platform_with_abs_resource_name) {
+    plat = Vanagon::Platform::DSL.new('aix-6.1-ppc')
+    plat.instance_eval("platform 'aix-6.1-ppc' do |plat|
+                      plat.build_host 'abcd'
+                      plat.abs_resource_name 'aix-61-ppc'
+                    end")
+    plat._platform
+  }
+
+  let (:platform_with_both) {
+    plat = Vanagon::Platform::DSL.new('aix-6.1-ppc')
+    plat.instance_eval("platform 'aix-6.1-ppc' do |plat|
+                      plat.build_host 'abcd'
+                      plat.vmpooler_template 'aix-six-one-ppc'
+                      plat.abs_resource_name 'aix-61-ppc'
+                    end")
+    plat._platform
+  }
+
+  describe '#validate_platform' do
+    it 'returns true if the platform has the required attributes' do
+      expect(Vanagon::Engine::AlwaysBeScheduling.new(platform, nil).validate_platform)
+        .to be(true)
+    end
+  end
+
+  describe '#build_host_name' do
+    it 'by default returns the platform name with no translation' do
+      expect(Vanagon::Engine::AlwaysBeScheduling.new(platform, nil).build_host_name)
+        .to eq("aix-6.1-ppc")
+    end
+
+    it 'returns vmpooler_template if vmpooler_template is specified' do
+      expect(Vanagon::Engine::AlwaysBeScheduling.new(platform_with_vmpooler_template, nil).build_host_name)
+        .to eq("ubuntu-1004-amd64")
+    end
+
+    it 'returns abs_resource_name if abs_resource_name is specified' do
+      expect(Vanagon::Engine::AlwaysBeScheduling.new(platform_with_abs_resource_name, nil).build_host_name)
+        .to eq("aix-61-ppc")
+    end
+
+    it 'prefers abs_resource_name to vmpooler_template if both are specified' do
+      expect(Vanagon::Engine::AlwaysBeScheduling.new(platform_with_both, nil).build_host_name)
+        .to eq("aix-61-ppc")
+    end
+  end
+
+  describe '#name' do
+    it 'returns "always_be_scheduling" engine name' do
+      expect(Vanagon::Engine::AlwaysBeScheduling.new(platform, nil).name)
+        .to eq('always_be_scheduling')
+    end
+  end
+end