Skip to content

Add the formalized Swift Testing event stream arguments to swift test. #7768

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 12, 2024
Merged

Add the formalized Swift Testing event stream arguments to swift test. #7768

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 40 additions & 15 deletions Sources/Commands/SwiftTestCommand.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,38 @@ struct SharedOptions: ParsableArguments {
var testProduct: String?
}

struct TestEventStreamOptions: ParsableArguments {
/// Legacy equivalent of ``configurationPath``.
@Option(name: .customLong("experimental-configuration-path"),
help: .private)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's private vs hidden? Haven't seen private before 🤔

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hidden means it still shows up in verbose help. Private means it is never shown in help.

var experimentalConfigurationPath: AbsolutePath?

/// Path where swift-testing's JSON configuration should be read.
@Option(name: .customLong("configuration-path"),
help: .hidden)
var configurationPath: AbsolutePath?

/// Legacy equivalent of ``eventStreamOutputPath``.
@Option(name: .customLong("experimental-event-stream-output"),
help: .private)
var experimentalEventStreamOutputPath: AbsolutePath?

/// Path where swift-testing's JSON output should be written.
@Option(name: .customLong("event-stream-output-path"),
help: .hidden)
var eventStreamOutputPath: AbsolutePath?

/// Legacy equivalent of ``eventStreamVersion``.
@Option(name: .customLong("experimental-event-stream-version"),
help: .private)
var experimentalEventStreamVersion: Int?

/// The schema version of swift-testing's JSON input/output.
@Option(name: .customLong("event-stream-version"),
help: .hidden)
var eventStreamVersion: Int?
}

struct TestCommandOptions: ParsableArguments {
@OptionGroup()
var globalOptions: GlobalOptions
Expand All @@ -91,6 +123,10 @@ struct TestCommandOptions: ParsableArguments {
@OptionGroup()
var testLibraryOptions: TestLibraryOptions

/// Options for Swift Testing's event stream.
@OptionGroup()
var testEventStreamOptions: TestEventStreamOptions

/// If tests should run in parallel mode.
@Flag(name: .customLong("parallel"),
inversion: .prefixedNo,
Expand Down Expand Up @@ -156,21 +192,6 @@ struct TestCommandOptions: ParsableArguments {
return testOutput == .experimentalSummary
}

/// Path where swift-testing's JSON configuration should be read.
@Option(name: .customLong("experimental-configuration-path"),
help: .hidden)
var configurationPath: AbsolutePath?

/// Path where swift-testing's JSON output should be written.
@Option(name: .customLong("experimental-event-stream-output"),
help: .hidden)
var eventStreamOutputPath: AbsolutePath?

/// The schema version of swift-testing's JSON input/output.
@Option(name: .customLong("experimental-event-stream-version"),
help: .hidden)
var eventStreamVersion: Int?

@OptionGroup(visibility: .hidden)
package var traits: TraitOptions
}
Expand Down Expand Up @@ -656,6 +677,10 @@ extension SwiftTestCommand {
@OptionGroup()
var testLibraryOptions: TestLibraryOptions

/// Options for Swift Testing's event stream.
@OptionGroup()
var testEventStreamOptions: TestEventStreamOptions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this really for just configuration rather than the stream options?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't understand, sorry?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is in list. Does list actually need all these, or does it just need the configuration path?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

list can use them all now! See swiftlang/swift-testing#511


@OptionGroup(visibility: .hidden)
package var traits: TraitOptions

Expand Down