Tip

Click here to go directly to the current RST test specifications.

Note

Releases of the RST v2.0 test specifications do not always align with releases of the RST v2.0 service, as it is often necessary to publish an update to the test specs before the corresponding update to the test system.

As described in the API spec, the testPlan property of test objects includes the version of the test specs that is used for performing tests. This can be used to determine which version of the test specs is currently deployed in the given environment (OT&E or production).

This repository contains the specifications for ICANN's Registry System Testing (RST) v2.0 service.

Repository Contents

• The files in inc/ are what you need to edit if you want to make changes to the test specifications.

• rst-test-spec-schema.yaml is a schema for the YAML spec file.

• zonemaster-test-policies.yaml contains policies that are applied to Zonemaster tests when generating the spec files and the Zonemaster profile.

• The data directory contains the XLSX files from which the data providers are generated.

• The resources directory contains static resources.

• The .env file specifies which version of Zonemaster should be used to generate DNS and DNSSEC test cases, and their associated error codes. zonemaster-test-policies.yaml controls how the Zonemaster test cases and documentation should be incorporated into the RST specs.

Building the specification

The simplest way to build the specification is to run docker compose run spec (you obviously need Docker). The first run will take a while as it needs to build the image, but it will be quite fast after that.

Releasing a new version

1. Make the changes you want to make.
2. Once committed, tag the commit. The tag MUST take the form vYYYY.DD where YYYY is the current year and DD is a two-digit serial number that resets to 01 at the start of each year. Then push the tag to GitHub using git push --tags.
3. Create a new release using the tag.

Since the RST API spec includes data elements from the test specs, every time a new version of the RST spec is released, a new version of the API spec must also be released, in order to incorporate any changes to those data elements.

EPP Extension List, RDAP Conformance Tool and Zonemaster configuration

Unlike the test specs, changes to the EPP Extensions List, and configuration files for the RDAP Conformance Tool and Zonemaster do not require creation of a new release. Just update the appropriate files, and commit to the main branch, and the build-pages workflow will generate and publish the updated files. The RST system will pick them up automatically (after cache expiration).

See Also

• RST API Specification (GitHub repository)
• IDN test labels for RST v2.0

Copyright Statement

This repository is (c) 2025 Internet Corporation for Assigned Names and Numbers (ICANN). All rights reserved.