🎉 Source Mixpanel: Increase unit test coverage #11633

itaseskii · 2022-03-31T16:28:51Z

What

Increases unit test coverage for the existing Mixpanel streams

How

Using pytest

🚨 User Impact 🚨

Are there any breaking changes? What is the end result perceived by the user? If yes, please merge this PR with the 🚨🚨 emoji so changelog authors can further highlight this if needed.

Pre-merge Checklist

Expand the relevant checklist and delete the others.

New Connector

Community member or Airbyter

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

Create a non-forked branch based on this PR and test the below items on it
Build is successful
If new credentials are required for use in CI, add them to GSM. Instructions.
/test connector=connectors/<name> command is passing
New Connector version released on Dockerhub by running the /publish command described here
After the connector is published, connector added to connector index as described here
Seed specs have been re-generated by building the platform and committing the changes to the seed spec files, as described here

Updating a connector

Community member or Airbyter

Grant edit access to maintainers (instructions)
Secrets in the connector's spec are annotated with airbyte_secret
Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
Code reviews completed
Documentation updated
- Connector's README.md
- Connector's bootstrap.md. See description and examples
- Changelog updated in docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
PR name follows PR naming conventions

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

Create a non-forked branch based on this PR and test the below items on it
Build is successful
If new credentials are required for use in CI, add them to GSM. Instructions.
/test connector=connectors/<name> command is passing
New Connector version released on Dockerhub by running the /publish command described here
After the new connector version is published, connector version bumped in the seed directory as described here
Seed specs have been re-generated by building the platform and committing the changes to the seed spec files, as described here

Connector Generator

Issue acceptance criteria met
PR name follows PR naming conventions
If adding a new generator, add it to the list of scaffold modules being tested
The generator test modules (all connectors with -scaffold in their name) have been updated with the latest scaffold by running ./gradlew :airbyte-integrations:connector-templates:generator:testScaffoldTemplates then checking in your changes
Documentation which references the generator is updated as needed

Tests

Unit

Put your unit tests output here.

Integration

Put your integration tests output here.

Acceptance

Put your acceptance tests output here.

alafanechere · 2022-03-31T19:59:22Z

Hi @itaseskii,
Thank you for this contribution!
Before I go for a first review, could you please do the following:

🚨 Check the API key you set in the config is not a valid one, otherwise please rotate this key because it could be compromised.
Share the motivation behind this PR
Bump the connector version in the Dockerfile and in the source_definitions.yaml
Update the changelog in mixpanel.md

itaseskii · 2022-03-31T20:36:11Z

Hi @alafanechere,

No worries, the value was randomly generated by me with the intention to look like a real secret.
The motivation is to increase the unit test coverage of the Mixpanel connector.
bumped to 0.1.10
done

alafanechere · 2022-03-31T20:41:26Z

The motivation is to increase the unit test coverage of the Mixpanel connector.

Yes this is great, but I meant what was the motivation behind writing these tests, why do you think this test is a required addition. I have no doubt in that it's a good approach but I'd like to know in order to make an enlightened review.

alafanechere · 2022-03-31T20:42:51Z

/test connector=connectors/source-mixpanel

🕑 connectors/source-mixpanel https://github.com/airbytehq/airbyte/actions/runs/2073508364
❌ connectors/source-mixpanel https://github.com/airbytehq/airbyte/actions/runs/2073508364
🐛 https://gradle.com/s/csv7kkeqpdey2
Python short test summary info:

=========================== short test summary info ============================
FAILED test_incremental.py::TestIncremental::test_two_sequential_reads[inputs0]
SKIPPED [1] ../usr/local/lib/python3.7/site-packages/source_acceptance_test/tests/test_incremental.py:21: `future_state_path` not specified, skipping
============= 1 failed, 20 passed, 1 skipped in 3211.64s (0:53:31) =============

alafanechere

Just made a quick high-level review first. I'll dive into a more complete later.

alafanechere · 2022-03-31T20:45:58Z

