Enhanced coverage

Author: vsdudakov

Makefile

@@ -11,16 +11,16 @@ dev:
 
 .PHONY: fix
 fix:
-	poetry run pyupgrade --exit-zero-even-if-changed --py39-plus fastadmin/**/*.py
-	poetry run isort --settings-path pyproject.toml fastadmin
-	poetry run black --config pyproject.toml fastadmin
+	poetry run pyupgrade --exit-zero-even-if-changed --py39-plus fastadmin/**/*.py tests/**/*.py
+	poetry run isort --settings-path pyproject.toml fastadmin tests
+	poetry run black --config pyproject.toml fastadmin tests
 	make -C frontend fix
 
 .PHONY: lint
 lint:
-	poetry run isort --diff --check-only --settings-path pyproject.toml fastadmin
-	poetry run black --diff --check --config pyproject.toml fastadmin
-	poetry run flake8 --show-source --config .flake8 fastadmin
+	poetry run isort --diff --check-only --settings-path pyproject.toml fastadmin tests
+	poetry run black --diff --check --config pyproject.toml fastadmin tests
+	poetry run flake8 --show-source --config .flake8 fastadmin tests
 	poetry run mypy --show-error-code --install-types --non-interactive --namespace-packages --show-traceback --config-file pyproject.toml fastadmin
 	make -C frontend lint
 

fastadmin/api/api.py

@@ -1,5 +1,7 @@
 import logging
 from datetime import datetime, timedelta
+from typing import Any, List
+from uuid import UUID
 
 import jwt
 from fastapi import APIRouter, Depends, HTTPException, Request, status
@@ -29,7 +31,7 @@
 async def sign_in(
     response: Response,
     payload: SignInInputSchema,
-):
+) -> None:
     """This method is used to sign in.
 
     :params response: a response object.
@@ -62,8 +64,8 @@ async def sign_in(
 @router.post("/sign-out")
 async def sign_out(
     response: Response,
-    _: str = Depends(get_user_id),
-):
+    _: UUID | int = Depends(get_user_id),
+) -> None:
     """This method is used to sign out.
 
     :params response: a response object.
@@ -75,15 +77,15 @@ async def sign_out(
 
 @router.get("/me")
 async def me(
-    user_id: str = Depends(get_user_id),
-):
+    user_id: UUID | int = Depends(get_user_id),
+) -> Any:
     """This method is used to get current user.
 
     :params user_id: a user id.
     :return: A user object.
     """
     model = settings.ADMIN_USER_MODEL
-    admin_model = get_admin_model(model)
+    admin_model: Any = get_admin_model(model)
     return await admin_model.get_obj(user_id)
 
 
@@ -95,8 +97,8 @@ async def list(
     sort_by: str = "-created_at",
     offset: int | None = 0,
     limit: int | None = 10,
-    _: str = Depends(get_user_id),
-):
+    _: UUID | int = Depends(get_user_id),
+) -> dict[str, int | List[Any]]:
     """This method is used to get a list of objects.
 
     :params request: a request object.
@@ -132,9 +134,9 @@ async def list(
 @router.get("/retrieve/{model}/{id}")
 async def get(
     model: str,
-    id: str,
-    _: str = Depends(get_user_id),
-):
+    id: UUID | int,
+    _: UUID | int = Depends(get_user_id),
+) -> Any:
     """This method is used to get an object.
 
     :params model: a name of model.
@@ -154,8 +156,8 @@ async def get(
 async def add(
     model: str,
     payload: dict,
-    _: str = Depends(get_user_id),
-):
+    _: UUID | int = Depends(get_user_id),
+) -> Any:
     """This method is used to add an object.
 
     :params model: a name of model.
@@ -165,19 +167,16 @@ async def add(
     admin_model = get_admin_model(model)
     if not admin_model:
         raise HTTPException(status.HTTP_404_NOT_FOUND, detail=f"{model} model is not registered.")
-    obj = await admin_model.save_model(None, payload)
-    if not obj:
-        raise HTTPException(status.HTTP_404_NOT_FOUND, detail=f"{model} not found.")
-    return obj
+    return await admin_model.save_model(None, payload)
 
 
 @router.patch("/change/{model}/{id}")
 async def change(
     model: str,
-    id: str,
+    id: UUID | int,
     payload: dict,
-    _: str = Depends(get_user_id),
-):
+    _: UUID | int = Depends(get_user_id),
+) -> Any:
     """This method is used to change an object.
 
     :params model: a name of model.
