Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(inspector): add minimal L2 interface for Inspector assessment template and fromCfnAssessmentTemplate() #33614

Merged
merged 4 commits into from
Mar 2, 2025

Conversation

gracelu0
Copy link
Contributor

Issue # (if applicable)

Closes #.

Reason for this change

As part of effort to stabilize scheduler-targets-alpha module, the Inspector start assessment run target currently uses the L1 CfnAssessmentTemplate as the target. Using the L1 as a target goes against our general design guidelines for CDK L2s so we need an intermediary solution. Separate PR to follow to update the scheduler target API.

Description of changes

  • L2 interface IAssessmentTemplate which contains the ARN attribute
  • New class containing a static method to allow users to pass in L1 but returns L2 interface for usage with functions that expect L2

Describe any new or updated permissions being added

n/a

Description of how you validated changes

Added unit tests.

Checklist


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

@aws-cdk-automation aws-cdk-automation requested a review from a team February 28, 2025 00:40
@github-actions github-actions bot added the p2 label Feb 28, 2025
@gracelu0 gracelu0 changed the title feat(inspector): add minimal L2 interface for Inspector assessment template and fromCfnAssessmentTemplate() to support scheduler target integration feat(inspector): add minimal L2 interface for Inspector assessment template and fromCfnAssessmentTemplate() Feb 28, 2025
@gracelu0 gracelu0 changed the title feat(inspector): add minimal L2 interface for Inspector assessment template and fromCfnAssessmentTemplate() feat(inspector): add minimal L2 interface for Inspector assessment template and fromCfnAssessmentTemplate() Feb 28, 2025
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Feb 28, 2025
@gracelu0 gracelu0 changed the title feat(inspector): add minimal L2 interface for Inspector assessment template and fromCfnAssessmentTemplate() feat(inspector): add minimal L2 interface for Inspector assessment template and fromCfnAssessmentTemplate() Feb 28, 2025
@gracelu0 gracelu0 added pr-linter/exempt-integ-test The PR linter will not require integ test changes pr-linter/exempt-readme The PR linter will not require README changes labels Feb 28, 2025
@gracelu0 gracelu0 force-pushed the inspector-assessment-template branch from 7fe1eca to b960280 Compare February 28, 2025 01:24
Copy link
Contributor

@samson-keung samson-keung left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you

@samson-keung
Copy link
Contributor

Looks like the awslint step is failing in the build:

aws-cdk-lib: error: [awslint:props-struct-name:aws-cdk-lib.aws_inspector.IAssessmentTemplate] all constructs must have a props struct 
aws-cdk-lib: error: [awslint:construct-ctor-props-type:aws-cdk-lib.aws_inspector.AssessmentTemplate] construct "props" type should use the props struct aws-cdk-lib.aws_inspector.AssessmentTemplateProps
aws-cdk-lib: Error: /codebuild/output/src606487186/src/github.com/aws/aws-cdk/tools/@aws-cdk/cdk-build-tools/bin/cdk-awslint exited with error code 1

@gracelu0
Copy link
Contributor Author

Looks like the awslint step is failing in the build:

aws-cdk-lib: error: [awslint:props-struct-name:aws-cdk-lib.aws_inspector.IAssessmentTemplate] all constructs must have a props struct 
aws-cdk-lib: error: [awslint:construct-ctor-props-type:aws-cdk-lib.aws_inspector.AssessmentTemplate] construct "props" type should use the props struct aws-cdk-lib.aws_inspector.AssessmentTemplateProps
aws-cdk-lib: Error: /codebuild/output/src606487186/src/github.com/aws/aws-cdk/tools/@aws-cdk/cdk-build-tools/bin/cdk-awslint exited with error code 1

Yes just noticed that as well. Will push a fix shortly!

Copy link

codecov bot commented Mar 1, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.21%. Comparing base (1df1a78) to head (723dcac).

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #33614   +/-   ##
=======================================
  Coverage   82.21%   82.21%           
=======================================
  Files         119      119           
  Lines        6876     6876           
  Branches     1162     1162           
=======================================
  Hits         5653     5653           
  Misses       1120     1120           
  Partials      103      103           
Flag Coverage Δ
suite.unit 82.21% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Components Coverage Δ
packages/aws-cdk ∅ <ø> (∅)
packages/aws-cdk-lib/core 82.21% <ø> (ø)

Copy link
Contributor

mergify bot commented Mar 1, 2025

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: 723dcac
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

Copy link
Contributor

mergify bot commented Mar 2, 2025

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@mergify mergify bot merged commit d51f70a into aws:main Mar 2, 2025
20 checks passed
Copy link

github-actions bot commented Mar 2, 2025

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 2, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
contribution/core This is a PR that came from AWS. p2 pr-linter/exempt-integ-test The PR linter will not require integ test changes pr-linter/exempt-readme The PR linter will not require README changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants