loom-core 0.0.6 → 0.0.9

data/loom.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = %w[lib]
 
-  s.add_dependency 'sshkit', '~> 1.11'
+  s.add_dependency 'sshkit', '~> 1.23'
   s.add_dependency 'commander', '~> 4.4'
 
   # *** Obsolete, see new issue below ***
@@ -28,17 +28,18 @@ Gem::Specification.new do |s|
   # I can manually `gem install net-ssh --version 4.0.0.beta3` for now.
   # s.add_dependency 'net-ssh', '>= 4.0.0.beta3'
   s.add_dependency 'net-ssh', '>= 5'
-  s.add_dependency 'rbnacl-libsodium', '1.0.10'
+  s.add_dependency 'rbnacl-libsodium', '1.0.16'
   s.add_dependency 'bcrypt_pbkdf', ">= 1.0", "< 2.0"
 
   # New net-ssh requiremetns for ed25519
   # https://github.com/net-ssh/net-ssh/issues/565
   s.add_dependency 'ed25519', '>=1.0', '<2.0'
 
-  s.add_development_dependency 'bundler', '~> 1.13'
+  s.add_development_dependency 'bundler'
   s.add_development_dependency 'rake', '~> 11.3'
   s.add_development_dependency 'rspec', '~> 3.5'
   s.add_development_dependency 'guard-rspec', '~> 4.7'
   s.add_development_dependency 'pry', '~> 0.10'
   s.add_development_dependency 'pry-byebug'
+  s.add_development_dependency 'rubocop'
 end

data/spec/.loom/error_handling.loom

@@ -1,4 +1,5 @@
 # !!! NOTE: This will reboot the host it runs on!!!
+# $ bx rspec spec/test_loom_spec.rb -f d -t file:error_handling.loom
 module ErrorHandling
   include Loom::Pattern
 

data/spec/.loom/fail.loom

@@ -1,20 +1,34 @@
 # All patterns are expected to fail
+# $ bx rspec spec/test_loom_spec.rb -f d -t file:fail.loom
+module ExpectedFailures
+  include Loom::Pattern
 
-desc "Always fails due to return code."
-pattern :fail_soft do |loom, facts|
-  unless loom << :false
-    loom.x :echo, "i am false"
+  before do
+    Loom.log.warn <<EOS
+
+!!!
+!!! The next case is expected to fail !!!
+!!!
+EOS
   end
-end
 
-desc "Always fails due to a hard failure"
-pattern :fail_hard do |loom, facts|
-  loom.fail "Fail big or not at all"
-end
 
-desc "Expected to fail: Check timeout commands"
-pattern :timeout_fail do |loom, facts|
-  loom.timeout(:timeout => 1) do
-    loom.x :sleep, 2
+  desc "Always fails due to return code."
+  pattern :fail_soft do |loom, facts|
+    unless loom.x :false
+      loom.x :echo, "i fail soft, because ALL examples are expected to succeed"
+    end
+  end
+
+  desc "Expect `loom.fail` to throw and error out"
+  pattern :fail_hard do |loom, facts|
+    loom.fail "`loom.fail`: Fail big or not at all"
+  end
+
+  desc "Expected to fail: Check timeout commands"
+  pattern :timeout_fail do |loom, facts|
+    loom.timeout(:timeout => 1) do
+      loom.x :sleep, 2
+    end
   end
 end

data/spec/.loom/files.loom

@@ -1,4 +1,5 @@
 # Tests for LoomExt::CoreMods::Package
+# $ bx rspec spec/test_loom_spec.rb -f d -t file:files.loom
 module Files
   include Loom::Pattern
 

data/spec/.loom/inventory.yml

@@ -0,0 +1,3 @@
+---
+- a.host.to.check
+- my.other.host

data/spec/.loom/net.loom

@@ -1,3 +1,4 @@
+# $ bx rspec spec/test_loom_spec.rb -f d -t file:net.loom
 module Net
   include Loom::Pattern
 

data/spec/.loom/pattern_context.loom

@@ -1,5 +1,6 @@
 # Tests patterns nested at deeper module levels with contextual let, before, and
 # after hooks. Verifies hook order and contexts are set correctly.
+# $ bx rspec spec/test_loom_spec.rb -f d -t file:pattern_context.loom
 module PatternContext
   module Parent
     include Loom::Pattern

data/spec/.loom/pkg.loom

@@ -1,4 +1,5 @@
 # Tests for LoomExt::CoreMods::Package
+# $ bx rspec spec/test_loom_spec.rb -f d -t file:pkg.loom
 module Package
   include Loom::Pattern
 

data/spec/.loom/regression.loom

@@ -0,0 +1,23 @@
+# Regression tests for issues that I've spent too much time debugging.
+# These must be safe to run on localhost.
+module Regression
+  include Loom::Pattern
+
+  # For some reason, weave glob expansion is more confusing than it should be.
+  weave :verify_no_glob_expansion, [
+    "regression:dummies:date",
+    "regression:dummies:echo",
+  ]
+
+  weave :verify_glob_expansion, [
+    "regression:dummies:*",
+  ]
+
+  module Dummies
+    include Loom::Pattern
+
+    pattern(:date) { |l, _| l.x :date }
+    pattern(:echo) { |l, _| l.x :echo, :hello }
+    pattern(:uptime) { |l, _| l.x :uptime }
+  end
+end

data/spec/.loom/shell.loom

@@ -1,3 +1,4 @@
+# $ bx rspec spec/test_loom_spec.rb -f d -t file:shell.loom
 module Shell
   include Loom::Pattern
 

data/spec/.loom/test.loom

@@ -1,12 +1,28 @@
 # TODO: add in test verifications that these tests are actually doing what
 # they're supposed to do.
+# $ bx rspec spec/test_loom_spec.rb -f d -t file:test.loom
+weave :smoke, [
+  :"test:*",
+  :uptime,
+]
 
-module Smoke
+desc "a pattern with no namespace"
+pattern(:uptime) { |loom, _| loom.x :uptime }
+
+module Test
   include Loom::Pattern
 
-  desc "Prints some known facts"
-  report :three_facts do |loom, facts|
-    facts
+  with_facts { |f| f.merge a_fact: :or_fiction?  }
+  let(:a_fact_len) { |f| f[:a_fact].size }
+
+  desc "inspects the facts"
+  report :the_facts do |loom, facts|
+    loom.fail "this should not happen: #{a_fact_len}" unless a_fact_len == 11
+  end
+
+  desc "expects cli provided :param_facts"
+  pattern :param_facts do |loom, facts|
+    loom.fail "expected :param_facts" unless facts[:param_facts] == "from args"
   end
 
   desc "Reports `uptime` status"
@@ -28,6 +44,7 @@ module Smoke
   pattern :wrap_returns do |loom, facts|
     # using loom.time as a proxy for Shell::Core#wrap here
     loom.time do
+      # TODO: this should be loom.fail
       raise "wrapped true is not true" unless loom.test :true
       raise "wrapped false is not false" if loom.test :false
     end

data/spec/.loom/user.loom

@@ -1,4 +1,5 @@
 # Tests for LoomExt::CoreMods::User
+# $ bx rspec spec/test_loom_spec.rb -f d -t file:user.loom
 module User
   include Loom::Pattern
 

data/spec/.loom/vms.loom

@@ -1,5 +1,6 @@
 # Tests for LoomExt::CoreMods::Vbox.
 # Currently disabled
+# $ bx rspec spec/test_loom_spec.rb -f d -t file:vms.loom
 module VMs
   include Loom::Pattern
 

data/spec/loom/host_spec_spec.rb

@@ -85,7 +85,7 @@ describe Loom::HostSpec do
   end
 
   context "ipv6 addresses" do
-    let(:host_string) { "[2a02:120b:2c28:5920:6257:18ff:febf:13c8:22]" }
+    let(:host_string) { "[2a02:120b:2c28:5920:6257:18ff:febf:13c8]:22" }
 
     it "parses user@localhost configurations as remote" do
       expect(subject.is_localhost?).to be false

data/spec/loom/pattern/dsl_spec.rb

@@ -3,6 +3,7 @@ require "loom/pattern"
 require "loom/shell"
 
 describe Loom::Pattern::DSL do
+  extend LoomSpec::LoomInternalsHelper
 
   # Fake API for tests. This object should raise an error on any command
   # execution.
@@ -18,8 +19,8 @@ describe Loom::Pattern::DSL do
       config.log_device = @logger_io
     end
 
-    @reference_set = Loom::Pattern::ReferenceSet::Builder
-      .create(loom_file, ':loom_file')
+    @reference_set =
+      Loom::Pattern::ReferenceSet.builder(loom_file, ':loom_file').build
   end
 
   let(:pattern_under_test) { @reference_set['pattern_under_test'] }

data/spec/shared/loom_internals_helper.rb

@@ -15,7 +15,7 @@ module LoomSpec
 
     def create_reference_set(loom_file_src=nil, path: 'loom/file/path')
       loom_file_src ||= File.read(path)
-      Loom::Pattern::ReferenceSet::Builder.create(loom_file_src, path)
+      Loom::Pattern::ReferenceSet::builder(loom_file_src, path).build
     end
 
     def capture_logs_to_io

data/spec/test_loom_spec.rb

@@ -15,6 +15,10 @@ describe "spec .loom files" do
   }
 
   EXPECTED_EXIT_CODE = {
+    # 100 to indicate failing patterns
+    # + 3 failed patterns
+    # ---
+    # 103 expected exit code
     "fail.loom" => 103
   }
 
@@ -25,53 +29,109 @@ describe "spec .loom files" do
 
   let(:host) { "rp0" }
   let(:patterns) { ref_set.slugs }
-  let(:command) {[
-      "bin/loom weave #{patterns.join " "}",
-      "-t",
-      "-l #{loom_file}",
-      "-X log_level=info",
-      "-H #{host}",
-      "-V",
-      "-X sshkit_log_level=warn",
-      "-X log_device=stderr",
-      "-X run_failure_strategy=cowboy",
-    ]}
-
-  # bundle exec rspec --tag smoke
-  context "test.loom" do
-    let(:loom_file) { LOOM_FILES.select { |p| p.match?(/test.loom/) }.first }
-    let(:ref_set) { create_reference_set(path: loom_file) }
-    let(:patterns) { ref_set.slugs.select { |s| s.match?(/^smoke:/) } }
-    let(:host) { "localhost" }
-
-    it "should pass a few tests quickly", :smoke => true do
-      exec = command.join(' ')
-      output = `#{exec}`
-      expect($?.exitstatus).to eq 0
+  let(:command) { nil }
+
+  let(:executor) { lambda do |*cmd_parts|
+      cmd_exec = cmd_parts.join ' '
+      output = `#{cmd_exec} 2>&1`
+      OpenStruct.new({
+        cmd_exec: cmd_exec,
+        stdout: output,
+        rc: $?.exitstatus,
+      })
+    end }
+  let(:exec_result) { executor.call(*command) }
+
+  context "$ loom inventory", smoke: true do
+    let(:command) {[
+        "bin/loom inventory",
+        "-X loom_search_paths=./spec/.loom"
+      ]}
+
+    it "should list all hosts in inventory.yml" do
+      result = exec_result
+
+      ["a.host.to.check", "my.other.host"].each do |h|
+        expect(result.stdout).to match(/#{h}/), result.to_yaml
+      end
+      expect(result.rc).to eql 0
     end
   end
 
-  # bundle exec rspec --tag integration
-  LOOM_FILES.each do |loom_file|
-    context File.basename loom_file do
-      let(:loom_file) { loom_file }
+  context "$ loom pattern", smoke: true do
+    let(:command) {[
+        "bin/loom patterns",
+        "-l #{LOOM_FILES.join ','}"
+      ]}
+
+    it "should list all patterns to stdout" do
+      result = exec_result
+
+      # some expected pattern slug namespaces
+      ["pkg", "shell", "expectedfailures", "test"].each do |ns|
+        expect(result.stdout).to match(/^\s*#{ns}:.+/), result.to_yaml
+      end
+      expect(result.rc).to eql 0
+    end
+  end
+
+  context "$ loom weave" do
+
+    # Tests important command line flags
+    let(:command) {[
+        "bin/loom weave #{patterns.join " "}",
+        "-t",
+        "-l #{loom_file}",
+        "-X log_level=info",
+        "-H #{host}",
+        "-V",
+        "-X sshkit_log_level=warn",
+        "-X log_device=stderr",
+        "-X run_failure_strategy=cowboy",
+        "-F param_facts='from args'"
+      ]}
+
+    # bundle exec rspec --tag smoke
+    context "test.loom" do
+      let(:loom_file) { LOOM_FILES.select { |p| p.match?(/#{subject}/) }.first }
       let(:ref_set) { create_reference_set(path: loom_file) }
+      let(:patterns) { [:smoke] }
+      let(:host) { "localhost" }
+
+      it "should pass the smoke tests quickly", :smoke => true do
+        result = exec_result
+        unless result.rc == 0
+          puts "loom output:\n#{output}"
+        end
+        expect(result.rc).to eq(0), result.to_yaml
+      end
+    end
 
-      if XFILE_SET[File.basename(loom_file)]
-        xit "should pass all the tests",
-        SPEC_TAGS.merge(:file => File.basename(loom_file)) {}
-      else
-        it "should pass all tests",
-        SPEC_TAGS.merge(:file => File.basename(loom_file)) do
-          exec = command.join(' ')
-          puts exec
-          # TODO pattern match the commands on STDOUT (see comment in
-          # .loom/test.loom)
-          output = `#{exec}`
-
-          basename = File.basename(loom_file)
-          expected_exit_code = EXPECTED_EXIT_CODE[basename] || 0
-          expect($?.exitstatus).to eq expected_exit_code
+    # bundle exec rspec --tag integration
+    LOOM_FILES.each do |loom_file|
+      context File.basename loom_file do
+        let(:loom_file) { loom_file }
+        let(:ref_set) { create_reference_set(path: loom_file) }
+
+        if XFILE_SET[File.basename(loom_file)]
+          xit "should pass all the tests",
+          SPEC_TAGS.merge(:file => File.basename(loom_file)) {}
+        else
+          it "should pass all tests",
+          SPEC_TAGS.merge(:file => File.basename(loom_file)) do
+            exec = command.join(' ')
+            puts <<EOS
+            executing command:
+              $ #{exec}
+EOS
+            # TODO pattern match the commands on STDOUT (see comment in
+            # .loom/test.loom)
+            output = `#{exec}`
+
+            basename = File.basename(loom_file)
+            expected_exit_code = EXPECTED_EXIT_CODE[basename] || 0
+            expect($?.exitstatus).to eq expected_exit_code
+          end
         end
       end
     end

data/test

@@ -1,2 +1,17 @@
 #!/bin/sh
+echo "running unit and smoke tests"
 bundle exec rspec --tag ~integration
+rc=$?
+if [ $rc -ne 0 ]; then
+    exit $rc
+fi
+
+y_or_Y="${1}"
+if [ "${y_or_Y}" == "" ];then
+    read -p "run integration tests (y/n)?" y_or_Y
+fi
+
+case "$y_or_Y" in
+  y|Y ) bundle exec rspec --tag integration;;
+  * ) exit $rc;;
+esac

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: loom-core
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.9
 platform: ruby
 authors:
 - Erick Johnson
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-10-26 00:00:00.000000000 Z
+date: 2024-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sshkit
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '1.23'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '1.23'
 - !ruby/object:Gem::Dependency
   name: commander
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.10
+        version: 1.0.16
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.10
+        version: 1.0.16
 - !ruby/object:Gem::Dependency
   name: bcrypt_pbkdf
   requirement: !ruby/object:Gem::Requirement
@@ -110,16 +110,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -190,6 +190,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Repeatable management of remote hosts over SSH
 email: ejohnson82@gmail.com
 executables:
@@ -199,17 +213,19 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - Gemfile
 - Gemfile.lock
 - Guardfile
 - Rakefile
 - bin/loom
+- docs/architecture.jpg
+- gentags.sh
 - lib/env/development.rb
 - lib/loom.rb
 - lib/loom/all.rb
 - lib/loom/config.rb
 - lib/loom/core_ext.rb
-- lib/loom/dsl.rb
 - lib/loom/facts.rb
 - lib/loom/facts/all.rb
 - lib/loom/facts/fact_file_provider.rb
@@ -231,10 +247,14 @@ files:
 - lib/loom/pattern/expanding_reference.rb
 - lib/loom/pattern/hook.rb
 - lib/loom/pattern/loader.rb
+- lib/loom/pattern/pattern.rb
 - lib/loom/pattern/reference.rb
 - lib/loom/pattern/reference_set.rb
 - lib/loom/pattern/result_reporter.rb
 - lib/loom/runner.rb
+- lib/loom/runner/all.rb
+- lib/loom/runner/execution_context.rb
+- lib/loom/runner/sshkit_connector.rb
 - lib/loom/shell.rb
 - lib/loom/shell/all.rb
 - lib/loom/shell/api.rb
@@ -262,21 +282,25 @@ files:
 - lib/loomext/coremods/package/package.rb
 - lib/loomext/coremods/systemd.rb
 - lib/loomext/coremods/systemd/all.rb
+- lib/loomext/coremods/systemd/hostname.rb
 - lib/loomext/coremods/systemd/systemd.rb
 - lib/loomext/coremods/systemd/systemd_units.rb
 - lib/loomext/coremods/user.rb
 - lib/loomext/coremods/vm.rb
 - lib/loomext/coremods/vm/all.rb
 - lib/loomext/coremods/vm/vbox.rb
+- loom.TAGS
 - loom.gemspec
 - loom/inventory.yml
 - scripts/harness.sh
 - spec/.loom/error_handling.loom
 - spec/.loom/fail.loom
 - spec/.loom/files.loom
+- spec/.loom/inventory.yml
 - spec/.loom/net.loom
 - spec/.loom/pattern_context.loom
 - spec/.loom/pkg.loom
+- spec/.loom/regression.loom
 - spec/.loom/shell.loom
 - spec/.loom/test.loom
 - spec/.loom/user.loom
@@ -297,11 +321,11 @@ files:
 - spec/systemd.loom
 - spec/test_loom_spec.rb
 - test
-homepage: 
+homepage:
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -316,9 +340,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
-signing_key: 
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: Repeatable management of remote hosts over SSH
 test_files: