loom-core 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fca395ca95a28376331f0163c1748fcd3eb083c2f6d677627edb04a795c5b858
-  data.tar.gz: 29fc16366271bfe121eb57b7315daa87a6d8017210d41a061cdecc6665bb26bc
+  metadata.gz: ba730790e0a31bfadc0f837eb2574f9e21aed1833afd06881987cb76bc6bce2d
+  data.tar.gz: 6e3936463bef27cf155cdd9873f0268547495d1e0609dce16e5e7089699bd8f5
 SHA512:
-  metadata.gz: 291da2a4d0b793019dd65c511dfc1caa113a3a12c3a7f2ab12e9b991a8e5ce09b4fba97fb150b15b01edd6c67f0ea0536f16fc00384bf80c6ec54f9b21c9c1c2
-  data.tar.gz: 0b18248b8cf5583a48fb3844c39e15b0db216ad6c6ab62a160b5013d05e6f8931bbf165c35c7e107ce3de28a88e7227662480fd263f11031fb5356da2729c5a6
+  metadata.gz: bd86c4cafa91fcf0032f214999be470547f198f930cf1b4ff50e1aba0948aa6d78133205f05c91c81aedc2f4809266398365a5b57d878c6655ad92dc5f349100
+  data.tar.gz: a9338a3ff37ed372683af92825b196e5a6c0db4ba9fc14b75a345357dcc92474aeb3008058243e88f24d09e752dcde000551fc79f76bfe3a08c42facc0c426c5

data/.gitignore

@@ -1,2 +1,2 @@
 pkg
-loom-core-0.0.1.gem
+loom-core-*.gem

data/lib/loom/facts/all.rb

@@ -1,2 +1,3 @@
+require_relative "provider"
 require_relative "fact_set"
 require_relative "fact_file_provider"

data/lib/loom/facts/fact_set.rb

@@ -1,45 +1,9 @@
 module Loom::Facts
 
-  class Provider
-    attr_reader :fact_map
-
-    class << self
-      def disable_for_host(host_spec, klass)
-        Loom.log.warn "disabling fact provider => #{klass} on #{host_spec.hostname}"
-        @disabled_providers ||= {}
-        @disabled_providers[host_spec.hostname] ||= []
-        @disabled_providers[host_spec.hostname] << klass
-      end
-
-      def disabled_for_host?(host_spec, klass)
-        @disabled_providers ||= {}
-        @disabled_providers[host_spec.hostname] ||= []
-        @disabled_providers[host_spec.hostname].include? klass
-      end
-
-      def register_factory(klass, &block)
-        @provider_factories ||= []
-        @provider_factories << block
-        Loom.log.debug1(self) { "registered fact provider => #{klass}" }
-      end
-
-      def create_fact_providers(host_spec, shell, loom_config)
-        @provider_factories.map do |block|
-          block.call(host_spec, shell, loom_config)
-        end.flatten
-      end
-    end
-
-    def disable(host_spec)
-      Provider.disable_for_host host_spec, self.class
-    end
-
-    # Should return a Hash
-    def collect_facts
-      raise 'not implemented'
-    end
-  end
-
+  ##
+  # A factset is created by running each registered Loom::Facts::Provider and
+  # calling Provider+collect_facts+. See ./fact_file_provider.rb and
+  # lib/loomext/facts/facter_provider.rb for examples of fact providers.
   class FactSet
 
     InvalidFactName = Class.new Loom::LoomError
@@ -53,19 +17,33 @@ module Loom::Facts
         fact_providers.each do |provider|
           next if Provider.disabled_for_host?(host_spec, provider.class)
 
-          Loom.log.debug { "loading facts from provider => #{provider}" }
+          namespace = provider.namespace
+          Loom.log.debug { "loading facts from provider => #{provider}[#{namespace}]" }
 
+          provider_facts = {}
           begin
             provider.collect_facts.each do |k, v|
               k = k.to_sym
-              if fact_map[k]
-                Loom.log.warn "overriding fact => #{k}"
+              provider_facts[k] = v
+            end
+
+            if namespace
+              if fact_map[namespace]
+                Loom.log.warn "overriding fact[#{namespace}] with namespace"
+              end
+              fact_map[namespace] = provider_facts
+            else
+              provider_facts.each do |k, v|
+                if fact_map[k]
+                  Loom.log.warn "overriding fact[#{k}]"
+                end
+                Loom.log.debug5(self) { "adding fact => #{k}=#{v.to_s}" }
+                fact_map[k] = v
               end
-              Loom.log.debug5(self) { "adding fact => #{k}=#{v.to_s}" }
-              fact_map[k] = v
             end
           rescue => e
             Loom.log.error "error executing fact provider #{provider.class} => #{e.message}"
+            Loom.log.debug(self) { e.backtrace.join("\n\t") }
             provider.disable(host_spec)
           end
         end

data/lib/loom/facts/provider.rb

@@ -0,0 +1,43 @@
+module Loom::Facts
+
+  class Provider
+    # TODO: add documentation re: use of namespace in fact_set.rb
+    attr_reader :fact_map, :namespace
+
+    class << self
+      def disable_for_host(host_spec, klass)
+        Loom.log.warn "disabling fact provider => #{klass} on #{host_spec.hostname}"
+        @disabled_providers ||= {}
+        @disabled_providers[host_spec.hostname] ||= []
+        @disabled_providers[host_spec.hostname] << klass
+      end
+
+      def disabled_for_host?(host_spec, klass)
+        @disabled_providers ||= {}
+        @disabled_providers[host_spec.hostname] ||= []
+        @disabled_providers[host_spec.hostname].include? klass
+      end
+
+      def register_factory(klass, &block)
+        @provider_factories ||= []
+        @provider_factories << block
+        Loom.log.debug1(self) { "registered fact provider => #{klass}" }
+      end
+
+      def create_fact_providers(host_spec, shell, loom_config)
+        @provider_factories.map do |block|
+          block.call(host_spec, shell, loom_config)
+        end.flatten
+      end
+    end
+
+    def disable(host_spec)
+      Provider.disable_for_host host_spec, self.class
+    end
+
+    # Should return a Hash of fact_name => fact_value entries
+    def collect_facts
+      raise 'not implemented'
+    end
+  end
+end

data/lib/loom/mods/mod_loader.rb

@@ -30,7 +30,7 @@ module Loom::Mods
         raise ModDefinedError, name if instance_methods.include? name
 
         define_mod_factory name, klass
-        Loom.log.debug1(self) { "registered mod => #{klass} as #{name}" }
+        Loom.log.debug(self) { "registered mod => #{klass} as #{name}" }
 
         opts.each do |k,v|
           case k

data/lib/loom/mods/module.rb

@@ -49,12 +49,19 @@ module Loom::Mods
 
     class << self
 
+      ##
+      # Registers a mod as a new namespace on the loom object.
+      # Mods add actions either via a `mod_block` or via registering
+      # actions. Only 1 mod_block may be registered per module (which should
+      # be fixed), otherwise actions are imported to add module behavior.
+      # See loom/lib/loomext/coremods.rb and files.rb for examples.
       def register_mod(name, **opts, &block)
         Loom.log.debug2(self) { "registered mod => #{name}" }
 
+        # TODO: allow multiple mod_blocks per mod. Should probably stop
+        # dynamically defining :mod_block to do so. Current behavior, is the
+        # last register_mod w/ a mod_block wins. This is obvsiously shitty.
         if block_given?
-          # TODO: i forget what mod_blocks are. read through, remember, and
-          # document them.
           Loom.log.debug2(self) { "acting as mod_block => #{name}:#{block}" }
           define_method :mod_block, &block
         end

data/lib/loom/version.rb

@@ -1,3 +1,3 @@
 module Loom
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/loomext/corefacts/all.rb

@@ -6,3 +6,4 @@ end
 require "loom"
 
 require_relative "facter_provider"
+require_relative "system_info_provider"

data/lib/loomext/corefacts/facter_provider.rb

@@ -9,6 +9,7 @@ module LoomExt::CoreFacts
       @has_facter = shell.test :which, "facter"
       disable(host_spec) unless @has_facter
       @shell = shell
+      @namespace = :facter
     end
 
     def collect_facts

data/lib/loomext/corefacts/system_info_provider.rb

@@ -0,0 +1,104 @@
+module LoomExt::CoreFacts
+  class SystemInfoProvider < Loom::Facts::Provider
+
+    using Loom::CoreExt # using +underscore+ for key name creation
+
+    Loom::Facts::Provider.register_factory(self) do |host_spec, shell, loom_config|
+      SystemInfoProvider.new host_spec, shell
+    end
+
+    def initialize(host_spec, shell)
+      @shell = shell
+      @namespace = :system_info
+    end
+
+    def collect_facts
+      # see:
+      # https://linux.die.net/man/8/vmstat
+      # https://linux.die.net/man/5/proc
+      # https://linux.die.net/man/1/df
+      # https://www.cyberciti.biz/faq/linux-find-out-raspberry-pi-gpu-and-arm-cpu-temperature-command/
+      {
+        :vmstat => facts_from_vmstat,
+        :loadavg => facts_from_proc_loadavg,
+        :df => facts_from_df,
+        :os_release => facts_from_etc_os_release,
+        :cpu_temp => facts_from_sys_class_thermal_zones
+      }
+    end
+
+    private
+    def facts_from_vmstat
+      # NB: requires the host to support `vmstat -s` for table formatted output
+      vmstat_table = @shell.capture :vmstat, "-s"
+      vmstat_table.each_line.reduce({}) do |memo, line|
+        _, str_value, label = line.match(/\s*(\d+)\s(.*)/).to_a
+        int_value = str_value.to_i
+        value = int_value.to_s == str_value ? int_value : str_value
+        memo.merge label.strip.underscore.to_sym => value
+      end
+    end
+
+    def facts_from_proc_loadavg
+      loadavg = @shell.capture :cat, "/proc/loadavg"
+
+      one, five, fifteen, kernel_scheduling_entities, lastpid = loadavg.split
+      current_entities, total_entities = kernel_scheduling_entities.split("/")
+
+      {
+        :"1_min_avg" => one.to_f,
+        :"5_min_avg" => five.to_f,
+        :"15_min_avg" => fifteen.to_f,
+        :kernel_scheduling_entities => kernel_scheduling_entities,
+        :current_scheduling_entities => current_entities.to_i,
+        :total_scheduling_entities => total_entities.to_i,
+        :lastpid => lastpid
+      }
+    end
+
+    def facts_from_df
+      df = @shell.capture :df
+
+      headers = df.lines.first.split.map do |h|
+        h = "UsePercent" if h == "Use%"
+        h.strip.underscore.to_sym
+      end
+
+      info_lines = df.lines.drop(1).map { |l| l.strip }
+      info_lines.map do |info|
+        info_parts = info.split.map { |i| i.strip }
+        header_info_pairs = headers.zip(info_parts)
+        header_info_pairs.reduce({}) do |memo, pair|
+          str_value = pair[1]
+          int_value = str_value.to_i
+          value = int_value.to_s == str_value ? int_value : str_value
+          memo.merge pair[0] => value
+        end
+      end
+    end
+
+    def facts_from_etc_os_release
+      os_release = @shell.capture :cat, "/etc/os-release"
+
+      facts = {}
+      os_release.each_line do |l|
+        l = l.strip
+        key, value = l.split("=")
+        unquoted_value = value.gsub(/^"(.+)"$/) { |m| $1 }
+        facts[key.to_sym] = unquoted_value
+      end
+      facts
+    end
+
+    def facts_from_sys_class_thermal_zones
+      thermal_zones = @shell.capture :ls, "/sys/class/thermal"
+      thermal_zones
+        .split
+        .delete_if { |f| !f.strip.match(/^thermal_zone/) }
+        .map do |tz_dir|
+        temp = @shell.capture :cat, "/sys/class/thermal/#{tz_dir}/temp"
+        temp.strip.to_f / 1000
+      end
+    end
+  end
+end

data/lib/loomext/coremods/files.rb

@@ -2,6 +2,7 @@ module LoomExt::CoreMods
   class Files < Loom::Mods::Module
 
     register_mod :files
+    required_commands :cat, :mv, :tee, :chown, :rm, :touch, :sudo, :mkdir, :echo
 
     # TODO: document loom file statements like:
     #     `loom.files("some", "different/paths").cat`
@@ -88,6 +89,8 @@ module LoomExt::CoreMods
         each_path :action => :mkdir, :flags => flags
       end
 
+      # TODO this sudo line is just another instance of needing the harness to
+      # work properly (in this case to provides a hack for sudo_append)
       def ensure_line(line, sudo: false)
         if loom.is_sudo?
           Loom.log.warn "do not use files.ensure_line in sudo  due to poor command escaping" +
@@ -97,17 +100,21 @@ module LoomExt::CoreMods
         each_path do |p|
           file = shell.capture :cat, p
 
-          unless file.match(line)
+          matches = file.match(/^#{line}$/)
+          unless matches
             if sudo
               sudo_append(line)
             else
               append(line)
             end
+          else
+            Loom.log.debug(self) { "ensure_line match found: #{matches[0]}"}
           end
         end
       end
 
-      # this is a hack to accomodate append being f'd inside sudo blocks
+      # TODO: Get the harness working, this is a hack to accomodate append being
+      # f'd inside sudo blocks
       def sudo_append(text="")
         if text.index "\n"
           Loom.log.warn "append lines individually until cmd escaping is fixed.... "

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: loom-core
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Erick Johnson
@@ -214,6 +214,7 @@ files:
 - lib/loom/facts/all.rb
 - lib/loom/facts/fact_file_provider.rb
 - lib/loom/facts/fact_set.rb
+- lib/loom/facts/provider.rb
 - lib/loom/host_spec.rb
 - lib/loom/inventory.rb
 - lib/loom/logger.rb
@@ -249,6 +250,7 @@ files:
 - lib/loomext/corefacts.rb
 - lib/loomext/corefacts/all.rb
 - lib/loomext/corefacts/facter_provider.rb
+- lib/loomext/corefacts/system_info_provider.rb
 - lib/loomext/coremods.rb
 - lib/loomext/coremods/all.rb
 - lib/loomext/coremods/exec.rb