refactor(event_source): convert functional tests to unit tests #2506

leandrodamascena · 2023-06-20T18:38:37Z

Issue number: #509

Summary

Changes

This pull request aims to enhance the test structure and organization within the event_source_data_classes module. By breaking down the existing tests into smaller, more focused units, this refactor improves the maintainability and readability of the codebase. The test_data_class.py file had more than 2k LOC and it was becoming impossible to maintain it, so I divided it into small tests to make it easier to maintain.

I've also changed function tests to unit tests, which makes more sense for the type of testing we're doing. Just to explain a little more, these tests specifically test whether given an event source, Powertools can turn it into an object.

User experience

There is no change in the user experience.

Checklist

If your change doesn't seem to apply, please leave them unchecked.

Meet tenets criteria
I have performed a self-review of this change
Changes have been tested
Changes are documented
PR title follows conventional commit semantics

Is this a breaking change?

RFC issue number:

Checklist:

Migration process documented
Implement warnings (if it can live side by side)

Acknowledgment

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

…adability

codecov-commenter · 2023-06-20T18:43:27Z

Codecov Report

Patch coverage: 100.00% and project coverage change: +0.01 🎉

Comparison is base (9042039) 97.20% compared to head (56dbb51) 97.21%.

❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #2506      +/-   ##
===========================================
+ Coverage    97.20%   97.21%   +0.01%     
===========================================
  Files          158      158              
  Lines         7358     7365       +7     
  Branches       534      537       +3     
===========================================
+ Hits          7152     7160       +8     
+ Misses         159      158       -1     
  Partials        47       47

Impacted Files	Coverage Δ
...wertools/utilities/data_classes/active_mq_event.py	`100.00% <100.00%> (ø)`
...a_powertools/utilities/data_classes/kafka_event.py	`98.57% <100.00%> (+1.60%)`	⬆️

... and 2 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

github-actions · 2023-06-21T12:54:50Z

⚠️Large PR detected⚠️

Please consider breaking into smaller PRs to avoid significant review delays. Ignore if this PR has naturally grown to this size after reviews.

heitorlessa · 2023-06-21T13:13:29Z

looking 👀

heitorlessa · 2023-06-21T13:14:46Z

@leandrodamascena PR body can be improved - add a note about functional -> unit, before/after (functional -> unit change for a single test), etc.

heitorlessa

I'm so so happy we're finally getting this tech debt done - THANK YOU.

Two major changes before merging:

We need a functional test for @event_source decorator
Split raw_event from parsed_event in every example, and assert whether parsed_event.<property> has the same data as the raw_event[<property>]

tests/unit/data_classes/test_api_gateway_proxy_event.py

leandrodamascena · 2023-06-21T14:43:49Z

@leandrodamascena PR body can be improved - add a note about functional -> unit, before/after (functional -> unit change for a single test), etc.

Can you check again please?

github-actions · 2023-06-21T19:10:34Z

⚠️Large PR detected⚠️

Please consider breaking into smaller PRs to avoid significant review delays. Ignore if this PR has naturally grown to this size after reviews.

heitorlessa

found a hidden bug in ActiveMQ implementation of message property when reviewing an older assertion it was doing.

We need to search for other uses of generators with next() in properties, as it'll lead to the same problem.

tests/unit/data_classes/test_active_mq_event.py

aws_lambda_powertools/utilities/data_classes/active_mq_event.py

aws_lambda_powertools/utilities/data_classes/kafka_event.py

github-actions · 2023-06-23T15:52:53Z

⚠️Large PR detected⚠️

Please consider breaking into smaller PRs to avoid significant review delays. Ignore if this PR has naturally grown to this size after reviews.

github-actions · 2023-06-23T15:52:57Z

⚠️Large PR detected⚠️

Please consider breaking into smaller PRs to avoid significant review delays. Ignore if this PR has naturally grown to this size after reviews.

github-actions · 2023-06-23T15:52:58Z

⚠️Large PR detected⚠️

Please consider breaking into smaller PRs to avoid significant review delays. Ignore if this PR has naturally grown to this size after reviews.

github-actions · 2023-06-23T15:53:01Z

⚠️Large PR detected⚠️

Please consider breaking into smaller PRs to avoid significant review delays. Ignore if this PR has naturally grown to this size after reviews.

github-actions · 2023-06-23T15:53:02Z

⚠️Large PR detected⚠️

Please consider breaking into smaller PRs to avoid significant review delays. Ignore if this PR has naturally grown to this size after reviews.

heitorlessa

🚀 ⛴️

Mypy is failing

heitorlessa · 2023-06-23T16:45:07Z

Just need to fix the typing for self._messages and records because they're being inferred as None, then assigned a generator later

…owertools#2506)

ci(event_source): Splitting tests for improved maintainability and re…

8e4812b

…adability

leandrodamascena linked an issue Jun 20, 2023 that may be closed by this pull request

Maintenance: Break down event_source_data_classes tests #509

Closed

leandrodamascena changed the title ~~ci(event_source): breaking down event_source_data_classes tests~~ tests(event_source): breaking down event_source_data_classes tests Jun 20, 2023

tests: removing files

15169c6

leandrodamascena added 2 commits June 20, 2023 19:52

tests: moving to unit tests

1f0f3c0

tests: codecoverage

8323cb9

leandrodamascena requested a review from heitorlessa June 21, 2023 08:09

Merge branch 'develop' into techdebt/event_source_tests

7347b7d

heitorlessa changed the title ~~tests(event_source): breaking down event_source_data_classes tests~~ refactor(event_source): breaking down event_source_data_classes tests Jun 21, 2023

github-actions bot added the enhancement label Jun 21, 2023

heitorlessa added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Jun 21, 2023

heitorlessa mentioned this pull request Jun 21, 2023

Maintenance: Pull requests automation failing after migration #2511

Closed

2 tasks

heitorlessa suggested changes Jun 21, 2023

View reviewed changes

tests/unit/data_classes/test_api_gateway_proxy_event.py Outdated Show resolved Hide resolved

leandrodamascena added 10 commits June 21, 2023 16:34

tests: fix data class events

f6543ba

refactor: active mq

3031acb

refactor: alb event

279a5f6

refactor: rabbitmq event

cf6a07c

refactor: api gatewa authorizer

cc79fa9

refactor: api gateway proxy

95db001

refactor: appsync direct

dbadb82

refactor: cloudwatch widget

4c990d6

refactor: connect contact

2ef31f9

refactor: event bridge

d78e015

boring-cyborg bot added the tests label Jun 21, 2023

heitorlessa suggested changes Jun 22, 2023

View reviewed changes

tests/unit/data_classes/test_active_mq_event.py Outdated Show resolved Hide resolved

refactor: addressing Heitor's feedback

d8b2739

leandrodamascena requested a review from a team as a code owner June 22, 2023 17:32

leandrodamascena requested a review from heitorlessa June 22, 2023 17:35

heitorlessa reviewed Jun 23, 2023

View reviewed changes

aws_lambda_powertools/utilities/data_classes/active_mq_event.py Show resolved Hide resolved

heitorlessa reviewed Jun 23, 2023

View reviewed changes

aws_lambda_powertools/utilities/data_classes/active_mq_event.py Show resolved Hide resolved

heitorlessa reviewed Jun 23, 2023

View reviewed changes

aws_lambda_powertools/utilities/data_classes/kafka_event.py Outdated Show resolved Hide resolved

boring-cyborg bot added commons dependencies Pull requests that update a dependency file documentation Improvements or additions to documentation event_handlers github-actions Pull requests that update Github_actions code labels Jun 23, 2023

leandrodamascena force-pushed the techdebt/event_source_tests branch from 26ae39c to d8b2739 Compare June 23, 2023 16:05

leandrodamascena added 2 commits June 23, 2023 17:07

Merge branch 'develop' into techdebt/event_source_tests

56dbb51

feature: addressing Heitor's feedback

c162ea7

leandrodamascena requested a review from heitorlessa June 23, 2023 16:34

heitorlessa previously approved these changes Jun 23, 2023

View reviewed changes

leandrodamascena added 2 commits June 23, 2023 17:52

feature: mypy error

f39c81d

feature: mypy error

468da93

heitorlessa approved these changes Jun 23, 2023

View reviewed changes

heitorlessa changed the title ~~refactor(event_source): breaking down event_source_data_classes tests~~ refactor(event_source): convert functional tests to unit tests Jun 23, 2023

heitorlessa merged commit b1b835b into aws-powertools:develop Jun 23, 2023

rafaelgsr pushed a commit to rafaelgsr/aws-lambda-powertools-python that referenced this pull request Jun 30, 2023

refactor(event_source): convert functional tests to unit tests (aws-p…

793b55b

…owertools#2506)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor(event_source): convert functional tests to unit tests #2506

refactor(event_source): convert functional tests to unit tests #2506

leandrodamascena commented Jun 20, 2023 •

edited

Loading

codecov-commenter commented Jun 20, 2023 •

edited

Loading

github-actions bot commented Jun 21, 2023

heitorlessa commented Jun 21, 2023

heitorlessa commented Jun 21, 2023

heitorlessa left a comment

leandrodamascena commented Jun 21, 2023

github-actions bot commented Jun 21, 2023

heitorlessa left a comment

github-actions bot commented Jun 23, 2023

github-actions bot commented Jun 23, 2023

github-actions bot commented Jun 23, 2023

github-actions bot commented Jun 23, 2023

github-actions bot commented Jun 23, 2023

heitorlessa left a comment

heitorlessa commented Jun 23, 2023

refactor(event_source): convert functional tests to unit tests #2506

refactor(event_source): convert functional tests to unit tests #2506

Conversation

leandrodamascena commented Jun 20, 2023 • edited Loading

Summary

Changes

User experience

Checklist

Acknowledgment

codecov-commenter commented Jun 20, 2023 • edited Loading

Codecov Report

github-actions bot commented Jun 21, 2023

⚠️Large PR detected⚠️

heitorlessa commented Jun 21, 2023

heitorlessa commented Jun 21, 2023

heitorlessa left a comment

Choose a reason for hiding this comment

leandrodamascena commented Jun 21, 2023

github-actions bot commented Jun 21, 2023

⚠️Large PR detected⚠️

heitorlessa left a comment

Choose a reason for hiding this comment

github-actions bot commented Jun 23, 2023

⚠️Large PR detected⚠️

github-actions bot commented Jun 23, 2023

⚠️Large PR detected⚠️

github-actions bot commented Jun 23, 2023

⚠️Large PR detected⚠️

github-actions bot commented Jun 23, 2023

⚠️Large PR detected⚠️

github-actions bot commented Jun 23, 2023

⚠️Large PR detected⚠️

heitorlessa left a comment

Choose a reason for hiding this comment

heitorlessa commented Jun 23, 2023

leandrodamascena commented Jun 20, 2023 •

edited

Loading

codecov-commenter commented Jun 20, 2023 •

edited

Loading