choria-mcorpc-support 2.24.1 → 2.25.0

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/discovery/delegate.rb

@@ -10,6 +10,9 @@ module MCollective
 
         cmd = [binary_name, "discover", "-j", "--silent"]
 
+        config = client.options.fetch(:config)
+        cmd << "--config" << config if config
+
         cmd << "-T" << filter["collective"] if filter["collective"]
 
         filter.fetch("identity", []).each do |i|
@@ -53,6 +56,7 @@ module MCollective
 
           begin
             Timeout.timeout(timeout + 0.5) do
+              nodes.concat(JSON.parse(stdout.read))
               status = wait_thr.value
 
               raise("Choria discovery failed: %s" % stderr.read) unless status.exitstatus == 0
@@ -62,8 +66,6 @@ module MCollective
             Process.kill("KILL", wait_thr[:pid])
             raise("Choria failed to complete discovery within %d timeout" % timeout)
           end
-
-          nodes.concat(JSON.parse(stdout.read))
         end
 
         nodes

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

@@ -65,7 +65,7 @@ module MCollective
       # AIO path to binaries like wrappers etc
       def aio_bin_path
         if Util.windows?
-          'C:\Program Files\Puppet Labs\Puppet\bin'
+          'C:\Program Files\Puppet Labs\Puppet\puppet\bin'
         else
           "/opt/puppetlabs/puppet/bin"
         end
@@ -88,6 +88,13 @@ module MCollective
         end
       end
 
+      # Is this an AIO install?
+      #
+      # @return [Boolean]
+      def aio?
+        File.directory?(aio_bin_path)
+      end
+
       # Path to the task wrapper executable
       #
       # @return [String]
@@ -157,7 +164,7 @@ module MCollective
       # @return [String] path to the command
       def task_command(spooldir, task)
         file_spec = task["files"][0]
-        file_name = File.join(spooldir, "files", file_spec["filename"])
+        file_name = File.join(spooldir, "files", task_module(task["task"]), "tasks", file_spec["filename"])
 
         command = platform_specific_command(file_name)
 
@@ -179,6 +186,8 @@ module MCollective
           "_choria_task_caller" => task_caller
         }
 
+        environment["PATH"] = "#{aio_bin_path}#{File::PATH_SEPARATOR}#{ENV['PATH']}" if aio?
+
         return environment unless task["input"]
         return environment unless ["both", "environment"].include?(task_input_method(task))
 
@@ -186,6 +195,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
@@ -220,7 +230,10 @@ module MCollective
       # @param task [Hash] task specification
       def populate_spooldir(spooldir, task)
         task["files"].each do |file|
-          spool_filename = File.join(spooldir, "files", file["filename"])
+          filename = file["filename"]
+          filename = File.join(task_module(task["task"]), "tasks", filename) unless filename.index("/")
+
+          spool_filename = File.join(spooldir, "files", filename)
 
           FileUtils.mkdir_p(File.dirname(spool_filename), :mode => 0o0750)
           FileUtils.cp(task_file_name(file), spool_filename)
@@ -246,7 +259,7 @@ module MCollective
       # act on these tasks either by asking for their status or perhaps killing
       # them?
       #
-      # @param command [Array<String>] command to run
+      # @param command [String] command to run
       # @param environment [Hash] environment to run with
       # @param stdin [String] stdin to send to the command
       # @param spooldir [String] path to the spool for this specific request
@@ -287,7 +300,7 @@ module MCollective
             Process.exec(environment, command, options)
           end
         else
-          pid = Process.spawn(environment, command, options)
+          pid = Process.spawn(environment, [command, command], options)
         end
 
         sleep 0.1 until File.exist?(wrapper_stdout)
@@ -569,6 +582,15 @@ module MCollective
         parts
       end
 
+      # Return a task's module
+      #
+      # @param task [String]
+      # @return [String] the module name
+      # @raise [StandardError] for invalid task names
+      def task_module(task)
+        parse_task(task)[0]
+      end
+
       # Determines the cache path for a task file
       #
       # @param file [Hash] a file hash as per the task metadata

data/lib/mcollective/util.rb

@@ -147,13 +147,11 @@ module MCollective
 
     # Returns the PuppetLabs mcollective path for windows
     def self.windows_prefix
-      require "win32/dir"
-      File.join(Dir::COMMON_APPDATA, "PuppetLabs", "choria")
+      File.join(ENV["ALLUSERSPROFILE"], "PuppetLabs", "choria")
     end
 
     def self.choria_windows_prefix
-      require "win32/dir"
-      File.join(Dir::COMMON_APPDATA, "ChoriaIO", "choria")
+      File.join(ENV["ALLUSERSPROFILE"], "choria")
     end
 
     def self.config_paths_for_user