omnitest-core 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bdb34e38c505f97708ebeea946cf17c9fd6c4c8e
+  data.tar.gz: 57c68bab3e68e34e8e11d28778521b0f168cafe4
+SHA512:
+  metadata.gz: 57c9056f0e7b5dc6d09404c8ebc019989b415b998d6015850fe798cdf3596188781a5c5bba8d93f6d311914ee787efe526d11716809fc3ae5bcce8d536f95b85
+  data.tar.gz: f6accd7f908e093e1426af222caf8a153e6474be2abe4abf8a0e9fe32cc6dcbc4bcf043352249c86b67ed8299653200414755772658052a2089f0ad08ced2c9f

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,30 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2015-01-20 16:57:55 -0500 using RuboCop version 0.27.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Metrics/AbcSize:
+  Max: 18
+
+# Offense count: 10
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 105
+
+# Offense count: 4
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 13
+
+# Offense count: 14
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 2
+# Configuration parameters: MaxSlashes.
+Style/RegexpLiteral:
+  Enabled: false
+

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Max Lincoln
+
+MIT License
+
+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,4 @@
+# Omnitest::Core
+
+Shared code for omnitest projects.
+See [omnitest](https://github.com/omnitest/omnitest)

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+require 'rake/notes/rake_task'
+require 'rspec/core/rake_task'
+
+task default: [:spec, :rubocop, :notes]
+
+RSpec::Core::RakeTask.new('spec')
+RuboCop::RakeTask.new(:rubocop) do |task|
+  # abort rake on failure
+  task.fail_on_error = true
+end

data/lib/omnitest/core.rb

@@ -0,0 +1,56 @@
+require 'omnitest/core/version'
+require 'logger'
+require 'cause'
+require 'thor'
+require 'pathname'
+require 'omnitest/errors'
+
+module Omnitest
+  module Core
+    autoload :Configurable, 'omnitest/core/configurable'
+    autoload :Util, 'omnitest/core/util'
+    autoload :FileSystem, 'omnitest/core/file_system'
+    autoload :CLI, 'omnitest/core/cli'
+    autoload :Logger, 'omnitest/core/logger'
+    autoload :Logging, 'omnitest/core/logging'
+    autoload :DefaultLogger, 'omnitest/core/logging'
+    autoload :StdoutLogger, 'omnitest/core/logging'
+    autoload :LogdevLogger, 'omnitest/core/logging'
+    autoload :Color, 'omnitest/core/color'
+    autoload :Dash, 'omnitest/core/hashie'
+    autoload :Mash, 'omnitest/core/hashie'
+  end
+
+  include Omnitest::Core::Logger
+  include Omnitest::Core::Logging
+
+  class << self
+    # @return [Logger] the common Omnitest logger
+    attr_accessor :logger
+
+    # @return [Mutex] a common mutex for global coordination
+    attr_accessor :mutex
+
+    def basedir
+      @basedir ||= Dir.pwd
+    end
+
+    def logger
+      @logger ||= Core::StdoutLogger.new($stdout)
+    end
+
+    # Determine the default log level from an environment variable, if it is
+    # set.
+    #
+    # @return [Integer,nil] a log level or nil if not set
+    # @api private
+    def env_log
+      level = ENV['CROSSTEST_LOG'] && ENV['CROSSTEST_LOG'].downcase.to_sym
+      level = Util.to_logger_level(level) unless level.nil?
+      level
+    end
+
+    # Default log level verbosity
+    DEFAULT_LOG_LEVEL = :info
+  end
+end

data/lib/omnitest/core/cli.rb

@@ -0,0 +1,70 @@
+require 'English'
+require 'thor'
+
+module Omnitest
+  module Core
+    class CLI < Thor
+      # Common module to load and invoke a CLI-implementation agnostic command.
+      module PerformCommand
+        attr_reader :action
+
+        # Perform a scenario subcommand.
+        #
+        # @param task [String] action to take, usually corresponding to the
+        #   subcommand name
+        # @param command [String] command class to create and invoke]
+        # @param args [Array] remainder arguments from processed ARGV
+        #   (default: `nil`)
+        # @param additional_options [Hash] additional configuration needed to
+        #   set up the command class (default: `{}`)
+        def perform(task, command, args = nil, additional_options = {})
+          require "omnitest/command/#{command}"
+
+          command_options = {
+            help: -> { help(task) },
+            test_dir: @test_dir,
+            shell: shell
+          }.merge(additional_options)
+
+          str_const = Thor::Util.camel_case(command)
+          klass = ::Omnitest::Command.const_get(str_const)
+          klass.new(task, args, options, command_options).call
+        end
+      end
+
+      include Core::Logging
+      include PerformCommand
+
+      class << self
+        # Override Thor's start to strip extra_args from ARGV before it's processed
+        attr_accessor :extra_args
+
+        def start(given_args = ARGV, config = {})
+          if given_args && (split_pos = given_args.index('--'))
+            @extra_args = given_args.slice(split_pos + 1, given_args.length).map do | arg |
+              # Restore quotes
+              arg.match(/\=/) ? restore_quotes(arg) : arg
+            end
+            given_args = given_args.slice(0, split_pos)
+          end
+          super given_args, config
+        end
+
+        private
+
+        def restore_quotes(arg)
+          lhs, rhs = arg.split('=')
+          lhs = "\"#{lhs}\"" if lhs.match(/\s/)
+          rhs = "\"#{rhs}\"" if rhs.match(/\s/)
+          [lhs, rhs].join('=')
+        end
+      end
+
+      no_commands do
+        def extra_args
+          self.class.extra_args
+        end
+      end
+    end
+  end
+end

data/lib/omnitest/core/color.rb

@@ -0,0 +1,42 @@
+module Omnitest
+  module Core
+    module Color
+      ANSI = {
+        reset: 0, black: 30, red: 31, green: 32, yellow: 33,
+        blue: 34, magenta: 35, cyan: 36, white: 37,
+        bright_black: 90, bright_red: 91, bright_green: 92,
+        bright_yellow: 93, bright_blue: 94, bright_magenta: 95,
+        bright_cyan: 96, bright_white: 97
+      }.freeze
+
+      COLORS = %w(
+        cyan yellow green magenta blue bright_cyan bright_yellow
+        bright_green bright_magenta bright_blue
+      ).freeze
+
+      # Returns an ansi escaped string representing a color control sequence.
+      #
+      # @param name [Symbol] a valid color representation, taken from
+      #   Omnitest::Color::ANSI
+      # @return [String] an ansi escaped string if the color is valid and an
+      #   empty string otherwise
+      def self.escape(name)
+        return '' if name.nil?
+        return '' unless ANSI[name]
+        "\e[#{ANSI[name]}m"
+      end
+
+      # Returns a colorized ansi escaped string with the given color.
+      #
+      # @param str [String] a string to colorize
+      # @param name [Symbol] a valid color representation, taken from
+      #   Omnitest::Color::ANSI
+      # @return [String] an ansi escaped string if the color is valid and an
+      #   unescaped string otherwise
+      def self.colorize(str, name)
+        color = escape(name)
+        color.empty? ? str : "#{color}#{str}#{escape(:reset)}"
+      end
+    end
+  end
+end

data/lib/omnitest/core/configurable.rb

@@ -0,0 +1,21 @@
+module Omnitest
+  module Core
+    module Configurable
+      # @see Omnitest::Configuration
+      def configuration
+        fail "configuration doesn't take a block, use configure" if block_given?
+        @configuration ||= const_get('Configuration').new
+      end
+
+      # @see Omnitest::Configuration
+      def configure
+        yield(configuration)
+      end
+
+      def reset
+        configuration.clear
+        @configuration = nil
+      end
+    end
+  end
+end

data/lib/omnitest/core/file_system.rb

@@ -0,0 +1,60 @@
+module Omnitest
+  module Core
+    module FileSystem
+      include Util::String
+
+      class << self
+        # Finds a file by loosely matching the file name to a scenario name
+        def find_file(search_path, scenario_name, ignored_patterns = nil)
+          ignored_patterns ||= read_gitignore(search_path)
+          glob_string = "#{search_path}/**/*#{slugify(scenario_name)}.*"
+          potential_files = Dir.glob(glob_string, File::FNM_CASEFOLD)
+          potential_files.concat Dir.glob(glob_string.gsub('_', '-'), File::FNM_CASEFOLD)
+          potential_files.concat Dir.glob(glob_string.gsub('_', ''), File::FNM_CASEFOLD)
+
+          # Filter out ignored filesFind the first file, not including generated files
+          files = potential_files.select do |f|
+            !ignored? ignored_patterns, search_path, f
+          end
+
+          # Select the shortest path, likely the best match
+          file = files.min_by(&:length)
+
+          fail Errno::ENOENT, "No file was found for #{scenario_name} within #{search_path}" if file.nil?
+          Pathname.new file
+        end
+
+        def relativize(file, base_path)
+          absolute_file = File.absolute_path(file)
+          absolute_base_path = File.absolute_path(base_path)
+          Pathname.new(absolute_file).relative_path_from Pathname.new(absolute_base_path)
+        end
+
+        private
+
+        # @api private
+        def read_gitignore(dir)
+          gitignore_file = "#{dir}/.gitignore"
+          File.read(gitignore_file)
+        rescue
+          ''
+        end
+
+        # @api private
+        def ignored?(ignored_patterns, base_path, target_file)
+          # Trying to match the git ignore rules but there's some discrepencies.
+          ignored_patterns.split.find do |pattern|
+            # if git ignores a folder, we should ignore all files it contains
+            pattern = "#{pattern}**" if pattern[-1] == '/'
+            started_with_slash = pattern.start_with? '/'
+
+            pattern.gsub!(/\A\//, '') # remove leading slashes since we're searching from root
+            file = relativize(target_file, base_path)
+            ignored = file.fnmatch? pattern
+            ignored || (file.fnmatch? "**/#{pattern}" unless started_with_slash)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/omnitest/core/hashie.rb

@@ -0,0 +1,51 @@
+require 'hashie'
+require 'erb'
+
+module Omnitest
+  module Core
+    class Dash < Hashie::Dash
+      include Hashie::Extensions::Coercion
+
+      def initialize(hash = {})
+        super Omnitest::Core::Util.symbolized_hash(hash)
+      end
+
+      # @api private
+      # @!macro [attach] field
+      #   @!attribute [rw] $1
+      #     Attribute $1. $3
+      #     @return [$2]
+      # Defines a typed attribute on a class.
+      def self.field(name, type, opts = {})
+        property name, opts
+        coerce_key name, type
+      end
+
+      # @api private
+      # @!macro [attach] required_field
+      #   @!attribute [rw] $1
+      #     **Required** Attribute $1. $3
+      #     @return [$2]
+      # Defines a required, typed attribute on a class.
+      def self.required_field(name, type, opts = {})
+        opts[:required] = true
+        field(name, type, opts)
+      end
+
+      module Loadable
+        include Core::DefaultLogger
+        def from_yaml(yaml_file)
+          logger.debug "Loading #{yaml_file}"
+          raw_content = File.read(yaml_file)
+          processed_content = ERB.new(raw_content).result
+          data = YAML.load processed_content
+          new data
+        end
+      end
+    end
+
+    class Mash < Hashie::Mash
+      include Hashie::Extensions::Coercion
+    end
+  end
+end

data/lib/omnitest/core/logger.rb

@@ -0,0 +1,42 @@
+require 'logger'
+
+module Omnitest
+  module Core
+    module Logger
+      def logger
+        @logger ||= new_logger
+      end
+
+      def new_logger(io = $stdout, level = :debug)
+        stdout_logger(io).tap do | logger |
+          logger.level = Util.to_logger_level(level)
+        end
+      end
+
+      # Construct a new standard out logger.
+      #
+      # @param stdout [IO] the IO object that represents stdout (or similar)
+      # @param color [Symbol] color to use when outputing messages
+      # @return [StdoutLogger] a new logger
+      # @api private
+      def stdout_logger(stdout, color = nil)
+        logger = Omnitest::Core::StdoutLogger.new(stdout)
+        # if Omnitest.tty?
+        if stdout.tty? && color
+          logger.formatter = proc do |_severity, _datetime, _progname, msg|
+            Core::Color.colorize("#{msg}", color).concat("\n")
+          end
+        else
+          logger.formatter = proc do |_severity, _datetime, _progname, msg|
+            msg.concat("\n")
+          end
+        end
+        logger
+      end
+
+      def log_level=(level)
+        logger.level = level
+      end
+    end
+  end
+end

data/lib/omnitest/core/logging.rb

@@ -0,0 +1,133 @@
+module Omnitest
+  module Core
+    module DefaultLogger
+      module ClassMethods
+        def logger
+          @logger ||= default_logger
+        end
+
+        def default_logger
+          if Omnitest.respond_to? :configuration
+            Omnitest.configuration.default_logger
+          else
+            ::Logger.new(STDOUT)
+          end
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      include ClassMethods
+    end
+
+    module Logging
+      class << self
+        private
+
+        def logger_method(meth)
+          define_method(meth) do |*args|
+            logger.public_send(meth, *args)
+          end
+        end
+      end
+
+      logger_method :banner
+      logger_method :debug
+      logger_method :info
+      logger_method :warn
+      logger_method :error
+      logger_method :fatal
+    end
+
+    # Internal class which adds a #banner method call that displays the
+    # message with a callout arrow.
+    class LogdevLogger < ::Logger
+      alias_method :super_info, :info
+
+      # Dump one or more messages to info.
+      #
+      # @param msg [String] a message
+      def <<(msg)
+        @buffer ||= ''
+        lines, _, remainder = msg.rpartition("\n")
+        if lines.empty?
+          @buffer << remainder
+        else
+          lines.insert(0, @buffer)
+          lines.split("\n").each { |l| format_line(l.chomp) }
+          @buffer = ''
+        end
+      end
+
+      # Log a banner message.
+      #
+      # @param msg [String] a message
+      def banner(msg = nil, &block)
+        super_info("-----> #{msg}", &block)
+      end
+
+      private
+
+      # Reformat a line if it already contains log formatting.
+      #
+      # @param line [String] a message line
+      # @api private
+      def format_line(line)
+        case line
+        when /^-----> / then banner(line.gsub(/^[ >-]{6} /, ''))
+        when /^>>>>>> / then error(line.gsub(/^[ >-]{6} /, ''))
+        when /^       / then info(line.gsub(/^[ >-]{6} /, ''))
+        else info(line)
+        end
+      end
+    end
+
+    # Internal class which reformats logging methods for display as console
+    # output.
+    class StdoutLogger < LogdevLogger
+      # Log a debug message
+      #
+      # @param msg [String] a message
+      def debug(msg = nil, &block)
+        super("D      #{msg}", &block)
+      end
+
+      # Log an info message
+      #
+      # @param msg [String] a message
+      def info(msg = nil, &block)
+        super("       #{msg}", &block)
+      end
+
+      # Log a warn message
+      #
+      # @param msg [String] a message
+      def warn(msg = nil, &block)
+        super("$$$$$$ #{msg}", &block)
+      end
+
+      # Log an error message
+      #
+      # @param msg [String] a message
+      def error(msg = nil, &block)
+        super(">>>>>> #{msg}", &block)
+      end
+
+      # Log a fatal message
+      #
+      # @param msg [String] a message
+      def fatal(msg = nil, &block)
+        super("!!!!!! #{msg}", &block)
+      end
+
+      # Log an unknown message
+      #
+      # @param msg [String] a message
+      def unknown(msg = nil, &block)
+        super("?????? #{msg}", &block)
+      end
+    end
+  end
+end

data/lib/omnitest/core/util.rb

@@ -0,0 +1,204 @@
+# -*- encoding: utf-8 -*-
+#
+# Much of this code has been adapted from Fletcher Nichol (<fnichol@nichol.ca>)
+# work on test-kitchen.
+
+module Omnitest
+  module Core
+    # Stateless utility methods used in different contexts. Essentially a mini
+    # PassiveSupport library.
+    module Util
+      module Hashable
+        def to_hash
+          instance_variables.each_with_object({}) do |var, hash|
+            hash[var.to_s.delete('@')] = instance_variable_get(var)
+          end
+        end
+      end
+
+      # Returns the standard library Logger level constants for a given symbol
+      # representation.
+      #
+      # @param symbol [Symbol] symbol representation of a logger level (:debug,
+      #   :info, :warn, :error, :fatal)
+      # @return [Integer] Logger::Severity constant value or nil if input is not
+      #   valid
+      def self.to_logger_level(symbol)
+        return nil unless [:debug, :info, :warn, :error, :fatal].include?(symbol)
+
+        ::Logger.const_get(symbol.to_s.upcase)
+      end
+
+      # Returns the symbol represenation of a logging levels for a given
+      # standard library Logger::Severity constant.
+      #
+      # @param const [Integer] Logger::Severity constant value for a logging
+      #   level (Logger::DEBUG, Logger::INFO, Logger::WARN, Logger::ERROR,
+      #   Logger::FATAL)
+      # @return [Symbol] symbol representation of the logging level
+      def self.from_logger_level(const)
+        case const
+        when ::Logger::DEBUG then :debug
+        when ::Logger::INFO then :info
+        when ::Logger::WARN then :warn
+        when ::Logger::ERROR then :error
+        else :fatal
+        end
+      end
+
+      # Returns a new Hash with all key values coerced to symbols. All keys
+      # within a Hash are coerced by calling #to_sym and hashes within arrays
+      # and other hashes are traversed.
+      #
+      # @param obj [Object] the hash to be processed. While intended for
+      #   hashes, this method safely processes arbitrary objects
+      # @return [Object] a converted hash with all keys as symbols
+      def self.symbolized_hash(obj)
+        if obj.is_a?(Hash)
+          obj.each_with_object({}) do |(k, v), h|
+            h[k.to_sym] = symbolized_hash(v)
+          end
+        elsif obj.is_a?(Array)
+          obj.each_with_object([]) do |e, a|
+            a << symbolized_hash(e)
+          end
+        else
+          obj
+        end
+      end
+
+      # Returns a new Hash with all key values coerced to strings. All keys
+      # within a Hash are coerced by calling #to_s and hashes with arrays
+      # and other hashes are traversed.
+      #
+      # @param obj [Object] the hash to be processed. While intended for
+      #   hashes, this method safely processes arbitrary objects
+      # @return [Object] a converted hash with all keys as strings
+      def self.stringified_hash(obj)
+        if obj.is_a?(Hash)
+          obj.each_with_object({}) do |(k, v), h|
+            h[k.to_s] = stringified_hash(v)
+          end
+        elsif obj.is_a?(Array)
+          obj.each_with_object([]) do |e, a|
+            a << stringified_hash(e)
+          end
+        else
+          obj
+        end
+      end
+
+      # Returns a formatted string representing a duration in seconds.
+      #
+      # @param total [Integer] the total number of seconds
+      # @return [String] a formatted string of the form (XmYY.00s)
+      def self.duration(total)
+        total = 0 if total.nil?
+        minutes = (total / 60).to_i
+        seconds = (total - (minutes * 60))
+        format('(%dm%.2fs)', minutes, seconds)
+      end
+
+      module String
+        module ClassMethods
+          def slugify(*labels)
+            labels.map do |label|
+              label.downcase.gsub(/[\.\s-]/, '_')
+            end.join('-')
+          end
+
+          def ansi2html(text)
+            HTML.from_ansi(text)
+          end
+
+          def escape_html(text)
+            HTML.escape_html(text)
+          end
+          alias_method :h, :escape_html
+
+          def highlight(source, opts = {})
+            return nil if source.nil?
+
+            opts[:language] ||= 'ruby'
+            opts[:formatter] ||= 'terminal256'
+            Highlight.new(opts).highlight(source)
+          end
+        end
+
+        def self.included(base)
+          base.extend(ClassMethods)
+        end
+
+        include ClassMethods
+      end
+
+      class Highlight
+        def initialize(opts)
+          @lexer = Rouge::Lexer.find(opts[:language]) || Rouge::Lexer.guess_by_filename(opts[:filename])
+          @formatter = opts[:formatter]
+        end
+
+        def highlight(source)
+          Rouge.highlight(source, @lexer, @formatter)
+        end
+      end
+
+      class HTML
+        ANSICODES = {
+          '1' => 'bold',
+          '4' => 'underline',
+          '30' => 'black',
+          '31' => 'red',
+          '32' => 'green',
+          '33' => 'yellow',
+          '34' => 'blue',
+          '35' => 'magenta',
+          '36' => 'cyan',
+          '37' => 'white',
+          '40' => 'bg-black',
+          '41' => 'bg-red',
+          '42' => 'bg-green',
+          '43' => 'bg-yellow',
+          '44' => 'bg-blue',
+          '45' => 'bg-magenta',
+          '46' => 'bg-cyan',
+          '47' => 'bg-white'
+        }
+
+        def self.from_ansi(text)
+          ansi = StringScanner.new(text)
+          html = StringIO.new
+          until ansi.eos?
+            if ansi.scan(/\e\[0?m/)
+              html.print(%(</span>))
+            elsif ansi.scan(/\e\[0?(\d+)m/)
+              # use class instead of style?
+              style = ANSICODES[ansi[1]] || 'text-reset'
+              html.print(%(<span class="#{style}">))
+            else
+              html.print(ansi.scan(/./m))
+            end
+          end
+          html.string
+        end
+
+        # From Rack
+
+        ESCAPE_HTML = {
+          '&' => '&amp;',
+          '<' => '&lt;',
+          '>' => '&gt;',
+          "'" => '&#x27;',
+          '"' => '&quot;',
+          '/' => '&#x2F;'
+        }
+        ESCAPE_HTML_PATTERN = Regexp.union(*ESCAPE_HTML.keys)
+
+        # Escape ampersands, brackets and quotes to their HTML/XML entities.
+        def self.escape_html(string)
+          string.to_s.gsub(ESCAPE_HTML_PATTERN) { |c| ESCAPE_HTML[c] }
+        end
+      end
+    end
+  end
+end

data/lib/omnitest/core/version.rb

@@ -0,0 +1,5 @@
+module Omnitest
+  module Core
+    VERSION = '0.0.1'
+  end
+end

data/lib/omnitest/errors.rb

@@ -0,0 +1,244 @@
+require 'English'
+
+module Omnitest
+  # All Omnitest errors and exceptions.
+  module Error
+    # Creates an array of strings, representing a formatted exception,
+    # containing backtrace and nested exception info as necessary, that can
+    # be viewed by a human.
+    #
+    # For example:
+    #
+    #     ------Exception-------
+    #     Class: Omnitest::StandardError
+    #     Message: Failure starting the party
+    #     ---Nested Exception---
+    #     Class: IOError
+    #     Message: not enough directories for a party
+    #     ------Backtrace-------
+    #     nil
+    #     ----------------------
+    #
+    # @param exception [::StandardError] an exception
+    # @return [Array<String>] a formatted message
+    def self.formatted_trace(exception)
+      arr = formatted_exception(exception).dup
+      last = arr.pop
+      if exception.respond_to?(:original) && exception.original
+        arr += formatted_exception(exception.original, 'Nested Exception')
+        last = arr.pop
+      end
+      arr += ['Backtrace'.center(22, '-'), exception.backtrace, last].flatten
+      arr
+    end
+
+    # Creates an array of strings, representing a formatted exception that
+    # can be viewed by a human. Thanks to MiniTest for the inspiration
+    # upon which this output has been designed.
+    #
+    # For example:
+    #
+    #     ------Exception-------
+    #     Class: Omnitest::StandardError
+    #     Message: I have failed you
+    #     ----------------------
+    #
+    # @param exception [::StandardError] an exception
+    # @param title [String] a custom title for the message
+    #   (default: `"Exception"`)
+    # @return [Array<String>] a formatted message
+    def self.formatted_exception(exception, title = 'Exception')
+      [
+        title.center(22, '-'),
+        "Class: #{exception.class}",
+        "Message: #{exception.message}",
+        ''.center(22, '-')
+      ]
+    end
+  end
+
+  module ErrorSource
+    def error_source
+      if backtrace_locations
+        source_from_backtrace(backtrace_locations)
+      elsif original && original.backtrace_locations
+        source_from_backtrace(original.backtrace_locations)
+      end
+    end
+
+    def source_from_backtrace(backtrace_locations)
+      error_location = backtrace_locations.delete_if { |l| l.absolute_path =~ /gems\/rspec-/ }.first
+      error_source = File.read(error_location.absolute_path)
+      error_lineno = error_location.lineno - 1 # lineno counts from 1
+      get_dedented_block(error_source, error_lineno)
+    end
+
+    def get_dedented_block(source_text, target_lineno)
+      block = []
+      lines = source_text.lines
+      target_indent = lines[target_lineno][/\A */].size
+      lines[0...target_lineno].reverse.each do |line|
+        indent = line[/\A */].size
+        block.prepend line
+        break if indent < target_indent
+      end
+      lines[target_lineno..lines.size].each do |line|
+        indent = line[/\A */].size
+        block.push line
+        break if indent < target_indent
+      end
+      block.join
+    end
+  end
+
+  # Base exception class from which all Omnitest exceptions derive. This class
+  # nests an exception when this class is re-raised from a rescue block.
+  class StandardError < ::StandardError
+    include Error
+
+    # @return [::StandardError] the original (wrapped) exception
+    attr_reader :original
+
+    # Creates a new StandardError exception which optionally wraps an original
+    # exception if given or detected by checking the `$!` global variable.
+    #
+    # @param msg [String] exception message
+    # @param original [::StandardError] an original exception which will be
+    #   wrapped (default: `$ERROR_INFO`)
+    def initialize(msg, original = $ERROR_INFO)
+      super(msg)
+      @original = original
+    end
+  end
+
+  # Base exception class for all exceptions that are caused by user input
+  # errors.
+  class UserError < StandardError; end
+
+  # Base exception class for all exceptions that are caused by incorrect use
+  # of an API.
+  class ClientError < StandardError; end
+
+  # Base exception class for exceptions that are caused by external library
+  # failures which may be temporary.
+  class TransientFailure < StandardError; end
+
+  # Exception class for any exceptions raised when performing an scenario
+  # action.
+  class ActionFailed < TransientFailure; end
+
+  class ExecutionError < TransientFailure
+    attr_accessor :execution_result
+  end
+
+  class << self
+    # Yields to a code block in order to consistently emit a useful crash/error
+    # message and exit appropriately. There are two primary failure conditions:
+    # an expected scenario failure, and any other unexpected failures.
+    #
+    # **Note** This method may call `Kernel.exit` so may not return if the
+    # yielded code block raises an exception.
+    #
+    # ## Scenario Failure
+    #
+    # This is an expected failure scenario which could happen if an scenario
+    # couldn't be created, a Chef run didn't successfully converge, a
+    # post-convergence test suite failed, etc. In other words, you can count on
+    # encountering these failures all the time--this is Omnitest's worldview:
+    # crash early and often. In this case a cleanly formatted exception is
+    # written to `STDERR` and the exception message is written to
+    # the common Omnitest file logger.
+    #
+    # ## Unexpected Failure
+    #
+    # All other forms of `Omnitest::Error` exceptions are considered unexpected
+    # or unplanned exceptions, typically from user configuration errors, driver
+    # or provisioner coding issues or bugs, or internal code issues. Given
+    # a stable release of Omnitest and a solid set of drivers and provisioners,
+    # the most likely cause of this is user configuration error originating in
+    # the `.omnitest.yaml` setup. For this reason, the exception is written to
+    # `STDERR`, a full formatted exception trace is written to the common
+    # Omnitest file logger, and a message is displayed on `STDERR` to the user
+    # informing them to check the log files and check their configuration with
+    # the `omnitest diagnose` subcommand.
+    #
+    # @raise [SystemExit] if an exception is raised in the yielded block
+    def with_friendly_errors
+      yield
+    rescue Omnitest::Skeptic::ScenarioFailure => e
+      Omnitest.mutex.synchronize do
+        handle_scenario_failure(e)
+      end
+      exit 10
+    rescue Omnitest::Error => e
+      Omnitest.mutex.synchronize do
+        handle_error(e)
+      end
+      exit 20
+    end
+
+    # Handles an scenario failure exception.
+    #
+    # @param e [StandardError] an exception to handle
+    # @see Omnitest.with_friendly_errors
+    # @api private
+    def handle_scenario_failure(e)
+      stderr_log(e.message.split(/\s{2,}/))
+      stderr_log(Error.formatted_exception(e.original))
+      file_log(:error, e.message.split(/\s{2,}/).first)
+      debug_log(Error.formatted_trace(e))
+    end
+
+    alias_method :handle_validation_failure, :handle_scenario_failure
+
+    # Handles an unexpected failure exception.
+    #
+    # @param e [StandardError] an exception to handle
+    # @see Omnitest.with_friendly_errors
+    # @api private
+    def handle_error(e)
+      stderr_log(Error.formatted_exception(e))
+      stderr_log('Please see .omnitest/logs/omnitest.log for more details')
+      # stderr_log("Also try running `omnitest diagnose --all` for configuration\n")
+      file_log(:error, Error.formatted_trace(e))
+    end
+
+    private
+
+    # Writes an array of lines to the common Omnitest logger's file device at the
+    # given severity level. If the Omnitest logger is set to debug severity, then
+    # the array of lines will also be written to the console output.
+    #
+    # @param level [Symbol,String] the desired log level
+    # @param lines [Array<String>] an array of strings to log
+    # @api private
+    def file_log(level, lines)
+      Array(lines).each do |line|
+        if Omnitest.logger.debug?
+          Omnitest.logger.debug(line)
+        else
+          Omnitest.logger.logdev && Omnitest.logger.logdev.public_send(level, line)
+        end
+      end
+    end
+
+    # Writes an array of lines to the `STDERR` device.
+    #
+    # @param lines [Array<String>] an array of strings to log
+    # @api private
+    def stderr_log(lines)
+      Array(lines).each do |line|
+        $stderr.puts(Core::Color.colorize(">>>>>> #{line}", :red))
+      end
+    end
+
+    # Writes an array of lines to the common Omnitest debugger with debug
+    # severity.
+    #
+    # @param lines [Array<String>] an array of strings to log
+    # @api private
+    def debug_log(lines)
+      Array(lines).each { |line| Omnitest.logger.debug(line) }
+    end
+  end
+end

data/omnitest-core.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'omnitest/core/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'omnitest-core'
+  spec.version       = Omnitest::Core::VERSION
+  spec.authors       = ['Max Lincoln']
+  spec.email         = ['max@devopsy.com']
+  spec.summary       = 'Shared code for omnitest projects.'
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'thor', '~> 0.19'
+  spec.add_dependency 'cause', '~> 0.1'
+  spec.add_dependency 'rouge', '~> 1.7'
+  spec.add_dependency 'hashie', '~> 3.0'
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake-notes'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.18', '<= 0.27'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.2'
+  spec.add_development_dependency 'aruba'
+end

metadata

@@ -0,0 +1,237 @@
+--- !ruby/object:Gem::Specification
+name: omnitest-core
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Max Lincoln
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: cause
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: rouge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rake-notes
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '0.27'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '0.27'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- max@devopsy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/omnitest/core.rb
+- lib/omnitest/core/cli.rb
+- lib/omnitest/core/color.rb
+- lib/omnitest/core/configurable.rb
+- lib/omnitest/core/file_system.rb
+- lib/omnitest/core/hashie.rb
+- lib/omnitest/core/logger.rb
+- lib/omnitest/core/logging.rb
+- lib/omnitest/core/util.rb
+- lib/omnitest/core/version.rb
+- lib/omnitest/errors.rb
+- omnitest-core.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+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.4.2
+signing_key: 
+specification_version: 4
+summary: Shared code for omnitest projects.
+test_files: []