norad_serverspec_runner 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eee7ff3f28d053afd09840c243f163515db55fd7
+  data.tar.gz: 3c715d54f3448974c595008864e587b92c3ce6b5
+SHA512:
+  metadata.gz: 3321b88c496de298540e9e89ef92fba76c0c5c696ddf4cc122f50c5b32b4eafa5196349272be3a656fa06b4af93ca76f7e5533f90f2b5fd87b5da8f8f865e30a
+  data.tar.gz: 835eee0c088532ad6a9272efa74760cfebc9cc70975e04b3d933a5239267741cbd39e5d3209e6c659562b511a2aee2ed99623a9f1c244c05c81280dd87228d3f

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.gitlab-ci.yml

@@ -0,0 +1,23 @@
+stages:
+  - release
+
+image: ruby:2.4.0
+
+before_script:
+  - bundle install --jobs=4 --with development
+
+publish:
+  stage: release
+  script:
+    - echo "---" > ~/.gem/credentials
+    - COLON=':' && echo "${COLON}rubygems_api_key${COLON} ${RUBYGEMS_API_KEY}" >> ~/.gem/credentials
+    - git config --global user.email "norad.dev@gmail.com"
+    - git config --global user.name "Norad Release"
+    - git config --global push.default simple
+    - chmod 0600 ~/.gem/credentials
+    - bundle exec rake build
+    - bundle exec rake release:guard_clean
+    - gem push `ls ./pkg/norad_serverspec_runner-*.gem`
+    - rm -fr ~/.gem
+  only:
+    - master

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+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 2015 Cisco Systems, 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,40 @@
+# ServerspecRunner
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/serverspec_runner`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'norad_serverspec_runner'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install norad_serverspec_runner
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 Gitlab at https://gitlab.com/norad/serverspec_runner.
+
+
+## License
+
+The gem is available as open source under the terms of the [Apache 2.0 License](https://opensource.org/licenses/Apache-2.0).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/norad_serverspec_runner

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'serverspec_runner'
+ServerspecRunner::Cli.start(ARGV)

data/lib/serverspec_runner.rb

@@ -0,0 +1,6 @@
+require 'serverspec_runner/version'
+require 'serverspec_runner/cli'
+require 'serverspec_runner/task'
+
+module ServerspecRunner
+end

data/lib/serverspec_runner/cli.rb

@@ -0,0 +1,47 @@
+require 'thor'
+require 'serverspec_runner/task'
+require 'base64'
+require 'openssl'
+
+module ServerspecRunner
+  # Drives the CLI for serverspec_runner
+  class Cli < Thor
+    desc 'remote encoded_key', 'Will test a server using serverspec'
+    long_desc <<-SPEC_REMOTE
+
+    `serverspec_runner remote` will ssh into a server and run serverspec tests
+    SPEC_REMOTE
+    method_option :host, :aliases => '-h', :desc => 'Host to scan'
+    method_option :username, :aliases => '-u', :desc => 'Username to login as'
+    method_option :sshkey, :aliases => '-k', :desc => 'SSH Key to use', :default => '/tmp/sshkey'
+    method_option :tests, :aliases => '-t', :desc => 'Serverspec tests to execute'
+    method_option :sub_tests, :aliases => '-s', :desc => 'Specific test from given serverspec file', :default => '\'\''
+    method_option :results_file, :aliases => '-r', :desc => 'File to store the results'
+    method_option :port, :aliases => '-p', :desc => 'Port to connect on', :default => 22
+    def remote(encoded_key)
+      spectask = ServerspecRunner::Task.new(options[:tests], options[:sub_tests], options[:results_file])
+
+      spectask.host = options[:host]
+      spectask.username = options[:username]
+      spectask.ssh_port = options[:port]
+      # Decode the key and store
+      File.open(options[:sshkey], "w") do |f|
+        f.write Base64.decode64(encoded_key)
+      end
+      spectask.sshkey = options[:sshkey]
+      spectask.run
+    end
+
+    desc 'local', 'Will execute serverspec tests locally'
+    long_desc <<-SPEC_LOCAL
+
+    `serverspec_runner local` will run serverspec tests locally
+    SPEC_LOCAL
+    method_option :tests, :aliases => '-t', :desc => 'Serverspec tests to execute'
+    method_option :results_file, :aliases => '-r', :desc => 'File to store the results'
+    def local
+      spectask = ServerspecRunner::Task.new(options[:tests], options[:results_file])
+      spectask.run
+    end
+  end
+end

data/lib/serverspec_runner/task.rb

@@ -0,0 +1,83 @@
+require 'rspec'
+require 'rspec/core/rake_task'
+require 'net/ssh'
+
+module ServerspecRunner
+  # Class to run serverspec tests
+  class Task
+    SSH_TIMEOUT = 10
+
+    attr_accessor :host
+    attr_accessor :username
+    attr_accessor :sshkey
+    attr_accessor :ssh_port
+
+    def initialize(tests, sub_tests, results_file)
+      @obj = RSpec::Core::RakeTask.new(@host) do |_|
+        true
+      end
+
+      # FIXME: Sanitize the path, make sure no directory traversal
+      @obj.pattern = "#{File.dirname(__FILE__)}/../tests/" + tests
+      @obj.rspec_opts = "-e #{sub_tests} --format json -o #{results_file}"
+      @results_file = results_file
+    end
+
+    # Check if given host/ip is reachable and we can ssh as root
+    # If not, then create empty log file for that host and return false.
+    def unable_to_ssh?
+      session = Net::SSH.start( @host, @username, :port => @ssh_port, :timeout => SSH_TIMEOUT, :auth_methods => ['publickey'], :keys => [@sshkey] )
+      session.exec('ls')
+      session.close()
+      false
+    rescue Net::SSH::AuthenticationFailed, Net::SSH::ConnectionTimeout, Net::SSH::Timeout, Net::SSH::Exception, Errno::ECONNREFUSED, Errno::EHOSTUNREACH => e
+      p e
+      write_error_to_results_file e.message
+      true
+    end
+
+    def run
+      pstderr = STDERR.dup
+      ftmp = Tempfile.open('eout')
+      FileUtils.touch @results_file
+      return if unable_to_ssh?
+
+      # Run the rspec tests
+      if defined?(@host) and defined?(@username) and defined?(@sshkey)
+        ENV['AUDIT_HOST'] = @host
+        ENV['AUDIT_USERNAME'] = @username
+        ENV['AUDIT_SSHKEY'] = @sshkey
+        ENV['AUDIT_SSH_PORT'] = @ssh_port
+      end
+
+      # Capture STDERR for SSH related errors
+      STDERR.reopen(ftmp)
+      @obj.run_task(true)
+    rescue SystemExit => e
+      ftmp.rewind
+      err = ftmp.read
+      ftmp.close
+      p err
+      # We land here even on successful run (SystemExit exception), only report error if stderr is not empty
+      if err =~ /Please set sudo password to Specinfra.configuration.sudo_password|set :request_pty, true/
+        write_error_to_results_file "SSH user #{@username} requires SUDO permission with NOPASSWD: option set."
+      elsif not err.empty?
+        write_error_to_results_file err
+      end
+    rescue Exception => e
+      # Unknown exception!
+      write_error_to_results_file e.message
+    ensure
+      STDERR.reopen pstderr
+    end
+
+    private
+
+    def write_error_to_results_file(error)
+      File.open(@results_file, "w") do |f|
+        f.write "!! NORAD SPECS SSH ERROR !!\nError: #{error}\n"
+      end
+    end
+  end
+end
+

data/lib/serverspec_runner/version.rb

@@ -0,0 +1,3 @@
+module ServerspecRunner
+  VERSION = "0.1.0"
+end

data/serverspec_runner.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'serverspec_runner/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "norad_serverspec_runner"
+  spec.version       = ServerspecRunner::VERSION
+  spec.authors       = ["Brian Manifold", "Blake Hitchcock", "Roger Seagle"]
+  spec.email         = ['norad.dev@gmail.com']
+
+  spec.summary       = %q{Gem to help with serverspec.}
+  spec.description   = %q{Gem to help with serverspec.}
+  spec.homepage      = "https://gitlab.com/norad/serverspec-runner"
+  spec.license       = "Apache-2.0"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'serverspec'
+  spec.add_dependency 'rspec'
+  spec.add_dependency 'rspec-expectations'
+  spec.add_dependency 'thor'
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: norad_serverspec_runner
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brian Manifold
+- Blake Hitchcock
+- Roger Seagle
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: serverspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Gem to help with serverspec.
+email:
+- norad.dev@gmail.com
+executables:
+- norad_serverspec_runner
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rspec"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/norad_serverspec_runner
+- lib/serverspec_runner.rb
+- lib/serverspec_runner/cli.rb
+- lib/serverspec_runner/task.rb
+- lib/serverspec_runner/version.rb
+- serverspec_runner.gemspec
+homepage: https://gitlab.com/norad/serverspec-runner
+licenses:
+- Apache-2.0
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: Gem to help with serverspec.
+test_files: []