CMR-10313: updating PR requests.

Author: eereiter

subscription/notify-lambda/build.sh

@@ -1,6 +1,5 @@
-# This script is used by the bamboo build project.
-
 #!/bin/bash
+# This script is used by the bamboo build project.
 
 mkdir -p package
 

subscription/notify-lambda/run-tests-cicd.sh

@@ -1,7 +1,6 @@
 #!/bin/bash
 
 export PYTHONPATH=src
-#export AWS_REGION="us-east-1"
 
 pip3 install requests
 python3 -m unittest discover -v -s ./test -p "*_test.py"

subscription/notify-lambda/src/notification_lambda.py

@@ -2,21 +2,22 @@
 import requests
 from logger import logger
 
-# This lambda is triggered through a subscription to the cmr-internal-subscription-sit SNS topic. It processes the events which are notifications that get sent
+# This lambda is triggered through a subscription to the cmr-internal-subscription-<env> SNS topic. It processes the events which are notifications that get sent
 # to an external URL.
 
-# Lambda's cannot handle Type hints in some cases. They are left as comments.
-# handler(event: Dict[str, Any], context: Any) -> None:
 def handler(event, context):
-    """The handler is the starting point that is triggered by an SNS topic subscription with a filter that designates tha the notification sent is a URL notification. """
+    """The handler is the starting point that is triggered by an SNS topic subscription with a filter that designates tha the notification sent is a URL notification.
+       Input: event: Dict[str, Any], context: Any
+       Returns: None"""
 
     logger.debug(f"Ingest notification lambda received event: {json.dumps(event, indent=2)}")
     for record in event['Records']:
         process_message(record)
 
-# process_message(record: Dict[str, Any]) ->None:
 def process_message(record):
-    """Processes the record in the event. """
+    """Processes the record in the event.
+       Input: record: Dict[str, Any]
+       Returns: None"""
 
     try:
         logger.info(f"Ingest notification lambda processing message - record: {record}")
@@ -29,9 +30,11 @@ def process_message(record):
         logger.error(f"Ingest notification lambda an error occurred {e} while trying to send the record: {record}")
         raise e
 
-# send_message(url: str, message: Dict[str, Any]) -> None:
 def send_message(url, message):
-    """Sends the passed message to the external URL. If not successful the message is put onto a dead letter queue."""
+    """Sends the passed message to the external URL. If not successful the message is put onto a dead letter queue.
+       Input: url: str, message: Dict[str, Any]
+       Returns: None"""
+
     # Prepare the data to be sent
 
     try:

subscription/notify-test-lambda/README.md

