danger-ikr-xcode_summary 1.2.0

data/spec/fixtures/swiftlint.xcresult/Info.plist

@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>dateCreated</key>
+	<date>2019-09-27T03:04:10Z</date>
+	<key>externalLocations</key>
+	<array/>
+	<key>rootId</key>
+	<dict>
+		<key>hash</key>
+		<string>0~aBrGz65aeXPVqACvo49xELHeqBawlmly6M_SmRa-iT99yzTiBp2st43mhwZEOVIgvsBEHLkKbH5oQpqjWgkueA==</string>
+	</dict>
+	<key>storage</key>
+	<dict>
+		<key>backend</key>
+		<string>fileBacked2</string>
+		<key>compression</key>
+		<string>standard</string>
+	</dict>
+	<key>version</key>
+	<dict>
+		<key>major</key>
+		<integer>3</integer>
+		<key>minor</key>
+		<integer>21</integer>
+	</dict>
+</dict>
+</plist>

data/spec/spec_helper.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require 'pathname'
+ROOT = Pathname.new(File.expand_path('..', __dir__))
+$LOAD_PATH.unshift("#{ROOT}lib".to_s)
+$LOAD_PATH.unshift("#{ROOT}spec".to_s)
+
+require 'bundler/setup'
+require 'pry'
+
+require 'rspec'
+require 'danger'
+
+require 'danger_plugin'
+
+# Use coloured output, it's the best.
+RSpec.configure do |config|
+  config.filter_gems_from_backtrace 'bundler'
+  config.color = true
+  config.tty = true
+  config.expect_with :rspec do |c|
+    c.max_formatted_output_length = nil # n is number of lines, or nil for no truncation.
+  end
+end
+
+# These functions are a subset of https://github.com/danger/danger/blob/master/spec/spec_helper.rb
+# If you are expanding these files, see if it's already been done ^.
+
+# A silent version of the user interface,
+# it comes with an extra function `.string` which will
+# strip all ANSI colours from the string.
+
+# rubocop:disable Lint/NestedMethodDefinition
+def testing_ui
+  @output = StringIO.new
+  def @output.winsize
+    [20, 9999]
+  end
+
+  cork = Cork::Board.new(out: @output)
+  def cork.string
+    out.string.gsub(/\e\[([;\d]+)?m/, '')
+  end
+  cork
+end
+# rubocop:enable Lint/NestedMethodDefinition
+
+# Example environment (ENV) that would come from
+# running a PR on TravisCI
+def testing_env
+  {
+    'HAS_JOSH_K_SEAL_OF_APPROVAL' => 'true',
+    'TRAVIS_PULL_REQUEST' => '800',
+    'TRAVIS_REPO_SLUG' => 'artsy/eigen',
+    'TRAVIS_COMMIT_RANGE' => '759adcbd0d8f...13c4dc8bb61d',
+    'DANGER_GITHUB_API_TOKEN' => '123sbdq54erfsd3422gdfio'
+  }
+end
+
+def testing_bitbucket_env
+  {
+    'GIT_URL' => 'https://github.com/diogot/danger-xcode_summary.git',
+    'CHANGE_ID' => '4d4c0f31857e3185b51b6865a0700525bc0cb2bb',
+    'JENKINS_URL' => 'http://jenkins.server.com/',
+    'DANGER_BITBUCKETCLOUD_USERNAME' => 'username',
+    'DANGER_BITBUCKETCLOUD_PASSWORD' => 'password',
+    'DANGER_BITBUCKETCLOUD_UUID' => 'c91be865-efc6-49a6-93c5-24e1267c479b',
+    'ghprbPullId' => '2080'
+  }
+end
+
+# A stubbed out Dangerfile for use in tests
+def testing_dangerfile
+  env = Danger::EnvironmentManager.new(testing_env)
+  Danger::Dangerfile.new(env, testing_ui)
+end
+
+# A stubbed out Dangerfile with Bitbucket as a request_source for use in tests
+def testing_bitbucket_dangerfile
+  env = Danger::EnvironmentManager.new(testing_bitbucket_env)
+  Danger::Dangerfile.new(env, testing_ui)
+end

data/spec/xcode_summary_spec.rb

@@ -0,0 +1,213 @@
+# frozen_string_literal: true
+
+# rubocop:disable Layout/LineLength
+
+require File.expand_path('spec_helper', __dir__)
+
+module Danger
+  describe Danger::DangerXcodeSummary do
+    it 'should be a plugin' do
+      expect(Danger::DangerXcodeSummary.new(nil)).to be_a Danger::Plugin
+    end
+
+    describe 'with Dangerfile' do
+      before do
+        @dangerfile = testing_dangerfile
+        @xcode_summary = @dangerfile.xcode_summary
+        @xcode_summary.env.request_source.pr_json = JSON.parse(File.read('spec/fixtures/pr_json.json'))
+        @xcode_summary.project_root = '/Users/marcelofabri/SwiftLint/'
+      end
+
+      it 'fail if file does not exist' do
+        @xcode_summary.report('spec/fixtures/inexistent_file.xcresult')
+        expect(@dangerfile.status_report[:errors]).to eq ['summary file not found']
+      end
+
+      context 'reporting' do
+        it 'formats compile warnings' do
+          @xcode_summary.report('spec/fixtures/swiftlint.xcresult')
+          expect(@dangerfile.status_report[:warnings]).to eq [
+            "**<a href='https://github.com/realm/SwiftLint/blob/f211694e7def13785ff62047386437534541d7b3/Carthage/Checkouts/Yams/Sources/Yams/Tag.swift#L88'>Carthage/Checkouts/Yams/Sources/Yams/Tag.swift#L88</a>**: Legacy Hashing Violation: Prefer using the `hash(into:)` function instead of overriding `hashValue` (legacy_hashing)",
+            "**<a href='https://github.com/realm/SwiftLint/blob/f211694e7def13785ff62047386437534541d7b3/Carthage/Checkouts/Yams/Sources/Yams/Tag.swift#L109'>Carthage/Checkouts/Yams/Sources/Yams/Tag.swift#L109</a>**: Legacy Hashing Violation: Prefer using the `hash(into:)` function instead of overriding `hashValue` (legacy_hashing)",
+            "**<a href='https://github.com/realm/SwiftLint/blob/f211694e7def13785ff62047386437534541d7b3/Carthage/Checkouts/Yams/Sources/Yams/Decoder.swift#L102'>Carthage/Checkouts/Yams/Sources/Yams/Decoder.swift#L102</a>**: Colon Violation: Colons should be next to the identifier when specifying a type and next to the key in dictionary literals. (colon)",
+            "**<a href='https://github.com/realm/SwiftLint/blob/f211694e7def13785ff62047386437534541d7b3/Carthage/Checkouts/Yams/Sources/Yams/Node.swift#L191'>Carthage/Checkouts/Yams/Sources/Yams/Node.swift#L191</a>**: Legacy Hashing Violation: Prefer using the `hash(into:)` function instead of overriding `hashValue` (legacy_hashing)",
+            "**<a href='https://github.com/realm/SwiftLint/blob/f211694e7def13785ff62047386437534541d7b3/Carthage/Checkouts/Yams/Sources/Yams/Representer.swift#L187'>Carthage/Checkouts/Yams/Sources/Yams/Representer.swift#L187</a>**: Todo Violation: TODOs should be resolved (Support `Float80`). (todo)",
+            "**<a href='https://github.com/realm/SwiftLint/blob/f211694e7def13785ff62047386437534541d7b3/Carthage/Checkouts/Yams/Sources/Yams/Encoder.swift#L139'>Carthage/Checkouts/Yams/Sources/Yams/Encoder.swift#L139</a>**: Colon Violation: Colons should be next to the identifier when specifying a type and next to the key in dictionary literals. (colon)",
+            "**<a href='https://github.com/realm/SwiftLint/blob/f211694e7def13785ff62047386437534541d7b3/Carthage/Checkouts/Yams/Sources/Yams/Parser.swift#L441'>Carthage/Checkouts/Yams/Sources/Yams/Parser.swift#L441</a>**: File Line Length Violation: File should contain 400 lines or less: currently contains 441 (file_length)",
+            "**<a href='https://github.com/realm/SwiftLint/blob/f211694e7def13785ff62047386437534541d7b3/Carthage/Checkouts/Yams/Sources/Yams/Constructor.swift#L405'>Carthage/Checkouts/Yams/Sources/Yams/Constructor.swift#L405</a>**: Todo Violation: TODOs should be resolved (YAML supports keys other than ...). (todo)",
+            "**<a href='https://github.com/realm/SwiftLint/blob/f211694e7def13785ff62047386437534541d7b3/Carthage/Checkouts/Yams/Sources/Yams/Constructor.swift#L430'>Carthage/Checkouts/Yams/Sources/Yams/Constructor.swift#L430</a>**: Todo Violation: TODOs should be resolved (Should raise error on other th...). (todo)",
+            "**<a href='https://github.com/realm/SwiftLint/blob/f211694e7def13785ff62047386437534541d7b3/Carthage/Checkouts/Yams/Sources/Yams/Constructor.swift#L450'>Carthage/Checkouts/Yams/Sources/Yams/Constructor.swift#L450</a>**: Todo Violation: TODOs should be resolved (YAML supports Hashable element...). (todo)",
+            "**<a href='https://github.com/realm/SwiftLint/blob/f211694e7def13785ff62047386437534541d7b3/Carthage/Checkouts/Yams/Sources/Yams/Constructor.swift#L478'>Carthage/Checkouts/Yams/Sources/Yams/Constructor.swift#L478</a>**: Todo Violation: TODOs should be resolved (Should raise error if subnode ...). (todo)",
+            "**<a href='https://github.com/realm/SwiftLint/blob/f211694e7def13785ff62047386437534541d7b3/Carthage/Checkouts/Yams/Sources/Yams/Constructor.swift#L492'>Carthage/Checkouts/Yams/Sources/Yams/Constructor.swift#L492</a>**: Todo Violation: TODOs should be resolved (Should raise error if subnode ...). (todo)",
+            "**<a href='https://github.com/realm/SwiftLint/blob/f211694e7def13785ff62047386437534541d7b3/Carthage/Checkouts/Yams/Sources/Yams/Emitter.swift#L340'>Carthage/Checkouts/Yams/Sources/Yams/Emitter.swift#L340</a>**: Todo Violation: TODOs should be resolved (Support tags). (todo)",
+            "**<a href='https://github.com/realm/SwiftLint/blob/f211694e7def13785ff62047386437534541d7b3/Carthage/Checkouts/Yams/Tests/YamsTests/SpecTests.swift#L379'>Carthage/Checkouts/Yams/Tests/YamsTests/SpecTests.swift#L379</a>**: Todo Violation: TODOs should be resolved (YAML supports keys other than ...). (todo)",
+            "**<a href='https://github.com/realm/SwiftLint/blob/f211694e7def13785ff62047386437534541d7b3/Carthage/Checkouts/Yams/Tests/YamsTests/SpecTests.swift#L714'>Carthage/Checkouts/Yams/Tests/YamsTests/SpecTests.swift#L714</a>**: Todo Violation: TODOs should be resolved (local tag parsing). (todo)",
+            "**<a href='https://github.com/realm/SwiftLint/blob/f211694e7def13785ff62047386437534541d7b3/Carthage/Checkouts/Yams/Tests/YamsTests/EncoderTests.swift#L924'>Carthage/Checkouts/Yams/Tests/YamsTests/EncoderTests.swift#L924</a>**: Colon Violation: Colons should be next to the identifier when specifying a type and next to the key in dictionary literals. (colon)",
+            "**<a href='https://github.com/realm/SwiftLint/blob/f211694e7def13785ff62047386437534541d7b3/Carthage/Checkouts/Yams/Tests/YamsTests/EncoderTests.swift#L937'>Carthage/Checkouts/Yams/Tests/YamsTests/EncoderTests.swift#L937</a>**: Colon Violation: Colons should be next to the identifier when specifying a type and next to the key in dictionary literals. (colon)",
+            "**<a href='https://github.com/realm/SwiftLint/blob/f211694e7def13785ff62047386437534541d7b3/Carthage/Checkouts/Yams/Tests/YamsTests/EncoderTests.swift#L253'>Carthage/Checkouts/Yams/Tests/YamsTests/EncoderTests.swift#L253</a>**: Superfluous Disable Command Violation: 'unused_private_declaration' is not a valid SwiftLint rule. Please remove it from the disable command. (superfluous_disable_command)",
+            "**<a href='https://github.com/realm/SwiftLint/blob/f211694e7def13785ff62047386437534541d7b3/Carthage/Checkouts/SWXMLHash/Source/XMLIndexer+XMLIndexerDeserializable.swift#L538'>Carthage/Checkouts/SWXMLHash/Source/XMLIndexer+XMLIndexerDeserializable.swift#L538</a>**: 'public' modifier is redundant for instance method declared in a public extension",
+            "**<a href='https://github.com/realm/SwiftLint/blob/f211694e7def13785ff62047386437534541d7b3/Carthage/Checkouts/SWXMLHash/Source/XMLIndexer+XMLIndexerDeserializable.swift#L552'>Carthage/Checkouts/SWXMLHash/Source/XMLIndexer+XMLIndexerDeserializable.swift#L552</a>**: 'public' modifier is redundant for instance method declared in a public extension",
+            "**<a href='https://github.com/realm/SwiftLint/blob/f211694e7def13785ff62047386437534541d7b3/Carthage/Checkouts/Result/Result/NoError.swift#L8'>Carthage/Checkouts/Result/Result/NoError.swift#L8</a>**: Will never be executed"
+          ]
+        end
+
+        it 'ignores file when ignored_files matches' do
+          @xcode_summary.ignored_files = 'Carthage/**/Yams/**'
+          @xcode_summary.report('spec/fixtures/swiftlint.xcresult')
+          expect(@dangerfile.status_report[:warnings]).to eq [
+            "**<a href='https://github.com/realm/SwiftLint/blob/f211694e7def13785ff62047386437534541d7b3/Carthage/Checkouts/SWXMLHash/Source/XMLIndexer+XMLIndexerDeserializable.swift#L538'>Carthage/Checkouts/SWXMLHash/Source/XMLIndexer+XMLIndexerDeserializable.swift#L538</a>**: 'public' modifier is redundant for instance method declared in a public extension",
+            "**<a href='https://github.com/realm/SwiftLint/blob/f211694e7def13785ff62047386437534541d7b3/Carthage/Checkouts/SWXMLHash/Source/XMLIndexer+XMLIndexerDeserializable.swift#L552'>Carthage/Checkouts/SWXMLHash/Source/XMLIndexer+XMLIndexerDeserializable.swift#L552</a>**: 'public' modifier is redundant for instance method declared in a public extension",
+            "**<a href='https://github.com/realm/SwiftLint/blob/f211694e7def13785ff62047386437534541d7b3/Carthage/Checkouts/Result/Result/NoError.swift#L8'>Carthage/Checkouts/Result/Result/NoError.swift#L8</a>**: Will never be executed"
+          ]
+        end
+
+        it 'ignores file when ignored_files is an array and matches' do
+          @xcode_summary.ignored_files = ['Carthage/**/Yams/**', 'Carthage/**/SWXMLHash/**']
+          @xcode_summary.report('spec/fixtures/swiftlint.xcresult')
+          expect(@dangerfile.status_report[:warnings]).to eq [
+            "**<a href='https://github.com/realm/SwiftLint/blob/f211694e7def13785ff62047386437534541d7b3/Carthage/Checkouts/Result/Result/NoError.swift#L8'>Carthage/Checkouts/Result/Result/NoError.swift#L8</a>**: Will never be executed"
+          ]
+        end
+
+        it 'formats test errors' do
+          @xcode_summary.report('spec/fixtures/swiftlint.xcresult')
+          expect(@dangerfile.status_report[:errors]).to eq [
+            "**SwiftLintFrameworkTests.ColonRuleTests.testColonWithoutApplyToDictionaries()**: XCTAssertEqual failed: (\"0\") is not equal to (\"1\")  <br />  <a href='https://github.com/realm/SwiftLint/blob/f211694e7def13785ff62047386437534541d7b3/Tests/SwiftLintFrameworkTests/TestHelpers.swift#L169'>Tests/SwiftLintFrameworkTests/TestHelpers.swift#L169</a>"
+          ]
+        end
+
+        it 'formats errors' do
+          @xcode_summary.report('spec/fixtures/build_error.xcresult')
+          expect(@dangerfile.status_report[:errors]).to eq [
+            'Testing cancelled because the build failed.',
+            "**<a href='https://github.com/realm/SwiftLint/blob/f211694e7def13785ff62047386437534541d7b3/Source/SwiftLintFramework/Extensions/QueuedPrint.swift#L13'>Source/SwiftLintFramework/Extensions/QueuedPrint.swift#L13</a>**: Use of unresolved identifier 'queue'",
+            "**<a href='https://github.com/realm/SwiftLint/blob/f211694e7def13785ff62047386437534541d7b3/Source/SwiftLintFramework/Extensions/QueuedPrint.swift#L17'>Source/SwiftLintFramework/Extensions/QueuedPrint.swift#L17</a>**: Use of unresolved identifier 'queue'"
+          ]
+        end
+
+        it 'report warning and error counts' do
+          result = @xcode_summary.warning_error_count('spec/fixtures/build_error.xcresult')
+          expect(result).to eq '{"warnings":21,"errors":3}'
+        end
+
+        context 'with inline_mode' do
+          before do
+            @xcode_summary.inline_mode = true
+          end
+
+          it 'asserts errors on the line' do
+            allow(@xcode_summary).to receive(:fail)
+            @xcode_summary.report('spec/fixtures/build_error.xcresult')
+            expect(@xcode_summary).to have_received(:fail).with(
+              instance_of(String),
+              sticky: false,
+              file: 'Source/SwiftLintFramework/Extensions/QueuedPrint.swift',
+              line: 13
+            )
+            expect(@xcode_summary).to have_received(:fail).with(
+              instance_of(String),
+              sticky: false,
+              file: 'Source/SwiftLintFramework/Extensions/QueuedPrint.swift',
+              line: 17
+            )
+            expect(@xcode_summary).to have_received(:fail).with(
+              'Testing cancelled because the build failed.',
+              sticky: false
+            )
+          end
+
+          it 'asserts warning on the line' do
+            allow(@xcode_summary).to receive(:warn)
+            @xcode_summary.report('spec/fixtures/swiftlint.xcresult')
+            expect(@xcode_summary).to have_received(:warn).with(
+              instance_of(String),
+              sticky: false,
+              file: 'Carthage/Checkouts/SWXMLHash/Source/XMLIndexer+XMLIndexerDeserializable.swift',
+              line: 538
+            )
+          end
+        end
+
+        context 'with ignores_warnings' do
+          before do
+            @xcode_summary.ignores_warnings = true
+          end
+
+          it 'shows no warnings' do
+            @xcode_summary.report('spec/fixtures/swiftlint.xcresult')
+            expect(@dangerfile.status_report[:warnings]).to eq []
+          end
+
+          it 'shows errors' do
+            @xcode_summary.report('spec/fixtures/build_error.xcresult')
+            expect(@dangerfile.status_report[:warnings]).to eq []
+            expect(@dangerfile.status_report[:errors].count).to_not eq 0
+          end
+
+          it 'reports warning and error counts with no warnings' do
+            result = @xcode_summary.warning_error_count('spec/fixtures/build_error.xcresult')
+            expect(result).to eq '{"warnings":0,"errors":3}'
+          end
+        end
+
+        context 'with ignored_results' do
+          before do
+            @xcode_summary.ignored_results do |result|
+              result.message.include?('public extension') || result.message.include?('unresolved')
+            end
+          end
+
+          it 'asserts no errors' do
+            @xcode_summary.report('spec/fixtures/build_error.xcresult')
+            expect(@dangerfile.status_report[:errors].count).to eq 1
+          end
+
+          it 'asserts no warnings' do
+            @xcode_summary.report('spec/fixtures/swiftlint.xcresult')
+            expect(@dangerfile.status_report[:warnings].count).to eq 19
+          end
+
+          it 'report warning and error counts' do
+            result = @xcode_summary.warning_error_count('spec/fixtures/build_error.xcresult')
+            expect(result).to eq '{"warnings":19,"errors":1}'
+          end
+        end
+
+        context 'without strict' do
+          before do
+            @xcode_summary.strict = false
+          end
+
+          it 'shows errors as warnings' do
+            @xcode_summary.report('spec/fixtures/build_error.xcresult')
+            expect(@dangerfile.status_report[:warnings].count).to_not eq 0
+            expect(@dangerfile.status_report[:errors]).to eq []
+          end
+
+          it 'report warning and error counts' do
+            result = @xcode_summary.warning_error_count('spec/fixtures/build_error.xcresult')
+            expect(result).to eq '{"warnings":21,"errors":3}'
+          end
+        end
+      end
+    end
+
+    # Second environment with different request_source
+    describe 'with bitbucket request_source' do
+      before do
+        @dangerfile = testing_bitbucket_dangerfile
+        @xcode_summary = @dangerfile.xcode_summary
+        @xcode_summary.env.request_source.pr_json = JSON.parse(File.read('spec/fixtures/bitbucket_pr.json'), symbolize_names: true)
+        @xcode_summary.project_root = '/Users/diogo/src/danger-xcode_summary'
+      end
+
+      describe 'where request source' do
+        it 'should be bitbucket' do
+          path = @xcode_summary.send(:format_path, 'lib/xcode_summary/plugin.rb', 3)
+          expect(path).to eq 'lib/xcode_summary/plugin.rb'
+        end
+      end
+    end
+  end
+end
+# rubocop:enable Layout/LineLength