Changeset - 0bfda9b0c3fe
[Not reviewed]
0 2 0
Branko Majic (branko) - 7 years ago 2018-10-18 07:59:20
branko@majic.rs
MAR-132: Pin packages as part of wsgi_website role test to ensure reproducability:

- Provide explicit list of packages being deployed. This should ensure
we can always reproduce the tests without being affected by new
releases of packages.
- Updated expected requirements in test for the jedi version.
2 files changed with 10 insertions and 2 deletions:
0 comments (0 inline, 0 general)
roles/wsgi_website/molecule/default/playbook.yml
Show inline comments
 
---
 

	
 
- hosts: wsgi-website
 
  become: true
 
  vars:
 
    # common
 
    ca_certificates:
 
      testca: "{{ lookup('file', 'tests/data/x509/ca.cert.pem') }}"
 

	
 
    # web_server
 
    default_https_tls_certificate: "{{ lookup('file', 'tests/data/x509/wsgi-website_https.cert.pem') }}"
 
    default_https_tls_key: "{{ lookup('file', 'tests/data/x509/wsgi-website_https.key.pem') }}"
 

	
 
    # Common parameters (general, not role).
 
    tls_certificate_dir: tests/data/x509/
 
    tls_private_key_dir: tests/data/x509/
 

	
 
  roles:
 
    - role: wsgi_website
 
      fqdn: parameters-mandatory
 
      wsgi_application: testapp:application
 

	
 
    - role: wsgi_website
 
      fqdn: parameters-optional.local
 
      additional_nginx_config:
 
        - comment: Custom missing page.
 
          value: error_page 404 /my/own/error/page;
 
      admin_uid: 5000
 
      enforce_https: false
 
      environment_indicator:
 
        background_colour: "#ff0000"
 
        text_colour: "#00ff00"
 
        text: "parameters-optional"
 
      environment_variables:
 
        MY_ENV_VAR: "My environment variable"
 
      futures_version: 3.1.0
 
      gunicorn_version: 19.7.0
 
      https_tls_certificate: "{{ lookup('file', 'tests/data/x509/parameters-optional.local_https.cert.pem') }}"
 
      https_tls_key: "{{ lookup('file', 'tests/data/x509/parameters-optional.local_https.key.pem') }}"
 
      packages:
 
        - "{% if ansible_distribution_release == 'jessie' %}libmariadb-client-lgpl-dev-compat\
 
{% elif ansible_distribution_release == 'stretch' %}libmariadbclient-dev-compat{% endif %}"
 
        - global
 
      proxy_headers:
 
        Accept-Encoding: '""'
 
      rewrites:
 
        - '^/rewrite1/(.*) /rewritten1/ last'
 
        - '^/rewrite2/(.*) /rewritten2/$1 last'
 
      static_locations:
 
        - /static/
 
        - /media/
 
      uid: 5001
 
      use_paste: false
 
      virtualenv_packages:
 
        - dnspython==1.15.0,<1.20.0
 
        # Main packages.
 
        - dnspython==1.15.0
 
        - ptpython==0.41
 
        - prompt-toolkit==1.0.15
 
        # Dependencies.
 
        - docopt==0.6.2
 
        - jedi==0.13.1
 
        - parso==0.3.1
 
        - Pygments==2.2.0
 
        - six==1.11.0
 
        - wcwidth==0.1.7
 
      website_mail_recipients: user
 
      wsgi_application: testapp:application
 
      wsgi_requirements: []
 
      python_version: 3
 

	
 
    - role: wsgi_website
 
      fqdn: parameters-paste-req
 
      use_paste: true
 
      virtualenv_packages:
 
        - click==6.7
 
        - Flask==0.12.2
 
        - itsdangerous==0.24
 
        - Jinja2==2.9.6
 
        - MarkupSafe==1.0
 
        - Paste==2.0.3
 
        - PasteDeploy==1.5.2
 
        - PasteScript==2.0.2
 
        - six==1.10.0
 
        - Werkzeug==0.12.2
 
      wsgi_application: config.ini
 
      wsgi_requirements:
 
        - futures==3.1.0
 
        - gunicorn==19.7.0
 
      https_tls_certificate: "{{ lookup('file', 'tests/data/x509/parameters-paste-req_https.cert.pem') }}"
 
      https_tls_key: "{{ lookup('file', 'tests/data/x509/parameters-paste-req_https.key.pem') }}"
 

	
 
