Package software.amazon.smithy.diff.testrunner

Class SmithyDiffTestCase

java.lang.Object

software.amazon.smithy.diff.testrunner.SmithyDiffTestCase

public final class SmithyDiffTestCase
extends java.lang.Object

Runs a single test case by loading corresponding models `a` and `b` and ensuring the resulting events match the diff events stored in a `-----` separated file.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SmithyDiffTestCase.Error	Thrown when errors are encountered while unwrapping a test case.
static class	SmithyDiffTestCase.Result	Output of diffing a model against a test case.

Constructor Summary

Constructors

Constructor	Description
SmithyDiffTestCase(java.nio.file.Path path, java.lang.String name, java.util.List<ValidationEvent> expectedEvents)

Method Summary

Modifier and Type	Method	Description
SmithyDiffTestCase.Result	createResult(java.util.List<ValidationEvent> actualEvents)	Creates a test case result from a list of model diff events.
static SmithyDiffTestCase	from(java.nio.file.Path path, java.lang.String name)	Creates a test case from a test case path and name.
java.util.List<ValidationEvent>	getExpectedEvents()	Gets the expected validation events.
java.lang.String	getName()	Gets the name of the test case.
java.nio.file.Path	getPath()	Gets the parent path of the test case.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SmithyDiffTestCase

public SmithyDiffTestCase(java.nio.file.Path path,
                          java.lang.String name,
                          java.util.List<ValidationEvent> expectedEvents)

Parameters:

path - Parent path of where the model and event files are stored.

name - Name of the test case

expectedEvents - The expected diff events to encounter.

Method Detail

from

public static SmithyDiffTestCase from(java.nio.file.Path path,
                                      java.lang.String name)

Creates a test case from a test case path and name.

The models and events file are expected to be stored in the same directory as the model and events file are assumed to be named the same barring the file extensions: `.a.(json|smithy)`, `.b.(json|smithy)`, `.events`.

The accompanying events file is a `-----` separated list of event strings, where each event is defined in the following format: [SEVERITY] shapeId message | EventId filename:line:column. A shapeId of "-" means that a specific shape is not targeted.

Parameters:

path - Parent path of where the model and event files are stored.

name - Name of the test case

Returns:

Returns the created test case.

getPath

public java.nio.file.Path getPath()

Gets the parent path of the test case.

Returns:

parent path of the test case.

getName

public java.lang.String getName()

Gets the name of the test case.

Returns:

name of the test case.

getExpectedEvents

public java.util.List<ValidationEvent> getExpectedEvents()

Gets the expected validation events.

Returns:

Expected validation events.

createResult

public SmithyDiffTestCase.Result createResult(java.util.List<ValidationEvent> actualEvents)

Creates a test case result from a list of model diff events.

The diff events encountered are compared against the expected validation events. An actual event (A) is considered a match with an expected event (E) if A and E target the same shape, have the same severity, the eventId of A contains the eventId of E, and the message of E starts with the suppression reason or message of A.

Parameters:

actualEvents - List of actual diff events.

Returns:

Returns the created test case result.