No description, website, or topics provided.
Perl
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
debian
lib/PDT/TS
script
t
.gitignore
Build.PL
LICENSE
MANIFEST
MANIFEST.SKIP
META.json
META.yml
Makefile.PL
README.internal.md
README.md

README.md

Purpose

The purpose of the Whois Selftest Tool is to help gTLD applicants prepare for Registry System Testing (RST) by providing pre-RST Whois output validation. (PDT is now part of RST.)

Scope

While Whois Selftest Tool does validate Whois output and it does strive to reflect the state of RST Whois output validation, it is not authoritative on the outcome of RST and it is subject to change.

Disclaimer

The Whois Selftest Tool and the actual Whois testing under RST are not equal. We strive to make the two as equal as possible, but here is no guarantee that successfully running the Whois Selftest Tool means that the same Whois system will pass the Whois testing under RST. For example, the parts of Whois tests under Whois that include DNS lookups and TCP connections are not included in the Whois Selftest Tool. For a complete reference of the Whois tests under RST see the RST Whois document listed under the references below.

Version history

  • v1.0.0 - Initial public release (2015-12-03)
  • v1.1.0 - Updated public release (2016-01-08)
  • v1.2.0 - Updated public release (2016-02-02)
  • v1.3.0 - Updated public release (2016-02-26)
  • v1.4.0 - Updated public release (2016-11-01)
  • v1.4.1 - No public release
  • v1.3.1 - No public release
  • v1.4.2 - Updated public release (2017-03-23, on Github 2017-08-24)

The v1.1.0 release primarily matches the updates to the PDT Whois TP and TCs in the version 2.9 document release. It also handles the issue with IDN in the v1.0.0 release and corrects found bugs.

The v1.2.0 release primarily matches the updates to the PDT Whois TP in the the version 2.10 document release. It also corrects found bugs.

The v1.3.0 release includes two updates of the PDT Whois TP that will be included in the next document release:

  • If the Domain Status is "ok" then the fragment in the URL in the Domain Status field may be "ok" or "OK".
  • If a field is empty (key is there, but no value) there may be one space character (U+0020) after the colon, i.e. trailing space is permitted.

The v1.4.0 release updates Whois Selftest Tool to match the new format requirements specified in "Registry Registration Data Directory Services Consistent Labeling and Display Policy". That specification is optional until 2017-08-01, and registries still using the current format should stick to v1.3.0 of Whois Selftest Tool.

The v1.4.1 release updates Whois Selftest Tool with two improvements:

  • Better error message when fields of type "optional-constrained", "empty-constrained" or "omitted-constrained" are not following the specification.
  • Improved error message when "Registrar Abuse Contact Phone" (or "... Email") is empty.

The v1.3.1 release only updates the debian/changelog for IIS internal package building.

The v1.4.2 release corrects a bug and a Perl warning only seen in Perl 5.18 or higher.

The v1.4.2 release now refer to the RST documents.

Specification compatibility matrix

Refer to this compatibility matrix when deciding which version of Whois Selftest Tool to use.

Whois Selftest Tool version PDT Document Release PDT Whois Test Plan version PDT Whois CLI Test Case document version RST Whois Test Area Specification version
v1.0.0 2.8
v1.1.0 2.9
v1.2.0 2.10
v1.3.0 2.10 plus two updates described above J H
v1.4.0 2.11 K I
v1.4.1 2.11 K I
v1.3.1 2.10 plus two updates described above J H
v1.4.2 2.11 K I
v1.4.2 3.0 - - B

Roadmap

The plan is to solve know issues and any bugs of importance. New versions will be released when fixes are stable.

PDT References

The old Pre-Delegation Testing microsite hosts the old PDT documents relevant to the Whois Selftest Tool. Find the PDT Test Specifications zip file.

  • The PDT Whois CLI Test Cases document, within the zip file, specifies the test cases that the Whois Selftest Tool partially implements.
  • The PDT Whois Test Plan document, within the zip file, specifies the format specification that the Whois Selftest Tool implements.

In PDT Whois Test Plan you can find references to other useful documents.

For the most current information, go to the the RST site instead.

RST References

The Registry System Testing site at ICANN hosts the RST documents relevant to the Whois Selftest Tool. Find the RST Test Specifications zip file.

  • The RST Whois Test Area Specification, wihtin the zip file, specifies the test cases the the Whois Selftest Tool partially implements. It also contains the format specification that the Whois Selftest Tool implements.

In RST Whois Test Area Specification you can find references to other useful documents.

Licensing

Whois Selftest Tool is distributed under the terms of this license.

Dependencies

  • Ubuntu Linux version 12.04
  • Perl, version 5.14 or higher
  • Standard Perl libraries found on CPAN.org
    • DateTime
    • File::Slurp
    • File::Which
    • Net::IDN::Encode
    • Net::IP
    • Readonly
    • Regexp::IPv6
    • Test::Differences
    • Test::MockObject
    • Text::CSV
    • Text::CSV_XS
    • URI
    • YAML::Syck
  • wget

The Whois Selftest Tool has been developed on Unbuntu Linux, but we have tried to avoid Linux specific coding. There is, however, no guarantee that it works on other OSs.

Installation

Clone the project repository and choose version according to the specification compatibility matrix. In the normal case, choose the latest version.

$> git clone https://github.com/dotse/Whois-Selftest-Tool.git <srcdir>
$> cd <srcdir>
$> git checkout <version>

Install Whois Selftest Tool scripts and libraries.

$> perl Build.PL
$> ./Build
$> ./Build test
$> ./Build install

To check the installation run the scripts with --help. Before the whois-test script can be run, the EPP database must be fetched.

$> whois-fetch-epp-repo-ids --help
$> whois-fetch-epp-repo-ids
$> whois-test --help

After installing, you can find documentation for this module with the perldoc command.

perldoc PDT::TS::Whois

Before use

Before you use the tool, make sure that you have read the documents listed in the reference above. Some error messages may be difficult to understand without referring to the RST Whois Test Area Specification document.

Usage

The Whois Selftest Tool provides the two commands whois-fetch-epp-repo-ids and whois-test. If you have followed the installation above, always go to your <programdir> and run the commands from there or else the scripts will not be able to find its libraries in the PDT directory. You probably have to prepend the commands with ./ just as in the instructions above.

whois-fetch-epp-repo-ids fetches the EPP Repository Identifiers registered with IANA and stores them in a text file inside the user's home directory.

whois-test validates the Whois responses according to the format specification in the RST Whois Test Area Specification document.

The database of EPP Repository Identifiers is a prerequisite for running whois-test command, so whois-fetch-epp-repo-ids must be run at least once before whois-test is used for the first time. After that, run whois-fetch-epp-repo-ids again to update the database every time the Whois Selfttest Tool is to be used.

See the man pages for the respective commands for details on how to run them. (You can use the --man option to view the man pages)

Known issues

  • The description of the two types of replies on queries for nameserver objects is a bit unclear. For full understanding, please see Test Case WhoisCLI03 found in the RST Whois Test Area Specification document listed in the references above.

Reporting bugs

If you think you've found a bug, please search both the list of known issues and the issue tracker to see if this is a known bug. If you cannot find it, please report it to the issue tracker.