From 1c9d36615a60dfbe96da5e9866480313415f262d Mon Sep 17 00:00:00 2001
From: Nils Adermann <naderman@naderman.de>
Date: Thu, 9 May 2013 19:59:34 +0200
Subject: [ticket/11529] Rename RUNNING_TESTS.txt to RUNNING_TESTS.md

PHPBB3-11529
---
 tests/RUNNING_TESTS.md  | 119 ++++++++++++++++++++++++++++++++++++++++++++++++
 tests/RUNNING_TESTS.txt | 119 ------------------------------------------------
 2 files changed, 119 insertions(+), 119 deletions(-)
 create mode 100644 tests/RUNNING_TESTS.md
 delete mode 100644 tests/RUNNING_TESTS.txt

diff --git a/tests/RUNNING_TESTS.md b/tests/RUNNING_TESTS.md
new file mode 100644
index 0000000000..0fa45e7bc4
--- /dev/null
+++ b/tests/RUNNING_TESTS.md
@@ -0,0 +1,119 @@
+Running Tests
+=============
+
+Prerequisites
+=============
+
+PHPUnit
+-------
+
+phpBB unit tests use the PHPUnit framework (see http://www.phpunit.de for more
+information). Version 3.5 or higher is required to run the tests. PHPUnit can
+be installed via Composer together with other development dependencies as
+follows.
+
+    $ cd phpBB
+    $ php ../composer.phar install --dev
+    $ cd ..
+
+PHP extensions
+--------------
+
+Unit tests use several PHP extensions that board code does not use. Currently
+the following PHP extensions must be installed and enabled to run unit tests:
+
+- ctype (also a PHPUnit dependency)
+- dom (PHPUnit dependency)
+
+Some of the functionality in phpBB and/or the test suite uses additional
+PHP extensions. If these extensions are not loaded, respective tests
+will be skipped:
+
+- apc (APC cache driver)
+- bz2 (compress tests)
+- interbase, pdo_firebird (Firebird database driver)
+- mysql, pdo_mysql (MySQL database driver)
+- mysqli, pdo_mysql (MySQLi database driver)
+- pdo (any database tests)
+- pgsql, pdo_pgsql (PostgreSQL database driver)
+- simplexml (any database tests)
+- sqlite, pdo_sqlite (SQLite database driver, requires SQLite 2.x support
+  in pdo_sqlite)
+- zlib (compress tests)
+
+Database Tests
+--------------
+
+By default all tests requiring a database connection will use sqlite. If you
+do not have sqlite installed the tests will be skipped. If you wish to run the
+tests on a different database you have to create a test_config.php file within
+your tests directory following the same format as phpBB's config.php. An
+example for mysqli can be found below. More information on configuration
+options can be found on the wiki (see below).
+
+    <?php
+    $dbms = 'mysqli';
+    $dbhost = 'localhost';
+    $dbport = '';
+    $dbname = 'database';
+    $dbuser = 'user';
+    $dbpasswd = 'password';
+
+It is possible to have multiple test_config.php files, for example if you
+are testing on multiple databases. You can specify which test_config.php file
+to use in the environment as follows:
+
+    $ PHPBB_TEST_CONFIG=tests/test_config.php phpunit
+
+Alternatively you can specify parameters in the environment, so e.g. the
+following will run PHPUnit with the same parameters as in the shown
+test_config.php file:
+
+    $ PHPBB_TEST_DBMS='mysqli' PHPBB_TEST_DBHOST='localhost' \
+      PHPBB_TEST_DBNAME='database' PHPBB_TEST_DBUSER='user' \
+      PHPBB_TEST_DBPASSWD='password' phpunit
+
+Special Database Cases
+----------------------
+In order to run tests on some of the databases that we support, it will be
+necessary to provide a custom DSN string in test_config.php. This is only
+needed for MSSQL 2000+ (PHP module), MSSQL via ODBC, and Firebird when
+PDO_Firebird does not work on your system
+(https://bugs.php.net/bug.php?id=61183). The variable must be named $custom_dsn.
+
+Examples:
+Firebird using http://www.firebirdsql.org/en/odbc-driver/
+$custom_dsn = "Driver={Firebird/InterBase(r) driver};dbname=$dbhost:$dbname";
+
+MSSQL
+$custom_dsn = "Driver={SQL Server Native Client 10.0};Server=$dbhost;Database=$dbname";
+
+The other fields in test_config.php should be filled out as you would normally
+to connect to that database in phpBB.
+
+Additionally, you will need to be running the DbUnit fork from
+https://github.com/phpbb/dbunit/tree/phpbb.
+
+Running
+=======
+
+Once the prerequisites are installed, run the tests from the project root
+directory (above phpBB):
+
+    $ phpBB/vendor/bin/phpunit
+
+Slow tests
+--------------
+
+Certain tests, such as the UTF-8 normalizer or the DNS tests tend to be slow.
+Thus these tests are in the `slow` group, which is excluded by default. You can
+enable slow tests by copying the phpunit.xml.all file to phpunit.xml. If you
+only want the slow tests, run:
+
+    $ phpBB/vendor/bin/phpunit --group slow
+
+More Information
+================
+
+Further information is available on phpbb wiki:
+http://wiki.phpbb.com/Unit_Tests
diff --git a/tests/RUNNING_TESTS.txt b/tests/RUNNING_TESTS.txt
deleted file mode 100644
index 0fa45e7bc4..0000000000
--- a/tests/RUNNING_TESTS.txt
+++ /dev/null
@@ -1,119 +0,0 @@
-Running Tests
-=============
-
-Prerequisites
-=============
-
-PHPUnit
--------
-
-phpBB unit tests use the PHPUnit framework (see http://www.phpunit.de for more
-information). Version 3.5 or higher is required to run the tests. PHPUnit can
-be installed via Composer together with other development dependencies as
-follows.
-
-    $ cd phpBB
-    $ php ../composer.phar install --dev
-    $ cd ..
-
-PHP extensions
---------------
-
-Unit tests use several PHP extensions that board code does not use. Currently
-the following PHP extensions must be installed and enabled to run unit tests:
-
-- ctype (also a PHPUnit dependency)
-- dom (PHPUnit dependency)
-
-Some of the functionality in phpBB and/or the test suite uses additional
-PHP extensions. If these extensions are not loaded, respective tests
-will be skipped:
-
-- apc (APC cache driver)
-- bz2 (compress tests)
-- interbase, pdo_firebird (Firebird database driver)
-- mysql, pdo_mysql (MySQL database driver)
-- mysqli, pdo_mysql (MySQLi database driver)
-- pdo (any database tests)
-- pgsql, pdo_pgsql (PostgreSQL database driver)
-- simplexml (any database tests)
-- sqlite, pdo_sqlite (SQLite database driver, requires SQLite 2.x support
-  in pdo_sqlite)
-- zlib (compress tests)
-
-Database Tests
---------------
-
-By default all tests requiring a database connection will use sqlite. If you
-do not have sqlite installed the tests will be skipped. If you wish to run the
-tests on a different database you have to create a test_config.php file within
-your tests directory following the same format as phpBB's config.php. An
-example for mysqli can be found below. More information on configuration
-options can be found on the wiki (see below).
-
-    <?php
-    $dbms = 'mysqli';
-    $dbhost = 'localhost';
-    $dbport = '';
-    $dbname = 'database';
-    $dbuser = 'user';
-    $dbpasswd = 'password';
-
-It is possible to have multiple test_config.php files, for example if you
-are testing on multiple databases. You can specify which test_config.php file
-to use in the environment as follows:
-
-    $ PHPBB_TEST_CONFIG=tests/test_config.php phpunit
-
-Alternatively you can specify parameters in the environment, so e.g. the
-following will run PHPUnit with the same parameters as in the shown
-test_config.php file:
-
-    $ PHPBB_TEST_DBMS='mysqli' PHPBB_TEST_DBHOST='localhost' \
-      PHPBB_TEST_DBNAME='database' PHPBB_TEST_DBUSER='user' \
-      PHPBB_TEST_DBPASSWD='password' phpunit
-
-Special Database Cases
-----------------------
-In order to run tests on some of the databases that we support, it will be
-necessary to provide a custom DSN string in test_config.php. This is only
-needed for MSSQL 2000+ (PHP module), MSSQL via ODBC, and Firebird when
-PDO_Firebird does not work on your system
-(https://bugs.php.net/bug.php?id=61183). The variable must be named $custom_dsn.
-
-Examples:
-Firebird using http://www.firebirdsql.org/en/odbc-driver/
-$custom_dsn = "Driver={Firebird/InterBase(r) driver};dbname=$dbhost:$dbname";
-
-MSSQL
-$custom_dsn = "Driver={SQL Server Native Client 10.0};Server=$dbhost;Database=$dbname";
-
-The other fields in test_config.php should be filled out as you would normally
-to connect to that database in phpBB.
-
-Additionally, you will need to be running the DbUnit fork from
-https://github.com/phpbb/dbunit/tree/phpbb.
-
-Running
-=======
-
-Once the prerequisites are installed, run the tests from the project root
-directory (above phpBB):
-
-    $ phpBB/vendor/bin/phpunit
-
-Slow tests
---------------
-
-Certain tests, such as the UTF-8 normalizer or the DNS tests tend to be slow.
-Thus these tests are in the `slow` group, which is excluded by default. You can
-enable slow tests by copying the phpunit.xml.all file to phpunit.xml. If you
-only want the slow tests, run:
-
-    $ phpBB/vendor/bin/phpunit --group slow
-
-More Information
-================
-
-Further information is available on phpbb wiki:
-http://wiki.phpbb.com/Unit_Tests
-- 
cgit v1.2.1


From ab3b0df2449ec8b4b215dcde3c7d0b8cd35147ce Mon Sep 17 00:00:00 2001
From: Nils Adermann <naderman@naderman.de>
Date: Thu, 9 May 2013 20:06:12 +0200
Subject: [ticket/11529] Format markdown code correctly

PHPBB3-11529
---
 tests/RUNNING_TESTS.md | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/tests/RUNNING_TESTS.md b/tests/RUNNING_TESTS.md
index 0fa45e7bc4..26a93f0430 100644
--- a/tests/RUNNING_TESTS.md
+++ b/tests/RUNNING_TESTS.md
@@ -79,14 +79,16 @@ In order to run tests on some of the databases that we support, it will be
 necessary to provide a custom DSN string in test_config.php. This is only
 needed for MSSQL 2000+ (PHP module), MSSQL via ODBC, and Firebird when
 PDO_Firebird does not work on your system
-(https://bugs.php.net/bug.php?id=61183). The variable must be named $custom_dsn.
+(https://bugs.php.net/bug.php?id=61183). The variable must be named `$custom_dsn`.
 
 Examples:
 Firebird using http://www.firebirdsql.org/en/odbc-driver/
-$custom_dsn = "Driver={Firebird/InterBase(r) driver};dbname=$dbhost:$dbname";
+
+    $custom_dsn = "Driver={Firebird/InterBase(r) driver};dbname=$dbhost:$dbname";
 
 MSSQL
-$custom_dsn = "Driver={SQL Server Native Client 10.0};Server=$dbhost;Database=$dbname";
+
+    $custom_dsn = "Driver={SQL Server Native Client 10.0};Server=$dbhost;Database=$dbname";
 
 The other fields in test_config.php should be filled out as you would normally
 to connect to that database in phpBB.
-- 
cgit v1.2.1