Add support for a pipeline piping's title attribute

Author: jbernal0019

store_backend/pipelines/migrations/0006_pluginpiping_title.py

@@ -0,0 +1,18 @@
+# Generated by Django 4.0 on 2022-10-02 16:47
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('pipelines', '0005_alter_defaultpipingboolparameter_id_and_more'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='pluginpiping',
+            name='title',
+            field=models.CharField(blank=True, max_length=100),
+        ),
+    ]

store_backend/pipelines/models.py

@@ -72,6 +72,7 @@ class Meta:
 
 
 class PluginPiping(models.Model):
+    title = models.CharField(max_length=100, blank=True)
     plugin = models.ForeignKey(Plugin, on_delete=models.CASCADE)
     pipeline = models.ForeignKey(Pipeline, on_delete=models.CASCADE,
                                  related_name='plugin_pipings')

store_backend/pipelines/serializers.py

@@ -15,6 +15,25 @@
 from .models import DefaultPipingBoolParameter, DefaultPipingStrParameter
 
 
+class PluginPipingSerializer(serializers.HyperlinkedModelSerializer):
+    previous_id = serializers.ReadOnlyField(source='previous.id')
+    plugin_id = serializers.ReadOnlyField(source='plugin.id')
+    plugin_name = serializers.ReadOnlyField(source='plugin.meta.name')
+    plugin_version = serializers.ReadOnlyField(source='plugin.version')
+    pipeline_id = serializers.ReadOnlyField(source='pipeline.id')
+    previous = serializers.HyperlinkedRelatedField(view_name='pluginpiping-detail',
+                                                 read_only=True)
+    plugin = serializers.HyperlinkedRelatedField(view_name='plugin-detail',
+                                                 read_only=True)
+    pipeline = serializers.HyperlinkedRelatedField(view_name='pipeline-detail',
+                                                   read_only=True)
+
+    class Meta:
+        model = PluginPiping
+        fields = ('url', 'id', 'previous_id', 'title', 'plugin_id', 'plugin_name',
+                  'plugin_version', 'pipeline_id', 'previous', 'plugin', 'pipeline')
+
+
 class PipelineSerializer(serializers.HyperlinkedModelSerializer):
     plugin_tree = serializers.JSONField(write_only=True, required=False)
     owner_username = serializers.ReadOnlyField(source='owner.username')
@@ -123,6 +142,16 @@ def validate_plugin_tree(self, plugin_tree):
                 msg = [f"Plugin {plg} is of type 'fs' and therefore can not be used to "
                        f"create a pipeline."]
                 raise serializers.ValidationError(msg)
+            title = d.get('title')
+            if title is None:
+                d['title'] = plg.meta.name
+            else:
+                piping_serializer = PluginPipingSerializer(data={'title': title})
+                try:
+                    piping_serializer.is_valid(raise_exception=True)
+                except serializers.ValidationError as e:
+                    raise serializers.ValidationError([f'Invalid title: {title}, '
+                                                       f'detail: {str(e)}'])
             if 'plugin_parameter_defaults' in d:
                 param_defaults = d['plugin_parameter_defaults']
                 PipelineSerializer.validate_plugin_parameter_defaults(plg, param_defaults)
@@ -192,16 +221,20 @@ def get_tree(tree_list):
             raise ValueError(f'Could not find the root of the tree in {tree_list}.')
         tree = [None] * len(tree_list)
         plugin_id = tree_list[root_ix]['plugin_id']
+        title = tree_list[root_ix]['title']
         defaults = tree_list[root_ix]['plugin_parameter_defaults']
         tree[root_ix] = {'plugin_id': plugin_id,
+                         'title': title,
                          'plugin_parameter_defaults': defaults,
                          'child_indices': []}
         for ix, d in enumerate(tree_list):
             if ix != root_ix:
                 if not tree[ix]:
                     plugin_id = d['plugin_id']
+                    title = d['title']
                     defaults = d['plugin_parameter_defaults']
                     tree[ix] = {'plugin_id': plugin_id,
+                                'title': title,
                                 'plugin_parameter_defaults': defaults,
                                 'child_indices': []}
                 prev_ix = d['previous_index']
@@ -210,8 +243,10 @@ def get_tree(tree_list):
                         tree[prev_ix]['child_indices'].append(ix)
                     else:
                         plugin_id = tree_list[prev_ix]['plugin_id']
+                        title = tree_list[prev_ix]['title']
                         defaults = tree_list[prev_ix]['plugin_parameter_defaults']
                         tree[prev_ix] = {'plugin_id': plugin_id,
+                                         'title': title,
                                          'plugin_parameter_defaults': defaults,
                                          'child_indices': [ix]}
                 except (IndexError, TypeError):
@@ -247,7 +282,9 @@ def _add_plugin_tree_to_pipeline(pipeline, tree_dict):
         root_ix = tree_dict['root_index']
         tree = tree_dict['tree']
         root_plg = Plugin.objects.get(pk=tree[root_ix]['plugin_id'])
-        root_plg_piping = PluginPiping.objects.create(pipeline=pipeline, plugin=root_plg)
+        title = tree[root_ix]['title']
+        root_plg_piping = PluginPiping.objects.create(title=title, pipeline=pipeline,
+                                                      plugin=root_plg)
         defaults = tree[root_ix]['plugin_parameter_defaults']
         root_plg_piping.save(parameter_defaults=defaults)
         # breath-first traversal
@@ -258,33 +295,15 @@ def _add_plugin_tree_to_pipeline(pipeline, tree_dict):
             curr_piping = piping_queue.pop(0)
             for ix in tree[curr_ix]['child_indices']:
                 plg = Plugin.objects.get(pk=tree[ix]['plugin_id'])
-                plg_piping = PluginPiping.objects.create(pipeline=pipeline, plugin=plg,
-                                                         previous=curr_piping)
+                title = tree[ix]['title']
+                plg_piping = PluginPiping.objects.create(title=title, pipeline=pipeline,
+                                                         plugin=plg, previous=curr_piping)
                 defaults = tree[ix]['plugin_parameter_defaults']
                 plg_piping.save(parameter_defaults=defaults)
                 ix_queue.append(ix)
                 piping_queue.append(plg_piping)
 
 
-class PluginPipingSerializer(serializers.HyperlinkedModelSerializer):
-    plugin_id = serializers.ReadOnlyField(source='plugin.id')
-    plugin_name = serializers.ReadOnlyField(source='plugin.meta.name')
-    plugin_version = serializers.ReadOnlyField(source='plugin.version')
-    pipeline_id = serializers.ReadOnlyField(source='pipeline.id')
-    previous_id = serializers.ReadOnlyField(source='previous.id')
-    previous = serializers.HyperlinkedRelatedField(view_name='pluginpiping-detail',
-                                                 read_only=True)
-    plugin = serializers.HyperlinkedRelatedField(view_name='plugin-detail',
-                                                 read_only=True)
-    pipeline = serializers.HyperlinkedRelatedField(view_name='pipeline-detail',
-                                                   read_only=True)
-
-    class Meta:
-        model = PluginPiping
-        fields = ('url', 'id', 'plugin_id', 'plugin_name', 'plugin_version',
-                  'pipeline_id', 'previous_id', 'previous', 'plugin', 'pipeline')
-
-
 class DefaultPipingStrParameterSerializer(serializers.HyperlinkedModelSerializer):
     previous_plugin_piping_id = serializers.ReadOnlyField(
         source='plugin_piping.previous_id')

store_backend/pipelines/tests/test_serializers.py

@@ -203,6 +203,7 @@ def test_validate_plugin_tree_raises_validation_error_if_get_tree_raises_value_e
             with self.assertRaises(serializers.ValidationError):
                 pipeline_serializer.validate_plugin_tree(tree)
             get_tree_mock.assert_called_with([{"plugin_id": plugin_ds.id,
+                                               "title": plugin_ds.meta.name,
                                                "plugin_parameter_defaults": [],
                                                "previous_index": None}])
 
@@ -222,6 +223,23 @@ def test_validate_plugin_tree_raises_validation_error_if_validate_tree_raises_va
                 pipeline_serializer.validate_plugin_tree(tree)
                 validate_tree_mock.assert_called_with(tree_dict)
 
