choria-mcorpc-support 2.23.3 → 2.24.4

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)
 

data/lib/mcollective/client.rb

@@ -150,7 +150,7 @@ module MCollective
     # of the discovery being cancelled soon as it reached the
     # requested limit of hosts
     def discover(filter, timeout, limit=0)
-      @discoverer.discover(filter.merge("collective" => collective), timeout, limit)
+      @discoverer.discover(filter.merge("collective" => collective), timeout, limit, self)
     end
 
     # Send a request, performs the passed block for each response

data/lib/mcollective/config.rb

@@ -17,123 +17,132 @@ module MCollective
       @configured = false
     end
 
-    def loadconfig(configfile) # rubocop:disable Metrics/MethodLength
-      set_config_defaults(configfile)
+    def parse_config_file(configfile, libdirs) # rubocop:disable Metrics/MethodLength
+      File.readlines(configfile).each do |line|
+        # strip blank spaces, tabs etc off the end of all lines
+        line.gsub!(/\s*$/, "")
 
-      if File.exist?(configfile)
-        libdirs = []
-        File.readlines(configfile).each do |line|
-          # strip blank spaces, tabs etc off the end of all lines
-          line.gsub!(/\s*$/, "")
+        next if line =~ /^#|^$/
+        next unless line =~ /(.+?)\s*=\s*(.+)/
 
-          next if line =~ /^#|^$/
-          next unless line =~ /(.+?)\s*=\s*(.+)/
+        key = $1.strip
+        val = $2
 
-          key = $1.strip
-          val = $2
+        begin
+          case key
+          when "collectives"
+            @collectives = val.split(",").map(&:strip)
+          when "main_collective"
+            @main_collective = val
+          when "logfile"
+            @logfile = val
+          when "keeplogs"
+            @keeplogs = Integer(val)
+          when "max_log_size"
+            @max_log_size = Integer(val)
+          when "loglevel"
+            @loglevel = val
+          when "logfacility"
+            @logfacility = val
+          when "libdir"
+            paths = val.split(File::PATH_SEPARATOR)
+            paths.each do |path|
+              raise("libdir paths should be absolute paths but '%s' is relative" % path) unless Util.absolute_path?(path)
 
-          begin
-            case key
-            when "collectives"
-              @collectives = val.split(",").map(&:strip)
-            when "main_collective"
-              @main_collective = val
-            when "logfile"
-              @logfile = val
-            when "keeplogs"
-              @keeplogs = Integer(val)
-            when "max_log_size"
-              @max_log_size = Integer(val)
-            when "loglevel"
-              @loglevel = val
-            when "logfacility"
-              @logfacility = val
-            when "libdir"
-              paths = val.split(File::PATH_SEPARATOR)
-              paths.each do |path|
-                raise("libdir paths should be absolute paths but '%s' is relative" % path) unless Util.absolute_path?(path)
-
-                libdirs << path
-              end
-            when "identity"
-              @identity = val
-            when "direct_addressing"
-              @direct_addressing = Util.str_to_bool(val)
-            when "direct_addressing_threshold"
-              @direct_addressing_threshold = Integer(val)
-            when "color"
-              @color = Util.str_to_bool(val)
-            when "daemonize"
-              @daemonize = Util.str_to_bool(val)
-            when "securityprovider"
-              @securityprovider = val.capitalize
-            when "factsource"
-              @factsource = val.capitalize
-            when "connector"
-              @connector = val.capitalize
-            when "classesfile"
-              @classesfile = val
-            when /^plugin.(.+)$/
-              @pluginconf[$1] = val
-            when "discovery_timeout"
-              @discovery_timeout = Integer(val)
-            when "publish_timeout"
-              @publish_timeout = Integer(val)
-            when "connection_timeout"
-              @connection_timeout = Integer(val)
-            when "rpcaudit"
-              @rpcaudit = Util.str_to_bool(val)
-            when "rpcauditprovider"
-              @rpcauditprovider = val.capitalize
-            when "rpcauthorization"
-              @rpcauthorization = Util.str_to_bool(val)
-            when "rpcauthprovider"
-              @rpcauthprovider = val.capitalize
-            when "rpclimitmethod"
-              @rpclimitmethod = val.to_sym
-            when "logger_type"
-              @logger_type = val
-            when "fact_cache_time"
-              @fact_cache_time = Integer(val)
-            when "ssl_cipher"
-              @ssl_cipher = val
-            when "threaded"
-              @threaded = Util.str_to_bool(val)
-            when "ttl"
-              @ttl = Integer(val)
-            when "default_discovery_options"
-              @default_discovery_options << val
-            when "default_discovery_method"
-              @default_discovery_method = val
-            when "soft_shutdown"
-              @soft_shutdown = Util.str_to_bool(val)
-            when "soft_shutdown_timeout"
-              @soft_shutdown_timeout = Integer(val)
-            when "activate_agents"
-              @activate_agents = Util.str_to_bool(val)
-            when "default_batch_size"
-              @default_batch_size = Integer(val)
-            when "default_batch_sleep_time"
-              @default_batch_sleep_time = Float(val)
-            else
-              # server config might now be choria config which will divirge from mcollective
-              # in time, so we only raise this error when it looks like we aren't loading
-              # a server config else we try our best to load as much as we can
-              raise("Unknown config parameter '#{key}'") unless configfile =~ /server/
+              libdirs << path
             end
