Created test and documentation for adding required fields upon workit…

…em creation.

docs/workitem.rst

@@ -16,6 +16,9 @@ A new workitem can be created using :func:`~Project.createWorkitem`.
 
     new_task = project.createWorkitem('changerequest')
 
+    # Add fields to the creation. Needed if there are required fields upon creation.
+    new_task = project..createWorkitem('task', new_workitem_fields={'title': 'New title'})
+
 Updating a field
 ^^^^^^^^^^^^^^^^
 

polarion/workitem.py

@@ -69,7 +69,10 @@ def __init__(self, polarion, project, id=None, uri=None, new_workitem_type=None,
 
             if new_workitem_fields is not None:
                 for new_field in new_workitem_fields:
-                    self._polarion_item[new_field] = new_workitem_fields[new_field]
+                    if new_field in self._polarion_item:
+                        self._polarion_item[new_field] = new_workitem_fields[new_field]
+                    else:
+                        raise Exception(f'{new_field} in new_workitem_fields is not recognised as a workitem field')
 
             # and create it
             new_uri = service.createWorkItem(self._polarion_item)

tests/test_polarion_workitem.py

@@ -35,6 +35,18 @@ def test_create_workitem(self):
         self.assertEqual(executed_workitem, checking_workitem,
                          msg='Workitems not identical')
 
+        # Check that fields can be supplied with the call
+        executed_workitem = self.executing_project.createWorkitem('task', new_workitem_fields={'title': 'Test title!'})
+        checking_workitem = self.checking_project.getWorkitem(
+            executed_workitem.id)
+
+        self.assertEqual(executed_workitem, checking_workitem,
+                         msg='Workitems not identical when created with supplied fields')
+
+        # Check that fields are checks for validity
+        with self.assertRaises(Exception):
+            executed_workitem = self.executing_project.createWorkitem('task', new_workitem_fields={'wrong-field': 'what happens?'})
+
     def test_title_change(self):
         executed_workitem = self.global_workitem
         checking_workitem = self.checking_project.getWorkitem(