scala.tools.nsc.interactive.tests.InteractiveTest

A base class for writing interactive compiler tests.

This class tries to cover common functionality needed when testing the presentation compiler: instantiation source files, reloading, creating positions, instantiating the presentation compiler, random stress testing.

By default, this class loads all scala and java classes found under src/, going recursively into subfolders. Loaded classes are found in sourceFiles. trait TestResources The presentation compiler is available through compiler.

It is easy to test member completion, type and hyperlinking at a given position. Source files are searched for TextMarkers. By default, the completion marker is /*!*/, the typedAt marker is/*?*/ and the hyperlinking marker is /*#*/. Place these markers in your source files, and the test framework will automatically pick them up and test the corresponding actions. Sources are reloaded byaskReload(sourceFiles)(blocking call). All ask operations are placed on the work queue without waiting for each one to complete before asking the next. After all asks, it waits for each response in turn and prints the result. The default timeout is 1 second per operation.

To define a custom operation you have to:

(1) Define a new marker by extending TestMarker (2) Provide an implementation for the operation you want to check by extending PresentationCompilerTestDef (3) Add the class defined in (1) to the set of executed test actions by calling ++ on InteractiveTest.

Then you can simply use the new defined marker in your test sources and the testing framework will automatically pick it up.

Self Type: InteractiveTest
Source: InteractiveTest.scala
See also: Check existing tests under test/files/presentation

Linear Supertypes

InteractiveTestSettings, CoreTestDefs, PresentationCompilerRequestsWorkingMode, TestResources, TestSettings, PresentationCompilerInstance, AskLoadedTyped, AskReload, AskShutdown, AskParse, AskCommand, AnyRef, Any

Instance Constructors

new InteractiveTest()

Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
def ++(tests: PresentationCompilerTestDef*): Unit

Add new presentation compiler actions to test.
Add new presentation compiler actions to test. Presentation compiler's test need to extends trait PresentationCompilerTestDef.

Attributes
protected
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
final val TIMEOUT: Int(10000)

Attributes
protected
Definition Classes
TestSettings
val argsString: String

If there's a file ending in .
If there's a file ending in .opts, read it and parse it for cmd line arguments.

Attributes
protected
Definition Classes
InteractiveTestSettings
final def asInstanceOf[T0]: T0

Definition Classes
Any
def ask[T](op: (Response[T]) ⇒ Unit): Response[T]

Presentation compiler's askXXX actions work by doing side-effects on a Response instance passed as an argument during the askXXX call.
Presentation compiler's askXXX actions work by doing side-effects on a Response instance passed as an argument during the askXXX call. The defined method ask is meant to encapsulate this behavior.

Attributes
protected
Definition Classes
AskCommand
def askAllSources[T]: (TestMarker) ⇒ ((Position) ⇒ Response[T]) ⇒ ((Position, T) ⇒ Unit) ⇒ Unit

Attributes
protected
Definition Classes
PresentationCompilerRequestsWorkingMode
def askLoadedTyped(source: SourceFile)(implicit reporter: Reporter): Response[Tree]

Attributes
protected
Definition Classes
AskLoadedTyped
def askParse(sources: Seq[SourceFile]): Unit

