Merge pull request #569 from dawnbreak/QA_testing

[FEATURE] Extend Travis CI integration.

8 files changed, 309 insertions, 72 deletions

diff --git a/tests/phpunit-mariadb.xml b/tests/phpunit-mariadb.xml
new file mode 120000
index 000000000..63656b78b
--- /dev/null
+++ b/tests/phpunit-mariadb.xml
@@ -0,0 +1 @@
+phpunit-mysql.xml
\ No newline at end of file
diff --git a/tests/phpunit-mysql.xml b/tests/phpunit-mysql.xml
new file mode 100644
index 000000000..171211094
--- /dev/null
+++ b/tests/phpunit-mysql.xml
@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/6.0/phpunit.xsd"
+         bootstrap="../boot.php"
+         forceCoversAnnotation="false"
+         beStrictAboutCoversAnnotation="true"
+         beStrictAboutOutputDuringTests="true"
+         beStrictAboutTodoAnnotatedTests="true"
+         verbose="true">
+    <testsuite name="Hubzilla default Test Suite">
+        <directory suffix="Test.php">./unit/</directory>
+    </testsuite>
+    <testsuite name="API Test Suite">
+        <directory suffix="Test.php" prefix="API">./unit/</directory>
+    </testsuite>
+    <testsuite name="Ex-/Import Test Suite">
+        <directory suffix="Test.php">./unit/eximport/</directory>
+    </testsuite>
+    <groups>
+        <exclude>
+            <group>postgresql</group>
+        </exclude>
+    </groups>
+    <!--cover reporting-->
+    <filter>
+        <whitelist processUncoveredFilesFromWhitelist="true">
+            <directory suffix=".php">../Zotlabs/</directory>
+            <directory suffix=".php">../include/</directory>
+        </whitelist>
+    </filter>
+    <logging>
+        <log type="junit" target="./results/junit.xml" logIncompleteSkipped="false"/>
+        <log type="coverage-clover" target="./results/coverage-clover.xml"/>
+        <log type="coverage-html" target="./results/coverage-report/" lowUpperBound="35"
+        highLowerBound="70"/>
+    </logging>
+</phpunit>
diff --git a/tests/phpunit-pgsql.xml b/tests/phpunit-pgsql.xml
new file mode 100644
index 000000000..ace14e196
--- /dev/null
+++ b/tests/phpunit-pgsql.xml
@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/6.0/phpunit.xsd"
+         bootstrap="../boot.php"
+         forceCoversAnnotation="false"
+         beStrictAboutCoversAnnotation="true"
+         beStrictAboutOutputDuringTests="true"
+         beStrictAboutTodoAnnotatedTests="true"
+         verbose="true">
+    <testsuite name="Hubzilla default Test Suite">
+        <directory suffix="Test.php">./unit/</directory>
+    </testsuite>
+    <testsuite name="API Test Suite">
+        <directory suffix="Test.php" prefix="API">./unit/</directory>
+    </testsuite>
+    <groups>
+        <exclude>
+            <group>mysql</group>
+        </exclude>
+    </groups>
+    <!--cover reporting-->
+    <filter>
+        <whitelist processUncoveredFilesFromWhitelist="true">
+            <directory suffix=".php">../Zotlabs/</directory>
+            <directory suffix=".php">../include/</directory>
+        </whitelist>
+    </filter>
+    <logging>
+        <log type="junit" target="./results/junit.xml" logIncompleteSkipped="false"/>
+        <log type="coverage-clover" target="./results/coverage-clover.xml"/>
+        <log type="coverage-html" target="./results/coverage-report/" lowUpperBound="35"
+        highLowerBound="70"/>
+    </logging>
+</phpunit>
diff --git a/tests/travis/gen_apidocs.sh b/tests/travis/gen_apidocs.sh
new file mode 100755
index 000000000..e5938e1e8
--- /dev/null
+++ b/tests/travis/gen_apidocs.sh
@@ -0,0 +1,69 @@
+#!/usr/bin/env bash
+
+#
+# Copyright (c) 2016 Hubzilla
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+#
+
+# Exit if anything fails
+set -e
+
+# Only create and deploy API documentation once, on first build job.
+# Waiting for upcoming 'Build Stages' Q1/Q2 2017 to make this cleaner.
+# https://github.com/travis-ci/travis-ci/issues/929
+if [[ "$TRAVIS_JOB_NUMBER" != "${TRAVIS_BUILD_NUMBER}.1" ]]; then
+	echo "Not the first build job. Creating API documentation only once is enough."
+	echo "We are finished ..."
+	exit
+fi
+
+echo "Doxygen version >= 1.8 is required"
+doxygen --version
+
+# Check if newer version of Doxygen should be used
+if [ ! -z "$DOXY_VER" ]; then
+	export DOXY_BINPATH=$HOME/doxygen/doxygen-$DOXY_VER/bin
+	if [ ! -e "$DOXY_BINPATH/doxygen" ]; then
+		echo "Installing newer Doxygen $DOXY_VER ..."
+		mkdir -p $HOME/doxygen && cd $HOME/doxygen
+		wget -O - http://ftp.stack.nl/pub/users/dimitri/doxygen-$DOXY_VER.linux.bin.tar.gz | tar xz
+		export PATH=$DOXY_BINPATH:$PATH
+	fi
+	echo "Doxygen version"
+	doxygen --version
+fi
+
+echo "Generating Doxygen API documentation ..."
+cd $TRAVIS_BUILD_DIR
+mkdir -p ./doc/html
+# Redirect stderr and stdout to log file and console to be able to review documentation errors
+doxygen $DOXYFILE 2>&1 | tee ./doc/html/doxygen.log
+
+# Check if Doxygen successfully created the documentation
+if [ -d "doc/html" ] && [ -f "doc/html/index.html" ]; then
+	echo "API documentation generated"
+	if [ -n "${TRAVIS_TAG}" ]; then
+		echo "Generate API documentation archive for release deployment ..."
+		zip -9 -r -q doc/hubzilla-api-documentation.zip doc/html/
+	fi
+else
+	echo "No API documentation files have been found" >&2
+	exit 1
+fi
diff --git a/tests/travis/prepare.sh b/tests/travis/prepare.sh
new file mode 100755
index 000000000..267b4ec46
--- /dev/null
+++ b/tests/travis/prepare.sh
@@ -0,0 +1,35 @@
+#!/usr/bin/env bash
+
+#
+# Copyright (c) 2016 Hubzilla
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+#
+
+# Exit if anything fails
+set -e
+
+# gd is required, show some info about the used one
+php -r "var_dump(gd_info());"
+
+
+echo "Creating required folders for Hubzilla ..."
+mkdir -p ./store/\[data\]/smarty3
+
+echo "TODO: create .htconfig"
diff --git a/tests/travis/prepare_mysql.sh b/tests/travis/prepare_mysql.sh
new file mode 100755
index 000000000..92c720205
--- /dev/null
+++ b/tests/travis/prepare_mysql.sh
@@ -0,0 +1,39 @@
+#!/usr/bin/env bash
+
+#
+# Copyright (c) 2016 Hubzilla
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+#
+
+# Exit if anything fails
+set -e
+
+echo "Preparing for MySQL ..."
+
+# Print out some MySQL information
+mysql --version
+mysql -e "SELECT VERSION();"
+mysql -e "SHOW VARIABLES LIKE 'max_allowed_packet';"
+mysql -e "SHOW VARIABLES LIKE 'collation_%';"
+mysql -e "SHOW VARIABLES LIKE 'character_set%';"
+mysql -e "SELECT @@sql_mode;"
+
+# Create Hubzilla database
+mysql -e "CREATE DATABASE IF NOT EXISTS hubzilla;" -uroot;
diff --git a/tests/travis/prepare_pgsql.sh b/tests/travis/prepare_pgsql.sh
new file mode 100755
index 000000000..dcd83f3be
--- /dev/null
+++ b/tests/travis/prepare_pgsql.sh
@@ -0,0 +1,37 @@
+#!/usr/bin/env bash
+
+#
+# Copyright (c) 2016 Hubzilla
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+#
+
+# Exit if anything fails
+set -e
+
+echo "Preparing for PostgreSQL ..."
+
+# Print out some PostgreSQL information
+psql --version
+# Why does this hang further execution of the job?
+psql -c "SELECT VERSION();" -U postgres
+
+# Create Hubzilla database
+psql -c "DROP DATABASE IF EXISTS hubzilla;" -U postgres
+psql -c "CREATE DATABASE hubzilla;" -U postgres
diff --git a/tests/unit/Lib/PermissionDescriptionTest.php b/tests/unit/Lib/PermissionDescriptionTest.php
index b1da5a0fd..97a39a2c8 100644
--- a/tests/unit/Lib/PermissionDescriptionTest.php
+++ b/tests/unit/Lib/PermissionDescriptionTest.php
@@ -1,6 +1,6 @@
 <?php
 /*
- * Copyright (c) 2016 Hubzilla
+ * Copyright (c) 2016-2017 Hubzilla
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -21,90 +21,75 @@
  * SOFTWARE.
  */
 
