choria-mcorpc-support 0.0.1

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/standard_definition.rb

@@ -0,0 +1,69 @@
+module MCollective
+  module PluginPackager
+    class StandardDefinition
+      attr_accessor :path, :packagedata, :metadata, :target_path, :vendor, :revision
+      attr_accessor :plugintype, :preinstall, :postinstall, :dependencies, :mcname, :mcversion
+
+      def initialize(configuration, mcdependency, plugintype)
+        @plugintype = plugintype
+        @path = PluginPackager.get_plugin_path(configuration[:target])
+        @packagedata = {}
+        @revision = configuration[:revision] || 1
+        @preinstall = configuration[:preinstall]
+        @postinstall = configuration[:postinstall]
+        @vendor = configuration[:vendor] || "Puppet Labs"
+        @dependencies = configuration[:dependency] || []
+        @target_path = File.expand_path(@path)
+        @metadata, mcversion = PluginPackager.get_metadata(@path, @plugintype)
+        @mcname = mcdependency[:mcname] || "mcollective"
+        @mcversion = mcdependency[:mcversion] || mcversion
+        @dependencies << {:name => "#{mcname}-common", :version => @mcversion}
+        @metadata[:name] = (configuration[:pluginname] || @metadata[:name]).downcase.gsub(/\s+|_/, "-")
+        @metadata[:version] = (configuration[:version] || @metadata[:version])
+        identify_packages
+      end
+
+      # Identify present packages and populate the packagedata hash
+      def identify_packages
+        common_package = common
+        @packagedata[:common] = common_package if common_package
+        plugin_package = plugin
+        @packagedata[@plugintype.to_sym] = plugin_package if plugin_package
+      end
+
+      # Obtain standard plugin files and dependencies
+      def plugin
+        plugindata = {:files => [],
+                      :dependencies => @dependencies.clone,
+                      :description => "#{@name} #{@plugintype} plugin for the Marionette Collective."}
+
+        plugindir = File.join(@path, @plugintype.to_s)
+        if PluginPackager.check_dir_present plugindir
+          plugindata[:files] = Dir.glob(File.join(plugindir, "*"))
+        else
+          return nil
+        end
+
+        plugindata[:plugindependency] = {:name => "#{@mcname}-#{@metadata[:name]}-common",
+                                      :version => @metadata[:version],
+                                      :revision => @revision} if @packagedata[:common]
+        plugindata
+      end
+
+      # Obtain list of common files
+      def common
+        common = {:files => [],
+                  :dependencies => @dependencies.clone,
+                  :description => "Common libraries for #{@name} connector plugin"}
+
+        commondir = File.join(@path, "util")
+        if PluginPackager.check_dir_present commondir
+          common[:files] = Dir.glob(File.join(commondir, "*"))
+          return common
+        else
+          return nil
+        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') %>