chloride 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1b1d9fd43afd86f217fe0f203debb0324a911c42
-  data.tar.gz: d5fb4c549711b927d82f6419ab6603ef6285e571
+  metadata.gz: e24a2f7403f140127b82edf1f43edd11ba20ab57
+  data.tar.gz: 646409f9f55efbcd716d5edc14a7ff75c7240450
 SHA512:
-  metadata.gz: c0955bc1e67f7a11640e060e07306f0c04c54c3568e1486d599fa027e30f92ba9fb33cfdeafc7379ea0591ea9bd28d075920617414b39b4d9b84461b80f887ce
-  data.tar.gz: e092bb897e35bbf3183b81f90fca58cf10c23614b225dad3809a2088d7ed9218c1355f76e040913e7230b7fec7f8a15170a12c3cbf3c00958fb611d2940774bb
+  metadata.gz: 28e0249d6903a4b9722f3d29f99e3e46c15efa13ed1adac113749a6de581f9d3ada1d0bfe35c7fdec76bcefcd2d93447b0797c606fde8810b4730f8804033d98
+  data.tar.gz: 55f7169cd62cbde0153bb53f9047c7755eba4c6cfaefdba107f3e87fb41c76842952db5288b9287b8ca718f70ea1877945bce2f6551e46ca4695e614ad921a4f

data/.rubocop.yml

@@ -6,6 +6,9 @@
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
+AllCops:
+  TargetRubyVersion: 2.4
+
 # Offense count: 6
 # Configuration parameters: AllowSafeAssignment.
 Lint/AssignmentInCondition:
@@ -169,12 +172,12 @@ Style/Documentation:
     - 'lib/chloride/step/noop.rb'
 
 # Cop supports --auto-correct.
-Style/EmptyLines:
+Layout/EmptyLines:
   AutoCorrect: true
 
 # Cop supports --auto-correct.
 # Configuration parameters: AllowForAlignment, ForceEqualSignAlignment.
-Style/ExtraSpacing:
+Layout/ExtraSpacing:
   AutoCorrect: true
 
 # Configuration parameters: EnforcedStyle, SupportedStyles.
@@ -204,22 +207,22 @@ Style/IfUnlessModifier:
 
 # Configuration parameters: EnforcedStyle, SupportedStyles.
 # SupportedStyles: normal, rails
-Style/IndentationConsistency:
+Layout/IndentationConsistency:
   Enabled: true
 
 # Cop supports --auto-correct.
 # Configuration parameters: Width.
-Style/IndentationWidth:
+Layout/IndentationWidth:
   AutoCorrect: true
 
 # Cop supports --auto-correct.
-Style/LeadingCommentSpace:
+Layout/LeadingCommentSpace:
   AutoCorrect: true
 
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles.
 # SupportedStyles: symmetrical, new_line, same_line
-Style/MultilineMethodCallBraceLayout:
+Layout/MultilineMethodCallBraceLayout:
   AutoCorrect: true
 
 # Cop supports --auto-correct.
@@ -270,40 +273,40 @@ Style/RedundantSelf:
   AutoCorrect: true
 
 # Cop supports --auto-correct.
-Style/SpaceAfterComma:
+Layout/SpaceAfterComma:
   AutoCorrect: true
 
 # Cop supports --auto-correct.
-Style/SpaceAfterNot:
+Layout/SpaceAfterNot:
   AutoCorrect: true
 
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles.
 # SupportedStyles: space, no_space
-Style/SpaceAroundEqualsInParameterDefault:
+Layout/SpaceAroundEqualsInParameterDefault:
   AutoCorrect: true
 
 # Cop supports --auto-correct.
 # Configuration parameters: AllowForAlignment.
-Style/SpaceAroundOperators:
+Layout/SpaceAroundOperators:
   AutoCorrect: true
 
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles.
 # SupportedStyles: space, no_space
-Style/SpaceBeforeBlockBraces:
+Layout/SpaceBeforeBlockBraces:
   Enabled: true
 
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles, EnforcedStyleForEmptyBraces, SpaceBeforeBlockParameters.
 # SupportedStyles: space, no_space
-Style/SpaceInsideBlockBraces:
+Layout/SpaceInsideBlockBraces:
   AutoCorrect: true
 
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces, SupportedStyles.
 # SupportedStyles: space, no_space, compact
-Style/SpaceInsideHashLiteralBraces:
+Layout/SpaceInsideHashLiteralBraces:
   AutoCorrect: true
 
 # Cop supports --auto-correct.
@@ -313,6 +316,9 @@ Style/StringLiterals:
   Enabled: true
   AutoCorrect: true
 
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
 # Configuration parameters: EnforcedStyle, SupportedStyles.
 # SupportedStyles: single_quotes, double_quotes
 Style/StringLiteralsInInterpolation:
@@ -327,7 +333,9 @@ Style/TernaryParentheses:
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyleForMultiline, SupportedStyles.
 # SupportedStyles: comma, consistent_comma, no_comma