@@ -201,7 +200,7 @@ async def export(
     payload: ExportSchema,
     search: str | None = None,
     sort_by: str = "-created_at",
-    _: str = Depends(get_user_id),
+    _: UUID | int = Depends(get_user_id),
 ):
     """This method is used to export a list of objects.
 
@@ -237,9 +236,9 @@ async def export(
 @router.delete("/delete/{model}/{id}")
 async def delete(
     model: str,
-    id: str,
-    user_id: str = Depends(get_user_id),
-):
+    id: UUID | int,
+    user_id: UUID | int = Depends(get_user_id),
+) -> UUID | int:
     """This method is used to delete an object.
 
     :params model: a name of model.
@@ -249,16 +248,16 @@ async def delete(
     admin_model = get_admin_model(model)
     if not admin_model:
         raise HTTPException(status.HTTP_404_NOT_FOUND, detail=f"{model} model is not registered.")
-    if user_id == id:
+    if str(user_id) == str(id) and model == settings.ADMIN_USER_MODEL:
         raise HTTPException(status.HTTP_403_FORBIDDEN, detail="You cannot delete yourself.")
     await admin_model.delete_model(id)
     return id
 
 
 @router.get("/configuration")
 async def configuration(
-    user_id: str | None = Depends(get_user_id_or_none),
-):
+    user_id: UUID | int | None = Depends(get_user_id_or_none),
+) -> ConfigurationSchema:
     """This method is used to get a configuration.
 
     :params user_id: an id of user.

fastadmin/api/depends.py

@@ -1,4 +1,5 @@
 from datetime import datetime
+from uuid import UUID
 
 import jwt
 from fastapi import Request, status
@@ -8,7 +9,7 @@
 from fastadmin.settings import settings
 
 
-async def get_user_id_or_none(request: Request) -> str | None:
+async def get_user_id_or_none(request: Request) -> UUID | int | None:
     """This method is used to get user id from request or None.
 
     :params request: a request object.
@@ -42,7 +43,7 @@ async def get_user_id_or_none(request: Request) -> str | None:
     return user_id
 
 
-async def get_user_id(request: Request) -> str:
+async def get_user_id(request: Request) -> UUID | int:
     """This method is used to get user id from request.
 
     :params request: a request object.

fastadmin/models/base.py

@@ -3,6 +3,7 @@
 from collections.abc import Sequence
 from io import BytesIO, StringIO
 from typing import Any
+from uuid import UUID
 
 from fastadmin.schemas.api import ExportFormat
 from fastadmin.schemas.configuration import WidgetType
@@ -167,7 +168,7 @@ async def authenticate(self, username: str, password: str) -> str | None:
         """
         raise NotImplementedError
 
-    async def save_model(self, id: str | None, payload: dict) -> dict | None:
+    async def save_model(self, id: UUID | int | None, payload: dict) -> dict | None:
         """This method is used to save orm/db model object.
 
         :params id: an id of object.
@@ -176,15 +177,15 @@ async def save_model(self, id: str | None, payload: dict) -> dict | None:
         """
         raise NotImplementedError
 
-    async def delete_model(self, id: str) -> None:
+    async def delete_model(self, id: UUID | int) -> None:
         """This method is used to delete orm/db model object.
 
         :params id: an id of object.
         :return: None.
         """
         raise NotImplementedError
 
-    async def get_obj(self, id: str) -> dict | None:
+    async def get_obj(self, id: UUID | int) -> dict | None:
         """This method is used to get orm/db model object by id.
 
         :params id: an id of object.

fastadmin/models/orm/tortoise.py

@@ -1,6 +1,7 @@
 import asyncio
 from collections import OrderedDict
 from typing import Any
+from uuid import UUID
 
 from fastapi import HTTPException, status
 
@@ -29,7 +30,7 @@ async def obj_to_dict(obj: Any, with_m2m: bool = True) -> dict:
 
 
 class TortoiseModelAdmin(BaseModelAdmin):
-    async def save_model(self, id: str | None, payload: dict) -> dict | None:
+    async def save_model(self, id: UUID | int | None, payload: dict) -> dict | None:
         """This method is used to save orm/db model object.
 
         :params id: an id of object.
