✨Source Okta: migrate to low-code

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

@@ -1,109 +1,103 @@
 # Okta Source
 
-This is the repository for the Okta source connector, written in Python.
-For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/sources/okta).
+This is the repository for the Okta configuration based source connector.
+For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/okta).
 
 ## Local development
 
 ### Prerequisites
 
-**To iterate on this connector, make sure to complete this prerequisites section.**
+* Python (`^3.9`)
+* Poetry (`^1.7`) - installation instructions [here](https://python-poetry.org/docs/#installation)
 
-#### Build & Activate Virtual Environment and install dependencies
 
-From this connector directory, create a virtual environment:
 
-```shell
-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:
+### Installing the connector
 
-```shell
-source .venv/bin/activate
-pip install -r requirements.txt
+From this connector directory, run:
+```bash
+poetry install --with dev
 ```
 
-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.
+### Create credentials
 
-#### Create credentials
-
-**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/sources/okta)
-to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_okta/spec.json` file.
+**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/okta)
+to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `src/source_okta/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.
+See `sample_files/config.json` for a sample config file.
 
-**If you are an Airbyte core member**, copy the credentials in Lastpass under the secret name `source okta test creds`
-and place them into `secrets/config.json`.
 
 ### Locally running the connector
 
-```shell
-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
+```
+poetry run source-okta spec
+poetry run source-okta check --config secrets/config.json
+poetry run source-okta discover --config secrets/config.json
+poetry run source-okta read --config secrets/config.json --catalog integration_tests/configured_catalog.json
 ```
 
-### Locally running the connector docker image
+### Running tests
 
+To run tests locally, from the connector directory run:
 
-#### Build
-**Via [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md) (recommended):**
-```bash
-airbyte-ci connectors --name=source-okta build
+```
+poetry run pytest tests
 ```
 
-An image will be built with the tag `airbyte/source-okta:dev`.
+### Building the docker image
 
-**Via `docker build`:**
+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
-docker build -t airbyte/source-okta:dev .
+airbyte-ci connectors --name=source-okta build
 ```
 
-#### Run
+An image will be available on your host with the tag `airbyte/source-okta:dev`.
 
-Then run any of the connector commands as follows:
 
-```shell
+### Running as a docker container
+
+Then run any of the connector commands as follows:
+```
 docker run --rm airbyte/source-okta:dev spec
 docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-okta:dev check --config /secrets/config.json
 docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-okta:dev discover --config /secrets/config.json
 docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-okta:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json
 ```
 
+### Running our CI test suite
 
-## Testing
 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-okta 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
+### 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:
+All of your dependencies should be managed via Poetry. 
+To add a new dependency, run:
+```bash
+poetry add <package-name>
+```
 
-* required for your connector to work need to go to `MAIN_REQUIREMENTS` list.
-* required for the testing need to go to `TEST_REQUIREMENTS` list
+Please commit the changes to `pyproject.toml` and `poetry.lock` files.
+
+## Publishing a new version of the connector
 
-### 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-okta 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/okta.md`).
+4. Make sure the connector documentation and its changelog is up to date (`docs/integrations/sources/okta.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-okta/__init__.py

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

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

@@ -3,7 +3,7 @@ test_strictness_level: high
 acceptance_tests:
   spec:
     tests:
-      - spec_path: "source_okta/spec.json"
+      - spec_path: "source_okta/spec.yaml"
   connection:
     tests:
       - config_path: "secrets/config.json"

airbyte-integrations/connectors/source-okta/main.py

@@ -2,7 +2,13 @@
 # Copyright (c) 2023 Airbyte, Inc., all rights reserved.
 #
 
-from source_okta.run import run
+
+import sys
+
+from airbyte_cdk.entrypoint import launch
+from source_okta import SourceOkta
+
 
 if __name__ == "__main__":
-    run()
+    source = SourceOkta()
+    launch(source, sys.argv[1:])

airbyte-integrations/connectors/source-okta/metadata.yaml

@@ -2,28 +2,39 @@ data:
   ab_internal:
     ql: 200
     sl: 100
+  registries:
+    oss:
+      enabled: true
+    cloud:
+      enabled: true
+  remoteRegistries:
+    pypi:
+      enabled: true
+      packageName: airbyte-source-okta
+  connectorBuildOptions:
+    # Please update to the latest version of the connector base image.
+    # https://hub.docker.com/r/airbyte/python-connector-base
+    # Please use the full address with sha256 hash to guarantee build reproducibility.
+    baseImage: docker.io/airbyte/python-connector-base:1.0.0@sha256:dd17e347fbda94f7c3abff539be298a65af2d7fc27a307d89297df1081a45c27
   connectorSubtype: api
   connectorType: source
   definitionId: 1d4fdb25-64fc-4569-92da-fcdca79a8372
-  dockerImageTag: 0.1.16
+  dockerImageTag: 1.0.0
   dockerRepository: airbyte/source-okta
   documentationUrl: https://docs.airbyte.com/integrations/sources/okta
   githubIssueLabel: source-okta
-  icon: okta.svg
+  icon: icon.svg
   license: MIT
   name: Okta
-  remoteRegistries:
-    pypi:
-      enabled: true
-      packageName: airbyte-source-okta
-  registries:
-    cloud:
-      enabled: true
-    oss:
-      enabled: true
   releaseStage: alpha
+  releases:
+    breakingChanges:
+      1.0.0:
+        upgradeDeadline: "2024-12-31"
+        message: "Migrate Okta connector to Low Code Framework"
   supportLevel: community
+  documentationUrl: https://docs.airbyte.com/integrations/sources/okta
   tags:
     - language:python
-    - cdk:python
+    - cdk:low-code
 metadataSpecVersion: "1.0"