Jameleon - An Automated Testing Tool

Available Tags

This is a list of available tags for Jameleon Core. This list of tags is also available in the Jameleon GUI. You can get there by selecting the "Functional Points" tab on the lower-left. All tags, including custom tags and other enabled plug-ins' tags, show up in the GUI.

Jameleon Core Tags

Tag	Short Description
<application-tested/>	Documents the application tested.
<csv/>	Iterates over all nested tags one time per row of a CSV file.
<execute-jameleon-script/>	Used to acceptance test Jameleon tags.
<function-doc/>	Documents a single step of a test case.
<functional-point-tested/>	Documents which feature of the application the test case is testing.
<iterate/>	Iterates over all nested tags one time per object in a Collection.
<ju-assert-equals/>	Performs an assertEquals on two variables.
<ju-assert-not-null/>	Performs an assertNotNull on a given variable.
<ju-assert-null/>	Performs an assertNull on a given variable.
<ju-assert-true/>	Performs an assertTrue on a given expression.
<ju-session/>	A Session for the JUnit plug-in.
<map-variable/>	Used to map the value in one variable over to the value of another variable.
<param/>	Used to give a function tag a parameter or a list of parameters.
<param-name/>	Gives the parameter a name.
<param-type/>	Gives the parameter a variable type.
<param-value/>	Gives the parameter a value.
<postcondition/>	This tag is used to mark a group of tags as postconditions.
<precondition/>	This tag is used to mark a group of tags as preconditions.
<sql/>	Used to iterate over all tags it is surrounding one time per row in a SQL ResultSet.
<sql-param/>	Used to set binding parameter to the parent sql-update tag.
<sql-param-value/>	Used for set value of a sql-param.
<sql-update/>	Runs a delete or update SQL statement against the database.
<test-case-author/>	Documents the test case's author.
<test-case-bug/>	Describes a bug for a test case.
<test-case-id/>	Describes a unique id of the test case.
<test-case-level/>	Describes which test case level the test case should be executed under.
<test-case-requirement/>	Describes which requirement number the test case was written against.
<test-case-summary/>	Documents the summary of what the test case does.
<test-script/>	This is currently a tag meant to be nested inside the test-suite tag.
<test-suite/>	This is currently a tag meant to group several test case scripts.
<testcase/>	Every test case script must have at least one testcase tag containing all other Jameleon tags.
<variable-value/>	used only as a child of <map-variable/>, it allows the ability to map one or more.
<wait/>	Wait for the given number of milliseconds.

application-tested

Documents the application tested. This tag is used directly inside the <testcase/> tag. A example might be:

    <testcase xmlns="jelly:jameleon">
<test-case-summary>Tests some feature</test-case-summary>
<test-case-bug>3423</test-case-bug>
<test-case-author>Christian Hargraves</test-case-author>
<test-case-level>ACCEPTANCE</test-case-level>
<test-case-level>REGRESSION</test-case-level>
<functional-point-tested>csv</functional-point-tested>
<application-tested>framework</application-tested>
<test-case-requirement>AP-123</test-case-requirement>
<test-case-id>TC-123</test-case-id>
</testcase">

Take a look at this tag's API docs and source code for more information.

csv

Iterates over all nested tags one time per row of a CSV file. The name of the CSV file is based on the testEnvironment, organization, and the name attributes. The directory structure, then follows the testEnvironment then inside that directory the organization if set. The file name matches the name set in the csv attribute. For example, to execute the opening of an application and doing something n number of times:

    <testcase xmlns="jelly:jameleon">
<csv name="some_file_name_without_extension">
<some-session application="someApp" beginSession="true">
<some-tag-that-uses-context-variables
functionId="Verify successful navigation, using a different variable."/>
</some-session>
</csv>
</testcase>

Maybe opening the application n number of times takes too long, but each of the scenarios still need to be executed. Try putting the csv tag inside the session tag:

    <testcase xmlns="jelly:jameleon">
<some-session application="someApp" beginSession="true">
<csv name="some_file_name_without_extension">
<some-tag-that-uses-context-variables
functionId="Verify successful navigation, using a different variable."/>
</csv>
</some-session>
</testcase>

All values that are not defined in a CSV file will be considered 'null'. To define an empty String, simply define the value as "". For example:

    var1,var2,var3
one,"",

In the above example, var2 will be an empty string and var3 will be null.

Take a look at this tag's API docs and source code for more information.

Attribute Name	Description	Default	Required	Type
csvFileName	Sets the relative path to the name of the csv file. This does not use any logic in considering testEnvironment nor organization.		false	java.lang.String
name	Sets the name of the csv file to read in.		false	java.lang.String
csvDir	Sets the directory of the csv file to read in (relative to baseDir).		false	java.io.File
csvValueSeparator	Sets the separator used to separate CSV files.		false	char
csvCharset	Sets the character set to use when reading in the CSV file		false	java.lang.String
charset	Sets the character set to use to read the data file in.		false	java.lang.String
dataDir	Sets the directory of where the data will be looked for. The baseDir is then prepended on this		false	java.io.File
file	Sets the name of the file to use as a data source.		false	java.lang.String
countRow	Sets the DataDrivable tag to increment the number of times the test case was executed for each row executed.	false	false	boolean
stopTestExecutionOnFailure	To continue on a normal execution path even though an error occurs, set this to false		false	boolean
breakPoint	Sets a pause point to this class.		false	boolean

execute-jameleon-script

Used to acceptance test Jameleon tags. Executes a Jameleon script and checks various outputs.

Take a look at this tag's API docs and source code for more information.

Attribute Name	Description	Default	Required	Type
script	The script to execute		true	java.io.File
checkOutcomePassed	Pass only if the script passed		false	boolean
checkOutcomeFailed	Pass only if the script failed		false	boolean
noTestCaseResults	TODO		false	boolean
numOfFunctionsRun	The number of functional points that should be run from the script being executed	-1	false	int
numOfFailures	The number of failures that should fail from the script being executed	-1	false	int
noFailOnFunctionId	A functionId where no failure should occur		false	java.lang.String
numOfTestCasesRun	The number of test cases that should run from the script being executed (for when useCSV is set to true in the testcase tag)	-1	false	int
numOfTestCasesFailed	The number of test cases that should fail from the script being executed (for when useCSV is set to true in the testcase tag)	-1	false	int
testCaseDocsFile	The name of the generated test case doc file.		false	java.lang.String
executionTimeGreaterThan	The execution time should be greater than this number if set	-1	false	int
executionTimeLessThan	The execution time should be greater than this number if set	-1	false	int
lineNumFailed	The line # of the script that is stated as failing in the HTML . This requires the testCaseName attribute be set	-1	false	int
lineFailedReason	The given error message for failure in the HTML results		false	java.lang.String
lineFailedFunctionId	The functionId of the row that failed		false	java.lang.String
errorMsgContains	A snippet of the error message or reason for that is expected in stdout.		false	java.lang.String
testCaseName	A snippet of the error message or reason for that is expected in stdout.		false	java.lang.String
functionId	The id of this function. This is used in the macro as a short description of the function		true	java.lang.String
breakPoint	Tells the GUI to stop at this functional point		false	boolean
precondition	Specifies this is a precondition		false	boolean
postcondition	Specifies this is a postcondition and will therefore get executed even if a previous functional point or session tag failed.		false	boolean
expectFailure	Specifies a failure is expected.		false	boolean
expectException	Specifies an exception is expected.		false	boolean
functionDelay	The delay time to use at the end of each functional point	-1	false	long

function-doc

Documents a single step of a test case. This tag can be used to document manual test cases. Also, sometimes it is too difficult to fit everything in the functionId attribute of a tag because there is more than one thing happening.

Take a look at this tag's API docs and source code for more information.

Attribute Name	Description	Default	Required	Type
functionId	The id of this function. This is used in the macro as a short description of the function		true	java.lang.String
breakPoint	Tells the GUI to stop at this functional point		false	boolean
precondition	Specifies this is a precondition		false	boolean
postcondition	Specifies this is a postcondition and will therefore get executed even if a previous functional point or session tag failed.		false	boolean
expectFailure	Specifies a failure is expected.		false	boolean
expectException	Specifies an exception is expected.		false	boolean
functionDelay	The delay time to use at the end of each functional point	-1	false	long

functional-point-tested

Documents which feature of the application the test case is testing. This can be used to execute test cases that test only a certain feature set.

Take a look at this tag's API docs and source code for more information.

iterate

Iterates over all nested tags one time per object in a Collection. Sometimes you want to data-drive your test, but based on data that is defined in the application itself. This is a more generic way to data-drive your tags, based on a Collection of Objects that may be populated into the context via some other tag. For example:

    <testcase xmlns="jelly:jameleon">
<get-data-from-somewhere toVar="listOfAccounts"/>
<iterate varName="someVar" items="${listOfAccounts}">
<some-session application="someApp" beginSession="true">
<some-tag-that-uses-context-variables
functionId="Verify successful navigation, using a different variable."
attribute="${someVar}"/>
</some-session>
</iterate>
</testcase>

Take a look at this tag's API docs and source code for more information.

