org.scalatestplus.junit.JUnitWrapperSuite.scala Maven / Gradle / Ivy
/*
* Copyright 2001-2013 Artima, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.scalatestplus.junit;
import org.scalatest._
import java.lang.reflect
import java.util.Collections
import java.util.HashSet
import java.util.regex.Pattern
import org.junit.runner.Description
import org.junit.runner.JUnitCore
import org.junit.runner.Request
import org.junit.runner.Result
import org.junit.runner.notification.Failure
import org.junit.runner.notification.RunListener
import org.scalatest.Suite
/**
*
* A wrapper to allow JUnit tests to be run by the ScalaTest runner.
*
*
*
* Instances of this trait are not thread safe.
*
*
* @param junitClassName Fully qualified name of the JUnit suite
* @param loader Class loader to load the JUnit suite
*
* @author Bill Venners
* @author Daniel Watson
* @author Joel Neely
* @author George Berger
*/
class JUnitWrapperSuite(junitClassName: String, loader: ClassLoader) extends Suite {
// TODO: This may need to be made thread safe, because who
// knows what Thread JUnit will fire through this
private var theTracker = new Tracker
private val junitClass = Class.forName(junitClassName, false, loader)
/**
* Overrides to use JUnit to run the tests.
*
* @param testName an optional name of one test to run. If None, all relevant tests should be run.
* I.e., None acts like a wildcard that means run all relevant tests in this Suite.
* @param args the Args for this run
* @return a Status object that indicates when all tests and nested suites started by this method have completed, and whether or not a failure occurred.
*
*/
override def run(testName: Option[String], args: Args): Status = {
import args._
theTracker = tracker
val status = new StatefulStatus
val jUnitCore = new JUnitCore
jUnitCore.addListener(new MyRunListener(reporter, configMap, tracker, status))
jUnitCore.run(junitClass)
status.setCompleted()
status
}
/**
* Overrides to use JUnit's API to retrieve the expected test count.
*
* @param filter a Filter with which to filter tests to count based on their tags
* @return number of expected test count
*/
override def expectedTestCount(filter: Filter): Int = {
getRequest().getRunner.getDescription.testCount
}
/**
* Retrieves a JUnit4 Request object for the junit test
* class.
*
* The JUnit Request.classes() method has different
* signatures in different versions of JUnit4, so reflection
* is used here to identify and use whichever version is
* available in the junit jar on the user's classpath.
*
* @return JUnit4 Request object for the junit test class
*/
def getRequest(): Request = {
var classArgs = new Array[Class[_]](1)
classArgs(0) = junitClass
val requestClass =
try { Class.forName("org.junit.runner.Request") }
catch {
case e: ClassNotFoundException =>
throw new RuntimeException(
"Could not find class: org.junit.runner.Request. " +
"Note: a junit4 jar must be included on " +
"the classpath if using the -j option.")
}
try { // works for junit-4.4.jar
val method = requestClass.getMethod("classes", classOf[String],
classOf[Array[Class[_]]])
val result = method.invoke(null, "", classArgs)
result.asInstanceOf[Request]
}
catch {
case e: NoSuchMethodException =>
try { // works for junit-4.6.jar
val method = requestClass.getMethod("classes",
classOf[Array[Class[_]]])
val result = method.invoke(null, classArgs)
result.asInstanceOf[Request]
}
catch {
case e: NoSuchMethodException =>
throw new RuntimeException("Could not find method " +
"org.junit.runner.Request.classes. " +
"Possibly a junit version problem. " +
"Try junit-4.6.jar.")
}
}
}
/**
* Throws UnsupportedOperationException, because this method is unused by this
* class, given this class's run method delegates to JUnit to run
* its tests.
*
*
* The main purpose of this method implementation is to render a compiler error an attempt
* to mix in a trait that overrides runNestedSuites. Because this
* trait does not actually use runNestedSuites, the attempt to mix
* in behavior would very likely not work.
*
*
* @param args the Args for this run
*
* @throws UnsupportedOperationException always.
*/
override final protected def runNestedSuites(args: Args): Status = {
throw new UnsupportedOperationException
}
/**
* Throws UnsupportedOperationException, because this method is unused by this
* class, given this class's run method delegates to JUnit to run
* its tests.
*
*
* The main purpose of this method implementation is to render a compiler error an attempt
* to mix in a trait that overrides runTests. Because this
* trait does not actually use runTests, the attempt to mix
* in behavior would very likely not work.
*
*
* @param testName an optional name of one test to run. If None, all relevant tests should be run.
* I.e., None acts like a wildcard that means run all relevant tests in this Suite.
* @param args the Args for this run
*
* @throws UnsupportedOperationException always.
*/
override protected final def runTests(testName: Option[String], args: Args): Status = {
throw new UnsupportedOperationException
}
/**
* Throws UnsupportedOperationException, because this method is unused by this
* class, given this class's run method delegates to JUnit to run
* its tests.
*
*
* The main purpose of this method implementation is to render a compiler error an attempt
* to mix in a trait that overrides runTest. Because this
* trait does not actually use runTest, the attempt to mix
* in behavior would very likely not work.
*
*
* @param testName the name of one test to run.
* @param args the Args for this run
*
* @throws UnsupportedOperationException always.
*/
override protected final def runTest(testName: String, args: Args): Status = {
throw new UnsupportedOperationException
}
override def suiteId: String = junitClassName
}