From 294579b531d5a96a17aa863554e71f4680d35812 Mon Sep 17 00:00:00 2001 From: Elliot Smith Date: Fri, 15 Jan 2016 13:00:49 +0200 Subject: bitbake: toastergui: convert all builds page to ToasterTable For better long-term maintainability, use ToasterTable instead of Django template and view code to display the all builds page. NB the builds.html template has been left in, as this will otherwise cause conflicts when merging the new theme. [YOCTO #8738] (Bitbake rev: e0590fc8103afeb4c5e613a826057555c8193d59) Signed-off-by: Elliot Smith Signed-off-by: Ed Bartosh Signed-off-by: Richard Purdie --- bitbake/lib/toaster/toastergui/querysetfilter.py | 24 ++ bitbake/lib/toaster/toastergui/tables.py | 343 ++++++++++++++++++--- .../toastergui/templates/builds-toastertable.html | 62 ++++ bitbake/lib/toaster/toastergui/urls.py | 5 +- bitbake/lib/toaster/toastergui/views.py | 32 -- bitbake/lib/toaster/toastergui/widgets.py | 16 +- 6 files changed, 403 insertions(+), 79 deletions(-) create mode 100644 bitbake/lib/toaster/toastergui/querysetfilter.py create mode 100644 bitbake/lib/toaster/toastergui/templates/builds-toastertable.html (limited to 'bitbake/lib/toaster/toastergui') diff --git a/bitbake/lib/toaster/toastergui/querysetfilter.py b/bitbake/lib/toaster/toastergui/querysetfilter.py new file mode 100644 index 0000000000..62297e9b89 --- /dev/null +++ b/bitbake/lib/toaster/toastergui/querysetfilter.py @@ -0,0 +1,24 @@ +class QuerysetFilter(object): + """ Filter for a queryset """ + + def __init__(self, criteria=None): + if criteria: + self.set_criteria(criteria) + + def set_criteria(self, criteria): + """ + criteria is an instance of django.db.models.Q; + see https://docs.djangoproject.com/en/1.9/ref/models/querysets/#q-objects + """ + self.criteria = criteria + + def filter(self, queryset): + """ + Filter queryset according to the criteria for this filter, + returning the filtered queryset + """ + return queryset.filter(self.criteria) + + def count(self, queryset): + """ Returns a count of the elements in the filtered queryset """ + return self.filter(queryset).count() diff --git a/bitbake/lib/toaster/toastergui/tables.py b/bitbake/lib/toaster/toastergui/tables.py index 2e3c8a6956..116cff3f43 100644 --- a/bitbake/lib/toaster/toastergui/tables.py +++ b/bitbake/lib/toaster/toastergui/tables.py @@ -20,29 +20,18 @@ # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. from toastergui.widgets import ToasterTable +from toastergui.querysetfilter import QuerysetFilter from orm.models import Recipe, ProjectLayer, Layer_Version, Machine, Project -from orm.models import CustomImageRecipe, Package, Build +from orm.models import CustomImageRecipe, Package, Build, LogMessage, Task from django.db.models import Q, Max, Count from django.conf.urls import url from django.core.urlresolvers import reverse from django.views.generic import TemplateView -class ProjectFiltersMixin(object): - """Common mixin for recipe, machine in project filters""" - - def filter_in_project(self, count_only=False): - query = self.queryset.filter(layer_version__in=self.project_layers) - if count_only: - return query.count() - - self.queryset = query - - def filter_not_in_project(self, count_only=False): - query = self.queryset.exclude(layer_version__in=self.project_layers) - if count_only: - return query.count() - - self.queryset = query +class ProjectFilters(object): + def __init__(self, project_layers): + self.in_project = QuerysetFilter(Q(layer_version__in=project_layers)) + self.not_in_project = QuerysetFilter(~Q(layer_version__in=project_layers)) class LayersTable(ToasterTable): """Table of layers in Toaster""" @@ -60,34 +49,21 @@ class LayersTable(ToasterTable): return context - def setup_filters(self, *args, **kwargs): project = Project.objects.get(pk=kwargs['pid']) self.project_layers = ProjectLayer.objects.filter(project=project) + criteria = Q(projectlayer__in=self.project_layers) + in_project_filter = QuerysetFilter(criteria) + not_in_project_filter = QuerysetFilter(~criteria) self.add_filter(title="Filter by project layers", name="in_current_project", filter_actions=[ - self.make_filter_action("in_project", "Layers added to this project", self.filter_in_project), - self.make_filter_action("not_in_project", "Layers not added to this project", self.filter_not_in_project) + self.make_filter_action("in_project", "Layers added to this project", in_project_filter), + self.make_filter_action("not_in_project", "Layers not added to this project", not_in_project_filter) ]) - def filter_in_project(self, count_only=False): - query = self.queryset.filter(projectlayer__in=self.project_layers) - if count_only: - return query.count() - - self.queryset = query - - def filter_not_in_project(self, count_only=False): - query = self.queryset.exclude(projectlayer__in=self.project_layers) - if count_only: - return query.count() - - self.queryset = query - - def setup_queryset(self, *args, **kwargs): prj = Project.objects.get(pk = kwargs['pid']) compatible_layers = prj.get_all_compatible_layer_versions() @@ -204,7 +180,7 @@ class LayersTable(ToasterTable): computation = lambda x: x.layer.name) -class MachinesTable(ToasterTable, ProjectFiltersMixin): +class MachinesTable(ToasterTable): """Table of Machines in Toaster""" def __init__(self, *args, **kwargs): @@ -221,11 +197,13 @@ class MachinesTable(ToasterTable, ProjectFiltersMixin): def setup_filters(self, *args, **kwargs): project = Project.objects.get(pk=kwargs['pid']) + project_filters = ProjectFilters(self.project_layers) + self.add_filter(title="Filter by project machines", name="in_current_project", filter_actions=[ - self.make_filter_action("in_project", "Machines provided by layers added to this project", self.filter_in_project), - self.make_filter_action("not_in_project", "Machines provided by layers not added to this project", self.filter_not_in_project) + self.make_filter_action("in_project", "Machines provided by layers added to this project", project_filters.in_project), + self.make_filter_action("not_in_project", "Machines provided by layers not added to this project", project_filters.not_in_project) ]) def setup_queryset(self, *args, **kwargs): @@ -313,7 +291,7 @@ class LayerMachinesTable(MachinesTable): static_data_template=select_btn_template) -class RecipesTable(ToasterTable, ProjectFiltersMixin): +class RecipesTable(ToasterTable): """Table of All Recipes in Toaster""" def __init__(self, *args, **kwargs): @@ -338,11 +316,13 @@ class RecipesTable(ToasterTable, ProjectFiltersMixin): return context def setup_filters(self, *args, **kwargs): + project_filters = ProjectFilters(self.project_layers) + self.add_filter(title="Filter by project recipes", name="in_current_project", filter_actions=[ - self.make_filter_action("in_project", "Recipes provided by layers added to this project", self.filter_in_project), - self.make_filter_action("not_in_project", "Recipes provided by layers not added to this project", self.filter_not_in_project) + self.make_filter_action("in_project", "Recipes provided by layers added to this project", project_filters.in_project), + self.make_filter_action("not_in_project", "Recipes provided by layers not added to this project", project_filters.not_in_project) ]) def setup_queryset(self, *args, **kwargs): @@ -853,3 +833,284 @@ class ProjectsTable(ToasterTable): orderable=False, static_data_name='image_files', static_data_template=image_files_template) + +class BuildsTable(ToasterTable): + """Table of builds in Toaster""" + + def __init__(self, *args, **kwargs): + super(BuildsTable, self).__init__(*args, **kwargs) + self.default_orderby = '-completed_on' + self.title = 'All builds' + self.static_context_extra['Build'] = Build + self.static_context_extra['Task'] = Task + + def get_context_data(self, **kwargs): + return super(BuildsTable, self).get_context_data(**kwargs) + + def setup_queryset(self, *args, **kwargs): + queryset = Build.objects.all() + + # don't include in progress builds + queryset = queryset.exclude(outcome=Build.IN_PROGRESS) + + # sort + queryset = queryset.order_by(self.default_orderby) + + # annotate with number of ERROR and EXCEPTION log messages + queryset = queryset.annotate( + errors_no = Count( + 'logmessage', + only = Q(logmessage__level=LogMessage.ERROR) | + Q(logmessage__level=LogMessage.EXCEPTION) + ) + ) + + # annotate with number of WARNING log messages + queryset = queryset.annotate( + warnings_no = Count( + 'logmessage', + only = Q(logmessage__level=LogMessage.WARNING) + ) + ) + + self.queryset = queryset + + def setup_columns(self, *args, **kwargs): + outcome_template = ''' + + {% if data.outcome == data.SUCCEEDED %} + + {% elif data.outcome == data.FAILED %} + + {% endif %} + + + {% if data.cooker_log_path %} +   + + + + {% endif %} + ''' + + recipe_template = ''' + {% for target_label in data.target_labels %} + + {{target_label}} + +
+ {% endfor %} + ''' + + machine_template = ''' + + {{data.machine}} + + ''' + + started_on_template = ''' + + {{data.started_on | date:"d/m/y H:i"}} + + ''' + + completed_on_template = ''' + + {{data.completed_on | date:"d/m/y H:i"}} + + ''' + + failed_tasks_template = ''' + {% if data.failed_tasks.count == 1 %} + + + {{data.failed_tasks.0.recipe.name}}.{{data.failed_tasks.0.task_name}} + + + + + + + {% elif data.failed_tasks.count > 1 %} + + {{data.failed_tasks.count}} tasks + + {% endif %} + ''' + + errors_template = ''' + {% if data.errors.count %} + + {{data.errors.count}} error{{data.errors.count|pluralize}} + + {% endif %} + ''' + + warnings_template = ''' + {% if data.warnings.count %} + + {{data.warnings.count}} warning{{data.warnings.count|pluralize}} + + {% endif %} + ''' + + time_template = ''' + {% load projecttags %} + + {{data.timespent_seconds | sectohms}} + + ''' + + image_files_template = ''' + {% if data.outcome == extra.Build.SUCCEEDED %} + + {{data.get_image_file_extensions}} + + {% endif %} + ''' + + project_template = ''' + {% load project_url_tag %} + + {{data.project.name}} + + {% if data.project.is_default %} + + {% endif %} + ''' + + self.add_column(title='Outcome', + help_text='Final state of the build (successful \ + or failed)', + hideable=False, + orderable=True, + filter_name='outcome_filter', + static_data_name='outcome', + static_data_template=outcome_template) + + self.add_column(title='Recipe', + help_text='What was built (i.e. one or more recipes \ + or image recipes)', + hideable=False, + orderable=False, + static_data_name='target', + static_data_template=recipe_template) + + self.add_column(title='Machine', + help_text='Hardware for which you are building a \ + recipe or image recipe', + hideable=False, + orderable=True, + static_data_name='machine', + static_data_template=machine_template) + + self.add_column(title='Started on', + help_text='The date and time when the build started', + hideable=True, + orderable=True, + static_data_name='started_on', + static_data_template=started_on_template) + + self.add_column(title='Completed on', + help_text='The date and time when the build finished', + hideable=False, + orderable=True, + static_data_name='completed_on', + static_data_template=completed_on_template) + + self.add_column(title='Failed tasks', + help_text='The number of tasks which failed during \ + the build', + hideable=True, + orderable=False, + filter_name='failed_tasks_filter', + static_data_name='failed_tasks', + static_data_template=failed_tasks_template) + + self.add_column(title='Errors', + help_text='The number of errors encountered during \ + the build (if any)', + hideable=True, + orderable=False, + static_data_name='errors', + static_data_template=errors_template) + + self.add_column(title='Warnings', + help_text='The number of warnings encountered during \ + the build (if any)', + hideable=True, + orderable=False, + static_data_name='warnings', + static_data_template=warnings_template) + + self.add_column(title='Time', + help_text='How long the build took to finish', + hideable=False, + orderable=False, + static_data_name='time', + static_data_template=time_template) + + self.add_column(title='Image files', + help_text='The root file system types produced by \ + the build', + hideable=True, + orderable=False, + static_data_name='image_files', + static_data_template=image_files_template) + + self.add_column(title='Project', + hideable=True, + orderable=False, + static_data_name='project-name', + static_data_template=project_template) + + def setup_filters(self, *args, **kwargs): + # outcomes + filter_only_successful_builds = QuerysetFilter(Q(outcome=Build.SUCCEEDED)) + successful_builds_filter = self.make_filter_action( + 'successful_builds', + 'Successful builds', + filter_only_successful_builds + ) + + filter_only_failed_builds = QuerysetFilter(Q(outcome=Build.FAILED)) + failed_builds_filter = self.make_filter_action( + 'failed_builds', + 'Failed builds', + filter_only_failed_builds + ) + + self.add_filter(title='Filter builds by outcome', + name='outcome_filter', + filter_actions = [ + successful_builds_filter, + failed_builds_filter + ]) + + # failed tasks + criteria = Q(task_build__outcome=Task.OUTCOME_FAILED) + filter_only_builds_with_failed_tasks = QuerysetFilter(criteria) + with_failed_tasks_filter = self.make_filter_action( + 'with_failed_tasks', + 'Builds with failed tasks', + filter_only_builds_with_failed_tasks + ) + + criteria = ~Q(task_build__outcome=Task.OUTCOME_FAILED) + filter_only_builds_without_failed_tasks = QuerysetFilter(criteria) + without_failed_tasks_filter = self.make_filter_action( + 'without_failed_tasks', + 'Builds without failed tasks', + filter_only_builds_without_failed_tasks + ) + + self.add_filter(title='Filter builds by failed tasks', + name='failed_tasks_filter', + filter_actions = [ + with_failed_tasks_filter, + without_failed_tasks_filter + ]) diff --git a/bitbake/lib/toaster/toastergui/templates/builds-toastertable.html b/bitbake/lib/toaster/toastergui/templates/builds-toastertable.html new file mode 100644 index 0000000000..419d2b52f4 --- /dev/null +++ b/bitbake/lib/toaster/toastergui/templates/builds-toastertable.html @@ -0,0 +1,62 @@ +{% extends 'base.html' %} + +{% block title %} All builds - Toaster {% endblock %} + +{% block pagecontent %} +
+

+
+ +
+ {# TODO need to pass this data to context #} + {#% include 'mrb_section.html' %#} + + {% url 'builds' as xhr_table_url %} + {% include 'toastertable.html' %} +
+ + +{% endblock %} diff --git a/bitbake/lib/toaster/toastergui/urls.py b/bitbake/lib/toaster/toastergui/urls.py index b5e9a0554d..707b7d5f20 100644 --- a/bitbake/lib/toaster/toastergui/urls.py +++ b/bitbake/lib/toaster/toastergui/urls.py @@ -27,7 +27,10 @@ urlpatterns = patterns('toastergui.views', # landing page url(r'^landing/$', 'landing', name='landing'), - url(r'^builds/$', 'builds', name='all-builds'), + url(r'^builds/$', + tables.BuildsTable.as_view(template_name="builds-toastertable.html"), + name='all-builds'), + # build info navigation url(r'^build/(?P\d+)$', 'builddashboard', name="builddashboard"), diff --git a/bitbake/lib/toaster/toastergui/views.py b/bitbake/lib/toaster/toastergui/views.py index a79261de96..295773fc66 100755 --- a/bitbake/lib/toaster/toastergui/views.py +++ b/bitbake/lib/toaster/toastergui/views.py @@ -1915,34 +1915,6 @@ if True: ''' The exception raised on invalid POST requests ''' pass - # shows the "all builds" page for managed mode; it displays build requests (at least started!) instead of actual builds - # WARNING _build_list_helper() may raise a RedirectException, which - # will set the GET parameters and redirect back to the - # all-builds or projectbuilds page as appropriate; - # TODO don't use exceptions to control program flow - @_template_renderer("builds.html") - def builds(request): - # define here what parameters the view needs in the GET portion in order to - # be able to display something. 'count' and 'page' are mandatory for all views - # that use paginators. - - queryset = Build.objects.all() - - redirect_page = resolve(request.path_info).url_name - - context, pagesize, orderby = _build_list_helper(request, - queryset, - redirect_page) - # all builds page as a Project column - context['tablecols'].append({ - 'name': 'Project', - 'clclass': 'project_column' - }) - - _set_parameters_values(pagesize, orderby, request) - return context - - # helper function, to be used on "all builds" and "project builds" pages def _build_list_helper(request, queryset_all, redirect_page, pid=None): default_orderby = 'completed_on:-' @@ -1986,10 +1958,6 @@ if True: warnings_no = Count('logmessage', only=q_warnings) ) - # add timespent field - timespent = 'completed_on - started_on' - queryset_all = queryset_all.extra(select={'timespent': timespent}) - queryset_with_search = _get_queryset(Build, queryset_all, None, search_term, ordering_string, '-completed_on') diff --git a/bitbake/lib/toaster/toastergui/widgets.py b/bitbake/lib/toaster/toastergui/widgets.py index 6bb388936c..71b29eaa1e 100644 --- a/bitbake/lib/toaster/toastergui/widgets.py +++ b/bitbake/lib/toaster/toastergui/widgets.py @@ -32,6 +32,7 @@ from django.template import Context, Template from django.core.serializers.json import DjangoJSONEncoder from django.core.exceptions import FieldError from django.conf.urls import url, patterns +from toastergui.querysetfilter import QuerysetFilter import types import json @@ -113,7 +114,8 @@ class ToasterTable(TemplateView): cls=DjangoJSONEncoder) else: for actions in self.filters[name]['filter_actions']: - actions['count'] = self.filter_actions[actions['name']](count_only=True) + queryset_filter = self.filter_actions[actions['name']] + actions['count'] = queryset_filter.count(self.queryset) # Add the "All" items filter action self.filters[name]['filter_actions'].insert(0, { @@ -151,15 +153,18 @@ class ToasterTable(TemplateView): 'filter_actions' : filter_actions, } - def make_filter_action(self, name, title, action_function): - """ Utility to make a filter_action """ + def make_filter_action(self, name, title, queryset_filter): + """ + Utility to make a filter_action; queryset_filter is an instance + of QuerysetFilter or a function + """ action = { 'title' : title, 'name' : name, } - self.filter_actions[name] = action_function + self.filter_actions[name] = queryset_filter return action @@ -222,7 +227,8 @@ class ToasterTable(TemplateView): return try: - self.filter_actions[filter_action]() + queryset_filter = self.filter_actions[filter_action] + self.queryset = queryset_filter.filter(self.queryset) except KeyError: # pass it to the user - programming error here raise -- cgit v1.2.3-54-g00ecf