airbyte-integrations/connectors/source-mixpanel/unit_tests/conftest.py

+import pendulum
+import pytest
+
+


conftest.py is generally used to store fixtures that are reused by multiple test modules. I think these fixtures can be directly defined in test_sourceand test_stream.

To be honest I prefer to keep test classes clean of any mock responses and dto objects. Should we maybe move it to a different file i.e mockresponse.py?

I find it more convenient to have the fixture in the same file as the tests to understand how they are built. Feel free to create a module for your fixture if you like, but if the fixtures are not re-used, and only use in a specific test context, I don't find it necessary.

I have went with your suggestion and I have moved the fixtures in the test classes where they are used :)

Thanks, could you please declare the fixtures before the tests where they are used.

airbyte-integrations/connectors/source-mixpanel/unit_tests/conftest.py

airbyte-integrations/connectors/source-mixpanel/unit_tests/test_source.py

itaseskii · 2022-03-31T20:50:40Z

Two reasons basically.

Unit test coverage was low for this connector and in order to avoid regressions and ensure correctness it is better if the code has higher percentage of unit test coverage. The prior tests were only testing the stream_slices method for the streams. This PR aims to have a more complete approach by testing the ability of each stream to send requests and handle responses.
This improvement was required as part of the maintainer program Source Mixpanel Feature/Bug Hub #11008

itaseskii · 2022-03-31T20:53:12Z

And I will need to bump the version again since there was another PR merged beforehand

itaseskii · 2022-04-10T20:41:14Z

@alafanechere I have resolved all the merge conflicts and I have bumped the connector version to 0.1.12

alafanechere · 2022-04-11T13:41:23Z

airbyte-integrations/connectors/source-mixpanel/unit_tests/test_source.py

+@pytest.fixture
+def empty_response_ok():
+    return setup_response(200, {})
+
+
+@pytest.fixture
+def empty_response_bad():
+    return setup_response(400, {})


Please declare the fixtures before the test in which they're used.

@alafanechere do you mean

fixture1
test1
fixture2
test2

or

fixture1
fixture2
test1
test2

fixture1
test1
fixture2
test2

alafanechere · 2022-04-11T13:42:11Z

airbyte-integrations/connectors/source-mixpanel/unit_tests/conftest.py

+import pendulum
+import pytest
+
+


Thanks, could you please declare the fixtures before the tests where they are used.

alafanechere · 2022-04-11T13:44:24Z

/test connector=connectors/source-mixpanel

🕑 connectors/source-mixpanel https://github.com/airbytehq/airbyte/actions/runs/2148892227
✅ connectors/source-mixpanel https://github.com/airbytehq/airbyte/actions/runs/2148892227
Python tests coverage:

Name                                                 Stmts   Miss  Cover
------------------------------------------------------------------------
source_acceptance_test/utils/__init__.py                 6      0   100%
source_acceptance_test/tests/__init__.py                 4      0   100%
source_acceptance_test/__init__.py                       2      0   100%
source_acceptance_test/tests/test_full_refresh.py       52      2    96%
source_acceptance_test/utils/asserts.py                 37      2    95%
source_acceptance_test/config.py                        74      6    92%
source_acceptance_test/utils/json_schema_helper.py     105     13    88%
source_acceptance_test/utils/common.py                  70     17    76%
source_acceptance_test/utils/compare.py                 62     23    63%
source_acceptance_test/tests/test_core.py              285    106    63%
source_acceptance_test/base.py                          10      4    60%
source_acceptance_test/utils/connector_runner.py       110     48    56%
source_acceptance_test/tests/test_incremental.py        69     38    45%
------------------------------------------------------------------------
TOTAL                                                  886    259    71%
Name                          Stmts   Miss  Cover
-------------------------------------------------
source_mixpanel/__init__.py       2      0   100%
source_mixpanel/source.py       304     76    75%
-------------------------------------------------
TOTAL                           306     76    75%

Python short test summary info:

