docs
API
Generated with
docs/scalus/scalus.testing/scalus.testing.yaci/YaciDevKit

YaciDevKit

scalus.testing.yaci.YaciDevKit
trait YaciDevKit extends IntegrationTest

Base trait for integration tests using Yaci DevKit with ScalaTest

This trait extends IntegrationTest and forces Yaci environment (ignores SCALUS_TEST_ENV). Use createYaciContext() to get a scalus.testing.integration.YaciTestContext with:

  • Multi-party access (alice, bob, eve)
  • Full HD account access via account (Party.Alice with stake, drep, change keys)
  • Pre-registered pool ID for staking tests

For multi-environment tests, use IntegrationTest directly instead.

Usage:

class MyIntegrationTest extends AnyFunSuite with YaciDevKit {
 test("submit transaction to devnet") {
   val ctx = createYaciContext()
   // ctx.account provides full HD wallet access (Party.Alice)
   // ctx.alice, ctx.bob, ctx.eve for multi-party scenarios
 }
}

The trait supports container reuse across test runs for faster iteration. Override yaciConfig to customize behavior:

override def yaciConfig = YaciConfig(
 enableLogs = true,
 reuseContainer = true
)

Attributes

Graph
Supertypes
trait ScalusTest
trait Assertions
trait TripleEquals
trait TripleEqualsSupport
trait BeforeAndAfterAll
trait SuiteMixin
class Object
trait Matchable
class Any
Show all
Self type
Suite

Members list

Type members

Inherited classlikes

class CheckingEqualizer[L](val leftSide: L)

Class used via an implicit conversion to enable two objects to be compared with === and !== with a Boolean result and an enforced type constraint between two object types. For example:

Class used via an implicit conversion to enable two objects to be compared with === and !== with a Boolean result and an enforced type constraint between two object types. For example:

assert(a === b)
assert(c !== d)

You can also check numeric values against another with a tolerance. Here are some examples:

assert(a === (2.0 +- 0.1))
assert(c !== (2.0 +- 0.1))

Value parameters

leftSide

An object to convert to Equalizer, which represents the value on the left side of a === or !== invocation.

Attributes

Inherited from:
TripleEqualsSupport
Supertypes
class Object
trait Matchable
class Any
class Equalizer[L](val leftSide: L)

Class used via an implicit conversion to enable any two objects to be compared with === and !== with a Boolean result and no enforced type constraint between two object types. For example:

Class used via an implicit conversion to enable any two objects to be compared with === and !== with a Boolean result and no enforced type constraint between two object types. For example:

assert(a === b)
assert(c !== d)

You can also check numeric values against another with a tolerance. Here are some examples:

assert(a === (2.0 +- 0.1))
assert(c !== (2.0 +- 0.1))

Value parameters

leftSide

An object to convert to Equalizer, which represents the value on the left side of a === or !== invocation.

Attributes

Inherited from:
TripleEqualsSupport
Supertypes
class Object
trait Matchable
class Any
object UseDefaultAssertions

Attributes

Inherited from:
Assertions
Supertypes
class Object
trait Matchable
class Any

Value members

Concrete methods

def container: YaciCardanoContainer

Get the running container

Get the running container

Attributes

Inherited methods

def !==[T](right: Spread[T]): TripleEqualsInvocationOnSpread[T]

Returns a TripleEqualsInvocationOnSpread[T], given an Spread[T], to facilitate the “<left> should !== (<pivot> +- <tolerance>)” syntax of Matchers.

Returns a TripleEqualsInvocationOnSpread[T], given an Spread[T], to facilitate the “<left> should !== (<pivot> +- <tolerance>)” syntax of Matchers.

Value parameters

right

the Spread[T] against which to compare the left-hand value

Attributes

Returns

a TripleEqualsInvocationOnSpread wrapping the passed Spread[T] value, with expectingEqual set to false.

Inherited from:
TripleEqualsSupport
def !==(right: Null): TripleEqualsInvocation[Null]

Returns a TripleEqualsInvocation[Null], given a null reference, to facilitate the “<left> should !== null” syntax of Matchers.

Returns a TripleEqualsInvocation[Null], given a null reference, to facilitate the “<left> should !== null” syntax of Matchers.

Value parameters

right

a null reference

Attributes

Returns

a TripleEqualsInvocation wrapping the passed null value, with expectingEqual set to false.

Inherited from:
TripleEqualsSupport
def !==[T](right: T): TripleEqualsInvocation[T]

Returns a TripleEqualsInvocation[T], given an object of type T, to facilitate the “<left> should !== <right>” syntax of Matchers.

Returns a TripleEqualsInvocation[T], given an object of type T, to facilitate the “<left> should !== <right>” syntax of Matchers.

Value parameters

right

the right-hand side value for an equality assertion

Attributes

Returns

a TripleEqualsInvocation wrapping the passed right value, with expectingEqual set to false.

Inherited from:
TripleEqualsSupport
def ===[T](right: Spread[T]): TripleEqualsInvocationOnSpread[T]

Returns a TripleEqualsInvocationOnSpread[T], given an Spread[T], to facilitate the “<left> should === (<pivot> +- <tolerance>)” syntax of Matchers.

Returns a TripleEqualsInvocationOnSpread[T], given an Spread[T], to facilitate the “<left> should === (<pivot> +- <tolerance>)” syntax of Matchers.

Value parameters

right

the Spread[T] against which to compare the left-hand value

Attributes

Returns

a TripleEqualsInvocationOnSpread wrapping the passed Spread[T] value, with expectingEqual set to true.

Inherited from:
TripleEqualsSupport
def ===(right: Null): TripleEqualsInvocation[Null]

Returns a TripleEqualsInvocation[Null], given a null reference, to facilitate the “<left> should === null” syntax of Matchers.

Returns a TripleEqualsInvocation[Null], given a null reference, to facilitate the “<left> should === null” syntax of Matchers.

Value parameters

right

a null reference

Attributes

Returns

a TripleEqualsInvocation wrapping the passed null value, with expectingEqual set to true.

Inherited from:
TripleEqualsSupport
def ===[T](right: T): TripleEqualsInvocation[T]

Returns a TripleEqualsInvocation[T], given an object of type T, to facilitate the “<left> should === <right>” syntax of Matchers.

Returns a TripleEqualsInvocation[T], given an object of type T, to facilitate the “<left> should === <right>” syntax of Matchers.

Value parameters

right

the right-hand side value for an equality assertion

Attributes

Returns

a TripleEqualsInvocation wrapping the passed right value, with expectingEqual set to true.

Inherited from:
TripleEqualsSupport
override def afterAll(): Unit

Defines a method to be run after all of this suite's tests and nested suites have been run.

Defines a method to be run after all of this suite's tests and nested suites have been run.

This trait's implementation of run invokes this afterAll() method. This trait's implementation of this method does nothing.

Attributes

Definition Classes
IntegrationTest -> BeforeAndAfterAll
Inherited from:
IntegrationTest
def arbConstantByType(t: DefaultUni): Gen[Constant]

Attributes

Inherited from:
ArbitraryInstances
inline def assert(inline condition: Boolean, clue: Any)(implicit prettifier: Prettifier, pos: Position, use: UseDefaultAssertions.type): Assertion

Assert that a boolean condition, described in String message, is true. If the condition is true, this method returns normally. Else, it throws TestFailedException with a helpful error message appended with the String obtained by invoking toString on the specified clue as the exception's detail message.

Assert that a boolean condition, described in String message, is true. If the condition is true, this method returns normally. Else, it throws TestFailedException with a helpful error message appended with the String obtained by invoking toString on the specified clue as the exception's detail message.

This method is implemented in terms of a Scala macro that will generate a more helpful error message for expressions of this form:

  • assert(a == b, "a good clue")

  • assert(a != b, "a good clue")

  • assert(a === b, "a good clue")

  • assert(a !== b, "a good clue")

  • assert(a > b, "a good clue")

  • assert(a >= b, "a good clue")

  • assert(a < b, "a good clue")

  • assert(a <= b, "a good clue")

  • assert(a startsWith "prefix", "a good clue")

  • assert(a endsWith "postfix", "a good clue")

  • assert(a contains "something", "a good clue")

  • assert(a eq b, "a good clue")

  • assert(a ne b, "a good clue")

  • assert(a > 0 && b > 5, "a good clue")

  • assert(a > 0 || b > 5, "a good clue")

  • assert(a.isEmpty, "a good clue")

  • assert(!a.isEmpty, "a good clue")

  • assert(a.isInstanceOf[String], "a good clue")

  • assert(a.length == 8, "a good clue")

  • assert(a.size == 8, "a good clue")

  • assert(a.exists(_ == 8), "a good clue")

At this time, any other form of expression will just get a TestFailedException with message saying the given expression was false. In the future, we will enhance this macro to give helpful error messages in more situations. In ScalaTest 2.0, however, this behavior was sufficient to allow the === that returns Boolean to be the default in tests. This makes === consistent between tests and production code.

Value parameters

clue

An objects whose toString method returns a message to include in a failure report.

condition

the boolean condition to assert

Attributes

Throws
NullArgumentException

if message is null.

TestFailedException

if the condition is false.

Inherited from:
Assertions
inline def assert(inline condition: Boolean)(implicit prettifier: Prettifier, pos: Position, use: UseDefaultAssertions.type): Assertion

Assert that a boolean condition is true. If the condition is true, this method returns normally. Else, it throws TestFailedException.

Assert that a boolean condition is true. If the condition is true, this method returns normally. Else, it throws TestFailedException.

This method is implemented in terms of a Scala macro that will generate a more helpful error message for expressions of this form:

  • assert(a == b)

  • assert(a != b)

  • assert(a === b)

  • assert(a !== b)

  • assert(a > b)

  • assert(a >= b)

  • assert(a < b)

  • assert(a <= b)

  • assert(a startsWith "prefix")

  • assert(a endsWith "postfix")

  • assert(a contains "something")

  • assert(a eq b)

  • assert(a ne b)

  • assert(a > 0 && b > 5)

  • assert(a > 0 || b > 5)

  • assert(a.isEmpty)

  • assert(!a.isEmpty)

  • assert(a.isInstanceOf[String])

  • assert(a.length == 8)

  • assert(a.size == 8)

  • assert(a.exists(_ == 8))

At this time, any other form of expression will get a TestFailedException with message saying the given expression was false. In the future, we will enhance this macro to give helpful error messages in more situations. In ScalaTest 2.0, however, this behavior was sufficient to allow the === that returns Boolean to be the default in tests. This makes === consistent between tests and production code.

Value parameters

condition

the boolean condition to assert

Attributes

Throws
TestFailedException

if the condition is false.

Inherited from:
Assertions
transparent inline def assertCompiles(inline code: String): Assertion

Asserts that a given string snippet of code passes both the Scala parser and type checker.

Asserts that a given string snippet of code passes both the Scala parser and type checker.

You can use this to make sure a snippet of code compiles:

assertCompiles("val a: Int = 1")

Although assertCompiles is implemented with a macro that determines at compile time whether the snippet of code represented by the passed string compiles, errors (i.e., snippets of code that do not compile) are reported as test failures at runtime.

Value parameters

code

the snippet of code that should compile

Attributes

Inherited from:
Assertions
transparent inline def assertDoesNotCompile(inline code: String): Assertion

Asserts that a given string snippet of code does not pass either the Scala parser or type checker.

Asserts that a given string snippet of code does not pass either the Scala parser or type checker.

Often when creating libraries you may wish to ensure that certain arrangements of code that represent potential “user errors” do not compile, so that your library is more error resistant. ScalaTest's Assertions trait includes the following syntax for that purpose:

assertDoesNotCompile("val a: String = \"a string")

Although assertDoesNotCompile is implemented with a macro that determines at compile time whether the snippet of code represented by the passed string doesn't compile, errors (i.e., snippets of code that do compile) are reported as test failures at runtime.

Note that the difference between assertTypeError and assertDoesNotCompile is that assertDoesNotCompile will succeed if the given code does not compile for any reason, whereas assertTypeError will only succeed if the given code does not compile because of a type error. If the given code does not compile because of a syntax error, for example, assertDoesNotCompile will return normally but assertTypeError will throw a TestFailedException.

Value parameters

code

the snippet of code that should not type check

Attributes

Inherited from:
Assertions
inline def assertResult[L, R](expected: L)(actual: R)(implicit prettifier: Prettifier, caneq: CanEqual[L, R]): Assertion

Assert that the value passed as expected equals the value passed as actual. If the actual value equals the expected value (as determined by ==), assertResult returns normally. Else, assertResult throws a TestFailedException whose detail message includes the expected and actual values.

Assert that the value passed as expected equals the value passed as actual. If the actual value equals the expected value (as determined by ==), assertResult returns normally. Else, assertResult throws a TestFailedException whose detail message includes the expected and actual values.

Value parameters

actual

the actual value, which should equal the passed expected value

expected

the expected value

Attributes

Throws
TestFailedException

if the passed actual value does not equal the passed expected value.

Inherited from:
Assertions
inline def assertResult[L, R](expected: L, clue: Any)(actual: R)(implicit prettifier: Prettifier, caneq: CanEqual[L, R]): Assertion

Assert that the value passed as expected equals the value passed as actual. If the actual equals the expected (as determined by ==), assertResult returns normally. Else, if actual is not equal to expected, assertResult throws a TestFailedException whose detail message includes the expected and actual values, as well as the String obtained by invoking toString on the passed clue.

Assert that the value passed as expected equals the value passed as actual. If the actual equals the expected (as determined by ==), assertResult returns normally. Else, if actual is not equal to expected, assertResult throws a TestFailedException whose detail message includes the expected and actual values, as well as the String obtained by invoking toString on the passed clue.

Value parameters

actual

the actual value, which should equal the passed expected value

clue

An object whose toString method returns a message to include in a failure report.

expected

the expected value

Attributes

Throws
TestFailedException

if the passed actual value does not equal the passed expected value.

Inherited from:
Assertions
inline def assertThrows[T <: AnyRef](f: => Any)(implicit classTag: ClassTag[T]): Assertion

Ensure that an expected exception is thrown by the passed function value. The thrown exception must be an instance of the type specified by the type parameter of this method. This method invokes the passed function. If the function throws an exception that's an instance of the specified type, this method returns Succeeded. Else, whether the passed function returns normally or completes abruptly with a different exception, this method throws TestFailedException.

Ensure that an expected exception is thrown by the passed function value. The thrown exception must be an instance of the type specified by the type parameter of this method. This method invokes the passed function. If the function throws an exception that's an instance of the specified type, this method returns Succeeded. Else, whether the passed function returns normally or completes abruptly with a different exception, this method throws TestFailedException.

Note that the type specified as this method's type parameter may represent any subtype of AnyRef, not just Throwable or one of its subclasses. In Scala, exceptions can be caught based on traits they implement, so it may at times make sense to specify a trait that the intercepted exception's class must mix in. If a class instance is passed for a type that could not possibly be used to catch an exception (such as String, for example), this method will complete abruptly with a TestFailedException.

Also note that the difference between this method and intercept is that this method does not return the expected exception, so it does not let you perform further assertions on that exception. Instead, this method returns Succeeded, which means it can serve as the last statement in an async- or safe-style suite. It also indicates to the reader of the code that nothing further is expected about the thrown exception other than its type. The recommended usage is to use assertThrows by default, intercept only when you need to inspect the caught exception further.

Value parameters

classTag

an implicit ClassTag representing the type of the specified type parameter.

f

the function value that should throw the expected exception

Attributes

Returns

the Succeeded singleton, if an exception of the expected type is thrown

Throws
TestFailedException

if the passed function does not complete abruptly with an exception that's an instance of the specified type.

Inherited from:
Assertions
transparent inline def assertTypeError(inline code: String): Assertion

Asserts that a given string snippet of code does not pass the Scala type checker, failing if the given snippet does not pass the Scala parser.

Asserts that a given string snippet of code does not pass the Scala type checker, failing if the given snippet does not pass the Scala parser.

Often when creating libraries you may wish to ensure that certain arrangements of code that represent potential “user errors” do not compile, so that your library is more error resistant. ScalaTest's Assertions trait includes the following syntax for that purpose:

assertTypeError("val a: String = 1")

Although assertTypeError is implemented with a macro that determines at compile time whether the snippet of code represented by the passed string type checks, errors (i.e., snippets of code that do type check) are reported as test failures at runtime.

Note that the difference between assertTypeError and assertDoesNotCompile is that assertDoesNotCompile will succeed if the given code does not compile for any reason, whereas assertTypeError will only succeed if the given code does not compile because of a type error. If the given code does not compile because of a syntax error, for example, assertDoesNotCompile will return normally but assertTypeError will throw a TestFailedException.

Value parameters

code

the snippet of code that should not type check

Attributes

Inherited from:
Assertions
inline def assume(inline condition: Boolean, clue: Any)(implicit prettifier: Prettifier, pos: Position, use: UseDefaultAssertions.type): Assertion

Assume that a boolean condition, described in String message, is true. If the condition is true, this method returns normally. Else, it throws TestCanceledException with a helpful error message appended with String obtained by invoking toString on the specified clue as the exception's detail message.

Assume that a boolean condition, described in String message, is true. If the condition is true, this method returns normally. Else, it throws TestCanceledException with a helpful error message appended with String obtained by invoking toString on the specified clue as the exception's detail message.

This method is implemented in terms of a Scala macro that will generate a more helpful error message for expressions of this form:

  • assume(a == b, "a good clue")

  • assume(a != b, "a good clue")

  • assume(a === b, "a good clue")

  • assume(a !== b, "a good clue")

  • assume(a > b, "a good clue")

  • assume(a >= b, "a good clue")

  • assume(a < b, "a good clue")

  • assume(a <= b, "a good clue")

  • assume(a startsWith "prefix", "a good clue")

  • assume(a endsWith "postfix", "a good clue")

  • assume(a contains "something", "a good clue")

  • assume(a eq b, "a good clue")

  • assume(a ne b, "a good clue")

  • assume(a > 0 && b > 5, "a good clue")

  • assume(a > 0 || b > 5, "a good clue")

  • assume(a.isEmpty, "a good clue")

  • assume(!a.isEmpty, "a good clue")

  • assume(a.isInstanceOf[String], "a good clue")

  • assume(a.length == 8, "a good clue")

  • assume(a.size == 8, "a good clue")

  • assume(a.exists(_ == 8), "a good clue")

At this time, any other form of expression will just get a TestCanceledException with message saying the given expression was false. In the future, we will enhance this macro to give helpful error messages in more situations. In ScalaTest 2.0, however, this behavior was sufficient to allow the === that returns Boolean to be the default in tests. This makes === consistent between tests and production code.

Value parameters

clue

An objects whose toString method returns a message to include in a failure report.

condition

the boolean condition to assume

Attributes

Throws
NullArgumentException

if message is null.

TestCanceledException

if the condition is false.

Inherited from:
Assertions
inline def assume(inline condition: Boolean)(implicit prettifier: Prettifier, pos: Position, use: UseDefaultAssertions.type): Assertion

Assume that a boolean condition is true. If the condition is true, this method returns normally. Else, it throws TestCanceledException.

Assume that a boolean condition is true. If the condition is true, this method returns normally. Else, it throws TestCanceledException.

This method is implemented in terms of a Scala macro that will generate a more helpful error message for expressions of this form:

  • assume(a == b)

  • assume(a != b)

  • assume(a === b)

  • assume(a !== b)

  • assume(a > b)

  • assume(a >= b)

  • assume(a < b)

  • assume(a <= b)

  • assume(a startsWith "prefix")

  • assume(a endsWith "postfix")

  • assume(a contains "something")

  • assume(a eq b)

  • assume(a ne b)

  • assume(a > 0 && b > 5)

  • assume(a > 0 || b > 5)

  • assume(a.isEmpty)

  • assume(!a.isEmpty)

  • assume(a.isInstanceOf[String])

  • assume(a.length == 8)

  • assume(a.size == 8)

  • assume(a.exists(_ == 8))

At this time, any other form of expression will just get a TestCanceledException with message saying the given expression was false. In the future, we will enhance this macro to give helpful error messages in more situations. In ScalaTest 2.0, however, this behavior was sufficient to allow the === that returns Boolean to be the default in tests. This makes === consistent between tests and production code.

Value parameters

condition

the boolean condition to assume

Attributes

Throws
TestCanceledException

if the condition is false.

Inherited from:
Assertions
override def beforeAll(): Unit

Defines a method to be run before any of this suite's tests or nested suites are run.

Defines a method to be run before any of this suite's tests or nested suites are run.

This trait's implementation of run invokes this beforeAll() method. This trait's implementation of this method does nothing.

Attributes

Definition Classes
IntegrationTest -> BeforeAndAfterAll
Inherited from:
IntegrationTest
inline def cancel(cause: Throwable): Nothing

Throws TestCanceledException, with the passed Throwable cause, to indicate a test failed. The getMessage method of the thrown TestCanceledException will return cause.toString.

Throws TestCanceledException, with the passed Throwable cause, to indicate a test failed. The getMessage method of the thrown TestCanceledException will return cause.toString.

Value parameters

cause

a Throwable that indicates the cause of the cancellation.

Attributes

Throws
NullArgumentException

if cause is null

Inherited from:
Assertions
inline def cancel(message: String, cause: Throwable): Nothing

Throws TestCanceledException, with the passed String message as the exception's detail message and Throwable cause, to indicate a test failed.

Throws TestCanceledException, with the passed String message as the exception's detail message and Throwable cause, to indicate a test failed.

Value parameters

cause

A Throwable that indicates the cause of the failure.

message

A message describing the failure.

Attributes

Throws
NullArgumentException

if message or cause is null

Inherited from:
Assertions
inline def cancel(message: String): Nothing

Throws TestCanceledException, with the passed String message as the exception's detail message, to indicate a test was canceled.

Throws TestCanceledException, with the passed String message as the exception's detail message, to indicate a test was canceled.

Value parameters

message

A message describing the cancellation.

Attributes

Throws
NullArgumentException

if message is null

Inherited from:
Assertions
inline def cancel(): Nothing

Throws TestCanceledException to indicate a test was canceled.

Throws TestCanceledException to indicate a test was canceled.

Attributes

Inherited from:
Assertions
def compareBudgetWithReferenceValue(testName: String, scalusBudget: ExUnits, refBudget: ExUnits, isPrintComparison: Boolean = ...): Unit

Attributes

Inherited from:
ScalusTest
override def convertEquivalenceToAToBConstraint[A, B](equivalenceOfB: Equivalence[B])(implicit ev: A <:< B): CanEqual[A, B]

Provides a A CanEqual B for any two types A and B, enforcing the type constraint that A must be a subtype of B, given an explicit Equivalence[B].

