Skip to content
This repository has been archived by the owner on Mar 17, 2023. It is now read-only.

Latest commit

 

History

History
43 lines (28 loc) · 2.55 KB

testing.md

File metadata and controls

43 lines (28 loc) · 2.55 KB

Testing

JSP

To test the JupyterHub Singleuser Profiles library, you can follow these steps:

  1. Create a fork of the JSP repository
  2. Apply the required changes.
  3. Clone the jsp-wrapper repository.
  4. Follow the instructions written in the jsp-wrapper README
  5. Your changes should now be applied to jupyterhub in your cluster.

Notes:

  • In step 4 it is necessary to be logged in to your target openshift cluster, and you must have a quay.io account and be logged in to it through podman. If your quay.io username is different from your github username, it is changeable with the QUAY_REPO variable. (ex. QUAY_REPO=username)
  • After step 5 any errors will be logged into the main jupyterhub pod.
  • To increase the verbosity of logging, each .py file which is part of the JSP library has a _LOGGER variable. To set verbosity to maximum, add _LOGGER.setlevel('DEBUG'). By default the verbosity is set to WARNING and above.

JSP + Jupyterhub-odh

To test jsp changes that require modifying the jupyterhub-odh repository follow these steps:

  1. Create forks of both the JSP repository and the jupyterhub-odh repository
  2. Apply the required changes.
  3. Push the changes.
  4. Clone the jsp-wrapper repository.
  5. Follow instructions of this section of jsp-wrapper
  6. Your changes should now be applied to jupyterhub.

API

To test the API of the JSP library the same steps apply. Following these steps, it is necessary to go to the jupyterhub route. To get to the debug UI of the AI use the following link: <jupyterhub route>/services/api/ui

Any errors of the API will appear in the main jupyterhub pod. To configure these logs follow the instructions in the notes section of the JSP testing manual above.

UI

To test the Spawner UI, follow the steps in the JSP section above. Then follow the jupyterhub route.

Any errors will appear in the console accessed with F12. Closer information about the error may be available in the jupyterhub pod.

For further information such as local testing of the UI, follow instructions of the testing section of the UI Readme