Skip to content

Commit

Permalink
Merge branch 'master' into anne/feature-flag-refresh-schema
Browse files Browse the repository at this point in the history
  • Loading branch information
alovew committed Nov 29, 2022
2 parents 40b2308 + 5354b54 commit 0a83a93
Show file tree
Hide file tree
Showing 51 changed files with 2,421 additions and 34 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -77,5 +77,8 @@ airbyte-config/**/resources/seed/oss_catalog.json
# Helm charts .tgz dependencies
charts/**/charts

# Snyk
.dccache

# Datadog
dd-java-agent.jar
2 changes: 2 additions & 0 deletions airbyte-api/src/main/openapi/config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2935,6 +2935,8 @@ components:
$ref: "#/components/schemas/CatalogDiff"
breakingChange:
type: boolean
connectionStatus:
$ref: "#/components/schemas/ConnectionStatus"
SourceSearch:
type: object
properties:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -194,10 +194,20 @@ public void close() throws Exception {
return;
}

LOGGER.debug("Closing normalization process");
LOGGER.info("Terminating normalization process {}...", process.pid());
WorkerUtils.gentleClose(process, 1, TimeUnit.MINUTES);
if (process.isAlive() || process.exitValue() != 0) {
throw new WorkerException("Normalization process wasn't successful");

/*
* After attempting to close the process check the following:
*
* Did the process actually terminate? If "yes", did it do so nominally?
*/
if (process.isAlive()) {
throw new WorkerException("Normalization process " + process.pid() + " did not terminate after 1 minute.");
} else if (process.exitValue() != 0) {
throw new WorkerException("Normalization process " + process.pid() + " did not terminate normally (exit code: " + process.exitValue() + ")");
} else {
LOGGER.info("Normalization process {} successfully terminated.", process.pid());
}
}

Expand Down
10 changes: 10 additions & 0 deletions airbyte-config/init/src/main/resources/icons/senseforce.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@
dockerRepository: airbyte/destination-clickhouse
dockerImageTag: 0.2.0
documentationUrl: https://docs.airbyte.com/integrations/destinations/clickhouse
icon: clickhouse.svg
releaseStage: alpha
normalizationRepository: airbyte/normalization-clickhouse
normalizationTag: 0.2.24
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@
dockerRepository: airbyte/source-clickhouse
dockerImageTag: 0.1.14
documentationUrl: https://docs.airbyte.com/integrations/sources/clickhouse
icon: cliskhouse.svg
icon: clickhouse.svg
sourceType: database
releaseStage: alpha
- name: ClickUp
Expand Down Expand Up @@ -1148,6 +1148,13 @@
icon: persistiq.svg
sourceType: api
releaseStage: alpha
- name: Pexels API
sourceDefinitionId: 69d9eb65-8026-47dc-baf1-e4bf67901fd6
dockerRepository: airbyte/source-pexels-api
dockerImageTag: 0.1.0
documentationUrl: https://docs.airbyte.com/integrations/sources/pexels-api
sourceType: api
releaseStage: alpha
- name: Pinterest
sourceDefinitionId: 5cb7e5fe-38c2-11ec-8d3d-0242ac130003
dockerRepository: airbyte/source-pinterest
Expand Down Expand Up @@ -1434,6 +1441,7 @@
dockerRepository: airbyte/source-senseforce
dockerImageTag: 0.1.0
documentationUrl: https://docs.airbyte.com/integrations/sources/senseforce
icon: senseforce.svg
sourceType: api
releaseStage: alpha
- name: Sendinblue
Expand Down
66 changes: 66 additions & 0 deletions airbyte-config/init/src/main/resources/seed/source_specs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10614,6 +10614,72 @@
supportsNormalization: false
supportsDBT: false
supported_destination_sync_modes: []
- dockerImage: "airbyte/source-pexels-api:0.1.0"
spec:
documentationUrl: "https://docs.airbyte.com/integrations/sources/pexels-api"
connectionSpecification:
$schema: "http://json-schema.org/draft-07/schema#"
title: "Pexel API Spec"
type: "object"
required:
- "api_key"
- "query"
additionalProperties: true
properties:
api_key:
title: "API Key from the pexels website"
type: "string"
description: "API key is required to access pexels api, For getting your's\
\ goto https://www.pexels.com/api/documentation and create account for\
\ free."
airbyte_secret: true
query:
title: "Specific query for the search"
type: "string"
description: "Optional, the search query, Example Ocean, Tigers, Pears,\
\ etc."
examples:
- "people"
- "oceans"
orientation:
title: "Specific orientation for the search"
type: "string"
description: "Optional, Desired photo orientation. The current supported\
\ orientations are landscape, portrait or square"
examples:
- "square"
- "landscape"
size:
title: "Specific size for the search"
type: "string"
description: "Optional, Minimum photo size. The current supported sizes\
\ are large(24MP), medium(12MP) or small(4MP)."
examples:
- "large"
- "small"
color:
title: "Specific color for the search"
type: "string"
description: "Optional, Desired photo color. Supported colors red, orange,\
\ yellow, green, turquoise, blue, violet, pink, brown, black, gray, white\
\ or any hexidecimal color code."
examples:
- "red"
- "orange"
locale:
title: "Specific locale for the search"
type: "string"
description: "Optional, The locale of the search you are performing. The\
\ current supported locales are 'en-US' 'pt-BR' 'es-ES' 'ca-ES' 'de-DE'\
\ 'it-IT' 'fr-FR' 'sv-SE' 'id-ID' 'pl-PL' 'ja-JP' 'zh-TW' 'zh-CN' 'ko-KR'\
\ 'th-TH' 'nl-NL' 'hu-HU' 'vi-VN' 'cs-CZ' 'da-DK' 'fi-FI' 'uk-UA' 'el-GR'\
\ 'ro-RO' 'nb-NO' 'sk-SK' 'tr-TR' 'ru-RU'."
examples:
- "en-US"
- "pt-BR"
supportsNormalization: false
supportsDBT: false
supported_destination_sync_modes: []
- dockerImage: "airbyte/source-pinterest:0.1.9"
spec:
documentationUrl: "https://docs.airbyte.com/integrations/sources/pinterest"
Expand Down
Binary file not shown.
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
*
!Dockerfile
!main.py
!source_pexels_api
!setup.py
!secrets
38 changes: 38 additions & 0 deletions airbyte-integrations/connectors/source-pexels-api/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
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_pexels_api ./source_pexels_api

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-pexels-api
103 changes: 103 additions & 0 deletions airbyte-integrations/connectors/source-pexels-api/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
# Pexels Api Source

This is the repository for the Pexels Api configuration based source connector.
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/sources/pexels-api).

## Local development

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

#### Minimum Python version required `= 3.9.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
```
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.

To build using Gradle, from the Airbyte repository root, run:
```
./gradlew :airbyte-integrations:connectors:source-pexels-api:build
```

#### Create credentials
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/sources/pexels-api)
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_pexels_api/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 pexels-api test creds`
and place them into `secrets/config.json`.

### Locally running the connector docker image

#### Build
First, make sure you build the latest Docker image:
```
docker build . -t airbyte/source-pexels-api:dev
```

You can also build the connector image via Gradle:
```
./gradlew :airbyte-integrations:connectors:source-pexels-api:airbyteDocker
```
When building via Gradle, the docker image name and tag, respectively, are the values of the `io.airbyte.name` and `io.airbyte.version` `LABEL`s in
the Dockerfile.

#### Run
Then run any of the connector commands as follows:
```
docker run --rm airbyte/source-pexels-api:dev spec
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-pexels-api:dev check --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-pexels-api:dev discover --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-pexels-api:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json
```
## Testing

#### Acceptance Tests
Customize `acceptance-test-config.yml` file to configure tests. See [Source Acceptance Tests](https://docs.airbyte.io/connector-development/testing-connectors/source-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 docker

### Using gradle to run tests
All commands should be run from airbyte project root.
To run unit tests:
```
./gradlew :airbyte-integrations:connectors:source-pexels-api:unitTest
```
To run acceptance and custom integration tests:
```
./gradlew :airbyte-integrations:connectors:source-pexels-api:integrationTest
```

## Dependency Management
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
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 unit and integration tests.
1. Bump the connector version in `Dockerfile` -- just increment the value of the `LABEL io.airbyte.version` appropriately (we use [SemVer](https://semver.org/)).
1. Create a Pull Request.
1. Pat yourself on the back for being an awesome contributor.
1. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.
3 changes: 3 additions & 0 deletions airbyte-integrations/connectors/source-pexels-api/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
#
# Copyright (c) 2022 Airbyte, Inc., all rights reserved.
#
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# See [Source Acceptance Tests](https://docs.airbyte.com/connector-development/testing-connectors/source-acceptance-tests-reference)
# for more information about how to configure these tests
connector_image: airbyte/source-pexels-api:dev
acceptance_tests:
spec:
tests:
- spec_path: "source_pexels_api/spec.yaml"
connection:
tests:
- config_path: "secrets/config.json"
status: "succeed"
- config_path: "integration_tests/invalid_config.json"
status: "failed"
discovery:
tests:
- config_path: "secrets/config.json"
basic_read:
tests:
- config_path: "secrets/config.json"
configured_catalog_path: "integration_tests/configured_catalog.json"
empty_streams: []
full_refresh:
tests:
- config_path: "secrets/config.json"
configured_catalog_path: "integration_tests/configured_catalog.json"
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
#!/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-)

# Pull latest acctest image
docker pull airbyte/source-acceptance-test:latest

# Run
docker run --rm -it \
-v /var/run/docker.sock:/var/run/docker.sock \
-v /tmp:/tmp \
-v $(pwd):/test_input \
airbyte/source-acceptance-test \
--acceptance-test-config /test_input

Loading

0 comments on commit 0a83a93

Please sign in to comment.