Adjust plugin structure and add docs

Signed-off-by: jamshale <jamiehalebc@gmail.com>
openwallet-foundation · Nov 17, 2023 · 66d8129 · 66d8129
1 parent db04291
commit 66d8129
Show file tree

Hide file tree

Showing 59 changed files with 223 additions and 290 deletions.
diff --git a/kafka-events/.github/workflows/code-quality-check.yml b/kafka-events/.github/workflows/code-quality-check.yml
diff --git a/kafka-events/.github/workflows/publish-release.yml b/kafka-events/.github/workflows/publish-release.yml
diff --git a/kafka-events/.github/workflows/tests.yml b/kafka-events/.github/workflows/tests.yml
diff --git a/kafka-events/pyproject.toml b/kafka-events/pyproject.toml
diff --git a/kafka-events/.commitlint.config.js → kafka_events/.commitlint.config.js b/kafka-events/.commitlint.config.js → kafka_events/.commitlint.config.js
diff --git a/kafka-events/.gitignore → kafka_events/.gitignore b/kafka-events/.gitignore → kafka_events/.gitignore
diff --git a/kafka-events/.pre-commit-config.yaml → kafka_events/.pre-commit-config.yaml b/kafka-events/.pre-commit-config.yaml → kafka_events/.pre-commit-config.yaml
diff --git a/kafka-events/README.md → kafka_events/README.md b/kafka-events/README.md → kafka_events/README.md
diff --git a/kafka-events/demo/acapy-endpoint.sh → kafka_events/demo/acapy-endpoint.sh b/kafka-events/demo/acapy-endpoint.sh → kafka_events/demo/acapy-endpoint.sh
diff --git a/kafka-events/demo/configs/agency-kafka.yml → kafka_events/demo/configs/agency-kafka.yml b/kafka-events/demo/configs/agency-kafka.yml → kafka_events/demo/configs/agency-kafka.yml
diff --git a/kafka-events/demo/configs/agency.yml → kafka_events/demo/configs/agency.yml b/kafka-events/demo/configs/agency.yml → kafka_events/demo/configs/agency.yml
diff --git a/kafka-events/demo/configs/mediator.yml → kafka_events/demo/configs/mediator.yml b/kafka-events/demo/configs/mediator.yml → kafka_events/demo/configs/mediator.yml
diff --git a/kafka-events/demo/docker-compose.relay.yml → kafka_events/demo/docker-compose.relay.yml b/kafka-events/demo/docker-compose.relay.yml → kafka_events/demo/docker-compose.relay.yml
@@ -77,7 +77,7 @@ services:
   relay:
     image: http-kafka-relay
     build:
-      context: ../http_kafka_relay
+      context: ../kafka_events/v1_0/http_kafka_relay
     environment:
       - BOOTSTRAP_SERVER=kafka
       - INBOUND_TOPIC=acapy-inbound-message

diff --git a/kafka-events/demo/docker-compose.yml → kafka_events/demo/docker-compose.yml b/kafka-events/demo/docker-compose.yml → kafka_events/demo/docker-compose.yml
@@ -103,7 +103,7 @@ services:
   deliverer:
     image: kafka-http-deliverer
     build:
-      context: ../deliverer
+      context: ../kafka_events/v1_0/deliverer
     environment:
       - BOOTSTRAP_SERVER=kafka
       - OUTBOUND_TOPIC=acapy-outbound-message

diff --git a/kafka-events/demo/setup/Dockerfile → kafka_events/demo/setup/Dockerfile b/kafka-events/demo/setup/Dockerfile → kafka_events/demo/setup/Dockerfile
diff --git a/kafka-events/demo/setup/main.py → kafka_events/demo/setup/main.py b/kafka-events/demo/setup/main.py → kafka_events/demo/setup/main.py
@@ -1,11 +1,4 @@
-"""Automate setup of Agency + Mediator:
-
-1. Create invitation from mediator
-2. Receive invitation in Agency
-3. Request mediation from mediator
-4. Set mediator as default
-"""
-
+"""Automate setup of Agency + Mediator."""
 import asyncio
 from os import getenv
 from typing import Any, Callable, TypeVar
