DockerControllerSpecSupport

trait DockerControllerSpecSupport extends SuiteMixin with DockerControllerHelper with RandomPortUtil
trait RandomPortUtil
trait DockerControllerHelper
trait SuiteMixin
class Object
trait Matchable
class Any

Type members

Inherited classlikes

case class WaitPredicateSetting(awaitDuration: Duration, waitPredicate: WaitPredicate)

Value members

Concrete methods

protected def afterCreateContainers(): Unit
protected def afterRemoveContainers(): Unit
protected def afterStartContainers(): Unit
protected def afterStopContainers(): Unit
protected def beforeCreateContainers(): Unit
protected def beforeRemoveContainers(): Unit
protected def beforeStartContainers(): Unit
protected def beforeStopContainers(): Unit
protected def createDockerContainers(createRemoveLifecycle: Value, testName: Option[String]): Boolean
protected def removeDockerContainers(createRemoveLifecycle: Value, testName: Option[String]): Boolean
def run(testName: Option[String], args: Args): Status
protected def runTest(testName: String, args: Args): Status
protected def startDockerContainers(startStopLifecycle: Value, testName: Option[String]): Boolean
protected def startStopLifecycle: Value
protected def stopDockerContainers(startStopLifecycle: Value, testName: Option[String]): Boolean

Inherited methods

protected def afterDockerContainerCreated(dockerController: DockerController, testName: Option[String]): Unit
Inherited from
DockerControllerHelper
protected def afterDockerContainerRemoved(dockerController: DockerController, testName: Option[String]): Unit
Inherited from
DockerControllerHelper
protected def afterDockerContainerStopped(dockerController: DockerController, testName: Option[String]): Unit
Inherited from
DockerControllerHelper
protected def afterDocketContainerStarted(dockerController: DockerController, testName: Option[String]): Unit
Inherited from
DockerControllerHelper
protected def beforeDockerContainerCreate(dockerController: DockerController, testName: Option[String]): Unit
Inherited from
DockerControllerHelper
protected def beforeDockerContainerRemove(dockerController: DockerController, testName: Option[String]): Unit
Inherited from
DockerControllerHelper
protected def beforeDockerContainerStop(dockerController: DockerController, testName: Option[String]): Unit
Inherited from
DockerControllerHelper
protected def beforeDocketContainerStart(dockerController: DockerController, testName: Option[String]): Unit
Inherited from
DockerControllerHelper
protected def createDockerContainer(dockerController: DockerController, testName: Option[String]): Unit
Inherited from
DockerControllerHelper
def expectedTestCount(filter: Filter): Int

The total number of tests that are expected to run when this <code>Suite</code>'s <code>run</code> method is invoked.

The total number of tests that are expected to run when this <code>Suite</code>'s <code>run</code> method is invoked.

Value Params
filter

a <code>Filter</code> with which to filter tests to count based on their tags

Inherited from
SuiteMixin
def nestedSuites: IndexedSeq[Suite]

An immutable <code>IndexedSeq</code> of this <code>SuiteMixin</code> object's nested <code>Suite</code>s. If this <code>SuiteMixin</code> contains no nested <code>Suite</code>s, this method returns an empty <code>IndexedSeq</code>.

An immutable <code>IndexedSeq</code> of this <code>SuiteMixin</code> object's nested <code>Suite</code>s. If this <code>SuiteMixin</code> contains no nested <code>Suite</code>s, this method returns an empty <code>IndexedSeq</code>.

Inherited from
SuiteMixin
protected def removeDockerContainer(dockerController: DockerController, testName: Option[String]): Unit
Inherited from
DockerControllerHelper
def rerunner: Option[String]

The fully qualified name of the class that can be used to rerun this suite.

The fully qualified name of the class that can be used to rerun this suite.

Inherited from
SuiteMixin
protected def runNestedSuites(args: Args): Status

Runs zero to many of this suite's nested suites.

Runs zero to many of this suite's nested suites.

Value Params
args

the <code>Args</code> for this run

Returns

a <code>Status</code> object that indicates when all nested suites started by this method have completed, and whether or not a failure occurred.

Throws
NullArgumentException

if <code>args</code> is <code>null</code>.

Inherited from
SuiteMixin
protected def runTests(testName: Option[String], args: Args): Status

Runs zero to many of this suite's tests.

Runs zero to many of this suite's tests.

Value Params
args

the <code>Args</code> for this run

testName

an optional name of one test to run. If <code>None</code>, all relevant tests should be run. I.e., <code>None</code> acts like a wildcard that means run all relevant tests in this <code>Suite</code>.

Returns

a <code>Status</code> object that indicates when all tests started by this method have completed, and whether or not a failure occurred.

Throws
NullArgumentException

if either <code>testName</code> or <code>args</code> is <code>null</code>.

Inherited from
SuiteMixin
protected def startDockerContainer(dockerController: DockerController, testName: Option[String]): Unit
Inherited from
DockerControllerHelper
protected def stopDockerContainer(dockerController: DockerController, testName: Option[String]): Unit
Inherited from
DockerControllerHelper
def suiteId: String

