Commit 3bf4c1fd authored by Ernesto Rodriguez Ortiz's avatar Ernesto Rodriguez Ortiz
Browse files

WIP Refactoring to made drupalizer work with docker-compose.

I'm really sorry for this one BIG commit with all the changes, but this
start like an experiment work testing differents thinks and some of
them were removed, so I don't want to create confussion with commits
that add some changes and are later removed by other commits.
This is still a WIP (Work In Progress) but I think is ready for
testing and have some feedbacks and contributions!

* Use Docker4Drupal instead our own base image.
* Use Docker Compose to run docker commands instead docker directly, so
almost every fab docker.* task has changed, use fab --list to see new tasks.
* Add a fix permissions task to set the owner and groups of files
dynamically using the current user and the web server user in the container.
* Add a task to clean the src/drupal avoiding permissions problems.
* Add ruamel.yml like a dependency to the project to inspect the defined
services in the docker-compose.yml
* Change the test package to load and run differents tests modules dynamically.
* Add a "tags" argument to the "test" command in order to limit which
scenarios are run.
* Changes in the config files structure, you must copy local_vars.py and
rewrite the conf/drupalizer.py
* Several PEP8 corrections.
* Add aegir folder with the drush migrate-sites and remove-platform scripts
that should be placed in the aegir home in the hostmaster server.
parent cb54e5fa
Pipeline #1708 failed with stages
stages:
- test
- quality
health-check:
image: python:3.5
stage: test
script:
- pip install fabric ruamel.yaml
- fab --version
- fab -f . --list-format=nested --list
sonar:
tags:
- docker-images
sonarqube:
image: ntdt/sonar-scanner:2.7
stage: quality
script:
- /opt/sonar-scanner/bin/sonar-scanner -Dsonar.host.url='https://sonarqube.savoirfairelinux.net' -Dsonar.login='8317c73bde6903c2cca1fbcc2148a937602fbc97' -Dsonar.analysis.mode=preview -Dsonar.issuesReport.console.enable=true -Dsonar.gitlab.commit_sha=$CI_BUILD_REF -Dsonar.gitlab.ref=$CI_BUILD_REF_NAME
- cd $CI_PROJECT_DIR && /opt/sonar-scanner/bin/sonar-scanner -Dsonar.host.url=$SONAR_HOST -Dsonar.login=$SONAR_TOKEN
tags:
- docker-images
......@@ -6,16 +6,28 @@ This project adheres to http://semver.org/[Semantic Versioning].
== [Unreleased]
* Add a "tags" argument to the "test" command in order to limit which scenarios are run by behat.
=== Fixed
* Site name can now have whitespaces without breaking the shell execution string
=== Added
* Add a Patternlab command to build the static style guide: `fab patternlab.build`.
* Add a Git command to verify repositories states and warn user if changes might be lost.
* Use Docker4Drupal instead our own base image.
* Use Docker Compose to run docker commands instead docker directly, so
almost every fab docker.* task has changed, use fab --list to see new tasks.
* Add a fix permissions task to set the owner and groups of files
dynamically using the current user and the web server user in the container.
* Add a task to clean the src/drupal avoiding permissions problems.
* Add ruamel.yml like a dependency to the project to inspect the defined
services in the docker-compose.yml
* Change the test package to load and run differents tests modules dynamically.
* Add a "tags" argument to the "test" command in order to limit which
scenarios are run.
* Changes in the config files structure, you must copy local_vars.py and
rewrite the conf/drupalizer.py
* Several PEP8 corrections.
* Add aegir folder with the drush migrate-sites and remove-platform scripts
that should be placed in the aegir home in the hostmaster server.
* Site name can now have whitespaces without breaking the shell execution
string
* Add a Patternlab command to build the static style guide: `fab patternlab
.build`.
* Add a Git command to verify repositories states and warn user if changes
might be lost.
== 2.0.0 - 2016/05/09
......
......@@ -4,30 +4,37 @@ v2.0.0, 2016-04-05
:toc:
// Refs
:doc-docker: https://www.docker.com/
:doc-docker-compose: https://docs.docker.com/compose/
:doc-docker4drupal: http://docker4drupal.org/
:doc-fabric: http://www.fabfile.org/
:doc-docker-installation: https://docs.docker.com/engine/installation/
:doc-docker-baseimage: https://hub.docker.com/r/savoirfairelinux/lampd/
:doc-ruamel.yaml: https://pypi.python.org/pypi/ruamel.yaml
:doc-drush: http://docs.drush.org/en/master/
:doc-asciidoctor: http://asciidoctor.org/docs/asciidoc-recommended-practices/
== System Requirements
Drupalizer has been designed to work with Drupal 7
Drupalizer has been designed to work with Drupal 7 or 8
and therefore can not work as a standalone application.
TIP: Whenever it is possible, you should use *Composer* to install and manage the PHP dependencies.
TIP: Whenever it is possible, you should use *Composer* to install and manage
the PHP dependencies, and PIP to install and manage Python dependencies.
The following dependencies need to be installed:
* {doc-docker}[Docker]
* {doc-docker-compose}[Docker Compose]
* {doc-fabric}[Fabric]
* {doc-ruamel.yaml}[ruamel.yaml]
* {doc-drush}[Drush] (version 6 or 7)
== Installation
CAUTION: The installation procedure to set-up Docker is not described here. Please refer to the official documentation on how to install {doc-docker-installation}[Docker Engine]. The Docker image is based on our {doc-docker-baseimage}[Docker base image], that will automatically installed at setup.
CAUTION: The installation procedure to set-up Docker and Docker Compose is not
described here. Please refer to the official documentation on how to install
{doc-docker}[Docker] and {doc-docker-compose}[Docker Compose].
For Fabric to detect Drupalizer as Python module, clone the repository in a directory called `fabfile`.
For Fabric to detect Drupalizer as Python module, clone the repository in a
directory called `fabfile`.
To test the installation, run:
......@@ -45,18 +52,22 @@ You are now ready to build your Drupal site:
== About this document
This document uses the Asciidoc syntax generator.
It is a convenient tool allowing to write documentation in raw text files, and convert them to HTML or PDF later on.
It is a convenient tool allowing to write documentation in raw text files,
and convert them to HTML or PDF later on.
Visit https://github.com/asciidoctor[Asciidoctor @ *GitHub*] for more informations.
Visit https://github.com/asciidoctor[Asciidoctor @ *GitHub*] for more
informations.
The {doc-asciidoctor}[AsciiDoc Recommanded Practices] is also recommanded.
To generate a HTML version, first install asciidoctor package on your Linux distribution, then issue following command:
To generate a HTML version, first install asciidoctor package on your Linux
distribution, then issue following command:
$ asciidoctor README.adoc
The README.html is generated in the current directory.
Asciidoctor provides a native PDF renderer for Asciidoc. Still in alpha, but worth the try. Please follow the instructions on the official documentation to
Asciidoctor provides a native PDF renderer for Asciidoc. Still in alpha, but
worth the try. Please follow the instructions on the official documentation to
install it, then issue following command:
$ asciidoctor-pdf README.adoc
......
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
GNU AFFERO GENERAL PUBLIC LICENSE
Version 3, 19 November 2007
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
......@@ -7,17 +7,15 @@
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The GNU Affero General Public License is a free, copyleft license for
software and other kinds of works, specifically designed to ensure
cooperation with the community in the case of network server software.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
our General Public Licenses are intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
software for all its users.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
......@@ -26,44 +24,34 @@ them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
Developers that use our General Public Licenses protect your rights
with two steps: (1) assert copyright on the software, and (2) offer
you this License which gives you legal permission to copy, distribute
and/or modify the software.
A secondary benefit of defending all users' freedom is that
improvements made in alternate versions of the program, if they
receive widespread use, become available for other developers to
incorporate. Many developers of free software are heartened and
encouraged by the resulting cooperation. However, in the case of
software used on network servers, this result may fail to come about.
The GNU General Public License permits making a modified version and
letting the public access it on a server without ever releasing its
source code to the public.
The GNU Affero General Public License is designed specifically to
ensure that, in such cases, the modified source code becomes available
to the community. It requires the operator of a network server to
provide the source code of the modified version running there to the
users of that server. Therefore, public use of a modified version, on
a publicly accessible server, gives the public access to the source
code of the modified version.
An older license, called the Affero General Public License and
published by Affero, was designed to accomplish similar goals. This is
a different license, not a version of the Affero GPL, but Affero has
released a new version of the Affero GPL which permits relicensing under
this license.
The precise terms and conditions for copying, distribution and
modification follow.
......@@ -72,7 +60,7 @@ modification follow.
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"This License" refers to version 3 of the GNU Affero General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
......@@ -549,35 +537,45 @@ to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
13. Remote Network Interaction; Use with the GNU General Public License.
Notwithstanding any other provision of this License, if you modify the
Program, your modified version must prominently offer all users
interacting with it remotely through a computer network (if your version
supports such interaction) an opportunity to receive the Corresponding
Source of your version by providing access to the Corresponding Source
from a network server at no charge, through some standard or customary
means of facilitating copying of software. This Corresponding Source
shall include the Corresponding Source for any work covered by version 3
of the GNU General Public License that is incorporated pursuant to the
following paragraph.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
under version 3 of the GNU General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
but the work with which it is combined will remain governed by version
3 of the GNU General Public License.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
the GNU Affero General Public License from time to time. Such new versions
will be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Program specifies that a certain numbered version of the GNU Affero General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
GNU Affero General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
versions of the GNU Affero General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
......@@ -631,45 +629,33 @@ to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
{one line to give the program's name and a brief idea of what it does.}
Copyright (C) {year} {name of author}
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
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 General Public License for more details.
GNU Affero General Public License for more details.
You should have received a copy of the GNU General Public License
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/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
{project} Copyright (C) {year} {fullname}
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
If your software can interact with users remotely through a computer
network, you should also make sure that it provides a way for users to
get its source. For example, if your program is a web application, its
interface could display a "Source" link that leads users to an archive
of the code. There are many ways you could offer source, and different
solutions will be better for different programs; see section 13 for the
specific requirements.
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<http://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
For more information on this, and how to apply and follow the GNU AGPL, see
<http://www.gnu.org/licenses/>.
\ No newline at end of file
......@@ -35,9 +35,6 @@ Those are global project parameters mandatory to Drupalizer.
|This env var is defined by Fabric itself, and it's defaut value is True.
|You can easily pass it to False, addinf --no-pty to your fab command line. Useful in Jenkins jobs.
|_locale_
|If True, install the site in French.
|===
=== Site settings
......@@ -88,7 +85,7 @@ Those are global project parameters mandatory to Drupalizer.
|The Drupal site directory (only for multisite). Default: _default_.
|_site_languages_
|Translation files you need to download when building new Drupal installation (separate with comma). Default: _fr_.
|Translation files that must be downloaded when building Drupal and activate during installation (separate with comma, the first one will be the default site language). Default: _fr_.
|===
......@@ -107,20 +104,18 @@ Those are global project parameters mandatory to Drupalizer.
|===
|Parameters |Description
|_docker_workspace_
|The Docker workspace. Default: _/opt/sfl_
|_code_workspace_
|The Docker workspace. Default: _/var/www/html_
|_docker_site_root_
|Drupal root in the Docker container. Default: _/opt/sfl/src/drupal_.
|_code_site_root_
|Drupal root in the Docker container. Default: _/var/www/html/src/drupal_.
|bind_port
|The Docker port. Default: _8001_.
|_local_userid_
|The id of your local user to fix the permissions in the container.
|_apache_user_
|The user running Apache in the Docker container. Default: _www-data_.
|_apache_userid
|The user running Apache in the Docker container.
|_container_ip_
|Docker auto-added container IP. **Do not edit**.
|===
......@@ -188,12 +183,12 @@ Some more atomic tasks supported by *Drupalizer* would be:
* _Start/stop_ the Docker container:
$ fab docker.container_start
$ fab docker.container_stop
$ fab docker.composer_up
$ fab docker.composer_down
* _Bash_ into the Docker container:
$ fab docker.connect
$ fab docker.connect:service=php
* _Run_ the Behat tests (without configure):
......
import docker
from deploy import *
import drush
import behat
import patternlab
from .environments import e
# coding: utf-8
#
# Copyright (C) 2016 Savoir-faire Linux Inc. (<www.savoirfairelinux.com>).
#
# 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/>.
#
from fabric.api import task, env, execute
from fabric.colors import red
from fabric.contrib.console import confirm
from fabfile import core
from fabfile import docker
from fabfile import deploy
from fabfile import drush
from fabfile import patternlab
from fabfile import tests
@task
def init():
def clean():
"""
Complete local installation process, used generally when building the docker image for install and configure Drupal.
Remove all files inside src/drupal.
"""
execute(docker.image_create)
execute(docker.container_start)
execute(drush.make, 'install')
execute(drush.site_install, host='root@{}'.format(env.container_ip))
execute(drush.aliases)
execute(behat.init, host='root@{}'.format(env.container_ip))
core.clean()
@task
def test(tags=''):
def deployment(environment):
"""
Deploy code and run database updates on a target Drupal environment.
"""
Setup Behat and run the complete tests suite. Default output formatters: pretty and JUnit.
The JUnit report file is specified in the Behat configuration file. Default: tests/behat/out/behat.junit.xml.
execute(deploy.provision, environment)
execute(deploy.push, environment, hosts=env.hosts)
execute(deploy.migrate, environment, hosts=env.hosts)
:param tags Specific Behat tests tags to run.
@task
def hosts():
"""
execute(behat.init)
if not tags:
execute(behat.run)
else:
execute(behat.run, tags='{}'.format(tags))
Update the file /etc/hosts and add aliases for each services that made port
binding with the local machine
"""
execute(docker.compose_up)
core.add_hosts_aliases()
@task
def install():
def init():
"""
Run the full installation process.
Complete local installation process, used generally when
building the docker image for install and configure Drupal.
"""
execute(docker.compose_up)
execute(docker.compose_start)
execute(drush.make, 'install')
execute(drush.site_install)
execute(behat.init)
execute(drush.aliases)
@task
def update():
def install():
"""
Update the full codebase and run the availabe database updates.
Run the full installation process.
"""
execute(drush.make, 'update')
execute(drush.updatedb)
execute(behat.init)
execute(drush.make, 'install')
execute(drush.site_install)
@task
def release():
"""
Generate all artefacts related to a release process or a deployment process.
Generate all artefacts related to a release process or a deployment
process.
"""
execute(drush.archive_dump)
execute(drush.gen_doc)
@task
def deploy(environment):
"""Deploy code and run database updates on a target Drupal environment.
def test(pattern=''):
"""
Setup tests engines and run the complete tests suite.
:param pattern Specific tests to run that match the pattern.
"""
if pattern:
execute(tests.run, tags=pattern)
else:
execute(tests.run)
execute(provision, environment)
execute(push, environment, hosts=env.hosts)
execute(migrate, environment, hosts=env.hosts)
@task
def update():
"""
Update the full codebase and run the availabe database updates.
"""
execute(drush.make, 'update')
execute(drush.updatedb)
#!/usr/local/bin/drush @hostmaster
<?php
// Drush script to migrate a site from the command line.
// This script should be placed into the aegir home in the hostmaster server
// Provide site name and target platform name from the command line
// Get old and new platform name to migrate sites
$old_platform_name = drush_shift();
$new_platform_name = drush_shift();
// Lookup platform // CLEANER REQUEST NEED
$sql = "SELECT nid FROM node where title = '$new_platform_name' AND type = 'platform'";
$result = db_query($sql);
foreach ($result as $row) {
$new_platform_nid = $row->nid;
}
if (!$new_platform_nid) {
drush_set_error('INVALID_PLATFORM', "Specified target platform cannot be found");
exit();
}
// Confirm if platform is online, if not, wait
$timeout = 600;
$online = FALSE;
$start_time = time();
while (!$online) {
//Get platform readiness // CLEANER REQUEST NEED
$sql = "SELECT status FROM hosting_platform WHERE nid = '$new_platform_nid' AND status = 1";
$result = db_query($sql);
foreach ($result as $row) {
$online = $row->status;
}
//If we're not yet online, sleep for 15 seconds, unless we've already hit our timeout
if (!$online) {
if (time() - $start_time > $timeout) {
drush_set_error('PLATFORM_TIMEOUT', "Target migration platform was not ready within timeout period of $timeout seconds");
exit();
}
sleep(15);
}
}
// Find the sites in the old platform
$sql = "SELECT n.nid, n.title, s.db_server FROM node AS n " .
"INNER JOIN hosting_site AS s ON (n.nid=s.nid) " .
"INNER JOIN hosting_platform AS p ON (s.platform=p.nid) " .
"WHERE p.publish_path LIKE '%$old_platform_name%' AND p.publish_path <> '%$new_platform_name'";
// Migrate sites in the old platform to the new one
$result = db_query($sql);
foreach ($result as $row) {
//Platform must be online, so we can continue with the migrate
watchdog('hostmaster', 'Site ' . $row->title . ' will be migrate to Platform ' . $new_platform_name);
drush_log('Site ' . $row->title . ' will be migrate to Platform ' . $new_platform_name);
hosting_add_task($row->nid, 'migrate', array(
'target_platform' => $new_platform_nid,
'new_uri' => $row->title,
'new_db_server' => $row->db_server,
));
}