choria-mcorpc-support 2.23.2 → 2.24.3

data/lib/mcollective/agent/rpcutil.json

@@ -308,8 +308,7 @@
         },
         "machines": {
           "description": "Autonomous Agents",
-          "display_as": "Machines",
-          "default": null
+          "display_as": "Machines"
         }
       },
       "display": "always",
@@ -330,4 +329,4 @@
       "description": "Responds to requests for PING with PONG"
     }
   ]
-}
+}

data/lib/mcollective/agent/scout.json

@@ -1,122 +1,58 @@
 {
   "$schema": "https://choria.io/schemas/mcorpc/ddl/v1/agent.json",
   "metadata": {
-    "name": "scout",
-    "description": "Choria Scout Agent Management API",
-    "author": "R.I.Pienaar <rip@devco.net>",
     "license": "Apache-2.0",
+    "author": "R.I.Pienaar <rip@devco.net>",
+    "timeout": 5,
+    "name": "scout",
     "version": "0.0.1",
     "url": "https://choria.io",
-    "provider": "golang",
-    "timeout": 5
+    "description": "Choria Scout Agent Management API",
+    "provider": "golang"
   },
   "actions": [
     {
       "action": "checks",
-      "input": {
-      },
+      "display": "ok",
+      "description": "Obtain a list of checks and their current status",
+      "input": {},
       "output": {
         "checks": {
           "description": "Details about each check",
-          "display_as": "Checks",
-          "default": null,
-          "type": "array"
+          "type": "array",
+          "display_as": "Checks"
         }
-      },
-      "display": "ok",
-      "description": "Obtain a list of checks and their current status"
+      }
     },
     {
-      "action": "goss_validate",
+      "action": "resume",
       "input": {
-        "file": {
-          "prompt": "Goss File",
-          "description": "Path to the Goss validation specification",
-          "type": "string",
-          "default": null,
-          "optional": false,
-          "validation": ".+",
-          "maxlength": 256
-        },
-        "vars": {
-          "prompt": "Vars File",
-          "description": "Path to a file to use as template variables",
-          "type": "string",
-          "default": null,
-          "optional": true,
-          "validation": ".+",
-          "maxlength": 256
+        "checks": {
+          "prompt": "Checks",
+          "description": "Check to resume, empty means all",
+          "type": "array",
+          "optional": true
         }
       },
       "output": {
-        "failures": {
-          "description": "The number of tests that failed",
-          "display_as": "Failed Tests",
-          "default": null,
-          "type": "integer"
-        },
-        "results": {
-          "description": "The full test results",
-          "display_as": "Results",
-          "default": null,
+        "failed": {
+          "description": "List of checks that could not be resumed",
+          "display_as": "Failed",
           "type": "array"
         },
-        "runtime": {
-          "description": "The time it took to run the tests, in seconds",
-          "display_as": "Runtime",
-          "default": null,
-          "type": "integer"
-        },
-        "success": {
-          "description": "Indicates if the test passed",
-          "display_as": "Success",
-          "default": null,
-          "type": "string"
-        },
-        "summary": {
-          "description": "A human friendly test result",
-          "display_as": "Summary",
-          "default": null,
-          "type": "string"
+        "transitioned": {
+          "description": "List of checks that were resumed",
+          "display_as": "Triggered",
+          "type": "array"
         },
-        "tests": {
-          "description": "The number of tests that were run",
-          "display_as": "Tests",
-          "default": null,
-          "type": "integer"
+        "skipped": {
+          "description": "List of checks that was skipped",
+          "display_as": "Skipped",
+          "type": "array"
         }
       },
       "display": "failed",
-      "description": "Performs a Goss validation using a specific file",
-      "aggregate": [
-        {
-          "function": "summary",
-          "args": [
-            "tests",
-            {
-              "format": "%s Test Cases on %d node(s)"
-            }
-          ]
-        },
-        {
-          "function": "summary",
-          "args": [
-            "failures",
-            {
-              "format": "%s Failed Cases on %d node(s)"
-            }
-          ]
-        },
-        {
-          "function": "summary",
-          "args": [
-            "success",
-            {
-              "format": "%s Passed Cases on %d node(s)"
-            }
-          ]
-        }
-      ]
+      "description": "Resume active checking of one or more checks"
     },
     {
       "action": "maintenance",
@@ -125,7 +61,6 @@
           "prompt": "Checks",
           "description": "Check to pause, empty means all",
           "type": "array",
-          "default": null,
           "optional": true
         }
       },
@@ -133,19 +68,16 @@
         "failed": {
           "description": "List of checks that could not be paused",
           "display_as": "Failed",
-          "default": null,
-          "type": "array"
-        },
-        "skipped": {
-          "description": "List of checks that was skipped",
-          "display_as": "Skipped",
-          "default": null,
           "type": "array"
         },
         "transitioned": {
           "description": "List of checks that were paused",
           "display_as": "Triggered",
-          "default": null,
+          "type": "array"
+        },
+        "skipped": {
+          "description": "List of checks that was skipped",
+          "display_as": "Skipped",
           "type": "array"
         }
       },
@@ -153,38 +85,82 @@
       "description": "Pause checking of one or more checks"
     },
     {
-      "action": "resume",
+      "action": "goss_validate",
+      "description": "Performs a Goss validation using a specific file",
+      "display": "failed",
+      "aggregate": [
+        {
+          "function": "summary",
+          "args": [
+            "tests",
+            {"format":  "%s Tests on %d node(s)"}
+          ]
+        },
+        {
+          "function": "summary",
+          "args": [
+            "failures",
+            {"format":  "%s Failed test on %d node(s)"}
+          ]
+        },
+        {
+          "function": "summary",
+          "args": [
+            "success",
+            {"format":  "%s Passed tests on %d node(s)"}
+          ]
+        }
+      ],
       "input": {
-        "checks": {
-          "prompt": "Checks",
-          "description": "Check to resume, empty means all",
-          "type": "array",
-          "default": null,
+        "file": {
+          "prompt": "Goss File",
+          "description": "Path to the Goss validation specification",
+          "type": "string",
+          "maxlength": 256,
+          "validation": ".+",
+          "optional": false
+        },
+        "vars": {
+          "prompt": "Vars File",
+          "description": "Path to a file to use as template variables",
+          "type": "string",
+          "maxlength": 256,
+          "validation": ".+",
           "optional": true
         }
       },
       "output": {
-        "failed": {
-          "description": "List of checks that could not be resumed",
-          "display_as": "Failed",
-          "default": null,
-          "type": "array"
+        "tests": {
+          "description": "The number of tests that were run",
+          "display_as": "Tests",
+          "type": "integer"
         },
-        "skipped": {
-          "description": "List of checks that was skipped",
-          "display_as": "Skipped",
-          "default": null,
-          "type": "array"
+        "failures": {
+          "description": "The number of tests that failed",
+          "display_as": "Failed Tests",
+          "type": "integer"
         },
-        "transitioned": {
-          "description": "List of checks that were resumed",
-          "display_as": "Triggered",
-          "default": null,
+        "runtime": {
+          "description": "The time it took to run the tests, in seconds",
+          "display_as": "Runtime",
+          "type": "integer"
+        },
+        "success": {
+          "description": "Indicates if the test passed",
+          "display_as": "Success",
+          "type": "string"
+        },
+        "summary": {
+          "description": "A human friendly test result",
+          "display_as": "Summary",
+          "type": "string"
+        },
+        "results": {
+          "description": "The full test results",
+          "display_as": "Results",
           "type": "array"
         }
-      },
-      "display": "failed",
-      "description": "Resume active checking of one or more checks"
+      }
     },
     {
       "action": "trigger",
@@ -193,7 +169,6 @@
           "prompt": "Checks",
           "description": "Check to trigger, empty means all",
           "type": "array",
-          "default": null,
           "optional": true
         }
       },
@@ -201,19 +176,16 @@
         "failed": {
           "description": "List of checks that could not be triggered",
           "display_as": "Failed",
-          "default": null,
-          "type": "array"
-        },
-        "skipped": {
-          "description": "List of checks that was skipped",
-          "display_as": "Skipped",
-          "default": null,
           "type": "array"
         },
         "transitioned": {
           "description": "List of checks that were triggered",
           "display_as": "Triggered",
-          "default": null,
+          "type": "array"
+        },
+        "skipped": {
+          "description": "List of checks that was skipped",
+          "display_as": "Skipped",
           "type": "array"
         }
       },
@@ -221,4 +193,4 @@
       "description": "Force an immediate check of one or more checks"
     }
   ]
-}
+}