-          rescue ArgumentError
-            raise("Could not parse value for configuration option '%s' with value '%s'" % [key, val])
+          when "identity"
+            @identity = val
+          when "direct_addressing"
+            @direct_addressing = Util.str_to_bool(val)
+          when "direct_addressing_threshold"
+            @direct_addressing_threshold = Integer(val)
+          when "color"
+            @color = Util.str_to_bool(val)
+          when "daemonize"
+            @daemonize = Util.str_to_bool(val)
+          when "securityprovider"
+            @securityprovider = val.capitalize
+          when "factsource"
+            @factsource = val.capitalize
+          when "connector"
+            @connector = val.capitalize
+          when "classesfile"
+            @classesfile = val
+          when /^plugin.(.+)$/
+            @pluginconf[$1] = val
+          when "discovery_timeout"
+            @discovery_timeout = Integer(val)
+          when "publish_timeout"
+            @publish_timeout = Integer(val)
+          when "connection_timeout"
+            @connection_timeout = Integer(val)
+          when "rpcaudit"
+            @rpcaudit = Util.str_to_bool(val)
+          when "rpcauditprovider"
+            @rpcauditprovider = val.capitalize
+          when "rpcauthorization"
+            @rpcauthorization = Util.str_to_bool(val)
+          when "rpcauthprovider"
+            @rpcauthprovider = val.capitalize
+          when "rpclimitmethod"
+            @rpclimitmethod = val.to_sym
+          when "logger_type"
+            @logger_type = val
+          when "fact_cache_time"
+            @fact_cache_time = Integer(val)
+          when "ssl_cipher"
+            @ssl_cipher = val
+          when "threaded"
+            @threaded = Util.str_to_bool(val)
+          when "ttl"
+            @ttl = Integer(val)
+          when "default_discovery_options"
+            @default_discovery_options << val
+          when "default_discovery_method"
+            @default_discovery_method = val
+          when "soft_shutdown"
+            @soft_shutdown = Util.str_to_bool(val)
+          when "soft_shutdown_timeout"
+            @soft_shutdown_timeout = Integer(val)
+          when "activate_agents"
+            @activate_agents = Util.str_to_bool(val)
+          when "default_batch_size"
+            @default_batch_size = Integer(val)
+          when "default_batch_sleep_time"
+            @default_batch_sleep_time = Float(val)
+          else
+            # server config might now be choria config which will divirge from mcollective
+            # in time, so we only raise this error when it looks like we aren't loading
+            # a server config else we try our best to load as much as we can
+            raise("Unknown config parameter '#{key}'") unless configfile =~ /server/
           end
+        rescue ArgumentError
+          raise("Could not parse value for configuration option '%s' with value '%s'" % [key, val])
         end
+      end
+    end
+
+    def loadconfig(configfile)
+      set_config_defaults(configfile)
+
+      if File.exist?(configfile)
+        libdirs = []
+
+        parse_config_file(configfile, libdirs)
 
         read_plugin_config_dir("#{@configdir}/plugin.d")
 
-        raise 'Identities can only match /\w\.\-/' unless @identity =~ /^[\w.\-]+$/
+        parse_project_config(libdirs)
+
+        raise('Identities can only match /\w\.\-/') unless @identity =~ /^[\w.\-]+$/
+
+        check_deprecations
 
         @configured = true
 
         libdirs.each do |dir|
-          Log.debug("Cannot find libdir: #{dir}") unless File.directory?(dir)
+          Log.debug("Cannot find libdir: %s" % dir) unless File.directory?(dir)
 
           # remove the old one if it exists, we're moving it to the front
           $LOAD_PATH.reject! { |elem| elem == dir }
@@ -154,6 +163,31 @@ module MCollective
       end
     end
 
+    def project_root
+      Dir.pwd
+    end
+
+    def parse_project_config(libdirs)
+      project_config_files(project_root).each do |pfile|
+        parse_config_file(pfile, libdirs)
+      end
+    end
+
+    def project_config_files(path)
+      paths = []
+
+      path = File.expand_path(path)
+      parent = File.expand_path("..", path)
+
+      paths << project_config_files(parent) if parent != path
+
+      config = File.join(path, "choria.conf")
+
+      paths << config if File.exist?(config)
+
+      paths.flatten
+    end
+
     def set_config_defaults(configfile) # rubocop:disable Naming/AccessorMethodName
       @subscribe = []
       @pluginconf = {}
@@ -222,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