polytrix 0.0.1 → 0.1.0.pre

data/features/fixtures/configs/hello_world.yml

@@ -0,0 +1,10 @@
+---
+  global_env:
+    LOCALE: <%= ENV['LANG'] %>
+    FAVORITE_NUMBER: 5
+  suites:
+    Katas:
+      env:
+        NAME: 'Max'
+      samples:
+        - hello world

data/features/fixtures/spec/polytrix_merge.rb

@@ -0,0 +1,5 @@
+require 'polytrix'
+
+File.open('reports/polytrix.yaml', 'wb') do |f|
+  f.write Polytrix.merge_results(ARGV)
+end

data/features/fixtures/spec/polytrix_spec.rb

@@ -0,0 +1,10 @@
+require 'polytrix/rspec'
+
+Polytrix.configure do |polytrix|
+  Dir['sdks/*'].each do |sdk|
+    polytrix.implementor sdk
+  end
+  polytrix.test_manifest = 'polytrix_tests.yml'
+end
+Polytrix.bootstrap
+Polytrix.load_tests

data/features/reporting.feature

@@ -0,0 +1,140 @@
+Feature: Reporting
+
+  Polytrix creates YAML reports on teach test run. The reports are designed to be "deep mergable", so that you can split a test suite into separate threads running in parallel, each generating a separate report, and then merge them all to create a combined report.
+
+Scenario: A report for a single SDK
+    Given the ruby SDK
+    And the hello_world polytrix config
+    And the standard rspec setup
+    When I successfully run `bundle exec rspec -f Polytrix::RSpec::YAMLReport -o reports/polytrix.yaml`
+    Then the file "reports/polytrix.yaml" should contain exactly:
+    """
+    ---
+    global_env:
+      LOCALE: en_US.UTF-8
+      FAVORITE_NUMBER: '5'
+    suites:
+      Katas:
+        env:
+          NAME: Max
+        samples:
+          hello world:
+            ruby:
+              validations:
+              - validated_by: polytrix
+                result: passed
+              execution_result:
+                exitstatus: 0
+                stdout: |
+                  Hello, world!
+                stderr: ''
+              source_file: challenges/hello_world.rb
+
+    """
+
+Scenario: A report for several SDKS
+    Given the ruby SDK
+    And the java SDK
+    And the python SDK
+    And the hello_world polytrix config
+    And the standard rspec setup
+    When I successfully run `bundle exec rspec -f Polytrix::RSpec::YAMLReport -o reports/polytrix.yaml`
+    Then the file "reports/polytrix.yaml" should contain exactly:
+    """
+    ---
+    global_env:
+      LOCALE: en_US.UTF-8
+      FAVORITE_NUMBER: '5'
+    suites:
+      Katas:
+        env:
+          NAME: Max
+        samples:
+          hello world:
+            java:
+              validations:
+              - validated_by: polytrix
+                result: passed
+              execution_result:
+                exitstatus: 0
+                stdout: |
+                  Hello, world!
+                stderr: ''
+              source_file: challenges/HelloWorld.java
+            python:
+              validations:
+              - validated_by: polytrix
+                result: passed
+              execution_result:
+                exitstatus: 0
+                stdout: |
+                  Hello, world!
+                stderr: ''
+              source_file: challenges/hello_world.py
+            ruby:
+              validations:
+              - validated_by: polytrix
+                result: passed
+              execution_result:
+                exitstatus: 0
+                stdout: |
+                  Hello, world!
+                stderr: ''
+              source_file: challenges/hello_world.rb
+
+    """
+
+Scenario: Merging separate reports
+    Given the ruby SDK
+    And the java SDK
+    And the python SDK
+    And the hello_world polytrix config
+    And the standard rspec setup
+    When I successfully run `bundle exec rspec -f Polytrix::RSpec::YAMLReport -t ruby -o reports/polytrix-ruby.yaml`
+    When I successfully run `bundle exec rspec -f Polytrix::RSpec::YAMLReport -t java -o reports/polytrix-java.yaml`
+    When I successfully run `bundle exec rspec -f Polytrix::RSpec::YAMLReport -t python -o reports/polytrix-python.yaml`
+    And I successfully run `bundle exec ruby spec/polytrix_merge.rb reports/polytrix-java.yaml reports/polytrix-python.yaml reports/polytrix-ruby.yaml`
+    Then the file "reports/polytrix.yaml" should contain exactly:
+    """
+    ---
+    global_env:
+      LOCALE: en_US.UTF-8
+      FAVORITE_NUMBER: '5'
+    suites:
+      Katas:
+        env:
+          NAME: Max
+        samples:
+          hello world:
+            java:
+              validations:
+              - validated_by: polytrix
+                result: passed
+              execution_result:
+                exitstatus: 0
+                stdout: |
+                  Hello, world!
+                stderr: ''
+              source_file: challenges/HelloWorld.java
+            python:
+              validations:
+              - validated_by: polytrix
+                result: passed
+              execution_result:
+                exitstatus: 0
+                stdout: |
+                  Hello, world!
+                stderr: ''
+              source_file: challenges/hello_world.py
+            ruby:
+              validations:
+              - validated_by: polytrix
+                result: passed
+              execution_result:
+                exitstatus: 0
+                stdout: |
+                  Hello, world!
+                stderr: ''
+              source_file: challenges/hello_world.rb
+
+    """

data/features/step_definitions/sdk_steps.rb

@@ -0,0 +1,12 @@
+Given(/^the (\w+) SDK$/) do |sdk|
+  FileUtils.mkdir_p "#{current_dir}/sdks"
+  FileUtils.cp_r "samples/sdks/#{sdk}", "#{current_dir}/sdks"
+end
+
+Given(/^the (\w+) polytrix config$/) do |config|
+  FileUtils.cp_r "features/fixtures/configs/#{config}.yml", "#{current_dir}/polytrix_tests.yml"
+end
+
+Given(/^the standard rspec setup$/) do
+  FileUtils.cp_r 'features/fixtures/spec/', "#{current_dir}/"
+end

data/features/support/env.rb

@@ -0,0 +1,8 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'aruba/cucumber'
+
+Before do
+  @aruba_timeout_seconds = 20
+end

data/lib/polytrix/challenge.rb

@@ -1,27 +1,40 @@
 require 'hashie/dash'
 require 'hashie/extensions/coercion'
 require 'hashie/extensions/indifferent_access'
+require 'polytrix/documentation/helpers/code_helper'
 
 module Polytrix
   class Challenge < Hashie::Dash
     include Hashie::Extensions::Coercion
-    include Hashie::Extensions::IndifferentAccess
+
+    # View heleprs
+    include Polytrix::Documentation::Helpers::CodeHelper
+
     property :name
+    property :description
     property :implementor
-    property :vars, :default => {}
+    property :suite, required: true
+    property :vars, default: {}
     property :source_file
     coerce_key :source_file, Pathname
     property :basedir
     coerce_key :basedir, Pathname
-    property :challenge_runner, :default => ChallengeRunner.createRunner
+    property :challenge_runner, default: ChallengeRunner.create_runner
     property :result
     property :env_file
-    coerce_key :vars, Polytrix::Manifest::Environment
-    property :plugin_data, :default => {}
+    # coerce_key :vars, Polytrix::Manifest::Environment
+    property :plugin_data, default: {}
 
     def run
-      challenge_runner.run_challenge self
+      @result = challenge_runner.run_challenge self
     end
 
+    def validate
+      run unless @result
+      # validators = Polytrix::ValidatorRegistry.validators_for self
+      # validators.each do |validator|
+      #   validator.validate self
+      # end
+    end
   end
-end
+end

data/lib/polytrix/challenge_runner.rb

@@ -8,16 +8,11 @@ module Polytrix
     autoload :WindowsChallengeRunner, 'polytrix/runners/windows_challenge_runner'
   end
 
-  class FeatureNotImplementedError < StandardError
-    def initialize(feature)
-      super "Feature #{feature} is not implemented"
-    end
-  end
+  class ChallengeRunner < Thor::Shell::Color
+    include Polytrix::Core::FileSystemHelper
+    include Polytrix::Executor
 
-  class ChallengeRunner
-    include Polytrix::Core::FileFinder
-
-    def self.createRunner
+    def self.create_runner
       case RbConfig::CONFIG['host_os']
       when /mswin(\d+)|mingw/i
         Runners::WindowsChallengeRunner.new
@@ -34,23 +29,12 @@ module Polytrix
       ENV['CHALLENGE_EDITOR']
     end
 
-    def interactive?
-      ENV['INTERACTIVE']
-    end
-
-    def show_output?
-      ENV['SHOW_OUTPUT']
-    end
-
     def run_command(command)
-      if interactive? # allows use of pry, code.interact, etc.
-        system command
-      else # better error messages and interrupt handling
-        challenge_process = Mixlib::ShellOut.new(command)
-        challenge_process.live_stream = $stdout if show_output?
-        challenge_process.run_command
-        challenge_process.error!
-        challenge_process
+      if Polytrix.configuration.dry_run
+        puts "Would have run #{command}"
+      else
+        say_status 'polytrix:execute', command
+        execute command
       end
     end
 
@@ -59,25 +43,6 @@ module Polytrix
       challenge
     end
 
-    def find_challenge!(challenge, basedir = Dir.pwd)
-      find_file basedir, challenge
-    rescue Polytrix::Core::FileFinder::FileNotFound
-      raise FeatureNotImplementedError, challenge
-    end
-
-    def edit_challenge(challenge)
-      suffix = infer_suffix File.dirname(challenge)
-      challenge_file = "#{challenge}#{suffix}"
-      puts "Would you like to create #{challenge_file} (y/n)? "
-      system "#{challenge_editor} #{challenge_file}" if $stdin.gets.strip == 'y'
-      File.absolute_path challenge_file
-    end
-
-    def infer_suffix(source_dir)
-      # FIXME: Should be configurable or have a better way to infer
-      Dir["#{source_dir}/**/*.*"].map { |f| File.extname f }.first
-    end
-
     private
 
     def middleware

data/lib/polytrix/cli/add.rb

@@ -0,0 +1,67 @@
+module Polytrix
+  module CLI
+    class Add < Polytrix::CLI::Base
+      include Thor::Actions
+      desc 'sample IMPLEMENTOR SCENARIO', 'Add a code sample for an implementor'
+      # sdk_options
+      method_option :language, type: 'string', desc: 'Programming language to use (if not already configured by the implementor)', default: 'rb'
+      def sample(implementor, scenario)
+        # implementor = pick_implementor(options[:sdk])
+        implementor = pick_implementor implementor
+        language = implementor.language || options[:language]
+        generate_source implementor, scenario, language
+      end
+
+      protected
+
+      source_root Polytrix.configuration.template_dir
+      # source_root implementor.basedir
+
+      def generate_source(implementor, scenario, language)
+        source_paths.prepend File.expand_path(implementor.basedir)
+        @implementor = implementor
+        @scenario = implementor.build_challenge(
+          name: scenario
+        )
+        @language = language
+
+        output_file = File.join(implementor.basedir, "#{scenario.gsub(' ', '_')}.#{language}")
+        template('code_sample.tt', output_file)
+      end
+
+      def commented(comment)
+        return if comment.nil?
+
+        buffer = StringIO.new
+        _lang, comment_style = Polytrix::Documentation::CommentStyles.infer @language
+        if use_multiline? comment, comment_style
+          buffer.puts comment_style[:multi][:start]
+          comment.lines.each do |line|
+            buffer.puts comment_line(line, comment_style[:multi][:middle])
+          end
+          buffer.puts comment_style[:multi][:end]
+        else
+          comment.lines.each do |line|
+            buffer.puts comment_line(line, comment_style[:single])
+          end
+        end
+        buffer.string
+      end
+
+      def comment_line(line, comment_string)
+        comment_string ||= ''
+        if line.strip.empty?
+          whitespace, line = line.gsub("\n", ''), ''
+        else
+          whitespace, line = line.rstrip.match(/([\s]*)(.*)/).captures
+        end
+
+        "#{whitespace}#{comment_string} #{line}"
+      end
+
+      def use_multiline?(comment, comment_style)
+        comment.lines.size > 1 && !comment_style[:multi].nil? && (comment_style[:multi][:idiomatic] != false)
+      end
+    end
+  end
+end

data/lib/polytrix/cli/report.rb

@@ -0,0 +1,88 @@
+module Polytrix
+  module CLI
+    module Reports
+      # autoload :TextReporter, 'polytrix/cli/reports/text_reporter'
+      autoload :MarkdownReporter, 'polytrix/cli/reports/markdown_reporter'
+      # autoload :HTMLReporter, 'polytrix/cli/reports/html_reporter'
+      autoload :JSONReporter, 'polytrix/cli/reports/json_reporter'
+      autoload :YAMLReporter, 'polytrix/cli/reports/yaml_reporter'
+    end
+    class Report < Polytrix::CLI::Base
+      # class_options = super.class_options
+      class_option :format, desc: 'Output format for the report', default: 'text', enum: %w(text markdown json yaml)
+
+      desc 'report summary', 'Generate a summary report by SDK'
+      config_options
+      log_options
+      def summary
+        setup
+        results = load_results
+        table =  [%w(sdk passed failed pending skipped)]
+        results.each do |sdk, summary|
+          table << [sdk, summary[:passed], summary[:failed], summary[:pending], summary[:skipped]]
+        end
+        reporter.print_table table
+      end
+
+      desc 'report matrix', 'Generate a feature matrix report'
+      config_options
+      log_options
+      def matrix
+        setup
+        sdk_names = Polytrix.implementors.map(&:name)
+        table = [%w(Product Feature).concat(sdk_names)]
+
+        matrix_data.suites.each do |suite_name, suite_data|
+          suite_data.samples.each do |scenario_name, scenario_results|
+
+            statuses = sdk_names.map do |sdk|
+              result = Result.new(scenario_results[sdk])
+              result.status
+            end
+
+            table << [suite_name, scenario_name].concat(statuses)
+          end
+        end
+        reporter.print_table table
+      end
+
+      protected
+
+      def matrix_data
+        @matrix ||= Polytrix::Manifest.new(YAML.load(Polytrix.merge_results(Dir['reports/test_report*.yaml'])))
+      end
+
+      def load_results
+        result_stats = Hash.new do |hash, sdk|
+          hash[sdk] = { passed: 0, failed: 0, pending: 0, skipped: 0 }
+        end
+        matrix_data.suites.reduce(result_stats) do |hash, (suite_name, suite)|
+          suite.samples.each do |sample, suite_results|
+            Polytrix.implementors.map(&:name).each do |sdk|
+              result = Result.new(suite_results[sdk])
+              result.validations << Validation.new(validated_by: 'polytrix', result: 'skipped')
+              hash[sdk][result.status.to_sym] += 1
+            end
+          end
+          hash
+        end
+        result_stats
+      end
+
+      def reporter
+        @reporter ||= case options[:format]
+                      when 'text'
+                        self
+                      when 'markdown'
+                        Polytrix::CLI::Reports::MarkdownReporter.new
+                      when 'json'
+                        Polytrix::CLI::Reports::JSONReporter.new
+                      when 'yaml'
+                        Polytrix::CLI::Reports::YAMLReporter.new
+                      else
+                        fail "Unknown report format #{options[:format]}"
+                      end
+      end
+    end
+  end
+end

data/lib/polytrix/cli/reports/hash_reporter.rb

@@ -0,0 +1,30 @@
+require 'csv'
+
+module Polytrix
+  module CLI
+    module Reports
+      class HashReporter
+        def initialize(io = $stdout)
+          @buffer = io
+        end
+
+        def print_table(table)
+          headers = table[0]
+          data = []
+          table[1..-1].map do |row|
+            row_data = {}
+            row.each_with_index do |value, index|
+              row_data[headers[index]] = value
+            end
+            data << row_data
+          end
+          @buffer.puts convert(data)
+        end
+
+        def convert(data)
+          fail 'Subclass HashReporter and convert the data to the target format'
+        end
+      end
+    end
+  end
+end

data/lib/polytrix/cli/reports/json_reporter.rb

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

data/lib/polytrix/cli/reports/markdown_reporter.rb

@@ -0,0 +1,23 @@
+module Polytrix
+  module CLI
+    module Reports
+      class MarkdownReporter
+        def initialize(io = $stdout)
+          @buffer = io
+        end
+
+        def print_table(table)
+          @buffer.puts # Markdown tables don't always render properly without a break
+          header_data = table[0]
+          header_line = header_data.join ' | '
+          @buffer.puts header_line
+          @buffer.puts header_line.gsub(/[^|]/, '-')
+
+          table[1..-1].each do |data_line|
+            @buffer.puts data_line.join ' | '
+          end
+        end
+      end
+    end
+  end
+end

data/lib/polytrix/cli/reports/yaml_reporter.rb

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