✨ Google Drive Source

airbyte-integrations/connectors/source-google-drive/.dockerignore

@@ -0,0 +1,7 @@
+*
+!Dockerfile
+!Dockerfile.test
+!main.py
+!source_google_drive
+!setup.py
+!secrets

airbyte-integrations/connectors/source-google-drive/README.md

@@ -0,0 +1,126 @@
+# Google Drive Source
+
+This is the repository for the Google Drive source connector, written in Python.
+For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/sources/google-drive).
+
+## Local development
+
+### Prerequisites
+**To iterate on this connector, make sure to complete this prerequisites section.**
+
+#### Minimum Python version required `= 3.10.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.
+
+To build using Gradle, from the Airbyte repository root, run:
+```
+./gradlew :airbyte-integrations:connectors:source-google-drive:build
+```
+
+#### Create credentials
+**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/sources/google-drive)
+to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_google_drive/spec.json` 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 google-drive 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
+Build the docker image via `airbyte-ci`:
+```
+airbyte-ci connectors --name=source-google-drive build
+```
+
+#### Run
+Then run any of the connector commands as follows:
+```
+docker run --rm airbyte/source-google-drive:dev spec
+docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-google-drive:dev check --config /secrets/config.json
+docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-google-drive:dev discover --config /secrets/config.json
+docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-google-drive: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.
+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
+```
+docker build . --no-cache -t airbyte/source-google-drive:dev \
+&& python -m pytest -p connector_acceptance_test.plugin
+```
+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-google-drive:unitTest
+```
+To run acceptance and custom integration tests:
+```
+./gradlew :airbyte-integrations:connectors:source-google-drive: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.

airbyte-integrations/connectors/source-google-drive/acceptance-test-config.yml

@@ -0,0 +1,38 @@
+acceptance_tests:
+  basic_read:
+    tests:
+      - config_path: secrets/config.json
+        expect_records:
+          path: integration_tests/expected_records.jsonl
+          exact_order: true
+        timeout_seconds: 1800
+        expect_trace_message_on_failure: false
+
+  connection:
+    tests:
+      - config_path: secrets/config.json
+        status: succeed
+      - config_path: secrets/oauth_config.json
+        status: succeed
+      - config_path: integration_tests/invalid_config.json
+        status: failed
+  discovery:
+    tests:
+      - config_path: secrets/config.json
+  full_refresh:
+    tests:
+      - config_path: secrets/config.json
+        configured_catalog_path: integration_tests/configured_catalog.json
+        timeout_seconds: 1800
+
+  incremental:
+    tests:
+      - config_path: secrets/config.json
+        configured_catalog_path: integration_tests/configured_catalog.json
+        future_state:
+          future_state_path: integration_tests/abnormal_state.json
+        timeout_seconds: 1800
+  spec:
+    tests:
+      - spec_path: integration_tests/spec.json
+connector_image: airbyte/source-google-drive:dev

airbyte-integrations/connectors/source-google-drive/acceptance-test-docker.sh

@@ -0,0 +1,2 @@
+#!/usr/bin/env sh
+source "$(git rev-parse --show-toplevel)/airbyte-integrations/bases/connector-acceptance-test/acceptance-test-docker.sh"

airbyte-integrations/connectors/source-google-drive/examples/configured_catalog.json

@@ -0,0 +1,13 @@
+{
+  "streams": [
+    {
+      "stream": {
+        "name": "my_file_stream",
+        "json_schema": {},
+        "supported_sync_modes": ["full_refresh", "incremental"]
+      },
+      "sync_mode": "incremental",
+      "destination_sync_mode": "overwrite"
+    }
+  ]
+}

airbyte-integrations/connectors/source-google-drive/examples/state.json

@@ -0,0 +1,16 @@
+[
+  {
+    "type": "STREAM",
+    "stream": {
+      "stream_descriptor": {
+        "name": "my_file_stream"
+      },
+      "stream_state": {
+        "history": {
+          "https://drive.google.com/file/d/1kbXDc8UFkQcWCRfKKtSjCtlgD7EUXzuM": "2023-10-16T14:51:33.000000Z"
+        },
+        "_ab_source_file_last_modified": "2023-10-16T14:51:33.000000Z_https://drive.google.com/file/d/1kbXDc8UFkQcWCRfKKtSjCtlgD7EUXzuM"
+      }
+    }
+  }
+]

airbyte-integrations/connectors/source-google-drive/integration_tests/abnormal_state.json

@@ -0,0 +1,35 @@
+[
+  {
+    "type": "STREAM",
+    "stream": {
+      "stream_state": {
+        "history": {
+          "test.jsonl": "2023-10-16T15:16:07.574000Z",
+          "subfolder/test2.jsonl": "2023-10-19T10:43:57.000000Z"
+        },
+        "_ab_source_file_last_modified": "2023-10-19T10:43:57.000000Z_subfolder/test2.jsonl"
+      },
+      "stream_descriptor": {
+        "name": "test"
+      }
+    }
+  },
+  {
+    "type": "STREAM",
+    "stream": {
+      "stream_descriptor": {
+        "name": "test_unstructured"
+      },
+      "stream_state": {
+        "_ab_source_file_last_modified": "2023-10-27T10:26:09.076000Z_testdoc_presentation.pdf",
+        "history": {
+          "testdoc_google.docx": "2023-10-27T09:27:54.134000Z",
+          "testdoc_docx.docx": "2023-10-27T09:45:54.919000Z",
+          "testdoc_pdf.pdf": "2023-10-27T09:45:59.945000Z",
+          "testdoc_ocr_pdf.pdf": "2023-10-27T09:46:05.349000Z",
+          "testdoc_presentation.pdf": "2023-10-27T10:26:09.076000Z"
+        }
+      }
+    }
+  }
+]

airbyte-integrations/connectors/source-google-drive/integration_tests/acceptance.py

@@ -0,0 +1,16 @@
+#
+# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
+#
+
+
+from typing import Iterable
+
+import pytest
+
+pytest_plugins = ("connector_acceptance_test.plugin",)
+
+
+@pytest.fixture(scope="session", autouse=True)
+def connector_setup() -> Iterable[None]:
+    """This fixture is a placeholder for external resources that acceptance test might require."""
+    yield

airbyte-integrations/connectors/source-google-drive/integration_tests/configured_catalog.json

@@ -0,0 +1,60 @@
+{
+  "streams": [
+    {
+      "stream": {
+        "name": "test",
+        "json_schema": {
+          "type": "object",
+          "properties": {
+            "y": {
+              "type": ["null", "integer"]
+            },
+            "x": {
+              "type": ["null", "integer"]
+            },
+            "_ab_source_file_last_modified": {
+              "type": "string",
+              "format": "date-time"
+            },
+            "_ab_source_file_url": {
+              "type": "string"
+            }
+          }
+        },
+        "supported_sync_modes": ["full_refresh", "incremental"],
+        "source_defined_cursor": true,
+        "default_cursor_field": ["_ab_source_file_last_modified"]
+      },
+      "sync_mode": "incremental",
+      "destination_sync_mode": "append"
+    },
+    {
+      "stream": {
+        "name": "test_unstructured",
+        "json_schema": {
+          "type": "object",
+          "properties": {
+            "document_key": {
+              "type": ["null", "integer"]
+            },
+            "content": {
+              "type": ["null", "integer"]
+            },
+            "_ab_source_file_last_modified": {
+              "type": "string",
+              "format": "date-time"
+            },
+            "_ab_source_file_url": {
+              "type": "string"
+            }
+          }
+        },
+        "supported_sync_modes": ["full_refresh", "incremental"],
+        "source_defined_cursor": true,
+        "default_cursor_field": ["_ab_source_file_last_modified"]
+      },
+      "sync_mode": "incremental",
+      "destination_sync_mode": "append"
+    }
+  ]
+}

airbyte-integrations/connectors/source-google-drive/integration_tests/expected_records.jsonl

@@ -0,0 +1,9 @@
+{"stream": "test", "data": {"x": 999, "_ab_source_file_last_modified": "2023-10-16T15:16:07.574000Z", "_ab_source_file_url": "test.jsonl"}, "emitted_at": 162727468000}
+{"stream": "test", "data": {"x": 9999, "_ab_source_file_last_modified": "2023-10-16T15:16:07.574000Z", "_ab_source_file_url": "test.jsonl"}, "emitted_at": 162727468000}
+{"stream": "test", "data": {"y": 9999, "_ab_source_file_last_modified": "2023-10-19T10:43:57.000000Z", "_ab_source_file_url": "subfolder/test2.jsonl"}, "emitted_at": 162727468000}
+{"stream": "test", "data": {"y": 123, "_ab_source_file_last_modified": "2023-10-19T10:43:57.000000Z", "_ab_source_file_url": "subfolder/test2.jsonl"}, "emitted_at": 162727468000}
+{"stream": "test_unstructured", "data": {"content": "# Heading\n\nThis is the content which is not just a single word", "document_key": "testdoc_google.docx", "_ab_source_file_last_modified": "2023-10-27T09:27:54.134000Z", "_ab_source_file_url": "testdoc_google.docx"}, "emitted_at": 1698400261074}
+{"stream": "test_unstructured", "data": {"content": "# Heading\n\nThis is the content which is not just a single word", "document_key": "testdoc_docx.docx", "_ab_source_file_last_modified": "2023-10-27T09:45:54.919000Z", "_ab_source_file_url": "testdoc_docx.docx"}, "emitted_at": 1698400261867}
+{"stream": "test_unstructured", "data": {"content": "# Heading\n\nThis is the content which is not just a single word", "document_key": "testdoc_pdf.pdf", "_ab_source_file_last_modified": "2023-10-27T09:45:59.945000Z", "_ab_source_file_url": "testdoc_pdf.pdf"}, "emitted_at": 1698400264556}
+{"stream": "test_unstructured", "data": {"content": "This is a test", "document_key": "testdoc_ocr_pdf.pdf", "_ab_source_file_last_modified": "2023-10-27T09:46:05.349000Z", "_ab_source_file_url": "testdoc_ocr_pdf.pdf"}, "emitted_at": 1698400267184}
+{"stream": "test_unstructured", "data": {"content": "This is a test", "document_key": "testdoc_presentation.pdf", "_ab_source_file_last_modified": "2023-10-27T10:26:09.076000Z", "_ab_source_file_url": "testdoc_presentation.pdf"}, "emitted_at": 1698402779268}

airbyte-integrations/connectors/source-google-drive/integration_tests/invalid_config.json

@@ -0,0 +1,19 @@
+{
+  "folder_url": "https://drive.google.com/drive/folders/yyy",
+  "credentials": {
+    "auth_type": "Service",
+    "service_account_info": "abc"
+  },
+  "streams": [
+    {
+      "name": "test",
+      "globs": ["**/*.jsonl"],
+      "format": {
+        "filetype": "jsonl"
+      },
+      "schemaless": false,
+      "validation_policy": "Emit Record",
+      "days_to_sync_if_history_is_full": 3
+    }
+  ]
+}