RubyGems - xcpretty - Versions diffs - 0.1.6 → 0.1.7 - Mend

xcpretty 0.1.6 → 0.1.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (15) hide show

checksums.yaml +4 -4
data/assets/report.html.erb +18 -1
data/bin/xcpretty +7 -1
data/features/assets/RACCommandSpec, line 80, hello xcpretty.png +0 -0
data/features/assets/apple_raw.png +0 -0
data/features/html_report.feature +14 -0
data/features/steps/formatting_steps.rb +8 -0
data/features/steps/html_steps.rb +8 -0
data/features/support/env.rb +7 -0
data/lib/xcpretty/parser.rb +2 -2
data/lib/xcpretty/reporters/html.rb +24 -1
data/lib/xcpretty/version.rb +1 -1
data/spec/fixtures/constants.rb +4 -0
data/spec/xcpretty/parser_spec.rb +10 -2
metadata +7 -4

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc82776a1b5b7af57ec1112e3272f12a6942513b
-  data.tar.gz: 521c086a0311bf369acd88e7edf6ca3730ae6389
+  metadata.gz: b331eae2bee45d93e2fa2f33485126e2f64bdbbd
+  data.tar.gz: b017362f2060e5a0b0f9e84b231bc9ab47e4e46e
 SHA512:
-  metadata.gz: c9e3c17930e218fea3f34d5d8ea42b279d269c3869616c039ce84f356bdb9ac9528a3800d1fc25fcba975776036edc3ef0fb27894d0edbf0ea9a415603865d5a
-  data.tar.gz: 6d1274dbbf1824d65e07cf802d4f5795276e850778e24c2f82d07a47fb822d37761eebba5b2286a71ddcfae6c8b46f058160077bc96211c1c3a1dd3c65028af6
+  metadata.gz: 5754797a03a00904e8959a8cb7803bb30a7faaea12413e966c176a5f0157d16254afb5dfebe5b0053d5d4672c2ac52ceebd7d51175533c416544128bb999d614
+  data.tar.gz: 603f9a32654dea4a174b11a81ff26c783da32d3aee6e4174d4ffa8528d927c5312bbc807be1d7eb4676f9d537b247b8c1cd01dfd168d05b8f587c06ae7585c8e

data/assets/report.html.erb CHANGED Viewed

@@ -35,6 +35,10 @@
       .test .title { float: left; font-size: 0.9em; margin-top: 8px; font-family: Menlo, Monaco, monospace;}
       .test .time { float: left;margin: 4px 10px 0 20px;}
       .test-detail { font-family:Menlo, Monaco, monospace; font-size: 0.9em; margin: 5px 0 5px 0px;}
+      .screenshots { height: auto; overflow: hidden; padding: 4px 4px 0 4px; background-color: #B8E986; border: #A1D761; border-width: 0 1px; border-style: solid; }
+      .screenshots.failing { border-color: #C84F5E; background-color: #E58591; }
+      .screenshot { max-height: 60px; float: left; transition: max-height 0.2s; margin: 0 4px 4px 0 }
+      .screenshot.selected { max-height: 568px; }
       #test-suites { display: inline-block; width: 100%;margin-top:100px;}
       #segment-bar { margin-top: 10px;margin-left: 14px;float:right;}
       #segment-bar a:first-child { border-radius: 9px 0 0 9px; border-right: none;}
@@ -92,6 +96,10 @@
           showAll(document.querySelectorAll('.test-suite.passing'));
         }
       }
+      var toggleScreenshot = function(suiteName, index) {
+        var screenshot = document.getElementById("screenshot-" + suiteName + "-" + index);
+        isSelected(screenshot) ? deselect(screenshot) : select(screenshot);
+      }
     </script>
   </head>
   <body>
@@ -119,6 +127,15 @@
             <h3 class="title"><%= name %></h3>
           </section>
           <section class="tests">
+            <% unless info[:screenshots].empty? %>
+            <div class="screenshots <%= info[:failing] ? 'failing' : 'passing'%>">
+              <% info[:screenshots].each_with_index do |screenshot, index| %>
+                  <a href="javascript:toggleScreenshot('<%=name %>', <%=index %>)">
+                    <img class="screenshot" id="screenshot-<%=name %>-<%=index %>" src="<%=screenshot %>" />
+                  </a>
+              <% end %>
+            </div>
+            <% end %>
             <table>
             <% info[:tests].each_with_index do |test, index| %>
               <% detail_class = test[:name].gsub(/\s/,'') %>
@@ -152,4 +169,4 @@
     </section>
     <footer>Report generated with <a href="https://github.com/mneorr/xcpretty">xcpretty</a></footer>
   </body>
-</html>
+</html>

data/bin/xcpretty CHANGED Viewed

@@ -54,10 +54,16 @@ OptionParser.new do |opts|
   end
   opts.on('-o', '--output PATH', 'Write report output to PATH') do |path|
     unless opts = report_options.last
-      XCPretty.exit_with_error('Expected report format to be specified before before output path')
+      XCPretty.exit_with_error('Expected report format to be specified before output path')
     end
     opts[:path] = path
   end
+  opts.on('--screenshots', 'Collect screenshots in the HTML report') do
+    unless opts = report_options.last
+      XCPretty.exit_with_error('Expected screenshot argument to be specified after report format')
+    end
+    opts[:screenshots] = true
+  end
   opts.on_tail('-h', '--help', 'Show this message') { puts opts; exit }
   opts.on_tail("-v", "--version", "Show version") { puts XCPretty::VERSION; exit }
   opts.parse!

data/features/assets/RACCommandSpec, line 80, hello xcpretty.png ADDED Viewed

Binary file

data/features/assets/apple_raw.png ADDED Viewed

Binary file

data/features/html_report.feature CHANGED Viewed

@@ -38,3 +38,17 @@ Feature: Creating a HTML test report
     Scenario: Writing to multiple custom file paths
         When I pipe to xcpretty with two custom "html" report paths
         Then I should have test reports in two custom paths
+    Scenario: Showing screenshots
+        Given I have a passing test in my suite
+        And the test suite has finished
+        And I have a screenshot in the output folder
+        When I pipe to xcpretty with "--report html --screenshots"
+        Then I should see a screenshot in HTML
+  Scenario: Preventing unrelated images to be included in final report
+        Given I have a passing test in my suite
+        And the test suite has finished
+        And I have an unrelated image in the output folder
+        When I pipe to xcpretty with "--report html --screenshots"
+        Then I should not see a screenshot in HTML

data/features/steps/formatting_steps.rb CHANGED Viewed

@@ -92,6 +92,14 @@ Given(/^I have a file to touch$/) do
   add_run_input SAMPLE_TOUCH
 end
+Given(/^I have a screenshot in the output folder/) do
+  copy_file_to_screenshot_dir(SAMPLE_SCREENSHOT_FILE)
+end
+Given(/^I have an unrelated image in the output folder/) do
+  copy_file_to_screenshot_dir(SAMPLE_UNRELATED_IMAGE_FILE)
+end
 Then(/^I should see text beginning with "(.*?)"$/) do |text|
   run_output.lines.to_a.detect {|line| line.start_with? text }.should_not be_nil
 end

data/features/steps/html_steps.rb CHANGED Viewed

@@ -21,3 +21,11 @@ end
 Then(/^I should see (\d+) test suite sections? in HTML$/) do |section_count|
   html_test_suites.size.should == section_count.to_i
 end
+Then(/^I should see a screenshot in HTML$/) do
+  html_report_body.get_elements("//*[contains(@class, 'screenshot')]/").to_a.size.should_not == 0
+end
+Then(/^I should not see a screenshot in HTML$/) do
+  html_report_body.get_elements("//*[contains(@class, 'screenshot')]/").to_a.size.should == 0
+end

data/features/support/env.rb CHANGED Viewed

@@ -11,6 +11,7 @@ require 'lib/xcpretty/formatters/formatter'
 require 'lib/xcpretty/reporters/junit'
 require 'lib/xcpretty/reporters/html'
 require 'lib/xcpretty/reporters/json_compilation_database'
 begin
   require 'json'
 rescue LoadError
@@ -91,6 +92,11 @@ def other_custom_report_path
   end
 end
+def copy_file_to_screenshot_dir(screenshot_file)
+  @screenshot_file_path = "#{XCPretty::HTML::SCREENSHOT_DIR}/#{screenshot_file}"
+  FileUtils.cp("features/assets/#{screenshot_file}", @screenshot_file_path)
+end
 Before do
   self.colorize = true
 end
@@ -105,4 +111,5 @@ After do
   FileUtils.rm_rf(XCPretty::JUnit::FILEPATH)
   FileUtils.rm_rf(XCPretty::HTML::FILEPATH)
   FileUtils.rm_rf(XCPretty::JSONCompilationDatabase::FILEPATH)
+  File.delete(@screenshot_file_path) if @screenshot_file_path
 end

data/lib/xcpretty/parser.rb CHANGED Viewed

@@ -114,7 +114,7 @@ module XCPretty
     # @regex Captured groups
     # $1 = suite
     # $2 = time
-    TESTS_RUN_COMPLETION_MATCHER = /^\s*Test Suite '(?:.*\/)?(.*[ox]ctest.*)' finished at (.*)/
+    TESTS_RUN_COMPLETION_MATCHER = /^\s*Test Suite '(?:.*\/)?(.*[ox]ctest.*)' (finished|passed|failed) at (.*)/
     # @regex Captured groups
     # $1 = suite
@@ -267,7 +267,7 @@ module XCPretty
       when PBXCP_MATCHER
         formatter.format_pbxcp($1)
       when TESTS_RUN_COMPLETION_MATCHER
-        formatter.format_test_run_finished($1, $2)
+        formatter.format_test_run_finished($1, $3)
       when TESTS_RUN_START_MATCHER
         formatter.format_test_run_started($1)
       when TEST_SUITE_START_MATCHER

data/lib/xcpretty/reporters/html.rb CHANGED Viewed

@@ -4,6 +4,7 @@ module XCPretty
     include XCPretty::FormatMethods
     FILEPATH = 'build/reports/tests.html'
     TEMPLATE = File.expand_path('../../../../assets/report.html.erb', __FILE__)
+    SCREENSHOT_DIR = 'build/reports'
     def load_dependencies
       unless @@loaded ||= false
@@ -21,6 +22,7 @@ module XCPretty
       @parser      = Parser.new(self)
       @test_count  = 0
       @fail_count  = 0
+      @collect_screenshots = options[:screenshots]
     end
     def handle(line)
@@ -51,7 +53,7 @@ module XCPretty
     def add_test(suite_name, data)
       @test_count += 1
-      @test_suites[suite_name] ||= {:tests => []}
+      @test_suites[suite_name] ||= {:tests => [], :screenshots => []}
       @test_suites[suite_name][:tests] << data
       if data[:failing]
         @test_suites[suite_name][:failing] = true
@@ -60,6 +62,9 @@ module XCPretty
     end
     def write_report
+      if @collect_screenshots
+        load_screenshots
+      end
       File.open(@filepath, 'w') do |f|
         # WAT: get rid of these locals. BTW Cucumber fails if you remove them
         test_suites = @test_suites
@@ -69,5 +74,23 @@ module XCPretty
         f.write erb.result(binding)
       end
     end
+    def load_screenshots
+      Dir.foreach(SCREENSHOT_DIR) do |item|
+        next if item == '.' || item == '..' || File.extname(item) != '.png'
+        suite_name = find_test_suite(item)
+        next if suite_name.nil?
+        @test_suites[suite_name][:screenshots] << item
+      end
+    end
+    def find_test_suite(image_name)
+      @test_suites.each do |key, value|
+        return key if image_name.start_with?(key)
+      end
+      nil
+    end
   end
 end

data/lib/xcpretty/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module XCPretty
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

data/spec/fixtures/constants.rb CHANGED Viewed

@@ -6,6 +6,8 @@ SAMPLE_OCUNIT_TEST_RUN_BEGINNING = "Test Suite '/Users/musalj/Library/Developer/
 SAMPLE_KIWI_TEST_RUN_BEGINNING = "Test Suite 'ObjectiveRecordTests.xctest' started at 2013-12-10 06:15:39 +0000"
 SAMPLE_SPECTA_TEST_RUN_BEGINNING = "    Test Suite 'KIFTests.xctest' started at 2014-02-28 15:43:42 +0000"
 SAMPLE_OCUNIT_TEST_RUN_COMPLETION = "Test Suite '/Users/musalj/Library/Developer/Xcode/DerivedData/ReactiveCocoa-eznxkbqvgfsnrvetemqloysuwagb/Build/Products/Test/ReactiveCocoaTests.octest(Tests)' finished at 2013-12-10 07:03:03 +0000."
+SAMPLE_OCUNIT_FAILED_TEST_RUN_COMPLETION = "Test Suite '/Users/dm/someplace/Macadamia.octest' failed at 2014-09-24 23:09:20 +0000."
+SAMPLE_OCUNIT_PASSED_TEST_RUN_COMPLETION = "Test Suite 'Hazelnuts.xctest' passed at 2014-09-24 23:09:20 +0000."
 SAMPLE_KIWI_TEST_RUN_COMPLETION = "Test Suite 'ObjectiveRecordTests.xctest' finished at 2013-12-10 06:15:42 +0000."
 SAMPLE_SPECTA_TEST_RUN_COMPLETION = "     Test Suite 'KIFTests.xctest' finished at 2014-02-28 15:44:32 +0000."
@@ -544,3 +546,5 @@ SAMPLE_LD_LIBRARY_ERROR = 'ld: library not found for -lPods-Yammer'
 SAMPLE_CLANG_ERROR = 'clang: error: linker command failed with exit code 1 (use -v to see invocation)'
+SAMPLE_SCREENSHOT_FILE = 'RACCommandSpec, line 80, hello xcpretty.png'
+SAMPLE_UNRELATED_IMAGE_FILE = 'apple_raw.png'

data/spec/xcpretty/parser_spec.rb CHANGED Viewed

@@ -211,13 +211,21 @@ module XCPretty
       end
     end
     it "parses ocunit test run finished" do
       @formatter.should receive(:format_test_run_finished).with('ReactiveCocoaTests.octest(Tests)', '2013-12-10 07:03:03 +0000.')
       @parser.parse(SAMPLE_OCUNIT_TEST_RUN_COMPLETION)
     end
+    it "parses ocunit test run passed" do
+      @formatter.should receive(:format_test_run_finished).with('Hazelnuts.xctest', '2014-09-24 23:09:20 +0000.')
+      @parser.parse(SAMPLE_OCUNIT_PASSED_TEST_RUN_COMPLETION)
+    end
+    it "parses ocunit test run failed" do
+      @formatter.should receive(:format_test_run_finished).with('Macadamia.octest', '2014-09-24 23:09:20 +0000.')
+      @parser.parse(SAMPLE_OCUNIT_FAILED_TEST_RUN_COMPLETION)
+    end
     it "parses specta test run finished" do
       @formatter.should receive(:format_test_run_finished).with('KIFTests.xctest', '2014-02-28 15:44:32 +0000.')
       @parser.parse(SAMPLE_SPECTA_TEST_RUN_COMPLETION)

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xcpretty
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Marin Usalj
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-06-03 00:00:00.000000000 Z
+date: 2014-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -89,6 +89,8 @@ files:
 - Rakefile
 - assets/report.html.erb
 - bin/xcpretty
+- features/assets/RACCommandSpec, line 80, hello xcpretty.png
+- features/assets/apple_raw.png
 - features/custom_formatter.feature
 - features/fixtures/xcodebuild.log
 - features/html_report.feature
@@ -163,11 +165,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key:
 specification_version: 4
 summary: xcodebuild formatter done right
 test_files:
+- features/assets/RACCommandSpec, line 80, hello xcpretty.png
+- features/assets/apple_raw.png
 - features/custom_formatter.feature
 - features/fixtures/xcodebuild.log
 - features/html_report.feature
@@ -202,4 +206,3 @@ test_files:
 - spec/xcpretty/printer_spec.rb
 - spec/xcpretty/snippet_spec.rb
 - spec/xcpretty/syntax_spec.rb
-has_rdoc: