RSTUF Interface refactoring (IServices) #389
Merged
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
kairoaraujo
force-pushed
the
support_multiple_envs_for_setting
branch
from
eb235a3 to
34b7a82
Compare
Codecov ReportPatch coverage:
Additional details and impacted files@@ Coverage Diff @@
## main #389 +/- ##
===========================================
+ Coverage 99.43% 100.00% +0.56%
===========================================
Files 12 12
Lines 884 898 +14
===========================================
+ Hits 879 898 +19
+ Misses 5 0 -5
☔ View full report in Codecov by Sentry. |
- The old `repository.refresh_settings` handling the IServices
configuration was moved to the `interfaces`
- Now the way to importa a `I{Services}` uses directly the dynaconf
- Adds better error mensages for wrong configuration
- Support a service has one setting with multiple environment variables
what is helpful for third-part libraries that uses environment vars
Signed-off-by: Kairo de Araujo <[email protected]>
kairoaraujo
force-pushed
the
support_multiple_envs_for_setting
branch
from
34b7a82 to
3c240a1
Compare
MVrachev
reviewed
Sep 20, 2023
| @classmethod | ||
| def from_dynaconf(cls, settings: Dynaconf) -> None: | ||
| """ | ||
| Run actions to test, configure using the settings. |
There was a problem hiding this comment.
Suggested change
| Run actions to test, configure using the settings. | |
| Run actions to test and configure using the settings. |
| @@ -47,18 +55,26 @@ def get(self, public_key: Key) -> Signer: | |||
| class IStorage(ABC): | |||
| @classmethod | |||
| @abstractmethod | |||
| def configure(cls, settings: Any) -> None: | |||
| def configure(cls, settings: Dynaconf) -> None: | |||
There was a problem hiding this comment.
Does it make sense to annotate the settings arg at IkeyVault.configure as well?
| @@ -79,3 +95,79 @@ def put( | |||
| Stores file bytes within a file with a specific filename. | |||
| """ | |||
| raise NotImplementedError # pragma: no cover | |||
|
|
|||
|
|
|||
| def _setup_service_dynaconf(cls: Any, backend: Any, settings: Dynaconf): | |||
There was a problem hiding this comment.
Nit: to be even more precise you can create a class called IService and make both IkeyVault and IStorage inherit it, then here the cls will be cls: IService.
There was a problem hiding this comment.
As we have new contributors, it would be good to have it as a Good First Issue for someone who wants to understand the RSTUF Worker IServices.
| test_cls, test_settings.RSTUF_FAKE_BACKEND, test_settings | ||
| ) | ||
|
|
||
| assert "Invalid Interface IFake" in str(err) |
There was a problem hiding this comment.
I think this test function is duplicating the first one.
- Improve the comments - Implement a better test for the all settings None - Add asserts related to the stub Signed-off-by: Kairo de Araujo <[email protected]>
kairoaraujo
force-pushed
the
support_multiple_envs_for_setting
branch
from
a2a69cf to
e745c25
Compare
MVrachev
approved these changes
Sep 20, 2023
|
Superseded: #397. |
MVrachev
approved these changes
Sep 21, 2023
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.
repository.refresh_settingshandling the IServicesconfiguration was moved to the
interfacesI{Services}uses the dynaconf directlywhat is helpful for third-party libraries that use environment vars