Extract CLI logic from TestNG core by juherr · Pull Request #2612 · testng-team/testng

juherr · 2021-07-16T20:42:23Z

Did you remember to?

Add test case(s)
Update CHANGES.txt

https://github.com/remkop/picocli is the new defacto library for CLI.
Even if there is no plan to change the default implementation, JCommander was deeply linked.

The goal of this PR is to remove the strong dependency to JCommander.

krmahadevan · 2021-07-17T05:30:17Z

@juherr - Please give me some more time to go through this implementation (maybe this weekend). I liked this decoupling 👍
I will try to wrap up whatever observations I had by that time.

One thing. Do you think we can start preferring to use Streams and lambdas over regular for loops ?

krmahadevan · 2021-07-18T06:10:24Z

@juherr - I tried checking out your branch and then running the tests via ./gradlew clean test. I see a lot of test failures.
I also tried running a sample test case from within IntelliJ, I am seeing

Exception in thread "main" java.lang.InstantiationError: org.testng.CommandLineArgs
	at com.intellij.rt.testng.RemoteTestNGStarter.main(RemoteTestNGStarter.java:106)

Process finished with exit code 1

Please let me know if I am doing anything incorrectly here.

juherr · 2021-07-18T11:06:10Z

@krmahadevan Thanks for the feedback. I moved it to draft because I didn't check tests yet.

If the move looks good enough for you, I will finish it asap.

krmahadevan · 2021-07-18T11:15:56Z

@juherr - Sure. I am fine with this change. Please help take it forward.

@deprecated

testng-core depended on org.jcommander:jcommander in `api` scope, so every consumer got the parsing library whether or not it drove TestNG from a command line. The coupling ran deep: CommandLineArgs was a @Parameter-annotated POJO, TestNG held a static JCommander field, and TestNG.configure(CommandLineArgs) mixed applying configuration with CLI-only string-to-object conversion. The front end now lives in two new modules: testng-cli CliOptions, CliConfigurer, AbstractCliRunner - no parser testng-jcommander the JCommander implementation, plus Converter testng-core keeps a minimal ServiceLoader SPI, ITestNGCliRunner, so that "java -cp testng.jar org.testng.TestNG suite.xml" is unchanged: both modules are bundled into the merged jar. Implementations never terminate the JVM - an unusable command line comes back as a TestNGException, and only TestNG.main turns it into a message, a usage banner and exit code 1. Backward compatibility for 7.x is kept through frozen @deprecated shims: CommandLineArgs (annotations stripped), TestNG.configure(CommandLineArgs), TestNG.validateCommandLineParameters, TestNG.main and TestNG.privateMain. TestNG.configure(Map), the method Maven Surefire calls, still builds a CommandLineArgs, so removing that class depends on Surefire moving first. CliConfigurerParityTest compares the state both paths produce, field by field, because nothing else keeps the frozen copy in sync with the live one. testng-test-kit becomes the shared test-fixture library, so the 22 tests whose subject is the command line could move to testng-jcommander. The 243 classes extending SimpleBaseTest are unaffected. The two modules are deliberately not published on their own, and are kept out of the BOM for the same reason: that would ship org.testng.cli.* and its service registration in two artifacts at once. It is a packaging change for the next major, tracked in testng-team#3301. Supersedes testng-team#2612.

@deprecated

testng-core depended on org.jcommander:jcommander in `api` scope, so every consumer got the parsing library whether or not it drove TestNG from a command line. The coupling ran deep: CommandLineArgs was a @Parameter-annotated POJO, TestNG held a static JCommander field, and TestNG.configure(CommandLineArgs) mixed applying configuration with CLI-only string-to-object conversion. The front end now lives in two new modules: testng-cli CliOptions, CliConfigurer, AbstractCliRunner - no parser testng-jcommander the JCommander implementation, plus Converter testng-core keeps a minimal ServiceLoader SPI, ITestNGCliRunner, so that "java -cp testng.jar org.testng.TestNG suite.xml" is unchanged: both modules are bundled into the merged jar. Implementations never terminate the JVM - an unusable command line comes back as a TestNGException, and only TestNG.main turns it into a message, a usage banner and exit code 1. Backward compatibility for 7.x is kept through frozen @deprecated shims: CommandLineArgs (annotations stripped), TestNG.configure(CommandLineArgs), TestNG.validateCommandLineParameters, TestNG.main and TestNG.privateMain. TestNG.configure(Map), the method Maven Surefire calls, still builds a CommandLineArgs, so removing that class depends on Surefire moving first. CliConfigurerParityTest compares the state both paths produce, field by field, because nothing else keeps the frozen copy in sync with the live one. testng-test-kit becomes the shared test-fixture library, so the 22 tests whose subject is the command line could move to testng-jcommander. The 243 classes extending SimpleBaseTest are unaffected. The two modules are deliberately not published on their own, and are kept out of the BOM for the same reason: that would ship org.testng.cli.* and its service registration in two artifacts at once. It is a packaging change for the next major, tracked in testng-team#3301. Supersedes testng-team#2612.

