Fix: Generate tests for executable/tool with `--enable-swift-testing` #9032

JeffESchmitz · 2025-08-15T16:44:54Z

Updated InitPackage to handle .executable and .tool types when generating test files with SwiftTesting. Added corresponding tests to verify correct test file content for these package types.

Motivation:

The swift package init command did not generate a Tests directory for executable or tool packages when the --enable-swift-testing flag was used. This was caused by logic in Sources/Workspace/InitPackage.swift that incorrectly skipped test generation for these package types. This change fixes that behavior, ensuring that tests are created as expected.

Modifications:

In Sources/Workspace/InitPackage.swift, the writeTests() function was modified to proceed with test generation for .executable and .tool package types.
In the same file, the writeTestFileStubs() function was updated to include .executable and .tool types, allowing the creation of standard library-style test files for them.

Result:

After this change, running swift package init --type executable --enable-swift-testing or swift package init --type tool --enable-swift-testing correctly generates a Tests directory with sample test files, aligning the tool's behavior with its intended functionality.

Reproduction and Verification:

Reproducing the Issue (on `main` branch):

Create a temporary directory: mkdir -p /tmp/test-repro && cd /tmp/test-repro
Run swift package init --type executable --enable-swift-testing.
Verify that no Tests directory is created by running ls -F.

Verifying the Fix (on this branch):

Build the package manager: swift build
Find the built executable: find .build -name swift-package
Create a temporary directory: mkdir -p /tmp/test-fix && cd /tmp/test-fix
Run the newly built package manager to init a project: ../.build/arm64-apple-macosx/debug/swift-package init --type executable --enable-swift-testing (adjust path as needed).
Verify that a Tests directory is now created by running ls -F.

Updated InitPackage to handle .executable and .tool types when generating test files with SwiftTesting. Added corresponding tests to verify correct test file content for these package types.

MaxDesiatov · 2025-08-15T16:56:44Z

@swift-ci test

plemarquand · 2025-08-15T17:40:26Z

This patch does the same thing: #8995

I was waiting for CI to get back to green before progressing on it, but if you'd like to take over working on this I'm happy to pass it along.

JeffESchmitz · 2025-08-16T14:21:03Z

This patch does the same thing: #8995

I was waiting for CI to get back to green before progressing on it, but if you'd like to take over working on this I'm happy to pass it along.

Thanks, @plemarquand — I didn’t realize #8995 was already in progress. After looking closely, your PR already includes the same functional changes I made (allowing tests to be generated for .executable and .tool) and it adds the swift-testing modernization. Sorry for the duplicate effort.

The only delta I see from my side is a small style tweak where I used an exhaustive switch (no default:) to force future case handling.

I’m happy to help land #8995 and can open a PR against your branch for any cleanups you want, or port your test changes into #9032 if you’d prefer consolidating here. I’ll follow your lead, 👍🏻.

plemarquand · 2025-08-16T18:44:17Z

@JeffESchmitz I say you push forward with this PR. I'll give it a review when you unmark it as draft, and once it's merged I'll extract my work to convert the suite to Swift testing in to its own PR. Probably makes sense to break up that work anyway. Thanks!

jakepetroules · 2025-08-17T01:41:00Z

Sources/Workspace/InitPackage.swift

@@ -660,10 +660,16 @@ public final class InitPackage {
            return
        }

+        // Intentionally exhaustive switch without `default` case - forces compilation failure when new


I don't think the long explanatory comment is necessary - this pattern is used dozens of times throughout any decent-sized Swift codebase, and this would be best mentioned once in a style guide vs applied to every one of those locations.

Thank you for pointing that out, @jakepetroules.

My verbose comment was meant to capture my thought process—I probably should have included it in the PR description or removed it altogether.

I’ll go ahead and remove that inline comment and rely on the style guide to document the exhaustive‑switch pattern. Thanks again for catching that.

jakepetroules · 2025-08-17T01:42:27Z

Sources/Workspace/InitPackage.swift

-        case .library:
+        case .empty, .buildToolPlugin, .commandPlugin:
+            break
+        case .library, .executable, .tool: // Added .executable and .tool here


Similarly, this kind of comment isn't adding any useful information, and could become out of date over time.

The exhaustive-switch pattern is self-evident here and common across the codebase. This comment adds noise rather than clarity, so it's better removed and documented via a style guide if needed

plemarquand · 2025-08-20T13:23:21Z

@swift-ci please test

JeffESchmitz · 2025-08-21T14:04:54Z

The Windows Swift Test build errors are puzzling. What is SimpleTests and where is that within this repo?

0:24:49      [5/11] Compiling Simple Simple.swift

10:24:49      [6/12] Compiling SimpleTests SwiftTests.swift

10:24:49      C:\Users\ContainerAdministrator\AppData\Local\Temp\Miscellaneous_TestDiscovery_Simple.hs68qY\Miscellaneous_TestDiscovery_Simple\Tests\SimpleTests\SwiftTests.swift:2:18: 
error: module 'Simple' was not compiled for testing

