choria-mcorpc-support 2.21.1 → 2.23.1

data/lib/mcollective/validator.rb

@@ -30,7 +30,7 @@ module MCollective
     end
 
     # Allows validation plugins to be called like module methods : Validator.validate()
-    def self.method_missing(method, *args, &block) # rubocop:disable Style/MethodMissing
+    def self.method_missing(method, *args, &block)
       if has_validator?(method)
         Validator[method].validate(*args)
       else
@@ -38,6 +38,10 @@ module MCollective
       end
     end
 
+    def self.respond_to_missing?(method, *)
+      has_validator?(method)
+    end
+
     def self.has_validator?(validator)
       const_defined?(validator_class(validator))
     end
@@ -48,6 +52,7 @@ module MCollective
 
     def self.load_validators?
       return true if @last_load.nil?
+
       (@last_load - Time.now.to_i) > 300
     end
 

data/lib/mcollective/validator/bolt_task_name_validator.ddl

@@ -0,0 +1,7 @@
+metadata    :name => "bolt_task_name",
+            :description => "Validates that a string matches Bolt Task Name",
+            :author => "R.I.Pienaar <rip@devco.net>",
+            :license => "Apache-2.0",
+            :version => "0.19.0",
+            :url => "https://choria.io",
+            :timeout => 1

data/lib/mcollective/validator/bolt_task_name_validator.rb

@@ -0,0 +1,11 @@
+module MCollective
+  module Validator
+    class Bolt_task_nameValidator
+      def self.validate(name)
+        Validator.typecheck(name, :string)
+
+        raise("'%s' is not a valid Bolt Task name" % name) unless name =~ /\A([a-z][a-z0-9_]*)?(::[a-z][a-z0-9_]*)*\Z/
+      end
+    end
+  end
+end

data/lib/mcollective/validator/length_validator.rb

@@ -2,9 +2,7 @@ module MCollective
   module Validator
     class LengthValidator
       def self.validate(validator, length)
-        if (validator.size > length) && (length > 0)
-          raise ValidatorError, "Input string is longer than #{length} character(s)"
-        end
+        raise ValidatorError, "Input string is longer than #{length} character(s)" if (validator.size > length) && (length > 0)
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: choria-mcorpc-support
 version: !ruby/object:Gem::Version
-  version: 2.21.1
+  version: 2.23.1
 platform: ruby
 authors:
 - R.I.Pienaar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-07 00:00:00.000000000 Z
+date: 2021-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: systemu
@@ -54,7 +54,15 @@ files:
 - bin/mco
 - lib/mcollective.rb
 - lib/mcollective/agent.rb
+- lib/mcollective/agent/bolt_tasks.ddl
+- lib/mcollective/agent/bolt_tasks.json
+- lib/mcollective/agent/bolt_tasks.rb
+- lib/mcollective/agent/choria_util.ddl
+- lib/mcollective/agent/choria_util.json
 - lib/mcollective/agent/rpcutil.ddl
+- lib/mcollective/agent/rpcutil.json
+- lib/mcollective/agent/scout.ddl
+- lib/mcollective/agent/scout.json
 - lib/mcollective/agents.rb
 - lib/mcollective/aggregate.rb
 - lib/mcollective/aggregate/average.ddl
@@ -69,25 +77,33 @@ files:
 - lib/mcollective/aggregate/summary.ddl
 - lib/mcollective/aggregate/summary.rb
 - lib/mcollective/application.rb
+- lib/mcollective/application/choria.rb
 - lib/mcollective/application/completion.rb
-- lib/mcollective/application/describe_filter.rb
 - lib/mcollective/application/facts.rb
+- lib/mcollective/application/federation.rb
 - lib/mcollective/application/find.rb
 - lib/mcollective/application/help.rb
 - lib/mcollective/application/inventory.rb
 - lib/mcollective/application/ping.rb
