├── .mise ├── .gitignore ├── rollup.config.js ├── action.yml ├── package.json ├── README.md ├── src └── index.js └── LICENSE.txt /.mise: -------------------------------------------------------------------------------- 1 | [tools] 2 | node = "20" 3 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Node.js dependencies 2 | node_modules/ 3 | 4 | # Environment variables 5 | .env 6 | 7 | # OS files 8 | .DS_Store 9 | -------------------------------------------------------------------------------- /rollup.config.js: -------------------------------------------------------------------------------- 1 | import commonjs from "@rollup/plugin-commonjs"; 2 | import { nodeResolve } from "@rollup/plugin-node-resolve"; 3 | 4 | const config = { 5 | input: "src/index.js", 6 | output: { 7 | esModule: true, 8 | file: "dist/index.js", 9 | format: "es", 10 | sourcemap: false, 11 | }, 12 | plugins: [commonjs(), nodeResolve({ preferBuiltins: true })], 13 | }; 14 | 15 | export default config; 16 | -------------------------------------------------------------------------------- /action.yml: -------------------------------------------------------------------------------- 1 | name: Xcode Coverage Report 2 | description: Generate code coverage report from Xcode result bundle 3 | 4 | inputs: 5 | result-bundle: 6 | description: Path to the Xcode result bundle 7 | required: true 8 | included-targets: 9 | description: Comma-separated list of target names to include in the report 10 | required: false 11 | default: "" 12 | 13 | outputs: 14 | report: 15 | description: Markdown report of code coverage 16 | 17 | runs: 18 | using: node20 19 | main: dist/index.js 20 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "xcode-coverage-report", 3 | "version": "1.0.0", 4 | "description": "", 5 | "type": "module", 6 | "main": "index.js", 7 | "scripts": { 8 | "build": "rollup --config rollup.config.js" 9 | }, 10 | "keywords": [], 11 | "author": "", 12 | "license": "ISC", 13 | "dependencies": { 14 | "@actions/core": "^1.11.1" 15 | }, 16 | "devDependencies": { 17 | "@rollup/plugin-commonjs": "^29.0.0", 18 | "@rollup/plugin-node-resolve": "^16.0.3", 19 | "rollup": "^4.52.5" 20 | } 21 | } -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # xcode-coverage-report 2 | 3 | This GitHub Action extracts and formats Xcode coverage data from a result bundle using `xcrun xccov`. 4 | 5 | ## Usage 6 | 7 | Add this action to your workflow: 8 | 9 | ```yaml 10 | - name: Xcode Coverage Report 11 | uses: Infomaniak/ios-xcode-coverage-report-action@v1 12 | with: 13 | result-bundle: path/to/your/Test.xcresult 14 | ``` 15 | 16 | ## Inputs 17 | 18 | | Name | Description | Required | 19 | |----------------|---------------------------------------------|----------| 20 | | result-bundle | Path to the .xcresult file or directory | Yes | 21 | 22 | ## Outputs 23 | 24 | | Name | Description | 25 | |--------|--------------------------------------| 26 | | report | Markdown summary of coverage results | 27 | 28 | ## Example Output 29 | 30 | The `report` output contains a markdown summary like: 31 | 32 | ``` 33 | # Coverage result 34 | | Percent covered | 66.74% | 35 | | --- | --- | 36 | | Executable Lines | 14196 | 37 | | Covered Lines | 9475 | 38 | 39 | # Details 40 |
41 | DeviceAssociation (69.29%) 42 | 43 | | File | Coverage | 44 | | --- | --- | 45 | | Capability.swift | 70.00% | 46 | 47 |
48 | ``` 49 | 50 | ## Requirements 51 | - macOS runner with Xcode installed 52 | - The `xcrun` tool available in PATH 53 | 54 | ## Troubleshooting 55 | - Ensure the path to your `.xcresult` bundle is correct and accessible. 56 | - The action will fail if the path does not exist or is not a file/directory. 57 | 58 | ## Developement 59 | Use `$ npm run build` and commit the updated `dist/index.js` file -------------------------------------------------------------------------------- /src/index.js: -------------------------------------------------------------------------------- 1 | import * as core from "@actions/core"; 2 | import { execFileSync } from "child_process"; 3 | import * as fs from "fs"; 4 | import * as path from "path"; 5 | 6 | try { 7 | // Read and sanitize the result-bundle input: must be a file path 8 | const rawInput = core.getInput("result-bundle", { required: true }); 9 | const trimmed = rawInput.trim(); 10 | 11 | // Basic safety checks: disallow NULs and newlines which can indicate injection or malformed input 12 | if (/[\0\r\n]/.test(trimmed)) { 13 | throw new Error("Invalid result-bundle: contains control characters"); 14 | } 15 | 16 | // Resolve to an absolute path so downstream tools get a canonical path 17 | const resultBundle = path.resolve(trimmed); 18 | 19 | // Ensure the path exists and is a file or directory 20 | if (!fs.existsSync(resultBundle)) { 21 | throw new Error(`result-bundle path does not exist: ${resultBundle}`); 22 | } 23 | const stat = fs.statSync(resultBundle); 24 | if (!stat.isFile() && !stat.isDirectory()) { 25 | throw new Error(`result-bundle must be a file or directory path: ${resultBundle}`); 26 | } 27 | 28 | // Run xcrun xccov view command and get JSON output (no shell interpolation) 29 | // Write JSON output to a temporary file 30 | const tmpJsonPath = path.join(process.cwd(), "xccov-report.json"); 31 | execFileSync( 32 | "xcrun", 33 | ["xccov", "view", "--report", "--json", resultBundle, ">", tmpJsonPath], 34 | { shell: true } 35 | ); 36 | 37 | // Read and parse the JSON from the file 38 | const jsonOutput = fs.readFileSync(tmpJsonPath, { encoding: "utf-8" }); 39 | const coverageData = JSON.parse(jsonOutput); 40 | 41 | // Get optional included-targets input 42 | const includedTargetsRaw = core.getInput("included-targets", { required: false }) || ""; 43 | const includedTargets = includedTargetsRaw.split(",").map(s => s.trim()).filter(Boolean); 44 | 45 | let filteredTargets = coverageData.targets; 46 | let overallExecutable = 0; 47 | let overallCovered = 0; 48 | 49 | if (includedTargets.length > 0) { 50 | filteredTargets = coverageData.targets.filter(t => includedTargets.includes(t.name)); 51 | // Manually compute overall percent covered 52 | for (const target of filteredTargets) { 53 | overallExecutable += target.executableLines; 54 | overallCovered += target.coveredLines; 55 | } 56 | } else { 57 | overallExecutable = coverageData.executableLines; 58 | overallCovered = coverageData.coveredLines; 59 | } 60 | 61 | const percentCovered = overallExecutable > 0 ? ((overallCovered / overallExecutable) * 100).toFixed(2) : "0.00"; 62 | 63 | let markdown = `# Coverage result\n`; 64 | markdown += `| Overall Percent Covered | ${percentCovered}% |\n`; 65 | markdown += `| --- | --- |\n`; 66 | markdown += `| Executable Lines | ${overallExecutable} |\n`; 67 | markdown += `| Covered Lines | ${overallCovered} |\n\n`; 68 | markdown += `# Details\n`; 69 | 70 | // Add details for each filtered target 71 | for (const target of filteredTargets) { 72 | const targetPercent = (target.lineCoverage * 100).toFixed(2); 73 | markdown += `
\n\n`; 74 | markdown += `${target.name} (${targetPercent}%)\n\n`; 75 | 76 | // List all files with percent covered in table format 77 | markdown += `| File | Coverage |\n`; 78 | markdown += `| --- | --- |\n`; 79 | for (const file of target.files) { 80 | const filePercent = (file.lineCoverage * 100).toFixed(2); 81 | markdown += `| ${file.name} | ${filePercent}% |\n`; 82 | } 83 | 84 | markdown += `\n
\n\n`; 85 | } 86 | 87 | core.setOutput("report", markdown); 88 | } catch (error) { 89 | core.setFailed(error.message); 90 | } 91 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | --------------------------------------------------------------------------------