choria-mcorpc-support 2.24.2 → 2.24.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c9b96995926bcb736c4d7340f1e35c82673db5ce74de15443a79fba36873a2a
-  data.tar.gz: f00bd913097f164271403440750015b73041d61b54712dadc728f0b56859d9c9
+  metadata.gz: cda09be3dbdb88b142247d02b8ee0f03d8198a1b4138b3b4d77b1143f692400a
+  data.tar.gz: c86ce219df50736213dd3da1915869c2971316f454f1377564c3147a48670c55
 SHA512:
-  metadata.gz: 996376fe60e4d07d576f18900fb17c062888e467dc04354b58665d7f16ac55dbd44a778146d70e517ea4e5c5ba11cc3437a83ac83644ff9493fcb3c48cc5fece
-  data.tar.gz: 217bcb3d3b7ec754dcb0756c68d68ec539546b44f084191b5abd47a21628b1029deabe118ab356db34a5727565734d34bf74c15d4c518a9fcc8109a066442fab
+  metadata.gz: a799daf56ba217197c4e3b66ae81e583eb4f5e88229b3f9e0b3e99ae4b666eb29388f7fa21c7cc8f9dbd5731c78016277978d1ed084c02593ae120694877a40d
+  data.tar.gz: 1bd34b265c722b9170d8a530caab0581809dbd812fae49bfa1337ee5e06eda441b22a0dcc67dd8b4341963ec85890d2442a5432bb34278cd0813f3ab5642b5e9

data/lib/mcollective.rb

@@ -43,7 +43,6 @@ module MCollective
   require "mcollective/log"
   require "mcollective/message"
   require "mcollective/optionparser"
-  require "mcollective/generators"
   require "mcollective/pluginmanager"
   require "mcollective/pluginpackager"
   require "mcollective/rpc"

data/lib/mcollective/application/plugin.rb

@@ -8,18 +8,14 @@ mco plugin package [options] <directory>
        mco plugin info <directory>
        mco plugin doc <plugin>
        mco plugin doc <type/plugin>
-       mco plugin generate agent <pluginname> [actions=val,val]
+       mco plugin generate client <ddl> <target>
+       mco plugin generate ddl <json_output> <ruby_output>
 
           info : Display plugin information including package details.
        package : Create all available plugin packages.
            doc : Display documentation for a specific plugin.
     END_OF_USAGE
 
-    option :pluginname,
-           :description => "Plugin name",
-           :arguments => ["-n", "--name NAME"],
-           :type => String
-
     option :postinstall,
            :description => "Post install script",
            :arguments => ["--postinstall POSTINSTALL"],
@@ -66,7 +62,7 @@ mco plugin package [options] <directory>
            :type => :array
 
     option :format,
-           :description => "Package output format. Defaults to rpmpackage or debpackage",
+           :description => "Package output format. Defaults to forge",
            :arguments => ["--format OUTPUTFORMAT"],
            :type => String
 
@@ -80,41 +76,11 @@ mco plugin package [options] <directory>
            :arguments => ["--template HELPTEMPLATE"],
            :type => String
 
-    option :description,
-           :description => "Plugin description",
-           :arguments => ["--description DESCRIPTION"],
-           :type => String
-
-    option :author,
-           :description => "The author of the plugin",
-           :arguments => ["--author AUTHOR"],
-           :type => String
-
-    option :license,
-           :description => "The license under which the plugin is distributed",
-           :arguments => ["--license LICENSE"],
-           :type => String
-
     option :version,
            :description => "The version of the plugin",
            :arguments => ["--pluginversion VERSION"],
            :type => String
 
-    option :url,
-           :description => "Url at which information about the plugin can be found",
-           :arguments => ["--url URL"],
-           :type => String
-
-    option :timeout,
-           :description => "The plugin's timeout",
-           :arguments => ["--timeout TIMEOUT"],
-           :type => Integer
-
-    option :actions,
-           :description => "Actions to be generated for an Agent Plugin",
-           :arguments => ["--actions [ACTIONS]"],
-           :type => Array
-
     option :keep_artifacts,
            :description => "Don't remove artifacts after building packages",
            :arguments => ["--keep-artifacts"],
@@ -131,53 +97,12 @@ mco plugin package [options] <directory>
         configuration[:action] = ARGV.delete_at(0)
 
         configuration[:target] = ARGV.delete_at(0) || "."
-
-        if configuration[:action] == "generate"
-          unless ARGV[0] && ARGV[0].match(/(actions|outputs)=(.+)/i)
-            if configuration[:pluginname] # rubocop:disable Metrics/BlockNesting
-              ARGV.delete_at(0)
-            else
-              configuration[:pluginname] = ARGV.delete_at(0)
-            end
-          end
-
-          ARGV.each do |argument|
-            if argument.match(/(actions|outputs)=(.+)/i)
-              configuration[$1.downcase.to_sym] = $2.split(",")
-            else
-              raise "Could not parse --arg '#{argument}'"
-            end
-          end
-        end
       end
     end
 
-    # Display info about plugin
-    def info_command
-      plugin = prepare_plugin
-      packager = PluginPackager["#{configuration[:format].capitalize}Packager"]
-      packager.new(plugin).package_information
-    end
-
     # Generate a plugin skeleton
     def generate_command
-      raise "undefined plugin type. cannot generate plugin. valid types are 'agent'" if configuration["target"] == "."
-
-      unless configuration[:pluginname]
-        puts "No plugin name specified. Using 'new_plugin'"
-        configuration[:pluginname] = "new_plugin"
-      end
-
-      load_plugin_config_values
-
-      case configuration[:target].downcase
-      when "agent"
-        Generators::AgentGenerator.new(configuration[:pluginname], configuration[:actions], configuration[:pluginname],
-                                       configuration[:description], configuration[:author], configuration[:license],
-                                       configuration[:version], configuration[:url], configuration[:timeout])
-      else
-        raise "invalid plugin type. cannot generate plugin '#{configuration[:target]}'"
-      end
+      puts "CRITICAL: mco plugin generate is deprecated, please use 'choria plugin generate'"
     end
 
     # Package plugin
@@ -211,75 +136,10 @@ mco plugin package [options] <directory>
     end
 
     # Show application list and plugin help
