Enhancement/20 allow reading and writing shared config file #23
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
added a configuration loader which checks for existing config files. If the folder is not found it is created. If the file is not found the default empty config file is copied to users home directory.
added suggestions from pylint
Add a test case that loads a simple YAML file with two projects. You can run tests by executing `pytest` in the project root. Note that the test currently fails.
added yaml import
The tests now are green. I just changed it to return the contents of the yaml file. In the test no path has to be passed. This is already done in the configloader. Can I remove this from the test @bkircher ?
Added misssing dependency pyyaml for pytest
The function was copying the file to the wrong location
…file' of https://github.com/gridscale/gridscale_api_client_python into enhancement/20-allow-reading-and-writing-shared-config-file
|
@jonathanlutterbeck Hey thanks! Can you
|
Checks have been added to verify file name lenght and to check if it's really a .yaml file. All tests are now green. Fixed error Moved the syspath cariable to be globally available Fix error path variable was named wrong Try to fix github action error Changed file name for config file. Fixed Test Fixed copyfile for test case Check if config is valid load_config now gives correct error messages and does not catch any exceptions. The functions are now also properly seperated. removed print statements Print statements have been removed and replaced them with RuntimeErrors where applicable. which_path was renamed to default_config_path. Improved code I merged the two isInstance calls to improve readability.
BoxG11
force-pushed
the
enhancement/20-allow-reading-and-writing-shared-config-file
branch
from
e48f9ac
to
ebc5df8
Compare
added 2 commits
June 2, 2022 18:15
commit ebc5df8 Author: Benjamin Kircher <bkircher@gridscale.io> Date: Wed May 4 10:05:50 2022 +0200 tests: Ensure load_config does not interpret file name commit 5fe3df0 Author: Jonathan Lutterbeck <jonathan@gridscale.io> Date: Mon Apr 25 19:45:13 2022 +0200 improvements to check validity of config file Checks have been added to verify file name lenght and to check if it's really a .yaml file. All tests are now green. Fixed error Moved the syspath cariable to be globally available Fix error path variable was named wrong Try to fix github action error Changed file name for config file. Fixed Test Fixed copyfile for test case Check if config is valid load_config now gives correct error messages and does not catch any exceptions. The functions are now also properly seperated. removed print statements Print statements have been removed and replaced them with RuntimeErrors where applicable. which_path was renamed to default_config_path. Improved code I merged the two isInstance calls to improve readability. commit a658543 Author: Benjamin Kircher <bkircher@gridscale.io> Date: Wed Apr 27 09:18:58 2022 +0200 tests: Add more test cases for load_config() commit 3566688 Merge: d7d1915 6aed011 Author: Jonathan Lutterbeck <jonathan@gridscale.io> Date: Mon Apr 25 19:42:41 2022 +0200 Merge branch 'enhancement/20-allow-reading-and-writing-shared-config-file' of https://github.com/gridscale/gridscale_api_client_python into enhancement/20-allow-reading-and-writing-shared-config-file commit d7d1915 Author: Jonathan Lutterbeck <jonathan@gridscale.io> Date: Mon Apr 25 19:41:45 2022 +0200 Fixed error The function was copying the file to the wrong location commit 6aed011 Author: jonathanlutterbeck <48634262+jonathanlutterbeck@users.noreply.github.com> Date: Mon Apr 25 19:39:26 2022 +0200 Changed yaml to pyyaml Added misssing dependency pyyaml for pytest commit 415112c Author: Jonathan Lutterbeck <jonathan@gridscale.io> Date: Mon Apr 25 19:15:34 2022 +0200 Improve code to run checks The tests now are green. I just changed it to return the contents of the yaml file. In the test no path has to be passed. This is already done in the configloader. Can I remove this from the test @bkircher ? commit 05c3775 Author: jonathanlutterbeck <48634262+jonathanlutterbeck@users.noreply.github.com> Date: Fri Apr 22 11:27:59 2022 +0200 Update dev-requirements.txt added yaml import commit 2c62062 Author: Benjamin Kircher <bkircher@gridscale.io> Date: Fri Apr 22 11:12:10 2022 +0200 Add test case for load_config Add a test case that loads a simple YAML file with two projects. You can run tests by executing `pytest` in the project root. Note that the test currently fails. commit 09ef4af Author: jonathanlutterbeck <48634262+jonathanlutterbeck@users.noreply.github.com> Date: Fri Apr 15 20:34:34 2022 +0200 improved code added suggestions from pylint commit acb07f7 Author: jonathanlutterbeck <48634262+jonathanlutterbeck@users.noreply.github.com> Date: Fri Apr 15 15:34:24 2022 +0200 created configloader.py added a configuration loader which checks for existing config files. If the folder is not found it is created. If the file is not found the default empty config file is copied to users home directory.
…file' of https://github.com/gridscale/gridscale_api_client_python into enhancement/20-allow-reading-and-writing-shared-config-file
| api_config.api_key['X-Auth-UserId'] = "USER_UUID" | ||
| # api_config.debug = True | ||
|
|
||
| #TODO: Change filename |
| configfile = load_config("config.yaml") | ||
| api_config.api_key['X-Auth-Token'] = configfile[0].get("token") | ||
| api_config.api_key['X-Auth-UserId'] = configfile[0].get("userId") | ||
| api_config.debug = True |
There was a problem hiding this comment.
I think this shouldn't be debug per default
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.
All your requested changes have been made. Tests are all green