-Style/TrailingCommaInLiteral:
+Style/TrailingCommaInArrayLiteral:
+  AutoCorrect: true
+Style/TrailingCommaInHashLiteral:
   AutoCorrect: true
 
 # Cop supports --auto-correct.
@@ -359,3 +367,20 @@ Style/WordArray:
 # Cop supports --auto-correct.
 Style/ZeroLengthPredicate:
   AutoCorrect: true
+
+# I'll be a terse as I want to
+Naming/UncommunicativeMethodParamName:
+  Enabled: false
+
+# Don't like the %i style.
+Style/SymbolArray:
+  Enabled: false
+
+# if code_is_poetry
+#   make_a_block_if_you_want_to
+# end
+Style/IfUnlessModifier:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false

data/.travis.yml

@@ -1,4 +1,4 @@
 language: ruby
 rvm:
-  - 2.2
-  - 2.1
+  - 2.4
+  - 2.5

data/README.md

@@ -1,4 +1,7 @@
-# Chloride [![Build Status](https://travis-ci.org/puppetlabs/chloride.svg?branch=master)](https://travis-ci.org/puppetlabs/chloride)
+# Chloride
+[![Gem Version](https://badge.fury.io/rb/chloride.svg)](https://badge.fury.io/rb/chloride)
+[![Build Status](https://travis-ci.org/puppetlabs/chloride.svg?branch=master)](https://travis-ci.org/puppetlabs/chloride)
+[![Issue Count](https://codeclimate.com/github/puppetlabs/chloride/badges/issue_count.svg)](https://codeclimate.com/github/puppetlabs/chloride)
 
 A simple abstraction layer around NetSSH.
 

data/Rakefile

@@ -5,4 +5,4 @@ require 'rubocop/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 RuboCop::RakeTask.new(:lint)
 
-task default: [:lint, :spec]
+task default: [:spec, :lint]

data/bin/go_execute

@@ -17,7 +17,7 @@ opt_parse = OptionParser.new do |opts|
 end
 
 if ARGV.length < 2
-  opt_parse.parse!(%w(--help))
+  opt_parse.parse!(%w[--help])
 else
   hostname = ARGV[0]
   command = ARGV[1]

data/chloride.gemspec

@@ -1,5 +1,4 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'chloride/version'
 
@@ -21,13 +20,14 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '~> 2.4'
+
   spec.add_development_dependency 'bundler', '~> 1'
+  spec.add_development_dependency 'pry'
   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', '~> 2'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'simplecov'
   spec.add_dependency 'net-scp', '~> 1'
+  spec.add_dependency 'net-ssh', '~> 4'
 end

data/lib/chloride.rb

@@ -5,6 +5,7 @@ require 'chloride/action/mkdir'
 require 'chloride/action/mktmp'
 require 'chloride/action/resolve_dns'
 require 'chloride/host'
+require 'chloride/ssh_known_hosts'
 
 module Chloride
   def self.go_execute(hostname, command)
@@ -29,4 +30,31 @@ module Chloride
       puts "We failed to run '#{command}' with error code #{remote_command.status} on #{hostname}"
     end
   end
+
+  def self.go_action(hostname, action, opts)
+    host = Chloride::Host.new(hostname)
+    host.ssh_connect
+
+    action_class =  case action
+                    when 'file_copy'
+                      opts[:to_host] = host
+                      Chloride::Action::FileCopy
+                    else
+                      raise "Unknown or unsupported action #{action_class}"
+                    end
+
+    remote_action = action_class.new(opts)
+
+    remote_action.go do |event|
+      event.data[:messages].each do |data|
+        puts "[#{data.severity}:#{data.hostname}]: #{data.message}"
+      end
+    end
+
+    if remote_action.success?
+      puts "We were successful at running '#{action}' on #{hostname}"
+    else
+      puts "We failed to run '#{action}' with error code #{remote_action.status} on #{hostname}"
+    end
+  end
 end

data/lib/chloride/action/detect_platform.rb

@@ -127,7 +127,7 @@ class Chloride::Action::DetectPlatform < Chloride::Action
         if (suse_release[:exit_status]).zero?
           stdout = suse_release[:stdout]
 
-          if /Enterprise Server/ =~ stdout
+          if stdout.match?(/Enterprise Server/)
             distribution = :sles
             release = /^VERSION = (\d*)/m.match(stdout)[1]
           end
@@ -141,7 +141,7 @@ class Chloride::Action::DetectPlatform < Chloride::Action
         if (system_release[:exit_status]).zero?
           stdout = system_release[:stdout]
 
-          if /amazon linux/im =~ stdout
+          if stdout.match?(/amazon linux/im)
             distribution = :amazon
             # How is this safe to assume?
             release = '6'

data/lib/chloride/executor.rb

@@ -6,7 +6,7 @@ class Chloride::Executor
 
   def publish(event, action_id = nil)
     event.action_id = action_id if action_id
-    @stream_block.call(event) if @stream_block
+    @stream_block&.call(event)
   end
 
   def execute(steps)

data/lib/chloride/host.rb

@@ -5,9 +5,10 @@ require 'strscan'
 require 'open3'
 require 'timeout'
 require 'json'
+require 'chloride/ssh_known_hosts'
 
 class Chloride::Host
-  attr_reader :data, :remote_conn, :hostname, :username, :ssh_key_file, :ssh_key_passphrase, :localhost
+  attr_reader :remote_conn, :hostname, :username, :ssh_key_file, :ssh_key_passphrase, :localhost
   attr_accessor :data
 
   def initialize(hostname, config = {})
@@ -26,6 +27,7 @@ class Chloride::Host
     @data = {}
     @timeout = 60
     @ssh_status = nil
+    @known_hosts_file = config[:known_hosts] || 'known_hosts'
   end
 
   # Initializes SSH connection/session to host. Must be called before {#ssh} or {#scp}.
@@ -44,7 +46,8 @@ class Chloride::Host
         passphrase: @ssh_key_passphrase,
         password: @sudo_password,
         logger: logger,
-        verbose: :warn
+        verbose: :warn,
+        known_hosts: Chloride::SSHKnownHosts.new(@known_hosts_file)
       }.reject { |_, v| v.nil? }
 
       ssh_opts[:keys] = [@ssh_key_file] if @ssh_key_file
@@ -55,7 +58,7 @@ class Chloride::Host
         @ssh_status = :connected
       }
     end
-  rescue Net::SSH::AuthenticationFailed => err
+  rescue Net::SSH::AuthenticationFailed => _
     @ssh_status = :error
     log.rewind
     raise("Authentication failed while attempting to SSH to #{@username}@#{@hostname}: \n#{log.read}")
@@ -149,6 +152,7 @@ class Chloride::Host
     buffers = { stdout: StringScanner.new(''), stderr: StringScanner.new('') }
     buffer_proc = proc do |info, stream, data|
       raise NotImplementedError, "Unknown stream #{stream}" unless [:stdout, :stderr].include? stream
+
       buffers[stream] << data
       while l = buffers[stream].scan_until(/\n/)
         send.call(info, stream, l)
@@ -268,12 +272,12 @@ class Chloride::Host
       ch.wait
 
       true
-    elsif data =~ /^#{@username} is not in the sudoers file./
+    elsif data.match?(/^#{@username} is not in the sudoers file./)
       # Sudo failed, wrong user. Bail out.
       stream_block.call(info, :stderr, "Cannot proceed: User #{@username} does not have sudo permission.")
       raise Chloride::RemoteError, "User #{@username} does not have sudo permission"
     # This could be a terrible bug.
-    elsif data =~ /Sorry, try again./
+    elsif data.match?(/Sorry, try again./)
       # Sudo failed, wrong password. Bail out.
       stream_block.call(info, :stderr, 'Cannot proceed: Sudo password not recognized.')
       raise Chloride::RemoteError, 'Sudo password not recognized'

data/lib/chloride/ssh_known_hosts.rb

@@ -0,0 +1,20 @@
+# Dummy KnownHosts implementation
+#
+# This exists to stop Net::SSH from writing to the user's known_hosts file
+# Instead, new host signatures are saved to a library-specific file.
+class Chloride::SSHKnownHosts < Net::SSH::KnownHosts
+  # Method signatures inherited from Net::SSH::KnownHosts
+  # def initialize(source)
+  # def hostfiles(options, which=:all)
+  # def search_in(files, host)
+  # def keys_for(host)
+  # def known_host_hash?(hostlist, entries, scanner)
+  # def add(host, key)
+  # def add(host, key, options={})
+
+  # Must be implemented
+  def search_for(host, options = {})
+    opts = {}.merge(options).merge(user_known_hosts_file: source)
+    Net::SSH::KnownHosts.search_for(host, opts)
+  end
+end

data/lib/chloride/version.rb

@@ -1,3 +1,3 @@
 module Chloride
-  VERSION = '0.2.3'.freeze
+  VERSION = '0.3.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chloride
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Brandon High
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-13 00:00:00.000000000 Z
+date: 2018-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -27,117 +27,103 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1'
 - !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '11'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '11'
-- !ruby/object:Gem::Dependency
-  name: rspec
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '11'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '3'
 - !ruby/object:Gem::Dependency
-  name: pry-coolline
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.44'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.44'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: net-ssh
+  name: net-scp
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '1'
 - !ruby/object:Gem::Dependency
-  name: net-scp
+  name: net-ssh
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '4'
 description: 
 email:
 - brandon.high@puppet.com
@@ -173,6 +159,7 @@ files:
 - lib/chloride/event/message.rb
 - lib/chloride/executor.rb
 - lib/chloride/host.rb
+- lib/chloride/ssh_known_hosts.rb
 - lib/chloride/step.rb
 - lib/chloride/step/noop.rb
 - lib/chloride/version.rb
@@ -186,9 +173,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -196,7 +183,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.5
+rubygems_version: 2.6.14.1
 signing_key: 
 specification_version: 4
 summary: A simple streaming NetSSH implementation