jprdonnelly/airbyte
1
0
Fork 0
mirror of synced 2025-12-25 02:09:19 -05:00
Code Issues Packages Projects Releases Wiki Activity

source-sap-fieldglass: [autopull] base image + poetry + up_to_date (#38384)

Browse Source
This commit is contained in:
Natik Gadzhi
2024-05-20 22:37:25 -07:00
committed by GitHub
parent db35b3b16b
commit a40b0719d8
7 changed files with 1408 additions and 122 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
airbyte-integrations/connectors/source-sap-fieldglass/Dockerfile
View File

@@ -1,38 +0,0 @@
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
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 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 source_sap_fieldglass ./source_sap_fieldglass
ENV AIRBYTE_ENTRYPOINT "python /airbyte/integration_code/main.py"
ENTRYPOINT ["python", "/airbyte/integration_code/main.py"]
LABEL io.airbyte.version=0.1.0
LABEL io.airbyte.name=airbyte/source-sap-fieldglass

87
airbyte-integrations/connectors/source-sap-fieldglass/README.md
View File

@@ -1,42 +1,56 @@
# Sap Fieldglass Source
# Sap-Fieldglass source connector
This is the repository for the Sap Fieldglass configuration based source connector.
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/sources/sap-fieldglass).
This is the repository for the Sap-Fieldglass source connector, written in Python.
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/sap-fieldglass).
## Local development
#### Create credentials
### Prerequisites
* Python (~=3.9)
* Poetry (~=1.7) - installation instructions [here](https://python-poetry.org/docs/#installation)
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/sources/sap-fieldglass)
### Installing the connector
From this connector directory, run:
```bash
poetry install --with dev
```
### Create credentials
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/sap-fieldglass)
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_sap_fieldglass/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.
See `sample_files/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 sap-fieldglass test creds`
and place them into `secrets/config.json`.
### Locally running the connector docker image
### Locally running the connector
```
poetry run source-sap-fieldglass spec
poetry run source-sap-fieldglass check --config secrets/config.json
poetry run source-sap-fieldglass discover --config secrets/config.json
poetry run source-sap-fieldglass read --config secrets/config.json --catalog sample_files/configured_catalog.json
```
#### Build
**Via [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md) (recommended):**
### Running unit tests
To run unit tests locally, from the connector directory run:
```
poetry run pytest unit_tests
```
### Building the docker image
1. Install [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md)
2. Run the following command to build the docker image:
```bash
airbyte-ci connectors --name=source-sap-fieldglass build
```
An image will be built with the tag `airbyte/source-sap-fieldglass:dev`.
An image will be available on your host with the tag `airbyte/source-sap-fieldglass:dev`.
**Via `docker build`:**
```bash
docker build -t airbyte/source-sap-fieldglass:dev .
```
#### Run
### Running as a docker container
Then run any of the connector commands as follows:
```
docker run --rm airbyte/source-sap-fieldglass:dev spec
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-sap-fieldglass:dev check --config /secrets/config.json
@@ -44,35 +58,34 @@ docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-sap-fieldglass:dev dis
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-sap-fieldglass:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json
```
## Testing
### Running our CI test suite
You can run our full test suite locally using [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md):
```bash
airbyte-ci connectors --name=source-sap-fieldglass test
```
### Customizing acceptance Tests
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.
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.
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.
## Dependency Management
### Dependency Management
All of your dependencies should be managed via Poetry.
To add a new dependency, run:
```bash
poetry add <package-name>
```
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.
We split dependencies between two groups, dependencies that are:
- required for your connector to work need to go to `MAIN_REQUIREMENTS` list.
- required for the testing need to go to `TEST_REQUIREMENTS` list
### Publishing a new version of the connector
Please commit the changes to `pyproject.toml` and `poetry.lock` files.
## Publishing a new version of the connector
You've checked out the repo, implemented a million dollar feature, and you're ready to share your changes with the world. Now what?
1. Make sure your changes are passing our test suite: `airbyte-ci connectors --name=source-sap-fieldglass test`
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).
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)):
- bump the `dockerImageTag` value in in `metadata.yaml`
- bump the `version` value in `pyproject.toml`
3. Make sure the `metadata.yaml` content is up to date.
4. Make the connector documentation and its changelog is up to date (`docs/integrations/sources/sap-fieldglass.md`).
4. Make sure the connector documentation and its changelog is up to date (`docs/integrations/sources/sap-fieldglass.md`).
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).
6. Pat yourself on the back for being an awesome contributor.
7. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.
8. Once your PR is merged, the new version of the connector will be automatically published to Docker Hub and our connector registry.

4
airbyte-integrations/connectors/source-sap-fieldglass/metadata.yaml
View File

@@ -2,7 +2,7 @@ data:
connectorSubtype: api
connectorType: source
definitionId: ec5f3102-fb31-4916-99ae-864faf8e7e25
dockerImageTag: 0.1.0
dockerImageTag: 0.1.1
dockerRepository: airbyte/source-sap-fieldglass
githubIssueLabel: source-sap-fieldglass
icon: sapfieldglass.svg
@@ -34,4 +34,6 @@ data:
secretStore:
type: GSM
alias: airbyte-connector-testing-secret-store
connectorBuildOptions:
baseImage: docker.io/airbyte/python-connector-base:1.2.0@sha256:c22a9d97464b69d6ef01898edf3f8612dc11614f05a84984451dde195f337db9
metadataSpecVersion: "1.0"

1326
airbyte-integrations/connectors/source-sap-fieldglass/poetry.lock generated Normal file
View File

File diff suppressed because it is too large Load Diff

28
airbyte-integrations/connectors/source-sap-fieldglass/pyproject.toml Normal file
View File

@@ -0,0 +1,28 @@
[build-system]
requires = [ "poetry-core>=1.0.0",]
build-backend = "poetry.core.masonry.api"
[tool.poetry]
version = "0.1.1"
name = "source-sap-fieldglass"
description = "Source implementation for Sap Fieldglass."
authors = [ "Airbyte <contact@airbyte.io>",]
license = "MIT"
readme = "README.md"
documentation = "https://docs.airbyte.com/integrations/sources/sap-fieldglass"
homepage = "https://airbyte.com"
repository = "https://github.com/airbytehq/airbyte"
[[tool.poetry.packages]]
include = "source_sap_fieldglass"
[tool.poetry.dependencies]
python = "^3.9,<3.12"
airbyte-cdk = "1.0.0"
[tool.poetry.scripts]
source-sap-fieldglass = "source_sap_fieldglass.run:run"
[tool.poetry.group.dev.dependencies]
requests-mock = "^1.9.3"
pytest = "^6.1"
pytest-mock = "^3.6.1"

46
airbyte-integrations/connectors/source-sap-fieldglass/setup.py
View File

@@ -1,46 +0,0 @@
#
# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
#
from setuptools import find_packages, setup
MAIN_REQUIREMENTS = [
"airbyte-cdk~=0.1",
]
TEST_REQUIREMENTS = [
"requests-mock~=1.9.3",
"pytest~=6.1",
"pytest-mock~=3.6.1",
]
setup(
entry_points={
"console_scripts": [
"source-sap-fieldglass=source_sap_fieldglass.run:run",
],
},
name="source_sap_fieldglass",
description="Source implementation for Sap Fieldglass.",
author="Airbyte",
author_email="contact@airbyte.io",
packages=find_packages(),
install_requires=MAIN_REQUIREMENTS,
package_data={
"": [
# Include yaml files in the package (if any)
"*.yml",
"*.yaml",
# Include all json files in the package, up to 4 levels deep
"*.json",
"*/*.json",
"*/*/*.json",
"*/*/*/*.json",
"*/*/*/*/*.json",
]
},
extras_require={
"tests": TEST_REQUIREMENTS,
},
)

1
docs/integrations/sources/sap-fieldglass.md
View File

@@ -22,4 +22,5 @@ This page contains the setup guide and reference information for the SAP Fieldgl
| Version | Date | Pull Request | Subject |
| :------ | :--------- | :---------------------------------------------- | :------------- |
| 0.1.1 | 2024-05-20 | [38384](https://github.com/airbytehq/airbyte/pull/38384) | [autopull] base image + poetry + up_to_date |
| 0.1.0 | 2022-10-22 | https://github.com/airbytehq/airbyte/pull/18656 | Initial commit |