Merge pull request #5 from WeTransfer/feature/better-reporting

Reporting no longer breaks tests

Author: AvdLee

.travis.yml

@@ -1,9 +1,7 @@
 language: objective-c
-osx_image: xcode8.3
+osx_image: xcode9.2
 script:
-    - xcodebuild clean -project Mocker.xcodeproj -scheme Mocker | xcpretty
-    - xcodebuild test -project Mocker.xcodeproj -scheme Mocker -destination 'platform=iOS Simulator,name=iPhone 7,OS=10.3.1' -enableCodeCoverage YES | xcpretty -f `xcpretty-json-formatter`
-    - bundle exec danger
+    - bundle exec fastlane test
 before_install:
   - brew outdated swiftlint || brew upgrade swiftlint
   - bundle install

Gemfile

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 source "https://rubygems.org"
 
+gem 'fastlane'
 gem 'danger'
-gem 'danger-swiftlint', '0.9.0'
+gem 'danger-swiftlint', '0.12.1'
 gem 'danger-xcov'
 gem 'danger-xcodebuild'
 gem 'danger-xcode_summary'
+gem 'xcpretty'
 gem 'xcpretty-json-formatter'

Mocker.xcodeproj/project.pbxproj

@@ -141,7 +141,7 @@
 				501E26901F3DAE370048F39E /* Frameworks */,
 				501E26911F3DAE370048F39E /* Headers */,
 				501E26921F3DAE370048F39E /* Resources */,
-				503446441F3DE70C0039D5E4 /* ShellScript */,
+				503446441F3DE70C0039D5E4 /* SwiftLint */,
 			);
 			buildRules = (
 			);
@@ -231,18 +231,19 @@
 /* End PBXResourcesBuildPhase section */
 
 /* Begin PBXShellScriptBuildPhase section */
-		503446441F3DE70C0039D5E4 /* ShellScript */ = {
+		503446441F3DE70C0039D5E4 /* SwiftLint */ = {
 			isa = PBXShellScriptBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
 			);
 			inputPaths = (
 			);
+			name = SwiftLint;
 			outputPaths = (
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 			shellPath = /bin/sh;
-			shellScript = "if which swiftlint >/dev/null; then\nswiftlint lint --config \".swiftlint.yml\"\nelse\necho \"warning: SwiftLint not installed, download from https://github.com/realm/SwiftLint\"\nfi\n";
+			shellScript = "if which swiftlint >/dev/null; then\n    swiftlint lint --config \".swiftlint.yml\"\nelse\n    echo \"warning: SwiftLint not installed, download from https://github.com/realm/SwiftLint\"\nfi\n\n";
 		};
 /* End PBXShellScriptBuildPhase section */
 
@@ -439,7 +440,6 @@
 				LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks";
 				PRODUCT_BUNDLE_IDENTIFIER = com.wetransfer.MockerTests;
 				PRODUCT_NAME = "$(TARGET_NAME)";
-				SWIFT_SWIFT3_OBJC_INFERENCE = On;
 			};
 			name = Debug;
 		};
@@ -452,7 +452,6 @@
 				LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks";
 				PRODUCT_BUNDLE_IDENTIFIER = com.wetransfer.MockerTests;
 				PRODUCT_NAME = "$(TARGET_NAME)";
-				SWIFT_SWIFT3_OBJC_INFERENCE = On;
 			};
 			name = Release;
 		};

Sources/MockingURLProtocol.swift

@@ -10,15 +10,21 @@ import Foundation
 
 /// The protocol which can be used to send Mocked data back. Use the `Mocker` to register `Mock` data
 public final class MockingURLProtocol: URLProtocol {
-    
+
+    enum MockingURLProtocolError: Swift.Error {
+        case missingMockedData(url: String)
+    }
+
     /// Returns Mocked data based on the mocks register in the `Mocker`. Will end up in an error when no Mock data is found for the request.
     public override func startLoading() {
         guard
             let mock = Mocker.mock(for: request),
             let response = HTTPURLResponse(url: mock.url, statusCode: mock.statusCode, httpVersion: Mocker.httpVersion.rawValue, headerFields: mock.headers),
             let data = mock.data(for: request)
         else {
-            fatalError("No mocked data found for url \(String(describing: request.url?.absoluteString)) method \(String(describing: request.httpMethod)). Did you forget to use `register()`?")
+            print("\n\n 🚨 No mocked data found for url \(String(describing: request.url?.absoluteString)) method \(String(describing: request.httpMethod)). Did you forget to use `register()`? 🚨 \n\n")
+            client?.urlProtocol(self, didFailWithError: MockingURLProtocolError.missingMockedData(url: String(describing: request.url?.absoluteString)))
+            return
         }
 
         DispatchQueue.global(qos: DispatchQoS.QoSClass.background).asyncAfter(deadline: .now() + (mock.delay ?? DispatchTimeInterval.seconds(0))) {

danger/shared/Dangerfile

@@ -8,7 +8,7 @@ end
 
 def lineIsPropertyMethodClassOrStruct(line)
 	if line.include?("var") or line.include?("let") or line.include?("func") or line.include?("class") or line.include?("struct")
-		if line.include?("guard") or line.include?("==")
+		if line.include?("guard")
 			return false
 		end
 		return true
@@ -23,6 +23,15 @@ def lineIncludesDocumentComment(line)
 	return false
 end
 
+def lineRequiresDocumentation(line)
+	if line.include?("override") or line.include?("==")
+		# Overrides will use documentation of the original method. Operators don't need documentation.
+		return false
+	end
+
+	return true
+end
+
 # Make it more obvious that a PR is a work in progress and shouldn't be merged yet.
 has_wip_label = github.pr_labels.any? { |label| label.include? "WIP" }
 has_wip_title = github.pr_title.include? "[WIP]"
@@ -35,24 +44,29 @@ end
 warn("Big PR") if git.lines_of_code > 500
 
 # Check for warnings
-xcodebuild.json_file = "build/reports/errors.json"
-xcodebuild.post_messages = false
-number_of_warnings = xcodebuild.parse_warnings
+json_file = "build/reports/errors.json"
+if File.file?(json_file)
+	xcodebuild.json_file = json_file
+	xcodebuild.post_messages = false
+	number_of_warnings = xcodebuild.parse_warnings
+
+	if number_of_warnings > 0
+	 warn("The project still contains #{number_of_warnings} warnings 😱")
+	end
 
-if number_of_warnings > 0
- warn("The project still contains #{number_of_warnings} warnings 😱")
+	xcode_summary.ignored_files = 'Submodules/**'
+	xcode_summary.inline_mode = true
+	xcode_summary.report 'build/reports/errors.json'
 end
 
-xcode_summary.inline_mode = true
-xcode_summary.report 'build/reports/errors.json'
-
-
 # Check to see if any of our project files contains a line with "SOURCE_ROOT" which indicates that the file isn't in sync with Finder.
 ["Mocker.xcodeproj/project.pbxproj"].each do |project_file|
  	next unless File.file?(project_file)
 	File.readlines(project_file).each_with_index do |line, index|
 		# The folder Resources is a folder references for sharing resources for testing. Don't warn for that folder.
-		if line.include?("sourceTree = SOURCE_ROOT;") and line.include?("PBXFileReference") and line.include?("name = Resources") == false
+		files_to_ignore = ["Resources", "Toucan.swift"]
+		line_should_be_ignored = files_to_ignore.map { |name| "name = " + name }.any? { |file_to_ignore| line.include?(file_to_ignore) }
+		if line.include?("sourceTree = SOURCE_ROOT;") and line.include?("PBXFileReference") and !line_should_be_ignored
 			warn("Files should be in sync with project structure", file: project_file, line: index+1) 
 		end
 	end
@@ -81,7 +95,10 @@ files_to_check = (git.modified_files + git.added_files).uniq
 	next unless File.file?(file)
 	# Only check for classes inside swift files
 	next unless File.extname(file).include?(".swift")
-  	
+
+	# Determine if we're in a test file
+  	isTestFile = File.basename(file, ".*" ).downcase.include?("test")
+
   	# Will be used to check if we're inside a comment block.
 	isCommentBlock = false
 
@@ -125,14 +142,14 @@ files_to_check = (git.modified_files + git.added_files).uniq
 			end
 
 			## Check for public properties which aren't commented
-			if disabled_rules.include?("public_docs") == false and lineContainsPublicPropertyMethodClassOrStruct(line) && lineIncludesDocumentComment(filelines[index-1]) == false
+			if disabled_rules.include?("public_docs") == false and lineContainsPublicPropertyMethodClassOrStruct(line) && lineIncludesDocumentComment(filelines[index-1]) == false && lineRequiresDocumentation(line)
 				warn("Public properties, methods, classes or structs should be documented. Make use of `///` or `/* */` so it will show up inside the docs. (public_docs)", file: file, line: index+1) 
 			end
 		end 
 	end
 
 	## Check wether our file is larger than 200 lines and doesn't include any Marks
-	if filelines.count > 200 and foundMark == false 
-		warn("Consider to place some `MARK:` lines for files over 200 lines big.")
+	if filelines.count > 200 and foundMark == false and isTestFile == false
+		warn("Consider to place some `MARK:` lines for #{file}, which is over 200 lines big.")
 	end
 end

fastlane/.gitignore

@@ -0,0 +1,4 @@
+installer/
+test_output/
+README.md
+report.xml

fastlane/Fastfile

@@ -0,0 +1,21 @@
+# Fastlane requirements
+fastlane_version "1.109.0"
+generated_fastfile_id "0121e253-f9e2-40ac-b489-f17f36e24ec6"
+
+default_platform :ios
+
+desc "Run tests and Danger"
+lane :test do
+  clear_derived_data
+
+  scan(
+    scheme: "Mocker",
+    project: "Mocker.xcodeproj",
+    skip_slack: true,
+    device: "iPhone 7",
+    clean: true,
+    code_coverage: true,
+    formatter: "xcpretty-json-formatter")
+
+  danger
+end