Remove no longer needed Docker helper and its related Dockerfile

Signed-off-by: Daniel Calviño Sánchez <danxuliu@gmail.com>
This commit is contained in:
Daniel Calviño Sánchez 2017-04-19 08:06:32 +02:00
parent eea015c1ba
commit 42fbf809fe
2 changed files with 0 additions and 278 deletions

View File

@ -1,52 +0,0 @@
# This Dockerfile builds an image of a system in which a Nextcloud server could
# be installed. It is based on the Dockerfile for Nextcloud 11 on Apache
# (https://github.com/nextcloud/docker/blob/843d309ee62b9d2704e6141d2103f9ded97e35b6/11.0/apache/Dockerfile),
# although without the download and copy of a specific Nextcloud version; there
# is no volume either at "/var/www/html" to make possible to create a new image
# from a container based on this image that includes the installed Nextcloud
# server of the container (as the command to generate a new image from a
# container, "docker commit", does not include in the new image any data stored
# in volumes mounted inside the container).
FROM php:7.1-apache
RUN apt-get update && apt-get install -y \
bzip2 \
libcurl4-openssl-dev \
libfreetype6-dev \
libicu-dev \
libjpeg-dev \
libldap2-dev \
libmcrypt-dev \
libmemcached-dev \
libpng12-dev \
libpq-dev \
libxml2-dev \
&& rm -rf /var/lib/apt/lists/*
# https://docs.nextcloud.com/server/9/admin_manual/installation/source_installation.html
RUN docker-php-ext-configure gd --with-png-dir=/usr --with-jpeg-dir=/usr \
&& docker-php-ext-configure ldap --with-libdir=lib/x86_64-linux-gnu \
&& docker-php-ext-install gd exif intl mbstring mcrypt ldap mysqli opcache pdo_mysql pdo_pgsql pgsql zip
# set recommended PHP.ini settings
# see https://secure.php.net/manual/en/opcache.installation.php
RUN { \
echo 'opcache.memory_consumption=128'; \
echo 'opcache.interned_strings_buffer=8'; \
echo 'opcache.max_accelerated_files=4000'; \
echo 'opcache.revalidate_freq=60'; \
echo 'opcache.fast_shutdown=1'; \
echo 'opcache.enable_cli=1'; \
} > /usr/local/etc/php/conf.d/opcache-recommended.ini
RUN a2enmod rewrite
# PECL extensions
RUN set -ex \
&& pecl install APCu-5.1.8 \
&& pecl install memcached-3.0.2 \
&& pecl install redis-3.1.1 \
&& docker-php-ext-enable apcu redis memcached
RUN a2enmod rewrite
CMD ["apache2-foreground"]

View File

@ -1,226 +0,0 @@
<?php
/**
*
* @copyright Copyright (c) 2017, Daniel Calviño Sánchez (danxuliu@gmail.com)
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
/**
* Helper to manage the Docker container for the Nextcloud test server.
*
* The NextcloudTestServerDockerHelper provides a Nextcloud test server using a
* Docker container. The "setUp" method creates and starts the container, while
* the "cleanUp" method destroys it. A Docker image that provides an installed
* and ready to run Nextcloud server with the configuration and data expected by
* the acceptance tests must be available in the system. The Nextcloud server
* must use a local storage so all the changes it makes are confined to its
* running container.
*
* Also, the Nextcloud server installed in the Docker image is expected to see
* "127.0.0.1" as a trusted domain (which would be the case if it was installed
* by running "occ maintenance:install"). Therefore, the Nextcloud server
* container is connected to the network of the Selenium server container (which
* can be customized in the constructor) so the Selenium server can access the
* Nextcloud server using the "127.0.0.1" IP address. The Selenium server
* container is also expected to map its 80 port to the 80 port of the host so
* the acceptance tests can also access the Nextcloud server using the
* "127.0.0.1" IP address. In any case, the base URL to access the Nextcloud
* server can be got from "getBaseUrl".
*
* Internally, the NextcloudTestServerDockerHelper uses the Docker Command Line
* Interface (the "docker" command) to run, get information from, and destroy
* the container, For better compatibility, the used Docker CLI commands follow
* the pre-1.13 syntax (also available in 1.13 and newer). For example,
* "docker start" instead of "docker container start".
*
* In any case, the "docker" command requires special permissions to talk to the
* Docker daemon, and those permissions are typically available only to the root
* user. However, you should NOT run the acceptance tests as root, but as a
* regular user instead. Please see the Docker documentation to find out how to
* give access to a regular user to the Docker daemon:
* https://docs.docker.com/engine/installation/linux/linux-postinstall/
*
* Note, however, that being able to communicate with the Docker daemon is the
* same as being able to get root privileges for the system. Therefore, you must
* give access to the Docker daemon (and thus run the acceptance tests as) ONLY
* to trusted and secure users:
* https://docs.docker.com/engine/security/security/#docker-daemon-attack-surface
*
* All the public methods that use the 'docker' command throw an exception if
* the command can not be executed or if it does not have enough permissions to
* connect to the Docker daemon; as, due to the current use of this class, it is
* just a warning for the test runner and nothing to be explicitly catched a
* plain base Exception is used.
*/
class NextcloudTestServerDockerHelper implements NextcloudTestServerHelper {
/**
* @var string
*/
private $imageName;
/**
* @var string
*/
private $seleniumContainerName;
/**
* @var string
*/
private $containerName;
/**
* Creates a new NextcloudTestServerDockerHelper.
*
* @param string $imageName the name of the Docker image that provides the
* Nextcloud test server.
* @param string $seleniumContainerName the name of the Selenium server
* container.
*/
public function __construct($imageName = "nextcloud-local-test-acceptance", $seleniumContainerName = "selenium-nextcloud-local-test-acceptance") {
$this->imageName = $imageName;
$this->seleniumContainerName = $seleniumContainerName;
$this->containerName = null;
}
/**
* Sets up the Nextcloud test server.
*
* It starts the Docker container and waits for its Nextcloud test server to
* be started; if the server does not start after some time an exception is
* thrown (as it is just a warning for the test runner and nothing to be
* explicitly catched a plain base Exception is used).
*
* @throws \Exception if the Docker container or its Nextcloud test server
* can not be started.
*/
public function setUp() {
$this->createAndStartContainer();
$timeout = 10;
if (!Utils::waitForServer($this->getBaseUrl(), $timeout)) {
throw new Exception("Docker container for Nextcloud (" . $this->containerName . ") or its Nextcloud test server could not be started");
}
}
/**
* Creates and starts the container.
*
* Note that, even if the container has started, the server it contains may
* not have started yet when this method returns.
*
* @throws \Exception if the Docker command failed to execute.
*/
private function createAndStartContainer() {
$moreEntropy = true;
$this->containerName = uniqid($this->imageName . "-", $moreEntropy);
// There is no need to start the web server as root, so it is started
// directly as www-data instead.
// The container is connected to the network of the Selenium server
// container; due to this, the Selenium server can access the Nextcloud
// server using the "127.0.0.1" IP address, which prevents Nextcloud
// from complaining that it is being accessed from an untrusted domain.
// Moreover, as the Selenium server container is expected to map its
// 80 port to the 80 port of the host the acceptance tests can also
// access the Nextcloud server using the "127.0.0.1" IP address to check
// whether the server is ready or not.
$this->executeDockerCommand("run --detach --user=www-data --network container:" . $this->seleniumContainerName . " --name=" . $this->containerName . " " . $this->imageName);
}
/**
* Cleans up the Nextcloud test server.
*
* It stops and removes the Docker container; if the Docker container can
* not be removed after some time an exception is thrown (as it is just a
* warning for the test runner and nothing to be explicitly catched a plain
* base Exception is used).
*
* @throws \Exception if the Docker container can not be removed.
*/
public function cleanUp() {
$this->stopAndRemoveContainer();
$wasContainerRemovedCallback = function() {
return !$this->isContainerRegistered();
};
$timeout = 10;
$timeoutStep = 0.5;
if (!Utils::waitFor($wasContainerRemovedCallback, $timeout, $timeoutStep)) {
throw new Exception("Docker container for Nextcloud (" . $this->containerName . ") could not be removed");
}
}
/**
* Stops and removes the container.
*
* @throws \Exception if the Docker command failed to execute.
*/
private function stopAndRemoveContainer() {
// Although the Nextcloud image does not define a volume "--volumes" is
// used anyway just in case any of its ancestor images does.
$this->executeDockerCommand("rm --volumes --force " . $this->containerName);
}
/**
* Returns whether the container exists (no matter its state) or not.
*
* @return boolean true if the container exists, false otherwise.
* @throws \Exception if the Docker command failed to execute.
*/
private function isContainerRegistered() {
// With the "--quiet" option "docker ps" only shows the ID of the
// matching containers, without table headers. Therefore, if the
// container does not exist the output will be empty (not even a new
// line, as the last line of output returned by "executeDockerCommand"
// does not include a trailing new line character).
return $this->executeDockerCommand("ps --all --quiet --filter 'name=" . $this->containerName . "'") !== "";
}
/**
* Returns the base URL of the Nextcloud test server.
*
* @return string the base URL of the Nextcloud test server.
* @throws \Exception if the Docker command failed to execute or the
* container is not running.
*/
public function getBaseUrl() {
return "http://127.0.0.1/index.php";
}
/**
* Executes the given Docker command.
*
* @return string the last line of output, without trailing new line
* character.
* @throws \Exception if the Docker command failed to execute.
*/
private function executeDockerCommand($dockerCommand) {
$output = array();
$returnValue = 0;
$lastLine = exec("docker " . $dockerCommand . " 2>&1", $output, $returnValue);
if ($returnValue !== 0) {
throw new Exception("Failed to execute 'docker " . $dockerCommand . "': " . implode("\n", $output));
}
return $lastLine;
}
}