From 9881dd207480ddaa486718d1f26a2f8188013689 Mon Sep 17 00:00:00 2001 From: Ionut Filip Date: Mon, 22 Oct 2018 12:13:22 +0300 Subject: [PATCH 01/28] Documentation for adding more steps/flavors --- setup/readme.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 setup/readme.md diff --git a/setup/readme.md b/setup/readme.md new file mode 100644 index 00000000..0f096734 --- /dev/null +++ b/setup/readme.md @@ -0,0 +1,46 @@ +## Adding more flavors/steps +(Everything will go under setup/ directory - using Kubernetes flavor as example) + +Until this point, the app is working as it follows: +- when accesing the setup page it will display the flavors selection step (`templates/steps/flavor.html`) +- after you choose your desired flavor it will iterare over the files in the flavor directory and building the page + (`templates/steps/config.html is general for all flavors`) +- when you complete all required fields and press "Setup Mailu" button it will redirect you to the setup page (`flavors/choosen-flavor/setup.html`) + +To add a new flavor you need to create a directory under `templates/steps/` in which you are adding actual steps. +Eg: Adding a WIP step we'll create `templates/steps/kubernetes/wip.html` + +*Note that wizard.html is iterating over files in this directory and building the page. Files are prefixed with a number for sorting purposes.* + +wip.html will start with + +``` +{% call macros.panel("info", "Step X - Work in progress") +``` + +and end with +``` +{% endcall %} +``` + +You store variable from front-page using the name attribute inside tag. +In the example below the string entered in the input field is stored in the variable `named var_test` +``` + +``` + +In order to user the variable furter you use it like `{{ var_test }}` + +In the setup page (`flavors/kubernetes/setup`) you cand add steps by importing macros + +``` +{% import "macros.html" as macros %} +``` + +and start and end every step with +``` +{% call macros.panel("info", "Step X - Title") %} +------------------- +{% endcall %} +``` + From 6a9e5c192116f84569761a29b983a5c5c4b448cd Mon Sep 17 00:00:00 2001 From: Ionut Filip Date: Mon, 22 Oct 2018 12:53:25 +0300 Subject: [PATCH 02/28] Create/generate file template --- setup/{readme.md => README.md} | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) rename setup/{readme.md => README.md} (72%) diff --git a/setup/readme.md b/setup/README.md similarity index 72% rename from setup/readme.md rename to setup/README.md index 0f096734..24c9cfa2 100644 --- a/setup/readme.md +++ b/setup/README.md @@ -15,7 +15,7 @@ Eg: Adding a WIP step we'll create `templates/steps/kubernetes/wip.html` wip.html will start with ``` -{% call macros.panel("info", "Step X - Work in progress") +{% call macros.panel("info", "Step X - Work in progress") %} ``` and end with @@ -31,7 +31,7 @@ In the example below the string entered in the input field is stored in the vari In order to user the variable furter you use it like `{{ var_test }}` -In the setup page (`flavors/kubernetes/setup`) you cand add steps by importing macros +In the setup page (`flavors/kubernetes/setup.html`) you cand add steps by importing macros ``` {% import "macros.html" as macros %} @@ -44,3 +44,16 @@ and start and end every step with {% endcall %} ``` +### Generating a file +Create the file template in `flavors/kubernetes/` (eg. file.txt) in which you save your variables +``` +ROOT = {{ root }} +MY_VAR = {{ var_test }} +``` + +When you submit to Setup Mailu the file will be generated. In order to get the file add the following command to setup.html + +``` +

curl {{ url_for('.file', uid=uid, filepath='file.txt', _external=True) }} > file.txt

+``` + From 3c9cae5d06c10e30a06d5ba0200415bcee643f35 Mon Sep 17 00:00:00 2001 From: Ionut Filip Date: Mon, 22 Oct 2018 15:13:18 +0300 Subject: [PATCH 03/28] Added replicas variables for core containers - Added back restart: always on compose flavor - Moved Log driver from .env to docker-compose.yml --- setup/flavors/compose/docker-compose.yml | 12 +++++++++ setup/flavors/compose/mailu.env | 2 +- setup/flavors/stack/docker-compose.yml | 11 ++++---- setup/templates/steps/stack/03_expose.html | 3 ++- setup/templates/steps/stack/04_replicas.html | 28 ++++++++++++++++++++ 5 files changed, 49 insertions(+), 7 deletions(-) create mode 100644 setup/templates/steps/stack/04_replicas.html diff --git a/setup/flavors/compose/docker-compose.yml b/setup/flavors/compose/docker-compose.yml index b01bb8fd..daea844e 100644 --- a/setup/flavors/compose/docker-compose.yml +++ b/setup/flavors/compose/docker-compose.yml @@ -10,13 +10,17 @@ services: # External dependencies redis: image: redis:alpine + restart: always volumes: - "{{ root }}/redis:/data" # Core services front: image: mailu/nginx:{{ version }} + restart: always env_file: {{ env }} + logging: + driver: {{ log_driver or 'json-file' }} ports: {% for port in (80, 443, 25, 465, 587, 110, 995, 143, 993) %} {% if bind4 %} @@ -31,6 +35,7 @@ services: admin: image: mailu/admin:{{ version }} + restart: always env_file: {{ env }} {% if not admin_enabled %} ports: @@ -44,6 +49,7 @@ services: imap: image: mailu/dovecot:{{ version }} + restart: always env_file: {{ env }} volumes: - "{{ root }}/mail:/mail" @@ -53,6 +59,7 @@ services: smtp: image: mailu/postfix:{{ version }} + restart: always env_file: {{ env }} volumes: - "{{ root }}/overrides:/overrides" @@ -63,6 +70,7 @@ services: {% if antispam_enabled %} antispam: image: mailu/rspamd:{{ version }} + restart: always env_file: {{ env }} volumes: - "{{ root }}/filter:/var/lib/rspamd" @@ -75,6 +83,7 @@ services: {% if antivirus_enabled %} antivirus: image: mailu/clamav:{{ version }} + restart: always env_file: {{ env }} volumes: - "{{ root }}/filter:/data" @@ -83,6 +92,7 @@ services: {% if webdav_enabled %} webdav: image: mailu/radicale:{{ version }} + restart: always env_file: {{ env }} volumes: - "{{ root }}/dav:/data" @@ -91,6 +101,7 @@ services: {% if fetchmail_enabled %} fetchmail: image: mailu/fetchmail:{{ version }} + restart: always env_file: {{ env }} {% endif %} @@ -98,6 +109,7 @@ services: {% if webmail_type != 'none' %} webmail: image: mailu/{{ webmail_type }}:{{ version }} + restart: always env_file: {{ env }} volumes: - "{{ root }}/webmail:/data" diff --git a/setup/flavors/compose/mailu.env b/setup/flavors/compose/mailu.env index 9fc1197d..9433ecce 100644 --- a/setup/flavors/compose/mailu.env +++ b/setup/flavors/compose/mailu.env @@ -138,7 +138,7 @@ DOMAIN_REGISTRATION=true # json-file (default) # journald (On systemd platforms, useful for Fail2Ban integration) # syslog (Non systemd platforms, Fail2Ban integration. Disables `docker-compose log` for front!) -LOG_DRIVER={{ log_driver or 'json-file' }} +# LOG_DRIVER={{ log_driver or 'json-file' }} # Docker-compose project name, this will prepended to containers names. COMPOSE_PROJECT_NAME={{ compose_project_name or 'mailu' }} diff --git a/setup/flavors/stack/docker-compose.yml b/setup/flavors/stack/docker-compose.yml index f27b661f..728135d5 100644 --- a/setup/flavors/stack/docker-compose.yml +++ b/setup/flavors/stack/docker-compose.yml @@ -10,7 +10,6 @@ services: # External dependencies redis: image: redis:alpine - restart: always volumes: - "{{ root }}/redis:/data" @@ -18,6 +17,8 @@ services: front: image: mailu/nginx:{{ version }} env_file: {{ env }} + logging: + driver: {{ log_driver or 'json-file' }} ports: {% for port in (80, 443, 25, 465, 587, 110, 995, 143, 993) %} - target: {{ port }} @@ -27,7 +28,7 @@ services: volumes: - "{{ root }}/certs:/certs" deploy: - replicas: 1 + replicas: {{ front_replicas }} admin: image: mailu/admin:{{ version }} @@ -40,7 +41,7 @@ services: - "{{ root }}/data:/data" - "{{ root }}/dkim:/dkim" deploy: - replicas: 1 + replicas: {{ admin_replicas }} imap: image: mailu/dovecot:{{ version }} @@ -52,7 +53,7 @@ services: - "{{ root }}/mail:/mail" - "{{ root }}/overrides:/overrides" deploy: - replicas: 1 + replicas: {{ imap_replicas }} smtp: image: mailu/postfix:{{ version }} @@ -62,7 +63,7 @@ services: volumes: - "{{ root }}/overrides:/overrides" deploy: - replicas: 1 + replicas: {{ smtp_replicas }} # Optional services {% if antispam_enabled %} diff --git a/setup/templates/steps/stack/03_expose.html b/setup/templates/steps/stack/03_expose.html index a9cffc1c..bb61a35c 100644 --- a/setup/templates/steps/stack/03_expose.html +++ b/setup/templates/steps/stack/03_expose.html @@ -5,7 +5,8 @@ you expose it to the world.

- +

You server will be available under a main hostname but may expose multiple public diff --git a/setup/templates/steps/stack/04_replicas.html b/setup/templates/steps/stack/04_replicas.html new file mode 100644 index 00000000..785125cc --- /dev/null +++ b/setup/templates/steps/stack/04_replicas.html @@ -0,0 +1,28 @@ +{% call macros.panel("info", "Step 5 - Number of replicas for containers") %} +

Select number of replicas for containers

+ +
+ + +
+ +
+ + +
+ +
+ + +
+ +
+ + +
+ +{% endcall %} \ No newline at end of file From ae8f928fc0705adf1bde24c6c812ec45d964e6b9 Mon Sep 17 00:00:00 2001 From: Ionut Filip Date: Tue, 23 Oct 2018 17:07:05 +0300 Subject: [PATCH 04/28] Added project name on docker commands --- setup/flavors/compose/setup.html | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/setup/flavors/compose/setup.html b/setup/flavors/compose/setup.html index 0379ba82..3d87a263 100644 --- a/setup/flavors/compose/setup.html +++ b/setup/flavors/compose/setup.html @@ -28,15 +28,15 @@ files before going any further.

{% call macros.panel("info", "Step 3 - Start the Compose project") %}

To start your compose project, simply run the Docker Compose up -command.

+command using -p mailu flag for project name.

cd {{ root }}
-docker-compose up -d
+docker-compose -p mailu up -d
 
Before you can use Mailu, you must create the primary administrator user account. This should be {{ postmaster }}@{{ domain }}. Use the following command, changing PASSWORD to your liking: -
docker-compose exec admin python manage.py admin {{ postmaster }} {{ domain }} PASSWORD
+
docker-compose -p mailu exec admin python manage.py admin {{ postmaster }} {{ domain }} PASSWORD
 

Login to the admin interface to change the password for a safe one, at From e5268de0c750125b5d9621fed47f643e3b97237b Mon Sep 17 00:00:00 2001 From: Ionut Filip Date: Tue, 23 Oct 2018 17:55:44 +0300 Subject: [PATCH 05/28] Revert default value for subnet --- setup/templates/steps/stack/03_expose.html | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/setup/templates/steps/stack/03_expose.html b/setup/templates/steps/stack/03_expose.html index bb61a35c..a9cffc1c 100644 --- a/setup/templates/steps/stack/03_expose.html +++ b/setup/templates/steps/stack/03_expose.html @@ -5,8 +5,7 @@ you expose it to the world.

- +

You server will be available under a main hostname but may expose multiple public From 238d4e7f208b13b245b1bb98e8e8b56ce50e229f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim=20M=C3=B6hlmann?= Date: Wed, 24 Oct 2018 12:02:28 +0300 Subject: [PATCH 06/28] Provide test cases created with the new setup utility --- tests/compose/core.yml | 74 ++++++++++++++++ tests/compose/fetchmail.yml | 77 +++++++++++++++++ tests/compose/filters+dns.yml | 119 ++++++++++++++++++++++++++ tests/compose/{core.env => mailu.env} | 54 ++++++------ tests/compose/rainloop.yml | 84 ++++++++++++++++++ tests/compose/roundcube.yml | 84 ++++++++++++++++++ tests/compose/run.yml | 101 ---------------------- tests/compose/webdav.yml | 79 +++++++++++++++++ 8 files changed, 545 insertions(+), 127 deletions(-) create mode 100644 tests/compose/core.yml create mode 100644 tests/compose/fetchmail.yml create mode 100644 tests/compose/filters+dns.yml rename tests/compose/{core.env => mailu.env} (72%) create mode 100644 tests/compose/rainloop.yml create mode 100644 tests/compose/roundcube.yml delete mode 100644 tests/compose/run.yml create mode 100644 tests/compose/webdav.yml diff --git a/tests/compose/core.yml b/tests/compose/core.yml new file mode 100644 index 00000000..460a6908 --- /dev/null +++ b/tests/compose/core.yml @@ -0,0 +1,74 @@ +# This file is auto-generated by the Mailu configuration wizard. +# Please read the documentation before attempting any change. +# Generated for compose flavor + +version: '3.6' + +services: + + # External dependencies + redis: + image: redis:alpine + volumes: + - "/mailu/redis:/data" + + # Core services + front: + image: mailu/nginx:master + env_file: mailu.env + ports: + - "127.0.0.1:80:80" + - "::1:80:80" + - "127.0.0.1:443:443" + - "::1:443:443" + - "127.0.0.1:25:25" + - "::1:25:25" + - "127.0.0.1:465:465" + - "::1:465:465" + - "127.0.0.1:587:587" + - "::1:587:587" + - "127.0.0.1:110:110" + - "::1:110:110" + - "127.0.0.1:995:995" + - "::1:995:995" + - "127.0.0.1:143:143" + - "::1:143:143" + - "127.0.0.1:993:993" + - "::1:993:993" + volumes: + - "/mailu/certs:/certs" + + + admin: + image: mailu/admin:master + env_file: mailu.env + volumes: + - "/mailu/data:/data" + - "/mailu/dkim:/dkim" + depends_on: + - redis + + imap: + image: mailu/dovecot:master + env_file: mailu.env + volumes: + - "/mailu/mail:/mail" + - "/mailu/overrides:/overrides" + depends_on: + - front + + smtp: + image: mailu/postfix:master + env_file: mailu.env + volumes: + - "/mailu/overrides:/overrides" + depends_on: + - front + + # Optional services + + + + + # Webmail + diff --git a/tests/compose/fetchmail.yml b/tests/compose/fetchmail.yml new file mode 100644 index 00000000..8f40ba19 --- /dev/null +++ b/tests/compose/fetchmail.yml @@ -0,0 +1,77 @@ +# This file is auto-generated by the Mailu configuration wizard. +# Please read the documentation before attempting any change. +# Generated for compose flavor + +version: '3.6' + +services: + + # External dependencies + redis: + image: redis:alpine + volumes: + - "/mailu/redis:/data" + + # Core services + front: + image: mailu/nginx:master + env_file: mailu.env + ports: + - "127.0.0.1:80:80" + - "::1:80:80" + - "127.0.0.1:443:443" + - "::1:443:443" + - "127.0.0.1:25:25" + - "::1:25:25" + - "127.0.0.1:465:465" + - "::1:465:465" + - "127.0.0.1:587:587" + - "::1:587:587" + - "127.0.0.1:110:110" + - "::1:110:110" + - "127.0.0.1:995:995" + - "::1:995:995" + - "127.0.0.1:143:143" + - "::1:143:143" + - "127.0.0.1:993:993" + - "::1:993:993" + volumes: + - "/mailu/certs:/certs" + + + admin: + image: mailu/admin:master + env_file: mailu.env + volumes: + - "/mailu/data:/data" + - "/mailu/dkim:/dkim" + depends_on: + - redis + + imap: + image: mailu/dovecot:master + env_file: mailu.env + volumes: + - "/mailu/mail:/mail" + - "/mailu/overrides:/overrides" + depends_on: + - front + + smtp: + image: mailu/postfix:master + env_file: mailu.env + volumes: + - "/mailu/overrides:/overrides" + depends_on: + - front + + # Optional services + + + + fetchmail: + image: mailu/fetchmail:master + env_file: mailu.env + + # Webmail + diff --git a/tests/compose/filters+dns.yml b/tests/compose/filters+dns.yml new file mode 100644 index 00000000..993ed786 --- /dev/null +++ b/tests/compose/filters+dns.yml @@ -0,0 +1,119 @@ +# This file is auto-generated by the Mailu configuration wizard. +# Please read the documentation before attempting any change. +# Generated for compose flavor + +version: '3.6' + +services: + + # External dependencies + redis: + image: redis:alpine + volumes: + - "/mailu/redis:/data" + + # Core services + front: + image: mailu/nginx:master + env_file: mailu.env + ports: + - "127.0.0.1:80:80" + - "::1:80:80" + - "127.0.0.1:443:443" + - "::1:443:443" + - "127.0.0.1:25:25" + - "::1:25:25" + - "127.0.0.1:465:465" + - "::1:465:465" + - "127.0.0.1:587:587" + - "::1:587:587" + - "127.0.0.1:110:110" + - "::1:110:110" + - "127.0.0.1:995:995" + - "::1:995:995" + - "127.0.0.1:143:143" + - "::1:143:143" + - "127.0.0.1:993:993" + - "::1:993:993" + volumes: + - "/mailu/certs:/certs" + + resolver: + image: mailu/unbound:master + env_file: mailu.env + restart: always + networks: + default: + ipv4_address: 192.168.0.254 + + admin: + image: mailu/admin:master + env_file: mailu.env + volumes: + - "/mailu/data:/data" + - "/mailu/dkim:/dkim" + depends_on: + - redis + + imap: + image: mailu/dovecot:master + env_file: mailu.env + volumes: + - "/mailu/mail:/mail" + - "/mailu/overrides:/overrides" + depends_on: + - front + + smtp: + image: mailu/postfix:master + env_file: mailu.env + volumes: + - "/mailu/overrides:/overrides" + depends_on: + - front + - resolver + dns: + - 192.168.0.254 + + # Optional services + antispam: + image: mailu/rspamd:master + env_file: mailu.env + volumes: + - "/mailu/filter:/var/lib/rspamd" + - "/mailu/dkim:/dkim" + - "/mailu/overrides/rspamd:/etc/rspamd/override.d" + depends_on: + - front + - resolver + dns: + - 192.168.0.254 + + antivirus: + image: mailu/clamav:master + env_file: mailu.env + volumes: + - "/mailu/filter:/data" + depends_on: + - resolver + dns: + - 192.168.0.254 + + + + # Webmail + webmail: + image: mailu/rainloop:master + env_file: mailu.env + volumes: + - "/mailu/webmail:/data" + depends_on: + - imap + +networks: + default: + driver: bridge + ipam: + driver: default + config: + - subnet: 192.168.0.0/24 diff --git a/tests/compose/core.env b/tests/compose/mailu.env similarity index 72% rename from tests/compose/core.env rename to tests/compose/mailu.env index 78c307c0..74c87118 100644 --- a/tests/compose/core.env +++ b/tests/compose/mailu.env @@ -1,31 +1,38 @@ # Mailu main configuration file # -# Most configuration variables can be modified through the Web interface, -# these few settings must however be configured before starting the mail -# server and require a restart upon change. +# Generated for compose flavor +# +# This file is autogenerated by the configuration management wizard. +# For a detailed list of configuration variables, see the documentation at +# https://mailu.io ################################### # Common configuration variables ################################### # Set this to the path where Mailu data and configuration is stored -ROOT=/mailu +# This variable is now set directly in `docker-compose.yml by the setup utility +# ROOT=/mailu # Mailu version to run (1.0, 1.1, etc. or master) #VERSION=master # Set to a randomly generated 16 bytes string -SECRET_KEY=ChangeMeChangeMe +SECRET_KEY=1DS36JPBRGPM5JUC # Address where listening ports should bind -BIND_ADDRESS4=127.0.0.1 -#BIND_ADDRESS6=::1 +# This variables are now set directly in `docker-compose.yml by the setup utility +# PUBLIC_IPV4= 127.0.0.1 (default: 127.0.0.1) +# PUBLIC_IPV6= ::1 (default: ::1) + +# Subnet +SUBNET=192.168.0.0/24 # Main mail domain DOMAIN=mailu.io # Hostnames for this server, separated with comas -HOSTNAMES=mail.mailu.io,alternative.mailu.io,yetanother.mailu.io +HOSTNAMES=mail.mailu.io # Postmaster local part (will append the main mail domain) POSTMASTER=admin @@ -34,7 +41,7 @@ POSTMASTER=admin TLS_FLAVOR=cert # Authentication rate limit (per source IP address) -AUTH_RATELIMIT=10/minute;1000/hour +AUTH_RATELIMIT=10/minute;1000/hour # Opt-out of statistics, replace with "True" to opt out DISABLE_STATISTICS=False @@ -44,7 +51,7 @@ DISABLE_STATISTICS=False ################################### # Expose the admin interface (value: true, false) -ADMIN=false +ADMIN=true # Choose which webmail to run if any (values: roundcube, rainloop, none) WEBMAIL=none @@ -53,7 +60,10 @@ WEBMAIL=none WEBDAV=none # Antivirus solution (value: clamav, none) -ANTIVIRUS=none +#ANTIVIRUS=none + +#Antispam solution +ANTISPAM=none ################################### # Mail settings @@ -65,7 +75,7 @@ MESSAGE_SIZE_LIMIT=50000000 # Networks granted relay permissions, make sure that you include your Docker # internal network (default to 172.17.0.0/16) -RELAYNETS=172.16.0.0/12 +RELAYNETS=172.17.0.0/16 # Will relay all outgoing mails if configured RELAYHOST= @@ -74,18 +84,12 @@ RELAYHOST= FETCHMAIL_DELAY=600 # Recipient delimiter, character used to delimiter localpart from custom address part -# e.g. localpart+custom@domain;tld RECIPIENT_DELIMITER=+ # DMARC rua and ruf email DMARC_RUA=admin DMARC_RUF=admin -# Welcome email, enable and set a topic and body if you wish to send welcome -# emails to all users. -WELCOME=false -WELCOME_SUBJECT=Welcome to your new email account -WELCOME_BODY=Welcome to your new email account, if you can read this, then it is configured properly! # Maildir Compression # choose compression-method, default: none (value: bz2, gz) @@ -109,12 +113,7 @@ SITENAME=Mailu # Linked Website URL WEBSITE=https://mailu.io -# Registration reCaptcha settings (warning, this has some privacy impact) -# RECAPTCHA_PUBLIC_KEY= -# RECAPTCHA_PRIVATE_KEY= -# Domain registration, uncomment to enable -# DOMAIN_REGISTRATION=true ################################### # Advanced settings @@ -127,14 +126,17 @@ WEBSITE=https://mailu.io LOG_DRIVER=json-file # Docker-compose project name, this will prepended to containers names. -#COMPOSE_PROJECT_NAME=mailu +COMPOSE_PROJECT_NAME=mailu # Default password scheme used for newly created accounts and changed passwords -# (value: SHA512-CRYPT, SHA256-CRYPT, MD5-CRYPT, CRYPT) -PASSWORD_SCHEME=SHA512-CRYPT +# (value: BLF-CRYPT, SHA512-CRYPT, SHA256-CRYPT, MD5-CRYPT, CRYPT) +PASSWORD_SCHEME=BLF-CRYPT # Header to take the real ip from REAL_IP_HEADER= # IPs for nginx set_real_ip_from (CIDR list separated by commas) REAL_IP_FROM= + +# choose wether mailu bounces (no) or rejects (yes) mail when recipient is unknown (value: yes, no) +REJECT_UNLISTED_RECIPIENT= \ No newline at end of file diff --git a/tests/compose/rainloop.yml b/tests/compose/rainloop.yml new file mode 100644 index 00000000..29011eeb --- /dev/null +++ b/tests/compose/rainloop.yml @@ -0,0 +1,84 @@ +# This file is auto-generated by the Mailu configuration wizard. +# Please read the documentation before attempting any change. +# Generated for compose flavor + +version: '3.6' + +services: + + # External dependencies + redis: + image: redis:alpine + volumes: + - "/mailu/redis:/data" + + # Core services + front: + image: mailu/nginx:master + env_file: mailu.env + ports: + - "127.0.0.1:80:80" + - "::1:80:80" + - "127.0.0.1:443:443" + - "::1:443:443" + - "127.0.0.1:25:25" + - "::1:25:25" + - "127.0.0.1:465:465" + - "::1:465:465" + - "127.0.0.1:587:587" + - "::1:587:587" + - "127.0.0.1:110:110" + - "::1:110:110" + - "127.0.0.1:995:995" + - "::1:995:995" + - "127.0.0.1:143:143" + - "::1:143:143" + - "127.0.0.1:993:993" + - "::1:993:993" + volumes: + - "/mailu/certs:/certs" + + + admin: + image: mailu/admin:master + env_file: mailu.env + volumes: + - "/mailu/data:/data" + - "/mailu/dkim:/dkim" + depends_on: + - redis + + imap: + image: mailu/dovecot:master + env_file: mailu.env + volumes: + - "/mailu/mail:/mail" + - "/mailu/overrides:/overrides" + depends_on: + - front + + smtp: + image: mailu/postfix:master + env_file: mailu.env + volumes: + - "/mailu/overrides:/overrides" + depends_on: + - front + + # Optional services + + + + + # Webmail + webmail: + image: mailu/rainloop:master + env_file: mailu.env + volumes: + - "/mailu/webmail:/data" + depends_on: + - imap + - resolver + dns: + - 192.168.0.254 + diff --git a/tests/compose/roundcube.yml b/tests/compose/roundcube.yml new file mode 100644 index 00000000..c6e46ed9 --- /dev/null +++ b/tests/compose/roundcube.yml @@ -0,0 +1,84 @@ +# This file is auto-generated by the Mailu configuration wizard. +# Please read the documentation before attempting any change. +# Generated for compose flavor + +version: '3.6' + +services: + + # External dependencies + redis: + image: redis:alpine + volumes: + - "/mailu/redis:/data" + + # Core services + front: + image: mailu/nginx:master + env_file: mailu.env + ports: + - "127.0.0.1:80:80" + - "::1:80:80" + - "127.0.0.1:443:443" + - "::1:443:443" + - "127.0.0.1:25:25" + - "::1:25:25" + - "127.0.0.1:465:465" + - "::1:465:465" + - "127.0.0.1:587:587" + - "::1:587:587" + - "127.0.0.1:110:110" + - "::1:110:110" + - "127.0.0.1:995:995" + - "::1:995:995" + - "127.0.0.1:143:143" + - "::1:143:143" + - "127.0.0.1:993:993" + - "::1:993:993" + volumes: + - "/mailu/certs:/certs" + + + admin: + image: mailu/admin:master + env_file: mailu.env + volumes: + - "/mailu/data:/data" + - "/mailu/dkim:/dkim" + depends_on: + - redis + + imap: + image: mailu/dovecot:master + env_file: mailu.env + volumes: + - "/mailu/mail:/mail" + - "/mailu/overrides:/overrides" + depends_on: + - front + + smtp: + image: mailu/postfix:master + env_file: mailu.env + volumes: + - "/mailu/overrides:/overrides" + depends_on: + - front + + # Optional services + + + + + # Webmail + webmail: + image: mailu/roundcube:master + env_file: mailu.env + volumes: + - "/mailu/webmail:/data" + depends_on: + - imap + - resolver + dns: + - 192.168.0.254 + diff --git a/tests/compose/run.yml b/tests/compose/run.yml deleted file mode 100644 index eac35b76..00000000 --- a/tests/compose/run.yml +++ /dev/null @@ -1,101 +0,0 @@ -version: '2' - -services: - - front: - image: $DOCKER_ORG/nginx:$VERSION - restart: 'no' - env_file: $PWD/.env - logging: - driver: $LOG_DRIVER - ports: - - "$BIND_ADDRESS4:80:80" - - "$BIND_ADDRESS4:443:443" - - "$BIND_ADDRESS4:110:110" - - "$BIND_ADDRESS4:143:143" - - "$BIND_ADDRESS4:993:993" - - "$BIND_ADDRESS4:995:995" - - "$BIND_ADDRESS4:25:25" - - "$BIND_ADDRESS4:465:465" - - "$BIND_ADDRESS4:587:587" - volumes: - - "$ROOT/certs:/certs" - - redis: - image: redis:alpine - restart: 'no' - volumes: - - "$ROOT/redis:/data" - - imap: - image: $DOCKER_ORG/dovecot:$VERSION - restart: 'no' - env_file: $PWD/.env - volumes: - - "$ROOT/data:/data" - - "$ROOT/mail:/mail" - - "$ROOT/overrides:/overrides" - depends_on: - - front - - smtp: - image: $DOCKER_ORG/postfix:$VERSION - restart: 'no' - env_file: $PWD/.env - volumes: - - "$ROOT/data:/data" - - "$ROOT/overrides:/overrides" - depends_on: - - front - - antispam: - image: $DOCKER_ORG/rspamd:$VERSION - restart: 'no' - env_file: $PWD/.env - volumes: - - "$ROOT/filter:/var/lib/rspamd" - - "$ROOT/dkim:/dkim" - - "$ROOT/overrides/rspamd:/etc/rspamd/override.d" - depends_on: - - front - - antivirus: - image: $DOCKER_ORG/$ANTIVIRUS:$VERSION - restart: 'no' - env_file: $PWD/.env - volumes: - - "$ROOT/filter:/data" - - webdav: - image: $DOCKER_ORG/$WEBDAV:$VERSION - restart: 'no' - env_file: $PWD/.env - volumes: - - "$ROOT/dav:/data" - - admin: - image: $DOCKER_ORG/admin:$VERSION - restart: 'no' - env_file: $PWD/.env - volumes: - - "$ROOT/data:/data" - - "$ROOT/dkim:/dkim" - - /var/run/docker.sock:/var/run/docker.sock:ro - depends_on: - - redis - - webmail: - image: "$DOCKER_ORG/$WEBMAIL:$VERSION" - restart: 'no' - env_file: $PWD/.env - volumes: - - "$ROOT/webmail:/data" - depends_on: - - imap - - fetchmail: - image: $DOCKER_ORG/fetchmail:$VERSION - restart: 'no' - env_file: $PWD/.env - volumes: - - "$ROOT/data:/data" diff --git a/tests/compose/webdav.yml b/tests/compose/webdav.yml new file mode 100644 index 00000000..b4d222ef --- /dev/null +++ b/tests/compose/webdav.yml @@ -0,0 +1,79 @@ +# This file is auto-generated by the Mailu configuration wizard. +# Please read the documentation before attempting any change. +# Generated for compose flavor + +version: '3.6' + +services: + + # External dependencies + redis: + image: redis:alpine + volumes: + - "/mailu/redis:/data" + + # Core services + front: + image: mailu/nginx:master + env_file: mailu.env + ports: + - "127.0.0.1:80:80" + - "::1:80:80" + - "127.0.0.1:443:443" + - "::1:443:443" + - "127.0.0.1:25:25" + - "::1:25:25" + - "127.0.0.1:465:465" + - "::1:465:465" + - "127.0.0.1:587:587" + - "::1:587:587" + - "127.0.0.1:110:110" + - "::1:110:110" + - "127.0.0.1:995:995" + - "::1:995:995" + - "127.0.0.1:143:143" + - "::1:143:143" + - "127.0.0.1:993:993" + - "::1:993:993" + volumes: + - "/mailu/certs:/certs" + + + admin: + image: mailu/admin:master + env_file: mailu.env + volumes: + - "/mailu/data:/data" + - "/mailu/dkim:/dkim" + depends_on: + - redis + + imap: + image: mailu/dovecot:master + env_file: mailu.env + volumes: + - "/mailu/mail:/mail" + - "/mailu/overrides:/overrides" + depends_on: + - front + + smtp: + image: mailu/postfix:master + env_file: mailu.env + volumes: + - "/mailu/overrides:/overrides" + depends_on: + - front + + # Optional services + + + webdav: + image: mailu/radicale:master + env_file: mailu.env + volumes: + - "/mailu/dav:/data" + + + # Webmail + From 3b1fdc6166a3505e7c516d0f99b210dc5ab066f9 Mon Sep 17 00:00:00 2001 From: Ionut Filip Date: Thu, 25 Oct 2018 15:27:09 +0300 Subject: [PATCH 07/28] Migrate test script from shell to python - test.py needs to be called with 2 arguments : test_name and timeout - it will cd to test_name dir and use the test_name.yml from there - it will sleep for an amount of time equals to timeout in minutes - it will perform health checks for containers. If healtcheck isn't enabled will check for running state - it will run hooks inside the test_name dir ( .py and .sh) if there are any - printing logs in any case --- .travis.yml | 7 +- tests/compose/{ => core}/core.yml | 10 +- tests/compose/{ => fetchmail}/fetchmail.yml | 0 .../compose/{ => filters+dns}/filters+dns.yml | 0 tests/compose/{ => rainloop}/rainloop.yml | 0 tests/compose/{ => roundcube}/roundcube.yml | 0 tests/compose/test.py | 92 +++++++++++++++++++ tests/compose/{ => webdav}/webdav.yml | 0 tests/requirements.txt | 2 + 9 files changed, 109 insertions(+), 2 deletions(-) rename tests/compose/{ => core}/core.yml (85%) rename tests/compose/{ => fetchmail}/fetchmail.yml (100%) rename tests/compose/{ => filters+dns}/filters+dns.yml (100%) rename tests/compose/{ => rainloop}/rainloop.yml (100%) rename tests/compose/{ => roundcube}/roundcube.yml (100%) create mode 100755 tests/compose/test.py rename tests/compose/{ => webdav}/webdav.yml (100%) create mode 100644 tests/requirements.txt diff --git a/.travis.yml b/.travis.yml index c3a19529..107696aa 100644 --- a/.travis.yml +++ b/.travis.yml @@ -6,12 +6,17 @@ addons: - docker-ce env: - VERSION=$TRAVIS_BRANCH +language: python +python: + - "3.6" +install: + - pip install -r tests/requirements.txt script: # Default to mailu for DOCKER_ORG - if [ -z "$DOCKER_ORG" ]; then export DOCKER_ORG="mailu"; fi - docker-compose -f tests/build.yml build - - tests/compose/test-script.sh + - python tests/compose/test.py deploy: provider: script diff --git a/tests/compose/core.yml b/tests/compose/core/core.yml similarity index 85% rename from tests/compose/core.yml rename to tests/compose/core/core.yml index 460a6908..d85388a4 100644 --- a/tests/compose/core.yml +++ b/tests/compose/core/core.yml @@ -66,7 +66,15 @@ services: - front # Optional services - + antispam: + image: mailu/rspamd:master + env_file: mailu.env + volumes: + - "/mailu/filter:/var/lib/rspamd" + - "/mailu/dkim:/dkim" + - "/mailu/overrides/rspamd:/etc/rspamd/override.d" + depends_on: + - front diff --git a/tests/compose/fetchmail.yml b/tests/compose/fetchmail/fetchmail.yml similarity index 100% rename from tests/compose/fetchmail.yml rename to tests/compose/fetchmail/fetchmail.yml diff --git a/tests/compose/filters+dns.yml b/tests/compose/filters+dns/filters+dns.yml similarity index 100% rename from tests/compose/filters+dns.yml rename to tests/compose/filters+dns/filters+dns.yml diff --git a/tests/compose/rainloop.yml b/tests/compose/rainloop/rainloop.yml similarity index 100% rename from tests/compose/rainloop.yml rename to tests/compose/rainloop/rainloop.yml diff --git a/tests/compose/roundcube.yml b/tests/compose/roundcube/roundcube.yml similarity index 100% rename from tests/compose/roundcube.yml rename to tests/compose/roundcube/roundcube.yml diff --git a/tests/compose/test.py b/tests/compose/test.py new file mode 100755 index 00000000..95670e30 --- /dev/null +++ b/tests/compose/test.py @@ -0,0 +1,92 @@ +import sys +import os +import time +import docker +from colorama import Fore, Style + +# Declare variables for service name and sleep time +test_name=sys.argv[1] +timeout=int(sys.argv[2]) + +client = docker.APIClient(base_url='unix://var/run/docker.sock') + +containers = [] + +# Start up containers +def start(): + os.system("cp mailu.env " + test_name + "/") + os.system("docker-compose -f " + test_name + "/" + test_name + ".yml -p $DOCKER_ORG up -d ") + +# Stop containers +def stop(exit_code): + print_logs() + os.system("docker-compose -f " + test_name + "/" + test_name + ".yml -p $DOCKER_ORG down") + os.system("rm " + test_name +"/mailu.env") + sys.exit(exit_code) + +# Sleep for a defined amount of time +def sleep(): + print(Fore.LIGHTMAGENTA_EX + "Sleeping for " + str(timeout) + "m" + Style.RESET_ALL) + time.sleep(timeout*60) + +def health_checks(): + exit_code = 0 + #Iterating trough all containers dictionary + for container in client.containers(all=True): + #Perform "docker container inspect" on container based on container ID and save output to a dictionary + container_inspect = client.inspect_container(container['Id']) #Dict + + if "Health" in container_inspect['State'].keys(): + if container_inspect['State']['Health']['Status'] == "healthy": + print(Fore.GREEN + "Health status for " + container_inspect['Name'].replace("/", "") + " : " + Fore.CYAN + container_inspect['State']['Health']['Status'] + Style.RESET_ALL) + if container_inspect['State']['Health']['Status'] != "healthy": + print(Fore.RED + "Container " + container_inspect['Name'].replace("/", "") + " is " + Fore.YELLOW + container_inspect['State']['Health']['Status'] + + Fore.RED + ", FailingStreak: " + Fore.YELLOW + str(container_inspect['State']['Health']['FailingStreak']) + + Fore.RED + ", Log: " + Fore.YELLOW + str(container_inspect['State']['Health']['Log']) + Style.RESET_ALL) + exit_code = 1 + else: + if container_inspect['State']['Status'] == "running": + print(Fore.GREEN + "Running status for " + container_inspect['Name'].replace("/", "") + " : " + Fore.BLUE + container_inspect['State']['Status'] + Style.RESET_ALL) + if container_inspect['State']['Status'] != "running": + print(Fore.RED + "Container " + container_inspect['Name'].replace("/", "") + " state is: " + Fore.YELLOW + container_inspect['State']['Status'] + Style.RESET_ALL) + exit_code = 1 + + #Saving Id, Name and state to a new dictionary + containers_dict = {} + containers_dict['Name'] = container_inspect['Name'].replace("/", "") + containers_dict['Id'] = container_inspect['Id'] + containers_dict['State'] = container_inspect['State'] + + #Adding the generated dictionary to a list + containers.append(containers_dict) + + if exit_code != 0: + stop(exit_code) + +def print_logs(): + print("Printing logs ...") + #Iterating through docker container inspect list and print logs + for container in containers: + print(Fore.LIGHTMAGENTA_EX + "Printing logs for: " + Fore.GREEN + container['Name'] + Style.RESET_ALL) + os.system('docker container logs ' + container['Name']) + +#Iterating over hooks in test folder and running them +def hooks(): + print("Running hooks") + for test_file in sorted(os.listdir(test_name + "/")): + if test_file.endswith(".py"): + os.system("python3 " + test_name + "/" + test_file) + elif test_file.endswith(".sh"): + os.system("./" + test_name + "/" + test_file) + +start() +print() +sleep() +print() +os.system("docker ps -a") +print() +health_checks() +print() +hooks() +print() +stop(0) diff --git a/tests/compose/webdav.yml b/tests/compose/webdav/webdav.yml similarity index 100% rename from tests/compose/webdav.yml rename to tests/compose/webdav/webdav.yml diff --git a/tests/requirements.txt b/tests/requirements.txt new file mode 100644 index 00000000..36006cfc --- /dev/null +++ b/tests/requirements.txt @@ -0,0 +1,2 @@ +docker +colorama From 72e931f4b470b74f2546ffa0483a88208987b7d1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim=20M=C3=B6hlmann?= Date: Thu, 25 Oct 2018 16:35:08 +0300 Subject: [PATCH 08/28] Modify setup templates to allow for DOCKER_ORG and VERSION override. (Needed for Travis) --- .travis.yml | 7 +++---- setup/flavors/compose/docker-compose.yml | 18 ++++++++-------- setup/flavors/stack/docker-compose.yml | 18 ++++++++-------- tests/build.yml | 26 ++++++++++++------------ 4 files changed, 34 insertions(+), 35 deletions(-) diff --git a/.travis.yml b/.travis.yml index 107696aa..bae6d04f 100644 --- a/.travis.yml +++ b/.travis.yml @@ -5,7 +5,7 @@ addons: packages: - docker-ce env: - - VERSION=$TRAVIS_BRANCH + - MAILU_VERSION=$TRAVIS_BRANCH language: python python: - "3.6" @@ -13,10 +13,9 @@ install: - pip install -r tests/requirements.txt script: - # Default to mailu for DOCKER_ORG - - if [ -z "$DOCKER_ORG" ]; then export DOCKER_ORG="mailu"; fi - docker-compose -f tests/build.yml build - - python tests/compose/test.py +# test.py, test name and timeout between start and tests. + - python tests/compose/test.py core 1 deploy: provider: script diff --git a/setup/flavors/compose/docker-compose.yml b/setup/flavors/compose/docker-compose.yml index daea844e..14eeba3c 100644 --- a/setup/flavors/compose/docker-compose.yml +++ b/setup/flavors/compose/docker-compose.yml @@ -16,7 +16,7 @@ services: # Core services front: - image: mailu/nginx:{{ version }} + image: ${DOCKER_ORG:-mailu}/nginx:${MAILU_VERSION:-{{ version }}} restart: always env_file: {{ env }} logging: @@ -34,7 +34,7 @@ services: - "{{ root }}/certs:/certs" admin: - image: mailu/admin:{{ version }} + image: ${DOCKER_ORG:-mailu}/admin:${MAILU_VERSION:-{{ version }}} restart: always env_file: {{ env }} {% if not admin_enabled %} @@ -48,7 +48,7 @@ services: - redis imap: - image: mailu/dovecot:{{ version }} + image: ${DOCKER_ORG:-mailu}/dovecot:${MAILU_VERSION:-{{ version }}} restart: always env_file: {{ env }} volumes: @@ -58,7 +58,7 @@ services: - front smtp: - image: mailu/postfix:{{ version }} + image: ${DOCKER_ORG:-mailu}/postfix:${MAILU_VERSION:-{{ version }}} restart: always env_file: {{ env }} volumes: @@ -69,7 +69,7 @@ services: # Optional services {% if antispam_enabled %} antispam: - image: mailu/rspamd:{{ version }} + image: ${DOCKER_ORG:-mailu}/rspamd:${MAILU_VERSION:-{{ version }}} restart: always env_file: {{ env }} volumes: @@ -82,7 +82,7 @@ services: {% if antivirus_enabled %} antivirus: - image: mailu/clamav:{{ version }} + image: ${DOCKER_ORG:-mailu}/clamav:${MAILU_VERSION:-{{ version }}} restart: always env_file: {{ env }} volumes: @@ -91,7 +91,7 @@ services: {% if webdav_enabled %} webdav: - image: mailu/radicale:{{ version }} + image: ${DOCKER_ORG:-mailu}/radicale:${MAILU_VERSION:-{{ version }}} restart: always env_file: {{ env }} volumes: @@ -100,7 +100,7 @@ services: {% if fetchmail_enabled %} fetchmail: - image: mailu/fetchmail:{{ version }} + image: ${DOCKER_ORG:-mailu}/fetchmail:${MAILU_VERSION:-{{ version }}} restart: always env_file: {{ env }} {% endif %} @@ -108,7 +108,7 @@ services: # Webmail {% if webmail_type != 'none' %} webmail: - image: mailu/{{ webmail_type }}:{{ version }} + image: ${DOCKER_ORG:-mailu}/{{ webmail_type }}:${MAILU_VERSION:-{{ version }}} restart: always env_file: {{ env }} volumes: diff --git a/setup/flavors/stack/docker-compose.yml b/setup/flavors/stack/docker-compose.yml index 728135d5..92a156c7 100644 --- a/setup/flavors/stack/docker-compose.yml +++ b/setup/flavors/stack/docker-compose.yml @@ -15,7 +15,7 @@ services: # Core services front: - image: mailu/nginx:{{ version }} + image: ${DOCKER_ORG:-mailu}/nginx:${MAILU_VERSION:-{{ version }}} env_file: {{ env }} logging: driver: {{ log_driver or 'json-file' }} @@ -31,7 +31,7 @@ services: replicas: {{ front_replicas }} admin: - image: mailu/admin:{{ version }} + image: ${DOCKER_ORG:-mailu}/admin:${MAILU_VERSION:-{{ version }}} env_file: {{ env }} {% if not admin_enabled %} ports: @@ -44,7 +44,7 @@ services: replicas: {{ admin_replicas }} imap: - image: mailu/dovecot:{{ version }} + image: ${DOCKER_ORG:-mailu}/dovecot:${MAILU_VERSION:-{{ version }}} env_file: {{ env }} environment: # Default to 10.0.1.0/24 @@ -56,7 +56,7 @@ services: replicas: {{ imap_replicas }} smtp: - image: mailu/postfix:{{ version }} + image: ${DOCKER_ORG:-mailu}/postfix:${MAILU_VERSION:-{{ version }}} env_file: {{ env }} environment: - POD_ADDRESS_RANGE={{ subnet }} @@ -68,7 +68,7 @@ services: # Optional services {% if antispam_enabled %} antispam: - image: mailu/rspamd:{{ version }} + image: ${DOCKER_ORG:-mailu}/rspamd:${MAILU_VERSION:-{{ version }}} env_file: {{ env }} environment: - POD_ADDRESS_RANGE={{ subnet }} @@ -82,7 +82,7 @@ services: {% if antivirus_enabled %} antivirus: - image: mailu/clamav:{{ version }} + image: ${DOCKER_ORG:-mailu}/clamav:${MAILU_VERSION:-{{ version }}} env_file: {{ env }} volumes: - "{{ root }}/filter:/data" @@ -92,7 +92,7 @@ services: {% if webdav_enabled %} webdav: - image: mailu/none:{{ version }} + image: ${DOCKER_ORG:-mailu}/none:${MAILU_VERSION:-{{ version }}} env_file: {{ env }} volumes: - "{{ root }}/dav:/data" @@ -102,7 +102,7 @@ services: {% if fetchmail_enabled %} fetchmail: - image: mailu/fetchmail:{{ version }} + image: ${DOCKER_ORG:-mailu}/fetchmail:${MAILU_VERSION:-{{ version }}} env_file: {{ env }} volumes: - "{{ root }}/data:/data" @@ -112,7 +112,7 @@ services: {% if webmail_type != 'none' %} webmail: - image: mailu/roundcube:{{ version }} + image: ${DOCKER_ORG:-mailu}/roundcube:${MAILU_VERSION:-{{ version }}} env_file: {{ env }} volumes: - "{{ root }}/webmail:/data" diff --git a/tests/build.yml b/tests/build.yml index 5f360ece..dc259608 100644 --- a/tests/build.yml +++ b/tests/build.yml @@ -3,54 +3,54 @@ version: '3' services: front: - image: ${DOCKER_ORG:-mailu}/nginx:${VERSION:-local} + image: ${DOCKER_ORG:-mailu}/nginx:${MAILU_VERSION:-local} build: ../core/nginx imap: - image: ${DOCKER_ORG:-mailu}/dovecot:${VERSION:-local} + image: ${DOCKER_ORG:-mailu}/dovecot:${MAILU_VERSION:-local} build: ../core/dovecot smtp: - image: ${DOCKER_ORG:-mailu}/postfix:${VERSION:-local} + image: ${DOCKER_ORG:-mailu}/postfix:${MAILU_VERSION:-local} build: ../core/postfix antispam: - image: ${DOCKER_ORG:-mailu}/rspamd:${VERSION:-local} + image: ${DOCKER_ORG:-mailu}/rspamd:${MAILU_VERSION:-local} build: ../services/rspamd antivirus: - image: ${DOCKER_ORG:-mailu}/clamav:${VERSION:-local} + image: ${DOCKER_ORG:-mailu}/clamav:${MAILU_VERSION:-local} build: ../optional/clamav webdav: - image: ${DOCKER_ORG:-mailu}/radicale:${VERSION:-local} + image: ${DOCKER_ORG:-mailu}/radicale:${MAILU_VERSION:-local} build: ../optional/radicale admin: - image: ${DOCKER_ORG:-mailu}/admin:${VERSION:-local} + image: ${DOCKER_ORG:-mailu}/admin:${MAILU_VERSION:-local} build: ../core/admin roundcube: - image: ${DOCKER_ORG:-mailu}/roundcube:${VERSION:-local} + image: ${DOCKER_ORG:-mailu}/roundcube:${MAILU_VERSION:-local} build: ../webmails/roundcube rainloop: - image: ${DOCKER_ORG:-mailu}/rainloop:${VERSION:-local} + image: ${DOCKER_ORG:-mailu}/rainloop:${MAILU_VERSION:-local} build: ../webmails/rainloop fetchmail: - image: ${DOCKER_ORG:-mailu}/fetchmail:${VERSION:-local} + image: ${DOCKER_ORG:-mailu}/fetchmail:${MAILU_VERSION:-local} build: ../services/fetchmail none: - image: ${DOCKER_ORG:-mailu}/none:${VERSION:-local} + image: ${DOCKER_ORG:-mailu}/none:${MAILU_VERSION:-local} build: ../core/none docs: - image: ${DOCKER_ORG:-mailu}/docs:${VERSION:-local} + image: ${DOCKER_ORG:-mailu}/docs:${MAILU_VERSION:-local} build: ../docs setup: - image: ${DOCKER_ORG:-mailu}/setup:${VERSION:-local} + image: ${DOCKER_ORG:-mailu}/setup:${MAILU_VERSION:-local} build: ../setup From dde7ccca97a72c20143f0cfb76a54077aab675f2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim=20M=C3=B6hlmann?= Date: Thu, 25 Oct 2018 17:35:53 +0300 Subject: [PATCH 09/28] Created test cases from latest setup revision --- .travis.yml | 9 +- .../core/{core.yml => docker-compose.yml} | 23 ++- tests/compose/{ => core}/mailu.env | 9 +- .../docker-compose.yml} | 43 +++--- tests/compose/fetchmail/fetchmail.yml | 77 ---------- tests/compose/fetchmail/mailu.env | 139 ++++++++++++++++++ tests/compose/filters/docker-compose.yml | 95 ++++++++++++ tests/compose/filters/mailu.env | 139 ++++++++++++++++++ .../docker-compose.yml} | 54 ++----- tests/compose/rainloop/mailu.env | 139 ++++++++++++++++++ .../{roundcube.yml => docker-compose.yml} | 35 +++-- tests/compose/roundcube/mailu.env | 139 ++++++++++++++++++ tests/compose/test-script.sh | 57 ------- tests/compose/test.py | 12 +- .../webdav/{webdav.yml => docker-compose.yml} | 32 +++- tests/compose/webdav/mailu.env | 139 ++++++++++++++++++ 16 files changed, 910 insertions(+), 231 deletions(-) rename tests/compose/core/{core.yml => docker-compose.yml} (75%) rename tests/compose/{ => core}/mailu.env (96%) rename tests/compose/{rainloop/rainloop.yml => fetchmail/docker-compose.yml} (63%) delete mode 100644 tests/compose/fetchmail/fetchmail.yml create mode 100644 tests/compose/fetchmail/mailu.env create mode 100644 tests/compose/filters/docker-compose.yml create mode 100644 tests/compose/filters/mailu.env rename tests/compose/{filters+dns/filters+dns.yml => rainloop/docker-compose.yml} (68%) create mode 100644 tests/compose/rainloop/mailu.env rename tests/compose/roundcube/{roundcube.yml => docker-compose.yml} (64%) create mode 100644 tests/compose/roundcube/mailu.env delete mode 100755 tests/compose/test-script.sh rename tests/compose/webdav/{webdav.yml => docker-compose.yml} (63%) create mode 100644 tests/compose/webdav/mailu.env diff --git a/.travis.yml b/.travis.yml index bae6d04f..b1eb2d10 100644 --- a/.travis.yml +++ b/.travis.yml @@ -12,10 +12,17 @@ python: install: - pip install -r tests/requirements.txt -script: +before_script: - docker-compose -f tests/build.yml build + +script: # test.py, test name and timeout between start and tests. - python tests/compose/test.py core 1 + - python tests/compose/test.py fetchmail 1 + - travis_wait python tests/compose/test.py filters 10 + - python tests/compose/test.py rainloop 1 + - python tests/compose/test.py roundcube 1 + - python tests/compose/test.py webdav 1 deploy: provider: script diff --git a/tests/compose/core/core.yml b/tests/compose/core/docker-compose.yml similarity index 75% rename from tests/compose/core/core.yml rename to tests/compose/core/docker-compose.yml index d85388a4..47c5f179 100644 --- a/tests/compose/core/core.yml +++ b/tests/compose/core/docker-compose.yml @@ -9,13 +9,17 @@ services: # External dependencies redis: image: redis:alpine + restart: always volumes: - "/mailu/redis:/data" # Core services front: - image: mailu/nginx:master + image: ${DOCKER_ORG:-mailu}/nginx:${MAILU_VERSION:-master} + restart: always env_file: mailu.env + logging: + driver: json-file ports: - "127.0.0.1:80:80" - "::1:80:80" @@ -37,10 +41,10 @@ services: - "::1:993:993" volumes: - "/mailu/certs:/certs" - admin: - image: mailu/admin:master + image: ${DOCKER_ORG:-mailu}/admin:${MAILU_VERSION:-master} + restart: always env_file: mailu.env volumes: - "/mailu/data:/data" @@ -49,7 +53,8 @@ services: - redis imap: - image: mailu/dovecot:master + image: ${DOCKER_ORG:-mailu}/dovecot:${MAILU_VERSION:-master} + restart: always env_file: mailu.env volumes: - "/mailu/mail:/mail" @@ -58,16 +63,17 @@ services: - front smtp: - image: mailu/postfix:master + image: ${DOCKER_ORG:-mailu}/postfix:${MAILU_VERSION:-master} + restart: always env_file: mailu.env volumes: - "/mailu/overrides:/overrides" depends_on: - front - # Optional services antispam: - image: mailu/rspamd:master + image: ${DOCKER_ORG:-mailu}/rspamd:${MAILU_VERSION:-master} + restart: always env_file: mailu.env volumes: - "/mailu/filter:/var/lib/rspamd" @@ -76,7 +82,8 @@ services: depends_on: - front + # Optional services + # Webmail - diff --git a/tests/compose/mailu.env b/tests/compose/core/mailu.env similarity index 96% rename from tests/compose/mailu.env rename to tests/compose/core/mailu.env index 74c87118..b243adcc 100644 --- a/tests/compose/mailu.env +++ b/tests/compose/core/mailu.env @@ -18,16 +18,13 @@ #VERSION=master # Set to a randomly generated 16 bytes string -SECRET_KEY=1DS36JPBRGPM5JUC +SECRET_KEY=DY8PPWQXCFV84N4K # Address where listening ports should bind # This variables are now set directly in `docker-compose.yml by the setup utility # PUBLIC_IPV4= 127.0.0.1 (default: 127.0.0.1) # PUBLIC_IPV6= ::1 (default: ::1) -# Subnet -SUBNET=192.168.0.0/24 - # Main mail domain DOMAIN=mailu.io @@ -38,7 +35,7 @@ HOSTNAMES=mail.mailu.io POSTMASTER=admin # Choose how secure connections will behave (value: letsencrypt, cert, notls, mail, mail-letsencrypt) -TLS_FLAVOR=cert +TLS_FLAVOR=letsencrypt # Authentication rate limit (per source IP address) AUTH_RATELIMIT=10/minute;1000/hour @@ -123,7 +120,7 @@ WEBSITE=https://mailu.io # json-file (default) # journald (On systemd platforms, useful for Fail2Ban integration) # syslog (Non systemd platforms, Fail2Ban integration. Disables `docker-compose log` for front!) -LOG_DRIVER=json-file +# LOG_DRIVER=json-file # Docker-compose project name, this will prepended to containers names. COMPOSE_PROJECT_NAME=mailu diff --git a/tests/compose/rainloop/rainloop.yml b/tests/compose/fetchmail/docker-compose.yml similarity index 63% rename from tests/compose/rainloop/rainloop.yml rename to tests/compose/fetchmail/docker-compose.yml index 29011eeb..6612dc25 100644 --- a/tests/compose/rainloop/rainloop.yml +++ b/tests/compose/fetchmail/docker-compose.yml @@ -9,13 +9,17 @@ services: # External dependencies redis: image: redis:alpine + restart: always volumes: - "/mailu/redis:/data" # Core services front: - image: mailu/nginx:master + image: ${DOCKER_ORG:-mailu}/nginx:${MAILU_VERSION:-master} + restart: always env_file: mailu.env + logging: + driver: json-file ports: - "127.0.0.1:80:80" - "::1:80:80" @@ -37,10 +41,10 @@ services: - "::1:993:993" volumes: - "/mailu/certs:/certs" - admin: - image: mailu/admin:master + image: ${DOCKER_ORG:-mailu}/admin:${MAILU_VERSION:-master} + restart: always env_file: mailu.env volumes: - "/mailu/data:/data" @@ -49,7 +53,8 @@ services: - redis imap: - image: mailu/dovecot:master + image: ${DOCKER_ORG:-mailu}/dovecot:${MAILU_VERSION:-master} + restart: always env_file: mailu.env volumes: - "/mailu/mail:/mail" @@ -58,27 +63,31 @@ services: - front smtp: - image: mailu/postfix:master + image: ${DOCKER_ORG:-mailu}/postfix:${MAILU_VERSION:-master} + restart: always env_file: mailu.env volumes: - "/mailu/overrides:/overrides" depends_on: - front + antispam: + image: ${DOCKER_ORG:-mailu}/rspamd:${MAILU_VERSION:-master} + restart: always + env_file: mailu.env + volumes: + - "/mailu/filter:/var/lib/rspamd" + - "/mailu/dkim:/dkim" + - "/mailu/overrides/rspamd:/etc/rspamd/override.d" + depends_on: + - front + # Optional services - + fetchmail: + image: ${DOCKER_ORG:-mailu}/fetchmail:${MAILU_VERSION:-master} + restart: always + env_file: mailu.env # Webmail - webmail: - image: mailu/rainloop:master - env_file: mailu.env - volumes: - - "/mailu/webmail:/data" - depends_on: - - imap - - resolver - dns: - - 192.168.0.254 - diff --git a/tests/compose/fetchmail/fetchmail.yml b/tests/compose/fetchmail/fetchmail.yml deleted file mode 100644 index 8f40ba19..00000000 --- a/tests/compose/fetchmail/fetchmail.yml +++ /dev/null @@ -1,77 +0,0 @@ -# This file is auto-generated by the Mailu configuration wizard. -# Please read the documentation before attempting any change. -# Generated for compose flavor - -version: '3.6' - -services: - - # External dependencies - redis: - image: redis:alpine - volumes: - - "/mailu/redis:/data" - - # Core services - front: - image: mailu/nginx:master - env_file: mailu.env - ports: - - "127.0.0.1:80:80" - - "::1:80:80" - - "127.0.0.1:443:443" - - "::1:443:443" - - "127.0.0.1:25:25" - - "::1:25:25" - - "127.0.0.1:465:465" - - "::1:465:465" - - "127.0.0.1:587:587" - - "::1:587:587" - - "127.0.0.1:110:110" - - "::1:110:110" - - "127.0.0.1:995:995" - - "::1:995:995" - - "127.0.0.1:143:143" - - "::1:143:143" - - "127.0.0.1:993:993" - - "::1:993:993" - volumes: - - "/mailu/certs:/certs" - - - admin: - image: mailu/admin:master - env_file: mailu.env - volumes: - - "/mailu/data:/data" - - "/mailu/dkim:/dkim" - depends_on: - - redis - - imap: - image: mailu/dovecot:master - env_file: mailu.env - volumes: - - "/mailu/mail:/mail" - - "/mailu/overrides:/overrides" - depends_on: - - front - - smtp: - image: mailu/postfix:master - env_file: mailu.env - volumes: - - "/mailu/overrides:/overrides" - depends_on: - - front - - # Optional services - - - - fetchmail: - image: mailu/fetchmail:master - env_file: mailu.env - - # Webmail - diff --git a/tests/compose/fetchmail/mailu.env b/tests/compose/fetchmail/mailu.env new file mode 100644 index 00000000..4cea36f7 --- /dev/null +++ b/tests/compose/fetchmail/mailu.env @@ -0,0 +1,139 @@ +# Mailu main configuration file +# +# Generated for compose flavor +# +# This file is autogenerated by the configuration management wizard. +# For a detailed list of configuration variables, see the documentation at +# https://mailu.io + +################################### +# Common configuration variables +################################### + +# Set this to the path where Mailu data and configuration is stored +# This variable is now set directly in `docker-compose.yml by the setup utility +# ROOT=/mailu + +# Mailu version to run (1.0, 1.1, etc. or master) +#VERSION=master + +# Set to a randomly generated 16 bytes string +SECRET_KEY=PDK7N9UC7FDQ2UWE + +# Address where listening ports should bind +# This variables are now set directly in `docker-compose.yml by the setup utility +# PUBLIC_IPV4= 127.0.0.1 (default: 127.0.0.1) +# PUBLIC_IPV6= ::1 (default: ::1) + +# Main mail domain +DOMAIN=mailu.io + +# Hostnames for this server, separated with comas +HOSTNAMES=mail.mailu.io + +# Postmaster local part (will append the main mail domain) +POSTMASTER=admin + +# Choose how secure connections will behave (value: letsencrypt, cert, notls, mail, mail-letsencrypt) +TLS_FLAVOR=letsencrypt + +# Authentication rate limit (per source IP address) +AUTH_RATELIMIT=10/minute;1000/hour + +# Opt-out of statistics, replace with "True" to opt out +DISABLE_STATISTICS=False + +################################### +# Optional features +################################### + +# Expose the admin interface (value: true, false) +ADMIN=true + +# Choose which webmail to run if any (values: roundcube, rainloop, none) +WEBMAIL=none + +# Dav server implementation (value: radicale, none) +WEBDAV=none + +# Antivirus solution (value: clamav, none) +#ANTIVIRUS=none + +#Antispam solution +ANTISPAM=none + +################################### +# Mail settings +################################### + +# Message size limit in bytes +# Default: accept messages up to 50MB +MESSAGE_SIZE_LIMIT=50000000 + +# Networks granted relay permissions, make sure that you include your Docker +# internal network (default to 172.17.0.0/16) +RELAYNETS=172.17.0.0/16 + +# Will relay all outgoing mails if configured +RELAYHOST= + +# Fetchmail delay +FETCHMAIL_DELAY=600 + +# Recipient delimiter, character used to delimiter localpart from custom address part +RECIPIENT_DELIMITER=+ + +# DMARC rua and ruf email +DMARC_RUA=admin +DMARC_RUF=admin + + +# Maildir Compression +# choose compression-method, default: none (value: bz2, gz) +COMPRESSION= +# change compression-level, default: 6 (value: 1-9) +COMPRESSION_LEVEL= + +################################### +# Web settings +################################### + +# Path to the admin interface if enabled +WEB_ADMIN=/admin + +# Path to the webmail if enabled +WEB_WEBMAIL=/webmail + +# Website name +SITENAME=Mailu + +# Linked Website URL +WEBSITE=https://mailu.io + + + +################################### +# Advanced settings +################################### + +# Log driver for front service. Possible values: +# json-file (default) +# journald (On systemd platforms, useful for Fail2Ban integration) +# syslog (Non systemd platforms, Fail2Ban integration. Disables `docker-compose log` for front!) +# LOG_DRIVER=json-file + +# Docker-compose project name, this will prepended to containers names. +COMPOSE_PROJECT_NAME=mailu + +# Default password scheme used for newly created accounts and changed passwords +# (value: BLF-CRYPT, SHA512-CRYPT, SHA256-CRYPT, MD5-CRYPT, CRYPT) +PASSWORD_SCHEME=BLF-CRYPT + +# Header to take the real ip from +REAL_IP_HEADER= + +# IPs for nginx set_real_ip_from (CIDR list separated by commas) +REAL_IP_FROM= + +# choose wether mailu bounces (no) or rejects (yes) mail when recipient is unknown (value: yes, no) +REJECT_UNLISTED_RECIPIENT= \ No newline at end of file diff --git a/tests/compose/filters/docker-compose.yml b/tests/compose/filters/docker-compose.yml new file mode 100644 index 00000000..31e62e72 --- /dev/null +++ b/tests/compose/filters/docker-compose.yml @@ -0,0 +1,95 @@ +# This file is auto-generated by the Mailu configuration wizard. +# Please read the documentation before attempting any change. +# Generated for compose flavor + +version: '3.6' + +services: + + # External dependencies + redis: + image: redis:alpine + restart: always + volumes: + - "/mailu/redis:/data" + + # Core services + front: + image: ${DOCKER_ORG:-mailu}/nginx:${MAILU_VERSION:-master} + restart: always + env_file: mailu.env + logging: + driver: json-file + ports: + - "127.0.0.1:80:80" + - "::1:80:80" + - "127.0.0.1:443:443" + - "::1:443:443" + - "127.0.0.1:25:25" + - "::1:25:25" + - "127.0.0.1:465:465" + - "::1:465:465" + - "127.0.0.1:587:587" + - "::1:587:587" + - "127.0.0.1:110:110" + - "::1:110:110" + - "127.0.0.1:995:995" + - "::1:995:995" + - "127.0.0.1:143:143" + - "::1:143:143" + - "127.0.0.1:993:993" + - "::1:993:993" + volumes: + - "/mailu/certs:/certs" + + admin: + image: ${DOCKER_ORG:-mailu}/admin:${MAILU_VERSION:-master} + restart: always + env_file: mailu.env + volumes: + - "/mailu/data:/data" + - "/mailu/dkim:/dkim" + depends_on: + - redis + + imap: + image: ${DOCKER_ORG:-mailu}/dovecot:${MAILU_VERSION:-master} + restart: always + env_file: mailu.env + volumes: + - "/mailu/mail:/mail" + - "/mailu/overrides:/overrides" + depends_on: + - front + + smtp: + image: ${DOCKER_ORG:-mailu}/postfix:${MAILU_VERSION:-master} + restart: always + env_file: mailu.env + volumes: + - "/mailu/overrides:/overrides" + depends_on: + - front + + antispam: + image: ${DOCKER_ORG:-mailu}/rspamd:${MAILU_VERSION:-master} + restart: always + env_file: mailu.env + volumes: + - "/mailu/filter:/var/lib/rspamd" + - "/mailu/dkim:/dkim" + - "/mailu/overrides/rspamd:/etc/rspamd/override.d" + depends_on: + - front + + # Optional services + antivirus: + image: ${DOCKER_ORG:-mailu}/clamav:${MAILU_VERSION:-master} + restart: always + env_file: mailu.env + volumes: + - "/mailu/filter:/data" + + + + # Webmail diff --git a/tests/compose/filters/mailu.env b/tests/compose/filters/mailu.env new file mode 100644 index 00000000..15fae1fc --- /dev/null +++ b/tests/compose/filters/mailu.env @@ -0,0 +1,139 @@ +# Mailu main configuration file +# +# Generated for compose flavor +# +# This file is autogenerated by the configuration management wizard. +# For a detailed list of configuration variables, see the documentation at +# https://mailu.io + +################################### +# Common configuration variables +################################### + +# Set this to the path where Mailu data and configuration is stored +# This variable is now set directly in `docker-compose.yml by the setup utility +# ROOT=/mailu + +# Mailu version to run (1.0, 1.1, etc. or master) +#VERSION=master + +# Set to a randomly generated 16 bytes string +SECRET_KEY=IUFE7Z57URZH1ZM1 + +# Address where listening ports should bind +# This variables are now set directly in `docker-compose.yml by the setup utility +# PUBLIC_IPV4= 127.0.0.1 (default: 127.0.0.1) +# PUBLIC_IPV6= ::1 (default: ::1) + +# Main mail domain +DOMAIN=mailu.io + +# Hostnames for this server, separated with comas +HOSTNAMES=mail.mailu.io + +# Postmaster local part (will append the main mail domain) +POSTMASTER=admin + +# Choose how secure connections will behave (value: letsencrypt, cert, notls, mail, mail-letsencrypt) +TLS_FLAVOR=letsencrypt + +# Authentication rate limit (per source IP address) +AUTH_RATELIMIT=10/minute;1000/hour + +# Opt-out of statistics, replace with "True" to opt out +DISABLE_STATISTICS=False + +################################### +# Optional features +################################### + +# Expose the admin interface (value: true, false) +ADMIN=true + +# Choose which webmail to run if any (values: roundcube, rainloop, none) +WEBMAIL=none + +# Dav server implementation (value: radicale, none) +WEBDAV=none + +# Antivirus solution (value: clamav, none) +#ANTIVIRUS=clamav + +#Antispam solution +ANTISPAM=none + +################################### +# Mail settings +################################### + +# Message size limit in bytes +# Default: accept messages up to 50MB +MESSAGE_SIZE_LIMIT=50000000 + +# Networks granted relay permissions, make sure that you include your Docker +# internal network (default to 172.17.0.0/16) +RELAYNETS=172.17.0.0/16 + +# Will relay all outgoing mails if configured +RELAYHOST= + +# Fetchmail delay +FETCHMAIL_DELAY=600 + +# Recipient delimiter, character used to delimiter localpart from custom address part +RECIPIENT_DELIMITER=+ + +# DMARC rua and ruf email +DMARC_RUA=admin +DMARC_RUF=admin + + +# Maildir Compression +# choose compression-method, default: none (value: bz2, gz) +COMPRESSION= +# change compression-level, default: 6 (value: 1-9) +COMPRESSION_LEVEL= + +################################### +# Web settings +################################### + +# Path to the admin interface if enabled +WEB_ADMIN=/admin + +# Path to the webmail if enabled +WEB_WEBMAIL=/webmail + +# Website name +SITENAME=Mailu + +# Linked Website URL +WEBSITE=https://mailu.io + + + +################################### +# Advanced settings +################################### + +# Log driver for front service. Possible values: +# json-file (default) +# journald (On systemd platforms, useful for Fail2Ban integration) +# syslog (Non systemd platforms, Fail2Ban integration. Disables `docker-compose log` for front!) +# LOG_DRIVER=json-file + +# Docker-compose project name, this will prepended to containers names. +COMPOSE_PROJECT_NAME=mailu + +# Default password scheme used for newly created accounts and changed passwords +# (value: BLF-CRYPT, SHA512-CRYPT, SHA256-CRYPT, MD5-CRYPT, CRYPT) +PASSWORD_SCHEME=BLF-CRYPT + +# Header to take the real ip from +REAL_IP_HEADER= + +# IPs for nginx set_real_ip_from (CIDR list separated by commas) +REAL_IP_FROM= + +# choose wether mailu bounces (no) or rejects (yes) mail when recipient is unknown (value: yes, no) +REJECT_UNLISTED_RECIPIENT= \ No newline at end of file diff --git a/tests/compose/filters+dns/filters+dns.yml b/tests/compose/rainloop/docker-compose.yml similarity index 68% rename from tests/compose/filters+dns/filters+dns.yml rename to tests/compose/rainloop/docker-compose.yml index 993ed786..730e33d8 100644 --- a/tests/compose/filters+dns/filters+dns.yml +++ b/tests/compose/rainloop/docker-compose.yml @@ -9,13 +9,17 @@ services: # External dependencies redis: image: redis:alpine + restart: always volumes: - "/mailu/redis:/data" # Core services front: - image: mailu/nginx:master + image: ${DOCKER_ORG:-mailu}/nginx:${MAILU_VERSION:-master} + restart: always env_file: mailu.env + logging: + driver: json-file ports: - "127.0.0.1:80:80" - "::1:80:80" @@ -37,17 +41,10 @@ services: - "::1:993:993" volumes: - "/mailu/certs:/certs" - - resolver: - image: mailu/unbound:master - env_file: mailu.env - restart: always - networks: - default: - ipv4_address: 192.168.0.254 admin: - image: mailu/admin:master + image: ${DOCKER_ORG:-mailu}/admin:${MAILU_VERSION:-master} + restart: always env_file: mailu.env volumes: - "/mailu/data:/data" @@ -56,7 +53,8 @@ services: - redis imap: - image: mailu/dovecot:master + image: ${DOCKER_ORG:-mailu}/dovecot:${MAILU_VERSION:-master} + restart: always env_file: mailu.env volumes: - "/mailu/mail:/mail" @@ -65,19 +63,17 @@ services: - front smtp: - image: mailu/postfix:master + image: ${DOCKER_ORG:-mailu}/postfix:${MAILU_VERSION:-master} + restart: always env_file: mailu.env volumes: - "/mailu/overrides:/overrides" depends_on: - front - - resolver - dns: - - 192.168.0.254 - # Optional services antispam: - image: mailu/rspamd:master + image: ${DOCKER_ORG:-mailu}/rspamd:${MAILU_VERSION:-master} + restart: always env_file: mailu.env volumes: - "/mailu/filter:/var/lib/rspamd" @@ -85,35 +81,17 @@ services: - "/mailu/overrides/rspamd:/etc/rspamd/override.d" depends_on: - front - - resolver - dns: - - 192.168.0.254 - antivirus: - image: mailu/clamav:master - env_file: mailu.env - volumes: - - "/mailu/filter:/data" - depends_on: - - resolver - dns: - - 192.168.0.254 + # Optional services # Webmail webmail: - image: mailu/rainloop:master + image: ${DOCKER_ORG:-mailu}/rainloop:${MAILU_VERSION:-master} + restart: always env_file: mailu.env volumes: - "/mailu/webmail:/data" depends_on: - imap - -networks: - default: - driver: bridge - ipam: - driver: default - config: - - subnet: 192.168.0.0/24 diff --git a/tests/compose/rainloop/mailu.env b/tests/compose/rainloop/mailu.env new file mode 100644 index 00000000..7ac75438 --- /dev/null +++ b/tests/compose/rainloop/mailu.env @@ -0,0 +1,139 @@ +# Mailu main configuration file +# +# Generated for compose flavor +# +# This file is autogenerated by the configuration management wizard. +# For a detailed list of configuration variables, see the documentation at +# https://mailu.io + +################################### +# Common configuration variables +################################### + +# Set this to the path where Mailu data and configuration is stored +# This variable is now set directly in `docker-compose.yml by the setup utility +# ROOT=/mailu + +# Mailu version to run (1.0, 1.1, etc. or master) +#VERSION=master + +# Set to a randomly generated 16 bytes string +SECRET_KEY=QWE7CJZOET9BN4BU + +# Address where listening ports should bind +# This variables are now set directly in `docker-compose.yml by the setup utility +# PUBLIC_IPV4= 127.0.0.1 (default: 127.0.0.1) +# PUBLIC_IPV6= ::1 (default: ::1) + +# Main mail domain +DOMAIN=mailu.io + +# Hostnames for this server, separated with comas +HOSTNAMES=mail.mailu.io + +# Postmaster local part (will append the main mail domain) +POSTMASTER=admin + +# Choose how secure connections will behave (value: letsencrypt, cert, notls, mail, mail-letsencrypt) +TLS_FLAVOR=letsencrypt + +# Authentication rate limit (per source IP address) +AUTH_RATELIMIT=10/minute;1000/hour + +# Opt-out of statistics, replace with "True" to opt out +DISABLE_STATISTICS=False + +################################### +# Optional features +################################### + +# Expose the admin interface (value: true, false) +ADMIN=true + +# Choose which webmail to run if any (values: roundcube, rainloop, none) +WEBMAIL=rainloop + +# Dav server implementation (value: radicale, none) +WEBDAV=none + +# Antivirus solution (value: clamav, none) +#ANTIVIRUS=none + +#Antispam solution +ANTISPAM=none + +################################### +# Mail settings +################################### + +# Message size limit in bytes +# Default: accept messages up to 50MB +MESSAGE_SIZE_LIMIT=50000000 + +# Networks granted relay permissions, make sure that you include your Docker +# internal network (default to 172.17.0.0/16) +RELAYNETS=172.17.0.0/16 + +# Will relay all outgoing mails if configured +RELAYHOST= + +# Fetchmail delay +FETCHMAIL_DELAY=600 + +# Recipient delimiter, character used to delimiter localpart from custom address part +RECIPIENT_DELIMITER=+ + +# DMARC rua and ruf email +DMARC_RUA=admin +DMARC_RUF=admin + + +# Maildir Compression +# choose compression-method, default: none (value: bz2, gz) +COMPRESSION= +# change compression-level, default: 6 (value: 1-9) +COMPRESSION_LEVEL= + +################################### +# Web settings +################################### + +# Path to the admin interface if enabled +WEB_ADMIN=/admin + +# Path to the webmail if enabled +WEB_WEBMAIL=/webmail + +# Website name +SITENAME=Mailu + +# Linked Website URL +WEBSITE=https://mailu.io + + + +################################### +# Advanced settings +################################### + +# Log driver for front service. Possible values: +# json-file (default) +# journald (On systemd platforms, useful for Fail2Ban integration) +# syslog (Non systemd platforms, Fail2Ban integration. Disables `docker-compose log` for front!) +# LOG_DRIVER=json-file + +# Docker-compose project name, this will prepended to containers names. +COMPOSE_PROJECT_NAME=mailu + +# Default password scheme used for newly created accounts and changed passwords +# (value: BLF-CRYPT, SHA512-CRYPT, SHA256-CRYPT, MD5-CRYPT, CRYPT) +PASSWORD_SCHEME=BLF-CRYPT + +# Header to take the real ip from +REAL_IP_HEADER= + +# IPs for nginx set_real_ip_from (CIDR list separated by commas) +REAL_IP_FROM= + +# choose wether mailu bounces (no) or rejects (yes) mail when recipient is unknown (value: yes, no) +REJECT_UNLISTED_RECIPIENT= \ No newline at end of file diff --git a/tests/compose/roundcube/roundcube.yml b/tests/compose/roundcube/docker-compose.yml similarity index 64% rename from tests/compose/roundcube/roundcube.yml rename to tests/compose/roundcube/docker-compose.yml index c6e46ed9..989f6a67 100644 --- a/tests/compose/roundcube/roundcube.yml +++ b/tests/compose/roundcube/docker-compose.yml @@ -9,13 +9,17 @@ services: # External dependencies redis: image: redis:alpine + restart: always volumes: - "/mailu/redis:/data" # Core services front: - image: mailu/nginx:master + image: ${DOCKER_ORG:-mailu}/nginx:${MAILU_VERSION:-master} + restart: always env_file: mailu.env + logging: + driver: json-file ports: - "127.0.0.1:80:80" - "::1:80:80" @@ -37,10 +41,10 @@ services: - "::1:993:993" volumes: - "/mailu/certs:/certs" - admin: - image: mailu/admin:master + image: ${DOCKER_ORG:-mailu}/admin:${MAILU_VERSION:-master} + restart: always env_file: mailu.env volumes: - "/mailu/data:/data" @@ -49,7 +53,8 @@ services: - redis imap: - image: mailu/dovecot:master + image: ${DOCKER_ORG:-mailu}/dovecot:${MAILU_VERSION:-master} + restart: always env_file: mailu.env volumes: - "/mailu/mail:/mail" @@ -58,27 +63,35 @@ services: - front smtp: - image: mailu/postfix:master + image: ${DOCKER_ORG:-mailu}/postfix:${MAILU_VERSION:-master} + restart: always env_file: mailu.env volumes: - "/mailu/overrides:/overrides" depends_on: - front + antispam: + image: ${DOCKER_ORG:-mailu}/rspamd:${MAILU_VERSION:-master} + restart: always + env_file: mailu.env + volumes: + - "/mailu/filter:/var/lib/rspamd" + - "/mailu/dkim:/dkim" + - "/mailu/overrides/rspamd:/etc/rspamd/override.d" + depends_on: + - front + # Optional services - # Webmail webmail: - image: mailu/roundcube:master + image: ${DOCKER_ORG:-mailu}/roundcube:${MAILU_VERSION:-master} + restart: always env_file: mailu.env volumes: - "/mailu/webmail:/data" depends_on: - imap - - resolver - dns: - - 192.168.0.254 - diff --git a/tests/compose/roundcube/mailu.env b/tests/compose/roundcube/mailu.env new file mode 100644 index 00000000..3c092f15 --- /dev/null +++ b/tests/compose/roundcube/mailu.env @@ -0,0 +1,139 @@ +# Mailu main configuration file +# +# Generated for compose flavor +# +# This file is autogenerated by the configuration management wizard. +# For a detailed list of configuration variables, see the documentation at +# https://mailu.io + +################################### +# Common configuration variables +################################### + +# Set this to the path where Mailu data and configuration is stored +# This variable is now set directly in `docker-compose.yml by the setup utility +# ROOT=/mailu + +# Mailu version to run (1.0, 1.1, etc. or master) +#VERSION=master + +# Set to a randomly generated 16 bytes string +SECRET_KEY=KXGYDHIHWTS7VRUP + +# Address where listening ports should bind +# This variables are now set directly in `docker-compose.yml by the setup utility +# PUBLIC_IPV4= 127.0.0.1 (default: 127.0.0.1) +# PUBLIC_IPV6= ::1 (default: ::1) + +# Main mail domain +DOMAIN=mailu.io + +# Hostnames for this server, separated with comas +HOSTNAMES=mail.mailu.io + +# Postmaster local part (will append the main mail domain) +POSTMASTER=admin + +# Choose how secure connections will behave (value: letsencrypt, cert, notls, mail, mail-letsencrypt) +TLS_FLAVOR=letsencrypt + +# Authentication rate limit (per source IP address) +AUTH_RATELIMIT=10/minute;1000/hour + +# Opt-out of statistics, replace with "True" to opt out +DISABLE_STATISTICS=False + +################################### +# Optional features +################################### + +# Expose the admin interface (value: true, false) +ADMIN=true + +# Choose which webmail to run if any (values: roundcube, rainloop, none) +WEBMAIL=roundcube + +# Dav server implementation (value: radicale, none) +WEBDAV=none + +# Antivirus solution (value: clamav, none) +#ANTIVIRUS=none + +#Antispam solution +ANTISPAM=none + +################################### +# Mail settings +################################### + +# Message size limit in bytes +# Default: accept messages up to 50MB +MESSAGE_SIZE_LIMIT=50000000 + +# Networks granted relay permissions, make sure that you include your Docker +# internal network (default to 172.17.0.0/16) +RELAYNETS=172.17.0.0/16 + +# Will relay all outgoing mails if configured +RELAYHOST= + +# Fetchmail delay +FETCHMAIL_DELAY=600 + +# Recipient delimiter, character used to delimiter localpart from custom address part +RECIPIENT_DELIMITER=+ + +# DMARC rua and ruf email +DMARC_RUA=admin +DMARC_RUF=admin + + +# Maildir Compression +# choose compression-method, default: none (value: bz2, gz) +COMPRESSION= +# change compression-level, default: 6 (value: 1-9) +COMPRESSION_LEVEL= + +################################### +# Web settings +################################### + +# Path to the admin interface if enabled +WEB_ADMIN=/admin + +# Path to the webmail if enabled +WEB_WEBMAIL=/webmail + +# Website name +SITENAME=Mailu + +# Linked Website URL +WEBSITE=https://mailu.io + + + +################################### +# Advanced settings +################################### + +# Log driver for front service. Possible values: +# json-file (default) +# journald (On systemd platforms, useful for Fail2Ban integration) +# syslog (Non systemd platforms, Fail2Ban integration. Disables `docker-compose log` for front!) +# LOG_DRIVER=json-file + +# Docker-compose project name, this will prepended to containers names. +COMPOSE_PROJECT_NAME=mailu + +# Default password scheme used for newly created accounts and changed passwords +# (value: BLF-CRYPT, SHA512-CRYPT, SHA256-CRYPT, MD5-CRYPT, CRYPT) +PASSWORD_SCHEME=BLF-CRYPT + +# Header to take the real ip from +REAL_IP_HEADER= + +# IPs for nginx set_real_ip_from (CIDR list separated by commas) +REAL_IP_FROM= + +# choose wether mailu bounces (no) or rejects (yes) mail when recipient is unknown (value: yes, no) +REJECT_UNLISTED_RECIPIENT= \ No newline at end of file diff --git a/tests/compose/test-script.sh b/tests/compose/test-script.sh deleted file mode 100755 index 0a3c2237..00000000 --- a/tests/compose/test-script.sh +++ /dev/null @@ -1,57 +0,0 @@ -#!/bin/bash -containers=( - webmail - imap - smtp - antispam - admin - redis - antivirus - webdav -# fetchmail - front -) - -# Time to sleep in minutes after starting the containers -WAIT=1 - -containers_check() { - status=0 - for container in "${containers[@]}"; do - name="${DOCKER_ORG}_${container}_1" - echo "Checking $name" - docker inspect "$name" | grep '"Status": "running"' || status=1 - done - docker ps -a - return $status -} - -container_logs() { - for container in "${containers[@]}"; do - name="${DOCKER_ORG}_${container}_1" - echo "Showing logs for $name" - docker container logs "$name" - done -} - -clean() { - docker-compose -f tests/compose/run.yml -p $DOCKER_ORG down || exit 1 - rm -fv .env -} - -# Cleanup before callig exit -die() { - clean - exit $1 -} - -for file in tests/compose/*.env ; do - cp $file .env - docker-compose -f tests/compose/run.yml -p $DOCKER_ORG up -d - echo -e "\nSleeping for ${WAIT} minutes" # Clean terminal distortion from docker-compose in travis - travis_wait sleep ${WAIT}m || sleep ${WAIT}m #Fallback sleep for local run - container_logs - containers_check || die 1 - clean -done - diff --git a/tests/compose/test.py b/tests/compose/test.py index 95670e30..dfe07ea8 100755 --- a/tests/compose/test.py +++ b/tests/compose/test.py @@ -7,21 +7,16 @@ from colorama import Fore, Style # Declare variables for service name and sleep time test_name=sys.argv[1] timeout=int(sys.argv[2]) +compose_file="tests/compose/" + test_name + "/docker-compose.yml" client = docker.APIClient(base_url='unix://var/run/docker.sock') containers = [] -# Start up containers -def start(): - os.system("cp mailu.env " + test_name + "/") - os.system("docker-compose -f " + test_name + "/" + test_name + ".yml -p $DOCKER_ORG up -d ") - # Stop containers def stop(exit_code): print_logs() - os.system("docker-compose -f " + test_name + "/" + test_name + ".yml -p $DOCKER_ORG down") - os.system("rm " + test_name +"/mailu.env") + os.system("docker-compose -f " + compose_file + " -p ${DOCKER_ORG:-mailu} down") sys.exit(exit_code) # Sleep for a defined amount of time @@ -79,7 +74,8 @@ def hooks(): elif test_file.endswith(".sh"): os.system("./" + test_name + "/" + test_file) -start() +# Start up containers +os.system("docker-compose -f " + compose_file + " -p ${DOCKER_ORG:-mailu} up -d ") print() sleep() print() diff --git a/tests/compose/webdav/webdav.yml b/tests/compose/webdav/docker-compose.yml similarity index 63% rename from tests/compose/webdav/webdav.yml rename to tests/compose/webdav/docker-compose.yml index b4d222ef..7e28c4cc 100644 --- a/tests/compose/webdav/webdav.yml +++ b/tests/compose/webdav/docker-compose.yml @@ -9,13 +9,17 @@ services: # External dependencies redis: image: redis:alpine + restart: always volumes: - "/mailu/redis:/data" # Core services front: - image: mailu/nginx:master + image: ${DOCKER_ORG:-mailu}/nginx:${MAILU_VERSION:-master} + restart: always env_file: mailu.env + logging: + driver: json-file ports: - "127.0.0.1:80:80" - "::1:80:80" @@ -37,10 +41,10 @@ services: - "::1:993:993" volumes: - "/mailu/certs:/certs" - admin: - image: mailu/admin:master + image: ${DOCKER_ORG:-mailu}/admin:${MAILU_VERSION:-master} + restart: always env_file: mailu.env volumes: - "/mailu/data:/data" @@ -49,7 +53,8 @@ services: - redis imap: - image: mailu/dovecot:master + image: ${DOCKER_ORG:-mailu}/dovecot:${MAILU_VERSION:-master} + restart: always env_file: mailu.env volumes: - "/mailu/mail:/mail" @@ -58,22 +63,33 @@ services: - front smtp: - image: mailu/postfix:master + image: ${DOCKER_ORG:-mailu}/postfix:${MAILU_VERSION:-master} + restart: always env_file: mailu.env volumes: - "/mailu/overrides:/overrides" depends_on: - front + antispam: + image: ${DOCKER_ORG:-mailu}/rspamd:${MAILU_VERSION:-master} + restart: always + env_file: mailu.env + volumes: + - "/mailu/filter:/var/lib/rspamd" + - "/mailu/dkim:/dkim" + - "/mailu/overrides/rspamd:/etc/rspamd/override.d" + depends_on: + - front + # Optional services - webdav: - image: mailu/radicale:master + image: ${DOCKER_ORG:-mailu}/radicale:${MAILU_VERSION:-master} + restart: always env_file: mailu.env volumes: - "/mailu/dav:/data" # Webmail - diff --git a/tests/compose/webdav/mailu.env b/tests/compose/webdav/mailu.env new file mode 100644 index 00000000..acb48abb --- /dev/null +++ b/tests/compose/webdav/mailu.env @@ -0,0 +1,139 @@ +# Mailu main configuration file +# +# Generated for compose flavor +# +# This file is autogenerated by the configuration management wizard. +# For a detailed list of configuration variables, see the documentation at +# https://mailu.io + +################################### +# Common configuration variables +################################### + +# Set this to the path where Mailu data and configuration is stored +# This variable is now set directly in `docker-compose.yml by the setup utility +# ROOT=/mailu + +# Mailu version to run (1.0, 1.1, etc. or master) +#VERSION=master + +# Set to a randomly generated 16 bytes string +SECRET_KEY=QDHY5C0EME3YBI2W + +# Address where listening ports should bind +# This variables are now set directly in `docker-compose.yml by the setup utility +# PUBLIC_IPV4= 127.0.0.1 (default: 127.0.0.1) +# PUBLIC_IPV6= ::1 (default: ::1) + +# Main mail domain +DOMAIN=mailu.io + +# Hostnames for this server, separated with comas +HOSTNAMES=mail.mailu.io + +# Postmaster local part (will append the main mail domain) +POSTMASTER=admin + +# Choose how secure connections will behave (value: letsencrypt, cert, notls, mail, mail-letsencrypt) +TLS_FLAVOR=letsencrypt + +# Authentication rate limit (per source IP address) +AUTH_RATELIMIT=10/minute;1000/hour + +# Opt-out of statistics, replace with "True" to opt out +DISABLE_STATISTICS=False + +################################### +# Optional features +################################### + +# Expose the admin interface (value: true, false) +ADMIN=true + +# Choose which webmail to run if any (values: roundcube, rainloop, none) +WEBMAIL=none + +# Dav server implementation (value: radicale, none) +WEBDAV=radicale + +# Antivirus solution (value: clamav, none) +#ANTIVIRUS=none + +#Antispam solution +ANTISPAM=none + +################################### +# Mail settings +################################### + +# Message size limit in bytes +# Default: accept messages up to 50MB +MESSAGE_SIZE_LIMIT=50000000 + +# Networks granted relay permissions, make sure that you include your Docker +# internal network (default to 172.17.0.0/16) +RELAYNETS=172.17.0.0/16 + +# Will relay all outgoing mails if configured +RELAYHOST= + +# Fetchmail delay +FETCHMAIL_DELAY=600 + +# Recipient delimiter, character used to delimiter localpart from custom address part +RECIPIENT_DELIMITER=+ + +# DMARC rua and ruf email +DMARC_RUA=admin +DMARC_RUF=admin + + +# Maildir Compression +# choose compression-method, default: none (value: bz2, gz) +COMPRESSION= +# change compression-level, default: 6 (value: 1-9) +COMPRESSION_LEVEL= + +################################### +# Web settings +################################### + +# Path to the admin interface if enabled +WEB_ADMIN=/admin + +# Path to the webmail if enabled +WEB_WEBMAIL=/webmail + +# Website name +SITENAME=Mailu + +# Linked Website URL +WEBSITE=https://mailu.io + + + +################################### +# Advanced settings +################################### + +# Log driver for front service. Possible values: +# json-file (default) +# journald (On systemd platforms, useful for Fail2Ban integration) +# syslog (Non systemd platforms, Fail2Ban integration. Disables `docker-compose log` for front!) +# LOG_DRIVER=json-file + +# Docker-compose project name, this will prepended to containers names. +COMPOSE_PROJECT_NAME=mailu + +# Default password scheme used for newly created accounts and changed passwords +# (value: BLF-CRYPT, SHA512-CRYPT, SHA256-CRYPT, MD5-CRYPT, CRYPT) +PASSWORD_SCHEME=BLF-CRYPT + +# Header to take the real ip from +REAL_IP_HEADER= + +# IPs for nginx set_real_ip_from (CIDR list separated by commas) +REAL_IP_FROM= + +# choose wether mailu bounces (no) or rejects (yes) mail when recipient is unknown (value: yes, no) +REJECT_UNLISTED_RECIPIENT= \ No newline at end of file From 1e3392e4175ff41d0dfc61c8fba40914e7d179ea Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim=20M=C3=B6hlmann?= Date: Thu, 25 Oct 2018 17:37:22 +0300 Subject: [PATCH 10/28] Antispam not an optional service, postfix fails without it --- setup/flavors/compose/docker-compose.yml | 4 +--- setup/flavors/stack/docker-compose.yml | 4 +--- setup/templates/steps/compose/02_services.html | 6 ------ setup/templates/steps/stack/02_services.html | 6 ------ 4 files changed, 2 insertions(+), 18 deletions(-) diff --git a/setup/flavors/compose/docker-compose.yml b/setup/flavors/compose/docker-compose.yml index 14eeba3c..f2cbad23 100644 --- a/setup/flavors/compose/docker-compose.yml +++ b/setup/flavors/compose/docker-compose.yml @@ -66,8 +66,6 @@ services: depends_on: - front - # Optional services - {% if antispam_enabled %} antispam: image: ${DOCKER_ORG:-mailu}/rspamd:${MAILU_VERSION:-{{ version }}} restart: always @@ -78,8 +76,8 @@ services: - "{{ root }}/overrides/rspamd:/etc/rspamd/override.d" depends_on: - front - {% endif %} + # Optional services {% if antivirus_enabled %} antivirus: image: ${DOCKER_ORG:-mailu}/clamav:${MAILU_VERSION:-{{ version }}} diff --git a/setup/flavors/stack/docker-compose.yml b/setup/flavors/stack/docker-compose.yml index 92a156c7..dd9ed7dc 100644 --- a/setup/flavors/stack/docker-compose.yml +++ b/setup/flavors/stack/docker-compose.yml @@ -65,8 +65,6 @@ services: deploy: replicas: {{ smtp_replicas }} - # Optional services - {% if antispam_enabled %} antispam: image: ${DOCKER_ORG:-mailu}/rspamd:${MAILU_VERSION:-{{ version }}} env_file: {{ env }} @@ -78,8 +76,8 @@ services: - "{{ root }}/overrides/rspamd:/etc/rspamd/override.d" deploy: replicas: 1 - {% endif %} + # Optional services {% if antivirus_enabled %} antivirus: image: ${DOCKER_ORG:-mailu}/clamav:${MAILU_VERSION:-{{ version }}} diff --git a/setup/templates/steps/compose/02_services.html b/setup/templates/steps/compose/02_services.html index 7117c490..424b22dc 100644 --- a/setup/templates/steps/compose/02_services.html +++ b/setup/templates/steps/compose/02_services.html @@ -32,12 +32,6 @@ will prevent Mailu from doing spam filtering, virus filtering, and from applying white and blacklists that you may configure in the admin interface. You may also disable the antivirus if required (it does use aroung 1GB of ram).

-
- -
+ + + + {% endcall %} diff --git a/setup/templates/steps/config.html b/setup/templates/steps/config.html index 88c17597..a3352b7e 100644 --- a/setup/templates/steps/config.html +++ b/setup/templates/steps/config.html @@ -68,11 +68,29 @@ Or in plain english: if receivers start to classify your mail as spam, this post manage your email domains, users, etc.

- -
-
- -
+ + +
+ + + + {% endcall %} diff --git a/setup/templates/steps/stack/02_services.html b/setup/templates/steps/stack/02_services.html index 424b22dc..53763658 100644 --- a/setup/templates/steps/stack/02_services.html +++ b/setup/templates/steps/stack/02_services.html @@ -15,15 +15,14 @@ accessing messages for beginner users.


- {% for webmailtype in ["none", "roundcube", "rainloop"] %} {% endfor %}

- - +
@@ -53,4 +52,27 @@ also disable the antivirus if required (it does use aroung 1GB of ram).

+ + + + {% endcall %} From 003c36c98a68a137a95bf105341bae4c0a301683 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim=20M=C3=B6hlmann?= Date: Wed, 31 Oct 2018 17:47:05 +0200 Subject: [PATCH 15/28] Fix imap login when no webmail selected --- core/admin/mailu/internal/views/dovecot.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/core/admin/mailu/internal/views/dovecot.py b/core/admin/mailu/internal/views/dovecot.py index 036140f0..e6e4c10f 100644 --- a/core/admin/mailu/internal/views/dovecot.py +++ b/core/admin/mailu/internal/views/dovecot.py @@ -3,7 +3,7 @@ from mailu.internal import internal import flask import socket - +import os @internal.route("/dovecot/passdb/") def dovecot_passdb_dict(user_email): @@ -13,7 +13,8 @@ def dovecot_passdb_dict(user_email): app.config.get("POD_ADDRESS_RANGE") or socket.gethostbyname(app.config["HOST_FRONT"]) ) - allow_nets.append(socket.gethostbyname(app.config["HOST_WEBMAIL"])) + if os.environ["WEBMAIL"] != "none": + allow_nets.append(socket.gethostbyname(app.config["HOST_WEBMAIL"])) print(allow_nets) return flask.jsonify({ "password": None, From 4e9dc0c3c93fbc65b2704b50b9f92dab46ceac86 Mon Sep 17 00:00:00 2001 From: Ionut Filip Date: Thu, 1 Nov 2018 11:40:54 +0200 Subject: [PATCH 16/28] Implemented sending/reading email(local tests) --- tests/certs/cert.pem | 29 ++++++++++++++ tests/certs/key.pem | 52 +++++++++++++++++++++++++ tests/compose/core/email_test.py | 55 +++++++++++++++++++++++++++ tests/compose/core/mailu.env | 2 +- tests/compose/fetchmail/email_test.py | 55 +++++++++++++++++++++++++++ tests/compose/fetchmail/mailu.env | 2 +- tests/compose/filters/email_test.py | 55 +++++++++++++++++++++++++++ tests/compose/filters/mailu.env | 2 +- tests/compose/rainloop/email_test.py | 55 +++++++++++++++++++++++++++ tests/compose/rainloop/mailu.env | 2 +- tests/compose/roundcube/email_test.py | 55 +++++++++++++++++++++++++++ tests/compose/roundcube/mailu.env | 2 +- tests/compose/test.py | 14 ++++++- tests/compose/webdav/email_test.py | 55 +++++++++++++++++++++++++++ tests/compose/webdav/mailu.env | 2 +- 15 files changed, 430 insertions(+), 7 deletions(-) create mode 100644 tests/certs/cert.pem create mode 100644 tests/certs/key.pem create mode 100755 tests/compose/core/email_test.py create mode 100755 tests/compose/fetchmail/email_test.py create mode 100755 tests/compose/filters/email_test.py create mode 100755 tests/compose/rainloop/email_test.py create mode 100755 tests/compose/roundcube/email_test.py create mode 100755 tests/compose/webdav/email_test.py diff --git a/tests/certs/cert.pem b/tests/certs/cert.pem new file mode 100644 index 00000000..d6dc928f --- /dev/null +++ b/tests/certs/cert.pem @@ -0,0 +1,29 @@ +-----BEGIN CERTIFICATE----- +MIIE/jCCAuagAwIBAgIJAKVnyadXS7SuMA0GCSqGSIb3DQEBCwUAMBQxEjAQBgNV +BAMMCWxvY2FsaG9zdDAeFw0xODEwMzExMDE1MzFaFw0yODEwMjgxMDE1MzFaMBQx +EjAQBgNVBAMMCWxvY2FsaG9zdDCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoC +ggIBAOQ2ZDqR+YvW5FKykBXz/Ec+jSb0Lv7GYQkT5t+TB1NXuR+QH1LfNWFmXOo7 +YXcPVXlmcuLDuUldrctdS59fx8dnFu5gRRUqJwZuEQICypsX0rTDtsV6xqZB8c8y +2+BztP9OHfPpZdnU1IBx2fDbjpdKUaoAMFMFvyTaEcIyp6aGAhejvJCwc3D8fIJI +NhWA2O11sZQHUs7/MHzpu/IHpgutgk8EsNOUNLwB3+9p3IlOlTT6GilIXOYeTzoD +hiI6B5BQqXHsRrkao3v0YL6Ekun4hOx3MYx09AZtmuyrlq1mkNueKS5JwKDrXXbq +Ta0oyJ18UTZFRwVqApcuR4CA8vuhI9PsoDCvBQH1rW6FyiM4bhybatFJAYjQAODe +gwh2p6JWux5C1gaBUubOrKO7o5ePI6s0MmK8ZxrL4PpBYt3B33ztFfjWmVbCTSvP +GuQ2Ux73OY2NNxx2aNt4Th0IxrvMdsGLrZsdma2rWa5eTJTAuqbSjI/Wb1zjO0pi +pwoxk6f1COFLopo2xgJj6+KKG1nKLfOzQFexcpdq/mpuulcVcLDPJzJTLX3qsgtD +iBpm1ozNRT+M7XUavg8aHNfn6S+TcDb5hp+1yZ6obZq/VlA6atk0fuPzf+ndQ0fq +YN1jlAIzZXt/Dpc+ObjS09WGDVQXobGesdwA6BH14OV+TxOHAgMBAAGjUzBRMB0G +A1UdDgQWBBQy7kA8FbdcFpVU1AoFgzE7Fw1QqDAfBgNVHSMEGDAWgBQy7kA8Fbdc +FpVU1AoFgzE7Fw1QqDAPBgNVHRMBAf8EBTADAQH/MA0GCSqGSIb3DQEBCwUAA4IC +AQBLFlQKxztxm7MtsHs01Pl8/FpKzWekWK1ksf15d8mHBT30OTs+NXaJDuHTGL4r +rPeFf3NZ1PZkGRnJCEWur+8e8Y5KwuMAaagneSYXU0gcZfvTidvf865Jiml8xO5x +PAo8qTZQCHmYcvJQwBXMkq/2sFJCYeMOLoJdXXbTTe2ZQ/N3MSQbpgWJ8pF7srKU +biw2RkNH39QPq9GpWRQGx2gwvZDy2oFG8cM1hJYmz0Y9clpBE0mSqypvA1E8ufKC +uaUc0tpPI5H4efeWv/ObnFAJ3DMEmzUnQ8hdM/7cpf6AL8VRm4Wrw112gK7SbSdd +mMsUfFIDfyE9vsZ3OC8C8LqXKLwMcm7Fdq0ym0NINtoVW0ukmVJzB78CdWaJ7ux1 +WqitcnewgiMWuuwuepBmNurZtgDrg+zgMhNpuK0NzYyE+ZReoJIOJCub3SSEsWdl +x5aJEYuFYJR5EvmxWeYv5p1GVOTL1TJqW7iRodzRoMc9u2vb0+tCbM5XSZVPul6P +QimDui2Ogq0zYNbSkHaUGBpjGDvHYG0zXO2sWrdrAJQMHo8dGEe7FuSuAlWbQdb/ +xgN4uwejxV6B2e6rjT6YMni+r5Qw0EhNka+Xohw5E68bEcQSrCP8j64qQLAeipuz +ImqBTNyyR4WTcL+1HIVM7ZIw3igHH55zo5qTvyjKyZX9Uw== +-----END CERTIFICATE----- diff --git a/tests/certs/key.pem b/tests/certs/key.pem new file mode 100644 index 00000000..938633fd --- /dev/null +++ b/tests/certs/key.pem @@ -0,0 +1,52 @@ +-----BEGIN PRIVATE KEY----- +MIIJQwIBADANBgkqhkiG9w0BAQEFAASCCS0wggkpAgEAAoICAQDkNmQ6kfmL1uRS +spAV8/xHPo0m9C7+xmEJE+bfkwdTV7kfkB9S3zVhZlzqO2F3D1V5ZnLiw7lJXa3L +XUufX8fHZxbuYEUVKicGbhECAsqbF9K0w7bFesamQfHPMtvgc7T/Th3z6WXZ1NSA +cdnw246XSlGqADBTBb8k2hHCMqemhgIXo7yQsHNw/HyCSDYVgNjtdbGUB1LO/zB8 +6bvyB6YLrYJPBLDTlDS8Ad/vadyJTpU0+hopSFzmHk86A4YiOgeQUKlx7Ea5GqN7 +9GC+hJLp+ITsdzGMdPQGbZrsq5atZpDbnikuScCg61126k2tKMidfFE2RUcFagKX +LkeAgPL7oSPT7KAwrwUB9a1uhcojOG4cm2rRSQGI0ADg3oMIdqeiVrseQtYGgVLm +zqyju6OXjyOrNDJivGcay+D6QWLdwd987RX41plWwk0rzxrkNlMe9zmNjTccdmjb +eE4dCMa7zHbBi62bHZmtq1muXkyUwLqm0oyP1m9c4ztKYqcKMZOn9QjhS6KaNsYC +Y+viihtZyi3zs0BXsXKXav5qbrpXFXCwzycyUy196rILQ4gaZtaMzUU/jO11Gr4P +GhzX5+kvk3A2+YaftcmeqG2av1ZQOmrZNH7j83/p3UNH6mDdY5QCM2V7fw6XPjm4 +0tPVhg1UF6GxnrHcAOgR9eDlfk8ThwIDAQABAoICACoHsnHvDIyqqSZp6IuCggYF +CS4Rbs5RbvGjDrRCeejpkRi1DG/Q2B32IkqpYQvycQWIzsPg1DEk5as8pX7Wvw6E +d/6zEEYTm1hd0RgTt4jU3GOaYAEC2a8pGgXVEhXGeaFDm9SeObnirrhxP3hSl3JZ +p6ytmDjSKB/7YaXoemP67ku4RjRHqxs2BSBheESBlHI3aNsgdinVafK3gXvT2Mrx +y7wN2xs8gnHVzo5jatCG/ofhQAw2XZWsI19F4uBO27HCiVKH94aD13Quz9qGxB// +O0vpr+B0cbT1XsET4Q5Sg39PI7p4rtd0QaRzBpdLmZcXnEVogOoIWi3JwjVyik1g +lcg+4A8wj4pDGsCmANt90YqedktQGiYsYozZHO3YCrnjO6lqYJLOBocRG9NJqldY +kzs6UfJ+96FoYQVGNXyeQZizC26rQHll/rwsJnsB7GvM38f3q3cr3Borpwx3HosN +mmM+WRcvV3WWjjx1870Jm+tIDu0clWvT7hdHSf4938/Xr9cUTyuX2LrqTfp6JThl ++NbYgbuvd5leP94wPwRxfJL+PR5B4kbLPwDNCbpM8QTBm+9Y4kU+6ePmgcuRemMQ +8J41ocUjC4wR2j9Zgy0f0Rz4KiKM6IiVgKyqPUMaY+aJQ+yB5J+tlBkPJeZzft/e +XAoxt0STTassHC+p9COxAoIBAQD2Vd2Q1rbxWGnWl0m1LcH5q4hsuUAhIYmuTMSO +RkDLD/8yfPR4uUbTgrtdL2FaeOsCK7nrQAPxcfdD//+SoNVsAkMuNw6QvJn4ZXLf +5C45tN4pfoz/EwIRBvyJnI+HZuNaCUCfsQB9ggeEHgM2n36GBiOX82inQey3eREz +wZjQqmCp+b1QiYoWrVCgOPOvB86kbNgHGacIS7cDe94OeP4dH+FAfWaIBab8sDnG +K6+N6dWdj+b7veUWpXBs8beVCTO4GPnW5hnYOfuWkdpNCej/QbMeivMA4U7g+CeF +Y5QB07EE5f35Epp8WoNtwVZoFgP72xMT1taz1Rx7dohdYvLVAoIBAQDtKoDiwi2V +07rOgsjgW972HdA0nOnja/lky6CKkY5BqNGMj63h0ysy8Fe8mEWdPXyY9f7TgWP9 +sDMZMq+d8ZwAjfdYjYTKpxA3pA9oj66OCxtR6usElmeyultPjZ8FXJNXzOLv4dju +FnELSFSSx8o6WHGq9l2eWNMFf46g70Bt+aiHV/VGLLSFTUcvd51H7jP+PFxrBn1k +kz1u0n/RRuPMIru68lKJxrpDsr917Spw16O+uzjR99IqNPskVJxUnXV8qvMxeWVl +wTOP9soqYv/KvqjsBO+nLNkLSH402Fp78e2Oe6KPKlF21kl5oA7Yn/w4MtyFpj65 +fg6uDaPhgoLrAoIBAQCb9uWfzLJrwETSn1sFoYENKPPpkqjt0SQw/V39jrF7YBd9 +yeune/dB96XVbChBdgmliDXgotlcR4H8xdr05Wv7RLtwSV+peCAsS18eLoSt+Lwo +nX18CnbmfPvrzPp7CkOsP+twsErVLDzCA5aZQQaEqOJkVLLQI0dTKw4fLNYqV5V4 +SSz6DvslPHqt1yFCkrjdFiT46d79u6KWTBjeJPEPU530jPEb8ig2GQWbWRF/0qtz +ZSckAKlJW1oBQFGxxO/AAeA9ldaLNrr6LEKBQGMLKnfUQLl2tzCP885iABg3x+Zu +aYgR6Rty3IQWO7EPmdDP53b+uqmZlra/3N6d8gY5AoIBADxkBk23hEQSlg7f3qbC +vhONo+bBzgzLAcZY05h1V/QAONvB+lT2oJln+e9cFt3jOkb43NqeqAeBRoG0FmPx +kffSLpmt75Jq2AZTEFlfvOMOkPZbC10vr1gje/zV4xhKanqBAYhzyflWXZKx6Fc3 +6JbSzp7p/QzFMXbE9Fymj5FxcSiFjT9BQvZupyG/I52dWj/yvtXB4Uwq8gm2MDXq +BzeD4KnJ6pqKsANtELPGoHf7cQawRdexcyKsOwcVRHmHXtNP9H00nE081RRjkzcX +3mqSAhGXcC7xjJMC8qAiN2g4QnV1pf8ul2/bQPpnd2BR3Leyu9SMcIxrPPG1J3XU +9eECggEBAMMhMURUfLSXIkreMfxH4rSqk0r2xQ1rE1ChAIBQPfyx4KWUkBTdpoiv +uKcPzAgN+bm3Y5wRGwoE22Ac0lWobnzaIYyYN9N7HU+86q92ozWW1lCUEE0kBt2r +FnWCD/3B0LOX2Cn8HHYzroRmzMlRvBa7/GO1dqURz/OzjTWN0+k9mgE7oS5M8fQV +AS3mxXZMPKSB0xTfJoXW8ui9MQZHcNSkNORNP/2doCkR2qDUkazbhi/3ghLmDGVJ +p5OrIPQUwcp1bFOciX22fAaZwoa63ng3K+WZjSqqma05AiOc59MhDLAu6a0rKKO1 +W3079UVfBB4hkfN2721fqyj+r/0z+R0= +-----END PRIVATE KEY----- diff --git a/tests/compose/core/email_test.py b/tests/compose/core/email_test.py new file mode 100755 index 00000000..c16ce9d8 --- /dev/null +++ b/tests/compose/core/email_test.py @@ -0,0 +1,55 @@ +import string +import random +import smtplib +import imaplib +import time + +def secret(length=16): + charset = string.ascii_uppercase + string.digits + return ''.join( + random.SystemRandom().choice(charset) + for _ in range(length) + ) + +#Generating secret message +secret_message = secret(16) + +#Login to smt server and sending email with secret message +def send_email(msg): + print("Sending email ...") + server = smtplib.SMTP('localhost') + server.set_debuglevel(1) + server.connect('localhost', 587) + server.ehlo() + server.starttls() + server.ehlo() + server.login("admin@mailu.io", "password") + + server.sendmail("admin@mailu.io", "user@mailu.io", msg) + server.quit() + + print("email sent with message " + msg) + +#Login to imap server, read latest email and check for secret message +def read_email(): + print("Receiving email ...") + server = imaplib.IMAP4_SSL('localhost') + server.login('user@mailu.io', 'password') + + stat, count = server.select('inbox') + stat, data = server.fetch(count[0], '(UID BODY[TEXT])') + + print("email received with message " + str(data[0][1])) + + if secret_message in str(data[0][1]): + print("Success!") + else: + print("Failed! Something went wrong") + server.close() + server.logout() + + +send_email(secret_message) +print("Sleeping for 1m") +time.sleep(60) +read_email() diff --git a/tests/compose/core/mailu.env b/tests/compose/core/mailu.env index dabd523f..9a744e35 100644 --- a/tests/compose/core/mailu.env +++ b/tests/compose/core/mailu.env @@ -29,7 +29,7 @@ SECRET_KEY=HGZCYGVI6FVG31HS DOMAIN=mailu.io # Hostnames for this server, separated with comas -HOSTNAMES=mail.mailu.io +HOSTNAMES=localhost # Postmaster local part (will append the main mail domain) POSTMASTER=admin diff --git a/tests/compose/fetchmail/email_test.py b/tests/compose/fetchmail/email_test.py new file mode 100755 index 00000000..c16ce9d8 --- /dev/null +++ b/tests/compose/fetchmail/email_test.py @@ -0,0 +1,55 @@ +import string +import random +import smtplib +import imaplib +import time + +def secret(length=16): + charset = string.ascii_uppercase + string.digits + return ''.join( + random.SystemRandom().choice(charset) + for _ in range(length) + ) + +#Generating secret message +secret_message = secret(16) + +#Login to smt server and sending email with secret message +def send_email(msg): + print("Sending email ...") + server = smtplib.SMTP('localhost') + server.set_debuglevel(1) + server.connect('localhost', 587) + server.ehlo() + server.starttls() + server.ehlo() + server.login("admin@mailu.io", "password") + + server.sendmail("admin@mailu.io", "user@mailu.io", msg) + server.quit() + + print("email sent with message " + msg) + +#Login to imap server, read latest email and check for secret message +def read_email(): + print("Receiving email ...") + server = imaplib.IMAP4_SSL('localhost') + server.login('user@mailu.io', 'password') + + stat, count = server.select('inbox') + stat, data = server.fetch(count[0], '(UID BODY[TEXT])') + + print("email received with message " + str(data[0][1])) + + if secret_message in str(data[0][1]): + print("Success!") + else: + print("Failed! Something went wrong") + server.close() + server.logout() + + +send_email(secret_message) +print("Sleeping for 1m") +time.sleep(60) +read_email() diff --git a/tests/compose/fetchmail/mailu.env b/tests/compose/fetchmail/mailu.env index ef78508b..a987c853 100644 --- a/tests/compose/fetchmail/mailu.env +++ b/tests/compose/fetchmail/mailu.env @@ -29,7 +29,7 @@ SECRET_KEY=JS48Q9KE3B6T97E6 DOMAIN=mailu.io # Hostnames for this server, separated with comas -HOSTNAMES=mail.mailu.io +HOSTNAMES=localhost # Postmaster local part (will append the main mail domain) POSTMASTER=admin diff --git a/tests/compose/filters/email_test.py b/tests/compose/filters/email_test.py new file mode 100755 index 00000000..c16ce9d8 --- /dev/null +++ b/tests/compose/filters/email_test.py @@ -0,0 +1,55 @@ +import string +import random +import smtplib +import imaplib +import time + +def secret(length=16): + charset = string.ascii_uppercase + string.digits + return ''.join( + random.SystemRandom().choice(charset) + for _ in range(length) + ) + +#Generating secret message +secret_message = secret(16) + +#Login to smt server and sending email with secret message +def send_email(msg): + print("Sending email ...") + server = smtplib.SMTP('localhost') + server.set_debuglevel(1) + server.connect('localhost', 587) + server.ehlo() + server.starttls() + server.ehlo() + server.login("admin@mailu.io", "password") + + server.sendmail("admin@mailu.io", "user@mailu.io", msg) + server.quit() + + print("email sent with message " + msg) + +#Login to imap server, read latest email and check for secret message +def read_email(): + print("Receiving email ...") + server = imaplib.IMAP4_SSL('localhost') + server.login('user@mailu.io', 'password') + + stat, count = server.select('inbox') + stat, data = server.fetch(count[0], '(UID BODY[TEXT])') + + print("email received with message " + str(data[0][1])) + + if secret_message in str(data[0][1]): + print("Success!") + else: + print("Failed! Something went wrong") + server.close() + server.logout() + + +send_email(secret_message) +print("Sleeping for 1m") +time.sleep(60) +read_email() diff --git a/tests/compose/filters/mailu.env b/tests/compose/filters/mailu.env index ab97e191..8609a287 100644 --- a/tests/compose/filters/mailu.env +++ b/tests/compose/filters/mailu.env @@ -29,7 +29,7 @@ SECRET_KEY=11H6XURLGE7GW3U1 DOMAIN=mailu.io # Hostnames for this server, separated with comas -HOSTNAMES=mail.mailu.io +HOSTNAMES=localhost # Postmaster local part (will append the main mail domain) POSTMASTER=admin diff --git a/tests/compose/rainloop/email_test.py b/tests/compose/rainloop/email_test.py new file mode 100755 index 00000000..c16ce9d8 --- /dev/null +++ b/tests/compose/rainloop/email_test.py @@ -0,0 +1,55 @@ +import string +import random +import smtplib +import imaplib +import time + +def secret(length=16): + charset = string.ascii_uppercase + string.digits + return ''.join( + random.SystemRandom().choice(charset) + for _ in range(length) + ) + +#Generating secret message +secret_message = secret(16) + +#Login to smt server and sending email with secret message +def send_email(msg): + print("Sending email ...") + server = smtplib.SMTP('localhost') + server.set_debuglevel(1) + server.connect('localhost', 587) + server.ehlo() + server.starttls() + server.ehlo() + server.login("admin@mailu.io", "password") + + server.sendmail("admin@mailu.io", "user@mailu.io", msg) + server.quit() + + print("email sent with message " + msg) + +#Login to imap server, read latest email and check for secret message +def read_email(): + print("Receiving email ...") + server = imaplib.IMAP4_SSL('localhost') + server.login('user@mailu.io', 'password') + + stat, count = server.select('inbox') + stat, data = server.fetch(count[0], '(UID BODY[TEXT])') + + print("email received with message " + str(data[0][1])) + + if secret_message in str(data[0][1]): + print("Success!") + else: + print("Failed! Something went wrong") + server.close() + server.logout() + + +send_email(secret_message) +print("Sleeping for 1m") +time.sleep(60) +read_email() diff --git a/tests/compose/rainloop/mailu.env b/tests/compose/rainloop/mailu.env index 747dac58..678ea048 100644 --- a/tests/compose/rainloop/mailu.env +++ b/tests/compose/rainloop/mailu.env @@ -29,7 +29,7 @@ SECRET_KEY=V5J4SHRYVW9PZIQU DOMAIN=mailu.io # Hostnames for this server, separated with comas -HOSTNAMES=mail.mailu.io +HOSTNAMES=localhost # Postmaster local part (will append the main mail domain) POSTMASTER=admin diff --git a/tests/compose/roundcube/email_test.py b/tests/compose/roundcube/email_test.py new file mode 100755 index 00000000..c16ce9d8 --- /dev/null +++ b/tests/compose/roundcube/email_test.py @@ -0,0 +1,55 @@ +import string +import random +import smtplib +import imaplib +import time + +def secret(length=16): + charset = string.ascii_uppercase + string.digits + return ''.join( + random.SystemRandom().choice(charset) + for _ in range(length) + ) + +#Generating secret message +secret_message = secret(16) + +#Login to smt server and sending email with secret message +def send_email(msg): + print("Sending email ...") + server = smtplib.SMTP('localhost') + server.set_debuglevel(1) + server.connect('localhost', 587) + server.ehlo() + server.starttls() + server.ehlo() + server.login("admin@mailu.io", "password") + + server.sendmail("admin@mailu.io", "user@mailu.io", msg) + server.quit() + + print("email sent with message " + msg) + +#Login to imap server, read latest email and check for secret message +def read_email(): + print("Receiving email ...") + server = imaplib.IMAP4_SSL('localhost') + server.login('user@mailu.io', 'password') + + stat, count = server.select('inbox') + stat, data = server.fetch(count[0], '(UID BODY[TEXT])') + + print("email received with message " + str(data[0][1])) + + if secret_message in str(data[0][1]): + print("Success!") + else: + print("Failed! Something went wrong") + server.close() + server.logout() + + +send_email(secret_message) +print("Sleeping for 1m") +time.sleep(60) +read_email() diff --git a/tests/compose/roundcube/mailu.env b/tests/compose/roundcube/mailu.env index e87d1f61..b8a8b266 100644 --- a/tests/compose/roundcube/mailu.env +++ b/tests/compose/roundcube/mailu.env @@ -29,7 +29,7 @@ SECRET_KEY=PGGO2JRQ59QV3DW7 DOMAIN=mailu.io # Hostnames for this server, separated with comas -HOSTNAMES=mail.mailu.io +HOSTNAMES=localhost # Postmaster local part (will append the main mail domain) POSTMASTER=admin diff --git a/tests/compose/test.py b/tests/compose/test.py index 819c7222..d3b2d109 100755 --- a/tests/compose/test.py +++ b/tests/compose/test.py @@ -74,8 +74,19 @@ def hooks(): os.system("python3 " + test_path + test_file) elif test_file.endswith(".sh"): os.system("./" + test_path + test_file) - + +#Create admin and user +def create_users(): + print("Creating admin account...") + os.system("docker-compose -p $DOCKER_ORG exec admin python manage.py admin admin mailu.io password") + print("Admin account created") + print("Creating user account...") + os.system("docker-compose -p $DOCKER_ORG exec admin python manage.py user --hash_scheme='SHA512-CRYPT' user mailu.io 'password'") + print("User account created") + # Start up containers +os.system("mkdir -p /mailu && cp -r tests/certs /mailu") +os.system("chmod 600 /mailu/certs/* ") os.system("docker-compose -f " + compose_file + " -p ${DOCKER_ORG:-mailu} up -d ") print() sleep() @@ -84,6 +95,7 @@ os.system("docker ps -a") print() health_checks() print() +create_users() hooks() print() stop(0) diff --git a/tests/compose/webdav/email_test.py b/tests/compose/webdav/email_test.py new file mode 100755 index 00000000..c16ce9d8 --- /dev/null +++ b/tests/compose/webdav/email_test.py @@ -0,0 +1,55 @@ +import string +import random +import smtplib +import imaplib +import time + +def secret(length=16): + charset = string.ascii_uppercase + string.digits + return ''.join( + random.SystemRandom().choice(charset) + for _ in range(length) + ) + +#Generating secret message +secret_message = secret(16) + +#Login to smt server and sending email with secret message +def send_email(msg): + print("Sending email ...") + server = smtplib.SMTP('localhost') + server.set_debuglevel(1) + server.connect('localhost', 587) + server.ehlo() + server.starttls() + server.ehlo() + server.login("admin@mailu.io", "password") + + server.sendmail("admin@mailu.io", "user@mailu.io", msg) + server.quit() + + print("email sent with message " + msg) + +#Login to imap server, read latest email and check for secret message +def read_email(): + print("Receiving email ...") + server = imaplib.IMAP4_SSL('localhost') + server.login('user@mailu.io', 'password') + + stat, count = server.select('inbox') + stat, data = server.fetch(count[0], '(UID BODY[TEXT])') + + print("email received with message " + str(data[0][1])) + + if secret_message in str(data[0][1]): + print("Success!") + else: + print("Failed! Something went wrong") + server.close() + server.logout() + + +send_email(secret_message) +print("Sleeping for 1m") +time.sleep(60) +read_email() diff --git a/tests/compose/webdav/mailu.env b/tests/compose/webdav/mailu.env index ac7b434c..21dd3981 100644 --- a/tests/compose/webdav/mailu.env +++ b/tests/compose/webdav/mailu.env @@ -29,7 +29,7 @@ SECRET_KEY=XVDDSWOAGVF5J9QJ DOMAIN=mailu.io # Hostnames for this server, separated with comas -HOSTNAMES=mail.mailu.io +HOSTNAMES=localhost # Postmaster local part (will append the main mail domain) POSTMASTER=admin From c3bc7988c90d25d65d1eb8d2142a58686bacab40 Mon Sep 17 00:00:00 2001 From: Ionut Filip Date: Fri, 2 Nov 2018 14:27:46 +0200 Subject: [PATCH 17/28] Implemented email test for travis --- .travis.yml | 4 ++ tests/compose/{core => }/email_test.py | 0 tests/compose/fetchmail/email_test.py | 55 -------------------------- tests/compose/filters/email_test.py | 55 -------------------------- tests/compose/rainloop/email_test.py | 55 -------------------------- tests/compose/roundcube/email_test.py | 55 -------------------------- tests/compose/test.py | 15 ++----- tests/compose/webdav/email_test.py | 55 -------------------------- 8 files changed, 7 insertions(+), 287 deletions(-) rename tests/compose/{core => }/email_test.py (100%) delete mode 100755 tests/compose/fetchmail/email_test.py delete mode 100755 tests/compose/filters/email_test.py delete mode 100755 tests/compose/rainloop/email_test.py delete mode 100755 tests/compose/roundcube/email_test.py delete mode 100755 tests/compose/webdav/email_test.py diff --git a/.travis.yml b/.travis.yml index 54b3b3c7..ffb6af43 100644 --- a/.travis.yml +++ b/.travis.yml @@ -18,6 +18,10 @@ install: before_script: - docker-compose -v - docker-compose -f tests/build.yml build + - docker-compose up -d admin + - docker-compose exec admin python manage.py admin admin mailu.io password + - docker-compose exec admin python manage.py user --hash_scheme='SHA512-CRYPT' user mailu.io 'password' + - docker-compose down script: # test.py, test name and timeout between start and tests. diff --git a/tests/compose/core/email_test.py b/tests/compose/email_test.py similarity index 100% rename from tests/compose/core/email_test.py rename to tests/compose/email_test.py diff --git a/tests/compose/fetchmail/email_test.py b/tests/compose/fetchmail/email_test.py deleted file mode 100755 index c16ce9d8..00000000 --- a/tests/compose/fetchmail/email_test.py +++ /dev/null @@ -1,55 +0,0 @@ -import string -import random -import smtplib -import imaplib -import time - -def secret(length=16): - charset = string.ascii_uppercase + string.digits - return ''.join( - random.SystemRandom().choice(charset) - for _ in range(length) - ) - -#Generating secret message -secret_message = secret(16) - -#Login to smt server and sending email with secret message -def send_email(msg): - print("Sending email ...") - server = smtplib.SMTP('localhost') - server.set_debuglevel(1) - server.connect('localhost', 587) - server.ehlo() - server.starttls() - server.ehlo() - server.login("admin@mailu.io", "password") - - server.sendmail("admin@mailu.io", "user@mailu.io", msg) - server.quit() - - print("email sent with message " + msg) - -#Login to imap server, read latest email and check for secret message -def read_email(): - print("Receiving email ...") - server = imaplib.IMAP4_SSL('localhost') - server.login('user@mailu.io', 'password') - - stat, count = server.select('inbox') - stat, data = server.fetch(count[0], '(UID BODY[TEXT])') - - print("email received with message " + str(data[0][1])) - - if secret_message in str(data[0][1]): - print("Success!") - else: - print("Failed! Something went wrong") - server.close() - server.logout() - - -send_email(secret_message) -print("Sleeping for 1m") -time.sleep(60) -read_email() diff --git a/tests/compose/filters/email_test.py b/tests/compose/filters/email_test.py deleted file mode 100755 index c16ce9d8..00000000 --- a/tests/compose/filters/email_test.py +++ /dev/null @@ -1,55 +0,0 @@ -import string -import random -import smtplib -import imaplib -import time - -def secret(length=16): - charset = string.ascii_uppercase + string.digits - return ''.join( - random.SystemRandom().choice(charset) - for _ in range(length) - ) - -#Generating secret message -secret_message = secret(16) - -#Login to smt server and sending email with secret message -def send_email(msg): - print("Sending email ...") - server = smtplib.SMTP('localhost') - server.set_debuglevel(1) - server.connect('localhost', 587) - server.ehlo() - server.starttls() - server.ehlo() - server.login("admin@mailu.io", "password") - - server.sendmail("admin@mailu.io", "user@mailu.io", msg) - server.quit() - - print("email sent with message " + msg) - -#Login to imap server, read latest email and check for secret message -def read_email(): - print("Receiving email ...") - server = imaplib.IMAP4_SSL('localhost') - server.login('user@mailu.io', 'password') - - stat, count = server.select('inbox') - stat, data = server.fetch(count[0], '(UID BODY[TEXT])') - - print("email received with message " + str(data[0][1])) - - if secret_message in str(data[0][1]): - print("Success!") - else: - print("Failed! Something went wrong") - server.close() - server.logout() - - -send_email(secret_message) -print("Sleeping for 1m") -time.sleep(60) -read_email() diff --git a/tests/compose/rainloop/email_test.py b/tests/compose/rainloop/email_test.py deleted file mode 100755 index c16ce9d8..00000000 --- a/tests/compose/rainloop/email_test.py +++ /dev/null @@ -1,55 +0,0 @@ -import string -import random -import smtplib -import imaplib -import time - -def secret(length=16): - charset = string.ascii_uppercase + string.digits - return ''.join( - random.SystemRandom().choice(charset) - for _ in range(length) - ) - -#Generating secret message -secret_message = secret(16) - -#Login to smt server and sending email with secret message -def send_email(msg): - print("Sending email ...") - server = smtplib.SMTP('localhost') - server.set_debuglevel(1) - server.connect('localhost', 587) - server.ehlo() - server.starttls() - server.ehlo() - server.login("admin@mailu.io", "password") - - server.sendmail("admin@mailu.io", "user@mailu.io", msg) - server.quit() - - print("email sent with message " + msg) - -#Login to imap server, read latest email and check for secret message -def read_email(): - print("Receiving email ...") - server = imaplib.IMAP4_SSL('localhost') - server.login('user@mailu.io', 'password') - - stat, count = server.select('inbox') - stat, data = server.fetch(count[0], '(UID BODY[TEXT])') - - print("email received with message " + str(data[0][1])) - - if secret_message in str(data[0][1]): - print("Success!") - else: - print("Failed! Something went wrong") - server.close() - server.logout() - - -send_email(secret_message) -print("Sleeping for 1m") -time.sleep(60) -read_email() diff --git a/tests/compose/roundcube/email_test.py b/tests/compose/roundcube/email_test.py deleted file mode 100755 index c16ce9d8..00000000 --- a/tests/compose/roundcube/email_test.py +++ /dev/null @@ -1,55 +0,0 @@ -import string -import random -import smtplib -import imaplib -import time - -def secret(length=16): - charset = string.ascii_uppercase + string.digits - return ''.join( - random.SystemRandom().choice(charset) - for _ in range(length) - ) - -#Generating secret message -secret_message = secret(16) - -#Login to smt server and sending email with secret message -def send_email(msg): - print("Sending email ...") - server = smtplib.SMTP('localhost') - server.set_debuglevel(1) - server.connect('localhost', 587) - server.ehlo() - server.starttls() - server.ehlo() - server.login("admin@mailu.io", "password") - - server.sendmail("admin@mailu.io", "user@mailu.io", msg) - server.quit() - - print("email sent with message " + msg) - -#Login to imap server, read latest email and check for secret message -def read_email(): - print("Receiving email ...") - server = imaplib.IMAP4_SSL('localhost') - server.login('user@mailu.io', 'password') - - stat, count = server.select('inbox') - stat, data = server.fetch(count[0], '(UID BODY[TEXT])') - - print("email received with message " + str(data[0][1])) - - if secret_message in str(data[0][1]): - print("Success!") - else: - print("Failed! Something went wrong") - server.close() - server.logout() - - -send_email(secret_message) -print("Sleeping for 1m") -time.sleep(60) -read_email() diff --git a/tests/compose/test.py b/tests/compose/test.py index d3b2d109..84281123 100755 --- a/tests/compose/test.py +++ b/tests/compose/test.py @@ -17,7 +17,7 @@ containers = [] # Stop containers def stop(exit_code): print_logs() - os.system("docker-compose -f " + compose_file + " -p ${DOCKER_ORG:-mailu} down") + os.system("docker-compose -f " + compose_file + " down") sys.exit(exit_code) # Sleep for a defined amount of time @@ -69,25 +69,17 @@ def print_logs(): #Iterating over hooks in test folder and running them def hooks(): print("Running hooks") + os.system("python3 tests/compose/email_test.py") for test_file in sorted(os.listdir(test_path)): if test_file.endswith(".py"): os.system("python3 " + test_path + test_file) elif test_file.endswith(".sh"): os.system("./" + test_path + test_file) -#Create admin and user -def create_users(): - print("Creating admin account...") - os.system("docker-compose -p $DOCKER_ORG exec admin python manage.py admin admin mailu.io password") - print("Admin account created") - print("Creating user account...") - os.system("docker-compose -p $DOCKER_ORG exec admin python manage.py user --hash_scheme='SHA512-CRYPT' user mailu.io 'password'") - print("User account created") - # Start up containers os.system("mkdir -p /mailu && cp -r tests/certs /mailu") os.system("chmod 600 /mailu/certs/* ") -os.system("docker-compose -f " + compose_file + " -p ${DOCKER_ORG:-mailu} up -d ") +os.system("docker-compose -f " + compose_file + " up -d ") print() sleep() print() @@ -95,7 +87,6 @@ os.system("docker ps -a") print() health_checks() print() -create_users() hooks() print() stop(0) diff --git a/tests/compose/webdav/email_test.py b/tests/compose/webdav/email_test.py deleted file mode 100755 index c16ce9d8..00000000 --- a/tests/compose/webdav/email_test.py +++ /dev/null @@ -1,55 +0,0 @@ -import string -import random -import smtplib -import imaplib -import time - -def secret(length=16): - charset = string.ascii_uppercase + string.digits - return ''.join( - random.SystemRandom().choice(charset) - for _ in range(length) - ) - -#Generating secret message -secret_message = secret(16) - -#Login to smt server and sending email with secret message -def send_email(msg): - print("Sending email ...") - server = smtplib.SMTP('localhost') - server.set_debuglevel(1) - server.connect('localhost', 587) - server.ehlo() - server.starttls() - server.ehlo() - server.login("admin@mailu.io", "password") - - server.sendmail("admin@mailu.io", "user@mailu.io", msg) - server.quit() - - print("email sent with message " + msg) - -#Login to imap server, read latest email and check for secret message -def read_email(): - print("Receiving email ...") - server = imaplib.IMAP4_SSL('localhost') - server.login('user@mailu.io', 'password') - - stat, count = server.select('inbox') - stat, data = server.fetch(count[0], '(UID BODY[TEXT])') - - print("email received with message " + str(data[0][1])) - - if secret_message in str(data[0][1]): - print("Success!") - else: - print("Failed! Something went wrong") - server.close() - server.logout() - - -send_email(secret_message) -print("Sleeping for 1m") -time.sleep(60) -read_email() From 88f5e6e4cff54757bbbd3bd8653d8f8cad7bee51 Mon Sep 17 00:00:00 2001 From: Ionut Filip Date: Fri, 2 Nov 2018 15:05:16 +0200 Subject: [PATCH 18/28] Moved users creation in core --- .travis.yml | 4 ---- tests/compose/core/00_create_users.sh | 3 +++ tests/compose/test.py | 21 +++++++++++---------- 3 files changed, 14 insertions(+), 14 deletions(-) create mode 100755 tests/compose/core/00_create_users.sh diff --git a/.travis.yml b/.travis.yml index ffb6af43..54b3b3c7 100644 --- a/.travis.yml +++ b/.travis.yml @@ -18,10 +18,6 @@ install: before_script: - docker-compose -v - docker-compose -f tests/build.yml build - - docker-compose up -d admin - - docker-compose exec admin python manage.py admin admin mailu.io password - - docker-compose exec admin python manage.py user --hash_scheme='SHA512-CRYPT' user mailu.io 'password' - - docker-compose down script: # test.py, test name and timeout between start and tests. diff --git a/tests/compose/core/00_create_users.sh b/tests/compose/core/00_create_users.sh new file mode 100755 index 00000000..babe307d --- /dev/null +++ b/tests/compose/core/00_create_users.sh @@ -0,0 +1,3 @@ +echo "Creating users ..." +docker-compose -f tests/compose/core/docker-compose.yml exec admin python manage.py admin admin mailu.io password || exit 1 +docker-compose -f tests/compose/core/docker-compose.yml exec admin python manage.py user --hash_scheme='SHA512-CRYPT' user mailu.io 'password' || exit 1 diff --git a/tests/compose/test.py b/tests/compose/test.py index 84281123..c90f481b 100755 --- a/tests/compose/test.py +++ b/tests/compose/test.py @@ -19,19 +19,19 @@ def stop(exit_code): print_logs() os.system("docker-compose -f " + compose_file + " down") sys.exit(exit_code) - + # Sleep for a defined amount of time def sleep(): print(Fore.LIGHTMAGENTA_EX + "Sleeping for " + str(timeout) + "m" + Style.RESET_ALL) time.sleep(timeout*60) - + def health_checks(): exit_code = 0 #Iterating trough all containers dictionary for container in client.containers(all=True): #Perform "docker container inspect" on container based on container ID and save output to a dictionary container_inspect = client.inspect_container(container['Id']) #Dict - + if "Health" in container_inspect['State'].keys(): if container_inspect['State']['Health']['Status'] == "healthy": print(Fore.GREEN + "Health status for " + container_inspect['Name'].replace("/", "") + " : " + Fore.CYAN + container_inspect['State']['Health']['Status'] + Style.RESET_ALL) @@ -46,36 +46,37 @@ def health_checks(): if container_inspect['State']['Status'] != "running": print(Fore.RED + "Container " + container_inspect['Name'].replace("/", "") + " state is: " + Fore.YELLOW + container_inspect['State']['Status'] + Style.RESET_ALL) exit_code = 1 - + #Saving Id, Name and state to a new dictionary containers_dict = {} containers_dict['Name'] = container_inspect['Name'].replace("/", "") containers_dict['Id'] = container_inspect['Id'] containers_dict['State'] = container_inspect['State'] - + #Adding the generated dictionary to a list containers.append(containers_dict) - + if exit_code != 0: stop(exit_code) - + def print_logs(): print("Printing logs ...") #Iterating through docker container inspect list and print logs for container in containers: print(Fore.LIGHTMAGENTA_EX + "Printing logs for: " + Fore.GREEN + container['Name'] + Style.RESET_ALL) os.system('docker container logs ' + container['Name']) - -#Iterating over hooks in test folder and running them + +#Iterating over hooks in test folder and running them def hooks(): print("Running hooks") - os.system("python3 tests/compose/email_test.py") for test_file in sorted(os.listdir(test_path)): if test_file.endswith(".py"): os.system("python3 " + test_path + test_file) elif test_file.endswith(".sh"): os.system("./" + test_path + test_file) + os.system("python3 tests/compose/email_test.py") + # Start up containers os.system("mkdir -p /mailu && cp -r tests/certs /mailu") os.system("chmod 600 /mailu/certs/* ") From fd8ed3dfa6c901bd2a493d64042ac5a6e3c4bd39 Mon Sep 17 00:00:00 2001 From: Ionut Filip Date: Fri, 2 Nov 2018 15:17:59 +0200 Subject: [PATCH 19/28] Moved certs copy in travis --- .travis.yml | 3 ++- tests/compose/test.py | 2 -- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/.travis.yml b/.travis.yml index 54b3b3c7..a0762280 100644 --- a/.travis.yml +++ b/.travis.yml @@ -18,7 +18,8 @@ install: before_script: - docker-compose -v - docker-compose -f tests/build.yml build - + - mkdir -p /mailu && sudo cp -r tests/certs /mailu && chmod 600 /mailu/certs/* + script: # test.py, test name and timeout between start and tests. - python tests/compose/test.py core 1 diff --git a/tests/compose/test.py b/tests/compose/test.py index c90f481b..a44382a1 100755 --- a/tests/compose/test.py +++ b/tests/compose/test.py @@ -78,8 +78,6 @@ def hooks(): os.system("python3 tests/compose/email_test.py") # Start up containers -os.system("mkdir -p /mailu && cp -r tests/certs /mailu") -os.system("chmod 600 /mailu/certs/* ") os.system("docker-compose -f " + compose_file + " up -d ") print() sleep() From 0d6a203a9d8009e8c7348f9f7692c748bf6fdba3 Mon Sep 17 00:00:00 2001 From: Ionut Filip Date: Fri, 2 Nov 2018 15:32:36 +0200 Subject: [PATCH 20/28] Use sudo for running sh commands --- .travis.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index a0762280..22e024ec 100644 --- a/.travis.yml +++ b/.travis.yml @@ -18,7 +18,7 @@ install: before_script: - docker-compose -v - docker-compose -f tests/build.yml build - - mkdir -p /mailu && sudo cp -r tests/certs /mailu && chmod 600 /mailu/certs/* + - sudo -- sh -c 'mkdir -p /mailu && cp -r tests/certs /mailu && chmod 600 /mailu/certs/*' script: # test.py, test name and timeout between start and tests. From 982e586e499a6bc30e1961882ba2c14291e71396 Mon Sep 17 00:00:00 2001 From: Ionut Filip Date: Fri, 2 Nov 2018 16:25:55 +0200 Subject: [PATCH 21/28] Replaced os.system calls with native python calls --- tests/compose/core/00_create_users.sh | 1 + tests/compose/test.py | 14 +++++++------- 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/tests/compose/core/00_create_users.sh b/tests/compose/core/00_create_users.sh index babe307d..fd998a15 100755 --- a/tests/compose/core/00_create_users.sh +++ b/tests/compose/core/00_create_users.sh @@ -1,3 +1,4 @@ echo "Creating users ..." docker-compose -f tests/compose/core/docker-compose.yml exec admin python manage.py admin admin mailu.io password || exit 1 docker-compose -f tests/compose/core/docker-compose.yml exec admin python manage.py user --hash_scheme='SHA512-CRYPT' user mailu.io 'password' || exit 1 +echo "Admin and user successfully created!" \ No newline at end of file diff --git a/tests/compose/test.py b/tests/compose/test.py index a44382a1..7172aab9 100755 --- a/tests/compose/test.py +++ b/tests/compose/test.py @@ -17,7 +17,7 @@ containers = [] # Stop containers def stop(exit_code): print_logs() - os.system("docker-compose -f " + compose_file + " down") + print(os.popen("docker-compose -f " + compose_file + " down").read()) sys.exit(exit_code) # Sleep for a defined amount of time @@ -64,25 +64,25 @@ def print_logs(): #Iterating through docker container inspect list and print logs for container in containers: print(Fore.LIGHTMAGENTA_EX + "Printing logs for: " + Fore.GREEN + container['Name'] + Style.RESET_ALL) - os.system('docker container logs ' + container['Name']) + print(os.popen('docker container logs ' + container['Name']).read()) #Iterating over hooks in test folder and running them def hooks(): print("Running hooks") for test_file in sorted(os.listdir(test_path)): if test_file.endswith(".py"): - os.system("python3 " + test_path + test_file) + print(os.popen("python3 " + test_path + test_file).read()) elif test_file.endswith(".sh"): - os.system("./" + test_path + test_file) + print(os.popen("./" + test_path + test_file).read()) - os.system("python3 tests/compose/email_test.py") + print(os.popen("python3 tests/compose/email_test.py").read()) # Start up containers -os.system("docker-compose -f " + compose_file + " up -d ") +print(os.popen("docker-compose -f " + compose_file + " up -d ").read()) print() sleep() print() -os.system("docker ps -a") +print(os.popen("docker ps -a").read()) print() health_checks() print() From 9a7fc1416a29d81faac7710aaa7c796cbe33bb05 Mon Sep 17 00:00:00 2001 From: Ionut Filip Date: Sat, 3 Nov 2018 19:15:05 +0200 Subject: [PATCH 22/28] Replaces os.popen with subprocess.check_output --- tests/compose/test.py | 15 ++++++++------- tests/{compose => }/email_test.py | 4 +++- 2 files changed, 11 insertions(+), 8 deletions(-) rename tests/{compose => }/email_test.py (94%) diff --git a/tests/compose/test.py b/tests/compose/test.py index 7172aab9..b04bad00 100755 --- a/tests/compose/test.py +++ b/tests/compose/test.py @@ -3,6 +3,7 @@ import os import time import docker from colorama import Fore, Style +import subprocess # Declare variables for service name and sleep time test_name=sys.argv[1] @@ -17,7 +18,7 @@ containers = [] # Stop containers def stop(exit_code): print_logs() - print(os.popen("docker-compose -f " + compose_file + " down").read()) + print(subprocess.check_output("docker-compose -f " + compose_file + " down", shell=True)) sys.exit(exit_code) # Sleep for a defined amount of time @@ -64,25 +65,25 @@ def print_logs(): #Iterating through docker container inspect list and print logs for container in containers: print(Fore.LIGHTMAGENTA_EX + "Printing logs for: " + Fore.GREEN + container['Name'] + Style.RESET_ALL) - print(os.popen('docker container logs ' + container['Name']).read()) + print(subprocess.check_output('docker container logs ' + container['Name'], shell=True)) #Iterating over hooks in test folder and running them def hooks(): print("Running hooks") for test_file in sorted(os.listdir(test_path)): if test_file.endswith(".py"): - print(os.popen("python3 " + test_path + test_file).read()) + print(subprocess.check_output("python3 " + test_path + test_file, shell=True)) elif test_file.endswith(".sh"): - print(os.popen("./" + test_path + test_file).read()) + print(subprocess.check_output("./" + test_path + test_file, shell=True)) - print(os.popen("python3 tests/compose/email_test.py").read()) + print(subprocess.check_output("python3 tests/email_test.py", shell=True)) # Start up containers -print(os.popen("docker-compose -f " + compose_file + " up -d ").read()) +print(subprocess.check_output("docker-compose -f " + compose_file + " up -d", shell=True)) print() sleep() print() -print(os.popen("docker ps -a").read()) +print(subprocess.check_output("docker ps -a", shell=True)) print() health_checks() print() diff --git a/tests/compose/email_test.py b/tests/email_test.py similarity index 94% rename from tests/compose/email_test.py rename to tests/email_test.py index c16ce9d8..c56c1f57 100755 --- a/tests/compose/email_test.py +++ b/tests/email_test.py @@ -3,6 +3,7 @@ import random import smtplib import imaplib import time +import sys def secret(length=16): charset = string.ascii_uppercase + string.digits @@ -44,7 +45,8 @@ def read_email(): if secret_message in str(data[0][1]): print("Success!") else: - print("Failed! Something went wrong") + print("Failed! Something went wrong") + sys.exit(1) server.close() server.logout() From fca3dc4e7005250a3a49028e2131b439663e0829 Mon Sep 17 00:00:00 2001 From: Ionut Filip Date: Sat, 3 Nov 2018 19:34:47 +0200 Subject: [PATCH 23/28] Flushing stream before calling subprocess --- tests/compose/test.py | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/tests/compose/test.py b/tests/compose/test.py index b04bad00..576e128d 100755 --- a/tests/compose/test.py +++ b/tests/compose/test.py @@ -18,6 +18,7 @@ containers = [] # Stop containers def stop(exit_code): print_logs() + sys.stdout.flush() print(subprocess.check_output("docker-compose -f " + compose_file + " down", shell=True)) sys.exit(exit_code) @@ -65,6 +66,7 @@ def print_logs(): #Iterating through docker container inspect list and print logs for container in containers: print(Fore.LIGHTMAGENTA_EX + "Printing logs for: " + Fore.GREEN + container['Name'] + Style.RESET_ALL) + sys.stdout.flush() print(subprocess.check_output('docker container logs ' + container['Name'], shell=True)) #Iterating over hooks in test folder and running them @@ -72,17 +74,22 @@ def hooks(): print("Running hooks") for test_file in sorted(os.listdir(test_path)): if test_file.endswith(".py"): + sys.stdout.flush() print(subprocess.check_output("python3 " + test_path + test_file, shell=True)) elif test_file.endswith(".sh"): + sys.stdout.flush() print(subprocess.check_output("./" + test_path + test_file, shell=True)) - + + sys.stdout.flush() print(subprocess.check_output("python3 tests/email_test.py", shell=True)) # Start up containers +sys.stdout.flush() print(subprocess.check_output("docker-compose -f " + compose_file + " up -d", shell=True)) print() sleep() print() +sys.stdout.flush() print(subprocess.check_output("docker ps -a", shell=True)) print() health_checks() From 4032e7128d2093cf12a0557cca25503ed1b19d9b Mon Sep 17 00:00:00 2001 From: Ionut Filip Date: Mon, 5 Nov 2018 12:34:52 +0200 Subject: [PATCH 24/28] Calling email test as hook with msg as arg --- tests/compose/core/01_email_test.sh | 1 + tests/compose/filters/01_email_test.sh | 1 + tests/compose/test.py | 29 +++++++++++++------------- tests/email_test.py | 18 ++++------------ 4 files changed, 21 insertions(+), 28 deletions(-) create mode 100755 tests/compose/core/01_email_test.sh create mode 100755 tests/compose/filters/01_email_test.sh diff --git a/tests/compose/core/01_email_test.sh b/tests/compose/core/01_email_test.sh new file mode 100755 index 00000000..97dd6e4b --- /dev/null +++ b/tests/compose/core/01_email_test.sh @@ -0,0 +1 @@ +python3 tests/email_test.py message-core \ No newline at end of file diff --git a/tests/compose/filters/01_email_test.sh b/tests/compose/filters/01_email_test.sh new file mode 100755 index 00000000..64fa3fba --- /dev/null +++ b/tests/compose/filters/01_email_test.sh @@ -0,0 +1 @@ +python3 tests/email_test.py message-filters \ No newline at end of file diff --git a/tests/compose/test.py b/tests/compose/test.py index 576e128d..690855d4 100755 --- a/tests/compose/test.py +++ b/tests/compose/test.py @@ -19,7 +19,7 @@ containers = [] def stop(exit_code): print_logs() sys.stdout.flush() - print(subprocess.check_output("docker-compose -f " + compose_file + " down", shell=True)) + print(subprocess.check_output("docker-compose -f " + compose_file + " down", shell=True).decode()) sys.exit(exit_code) # Sleep for a defined amount of time @@ -67,30 +67,31 @@ def print_logs(): for container in containers: print(Fore.LIGHTMAGENTA_EX + "Printing logs for: " + Fore.GREEN + container['Name'] + Style.RESET_ALL) sys.stdout.flush() - print(subprocess.check_output('docker container logs ' + container['Name'], shell=True)) + print(subprocess.check_output('docker container logs ' + container['Name'], shell=True).decode()) #Iterating over hooks in test folder and running them def hooks(): - print("Running hooks") + print(Fore.LIGHTMAGENTA_EX + "Running hooks" + Style.RESET_ALL) for test_file in sorted(os.listdir(test_path)): - if test_file.endswith(".py"): - sys.stdout.flush() - print(subprocess.check_output("python3 " + test_path + test_file, shell=True)) - elif test_file.endswith(".sh"): - sys.stdout.flush() - print(subprocess.check_output("./" + test_path + test_file, shell=True)) - - sys.stdout.flush() - print(subprocess.check_output("python3 tests/email_test.py", shell=True)) + try: + if test_file.endswith(".py"): + sys.stdout.flush() + print(subprocess.check_output("python3 " + test_path + test_file, shell=True).decode()) + elif test_file.endswith(".sh"): + sys.stdout.flush() + print(subprocess.check_output("./" + test_path + test_file, shell=True).decode()) + except subprocess.CalledProcessError as e: + sys.stderr.write("[ERROR]: output = %s, error code = %s\n" % (e.output.decode(), e.returncode)) + stop(1) # Start up containers sys.stdout.flush() -print(subprocess.check_output("docker-compose -f " + compose_file + " up -d", shell=True)) +print(subprocess.check_output("docker-compose -f " + compose_file + " up -d", shell=True).decode()) print() sleep() print() sys.stdout.flush() -print(subprocess.check_output("docker ps -a", shell=True)) +print(subprocess.check_output("docker ps -a", shell=True).decode()) print() health_checks() print() diff --git a/tests/email_test.py b/tests/email_test.py index c56c1f57..7148365e 100755 --- a/tests/email_test.py +++ b/tests/email_test.py @@ -1,19 +1,9 @@ -import string -import random import smtplib import imaplib import time import sys -def secret(length=16): - charset = string.ascii_uppercase + string.digits - return ''.join( - random.SystemRandom().choice(charset) - for _ in range(length) - ) - -#Generating secret message -secret_message = secret(16) +email_msg = sys.argv[1] #Login to smt server and sending email with secret message def send_email(msg): @@ -42,16 +32,16 @@ def read_email(): print("email received with message " + str(data[0][1])) - if secret_message in str(data[0][1]): + if email_msg in str(data[0][1]): print("Success!") else: - print("Failed! Something went wrong") + print("Failed receiving email with message %s" % email_msg) sys.exit(1) server.close() server.logout() -send_email(secret_message) +send_email(email_msg) print("Sleeping for 1m") time.sleep(60) read_email() From 76d9fc3865efb010c0dfc33f796df4af981bed8f Mon Sep 17 00:00:00 2001 From: Ionut Filip Date: Mon, 5 Nov 2018 17:28:40 +0200 Subject: [PATCH 25/28] Rewrite of email test script and added eicar virus file --- tests/compose/filters/01_email_test.sh | 7 ++- tests/compose/filters/eicar.com | 1 + tests/email_test.py | 86 +++++++++++++++----------- 3 files changed, 56 insertions(+), 38 deletions(-) create mode 100644 tests/compose/filters/eicar.com diff --git a/tests/compose/filters/01_email_test.sh b/tests/compose/filters/01_email_test.sh index 64fa3fba..5af395c4 100755 --- a/tests/compose/filters/01_email_test.sh +++ b/tests/compose/filters/01_email_test.sh @@ -1 +1,6 @@ -python3 tests/email_test.py message-filters \ No newline at end of file +python3 tests/email_test.py message-virus "tests/compose/filters/eicar.com" +if [ $? -eq 99 ]; then + exit 0 +else + exit 1 +fi \ No newline at end of file diff --git a/tests/compose/filters/eicar.com b/tests/compose/filters/eicar.com new file mode 100644 index 00000000..704cac85 --- /dev/null +++ b/tests/compose/filters/eicar.com @@ -0,0 +1 @@ +X5O!P%@AP[4\PZX54(P^)7CC)7}$EICAR-STANDARD-ANTIVIRUS-TEST-FILE!$H+H* diff --git a/tests/email_test.py b/tests/email_test.py index 7148365e..853b76b5 100755 --- a/tests/email_test.py +++ b/tests/email_test.py @@ -2,46 +2,58 @@ import smtplib import imaplib import time import sys +from email.mime.multipart import MIMEMultipart +from email.mime.text import MIMEText +import ntpath +from email.mime.base import MIMEBase +from email import encoders -email_msg = sys.argv[1] +msg = MIMEMultipart() +msg['From'] = "admin@mailu.io" +msg['To'] = "user@mailu.io" +msg['Subject'] = "File Test" +msg.attach(MIMEText(sys.argv[1], 'plain')) -#Login to smt server and sending email with secret message -def send_email(msg): - print("Sending email ...") - server = smtplib.SMTP('localhost') - server.set_debuglevel(1) - server.connect('localhost', 587) - server.ehlo() - server.starttls() - server.ehlo() - server.login("admin@mailu.io", "password") - - server.sendmail("admin@mailu.io", "user@mailu.io", msg) - server.quit() +if len(sys.argv) == 3: + part = MIMEBase('application', 'octet-stream') + part.set_payload((open(sys.argv[2], "rb")).read()) + encoders.encode_base64(part) + part.add_header('Content-Disposition', "attachment; filename=%s" % ntpath.basename(sys.argv[2])) + msg.attach(part) - print("email sent with message " + msg) +try: + smtp_server = smtplib.SMTP('localhost') + smtp_server.set_debuglevel(1) + smtp_server.connect('localhost', 587) + smtp_server.ehlo() + smtp_server.starttls() + smtp_server.ehlo() + smtp_server.login("admin@mailu.io", "password") + + smtp_server.sendmail("admin@mailu.io", "user@mailu.io", msg.as_string()) + smtp_server.quit() +except: + sys.exit(25) -#Login to imap server, read latest email and check for secret message -def read_email(): - print("Receiving email ...") - server = imaplib.IMAP4_SSL('localhost') - server.login('user@mailu.io', 'password') - - stat, count = server.select('inbox') - stat, data = server.fetch(count[0], '(UID BODY[TEXT])') - - print("email received with message " + str(data[0][1])) - - if email_msg in str(data[0][1]): - print("Success!") - else: - print("Failed receiving email with message %s" % email_msg) - sys.exit(1) - server.close() - server.logout() +time.sleep(30) +try: + imap_server = imaplib.IMAP4_SSL('localhost') + imap_server.login('user@mailu.io', 'password') +except: + sys.exit(110) + +stat, count = imap_server.select('inbox') +try: + stat, data = imap_server.fetch(count[0], '(UID BODY[TEXT])') +except : + sys.exit(99) + +if sys.argv[1] in str(data[0][1]): + print("Success sending and receiving email!") +else: + print("Failed receiving email with message %s" % sys.argv[1]) + sys.exit(99) -send_email(email_msg) -print("Sleeping for 1m") -time.sleep(60) -read_email() +imap_server.close() +imap_server.logout() From 2a76451a98edbf6d5f8feb02cc13f1577e75fcf9 Mon Sep 17 00:00:00 2001 From: Ionut Filip Date: Wed, 7 Nov 2018 16:41:11 +0200 Subject: [PATCH 26/28] Moved scripts to an external js file --- setup/Dockerfile | 1 + setup/static/render.js | 34 +++++++++++++++++++ .../templates/steps/compose/02_services.html | 22 ++---------- setup/templates/steps/config.html | 18 +--------- setup/templates/steps/stack/02_services.html | 21 +----------- 5 files changed, 39 insertions(+), 57 deletions(-) create mode 100644 setup/static/render.js diff --git a/setup/Dockerfile b/setup/Dockerfile index 83711af5..e39d7c3b 100644 --- a/setup/Dockerfile +++ b/setup/Dockerfile @@ -12,6 +12,7 @@ COPY setup.py ./setup.py COPY main.py ./main.py COPY flavors /data/master/flavors COPY templates /data/master/templates +COPY static ./static #RUN python setup.py https://github.com/mailu/mailu /data diff --git a/setup/static/render.js b/setup/static/render.js new file mode 100644 index 00000000..a1c3fb0d --- /dev/null +++ b/setup/static/render.js @@ -0,0 +1,34 @@ +$(document).ready(function() { + if ($("#webmail").val() == 'none') { + $("#webmail_path").hide(); + $("#webmail_path").attr("value", ""); + } else { + $("#webmail_path").show(); + $("#webmail_path").attr("value", "/webmail"); + } + $("#webmail").click(function() { + if (this.value == 'none') { + $("#webmail_path").hide(); + $("#webmail_path").attr("value", ""); + } else { + $("#webmail_path").show(); + $("#webmail_path").attr("value", "/webmail"); + } + }); +}); + +$(document).ready(function() { + if ($('#admin').prop('checked')) { + $("#admin_path").show(); + $("#admin_path").attr("value", "/admin"); + } + $("#admin").change(function() { + if ($(this).is(":checked")) { + $("#admin_path").show(); + $("#admin_path").attr("value", "/admin"); + } else { + $("#admin_path").hide(); + $("#admin_path").attr("value", ""); + } + }); +}); \ No newline at end of file diff --git a/setup/templates/steps/compose/02_services.html b/setup/templates/steps/compose/02_services.html index 53763658..11e7a14e 100644 --- a/setup/templates/steps/compose/02_services.html +++ b/setup/templates/steps/compose/02_services.html @@ -54,25 +54,7 @@ also disable the antivirus if required (it does use aroung 1GB of ram).

- + + {% endcall %} diff --git a/setup/templates/steps/config.html b/setup/templates/steps/config.html index a3352b7e..d843d684 100644 --- a/setup/templates/steps/config.html +++ b/setup/templates/steps/config.html @@ -75,22 +75,6 @@ manage your email domains, users, etc.

- + {% endcall %} diff --git a/setup/templates/steps/stack/02_services.html b/setup/templates/steps/stack/02_services.html index 53763658..36493e05 100644 --- a/setup/templates/steps/stack/02_services.html +++ b/setup/templates/steps/stack/02_services.html @@ -54,25 +54,6 @@ also disable the antivirus if required (it does use aroung 1GB of ram).

- + {% endcall %} From 2b6f5ea3d079440dacbcb1b5758babee17064e8c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim=20M=C3=B6hlmann?= Date: Sat, 1 Dec 2018 02:37:34 +0200 Subject: [PATCH 27/28] Update setup's own docker-compose.yml file --- setup/docker-compose.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/setup/docker-compose.yml b/setup/docker-compose.yml index e91332e1..42e7ee18 100644 --- a/setup/docker-compose.yml +++ b/setup/docker-compose.yml @@ -1,13 +1,13 @@ # This file is used to run the mailu/setup utility -version: '2' +version: '3.6' services: redis: image: redis:alpine setup: - image: mailu/setup + image: ${DOCKER_ORG:-mailu}/${DOCKER_PREFIX}setup:${MAILU_VERSION:-master} ports: - "8000:80" build: . From d84254ccd83f8359b6cf3f78d568df668b4a2e11 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim=20M=C3=B6hlmann?= Date: Wed, 5 Dec 2018 16:23:16 +0200 Subject: [PATCH 28/28] Update user creation to python3 --- tests/compose/core/00_create_users.sh | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/tests/compose/core/00_create_users.sh b/tests/compose/core/00_create_users.sh index fd998a15..967e13b7 100755 --- a/tests/compose/core/00_create_users.sh +++ b/tests/compose/core/00_create_users.sh @@ -1,4 +1,4 @@ echo "Creating users ..." -docker-compose -f tests/compose/core/docker-compose.yml exec admin python manage.py admin admin mailu.io password || exit 1 -docker-compose -f tests/compose/core/docker-compose.yml exec admin python manage.py user --hash_scheme='SHA512-CRYPT' user mailu.io 'password' || exit 1 -echo "Admin and user successfully created!" \ No newline at end of file +docker-compose -f tests/compose/core/docker-compose.yml exec admin python3 manage.py admin admin mailu.io password || exit 1 +docker-compose -f tests/compose/core/docker-compose.yml exec admin python3 manage.py user --hash_scheme='SHA512-CRYPT' user mailu.io 'password' || exit 1 +echo "Admin and user successfully created!"