Allow user to specify which tags to include in the comparision page

Kami · Kami · commit f33429c8dfdd · 2020-03-10T20:46:22.000+01:00
executables list.

This comes handy in scenarios where there are a lot of tags, but you
only want to list / include some of them.

NOTE: For backward compatibility reasons, default value is None which
means include all the tags.
diff --git a/codespeed/settings.py b/codespeed/settings.py
@@ -78,6 +78,10 @@
                          #     ('myexe', '21df2423ra'),
                          #     ('myexe', 'L'),]
 
+COMPARISON_TAGS = None  # List of tag names which should be included on the comparision page.
+                        # If this value is set to None, all the available tags will be included.
+                        # Empty list means no tags will be included.
+
 TIMELINE_EXECUTABLE_NAME_MAX_LEN = 22  # Maximum length of the executable name used in the
                                        # Changes and Timeline view. If the name is longer, the name
                                        # will be truncated and "..." will be added at the end.
diff --git a/codespeed/tests/test_views_data.py b/codespeed/tests/test_views_data.py
@@ -173,6 +173,70 @@ def test_get_comparisionexes_branch_filtering(self):
         for index, exe_key in enumerate(expected_exe_keys):
             self.assertEqual(executables[self.project][index]['key'], exe_key)
 
+    def test_get_comparisionexes_tag_name_filtering(self):
+        # Insert some mock revisions with tags
+        rev_v4 = Revision.objects.create(
+            branch=self.branch_master, commitid='4', tag='v4.0.0')
+        rev_v5 = Revision.objects.create(
+            branch=self.branch_master, commitid='5', tag='v5.0.0')
+        rev_v6 = Revision.objects.create(
+            branch=self.branch_master, commitid='6', tag='v6.0.0')
+
+        # No COMPARIION_TAGS filters specified, all the tags should be included
+        executables, exe_keys = getcomparisonexes()
+        self.assertEqual(len(executables), 1)
+        self.assertEqual(len(executables[self.project]), 2 * 2 + 2 * 3)
+        self.assertEqual(len(exe_keys), 2 * 2 + 2 * 3)
+
+        self.assertExecutablesListContainsRevision(executables[self.project], rev_v4)
+        self.assertExecutablesListContainsRevision(executables[self.project], rev_v5)
+        self.assertExecutablesListContainsRevision(executables[self.project], rev_v6)
+
+        # Only a single tag should be included
+        with override_settings(COMPARISON_TAGS=['v4.0.0']):
+            executables, exe_keys = getcomparisonexes()
+            self.assertEqual(len(executables), 1)
+            self.assertEqual(len(executables[self.project]), 2 * 2 + 2 * 1)
+            self.assertEqual(len(exe_keys), 2 * 2 + 2 * 1)
+
+            self.assertExecutablesListContainsRevision(executables[self.project], rev_v4)
+            self.assertExecutablesListDoesntContainRevision(executables[self.project], rev_v5)
+            self.assertExecutablesListDoesntContainRevision(executables[self.project], rev_v6)
+
+        # No tags should be included
+        with override_settings(COMPARISON_TAGS=[]):
+            executables, exe_keys = getcomparisonexes()
+            self.assertEqual(len(executables), 1)
+            self.assertEqual(len(executables[self.project]), 2 * 2)
+            self.assertEqual(len(exe_keys), 2 * 2)
+
+            self.assertExecutablesListDoesntContainRevision(executables[self.project], rev_v4)
+            self.assertExecutablesListDoesntContainRevision(executables[self.project], rev_v5)
+            self.assertExecutablesListDoesntContainRevision(executables[self.project], rev_v6)
+
+    def assertExecutablesListContainsRevision(self, executables, revision):
+        found = self._executable_list_contains_revision(executables=executables,
+                                                        revision=revision)
+
+        if not found:
+            self.assertFalse("Didn't find revision \"%s\" in executable list \"%s\"" %
+                            (str(revision), str(executables)))
+
+    def assertExecutablesListDoesntContainRevision(self, executables, revision):
+        found = self._executable_list_contains_revision(executables=executables,
+                                                        revision=revision)
+
+        if found:
+            self.assertFalse("Found revision \"%s\", but didn't expect it" %
+                            (str(revision)))
+
+    def _executable_list_contains_revision(self, executables, revision):
+        for executable in executables:
+            if executable['revision'] == revision:
+                return True
+
+        return False
+
 
 class UtilityFunctionsTestCase(TestCase):
     @override_settings(TIMELINE_EXECUTABLE_NAME_MAX_LEN=22)
diff --git a/codespeed/views_data.py b/codespeed/views_data.py
@@ -49,15 +49,27 @@ def get_default_environment(enviros, data, multi=False):
         return defaultenviros[0]
 
 
-def getbaselineexecutables():
+def getbaselineexecutables(include_tags=None):
+    """
+    :param include_tags: A list of tags to include in the result. If not specified, it will
+                        include all the available tags.
+    :type include_tags: ``list``
+    """
     baseline = [{
         'key': "none",
         'name': "None",
         'executable': "none",
         'revision': "none",
     }]
     executables = Executable.objects.select_related('project')
-    revs = Revision.objects.exclude(tag="").select_related('branch__project')
+
+    if include_tags is not None:
+        revs = Revision.objects.filter(tag__in=include_tags)
+    else:
+        revs = Revision.objects.exclude(tag="")
+
+    revs = revs.select_related('branch__project')
+
     for rev in revs:
         # Add executables that correspond to each tagged revision.
         for exe in [e for e in executables if e.project == rev.branch.project]:
@@ -107,9 +119,12 @@ def getdefaultexecutable():
 
 
 def getcomparisonexes():
+    comparison_tags = getattr(settings, 'COMPARISON_TAGS', None)
+
     all_executables = {}
     exekeys = []
-    baselines = getbaselineexecutables()
+    baselines = getbaselineexecutables(include_tags=comparison_tags)
+
     for proj in Project.objects.all():
         executables = []
         executablekeys = []
