Generic transport editor. (#1309)

Generic transport editor.

see #1301

* Fixed unit test.

* Added unit tests.

* Fixed unit test.

* Added transport module to test list.

* Moved relay transport backend to appropriate app.

see #1301

* Added missing file.
This commit is contained in:
Antoine Nguyen
2017-11-27 10:42:27 +01:00
committed by GitHub
parent 1129c94316
commit 98eea782a0
65 changed files with 1621 additions and 611 deletions
+1
View File
@@ -0,0 +1 @@
default_app_config = "modoboa.transport.apps.TransportConfig"
+3
View File
@@ -0,0 +1,3 @@
from django.contrib import admin
# Register your models here.
+11
View File
@@ -0,0 +1,11 @@
from __future__ import unicode_literals
from django.apps import AppConfig
class TransportConfig(AppConfig):
name = 'modoboa.transport'
def ready(self):
from . import handlers
+105
View File
@@ -0,0 +1,105 @@
"""Transport backend."""
from django import forms
from django.core import validators
from django.utils.translation import ugettext_lazy as _
from modoboa.lib import validators as lib_validators
class TransportBackend(object):
"""Base backend class."""
name = None
settings = ()
def _validate_host_address(self, value):
"""Validate an host address syntax."""
validator_list = [
lib_validators.validate_hostname,
validators.validate_ipv46_address
]
for validator in validator_list:
try:
validator(value)
except forms.ValidationError:
pass
else:
return True
return False
def clean_fields(self, values):
"""Check that values are correct."""
errors = []
for setting in self.settings:
fname = "{}_{}".format(self.name, setting["name"])
value = values.get(fname)
if not value:
if not setting.get("required", True):
continue
errors.append((fname, _("This field is required")))
continue
ftype = setting.get("type", "string")
if ftype == "string":
validator = setting.get("validator")
vfunc = "_validate_{}".format(validator)
if validator and hasattr(self, vfunc):
if getattr(self, vfunc)(value):
continue
else:
continue
elif ftype == "int" and isinstance(value, int):
continue
elif ftype == "boolean" and isinstance(value, bool):
continue
errors.append((fname, _("Invalid value")))
return errors
def serialize(self, transport):
"""Transform received values if needed."""
pass
class TransportBackendManager(object):
"""Transport backends manager."""
def __init__(self):
"""Constructor."""
self.backends = {}
def get_backend(self, name, **kwargs):
"""Return backend instance."""
backend_class = self.backends.get(name)
if backend_class is None:
return None
return backend_class(**kwargs)
def get_backend_list(self):
"""Return known backend list."""
return sorted([
(key, key)
for key, backend in self.backends.items()
], key=lambda i: i[1])
def get_backend_settings(self, name):
"""Return backend settings."""
backend_class = self.backends.get(name)
if backend_class is None:
return None
return backend_class.settings
def get_all_backend_settings(self):
"""Return all backend settings."""
return {
name: backend_class.settings
for name, backend_class in list(self.backends.items())
}
def register_backend(self, backend_class):
"""Register a new backend."""
if not backend_class.name:
raise RuntimeError("missing backend name")
self.backends[backend_class.name] = backend_class
manager = TransportBackendManager()
+5
View File
@@ -0,0 +1,5 @@
"""Transport constants."""
PERMISSIONS = {
}
+20
View File
@@ -0,0 +1,20 @@
"""Transport factories."""
import factory
from modoboa.core.factories import PermissionFactory
from . import models
class TransportFactory(PermissionFactory):
"""Factory for Transport."""
class Meta:
model = models.Transport
django_get_or_create = ("pattern", )
pattern = factory.Sequence(lambda n: "transport{}".format(n))
service = "relay"
next_hop = "[external.host.tld]:25"
+94
View File
@@ -0,0 +1,94 @@
"""Transport forms."""
from django import forms
from . import backends
from . import models
TYPE_TO_FIELD_MAP = {
"int": forms.IntegerField,
"boolean": forms.BooleanField,
"string": forms.CharField
}
class BackendSettingsMixin(object):
"""A mixin to deal with backend settings in a model form."""
def __init__(self, *args, **kwargs):
"""Constructor."""
super(BackendSettingsMixin, self).__init__(*args, **kwargs)
self.setting_fields = []
def inject_backend_settings(self, name, settings):
"""Inject backend settings to form."""
for setting in settings:
fullname = "{}_{}".format(name, setting["name"])
options = {}
ftype = setting.get("type", "string")
if self.instance.pk:
options["initial"] = self.instance._settings.get(fullname)
elif "default" in setting:
options["initial"] = setting["default"]
if "widget" in setting:
options["widget"] = setting["widget"]
self.fields[fullname] = TYPE_TO_FIELD_MAP[ftype](
label=setting["label"], required=False, **options)
self.setting_fields.append(fullname)
def clean_backend_fields(self, name):
"""Clean backend fields."""
self.backend = backends.manager.get_backend(name)
for field, error in self.backend.clean_fields(self.cleaned_data):
self.add_error(field, error)
def save(self, commit=True):
"""Set settings to JSON field."""
transport = super(BackendSettingsMixin, self).save(commit=False)
transport._settings = {
name: self.cleaned_data[name] for name in self.setting_fields
}
if commit:
transport.save()
return transport
class TransportForm(BackendSettingsMixin, forms.ModelForm):
"""Transport model form."""
service = forms.ChoiceField(choices=[])
class Meta:
fields = ("pattern", "service", "enabled")
model = models.Transport
def __init__(self, *args, **kwargs):
"""Set backend list."""
super(TransportForm, self).__init__(*args, **kwargs)
self.fields["service"].choices = backends.manager.get_backend_list()
settings = backends.manager.get_all_backend_settings()
for name, backend_settings in settings.items():
self.inject_backend_settings(name, backend_settings)
def _clean_fields(self):
"""Make backend settings required."""
backend_name = self.data.get("service")
backend_settings = backends.manager.get_backend_settings(backend_name)
for name, field in self.fields.items():
if name.startswith("{}_".format(backend_name)):
name = name.replace("{}_".format(backend_name), "")
for setting in backend_settings:
if setting["name"] == name:
break
if setting.get("required", True):
field.required = True
return super(TransportForm, self)._clean_fields()
def clean(self):
"""Check values."""
cleaned_data = super(TransportForm, self).clean()
if self.errors:
return cleaned_data
self.clean_backend_fields(cleaned_data["service"])
return cleaned_data
+31
View File
@@ -0,0 +1,31 @@
"""Transport handlers."""
from __future__ import unicode_literals
from django.core.urlresolvers import reverse
from django.dispatch import receiver
from django.utils.translation import ugettext as _
from modoboa.admin import signals as admin_signals
from modoboa.core import signals as core_signals
from . import postfix_maps
@receiver(admin_signals.extra_domain_menu_entries)
def extra_domain_menu_entries(sender, user, **kwargs):
"""Add extra menu entries."""
return [{
"name": "transports",
"label": _("Transports"),
"url": reverse("transport:transport_list"),
"img": "fa fa-bus",
}]
@receiver(core_signals.register_postfix_maps)
def register_postfix_maps(sender, **kwargs):
"""Register postfix maps."""
return [
postfix_maps.TransportMap,
]
@@ -0,0 +1,124 @@
# SOME DESCRIPTIVE TITLE.
# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
# This file is distributed under the same license as the PACKAGE package.
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: PACKAGE VERSION\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2017-11-24 16:42+0100\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"Language: \n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
#: backends.py:31
msgid "target host address"
msgstr ""
#: backends.py:32
msgid "target host port"
msgstr ""
#: backends.py:34
msgid "verify recipients"
msgstr ""
#: backends.py:46
msgid "This field is required"
msgstr ""
#: backends.py:54
msgid "Invalid value"
msgstr ""
#: handlers.py:20 templates/transport/transport_list.html:5
msgid "Transports"
msgstr ""
#: models.py:18
msgid "pattern"
msgstr ""
#: models.py:19
msgid "service"
msgstr ""
#: models.py:20
msgid "next hop"
msgstr ""
#: serializers.py:23
msgid "Unsupported service"
msgstr ""
#: templates/transport/_transport_headers.html:3
msgid "Name"
msgstr ""
#: templates/transport/_transport_headers.html:4
msgid "Tags"
msgstr ""
#: templates/transport/_transport_headers.html:5
#: templates/transport/transport_list.html:33
msgid "Actions"
msgstr ""
#: templates/transport/transport_list.html:21
msgid "Add"
msgstr ""
#: templates/transport/transport_list.html:31
msgid "Pattern"
msgstr ""
#: templates/transport/transport_list.html:32
msgid "Service"
msgstr ""
#: templates/transport/transport_list.html:39
msgid "disabled"
msgstr ""
#: templates/transport/transport_list.html:49
#, python-format
msgid "Delete %(pattern)s? "
msgstr ""
#: templates/transport/transport_list.html:56
msgid "No transport defined yet."
msgstr ""
#: views.py:47
msgid "Transport created"
msgstr ""
#: views.py:99
msgid "Create"
msgstr ""
#: views.py:100
msgid "New transport"
msgstr ""
#: views.py:112
msgid "Transport updated"
msgstr ""
#: views.py:121
msgid "Update"
msgstr ""
#: views.py:122
msgid "Edit transport"
msgstr ""
#: views.py:141
msgid "Transport deleted"
msgstr ""
@@ -0,0 +1,22 @@
# SOME DESCRIPTIVE TITLE.
# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
# This file is distributed under the same license as the PACKAGE package.
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: PACKAGE VERSION\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2017-11-24 16:44+0100\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"Language: \n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
#: static/transport/js/transport.js:36
msgid "Search"
msgstr ""
@@ -0,0 +1,124 @@
# SOME DESCRIPTIVE TITLE.
# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
# This file is distributed under the same license as the PACKAGE package.
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
#
msgid ""
msgstr ""
"Project-Id-Version: PACKAGE VERSION\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2017-11-24 16:42+0100\n"
"PO-Revision-Date: 2017-11-24 17:22+0100\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"Language: \n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Plural-Forms: nplurals=2; plural=(n > 1);\n"
#: backends.py:31
msgid "target host address"
msgstr "adresse de l'hôte cible"
#: backends.py:32
msgid "target host port"
msgstr "admin/tests/"
#: backends.py:34
msgid "verify recipients"
msgstr "vérifier les destinataires"
#: backends.py:46
msgid "This field is required"
msgstr "Ce champ est requis"
#: backends.py:54
msgid "Invalid value"
msgstr "Valeur incorrecte"
#: handlers.py:20 templates/transport/transport_list.html:5
msgid "Transports"
msgstr "Transports"
#: models.py:18
msgid "pattern"
msgstr "patron"
#: models.py:19
msgid "service"
msgstr "service"
#: models.py:20
msgid "next hop"
msgstr "saut suivant"
#: serializers.py:23
msgid "Unsupported service"
msgstr "Service non supporté"
#: templates/transport/_transport_headers.html:3
msgid "Name"
msgstr "Nom"
#: templates/transport/_transport_headers.html:4
msgid "Tags"
msgstr "Libellés"
#: templates/transport/_transport_headers.html:5
#: templates/transport/transport_list.html:33
msgid "Actions"
msgstr "Actions"
#: templates/transport/transport_list.html:21
msgid "Add"
msgstr "Ajouter"
#: templates/transport/transport_list.html:31
msgid "Pattern"
msgstr "Patron"
#: templates/transport/transport_list.html:32
msgid "Service"
msgstr "Service"
#: templates/transport/transport_list.html:39
msgid "disabled"
msgstr "désactivé"
#: templates/transport/transport_list.html:49
#, python-format
msgid "Delete %(pattern)s? "
msgstr "Supprimer %(pattern)s ? "
#: templates/transport/transport_list.html:56
msgid "No transport defined yet."
msgstr "Aucun transport défini"
#: views.py:47
msgid "Transport created"
msgstr "Transport créé"
#: views.py:99
msgid "Create"
msgstr "Créer"
#: views.py:100
msgid "New transport"
msgstr "Nouveau transport"
#: views.py:112
msgid "Transport updated"
msgstr "Transport mis à jour"
#: views.py:121
msgid "Update"
msgstr "Mettre à jour"
#: views.py:122
msgid "Edit transport"
msgstr "Modifier le transport"
#: views.py:141
msgid "Transport deleted"
msgstr "Transport supprimé"
@@ -0,0 +1,22 @@
# SOME DESCRIPTIVE TITLE.
# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
# This file is distributed under the same license as the PACKAGE package.
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
#
msgid ""
msgstr ""
"Project-Id-Version: PACKAGE VERSION\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2017-11-24 16:44+0100\n"
"PO-Revision-Date: 2017-11-24 16:45+0100\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"Language: \n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Plural-Forms: nplurals=2; plural=(n > 1);\n"
#: static/transport/js/transport.js:36
msgid "Search"
msgstr "Chercher"
@@ -0,0 +1,34 @@
# -*- coding: utf-8 -*-
# Generated by Django 1.10.7 on 2017-11-24 11:16
from __future__ import unicode_literals
from django.db import migrations, models
import django.utils.timezone
import jsonfield.fields
class Migration(migrations.Migration):
initial = True
dependencies = [
]
operations = [
migrations.CreateModel(
name='Transport',
fields=[
('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
('creation', models.DateTimeField(default=django.utils.timezone.now)),
('last_modification', models.DateTimeField(auto_now=True)),
('pattern', models.CharField(max_length=254, unique=True, verbose_name='pattern')),
('service', models.CharField(max_length=30, verbose_name='service')),
('next_hop', models.CharField(blank=True, max_length=100, verbose_name='next hop')),
('enabled', models.BooleanField(default=True, verbose_name='enabled')),
('_settings', jsonfield.fields.JSONField(default={})),
],
options={
'ordering': ['pattern'],
},
),
]
+32
View File
@@ -0,0 +1,32 @@
"""Transport models."""
from __future__ import unicode_literals
from reversion import revisions as reversion
from django.db import models
from django.utils.translation import ugettext_lazy as _
import jsonfield
from modoboa.admin import models as admin_models
class Transport(admin_models.AdminObject):
"""Transport table."""
pattern = models.CharField(_("pattern"), unique=True, max_length=254)
service = models.CharField(_("service"), max_length=30)
next_hop = models.CharField(_("next hop"), max_length=100, blank=True)
enabled = models.BooleanField("enabled", default=True)
_settings = jsonfield.JSONField(default={})
class Meta:
ordering = ["pattern"]
def __str__(self):
return self.pattern
reversion.register(Transport)
+24
View File
@@ -0,0 +1,24 @@
"""Map file definitions for postfix."""
from __future__ import unicode_literals
class TransportMap(object):
"""A transport map."""
filename = "sql-transport.cf"
mysql = (
"SELECT CONCAT(service, ':', next_hop) "
"FROM transport_transport "
"WHERE enabled=1 AND pattern='%s'"
)
postgres = (
"SELECT service || ':' || next_hop "
"FROM transport_transport "
"WHERE enabled AND pattern='%s'"
)
sqlite = (
"SELECT service || ':' || next_hop "
"FROM transport_transport "
"WHERE enabled=1 AND pattern='%s'"
)
+49
View File
@@ -0,0 +1,49 @@
"""Transport serializers."""
import json
from django.utils.translation import ugettext as _
from rest_framework import serializers
from . import backends
from . import models
class TransportSerializer(serializers.ModelSerializer):
"""Transport serializer class."""
class Meta:
model = models.Transport
fields = ("pk", "pattern", "service", "enabled", "_settings")
def validate(self, data):
"""Check fields based on backend."""
self.backend = backends.manager.get_backend(data["service"])
if not self.backend:
raise serializers.ValidationError({
"service": _("Unsupported service")
})
data["_settings"] = json.loads(data["_settings"])
errors = self.backend.clean_fields(data["_settings"])
if errors:
raise serializers.ValidationError({
"_settings": ",".join(
["{}: {}".format(error[0], error[1]) for error in errors])
})
return data
def create(self, validated_data):
"""Use backend to serialize data."""
transport = models.Transport(**validated_data)
self.backend.serialize(transport)
transport.save(creator=self.context["request"].user)
return transport
def update(self, instance, validated_data):
"""Use backend to serialize data."""
for key, value in validated_data.items():
setattr(instance, key, value)
self.backend.serialize(instance)
instance.save()
return instance
@@ -0,0 +1,43 @@
/*
* Transport javascript tools.
*/
function displayBackendSettings(name) {
$('#backend_settings').find("div[class*=form-group]").hide();
if (name !== '') {
$('#backend_settings').find('[name*=' + name + '_]').each(function (index, input) {
$(input).parents("div[class*=form-group]").show();
});
}
}
function transportFormCallback () {
var $service_field = $('#id_service');
$service_field.change(function (event) {
displayBackendSettings($(this).val());
});
displayBackendSettings($service_field.val());
$('.submit').one('click', $.proxy(function(e) {
simple_ajax_form_post(e, {
formid: 'transport_form',
error_cb: transportFormCallback
});
}, this));
}
$(document).ready(function () {
$('#searchquery').focus(function () {
$(this).val('');
}).blur(function (e) {
var $this = $(this);
if ($this.val() === '') {
$this.val(gettext('Search'));
}
});
$('a[name=deltransport]').confirm({
question: function() { return this.$element.attr('title'); },
method: 'DELETE'
});
});
@@ -0,0 +1,14 @@
{% extends "common/generic_modal_form.html" %}
{% load form_tags %}
{% block formbody %}
{% render_field form.pattern %}
{% render_field form.service %}
{% render_field form.enabled %}
<div id="backend_settings">
{% for field in setting_fields %}
{% render_field field hidden=True %}
{% endfor %}
</div>
{% endblock %}
@@ -0,0 +1,5 @@
{% load i18n %}
<th id="name" class="sortable" data-sort_order="name" width="">{% trans "Name" %}</th>
<th id="tags" class="sortable" data-sort_order="tags" width="">{% trans "Tags" %}</th>
<th id="actions" width="">{% trans "Actions" %}</th>
@@ -0,0 +1,66 @@
{% extends "twocols.html" %}
{% load i18n admin_tags lib_tags static %}
{% block pagetitle %}{% trans "Transports" %}{% endblock %}
{% block leftcol %}
<ul class="nav nav-sidebar">
{% domains_menu "transports" user False %}
</ul>
{% endblock %}
{% block apparea %}
<div class="row">
<div class="col-sm-5">
{% include "admin/searchform.html" %}
</div>
<div class="col-sm-3">
{% if perms.transport.add_transport %}
<a href="{% url 'transport:transport_create' %}" class="btn btn-primary" data-toggle="ajaxmodal" modalcb="transportFormCallback">
<span class="fa fa-plus"></span> {% trans "Add" %}
</a>
{% endif %}
</div>
<div id="taglist" class="col-sm-4"> </div>
</div>
<table class="table table-hover">
<thead>
<tr>
<th id="pattern" class="sortable" data-sort_order="pattern" width="">{% trans "Pattern" %}</th>
<th id="service" class="sortable" data-sort_order="service" width="">{% trans "Service" %}</th>
<th id="actions" width="">{% trans "Actions" %}</th>
</tr>
</thead>
<tbody>
{% for transport in object_list %}
<tr class="{% if not transport.enabled %}text-muted{% endif %}">
<td>{{ transport.pattern }}{% if not transport.enabled %} ({% trans "disabled" %}){% endif %}</td>
<td><span class="label label-default">
<a href="#" class="filter transport">{{ transport.service }}</a>
</span></td>
<td name="actions">
<a href="{% url 'transport:transport_update' transport.pk %}"
data-toggle="ajaxmodal" modalcb="transportFormCallback">
<span class="fa fa-edit"></span>
</a>
<a href="{% url 'transport:transport_delete' transport.pk %}"
name="deltransport" title="{% blocktrans with pattern=transport.pattern %}Delete {{ pattern }}? {% endblocktrans %}">
<span class="fa fa-trash"></span>
</a>
</td>
</tr>
{% empty %}
<tr><td colspan="3">
<div class="alert alert-info">{% trans "No transport defined yet." %}</div>
</td></tr>
{% endfor %}
</tbody>
</table>
{% endblock %}
{% block extra_js %}
{{ block.super }}
<script type="text/javascript" src="{% static 'transport/js/transport.js' %}"></script>
{% endblock %}
+163
View File
@@ -0,0 +1,163 @@
"""Transport tests."""
import json
from django.core.urlresolvers import reverse
from modoboa.lib.tests import ModoAPITestCase, ModoTestCase
from . import factories
from . import models
class DataMixin(object):
"""A mixin to provide test data."""
@classmethod
def setUpTestData(cls):
super(DataMixin, cls).setUpTestData()
cls.transport1 = factories.TransportFactory(
pattern="domain1.test", _settings={
"relay_target_host": "external.host.tld",
"relay_target_port": 25,
"relay_verify_recipients": False
}
)
cls.transport2 = factories.TransportFactory(
pattern="domain2.test", _settings={
"relay_target_host": "external.host.tld",
"relay_target_port": 25,
"relay_verify_recipients": True
}
)
class TransportViewsTestCase(DataMixin, ModoTestCase):
"""Test transport views."""
def test_transport_list(self):
"""Test list view."""
url = reverse("transport:transport_list")
response = self.client.get(url)
self.assertContains(response, self.transport1.pattern)
self.assertContains(response, self.transport2.pattern)
url = "{}?searchquery=domain1".format(url)
response = self.client.get(url)
self.assertContains(response, self.transport1.pattern)
self.assertNotContains(response, self.transport2.pattern)
def test_create_transport(self):
"""Test create view."""
url = reverse("transport:transport_create")
response = self.client.get(url)
self.assertContains(response, "New transport")
data = {
"pattern": "domain3.test",
"service": "relay",
"relay_target_host": "1.2.3.4",
}
response = self.ajax_post(url, data, 400)
data.update({"relay_target_port": 25})
self.ajax_post(url, data)
transport = models.Transport.objects.get(pattern="domain3.test")
self.assertEqual(
transport.next_hop, "[{}]:{}".format(
data["relay_target_host"], data["relay_target_port"])
)
def test_update_transport(self):
"""Test update view."""
url = reverse("transport:transport_update", args=[self.transport1.pk])
response = self.client.get(url)
self.assertContains(response, "Edit transport")
data = {
"pattern": self.transport1.pattern,
"service": self.transport1.service,
"relay_target_host": "1.2.3.5",
"relay_target_port": 234,
"relay_verify_recipients": True
}
self.ajax_post(url, data)
self.transport1.refresh_from_db()
self.assertTrue(
self.transport1._settings["relay_verify_recipients"])
self.assertEqual(
self.transport1.next_hop, "[{}]:{}".format(
data["relay_target_host"], data["relay_target_port"])
)
def test_delete_transport(self):
"""Test delete view."""
url = reverse("transport:transport_delete", args=[self.transport1.pk])
response = self.client.delete(url)
self.assertEqual(response.status_code, 302)
with self.assertRaises(models.Transport.DoesNotExist):
self.transport1.refresh_from_db()
class TransportAPITestCase(DataMixin, ModoAPITestCase):
"""API test cases."""
def test_list(self):
"""Test list service."""
url = reverse("api:transport-list")
response = self.client.get(url)
self.assertEqual(response.status_code, 200)
self.assertEqual(len(response.data), 2)
def test_create(self):
"""Test create service."""
url = reverse("api:transport-list")
settings = {
"relay_target_host": "1.2.3.4"
}
data = {
"pattern": "domain3.test",
"service": "relay",
"_settings": json.dumps(settings)
}
response = self.client.post(url, data, format="json")
self.assertEqual(response.status_code, 400)
self.assertEqual(
response.data["_settings"],
["relay_target_port: This field is required"]
)
settings.update({"relay_target_port": 25})
data["_settings"] = json.dumps(settings)
response = self.client.post(url, data, format="json")
self.assertEqual(response.status_code, 201)
transport = models.Transport.objects.get(pattern="domain3.test")
self.assertEqual(
transport.next_hop, "[{}]:{}".format(
settings["relay_target_host"], settings["relay_target_port"])
)
def test_update(self):
"""Test update service."""
url = reverse("api:transport-detail", args=[self.transport1.pk])
settings = self.transport1._settings.copy()
settings.update({"relay_target_port": 1000})
data = {
"pattern": "domain3.test",
"service": "relay",
"_settings": json.dumps(settings)
}
response = self.client.put(url, data, format="json")
self.assertEqual(response.status_code, 200)
self.transport1.refresh_from_db()
self.assertEqual(self.transport1.pattern, data["pattern"])
self.assertEqual(
self.transport1.next_hop, "[{}]:{}".format(
settings["relay_target_host"], settings["relay_target_port"])
)
def test_delete(self):
"""Test delete service."""
url = reverse("api:transport-detail", args=[self.transport1.pk])
response = self.client.delete(url)
self.assertEqual(response.status_code, 204)
with self.assertRaises(models.Transport.DoesNotExist):
self.transport1.refresh_from_db()
+17
View File
@@ -0,0 +1,17 @@
"""Transport urls."""
from django.conf.urls import url
from . import views
urlpatterns = [
url(r"^$", views.TransportListView.as_view(),
name="transport_list"),
url("^create/$", views.TransportCreateView.as_view(),
name="transport_create"),
url("^update/(?P<pk>\d+)/$", views.TransportUpdateView.as_view(),
name="transport_update"),
url("^delete/(?P<pk>\d+)/$", views.TransportDeleteView.as_view(),
name="transport_delete"),
]
+11
View File
@@ -0,0 +1,11 @@
"""Transport API urls."""
from rest_framework import routers
from . import viewsets
router = routers.SimpleRouter()
router.register(
r"transports", viewsets.TransportViewSet, base_name="transport")
urlpatterns = router.urls
+142
View File
@@ -0,0 +1,142 @@
"""Transport views."""
from django import http
from django.core.urlresolvers import reverse, reverse_lazy
from django.utils.translation import ugettext as _, ugettext_lazy
from django.views import generic
from django.contrib.auth import mixins as auth_mixins
from django.contrib import messages
from . import backends
from . import forms
from . import models
class TransportListView(
auth_mixins.PermissionRequiredMixin, generic.ListView):
"""ListView for Transport."""
model = models.Transport
permission_required = "transport.add_transport"
template_name = "transport/transport_list.html"
def get_context_data(self, **kwargs):
"""Inject search query."""
context = super(TransportListView, self).get_context_data(**kwargs)
context.update({
"selection": "domains",
"squery": self.request.GET.get("searchquery")
})
return context
def get_queryset(self):
"""Filter."""
qs = super(TransportListView, self).get_queryset()
searchquery = self.request.GET.get("searchquery")
if searchquery:
qs = qs.filter(pattern__icontains=searchquery)
return qs
class TransportMixin(object):
"""Mixin for Transport creation/update."""
form_class = forms.TransportForm
model = models.Transport
success_message = ugettext_lazy("Transport created")
success_url = reverse_lazy("transport:transport_list")
template_name = "transport/_transport_form.html"
def form_invalid(self, form):
"""Return JSON response."""
return http.JsonResponse({
"form_errors": form.errors,
"prefix": form.prefix
}, status=400)
def form_valid(self, form):
"""Save transport."""
transport = form.save(commit=False)
backend = backends.manager.get_backend(transport.service)
backend.serialize(transport)
options = {}
if not transport.pk:
options.update({"creator": self.request.user})
transport.save(**options)
messages.success(self.request, self.success_message)
return http.JsonResponse({})
def get_context_data(self, **kwargs):
"""Include extra data."""
context = super(TransportMixin, self).get_context_data(
**kwargs)
setting_fields = []
for fname in context["form"].setting_fields:
setting_fields.append(context["form"][fname])
context.update({
"action_classes": "submit",
"formid": "transport_form",
"setting_fields": setting_fields
})
return context
class TransportCreateView(
auth_mixins.PermissionRequiredMixin,
TransportMixin,
generic.CreateView):
"""Transport create view."""
permission_required = "transport.add_transport"
def get_context_data(self, **kwargs):
"""Include extra data."""
context = super(TransportCreateView, self).get_context_data(
**kwargs)
context.update({
"action": reverse("transport:transport_create"),
"action_label": _("Create"),
"title": _("New transport"),
})
return context
class TransportUpdateView(
auth_mixins.PermissionRequiredMixin,
TransportMixin,
generic.UpdateView):
"""Transport update view."""
permission_required = "transport.change_transport"
success_message = ugettext_lazy("Transport updated")
def get_context_data(self, **kwargs):
"""Include extra data."""
context = super(TransportUpdateView, self).get_context_data(
**kwargs)
context.update({
"action": reverse(
"transport:transport_update", args=[self.object.pk]),
"action_label": _("Update"),
"title": _("Edit transport"),
})
return context
class TransportDeleteView(
auth_mixins.PermissionRequiredMixin,
TransportMixin,
generic.DeleteView):
"""Transport delete view."""
model = models.Transport
permission_required = "transport.del_transport"
success_url = reverse_lazy("transport:transport_list")
def delete(self, request, *args, **kwargs):
"""Add message."""
response = super(TransportDeleteView, self).delete(
request, *args, **kwargs)
messages.success(request, _("Transport deleted"))
return response
+18
View File
@@ -0,0 +1,18 @@
"""Transport viewsets."""
from rest_framework import viewsets
from rest_framework.permissions import IsAuthenticated, DjangoModelPermissions
from . import models
from . import serializers
class TransportViewSet(viewsets.ModelViewSet):
"""Transport viewset."""
permission_classes = [IsAuthenticated, DjangoModelPermissions, ]
serializer_class = serializers.TransportSerializer
def get_queryset(self):
"""Filter queryset based on current user."""
return models.Transport.objects.get_for_admin(self.request.user)