Not registered yet?
Register now! It is easy and done in 1 minute and gives you access to special discounts and much more!
I would like to run JUnit test cases from the command line.
How can I do this?
For JUnit 5.x it's:
java -jar junit-platform-console-standalone-<version>.jar <Options>
Find a brief summary at https://stackoverflow.com/a/52373592/1431016 and full details at https://junit.org/junit5/docs/current/user-guide/#running-tests-console-launcher
For JUnit 4.X it's really:
java -cp .:/usr/share/java/junit.jar org.junit.runner.JUnitCore [test class name]
But if you are using JUnit 3.X note the class name is different:
java -cp .:/usr/share/java/junit.jar junit.textui.TestRunner [test class name]
You might need to add more JARs or directories with your class files to the classpath and separate that with semicolons (Windows) or colons (UNIX/Linux). It depends on your environment.
Edit: I've added current directory as an example. Depends on your environment and how you build your application (can be bin/ or build/ or even my_application.jar etc). Note Java 6+ does support globs in classpath, you can do:
java -cp lib/*.jar:/usr/share/java/junit.jar ...
Hope it helps. Write tests! :-)
@Izap Any idea to programatically determine whether a test is using JUnit4 or JUnit3?
Class.forName I guess. It's been years I was programming in Java for the last time...
and what if you are using android?
Then try the first command, if it does not work the latter. Or read Android docs... dunno.
If the version of your JUnit jar is at least 4.0, then you should be able to use org.junit.runner.JUnitCore as your main class, that that will work whether your tests are written in JUnit3-style or JUnit4-style.
Documentation for the "-cp" argument (i.e. the CLASSPATH) is here (Java 7, Unix) and here (Tutorial) and here (Java 8, Unix) and here (Java 8, Windows). Apparently wildcards in the classpath are now supported.
That works well, however I'd like to give another argument to the test (the url it should go to) how can I do that? How can I get it inside the Java code?
Downvote. For JUnit 4.x it's not right. Your instructions give "Could not find class: [test class name]" Even when [test class name] is in the classpath.
If you use Maven, you can run the following command to run all your test cases:
mvn clean test
Or you can run a particular test as below
mvn clean test -Dtest=your.package.TestClassName
mvn clean test -Dtest=your.package.TestClassName#particularMethod
If you would like to see the stack trace (if any) in the console instead of report files in the target\surefire-reports folder, set the user property surefire.useFile to false. For example:
mvn clean test -Dtest=your.package.TestClassName -Dsurefire.useFile=false
If you use Gradle, you can run the following command to run all your test cases:
gradle test --tests your.package.TestClassName
gradle test --tests your.package.TestClassName.particularMethod
If you would like more information, you can consider options such as --stacktrace, or --info, or --debug.
For example, when you run Gradle with the info logging level --info, it will show you the result of each test while they are running. If there is any exception, it will show you the stack trace, pointing out what the problem is.
gradle test --info
If you would like to see the overall test results, you can open the report in the browser, for example (Open it using Google Chrome in Ubuntu):
Once you set up your Ant build file build.xml, you can run your JUnit test cases from the command line as below:
ant -f build.xml <Your JUnit test target name>
You can follow the link below to read more about how to configure JUnit tests in the Ant build file:
If you do not use Maven, or Gradle or Ant, you can follow the following way:
First of all, you need to compile your test cases. For example (in Linux):
javac -d /absolute/path/for/compiled/classes -cp /absolute/path/to/junit-4.12.jar /absolute/path/to/TestClassName.java
Then run your test cases. For example:
java -cp /absolute/path/for/compiled/classes:/absolute/path/to/junit-4.12.jar:/absolute/path/to/hamcrest-core-1.3.jar org.junit.runner.JUnitCore your.package.TestClassName
I like that this answer has examples for multiple technologies, kudos!
what about groovy tests using the last approach?
Personally I would use the Maven surefire JUnit runner to do that.
With JUnit 4.12 the following didn't work for me:
Apparently, from JUnit 4.11 onwards you should also include hamcrest-core.jar in your classpath:
java -cp .:/usr/share/java/junit.jar:/usr/share/java/hamcrest-core.jar org.junit.runner.JUnitCore [test class name]
Had the same issue with JUnit 4.12. Came up with a similar solution, but it didn't work for me, failing to load JUnitCore. I basically switched to JUnit 4.8.2 as it does not require to include hamcrest-core.jar in the classpath.
Confirmed that this must be done with JUnit 4.12. +1.
This worked for me: java -cp .:/usr/share/java/junit4.jar org.junit.runner.JUnitCore [test class name]
java -cp .:/usr/share/java/junit4.jar org.junit.runner.JUnitCore [test class name]
Alternatively you can use the following methods in JunitCore class http://junit.sourceforge.net/javadoc/org/junit/runner/JUnitCore.html
run (with Request , Class classes and Runner) or runClasses from your java file.
If your project is Maven-based you can run all test-methods from test-class CustomTest which belongs to module 'my-module' using next command:
mvn clean test -pl :my-module -Dtest=CustomTest
Or run only 1 test-method myMethod from test-class CustomTest using next command:
mvn clean test -pl :my-module -Dtest=CustomTest#myMethod
For this ability you need Maven Surefire Plugin v.2.7.3+ and Junit 4.
More details is here: http://maven.apache.org/surefire/maven-surefire-plugin/examples/single-test.html
In windows it is
java -cp .;/path/junit.jar org.junit.runner.JUnitCore TestClass [test class name without .class extension]
java -cp .;/path/junit.jar org.junit.runner.JUnitCore TestClass
c:\>java -cp .;f:/libraries/junit-4.8.2 org.junit.runner.JUnitCore TestSample1 TestSample2 ... and so on, if one has more than one test classes.
c:\>java -cp .;f:/libraries/junit-4.8.2 org.junit.runner.JUnitCore TestSample1 TestSample2 ...
-cp stands for class path and the dot (.) represents the existing classpath while semi colon (;) appends the additional given jar to the classpath , as in above example junit-4.8.2 is now available in classpath to execute JUnitCore class that here we have used to execute our test classes.
Above command line statement helps you to execute junit (version 4+) tests from command prompt(i-e MSDos).
Note: JUnitCore is a facade to execute junit tests, this facade is included in 4+ versions of junit.
Please explain your answer in very brief.
It is already very brief.
I did not ask you to keep your answer brief. I requested to add some explanation (at least a brief explanation). It is a good practice to explain how your answer work. Readers may understand it, like it, upvote it.
so if I had a supplemental testing jar AND the vanilla junit jar, Id have to have both of those in java -cp command for anything to actually work? Is there a way around having to put all this into a command line so that I don't have to type as much stuff?
Actually you can also make the Junit test a runnable Jar and call the runnable jar as
How is this done?
I would also like to know. That sounds really cool.
In Eclipse , right click your JUnit project -> Click on Export --> Choose Java-> Runnable Jar File
The answer that @lzap gave is a good solution. However, I would like to add that you should add . to the class path, so that your current directory is not left out, resulting in your own classes to be left out. This has happened to me on some platforms. So an updated version for JUnit 4.x would be:
is that supposed to be a semi colon?
@panny it's a semicolon on Windows. On n *nix environment (at least OSX and all the Linux distros I've used) you use a colon.
@rand_acs does the test class name need to be the fully classified class name ?
@Goaler444 Yes, I always use the full name, with all the namespaces specified.
Good point, edited. Thanks.
Ensure that JUnit.jar is in your classpath, then invoke the command line runner from the console
java org.junit.runner.JUnitCore [test class name]
java org.junit.runner.JUnitCore [test class name]
Reference: junit FAQ
you also need to set up the rest of your project's classpath.
This just gives "Could not find class: [test class name]" even when [test class name] is in the classpath.
If you project is ant based then you should be able to do something like this from the console:
If this doesn't work, but still your project is ant based, you can run ant -p to list the main targets of the project.
the Q has nothing to do with ant
That's why I said "if your project is ant based". Note also that the OP may don't know about ant.
I had this dillema, unit test files were not in folder marked as source by eclipse. That project uses ant to build, this was the proper way to run those JUnit tests.