loom-core 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba730790e0a31bfadc0f837eb2574f9e21aed1833afd06881987cb76bc6bce2d
-  data.tar.gz: 6e3936463bef27cf155cdd9873f0268547495d1e0609dce16e5e7089699bd8f5
+  metadata.gz: 6d528b08eb52c1ed7fca596af8d47b5e1869c5bd98d1bbeba9cb66c27dad3043
+  data.tar.gz: 1445b6f3d508a9be19d32f2aa9253e3e6f7b7eb9b771b73ea482b9b3ca07a846
 SHA512:
-  metadata.gz: bd86c4cafa91fcf0032f214999be470547f198f930cf1b4ff50e1aba0948aa6d78133205f05c91c81aedc2f4809266398365a5b57d878c6655ad92dc5f349100
-  data.tar.gz: a9338a3ff37ed372683af92825b196e5a6c0db4ba9fc14b75a345357dcc92474aeb3008058243e88f24d09e752dcde000551fc79f76bfe3a08c42facc0c426c5
+  metadata.gz: 93499a20ce6ba74bcf96dc84d6fbf2c1b1c3fd38901dd9f4c06e8f3ce04d6d44dde3176f1aa88b8becbda43b72b5e93767d7e088d8d4fb1c52e40e3b07212f9e
+  data.tar.gz: f3e2c5a3699f76c3e6d83d41286b421158c9ed2380714dbe2e54658c51c3a466832967f29d1e12601c63beaf2f59d8e83b0b03938cff43459d906e59018d4eec

data/Gemfile.lock

@@ -1,22 +1,24 @@
 PATH
   remote: .
   specs:
-    loom-core (0.0.1)
-      bcrypt_pbkdf (= 1.0.0.alpha1)
+    loom-core (0.0.3)
+      bcrypt_pbkdf (>= 1.0, < 2.0)
       commander (~> 4.4)
-      net-ssh (>= 3)
+      ed25519 (>= 1.0, < 2.0)
+      net-ssh (>= 5)
       rbnacl-libsodium (= 1.0.10)
       sshkit (~> 1.11)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    bcrypt_pbkdf (1.0.0.alpha1)
+    bcrypt_pbkdf (1.0.0)
     byebug (9.0.6)
     coderay (1.1.1)
-    commander (4.4.0)
+    commander (4.4.6)
       highline (~> 1.7.2)
     diff-lcs (1.2.5)
+    ed25519 (1.2.4)
     ffi (1.9.14)
     formatador (0.2.5)
     guard (2.14.0)
@@ -33,7 +35,7 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    highline (1.7.8)
+    highline (1.7.10)
     listen (3.1.5)
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
@@ -43,7 +45,7 @@ GEM
     nenv (0.3.0)
     net-scp (1.2.1)
       net-ssh (>= 2.6.5)
-    net-ssh (3.2.0)
+    net-ssh (5.0.2)
     notiffany (0.1.1)
       nenv (~> 0.1)
       shellany (~> 0.0)
@@ -58,7 +60,7 @@ GEM
     rb-fsevent (0.9.8)
     rb-inotify (0.9.7)
       ffi (>= 0.5.0)
-    rbnacl (3.4.0)
+    rbnacl (5.0.0)
       ffi
     rbnacl-libsodium (1.0.10)
       rbnacl (>= 3.0.1)
@@ -78,7 +80,7 @@ GEM
     ruby_dep (1.5.0)
     shellany (0.0.1)
     slop (3.6.0)
-    sshkit (1.11.4)
+    sshkit (1.17.0)
       net-scp (>= 1.1.2)
       net-ssh (>= 2.8.0)
     thor (0.19.1)
@@ -96,4 +98,4 @@ DEPENDENCIES
   rspec (~> 3.5)
 
 BUNDLED WITH
-   1.13.6
+   1.16.2

data/lib/loom/facts/fact_set.rb

@@ -83,8 +83,10 @@ module Loom::Facts
     end
 
     def get(fact_name)
-      result = @fact_map[fact_name.to_sym]
-      result.dup rescue result
+      v = @fact_map[fact_name.to_sym]
+      dup = v.dup rescue v
+      dup = FactSet.new(@host_spec, {}) if dup.nil?
+      dup.is_a?(Hash) ? FactSet.new(@host_spec, dup) : dup
     end
     alias_method :[], :get
 

data/lib/loom/facts/provider.rb

@@ -4,6 +4,10 @@ module Loom::Facts
     # TODO: add documentation re: use of namespace in fact_set.rb
     attr_reader :fact_map, :namespace
 
+    # TODO: add a mechanism to check for prerequisites to enabling a fact provider, currently
+    # FacterProvider does this manually. At a minimum binaries required by the fact provider to
+    # collect info should be checked to be available.
+
     class << self
       def disable_for_host(host_spec, klass)
         Loom.log.warn "disabling fact provider => #{klass} on #{host_spec.hostname}"

data/lib/loom/pattern/all.rb

@@ -2,6 +2,7 @@ require_relative "dsl"
 require_relative "hook"
 require_relative "definition_context"
 require_relative "reference"
+require_relative "expanding_reference"
 require_relative "reference_set"
 require_relative "loader"
 require_relative "result_reporter"

data/lib/loom/pattern/definition_context.rb

@@ -49,6 +49,8 @@ module Loom::Pattern
       Hook.after_hooks merged_hooks.reverse
     end
 
+    # Helper methods for flattening all parent definition contexts for running a
+    # pattern ref.
     private
     def merged_fact_map
       merged_contexts.map(&:fact_map).reduce({}) do |merged_map, next_map|
@@ -62,6 +64,10 @@ module Loom::Pattern
       end
     end
 
+    ##
+    # Flattens the list of hooks from all parent modules so that executing the
+    # pattern reference executes all expected hooks in the correct order, w/o
+    # needing to recurse.
     def merged_hooks
       return hooks if @parent_context.nil?
       merged_contexts.map(&:hooks).flatten

data/lib/loom/pattern/dsl.rb

@@ -98,6 +98,13 @@ Loom::Facts::FactSet as parameters.
 
 =end
 module Loom::Pattern
+
+  # TODO: clarify this DSL to only export:
+  # - description
+  # - pattern
+  # - let
+  # - after/before
+  # other methods are utility methods used to process and run patterns.
   module DSL
 
     loom_accessor :namespace
@@ -120,7 +127,23 @@ module Loom::Pattern
     end
 
     def pattern(name, &block)
-      Loom.log.debug3(self) { "defined pattern method => #{name}" }
+      Loom.log.debug1(self) { "defining pattern => #{name}" }
+      define_pattern_internal(name, &block)
+    end
+
+    def weave(name, pattern_slugs)
+      Loom.log.debug1(self) { "defining weave => #{name}" }
+      @weave_slugs ||= {}
+      @weave_slugs[name.to_sym] = pattern_slugs.map { |s| s.to_s }
+
+      unless @next_description
+        @next_description = "Weave runs patterns: %s" % pattern_slugs.join(", ")
+      end
+
+      define_pattern_internal(name) { |_, _| true }
+    end
+
+    def define_pattern_internal(name, &block)
       @pattern_methods ||= []
       @pattern_method_map ||= {}
       @pattern_descriptions ||= {}
@@ -148,6 +171,14 @@ module Loom::Pattern
       hook :after, &block
     end
 
+    def weave_slugs
+      @weave_slugs || {}
+    end
+
+    def is_weave?(name)
+      !!weave_slugs[name]
+    end
+
     def pattern_methods
       @pattern_methods || []
     end

data/lib/loom/pattern/expanding_reference.rb

@@ -0,0 +1,16 @@
+module Loom::Pattern
+  class ExpandingReference
+
+    attr_reader :slug, :reference_slugs, :source_file, :desc
+
+    def initialize(slug, reference_slugs, source_file, description)
+      @slug = slug
+      @reference_slugs = reference_slugs
+      @desc = description
+    end
+
+    def is_expanding?
+      true
+    end
+  end
+end

data/lib/loom/pattern/loader.rb

@@ -1,6 +1,7 @@
 module Loom::Pattern
 
   SiteFileNotFound = Class.new Loom::LoomError
+  RecursiveExpansionError = Class.new Loom::LoomError
 
   class Loader
     class << self
@@ -24,7 +25,8 @@ module Loom::Pattern
       if slugs.nil?
         @reference_set.pattern_refs
       else
-        slugs.map { |slug| get_pattern_ref(slug) }
+        refs = slugs.map { |slug| get_pattern_ref(slug) }
+        expand_refs(refs)
       end
     end
 
@@ -44,5 +46,24 @@ module Loom::Pattern
     def load_pattern_file(f)
       @reference_set.merge! ReferenceSet.load_from_file(f)
     end
+
+    def expand_refs(refs)
+      refs.flat_map do |ref|
+        if ref.is_expanding?
+          expanded_refs = ref.reference_slugs.map { |s| get_pattern_ref(s) }
+          expanded_refs.each do |exp_ref|
+            if exp_ref.is_expanding?
+              Loom.log.error "error expanding pattern[#{exp_ref.slug}] in weave[#{ref.slug}], i.e. only patterns are allowed in weaves"
+              raise RecursiveExpansionError, ref.slug
+            end
+          end
+          Loom.log.info(
+            "expanded pattern #{ref.slug} to patterns: #{expanded_refs.map(&:slug).join(",")}")
+          expanded_refs
+        else
+          ref
+        end
+      end
+    end
   end
 end

data/lib/loom/pattern/reference.rb

@@ -11,6 +11,10 @@ module Loom::Pattern
       @desc = description
     end
 
+    def is_expanding?
+      false
+    end
+
     def call(shell_api, host_fact_set)
       run_context = RunContext.new @unbound_method, @definition_ctx
 

data/lib/loom/pattern/reference_set.rb

@@ -1,3 +1,8 @@
+# THERE BE DRAGONS HERE
+# TODO: add documentation re: how the .loom file is parsed (exec'd) and turned
+# into a reference set. There's also a lot of dark magic w/ generating
+# stacktraces to get the correct .loom file line (but I forget if that's done
+# here or in pattern/reference.rb maybe?)
 module Loom::Pattern
 
   DuplicatePatternRef = Class.new Loom::LoomError
@@ -54,6 +59,8 @@ module Loom::Pattern
         def create(ruby_code, source)
           shell_module = Module.new
           shell_module.include Loom::Pattern
+          # TODO: I think this is my black magic for capturing stacktrace
+          # info... I forget the details. Add documentation.
           shell_module.module_eval ruby_code, source, 1
           shell_module.namespace ""
 
@@ -81,18 +88,35 @@ module Loom::Pattern
       def refs_for_mod_spec(mod_spec)
         mod = mod_spec[:module]
         context = context_for_mod_spec mod_spec
-        source = @source
 
         mod_spec[:pattern_methods].map do |m|
-          method = mod.pattern_method m
-          desc = mod.pattern_description m
           slug = compute_slug mod_spec[:namespace_list], m
 
-          Loom.log.warn "no descripiton for pattern => #{slug}" unless desc
-          Reference.new slug, method, source, context, desc
+          if mod.is_weave?(m)
+            Loom.log.debug2(self) { "adding ExpandingReference for weave: #{slug}" }
+            build_expanding_reference(m, slug, mod)
+          else
+            Loom.log.debug2(self) { "adding Reference for pattern: #{slug}" }
+            build_pattern_reference(m, slug, context, mod)
+          end
         end
       end
 
+      def build_expanding_reference(weave_name, slug, mod)
+        desc = mod.pattern_description weave_name
+        Loom.log.warn "no descripiton for weave => #{slug}" unless desc
+
+        ExpandingReference.new slug, mod.weave_slugs[weave_name], @source, desc
+      end
+
+      def build_pattern_reference(pattern_name, slug, context, mod)
+        method = mod.pattern_method pattern_name
+        desc = mod.pattern_description pattern_name
+        Loom.log.warn "no descripiton for pattern => #{slug}" unless desc
+
+        Reference.new slug, method, @source, context, desc
+      end
+
       def context_for_mod_spec(mod_spec)
         parents = mod_spec[:parent_modules].find_all do |mod|
           is_pattern_module mod

data/lib/loom/runner.rb

@@ -128,7 +128,7 @@ module Loom
             end
 
             Loom.log.debug "collecting facts for => #{pattern_description}"
-            # Collect facts for each pattern run on each host, this way if one
+            # Collects facts for each pattern run on each host, this way if one
             # pattern run updates would be facts, the next pattern will see the
             # new fact.
             fact_shell = Loom::Shell.create @mod_loader, sshkit_backend, dry_run
@@ -136,10 +136,8 @@ module Loom
                          .merge @other_facts
 
             Loom.log.info "running pattern => #{pattern_description}"
-            # Each pattern execution needs its own shell and mod loader to make
-            # sure context is reported correctly (this is probably a hack, there
-            # should just be a way to clear/ignore state from certain commands -
-            # like the fact_finding ones above).
+            # Creates a new shell for executing the pattern, so as not to be
+            # tainted by the fact finding shell above.
             pattern_shell = Loom::Shell.create @mod_loader, sshkit_backend, dry_run
 
             Loom.log.warn "dry run only => #{pattern_description}" if dry_run
@@ -165,9 +163,11 @@ module Loom
       result_reporter = Loom::Pattern::ResultReporter.new(
         @loom_config, pattern_ref.slug, hostname, shell_session)
 
-      # TODO: This is a crappy mechanism for tracking errors (hency my crappy error reporting :( ),
-      # there should be an exception thrown inside of Shell when a command fails and pattern
-      # execution should stop. All errors should come from exceptions.
+      # TODO: This is a crappy mechanism for tracking errors - hency my crappy
+      # error reporting :( - there should be an exception thrown inside of Shell
+      # when a command fails and pattern execution should stop. All errors
+      # should come from exceptions. This needs to be thought about wrt to the
+      # defined `failure_strategy`
       run_failure = []
       begin
         pattern_ref.call(shell.shell_api, fact_set)
@@ -175,8 +175,8 @@ module Loom
         Loom.log.debug e.backtrace.join "\n\t"
         run_failure << e
       ensure
-        # TODO[P0]: this prints out [Result: OK] even if an exception is raised... this is really
-        # annoying.
+        # TODO[P0]: this prints out [Result: OK] even if an exception is
+        # raised... this is really annoying.
         result_reporter.write_report
 
         # TODO: this is not the correct error condition.
@@ -198,10 +198,10 @@ module Loom
         Loom.log.warn "disabling host per :run_failure_strategy => #{failure_strategy}"
         @inventory_list.disable hostname
       when :fail_fast
-        Loom.log.error "erroring out of failed scenario per :run_failure_strategy"
+        Loom.log.error "erroring out of failed pattern per :run_failure_strategy"
         raise FailFastExecutionError, failure_summary
       when :cowboy
-        Loom.log.warn "continuing on past failed scenario per :run_failure_strategy"
+        Loom.log.warn "continuing on past failed pattern per :run_failure_strategy"
       else
         raise ConfigError, "unknown failure_strategy: #{failure_stratgy}"
       end

data/lib/loom/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: loom-core
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Erick Johnson
@@ -228,6 +228,7 @@ files:
 - lib/loom/pattern/all.rb
 - lib/loom/pattern/definition_context.rb
 - lib/loom/pattern/dsl.rb
+- lib/loom/pattern/expanding_reference.rb
 - lib/loom/pattern/hook.rb
 - lib/loom/pattern/loader.rb
 - lib/loom/pattern/reference.rb