A string ID for this <code>Suite</code> that is intended to be unique among all suites reported during a run.

A string ID for this <code>Suite</code> that is intended to be unique among all suites reported during a run.

The suite ID is <em>intended</em> to be unique, because ScalaTest does not enforce that it is unique. If it is not unique, then you may not be able to uniquely identify a particular test of a particular suite. This ability is used, for example, to dynamically tag tests as having failed in the previous run when rerunning only failed tests.

Returns

this <code>Suite</code> object's ID.

Inherited from
SuiteMixin
def suiteName: String

A user-friendly suite name for this <code>Suite</code>.

A user-friendly suite name for this <code>Suite</code>.

This trait's implementation of this method returns the simple name of this object's class. This trait's implementation of <code>runNestedSuites</code> calls this method to obtain a name for <code>Report</code>s to pass to the <code>suiteStarting</code>, <code>suiteCompleted</code>, and <code>suiteAborted</code> methods of the <code>Reporter</code>.

Returns

this <code>Suite</code> object's suite name.

Inherited from
SuiteMixin
def tags: Map[String, Set[String]]

A <code>Map</code> whose keys are <code>String</code> names of tagged tests and whose associated values are the <code>Set</code> of tag names for the test. If a test has no associated tags, its name does not appear as a key in the returned <code>Map</code>. If this <code>Suite</code> contains no tests with tags, this method returns an empty <code>Map</code>.

A <code>Map</code> whose keys are <code>String</code> names of tagged tests and whose associated values are the <code>Set</code> of tag names for the test. If a test has no associated tags, its name does not appear as a key in the returned <code>Map</code>. If this <code>Suite</code> contains no tests with tags, this method returns an empty <code>Map</code>.

Subclasses may override this method to define and/or discover tags in a custom manner, but overriding method implementations should never return an empty <code>Set</code> as a value. If a test has no tags, its name should not appear as a key in the returned <code>Map</code>.

Inherited from
SuiteMixin
def temporaryServerAddress(interface: String): InetSocketAddress
Inherited from
RandomPortUtil
def temporaryServerHostnameAndPort(interface: String): (String, Int)
Inherited from
RandomPortUtil
def temporaryServerPort(interface: String): Int
Inherited from
RandomPortUtil
def testDataFor(testName: String, theConfigMap: ConfigMap): TestData

Provides a <code>TestData</code> instance for the passed test name, given the passed config map.

Provides a <code>TestData</code> instance for the passed test name, given the passed config map.

This method is used to obtain a <code>TestData</code> instance to pass to <code>withFixture(NoArgTest)</code> and <code>withFixture(OneArgTest)</code> and the <code>beforeEach</code> and <code>afterEach</code> methods of trait <code>BeforeAndAfterEach</code>.

Value Params
testName

the name of the test for which to return a <code>TestData</code> instance

theConfigMap

the config map to include in the returned <code>TestData</code>

Returns

a <code>TestData</code> instance for the specified test, which includes the specified config map

Inherited from
SuiteMixin
def testNames: Set[String]

A <code>Set</code> of test names. If this <code>Suite</code> contains no tests, this method returns an empty <code>Set</code>.

A <code>Set</code> of test names. If this <code>Suite</code> contains no tests, this method returns an empty <code>Set</code>.

Although subclass and subtrait implementations of this method may return a <code>Set</code> whose iterator produces <code>String</code> test names in a well-defined order, the contract of this method does not required a defined order. Subclasses are free to implement this method and return test names in either a defined or undefined order.

Inherited from
SuiteMixin

Inherited fields

protected val dockerClient: DockerClient
Inherited from
DockerControllerHelper
protected val dockerClientConfig: DockerClientConfig
Inherited from
DockerControllerHelper
protected val dockerControllers: Vector[DockerController]
Inherited from
DockerControllerHelper
protected val dockerHost: String
Inherited from
DockerControllerHelper
protected val dockerHttpClient: DockerHttpClient
Inherited from
DockerControllerHelper
protected val logger: Logger
Inherited from
DockerControllerHelper
protected val waitPredicatesSettings: Map[DockerController, WaitPredicateSetting]
Inherited from
DockerControllerHelper

Deprecated and Inherited fields

@deprecated("The styleName lifecycle method has been deprecated and will be removed in a future version of ScalaTest with no replacement.", "3.1.0")
val styleName: String

<strong>The <code>styleName</code> lifecycle method has been deprecated and will be removed in a future version of ScalaTest.</strong>

<strong>The <code>styleName</code> lifecycle method has been deprecated and will be removed in a future version of ScalaTest.</strong>

This method was used to support the chosen styles feature, which was deactivated in 3.1.0. The internal modularization of ScalaTest in 3.2.0 will replace chosen styles as the tool to encourage consistency across a project. We do not plan a replacement for <code>styleName</code>.

Deprecated
Inherited from
SuiteMixin