Attribute Name	Description	Default	Required	Type
items			true	java.util.Collection
varName			true	java.lang.String
id	This is primarily used for debugging. It also provides a means to distinguish between nested `IterateTag` tags.		false	java.lang.String
countRow	Sets the DataDrivable tag to increment the number of times the test case was executed for each row executed.	false	false	boolean
stopTestExecutionOnFailure	To continue on a normal execution path even though an error occurs, set this to false		false	boolean
breakPoint	Sets a pause point to this class.		false	boolean

ju-assert-equals

Performs an assertEquals on two variables. This tag, along with all JUnit tags can be used inside any other plug-in's session tag To compare two variables with a default JUnit error message on a failure:

    <testcase xmlns="jelly:jameleon">
<ju-session application="someApp">
<ju-assert-equals
functionId="Check that var1 equals var2."
expected="${var1}"
actual="${var2}"/>
</ju-session>
</testcase>

To compare two variables that gives "First Name" at the beginning of the failure message:

    <testcase xmlns="jelly:jameleon">
<jiffie-session application="someApp">
<ju-assert-equals
functionId="Check that var1 equals var2."
expected="${var1}"
actual="${var2}"
msg="First Name"/>
</jiffie-session>
</testcase>

Take a look at this tag's API docs and source code for more information.

Attribute Name	Description	Default	Required	Type
expected	The expected value		false	java.lang.Object
actual	The actual value		false	java.lang.Object
valuesAreStrings	Forces the values to be compared as Strings by calling the toString() method.	false	false	boolean
msg	The error message to display if the test fails		false	java.lang.String
functionId	The id of this function. This is used in the macro as a short description of the function		true	java.lang.String
breakPoint	Tells the GUI to stop at this functional point		false	boolean
precondition	Specifies this is a precondition		false	boolean
postcondition	Specifies this is a postcondition and will therefore get executed even if a previous functional point or session tag failed.		false	boolean
expectFailure	Specifies a failure is expected.		false	boolean
expectException	Specifies an exception is expected.		false	boolean
functionDelay	The delay time to use at the end of each functional point	-1	false	long

ju-assert-not-null

Performs an assertNotNull on a given variable. This tag, along with all JUnit tags can be used inside any other plug-in's session tag An example use might be:

    <testcase xmlns="jelly:jameleon" xmlns:j="jelly:core">
<j:set-var var="someVar" value="some value"/>
<ju-session application="someApp">
<ju-assert-not-null
functionId="Check that var1 equals var2."
value="${someVar}"/>
</ju-session>
</testcase>

Take a look at this tag's API docs and source code for more information.

Attribute Name	Description	Default	Required	Type
value	The value to be checked for null		false	java.lang.Object
msg	The error message to display if the test fails		false	java.lang.String
functionId	The id of this function. This is used in the macro as a short description of the function		true	java.lang.String
breakPoint	Tells the GUI to stop at this functional point		false	boolean
precondition	Specifies this is a precondition		false	boolean
postcondition	Specifies this is a postcondition and will therefore get executed even if a previous functional point or session tag failed.		false	boolean
expectFailure	Specifies a failure is expected.		false	boolean
expectException	Specifies an exception is expected.		false	boolean
functionDelay	The delay time to use at the end of each functional point	-1	false	long

ju-assert-null

Performs an assertNull on a given variable. This tag, along with all JUnit tags can be used inside any other plug-in's session tag An example use might be:

    <testcase xmlns="jelly:jameleon">
<ju-session application="someApp">
<ju-assert-null
functionId="Check that var1 equals var2."
value="${someNonExistentVar}"/>
</ju-session>
</testcase>

Take a look at this tag's API docs and source code for more information.

Attribute Name	Description	Default	Required	Type
value	The value to be checked for null		false	java.lang.Object
msg	The error message to display if the test fails		false	java.lang.String
functionId	The id of this function. This is used in the macro as a short description of the function		true	java.lang.String
breakPoint	Tells the GUI to stop at this functional point		false	boolean
precondition	Specifies this is a precondition		false	boolean
postcondition	Specifies this is a postcondition and will therefore get executed even if a previous functional point or session tag failed.		false	boolean
expectFailure	Specifies a failure is expected.		false	boolean
expectException	Specifies an exception is expected.		false	boolean
functionDelay	The delay time to use at the end of each functional point	-1	false	long

ju-assert-true

Performs an assertTrue on a given expression. This tag, along with all JUnit tags can be used inside any other plug-in's session tag The following is an example:

    <testcase xmlns="jelly:jameleon" xmlns:j="jelly:core">
<j:set var="greeting" value="Hello World!"/>
<ju-session>
<ju-assert-true
functionId="check that 'greeting' has at least one character in it"
test="${greeting.length() >= 1"/>
</ju-session>
</testcase>

Take a look at this tag's API docs and source code for more information.

Attribute Name	Description	Default	Required	Type
test	The test to be executed		true	org.apache.commons.jelly.expression.Expression
msg	The error message to display if the test fails		false	java.lang.String
functionId	The id of this function. This is used in the macro as a short description of the function		true	java.lang.String
breakPoint	Tells the GUI to stop at this functional point		false	boolean
precondition	Specifies this is a precondition		false	boolean
postcondition	Specifies this is a postcondition and will therefore get executed even if a previous functional point or session tag failed.		false	boolean
expectFailure	Specifies a failure is expected.		false	boolean
expectException	Specifies an exception is expected.		false	boolean
functionDelay	The delay time to use at the end of each functional point	-1	false	long

ju-session

A Session for the JUnit plug-in. An example of its use might:

    <testcase xmlns="jelly:jameleon">
<ju-session application="someApp">
<ju-assert-equals
functionId="Check that var1 equals var2."
expected="${var1}"
actual="${var2}"/>
</ju-session>
</testcase>

Take a look at this tag's API docs and source code for more information.

Attribute Name	Description	Default	Required	Type
application	The name of the application being run according to the *-TestCaseTag.properties file		false	java.lang.String
organization	The organization (affiliate or company name) this application will be tested against.		false	java.lang.String
postcondition			false	boolean
sessionDelay	Sets the tag to delay x milliseconds before anything else is executed.	0	false	long
beginSession	Starts the applicattion and gets it to the state defined in the $testEnviroment-Applications.properties. DEFAULTS to `false`		false	boolean

map-variable

Used to map the value in one variable over to the value of another variable. sThis is useful when the same functional point is being used more than once or when the same variable name is used between different functional points that are in the same test-case. The following is an example of creating a list and using it in a tag.

    <testcase xmlns="jelly:jameleon">
<map-variable toVariable="resultsText" variableType="list">
<variable-value>value 1</variable-value>
<variable-value>value 2</variable-value>
<variable-value>value 3</variable-value>
<variable-value>value 4</variable-value>
</map-variable/>

<some-session application="someApp" beginSession="true">
<some-tag-that-uses-context-variables
functionId="Verify successful navigation, using a different variable."
someVariable="${resultsText}/>
</some-session>
</testcase>

The following is an example of mapping one value of a variable to another variable (pretty much useless).

    <testcase xmlns="jelly:jameleon">

<some-session application="someApp" beginSession="true">
<some-tag-that-uses-context-variables
functionId="Verify successful navigation, using a different variable.">
<map-variable
fromVariable="resultsText1"
toVariable="resultsText"/>
</some-tag-that-uses-context-variables>
</some-session>
</testcase>

The following is an example of using the ${varName} notation (recommended)

    <testcase xmlns="jelly:jameleon">

<some-session application="someApp" beginSession="true">
<some-tag-that-uses-context-variables
functionId="Verify successful navigation, using a different variable."
resultsText="${resultsText1"/>
</some-session>
</testcase>

The following is an example of mapping multiple variable values to a single variable. Notice it's variableType is set to "list":

    <testcase xmlns="jelly:jameleon">

<some-session application="someApp" beginSession="true">
<some-tag-that-uses-context-variables
functionId="Verify successful navigation, using a different variable.">
<map-variable
fromVariable="resultsText1"
toVariable="resultsText"
variableType="list"/>
<map-variable
fromVariable="resultsText2"
toVariable="resultsText"
variableType="list"/>
<map-variable
fromVariable="resultsText3"
toVariable="resultsText"
variableType="list"/>
</some-tag-that-uses-context-variables>
</some-session>
</testcase>

The value(s) can be entered directly like so:

    <testcase xmlns="jelly:jameleon">

<some-session application="someApp" beginSession="true">
<some-tag-that-uses-context-variables
functionId="Verify successful navigation, using a different variable.">
<map-variable toVariable="resultsText" variableType="list">
<variable-value>value 1</variable-value>
<variable-value>value 2</variable-value>
<variable-value>value 3</variable-value>
<variable-value>value 4</variable-value>
</map-variable/>
</some-tag-that-uses-context-variables>
</some-session>
</testcase>

Take a look at this tag's API docs and source code for more information.

param

Used to give a function tag a parameter or a list of parameters. For example:

<param>
<param-name>someName</param-name>
<param-value>foo</param-value>
<param-type>text</param-type>
</param>

This tag adds itself to a list of param tags to the parent FunctionTag. It's up to the FunctionTag to use the parameters. They can be accessed via the {@link net.sf.jameleon.function.FunctionTag#getParams()} method.

Take a look at this tag's API docs and source code for more information.

param-name

Gives the parameter a name. For example:

<param>
<param-name>someName</param-name>
</param>

Take a look at this tag's API docs and source code for more information.

param-type

Gives the parameter a variable type. For example:

<param>
<param-name>someName</param-name>
<param-value>foo</param-value>
<param-type>text</param-type>
</param>

It's up to the function tag to interpret the param-type. For example, in an HTTP plug-in some types might be: checkbox, select, textarea, and etc ...

Take a look at this tag's API docs and source code for more information.

param-value

Gives the parameter a value. For example:

<param>
<param-name>someName</param-name>
<param-value>foo</param-value>
</param>

Take a look at this tag's API docs and source code for more information.

postcondition

This tag is used to mark a group of tags as postconditions. Marking a tag as a postcondition tag guarantees the execution of the tag. If the test case fails at a tag marked as a postcondition, then the results are marked as a postcondition failure.

Take a look at this tag's API docs and source code for more information.

precondition

This tag is used to mark a group of tags as preconditions. Marking a tag as a precondition tag doesn't change the functionality of the test case. If the test case fails at a tag marked as a precondition, then the results are marked as a precondition failure.

Take a look at this tag's API docs and source code for more information.

sql

Used to iterate over all tags it is surrounding one time per row in a SQL ResultSet. This tag should work with any RDBMS that provides a JDBC driver. One thing to remember is each JDBC driver seems to act a bit differently when returning the column names returned. Some JDBC drivers will returned the column names in all caps some will return them as undercase, while others may return them as defined when the table was created.

    <testcase xmlns="jelly:jameleon">
<sql query="SELECT ID, col1 as NAME, col2 as GENDER FROM TEST"
jdbcUsername="sa"
jdbcPassword=""
jdbcUrl="jdbc:hsqldb:hsqldb_sample"
jdbcDriver="org.hsqldb.jdbcDriver"
countRow="true">

<some-session application="someApp" beginSession="true">
<some-tag-that-uses-context-variables
functionId="Verify successful navigation, using a different variable."
id="${ID}"
name="${NAME}"
gender="${GENDER}"/>
</some-session>
</sql>
</testcase>

Take a look at this tag's API docs and source code for more information.

Attribute Name	Description	Default	Required	Type
jdbcDriver	Set the JDBC Driver needed for the Database Connection		true	java.lang.String
jdbcUrl	Set the JDBC URL for the Database Connection		true	java.lang.String
jdbcUsername	Set the JDBC UserName for the Database Connection		true	java.lang.String
jdbcPassword	Set the JDBC Password for the Database Connection		false	java.lang.String
query	Set the SQL Query for the Database Connection		true	java.lang.String
id	Set the SQL ID number This is primarily used for debugging. It also provides a means to distinguish between nested `SqlTag` tags.		false	java.lang.String
countRow	Sets the DataDrivable tag to increment the number of times the test case was executed for each row executed.	false	false	boolean
stopTestExecutionOnFailure	To continue on a normal execution path even though an error occurs, set this to false		false	boolean
breakPoint	Sets a pause point to this class.		false	boolean

sql-param

Used to set binding parameter to the parent sql-update tag. An example might be:

    <sql-update
functionId="Insert a row into test table via a prepared statement with multiple param values"
sqlUpdateSql="insert into test(test_str, test_str2) values(?,?)"/>
<sql-param>
<sql-param-value>text2>/sql-param-value>
<sql-param-value>text3>/sql-param-value>
</sql-param>
</sql-update>

Take a look at this tag's API docs and source code for more information.

sql-param-value

Used for set value of a sql-param. An example might be:

    <sql-update
functionId="Insert a row into test table via a prepared statement with multiple param values"
sqlUpdateSql="insert into test(test_str, test_str2) values(?,?)"/>
<sql-param>
<sql-param-value>text2>/sql-param-value>
<sql-param-value>text3>/sql-param-value>
</sql-param>
</sql-update>

Take a look at this tag's API docs and source code for more information.

sql-update

Runs a delete or update SQL statement against the database. Sometimes putting an application into a required state means connecting to a database and executing a SQL statment. This can be done with this tag. The SQL can be an insert, delete or update command. The body of this element should contain the SQL statement used. See the function tag docs for information on other attributes supported and/or required by this tag. An example might be:

    <junit-session xmlns:j="jelly:core">
<sql-update
functionId="Insert another row into test table"
jdbcDriver="org.hsqldb.jdbcDriver"
jdbcUrl="jdbc:hsqldb:tst/_tmp/jameleon_test2"
jdbcUsername="sa"
jdbcPassword="">
create cached table test2(
test_str varchar,
test_str2 varchar
);
</sql-update>
<sql-update
functionId="Delete row from test table"
jdbcDriver="org.hsqldb.jdbcDriver"
jdbcUrl="jdbc:hsqldb:tst/_tmp/jameleon_test2"
jdbcUsername="sa"
jdbcPassword="">
delete from test2 where test_str='some text';
-- some SQL comment
-- Another SQL comment
</sql-update>
</junit-session>

Take a look at this tag's API docs and source code for more information.

Attribute Name	Context Name	Description	Default	Required	Type
jdbcDriver	jdbc.driver	The jdbc driver		true	java.lang.String
jdbcUrl	jdbc.url	The jdbc url		true	java.lang.String
jdbcUsername	jdbc.username	The jdbc username		true	java.lang.String
jdbcPassword	jdbc.password	The jdbc password		false	java.lang.String
functionId		The id of this function. This is used in the macro as a short description of the function		true	java.lang.String
breakPoint		Tells the GUI to stop at this functional point		false	boolean
precondition		Specifies this is a precondition		false	boolean
postcondition		Specifies this is a postcondition and will therefore get executed even if a previous functional point or session tag failed.		false	boolean
expectFailure		Specifies a failure is expected.		false	boolean
expectException		Specifies an exception is expected.		false	boolean
functionDelay		The delay time to use at the end of each functional point	-1	false	long
sqlUpdateSql				false	java.lang.String

test-case-author

Documents the test case's author. This tag is used directly inside the <testcase/> tag. A example might be:

    <testcase xmlns="jelly:jameleon">
<test-case-summary>Tests some feature</test-case-summary>
<test-case-bug>3423</test-case-bug>
<test-case-author>Christian Hargraves</test-case-author>
<test-case-level>ACCEPTANCE</test-case-level>
<test-case-level>REGRESSION</test-case-level>
<functional-point-tested>csv</functional-point-tested>
<application-tested>framework</application-tested>
<test-case-requirement>AP-123</test-case-requirement>
<test-case-id>TC-123</test-case-id>
</testcase">

Take a look at this tag's API docs and source code for more information.

test-case-bug

Describes a bug for a test case. To provide a link in the test case documentation for the both GUI and the HTML results simply set the bugTrackerUrl parameter the Jameleon configuration. This tag is used directly inside the <testcase/> tag. A example might be:

    <testcase xmlns="jelly:jameleon">
<test-case-summary>Tests some feature</test-case-summary>
<test-case-bug>3423</test-case-bug>
<test-case-author>Christian Hargraves</test-case-author>
<test-case-level>ACCEPTANCE</test-case-level>
<test-case-level>REGRESSION</test-case-level>
<functional-point-tested>csv</functional-point-tested>
<application-tested>framework</application-tested>
<test-case-requirement>AP-123</test-case-requirement>
<test-case-id>TC-123</test-case-id>
</testcase">

Take a look at this tag's API docs and source code for more information.

test-case-id

Describes a unique id of the test case. Can be used to link to an independent system like TestLink. This tag is used directly inside the <testcase/> tag. A example might be:

    <testcase xmlns="jelly:jameleon">
<test-case-summary>Tests some feature</test-case-summary>
<test-case-bug>3423</test-case-bug>
<test-case-author>Christian Hargraves</test-case-author>
<test-case-level>ACCEPTANCE</test-case-level>
<test-case-level>REGRESSION</test-case-level>
<functional-point-tested>csv</functional-point-tested>
<application-tested>framework</application-tested>
<test-case-requirement>AP-123</test-case-requirement>
<test-case-id>TC-123</test-case-id>
</testcase">

Take a look at this tag's API docs and source code for more information.

test-case-level

Describes which test case level the test case should be executed under. This tag is used directly inside the <testcase/> tag. A example might be:

    <testcase xmlns="jelly:jameleon">
<test-case-summary>Tests some feature</test-case-summary>
<test-case-bug>3423</test-case-bug>
<test-case-author>Christian Hargraves</test-case-author>
<test-case-level>ACCEPTANCE</test-case-level>
<test-case-level>REGRESSION</test-case-level>
<functional-point-tested>csv</functional-point-tested>
<application-tested>framework</application-tested>
<test-case-requirement>AP-123</test-case-requirement>
<test-case-id>TC-123</test-case-id>
</testcase">

Take a look at this tag's API docs and source code for more information.

test-case-requirement

Describes which requirement number the test case was written against. This tag is used directly inside the <testcase/> tag. A example might be:

    <testcase xmlns="jelly:jameleon">
<test-case-summary>Tests some feature</test-case-summary>
<test-case-bug>3423</test-case-bug>
<test-case-author>Christian Hargraves</test-case-author>
<test-case-level>ACCEPTANCE</test-case-level>
<test-case-level>REGRESSION</test-case-level>
<functional-point-tested>csv</functional-point-tested>
<application-tested>framework</application-tested>
<test-case-requirement>AP-123</test-case-requirement>
<test-case-id>TC-123</test-case-id>
</testcase">

Take a look at this tag's API docs and source code for more information.

test-case-summary

Documents the summary of what the test case does. This tag is used directly inside the <testcase/> tag. A example might be:

    <testcase xmlns="jelly:jameleon">
<test-case-summary>Tests some feature</test-case-summary>
<test-case-bug>3423</test-case-bug>
<test-case-author>Christian Hargraves</test-case-author>
<test-case-level>ACCEPTANCE</test-case-level>
<test-case-level>REGRESSION</test-case-level>
<functional-point-tested>csv</functional-point-tested>
<application-tested>framework</application-tested>
<test-case-requirement>AP-123</test-case-requirement>
<test-case-id>TC-123</test-case-id>
</testcase">

Take a look at this tag's API docs and source code for more information.

test-script

This is currently a tag meant to be nested inside the test-suite tag. It represents one of the scripts to be included and executed in the test-suite. If a test-script nested inside a precondition tag fails, then none of the following scripts will be executed even if they are nested inside a postcondition tag.

Take a look at this tag's API docs and source code for more information.

Attribute Name	Context Name	Description	Default	Required	Type
script		The script to execute.		true	java.io.File
precondition		Do not continue executing any following scripts if a script marked as a precondition fails.	false	false	boolean

test-suite

This is currently a tag meant to group several test case scripts together into a test suite. An example use might be:

<test-suite name="some test suite name">
<precondition>
<test-script script="scripts/setup.xml"/>
</precondition>
<test-script script="scripts/foo/0002.xml"/>
<test-script script="scripts/foo/0003.xml"/>
</test-suite>

NOTE: There is currently no support for a postcondition tag yet.

Take a look at this tag's API docs and source code for more information.

Attribute Name	Context Name	Description	Default	Required	Type
testSuiteListener		A fully qualified class name that implements TestSuiteListener.		false	java.lang.String
name		The name of the test suite.		false	java.lang.String

testcase

Every test case script must have at least one testcase tag containing all other Jameleon tags.

Some of this tags attribute may affect every nested Jameleon tag. Many of the attributes in this tag can be set globally via a jameleon.conf file.

The order of setting variables in the context follows:

Load the CSV file variables and put them in the context.
Load the $testEnvironment-Applications.properties and then Applications.properties and only set the variables that aren't set in the previous files. In other words, if there are variables that are going to be the same ( like the page title ) across multiple test cases, then first variable set wins.
Execute the function tag and set the attributes in the context. If you want key/values in the CSV and properties files to override the script attribute, then the function point author uses the setDefaultVariableValue() method in the set method for that attribute.
If the function point is using a map-variable, then override all settings to set the variable to the mapFrom variable name.

Take a look at this tag's API docs and source code for more information.

Attribute Name	Description	Default	Required	Type
testCaseResultSessionTemplate	Sets the session template to be used to generate the session result. This is searched for in the classpath.		false	java.lang.String
testCaseResultDataRowTemplate	Sets the data row template to be used to generate the data drivable result. This is searched for in the classpath.		false	java.lang.String
testCaseResultFunctionTemplate	Sets the function result template to be used to generate the test case result. This is searched for in the classpath.		false	java.lang.String
testCaseMainPageTemplate	Sets the template to be used to generate the main page of the results.. This is searched for in the classpath.		false	java.lang.String
testCaseSummaryTemplate	Sets the template to be used to generate the test case summary page of the results. This is searched for in the classpath.		false	java.lang.String
testCaseResultTemplate	Sets the template to be used to generate the test case result summary page. This is searched for in the classpath.		false	java.lang.String
testCaseResultSummaryTemplate	Sets the template to be used to generate the test case result summary page. This is searched for in the classpath.		false	java.lang.String
resultsDir	Sets the directory where the results will be written to.		false	java.io.File
storeStateEvent	Sets the test case to record the state of the application at a defined `event`		false	java.lang.String
storeStateOnChange	Sets the test case to record the state of the application whenever the application's state changes.		false	boolean
storeStateOnError	Sets the test case to record the state of the application on errors.		false	boolean
storeStateNever	Sets the test case to never record the state of the application.		false	boolean
maxExecutionTime	Sets the maximum execution time before the test case fails		false	long
failedOnDataDriver	Used internally to mark whether the DataDrivable had a problem. This is used for the failOnCSVFileNotFound option only		false	boolean
failOnCSVFileNotFound	Sets the failOnCSVFileNotFound property		false	boolean
organization	Sets the organziation or company that this test will be run against. This is used the same as the testEnvironment to find the CSV file or use values from a properties file specific to an organization.		false	java.lang.String
testEnvironment	Sets the environment to which testing system the testcase will be run in. Information like the starting url, can be based on this. This is also used to find the CSV file if one is used for the test case. This can be set as a global variable.		false	java.lang.String
useCSV	Sets whether a CSV file should be used for this testcase or not.		false	boolean
trace	Sets whether a std out message should be sent before and after the execution of a functional point.		false	boolean
baseDir	Sets the base directory of the project		false	java.io.File
assertGreaterThanLevel			false	java.lang.String
assertLessThanLevel			false	java.lang.String
assertLevel			false	java.lang.String
assertLevels	Sets the level of the asserts to run that are equal to this list of numbers.		false	java.lang.String
genTestCaseDocs	Sets the test case to generate the test case docs based on the javadocs of the functional points and the functionId's of the functional points in the test case.		false	boolean
executeTestCase	Sets the test case to be executed or not.		false	boolean
bugTrackerUrl	Sets the url of the bugtracking tool used so the bug's listed for the test case are linked.		false	java.lang.String
genTestCaseDocsEncoding	Sets the charset encoding.		false	java.lang.String
propsName	Sets the name of the properties file (minus the .properties) to read in into the context		false	java.lang.String
jameleonConfigName	Sets the configuration file Jameleon uses to configure itself. (default is defined in {@link net.sf.jameleon.util.Configurator}) Do not use. This is used for internal testing purposes only.		false	java.lang.String
enableSslCertCheck	Enable or disable validity checking of SSL certificates.		false	boolean
csvFileName	Sets the relative path to the name of the csv file. This does not use any logic in considering testEnvironment nor organization.		false	java.lang.String
name	Sets the name of the csv file to read in.		false	java.lang.String
csvDir	Sets the directory of the csv file to read in (relative to baseDir).		false	java.io.File
csvValueSeparator	Sets the separator used to separate CSV files.		false	char
csvCharset	Sets the character set to use when reading in the CSV file		false	java.lang.String
charset	Sets the character set to use to read the data file in.		false	java.lang.String
dataDir	Sets the directory of where the data will be looked for. The baseDir is then prepended on this		false	java.io.File
file	Sets the name of the file to use as a data source.		false	java.lang.String
countRow	Sets the DataDrivable tag to increment the number of times the test case was executed for each row executed.	false	false	boolean
stopTestExecutionOnFailure	To continue on a normal execution path even though an error occurs, set this to false		false	boolean
breakPoint	Sets a pause point to this class.		false	boolean

variable-value

used only as a child of <map-variable/>, it allows the ability to map one or more text values to a variable. The variableType of <map-variable/> can be used to when defining multiple values. For example:

    <testcase xmlns="jelly:jameleon">

<some-session application="someApp" beginSession="true">
<some-tag-that-uses-context-variables
functionId="Verify successful navigation, using a different variable.">
<map-variable toVariable="resultsText" variableType="list">
<variable-value>value 1</variable-value>
<variable-value>value 2</variable-value>
<variable-value>value 3</variable-value>
<variable-value>value 4</variable-value>
</map-variable/>
</some-tag-that-uses-context-variables>
</some-session>
</testcase>

Take a look at this tag's API docs and source code for more information.

wait

Wait for the given number of milliseconds. This tag may be used anywhere inside the testcase tag.

Take a look at this tag's API docs and source code for more information.

Attribute Name	Description	Default	Required	Type
delayTime	The number of milliseconds to wait for		true	long
functionId	The id of this function. This is used in the macro as a short description of the function		true	java.lang.String
breakPoint	Tells the GUI to stop at this functional point		false	boolean
precondition	Specifies this is a precondition		false	boolean
postcondition	Specifies this is a postcondition and will therefore get executed even if a previous functional point or session tag failed.		false	boolean
expectFailure	Specifies a failure is expected.		false	boolean
expectException	Specifies an exception is expected.		false	boolean
functionDelay	The delay time to use at the end of each functional point	-1	false	long

Learning Jameleon

Helpful Links

Plug-ins

Technical Documentation

Project Documentation

Available Tags

Jameleon Core Tags

application-tested

csv

execute-jameleon-script

function-doc

functional-point-tested

iterate

ju-assert-equals

ju-assert-not-null

ju-assert-null

ju-assert-true

ju-session

map-variable

param

param-name

param-type

param-value

postcondition

precondition

sql

sql-param

sql-param-value

sql-update

test-case-author

test-case-bug

test-case-id

test-case-level

test-case-requirement

test-case-summary

test-script

test-suite

testcase

variable-value

wait