Template Expressions
Many of command/assertion parameters accept templates. So you can use template variables and expressions. For example,
page.goto("https://github.com/{{ USER }}/puppetry/") or TARGET.type("name{{ counter() }}")By using Settings/Template Variables panel we can define a set of variables per environment. For an instance, we can declare a separate target app URL for every environment (test.acme.com, stage.acme.com, www.acme.com). Before running/exporting test project we specify the desired environment and the corresponding template tags will be replaced with the value (URL) given for that environment.
To edit template variables click on Project/Template variables in the main menu:
Template variables in the Project menu
Under the table Template variables you will find a manageable table with variables (by default it's empty):
Template variables panel
You can use this UI the same way to do with targets, suits, and test cases. The difference is that the displayed variables belong to the selected environment:
Selecting destination environment
As you add a new variable let's say to test environment it appears in all available environments. But when you update it's value, the value stays unique per environment.
Also note the edit action link next to the environment selector. When you click it you get a modal window where you can manage the list of environments:
Editing environments
After we assigned the variables and running the tests (or exporting them for CI) in the modal window we can choose what environment we target:
Destinating test run for a given environment
{{ VARIABLE_NAME }}
The tag makes Puppetry injecting the variable value assigned for the selected environment into the container string
{{ BASE_URL }}/api/{{ API_VERSION }}/method
Template variables can be also assigned dynamically. E.g. you can use
page.assignVar to define a variable by using expressions or page.assignVarRemotely to define a variable by using REST API (learn more).Template expressions are basically functions that we may want to use for building template string.
Test step parameters supporting templates provided with a helper widget, which you can you to autofill the field:
Template helper widget
{{ env( NAME ) }}
{{ env( "SECRET" ) }}
{{ counter() }}
Function increments every time it called, but is unique per command/assertion
joe.{{ counter() }}@acme.com
This template resolves in email addresses [email protected], [email protected] and so on
{{ uniqid() }}
Function generates a unique id like
8fzk2g5fpkb{{ uniqid() }}
{{ iterate( LIST ) }}
Function iterates through a given list. It starts from the beginning as it reaches the end
{{ iterate(["[email protected]", "[email protected]", "[email protected]"]) }}
This template resolves in [email protected], [email protected], [email protected], [email protected], ...
{{ random( LIST ) }}
Function picks a random value out of a given list.
{{ random(["[email protected]", "[email protected]", "[email protected]"]) }}
{{ htmlOf( TARGET ) }}
Function extracts content (innerHTML) of a given TARGET.
{{ htmlOf("FOO") }}
{{ attributeOf( TARGET, ATTRIBUTE_NAME ) }}
Function retrieve attribute value of a given TARGET.
{{ attributeOf("FOO", "href") }}
{{ propertyOf( TARGET, PROPERTY_NAME ) }}
Function retrieve property value of a given TARGET.
{{ propertyOf("FOO", "checked") }}
{{ fake( FAKER_METHOD, LOCALE ) }}
{{ faker("address.streetSuffix", "en_GB") }}
{{ eval( "JavaScript code" ) }}
Function injects the given JavaScript into the suite code forming the string.
{{ eval("process.cwd()") }}
resolves into
`${ process.cwd() }`
NPM modules "fs", "path" and "os" as well as Command API (https://docs.puppetry.app/command-api) are available for evaluation.
Quotation marks in the JavaScript code have to be escaped.
Last modified 1yr ago