Add HMAC capabilities #181
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
github-actions
bot
added
the
part:tooling
florian-wagner-frequenz
force-pushed
the
hmac_signing
branch
2 times, most recently
from
1ecb907 to
67fc1d5
Compare
florian-wagner-frequenz
force-pushed
the
hmac_signing
branch
from
67fc1d5 to
55519b0
Compare
github-actions
bot
added
the
part:tests
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
llucax
reviewed
May 23, 2025
llucax
reviewed
May 23, 2025
florian-wagner-frequenz
force-pushed
the
hmac_signing
branch
from
114af31 to
e7ffe2f
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR adds HMAC signing capabilities to the Reporting client.
- Introduces a new parameter "sign_secret" in ReportingApiClient and updates its initialization.
- Adds a new CLI option "--sign_secret" to enable HMAC support via the command line.
- Updates tests and dependency versions to support the new HMAC functionality.
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| tests/test_client_reporting.py | Adds "sign_secret" test parameter and verifies its propagation to the base class. |
| src/frequenz/client/reporting/cli/main.py | Introduces the CLI option "--sign_secret" for HMAC signing. |
| src/frequenz/client/reporting/_client.py | Updates ReportingApiClient to accept and pass "sign_secret" to BaseApiClient. |
| pyproject.toml | Updates dependency version of frequenz-client-base. |
| RELEASE_NOTES.md | Adds new release note entries for the HMAC generation capabilities. |
Comments suppressed due to low confidence (1)
RELEASE_NOTES.md:13
- The release notes currently reference the 'key' argument for HMAC functionality; please update them to correctly mention the new '--sign_secret' CLI option and the 'sign_secret' parameter used for HMAC signing.
* Add HMAC generation capabilities.
llucax
reviewed
Jun 12, 2025
| class ReportingApiClient(BaseApiClient[ReportingStub]): | ||
| """A client for the Reporting service.""" | ||
|
|
||
| # pylint: disable=too-many-arguments, too-many-positional-arguments |
There was a problem hiding this comment.
If you use disable= in its own line, that will disable the check for the rest of the file, not only for the next line, if you want to disable it only for the next line you need to use disable-next=.
Suggested change
| # pylint: disable=too-many-arguments, too-many-positional-arguments | |
| # pylint: disable-next=too-many-arguments, too-many-positional-arguments |
Also I think in this case pylint has a point, and you should use positional-only arguments, specially for strings/bool that are really hard to read without a keyword on the call site.
There was a problem hiding this comment.
Again, me being to meek about breaking the interface, but I am already doing it anyways.
We support two versions of protobuf-gencode. However, automated warnings treated as errors will prevent the package from building correctly with the newer version due to version mismatch. Signed-off-by: Florian Wagner <[email protected]>
florian-wagner-frequenz
force-pushed
the
hmac_signing
branch
from
e7ffe2f to
aadf204
Compare
llucax
previously approved these changes
Jun 13, 2025
This adds the capability for HMAC based signing into the reporting client. This also removes the need for ad-hoc api key management, as the underlying `BaseApiClient` will automatically create an interceptor to inject the key as metadata. Signed-off-by: Florian Wagner <[email protected]>
florian-wagner-frequenz
force-pushed
the
hmac_signing
branch
from
aadf204 to
d745b39
Compare
llucax
approved these changes
Jun 13, 2025
cwasicki
reviewed
Jun 16, 2025
| server_url: str, | ||
| key: str | None = None, | ||
| *, | ||
| auth_key: str | None = None, |
There was a problem hiding this comment.
Could you please update the README w.r.t. these interface changes.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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 adds the capability for HMAC based signing into the reporting client.