Merge pull request tobami#283 from Kami/configurable_comparison_display_branch

Allow admin to configure which branches are displayed on the Comparison page

Author: tobami

codespeed/admin.py

@@ -37,7 +37,7 @@ class ProjectAdmin(admin.ModelAdmin):
 
 @admin.register(Branch)
 class BranchAdmin(admin.ModelAdmin):
-    list_display = ('name', 'project')
+    list_display = ('name', 'project', 'display_on_comparison_page')
     list_filter = ('project',)
 
 

codespeed/migrations/0004_branch_display_on_comparison_page.py

@@ -0,0 +1,18 @@
+# Generated by Django 2.1.15 on 2020-02-24 11:26
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('codespeed', '0003_project_default_branch'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='branch',
+            name='display_on_comparison_page',
+            field=models.BooleanField(default=True, verbose_name='True to display this branch on the comparison page'),
+        ),
+    ]

codespeed/models.py

@@ -107,6 +107,9 @@ class Branch(models.Model):
     name = models.CharField(max_length=32)
     project = models.ForeignKey(
         Project, on_delete=models.CASCADE, related_name="branches")
+    display_on_comparison_page = models.BooleanField(
+        "True to display this branch on the comparison page",
+        default=True)
 
     def __str__(self):
         return self.project.name + ":" + self.name

codespeed/tests/test_views_data.py

@@ -141,6 +141,38 @@ def test_get_comparisionexes_custom_default_branch(self):
         self.assertEqual(exe_keys[2], '1+L+custom')
         self.assertEqual(exe_keys[3], '2+L+custom')
 
+    def test_get_comparisionexes_branch_filtering(self):
+        # branch1 and branch3 have display_on_comparison_page flag set to False
+        # so they shouldn't be included in the result
+        branch1 = Branch.objects.create(name='branch1', project=self.project,
+                                        display_on_comparison_page=False)
+        branch2 = Branch.objects.create(name='branch2', project=self.project,
+                                        display_on_comparison_page=True)
+        branch3 = Branch.objects.create(name='branch3', project=self.project,
+                                        display_on_comparison_page=False)
+
+        Revision.objects.create(branch=branch1, commitid='1')
+        Revision.objects.create(branch=branch2, commitid='1')
+        Revision.objects.create(branch=branch3, commitid='1')
+
+        executables, exe_keys = getcomparisonexes()
+        self.assertEqual(len(executables), 1)
+        self.assertEqual(len(executables[self.project]), 6)
+        self.assertEqual(len(exe_keys), 6)
+
+        expected_exe_keys = [
+            '1+L+master',
+            '2+L+master',
+            '1+L+custom',
+            '2+L+custom',
+            '1+L+branch2',
+            '2+L+branch2'
+        ]
+        self.assertEqual(exe_keys, expected_exe_keys)
+
+        for index, exe_key in enumerate(expected_exe_keys):
+            self.assertEqual(executables[self.project][index]['key'], exe_key)
+
 
 class UtilityFunctionsTestCase(TestCase):
     @override_settings(TIMELINE_EXECUTABLE_NAME_MAX_LEN=22)

codespeed/views_data.py

@@ -120,7 +120,7 @@ def getcomparisonexes():
                 executables.append(exe)
 
         # add latest revs of the project
-        branches = Branch.objects.filter(project=proj)
+        branches = Branch.objects.filter(project=proj, display_on_comparison_page=True)
         for branch in branches:
             try:
                 rev = Revision.objects.filter(branch=branch).latest('date')