Produits Entr'ouvert » Hobo

# hobo - portal to configure and deploy applications

# Copyright (C) 2015-2022  Entr'ouvert

#

# This program is free software: you can redistribute it and/or modify it

# under the terms of the GNU Affero General Public License as published

# by the Free Software Foundation, either version 3 of the License, or

# (at your option) any later version.

#

# This program is distributed in the hope that it will be useful,

# but WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

# GNU Affero General Public License for more details.

#

# You should have received a copy of the GNU Affero General Public License

# along with this program.  If not, see <http://www.gnu.org/licenses/>.

from django import forms

from django.utils.translation import ugettext_lazy as _

class MaintenanceForm(forms.Form):

    maintenance_page = forms.BooleanField(required=False, label=_('Enable maintenance page'))

    maintenance_pass_trough_header = forms.CharField(

        required=False, label=_('Maintenance HTTP header pass through')

    )

    disable_cron = forms.BooleanField(required=False, label=_('Disable cron jobs'))

{% extends "hobo/base.html" %}

{% load i18n %}

{% block breadcrumb %}

{{ block.super }}

<a href="{% url 'maintenance-home' %}">{% trans "Maintenance" %}</a>

{% endblock %}

{% block appbar %}

<h2>{% trans 'Maintenance' %}</h2>

{% endblock %}

{% block content %}

{% if pass_through_ips %}

<div class="infonotice">

  {% blocktrans %}IP addresses configured to pass through the maintenance page:{% endblocktrans %} {{ pass_through_ips }}

</div>

{% else %}

<div class="warningnotice">

  {% trans "No IP addresses configured to pass through the maintenance page." %}

</div>

{% endif %}

<form action="." method="post">

  {% csrf_token %}

  {{ form.as_p }}

  <div class="buttons">

    <button>{% trans "Submit" %}</button>

  </div>

</form>

{% endblock %}

# hobo - portal to configure and deploy applications

# Copyright (C) 2015-2022 Entr'ouvert

#

# This program is free software: you can redistribute it and/or modify it

# under the terms of the GNU Affero General Public License as published

# by the Free Software Foundation, either version 3 of the License, or

# (at your option) any later version.

#

# This program is distributed in the hope that it will be useful,

# but WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

# GNU Affero General Public License for more details.

#

# You should have received a copy of the GNU Affero General Public License

# along with this program.  If not, see <http://www.gnu.org/licenses/>.

from django.conf.urls import url

from . import views

urlpatterns = [

    url(r'^$', views.home, name='maintenance-home'),

]

# hobo - portal to configure and deploy applications

# Copyright (C) 2015-2022 Entr'ouvert

#

# This program is free software: you can redistribute it and/or modify it

# under the terms of the GNU Affero General Public License as published

# by the Free Software Foundation, either version 3 of the License, or

# (at your option) any later version.

#

# This program is distributed in the hope that it will be useful,

# but WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

# GNU Affero General Public License for more details.

#

# You should have received a copy of the GNU Affero General Public License

# along with this program.  If not, see <http://www.gnu.org/licenses/>.

from django.conf import settings

from django.urls import reverse_lazy

from django.utils.functional import cached_property

from django.views.generic import FormView

from hobo.environment.utils import get_setting_variable

from .forms import MaintenanceForm

class HomeView(FormView):

    template_name = 'hobo/maintenance/home.html'

    form_class = MaintenanceForm

    success_url = reverse_lazy('maintenance-home')

    @cached_property

    def maintenance_page_variable(self):

        return get_setting_variable('MAINTENANCE_PAGE')

    @cached_property

    def maintenance_pass_trough_header_variable(self):

        return get_setting_variable('MAINTENANCE_PASS_THROUGH_HEADER')

    @cached_property

    def tenant_disable_cron_jobs_variable(self):

        return get_setting_variable('TENANT_DISABLE_CRON_JOBS')

    def get_initial(self):

        initial = super().get_initial()

        initial['maintenance_page'] = bool(self.maintenance_page_variable.json)

        initial['maintenance_pass_trough_header'] = self.maintenance_pass_trough_header_variable.value

        initial['disable_cron'] = bool(self.tenant_disable_cron_jobs_variable.json)

        return initial

    def form_valid(self, form):

        self.maintenance_page_variable.json = form.cleaned_data['maintenance_page']

        self.maintenance_page_variable.save()

        self.maintenance_pass_trough_header_variable.value = form.cleaned_data[

            'maintenance_pass_trough_header'

        ]

        self.maintenance_pass_trough_header_variable.save()

        self.tenant_disable_cron_jobs_variable.json = form.cleaned_data['disable_cron']

        self.tenant_disable_cron_jobs_variable.save()

        return super().form_valid(form)

    def get_context_data(self, **kwargs):

        ctx = super().get_context_data(**kwargs)

        pass_through_ips_setting = getattr(settings, 'MAINTENANCE_PASS_THROUGH_IPS', [])

        ctx['pass_through_ips'] = ', '.join(pass_through_ips_setting)

        return ctx

home = HomeView.as_view()

    'hobo.maintenance',

 <a class="button button-paragraph" href="{% url 'maintenance-home' %}">{% trans 'Maintenance' %}</a>

from .maintenance.urls import urlpatterns as maintenance_urls

    url(r'^maintenance/', decorated_includes(admin_required, include(maintenance_urls))),

from hobo.environment.models import Variable

def test_manage(app, admin_user, settings):

    assert Variable.objects.filter(name='SETTING_MAINTENANCE_PAGE').count() == 0

    assert Variable.objects.filter(name='SETTING_MAINTENANCE_PASS_THROUGH_HEADER').count() == 0

    assert Variable.objects.filter(name='TENANT_DISABLE_CRON_JOBS').count() == 0

    assert not getattr(settings, 'MAINTENANCE_PASS_THROUGH_IPS', [])

    login(app)

    resp = app.get('/maintenance/')

    assert 'No IP addresses configured' in resp.text

    resp.form.set('maintenance_page', True)

    resp.form.set('maintenance_pass_trough_header', 'X-Entrouvert')

    resp.form.set('disable_cron', True)

    resp = resp.form.submit().follow()

    assert Variable.objects.filter(name='SETTING_MAINTENANCE_PAGE').get().value == 'true'

    assert (

        Variable.objects.filter(name='SETTING_MAINTENANCE_PASS_THROUGH_HEADER').get().value == 'X-Entrouvert'

    )

    assert Variable.objects.filter(name='SETTING_TENANT_DISABLE_CRON_JOBS').get().value == 'true'

    resp.form.set('maintenance_page', False)

    resp.form.set('maintenance_pass_trough_header', '')

    resp.form.set('disable_cron', False)

    resp = resp.form.submit().follow()

    assert Variable.objects.filter(name='SETTING_MAINTENANCE_PAGE').get().value == 'false'

    assert Variable.objects.filter(name='SETTING_MAINTENANCE_PASS_THROUGH_HEADER').get().value == ''

    assert Variable.objects.filter(name='SETTING_TENANT_DISABLE_CRON_JOBS').get().value == 'false'

    settings.MAINTENANCE_PASS_THROUGH_IPS = ['127.0.0.1', '127.0.0.2']

    resp = app.get('/maintenance/')

    assert 'IP addresses configured to pass through the maintenance page: 127.0.0.1, 127.0.0.2' in resp.text