Overview of Denizen

The Denizen Test Suite is a group of shell scripts and C programs designed to use the XGL library to render objects and evaluate results. Denizen contains approximately 625 test programs that test every XGL function defined at the API and the major internal components of the XGL library. Denizen provides a script that can either run all or a select set of the test programs. Each test evaluates its results automatically. Denizen creates a log of events, errors, and failures that can be compared to previous test runs. Ports of XGL to IHV hardware should produce Denizen pass rates similar to those measured for the reference frame buffers (8- and 24-bit nonaccelerated frame buffers). The following files are included with the Denizen product:

• Binaries for tests and libdenizen
• Source code for tests
• Setup, install, and run scripts
• Inspector tool

• 8-bit and 24-bit reference images
• 8-bit and 24-bit failure logs
• Install, build, and run documentation
• Open XGL bug list

Denizen Test Types

Denizen consists of two types of test programs, sampling method (SM) tests and comparison method (CM) tests. The SM tests are programs that call the XGL library to render an object. These tests sample the pixels that are displayed, check their placement and color, and indicate pass or fail results. Some SM tests also test XGL nonrendering functionality (such as set and get functions).

The CM tests compare an image created using XGL with images that have been previously created¹. CM tests classify the new image as either certified (matches a previously accepted image), or uncertified (does not match reference image).

---

1. Only 8- and 24-bit reference images are included so if the device has a different depth, you may opt not to run these tests. Also, inspector tool does not support other depths (see options listed in Chapter 3, "Options for Running Denizen").

Denizen Directory Tree

Figure 1-1 illustrates the Denizen directory structure.

Figure 1-1

Core Functionality

run_denizen.sh Shell script that executes the Denizen test suite. This script runs the C programs in the testcases/ subdirectories.

testcases/ Directory containing the source and executable files for test programs called by run_denizen.sh. This directory contains a subdirectory for each test area. Within each test area subdirectory are test program files for that area, and four ASCII files listing specific tests. These ASCII files are used by the test type options of run_denizen.sh:

• INDEX_TESTS--A list of tests that use index color (-index)
• RGB_TESTS--A list of tests that use RGB color (-rgb)
• SM_TESTS--A list of tests that use the Sampling Method (-sm)
• CM_TESTS--A list of tests that use the Comparison Method (-cm)

images/ Directory containing the images used for CM testing. This directory contains subdirectories for each device type.

The reference images for the CM tests are in refimages-cg3,refimages-cg8, and refimages-cg6. If the testing device is 8-bit, set the REFIMAGE environment variable to refimages-8bit. For 24-bit devices, set the REFIMAGE environment variable to refimages-24bit.

The curimages-cg3, curimages-cg8, and curimages-cg6 directories contain uncertified images (do not match reference images) produced by XGL.

Service Functionality

include/ Directory containing the header files used in the test programs from the testcases/ directory.

lib/

Directory containing the verification library used by the test programs.

Failure Analysis Resources

setup_cg3, setup_cg8, setup_cg6 Basic setup for running Denizen on cg3, cg8, and cg6.

setup.common Basic setup script (dependent upon $XGLHOME being set).

common_flags.mk Selects the correct compiler and loader.

Makefile*

Makefile for the Denizen directory.

INSTRUCTIONS ASCII file containing information on defining and customizing environment variables.

README ASCII file containing information on run_denizen.sh. The same information is provided in this document; however, README is in man page style.

doc/test_desc/ Directory containing ASCII documentation for the test programs contained in testcases/. Each file represents a test area, and describes the tests available for that area. Chapters dedicated to each test area summarize this information.

logs/ Directory containing the results of the Denizen test runs on XGL. There is a log for each of the nonaccelerated reference frame buffers.