Merge pull request #2 from artefactory/bigquery

create new bigquery source in python

Author: maryam21

airbyte-integrations/connectors/source-bigquery/README.md

@@ -1,21 +1,105 @@
-# BigQuery Test Configuration
+# Bigquery Source
 
-In order to test the BigQuery source, you need a service account key file.
+This is the repository for the Bigquery source connector, written in Python.
+For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/bigquery).
 
-## Community Contributor
+## Local development
 
-As a community contributor, you will need access to a GCP project and BigQuery to run tests.
+### Prerequisites
 
-1. Go to the `Service Accounts` page on the GCP console
-1. Click on `+ Create Service Account" button
-1. Fill out a descriptive name/id/description
-1. Click the edit icon next to the service account you created on the `IAM` page
-1. Add the `BigQuery Data Editor` and `BigQuery User` role
-1. Go back to the `Service Accounts` page and use the actions modal to `Create Key`
-1. Download this key as a JSON file
-1. Move and rename this file to `secrets/credentials.json`
+* Python (`^3.9`)
+* Poetry (`^1.7`) - installation instructions [here](https://python-poetry.org/docs/#installation)
 
-## Airbyte Employee
 
-1. Access the `BigQuery Integration Test User` secret on Rippling under the `Engineering` folder
-1. Create a file with the contents at `secrets/credentials.json`
+
+### 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/bigquery)
+to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `src/source_bigquery/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-bigquery spec
+poetry run source-bigquery check --config secrets/config.json
+poetry run source-bigquery discover --config secrets/config.json
+poetry run source-bigquery read --config secrets/config.json --catalog sample_files/configured_catalog.json
+```
+
+### Running tests
+
+To run tests locally, from the connector directory run:
+
+```
+poetry run pytest 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-bigquery build
+```
+
+An image will be available on your host with the tag `airbyte/source-bigquery:dev`.
+
+
+### Running as a docker container
+
+Then run any of the connector commands as follows:
+```
+docker run --rm airbyte/source-bigquery:dev spec
+docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-bigquery:dev check --config /secrets/config.json
+docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-bigquery:dev discover --config /secrets/config.json
+docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-bigquery:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json
+```
+
+### 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-bigquery 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-bigquery 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.
+4. Make sure the connector documentation and its changelog is up to date (`docs/integrations/sources/bigquery.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.

airbyte-integrations/connectors/source-bigquery/acceptance-test-config.yml

@@ -0,0 +1,37 @@
+# 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-bigquery:dev
+acceptance_tests:
+  spec:
+    tests:
+      - spec_path: "source_bigquery/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: []
+# TODO uncomment this block to specify that the tests should assert the connector outputs the records provided in the input file a file
+#        expect_records:
+#          path: "integration_tests/expected_records.jsonl"
+#          exact_order: no
+  incremental: 
+    bypass_reason: "This connector does not implement incremental sync"
+# TODO uncomment this block this block if your connector implements incremental sync: 
+#    tests:
+#      - config_path: "secrets/config.json"
+#        configured_catalog_path: "integration_tests/configured_catalog.json"
+#        future_state:
+#          future_state_path: "integration_tests/abnormal_state.json"
+  full_refresh:
+    tests:
+      - config_path: "secrets/config.json"
+        configured_catalog_path: "integration_tests/configured_catalog.json"

airbyte-integrations/connectors/source-bigquery/build.gradle

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

airbyte-integrations/connectors/source-bigquery/icon.svg

@@ -0,0 +1,5 @@
+{
+  "todo-stream-name": {
+    "todo-field-name": "todo-abnormal-value"
+  }
+}

airbyte-integrations/connectors/source-bigquery/integration_tests/README.md

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