Merge pull request #12168 from owncloud/docker-webdav

Setup a docker container that holds a webdav instance to test files_exte...

.gitignore

@@ -22,6 +22,7 @@
 /apps/files_external/3rdparty/irodsphp/prods/test
 /apps/files_external/3rdparty/irodsphp/prods/tutorials
 /apps/files_external/3rdparty/irodsphp/prods/test*
+/apps/files_external/tests/config.*.php
 
 
 

apps/files_external/tests/backends/webdav.php

@@ -16,15 +16,15 @@ class DAV extends Storage {
 		parent::setUp();
 
 		$id = $this->getUniqueID();
-		$this->config = include('files_external/tests/config.php');
+		$config = include('files_external/tests/config.webdav.php');
-		if ( ! is_array($this->config) or ! isset($this->config['webdav']) or ! $this->config['webdav']['run']) {
+		if ( ! is_array($config) or !$config['run']) {
 			$this->markTestSkipped('WebDAV backend not configured');
 		}
-		if (isset($this->config['webdav']['wait'])) {
+		if (isset($config['wait'])) {
-			$this->waitDelay = $this->config['webdav']['wait'];
+			$this->waitDelay = $config['wait'];
 		}
-		$this->config['webdav']['root'] .= '/' . $id; //make sure we have an new empty folder to work in
+		$config['root'] .= '/' . $id; //make sure we have an new empty folder to work in
-		$this->instance = new \OC\Files\Storage\DAV($this->config['webdav']);
+		$this->instance = new \OC\Files\Storage\DAV($config);
 		$this->instance->mkdir('/');
 	}
 

apps/files_external/tests/env/start-webdav-ownCloud.sh

@@ -0,0 +1,82 @@
+#!/bin/bash
+#
+# ownCloud
+#
+# This script start a docker container to test the files_external tests
+# against. It will also change the files_external config to use the docker
+# container as testing environment. This is reverted in the stop step.
+#
+# If the environment variable RUN_DOCKER_MYSQL is set the ownCloud will
+# be set up using MySQL instead of SQLite.
+#
+# Set environment variable DEBUG to print config file
+#
+# @author Morris Jobke
+# @copyright 2014 Morris Jobke <hey@morrisjobke.de>
+#
+
+if ! command -v docker >/dev/null 2>&1; then
+    echo "No docker executable found - skipped docker setup"
+    exit 0;
+fi
+
+echo "Docker executable found - setup docker"
+
+echo "Fetch recent morrisjobke/owncloud docker image"
+docker pull morrisjobke/owncloud
+
+# retrieve current folder to place the config in the parent folder
+thisFolder=`echo $0 | replace "env/start-webdav-ownCloud.sh" ""`
+
+if [ -n "$RUN_DOCKER_MYSQL" ]; then
+    echo "Fetch recent mysql docker image"
+    docker pull mysql
+
+    echo "Setup MySQL ..."
+    # user/password will be read by ENV variables in owncloud container (they are generated by docker)
+    databaseContainer=`docker run -e MYSQL_ROOT_PASSWORD=mysupersecretpassword -d mysql`
+    containerName=`docker inspect $databaseContainer | grep Name | grep _ | cut -d \" -f 4 | cut -d / -f 2`
+
+    parameter="--link $containerName:db"
+fi
+
+container=`docker run -P $parameter -d -e ADMINLOGIN=test -e ADMINPWD=test morrisjobke/owncloud`
+
+# TODO find a way to determine the successful initialization inside the docker container
+echo "Waiting 30 seconds for ownCloud initialization ... "
+sleep 30
+
+# get mapped port on host for internal port 80 - output is IP:PORT - we need to extract the port with 'cut'
+port=`docker port $container 80 | cut -f 2 -d :`
+
+
+cat > $thisFolder/config.webdav.php <<DELIM
+<?php
+
+return array(
+    'run'=>true,
+    'host'=>'localhost:$port/owncloud/remote.php/webdav/',
+    'user'=>'test',
+    'password'=>'test',
+    'root'=>'',
+    // wait delay in seconds after write operations
+    // (only in tests)
+    // set to higher value for lighttpd webdav
+    'wait'=> 0
+);
+
+DELIM
+
+echo "ownCloud container: $container"
+
+# put container IDs into a file to drop them after the test run (keep in mind that multiple tests run in parallel on the same host)
+echo $container >> $thisFolder/dockerContainerOwnCloud.$EXECUTOR_NUMBER.webdav
+
+if [ -n "$databaseContainer" ]; then
+    echo "Database container: $databaseContainer"
+    echo $databaseContainer >> $thisFolder/dockerContainerOwnCloud.$EXECUTOR_NUMBER.webdav
+fi
+
+if [ -n "$DEBUG" ]; then
+    echo $thisFolder/config.webdav.php
+fi

apps/files_external/tests/env/stop-webdav-ownCloud.sh

@@ -0,0 +1,41 @@
+#!/bin/bash
+#
+# ownCloud
+#
+# This script stops the docker container the files_external tests were run
+# against. It will also revert the config changes done in start step.
+#
+# @author Morris Jobke
+# @copyright 2014 Morris Jobke <hey@morrisjobke.de>
+#
+
+if ! command -v docker >/dev/null 2>&1; then
+    echo "No docker executable found - skipped docker stop"
+    exit 0;
+fi
+
+echo "Docker executable found - stop and remove docker containers"
+
+# retrieve current folder to remove the config from the parent folder
+thisFolder=`echo $0 | replace "env/stop-webdav-ownCloud.sh" ""`
+
+echo "DEBUG"
+
+netstat -tlpen
+
+echo "CONFIG:"
+
+cat $thisFolder/config.webdav.php
+cat $thisFolder/dockerContainerOwnCloud.$EXECUTOR_NUMBER.webdav
+
+# stopping and removing docker containers
+for container in `cat $thisFolder/dockerContainerOwnCloud.$EXECUTOR_NUMBER.webdav`; do
+    echo "Stopping and removing docker container $container"
+    # kills running container and removes it
+    docker rm -f $container
+done;
+
+# cleanup
+rm $thisFolder/config.webdav.php
+rm $thisFolder/dockerContainerOwnCloud.$EXECUTOR_NUMBER.webdav
+

autotest-external.sh

@@ -0,0 +1,308 @@
+#!/bin/bash
+#
+# ownCloud
+#
+# @author Thomas Müller
+# @author Morris Jobke
+# @copyright 2012, 2013 Thomas Müller thomas.mueller@tmit.eu
+# @copyright 2014 Morris Jobke hey@morrisjobke.de
+#
+
+#$EXECUTOR_NUMBER is set by Jenkins and allows us to run autotest in parallel
+DATABASENAME=oc_autotest$EXECUTOR_NUMBER
+DATABASEUSER=oc_autotest$EXECUTOR_NUMBER
+ADMINLOGIN=admin$EXECUTOR_NUMBER
+BASEDIR=$PWD
+
+DBCONFIGS="sqlite mysql pgsql oci"
+PHPUNIT=$(which phpunit)
+
+function print_syntax {
+	echo -e "Syntax: ./autotest-external.sh [dbconfigname] [startfile]\n" >&2
+	echo -e "\t\"dbconfigname\" can be one of: $DBCONFIGS" >&2
+	echo -e "\t\"startfile\" is the name of a start file inside the env/ folder in the files_external tests" >&2
+	echo -e "\nExample: ./autotest.sh sqlite webdav-ownCloud" >&2
+	echo "will run the external suite from \"apps/files_external/tests/env/start-webdav-ownCloud.sh\"" >&2
+	echo -e "\nIf no arguments are specified, all available external backends will be run with all database configs" >&2
+}
+
+if ! [ -x "$PHPUNIT" ]; then
+	echo "phpunit executable not found, please install phpunit version >= 3.7" >&2
+	exit 3
+fi
+
+PHPUNIT_VERSION=$("$PHPUNIT" --version | cut -d" " -f2)
+PHPUNIT_MAJOR_VERSION=$(echo $PHPUNIT_VERSION | cut -d"." -f1)
+PHPUNIT_MINOR_VERSION=$(echo $PHPUNIT_VERSION | cut -d"." -f2)
+
+if ! [ $PHPUNIT_MAJOR_VERSION -gt 3 -o \( $PHPUNIT_MAJOR_VERSION -eq 3 -a $PHPUNIT_MINOR_VERSION -ge 7 \) ]; then
+	echo "phpunit version >= 3.7 required. Version found: $PHPUNIT_VERSION" >&2
+	exit 4
+fi
+
+if ! [ \( -w config -a ! -f config/config.php \) -o \( -f config/config.php -a -w config/config.php \) ]; then
+	echo "Please enable write permissions on config and config/config.php" >&2
+	exit 1
+fi
+
+if [ "$1" ]; then
+	FOUND=0
+	for DBCONFIG in $DBCONFIGS; do
+		if [ "$1" = $DBCONFIG ]; then
+			FOUND=1
+			break
+		fi
+	done
+	if [ $FOUND = 0 ]; then
+		echo -e "Unknown database config name \"$1\"\n" >&2
+		print_syntax
+		exit 2
+	fi
+fi
+
+# Back up existing (dev) config if one exists
+if [ -f config/config.php ]; then
+	mv config/config.php config/config-autotest-backup.php
+fi
+
+function restore_config {
+	# Restore existing config
+	if [ -f config/config-autotest-backup.php ]; then
+		mv config/config-autotest-backup.php config/config.php
+	fi
+}
+
+# restore config on exit, even when killed
+trap restore_config SIGINT SIGTERM
+
+# use tmpfs for datadir - should speedup unit test execution
+if [ -d /dev/shm ]; then
+  DATADIR=/dev/shm/data-autotest$EXECUTOR_NUMBER
+else
+  DATADIR=$BASEDIR/data-autotest
+fi
+
+echo "Using database $DATABASENAME"
+
+# create autoconfig for sqlite, mysql and postgresql
+cat > ./tests/autoconfig-sqlite.php <<DELIM
+<?php
+\$AUTOCONFIG = array (
+  'installed' => false,
+  'dbtype' => 'sqlite',
+  'dbtableprefix' => 'oc_',
+  'adminlogin' => '$ADMINLOGIN',
+  'adminpass' => 'admin',
+  'directory' => '$DATADIR',
+);
+DELIM
+
+cat > ./tests/autoconfig-mysql.php <<DELIM
+<?php
+\$AUTOCONFIG = array (
+  'installed' => false,
+  'dbtype' => 'mysql',
+  'dbtableprefix' => 'oc_',
+  'adminlogin' => '$ADMINLOGIN',
+  'adminpass' => 'admin',
+  'directory' => '$DATADIR',
+  'dbuser' => '$DATABASEUSER',
+  'dbname' => '$DATABASENAME',
+  'dbhost' => 'localhost',
+  'dbpass' => 'owncloud',
+);
+DELIM
+
+cat > ./tests/autoconfig-pgsql.php <<DELIM
+<?php
+\$AUTOCONFIG = array (
+  'installed' => false,
+  'dbtype' => 'pgsql',
+  'dbtableprefix' => 'oc_',
+  'adminlogin' => '$ADMINLOGIN',
+  'adminpass' => 'admin',
+  'directory' => '$DATADIR',
+  'dbuser' => '$DATABASEUSER',
+  'dbname' => '$DATABASENAME',
+  'dbhost' => 'localhost',
+  'dbpass' => 'owncloud',
+);
+DELIM
+
+cat > ./tests/autoconfig-oci.php <<DELIM
+<?php
+\$AUTOCONFIG = array (
+  'installed' => false,
+  'dbtype' => 'oci',
+  'dbtableprefix' => 'oc_',
+  'adminlogin' => '$ADMINLOGIN',
+  'adminpass' => 'admin',
+  'directory' => '$DATADIR',
+  'dbuser' => '$DATABASENAME',
+  'dbname' => 'XE',
+  'dbhost' => 'localhost',
+  'dbpass' => 'owncloud',
+);
+DELIM
+
+function execute_tests {
+	echo "Setup environment for $1 testing ..."
+	# back to root folder
+	cd "$BASEDIR"
+
+	# revert changes to tests/data
+	git checkout tests/data
+
+	# reset data directory
+	rm -rf "$DATADIR"
+	mkdir "$DATADIR"
+
+	# remove the old config file
+	#rm -rf config/config.php
+	cp tests/preseed-config.php config/config.php
+
+	# drop database
+	if [ "$1" == "mysql" ] ; then
+		mysql -u $DATABASEUSER -powncloud -e "DROP DATABASE IF EXISTS $DATABASENAME" || true
+	fi
+	if [ "$1" == "pgsql" ] ; then
+		dropdb -U $DATABASEUSER $DATABASENAME || true
+	fi
+	if [ "$1" == "oci" ] ; then
+		echo "drop the database"
+		sqlplus -s -l / as sysdba <<EOF
+			drop user $DATABASENAME cascade;
+EOF
+
+		echo "create the database"
+		sqlplus -s -l / as sysdba <<EOF
+			create user $DATABASENAME identified by owncloud;
+			alter user $DATABASENAME default tablespace users
+			temporary tablespace temp
+			quota unlimited on users;
+			grant create session
+			, create table
+			, create procedure
+			, create sequence
+			, create trigger
+			, create view
+			, create synonym
+			, alter session
+			to $DATABASENAME;
+			exit;
+EOF
+	fi
+
+	# copy autoconfig
+	cp "$BASEDIR/tests/autoconfig-$1.php" "$BASEDIR/config/autoconfig.php"
+
+	# trigger installation
+	echo "INDEX"
+	php -f index.php | grep -i -C9999 error && echo "Error during setup" && exit 101
+	echo "END INDEX"
+
+	#test execution
+	echo "Testing with $1 ..."
+
+	if [ -n "$2" ]; then
+		echo "Run only $2 ..."
+	fi
+
+	cd tests
+	rm -rf "coverage-external-html-$1"
+	mkdir "coverage-external-html-$1"
+	# just enable files_external
+	php ../occ app:enable files_external
+	if [ -z "$NOCOVERAGE" ]; then
+		#"$PHPUNIT" --configuration phpunit-autotest-external.xml --log-junit "autotest-external-results-$1.xml" --coverage-clover "autotest-external-clover-$1.xml" --coverage-html "coverage-external-html-$1"
+		RESULT=$?
+	else
+		echo "No coverage"
+		#"$PHPUNIT" --configuration phpunit-autotest-external.xml --log-junit "autotest-external-results-$1.xml"
+		RESULT=$?
+	fi
+
+    FILES_EXTERNAL_BACKEND_PATH=../apps/files_external/tests/backends
+    FILES_EXTERNAL_BACKEND_ENV_PATH=../apps/files_external/tests/env
+
+	for startFile in `ls -1 $FILES_EXTERNAL_BACKEND_ENV_PATH | grep start`; do
+	    name=`echo $startFile | replace "start-" "" | replace ".sh" ""`
+
+	    if [ -n "$2" -a "$2" != "$name" ]; then
+	        echo "skip: $startFile"
+	        continue;
+	    fi
+
+	    echo "start: $startFile"
+	    echo "name: $name"
+
+	    # execute start file
+	    ./$FILES_EXTERNAL_BACKEND_ENV_PATH/$startFile
+
+	    # getting backend to test from filename
+	    # it's the part between the dots startSomething.TestToRun.sh
+	    testToRun=`echo $startFile | cut -d '-' -f 2`
+
+        # run the specific test
+        if [ -z "$NOCOVERAGE" ]; then
+            rm -rf "coverage-external-html-$1-$name"
+            mkdir "coverage-external-html-$1-$name"
+            "$PHPUNIT" --configuration phpunit-autotest-external.xml --log-junit "autotest-external-results-$1-$name.xml" --coverage-clover "autotest-external-clover-$1-$name.xml" --coverage-html "coverage-external-html-$1-$name" "$FILES_EXTERNAL_BACKEND_PATH/$testToRun.php"
+            RESULT=$?
+        else
+            echo "No coverage"
+            "$PHPUNIT" --configuration phpunit-autotest-external.xml --log-junit "autotest-external-results-$1-$name.xml" "$FILES_EXTERNAL_BACKEND_PATH/$testToRun.php"
+            RESULT=$?
+        fi
+
+	    # calculate stop file
+	    stopFile=`echo "$startFile" | replace start stop`
+	    echo "stop: $stopFile"
+	    if [ -f $FILES_EXTERNAL_BACKEND_ENV_PATH/$stopFile ]; then
+	        # execute stop file if existant
+	        ./$FILES_EXTERNAL_BACKEND_ENV_PATH/$stopFile
+	    fi
+	done;
+}
+
+#
+# start test execution
+#
+if [ -z "$1" ]
+  then
+	# run all known database configs
+	for DBCONFIG in $DBCONFIGS; do
+		execute_tests $DBCONFIG "$2"
+	done
+else
+	execute_tests "$1" "$2"
+fi
+
+cd "$BASEDIR"
+
+restore_config
+#
+# NOTES on mysql:
+#  - CREATE DATABASE oc_autotest;
+#  - CREATE USER 'oc_autotest'@'localhost' IDENTIFIED BY 'owncloud';
+#  - grant all on oc_autotest.* to 'oc_autotest'@'localhost';
+#
+#  - for parallel executor support with EXECUTOR_NUMBER=0:
+#  - CREATE DATABASE oc_autotest0;
+#  - CREATE USER 'oc_autotest0'@'localhost' IDENTIFIED BY 'owncloud';
+#  - grant all on oc_autotest0.* to 'oc_autotest0'@'localhost';
+#
+# NOTES on pgsql:
+#  - su - postgres
+#  - createuser -P oc_autotest (enter password and enable superuser)
+#  - to enable dropdb I decided to add following line to pg_hba.conf (this is not the safest way but I don't care for the testing machine):
+# local	all	all	trust
+#
+#  - for parallel executor support with EXECUTOR_NUMBER=0:
+#  - createuser -P oc_autotest0 (enter password and enable superuser)
+#
+# NOTES on oci:
+#  - it's a pure nightmare to install Oracle on a Linux-System
+#  - DON'T TRY THIS AT HOME!
+#  - if you really need it: we feel sorry for you
+#

tests/phpunit-autotest-external.xml

@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<phpunit bootstrap="bootstrap.php"
+		 strict="true"
+		 verbose="true"
+		 timeoutForSmallTests="900"
+		 timeoutForMediumTests="900"
+		 timeoutForLargeTests="900"
+>
+	<testsuite name='ownCloud files external'>
+		<directory suffix=".php">../apps/files_external/tests</directory>
+		<!-- exclude backends as they are called separately -->
+		<exclude>../apps/files_external/tests/backends/</exclude>
+	</testsuite>
+	<!-- filters for code coverage -->
+	<filter>
+		<!-- whitelist processUncoveredFilesFromWhitelist="true" -->
+		<whitelist>
+			<file>../lib/private/files/storage/dav.php</file>
+			<directory suffix=".php">../apps/files_external</directory>
+			<exclude>
+				<directory suffix=".php">../apps/files_external/l10n</directory>
+				<directory suffix=".php">../apps/files_external/3rdparty</directory>
+				<directory suffix=".php">../apps/files_external/tests</directory>
+			</exclude>
+		</whitelist>
+	</filter>
+	<!--<listeners>
+		<listener class="StartSessionListener" file="startsessionlistener.php" />
+	  <listener class="TestCleanupListener" file="testcleanuplistener.php">
+		<arguments>
+			<string>detail</string>
+		</arguments>
+	  </listener>
+	</listeners>-->
+</phpunit>
+