-// Global namespace for fully qualified \App class.
-namespace {
-	// General channel permissions in boot.php
-	// 0 = Only you
-	define ( 'PERMS_PUBLIC'     , 0x0001 ); // anybody
-	define ( 'PERMS_NETWORK'    , 0x0002 ); // anybody in this network
-	define ( 'PERMS_SITE'       , 0x0004 ); // anybody on this site
-	define ( 'PERMS_CONTACTS'   , 0x0008 ); // any of my connections
-	define ( 'PERMS_SPECIFIC'   , 0x0080 ); // only specific connections
-	define ( 'PERMS_AUTHED'     , 0x0100 ); // anybody authenticated (could include visitors from other networks)
-	define ( 'PERMS_PENDING'    , 0x0200 ); // any connections including those who haven't yet been approved
-	// log levels in boot.php
-	define ( 'LOGGER_DEBUG',           2 );
+namespace Zotlabs\Tests\Unit\Lib;
 
-	// Stub global fully qualified \App class for static function calls
-	class App {
-		// Stub get_hostname()
-		public static function get_hostname() {
-			return 'phpunit';
-		}
-	}
-}
+use phpmock\phpunit\PHPMock;
+use Zotlabs\Tests\Unit\UnitTestCase;
+use Zotlabs\Lib\PermissionDescription;
 
-// Stub global functions used in PermissionDescription with the help of
-// PHP's namespace resolution rules.
-namespace Zotlabs\Lib {
-	// Stub global translate function t()
-	function t($s) {
-		return $s;
-	}
-	// Stub global log function logger()
-	function logger($msg, $level = LOGGER_NORMAL, $priority = LOG_INFO) {
-		// doesn't matter
-	}
-}
+/**
+ * @brief Unit Test case for PermissionDescription class.
+ */
+class PermissionDescriptionTest extends UnitTestCase {
 
-// regular namespace for this unit test
-namespace Zotlabs\Tests\Unit\Lib {
+	use PHPMock;
 
-	use Zotlabs\Tests\Unit\UnitTestCase;
-	use Zotlabs\Lib\PermissionDescription;
+	public function testFromDescription() {
+		$permDesc = PermissionDescription::fromDescription('test');
+		$permDesc2 = PermissionDescription::fromDescription('test');
+		$permDesc3 = PermissionDescription::fromDescription('test2');
 
-	/**
-	 * @brief Unit Test case for ConnectionPool class.
-	 */
-	class PermissionDescriptionTest extends UnitTestCase {
+		$this->assertEquals($permDesc, $permDesc2);
+		$this->assertNotEquals($permDesc, $permDesc3);
+	}
 
-		public function testFromDescription() {
-			$permDesc = PermissionDescription::fromDescription('test');
-			$permDesc2 = PermissionDescription::fromDescription('test');
-			$permDesc3 = PermissionDescription::fromDescription('test2');
+	public function testFromStandalonePermission() {
+		// Create a stub for global function t()
+		$t = $this->getFunctionMock('Zotlabs\Lib', 't');
+		$t->expects($this->atLeastOnce())->willReturnCallback(
+			function ($string) {
+				return $string;
+			}
+		);
+		// Create a mock for global function logger()
+		$this->getFunctionMock('Zotlabs\Lib', 'logger');
 
-			$this->assertEquals($permDesc, $permDesc2);
-			$this->assertNotEquals($permDesc, $permDesc3);
-		}
+		$permDescUnknown = PermissionDescription::fromStandalonePermission(-1);
+		$permDescSelf = PermissionDescription::fromStandalonePermission(0);
 
-		public function testFromStandalonePermission() {
-			$permDescUnknown = PermissionDescription::fromStandalonePermission(-1);
-			$permDescSelf = PermissionDescription::fromStandalonePermission(0);
+		$this->assertNull($permDescUnknown);
+		$this->assertNotNull($permDescSelf);
+	}
 
-			$this->assertNull($permDescUnknown);
-			$this->assertNotNull($permDescSelf);
-		}
+	public function testFromGlobalPermission() {
+		//$permDesc = PermissionDescription::fromGlobalPermission('view_profile');
 
-		public function testFromGlobalPermission() {
-			//$permDesc = PermissionDescription::fromGlobalPermission('view_profile');
+		$this->markTestIncomplete(
+			'The method fromGlobalPermission() is not yet testable ...'
+		);
+	}
 
-			$this->markTestIncomplete(
-				'For this test we need more stubs...'
-			);
-		}
+	public function testGetPermissionDescription() {
+		// Create a stub for global function t()
+		$t = $this->getFunctionMock('Zotlabs\Lib', 't');
+		$t->expects($this->atLeastOnce())->willReturnCallback(
+				function ($string) {
+					return $string;
+				}
+		);
+		// Create a mock for global function logger()
+		$this->getFunctionMock('Zotlabs\Lib', 'logger');
 
-		public function testGetPermissionDescription() {
+		// Create a stub for the PermissionDescription class
+		$stub = $this->createMock(PermissionDescription::class);
+		$stub->method('get_permission_description')
+			->will($this->returnArgument(0));
 
-			// fromStandalonePermission uses get_permission_description(), so that will not help
-			//$permDescSelf = PermissionDescription::fromStandalonePermission(0);
-			//$permDescPublic = PermissionDescription::fromStandalonePermission(PERMS_PUBLIC);
+		$permDescSelf = PermissionDescription::fromStandalonePermission(0);
+		$this->assertInstanceOf(PermissionDescription::class, $permDescSelf);
+		$this->assertEquals($permDescSelf->get_permission_description(), 'Only me');
 
-			$this->markTestIncomplete(
-				'For this test we need a mock of PermissionDescription...'
-			);
-			//$permDescSelf =
-			//$this->assertEquals($permDescSelf->, 'Only me');
-			//$this->assertEquals($permDescPublic, 'Public');
-		}
+		$permDescPublic = PermissionDescription::fromStandalonePermission(PERMS_PUBLIC);
+		$this->assertEquals($permDescPublic->get_permission_description(), 'Public');
 	}
 }