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-sonar-cloud: ensure inline schemas, updated cdk, poetry (where possible) (#37262)

Browse Source
This commit is contained in:
Brian Leonard
2024-05-01 11:52:37 -07:00
committed by GitHub
parent 6276c1f9cf
commit 6cd8abfd8e
11 changed files with 1261 additions and 246 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
airbyte-integrations/connectors/source-sonar-cloud/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_sonar_cloud ./source_sonar_cloud
ENV AIRBYTE_ENTRYPOINT "python /airbyte/integration_code/main.py"
ENTRYPOINT ["python", "/airbyte/integration_code/main.py"]
LABEL io.airbyte.version=0.1.1
LABEL io.airbyte.name=airbyte/source-sonar-cloud

84
airbyte-integrations/connectors/source-sonar-cloud/README.md
View File

@@ -1,36 +1,55 @@
# Sonar Cloud Source
# Sonar-Cloud source connector
This is the repository for the Sonar Cloud configuration based source connector.
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/sources/sonar-cloud).
This is the repository for the Sonar-Cloud source connector, written in Python.
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/sonar-cloud).
## Local development
#### Create credentials
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/sources/sonar-cloud)
### Prerequisites
* Python (~=3.9)
* Poetry (~=1.7) - installation instructions [here](https://python-poetry.org/docs/#installation)
### 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/sonar-cloud)
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_sonar_cloud/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 sonar-cloud test creds`
and place them into `secrets/config.json`.
### Locally running the connector docker image
See `sample_files/sample_config.json` for a sample config file.
#### Build
**Via [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md) (recommended):**
### Locally running the connector
```
poetry run source-sonar-cloud spec
poetry run source-sonar-cloud check --config secrets/config.json
poetry run source-sonar-cloud discover --config secrets/config.json
poetry run source-sonar-cloud read --config secrets/config.json --catalog sample_files/configured_catalog.json
```
### 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-sonar-cloud build
```
An image will be built with the tag `airbyte/source-sonar-cloud:dev`.
An image will be available on your host with the tag `airbyte/source-sonar-cloud:dev`.
**Via `docker build`:**
```bash
docker build -t airbyte/source-sonar-cloud:dev .
```
#### Run
### Running as a docker container
Then run any of the connector commands as follows:
```
docker run --rm airbyte/source-sonar-cloud:dev spec
@@ -39,29 +58,34 @@ docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-sonar-cloud:dev discov
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-sonar-cloud: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-sonar-cloud 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
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
### Dependency Management
All of your dependencies should be managed via Poetry.
To add a new dependency, run:
```bash
poetry add <package-name>
```
### 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-sonar-cloud 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/sonar-cloud.md`).
4. Make sure the connector documentation and its changelog is up to date (`docs/integrations/sources/sonar-cloud.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.

22
airbyte-integrations/connectors/source-sonar-cloud/metadata.yaml
View File

@@ -1,32 +1,34 @@
data:
ab_internal:
ql: 100
sl: 100
allowedHosts:
hosts:
- sonarcloud.io
connectorBuildOptions:
baseImage: docker.io/airbyte/python-connector-base:1.2.0@sha256:c22a9d97464b69d6ef01898edf3f8612dc11614f05a84984451dde195f337db9
connectorSubtype: api
connectorType: source
definitionId: 3ab1d7d0-1577-4ab9-bcc4-1ff6a4c2c9f2
dockerImageTag: 0.1.1
dockerImageTag: 0.1.5
dockerRepository: airbyte/source-sonar-cloud
documentationUrl: https://docs.airbyte.com/integrations/sources/sonar-cloud
githubIssueLabel: source-sonar-cloud
icon: sonarcloud.svg
license: MIT
name: Sonar Cloud
remoteRegistries:
pypi:
enabled: true
packageName: airbyte-source-sonar-cloud
registries:
cloud:
enabled: true
oss:
enabled: true
releaseStage: alpha
documentationUrl: https://docs.airbyte.com/integrations/sources/sonar-cloud
remoteRegistries:
pypi:
enabled: true
packageName: airbyte-source-sonar-cloud
supportLevel: community
tags:
- language:python
- cdk:low-code
ab_internal:
sl: 100
ql: 100
supportLevel: community
metadataSpecVersion: "1.0"

1031
airbyte-integrations/connectors/source-sonar-cloud/poetry.lock generated Normal file
View File

File diff suppressed because it is too large Load Diff

28
airbyte-integrations/connectors/source-sonar-cloud/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.5"
name = "source-sonar-cloud"
description = "Source implementation for Sonar Cloud."
authors = [ "Airbyte <contact@airbyte.io>",]
license = "MIT"
readme = "README.md"
documentation = "https://docs.airbyte.com/integrations/sources/sonar-cloud"
homepage = "https://airbyte.com"
repository = "https://github.com/airbytehq/airbyte"
[[tool.poetry.packages]]
include = "source_sonar_cloud"
[tool.poetry.dependencies]
python = "^3.9,<3.12"
airbyte-cdk = "0.80.0"
[tool.poetry.scripts]
source-sonar-cloud = "source_sonar_cloud.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-sonar-cloud/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-sonar-cloud=source_sonar_cloud.run:run",
],
},
name="source_sonar_cloud",
description="Source implementation for Sonar Cloud.",
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,
},
)

132
airbyte-integrations/connectors/source-sonar-cloud/source_sonar_cloud/manifest.yaml
View File

@@ -43,12 +43,101 @@ definitions:
name: "components"
primary_key: "key"
path: "/components/search"
schema_loader:
type: InlineSchemaLoader
schema:
$schema: http://json-schema.org/draft-07/schema#
type: object
properties:
organization:
description: Name of the organization to which the component belongs
type: string
key:
description: Unique identifier for the component
type: string
name:
description: Name of the component
type: string
qualifier:
description: Type of the component (e.g., 'TRK' for a project)
type: string
project:
description: Name of the project to which the component is associated
type: string
issues_stream:
$ref: "#/definitions/base_stream"
$parameters:
name: "issues"
primary_key: "key"
path: "/issues/search?componentKeys={{ ','.join(config.get('component_keys', [])) }}"
path:
"/issues/search?componentKeys={{ ','.join(config.get('component_keys',
[])) }}"
schema_loader:
type: InlineSchemaLoader
schema:
$schema: http://json-schema.org/draft-07/schema#
type: object
properties:
key:
description: The unique key or identifier of the issue
type: string
rule:
description: The rule identifier associated with the issue
type: string
severity:
description: The severity level of the issue
type: string
component:
description: The project component associated with the issue
type: string
project:
description: The name of the project where the issue exists
type: string
resolution:
description: The resolution status of the issue
type: string
status:
description: The current status of the issue
type: string
message:
description: The message or description of the issue
type: string
effort:
description: The estimated effort required to resolve the issue
type: string
debt:
description: The debt value associated with resolving the issue
type: string
author:
description: The author or creator of the issue
type: string
creationDate:
description: The date and time when the issue was created
type: string
updateDate:
description: The date and time when the issue was last updated
type: string
type:
description: The type or category of the issue
type: string
organization:
description: The organization to which the project belongs
type: string
textRange:
description: The range of text in the source code where the issue occurs
type: object
tags:
description: Tags or labels associated with the issue
type: array
line:
description: The line number in the source code where the issue occurs
type: integer
hash:
description: The unique hash identifier of the issue
type: string
flows:
description: Information about the code flow related to the issue
type: array
metrics_stream:
$ref: "#/definitions/base_stream"
$parameters:
@@ -56,6 +145,47 @@ definitions:
primary_key: "id"
path: "/metrics/search"
schema_loader:
type: InlineSchemaLoader
schema:
$schema: http://json-schema.org/draft-07/schema#
type: object
properties:
id:
description: The unique identifier for the metric data
type: string
key:
description: The key associated with the metric data (e.g., 'code_quality')
type: string
name:
description: The name or title of the metric data
type: string
type:
description:
The type or format of the metric data (e.g., 'integer', 'float',
'string')
type: string
description:
description: A brief summary or explanation of the metric data
type: string
domain:
description: The domain or category to which the metric data belongs
type: string
qualitative:
description:
Indicates if the metric data is qualitative in nature (e.g.,
'yes' or 'no')
type: boolean
hidden:
description:
Indicates if the metric data is hidden from normal view (e.g.,
for internal use)
type: boolean
direction:
description:
The direction of the metric data (e.g., 'higher is better'
or 'lower is better')
type: number
streams:
- "#/definitions/components_stream"
- "#/definitions/issues_stream"

21
airbyte-integrations/connectors/source-sonar-cloud/source_sonar_cloud/schemas/components.json
View File

@@ -1,21 +0,0 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"organization": {
"type": "string"
},
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"qualifier": {
"type": "string"
},
"project": {
"type": "string"
}
}
}

66
airbyte-integrations/connectors/source-sonar-cloud/source_sonar_cloud/schemas/issues.json
View File

@@ -1,66 +0,0 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"key": {
"type": "string"
},
"rule": {
"type": "string"
},
"severity": {
"type": "string"
},
"component": {
"type": "string"
},
"project": {
"type": "string"
},
"resolution": {
"type": "string"
},
"status": {
"type": "string"
},
"message": {
"type": "string"
},
"effort": {
"type": "string"
},
"debt": {
"type": "string"
},
"author": {
"type": "string"
},
"creationDate": {
"type": "string"
},
"updateDate": {
"type": "string"
},
"type": {
"type": "string"
},
"organization": {
"type": "string"
},
"textRange": {
"type": "object"
},
"tags": {
"type": "array"
},
"line": {
"type": "integer"
},
"hash": {
"type": "string"
},
"flows": {
"type": "array"
}
}
}

33
airbyte-integrations/connectors/source-sonar-cloud/source_sonar_cloud/schemas/metrics.json
View File

@@ -1,33 +0,0 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"domain": {
"type": "string"
},
"qualitative": {
"type": "boolean"
},
"hidden": {
"type": "boolean"
},
"direction": {
"type": "number"
}
}
}

6
docs/integrations/sources/sonar-cloud.md
View File

@@ -28,5 +28,9 @@ This source can sync data from the [Sonar cloud API](https://sonarcloud.io/web_a
| Version | Date | Pull Request | Subject |
| :------ | :--------- | :-------------------------------------------------------- | :----------------------------------------- |
| 0.1.5 | 2024-04-19 | [37262](https://github.com/airbytehq/airbyte/pull/37262) | Updating to 0.80.0 CDK |
| 0.1.4 | 2024-04-18 | [37262](https://github.com/airbytehq/airbyte/pull/37262) | Manage dependencies with Poetry. |
| 0.1.3 | 2024-04-15 | [37262](https://github.com/airbytehq/airbyte/pull/37262) | Base image migration: remove Dockerfile and use the python-connector-base image |
| 0.1.2 | 2024-04-12 | [37262](https://github.com/airbytehq/airbyte/pull/37262) | schema descriptions |
| 0.1.1 | 2023-02-11 l [22868](https://github.com/airbytehq/airbyte/pull/22868) | Specified date formatting in specification |
| 0.1.0 | 2022-10-26 | [#18475](https://github.com/airbytehq/airbyte/pull/18475) | 🎉 New Source: Sonar Cloud API [low-code CDK] |
| 0.1.0 | 2022-10-26 | [#18475](https://github.com/airbytehq/airbyte/pull/18475) | 🎉 New Source: Sonar Cloud API [low-code CDK] |