Merge pull request #26 from CMSgov/jfuqian/BB2-1702-Python-Sample-App-code-cleanup

[BB2-1702] BB2 Python Sample App code refactor (use SDK) & cleanup

Author: James Fuqian

README-bb2-dev.md

@@ -0,0 +1,33 @@
+# Blue Button 2.0 Sample Application Development Documentation
+
+## Introduction
+
+This README contains information related to developing the SDK.
+
+It is intended for BB2 team members or others performing sample application development work.
+
+## Run selenium tests in docker
+
+Configure the remote target BB2 instance where the tested app is registered (as described above "Running the Back-end & Front-end")
+
+Change your `callback_url` configuration to use `server` instead of `localhost`. For example:
+```JSON
+    "callback_url": "http://server:3001/api/bluebutton/callback/"
+```
+You can also start your configuration by following the sample config template for selenium tests:
+
+cp server/sample-bluebutton-selenium-config.json server/.bluebutton-config.json
+
+You will also need to add this URL to your `redirect_uris` list in your application's configuration on the BB2 Sandbox UI.
+
+Go to local repository base directory and run docker compose as below:
+
+docker-compose -f docker-compose.selenium.yml up --abort-on-container-exit
+
+Note: --abort-on-container-exit will abort client and server containers when selenium tests ends
+
+Note: You may need to clean up already existing Docker containers, if you are having issues or have changed your configuration file.
+
+## Visual trouble shoot
+
+Install VNC viewer and point browser to http://localhost:5900 to monitor web UI interactions

README.md

@@ -25,12 +25,11 @@ Running the Back-end & Front-end
 
 Once Docker and Python are Installed then do the following:
 
-    copy server/src/configs/sample_config.py -> server/src/configs/config.py
-    
-Make sure to replace the clientId and clientSecret variables within the config file with
-the ones you were provided, for your application, when you created your Blue Button Sandbox account.
+    cp server/sample-bluebutton-config.json server/.bluebutton-config.json
 
-    copy server/src/prestart/env/sandbox.sample.env -> server/src/prestart/env/development.env
+Make sure to replace the client_id and client_secret variables within the config file with
+the ones you were provided, for your application, when you created your Blue Button Sandbox account,
+the supported environments are SANDBOX or PRODUCTION.
 
     docker-compose up -d
 
@@ -51,27 +50,21 @@ data would be:  BBUser29999 (PWD: PW29999!) or BBUser29998 (PWD: PW29998!)
 
 Development
 -----------
-Read the DEVELOPER NOTES found in the code to understand the application
-and where you will need to make adjustments/changes as well as some 
-suggestions for best practices.
-
-Debugging server component
---------------------------
-debugpy remote debugging enabled on port 5678 for server in docker compose, developer can attach to server from IDE e.g. vscode.
+Read the comments in the code to understand the application and where
+you will need to make adjustments/changes as well as some suggestions
+for best practices.
 
-## Run selenium tests in docker
+Python SDK
+----------
 
-Configure the remote target BB2 instance where the tested app is registered (as described above "Running the Back-end & Front-end")
+The sample app utilizes our [Python SDK](https://github.com/CMSgov/cms-bb2-python-sdk).
 
-Go to local repository base directory and run docker compose as below:
+Please review our SDK documentation for more information and additional features available for your use.
 
-docker-compose -f docker-compose.selenium.yml up --abort-on-container-exit
 
-Note: --abort-on-container-exit will abort client and server containers when selenium tests ends
-
-## Visual trouble shoot
-
-Install VNC viewer and point browser to http://localhost:5900 to monitor web UI interactions
+Debugging server component
+--------------------------
+debugpy remote debugging enabled on port 5678 for server in docker compose, developer can attach to server from IDE e.g. vscode.
 
 Error Responses and handling:
 -----------------------------

docker-compose.selenium.yml

@@ -24,7 +24,7 @@ services:
     build:
       context: ./selenium_tests
       dockerfile: ./Dockerfile
-    command: pytest ./src/test_node_sample.py
+    command: pytest ./src/test_python_sample.py
     depends_on:
       - chrome
       - server

selenium_tests/src/test_node_sample.py selenium_tests/src/test_python_sample.pyselenium_tests/src/test_node_sample.py renamed to selenium_tests/src/test_python_sample.py

@@ -1,10 +1,11 @@
-# Generated by Selenium IDE
 import time
 from selenium import webdriver
 from selenium.webdriver.common.by import By
 from selenium.webdriver.support import expected_conditions as EC
 from selenium.webdriver.support.wait import WebDriverWait
 
+CSS_SEL_FE_ERR_MSG_CONTENT = "tbody .ds-u-text-align--left:nth-child(2)"
+
 
 class TestNodeSampleApp():
     driver_ready = False
@@ -73,6 +74,13 @@ def _assert_EOB_table_records_present(self, cnt):
         elements = self._find_elem_xpath(xpath)
         assert len(elements) == cnt
 
+    def _assert_EOB_table_error_present(self):
+        element = self._find_and_return(30,
+                                        By.CSS_SELECTOR,
+                                        CSS_SEL_FE_ERR_MSG_CONTENT)
+        assert element is not None
+        print(element.text)
+
     def _input_user_and_passwd_and_login(self):
         self._find_and_sendkey(30, By.ID, "username-textbox", "BBUser10000")
         self._find_and_sendkey(30, By.ID, "password-textbox", "PW10000!")
@@ -110,5 +118,26 @@ def test_node_sample_app_deny_access(self):
         self._input_user_and_passwd_and_login()
         self._find_and_click(30, By.ID, "deny")
         time.sleep(5)
-        self._assert_EOB_table_header_present()
-        self._assert_EOB_table_records_present(0)
+        self._assert_EOB_table_error_present()
+
+    def test_node_sample_app_grant_followed_by_deny_access(self):
+        '''
+        this is to verify that the cached result from previous
+        authorized eob query is clean up (should not see cached claims)
+        '''
+        self.driver.get("http://client:3000/")
+        self.driver.set_window_size(1500, 1800)
+        elem = self._find_and_click(30, By.ID, "auth_btn")
+        assert elem is not None
+        self._input_user_and_passwd_and_login()
+        self._find_and_click(30, By.ID, "approve")
+        time.sleep(5)
+        self._assert_EOB_table_records_present(10)
+        # go again
+        elem = self._find_and_click(30, By.ID, "auth_btn")
+        assert elem is not None
+        self._input_user_and_passwd_and_login()
+        self._find_and_click(30, By.ID, "deny")
+        time.sleep(5)
+        # should see error message
+        self._assert_EOB_table_error_present()

server/Dockerfile

@@ -5,17 +5,16 @@ LABEL description="Demo of a Medicare claims data sample app"
 
 WORKDIR /server
 
-COPY ["./src/configs/sample_config.py", "./src/configs/config.py"]
-COPY ["./src/prestart/env/sandbox.sample.env","./src/prestart/env/development.env"]
+# COPY ["./src/configs/sample_config.py", "./src/configs/config.py"]
+# COPY ["./src/prestart/env/sandbox.sample.env","./src/prestart/env/development.env"]
 
 COPY . . 
 
-RUN pip install pipenv
-RUN pip install debugpy
+RUN pip install pipenv debugpy ./cms_bluebutton_sdk-1.0.0-py3-none-any.whl
 RUN pipenv install --system --deploy --ignore-pipfile
 
-ENV ENV "development"
+# ENV ENV "development"
 
 EXPOSE 3001
 
-CMD ["sh", "-c", "python -m debugpy --listen 0.0.0.0:5678 run.py --ENV ${ENV}"]
+CMD ["sh", "-c", "python -m debugpy --listen 0.0.0.0:5678 app.py"]

server/Pipfile

@@ -5,10 +5,6 @@ name = "pypi"
 
 [packages]
 flask = "*"
-requests = "*"
-argparse = "*"
-requests-toolbelt = "*"
-python-dotenv = "*"
 
 [dev-packages]