Provides a A CanEqual B for any two types A and B, enforcing the type constraint that A must be a subtype of B, given an explicit Equivalence[B].

This method is used to enable the Explicitly DSL for TypeCheckedTripleEquals by requiring an explicit Equivalance[B], but taking an implicit function that provides evidence that A is a subtype of B.

The returned Constraint's areEqual method uses the implicitly passed Equivalence[B]'s areEquivalent method to determine equality.

This method is overridden and made implicit by subtraits LowPriorityTypeCheckedConstraint (extended by TypeCheckedTripleEquals), and overriden as non-implicit by the other subtraits in this package.

Value parameters

equivalenceOfB

an Equivalence[B] type class to which the Constraint.areEqual method will delegate to determine equality.

ev

evidence that A is a subype of B

Attributes

Returns

an A CanEqual B instance whose areEqual method delegates to the areEquivalent method of the passed Equivalence[B].

Definition Classes
TripleEquals -> TripleEqualsSupport
Inherited from:
TripleEquals
override def convertEquivalenceToBToAConstraint[A, B](equivalenceOfA: Equivalence[A])(implicit ev: B <:< A): CanEqual[A, B]

Provides an A CanEqual B instance for any two types A and B, enforcing the type constraint that B must be a subtype of A, given an explicit Equivalence[A].

Provides an A CanEqual B instance for any two types A and B, enforcing the type constraint that B must be a subtype of A, given an explicit Equivalence[A].

This method is used to enable the Explicitly DSL for TypeCheckedTripleEquals by requiring an explicit Equivalance[B], but taking an implicit function that provides evidence that A is a subtype of B. For example, under TypeCheckedTripleEquals, this method (as an implicit method), would be used to compile this statement:

def closeEnoughTo1(num: Double): Boolean =
 (num === 1.0)(decided by forgivingEquality)

The returned Constraint's areEqual method uses the implicitly passed Equivalence[A]'s areEquivalent method to determine equality.

This method is overridden and made implicit by subtraits TypeCheckedTripleEquals) and overriden as non-implicit by the other subtraits in this package.

Value parameters

equalityOfA

an Equivalence[A] type class to which the Constraint.areEqual method will delegate to determine equality.

ev

evidence that B is a subype of A

Attributes

Returns

an A CanEqual B instance whose areEqual method delegates to the areEquivalent method of the passed Equivalence[A].

Definition Classes
TripleEquals -> TripleEqualsSupport
Inherited from:
TripleEquals
override def convertToCheckingEqualizer[T](left: T): CheckingEqualizer[T]

Converts to an CheckingEqualizer that provides === and !== operators that result in Boolean and enforce a type constraint.

Converts to an CheckingEqualizer that provides === and !== operators that result in Boolean and enforce a type constraint.

This method is overridden and made implicit by subtrait TypeCheckedTripleEquals, and overriden as non-implicit by the other subtraits in this package.

Value parameters

left

the object whose type to convert to CheckingEqualizer.

Attributes

Throws
NullPointerException

if left is null.

Definition Classes
TripleEquals -> TripleEqualsSupport
Inherited from:
TripleEquals
protected def createBlockfrostContext(name: String, network: Network, slotConfig: SlotConfig): BlockfrostTestContext

Create a Blockfrost-based test context for Preprod or Mainnet.

Create a Blockfrost-based test context for Preprod or Mainnet.

Requires environment variables:

  • BLOCKFROST_API_KEY: Blockfrost API key
  • WALLET_MNEMONIC_PREPROD or WALLET_MNEMONIC_MAINNET: HD wallet mnemonic

Attributes

Inherited from:
IntegrationTest
protected def createEmulatorContext(): EmulatorTestContext

Create an Emulator-based test context with all Party addresses funded.

Create an Emulator-based test context with all Party addresses funded.

Uses mainnet CardanoInfo which includes mainnet slotConfig. The emulator internally also uses mainnet slotConfig, ensuring consistent slot-to-time conversions.

Attributes

Inherited from:
IntegrationTest
protected def createTestContext(): IntegrationTestContext

Create test context based on SCALUS_TEST_ENV.

Create test context based on SCALUS_TEST_ENV.

Override to add custom environments or change defaults.

Attributes

Inherited from:
IntegrationTest
protected def createYaciContext(): YaciTestContext

Create a YaciDevKit-based test context.

Create a YaciDevKit-based test context.

Attributes

Inherited from:
IntegrationTest
def defaultEquality[A]: Equality[A]

Returns an Equality[A] for any type A that determines equality by first calling .deep on any Array (on either the left or right side), then comparing the resulting objects with ==.

Returns an Equality[A] for any type A that determines equality by first calling .deep on any Array (on either the left or right side), then comparing the resulting objects with ==.

Attributes

Returns

a default Equality for type A

Inherited from:
TripleEqualsSupport
inline def fail(cause: Throwable): Nothing

Throws TestFailedException, with the passed Throwable cause, to indicate a test failed. The getMessage method of the thrown TestFailedException will return cause.toString.

Throws TestFailedException, with the passed Throwable cause, to indicate a test failed. The getMessage method of the thrown TestFailedException will return cause.toString.

Value parameters

cause

a Throwable that indicates the cause of the failure.

Attributes

Throws
NullArgumentException

if cause is null

Inherited from:
Assertions
inline def fail(message: String, cause: Throwable): Nothing

Throws TestFailedException, with the passed String message as the exception's detail message and Throwable cause, to indicate a test failed.

Throws TestFailedException, with the passed String message as the exception's detail message and Throwable cause, to indicate a test failed.

Value parameters

cause

A Throwable that indicates the cause of the failure.

message

A message describing the failure.

Attributes

Throws
NullArgumentException

if message or cause is null

Inherited from:
Assertions
inline def fail(message: String): Nothing

Throws TestFailedException, with the passed String message as the exception's detail message, to indicate a test failed.

Throws TestFailedException, with the passed String message as the exception's detail message, to indicate a test failed.

Value parameters

message

A message describing the failure.

Attributes

Throws
NullArgumentException

if message is null

Inherited from:
Assertions
inline def fail(): Nothing

Throws TestFailedException to indicate a test failed.

Throws TestFailedException to indicate a test failed.

Attributes

Inherited from:
Assertions
def genAmount: Gen[BigInt]

Attributes

Inherited from:
ArbitraryInstances
def genAsset: Gen[Value]

Attributes

Inherited from:
ArbitraryInstances
def genAssetName: Gen[ByteString]

Generates a random asset name, which is a ByteString of length between 1 and 32 bytes.

Generates a random asset name, which is a ByteString of length between 1 and 32 bytes.

Attributes

Inherited from:
ArbitraryInstances
def genByteStringOfN(n: Int): Gen[ByteString]

Attributes

Inherited from:
ArbitraryInstances
def genLovelace: Gen[Value]

Attributes

Inherited from:
ArbitraryInstances
def genPolicyId: Gen[ByteString]

Attributes

Inherited from:
ArbitraryInstances
def genToken: Gen[(ByteString, BigInt)]

Attributes

Inherited from:
ArbitraryInstances
inline def intercept[T <: AnyRef](f: => Any)(implicit classTag: ClassTag[T]): T

Intercept and return an exception that's expected to be thrown by the passed function value. The thrown exception must be an instance of the type specified by the type parameter of this method. This method invokes the passed function. If the function throws an exception that's an instance of the specified type, this method returns that exception. Else, whether the passed function returns normally or completes abruptly with a different exception, this method throws TestFailedException.

Intercept and return an exception that's expected to be thrown by the passed function value. The thrown exception must be an instance of the type specified by the type parameter of this method. This method invokes the passed function. If the function throws an exception that's an instance of the specified type, this method returns that exception. Else, whether the passed function returns normally or completes abruptly with a different exception, this method throws TestFailedException.

