Fix problem with tests failing sometimes #56
Merged
Conversation
This file contains hidden or 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
Added a connectivity waiter for the webserver to make sure it is ready for the test cases to use.
t-persson
requested review from
fredjn and
magnusbaeck
and removed request for
a team
magnusbaeck
approved these changes
Oct 15, 2020
Comment on lines
+50
to
+67
| def wait_for_webserver_connection(): | ||
| """Wait for the webserver to respond to HTTP requests.""" | ||
| LOGGER.info("Testing for webserver connectivity.") | ||
| query_handler = GraphQLQueryHandler("http://127.0.0.1:12345/graphql") | ||
| timeout = time.time() + 30 | ||
| while time.time() < timeout: | ||
| try: | ||
| query_handler.execute("{nothing}") | ||
| LOGGER.info("Up and running") | ||
| return | ||
| except HTTPError: # BadRequest means the webserver came up. | ||
| LOGGER.info("Up and running") | ||
| return | ||
| except Exception as exception: # pylint: disable=broad-except | ||
| LOGGER.error("%r", exception) | ||
| LOGGER.warning("Connection could not be established. Trying again in 1s..") | ||
| time.sleep(1) | ||
| raise TimeoutError("Timeout waiting for the webserver to start.") |
There was a problem hiding this comment.
Why not use the retry package instead?
@retry.retry(exceptions=Exception, tries=30, delay=1, logger=LOGGER)
def wait_for_webserver_connection():
query_handler = GraphQLQueryHandler("http://127.0.0.1:12345/graphql")
try:
query_handler.execute("{nothing}")
except HTTPError as err:
if err.response.status_code != 400:
raiseIt won't raise TimeoutError if the startup fails though.
There was a problem hiding this comment.
Since this is the only place in the entire code-base where we do this kind of retry, I would say that the additional "overhead" of installing the retry package feels unnecessary.
If we were to add more retries, then definitely.
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.
Applicable Issues
None
Description of the Change
Added a connectivity waiter for the webserver to make sure it is ready for the test cases to use.
Alternate Designs
Unknown
Benefits
Tests won't fail intermittently
Possible Drawbacks
Possible that the tests will take a lot longer to run
Sign-off
Developer's Certificate of Origin 1.1
By making a contribution to this project, I certify that:
(a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; or
(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or
(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.
(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.
Signed-off-by: Tobias Persson tobias.persson@axis.com