Unit testing configuration file

Overview

This page documents the properties in the unit test configuration file.

The test configuration file sets a large number of configuration properties. These are explained below.

The most current version of the configuration file is available from the SVN repository.

Local test data configuration

local.test.data.root

local.test.data.root = /local/test/data/path

Specify the path to the root directory for the local test data. This is the test data that is maintained as part of the XBRLAPI project and that is released as a ZIP archive in its own package as one of the file releases maintained by the XBRLAPI project.

Caching configuration

local.cache

local.cache = /cache/path

Specify the path to the root directory for the local document cache. This will be used when running all tests.

nonexistent.cache

nonexistent.cache = /rubbish/path/to/nonexistent/cache

Specify a cache location that does not actually exist in the local file system.

nonexistent.url

nonexistent.url = http://some.rubbish.org/nonexistent.xml

Specify a valid URL but one that does not resolve.

Xindice data store configuration

These configuration properties are only required if you are unit testing the Xindice data store implementation.

xindice.xmldb.version

xindice.xmldb.version = 1.0

Sets the version of XML:DB to use when running Xindice tests. Ghis should always be set to 1.0.

xindice.scheme

xindice.scheme = xmldb:xindice

Sets the URL scheme to use for accessing the Xindice database. This should always be xmldb:xindice.

xindice.domain = localhost

xindice.domain = localhost

Sets the value of the domain to use in Xindice database URLs.

xindice.port

xindice.port = 80

Sets the port to use in Xindice database URLs

xindice.database

xindice.database = db

Sets the value of the path to the root of the Xindice database for use in Xindice database URLs.

The Xindice database URL is formed from:
xindice.scheme + "://" + xindice.domain + ":" + xindice.port + "/" + xindice.database

xindice.data.collection.name

xindice.data.collection.name = collectionName

Sets the name to use for the collection that will hold the data store in Xindice data store tests.

xindice.store.parent.path

xindice.store.parent.path = /

The path to the collection that will be the parent collection of the collection that actually holds XBRLAPI data. A value of / specifies that the data store is in a collection that is a child of the database root. If some other value is used you will also need to ensure that the specified parent collection actually exists.

Exist data store configuration

These configuration properties are only required if you are unit testing the eXist data store implementation.

exist.xmldb.version

exist.xmldb.version = 1.0

Sets the version of XML:DB to use when running Exist tests. Generally this should always be set to 1.0.

xindice.scheme

exist.scheme = xmldb:exist

Sets the URL scheme to use for accessing the Exist database. This should always be xmldb:exist.

exist.domain = localhost

exist.domain = localhost

Sets the value of the domain to use in Exist database URLs.

exist.port

exist.port = 80

Sets the port to use in Exist database URLs

exist.database

exist.database = exist/xmlrpc/db

Sets the value of the path to the root of the Xindice database for use in Exist database URLs.

The Exist database URL is formed from:
exist.scheme + "://" + exist.domain + ":" + exist.port + "/" + exist.database

exist.username

exist.username = admin

The user name to use when accessing the Exist database. In a default installation of eXist, the username is "admin".

exist.password

exist.password =

The password to use when accessing the Exist database. In a default installation of eXist, the password is "", ie: the empty string. If this is the case in your test environment, just have a new line character (or characters)at the end of the "=" when setting this configuration property.

exist.data.collection

exist.data.collection.name = xbrlapiData

Sets the name to use for the collection that will hold the data store in Exist data store tests.

exist.store.parent.path

exist.store.parent.path = /

Oracle Berkeley Database XML data store configuration

These configuration properties are only required if you are unit testing the Oracle Berkeley Database XML data store implementation.

bdbxml.store.location

bdbxml.store.location = /path/to/directory/for/database/files

The directory specified needs to be writeable.

bdbxml.container.name

bdbxml.container.name = xbrlapiContainer

The container name needs to be a valid file name for the file system that you are using.

XBRL 2.1 conformance suite configuration

test.data.baseURL

test.data.baseURL = http://localhost/conformance/

The base URL for the XBRL 2.1 conformance suite.

test.data.baseURL.cacheRepresentation

test.data.baseURL.cacheRepresentation = /http/localhost/80/conformance

The cache representation of the XBRL 2.1 conformance suite URL. This involves replacing the ://, / and : character groups with a single slash. It also requires inclusion of the port information even if that is not explicit in the URL. If you are using a file scheme URL then the port value is null.

Conformance suite test data configuration

These properties all have names that are prefixed with test.data.

The values of these properties are all paths to specific documents in the conformance suite. These paths are resolved relative to the base URL of the conformance suite. They should not be changed.

Local data set test configuration

These properties all have names that are prefixed with test.data.local.

The values of these properties are all paths that are relative to the path specified by the local.test.data.root property. They should not need to be modified.

real data set test configuration

These properties all have names that are prefixed with real.data.

The values of these properties are all absolute paths to specific documents. They should not be changed.

piwik