loom-core 0.0.1

data/spec/spec_helper.rb

@@ -0,0 +1,94 @@
+Dir.glob('./spec/shared/**/*.rb').each { |f| require f }
+require './lib/loom'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/spec/test.loom

@@ -0,0 +1,370 @@
+require "loomext/all"
+
+desc "Prints some known facts"
+pattern :three_facts do |loom, facts|
+  puts "first 3 facts..."
+  puts facts.facts.to_a.slice(0, 3).map { |tuple| tuple.join "=" }.join("\n")
+end
+
+
+desc "Reports `uptime` status"
+pattern :uptime do |loom, facts|
+  loom << :uptime
+  loom << :hostname
+  loom.local << :hostname
+end
+#produces { pkg.installed? :httpd }
+
+desc "cd's to the /etc directory and runs `pwd`"
+pattern :cd do |loom, facts|
+  loom.cd "/etc" do
+    loom << :pwd
+  end
+end
+
+desc "tests return codes from wrapped commands"
+pattern :wrap_returns do |loom, facts|
+  # using loom.time as a proxy for Shell::Core#wrap here
+  loom.time do
+    raise "wrapped true is not true" unless loom.test :true
+    raise "wrapped false is not false" if loom.test :false
+  end
+end
+
+desc "Tests a condition."
+pattern :test do |loom, facts|
+  unless loom.test :false
+    loom.x :echo, "i tested false"
+  end
+
+  if loom.test :true
+    loom.x :echo, "i tested true"
+  end
+
+  if loom.test :which, "bash"
+    loom.x :echo, "has bash"
+  end
+end
+
+desc "Tests a grep condition."
+pattern :match do |loom, facts|
+  if loom.files("/etc/hosts").match? :pattern => "aldsfja;ldjf"
+    loom.fail "should not match garbage"
+  else
+    loom.x :echo, "I didnt match garbage"
+  end
+
+  unless loom.files("/etc/hosts").match? :pattern => "localhost"
+    loom.fail "should match localhost"
+  else
+    loom.x :echo, "I did match my target"
+  end
+end
+
+desc "Always fails due to return code."
+pattern :fail_soft do |loom, facts|
+  unless loom << :false
+    loom.x :echo, "i am false"
+  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 "Check timeout commands"
+pattern :timeout_fail do |loom, facts|
+  loom.timeout(:timeout => 1) do
+    loom.x :sleep, 2
+  end
+end
+
+desc "Wrapped time commands"
+pattern :time do |loom, facts|
+  loom.time do
+    loom.x :echo, :hi
+    loom.x :sleep, 2
+  end
+end
+
+module Net
+  include Loom::Pattern
+
+  desc "tests the net package, with_net check"
+  pattern :check_net do |loom, facts|
+    unless loom.net(check_host: '127.0.0.1').has_net?
+      loom.fail 'can not ping localhost'
+    end
+
+    has_local_net = false
+    loom.net(check_host: '127.0.0.1').with_net do
+      has_local_net = true
+    end
+    loom.fail "should have local net" unless has_local_net
+  end
+
+  desc "expected check_net failures"
+  pattern :check_net_fail do |loom, facts|
+    loom.net(timeout: 2, check_host: '1.1.1.1').check_net
+  end
+end
+
+module Files
+  include Loom::Pattern
+
+  desc "Reads a file"
+  pattern :read do |loom, facts|
+    loom.files("/etc/hosts").cat
+  end
+
+  desc "Gsubs file text"
+  pattern :gsub do |loom, facts|
+    loom.files("/tmp/garbage").write <<EOS
+This is a bunch of junk
+192.123.456.0\t\thostname.xyz
+EOS
+
+    loom.files("/tmp/garbage")
+      .cat
+      .gsub(pattern: /[\d]{3}/, replace: "xxx")
+      .append("this is something new")
+      .cat
+  end
+
+  desc "Chowns a file"
+  pattern :chown do |loom, facts|
+    loom.files("/tmp/chown.me")
+      .touch
+      .append("this file will be owned by root")
+
+    loom.sudo do
+      loom.files("/tmp/chown.me").chown user: :root
+      loom.x :ls, "-lZ", "/tmp/chown.me"
+
+      loom.files("/tmp/chown.me").chown user: :root, group: :root
+    end
+
+    loom.sudo { loom.exec :rm, "/tmp/chown.me" }
+  end
+end
+
+module Shell
+  include Loom::Pattern
+
+  desc "Executes some commands in a subshell"
+  pattern :subshell do |loom, facts|
+    loom << :"(echo $$; echo $BASHPID; whoami)"
+    loom << :"(sudo -i -u root whoami)"
+
+    loom.local << :"(echo $$; echo $BASHPID; whoami)"
+    #    loom.local << "(sudo -i -u root whoami)"
+  end
+
+  desc "Tests nested sudo scenarios"
+  pattern :sudo do |loom, facts|
+    loom.sudo user: "root" do
+      loom << :pwd
+      loom << :whoami
+      loom.exec :touch, "loom.file"
+
+      loom.sudo do
+        loom << :whoami
+        loom << :pwd
+        loom.x :touch, "root.file"
+
+        loom.user.add_system_user :postgres, uid: 999
+        loom.sudo user: :postgres do
+          loom << :whoami
+          loom.cd "/tmp" do
+            loom << :pwd
+            loom.x :touch, "postgres.file"
+          end
+        end
+        loom.user.remove :postgres
+
+        loom.x :touch, "root.file2"
+      end
+    end
+
+    loom.cd "/tmp" do
+      loom << :pwd
+      loom.sudo user: :root, cmd: :pwd do loom << :pwd end
+      loom << :pwd
+    end
+
+  end
+end
+
+module Parent
+  include Loom::Pattern
+
+  with_facts :outer_fact => :outer, :replaced => :original
+
+  before do
+    puts "Test::Parent => before"
+  end
+
+  after do
+    puts "Test::Parent => after"
+  end
+
+  desc "Checks facts on a parent pattern"
+  pattern :check_facts do |loom, facts|
+    unless facts[:outer_fact] == :outer
+      raise "expected outer fact => #{facts[:outer_fact]}"
+    end
+  end
+
+  let(:a_let_key) { "the value" }
+  let(:a_fact_based_let) { |facts| facts[:outer_fact].to_s + "/let" }
+  let(:a_referencing_let) { a_let_key + " referenced" }
+
+  desc "Checks let defines"
+  pattern :check_lets do |loom, facts|
+    raise "bad let :a_let_key" unless a_let_key == "the value"
+    raise "bad let :a_fact_based_let" unless a_fact_based_let == "outer/let"
+
+    unless a_referencing_let == "the value referenced"
+      raise "bad let :a_referencing_let => #{a_referencing_let}"
+    end
+
+    puts "a_let_key: %s" % a_let_key
+    puts "a_fact_based_let: %s" % a_fact_based_let
+  end
+
+  module Child
+    include Loom::Pattern
+
+    with_facts :inner_fact => :inner, :replaced => :override
+    let(:a_let_key) { |facts|  facts[:inner_fact].to_s + " overrides parent" }
+
+    before do
+      puts "Test::Parent::Child => before"
+    end
+
+    after do
+      puts "Test::Parent::Child => after"
+    end
+
+    desc "Check let overrides"
+    pattern :check_let_overrides do |loom, facts|
+      raise "bad let :a_let_key" unless a_let_key == "inner overrides parent"
+      raise "bad let :a_fact_based_let" unless a_fact_based_let == "outer/let"
+
+      puts "child a_let_key: %s" % a_let_key
+      puts "child a_fact_based_let: %s" % a_fact_based_let
+    end
+
+    desc "Checks inherited facts on a cihld pattern"
+    pattern :check_facts do |loom, facts|
+      unless facts[:inner_fact] == :inner
+        raise "expected inner fact => #{facts[:inner_fact]}"
+      end
+      unless facts[:outer_fact] == :outer
+        raise "expected outer fact => #{facts[:outer_fact]}"
+      end
+      unless facts[:replaced] == :override
+        raise "expected replaced fact => #{facts[:replaced_fact]}"
+      end
+    end
+  end
+end
+
+module User
+  include Loom::Pattern
+
+  desc "Adds a bunch of users and then removes them right away"
+  pattern :add_users do |loom, facts|
+    loom.sudo do
+      loom.user.add :nara, uid: 1001, home_dir: "/home/nara"
+      loom.user.add :marrian, home_dir: "/home/marrian"
+
+      loom.user.add_system_user :app, uid: 900
+      loom.user.add_system_user :batch
+
+      loom.user.remove :nara
+      loom.user.remove :marrian
+      loom.user.remove :app
+      loom.user.remove :batch
+    end
+  end
+
+  desc "Makes the postgres user a sudoer"
+  pattern :sudoers do |loom, facts|
+    loom.sudo do
+      loom.user.add_system_user :postgres, uid: 999
+      loom.user.make_sudoer :postgres
+      loom.user.remove :postgres
+    end
+  end
+end
+
+module Package
+  include Loom::Pattern
+
+  namespace :pkg
+
+  before do |loom, facts|
+    puts "#{self} in before"
+  end
+
+  after do
+    puts "#{self} in after"
+  end
+
+  desc "Updates the default package manager cache"
+  pattern :update_cache do |loom, facts|
+    loom.sudo { loom.pkg.update_cache }
+  end
+
+  desc "Installs Apache HTTP server"
+  pattern :install_httpd do |loom, facts|
+    loom.sudo do
+      loom.pkg.install 'apache2' unless loom.pkg.installed? 'apache2'
+    end
+  end
+
+  desc "Installs Facter GEM"
+  pattern :install_facter do |loom, facts|
+    loom.sudo do
+      loom.pkg[:gem].ensure_installed :facter
+    end
+  end
+end
+
+module ErrorHandling
+  include Loom::Pattern
+
+  namespace :err
+
+  desc "Handle SSH disconnection errors"
+  pattern :ssh_disconnect do |loom, facts|
+    if facts[:really_really_reboot]
+      loom.sudo cmd: :reboot
+    else
+      puts "to REALLY reboot set fact[:really_really_reboot] = true"
+    end
+  end
+end
+
+module VMs
+  include Loom::Pattern
+
+  desc "Check if some virtualbox vms exist"
+  pattern :vm_exists? do |loom, facts|
+    vm0_exists = loom.local.vbox.check_exists "vm0.local"
+    puts "Virtualbox VM 'vm0.local' exists: #{vm0_exists}"
+  end
+
+  desc "Check if some virtualbox vms exist"
+  pattern :list do |loom, facts|
+    loom.local.vbox.list
+  end
+
+  desc "Takes a snapshot of a VM"
+  pattern :snap do |loom, facts|
+    loom.local.vbox.snapshot "vm0.local", snapshot_name: "test:snap"
+    loom.local.vbox.snapshot "vm0.local", action: :delete, snapshot_name: "test:snap"
+  end
+end