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

🚨🚨 Source Amplitude: migrate to YAML #22362

Merged
merged 28 commits into from
Apr 13, 2023
Merged
Show file tree
Hide file tree
Changes from 21 commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
4e5a7b4
Source Amplitude: migrate to YAML
artem1205 Feb 3, 2023
2372f21
Source Amplitude: enable high strictness level
artem1205 Feb 3, 2023
4b92708
Source Amplitude: update docs
artem1205 Feb 3, 2023
31d2f51
Source Amplitude: update cursor field + expected records
artem1205 Feb 3, 2023
1e64c83
Source Amplitude: logging refactor
artem1205 Feb 3, 2023
3cd1dd3
Source Amplitude: refactor extractors
artem1205 Feb 3, 2023
0b849fb
Source Amplitude: refactor extractors
artem1205 Feb 5, 2023
6013303
Merge branch 'master' into artem1205/source-amplitude-migrate-to-YAML…
artem1205 Feb 16, 2023
1328b18
Source Amplitude: migrate to beta low-code
artem1205 Feb 16, 2023
597c6d5
Source Amplitude: add docstring
artem1205 Feb 16, 2023
5e6f42e
Source Amplitude: fix unit tests
artem1205 Feb 16, 2023
3304d17
Source Amplitude: update expected records
artem1205 Feb 16, 2023
170a6ff
Merge branch 'master' into artem1205/source-amplitude-migrate-to-YAML…
artem1205 Feb 22, 2023
381c9b2
Source Amplitude: fix response filter action
artem1205 Feb 22, 2023
0a9a2ab
Source Amplitude: rename typo
artem1205 Feb 22, 2023
7b2114f
Merge branch 'master' into artem1205/source-amplitude-migrate-to-YAML…
artem1205 Feb 23, 2023
7f77a69
Source Amplitude: fix migration
artem1205 Feb 23, 2023
5370a24
Source Amplitude: update docs
artem1205 Feb 23, 2023
91404c8
Source Amplitude: fix migration
artem1205 Feb 23, 2023
d58385b
Source Amplitude: update expected recrods
artem1205 Feb 23, 2023
5efca3a
Merge branch 'master' into artem1205/source-amplitude-migrate-to-YAML…
artem1205 Feb 23, 2023
b10ea98
Merge branch 'master' into artem1205/source-amplitude-migrate-to-YAML…
artem1205 Apr 3, 2023
dff40a6
Source Amplitude: bump manifest version
artem1205 Apr 3, 2023
ce9147f
Merge branch 'master' into artem1205/source-amplitude-migrate-to-YAML…
artem1205 Apr 12, 2023
919218d
Automated Change
artem1205 Apr 12, 2023
9a0f38f
Source Amplitude: Update http -> https
artem1205 Apr 13, 2023
044cbac
Source Amplitude: tests fix + pin cdk version
artem1205 Apr 13, 2023
83c4b3f
auto-bump connector version
octavia-squidington-iii Apr 13, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,8 @@
releaseStage: generally_available
allowedHosts:
hosts:
- "*.amplitude.com"
- amplitude.com
- analytics.eu.amplitude.com
- name: Apify Dataset
sourceDefinitionId: 47f17145-fe20-4ef5-a548-e29b048adf84
dockerRepository: airbyte/source-apify-dataset
Expand Down
36 changes: 29 additions & 7 deletions airbyte-integrations/connectors/source-amplitude/Dockerfile
Original file line number Diff line number Diff line change
@@ -1,16 +1,38 @@
FROM python:3.9-slim
FROM python:3.9.11-alpine3.15 as base

# build and load all requirements
FROM base as builder
WORKDIR /airbyte/integration_code

# upgrade pip to the latest version
RUN apk --no-cache upgrade \
&& pip install --upgrade pip \
&& apk --no-cache add tzdata build-base

