]> git.madduck.net Git - etc/taskwarrior.git/blobdiff - tasklib/tests.py

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

tests: Python 2.6. does not support timedelta.total_seconds, add workaround
[etc/taskwarrior.git] / tasklib / tests.py
index 8fc5753219fd1ee224d758b82f83d1a6d29df4b0..3e18bc96d4c9ed094a7e8b742d68017c0b1a04bd 100644 (file)
@@ -1,18 +1,50 @@
 # coding=utf-8
 
 # coding=utf-8
 
+import copy
 import datetime
 import datetime
+import itertools
+import json
+import pytz
+import six
 import shutil
 import shutil
+import sys
 import tempfile
 import unittest
 
 import tempfile
 import unittest
 
-from .task import TaskWarrior, Task
+from .task import TaskWarrior, Task, ReadOnlyDictView, local_zone, DATE_FORMAT
+
+# http://taskwarrior.org/docs/design/task.html , Section: The Attributes
+TASK_STANDARD_ATTRS = (
+    'status',
+    'uuid',
+    'entry',
+    'description',
+    'start',
+    'end',
+    'due',
+    'until',
+    'wait',
+    'modified',
+    'scheduled',
+    'recur',
+    'mask',
+    'imask',
+    'parent',
+    'project',
+    'priority',
+    'depends',
+    'tags',
+    'annotations',
+)
+
+total_seconds_2_6 = lambda x: x.microseconds / 1e6 + x.seconds + x.days * 24 * 3600
 
 
 class TasklibTest(unittest.TestCase):
 
     def setUp(self):
         self.tmp = tempfile.mkdtemp(dir='.')
 
 
 class TasklibTest(unittest.TestCase):
 
     def setUp(self):
         self.tmp = tempfile.mkdtemp(dir='.')
-        self.tw = TaskWarrior(data_location=self.tmp)
+        self.tw = TaskWarrior(data_location=self.tmp, taskrc_location='/')
 
     def tearDown(self):
         shutil.rmtree(self.tmp)
 
     def tearDown(self):
         shutil.rmtree(self.tmp)
@@ -98,6 +130,112 @@ class TaskFilterTest(TasklibTest):
         filtered_task = self.tw.tasks.get(project="random")
         self.assertEqual(filtered_task['project'], "random")
 
         filtered_task = self.tw.tasks.get(project="random")
         self.assertEqual(filtered_task['project'], "random")
 
