workflow: added new workflow for manual maerger

Signed-off-by: Antonio Cesarano <[email protected]>

* define a new workflow for the manual merge use case
* add new task functions specific for such use case
* integration tests

inspirehep/modules/workflows/actions/merge_approval.py

@@ -32,4 +32,16 @@ class MergeApproval(object):
     @staticmethod
     def resolve(obj, *args, **kwargs):
         """Resolve the action taken in the approval action."""
-        pass
+
+        obj.extra_data["approved"] = True
+        obj.extra_data["auto-approved"] = False
+        obj.remove_action()
+        obj.save()
+
+        delayed = True
+        if obj.workflow.name == 'manual_merge':
+            # the manual merge wf should be sync
+            delayed = False
+
+        obj.continue_workflow(delayed=delayed)
+        return True

inspirehep/modules/workflows/tasks/manual_merging.py

@@ -0,0 +1,133 @@
+# -*- coding: utf-8 -*-
+#
+# This file is part of INSPIRE.
+# Copyright (C) 2014-2017 CERN.
+#
+# INSPIRE is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# INSPIRE is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with INSPIRE. If not, see <http://www.gnu.org/licenses/>.
+#
+# In applying this license, CERN does not waive the privileges and immunities
+# granted to it by virtue of its status as an Intergovernmental Organization
+# or submit itself to any jurisdiction.
+
+"""Tasks related to manual merge generic record."""
+
+from __future__ import absolute_import, division, print_function
+
+import json
+
+from invenio_db import db
+
+from inspire_json_merger.inspire_json_merger import inspire_json_merge
+from inspire_dojson.utils import get_record_ref
+
+from inspirehep.modules.workflows.tasks.merging import (
+    insert_wf_record_source,
+)
+from inspirehep.modules.workflows.utils import with_debug_logging
+from inspirehep.utils.record_getter import get_db_record
+
+
+def _get_head_and_update(obj):
+    head = obj.extra_data['head']
+    update = obj.extra_data['update']
+    return head, update
+
+
+@with_debug_logging
+def merge_records(obj, eng):
+    """Merge the records whose ids are defined in the `obj` parameter and store
+    the merged record and relative conflicts in `obj.data` and
+    `obj.extra_data['conflicts']`.
+    """
+    head, update = _get_head_and_update(obj)
+
+    merged, conflicts = inspire_json_merge(
+        root={},
+        head=head,
+        update=update,
+        head_source=obj.extra_data['head_source']
+    )
+    obj.data = merged
+    obj.extra_data['conflicts'] = [json.loads(c.to_json()) for c in conflicts]
+
+
+@with_debug_logging
+def halt_for_approval(obj, eng):
+    """Stop the Workflow engine"""
+    eng.halt(
+        action="merge_approval",
+        msg='Manual Merge halted for curator approval.'
+    )
+
+
+@with_debug_logging
+def edit_metadata_and_store(obj, eng):
+    """Replace the `head` record with the previously merged record and updates
+    some reference in order to delete the `update` record, linking it to the
+    new `head`.
+    """
+
+    head = get_db_record('lit', obj.extra_data['head_control_number'])
+    update = get_db_record('lit', obj.extra_data['update_control_number'])
+
+    head.clear()
+    head.update(obj.data)    # head's content will be replaced by merged
+    update.merge(head)       # update's uuid will point to head's uuid
+    update.delete()          # mark update record as deleted
+
+    # add schema contents to refer deleted record to the merged one
+    update['new_record'] = get_record_ref(
+        head['control_number'],
+        endpoint='record'
+    )
+    _add_deleted_records(head, update)
+
+    head.commit()
+    update.commit()
+    db.session.commit()
+
+
+def _add_deleted_records(new_rec, deleted_rec):
+    """Mark `deleted_rec` as replaced by `new_rec` by adding its id to the
+    deleted_record list property.
+    """
+    ref = get_record_ref(deleted_rec['control_number'], 'record')
+    new_rec.setdefault('deleted_records', []).append(ref)
+
+
+def save_records_as_roots(obj, eng):
+    """Save `head` and `update` records in the Root table in the db if they
+    have different `sources, otherwise only `head` is saved.
+    """
+    head, update = _get_head_and_update(obj)
+
+    head_source = obj.extra_data['head_source']
+
+    insert_wf_record_source(
+        json=head,
+        source=head_source,
+        record_uuid=obj.extra_data['head_uuid'],
+    )
+
+    update_source = obj.extra_data['update_source']
+
+    # need to save just one root per source
+    if update_source != head_source:
+        insert_wf_record_source(
+            json=update,
+            source=update_source.lower(),
+            record_uuid=obj.extra_data['update_uuid'],
+        )
+    obj.save()
+    db.session.commit()

inspirehep/modules/workflows/tasks/merging.py

@@ -45,7 +45,7 @@ def insert_wf_record_source(json, record_uuid, source):
     Args:
         json(dict): the content of the root
         record_uuid(uuid): the record's uuid to associate with the root
-        source(string): the source og the root
+        source(string): the source of the root
     """
     record_source = read_wf_record_source(record_uuid=record_uuid, source=source)
     if record_source is None:

inspirehep/modules/workflows/workflows/__init__.py

@@ -26,3 +26,4 @@
 
 from .article import Article  # noqa: F401
 from .author import Author    # noqa: F401
+from .manual_merge import ManualMerge   # noqa: F401

inspirehep/modules/workflows/workflows/manual_merge.py

@@ -0,0 +1,114 @@
+# -*- coding: utf-8 -*-
+#
+# This file is part of INSPIRE.
+# Copyright (C) 2014-2017 CERN.
+#
+# INSPIRE is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# INSPIRE is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with INSPIRE. If not, see <http://www.gnu.org/licenses/>.
+#
+# In applying this license, CERN does not waive the privileges and immunities
+# granted to it by virtue of its status as an Intergovernmental Organization
+# or submit itself to any jurisdiction.
+
+"""Workflow for manual merging generic records."""
+
+from __future__ import absolute_import, division, print_function
+
+from invenio_workflows import start, workflow_object_class
+from inspire_json_merger.inspire_json_merger import (
+    get_head_source as merger_get_source
+)
+
+from inspirehep.modules.workflows.tasks.manual_merging import (
+    halt_for_approval,
+    edit_metadata_and_store, merge_records, save_records_as_roots,
+)
+from inspirehep.modules.workflows.tasks.merging import (
+    get_head_source
+)
+from inspirehep.utils.record import get_source
+from inspirehep.utils.record_getter import get_db_record
+
+
+class ManualMerge(object):
+    name = 'MERGE'
+    data_type = ''
+
+    workflow = ([
+        merge_records,
+        halt_for_approval,
+        # when resume here, we expect the workflow_object contains the
+        # merged record accepted by a curator
+        save_records_as_roots,
+        edit_metadata_and_store,
+    ])
+
+
+def start_merger(
+        head_id,
+        update_id,
+        current_user_id=None,
+):
+    """Start a new ManualMerge workflow to merge two records manually.
+
+    Args:
+        head_id: the id of the first record to merge. This record is the one
+            that will be updated with the new information.
+        update_id: the id of the second record to merge. This record is the
+            one that is going to be deleted and replaced by `head`.
+        current_user_id: Id of the current user provided by the Flask app.
+
+    Returns:
+        (int): the current workflow object's id.
+    """
+    data = {
+        'pid_type': 'lit',  # TODO: support
+        'recid_head': head_id,
+        'recid_update': update_id,
+    }
+
+    head = get_db_record('lit', head_id)
+    update = get_db_record('lit', update_id)
+
+    workflow_object = workflow_object_class.create(
+        data=None,
+        id_user=current_user_id,
+        data_type='hep'
+    )
+
+    wf_id = workflow_object.id    # to retrieve it later
+    workflow_object.extra_data.update(data)
+
+    # preparing identifiers in order to do less requests possible later
+    head_source = get_head_source(head.id) or merger_get_source(head)
+
+    update_source = get_source(update)
+    update_source = update_source if update_source else 'arxiv'
+
+    workflow_object.extra_data['head_source'] = head_source.lower()
+    workflow_object.extra_data['update_source'] = update_source.lower()
+
+    workflow_object.extra_data['head_control_number'] = head_id
+    workflow_object.extra_data['update_control_number'] = update_id
+
+    workflow_object.extra_data['head_uuid'] = str(head.id)
+    workflow_object.extra_data['update_uuid'] = str(update.id)
+
+    workflow_object.extra_data['head'] = head
+    workflow_object.extra_data['update'] = update
+
+    workflow_object.save()
+
+    start('manual_merge', object_id=wf_id)
+
+    return wf_id

setup.py

@@ -245,6 +245,7 @@
         'invenio_workflows.workflows': [
             'article = inspirehep.modules.workflows.workflows:Article',
             'author = inspirehep.modules.workflows.workflows:Author',
+            'manual_merge = inspirehep.modules.workflows.workflows:ManualMerge',
         ],
         'invenio_workflows_ui.actions': [
             'author_approval = inspirehep.modules.workflows.actions.author_approval:AuthorApproval',

tests/integration/workflows/helpers/calls.py

@@ -57,6 +57,16 @@ def do_resolve_workflow(app, workflow_id, action='accept_core'):
     )
 
 
+def do_resolve_manual_merge_wf(app, workflow_id):
+    """Solve the the given workflow's conflicts.
+    """
+    response = do_resolve_workflow(
+        app=app,
+        workflow_id=workflow_id
+    )
+    assert response.status_code == 200
+
+
 def do_accept_core(app, workflow_id):
     """Accepts the given workflow as core.