choria-mcorpc-support 2.20.5 → 2.21.1

data/lib/mcollective/pluginpackager/{puppet_module_packager.rb → forge_packager.rb}

@@ -2,12 +2,12 @@ require "yaml"
 
 module MCollective
   module PluginPackager
-    class PuppetmodulePackager
-      def initialize(plugin, pluginpath = nil, signature = nil, verbose = false, keep_artifacts = nil, module_template = nil)
+    class ForgePackager
+      def initialize(plugin, pluginpath=nil, signature=nil, verbose=false, keep_artifacts=nil, module_template=nil)
         @plugin = plugin
         @verbose = verbose
         @keep_artifacts = keep_artifacts
-        @module_template = module_template || File.join(File.dirname(__FILE__), 'templates', 'puppet_module')
+        @module_template = module_template || File.join(File.dirname(__FILE__), "templates", "forge")
       end
 
       def which(cmd)
@@ -18,11 +18,11 @@ module MCollective
             return exe if File.executable?(exe) && !File.directory?(exe)
           end
         end
-        return nil
+        nil
       end
 
       def create_packages
-        assert_new_enough_puppet
+        assert_new_enough_pdk
         validate_environment
 
         begin
@@ -44,7 +44,7 @@ module MCollective
         ensure
           if @keep_artifacts
             puts("Keeping build artifacts")
-            puts("Build artifacts saved in %s" %  @tmpdir)
+            puts("Build artifacts saved in %s" % @tmpdir)
           else
             cleanup_tmpdirs
           end
@@ -81,7 +81,15 @@ module MCollective
       def filelist(type)
         @plugin.packagedata[type][:files].map do |file|
           file.gsub(/^\.\//, "") unless File.directory?(file)
-        end.compact
+        end.compact.uniq
+      rescue
+        []
+      end
+
+      def executablelist(type)
+        @plugin.packagedata[type][:executable_files].map do |file|
+          file.gsub(/^\.\//, "") unless File.directory?(file)
+        end.compact.uniq
       rescue
         []
       end
@@ -100,11 +108,12 @@ module MCollective
         {
           hierakey(:config_name) => @plugin.metadata[:name].downcase,
           hierakey(:common_files) => filelist(:common),
+          hierakey(:executable_files) => executablelist(:agent),
           hierakey(:common_directories) => dirlist(:common),
           hierakey(:server_files) => filelist(:agent),
           hierakey(:server_directories) => dirlist(:agent),
           hierakey(:client_files) => filelist(:client),
-          hierakey(:client_directories) => dirlist(:client),
+          hierakey(:client_directories) => dirlist(:client)
         }.merge(module_override_data)
       end
 
@@ -123,7 +132,7 @@ module MCollective
       end
 
       def copy_module_files
-        @plugin.packagedata.each do |klass, data|
+        @plugin.packagedata.each_value do |data|
           data[:files].each do |file|
             clean_dest_file = file.gsub("./lib/mcollective", "")
             dest_dir = File.expand_path(File.join(@tmpdir, "files", "mcollective", File.dirname(clean_dest_file)))
@@ -142,13 +151,18 @@ module MCollective
             agent_name = File.basename(file, ".ddl")
             json_file = File.join(agent_dir, "%s.json" % agent_name)
 
+            if File.exist?(json_file)
+              Log.warn("JSON DDL %s already exist, not regenerating from the %s" % [json_file, agent_name])
+              next
+            end
+
             ddl = DDL.new(agent_name, :agent, false)
             ddl.instance_eval(File.read(file))
 
             data = {
               "$schema" => "https://choria.io/schemas/mcorpc/ddl/v1/agent.json",
               "metadata" => ddl.meta,
-              "actions" => [],
+              "actions" => []
             }
 
             ddl.actions.sort.each do |action|
@@ -165,7 +179,7 @@ module MCollective
       end
 
       def render_templates
-        templates = Dir.chdir(@module_template) do |path|
+        templates = Dir.chdir(@module_template) do |_path|
           Dir.glob("**/*.erb")
         end
 
@@ -177,69 +191,62 @@ module MCollective
       end
 
       def render_template(infile, outfile)
-        begin
-          erb = ERB.new(File.read(infile), nil, "-")
-          File.open(outfile, "w") do |f|
-            f.puts erb.result(binding)
-          end
-        rescue
-          STDERR.puts("Could not render template %s to %s" % [infile, outfile])
-          raise
+        erb = ERB.new(File.read(infile), nil, "-")
+        File.open(outfile, "w") do |f|
+          f.puts erb.result(binding)
         end
+      rescue
+        STDERR.puts("Could not render template %s to %s" % [infile, outfile])
+        raise
       end
 
       def validate_environment
         raise("Supplying a vendor is required, please use --vendor") if @plugin.vendor == "Puppet Labs"
-        raise("Vendor names may not have a space in them, please specify a valid vendor using --vendor") if @plugin.vendor.match(" ")
+        raise("Vendor names may not have a space in them, please specify a valid vendor using --vendor") if @plugin.vendor.include?(" ")
       end
 
-      def assert_new_enough_puppet
-        puppet_bin = which("puppet")
-        puppet_bin = "/opt/puppetlabs/bin/puppet" if !puppet_bin
-        if !puppet_bin
-          raise("Cannot build package. 'puppet' not found on path, and '/opt/puppetlabs/bin/puppet' is not present on the system.")
-        end
+      def pdk_path
+        pdk_bin = which("pdk")
+        pdk_bin ||= "/opt/puppetlabs/pdk/bin/pdk"
 
-        s = Shell.new("#{puppet_bin} --version")
+        pdk_bin
+      end
+
+      def assert_new_enough_pdk
+        s = Shell.new("#{pdk_path} --version")
         s.runcommand
         actual_version = s.stdout.chomp
-        required_version = '4.5.1'
+        required_version = "1.12.0"
 
         if Util.versioncmp(actual_version, required_version) < 0
-          raise("Cannot build package. puppet #{required_version} or greater required.  We have #{actual_version}.")
+          raise("Cannot build package. pdk #{required_version} or greater required.  We have #{actual_version}.")
         end
       end
 
       def run_build
-        begin
-          PluginPackager.execute_verbosely(@verbose) do
-            Dir.chdir(@tmpdir) do
-              PluginPackager.safe_system('puppet module build')
-            end
+        PluginPackager.execute_verbosely(@verbose) do
+          Dir.chdir(@tmpdir) do
+            PluginPackager.safe_system("#{pdk_path} build --force")
           end
-        rescue
-          STDERR.puts("Build process has failed")
-          raise
         end
+      rescue
+        STDERR.puts("Build process has failed")
+        raise
       end
 
       def move_package
-        begin
-          package_file = File.join(@tmpdir, "pkg", module_file_name)
-          FileUtils.cp(package_file, ".")
-        rescue
-          STDERR.puts("Could not copy package to working directory")
-          raise
-        end
+        package_file = File.join(@tmpdir, "pkg", module_file_name)
+        FileUtils.cp(package_file, ".")
+      rescue
+        STDERR.puts("Could not copy package to working directory")
+        raise
       end
 
       def cleanup_tmpdirs
-        begin
-          FileUtils.rm_r(@tmpdir) if File.directory?(@tmpdir)
-        rescue
-          STDERR.puts("Could not remove temporary build directory %s" % [@tmpdir])
-          raise
-        end
+        FileUtils.rm_r(@tmpdir) if File.directory?(@tmpdir)
+      rescue
+        STDERR.puts("Could not remove temporary build directory %s" % [@tmpdir])
+        raise
       end
     end
   end

data/lib/mcollective/pluginpackager/standard_definition.rb

@@ -11,7 +11,7 @@ module MCollective
         @revision = configuration[:revision] || 1
         @preinstall = configuration[:preinstall]
         @postinstall = configuration[:postinstall]
-        @vendor = configuration[:vendor] || "Puppet Labs"
+        @vendor = configuration[:vendor] || "Choria.IO User"
         @dependencies = configuration[:dependency] || []
         @target_path = File.expand_path(@path)
         @metadata, mcversion = PluginPackager.get_metadata(@path, @plugintype)
@@ -20,6 +20,7 @@ module MCollective
         @dependencies << {:name => "#{mcname}-common", :version => @mcversion}
         @metadata[:name] = (configuration[:pluginname] || @metadata[:name]).downcase.gsub(/\s+|_/, "-")
         @metadata[:version] = (configuration[:version] || @metadata[:version])
+
         identify_packages
       end
 
@@ -33,9 +34,11 @@ module MCollective
 
       # Obtain standard plugin files and dependencies
       def plugin
-        plugindata = {:files => [],
-                      :dependencies => @dependencies.clone,
-                      :description => "#{@name} #{@plugintype} plugin for the Marionette Collective."}
+        plugindata = {
+          :files => [],
+          :dependencies => @dependencies.clone,
+          :description => "#{@name} #{@plugintype} plugin for the Choria Orchestrator."
+        }
 
         plugindir = File.join(@path, @plugintype.to_s)
         if PluginPackager.check_dir_present plugindir
@@ -44,25 +47,33 @@ module MCollective
           return nil
         end
 
-        plugindata[:plugindependency] = {:name => "#{@mcname}-#{@metadata[:name]}-common",
-                                      :version => @metadata[:version],
-                                      :revision => @revision} if @packagedata[:common]
+        if @packagedata[:common]
+          plugindata[:plugindependency] = {
+            :name => "#{@mcname}-#{@metadata[:name]}-common",
+            :version => @metadata[:version],
+            :revision => @revision
+          }
+        end
+
         plugindata
       end
 
       # Obtain list of common files
       def common
-        common = {:files => [],
-                  :dependencies => @dependencies.clone,
-                  :description => "Common libraries for #{@name} connector plugin"}
+        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
+
+        nil
       end
     end
   end

data/lib/mcollective/pluginpackager/templates/{puppet_module → forge}/README.md.erb

@@ -67,6 +67,6 @@ For a full list of possible configuration settings see the module [source reposi
 
 ## Development:
 
-To contribute to this MCollective plugin please visit <%= @plugin.metadata[:url] %>.
+To contribute to this [Choria.IO](https://choria.io) plugin please visit <%= @plugin.metadata[:url] %>.
 
 This module was generated using the Choria Plugin Packager based on templates found at the [GitHub Project](https://github.com/choria-io/).

data/lib/mcollective/pluginpackager/templates/{puppet_module → forge}/manifests/init.pp.erb

@@ -6,6 +6,7 @@ class <%= module_name %> (
   Array[String] $server_directories = [],
   Array[String] $common_files = [],
   Array[String] $common_directories = [],
+  Array[String] $executable_files = [],
   Boolean $manage_gem_dependencies = true,
   Hash $gem_dependencies = {},
   Boolean $manage_package_dependencies = true,
@@ -26,6 +27,7 @@ class <%= module_name %> (
     client_files                => $client_files,
     server_files                => $server_files,
     common_files                => $common_files,
+    executable_files            => $executable_files,
     client_directories          => $client_directories,
     server_directories          => $server_directories,
     common_directories          => $common_directories,

data/lib/mcollective/pluginpackager/templates/{puppet_module → forge}/metadata.json.erb

@@ -7,12 +7,12 @@
   "source": "<%= @plugin.metadata[:url] %>",
   "project_page": "<%= @plugin.metadata[:url] %>",
   "dependencies": [
-  {"name": "choria/mcollective", "version_requirement": ">= 0.4.0 < 2.0.0"}
+  {"name": "choria/mcollective", "version_requirement": ">= 0.9.3 < 2.0.0"}
   ],
   "requirements": [
     {
       "name": "puppet",
-      "version_requirement": ">= 4.9.0"
+      "version_requirement": ">= 6.0.0"
     }
   ]
 }

data/lib/mcollective/validator.rb

@@ -57,7 +57,7 @@ module MCollective
       Validator.load_validators
 
       begin
-        if [:integer, :boolean, :float, :number, :string].include?(validation)
+        if [:integer, :boolean, :float, :number, :string, :array, :hash].include?(validation)
           Validator.typecheck(validator, validation)
 
         else
@@ -76,7 +76,7 @@ module MCollective
           end
         end
       rescue => e
-        raise ValidatorError, e.to_s
+        raise ValidatorError, e.to_s, e.backtrace
       end
     end
   end

data/lib/mcollective/validator/array_validator.rb

@@ -2,7 +2,7 @@ module MCollective
   module Validator
     class ArrayValidator
       def self.validate(validator, array)
-        raise ValidatorError, "value should be one of %s" % [ array.join(", ") ] unless array.include?(validator)
+        raise ValidatorError, "value should be one of %s" % [array.join(", ")] unless array.include?(validator)
       end
     end
   end

data/lib/mcollective/validator/ipv4address_validator.rb

@@ -1,15 +1,13 @@
 module MCollective
   module Validator
     class Ipv4addressValidator
-      require 'ipaddr'
+      require "ipaddr"
 
       def self.validate(validator)
-        begin
-          ip = IPAddr.new(validator)
-          raise ValidatorError, "value should be an ipv4 adddress" unless ip.ipv4?
-        rescue
-          raise ValidatorError, "value should be an ipv4 address"
-        end
+        ip = IPAddr.new(validator)
+        raise ValidatorError, "value should be an ipv4 adddress" unless ip.ipv4?
+      rescue
+        raise ValidatorError, "value should be an ipv4 address"
       end
     end
   end

data/lib/mcollective/validator/ipv6address_validator.rb

@@ -1,15 +1,13 @@
 module MCollective
   module Validator
     class Ipv6addressValidator
-      require 'ipaddr'
+      require "ipaddr"
 
       def self.validate(validator)
-        begin
-          ip = IPAddr.new(validator)
-          raise ValidatorError, "value should be an ipv6 adddress" unless ip.ipv6?
-        rescue
-          raise ValidatorError, "value should be an ipv6 address"
-        end
+        ip = IPAddr.new(validator)
+        raise ValidatorError, "value should be an ipv6 adddress" unless ip.ipv6?
+      rescue
+        raise ValidatorError, "value should be an ipv6 address"
       end
     end
   end

data/lib/mcollective/validator/shellsafe_validator.rb

@@ -4,7 +4,7 @@ module MCollective
       def self.validate(validator)
         raise ValidatorError, "value should be a String" unless validator.is_a?(String)
 
-        ['`', '$', ';', '|', '&&', '>', '<'].each do |chr|
+        ["`", "$", ";", "|", "&&", ">", "<"].each do |chr|
           raise ValidatorError, "value should not have #{chr} in it" if validator.match(Regexp.escape(chr))
         end
       end

data/lib/mcollective/validator/typecheck_validator.rb

@@ -2,25 +2,29 @@ module MCollective
   module Validator
     class TypecheckValidator
       def self.validate(validator, validation_type)
-        raise ValidatorError, "value should be a #{validation_type.to_s}" unless check_type(validator, validation_type)
+        raise ValidatorError, "value should be a #{validation_type}" unless check_type(validator, validation_type)
       end
 
       def self.check_type(validator, validation_type)
         case validation_type
-          when Class
-            validator.is_a?(validation_type)
-          when :integer
-            validator.is_a?(Integer)
-          when :float
-            validator.is_a?(Float)
-          when :number
-            validator.is_a?(Numeric)
-          when :string
-            validator.is_a?(String)
-          when :boolean
-            [TrueClass, FalseClass].include?(validator.class)
-          else
-            false
+        when Class
+          validator.is_a?(validation_type)
+        when :integer
+          validator.is_a?(Integer)
+        when :float
+          validator.is_a?(Float)
+        when :number
+          validator.is_a?(Numeric)
+        when :string
+          validator.is_a?(String)
+        when :boolean
+          [TrueClass, FalseClass].include?(validator.class)
+        when :array
+          validator.is_a?(Array)
+        when :hash
+          validator.is_a?(Hash)
+        else
+          false
         end
       end
     end