[DOP-21443] Add XML API schema (#142)

Author: IlyasDevelopment

docs/changelog/next_release/142.feature.rst

@@ -0,0 +1 @@
+Add XML API schema

syncmaster/schemas/v1/__init__.py

@@ -36,7 +36,7 @@
     PostgresReadTransferSourceAndTarget,
     ReadDBTransfer,
 )
-from syncmaster.schemas.v1.transfers.file_format import CSV, JSON, Excel, JSONLine
+from syncmaster.schemas.v1.transfers.file_format import CSV, JSON, XML, Excel, JSONLine
 from syncmaster.schemas.v1.transfers.run import (
     CreateRunSchema,
     ReadRunSchema,

syncmaster/schemas/v1/file_formats.py

@@ -6,3 +6,4 @@
 JSONLINE_FORMAT = Literal["jsonline"]
 JSON_FORMAT = Literal["json"]
 EXCEL_FORMAT = Literal["excel"]
+XML_FORMAT = Literal["xml"]

syncmaster/schemas/v1/transfers/file/base.py

@@ -7,28 +7,32 @@
 
 from pydantic import BaseModel, Field, field_validator
 
-from syncmaster.schemas.v1.transfers.file_format import CSV, JSON, Excel, JSONLine
+from syncmaster.schemas.v1.transfers.file_format import CSV, JSON, XML, Excel, JSONLine
 
 
 # At the moment the ReadTransferSourceParams and ReadTransferTargetParams
 # classes are identical but may change in the future
 class ReadFileTransferSource(BaseModel):
     directory_path: str
-    file_format: CSV | JSONLine | JSON | Excel = Field(..., discriminator="type")
+    file_format: CSV | JSONLine | JSON | Excel | XML = Field(..., discriminator="type")
     options: dict[str, Any]
 
 
 class ReadFileTransferTarget(BaseModel):
     directory_path: str
-    file_format: CSV | JSONLine | Excel = Field(..., discriminator="type")  # JSON format is not supported for writing
+    # JSON format is not supported for writing
+    file_format: CSV | JSONLine | Excel | XML = Field(
+        ...,
+        discriminator="type",
+    )
     options: dict[str, Any]
 
 
 # At the moment the CreateTransferSourceParams and CreateTransferTargetParams
 # classes are identical but may change in the future
 class CreateFileTransferSource(BaseModel):
     directory_path: str
-    file_format: CSV | JSONLine | JSON | Excel = Field(..., discriminator="type")
+    file_format: CSV | JSONLine | JSON | Excel | XML = Field(..., discriminator="type")
     options: dict[str, Any] = Field(default_factory=dict)
 
     class Config:
@@ -44,7 +48,11 @@ def _directory_path_is_valid_path(cls, value):
 
 class CreateFileTransferTarget(BaseModel):
     directory_path: str
-    file_format: CSV | JSONLine | Excel = Field(..., discriminator="type")  # JSON FORMAT IS NOT SUPPORTED AS A TARGET !
+    # JSON format is not supported as a target
+    file_format: CSV | JSONLine | Excel | XML = Field(
+        ...,
+        discriminator="type",
+    )
     options: dict[str, Any] = Field(default_factory=dict)
 
     class Config:

syncmaster/schemas/v1/transfers/file_format.py

@@ -9,6 +9,7 @@
     EXCEL_FORMAT,
     JSON_FORMAT,
     JSONLINE_FORMAT,
+    XML_FORMAT,
 )
 
 
@@ -38,3 +39,9 @@ class Excel(BaseModel):
     type: EXCEL_FORMAT
     include_header: bool = False
     start_cell: str | None = None
+
+
+class XML(BaseModel):
+    type: XML_FORMAT
+    root_tag: str
+    row_tag: str

tests/test_unit/test_transfers/test_create_transfer.py

@@ -636,11 +636,11 @@ async def test_developer_plus_can_not_create_transfer_with_target_format_json(
                     "context": {
                         "discriminator": "'type'",
                         "tag": "json",
-                        "expected_tags": "'csv', 'jsonline', 'excel'",
+                        "expected_tags": "'csv', 'jsonline', 'excel', 'xml'",
                     },
                     "input": {"type": "json", "lineSep": "\n", "encoding": "utf-8"},
                     "location": ["body", "target_params", "s3", "file_format"],
-                    "message": "Input tag 'json' found using 'type' does not match any of the expected tags: 'csv', 'jsonline', 'excel'",
+                    "message": "Input tag 'json' found using 'type' does not match any of the expected tags: 'csv', 'jsonline', 'excel', 'xml'",
                     "code": "union_tag_invalid",
                 },
             ],

tests/test_unit/test_transfers/test_file_transfers/test_create_transfer.py

@@ -51,6 +51,18 @@
                 "some": "option",
             },
         },
+        {
+            "type": "s3",
+            "directory_path": "/some/xml/path",
+            "file_format": {
+                "type": "xml",
+                "root_tag": "data",
+                "row_tag": "record",
+            },
+            "options": {
+                "some": "option",
+            },
+        },
     ],
 )
 async def test_developer_plus_can_create_s3_transfer(
@@ -127,6 +139,11 @@ async def test_developer_plus_can_create_s3_transfer(
             "include_header": True,
             "start_cell": "A1",
         },
+        "xml": {
+            "type": "xml",
+            "root_tag": "data",
+            "row_tag": "record",
+        },
     }
 
     for params in (transfer.source_params, transfer.target_params):
@@ -165,6 +182,15 @@ async def test_developer_plus_can_create_s3_transfer(
                 "start_cell": "A1",
             },
         },
+        {
+            "type": "hdfs",
+            "directory_path": "/some/xml/path",
+            "file_format": {
+                "type": "xml",
+                "root_tag": "data",
+                "row_tag": "record",
+            },
+        },
     ],
 )
 async def test_developer_plus_can_create_hdfs_transfer(
@@ -242,6 +268,11 @@ async def test_developer_plus_can_create_hdfs_transfer(
             "include_header": True,
             "start_cell": "A1",
         },
+        "xml": {
+            "type": "xml",
+            "root_tag": "data",
+            "row_tag": "record",
+        },
     }
 
     for params in (transfer.source_params, transfer.target_params):
@@ -280,6 +311,15 @@ async def test_developer_plus_can_create_hdfs_transfer(
                 "include_header": True,
             },
         },
+        {
+            "type": "s3",
+            "directory_path": "some/path",
+            "file_format": {
+                "type": "xml",
+                "root_tag": "data",
+                "row_tag": "record",
+            },
+        },
     ],
 )
 async def test_cannot_create_file_transfer_with_relative_path(

tests/test_unit/test_transfers/test_file_transfers/test_read_transfer.py

@@ -33,6 +33,16 @@
             },
             "options": {},
         },
+        {
+            "type": "s3",
+            "directory_path": "/some/xml/path",
+            "file_format": {
+                "type": "xml",
+                "root_tag": "data",
+                "row_tag": "record",
+            },
+            "options": {},
+        },
     ],
 )
 @pytest.mark.parametrize(

tests/test_unit/test_transfers/test_file_transfers/test_update_transfer.py

@@ -33,6 +33,16 @@
             },
             "options": {},
         },
+        {
+            "type": "s3",
+            "directory_path": "/some/xml/path",
+            "file_format": {
+                "type": "xml",
+                "root_tag": "data",
+                "row_tag": "record",
+            },
+            "options": {},
+        },
     ],
 )
 @pytest.mark.parametrize(