JSUnit

(jsunit)

Overview

The JSUnitAssertFunctions class provides a comprehensive set of assertion methods for unit testing in Servoy. It supports operations such as equality checks, regular expression matching, null checks, and conditional assertions. These methods enable the validation of test outcomes with detailed messages and tolerances for specific scenarios like floating-point comparisons. Assertions can evaluate conditions as true or false, verify object definitions, or ensure two values are the same or different. Additional functions allow forcing test failures and checking against expected exceptions.

Methods Summarized

Type

Name

Summary

void

Asserts that two values are equal.

void

Asserts that two values are equal.

void

Asserts that a condition is false.

void

Asserts that a condition is false.

void

Asserts that two floating point values are equal to within a given tolerance.

void

Asserts that two floating point values are equal to within a given tolerance.

void

Asserts that a regular expression matches a string.

void

Asserts that a regular expression matches a string.

void

Asserts that an object is not null.

void

Asserts that an object is not null.

void

Asserts that two values are not the same.

void

Asserts that two values are not the same.

void

Asserts that an object is not undefined.

void

Asserts that an object is not undefined.

void

Asserts that an object is null.

void

Asserts that an object is null.

void

Asserts that two values are the same.

void

Asserts that two values are the same.

void

Asserts that a condition is true.

void

Asserts that a condition is true.

void

Asserts that an object is undefined.

void

Asserts that an object is undefined.

void

Fails a test.

void

Fails a test.

void

Fails a test.

Methods Detailed

assertEquals(expected, actual)

Asserts that two values are equal. AssertionFailedError is thrown if the actual value does not match the regular expression.

Parameters

Object expected the expected value.
Object actual the actual value.

Returns: void

Sample

// Asserts that two values are equal. AssertionFailedError is thrown if the actual value does not match the regular expression.
jsunit.assertEquals("Solution name test", "someSolution", application.getSolutionName());
jsunit.assertEquals("Simple math test", 2, 1 + 1);

assertEquals(message, expected, actual)

Asserts that two values are equal. AssertionFailedError is thrown if the actual value does not match the regular expression.

Parameters

String message The test description/message.
Object expected the expected value.
Object actual the actual value.

Returns: void

Sample

// Asserts that two values are equal. AssertionFailedError is thrown if the actual value does not match the regular expression.
jsunit.assertEquals("Solution name test", "someSolution", application.getSolutionName());
jsunit.assertEquals("Simple math test", 2, 1 + 1);

assertFalse(boolean_condition)

Asserts that a condition is false. AssertionFailedError is thrown if the evaluation was not false.

Parameters

Boolean boolean_condition the actual value.

Returns: void

Sample

// Asserts that a condition is false. AssertionFailedError is thrown if the evaluation was not false.
jsunit.assertFalse("False test", application.isLastPrintPreviewPrinted());

assertFalse(message, boolean_condition)

Asserts that a condition is false. AssertionFailedError is thrown if the evaluation was not false.

Parameters

String message The test description/message.
Boolean boolean_condition the actual value.

Returns: void

Sample

// Asserts that a condition is false. AssertionFailedError is thrown if the evaluation was not false.
jsunit.assertFalse("False test", application.isLastPrintPreviewPrinted());

assertFloatEquals(expectedFloat, actualFloat, tolerance)

Asserts that two floating point values are equal to within a given tolerance. AssertionFailedError is thrown if the expected value is not within the tolerance of the actual one.

Parameters

Number expectedFloat the expected value.
Number actualFloat the actual value.
Number tolerance tolerance when comparing.

Returns: void

Sample

// Asserts that two floating point values are equal to within a given tolerance. AssertionFailedError is thrown if the expected value is not within the tolerance of the actual one.
jsunit.assertFloatEquals("Float equals test", 3.12, 3.121, 0.0015);

assertFloatEquals(message, expectedFloat, actualFloat, tolerance)

Asserts that two floating point values are equal to within a given tolerance. AssertionFailedError is thrown if the expected value is not within the tolerance of the actual one.

Parameters

String message The test description/message.
Number expectedFloat the expected value.
Number actualFloat the actual value.
Number tolerance tolerance when comparing.

Returns: void

Sample

// Asserts that two floating point values are equal to within a given tolerance. AssertionFailedError is thrown if the expected value is not within the tolerance of the actual one.
jsunit.assertFloatEquals("Float equals test", 3.12, 3.121, 0.0015);

assertMatches(regularExpression, actualString)

Asserts that a regular expression matches a string. AssertionFailedError is thrown if the expected value is not the actual one.

Parameters

Object regularExpression the regular expression used for matching.
String actualString the actual value to be matched.

Returns: void

Sample

// Asserts that a regular expression matches a string. AssertionFailedError is thrown if the expected value is not the actual one.
jsunit.assertMatches(new RegExp("gr(a|e)y"), "gray");

assertMatches(message, regularExpression, actualString)

Asserts that a regular expression matches a string. AssertionFailedError is thrown if the expected value is not the actual one.

Parameters

String message The test description/message.
Object regularExpression the regular expression used for matching.
String actualString the actual value to be matched.

Returns: void

Sample

// Asserts that a regular expression matches a string. AssertionFailedError is thrown if the expected value is not the actual one.
jsunit.assertMatches("Match test", new RegExp("gr(a|e)y"), "gray");

assertNotNull(object)

Asserts that an object is not null. AssertionFailedError is thrown if the object is not null.

Parameters

Object object the actual value.

Returns: void

Sample

// Asserts that an object is not null. AssertionFailedError is thrown if the object is not null.
var a; // this is undefined, not null
jsunit.assertNotNull(a);

assertNotNull(message, object)

Asserts that an object is not null. AssertionFailedError is thrown if the object is not null.

Parameters

String message The test description/message.
Object object the actual value.

Returns: void

Sample

// Asserts that an object is not null. AssertionFailedError is thrown if the object is not null.
var a; // this is undefined, not null
jsunit.assertNotNull("Not null test", a);

assertNotSame(notExpected, actual)

Asserts that two values are not the same. AssertionFailedError is thrown if the expected value is the actual one.

Parameters

Object notExpected the value that is not expected.
Object actual the actual value.

Returns: void

Sample

// Asserts that two values are not the same. AssertionFailedError is thrown if the expected value is the actual one.
var a = new Date(1990, 1, 1);
var b = new Date(1990, 1, 1);
jsunit.assertNotSame(a, b);
jsunit.assertEquals("But equals", a, b);

assertNotSame(message, notExpected, actual)

Asserts that two values are not the same. AssertionFailedError is thrown if the expected value is the actual one.

Parameters

String message The test description/message.
Object notExpected the value that is not expected.
Object actual the actual value.

Returns: void

Sample

// Asserts that two values are not the same. AssertionFailedError is thrown if the expected value is the actual one.
var a = new Date(1990, 1, 1);
var b = new Date(1990, 1, 1);
jsunit.assertNotSame("Not same test", a, b);
jsunit.assertEquals("But equals", a, b);

assertNotUndefined(definedObject)

Asserts that an object is not undefined. AssertionFailedError is thrown if the object is undefined.

Parameters

Object definedObject the actual value.

Returns: void

Sample

// Asserts that an object is not undefined. AssertionFailedError is thrown if the object is undefined.
var a = 0;
jsunit.assertNotUndefined(a);

assertNotUndefined(message, definedObject)

Asserts that an object is not undefined. AssertionFailedError is thrown if the object is undefined.

Parameters

String message The test description/message.
Object definedObject the actual value.

Returns: void

Sample

// Asserts that an object is not undefined. AssertionFailedError is thrown if the object is undefined.
var a = 0;
jsunit.assertNotUndefined("Not undefined test", a);

assertNull(nullValue)

Asserts that an object is null. AssertionFailedError is thrown if the object is not null.

Parameters

Object nullValue the actual value.

Returns: void

Sample

// Asserts that an object is null. AssertionFailedError is thrown if the object is not null.
jsunit.assertNull("Null test", null);

assertNull(message, nullValue)

Asserts that an object is null. AssertionFailedError is thrown if the object is not null.

Parameters

String message The test description/message.
Object nullValue the actual value.

