James Valleroy d7907e0ef3
diagnostics: Add option to toggle daily run
The option is stored in kvstore. If no value is set, it is assumed to be
enabled.

Tests:

- Disable daily run. In development mode, diagnostic are not run after several
  minutes.

- Enable daily run. In development mode, diagnostics are run after several
  minutes.

Signed-off-by: James Valleroy <jvalleroy@mailbox.org>
[sunil: Minor refactoring and update messages in UI]
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: Sunil Mohan Adapa <sunil@medhas.org>
2024-01-23 11:40:09 -08:00

114 lines
3.4 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.modules import diagnostics
from plinth.views import AppView
from .check import Result
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
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,
})