[DOP-25451] Sync name length limits for all entities

dolfinus · dolfinus · commit 37027e36a175 · 2025-04-11T15:40:52.000+03:00
diff --git a/docs/changelog/0.2.2.rst b/docs/changelog/0.2.2.rst
@@ -6,7 +6,7 @@ Breaking
 
 - Use ``PUT /v1/qroups/:id`` instead of ``PATCH /v1/qroups/:id``.
 - Use ``PUT /v1/queues/:id`` instead of ``PATCH /v1/queues/:id``.
-- Minimal queue name is 3 symbols instead of 1.
+- Now allowed names length should be in 3..128 symbols range, not 1..inf.
 
 Improvements
 ------------
diff --git a/syncmaster/db/migrations/versions/2023-11-23_0002_create_group_table.py b/syncmaster/db/migrations/versions/2023-11-23_0002_create_group_table.py
@@ -22,7 +22,7 @@ def upgrade():
     op.create_table(
         "group",
         sa.Column("id", sa.BigInteger(), nullable=False),
-        sa.Column("name", sa.String(length=256), nullable=False),
+        sa.Column("name", sa.String(length=128), nullable=False),
         sa.Column("description", sa.String(length=512), nullable=False),
         sa.Column("owner_id", sa.BigInteger(), nullable=False),
         sa.Column("created_at", sa.DateTime(timezone=True), server_default=sa.text("now()"), nullable=False),
diff --git a/syncmaster/db/models/group.py b/syncmaster/db/models/group.py
@@ -71,7 +71,7 @@ def roles_at_least(cls, role: str | GroupMemberRole) -> list[str]:
 
 class Group(Base, TimestampMixin):
     id: Mapped[int] = mapped_column(BigInteger, primary_key=True)
-    name: Mapped[str] = mapped_column(String(256), nullable=False, unique=True)
+    name: Mapped[str] = mapped_column(String(128), nullable=False, unique=True)
     description: Mapped[str] = mapped_column(String(512), nullable=False, default="")
     owner_id: Mapped[int] = mapped_column(ForeignKey("user.id", ondelete="CASCADE"), nullable=False, index=True)
 
diff --git a/syncmaster/schemas/v1/connections/clickhouse.py b/syncmaster/schemas/v1/connections/clickhouse.py
@@ -29,7 +29,7 @@ class ReadClickhouseConnectionDataSchema(BaseModel):
 
 
 class CreateClickhouseConnectionSchema(CreateConnectionBaseSchema):
-    type: CLICKHOUSE_TYPE = Field(..., description="Connection type")
+    type: CLICKHOUSE_TYPE = Field(description="Connection type")
     data: CreateClickhouseConnectionDataSchema = Field(
         ...,
         alias="connection_data",
diff --git a/syncmaster/schemas/v1/connections/connection.py b/syncmaster/schemas/v1/connections/connection.py
@@ -125,7 +125,7 @@
 
 class ConnectionCopySchema(BaseModel):
     new_group_id: int
-    new_name: NameConstr | None = None  # noqa: F722
+    new_name: NameConstr | None = None
     remove_source: bool = False
 
 
diff --git a/syncmaster/schemas/v1/connections/connection_base.py b/syncmaster/schemas/v1/connections/connection_base.py
@@ -10,9 +10,9 @@
 
 
 class CreateConnectionBaseSchema(BaseModel):
-    group_id: int = Field(..., description="Connection owner group id")
-    name: NameConstr = Field(..., description="Connection name")  # noqa: F722
-    description: str = Field(..., description="Additional description")
+    group_id: int = Field(description="Connection owner group id")
+    name: NameConstr = Field(description="Connection name")
+    description: str = Field(description="Additional description")
 
     model_config = ConfigDict(populate_by_name=True)
 
diff --git a/syncmaster/schemas/v1/connections/ftp.py b/syncmaster/schemas/v1/connections/ftp.py
@@ -26,7 +26,7 @@ class ReadFTPConnectionDataSchema(BaseModel):
 
 
 class CreateFTPConnectionSchema(CreateConnectionBaseSchema):
-    type: FTP_TYPE = Field(..., description="Connection type")
+    type: FTP_TYPE = Field(description="Connection type")
     data: CreateFTPConnectionDataSchema = Field(
         ...,
         alias="connection_data",
diff --git a/syncmaster/schemas/v1/connections/ftps.py b/syncmaster/schemas/v1/connections/ftps.py
@@ -26,7 +26,7 @@ class ReadFTPSConnectionDataSchema(BaseModel):
 
 
 class CreateFTPSConnectionSchema(CreateConnectionBaseSchema):
-    type: FTPS_TYPE = Field(..., description="Connection type")
+    type: FTPS_TYPE = Field(description="Connection type")
     data: CreateFTPSConnectionDataSchema = Field(
         ...,
         alias="connection_data",
diff --git a/syncmaster/schemas/v1/connections/hdfs.py b/syncmaster/schemas/v1/connections/hdfs.py
@@ -24,7 +24,7 @@ class ReadHDFSConnectionDataSchema(BaseModel):
 
 
 class CreateHDFSConnectionSchema(CreateConnectionBaseSchema):
-    type: HDFS_TYPE = Field(..., description="Connection type")
+    type: HDFS_TYPE = Field(description="Connection type")
     data: CreateHDFSConnectionDataSchema = Field(
         ...,
         alias="connection_data",
diff --git a/syncmaster/schemas/v1/connections/hive.py b/syncmaster/schemas/v1/connections/hive.py
@@ -24,7 +24,7 @@ class ReadHiveConnectionDataSchema(BaseModel):
 
 
 class CreateHiveConnectionSchema(CreateConnectionBaseSchema):
-    type: HIVE_TYPE = Field(..., description="Connection type")
+    type: HIVE_TYPE = Field(description="Connection type")
     data: CreateHiveConnectionDataSchema = Field(
         ...,
         alias="connection_data",
diff --git a/syncmaster/schemas/v1/connections/mssql.py b/syncmaster/schemas/v1/connections/mssql.py
@@ -29,7 +29,7 @@ class ReadMSSQLConnectionDataSchema(BaseModel):
 
 
 class CreateMSSQLConnectionSchema(CreateConnectionBaseSchema):
-    type: MSSQL_TYPE = Field(..., description="Connection type")
+    type: MSSQL_TYPE = Field(description="Connection type")
     data: CreateMSSQLConnectionDataSchema = Field(
         ...,
         alias="connection_data",
diff --git a/syncmaster/schemas/v1/connections/mysql.py b/syncmaster/schemas/v1/connections/mysql.py
@@ -29,7 +29,7 @@ class ReadMySQLConnectionDataSchema(BaseModel):
 
 
 class CreateMySQLConnectionSchema(CreateConnectionBaseSchema):
-    type: MYSQL_TYPE = Field(..., description="Connection type")
+    type: MYSQL_TYPE = Field(description="Connection type")
     data: CreateMySQLConnectionDataSchema = Field(
         ...,
         alias="connection_data",
diff --git a/syncmaster/schemas/v1/connections/oracle.py b/syncmaster/schemas/v1/connections/oracle.py
@@ -39,7 +39,7 @@ class ReadOracleConnectionDataSchema(BaseModel):
 
 
 class CreateOracleConnectionSchema(CreateConnectionBaseSchema):
-    type: ORACLE_TYPE = Field(..., description="Connection type")
+    type: ORACLE_TYPE = Field(description="Connection type")
     data: CreateOracleConnectionDataSchema = Field(
         ...,
         alias="connection_data",
diff --git a/syncmaster/schemas/v1/connections/postgres.py b/syncmaster/schemas/v1/connections/postgres.py
@@ -30,7 +30,7 @@ class ReadPostgresConnectionDataSchema(BaseModel):
 
 
 class CreatePostgresConnectionSchema(CreateConnectionBaseSchema):
-    type: POSTGRES_TYPE = Field(..., description="Connection type")
+    type: POSTGRES_TYPE = Field(description="Connection type")
     data: CreatePostgresConnectionDataSchema = Field(
         ...,
         alias="connection_data",
diff --git a/syncmaster/schemas/v1/connections/s3.py b/syncmaster/schemas/v1/connections/s3.py
@@ -46,7 +46,7 @@ class ReadS3ConnectionDataSchema(BaseModel):
 
 
 class CreateS3ConnectionSchema(CreateConnectionBaseSchema):
-    type: S3_TYPE = Field(..., description="Connection type")
+    type: S3_TYPE = Field(description="Connection type")
     data: CreateS3ConnectionDataSchema = Field(
         ...,
         alias="connection_data",
diff --git a/syncmaster/schemas/v1/connections/samba.py b/syncmaster/schemas/v1/connections/samba.py
@@ -33,7 +33,7 @@ class ReadSambaConnectionDataSchema(BaseModel):
 
 
 class CreateSambaConnectionSchema(CreateConnectionBaseSchema):
-    type: SAMBA_TYPE = Field(..., description="Connection type")
+    type: SAMBA_TYPE = Field(description="Connection type")
     data: CreateSambaConnectionDataSchema = Field(
         ...,
         alias="connection_data",
diff --git a/syncmaster/schemas/v1/connections/sftp.py b/syncmaster/schemas/v1/connections/sftp.py
@@ -26,7 +26,7 @@ class ReadSFTPConnectionDataSchema(BaseModel):
 
 
 class CreateSFTPConnectionSchema(CreateConnectionBaseSchema):
-    type: SFTP_TYPE = Field(..., description="Connection type")
+    type: SFTP_TYPE = Field(description="Connection type")
     data: CreateSFTPConnectionDataSchema = Field(
         ...,
         alias="connection_data",
diff --git a/syncmaster/schemas/v1/connections/webdav.py b/syncmaster/schemas/v1/connections/webdav.py
@@ -30,7 +30,7 @@ class ReadWebDAVConnectionDataSchema(BaseModel):
 
 
 class CreateWebDAVConnectionSchema(CreateConnectionBaseSchema):
-    type: WEBDAV_TYPE = Field(..., description="Connection type")
+    type: WEBDAV_TYPE = Field(description="Connection type")
     data: CreateWebDAVConnectionDataSchema = Field(
         ...,
         alias="connection_data",
diff --git a/syncmaster/schemas/v1/groups.py b/syncmaster/schemas/v1/groups.py
@@ -8,13 +8,13 @@
 
 
 class UpdateGroupSchema(BaseModel):
-    name: NameConstr  # noqa: F722
+    name: NameConstr
     description: str
     owner_id: int
 
 
 class CreateGroupSchema(BaseModel):
-    name: NameConstr  # noqa: F722
+    name: NameConstr
     description: str
 
 
@@ -40,7 +40,7 @@ def validate_role(cls, values):
 
 class ReadGroupSchema(BaseModel):
     id: int
-    name: NameConstr  # noqa: F722
+    name: str
     description: str
     owner_id: int
 
diff --git a/syncmaster/schemas/v1/transfers/__init__.py b/syncmaster/schemas/v1/transfers/__init__.py
@@ -142,9 +142,9 @@
 class CopyTransferSchema(BaseModel):
     new_group_id: int
     new_queue_id: int
-    new_source_connection_name: NameConstr | None = None  # noqa: F722
-    new_target_connection_name: NameConstr | None = None  # noqa: F722
-    new_name: NameConstr | None = None  # noqa: F722
+    new_source_connection_name: NameConstr | None = None
+    new_target_connection_name: NameConstr | None = None
+    new_name: NameConstr | None = None
     remove_source: bool = False
 
 
@@ -176,14 +176,14 @@ class ReadTransferSchema(BaseModel):
 
 
 class CreateTransferSchema(BaseModel):
-    group_id: int = Field(..., description="Transfer owner group id")
-    source_connection_id: int = Field(..., description="id of the connection that will be the data source")
-    target_connection_id: int = Field(..., description="id of the connection that will be the data receiver")
-    name: NameConstr = Field(..., description="Transfer name")  # noqa: F722
-    description: str = Field(..., description="Additional description")
-    is_scheduled: bool = Field(..., description="Is the transfer on schedule")
-    queue_id: int = Field(..., description="id of the queue in which the transfer will be performed")
-    schedule: str | None = Field(None, description="Execution schedule in cron format")
+    group_id: int = Field(description="Transfer owner group id")
+    source_connection_id: int = Field(description="id of the connection that will be the data source")
+    target_connection_id: int = Field(description="id of the connection that will be the data receiver")
+    name: NameConstr = Field(description="Transfer name")
+    description: str = Field(description="Additional description")
+    is_scheduled: bool = Field(description="Is the transfer on schedule")
+    queue_id: int = Field(description="id of the queue in which the transfer will be performed")
+    schedule: str | None = Field(default=None, description="Execution schedule in cron format")
     source_params: CreateTransferSchemaSource = Field(
         ...,
         discriminator="type",
diff --git a/syncmaster/schemas/v1/transfers/file/base.py b/syncmaster/schemas/v1/transfers/file/base.py
@@ -23,7 +23,7 @@
 # classes are identical but may change in the future
 class ReadFileTransferSource(BaseModel):
     directory_path: str
-    file_format: CSV | JSONLine | JSON | Excel | XML | ORC | Parquet = Field(..., discriminator="type")
+    file_format: CSV | JSONLine | JSON | Excel | XML | ORC | Parquet = Field(discriminator="type")
     options: dict[str, Any]
 
 
@@ -42,7 +42,7 @@ class ReadFileTransferTarget(BaseModel):
 # classes are identical but may change in the future
 class CreateFileTransferSource(BaseModel):
     directory_path: str
-    file_format: CSV | JSONLine | JSON | Excel | XML | ORC | Parquet = Field(..., discriminator="type")
+    file_format: CSV | JSONLine | JSON | Excel | XML | ORC | Parquet = Field(discriminator="type")
     options: dict[str, Any] = Field(default_factory=dict)
 
     model_config = ConfigDict(arbitrary_types_allowed=True)
diff --git a/syncmaster/schemas/v1/transfers/transformations/dataframe_columns_filter.py b/syncmaster/schemas/v1/transfers/transformations/dataframe_columns_filter.py
@@ -30,4 +30,4 @@ class CastFilter(BaseColumnsFilter):
 
 class DataframeColumnsFilter(BaseModel):
     type: DATAFRAME_COLUMNS_FILTER
-    filters: list[Annotated[ColumnsFilter, Field(..., discriminator="type")]] = Field(default_factory=list)
+    filters: list[Annotated[ColumnsFilter, Field(discriminator="type")]] = Field(default_factory=list)
diff --git a/syncmaster/schemas/v1/transfers/transformations/dataframe_rows_filter.py b/syncmaster/schemas/v1/transfers/transformations/dataframe_rows_filter.py
@@ -93,4 +93,4 @@ class RegexpFilter(BaseRowsFilter):
 
 class DataframeRowsFilter(BaseModel):
     type: DATAFRAME_ROWS_FILTER
-    filters: list[Annotated[RowsFilter, Field(..., discriminator="type")]] = Field(default_factory=list)
+    filters: list[Annotated[RowsFilter, Field(discriminator="type")]] = Field(default_factory=list)
diff --git a/syncmaster/schemas/v1/transfers/transformations/file_metadata_filter.py b/syncmaster/schemas/v1/transfers/transformations/file_metadata_filter.py
@@ -50,4 +50,4 @@ class FileSizeMaxFilter(BaseModel):
 
 class FileMetadataFilter(BaseModel):
     type: FILE_METADATA_FILTER
-    filters: list[Annotated[MetadataFilter, Field(..., discriminator="type")]] = Field(default_factory=list)
+    filters: list[Annotated[MetadataFilter, Field(discriminator="type")]] = Field(default_factory=list)
diff --git a/syncmaster/schemas/v1/types.py b/syncmaster/schemas/v1/types.py
@@ -1,5 +1,7 @@
 # SPDX-FileCopyrightText: 2023-2024 MTS PJSC
 # SPDX-License-Identifier: Apache-2.0
-from pydantic import constr
+from typing import Annotated
 
-NameConstr = constr(min_length=1)
+from pydantic import StringConstraints
+
+NameConstr = Annotated[str, StringConstraints(min_length=3, max_length=128)]  # noqa: WPS432
diff --git a/syncmaster/server/settings/auth/keycloak.py b/syncmaster/server/settings/auth/keycloak.py
@@ -5,11 +5,11 @@
 
 class KeycloakSettings(BaseModel):
 
-    server_url: str = Field(..., description="Keycloak server URL")
-    client_id: str = Field(..., description="Keycloak client ID")
-    realm_name: str = Field(..., description="Keycloak realm name")
-    client_secret: SecretStr = Field(..., description="Keycloak client secret")
-    redirect_uri: str = Field(..., description="Redirect URI")
+    server_url: str = Field(description="Keycloak server URL")
+    client_id: str = Field(description="Keycloak client ID")
+    realm_name: str = Field(description="Keycloak realm name")
+    client_secret: SecretStr = Field(description="Keycloak client secret")
+    redirect_uri: str = Field(description="Redirect URI")
     verify_ssl: bool = Field(True, description="Verify SSL certificates")
     scope: str = Field("openid", description="Keycloak scope")
 
diff --git a/tests/test_unit/test_connections/test_copy_connection.py b/tests/test_unit/test_connections/test_copy_connection.py
@@ -261,35 +261,53 @@ async def test_maintainer_plus_cannot_copy_connection_with_same_name_in_new_grou
     }
 
 
-async def test_check_name_validation_copy_connection_with_new_connection_name(
+@pytest.mark.parametrize(
+    ("name", "error"),
+    [
+        (
+            "aa",
+            {
+                "context": {"min_length": 3},
+                "input": "aa",
+                "location": ["body", "new_name"],
+                "message": "String should have at least 3 characters",
+                "code": "string_too_short",
+            },
+        ),
+        (
+            "a" * 129,
+            {
+                "context": {"max_length": 128},
+                "input": "a" * 129,
+                "location": ["body", "new_name"],
+                "message": "String should have at most 128 characters",
+                "code": "string_too_long",
+            },
+        ),
+    ],
+)
+async def test_check_new_name_field_validation_on_copy_connection(
     client: AsyncClient,
     group_connection_and_group_developer_plus: str,
     group_connection: MockConnection,
     empty_group: MockGroup,
+    name: str,
+    error: dict,
 ):
     role = group_connection_and_group_developer_plus
     user = group_connection.owner_group.get_member_of_role(role)
-    new_name = ""
 
     result = await client.post(
         f"v1/connections/{group_connection.id}/copy_connection",
         headers={"Authorization": f"Bearer {user.token}"},
-        json={"new_group_id": empty_group.id, "new_name": new_name},
+        json={"new_group_id": empty_group.id, "new_name": name},
     )
 
     assert result.json() == {
         "error": {
             "code": "invalid_request",
             "message": "Invalid request",
-            "details": [
-                {
-                    "context": {"min_length": 1},
-                    "input": "",
-                    "location": ["body", "new_name"],
-                    "message": "String should have at least 1 character",
-                    "code": "string_too_short",
-                },
-            ],
+            "details": [error],
         },
     }
 
diff --git a/tests/test_unit/test_connections/test_create_connection.py b/tests/test_unit/test_connections/test_create_connection.py
diff --git a/tests/test_unit/test_connections/test_update_connection.py b/tests/test_unit/test_connections/test_update_connection.py
diff --git a/tests/test_unit/test_groups/test_update_group.py b/tests/test_unit/test_groups/test_update_group.py
diff --git a/tests/test_unit/test_queues/test_create_queue.py b/tests/test_unit/test_queues/test_create_queue.py
diff --git a/tests/test_unit/test_queues/test_update_queue.py b/tests/test_unit/test_queues/test_update_queue.py
diff --git a/tests/test_unit/test_transfers/test_copy_transfer.py b/tests/test_unit/test_transfers/test_copy_transfer.py
diff --git a/tests/test_unit/test_transfers/test_create_transfer.py b/tests/test_unit/test_transfers/test_create_transfer.py
diff --git a/tests/test_unit/test_transfers/test_update_transfer.py b/tests/test_unit/test_transfers/test_update_transfer.py
