Docs: Provide documentation for using tasklib in hooks scripts

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

diff --git a/tasklib/tests.py b/tasklib/tests.py
index 6d67a12d4fb7ae0098080bf5762bee7d1e54c701..cba3271cf7c2090dfd6a9fd7cba5d0892828d857 100644 (file)
--- a/tasklib/tests.py
+++ b/tasklib/tests.py
@@ -1,6 +1,8 @@
 # coding=utf-8
 
 import datetime
+import itertools
+import six
 import shutil
 import tempfile
 import unittest
@@ -181,9 +183,9 @@ class TaskTest(TasklibTest):
 
         # We only save the parent task, dependency task is unsaved
         t.save()
+        t['depends'] = set([dependency])
 
-        self.assertRaises(Task.NotSaved,
-                          t.__setitem__, 'depends', set([dependency]))
+        self.assertRaises(Task.NotSaved, t.save)
 
     def test_set_simple_dependency_set(self):
         # Adds only one dependency to task with no dependencies
@@ -223,7 +225,7 @@ class TaskTest(TasklibTest):
         t['depends'] = set([dependency1, dependency2])
         t.save()
 
-        t['depends'] = t['depends'] - set([dependency2])
+        t['depends'].remove(dependency2)
         t.save()
 
         self.assertEqual(t['depends'], set([dependency1]))
@@ -240,11 +242,23 @@ class TaskTest(TasklibTest):
         t['depends'] = set([dependency1])
         t.save()
 
-        t['depends'] = t['depends'] | set([dependency2])
+        t['depends'].add(dependency2)
         t.save()
 
         self.assertEqual(t['depends'], set([dependency1, dependency2]))
 
+    def test_add_to_empty_dependency_set(self):
+        # Adds dependency to task with one dependencies
+        t = Task(self.tw, description="test task")
+        dependency = Task(self.tw, description="needs to be done first")
+
+        dependency.save()
+
+        t['depends'].add(dependency)
+        t.save()
+
+        self.assertEqual(t['depends'], set([dependency]))
+
     def test_simple_dependency_set_save_repeatedly(self):
         # Adds only one dependency to task with no dependencies
         t = Task(self.tw, description="test task")
@@ -413,6 +427,76 @@ class TaskTest(TasklibTest):
             self.assertRaises(RuntimeError,
                               lambda: t.__setitem__(readonly_key, 'value'))
 
+    def test_saving_unmodified_task(self):
+        t = Task(self.tw, description="test task")
+        t.save()
+        t.save()
+
+    def test_adding_tag_by_appending(self):
+        t = Task(self.tw, description="test task", tags=['test1'])
+        t.save()
+        t['tags'].append('test2')
+        t.save()
+        self.assertEqual(t['tags'], ['test1', 'test2'])
+
+    def test_adding_tag_by_appending_empty(self):
+        t = Task(self.tw, description="test task")
+        t.save()
+        t['tags'].append('test')
+        t.save()
+        self.assertEqual(t['tags'], ['test'])
+
+
+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)
+        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)
+        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=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 AnnotationTest(TasklibTest):
 
@@ -447,6 +531,14 @@ class AnnotationTest(TasklibTest):
         task.remove_annotation(ann)
         self.assertEqual(len(task['annotations']), 0)
 
+    def test_annotation_after_modification(self):
+         task = self.tw.tasks.get()
+         task['project'] = 'test'
+         task.add_annotation('I should really do this task')
+         self.assertEqual(task['project'], 'test')
+         task.save()
+         self.assertEqual(task['project'], 'test')
+
 
 class UnicodeTest(TasklibTest):