Note that the type specified as this method's type parameter may represent any subtype of AnyRef, not just Throwable or one of its subclasses. In Scala, exceptions can be caught based on traits they implement, so it may at times make sense to specify a trait that the intercepted exception's class must mix in. If a class instance is passed for a type that could not possibly be used to catch an exception (such as String, for example), this method will complete abruptly with a TestFailedException.

Also note that the difference between this method and assertThrows is that this method returns the expected exception, so it lets you perform further assertions on that exception. By contrast, the assertThrows method returns Succeeded, which means it can serve as the last statement in an async- or safe-style suite. assertThrows also indicates to the reader of the code that nothing further is expected about the thrown exception other than its type. The recommended usage is to use assertThrows by default, intercept only when you need to inspect the caught exception further.

Value parameters

classTag

an implicit ClassTag representing the type of the specified type parameter.

f

the function value that should throw the expected exception

Attributes

Returns

the intercepted exception, if it is of the expected type

Throws
TestFailedException

if the passed function does not complete abruptly with an exception that's an instance of the specified type.

Inherited from:
Assertions
override def lowPriorityTypeCheckedConstraint[A, B](implicit equivalenceOfB: Equivalence[B], ev: A <:< B): CanEqual[A, B]

Provides an A CanEqual B for any two types A and B, enforcing the type constraint that A must be a subtype of B, given an implicit Equivalence[B].

Provides an A CanEqual B for any two types A and B, enforcing the type constraint that A must be a subtype of B, given an implicit Equivalence[B].

The returned Constraint's areEqual method uses the implicitly passed Equivalence[A]'s areEquivalent method to determine equality.

This method is overridden and made implicit by subtraits LowPriorityTypeCheckedConstraint (extended by TypeCheckedTripleEquals), and overriden as non-implicit by the other subtraits in this package.

Value parameters

equivalenceOfB

an Equivalence[B] type class to which the Constraint.areEqual method will delegate to determine equality.

ev

evidence that A is a subype of B

Attributes

Returns

an A CanEqual B instance whose areEqual method delegates to the areEquivalent method of the passed Equivalence[B].

Definition Classes
TripleEquals -> TripleEqualsSupport
Inherited from:
TripleEquals
def pending: Assertion & PendingStatement

Throws TestPendingException to indicate a test is pending.

Throws TestPendingException to indicate a test is pending.

A pending test is one that has been given a name but is not yet implemented. The purpose of pending tests is to facilitate a style of testing in which documentation of behavior is sketched out before tests are written to verify that behavior (and often, the before the behavior of the system being tested is itself implemented). Such sketches form a kind of specification of what tests and functionality to implement later.

To support this style of testing, a test can be given a name that specifies one bit of behavior required by the system being tested. The test can also include some code that sends more information about the behavior to the reporter when the tests run. At the end of the test, it can call method pending, which will cause it to complete abruptly with TestPendingException. Because tests in ScalaTest can be designated as pending with TestPendingException, both the test name and any information sent to the reporter when running the test can appear in the report of a test run. (In other words, the code of a pending test is executed just like any other test.) However, because the test completes abruptly with TestPendingException, the test will be reported as pending, to indicate the actual test, and possibly the functionality it is intended to test, has not yet been implemented.

Note: This method always completes abruptly with a TestPendingException. Thus it always has a side effect. Methods with side effects are usually invoked with parentheses, as in pending(). This method is defined as a parameterless method, in flagrant contradiction to recommended Scala style, because it forms a kind of DSL for pending tests. It enables tests in suites such as FunSuite or FunSpec to be denoted by placing "(pending)" after the test name, as in:

test("that style rules are not laws") (pending)

Readers of the code see "pending" in parentheses, which looks like a little note attached to the test name to indicate it is pending. Whereas "(pending()) looks more like a method call, "(pending)" lets readers stay at a higher level, forgetting how it is implemented and just focusing on the intent of the programmer who wrote the code.

Attributes

Inherited from:
Assertions
inline def pendingUntilFixed(f: => Unit): Assertion & PendingStatement

Execute the passed block of code, and if it completes abruptly, throw TestPendingException, else throw TestFailedException.

Execute the passed block of code, and if it completes abruptly, throw TestPendingException, else throw TestFailedException.

This method can be used to temporarily change a failing test into a pending test in such a way that it will automatically turn back into a failing test once the problem originally causing the test to fail has been fixed. At that point, you need only remove the pendingUntilFixed call. In other words, a pendingUntilFixed surrounding a block of code that isn't broken is treated as a test failure. The motivation for this behavior is to encourage people to remove pendingUntilFixed calls when there are no longer needed.

This method facilitates a style of testing in which tests are written before the code they test. Sometimes you may encounter a test failure that requires more functionality than you want to tackle without writing more tests. In this case you can mark the bit of test code causing the failure with pendingUntilFixed. You can then write more tests and functionality that eventually will get your production code to a point where the original test won't fail anymore. At this point the code block marked with pendingUntilFixed will no longer throw an exception (because the problem has been fixed). This will in turn cause pendingUntilFixed to throw TestFailedException with a detail message explaining you need to go back and remove the pendingUntilFixed call as the problem orginally causing your test code to fail has been fixed.

Value parameters

f

a block of code, which if it completes abruptly, should trigger a TestPendingException

Attributes

Throws
TestPendingException

if the passed block of code completes abruptly with an Exception or AssertionError

Inherited from:
Assertions
protected def requireEnv(key: String): String

Get required environment variable or cancel test

Get required environment variable or cancel test

Attributes

Inherited from:
IntegrationTest
abstract override def run(testName: Option[String], args: Args): Status

Execute a suite surrounded by calls to beforeAll and afterAll.

Execute a suite surrounded by calls to beforeAll and afterAll.

This trait's implementation of this method ("this method") invokes beforeAll(ConfigMap) before executing any tests or nested suites and afterAll(ConfigMap) after executing all tests and nested suites. It runs the suite by invoking super.run, passing along the parameters passed to it.

If any invocation of beforeAll completes abruptly with an exception, this method will complete abruptly with the same exception. If any call to super.run completes abruptly with an exception, this method will complete abruptly with the same exception, however, before doing so, it will invoke afterAll. If afterAll also completes abruptly with an exception, this method will nevertheless complete abruptly with the exception previously thrown by super.run. If super.run returns normally, but afterAll completes abruptly with an exception, this method will complete abruptly with the same exception.

This method does not invoke either beforeAll or afterAll if runTestsInNewInstance is true so that any side effects only happen once per test if OneInstancePerTest is being used. In addition, if no tests are expected, then beforeAll and afterAll will be invoked only if the invokeBeforeAllAndAfterAllEvenIfNoTestsAreExpected flag is true. By default, this flag is false, so that if all tests are excluded (such as if the entire suite class has been marked with @Ignore), then side effects would happen only if at least one test will ultimately be executed in this suite or its nested suites.

Value parameters

args

the Args for this run

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.

Attributes

Returns

a Status object that indicates when the test started by this method has completed, and whether or not it failed .

Inherited from:
BeforeAndAfterAll
override def typeCheckedConstraint[A, B](implicit equivalenceOfA: Equivalence[A], ev: B <:< A): CanEqual[A, B]

Provides an A CanEqual B instance for any two types A and B, enforcing the type constraint that B must be a subtype of A, given an implicit Equivalence[A].

Provides an A CanEqual B instance for any two types A and B, enforcing the type constraint that B must be a subtype of A, given an implicit Equivalence[A].

The returned Constraint's areEqual method uses the implicitly passed Equivalence[A]'s areEquivalent method to determine equality.

This method is overridden and made implicit by subtraits TypeCheckedTripleEquals) and overriden as non-implicit by the other subtraits in this package.

Value parameters

equalityOfA

an Equivalence[A] type class to which the Constraint.areEqual method will delegate to determine equality.

ev

evidence that B is a subype of A

Attributes

Returns

an A CanEqual B instance whose areEqual method delegates to the areEquivalent method of the passed Equivalence[A].

Definition Classes
TripleEquals -> TripleEqualsSupport
Inherited from:
TripleEquals
def withClue[T](clue: Any)(fun: => T): T

Executes the block of code passed as the second parameter, and, if it completes abruptly with a ModifiableMessage exception, prepends the "clue" string passed as the first parameter to the beginning of the detail message of that thrown exception, then rethrows it. If clue does not end in a white space character, one space will be added between it and the existing detail message (unless the detail message is not defined).

Executes the block of code passed as the second parameter, and, if it completes abruptly with a ModifiableMessage exception, prepends the "clue" string passed as the first parameter to the beginning of the detail message of that thrown exception, then rethrows it. If clue does not end in a white space character, one space will be added between it and the existing detail message (unless the detail message is not defined).

This method allows you to add more information about what went wrong that will be reported when a test fails. Here's an example:

withClue("(Employee's name was: " + employee.name + ")") {
 intercept[IllegalArgumentException] {
   employee.getTask(-1)
 }
}

If an invocation of intercept completed abruptly with an exception, the resulting message would be something like:

(Employee's name was Bob Jones) Expected IllegalArgumentException to be thrown, but no exception was thrown

Attributes

Throws
NullArgumentException

if the passed clue is null

Inherited from:
Assertions
protected def yaciConfig: YaciConfig

Override to customize YaciDevKit configuration

Override to customize YaciDevKit configuration

Attributes

Inherited from:
IntegrationTest
protected def yaciContainer: Option[YaciCardanoContainer]

Get the running Yaci container (if using Yaci environment)

Get the running Yaci container (if using Yaci environment)

Attributes

Inherited from:
IntegrationTest

Inherited and Abstract methods

def expectedTestCount(filter: Filter): Int

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

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

Value parameters

filter

a Filter with which to filter tests to count based on their tags

Attributes

Inherited from:
SuiteMixin
def nestedSuites: IndexedSeq[Suite]

An immutable IndexedSeq of this SuiteMixin object's nested Suites. If this SuiteMixin contains no nested Suites, this method returns an empty IndexedSeq.

An immutable IndexedSeq of this SuiteMixin object's nested Suites. If this SuiteMixin contains no nested Suites, this method returns an empty IndexedSeq.

Attributes

Inherited from:
SuiteMixin
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.

Attributes

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 parameters

args

the Args for this run

Attributes

Returns

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

Throws
NullArgumentException

if args is null.

Inherited from:
SuiteMixin
protected def runTest(testName: String, args: Args): Status

Runs a test.

Runs a test.

Value parameters

args

the Args for this run

testName

the name of one test to execute.

Attributes

Returns

a Status object that indicates when the test started by this method has completed, and whether or not it failed .

Throws
NullArgumentException

if any of testName or args is null.

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 parameters

args

the Args for this run

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.

Attributes

Returns

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

Throws
NullArgumentException

if either testName or args is null.

Inherited from:
SuiteMixin
def suiteId: String

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

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

The suite ID is intended 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.

Attributes

Returns

this Suite object's ID.

Inherited from:
SuiteMixin
def suiteName: String

A user-friendly suite name for this Suite.

A user-friendly suite name for this Suite.

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

Attributes

Returns

this Suite object's suite name.

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

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

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

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

Attributes

Inherited from:
SuiteMixin
def testDataFor(testName: String, theConfigMap: ConfigMap): TestData

Provides a TestData instance for the passed test name, given the passed config map.

Provides a TestData instance for the passed test name, given the passed config map.

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

Value parameters

testName

the name of the test for which to return a TestData instance

theConfigMap

the config map to include in the returned TestData

Attributes

Returns

a TestData instance for the specified test, which includes the specified config map

Inherited from:
SuiteMixin
def testNames: Set[String]

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

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

Although subclass and subtrait implementations of this method may return a Set whose iterator produces String 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.

Attributes

Inherited from:
SuiteMixin

Deprecated and Inherited methods

override def conversionCheckedConstraint[A, B](implicit equivalenceOfA: Equivalence[A], cnv: B => A): CanEqual[A, B]

The conversionCheckedConstraint method has been deprecated and will be removed in a future version of Scalactic. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.

The conversionCheckedConstraint method has been deprecated and will be removed in a future version of Scalactic. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.

Provides an A CanEqual B instance for any two types A and B, enforcing the type constraint that B is implicitly convertible to A, given an implicit Equivalence[A].

The returned Constraint's areEqual method uses the implicitly passed Equivalence[A]'s areEquivalent method to determine equality.

This method is overridden and made implicit by subtraits ConversionCheckedTripleEquals) and overriden as non-implicit by the other subtraits in this package.

Value parameters

cnv

an implicit conversion from B to A

equivalenceOfA

an Equivalence[A] type class to which the Constraint.areEqual method will delegate to determine equality.

Attributes

Returns

an A CanEqual B instance whose areEqual method delegates to the areEquivalent method of the passed Equivalence[A].

Deprecated
[Since version 3.1.0] The conversionCheckedConstraint method has been deprecated and will be removed in a future version of ScalaTest. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.
Definition Classes
TripleEquals -> TripleEqualsSupport
Inherited from:
TripleEquals
override def convertEquivalenceToAToBConversionConstraint[A, B](equivalenceOfB: Equivalence[B])(implicit ev: A => B): CanEqual[A, B]

The convertEquivalenceToAToBConversionConstraint method has been deprecated and will be removed in a future version of Scalactic. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.

The convertEquivalenceToAToBConversionConstraint method has been deprecated and will be removed in a future version of Scalactic. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.

Provides an A CanEqual B instance for any two types A and B, enforcing the type constraint that A is implicitly convertible to B, given an explicit Equivalence[B].

This method is used to enable the Explicitly DSL for ConversionCheckedTripleEquals by requiring an explicit Equivalance[B], but taking an implicit function that converts from A to B.

The returned Constraint's areEqual method uses the implicitly passed Equivalence[B]'s areEquivalent method to determine equality.

This method is overridden and made implicit by subtraits LowPriorityConversionCheckedConstraint (extended by ConversionCheckedTripleEquals), and overriden as non-implicit by the other subtraits in this package.

Value parameters

cnv

an implicit conversion from A to B

equalityOfB

an Equivalence[B] type class to which the Constraint.areEqual method will delegate to determine equality.

Attributes

Returns

an A CanEqual B instance whose areEqual method delegates to the areEquivalent method of the passed Equivalence[B].

Deprecated
[Since version 3.1.0] The convertEquivalenceToAToBConversionConstraint method has been deprecated and will be removed in a future version of ScalaTest. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.
Definition Classes
TripleEquals -> TripleEqualsSupport
Inherited from:
TripleEquals
override def convertEquivalenceToBToAConversionConstraint[A, B](equivalenceOfA: Equivalence[A])(implicit ev: B => A): CanEqual[A, B]

The convertEquivalenceToBToAConversionConstraint method has been deprecated and will be removed in a future version of Scalactic. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.

The convertEquivalenceToBToAConversionConstraint method has been deprecated and will be removed in a future version of Scalactic. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.

Provides an A CanEqual B instance for any two types A and B, enforcing the type constraint that B is implicitly convertible to A, given an explicit Equivalence[A].

This method is used to enable the Explicitly DSL for ConversionCheckedTripleEquals by requiring an explicit Equivalance[A], but taking an implicit function that converts from B to A. For example, under ConversionCheckedTripleEquals, this method (as an implicit method), would be used to compile this statement:

def closeEnoughTo1(num: Double): Boolean =
 (num === 1.0)(decided by forgivingEquality)

The returned Constraint's areEqual method uses the implicitly passed Equivalence[A]'s areEquivalent method to determine equality.

This method is overridden and made implicit by subtraits ConversionCheckedTripleEquals) and overriden as non-implicit by the other subtraits in this package.

Value parameters

cnv

an implicit conversion from B to A

equivalenceOfA

an Equivalence[A] type class to which the Constraint.areEqual method will delegate to determine equality.

Attributes

Returns

an A CanEqual B instance whose areEqual method delegates to the areEquivalent method of the passed Equivalence[A].

Deprecated
[Since version 3.1.0] The convertEquivalenceToBToAConversionConstraint method has been deprecated and will be removed in a future version of ScalaTest. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.
Definition Classes
TripleEquals -> TripleEqualsSupport
Inherited from:
TripleEquals
override def lowPriorityConversionCheckedConstraint[A, B](implicit equivalenceOfB: Equivalence[B], cnv: A => B): CanEqual[A, B]

The lowPriorityConversionCheckedConstraint method has been deprecated and will be removed in a future version of Scalactic. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.

The lowPriorityConversionCheckedConstraint method has been deprecated and will be removed in a future version of Scalactic. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.

Provides an A CanEqual B instance for any two types A and B, enforcing the type constraint that A is implicitly convertible to B, given an implicit Equivalence[B].

The returned Constraint's areEqual method uses the implicitly passed Equivalence[B]'s areEquivalent method to determine equality.

This method is overridden and made implicit by subtraits LowPriorityConversionCheckedConstraint (extended by ConversionCheckedTripleEquals), and overriden as non-implicit by the other subtraits in this package.

Value parameters

cnv

an implicit conversion from A to B

equalityOfB

an Equivalence[B] type class to which the Constraint.areEqual method will delegate to determine equality.

Attributes

Returns

an A CanEqual B instance whose areEqual method delegates to the areEquivalent method of the passed Equivalence[B].

Deprecated
[Since version 3.1.0] The lowPriorityConversionCheckedConstraint method has been deprecated and will be removed in a future version of ScalaTest. It is no longer needed now that the deprecation period of ConversionCheckedTripleEquals has expired. It will not be replaced.
Definition Classes
TripleEquals -> TripleEqualsSupport
Inherited from:
TripleEquals
def trap[T](f: => T): Throwable

Trap and return any thrown exception that would normally cause a ScalaTest test to fail, or create and return a new RuntimeException indicating no exception is thrown.

Trap and return any thrown exception that would normally cause a ScalaTest test to fail, or create and return a new RuntimeException indicating no exception is thrown.

This method is intended to be used in the Scala interpreter to eliminate large stack traces when trying out ScalaTest assertions and matcher expressions. It is not intended to be used in regular test code. If you want to ensure that a bit of code throws an expected exception, use intercept, not trap. Here's an example interpreter session without trap:

scala> import org.scalatest._
import org.scalatest._

scala> import Matchers._
import Matchers._

scala> val x = 12
a: Int = 12

scala> x shouldEqual 13
org.scalatest.exceptions.TestFailedException: 12 did not equal 13
  at org.scalatest.Assertions$class.newAssertionFailedException(Assertions.scala:449)
  at org.scalatest.Assertions$.newAssertionFailedException(Assertions.scala:1203)
  at org.scalatest.Assertions$AssertionsHelper.macroAssertTrue(Assertions.scala:417)
  at .<init>(<console>:15)
  at .<clinit>(<console>)
  at .<init>(<console>:7)
  at .<clinit>(<console>)
  at $print(<console>)
  at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
  at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
  at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
  at java.lang.reflect.Method.invoke(Method.java:597)
  at scala.tools.nsc.interpreter.IMain$ReadEvalPrint.call(IMain.scala:731)
  at scala.tools.nsc.interpreter.IMain$Request.loadAndRun(IMain.scala:980)
  at scala.tools.nsc.interpreter.IMain.loadAndRunReq$1(IMain.scala:570)
  at scala.tools.nsc.interpreter.IMain.interpret(IMain.scala:601)
  at scala.tools.nsc.interpreter.IMain.interpret(IMain.scala:565)
  at scala.tools.nsc.interpreter.ILoop.reallyInterpret$1(ILoop.scala:745)
  at scala.tools.nsc.interpreter.ILoop.interpretStartingWith(ILoop.scala:790)
  at scala.tools.nsc.interpreter.ILoop.command(ILoop.scala:702)
  at scala.tools.nsc.interpreter.ILoop.processLine$1(ILoop.scala:566)
  at scala.tools.nsc.interpreter.ILoop.innerLoop$1(ILoop.scala:573)
  at scala.tools.nsc.interpreter.ILoop.loop(ILoop.scala:576)
  at scala.tools.nsc.interpreter.ILoop$$anonfun$process$1.apply$mcZ$sp(ILoop.scala:867)
  at scala.tools.nsc.interpreter.ILoop$$anonfun$process$1.apply(ILoop.scala:822)
  at scala.tools.nsc.interpreter.ILoop$$anonfun$process$1.apply(ILoop.scala:822)
  at scala.tools.nsc.util.ScalaClassLoader$.savingContextLoader(ScalaClassLoader.scala:135)
  at scala.tools.nsc.interpreter.ILoop.process(ILoop.scala:822)
  at scala.tools.nsc.MainGenericRunner.runTarget$1(MainGenericRunner.scala:83)
  at scala.tools.nsc.MainGenericRunner.process(MainGenericRunner.scala:96)
  at scala.tools.nsc.MainGenericRunner$.main(MainGenericRunner.scala:105)
  at scala.tools.nsc.MainGenericRunner.main(MainGenericRunner.scala)

That's a pretty tall stack trace. Here's what it looks like when you use trap:

scala> trap { x shouldEqual 13 }
res1: Throwable = org.scalatest.exceptions.TestFailedException: 12 did not equal 13

Much less clutter. Bear in mind, however, that if no exception is thrown by the passed block of code, the trap method will create a new NormalResult (a subclass of Throwable made for this purpose only) and return that. If the result was the Unit value, it will simply say that no exception was thrown:

scala> trap { x shouldEqual 12 }
res2: Throwable = No exception was thrown.

If the passed block of code results in a value other than Unit, the NormalResult's toString will print the value:

scala> trap { "Dude!" }
res3: Throwable = No exception was thrown. Instead, result was: "Dude!"

Although you can access the result value from the NormalResult, its type is Any and therefore not very convenient to use. It is not intended that trap be used in test code. The sole intended use case for trap is decluttering Scala interpreter sessions by eliminating stack traces when executing assertion and matcher expressions.

Attributes

Deprecated
The trap method is no longer needed for demos in the REPL, which now abreviates stack traces, and will be removed in a future version of ScalaTest
Inherited from:
Assertions

Concrete fields

val preRegisteredPoolId: PoolKeyHash

Pre-registered pool ID in Yaci DevKit

Pre-registered pool ID in Yaci DevKit

Attributes

lazy override protected val testEnvName: String

Read SCALUS_TEST_ENV, default to "emulator"

Read SCALUS_TEST_ENV, default to "emulator"

Attributes

Inherited fields

val invokeBeforeAllAndAfterAllEvenIfNoTestsAreExpected: Boolean

Flag to indicate whether to invoke beforeAll and afterAll even when there are no tests expected.

Flag to indicate whether to invoke beforeAll and afterAll even when there are no tests expected.

