[WIP] Unit Test for dashboard #672
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributes to unit testing by applying a UI component to exit the dialog box and allowing selenium to continue testing the application
Initially these were added to convert user input to the correct type in order to be compatible with simulation. However, upon commenting these out for the sake of unit testing compatibility, it was found that the simulation is still functional with user inputs and does not need any conversion of user values. There is potential for underlying problems that have yet to be found.
proy30
commented
Aug 11, 2024
proy30
commented
Aug 12, 2024
ax3l
reviewed
Aug 12, 2024
Comment on lines
+31
to
+33
| script_dir = os.path.dirname(os.path.abspath(__file__)) | ||
| working_directory = os.path.join(script_dir, "../../../src/python/impactx") | ||
| working_directory = os.path.normpath(working_directory) |
There was a problem hiding this comment.
We need to generalize this so it:
- runs in CTests from the build directory
- runs when copied in a package manager with external installs
ax3l
reviewed
Aug 12, 2024
ax3l
reviewed
Aug 12, 2024
tests/python/dashboard/util.py
Outdated
| working_directory = os.path.normpath(working_directory) | ||
|
|
||
| return subprocess.Popen( | ||
| ["python", "-m", "dashboard"], |
There was a problem hiding this comment.
When I run this locally, this literally opens a browser window for me.
Is there a way to run this headless?
ax3l
reviewed
Aug 12, 2024
Mark the test as skipped if `seleniumbase` is not available.
ax3l
reviewed
Aug 12, 2024
proy30
commented
Aug 13, 2024
Comment on lines
66
to
68
| # Check if "Simulation complete" message is printed | ||
| xterm_content = sb.get_text("#xterm_component") | ||
| assert "Simulation complete." in xterm_content |
There was a problem hiding this comment.
This is currently buggy and offering flaky results.
There was a problem hiding this comment.
Alternative method implemented by having unit test interact with phase space projections, which indirectly mean simulation ran properly.
ax3l
reviewed
Aug 15, 2024
| time.sleep(10) | ||
|
|
||
| try: | ||
| with SB() as sb: |
There was a problem hiding this comment.
Trying if this prevents that the unit test on Linux/macOS opens a browser:
Suggested change
| with SB() as sb: | |
| with SB(headless=True) as sb: | |
There was a problem hiding this comment.
ax3l
reviewed
Aug 15, 2024
This indirectly assures user that sim ran successfully.
for more information, see https://pre-commit.ci
changed hardcoded 'python' command to 'sys.executable' and also initialized app_process
Adjusted function to retry upon failure until timeout has reached max time.
for more information, see https://pre-commit.ci
|
Continued in #706 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR introduces the first unit test for the ImpactX dashboard, leveraging the SeleniumBase library to simulate a simulation run by a user with the GUI.
Key Features
Issues
Dependency on Running Dashboard:The current implementation requires the ImpactX dashboard to run in a separate terminal before executing the test viapytest.Can investigate to potentially have dashboard be launched within the test itself.Unit test is flaky with passing/failing, unsure if this is due to code error or error in pytest implementation. Need to investigate. Started occurring after the implementation of subprocess.Checklist
Resolves #667