chloride 0.1.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in chloride.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2016 Puppet Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,42 @@
+# Chloride [![Build Status](https://travis-ci.org/puppetlabs/chloride.svg?branch=master)](https://travis-ci.org/puppetlabs/chloride)
+
+A simple abstraction layer around NetSSH.
+
+Features:
+* `Host` allows you to easily SSH/SCP to a host using local SSH defaults
+* `Actions` allow you to automate you interactions with `Host`s
+* Create a sequence of `Actions` to be performed on `Host`s
+* Put it all together in order to automate your SSH-based workflows, such as
+  installing Puppet.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'chloride'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install chloride
+
+## Usage
+
+Check out the example [`go_execute` command](bin/go_execute)
+
+    $ bundle exec bin/go_execute 'abc123.example.com' 'cat /etc/hosts'
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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/puppetlabs/chloride. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:lint)
+
+task default: [:lint, :spec]

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'chloride'
+
+# 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.
+
+require 'pry'
+Pry.start

data/bin/go_execute

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'chloride'
+require 'optparse'
+
+opt_parse = OptionParser.new do |opts|
+  opts.banner = 'Usage: go_execute [options] hosts'
+  args = {}
+
+  opts.on('-h', '--help', 'Prints this help') do
+    puts opts
+    exit
+  end
+
+  args
+end
+
+if ARGV.length < 2
+  opt_parse.parse!(%w(--help))
+else
+  hostname = ARGV[0]
+  command = ARGV[1]
+  Chloride.go_execute(hostname, command)
+end

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/chloride.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'chloride/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'chloride'
+  spec.version       = Chloride::VERSION
+  spec.authors       = ['Brandon High', 'Eric Williamson', 'Nick Lewis']
+  spec.email         = ['brandon.high@puppet.com', 'eric.williamson@puppet.com', 'nick@puppet.com']
+
+  spec.summary       = 'A simple streaming NetSSH implementation'
+  # spec.description   = %q{TODO: More verbose description here.}
+  spec.homepage      = 'https://github.com/puppetlabs/chloride'
+  spec.license       = 'Apache-2.0'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1'
+  spec.add_development_dependency 'rake', '~> 11'
+  spec.add_development_dependency 'rspec', '~> 3'
+  spec.add_development_dependency 'simplecov', '~> 0.12'
+  spec.add_development_dependency 'pry', '~> 0.10'
+  spec.add_development_dependency 'pry-coolline', '~> 0.2'
+  spec.add_development_dependency 'rubocop', '~> 0.44'
+  spec.add_dependency 'net-ssh', '~> 3.2'
+  spec.add_dependency 'net-scp', '~> 1.2'
+end

data/lib/chloride.rb

@@ -0,0 +1,32 @@
+require 'chloride/version'
+require 'chloride/action/execute'
+require 'chloride/action/file_copy'
+require 'chloride/action/mkdir'
+require 'chloride/action/mktmp'
+require 'chloride/action/resolve_dns'
+require 'chloride/host'
+
+module Chloride
+  def self.go_execute(hostname, command)
+    host = Chloride::Host.new(hostname)
+    host.ssh_connect
+
+    remote_command = Chloride::Action::Execute.new(
+      host: host,
+      sudo: true,
+      cmd: command
+    )
+
+    remote_command.go do |event|
+      event.data[:messages].each do |data|
+        puts "[#{data.severity}:#{data.hostname}]: #{data.message}"
+      end
+    end
+
+    if remote_command.success?
+      puts "We were successful at running '#{command}' on #{hostname}"
+    else
+      puts "We failed to run '#{command}' with error code #{remote_command.status} on #{hostname}"
+    end
+  end
+end

data/lib/chloride/action.rb

@@ -0,0 +1,65 @@
+module Chloride
+  class Action
+    def initialize(_args)
+      @data = {}
+      @status = :initialized
+    end
+
+    def go(_update_block)
+      raise NotImplementedError, 'Action must implement a go method'
+    end
+
+    def update_proc(&stream_block)
+      proc do |info, stream, data|
+        if stream == :stdout
+          severity = :info
+        elsif stream == :stderr
+          severity = :warn
+        else
+          raise NotImplementedError, "Unknown stream #{stream}: #{data}"
+        end
+
+        progress_event = Chloride::Event.new(:action_progress, name)
+        message = Chloride::Event::Message.new(severity, info['hostname'], data)
+        progress_event.add_message(message)
+        stream_block.call(progress_event)
+      end
+    end
+
+    def exec_and_log(host, cmd, sudo, results, &stream_block)
+      event(host, cmd, &stream_block)
+      result = host.execute(cmd, sudo, &update_proc(&stream_block))
+
+      results[:stdout] = '' if results[:stdout].nil?
+      results[:stdout] += result[:stdout] || ''
+      results[:stderr] = '' if results[:stderr].nil?
+      results[:stderr] += result[:stderr] || ''
+      results[:exit_status] = result[:exit_status]
+
+      result
+    end
+
+    def event(host, message, &stream_block)
+      event = Chloride::Event.new(:action_progress, name)
+      msg = if host.localhost
+              "[localhost/#{host}] #{message}\n\n"
+            else
+              "[#{host}] #{message}\n\n"
+            end
+      event.add_message(Chloride::Event::Message.new(:info, host, msg))
+      stream_block.call(event)
+    end
+
+    def success?
+      false
+    end
+
+    def name
+      raise NotImplementedError, 'Action must have a name'
+    end
+
+    def description
+      raise NotImplementedError, 'Action must have a description'
+    end
+  end
+end

data/lib/chloride/action/execute.rb

@@ -0,0 +1,58 @@
+require 'chloride/errors'
+require 'chloride/event'
+require 'chloride/action'
+
+# Executes a shell command on the hosts provided. Will block until completion.
+module Chloride
+  class Action::Execute < Chloride::Action
+    attr_reader :results, :hosts
+
+    # TODO: Document args
+    def initialize(args)
+      super
+
+      @hosts = args[:hosts] || [args[:host]]
+      @cmd = args[:cmd]
+      @sudo = args[:sudo] || false
+    end
+
+    # TODO: Document block format
+    def go(&stream_block)
+      @status = :running
+      @results = {}
+      @hosts.each do |host|
+        cmd_event = Chloride::Event.new(:action_progress, name)
+        msg = if host.localhost
+                "[localhost/#{host}] #{@cmd}\n\n"
+              else
+                "[#{host}] #{@cmd}\n\n"
+              end
+        cmd_event.add_message(Chloride::Event::Message.new(:info, host, msg))
+        stream_block.call(cmd_event)
+        @results[host.hostname] = host.execute(@cmd, @sudo, &update_proc(&stream_block))
+      end
+
+      @results
+    end
+
+    def success?
+      @results.all? do |_host, result|
+        (result[:exit_status]).zero?
+      end
+    end
+
+    def error_message(hostname)
+      if @results.key?(hostname) && @results[hostname].key?(:stderr)
+        @results[hostname][:stderr].strip
+      end
+    end
+
+    def name
+      :execute
+    end
+
+    def description
+      "Execute `#{@cmd}` on #{@hosts.join(', ')}"
+    end
+  end
+end