choria-mcorpc-support 2.23.1 → 2.24.2

data/lib/mcollective/discovery/delegate.rb

@@ -0,0 +1,73 @@
+module MCollective
+  class Discovery
+    class Delegate
+      def self.binary_name
+        "choria"
+      end
+
+      def self.discover(filter, timeout, limit, client)
+        raise("Cannot find the choria binary in your path") unless Util.command_in_path?("choria")
+
+        cmd = [binary_name, "discover", "-j", "--silent"]
+
+        cmd << "-T" << filter["collective"] if filter["collective"]
+
+        filter.fetch("identity", []).each do |i|
+          cmd << "-I" << i
+        end
+
+        filter.fetch("cf_class", []).each do |c|
+          cmd << "-C" << c
+        end
+
+        filter.fetch("fact", []).each do |f|
+          cmd << "-F" << "%s%s%s" % [f[:fact], f[:operator], f[:value]]
+        end
+
+        filter.fetch("agent", []).each do |a|
+          cmd << "-A" << a
+        end
+
+        filter.fetch("compound", []).each do |c|
+          next unless c.is_a?(Array)
+
+          cmd << "-S" << c.first["expr"]
+        end
+
+        client.options.fetch(:discovery_options, []).each do |opt|
+          cmd << "--do" << opt
+        end
+
+        cmd << "--dm" << (client.options.fetch(:discovery_method, "broadcast") rescue "broadcast")
+
+        run_discover(cmd, timeout)
+      end
+
+      def self.run_discover(cmd, timeout)
+        nodes = []
+
+        Log.debug("Executing choria for discovery using: %s" % cmd.join(" "))
+
+        Open3.popen3(ENV, *cmd) do |stdin, stdout, stderr, wait_thr|
+          stdin.close
+
+          begin
+            Timeout.timeout(timeout + 0.5) do
+              status = wait_thr.value
+
+              raise("Choria discovery failed: %s" % stderr.read) unless status.exitstatus == 0
+            end
+          rescue Timeout::Error
+            Log.warn("Timeout waiting for Choria to perform discovery")
+            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
+      end
+    end
+  end
+end

data/lib/mcollective/discovery/external.ddl

@@ -0,0 +1,13 @@
+metadata    :name        => "external",
+            :description => "External executable based discovery",
+            :author      => "R.I.Pienaar <rip@devco.net>",
+            :license     => "Apache-2.0",
+            :version     => "0.1",
+            :url         => "https://choria.io/",
+            :timeout     => 2
+
+discovery do
+    capabilities [:classes, :facts, :identity, :agents, :compound]
+end
+
+

data/lib/mcollective/discovery/file.ddl

@@ -0,0 +1,13 @@
+metadata    :name        => "file",
+            :description => "Discovers from JSON, YAML and Text files",
+            :author      => "R.I.Pienaar <rip@devco.net>",
+            :license     => "Apache-2.0",
+            :version     => "0.1",
+            :url         => "https://choria.io/",
+            :timeout     => 2
+
+discovery do
+    capabilities [:identity]
+end
+
+

data/lib/mcollective/discovery/flatfile.ddl

@@ -1,11 +1,13 @@
 metadata    :name        => "flatfile",
-            :description => "Flatfile based discovery for node identities",
+            :description => "Discovers from JSON, YAML and Text files",
             :author      => "R.I.Pienaar <rip@devco.net>",
-            :license     => "ASL 2.0",
+            :license     => "Apache-2.0",
             :version     => "0.1",
-            :url         => "https://docs.puppetlabs.com/mcollective/",
-            :timeout     => 0
+            :url         => "https://choria.io/",
+            :timeout     => 2
 
 discovery do
-    capabilities :identity
+    capabilities [:identity]
 end
+
+

data/lib/mcollective/discovery/inventory.ddl

@@ -0,0 +1,13 @@
+metadata    :name        => "delegate",
+            :description => "Choria CLI based delegated discovery",
+            :author      => "R.I.Pienaar <rip@devco.net>",
+            :license     => "Apache 2.0",
+            :version     => "0.1",
+            :url         => "https://choria.io/",
+            :timeout     => 2
+
+discovery do
+    capabilities [:classes, :facts, :identity, :agents, :compound]
+end
+
+

data/lib/mcollective/discovery/mc.ddl

@@ -1,9 +1,9 @@
 metadata    :name        => "mc",
-            :description => "MCollective Broadcast based discovery",
+            :description => "Choria Broadcast based discovery",
             :author      => "R.I.Pienaar <rip@devco.net>",
-            :license     => "ASL 2.0",
+            :license     => "Apache-2.0",
             :version     => "0.1",
-            :url         => "https://docs.puppetlabs.com/mcollective/",
+            :url         => "https://choria.io",
             :timeout     => 2
 
 discovery do

data/lib/mcollective/generators.rb

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

data/lib/mcollective/optionparser.rb

@@ -168,7 +168,7 @@ module MCollective
         raise "Cannot read the discovery file #{v}" unless File.readable?(v)
 
         @options[:discovery_method] = "flatfile"
-        @options[:discovery_options] << v
+        @options[:discovery_options] << "file=%s" % v
       end
 
       @parser.on("--publish_timeout TIMEOUT", Integer, "Timeout for publishing requests to remote agents.") do |pt|

data/lib/mcollective/pluginpackager/forge_packager.rb

@@ -191,7 +191,7 @@ module MCollective
       end
 
       def render_template(infile, outfile)
-        erb = ERB.new(File.read(infile), 0, "%")
+        erb = ERB.new(File.read(infile), 0, "-")
         File.open(outfile, "w") do |f|
           f.puts erb.result(binding)
         end

data/lib/mcollective/rpc/client.rb

@@ -533,6 +533,8 @@ module MCollective
 
         # All else fails we do it the hard way using a traditional broadcast
         unless @discovered_agents
+          raise("Invalid discovery method %s" % discovery_method) unless @client.discoverer.find_known_methods.include?(discovery_method)
+
           @stats.time_discovery :start
 
           @client.options = options
@@ -548,9 +550,9 @@ module MCollective
             actual_timeout = @client.discoverer.discovery_timeout(discovery_timeout, options[:filter])
 
             if actual_timeout > 0
-              @stderr.print("Discovering hosts using the %s method for %d second(s) .... " % [@client.discoverer.discovery_method, actual_timeout])
+              @stderr.print("Discovering hosts using the %s method for %d second(s) .... " % [discovery_method, actual_timeout])
             else
-              @stderr.print("Discovering hosts using the %s method .... " % [@client.discoverer.discovery_method])
+              @stderr.print("Discovering hosts using the %s method .... " % discovery_method)
             end
           end
 

data/lib/mcollective/util.rb

@@ -147,28 +147,30 @@ 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.mcollective_config_paths_for_user
+    def self.config_paths_for_user
       config_paths = []
 
-      begin
-        # File.expand_path will raise if HOME isn't set, catch it
-        user_path = File.expand_path("~/.mcollective")
-        config_paths << user_path
-      rescue Exception # rubocop:disable Lint/RescueException, Lint/SuppressedException
+      ["~/.choriarc", "~/.mcollective"].each do |f|
+        begin
+          # File.expand_path will raise if HOME isn't set, catch it
+          config_paths << File.expand_path(f)
+        rescue ArgumentError # rubocop:disable Lint/SuppressedException
+        end
       end
 
       if windows?
+        config_paths << File.join(choria_windows_prefix, "etc", "client.conf")
         config_paths << File.join(windows_prefix, "etc", "client.cfg")
       else
+        config_paths << "/etc/choria/client.conf"
+        config_paths << "/usr/local/etc/choria/client.conf"
         config_paths << "/etc/puppetlabs/mcollective/client.cfg"
         config_paths << "/etc/mcollective/client.cfg"
         config_paths << "/usr/local/etc/mcollective/client.cfg"
@@ -177,42 +179,30 @@ module MCollective
       config_paths
     end
 
