source: php/trunk/doxygen/doc_page_option_unittest.php

<?PHP

/* RDFInt.php - RDF Interfaces for PHP
 * Copyright 2011 netlabs.org
 * Author: Christian Langanke, Adrian Gschwend
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * @page page_option_unittest Option: Executing RDFint.PHP unittests
 *
 * \section sec_unittest_prerequisites Prerequisites
 *
 * For running the unittests, \c PHPUnit is required.
 * Install as described at:
 * \htmllinkext{ http://www.phpunit.de/manual/current/en/installation.html}
 *

 * \note For execution of the unittests, \c GNU \c make is being used.
 * Under Windows operating systems,
 * \htmllinkext{http://ftp.gnu.org/gnu/make/,GNU make} needs to be installed on your system.
 * Just place \c make.exe into a directory specified in your \c PATH environment variable.
 *
 * The unittest \c rdfa_parse_sparql requires a locally installed \c SPARQL \c endpoint.
 * You may want to use the open source edition of \c Virtuoso for this. \n
 * Download from: \htmllinkext{http://virtuoso.openlinksw.com/dataspace/dav/wiki/Main/VOSDownload} \n
 * For usage under Windows operating systems, install \c Virtuoso as described at:
 * \htmllinkext{http://virtuoso.openlinksw.com/dataspace/dav/wiki/Main/VOSUsageWindows} \n
 * and launch the test instcance.
 *
 * <!-- ========================================================================== -->
 * <hr>
 *
 * \section sec_unittest_all Implementation of unittests
 *
 * The unittests are provided in subdirectories below the \c unittest directory,
 * where the name of the subdirectory represents the name of the unittest. An exception
 * to this rule are unittests related to the \c RDF \c Test \c Cases of \c W3C, they are 
 * implemented by a unittest in a single subdirectory.
 *
 * Unittests are implemented in the file \c unittest.php within the respective unittest subdirectory.
 *
 * \subsection sec_unittest_all_w3c Unittests related to RDF Test Cases
 *
 * \libname comes with support for selected testcases of the \c RDF \c Test \c Cases of the \c W3C,
 * see \htmllinkext{http://www.w3.org/TR/rdf-testcases/} for details. Supported are
 * most of the so-called \c Positive \c parser \c tests.
 *
 * All of these unittests are executed by a single unittest
 * in the subdirectory \c rdftestcases below the \c unittest directory.
 * The name of the \c RDF \c Test \c Case is provided by the makefile, setting the
 * name as the value of the environment variable \c TESTCASE.
 *
 * \note Executing \c RDF \c Test\c Cases in fact tests the underlying library used
 * for parsing and serializing RDF data (currently ARC2). If a test fails, it is most likely
 * the error of the underlying library and not of \libname.
 *
 *
 * <!-- ========================================================================== -->
 * <hr>
 *
 * \section sec_unittest_available Determine available unittests
 *
 * Execute \code make list \endcode in the \c unittest directory to determine available
 * unittests.
 *
 * \section sec_unittest_executing Executing unittests
 *
 * For executing testcases, execute \code make <target> \endcode in the
 * directory \c unittest.
 *
 * The available make targets can be shown by executing \c make with no target:
\verbatim
 makefile for unittests of RDFInt.PHP

 Valid targets/symbols:

   help                - display this help
   list                - list names of testcases

   all                 - execute all unittests (lib && rdf)

   lib                 - execute all library specific unittests
   lib TESTCASE=<name> - execute given library specific unittests

   rdf                 - execute all of selected unitests related to W3C RDF Test Cases
   rdf TESTCASE=<name> - execute given unittest related to W3C RDF Test Case

   For information on RDF Test Cases see: http://www.w3.org/TR/rdf-testcases/
\endverbatim
 *
 * As an alternative, testcases can also be executed within the testcase directory by executing
 *
 * \code phpunit unittest.php \endcode
 *
 * \note For running one of the supported tests of \c RDF \c Testcases, before running the test,
 * the name of the test must be set in the environment variable \c TESTCASE.
 * Execute \code make list \endcode in the \c unittest directory to determine the name of one
 * of the supported \c RDF \c Testcases.
 *
 */


?>