[IMP] runbot: allow bundle tagging

The purppose of this commit is to facilitate the Odoo freeze process.

A new BundleTag model is added that allows to tag bundles.
A frontend controller is also added to list bundles with a particular
tag.

A "description" compute stored field is added on the bundle. By default
the PR titles are used to fill the description.

A "team_id" compute stored field is added to help classifying the
bundles. The computed attribution is based on the Odoo convention that a
branch name should end with the employee n-gram.

Author: d-fence

runbot/__manifest__.py

@@ -39,6 +39,7 @@
         'templates/build_error.xml',
         'templates/batches_by_date.xml',
         'templates/commit_link_details.xml',
+        'templates/bundles_by_tag.xml',
 
         'views/branch_views.xml',
         'views/build_error_link_views.xml',

runbot/controllers/frontend.py

@@ -1,7 +1,7 @@
 import datetime
 import functools
 import logging
-from collections import OrderedDict
+from collections import OrderedDict, defaultdict
 from subprocess import CalledProcessError
 from urllib.parse import urlsplit
 
@@ -79,7 +79,7 @@ def _pending(self):
             '/runbot',
             '/runbot/<model("runbot.project"):project>',
             '/runbot/<model("runbot.project"):project>/search/<search>'], website=True, auth='public', type='http')
-    def bundles(self, project=None, search='', refresh=False, for_next_freeze=False, limit=40, has_pr=None, **kwargs):
+    def bundles(self, project=None, search='', refresh=False, limit=40, has_pr=None, **kwargs):
         search = search if len(search) < 60 else search[:60]
         env = request.env
         categories = env['runbot.category'].search([])
@@ -114,9 +114,6 @@ def bundles(self, project=None, search='', refresh=False, for_next_freeze=False,
             elif filter_mode == 'default' and not search:
                 domain.append(('sticky', '=', True))
 
-            if for_next_freeze:
-                domain.append(('for_next_freeze', '=', True))
-
             if search:
                 search_domains = []
                 pr_numbers = []
@@ -811,3 +808,28 @@ def commit_links_diffs(self, commit_link_ids=None, versions_filter_ids=None, rep
             'commit_links': selected_commit_links,
             'diff_by_commit_link_ids': diff_by_commit_link_ids,
         })
+
+    @route([
+        '/runbot/bundle/tag/<model("runbot.bundle.tag"):bundle_tag_id>',
+        '/runbot/<model("runbot.project"):project>/bundle/tag/<model("runbot.bundle.tag"):bundle_tag_id>',
+        ], type="http", auth="user", website=True, sitemap=False)
+    def bundles_by_tag(self, bundle_tag_id=None, project=None, **kwargs):
+        projects = self.env['runbot.project'].search([('hidden', '=', False)])
+        if not project and projects:
+            project = projects[0]
+        bundles_by_team = defaultdict(list)
+        nb_bundles = 0
+        nb_bundles_done = 0
+        for bundle in self.env['runbot.bundle'].search([('tag_ids', 'in', bundle_tag_id.id)]):
+            bundles_by_team[bundle.team_id.name or 'No Team Defined'].append(bundle)
+            nb_bundles += 1
+            if any(bundle.branch_ids.filtered(lambda rec: rec.is_pr)) and not any(bundle.branch_ids.filtered(lambda rec: rec.is_pr).mapped('alive')):
+                nb_bundles_done += 1
+
+        qctx = {
+            'tag': bundle_tag_id,
+            'bundles_by_team': bundles_by_team,
+            'nb_bundles': nb_bundles,
+            'nb_bundles_done': nb_bundles_done,
+        }
+        return request.render('runbot.bundles_by_tag', qctx)

runbot/models/branch.py

@@ -283,9 +283,6 @@ def _recompute_infos(self, payload=None):
 
         if was_alive and not self.alive:
             self.close_date = self.env.cr.now()
-            if self.bundle_id.for_next_freeze:
-                if not any(branch.alive and branch.is_pr for branch in self.bundle_id.branch_ids):
-                    self.bundle_id.for_next_freeze = False
 
         if (not self.draft and was_draft) or (self.alive and not was_alive) or (self.target_branch_name != init_target_branch_name and self.alive):
             self.bundle_id._force()

runbot/models/bundle.py

@@ -1,10 +1,12 @@
 import time
 import logging
 import datetime