=========================== short test summary info ============================
SKIPPED [1] ../usr/local/lib/python3.7/site-packages/source_acceptance_test/tests/test_incremental.py:21: `future_state_path` not specified, skipping
================== 21 passed, 1 skipped in 2973.98s (0:49:33) ==================

alafanechere · 2022-04-14T10:17:40Z

@itaseskii I made a bit of refactoring to showcase some test practices I like to use and would suggest for your future reviews / contributions.

alafanechere · 2022-04-14T13:46:56Z

/test connector=connectors/source-mixpanel

🕑 connectors/source-mixpanel https://github.com/airbytehq/airbyte/actions/runs/2167573217
✅ connectors/source-mixpanel https://github.com/airbytehq/airbyte/actions/runs/2167573217
Python tests coverage:

Name                                                 Stmts   Miss  Cover
------------------------------------------------------------------------
source_acceptance_test/utils/__init__.py                 6      0   100%
source_acceptance_test/tests/__init__.py                 4      0   100%
source_acceptance_test/__init__.py                       2      0   100%
source_acceptance_test/tests/test_full_refresh.py       52      2    96%
source_acceptance_test/utils/asserts.py                 37      2    95%
source_acceptance_test/config.py                        74      6    92%
source_acceptance_test/utils/json_schema_helper.py     105     13    88%
source_acceptance_test/utils/common.py                  70     17    76%
source_acceptance_test/utils/compare.py                 62     23    63%
source_acceptance_test/tests/test_core.py              285    106    63%
source_acceptance_test/base.py                          10      4    60%
source_acceptance_test/utils/connector_runner.py       110     48    56%
source_acceptance_test/tests/test_incremental.py        69     38    45%
------------------------------------------------------------------------
TOTAL                                                  886    259    71%
Name                          Stmts   Miss  Cover
-------------------------------------------------
source_mixpanel/__init__.py       2      0   100%
source_mixpanel/source.py       304     76    75%
-------------------------------------------------
TOTAL                           306     76    75%

Python short test summary info:

=========================== short test summary info ============================
SKIPPED [1] ../usr/local/lib/python3.7/site-packages/source_acceptance_test/tests/test_incremental.py:21: `future_state_path` not specified, skipping
================== 21 passed, 1 skipped in 2880.13s (0:48:00) ==================

alafanechere · 2022-04-15T12:16:39Z

/publish connector=connectors/source-mixpanel auto-bump-version=false

🕑 connectors/source-mixpanel https://github.com/airbytehq/airbyte/actions/runs/2172478868
🚀 Successfully published connectors/source-mixpanel
✅ connectors/source-mixpanel https://github.com/airbytehq/airbyte/actions/runs/2172478868

itaseskii · 2022-04-15T14:44:11Z

@itaseskii I made a bit of refactoring to showcase some test practices I like to use and would suggest for your future reviews / contributions.

Thanks @alafanechere I will look into them.

alafanechere

Thank you for the effort @itaseskii! Feel free to add more of this kind of PR 🙏

increase mixpanel unit test coverage

5ee0957

github-actions bot added the area/connectors Connector related issues label Mar 31, 2022

octavia-squidington-iii added the community label Mar 31, 2022

alafanechere self-assigned this Mar 31, 2022

bump version

2b40736

github-actions bot added the area/documentation Improvements or additions to documentation label Mar 31, 2022

itaseskii added 2 commits March 31, 2022 22:37

fix year in docs

346246b

Merge branch 'master' into mixpanel-unit-tests

2d87836

alafanechere requested changes Mar 31, 2022

View reviewed changes

itaseskii closed this Mar 31, 2022

itaseskii reopened this Mar 31, 2022

itaseskii added 3 commits April 5, 2022 11:29

fix suggestions

569391a

refactor test config

9846c2e

resolve conflicts

ee5712a

alafanechere requested changes Apr 11, 2022

View reviewed changes

alafanechere added 3 commits April 14, 2022 11:43

refactor tests

e18ea71

Merge branch 'master' into mixpanel-unit-tests

