Add testing API for py-shiny #1156

Activity

1. github-actions

   added

   needs-triage

   on Feb 26, 2024
2. schloerke

   added

   testingRelated to testing shiny appsRelated to testing shiny apps

   and removed

   needs-triage

   on Apr 3, 2024
3. schloerke commented on Apr 3, 2024

   

   schloerke

   on Apr 3, 2024

   Collaborator

   More actions

   Hi @pstorozenko 👋 !

   @karangattu and I are aiming for a testing release near conf in the early fall. We are hoping to have the existing classes (and their methods) documented and moved under shiny.test (or something similar).

   ---

   It seems reasonable to try to make basic testing possible in the near future (knowing the API might change), such as the simple UI test linked above. (Functions related to conftest)

   The other helper controls could be aded piecemeal as we document / vet them.
4. pstorozenko commented on Apr 3, 2024

   

   pstorozenko

   on Apr 3, 2024

   Last edited by pstorozenko

   Author

   More actions

   Great to hear that!
   In the meantime, I'm working on the blog post on how to test pyshiny apps with playwright right now, will share here and on discord once it's ready :)

   ❤️React with ❤️1Reacted by Gabriele Calvo
5. pstorozenko commented on Apr 11, 2024

   

   pstorozenko

   on Apr 11, 2024

   Author

   More actions

   For all those wanting to test your apps right now

   It's great that there's an Epic for testing shiny apps 🎉
   In the meantime you can check this repo with examples.
   And the accompanying blog post.

   For adding tests to the CI/CD pipeline you can use this snippet in conftest.py (check this SO thread).
   This assumes the app is defined as app = App(...) in the app.py file.

   import threading
   
   import pytest
   import requests
   from tenacity import retry, stop_after_delay, wait_fixed
   from uvicorn import Config, Server
   
   APP_HOST = "127.0.0.1"
   APP_PORT = 8989
   APP_URL = f"http://{APP_HOST}:{APP_PORT}"
   
   
   @retry(wait=wait_fixed(0.5), stop=stop_after_delay(10))
   def wait_for_server_to_start(url):
       response = requests.get(url)  # noqa: S113
       response.raise_for_status()  # Will raise an exception if the request is unsuccessful, i.e. server is not ready
   
   
   def run_server():
       config = Config(app="app:app", host=APP_HOST, port=APP_PORT, log_level="info")
       server = Server(config)
       server.run()
   
   
   @pytest.fixture(scope="session", autouse=True)
   def _shiny_server():
       # Start the server in a background thread
       thread = threading.Thread(target=run_server, daemon=True)
       thread.start()
   
       wait_for_server_to_start(APP_URL)
   
       return
6. schloerke

   closed this as completedin #1448on Jun 4, 2024