feat: migrate @move annotation (#1149)

Closes #1143.

### Summary of Changes

- add migration for `@move` annotations to another version, with the
possibilities:
- If the mapped apiv2 element is a class or global function, the
annotation will be migrated as expected.
    - Else, a `@todo` annotation will mark the element.
- new get_migration_text function that creates the text for a todo
annotation or comment

### Testing Instructions

run the migrate command or view and run the `test_migration.py` file

Co-authored-by: Aclrian <[email protected]>

Author: Aclrian

package-parser/package_parser/processing/migration/_migrate.py

@@ -12,6 +12,9 @@
     migrate_todo_annotation,
     migrate_value_annotation,
 )
+from package_parser.processing.migration.annotations._migrate_move_annotation import (
+    migrate_move_annotation,
+)
 from package_parser.processing.migration.model import Mapping
 
 
@@ -45,6 +48,12 @@ def migrate_annotations(
             for annotation in migrate_enum_annotation(enum_annotation, mapping):
                 migrated_annotation_store.add_annotation(annotation)
 
+    for move_annotation in annotationsv1.moveAnnotations:
+        mapping = _get_mapping_from_annotation(move_annotation, mappings)
+        if mapping is not None:
+            for annotation in migrate_move_annotation(move_annotation, mapping):
+                migrated_annotation_store.add_annotation(annotation)
+
     for rename_annotation in annotationsv1.renameAnnotations:
         mapping = _get_mapping_from_annotation(rename_annotation, mappings)
         if mapping is not None:

package-parser/package_parser/processing/migration/annotations/__init__.py

@@ -1,4 +1,5 @@
 from ._constants import migration_author
+from ._get_migration_text import get_migration_text
 from ._migrate_boundary_annotation import migrate_boundary_annotation
 from ._migrate_enum_annotation import migrate_enum_annotation
 from ._migrate_rename_annotation import migrate_rename_annotation

package-parser/package_parser/processing/migration/annotations/_get_migration_text.py

@@ -0,0 +1,101 @@
+from package_parser.processing.annotations.model import (
+    AbstractAnnotation,
+    BoundaryAnnotation,
+    CalledAfterAnnotation,
+    CompleteAnnotation,
+    ConstantAnnotation,
+    DescriptionAnnotation,
+    EnumAnnotation,
+    GroupAnnotation,
+    MoveAnnotation,
+    OptionalAnnotation,
+    PureAnnotation,
+    RemoveAnnotation,
+    RenameAnnotation,
+    TodoAnnotation,
+    ValueAnnotation,
+)
+from package_parser.processing.migration import Mapping
+
+
+def _get_further_information(annotation: AbstractAnnotation) -> str:
+    if isinstance(annotation, (CompleteAnnotation, PureAnnotation, RemoveAnnotation)):
+        return ""
+    if isinstance(annotation, BoundaryAnnotation):
+        return " with the interval '" + str(annotation.interval.to_json()) + "'"
+    if isinstance(annotation, CalledAfterAnnotation):
+        return (
+            " with the method '"
+            + annotation.calledAfterName
+            + "' that should be called before"
+        )
+    if isinstance(annotation, DescriptionAnnotation):
+        return " with the new description '" + annotation.newDescription + "'"
+    if isinstance(annotation, EnumAnnotation):
+        return (
+            " with the new enum '"
+            + annotation.enumName
+            + " ("
+            + ", ".join(
+                map(
+                    lambda enum_pair: enum_pair.stringValue
+                    + ", "
+                    + enum_pair.instanceName,
+                    annotation.pairs,
+                )
+            )
+            + ")'"
+        )
+    if isinstance(annotation, GroupAnnotation):
+        return (
+            " with the group name '"
+            + annotation.groupName
+            + "' and the grouped parameters: '"
+            + ", ".join(annotation.parameters)
+            + "'"
+        )
+    if isinstance(annotation, MoveAnnotation):
+        return " with the destination: '" + annotation.destination + "'"
+    if isinstance(annotation, RenameAnnotation):
+        return " with the new name '" + annotation.newName + "'"
+    if isinstance(annotation, TodoAnnotation):
+        return " with the todo '" + annotation.newTodo + "'"
+    if isinstance(annotation, ValueAnnotation):
+        value = " with the variant '" + annotation.variant.value
+        if isinstance(annotation, (ConstantAnnotation, OptionalAnnotation)):
+            value += (
+                "' and the default Value '"
+                + annotation.defaultValue
+                + " ( type: "
+                + annotation.defaultValueType.value
+                + " )"
+            )
+        value += "'"
+        return value
+    return " with the data '" + str(annotation.to_json()) + "'"
+
+
+def get_migration_text(annotation: AbstractAnnotation, mapping: Mapping) -> str:
+    class_name = str(annotation.__class__.__name__)
+    if class_name.endswith("Annotation"):
+        class_name = class_name[:-10]
+    if issubclass(type(annotation), ValueAnnotation):
+        class_name = "Value"
+
+    migrate_text = (
+        "The @" + class_name + " Annotation" + _get_further_information(annotation)
+    )
+    migrate_text += (
+        " from the previous version was at '"
+        + annotation.target
+        + "' and the possible alternatives in the new version of the api are: "
+        + ", ".join(
+            map(
+                lambda api_element: api_element.id
+                if hasattr(api_element, "id")
+                else api_element.name,
+                mapping.get_apiv2_elements(),
+            )
+        )
+    )
+    return migrate_text

package-parser/package_parser/processing/migration/annotations/_migrate_boundary_annotation.py

@@ -25,6 +25,7 @@
 )
 
 from ._constants import migration_author
+from ._get_migration_text import get_migration_text
 
 
 def migrate_interval_to_fit_parameter_type(
@@ -80,16 +81,7 @@ def migrate_boundary_annotation(
     authors.append(migration_author)
     boundary_annotation.authors = authors
 
-    migrate_text = (
-        "The @Boundary Annotation with the interval '"
-        + str(boundary_annotation.interval.to_json())
-        + "' from the previous version was at '"
-        + boundary_annotation.target
-        + "' and the possible alternatives in the new version of the api are: "
-        + ", ".join(
-            map(lambda api_element: api_element.name, mapping.get_apiv2_elements())
-        )
-    )
+    migrate_text = get_migration_text(boundary_annotation, mapping)
 
     if isinstance(mapping, (OneToOneMapping, ManyToOneMapping)):
         parameter = mapping.get_apiv2_elements()[0]

package-parser/package_parser/processing/migration/annotations/_migrate_enum_annotation.py

@@ -25,6 +25,7 @@
 )
 
 from ._constants import migration_author
+from ._get_migration_text import get_migration_text
 
 
 def _contains_string(type_: AbstractType) -> bool:
@@ -56,23 +57,7 @@ def migrate_enum_annotation(
     authors.append(migration_author)
     enum_annotation.authors = authors
 
-    migrate_text = (
-        "The @Enum Annotation with the new name '"
-        + enum_annotation.enumName
-        + " ("
-        + ", ".join(
-            map(
-                lambda enum_pair: enum_pair.stringValue + ", " + enum_pair.instanceName,
-                enum_annotation.pairs,
-            )
-        )
-        + ")' from the previous version was at '"
-        + enum_annotation.target
-        + "' and the possible alternatives in the new version of the api are: "
-        + ", ".join(
-            map(lambda api_element: api_element.name, mapping.get_apiv2_elements())
-        )
-    )
+    migrate_text = get_migration_text(enum_annotation, mapping)
 
     if isinstance(mapping, (OneToOneMapping, ManyToOneMapping)):
         parameter = mapping.get_apiv2_elements()[0]

package-parser/package_parser/processing/migration/annotations/_migrate_move_annotation.py

@@ -0,0 +1,104 @@
+from copy import deepcopy
+
+from package_parser.processing.annotations.model import (
+    AbstractAnnotation,
+    EnumReviewResult,
+    MoveAnnotation,
+    TodoAnnotation,
+)
+from package_parser.processing.api.model import (
+    Attribute,
+    Class,
+    Function,
+    Parameter,
+    Result,
+)
+from package_parser.processing.migration.model import (
+    ManyToOneMapping,
+    Mapping,
+    OneToOneMapping,
+)
+
+from ._constants import migration_author
+from ._get_migration_text import get_migration_text
+
+
+def is_moveable(element: Attribute | Class | Function | Parameter | Result) -> bool:
+    if isinstance(element, (Attribute, Result)):
+        return False
+    if isinstance(element, Function):
+        # check for global function
+        element_parents = element.id.split("/")
+        return len(element_parents) == 3
+    return isinstance(element, Class)
+
+
+# pylint: disable=duplicate-code
+def migrate_move_annotation(
+    move_annotation: MoveAnnotation, mapping: Mapping
+) -> list[AbstractAnnotation]:
+    move_annotation = deepcopy(move_annotation)
+    authors = move_annotation.authors
+    authors.append(migration_author)
+    move_annotation.authors = authors
+    migrate_text = get_migration_text(move_annotation, mapping)
+
+    if isinstance(mapping, (ManyToOneMapping, OneToOneMapping)):
+        element = mapping.get_apiv2_elements()[0]
+        if isinstance(element, (Attribute, Result)):
+            return []
+        if not is_moveable(element):
+            return [
+                TodoAnnotation(
+                    element.id,
+                    authors,
+                    move_annotation.reviewers,
+                    move_annotation.comment,
+                    EnumReviewResult.NONE,
+                    migrate_text,
+                )
+            ]
+        move_annotation.target = element.id
+        return [move_annotation]
+
+    annotated_apiv1_element = None
+    for element in mapping.get_apiv1_elements():
+        if (
+            not isinstance(element, (Attribute, Result))
+            and move_annotation.target == element.id
+        ):
+            annotated_apiv1_element = element
+            break
+
+    if annotated_apiv1_element is None:
+        return []
+
+    move_annotations: list[AbstractAnnotation] = []
+    for element in mapping.get_apiv2_elements():
+        if (
+            isinstance(element, type(annotated_apiv1_element))
+            and is_moveable(element)
+            and not isinstance(element, (Attribute, Result))
+        ):
+            move_annotations.append(
+                MoveAnnotation(
+                    element.id,
+                    authors,
+                    move_annotation.reviewers,
+                    move_annotation.comment,
+                    EnumReviewResult.NONE,
+                    move_annotation.destination,
+                )
+            )
+        elif not isinstance(element, (Attribute, Result)):
+            move_annotations.append(
+                TodoAnnotation(
+                    element.id,
+                    authors,
+                    move_annotation.reviewers,
+                    move_annotation.comment,
+                    EnumReviewResult.UNSURE,
+                    migrate_text,
+                )
+            )
+    return move_annotations

package-parser/package_parser/processing/migration/annotations/_migrate_rename_annotation.py

@@ -14,6 +14,7 @@
 )
 
 from ._constants import migration_author
+from ._get_migration_text import get_migration_text
 
 
 def migrate_rename_annotation(
@@ -32,16 +33,7 @@ def migrate_rename_annotation(
         rename_annotation.target = element.id
         return [rename_annotation]
 
-    migrate_text = (
-        "The @Rename Annotation with the new name '"
-        + rename_annotation.newName
-        + "' from the previous version was at '"
-        + rename_annotation.target
-        + "' and the possible alternatives in the new version of the api are: "
-        + ", ".join(
-            map(lambda api_element: api_element.name, mapping.get_apiv2_elements())
-        )
-    )
+    migrate_text = get_migration_text(rename_annotation, mapping)
 
     todo_annotations: list[AbstractAnnotation] = []
     for element in mapping.get_apiv2_elements():

package-parser/package_parser/processing/migration/annotations/_migrate_todo_annotation.py

@@ -13,8 +13,10 @@
 )
 
 from ._constants import migration_author
+from ._get_migration_text import get_migration_text
 
 
+# pylint: disable=duplicate-code
 def migrate_todo_annotation(
     todo_annotation: TodoAnnotation, mapping: Mapping
 ) -> list[AbstractAnnotation]:
@@ -30,21 +32,19 @@ def migrate_todo_annotation(
         todo_annotation.target = element.id
         return [todo_annotation]
 
-    migrate_text = (
-        "The @Todo Annotation with the todo '"
-        + todo_annotation.newTodo
-        + "' from the previous version was at '"
-        + todo_annotation.target
-        + "' and the possible alternatives in the new version of the api are: "
-        + ", ".join(
-            map(lambda api_element: api_element.name, mapping.get_apiv2_elements())
-        )
-    )
+    migrate_text = get_migration_text(todo_annotation, mapping)
 
     annotated_apiv1_element = None
     for element in mapping.get_apiv1_elements():
-        if not isinstance(element, (Attribute, Result)) and element.id:
+        if (
+            not isinstance(element, (Attribute, Result))
+            and todo_annotation.target == element.id
+        ):
             annotated_apiv1_element = element
+            break
+
+    if annotated_apiv1_element is None:
+        return []
 
     todo_annotations: list[AbstractAnnotation] = []
     for element in mapping.get_apiv2_elements():