Merge pull request #29 from CMSgov/jfuqian/BB2-2080-python-SDK-add-support-for-LOCAL-env

[BB2-2080] Python SDK Add Support for LOCAL and TEST target ENV

Author: James Fuqian

README.md

@@ -120,7 +120,7 @@ There are three ways to configure the SDK when instantiating a `BlueButton` clas
                    "backoff_factor": 5,
                    "status_forcelist": [500, 502, 503, 504]
                }
-            }
+            })
       ```
 ### JSON config file
     - This is using a configuration file that is in a JSON format.

cms_bluebutton/cms_bluebutton.py

@@ -69,12 +69,12 @@ def set_configuration(self, config):
 
         # Check environment setting
         env = config_dict.get("environment", None)
-        if env in ["SANDBOX", "PRODUCTION"]:
+        if env in ["LOCAL", "TEST", "SANDBOX", "PRODUCTION"]:
             self.base_url = ENVIRONMENT_URLS.get(env, None)
         else:
             raise ValueError(
                 "Error: Configuration environment must be set to"
-                " SANDBOX or PRODUCTION in: {}".format(config)
+                " LOCAL or TEST or SANDBOX or PRODUCTION in: {}".format(config)
             )
 
         # Check other settings are provided

cms_bluebutton/constants.py

@@ -9,6 +9,8 @@
 REFRESH_TOKEN_ENDPOINT = "/o/token/"
 
 ENVIRONMENT_URLS = {
+    "LOCAL": "http://localhost:8000",
+    "TEST": "https://test.bluebutton.cms.gov",
     "SANDBOX": "https://sandbox.bluebutton.cms.gov",
     "PRODUCTION": "https://api.bluebutton.cms.gov",
 }

cms_bluebutton/tests/test_configs.py

@@ -27,6 +27,22 @@ def test_read_config_json_equals_yaml():
 
 
 def test_valid_config():
+    # valid config local env
+    bb = BlueButton(config=CONFIGS_DIR + "json/bluebutton-sample-config-valid-local.json")
+    assert bb.base_url == "http://localhost:8000"
+    assert bb.client_id == "<your BB2 client_id here>"
+    assert bb.client_secret == "<your BB2 client_secret here>"
+    assert bb.callback_url == "https://fake-local/your/callback/here"
+    assert bb.version == 1
+
+    # valid config test env
+    bb = BlueButton(config=CONFIGS_DIR + "json/bluebutton-sample-config-valid-test.json")
+    assert bb.base_url == "https://test.bluebutton.cms.gov"
+    assert bb.client_id == "<your BB2 client_id here>"
+    assert bb.client_secret == "<your BB2 client_secret here>"
+    assert bb.callback_url == "https://www.fake-test.com/your/callback/here"
+    assert bb.version == 1
+
     # valid config sbx
     bb = BlueButton(config=CONFIGS_DIR + "json/bluebutton-sample-config-valid-sbx.json")
     assert bb.base_url == "https://sandbox.bluebutton.cms.gov"
@@ -53,6 +69,7 @@ def test_valid_config():
         "callback_url": "https://www.fake-prod.com/your/callback/here",
         "version": 1,
     }
+
     bb = BlueButton(config_dict)
     assert bb.base_url == "https://api.bluebutton.cms.gov"
     assert bb.client_id == "<your BB2 client_id here>"
@@ -95,7 +112,7 @@ def test_config_setting_environment():
         with pytest.raises(
             ValueError,
             match=r"Error: Configuration environment must"
-            " be set to SANDBOX or PRODUCTION in:.*",
+            " be set to LOCAL or TEST or SANDBOX or PRODUCTION in:.*",
         ):
             BlueButton(config=CONFIGS_DIR + file_name)
 

cms_bluebutton/tests/test_configs/json/bluebutton-sample-config-valid-local.json

@@ -0,0 +1,7 @@
+{
+    "environment": "LOCAL",
+    "client_id": "<your BB2 client_id here>",
+    "client_secret": "<your BB2 client_secret here>",
+    "callback_url": "https://fake-local/your/callback/here",
+    "version": 1
+}

cms_bluebutton/tests/test_configs/json/bluebutton-sample-config-valid-test.json

@@ -0,0 +1,7 @@
+{
+    "environment": "TEST",
+    "client_id": "<your BB2 client_id here>",
+    "client_secret": "<your BB2 client_secret here>",
+    "callback_url": "https://www.fake-test.com/your/callback/here",
+    "version": 1
+}