+- lib/mcollective/application/playbook.rb
 - lib/mcollective/application/plugin.rb
 - lib/mcollective/application/rpc.rb
+- lib/mcollective/application/tasks.rb
 - lib/mcollective/applications.rb
+- lib/mcollective/audit/choria.rb
 - lib/mcollective/cache.rb
 - lib/mcollective/client.rb
 - lib/mcollective/config.rb
 - lib/mcollective/connector.rb
 - 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
@@ -102,6 +118,8 @@ files:
 - lib/mcollective/ddl/discoveryddl.rb
 - lib/mcollective/ddl/validatorddl.rb
 - lib/mcollective/discovery.rb
+- lib/mcollective/discovery/choria.ddl
+- lib/mcollective/discovery/choria.rb
 - lib/mcollective/discovery/flatfile.ddl
 - lib/mcollective/discovery/flatfile.rb
 - lib/mcollective/discovery/mc.ddl
@@ -126,9 +144,6 @@ files:
 - lib/mcollective/logger/console_logger.rb
 - lib/mcollective/logger/file_logger.rb
 - lib/mcollective/logger/syslog_logger.rb
-- lib/mcollective/matcher.rb
-- lib/mcollective/matcher/parser.rb
-- lib/mcollective/matcher/scanner.rb
 - lib/mcollective/message.rb
 - lib/mcollective/monkey_patches.rb
 - lib/mcollective/optionparser.rb
@@ -158,12 +173,56 @@ files:
 - lib/mcollective/runnerstats.rb
 - lib/mcollective/security.rb
 - lib/mcollective/security/base.rb
+- lib/mcollective/security/choria.rb
 - lib/mcollective/shell.rb
+- lib/mcollective/signer/base.rb
+- lib/mcollective/signer/choria.rb
 - lib/mcollective/ssl.rb
 - lib/mcollective/util.rb
+- lib/mcollective/util/bolt_support.rb
+- lib/mcollective/util/bolt_support/plan_runner.rb
+- lib/mcollective/util/bolt_support/task_result.rb
+- lib/mcollective/util/bolt_support/task_results.rb
+- lib/mcollective/util/choria.rb
+- lib/mcollective/util/indifferent_hash.rb
+- lib/mcollective/util/natswrapper.rb
+- lib/mcollective/util/playbook.rb
+- lib/mcollective/util/playbook/data_stores.rb
+- lib/mcollective/util/playbook/data_stores/base.rb
+- lib/mcollective/util/playbook/data_stores/consul_data_store.rb
+- lib/mcollective/util/playbook/data_stores/environment_data_store.rb
+- lib/mcollective/util/playbook/data_stores/etcd_data_store.rb
+- lib/mcollective/util/playbook/data_stores/file_data_store.rb
+- lib/mcollective/util/playbook/data_stores/shell_data_store.rb
+- lib/mcollective/util/playbook/inputs.rb
+- lib/mcollective/util/playbook/nodes.rb
+- lib/mcollective/util/playbook/nodes/mcollective_nodes.rb
+- lib/mcollective/util/playbook/nodes/pql_nodes.rb
+- lib/mcollective/util/playbook/nodes/shell_nodes.rb
+- lib/mcollective/util/playbook/nodes/terraform_nodes.rb
+- lib/mcollective/util/playbook/nodes/yaml_nodes.rb
+- lib/mcollective/util/playbook/playbook_logger.rb
+- lib/mcollective/util/playbook/puppet_logger.rb
+- lib/mcollective/util/playbook/report.rb
+- lib/mcollective/util/playbook/task_result.rb
+- lib/mcollective/util/playbook/tasks.rb
+- lib/mcollective/util/playbook/tasks/base.rb
+- lib/mcollective/util/playbook/tasks/graphite_event_task.rb
+- lib/mcollective/util/playbook/tasks/mcollective_task.rb
+- lib/mcollective/util/playbook/tasks/shell_task.rb
+- lib/mcollective/util/playbook/tasks/slack_task.rb
+- lib/mcollective/util/playbook/tasks/webhook_task.rb
+- lib/mcollective/util/playbook/template_util.rb
+- lib/mcollective/util/playbook/uses.rb
+- lib/mcollective/util/tasks_support.rb
+- lib/mcollective/util/tasks_support/cli.rb
+- lib/mcollective/util/tasks_support/default_formatter.rb
+- lib/mcollective/util/tasks_support/json_formatter.rb
 - lib/mcollective/validator.rb
 - lib/mcollective/validator/array_validator.ddl
 - lib/mcollective/validator/array_validator.rb
+- lib/mcollective/validator/bolt_task_name_validator.ddl
+- lib/mcollective/validator/bolt_task_name_validator.rb
 - lib/mcollective/validator/ipv4address_validator.ddl
 - lib/mcollective/validator/ipv4address_validator.rb
 - lib/mcollective/validator/ipv6address_validator.ddl

data/lib/mcollective/application/describe_filter.rb

@@ -1,87 +0,0 @@
-module MCollective
-  class Application::Describe_filter<Application
-    exclude_argument_sections "common", "rpc"
-
-    description "Display human readable interpretation of filters"
-
-    usage "mco describe_filter -S <filter> -F <filter> -C <filter>"
-
-    def describe_s_filter(stack)
-      indent = "  "
-      old_indent = "  "
-      puts "-S Query expands to the following instructions:"
-      puts
-      stack.each do |token|
-        if token.keys[0] == "statement"
-          if token.values[0] =~ /(<=|>=|=|=~|=)/
-            op = $1
-            k,v = token.values[0].split(op)
-            puts indent + get_fact_string(k, v, op)
-          else
-            puts indent + get_class_string(token.values[0])
-          end
-        elsif token.keys[0] == "fstatement"
-          v = token.values[0]
-          result_string = indent + "Execute the Data Query '#{v["name"]}'"
-          if v["params"]
-            result_string += " with parameters (#{v["params"]})"
-          end
-          result_string += ". "
-          result_string += "Check if the query's '#{v["value"]}' value #{v["operator"]} '#{v["r_compare"]}'  "
-          puts result_string
-        elsif token.keys[0] == "("
-          puts indent + "("
-          old_indent = indent
-          indent *= 2
-        elsif token.keys[0] == ")"
-          indent = old_indent
-          puts indent + ")"
-        else
-          puts indent + token.keys[0].upcase
-        end
-      end
-    end
-
-    def describe_f_filter(facts)
-      puts "-F filter expands to the following fact comparisons:"
-      puts
-      facts.each do |f|
-        puts "  " + get_fact_string(f[:fact], f[:value], f[:operator])
-      end
-    end
-
-    def describe_c_filter(classes)
-      puts "-C filter expands to the following class checks:"
-      puts
-      classes.each do |c|
-        puts "  " + get_class_string(c)
-      end
-    end
-
-    def main
-      if !(@options[:filter]["fact"].empty?)
-        describe_f_filter(@options[:filter]["fact"])
-        puts
-      end
-
-      if !(@options[:filter]["cf_class"].empty?)
-        describe_c_filter(@options[:filter]["cf_class"])
-        puts
-      end
-
-      if !(@options[:filter]["compound"].empty?)
-        describe_s_filter(@options[:filter]["compound"][0])
-        puts
-      end
-    end
-
-    private
-    def get_fact_string(fact, value, op)
-      "Check if fact '#{fact}' #{op} '#{value}'"
-    end
-
-    def get_class_string(classname)
-      "Check if class '#{classname}' is present on the host"
-    end
-  end
-end

data/lib/mcollective/matcher.rb

