chore: update contracts, tests and linting errors.

Author: tjholm

contracts

@@ -59,7 +59,7 @@ def publish(
             payload = {}
         payload_struct = Struct()
         payload_struct.update(payload)
-        nitric_event = NitricEvent(id=event_id, payloadType=payload_type, payload=payload_struct)
+        nitric_event = NitricEvent(id=event_id, payload_type=payload_type, payload=payload_struct)
         request = event_model.EventPublishRequest(topic=topic_name, event=nitric_event)
         self._exec("Publish", request)
         return event_id

nitric/api/event.py

@@ -59,7 +59,7 @@ def _task_to_wire(self, task: Task) -> queue.NitricTask:
 
         return queue.NitricTask(
             id=task.task_id,
-            payloadType=task.payload_type,
+            payload_type=task.payload_type,
             payload=payload_struct,
         )
 
@@ -72,9 +72,9 @@ def _wire_to_task(self, task: queue.NitricTask) -> Task:
         """
         return Task(
             task_id=task.id,
-            payload_type=task.payloadType,
+            payload_type=task.payload_type,
             payload=MessageToDict(task.payload),
-            lease_id=task.leaseId,
+            lease_id=task.lease_id,
         )
 
     def _wire_to_failed_task(self, failed_task: queue.FailedTask) -> FailedTask:

nitric/api/queue.py

@@ -42,7 +42,7 @@ def write(self, bucket_name: str, key: str, body: bytes):
         :param body: data to be stored.
         :return: storage result.
         """
-        request = storage.StorageWriteRequest(bucketName=bucket_name, key=key, body=body)
+        request = storage.StorageWriteRequest(bucket_name=bucket_name, key=key, body=body)
         response = self._exec("Write", request)
         return response
 
@@ -54,6 +54,6 @@ def read(self, bucket_name: str, key: str) -> bytes:
         :param key: key for the file to retrieve.
         :return: the file as bytes.
         """
-        request = storage.StorageReadRequest(bucketName=bucket_name, key=key)
+        request = storage.StorageReadRequest(bucket_name=bucket_name, key=key)
         response = self._exec("Read", request)
         return response.body

nitric/api/storage.py

@@ -22,40 +22,73 @@
 
 
 class TopicResponseContext(object):
+    """Response context for triggers raised by a topic event."""
+
     def __init__(self, success: bool = True):
+        """Create a Topic response context."""
         self.success = success
 
     def to_grpc_topic_response_context(self) -> faas_pb2.TopicResponseContext:
+        """Translate a topic response context for wire transport."""
         return faas_pb2.TopicResponseContext(success=self.success)
 
 
 class HttpResponseContext(object):
-    def __init__(self, headers: Dict[str, str] = {}, status: int = 200):
-        self.headers = headers
+    """Response context for triggers raised by a HTTP request."""
+
+    def __init__(self, headers: Dict[str, str] = None, status: int = 200):
+        """Create a HTTP response context."""
+        if headers is None:
+            self.headers = {}
+        else:
+            self.headers = headers
         self.status = status
 
     def to_grpc_http_response_context(self) -> faas_pb2.HttpResponseContext:
+        """Translate a HTTP response context for on wire transport."""
         return faas_pb2.HttpResponseContext(headers=self.headers, status=self.status)
 
 
 class ResponseContext(object):
+    """Wrapper for typed response context for triggers."""
+
     def __init__(self, context: Union[TopicResponseContext, HttpResponseContext]):
+        """Create a new response context wrapper."""
         self.context = context
 
     def is_http(self):
+        """
+        Determine if response is for a HTTP request.
+
+        :return true if context is for a HTTP request.
+        """
         return isinstance(self.context, HttpResponseContext)
 
     def is_topic(self):
+        """
+        Determine if response is for an event raised by a topic.
+
+        :return true if context is for a topic event.
+        """
         return isinstance(self.context, TopicResponseContext)
 
     def as_http(self) -> Union[HttpResponseContext, None]:
+        """
+        Unwraps response context as Http response context.
+
+        :return HttpResponseContext if is_http is true otherwise return None
+        """
         if not self.is_http():
             return None
 
         return self.context
 
     def as_topic(self) -> Union[TopicResponseContext, None]:
-        """Determine is ResponseContext is for a topic"""
+        """
+        Unwraps response context as Topic response context.
+
+        :return TopicResponseContext if is_topic is true otherwise return None
+        """
         if not self.is_topic():
             return None
 
@@ -76,8 +109,7 @@ def __init__(
         self.data = data
 
     def to_grpc_trigger_response_context(self) -> TriggerResponse:
-        """Translate a response object ready for on the wire transport"""
-
+        """Translate a response object ready for on the wire transport."""
         response = TriggerResponse(data=self.data)
 
         if self.context.is_http():

nitric/faas/response.py

@@ -24,7 +24,7 @@
 
 
 class HttpTriggerContext(object):
-    """Represents Trigger metadata from a HTTP subscription"""
+    """Represents Trigger metadata from a HTTP subscription."""
 
     def __init__(
         self,
@@ -33,16 +33,18 @@ def __init__(
         headers: typing.Dict[str, str],
         query_params: typing.Dict[str, str],
     ):
+        """Create a Http trigger context."""
         self.method = method
         self.path = path
         self.headers = headers
         self.query_params = query_params
 
 
 class TopicTriggerContext(object):
-    """Represents Trigger metadata from a topic subscription"""
+    """Represents Trigger metadata from a topic subscription."""
 
     def __init__(self, topic: str):
+        """Create a Topic trigger context."""
         self.topic = topic
 
 
@@ -54,25 +56,50 @@ def __init__(self, context: typing.Union[TopicTriggerContext, HttpTriggerContext
         self.context = context
 
     def is_http(self) -> bool:
+        """
+        Determine if trigger was raised by a http request.
+
+        :return true if trigger was raised by a HTTP request
+        """
         return isinstance(self.context, HttpTriggerContext)
 
     def as_http(self) -> typing.Union[HttpTriggerContext, None]:
+        """
+        Unwrap HttpTriggerContext.
+
+        :return HttpTriggerContext if is_http is true otherwise None
+        """
         if not self.is_http():
             return None
 
         return self.context
 
     def is_topic(self) -> bool:
+        """
+        Determine if trigger was raised by a topic event.
+
+        :return true if trigger is for a topic event
+        """
         return isinstance(self.context, TriggerContext)
 
     def as_topic(self) -> typing.Union[TopicTriggerContext, None]:
+        """
+        Unwrap TopicTriggerContext.
+
+        :return TopicTriggerContext if is_topic is true otherwise None
+        """
         if not self.is_topic():
             return None
 
         return self.context
 
     @staticmethod
     def from_trigger_request(trigger_request: TriggerRequest):
+        """
+        Create a TriggerContext from a gRPC TriggerRequest.
+
+        :return Created TriggerContext
+        """
         if trigger_request.http is not None:
             return TriggerContext(
                 context=HttpTriggerContext(
@@ -120,9 +147,12 @@ def get_object(self) -> dict:
 
     def default_response(self) -> Response:
         """
-        Convenience method to construct a relevant default response
+        Create a relevant default response.
+
         The returned response can be interrogated with its context to determine the appropriate
-        response context e.g. response.context.is_http() or response.context.is_topic()
+        response context e.g. response.context.is_http() or response.context.is_topic().
+
+        :returns Default response for this Trigger
         """
         response_ctx = None
 
@@ -135,6 +165,11 @@ def default_response(self) -> Response:
 
     @staticmethod
     def from_trigger_request(trigger_request: TriggerRequest):
+        """
+        Create a Trigger from a gRPC TriggerRequest.
+
+        :returns Created Trigger
+        """
         context = TriggerContext.from_trigger_request(trigger_request)
 
         return Trigger(context=context, data=trigger_request.data)

nitric/faas/trigger.py

@@ -42,7 +42,7 @@ def test_publish():
     mock_publish.assert_called_once()
     assert mock_publish.call_args[0][0].topic == "topic_name"
     assert mock_publish.call_args[0][0].event.id == "abc-123"
-    assert mock_publish.call_args[0][0].event.payloadType == "payload.type"
+    assert mock_publish.call_args[0][0].event.payload_type == "payload.type"
     assert mock_publish.call_args[0][0].event.payload["content"] == "of event"
 
 

tests/api/test_event_client.py

@@ -38,7 +38,7 @@ def test_push():
     mock_push.assert_called_once()
     assert mock_push.call_args[0][0].queue == "test-queue"
     assert mock_push.call_args[0][0].tasks[0].id == "1234"
-    assert mock_push.call_args[0][0].tasks[0].payloadType == "test-payload"
+    assert mock_push.call_args[0][0].tasks[0].payload_type == "test-payload"
     assert mock_push.call_args[0][0].tasks[0].payload["test"] == "test"
 
 

tests/api/test_queue_client.py

@@ -36,7 +36,7 @@ def test_write():
 
     # Ensure the 'Put' method is called with the expected input
     mock_create.assert_called_once()  # No input data required to get topics
-    assert mock_create.call_args[0][0].bucketName == "bucket_name"
+    assert mock_create.call_args[0][0].bucket_name == "bucket_name"
     assert mock_create.call_args[0][0].key == "key_name"
     assert mock_create.call_args[0][0].body == content
 
@@ -55,7 +55,7 @@ def test_read():
 
     # Ensure the 'Get' method is called with the expected input
     mock_create.assert_called_once()  # No input data required to get topics
-    assert mock_create.call_args[0][0].bucketName == "bucket_name"
+    assert mock_create.call_args[0][0].bucket_name == "bucket_name"
     assert mock_create.call_args[0][0].key == "key_name"
 
 

tests/api/test_storage_client.py

@@ -18,7 +18,7 @@ deps =
     pip-licenses
 commands =
     flake8 nitric
-    black --check nitric tests tools
+    black nitric tests tools
     pydocstyle nitric
     pip-licenses --allow-only="MIT License;BSD License;Zope Public License;Python Software Foundation License;Apache License 2.0;Apache Software License;MIT License, Mozilla Public License 2.0 (MPL 2.0);MIT;BSD License, Apache Software License;3-Clause BSD License;Historical Permission Notice and Disclaimer (HPND);Mozilla Public License 2.0 (MPL 2.0);Apache Software License, BSD License;BSD;Python Software Foundation License, MIT License;Public Domain;Public Domain, Python Software Foundation License, BSD License, GNU General Public License (GPL);GNU Library or Lesser General Public License (LGPL);LGPL;Apache Software License, MIT License" --ignore-packages nitric