https://ci-external.swift.org/job/pr-swiftpm-windows-self-hosted/1880/console

@plemarquand, any ideas?

plemarquand · 2025-08-22T03:05:05Z

@swift-ci test windows

plemarquand · 2025-08-22T03:05:35Z

@JeffESchmitz odd, that doesn't seem related. I've rekicked a build.

plemarquand · 2025-08-24T02:45:44Z

@swift-ci test windows

JeffESchmitz · 2025-08-26T21:32:47Z

Thanks @plemarquand for kicking off the Windows build. This PR should be ready for another review.

Does it need anyone else to review and approve before it can be merged to main?

plemarquand · 2025-08-27T13:02:27Z

@JeffESchmitz Looks good to me, thanks for all your help!

Add SwiftTesting support for executable and tool packages

2bea2e6

Updated InitPackage to handle .executable and .tool types when generating test files with SwiftTesting. Added corresponding tests to verify correct test file content for these package types.

JeffESchmitz requested review from jakepetroules, dschaefer2, shawnhyam, bripeticca, plemarquand, owenv, bkhouri, cmcgee1024 and daveyc123 as code owners August 15, 2025 16:44

JeffESchmitz mentioned this pull request Aug 15, 2025

No sample tests in swift package init --type executable --enable-swift-testing #8990

Closed

1 task

JeffESchmitz marked this pull request as draft August 16, 2025 14:21

jakepetroules reviewed Aug 17, 2025

View reviewed changes

refactor: remove verbose exhaustive-switch comment

66ce054

The exhaustive-switch pattern is self-evident here and common across the codebase. This comment adds noise rather than clarity, so it's better removed and documented via a style guide if needed

JeffESchmitz marked this pull request as ready for review August 20, 2025 16:38

JeffESchmitz requested a review from jakepetroules August 20, 2025 18:37

plemarquand approved these changes Aug 27, 2025

View reviewed changes

plemarquand merged commit 339afc8 into swiftlang:main Aug 27, 2025
6 checks passed

This was referenced Aug 27, 2025

Package Init - Generate tests for .executable, .tool #8995

Closed

[Tests] Convert InitTests to Swift Testing #9079

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Fix: Generate tests for executable/tool with `--enable-swift-testing` #9032

Fix: Generate tests for executable/tool with `--enable-swift-testing` #9032

Uh oh!

JeffESchmitz commented Aug 15, 2025

Uh oh!

MaxDesiatov commented Aug 15, 2025

Uh oh!

plemarquand commented Aug 15, 2025

Uh oh!

JeffESchmitz commented Aug 16, 2025 •

edited

Loading

Uh oh!

plemarquand commented Aug 16, 2025

Uh oh!

jakepetroules Aug 17, 2025

Uh oh!

JeffESchmitz Aug 20, 2025

Uh oh!

jakepetroules Aug 17, 2025

Uh oh!

plemarquand commented Aug 20, 2025

Uh oh!

JeffESchmitz commented Aug 21, 2025 •

edited

Loading

Uh oh!

plemarquand commented Aug 22, 2025

Uh oh!

plemarquand commented Aug 22, 2025

Uh oh!

plemarquand commented Aug 24, 2025

Uh oh!

JeffESchmitz commented Aug 26, 2025

Uh oh!

plemarquand commented Aug 27, 2025

Uh oh!

Uh oh!

Uh oh!

Fix: Generate tests for executable/tool with --enable-swift-testing #9032

Fix: Generate tests for executable/tool with --enable-swift-testing #9032

Uh oh!

Conversation

JeffESchmitz commented Aug 15, 2025

Motivation:

Modifications:

Result:

Reproduction and Verification:

Reproducing the Issue (on main branch):

Verifying the Fix (on this branch):

Uh oh!

MaxDesiatov commented Aug 15, 2025

Uh oh!

plemarquand commented Aug 15, 2025

Uh oh!

JeffESchmitz commented Aug 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

plemarquand commented Aug 16, 2025

Uh oh!

jakepetroules Aug 17, 2025

Choose a reason for hiding this comment

Uh oh!

JeffESchmitz Aug 20, 2025

Choose a reason for hiding this comment

Uh oh!

jakepetroules Aug 17, 2025

Choose a reason for hiding this comment

Uh oh!

plemarquand commented Aug 20, 2025

Uh oh!

JeffESchmitz commented Aug 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

plemarquand commented Aug 22, 2025

Uh oh!

plemarquand commented Aug 22, 2025

Uh oh!

plemarquand commented Aug 24, 2025

Uh oh!

JeffESchmitz commented Aug 26, 2025

Uh oh!

plemarquand commented Aug 27, 2025

Uh oh!

Uh oh!

Uh oh!

Fix: Generate tests for executable/tool with `--enable-swift-testing` #9032

Fix: Generate tests for executable/tool with `--enable-swift-testing` #9032

Reproducing the Issue (on `main` branch):

JeffESchmitz commented Aug 16, 2025 •

edited

Loading

JeffESchmitz commented Aug 21, 2025 •

edited

Loading