+import re
 import subprocess
 
 from collections import defaultdict
 from odoo import models, fields, api, tools
+from odoo.exceptions import ValidationError
 from ..common import dt2time, s2human_long
 
 
@@ -58,7 +60,9 @@ class Bundle(models.Model):
     frontend_url = fields.Char("Frontend URL", compute="_compute_frontend_url")
 
     # extra_info
-    for_next_freeze = fields.Boolean('Should be in next freeze')
+    description = fields.Char('Description', compute='_compute_description', store=True, readonly=False)
+    tag_ids = fields.Many2many('runbot.bundle.tag', string='Tags')
+    team_id = fields.Many2one('runbot.team', compute='_compute_team_id', store=True, readonly=False)
 
     def _compute_frontend_url(self):
         for bundle in self:
@@ -212,6 +216,23 @@ def _compute_all_trigger_custom_ids(self):
                 parent_bundle = self.env['runbot.bundle'].search([('name', '=', targets.pop())])
                 bundle.all_trigger_custom_ids = parent_bundle.all_trigger_custom_ids
 
+    @api.depends('name')
+    def _compute_team_id(self):
+        ngram_re = re.compile(r'.+\((?P<ngram>[a-z]{2,4})\)$')
+        team_by_ngram_project = dict()
+        for team in self.env['runbot.team'].search([('module_ownership_ids', '!=', False)]):
+            for user in team.user_ids:
+                if m := ngram_re.match(user.name.lower()):
+                    team_by_ngram_project[m.group('ngram'), team.project_id] = team
+        for bundle in self.filtered_domain([('is_base', '=', False)]):
+            bundle_ngram = bundle.name.split('-')[-1].lower()
+            bundle.team_id = team_by_ngram_project.get((bundle_ngram, bundle.project_id))
+
+    @api.depends('branch_ids')
+    def _compute_description(self):
+        for bundle in self:
+            bundle.description = ' / '.join(set(bundle.branch_ids.filtered(lambda rec: rec.is_pr and rec.pr_title).mapped('pr_title')))
+
     def _url(self):
         self.ensure_one()
         return "/runbot/bundle/%s" % self.id
@@ -310,3 +331,12 @@ def action_generate_custom_trigger_restore_action(self):
             'default_number_build': 0,
         }
         return self._generate_custom_trigger_action(context)
+
+
+class BundleTag(models.Model):
+
+    _name = "runbot.bundle.tag"
+    _description = "Bundle tag"
+
+    name = fields.Char(string='Bundle Tag')
+    bundle_ids = fields.Many2many('runbot.bundle', string='Bundles')

runbot/models/team.py

@@ -22,6 +22,7 @@ class RunbotTeam(models.Model):
     _inherit = 'mail.thread'
 
     name = fields.Char('Team', required=True)
+    active = fields.Boolean('Active', default=True)
     project_id = fields.Many2one('runbot.project', 'Project', help='Project to monitor', required=True,
                                  default=lambda self: self.env.ref('runbot.main_project'))
     organisation = fields.Char('organisation', related="project_id.organisation")

runbot/security/ir.model.access.csv

@@ -167,3 +167,5 @@ access_runbot_build_error_merge_filters_admin,access_runbot_build_error_merge_fi
 access_runbot_build_error_merge_user,access_runbot_build_error_merge,runbot.model_runbot_build_error_merge,runbot.group_user,1,0,0,0
 access_runbot_build_error_merge_filters_user,access_runbot_build_error_merge_filters,runbot.model_runbot_build_error_merge_filters,runbot.group_user,1,0,0,0
 
+access_runbot_bundle_tag_admin,access_runbot_bundle_tag_admin,runbot.model_runbot_bundle_tag,runbot.group_runbot_admin,1,1,1,1
+access_runbot_bundle_tag_user,access_runbot_bundle_tag_user,runbot.model_runbot_bundle_tag,group_user,1,0,0,0

runbot/templates/bundles_by_tag.xml

