🎉 New Source: Faker (#11738)

* Faker WIP

* Update catalog to handle dates better

* Adding unit tests for faker source

* WIP  - tests mostly passing

* add docs

* bump python version and fix unit tests

* test array types

* remove comment

* better python map

* update `moduleDirectory`

* simplify intiilization\

* use `ConfiguredAirbyteCatalog` in test rather than custom dict class

* Tests passing by using deterministic time

* Bump birthdays

* Update airbyte-integrations/connectors/source-faker/integration_tests/acceptance.py

Co-authored-by: George Claireaux <george@claireaux.co.uk>

* remove bootstrap and stronger types

* better incremental support

* fixup un-used imports

* bump to test codecov

* Add connector to medatata files

Co-authored-by: George Claireaux <george@claireaux.co.uk>

airbyte-config/init/src/main/resources/seed/source_definitions.yaml

@@ -221,6 +221,12 @@
   documentationUrl: https://hub.docker.com/r/airbyte/source-facebook-pages
   icon: facebook.svg
   sourceType: api
+- name: Faker
+  sourceDefinitionId: dfd88b22-b603-4c3d-aad7-3701784586b1
+  dockerRepository: airbyte/source-faker
+  dockerImageTag: 0.1.0
+  documentationUrl: https://docs.airbyte.com/integrations/source-faker
+  sourceType: api
 - name: File
   sourceDefinitionId: 778daa7c-feaf-4db6-96f3-70fd645acc77
   dockerRepository: airbyte/source-file

airbyte-config/init/src/main/resources/seed/source_specs.yaml

@@ -2068,6 +2068,34 @@
         oauthFlowInitParameters: []
         oauthFlowOutputParameters:
         - - "access_token"
+- dockerImage: "airbyte/source-faker:0.1.0"
+  spec:
+    documentationUrl: "https://docs.airbyte.com/integrations/sources/faker"
+    connectionSpecification:
+      $schema: "http://json-schema.org/draft-07/schema#"
+      title: "Faker Source Spec"
+      type: "object"
+      required:
+      - "count"
+      additionalProperties: false
+      properties:
+        count:
+          title: "Count"
+          description: "How many fake records should be generated"
+          type: "integer"
+          minimum: 1
+          default: 100
+          order: 0
+        seed:
+          title: "Seed"
+          description: "Manually control the faker random seed to return the same\
+            \ values on subsequent runs (leave -1 for random)"
+          type: "integer"
+          default: -1
+          order: 1
+    supportsNormalization: false
+    supportsDBT: false
+    supported_destination_sync_modes: []
 - dockerImage: "airbyte/source-file:0.2.10"
   spec:
     documentationUrl: "https://docs.airbyte.io/integrations/sources/file"

airbyte-integrations/connectors/source-faker/.dockerignore

@@ -0,0 +1,6 @@
+*
+!Dockerfile
+!main.py
+!source_faker
+!setup.py
+!secrets

airbyte-integrations/connectors/source-faker/CHANGELOG.md

@@ -0,0 +1,3 @@
+| Version | Date       | Pull Request                                             | Subject                     |
+| :------ | :--------- | :------------------------------------------------------- | :-------------------------- |
+| 0.1.0   | 2022-04-12 | [11738](https://github.com/airbytehq/airbyte/pull/11738) | The Faker Source is created |

airbyte-integrations/connectors/source-faker/Dockerfile

@@ -0,0 +1,38 @@
+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_faker ./source_faker
+
+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.name=airbyte/source-faker

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

@@ -0,0 +1,166 @@
+# Faker Source
+
+This is the repository for the Faker source connector, written in Python.
+For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/sources/faker).
+
+## 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
+```
+
+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
+
+From the Airbyte repository root, run:
+
+```
+./gradlew :airbyte-integrations:connectors:source-faker:build
+```
+
+#### Create credentials
+
+**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/sources/faker)
+to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_faker/spec.json` file.
+Note that the `secrets` directory is gitignored by default, 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 faker 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
+
+First, make sure you build the latest Docker image:
+
+```
+docker build . -t airbyte/source-faker:dev
+```
+
+You can also build the connector image via Gradle:
+
+```
+./gradlew :airbyte-integrations:connectors:source-faker:airbyteDocker
+```
+
+When building via Gradle, the docker image name and tag, respectively, are the values of the `io.airbyte.name` and `io.airbyte.version` `LABEL`s in
+the Dockerfile.
+
+#### Run
+
+Then run any of the connector commands as follows:
+
+```
+docker run --rm airbyte/source-faker:dev spec
+docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-faker:dev check --config /secrets/config.json
+docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-faker:dev discover --config /secrets/config.json
+docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-faker: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 [Source Acceptance Tests](https://docs.airbyte.io/connector-development/testing-connectors/source-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
+
+```
+python -m pytest integration_tests -p integration_tests.acceptance
+```
+
+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-faker:unitTest
+```
+
+To run acceptance and custom integration tests:
+
+```
+./gradlew :airbyte-integrations:connectors:source-faker: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-faker/acceptance-test-config.yml

@@ -0,0 +1,29 @@
+# See [Source Acceptance Tests](https://docs.airbyte.io/connector-development/testing-connectors/source-acceptance-tests-reference)
+# for more information about how to configure these tests
+connector_image: airbyte/source-faker:dev
+tests:
+  spec:
+    - spec_path: "source_faker/spec.json"
+  connection:
+    - config_path: "secrets/config.json"
+      status: "succeed"
+    - config_path: "integration_tests/invalid_config.json"
+      status: "exception"
+  discovery:
+    - config_path: "secrets/config.json"
+  basic_read:
+    - config_path: "secrets/config.json"
+      configured_catalog_path: "integration_tests/configured_catalog.json"
+      empty_streams: []
+      expect_records:
+        path: "integration_tests/expected_records.txt"
+        extra_fields: no
+        exact_order: yes
+        extra_records: no
+  full_refresh:
+    - config_path: "secrets/config.json"
+      configured_catalog_path: "integration_tests/configured_catalog.json"
+      ignored_fields:
+        "Users":
+          - created_at
+          - updated_at

airbyte-integrations/connectors/source-faker/acceptance-test-docker.sh

@@ -0,0 +1,16 @@
+#!/usr/bin/env sh
+
+# Build latest connector image
+docker build . -t $(cat acceptance-test-config.yml | grep "connector_image" | head -n 1 | cut -d: -f2-)
+
+# Pull latest acctest image
+docker pull airbyte/source-acceptance-test:latest
+
+# Run
+docker run --rm -it \
+    -v /var/run/docker.sock:/var/run/docker.sock \
+    -v /tmp:/tmp \
+    -v $(pwd):/test_input \
+    airbyte/source-acceptance-test \
+    --acceptance-test-config /test_input
+

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

@@ -0,0 +1,9 @@
+plugins {
+    id 'airbyte-python'
+    id 'airbyte-docker'
+    id 'airbyte-source-acceptance-test'
+}
+
+airbytePython {
+    moduleDirectory 'source_faker'
+}

airbyte-integrations/connectors/source-faker/integration_tests/__init__.py

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

airbyte-integrations/connectors/source-faker/integration_tests/abnormal_state.json

@@ -0,0 +1,5 @@
+{
+  "Users": {
+    "cursor": -1
+  }
+}

airbyte-integrations/connectors/source-faker/integration_tests/acceptance.py

@@ -0,0 +1,14 @@
+#
+# Copyright (c) 2021 Airbyte, Inc., all rights reserved.
+#
+
+
+import pytest
+
+pytest_plugins = ("source_acceptance_test.plugin",)
+
+
+@pytest.fixture(scope="session", autouse=True)
+def connector_setup():
+    """This fixture is a placeholder for external resources that acceptance test might require."""
+    yield

airbyte-integrations/connectors/source-faker/integration_tests/catalog.json

@@ -0,0 +1,40 @@
+{
+  "streams": [
+    {
+      "name": "Users",
+      "json_schema": {
+        "$schema": "http://json-schema.org/draft-07/schema#",
+        "type": "object",
+        "properties": {
+          "id": { "type": "number" },
+          "created_at": {
+            "type": "string",
+            "format": "date-time",
+            "airbyte_type": "timestamp_without_timezone"
+          },
+          "updated_at": {
+            "type": "string",
+            "format": "date-time",
+            "airbyte_type": "timestamp_without_timezone"
+          },
+          "job": { "type": "string" },
+          "company": { "type": "string" },
+          "ssn": { "type": "string" },
+          "residence": { "type": "string" },
+          "current_location": { "type": "array" },
+          "blood_group": { "type": "string" },
+          "website": { "type": "array" },
+          "username": { "type": "string" },
+          "name": { "type": "string" },
+          "sex": { "type": "string" },
+          "address": { "type": "string" },
+          "mail": { "type": "string" },
+          "birthdate": { "type": "string", "format": "date" }
+        }
+      },
+      "supported_sync_modes": ["incremental", "full_refresh"],
+      "source_defined_cursor": true,
+      "default_cursor_field": ["created_at"]
+    }
+  ]
+}