Returns: void

Sample

// Asserts that an object is null. AssertionFailedError is thrown if the object is not null.
jsunit.assertNull("Null test", null);

assertSame(expected, actual)

Asserts that two values are the same. AssertionFailedError is thrown if the expected value is not the actual one.

Parameters

Object expected the expected value.
Object actual the actual value.

Returns: void

Sample

// Asserts that two values are the same. AssertionFailedError is thrown if the expected value is not the actual one.
var a = new Date(1990, 1, 1);
var b = a;
jsunit.assertSame(a, b);

assertSame(message, expected, actual)

Asserts that two values are the same. AssertionFailedError is thrown if the expected value is not the actual one.

Parameters

String message The test description/message.
Object expected the expected value.
Object actual the actual value.

Returns: void

Sample

// Asserts that two values are the same. AssertionFailedError is thrown if the expected value is not the actual one.
var a = new Date(1990, 1, 1);
var b = a;
jsunit.assertSame("Same test", a, b);

assertTrue(boolean_condition)

Asserts that a condition is true. AssertionFailedError is thrown if the evaluation was not true.

Parameters

Boolean boolean_condition the actual value.

Returns: void

Sample

// Asserts that a condition is true. AssertionFailedError is thrown if the evaluation was not true.
jsunit.assertTrue("True test", application.isLastPrintPreviewPrinted());

assertTrue(message, boolean_condition)

Asserts that a condition is true. AssertionFailedError is thrown if the evaluation was not true.

Parameters

String message The test description/message.
Boolean boolean_condition the actual value.

Returns: void

Sample

// Asserts that a condition is true. AssertionFailedError is thrown if the evaluation was not true.
jsunit.assertTrue("True test", application.isLastPrintPreviewPrinted());

assertUndefined(undefinedValue)

Asserts that an object is undefined. AssertionFailedError is thrown if the object is defined.

Parameters

Object undefinedValue the actual value.

Returns: void

Sample

// Asserts that an object is undefined. AssertionFailedError is thrown if the object is defined.
jsunit.assertUndefined("Undefined test", thisIsUndefined);

assertUndefined(message, undefinedValue)

Asserts that an object is undefined. AssertionFailedError is thrown if the object is defined.

Parameters

String message The test description/message.
Object undefinedValue the actual value.

Returns: void

Sample

// Asserts that an object is undefined. AssertionFailedError is thrown if the object is defined.
jsunit.assertUndefined(thisIsUndefined);

fail(message)

Fails a test. AssertionFailedError is always thrown.

Parameters

String message The test description/message. This is usually the only parameter specified when calling this method.

Returns: void

Sample

// Fails a test. AssertionFailedError is always thrown.
jsunit.fail("Fail test");
jsunit.fail("test", null, "Fail"); // 2nd param is not used in Servoy, params 3 and 1 get merged to form a message. The result is the same as in the line above.

fail(message, instanceOfCallStack)

Fails a test. AssertionFailedError is always thrown.

Parameters

String message The test description/message. This is usually the only parameter specified when calling this method.
Object instanceOfCallStack an internal JSUnit call stack. Use null for this if you want to get to the next optional parameter. Usually not specified.

Returns: void

Sample

// Fails a test. AssertionFailedError is always thrown.
jsunit.fail("Fail test");
jsunit.fail("test", null, "Fail"); // 2nd param is not used in Servoy, params 3 and 1 get merged to form a message. The result is the same as in the line above.

fail(message, instanceOfCallStack, userMessage)

Fails a test. AssertionFailedError is always thrown.

Parameters

String message The test description/message. This is usually the only parameter specified when calling this method.
Object instanceOfCallStack an internal JSUnit call stack. Use null for this if you want to get to the next optional parameter. Usually not specified.
String userMessage a user message. Usually not specified.

Returns: void

Sample

// Fails a test. AssertionFailedError is always thrown.
jsunit.fail("Fail test");
jsunit.fail("test", null, "Fail"); // 2nd param is not used in Servoy, params 3 and 1 get merged to form a message. The result is the same as in the line above.

PreviousDataException NextDatasources

Last updated 2 days ago