@deprecated

testng-core depended on org.jcommander:jcommander in `api` scope, so every consumer got the parsing library whether or not it drove TestNG from a command line. The coupling ran deep: CommandLineArgs was a @Parameter-annotated POJO, TestNG held a static JCommander field, and TestNG.configure(CommandLineArgs) mixed applying configuration with CLI-only string-to-object conversion. The front end now lives in two new modules: testng-cli CliOptions, CliConfigurer, AbstractCliRunner - no parser testng-jcommander the JCommander implementation, plus Converter testng-core keeps a minimal ServiceLoader SPI, ITestNGCliRunner, so that "java -cp testng.jar org.testng.TestNG suite.xml" is unchanged: both modules are bundled into the merged jar. Implementations never terminate the JVM - an unusable command line comes back as a TestNGException, and only TestNG.main turns it into a message, a usage banner and exit code 1. TestNG.setThreadCount now raises a TestNGException below 1 instead of printing the usage banner and calling System.exit(1), so that no library setter can kill an embedder's JVM. The command line output is unchanged: TestNG.main turns that exception into the same message and the same exit code. Backward compatibility for 7.x is kept through frozen @deprecated shims: CommandLineArgs (annotations stripped), TestNG.configure(CommandLineArgs), TestNG.validateCommandLineParameters, TestNG.main and TestNG.privateMain. TestNG.configure(Map), the method Maven Surefire calls, still builds a CommandLineArgs, so removing that class depends on Surefire moving first. CliConfigurerParityTest compares the state both paths produce, field by field, because nothing else keeps the frozen copy in sync with the live one. testng-test-kit becomes the shared test-fixture library, so the 22 tests whose subject is the command line could move to testng-jcommander. The 243 classes extending SimpleBaseTest are unaffected. The two modules are deliberately not published on their own, and are kept out of the BOM for the same reason: that would ship org.testng.cli.* and its service registration in two artifacts at once. It is a packaging change for the next major, tracked in testng-team#3301. Supersedes testng-team#2612.

juherr · 2026-07-29T14:22:53Z

superseed by #3307

@deprecated

testng-core depended on org.jcommander:jcommander in `api` scope, so every consumer got the parsing library whether or not it drove TestNG from a command line. The coupling ran deep: CommandLineArgs was a @Parameter-annotated POJO, TestNG held a static JCommander field, and TestNG.configure(CommandLineArgs) mixed applying configuration with CLI-only string-to-object conversion. The front end now lives in two new modules: testng-cli CliOptions, CliConfigurer, AbstractCliRunner - no parser testng-jcommander the JCommander implementation, plus Converter testng-core keeps a minimal ServiceLoader SPI, ITestNGCliRunner, so that "java -cp testng.jar org.testng.TestNG suite.xml" is unchanged: both modules are bundled into the merged jar. Implementations never terminate the JVM - an unusable command line comes back as a TestNGException, and only TestNG.main turns it into a message, a usage banner and exit code 1. TestNG.setThreadCount now raises a TestNGException below 1 instead of printing the usage banner and calling System.exit(1), so that no library setter can kill an embedder's JVM. The command line output is unchanged: TestNG.main turns that exception into the same message and the same exit code. Backward compatibility for 7.x is kept through frozen @deprecated shims: CommandLineArgs (annotations stripped), TestNG.configure(CommandLineArgs), TestNG.validateCommandLineParameters, TestNG.main and TestNG.privateMain. TestNG.configure(Map), the method Maven Surefire calls, still builds a CommandLineArgs, so removing that class depends on Surefire moving first. CliConfigurerParityTest compares the state both paths produce, field by field, because nothing else keeps the frozen copy in sync with the live one. testng-test-kit becomes the shared test-fixture library, so the 22 tests whose subject is the command line could move to testng-jcommander. The 243 classes extending SimpleBaseTest are unaffected. The two modules are deliberately not published on their own, and are kept out of the BOM for the same reason: that would ship org.testng.cli.* and its service registration in two artifacts at once. It is a packaging change for the next major, tracked in testng-team#3301. Supersedes testng-team#2612.

@deprecated

testng-core depended on org.jcommander:jcommander in `api` scope, so every consumer got the parsing library whether or not it drove TestNG from a command line. The coupling ran deep: CommandLineArgs was a @Parameter-annotated POJO, TestNG held a static JCommander field, and TestNG.configure(CommandLineArgs) mixed applying configuration with CLI-only string-to-object conversion. The front end now lives in two new modules: testng-cli CliOptions, CliConfigurer, AbstractCliRunner - no parser testng-jcommander the JCommander implementation, plus Converter testng-core keeps a minimal ServiceLoader SPI, ITestNGCliRunner, so that "java -cp testng.jar org.testng.TestNG suite.xml" is unchanged: both modules are bundled into the merged jar. Implementations never terminate the JVM - an unusable command line comes back as a TestNGException, and only TestNG.main turns it into a message, a usage banner and exit code 1. TestNG.setThreadCount now raises a TestNGException below 1 instead of printing the usage banner and calling System.exit(1), so that no library setter can kill an embedder's JVM. The command line output is unchanged: TestNG.main turns that exception into the same message and the same exit code. Backward compatibility for 7.x is kept through frozen @deprecated shims: CommandLineArgs (annotations stripped), TestNG.configure(CommandLineArgs), TestNG.validateCommandLineParameters, TestNG.main and TestNG.privateMain. TestNG.configure(Map), the method Maven Surefire calls, still builds a CommandLineArgs, so removing that class depends on Surefire moving first. CliConfigurerParityTest compares the state both paths produce, field by field, because nothing else keeps the frozen copy in sync with the live one. testng-test-kit becomes the shared test-fixture library, so the 22 tests whose subject is the command line could move to testng-jcommander. The 243 classes extending SimpleBaseTest are unaffected. The two modules are deliberately not published on their own, and are kept out of the BOM for the same reason: that would ship org.testng.cli.* and its service registration in two artifacts at once. It is a packaging change for the next major, tracked in testng-team#3301. Supersedes testng-team#2612.

juherr added 3 commits July 4, 2021 21:13

Extract cli logic from TestNG

8823687

Move Jcommander into its own module

e04b883

Update CHANGES

4af5964

juherr added the Runner: CLI Running TestNG from the command line label Jul 16, 2021

juherr requested a review from krmahadevan July 16, 2021 20:42

Add jcommander module into bom

7f4105c

Autostyle fix

fd54977

juherr marked this pull request as draft July 18, 2021 11:05

juherr added 4 commits July 24, 2021 22:56

Fix tests

6feb083

Add module in BOM

56ca68e

Fix style

f80bee2

Merge remote-tracking branch 'upstream/master' into feature/picocli

7a71b49

This was referenced Jul 29, 2026

Next major: drop Java 11, move to Guice 7 and JCommander 3 #3301

Open

refactor(core): extract the command line front end out of testng-core #3307

Open

juherr closed this Jul 29, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Extract CLI logic from TestNG core - #2612

Extract CLI logic from TestNG core#2612
juherr wants to merge 9 commits into
testng-team:masterfrom
juherr:feature/picocli

juherr commented Jul 16, 2021

Uh oh!

krmahadevan commented Jul 17, 2021

Uh oh!

krmahadevan commented Jul 18, 2021

Uh oh!

juherr commented Jul 18, 2021

Uh oh!

krmahadevan commented Jul 18, 2021

Uh oh!

juherr commented Jul 29, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

juherr commented Jul 16, 2021

Did you remember to?

Uh oh!

krmahadevan commented Jul 17, 2021

Uh oh!

krmahadevan commented Jul 18, 2021

Uh oh!

juherr commented Jul 18, 2021

Uh oh!

krmahadevan commented Jul 18, 2021

Uh oh!

juherr commented Jul 29, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants