Source microsoft-teams: Migrate to manifest-only (#44116)

Author: ChristoGrab

airbyte-integrations/connectors/source-microsoft-teams/README.md

@@ -1,49 +1,22 @@
-# Microsoft Teams Source
+# Microsoft Teams source connector
 
-This is the repository for the Microsoft Teams configuration based source connector.
-For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/microsoft-teams).
+This directory contains the manifest-only connector for `source-microsoft-teams`.
+This _manifest-only_ connector is not a Python package on its own, as it runs inside of the base `source-declarative-manifest` image.
 
-## Local development
-
-### Prerequisites
-
-- 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
+For information about how to configure and use this connector within Airbyte, see [the connector's full documentation](https://docs.airbyte.com/integrations/sources/microsoft-teams).
 
-**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/microsoft-teams)
-to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `src/source_microsoft_teams/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-microsoft-teams spec
-poetry run source-microsoft-teams check --config secrets/config.json
-poetry run source-microsoft-teams discover --config secrets/config.json
-poetry run source-microsoft-teams read --config secrets/config.json --catalog sample_files/configured_catalog.json
-```
+## Local development
 
-### Running tests
+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!
 
-To run tests locally, from the connector directory run:
-
-```
-poetry run pytest 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,50 +26,38 @@ airbyte-ci connectors --name=source-microsoft-teams build
 
 An image will be available on your host with the tag `airbyte/source-microsoft-teams:dev`.
 
+### Creating credentials
+
+**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/microsoft-teams)
+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-microsoft-teams:dev spec
 docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-microsoft-teams:dev check --config /secrets/config.json
 docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-microsoft-teams:dev discover --config /secrets/config.json
 docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-microsoft-teams: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):
 
 ```bash
 airbyte-ci connectors --name=source-microsoft-teams 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-microsoft-teams 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-microsoft-teams`, 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-microsoft-teams 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/microsoft-teams.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.

airbyte-integrations/connectors/source-microsoft-teams/__init__.py

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

airbyte-integrations/connectors/source-microsoft-teams/acceptance-test-config.yml

@@ -1,4 +1,4 @@
-version: 0.44.0
+version: 4.3.0
 type: DeclarativeSource
 check:
   type: CheckStream
@@ -403,7 +403,8 @@ streams:
         type: HttpRequester
         url_base: https://graph.microsoft.com/v1.0/
         path: >-
-          groups/{{ stream_partition.group_id }}/members?$top={{ config.get('page_size', 20) }}
+          groups/{{ stream_partition.group_id }}/members?$top={{ config.get('page_size',
+          20) }}
         http_method: GET
         request_parameters: {}
         request_headers: {}
@@ -747,7 +748,8 @@ streams:
         type: HttpRequester
         url_base: https://graph.microsoft.com/v1.0/
         path: >-
-          groups/{{ stream_partition.group_id }}/owners?$top={{ config.get('page_size', 20) }}
+          groups/{{ stream_partition.group_id }}/owners?$top={{ config.get('page_size',
+          20) }}
         http_method: GET
         request_parameters: {}
         request_headers: {}
@@ -1069,7 +1071,8 @@ streams:
         type: HttpRequester
         url_base: https://graph.microsoft.com/v1.0/
         path: >-
-          groups/{{ stream_partition.group_id }}/conversations?$top={{ config.get('page_size', 20) }}
+          groups/{{ stream_partition.group_id }}/conversations?$top={{ config.get('page_size',
+          20) }}
         http_method: GET
         request_parameters: {}
         request_headers: {}
@@ -1738,7 +1741,8 @@ streams:
         url_base: https://graph.microsoft.com/v1.0/
         path: >-
           teams/{{ stream_partition.group_id }}/channels/{{
-          stream_partition.channel_id }}/members?$top={{ config.get('page_size', 20) }}
+          stream_partition.channel_id }}/members?$top={{ config.get('page_size', 20)
+          }}
         http_method: GET
         request_parameters: {}
         request_headers: {}
@@ -2329,7 +2333,9 @@ streams:
                                 authenticator:
                                   type: OAuthAuthenticator
                                   client_id: "{{ config['credentials']['client_id'] }}"
-                                  client_secret: "{{ config['credentials']['client_secret'] }}"
+                                  client_secret:
+                                    "{{ config['credentials']['client_secret']
+                                    }}"
                                   refresh_request_body:
                                     scope: https://graph.microsoft.com/.default
                                   token_refresh_endpoint: >-
@@ -3035,7 +3041,9 @@ streams:
                                 authenticator:
                                   type: OAuthAuthenticator
                                   client_id: "{{ config['credentials']['client_id'] }}"
-                                  client_secret: "{{ config['credentials']['client_secret'] }}"
+                                  client_secret:
+                                    "{{ config['credentials']['client_secret']
+                                    }}"
                                   refresh_request_body:
                                     scope: https://graph.microsoft.com/.default
                                   token_refresh_endpoint: >-
@@ -3122,7 +3130,8 @@ streams:
         url_base: https://graph.microsoft.com/v1.0/
         path: >-
           groups/{{ stream_partition.group_id }}/conversations/{{
-          stream_partition.conversation_id }}/threads?$top={{ config.get('page_size', 20) }}
+          stream_partition.conversation_id }}/threads?$top={{ config.get('page_size',
+          20) }}
         http_method: GET
         request_parameters: {}
         request_headers: {}
@@ -3719,7 +3728,9 @@ streams:
                                 authenticator:
                                   type: OAuthAuthenticator
                                   client_id: "{{ config['credentials']['client_id'] }}"
-                                  client_secret: "{{ config['credentials']['client_secret'] }}"
+                                  client_secret:
+                                    "{{ config['credentials']['client_secret']
+                                    }}"
                                   refresh_request_body:
                                     scope: https://graph.microsoft.com/.default
                                   token_refresh_endpoint: >-
@@ -4466,7 +4477,9 @@ streams:
                                 authenticator:
                                   type: OAuthAuthenticator
                                   client_id: "{{ config['credentials']['client_id'] }}"
-                                  client_secret: "{{ config['credentials']['client_secret'] }}"
+                                  client_secret:
+                                    "{{ config['credentials']['client_secret']
+                                    }}"
                                   refresh_request_body:
                                     scope: https://graph.microsoft.com/.default
                                   token_refresh_endpoint: >-
@@ -4559,7 +4572,8 @@ streams:
                     url_base: https://graph.microsoft.com/v1.0/
                     path: >-
                       groups/{{ stream_partition.group_id }}/conversations/{{
-                      stream_partition.conversation_id }}/threads?$top={{ config.get('page_size', 20) }}
+                      stream_partition.conversation_id }}/threads?$top={{ config.get('page_size',
+                      20) }}
                     http_method: GET
                     request_parameters: {}
                     request_headers: {}
@@ -4819,7 +4833,9 @@ streams:
                                 authenticator:
                                   type: OAuthAuthenticator
                                   client_id: "{{ config['credentials']['client_id'] }}"
-                                  client_secret: "{{ config['credentials']['client_secret'] }}"
+                                  client_secret:
+                                    "{{ config['credentials']['client_secret']
+                                    }}"
                                   refresh_request_body:
                                     scope: https://graph.microsoft.com/.default
                                   token_refresh_endpoint: >-
@@ -4911,7 +4927,9 @@ streams:
                                 authenticator:
                                   type: OAuthAuthenticator
                                   client_id: "{{ config['credentials']['client_id'] }}"
-                                  client_secret: "{{ config['credentials']['client_secret'] }}"
+                                  client_secret:
+                                    "{{ config['credentials']['client_secret']
+                                    }}"
                                   refresh_request_body:
                                     scope: https://graph.microsoft.com/.default
                                   token_refresh_endpoint: >-
@@ -5163,8 +5181,12 @@ streams:
                                             request_headers: {}
                                             authenticator:
                                               type: OAuthAuthenticator
-                                              client_id: "{{ config['credentials']['client_id'] }}"
-                                              client_secret: "{{ config['credentials']['client_secret'] }}"
+                                              client_id:
+                                                "{{ config['credentials']['client_id']
+                                                }}"
+                                              client_secret:
+                                                "{{ config['credentials']['client_secret']
+                                                }}"
                                               refresh_request_body:
                                                 scope: https://graph.microsoft.com/.default
                                               token_refresh_endpoint: >-
@@ -5322,7 +5344,8 @@ streams:
         type: HttpRequester
         url_base: https://graph.microsoft.com/v1.0/
         path: >-
-          groups/{{ stream_partition.group_id }}/drives?$top={{ config.get('page_size', 20) }}
+          groups/{{ stream_partition.group_id }}/drives?$top={{ config.get('page_size',
+          20) }}
         http_method: GET
         request_parameters: {}
         request_headers: {}
@@ -5771,11 +5794,11 @@ spec:
                 title: Directory (tenant) ID
                 type: string
                 description:
-                  "A globally unique identifier (GUID) that is different than
-                  your organization name or domain. Follow these steps to obtain: open
-                  one of the Teams where you belong inside the Teams Application -> Click
-                  on the … next to the Team title -> Click on Get link to team -> Copy
-                  the link to the team and grab the tenant ID form the URL"
+                  "A globally unique identifier (GUID) that is different
+                  than your organization name or domain. Follow these steps to obtain:
+                  open one of the Teams where you belong inside the Teams Application
+                  -> Click on the … next to the Team title -> Click on Get link to team
+                  -> Copy the link to the team and grab the tenant ID form the URL"
                 airbyte_secret: true
               client_id:
                 title: Client ID
@@ -5809,11 +5832,11 @@ spec:
                 title: Directory (tenant) ID
                 type: string
                 description:
-                  "A globally unique identifier (GUID) that is different than
-                  your organization name or domain. Follow these steps to obtain: open
-                  one of the Teams where you belong inside the Teams Application -> Click
-                  on the … next to the Team title -> Click on Get link to team -> Copy
-                  the link to the team and grab the tenant ID form the URL"
+                  "A globally unique identifier (GUID) that is different
+                  than your organization name or domain. Follow these steps to obtain:
+                  open one of the Teams where you belong inside the Teams Application
+                  -> Click on the … next to the Team title -> Click on Get link to team
+                  -> Copy the link to the team and grab the tenant ID form the URL"
                 airbyte_secret: true
               client_id:
                 title: Client ID

airbyte-integrations/connectors/source-microsoft-teams/main.py

@@ -9,17 +9,17 @@ data:
       enabled: true
   remoteRegistries:
     pypi:
-      enabled: true
+      enabled: false
       packageName: airbyte-source-microsoft-teams
   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:2.0.0@sha256:c44839ba84406116e8ba68722a0f30e8f6e7056c726f447681bb9e9ece8bd916
+    baseImage: docker.io/airbyte/source-declarative-manifest:4.4.1@sha256:a8c0f0d32782957beef2c65bac98756b04fff2f3ffc4568a6676d3c83a422a5b
   connectorSubtype: api
   connectorType: source
   definitionId: eaf50f04-21dd-4620-913b-2a83f5635227
-  dockerImageTag: 1.1.11
+  dockerImageTag: 1.2.0
   dockerRepository: airbyte/source-microsoft-teams
   githubIssueLabel: source-microsoft-teams
   icon: microsoft-teams.svg
@@ -30,13 +30,18 @@ data:
   releases:
     breakingChanges:
       1.0.0:
-        message: Version 1.0.0 introduces breaking schema changes to all streams. A full schema refresh is required to upgrade to this version. For more details, see our <a href='https://docs.airbyte.io/integrations/sources/microsoft-teams-migrations'>migration guide</a>.
+        message:
+          Version 1.0.0 introduces breaking schema changes to all streams.
+          A full schema refresh is required to upgrade to this version. For more details,
+          see our <a
+          href='https://docs.airbyte.io/integrations/sources/microsoft-teams-migrations'>migration
+          guide</a>.
         upgradeDeadline: "2024-01-24"
   supportLevel: community
   documentationUrl: https://docs.airbyte.com/integrations/sources/microsoft-teams
   tags:
-    - language:python
     - cdk:low-code
+    - language:manifest-only
   connectorTestSuitesOptions:
     - suite: liveTests
       testConnections: