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

chore(ses): create unit tests for drop spam handler #27769

Merged
merged 3 commits into from
Nov 3, 2023

Conversation

colifran
Copy link
Contributor

This PR adds unit tests for the SES drop spam handler. Specifically, the unit tests verify that spam will be dropped under the following conditions:

  1. SPF verdict is FAIL
  2. DKIM verdict is FAIL
  3. Spam verdict is FAIL
  4. Virus verdict is FAIL

An additional unit test was added to ensure that null is returned if all the above verdicts are not FAIL.

Closes #27726


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

Signed-off-by: Francis <colifran@amazon.com>
@aws-cdk-automation aws-cdk-automation requested a review from a team October 30, 2023 23:53
@github-actions github-actions bot added feature-request A feature should be added or improved. p2 labels Oct 30, 2023
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Oct 30, 2023
@aws-cdk-automation aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Oct 31, 2023
@MrArnoldPalmer MrArnoldPalmer added the pr/do-not-merge This PR should not be merged at this time. label Oct 31, 2023
Copy link
Contributor

@MrArnoldPalmer MrArnoldPalmer left a comment

Choose a reason for hiding this comment

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

approved with DNM just for my little refactor if you want it, not a hard requirement.

Comment on lines 4 to 26
test('drop spam when spf verdict status is FAIL', async () => {
const sesEvent = createSesEvent({ spf: { status: 'FAIL' } });
const response = await handler(sesEvent);
expect(response).toEqual({ disposition: 'STOP_RULE_SET' });
});

test('drop spam when dkim verdict status is FAIL', async () => {
const sesEvent = createSesEvent({ dkim: { status: 'FAIL' } });
const response = await handler(sesEvent);
expect(response).toEqual({ disposition: 'STOP_RULE_SET' });
});

test('drop spam when spam verdict status is FAIL', async () => {
const sesEvent = createSesEvent({ spam: { status: 'FAIL' } });
const response = await handler(sesEvent);
expect(response).toEqual({ disposition: 'STOP_RULE_SET' });
});

test('drop spam when virus verdict status is FAIL', async () => {
const sesEvent = createSesEvent({ virus: { status: 'FAIL' } });
const response = await handler(sesEvent);
expect(response).toEqual({ disposition: 'STOP_RULE_SET' });
});
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
test('drop spam when spf verdict status is FAIL', async () => {
const sesEvent = createSesEvent({ spf: { status: 'FAIL' } });
const response = await handler(sesEvent);
expect(response).toEqual({ disposition: 'STOP_RULE_SET' });
});
test('drop spam when dkim verdict status is FAIL', async () => {
const sesEvent = createSesEvent({ dkim: { status: 'FAIL' } });
const response = await handler(sesEvent);
expect(response).toEqual({ disposition: 'STOP_RULE_SET' });
});
test('drop spam when spam verdict status is FAIL', async () => {
const sesEvent = createSesEvent({ spam: { status: 'FAIL' } });
const response = await handler(sesEvent);
expect(response).toEqual({ disposition: 'STOP_RULE_SET' });
});
test('drop spam when virus verdict status is FAIL', async () => {
const sesEvent = createSesEvent({ virus: { status: 'FAIL' } });
const response = await handler(sesEvent);
expect(response).toEqual({ disposition: 'STOP_RULE_SET' });
});
test.each([ 'spf', 'dkim', 'spam', 'virus'])('drop spam when %s status is FAIL', (key) => {
const sesEvent = createSesEvent({ [key]: { status: 'FAIL' } });
const response = await handler(sesEvent);
expect(response).toEqual({ disposition: 'STOP_RULE_SET' });
});

Just nitpicking

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good suggestion. Updated.

@aws-cdk-automation aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Oct 31, 2023
colifran and others added 2 commits November 2, 2023 17:41
Signed-off-by: Francis <colifran@amazon.com>
@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

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

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

@colifran colifran removed the pr/do-not-merge This PR should not be merged at this time. label Nov 3, 2023
Copy link
Contributor

mergify bot commented Nov 3, 2023

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 12fe361 into main Nov 3, 2023
15 checks passed
@mergify mergify bot deleted the colifran/drop-spam-tests branch November 3, 2023 01:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution/core This is a PR that came from AWS. feature-request A feature should be added or improved. p2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

(ses): create unit tests for drop spam handler
3 participants