Add support for uploading xcresult bundle #40

hi-rai · 2025-12-23T14:20:16Z

This fixes https://github.com/Hypersequent/tms-issues/issues/2142

gemini-code-assist · 2025-12-23T14:20:45Z

Summary of Changes

Hello @hi-rai, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces comprehensive support for uploading Xcode result bundles (.xcresult) to QA Sphere, directly addressing issue #2142. This enhancement significantly broadens the tool's compatibility, allowing iOS/macOS developers to integrate their test results seamlessly. The changes include a new command-line interface option, updated dependencies for handling SQLite databases and Zstandard compression within .xcresult files, and refined parsing logic to extract test results, statuses, messages, and attachments from these bundles. Additionally, the PR improves user guidance for correctly formatting test case markers across all supported report types.

Highlights

New xcresult-upload Command: Introduced a new command to upload Xcode result bundles (.xcresult) directly to QA Sphere, expanding the types of test reports supported.
Updated Documentation: The README.md has been updated to include details on the new xcresult-upload command, its usage, and the required format for test case markers within Xcode reports.
Dependency Updates: New dependencies better-sqlite3 and fzstd were added to handle the parsing and decompression of .xcresult bundles, along with their respective TypeScript type definitions.
Refactored Parsing Logic: The internal parsing functions for JUnit XML and Playwright JSON reports were refactored to accept file paths directly, aligning with the new Xcode result bundle parser.
Improved Test Case Marker Detection: The regex for detecting project codes in test case names has been enhanced to support both hyphen (-) and underscore (_) separators, providing more flexibility for different reporting formats.
Enhanced Guidance for Missing Markers: Specific guidance messages are now provided for each report type (JUnit, Playwright, Xcode) when test case markers are not found, helping users correctly format their test names or annotations.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

gemini-code-assist

Code Review

This pull request adds support for uploading .xcresult bundles from Xcode, which is a great new feature. The implementation includes a new parser for the .xcresult format, leveraging better-sqlite3 to read the embedded database, which is a solid approach. The necessary changes are propagated throughout the CLI, including command registration, documentation, and testing. The refactoring of existing test parsers to accept file paths instead of content is a good move for consistency.

I have a couple of suggestions for the new xcresult parser to improve its robustness and performance. Specifically, I've pointed out the use of execSync in an async function and a potentially brittle way of parsing test names.

Overall, this is a well-executed feature addition. Great work!

gemini-code-assist · 2025-12-23T14:22:50Z

src/utils/result-upload/xcresultSqliteParser.ts

+			execSync(`xcrun xcresulttool get test-results summary --path "${bundlePath}"`, {
+				stdio: 'ignore',
+			})


The use of execSync blocks the Node.js event loop, which is an anti-pattern in an async function. This can freeze UI elements like spinners. It's better to use the asynchronous exec instead, especially since parseXCResult is already an async function. You can use dynamic imports and promisify to achieve this.

Suggested change

execSync(`xcrun xcresulttool get test-results summary --path "${bundlePath}"`, {

stdio: 'ignore',

})

const { promisify } = await import('node:util');

const { exec } = await import('node:child_process');

await promisify(exec)(`xcrun xcresulttool get test-results summary --path "${bundlePath}"`);

gemini-code-assist · 2025-12-23T14:22:50Z

src/utils/result-upload/xcresultSqliteParser.ts

+			)
+
+			results.push({
+				name: (testCase.name ?? 'Unknown Test').split('(')[0], // Names include "()" as well


Using split('(')[0] to clean the test case name is a bit brittle. It's meant to remove the test suite context that Xcode sometimes appends (e.g., testMyFeature(MyTests)), but it will also truncate valid test names that contain parentheses for other reasons, like testSomething(withContext). A regular expression would be more robust for removing only a parenthesized suffix.

Suggested change

name: (testCase.name ?? 'Unknown Test').split('(')[0], // Names include "()" as well

name: (testCase.name ?? 'Unknown Test').replace(/$.*$$/, '').trim(), // Names include "()" as well

hi-rai · 2025-12-23T14:40:12Z

src/commands/main.ts

Need to configure prettier to run automatically in pre commit hook

hi-rai · 2025-12-23T14:40:59Z

src/tests/playwright-json-parsing.spec.ts

Changes because parsePlaywrightJson now expects file name instead of contents

hi-rai · 2025-12-23T14:41:09Z

src/tests/junit-xml-parsing.spec.ts

Changes because parseJUnitXml now expects file name instead of contents

hi-rai · 2025-12-23T14:42:01Z

src/utils/result-upload/playwrightJsonParser.ts


 	if (result.retry) {
-		message += `<p><b>Test passed in ${result.retry + 1} attempts</b></p>`
+		message += `<p><strong>Test passed in ${result.retry + 1} attempts</strong></p>`


Backend expects strong tag instead of b

hi-rai · 2025-12-23T14:42:35Z

src/utils/result-upload/ResultUploadCommandHandler.ts

 	protected detectProjectCodeFromTCaseNames(fileResults: FileResults[]) {
-		// Look for pattern like PRJ-123 or TEST-456
-		const tcaseSeqRegex = new RegExp(/([A-Za-z0-9]{1,5})-\d{3,}/)
+		// Look for pattern like PRJ-123 or TEST-456 (_ is also allowed as separator)


_ because function names in xcresult files can't have -

hi-rai · 2025-12-23T14:42:57Z

src/utils/result-upload/ResultUploadCommandHandler.ts

+				printError(
+					`Test case name "${result.name}" in ${file} does not contain valid test case marker`
+				)
+				commandTypePrintMissingMarkerGuidance[this.type](projectCode, result.name)


Added marker guidelines here as well

hi-rai · 2025-12-23T14:43:56Z

src/utils/result-upload/xcresultSqliteParser.ts

Can be tested using xcresult bundle added in the test or from https://github.com/Hypersequent/bistro-ios-xct

hi-rai · 2025-12-23T14:47:04Z

src/utils/result-upload/xcresultSqliteParser.ts

+
+export const parseXCResult: Parser = async (bundlePath: string): Promise<TestCaseResult[]> => {
+	const dbPath = path.join(bundlePath, sqliteFile)
+	if (!existsSync(dbPath)) {


After inspecting the demo bundles present in https://github.com/Hypersequent/bistro-ios-xct, I expected the sqlite files to be always present in the bundle. However, when I myself generated new bundles (after implementation), it didn't contain the sqlite file.
Found that we need to run some xcrun xcresulttool command, which then generates the sqlite file (on the first run). So now this becomes a dependency

hi-rai · 2025-12-23T14:50:12Z

src/tests/fixtures/xcresult/Variety.xcresult/database.sqlite3

This bundle is same as the one at https://github.com/Hypersequent/bistro-ios-xct/tree/main/Saved%20Results. I only retained the sqlite file as that is sufficient for our case

Updated tcase names to contain valid markers like TEST_002

Deleted entries from attachments table. Then we won't need the raw files present in data directory

Add support for uploading xcresult bundle

1a79e20

hi-rai requested review from AndrianBdn, ramilamparo, satvik007 and sirkostya009 December 23, 2025 14:20

hi-rai self-assigned this Dec 23, 2025

gemini-code-assist bot reviewed Dec 23, 2025

View reviewed changes

Improve error message

6d989cb

hi-rai commented Dec 23, 2025

View reviewed changes

hi-rai marked this pull request as draft December 31, 2025 06:34

-			execSync(`xcrun xcresulttool get test-results summary --path "${bundlePath}"`, {
-				stdio: 'ignore',
-			})
+			const { promisify } = await import('node:util');
+			const { exec } = await import('node:child_process');
+			await promisify(exec)(`xcrun xcresulttool get test-results summary --path "${bundlePath}"`);

	name: (testCase.name ?? 'Unknown Test').split('(')[0], // Names include "()" as well
	name: (testCase.name ?? 'Unknown Test').replace(/\(.*\)$/, '').trim(), // Names include "()" as well

Add support for uploading xcresult bundle #40

Are you sure you want to change the base?

Add support for uploading xcresult bundle #40

Uh oh!

Conversation

hi-rai commented Dec 23, 2025

Uh oh!

gemini-code-assist bot commented Dec 23, 2025

Summary of Changes

Highlights

Footnotes

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist bot Dec 23, 2025

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Dec 23, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants