vanagon 0.3.19 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 209125a16053b5957e7a0803765857938e3c9c3b
-  data.tar.gz: 96431964ee62b54f27e24b5991d617be07b9e46e
+  metadata.gz: 8e9188b407a2cea5a4ad1beaa844e0f18abaa5da
+  data.tar.gz: 2f867ac9b05096dd35ce45d571af099faf0acc87
 SHA512:
-  metadata.gz: 226ac385d96501d28837424a734aaa30e5ae374600c584cc5de76de22baef59b15ed4cd43f345f25abd1bef91fd1035dea7c2764ed8840bb81eab16189901aa7
-  data.tar.gz: 4f4a9ff1c9a35dc4bd7fb3f6fd7636ebb581409851b5321810e8994541ed9535a4b2c75b9be984a3079d9b1be1caed5b1d7f9070e6679bc0cba5adb269bc4ce4
+  metadata.gz: c174fd00eb54d11bc40446b627c4cfaedfa1930b2d6c5a7edeb2a08148ca8e68abb63ad1d1b390fe940a221f37423128e21fb305a7c6f5d192bfef3f1a2e7109
+  data.tar.gz: ffd5a859ee33018f5b1fbb7e7d587681290a9eee4271c1ec5020936b0d0dfa91c5441e77ad8d53b4179d603cf1e7e01b8a3f777cf59347c1fae33ac08000fcdd

data/lib/vanagon/component.rb

@@ -11,6 +11,7 @@ class Vanagon
     attr_accessor :settings, :platform, :patches, :requires, :service, :options
     attr_accessor :directories, :replaces, :provides, :cleanup_source, :environment
     attr_accessor :sources, :preinstall_actions, :postinstall_actions
+    attr_accessor :preremove_actions, :postremove_actions
 
     # Loads a given component from the configdir
     #
@@ -58,6 +59,8 @@ class Vanagon
       @sources = []
       @preinstall_actions = []
       @postinstall_actions = []
+      @preremove_actions = []
+      @postremove_actions = []
     end
 
     # Adds the given file to the list of files and returns @files.

data/lib/vanagon/component/dsl.rb

@@ -232,6 +232,7 @@ class Vanagon
       def link(source, target)
         @component.install << "#{@component.platform.install} -d '#{File.dirname(target)}'"
         @component.install << "ln -s '#{source}' '#{target}'"
+        @component.add_file Vanagon::Common::Pathname.file(target)
       end
 
       # Sets the version for the component
@@ -289,18 +290,64 @@ class Vanagon
         @component.environment.merge!(env)
       end
 
-      # Adds actions to run at the beginning of a package install
+      # Adds action to run during the preinstall phase of packaging
       #
-      # @param action [String] Bourne shell compatible scriptlets to execute
-      def add_preinstall_action(action)
-        @component.preinstall_actions << action
+      # @param pkg_state [Array] the state in which the scripts should execute. Can be
+      #   one or multiple of 'install' and 'upgrade'.
+      # @param scripts [Array] the Bourne shell compatible scriptlet(s) to execute
+      def add_preinstall_action(pkg_state, scripts)
+        pkg_state = Array(pkg_state)
+        scripts = Array(scripts)
+
+        if pkg_state.empty? || !(pkg_state - ["install", "upgrade"]).empty?
+          raise Vanagon::Error, "#{pkg_state} should be an array containing one or more of ['install', 'upgrade']"
+        end
+        @component.preinstall_actions << OpenStruct.new(:pkg_state => pkg_state, :scripts => scripts)
+      end
+
+      # Adds action to run during the postinstall phase of packaging
+      #
+      # @param pkg_state [Array] the state in which the scripts should execute. Can be
+      #   one or multiple of 'install' and 'upgrade'.
+      # @param scripts [Array] the Bourne shell compatible scriptlet(s) to execute
+      def add_postinstall_action(pkg_state, scripts)
+        pkg_state = Array(pkg_state)
+        scripts = Array(scripts)
+
+        if pkg_state.empty? || !(pkg_state - ["install", "upgrade"]).empty?
+          raise Vanagon::Error, "#{pkg_state} should be an array containing one or more of ['install', 'upgrade']"
+        end
+        @component.postinstall_actions << OpenStruct.new(:pkg_state => pkg_state, :scripts => scripts)
       end
 