@@ -1,220 +0,0 @@
-module MCollective
-  # A parser and scanner that creates a stack machine for a simple
-  # fact and class matching language used on the CLI to facilitate
-  # a rich discovery language
-  #
-  # Language EBNF
-  #
-  # compound = ["("] expression [")"] {["("] expression [")"]}
-  # expression = [!|not]statement ["and"|"or"] [!|not] statement
-  # char = A-Z | a-z | < | > | => | =< | _ | - |* | / { A-Z | a-z | < | > | => | =< | _ | - | * | / | }
-  # int = 0|1|2|3|4|5|6|7|8|9{|0|1|2|3|4|5|6|7|8|9|0}
-  module Matcher
-    require "mcollective/matcher/parser"
-    require "mcollective/matcher/scanner"
-
-    # Helper creates a hash from a function call string
-    def self.create_function_hash(function_call)
-      func_hash = {}
-      f = ""
-      func_parts = function_call.split(/(!=|>=|<=|<|>|=)/)
-      func_hash["r_compare"] = func_parts.pop
-      func_hash["operator"] = func_parts.pop
-      func = func_parts.join
-
-      # Deal with dots in function parameters and functions without dot values
-      if func =~ /^.+\(.*\)$/
-        f = func
-      else
-        func_parts = func.split(".")
-        func_hash["value"] = func_parts.pop
-        f = func_parts.join(".")
-      end
-
-      # Deal with regular expression matches
-      if func_hash["r_compare"] =~ /^\/.*\/$/
-        func_hash["operator"] = "=~" if func_hash["operator"] == "="
-        func_hash["operator"] = "!=~" if func_hash["operator"] == "!="
-        func_hash["r_compare"] = Regexp.new(func_hash["r_compare"].gsub(/^\/|\/$/, ""))
-      # Convert = operators to == so they can be propperly evaluated
-      elsif func_hash["operator"] == "="
-        func_hash["operator"] = "=="
-      end
-
-      # Grab function name and parameters from left compare string
-      func_hash["name"], func_hash["params"] = f.split("(")
-      if func_hash["params"] == ")"
-        func_hash["params"] = nil
-      else
-
-        # Walk the function parameters from the front and from the
-        # back removing the first and last instances of single of
-        # double qoutes. We do this to handle the case where params
-        # contain escaped qoutes.
-        func_hash["params"] = func_hash["params"].gsub(")", "")
-        func_quotes = func_hash["params"].split(/('|")/)
-
-        func_quotes.each_with_index do |item, i|
-          if item =~ /'|"/
-            func_quotes.delete_at(i)
-            break
-          end
-        end
-
-        func_quotes.reverse.each_with_index do |item, i|
-          if item =~ /'|"/
-            func_quotes.delete_at(func_quotes.size - i - 1)
-            break
-          end
-        end
-
-        func_hash["params"] = func_quotes.join
-      end
-
-      func_hash
-    end
-
-    # Returns the result of an executed function
-    def self.execute_function(function_hash)
-      # In the case where a data plugin isn't present there are two ways we can handle
-      # the raised exception. The function result can either be false or the entire
-      # expression can fail.
-      #
-      # In the case where we return the result as false it opens us op to unexpected
-      # negation behavior.
-      #
-      #   !foo('bar').name = bar
-      #
-      # In this case the user would expect discovery to match on all machines where
-      # the name value of the foo function does not equal bar. If a non existent function
-      # returns false then it is posible to match machines where the name value of the
-      # foo function is bar.
-      #
-      # Instead we raise a DDLValidationError to prevent this unexpected behavior from
-      # happening.
-
-      result = Data.send(function_hash["name"], function_hash["params"])
-
-      if function_hash["value"]
-        begin
-          eval_result = result.send(function_hash["value"])
-        rescue
-          # If data field has not been set we set the comparison result to nil
-          eval_result = nil
-        end
-        return eval_result
-      else
-        return result
-      end
-    rescue NoMethodError
-      Log.debug("cannot execute discovery function '#{function_hash['name']}'. data plugin not found")
-      raise DDLValidationError
-    end
-
-    # Evaluates a compound statement
-    def self.eval_compound_statement(expression)
-      if expression.values.first =~ /^\//
-        Util.has_cf_class?(expression.values.first)
-      elsif expression.values.first =~ />=|<=|=|<|>/
-        optype = expression.values.first.match(/>=|<=|=|<|>/)
-        name, value = expression.values.first.split(optype[0])
-        if value.split("")[0] == "/"
-          optype = "=~"
-        else
-          optype[0] == "=" ? optype = "==" : optype = optype[0]
-        end
-
-        Util.has_fact?(name, value, optype).to_s
-      else
-        Util.has_cf_class?(expression.values.first)
-      end
-    end
-
-    # Returns the result of an evaluated compound statement that
-    # includes a function
-    def self.eval_compound_fstatement(function_hash) # rubocop:disable Metrics/MethodLength
-      l_compare = execute_function(function_hash)
-      r_compare = function_hash["r_compare"]
-      operator = function_hash["operator"]
-
-      # Break out early and return false if the function returns nil
-      return false if l_compare.nil?
-
-      # Prevent unwanted discovery by limiting comparison operators
-      # on Strings and Booleans
-      if (l_compare.is_a?(String) || l_compare.is_a?(TrueClass) || l_compare.is_a?(FalseClass)) && function_hash["operator"].match(/<|>/)
-        Log.debug("Cannot do > and < comparison on Booleans and Strings '#{l_compare} #{function_hash['operator']} #{function_hash['r_compare']}'")
-        return false
-      end
-
-      # Prevent backticks in function parameters
-      if function_hash["params"] =~ /`/
-        Log.debug("Cannot use backticks in function parameters")
-        return false
-      end
-
-      # Do a regex comparison if right compare string is a regex
-      if operator =~ /(=~|!=~)/
-        # Fail if left compare value isn't a string
-        if l_compare.is_a?(String)
-          result = l_compare.match(r_compare)
-          # Flip return value for != operator
-          if function_hash["operator"] == "!=~"
-            return !result
-          else
-            return !!result
-          end
-        else
-          Log.debug("Cannot do a regex check on a non string value.")
-          return false
-        end
-        # Otherwise do a normal comparison while taking the type into account
-      else
-        if l_compare.is_a? String
-          r_compare = r_compare.to_s
-        elsif r_compare.is_a? String
-          if l_compare.is_a? Numeric
-            r_compare = r_compare.strip
-            begin
-              r_compare = Integer(r_compare)
-            rescue ArgumentError # rubocop:disable Metrics/BlockNesting
-              begin
-                r_compare = Float(r_compare)
-              rescue ArgumentError # rubocop:disable Metrics/BlockNesting
-                raise(ArgumentError, "invalid numeric value: #{r_compare}")
-              end
-            end
-          elsif l_compare.is_a?(TrueClass) || l_compare.is_a?(FalseClass)
-            r_compare = r_compare.strip
-            if r_compare == true.to_s # rubocop:disable Metrics/BlockNesting
-              r_compare = true
-            elsif r_compare == false.to_s # rubocop:disable Metrics/BlockNesting
-              r_compare = false
-            else
-              raise(ArgumentError, "invalid boolean value: #{r_compare}")
-            end
-          end
-        end
-        operator = operator.strip
-        if operator =~ /(?:(!=|<=|>=|<|>)|==?)/
-          operator = $1 ? $1.to_sym : :==
-        else
-          raise(ArgumentError, "invalid operator: #{operator}")
-        end
-        result = l_compare.send(operator, r_compare)
-        return result
-      end
-    end
-
-    # Creates a callstack to be evaluated from a compound evaluation string
-    def self.create_compound_callstack(call_string)
-      callstack = Matcher::Parser.new(call_string).execution_stack
-      callstack.each_with_index do |statement, i|
-        if statement.keys.first == "fstatement"
-          callstack[i]["fstatement"] = create_function_hash(statement.values.first)
-        end
-      end
-      callstack
-    end
-  end
-end