CP-9044/api-key-as-environment-variable: Added tests to cover file and environment set api keys

ericvautour-quandl · ericvautour-quandl · commit 2ef1aeebcbc0 · 2021-12-07T11:58:47.000-05:00
diff --git a/nasdaqdatalink/api_config.py b/nasdaqdatalink/api_config.py
@@ -38,9 +38,11 @@ def default_config_filename():
     return os.path.expanduser(config_file)
 
 
-def default_config_file_exists():
-    config_filename = default_config_filename()
-    return os.path.isfile(config_filename)
+def config_file_exists(filename=None):
+    if filename is None:
+        filename = default_config_filename()
+
+    return os.path.isfile(filename)
 
 
 def save_key(apikey, filename=None):
@@ -85,5 +87,5 @@ def read_key_from_environment_variable():
 def read_key(filename=None):
     if api_key_environment_variable_exists():
         read_key_from_environment_variable()
-    elif default_config_file_exists():
+    elif config_file_exists(filename):
         read_key_from_file(filename)
diff --git a/test/test_api_config.py b/test/test_api_config.py
@@ -8,37 +8,69 @@
   os.path.dirname(os.path.realpath(__file__)), ".nasdaq-config", "testkeyfile"
 )
 
-
-class ApiConfigTest(TestCase):
-    @mock.patch.dict(os.environ, {"NASDAQ_DATA_LINK_API_KEY": "setinenv"})
-    def test_read_key_when_environment_variable_set(self):
-        ApiConfig.api_key = None
-        read_key()
-        self.assertEqual(ApiConfig.api_key, "setinenv")
-        del os.environ['NASDAQ_DATA_LINK_API_KEY']
+TEST_DEFAULT_FILE = os.path.join(
+  os.path.dirname(os.path.realpath(__file__)), ".nasdaq-config", "defaultkeyfile"
+)
 
 
-    def test_read_key_when_environment_variable_not_set(self):
+class ApiConfigTest(TestCase):
+    def setUp(self):
         if not os.path.exists(os.path.dirname(TEST_KEY_FILE)):
             try:
                 os.makedirs(os.path.dirname(TEST_KEY_FILE))
             except OSError as exc: # Guard against race condition
                 if exc.errno != errno.EEXIST:
                     raise
 
-        ApiConfig.api_key = None
-        save_key("keyforfile", TEST_KEY_FILE)
-        read_key(TEST_KEY_FILE)
-        self.assertEqual(ApiConfig.api_key, 'keyforfile')
+    def tearDown(self):
+        if NASDAQ_DATA_LINK_API_KEY in os.environ:
+            del os.environ['NASDAQ_DATA_LINK_API_KEY']
+
         if os.path.exists(TEST_KEY_FILE):
             os.remove(TEST_KEY_FILE)
 
+        if os.path.exists(TEST_DEFAULT_FILE):
+            os.remove(TEST_DEFAULT_FILE)
 
 
-    def test_read_key_when_file_not_set(self):
-        if os.path.exists(TEST_KEY_FILE):
-            os.remove(TEST_KEY_FILE)
+    def test_read_key_when_environment_variable_set(self):
+        os.environ['NASDAQ_DATA_LINK_API_KEY'] = 'setinenv'
+        ApiConfig.api_key = None
+        read_key()
+        self.assertEqual(ApiConfig.api_key, "setinenv")
+
 
+    def test_read_key_environment_variable_takes_precedence(self):
+        os.environ['NASDAQ_DATA_LINK_API_KEY'] = 'setinenvprecedence'
+        save_key("keyforfilenot", TEST_KEY_FILE)
         ApiConfig.api_key = None
         read_key()
+        self.assertEqual(ApiConfig.api_key, "setinenvprecedence")
+
+
+    def test_read_key_when_environment_variable_not_set(self):
+        save_key("keyforfile", TEST_KEY_FILE)
+        ApiConfig.api_key = None # Set None, we are not testing save_key
+        read_key(TEST_KEY_FILE)
+        self.assertEqual(ApiConfig.api_key, 'keyforfile')
+
+
+    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:
+             mock_default_config_filename.return_value = TEST_DEFAULT_FILE
+             read_key()
+
+        mock_default_config_filename.assert_called_once
         self.assertEqual(ApiConfig.api_key, None)
+
+
+    def test_read_key_when_default_file_set(self):
+        save_key("keyfordefaultfile", TEST_DEFAULT_FILE)
+        ApiConfig.api_key = None # Set None, we are not testing save_key
+
+        with mock.patch("nasdaqdatalink.api_config.default_config_filename") as mock_default_config_filename:
+             mock_default_config_filename.return_value = TEST_DEFAULT_FILE
+             read_key()
+
+        self.assertEqual(ApiConfig.api_key, 'keyfordefaultfile')
