✨Source MailGun: Migrate Python CDK to Low-code CDK (#29122)

Co-authored-by: Marcos Marx <marcosmarxm@users.noreply.github.com> Co-authored-by: Sajarin <sajarindider@gmail.com>

Author: 3 people

airbyte-integrations/connectors/source-mailgun/Dockerfile

@@ -34,5 +34,5 @@ COPY source_mailgun ./source_mailgun
 ENV AIRBYTE_ENTRYPOINT "python /airbyte/integration_code/main.py"
 ENTRYPOINT ["python", "/airbyte/integration_code/main.py"]
 
-LABEL io.airbyte.version=0.1.1
+LABEL io.airbyte.version=0.2.0
 LABEL io.airbyte.name=airbyte/source-mailgun

airbyte-integrations/connectors/source-mailgun/README.md

@@ -1,35 +1,10 @@
 # Mailgun Source
 
-This is the repository for the Mailgun source connector, written in Python.
-For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/sources/mailgun).
+This is the repository for the Mailgun configuration based source connector.
+For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/mailgun).
 
 ## Local development
 
-### Prerequisites
-**To iterate on this connector, make sure to complete this prerequisites section.**
-
-#### Minimum Python version required `= 3.7.0`
-
-#### Build & Activate Virtual Environment and install dependencies
-From this connector directory, create a virtual environment:
-```
-python -m venv .venv
-```
-
-This will generate a virtualenv for this module in `.venv/`. Make sure this venv is active in your
-development environment of choice. To activate it from the terminal, run:
-```
-source .venv/bin/activate
-pip install -r requirements.txt
-pip install '.[tests]'
-```
-If you are in an IDE, follow your IDE's instructions to activate the virtualenv.
-
-Note that while we are installing dependencies from `requirements.txt`, you should only edit `setup.py` for your dependencies. `requirements.txt` is
-used for editable installs (`pip install -e`) to pull in Python dependencies from the monorepo and will call `setup.py`.
-If this is mumbo jumbo to you, don't worry about it, just put your deps in `setup.py` but install using `pip install -r requirements.txt` and everything
-should work as you expect.
-
 #### Building via Gradle
 You can also build the connector in Gradle. This is typically used in CI and not needed for your development workflow.
 
@@ -39,22 +14,14 @@ To build using Gradle, from the Airbyte repository root, run:
 ```
 
 #### Create credentials
-**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/sources/mailgun)
-to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_mailgun/spec.json` file.
+**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/mailgun)
+to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_mailgun/spec.yaml` file.
 Note that any directory named `secrets` is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information.
 See `integration_tests/sample_config.json` for a sample config file.
 
 **If you are an Airbyte core member**, copy the credentials in Lastpass under the secret name `source mailgun test creds`
 and place them into `secrets/config.json`.
 
-### Locally running the connector
-```
-python main.py spec
-python main.py check --config secrets/config.json
-python main.py discover --config secrets/config.json
-python main.py read --config secrets/config.json --catalog integration_tests/configured_catalog.json
-```
-
 ### Locally running the connector docker image
 
 #### Build
@@ -79,32 +46,15 @@ docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-mailgun:dev discover -
 docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-mailgun:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json
 ```
 ## Testing
-Make sure to familiarize yourself with [pytest test discovery](https://docs.pytest.org/en/latest/goodpractices.html#test-discovery) to know how your test files and methods should be named.
-First install test dependencies into your virtual environment:
-```
-pip install .[tests]
-```
-### Unit Tests
-To run unit tests locally, from the connector directory run:
-```
-python -m pytest unit_tests
-```
 
-### Integration Tests
-There are two types of integration tests: Acceptance Tests (Airbyte's test suite for all source connectors) and custom integration tests (which are specific to this connector).
-#### Custom Integration tests
-Place custom tests inside `integration_tests/` folder, then, from the connector root, run
-```
-python -m pytest integration_tests
-```
 #### Acceptance Tests
-Customize `acceptance-test-config.yml` file to configure tests. See [Connector Acceptance Tests](https://docs.airbyte.io/connector-development/testing-connectors/connector-acceptance-tests-reference) for more information.
+Customize `acceptance-test-config.yml` file to configure tests. See [Connector Acceptance Tests](https://docs.airbyte.com/connector-development/testing-connectors/connector-acceptance-tests-reference) for more information.
 If your connector requires to create or destroy resources for use during acceptance tests create fixtures for it and place them inside integration_tests/acceptance.py.
-To run your integration tests with acceptance tests, from the connector root, run
+
+To run your integration tests with Docker, run:
 ```
-python -m pytest integration_tests -p integration_tests.acceptance
+./acceptance-test-docker.sh
 ```
-To run your integration tests with docker
 
 ### Using gradle to run tests
 All commands should be run from airbyte project root.

airbyte-integrations/connectors/source-mailgun/__init__.py

@@ -0,0 +1,3 @@
+#
+# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
+#

airbyte-integrations/connectors/source-mailgun/acceptance-test-config.yml

@@ -1,24 +1,41 @@
-# See [Connector Acceptance Tests](https://docs.airbyte.com/connector-development/testing-connectors/connector-acceptance-tests-reference)
-# for more information about how to configure these tests
 connector_image: airbyte/source-mailgun:dev
-tests:
+acceptance_tests:
  spec:
- - spec_path: "source_mailgun/spec.json"
+ tests:
+ - spec_path: "source_mailgun/spec.yaml"
+ backward_compatibility_tests_config:
+ disable_for_version: 0.1.1
  connection:
- - config_path: "secrets/config.json"
- status: "succeed"
- - config_path: "integration_tests/invalid_config.json"
- status: "failed"
+ tests:
+ - config_path: "secrets/config.json"
+ status: "succeed"
+ - config_path: "integration_tests/invalid_config.json"
+ status: "failed"
  discovery:
- - config_path: "secrets/config.json"
+ tests:
+ - config_path: "secrets/config.json"
+ backward_compatibility_tests_config:
+ disable_for_version: 0.1.1
  basic_read:
- - config_path: "secrets/config.json"
- configured_catalog_path: "integration_tests/configured_catalog.json"
- empty_streams: []
- incremental:
- - config_path: "secrets/config.json"
- configured_catalog_path: "integration_tests/configured_catalog.json"
- future_state_path: "integration_tests/abnormal_state.json"
+ tests:
+ - config_path: "secrets/config.json"
+ configured_catalog_path: "integration_tests/configured_catalog.json"
+ empty_streams:
+ - name: events
+ bypass_reason: "Sandbox account can't seed this stream"
+# expect_records:
+# path: "integration_tests/expected_records.jsonl"
+# extra_fields: no
+# exact_order: no
+# extra_records: yes
+ incremental: 
+ bypass_reason: "This connector does not implement incremental sync"
+# tests:
+# - config_path: "secrets/config.json"
+# configured_catalog_path: "integration_tests/configured_catalog.json"
+# future_state:
+# future_state_path: "integration_tests/abnormal_state.json"
  full_refresh:
- - config_path: "secrets/config.json"
- configured_catalog_path: "integration_tests/configured_catalog.json"
+ tests:
+ - config_path: "secrets/config.json"
+ configured_catalog_path: "integration_tests/configured_catalog.json"

airbyte-integrations/connectors/source-mailgun/acceptance-test-docker.sh

@@ -1,2 +1,3 @@
 #!/usr/bin/env sh
+
 source "$(git rev-parse --show-toplevel)/airbyte-integrations/bases/connector-acceptance-test/acceptance-test-docker.sh"

airbyte-integrations/connectors/source-mailgun/integration_tests/__init__.py

@@ -1,3 +1,3 @@
 #
-# Copyright (c) 2021 Airbyte, Inc., all rights reserved.
+# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
 #

airbyte-integrations/connectors/source-mailgun/integration_tests/acceptance.py

@@ -2,59 +2,12 @@
 # Copyright (c) 2023 Airbyte, Inc., all rights reserved.
 #
 
-import datetime
-import json
-import os.path
-from typing import Any, Dict, Iterable
 
 import pytest
 
-from .fill_data import DataFiller
-
 pytest_plugins = ("connector_acceptance_test.plugin",)
 
 
-class Config:
-
- messages_per_sender: int = 5
- min_update_interval: int = datetime.timedelta(2).total_seconds() # 2 days
-
- recipients: Iterable[str] = [
- "integration-test@airbyte.io",
- ]
- senders: Iterable[str] = [
- "Ann",
- "Bob",
- "Carl",
- ]
-
- test_data_file_path: str = os.path.join(os.path.dirname(__file__), "test_data.json")
-
- @classmethod
- def get_test_data(cls) -> Dict[str, Any]:
- with open(cls.test_data_file_path) as tdf:
- return json.load(tdf)
-
- @classmethod
- def update_timestamp(cls, timestamp: float):
- test_data = cls.get_test_data()
- test_data.update({"last_update_timestamp": timestamp})
- with open(cls.test_data_file_path, "w") as tdf:
- json.dump(test_data, tdf)
-
-
 @pytest.fixture(scope="session", autouse=True)
 def connector_setup():
- """
- Fill the sandbox with fresh data by sending simple text-only messages.
- """
- config = Config
- now = datetime.datetime.now().timestamp()
- if config.get_test_data()["last_update_timestamp"] + config.min_update_interval <= now:
- data_filler: DataFiller = DataFiller(
- from_emails=config.senders, to=config.recipients, number_of_messages=config.messages_per_sender
- )
- data_filler.fill()
- config.update_timestamp(now)
-
  yield

airbyte-integrations/connectors/source-mailgun/integration_tests/fill_data.py

@@ -1,3 +1,5 @@
 {
- "private_key": "test-api-key"
+ "private_key": "xxx17ec8cf955c450b20d02454d04xxxxxxx34xxxxxxx9dxxx",
+ "domain_region": "us",
+ "start_date": "2023-08-01T00:00:00Z"
 }

airbyte-integrations/connectors/source-mailgun/integration_tests/sample_config.json

@@ -0,0 +1,5 @@
+{
+ "todo-stream-name": {
+ "todo-field-name": "value"
+ }
+}