├── .github ├── FUNDING.yml └── workflows │ └── main.yml ├── .gitignore ├── .pre-commit-config.yaml ├── .swiftformat ├── .swiftlint.yml ├── .vscode ├── settings.json └── tasks.json ├── Brewfile ├── LICENSE ├── Package.resolved ├── Package.swift ├── README.md ├── Sources └── XCTestJSONObserver │ └── JSONObserver.swift ├── Tests └── JSONObserverTests │ ├── Equatable.swift │ └── PropertyTests.swift └── xcode_test.sh /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | 3 | github: MaxDesiatov # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] 4 | patreon: # Replace with a single Patreon username 5 | open_collective: # Replace with a single Open Collective username 6 | ko_fi: # Replace with a single Ko-fi username 7 | tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel 8 | community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry 9 | liberapay: # Replace with a single Liberapay username 10 | issuehunt: # Replace with a single IssueHunt username 11 | otechie: # Replace with a single Otechie username 12 | custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] 13 | -------------------------------------------------------------------------------- /.github/workflows/main.yml: -------------------------------------------------------------------------------- 1 | # This is a basic workflow to help you get started with Actions 2 | 3 | name: CI 4 | 5 | # Controls when the action will run. Triggers the workflow on push or pull request 6 | # events but only for the master branch 7 | on: 8 | push: 9 | branches: [main] 10 | pull_request: 11 | branches: [main] 12 | 13 | # A workflow run is made up of one or more jobs that can run sequentially or in parallel 14 | jobs: 15 | xcode-11_4: 16 | runs-on: macos-latest 17 | 18 | steps: 19 | - uses: actions/checkout@v2 20 | 21 | - name: Test with Xcode 11.4 22 | run: ./xcode_test.sh Xcode_11.4.1 23 | 24 | xcode-11_5: 25 | runs-on: macos-latest 26 | 27 | steps: 28 | - uses: actions/checkout@v2 29 | 30 | - name: Test with Xcode 11.5 31 | run: ./xcode_test.sh Xcode_11.5 32 | 33 | linux-5_2: 34 | runs-on: ubuntu-latest 35 | 36 | steps: 37 | - uses: actions/checkout@v2 38 | 39 | - name: Test on Linux with Swift 5.2 40 | uses: Didstopia/SwiftAction@v1.0.2 41 | with: 42 | swift-action: test --enable-test-discovery 43 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Xcode 2 | # 3 | # gitignore contributors: remember to update Global/Xcode.gitignore, Objective-C.gitignore & Swift.gitignore 4 | 5 | ## User settings 6 | xcuserdata/ 7 | 8 | ## compatibility with Xcode 8 and earlier (ignoring not required starting Xcode 9) 9 | *.xcscmblueprint 10 | *.xccheckout 11 | 12 | ## compatibility with Xcode 3 and earlier (ignoring not required starting Xcode 4) 13 | build/ 14 | DerivedData/ 15 | *.moved-aside 16 | *.pbxuser 17 | !default.pbxuser 18 | *.mode1v3 19 | !default.mode1v3 20 | *.mode2v3 21 | !default.mode2v3 22 | *.perspectivev3 23 | !default.perspectivev3 24 | 25 | ## Obj-C/Swift specific 26 | *.hmap 27 | 28 | ## App packaging 29 | *.ipa 30 | *.dSYM.zip 31 | *.dSYM 32 | 33 | ## Playgrounds 34 | timeline.xctimeline 35 | playground.xcworkspace 36 | 37 | # Swift Package Manager 38 | # 39 | # Add this line if you want to avoid checking in source code from Swift Package Manager dependencies. 40 | # Packages/ 41 | # Package.pins 42 | # Package.resolved 43 | # *.xcodeproj 44 | # 45 | # Xcode automatically generates this directory with a .xcworkspacedata file and xcuserdata 46 | # hence it is not needed unless you have added a package configuration file to your project 47 | # .swiftpm 48 | 49 | .build/ 50 | 51 | # CocoaPods 52 | # 53 | # We recommend against adding the Pods directory to your .gitignore. However 54 | # you should judge for yourself, the pros and cons are mentioned at: 55 | # https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control 56 | # 57 | # Pods/ 58 | # 59 | # Add this line if you want to avoid checking in source code from the Xcode workspace 60 | # *.xcworkspace 61 | 62 | # Carthage 63 | # 64 | # Add this line if you want to avoid checking in source code from Carthage dependencies. 65 | # Carthage/Checkouts 66 | 67 | Carthage/Build/ 68 | 69 | # Accio dependency management 70 | Dependencies/ 71 | .accio/ 72 | 73 | # fastlane 74 | # 75 | # It is recommended to not store the screenshots in the git repo. 76 | # Instead, use fastlane to re-generate the screenshots whenever they are needed. 77 | # For more information about the recommended setup visit: 78 | # https://docs.fastlane.tools/best-practices/source-control/#source-control 79 | 80 | fastlane/report.xml 81 | fastlane/Preview.html 82 | fastlane/screenshots/**/*.png 83 | fastlane/test_output 84 | 85 | # Code Injection 86 | # 87 | # After new code Injection tools there's a generated folder /iOSInjectionProject 88 | # https://github.com/johnno1962/injectionforxcode 89 | 90 | iOSInjectionProject/ 91 | -------------------------------------------------------------------------------- /.pre-commit-config.yaml: -------------------------------------------------------------------------------- 1 | # See https://pre-commit.com for more information 2 | # See https://pre-commit.com/hooks.html for more hooks 3 | repos: 4 | - repo: https://github.com/pre-commit/pre-commit-hooks 5 | rev: v2.5.0 6 | hooks: 7 | - id: trailing-whitespace 8 | - id: end-of-file-fixer 9 | exclude: __Snapshots__ 10 | - id: check-yaml 11 | - id: check-added-large-files 12 | - id: detect-private-key 13 | - id: check-merge-conflict 14 | - repo: https://github.com/hodovani/pre-commit-swift 15 | rev: master 16 | hooks: 17 | - id: swift-lint 18 | - id: swift-format 19 | -------------------------------------------------------------------------------- /.swiftformat: -------------------------------------------------------------------------------- 1 | --indent 4 2 | --indentcase false 3 | --trimwhitespace always 4 | --ranges nospace 5 | --empty tuple 6 | --operatorfunc nospace 7 | --ifdef noindent 8 | --stripunusedargs closure-only 9 | --disable andOperator 10 | --swiftversion 5.2 11 | -------------------------------------------------------------------------------- /.swiftlint.yml: -------------------------------------------------------------------------------- 1 | disabled_rules: 2 | - trailing_comma 3 | - identifier_name 4 | - void_return 5 | - operator_whitespace 6 | - nesting 7 | - cyclomatic_complexity 8 | 9 | line_length: 100 10 | 11 | function_body_length: 12 | - 50 13 | 14 | included: 15 | - Sources 16 | - Tests 17 | -------------------------------------------------------------------------------- /.vscode/settings.json: -------------------------------------------------------------------------------- 1 | { 2 | "licenser.author": "XCTestJSONObserver contributors", 3 | "editor.tabSize": 4, 4 | "editor.detectIndentation": false, 5 | "editor.formatOnSave": true 6 | } 7 | -------------------------------------------------------------------------------- /.vscode/tasks.json: -------------------------------------------------------------------------------- 1 | { 2 | // See https://go.microsoft.com/fwlink/?LinkId=733558 3 | // for the documentation about the tasks.json format 4 | "version": "2.0.0", 5 | "tasks": [ 6 | { 7 | "label": "swift build", 8 | "type": "shell", 9 | "command": "swift build" 10 | }, 11 | { 12 | "label": "swift test", 13 | "type": "shell", 14 | "command": "swift test --enable-test-discovery" 15 | } 16 | ] 17 | } 18 | -------------------------------------------------------------------------------- /Brewfile: -------------------------------------------------------------------------------- 1 | brew "pre-commit" 2 | brew "swiftformat" 3 | brew "swiftlint" 4 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /Package.resolved: -------------------------------------------------------------------------------- 1 | { 2 | "object": { 3 | "pins": [ 4 | { 5 | "package": "Chalk", 6 | "repositoryURL": "https://github.com/mxcl/Chalk.git", 7 | "state": { 8 | "branch": null, 9 | "revision": "9aa9f348b86db3cf6702a3e43c081ecec80cf3c7", 10 | "version": "0.4.0" 11 | } 12 | }, 13 | { 14 | "package": "FileCheck", 15 | "repositoryURL": "https://github.com/llvm-swift/FileCheck.git", 16 | "state": { 17 | "branch": null, 18 | "revision": "f25bfb4c69b9e05bf6b8d0862dcedb875c1b0f68", 19 | "version": "0.2.4" 20 | } 21 | }, 22 | { 23 | "package": "swift-tools-support-core", 24 | "repositoryURL": "https://github.com/apple/swift-tools-support-core.git", 25 | "state": { 26 | "branch": null, 27 | "revision": "693aba4c4c9dcc4767cc853a0dd38bf90ad8c258", 28 | "version": "0.0.1" 29 | } 30 | }, 31 | { 32 | "package": "SwiftCheck", 33 | "repositoryURL": "https://github.com/typelift/SwiftCheck.git", 34 | "state": { 35 | "branch": null, 36 | "revision": "077c096c3ddfc38db223ac8e525ad16ffb987138", 37 | "version": "0.12.0" 38 | } 39 | } 40 | ] 41 | }, 42 | "version": 1 43 | } 44 | -------------------------------------------------------------------------------- /Package.swift: -------------------------------------------------------------------------------- 1 | // swift-tools-version:5.2 2 | // The swift-tools-version declares the minimum version of Swift required to build this package. 3 | 4 | import PackageDescription 5 | 6 | let package = Package( 7 | name: "XCTestJSONObserver", 8 | platforms: [.macOS(.v10_13)], 9 | products: [ 10 | // Products define the executables and libraries a package produces, and make them visible to other packages. 11 | .library( 12 | name: "XCTestJSONObserver", 13 | targets: ["XCTestJSONObserver"] 14 | ), 15 | ], 16 | dependencies: [ 17 | .package(url: "https://github.com/typelift/SwiftCheck.git", from: "0.8.1"), 18 | ], 19 | targets: [ 20 | // Targets are the basic building blocks of a package. A target can define a module or a test suite. 21 | // Targets can depend on other targets in this package, and on products in packages this package depends on. 22 | .target( 23 | name: "XCTestJSONObserver", 24 | dependencies: [] 25 | ), 26 | .testTarget( 27 | name: "JSONObserverTests", 28 | dependencies: ["SwiftCheck", "XCTestJSONObserver"] 29 | ), 30 | ] 31 | ) 32 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # XCTestJSONObserver 2 | 3 | JSON observer and test reporter for XCTest. 4 | -------------------------------------------------------------------------------- /Sources/XCTestJSONObserver/JSONObserver.swift: -------------------------------------------------------------------------------- 1 | // This source file is part of the Swift.org open source project 2 | // 3 | // Copyright (c) 2020 Apple Inc. and the Swift project authors 4 | // Licensed under Apache License v2.0 with Runtime Library Exception 5 | // 6 | // See http://swift.org/LICENSE.txt for license information 7 | // See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors 8 | // 9 | // 10 | // JSONObserver.swift 11 | // Prints test progress to stdout encoded as JSON 12 | // 13 | 14 | import Foundation 15 | import XCTest 16 | 17 | public struct TimedEvent: Codable { 18 | public let name: String 19 | public let date: Date 20 | } 21 | 22 | public struct FailedTestCase: Codable { 23 | public let filePath: String? 24 | public let lineNumber: Int 25 | public let name: String 26 | public let description: String 27 | } 28 | 29 | public struct FinishedTestCase: Codable { 30 | public enum State: String, Codable, CaseIterable { 31 | case skipped 32 | case passed 33 | case failed 34 | } 35 | 36 | public let state: State 37 | public let durationInSeconds: TimeInterval 38 | } 39 | 40 | public struct FinishedTestSuite: Codable { 41 | public let executionCount: Int 42 | public let totalFailureCount: Int 43 | public let unexpectedExceptionCount: Int 44 | public let testDuration: TimeInterval 45 | public let totalDuration: TimeInterval 46 | } 47 | 48 | public enum Event: Codable { 49 | public enum CodingError: Error { 50 | case invalidVersion 51 | } 52 | 53 | public enum Kind: String, Codable, CaseIterable { 54 | case testSuiteStarted 55 | case testCaseStarted 56 | case testCaseFailed 57 | case testCaseFinished 58 | case testSuiteFinished 59 | } 60 | 61 | private enum CodingKeys: CodingKey { 62 | case version 63 | case kind 64 | case value 65 | } 66 | 67 | case testSuiteStarted(TimedEvent) 68 | case testCaseStarted(TimedEvent) 69 | case testCaseFailed(FailedTestCase) 70 | case testCaseFinished(FinishedTestCase) 71 | case testSuiteFinished(FinishedTestSuite) 72 | 73 | public init(from decoder: Decoder) throws { 74 | let container = try decoder.container(keyedBy: CodingKeys.self) 75 | 76 | let version = try container.decode(Int.self, forKey: .version) 77 | guard version == 0 else { throw CodingError.invalidVersion } 78 | 79 | let kind = try container.decode(Kind.self, forKey: .kind) 80 | 81 | switch kind { 82 | case .testSuiteStarted: 83 | self = .testSuiteStarted(try container.decode(TimedEvent.self, forKey: .value)) 84 | case .testCaseStarted: 85 | self = .testCaseStarted(try container.decode(TimedEvent.self, forKey: .value)) 86 | case .testCaseFailed: 87 | self = .testCaseFailed(try container.decode(FailedTestCase.self, forKey: .value)) 88 | case .testCaseFinished: 89 | self = .testCaseFinished(try container.decode(FinishedTestCase.self, forKey: .value)) 90 | case .testSuiteFinished: 91 | self = .testSuiteFinished(try container.decode(FinishedTestSuite.self, forKey: .value)) 92 | } 93 | } 94 | 95 | public func encode(to encoder: Encoder) throws { 96 | var container = encoder.container(keyedBy: CodingKeys.self) 97 | try container.encode(0, forKey: CodingKeys.version) 98 | 99 | switch self { 100 | case let .testSuiteStarted(value): 101 | try container.encode(Kind.testSuiteStarted, forKey: CodingKeys.kind) 102 | try container.encode(value, forKey: CodingKeys.value) 103 | case let .testCaseStarted(value): 104 | try container.encode(Kind.testCaseStarted, forKey: CodingKeys.kind) 105 | try container.encode(value, forKey: CodingKeys.value) 106 | case let .testCaseFailed(value): 107 | try container.encode(Kind.testCaseFailed, forKey: CodingKeys.kind) 108 | try container.encode(value, forKey: CodingKeys.value) 109 | case let .testCaseFinished(value): 110 | try container.encode(Kind.testCaseFinished, forKey: CodingKeys.kind) 111 | try container.encode(value, forKey: CodingKeys.value) 112 | case let .testSuiteFinished(value): 113 | try container.encode(Kind.testSuiteFinished, forKey: CodingKeys.kind) 114 | try container.encode(value, forKey: CodingKeys.value) 115 | } 116 | } 117 | } 118 | 119 | /// Prints JSON representations of each XCTestObservation event to stdout. 120 | public class JSONObserver: NSObject, XCTestObservation { 121 | let handler: (Event) -> () 122 | 123 | public init(handler: @escaping (Event) -> ()) { 124 | self.handler = handler 125 | } 126 | 127 | #if !os(WASI) 128 | public func testBundleWillStart(_ testBundle: Bundle) {} 129 | #endif 130 | 131 | public func testSuiteWillStart(_ testSuite: XCTestSuite) { 132 | handler(Event.testSuiteStarted(.init( 133 | name: testSuite.name, 134 | date: testSuite.testRun!.startDate! 135 | ))) 136 | } 137 | 138 | public func testCaseWillStart(_ testCase: XCTestCase) { 139 | handler(Event.testSuiteStarted(.init( 140 | name: testCase.name, 141 | date: testCase.testRun!.startDate! 142 | ))) 143 | } 144 | 145 | public func testCase( 146 | _ testCase: XCTestCase, 147 | didFailWithDescription description: String, 148 | inFile filePath: String?, 149 | atLine lineNumber: Int 150 | ) { 151 | handler(Event.testCaseFailed(.init( 152 | filePath: filePath, 153 | lineNumber: lineNumber, 154 | name: testCase.name, 155 | description: description 156 | ))) 157 | } 158 | 159 | public func testCaseDidFinish(_ testCase: XCTestCase) { 160 | let testRun = testCase.testRun! 161 | 162 | let state: FinishedTestCase.State 163 | if testRun.hasSucceeded { 164 | if testRun.hasBeenSkipped { 165 | state = .skipped 166 | } else { 167 | state = .passed 168 | } 169 | } else { 170 | state = .failed 171 | } 172 | 173 | handler(Event.testCaseFinished(.init( 174 | state: state, 175 | durationInSeconds: testRun.totalDuration 176 | ))) 177 | } 178 | 179 | public func testSuiteDidFinish(_ testSuite: XCTestSuite) { 180 | let testRun = testSuite.testRun! 181 | 182 | handler(Event.testSuiteFinished(.init( 183 | executionCount: testRun.executionCount, 184 | totalFailureCount: testRun.totalFailureCount, 185 | unexpectedExceptionCount: testRun.unexpectedExceptionCount, 186 | testDuration: testRun.testDuration, 187 | totalDuration: testRun.totalDuration 188 | ))) 189 | } 190 | 191 | #if !os(WASI) 192 | public func testBundleDidFinish(_ testBundle: Bundle) {} 193 | #endif 194 | } 195 | -------------------------------------------------------------------------------- /Tests/JSONObserverTests/Equatable.swift: -------------------------------------------------------------------------------- 1 | // Copyright 2020 XCTestJSONObserver contributors 2 | // 3 | // Licensed under the Apache License, Version 2.0 (the "License"); 4 | // you may not use this file except in compliance with the License. 5 | // You may obtain a copy of the License at 6 | // 7 | // http://www.apache.org/licenses/LICENSE-2.0 8 | // 9 | // Unless required by applicable law or agreed to in writing, software 10 | // distributed under the License is distributed on an "AS IS" BASIS, 11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | // See the License for the specific language governing permissions and 13 | // limitations under the License. 14 | 15 | @testable import XCTestJSONObserver 16 | 17 | func fpAlmostEqual(_ first: T, _ second: T) -> Bool { 18 | if abs(first - second) < .ulpOfOne { 19 | return true 20 | } 21 | return false 22 | } 23 | 24 | extension TimedEvent: Equatable { 25 | public static func ==(lhs: Self, rhs: Self) -> Bool { 26 | lhs.name == rhs.name && lhs.date == rhs.date 27 | } 28 | } 29 | 30 | extension FailedTestCase: Equatable { 31 | public static func ==(lhs: Self, rhs: Self) -> Bool { 32 | lhs.filePath == rhs.filePath && 33 | lhs.lineNumber == rhs.lineNumber && 34 | lhs.name == rhs.name && 35 | lhs.description == rhs.description 36 | } 37 | } 38 | 39 | extension FinishedTestCase: Equatable { 40 | public static func ==(lhs: Self, rhs: Self) -> Bool { 41 | lhs.state == rhs.state && 42 | fpAlmostEqual(lhs.durationInSeconds, rhs.durationInSeconds) 43 | } 44 | } 45 | 46 | extension FinishedTestSuite: Equatable { 47 | public static func ==(lhs: Self, rhs: Self) -> Bool { 48 | lhs.executionCount == rhs.executionCount && 49 | lhs.totalFailureCount == rhs.totalFailureCount && 50 | lhs.unexpectedExceptionCount == rhs.unexpectedExceptionCount && 51 | fpAlmostEqual(lhs.testDuration, rhs.testDuration) && 52 | fpAlmostEqual(lhs.totalDuration, rhs.totalDuration) 53 | } 54 | } 55 | 56 | extension Event: Equatable { 57 | public static func ==(lhs: Self, rhs: Self) -> Bool { 58 | switch (lhs, rhs) { 59 | case let (.testSuiteStarted(lhs), .testSuiteStarted(rhs)): 60 | return lhs == rhs 61 | case let (.testCaseStarted(lhs), .testCaseStarted(rhs)): 62 | return lhs == rhs 63 | case let (.testCaseFailed(lhs), .testCaseFailed(rhs)): 64 | return lhs == rhs 65 | case let (.testCaseFinished(lhs), .testCaseFinished(rhs)): 66 | return lhs == rhs 67 | case let (.testSuiteFinished(lhs), .testSuiteFinished(rhs)): 68 | return lhs == rhs 69 | default: 70 | return false 71 | } 72 | } 73 | } 74 | -------------------------------------------------------------------------------- /Tests/JSONObserverTests/PropertyTests.swift: -------------------------------------------------------------------------------- 1 | // Copyright 2020 XCTestJSONObserver contributors 2 | // 3 | // Licensed under the Apache License, Version 2.0 (the "License"); 4 | // you may not use this file except in compliance with the License. 5 | // You may obtain a copy of the License at 6 | // 7 | // http://www.apache.org/licenses/LICENSE-2.0 8 | // 9 | // Unless required by applicable law or agreed to in writing, software 10 | // distributed under the License is distributed on an "AS IS" BASIS, 11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | // See the License for the specific language governing permissions and 13 | // limitations under the License. 14 | 15 | import Foundation 16 | import SwiftCheck 17 | import XCTest 18 | @testable import XCTestJSONObserver 19 | 20 | extension Date: Arbitrary { 21 | public static var arbitrary: Gen { 22 | TimeInterval.arbitrary.map { Date(timeIntervalSince1970: $0) } 23 | } 24 | } 25 | 26 | extension TimedEvent: Arbitrary { 27 | public static var arbitrary: Gen { 28 | .compose { .init(name: $0.generate(), date: $0.generate()) } 29 | } 30 | } 31 | 32 | extension FailedTestCase: Arbitrary { 33 | public static var arbitrary: Gen { 34 | .compose { 35 | .init( 36 | filePath: $0.generate(), 37 | lineNumber: $0.generate(), 38 | name: $0.generate(), 39 | description: $0.generate() 40 | ) 41 | } 42 | } 43 | } 44 | 45 | extension FinishedTestCase.State: Arbitrary { 46 | public static var arbitrary: Gen { 47 | .fromElements(of: FinishedTestCase.State.allCases) 48 | } 49 | } 50 | 51 | extension FinishedTestCase: Arbitrary { 52 | public static var arbitrary: Gen { 53 | .compose { .init(state: $0.generate(), durationInSeconds: $0.generate()) } 54 | } 55 | } 56 | 57 | extension FinishedTestSuite: Arbitrary { 58 | public static var arbitrary: Gen { 59 | .compose { 60 | .init( 61 | executionCount: $0.generate(), 62 | totalFailureCount: $0.generate(), 63 | unexpectedExceptionCount: $0.generate(), 64 | testDuration: $0.generate(), 65 | totalDuration: $0.generate() 66 | ) 67 | } 68 | } 69 | } 70 | 71 | extension Event.Kind: Arbitrary { 72 | public static var arbitrary: Gen { 73 | .fromElements(of: Event.Kind.allCases) 74 | } 75 | } 76 | 77 | extension Event: Arbitrary { 78 | public static var arbitrary: Gen { 79 | .compose { 80 | let kind: Event.Kind = $0.generate() 81 | 82 | switch kind { 83 | case .testSuiteStarted: 84 | return .testSuiteStarted($0.generate()) 85 | case .testCaseStarted: 86 | return .testCaseStarted($0.generate()) 87 | case .testCaseFailed: 88 | return .testCaseFailed($0.generate()) 89 | case .testCaseFinished: 90 | return .testCaseFinished($0.generate()) 91 | case .testSuiteFinished: 92 | return .testSuiteFinished($0.generate()) 93 | } 94 | } 95 | } 96 | } 97 | 98 | func doublesAreEqual(first: Double, second: Double) -> Bool { 99 | if fabs(first - second) < .ulpOfOne { 100 | return true 101 | } 102 | return false 103 | } 104 | 105 | final class PropertyTests: XCTestCase { 106 | func testReversibleEncoding() throws { 107 | property("Event encoding is reversible") <- forAll { (event: Event) in 108 | let encoder = JSONEncoder() 109 | let encoded = try encoder.encode(event) 110 | let decoder = JSONDecoder() 111 | let decodedEvent = try decoder.decode(Event.self, from: encoded) 112 | 113 | return decodedEvent == event 114 | } 115 | } 116 | } 117 | -------------------------------------------------------------------------------- /xcode_test.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | set -ex 4 | 5 | sudo xcode-select --switch /Applications/$1.app/Contents/Developer 6 | 7 | swift test 8 | --------------------------------------------------------------------------------