465 lines
17 KiB
Python
465 lines
17 KiB
Python
# w.c.s. - web application for online forms
|
|
# Copyright (C) 2005-2022 Entr'ouvert
|
|
#
|
|
# This program is free software; you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation; either version 2 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 General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with this program; if not, see <http://www.gnu.org/licenses/>.
|
|
|
|
import json
|
|
|
|
from django.template.loader import render_to_string
|
|
from django.utils.timezone import now
|
|
from quixote import get_publisher, get_request, get_response, get_session, redirect
|
|
from quixote.directory import Directory
|
|
from quixote.html import TemplateIO, htmltext
|
|
|
|
from wcs.backoffice.management import FormBackofficeEditPage, FormBackOfficeStatusPage
|
|
from wcs.backoffice.pagination import pagination_links
|
|
from wcs.forms.common import FormStatusPage
|
|
from wcs.qommon import _, misc, template
|
|
from wcs.qommon.afterjobs import AfterJob
|
|
from wcs.qommon.errors import TraversalError
|
|
from wcs.qommon.form import FileWidget, Form, SingleSelectWidget, StringWidget
|
|
from wcs.sql_criterias import Equal
|
|
from wcs.testdef import TestDef, TestError, TestResult
|
|
|
|
|
|
class TestEditPage(FormBackofficeEditPage):
|
|
filling_templates = ['wcs/backoffice/testdata_filling.html']
|
|
edit_mode_submit_label = _('Save data')
|
|
|
|
def __init__(self, *args, testdef, filled, **kwargs):
|
|
super().__init__(*args, **kwargs)
|
|
self.testdef = testdef
|
|
self.edited_data = filled
|
|
self.edited_data.data['edited_testdef_id'] = self.testdef.id
|
|
self._q_exports.append(('mark-as-failing', 'mark_as_failing'))
|
|
|
|
def _q_index(self):
|
|
get_response().breadcrumb.append(('edit-data/', _('Edit data')))
|
|
return super()._q_index()
|
|
|
|
def modify_filling_context(self, context, *args, **kwargs):
|
|
super().modify_filling_context(context, *args, **kwargs)
|
|
|
|
form = context['html_form']
|
|
if form.get_submit() == 'submit':
|
|
self.testdef.data['expected_error'] = None
|
|
|
|
get_response().filter['sidebar'] = self.get_test_sidebar(form)
|
|
|
|
def get_test_sidebar(self, form):
|
|
context = {'testdef': self.testdef, 'mark_as_failing_form': self.get_mark_as_failing_form(form)}
|
|
return render_to_string('wcs/backoffice/test_edit_sidebar.html', context=context)
|
|
|
|
def get_mark_as_failing_form(self, form):
|
|
errors = form.global_error_messages or []
|
|
|
|
if not errors and not form.has_errors():
|
|
return
|
|
|
|
for widget in form.widgets:
|
|
widget = TestDef.get_error_widget(widget)
|
|
if widget:
|
|
errors.append(widget.error)
|
|
|
|
if len(errors) != 1:
|
|
return
|
|
|
|
form = Form(enctype='multipart/form-data', action='mark-as-failing', use_tokens=False)
|
|
form.add_hidden('error', errors[0])
|
|
form.test_error = errors[0]
|
|
|
|
magictoken = get_request().form.get('magictoken')
|
|
form.add_hidden('magictoken', magictoken)
|
|
|
|
form.add_submit('submit', _('Mark as failing'))
|
|
return form
|
|
|
|
def mark_as_failing(self):
|
|
if not get_request().get_method() == 'POST':
|
|
raise TraversalError()
|
|
|
|
magictoken = get_request().form.get('magictoken')
|
|
edited_data = self.get_transient_formdata(magictoken)
|
|
|
|
testdef = TestDef.create_from_formdata(self.formdef, edited_data)
|
|
self.testdef.data = testdef.data
|
|
|
|
self.testdef.data['expected_error'] = get_request().form.get('error')
|
|
self.testdef.store()
|
|
return redirect('..')
|
|
|
|
|
|
class TestPage(FormBackOfficeStatusPage):
|
|
_q_extra_exports = ['delete', 'export', 'edit', ('edit-data', 'edit_data'), 'duplicate']
|
|
|
|
def __init__(self, component, objectdef):
|
|
try:
|
|
self.testdef = TestDef.get(component)
|
|
except KeyError:
|
|
raise TraversalError()
|
|
|
|
filled = self.testdef.build_formdata(objectdef, include_fields=True)
|
|
super().__init__(objectdef, filled)
|
|
|
|
@property
|
|
def edit_data(self):
|
|
return TestEditPage(
|
|
self.formdef.url_name, update_breadcrumbs=False, testdef=self.testdef, filled=self.filled
|
|
)
|
|
|
|
def _q_index(self):
|
|
get_response().add_javascript(['select2.js'])
|
|
return super()._q_index()
|
|
|
|
def _q_traverse(self, path):
|
|
get_response().breadcrumb.append((str(self.testdef.id) + '/', str(self.testdef)))
|
|
return super(FormStatusPage, self)._q_traverse(path)
|
|
|
|
def should_fold_summary(self, mine, request_user):
|
|
return False
|
|
|
|
def get_extra_context_bar(self, parent=None):
|
|
return render_to_string('wcs/backoffice/test_sidebar.html', context={})
|
|
|
|
def status(self):
|
|
r = TemplateIO(html=True)
|
|
r += htmltext('<div id="appbar">')
|
|
r += htmltext('<h2>%s</h2>') % self.testdef
|
|
r += htmltext('<span class="actions">')
|
|
r += htmltext('<a href="edit-data/">%s</a>') % _('Edit data')
|
|
r += htmltext('</span>')
|
|
r += htmltext('</div>')
|
|
if self.testdef.data.get('expected_error'):
|
|
r += htmltext('<div class="infonotice"><p>%s</p></div>') % (
|
|
_('This test is expected to fail on error "%s".') % self.testdef.data['expected_error']
|
|
)
|
|
if self.testdef.data['fields']:
|
|
r += self.receipt(always_include_user=True, mine=False)
|
|
else:
|
|
r += htmltext('<div class="infonotice"><p>%s</p></div>') % _('This test is empty.')
|
|
return r.getvalue()
|
|
|
|
def delete(self):
|
|
form = Form(enctype='multipart/form-data')
|
|
form.add_submit('delete', _('Delete'))
|
|
form.add_submit('cancel', _('Cancel'))
|
|
|
|
if form.get_widget('cancel').parse():
|
|
return redirect('.')
|
|
if not form.is_submitted() or form.has_errors():
|
|
get_response().breadcrumb.append(('delete', _('Delete')))
|
|
r = TemplateIO(html=True)
|
|
r += htmltext('<h2>%s %s</h2>') % (_('Deleting Test:'), self.testdef)
|
|
r += form.render()
|
|
return r.getvalue()
|
|
else:
|
|
TestDef.remove_object(self.testdef.id)
|
|
return redirect('..')
|
|
|
|
def export(self):
|
|
get_response().set_content_type('application/json')
|
|
get_response().set_header(
|
|
'content-disposition', 'attachment; filename=wcs_test_%s.json' % self.testdef.name
|
|
)
|
|
return json.dumps(self.testdef.export_to_json())
|
|
|
|
def edit(self):
|
|
form = Form(enctype='multipart/form-data')
|
|
form.add(StringWidget, 'name', title=_('Name'), required=True, size=50, value=self.testdef.name)
|
|
|
|
user_options = [('', '---', '')] + [
|
|
(x.id, str(x), x.id) for x in get_publisher().user_class.select(order_by='name')
|
|
]
|
|
form.add(
|
|
SingleSelectWidget,
|
|
'user',
|
|
title=_('User'),
|
|
value=self.testdef.data['user'].get('id', '') if self.testdef.data['user'] else '',
|
|
options=user_options,
|
|
**{'data-autocomplete': 'true'},
|
|
)
|
|
|
|
form.add_submit('submit', _('Submit'))
|
|
form.add_submit('cancel', _('Cancel'))
|
|
|
|
if form.get_widget('cancel').parse():
|
|
return redirect('.')
|
|
if not form.is_submitted() or form.has_errors():
|
|
get_response().breadcrumb.append(('edit', _('Edit test')))
|
|
r = TemplateIO(html=True)
|
|
r += htmltext('<h2>%s</h2>') % (_('Edit test'))
|
|
r += form.render()
|
|
return r.getvalue()
|
|
else:
|
|
self.testdef.name = form.get_widget('name').parse()
|
|
|
|
user_id = form.get_widget('user').parse()
|
|
if user_id:
|
|
user = get_publisher().user_class.get(user_id)
|
|
self.testdef.data['user'] = user.get_json_export_dict()
|
|
else:
|
|
self.testdef.data['user'] = None
|
|
|
|
self.testdef.store()
|
|
return redirect('.')
|
|
|
|
def duplicate(self):
|
|
form = Form(enctype='multipart/form-data')
|
|
name_widget = form.add(StringWidget, 'name', title=_('Name'), required=True, size=30)
|
|
form.add_submit('submit', _('Submit'))
|
|
form.add_submit('cancel', _('Cancel'))
|
|
if form.get_widget('cancel').parse():
|
|
return redirect('.')
|
|
|
|
if not form.is_submitted():
|
|
original_name = self.testdef.name
|
|
new_name = '%s %s' % (original_name, _('(copy)'))
|
|
names = [x.name for x in TestDef.select_for_objectdef(self.formdef)]
|
|
no = 2
|
|
while new_name in names:
|
|
new_name = _('%(name)s (copy %(no)d)') % {'name': original_name, 'no': no}
|
|
no += 1
|
|
name_widget.set_value(new_name)
|
|
|
|
if not form.is_submitted() or form.has_errors():
|
|
get_response().set_title(_('Duplicate test'))
|
|
r = TemplateIO(html=True)
|
|
get_response().breadcrumb.append(('duplicate', _('Duplicate')))
|
|
r += htmltext('<h2>%s</h2>') % _('Duplicate test')
|
|
r += form.render()
|
|
return r.getvalue()
|
|
|
|
self.testdef.id = None
|
|
self.testdef.slug = None
|
|
self.testdef.name = form.get_widget('name').parse()
|
|
self.testdef.store()
|
|
return redirect(self.testdef.get_admin_url())
|
|
|
|
|
|
class TestsDirectory(Directory):
|
|
_q_exports = ['', 'new', ('import', 'p_import'), 'results']
|
|
section = 'tests'
|
|
|
|
def __init__(self, objectdef):
|
|
self.objectdef = objectdef
|
|
self.results = TestResultsDirectory(objectdef)
|
|
|
|
def _q_traverse(self, path):
|
|
get_response().breadcrumb.append(('tests/', _('Tests')))
|
|
return super()._q_traverse(path)
|
|
|
|
def _q_lookup(self, component):
|
|
return TestPage(component, self.objectdef)
|
|
|
|
def _q_index(self):
|
|
context = {
|
|
'testdefs': TestDef.select_for_objectdef(self.objectdef),
|
|
'has_deprecated_fields': any(
|
|
x.type in ('table', 'table-select', 'tablerows', 'ranked-items')
|
|
for x in self.objectdef.fields
|
|
),
|
|
'has_sidebar': True,
|
|
}
|
|
get_response().add_javascript(['popup.js'])
|
|
get_response().set_title(_('Tests'))
|
|
return template.QommonTemplateResponse(
|
|
templates=['wcs/backoffice/tests.html'], context=context, is_django_native=True
|
|
)
|
|
|
|
def new(self):
|
|
form = Form(enctype='multipart/form-data')
|
|
form.add(StringWidget, 'name', title=_('Name'), required=True, size=50)
|
|
form.add_submit('submit', _('Submit'))
|
|
form.add_submit('cancel', _('Cancel'))
|
|
|
|
if form.get_widget('cancel').parse():
|
|
return redirect('.')
|
|
|
|
if not form.is_submitted() or form.has_errors():
|
|
get_response().breadcrumb.append(('new', _('New')))
|
|
get_response().set_title(_('New test'))
|
|
r = TemplateIO(html=True)
|
|
r += htmltext('<h2>%s</h2>') % _('New test')
|
|
r += form.render()
|
|
return r.getvalue()
|
|
|
|
# create empty test
|
|
testdef = TestDef.create_from_formdata(self.objectdef, self.objectdef.data_class()())
|
|
testdef.name = form.get_widget('name').parse()
|
|
testdef.store()
|
|
|
|
return redirect(testdef.get_admin_url() + 'edit-data/')
|
|
|
|
def p_import(self):
|
|
form = Form(enctype='multipart/form-data')
|
|
|
|
form.add(FileWidget, 'file', title=_('File'), required=True)
|
|
form.add_submit('submit', _('Import Test'))
|
|
form.add_submit('cancel', _('Cancel'))
|
|
|
|
if form.get_submit() == 'cancel':
|
|
return redirect('.')
|
|
|
|
if form.is_submitted() and not form.has_errors():
|
|
try:
|
|
return self.import_submit(form)
|
|
except ValueError:
|
|
pass
|
|
|
|
get_response().breadcrumb.append(('import', _('Import')))
|
|
get_response().set_title(_('Import Test'))
|
|
r = TemplateIO(html=True)
|
|
r += htmltext('<h2>%s</h2>') % _('Import Test')
|
|
r += htmltext('<p>%s</p>') % _(
|
|
'You can add a new test or update an existing one by importing a JSON file.'
|
|
)
|
|
r += form.render()
|
|
return r.getvalue()
|
|
|
|
def import_submit(self, form):
|
|
fp = form.get_widget('file').parse().fp
|
|
|
|
try:
|
|
testdef = TestDef.import_from_json(json.loads(fp.read()))
|
|
except Exception as e:
|
|
form.set_error('file', str(e))
|
|
raise ValueError()
|
|
|
|
get_session().message = ('info', _('Test "%s" has been successfully imported.') % testdef.name)
|
|
return redirect('.')
|
|
|
|
|
|
class TestResultPage(Directory):
|
|
_q_exports = ['']
|
|
|
|
def __init__(self, component, objectdef):
|
|
try:
|
|
self.test_result = TestResult.get(component)
|
|
except KeyError:
|
|
raise TraversalError()
|
|
|
|
self.objectdef = objectdef
|
|
|
|
def _q_traverse(self, path):
|
|
get_response().breadcrumb.append(
|
|
(str(self.test_result.id) + '/', _('Result #%s') % self.test_result.id)
|
|
)
|
|
return super()._q_traverse(path)
|
|
|
|
def _q_index(self):
|
|
testdefs = TestDef.select_for_objectdef(self.objectdef)
|
|
testdefs_by_id = {x.id: x for x in testdefs}
|
|
for test in self.test_result.results:
|
|
if test['id'] in testdefs_by_id:
|
|
test['url'] = testdefs_by_id[test['id']].get_admin_url()
|
|
|
|
return template.QommonTemplateResponse(
|
|
templates=['wcs/backoffice/test-result.html'],
|
|
context={'test_result': self.test_result},
|
|
is_django_native=True,
|
|
)
|
|
|
|
|
|
class TestResultsDirectory(Directory):
|
|
_q_exports = ['', 'run']
|
|
section = 'test_results'
|
|
|
|
def __init__(self, objectdef):
|
|
self.objectdef = objectdef
|
|
|
|
def _q_traverse(self, path):
|
|
get_response().breadcrumb.append(('results/', _('Test results')))
|
|
get_response().set_title('%s - %s' % (self.objectdef.name, _('Test results')))
|
|
return super()._q_traverse(path)
|
|
|
|
def _q_lookup(self, component):
|
|
return TestResultPage(component, self.objectdef)
|
|
|
|
def _q_index(self):
|
|
criterias = [
|
|
Equal('object_type', self.objectdef.get_table_name()),
|
|
Equal('object_id', self.objectdef.id),
|
|
]
|
|
|
|
offset = misc.get_int_or_400(get_request().form.get('offset', 0))
|
|
limit = misc.get_int_or_400(get_request().form.get('limit', 25))
|
|
total_count = TestResult.count(criterias)
|
|
|
|
context = {
|
|
'test_results': TestResult.select(criterias, offset=offset, limit=limit, order_by='-id'),
|
|
'has_testdefs': bool(TestDef.count(criterias)),
|
|
'pagination_links': pagination_links(offset, limit, total_count, load_js=False),
|
|
}
|
|
return template.QommonTemplateResponse(
|
|
templates=['wcs/backoffice/test-results.html'], context=context, is_django_native=True
|
|
)
|
|
|
|
def run(self):
|
|
test_result = TestsAfterJob.run_tests(self.objectdef, _('Manual run.'))
|
|
return redirect(test_result.get_admin_url())
|
|
|
|
|
|
class TestsAfterJob(AfterJob):
|
|
def __init__(self, objectdef, reason, snapshot=None, **kwargs):
|
|
super().__init__(
|
|
objectdef_class=objectdef.__class__,
|
|
objectdef_id=objectdef.id,
|
|
reason=reason,
|
|
snapshot_id=snapshot.id if snapshot else None,
|
|
**kwargs,
|
|
)
|
|
|
|
def execute(self):
|
|
objectdef = self.kwargs['objectdef_class'].get(self.kwargs['objectdef_id'])
|
|
reason = self.kwargs['reason']
|
|
|
|
result = self.run_tests(objectdef, reason)
|
|
|
|
if result and self.kwargs['snapshot_id'] is not None:
|
|
snapshot = get_publisher().snapshot_class.get(self.kwargs['snapshot_id'])
|
|
snapshot.test_result_id = result.id
|
|
snapshot.store()
|
|
|
|
@staticmethod
|
|
def run_tests(objectdef, reason):
|
|
testdefs = TestDef.select_for_objectdef(objectdef)
|
|
if not testdefs:
|
|
return
|
|
|
|
for test in testdefs:
|
|
try:
|
|
test.run(objectdef)
|
|
except TestError as e:
|
|
test.error = str(e)
|
|
|
|
test_result = TestResult()
|
|
test_result.object_type = objectdef.get_table_name()
|
|
test_result.object_id = objectdef.id
|
|
test_result.timestamp = now()
|
|
test_result.success = not any(hasattr(test, 'error') for test in testdefs)
|
|
test_result.reason = str(reason)
|
|
test_result.results = [
|
|
{
|
|
'id': test.id,
|
|
'name': str(test),
|
|
'error': getattr(test, 'error', None),
|
|
'missing_required_fields': test.missing_required_fields,
|
|
}
|
|
for test in testdefs
|
|
]
|
|
test_result.results.sort(key=lambda x: not bool(x['error']))
|
|
test_result.store()
|
|
|
|
return test_result
|