strut 0.1.0

data/lib/strut/interaction_factory.rb

@@ -0,0 +1,25 @@
+module Strut
+  Interaction = Struct.new(:uri, :method, :statusCode)
+
+  class InteractionFactory
+    def make_interaction(path_stack)
+      interaction = Interaction.new
+
+      if path_stack[0] == "paths"
+        interaction.uri = path_stack[1] unless extension?(path_stack[1])
+      end
+
+      interaction.method = path_stack[2] unless extension?(path_stack[2])
+
+      if path_stack[3] == "responses"
+        interaction.statusCode = path_stack[4] unless extension?(path_stack[4])
+      end
+
+      interaction
+    end
+
+    def extension?(tag)
+       tag =~ /^x-/
+    end
+  end
+end

data/lib/strut/parser.rb

@@ -0,0 +1,57 @@
+require "strut/extensions"
+require "strut/document_builder"
+require "strut/interaction_factory"
+require "strut/scenario_builder"
+require "strut/slim_command"
+require "strut/slim_command_factory"
+
+module Strut
+  class Parser
+    X_SCENARIO_PREFIX = "x-scenario-"
+
+    def initialize(namespace)
+      @namespace = namespace
+      @command_factory = SlimCommandFactory.new
+      @document_builder = DocumentBuilder.new
+      @interaction_factory = InteractionFactory.new
+      @scenario_builder = ScenarioBuilder.new(@document_builder, @command_factory)
+      @scenario_number = 1
+    end
+
+    def parse(yaml)
+      parsed_yaml = Psych::parse_yaml(yaml)
+      append_import_command
+      extract_scenarios(parsed_yaml)
+      @document_builder.document
+    end
+
+    def append_import_command
+      metadata = CommandMetadata.new(1)
+      import_command = @command_factory.make_import_command(metadata, @namespace)
+      @document_builder.append_command(import_command)
+    end
+
+    def extract_scenarios(node)
+      wrapped_node = {"value" => node, "line" => 0}
+      extract_scenarios_for_node("", wrapped_node, [])
+    end
+
+    def extract_scenarios_for_node(node_name, node, path_stack)
+      if node_name.start_with?(X_SCENARIO_PREFIX)
+        fixture = node_name.gsub(/^#{X_SCENARIO_PREFIX}/, "")
+        interaction = @interaction_factory.make_interaction(path_stack)
+        @scenario_number = @scenario_builder.extract_scenarios_for_interaction(@scenario_number, interaction, fixture, node)
+      else
+        extract_scenarios_for_children(@scenario_number, node["value"], path_stack)
+      end
+    end
+
+    def extract_scenarios_for_children(scenario_number, node, path_stack)
+      return unless node.respond_to?(:each_pair)
+      node.each_pair do |child_node_name, child_node|
+        next_path_stack = path_stack + [child_node_name]
+        extract_scenarios_for_node(child_node_name.to_s, child_node, next_path_stack)
+      end
+    end
+  end
+end

data/lib/strut/report.rb

@@ -0,0 +1,48 @@
+require "strut/scenario_result"
+
+module Strut
+  class Report
+    attr_reader :number_scenarios, :number_passed, :number_failed, :number_skipped
+    attr_reader :scenario_results, :errors
+
+    def initialize
+      @scenario_results = []
+      @errors = []
+    end
+
+    def add_scenario_result(result)
+      @scenario_results << result
+    end
+
+    def add_error(error)
+      @errors << error
+    end
+
+    def annotations_for_line(line)
+      all_annotations = @scenario_results.map do |result|
+        result.annotations_for_line(line)
+      end
+      all_annotations.reject { |a| a.empty? }.flatten
+    end
+
+    def number_scenarios
+      @scenario_results.count
+    end
+
+    def number_passed
+      number_with_result(SCENARIO_PASS)
+    end
+
+    def number_failed
+      number_with_result(SCENARIO_FAIL)
+    end
+
+    def number_skipped
+      number_with_result(SCENARIO_ERROR)
+    end
+
+    def number_with_result(result)
+      @scenario_results.select { |scenario| scenario.result == result }.count
+    end
+  end
+end

data/lib/strut/report_builder.rb

@@ -0,0 +1,56 @@
+require "strut/report"
+
+module Strut
+  class ReportBuilder
+    def build(responses, document)
+      report = Report.new
+
+      scenario_results = Hash.new { |h, k| h[k] = ScenarioResult.new }
+      responses.each do |response|
+        handle_response(response, document, report, scenario_results)
+      end
+
+      scenario_results.each_pair do |_, result|
+        report.add_scenario_result(result)
+      end
+
+      report
+    end
+
+    def handle_response(response, document, report, scenario_results)
+      command_id, command_result = *response
+      if command_id == "error"
+        report.add_error(command_result.to_s)
+      else
+        metadata = document.metadata_for_command_id(command_id)
+        if metadata
+          process_result(command_result, metadata, report, scenario_results)
+        else
+          report.add_error("Unexpected response from Slim: #{response.inspect}")
+        end
+      end
+    end
+
+    def process_result(result, metadata, report, scenario_results)
+      scenario_result = scenario_results[metadata.scenario_number]
+      scenario_result.name = "Scenario #{metadata.scenario_number}, line #{metadata.line}"
+
+      if exception_message = exceptional_result?(result)
+        scenario_result.add_exception_for_line(metadata.line, exception_message)
+      elsif failed_result?(result, metadata)
+        fail_message = "Expected #{metadata.expected_value} but got #{result}"
+        scenario_result.add_fail_for_line(metadata.line, fail_message)
+      else
+        scenario_result.add_ok_for_line(metadata.line)
+      end
+    end
+
+    def exceptional_result?(result)
+      result =~ /^__EXCEPTION__:message:(.+)/ ? $1 : nil
+    end
+
+    def failed_result?(result, metadata)
+      metadata.expected_value && metadata.expected_value.to_s != result.to_s
+    end
+  end
+end

data/lib/strut/report_junit_formatter.rb

@@ -0,0 +1,47 @@
+module Strut
+  class ReportJUnitFormatter
+    def format(report)
+      doc = REXML::Document.new("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n")
+      results = report.scenario_results
+      add_testsuite(results, doc)
+      doc.to_s
+    end
+
+    def add_testsuite(results, doc)
+      testsuite = doc.add_element("testsuite")
+      results.each do |scenario|
+        add_testcase_for_scenario(scenario, testsuite)
+      end
+    end
+
+    def add_testcase_for_scenario(scenario, testsuite)
+      testcase = testsuite.add_element("testcase")
+      testcase.attributes["name"] = scenario.name
+      testcase.attributes["time"] = scenario.time
+      testcase.attributes["classname"] = "swagger"
+      add_result_for_testcase(scenario, testcase)
+    end
+
+    def add_result_for_testcase(scenario, testcase)
+      if scenario.result == SCENARIO_FAIL
+        add_failure_for_testcase(scenario.message, testcase)
+      elsif scenario.result == SCENARIO_ERROR
+        add_error_for_testcase(scenario.message, testcase)
+      end
+    end
+
+    def add_failure_for_testcase(message, testcase)
+      add_element_for_testcase("failure", testcase, message, "assert")
+    end
+
+    def add_error_for_testcase(message, testcase)
+      add_element_for_testcase("error", testcase, message, "exception")
+    end
+
+    def add_element_for_testcase(element, testcase, message, type)
+      node = testcase.add_element(element)
+      node.attributes["message"] = message
+      node.attributes["type"] = type
+    end
+  end
+end

data/lib/strut/report_pretty_formatter.rb

@@ -0,0 +1,91 @@
+require "rubygems"
+require "term/ansicolor"
+include Term::ANSIColor
+require "strut/report"
+
+module Strut
+  class ReportPrettyFormatter
+    def initialize(lines)
+      @lines = lines
+    end
+
+    def format(report)
+      begin
+        out = StringIO.new
+        $stdout = out
+        print_report_to_stdout(report)
+      ensure
+        $stdout = STDOUT
+      end
+      out.string
+    end
+
+    def print_report_to_stdout(report)
+      @lines.each_line.each_with_index do |line, index|
+        annotations = report.annotations_for_line(index+1)
+        print_line_with_annotations(line.chomp, annotations)
+      end
+      puts
+      print_errors(report)
+      print "#{report.number_scenarios} scenarios ("
+      print green { "#{report.number_passed} passed" }, ", "
+      print red { "#{report.number_failed} failed" }, ", "
+      print yellow { "#{report.number_skipped} skipped" }, ")"
+    end
+
+    def print_line_with_annotations(line, annotations)
+      if annotations.empty?
+        print_unannotated_line(line)
+      elsif
+        print_annotated_line(annotations, line)
+      end
+    end
+
+    def print_unannotated_line(line)
+      puts line
+    end
+
+    def print_annotated_line(annotations, line)
+      # TODO: print all annotations, not just the first
+      annotation = annotations.first
+
+      case annotation.type
+      when ANNOTATION_EXCEPTION
+        print_exception_line(line, annotation.message)
+      when ANNOTATION_FAIL
+        print_fail_line(line, annotation.message)
+      else
+        print_ok_line(line)
+      end
+    end
+
+    def print_exception_line(line, message)
+      print_error_line(line, :black, :on_yellow, message, :yellow, :on_black)
+    end
+
+    def print_fail_line(line, message)
+      print_error_line(line, :white, :on_red, message, :red, :on_white)
+    end
+
+    def print_ok_line(line)
+      print_line(line, :black, :on_green)
+    end
+
+    def print_error_line(line, line_fg, line_bg, message, message_fg, message_bg)
+      print_line(line, line_fg, line_bg)
+      print_line(message, message_fg, message_bg)
+    end
+
+    def print_line(line, foreground, background)
+      puts line.send(foreground).send(background)
+    end
+
+    def print_errors(report)
+      return if report.errors.empty?
+      report.errors.each do |error|
+        print red { error }, "\n"
+      end
+      puts
+    end
+  end
+end

data/lib/strut/scenario_builder.rb

@@ -0,0 +1,124 @@
+module Strut
+  class ScenarioBuilder
+    def initialize(document_builder, command_factory)
+      @document_builder = document_builder
+      @command_factory = command_factory
+    end
+
+    def extract_scenarios_for_interaction(scenario_number, interaction, fixture, node)
+      instance = "instance-#{scenario_number}"
+      line = node["line"]
+      scenario_definitions_for_node(node).each do |scenario_stages|
+        make_scenario(scenario_number, line, instance, fixture, interaction, scenario_stages)
+        scenario_number += 1
+      end
+      scenario_number
+    end
+
+    def scenario_definitions_for_node(node)
+      raw_scenarios = node["value"]
+      raw_scenarios = [raw_scenarios] if raw_scenarios.respond_to?(:each_pair)
+      raw_scenarios
+    end
+
+    def make_scenario(scenario_number, line, instance, fixture, interaction, scenario_stages)
+      append_make_command(scenario_number, line, instance, fixture)
+      append_uri_command(scenario_number, line, instance, interaction.uri, scenario_stages)
+      append_method_command(scenario_number, line, instance, interaction.method)
+      append_given_commands(scenario_number, scenario_stages, instance)
+      append_execute_command(scenario_number, line, instance)
+      append_then_commands(scenario_number, scenario_stages, instance)
+      append_status_command(scenario_number, line, instance, interaction.statusCode)
+    end
+
+    def append_make_command(scenario_number, line, instance, class_name)
+      metadata = CommandMetadata.new(scenario_number, line)
+      make_command = @command_factory.make_make_command(metadata, instance, class_name)
+      @document_builder.append_command(make_command)
+    end
+
+    def append_uri_command(scenario_number, line, instance, uri, scenario_stages)
+      if uri
+        metadata = CommandMetadata.new(scenario_number, line)
+        combined_uri = combine_uri_with_parameters(scenario_stages, uri)
+        path_command = make_set_command(scenario_number, line, instance, "uri", combined_uri)
+        @document_builder.append_command(path_command)
+      end
+    end
+
+    def append_method_command(scenario_number, line, instance, method)
+      if method
+        metadata = CommandMetadata.new(scenario_number, line)
+        method_command = make_set_command(scenario_number, line, instance, "method", method)
+        @document_builder.append_command(method_command)
+      end
+    end
+
+    def combine_uri_with_parameters(stages, uri)
+      combined_uri = uri.dup
+      when_stages = stages_with_names(stages, ["when"])
+      when_stages.each do |stage|
+        stage.each do |k, v|
+          argument = v["value"].to_s
+          combined_uri.gsub!(/\{#{k}\}/, argument)
+        end
+      end
+      combined_uri
+    end
+
+    def append_given_commands(scenario_number, stages, instance)
+      given_stages = stages_with_names(stages, ["given", "when"])
+      parse_stages(given_stages) { |k, v| make_given_command(scenario_number, k, v, instance) }
+    end
+
+    def append_execute_command(scenario_number, line, instance)
+      metadata = CommandMetadata.new(scenario_number, line)
+      execute_command = @command_factory.make_call_command(metadata, instance, "execute")
+      @document_builder.append_command(execute_command)
+    end
+
+    def append_then_commands(scenario_number, stages, instance)
+      then_stages = stages_with_names(stages, ["then"])
+      parse_stages(then_stages) { |k, v| make_then_command(scenario_number, k, v, instance) }
+    end
+
+    def append_status_command(scenario_number, line, instance, statusCode)
+      if statusCode
+        metadata = CommandMetadata.new(scenario_number, line, statusCode)
+        status_command = @command_factory.make_call_command(metadata, instance, "statusCode")
+        @document_builder.append_command(status_command)
+      end
+    end
+
+    def make_given_command(scenario_number, property_name, value_container, instance)
+      line = value_container["line"]
+      value = value_container["value"]
+      make_set_command(scenario_number, line, instance, property_name, value)
+    end
+
+    def make_set_command(scenario_number, line, instance, name, value)
+      metadata = CommandMetadata.new(scenario_number, line)
+      @command_factory.make_call_command(metadata, instance, "set_#{name}", value)
+    end
+
+    def make_then_command(scenario_number, property_name, value_container, instance)
+      line = value_container["line"]
+      value = value_container["value"]
+      metadata = CommandMetadata.new(scenario_number, line, value)
+      @command_factory.make_call_command(metadata, instance, property_name)
+    end
+
+    def stages_with_names(stages, names)
+      names.map { |name| stages[name] }.reject { |stage| stage.nil? }.map { |stage| stage["value"] }
+    end
+
+    def parse_stages(stages, &block)
+      stages.each do |stage|
+        stage.each do |k, v|
+          command = block.call(k, v)
+          @document_builder.append_command(command)
+        end
+      end
+    end
+  end
+end