Skip to content

Commit d6a0d50

Browse files
alafanecherexiaohansong
alafanechere
authored and
xiaohansong
committed
✨ source-freshdesk: migrate to poetry (#35187)
1 parent a7ebd6d commit d6a0d50

File tree

6 files changed

+1107
-146
lines changed

6 files changed

+1107
-146
lines changed

‎airbyte-integrations/connectors/source-freshdesk/README.md

+42-100
Original file line numberDiff line numberDiff line change
@@ -1,119 +1,55 @@
1-
# Freshdesk Source
1+
# Freshdesk source connector
2+
23

34
This is the repository for the Freshdesk source connector, written in Python.
45
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/freshdesk).
56

67
## Local development
78

89
### Prerequisites
9-
**To iterate on this connector, make sure to complete this prerequisites section.**
10-
11-
#### Minimum Python version required `= 3.9.0`
10+
* Python (~=3.9)
11+
* Poetry (~=1.7) - installation instructions [here](https://python-poetry.org/docs/#installation)
1212

13-
#### Build & Activate Virtual Environment and install dependencies
14-
From this connector directory, create a virtual environment:
15-
```
16-
python -m venv .venv
17-
```
1813

19-
This will generate a virtualenv for this module in `.venv/`. Make sure this venv is active in your
20-
development environment of choice. To activate it from the terminal, run:
21-
```
22-
source .venv/bin/activate
23-
pip install -r requirements.txt
14+
### Installing the connector
15+
From this connector directory, run:
16+
```bash
17+
poetry install --with dev
2418
```
25-
If you are in an IDE, follow your IDE's instructions to activate the virtualenv.
2619

27-
Note that while we are installing dependencies from `requirements.txt`, you should only edit `setup.py` for your dependencies. `requirements.txt` is
28-
used for editable installs (`pip install -e`) to pull in Python dependencies from the monorepo and will call `setup.py`.
29-
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
30-
should work as you expect.
3120

32-
#### Create credentials
21+
### Create credentials
3322
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/freshdesk)
3423
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_freshdesk/spec.yaml` file.
35-
Note that the `secrets` directory is gitignored by default, so there is no danger of accidentally checking in sensitive information.
36-
See `integration_tests/sample_config.json` for a sample config file.
24+
Note that any directory named `secrets` is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information.
25+
See `sample_files/sample_config.json` for a sample config file.
3726

38-
**If you are an Airbyte core member**, copy the credentials in Lastpass under the secret name `source freshdesk test creds`
39-
and place them into `secrets/config.json`.
4027

4128
### Locally running the connector
4229
```
43-
python main.py spec
44-
python main.py check --config secrets/config.json
45-
python main.py discover --config secrets/config.json
46-
python main.py read --config secrets/config.json --catalog integration_tests/configured_catalog.json
30+
poetry run source-freshdesk spec
31+
poetry run source-freshdesk check --config secrets/config.json
32+
poetry run source-freshdesk discover --config secrets/config.json
33+
poetry run source-freshdesk read --config secrets/config.json --catalog sample_files/configured_catalog.json
4734
```
4835

49-
### Locally running the connector docker image
50-
51-
52-
53-
54-
#### Use `airbyte-ci` to build your connector
55-
The Airbyte way of building this connector is to use our `airbyte-ci` tool.
56-
You can follow install instructions [here](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md#L1).
57-
Then running the following command will build your connector:
58-
59-
```bash
60-
airbyte-ci connectors --name source-freshdesk build
36+
### Running unit tests
37+
To run unit tests locally, from the connector directory run:
6138
```
62-
Once the command is done, you will find your connector image in your local docker registry: `airbyte/source-freshdesk:dev`.
63-
64-
##### Customizing our build process
65-
When contributing on our connector you might need to customize the build process to add a system dependency or set an env var.
66-
You can customize our build process by adding a `build_customization.py` module to your connector.
67-
This module should contain a `pre_connector_install` and `post_connector_install` async function that will mutate the base image and the connector container respectively.
68-
It will be imported at runtime by our build process and the functions will be called if they exist.
69-
70-
Here is an example of a `build_customization.py` module:
71-
```python
72-
from __future__ import annotations
73-
74-
from typing import TYPE_CHECKING
75-
76-
if TYPE_CHECKING:
77-
# Feel free to check the dagger documentation for more information on the Container object and its methods.
78-
# https://dagger-io.readthedocs.io/en/sdk-python-v0.6.4/
79-
from dagger import Container
80-
81-
82-
async def pre_connector_install(base_image_container: Container) -> Container:
83-
return await base_image_container.with_env_variable("MY_PRE_BUILD_ENV_VAR", "my_pre_build_env_var_value")
84-
85-
async def post_connector_install(connector_container: Container) -> Container:
86-
return await connector_container.with_env_variable("MY_POST_BUILD_ENV_VAR", "my_post_build_env_var_value")
39+
poetry run pytest unit_tests
8740
```
8841

89-
#### Build your own connector image
90-
This connector is built using our dynamic built process in `airbyte-ci`.
91-
The base image used to build it is defined within the metadata.yaml file under the `connectorBuildOptions`.
92-
The build logic is defined using [Dagger](https://dagger.io/) [here](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/pipelines/builds/python_connectors.py).
93-
It does not rely on a Dockerfile.
94-
95-
If you would like to patch our connector and build your own a simple approach would be to:
96-
97-
1. Create your own Dockerfile based on the latest version of the connector image.
98-
```Dockerfile
99-
FROM airbyte/source-freshdesk:latest
42+
### Building the docker image
43+
1. Install [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md)
44+
2. Run the following command to build the docker image:
45+
```bash
46+
airbyte-ci connectors --name=source-freshdesk build
47+
```
10048

101-
COPY . ./airbyte/integration_code
102-
RUN pip install ./airbyte/integration_code
49+
An image will be available on your host with the tag `airbyte/source-freshdesk:dev`.
10350

104-
# The entrypoint and default env vars are already set in the base image
105-
# ENV AIRBYTE_ENTRYPOINT "python /airbyte/integration_code/main.py"
106-
# ENTRYPOINT ["python", "/airbyte/integration_code/main.py"]
107-
```
108-
Please use this as an example. This is not optimized.
10951

110-
2. Build your image:
111-
```bash
112-
docker build -t airbyte/source-freshdesk:dev .
113-
# Running the spec command against your patched connector
114-
docker run airbyte/source-freshdesk:dev spec
115-
```
116-
#### Run
52+
### Running as a docker container
11753
Then run any of the connector commands as follows:
11854
```
11955
docker run --rm airbyte/source-freshdesk:dev spec
@@ -122,28 +58,34 @@ docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-freshdesk:dev discover
12258
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-freshdesk:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json
12359
```
12460

125-
## Testing
61+
### Running our CI test suite
12662
You can run our full test suite locally using [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md):
12763
```bash
12864
airbyte-ci connectors --name=source-freshdesk test
12965
```
13066

13167
### Customizing acceptance Tests
132-
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.
68+
Customize `acceptance-test-config.yml` file to configure acceptance tests. See [Connector Acceptance Tests](https://docs.airbyte.com/connector-development/testing-connectors/connector-acceptance-tests-reference) for more information.
13369
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.
13470

135-
## Dependency Management
136-
All of your dependencies should go in `setup.py`, NOT `requirements.txt`. The requirements file is only used to connect internal Airbyte dependencies in the monorepo for local development.
137-
We split dependencies between two groups, dependencies that are:
138-
* required for your connector to work need to go to `MAIN_REQUIREMENTS` list.
139-
* required for the testing need to go to `TEST_REQUIREMENTS` list
71+
### Dependency Management
72+
All of your dependencies should be managed via Poetry.
73+
To add a new dependency, run:
74+
```bash
75+
poetry add <package-name>
76+
```
77+
78+
Please commit the changes to `pyproject.toml` and `poetry.lock` files.
14079

141-
### Publishing a new version of the connector
80+
## Publishing a new version of the connector
14281
You've checked out the repo, implemented a million dollar feature, and you're ready to share your changes with the world. Now what?
14382
1. Make sure your changes are passing our test suite: `airbyte-ci connectors --name=source-freshdesk test`
144-
2. Bump the connector version in `metadata.yaml`: increment the `dockerImageTag` value. Please follow [semantic versioning for connectors](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#semantic-versioning-for-connectors).
83+
2. Bump the connector version (please follow [semantic versioning for connectors](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#semantic-versioning-for-connectors)):
84+
- bump the `dockerImageTag` value in in `metadata.yaml`
85+
- bump the `version` value in `pyproject.toml`
14586
3. Make sure the `metadata.yaml` content is up to date.
146-
4. Make the connector documentation and its changelog is up to date (`docs/integrations/sources/freshdesk.md`).
87+
4. Make sure the connector documentation and its changelog is up to date (`docs/integrations/sources/freshdesk.md`).
14788
5. Create a Pull Request: use [our PR naming conventions](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#pull-request-title-convention).
14889
6. Pat yourself on the back for being an awesome contributor.
14990
7. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.
91+
8. Once your PR is merged, the new version of the connector will be automatically published to Docker Hub and our connector registry.

‎airbyte-integrations/connectors/source-freshdesk/metadata.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ data:
1010
connectorSubtype: api
1111
connectorType: source
1212
definitionId: ec4b9503-13cb-48ab-a4ab-6ade4be46567
13-
dockerImageTag: 3.0.6
13+
dockerImageTag: 3.0.7
1414
dockerRepository: airbyte/source-freshdesk
1515
documentationUrl: https://docs.airbyte.com/integrations/sources/freshdesk
1616
githubIssueLabel: source-freshdesk

0 commit comments

Comments
 (0)