# Bash is installed for more convenient debugging.
RUN apt-get update && apt-get install -y bash && rm -rf /var/lib/apt/lists/*

COPY setup.py ./
# install necessary packages to a temporary folder
RUN pip install --prefix=/install .

# build a clean environment
FROM base
WORKDIR /airbyte/integration_code
COPY source_amplitude ./source_amplitude

# copy all loaded and built libraries to a pure basic image
COPY --from=builder /install /usr/local
# add default timezone settings
COPY --from=builder /usr/share/zoneinfo/Etc/UTC /etc/localtime
RUN echo "Etc/UTC" > /etc/timezone

# bash is installed for more convenient debugging.
RUN apk --no-cache add bash

# copy payload code only
COPY main.py ./
COPY setup.py ./
RUN pip install .
COPY source_amplitude ./source_amplitude

ENV AIRBYTE_ENTRYPOINT "python /airbyte/integration_code/main.py"
ENTRYPOINT ["python", "/airbyte/integration_code/main.py"]

LABEL io.airbyte.version=0.1.22
LABEL io.airbyte.version=0.2.0
LABEL io.airbyte.name=airbyte/source-amplitude
64 changes: 8 additions & 56 deletions airbyte-integrations/connectors/source-amplitude/README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,10 @@
# Amplitude Source

This is the repository for the Amplitude source connector, written in Python.
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/sources/amplitude).
This is the repository for the Amplitude configuration based source connector.
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/amplitude).

## Local development

### Prerequisites
**To iterate on this connector, make sure to complete this prerequisites section.**

#### 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
```
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.

Expand All @@ -36,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/amplitude)
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_amplitude/spec.json` file.
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/amplitude)
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_amplitude/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 amplitude 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
Expand All @@ -76,33 +46,15 @@ docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-amplitude:dev discover
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-amplitude: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:
```
docker build . --no-cache -t airbyte/source-amplitude:dev \
&& python -m pytest -p connector_acceptance_test.plugin
./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.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
#
# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
#


def test_example():
assert True
Original file line number Diff line number Diff line change
@@ -1,35 +1,42 @@
# See [Connector Acceptance Tests](https://docs.airbyte.io/connector-development/testing-connectors/connector-acceptance-tests-reference)
# for more information about how to configure these tests
connector_image: airbyte/source-amplitude:dev
test_strictness_level: high
acceptance_tests:
spec:
tests:
- spec_path: "source_amplitude/spec.json"
- spec_path: "source_amplitude/spec.yaml"
connection:
tests:
- config_path: "secrets/config.json"
status: "succeed"
- config_path: "integration_tests/invalid_config.json"
status: "failed"
- config_path: "secrets/config.json"
status: "succeed"
- config_path: "integration_tests/invalid_config.json"
status: "failed"
discovery:
tests:
- config_path: "secrets/config.json"
- config_path: "secrets/config.json"
backward_compatibility_tests_config:
disable_for_version: 0.1.22 # cursor field for stream events has been changed
basic_read:
tests:
- config_path: "secrets/config.json"
expect_records:
path: "integration_tests/expected_records.jsonl"
empty_streams:
- name: "cohorts"
bypass_reason: "This stream is empty due to free subscription plan for the sandbox."
- name: "annotations"
bypass_reason: "This stream is empty due to free subscription plan for the sandbox."
full_refresh:
tests:
- config_path: "secrets/config.json"
configured_catalog_path: "integration_tests/configured_catalog.json"
expect_records:
path: "integration_tests/expected_records.jsonl"
extra_fields: no
exact_order: no
extra_records: yes
incremental:
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:
tests:
- config_path: "secrets/config.json"
configured_catalog_path: "integration_tests/configured_catalog.json"
4 changes: 2 additions & 2 deletions airbyte-integrations/connectors/source-amplitude/acceptance-test-docker.sh
100644 → 100755
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
#!/usr/bin/env sh

# Build latest connector image
docker build . -t $(cat acceptance-test-config.yml | grep "connector_image" | head -n 1 | cut -d: -f2)
docker build . -t $(cat acceptance-test-config.yml | grep "connector_image" | head -n 1 | cut -d: -f2-)

# Pull latest acctest image
# Pull latest acceptance test image
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: Can we either not make this change or apply it to all connectors (in a separate PR) for the sake of consistency?

docker pull airbyte/connector-acceptance-test:latest

# Run
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,21 @@
{
"type": "STREAM",
"stream": {
"stream_state": { "event_time": "2025-02-15 08:00:00.000000" },
"stream_state": { "server_upload_time": "2100-01-01T00:00:00.00+00:00" },
"stream_descriptor": { "name": "events" }
}
},
{
"type": "STREAM",
"stream": {
"stream_state": { "date": "2025-02-17" },
"stream_state": { "date": "2100-01-01" },
"stream_descriptor": { "name": "active_users" }
}
},
{
"type": "STREAM",
"stream": {
"stream_state": { "date": "2025-02-17" },
"stream_state": { "date": "2100-01-01" },
"stream_descriptor": { "name": "average_session_length" }
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,12 +52,12 @@
"json_schema": {},
"supported_sync_modes": ["full_refresh", "incremental"],
"source_defined_cursor": true,
"default_cursor_field": ["event_time"],
"default_cursor_field": ["server_upload_time"],
"source_defined_primary_key": [["uuid"]]
},
"sync_mode": "incremental",
"destination_sync_mode": "append",
"cursor_field": ["event_time"]
"cursor_field": ["server_upload_time"]
}
]
}
Loading