sources need to be entirely parsed before running the test (else commands such as AskCompletionAt may fail simply because the source's AST is not yet loaded).
sources need to be entirely parsed before running the test (else commands such as AskCompletionAt may fail simply because the source's AST is not yet loaded).

Definition Classes
AskParse
def askReload(sources: Seq[SourceFile])(implicit reporter: Reporter): Response[Unit]

Reload the given source files and wait for them to be reloaded.
Reload the given source files and wait for them to be reloaded.

Attributes
protected
Definition Classes
AskReload
def askShutdown(): Unit

Definition Classes
AskShutdown
val baseDir: Path

The base directory for this test, usually a subdirectory of "test/files/presentation/"
The base directory for this test, usually a subdirectory of "test/files/presentation/"

Attributes
protected
Definition Classes
TestSettings
def clone(): AnyRef

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws()
lazy val compiler: Global

Attributes
protected
Definition Classes
PresentationCompilerInstance
val compilerReporter: StoreReporter

Attributes
protected
Definition Classes
PresentationCompilerInstance
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def main(args: Array[String]): Unit

Test's entry point
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val outDir: Path

The root directory for this test suite, usually the test kind ("test/files/presentation").
The root directory for this test suite, usually the test kind ("test/files/presentation").

Attributes
protected
Definition Classes
TestSettings
def prepareSettings(settings: Settings): Unit

Prepare the settings object.
Prepare the settings object. Load the .opts file and adjust all paths from the Unix-like syntax to the platform specific syntax. This is necessary so that a single .opts file can be used on all platforms.

Attributes
protected
Definition Classes
InteractiveTestSettings → PresentationCompilerInstance
Note
Bootclasspath is treated specially. If there is a -bootclasspath option in the file, the 'usejavacp' setting is set to false. This ensures that the bootclasspath takes precedence over the scala-library used to run the current test.
def printClassPath(implicit reporter: Reporter): Unit

Attributes
protected
Definition Classes
InteractiveTestSettings → PresentationCompilerInstance
implicit val reporter: Reporter

Attributes
protected
Definition Classes
TestSettings
val runRandomTests: Boolean

Attributes
protected
def runTests(): Unit

Run all defined PresentationCompilerTestDef
Run all defined PresentationCompilerTestDef

Attributes
protected
val settings: Settings

Attributes
protected
Definition Classes
PresentationCompilerInstance
def shutdown(): Unit

shutdown the presentation compiler.
shutdown the presentation compiler.

Attributes
protected
val sourceDir: String

Where source files are placed.
Where source files are placed.

Attributes
protected
Definition Classes
TestSettings
lazy val sourceFiles: Array[SourceFile]

collected source files that are to be used by the test runner
collected source files that are to be used by the test runner

Attributes
protected
Definition Classes
TestResources
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val synchronousRequests: Boolean

Should askAllSources wait for each ask to finish before issuing the next?
Should askAllSources wait for each ask to finish before issuing the next?

Attributes
protected
Definition Classes
InteractiveTest → PresentationCompilerRequestsWorkingMode
lazy val testActions: ListBuffer[PresentationCompilerTestDef]

The core set of test actions that are executed during each test run are CompletionAction, TypeAction and HyperlinkAction.
The core set of test actions that are executed during each test run are CompletionAction, TypeAction and HyperlinkAction. Override this member if you need to change the default set of executed test actions.

Attributes
protected
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws()
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws()
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws()

InteractiveTest

abstract class InteractiveTest extends AskParse with AskShutdown with AskReload with AskLoadedTyped with PresentationCompilerInstance with CoreTestDefs with InteractiveTestSettings

Instance Constructors

new InteractiveTest()

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

def ++(tests: PresentationCompilerTestDef*): Unit

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final val TIMEOUT: Int(10000)

val argsString: String

final def asInstanceOf[T0]: T0

def ask[T](op: (Response[T]) ⇒ Unit): Response[T]

def askAllSources[T]: (TestMarker) ⇒ ((Position) ⇒ Response[T]) ⇒ ((Position, T) ⇒ Unit) ⇒ Unit

def askLoadedTyped(source: SourceFile)(implicit reporter: Reporter): Response[Tree]

def askParse(sources: Seq[SourceFile]): Unit

def askReload(sources: Seq[SourceFile])(implicit reporter: Reporter): Response[Unit]

def askShutdown(): Unit

val baseDir: Path

def clone(): AnyRef

lazy val compiler: Global

val compilerReporter: StoreReporter

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def main(args: Array[String]): Unit

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val outDir: Path

def prepareSettings(settings: Settings): Unit

def printClassPath(implicit reporter: Reporter): Unit

implicit val reporter: Reporter

val runRandomTests: Boolean

def runTests(): Unit

val settings: Settings

def shutdown(): Unit

val sourceDir: String

lazy val sourceFiles: Array[SourceFile]

final def synchronized[T0](arg0: ⇒ T0): T0

val synchronousRequests: Boolean

lazy val testActions: ListBuffer[PresentationCompilerTestDef]

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from InteractiveTestSettings

Inherited from CoreTestDefs

Inherited from PresentationCompilerRequestsWorkingMode

Inherited from TestResources

Inherited from TestSettings

Inherited from PresentationCompilerInstance

Inherited from AskLoadedTyped

Inherited from AskReload

Inherited from AskShutdown

Inherited from AskParse

Inherited from AskCommand

Inherited from AnyRef

Inherited from Any