-    def doc_command # rubocop:disable Metrics/MethodLength
-      known_plugin_types = [
-        ["Agents", :agent],
-        ["Aggregate", :aggregate],
-        ["Connectors", :connector],
-        ["Discovery Methods", :discovery],
-        ["Validator Plugins", :validator]
-      ]
-
-      if configuration.include?(:target) && configuration[:target] != "."
-        if configuration[:target] =~ /^(.+?)\/(.+)$/
-          ddl = load_plugin_ddl($2.to_sym, $1)
-        else
-          found_plugin_type = nil
-
-          known_plugin_types.each do |plugin_type|
-            PluginManager.find(plugin_type[1], "ddl").each do |ddlf|
-              pluginname = ddlf.gsub(/_#{plugin_type[1]}$/, "")
-
-              abort "Duplicate plugin name found, please specify a full path like agent/rpcutil" if pluginname == configuration[:target] && found_plugin_type
-
-              found_plugin_type = plugin_type[1] if pluginname == configuration[:target]
-            end
-          end
-
-          abort "Could not find a plugin named '%s' in any supported plugin type" % configuration[:target] unless found_plugin_type
-          ddl = load_plugin_ddl(configuration[:target], found_plugin_type)
-        end
-
-        if ddl
-          puts ddl.help(configuration[:rpctemplate])
-        else
-          abort "Could not find a '%s' plugin named '%s'" % configuration[:target].split("/")
-        end
-
-      else
-        puts "Please specify a plugin. Available plugins are:"
-        puts
-
-        load_errors = []
-
-        known_plugin_types.each do |plugin_type|
-          puts "%s:" % plugin_type[0]
-
-          PluginManager.find(plugin_type[1], "ddl").each do |ddlf|
-            begin
-              help = DDL.new(ddlf, plugin_type[1], false)
+    def doc_command
+      puts "WARNING: mco plugin doc is deprecated, please use choria plugin doc"
 
-              next unless help.client_activated?
-
-              help.loadddlfile
-              pluginname = ddlf.gsub(/_#{plugin_type[1]}$/, "")
-              puts "  %-25s %s" % [pluginname, help.meta[:description]]
-            rescue => e
-              load_errors << [plugin_type[1], ddlf, e]
-            end
-          end
-
-          puts
-        end
-
-        unless load_errors.empty?
-          puts "Plugin Load Errors:"
-
-          load_errors.each do |e|
-            puts "  %-25s %s" % ["#{e[0]}/#{e[1]}", Util.colorize(:yellow, e[2])]
-          end
-        end
-      end
+      exec("choria plugin doc %s" % [configuration[:target]])
     end
 
     # Creates the correct package plugin object.
@@ -341,18 +201,6 @@ mco plugin package [options] <directory>
       File.basename(plugintype[0])
     end
 
-    # Load preset metadata values from config if they are present
-    # This makes it possible to override metadata values in a local
-    # client config file.
-    #
-    # Example : plugin.metadata.license = Apache 2
-    def load_plugin_config_values
-      config = Config.instance
-      [:pluginname, :description, :author, :license, :version, :url, :timeout].each do |confoption|
-        configuration[confoption] = config.pluginconf["metadata.#{confoption}"] unless configuration[confoption]
-      end
-    end
-
     def main
       abort "No action specified, please run 'mco help plugin' for help" unless configuration.include?(:action)
 

data/lib/mcollective/config.rb

@@ -137,6 +137,8 @@ module MCollective
 
         raise('Identities can only match /\w\.\-/') unless @identity =~ /^[\w.\-]+$/
 
+        check_deprecations
+
         @configured = true
 
         libdirs.each do |dir|
@@ -254,5 +256,13 @@ module MCollective
         end
       end
     end
+
+    def check_deprecations
+      if @pluginconf["choria.use_srv_records"]
+        Log.warn("Configuration set 'choria.use_srv_records' which is deprecated in favor of 'choria.use_srv'.")
+        @pluginconf["choria.use_srv"] = @pluginconf["choria.use_srv_records"]
+        @pluginconf.delete("choria.use_srv_records")
+      end
+    end
   end
 end

data/lib/mcollective/log.rb

@@ -96,9 +96,8 @@ module MCollective
         end
 
         @logger.start
-      rescue Exception => e # rubocop:disable Lint/RescueException
+      rescue Exception # rubocop:disable Lint/RescueException
         @configured = false
-        warn "Could not start logger: #{e.class} #{e}"
       end
 
       # figures out the filename that called us

data/lib/mcollective/util/choria.rb

@@ -157,19 +157,19 @@ module MCollective
 
       # Determines if SRV records should be used
       #
-      # Setting choria.use_srv_records to anything other than t, true, yes or 1 will disable
+      # Setting choria.use_srv to anything other than t, true, yes or 1 will disable
       # SRV records
       #
       # @return [Boolean]
       def should_use_srv?
-        ["t", "true", "yes", "1"].include?(get_option("choria.use_srv_records", "1").downcase)
+        ["t", "true", "yes", "1"].include?(get_option("choria.use_srv", "1").downcase)
       end
 
       # Query DNS for a series of records
       #
       # The given records will be passed through {#srv_records} to figure out the domain to query in.
       #
-      # Querying of records can be bypassed by setting choria.use_srv_records to false
+      # Querying of records can be bypassed by setting choria.use_srv to false
       #
       # @yield [Hash] each record for modification by the caller
       # @param records [Array<String>] the records to query without their domain parts
@@ -634,21 +634,27 @@ module MCollective
 
       # The PuppetDB server to connect to
       #
-      # Will consult _x-puppet-db._tcp.example.net then _x-puppet._tcp.example.net
-      # then configurable using choria.puppetdb_host and choria.puppetdb_port, defaults
-      # to puppet:8081
+      # Use choria.puppetdb_host if set, otherwise query
+      # _x-puppet-db._tcp.example.net then _x-puppet._tcp.example.net if SRV
+      # lookup is enabled, and fallback to puppet:8081 if nothing else worked.
       #
       # @return [Hash] with :target and :port
       def puppetdb_server
-        d_host = get_option("choria.puppetdb_host", "puppet")
         d_port = get_option("choria.puppetdb_port", "8081")
 
+        answer = {
+          :target => get_option("choria.puppetdb_host", nil),
+          :port => d_port
+        }
+
+        return answer if answer[:target]
+
         answer = try_srv(["_x-puppet-db._tcp"], nil, nil)
         return answer if answer[:target]
 
         # In the case where we take _x-puppet._tcp SRV records we unfortunately have
         # to force the port else it uses the one from Puppet which will 404
-        answer = try_srv(["_x-puppet._tcp"], d_host, d_port)
+        answer = try_srv(["_x-puppet._tcp"], "puppet", d_port)
         answer[:port] = d_port
 
         answer

data/lib/mcollective/util/tasks_support.rb

@@ -186,6 +186,7 @@ module MCollective
           environment["PT_%s" % k] = v.to_s
         end
 
+        environment["PT__task"] = task["task"]
         environment["PT__installdir"] = File.join(request_spooldir(task_id), "files")
 
         environment

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: choria-mcorpc-support
 version: !ruby/object:Gem::Version
-  version: 2.24.2
+  version: 2.24.3
 platform: ruby
 authors:
 - R.I.Pienaar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-29 00:00:00.000000000 Z
+date: 2021-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: systemu
@@ -118,12 +118,6 @@ files:
 - lib/mcollective/facts.rb
 - lib/mcollective/facts/base.rb
 - lib/mcollective/facts/yaml_facts.rb
-- lib/mcollective/generators.rb
-- lib/mcollective/generators/agent_generator.rb
-- lib/mcollective/generators/base.rb
-- lib/mcollective/generators/templates/action_snippet.erb
-- lib/mcollective/generators/templates/ddl.erb
-- lib/mcollective/generators/templates/plugin.erb
 - lib/mcollective/log.rb
 - lib/mcollective/logger.rb
 - lib/mcollective/logger/base.rb

data/lib/mcollective/generators.rb

@@ -1,6 +0,0 @@
-module MCollective
-  module Generators
-    require "mcollective/generators/base"
-    require "mcollective/generators/agent_generator"
-  end
-end

data/lib/mcollective/generators/agent_generator.rb

@@ -1,50 +0,0 @@
-module MCollective
-  module Generators
-    class AgentGenerator < Base
-      attr_accessor :ddl, :content
-
-      def initialize(plugin_name, actions=[], name=nil, description=nil, author=nil,
-                     license=nil, version=nil, url=nil, timeout=nil)
-
-        super(name, description, author, license, version, url, timeout)
-        @plugin_name = plugin_name
-        @actions = actions || []
-        @ddl = create_ddl
-        @mod_name = "Agent"
-        @pclass = "RPC::Agent"
-        @content = create_plugin_content
-        @plugin = create_plugin_string
-        write_plugins
-      end
-
-      def create_ddl
-        action_text = ""
-        @actions.each_with_index do |action, i|
-          action_text += "action \"#{action}\", :description => \"%ACTIONDESCRIPTION%\" do\n"
-          action_text += action_help if i == 0
-          action_text += "end\n"
-          action_text += "\n" unless @actions.size == (i + 1)
-        end
-        # Use inherited method to create metadata part of the ddl
-        create_metadata_string + action_text
-      end
-
-      def create_plugin_content
-        content_text = ""
-
-        # Add actions to agent file
-        @actions.each_with_index do |action, i|
-          content_text +=  "%6s%s" % [" ", "action \"#{action}\" do\n"]
-          content_text +=  "%6s%s" % [" ", "end\n"]
-          content_text += "\n" unless @actions.size == (i + 1)
-        end
-        content_text
-      end
-
-      def action_help
-        action_snippet = File.read(File.join(File.dirname(__FILE__), "templates", "action_snippet.erb"))
-        ERB.new(action_snippet).result
-      end
-    end
-  end
-end

data/lib/mcollective/generators/base.rb

@@ -1,45 +0,0 @@
-module MCollective
-  module Generators
-    class Base
-      attr_accessor :meta, :plugin_name, :mod_name
-
-      def initialize(name, description, author, license, version, url, timeout)
-        @meta = {:name => name,
-                 :description => description,
-                 :author => author,
-                 :license => license,
-                 :version => version,
-                 :url => url,
-                 :timeout => timeout}
-      end
-
-      def create_metadata_string
-        ddl_template = File.read(File.join(File.dirname(__FILE__), "templates", "ddl.erb"))
-        ERB.new(ddl_template, nil, "-").result(binding)
-      end
-
-      def create_plugin_string
-        plugin_template = File.read(File.join(File.dirname(__FILE__), "templates", "plugin.erb"))
-        ERB.new(plugin_template, nil, "-").result(binding)
-      end
-
-      def write_plugins
-        Dir.mkdir @plugin_name
-        dirname = File.join(@plugin_name, @mod_name.downcase)
-        Dir.mkdir dirname
-        puts "Created plugin directory : #{@plugin_name}"
-
-        File.open(File.join(dirname, "#{@plugin_name}.ddl"), "w") {|f| f.puts @ddl}
-        puts "Created DDL file : #{File.join(dirname, "#{@plugin_name}.ddl")}"
-
-        File.open(File.join(dirname, "#{@plugin_name}.rb"), "w") {|f| f.puts @plugin}
-        puts "Created #{@mod_name} file : #{File.join(dirname, "#{@plugin_name}.rb")}"
-      rescue Errno::EEXIST
-        raise "cannot generate '#{@plugin_name}' : plugin directory already exists."
-      rescue Exception => e # rubocop:disable Lint/RescueException
-        FileUtils.rm_rf(@plugin_name) if File.directory?(@plugin_name)
-        raise "cannot generate plugin - #{e}"
-      end
-    end
-  end
-end

data/lib/mcollective/generators/templates/action_snippet.erb

@@ -1,13 +0,0 @@
-     # Example Input
-     input :name,
-           :prompt => "%PROMPT%",
-           :description => "%DESCRIPTION%",
-           :type => %TYPE%,
-           :validation => '%VALIDATION%',
-           :optional => %OPTIONAL%,
-           :maxlength => %MAXLENGTH%
-
-     # Example output
-     output :name,
-            :description => "%DESCRIPTION%",
-            :display_as => "%DISPLAYAS%"

data/lib/mcollective/generators/templates/ddl.erb

@@ -1,8 +0,0 @@
-metadata :name => "<%= meta[:name] || "%FULLNANE%" -%>",
-         :description => "<%= meta[:description] || "%DESCRIPTION%" -%>",
-         :author => "<%= meta[:author] || "%AUTHOR%" -%>",
-         :license => "<%= meta[:license] || "%LICENSE%" -%>",
-         :version => "<%= meta[:version] || "%VERSION%" -%>",
-         :url => "<%= meta[:url] || "%URL%" -%>",
-         :timeout => <%= meta[:timeout] || "%TIMEOUT%" %>
-

data/lib/mcollective/generators/templates/plugin.erb

@@ -1,7 +0,0 @@
-module MCollective
-  module <%= @mod_name%>
-    class <%= @plugin_name.capitalize -%><<%= @pclass%>
-<%= @content%>
-    end
-  end
-end