+    def test_filter_with_empty_uuid(self):
+        self.assertRaises(ValueError, lambda: self.tw.tasks.get(uuid=''))
+
+    def test_filter_dummy_by_status(self):
+        t = Task(self.tw, description="test")
+        t.save()
+
+        tasks = self.tw.tasks.filter(status=t['status'])
+        self.assertEqual(list(tasks), [t])
+
+    def test_filter_dummy_by_uuid(self):
+        t = Task(self.tw, description="test")
+        t.save()
+
+        tasks = self.tw.tasks.filter(uuid=t['uuid'])
+        self.assertEqual(list(tasks), [t])
+
+    def test_filter_dummy_by_entry(self):
+        t = Task(self.tw, description="test")
+        t.save()
+
+        tasks = self.tw.tasks.filter(entry=t['entry'])
+        self.assertEqual(list(tasks), [t])
+
+    def test_filter_dummy_by_description(self):
+        t = Task(self.tw, description="test")
+        t.save()
+
+        tasks = self.tw.tasks.filter(description=t['description'])
+        self.assertEqual(list(tasks), [t])
+
+    def test_filter_dummy_by_start(self):
+        t = Task(self.tw, description="test")
+        t.save()
+        t.start()
+
+        tasks = self.tw.tasks.filter(start=t['start'])
+        self.assertEqual(list(tasks), [t])
+
+    def test_filter_dummy_by_end(self):
+        t = Task(self.tw, description="test")
+        t.save()
+        t.done()
+
+        tasks = self.tw.tasks.filter(end=t['end'])
+        self.assertEqual(list(tasks), [t])
+
+    def test_filter_dummy_by_due(self):
+        t = Task(self.tw, description="test", due=datetime.datetime.now())
+        t.save()
+
+        tasks = self.tw.tasks.filter(due=t['due'])
+        self.assertEqual(list(tasks), [t])
+
+    def test_filter_dummy_by_until(self):
+        t = Task(self.tw, description="test")
+        t.save()
+
+        tasks = self.tw.tasks.filter(until=t['until'])
+        self.assertEqual(list(tasks), [t])
+
+    def test_filter_dummy_by_modified(self):
+        # Older TW version does not support bumping modified
+        # on save
+        if self.tw.version < six.text_type('2.2.0'):
+            # Python2.6 does not support SkipTest. As a workaround
+            # mark the test as passed by exiting.
+            if getattr(unittest, 'SkipTest', None) is not None:
+                raise unittest.SkipTest()
+            else:
+                return
+
+        t = Task(self.tw, description="test")
+        t.save()
+
+        tasks = self.tw.tasks.filter(modified=t['modified'])
+        self.assertEqual(list(tasks), [t])
+
+    def test_filter_dummy_by_scheduled(self):
+        t = Task(self.tw, description="test")
+        t.save()
+
+        tasks = self.tw.tasks.filter(scheduled=t['scheduled'])
+        self.assertEqual(list(tasks), [t])
+
+    def test_filter_dummy_by_tags(self):
+        t = Task(self.tw, description="test", tags=["home"])
+        t.save()
+
+        tasks = self.tw.tasks.filter(tags=t['tags'])
+        self.assertEqual(list(tasks), [t])
+
+    def test_filter_dummy_by_projects(self):
+        t = Task(self.tw, description="test", project="random")
+        t.save()
+
+        tasks = self.tw.tasks.filter(project=t['project'])
+        self.assertEqual(list(tasks), [t])
+
+    def test_filter_by_priority(self):
+        t = Task(self.tw, description="test", priority="H")
+        t.save()
+
+        tasks = self.tw.tasks.filter(priority=t['priority'])
+        self.assertEqual(list(tasks), [t])
+
 
 class TaskTest(TasklibTest):
 
 
 class TaskTest(TasklibTest):
 
@@ -121,6 +259,10 @@ class TaskTest(TasklibTest):
         t = Task(self.tw, description="test task")
         self.assertRaises(Task.NotSaved, t.refresh)
 
         t = Task(self.tw, description="test task")
         self.assertRaises(Task.NotSaved, t.refresh)
 
+    def test_start_unsaved_task(self):
+        t = Task(self.tw, description="test task")
+        self.assertRaises(Task.NotSaved, t.start)
+
     def test_delete_deleted_task(self):
         t = Task(self.tw, description="test task")
         t.save()
     def test_delete_deleted_task(self):
         t = Task(self.tw, description="test task")
         t.save()
@@ -135,6 +277,13 @@ class TaskTest(TasklibTest):
 
         self.assertRaises(Task.CompletedTask, t.done)
 
 
         self.assertRaises(Task.CompletedTask, t.done)
 
+    def test_start_completed_task(self):
+        t = Task(self.tw, description="test task")
+        t.save()
+        t.done()
+
+        self.assertRaises(Task.CompletedTask, t.start)
+
     def test_complete_deleted_task(self):
         t = Task(self.tw, description="test task")
         t.save()
     def test_complete_deleted_task(self):
         t = Task(self.tw, description="test task")
         t.save()
@@ -142,6 +291,40 @@ class TaskTest(TasklibTest):
 
         self.assertRaises(Task.DeletedTask, t.done)
 
 
         self.assertRaises(Task.DeletedTask, t.done)
 
+    def test_start_completed_task(self):
+        t = Task(self.tw, description="test task")
+        t.save()
+        t.done()
+
+        self.assertRaises(Task.CompletedTask, t.start)
+
+    def test_starting_task(self):
+        t = Task(self.tw, description="test task")
+        now = t.datetime_normalizer(datetime.datetime.now())
+        t.save()
+        t.start()
+
+        self.assertTrue(now.replace(microsecond=0) <= t['start'])
+        self.assertEqual(t['status'], 'pending')
+
+    def test_completing_task(self):
+        t = Task(self.tw, description="test task")
+        now = t.datetime_normalizer(datetime.datetime.now())
+        t.save()
+        t.done()
+
+        self.assertTrue(now.replace(microsecond=0) <= t['end'])
+        self.assertEqual(t['status'], 'completed')
+
+    def test_deleting_task(self):
+        t = Task(self.tw, description="test task")
+        now = t.datetime_normalizer(datetime.datetime.now())
+        t.save()
+        t.delete()
+
+        self.assertTrue(now.replace(microsecond=0) <= t['end'])
+        self.assertEqual(t['status'], 'deleted')
+
     def test_modify_simple_attribute_without_space(self):
         t = Task(self.tw, description="test")
         t.save()
     def test_modify_simple_attribute_without_space(self):
         t = Task(self.tw, description="test")
         t.save()
@@ -411,6 +594,14 @@ class TaskTest(TasklibTest):
         t['depends'] = set([dependency])
         self.assertEqual(set(t._modified_fields), set())
 
         t['depends'] = set([dependency])
         self.assertEqual(set(t._modified_fields), set())
 
+    def test_modified_fields_not_affected_by_reading(self):
+        t = Task(self.tw)
+
+        for field in TASK_STANDARD_ATTRS:
+            value = t[field]
+
+        self.assertEqual(set(t._modified_fields), set())
+
     def test_setting_read_only_attrs_through_init(self):
         # Test that we are unable to set readonly attrs through __init__
         for readonly_key in Task.read_only_fields:
     def test_setting_read_only_attrs_through_init(self):
         # Test that we are unable to set readonly attrs through __init__
         for readonly_key in Task.read_only_fields:
@@ -444,6 +635,242 @@ class TaskTest(TasklibTest):
         t.save()
         self.assertEqual(t['tags'], ['test'])
 
         t.save()
         self.assertEqual(t['tags'], ['test'])
 
+    def test_serializers_returning_empty_string_for_none(self):
+        # Test that any serializer returns '' when passed None
+        t = Task(self.tw)
+        serializers = [getattr(t, serializer_name) for serializer_name in
+                       filter(lambda x: x.startswith('serialize_'), dir(t))]
+        for serializer in serializers:
+            self.assertEqual(serializer(None), '')
+
+    def test_deserializer_returning_empty_value_for_empty_string(self):
+        # Test that any deserializer returns empty value when passed ''
+        t = Task(self.tw)
+        deserializers = [getattr(t, deserializer_name) for deserializer_name in
+                        filter(lambda x: x.startswith('deserialize_'), dir(t))]
+        for deserializer in deserializers:
+            self.assertTrue(deserializer('') in (None, [], set()))
+
+    def test_normalizers_handling_none(self):
+        # Test that any normalizer can handle None as a valid value
+        t = Task(self.tw)
+
+        for key in TASK_STANDARD_ATTRS:
+            t._normalize(key, None)
+
+    def test_recurrent_task_generation(self):
+        today = datetime.date.today()
+        t = Task(self.tw, description="brush teeth",
+                 due=today, recur="daily")
+        t.save()
+        self.assertEqual(len(self.tw.tasks.pending()), 2)
+
+    def test_modify_number_of_tasks_at_once(self):
+        for i in range(1, 100):
+            Task(self.tw, description="test task %d" % i, tags=['test']).save()
+
+        self.tw.execute_command(['+test', 'mod', 'unified', 'description'])
+
+
+class TaskFromHookTest(TasklibTest):
+
+    input_add_data = six.StringIO(
+        '{"description":"Buy some milk",'
+        '"entry":"20141118T050231Z",'
+        '"status":"pending",'
+        '"uuid":"a360fc44-315c-4366-b70c-ea7e7520b749"}')
+
+    input_modify_data = six.StringIO(input_add_data.getvalue() + '\n' +
+        '{"description":"Buy some milk finally",'
+        '"entry":"20141118T050231Z",'
+        '"status":"completed",'
+        '"uuid":"a360fc44-315c-4366-b70c-ea7e7520b749"}')
+
+    exported_raw_data = (
+        '{"project":"Home",'
+         '"due":"20150101T232323Z",'
+         '"description":"test task"}')
+
+    def test_setting_up_from_add_hook_input(self):
+        t = Task.from_input(input_file=self.input_add_data, warrior=self.tw)
+        self.assertEqual(t['description'], "Buy some milk")
+        self.assertEqual(t.pending, True)
+
+    def test_setting_up_from_modified_hook_input(self):
+        t = Task.from_input(input_file=self.input_modify_data, modify=True,
+                            warrior=self.tw)
+        self.assertEqual(t['description'], "Buy some milk finally")
+        self.assertEqual(t.pending, False)
+        self.assertEqual(t.completed, True)
+
+        self.assertEqual(t._original_data['status'], "pending")
+        self.assertEqual(t._original_data['description'], "Buy some milk")
+        self.assertEqual(set(t._modified_fields),
+                         set(['status', 'description']))
+
+    def test_export_data(self):
+        t = Task(self.tw, description="test task",
+            project="Home",
+            due=pytz.utc.localize(datetime.datetime(2015,1,1,23,23,23)))
+
+        # Check that the output is a permutation of:
+        # {"project":"Home","description":"test task","due":"20150101232323Z"}
+        allowed_segments = self.exported_raw_data[1:-1].split(',')
+        allowed_output = [
+            '{' + ','.join(segments) + '}'
+            for segments in itertools.permutations(allowed_segments)
+        ]
+
+        self.assertTrue(any(t.export_data() == expected
+                            for expected in allowed_output))
+
+class TimezoneAwareDatetimeTest(TasklibTest):
+
+    def setUp(self):
+        super(TimezoneAwareDatetimeTest, self).setUp()
+        self.zone = local_zone
+        self.localdate_naive = datetime.datetime(2015,2,2)
+        self.localtime_naive = datetime.datetime(2015,2,2,0,0,0)
+        self.localtime_aware = self.zone.localize(self.localtime_naive)
+        self.utctime_aware = self.localtime_aware.astimezone(pytz.utc)
+
+    def test_timezone_naive_datetime_setitem(self):
+        t = Task(self.tw, description="test task")
+        t['due'] = self.localtime_naive
+        self.assertEqual(t['due'], self.localtime_aware)
+
+    def test_timezone_naive_datetime_using_init(self):
+        t = Task(self.tw, description="test task", due=self.localtime_naive)
+        self.assertEqual(t['due'], self.localtime_aware)
+
+    def test_filter_by_naive_datetime(self):
+        t = Task(self.tw, description="task1", due=self.localtime_naive)
+        t.save()
+        matching_tasks = self.tw.tasks.filter(due=self.localtime_naive)
+        self.assertEqual(len(matching_tasks), 1)
+
+    def test_serialize_naive_datetime(self):
+        t = Task(self.tw, description="task1", due=self.localtime_naive)
+        self.assertEqual(json.loads(t.export_data())['due'],
+                         self.utctime_aware.strftime(DATE_FORMAT))
+
+    def test_timezone_naive_date_setitem(self):
+        t = Task(self.tw, description="test task")
+        t['due'] = self.localdate_naive
+        self.assertEqual(t['due'], self.localtime_aware)
+
+    def test_timezone_naive_date_using_init(self):
+        t = Task(self.tw, description="test task", due=self.localdate_naive)
+        self.assertEqual(t['due'], self.localtime_aware)
+
+    def test_filter_by_naive_date(self):
+        t = Task(self.tw, description="task1", due=self.localdate_naive)
+        t.save()
+        matching_tasks = self.tw.tasks.filter(due=self.localdate_naive)
+        self.assertEqual(len(matching_tasks), 1)
+
+    def test_serialize_naive_date(self):
+        t = Task(self.tw, description="task1", due=self.localdate_naive)
+        self.assertEqual(json.loads(t.export_data())['due'],
+                         self.utctime_aware.strftime(DATE_FORMAT))
+
+    def test_timezone_aware_datetime_setitem(self):
+        t = Task(self.tw, description="test task")
+        t['due'] = self.localtime_aware
+        self.assertEqual(t['due'], self.localtime_aware)
+
+    def test_timezone_aware_datetime_using_init(self):
+        t = Task(self.tw, description="test task", due=self.localtime_aware)
+        self.assertEqual(t['due'], self.localtime_aware)
+
+    def test_filter_by_aware_datetime(self):
+        t = Task(self.tw, description="task1", due=self.localtime_aware)
+        t.save()
+        matching_tasks = self.tw.tasks.filter(due=self.localtime_aware)
+        self.assertEqual(len(matching_tasks), 1)
+
+    def test_serialize_aware_datetime(self):
+        t = Task(self.tw, description="task1", due=self.localtime_aware)
+        self.assertEqual(json.loads(t.export_data())['due'],
+                         self.utctime_aware.strftime(DATE_FORMAT))
+
+class DatetimeStringTest(TasklibTest):
+
+    def test_simple_now_conversion(self):
+        if self.tw.version < six.text_type('2.4.0'):
+            # Python2.6 does not support SkipTest. As a workaround
+            # mark the test as passed by exiting.
+            if getattr(unittest, 'SkipTest', None) is not None:
+                raise unittest.SkipTest()
+            else:
+                return
+
+        t = Task(self.tw, description="test task", due="now")
+        now = local_zone.localize(datetime.datetime.now())
+
+        # Assert that both times are not more than 5 seconds apart
+        if sys.version > (2,6):
+            self.assertTrue((now - t['due']).total_seconds() < 5)
+            self.assertTrue((t['due'] - now).total_seconds() < 5)
+        else:
+            self.assertTrue(total_seconds_2_6(now - t['due']) < 5)
+            self.assertTrue(total_seconds_2_6(t['due'] - now) < 5)
+
+    def test_simple_eoy_conversion(self):
+        if self.tw.version < six.text_type('2.4.0'):
+            # Python2.6 does not support SkipTest. As a workaround
+            # mark the test as passed by exiting.
+            if getattr(unittest, 'SkipTest', None) is not None:
+                raise unittest.SkipTest()
+            else:
+                return
+
+        t = Task(self.tw, description="test task", due="eoy")
+        now = local_zone.localize(datetime.datetime.now())
+        eoy = local_zone.localize(datetime.datetime(
+            year=now.year,
+            month=12,
+            day=31,
+            hour=23,
+            minute=59,
+            second=59
+            ))
+        self.assertEqual(eoy, t['due'])
+
+    def test_complex_eoy_conversion(self):
+        if self.tw.version < six.text_type('2.4.0'):
+            # Python2.6 does not support SkipTest. As a workaround
+            # mark the test as passed by exiting.
+            if getattr(unittest, 'SkipTest', None) is not None:
+                raise unittest.SkipTest()
+            else:
+                return
+
+        t = Task(self.tw, description="test task", due="eoy - 4 months")
+        now = local_zone.localize(datetime.datetime.now())
+        due_date = local_zone.localize(datetime.datetime(
+            year=now.year,
+            month=12,
+            day=31,
+            hour=23,
+            minute=59,
+            second=59
+            )) - datetime.timedelta(0,4 * 30 * 86400)
+        self.assertEqual(due_date, t['due'])
+
+    def test_filtering_with_string_datetime(self):
+        if self.tw.version < six.text_type('2.4.0'):
+            # Python2.6 does not support SkipTest. As a workaround
+            # mark the test as passed by exiting.
+            if getattr(unittest, 'SkipTest', None) is not None:
+                raise unittest.SkipTest()
+            else:
+                return
+
+        t = Task(self.tw, description="test task",
+                 due=datetime.datetime.now() - datetime.timedelta(0,2))
+        t.save()
+        self.assertEqual(len(self.tw.tasks.filter(due__before="now")), 1)
 
 class AnnotationTest(TasklibTest):
 
 
 class AnnotationTest(TasklibTest):
 
@@ -486,6 +913,23 @@ class AnnotationTest(TasklibTest):
          task.save()
          self.assertEqual(task['project'], 'test')
 
          task.save()
          self.assertEqual(task['project'], 'test')
 
+    def test_serialize_annotations(self):
+        # Test that serializing annotations is possible
+        t = Task(self.tw, description="test")
+        t.save()
+
+        t.add_annotation("annotation1")
+        t.add_annotation("annotation2")
+
+        data = t._serialize('annotations', t._data['annotations'])
+
+        self.assertEqual(len(data), 2)
+        self.assertEqual(type(data[0]), dict)
+        self.assertEqual(type(data[1]), dict)
+
+        self.assertEqual(data[0]['description'], "annotation1")
+        self.assertEqual(data[1]['description'], "annotation2")
+
 
 class UnicodeTest(TasklibTest):
 
 
 class UnicodeTest(TasklibTest):
 
@@ -496,3 +940,76 @@ class UnicodeTest(TasklibTest):
     def test_non_unicode_task(self):
         Task(self.tw, description="test task").save()
         self.tw.tasks.get()
     def test_non_unicode_task(self):
         Task(self.tw, description="test task").save()
         self.tw.tasks.get()
+
+class ReadOnlyDictViewTest(unittest.TestCase):
+
+    def setUp(self):
+        self.sample = dict(l=[1,2,3], d={'k':'v'})
+        self.original_sample = copy.deepcopy(self.sample)
+        self.view = ReadOnlyDictView(self.sample)
+
+    def test_readonlydictview_getitem(self):
+        l = self.view['l']
+        self.assertEqual(l, self.sample['l'])
+
+        # Assert that modification changed only copied value
+        l.append(4)
+        self.assertNotEqual(l, self.sample['l'])
+
+        # Assert that viewed dict is not changed
+        self.assertEqual(self.sample, self.original_sample)
+
+    def test_readonlydictview_contains(self):
+        self.assertEqual('l' in self.view, 'l' in self.sample)
+        self.assertEqual('d' in self.view, 'd' in self.sample)
+        self.assertEqual('k' in self.view, 'k' in self.sample)
+
+        # Assert that viewed dict is not changed
+        self.assertEqual(self.sample, self.original_sample)
+
+    def test_readonlydictview_iter(self):
+        self.assertEqual(list(k for k in self.view),
+                         list(k for k in self.sample))
+
+        # Assert the view is correct after modification
+        self.sample['new'] = 'value'
+        self.assertEqual(list(k for k in self.view),
+                         list(k for k in self.sample))
+
+    def test_readonlydictview_len(self):
+        self.assertEqual(len(self.view), len(self.sample))
+
+        # Assert the view is correct after modification
+        self.sample['new'] = 'value'
+        self.assertEqual(len(self.view), len(self.sample))
+
+    def test_readonlydictview_get(self):
+        l = self.view.get('l')
+        self.assertEqual(l, self.sample.get('l'))
+
+        # Assert that modification changed only copied value
+        l.append(4)
+        self.assertNotEqual(l, self.sample.get('l'))
+
+        # Assert that viewed dict is not changed
+        self.assertEqual(self.sample, self.original_sample)
+
+    def test_readonlydict_items(self):
+        view_items = self.view.items()
+        sample_items = list(self.sample.items())
+        self.assertEqual(view_items, sample_items)
+
+        view_items.append('newkey')
+        self.assertNotEqual(view_items, sample_items)
+        self.assertEqual(self.sample, self.original_sample)
+
+    def test_readonlydict_values(self):
+        view_values = self.view.values()
+        sample_values = list(self.sample.values())
+        self.assertEqual(view_values, sample_values)
+
+        view_list_item = list(filter(lambda x: type(x) is list,
+                                     view_values))[0]
+        view_list_item.append(4)
+        self.assertNotEqual(view_values, sample_values)
+        self.assertEqual(self.sample, self.original_sample)