The constructors of all TestInstruction's have been changed to include the default argument SrcRef src=#:src. The reason for this is to improve the debugging of errors by enabling developers to jump directly to the test instruction that caused an error. Be sure to include this default argument in all classes extending TestInstruction and pass it along to super.

The following utility functions have been updated due to test case error messages being changed from simple strings to the new object TestCaseError. The error message is now instead contained in the new class.

Old: public str[] getErrors(str->Object blackboard) {
New: public TestCaseError[] getErrors(str->Object blackboard) {
Old: public void appendError(str->Object blackboard, str error) {
New: public void appendError(str->Object blackboard, str error, SrcRef src=#:src) {

class TestInstruction

Added a source reference to the constructor in order to know where in the code a TestInstruction instance is constructed. This is used when printing test errors and allows developers to jump directly to the source of the error. Be sure to include the default argument SrcRef src=#:src in the constructors of all TestInstruction-subclasses and pass it along to super.

Old: public constructor() {
New: public constructor(SrcRef src=#:src) {

Made the execute function abstract since it's required to be implemented by subclasses.

Old: extend public void execute(str->Object blackboard) { }
New: extend public void execute(str->Object blackboard) : abstract { }

class ValidateInstruction

The class has been made abstract as there is no reason to instantiate it by itself.

Old: public class ValidateInstruction extends TestInstruction {
New: public class ValidateInstruction extends TestInstruction : abstract {

class CopySnapperInstruction

This class has been removed. As replacement, use a combination of CopyInstruction, CutInstruction, PasteInstruction and PasteSelectionInstruction. These new instructions more closely mimic the default behaviour of the copy, cut and paste actions in CET.

Removed: class CopySnapperInstruction
Added: class CopyInstruction
Added: class CutInstruction
Added: class PasteInstruction
Added: class PasteSelectionInstruction

Since the default copy, cut and paste behaviour use the active selection and animations, you may also want to combine them with SelectSnapperInstruction and SimulateAnimationClickInstruction.

class InsertSnapperInstruction

All fields have been changed from public to private. The reason for this is that all of them can already be assigned via the constructors, and TestInstruction fields are in general not intended to be changeable afterwards.

Old: public Snapper snapper;
New: private Snapper snapper;
Old: public line mouseLine;
New: private line[] mouseLines;
Old: public str outputKey;
New: private str outputKey;
Old: public bool skipSnap;
New: private bool skipSnap;

InsertSnapperInstruction now supports simulating multiple clicks when inserting snappers, making it possible to insert things like lines that require both a start pos and end pos. To handle this, the line mouseLine field has been changed to a sequence, and the following constructors have been added:

Added: public constructor(Snapper snapper, line[] mouseLines, str outputKey=null, bool skipSnap=false)
Added: public constructor(SnapperSpawner spawner, line[] mouseLines, str outputKey=null, bool skipSnap=false)
Added: public constructor(Snapper snapper, point2D[] pos, str outputKey=null, bool skipSnap=false)
Added: public constructor(SnapperSpawner spawner, point2D[] pos, str outputKey=null, bool skipSnap=false)

class InsertSimpleWallLineInstruction

This class has been removed. Instead use the more general InsertSnapperInstruction.

Removed: class InsertSimpleWallLineInstruction

Example:

Old: InsertSimpleWallLineInstruction((0.0, 0.0, 0.0), (2.0, 0.0, 0.0), outputKey="wall");
New: InsertSnapperInstruction(SimpleWallLine(), [(0.0, 0.0), (2.0, 0.0)], outputKey="wall");

class InsertWallLineInstruction

This class has been removed. Instead use the more general InsertSnapperInstruction.

Removed: class InsertWallLineInstruction

Example:

Old: InsertWallLineInstruction((0.0, 0.0, 0.0), (2.0, 0.0, 0.0), outputKey="wall");
New: InsertSnapperInstruction(WallLine(), [(0.0, -0.1), (2.0, -0.1)], outputKey="wall", skipSnap=true);

To set the thickness and height of the wall, use the new PutQuickPropInstruction.

PutQuickPropInstruction("wall", "d", Distance(0.2.distance)); // Set thickness to 0.2
PutQuickPropInstruction("wall", "h", Distance(1.8.distance), ensureValidProps=true); // Set thickness to 1.8

Please note that the insert position may vary slightly because the InsertSnapperInstruction utilizes the standard insert animation, whereas InsertWallLineInstruction did not. Normally, you need to offset the position by the thickness of the wall to end up at the same position as before.

Since InsertWallLineInsruction did not use an insert animation, it also ignored snapping. To get the same behaviour, set the parameter skipSnap=true.

class SwitchToView2DInstruction

This class has been removed and should be replaced with the new SwitchToViewInstruction.

A 1 to 1 replacement would look like this: SwitchToView2DInstruction() -> SwitchToViewInstruction(viewOption.splitHorizontal, viewType.view2DType) But if the test doesn't require a split view, the following is sufficient SwitchToViewInstruction(viewOption.threeD)

class SwitchToView3DInstruction

This class has been removed and should be replaced with the new SwitchToViewInstruction.

A 1 to 1 replacement would look like this: SwitchToView3DInstruction() -> SwitchToViewInstruction(viewOption.splitHorizontal, viewType.view3DType) But if the test doesn't require a split view, the following is sufficient SwitchToViewInstruction(viewOption.twoD)

class ValidateFieldValueInstruction

This class has been removed. Instead, use GetFieldValueInstruction followed by ValidateValueInstruction.

Removed: class ValidateFieldValueInstruction
Added: class GetFieldValueInstruction

class FreezeSnappersInstruction

This class has been removed. Instead, use ToggleFreezeInstruction. ToggleFreezeInstruction freezes or unfreezes items in the active selection (same as using the ctrl+e shortcut). If you need to update the active selection, use SelectSnapperInstruction.

Removed: class FreezeSnappersInstruction
Added: class ToggleFreezeInstruction

class UnfreezeSnappersInstruction

This class has been removed. Instead, use ToggleFreezeInstruction. ToggleFreezeInstruction freezes or unfreezes items in the active selection (same as using the ctrl+e shortcut). If you need to update the active selection, use SelectSnapperInstruction.

Removed: class UnfreezeSnappersInstruction
Added: class ToggleFreezeInstruction

class ClickConnectorInstruction

Added a default SrcRef argument to all constructors.

Old: public constructor(..) {
New: public constructor(.., SrcRef src=#:src) {

Combined the str snapperKey and str connectorKey into one. If the key refers to a connector, the connector will be clicked. If it refers to a snapper, all connectors on that snapper will be clicked.

Old: public constructor(str snapperKey) {
New: public constructor(str connectorKey, SrcRef src=#:src) {
Removed: public constructor(str snapperKey, str connectorKey, SrcRef src=#:src) {

Changed fields to private as they are not intended to be assigned outside of the constructor.

Old: public str snapperKey;
New: private str snapperKey;

class CompareListsInstruction

Added a default SrcRef argument to all constructors.

Old: public constructor(..) {
New: public constructor(.., SrcRef src=#:src) {

Changed fields to private as they are not intended to be assigned outside of the constructor.

Old: public str listKey1;
New: private public str listKey1;
Old: public str listKey2;
New: private public str listKey2;
Old: public function(Object, Object):bool equalsFunction;
New: private public function(Object, Object):bool equalsFunction;
Old: public function(Object):str itemToLabelFunction;
New: private function(Object):str itemToLabelFunction;

class DragSnapperInstruction

Added a default SrcRef argument to all constructors.

Old: public constructor(..) {
New: public constructor(.., SrcRef src=#:src) {

Changed fields to private as they are not intended to be assigned outside of the constructor.

Old: public str : public str snapperKey;
New: private str : public str snapperKey;
Old: public line : public line mouseLine;
New: private line : public line mouseLine;
Old: public str->Object : public str->Object props
New: private str->Object : public str->Object props
Old: public bool : public bool skipSnap;
New: private bool : public bool skipSnap;

class GetChildSnappersInstruction

Added a default SrcRef argument to all constructors.

Old: public constructor(..) {
New: public constructor(.., SrcRef src=#:src) {

Changed fields to private as they are not intended to be assigned outside of the constructor.

Old: public str snapperKey;
New: private str snapperKey;
Old: public str outputKey
New: private str outputKey
Old: public SnapperFilter filter;
New: private SnapperFilter filter;
Old: public bool recursive;
New: private bool recursive;

class GetConnectorOfClassInstruction -> GetConnectorInstruction

The class has been renamed from GetConnectorOfClassInstruction to GetConnectorInstruction and a new constructor has been added.

Old: public constructor(str snapperKey, Class connectorClass, str outputKey) {
New: public constructor(str snapperKey, Class connectorClass, str outputKey, SrcRef src=#:src) {
Added: public constructor(str snapperKey, str connectorClassName, str outputKey, SrcRef src=#:src) {

class GetFieldValueInstruction

Added a default SrcRef argument to all constructors.

Old: public constructor(..) {
New: public constructor(.., SrcRef src=#:src) {

Changed fields to private as they are not intended to be assigned outside of the constructor.

Old: public str objectKey;
New: private str objectKey;
Old: public str fieldName;
New: private str fieldName;
Old: public str outputKey;
New: private str outputKey;

class GetPartsFromSpaceInstruction

Added a default SrcRef argument to all constructors.

Old: public constructor(..) {
New: public constructor(.., SrcRef src=#:src) {

Changed fields to private as they are not intended to be assigned outside of the constructor.

Old: public str outputKey;
New: private str outputKey;

class GetSelectionInstruction

Added a default SrcRef argument to all constructors.

Old: public constructor(..) {
New: public constructor(.., SrcRef src=#:src) {

Changed fields to private as they are not intended to be assigned outside of the constructor.

Old: public bool onlyMain;
New: private bool onlyMain;
Old: public str outputKey;
New: private str outputKey;

class GetSpaceSnappersInRectInstruction

Added a default SrcRef argument to all constructors.

Old: public constructor(..) {
New: public constructor(.., SrcRef src=#:src) {

Changed fields to private as they are not intended to be assigned outside of the constructor.

Old: public SnapperFilter filter;
New: private SnapperFilter filter;
Old: public str outputKey;
New: private str outputKey;
Old: public rect r;
New: private rect r;

class GetSpaceSnappersInstruction

Added a default SrcRef argument to all constructors.

Old: public constructor(..) {
New: public constructor(.., SrcRef src=#:src) {

Changed fields to private as they are not intended to be assigned outside of the constructor.

Old: public SnapperFilter filter;
New: private SnapperFilter filter;
Old: public str outputKey;
New: private str outputKey;

class IndexListItemsInstruction

Added a default SrcRef argument to all constructors.

Old: public constructor(..) {
New: public constructor(.., SrcRef src=#:src) {

Changed fields to private as they are not intended to be assigned outside of the constructor.

Old: public str listKey;
New: private str listKey;
Old: public str outputKey;
New: private str outputKey;

class LoadDataInstruction

Added a default SrcRef argument to all constructors.

Old: public constructor(..) {
New: public constructor(.., SrcRef src=#:src) {

Changed fields to private as they are not intended to be assigned outside of the constructor.

Old: public Url url;
New: private Url url;
Old: public str outputKey;
New: private str outputKey;

class PutAnimationPropInstruction

Added a default SrcRef argument to all constructors.

Old: public constructor(..) {
New: public constructor(.., SrcRef src=#:src) {

Changed fields to private as they are not intended to be assigned outside of the constructor.

Old: public str propKey;
New: private str propKey;
Old: public Object value;
New: private Object value;

class PutPropInstruction

Added a default SrcRef argument to all constructors.

Old: public constructor(..) {
New: public constructor(.., SrcRef src=#:src) {

Changed fields to private as they are not intended to be assigned outside of the constructor.

Old: public str snapperKey;
New: private str snapperKey;
Old: public str propKey;
New: private str propKey;
Old: public Object value;
New: private Object value;

class RemoveSnapperInstruction

Added a default SrcRef argument to all constructors.

Old: public constructor(..) {
New: public constructor(.., SrcRef src=#:src) {

Changed fields to private as they are not intended to be assigned outside of the constructor.

Old: public str snapperKey;
New: private str snapperKey;

class RotateSnapperInstruction

Added a default SrcRef argument to all constructors.

Old: public constructor(..) {
New: public constructor(.., SrcRef src=#:src) {

Changed fields to private as they are not intended to be assigned outside of the constructor.

Old: public str snapperKey;
New: private str snapperKey;
Old: public angle rotAngle;
New: private angle rotAngle;

class SaveDataInstruction

Added a default SrcRef argument to all constructors.

Old: public constructor(..) {
New: public constructor(.., SrcRef src=#:src) {

Changed fields to private as they are not intended to be assigned outside of the constructor.

Old: public Url url;
New: private Url url;
Old: public str dataKey;
New: private str dataKey;

class SelectSnapperInstruction

Added a default SrcRef argument to all constructors.

Old: public constructor(..) {
New: public constructor(.., SrcRef src=#:src) {

Changed fields to private as they are not intended to be assigned outside of the constructor.

Old: public str snapperKey;
New: private str snapperKey;

class SortListInstruction

Added a default SrcRef argument to all constructors.

Old: public constructor(..) {
New: public constructor(.., SrcRef src=#:src) {

Changed fields to private as they are not intended to be assigned outside of the constructor.

Old: public str listKey;
New: private str listKey;
Old: public function(Snapper, Snapper, Object):int sortFunction;
New: private function(Snapper, Snapper, Object):int sortFunction;
Old: public Object sortEnv;
New: private Object sortEnv;

class ValidateAnyOfSeveralPropValuesInstruction

Added a default SrcRef argument to all constructors.

Old: public constructor(..) {
New: public constructor(.., SrcRef src=#:src) {

Changed fields to private as they are not intended to be assigned outside of the constructor.

Old: public str snapperKey;
New: private str snapperKey;
Old: public str propKey;
New: private str propKey;
Old: public Object{} expectedValues;
New: private Object{} expectedValues;

class ValidateBoundInstruction

Added a default SrcRef argument to all constructors.

Old: public constructor(..) {
New: public constructor(.., SrcRef src=#:src) {

Changed fields to private as they are not intended to be assigned outside of the constructor.

Old: public str snapperKey;
New: private str snapperKey;
Old: public Vector expectedSize;
New: private Vector expectedSize;

class ValidateConnectedToInstruction

Added a default SrcRef argument to all constructors.

Old: public constructor(..) {
New: public constructor(.., SrcRef src=#:src) {

Changed fields to private as they are not intended to be assigned outside of the constructor.

Old: public str fromSnapperKey;
New: private str fromSnapperKey;
Old: public str toSnapperKey;
New: private str toSnapperKey;

class ValidateIsActiveInstruction

Added a default SrcRef argument to all constructors.

Old: public constructor(..) {
New: public constructor(.., SrcRef src=#:src) {

Changed fields to private as they are not intended to be assigned outside of the constructor.

Old: public str snapperKey;
New: private str snapperKey;

class ValidateIsAliveInstruction

Added a "expectedValue" argument.

Old: public constructor(str snapperKey) {
New: public constructor(str snapperKey, bool expectedValue=true, SrcRef src=#:src) {

Changed fields to private as they are not intended to be assigned outside of the constructor.

Old: public str snapperKey;
New: private str snapperKey;

class ValidateConnectionCountInstruction

Added a default SrcRef argument to all constructors.

Old: public constructor(..) {
New: public constructor(.., SrcRef src=#:src) {

Changed fields to private as they are not intended to be assigned outside of the constructor.

Old: public str snapperKey;
New: private str snapperKey;
Old: public Int expectedConnections;
New: private Int expectedConnections;
Old: public SnapperFilter filter;
New: private SnapperFilter filter;

class ValidateListCountInstruction

This class has been changed to support lists other than sequences and sets of snappers.

Note that due compiler-technical reasons, not all lists are supported. It currently supports Snappers and TreeViewItems. If you need this expanded, please contact Configura Support.

Old: public str snapperKey;
New: private str key;
Old: public Int expectedListCount;
New: private Int expectedListCount;
Old: public constructor(str snapperKey, Int expectedListCount) {
New: public constructor(str key, Int expectedListCount, SrcRef src=#:src) {

class ValidateLocalBoundInstruction

Added a default SrcRef argument to all constructors.

Old: public constructor(..) {
New: public constructor(.., SrcRef src=#:src) {

Changed fields to private as they are not intended to be assigned outside of the constructor.

Old: public str snapperKey;
New: private str snapperKey;
Old: public Vector expectedSize;
New: private Vector expectedSize;

class ValidateChildCountInstruction

Added a default SrcRef argument to all constructors.

Old: public constructor(..) {
New: public constructor(.., SrcRef src=#:src) {

Changed fields to private as they are not intended to be assigned outside of the constructor.

Old: public str snapperKey;
New: private str snapperKey;
Old: public Int expectedChildCount;
New: private Int expectedChildCount;
Old: public SnapperFilter filter;
New: private SnapperFilter filter;
Old: public bool recursive;
New: private bool recursive;

class ValidateIsSuspendedInstruction

Added a default SrcRef argument to all constructors.

Old: public constructor(..) {
New: public constructor(.., SrcRef src=#:src) {

Changed fields to private as they are not intended to be assigned outside of the constructor.

Old: public str snapperKey;
New: private str snapperKey;

class ValidatePartQuantityInstruction

Added a default SrcRef argument to all constructors.

Old: public constructor(..) {
New: public constructor(.., SrcRef src=#:src) {

Changed fields to private as they are not intended to be assigned outside of the constructor.

Old: public str articleCode;
New: private str articleCode;
Old: public double expectedQuantity;
New: private double expectedQuantity;

class ValidatePropDoesNotExistInstruction

Added a default SrcRef argument to all constructors.

Old: public constructor(..) {
New: public constructor(.., SrcRef src=#:src) {

Changed fields to private as they are not intended to be assigned outside of the constructor.

Old: public str snapperKey;
New: private str snapperKey;
Old: public str propKey;
New: private str propKey;

class ValidatePartSpecOptionInstruction

Added a default SrcRef argument to all constructors.

Old: public constructor(..) {
New: public constructor(.., SrcRef src=#:src) {

Changed fields to private as they are not intended to be assigned outside of the constructor.

Old: public str articleCode;
New: private str articleCode;
Old: public str expectedCode;
New: private str expectedCode;
Old: public Str expectedDescription;
New: private Str expectedDescription;
Old: public Int expectedSequence;
New: private Int expectedSequence;
Old: public Int expectedLevel;
New: private Int expectedLevel;
Old: public Str expectedGroupDescription;
New: private Str expectedGroupDescription;
Old: public <str, str> expectedUserDefined;
New: private <str, str> expectedUserDefined;
Old: public Bool expectedExportable;
New: private Bool expectedExportable;

class ValidateTreeViewItemKeyInstruction

Added a default SrcRef argument to all constructors.

Old: public constructor(..) {
New: public constructor(.., SrcRef src=#:src) {

Changed fields to private as they are not intended to be assigned outside of the constructor.

Old: public str expectedKey;
New: private str expectedKey;
Old: public str treeViewItemKey;
New: private str treeViewItemKey;

class ValidateTreeViewItemIsCheckedInstruction

Added a default SrcRef argument to all constructors.

Old: public constructor(..) {
New: public constructor(.., SrcRef src=#:src) {

Changed fields to private as they are not intended to be assigned outside of the constructor.

Old: public Object expected;
New: private Object expected;
Old: public str itemKey;
New: private str itemKey;

class ValidateOrientationInstruction

Added a default SrcRef argument to all constructors.

Old: public constructor(..) {
New: public constructor(.., SrcRef src=#:src) {

Changed fields to private as they are not intended to be assigned outside of the constructor.

Old: public str snapperKey;
New: private str snapperKey;
Old: public Orientation expectedRot;
New: private Orientation expectedRot;

class ValidatePropValueInstruction

Added a default SrcRef argument to all constructors.

Old: public constructor(..) {
New: public constructor(.., SrcRef src=#:src) {

Changed fields to private as they are not intended to be assigned outside of the constructor.

Old: public str snapperKey;
New: private str snapperKey;
Old: public str propKey;
New: private str propKey;
Old: public Object expectedValue;
New: private Object expectedValue;

class ValidateRotationInstruction

Added a default SrcRef argument to all constructors.

Old: public constructor(..) {
New: public constructor(.., SrcRef src=#:src) {

Changed fields to private as they are not intended to be assigned outside of the constructor.

Old: public str snapperKey;
New: private str snapperKey;
Old: public orientation expectedRot;
New: private orientation expectedRot;

class ValidateSnapperGMaterialInstruction

Added a default SrcRef argument to all constructors.

Old: public constructor(..) {
New: public constructor(.., SrcRef src=#:src) {

Changed fields to private as they are not intended to be assigned outside of the constructor.

Old: public str snapperKey;
New: private str snapperKey;
Old: public GMaterial3D expectedMaterial;
New: private GMaterial3D expectedMaterial;

class ValidatePositionInstruction

Added a default SrcRef argument to all constructors.

Old: public constructor(..) {
New: public constructor(.., SrcRef src=#:src) {

Changed fields to private as they are not intended to be assigned outside of the constructor.

Old: public str snapperKey;
New: private str snapperKey;
Old: public Point expectedPos;
New: private Point expectedPos;

class ValidateTreeViewItemIsEnabledInstruction

Added a default SrcRef argument to all constructors.

Old: public constructor(..) {
New: public constructor(.., SrcRef src=#:src) {

Changed fields to private as they are not intended to be assigned outside of the constructor.

Old: public bool expectedEnabled;
New: private bool expectedEnabled;
Old: public str itemKey;
New: private str itemKey;

class ValidateAnimationPropValueInstruction

Added a default SrcRef argument to all constructors.

Old: public constructor(..) {
New: public constructor(.., SrcRef src=#:src) {

Changed fields to private as they are not intended to be assigned outside of the constructor.

Old: public str propKey;
New: private str propKey;
Old: public Object expectedValue;
New: private Object expectedValue;

class ClickConnectorInstruction

The click functionality now more closely mimics what happens when a user clicks a connector in CET, in other words it reads the snapClickAnimation(..) from the snapper and calls animate(..) on it.

if (Animation a = c.snapper.snapClickAnimation(c)) {
    animate(a);
    simulateAnimationClick(line());
}

Previously, it was written specifically to handle SnapClickAnimation's and would call executeToggleConnection(..) directly on them instead of going through the proper animation chain.

if (?SnapClickAnimation clickAnimation = c.clickAnimation()) {
    Connector attach = c.connection();
    if (!attach) {
	for (a in c.connections()) { attach = a; break; }
    }
    if (attach) {
	clickAnimation.currentSpace.beginUndoStep();
	clickAnimation.executeToggleConnection(attach, true);
	clickAnimation.currentSpace.endUndoStep();
    }
 }

As a result of this change, more of the click animation's code, such as begin() and end(), will be executed which can lead to behaviour changes. However, it is not likely to require any code adjustments.