-      # Adds actions to run at the end of a package install
+      # Adds action to run during the preremoval phase of packaging
       #
-      # @param action [String] Bourne shell compatible scriptlets to execute
-      def add_postinstall_action(action)
-        @component.postinstall_actions << action
+      # @param pkg_state [Array] the state in which the scripts should execute. Can be
+      #   one or multiple of 'removal' and 'upgrade'.
+      # @param scripts [Array] the Bourne shell compatible scriptlet(s) to execute
+      def add_preremove_action(pkg_state, scripts)
+        pkg_state = Array(pkg_state)
+        scripts = Array(scripts)
+
+        if pkg_state.empty? || !(pkg_state - ["upgrade", "removal"]).empty?
+          raise Vanagon::Error, "#{pkg_state} should be an array containing one or more of ['removal', 'upgrade']"
+        end
+        @component.preremove_actions << OpenStruct.new(:pkg_state => pkg_state, :scripts => scripts)
+      end
+
+      # Adds action to run during the postremoval phase of packaging
+      #
+      # @param pkg_state [Array] the state in which the scripts should execute. Can be
+      #   one or multiple of 'removal' and 'upgrade'.
+      # @param scripts [Array] the Bourne shell compatible scriptlet(s) to execute
+      def add_postremove_action(pkg_state, scripts)
+        pkg_state = Array(pkg_state)
+        scripts = Array(scripts)
+
+        if pkg_state.empty? || !(pkg_state - ["upgrade", "removal"]).empty?
+          raise Vanagon::Error, "#{pkg_state} should be an array containing one or more of ['removal', 'upgrade']"
+        end
+        @component.postremove_actions << OpenStruct.new(:pkg_state => pkg_state, :scripts => scripts)
       end
     end
   end

data/lib/vanagon/component/source.rb

@@ -21,21 +21,33 @@ class Vanagon
 
       def self.rewrite(url, protocol)
         rule = @@rewrite_rule[protocol]
+
         if rule
-          if rule.is_a?(Proc) and rule.arity == 1
-            return rule.call(url)
+          if rule.is_a?(Proc)
+            return proc_rewrite(rule, url)
           elsif rule.is_a?(String)
-            target_match = url.match(/.*\/([^\/]*)$/)
-            if target_match
-              target = target_match[1]
-              return File.join(rule, target)
-            else
-              raise Vanagon::Error, "Unable to apply url rewrite to '#{url}', expected to find at least one '/' in the url."
-            end
-          else
+            return string_rewrite(rule, url)
           end
+        end
+
+        return url
+      end
+
+      def self.proc_rewrite(rule, url)
+        if rule.arity == 1
+          rule.call(url)
+        else
+          raise Vanagon::Error, "Unable to use provided rewrite rule. Expected Proc with one argument, Proc has #{rule.arity} arguments"
+        end
+      end
+
+      def self.string_rewrite(rule, url)
+        target_match = url.match(/.*\/([^\/]*)$/)
+        if target_match
+          target = target_match[1]
+          return File.join(rule, target)
         else
-          return url
+          raise Vanagon::Error, "Unable to apply url rewrite to '#{url}', expected to find at least one '/' in the url."
         end
       end
 

data/lib/vanagon/component/source/http.rb

@@ -13,7 +13,7 @@ class Vanagon
         ARCHIVE_EXTENSIONS = '.tar.gz', '.tgz'
 
         # Extensions for files we aren't going to unpack during the build
-        NON_ARCHIVE_EXTENSIONS = '.gem', '.ru', '.txt', '.conf', '.ini', '.gpg', '.rb', '.sh', '.csh'
+        NON_ARCHIVE_EXTENSIONS = '.gem', '.ru', '.txt', '.conf', '.ini', '.gpg', '.rb', '.sh', '.csh', '.xml'
 
         # Constructor for the Http source type
         #

data/lib/vanagon/engine/pooler.rb

@@ -37,7 +37,7 @@ class Vanagon
           '{"' + @platform.vmpooler_template + '":"1"}',
           { 'X-AUTH-TOKEN' => @token }
         )
-        if response and response["ok"]
+        if response["ok"]
           @target = response[@platform.vmpooler_template]['hostname'] + '.' + response['domain']
           Vanagon::Driver.logger.info "Reserving #{@target} (#{@platform.vmpooler_template}) [#{@token ? 'token used' : 'no token used'}]"
 
@@ -49,7 +49,7 @@ class Vanagon
             }
           }
 
-          response_tag = Vanagon::Utilities.http_request(
+          Vanagon::Utilities.http_request(
             "#{@pooler}/vm/#{response[@platform.vmpooler_template]['hostname']}",
             'PUT',
             tags.to_json,

data/lib/vanagon/platform.rb

@@ -146,7 +146,7 @@ class Vanagon
     # @return [true, false] true if it is a redhat variety or uses rpm
     # under the hood, false otherwise
     def is_rpm?
-      return !!@name.match(/^(aix|cisco-wrlinux|el|eos|fedora|huaweios|nxos|sles)-.*$/)
+      return !!@name.match(/^(aix|cisco-wrlinux|el|eos|fedora|huaweios|sles)-.*$/)
     end
 
     # Utility matcher to determine is the platform is an enterprise linux variety
@@ -191,13 +191,6 @@ class Vanagon
       return !!@name.match(/^huaweios-.*$/)
     end
 
-    # Utility matcher to determine is the platform is an nxos variety
-    #
-    # @return [true, false] true if it is an nxos variety, false otherwise
-    def is_nxos?
-      return !!@name.match(/^nxos-.*$/)
-    end
-
     # Utility matcher to determine is the platform is a cisco-wrlinux
     # variety
     #

data/lib/vanagon/platform/deb.rb

@@ -28,7 +28,7 @@ class Vanagon
         FileUtils.mkdir_p(deb_dir)
 
         # Lots of templates here
-        ["changelog", "conffiles", "control", "docs", "dirs", "install", "postinst", "postrm", "prerm", "rules"].each do |deb_file|
+        ["changelog", "conffiles", "control", "docs", "dirs", "install", "preinst", "postinst", "postrm", "prerm", "rules"].each do |deb_file|
           erb_file(File.join(VANAGON_ROOT, "templates/deb/#{deb_file}.erb"), File.join(deb_dir, deb_file), false, { :binding => binding })
         end
 
@@ -54,6 +54,53 @@ class Vanagon
         File.join("deb", @codename, target_repo)
       end
 
+      # Returns the string to add a target repo to the platforms' provisioning
+      #
+      # @param definition [URI] A URI to a deb or list file
+      # @return [String] The command to add the repo target to the system
+      def add_repo_target(definition)
+        if File.extname(definition.path) == '.deb'
+          # repo definition is an deb (like puppetlabs-release)
+          "curl -o local.deb '#{definition}' && dpkg -i local.deb; rm -f local.deb"
+        else
+          reponame = "#{SecureRandom.hex}-#{File.basename(definition.path)}"
+          reponame = "#{reponame}.list" if File.extname(reponame) != '.list'
+          "curl -o '/etc/apt/sources.list.d/#{reponame}' '#{definition}'"
+        end
+      end
+
+      # Returns the string to add a gpg key to the platforms' provisioning
+      #
+      # @param gpg_key [URI] A URI to the gpg key
+      # @return [String] The command to add the gpg key to the system
+      def add_gpg_key(gpg_key)
+        gpgname = "#{SecureRandom.hex}-#{File.basename(gpg_key.path)}"
+        gpgname = "#{gpgname}.gpg" if gpgname !~ /\.gpg$/
+        "curl -o '/etc/apt/trusted.gpg.d/#{gpgname}' '#{gpg_key}'"
+      end
+
+      # Returns the commands to add a given repo target and optionally a gpg key to the build system
+      #
+      # @param definition [String] URI to the repo (.deb or .list)
+      # @param gpg_key [String, nil] URI to a gpg key for the repo
+      def add_repository(definition, gpg_key = nil)
+        # i.e., definition = http://builds.delivery.puppetlabs.net/puppet-agent/0.2.1/repo_configs/deb/pl-puppet-agent-0.2.1-wheezy.list
+        # parse the definition and gpg_key if set to ensure they are both valid URIs
+        definition = URI.parse(definition)
+        gpg_key = URI.parse(gpg_key) if gpg_key
+        provisioning = ["apt-get -qq update && apt-get -qq install curl"]
+
+        if definition.scheme =~ /^(http|ftp)/
+          provisioning << add_repo_target(definition)
+        end
+
+        if gpg_key
+          provisioning << add_gpg_key(gpg_key)
+        end
+
+        provisioning << "apt-get -qq update"
+      end
+
       # Constructor. Sets up some defaults for the debian platform and calls the parent constructor
       #
       # @param name [String] name of the platform

data/lib/vanagon/platform/dsl.rb

@@ -1,5 +1,7 @@
 require 'vanagon/platform/deb'
 require 'vanagon/platform/rpm'
+require 'vanagon/platform/rpm/aix'
+require 'vanagon/platform/rpm/sles'
 require 'vanagon/platform/rpm/wrl'
 require 'vanagon/platform/swix'
 require 'vanagon/platform/osx'
@@ -25,8 +27,12 @@ class Vanagon
       # @param block [Proc] DSL definition of the platform to call
       def platform(name, &block)
         @platform = case name
-                    when /^(aix|cisco-wrlinux|el|fedora|nxos|sles)-/
+                    when /^aix-/
+                      Vanagon::Platform::RPM::AIX.new(@name)
+                    when /^(cisco-wrlinux|el|fedora)-/
                       Vanagon::Platform::RPM.new(@name)
+                    when /^sles-/
+                      Vanagon::Platform::RPM::SLES.new(@name)
                     when /^huaweios-/
                       Vanagon::Platform::RPM::WRL.new(@name)
                     when /^(cumulus|debian|ubuntu)-/
@@ -118,6 +124,7 @@ class Vanagon
       # @param command [String] Command to enable the target machine to build packages for the platform
       def provision_with(command)
         @platform.provisioning << command
+        @platform.provisioning.flatten!
       end
 
       # Set the command to install any needed build dependencies for the target machine
@@ -198,83 +205,28 @@ class Vanagon
       #
       # @param definition [String] the repo setup file, must be a valid uri, fetched with curl
       # @param gpg_key [String] optional gpg key to be fetched via curl and installed
+      # @deprecated Please use the add_build_repository DSL method instead. apt_repo will be removed in a future vanagon release.
       def apt_repo(definition, gpg_key = nil)
-        # i.e., definition = http://builds.delivery.puppetlabs.net/puppet-agent/0.2.1/repo_configs/deb/pl-puppet-agent-0.2.1-wheezy.list
-        # parse the definition and gpg_key if set to ensure they are both valid URIs
-        definition = URI.parse definition
-        gpg_key = URI.parse gpg_key if gpg_key
-
-        self.provision_with "apt-get -qq update && apt-get -qq install curl"
-        if definition.scheme =~ /^(http|ftp)/
-          if File.extname(definition.path) == '.deb'
-            # repo definition is an deb (like puppetlabs-release)
-            self.provision_with "curl -o local.deb '#{definition}' && dpkg -i local.deb; rm -f local.deb"
-          else
-            reponame = "#{SecureRandom.hex}-#{File.basename(definition.path)}"
-            reponame = "#{reponame}.list" if File.extname(reponame) != '.list'
-            self.provision_with "curl -o '/etc/apt/sources.list.d/#{reponame}' '#{definition}'"
-          end
-        end
-
-        if gpg_key
-          gpgname = "#{SecureRandom.hex}-#{File.basename(gpg_key.path)}"
-          gpgname = "#{gpgname}.gpg" if gpgname !~ /\.gpg$/
-          self.provision_with "curl -o '/etc/apt/trusted.gpg.d/#{gpgname}' '#{gpg_key}'"
-        end
-
-        self.provision_with "apt-get -qq update"
+        warn "Please use the add_build_repository DSL method instead. apt_repo will be removed in a future vanagon release."
+        self.add_build_repository(definition, gpg_key)
       end
 
       # Helper to setup a yum repository on a target system
       #
       # @param definition [String] the repo setup URI or RPM file
+      # @deprecated Please use the add_build_repository DSL method instead. yum_repo will be removed in a future vanagon release.
       def yum_repo(definition)
-        definition = URI.parse definition
-
-        self.provision_with "rpm -q curl > /dev/null || yum -y install curl"
-        if definition.scheme =~ /^(http|ftp)/
-          if File.extname(definition.path) == '.rpm'
-            # repo definition is an rpm (like puppetlabs-release)
-            if @platform.os_version.to_i < 6
-              # This can likely be done with just rpm itself (minus curl) however
-              # with a http_proxy curl has many more options avavailable for
-              # usage than rpm raw does. So for the most compatibility, we have
-              # chosen curl.
-              self.provision_with "curl -o local.rpm '#{definition}'; rpm -Uvh local.rpm; rm -f local.rpm"
-            else
-              self.provision_with "yum localinstall -y '#{definition}'"
-            end
-          else
-            reponame = "#{SecureRandom.hex}-#{File.basename(definition.path)}"
-            reponame = "#{reponame}.repo"  if File.extname(reponame) != '.repo'
-            if @platform.is_nxos? or @platform.is_cisco_wrlinux?
-              self.provision_with "curl -o '/etc/yum/repos.d/#{reponame}' '#{definition}'"
-            else
-              self.provision_with "curl -o '/etc/yum.repos.d/#{reponame}' '#{definition}'"
-            end
-          end
-        end
+        warn "Please use the add_build_repository DSL method instead. yum_repo will be removed in a future vanagon release."
+        self.add_build_repository(definition)
       end
 
       # Helper to setup a zypper repository on a target system
       #
       # @param definition [String] the repo setup URI or RPM file
+      # @deprecated Please use the add_build_repository DSL method instead. zypper_repo will be removed in a future vanagon release.
       def zypper_repo(definition)
-        definition = URI.parse definition
-        if @platform.os_version == '10'
-          flag = 'sa'
-        else
-          flag = 'ar'
-        end
-        self.provision_with "yes | zypper -n --no-gpg-checks install curl"
-        if definition.scheme =~ /^(http|ftp)/
-          if File.extname(definition.path) == '.rpm'
-            # repo definition is an rpm (like puppetlabs-release)
-            self.provision_with "curl -o local.rpm '#{definition}'; rpm -Uvh local.rpm; rm -f local.rpm"
-          else
-            self.provision_with "yes | zypper -n --no-gpg-checks #{flag} -t YUM --repo '#{definition}'"
-          end
-        end
+        warn "Please use the add_build_repository DSL method instead. zypper_repo will be removed in a future vanagon release."
+        self.add_build_repository(definition)
       end
 
       # Generic adder for build repositories

data/lib/vanagon/platform/osx.rb

@@ -7,6 +7,21 @@ class Vanagon
       # @return [Array] list of commands required to build a osx package for the given project from a tarball
       def generate_package(project)
         target_dir = project.repo ? output_dir(project.repo) : output_dir
+
+        # Here we maintain backward compatibility with older vanagon versions
+        # that did this by default.  This shim should get removed at some point
+        # in favor of just letting the makefile deliver the bill-of-materials
+        # to the correct directory. This shouldn't be required at all then.
+        if project.bill_of_materials.nil?
+          bom_install = [# Move bill-of-materials into a docdir
+           "mkdir -p $(tempdir)/osx/build/root/#{project.name}-#{project.version}/usr/local/share/doc/#{project.name}",
+           "mv $(tempdir)/osx/build/root/#{project.name}-#{project.version}/bill-of-materials $(tempdir)/osx/build/root/#{project.name}-#{project.version}/usr/local/share/doc/#{project.name}/bill-of-materials",]
+
+        else
+          bom_install = []
+        end
+
+
          # Setup build directories
         ["bash -c 'mkdir -p $(tempdir)/osx/build/{dmg,pkg,scripts,resources,root,payload,plugins}'",
          "mkdir -p $(tempdir)/osx/build/root/#{project.name}-#{project.version}",
@@ -17,9 +32,7 @@ class Vanagon
          # Unpack the project
          "gunzip -c #{project.name}-#{project.version}.tar.gz | '#{@tar}' -C '$(tempdir)/osx/build/root/#{project.name}-#{project.version}' --strip-components 1 -xf -",
 
-         # Move bill-of-materials into a docdir
-         "mkdir -p $(tempdir)/osx/build/root/#{project.name}-#{project.version}/usr/local/share/doc/#{project.name}",
-         "mv $(tempdir)/osx/build/root/#{project.name}-#{project.version}/bill-of-materials $(tempdir)/osx/build/root/#{project.name}-#{project.version}/usr/local/share/doc/#{project.name}/bill-of-materials",
+         bom_install,
 
          # Package the project
          "(cd $(tempdir)/osx/build/; #{@pkgbuild} --root root/#{project.name}-#{project.version} \
@@ -39,7 +52,7 @@ class Vanagon
          "(cd $(tempdir)/osx/build/; #{@hdiutil} create -volname #{project.name}-#{project.version} \
           -srcfolder pkg/ dmg/#{project.package_name})",
          "mkdir -p output/#{target_dir}",
-         "cp $(tempdir)/osx/build/dmg/#{project.package_name} ./output/#{target_dir}"]
+         "cp $(tempdir)/osx/build/dmg/#{project.package_name} ./output/#{target_dir}"].flatten.compact
       end
 
       # Method to generate the files required to build a osx package for the project

data/lib/vanagon/platform/rpm.rb

@@ -48,10 +48,29 @@ class Vanagon
         defines =  %(--define '_topdir $(tempdir)/rpmbuild' )
         # RPM doesn't allow dashes in the os_name. This was added to
         # convert cisco-wrlinux to cisco_wrlinux
-        unless is_aix?
-          defines << %(--define 'dist .#{@os_name.gsub('-', '_')}#{@os_version}' )
+        defines << %(--define 'dist .#{@os_name.gsub('-', '_')}#{@os_version}' )
+      end
+
+      def add_repository(definition)
+        definition = URI.parse(definition)
+
+        commands = ["rpm -q curl > /dev/null || yum -y install curl"]
+        if definition.scheme =~ /^(http|ftp)/
+          if File.extname(definition.path) == '.rpm'
+            # repo definition is an rpm (like puppetlabs-release)
+            commands << "curl -o local.rpm '#{definition}'; rpm -Uvh local.rpm; rm -f local.rpm"
+          else
+            reponame = "#{SecureRandom.hex}-#{File.basename(definition.path)}"
+            reponame = "#{reponame}.repo" if File.extname(reponame) != '.repo'
+            if is_cisco_wrlinux?
+              commands << "curl -o '/etc/yum/repos.d/#{reponame}' '#{definition}'"
+            else
+              commands << "curl -o '/etc/yum.repos.d/#{reponame}' '#{definition}'"
+            end
+          end
         end
-        defines
+
+        commands
       end
 
       # Constructor. Sets up some defaults for the rpm platform and calls the parent constructor
@@ -60,15 +79,11 @@ class Vanagon
       # @return [Vanagon::Platform::RPM] the rpm derived platform with the given name
       def initialize(name)
         @name = name
-        @make = "/usr/bin/make"
-        @tar = "tar"
-        @patch = "/usr/bin/patch"
-        @num_cores = "/bin/grep -c 'processor' /proc/cpuinfo"
-        if is_aix?
-          @num_cores = "lsdev -Cc processor |wc -l"
-          @install = "/opt/freeware/bin/install"
-        end
-        @rpmbuild = "/usr/bin/rpmbuild"
+        @make ||= "/usr/bin/make"
+        @tar ||= "tar"
+        @patch ||= "/usr/bin/patch"
+        @num_cores ||= "/bin/grep -c 'processor' /proc/cpuinfo"
+        @rpmbuild ||= "/usr/bin/rpmbuild"
         super(name)
       end
     end