812e173

refactor tests

4c61237

update source spec

a8c4a28

alafanechere approved these changes Apr 15, 2022

View reviewed changes

alafanechere merged commit e4a55a4 into airbytehq:master Apr 15, 2022

octavia-squidington-iii mentioned this pull request Apr 19, 2022

Bump Airbyte version from 0.36.0-alpha to 0.36.1-alpha #12148

Merged

suhomud pushed a commit that referenced this pull request May 23, 2022

🎉 Source Mixpanel: Increase unit test coverage (#11633)

b2ecfdb

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

🎉 Source Mixpanel: Increase unit test coverage #11633

🎉 Source Mixpanel: Increase unit test coverage #11633

itaseskii commented Mar 31, 2022 •

edited by aharelick

Loading

alafanechere commented Mar 31, 2022 •

edited

Loading

itaseskii commented Mar 31, 2022

alafanechere commented Mar 31, 2022 •

edited

Loading

alafanechere commented Mar 31, 2022 •

edited by github-actions bot

Loading

alafanechere left a comment

alafanechere Mar 31, 2022

itaseskii Apr 5, 2022

alafanechere Apr 6, 2022

itaseskii Apr 10, 2022 •

edited

Loading

alafanechere Apr 11, 2022

itaseskii commented Mar 31, 2022 •

edited

Loading

itaseskii commented Mar 31, 2022

itaseskii commented Apr 10, 2022

alafanechere Apr 11, 2022

itaseskii Apr 11, 2022

alafanechere Apr 11, 2022

alafanechere Apr 11, 2022

alafanechere commented Apr 11, 2022 •

edited by github-actions bot

Loading

alafanechere commented Apr 14, 2022 •

edited

Loading

alafanechere commented Apr 14, 2022 •

edited by github-actions bot

Loading

alafanechere commented Apr 15, 2022 •

edited by github-actions bot

Loading

itaseskii commented Apr 15, 2022

alafanechere left a comment

		import pendulum
		import pytest

		import pendulum
		import pytest

🎉 Source Mixpanel: Increase unit test coverage #11633

🎉 Source Mixpanel: Increase unit test coverage #11633

Conversation

itaseskii commented Mar 31, 2022 • edited by aharelick Loading

What

How

Recommended reading order

🚨 User Impact 🚨

Pre-merge Checklist

Community member or Airbyter

Airbyter

Community member or Airbyter

Airbyter

Tests

alafanechere commented Mar 31, 2022 • edited Loading

itaseskii commented Mar 31, 2022

alafanechere commented Mar 31, 2022 • edited Loading

alafanechere commented Mar 31, 2022 • edited by github-actions bot Loading

alafanechere left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

itaseskii Apr 10, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

itaseskii commented Mar 31, 2022 • edited Loading

itaseskii commented Mar 31, 2022

itaseskii commented Apr 10, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alafanechere commented Apr 11, 2022 • edited by github-actions bot Loading

alafanechere commented Apr 14, 2022 • edited Loading

alafanechere commented Apr 14, 2022 • edited by github-actions bot Loading

alafanechere commented Apr 15, 2022 • edited by github-actions bot Loading

itaseskii commented Apr 15, 2022

alafanechere left a comment

Choose a reason for hiding this comment

itaseskii commented Mar 31, 2022 •

edited by aharelick

Loading

alafanechere commented Mar 31, 2022 •

edited

Loading

alafanechere commented Mar 31, 2022 •

edited

Loading

alafanechere commented Mar 31, 2022 •

edited by github-actions bot

Loading

itaseskii Apr 10, 2022 •

edited

Loading

itaseskii commented Mar 31, 2022 •

edited

Loading

alafanechere commented Apr 11, 2022 •

edited by github-actions bot

Loading

alafanechere commented Apr 14, 2022 •

edited

Loading

alafanechere commented Apr 14, 2022 •

edited by github-actions bot

Loading

alafanechere commented Apr 15, 2022 •

edited by github-actions bot

Loading