Skip to content

Commit

Permalink
migrated to low code
Browse files Browse the repository at this point in the history
  • Loading branch information
avirajsingh7 committed Aug 9, 2023
1 parent 3da1a2f commit ed9347f
Show file tree
Hide file tree
Showing 18 changed files with 182 additions and 370 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,5 @@ COPY source_glassfrog ./source_glassfrog
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.version=1.0.0
LABEL io.airbyte.name=airbyte/source-glassfrog
64 changes: 7 additions & 57 deletions airbyte-integrations/connectors/source-glassfrog/README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,10 @@
# Glassfrog Source

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

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

Expand All @@ -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/glassfrog)
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/glassfrog)
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_glassfrog/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 glassfrog 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 @@ -79,32 +46,15 @@ docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-glassfrog:dev discover
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-glassfrog: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.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,20 +1,31 @@
# 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-glassfrog:dev
tests:
acceptance_tests:
spec:
- spec_path: "source_glassfrog/spec.yaml"
tests:
- spec_path: "source_glassfrog/spec.yaml"
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"
basic_read:
- config_path: "secrets/config.json"
configured_catalog_path: "integration_tests/configured_catalog.json"
empty_streams: ["custom_fields", "checklist_items", "metrics", "projects"]
tests:
- config_path: "secrets/config.json"
configured_catalog_path: "integration_tests/configured_catalog.json"
empty_streams:
- name: custom_fields
- name: checklist_items
- name: metrics
- name: projects
incremental:
bypass_reason: "This connector does not implement incremental sync"
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"
1 change: 1 addition & 0 deletions airbyte-integrations/connectors/source-glassfrog/acceptance-test-docker.sh
100644 → 100755
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
#!/usr/bin/env sh

source "$(git rev-parse --show-toplevel)/airbyte-integrations/bases/connector-acceptance-test/acceptance-test-docker.sh"
28 changes: 0 additions & 28 deletions airbyte-integrations/connectors/source-glassfrog/bootstrap.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
"api_key": "xxxxxxx"
"api_key": "invalid_api_key"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"api_key": "api_key"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"todo-stream-name": {
"todo-field-name": "value"
}
}
23 changes: 12 additions & 11 deletions airbyte-integrations/connectors/source-glassfrog/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,24 +1,25 @@
data:
allowedHosts:
hosts:
- "*" # Please change to the hostname of the source.
registries:
oss:
enabled: true
cloud:
enabled: true
connectorSubtype: api
connectorType: source
definitionId: cf8ff320-6272-4faa-89e6-4402dc17e5d5
dockerImageTag: 0.1.0
dockerImageTag: 1.0.0
dockerRepository: airbyte/source-glassfrog
githubIssueLabel: source-glassfrog
icon: glassfrog.svg
license: MIT
name: Glassfrog
registries:
cloud:
enabled: true
oss:
enabled: true
releaseDate: "2022-06-16"
releaseStage: alpha
supportLevel: community
documentationUrl: https://docs.airbyte.com/integrations/sources/glassfrog
tags:
- language:python
ab_internal:
sl: 100
ql: 200
supportLevel: community
- language:lowcode
metadataSpecVersion: "1.0"
2 changes: 1 addition & 1 deletion airbyte-integrations/connectors/source-glassfrog/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
]

TEST_REQUIREMENTS = [
"pytest~=6.1",
"pytest~=6.2",
"pytest-mock~=3.6.1",
"connector-acceptance-test",
]
Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
version: "0.29.0"

definitions:
selector:
type: RecordSelector
extractor:
type: DpathExtractor
field_path: ["{{ parameters.path}}"]
requester:
type: HttpRequester
url_base: "https://api.glassfrog.com/api/v3/"
http_method: "GET"
authenticator:
type: ApiKeyAuthenticator
header: "X-Auth-Token"
api_token: "{{ config['api_key'] }}"
retriever:
type: SimpleRetriever
record_selector:
$ref: "#/definitions/selector"
paginator:
type: NoPagination
requester:
$ref: "#/definitions/requester"
base_stream:
type: DeclarativeStream
retriever:
$ref: "#/definitions/retriever"

assignments_stream:
$ref: "#/definitions/base_stream"
name: "assignments"
primary_key: "id"
$parameters:
path: "assignments"

checklist_items_stream:
$ref: "#/definitions/base_stream"
name: "checklist_items"
primary_key: "id"
$parameters:
path: "checklist_items"

circles_stream:
$ref: "#/definitions/base_stream"
name: "circles"
primary_key: "id"
$parameters:
path: "circles"

custom_fields_stream:
$ref: "#/definitions/base_stream"
name: "custom_fields"
primary_key: "id"
$parameters:
path: "custom_fields"

metrics_stream:
$ref: "#/definitions/base_stream"
name: "metrics"
primary_key: "id"
$parameters:
path: "metrics"

people_stream:
$ref: "#/definitions/base_stream"
name: "people"
primary_key: "id"
$parameters:
path: "people"

projects_stream:
$ref: "#/definitions/base_stream"
name: "projects"
primary_key: "id"
$parameters:
path: "projects"

roles_stream:
$ref: "#/definitions/base_stream"
name: "roles"
primary_key: "id"
$parameters:
path: "roles"

streams:
- "#/definitions/assignments_stream"
- "#/definitions/checklist_items_stream"
- "#/definitions/circles_stream"
- "#/definitions/custom_fields_stream"
- "#/definitions/metrics_stream"
- "#/definitions/people_stream"
- "#/definitions/projects_stream"
- "#/definitions/roles_stream"

check:
type: CheckStream
stream_names:
- "assignments"

spec:
type: Spec
documentationUrl: https://docs.airbyte.com/integrations/sources/glassfrog
connection_specification:
$schema: http://json-schema.org/draft-07/schema#
title: Glassfrog Spec
type: object
required:
- api_key
additionalProperties: true
properties:
api_key:
type: string
description: API key provided by Glassfrog
airbyte_secret: true
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@
"type": ["null", "integer"],
"default": null
},
"settings": {
"type": ["null", "object"]
},
"links": {
"type": "object",
"default": {},
Expand Down
Loading

0 comments on commit ed9347f

Please sign in to comment.