mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-01-21 07:55:00 +00:00
4b09d91f93
Helps: #2410. - Ensure that diagnostics methods and parameters are type checked so that we can catch any potential issues. - Move plinth/modules/diagnostics/check.py to plinth/diagnostic_check.py to avoid many circular dependencies created. This is due to plinth.modules.diagnostics automatically imported when plinth.modules.diagnostics.check is imported. Also app.py is already (type) dependent on diagnostic_check due to diagnose() method. To make the Check classes independent of diagnostic module is okay. Tests: - Run make check-type. - Run full diagnostics with following apps installed: torproxy, tor. - Test to netcat to 9051 in tor works. - Test 'port available for internal/external networks' in firewall works. - Test 'Package is latest' works. - Test 'Access url with proxy' in privoxy works. Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org> Reviewed-by: James Valleroy <jvalleroy@mailbox.org> [jvalleroy: Also move tests for diagnostic_check] Signed-off-by: James Valleroy <jvalleroy@mailbox.org>
118 lines
3.6 KiB
Python
118 lines
3.6 KiB
Python
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
"""
|
|
FreedomBox app for running diagnostics.
|
|
"""
|
|
|
|
import logging
|
|
|
|
from django.contrib import messages
|
|
from django.http import Http404
|
|
from django.template.response import TemplateResponse
|
|
from django.utils.translation import gettext_lazy as _
|
|
from django.views.decorators.http import require_POST
|
|
from django.views.generic import TemplateView
|
|
|
|
from plinth import operation
|
|
from plinth.app import App
|
|
from plinth.diagnostic_check import Result
|
|
from plinth.modules import diagnostics
|
|
from plinth.views import AppView
|
|
|
|
from .forms import ConfigureForm
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
class DiagnosticsView(AppView):
|
|
"""Diagnostics app page."""
|
|
|
|
app_id = 'diagnostics'
|
|
form_class = ConfigureForm
|
|
template_name = 'diagnostics.html'
|
|
|
|
def get_context_data(self, **kwargs):
|
|
"""Return additional context for rendering the template."""
|
|
context = super().get_context_data(**kwargs)
|
|
context['has_diagnostics'] = False
|
|
context['results_available'] = diagnostics.are_results_available()
|
|
return context
|
|
|
|
def get_initial(self):
|
|
"""Return the initial values for the form."""
|
|
status = super().get_initial()
|
|
status['daily_run_enabled'] = diagnostics.is_daily_run_enabled()
|
|
return status
|
|
|
|
def form_valid(self, form):
|
|
"""Apply the form changes."""
|
|
old_status = form.initial
|
|
new_status = form.cleaned_data
|
|
if old_status['daily_run_enabled'] != new_status['daily_run_enabled']:
|
|
diagnostics.set_daily_run_enabled(new_status['daily_run_enabled'])
|
|
messages.success(self.request, _('Configuration updated.'))
|
|
|
|
return super().form_valid(form)
|
|
|
|
|
|
class DiagnosticsFullView(TemplateView):
|
|
"""View to run full diagnostics."""
|
|
|
|
template_name = 'diagnostics_full.html'
|
|
|
|
def post(self, request):
|
|
"""Start diagnostics."""
|
|
diagnostics.start_diagnostics()
|
|
return self.get(self, request)
|
|
|
|
def get_context_data(self, **kwargs):
|
|
"""Return additional context for rendering the template."""
|
|
try:
|
|
is_task_running = bool(operation.manager.get('diagnostics-full'))
|
|
except KeyError:
|
|
is_task_running = False
|
|
|
|
context = super().get_context_data(**kwargs)
|
|
context['is_task_running'] = is_task_running
|
|
context['results'] = diagnostics.get_results()
|
|
context['refresh_page_sec'] = 3 if is_task_running else None
|
|
exception = context['results'].pop('exception', None)
|
|
if exception:
|
|
messages.error(self.request, exception)
|
|
|
|
return context
|
|
|
|
|
|
@require_POST
|
|
def diagnose_app(request, app_id):
|
|
"""Return diagnostics for a particular app."""
|
|
try:
|
|
app = App.get(app_id)
|
|
except KeyError:
|
|
raise Http404('App does not exist')
|
|
app_name = app.info.name or app_id
|
|
|
|
diagnosis = None
|
|
diagnosis_exception = None
|
|
try:
|
|
diagnosis = app.diagnose()
|
|
except Exception as exception:
|
|
logger.exception('Error running %s diagnostics - %s', app_id,
|
|
exception)
|
|
diagnosis_exception = str(exception)
|
|
|
|
show_rerun_setup = False
|
|
for check in diagnosis:
|
|
if check.result in [Result.FAILED, Result.WARNING]:
|
|
show_rerun_setup = True
|
|
break
|
|
|
|
return TemplateResponse(
|
|
request, 'diagnostics_app.html', {
|
|
'title': _('Diagnostic Test'),
|
|
'app_id': app_id,
|
|
'app_name': app_name,
|
|
'results': diagnosis,
|
|
'exception': diagnosis_exception,
|
|
'show_rerun_setup': show_rerun_setup,
|
|
})
|