feat: improve gf-auth-stop command, add envvars for keycloak setup, a…

…nd add instructions for running the auth server to CONTRIBUTING

CONTRIBUTING.md

@@ -49,12 +49,37 @@ NOTE: You can also/alternatively run `pre-commit run` (changes only) or
 
 ## Run Genetic Forensic portal
 
+First run the authentication application (Keycloak server) with the following
+command
+
+```bash
+gf-auth-up
+```
+
 You are now ready to run the Genetic Forensic portal Streamlit application:
 
 ```bash
 gf-portal
 ```
 
+## Stopping the auth portal
+
+To stop the auth portal, run the following command:
+
+```bash
+gf-auth-stop
+```
+
+## DO NOT RUN IN PROD: Exporting a list of DEV users from the DEV auth server
+
+To update the Keycloak realm containing the dev users, you can run the following
+command. Do not export your actual production users this way, as you do NOT want
+those users being uploaded to the repository.
+
+```bash
+gf-auth-dev-export-DO-NOT-RUN-IN-PROD
+```
+
 ## Testing
 
 When making changes, please run the following tests:

src/genetic_forensic_portal/app/common/setup.py

@@ -29,48 +29,7 @@ def login_success(message: str, username: str, token: dict[Any, Any]) -> None:
 
 @st.experimental_dialog("Login")  # type: ignore[misc]
 def authentication_dialog() -> None:
-    login_tab, create_tab = st.tabs(
-        [
-            "Login to existing account",
-            "Create new account",
-        ]
-    )
-
-    # Create new account
-    with create_tab:
-        st.write("Coming soon!")
-        # TODO figure out how to connect to keycloak to create an account
-        # with st.form(key="create"):
-        #     username = st.text_input(
-        #         label="Create a username",
-        #         placeholder=None,
-        #         help=None,
-        #         disabled=st.session_state[AUTHENTICATED],
-        #     )
-
-        #     password = st.text_input(
-        #         label="Create a password",
-        #         placeholder=None,
-        #         help=None,
-        #         type="password",
-        #         disabled=st.session_state[AUTHENTICATED],
-        #     )
-
-        #     if st.form_submit_button(
-        #         label="Create account",
-        #         type="primary",
-        #         disabled=st.session_state[AUTHENTICATED],
-        #     ):
-        #         try:
-        #             st.write(username)
-        #         except Exception as e:
-        #             st.error(e.message)
-        #             st.session_state[AUTHENTICATED] = False
-        #         else:
-        #             login_success("Account created!", username)
-
-    # Login to existing account
-    with login_tab, st.form(key="login"):
+    with st.form(key="login"):
         username = st.text_input(
             label="Login username",
             placeholder=None,

src/genetic_forensic_portal/auth.py

@@ -56,19 +56,33 @@ def start_keycloak(force: bool = False) -> None:
 
 
 def up() -> None:
+    if "DEFAULT_AUTH_ADMIN_PASSWORD" in os.environ:
+        os.environ["KEYCLOAK_ADMIN"] = os.environ["DEFAULT_AUTH_ADMIN_USERNAME"]
+        os.environ["KEYCLOAK_ADMIN_PASSWORD"] = os.environ[
+            "DEFAULT_AUTH_ADMIN_PASSWORD"
+        ]
+    elif (
+        "KEYCLOAK_ADMIN" not in os.environ
+        or "KEYCLOAK_ADMIN_PASSWORD" not in os.environ
+    ):
+        os.environ["KEYCLOAK_ADMIN"] = input("Enter Keycloak admin username: ")
+        os.environ["KEYCLOAK_ADMIN_PASSWORD"] = input("Enter Keycloak admin password: ")
+
+    down()
     logger.info("Starting Keycloak")
     start_keycloak()
 
 
 def down() -> None:
-    logger.info("Stopping Keycloak")
-    keycloak_pid_file = KEYCLOAK_PID_FILE.open("r")
-    keycloak_pid = keycloak_pid_file.read()
-    keycloak_pid_file.close()
+    if KEYCLOAK_PID_FILE.exists():
+        logger.info("Stopping Keycloak")
+        keycloak_pid_file = KEYCLOAK_PID_FILE.open("r")
+        keycloak_pid = keycloak_pid_file.read()
+        keycloak_pid_file.close()
 
-    os.system(f"kill -9 {keycloak_pid}")
+        os.system(f"kill -9 {keycloak_pid}")
 
-    KEYCLOAK_PID_FILE.unlink()
+        KEYCLOAK_PID_FILE.unlink()
 
 
 def export() -> None: