fix wrong Task Type

closes #6

Author: Carli

CHANGELOG.rst

@@ -8,6 +8,8 @@ Version 0.0.6
 - Add shortcuts ``-u`` and ``-t``  for gitlab url and gitlab token
 - Add `PreCommit`_ to prevent failing builds :issue:`4`
 - Fix Bug that percentage done was not calculated correctly :issue:`5`
+- Syncing always set Task Type to Fixed Work but revert to original after sync :issue:`6`
+- Adding parameter ``--force-fixed-work``  that does not reset the Task Type after sync
 
 Version 0.0.5
 =============

src/syncgitlab2msproject/cli.py

@@ -23,6 +23,7 @@
     get_group_issues,
     get_project_issues,
 )
+from syncgitlab2msproject.helper_classes import ForceFixedWork, SetTaskTypeConservative
 from syncgitlab2msproject.sync import sync_gitlab_issues_to_ms_project
 
 _logger = logging.getLogger(f"{__package__}.{__name__}")
@@ -70,6 +71,14 @@ def parse_args(args):
         type=str,
     )
 
+    parser.add_argument(
+        "--force-fixed-work",
+        dest="fixed_work",
+        help="Set all synced issued to fixed_work, overwriting "
+        "also already existing tasks",
+        action="store_true",
+    )
+
     # TODO read from ENV
     parser.add_argument(
         "--gitlab-url",
@@ -196,6 +205,11 @@ def main(args):
     else:
         raise ValueError("Invalid Resource Type")
 
+    if args.fixed_work:
+        sync_task_helper = ForceFixedWork
+    else:
+        sync_task_helper = SetTaskTypeConservative
+
     try:
         issues = get_issues_func(gitlab, args.gitlab_resource_id)
     except ConnectionError as e:
@@ -205,7 +219,7 @@ def main(args):
         include_issue = functools.partial(has_not_label, label=args.ignore_label)
         with MSProject(ms_project_file.absolute()) as tasks:
             sync_gitlab_issues_to_ms_project(
-                tasks, issues, WebURL(args.gitlab_url), include_issue
+                tasks, issues, WebURL(args.gitlab_url), sync_task_helper, include_issue
             )
     _logger.info("Finished syncing")
 

src/syncgitlab2msproject/helper_classes.py

@@ -0,0 +1,69 @@
+from abc import ABC, abstractmethod
+from typing import Optional
+
+from .gitlab_issues import Issue
+from .ms_project import PjTaskFixedType, Task
+
+
+class TaskTyperSetter(ABC):
+    """
+    Abstract Base Class that is used to dynamically allow setting the task type
+    """
+
+    def __init__(self, issue: Issue) -> None:
+        self._type_before_sync: Optional[PjTaskFixedType] = None
+        self._effort_driven_before_sync: Optional[bool] = None
+        self._is_initial: bool = False
+        self.issue = Issue
+
+    @abstractmethod
+    def set_task_type_before_sync(self, task: Task, is_initial: bool) -> None:
+        """
+        Function that is called at the beginning of the sync
+        """
+
+    @abstractmethod
+    def set_task_type_after_sync(self, task: Task) -> None:
+        """
+        Function just before finishing the sync
+        """
+
+
+class SetTaskTypeConservative(TaskTyperSetter):
+    """
+    Set Fixed Work as default creating a new task and before syncing any Task
+    but make sure to reset to the original value (including Effort Driven Setting)
+    after finishing the sync
+    """
+
+    def set_task_type_before_sync(self, task: Task, is_inital: bool) -> None:
+        if task.has_children:
+            # Can't update tasks with children
+            return
+        self._type_before_sync = task.type
+        self._effort_driven_before_sync = task.effort_driven
+        self._is_initial = is_inital
+        task.type = PjTaskFixedType.pjFixedWork
+
+    def set_task_type_after_sync(self, task: Task) -> None:
+        if task.has_children:
+            # Can't update tasks with children
+            return
+        if not self._is_initial:
+            assert self._effort_driven_before_sync is not None
+            assert self._type_before_sync is not None
+            # Only update if required
+            if task.type != self._type_before_sync:
+                task.type = self._type_before_sync
+            if task.effort_driven != self._effort_driven_before_sync:
+                task.effort_driven = self._effort_driven_before_sync
+
+
+class ForceFixedWork(SetTaskTypeConservative):
+    """
+    No matter what always set Task Type to Fixed Work for all synced Task
+    """
+
+    def set_task_type_after_sync(self, task: Task) -> None:
+        # Make sure the everything is FixedWork by default by not resetting it
+        pass

src/syncgitlab2msproject/sync.py

@@ -1,8 +1,9 @@
 import win32com.universal
 from logging import getLogger
-from typing import Callable, Dict, List, Optional, overload
+from typing import Callable, Dict, List, Optional, Type, overload
 
 from syncgitlab2msproject.custom_types import WebURL
+from syncgitlab2msproject.helper_classes import TaskTyperSetter
 
 from .custom_types import IssueRef
 from .exceptions import (
@@ -79,9 +80,11 @@ def check_get_url(value: Optional[str]) -> Optional[WebURL]:
 def update_task_with_issue_data(
     task: Task,
     issue: Issue,
+    task_type_setter: Type[TaskTyperSetter],
     *,
     parent_ids: Optional[List[IssueRef]] = None,
     ignore_issue: bool = False,
+    is_add: bool = False,
 ) -> List[IssueRef]:
     """
     Update task with issue data
@@ -91,9 +94,11 @@ def update_task_with_issue_data(
     Args:
         task: The MS Project task that will be updated
         issue: the issue with the data to be considered
+        task_type_setter: Helper class to set the task type correct
         parent_ids: the parent stuff
         ignore_issue: only return the related (and moved) ids but do not really sync
                       This is required so we can ignored also moved issues correctly
+        is_add:
 
     Returns:
         list of IssueRefs that
@@ -107,7 +112,11 @@ def update_task_with_issue_data(
         assert moved_ref is not None
         try:
             return update_task_with_issue_data(
-                task, moved_ref, parent_ids=parent_ids, ignore_issue=ignore_issue
+                task,
+                moved_ref,
+                task_type_setter,
+                parent_ids=parent_ids,
+                ignore_issue=ignore_issue,
             )
         except MovedIssueNotDefined:
             logger.warning(
@@ -117,6 +126,8 @@ def update_task_with_issue_data(
     elif not ignore_issue:
         set_issue_ref_to_task(task, issue)
         try:
+            type_setter = task_type_setter(issue)
+            type_setter.set_task_type_before_sync(task, is_add)
             task.name = issue.title
             task.notes = issue.description
             if issue.due_date is not None:
@@ -135,6 +146,7 @@ def update_task_with_issue_data(
             task.text28 = "; ".join([f'"{label}"' for label in issue.labels])
             if issue.is_closed:
                 task.actual_finish = issue.closed_at
+            type_setter.set_task_type_after_sync(task)
         except (MSProjectValueSetError, win32com.universal.com_error) as e:
             logger.error(
                 f"FATAL: Could not sync issue {issue} to task {task}.\nError: {e}"
@@ -144,12 +156,14 @@ def update_task_with_issue_data(
     return parent_ids
 
 
-def add_issue_as_task_to_project(tasks: MSProject, issue: Issue):
+def add_issue_as_task_to_project(
+    tasks: MSProject, issue: Issue, task_type_setter: Type[TaskTyperSetter]
+):
     task = tasks.add_task(issue.title)
     logger.info(f"Created {task} as it was missing for issue, now syncing it.")
     # Add a setting to allow forcing outline level on new tasks
     # task.outline_level = 1
-    update_task_with_issue_data(task, issue)
+    update_task_with_issue_data(task, issue, task_type_setter, is_add=True)
 
 
 class IssueFinder:
@@ -237,6 +251,7 @@ def sync_gitlab_issues_to_ms_project(
     tasks: MSProject,
     issues: List[Issue],
     gitlab_url: WebURL,
+    task_type_setter: Type[TaskTyperSetter],
     include_issue: Optional[Callable[[Issue], bool]] = None,
 ) -> None:
     """
@@ -295,7 +310,7 @@ def always_true(x: Issue):
             # added and we also want make sure that moved ignored issues are handled
             # correctly
             synced += update_task_with_issue_data(
-                task, ref_issue, ignore_issue=ignore_issue
+                task, ref_issue, task_type_setter, ignore_issue=ignore_issue
             )
 
     # adding everything that was not synced and is not duplicate
@@ -308,4 +323,4 @@ def always_true(x: Issue):
                         f"as it has been marked to be ignored."
                     )
                 else:
-                    add_issue_as_task_to_project(tasks, ref_issue)
+                    add_issue_as_task_to_project(tasks, ref_issue, task_type_setter)