- hosts: wsgi-website
 
  become: true
 
  tasks:
 
    # parameters-mandatory application
 
    - name: Set-up directories where application files are hosted at
 
      file:
 
        path: "/var/www/parameters-mandatory/{{ item }}"
 
        state: directory
 
        owner: admin-parameters-mandatory
 
        group: web-parameters-mandatory
 
        mode: 02750
 
      with_items:
 
        - htdocs/static
 
        - htdocs/media
 
        - code
 
    - name: Deploy WSGI application
 
      copy:
 
        src: "tests/data/python/wsgi/testapp.py"
 
        dest: "/var/www/parameters-mandatory/code/testapp.py"
 
        owner: admin-parameters-mandatory
 
        group: web-parameters-mandatory
 
        mode: 0640
 
      notify:
 
        - Restart parameters-mandatory
 
    - name: Deploy a static file
 
      copy:
 
        src: "tests/data/static_file.txt"
 
        dest: "/var/www/parameters-mandatory/htdocs/static/static_file.txt"
 
        owner: admin-parameters-mandatory
 
        group: web-parameters-mandatory
 
        mode: 0640
 
    - name: Deploy a media file
 
      copy:
 
        src: "tests/data/media_file.txt"
 
        dest: "/var/www/parameters-mandatory/htdocs/media/media_file.txt"
 
        owner: admin-parameters-mandatory
 
        group: web-parameters-mandatory
 
        mode: 0640
 

	
 
    # parameters-optional application
 
    - name: Set-up directories where application files are hosted at
 
      file:
 
        path: "/var/www/parameters-optional.local/{{ item }}"
 
        state: directory
 
        owner: admin-parameters-optional_local
 
        group: web-parameters-optional_local
 
        mode: 02750
 
      with_items:
 
        - htdocs/static
 
        - htdocs/media
 
        - code
 
    - name: Deploy WSGI application
 
      copy:
 
        src: "tests/data/python/wsgi/testapp.py"
 
        dest: "/var/www/parameters-optional.local/code/testapp.py"
 
        owner: admin-parameters-optional_local
 
        group: web-parameters-optional_local
 
        mode: 0640
 
      notify:
 
        - Restart parameters-optional.local
 
    - name: Deploy a static file
 
      copy:
 
        src: "tests/data/static_file.txt"
 
        dest: "/var/www/parameters-optional.local/htdocs/static/static_file.txt"
 
        owner: admin-parameters-optional_local
 
        group: web-parameters-optional_local
 
        mode: 0640
 
    - name: Deploy a media file
 
      copy:
 
        src: "tests/data/media_file.txt"
 
        dest: "/var/www/parameters-optional.local/htdocs/media/media_file.txt"
 
        owner: admin-parameters-optional_local
 
        group: web-parameters-optional_local
 
        mode: 0640
 

	
 
    # parameters-paste-req application
 
    - name: Set-up directories where application files are hosted at
 
      file:
 
        path: "/var/www/parameters-paste-req/{{ item }}"
 
        state: directory
 
        owner: admin-parameters-paste-req
 
        group: web-parameters-paste-req
 
        mode: 02750
 
      with_items:
 
        - htdocs/static
 
        - htdocs/media
 
        - code
 
    - name: Deploy WSGI application
 
      copy:
 
        src: "tests/data/python/paste/{{ item }}"
 
        dest: "/var/www/parameters-paste-req/code/{{ item }}"
 
        owner: admin-parameters-paste-req
 
        group: web-parameters-paste-req
 
        mode: 0640
 
      with_items:
 
        - config.ini
 
        - testapp.py
 
        - wsgi.py
 
      notify:
 
        - Restart parameters-paste-req
 
    - name: Deploy a static file
 
      copy:
 
        src: "tests/data/static_file.txt"
 
        dest: "/var/www/parameters-paste-req/htdocs/static/static_file.txt"
 
        owner: admin-parameters-paste-req
 
        group: web-parameters-paste-req
 
        mode: 0640
 
    - name: Deploy a media file
 
      copy:
 
        src: "tests/data/media_file.txt"
 
        dest: "/var/www/parameters-paste-req/htdocs/media/media_file.txt"
 
        owner: admin-parameters-paste-req
 
        group: web-parameters-paste-req
 
        mode: 0640
 

	
 
  handlers:
 
    - name: Restart parameters-mandatory
 
      service:
 
        name: parameters-mandatory
 
        state: restarted
 
    - name: Restart parameters-optional.local
 
      service:
 
        name: parameters-optional.local
 
        state: restarted
 
    - name: Restart parameters-paste-req
 
      service:
 
        name: parameters-paste-req
 
        state: restarted
roles/wsgi_website/molecule/default/tests/test_default.py
Show inline comments
 
import os
 
import re
 
import time
 

	
 
import pytest
 
import testinfra.utils.ansible_runner
 

	
 

	
 
testinfra_hosts = testinfra.utils.ansible_runner.AnsibleRunner(
 
    os.environ['MOLECULE_INVENTORY_FILE']).get_hosts(['all'])
 

	
 

	
 
@pytest.mark.parametrize("expected_group, expected_group_id", [
 
    ('web-parameters-mandatory', 1003),
 
    ('web-parameters-optional_local', 5001),
 
    ('web-parameters-paste-req', 5002),
 
])
 
def test_website_group(host, expected_group, expected_group_id):
 
    """
 
    Tests if website group has been created correctly.
 
    """
 

	
 
    group = host.group(expected_group)
 

	
 
    assert group.exists
 
    assert group.gid == expected_group_id
 

	
 

	
 
@pytest.mark.parametrize("fqdn, expected_group, expected_admin, expected_user_id", [
 
    ('parameters-mandatory', 'web-parameters-mandatory', 'admin-parameters-mandatory', 1003),
 
    ('parameters-optional.local', 'web-parameters-optional_local', 'admin-parameters-optional_local', 5000),
 
    ('parameters-paste-req', 'web-parameters-paste-req', 'admin-parameters-paste-req', 5002)
 
])
 
def test_website_admin_user(host, fqdn, expected_group, expected_admin, expected_user_id):
 

	
 
    user = host.user(expected_admin)
 

	
 
    assert user.exists
 
    assert user.uid == expected_user_id
 
    assert user.group == expected_group
 
    assert user.groups == [expected_group]
 
    assert user.shell == '/bin/bash'
 
    assert user.home == '/var/www/' + fqdn
 

	
 

	
 
@pytest.mark.parametrize("home, expected_owner, expected_group", [
 
    ('/var/www/parameters-mandatory', 'admin-parameters-mandatory', 'web-parameters-mandatory'),
 
    ('/var/www/parameters-optional.local', 'admin-parameters-optional_local', 'web-parameters-optional_local'),
 
    ('/var/www/parameters-paste-req', 'admin-parameters-paste-req', 'web-parameters-paste-req'),
 
])
 
def test_website_admin_home(host, home, expected_owner, expected_group):
 
    """
 
    Tests if permissions on website admin home directory are correct.
 
    """
 

	
 
    home = host.file(home)
 

	
 
    assert home.is_directory
 
    assert home.user == expected_owner
 
    assert home.group == expected_group
 
    assert home.mode == 0o750
 

	
 

	
 
@pytest.mark.parametrize("profile_dir, expected_owner, expected_group", [
 
    ('/var/www/parameters-mandatory/.profile.d', 'admin-parameters-mandatory', 'web-parameters-mandatory'),
 
    ('/var/www/parameters-optional.local/.profile.d', 'admin-parameters-optional_local', 'web-parameters-optional_local'),
 
    ('/var/www/parameters-paste-req/.profile.d', 'admin-parameters-paste-req', 'web-parameters-paste-req'),
 
])
 
def test_home_profile_directory(host, profile_dir, expected_owner, expected_group):
 
    """
 
    Tests if profile directory has been set-up correctly for the website
 
    administrator/application user.
 
    """
 

	
 
    with host.sudo():
 

	
 
        directory = host.file(profile_dir)
 
        assert directory.is_directory
 
        assert directory.user == expected_owner
 
        assert directory.group == expected_group
 
        assert directory.mode == 0o750
 

	
 

	
 
@pytest.mark.parametrize("profile_file, expected_group", [
 
    ('/var/www/parameters-mandatory/.profile.d/virtualenv.sh', 'web-parameters-mandatory'),
 
    ('/var/www/parameters-optional.local/.profile.d/virtualenv.sh', 'web-parameters-optional_local'),
 
    ('/var/www/parameters-paste-req/.profile.d/virtualenv.sh', 'web-parameters-paste-req'),
 
])
 
def test_virtualenv_profile_configuration(host, profile_file, expected_group):
 
    """
 
    Tests if profile configuration file for auto-activation of virtual
 
    environment has been deployed correctly.
 
    """
 

	
 
    with host.sudo():
 

	
 
        config = host.file(profile_file)
 
        assert config.is_file
 
        assert config.user == 'root'
 
        assert config.group == expected_group
 
        assert config.mode == 0o640
 

	
 

	
 
@pytest.mark.parametrize("profile_file, expected_group, expected_content", [
 
    ('/var/www/parameters-mandatory/.profile.d/environment.sh', 'web-parameters-mandatory', ''),
 
    ('/var/www/parameters-optional.local/.profile.d/environment.sh', 'web-parameters-optional_local', "export MY_ENV_VAR='My environment variable'"),
 
    ('/var/www/parameters-paste-req/.profile.d/environment.sh', 'web-parameters-paste-req', ''),
 
])
 
def test_environment_profile_configuration(host, profile_file, expected_group, expected_content):
 
    """
 
    Tests if profile configuration file for setting-up environment variables has
 
    been deployed correctly.
 
    """
 

	
 
    with host.sudo():
 

	
 
        config = host.file(profile_file)
 
        assert config.is_file
 
        assert config.user == 'root'
 
        assert config.group == expected_group
 
        assert config.mode == 0o640
 
        assert config.content == expected_content
 

	
 

	
 
@pytest.mark.parametrize("admin_user, expected_virtualenv_path", [
 
    ('admin-parameters-mandatory', '/var/www/parameters-mandatory/virtualenv'),
 
    ('admin-parameters-optional_local', '/var/www/parameters-optional.local/virtualenv\nMy environment variable'),
 
    ('admin-parameters-paste-req', '/var/www/parameters-paste-req/virtualenv'),
 
])
 
def test_profile_configuration(host, admin_user, expected_virtualenv_path):
 
    """
 
    Tests if profile configuration is behaving correctly (setting appropriate
 
    vars via login shell).
 
    """
 

	
 
    env = host.run("sudo -i -u " + admin_user + " printenv VIRTUAL_ENV MY_ENV_VAR")
 
    assert env.stdout == expected_virtualenv_path
 

	
 

	
 
@pytest.mark.parametrize("app_user, expected_uid, expected_group, expected_home", [
 
    ('web-parameters-mandatory', 999, 'web-parameters-mandatory', '/var/www/parameters-mandatory'),
 
    ('web-parameters-optional_local', 5001, 'web-parameters-optional_local', '/var/www/parameters-optional.local'),
 
    ('web-parameters-paste-req', 998, 'web-parameters-paste-req', '/var/www/parameters-paste-req'),
 
])
 
def test_website_application_user(host, app_user, expected_uid, expected_group, expected_home):
 
    """
 
    Tests if website application user has been created correctly.
 
    """
 

	
 
    user = host.user(app_user)
 

	
 
    assert user.exists
 
    assert user.uid == expected_uid
 
    assert user.group == expected_group
 
    assert user.groups == [expected_group]
 
    assert user.shell == '/bin/sh'
 
    assert user.home == expected_home
 

	
 
    with host.sudo():
 
        umask = host.run("su -l " + app_user + " -c 'bash -c umask'")
 
        assert umask.stdout == '0007'
 

	
 

	
 
@pytest.mark.parametrize("expected_group", [
 
    'web-parameters-mandatory',
 
    'web-parameters-optional_local',
 
    'web-parameters-paste-req'
 
])
 
def test_nginx_user(host, expected_group):
 
    """
 
    Tests if web server user has been added to website group.
 
    """
 

	
 
    user = host.user('www-data')
 
    assert expected_group in user.groups
 

	
 

	
 
@pytest.mark.parametrize("forward_file, expected_group, expected_content", [
 
    ('/var/www/parameters-mandatory/.forward', 'web-parameters-mandatory', 'root'),
 
    ('/var/www/parameters-optional.local/.forward', 'web-parameters-optional_local', 'user'),
 
    ('/var/www/parameters-paste-req/.forward', 'web-parameters-paste-req', 'root'),
 
])
 
def test_forward_file(host, forward_file, expected_group, expected_content):
 
    """
 
    Tests if the forward file has correct permissions and content.
 
    """
 

	
 
    with host.sudo():
 

	
 
        config = host.file(forward_file)
 

	
 
        assert config.is_file
 
        assert config.user == 'root'
 
        assert config.group == expected_group
 
        assert config.mode == 0o640
 
        assert config.content == expected_content
 

	
 

	
 
@pytest.mark.parametrize("original_destination, expected_destination_user", [
 
    ('web-parameters-mandatory@localhost', 'vagrant'),
 
    ('web-parameters-optional_local@localhost', 'user'),
 
    ('web-parameters-paste-req@localhost', 'vagrant'),
 
])
 
def test_mail_forwarding(host, original_destination, expected_destination_user):
 
    """
 
    Tests if mail forwarding works as expected.
 
    """
 

	
 
    hostname = host.run('hostname').stdout
 

	
 
    send = host.run('swaks --suppress-data --to ' + original_destination)
 
    assert send.rc == 0
 
    original_queue_id = re.search('Ok: queued as (.*)', send.stdout).group(1)
 

	
 
    # Sleep for a couple of seconds so the mail can get delivered.
 
    time.sleep(5)
 

	
 
    with host.sudo():
 
        mail_log = host.file('/var/log/mail.log')
 

	
 
        # First extract message ID of forwarded mail.
 
        pattern = "%s: to=<%s>.*status=sent \(forwarded as ([^)]*)\)" % (original_queue_id, original_destination)
 
        forward_queue_id = re.search(pattern, mail_log.content).group(1)
 

	
 
        # Now try to determine where the forward ended-up at.
 
        pattern = "%s: to=<%s@%s>, orig_to=<%s>.*status=sent" % (forward_queue_id, expected_destination_user, hostname, original_destination)
 
        assert re.search(pattern, mail_log.content) is not None
 

	
 

	
 
@pytest.mark.parametrize("virtualenv_dir, expected_owner, expected_group", [
 
    ('/var/www/parameters-mandatory/virtualenv', 'admin-parameters-mandatory', 'web-parameters-mandatory'),
 
    ('/var/www/parameters-optional.local/virtualenv', 'admin-parameters-optional_local', 'web-parameters-optional_local'),
 
    ('/var/www/parameters-paste-req/virtualenv', 'admin-parameters-paste-req', 'web-parameters-paste-req'),
 
])
 
def test_python_virtualenv_created(host, virtualenv_dir, expected_owner, expected_group):
 
    """
 
    Tests if Python virtual environment has been created correctly.
 
    """
 

	
 
    with host.sudo():
 

	
 
        virtualenv = host.file(virtualenv_dir)
 
        assert virtualenv.is_directory
 
        assert virtualenv.user == expected_owner
 
        assert virtualenv.group == expected_group
 
        assert virtualenv.mode == 0o2750
 

	
 
        virtualenv_activate = host.file(virtualenv_dir + "/bin/activate")
 
        assert virtualenv_activate.is_file
 
        assert virtualenv_activate.user == expected_owner
 
        assert virtualenv_activate.group == expected_group
 
        # @TODO: Possibly due to some timing issues, this file might
 
        # end-up being 0640, particularly when switching Python
 
        # version in virtualenv.
 
        # assert virtualenv_activate.mode == 0o644
 

	
 

	
 
@pytest.mark.parametrize("project_file, expected_owner, expected_group", [
 
    ('/var/www/parameters-mandatory/virtualenv/.project', 'admin-parameters-mandatory', 'web-parameters-mandatory'),
 
    ('/var/www/parameters-optional.local/virtualenv/.project', 'admin-parameters-optional_local', 'web-parameters-optional_local'),
 
    ('/var/www/parameters-paste-req/virtualenv/.project', 'admin-parameters-paste-req', 'web-parameters-paste-req'),
 
])
 
def test_python_virtualenv_project_directory_config(host, project_file, expected_owner, expected_group):
 
    """
 
    Tests if project directory configuration within virtualenv is set-up
 
    correctly.
 
    """
 

	
 
    with host.sudo():
 

	
 
        project = host.file(project_file)
 

	
 
        assert project.is_file
 
        assert project.user == expected_owner
 
        assert project.group == expected_group
 
        assert project.mode == 0o640
 

	
 

	
 
@pytest.mark.parametrize("wrapper_script, expected_owner, expected_group", [
 
    ('/var/www/parameters-mandatory/virtualenv/bin/exec', 'admin-parameters-mandatory', 'web-parameters-mandatory'),
 
    ('/var/www/parameters-optional.local/virtualenv/bin/exec', 'admin-parameters-optional_local', 'web-parameters-optional_local'),
 
    ('/var/www/parameters-paste-req/virtualenv/bin/exec', 'admin-parameters-paste-req', 'web-parameters-paste-req'),
 
])
 
def test_python_virtualenv_wrapper_script(host, wrapper_script, expected_owner, expected_group):
 
    """
 
    Tests if Python virtualenv wrapper script is functioning correctly.
 
    """
 

	
 
    with host.sudo():
 

	
 
        wrapper = host.file(wrapper_script)
 
        assert wrapper.is_file
 
        assert wrapper.user == expected_owner
 
        assert wrapper.group == expected_group
 
        assert wrapper.mode == 0o750
 

	
 
        command = host.run("sudo -u %s %s python -c 'import gunicorn'" % (expected_owner, wrapper_script))
 
        assert command.rc == 0
 

	
 

	
 
@pytest.mark.parametrize("admin_user, pip_path, expected_packages",  [
 
    ('admin-parameters-mandatory', '/var/www/parameters-mandatory/virtualenv/bin/pip', [
 
        "futures==3.2.0",
 
        "gunicorn==19.9.0",
 
    ]),
 
    ('admin-parameters-optional_local', '/var/www/parameters-optional.local/virtualenv/bin/pip', [
 
        "Pygments==2.2.0",
 
        "dnspython==1.15.0",
 
        "docopt==0.6.2",
 
        "futures==3.1.0",
 
        "gunicorn==19.7.0",
 
        "jedi==0.12.1",
 
        "jedi==0.13.1",
 
        "parso==0.3.1",
 
        "prompt-toolkit==1.0.15",
 
        "ptpython==0.41",
 
        "six==1.11.0",
 
        "wcwidth==0.1.7",
 
    ]),
 
    ('admin-parameters-paste-req', '/var/www/parameters-paste-req/virtualenv/bin/pip', [
 
        "Flask==0.12.2",
 
        "Jinja2==2.9.6",
 
        "MarkupSafe==1.0",
 
        "Paste==2.0.3",
 
        "PasteDeploy==1.5.2",
 
        "PasteScript==2.0.2",
 
        "Werkzeug==0.12.2",
 
        "click==6.7",
 
        "futures==3.1.0",
 
        "gunicorn==19.7.0",
 
        "itsdangerous==0.24",
 
        "six==1.10.0",
 
    ]),
 
])
 
def test_virtualenv_packages(host, admin_user, pip_path, expected_packages):
 
    """
 
    Tests if correct packages are installed in virtualenv.
 
    """
 

	
 
    packages = host.run("sudo -u %s %s freeze" % (admin_user, pip_path))
 

	
 
    # Normalise package names and order.
 
    expected_packages = sorted([p.lower() for p in expected_packages])
 
    actual_packages = sorted(packages.stdout.lower().split("\n"))
 

	
 
    assert actual_packages == expected_packages
 

	
 

	
 
@pytest.mark.parametrize('check_config_dir', [
 
    '/etc/pip_check_requirements_upgrades/parameters-mandatory',
 
    '/etc/pip_check_requirements_upgrades/parameters-optional.local',
 
])
 
def test_wsgi_requirements_upgrade_checks(host, check_config_dir):
 
    """
 
    Tests if Python requirements files for upgrade checks are set-up
 
    correctly (absent when not configured).
 
    """
 

	
 
    with host.sudo():
 
        directory = host.file(check_config_dir)
 
        assert not directory.exists
 

	
 

	
 
@pytest.mark.parametrize("config_file, expected_website_name, expected_socket_file_path", [
 
    ('/etc/systemd/system/parameters-mandatory.socket', 'parameters-mandatory', '/run/wsgi/parameters-mandatory.sock'),
 
    ('/etc/systemd/system/parameters-optional.local.socket', 'parameters-optional.local', '/run/wsgi/parameters-optional.local.sock'),
 
    ('/etc/systemd/system/parameters-paste-req.socket', 'parameters-paste-req', '/run/wsgi/parameters-paste-req.sock'),
 
])
 
def test_systemd_socket_configuration_file(host, config_file, expected_website_name, expected_socket_file_path):
 
    """
 
    Tests if systemd socket configuration file has been set-up correctly.
 
    """
 

	
 
    config = host.file(config_file)
 
    assert config.is_file
 
    assert config.user == 'root'
 
    assert config.group == 'root'
 
    assert config.mode == 0o644
 
    assert "Socket for website %s" % expected_website_name in config.content
 
    assert "ListenStream=%s" % expected_socket_file_path in config.content
 

	
 

	
 
@pytest.mark.parametrize("socket_file_path", [
 
    '/run/wsgi/parameters-mandatory.sock',
 
    '/run/wsgi/parameters-optional.local.sock',
 
    '/run/wsgi/parameters-paste-req.sock',
 
])
 
def test_systemd_socket(host, socket_file_path):
 
    """
 
    Tests if systemd socket has correct permissions and is available.
 
    """
 

	
 
    with host.sudo():
 

	
 
        socket_file = host.file(socket_file_path)
 
        assert socket_file.is_socket
 
        assert socket_file.user == 'www-data'
 
        assert socket_file.group == 'www-data'
 
        assert socket_file.mode == 0o660
 

	
 
        socket = host.socket("unix://%s" % socket_file_path)
 
        assert socket.is_listening
 

	
 

	
 
@pytest.mark.parametrize("service_file, expected_fqdn", [
 
    ('/etc/systemd/system/parameters-mandatory.service', 'parameters-mandatory'),
 
    ('/etc/systemd/system/parameters-optional.local.service', 'parameters-optional.local'),
 
    ('/etc/systemd/system/parameters-paste-req.service', 'parameters-paste-req'),
 
])
 
def test_systemd_service_configuration_file(host, service_file, expected_fqdn):
 
    """
 
    Tests if systemd service configuration file has been set-up correctly.
 
    """
 

	
 
    config = host.file(service_file)
 
    assert config.is_file
 
    assert config.user == 'root'
 
    assert config.group == 'root'
 
    assert config.mode == 0o644
 
    assert expected_fqdn in config.content
 

	
 

	
 
@pytest.mark.parametrize("service_name", [
 
    'parameters-mandatory',
 
    'parameters-optional.local',
 
    'parameters-paste-req',
 
])
 
def test_systemd_service(host, service_name):
 
    """
 
    Tests if the systemd service is enabled at boot and running.
 
    """
 

	
 
    service = host.service(service_name)
 

	
 
    assert service.is_enabled
 
    assert service.is_running
 

	
 

	
 
@pytest.mark.parametrize("directory_path, expected_owner, expected_group", [
 
    ('/var/www/parameters-mandatory/htdocs', 'admin-parameters-mandatory', 'web-parameters-mandatory'),
 
    ('/var/www/parameters-optional.local/htdocs', 'admin-parameters-optional_local', 'web-parameters-optional_local'),
 
    ('/var/www/parameters-paste-req/htdocs', 'admin-parameters-paste-req', 'web-parameters-paste-req'),
 
])
 
def test_static_file_directory(host, directory_path, expected_owner, expected_group):
 
    """
 
    Tests if directory for serving static files has been created correctly.
 
    """
 

	
 
    with host.sudo():
 

	
 
        directory = host.file(directory_path)
 
        assert directory.is_directory
 
        assert directory.user == expected_owner
 
        assert directory.group == expected_group
 
        assert directory.mode == 0o2750
 

	
 

	
 
@pytest.mark.parametrize("private_key_path, certificate_path, expected_private_key, expected_certificate", [
 
    ('/etc/ssl/private/parameters-mandatory_https.key', '/etc/ssl/certs/parameters-mandatory_https.pem',
 
     'tests/data/x509/parameters-mandatory_https.key', 'tests/data/x509/parameters-mandatory_https.pem'),
 
    ('/etc/ssl/private/parameters-optional.local_https.key', '/etc/ssl/certs/parameters-optional.local_https.pem',
 
     'tests/data/x509/parameters-optional.local_https.key.pem', 'tests/data/x509/parameters-optional.local_https.cert.pem'),
 
    ('/etc/ssl/private/parameters-paste-req_https.key', '/etc/ssl/certs/parameters-paste-req_https.pem',
 
     'tests/data/x509/parameters-paste-req_https.key.pem', 'tests/data/x509/parameters-paste-req_https.cert.pem'),
 
])
 
def test_nginx_tls_files(host, private_key_path, certificate_path, expected_private_key, expected_certificate):
 
    """
 
    Tests if TLS private key and certificate have been deployed correctly.
 
    """
 

	
 
    with host.sudo():
 

	
 
        tls_file = host.file(private_key_path)
 
        assert tls_file.is_file
 
        assert tls_file.user == 'root'
 
        assert tls_file.group == 'root'
 
        assert tls_file.mode == 0o640
 
        assert tls_file.content == open(expected_private_key, "r").read().rstrip()
 

	
 
        tls_file = host.file(certificate_path)
 
        assert tls_file.is_file
 
        assert tls_file.user == 'root'
 
        assert tls_file.group == 'root'
 
        assert tls_file.mode == 0o644
 
        assert tls_file.content == open(expected_certificate, "r").read().rstrip()
 

	
 

	
 
@pytest.mark.parametrize("config_file_path, expected_content", [
 
    ('/etc/check_certificate/parameters-mandatory_https.conf', '/etc/ssl/certs/parameters-mandatory_https.pem'),
 
    ('/etc/check_certificate/parameters-optional.local_https.conf', '/etc/ssl/certs/parameters-optional.local_https.pem'),
 
    ('/etc/check_certificate/parameters-paste-req_https.conf', '/etc/ssl/certs/parameters-paste-req_https.pem'),
 
])
 
def test_certificate_validity_check_configuration(host, config_file_path, expected_content):
 
    """
 
    Tests if certificate validity check configuration file has been deployed
 
    correctly.
 
    """
 

	
 
    config = host.file(config_file_path)
 
    assert config.is_file
 
    assert config.user == 'root'
 
    assert config.group == 'root'
 
    assert config.mode == 0o644
 
    assert config.content == expected_content
 

	
 

	
 
@pytest.mark.parametrize("config_file", [
 
    '/etc/nginx/sites-available/parameters-mandatory',
 
    '/etc/nginx/sites-available/parameters-optional.local',
 
    '/etc/nginx/sites-available/parameters-paste-req',
 
])
 
def test_vhost_file(host, config_file):
 
    """
 
    Tests permissions of vhost configuration file.
 
    """
 

	
 
    config = host.file(config_file)
 

	
 
    assert config.is_file
 
    assert config.user == 'root'
 
    assert config.group == 'root'
 
    assert config.mode == 0o640
 

	
 

	
 
@pytest.mark.parametrize("config_file, expected_content", [
 
    ('/etc/nginx/sites-enabled/parameters-mandatory', '/etc/nginx/sites-available/parameters-mandatory'),
 
    ('/etc/nginx/sites-enabled/parameters-optional.local', '/etc/nginx/sites-available/parameters-optional.local'),
 
    ('/etc/nginx/sites-enabled/parameters-paste-req', '/etc/nginx/sites-available/parameters-paste-req'),
 
])
 
def test_website_enabled(host, config_file, expected_content):
 
    """
 
    Tests if website has been enabled.
 
    """
 

	
 
    config = host.file(config_file)
 

	
 
    assert config.is_symlink
 
    assert config.linked_to == expected_content
 

	
 

	
 
@pytest.mark.parametrize("python_path, expected_version_startswith", [
 
    ("/var/www/parameters-mandatory/virtualenv/bin/python", "Python 2"),
 
    ("/var/www/parameters-optional.local/virtualenv/bin/python", "Python 3"),
 
    ("/var/www/parameters-paste-req/virtualenv/bin/python", "Python 2"),
 
])
 
def test_python_version_in_virtualenv(host, python_path, expected_version_startswith):
 
    """
 
    Tests if correct Python version is used inside of virtual
 
    environment.
 
    """
 

	
 
    with host.sudo():
 

	
 
        python_version = host.run(python_path + " --version")
 

	
 
        # Python 2 outputs version to stderr, Python 3 outputs it to
 
        # stdout. Go figure.
 
        python_version_output = python_version.stdout + python_version.stderr
 

	
 
        assert python_version.rc == 0
 

	
 
        # Python binary prints out version to stderr.
 
        assert python_version_output.startswith(expected_version_startswith)
0 comments (0 inline, 0 general)