polytrix 0.1.2 → 0.1.3

data/lib/polytrix/{runners → executors}/buff_shellout_executor.rb

@@ -1,7 +1,7 @@
 require 'buff/shell_out'
 
 module Polytrix
-  module Runners
+  module Executors
     class BuffShellOutExecutor
       def execute(command, opts)
         cwd = opts.delete(:cwd) || Dir.pwd

data/lib/polytrix/executors/linux_challenge_executor.rb

@@ -0,0 +1,29 @@
+module Polytrix
+  module Executors
+    class LinuxChallengeRunner < ChallengeRunner
+      include Polytrix::Util::FileSystem
+
+      def challenge_command(challenge_script, basedir = Dir.pwd)
+        challenge_script = "./#{challenge_script}" unless challenge_script.to_s.start_with? '/'
+
+        [wrapper_script(basedir), challenge_script].compact.join(' ')
+      end
+
+      protected
+
+      def wrapper_script(basedir)
+        basedir_relative_wrapper = File.expand_path('scripts/wrapper', basedir)
+        root_relative_wrapper = File.expand_path('scripts/wrapper', Dir.pwd)
+
+        if File.exist? basedir_relative_wrapper
+          relativize(basedir_relative_wrapper, basedir).to_s
+        elsif File.exist? root_relative_wrapper
+          # FIXME: This isn't always desired, probably better to opt-in to this behavior
+          relativize(root_relative_wrapper, basedir).to_s
+        else
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/polytrix/executors/mixlib_shellout_executor.rb

@@ -0,0 +1,55 @@
+require 'mixlib/shellout'
+
+module Polytrix
+  module Executors
+    class IOToLog < IO
+      def initialize(logger)
+        @logger = logger
+        @buffer = ''
+      end
+
+      def write(string)
+        (@buffer + string).lines.each do |line|
+          if line.end_with? "\n"
+            @buffer = ''
+            @logger.info(line.rstrip)
+          else
+            @buffer = line
+          end
+        end
+      end
+    end
+
+    class MixlibShellOutExecutor
+      include Polytrix::DefaultLogger
+
+      MIXLIB_SHELLOUT_EXCEPTION_CLASSES = Mixlib::ShellOut.constants.map do|name|
+        klass = Mixlib::ShellOut.const_get(name)
+        if klass.is_a?(Class) && klass <= RuntimeError
+          klass
+        else
+          nil
+        end
+      end.compact
+
+      def log_decorator(_io, _prefix)
+        IOToLog.new(logger)
+      end
+
+      def execute(command, opts)
+        prefix = opts.delete :prefix
+        shell = Mixlib::ShellOut.new(command, opts)
+        shell.live_stream = log_decorator $stdout, prefix
+        shell.run_command
+        execution_result = ExecutionResult.new exitstatus: shell.exitstatus, stdout: shell.stdout, stderr: shell.stderr
+        # shell.error!
+        execution_result
+      rescue SystemCallError, *MIXLIB_SHELLOUT_EXCEPTION_CLASSES, TypeError => e
+        # See https://github.com/opscode/mixlib-shellout/issues/62
+        execution_error = ExecutionError.new(e)
+        execution_error.execution_result = execution_result
+        raise execution_error
+      end
+    end
+  end
+end

data/lib/polytrix/{runners/windows_challenge_runner.rb → executors/windows_challenge_executor.rb}

@@ -1,25 +1,18 @@
 module Polytrix
-  module Runners
+  module Executors
     class WindowsChallengeRunner < ChallengeRunner
       PS_OPTIONS = '-NoProfile -ExecutionPolicy Bypass'
-      def script_extension
-        'ps1'
-      end
 
-      def challenge_command(env_file, challenge_script)
+      def challenge_command(challenge_script, _basedir = Dir.pwd)
         # I don't know a simple powershell replacement for &&
         # See http://stackoverflow.com/questions/2416662/what-are-the-powershell-equivalent-of-bashs-and-operators
         if File.exist? 'scripts/wrapper.ps1'
-          command = ". ./#{env_file}; ./scripts/wrapper.ps1 #{challenge_script}"
+          command = "./scripts/wrapper.ps1 #{challenge_script}"
         else
-          command = ". ./#{env_file}; ./#{challenge_script}"
+          command = "./#{challenge_script}"
         end
         "PowerShell #{PS_OPTIONS} -Command \"#{command}\""
       end
-
-      def save_environment_variable(key, value)
-        "$Env:#{key}='#{value}'"
-      end
     end
   end
 end

data/lib/polytrix/{core/implementor.rb → implementor.rb}

@@ -20,8 +20,8 @@ module Polytrix
     end
 
     include Polytrix::Logging
-    include Polytrix::Core::FileSystemHelper
-    include Polytrix::Runners::Executor
+    include Polytrix::Util::FileSystem
+    include Executor
     property :name
     property :basedir, required: true
     property :language
@@ -46,7 +46,7 @@ module Polytrix
       end
       branch = git.branch ||= 'master'
       target_dir = git.to ||= basedir
-      if File.exists? target_dir
+      if File.exist? target_dir
         logger.info "Skipping clone because #{target_dir} already exists"
       else
         clone_cmd = "git clone #{git.repo} -b #{branch} #{target_dir}"
@@ -61,8 +61,12 @@ module Polytrix
       fail "Implementor #{name} has not been cloned" unless cloned?
 
       execute('./scripts/bootstrap', cwd: basedir, prefix: name)
-    rescue Errno::ENOENT
-      logger.warn "Skipping bootstrapping for #{name}, no script/bootstrap exists"
+    rescue ExecutionError => e
+      if e.cause.is_a? Errno::ENOENT
+        logger.warn "Skipping bootstrapping for #{name}, no script/bootstrap exists"
+      else
+        raise e
+      end
     end
 
     def build_challenge(challenge_data)
@@ -72,7 +76,7 @@ module Polytrix
       begin
         challenge_data[:source_file] ||= find_file basedir, challenge_data[:name]
         challenge_data[:source_file] = relativize(challenge_data[:source_file], challenge_data[:basedir])
-      rescue Polytrix::Core::FileSystemHelper::FileNotFound
+      rescue Errno::ENOENT
         challenge_data[:source_file] = nil
       end
       Challenge.new challenge_data

data/lib/polytrix/manifest.rb

@@ -1,5 +1,4 @@
 require 'yaml'
-require 'hashie/dash'
 require 'hashie/mash'
 require 'hashie/extensions/coercion'
 require 'hashie/extensions/deep_merge'
@@ -49,19 +48,10 @@ module Polytrix
       coerce_value Integer, String
     end
 
-    class CodeSample < Polytrix::ManifestSection
-      property :name, required: true
-
-      def self.coerce(data)
-        data = { name: data } if data.is_a? String
-        new(data)
-      end
-    end
-
     class Suite < Polytrix::ManifestSection
       property :env, default: {}
       property :samples, required: true
-      coerce_key :samples, Array[CodeSample]
+      coerce_key :samples, Array[String]
       property :results
     end
 
@@ -80,7 +70,7 @@ module Polytrix
       suites.each do | suite_name, suite |
         suite.samples.each do | sample |
           implementors.each_value do | implementor |
-            challenge = implementor.build_challenge suite: suite_name, name: sample.name, vars: suite.env
+            challenge = implementor.build_challenge suite: suite_name, name: sample, vars: suite.env
             @challenges[challenge.slug] = challenge
           end
         end
@@ -96,24 +86,5 @@ module Polytrix
       data = YAML.load processed_content
       new data
     end
-
-    def find_suite(suite_name)
-      _, suite = suites.find { |name, _| name.to_s.downcase == suite_name.to_s.downcase }
-      suite
-    end
-
-    def find_challenge(suite_name, scenario_name)
-      suite = find_suite suite_name
-      return nil if suite.nil?
-
-      if suite.samples.is_a? Array
-        # No results yet
-        suite.samples.find { |name, _| name.downcase == scenario_name.downcase }
-        Challenge.new suite: suite_name, name: scenario_name
-      else
-        _, challenge_data = find_suite('identity').samples.find { |name, challenge| name.downcase == scenario_name.downcase }
-        Challenge.new(suite: suite_name, name: scenario_name, result: challenge_data)
-      end
-    end
   end
 end

data/lib/polytrix/{reports → reporters}/hash_reporter.rb

@@ -1,7 +1,7 @@
 require 'csv'
 
 module Polytrix
-  module Reports
+  module Reporters
     class HashReporter
       def initialize(io = $stdout)
         @buffer = io
@@ -20,9 +20,13 @@ module Polytrix
         @buffer.puts convert(data)
       end
 
-      def convert(data)
+      def convert(_data)
         fail 'Subclass HashReporter and convert the data to the target format'
       end
+
+      def colors?
+        false
+      end
     end
   end
 end

data/lib/polytrix/{reports → reporters}/json_reporter.rb

@@ -1,8 +1,8 @@
 require 'json'
-require 'polytrix/cli/reports/hash_reporter'
+require 'polytrix/reporters/hash_reporter'
 
 module Polytrix
-  module Reports
+  module Reporters
     class JSONReporter < HashReporter
       def convert(data)
         JSON.pretty_generate data

data/lib/polytrix/{reports → reporters}/markdown_reporter.rb

@@ -1,6 +1,7 @@
 module Polytrix
-  module Reports
+  module Reporters
     class MarkdownReporter
+      include Polytrix::Util::String
       def initialize(io = $stdout)
         @buffer = io
       end
@@ -13,9 +14,13 @@ module Polytrix
         @buffer.puts header_line.gsub(/[^|]/, '-')
 
         table[1..-1].each do |data_line|
-          @buffer.puts data_line.join ' | '
+          @buffer.puts data_line.map { |line| escape_html(line) }.join(' | ')
         end
       end
+
+      def colors?
+        false
+      end
     end
   end
 end

data/lib/polytrix/{reports → reporters}/yaml_reporter.rb

@@ -1,8 +1,8 @@
 require 'yaml'
-require 'polytrix/cli/reports/hash_reporter'
+require 'polytrix/reporters/hash_reporter'
 
 module Polytrix
-  module Reports
+  module Reporters
     class YAMLReporter < HashReporter
       def convert(data)
         YAML.dump data

data/lib/polytrix/reporters.rb

@@ -0,0 +1,27 @@
+module Polytrix
+  module Reporters
+    autoload :MarkdownReporter, 'polytrix/reporters/markdown_reporter'
+    # autoload :HTMLReporter, 'polytrix/reporters/html_reporter'
+    autoload :JSONReporter, 'polytrix/reporters/json_reporter'
+    autoload :YAMLReporter, 'polytrix/reporters/yaml_reporter'
+
+    RESOURCES_DIR = File.expand_path '../../../resources/', __FILE__
+    TEMPLATE_DIR = File.expand_path 'templates/', RESOURCES_DIR
+    ASSETS_DIR = File.expand_path 'assets/', RESOURCES_DIR
+
+    def self.reporter(format, shell)
+      case format
+      when 'text'
+        shell
+      when 'markdown'
+        MarkdownReporter.new
+      when 'json'
+        JSONReporter.new
+      when 'yaml'
+        YAMLReporter.new
+      else
+        fail "Unknown report format #{options[:format]}"
+      end
+    end
+  end
+end

data/lib/polytrix/result.rb

@@ -1,4 +1,5 @@
 require 'hashie/dash'
+require 'hashie/extensions/coercion'
 
 module Polytrix
   class Result < Hashie::Dash
@@ -9,15 +10,15 @@ module Polytrix
     def_delegators :execution_result, :stdout, :stderr, :exitstatus
     property :source_file # , required: true
     property :data
-    property :validations, default: Validations.new
-    coerce_key :validations, Validations
+    property :validations, default: {}
+    coerce_key :validations, Hash[String => Validation]
 
     def status
       # A feature can be validated by different suites, or manually vs an automated suite.
       # That's why there's a precedence rather than boolean algebra here...
-      return 'failed' if validations.any? { |v| v.result == 'failed' }
-      return 'passed' if validations.any? { |v| v.result == 'passed' }
-      return 'pending' if validations.any? { |v| v.result == 'pending' }
+      return 'failed' if validations.values.any? { |v| v.result == 'failed' }
+      return 'passed' if validations.values.any? { |v| v.result == 'passed' }
+      return 'pending' if validations.values.any? { |v| v.result == 'pending' }
       'skipped'
     end
   end

data/lib/polytrix/spies/file_system_spy.rb

@@ -0,0 +1,15 @@
+module Polytrix
+  module Spies
+    class FileSystemSpy < Polytrix::Spy
+      def initialize(_app, _server_options)
+      end
+
+      def spy(_challenge)
+      end
+
+      report :summary, SummaryReport
+    end
+  end
+end
+
+Polytrix.configuration.register_spy(Polytrix::Spies::FileSystemSpy)

data/lib/polytrix/spies.rb

@@ -0,0 +1,61 @@
+require 'middleware'
+
+module Polytrix
+  # # @abstract
+  class Spy
+    def initialize(app, opts = {})
+      @app = app
+      @opts = opts
+    end
+
+    def call(_challenge)
+      fail NotImplementedError, 'Subclass must implement #call'
+    end
+
+    def self.reports
+      @reports ||= {}
+    end
+
+    def self.report(type, report_class)
+      reports[type] = report_class
+    end
+  end
+
+  module Spies
+    class << self
+      attr_reader :spies
+
+      def middleware
+        @middleware ||= Middleware::Builder.new
+      end
+
+      def spies
+        @spies ||= Set.new
+      end
+
+      def register_spy(spy)
+        spies.add(spy)
+        middleware.insert 0, spy, {}
+      end
+
+      def observe(challenge, &blk)
+        middleware = Middleware::Builder.new
+        spies.each do |spy|
+          middleware.use spy
+        end
+        middleware.use blk
+        middleware.call(challenge)
+      end
+
+      def reports
+        # Group by type
+        all_reports = spies.flat_map do |spy|
+          spy.reports.to_a if spy.respond_to? :reports
+        end
+        all_reports.each_with_object({}) do |(k, v), h|
+          (h[k] ||= []) << v
+        end
+      end
+    end
+  end
+end

data/lib/polytrix/state_file.rb

@@ -21,7 +21,7 @@ module Polytrix
       dir = File.dirname(file_name)
       serialized_string = serialize_hash(Util.stringified_hash(state))
 
-      FileUtils.mkdir_p(dir) unless File.directory?(dir)
+      FileUtils.mkdir_p(dir)
       File.open(file_name, 'wb') { |f| f.write(serialized_string) }
     end
 
@@ -29,29 +29,10 @@ module Polytrix
       FileUtils.rm_f(file_name) if File.exist?(file_name)
     end
 
-    def diagnose
-      raw = read
-      result = {}
-      raw.keys.sort.each { |k| result[k] = raw[k] }
-      result
-    end
-
     private
 
     attr_reader :file_name
 
-    # @api private
-    def read_file
-      IO.read(file_name)
-    end
-
-    # @api private
-    def deserialize_string(string)
-      SafeYAML.load(string)
-    rescue SyntaxError, Psych::SyntaxError => ex
-      raise StateFileLoadError, "Error parsing #{file_name} (#{ex.message})"
-    end
-
     # @api private
     def serialize_hash(hash)
       ::YAML.dump(hash)