How to add Actor specific XUA Conformance Tests in Toolkit

How to add Actor-specific XUA Conformance Tests in Toolkit

Pre-requisites

You must have properly configured the ACTOR_OPTIONS Java List in Build[Actor]OrchestrationButton class.

See this page for more information on how XUA tests are configured in toolkit: https://github.com/usnistgov/iheos-toolkit2/wiki/Adding-an-Option-Tab-to-the-Conformance-Test-Tool

An XUA test can only use one SAML assertion username at a time which follows the test folder naming convention of "[TestId]_[Xuausername]". It is required to follow this naming convention only for tests in the XUA test collection.

Steps

I. Create an XUA test folder

1. Copy an existing test folder as the base for the new XUA test. For the following example, we will use Test 12309 as the base test folder. To add an XUA test that uses the Xuabad SAML assertion username, make a copy of test folder 12309 and rename the copied folder as "12309_Xuabad".
2. Update the collections.txt file in the test folder and set it to "[actor]_xua". Use the actor code as described in pre-requisite section, namely, the one specified in the ACTOR_OPTIONS Java List.
3. Update readme.txt in the test folder and add/remove description as needed and indicate the use of SAML assertion. For example, adding the following note is helpful "Uses SAML assertion username as encoded in the test plan name."

II. For each section in the test folder update the testplan.xml

1. Update the Test element text value to [testId]/[section]. For example, 12309_Xuabad/finddocs.
2. If an invalid assertion username such as Xuabad is used... (see the Status Code column value of the Gazelle's XUA assertion username table in the Google Docs link).
   1. Update the ExpectedStatus element text value to "Fault" in the testplan.xml. ("Fault" represents a SOAP Fault.)
   2. Remove any assertions and/or ExpectedContents elements in testplan.xml.
3. For valid assertions (such as Xuagood or Xuaauthzconsent) there are two possible values for ExpectedStatus. If the test has a dependency and it is not expected to be run/available, set the ExpectedStatus to "Failure". The main purpose of this test is only to test SAML. If the test has no dependency and is expected to Pass, set the ExpectedStatus value to "Success".

III. Move the new XUA test to the local testkit folder

1. If a local testkit folder doesn't exist, create it.
   1. Using the XDS Toolkit web application, click the Toolkit configuration link on the left menu. This opens the Configure XDS Toolkit page.
      1. Click the "Create EC testkit structure" button. This should respond with "-- Success!" and a testkit folder should have been created in your external directory like so: [ec_dir]\environment\default\testkits.
      2. Click the "Reindex Test Kits" button.
2. Move the new XUA test to your local tests folder which should be locatable in this path [ec_dir]\environment\default\testkits\default\tests.
3. To verify the new XUA test is accessible from the Toolkit web application, navigate to the appropriate actor in the Conformance Tests tab and click on the XUA Option tab. Your new test should be displayed in the test collection.