Issue #163: Optional Connection upon Client Instantiation #164
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
This allows a user to create a client without _knowing_ the IP they are connecting to up front. It gives the user the ability to create and pass around a client object as needed. Additionally, the default behavior is preserved. * Added `check_connectivity` keyword arg to `RestClientBase`. * Added `check_connectivity` keyword arg to `HTTPClient`. * Added `check_connectivity` keyword arg to `redfish_client` function. * Conditionally execute `get_root_object` during client instantiation based on the value of `check_connectivity`. * Catch the resultant `AttributeError` in the case that `self.root` was not set due to `check_connectivity` being set to `False`. * Small test refactor, added `setUp` method to `TestRedFishClient` class to make commonly used attributes members of the test case. * Added new test for this functionality. Signed-off-by: Justin Palmer <jpavlav@gmail.com>
jpavlav
force-pushed
the
jpavlav/optional_get_root_object
branch
from
abf1571 to
ef8ec2a
Compare
Contributor
|
Only comments I have right now are we need to update the comment blocks that document parameters with the new We also need to add documentation to the README here for it: https://github.com/DMTF/python-redfish-library/blob/main/README.rst?plain=1#L93 Still looking over other things, but otherwise looks good so far |
Contributor
Author
|
Good callout on the docstrings! I can't believe I forgot to do that. I'll get those updated and the README as well. |
* Ensure that the `root` data/response added as attributes by the `get_root_object` method are cached when `login` is called. * Added new test to cover this case. Signed-off-by: Justin Palmer <jpavlav@gmail.com>
* Updated docstrings to describe `check_connectivity` parameter. * Updated `README.rst` to call it out as an optional parameter. Signed-off-by: Justin Palmer <jpavlav@gmail.com>
jpavlav
force-pushed
the
jpavlav/optional_get_root_object
branch
from
957421e to
72a23d7
Compare
Contributor
Author
|
@mraineri Hey there! Addressed your comments. Should be ready for review. |
Contributor
|
It all looks good to me! It'll be reviewed by the rest of the group today. |
Contributor
|
Approved 9/13 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 allows a user to create a client without knowing the IP they are connecting to up front. It gives the user the ability to create and pass around a client object as needed. Additionally, the default behavior is preserved.
check_connectivitykeyword arg toRestClientBase.check_connectivitykeyword arg toHTTPClient.check_connectivitykeyword arg toredfish_clientfunction.get_root_objectduring client instantiation based on the value ofcheck_connectivity.AttributeErrorin the case thatself.rootwas not set due tocheck_connectivitybeing set toFalse.setUpmethod toTestRedFishClientclass to make commonly used attributes members of the test case.rootdata/response added as attributes by theget_root_objectmethod are cached whenloginis called.Test results:
python tests/rest/test_v1.py ... ---------------------------------------------------------------------- Ran 3 tests in 11.384s OK#163