+ +
+ +In Files
+-
+
+
- lib/mcollective/util.rb + +
Methods
+-
+
+
- ::absolute_path? + +
- ::align_text + +
- ::color + +
- ::colorize + +
- ::command_in_path? + +
- ::config_file_for_user + +
- ::default_options + +
- ::empty_filter + +
- ::empty_filter? + +
- ::get_fact + +
- ::has_agent? + +
- ::has_cf_class? + +
- ::has_fact? + +
- ::has_identity? + +
- ::loadclass + +
- ::make_subscriptions + +
- ::mcollective_version + +
- ::parse_fact_string + +
- ::ruby_version + +
- ::setup_windows_sleeper + +
- ::shellescape + +
- ::str_to_bool + +
- ::subscribe + +
- ::t + +
- ::templatepath + +
- ::terminal_dimensions + +
- ::unsubscribe + +
- ::versioncmp + +
- ::windows? + +
- ::windows_prefix + +
Files
+-
+
+
- COPYING + +
- Gemfile + +
- README + +
- Rakefile + +
- client.cfg.dist + +
- data-help.erb + +
- discovery-help.erb + +
- facts.yaml.dist + +
- metadata-help.erb + +
- msg-help.erb + +
- rpc-help.erb + +
- server.cfg.dist + +
- PLACEHOLDER + +
- PLACEHOLDER + +
- action_snippet.erb + +
- data_input_snippet.erb + +
- ddl.erb + +
- plugin.erb + +
- en.yml + +
- mcollective.init + +
Class Index
+ ![[+]](../images/find.png "show/hide quicksearch")
+
+
+ -
+
+
- MCollective + +
- MCollective::Agent + +
- MCollective::Agents + +
- MCollective::Aggregate + +
- MCollective::Aggregate::Base + +
- MCollective::Aggregate::Result + +
- MCollective::Aggregate::Result::Base + +
- MCollective::Aggregate::Result::CollectionResult + +
- MCollective::Aggregate::Result::NumericResult + +
- MCollective::Application + +
- MCollective::Applications + +
- MCollective::Cache + +
- MCollective::Client + +
- MCollective::CodedError + +
- MCollective::Config + +
- MCollective::Connector + +
- MCollective::Connector::Base + +
- MCollective::DDL + +
- MCollective::DDL::AgentDDL + +
- MCollective::DDL::Base + +
- MCollective::DDL::DataDDL + +
- MCollective::DDL::DiscoveryDDL + +
- MCollective::DDL::ValidatorDDL + +
- MCollective::DDLValidationError + +
- MCollective::Data + +
- MCollective::Data::Base + +
- MCollective::Data::Result + +
- MCollective::Discovery + +
- MCollective::Facts + +
- MCollective::Facts::Base + +
- MCollective::Generators + +
- MCollective::Generators::AgentGenerator + +
- MCollective::Generators::Base + +
- MCollective::Generators::DataGenerator + +
- MCollective::InvalidRPCData + +
- MCollective::Log + +
- MCollective::Logger + +
- MCollective::Logger::Base + +
- MCollective::Logger::Console_logger + +
- MCollective::Logger::File_logger + +
- MCollective::Logger::Syslog_logger + +
- MCollective::Matcher + +
- MCollective::Matcher::Parser + +
- MCollective::Matcher::Scanner + +
- MCollective::Message + +
- MCollective::MissingRPCData + +
- MCollective::MsgDoesNotMatchRequestID + +
- MCollective::MsgTTLExpired + +
- MCollective::NotTargettedAtUs + +
- MCollective::Optionparser + +
- MCollective::PluginManager + +
- MCollective::PluginPackager + +
- MCollective::PluginPackager::AgentDefinition + +
- MCollective::PluginPackager::StandardDefinition + +
- MCollective::RPC + +
- MCollective::RPC::ActionRunner + +
- MCollective::RPC::Agent + +
- MCollective::RPC::Audit + +
- MCollective::RPC::Client + +
- MCollective::RPC::Helpers + +
- MCollective::RPC::Progress + +
- MCollective::RPC::Reply + +
- MCollective::RPC::Request + +
- MCollective::RPC::Result + +
- MCollective::RPC::Stats + +
- MCollective::RPCAborted + +
- MCollective::RPCError + +
- MCollective::Registration + +
- MCollective::Registration::Base + +
- MCollective::Runner + +
- MCollective::RunnerStats + +
- MCollective::SSL + +
- MCollective::Security + +
- MCollective::Security::Base + +
- MCollective::SecurityValidationFailed + +
- MCollective::Shell + +
- MCollective::Translatable + +
- MCollective::UnixDaemon + +
- MCollective::UnknownRPCAction + +
- MCollective::UnknownRPCError + +
- MCollective::Util + +
- MCollective::Validator + +
- MCollective::ValidatorError + +
- MCollective::WindowsDaemon + +
- Array + +
- Dir + +
- Object + +
- String + +
- Symbol + +
MCollective::Util
+ +Some basic utility helper methods useful to clients, agents, runner etc.
-Methods
+Public Class Methods
- + +Public Class methods
- --we should really use Pathname#absolute? but it‘s not in all the ruby +
+we should really use Pathname#absolute? but it’s not in all the ruby versions we support and it comes down to roughly this
- -
# File lib/mcollective/util.rb, line 464
464: def self.absolute_path?(path, separator=File::SEPARATOR, alt_separator=File::ALT_SEPARATOR)
@@ -164,23 +426,29 @@ versions we support and it comes down to roughly this
469: end
470:
471: !!path.match(path_matcher)
-472: end
-
- Returns an aligned_string of text relative to the size of the terminal window. If a line in the string exceeds the width of the terminal window the line will be chopped off at the whitespace chacter closest to the end @@ -191,9 +459,11 @@ The terminal size is detected by default, but custom line widths can passed. All strings will also be left aligned with 5 whitespace characters by default.
- -
# File lib/mcollective/util.rb, line 310
310: def self.align_text(text, console_cols = nil, preamble = 5)
@@ -276,29 +546,37 @@ by default.
387: end
388:
389: text.join("\n")
-390: end
-
- -Return color codes, if the config color= -option is false just return a empty string +390: end +
+Return color codes, if the config color= option is false just return a +empty string
- -
# File lib/mcollective/util.rb, line 270
270: def self.color(code)
@@ -316,54 +594,70 @@ option is false just return a empty string
282: else
283: return ""
284: end
-285: end
-
- -Helper to return a string in specific color +285: end +
+Helper to return a string in specific color
- -
# File lib/mcollective/util.rb, line 288
288: def self.colorize(code, msg)
289: "%s%s%s" % [ color(code), msg, color(:reset) ]
-290: end
-
- Checks in PATH returns true if the command is found
- -
# File lib/mcollective/util.rb, line 417
417: def self.command_in_path?(command)
@@ -372,29 +666,37 @@ Checks in PATH returns true if the command is found
420: end
421:
422: found.include?(true)
-423: end
-
- Picks a config file defaults to ~/.mcollective else /etc/mcollective/client.cfg
- -
# File lib/mcollective/util.rb, line 148
148: def self.config_file_for_user
@@ -420,28 +722,36 @@ Picks a config file defaults to ~/.mcollective else
168: end
169:
170: return config
-171: end
-
- Creates a standard options hash
- -
# File lib/mcollective/util.rb, line 174
174: def self.default_options
@@ -453,28 +763,36 @@ Creates a standard options hash
180: :discovery_method => nil,
181: :discovery_options => Config.instance.default_discovery_options,
182: :filter => empty_filter}
-183: end
-
- Creates an empty filter
- -
# File lib/mcollective/util.rb, line 132
132: def self.empty_filter
@@ -483,87 +801,111 @@ Creates an empty filter
135: "agent" => [],
136: "identity" => [],
137: "compound" => []}
-138: end
-
- Checks if the passed in filter is an empty one
- -
# File lib/mcollective/util.rb, line 127
127: def self.empty_filter?(filter)
128: filter == empty_filter || filter == {}
-129: end
-
- Gets the value of a specific fact, mostly just a duplicate of MCollective::Facts.get_fact but it kind of +href="Facts.html#M000483">MCollective::Facts.get_fact but it kind of goes with the other classes here
- -
# File lib/mcollective/util.rb, line 63
63: def self.get_fact(fact)
64: Facts.get_fact(fact)
-65: end
-
- Finds out if this MCollective has an agent by the name passed
-If the passed name starts with a / it‘s assumed to be regex and will +If the passed name starts with a / it’s assumed to be regex and will use regex to match
- -
# File lib/mcollective/util.rb, line 10
10: def self.has_agent?(agent)
@@ -580,34 +922,42 @@ use regex to match
21: end
22:
23: false
-24: end
-
- Checks if this node has a configuration management class by parsing the a text file with just a list of classes, recipes, roles etc. This is ala the classes.txt from puppet.
-If the passed name starts with a / it‘s assumed to be regex and will +If the passed name starts with a / it’s assumed to be regex and will use regex to match
- -
# File lib/mcollective/util.rb, line 40
40: def self.has_cf_class?(klass)
@@ -629,32 +979,40 @@ use regex to match
56: end
57:
58: false
-59: end
-
- Compares fact == value,
-If the passed value starts with a / it‘s assumed to be regex and will +If the passed value starts with a / it’s assumed to be regex and will use regex to match
- -
# File lib/mcollective/util.rb, line 71
71: def self.has_fact?(fact, value, operator)
@@ -694,32 +1052,40 @@ use regex to match
105: end
106:
107: false
-108: end
-
- Checks if the configured identity matches the one supplied
-If the passed name starts with a / it‘s assumed to be regex and will +If the passed name starts with a / it’s assumed to be regex and will use regex to match
- -
# File lib/mcollective/util.rb, line 114
114: def self.has_identity?(identity)
@@ -732,52 +1098,69 @@ use regex to match
121: end
122:
123: false
-124: end
-
- Wrapper around PluginManager.loadclass +href="PluginManager.html#M000084">PluginManager.loadclass
- -
# File lib/mcollective/util.rb, line 224
224: def self.loadclass(klass)
225: PluginManager.loadclass(klass)
-226: end
-
- (Not documented)
+ + + +
# File lib/mcollective/util.rb, line 185
185: def self.make_subscriptions(agent, type, collective=nil)
@@ -794,51 +1177,68 @@ href="PluginManager.html#M000034">PluginManager.loadclass
196:
197: [{:agent => agent, :type => type, :collective => collective}]
198: end
-199: end
-
- Parse a fact filter string like foo=bar into the tuple hash thats needed
- -
# File lib/mcollective/util.rb, line 229
229: def self.parse_fact_string(fact)
@@ -855,88 +1255,112 @@ Parse a fact filter string like foo=bar into the tuple hash thats needed
240: else
241: raise "Could not parse fact #{fact} it does not appear to be in a valid format"
242: end
-243: end
-
- Returns the current ruby version as per RUBY_VERSION, mostly doing this here to aid testing
- -
# File lib/mcollective/util.rb, line 294
294: def self.ruby_version
295: RUBY_VERSION
-296: end
-
- -On windows ^c can‘t interrupt the VM -if its blocking on IO, so this sets up a dummy thread that sleeps and this -will have the end result of being interruptable at least once a second. -This is a common pattern found in Rails etc +296: end +
+On windows ^c can’t interrupt the VM if its blocking on IO, so this +sets up a dummy thread that sleeps and this will have the end result of +being interruptable at least once a second. This is a common pattern found +in Rails etc
- -
# File lib/mcollective/util.rb, line 30
30: def self.setup_windows_sleeper
31: Thread.new { loop { sleep 1 } } if Util.windows?
-32: end
-
- +Escapes a string so it’s safe to use in system() or backticks
-Taken from Shellwords#shellescape since it‘s only in a few ruby +Taken from Shellwords#shellescape since it’s only in a few ruby versions
- -
# File lib/mcollective/util.rb, line 248
248: def self.shellescape(str)
@@ -953,30 +1377,37 @@ versions
259: str.gsub!(/\n/, "'\n'")
260:
261: return str
-262: end
-
- -Converts a string into a boolean value Strings matching 1,y,yes,true or t will return TrueClass Any other value will -return FalseClass +262: end +
+Converts a string into a boolean value Strings matching 1,y,yes,true or t +will return TrueClass Any other value will return FalseClass
- -
# File lib/mcollective/util.rb, line 477
477: def self.str_to_bool(val)
@@ -988,29 +1419,36 @@ return FalseClass
483: else
484: raise_code(:PLMC42, "Cannot convert string value '%{value}' into a boolean.", :error, :value => clean_val)
485: end
-486: end
-
- -Helper to subscribe to a topic on multiple -collectives or just one +486: end +
+Helper to subscribe to a topic on multiple collectives or just one
- -
# File lib/mcollective/util.rb, line 202
202: def self.subscribe(targets)
@@ -1021,28 +1459,36 @@ collectives or just one
207: targets.each do |target|
208: connection.subscribe(target[:agent], target[:type], target[:collective])
209: end
-210: end
-
- Looks up and interprolate the hash values into a i18n string
- -
# File lib/mcollective/util.rb, line 489
489: def self.t(msgid, args={})
@@ -1051,28 +1497,36 @@ Looks up and interprolate the hash values into a i18n string
492: else
493: I18n.t(msgid, args)
494: end
-495: end
-
- Looks up the template directory and returns its full path
- -
# File lib/mcollective/util.rb, line 498
498: def self.templatepath(template_file)
@@ -1082,32 +1536,40 @@ Looks up the template directory and returns its full path
502:
503: template_path = File.join("/etc/mcollective", template_file)
504: return template_path
-505: end
-
- Figures out the columns and lines of the current tty
-Returns [0, 0] if it can‘t figure it -out or if you‘re not running on a tty +Returns [0, 0] if it can’t figure it out or if you’re not +running on a tty
- -
# File lib/mcollective/util.rb, line 396
396: def self.terminal_dimensions(stdout = STDOUT, environment = ENV)
@@ -1128,29 +1590,36 @@ out or if you‘re not running on a tty
411: end
412: rescue
413: [0, 0]
-414: end
-
- -Helper to unsubscribe to a topic on -multiple collectives or just one +414: end +
+Helper to unsubscribe to a topic on multiple collectives or just one
- -
# File lib/mcollective/util.rb, line 213
213: def self.unsubscribe(targets)
@@ -1161,34 +1630,42 @@ multiple collectives or just one
218: targets.each do |target|
219: connection.unsubscribe(target[:agent], target[:type], target[:collective])
220: end
-221: end
-
- compare two software versions as commonly found in package versions.
-returns 0 if a == b returns -1 if a < b returns 1 if a > b +returns 0 if a == b returns -1 if a < b returns 1 if a > b
Code originally from Puppet
- -
# File lib/mcollective/util.rb, line 433
433: def self.versioncmp(version_a, version_b)
@@ -1218,72 +1695,100 @@ Code originally from Puppet
457: end
458:
459: version_a <=> version_b;
-460: end
-
- Returns the PuppetLabs mcollective path for windows
- -
# File lib/mcollective/util.rb, line 141
141: def self.windows_prefix
142: require 'win32/dir'
143: prefix = File.join(Dir::COMMON_APPDATA, "PuppetLabs", "mcollective")
-144: end
-
-