Expressions

With Testerum, you can evaluate JavaScript expressions using the following template: {{expression}} These expressions can be as simple as {{12 + 44}}, more complex
{{new Date().toISOString().substr(0, 10)}} or as complex as you like:

{{
  (function(){
    var futureDate = new Date();
    futureDate.setDate(futureDate.getDate()+10);
    return futureDate.toISOString().substr(0, 10);
  })()
}}

You can use Testerum Expressions:

when defining a Global Variable
when defining a Scenario Variable
when defining a Run Configuration Setting
in any part of the Test

Useful Functions

Testerum comes with a number of pre-built functions to make it easy to write expressions.

Escape Functions

escapeJson (
    text: String
): String

Escapes the characters in a String using JSON String rules.

Escapes any values it finds into their JSON String form - in such a way that the result may be safely included in a JSON String. Deals correctly with quotes and control-chars (tab, backslash, cr, ff, etc.)

For example, a tab becomes the characters '\' and 't'.

See RFC 4627 for further details.

Parameters:

text

Type: String. The text to escape, may be null.

the escaped text, ready to be included as part of a JSON string, or null if the parameter was null

given a variable text with the value He didn't say, "Stop!", the expression {{escapeJson(text)}} will return He didn't say, \"Stop!\"

unescapeJson (
    text: String
): String

Unescapes any JSON literals found in the given argument.

For example, it will turn a sequence of '\' and 'n' into a newline character, unless the '\' is preceded by another '\'.

Parameters:

text

Type: String. The String to unescape, may be null.

the unescaped String, or null if the parameter was null

given a variable text with the value He didn't say, \"Stop!\", the expression {{unescapeJson(text)}} will return He didn't say, "Stop!"

escapeXml (
    text: String
): String

Escapes the characters in a String using XML entities, using XML 1.0 rules.

For example: "bread" & "butter" => "bread" & "butter"

Note that XML 1.0 is a text-only format: it cannot represent control characters or unpaired Unicode surrogate codepoints, even after escaping. escapeXml() will remove characters that do not fit in the following ranges:

#x9 | #xA | #xD | [#x20-#xD7FF] | [#xE000-#xFFFD] | [#x10000-#x10FFFF]

Though not strictly necessary, escapeXml() will escape characters in the following ranges:

[#x7F-#x84] | [#x86-#x9F]

The returned string can be inserted into a valid XML 1.0 or XML 1.1 document. If you want to allow more non-text characters in an XML 1.1 document, use escapeXml11().

Note: this function escapes a String using XML 1.0 rules. XML 1.0 is the most widely used XML version.
If you need to escape a String using XML 1.1 rules, use escapeXml11() instead.

Parameters:

text

Type: String. The String to escape, may be null.

the escaped String, or null if the parameter was null

given a variable text with the value "bread" & "butter", the expression {{escapeXml(text)}} will return "bread" & "butter"

escapeXml11 (
    text: String
): String

Escapes the characters in a String using XML entities, using XML 1.1 rules.

XML 1.1 can represent certain control characters, but it cannot represent the null byte or unpaired Unicode surrogate codepoints, even after escaping. escapeXml11() will remove characters that do not fit in the following ranges:

[#x1-#xD7FF] | [#xE000-#xFFFD] | [#x10000-#x10FFFF]

escapeXml11() will escape characters in the following ranges:

[#x1-#x8] | [#xB-#xC] | [#xE-#x1F] | [#x7F-#x84] | [#x86-#x9F]

The returned string can be inserted into a valid XML 1.1 document. Do not use it for XML 1.0 documents.

Note: this function escapes a String using XML 1.1 rules. XML 1.1 is not used very much.
If you need to escape a String using XML 1.0 rules, use escapeXml() instead.

Parameters:

text

Type: String. The String to escape, may be null.

the escaped String, or null if the parameter was null

given a variable text with the value "bread" & "butter", the expression {{escapeXml11(text)}} will return "bread" & "butter"

unescapeXml (
    text: String
): String

Unescapes a string containing XML entity escapes to a string containing the actual Unicode characters corresponding to the escapes.

Supports only the five basic XML entities (gt, lt, quot, amp, apos). Does not support DTDs or external entities.

Note that numerical \\u Unicode codes are unescaped to their respective Unicode characters. This may change in future releases.

Parameters:

text

Type: String. The String to unescape, may be null.

the unescaped String, or null if the parameter was null

given a variable text with the value "bread" & "butter", the expression {{unescapeXml(text)}} will return "bread" & "butter"

escapeJavaScript (
    text: String
): String

Escapes the characters in a String using JavaScript String rules.

Escapes any values it finds into their JavaScript String form - in such a way that the result may be safely included in a JavaScript String. Deals correctly with quotes and control-chars (tab, backslash, cr, ff, etc.)

So a tab becomes the characters '\' and 't'.

Parameters:

text

Type: String. The String to escape, may be null.

the escaped String, or null if the parameter was null

given a variable text with the value He didn't say, "Stop!", the expression {{escapeJavaScript(text)}} will return He didn\'t say, \"Stop!\"

unescapeJavaScript (
    text: String
): String

Unescapes any JavaScript literals found in the String.

For example, it will turn a sequence of '\' and 'n' into a newline character, unless the '\' is preceded by another '\'.

Parameters:

text

Type: String. The String to unescape, may be null.

the unescaped String, or null if the parameter was null

given a variable text with the value He didn't say, \"Stop!\", the expression {{unescapeJavaScript(text)}} will return He didn't say, "Stop!"

escapeHtml (
    text: String
): String

Escapes the characters in a String using HTML entities.

For example, "bread" & "butter" becomes: "bread" & "butter".

Supports all known HTML 4.0 entities, including funky accents. Note that the commonly used apostrophe escape character (') is not a legal entity and so is not supported).

Parameters:

text

Type: String. The String to escape, may be null.

the escaped String, or null if the parameter was null

given a variable text with the value "bread" & "butter", the expression {{escapeHtml(text)}} will return "bread" & "butter"

unescapeHtml (
    text: String
): String

Unescapes a string containing entity escapes to a string containing the actual Unicode characters corresponding to the escapes. Supports HTML 4.0 entities.

For example, the string "<Français>" will become "<Français>"

If an entity is unrecognized, it is left alone, and inserted verbatim into the result string. e.g. ">&zzzz;x" will become ">&zzzz;x".

Parameters:

text

Type: String. The String to unescape, may be null.

the unescaped String, or null if the parameter was null

given a variable text with the value "<Français>", the expression {{unescapeHtml(text)}} will return "<Français>"

Date Functions

Using the Date pre-built functions, Testerum allows you to:

create a Date or DateTime that you want
generate the current Date or DateTime
add or substract different amount of time on the current date
transform the Date into a String format that you want

Constructor functions

currentDate ()
: TesterumDate

Generates the current DateTime. When is transformed to string, by default the format is ISO-8601 yyyy-MM-dd'T'HH:mm:ss.SSS

TesterumDate object

{{currentDate()}} - returns the current date

date (
  year: Integer,
  month: Integer,
  dayOfMonth: Integer,
  hour: Integer,
  minute: Integer,
  second: Integer,
  nanoOfSecond: Integer
): TesterumDate

Generates a date from the provided parameters. When is transformed to string, by default the format is ISO-8601 yyyy-MM-dd'T'HH:mm:ss.SSS

Parameters:

year

Type: Integer

month

Type: Integer

dayOfMonth

Type: Integer

hour

Type: Integer

minute

Type: Integer

second

Type: Integer

nanoOfSecond

Type: Integer

TesterumDate object

{{date(1981, 10, 31)}} - returns the date of 1981-10-31
{{date(1981, 10, 31, 17, 10, 59)}} - returns the date of 1981-10-31T17:10:59
{{date(1981, 10, 31, 17, 10, 59, 233)}} - returns the date of 1981-10-31T17:10:59.233

Methods

minusYears (
  years: Integer
): TesterumDate

Return a copy of the TesterumDate with the specified number of years subtracted.

Parameters:

years

Type: Integer. The years to subtract, may be negative

TesterumDate object

{{currentDate().minusYears(2)}} - returns the current date minus two years
{{date(1981, 10, 31).minusYears(5)}} - returns the date of 1976-10-31

plusYears (
  years: Integer
): TesterumDate

Return a copy of the TesterumDate with the specified number of years added.

Parameters:

years

Type: Integer. The years to add, may be negative

TesterumDate object

{{currentDate().plusYears(2)}} - returns the current date plus two years
{{date(1981, 10, 31).plusYears(5)}} - returns the date of 1986-10-31

minusMonths (
  months: Integer
): TesterumDate

Return a copy of the TesterumDate with the specified number of months subtracted.

Parameters:

months

Type: Integer. The months to subtract, may be negative

TesterumDate object

{{currentDate().minusMonths(2)}} - returns the current date minus two months
{{date(1981, 10, 31).minusMonths(5)}} - returns the date of 1981-5-31

plusMonths (
  months: Integer
): TesterumDate

Return a copy of the TesterumDate with the specified number of months added.

Parameters:

months

Type: Integer. The months to add, may be negative

TesterumDate object

{{currentDate().plusMonths(2)}} - returns the current date plus two months
{{date(1981, 10, 31).plusMonths(5)}} - returns the date of 1982-03-31

minusDays (
  days: Integer
): TesterumDate

Return a copy of the TesterumDate with the specified number of days subtracted.

Parameters:

days

Type: Integer. The days to subtract, may be negative

TesterumDate object

{{currentDate().minusDays(2)}} - returns the current date minus two days
{{date(1981, 10, 31).minusDays(5)}} - returns the date of 1981-10-26

plusDays (
  days: Integer
): TesterumDate

Return a copy of the TesterumDate with the specified number of days added.

Parameters:

days

Type: Integer. The days to add, may be negative

TesterumDate object

{{currentDate().plusDays(2)}} - returns the current date plus two days
{{date(1981, 10, 31).plusDays(5)}} - returns the date of 1981-11-05

minusHours (
  hours: Integer
): TesterumDate

Return a copy of the TesterumDate with the specified number of hours subtracted.

Parameters:

hours

Type: Integer. The hours to subtract, may be negative

TesterumDate object

{{currentDate().minusHours(2)}} - returns the current date minus two hours
{{date(1981, 10, 31, 17, 10, 59, 233).minusHours(5)}} - returns the date of 1981-10-31T12:10:59.233

plusHours (
  hours: Integer
): TesterumDate

Return a copy of the TesterumDate with the specified number of hours added.

Parameters:

hours

Type: Integer. The hours to add, may be negative

TesterumDate object

{{currentDate().plusHours(2)}} - returns the current date plus two hours
{{date(1981, 10, 31, 17, 10, 59, 233).plusHours(5)}} - returns the date of 1981-10-31T22:10:59.233

minusMinutes (
  minutes: Integer
): TesterumDate

Return a copy of the TesterumDate with the specified number of minutes subtracted.

Parameters:

minutes

Type: Integer. The minutes to subtract, may be negative

TesterumDate object

{{currentDate().minusMinutes(2)}} - returns the current date minus two minutes
{{date(1981, 10, 31, 17, 10, 59, 233).minusMinutes(5)}} - returns the date of 1981-10-31T17:05:59.233

plusMinutes (
  minutes: Integer
): TesterumDate

Return a copy of the TesterumDate with the specified number of minutes added.

Parameters:

minutes

Type: Integer. The minutes to add, may be negative

TesterumDate object

{{currentDate().plusMinutes(2)}} - returns the current date plus two minutes
{{date(1981, 10, 31, 17, 10, 59, 233).plusMinutes(5)}} - returns the date of 1981-10-31T17:15:59.233

minusSeconds (
  seconds: Integer
): TesterumDate

Return a copy of the TesterumDate with the specified number of seconds subtracted.

Parameters:

seconds

Type: Integer. The seconds to subtract, may be negative

TesterumDate object

{{currentDate().minusSeconds(2)}} - returns the current date minus two seconds
{{date(1981, 10, 31, 17, 10, 59, 233).minusSeconds(5)}} - returns the date of 1981-10-31T17:10:54.233

plusSeconds (
  seconds: Integer
): TesterumDate

Return a copy of the TesterumDate with the specified number of seconds added.

Parameters:

seconds

Type: Integer. The seconds to add, may be negative

TesterumDate object

{{currentDate().plusSeconds(2)}} - returns the current date plus two seconds
{{date(1981, 10, 31, 17, 10, 59, 233).plusSeconds(5)}} - returns the date of 1981-10-31T17:11:04.233

toString (
  pattern: String
): String

This method is used to return the TesterumDate as a String in the default or a custom format.
If no parameter is provided the date will be formatted as ISO-8601 yyyy-MM-dd'T'HH:mm:ss.SSS

Parameters:

pattern

Type: String.
This parameter is the pattern to be used to format the date as String. You can use the following symbols in your formatting pattern:

Letter	Date or Time Component	Presentation	Examples
`G`	Era designator	Text	`AD`
`y`	Year	Year	`1996`; `96`
`Y`	Week year	Year	`2009`; `09`
`M`	Month in year	Month	`July`; `Jul`; `07`
`w`	Week in year	Number	`27`
`W`	Week in month	Number	`2`
`D`	Day in year	Number	`189`
`d`	Day in month	Number	`10`
`F`	Day of week in month	Number	`2`
`E`	Day name in week	Text	`Tuesday`; `Tue`
`u`	Day number of week (1 = Monday, ..., 7 = Sunday)	Number	`1`
`a`	Am/pm marker	Text	`PM`
`H`	Hour in day (0-23)	Number	`0`
`k`	Hour in day (1-24)	Number	`24`
`K`	Hour in am/pm (0-11)	Number	`0`
`h`	Hour in am/pm (1-12)	Number	`12`
`m`	Minute in hour	Number	`30`
`s`	Second in minute	Number	`55`
`S`	Millisecondd	Number	`978`

For more information see DateTimeFormatter.
Note that the date to format is a LocalDateTime, which means that you can't use timezone fields in your pattern (z, Z, or X).

The formatted date as string

{{currentDate().toString()}} - returns the current formatted as ISO-8601 yyyy-MM-dd'T'HH:mm:ss.SSS
{{date(2011, 12, 03).toString('d MMM uuuu')}} - returns the a String

'3 Dec 2011'

{{date(2016, 11, 09, 10, 30, 21).toString('yyyy-MM-dd HH:mm')}} - returns the a String

'2016-11-09 10:30'

Random String by Regex Function

generateStringByRegex (
  regex: String
): String

Generate and return a random String that matches the Regex pattern.

Parameters:

regex

Type: String. The regular expression used to build the random String

a random String that match the Regex pattern.

{{generateStringByRegex("[0-3]([a-c]|[e-g]{1,2})")}} - return a String something like 2eg
{{generateStringByRegex("([a-z0-9]+)[@]([a-z0-9]+)[.]([a-z0-9]+)")}} - return a random email address

Random Data Generation Functions

When testing, generating data as close as possible to reality might be a very useful

Methods

PERSON NAME DATA GENERATION

dataGenerator().name().fullName()
: String

A multipart name composed of an optional prefix, a given and family name, another 'firstname' for the middle name and an optional suffix such as Jr.

a random name with a middle name component with optional prefix and suffix

"Mrs. Ella Geraldine Fitzgerald"
"Jason Tom Sawyer Jr."
"Helen Jessica Troy"

dataGenerator().name().firstName()
: String

Returns a random 'given' name such as Aaliyah, Aaron, Abagail or Abbey

a 'given' name such as Aaliyah, Aaron, Abagail or Abbey

dataGenerator().name().lastName()
: String

Returns a random last name such as Smith, Jones or Baldwin

a random last name such as Smith, Jones or Baldwin

dataGenerator().name().prefix()
: String

Returns a name prefix such as Mr., Mrs., Ms., Miss, or Dr.

a name prefix such as Mr., Mrs., Ms., Miss, or Dr.

dataGenerator().name().suffix()
: String

Returns a name suffix such as Jr., Sr., I, II, III, IV, V, MD, DDS, PhD or DVM

a name suffix such as Jr., Sr., I, II, III, IV, V, MD, DDS, PhD or DVM

ADDRESS DATA GENERATION

dataGenerator().address().fullAddress()
: String

Returns a full address such as "282 Kevin Brook, Imogeneborough, CA 58517"

dataGenerator().address().streetName()
: String

Returns a street name such as "Larkin Fork"

dataGenerator().address().streetAddressNumber()
: String

Returns a number such as "231"

dataGenerator().address().buildingNumber()
: String

Returns a number such as "7304"

dataGenerator().address().zip()
: String

Returns a zip code such as "58517" or "66259-8212"

dataGenerator().address().city()
: String

Returns a city name such as "Imogeneborough"

dataGenerator().address().state()
: String

Returns a state name such as "California"

dataGenerator().address().stateAbbr()
: String

Returns a state abbreviation such as "AP"

dataGenerator().address().timeZone()
: String

Returns a time zone such as "Asia/Yakutsk"

dataGenerator().address().country()
: String

Returns a country name such as "French Guiana"

dataGenerator().address().countryCode()
: String

Returns a country code such as "IT"

dataGenerator().address().latitude()
: String

Returns a latitude such as "-58.17256227443719"

dataGenerator().address().longitude()
: String

Returns a longitude such as "-156.65548382095133"

NUMBER GENERATION

dataGenerator().number().randomDigit()
: String

Returns a random number from 0-9 (both inclusive)

dataGenerator().number().randomDigitNotZero()
: String

Returns a random number from 1-9 (both inclusive)

dataGenerator().number().numberBetween(
  min: Long,
  max: Long
): Long

Return a number between min and max. If min == max, then min is returned. So numberBetween(2,2) will yield 2 even though it doesn't make sense.

Parameters:

min

Type: Long. The minimum inclusive value of the returned value

max

Type: Long. The maximum exclusive value of the returned value

dataGenerator().number().randomNumber(
  numberOfDigits: Integer,
  strict: Boolean
): String

Returns a random number based on the provided parameters. If no parameters are provided will have between 1 and 10 digits.

Parameters:

numberOfDigits

Type: Integer. The number of digits the generated value should have

strict

Type: Boolean. Whether or not the generated value should have exactly numberOfDigits

dataGenerator().number().randomDouble(
  maxNumberOfDecimals: Integer,
  min: Long,
  max: Long
): Long

Returns a random number based on the provided parameters. If no parameters are provided will have between 1 and 10 digits.

Parameters:

maxNumberOfDecimals

Type: Integer. The amount of decimals after the comma.

min

Type: Long. The minimum inclusive value of the returned value

max

Type: Long. The maximum exclusive value of the returned value

INTERNET DATA GENERATION

dataGenerator().internet().emailAddress()
: String

Returns an email address.

dataGenerator().internet().url()
: String

Returns an URL.

dataGenerator().internet().avatar()
: String

Generates a random avatar url based on a collection of profile pictures of real people. All this avatar have been authorized by its awesome users to be used on live websites (not just mockups). For more information, please visit: http://uifaces.com/authorized

An url to a random avatar image.

dataGenerator().internet().image(
  width: Integer,
  height: Integer,
  gray: Boolean,
  text: String
): String

Generates a random image url based on the lorempixel service. All the images provided by this service are released under the creative commons license (CC BY-SA). For more information, please visit: http://lorempixel.com/. If no parameters are provided returns a random image with random parameters. If you want to customize the picture you need to provide all the parameters.

Parameters:

width

Type: Integer. The image width

height

Type: Integer. The image height

gray

Type: Boolean. true for gray image and false for color image

text

Type: String. Custom text on the selected picture

an url to a random image.

dataGenerator().internet().password(
  minimumLength: Integer,
  maximumLength: Integer,
  includeUppercase: Boolean
): String

Generates a random password using also this special characters '!', '@', '#', '$', '%', '^', '&', '*'

Parameters:

minimumLength

Type: Integer.

maximumLength

Type: Integer.

includeUppercase

Type: Boolean. true to include upper case letters and false otherwise

dataGenerator().internet().ipV6Address()
: String

Returns an IPv4 address in dot separated octets.

dataGenerator().internet().ipV4Address()
: String

Returns an IPv6 address in hh:hh:hh:hh:hh:hh:hh:hh format.

LOREM DATA GENERATION

dataGenerator().lorem().character()
: String

Returns a character.

dataGenerator().lorem().characters(
  minimumLength: Integer,
  maximumLength: Integer,
  includeUppercase: Boolean
): String

Returns a string based on the provided parameters.

Parameters:

minimumLength

Type: Integer.

maximumLength

Type: Integer.

includeUppercase

Type: Boolean. true to include upper case letters and false otherwise

dataGenerator().lorem().word()
: String

Returns a lorem word String.

dataGenerator().lorem().sentence(
  wordCount: Integer
)

Create a sentence with a random number of words within the range (wordCount+1)..(wordCount+6).

Parameters:

wordCount

Type: Integer.

a random sentence.

dataGenerator().lorem().paragraph()
: String

Returns a paragraph with a random number of sentences between 1 and 3.

dataGenerator().lorem().fixedString(
  numberOfLetters: Integer,
): String

Create a string with a fixed size. Can be useful for testing validator based on length string for example

Parameters:

numberOfLetters

Type: Integer. Size of the expected String

a string with a fixed size.

FINANCE DATA GENERATION

dataGenerator().finance().creditCard()
: String

Returns a random credit card.

dataGenerator().business().creditCardNumber()
: String

Returns a random credit card number.

dataGenerator().business().creditCardType()
: String

Returns a random credit card type.

dataGenerator().business().creditCardExpiry()
: String

Returns a random credit card expiration date.

dataGenerator().finance().bic()
: String

Generates a random Business Identifier Code

dataGenerator().finance().iban(
  countryCode: String
): String

Generates a random IBAN. If a parameter with the countryCode is provided the IBAN will match the IBAN pattern of that country.

Parameters:

countryCode

Type: String. This value should be the two letters country code upper cased.

a IBAN as String.

COMPANY DATA GENERATION

dataGenerator().company().name()
: String

Returns a company name.

dataGenerator().company().suffix()
: String

Returns a company suffix.

dataGenerator().company().industry()
: String

Returns a company industry.

dataGenerator().company().logo()
: String

Generate a random company logo url in PNG format.