AWS region refactoring

* Make AWS region a CLI option and update the appropriate classes to take it as an argument
* Update the corresponding unit tests

* https://mitlibraries.atlassian.net/browse/DLSPP-130

awd/cli.py

@@ -40,6 +40,12 @@ def doi_to_be_retried(doi, doi_items):
 
 
 @click.group()
+@click.option(
+    "--aws_region",
+    required=True,
+    default=config.AWS_REGION_NAME,
+    help="The AWS region to use for clients.",
+)
 @click.option(
     "--doi_table",
     required=True,
@@ -68,11 +74,12 @@ def doi_to_be_retried(doi, doi_items):
     "--log_recipient_email",
     required=True,
     default=config.LOG_RECIPIENT_EMAIL,
-    help="The email address receiving the logs. Repeatable",
+    help="The email address receiving the logs.",
 )
 @click.pass_context
 def cli(
     ctx,
+    aws_region,
     doi_table,
     sqs_base_url,
     sqs_output_queue,
@@ -87,6 +94,7 @@ def cli(
     )
     ctx.ensure_object(dict)
     ctx.obj["stream"] = stream
+    ctx.obj["aws_region"] = aws_region
     ctx.obj["doi_table"] = doi_table
     ctx.obj["sqs_base_url"] = sqs_base_url
     ctx.obj["sqs_output_queue"] = sqs_output_queue
@@ -137,8 +145,8 @@ def deposit(
     date = datetime.today().strftime("%m-%d-%Y %H:%M:%S")
     stream = ctx.obj["stream"]
     s3_client = s3.S3()
-    sqs_client = sqs.SQS()
-    dynamodb_client = dynamodb.DynamoDB()
+    sqs_client = sqs.SQS(ctx.obj["aws_region"])
+    dynamodb_client = dynamodb.DynamoDB(ctx.obj["aws_region"])
 
     try:
         s3_client.client.list_objects_v2(Bucket=bucket)
@@ -223,7 +231,7 @@ def deposit(
         s3_client.archive_file_with_new_key(bucket, doi_file, "archived")
     logger.debug("Submission process has completed")
 
-    ses_client = ses.SES()
+    ses_client = ses.SES(ctx.obj["aws_region"])
     message = ses_client.create_email(
         f"Automated Wiley deposit errors {date}",
         stream.getvalue(),
@@ -254,8 +262,8 @@ def listen(
 ):
     date = datetime.today().strftime("%m-%d-%Y %H:%M:%S")
     stream = ctx.obj["stream"]
-    sqs = SQS()
-    dynamodb_client = DynamoDB()
+    sqs = SQS(ctx.obj["aws_region"])
+    dynamodb_client = DynamoDB(ctx.obj["aws_region"])
     try:
         for message in sqs.receive(
             ctx.obj["sqs_base_url"], ctx.obj["sqs_output_queue"]
@@ -298,7 +306,7 @@ def listen(
         logger.error(
             f"Failure while retrieving SQS messages, {e.response['Error']['Message']}"
         )
-    ses_client = SES()
+    ses_client = SES(ctx.obj["aws_region"])
     message = ses_client.create_email(
         f"DSS results {date}",
         stream.getvalue(),

awd/config.py

@@ -13,7 +13,7 @@
 AWS_REGION_NAME = "us-east-1"
 
 if ENV == "stage" or ENV == "prod":
-    ssm = SSM()
+    ssm = SSM(AWS_REGION_NAME)
     DOI_TABLE = ssm.get_parameter_value(f"{WILEY_SSM_PATH}dynamodb_table_name")
     METADATA_URL = ssm.get_parameter_value(f"{WILEY_SSM_PATH}wiley_metadata_url")
     CONTENT_URL = ssm.get_parameter_value(f"{WILEY_SSM_PATH}wiley_content_url")

awd/dynamodb.py

@@ -11,10 +11,10 @@
 class DynamoDB:
     """An DynamoDB class that provides a generic boto3 DynamoDB client."""
 
-    def __init__(self):
+    def __init__(self, region):
         self.client = boto3.client(
             "dynamodb",
-            region_name="us-east-1",
+            region_name=region,
         )
 
     def add_doi_item_to_database(self, doi_table, doi):

awd/ses.py

@@ -10,8 +10,8 @@
 class SES:
     """An SES class that provides a generic boto3 SES client."""
 
-    def __init__(self):
-        self.client = client("ses", region_name="us-east-1")
+    def __init__(self, region):
+        self.client = client("ses", region_name=region)
 
     def check_permissions(self, source_email_address, recipient_email_address):
         """Verify that an email can be sent from the specified email address"""

awd/sqs.py

@@ -9,8 +9,8 @@
 class SQS:
     """An SQS class that provides a generic boto3 SQS client."""
 
-    def __init__(self):
-        self.client = client("sqs", region_name="us-east-1")
+    def __init__(self, region):
+        self.client = client("sqs", region_name=region)
 
     def check_read_permissions(self, sqs_base_url, queue_name):
         """Verify that messages can be received from the specified queue."""

awd/ssm.py

@@ -8,8 +8,8 @@ class SSM:
     still used by boto3. This service contains Parameter Store, which is using for
     storing values that can be retrieved via an SSM client."""
 
-    def __init__(self):
-        self.client = client("ssm", region_name="us-east-1")
+    def __init__(self, region):
+        self.client = client("ssm", region_name=region)
 
     def check_permissions(self, ssm_path):
         """Check whether we can retrieve an encrypted ssm parameter.

tests/conftest.py

@@ -7,6 +7,7 @@
 from click.testing import CliRunner
 from moto import mock_dynamodb2, mock_iam, mock_s3, mock_ses, mock_sqs, mock_ssm
 
+from awd import config
 from awd.dynamodb import DynamoDB
 from awd.s3 import S3
 from awd.ses import SES
@@ -65,7 +66,7 @@ def test_aws_user(aws_credentials):
 
 @pytest.fixture(scope="function")
 def dynamodb_class():
-    return DynamoDB()
+    return DynamoDB(config.AWS_REGION_NAME)
 
 
 @pytest.fixture(scope="function")
@@ -75,17 +76,17 @@ def s3_class():
 
 @pytest.fixture(scope="function")
 def ses_class():
-    return SES()
+    return SES(config.AWS_REGION_NAME)
 
 
 @pytest.fixture(scope="function")
 def sqs_class():
-    return SQS()
+    return SQS(config.AWS_REGION_NAME)
 
 
 @pytest.fixture(scope="function")
 def ssm_class():
-    return SSM()
+    return SSM(config.AWS_REGION_NAME)
 
 
 @pytest.fixture(scope="function")

tests/test_ses.py

@@ -6,7 +6,7 @@
 from botocore.exceptions import ClientError
 from moto.core import set_initial_no_auth_action_count
 
-from awd import ses
+from awd import config, ses
 
 
 def test_check_permissions_success(mocked_ses, ses_class):
@@ -23,7 +23,7 @@ def test_check_permissions_raises_error_if_address_not_verified(
     os.environ["AWS_ACCESS_KEY_ID"] = test_aws_user["AccessKeyId"]
     os.environ["AWS_SECRET_ACCESS_KEY"] = test_aws_user["SecretAccessKey"]
     boto3.setup_default_session()
-    ses_class = ses.SES()
+    ses_class = ses.SES(config.AWS_REGION_NAME)
     with pytest.raises(ClientError) as e:
         ses_class.check_permissions("noreply@example.com", "mock@mock.mock")
     assert e.value.response["Error"]["Message"] == (

tests/test_sqs.py

@@ -5,7 +5,7 @@
 from botocore.exceptions import ClientError
 from moto.core import set_initial_no_auth_action_count
 
-from awd import sqs
+from awd import config, sqs
 
 
 def test_check_read_permissions_success(
@@ -43,7 +43,7 @@ def test_check_read_permissions_raises_error_if_no_permission(
     os.environ["AWS_ACCESS_KEY_ID"] = test_aws_user["AccessKeyId"]
     os.environ["AWS_SECRET_ACCESS_KEY"] = test_aws_user["SecretAccessKey"]
     boto3.setup_default_session()
-    sqs_class = sqs.SQS()
+    sqs_class = sqs.SQS(config.AWS_REGION_NAME)
     with pytest.raises(ClientError) as e:
         sqs_class.check_read_permissions(
             "https://queue.amazonaws.com/123456789012/", "mock-output-queue"
@@ -88,7 +88,7 @@ def test_check_write_permissions_raises_error_if_no_permission(
     os.environ["AWS_ACCESS_KEY_ID"] = test_aws_user["AccessKeyId"]
     os.environ["AWS_SECRET_ACCESS_KEY"] = test_aws_user["SecretAccessKey"]
     boto3.setup_default_session()
-    sqs_class = sqs.SQS()
+    sqs_class = sqs.SQS(config.AWS_REGION_NAME)
     with pytest.raises(ClientError) as e:
         sqs_class.check_write_permissions(
             "https://queue.amazonaws.com/123456789012/", "empty_input_queue"