]> git.mxchange.org Git - friendica.git/commitdiff
Add some explanation in DatabaseTest::getConnection()
authorPierre Rudloff <contact@rudloff.pro>
Wed, 16 May 2018 11:14:50 +0000 (13:14 +0200)
committerPierre Rudloff <contact@rudloff.pro>
Wed, 16 May 2018 11:14:50 +0000 (13:14 +0200)
tests/DatabaseTest.php

index 7819b46ab8f2178b57c285be16992be5151f9c49..5a9a563a5da2d05b753257e4a2ff4769fc9160f4 100644 (file)
@@ -22,6 +22,12 @@ abstract class DatabaseTest extends TestCase
 
        /**
         * Get database connection.
+        *
+        * This function is executed before each test in order to get a database connection that can be used by tests.
+        * If no prior connection is available, it tries to create one using the USER, PASS and DB environment variables.
+        *
+        * If it could not connect to the database, the test is skipped.
+        *
         * @return PHPUnit_Extensions_Database_DB_IDatabaseConnection
         * @see https://phpunit.de/manual/5.7/en/database.html
         */