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: Migrate to manifest-only (#44063)

Browse Source
This commit is contained in:
Christo Grabowski
2024-08-14 20:14:34 -04:00
committed by GitHub
parent 589663289a
commit 92ec51404e
13 changed files with 725 additions and 1517 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1,49 +1,22 @@
# Sonar-Cloud source connector
# Sonar cloud source connector
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).
This directory contains the manifest-only connector for `source-sonar-cloud`.
This _manifest-only_ connector is not a Python package on its own, as it runs inside of the base `source-declarative-manifest` image.
For information about how to configure and use this connector within Airbyte, see [the connector's full documentation](https://docs.airbyte.com/integrations/sources/sonar-cloud).
## Local development
### Prerequisites
We recommend using the Connector Builder to edit this connector.
Using either Airbyte Cloud or your local Airbyte OSS instance, navigate to the **Builder** tab and select **Import a YAML**.
Then select the connector's `manifest.yaml` file to load the connector into the Builder. You're now ready to make changes to the connector!
- 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 `sample_files/sample_config.json` for a sample config file.
### 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
```
If you prefer to develop locally, you can follow the instructions below.
### Building the docker image
You can build any manifest-only connector with `airbyte-ci`:
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:
@@ -53,18 +26,24 @@ airbyte-ci connectors --name=source-sonar-cloud build
An image will be available on your host with the tag `airbyte/source-sonar-cloud:dev`.
### Creating 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 `spec` object in the connector's `manifest.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.
### Running as a docker container
Then run any of the connector commands as follows:
Then run any of the standard source connector commands:
```
```bash
docker run --rm airbyte/source-sonar-cloud:dev spec
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-sonar-cloud:dev check --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-sonar-cloud:dev discover --config /secrets/config.json
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
```
### Running our CI test suite
### Running the 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):
@@ -72,33 +51,15 @@ You can run our full test suite locally using [`airbyte-ci`](https://github.com/
airbyte-ci connectors --name=source-sonar-cloud test
```
### Customizing acceptance Tests
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 be managed via Poetry.
To add a new dependency, run:
```bash
poetry add <package-name>
```
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 (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.
If you want to contribute changes to `source-sonar-cloud`, here's how you can do that:
1. Make your changes locally, or load the connector's manifest into Connector Builder and make changes there.
2. Make sure your changes are passing our test suite with `airbyte-ci connectors --name=source-sonar-cloud test`
3. 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`
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.
8. Once your PR is merged, the new version of the connector will be automatically published to Docker Hub and our connector registry.

3
airbyte-integrations/connectors/source-sonar-cloud/__init__.py
View File

@@ -1,3 +0,0 @@
#
# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
#

2
airbyte-integrations/connectors/source-sonar-cloud/acceptance-test-config.yml
View File

@@ -4,7 +4,7 @@ connector_image: airbyte/source-sonar-cloud:dev
acceptance_tests:
spec:
tests:
- spec_path: "source_sonar_cloud/spec.yaml"
- spec_path: "manifest.yaml"
connection:
tests:
- config_path: "secrets/config.json"

8
airbyte-integrations/connectors/source-sonar-cloud/main.py
View File

@@ -1,8 +0,0 @@
#
# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
#
from source_sonar_cloud.run import run
if __name__ == "__main__":
run()

693
airbyte-integrations/connectors/source-sonar-cloud/manifest.yaml Normal file
View File

@@ -0,0 +1,693 @@
version: 4.3.0
type: DeclarativeSource
check:
type: CheckStream
stream_names:
- components
definitions:
streams:
components:
type: DeclarativeStream
name: components
primary_key:
- key
retriever:
type: SimpleRetriever
requester:
type: HttpRequester
url_base: https://sonarcloud.io/api
authenticator:
type: BearerAuthenticator
api_token: "{{ config['user_token'] }}"
path: /components/search
http_method: GET
request_parameters:
organization: "{{ config['organization'] }}"
createdAfter: "{{ config['start_date'] }}"
createdBefore: "{{ config['end_date'] }}"
record_selector:
type: RecordSelector
extractor:
type: DpathExtractor
field_path:
- components
paginator:
type: DefaultPaginator
page_token_option:
type: RequestOption
inject_into: request_parameter
field_name: p
page_size_option:
type: RequestOption
inject_into: request_parameter
field_name: ps
pagination_strategy:
type: PageIncrement
page_size: 100
schema_loader:
type: InlineSchemaLoader
schema:
type: object
$schema: http://json-schema.org/draft-07/schema#
additionalProperties: true
properties:
key:
type: string
description: Unique identifier for the component
name:
type: string
description: Name of the component
organization:
type: string
description: Name of the organization to which the component belongs
project:
type: string
description: Name of the project to which the component is associated
qualifier:
type: string
description: Type of the component (e.g., 'TRK' for a project)
issues:
type: DeclarativeStream
name: issues
primary_key:
- key
retriever:
type: SimpleRetriever
requester:
type: HttpRequester
url_base: https://sonarcloud.io/api
authenticator:
type: BearerAuthenticator
api_token: "{{ config['user_token'] }}"
path: >-
/issues/search?componentKeys={{
','.join(config.get('component_keys', [])) }}
http_method: GET
request_parameters:
organization: "{{ config['organization'] }}"
createdAfter: "{{ config['start_date'] }}"
createdBefore: "{{ config['end_date'] }}"
record_selector:
type: RecordSelector
extractor:
type: DpathExtractor
field_path:
- issues
paginator:
type: DefaultPaginator
page_token_option:
type: RequestOption
inject_into: request_parameter
field_name: p
page_size_option:
type: RequestOption
inject_into: request_parameter
field_name: ps
pagination_strategy:
type: PageIncrement
page_size: 100
schema_loader:
type: InlineSchemaLoader
schema:
type: object
$schema: http://json-schema.org/draft-07/schema#
additionalProperties: true
properties:
type:
type: string
description: The type or category of the issue
author:
type: string
description: The author or creator of the issue
component:
type: string
description: The project component associated with the issue
creationDate:
type: string
description: The date and time when the issue was created
debt:
type: string
description: The debt value associated with resolving the issue
effort:
type: string
description: The estimated effort required to resolve the issue
flows:
type: array
description: Information about the code flow related to the issue
hash:
type: string
description: The unique hash identifier of the issue
key:
type: string
description: The unique key or identifier of the issue
line:
type: integer
description: The line number in the source code where the issue occurs
message:
type: string
description: The message or description of the issue
organization:
type: string
description: The organization to which the project belongs
project:
type: string
description: The name of the project where the issue exists
resolution:
type: string
description: The resolution status of the issue
rule:
type: string
description: The rule identifier associated with the issue
severity:
type: string
description: The severity level of the issue
status:
type: string
description: The current status of the issue
tags:
type: array
description: Tags or labels associated with the issue
textRange:
type: object
description: The range of text in the source code where the issue occurs
updateDate:
type: string
description: The date and time when the issue was last updated
metrics:
type: DeclarativeStream
name: metrics
primary_key:
- id
retriever:
type: SimpleRetriever
requester:
type: HttpRequester
url_base: https://sonarcloud.io/api
authenticator:
type: BearerAuthenticator
api_token: "{{ config['user_token'] }}"
path: /metrics/search
http_method: GET
request_parameters:
organization: "{{ config['organization'] }}"
createdAfter: "{{ config['start_date'] }}"
createdBefore: "{{ config['end_date'] }}"
record_selector:
type: RecordSelector
extractor:
type: DpathExtractor
field_path:
- metrics
paginator:
type: DefaultPaginator
page_token_option:
type: RequestOption
inject_into: request_parameter
field_name: p
page_size_option:
type: RequestOption
inject_into: request_parameter
field_name: ps
pagination_strategy:
type: PageIncrement
page_size: 100
schema_loader:
type: InlineSchemaLoader
schema:
type: object
$schema: http://json-schema.org/draft-07/schema#
additionalProperties: true
properties:
type:
type: string
description: >-
The type or format of the metric data (e.g., 'integer', 'float',
'string')
description:
type: string
description: A brief summary or explanation of the metric data
direction:
type: number
description: >-
The direction of the metric data (e.g., 'higher is better' or 'lower
is better')
domain:
type: string
description: The domain or category to which the metric data belongs
hidden:
type: boolean
description: >-
Indicates if the metric data is hidden from normal view (e.g., for
internal use)
id:
type: string
description: The unique identifier for the metric data
key:
type: string
description: The key associated with the metric data (e.g., 'code_quality')
name:
type: string
description: The name or title of the metric data
qualitative:
type: boolean
description: >-
Indicates if the metric data is qualitative in nature (e.g., 'yes'
or
'no')
base_requester:
type: HttpRequester
url_base: https://sonarcloud.io/api
authenticator:
type: BearerAuthenticator
api_token: "{{ config['user_token'] }}"
streams:
- type: DeclarativeStream
name: components
primary_key:
- key
retriever:
type: SimpleRetriever
requester:
type: HttpRequester
url_base: https://sonarcloud.io/api
authenticator:
type: BearerAuthenticator
api_token: "{{ config['user_token'] }}"
path: /components/search
http_method: GET
request_parameters:
organization: "{{ config['organization'] }}"
createdAfter: "{{ config['start_date'] }}"
createdBefore: "{{ config['end_date'] }}"
record_selector:
type: RecordSelector
extractor:
type: DpathExtractor
field_path:
- components
paginator:
type: DefaultPaginator
page_token_option:
type: RequestOption
inject_into: request_parameter
field_name: p
page_size_option:
type: RequestOption
inject_into: request_parameter
field_name: ps
pagination_strategy:
type: PageIncrement
page_size: 100
schema_loader:
type: InlineSchemaLoader
schema:
type: object
$schema: http://json-schema.org/draft-07/schema#
additionalProperties: true
properties:
key:
type: string
description: Unique identifier for the component
name:
type: string
description: Name of the component
organization:
type: string
description: Name of the organization to which the component belongs
project:
type: string
description: Name of the project to which the component is associated
qualifier:
type: string
description: Type of the component (e.g., 'TRK' for a project)
- type: DeclarativeStream
name: issues
primary_key:
- key
retriever:
type: SimpleRetriever
requester:
type: HttpRequester
url_base: https://sonarcloud.io/api
authenticator:
type: BearerAuthenticator
api_token: "{{ config['user_token'] }}"
path: >-
/issues/search?componentKeys={{
','.join(config.get('component_keys', [])) }}
http_method: GET
request_parameters:
organization: "{{ config['organization'] }}"
createdAfter: "{{ config['start_date'] }}"
createdBefore: "{{ config['end_date'] }}"
record_selector:
type: RecordSelector
extractor:
type: DpathExtractor
field_path:
- issues
paginator:
type: DefaultPaginator
page_token_option:
type: RequestOption
inject_into: request_parameter
field_name: p
page_size_option:
type: RequestOption
inject_into: request_parameter
field_name: ps
pagination_strategy:
type: PageIncrement
page_size: 100
schema_loader:
type: InlineSchemaLoader
schema:
type: object
$schema: http://json-schema.org/draft-07/schema#
additionalProperties: true
properties:
type:
type: string
description: The type or category of the issue
author:
type: string
description: The author or creator of the issue
component:
type: string
description: The project component associated with the issue
creationDate:
type: string
description: The date and time when the issue was created
debt:
type: string
description: The debt value associated with resolving the issue
effort:
type: string
description: The estimated effort required to resolve the issue
flows:
type: array
description: Information about the code flow related to the issue
hash:
type: string
description: The unique hash identifier of the issue
key:
type: string
description: The unique key or identifier of the issue
line:
type: integer
description: The line number in the source code where the issue occurs
message:
type: string
description: The message or description of the issue
organization:
type: string
description: The organization to which the project belongs
project:
type: string
description: The name of the project where the issue exists
resolution:
type: string
description: The resolution status of the issue
rule:
type: string
description: The rule identifier associated with the issue
severity:
type: string
description: The severity level of the issue
status:
type: string
description: The current status of the issue
tags:
type: array
description: Tags or labels associated with the issue
textRange:
type: object
description: The range of text in the source code where the issue occurs
updateDate:
type: string
description: The date and time when the issue was last updated
- type: DeclarativeStream
name: metrics
primary_key:
- id
retriever:
type: SimpleRetriever
requester:
type: HttpRequester
url_base: https://sonarcloud.io/api
authenticator:
type: BearerAuthenticator
api_token: "{{ config['user_token'] }}"
path: /metrics/search
http_method: GET
request_parameters:
organization: "{{ config['organization'] }}"
createdAfter: "{{ config['start_date'] }}"
createdBefore: "{{ config['end_date'] }}"
record_selector:
type: RecordSelector
extractor:
type: DpathExtractor
field_path:
- metrics
paginator:
type: DefaultPaginator
page_token_option:
type: RequestOption
inject_into: request_parameter
field_name: p
page_size_option:
type: RequestOption
inject_into: request_parameter
field_name: ps
pagination_strategy:
type: PageIncrement
page_size: 100
schema_loader:
type: InlineSchemaLoader
schema:
type: object
$schema: http://json-schema.org/draft-07/schema#
additionalProperties: true
properties:
type:
type: string
description: >-
The type or format of the metric data (e.g., 'integer', 'float',
'string')
description:
type: string
description: A brief summary or explanation of the metric data
direction:
type: number
description: >-
The direction of the metric data (e.g., 'higher is better' or 'lower
is better')
domain:
type: string
description: The domain or category to which the metric data belongs
hidden:
type: boolean
description: >-
Indicates if the metric data is hidden from normal view (e.g., for
internal use)
id:
type: string
description: The unique identifier for the metric data
key:
type: string
description: The key associated with the metric data (e.g., 'code_quality')
name:
type: string
description: The name or title of the metric data
qualitative:
type: boolean
description: >-
Indicates if the metric data is qualitative in nature (e.g., 'yes' or
'no')
spec:
type: Spec
connection_specification:
type: object
$schema: http://json-schema.org/draft-07/schema#
required:
- component_keys
- organization
- user_token
properties:
component_keys:
type: array
title: Component Keys
description: Comma-separated list of component keys.
examples:
- airbyte-ws-order
- airbyte-ws-checkout
order: 0
end_date:
type: string
title: End date
description: To retrieve issues created before the given date (inclusive).
pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}$
examples:
- YYYY-MM-DD
format: date
order: 1
organization:
type: string
title: Organization
description: >-
Organization key. See <a
href="https://docs.sonarcloud.io/appendices/project-information/#project-and-organization-keys">here</a>.
examples:
- airbyte
order: 2
start_date:
type: string
title: Start date
description: To retrieve issues created after the given date (inclusive).
pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}$
examples:
- YYYY-MM-DD
format: date
order: 3
user_token:
type: string
title: User Token
description: >-
Your User Token. See <a
href="https://docs.sonarcloud.io/advanced-setup/user-accounts/">here</a>.
The token is case sensitive.
airbyte_secret: true
order: 4
additionalProperties: true
metadata:
autoImportSchema:
components: false
issues: false
metrics: false
schemas:
components:
type: object
$schema: http://json-schema.org/draft-07/schema#
additionalProperties: true
properties:
key:
type: string
description: Unique identifier for the component
name:
type: string
description: Name of the component
organization:
type: string
description: Name of the organization to which the component belongs
project:
type: string
description: Name of the project to which the component is associated
qualifier:
type: string
description: Type of the component (e.g., 'TRK' for a project)
issues:
type: object
$schema: http://json-schema.org/draft-07/schema#
additionalProperties: true
properties:
type:
type: string
description: The type or category of the issue
author:
type: string
description: The author or creator of the issue
component:
type: string
description: The project component associated with the issue
creationDate:
type: string
description: The date and time when the issue was created
debt:
type: string
description: The debt value associated with resolving the issue
effort:
type: string
description: The estimated effort required to resolve the issue
flows:
type: array
description: Information about the code flow related to the issue
hash:
type: string
description: The unique hash identifier of the issue
key:
type: string
description: The unique key or identifier of the issue
line:
type: integer
description: The line number in the source code where the issue occurs
message:
type: string
description: The message or description of the issue
organization:
type: string
description: The organization to which the project belongs
project:
type: string
description: The name of the project where the issue exists
resolution:
type: string
description: The resolution status of the issue
rule:
type: string
description: The rule identifier associated with the issue
severity:
type: string
description: The severity level of the issue
status:
type: string
description: The current status of the issue
tags:
type: array
description: Tags or labels associated with the issue
textRange:
type: object
description: The range of text in the source code where the issue occurs
updateDate:
type: string
description: The date and time when the issue was last updated
metrics:
type: object
$schema: http://json-schema.org/draft-07/schema#
additionalProperties: true
properties:
type:
type: string
description: >-
The type or format of the metric data (e.g., 'integer', 'float',
'string')
description:
type: string
description: A brief summary or explanation of the metric data
direction:
type: number
description: >-
The direction of the metric data (e.g., 'higher is better' or 'lower
is better')
domain:
type: string
description: The domain or category to which the metric data belongs
hidden:
type: boolean
description: >-
Indicates if the metric data is hidden from normal view (e.g., for
internal use)
id:
type: string
description: The unique identifier for the metric data
key:
type: string
description: The key associated with the metric data (e.g., 'code_quality')
name:
type: string
description: The name or title of the metric data
qualitative:
type: boolean
description: >-
Indicates if the metric data is qualitative in nature (e.g., 'yes' or
'no')

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

@@ -6,11 +6,11 @@ data:
hosts:
- sonarcloud.io
connectorBuildOptions:
baseImage: docker.io/airbyte/python-connector-base:2.0.0@sha256:c44839ba84406116e8ba68722a0f30e8f6e7056c726f447681bb9e9ece8bd916
baseImage: docker.io/airbyte/source-declarative-manifest:4.4.1@sha256:a8c0f0d32782957beef2c65bac98756b04fff2f3ffc4568a6676d3c83a422a5b
connectorSubtype: api
connectorType: source
definitionId: 3ab1d7d0-1577-4ab9-bcc4-1ff6a4c2c9f2
dockerImageTag: 0.1.17
dockerImageTag: 0.2.0
dockerRepository: airbyte/source-sonar-cloud
documentationUrl: https://docs.airbyte.com/integrations/sources/sonar-cloud
githubIssueLabel: source-sonar-cloud
@@ -25,12 +25,12 @@ data:
releaseStage: alpha
remoteRegistries:
pypi:
enabled: true
enabled: false
packageName: airbyte-source-sonar-cloud
supportLevel: community
tags:
- language:python
- cdk:low-code
- language:manifest-only
connectorTestSuitesOptions:
- suite: liveTests
testConnections:

1041
airbyte-integrations/connectors/source-sonar-cloud/poetry.lock generated
View File

File diff suppressed because it is too large Load Diff

28
airbyte-integrations/connectors/source-sonar-cloud/pyproject.toml
View File

@@ -1,28 +0,0 @@
[build-system]
requires = [ "poetry-core>=1.0.0",]
build-backend = "poetry.core.masonry.api"
[tool.poetry]
version = "0.1.17"
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"

8
airbyte-integrations/connectors/source-sonar-cloud/source_sonar_cloud/__init__.py
View File

@@ -1,8 +0,0 @@
#
# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
#
from .source import SourceSonarCloud
__all__ = ["SourceSonarCloud"]

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

@@ -1,327 +0,0 @@
version: 0.79.1
type: DeclarativeSource
check:
type: CheckStream
stream_names:
- components
definitions:
streams:
components:
type: DeclarativeStream
name: components
primary_key:
- key
retriever:
type: SimpleRetriever
requester:
$ref: "#/definitions/base_requester"
path: /components/search
http_method: GET
request_parameters:
organization: "{{ config['organization'] }}"
createdAfter: "{{ config['start_date'] }}"
createdBefore: "{{ config['end_date'] }}"
record_selector:
type: RecordSelector
extractor:
type: DpathExtractor
field_path:
- components
paginator:
type: DefaultPaginator
page_token_option:
type: RequestOption
inject_into: request_parameter
field_name: p
page_size_option:
type: RequestOption
inject_into: request_parameter
field_name: ps
pagination_strategy:
type: PageIncrement
page_size: 100
schema_loader:
type: InlineSchemaLoader
schema:
$ref: "#/schemas/components"
issues:
type: DeclarativeStream
name: issues
primary_key:
- key
retriever:
type: SimpleRetriever
requester:
$ref: "#/definitions/base_requester"
path: >-
/issues/search?componentKeys={{
','.join(config.get('component_keys', [])) }}
http_method: GET
request_parameters:
organization: "{{ config['organization'] }}"
createdAfter: "{{ config['start_date'] }}"
createdBefore: "{{ config['end_date'] }}"
record_selector:
type: RecordSelector
extractor:
type: DpathExtractor
field_path:
- issues
paginator:
type: DefaultPaginator
page_token_option:
type: RequestOption
inject_into: request_parameter
field_name: p
page_size_option:
type: RequestOption
inject_into: request_parameter
field_name: ps
pagination_strategy:
type: PageIncrement
page_size: 100
schema_loader:
type: InlineSchemaLoader
schema:
$ref: "#/schemas/issues"
metrics:
type: DeclarativeStream
name: metrics
primary_key:
- id
retriever:
type: SimpleRetriever
requester:
$ref: "#/definitions/base_requester"
path: /metrics/search
http_method: GET
request_parameters:
organization: "{{ config['organization'] }}"
createdAfter: "{{ config['start_date'] }}"
createdBefore: "{{ config['end_date'] }}"
record_selector:
type: RecordSelector
extractor:
type: DpathExtractor
field_path:
- metrics
paginator:
type: DefaultPaginator
page_token_option:
type: RequestOption
inject_into: request_parameter
field_name: p
page_size_option:
type: RequestOption
inject_into: request_parameter
field_name: ps
pagination_strategy:
type: PageIncrement
page_size: 100
schema_loader:
type: InlineSchemaLoader
schema:
$ref: "#/schemas/metrics"
base_requester:
type: HttpRequester
url_base: https://sonarcloud.io/api
authenticator:
type: BearerAuthenticator
api_token: "{{ config['user_token'] }}"
streams:
- $ref: "#/definitions/streams/components"
- $ref: "#/definitions/streams/issues"
- $ref: "#/definitions/streams/metrics"
spec:
type: Spec
connection_specification:
type: object
$schema: http://json-schema.org/draft-07/schema#
required:
- component_keys
- organization
- user_token
properties:
component_keys:
type: array
title: Component Keys
description: Comma-separated list of component keys.
examples:
- airbyte-ws-order
- airbyte-ws-checkout
order: 0
end_date:
type: string
title: End date
description: To retrieve issues created before the given date (inclusive).
pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}$
examples:
- YYYY-MM-DD
format: date
order: 1
organization:
type: string
title: Organization
description: >-
Organization key. See <a
href="https://docs.sonarcloud.io/appendices/project-information/#project-and-organization-keys">here</a>.
examples:
- airbyte
order: 2
start_date:
type: string
title: Start date
description: To retrieve issues created after the given date (inclusive).
pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}$
examples:
- YYYY-MM-DD
format: date
order: 3
user_token:
type: string
title: User Token
description: >-
Your User Token. See <a
href="https://docs.sonarcloud.io/advanced-setup/user-accounts/">here</a>.
The token is case sensitive.
airbyte_secret: true
order: 4
additionalProperties: true
metadata:
autoImportSchema:
components: false
issues: false
metrics: false
schemas:
components:
type: object
$schema: http://json-schema.org/draft-07/schema#
additionalProperties: true
properties:
key:
type: string
description: Unique identifier for the component
name:
type: string
description: Name of the component
organization:
type: string
description: Name of the organization to which the component belongs
project:
type: string
description: Name of the project to which the component is associated
qualifier:
type: string
description: Type of the component (e.g., 'TRK' for a project)
issues:
type: object
$schema: http://json-schema.org/draft-07/schema#
additionalProperties: true
properties:
type:
type: string
description: The type or category of the issue
author:
type: string
description: The author or creator of the issue
component:
type: string
description: The project component associated with the issue
creationDate:
type: string
description: The date and time when the issue was created
debt:
type: string
description: The debt value associated with resolving the issue
effort:
type: string
description: The estimated effort required to resolve the issue
flows:
type: array
description: Information about the code flow related to the issue
hash:
type: string
description: The unique hash identifier of the issue
key:
type: string
description: The unique key or identifier of the issue
line:
type: integer
description: The line number in the source code where the issue occurs
message:
type: string
description: The message or description of the issue
organization:
type: string
description: The organization to which the project belongs
project:
type: string
description: The name of the project where the issue exists
resolution:
type: string
description: The resolution status of the issue
rule:
type: string
description: The rule identifier associated with the issue
severity:
type: string
description: The severity level of the issue
status:
type: string
description: The current status of the issue
tags:
type: array
description: Tags or labels associated with the issue
textRange:
type: object
description: The range of text in the source code where the issue occurs
updateDate:
type: string
description: The date and time when the issue was last updated
metrics:
type: object
$schema: http://json-schema.org/draft-07/schema#
additionalProperties: true
properties:
type:
type: string
description: >-
The type or format of the metric data (e.g., 'integer', 'float',
'string')
description:
type: string
description: A brief summary or explanation of the metric data
direction:
type: number
description: >-
The direction of the metric data (e.g., 'higher is better' or 'lower
is better')
domain:
type: string
description: The domain or category to which the metric data belongs
hidden:
type: boolean
description: >-
Indicates if the metric data is hidden from normal view (e.g., for
internal use)
id:
type: string
description: The unique identifier for the metric data
key:
type: string
description: The key associated with the metric data (e.g., 'code_quality')
name:
type: string
description: The name or title of the metric data
qualitative:
type: boolean
description: >-
Indicates if the metric data is qualitative in nature (e.g., 'yes' or
'no')

14
airbyte-integrations/connectors/source-sonar-cloud/source_sonar_cloud/run.py
View File

@@ -1,14 +0,0 @@
#
# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
#
import sys
from airbyte_cdk.entrypoint import launch
from source_sonar_cloud import SourceSonarCloud
def run():
source = SourceSonarCloud()
launch(source, sys.argv[1:])

18
airbyte-integrations/connectors/source-sonar-cloud/source_sonar_cloud/source.py
View File

@@ -1,18 +0,0 @@
#
# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
#
from airbyte_cdk.sources.declarative.yaml_declarative_source import YamlDeclarativeSource
"""
This file provides the necessary constructs to interpret a provided declarative YAML configuration file into
source connector.
WARNING: Do not modify this file.
"""
# Declarative Source
class SourceSonarCloud(YamlDeclarativeSource):
def __init__(self):
super().__init__(**{"path_to_yaml": "manifest.yaml"})

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

@@ -30,6 +30,7 @@ This source can sync data from the [Sonar cloud API](https://sonarcloud.io/web_a
| Version | Date | Pull Request | Subject |
| :------ | :-------------------------------------------------------------------- | :-------------------------------------------------------- | :------------------------------------------------------------------------------ |
| 0.2.0 | 2024-08-14 | [44063](https://github.com/airbytehq/airbyte/pull/44063) | Refactor connector to manifest-only format |
| 0.1.17 | 2024-08-10 | [43569](https://github.com/airbytehq/airbyte/pull/43569) | Update dependencies |
| 0.1.16 | 2024-08-03 | [43249](https://github.com/airbytehq/airbyte/pull/43249) | Update dependencies |
| 0.1.15 | 2024-07-27 | [42651](https://github.com/airbytehq/airbyte/pull/42651) | Update dependencies |