-    def self.choria_config_paths_for_user
-      config_paths = []
-
-      begin
-        # File.expand_path will raise if HOME isn't set, catch it
-        user_path = File.expand_path("~/.choriarc")
-        config_paths << user_path
-      rescue Exception # rubocop:disable Lint/RescueException, Lint/SuppressedException
-      end
-
-      if windows?
-        config_paths << File.join(choria_windows_prefix, "etc", "client.conf")
-      else
-        config_paths << "/etc/choria/client.conf"
-        config_paths << "/usr/local/etc/choria/client.conf"
-      end
-
-      config_paths
-    end
-
     # Picks the default user config file, priorities are first Choria ones then old MCollective ones
     #
     # In roughly this order, first to exist is used:
     #
     # - ~/.choriarc
-    # - APPData/ChoriaIO/choria/etc/client.conf on windows
-    # - /etc/choria/client.conf then
-    # - /usr/local/etc/choria/client.conf on unix
     # - ~/.mcollective
-    # - APPData/PuppetLabs/mcollective/etc/client.cfg on windows
+    #
+    # On Unix:
+    #
+    # - /etc/choria/client.conf
+    # - /usr/local/etc/choria/client.conf
     # - /etc/puppetlabs/mcollective/client.cfg
     # - /etc/mcollective/client.cfg
     # - /usr/local/etc/mcollective/client.cfg
+    #
+    # On Windows:
+    #
+    # - APPData/ChoriaIO/choria/etc/client.conf on windows
+    # - APPData/PuppetLabs/mcollective/etc/client.cfg on windows
     def self.config_file_for_user
-      config_paths = choria_config_paths_for_user + mcollective_config_paths_for_user
+      config_paths = config_paths_for_user
+
       found = config_paths.find_index { |file| File.readable?(file) } || 0
+
       config_paths[found]
     end
 

data/lib/mcollective/util/tasks_support.rb

@@ -157,7 +157,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)
 
@@ -220,7 +220,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)
@@ -283,6 +286,7 @@ module MCollective
           if pid.nil?
             Process.gid = Process.egid = u.gid
             Process.uid = Process.euid = u.uid
+            ENV.delete_if { |name| name !~ /^LC_/ }
             Process.exec(environment, command, options)
           end
         else
@@ -568,6 +572,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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: choria-mcorpc-support
 version: !ruby/object:Gem::Version
-  version: 2.23.1
+  version: 2.24.2
 platform: ruby
 authors:
 - R.I.Pienaar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-12 00:00:00.000000000 Z
+date: 2021-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: systemu
@@ -98,34 +98,22 @@ files:
 - lib/mcollective/connector/base.rb
 - lib/mcollective/connector/nats.ddl
 - lib/mcollective/connector/nats.rb
-- lib/mcollective/data.rb
-- lib/mcollective/data/agent_data.ddl
-- lib/mcollective/data/agent_data.rb
-- lib/mcollective/data/base.rb
-- lib/mcollective/data/bolt_task_data.ddl
-- lib/mcollective/data/bolt_task_data.rb
-- lib/mcollective/data/collective_data.ddl
-- lib/mcollective/data/collective_data.rb
-- lib/mcollective/data/fact_data.ddl
-- lib/mcollective/data/fact_data.rb
-- lib/mcollective/data/fstat_data.ddl
-- lib/mcollective/data/fstat_data.rb
-- lib/mcollective/data/result.rb
 - lib/mcollective/ddl.rb
 - lib/mcollective/ddl/agentddl.rb
 - lib/mcollective/ddl/base.rb
-- lib/mcollective/ddl/dataddl.rb
 - lib/mcollective/ddl/discoveryddl.rb
 - lib/mcollective/ddl/validatorddl.rb
 - lib/mcollective/discovery.rb
+- lib/mcollective/discovery/broadcast.ddl
 - lib/mcollective/discovery/choria.ddl
-- lib/mcollective/discovery/choria.rb
+- lib/mcollective/discovery/delegate.ddl
+- lib/mcollective/discovery/delegate.rb
+- lib/mcollective/discovery/external.ddl
+- lib/mcollective/discovery/file.ddl
 - lib/mcollective/discovery/flatfile.ddl
-- lib/mcollective/discovery/flatfile.rb
+- lib/mcollective/discovery/inventory.ddl
 - lib/mcollective/discovery/mc.ddl
 - lib/mcollective/discovery/mc.rb
-- lib/mcollective/discovery/stdin.ddl
-- lib/mcollective/discovery/stdin.rb
 - lib/mcollective/exceptions.rb
 - lib/mcollective/facts.rb
 - lib/mcollective/facts/base.rb
@@ -133,9 +121,7 @@ files:
 - lib/mcollective/generators.rb
 - lib/mcollective/generators/agent_generator.rb
 - lib/mcollective/generators/base.rb
-- lib/mcollective/generators/data_generator.rb
 - lib/mcollective/generators/templates/action_snippet.erb
-- lib/mcollective/generators/templates/data_input_snippet.erb
 - lib/mcollective/generators/templates/ddl.erb
 - lib/mcollective/generators/templates/plugin.erb
 - lib/mcollective/log.rb
@@ -255,7 +241,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: Support libraries the Choria Server

data/lib/mcollective/data.rb

@@ -1,96 +0,0 @@
-module MCollective
-  module Data
-    require "mcollective/data/base"
-    require "mcollective/data/result"
-
-    def self.load_data_sources
-      PluginManager.find_and_load("data")
-
-      PluginManager.grep(/_data$/).each do |plugin|
-        begin
-          unless PluginManager[plugin].class.activate?
-            Log.debug("Disabling data plugin %s due to plugin activation policy" % plugin)
-            PluginManager.delete(plugin)
-          end
-        rescue Exception => e # rubocop:disable Lint/RescueException
-          Log.debug("Disabling data plugin %s due to exception %s: %s" % [plugin, e.class, e])
-          PluginManager.delete(plugin)
-        end
-      end
-    end
-
-    def self.pluginname(plugin)
-      plugin.to_s =~ /_data$/i ? plugin.to_s.downcase : "%s_data" % plugin.to_s.downcase
-    end
-
-    def self.[](plugin)
-      PluginManager[pluginname(plugin)]
-    end
-
-    # Data.package("httpd").architecture
-    def self.method_missing(method, *args)
-      super unless PluginManager.include?(pluginname(method))
-
-      PluginManager[pluginname(method)].lookup(args.first)
-    end
-
-    def self.respond_to_missing?(method, *)
-      PluginManager.include?(pluginname(method)) || super
-    end
-
-    def self.ddl(plugin)
-      DDL.new(pluginname(plugin), :data)
-    end
-
-    def self.ddl_validate(ddl, argument)
-      name = ddl.meta[:name]
-      query = ddl.entities[:data]
-
-      raise DDLValidationError, "No dataquery has been defined in the DDL for data plugin #{name}" unless query
-
-      input = query.fetch(:input, {})
-      output = query.fetch(:output, {})
-
-      raise DDLValidationError, "No output has been defined in the DDL for data plugin #{name}" if output.keys.empty?
-
-      if input[:query]
-        return true if argument.nil? && input[:query][:optional]
-
-        ddl.validate_input_argument(input, :query, argument)
-      else
-        raise("No data plugin argument was declared in the %s DDL but an input was supplied" % name) if argument
-
-        true
-      end
-    end
-
-    def self.ddl_has_output?(ddl, output)
-      ddl.entities[:data][:output].include?(output.to_sym) rescue false
-    end
-
-    # For an input where the DDL requests a boolean or some number
-    # this will convert the input to the right type where possible
-    # else just returns the origin input unedited
-    #
-    # if anything here goes wrong just return the input value
-    # this is not really the end of the world or anything since
-    # all that will happen is that DDL validation will fail and
-    # the user will get an error, no need to be too defensive here
-    def self.ddl_transform_input(ddl, input)
-      begin
-        type = ddl.entities[:data][:input][:query][:type]
-
-        case type
-        when :boolean
-          return DDL.string_to_boolean(input)
-
-        when :number, :integer, :float
-          return DDL.string_to_number(input)
-        end
-      rescue # rubocop:disable Lint/SuppressedException
-      end
-
-      input
-    end
-  end
-end