api_config: raise errors for mis-configured environment variable

It is possible users could define an environment variable but not set it. Help users avoid shooting themselves in the foot by raising an exception when it is determine callers have: defined the NASDAQ_DATA_LINK_API_KEY; and it is considered empty Signed-off-by: Jamie Couture <[email protected]>
bdelacruz3 · Jan 28, 2022 · a478f5c · a478f5c
1 parent 22325ad
commit a478f5c
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 1 deletion.
diff --git a/nasdaqdatalink/api_config.py b/nasdaqdatalink/api_config.py
@@ -60,6 +60,10 @@ def raise_empty_file(config_filename):
     raise ValueError("File '{:s}' is empty.".format(config_filename))
 
 
+def raise_empty_environment_variable():
+    raise ValueError("NASDAQ_DATA_LINK_API_KEY cannot be empty")
+
+
 def get_first_non_empty(file_handle):
     lines = [line.strip() for line in file_handle.readlines()]
     return next((line for line in lines if line), None)
@@ -86,7 +90,11 @@ def api_key_environment_variable_exists():
 
 
 def read_key_from_environment_variable():
-    ApiConfig.api_key = os.environ.get(NASDAQ_DATA_LINK_API_KEY)
+    apikey = os.environ.get(NASDAQ_DATA_LINK_API_KEY)
+    if not apikey:
+        raise_empty_environment_variable()
+
+    ApiConfig.api_key = apikey
 
 
 def read_key(filename=None):

diff --git a/test/test_api_config.py b/test/test_api_config.py
@@ -65,6 +65,12 @@ def test_read_key_empty_file(self):
                 read_key()
 
 
+    def test_read_key_when_env_key_empty(self):
+        os.environ['NASDAQ_DATA_LINK_API_KEY'] = ''
+        with self.assertRaises(ValueError):
+            read_key()
+
+
     def test_read_key_when_files_not_set(self):
         ApiConfig.api_key = None
         with mock.patch("nasdaqdatalink.api_config.default_config_filename") as mock_default_config_filename: