fix folder and update docs

sauljabin · Jan 17, 2025 · af84329 · af84329
1 parent 584495a
commit af84329
Show file tree

Hide file tree

Showing 16 changed files with 31 additions and 21 deletions.
diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
@@ -185,42 +185,52 @@ kaskade consumer -b localhost:19092 --from-beginning -k string -v double -t doub
 kaskade consumer -b localhost:19092 --from-beginning -k string -v boolean -t boolean
 ```
 
+Test json consumer with Schema Registry (Confluent and Redpanda):
+
+```bash
+kaskade consumer -b localhost:19092 --from-beginning -t json-schema \
+        -k string -v registry \
+        --registry url=http://localhost:18081
+```
+
+Test json consumer without Schema Registry:
+
 ```bash
 kaskade consumer -b localhost:19092 --from-beginning -k string -v json -t json
 ```
 
-Test consumer with Schema Registry (Confluent and Redpanda):
+Test avro consumer with Schema Registry (Confluent and Redpanda):
 
 ```bash
-kaskade consumer -b localhost:19092 --from-beginning -t avro \
+kaskade consumer -b localhost:19092 --from-beginning -t avro-schema \
         -k string -v registry \
         --registry url=http://localhost:18081
 ```
 
-Test consumer with Apicurio Registry:
+Test avro consumer with Apicurio Registry:
 
 ```bash
-kaskade consumer -b localhost:19092 --from-beginning -t avro \
+kaskade consumer -b localhost:19092 --from-beginning -t avro-schema \
         -k string -v registry \
         --registry url=http://localhost:18081/apis/ccompat/v7
 ```
 
-Test consumer avro without Schema Registry:
+Test avro consumer without Schema Registry:
 
 ```bash
 kaskade consumer -b localhost:19092 --from-beginning -t avro \
         -k string -v avro \
-        --avro value=tests/avro/user.avsc
+        --avro value=tests/avro_model/user.avsc
 ```
 
-Test consumer with protobuf:
+Test protobuf consumer:
 
 > Install `protoc` with `brew install protobuf`.\
 > Update descriptor with `python -m scripts.protobuf`.
 
 ```bash
 kaskade consumer -b localhost:19092 --from-beginning -t protobuf \
         -k string -v protobuf \
-        --protobuf descriptor=tests/protobuf/user.desc \
+        --protobuf descriptor=tests/protobuf_model/user.desc \
         --protobuf value=User
 ```
diff --git a/poetry.lock b/poetry.lock
diff --git a/scripts/protobuf.py b/scripts/protobuf.py
@@ -2,7 +2,7 @@
 
 
 def main() -> None:
-    path = "tests/protobuf"
+    path = "tests/protobuf_model"
     commands = {
         "build protobuf examples": f"protoc --include_imports --proto_path={path} --python_out={path} --pyi_out={path} --descriptor_set_out={path}/user.desc {path}/user.proto",
     }

diff --git a/scripts/sandbox.py b/scripts/sandbox.py
@@ -18,12 +18,12 @@
 from faker import Faker
 
 from kaskade.utils import pack_bytes, file_to_str, py_to_avro
-from tests.protobuf.user_pb2 import User as ProtobufUser
-from tests.avro.user import User as AvroUser
-from tests.json.user import User as JsonUser
+from tests.protobuf_model.user_pb2 import User as ProtobufUser
+from tests.avro_model.user import User as AvroUser
+from tests.json_model.user import User as JsonUser
 
-JSON_USER_SCHEMA = "tests/json/user.schema.json"
-AVRO_USER_SCHEMA = "tests/avro/user.avsc"
+JSON_USER_SCHEMA = "tests/json_model/user.schema.json"
+AVRO_USER_SCHEMA = "tests/avro_model/user.avsc"
 
 
 class Populator:

diff --git a/tests/avro/__init__.py → tests/avro_model/__init__.py b/tests/avro/__init__.py → tests/avro_model/__init__.py
diff --git a/tests/avro/user.avsc → tests/avro_model/user.avsc b/tests/avro/user.avsc → tests/avro_model/user.avsc
diff --git a/tests/avro/user.py → tests/avro_model/user.py b/tests/avro/user.py → tests/avro_model/user.py
diff --git a/tests/json/__init__.py → tests/json_model/__init__.py b/tests/json/__init__.py → tests/json_model/__init__.py
diff --git a/tests/json/user.py → tests/json_model/user.py b/tests/json/user.py → tests/json_model/user.py
diff --git a/tests/json/user.schema.json → tests/json_model/user.schema.json b/tests/json/user.schema.json → tests/json_model/user.schema.json
diff --git a/tests/protobuf/__init__.py → tests/protobuf_model/__init__.py b/tests/protobuf/__init__.py → tests/protobuf_model/__init__.py
diff --git a/tests/protobuf/user.desc → tests/protobuf_model/user.desc b/tests/protobuf/user.desc → tests/protobuf_model/user.desc
diff --git a/tests/protobuf/user.proto → tests/protobuf_model/user.proto b/tests/protobuf/user.proto → tests/protobuf_model/user.proto
diff --git a/tests/protobuf/user_pb2.py → tests/protobuf_model/user_pb2.py b/tests/protobuf/user_pb2.py → tests/protobuf_model/user_pb2.py
diff --git a/tests/protobuf/user_pb2.pyi → tests/protobuf_model/user_pb2.pyi b/tests/protobuf/user_pb2.pyi → tests/protobuf_model/user_pb2.pyi
diff --git a/tests/tests_deserializers.py b/tests/tests_deserializers.py
@@ -23,18 +23,18 @@
 )
 from kaskade.utils import file_to_str, py_to_avro
 from tests import faker
-from tests.protobuf.user_pb2 import User
+from tests.protobuf_model.user_pb2 import User
 
 
 CURRENT_PATH = os.getcwd()
-DESCRIPTOR_NAME = "protobuf/user.desc"
+DESCRIPTOR_NAME = "protobuf_model/user.desc"
 DESCRIPTOR_PATH = (
     f"{CURRENT_PATH}/{DESCRIPTOR_NAME}"
     if CURRENT_PATH.endswith("tests")
     else f"{CURRENT_PATH}/tests/{DESCRIPTOR_NAME}"
 )
 
-AVRO_SCHEMA_NAME = "avro/user.avsc"
+AVRO_SCHEMA_NAME = "avro_model/user.avsc"
 AVRO_PATH = (
     f"{CURRENT_PATH}/{AVRO_SCHEMA_NAME}"
     if CURRENT_PATH.endswith("tests")