refactor: policy validation on config change #418
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
|
We identified new issues on unchanged lines of code. Navigate to the Amazon CodeGuru Reviewer console to view the recommendations to fix them. |
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
src/main/java/com/aws/greengrass/clientdevices/auth/ClientDevicesAuthService.java
Fixed
Show fixed
Hide fixed
Benchmark Results
|
jcosentino11
force-pushed
the
policy-validation-refactor
branch
2 times, most recently
from
ae23c35
to
b939c4e
Compare
|
Code Coverage Report
Minimum allowed coverage is Generated by 🐒 cobertura-action against f32d9d5 |
jcosentino11
force-pushed
the
policy-validation-refactor
branch
from
b939c4e
to
ac76c33
Compare
robcmann
previously approved these changes
Feb 2, 2024
MikeDombo
reviewed
Feb 3, 2024
| @@ -68,6 +71,15 @@ | |||
| @ImplementsService(name = ClientDevicesAuthService.CLIENT_DEVICES_AUTH_SERVICE_NAME) | |||
| public class ClientDevicesAuthService extends PluginService { | |||
| public static final String CLIENT_DEVICES_AUTH_SERVICE_NAME = "aws.greengrass.clientdevices.Auth"; | |||
| private static final ObjectMapper MAPPER = JsonMapper.builder() | |||
There was a problem hiding this comment.
use the mappers we already have in the utils. We have one already for recipes which does case insensitive stuff
MikeDombo
reviewed
Feb 3, 2024
src/main/java/com/aws/greengrass/clientdevices/auth/ClientDevicesAuthService.java
Outdated
Show resolved
Hide resolved
src/test/java/com/aws/greengrass/clientdevices/auth/ClientDevicesAuthServiceTest.java
Outdated
Show resolved
Hide resolved
MikeDombo
reviewed
Feb 5, 2024
MikeDombo
reviewed
Feb 5, 2024
| @@ -68,6 +70,8 @@ | |||
| @ImplementsService(name = ClientDevicesAuthService.CLIENT_DEVICES_AUTH_SERVICE_NAME) | |||
| public class ClientDevicesAuthService extends PluginService { | |||
| public static final String CLIENT_DEVICES_AUTH_SERVICE_NAME = "aws.greengrass.clientdevices.Auth"; | |||
| private static final ObjectMapper MAPPER = SerializerFactory.getRecipeSerializerJson(); | |||
There was a problem hiding this comment.
I think you want getConfigurationSerializerJson to avoid changing capitalization
There was a problem hiding this comment.
looks like we were relying on FAIL_ON_UNKNOWN_PROPERTIES before (which is why there's a test failure right now). so we'd have to use the existing objectmapper for backwards compat; otherwise if customers set group policy w/ extra stuff they can't rollback
There was a problem hiding this comment.
We shouldn't fail on unknown though. That prevents forward compatibility
There was a problem hiding this comment.
yeah, ok if we're fine with that behavior change then yeah can add it in
MikeDombo
previously approved these changes
Feb 6, 2024
robcmann
reviewed
Feb 6, 2024
| * | ||
| * @throws PolicyException if an invalid policy is detected | ||
| */ | ||
| public void validate() throws PolicyException { |
There was a problem hiding this comment.
Should we also validate that policy variables in the policy document are supported by the PolicyVariableResolver since the resolver doesn't handle unsupported policy variables?
There was a problem hiding this comment.
yep, wanted to do that in a follow-up, this PR is meant to be a refactor
robcmann
approved these changes
Feb 6, 2024
sameerzuberi
approved these changes
Feb 6, 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.
Issue #, if available:
Description of changes:
Add an explicit
GroupConfiguration#validatemethod, which is used to validate incoming policy config changes before applying them to CDA.Making this change as the foundation for adding more validations in the future (for policy variable feature).
Why is this change necessary:
How was this change tested:
Any additional information or context required to review the change:
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.