@@ -0,0 +1,51 @@
+<?xml version="1.0" encoding="utf-8"?>
+<odoo>
+    <data>
+        <template id="runbot.bundle_tag_slot">
+            <t t-set="link_class" t-value="'link-primary'"/>
+            <t t-set="link_title" t-value="bundle.name"/>
+            <t t-if="not any(bundle.branch_ids.filtered(lambda rec: rec.is_pr))">
+                <t t-set="link_class" t-value="'link-danger'"/>
+                <t t-set="link_title" t-value="'No PR yet'"/>
+            </t>
+            <t t-elif="not any(bundle.branch_ids.filtered(lambda rec: rec.is_pr).mapped('alive'))">
+                <t t-set="link_class" t-value="'link-success text-decoration-line-through'"/>
+                <t t-set="link_title" t-value="'All PR are closed'"/>
+                <t t-set="done" t-value="True"/>
+            </t>
+            <t t-call="runbot.branch_github_menu">
+                <t t-set="btn_classes" t-value="'btn btn-ssm'"/>
+            </t>
+            <a t-out="bundle.description or bundle.name" t-attf-href="/runbot/bundle/{{bundle.id}}" t-att-class="link_class" t-att-title="link_title" target="_blank"/>
+            <t t-set="other_tags" t-value="bundle.tag_ids.filtered(lambda rec: rec != tag)"/>
+            <t t-foreach="other_tags" t-as="other_tag">
+                <span class="badge rounded-pill text-bg-success"><t t-out="other_tag.name"/></span>
+            </t>
+            <t t-if="not done">
+                <span t-attf-class="badge bg-info" data-toggle="tooltip" title="Last batch age">
+                    <t t-out="bundle.last_batch._get_formated_age()"/>
+                </span>
+            </t>
+        </template>
+        <template id="runbot.bundles_by_tag">
+            <t t-call='runbot.layout'>
+            <div class="container-fluid">
+                <h1 class="text-capitalize">
+                    <t t-out="tag.name"/>
+                    <button type="button" class="btn btn-primary btn-ssm disabled"><t t-out="nb_bundles_done"/> / <t t-out="nb_bundles"/></button>
+                </h1>
+                <t t-foreach="sorted(bundles_by_team.keys())" t-as="team">
+                    <t t-set="team_bundles" t-value="bundles_by_team.get(team)"/>
+                    <details t-att-open="bool(team_bundles) and ''"><summary t-out="team"/>
+                        <ul>
+                            <t t-foreach="team_bundles" t-as="bundle">
+                                <li><t t-call="runbot.bundle_tag_slot"/></li>
+                            </t>
+                        </ul>
+                    </details>
+                </t>
+            </div>
+            </t>
+        </template>
+    </data>
+</odoo>

runbot/templates/utils.xml

@@ -413,7 +413,7 @@
         </template>
 
         <template id="runbot.branch_github_menu">
-          <button t-attf-class="btn btn-default btn-ssm dropdown-toggle" data-bs-toggle="dropdown" title="Github links" aria-label="Github links" aria-expanded="false">
+          <button t-attf-class="{{btn_classes or 'btn btn-default btn-ssm'}} dropdown-toggle" data-bs-toggle="dropdown" title="Github links" aria-label="Github links" aria-expanded="false">
             <i t-attf-class="fa fa-github {{'text-primary' if any(branch_id.is_pr and branch_id.alive for branch_id in bundle.branch_ids) else 'text-secondary' if all(not branch_id.alive for branch_id in bundle.branch_ids) else ''}}"/>
             <span class="caret"/>
           </button>

runbot/tests/test_branch.py

@@ -1,5 +1,8 @@
-# -*- coding: utf-8 -*-
+from unittest.mock import patch, mock_open
+
+from odoo.tests.common import new_test_user
 from odoo.tools import mute_logger
+
 from .common import RunbotCase, RunbotCaseMinimalSetup
 
 
@@ -300,3 +303,43 @@ def test_is_base_regex_on_dev_remote(self):
             'head': mistaken_commit.id
         })
         self.assertEqual(branch_mistake_dev.bundle_id, dummy_bundle, "A branch matching the is_base_regex should on a secondary repo should goes in dummy bundle")
+
+
+class TestBundleTeam(RunbotCase):
+
+    def test_bundle_team_attribution(self):
+        self.stop_patcher('isfile')
+        self.stop_patcher('isdir')  #  needed to create the user avatar
+        create_context = {'no_reset_password': True, 'mail_create_nolog': True, 'mail_create_nosubscribe': True, 'mail_notrack': True}
+        test_user = new_test_user(self.env, login='testrunbot', name='testrunbot (tru)', context=create_context)
+
+        team = self.env['runbot.team'].create({
+            'name': 'Test Team',
+            'project_id': self.project.id,
+        })
+
+        team.user_ids += test_user
+
+        branch = self.Branch.create({
+            'remote_id': self.remote_server_dev.id,
+            'name': 'saas-19.1-test-tru',
+            'is_pr': False,
+        })
+
+        module = self.env['runbot.module'].create({'name': 'test_module'})
+        self.env['runbot.module.ownership'].create({
+            'module_id': module.id,
+            'team_id': team.id,
+        })
+
+        bundle = self.env['runbot.bundle'].search([('name', '=', branch.name)])
+        self.assertEqual(bundle.team_id, team)
+
+        # now test that a team can be manually set on a bundle
+        other_team = self.env['runbot.team'].create({
+            'name': 'Another Test Team',
+            'project_id': self.project.id,
+        })
+
+        bundle.team_id = other_team
+        self.assertEqual(bundle.team_id, other_team)

runbot/views/bundle_views.xml

@@ -45,10 +45,15 @@
                     <button name="action_generate_custom_trigger_restore_action" string="New custom restore" type="object" class="oe_highlight"/>
                 </header>
                 <sheet>
+                    <group>
+                        <field name="name" widget="char_frontend_url"/>
+                        <field name="description"/>
+                        <field name="tag_ids" widget="many2many_tags" options="{'not_delete': True, 'no_create': True}"/>
+                    </group>
                     <group>
                         <group string="Base options">
-                            <field name="name" widget="char_frontend_url"/>
                             <field name="project_id"/>
+                            <field name="team_id"/>
                             <field name="sticky" readonly="0"/>
                             <field name="to_upgrade" readonly="0"/>
                             <field name="to_upgrade_from" readonly="0"/>
@@ -57,7 +62,6 @@
                             <field name="base_id"/>
                             <field name="defined_base_id" readonly="is_base"/>
                             <field name="version_id"/>
-                            <field name="for_next_freeze"/>
                             <field name="has_pr"/>
                         </group>
                         <group string="Testing options">
@@ -155,6 +159,7 @@
                 <field name="no_build"/>
                 <field name="branch_ids"/>
                 <field name="version_id"/>
+                <field name="team_id" optional="hide"/>
             </list>
         </field>
     </record>
@@ -167,7 +172,6 @@
             <field name="name"/>
             <field name="version_id"/>
             <separator/>
-            <filter string="For next freeze" name="for_next_freeze" domain="[('for_next_freeze', '=', True)]"/>
             <filter string="Has open pr" name="has_pr" domain="[('has_pr', '=', True)]"/>
             <filter string="No pr" name="no_pr" domain="[('branch_ids', '!=', []), '!', ('branch_ids', 'any', [('is_pr', '=', True)])]"/>
             <filter string="Is base" name="is_base" domain="[('is_base', '=', True)]"/>
@@ -227,6 +231,30 @@
             </list>
         </field>
     </record>
+
+    <record id="view_runbot_bundle_tag_tree" model="ir.ui.view">
+        <field name="model">runbot.bundle.tag</field>
+        <field name="arch" type="xml">
+            <list string="Bundle Tag">
+                <field name="name"/>
+            </list>
+        </field>
+    </record>
+
+   <record id="view_runbot_bundle_tag" model="ir.ui.view">
+        <field name="model">runbot.bundle.tag</field>
+        <field name="arch" type="xml">
+            <form string="Bundle Tags">
+                <group>
+                    <field name="name"/>
+                </group>
+                <list create="0" delete="0" edit="0">
+                    <field name="bundle_ids"/>
+                </list>
+            </form>
+        </field>
+    </record>
+
     <record id="action_bundle_custom_trigger" model="ir.actions.act_window">
         <field name="name">Custom triggers</field>
         <field name="type">ir.actions.act_window</field>
@@ -257,5 +285,11 @@
         <field name="res_model">runbot.batch</field>
         <field name="view_mode">list,form</field>
     </record>
+    <record id="action_bundle_tag" model="ir.actions.act_window">
+        <field name="name">Bundle Tags</field>
+        <field name="type">ir.actions.act_window</field>
+        <field name="res_model">runbot.bundle.tag</field>
+        <field name="view_mode">list,form</field>
+    </record>
   </data>
 </odoo>