tests: Add test for adding a completed task

[etc/taskwarrior.git] / tasklib / task.py

diff --git a/tasklib/task.py b/tasklib/task.py
index aa26729a432c63c963d26a270d49afb5de1311f8..ba95662de1736a2d53e2d041ff4f1faa199f68a0 100644 (file)
--- a/tasklib/task.py
+++ b/tasklib/task.py
@@ -5,6 +5,7 @@ import json
 import logging
 import os
 import pytz
 import logging
 import os
 import pytz

+import re

 import six
 import sys
 import subprocess
 import six
 import sys
 import subprocess


@@ -236,8 +237,15 @@ class SerializingObject(object):
         return ','.join(task['uuid'] for task in value)
 
     def deserialize_depends(self, raw_uuids):
         return ','.join(task['uuid'] for task in value)
 
     def deserialize_depends(self, raw_uuids):

-        raw_uuids = raw_uuids or ''  # Convert None to empty string
-        uuids = raw_uuids.split(',')
+        raw_uuids = raw_uuids or []  # Convert None to empty list
+
+        # TW 2.4.4 encodes list of dependencies as a single string
+        if type(raw_uuids) is not list:
+            uuids = raw_uuids.split(',')
+        # TW 2.4.5 and later exports them as a list, no conversion needed
+        else:
+            uuids = raw_uuids
+

         return set(self.warrior.tasks.get(uuid=uuid) for uuid in uuids if uuid)
 
     def datetime_normalizer(self, value):
         return set(self.warrior.tasks.get(uuid=uuid) for uuid in uuids if uuid)
 
     def datetime_normalizer(self, value):


@@ -297,7 +305,7 @@ class TaskResource(SerializingObject):
         # are not propagated.
         self._original_data = copy.deepcopy(self._data)
 
         # are not propagated.
         self._original_data = copy.deepcopy(self._data)
 

-    def _update_data(self, data, update_original=False):
+    def _update_data(self, data, update_original=False, remove_missing=False):

         """
         Low level update of the internal _data dict. Data which are coming as
         updates should already be serialized. If update_original is True, the
         """
         Low level update of the internal _data dict. Data which are coming as
         updates should already be serialized. If update_original is True, the


@@ -306,6 +314,11 @@ class TaskResource(SerializingObject):
         self._data.update(dict((key, self._deserialize(key, value))
                                for key, value in data.items()))
 
         self._data.update(dict((key, self._deserialize(key, value))
                                for key, value in data.items()))
 

+        # In certain situations, we want to treat missing keys as removals
+        if remove_missing:
+            for key in set(self._data.keys()) - set(data.keys()):
+                self._data[key] = None
+

         if update_original:
             self._original_data = copy.deepcopy(self._data)
 
         if update_original:
             self._original_data = copy.deepcopy(self._data)
 


@@ -416,6 +429,18 @@ class Task(TaskResource):
         """
         pass
 
         """
         pass
 

+    class ActiveTask(Exception):
+        """
+        Raised when the operation cannot be performed on the active task.
+        """
+        pass
+
+    class InactiveTask(Exception):
+        """
+        Raised when the operation cannot be performed on an inactive task.
+        """
+        pass
+

     class NotSaved(Exception):
         """
         Raised when the operation cannot be performed on the task, because
     class NotSaved(Exception):
         """
         Raised when the operation cannot be performed on the task, because


@@ -458,7 +483,8 @@ class Task(TaskResource):
         # If this is a on-modify event, we are provided with additional
         # line of input, which provides updated data
         if modify:
         # If this is a on-modify event, we are provided with additional
         # line of input, which provides updated data
         if modify:

-            task._update_data(json.loads(input_file.readline().strip()))
+            task._update_data(json.loads(input_file.readline().strip()),
+                              remove_missing=True)

 
         return task
 
 
         return task
 


@@ -588,12 +614,29 @@ class Task(TaskResource):
             raise Task.CompletedTask("Cannot start a completed task")
         elif self.deleted:
             raise Task.DeletedTask("Deleted task cannot be started")
             raise Task.CompletedTask("Cannot start a completed task")
         elif self.deleted:
             raise Task.DeletedTask("Deleted task cannot be started")

+        elif self.active:
+            raise Task.ActiveTask("Task is already active")

 
         self.warrior.execute_command([self['uuid'], 'start'])
 
         # Refresh the status again, so that we have updated info stored
         self.refresh(only_fields=['status', 'start'])
 
 
         self.warrior.execute_command([self['uuid'], 'start'])
 
         # Refresh the status again, so that we have updated info stored
         self.refresh(only_fields=['status', 'start'])
 

+    def stop(self):
+        if not self.saved:
+            raise Task.NotSaved("Task needs to be saved before it can be stopped")
+
+        # Refresh, and raise exception if task is already completed/deleted
+        self.refresh(only_fields=['status'])
+
+        if not self.active:
+            raise Task.InactiveTask("Cannot stop an inactive task")
+
+        self.warrior.execute_command([self['uuid'], 'stop'])
+
+        # Refresh the status again, so that we have updated info stored
+        self.refresh(only_fields=['status', 'start'])
+

     def done(self):
         if not self.saved:
             raise Task.NotSaved("Task needs to be saved before it can be completed")
     def done(self):
         if not self.saved:
             raise Task.NotSaved("Task needs to be saved before it can be completed")


@@ -606,6 +649,10 @@ class Task(TaskResource):
         elif self.deleted:
             raise Task.DeletedTask("Deleted task cannot be completed")
 
         elif self.deleted:
             raise Task.DeletedTask("Deleted task cannot be completed")
 

+        # Older versions of TW do not stop active task at completion
+        if self.warrior.version < VERSION_2_4_0 and self.active:
+            self.stop()
+

         self.warrior.execute_command([self['uuid'], 'done'])
 
         # Refresh the status again, so that we have updated info stored
         self.warrior.execute_command([self['uuid'], 'done'])
 
         # Refresh the status again, so that we have updated info stored


@@ -879,6 +926,10 @@ class TaskWarrior(object):
             'confirmation': 'no',
             'dependency.confirmation': 'no',  # See TW-1483 or taskrc man page
             'recurrence.confirmation': 'no',  # Necessary for modifying R tasks
             'confirmation': 'no',
             'dependency.confirmation': 'no',  # See TW-1483 or taskrc man page
             'recurrence.confirmation': 'no',  # Necessary for modifying R tasks

+
+            # Defaults to on since 2.4.5, we expect off during parsing
+            'json.array': 'off',
+

             # 2.4.3 onwards supports 0 as infite bulk, otherwise set just
             # arbitrary big number which is likely to be large enough
             'bulk': 0 if self.version >= VERSION_2_4_3 else 100000,
             # 2.4.3 onwards supports 0 as infite bulk, otherwise set just
             # arbitrary big number which is likely to be large enough
             'bulk': 0 if self.version >= VERSION_2_4_3 else 100000,


@@ -910,7 +961,24 @@ class TaskWarrior(object):
         stdout, stderr = [x.decode('utf-8') for x in p.communicate()]
         return stdout.strip('\n')
 
         stdout, stderr = [x.decode('utf-8') for x in p.communicate()]
         return stdout.strip('\n')
 

-    def execute_command(self, args, config_override={}, allow_failure=True):
+    def get_config(self):
+        raw_output = self.execute_command(
+                ['show'],
+                config_override={'verbose': 'nothing'}
+            )
+
+        config = dict()
+        config_regex = re.compile(r'^(?P<key>[^\s]+)\s+(?P<value>[^\s].+$)')
+
+        for line in raw_output:
+            match = config_regex.match(line)
+            if match:
+                config[match.group('key')] = match.group('value').strip()
+
+        return config
+
+    def execute_command(self, args, config_override={}, allow_failure=True,
+                        return_all=False):

         command_args = self._get_command_args(
             args, config_override=config_override)
         logger.debug(' '.join(command_args))
         command_args = self._get_command_args(
             args, config_override=config_override)
         logger.debug(' '.join(command_args))


@@ -923,7 +991,14 @@ class TaskWarrior(object):
             else:
                 error_msg = stdout.strip()
             raise TaskWarriorException(error_msg)
             else:
                 error_msg = stdout.strip()
             raise TaskWarriorException(error_msg)

-        return stdout.rstrip().split('\n')
+
+        # Return all whole triplet only if explicitly asked for
+        if not return_all:
+            return stdout.rstrip().split('\n')
+        else:
+            return (stdout.rstrip().split('\n'),
+                    stderr.rstrip().split('\n'),
+                    p.returncode)

 
     def enforce_recurrence(self):
         # Run arbitrary report command which will trigger generation
 
     def enforce_recurrence(self):
         # Run arbitrary report command which will trigger generation