From 65808456889061e2c2258e05769f3c72577233d7 Mon Sep 17 00:00:00 2001 From: Jean Date: Thu, 18 Sep 2025 22:58:56 -0300 Subject: [PATCH 01/19] feat: Add ContainerLabs menu, Running/Create CLabs submenus, and file upload functionality (PoC) --- .gitignore | 1 + apps/__init__.py | 35 ++- apps/clabs/__init__.py | 10 + apps/clabs/mock_data.py | 89 ++++++ apps/clabs/routes.py | 159 +++++++++++ apps/clabs/templates/clabs/create.html | 349 ++++++++++++++++++++++++ apps/clabs/templates/clabs/open.html | 202 ++++++++++++++ apps/clabs/templates/clabs/running.html | 223 +++++++++++++++ apps/templates/includes/sidebar.html | 28 +- 9 files changed, 1088 insertions(+), 8 deletions(-) create mode 100644 apps/clabs/__init__.py create mode 100644 apps/clabs/mock_data.py create mode 100644 apps/clabs/routes.py create mode 100644 apps/clabs/templates/clabs/create.html create mode 100644 apps/clabs/templates/clabs/open.html create mode 100644 apps/clabs/templates/clabs/running.html diff --git a/.gitignore b/.gitignore index b267f5f..61ec9f3 100644 --- a/.gitignore +++ b/.gitignore @@ -13,6 +13,7 @@ __pycache__/ # venv venv +*.venv # .env variables file .env diff --git a/apps/__init__.py b/apps/__init__.py index be7ee67..6dbdeab 100644 --- a/apps/__init__.py +++ b/apps/__init__.py @@ -40,10 +40,33 @@ def register_extensions(app): def register_blueprints(app): for module_name in ('authentication', 'home', 'api', 'k8s', 'cli'): - module = import_module('apps.{}.routes'.format(module_name)) + module = import_module(f'apps.{module_name}.routes') app.register_blueprint(module.blueprint) - # Load socketio endpoints - import_module("apps.events") + + # (PoC) ContainerLabs: registra blueprint se habilitado + enable_clabs = app.config.get( + "ENABLE_CLABS", + str(os.getenv("ENABLE_CLABS", "false")).lower() in ("1", "true", "yes", "on") + ) + if enable_clabs: + try: + clabs = import_module("apps.clabs.routes") + app.register_blueprint(clabs.blueprint) + app.logger.info("ContainerLabs blueprint registrado (ENABLE_CLABS=true).") + except Exception as e: + app.logger.error(f"Falha ao registrar ContainerLabs: {e}") + else: + app.logger.info("ContainerLabs desativado (ENABLE_CLABS=false).") + + # Carrega endpoints do Socket.IO (xterm) + # -> Pula no Windows porque usa pty/termios/fcntl (só Unix) + try: + if os.name != "nt": + import_module("apps.events") + else: + app.logger.warning("Skipping apps.events on Windows (no termios/pty).") + except Exception as e: + app.logger.warning(f"Skipping apps.events due to error: {e}") def configure_database(app): @@ -79,6 +102,11 @@ def configure_log(app): def create_app(config): app = Flask(__name__) app.config.from_object(config) + + # Default da feature flag (pode vir do .env) + if "ENABLE_CLABS" not in app.config: + app.config["ENABLE_CLABS"] = str(os.getenv("ENABLE_CLABS", "false")).lower() in ("1", "true", "yes", "on") + register_extensions(app) register_blueprints(app) #configure_database(app) @@ -86,3 +114,4 @@ def create_app(config): configure_log(app) return app + diff --git a/apps/clabs/__init__.py b/apps/clabs/__init__.py new file mode 100644 index 0000000..0b0ba0e --- /dev/null +++ b/apps/clabs/__init__.py @@ -0,0 +1,10 @@ +# -*- encoding: utf-8 -*- +from flask import Blueprint + +blueprint = Blueprint( + "clabs_blueprint", + __name__, + url_prefix="/containerlabs", + template_folder="templates", + static_folder="static", +) diff --git a/apps/clabs/mock_data.py b/apps/clabs/mock_data.py new file mode 100644 index 0000000..d86e413 --- /dev/null +++ b/apps/clabs/mock_data.py @@ -0,0 +1,89 @@ +# -*- encoding: utf-8 -*- + +# Lista simples (usada na página de Running CLabs) +CLABS = [ + { + "id": "clab-001", + "name": "Edge Fabric", + "owner": "alice@example.com", + "status": "running", + "created_at": "2025-09-10 14:32", + "nodes": 6, + }, + { + "id": "clab-002", + "name": "Core BGP", + "owner": "bob@example.com", + "status": "running", + "created_at": "2025-09-12 09:05", + "nodes": 4, + }, +] + +# Recursos detalhados por CLab (para a página Open CLab) +# Estrutura inspirada em view_lab_instance: uma lista de "resources" por nó/serviço +CLABS_DETAILS = { + "clab-001": { + "title": "Edge Fabric", + "lab_instance_id": "clab-001", + "user": "Alice (alice@example.com)", + "created": "2025-09-10 14:32", + "expires_at": None, # PoC: sem expiração + "resources": [ + { + "kind": "node", + "name": "leaf1", + "ready": "Running", + "links": [ + {"label": "Console", "href": "#"}, + ], + "services": [ + {"name": "Mgmt SSH", "url": "#"}, + {"name": "gNMI", "url": "#"}, + ], + "age": "1d", + "node_name": "edge-host-01", + "pod_ip": "10.0.0.11", + }, + { + "kind": "node", + "name": "leaf2", + "ready": "Running", + "links": [{"label": "Console", "href": "#"}], + "services": [{"name": "Mgmt SSH", "url": "#"}], + "age": "1d", + "node_name": "edge-host-02", + "pod_ip": "10.0.0.12", + }, + ], + }, + "clab-002": { + "title": "Core BGP", + "lab_instance_id": "clab-002", + "user": "Bob (bob@example.com)", + "created": "2025-09-12 09:05", + "expires_at": None, + "resources": [ + { + "kind": "node", + "name": "r1", + "ready": "Running", + "links": [{"label": "Console", "href": "#"}], + "services": [{"name": "Mgmt SSH", "url": "#"}], + "age": "2h", + "node_name": "core-host-01", + "pod_ip": "10.1.0.21", + }, + { + "kind": "node", + "name": "r2", + "ready": "Running", + "links": [{"label": "Console", "href": "#"}], + "services": [{"name": "Mgmt SSH", "url": "#"}], + "age": "2h", + "node_name": "core-host-02", + "pod_ip": "10.1.0.22", + }, + ], + }, +} diff --git a/apps/clabs/routes.py b/apps/clabs/routes.py new file mode 100644 index 0000000..e2495b1 --- /dev/null +++ b/apps/clabs/routes.py @@ -0,0 +1,159 @@ +# -*- encoding: utf-8 -*- +from flask import render_template, request, jsonify +from flask_login import current_user +from datetime import datetime + +from . import blueprint +from .mock_data import CLABS, CLABS_DETAILS + +# Tentamos usar PyYAML; se não estiver instalado, seguimos sem quebrar +try: + import yaml # PyYAML +except Exception: + yaml = None + +@blueprint.route("/running") +def running(): + labs = [] + for c in CLABS: + labs.append({ + "lab_instance_id": c["id"], + "user": c.get("owner", "--"), + "title": c.get("name", "--"), + "created": c.get("created_at", "--"), + }) + return render_template("clabs/running.html", labs=labs) + + +@blueprint.route("/open/") +def open_clab(clab_id): + lab = CLABS_DETAILS.get(clab_id) + if not lab: + return render_template("pages/error.html", title="Open CLab", msg="CLab not found") + + return render_template("clabs/open.html", lab=lab) + +def _resources_from_clab_yaml(yaml_text: str): + """ + Constrói a lista de 'resources' (nós) a partir de um YAML ContainerLab. + Se PyYAML não estiver disponível ou o YAML estiver inválido, retorna []. + """ + if not yaml or not yaml_text: + return [] + + try: + data = yaml.safe_load(yaml_text) + except Exception: + return [] + + if not isinstance(data, dict): + return [] + + topo = data.get("topology") or {} + nodes = topo.get("nodes") or {} + if not isinstance(nodes, dict): + return [] + + resources = [] + for name, cfg in nodes.items(): + # cfg costuma ser dict com 'kind', 'image', 'mgmt_ipv4' etc. + kind = "node" + ready = "Running" # PoC: considera subido + pod_ip = None + node_name = None + links = [{"label": "Console", "href": "#"}] # placeholder + services = [] + + if isinstance(cfg, dict): + pod_ip = cfg.get("mgmt_ipv4") + node_name = cfg.get("kind") or cfg.get("image") or "--" + + resources.append({ + "kind": kind, + "name": str(name), + "ready": ready, + "links": links, + "services": services, + "age": "--", + "node_name": node_name or "--", + "pod_ip": pod_ip or "--", + }) + + return resources + +@blueprint.route("/create", methods=["GET", "POST"]) +def create(): + if request.method == "GET": + return render_template("clabs/create.html") + + # --- POST (PoC) --- + # Recebe dados do formulário e arquivos (mock – não persiste em disco) + name = (request.form.get("clab_name") or "").strip() + namespace = (request.form.get("clab_namespace") or "").strip() + yaml_manifest = (request.form.get("clab_yaml") or "").strip() + + # Conta arquivos enviados (arquivos soltos + pastas via webkitdirectory) + files_count = 0 + files_list = [] # Vamos armazenar os nomes dos arquivos enviados aqui + try: + # Adiciona arquivos individuais + files_list.extend(request.files.getlist("clab_files") or []) + + # Adiciona arquivos de pastas com caminho completo + for file in request.files.getlist("clab_folders"): + # O caminho completo da pasta será adicionado, evitando duplicação + files_list.append(file) + + files_count = len(files_list) + except Exception: + files_count = 0 + + # Validação mínima (PoC): exigir YAML ou ao menos 1 arquivo + if not yaml_manifest and files_count == 0: + return jsonify({"ok": False, "result": "Provide YAML and/or files"}), 400 + + # ---- Monta recursos a partir do YAML (se possível) ---- + resources = _resources_from_clab_yaml(yaml_manifest) + nodes_count = len(resources) + + # ---- Atualiza os mocks para aparecer em Running CLabs e Open CLab ---- + new_id = f"clab-{datetime.utcnow().strftime('%Y%m%d%H%M%S')}" + created_str = datetime.utcnow().strftime('%Y-%m-%d %H:%M:%S') + + # Dados do "owner" a partir do usuário logado (fallbacks seguros) + owner_name = getattr(current_user, "name", None) or getattr(current_user, "username", "User") + owner_email = getattr(current_user, "email", None) or "user@example.com" + owner_display = f"{owner_name} ({owner_email})" + + # Lista simples (Running CLabs) + CLABS.append({ + "id": new_id, + "name": name or "Unnamed", + "owner": owner_email, + "status": "running", + "created_at": created_str, + "nodes": nodes_count, + }) + + # Detalhes (Open CLab) — Incluindo os arquivos enviados + CLABS_DETAILS[new_id] = { + "title": name or "Unnamed", + "lab_instance_id": new_id, + "user": owner_display, + "created": created_str, + "expires_at": None, + "resources": resources, # agora populado a partir do YAML + "files": files_list, # Armazena os arquivos enviados com o caminho completo + } + + return jsonify({ + "ok": True, + "result": f"CLab '{name or 'Unnamed'}' created (mock).", + "received": { + "id": new_id, + "namespace": namespace or "--", + "has_yaml": bool(yaml_manifest), + "files": files_count, + "resources": nodes_count, + } + }), 201 diff --git a/apps/clabs/templates/clabs/create.html b/apps/clabs/templates/clabs/create.html new file mode 100644 index 0000000..c5082f0 --- /dev/null +++ b/apps/clabs/templates/clabs/create.html @@ -0,0 +1,349 @@ +{% extends "layouts/base.html" %} + +{% block title %} Create CLabs {% endblock %} + +{% block body_class %} sidebar-mini layout-navbar-fixed {% endblock body_class %} + +{% block stylesheets %} + + + + + + + + + +{% endblock stylesheets %} + +{% block content %} + +
+ +
+
+
+
+

Create CLabs

+ Paste your containerlab YAML and/or upload files/folders +
+
+
    +
  1. Home
    2. +
  2. ContainerLabs +
    3. +
  3. Create
    4. +
+
+
+
+
+ +
+ +
+
+
+
+

New ContainerLab

+
+
+
+
+ + +
+
+ + +
+
+ +
+ + + Use the same style of editor we já utilizamos para + Kubernetes Manifest (CodeMirror). +
+ +
+ +
+ +
Drag & drop files here, or click to select
+ Accepted: multiple files +
+ +
+
+ +
+ + + + Folder upload works on Chromium-based browsers (Chrome/Edge). Firefox não suporta; como + alternativa, compacte em ZIP e envie nos arquivos acima. + +
+ +
+
+ + Cancel +
+
+
+
+ +
+ +
+ +{% endblock content %} + +{% block javascripts %} + + + + + + + + + + + + +{% endblock javascripts %} \ No newline at end of file diff --git a/apps/clabs/templates/clabs/open.html b/apps/clabs/templates/clabs/open.html new file mode 100644 index 0000000..1517ce9 --- /dev/null +++ b/apps/clabs/templates/clabs/open.html @@ -0,0 +1,202 @@ +{% extends "layouts/base.html" %} + +{% block title %} Open CLab {% endblock %} + +{% block body_class %} sidebar-mini layout-navbar-fixed {% endblock body_class %} + +{% block stylesheets %} + + + + + + + + + +{% endblock stylesheets %} + +{% block content %} + +
+ +
+
+
+
+

Open CLab

+ View ContainerLab resources +
+
+
    +
  1. Home
    2. +
  2. ContainerLabs +
    3. +
  3. {{ lab.lab_instance_id }}
    4. +
+
+
+
+
+ +
+ + +
+
+
+
+

{{ lab.title }}

+
+
+
+
+ Instance ID: +

{{ lab.lab_instance_id }}

+
+
+ User: +

{{ lab.user }}

+
+
+ Created (UTC): +

{{ lab.created or '--' }}

+
+
+ Expires at: +

{{ lab.expires_at or '--' }}

+
+
+
+
+
+
+ + +
+
+
+
+

Uploaded Files

+
+
+ {% if lab.files %} +
    + {% for file in lab.files %} +
  • + {{ file.filename if file.filename else file }} +
    • + {% endfor %} +
+ {% else %} +

No files uploaded.

+ {% endif %} +
+
+
+
+ + +
+
+
+
+

Resources

+
+
+ + + + + + + + + + + + + + + {% for r in lab.resources %} + + + + + + + + + + + {% endfor %} + +
KindNameStatusNodePod IPAgeServicesLinks
{{ r.kind }}{{ r.name }} + {% if r.ready == 'Running' %} + {{ r.ready }} + {% else %} + {{ r.ready }} + {% endif %} + {{ r.node_name or '--' }}{{ r.pod_ip or '--' }}{{ r.age or '--' }} + {% if r.services %} + {% for s in r.services %} + {{ + s.name }} + {% endfor %} + {% else %} + -- + {% endif %} + + {% if r.links %} + {% for l in r.links %} + {{ l.label }} + {% endfor %} + {% else %} + -- + {% endif %} +
+
+
+
+
+ +
+ +
+ +{% endblock content %} + +{% block javascripts %} + + + + + + + + + + + + + +{% endblock javascripts %} \ No newline at end of file diff --git a/apps/clabs/templates/clabs/running.html b/apps/clabs/templates/clabs/running.html new file mode 100644 index 0000000..bd242fc --- /dev/null +++ b/apps/clabs/templates/clabs/running.html @@ -0,0 +1,223 @@ +{% extends "layouts/base.html" %} + +{% block title %} Running CLabs {% endblock %} + +{% block body_class %} sidebar-mini layout-navbar-fixed {% endblock body_class %} + +{% block stylesheets %} + + + + + + + + + + + +{% endblock stylesheets %} + +{% block content %} + +
+
+
+
+
+

Running CLabs

+
+
+
    +
  1. Home
    2. +
  2. Running CLabs
    3. +
+
+
+
+
+ +
+
+
+
+
+

Running CLabs

+
+ + +
+
+ +
+ + + + + + + + + + + + {% for lab in labs %} + + + + + + + + {% endfor %} + +
UserLab titleCreated (UTC)Actions
+
+ + +
+ 		{{ lab['user'] }}{{ lab['title'] }}{{ lab['created'] }} + Open CLab +
+ +
+ +
+
+ + +
+
+
+ +
+
+ + + +
+
+ +{% endblock content %} + +{% block javascripts %} + + + + + + + + + + + + + + + + +{% endblock javascripts %} \ No newline at end of file diff --git a/apps/templates/includes/sidebar.html b/apps/templates/includes/sidebar.html index 4b07429..a51dd68 100644 --- a/apps/templates/includes/sidebar.html +++ b/apps/templates/includes/sidebar.html @@ -96,15 +96,33 @@ -
  • - - + + {% if config.get('ENABLE_CLABS') %} +
  • + +

    - Running Labs - {{g.running_labs}} + ContainerLabs +

    +
    • + {% endif %} +
  • MANAGEMENT
    • {% if current_user.category == "admin" or current_user.category == "teacher" %}
  • From 98b763f34ddd6d920a3cb23964c183cef170882c Mon Sep 17 00:00:00 2001 From: Jean Date: Fri, 19 Sep 2025 17:12:18 -0300 Subject: [PATCH 02/19] fix: improve YAML validation and handling of submit button state --- apps/clabs/templates/clabs/create.html | 448 ++++++++++++++++++------- 1 file changed, 323 insertions(+), 125 deletions(-) diff --git a/apps/clabs/templates/clabs/create.html b/apps/clabs/templates/clabs/create.html index c5082f0..fdb0317 100644 --- a/apps/clabs/templates/clabs/create.html +++ b/apps/clabs/templates/clabs/create.html @@ -143,18 +143,29 @@

    New ContainerLab

    referrerpolicy="no-referrer"> + {% endblock javascripts %} \ No newline at end of file From 411bb0941a332229a1eeb9d2ec5b84cfd81aee87 Mon Sep 17 00:00:00 2001 From: Jean Date: Sat, 20 Sep 2025 23:11:03 -0300 Subject: [PATCH 03/19] =?UTF-8?q?feat(clabs):=20consolidar=20Create=20CLab?= =?UTF-8?q?=20=E2=80=94=20valida=C3=A7=C3=A3o=20YAML,=20DnD=20de=20pastas?= =?UTF-8?q?=20e=20UX=20de=20envio?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- apps/clabs/routes.py | 109 ++++++++++++++---------- apps/clabs/templates/clabs/create.html | 68 +++------------ apps/clabs/templates/clabs/open.html | 15 ++-- apps/clabs/templates/clabs/running.html | 2 +- apps/config.py | 6 ++ 5 files changed, 92 insertions(+), 108 deletions(-) diff --git a/apps/clabs/routes.py b/apps/clabs/routes.py index e2495b1..6d318b0 100644 --- a/apps/clabs/routes.py +++ b/apps/clabs/routes.py @@ -1,5 +1,5 @@ # -*- encoding: utf-8 -*- -from flask import render_template, request, jsonify +from flask import render_template, request, jsonify, current_app from flask_login import current_user from datetime import datetime @@ -16,14 +16,23 @@ def running(): labs = [] for c in CLABS: + lab_id = c.get("id") or c.get("lab_instance_id") or c.get("lab_id") + user = c.get("owner") or c.get("user") or "--" + title = c.get("name") or c.get("title") or "--" + created = c.get("created_at") or c.get("created") or "--" + + # se não tiver id em nenhum formato, pula a linha + if not lab_id: + continue + labs.append({ - "lab_instance_id": c["id"], - "user": c.get("owner", "--"), - "title": c.get("name", "--"), - "created": c.get("created_at", "--"), + "lab_instance_id": lab_id, + "user": user, + "title": title, + "created": created, }) - return render_template("clabs/running.html", labs=labs) + return render_template("clabs/running.html", labs=labs) @blueprint.route("/open/") def open_clab(clab_id): @@ -56,12 +65,11 @@ def _resources_from_clab_yaml(yaml_text: str): resources = [] for name, cfg in nodes.items(): - # cfg costuma ser dict com 'kind', 'image', 'mgmt_ipv4' etc. kind = "node" - ready = "Running" # PoC: considera subido + ready = "Running" pod_ip = None node_name = None - links = [{"label": "Console", "href": "#"}] # placeholder + links = [{"label": "Console", "href": "#"}] services = [] if isinstance(cfg, dict): @@ -87,63 +95,77 @@ def create(): return render_template("clabs/create.html") # --- POST (PoC) --- - # Recebe dados do formulário e arquivos (mock – não persiste em disco) + # Campos do formulário name = (request.form.get("clab_name") or "").strip() namespace = (request.form.get("clab_namespace") or "").strip() yaml_manifest = (request.form.get("clab_yaml") or "").strip() - # Conta arquivos enviados (arquivos soltos + pastas via webkitdirectory) - files_count = 0 - files_list = [] # Vamos armazenar os nomes dos arquivos enviados aqui - try: - # Adiciona arquivos individuais - files_list.extend(request.files.getlist("clab_files") or []) - - # Adiciona arquivos de pastas com caminho completo - for file in request.files.getlist("clab_folders"): - # O caminho completo da pasta será adicionado, evitando duplicação - files_list.append(file) - - files_count = len(files_list) - except Exception: - files_count = 0 + files = request.files.getlist("clab_files") or [] + files_meta = [] + for f in files: + files_meta.append({ + "name": f.filename, + "mimetype": getattr(f, "mimetype", "") or "", + "size": getattr(f, "content_length", None), + }) + files_count = len(files_meta) - # Validação mínima (PoC): exigir YAML ou ao menos 1 arquivo + # Regras mínimas de envio: YAML ou pelo menos 1 arquivo if not yaml_manifest and files_count == 0: return jsonify({"ok": False, "result": "Provide YAML and/or files"}), 400 - # ---- Monta recursos a partir do YAML (se possível) ---- + # Limites de upload (quantidade) - PoC + max_files = current_app.config.get("CLABS_UPLOAD_MAX_FILES", 200) + if files_count > max_files: + return jsonify({ + "ok": False, + "result": f"Too many files: {files_count} (max {max_files})" + }), 400 + + # Validação de YAML no servidor (fallback/autoridade) + # Se o usuário enviou YAML e houver PyYAML disponível, valide e falhe (400) se inválido. + if yaml_manifest: + if yaml is not None: + try: + # Fazemos o parse só para validar; geração de resources acontece na função auxiliar + yaml.safe_load(yaml_manifest) + except Exception as e: + return jsonify({"ok": False, "result": f"YAML inválido: {e}"}), 400 + # Se yaml==None, seguimos (sem validar) pois o front já tentou avisar. + + # Monta recursos (um por node) — segura mesmo sem YAML (retorna []) resources = _resources_from_clab_yaml(yaml_manifest) nodes_count = len(resources) - # ---- Atualiza os mocks para aparecer em Running CLabs e Open CLab ---- + # Identidade do "owner" (seguro para PoC) + try: + owner = getattr(current_user, "username", None) or getattr(current_user, "email", None) or "anonymous" + except Exception: + owner = "anonymous" + + # ID e timestamps new_id = f"clab-{datetime.utcnow().strftime('%Y%m%d%H%M%S')}" created_str = datetime.utcnow().strftime('%Y-%m-%d %H:%M:%S') - # Dados do "owner" a partir do usuário logado (fallbacks seguros) - owner_name = getattr(current_user, "name", None) or getattr(current_user, "username", "User") - owner_email = getattr(current_user, "email", None) or "user@example.com" - owner_display = f"{owner_name} ({owner_email})" - - # Lista simples (Running CLabs) + # Atualiza mocks (lista e detalhe) CLABS.append({ - "id": new_id, + "lab_instance_id": new_id, + "user": owner, + "title": name or "Unnamed", "name": name or "Unnamed", - "owner": owner_email, - "status": "running", - "created_at": created_str, + "created": created_str, + "status": "Running", "nodes": nodes_count, }) - # Detalhes (Open CLab) — Incluindo os arquivos enviados CLABS_DETAILS[new_id] = { - "title": name or "Unnamed", "lab_instance_id": new_id, - "user": owner_display, + "title": name or "Unnamed", + "user": owner, "created": created_str, "expires_at": None, - "resources": resources, # agora populado a partir do YAML - "files": files_list, # Armazena os arquivos enviados com o caminho completo + "resources": resources, + "files": files_meta, } return jsonify({ @@ -157,3 +179,4 @@ def create(): "resources": nodes_count, } }), 201 + diff --git a/apps/clabs/templates/clabs/create.html b/apps/clabs/templates/clabs/create.html index fdb0317..eb37f67 100644 --- a/apps/clabs/templates/clabs/create.html +++ b/apps/clabs/templates/clabs/create.html @@ -183,24 +183,18 @@

    New ContainerLab

    var btn = document.getElementById('btnSubmit'); var form = document.getElementById('clab-form'); - // Data store: DataTransfer para manter arquivos selecionados (com remoção) var store = new DataTransfer(); - // Para trackear linhas marcadas no CodeMirror (limpar marcações antes) var markedLines = []; - // Set para evitar duplicatas por caminho (nome ou caminho relativo) var seenPaths = new Set(); - // Click na dropzone -> abre fileInput drop && drop.addEventListener('click', function () { fileInput && fileInput.click(); }); - // impede navegação em dragover/drop na página ['dragover', 'drop'].forEach(function (evt) { document.addEventListener(evt, function (e) { e.preventDefault(); }, false); }); - // Renderiza lista de arquivos + botões remover function renderFilesList() { filesList.innerHTML = ''; if (!store.files.length) { @@ -242,7 +236,6 @@

    New ContainerLab

    filesList.appendChild(ul); } - // limpa marcações no CodeMirror function clearCmMarks() { if (!cm) return; while (markedLines.length) { @@ -252,7 +245,6 @@

    New ContainerLab

    } } - // adiciona marcação de erro no CodeMirror (linha: zero-indexed) function markCmError(line, message) { if (!cm) return; cm.addLineClass(line, 'background', 'cm-error-line'); @@ -262,11 +254,9 @@

    New ContainerLab

    marker.innerHTML = '●'; cm.setGutterMarker(line, 'error-gutter', marker); markedLines.push(line); - // scroll to line cm.scrollIntoView({ line: line, ch: 0 }, 100); } - // adiciona CSS runtime para highlight de erro e gutter (se preferir leve para CSS) (function addRuntimeCss() { var css = document.createElement('style'); css.type = 'text/css'; @@ -274,27 +264,27 @@

    New ContainerLab

    .cm-error-line { background: rgba(255, 0, 0, 0.06) !important; }\ .error-gutter-marker { color: #c0392b; font-weight: bold; }"; document.head.appendChild(css); - // garante gutter 'error-gutter' existe if (cm) cm.setOption('gutters', ['CodeMirror-linenumbers', 'error-gutter']); })(); // ====== Validação YAML ====== + function validateYaml(yamlText) { clearCmMarks(); - if (!yamlText || !yamlText.trim()) return true; // vazio permitido (se backend aceitar) — ajustável + if (!yamlText || !yamlText.trim()) return true; + if (typeof jsyaml === 'undefined') { - showToast('bg-danger', 'Validation error', 'js-yaml not loaded. Cannot validate YAML client-side.'); - return false; + showToast('bg-info', 'Heads up', 'js-yaml não carregou; validação será feita no servidor.'); + return true; } + try { - // jsyaml.load utiliza exception com mark {line, column} jsyaml.load(yamlText); return true; } catch (err) { var msg = err && err.message ? err.message : String(err); - // marca linha se disponível (js-yaml usa err.mark.line zero-indexed? geralmente 0-based) if (err && err.mark && typeof err.mark.line === 'number') { - var lineNo = err.mark.line; // já zero-index em muitas versões + var lineNo = err.mark.line; markCmError(lineNo, msg); } showToast('bg-danger', 'YAML error', msg); @@ -302,35 +292,29 @@

    New ContainerLab

    } } + // ====== Adição / deduplicação de arquivos ao store ====== function addFiles(fileList) { if (!fileList || !fileList.length) return; for (let i = 0; i < fileList.length; i++) { let f = fileList[i]; - // f.name já pode conter caminho relativo (se criado assim) var key = f.name || f.webkitRelativePath || f.fileName || f.path || (i + ':' + f.size); if (seenPaths.has(key)) continue; - // Se for um File vindo sem path, usamos name; se tiver webkitRelativePath (ex: folder input) preferimos ela - // Mas no fluxo abaixo, quando criarmos Files para pastas, já nomearemos com 'subdir/file' seenPaths.add(key); try { store.items.add(f); } catch (e) { - // falha ao adicionar (browser restrição) -> ignorar e logar console.warn('Could not add file to DataTransfer:', e, f); } } - // sincroniza input visível com store para consistência (opcional) try { fileInput.files = store.files; } catch (e) { /* some browsers don't allow */ } renderFilesList(); } - // ====== Leitura recursiva de pastas via DataTransferItem.webkitGetAsEntry ====== function traverseFileTree(entry, path) { return new Promise(function (resolve) { if (entry.isFile) { entry.file(function (file) { - // criamos novo File com nome que inclui o path relativo (para backend receber o path) var relPath = path + file.name; var newFile = new File([file], relPath, { type: file.type }); resolve([newFile]); @@ -365,7 +349,6 @@

    New ContainerLab

    }); } - // ====== Drop handler com suporte a pastas ====== if (drop) { // efeitos visuais ['dragenter', 'dragover'].forEach(function (evt) { @@ -381,12 +364,10 @@

    New ContainerLab

    }, false); }); - // drop drop.addEventListener('drop', function (e) { var dt = e.dataTransfer; if (!dt) return; if (dt.items && dt.items.length) { - // quando houver items, podemos examinar diretórios var promises = []; var filesToAdd = []; for (let i = 0; i < dt.items.length; i++) { @@ -394,27 +375,22 @@

    New ContainerLab

    if (typeof item.webkitGetAsEntry === 'function') { var entry = item.webkitGetAsEntry(); if (entry) { - // traverseFileTree -> retorna promise de array de Files (com nomes relativos) promises.push(traverseFileTree(entry, entry.isDirectory ? entry.name + '/' : '')); } else { - // fallback: item.getAsFile var f = item.getAsFile && item.getAsFile(); if (f) filesToAdd.push(f); } } else { - // fallback: item.getAsFile var f2 = item.getAsFile && item.getAsFile(); if (f2) filesToAdd.push(f2); } } - // processar promises Promise.all(promises).then(function (results) { var flat = [].concat.apply([], results || []); if (filesToAdd.length) flat = flat.concat(filesToAdd); if (flat.length) addFiles(flat); }).catch(function (err) { console.warn('Error reading dropped folder:', err); - // fallback para dt.files if (dt.files && dt.files.length) addFiles(dt.files); showToast('bg-info', 'Heads up', 'Folder drops may not be fully supported in this browser. Use "Upload folders" abaixo.'); }); @@ -424,11 +400,9 @@

    New ContainerLab

    }, false); } - // ====== Input file change ====== if (fileInput) { fileInput.addEventListener('change', function (e) { addFiles(e.target.files); - // limpar seleção original para permitir re-seleção dos mesmos nomes fileInput.value = ''; }); } @@ -436,31 +410,25 @@

    New ContainerLab

    // ====== Input folder change ====== if (folderInput) { folderInput.addEventListener('change', function (e) { - // folderInput.files já vem com webkitRelativePath em Chrome; convertê-los para Files com name==relativePath var arr = []; for (let i = 0; i < e.target.files.length; i++) { var f = e.target.files[i]; var rel = f.webkitRelativePath || f.name; - // criar novo File com nome contendo o caminho relativo (facilita envio com caminho) var newF = new File([f], rel, { type: f.type }); arr.push(newF); } addFiles(arr); - // limpamos o input para evitar duplicação posterior (se o usuário reabrir) folderInput.value = ''; }); } - // ====== Submit refinado (async/await) ====== async function handleSubmit() { var btnText = btn.querySelector('.btn-text'); var spinner = btn.querySelector('.spinner-border'); btn.disabled = true; btnText.classList.add('d-none'); spinner.classList.remove('d-none'); - // sincroniza editor -> textarea if (typeof CodeMirror !== 'undefined' && cm) { cm.save(); } - // Valida o YAML (através de jsyaml) var yamlText = document.getElementById('clab_yaml').value; if (!validateYaml(yamlText)) { btn.disabled = false; @@ -469,17 +437,10 @@

    New ContainerLab

    return; } - // FormData a partir do form - var fd = new FormData(form); + try { fileInput.files = store.files; } catch (e) {} - // Repassa arquivos do store (já com nomes relativos em store.files[].name) - for (let i = 0; i < store.files.length; i++) { - var file = store.files[i]; - // usa file.name como caminho relativo (se existir) no parâmetro filename do append - fd.append('clab_files', file, file.name); - } + var fd = new FormData(form); - // Validação mínima: YAML ou arquivos var hasYaml = (fd.get('clab_yaml') || '').trim().length > 0; var filesLen = store.files.length; if (!hasYaml && filesLen === 0) { @@ -496,7 +457,6 @@

    New ContainerLab

    body: fd }); - // tentar parsear JSON, mas fallback se não for JSON var resultText; try { var j = await resp.json(); @@ -507,14 +467,11 @@

    New ContainerLab

    resultText = j.result || 'CLab created (mock).'; sessionStorage.setItem('msgSuccess', resultText); showToast('bg-success', 'Success', resultText); - // redireciona window.location = '{{ url_for("clabs_blueprint.running") }}'; } catch (innerErr) { if (!resp.ok) { - // servidor retornou erro e não JSON throw innerErr; } else { - // resp ok mas não JSON -> success textual resultText = await resp.text(); sessionStorage.setItem('msgSuccess', resultText || 'CLab created.'); showToast('bg-success', 'Success', sessionStorage.getItem('msgSuccess')); @@ -524,22 +481,17 @@

    New ContainerLab

    } catch (err) { sessionStorage.setItem('msgFail', (err && err.toString()) || 'Failed to create CLab.'); showToast('bg-danger', 'Failure', sessionStorage.getItem('msgFail')); - // opcional: não redirecionar em falha? você redirecionava antes; mantive redirecionamento window.location = '{{ url_for("clabs_blueprint.running") }}'; } finally { - // garante reabilitar UI se o código ficar na mesma página btn.disabled = false; btnText.classList.remove('d-none'); spinner.classList.add('d-none'); - // renderiza lista atualizada renderFilesList(); } } - // attach handler if (btn) btn.addEventListener('click', handleSubmit); - // render inicial renderFilesList(); })(); diff --git a/apps/clabs/templates/clabs/open.html b/apps/clabs/templates/clabs/open.html index 1517ce9..b935902 100644 --- a/apps/clabs/templates/clabs/open.html +++ b/apps/clabs/templates/clabs/open.html @@ -72,7 +72,7 @@

    {{ lab.title }}

    - +
    @@ -80,16 +80,19 @@

    {{ lab.title }}

    Uploaded Files

    - {% if lab.files %} -
      - {% for file in lab.files %} + {% if lab.files and lab.files|length > 0 %} +
        + {% for f in lab.files %}
      • - {{ file.filename if file.filename else file }} + + {{ f.name or f.filename or f }} + {% if f.size %} ({{ f.size }} bytes){% endif %} + {% if f.mimetype %} — {{ f.mimetype }}{% endif %}
        • {% endfor %}
      {% else %} -

      No files uploaded.

      +

      No files uploaded.

      {% endif %}
    diff --git a/apps/clabs/templates/clabs/running.html b/apps/clabs/templates/clabs/running.html index bd242fc..1c080a9 100644 --- a/apps/clabs/templates/clabs/running.html +++ b/apps/clabs/templates/clabs/running.html @@ -165,7 +165,7 @@

    Confirm CLab removal

    if (sessionStorage.getItem('msgSuccess')) { $(document).Toasts('create', { class: 'bg-success', - title: 'Sucess', + title: 'Success', body: sessionStorage.getItem('msgSuccess') }); sessionStorage.removeItem('msgSuccess'); diff --git a/apps/config.py b/apps/config.py index b39ac91..650a822 100644 --- a/apps/config.py +++ b/apps/config.py @@ -11,6 +11,12 @@ class Config(object): basedir = os.path.abspath(os.path.dirname(__file__)) + # Limite total do corpo (teto de upload) — 50MB por padrão + MAX_CONTENT_LENGTH = int(os.getenv("MAX_CONTENT_LENGTH", 50 * 1024 * 1024)) + + # Limite de quantidade de arquivos (PoC) + CLABS_UPLOAD_MAX_FILES = int(os.getenv("CLABS_UPLOAD_MAX_FILES", 200)) + # Directories DATA_DIR = os.getenv('DATA_DIR', os.path.join(basedir, 'data')) UPLOAD_DIR = os.path.join(DATA_DIR, 'uploads') From b0e7085f7cb9705af8b3f69700742c2a95af6363 Mon Sep 17 00:00:00 2001 From: Jean Date: Sat, 20 Sep 2025 23:22:17 -0300 Subject: [PATCH 04/19] test(clabs): add valid and invalid ContainerLab YAML examples for Create CLab validation --- apps/clabs/routes.py | 42 ++++++++ apps/clabs/templates/clabs/open.html | 9 +- apps/clabs/templates/clabs/running.html | 136 +++++++++++++++++------- 3 files changed, 142 insertions(+), 45 deletions(-) diff --git a/apps/clabs/routes.py b/apps/clabs/routes.py index 6d318b0..e879394 100644 --- a/apps/clabs/routes.py +++ b/apps/clabs/routes.py @@ -12,6 +12,19 @@ except Exception: yaml = None +def _norm_lab_row(c: dict) -> dict: + """Normaliza um item de CLABS para exibição na tabela.""" + lab_id = c.get("id") or c.get("lab_instance_id") or c.get("lab_id") + user = c.get("owner") or c.get("user") or "--" + title = c.get("name") or c.get("title") or "--" + created = c.get("created_at") or c.get("created") or "--" + return { + "lab_instance_id": lab_id, + "user": user, + "title": title, + "created": created, + } + @blueprint.route("/running") def running(): labs = [] @@ -180,3 +193,32 @@ def create(): } }), 201 +@blueprint.route("/api/list", methods=["GET"]) +def api_list(): + """Retorna a lista normalizada de CLabs em execução (mock).""" + items = [] + for c in CLABS: + row = _norm_lab_row(c) + if row["lab_instance_id"]: + items.append(row) + return jsonify({"items": items}) + + +@blueprint.route("/api/delete/", methods=["DELETE"]) +def api_delete(clab_id): + """Remove (mock) o CLab da memória.""" + # remove de CLABS + removed = False + for i in range(len(CLABS) - 1, -1, -1): + _id = CLABS[i].get("id") or CLABS[i].get("lab_instance_id") or CLABS[i].get("lab_id") + if _id == clab_id: + CLABS.pop(i) + removed = True + # remove detalhe + if clab_id in CLABS_DETAILS: + CLABS_DETAILS.pop(clab_id, None) + removed = True + + if not removed: + return jsonify({"ok": False, "result": "not found"}), 404 + return jsonify({"ok": True}) diff --git a/apps/clabs/templates/clabs/open.html b/apps/clabs/templates/clabs/open.html index b935902..5fc290d 100644 --- a/apps/clabs/templates/clabs/open.html +++ b/apps/clabs/templates/clabs/open.html @@ -126,11 +126,10 @@

    Resources

    {{ r.kind }} {{ r.name }} - {% if r.ready == 'Running' %} - {{ r.ready }} - {% else %} - {{ r.ready }} - {% endif %} + + {{ r.ready or '--' }} + {{ r.node_name or '--' }} {{ r.pod_ip or '--' }} diff --git a/apps/clabs/templates/clabs/running.html b/apps/clabs/templates/clabs/running.html index 1c080a9..5510273 100644 --- a/apps/clabs/templates/clabs/running.html +++ b/apps/clabs/templates/clabs/running.html @@ -146,12 +146,15 @@

    Confirm CLab removal

    + {% endblock javascripts %} \ No newline at end of file From 43b6ba39a81563a21aed203a42baed608833af32 Mon Sep 17 00:00:00 2001 From: Jean Date: Sat, 20 Sep 2025 23:50:04 -0300 Subject: [PATCH 05/19] feat(clabs): unify persisted state path and ensure JSON save/load across restarts --- apps/apps/data/clabs_state.json | 73 ++++++++++++++++++++ apps/clabs/mock_data.py | 114 +++++++++----------------------- apps/clabs/routes.py | 39 +++++++++-- apps/clabs/store.py | 61 +++++++++++++++++ apps/config.py | 8 +++ 5 files changed, 207 insertions(+), 88 deletions(-) create mode 100644 apps/apps/data/clabs_state.json create mode 100644 apps/clabs/store.py diff --git a/apps/apps/data/clabs_state.json b/apps/apps/data/clabs_state.json new file mode 100644 index 0000000..0a885db --- /dev/null +++ b/apps/apps/data/clabs_state.json @@ -0,0 +1,73 @@ +{ + "clabs": [ + { + "id": "clab-sample-1", + "name": "Sample Topology", + "owner": "demo@example.com", + "status": "Running", + "created_at": "2025-09-20 12:00:00", + "nodes": 2 + }, + { + "lab_instance_id": "clab-20250921023818", + "user": "admin", + "title": "mano pivas", + "name": "mano pivas", + "created": "2025-09-21 02:38:18", + "status": "Running", + "nodes": 0 + } + ], + "details": { + "clab-sample-1": { + "lab_instance_id": "clab-sample-1", + "title": "Sample Topology", + "user": "demo@example.com", + "created": "2025-09-20 12:00:00", + "expires_at": null, + "resources": [ + { + "kind": "node", + "name": "r1", + "ready": "Running", + "node_name": "linux", + "pod_ip": "172.20.20.2", + "age": "--", + "services": [], + "links": [] + }, + { + "kind": "node", + "name": "r2", + "ready": "Running", + "node_name": "linux", + "pod_ip": "172.20.20.3", + "age": "--", + "services": [], + "links": [] + } + ], + "files": [] + }, + "clab-20250921023818": { + "lab_instance_id": "clab-20250921023818", + "title": "mano pivas", + "user": "admin", + "created": "2025-09-21 02:38:18", + "expires_at": null, + "resources": [], + "files": [ + { + "name": "teste/Novo(a) Documento de Texto.txt", + "mimetype": "text/plain", + "size": 0 + }, + { + "name": "teste/teste 1/Novo(a) Documento de Texto2.txt", + "mimetype": "text/plain", + "size": 0 + } + ] + } + } +} \ No newline at end of file diff --git a/apps/clabs/mock_data.py b/apps/clabs/mock_data.py index d86e413..609816d 100644 --- a/apps/clabs/mock_data.py +++ b/apps/clabs/mock_data.py @@ -1,89 +1,41 @@ -# -*- encoding: utf-8 -*- +from typing import List, Dict +from .store import load_state, default_state_path -# Lista simples (usada na página de Running CLabs) -CLABS = [ +# mocks padrão (usados se não houver estado persistido) +CLABS: List[dict] = [ { - "id": "clab-001", - "name": "Edge Fabric", - "owner": "alice@example.com", - "status": "running", - "created_at": "2025-09-10 14:32", - "nodes": 6, - }, - { - "id": "clab-002", - "name": "Core BGP", - "owner": "bob@example.com", - "status": "running", - "created_at": "2025-09-12 09:05", - "nodes": 4, - }, + "id": "clab-sample-1", + "name": "Sample Topology", + "owner": "demo@example.com", + "status": "Running", + "created_at": "2025-09-20 12:00:00", + "nodes": 2, + } ] -# Recursos detalhados por CLab (para a página Open CLab) -# Estrutura inspirada em view_lab_instance: uma lista de "resources" por nó/serviço -CLABS_DETAILS = { - "clab-001": { - "title": "Edge Fabric", - "lab_instance_id": "clab-001", - "user": "Alice (alice@example.com)", - "created": "2025-09-10 14:32", - "expires_at": None, # PoC: sem expiração - "resources": [ - { - "kind": "node", - "name": "leaf1", - "ready": "Running", - "links": [ - {"label": "Console", "href": "#"}, - ], - "services": [ - {"name": "Mgmt SSH", "url": "#"}, - {"name": "gNMI", "url": "#"}, - ], - "age": "1d", - "node_name": "edge-host-01", - "pod_ip": "10.0.0.11", - }, - { - "kind": "node", - "name": "leaf2", - "ready": "Running", - "links": [{"label": "Console", "href": "#"}], - "services": [{"name": "Mgmt SSH", "url": "#"}], - "age": "1d", - "node_name": "edge-host-02", - "pod_ip": "10.0.0.12", - }, - ], - }, - "clab-002": { - "title": "Core BGP", - "lab_instance_id": "clab-002", - "user": "Bob (bob@example.com)", - "created": "2025-09-12 09:05", +CLABS_DETAILS: Dict[str, dict] = { + "clab-sample-1": { + "lab_instance_id": "clab-sample-1", + "title": "Sample Topology", + "user": "demo@example.com", + "created": "2025-09-20 12:00:00", "expires_at": None, "resources": [ - { - "kind": "node", - "name": "r1", - "ready": "Running", - "links": [{"label": "Console", "href": "#"}], - "services": [{"name": "Mgmt SSH", "url": "#"}], - "age": "2h", - "node_name": "core-host-01", - "pod_ip": "10.1.0.21", - }, - { - "kind": "node", - "name": "r2", - "ready": "Running", - "links": [{"label": "Console", "href": "#"}], - "services": [{"name": "Mgmt SSH", "url": "#"}], - "age": "2h", - "node_name": "core-host-02", - "pod_ip": "10.1.0.22", - }, + {"kind": "node", "name": "r1", "ready": "Running", "node_name": "linux", "pod_ip": "172.20.20.2", "age": "--", "services": [], "links": []}, + {"kind": "node", "name": "r2", "ready": "Running", "node_name": "linux", "pod_ip": "172.20.20.3", "age": "--", "services": [], "links": []}, ], - }, + "files": [] + } } + +# tenta carregar estado persistido +try: + path = default_state_path() # --> .../apps/data/clabs_state.json + _clabs, _details = load_state(path) + if _clabs or _details: + CLABS[:] = _clabs + CLABS_DETAILS.clear() + CLABS_DETAILS.update(_details) +except Exception: + # mantém mocks se falhar + pass diff --git a/apps/clabs/routes.py b/apps/clabs/routes.py index e879394..931307d 100644 --- a/apps/clabs/routes.py +++ b/apps/clabs/routes.py @@ -1,8 +1,9 @@ # -*- encoding: utf-8 -*- +import os from flask import render_template, request, jsonify, current_app from flask_login import current_user from datetime import datetime - +from .store import load_state, save_state, prune_inplace, default_state_path from . import blueprint from .mock_data import CLABS, CLABS_DETAILS @@ -177,10 +178,16 @@ def create(): "user": owner, "created": created_str, "expires_at": None, - "resources": resources, - "files": files_meta, + "resources": resources, + "files": files_meta, } + # Persistência (PoC) + try: + save_state(default_state_path(current_app.config.get("CLABS_STATE_PATH")), CLABS, CLABS_DETAILS) + except Exception: + current_app.logger.warning("Failed to save CLabs state", exc_info=True) + return jsonify({ "ok": True, "result": f"CLab '{name or 'Unnamed'}' created (mock).", @@ -195,25 +202,35 @@ def create(): @blueprint.route("/api/list", methods=["GET"]) def api_list(): - """Retorna a lista normalizada de CLabs em execução (mock).""" + expire_days = current_app.config.get("CLABS_EXPIRE_DAYS", 0) + removed = 0 + if expire_days and expire_days > 0: + removed = prune_inplace(CLABS, CLABS_DETAILS, max_days=expire_days) + if removed: + try: + save_state(default_state_path(current_app.config.get("CLABS_STATE_PATH")), CLABS, CLABS_DETAILS) + except Exception: + current_app.logger.warning("Failed to save after prune", exc_info=True) + items = [] for c in CLABS: row = _norm_lab_row(c) if row["lab_instance_id"]: items.append(row) - return jsonify({"items": items}) - + return jsonify({"items": items, "pruned": removed}) @blueprint.route("/api/delete/", methods=["DELETE"]) def api_delete(clab_id): """Remove (mock) o CLab da memória.""" - # remove de CLABS removed = False + + # remove de CLABS for i in range(len(CLABS) - 1, -1, -1): _id = CLABS[i].get("id") or CLABS[i].get("lab_instance_id") or CLABS[i].get("lab_id") if _id == clab_id: CLABS.pop(i) removed = True + # remove detalhe if clab_id in CLABS_DETAILS: CLABS_DETAILS.pop(clab_id, None) @@ -221,4 +238,12 @@ def api_delete(clab_id): if not removed: return jsonify({"ok": False, "result": "not found"}), 404 + + # Persistência após remoção — alinhado corretamente + try: + save_state(default_state_path(current_app.config.get("CLABS_STATE_PATH")), CLABS, CLABS_DETAILS) + except Exception: + current_app.logger.warning("Failed to save CLabs state after delete", exc_info=True) + return jsonify({"ok": True}) + diff --git a/apps/clabs/store.py b/apps/clabs/store.py new file mode 100644 index 0000000..1fc0ab3 --- /dev/null +++ b/apps/clabs/store.py @@ -0,0 +1,61 @@ +import os +import json +from typing import Tuple, Dict, List, Optional + +def _ensure_dir(path: str) -> None: + os.makedirs(os.path.dirname(path), exist_ok=True) + +def default_state_path(cfg_path: Optional[str] = None) -> str: + if cfg_path: + return cfg_path + base = os.path.abspath(os.path.join(os.path.dirname(__file__), "..")) # .../apps + return os.path.join(base, "data", "clabs_state.json") + +def load_state(state_path: str) -> Tuple[List[dict], Dict[str, dict]]: + """ + Carrega estado do disco. Se não existir ou falhar, retorna ([], {}). + """ + try: + if not os.path.exists(state_path): + return [], {} + with open(state_path, "r", encoding="utf-8") as f: + data = json.load(f) + clabs = data.get("clabs", []) + details = data.get("details", {}) + if not isinstance(clabs, list): clabs = [] + if not isinstance(details, dict): details = {} + return clabs, details + except Exception: + return [], {} + +def save_state(state_path: str, clabs: List[dict], details: Dict[str, dict]) -> None: + """ + Salva estado de forma atômica (JSON). Cria a pasta se não existir. + """ + _ensure_dir(state_path) + tmp = state_path + ".tmp" + payload = {"clabs": clabs, "details": details} + with open(tmp, "w", encoding="utf-8") as f: + json.dump(payload, f, ensure_ascii=False, indent=2) + os.replace(tmp, state_path) + +def prune_inplace(clabs: List[dict], details: Dict[str, dict], max_days: int = 0) -> int: + """ + Remoção simplificada (PoC). max_days=0 desativa. Aqui só remove status 'expired'/'deleted'. + """ + if not max_days or max_days <= 0: + return 0 + ids = [] + for c in clabs: + status = (c.get("status") or "").lower() + if status in {"expired", "deleted"}: + _id = c.get("id") or c.get("lab_instance_id") or c.get("lab_id") + if _id: + ids.append(_id) + if not ids: return 0 + idset = set(ids) + clabs[:] = [c for c in clabs if (c.get("id") or c.get("lab_instance_id") or c.get("lab_id")) not in idset] + for k in list(details.keys()): + if k in idset: + details.pop(k, None) + return len(ids) diff --git a/apps/config.py b/apps/config.py index 650a822..116199d 100644 --- a/apps/config.py +++ b/apps/config.py @@ -11,6 +11,14 @@ class Config(object): basedir = os.path.abspath(os.path.dirname(__file__)) + # Persistência dos CLabs (PoC) + CLABS_STATE_PATH = os.getenv("CLABS_STATE_PATH", None) + CLABS_EXPIRE_DAYS = int(os.getenv("CLABS_EXPIRE_DAYS", "0")) + + # Limites de upload + MAX_CONTENT_LENGTH = int(os.getenv("MAX_CONTENT_LENGTH", str(50 * 1024 * 1024))) # 50 MB + CLABS_UPLOAD_MAX_FILES = int(os.getenv("CLABS_UPLOAD_MAX_FILES", "200")) + # Limite total do corpo (teto de upload) — 50MB por padrão MAX_CONTENT_LENGTH = int(os.getenv("MAX_CONTENT_LENGTH", 50 * 1024 * 1024)) From f7664c53ee6dbc09d026f5cc8af7285fb3f5d14f Mon Sep 17 00:00:00 2001 From: Jean Date: Sun, 21 Sep 2025 00:03:25 -0300 Subject: [PATCH 06/19] feat(clabs): persist mock state to JSON + reload on start + TTL prune --- apps/clabs/mock_data.py | 26 ++------------ apps/clabs/routes.py | 80 +++++++++++++++++++++++++---------------- 2 files changed, 52 insertions(+), 54 deletions(-) diff --git a/apps/clabs/mock_data.py b/apps/clabs/mock_data.py index 609816d..e0268ae 100644 --- a/apps/clabs/mock_data.py +++ b/apps/clabs/mock_data.py @@ -2,31 +2,9 @@ from .store import load_state, default_state_path # mocks padrão (usados se não houver estado persistido) -CLABS: List[dict] = [ - { - "id": "clab-sample-1", - "name": "Sample Topology", - "owner": "demo@example.com", - "status": "Running", - "created_at": "2025-09-20 12:00:00", - "nodes": 2, - } -] +CLABS: List[dict] = [] -CLABS_DETAILS: Dict[str, dict] = { - "clab-sample-1": { - "lab_instance_id": "clab-sample-1", - "title": "Sample Topology", - "user": "demo@example.com", - "created": "2025-09-20 12:00:00", - "expires_at": None, - "resources": [ - {"kind": "node", "name": "r1", "ready": "Running", "node_name": "linux", "pod_ip": "172.20.20.2", "age": "--", "services": [], "links": []}, - {"kind": "node", "name": "r2", "ready": "Running", "node_name": "linux", "pod_ip": "172.20.20.3", "age": "--", "services": [], "links": []}, - ], - "files": [] - } -} +CLABS_DETAILS: Dict[str, dict] = {} # tenta carregar estado persistido try: diff --git a/apps/clabs/routes.py b/apps/clabs/routes.py index 931307d..155c264 100644 --- a/apps/clabs/routes.py +++ b/apps/clabs/routes.py @@ -2,7 +2,7 @@ import os from flask import render_template, request, jsonify, current_app from flask_login import current_user -from datetime import datetime +from datetime import datetime, timedelta from .store import load_state, save_state, prune_inplace, default_state_path from . import blueprint from .mock_data import CLABS, CLABS_DETAILS @@ -163,10 +163,13 @@ def create(): # Atualiza mocks (lista e detalhe) CLABS.append({ + "id": new_id, "lab_instance_id": new_id, + "owner": owner, "user": owner, "title": name or "Unnamed", "name": name or "Unnamed", + "created_at": created_str, "created": created_str, "status": "Running", "nodes": nodes_count, @@ -202,15 +205,50 @@ def create(): @blueprint.route("/api/list", methods=["GET"]) def api_list(): - expire_days = current_app.config.get("CLABS_EXPIRE_DAYS", 0) + # TTL opcional por idade em dias (0 = desativa) + expire_days = int(current_app.config.get("CLABS_EXPIRE_DAYS", 0) or 0) removed = 0 - if expire_days and expire_days > 0: - removed = prune_inplace(CLABS, CLABS_DETAILS, max_days=expire_days) - if removed: + if expire_days > 0: + cutoff = datetime.utcnow() - timedelta(days=expire_days) + ids_to_remove = [] + + def parse_created(c: dict): + val = c.get("created_at") or c.get("created") + if not val: + return None + # tenta formatos comuns + for fmt in ("%Y-%m-%d %H:%M:%S", "%Y-%m-%dT%H:%M:%S", "%Y-%m-%dT%H:%M:%S.%f"): + try: + return datetime.strptime(val, fmt) + except Exception: + continue + # último recurso: tenta fromisoformat + try: + return datetime.fromisoformat(val.replace("Z", "")) + except Exception: + return None + + # coleta ids antigos + for c in CLABS: + dt = parse_created(c) + if dt and dt < cutoff: + _id = c.get("id") or c.get("lab_instance_id") or c.get("lab_id") + if _id: + ids_to_remove.append(_id) + + if ids_to_remove: + ids = set(ids_to_remove) + # remove da lista + CLABS[:] = [c for c in CLABS if (c.get("id") or c.get("lab_instance_id") or c.get("lab_id")) not in ids] + # remove detalhes + for cid in list(CLABS_DETAILS.keys()): + if cid in ids: + CLABS_DETAILS.pop(cid, None) + removed = len(ids) try: save_state(default_state_path(current_app.config.get("CLABS_STATE_PATH")), CLABS, CLABS_DETAILS) except Exception: - current_app.logger.warning("Failed to save after prune", exc_info=True) + current_app.logger.warning("Failed to save after TTL prune", exc_info=True) items = [] for c in CLABS: @@ -219,31 +257,13 @@ def api_list(): items.append(row) return jsonify({"items": items, "pruned": removed}) -@blueprint.route("/api/delete/", methods=["DELETE"]) -def api_delete(clab_id): - """Remove (mock) o CLab da memória.""" - removed = False - - # remove de CLABS - for i in range(len(CLABS) - 1, -1, -1): - _id = CLABS[i].get("id") or CLABS[i].get("lab_instance_id") or CLABS[i].get("lab_id") - if _id == clab_id: - CLABS.pop(i) - removed = True - - # remove detalhe - if clab_id in CLABS_DETAILS: - CLABS_DETAILS.pop(clab_id, None) - removed = True - - if not removed: - return jsonify({"ok": False, "result": "not found"}), 404 - - # Persistência após remoção — alinhado corretamente +@blueprint.route("/api/clear", methods=["POST"]) +def api_clear_all(): + """Dev only: limpa todos os CLabs do estado (lista + detalhes).""" + CLABS.clear() + CLABS_DETAILS.clear() try: save_state(default_state_path(current_app.config.get("CLABS_STATE_PATH")), CLABS, CLABS_DETAILS) except Exception: - current_app.logger.warning("Failed to save CLabs state after delete", exc_info=True) - + current_app.logger.warning("Failed to save after clear", exc_info=True) return jsonify({"ok": True}) - From 3ceefc8725be6a2bda3398c21ec9437e3dfc779e Mon Sep 17 00:00:00 2001 From: Jean Date: Thu, 2 Oct 2025 23:36:02 -0300 Subject: [PATCH 07/19] refactor(app): load optional blueprints via OPTIONAL_MODULES; always load apps.events; fix config duplication; restore sidebar item --- apps/__init__.py | 38 +++++++++------------------- apps/config.py | 11 ++++---- apps/templates/includes/sidebar.html | 11 +++++++- env-template | 3 +++ 4 files changed, 31 insertions(+), 32 deletions(-) diff --git a/apps/__init__.py b/apps/__init__.py index 6dbdeab..01cb25b 100644 --- a/apps/__init__.py +++ b/apps/__init__.py @@ -39,35 +39,26 @@ def register_extensions(app): def register_blueprints(app): + # Core blueprints (always loaded) for module_name in ('authentication', 'home', 'api', 'k8s', 'cli'): module = import_module(f'apps.{module_name}.routes') app.register_blueprint(module.blueprint) - # (PoC) ContainerLabs: registra blueprint se habilitado - enable_clabs = app.config.get( - "ENABLE_CLABS", - str(os.getenv("ENABLE_CLABS", "false")).lower() in ("1", "true", "yes", "on") - ) - if enable_clabs: + # Optional blueprints (controlled by config.OPTIONAL_MODULES) + optional_modules = app.config.get("OPTIONAL_MODULES", []) or [] + for opt in optional_modules: try: - clabs = import_module("apps.clabs.routes") - app.register_blueprint(clabs.blueprint) - app.logger.info("ContainerLabs blueprint registrado (ENABLE_CLABS=true).") + mod = import_module(f"apps.{opt}.routes") + app.register_blueprint(mod.blueprint) + app.logger.info(f"Optional module loaded: {opt}") except Exception as e: - app.logger.error(f"Falha ao registrar ContainerLabs: {e}") - else: - app.logger.info("ContainerLabs desativado (ENABLE_CLABS=false).") + app.logger.error(f"Failed to load optional module '{opt}': {e}") - # Carrega endpoints do Socket.IO (xterm) - # -> Pula no Windows porque usa pty/termios/fcntl (só Unix) + # Socket.IO endpoints (xterm) - always load; Windows must run via Docker (see docs) try: - if os.name != "nt": - import_module("apps.events") - else: - app.logger.warning("Skipping apps.events on Windows (no termios/pty).") + import_module("apps.events") except Exception as e: - app.logger.warning(f"Skipping apps.events due to error: {e}") - + app.logger.error(f"Failed to load apps.events: {e}") def configure_database(app): with app.app_context(): @@ -103,15 +94,10 @@ def create_app(config): app = Flask(__name__) app.config.from_object(config) - # Default da feature flag (pode vir do .env) - if "ENABLE_CLABS" not in app.config: - app.config["ENABLE_CLABS"] = str(os.getenv("ENABLE_CLABS", "false")).lower() in ("1", "true", "yes", "on") - register_extensions(app) register_blueprints(app) - #configure_database(app) + # configure_database(app) configure_oauth(app) configure_log(app) return app - diff --git a/apps/config.py b/apps/config.py index 116199d..d88d723 100644 --- a/apps/config.py +++ b/apps/config.py @@ -17,10 +17,6 @@ class Config(object): # Limites de upload MAX_CONTENT_LENGTH = int(os.getenv("MAX_CONTENT_LENGTH", str(50 * 1024 * 1024))) # 50 MB - CLABS_UPLOAD_MAX_FILES = int(os.getenv("CLABS_UPLOAD_MAX_FILES", "200")) - - # Limite total do corpo (teto de upload) — 50MB por padrão - MAX_CONTENT_LENGTH = int(os.getenv("MAX_CONTENT_LENGTH", 50 * 1024 * 1024)) # Limite de quantidade de arquivos (PoC) CLABS_UPLOAD_MAX_FILES = int(os.getenv("CLABS_UPLOAD_MAX_FILES", 200)) @@ -84,7 +80,7 @@ class Config(object): # Kubernetes K8S_NAMESPACE = os.getenv('K8S_NAMESPACE', "") K8S_CONFIG = os.path.expanduser(os.getenv("KUBECONFIG", "~/.kube/config")) - K8S_AVOID_NODES = os.getenv("K8S_AVOID_NODES", "").split(",") + K8S_AVOID_NODES = [n.strip() for n in os.getenv("K8S_AVOID_NODES", "").split(",") if n.strip()] # Base URL BASE_URL = os.getenv("BASE_URL", 'https://dashboard.hackinsdn.ufba.br') @@ -125,6 +121,11 @@ class Config(object): MAP_ZOOM_LEVEL = int(os.getenv('MAP_ZOOM_LEVEL', "1")) MAP_POINTS = json.loads(os.getenv('MAP_POINTS', '[]')) +# -------- Optional modules & feature flags -------- +# Canonical optional modules control (CSV -> list). Default includes "clabs". +OPTIONAL_MODULES = [m.strip() for m in os.getenv("OPTIONAL_MODULES", "clabs").split(",") if m.strip()] +# Backward-compatible flag for CLabs; prefer OPTIONAL_MODULES going forward. +ENABLE_CLABS = str(os.getenv("ENABLE_CLABS", "false")).lower() in ("1", "true", "yes", "on") class ProductionConfig(Config): DEBUG = False diff --git a/apps/templates/includes/sidebar.html b/apps/templates/includes/sidebar.html index a51dd68..d8ece08 100644 --- a/apps/templates/includes/sidebar.html +++ b/apps/templates/includes/sidebar.html @@ -96,7 +96,16 @@
    • - +
  • + + +

    + Running Labs + {{ g.running_labs }} +

    +     +
    • + {% if config.get('ENABLE_CLABS') %}
  • diff --git a/env-template b/env-template index 200008b..8f18e48 100644 --- a/env-template +++ b/env-template @@ -24,3 +24,6 @@ export MAP_ZOOM_LEVEL=xxxx # Pontos do mapa (formato JSON) export MAP_POINTS=xxxx export TESTBED_TITLE=xxxx + +# Enable or disable the Collaborative Labs feature +ENABLE_CLABS=true \ No newline at end of file From 33558397041373c80070c242570d30d0240cc347 Mon Sep 17 00:00:00 2001 From: Jean Date: Fri, 3 Oct 2025 00:10:54 -0300 Subject: [PATCH 08/19] fix(config): load OPTIONAL_MODULES/ENABLE_CLABS by defining inside Config class --- apps/config.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/apps/config.py b/apps/config.py index d88d723..4299bb8 100644 --- a/apps/config.py +++ b/apps/config.py @@ -121,11 +121,11 @@ class Config(object): MAP_ZOOM_LEVEL = int(os.getenv('MAP_ZOOM_LEVEL', "1")) MAP_POINTS = json.loads(os.getenv('MAP_POINTS', '[]')) -# -------- Optional modules & feature flags -------- -# Canonical optional modules control (CSV -> list). Default includes "clabs". -OPTIONAL_MODULES = [m.strip() for m in os.getenv("OPTIONAL_MODULES", "clabs").split(",") if m.strip()] -# Backward-compatible flag for CLabs; prefer OPTIONAL_MODULES going forward. -ENABLE_CLABS = str(os.getenv("ENABLE_CLABS", "false")).lower() in ("1", "true", "yes", "on") + # -------- Optional modules & feature flags -------- + # Canonical optional modules control (CSV -> list). Default includes "clabs". + OPTIONAL_MODULES = [m.strip() for m in os.getenv("OPTIONAL_MODULES", "clabs").split(",") if m.strip()] + # Backward-compatible flag for CLabs; prefer OPTIONAL_MODULES going forward. + ENABLE_CLABS = str(os.getenv("ENABLE_CLABS", "false")).lower() in ("1", "true", "yes", "on") class ProductionConfig(Config): DEBUG = False From 8e665cabcaf0c2707a24c3ebcc57a78162e05fef Mon Sep 17 00:00:00 2001 From: Jean Date: Fri, 3 Oct 2025 00:21:13 -0300 Subject: [PATCH 09/19] feat(clabs): add DELETE endpoint and wire running.html to remove CLabs --- apps/clabs/routes.py | 30 +++++++++++++++++++++++++ apps/clabs/templates/clabs/running.html | 1 + 2 files changed, 31 insertions(+) diff --git a/apps/clabs/routes.py b/apps/clabs/routes.py index 155c264..10ce095 100644 --- a/apps/clabs/routes.py +++ b/apps/clabs/routes.py @@ -267,3 +267,33 @@ def api_clear_all(): except Exception: current_app.logger.warning("Failed to save after clear", exc_info=True) return jsonify({"ok": True}) + +@blueprint.route("/api/delete/", methods=["DELETE", "POST"]) +def api_delete(clab_id): + # Access control básico: só o dono pode remover (ajuste depois conforme RBAC) + lab = CLABS_DETAILS.get(clab_id) + owner = getattr(current_user, "username", None) or getattr(current_user, "email", None) + if not lab: + return jsonify({"ok": False, "error": "CLab not found"}), 404 + if lab.get("user") not in (owner, "anonymous"): + return jsonify({"ok": False, "error": "Forbidden"}), 403 + + # Remove do mock de lista + kept = [] + removed = False + for c in CLABS: + _id = c.get("id") or c.get("lab_instance_id") or c.get("lab_id") + if _id == clab_id: + removed = True + continue + kept.append(c) + if removed: + CLABS[:] = kept + CLABS_DETAILS.pop(clab_id, None) + try: + save_state(default_state_path(current_app.config.get("CLABS_STATE_PATH")), CLABS, CLABS_DETAILS) + except Exception: + current_app.logger.warning("Failed to save after delete", exc_info=True) + return jsonify({"ok": True}) + else: + return jsonify({"ok": False, "error": "CLab not found"}), 404 diff --git a/apps/clabs/templates/clabs/running.html b/apps/clabs/templates/clabs/running.html index 5510273..89155f1 100644 --- a/apps/clabs/templates/clabs/running.html +++ b/apps/clabs/templates/clabs/running.html @@ -150,6 +150,7 @@

    Confirm CLab removal

    const listUrl = "{{ url_for('clabs_blueprint.api_list') }}"; const deleteUrlTpl = "{{ url_for('clabs_blueprint.api_delete', clab_id='__ID__') }}"; + // DataTable var table = $("#tableLabs").DataTable({ responsive: false, From ff009189df9a17b63fb989067f6fb0c859b9ceab Mon Sep 17 00:00:00 2001 From: Jean Date: Fri, 3 Oct 2025 00:38:21 -0300 Subject: [PATCH 10/19] refactor(clabs): wire routes to C9sController and drop mock/store usage --- apps/clabs/routes.py | 232 +++++++-------------------- apps/controllers/__init__.py | 22 ++- apps/controllers/clabernetes.py | 272 ++++++++++++++++++++++++++++++++ 3 files changed, 347 insertions(+), 179 deletions(-) create mode 100644 apps/controllers/clabernetes.py diff --git a/apps/clabs/routes.py b/apps/clabs/routes.py index 10ce095..f032355 100644 --- a/apps/clabs/routes.py +++ b/apps/clabs/routes.py @@ -3,15 +3,24 @@ from flask import render_template, request, jsonify, current_app from flask_login import current_user from datetime import datetime, timedelta -from .store import load_state, save_state, prune_inplace, default_state_path from . import blueprint -from .mock_data import CLABS, CLABS_DETAILS -# Tentamos usar PyYAML; se não estiver instalado, seguimos sem quebrar -try: - import yaml # PyYAML -except Exception: - yaml = None +from apps.controllers.clabernetes import C9sController +import yaml # agora é dependência real (requirements) + +# bootstrap lazy do controller (singleton por processo) +_CLABS_CTRL = None +def ctrl() -> C9sController: + global _CLABS_CTRL + if _CLABS_CTRL is None: + cfg = current_app.config + _CLABS_CTRL = C9sController( + state_path=cfg.get("CLABS_STATE_PATH"), + expire_days=cfg.get("CLABS_EXPIRE_DAYS", 0), + upload_max_files=cfg.get("CLABS_UPLOAD_MAX_FILES", 200), + ) + return _CLABS_CTRL + def _norm_lab_row(c: dict) -> dict: """Normaliza um item de CLABS para exibição na tabela.""" @@ -28,34 +37,18 @@ def _norm_lab_row(c: dict) -> dict: @blueprint.route("/running") def running(): - labs = [] - for c in CLABS: - lab_id = c.get("id") or c.get("lab_instance_id") or c.get("lab_id") - user = c.get("owner") or c.get("user") or "--" - title = c.get("name") or c.get("title") or "--" - created = c.get("created_at") or c.get("created") or "--" - - # se não tiver id em nenhum formato, pula a linha - if not lab_id: - continue - - labs.append({ - "lab_instance_id": lab_id, - "user": user, - "title": title, - "created": created, - }) - + owner = getattr(current_user, "username", None) or getattr(current_user, "email", None) + labs = ctrl().list(user=owner) return render_template("clabs/running.html", labs=labs) @blueprint.route("/open/") def open_clab(clab_id): - lab = CLABS_DETAILS.get(clab_id) + lab = ctrl().get(clab_id) if not lab: return render_template("pages/error.html", title="Open CLab", msg="CLab not found") - return render_template("clabs/open.html", lab=lab) + def _resources_from_clab_yaml(yaml_text: str): """ Constrói a lista de 'resources' (nós) a partir de um YAML ContainerLab. @@ -108,95 +101,48 @@ def create(): if request.method == "GET": return render_template("clabs/create.html") - # --- POST (PoC) --- - # Campos do formulário name = (request.form.get("clab_name") or "").strip() namespace = (request.form.get("clab_namespace") or "").strip() yaml_manifest = (request.form.get("clab_yaml") or "").strip() files = request.files.getlist("clab_files") or [] - files_meta = [] - for f in files: - files_meta.append({ - "name": f.filename, - "mimetype": getattr(f, "mimetype", "") or "", - "size": getattr(f, "content_length", None), - }) + files_meta = [{ + "name": f.filename, + "mimetype": getattr(f, "mimetype", "") or "", + "size": getattr(f, "content_length", None), + } for f in files] files_count = len(files_meta) - # Regras mínimas de envio: YAML ou pelo menos 1 arquivo if not yaml_manifest and files_count == 0: return jsonify({"ok": False, "result": "Provide YAML and/or files"}), 400 - # Limites de upload (quantidade) - PoC max_files = current_app.config.get("CLABS_UPLOAD_MAX_FILES", 200) if files_count > max_files: - return jsonify({ - "ok": False, - "result": f"Too many files: {files_count} (max {max_files})" - }), 400 + return jsonify({"ok": False, "result": f"Too many files: {files_count} (max {max_files})"}), 400 - # Validação de YAML no servidor (fallback/autoridade) - # Se o usuário enviou YAML e houver PyYAML disponível, valide e falhe (400) se inválido. - if yaml_manifest: - if yaml is not None: - try: - # Fazemos o parse só para validar; geração de resources acontece na função auxiliar - yaml.safe_load(yaml_manifest) - except Exception as e: - return jsonify({"ok": False, "result": f"YAML inválido: {e}"}), 400 - # Se yaml==None, seguimos (sem validar) pois o front já tentou avisar. + owner = getattr(current_user, "username", None) or getattr(current_user, "email", None) or "anonymous" - # Monta recursos (um por node) — segura mesmo sem YAML (retorna []) - resources = _resources_from_clab_yaml(yaml_manifest) - nodes_count = len(resources) - - # Identidade do "owner" (seguro para PoC) try: - owner = getattr(current_user, "username", None) or getattr(current_user, "email", None) or "anonymous" - except Exception: - owner = "anonymous" - - # ID e timestamps - new_id = f"clab-{datetime.utcnow().strftime('%Y%m%d%H%M%S')}" - created_str = datetime.utcnow().strftime('%Y-%m-%d %H:%M:%S') - - # Atualiza mocks (lista e detalhe) - CLABS.append({ - "id": new_id, - "lab_instance_id": new_id, - "owner": owner, - "user": owner, - "title": name or "Unnamed", - "name": name or "Unnamed", - "created_at": created_str, - "created": created_str, - "status": "Running", - "nodes": nodes_count, - }) - - CLABS_DETAILS[new_id] = { - "lab_instance_id": new_id, - "title": name or "Unnamed", - "user": owner, - "created": created_str, - "expires_at": None, - "resources": resources, - "files": files_meta, - } - - # Persistência (PoC) - try: - save_state(default_state_path(current_app.config.get("CLABS_STATE_PATH")), CLABS, CLABS_DETAILS) - except Exception: - current_app.logger.warning("Failed to save CLabs state", exc_info=True) - + detail = ctrl().create( + name=name, + namespace=namespace, + yaml_manifest=yaml_manifest, + files_meta=files_meta, + owner=owner, + ) + except yaml.YAMLError as e: + return jsonify({"ok": False, "result": f"Invalid YAML: {e}"}), 400 + except Exception as e: + current_app.logger.exception("Failed to create CLab") + return jsonify({"ok": False, "result": "Internal error"}), 500 + + nodes_count = len(detail.get("resources", [])) return jsonify({ "ok": True, - "result": f"CLab '{name or 'Unnamed'}' created (mock).", + "result": f"CLab '{detail.get('title','Unnamed')}' created.", "received": { - "id": new_id, - "namespace": namespace or "--", + "id": detail.get("lab_instance_id"), + "namespace": detail.get("namespace") or "--", "has_yaml": bool(yaml_manifest), "files": files_count, "resources": nodes_count, @@ -205,95 +151,27 @@ def create(): @blueprint.route("/api/list", methods=["GET"]) def api_list(): - # TTL opcional por idade em dias (0 = desativa) - expire_days = int(current_app.config.get("CLABS_EXPIRE_DAYS", 0) or 0) - removed = 0 - if expire_days > 0: - cutoff = datetime.utcnow() - timedelta(days=expire_days) - ids_to_remove = [] - - def parse_created(c: dict): - val = c.get("created_at") or c.get("created") - if not val: - return None - # tenta formatos comuns - for fmt in ("%Y-%m-%d %H:%M:%S", "%Y-%m-%dT%H:%M:%S", "%Y-%m-%dT%H:%M:%S.%f"): - try: - return datetime.strptime(val, fmt) - except Exception: - continue - # último recurso: tenta fromisoformat - try: - return datetime.fromisoformat(val.replace("Z", "")) - except Exception: - return None - - # coleta ids antigos - for c in CLABS: - dt = parse_created(c) - if dt and dt < cutoff: - _id = c.get("id") or c.get("lab_instance_id") or c.get("lab_id") - if _id: - ids_to_remove.append(_id) - - if ids_to_remove: - ids = set(ids_to_remove) - # remove da lista - CLABS[:] = [c for c in CLABS if (c.get("id") or c.get("lab_instance_id") or c.get("lab_id")) not in ids] - # remove detalhes - for cid in list(CLABS_DETAILS.keys()): - if cid in ids: - CLABS_DETAILS.pop(cid, None) - removed = len(ids) - try: - save_state(default_state_path(current_app.config.get("CLABS_STATE_PATH")), CLABS, CLABS_DETAILS) - except Exception: - current_app.logger.warning("Failed to save after TTL prune", exc_info=True) - - items = [] - for c in CLABS: - row = _norm_lab_row(c) - if row["lab_instance_id"]: - items.append(row) + removed = ctrl().prune() # respeita CLABS_EXPIRE_DAYS + items = ctrl().list() return jsonify({"items": items, "pruned": removed}) @blueprint.route("/api/clear", methods=["POST"]) def api_clear_all(): - """Dev only: limpa todos os CLabs do estado (lista + detalhes).""" - CLABS.clear() - CLABS_DETAILS.clear() - try: - save_state(default_state_path(current_app.config.get("CLABS_STATE_PATH")), CLABS, CLABS_DETAILS) - except Exception: - current_app.logger.warning("Failed to save after clear", exc_info=True) - return jsonify({"ok": True}) + n = ctrl().clear() + return jsonify({"ok": True, "removed": n}) @blueprint.route("/api/delete/", methods=["DELETE", "POST"]) def api_delete(clab_id): - # Access control básico: só o dono pode remover (ajuste depois conforme RBAC) - lab = CLABS_DETAILS.get(clab_id) - owner = getattr(current_user, "username", None) or getattr(current_user, "email", None) + lab = ctrl().get(clab_id) if not lab: return jsonify({"ok": False, "error": "CLab not found"}), 404 + + owner = getattr(current_user, "username", None) or getattr(current_user, "email", None) if lab.get("user") not in (owner, "anonymous"): return jsonify({"ok": False, "error": "Forbidden"}), 403 - # Remove do mock de lista - kept = [] - removed = False - for c in CLABS: - _id = c.get("id") or c.get("lab_instance_id") or c.get("lab_id") - if _id == clab_id: - removed = True - continue - kept.append(c) - if removed: - CLABS[:] = kept - CLABS_DETAILS.pop(clab_id, None) - try: - save_state(default_state_path(current_app.config.get("CLABS_STATE_PATH")), CLABS, CLABS_DETAILS) - except Exception: - current_app.logger.warning("Failed to save after delete", exc_info=True) + ok = ctrl().delete(clab_id) + if ok: return jsonify({"ok": True}) - else: - return jsonify({"ok": False, "error": "CLab not found"}), 404 + return jsonify({"ok": False, "error": "CLab not found"}), 404 + diff --git a/apps/controllers/__init__.py b/apps/controllers/__init__.py index 139db07..a336ca7 100644 --- a/apps/controllers/__init__.py +++ b/apps/controllers/__init__.py @@ -1,5 +1,23 @@ """apps controllers""" -from apps.controllers.kubernetes import K8sController +from .kubernetes import K8sController +from .clabernetes import C9sController -k8s = K8sController() +class _LazyProxy: + def __init__(self, factory): + self._factory = factory + self._inst = None + def _get(self): + if self._inst is None: + self._inst = self._factory() + return self._inst + def __getattr__(self, name): + return getattr(self._get(), name) + def __call__(self, *args, **kwargs): + return self._get() + +# proxies: só instanciam quando alguém usa +k8s = _LazyProxy(lambda: K8sController()) +c9s = _LazyProxy(lambda: C9sController()) + +__all__ = ["K8sController", "C9sController", "k8s", "c9s"] diff --git a/apps/controllers/clabernetes.py b/apps/controllers/clabernetes.py new file mode 100644 index 0000000..5533be1 --- /dev/null +++ b/apps/controllers/clabernetes.py @@ -0,0 +1,272 @@ +# -*- coding: utf-8 -*- +from __future__ import annotations + +import os +import json +import datetime as dt +import threading +from typing import List, Dict, Optional, Any + +import yaml # requer PyYAML no requirements.txt + + +class C9sController: + """ + Controller para gerenciar ContainerLabs (PoC): + - Estado em memória com persistência opcional em arquivo JSON + - Operações CRUD mínimas + TTL prune + - Parse de YAML ContainerLab -> resources (nós) + """ + + def __init__( + self, + state_path: Optional[str] = None, + expire_days: int = 0, + upload_max_files: int = 200, + ) -> None: + self._lock = threading.RLock() + self.state_path = state_path or None + self.expire_days = int(expire_days or 0) + self.upload_max_files = int(upload_max_files or 200) + + self._list: List[Dict[str, Any]] = [] + self._details: Dict[str, Dict[str, Any]] = {} + + self._load_state() + + # -------------------- Persistência PoC -------------------- + + def _state_file(self) -> Optional[str]: + if not self.state_path: + return None + os.makedirs(os.path.dirname(self.state_path), exist_ok=True) + return self.state_path + + def _load_state(self) -> None: + path = self._state_file() + if not path or not os.path.exists(path): + self._list = [] + self._details = {} + return + try: + with self._lock, open(path, "r", encoding="utf-8") as f: + payload = json.load(f) + self._list = payload.get("list", []) or [] + self._details = payload.get("details", {}) or {} + except Exception: + # Em caso de erro de leitura, inicia vazio (não quebra a app) + self._list = [] + self._details = {} + + def _save_state(self) -> None: + path = self._state_file() + if not path: + return + payload = {"list": self._list, "details": self._details} + tmp = path + ".tmp" + with self._lock, open(tmp, "w", encoding="utf-8") as f: + json.dump(payload, f, ensure_ascii=False, indent=2) + os.replace(tmp, path) + + # -------------------- Helpers -------------------- + + @staticmethod + def _normalize_row(c: dict) -> dict: + lab_id = c.get("id") or c.get("lab_instance_id") or c.get("lab_id") + user = c.get("owner") or c.get("user") or "--" + title = c.get("name") or c.get("title") or "--" + created = c.get("created_at") or c.get("created") or "--" + return { + "lab_instance_id": lab_id, + "user": user, + "title": title, + "created": created, + } + + @staticmethod + def _parse_created(val: Optional[str]) -> Optional[dt.datetime]: + if not val: + return None + for fmt in ("%Y-%m-%d %H:%M:%S", "%Y-%m-%dT%H:%M:%S", "%Y-%m-%dT%H:%M:%S.%f"): + try: + return dt.datetime.strptime(val, fmt) + except Exception: + continue + try: + return dt.datetime.fromisoformat(val.replace("Z", "")) + except Exception: + return None + + # -------------------- API pública -------------------- + + def list(self, user: Optional[str] = None) -> List[dict]: + """ + Retorna linhas normalizadas para tabela. Se `user` for fornecido, + o filtro por dono pode ser feito aqui (ou nas rotas/RBAC externo). + """ + items = [] + for c in self._list: + # se quiser filtrar por owner, descomente: + # if user and (c.get("owner") or c.get("user")) != user: + # continue + row = self._normalize_row(c) + if row["lab_instance_id"]: + items.append(row) + return items + + def get(self, lab_id: str) -> Optional[dict]: + return self._details.get(lab_id) + + def delete(self, lab_id: str) -> bool: + with self._lock: + if lab_id not in self._details: + return False + # remove detalhes + self._details.pop(lab_id, None) + # remove da lista + self._list = [ + c + for c in self._list + if (c.get("id") or c.get("lab_instance_id") or c.get("lab_id")) != lab_id + ] + self._save_state() + return True + + def clear(self) -> int: + with self._lock: + n = len(self._details) + self._list.clear() + self._details.clear() + self._save_state() + return n + + def prune(self, now: Optional[dt.datetime] = None) -> int: + """Remove labs criados há mais de `expire_days` (se > 0).""" + days = self.expire_days + if not days or days <= 0: + return 0 + + cutoff = (now or dt.datetime.utcnow()) - dt.timedelta(days=days) + + ids_to_remove: List[str] = [] + for c in self._list: + created_val = c.get("created_at") or c.get("created") + ts = self._parse_created(created_val) + if ts and ts < cutoff: + _id = c.get("id") or c.get("lab_instance_id") or c.get("lab_id") + if _id: + ids_to_remove.append(_id) + + if not ids_to_remove: + return 0 + + ids = set(ids_to_remove) + with self._lock: + self._list = [ + c + for c in self._list + if (c.get("id") or c.get("lab_instance_id") or c.get("lab_id")) not in ids + ] + for cid in list(self._details.keys()): + if cid in ids: + self._details.pop(cid, None) + self._save_state() + + return len(ids) + + # -------------------- Criação & YAML -------------------- + + def _resources_from_yaml(self, yaml_text: str) -> List[dict]: + """ + Constrói a lista de resources (nós) a partir de um YAML ContainerLab. + """ + if not yaml_text: + return [] + + data = yaml.safe_load(yaml_text) + if not isinstance(data, dict): + return [] + + topo = data.get("topology") or {} + nodes = topo.get("nodes") or {} + if not isinstance(nodes, dict): + return [] + + resources = [] + for name, cfg in nodes.items(): + pod_ip = None + node_name = None + if isinstance(cfg, dict): + pod_ip = cfg.get("mgmt_ipv4") + node_name = cfg.get("kind") or cfg.get("image") or "--" + + resources.append( + { + "kind": "node", + "name": str(name), + "ready": "Running", + "links": [{"label": "Console", "href": "#"}], + "services": [], + "age": "--", + "node_name": node_name or "--", + "pod_ip": pod_ip or "--", + } + ) + + return resources + + def create( + self, + name: str, + namespace: str, + yaml_manifest: str, + files_meta: Optional[List[dict]], + owner: Optional[str], + ) -> dict: + """ + Cria um novo CLab (PoC), valida YAML e atualiza estado. + Retorna o detalhe criado. + """ + if yaml_manifest: + # valida sintaxe (raise se inválido) + yaml.safe_load(yaml_manifest) + + resources = self._resources_from_yaml(yaml_manifest) + nodes_count = len(resources) + + now = dt.datetime.utcnow() + new_id = f"clab-{now.strftime('%Y%m%d%H%M%S')}" + created_str = now.strftime("%Y-%m-%d %H:%M:%S") + _owner = owner or "anonymous" + _name = name or "Unnamed" + + header = { + "id": new_id, + "lab_instance_id": new_id, + "owner": _owner, + "user": _owner, + "title": _name, + "name": _name, + "created_at": created_str, + "created": created_str, + "status": "Running", + "nodes": nodes_count, + } + + detail = { + "lab_instance_id": new_id, + "title": _name, + "user": _owner, + "created": created_str, + "expires_at": None, + "resources": resources, + "files": files_meta or [], + "namespace": namespace or "--", + } + + with self._lock: + self._list.append(header) + self._details[new_id] = detail + self._save_state() + + return detail From c5ce8287f46912723e98c997b2a5b47cf852f8bf Mon Sep 17 00:00:00 2001 From: Jean Date: Sat, 4 Oct 2025 19:00:33 -0300 Subject: [PATCH 11/19] =?UTF-8?q?clabs(routes):=20thin=20controllers=20+?= =?UTF-8?q?=20authZ=20por=20dono/role;=20valida=C3=A7=C3=A3o=20YAML=20via?= =?UTF-8?q?=20controller?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- apps/clabs/routes.py | 126 ++++++++++++++++--------------------------- 1 file changed, 46 insertions(+), 80 deletions(-) diff --git a/apps/clabs/routes.py b/apps/clabs/routes.py index f032355..dea0246 100644 --- a/apps/clabs/routes.py +++ b/apps/clabs/routes.py @@ -1,102 +1,56 @@ # -*- encoding: utf-8 -*- -import os from flask import render_template, request, jsonify, current_app -from flask_login import current_user -from datetime import datetime, timedelta -from . import blueprint - +from flask_login import current_user, login_required from apps.controllers.clabernetes import C9sController -import yaml # agora é dependência real (requirements) +import yaml + +from . import blueprint -# bootstrap lazy do controller (singleton por processo) +# -------- Controller singleton (lazy) -------- _CLABS_CTRL = None def ctrl() -> C9sController: + """Return a lazily-initialized controller instance.""" global _CLABS_CTRL if _CLABS_CTRL is None: cfg = current_app.config _CLABS_CTRL = C9sController( - state_path=cfg.get("CLABS_STATE_PATH"), + state_path=cfg.get("CLABS_STATE_PATH"), # será removido no Bloco 2 expire_days=cfg.get("CLABS_EXPIRE_DAYS", 0), upload_max_files=cfg.get("CLABS_UPLOAD_MAX_FILES", 200), ) return _CLABS_CTRL +# -------- Access helpers -------- +def _is_admin_or_teacher() -> bool: + cat = getattr(current_user, "category", "") or "" + return cat in ("admin", "teacher") -def _norm_lab_row(c: dict) -> dict: - """Normaliza um item de CLABS para exibição na tabela.""" - lab_id = c.get("id") or c.get("lab_instance_id") or c.get("lab_id") - user = c.get("owner") or c.get("user") or "--" - title = c.get("name") or c.get("title") or "--" - created = c.get("created_at") or c.get("created") or "--" - return { - "lab_instance_id": lab_id, - "user": user, - "title": title, - "created": created, - } +def _owner_identity() -> str: + return getattr(current_user, "username", None) or getattr(current_user, "email", None) or "anonymous" +# ----------------- Views ----------------- @blueprint.route("/running") +@login_required def running(): - owner = getattr(current_user, "username", None) or getattr(current_user, "email", None) - labs = ctrl().list(user=owner) - return render_template("clabs/running.html", labs=labs) + """List running labs. Admin/teacher sees all; users see only their labs.""" + if _is_admin_or_teacher(): + items = ctrl().list() + else: + items = ctrl().list(user=_owner_identity()) + return render_template("clabs/running.html", labs=items) @blueprint.route("/open/") +@login_required def open_clab(clab_id): lab = ctrl().get(clab_id) if not lab: return render_template("pages/error.html", title="Open CLab", msg="CLab not found") + if (not _is_admin_or_teacher()) and (lab.get("user") != _owner_identity()): + return render_template("pages/error.html", title="Open CLab", msg="Forbidden"), 403 return render_template("clabs/open.html", lab=lab) - -def _resources_from_clab_yaml(yaml_text: str): - """ - Constrói a lista de 'resources' (nós) a partir de um YAML ContainerLab. - Se PyYAML não estiver disponível ou o YAML estiver inválido, retorna []. - """ - if not yaml or not yaml_text: - return [] - - try: - data = yaml.safe_load(yaml_text) - except Exception: - return [] - - if not isinstance(data, dict): - return [] - - topo = data.get("topology") or {} - nodes = topo.get("nodes") or {} - if not isinstance(nodes, dict): - return [] - - resources = [] - for name, cfg in nodes.items(): - kind = "node" - ready = "Running" - pod_ip = None - node_name = None - links = [{"label": "Console", "href": "#"}] - services = [] - - if isinstance(cfg, dict): - pod_ip = cfg.get("mgmt_ipv4") - node_name = cfg.get("kind") or cfg.get("image") or "--" - - resources.append({ - "kind": kind, - "name": str(name), - "ready": ready, - "links": links, - "services": services, - "age": "--", - "node_name": node_name or "--", - "pod_ip": pod_ip or "--", - }) - - return resources - @blueprint.route("/create", methods=["GET", "POST"]) +@login_required def create(): if request.method == "GET": return render_template("clabs/create.html") @@ -118,9 +72,12 @@ def create(): max_files = current_app.config.get("CLABS_UPLOAD_MAX_FILES", 200) if files_count > max_files: - return jsonify({"ok": False, "result": f"Too many files: {files_count} (max {max_files})"}), 400 + return jsonify({ + "ok": False, + "result": f"Too many files: {files_count} (max {max_files})" + }), 400 - owner = getattr(current_user, "username", None) or getattr(current_user, "email", None) or "anonymous" + owner = _owner_identity() try: detail = ctrl().create( @@ -132,7 +89,7 @@ def create(): ) except yaml.YAMLError as e: return jsonify({"ok": False, "result": f"Invalid YAML: {e}"}), 400 - except Exception as e: + except Exception: current_app.logger.exception("Failed to create CLab") return jsonify({"ok": False, "result": "Internal error"}), 500 @@ -150,28 +107,37 @@ def create(): }), 201 @blueprint.route("/api/list", methods=["GET"]) +@login_required def api_list(): - removed = ctrl().prune() # respeita CLABS_EXPIRE_DAYS - items = ctrl().list() - return jsonify({"items": items, "pruned": removed}) + """Return list of labs + number of pruned items (TTL).""" + pruned = ctrl().prune() + if _is_admin_or_teacher(): + items = ctrl().list() + else: + items = ctrl().list(user=_owner_identity()) + return jsonify({"items": items, "pruned": pruned}) @blueprint.route("/api/clear", methods=["POST"]) +@login_required def api_clear_all(): + """Admin/teacher-only: clear all labs from state.""" + if not _is_admin_or_teacher(): + return jsonify({"ok": False, "error": "Forbidden"}), 403 n = ctrl().clear() return jsonify({"ok": True, "removed": n}) @blueprint.route("/api/delete/", methods=["DELETE", "POST"]) +@login_required def api_delete(clab_id): + """Delete a single lab. Owners can delete their own; admin/teacher can delete any.""" lab = ctrl().get(clab_id) if not lab: return jsonify({"ok": False, "error": "CLab not found"}), 404 - owner = getattr(current_user, "username", None) or getattr(current_user, "email", None) - if lab.get("user") not in (owner, "anonymous"): + if (not _is_admin_or_teacher()) and (lab.get("user") != _owner_identity()): return jsonify({"ok": False, "error": "Forbidden"}), 403 ok = ctrl().delete(clab_id) if ok: return jsonify({"ok": True}) return jsonify({"ok": False, "error": "CLab not found"}), 404 - From 8c81eab9ad91f4e08ad0314969068a245c2af137 Mon Sep 17 00:00:00 2001 From: Jean Date: Sat, 4 Oct 2025 20:41:09 -0300 Subject: [PATCH 12/19] config/clabs: controller owns state path default; remove config key --- apps/clabs/routes.py | 1 - apps/config.py | 1 - apps/controllers/clabernetes.py | 63 ++++++++++++++++++++------------- requirements.txt | 1 + 4 files changed, 39 insertions(+), 27 deletions(-) diff --git a/apps/clabs/routes.py b/apps/clabs/routes.py index dea0246..af9cb5e 100644 --- a/apps/clabs/routes.py +++ b/apps/clabs/routes.py @@ -14,7 +14,6 @@ def ctrl() -> C9sController: if _CLABS_CTRL is None: cfg = current_app.config _CLABS_CTRL = C9sController( - state_path=cfg.get("CLABS_STATE_PATH"), # será removido no Bloco 2 expire_days=cfg.get("CLABS_EXPIRE_DAYS", 0), upload_max_files=cfg.get("CLABS_UPLOAD_MAX_FILES", 200), ) diff --git a/apps/config.py b/apps/config.py index 4299bb8..3ff7322 100644 --- a/apps/config.py +++ b/apps/config.py @@ -12,7 +12,6 @@ class Config(object): basedir = os.path.abspath(os.path.dirname(__file__)) # Persistência dos CLabs (PoC) - CLABS_STATE_PATH = os.getenv("CLABS_STATE_PATH", None) CLABS_EXPIRE_DAYS = int(os.getenv("CLABS_EXPIRE_DAYS", "0")) # Limites de upload diff --git a/apps/controllers/clabernetes.py b/apps/controllers/clabernetes.py index 5533be1..e520b90 100644 --- a/apps/controllers/clabernetes.py +++ b/apps/controllers/clabernetes.py @@ -3,19 +3,20 @@ import os import json +import tempfile import datetime as dt import threading from typing import List, Dict, Optional, Any -import yaml # requer PyYAML no requirements.txt +import yaml # requires PyYAML in requirements.txt class C9sController: """ - Controller para gerenciar ContainerLabs (PoC): - - Estado em memória com persistência opcional em arquivo JSON - - Operações CRUD mínimas + TTL prune - - Parse de YAML ContainerLab -> resources (nós) + Controller to manage ContainerLabs (PoC): + - In-memory state with optional JSON file persistence (safe defaults) + - Minimal CRUD ops + TTL prune + - ContainerLab YAML parsing -> resource (node) list """ def __init__( @@ -25,7 +26,14 @@ def __init__( upload_max_files: int = 200, ) -> None: self._lock = threading.RLock() - self.state_path = state_path or None + + # Persistence default order: + # 1) explicit state_path argument + # 2) environment var CLABS_STATE_PATH (backward compatible) + # 3) safe temp file fallback + default_file = os.path.join(tempfile.gettempdir(), "clabs_state.json") + self.state_path = state_path or os.getenv("CLABS_STATE_PATH") or default_file + self.expire_days = int(expire_days or 0) self.upload_max_files = int(upload_max_files or 200) @@ -34,12 +42,17 @@ def __init__( self._load_state() - # -------------------- Persistência PoC -------------------- + # -------------------- Persistence (PoC) -------------------- def _state_file(self) -> Optional[str]: + """ + Ensure the directory exists and return the file path. + """ if not self.state_path: return None - os.makedirs(os.path.dirname(self.state_path), exist_ok=True) + dirname = os.path.dirname(self.state_path) or None + if dirname: + os.makedirs(dirname, exist_ok=True) return self.state_path def _load_state(self) -> None: @@ -54,7 +67,7 @@ def _load_state(self) -> None: self._list = payload.get("list", []) or [] self._details = payload.get("details", {}) or {} except Exception: - # Em caso de erro de leitura, inicia vazio (não quebra a app) + # On read error, start empty (do not break the app) self._list = [] self._details = {} @@ -97,18 +110,18 @@ def _parse_created(val: Optional[str]) -> Optional[dt.datetime]: except Exception: return None - # -------------------- API pública -------------------- + # -------------------- Public API -------------------- def list(self, user: Optional[str] = None) -> List[dict]: """ - Retorna linhas normalizadas para tabela. Se `user` for fornecido, - o filtro por dono pode ser feito aqui (ou nas rotas/RBAC externo). + Return normalized table rows. If `user` is provided, filter by owner. """ - items = [] + items: List[dict] = [] for c in self._list: - # se quiser filtrar por owner, descomente: - # if user and (c.get("owner") or c.get("user")) != user: - # continue + if user: + owner = c.get("owner") or c.get("user") + if owner != user: + continue row = self._normalize_row(c) if row["lab_instance_id"]: items.append(row) @@ -121,9 +134,9 @@ def delete(self, lab_id: str) -> bool: with self._lock: if lab_id not in self._details: return False - # remove detalhes + # remove details self._details.pop(lab_id, None) - # remove da lista + # remove from list self._list = [ c for c in self._list @@ -141,7 +154,7 @@ def clear(self) -> int: return n def prune(self, now: Optional[dt.datetime] = None) -> int: - """Remove labs criados há mais de `expire_days` (se > 0).""" + """Remove labs older than `expire_days` (if > 0).""" days = self.expire_days if not days or days <= 0: return 0 @@ -174,11 +187,11 @@ def prune(self, now: Optional[dt.datetime] = None) -> int: return len(ids) - # -------------------- Criação & YAML -------------------- + # -------------------- Create & YAML -------------------- def _resources_from_yaml(self, yaml_text: str) -> List[dict]: """ - Constrói a lista de resources (nós) a partir de um YAML ContainerLab. + Build the resource (node) list from a ContainerLab YAML manifest. """ if not yaml_text: return [] @@ -192,7 +205,7 @@ def _resources_from_yaml(self, yaml_text: str) -> List[dict]: if not isinstance(nodes, dict): return [] - resources = [] + resources: List[dict] = [] for name, cfg in nodes.items(): pod_ip = None node_name = None @@ -224,11 +237,11 @@ def create( owner: Optional[str], ) -> dict: """ - Cria um novo CLab (PoC), valida YAML e atualiza estado. - Retorna o detalhe criado. + Create a new CLab (PoC), validate YAML and update state. + Return the created detail. """ if yaml_manifest: - # valida sintaxe (raise se inválido) + # validate syntax (raises yaml.YAMLError if invalid) yaml.safe_load(yaml_manifest) resources = self._resources_from_yaml(yaml_manifest) diff --git a/requirements.txt b/requirements.txt index 8adceb5..41f53c4 100644 --- a/requirements.txt +++ b/requirements.txt @@ -20,6 +20,7 @@ kubernetes markdown2 flask_mail Flask-Caching +PyYAML>=6.0.1,<7 # flask_mysqldb # psycopg2-binary From a2e6cf2ac2a830fe4dd03a96b872314ea37584ab Mon Sep 17 00:00:00 2001 From: Jean Date: Sat, 4 Oct 2025 21:40:41 -0300 Subject: [PATCH 13/19] clabs(cleanup): remove PoC mocks/store files --- apps/clabs/mock_data.py | 19 ------------- apps/clabs/store.py | 61 ----------------------------------------- 2 files changed, 80 deletions(-) delete mode 100644 apps/clabs/mock_data.py delete mode 100644 apps/clabs/store.py diff --git a/apps/clabs/mock_data.py b/apps/clabs/mock_data.py deleted file mode 100644 index e0268ae..0000000 --- a/apps/clabs/mock_data.py +++ /dev/null @@ -1,19 +0,0 @@ -from typing import List, Dict -from .store import load_state, default_state_path - -# mocks padrão (usados se não houver estado persistido) -CLABS: List[dict] = [] - -CLABS_DETAILS: Dict[str, dict] = {} - -# tenta carregar estado persistido -try: - path = default_state_path() # --> .../apps/data/clabs_state.json - _clabs, _details = load_state(path) - if _clabs or _details: - CLABS[:] = _clabs - CLABS_DETAILS.clear() - CLABS_DETAILS.update(_details) -except Exception: - # mantém mocks se falhar - pass diff --git a/apps/clabs/store.py b/apps/clabs/store.py deleted file mode 100644 index 1fc0ab3..0000000 --- a/apps/clabs/store.py +++ /dev/null @@ -1,61 +0,0 @@ -import os -import json -from typing import Tuple, Dict, List, Optional - -def _ensure_dir(path: str) -> None: - os.makedirs(os.path.dirname(path), exist_ok=True) - -def default_state_path(cfg_path: Optional[str] = None) -> str: - if cfg_path: - return cfg_path - base = os.path.abspath(os.path.join(os.path.dirname(__file__), "..")) # .../apps - return os.path.join(base, "data", "clabs_state.json") - -def load_state(state_path: str) -> Tuple[List[dict], Dict[str, dict]]: - """ - Carrega estado do disco. Se não existir ou falhar, retorna ([], {}). - """ - try: - if not os.path.exists(state_path): - return [], {} - with open(state_path, "r", encoding="utf-8") as f: - data = json.load(f) - clabs = data.get("clabs", []) - details = data.get("details", {}) - if not isinstance(clabs, list): clabs = [] - if not isinstance(details, dict): details = {} - return clabs, details - except Exception: - return [], {} - -def save_state(state_path: str, clabs: List[dict], details: Dict[str, dict]) -> None: - """ - Salva estado de forma atômica (JSON). Cria a pasta se não existir. - """ - _ensure_dir(state_path) - tmp = state_path + ".tmp" - payload = {"clabs": clabs, "details": details} - with open(tmp, "w", encoding="utf-8") as f: - json.dump(payload, f, ensure_ascii=False, indent=2) - os.replace(tmp, state_path) - -def prune_inplace(clabs: List[dict], details: Dict[str, dict], max_days: int = 0) -> int: - """ - Remoção simplificada (PoC). max_days=0 desativa. Aqui só remove status 'expired'/'deleted'. - """ - if not max_days or max_days <= 0: - return 0 - ids = [] - for c in clabs: - status = (c.get("status") or "").lower() - if status in {"expired", "deleted"}: - _id = c.get("id") or c.get("lab_instance_id") or c.get("lab_id") - if _id: - ids.append(_id) - if not ids: return 0 - idset = set(ids) - clabs[:] = [c for c in clabs if (c.get("id") or c.get("lab_instance_id") or c.get("lab_id")) not in idset] - for k in list(details.keys()): - if k in idset: - details.pop(k, None) - return len(ids) From b177369128285d18fda9372b8a243020c8a71cf0 Mon Sep 17 00:00:00 2001 From: Jean Date: Sun, 12 Oct 2025 19:08:17 -0300 Subject: [PATCH 14/19] :wrench: chore: atualizar .gitignore --- .gitignore | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.gitignore b/.gitignore index 61ec9f3..afae21a 100644 --- a/.gitignore +++ b/.gitignore @@ -36,3 +36,5 @@ apps/static/assets/.temp *.pem kube-config.yaml + +*.sh text eol=lf \ No newline at end of file From df65d39361df9f1596724ea9500b96f858d06d27 Mon Sep 17 00:00:00 2001 From: Jean Date: Sun, 12 Oct 2025 20:56:32 -0300 Subject: [PATCH 15/19] :sparkles: feat: models Clab/ClabInstance --- apps/clabs/__init__.py | 1 + apps/clabs/models.py | 62 +++++++++++++++++++ .../versions/2.0.3_add_clabs_core_2.0.4.py | 43 +++++++++++++ .../2.0.3_add_clabs_core_2.0.4.py.bak | 48 ++++++++++++++ .../2.0.4_add_clab_instances_core_2.0.5.py | 55 ++++++++++++++++ ....5_add_clab_groups_and_categories_2.0.6.py | 44 +++++++++++++ scripts/bump_alembic_rev.py | 8 +++ scripts/bump_alembic_rev_to_2_0_6.py | 8 +++ 8 files changed, 269 insertions(+) create mode 100644 apps/clabs/models.py create mode 100644 migrations/versions/2.0.3_add_clabs_core_2.0.4.py create mode 100644 migrations/versions/2.0.3_add_clabs_core_2.0.4.py.bak create mode 100644 migrations/versions/2.0.4_add_clab_instances_core_2.0.5.py create mode 100644 migrations/versions/2.0.5_add_clab_groups_and_categories_2.0.6.py create mode 100644 scripts/bump_alembic_rev.py create mode 100644 scripts/bump_alembic_rev_to_2_0_6.py diff --git a/apps/clabs/__init__.py b/apps/clabs/__init__.py index 0b0ba0e..4e8c306 100644 --- a/apps/clabs/__init__.py +++ b/apps/clabs/__init__.py @@ -1,5 +1,6 @@ # -*- encoding: utf-8 -*- from flask import Blueprint +from .models import Clab, ClabInstance blueprint = Blueprint( "clabs_blueprint", diff --git a/apps/clabs/models.py b/apps/clabs/models.py new file mode 100644 index 0000000..6d1cd48 --- /dev/null +++ b/apps/clabs/models.py @@ -0,0 +1,62 @@ +from datetime import datetime +from apps import db + +class Clab(db.Model): + __tablename__ = "clabs" + + id = db.Column(db.String(36), primary_key=True) + title = db.Column(db.String(255), nullable=False) + + description = db.Column(db.String(255)) + extended_desc = db.Column(db.LargeBinary) + clab_guide_md = db.Column(db.Text) + clab_guide_html = db.Column(db.Text) + yaml_manifest = db.Column(db.Text) + namespace_default = db.Column(db.String(128)) + + created_at = db.Column(db.DateTime, default=datetime.utcnow, nullable=False) + updated_at = db.Column( + db.DateTime, default=datetime.utcnow, onupdate=datetime.utcnow, nullable=False + ) + + def __repr__(self): + return f"" + +class ClabInstance(db.Model): + __tablename__ = "clab_instances" + + # identidade / vínculo + id = db.Column(db.String(24), primary_key=True) # id curto, similar ao LabInstances + token = db.Column(db.String(64), unique=True, index=True, nullable=False) + + owner_user_id = db.Column(db.Integer, db.ForeignKey("users.id"), index=True, nullable=False) + clab_id = db.Column(db.String(36), db.ForeignKey("clabs.id"), index=True, nullable=False) + + # ciclo de vida + is_deleted = db.Column(db.Boolean, default=False, nullable=False) + expiration_ts = db.Column(db.DateTime, index=True) # definido em lógica de criação + finish_reason = db.Column(db.String(64)) + + # recursos materializados e namespace efetivo + _clab_resources = db.Column(db.Text) # JSON/texto + namespace_effective = db.Column(db.String(128)) # opcional + + # auditoria + created_at = db.Column(db.DateTime, default=datetime.utcnow, nullable=False) + updated_at = db.Column(db.DateTime, default=datetime.utcnow, onupdate=datetime.utcnow, nullable=False) + + def __repr__(self): + return f"" + + +clab_groups = db.Table( + "clab_groups", + db.Column("clab_id", db.String(36), db.ForeignKey("clabs.id"), primary_key=True), + db.Column("group_id", db.Integer, db.ForeignKey("groups.id"), primary_key=True), +) + +clab_categories_association = db.Table( + "clab_categories_association", + db.Column("clab_id", db.String(36), db.ForeignKey("clabs.id"), primary_key=True), + db.Column("category_id", db.Integer, db.ForeignKey("lab_categories.id"), primary_key=True), +) diff --git a/migrations/versions/2.0.3_add_clabs_core_2.0.4.py b/migrations/versions/2.0.3_add_clabs_core_2.0.4.py new file mode 100644 index 0000000..b7627aa --- /dev/null +++ b/migrations/versions/2.0.3_add_clabs_core_2.0.4.py @@ -0,0 +1,43 @@ +"""add clabs core + +Revision ID: 2.0.4 +Revises: 2.0.3 +Create Date: 2025-10-12 22:30:57.032807 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '2.0.4' +down_revision = '2.0.3' +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('clabs', + sa.Column('id', sa.String(length=36), nullable=False), + sa.Column('title', sa.String(length=255), nullable=False), + sa.Column('description', sa.String(length=255), nullable=True), + sa.Column('extended_desc', sa.LargeBinary(), nullable=True), + sa.Column('clab_guide_md', sa.Text(), nullable=True), + sa.Column('clab_guide_html', sa.Text(), nullable=True), + sa.Column('yaml_manifest', sa.Text(), nullable=True), + sa.Column('namespace_default', sa.String(length=128), nullable=True), + sa.Column('created_at', sa.DateTime(), nullable=False), + sa.Column('updated_at', sa.DateTime(), nullable=False), + sa.PrimaryKeyConstraint('id') + ) + + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + + op.drop_table('clabs') + # ### end Alembic commands ### + diff --git a/migrations/versions/2.0.3_add_clabs_core_2.0.4.py.bak b/migrations/versions/2.0.3_add_clabs_core_2.0.4.py.bak new file mode 100644 index 0000000..83399ae --- /dev/null +++ b/migrations/versions/2.0.3_add_clabs_core_2.0.4.py.bak @@ -0,0 +1,48 @@ +"""add clabs core + +Revision ID: 2.0.4 +Revises: 2.0.3 +Create Date: 2025-10-12 22:30:57.032807 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '2.0.4' +down_revision = '2.0.3' +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('clabs', + sa.Column('id', sa.String(length=36), nullable=False), + sa.Column('title', sa.String(length=255), nullable=False), + sa.Column('description', sa.String(length=255), nullable=True), + sa.Column('extended_desc', sa.LargeBinary(), nullable=True), + sa.Column('clab_guide_md', sa.Text(), nullable=True), + sa.Column('clab_guide_html', sa.Text(), nullable=True), + sa.Column('yaml_manifest', sa.Text(), nullable=True), + sa.Column('namespace_default', sa.String(length=128), nullable=True), + sa.Column('created_at', sa.DateTime(), nullable=False), + sa.Column('updated_at', sa.DateTime(), nullable=False), + sa.PrimaryKeyConstraint('id') + ) + with op.batch_alter_table('lab_answers', schema=None) as batch_op: + batch_op.add_column(sa.Column('comments', sa.String(), nullable=True)) + batch_op.add_column(sa.Column('grades', sa.String(), nullable=True)) + + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + with op.batch_alter_table('lab_answers', schema=None) as batch_op: + batch_op.drop_column('grades') + batch_op.drop_column('comments') + + op.drop_table('clabs') + # ### end Alembic commands ### diff --git a/migrations/versions/2.0.4_add_clab_instances_core_2.0.5.py b/migrations/versions/2.0.4_add_clab_instances_core_2.0.5.py new file mode 100644 index 0000000..812be08 --- /dev/null +++ b/migrations/versions/2.0.4_add_clab_instances_core_2.0.5.py @@ -0,0 +1,55 @@ +"""add clab_instances core + +Revision ID: 2.0.5 +Revises: 2.0.4 +Create Date: 2025-10-12 22:56:48.583230 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '2.0.5' +down_revision = '2.0.4' +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('clab_instances', + sa.Column('id', sa.String(length=24), nullable=False), + sa.Column('token', sa.String(length=64), nullable=False), + sa.Column('owner_user_id', sa.Integer(), nullable=False), + sa.Column('clab_id', sa.String(length=36), nullable=False), + sa.Column('is_deleted', sa.Boolean(), nullable=False), + sa.Column('expiration_ts', sa.DateTime(), nullable=True), + sa.Column('finish_reason', sa.String(length=64), nullable=True), + sa.Column('_clab_resources', sa.Text(), nullable=True), + sa.Column('namespace_effective', sa.String(length=128), nullable=True), + sa.Column('created_at', sa.DateTime(), nullable=False), + sa.Column('updated_at', sa.DateTime(), nullable=False), + sa.ForeignKeyConstraint(['clab_id'], ['clabs.id'], ), + sa.ForeignKeyConstraint(['owner_user_id'], ['users.id'], ), + sa.PrimaryKeyConstraint('id') + ) + with op.batch_alter_table('clab_instances', schema=None) as batch_op: + batch_op.create_index(batch_op.f('ix_clab_instances_clab_id'), ['clab_id'], unique=False) + batch_op.create_index(batch_op.f('ix_clab_instances_expiration_ts'), ['expiration_ts'], unique=False) + batch_op.create_index(batch_op.f('ix_clab_instances_owner_user_id'), ['owner_user_id'], unique=False) + batch_op.create_index(batch_op.f('ix_clab_instances_token'), ['token'], unique=True) + + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + with op.batch_alter_table('clab_instances', schema=None) as batch_op: + batch_op.drop_index(batch_op.f('ix_clab_instances_token')) + batch_op.drop_index(batch_op.f('ix_clab_instances_owner_user_id')) + batch_op.drop_index(batch_op.f('ix_clab_instances_expiration_ts')) + batch_op.drop_index(batch_op.f('ix_clab_instances_clab_id')) + + op.drop_table('clab_instances') + # ### end Alembic commands ### diff --git a/migrations/versions/2.0.5_add_clab_groups_and_categories_2.0.6.py b/migrations/versions/2.0.5_add_clab_groups_and_categories_2.0.6.py new file mode 100644 index 0000000..2bf9232 --- /dev/null +++ b/migrations/versions/2.0.5_add_clab_groups_and_categories_2.0.6.py @@ -0,0 +1,44 @@ +"""add clab groups and categories associations + +Revision ID: 2.0.6 +Revises: 2.0.5 +Create Date: 2025-10-12 23:26:20.674605 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '2.0.6' +down_revision = '2.0.5' +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('clab_categories_association', + sa.Column('clab_id', sa.String(length=36), nullable=False), + sa.Column('category_id', sa.Integer(), nullable=False), + sa.ForeignKeyConstraint(['category_id'], ['lab_categories.id'], ), + sa.ForeignKeyConstraint(['clab_id'], ['clabs.id'], ), + sa.PrimaryKeyConstraint('clab_id', 'category_id') + ) + op.create_table('clab_groups', + sa.Column('clab_id', sa.String(length=36), nullable=False), + sa.Column('group_id', sa.Integer(), nullable=False), + sa.ForeignKeyConstraint(['clab_id'], ['clabs.id'], ), + sa.ForeignKeyConstraint(['group_id'], ['groups.id'], ), + sa.PrimaryKeyConstraint('clab_id', 'group_id') + ) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_table('clab_groups') + op.drop_table('clab_categories_association') + # ### end Alembic commands ### + + diff --git a/scripts/bump_alembic_rev.py b/scripts/bump_alembic_rev.py new file mode 100644 index 0000000..8f79290 --- /dev/null +++ b/scripts/bump_alembic_rev.py @@ -0,0 +1,8 @@ +import sqlite3 +p = "apps/data/db.sqlite3" +con = sqlite3.connect(p) +cur = con.cursor() +cur.execute("update alembic_version set version_num='2.0.5'") +con.commit() +print("after=", cur.execute("select version_num from alembic_version").fetchall()) +con.close() diff --git a/scripts/bump_alembic_rev_to_2_0_6.py b/scripts/bump_alembic_rev_to_2_0_6.py new file mode 100644 index 0000000..0ebc14c --- /dev/null +++ b/scripts/bump_alembic_rev_to_2_0_6.py @@ -0,0 +1,8 @@ +import sqlite3 +p = "apps/data/db.sqlite3" +con = sqlite3.connect(p) +cur = con.cursor() +cur.execute("update alembic_version set version_num='2.0.6'") +con.commit() +print("after=", cur.execute("select version_num from alembic_version").fetchall()) +con.close() From 09c68df9c5d2fccb800263051c49efc2b7f1b43c Mon Sep 17 00:00:00 2001 From: Jean Date: Mon, 20 Oct 2025 21:10:35 -0300 Subject: [PATCH 16/19] feat(clabs): add ORM relations & unique (namespace_default,title) index (2.0.7) --- apps/clabs/models.py | 53 +++++++++++++++---- ...nique_index_clabs_namespace_title_2.0.7.py | 28 ++++++++++ 2 files changed, 72 insertions(+), 9 deletions(-) create mode 100644 migrations/versions/2.0.6_add_unique_index_clabs_namespace_title_2.0.7.py diff --git a/apps/clabs/models.py b/apps/clabs/models.py index 6d1cd48..0a57657 100644 --- a/apps/clabs/models.py +++ b/apps/clabs/models.py @@ -3,6 +3,14 @@ class Clab(db.Model): __tablename__ = "clabs" + __table_args__ = ( + db.Index( + "ix_clabs_namespace_title_unique", + "namespace_default", + "title", + unique=True, + ), + ) id = db.Column(db.String(36), primary_key=True) title = db.Column(db.String(255), nullable=False) @@ -19,35 +27,62 @@ class Clab(db.Model): db.DateTime, default=datetime.utcnow, onupdate=datetime.utcnow, nullable=False ) + groups = db.relationship( + "Groups", + secondary="clab_groups", + lazy="selectin", + backref=db.backref("clabs", lazy="selectin"), + ) + + categories = db.relationship( + "LabCategories", + secondary="clab_categories_association", + lazy="selectin", + backref=db.backref("clabs", lazy="selectin"), + ) + + instances = db.relationship( + "ClabInstance", + back_populates="clab", + cascade="all, delete-orphan", + lazy="selectin", + ) + def __repr__(self): return f"" class ClabInstance(db.Model): __tablename__ = "clab_instances" - # identidade / vínculo - id = db.Column(db.String(24), primary_key=True) # id curto, similar ao LabInstances + id = db.Column(db.String(24), primary_key=True) token = db.Column(db.String(64), unique=True, index=True, nullable=False) owner_user_id = db.Column(db.Integer, db.ForeignKey("users.id"), index=True, nullable=False) clab_id = db.Column(db.String(36), db.ForeignKey("clabs.id"), index=True, nullable=False) - # ciclo de vida is_deleted = db.Column(db.Boolean, default=False, nullable=False) - expiration_ts = db.Column(db.DateTime, index=True) # definido em lógica de criação + expiration_ts = db.Column(db.DateTime, index=True) finish_reason = db.Column(db.String(64)) - # recursos materializados e namespace efetivo - _clab_resources = db.Column(db.Text) # JSON/texto - namespace_effective = db.Column(db.String(128)) # opcional + _clab_resources = db.Column(db.Text) + namespace_effective = db.Column(db.String(128)) - # auditoria created_at = db.Column(db.DateTime, default=datetime.utcnow, nullable=False) updated_at = db.Column(db.DateTime, default=datetime.utcnow, onupdate=datetime.utcnow, nullable=False) + clab = db.relationship( + "Clab", + back_populates="instances", + lazy="selectin", + ) + + owner = db.relationship( + "Users", + lazy="selectin", + ) + def __repr__(self): return f"" - clab_groups = db.Table( "clab_groups", diff --git a/migrations/versions/2.0.6_add_unique_index_clabs_namespace_title_2.0.7.py b/migrations/versions/2.0.6_add_unique_index_clabs_namespace_title_2.0.7.py new file mode 100644 index 0000000..fc4bf61 --- /dev/null +++ b/migrations/versions/2.0.6_add_unique_index_clabs_namespace_title_2.0.7.py @@ -0,0 +1,28 @@ +"""add unique index on clabs(namespace_default, title) + +Revision ID: 2.0.7 +Revises: 2.0.6 +Create Date: 2025-10-21 +""" +from alembic import op +import sqlalchemy as sa + +# revision identifiers, used by Alembic. +revision = "2.0.7" +down_revision = "2.0.6" +branch_labels = None +depends_on = None + + +def upgrade(): + # Índice único composto + op.create_index( + "ix_clabs_namespace_title_unique", + "clabs", + ["namespace_default", "title"], + unique=True, + ) + + +def downgrade(): + op.drop_index("ix_clabs_namespace_title_unique", table_name="clabs") From c5d5f7b823e1d198566bed9b19f6909ad6d2bbb2 Mon Sep 17 00:00:00 2001 From: Jean Date: Mon, 20 Oct 2025 21:24:08 -0300 Subject: [PATCH 17/19] feat(clabs): migrate containerlabs to DB with serialization helpers --- apps/clabs/routes.py | 140 +++++++++++++++++++++++++++++++++++++------ 1 file changed, 121 insertions(+), 19 deletions(-) diff --git a/apps/clabs/routes.py b/apps/clabs/routes.py index af9cb5e..1897252 100644 --- a/apps/clabs/routes.py +++ b/apps/clabs/routes.py @@ -3,6 +3,12 @@ from flask_login import current_user, login_required from apps.controllers.clabernetes import C9sController import yaml +from apps import db +from apps.clabs.models import Clab, ClabInstance +from apps.authentication.models import Users +import json +import datetime as dt + from . import blueprint @@ -27,25 +33,65 @@ def _is_admin_or_teacher() -> bool: def _owner_identity() -> str: return getattr(current_user, "username", None) or getattr(current_user, "email", None) or "anonymous" +# -------- Serialization helpers (DB → UI/API) -------- +def _row_from_db(ci: ClabInstance) -> dict: + """Linha para /running e /api/list.""" + owner = getattr(ci, "owner", None) + clab = getattr(ci, "clab", None) + created = (ci.created_at or dt.datetime.utcnow()).strftime("%Y-%m-%d %H:%M:%S") + return { + "lab_instance_id": ci.id, + "user": getattr(owner, "username", None) or getattr(owner, "email", None) or "anonymous", + "title": getattr(clab, "title", None) or "Unnamed", + "created": created, + } + +def _detail_from_db(ci: ClabInstance) -> dict: + """Detalhe para /open/.""" + owner = getattr(ci, "owner", None) + clab = getattr(ci, "clab", None) + + created = (ci.created_at or dt.datetime.utcnow()).strftime("%Y-%m-%d %H:%M:%S") + try: + resources = json.loads(ci._clab_resources or "[]") + if not isinstance(resources, list): + resources = [] + except Exception: + resources = [] + + return { + "lab_instance_id": ci.id, + "user": getattr(owner, "username", None) or getattr(owner, "email", None) or "anonymous", + "title": getattr(clab, "title", None) or "Unnamed", + "created": created, + "namespace": ci.namespace_effective or getattr(clab, "namespace_default", None) or "--", + "resources": resources, + "name": getattr(clab, "title", None) or "Unnamed", + "status": "Running", + } + # ----------------- Views ----------------- @blueprint.route("/running") @login_required def running(): """List running labs. Admin/teacher sees all; users see only their labs.""" - if _is_admin_or_teacher(): - items = ctrl().list() - else: - items = ctrl().list(user=_owner_identity()) + q = ClabInstance.query.filter_by(is_deleted=False) + if not _is_admin_or_teacher(): + q = q.filter_by(owner_user_id=current_user.id) + cis = q.order_by(ClabInstance.created_at.desc()).all() + items = [_row_from_db(ci) for ci in cis] return render_template("clabs/running.html", labs=items) @blueprint.route("/open/") @login_required def open_clab(clab_id): - lab = ctrl().get(clab_id) - if not lab: + ci = ClabInstance.query.get(clab_id) + if not ci or ci.is_deleted: return render_template("pages/error.html", title="Open CLab", msg="CLab not found") - if (not _is_admin_or_teacher()) and (lab.get("user") != _owner_identity()): + if (not _is_admin_or_teacher()) and (ci.owner_user_id != current_user.id): return render_template("pages/error.html", title="Open CLab", msg="Forbidden"), 403 + + lab = _detail_from_db(ci) return render_template("clabs/open.html", lab=lab) @blueprint.route("/create", methods=["GET", "POST"]) @@ -78,6 +124,7 @@ def create(): owner = _owner_identity() + # 1) usa o controller PoC para validar YAML e montar o "detail" compatível try: detail = ctrl().create( name=name, @@ -92,6 +139,52 @@ def create(): current_app.logger.exception("Failed to create CLab") return jsonify({"ok": False, "result": "Internal error"}), 500 + # 2) persistência no DB (MVP) + clab_title = (detail.get("title") or name or "Unnamed").strip() or "Unnamed" + clab_ns = namespace or None + + # encontra ou cria o template Clab pelo par (namespace_default, title) + existing = Clab.query.filter_by(namespace_default=clab_ns, title=clab_title).first() + if existing: + clab = existing + else: + import uuid + clab = Clab( + id=str(uuid.uuid4()), + title=clab_title, + description=None, + extended_desc=None, + clab_guide_md=None, + clab_guide_html=None, + yaml_manifest=yaml_manifest or "", + namespace_default=clab_ns, + ) + db.session.add(clab) + db.session.flush() + + # cria a instância com o mesmo ID que o PoC gerou + inst_id = detail.get("lab_instance_id") + if not inst_id: + inst_id = f"clab-{int(dt.datetime.utcnow().timestamp())}" + + token = f"tok_{inst_id}" + resources = json.dumps(detail.get("resources", [])) + + ci = ClabInstance( + id=inst_id, + token=token, + owner_user_id=current_user.id, + clab_id=clab.id, + is_deleted=False, + expiration_ts=None, + finish_reason=None, + _clab_resources=resources, + namespace_effective=detail.get("namespace") or clab_ns, + ) + db.session.add(ci) + db.session.commit() + + # 3) resposta compatível com a UI (mantida) nodes_count = len(detail.get("resources", [])) return jsonify({ "ok": True, @@ -109,11 +202,13 @@ def create(): @login_required def api_list(): """Return list of labs + number of pruned items (TTL).""" - pruned = ctrl().prune() - if _is_admin_or_teacher(): - items = ctrl().list() - else: - items = ctrl().list(user=_owner_identity()) + pruned = 0 + + q = ClabInstance.query.filter_by(is_deleted=False) + if not _is_admin_or_teacher(): + q = q.filter_by(owner_user_id=current_user.id) + cis = q.order_by(ClabInstance.created_at.desc()).all() + items = [_row_from_db(ci) for ci in cis] return jsonify({"items": items, "pruned": pruned}) @blueprint.route("/api/clear", methods=["POST"]) @@ -129,14 +224,21 @@ def api_clear_all(): @login_required def api_delete(clab_id): """Delete a single lab. Owners can delete their own; admin/teacher can delete any.""" - lab = ctrl().get(clab_id) - if not lab: + ci = ClabInstance.query.get(clab_id) + if not ci or ci.is_deleted: return jsonify({"ok": False, "error": "CLab not found"}), 404 - if (not _is_admin_or_teacher()) and (lab.get("user") != _owner_identity()): + if (not _is_admin_or_teacher()) and (ci.owner_user_id != current_user.id): return jsonify({"ok": False, "error": "Forbidden"}), 403 - ok = ctrl().delete(clab_id) - if ok: - return jsonify({"ok": True}) - return jsonify({"ok": False, "error": "CLab not found"}), 404 + # tentativa de teardown no PoC (idempotente) + try: + ctrl().delete(clab_id) + except Exception: + current_app.logger.exception("PoC teardown failed (continuing)") + + ci.is_deleted = True + ci.finish_reason = ci.finish_reason or "user_deleted" if not _is_admin_or_teacher() else "admin_cleanup" + db.session.commit() + return jsonify({"ok": True}) + From d6031af88ebfc019f2bdb86017d177358a268ee3 Mon Sep 17 00:00:00 2001 From: Jean Date: Mon, 20 Oct 2025 21:49:47 -0300 Subject: [PATCH 18/19] feat(clabs): add status/extend APIs with RBAC & caps; expose expires_at in details --- apps/clabs/routes.py | 127 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 127 insertions(+) diff --git a/apps/clabs/routes.py b/apps/clabs/routes.py index 1897252..f11838c 100644 --- a/apps/clabs/routes.py +++ b/apps/clabs/routes.py @@ -59,6 +59,7 @@ def _detail_from_db(ci: ClabInstance) -> dict: except Exception: resources = [] + st = _status_from_ci(ci) return { "lab_instance_id": ci.id, "user": getattr(owner, "username", None) or getattr(owner, "email", None) or "anonymous", @@ -67,7 +68,42 @@ def _detail_from_db(ci: ClabInstance) -> dict: "namespace": ci.namespace_effective or getattr(clab, "namespace_default", None) or "--", "resources": resources, "name": getattr(clab, "title", None) or "Unnamed", + "status": st["status"], + "expires_at": st["expires_at"], + "remaining_seconds": st["remaining_seconds"] + } + +# -------- Time & Status helpers -------- +def _now_utc(): + return dt.datetime.utcnow() + +def _status_from_ci(ci: ClabInstance) -> dict: + """ + Calcula status atual da instância com base em is_deleted e expiration_ts. + Retorna dict com: status, expires_at (str ISO), remaining_seconds (int|None). + """ + if ci.is_deleted: + return {"status": "Deleted", "expires_at": None, "remaining_seconds": None} + + now = _now_utc() + exp = ci.expiration_ts + if exp is None: + # Sem expiração definida - considerar "Running" sem deadline + return {"status": "Running", "expires_at": None, "remaining_seconds": None} + + # Com data de expiração definida + if now >= exp: + return { + "status": "Expired", + "expires_at": exp.strftime("%Y-%m-%dT%H:%M:%SZ"), + "remaining_seconds": 0, + } + + remaining = int((exp - now).total_seconds()) + return { "status": "Running", + "expires_at": exp.strftime("%Y-%m-%dT%H:%M:%SZ"), + "remaining_seconds": remaining, } # ----------------- Views ----------------- @@ -242,3 +278,94 @@ def api_delete(clab_id): db.session.commit() return jsonify({"ok": True}) +@blueprint.route("/api/status/", methods=["GET"]) +@login_required +def api_status(clab_id): + """ + Retorna o status atual da instância: + { ok, status, expires_at, remaining_seconds } + Regras de acesso: owner/admin/teacher. + """ + ci = ClabInstance.query.get(clab_id) + if not ci: + return jsonify({"ok": False, "error": "CLab not found"}), 404 + + if (not _is_admin_or_teacher()) and (ci.owner_user_id != current_user.id): + return jsonify({"ok": False, "error": "Forbidden"}), 403 + + st = _status_from_ci(ci) + return jsonify({ + "ok": True, + "status": st["status"], + "expires_at": st["expires_at"], + "remaining_seconds": st["remaining_seconds"], + }) + +@blueprint.route("/api/extend/", methods=["POST"]) +@login_required +def api_extend(clab_id): + """ + Estende a expiração da instância em X horas (limites por configuração). + Body (JSON ou form): {"hours": } + """ + ci = ClabInstance.query.get(clab_id) + if not ci: + return jsonify({"ok": False, "error": "CLab not found"}), 404 + + if (not _is_admin_or_teacher()) and (ci.owner_user_id != current_user.id): + return jsonify({"ok": False, "error": "Forbidden"}), 403 + + if ci.is_deleted: + return jsonify({"ok": False, "error": "Cannot extend a deleted CLab"}), 400 + + # parâmetros e limites + cfg = current_app.config + max_per_req = int(cfg.get("CLABS_EXTEND_MAX_PER_REQUEST_HOURS", 4)) + max_total = int(cfg.get("CLABS_EXTEND_MAX_TOTAL_HOURS", 48)) + + hours_raw = (request.json or {}).get("hours") if request.is_json else request.form.get("hours") + try: + req_hours = int(hours_raw) if hours_raw is not None else max_per_req + except Exception: + return jsonify({"ok": False, "error": "Invalid 'hours'"}), 400 + + if req_hours <= 0: + return jsonify({"ok": False, "error": "Invalid 'hours'"}), 400 + + delta_hours = min(req_hours, max_per_req) + + now = _now_utc() + old_exp = ci.expiration_ts + base = old_exp if old_exp and old_exp > now else now + new_exp = base + dt.timedelta(hours=delta_hours) + + # teto absoluto: created_at + max_total + hard_cap = (ci.created_at or now) + dt.timedelta(hours=max_total) + if new_exp > hard_cap: + new_exp = hard_cap + + # se mesmo após o ajuste não houver ganho, avisa + if old_exp and new_exp <= old_exp: + st = _status_from_ci(ci) + return jsonify({ + "ok": False, + "error": "Max extension reached", + "status": st["status"], + "expires_at": st["expires_at"], + "remaining_seconds": st["remaining_seconds"], + }), 400 + + # aplica + ci.expiration_ts = new_exp + db.session.commit() + + st = _status_from_ci(ci) + return jsonify({ + "ok": True, + "old_expires_at": old_exp.strftime("%Y-%m-%dT%H:%M:%SZ") if old_exp else None, + "new_expires_at": st["expires_at"], + "status": st["status"], + "remaining_seconds": st["remaining_seconds"], + "applied_hours": delta_hours, + "max_total_hours": max_total, + }) From e6f4594d128bb31f02cb184b68a1737ab83a4d80 Mon Sep 17 00:00:00 2001 From: Jean Date: Mon, 27 Oct 2025 18:07:08 -0300 Subject: [PATCH 19/19] feat(users): persist DataTables search state and disable browser autocorrect --- apps/templates/pages/users.html | 275 +++++++++++++++++++++----------- 1 file changed, 184 insertions(+), 91 deletions(-) diff --git a/apps/templates/pages/users.html b/apps/templates/pages/users.html index 8112558..daac4aa 100644 --- a/apps/templates/pages/users.html +++ b/apps/templates/pages/users.html @@ -185,31 +185,145 @@

    Confirm Approve Users

    + -{% endblock javascripts %} +{% endblock javascripts %} \ No newline at end of file