assemblr 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a56be997b4579f72b563f67e40f81a2aaaec974dc2568a345528e9171b0813c1
+  data.tar.gz: 2d08815cb4b1c2d2245c75a9337a7586dfa2ef7e646ed726d8ed6527c90166c6
+SHA512:
+  metadata.gz: 7571588a2718e3ed241d328b5d25d9fd9efb75054bee707c27d65b549e3dd944e909dc715d93958a0eeb18386cffead01d92306a800a3957d6b4dae5aeac9fa9
+  data.tar.gz: cb10006737feca4ee02d42af22b6d06e9fc4fea7ae258d374f27e3363c37bcc03abf3877280cf29812d52ff9ae2fc2d4f5f5677752468dbca6d5f29b82f03a70

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/
+/examples/
+
+/Gemfile.lock
+/.rakeTasks

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in assemblr.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Ryan Burmeister-Morrison
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,84 @@
+# Assemblr
+
+A small DSL for the construction of quick automation tasks.
+
+**NOTE:** This version is just a prototype. It will be completely re-written.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'assemblr'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install assemblr
+
+## Usage
+
+This is an example of a simple assemblr script:
+
+```ruby
+# frozen_string_literal: true
+
+require 'assemblr'
+
+# Configuration options. The values listed below are the defaults for assemblr.
+set :default_user, 'root'     # set the default user nodes are assigned to
+set :default_group, 'default' # set the default group nodes are assigned to
+set :log, true                # turn on or off built-in logging.
+set :quit_on_error, true      # quit if anything goes wrong.
+
+group :dev_servers do
+  # Define nodes. All nodes defined in this block will be added to the
+  # specified group (:dev_servers). After the block ends, the default user and
+  # group will be restored for any other top-level node definitions.
+  node '10.0.0.173'
+  node '10.0.0.332'
+  node '10.0.1.22'
+end
+
+node '10.0.0.33' # assigned to group :default and user 'root' as per the
+                 # defaults
+
+group :dev_servers do
+  upload 'Gemfile', '/tmp/Gemmm' # upload a file to all nodes in a group
+  upload 'lib', '/tmp',
+         recursive: true # upload a directory to all nodes in a group
+
+  remote_exec 'echo "Hello, world!"'
+end
+
+upload_to '10.0.2.43', 'root', 'message.txt', '/home/user/message.txt'
+result = remote_exec_on 'ruby', inject: ['puts "Hello, world!"', 'exit']
+
+puts result
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can
+also run `bin/console` for an interactive prompt that will allow you to
+experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/rburmorrison/assemblr.
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+task default: :spec
+
+task 'rubocop' do
+  sh 'rubocop *'
+end

data/assemblr.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative 'lib/assemblr/version'
+
+Gem::Specification.new do |spec|
+  spec.name     = 'assemblr'
+  spec.version  = Assemblr::VERSION
+  spec.authors  = ['Ryan Burmeister-Morrison']
+  spec.email    = ['rburmeistermorrison@gmail.com']
+
+  spec.summary  = 'A small DSL for the construction of quick automation tasks.'
+  spec.homepage = 'https://github.com/rburmorrison/assemblr'
+  spec.license  = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/rburmorrison/assemblr'
+
+  # Specify which files should be added to the gem when it is released. The `git
+  # ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rubocop', '~> 0.80'
+
+  spec.add_runtime_dependency 'net-ping', '~> 2.0'
+  spec.add_runtime_dependency 'net-scp', '~> 2.0'
+  spec.add_runtime_dependency 'net-ssh', '~> 5.2'
+  spec.add_runtime_dependency 'tty-logger', '~> 0.3'
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'assemblr'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/assemblr.rb

@@ -0,0 +1,275 @@
+# frozen_string_literal: true
+
+require 'assemblr/version'
+require 'assemblr/logging'
+require 'assemblr/utilities'
+
+require 'open3'
+require 'net/ssh'
+require 'net/scp'
+
+module Assemblr
+  $VERBOSE = nil # turn off warnings from external libraries
+
+  # Local variables are prefixed with an 'm' for 'Module' as to not clash with
+  # method names.
+  m_nodes = []
+  m_current_group = 'default'
+  m_current_user = 'root'
+
+  ##
+  # Set a configuration option.
+  #
+  # Available options are:
+  #
+  # - *default_user*  - the default user to assign nodes to
+  # - *default_group* - the default group to assign nodes to
+  # - *log*           - turn on or off logging
+  # - *quit_on_error* - quit if any error occur
+  #
+  # @return [void]
+  define_method :set do |key, value|
+    options = %i[log quit_on_error default_user default_group]
+    unless options.include?(key)
+      raise ArgumentError, "#{key} is not a valid option"
+    end
+
+    key = :current_user if key == :default_user
+    key = :current_group if key == :default_group
+
+    info %(config: set "#{key}" to "#{value}")
+    eval "m_#{key} = value", binding, __FILE__, __LINE__
+  end
+
+  ##
+  # @!method local_exec(cmd, inject: [])
+  # Execute a command locally.
+  #
+  # @param cmd [String] the command to run locally
+  # @param inject [Array<String>] strings to inject into stdin
+  #
+  # @return [Array(String, Process::Status)]
+  define_method :local_exec do |cmd, inject: []|
+    log_string = "running `#{cmd}` locally"
+    log_string += " with these inputs: #{inject}" unless inject.empty?
+    info log_string
+
+    result = ''
+    status = nil
+    Open3.popen2e(cmd) do |i, o, wait|
+      inject.each do |line|
+        line = line.strip
+        i.write line + "\n"
+      end
+      i.close
+      result = o.read
+      status = wait.value
+    end
+
+    if status.exitstatus != 0
+      code = status.exitstatus
+      error "local command `#{cmd}` exited with a status of #{code}"
+    else
+      success "local command `#{cmd}` executed successfully"
+    end
+
+    return result, status
+  end
+
+  ##
+  # Execute a command on a remote machine using SSH. It returns the combined
+  # stdout and stderr data.
+  #
+  # @param ip [String] the ip of the node to run the command on
+  # @param user [String] the user to log in as
+  # @param cmd [String] the command to execute remotely
+  # @param inject [Array<String>] strings to inject into stdin
+  #
+  # @return [String]
+  # @return [Array<String>]
+  def remote_exec_on(ip, user, cmd, inject: [])
+    info "attempting to execute `#{cmd}` on #{user}@#{ip}"
+
+    result = ''
+    Net::SSH.start(ip, user) do |ssh|
+      ch = ssh.open_channel do |ch|
+        ch.exec(cmd) do |ch, success|
+          error "unable to execute `#{cmd}` on #{user}@#{ip}" unless success
+
+          # Collect stdout data.
+          ch.on_data do |_, data|
+            result += data if data.is_a?(String)
+          end
+
+          # Collect stderr data.
+          ch.on_extended_data do |_, _, data|
+            result += data if data.is_a?(String)
+          end
+
+          inject.each do |line|
+            ch.send_data(line + "\n")
+          end
+
+          ch.on_request 'exit-status' do |_, data|
+            code = data.read_long
+            if code.zero?
+              success "`#{cmd}` executed successfully on #{user}@#{ip}"
+            else
+              error "`#{cmd}` returned status code #{code} on #{user}@#{ip}"
+            end
+          end
+        end
+      end
+
+      ch.wait
+    end
+    result
+  end
+
+  ##
+  # Upload a file to a node.
+  #
+  # @param ip [String] the node to upload to
+  # @param user [String] the user to authenticate as
+  # @param src [String] the file to upload
+  # @param dest [String] the location to upload to
+  # @param recursive [Bool] recursively upload files in a directory
+  # @param timeout [Integer] how many seconds to wait before throwing an error
+  #
+  # @return [void]
+  def upload_to(ip, user, src, dest, recursive: false, timeout: 5)
+    info %(attempting to upload "#{src}" to #{user}@#{ip}:#{dest})
+    Timeout.timeout timeout do
+      Net::SCP.upload!(ip, user, src, dest, recursive: recursive)
+    end
+  rescue StandardError
+    error %(failed to upload "#{src}" to #{user}@#{ip}:#{dest})
+  rescue Timeout::Error
+    error %(failed to upload "#{src}" to #{user}@#{ip}:#{dest} within #{timeout} seconds)
+  else
+    success %(uploaded "#{src}" to #{user}@#{ip}:#{dest})
+  end
+
+  ##
+  # @!method current_nodes()
+  # Get all nodes in the current group.
+  #
+  # @return [void]
+  define_method :current_nodes do
+    return nodes if m_current_group == 'all'
+
+    nodes.select { |n| n[:group] == m_current_group }
+  end
+
+  ##
+  # Execute a command on all machines within the current group.
+  #
+  # @param cmd [String] the command to execute
+  # @param inject [Array<String>] strings to inject into stdin
+  #
+  # @return [String] the combined output of the command
+  def remote_exec(cmd, inject: [])
+    results = []
+    current_nodes.each do |n|
+      result = remote_exec_on(n[:ip], n[:user], cmd, inject: inject)
+      results << result
+    end
+    results
+  end
+
+  ##
+  # Upload a file or directory to all machines within the current group.
+  #
+  # @param src [String] the file to upload
+  # @param dest [String] the location to upload the file to
+  # @param recursive [Bool] recursively upload files in a directory
+  # @param timeout [Integer] how many seconds to wait before throwing an error
+  #
+  # @return [void]
+  def upload(src, dest, recursive: false, timeout: 5)
+    current_nodes.each do |n|
+      upload_to(n[:ip], n[:user], src, dest, recursive: recursive)
+    end
+  end
+
+  ##
+  # @!method group(group, &block)
+  # Temporarily change current_group to refer to the specified group while
+  # within the passed block.
+  #
+  # @param group [Symbol] the group to temporarily switch to
+  #
+  # @return [void]
+  define_method :group do |group, &block|
+    info %(entered group block with group "#{group}")
+
+    # Temporarily switch to the target group.
+    old_current_group = m_current_group
+    m_current_group = group.to_s
+
+    block.call
+
+    m_current_group = old_current_group
+
+    info %(exited group block with group "#{group}")
+  end
+
+  ##
+  # @!method current_group
+  # Get the current default group.
+  #
+  # @return [String]
+
+  ##
+  # @!method current_user
+  # Get the current default user.
+  #
+  # @return [String]
+  %w[group user].each do |item|
+    define_method "current_#{item}" do
+      eval "m_current_#{item}"
+    end
+  end
+
+  ##
+  # @!method node(ip, group: current_group, user: current_user)
+  # Add a node to the list of nodes.
+  #
+  # @param ip [String] the ip address of the node
+  # @param group [Symbol] the group to assign the node to
+  # @param user [String] the user to associate with the node
+  #
+  # @return [Hash{ip=>String, group=>String, user=>String}] the added node
+  define_method :node do |ip, group: m_current_group, user: m_current_user|
+    group = group.to_s
+    if group == 'all'
+      error = ArgumentError.new('nodes can not be assigned to the "all" group')
+      raise error
+    end
+
+    l_node = { ip: ip, group: group, user: user }
+    m_nodes << l_node
+    info "added node: #{l_node}"
+
+    l_node
+  end
+
+  ##
+  # @!method nodes()
+  # Get all registered nodes.
+  #
+  # @return [Array<Hash{ip=>String, group=>String, user=>String}>]
+  define_method :nodes do
+    m_nodes
+  end
+
+  define_method :nodes_reachable? do
+    reachable = true
+    m_nodes.each do |node|
+      reachable &&= reachable?(node[:ip])
+    end
+    reachable
+  end
+end
+
+extend Assemblr

data/lib/assemblr/logging.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'tty-logger'
+
+module Assemblr
+  Logger = TTY::Logger.new do |config|
+    config.metadata = %i[time date]
+  end
+
+  m_log = true
+  m_quit_on_error = true
+
+  ##
+  # @!method info(message)
+  # Logs an info message.
+  #
+  # @return [void]
+
+  ##
+  # @!method success(message)
+  # Logs a success message.
+  #
+  # @return [void]
+
+  ##
+  # @!method warn(message)
+  # Logs a warning message.
+  #
+  # @return [void]
+  %i[info success warn].each do |level|
+    define_method level do |*args, &block|
+      return unless m_log
+
+      Logger.send(level, *args, &block)
+    end
+  end
+
+  ##
+  # @!method error(message)
+  # Logs a error message. If configured, this will end the task with error code
+  # 1.
+  #
+  # @return [void]
+  define_method :error do |*args, &block|
+    Logger.send(:error, *args, &block) if m_log
+    exit 1 if m_quit_on_error
+  end
+end

data/lib/assemblr/utilities.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'socket'
+require 'net/ping'
+
+##
+# A collection of utility functions for assemblr.
+module Assemblr
+  ##
+  # Retrieve the first ip address that is not '127.0.0.1' on the local machine.
+  #
+  # @param pattern [Regexp] a pattern to test the ips against
+  def get_local_ip(pattern = //)
+    Socket.ip_address_list.each do |ip|
+      address = ip.ip_address
+      next if address == '127.0.0.1'
+      return address if address.match?(pattern)
+    end
+    ''
+  end
+
+  ##
+  # Check if a remote machine can be contacted.
+  #
+  # @return [Bool]
+  def reachable?(ip)
+    external = Net::Ping::External.new(ip)
+
+    info %(attempting to contact host "#{ip}"...)
+    reachable = external.ping || external.ping6
+    if reachable
+      success %(host "#{ip}" is reachable)
+    else
+      error %(unable to contact host "#{ip}")
+    end
+
+    reachable
+  end
+end

data/lib/assemblr/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Assemblr
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: assemblr
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ryan Burmeister-Morrison
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-03-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.80'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.80'
+- !ruby/object:Gem::Dependency
+  name: net-ping
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: net-scp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: tty-logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+description: 
+email:
+- rburmeistermorrison@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- assemblr.gemspec
+- bin/console
+- bin/setup
+- lib/assemblr.rb
+- lib/assemblr/logging.rb
+- lib/assemblr/utilities.rb
+- lib/assemblr/version.rb
+homepage: https://github.com/rburmorrison/assemblr
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/rburmorrison/assemblr
+  source_code_uri: https://github.com/rburmorrison/assemblr
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: A small DSL for the construction of quick automation tasks.
+test_files: []