spec_tracker 1.2.0

data/lib/spec_tracker/cli.rb

@@ -0,0 +1,24 @@
+module SpecTracker
+  class CLI < Thor
+      desc 'report', 'generate a report for a given configuration (default or custom)'
+      method_option :spec_path, type: :string, desc: "Path to the specifications. Expects a relative path to a file or a directory. Default: specifications"
+      method_option :test_report_path, type: :string, desc: "Path to the test reports. Expects a relative path to a file or a directory. Default: test/reports"
+      method_option :scenario_id_regex, type: :string, desc: "Regexp to find scenario ID in test reports. Default : \\[([a-zA-Z\\-]+)\\]"
+      method_option :spec_type, enum: %w(csv gherkin), desc: "Type of specification files. Default : csv"
+      method_option :scenario_id_header, type: :string, desc: "Name of the scenario ID column when spec files are csv. Default: #Scenario"
+      method_option :scenario_name_header, type: :string, desc: "Name of the scenario name column when spec files are csv. Default: Name/Rule"
+      method_option :locale, enum: %w(fr en), desc: "Locale for text output. Default: fr"
+      def report
+        SpecTracker.configure do |configuration|
+          configuration.spec_path = options[:spec_path] if options[:spec_path]
+          configuration.test_report_path = options[:test_report_path] if options[:test_report_path]
+          configuration.scenario_id_regex = Regexp.new(options[:scenario_id_regex]) if options[:scenario_id_regex]
+          configuration.spec_type = options[:spec_type] if options[:spec_type]
+          configuration.scenario_id_header = options[:scenario_id_header] if options[:scenario_id_header]
+          configuration.scenario_name_header = options[:scenario_name_header] if options[:scenario_name_header]
+          configuration.locale = options[:locale] if options[:locale]
+        end
+        SpecTracker::ReportTask.new.execute
+      end
+  end
+end

data/lib/spec_tracker/config/configuration.rb

@@ -0,0 +1,23 @@
+module SpecTracker
+  class Configuration
+    attr_accessor :scenario_id_header, :scenario_name_header, :locale,
+                  :test_report_path, :spec_path, :scenario_id_regex, :spec_type
+
+    attr_reader :wording, :local_path
+
+    def initialize
+      @scenario_id_header = 'Scenario ID'
+      @scenario_name_header = 'Name/Rule'
+      @spec_path = 'specifications'
+      @test_report_path = 'test/reports'
+      @scenario_id_regex = /\[([a-zA-Z\-]+)\]/
+      @spec_type = 'csv'
+      @available_types = %w(csv gherkin)
+      @locale = 'fr'
+      @available_locales = %w(fr en)
+      wording_path = Pathname.new(__FILE__).join("../#{locale}.yml")
+      @wording = YAML.load_file(wording_path)[:"#{locale}"]
+      @local_path = Pathname.new(Dir.pwd)
+    end
+  end
+end

data/lib/spec_tracker/config/en.yml

@@ -0,0 +1,8 @@
+:en:
+  :missing_specs: Missing requirements files
+  :bad_format: The requirement file is not a csv
+  :too_many_arguments: Too many arguments
+  :scenario_id: Scenario ID
+  :scenario_name: Scenario Name
+  :test_result: Test Result
+  :progression: Progression

data/lib/spec_tracker/config/fr.yml

@@ -0,0 +1,8 @@
+:fr:
+  :missing_specs: Le fichier de spécification n'a pas été fourni
+  :bad_format: Le fichier de specs n'est pas un csv
+  :too_many_arguments: Trop d'arguments ont été fournis
+  :scenario_id: Identifiant du scénario
+  :scenario_name: Nom du scénario
+  :test_result: Statut du test
+  :progression: Progression

data/lib/spec_tracker/report_task.rb

@@ -0,0 +1,26 @@
+module SpecTracker
+  class ReportTask
+    attr_reader :spec_parser, :test_report_parser, :report_mapper, :reporter
+
+    def initialize
+      spec_type = SpecTracker.configuration.spec_type
+      @spec_parser = (spec_type == %q{gherkin}) ? SpecParser::GherkinParser.new : SpecParser::CSVParser.new
+      @test_report_parser = TestReportParser::JUnit::Parser.new
+      @report_mapper = Reporter::ReportMapper.new
+      @reporter = Reporter::Terminal::Reporter.new
+    end
+
+    def execute
+      specifications = spec_parser.parse(SpecTracker.configuration.spec_path)
+      test_results = test_report_parser.parse(SpecTracker.configuration.test_report_path)
+      specifications.map do |specification|
+        report = report_mapper.map(
+          topic: specification.topic,
+          scenarios: specification.scenarios,
+          test_results: test_results
+        )
+        reporter.print(report)
+      end
+    end
+  end
+end

data/lib/spec_tracker/reporter/base_reporter.rb

@@ -0,0 +1,24 @@
+module SpecTracker
+  module Reporter
+    class BaseReporter
+      def initialize
+        # Should initialize UIMapper
+        raise Error.new('override me!')
+      end
+
+      def print(_)
+        raise Error.new('override me!')
+      end
+
+      protected
+
+      def view_models(report_data)
+
+      end
+
+      private
+
+      attr_reader :ui_mapper
+    end
+  end
+end

data/lib/spec_tracker/reporter/base_ui_mapper.rb

@@ -0,0 +1,25 @@
+module SpecTracker
+  module Reporter
+    class BaseUIMapper
+      include StatusUI
+
+      def map(_)
+        raise Error.new('override me!')
+      end
+
+      protected
+
+      def status_to_ui(status)
+        if status.success?
+          SUCCESS_EMOJI
+        elsif status.failure?
+          FAILURE_EMOJI
+        elsif status.skipped?
+          SKIPPED_EMOJI
+        elsif status.missing?
+          MISSING_EMOJI
+        end
+      end
+    end
+  end
+end

data/lib/spec_tracker/reporter/report.rb

@@ -0,0 +1,17 @@
+module SpecTracker
+  module Reporter
+    class Report
+      attr_reader :data, :topic
+
+      def initialize(data:, topic:)
+        @data = data
+        @topic = topic
+      end
+
+      def progression
+        success_count = data.select {|report_datum| report_datum.status.success?}.size
+        (success_count.to_f / data.size.to_f * 100).round(1)
+      end
+    end
+  end
+end

data/lib/spec_tracker/reporter/report_datum.rb

@@ -0,0 +1,13 @@
+module SpecTracker
+  module Reporter
+    class ReportDatum
+      attr_reader :scenario_id, :scenario_name, :status
+
+      def initialize(scenario_id:, scenario_name:, status:)
+        @scenario_id = scenario_id
+        @scenario_name = scenario_name
+        @status = status
+      end
+    end
+  end
+end

data/lib/spec_tracker/reporter/report_mapper.rb

@@ -0,0 +1,19 @@
+module SpecTracker
+  module Reporter
+    class ReportMapper
+      def map(scenarios:, test_results:, topic:)
+        report_data = scenarios.map do |scenario|
+          test_result = test_results.detect {|test_result| test_result.scenario_id == scenario.id}
+          if test_result
+            test_status = test_result.status
+          else
+            test_status = TestStatus.new
+            test_status.missing!
+          end
+          ReportDatum.new(scenario_id: scenario.id, scenario_name: scenario.name, status: test_status)
+        end
+        Report.new(data: report_data, topic: topic)
+      end
+    end
+  end
+end

data/lib/spec_tracker/reporter/status_ui.rb

@@ -0,0 +1,8 @@
+module SpecTracker
+  module StatusUI
+    SUCCESS_EMOJI = Emoji.find_by_alias("white_check_mark").raw.freeze
+    FAILURE_EMOJI = Emoji.find_by_alias("x").raw.freeze
+    SKIPPED_EMOJI = Emoji.find_by_alias("fast_forward").raw.freeze
+    MISSING_EMOJI = Emoji.find_by_alias("no_mouth").raw.freeze
+  end
+end

data/lib/spec_tracker/reporter/terminal/reporter.rb

@@ -0,0 +1,28 @@
+module SpecTracker
+  module Reporter
+    module Terminal
+      class Reporter < BaseReporter
+        def initialize
+          @ui_mapper = UIMapper.new
+        end
+
+        def print(report)
+          terminal_table = ::Terminal::Table.new do |t|
+            t.title = report.topic
+            t.headings = [
+              SpecTracker.configuration.wording[:scenario_id],
+              SpecTracker.configuration.wording[:scenario_name],
+              SpecTracker.configuration.wording[:test_result]
+            ]
+            t.rows = ui_mapper.map(report)
+            t.add_separator
+            t.add_row [SpecTracker.configuration.wording[:progression], nil, "#{report.progression}%"]
+          end
+          terminal_table.align_column(2, :center)
+          terminal_table.align_column(0, :center)
+          puts terminal_table
+        end
+      end
+    end
+  end
+end

data/lib/spec_tracker/reporter/terminal/ui_mapper.rb

@@ -0,0 +1,13 @@
+module SpecTracker
+  module Reporter
+    module Terminal
+      class UIMapper < BaseUIMapper
+        def map(report)
+          report.data.map do |report_datum|
+            [report_datum.scenario_id, report_datum.scenario_name, status_to_ui(report_datum.status)]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/spec_tracker/spec_parser/base_parser.rb

@@ -0,0 +1,36 @@
+module SpecTracker
+  module SpecParser
+    class BaseParser
+      def parse(path)
+        specifications = []
+        if spec_path(path).directory?
+          spec_path(path).each_entry do |entry|
+            next unless entry.extname == spec_file_extension
+            scenarios = parse_single(spec_path(path).join(entry.basename))
+            specifications << Specification.new(topic: entry.basename, scenarios: scenarios)
+          end
+        else
+          scenarios = parse_single(spec_path(path))
+          specifications << Specification.new(topic: spec_path(path).basename, scenarios: scenarios)
+        end
+        specifications
+      end
+
+      protected
+
+      def spec_file_extension
+        raise Error.new('override me!')
+      end
+
+      def parse_single(spec_file)
+        raise Error.new('override me!')
+      end
+
+      private
+
+      def spec_path(path)
+        SpecTracker.configuration.local_path.join(path)
+      end
+    end
+  end
+end

data/lib/spec_tracker/spec_parser/csv_parser.rb

@@ -0,0 +1,24 @@
+module SpecTracker
+  module SpecParser
+    class CSVParser < BaseParser
+      private
+
+      def spec_file_extension
+        '.csv'
+      end
+
+      def parse_single(csv_file)
+        scenarios = []
+        scenario_id_header = SpecTracker.configuration.scenario_id_header
+        scenario_name_header = SpecTracker.configuration.scenario_name_header
+        CSV.foreach(csv_file, headers: true, skip_blanks: true) do |row|
+          next if row[scenario_id_header].nil?
+          scenario_id = row[scenario_id_header]
+          scenario_name = row[scenario_name_header]
+          scenarios << Scenario.new(id: scenario_id, name: scenario_name)
+        end
+        scenarios
+      end
+    end
+  end
+end

data/lib/spec_tracker/spec_parser/gherkin_parser.rb

@@ -0,0 +1,27 @@
+module SpecTracker
+  module SpecParser
+    class GherkinParser < BaseParser
+      def initialize
+        @language_parser = Gherkin::Parser.new
+      end
+
+      private
+
+      def spec_file_extension
+        '.feature'
+      end
+
+      # FIXME: handle large files
+      def parse_single(spec_file)
+        file_content = File.read(spec_file)
+        parse_result = @language_parser.parse(file_content)
+        parse_result[:feature][:children].select { |child| child[:type].downcase == :scenario }.map do |scenario|
+          scenario_id = scenario[:name].slice(SpecTracker.configuration.scenario_id_regex, 1)
+          next if scenario_id.nil?
+          scenario_name = scenario[:name].gsub(SpecTracker.configuration.scenario_id_regex, '').strip
+          Scenario.new(id: scenario_id, name: scenario_name)
+        end
+      end
+    end
+  end
+end

data/lib/spec_tracker/spec_parser/scenario.rb

@@ -0,0 +1,12 @@
+module SpecTracker
+  module SpecParser
+    class Scenario
+      attr_reader :id, :name
+
+      def initialize(id:, name:)
+        @id = id
+        @name = name
+      end
+    end
+  end
+end

data/lib/spec_tracker/spec_parser/specification.rb

@@ -0,0 +1,12 @@
+module SpecTracker
+  module SpecParser
+    class Specification
+      attr_reader :topic, :scenarios
+
+      def initialize(topic:, scenarios:)
+        @topic = topic
+        @scenarios = scenarios
+      end
+    end
+  end
+end

data/lib/spec_tracker/test_report_parser/base_mapper.rb

@@ -0,0 +1,52 @@
+module SpecTracker
+  module TestReportParser
+    class BaseMapper
+      def map(test_case)
+        name = get_scenario_name(test_case)
+        scenario_id = get_scenario_id(name)
+        status = get_scenario_status(test_case)
+        TestResult.new(scenario_id: scenario_id, status: status)
+      end
+
+      protected
+
+      def get_scenario_name(_)
+        raise Error.new('override me!')
+      end
+
+      def failed?(_)
+        raise Error.new('override me!')
+      end
+
+      def success?(_)
+        raise Error.new('override me!')
+      end
+
+      def skipped?(_)
+        raise Error.new('override me!')
+      end
+
+      private
+
+      def get_scenario_id(scenario_name)
+        scenario_name.slice(scenario_id_regex, 1)
+      end
+
+      def scenario_id_regex
+        SpecTracker.configuration.scenario_id_regex
+      end
+
+      def get_scenario_status(testcase)
+        test_status = TestStatus.new
+        if success?(testcase)
+          test_status.success!
+        elsif skipped?(testcase)
+          test_status.skipped!
+        else
+          test_status.failure!
+        end
+        test_status
+      end
+    end
+  end
+end

data/lib/spec_tracker/test_report_parser/base_parser.rb

@@ -0,0 +1,43 @@
+module SpecTracker
+  module TestReportParser
+    class BaseParser
+      def parse(path)
+        test_results = []
+        if report_path(path).directory?
+          report_path(path).each_entry do |entry|
+            results = parse_single(report_path(path).join(entry.basename))
+            test_results.concat(results) unless results.empty?
+          end
+        else
+          results = parse_single(report_path(path))
+          test_results.concat(results) unless results.empty?
+        end
+        test_results
+      end
+
+      protected
+
+      def parse_single(file)
+        raise Error.new('override me!')
+      end
+
+      def file_extension
+        raise Error.new('override me!')
+      end
+
+      def test_cases(_)
+        raise Error.new('override me!')
+      end
+
+      def valid_extension?(entry)
+        entry.extname == file_extension
+      end
+
+      private
+
+      def report_path(path)
+        SpecTracker.configuration.local_path.join(path)
+      end
+    end
+  end
+end