The default value is false, which means beforeAll and afterAll will not be invoked if there are no tests expected. Whether tests are expected is determined by invoking expectedTestCount passing in the passed filter. Because this count does not include tests excluded based on tags, such as ignored tests, this prevents any side effects in beforeAll or afterAll if no tests will ultimately be executed anyway. If you always want to see the side effects even if no tests are expected, override this val and set it to true.

Attributes

Inherited from:
BeforeAndAfterAll
final val pipeChar: '|'

Attributes

Inherited from:
Assertions
final val succeed: Assertion

The Succeeded singleton.

The Succeeded singleton.

You can use succeed to solve a type error when an async test does not end in either Future[Assertion] or Assertion. Because Assertion is a type alias for Succeeded.type, putting succeed at the end of a test body (or at the end of a function being used to map the final future of a test body) will solve the type error.

Attributes

Inherited from:
Assertions

Deprecated and Inherited fields

val styleName: String

The styleName lifecycle method has been deprecated and will be removed in a future version of ScalaTest.

The styleName lifecycle method has been deprecated and will be removed in a future version of ScalaTest.

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 styleName.

Attributes

Deprecated
[Since version 3.1.0] The styleName lifecycle method has been deprecated and will be removed in a future version of ScalaTest with no replacement.
Inherited from:
SuiteMixin

Givens

Inherited givens

given TermShrink: Shrink[Term]

Attributes

Inherited from:
ArbitraryInstances
given TxIdV1: Arbitrary[TxId]

Attributes

Inherited from:
ArbitraryInstances
given arbAssocMap[A : Eq, B : Arbitrary]: Arbitrary[AssocMap[A, B]]

Attributes

Inherited from:
ArbitraryInstances
given arbData: Arbitrary[Data]

Attributes

Inherited from:
ArbitraryInstances
given arbList[A : Arbitrary]: Arbitrary[List[A]]

Attributes

Inherited from:
ArbitraryInstances
given arbOption[A : Arbitrary]: Arbitrary[Option[A]]

Attributes

Inherited from:
ArbitraryInstances
given arbSortedMap[A : Ord, B : Arbitrary]: Arbitrary[SortedMap[A, B]]

Attributes

Inherited from:
ArbitraryInstances
given arbitraryConstant: Arbitrary[Constant]

Attributes

Inherited from:
ArbitraryInstances
given arbitraryDefaultUni: Arbitrary[DefaultUni]

Attributes

Inherited from:
ArbitraryInstances
given arbitraryTerm: Arbitrary[Term]

Attributes

Inherited from:
ArbitraryInstances
given bArb: Arbitrary[B]

Attributes

Inherited from:
ArbitraryInstances
given byteStringArb: Arbitrary[ByteString]

Attributes

Inherited from:
ArbitraryInstances
given given_Arbitrary_Address: Arbitrary[Address]

Attributes

Inherited from:
ArbitraryInstances
given given_Arbitrary_Credential: Arbitrary[Credential]

Attributes

Inherited from:
ArbitraryInstances
given given_Arbitrary_Interval: Arbitrary[Interval]

Attributes

Inherited from:
ArbitraryInstances
given given_Arbitrary_IntervalBound: Arbitrary[IntervalBound]

Attributes

Inherited from:
ArbitraryInstances
given given_Arbitrary_IntervalBoundType: Arbitrary[IntervalBoundType]

Attributes

Inherited from:
ArbitraryInstances
given given_Arbitrary_OutputDatum: Arbitrary[OutputDatum]

Attributes

Inherited from:
ArbitraryInstances
given given_Arbitrary_Program: Arbitrary[Program]

Attributes

Inherited from:
ArbitraryInstances
given given_Arbitrary_PubKeyHash: Arbitrary[PubKeyHash]

Attributes

Inherited from:
ArbitraryInstances
given given_Arbitrary_ScriptPurpose: Arbitrary[ScriptPurpose]

Attributes

Inherited from:
ArbitraryInstances
given given_Arbitrary_StakingCredential: Arbitrary[StakingCredential]

Attributes

Inherited from:
ArbitraryInstances
given given_Arbitrary_TxId: Arbitrary[TxId]

Attributes

Inherited from:
ArbitraryInstances
given given_Arbitrary_TxInInfo: Arbitrary[TxInInfo]

Attributes

Inherited from:
ArbitraryInstances
given given_Arbitrary_TxInfo: Arbitrary[TxInfo]

Attributes

Inherited from:
ArbitraryInstances
given given_Arbitrary_TxOut: Arbitrary[TxOut]

Attributes

Inherited from:
ArbitraryInstances
given given_Arbitrary_TxOutRef: Arbitrary[TxOutRef]

Attributes

Inherited from:
ArbitraryInstances
given given_Arbitrary_Value: Arbitrary[Value]

Attributes

Inherited from:
ArbitraryInstances
given given_Ed25519Signer: Ed25519Signer

Attributes

Inherited from:
IntegrationTest
given given_Shrink_Constant: Shrink[Constant]

Attributes

Inherited from:
ArbitraryInstances
given given_Shrink_Data: Shrink[Data]

Attributes

Inherited from:
ArbitraryInstances
given given_Shrink_Program: Shrink[Program]

Attributes

Inherited from:
ArbitraryInstances
given iArb: Arbitrary[I]

Attributes

Inherited from:
ArbitraryInstances

Extensions

Inherited extensions

extension (self: SIR)
def runScript(using scalusOptions: Options = ...)(scriptContext: ScriptContext, param: Option[Data] = ...): Result

Attributes

Inherited from:
ScalusTest
def scriptV3(using scalusOptions: Options = ...)(errorTraces: Boolean = ...): Program

Attributes

Inherited from:
ScalusTest
extension (x: String)
inline def stripMargin: String

Attributes

Inherited from:
Assertions
extension (x: String)
inline def stripMargin(c: Char): String

Attributes

Inherited from:
Assertions

Deprecated and Inherited extensions

extension (self: Program)
def hash: ValidatorHash

Attributes

Deprecated
[Since version 0.14.2] will be removed
Inherited from:
ScalusTest
def runWithDebug(scriptContext: ScriptContext): Result

Attributes

Inherited from:
ScalusTest

Implicits

Inherited implicits

implicit override def convertToEqualizer[T](left: T): Equalizer[T]

Converts to an Equalizer that provides === and !== operators that result in Boolean and enforce no type constraint.

Converts to an Equalizer that provides === and !== operators that result in Boolean and enforce no type constraint.

This method is overridden and made implicit by subtrait TripleEquals and overriden as non-implicit by the other subtraits in this package.

Value parameters

left

the object whose type to convert to Equalizer.

Attributes

Throws
NullPointerException

if left is null.

Definition Classes
TripleEquals -> TripleEqualsSupport
Inherited from:
TripleEquals
implicit override def unconstrainedEquality[A, B](implicit equalityOfA: Equality[A]): CanEqual[A, B]

Provides an A CanEqual B instance for any two types A and B, with no type constraint enforced, given an implicit Equality[A].

Provides an A CanEqual B instance for any two types A and B, with no type constraint enforced, given an implicit Equality[A].

The returned Constraint's areEqual method uses the implicitly passed Equality[A]'s areEqual method to determine equality.

This method is overridden and made implicit by subtraits TripleEquals and overriden as non-implicit by the other subtraits in this package.

Value parameters

equalityOfA

an Equality[A] type class to which the Constraint.areEqual method will delegate to determine equality.

Attributes

Returns

an A CanEqual B instance whose areEqual method delegates to the areEqual method of the passed Equality[A].

Definition Classes
TripleEquals -> TripleEqualsSupport
Inherited from:
TripleEquals
Generated with