+    def test_validate_plugin_tree_raises_validation_error_if_title_too_long(self):
+        """
+        Test whether overriden validate_plugin_tree method raises ValidationError if
+        internal call to validate_tree method raises ValueError exception.
+        """
+        pipeline = Pipeline.objects.get(name=self.pipeline_name)
+        pipeline_serializer = PipelineSerializer(pipeline)
+        plugin_ds = Plugin.objects.get(meta__name=self.plugin_ds_name)
+        title = 200 * 's'
+        tree = '[{"plugin_id": ' + str(plugin_ds.id) + ', "title": ' + title + ', previous_index": null}]'
+        tree_dict = {'root_index': 0, 'tree': [{"plugin_id": plugin_ds.id, "title": title, "child_indices": []}]}
+        with mock.patch('pipelines.serializers.PipelineSerializer.validate_tree') as validate_tree_mock:
+            validate_tree_mock.return_value = None
+            with self.assertRaises(serializers.ValidationError):
+                pipeline_serializer.validate_plugin_tree(tree)
+                validate_tree_mock.assert_called_with(tree_dict)
+
     def test_validate_plugin_parameter_defaults_raises_validation_error_if_missing_name_or_default(self):
         """
         Test whether custom validate_plugin_parameter_defaults method raises ValidationError if
@@ -269,22 +287,28 @@ def test_get_tree(self):
         (plugin_ds2, tf) = Plugin.objects.get_or_create(meta=meta)
 
         tree_list = [{"plugin_id": plugin_ds1.id,
+                      "title": plugin_ds1.meta.name,
                       "plugin_parameter_defaults": [],
                       "previous_index": None},
                 {"plugin_id": plugin_ds2.id,
+                 "title": plugin_ds2.meta.name,
                  "plugin_parameter_defaults": [],
                  "previous_index": 0},
                 {"plugin_id": plugin_ds1.id,
+                 "title": "piping1",
                  "plugin_parameter_defaults": [],
                  "previous_index": 1}]
 
         tree = [{"plugin_id": plugin_ds1.id,
+                 "title": plugin_ds1.meta.name,
                  "plugin_parameter_defaults": [],
                  "child_indices": [1]},
                 {"plugin_id": plugin_ds2.id,
+                 "title": plugin_ds2.meta.name,
                  "plugin_parameter_defaults": [],
                  "child_indices": [2]},
                 {"plugin_id": plugin_ds1.id,
+                 "title": "piping1",
                  "plugin_parameter_defaults": [],
                  "child_indices": []}]
         expected_tree_dict = {'root_index': 0, 'tree': tree}
@@ -320,24 +344,30 @@ def test_get_tree_raises_value_error_if_it_finds_invalid_previous_index(self):
         (plugin_ds2, tf) = Plugin.objects.get_or_create(meta=meta)
 
         tree_list = [{"plugin_id": plugin_ds1.id,
+                      "title": plugin_ds1.meta.name,
                       "plugin_parameter_defaults": [],
                       "previous_index": None},
                 {"plugin_id": plugin_ds2.id,
+                 "title": plugin_ds2.meta.name,
                  "plugin_parameter_defaults": [],
                  "previous_index": 0},
                 {"plugin_id": plugin_ds1.id,
+                 "title": "piping1",
                  "plugin_parameter_defaults": [],
                  "previous_index": None}]
         with self.assertRaises(ValueError):
             pipeline_serializer.get_tree(tree_list)
 
         tree_list = [{"plugin_id": plugin_ds1.id,
+                      "title": plugin_ds1.meta.name,
                       "plugin_parameter_defaults": [],
                       "previous_index": None},
                 {"plugin_id": plugin_ds2.id,
+                 "title": plugin_ds2.meta.name,
                  "plugin_parameter_defaults": [],
                  "previous_index": 3},
                 {"plugin_id": plugin_ds1.id,
+                 "title": "piping1",
                  "plugin_parameter_defaults": [],
                  "previous_index": 1}]
         with self.assertRaises(ValueError):
@@ -372,12 +402,15 @@ def test__add_plugin_tree_to_pipeline(self):
         (plugin_ds2, tf) = Plugin.objects.get_or_create(meta=meta)
 
         tree = [{"plugin_id": plugin_ds1.id,
+                 "title": plugin_ds1.meta.name,
                  "plugin_parameter_defaults": [],
                  "child_indices": [1]},
                 {"plugin_id": plugin_ds2.id,
+                 "title": "piping2",
                  "plugin_parameter_defaults": [],
                  "child_indices": [2]},
                 {"plugin_id": plugin_ds1.id,
+                 "title": "piping1",
                  "plugin_parameter_defaults": [],
                  "child_indices": []}]
         tree_dict = {'root_index': 0, 'tree': tree}