data/lib/mcollective/application/facts.rb

@@ -1,71 +1,6 @@
 class MCollective::Application::Facts < MCollective::Application # rubocop:disable Style/ClassAndModuleChildren
   description "Reports on usage for a specific fact"
 
-  def post_option_parser(configuration)
-    configuration[:fact] = ARGV.shift unless ARGV.empty?
-  end
-
-  def validate_configuration(configuration)
-    raise "Please specify a fact to report for" unless configuration.include?(:fact)
-  end
-
-  def show_single_fact_report(fact, facts, verbose=false)
-    puts("Report for fact: #{fact}\n\n")
-
-    facts = stringify_facts_hash(facts)
-
-    field_size = MCollective::Util.field_size(facts.keys)
-    facts.keys.sort.each do |k|
-      printf("        %-#{field_size}s found %d times\n", k, facts[k].size)
-
-      next unless verbose
-
-      puts
-
-      facts[k].sort.each do |f|
-        puts("            #{f}")
-      end
-
-      puts
-    end
-  end
-
-  def stringify_facts_hash(facts)
-    res = Hash.new([])
-    facts.each { |k, v| res[k.to_s] += v }
-    res
-  end
-
-  def main
-    rpcutil = rpcclient("rpcutil")
-    rpcutil.progress = false
-
-    facts = {}
-
-    rpcutil.get_fact(:fact => configuration[:fact]) do |resp|
-      begin
-        value = resp[:body][:data][:value].to_s
-
-        if resp[:body][:data].include?(:value)
-          if facts.include?(value)
-            facts[value] << resp[:senderid]
-          else
-            facts[value] = [resp[:senderid]]
-          end
-        end
-      rescue Exception => e # rubocop:disable Lint/RescueException
-        warn "Could not parse facts for #{resp[:senderid]}: #{e.class}: #{e}"
-      end
-    end
-
-    if facts.empty?
-      puts "No values found for fact #{configuration[:fact]}\n"
-    else
-      show_single_fact_report(configuration[:fact], facts, options[:verbose])
-    end
-
-    printrpcstats
-
-    halt rpcutil.stats
-  end
+  external(:command => "choria", :args => ["facts"])
+  external_help(:command => "choria", :args => ["facts", "--help"])
 end

data/lib/mcollective/application/find.rb

@@ -16,7 +16,7 @@ class MCollective::Application::Find < MCollective::Application # rubocop:disabl
 
     nodes.each {|c| puts c}
 
-    warn "\nDiscovered %s nodes in %.2f seconds using the %s discovery plugin" % [nodes.size, discoverytime, mc.client.discoverer.discovery_method] if options[:verbose]
+    warn "\nDiscovered %s nodes in %.2f seconds using the %s discovery plugin" % [nodes.size, discoverytime, mc.client.options[:discovery_method]] if options[:verbose]
 
     !nodes.empty? ? exit(0) : exit(1)
   end

data/lib/mcollective/application/plugin.rb

@@ -8,19 +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 data <pluginname> [outputs=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"],
@@ -67,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
 
@@ -81,46 +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 :outputs,
-           :description => "Outputs to be generated for an Data Plugin",
-           :arguments => ["--outputs [OUTPUTS]"],
-           :type => Array
-
     option :keep_artifacts,
            :description => "Don't remove artifacts after building packages",
            :arguments => ["--keep-artifacts"],
@@ -137,59 +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' and 'data'" 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])
-      when "data"
-        raise "data plugin must have at least one output" unless configuration[:outputs]
-
-        Generators::DataGenerator.new(configuration[:pluginname], configuration[:outputs], 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
@@ -223,76 +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],
-        ["Data Queries", :data],
-        ["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]
+    def doc_command
+      puts "WARNING: mco plugin doc is deprecated, please use choria plugin doc"
 
-          PluginManager.find(plugin_type[1], "ddl").each do |ddlf|
-            begin
-              help = DDL.new(ddlf, plugin_type[1], false)
-
-              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.
@@ -345,7 +192,7 @@ mco plugin package [options] <directory>
     # Return the name of the type of plugin as a string
     def identify_plugin
       plugintype = Dir.glob(File.join(configuration[:target], "*")).select do |file|
-        File.directory?(file) && file.match(/(connector|facts|registration|security|audit|pluginpackager|data|discovery|validator)/)
+        File.directory?(file) && file.match(/(connector|facts|registration|security|audit|pluginpackager|discovery|validator)/)
       end
 
       raise "more than one plugin type detected in directory" if plugintype.size > 1
@@ -354,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)