Add list variables to config_helper

Author: aaronfriedman6

.python-version

@@ -0,0 +1 @@
+3.9.16

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
-## v1.1.0
+## v1.1.2
+- Update config_helper to accept list environment variables
+
+## v1.1.0/v1.1.1
 - Add retries for empty responses in oauth2 client. This was added to address a known quirk in the Sierra API where this response is returned:
 ```
 > GET / HTTP/1.1
@@ -8,6 +11,7 @@
 > Accept: */*
 > 
 ```
+- Due to an accidental deployment, v1.1.0 and v1.1.1 were both released but are identical
 
 ## v1.0.4 - 6/28/23
 - Enforce Kinesis stream 1000 records/second write limit

README.md

@@ -35,19 +35,19 @@ kinesis_client = KinesisClient(...)
 # Do not use any version below 1.0.0
 # All available optional dependencies can be found in pyproject.toml.
 # See the "Managing dependencies" section below for more details.
-nypl-py-utils[kinesis-client,config-helper]==1.0.4
+nypl-py-utils[kinesis-client,config-helper]==1.1.2
 ```
 
 ## Developing locally
 In order to use the local version of the package instead of the global version, use a virtual environment. To set up a virtual environment and install all the necessary dependencies, run:
 
 ```
-python3 -m venv testenv
-source testenv/bin/activate
+python3 -m venv .venv
+source .venv/bin/activate
 pip install --upgrade pip
 pip install .
 pip install '.[development]'
-deactivate && source testenv/bin/activate
+deactivate && source .venv/bin/activate
 ```
 
 ## Managing dependencies
@@ -61,7 +61,7 @@ The optional dependency sets also give the developer the option to manually list
 #### Using PostgreSQLClient in an AWS Lambda
 Because `psycopg` requires a statically linked version of the `libpq` library, the `PostgreSQLClient` cannot be installed as-is in an AWS Lambda function. Instead, it must be packaged as follows:
 ```bash
-pip install --target ./package nypl-py-utils[postgresql-client]==1.0.1
+pip install --target ./package nypl-py-utils[postgresql-client]==1.1.2
 
 pip install \
     --platform manylinux2014_x86_64 \

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "nypl_py_utils"
-version = "1.0.4"
+version = "1.1.2"
 authors = [
   { name="Aaron Friedman", email="aaronfriedman@nypl.org" },
 ]

src/nypl_py_utils/functions/config_helper.py

@@ -1,3 +1,4 @@
+import json
 import os
 import yaml
 
@@ -11,7 +12,8 @@ def load_env_file(run_type, file_string):
     """
     This method loads a YAML config file containing environment variables,
     decrypts whichever are encrypted, and puts them all into os.environ as
-    strings.
+    strings. For a YAML variable containing a list of values, the list is
+    exported into os.environ as a json string and should be loaded as such.
 
     It requires the YAML file to be split into a 'PLAINTEXT_VARIABLES' section
     and an 'ENCRYPTED_VARIABLES' section.
@@ -43,11 +45,18 @@ def load_env_file(run_type, file_string):
 
     if env_dict:
         for key, value in env_dict.get('PLAINTEXT_VARIABLES', {}).items():
-            os.environ[key] = str(value)
+            if type(value) is list:
+                os.environ[key] = json.dumps(value)
+            else:
+                os.environ[key] = str(value)
 
         kms_client = KmsClient()
         for key, value in env_dict.get('ENCRYPTED_VARIABLES', {}).items():
-            os.environ[key] = kms_client.decrypt(value)
+            if type(value) is list:
+                decrypted_list = [kms_client.decrypt(v) for v in value]
+                os.environ[key] = json.dumps(decrypted_list)
+            else:
+                os.environ[key] = kms_client.decrypt(value)
         kms_client.close()
 
 

tests/test_config_helper.py

@@ -4,16 +4,24 @@
 from nypl_py_utils.functions.config_helper import (
     load_env_file, ConfigHelperError)
 
-_TEST_VARIABLE_NAMES = ['TEST_STRING', 'TEST_INT', 'TEST_ENCRYPTED_VARIABLE_1',
-                        'TEST_ENCRYPTED_VARIABLE_2']
+_TEST_VARIABLE_NAMES = [
+    'TEST_STRING', 'TEST_INT', 'TEST_LIST', 'TEST_ENCRYPTED_VARIABLE_1',
+    'TEST_ENCRYPTED_VARIABLE_2', 'TEST_ENCRYPTED_LIST']
+
 _TEST_CONFIG_CONTENTS = \
     '''---
 PLAINTEXT_VARIABLES:
     TEST_STRING: string-variable
     TEST_INT: 1
+    TEST_LIST:
+        - string-var
+        - 2
 ENCRYPTED_VARIABLES:
     TEST_ENCRYPTED_VARIABLE_1: test-encryption-1
     TEST_ENCRYPTED_VARIABLE_2: test-encryption-2
+    TEST_ENCRYPTED_LIST:
+        - test-encryption-3
+        - test-encryption-4
 ...'''
 
 
@@ -22,7 +30,8 @@ class TestConfigHelper:
     def test_load_env_file(self, mocker):
         mock_kms_client = mocker.MagicMock()
         mock_kms_client.decrypt.side_effect = [
-            'test-decryption-1', 'test-decryption-2']
+            'test-decryption-1', 'test-decryption-2', 'test-decryption-3',
+            'test-decryption-4']
         mocker.patch('nypl_py_utils.functions.config_helper.KmsClient',
                      return_value=mock_kms_client)
         mock_file_open = mocker.patch(
@@ -34,13 +43,17 @@ def test_load_env_file(self, mocker):
 
         mock_file_open.assert_called_once_with('test-path/test-env.yaml', 'r')
         mock_kms_client.decrypt.assert_has_calls([
-            mocker.call('test-encryption-1'), mocker.call('test-encryption-2')]
+            mocker.call('test-encryption-1'), mocker.call('test-encryption-2'),
+            mocker.call('test-encryption-3'), mocker.call('test-encryption-4')]
         )
         mock_kms_client.close.assert_called_once()
         assert os.environ['TEST_STRING'] == 'string-variable'
         assert os.environ['TEST_INT'] == '1'
+        assert os.environ['TEST_LIST'] == '["string-var", 2]'
         assert os.environ['TEST_ENCRYPTED_VARIABLE_1'] == 'test-decryption-1'
         assert os.environ['TEST_ENCRYPTED_VARIABLE_2'] == 'test-decryption-2'
+        assert os.environ['TEST_ENCRYPTED_LIST'] == \
+            '["test-decryption-3", "test-decryption-4"]'
 
         for key in _TEST_VARIABLE_NAMES:
             if key in os.environ: