Refactor project #24
Merged
Refactor project #24
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
1. Delete everything and use `poetry` to rebuild the project structure, manage dependencies and handle development commands
1. Provide a handler to manage session cookies and configure `requests.Session` to use them. 2. Plan and structure some sketches for other handlers and other components for the project.
1. Authentication handlers available: session cookies, access tokens, and ID tokens. - Automatically renew the credentials if required. - Store the credentials in the filesystem, and load them if available to avoid reauthentications. For the ID token handler, refresh the token until the max session lifetime is reached (10h) before asking for a manual reauthentication. - Set file permissions to `0600` - Provide tests to check the code's correctness. 2. Update the McM REST client to use the new authentication handlers. - Enable users to perform arbitrary requests to the same web service via the `request.Session` attribute available at `self.session`. - Update the tests to use the `pytest` syntax.
1. Logger: Set default level to INFO if the client class does not configure this. 2. Include headers for the non authenticated session. 3. Update session User-Agent header for McM. 4. isort imports. 5. Skip cookie tests if `auth-get-sso-cookie` is not available.
1. Reorder all the content under the `rest` package. 2. Change the project's name. 3. Remove the `fixtures` test module from the final bundle, instead configure `pytest` to include it into its `PYTHONPATH` when tests are executed. 4. Update README: Include instructions about how to build the package automatically with `pip`
1. Downgrade from Python 3.11 to Python 3.9 Python 3.9 is the main version for the alias `python3` in AlmaLinux 9 and `lxplus.cern.ch` nodes. Also, this decision is mainly based on the Python version available in `cms-sw` apptainer images for `el9`, using a different version will reduce chances to smoothly integrate this with some batch execution within McM web application.
8 tasks
1. Configure a session using `access_token` 2. Use decorators and class fixtures to check and skip tests based on the execution runtime environment, and avoid repeating `except` conditions across the test suite 3. Refactor parametrized tests in several functions regarding its authentication method. 4. Skip session cookie tests if no valid Kerberos ticket is available. 5. yield files in fixtures instead of using `os.remove` into tests.
1. Raise a `DeprecationWarning` if someone attempts to access mangled methods in the McM class. 2. Re-include examples about how to use the McM REST class to perform requests to McM. 3. Remove some dead code. 4. Change the logger prefix to `pdmv-http-client`. 5. Fix some grammar issues. 6. Format the code using `black` and `isort`.
|
Only one script is missing, create_chained_campaigns.py, I will reinclude it in another PR when it is finished as it will require more code to properly plug it in this new project. Also, I consider change_priority.py is not required anymore so I deleted it. |
lmoureaux
previously approved these changes
Jul 1, 2024
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.
Related to: #23