@@ -27,6 +20,13 @@
 from acapy_client.models.mediation_create_request import MediationCreateRequest
 from acapy_client.models.mediation_record import MediationRecord
 from acapy_client.models.receive_invitation_request import ReceiveInvitationRequest
+"""
+1. Create invitation from mediator.
+2. Receive invitation in Agency.
+3. Request mediation from mediator.
+4. Set mediator as default.
+"""
+
 
 AGENT = getenv("AGENT_ADMIN_URL")
 MEDIATOR = getenv("MEDIATOR_ADMIN_URL")
@@ -38,6 +38,7 @@
 async def wait_for_state(
     record: RecordType, state: str, retrieve: Callable
 ) -> RecordType:
+    """Wait for record to reach state."""
     while record.state != state:
         await asyncio.sleep(1)
         record = await retrieve(record)
@@ -47,6 +48,7 @@ async def wait_for_state(
 
 
 async def get_mediator_invite(mediator: Client) -> dict:
+    """Retrieve invitation from mediator."""
     invite = await create_invitation.asyncio(
         client=mediator, json_body=CreateInvitationRequest()
     )
@@ -58,6 +60,7 @@ async def get_mediator_invite(mediator: Client) -> dict:
 
 
 async def agent_receive_invitation(agent: Client, invite: dict) -> ConnRecord:
+    """Receive invitation on agent."""
     conn_record = await receive_invitation.asyncio(
         client=agent, json_body=ReceiveInvitationRequest.from_dict(invite)
     )
@@ -72,6 +75,7 @@ async def _retrieve(record: ConnRecord):
 
 
 async def agent_request_mediation(agent: Client, conn_id: str):
+    """Request mediation from mediator."""
     mediation_record = await post_mediation_request_conn_id.asyncio(
         conn_id=conn_id, client=agent, json_body=MediationCreateRequest()
     )
@@ -88,6 +92,7 @@ async def _retrieve(record: MediationRecord):
 
 
 async def agent_set_default_mediator(agent: Client, mediation_id: str):
+    """Set mediator as default."""
     result = await put_mediation_mediation_id_default_mediator.asyncio(
         mediation_id, client=agent
     )
@@ -97,6 +102,7 @@ async def agent_set_default_mediator(agent: Client, mediation_id: str):
 
 
 async def main():
+    """Automate setup of Agency + Mediator."""
     if not AGENT or not MEDIATOR:
         raise RuntimeError(
             "Must set environment variables AGENT_ADMIN_URL and MEDIATOR_ADMIN_URL"

diff --git a/kafka-events/demo/setup/poetry.lock → kafka_events/demo/setup/poetry.lock b/kafka-events/demo/setup/poetry.lock → kafka_events/demo/setup/poetry.lock
diff --git a/kafka-events/demo/setup/pyproject.toml → kafka_events/demo/setup/pyproject.toml b/kafka-events/demo/setup/pyproject.toml → kafka_events/demo/setup/pyproject.toml
diff --git a/kafka-events/docker/Dockerfile → kafka_events/docker/Dockerfile b/kafka-events/docker/Dockerfile → kafka_events/docker/Dockerfile
@@ -21,9 +21,9 @@ RUN poetry install --no-dev
 # Make site packages location more accessible (for use with volumes)
 RUN ln -s $(poetry env info -p)/lib/python3.6/site-packages site-packages
 
-COPY kafka_queue kafka_queue
+COPY kafka_events/v1_0/kafka_queue kafka_queue
 COPY ./docker/default.yml .
 COPY ./docker/plugins-config.yaml .
 
 ENTRYPOINT ["/bin/sh", "-c", "/wait && poetry run aca-py \"$@\"", "--"]
-CMD ["start",  "--plugin", "kafka_queue", "--arg-file", "default.yml"]
+CMD ["start", "--arg-file", "default.yml"]
diff --git a/kafka-events/docker/Dockerfile.test → kafka_events/docker/Dockerfile.test b/kafka-events/docker/Dockerfile.test → kafka_events/docker/Dockerfile.test
diff --git a/kafka-events/docker/README.md → kafka_events/docker/README.md b/kafka-events/docker/README.md → kafka_events/docker/README.md
diff --git a/kafka-events/docker/default.yml → kafka_events/docker/default.yml b/kafka-events/docker/default.yml → kafka_events/docker/default.yml
@@ -6,7 +6,7 @@ admin-insecure-mode: true
 
 # Load toolbox plugin
 plugin:
-  - kafka_queue
+  - kafka_queue.v1_0
 
 plugin-config: plugins-config.yaml
 

diff --git a/kafka-events/docker/docker-compose.yml → kafka_events/docker/docker-compose.yml b/kafka-events/docker/docker-compose.yml → kafka_events/docker/docker-compose.yml
diff --git a/kafka-events/docker/plugins-config.yaml → kafka_events/docker/plugins-config.yaml b/kafka-events/docker/plugins-config.yaml → kafka_events/docker/plugins-config.yaml
diff --git a/kafka-events/docker/scripts/run_tests → kafka_events/docker/scripts/run_tests b/kafka-events/docker/scripts/run_tests → kafka_events/docker/scripts/run_tests
diff --git a/kafka-events/events.md → kafka_events/events.md b/kafka-events/events.md → kafka_events/events.md
diff --git a/kafka-events/example-config.yml → kafka_events/example-config.yml b/kafka-events/example-config.yml → kafka_events/example-config.yml
diff --git a/kafka-events/int/Dockerfile.test.runner → ...events/integration/Dockerfile.test.runner b/kafka-events/int/Dockerfile.test.runner → ...events/integration/Dockerfile.test.runner
diff --git a/kafka-events/int/README.md → kafka_events/integration/README.md b/kafka-events/int/README.md → kafka_events/integration/README.md
diff --git a/kafka-events/int/docker-compose.yml → kafka_events/integration/docker-compose.yml b/kafka-events/int/docker-compose.yml → kafka_events/integration/docker-compose.yml
@@ -47,7 +47,7 @@ services:
   relay:
     image: http-kafka-relay
     build:
-      context: ../http_kafka_relay
+      context: ../kafka_events/v1_0/http_kafka_relay
     ports:
       - 3000:80
     environment:
@@ -65,7 +65,7 @@ services:
   deliverer:
     image: kafka-http-deliverer
     build:
-      context: ../deliverer
+      context: ../kafka_events/v1_0/deliverer
     environment:
       - BOOTSTRAP_SERVER=kafka
       - OUTBOUND_TOPIC=acapy-outbound-message

diff --git a/kafka-events/int/poetry.lock → kafka_events/integration/poetry.lock b/kafka-events/int/poetry.lock → kafka_events/integration/poetry.lock
diff --git a/kafka-events/int/pyproject.toml → kafka_events/integration/pyproject.toml b/kafka-events/int/pyproject.toml → kafka_events/integration/pyproject.toml
diff --git a/kafka-events/int/tests/__init__.py → kafka_events/integration/tests/__init__.py b/kafka-events/int/tests/__init__.py → kafka_events/integration/tests/__init__.py
diff --git a/kafka-events/int/tests/conftest.py → kafka_events/integration/tests/conftest.py b/kafka-events/int/tests/conftest.py → kafka_events/integration/tests/conftest.py
diff --git a/kafka-events/int/tests/test_events.py → ...a_events/integration/tests/test_events.py b/kafka-events/int/tests/test_events.py → ...a_events/integration/tests/test_events.py
diff --git a/kafka-events/int/tests/test_kafka_basic.py → ...nts/integration/tests/test_kafka_basic.py b/kafka-events/int/tests/test_kafka_basic.py → ...nts/integration/tests/test_kafka_basic.py
diff --git a/kafka_events/kafka_events/definition.py b/kafka_events/kafka_events/definition.py
@@ -0,0 +1,10 @@
+"""Version definitions for this plugin."""
+
+versions = [
+    {
+        "major_version": 1,
+        "minimum_minor_version": 0,
+        "current_minor_version": 0,
+        "path": "v1_0",
+    }
+]
diff --git a/kafka-events/deliverer/Dockerfile → ...ts/kafka_events/v1_0/deliverer/Dockerfile b/kafka-events/deliverer/Dockerfile → ...ts/kafka_events/v1_0/deliverer/Dockerfile