mcollective-client 2.7.0 → 2.8.0

data/lib/mcollective/pluginpackager/debpackage_packager.rb

@@ -0,0 +1,237 @@
+module MCollective
+  module PluginPackager
+    class DebpackagePackager
+      require 'erb'
+
+      def initialize(plugin, pluginpath = nil, signature = nil, verbose = false, keep_artifacts = nil, module_template = nil)
+        if PluginPackager.command_available?('debuild')
+          @plugin = plugin
+          @verbose = verbose
+          @libdir = pluginpath || '/usr/share/mcollective/plugins/mcollective/'
+          @signature = signature
+          @package_name = "#{@plugin.mcname}-#{@plugin.metadata[:name]}"
+          @keep_artifacts = keep_artifacts
+        else
+          raise("Cannot build package. 'debuild' is not present on the system.")
+        end
+      end
+
+      # Build process :
+      # - create buildroot
+      # - craete buildroot/debian
+      # - create the relative directories with package contents
+      # - create install files for each of the plugins that are going to be built
+      # - create debian build files
+      # - create tarball
+      # - create pre and post install files
+      # - run the build script
+      # - move packages to cwd
+      # - clean up
+      def create_packages
+        begin
+          puts "Building packages for #{@package_name} plugin."
+
+          @tmpdir = Dir.mktmpdir('mcollective_packager')
+          @build_dir = File.join(@tmpdir, "#{@package_name}_#{@plugin.metadata[:version]}")
+          Dir.mkdir(@build_dir)
+
+          create_debian_dir
+          @plugin.packagedata.each do |type, data|
+            prepare_tmpdirs(data)
+            create_install_file(type, data)
+            create_pre_and_post_install(type)
+          end
+          create_debian_files
+          create_tar
+          run_build
+          move_packages
+
+          puts "Completed building all packages for #{@package_name} plugin."
+        ensure
+          if @keep_artifacts
+            puts 'Keeping build artifacts.'
+            puts "Build artifacts saved - #{@tmpdir}"
+          else
+            puts 'Removing build artifacts.'
+            cleanup_tmpdirs
+          end
+        end
+      end
+
+      private
+
+      def create_debian_files
+        ['control', 'Makefile', 'compat', 'rules', 'copyright', 'changelog'].each do |f|
+          create_file(f)
+        end
+      end
+
+      def run_build
+        FileUtils.cd(@build_dir) do
+          PluginPackager.execute_verbosely(@verbose) do
+            if @signature
+              if @signature.is_a?(String)
+                PluginPackager.safe_system("debuild --no-lintian -i -k#{@signature}")
+              else
+                PluginPackager.safe_system("debuild --no-lintian -i")
+              end
+            else
+              PluginPackager.safe_system("debuild --no-lintian -i -us -uc")
+            end
+          end
+        end
+      end
+
+      # Creates a string used by the control file to specify dependencies
+      # Dependencies can be formatted as :
+      # foo (>= x.x-x)
+      # foo (>= x.x)
+      # foo
+      def build_dependency_string(data)
+        dependencies = []
+        PluginPackager.filter_dependencies('debian', data[:dependencies]).each do |dep|
+          if dep[:version] && dep[:revision]
+            dependencies << "#{dep[:name]} (>=#{dep[:version]}-#{dep[:revision]})"
+          elsif dep[:version]
+            dependencies << "#{dep[:name]} (>=#{dep[:version]})"
+          else
+            dependencies << dep[:name]
+          end
+        end
+
+        if data[:plugindependency]
+          dependencies << "#{data[:plugindependency][:name]} (= ${binary:Version})"
+        end
+
+        dependencies.join(', ')
+      end
+
+      # Creates an install file for each of the packages that are going to be created
+      # for the plugin
+      def create_install_file(type, data)
+        install_file = "#{@package_name}-#{type}"
+        begin
+          install_file = File.join(@build_dir, 'debian', "#{install_file}.install")
+          File.open(install_file, 'w') do |file|
+            data[:files].each do |f|
+              extended_filename = File.join(@libdir, File.expand_path(f).gsub(/^#{@plugin.target_path}/, ''))
+              file.puts "#{extended_filename} #{File.dirname(extended_filename)}"
+            end
+          end
+        rescue Errno::EACCES => e
+          puts "Could not create install file '#{install_file}'. Permission denied"
+          raise e
+        rescue => e
+          puts "Could not create install file '#{install_file}'."
+          raise e
+        end
+      end
+
+      # Move source package and debs to cwd
+      def move_packages
+        begin
+          files_to_copy = Dir.glob(File.join(@tmpdir, '*.{deb,dsc,diff.gz,orig.tar.gz,changes}'))
+          FileUtils.cp(files_to_copy, '.')
+        rescue => e
+          puts 'Could not copy packages to working directory.'
+          raise e
+        end
+      end
+
+      # Create pre and post install files in $buildroot/debian
+      # from supplied scripts.
+      # Note that all packages built for the plugin will invoke
+      # the same pre and post install scripts.
+      def create_pre_and_post_install(type)
+        if @plugin.preinstall
+          if !File.exists?(@plugin.preinstall)
+            puts "pre-install script '#{@plugin.preinstall}' not found."
+            raise(Errno::ENOENT, @plugin.preinstall)
+          else
+            FileUtils.cp(@plugin.preinstall, File.join(@build_dir, 'debian', "#{@package_name}-#{type}.preinst"))
+          end
+        end
+
+        if @plugin.postinstall
+          if !File.exists?(@plugin.postinstall)
+            puts "post-install script '#{@plugin.postinstall}' not found."
+            raise(Errno::ENOENT, @plugin.postinstall)
+          else
+            FileUtils.cp(@plugin.postinstall, File.join(@build_dir, 'debian', "#{@package_name}-#{type}.postinst"))
+          end
+        end
+      end
+
+      # Tar up source
+      # Expects directory : $mcollective-$agent_$version
+      # Creates file : $buildroot/$mcollective-$agent_$version.orig.tar.gz
+      def create_tar
+        name_and_version = "#{@package_name}_#{@plugin.metadata[:version]}"
+        tarfile = "#{name_and_version}.orig.tar.gz"
+        begin
+          PluginPackager.execute_verbosely(@verbose) do
+            Dir.chdir(@tmpdir) do
+              PluginPackager.safe_system("tar -Pcvzf #{File.join(@tmpdir, tarfile)} #{name_and_version}")
+            end
+          end
+        rescue Exception => e
+          puts "Could not create tarball - #{tarfile}"
+          raise e
+        end
+      end
+
+      def create_file(filename)
+        begin
+          file = ERB.new(File.read(File.join(File.dirname(__FILE__), 'templates', 'debian', "#{filename}.erb")), nil, '-')
+          File.open(File.join(@build_dir, 'debian', filename), 'w') do |f|
+            f.puts file.result(binding)
+          end
+        rescue => e
+          puts "Could not create file - '#{filename}'"
+          raise e
+        end
+      end
+
+      # Move files contained in the plugin to the correct directory
+      # relative to the build root.
+      def prepare_tmpdirs(data)
+        data[:files].each do |file|
+          begin
+            targetdir = File.join(@build_dir, @libdir, File.dirname(File.expand_path(file)).gsub(/^#{@plugin.target_path}/, ""))
+            FileUtils.mkdir_p(targetdir) unless File.directory?(targetdir)
+            FileUtils.cp_r(file, targetdir)
+          rescue Errno::EACCES => e
+            puts "Could not create directory '#{targetdir}'. Permission denied"
+            raise e
+          rescue Errno::ENOENT => e
+            puts "Could not copy file '#{file}' to '#{targetdir}'. File does not exist"
+            raise e
+          rescue => e
+            puts 'Could not prepare build directory'
+            raise e
+          end
+        end
+      end
+
+      # Create the $buildroot/debian directory
+      def create_debian_dir
+        deb_dir = File.join(@build_dir, 'debian')
+        begin
+          FileUtils.mkdir_p(deb_dir)
+        rescue => e
+          puts "Could not create directory '#{deb_dir}'"
+          raise e
+        end
+      end
+
+      def cleanup_tmpdirs
+        begin
+          FileUtils.rm_r(@tmpdir) if File.directory?(@tmpdir)
+        rescue => e
+          puts "Could not remove temporary build directory - '#{@tmpdir}'"
+          raise e
+        end
+      end
+    end
+  end
+end

data/lib/mcollective/pluginpackager/modulepackage_packager.rb

@@ -0,0 +1,127 @@
+module MCollective
+  module PluginPackager
+    class ModulepackagePackager
+      require 'erb'
+
+      def initialize(plugin, pluginpath = nil, signature = nil, verbose = false, keep_artifacts = nil, module_template = nil)
+        assert_new_enough_puppet
+        @plugin = plugin
+        @package_name = "#{@plugin.mcname}_#{@plugin.metadata[:name]}".gsub(/-/, '_')
+        @verbose = verbose
+        @keep_artifacts = keep_artifacts
+        @module_template = module_template || File.join(File.dirname(__FILE__), 'templates', 'module')
+      end
+
+      # Build Process :
+      # - create module directory
+      # - run 'puppet module build'
+      # - move generated package back to cwd
+      def create_packages
+        begin
+          puts "Building module for #{@package_name} plugin."
+
+          @tmpdir = Dir.mktmpdir('mcollective_packager')
+          make_module
+          run_build
+          move_package
+
+          puts "Completed building module for #{@package_name} plugin."
+        ensure
+          if @keep_artifacts
+            puts 'Keeping build artifacts'
+            puts "Build artifacts saved - #{@tmpdir}"
+          else
+            cleanup_tmpdirs
+          end
+        end
+      end
+
+      private
+
+      def assert_new_enough_puppet
+        unless PluginPackager.command_available?('puppet')
+          raise("Cannot build package. 'puppet' is not present on the system.")
+        end
+
+        s = Shell.new('puppet --version')
+        s.runcommand
+        actual_version = s.stdout.chomp
+
+        required_version = '3.3.0'
+        if Util.versioncmp(actual_version, required_version) < 0
+          raise("Cannot build package. puppet #{required_version} or greater required.  We have #{actual_version}.")
+        end
+      end
+
+      def make_module
+        targetdir = File.join(@tmpdir, 'manifests')
+        FileUtils.mkdir_p(targetdir) unless File.directory?(targetdir)
+
+        # for each subpackage make a subclass
+        @plugin.packagedata.each do |klass,data|
+          data[:files].each do |file|
+            relative_path = File.expand_path(file).gsub(/#{@plugin.target_path}|^\.\//, '')
+            targetdir = File.join(@tmpdir, 'files', klass.to_s, 'mcollective', File.dirname(relative_path))
+            FileUtils.mkdir_p(targetdir) unless File.directory?(targetdir)
+            FileUtils.cp_r(file, targetdir)
+          end
+
+          @klass = klass.to_s
+          render_template('_manifest.pp.erb', File.join(@tmpdir, 'manifests', "#{klass}.pp"))
+        end
+
+        # render all the templates we have
+        Dir.glob(File.join(@module_template, '*.erb')).each do |template|
+          filename = File.basename(template, '.erb')
+          next if filename =~ /^_/ # starting with underscore makes it private
+          render_template("#{filename}.erb", File.join(@tmpdir, filename))
+        end
+      end
+
+      def render_template(template, path)
+        begin
+          erb = ERB.new(File.read(File.join(@module_template, template)), nil, '-')
+          File.open(path, 'w') do |f|
+            f.puts erb.result(binding)
+          end
+        rescue => e
+          puts "Could not render template to path - '#{path}'"
+          raise e
+        end
+      end
+
+      def run_build
+        begin
+          PluginPackager.execute_verbosely(@verbose) do
+            Dir.chdir(@tmpdir) do
+              PluginPackager.safe_system('puppet module build')
+            end
+          end
+        rescue => e
+          puts 'Build process has failed'
+          raise e
+        end
+      end
+
+      # Move built package to cwd
+      def move_package
+        begin
+          package_file = File.join(@tmpdir, 'pkg', "#{@plugin.vendor}-#{@package_name}-#{@plugin.metadata[:version]}.tar.gz")
+          FileUtils.cp(package_file, '.')
+        rescue => e
+          puts 'Could not copy package to working directory'
+          raise e
+        end
+      end
+
+      def cleanup_tmpdirs
+        begin
+          FileUtils.rm_r(@tmpdir) if File.directory?(@tmpdir)
+        rescue => e
+          puts "Could not remove temporary build directory - '#{@tmpdir}'"
+          raise e
+        end
+      end
+    end
+  end
+end

data/lib/mcollective/pluginpackager/ospackage_packager.rb

@@ -0,0 +1,59 @@
+module MCollective
+  module PluginPackager
+    # MCollective plugin packager general OS implementation.
+    class OspackagePackager
+
+      attr_accessor :package, :verbose, :packager, :package_type
+
+      # Create packager object with package parameter containing list of files,
+      # dependencies and package metadata.
+      def initialize(package, pluginpath = nil, signature = nil, verbose = false, keep_artifacts = false, module_template = nil)
+
+        if File.exists?("/etc/redhat-release")
+          @packager = PluginPackager["RpmpackagePackager"].new(package, pluginpath, signature, verbose, keep_artifacts, module_template)
+          @package_type = "RPM"
+        elsif File.exists?("/etc/debian_version")
+          @packager = PluginPackager["DebpackagePackager"].new(package, pluginpath, signature, verbose, keep_artifacts, module_template)
+          @package_type = "Deb"
+        else
+          raise "cannot identify operating system."
+        end
+
+        @package = package
+        @verbose = verbose
+      end
+
+      # Hands over package creation to the detected packager implementation
+      # based on operating system.
+      def create_packages
+        @packager.create_packages
+      end
+
+      # Displays the package metadata and detected files
+      def package_information
+        puts
+        puts "%30s%s" % ["Plugin information : ", @package.metadata[:name]]
+        puts "%30s%s" % ["-" * 22, "-" * 22]
+        puts "%30s%s" % ["Plugin Type : ", @package.plugintype.capitalize]
+        puts "%30s%s" % ["Package Output Format : ", @package_type]
+        puts "%30s%s" % ["Version : ", @package.metadata[:version]]
+        puts "%30s%s" % ["Revision : ", @package.revision]
+        puts "%30s%s" % ["Vendor : ", @package.vendor]
+        puts "%30s%s" % ["Post Install Script : ", @package.postinstall] if @package.postinstall
+        puts "%30s%s" % ["Author : ", @package.metadata[:author]]
+        puts "%30s%s" % ["License : ", @package.metadata[:license]]
+        puts "%30s%s" % ["URL : ", @package.metadata[:url]]
+
+        if @package.packagedata.size > 0
+          @package.packagedata.each_with_index do |values, i|
+            if i == 0
+              puts "%30s%s" % ["Identified Packages : ", values[0]]
+            else
+              puts "%30s%s" % [" ", values[0]]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mcollective/pluginpackager/rpmpackage_packager.rb

@@ -0,0 +1,180 @@
+module MCollective
+  module PluginPackager
+    class RpmpackagePackager
+      require 'erb'
+
+      def initialize(plugin, pluginpath = nil, signature = nil, verbose = false, keep_artifacts = nil, module_template = nil)
+        if @buildtool = select_command
+          @plugin = plugin
+          @package_name = "#{@plugin.mcname}-#{@plugin.metadata[:name]}"
+          @package_name_and_version = "#{@package_name}-#{@plugin.metadata[:version]}"
+          @verbose = verbose
+          @libdir = pluginpath || '/usr/libexec/mcollective/mcollective/'
+          @signature = signature
+          @rpmdir = rpmdir
+          @srpmdir = srpmdir
+          @keep_artifacts = keep_artifacts
+        else
+          raise("Cannot build package. 'rpmbuild' or 'rpmbuild-md5' is not present on the system")
+        end
+      end
+
+      # Determine the build tool present on the system
+      def select_command
+        if PluginPackager.command_available?('rpmbuild-md5')
+          return 'rpmbuild-md5'
+        elsif PluginPackager.command_available?('rpmbuild')
+          return 'rpmbuild'
+        else
+          return nil
+        end
+      end
+
+      def rpmdir
+        `rpm --eval '%_rpmdir'`.chomp
+      end
+
+      def srpmdir
+        `rpm --eval '%_srcrpmdir'`.chomp
+      end
+
+      # Build Process :
+      # - create temporary buildroot
+      # - create the spec file
+      # - create the tarball
+      # - run the build script
+      # - move pacakges to cwd
+      # - clean up
+      def create_packages
+        begin
+          puts "Building packages for #{@package_name} plugin."
+
+          @tmpdir = Dir.mktmpdir('mcollective_packager')
+          prepare_tmpdirs
+
+          make_spec_file
+          run_build
+          move_packages
+
+          puts "Completed building all packages for #{@package_name} plugin."
+        ensure
+          if @keep_artifacts
+            puts 'Keeping build artifacts'
+            puts "Build artifacts saved - #{@tmpdir}"
+          else
+            cleanup_tmpdirs
+          end
+        end
+      end
+
+      private
+
+      def run_build
+        begin
+          tarfile = create_tar
+          PluginPackager.execute_verbosely(@verbose) do
+            PluginPackager.safe_system("#{@buildtool} -ta#{" --quiet" unless @verbose}#{" --sign" if @signature} #{tarfile}")
+          end
+        rescue => e
+          puts 'Build process has failed'
+          raise e
+        end
+      end
+
+      # Tar up source
+      # Expects directory $mcollective-$agent-$version
+      # Creates file : $tmpbuildroot/$mcollective-$agent-$version
+      def create_tar
+        tarfile = File.join(@tmpdir, "#{@package_name_and_version}.tgz")
+        begin
+         PluginPackager.execute_verbosely(@verbose) do
+            Dir.chdir(@tmpdir) do
+              PluginPackager.safe_system("tar -cvzf #{tarfile} #{@package_name_and_version}")
+            end
+          end
+        rescue => e
+          puts "Could not create tarball - '#{tarfile}'"
+          raise e
+        end
+        tarfile
+      end
+
+      # Move rpm's and srpm's to cwd
+      def move_packages
+        begin
+          files_to_copy = []
+          files_to_copy += Dir.glob(File.join(@rpmdir, 'noarch', "#{@package_name}-*-#{@plugin.metadata[:version]}-#{@plugin.revision}*.noarch.rpm"))
+          files_to_copy += Dir.glob(File.join(@srpmdir, "#{@package_name}-#{@plugin.metadata[:version]}-#{@plugin.revision}*.src.rpm"))
+          FileUtils.cp(files_to_copy, '.')
+        rescue => e
+          puts 'Could not copy packages to working directory'
+          raise e
+        end
+      end
+
+      # Create the specfile and place as $tmpbuildroot/$mcollective-$agent-$version/$mcollective-$agent-$version.spec
+      def make_spec_file
+        spec_file = File.join(@tmpdir, @package_name_and_version, "#{@package_name_and_version}.spec")
+        begin
+          spec_template = ERB.new(File.read(File.join(File.dirname(__FILE__), 'templates', 'redhat', 'rpm_spec.erb')), nil, '-')
+          File.open(spec_file, 'w') do |f|
+            f.puts spec_template.result(binding)
+          end
+        rescue => e
+          puts "Could not create specfile - '#{spec_file}'"
+          raise e
+        end
+      end
+
+      # Move files contained in the plugin to the correct directory
+      # relative to the build root.
+      def prepare_tmpdirs
+        plugin_files.each do |file|
+          begin
+            targetdir = File.join(@tmpdir, @package_name_and_version, @libdir, File.dirname(File.expand_path(file)).gsub(@plugin.target_path, ""))
+            FileUtils.mkdir_p(targetdir) unless File.directory?(targetdir)
+            FileUtils.cp_r(file, targetdir)
+          rescue Errno::EACCES => e
+            puts "Could not create directory '#{targetdir}'. Permission denied"
+            raise e
+          rescue Errno::ENOENT => e
+            puts "Could not copy file '#{file}' to '#{targetdir}'. File does not exist"
+            raise e
+          rescue => e
+            puts 'Could not prepare temporary build directory'
+            raise e
+          end
+        end
+      end
+
+      # Extract all the package files from the plugin's package data hash
+      def plugin_files
+        files = []
+        @plugin.packagedata.each do |name, data|
+          files += data[:files].reject{ |f| File.directory?(f) }
+        end
+        files
+      end
+
+      # Extract the package specific files from the file list and omits directories
+      def package_files(files)
+        package_files = []
+        files.each do |f|
+          if !File.directory?(f)
+            package_files << File.join(@libdir, File.expand_path(f).gsub(/#{@plugin.target_path}|\.\//, ''))
+          end
+        end
+        package_files
+      end
+
+      def cleanup_tmpdirs
+        begin
+          FileUtils.rm_r(@tmpdir) if File.directory?(@tmpdir)
+        rescue => e
+          puts "Could not remove temporary build directory - '#{@tmpdir}'"
+          raise e
+        end
+      end
+    end
+  end
+end

data/lib/mcollective/pluginpackager/templates/debian/Makefile.erb

@@ -0,0 +1,7 @@
+DESTDIR=
+
+build:
+
+clean:
+
+install:

data/lib/mcollective/pluginpackager/templates/debian/changelog.erb

@@ -0,0 +1,5 @@
+<%= @package_name -%> (<%= @plugin.metadata[:version]-%>-<%= @plugin.revision-%>) unstable; urgency=low
+
+  * Automated release for <%= @package_name -%> by mco plugin packager.
+
+ -- The Marionette Collective <mcollective-dev@googlegroups.com>  <%= Time.new.strftime('%a, %d %b %Y %H:%M:%S %z') %>

data/lib/mcollective/pluginpackager/templates/debian/compat.erb

@@ -0,0 +1 @@
+7

data/lib/mcollective/pluginpackager/templates/debian/control.erb

@@ -0,0 +1,15 @@
+Source: <%= @package_name %>
+Homepage: <%= @plugin.metadata[:url] %>
+Section: utils
+Priority: extra
+Build-Depends: debhelper (>= 7), cdbs, dpatch
+Maintainer: <%= @plugin.metadata[:author] %>
+Standards-Version: 3.9.1
+<% @plugin.packagedata.each do |type, data| %>
+Package: <%= "#{@package_name}-#{type}" %>
+Architecture: all
+Depends: <%= build_dependency_string(data) %>
+Description: <%= @plugin.metadata[:description]%>
+ <%= data[:description]%>
+ .
+<% end -%>

data/lib/mcollective/pluginpackager/templates/debian/copyright.erb

@@ -0,0 +1,8 @@
+This package was generated by the MCollective plugin packager on
+<%= Time.now%>
+
+Upstream Author:
+  <%= @plugin.metadata[:author] %> <%= @plugin.metadata[:url] %>
+
+License:
+  <%= @plugin.metadata[:license] -%>

data/lib/mcollective/pluginpackager/templates/debian/rules.erb

@@ -0,0 +1,6 @@
+#!/usr/bin/make -f
+
+include /usr/share/cdbs/1/rules/debhelper.mk
+include /usr/share/cdbs/1/rules/dpatch.mk
+include /usr/share/cdbs/1/class/makefile.mk
+DEB_MAKE_INVOKE = $(DEB_MAKE_ENVVARS) make -f debian/Makefile -C $(DEB_BUILDDIR)

data/lib/mcollective/pluginpackager/templates/module/Modulefile.erb

@@ -0,0 +1,5 @@
+name '<%= @plugin.vendor %>-<%= @package_name %>'
+version '<%= @plugin.metadata[:version] %>'
+description '<%= @plugin.metadata[:description] %>'
+project_page '<%= @plugin.metadata[:url]%>'
+dependency 'puppetlabs/mcollective', '1.x'