@@ -3,9 +3,9 @@ This lambda is a test lambda meant to be run in SIT and WL.
 A user creates an ingest granule subscription. An example follows:
 {"Name": "Ingest-Subscription-Test-Sit-http",
  "Type": "granule",
- "SubscriberId": "eereiter",
+ "SubscriberId": "user1",
  "CollectionConceptId": "C1200463968-CMR_ONLY",
- "EndPoint": "http://internal-cmr-services-sit-internal-only-2141831226.us-east-1.elb.amazonaws.com:80/notification/tester",
+ "EndPoint": "http://<the-internal-loadbalancer-url>/notification/tester",
  "Mode": ["New", "Update", "Delete"],
  "Method": "ingest",
  "MetadataSpecification": {
@@ -19,8 +19,8 @@ Make sure the URL is the CMR internal load balancer followed by /notification/te
 
 Ingest a granule. 
 
-To verify that the notification is correct and that it was sent tunnel into the CMR internal load balancer
-then issue a get request to the load balancer with the correct tunnel port number such as
+To verify that the notification is correct and that it was sent through the tunnel into the CMR internal load balancer,
+issue a get request to the load balancer with the correct tunnel port number such as
 
 curl http://localhost:8081/notification/tester
 
@@ -33,20 +33,20 @@ curl -XPOST -H "Content-Type: application/json" http://localhost:8081/notificati
     {
       "EventSource": "aws:sns",
       "EventVersion": "1.0",
-      "EventSubscriptionArn": "arn:aws:sns:us-east-1:832706493240:cmr-subscriptions-sit:1f071817-9e7b-450e-b5a5-606bef7c5b71",
+      "EventSubscriptionArn": "arn:aws:sns:<region>:<account>:<SNS name>:<unique ID>",
       "Sns": {
         "Type": "Notification",
         "MessageId": "ed8c7ee0-c70a-5050-8ef9-1effe57d3dde",
-        "TopicArn": "arn:aws:sns:us-east-1:832706493240:cmr-subscriptions-sit",
+        "TopicArn": "arn:aws:sns:<region>:<account>:<sns name>",
         "Subject": "testing again",
         "Message": "testing again",
         "Timestamp": "2025-02-06T20:48:55.564Z",
         "SignatureVersion": "1",
-        "Signature": "iNvFhB7SvB2Um4xkJ4czhaDtQ9WMr3VWz91j9aBJclHQOSR1vznwdT6pJLJOj1fUA/C9JatNEnouUiPut+8DACZ8pVXfMw5bvHoyci63Y7z5gcmVIHpEMetn1Ms7SpgnuddrIoKpCN/tAQGrEfmzDlMbTXjRWrXpEs8xXsJ+Xq2Mp17FoMU00/JV/eAP8ktHX7TtS+dBGLsPd/QPY3eN5QYcmYAcoFd99Va4Qt6dMqOoH/fjIs1aCwnmD02MSnbjCWOgNSteZChnVAT/+l26krKoidHSop53guPt5KWNBGXTSy4Ouhq630qourN+AiVbKqzUtVypNTXas7iBEoT5Nw==",
-        "SigningCertUrl": "https://sns.us-east-1.amazonaws.com/SimpleNotificationService-9c6465fa7f48f5cacd23014631ec1136.pem",
-        "UnsubscribeUrl": "https://sns.us-east-1.amazonaws.com/?Action=Unsubscribe&SubscriptionArn=arn:aws:sns:us-east-1:832706493240:cmr-subscriptions-sit:1f071817-9e7b-450e-b5a5-606bef7c5b71",
+        "Signature": "iN...TXas7iBEoT5Nw==",
+        "SigningCertUrl": "https://sns.<region>.amazonaws.com/SimpleNotificationService-9...6.pem",
+        "UnsubscribeUrl": "https://sns.<region>.amazonaws.com/?Action=Unsubscribe&SubscriptionArn=<subscription arn>",
         "MessageAttributes": {
-          "endpoint": "http://host.docker.internal:5001/store"
+          "endpoint": "URL"
         }
       }
     }

subscription/notify-test-lambda/requirements.txt

@@ -1 +1,2 @@
 boto3
+

subscription/notify-test-lambda/src/notify-test-lambda.py

@@ -1,11 +1,12 @@
 import json
 import boto3
 from botocore.exceptions import ClientError
+from sys import stdout
 
 # This lambda is to be used in SIT and WL to test the ingest subscription notification process.
 # This is a test lambda that gets triggered off of the interal CMR load balancer.
 # It receives a notification generated by the ingest notification lambda. 
-# The notification is stored in a file in an S3 bucket. Ussers can tunnel into the CMR internal only 
+# The notification is stored in a file in an S3 bucket. Users can tunnel into the CMR internal only 
 # load balancer and run curl http://localhost:8081/notification/tester.  Make sure to use the correct port number
 # that you used in your tunnel.
 
@@ -55,6 +56,7 @@ def handle_post(body):
         }
     except Exception as e:
         print(f"Error in POST: {str(e)}")
+        stdout.flush()
         return {
             'statusCode': 500,
             'body': json.dumps('Error saving data')
@@ -79,6 +81,7 @@ def handle_get():
             }
         else:
             print(f"Error in GET: {str(e)}")
+            stdout.flush()
             return {
                 'statusCode': 500,
                 'body': json.dumps('Error retrieving data')