diff options
Diffstat (limited to 'apps/files_external/tests')
| -rw-r--r-- | apps/files_external/tests/README.md | 58 | ||||
| -rw-r--r-- | apps/files_external/tests/backends/smb.php | 8 | ||||
| -rwxr-xr-x | apps/files_external/tests/env/start-smb-silvershell.sh | 63 | ||||
| -rwxr-xr-x | apps/files_external/tests/env/start-webdav-ownCloud.sh | 7 | ||||
| -rwxr-xr-x | apps/files_external/tests/env/stop-smb-silvershell.sh | 36 | ||||
| -rwxr-xr-x | apps/files_external/tests/env/stop-webdav-ownCloud.sh | 11 |
6 files changed, 170 insertions, 13 deletions
diff --git a/apps/files_external/tests/README.md b/apps/files_external/tests/README.md new file mode 100644 index 00000000000..35a0232434e --- /dev/null +++ b/apps/files_external/tests/README.md @@ -0,0 +1,58 @@ +# How to run the files external unit tests + +## Components + +The files_external relies - as the name already says - on external file system +providers. To test easily against such a provider we use some scripts to setup +a provider (and of course also cleanup that provider). Those scripts can be +found in the `tests/env` folder of the files_external app. + +### Naming Conventions + +The current implementation supports a script that starts with `start-` for the +setup step which is executed before the PHPUnit run and an optional script +starting with `stop-` (and have the same ending as the start script) to cleanup +the provider. For example: `start-webdav-ownCloud.sh` and +`stop-webdav-ownCloud.sh`. As a second requirement after this prefix there has +to be the name of the backend test suite. In the above example the test suite +`tests/backends/webdav.php` is used. The last part is a name that can be chosen +freely. + +## Hands-on way of unit test execution + +Run all files_external unit tests by invoking the following in the ownCloud +core root folder: + + ./autotest-external.sh + +This script supports to get passed a database as first argument: + + ./autotest-external.sh sqlite + +You can also pass the name of the external file system provider as a second +argument that should be executed. This is the name of the script without the +prefix `start-` (or `stop-`) and without the extension `.sh` from the above +mentioned components in `test/env`. So if you want to start the WebDAV backend +tests against an ownCloud instance you can run following: + + ./autotest-external.sh sqlite webdav-ownCloud + +This runs the script `start-webdav-ownCloud.sh` from the `tests/env` folder, +then runs the unit test suite from `backends/webdav.php` (because the middle part of +the name of the script is `webdav`) and finally tries to call +`stop-webdav-ownCloud.sh` for cleanup purposes. + +## The more manual way of unit test execution + +If you want to debug your external storage provider, you maybe don't want to +fire it up, execute the unit tests and clean everything up for each debugging +step. In this case you can simply start the external storage provider instance +and run the unit test multiple times against the instance for debugging purposes. +To do this you just need to follow these steps (from within +`apps/files_external/tests`): + + 1. run the start step (`env/start-BACKEND-NAME.sh`) or start the environment by + hand (i.e. setting up an instance manually in a virtual box) + 2. run the unit tests with following command (you can repeat that step multiple times): + `phpunit --configuration ../../../tests/phpunit-autotest-external.xml backends/BACKEND.php` + 3. call the cleanup script (`env/stop-BACKEND-NAME.sh`) or cleanup by hand diff --git a/apps/files_external/tests/backends/smb.php b/apps/files_external/tests/backends/smb.php index 9e5ab2b331f..4b2f4425ebc 100644 --- a/apps/files_external/tests/backends/smb.php +++ b/apps/files_external/tests/backends/smb.php @@ -16,12 +16,12 @@ class SMB extends Storage { parent::setUp(); $id = $this->getUniqueID(); - $this->config = include('files_external/tests/config.php'); - if (!is_array($this->config) or !isset($this->config['smb']) or !$this->config['smb']['run']) { + $config = include('files_external/tests/config.smb.php'); + if (!is_array($config) or !$config['run']) { $this->markTestSkipped('Samba backend not configured'); } - $this->config['smb']['root'] .= $id; //make sure we have an new empty folder to work in - $this->instance = new \OC\Files\Storage\SMB($this->config['smb']); + $config['root'] .= $id; //make sure we have an new empty folder to work in + $this->instance = new \OC\Files\Storage\SMB($config); $this->instance->mkdir('/'); } diff --git a/apps/files_external/tests/env/start-smb-silvershell.sh b/apps/files_external/tests/env/start-smb-silvershell.sh new file mode 100755 index 00000000000..f72ad3f9e23 --- /dev/null +++ b/apps/files_external/tests/env/start-smb-silvershell.sh @@ -0,0 +1,63 @@ +#!/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.W +# +# Set environment variable DEBUG to print config file +# +# @author Morris Jobke +# @copyright 2015 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 silvershell/samba docker image" +docker pull silvershell/samba + +# retrieve current folder to place the config in the parent folder +thisFolder=`echo $0 | replace "env/start-smb-silvershell.sh" ""` + +if [ -z "$thisFolder" ]; then + thisFolder="." +fi; + +container=`docker run -d -e SMB_USER=test -e SMB_PWD=test silvershell/samba` + +host=`docker inspect $container | grep IPAddress | cut -d '"' -f 4` + +cat > $thisFolder/config.smb.php <<DELIM +<?php + +return array( + 'run'=>true, + 'host'=>'$host', + 'user'=>'test', + 'password'=>'test', + 'root'=>'', + 'share'=>'public', +); + +DELIM + +echo "samba 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/dockerContainerSilvershell.$EXECUTOR_NUMBER.smb + +if [ -n "$DEBUG" ]; then + cat $thisFolder/config.smb.php + cat $thisFolder/dockerContainerSilvershell.$EXECUTOR_NUMBER.smb +fi + +# TODO find a way to determine the successful initialization inside the docker container +echo "Waiting 5 seconds for smbd initialization ... " +sleep 5 + diff --git a/apps/files_external/tests/env/start-webdav-ownCloud.sh b/apps/files_external/tests/env/start-webdav-ownCloud.sh index c7267cff341..58b87e8f05d 100755 --- a/apps/files_external/tests/env/start-webdav-ownCloud.sh +++ b/apps/files_external/tests/env/start-webdav-ownCloud.sh @@ -28,6 +28,10 @@ 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 [ -z "$thisFolder" ]; then + thisFolder="." +fi; + if [ -n "$RUN_DOCKER_MYSQL" ]; then echo "Fetch recent mysql docker image" docker pull mysql @@ -78,5 +82,6 @@ if [ -n "$databaseContainer" ]; then fi if [ -n "$DEBUG" ]; then - echo $thisFolder/config.webdav.php + cat $thisFolder/config.webdav.php + cat $thisFolder/dockerContainerOwnCloud.$EXECUTOR_NUMBER.webdav fi diff --git a/apps/files_external/tests/env/stop-smb-silvershell.sh b/apps/files_external/tests/env/stop-smb-silvershell.sh new file mode 100755 index 00000000000..6ae28d15506 --- /dev/null +++ b/apps/files_external/tests/env/stop-smb-silvershell.sh @@ -0,0 +1,36 @@ +#!/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 2015 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-smb-silvershell.sh" ""` + +if [ -z "$thisFolder" ]; then + thisFolder="." +fi; + +# stopping and removing docker containers +for container in `cat $thisFolder/dockerContainerSilvershell.$EXECUTOR_NUMBER.smb`; do + echo "Stopping and removing docker container $container" + # kills running container and removes it + docker rm -f $container +done; + +# cleanup +rm $thisFolder/config.smb.php +rm $thisFolder/dockerContainerSilvershell.$EXECUTOR_NUMBER.smb + diff --git a/apps/files_external/tests/env/stop-webdav-ownCloud.sh b/apps/files_external/tests/env/stop-webdav-ownCloud.sh index 2f06eadcf7c..9d75c2bbd03 100755 --- a/apps/files_external/tests/env/stop-webdav-ownCloud.sh +++ b/apps/files_external/tests/env/stop-webdav-ownCloud.sh @@ -19,14 +19,9 @@ 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 +if [ -z "$thisFolder" ]; then + thisFolder="." +fi; # stopping and removing docker containers for container in `cat $thisFolder/dockerContainerOwnCloud.$EXECUTOR_NUMBER.webdav`; do |