Docs: Document the original attribute access to the task object

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

diff --git a/tasklib/tests.py b/tasklib/tests.py
index cba3271cf7c2090dfd6a9fd7cba5d0892828d857..0dae79e53a3b5564ca45c9604268266a62f0f539 100644 (file)
--- a/tasklib/tests.py
+++ b/tasklib/tests.py
@@ -1,14 +1,40 @@
 # coding=utf-8
 
 # coding=utf-8
 

+import copy

 import datetime
 import itertools
 import datetime
 import itertools

+import json
+import pytz

 import six
 import shutil
 import tempfile
 import unittest
 
 import six
 import shutil
 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',
+)

 
 class TasklibTest(unittest.TestCase):
 
 
 class TasklibTest(unittest.TestCase):
 


@@ -100,6 +126,8 @@ 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=''))

 
 class TaskTest(TasklibTest):
 
 
 class TaskTest(TasklibTest):
 


@@ -413,6 +441,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:


@@ -446,6 +482,42 @@ 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)
+
+        # These normalizers are not supposed to handle None
+        exempt_normalizers = ('normalize_uuid', )
+
+        normalizers = [getattr(t, normalizer_name) for normalizer_name in
+                       filter(lambda x: x.startswith('normalize_'), dir(t))
+                       if normalizer_name not in exempt_normalizers]
+
+        for normalizer in normalizers:
+            normalizer(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)

 
 class TaskFromHookTest(TasklibTest):
 
 
 class TaskFromHookTest(TasklibTest):
 


@@ -484,7 +556,8 @@ class TaskFromHookTest(TasklibTest):
 
     def test_export_data(self):
         t = Task(self.tw, description="test task",
 
     def test_export_data(self):
         t = Task(self.tw, description="test task",

-            project="Home", due=datetime.datetime(2015,1,1,23,23,23))
+            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"}
 
         # Check that the output is a permutation of:
         # {"project":"Home","description":"test task","due":"20150101232323Z"}


@@ -497,6 +570,75 @@ class TaskFromHookTest(TasklibTest):
         self.assertTrue(any(t.export_data() == expected
                             for expected in allowed_output))
 
         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 AnnotationTest(TasklibTest):
 
 
 class AnnotationTest(TasklibTest):
 


@@ -539,6 +681,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):
 


@@ -549,3 +708,83 @@ 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_readonlydictview_contains(self):
+        self.assertEqual(self.view.has_key('l'), self.sample.has_key('l'))
+        self.assertEqual(self.view.has_key('k'), self.sample.has_key('k'))
+        self.assertEqual(self.view.has_key('d'), self.sample.has_key('d'))
+
+        # 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 = 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 = self.sample.values()
+        self.assertEqual(view_values, sample_values)
+
+        view_list_item = 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)