Merge pull request 'Better README' (#36) from Luis-Hebendanz-main into main

README.md

@@ -1,6 +1,6 @@
-# 1Service Aware Network Project Repo
+# Service Aware Network Project Repo
 
-Welcome to our website repository! This repo is designed to help you and your team build high-quality websites efficiently. We've carefully chosen the technologies to make development smooth and enjoyable. Here's what you can expect from this template:
+Welcome to our website repository! This repo is designed to build high-quality websites efficiently. We've carefully chosen the technologies to make development smooth and enjoyable.
 
 **Frontend**: Our frontend is powered by [React NextJS](https://nextjs.org/), a popular and versatile framework for building web applications.
 
@@ -26,6 +26,12 @@ Let's get your development environment up and running:
      curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix | sh -s -- install
      ```
 
+On Windows Subsystem for Linux (WSL) the installer will fail and tell you what to do. Execute the command from the error message and then afterwards execute:
+
+```bash
+sudo echo "experimental-features = nix-command flakes" > '/etc/nix/nix.conf'
+```
+
 2. **Install direnv**:
 
    - Download the direnv package from [here](https://direnv.net/docs/installation.html) or run the following command:
@@ -45,6 +51,7 @@ Let's get your development environment up and running:
 4. **Clone the Repository and Navigate**:
 
    - Clone this repository and navigate to it.
+   - If you are under Windows Subystem For Linux (WSL) please clone the repository to the home folder of your Linux. Do NOT clone it onto your Windows machine!
 
 5. **Allow .envrc**:
 
@@ -66,9 +73,10 @@ Let's get your development environment up and running:
 
    - To start the backend server, execute:
      ```bash
-     clan webui --reload --no-open --log-level debug
+     clan webui --reload --no-open --log-level debug --populate
      ```
    - The server will automatically restart if any Python files change.
+   - The `--populate` flag will automatically populate the database with dummy data
 
 8. **Build the Frontend**:
 
@@ -95,19 +103,19 @@ Let's set up your Git workflow to collaborate effectively:
      ```bash
      tea login add
      ```
+   - Go to https://gitea.gchq.icu/user/settings/applications and create token with all privileges
    - Fill out the prompt as follows:
      - URL of Gitea instance: `https://gitea.gchq.icu`
      - Name of new Login [gitea.gchq.icu]: `gitea.gchq.icu:7171`
-     - Do you have an access token? No
-     - Username: YourUsername
-     - Password: YourPassword
+     - Do you have an access token? Yes
+     - Token: \***\*\*\*\***
      - Set Optional settings: No
 
 2. **Git Workflow**:
 
    1. Add your changes to Git using `git add <file1> <file2>`.
-   2. Run `nix fmt` to lint your files.
-   3. Commit your changes with a descriptive message: `git commit -a -m "My descriptive commit message"`.
+   2. Run `nix fmt` to lint your files. This will format your files and make changes!
+   3. Commit your changes and those of nix fmt with a descriptive message: `git commit -a -m "My descriptive commit message"`.
    4. Make sure your branch has the latest changes from upstream by executing:
       ```bash
       git fetch && git rebase origin/main --autostash
@@ -188,8 +196,8 @@ If you need to inspect the Nix sandbox while running tests, follow these steps:
 2. Use `cntr` and `psgrep` to attach to the Nix sandbox. This allows you to interactively debug your code while it's paused. For example:
 
    ```bash
-   cntr exec -w your_sandbox_name
    psgrep -a -x your_python_process_name
+   cntr attach <pid>
    ```
 
 These debugging and testing methods will help you identify and fix issues in your backend code efficiently, ensuring the reliability and robustness of your application.

pkgs/clan-cli/clan_cli/webui/__init__.py

@@ -22,6 +22,12 @@ def register_parser(parser: argparse.ArgumentParser) -> None:
     parser.add_argument(
         "--host", type=str, default="localhost", help="Host to listen on"
     )
+    parser.add_argument(
+        "--populate",
+        action="store_true",
+        help="Populate the database with dummy data",
+        default=False,
+    )
     parser.add_argument(
         "--no-open", action="store_true", help="Don't open the browser", default=False
     )

pkgs/clan-cli/clan_cli/webui/app.py

@@ -35,10 +35,11 @@ def setup_app() -> FastAPI:
     # bind sql engine
     # TODO comment aut and add flag to run with pupulated data rm *.sql run pytest with marked then start clan webui
     # https://docs.pytest.org/en/7.1.x/example/markers.html
-    sql_models.Base.metadata.drop_all(engine)
+    # sql_models.Base.metadata.drop_all(engine)
+
     sql_models.Base.metadata.create_all(bind=engine)
 
-    app = FastAPI(lifespan=lifespan)
+    app = FastAPI(lifespan=lifespan, swagger_ui_parameters={"tryItOutEnabled": True})
     app.add_middleware(
         CORSMiddleware,
         allow_origins=origins,

pkgs/clan-cli/clan_cli/webui/error_handlers.py

@@ -25,7 +25,7 @@ def sql_error_handler(request: Request, exc: SQLAlchemyError) -> JSONResponse:
 
 
 def clan_error_handler(request: Request, exc: ClanError) -> JSONResponse:
-    log.error("ClanError: %s", exc)
+    log.exception(exc)
     detail = [
         {
             "loc": [],

pkgs/clan-cli/clan_cli/webui/routers/sql_connect.py

@@ -1,3 +1,4 @@
+import logging
 import time
 from typing import List, Optional
 
@@ -5,6 +6,7 @@ import httpx
 from fastapi import APIRouter, BackgroundTasks, Depends
 from sqlalchemy.orm import Session
 
+from ...errors import ClanError
 from .. import sql_crud, sql_db, sql_models
 from ..schemas import (
     Consumer,
@@ -20,6 +22,8 @@ from ..tags import Tags
 
 router = APIRouter()
 
+log = logging.getLogger(__name__)
+
 
 #########################
 #                       #
@@ -141,11 +145,7 @@ def get_repository(
 @router.post("/api/v1/create_entity", response_model=Entity, tags=[Tags.entities])
 def create_entity(
     entity: EntityCreate, db: Session = Depends(sql_db.get_db)
-) -> EntityCreate | str:
-    # todo checken ob schon da ...
-    if sql_crud.get_entity_by_did(db, did=entity.did):
-        print("did already exsists")
-        return "Error did already exsists in db"
+) -> EntityCreate:
     return sql_crud.create_entity(db, entity)
 
 
@@ -178,7 +178,7 @@ def get_attached_entities(
     return entities
 
 
-@router.post("/api/v1/detach")
+@router.post("/api/v1/detach", response_model=Entity, tags=[Tags.entities])
 async def detach(
     background_tasks: BackgroundTasks,
     entity_did: str = "did:sov:test:1234",
@@ -186,13 +186,11 @@ async def detach(
     limit: int = 100,
     db: Session = Depends(sql_db.get_db),
 ) -> dict[str, str]:
-    background_tasks.add_task(
-        sql_crud.set_attached_by_entity_did, db, entity_did, False
-    )
-    return {"message": "Detaching in the background"}
+    entity = sql_crud.set_attached_by_entity_did(db, entity_did, False)
+    return entity
 
 
-@router.post("/api/v1/attach")
+@router.post("/api/v1/attach", tags=[Tags.entities])
 async def attach(
     background_tasks: BackgroundTasks,
     entity_did: str = "did:sov:test:1234",
@@ -200,27 +198,28 @@ async def attach(
     limit: int = 100,
     db: Session = Depends(sql_db.get_db),
 ) -> dict[str, str]:
+    if sql_crud.get_entity_by_did(db, entity_did) is None:
+        raise ClanError(f"Entity with did '{entity_did}' not found")
+
     background_tasks.add_task(attach_entity, db, entity_did)
     return {"message": "Attaching in the background"}
 
 
-# TODO
 def attach_entity(db: Session, entity_did: str) -> None:
     db_entity = sql_crud.set_attached_by_entity_did(db, entity_did, True)
     try:
-        if db_entity is not None:
-            while db_entity.attached:
-                # query status endpoint
-                # https://www.python-httpx.org/
-                response = httpx.get(f"http://{db_entity.ip}", timeout=2)
-                print(response)
-                # test with:
-                #  while true ; do printf 'HTTP/1.1 200 OK\r\n\r\ncool, thanks' | nc -l -N localhost 5555 ; done
-                # client test (apt install python3-httpx):
-                #  httpx http://localhost:5555
-                # except not reached set false
-                time.sleep(1)
-    except Exception as e:
-        print(e)
-        if db_entity is not None:
-            db_entity = sql_crud.set_attached_by_entity_did(db, entity_did, False)
+        while db_entity.attached:
+            # query status endpoint
+            # https://www.python-httpx.org/
+            response = httpx.get(f"http://{db_entity.ip}", timeout=2)
+            print(response)
+            # test with:
+            #  while true ; do printf 'HTTP/1.1 200 OK\r\n\r\ncool, thanks' | nc -l -N localhost 5555 ; done
+            # client test (apt install python3-httpx):
+            #  httpx http://localhost:5555
+            # except not reached set false
+            time.sleep(1)
+    except Exception:
+        log.warning(f"Entity {entity_did} not reachable. Setting attached to false")
+
+        db_entity = sql_crud.set_attached_by_entity_did(db, entity_did, False)

pkgs/clan-cli/clan_cli/webui/schemas.py

@@ -27,7 +27,7 @@ class ProducerBase(BaseModel):
     service_type: str = "3D Printing"
     endpoint_url: str = "http://127.0.0.1:8000"
     status: str = "unknown"
-    other: dict = {"test": "test"}
+    other: dict = {"action": ["register", "deregister", "delete", "create"]}
 
 
 class ProducerCreate(ProducerBase):
@@ -91,7 +91,11 @@ class EntityBase(BaseModel):
     name: str = "C1"
     ip: str = "127.0.0.1"
     attached: bool = False
-    other: dict = {"test": "test"}
+    visible: bool = True
+    other: dict = {
+        "network": "Carlo's Home Network",
+        "roles": ["service repository", "service prosumer"],
+    }
 
 
 class EntityCreate(EntityBase):

pkgs/clan-cli/clan_cli/webui/server.py

@@ -105,6 +105,27 @@ def start_server(args: argparse.Namespace) -> None:
         if not args.no_open:
             Thread(target=open_browser, args=(base_url, args.sub_url)).start()
 
+        # DELETE all data from the database
+        from . import sql_models
+        from .sql_db import engine
+
+        sql_models.Base.metadata.drop_all(engine)
+
+        if args.populate:
+            test_dir = Path(__file__).parent.parent.parent / "tests"
+
+            if not test_dir.is_dir():
+                raise ClanError(f"Could not find test dir: {test_dir}")
+
+            test_db_api = test_dir / "test_db_api.py"
+            if not test_db_api.is_file():
+                raise ClanError(f"Could not find test db api: {test_db_api}")
+
+            import subprocess
+
+            cmd = ["pytest", "-s", "-n0", str(test_db_api)]
+            subprocess.run(cmd, check=True)
+
         uvicorn.run(
             "clan_cli.webui.app:app",
             host=args.host,

pkgs/clan-cli/clan_cli/webui/sql_crud.py

@@ -3,6 +3,7 @@ from typing import List, Optional
 from sqlalchemy.orm import Session
 from sqlalchemy.sql.expression import true
 
+from ..errors import ClanError
 from . import schemas, sql_models
 
 #########################
@@ -153,21 +154,18 @@ def get_attached_entities(
     )
 
 
-# set attached
-# None if did not found
 # Returns same entity if setting didnt changed something
 def set_attached_by_entity_did(
     db: Session, entity_did: str, value: bool
-) -> Optional[sql_models.Entity]:
-    # ste attached to true
+) -> sql_models.Entity:
     db_entity = get_entity_by_did(db, entity_did)
-    if db_entity is not None:
-        # db_entity.attached = Column(True)
-        setattr(db_entity, "attached", value)
-        # save changes in db
-        db.add(db_entity)
-        db.commit()
-        db.refresh(db_entity)
-        return db_entity
-    else:
-        return db_entity
+    if db_entity is None:
+        raise ClanError(f"Entity with did '{entity_did}' not found")
+
+    setattr(db_entity, "attached", value)
+
+    # save changes in db
+    db.add(db_entity)
+    db.commit()
+    db.refresh(db_entity)
+    return db_entity

pkgs/clan-cli/clan_cli/webui/sql_models.py

@@ -26,6 +26,7 @@ class Entity(Base):
     name = Column(String, index=True)
     ip = Column(String, index=True)
     attached = Column(Boolean, index=True)
+    visible = Column(Boolean, index=True)
 
     ## Non queryable body ##
     # In here we deposit: Network, Roles, Visible, etc.

pkgs/clan-cli/tests/test_db_api.py

@@ -77,7 +77,7 @@ def test_producer(api: TestClient) -> None:
         "service_type": "3D Printing",
         "endpoint_url": "http://127.0.0.1:8000",
         "status": "unknown",
-        "other": {"test": "test"},
+        "other": {"action": ["register", "deregister", "delete", "create"]},
         "entity_did": default_entity_did,
     }
     paramter = "producer"
@@ -92,7 +92,7 @@ def test_producer2(api: TestClient) -> None:
         "service_type": "Fax",
         "endpoint_url": "http://127.0.0.1:8001",
         "status": "unknown",
-        "other": {"faxen": "dicke"},
+        "other": {"action": ["register", "deregister", "delete", "create"]},
         "entity_did": default_entity_did2,
     }
     paramter = "producer"
@@ -107,7 +107,7 @@ def test_producer3(api: TestClient) -> None:
         "service_type": "VR-Stream",
         "endpoint_url": "http://127.0.0.1:8002",
         "status": "unknown",
-        "other": {"oculos": "rift"},
+        "other": {"action": ["register", "deregister", "delete", "create"]},
         "entity_did": default_entity_did3,
     }
     paramter = "producer"
@@ -122,7 +122,7 @@ def test_producer4(api: TestClient) -> None:
         "service_type": "gallary",
         "endpoint_url": "http://127.0.0.1:8003",
         "status": "unknown",
-        "other": {"nice": "pics"},
+        "other": {"action": ["register", "deregister", "delete", "create"]},
         "entity_did": default_entity_did4,
     }
     paramter = "producer"
@@ -137,7 +137,7 @@ def test_producer5(api: TestClient) -> None:
         "service_type": "Game-Shop",
         "endpoint_url": "http://127.0.0.1:8004",
         "status": "unknown",
-        "other": {"war": "games"},
+        "other": {"action": ["register", "deregister", "delete", "create"]},
         "entity_did": default_entity_did5,
     }
     paramter = "producer"
@@ -263,7 +263,11 @@ def test_entity(api: TestClient) -> None:
         "name": "C1",
         "ip": "127.0.0.1",
         "attached": False,
-        "other": {"test": "test"},
+        "visible": True,
+        "other": {
+            "network": "Carlo1's Home Network",
+            "roles": ["service repository", "service consumer"],
+        },
     }
     paramter = "entity"
     # get_request = "entity_did=did%3Asov%3Atest%3A1234"
@@ -276,7 +280,11 @@ def test_entity2(api: TestClient) -> None:
         "name": "C2",
         "ip": "127.0.0.2",
         "attached": False,
-        "other": {"test": "test"},
+        "visible": True,
+        "other": {
+            "network": "Carlo2's Home Network",
+            "roles": ["service repository", "service prosumer"],
+        },
     }
     paramter = "entity"
     get_request = "entity_did=" + url.quote(default_entity_did2)