@@ -71,15 +72,15 @@ async def save_model(self, id: str | None, payload: dict) -> dict | None:
                     await m2m_rel.add(*remote_model_objs)
         return await obj_to_dict(obj)
 
-    async def delete_model(self, id: str) -> None:
+    async def delete_model(self, id: UUID | int) -> None:
         """This method is used to delete orm/db model object.
 
         :params id: an id of object.
         :return: None.
         """
         await self.model_cls.filter(id=id).delete()
 
-    async def get_obj(self, id: str) -> dict | None:
+    async def get_obj(self, id: UUID | int) -> dict | None:
         """This method is used to get orm/db model object by id.
 
         :params id: an id of object.

frontend/src/components/async-transfer/index.test.tsx

@@ -7,13 +7,14 @@ import { AsyncTransfer } from 'components/async-transfer';
 
 test('Renders AsyncTransfer', () => {
   const queryClient = new QueryClient();
+  const onChange = (data: any) => undefined;
   render(
     <TestProviders client={queryClient}>
       <AsyncTransfer
         idField="id"
         labelField="id"
         parentModel="test"
-        onChange={(data: any) => {}}
+        onChange={onChange}
         value={undefined}
       />
     </TestProviders>

frontend/src/components/async-transfer/index.tsx

@@ -46,23 +46,25 @@ export const AsyncTransfer: React.FC<IAsyncTransfer> = ({
     );
   };
 
-  const onSearch = (direction: TransferDirection, value: string) => {
+  const onSearch = (direction: TransferDirection, v: string) => {
     if (direction === 'left') {
-      setSearch(value);
+      setSearch(v);
     }
   };
 
   const dataSource = (data?.results || []).map((item: any) => {
     return { key: item[idField], title: item[labelField] };
   });
 
+  const render = (item: any) => item.title;
+
   return (
     <Transfer
       dataSource={dataSource}
       showSearch={true}
       filterOption={onFilter}
       onSearch={debounce(onSearch, 500)}
-      render={(item) => item.title}
+      render={render}
       onChange={onChange}
       targetKeys={value}
       listStyle={

frontend/src/components/crud-container/index.tsx

@@ -100,17 +100,18 @@ export const CrudContainer: React.FC<ICrudContainer> = ({
     },
     ...configuration.models
       .filter(
-        (model: IModel) =>
-          !search || model.name.toLocaleLowerCase().includes(search?.toLocaleLowerCase())
+        (m: IModel) => !search || m.name.toLocaleLowerCase().includes(search?.toLocaleLowerCase())
       )
-      .map((model: IModel) => {
+      .map((m: IModel) => {
         return {
-          key: model.name,
-          label: model.name,
+          key: m.name,
+          label: m.name,
         };
       }),
   ];
 
+  const onSearch = (e: any) => setSearch(e.target.value);
+
   return (
     <>
       <Helmet defaultTitle={title}>
@@ -193,7 +194,7 @@ export const CrudContainer: React.FC<ICrudContainer> = ({
               <div style={{ padding: 10 }}>
                 <Input
                   value={search}
-                  onChange={(e) => setSearch(e.target.value)}
+                  onChange={onSearch}
                   placeholder={_t('Search By Menu') as string}
                   prefix={<SearchOutlined />}
                 />
@@ -236,7 +237,7 @@ export const CrudContainer: React.FC<ICrudContainer> = ({
               }
               style={{ marginTop: 16 }}
             >
-              <Skeleton loading={isLoading} active>
+              <Skeleton loading={isLoading} active={true}>
                 {children}
               </Skeleton>
             </Card>

frontend/src/components/form-container/index.test.tsx

@@ -7,9 +7,10 @@ import { FormContainer } from 'components/form-container';
 
 test('Renders FormContainer', () => {
   const queryClient = new QueryClient();
+  const onFinish = (data: any) => undefined;
   render(
     <TestProviders client={queryClient}>
-      <FormContainer form="test" onFinish={(data: any) => {}} mode="add">
+      <FormContainer form="test" onFinish={onFinish} mode="add">
         <div />
       </FormContainer>
     </TestProviders>

frontend/src/containers/add/index.test.tsx

@@ -3,7 +3,6 @@ import { QueryClient } from '@tanstack/react-query';
 
 import { TestProviders } from 'providers';
 
-
 import { Add } from 'containers/add';
 
 test('Renders Add', () => {