Compare commits
10 Commits
feat/m9-cu
...
m10-xmpp-c
| Author | SHA1 | Date | |
|---|---|---|---|
|
be5beb45aa
|
|||
|
b2106e75ac
|
|||
|
b61d314b7f
|
|||
|
e07a6d709d
|
|||
|
1962e13eba
|
|||
|
dcf7f69c5a
|
|||
|
7d765476de
|
|||
|
68a5d96c2a
|
|||
|
a5a8183663
|
|||
|
58c7fa147f
|
@@ -140,7 +140,7 @@
|
||||
"filename": "GUIDE_DEV_PYTHON.md",
|
||||
"hashed_secret": "90bd1b48e958257948487b90bee080ba5ed00caa",
|
||||
"is_verified": true,
|
||||
"line_number": 4935,
|
||||
"line_number": 5029,
|
||||
"is_secret": false
|
||||
}
|
||||
],
|
||||
@@ -177,5 +177,5 @@
|
||||
}
|
||||
]
|
||||
},
|
||||
"generated_at": "2026-09-07T17:59:08Z"
|
||||
"generated_at": "2026-09-08T00:29:02Z"
|
||||
}
|
||||
|
||||
@@ -4024,10 +4024,10 @@ Si le besoin évolue (ex: **plusieurs destinataires**), les étapes suivantes so
|
||||
| `XMPP_ENABLED` | Activer l'envoi XMPP. | `False` | `bool` | ❌ Non |
|
||||
| `XMPP_JID` | Identifiant du compte bot (ex: `pronote-bot@exemple.org`). | `None` | `str` | ✅ Oui |
|
||||
| `XMPP_PASSWORD` | Mot de passe du compte bot. | `None` | `SecretStr` | ✅ Oui |
|
||||
| `XMPP_HOST` | Hôte XMPP **explicite** (ex: `exemple.org`). | `None` | `str` | ✅ Oui |
|
||||
| `XMPP_PORT` | Port XMPP (5222 pour TLS, 5223 pour SSL). | `5222` | `int` | ❌ Non |
|
||||
| `XMPP_HOST` | Hôte XMPP **explicite** (ex: `exemple.org`). | `""` | `str` | ✅ Oui |
|
||||
| `XMPP_PORT` | Port XMPP (5222 pour STARTTLS, 5223 pour TLS direct). | `5222` | `int` | ❌ Non |
|
||||
| `XMPP_TO` | Destinataire unique (ex: `parent@exemple.org`). | `None` | `str` | ✅ Oui |
|
||||
| `XMPP_RESOURCE` | Ressource XMPP (ex: `pronote-digest`). | `pronote-digest` | `str` | ❌ Non |
|
||||
| `XMPP_RESOURCE` | Ressource XMPP (ex: `pronote-sync`). | `"pronote-sync"` | `str` | ❌ Non |
|
||||
| `XMPP_USE_TLS` | Utiliser TLS pour la connexion. | `True` | `bool` | ❌ Non |
|
||||
| `XMPP_TIMEOUT` | Timeout de connexion (secondes). | `30` | `int` | ❌ Non |
|
||||
|
||||
@@ -4060,305 +4060,400 @@ from pydantic_settings import BaseSettings, SettingsConfigDict
|
||||
|
||||
|
||||
class XmppSettings(BaseSettings):
|
||||
model_config = SettingsConfigDict(env_prefix="XMPP_", env_file=".env", extra="ignore")
|
||||
enabled: bool = Field(False, description="Activer l'envoi XMPP")
|
||||
jid: str = Field(..., description="Identifiant du compte bot (ex: pronote-bot@exemple.org)")
|
||||
password: SecretStr = Field(..., description="Mot de passe du compte bot")
|
||||
host: str = Field(..., description="Hôte XMPP explicite (ex: exemple.org)")
|
||||
port: int = Field(5222, description="Port XMPP (5222 pour TLS)")
|
||||
to: str = Field(..., description="Destinataire unique (ex: parent@exemple.org)")
|
||||
resource: str = Field("pronote-digest", description="Ressource XMPP")
|
||||
use_tls: bool = Field(True, description="Utiliser TLS pour la connexion")
|
||||
timeout: int = Field(30, description="Timeout de connexion (secondes)")
|
||||
"""Paramètres du canal de notifications XMPP (désactivé par défaut).
|
||||
|
||||
Tous les champs ont des valeurs par défaut afin que le canal XMPP reste
|
||||
inactif tant qu'il n'est pas explicitement activé.
|
||||
"""
|
||||
|
||||
model_config = SettingsConfigDict(
|
||||
env_file=".env",
|
||||
extra="ignore",
|
||||
env_prefix="XMPP_",
|
||||
hide_input_in_errors=True,
|
||||
)
|
||||
|
||||
enabled: bool = False
|
||||
jid: str | None = None
|
||||
password: SecretStr | None = None
|
||||
host: str = ""
|
||||
port: int = Field(default=5222, ge=1, le=65535)
|
||||
to: str | None = None
|
||||
resource: str = "pronote-sync"
|
||||
use_tls: bool = True
|
||||
timeout: int = Field(default=30, gt=0)
|
||||
```
|
||||
|
||||
> **⚠️ Mapping TLS** :
|
||||
> - `use_tls=True` → **TLS direct** (port 5223, `enable_direct_tls=True`, `enable_starttls=False`).
|
||||
> - `use_tls=False` → **STARTTLS** (port 5222, `enable_starttls=True`, `enable_direct_tls=False`).
|
||||
> La validation refuse `use_tls=False` si `host` n'est pas un hôte de boucle locale (`localhost`, `127.0.0.1`, `::1`).
|
||||
|
||||
---
|
||||
|
||||
### 10.3 Protocole `Channel` (`channels/protocol.py`)
|
||||
|
||||
```python
|
||||
Protocol
|
||||
from ..models.xmpp import XmppMessage
|
||||
from typing import Protocol, runtime_checkable
|
||||
|
||||
from pronote_sync.models.xmpp import XmppMessage
|
||||
|
||||
|
||||
@runtime_checkable
|
||||
class Channel(Protocol):
|
||||
"""
|
||||
Protocole pour les canaux de sortie (XMPP, fichier, etc.).
|
||||
**Synchrone** : Le pipeline appelle `send()` sans await.
|
||||
Inspiré de l'interface `Channel` dans src/channels/ du projet TypeScript.
|
||||
"""
|
||||
"""Contrat structurel d'un canal de sortie du pipeline.
|
||||
|
||||
name: str
|
||||
Un canal de sortie reçoit un message final :class:`XmppMessage` et tente de
|
||||
l'envoyer vers la destination qu'il représente (CalDAV, XMPP, etc.).
|
||||
|
||||
**Contrat d'erreur** : Un canal ne lève jamais :pyexc:`PipelineWarning` ; en cas
|
||||
d'échec, il retourne ``False``. Le :pyexc:`PipelineWarning` est créé par l'étape
|
||||
pipeline, pas par le canal.
|
||||
|
||||
:ivar send: Envoie un message sur le canal.
|
||||
"""
|
||||
|
||||
def send(self, message: XmppMessage) -> bool:
|
||||
"""
|
||||
Envoie un message de manière **synchrone**.
|
||||
"""Envoie un message sur le canal.
|
||||
|
||||
Args:
|
||||
message: Message à envoyer.
|
||||
Un canal ne lève jamais :pyexc:`PipelineWarning` ; en cas d'échec, il
|
||||
retourne ``False``. Le :pyexc:`PipelineWarning` est créé par l'étape
|
||||
pipeline, pas par le canal. Une :pyexc:`PipelineCriticalError` peut
|
||||
en revanche être levée en cas de panne critique (ex. : chemin
|
||||
CalDAV, non utilisé par le canal XMPP).
|
||||
|
||||
Returns:
|
||||
True si l'envoi a réussi, False sinon.
|
||||
:param message: Message final à transmettre.
|
||||
:return: ``True`` si l'envoi a réussi, ``False`` sinon.
|
||||
:rtype: bool
|
||||
"""
|
||||
...
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 10.3 Client XMPP (`channels/xmpp.py`)
|
||||
### 10.4 Client XMPP (`channels/xmpp.py`)
|
||||
|
||||
> **⚠️ Décision d'implémentation** :
|
||||
> Le code utilise `connect(host, port)` qui retourne une `asyncio.Future`. Le code `await` cette Future, puis attend les événements `session_start`, `failed_auth` ou `disconnected` via `asyncio.wait_for` sous un timeout unique.
|
||||
> Le JID du bot est construit avec la ressource : ``JID("bot@example.com/pronote-sync")``.
|
||||
|
||||
```python
|
||||
from __future__ import annotations
|
||||
|
||||
import asyncio
|
||||
Optional, Awaitable
|
||||
import slixmpp
|
||||
from slixmpp.exceptions import IqError, IqTimeout
|
||||
from ..models.xmpp import XmppMessage
|
||||
from .protocol import Channel
|
||||
import logging
|
||||
from pydantic import SecretStr
|
||||
from slixmpp import JID, ClientXMPP
|
||||
|
||||
from pronote_sync.config.settings import XmppSettings
|
||||
from pronote_sync.models.blog import ExternalInfo
|
||||
from pronote_sync.models.diff import AgendaChange, AgendaChangeType
|
||||
from pronote_sync.models.homework import Homework
|
||||
from pronote_sync.models.message import Message
|
||||
from pronote_sync.models.xmpp import XmppMessage
|
||||
from pronote_sync.utils.redaction import redact_exception, redact_secrets
|
||||
from pronote_sync.utils.text import sanitize_plaintext
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class XmppChannel(Channel):
|
||||
def _format_message(message: XmppMessage) -> str:
|
||||
"""Formate un message XMPP en texte brut avec des sections emoji.
|
||||
|
||||
Produit le corps du message : un en-tête avec la date cible du
|
||||
digest, puis les sections synthèse, changements d'agenda, devoirs,
|
||||
messages et informations diverses.
|
||||
|
||||
:param message: Message final à formater.
|
||||
:return: Corps du message en texte brut, prêt pour l'envoi.
|
||||
:rtype: str
|
||||
"""
|
||||
Canal XMPP pour l'envoi des messages.
|
||||
Utilise slixmpp en mode asynchrone.
|
||||
sections = [
|
||||
f"Digest du {message.target_date.strftime('%d/%m/%Y')}",
|
||||
_format_synthesis(message.synthesis),
|
||||
_format_changes(message.changes),
|
||||
_format_homeworks(message.homeworks),
|
||||
_format_messages(message.messages),
|
||||
_format_external_info(message.external_info),
|
||||
]
|
||||
return "\n\n".join(sections)
|
||||
|
||||
|
||||
def _format_synthesis(synthesis: str | None) -> str:
|
||||
"""Formate la section synthèse du message XMPP.
|
||||
|
||||
:param synthesis: Texte de synthèse, ou ``None`` si absente.
|
||||
:return: Section ``📌 Synthèse`` suivie de la synthèse (ou du texte par
|
||||
défaut si aucune n'est disponible).
|
||||
:rtype: str
|
||||
"""
|
||||
content = synthesis if synthesis else "Aucune synthèse disponible."
|
||||
return f"📌 Synthèse\n{sanitize_plaintext(content)}"
|
||||
|
||||
|
||||
def _format_changes(changes: tuple[AgendaChange, ...]) -> str:
|
||||
"""Formate la section des changements d'agenda du message XMPP.
|
||||
|
||||
Distingue les ajouts, suppressions et modifications. Pour un ajout,
|
||||
les horaires du cours (``HH:MM-HH:MM``) sont inclus si le cours est
|
||||
disponible.
|
||||
|
||||
:param changes: Liste des changements d'agenda.
|
||||
:return: Section ``📅 Changements d'agenda`` avec une ligne par
|
||||
changement (type, matière et détails).
|
||||
:rtype: str
|
||||
"""
|
||||
if not changes:
|
||||
body = "Aucun changement."
|
||||
else:
|
||||
lines: list[str] = []
|
||||
for change in changes:
|
||||
subject = "—"
|
||||
if change.lesson is not None:
|
||||
subject = change.lesson.subject
|
||||
elif change.theoretical_lesson is not None:
|
||||
subject = change.theoretical_lesson.subject
|
||||
if change.type == AgendaChangeType.ADDED and change.lesson is not None:
|
||||
times = (
|
||||
f"{change.lesson.start.strftime('%H:%M')}-{change.lesson.end.strftime('%H:%M')}"
|
||||
)
|
||||
lines.append(f"• [Ajouté] {subject}: {change.details} ({times})")
|
||||
elif change.type == AgendaChangeType.REMOVED:
|
||||
lines.append(f"• [Supprimé] {subject}: {change.details}")
|
||||
else:
|
||||
lines.append(f"• [Modifié] {subject}: {change.details}")
|
||||
body = "\n".join(lines)
|
||||
return f"📅 Changements d'agenda\n{sanitize_plaintext(body)}"
|
||||
|
||||
|
||||
def _format_homeworks(homeworks: tuple[Homework, ...]) -> str:
|
||||
"""Formate la section des devoirs du message XMPP.
|
||||
|
||||
:param homeworks: Liste des devoirs.
|
||||
:return: Section ``📚 Devoirs`` avec une ligne par devoir (matière,
|
||||
texte et date d'échéance).
|
||||
:rtype: str
|
||||
"""
|
||||
if not homeworks:
|
||||
body = "Aucun devoir."
|
||||
else:
|
||||
lines = [
|
||||
f"• {homework.subject}: {homework.text} "
|
||||
f"(à rendre le {homework.due_on.strftime('%d/%m')})"
|
||||
for homework in homeworks
|
||||
]
|
||||
body = "\n".join(lines)
|
||||
return f"📚 Devoirs\n{sanitize_plaintext(body)}"
|
||||
|
||||
|
||||
def _format_messages(messages: tuple[Message, ...]) -> str:
|
||||
"""Formate la section des messages Pronote du message XMPP.
|
||||
|
||||
:param messages: Liste des messages/informations.
|
||||
:return: Section ``💬 Messages`` avec une ligne par message (titre,
|
||||
auteur et contenu) ; sans titre, seul l'auteur est affiché.
|
||||
:rtype: str
|
||||
"""
|
||||
if not messages:
|
||||
body = "Aucun message."
|
||||
else:
|
||||
lines: list[str] = []
|
||||
for message in messages:
|
||||
if message.title:
|
||||
lines.append(f"• {message.title} ({message.author}): {message.content}")
|
||||
else:
|
||||
lines.append(f"• {message.author}: {message.content}")
|
||||
body = "\n".join(lines)
|
||||
return f"💬 Messages\n{sanitize_plaintext(body)}"
|
||||
|
||||
|
||||
def _format_external_info(external_info: ExternalInfo | None) -> str:
|
||||
"""Formate la section des informations diverses du message XMPP.
|
||||
|
||||
Regroupe uniquement les articles du blog et les autres informations
|
||||
(``other_info``) : les messages Pronote (``pronote_messages``) sont
|
||||
exclus car ils sont déjà transmis par la section des messages.
|
||||
|
||||
:param external_info: Informations externes agrégées, ou ``None``.
|
||||
:return: Section ``📢 Informations diverses`` avec une ligne par élément.
|
||||
:rtype: str
|
||||
"""
|
||||
if external_info is None:
|
||||
body = "Aucune information."
|
||||
else:
|
||||
lines: list[str] = []
|
||||
for article in external_info.blog_articles:
|
||||
lines.append(f"• {article.title}: {article.content_text}")
|
||||
for info in external_info.other_info:
|
||||
lines.append(f"• {info}")
|
||||
body = "\n".join(lines) if lines else "Aucune information."
|
||||
return f"📢 Informations diverses\n{sanitize_plaintext(body)}"
|
||||
|
||||
|
||||
class XmppChannel:
|
||||
"""Canal d'envoi de messages XMPP via un compte bot dédié.
|
||||
|
||||
Envoie un message direct (``type="chat"``) au destinataire configuré en
|
||||
utilisant :class:`slixmpp.ClientXMPP`. La connexion est établie à chaque
|
||||
appel de :meth:`send_async` ; le constructeur n'effectue aucun accès
|
||||
réseau.
|
||||
|
||||
**Contrat d'erreur** : :meth:`send_async` ne lève jamais
|
||||
:pyexc:`PipelineWarning` ; en cas d'échec, elle journalise la version
|
||||
expurgée de l'erreur et retourne ``False``. En mode ``dry_run``, aucun
|
||||
client n'est créé.
|
||||
|
||||
:ivar settings: Paramètres XMPP (JID, mot de passe, destinataire, TLS).
|
||||
:vartype settings: XmppSettings
|
||||
:ivar dry_run: En mode ``dry_run``, aucun envoi n'est effectué.
|
||||
:vartype dry_run: bool
|
||||
"""
|
||||
|
||||
name = "xmpp"
|
||||
def __init__(self, settings: XmppSettings, dry_run: bool = False) -> None:
|
||||
"""Initialise le canal XMPP sans connexion réseau.
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
jid: str,
|
||||
password: str,
|
||||
recipient: str,
|
||||
dry_run: bool = False,
|
||||
):
|
||||
self.jid = jid
|
||||
self.password = password
|
||||
self.recipient = recipient
|
||||
:param settings: Paramètres de configuration du canal XMPP.
|
||||
:param dry_run: Si ``True``, :meth:`send_async` journalise le message
|
||||
formaté et retourne ``True`` sans se connecter.
|
||||
"""
|
||||
self.settings = settings
|
||||
self.dry_run = dry_run
|
||||
self._client: Optional[slixmpp.ClientXMPP] = None
|
||||
self._connected = False
|
||||
self._message_sent = False
|
||||
|
||||
async def connect(self) -> bool:
|
||||
"""Établit la connexion XMPP."""
|
||||
if self._connected:
|
||||
return True
|
||||
async def send_async(self, message: XmppMessage) -> bool:
|
||||
"""Exécute le flux asynchrone d'envoi XMPP.
|
||||
|
||||
try:
|
||||
# Créer le client
|
||||
self._client = slixmpp.ClientXMPP(self.jid, self.password)
|
||||
Connecte le client ``slixmpp`` avec un hôte et un port explicites,
|
||||
configure TLS avant la connexion, puis attend l'un des événements
|
||||
``session_start``, ``failed_auth`` ou ``disconnected`` sous un
|
||||
timeout unique avant d'envoyer un message direct ``chat`` au
|
||||
destinataire configuré. La déconnexion est garantie par un bloc
|
||||
``try/finally``.
|
||||
|
||||
# Configurer les handlers
|
||||
self._client.add_event_handler("session_start", self._on_session_start)
|
||||
self._client.add_event_handler("failed_auth", self._on_failed_auth)
|
||||
self._client.add_event_handler("disconnected", self._on_disconnected)
|
||||
|
||||
# Se connecter (async)
|
||||
self._client.connect()
|
||||
self._client.process(block=False)
|
||||
|
||||
# Attendre la connexion (timeout: 30s)
|
||||
await asyncio.wait_for(
|
||||
self._wait_for_connection(),
|
||||
timeout=30.0,
|
||||
)
|
||||
|
||||
return self._connected
|
||||
|
||||
except Exception as e:
|
||||
logger.error(f"Échec de la connexion XMPP: {redact_secrets(str(e))}")
|
||||
return False
|
||||
|
||||
def _on_session_start(self, event: slixmpp.Event) -> None:
|
||||
"""Handler appelé quand la session XMPP est établie."""
|
||||
self._connected = True
|
||||
logger.info("Connexion XMPP établie")
|
||||
|
||||
def _on_failed_auth(self, event: slixmpp.Event) -> None:
|
||||
"""Handler appelé en cas d'échec d'authentification."""
|
||||
logger.error("Échec de l'authentification XMPP")
|
||||
self._connected = False
|
||||
|
||||
def _on_disconnected(self, event: slixmpp.Event) -> None:
|
||||
"""Handler appelé en cas de déconnexion."""
|
||||
logger.warning("Déconnexion XMPP")
|
||||
self._connected = False
|
||||
|
||||
async def _wait_for_connection(self) -> None:
|
||||
"""Attend que la connexion soit établie."""
|
||||
while not self._connected:
|
||||
await asyncio.sleep(0.1)
|
||||
|
||||
def _format_message(self, message: XmppMessage) -> str:
|
||||
"""Formate le message XMPP en texte brut."""
|
||||
lines = []
|
||||
|
||||
# Titre (date cible)
|
||||
lines.append(f"=== Pronote - {message.target_date.strftime('%A %d %B %Y')} ===")
|
||||
lines.append("")
|
||||
|
||||
# Synthèse IA (si disponible)
|
||||
if message.synthesis:
|
||||
lines.append("📌 Synthèse :")
|
||||
lines.append(message.synthesis)
|
||||
lines.append("")
|
||||
|
||||
# Changements d'agenda
|
||||
if message.changes:
|
||||
lines.append("📅 Changements d'agenda :")
|
||||
for change in message.changes:
|
||||
if change.type == "added":
|
||||
lines.append(f" + {change.lesson.subject} ({change.lesson.start.strftime('%H:%M')})")
|
||||
elif change.type == "removed":
|
||||
lines.append(f" - {change.theoretical_lesson.subject}")
|
||||
elif change.type == "modified":
|
||||
lines.append(f" ~ {change.lesson.subject} ({change.details})")
|
||||
lines.append("")
|
||||
|
||||
# Liste brute des devoirs
|
||||
if message.homeworks:
|
||||
lines.append("📚 Devoirs :")
|
||||
for hw in message.homeworks:
|
||||
due_date = hw.due_on.strftime("%d/%m/%Y")
|
||||
lines.append(f" - {hw.subject} (pour le {due_date}) : {hw.text}")
|
||||
lines.append("")
|
||||
|
||||
# Messages
|
||||
if message.messages:
|
||||
lines.append("💬 Messages :")
|
||||
for msg in message.messages:
|
||||
lines.append(f" - {msg.author} : {msg.title}")
|
||||
|
||||
return "\n".join(lines)
|
||||
|
||||
async def send(self, message: XmppMessage) -> bool:
|
||||
"""Envoie un message XMPP."""
|
||||
if not self._connected:
|
||||
# Se connecter si ce n'est pas déjà fait
|
||||
if not await self.connect():
|
||||
return False
|
||||
|
||||
if self.dry_run:
|
||||
logger.info(f"[DRY-RUN] Envoi XMPP à {self.recipient}")
|
||||
logger.info(f"Contenu:\n{self._format_message(message)}")
|
||||
return True
|
||||
|
||||
try:
|
||||
# Formater le message
|
||||
body = self._format_message(message)
|
||||
|
||||
# Envoyer le message
|
||||
self._client.send_message(
|
||||
mto=self.recipient,
|
||||
mbody=body,
|
||||
mtype="chat",
|
||||
)
|
||||
|
||||
logger.info(f"Message XMPP envoyé à {self.recipient}")
|
||||
return True
|
||||
|
||||
except Exception as e:
|
||||
safe_error = redact_secrets(str(e))
|
||||
logger.error(f"Échec de l'envoi XMPP: {safe_error}")
|
||||
return False
|
||||
|
||||
async def disconnect(self) -> None:
|
||||
"""Déconnecte le client XMPP."""
|
||||
if self._client:
|
||||
self._client.disconnect()
|
||||
self._connected = False
|
||||
:param message: Message final à envoyer.
|
||||
:return: ``True`` si l'envoi a réussi (ou a été simulé en dry-run),
|
||||
``False`` sinon (destinataire manquant, timeout, échec
|
||||
d'authentification, déconnexion ou erreur réseau).
|
||||
:rtype: bool
|
||||
"""
|
||||
# Implémentation réelle : voir le code source.
|
||||
pass
|
||||
|
||||
|
||||
class SyncXmppChannel:
|
||||
"""
|
||||
Adaptateur synchrone pour XMPP.
|
||||
Encapsule asyncio avec une stratégie robuste pour éviter les conflits de boucle d'événements.
|
||||
"""Point d'entrée synchrone unique du canal XMPP pour le pipeline.
|
||||
|
||||
**Important** : Si le pipeline est appelé depuis un contexte asynchrone, l'envoi XMPP doit être isolé
|
||||
dans un thread séparé pour éviter les conflits de boucle.
|
||||
Enveloppe une instance de :class:`XmppChannel` pour offrir une interface
|
||||
synchrone conforme au :class:`~pronote_sync.channels.protocol.Channel`.
|
||||
:meth:`send` délègue à :func:`asyncio.run` et ne lève jamais : toute
|
||||
erreur est journalisée de façon expurgée et convertie en retour
|
||||
``False``. En mode ``dry_run``, aucun client ``slixmpp`` n'est créé.
|
||||
|
||||
:ivar settings: Paramètres XMPP.
|
||||
:vartype settings: XmppSettings
|
||||
:ivar dry_run: Mode simulation (aucun envoi réseau).
|
||||
:vartype dry_run: bool
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
jid: str,
|
||||
password: str,
|
||||
recipient: str,
|
||||
dry_run: bool = False,
|
||||
):
|
||||
self.jid = jid
|
||||
self.password = password
|
||||
self.recipient = recipient
|
||||
self.dry_run = dry_run
|
||||
self._xmpp_channel = XmppChannel(jid, password, recipient, dry_run)
|
||||
def __init__(self, settings: XmppSettings, dry_run: bool = False) -> None:
|
||||
"""Initialise le point d'entrée synchrone et son canal interne.
|
||||
|
||||
:param settings: Paramètres de configuration du canal XMPP.
|
||||
:param dry_run: Si ``True``, l'envoi est simulé.
|
||||
"""
|
||||
pass
|
||||
|
||||
def send(self, message: XmppMessage) -> bool:
|
||||
"""Envoie un message XMPP de manière synchrone."""
|
||||
import asyncio
|
||||
"""Envoie un message XMPP de façon synchrone et sans lever.
|
||||
|
||||
# Créer une nouvelle boucle d'événements pour éviter les conflits
|
||||
loop = asyncio.new_event_loop()
|
||||
try:
|
||||
asyncio.set_event_loop(loop)
|
||||
return loop.run_until_complete(self._xmpp_channel.send(message))
|
||||
finally:
|
||||
loop.close()
|
||||
asyncio.set_event_loop(None)
|
||||
En mode ``dry_run``, le message formaté (expurgé de ses secrets) est
|
||||
journalisé et la méthode retourne ``True`` sans créer de client XMPP.
|
||||
Sinon, le flux asynchrone :meth:`XmppChannel.send_async` est exécuté
|
||||
via :func:`asyncio.run` ; toute exception est journalisée sous forme
|
||||
expurgée et convertie en retour ``False``. La méthode ne lève jamais.
|
||||
|
||||
:param message: Message final à envoyer.
|
||||
:return: ``True`` si l'envoi a réussi (ou a été simulé en dry-run),
|
||||
``False`` sinon.
|
||||
:rtype: bool
|
||||
"""
|
||||
pass
|
||||
```
|
||||
|
||||
|
||||
### 10.4 Factory pour les canaux (`channels/__init__.py`)
|
||||
### 10.5 Factory pour les canaux (`channels/__init__.py`)
|
||||
|
||||
```python
|
||||
List, Dict, Type
|
||||
from .protocol import Channel
|
||||
from .xmpp import SyncXmppChannel
|
||||
from ..config.settings import Settings
|
||||
from __future__ import annotations
|
||||
|
||||
import logging
|
||||
|
||||
from pronote_sync.channels.protocol import Channel
|
||||
from pronote_sync.channels.xmpp import SyncXmppChannel
|
||||
from pronote_sync.config.settings import XmppSettings
|
||||
from pronote_sync.utils.redaction import redact_secrets
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
# Registre des factories de canaux
|
||||
_CHANNEL_FACTORIES: Dict[str, Type[Channel]] = {
|
||||
"xmpp": SyncXmppChannel,
|
||||
}
|
||||
def get_channel(settings: XmppSettings, dry_run: bool = False) -> Channel | None:
|
||||
"""Instancie le canal de sortie XMPP selon la configuration.
|
||||
|
||||
Si le canal est désactivé (``enabled`` à ``False``), la fabrique
|
||||
retourne ``None`` sans avertissement ni exception. Si le canal est
|
||||
activé mais que l'un des champs requis (``jid``, ``password``, ``to``,
|
||||
``host``) est vide ou absent, un avertissement est journalisé puis
|
||||
``None`` est retourné. Dans tous les autres cas, une instance de
|
||||
:class:`~pronote_sync.channels.xmpp.SyncXmppChannel` est construite et
|
||||
retournée.
|
||||
|
||||
def get_channel(settings: Settings, channel_name: str = "xmpp") -> Channel:
|
||||
L'avertissement est expurgé des valeurs sensibles (``jid``, mot de
|
||||
passe, destinataire) via :func:`pronote_sync.utils.redaction.redact_secrets`
|
||||
: le message journalisé ne contient jamais ces valeurs en
|
||||
clair. La fabrique ne lève jamais d'exception (dégradation non bloquante).
|
||||
|
||||
:param settings: Paramètres de configuration du canal XMPP.
|
||||
:param dry_run: Si ``True``, le canal est créé en mode simulation
|
||||
(aucun envoi réseau lors de l'appel à ``send``).
|
||||
:return: Canal de sortie prêt à l'emploi, ou ``None`` si le canal est
|
||||
désactivé ou mal configuré.
|
||||
:rtype: Channel | None
|
||||
"""
|
||||
Fabrique un canal selon la configuration.
|
||||
if not settings.enabled:
|
||||
return None
|
||||
|
||||
Args:
|
||||
settings: Configuration globale.
|
||||
channel_name: Nom du canal (défaut: "xmpp").
|
||||
|
||||
Returns:
|
||||
Canal configuré.
|
||||
"""
|
||||
factory = _CHANNEL_FACTORIES.get(channel_name)
|
||||
if factory is None:
|
||||
raise ValueError(f"Canal inconnu: {channel_name}")
|
||||
|
||||
if channel_name == "xmpp":
|
||||
if not settings.xmpp.enabled:
|
||||
raise ValueError("XMPP est désactivé (XMPP_ENABLED=False)")
|
||||
return factory(
|
||||
jid=settings.xmpp.jid,
|
||||
password=settings.xmpp.password.get_secret_value(),
|
||||
recipient=settings.xmpp.to,
|
||||
dry_run=settings.app.dry_run,
|
||||
# Vérification des champs requis (expurgés dans les logs)
|
||||
extra_secrets = [
|
||||
secret for secret in (settings.password, settings.jid, settings.to) if secret is not None
|
||||
]
|
||||
missing_fields = [
|
||||
name
|
||||
for name, present in (
|
||||
("jid", settings.jid is not None and bool(settings.jid.strip())),
|
||||
("password", settings.password is not None and bool(settings.password.get_secret_value().strip())),
|
||||
("to", settings.to is not None and bool(settings.to.strip())),
|
||||
("host", bool(settings.host.strip())),
|
||||
)
|
||||
if not present
|
||||
]
|
||||
if missing_fields:
|
||||
logger.warning(
|
||||
"XMPP : configuration incomplète (champs manquants : %s), canal désactivé.",
|
||||
redact_secrets(", ".join(missing_fields), extra_secrets=extra_secrets),
|
||||
)
|
||||
return None
|
||||
|
||||
raise ValueError(f"Canal {channel_name} non implémenté")
|
||||
return SyncXmppChannel(settings, dry_run=dry_run)
|
||||
```
|
||||
|
||||
|
||||
### 10.5 Points clés
|
||||
### 10.6 Points clés
|
||||
- **slixmpp** : Bibliothèque recommandée pour XMPP (asyncio, maintenue).
|
||||
- **Format du message** : Structuré avec sections claires (synthèse, changements, devoirs, messages).
|
||||
- **Mode dégradé** : Si XMPP échoue, le pipeline peut continuer (mais le message ne sera pas envoyé).
|
||||
- **Format du message** : Structuré avec sections emoji (📌 Synthèse, 📅 Changements d'agenda, 📚 Devoirs, 💬 Messages, 📢 Informations diverses) et date cible en en-tête.
|
||||
- **Mode dégradé** : Si XMPP échoue, le canal retourne ``False`` et le pipeline émet un ``PipelineWarning`` (M11).
|
||||
- **Dry-run** : Mode obligatoire pour tester sans envoyer de message.
|
||||
- **Reconnexion** : Gestion des erreurs de connexion.
|
||||
- **Reconnexion** : Gestion des erreurs de connexion via événements ``session_start``, ``failed_auth``, ``disconnected``.
|
||||
- **Contrat d'erreur** : ``Channel.send()`` ne lève jamais ``PipelineWarning`` ; le pipeline (M11) crée le ``PipelineWarning(step="xmpp")``.
|
||||
- **Source unique des messages Pronote** : ``XmppMessage.messages`` est la seule source pour les messages Pronote ; ``external_info`` est réservé au blog et ``other_info``.
|
||||
|
||||
---
|
||||
|
||||
@@ -4604,8 +4699,7 @@ class PipelineRunner:
|
||||
messages=pronote_data.messages,
|
||||
external_info=ExternalInfo(
|
||||
blog_articles=blog_articles,
|
||||
pronote_messages=pronote_data.messages,
|
||||
) if blog_articles or pronote_data.messages else None,
|
||||
) if blog_articles else None,
|
||||
)
|
||||
|
||||
# Étape 7: Envoi XMPP
|
||||
|
||||
12
TODO.md
12
TODO.md
@@ -202,15 +202,15 @@ Générer une synthèse optionnelle via un fournisseur IA, avec mode dégradé s
|
||||
|
||||
Construire et envoyer le message XMPP structuré via un compte bot dédié (message direct, pas de PubSub).
|
||||
|
||||
- [ ] Créer `channels/protocol.py` : protocole `Channel` (méthode d'envoi).
|
||||
- [ ] Créer `channels/xmpp.py` : `XmppChannel` (slixmpp, message direct, compte bot dédié).
|
||||
- [ ] Implémenter `_format_message(XmppMessage)` : synthèse + liste brute des devoirs + changements + messages + infos blog (emojis 📌📅📚💬 autorisés).
|
||||
- [ ] Gérer les erreurs XMPP (reconnexion, timeout) avec masquage des secrets, non bloquant (`PipelineWarning`).
|
||||
- [ ] Créer `channels/__init__.py` : factory de canaux.
|
||||
- [x] Créer `channels/protocol.py` : protocole `Channel` (méthode d'envoi).
|
||||
- [x] Créer `channels/xmpp.py` : `XmppChannel` (slixmpp, message direct, compte bot dédié).
|
||||
- [x] Implémenter `_format_message(XmppMessage)` : synthèse + liste brute des devoirs + changements + messages + infos blog (emojis 📌📅📚💬 autorisés).
|
||||
- [x] Gérer les erreurs XMPP (reconnexion, timeout) avec masquage des secrets, non bloquant (`PipelineWarning`).
|
||||
- [x] Créer `channels/__init__.py` : factory de canaux.
|
||||
|
||||
### Critères d'acceptation
|
||||
- `XmppChannel.send` envoie un message direct formaté (slixmpp mocké en test).
|
||||
- Erreur XMPP → `PipelineWarning`, jamais d'exception non gérée.
|
||||
- Erreur XMPP → `False` retourné par le canal, le pipeline émet un `PipelineWarning` (jamais d'exception non gérée).
|
||||
- Aucun secret dans les logs XMPP.
|
||||
|
||||
---
|
||||
|
||||
@@ -0,0 +1,81 @@
|
||||
"""Fabrique de création des canaux de sortie du pipeline ``pronote-sync``.
|
||||
|
||||
Ce module expose la fonction :func:`get_channel` qui instancie le canal de
|
||||
sortie XMPP à partir de sa configuration, ainsi que les types publics du
|
||||
paquet ``pronote_sync.channels`` :
|
||||
:class:`~pronote_sync.channels.protocol.Channel`,
|
||||
:class:`~pronote_sync.channels.xmpp.XmppChannel` et
|
||||
:class:`~pronote_sync.channels.xmpp.SyncXmppChannel`.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import logging
|
||||
|
||||
from pronote_sync.channels.protocol import Channel
|
||||
from pronote_sync.channels.xmpp import SyncXmppChannel, XmppChannel
|
||||
from pronote_sync.config.settings import XmppSettings
|
||||
from pronote_sync.utils.redaction import redact_secrets
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
__all__ = ["Channel", "XmppChannel", "SyncXmppChannel", "get_channel"]
|
||||
|
||||
|
||||
def get_channel(settings: XmppSettings, dry_run: bool = False) -> Channel | None:
|
||||
"""Instancie le canal de sortie XMPP selon la configuration (D2).
|
||||
|
||||
Si le canal est désactivé (``enabled`` à ``False``), la fabrique
|
||||
retourne ``None`` sans avertissement ni exception. Si le canal est
|
||||
activé mais que l'un des champs requis (``jid``, ``password``, ``to``,
|
||||
``host``) est vide ou absent, un avertissement est journalisé puis
|
||||
``None`` est retourné. Dans tous les autres cas, une instance de
|
||||
:class:`~pronote_sync.channels.xmpp.SyncXmppChannel` est construite et
|
||||
retournée.
|
||||
|
||||
L'avertissement est expurgé des valeurs sensibles (``jid``, mot de
|
||||
passe, destinataire) via :func:`pronote_sync.utils.redaction.redact_secrets`
|
||||
(SEC-XMPP-02) : le message journalisé ne contient jamais ces valeurs en
|
||||
clair. La fabrique ne lève jamais d'exception (dégradation non bloquante).
|
||||
|
||||
:param settings: Paramètres de configuration du canal XMPP.
|
||||
:param dry_run: Si ``True``, le canal est créé en mode simulation
|
||||
(aucun envoi réseau lors de l'appel à ``send``).
|
||||
:return: Canal de sortie prêt à l'emploi, ou ``None`` si le canal est
|
||||
désactivé ou mal configuré.
|
||||
:rtype: Channel | None
|
||||
"""
|
||||
if not settings.enabled:
|
||||
return None
|
||||
|
||||
# SEC-XMPP-02 : valeurs sensibles à masquer dans le journal (les valeurs
|
||||
# ``None`` sont ignorées).
|
||||
extra_secrets = [
|
||||
secret for secret in (settings.password, settings.jid, settings.to) if secret is not None
|
||||
]
|
||||
|
||||
# SEC-XMPP-02 : rejeter aussi les chaînes vides ou composées uniquement
|
||||
# d'espaces : ``bool(SecretStr)`` et ``bool(str)`` ne testent que la
|
||||
# présence de l'objet, pas la valeur contenue.
|
||||
missing_fields = [
|
||||
name
|
||||
for name, present in (
|
||||
("jid", settings.jid is not None and bool(settings.jid.strip())),
|
||||
(
|
||||
"password",
|
||||
settings.password is not None
|
||||
and bool(settings.password.get_secret_value().strip()),
|
||||
),
|
||||
("to", settings.to is not None and bool(settings.to.strip())),
|
||||
("host", bool(settings.host.strip())),
|
||||
)
|
||||
if not present
|
||||
]
|
||||
if missing_fields:
|
||||
logger.warning(
|
||||
"XMPP : configuration incomplète (champs manquants : %s), canal désactivé.",
|
||||
redact_secrets(", ".join(missing_fields), extra_secrets=extra_secrets),
|
||||
)
|
||||
return None
|
||||
|
||||
return SyncXmppChannel(settings, dry_run=dry_run)
|
||||
|
||||
33
pronote_sync/channels/protocol.py
Normal file
33
pronote_sync/channels/protocol.py
Normal file
@@ -0,0 +1,33 @@
|
||||
"""Protocole abstrait définissant le contrat des canaux de sortie."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
from typing import Protocol, runtime_checkable
|
||||
|
||||
from pronote_sync.models.xmpp import XmppMessage
|
||||
|
||||
|
||||
@runtime_checkable
|
||||
class Channel(Protocol):
|
||||
"""Contrat structurel d'un canal de sortie du pipeline.
|
||||
|
||||
Un canal de sortie reçoit un message final :class:`XmppMessage` et tente de
|
||||
l'envoyer vers la destination qu'il représente (CalDAV, XMPP, etc.).
|
||||
|
||||
:ivar send: Envoie un message sur le canal.
|
||||
"""
|
||||
|
||||
def send(self, message: XmppMessage) -> bool:
|
||||
"""Envoie un message sur le canal.
|
||||
|
||||
Un canal ne lève jamais :pyexc:`PipelineWarning` ; en cas d'échec, il
|
||||
retourne ``False``. Le :pyexc:`PipelineWarning` est créé par l'étape
|
||||
pipeline, pas par le canal. Une :pyexc:`PipelineCriticalError` peut
|
||||
en revanche être levée en cas de panne critique (ex. : chemin
|
||||
CalDAV, non utilisé par le canal XMPP).
|
||||
|
||||
:param message: Message final à transmettre.
|
||||
:return: ``True`` si l'envoi a réussi, ``False`` sinon.
|
||||
:rtype: bool
|
||||
"""
|
||||
...
|
||||
369
pronote_sync/channels/xmpp.py
Normal file
369
pronote_sync/channels/xmpp.py
Normal file
@@ -0,0 +1,369 @@
|
||||
"""Canal de sortie XMPP du pipeline ``pronote-sync``.
|
||||
|
||||
Ce module implémente le canal d'envoi de notifications XMPP : la classe
|
||||
:class:`XmppChannel` envoie un message direct via ``slixmpp``
|
||||
(:meth:`XmppChannel.send_async`), tandis que :class:`SyncXmppChannel`
|
||||
fournit le point d'entrée synchrone unique utilisé par le pipeline. Le corps
|
||||
du message est formaté en texte brut par ``_format_message`` (en-tête de date
|
||||
cible puis sections emoji 📌📅📚💬📢) et chaque texte est assaini par
|
||||
:func:`pronote_sync.utils.text.sanitize_plaintext` (SEC-XMPP-06).
|
||||
|
||||
Contrat d'erreur (D6) : le canal ne lève jamais :pyexc:`PipelineWarning` ;
|
||||
en cas d'échec, il journalise la version expurgée de l'erreur et retourne
|
||||
``False``. Le :pyexc:`PipelineWarning` est créé par l'étape pipeline, pas par
|
||||
le canal.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import asyncio
|
||||
import logging
|
||||
|
||||
from pydantic import SecretStr
|
||||
from slixmpp import JID, ClientXMPP
|
||||
|
||||
from pronote_sync.config.settings import XmppSettings
|
||||
from pronote_sync.models.blog import ExternalInfo
|
||||
from pronote_sync.models.diff import AgendaChange, AgendaChangeType
|
||||
from pronote_sync.models.homework import Homework
|
||||
from pronote_sync.models.message import Message
|
||||
from pronote_sync.models.xmpp import XmppMessage
|
||||
from pronote_sync.utils.redaction import redact_exception, redact_secrets
|
||||
from pronote_sync.utils.text import sanitize_plaintext
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
__all__ = ["XmppChannel", "SyncXmppChannel", "XmppMessage"]
|
||||
|
||||
|
||||
def _secret_values(settings: XmppSettings) -> tuple[SecretStr | str, ...]:
|
||||
"""Rassemble les secrets du canal XMPP pour le masquage des logs.
|
||||
|
||||
:param settings: Paramètres du canal XMPP.
|
||||
:return: Valeurs sensibles (mot de passe, JID du bot, destinataire).
|
||||
:rtype: tuple[SecretStr | str, ...]
|
||||
"""
|
||||
secrets: list[SecretStr | str] = []
|
||||
if settings.jid is not None:
|
||||
secrets.append(settings.jid)
|
||||
if settings.password is not None:
|
||||
secrets.append(settings.password)
|
||||
if settings.to is not None:
|
||||
secrets.append(settings.to)
|
||||
return tuple(secrets)
|
||||
|
||||
|
||||
def _format_synthesis(synthesis: str | None) -> str:
|
||||
"""Formate la section synthèse du message XMPP.
|
||||
|
||||
:param synthesis: Texte de synthèse, ou ``None`` si absente.
|
||||
:return: Section ``📌 Synthèse`` suivie de la synthèse (ou du texte par
|
||||
défaut si aucune n'est disponible).
|
||||
:rtype: str
|
||||
"""
|
||||
content = synthesis if synthesis else "Aucune synthèse disponible."
|
||||
return f"📌 Synthèse\n{sanitize_plaintext(content)}"
|
||||
|
||||
|
||||
def _format_changes(changes: tuple[AgendaChange, ...]) -> str:
|
||||
"""Formate la section des changements d'agenda du message XMPP.
|
||||
|
||||
Distingue les ajouts, suppressions et modifications (U4). Pour un ajout,
|
||||
les horaires du cours (``HH:MM-HH:MM``) sont inclus si le cours est
|
||||
disponible.
|
||||
|
||||
:param changes: Liste des changements d'agenda.
|
||||
:return: Section ``📅 Changements d'agenda`` avec une ligne par
|
||||
changement (type, matière et détails).
|
||||
:rtype: str
|
||||
"""
|
||||
if not changes:
|
||||
body = "Aucun changement."
|
||||
else:
|
||||
lines: list[str] = []
|
||||
for change in changes:
|
||||
subject = "—"
|
||||
if change.lesson is not None:
|
||||
subject = change.lesson.subject
|
||||
elif change.theoretical_lesson is not None:
|
||||
subject = change.theoretical_lesson.subject
|
||||
if change.type == AgendaChangeType.ADDED and change.lesson is not None:
|
||||
times = (
|
||||
f"{change.lesson.start.strftime('%H:%M')}-{change.lesson.end.strftime('%H:%M')}"
|
||||
)
|
||||
lines.append(f"• [Ajouté] {subject}: {change.details} ({times})")
|
||||
elif change.type == AgendaChangeType.REMOVED:
|
||||
lines.append(f"• [Supprimé] {subject}: {change.details}")
|
||||
else:
|
||||
lines.append(f"• [Modifié] {subject}: {change.details}")
|
||||
body = "\n".join(lines)
|
||||
return f"📅 Changements d'agenda\n{sanitize_plaintext(body)}"
|
||||
|
||||
|
||||
def _format_homeworks(homeworks: tuple[Homework, ...]) -> str:
|
||||
"""Formate la section des devoirs du message XMPP.
|
||||
|
||||
:param homeworks: Liste des devoirs.
|
||||
:return: Section ``📚 Devoirs`` avec une ligne par devoir (matière,
|
||||
texte et date d'échéance).
|
||||
:rtype: str
|
||||
"""
|
||||
if not homeworks:
|
||||
body = "Aucun devoir."
|
||||
else:
|
||||
lines = [
|
||||
f"• {homework.subject}: {homework.text} "
|
||||
f"(à rendre le {homework.due_on.strftime('%d/%m')})"
|
||||
for homework in homeworks
|
||||
]
|
||||
body = "\n".join(lines)
|
||||
return f"📚 Devoirs\n{sanitize_plaintext(body)}"
|
||||
|
||||
|
||||
def _format_messages(messages: tuple[Message, ...]) -> str:
|
||||
"""Formate la section des messages Pronote du message XMPP.
|
||||
|
||||
:param messages: Liste des messages/informations.
|
||||
:return: Section ``💬 Messages`` avec une ligne par message (titre,
|
||||
auteur et contenu) ; sans titre, seul l'auteur est affiché.
|
||||
:rtype: str
|
||||
"""
|
||||
if not messages:
|
||||
body = "Aucun message."
|
||||
else:
|
||||
lines: list[str] = []
|
||||
for message in messages:
|
||||
if message.title:
|
||||
lines.append(f"• {message.title} ({message.author}): {message.content}")
|
||||
else:
|
||||
lines.append(f"• {message.author}: {message.content}")
|
||||
body = "\n".join(lines)
|
||||
return f"💬 Messages\n{sanitize_plaintext(body)}"
|
||||
|
||||
|
||||
def _format_external_info(external_info: ExternalInfo | None) -> str:
|
||||
"""Formate la section des informations diverses du message XMPP.
|
||||
|
||||
Regroupe uniquement les articles du blog et les autres informations
|
||||
(``other_info``) : les messages Pronote (``pronote_messages``) sont
|
||||
exclus car ils sont déjà transmis par la section des messages.
|
||||
|
||||
:param external_info: Informations externes agrégées, ou ``None``.
|
||||
:return: Section ``📢 Informations diverses`` avec une ligne par élément.
|
||||
:rtype: str
|
||||
"""
|
||||
if external_info is None:
|
||||
body = "Aucune information."
|
||||
else:
|
||||
lines: list[str] = []
|
||||
for article in external_info.blog_articles:
|
||||
lines.append(f"• {article.title}: {article.content_text}")
|
||||
for info in external_info.other_info:
|
||||
lines.append(f"• {info}")
|
||||
body = "\n".join(lines) if lines else "Aucune information."
|
||||
return f"📢 Informations diverses\n{sanitize_plaintext(body)}"
|
||||
|
||||
|
||||
class XmppChannel:
|
||||
"""Canal d'envoi de messages XMPP via un compte bot dédié.
|
||||
|
||||
Envoie un message direct (``type="chat"``) au destinataire configuré en
|
||||
utilisant :class:`slixmpp.ClientXMPP`. La connexion est établie à chaque
|
||||
appel de :meth:`send_async` ; le constructeur n'effectue aucun accès
|
||||
réseau.
|
||||
|
||||
Contrat d'erreur (D6) : :meth:`send_async` ne lève jamais
|
||||
:pyexc:`PipelineWarning` ; en cas d'échec, elle journalise la version
|
||||
expurgée de l'erreur et retourne ``False``. En mode ``dry_run``, aucun
|
||||
client n'est créé.
|
||||
|
||||
:ivar settings: Paramètres XMPP (JID, mot de passe, destinataire, TLS).
|
||||
:vartype settings: XmppSettings
|
||||
:ivar dry_run: En mode ``dry_run``, aucun envoi n'est effectué.
|
||||
:vartype dry_run: bool
|
||||
"""
|
||||
|
||||
def __init__(self, settings: XmppSettings, dry_run: bool = False) -> None:
|
||||
"""Initialise le canal XMPP sans connexion réseau.
|
||||
|
||||
:param settings: Paramètres de configuration du canal XMPP.
|
||||
:param dry_run: Si ``True``, :meth:`send_async` journalise le message
|
||||
formaté et retourne ``True`` sans se connecter.
|
||||
"""
|
||||
self.settings = settings
|
||||
self.dry_run = dry_run
|
||||
|
||||
def _format_message(self, message: XmppMessage) -> str:
|
||||
"""Formate un message XMPP en texte brut avec des sections emoji.
|
||||
|
||||
Produit le corps du message : un en-tête avec la date cible du
|
||||
digest, puis les sections synthèse, changements d'agenda, devoirs,
|
||||
messages et informations diverses. Chaque texte est assaini par
|
||||
:func:`pronote_sync.utils.text.sanitize_plaintext` avant insertion
|
||||
(SEC-XMPP-06).
|
||||
|
||||
:param message: Message final à formater.
|
||||
:return: Corps du message en texte brut, prêt pour l'envoi.
|
||||
:rtype: str
|
||||
"""
|
||||
sections = [
|
||||
f"Digest du {message.target_date.strftime('%d/%m/%Y')}",
|
||||
_format_synthesis(message.synthesis),
|
||||
_format_changes(message.changes),
|
||||
_format_homeworks(message.homeworks),
|
||||
_format_messages(message.messages),
|
||||
_format_external_info(message.external_info),
|
||||
]
|
||||
return "\n\n".join(sections)
|
||||
|
||||
async def send_async(self, message: XmppMessage) -> bool:
|
||||
"""Exécute le flux asynchrone d'envoi XMPP (U2).
|
||||
|
||||
Connecte le client ``slixmpp`` avec un hôte et un port explicites,
|
||||
configure TLS avant la connexion, puis attend l'un des événements
|
||||
``session_start``, ``failed_auth`` ou ``disconnected`` sous un
|
||||
timeout unique avant d'envoyer un message direct ``chat`` au
|
||||
destinataire configuré. La déconnexion est garantie par un bloc
|
||||
``try/finally``. Aucun secret n'est journalisé (SEC-XMPP-02).
|
||||
|
||||
:param message: Message final à envoyer.
|
||||
:return: ``True`` si l'envoi a réussi (ou a été simulé en dry-run),
|
||||
``False`` sinon (destinataire manquant, timeout, échec
|
||||
d'authentification, déconnexion ou erreur réseau).
|
||||
:rtype: bool
|
||||
"""
|
||||
if self.dry_run:
|
||||
formatted = self._format_message(message)
|
||||
logger.info("XMPP dry-run: message would be sent")
|
||||
return True
|
||||
|
||||
# Build JID with resource
|
||||
jid_str = f"{self.settings.jid}/{self.settings.resource}"
|
||||
recipient = JID(self.settings.to) if self.settings.to else None
|
||||
if recipient is None:
|
||||
logger.warning("Destinataire XMPP manquant.")
|
||||
return False
|
||||
|
||||
# Create typed client
|
||||
client = ClientXMPP(
|
||||
jid_str,
|
||||
self.settings.password.get_secret_value() if self.settings.password else "",
|
||||
)
|
||||
|
||||
# Configure TLS BEFORE connect
|
||||
if self.settings.use_tls:
|
||||
# TLS direct (port 5223 typically)
|
||||
client.enable_direct_tls = True
|
||||
client.enable_starttls = False
|
||||
else:
|
||||
# STARTTLS (port 5222 typically)
|
||||
client.enable_starttls = True
|
||||
client.enable_direct_tls = False
|
||||
|
||||
# Register handlers
|
||||
session_future: asyncio.Future[bool] = asyncio.get_event_loop().create_future()
|
||||
|
||||
def on_session_start(event: object) -> None:
|
||||
if not session_future.done():
|
||||
session_future.set_result(True)
|
||||
|
||||
def on_failed_auth(event: object) -> None:
|
||||
if not session_future.done():
|
||||
session_future.set_result(False)
|
||||
|
||||
def on_disconnected(event: object) -> None:
|
||||
if not session_future.done():
|
||||
session_future.set_result(False)
|
||||
|
||||
client.add_event_handler("session_start", on_session_start)
|
||||
client.add_event_handler("failed_auth", on_failed_auth)
|
||||
client.add_event_handler("disconnected", on_disconnected)
|
||||
|
||||
try:
|
||||
# Connect with explicit host and port
|
||||
connect_future = client.connect(self.settings.host, self.settings.port)
|
||||
await connect_future # connect() returns a Future, not a coroutine
|
||||
|
||||
# Wait for one of the three events under a single timeout
|
||||
try:
|
||||
success = await asyncio.wait_for(session_future, timeout=self.settings.timeout)
|
||||
except TimeoutError:
|
||||
logger.warning("Délai d'attente de session XMPP dépassé.")
|
||||
return False
|
||||
|
||||
if not success:
|
||||
logger.warning("Échec d'authentification ou déconnexion XMPP.")
|
||||
return False
|
||||
|
||||
# Send the message
|
||||
formatted = self._format_message(message)
|
||||
client.send_message(mto=JID(self.settings.to), mbody=formatted, mtype="chat")
|
||||
return True
|
||||
|
||||
except Exception as exc:
|
||||
redacted = redact_exception(exc)
|
||||
extra = _secret_values(self.settings)
|
||||
logger.warning("Erreur XMPP: %s", redact_secrets(redacted, extra_secrets=extra))
|
||||
return False
|
||||
finally:
|
||||
try:
|
||||
disconnect_future = client.disconnect()
|
||||
await disconnect_future
|
||||
except Exception as cleanup_exc:
|
||||
logger.debug(
|
||||
"Erreur lors de la déconnexion XMPP: %s", redact_exception(cleanup_exc)
|
||||
)
|
||||
|
||||
|
||||
class SyncXmppChannel:
|
||||
"""Point d'entrée synchrone unique du canal XMPP pour le pipeline (U3).
|
||||
|
||||
Enveloppe une instance de :class:`XmppChannel` pour offrir une interface
|
||||
synchrone conforme au :class:`~pronote_sync.channels.protocol.Channel`.
|
||||
:meth:`send` délègue à :func:`asyncio.run` et ne lève jamais : toute
|
||||
erreur est journalisée de façon expurgée et convertie en retour
|
||||
``False`` (D6). En mode ``dry_run``, aucun client ``slixmpp`` n'est créé.
|
||||
|
||||
:ivar settings: Paramètres XMPP.
|
||||
:vartype settings: XmppSettings
|
||||
:ivar dry_run: Mode simulation (aucun envoi réseau).
|
||||
:vartype dry_run: bool
|
||||
"""
|
||||
|
||||
def __init__(self, settings: XmppSettings, dry_run: bool = False) -> None:
|
||||
"""Initialise le point d'entrée synchrone et son canal interne.
|
||||
|
||||
:param settings: Paramètres de configuration du canal XMPP.
|
||||
:param dry_run: Si ``True``, l'envoi est simulé.
|
||||
"""
|
||||
self.settings = settings
|
||||
self.dry_run = dry_run
|
||||
self._channel = XmppChannel(settings, dry_run)
|
||||
|
||||
def send(self, message: XmppMessage) -> bool:
|
||||
"""Envoie un message XMPP de façon synchrone et sans lever.
|
||||
|
||||
En mode ``dry_run``, le message formaté (expurgé de ses secrets) est
|
||||
journalisé et la méthode retourne ``True`` sans créer de client XMPP.
|
||||
Sinon, le flux asynchrone :meth:`XmppChannel.send_async` est exécuté
|
||||
via :func:`asyncio.run` ; toute exception est journalisée sous forme
|
||||
expurgée et convertie en retour ``False``. La méthode ne lève jamais
|
||||
(D6).
|
||||
|
||||
:param message: Message final à envoyer.
|
||||
:return: ``True`` si l'envoi a réussi (ou a été simulé en dry-run),
|
||||
``False`` sinon.
|
||||
:rtype: bool
|
||||
"""
|
||||
if self.dry_run:
|
||||
formatted = self._channel._format_message(message)
|
||||
redacted = redact_secrets(formatted, extra_secrets=_secret_values(self.settings))
|
||||
logger.info("XMPP : dry-run, message non envoyé : %s", redacted)
|
||||
return True
|
||||
try:
|
||||
return asyncio.run(self._channel.send_async(message))
|
||||
except Exception as exc:
|
||||
redacted = redact_exception(exc)
|
||||
redacted = redact_secrets(redacted, extra_secrets=_secret_values(self.settings))
|
||||
logger.warning("XMPP : erreur lors de l'envoi synchrone : %s", redacted)
|
||||
return False
|
||||
@@ -12,7 +12,13 @@ from datetime import date
|
||||
from typing import Literal
|
||||
from urllib.parse import urlparse
|
||||
|
||||
from pydantic import Field, SecretStr, ValidationInfo, field_serializer, field_validator
|
||||
from pydantic import (
|
||||
Field,
|
||||
SecretStr,
|
||||
ValidationInfo,
|
||||
field_serializer,
|
||||
field_validator,
|
||||
)
|
||||
from pydantic_settings import BaseSettings, SettingsConfigDict
|
||||
|
||||
from pronote_sync.utils.redaction import redact_url
|
||||
@@ -124,25 +130,66 @@ class CalDAVSettings(BaseSettings):
|
||||
return v
|
||||
|
||||
|
||||
_XMPP_LOOPBACK_HOSTS: frozenset[str] = frozenset({"localhost", "127.0.0.1", "::1"})
|
||||
|
||||
|
||||
class XmppSettings(BaseSettings):
|
||||
"""Paramètres du canal de notifications XMPP (désactivé par défaut).
|
||||
|
||||
Tous les champs ont des valeurs par défaut afin que le canal XMPP reste
|
||||
inactif tant qu'il n'est pas explicitement activé. Les variables
|
||||
d'environnement correspondantes sont préfixées par ``XMPP_``.
|
||||
|
||||
Contraintes de champs : ``port`` est borné entre 1 et 65535 et ``timeout``
|
||||
doit être strictement positif.
|
||||
|
||||
Politique TLS : la désactivation de TLS (``use_tls`` à ``False``) n'est
|
||||
autorisée que sur un hôte de boucle locale (``localhost``, ``127.0.0.1``,
|
||||
``::1``). Dans tout autre cas, une erreur de validation est levée,
|
||||
indépendamment de l'état du champ ``enabled``.
|
||||
"""
|
||||
|
||||
model_config = SettingsConfigDict(env_file=".env", extra="ignore", env_prefix="XMPP_")
|
||||
model_config = SettingsConfigDict(
|
||||
env_file=".env",
|
||||
extra="ignore",
|
||||
env_prefix="XMPP_",
|
||||
hide_input_in_errors=True,
|
||||
)
|
||||
|
||||
enabled: bool = False
|
||||
jid: str | None = None
|
||||
password: SecretStr | None = None
|
||||
host: str = ""
|
||||
port: int = 5222
|
||||
port: int = Field(default=5222, ge=1, le=65535)
|
||||
to: str | None = None
|
||||
resource: str = "pronote-sync"
|
||||
use_tls: bool = True
|
||||
timeout: int = 30
|
||||
timeout: int = Field(default=30, gt=0)
|
||||
|
||||
@field_validator("use_tls")
|
||||
@classmethod
|
||||
def _validate_tls_policy(cls, v: bool, info: ValidationInfo) -> bool:
|
||||
"""Refuse la désactivation de TLS hors des hôtes de boucle locale.
|
||||
|
||||
La règle s'applique quel que soit l'état du champ ``enabled``. Le
|
||||
message d'erreur ne contient aucune valeur sensible (``jid``,
|
||||
``password``, ``to``).
|
||||
|
||||
:param v: Valeur du champ ``use_tls`` à valider.
|
||||
:param info: Contexte de validation (accès aux autres champs).
|
||||
:return: La valeur validée inchangée.
|
||||
:rtype: bool
|
||||
:raises ValueError: Si ``use_tls`` est ``False`` et que ``host``
|
||||
n'est pas un hôte de boucle locale.
|
||||
"""
|
||||
if v is False:
|
||||
host = info.data.get("host", "")
|
||||
if host not in _XMPP_LOOPBACK_HOSTS:
|
||||
raise ValueError(
|
||||
"TLS désactivé n'est autorisé que sur les hôtes de loopback "
|
||||
"(localhost, 127.0.0.1, ::1)."
|
||||
) from None
|
||||
return v
|
||||
|
||||
|
||||
class AISettings(BaseSettings):
|
||||
|
||||
@@ -31,3 +31,29 @@ class PipelineCriticalError(PronoteSyncError):
|
||||
:param message: Message décrivant la cause de l'erreur critique.
|
||||
"""
|
||||
super().__init__(message)
|
||||
|
||||
|
||||
class PipelineWarning(PronoteSyncError):
|
||||
"""Avertissement non bloquant pour une erreur récupérable du pipeline.
|
||||
|
||||
Contrairement à :class:`PipelineCriticalError`, cet avertissement signale
|
||||
un problème récupérable : le pipeline peut poursuivre son exécution en
|
||||
mode dégradé.
|
||||
|
||||
Il hérite volontairement de :class:`PronoteSyncError` (et non de la classe
|
||||
native :class:`Warning`) afin de rester dans la hiérarchie canonique des
|
||||
erreurs du projet.
|
||||
|
||||
:ivar recoverable: Indique que l'erreur est récupérable (toujours ``True``).
|
||||
:ivar step: Étape du pipeline ayant produit l'avertissement.
|
||||
"""
|
||||
|
||||
def __init__(self, message: str, step: str | None = None) -> None:
|
||||
"""Initialise l'avertissement avec un message descriptif.
|
||||
|
||||
:param message: Message décrivant la cause de l'avertissement.
|
||||
:param step: Étape du pipeline ayant produit l'avertissement.
|
||||
"""
|
||||
super().__init__(message)
|
||||
self.recoverable = True
|
||||
self.step = step
|
||||
|
||||
@@ -10,7 +10,9 @@ from __future__ import annotations
|
||||
import re
|
||||
import unicodedata
|
||||
|
||||
__all__ = ["normalize_subject"]
|
||||
from bs4 import BeautifulSoup
|
||||
|
||||
__all__ = ["normalize_subject", "sanitize_plaintext"]
|
||||
|
||||
|
||||
def normalize_subject(subject: str) -> str:
|
||||
@@ -30,3 +32,29 @@ def normalize_subject(subject: str) -> str:
|
||||
normalized = re.sub(r"[^\w\s]", "", normalized)
|
||||
normalized = re.sub(r"\s+", " ", normalized).strip()
|
||||
return normalized.lower()
|
||||
|
||||
|
||||
# Pattern des caractères de contrôle ASCII non imprimables (à l'exception
|
||||
# des tabulations ``\\t``, des sauts de ligne ``\\n`` et des retours chariot ``\\r``).
|
||||
_CONTROL_CHARS_RE = re.compile(r"[\x00-\x08\x0b\x0c\x0e-\x1f\x7f-\x9f]")
|
||||
|
||||
|
||||
def sanitize_plaintext(text: str) -> str:
|
||||
"""Prépare un texte pour le corps de message XMPP en texte brut.
|
||||
|
||||
Supprime les balises HTML (via ``BeautifulSoup`` avec le parseur
|
||||
``html.parser``) puis les caractères de contrôle ASCII non imprimables,
|
||||
à l'exception des tabulations (``\\t``), des sauts de ligne (``\\n``) et
|
||||
des retours chariot (``\\r``). Les caractères Unicode au-delà de ``\\x1f``,
|
||||
notamment les emojis, sont conservés. La transformation est idempotente :
|
||||
appliquée deux fois, elle produit le même résultat qu'appliquée une seule
|
||||
fois. Une chaîne vide donne une chaîne vide.
|
||||
|
||||
:param text: Le texte brut ou HTML à assainir.
|
||||
:return: Le texte assaini, sans balises HTML ni caractères de contrôle.
|
||||
:rtype: str
|
||||
"""
|
||||
# Étape 1 : suppression des balises HTML.
|
||||
plain = BeautifulSoup(text, "html.parser").get_text()
|
||||
# Étape 2 : suppression des caractères de contrôle.
|
||||
return _CONTROL_CHARS_RE.sub("", plain)
|
||||
|
||||
@@ -121,6 +121,10 @@ strict = true
|
||||
module = "litellm"
|
||||
ignore_missing_imports = true
|
||||
|
||||
[[tool.mypy.overrides]]
|
||||
module = "slixmpp"
|
||||
ignore_missing_imports = true
|
||||
|
||||
[[tool.mypy.overrides]]
|
||||
module = "openai.*"
|
||||
follow_imports = "skip"
|
||||
|
||||
387
tests/integration/test_xmpp_integration.py
Normal file
387
tests/integration/test_xmpp_integration.py
Normal file
@@ -0,0 +1,387 @@
|
||||
"""Tests d'intégration pour le canal XMPP (end-to-end sans réseau).
|
||||
|
||||
Ce module valide les critères d'acceptation de la milestone M10 (GUIDE_DEV_PYTHON.md,
|
||||
TODO.md §M10) pour le canal XMPP, en mode end-to-end avec mock de slixmpp.
|
||||
|
||||
Les tests couvrent :
|
||||
- L'envoi réussi d'un message formaté via SyncXmppChannel
|
||||
- La dégradation des erreurs XMPP en retour False (jamais d'exception non gérée)
|
||||
- L'absence de fuite de secrets dans les logs XMPP
|
||||
- Le flag dry_run ne crée jamais ClientXMPP
|
||||
|
||||
Tous les tests sont exécutés sans réseau grâce à des mocks de slixmpp.ClientXMPP.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import asyncio
|
||||
from collections.abc import Callable
|
||||
from datetime import date, datetime
|
||||
from typing import Any
|
||||
from unittest.mock import patch
|
||||
|
||||
import pytest
|
||||
from pydantic import SecretStr
|
||||
|
||||
from pronote_sync.channels import get_channel
|
||||
from pronote_sync.channels.xmpp import XmppMessage
|
||||
from pronote_sync.config.settings import XmppSettings
|
||||
from pronote_sync.models.agenda import Lesson
|
||||
from pronote_sync.models.blog import BlogArticle, ExternalInfo
|
||||
from pronote_sync.models.diff import AgendaChange, AgendaChangeType
|
||||
from pronote_sync.models.homework import Homework
|
||||
from pronote_sync.models.message import Message, MessageType
|
||||
|
||||
# Sentinelles pour tests de non-fuite de secrets dans les logs
|
||||
INTEG_JID_SENTINEL = "INTEG_JID_SENTINEL@xmpp.example"
|
||||
INTEG_PASS_SENTINEL = "INTEG_PASS_SENTINEL"
|
||||
INTEG_TO_SENTINEL = "INTEG_TO_SENTINEL@xmpp.example"
|
||||
|
||||
|
||||
class FakeClientXMPP:
|
||||
"""Faux client XMPP avec signatures fidèles à slixmpp 1.17.0."""
|
||||
|
||||
instances: list[FakeClientXMPP] = []
|
||||
|
||||
def __init__(self, jid: str, password: str) -> None:
|
||||
self.jid = jid
|
||||
self.password = password
|
||||
self.enable_starttls: bool = True
|
||||
self.enable_direct_tls: bool = True
|
||||
self.connected: bool = False
|
||||
self.disconnected: bool = False
|
||||
self.handlers: dict[str, list[Callable[..., Any]]] = {}
|
||||
self.messages_sent: list[dict[str, object]] = []
|
||||
self._host_used: str | None = None
|
||||
self._port_used: int | None = None
|
||||
FakeClientXMPP.instances.append(self)
|
||||
|
||||
@classmethod
|
||||
def reset(cls) -> None:
|
||||
cls.instances.clear()
|
||||
|
||||
def add_event_handler(self, name: str, handler: Callable[..., Any]) -> None:
|
||||
"""Enregistre un gestionnaire d'événement.
|
||||
|
||||
:param name: Nom de l'événement (ex: 'session_start').
|
||||
:param handler: Fonction gestionnaire.
|
||||
:raises: AssertionError si l'événement n'est pas supporté.
|
||||
"""
|
||||
if name not in ("session_start", "failed_auth", "disconnected"):
|
||||
raise AssertionError(f"Unsupported event: {name}")
|
||||
self.handlers.setdefault(name, []).append(handler)
|
||||
|
||||
def connect(self, host: str | None = None, port: int | None = None) -> asyncio.Future[bool]:
|
||||
"""Simule la connexion au serveur XMPP.
|
||||
|
||||
Déclenche les handlers appropriés selon le scénario de test.
|
||||
|
||||
:param host: Hôte de connexion.
|
||||
:param port: Port de connexion.
|
||||
:return: Future résolue à True.
|
||||
"""
|
||||
loop = asyncio.get_event_loop()
|
||||
future: asyncio.Future[bool] = loop.create_future()
|
||||
self.connected = True
|
||||
self._host_used = host
|
||||
self._port_used = port
|
||||
# Déclencher session_start par défaut
|
||||
loop.call_soon(self._fire_events)
|
||||
future.set_result(True)
|
||||
return future
|
||||
|
||||
def _fire_events(self) -> None:
|
||||
for handler in self.handlers.get("session_start", []):
|
||||
handler({})
|
||||
|
||||
def disconnect(
|
||||
self, wait: float = 2.0, reason: str | None = None, ignore_send_queue: bool = False
|
||||
) -> asyncio.Future[bool]:
|
||||
"""Simule la déconnexion du serveur XMPP.
|
||||
|
||||
:param wait: Temps d'attente.
|
||||
:param reason: Raison de la déconnexion.
|
||||
:param ignore_send_queue: Ignorer la file d'envoi.
|
||||
:return: Future résolue à True.
|
||||
"""
|
||||
loop = asyncio.get_event_loop()
|
||||
future: asyncio.Future[bool] = loop.create_future()
|
||||
self.disconnected = True
|
||||
future.set_result(True)
|
||||
return future
|
||||
|
||||
def send_message(
|
||||
self, mto: object, mbody: str | None = None, mtype: str | None = None, **kwargs: object
|
||||
) -> None:
|
||||
"""Simule l'envoi d'un message.
|
||||
|
||||
:param mto: Destinataire.
|
||||
:param mbody: Corps du message.
|
||||
:param mtype: Type de message.
|
||||
:param kwargs: Arguments supplémentaires.
|
||||
"""
|
||||
self.messages_sent.append({"mto": mto, "mbody": mbody, "mtype": mtype, **kwargs})
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def xmpp_settings_enabled() -> XmppSettings:
|
||||
"""Fixture fournissant des paramètres XMPP valides et activés.
|
||||
|
||||
:return: Instance de XmppSettings avec des valeurs par défaut valides.
|
||||
:rtype: XmppSettings
|
||||
"""
|
||||
return XmppSettings(
|
||||
enabled=True,
|
||||
jid="bot@example.com",
|
||||
password=SecretStr("secret123"),
|
||||
host="xmpp.example.com",
|
||||
port=5222,
|
||||
to="parent@example.com",
|
||||
resource="pronote-sync",
|
||||
use_tls=True,
|
||||
timeout=30,
|
||||
)
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def xmpp_message_populated() -> XmppMessage:
|
||||
"""Fixture fournissant un message XMPP complet avec toutes les sections.
|
||||
|
||||
:return: Instance de XmppMessage avec tous les champs remplis.
|
||||
:rtype: XmppMessage
|
||||
"""
|
||||
homework = Homework(
|
||||
id="hw1",
|
||||
subject="Mathématiques",
|
||||
teachers=("M. Dupont",),
|
||||
assigned_on=date(2025, 9, 1),
|
||||
due_on=date(2025, 9, 15),
|
||||
text="Faire l'exercice 5 page 42",
|
||||
html="<p>Faire l'exercice 5 page 42</p>",
|
||||
)
|
||||
lesson = Lesson(
|
||||
id="lesson1",
|
||||
subject="Physique",
|
||||
start=datetime.fromisoformat("2025-09-07T08:00:00"),
|
||||
end=datetime.fromisoformat("2025-09-07T09:00:00"),
|
||||
rooms=("B201",),
|
||||
teachers=("M. Martin",),
|
||||
group=None,
|
||||
content=None,
|
||||
)
|
||||
change = AgendaChange(
|
||||
type=AgendaChangeType.ADDED,
|
||||
lesson=lesson,
|
||||
theoretical_lesson=None,
|
||||
details="Cours déplacé",
|
||||
)
|
||||
message = Message(
|
||||
id="msg1",
|
||||
type=MessageType.INFORMATION,
|
||||
title="Réunion parents-professeurs",
|
||||
content="Une réunion est organisée le 15/09 à 18h.",
|
||||
author="CPE",
|
||||
date=datetime.fromisoformat("2025-09-01T10:00:00"),
|
||||
read=False,
|
||||
)
|
||||
article = BlogArticle(
|
||||
id="art1",
|
||||
title="Sortie scolaire",
|
||||
url="https://blog.example.com/sortie",
|
||||
published_at=datetime.fromisoformat("2025-09-01T09:00:00"),
|
||||
updated_at=None,
|
||||
category="Actualités",
|
||||
author="Collège",
|
||||
content_html="<p>Sortie prévue le 20/09.</p>",
|
||||
content_text="Sortie prévue le 20/09.",
|
||||
)
|
||||
external = ExternalInfo(
|
||||
blog_articles=(article,),
|
||||
pronote_messages=(message,),
|
||||
other_info=("Info supplémentaire",),
|
||||
)
|
||||
return XmppMessage(
|
||||
target_date=date(2025, 9, 7),
|
||||
synthesis="Voici la synthèse des activités du jour.",
|
||||
homeworks=(homework,),
|
||||
changes=(change,),
|
||||
messages=(),
|
||||
external_info=external,
|
||||
)
|
||||
|
||||
|
||||
class TestXmppIntegrationSend:
|
||||
"""Tests d'intégration pour l'envoi de messages XMPP via SyncXmppChannel.
|
||||
|
||||
Ces tests valident le critère d'acceptation #1 de M10 :
|
||||
"XmppChannel.send envoie un message direct formaté (slixmpp mocké en test)".
|
||||
"""
|
||||
|
||||
@patch("pronote_sync.channels.xmpp.ClientXMPP", new=FakeClientXMPP)
|
||||
def test_integration_send_success(
|
||||
self,
|
||||
xmpp_settings_enabled: XmppSettings,
|
||||
xmpp_message_populated: XmppMessage,
|
||||
) -> None:
|
||||
"""Test que SyncXmppChannel.send envoie un message formaté et retourne True.
|
||||
|
||||
Critère d'acceptation #1 : L'envoi réussi retourne True et le message
|
||||
est envoyé avec mtype="chat".
|
||||
|
||||
:param xmpp_settings_enabled: Paramètres XMPP valides et activés.
|
||||
:param xmpp_message_populated: Message XMPP complet.
|
||||
"""
|
||||
# Obtenir le canal via la fabrique
|
||||
channel = get_channel(xmpp_settings_enabled, dry_run=False)
|
||||
assert channel is not None
|
||||
|
||||
# Envoyer le message
|
||||
result = channel.send(xmpp_message_populated)
|
||||
|
||||
# Vérifier que l'envoi a réussi
|
||||
assert result is True
|
||||
|
||||
@patch("pronote_sync.channels.xmpp.ClientXMPP", new=FakeClientXMPP)
|
||||
def test_integration_send_calls_send_message_with_chat_type(
|
||||
self,
|
||||
xmpp_settings_enabled: XmppSettings,
|
||||
xmpp_message_populated: XmppMessage,
|
||||
) -> None:
|
||||
"""Test que send_message est appelé avec mtype='chat' sur succès.
|
||||
|
||||
Critère d'acceptation #1 : Le message est envoyé en mode direct (chat).
|
||||
|
||||
:param xmpp_settings_enabled: Paramètres XMPP valides et activés.
|
||||
:param xmpp_message_populated: Message XMPP complet.
|
||||
"""
|
||||
# Obtenir le canal via la fabrique
|
||||
channel = get_channel(xmpp_settings_enabled, dry_run=False)
|
||||
assert channel is not None
|
||||
|
||||
# Envoyer le message
|
||||
channel.send(xmpp_message_populated)
|
||||
|
||||
# Vérifier que send_message a été appelé avec mtype="chat"
|
||||
# Le mock ClientXMPP a été patché, FakeClientXMPP.instances contient les instances
|
||||
instances = FakeClientXMPP.instances
|
||||
assert len(instances) > 0, "No FakeClientXMPP instance created"
|
||||
client_instance = instances[-1]
|
||||
# Vérifier que send_message a été appelé via messages_sent
|
||||
assert len(client_instance.messages_sent) > 0, "No message sent"
|
||||
# Vérifier que mtype="chat" a été passé
|
||||
found_chat = any(msg.get("mtype") == "chat" for msg in client_instance.messages_sent)
|
||||
assert found_chat, "send_message should have been called with mtype='chat'"
|
||||
|
||||
|
||||
class TestXmppIntegrationErrorHandling:
|
||||
"""Tests d'intégration pour la gestion des erreurs XMPP.
|
||||
|
||||
Ces tests valident le critère d'acceptation #2 de M10 :
|
||||
"Erreur XMPP → False, jamais d'exception non gérée".
|
||||
"""
|
||||
|
||||
@patch("pronote_sync.channels.xmpp.ClientXMPP", new=FakeClientXMPP)
|
||||
def test_integration_error_degradation(self, xmpp_settings_enabled: XmppSettings) -> None:
|
||||
"""Test qu'une erreur retourne False sans lever d'exception non gérée.
|
||||
|
||||
Critère d'acceptation #2 : Les erreurs sont dégradées et retournent False,
|
||||
jamais d'exception non gérée qui s'échappe.
|
||||
|
||||
:param xmpp_settings_enabled: Paramètres XMPP valides et activés.
|
||||
"""
|
||||
|
||||
class ErrorClient(FakeClientXMPP):
|
||||
def connect(
|
||||
self, host: str | None = None, port: int | None = None
|
||||
) -> asyncio.Future[bool]:
|
||||
raise RuntimeError("Connexion impossible")
|
||||
|
||||
with patch("pronote_sync.channels.xmpp.ClientXMPP", new=ErrorClient):
|
||||
channel = get_channel(xmpp_settings_enabled, dry_run=False)
|
||||
assert channel is not None
|
||||
msg = XmppMessage(target_date=date(2025, 9, 7), synthesis=None, external_info=None)
|
||||
|
||||
# Doit retourner False, pas lever d'exception
|
||||
result = channel.send(msg)
|
||||
assert result is False
|
||||
|
||||
|
||||
class TestXmppIntegrationSecurity:
|
||||
"""Tests de sécurité pour le canal XMPP en intégration.
|
||||
|
||||
Ces tests valident le critère d'acceptation #3 de M10 :
|
||||
"Aucun secret dans les logs XMPP".
|
||||
"""
|
||||
|
||||
@patch("pronote_sync.channels.xmpp.ClientXMPP", new=FakeClientXMPP)
|
||||
def test_integration_no_secret_in_logs_on_xmpp_error(
|
||||
self,
|
||||
caplog: pytest.LogCaptureFixture,
|
||||
) -> None:
|
||||
"""Test qu'aucun secret n'apparaît dans les logs en cas d'erreur XMPP.
|
||||
|
||||
Critère d'acceptation #3 : Les secrets (JID, mot de passe, destinataire)
|
||||
ne doivent jamais apparaître dans les logs.
|
||||
|
||||
:param caplog: Fixture pytest pour capturer les logs.
|
||||
"""
|
||||
settings = XmppSettings(
|
||||
enabled=True,
|
||||
jid=INTEG_JID_SENTINEL,
|
||||
password=SecretStr(INTEG_PASS_SENTINEL), # pragma: allowlist secret
|
||||
host="xmpp.example.com",
|
||||
port=5222,
|
||||
to=INTEG_TO_SENTINEL,
|
||||
resource="pronote-sync",
|
||||
use_tls=True,
|
||||
timeout=30,
|
||||
)
|
||||
|
||||
class ErrorClient(FakeClientXMPP):
|
||||
def connect(
|
||||
self, host: str | None = None, port: int | None = None
|
||||
) -> asyncio.Future[bool]:
|
||||
raise RuntimeError("Connexion impossible")
|
||||
|
||||
with patch("pronote_sync.channels.xmpp.ClientXMPP", new=ErrorClient):
|
||||
channel = get_channel(settings, dry_run=False)
|
||||
assert channel is not None
|
||||
msg = XmppMessage(target_date=date(2025, 9, 7), synthesis=None, external_info=None)
|
||||
|
||||
try:
|
||||
channel.send(msg)
|
||||
except Exception:
|
||||
pass # On s'attend à une PipelineWarning ou False
|
||||
|
||||
# Vérifier que les sentinelles n'apparaissent pas dans les logs
|
||||
logs = caplog.text
|
||||
assert INTEG_JID_SENTINEL not in logs
|
||||
assert INTEG_PASS_SENTINEL not in logs
|
||||
assert INTEG_TO_SENTINEL not in logs
|
||||
|
||||
@patch("pronote_sync.channels.xmpp.ClientXMPP", new=FakeClientXMPP)
|
||||
def test_integration_dry_run_no_connection(self, caplog: pytest.LogCaptureFixture) -> None:
|
||||
"""Test que dry_run=True ne crée jamais ClientXMPP.
|
||||
|
||||
:param caplog: Fixture pytest pour capturer les logs.
|
||||
"""
|
||||
settings = XmppSettings(
|
||||
enabled=True,
|
||||
jid=INTEG_JID_SENTINEL,
|
||||
password=SecretStr(INTEG_PASS_SENTINEL),
|
||||
host="xmpp.example.com",
|
||||
port=5222,
|
||||
to=INTEG_TO_SENTINEL,
|
||||
resource="pronote-sync",
|
||||
use_tls=True,
|
||||
timeout=30,
|
||||
)
|
||||
|
||||
with patch("pronote_sync.channels.xmpp.ClientXMPP") as mock_cls:
|
||||
channel = get_channel(settings, dry_run=True)
|
||||
assert channel is not None
|
||||
msg = XmppMessage(target_date=date(2025, 9, 7), synthesis=None, external_info=None)
|
||||
result = channel.send(msg)
|
||||
assert result is True
|
||||
# ClientXMPP ne doit pas être instancié en dry_run
|
||||
assert not mock_cls.called
|
||||
202
tests/unit/test_channel_protocol.py
Normal file
202
tests/unit/test_channel_protocol.py
Normal file
@@ -0,0 +1,202 @@
|
||||
"""Tests unitaires pour le Protocol Channel.
|
||||
|
||||
Ce module valide la spécification du Protocol ``Channel`` qui sera ajouté
|
||||
à ``pronote_sync.channels.protocol``. Ces tests doivent être ROUGES tant que
|
||||
le Protocol n'est pas implémenté.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
from datetime import date
|
||||
|
||||
import pytest
|
||||
|
||||
from pronote_sync.models.xmpp import XmppMessage
|
||||
|
||||
# Import du Protocol à valider (doit échouer tant qu'il n'existe pas)
|
||||
try:
|
||||
from pronote_sync.channels.protocol import Channel
|
||||
|
||||
CHANNEL_MODULE_EXISTS = True
|
||||
except ImportError:
|
||||
CHANNEL_MODULE_EXISTS = False
|
||||
|
||||
|
||||
class TestChannelProtocol:
|
||||
"""Tests pour le Protocol Channel."""
|
||||
|
||||
def test_channel_is_protocol(self) -> None:
|
||||
"""Vérifie que Channel est un Protocol.
|
||||
|
||||
:return: None
|
||||
:raises AssertionError: Si Channel n'est pas un Protocol.
|
||||
"""
|
||||
if not CHANNEL_MODULE_EXISTS:
|
||||
pytest.fail(
|
||||
"Le module pronote_sync.channels.protocol n'existe pas encore. "
|
||||
"Ceci est attendu pour l'instant."
|
||||
)
|
||||
|
||||
assert hasattr(Channel, "_is_protocol"), "Channel doit être un sous-type de typing.Protocol"
|
||||
|
||||
def test_channel_has_send_method(self) -> None:
|
||||
"""Vérifie que le Protocol Channel définit une méthode send.
|
||||
|
||||
:return: None
|
||||
:raises AssertionError: Si la méthode send n'est pas dans l'interface.
|
||||
"""
|
||||
if not CHANNEL_MODULE_EXISTS:
|
||||
pytest.fail(
|
||||
"Le module pronote_sync.channels.protocol n'existe pas encore. "
|
||||
"Ceci est attendu pour l'instant."
|
||||
)
|
||||
|
||||
assert hasattr(Channel, "send"), "Channel doit définir une méthode 'send'"
|
||||
|
||||
send_method = Channel.send
|
||||
assert callable(send_method), "La méthode 'send' doit être callable"
|
||||
|
||||
def test_conforming_class_satisfies_protocol(self) -> None:
|
||||
"""Vérifie qu'une classe conforme satisfait le Protocol Channel.
|
||||
|
||||
:return: None
|
||||
:raises AssertionError: Si la classe conforme n'est pas acceptée.
|
||||
"""
|
||||
if not CHANNEL_MODULE_EXISTS:
|
||||
pytest.fail(
|
||||
"Le module pronote_sync.channels.protocol n'existe pas encore. "
|
||||
"Ceci est attendu pour l'instant."
|
||||
)
|
||||
|
||||
# Classe minimale conforme au Protocol
|
||||
class DummyChannel:
|
||||
"""Implémentation minimale conforme au Protocol Channel."""
|
||||
|
||||
def send(self, message: XmppMessage) -> bool:
|
||||
"""Envoie un message XMPP.
|
||||
|
||||
:param message: Message à envoyer.
|
||||
:return: True si l'envoi a réussi.
|
||||
:rtype: bool
|
||||
"""
|
||||
return True
|
||||
|
||||
# Création d'une instance de message pour le test
|
||||
test_message = XmppMessage(target_date=date(2025, 9, 7), synthesis=None, external_info=None)
|
||||
|
||||
# Instanciation et vérification
|
||||
dummy_instance = DummyChannel()
|
||||
assert dummy_instance.send(test_message) is True, "La méthode send doit retourner True"
|
||||
|
||||
# Vérification que l'instance satisfait le Protocol
|
||||
if hasattr(Channel, "__protocol_attrs__"):
|
||||
# Vérification runtime avec @runtime_checkable
|
||||
assert isinstance(dummy_instance, Channel), (
|
||||
"Une classe conforme doit satisfaire le Protocol Channel"
|
||||
)
|
||||
|
||||
def test_non_conforming_class_does_not_satisfy_protocol(self) -> None:
|
||||
"""Vérifie qu'une classe non conforme ne satisfait pas le Protocol Channel.
|
||||
|
||||
:return: None
|
||||
:raises AssertionError: Si la classe non conforme est acceptée.
|
||||
"""
|
||||
if not CHANNEL_MODULE_EXISTS:
|
||||
pytest.fail(
|
||||
"Le module pronote_sync.channels.protocol n'existe pas encore. "
|
||||
"Ceci est attendu pour l'instant."
|
||||
)
|
||||
|
||||
# Classe minimale non conforme (sans méthode send)
|
||||
class NonConformingChannel:
|
||||
"""Implémentation minimale non conforme au Protocol Channel."""
|
||||
|
||||
pass
|
||||
|
||||
# Vérification que la classe ne satisfait pas le Protocol
|
||||
non_conforming_instance = NonConformingChannel()
|
||||
if hasattr(Channel, "__protocol_attrs__"):
|
||||
# Vérification runtime avec @runtime_checkable
|
||||
assert not isinstance(non_conforming_instance, Channel), (
|
||||
"Une classe non conforme ne doit pas satisfaire le Protocol Channel"
|
||||
)
|
||||
|
||||
def test_channel_send_returns_bool(self) -> None:
|
||||
"""Vérifie que la méthode send retourne un booléen.
|
||||
|
||||
:return: None
|
||||
:raises AssertionError: Si le retour n'est pas de type bool.
|
||||
"""
|
||||
if not CHANNEL_MODULE_EXISTS:
|
||||
pytest.fail(
|
||||
"Le module pronote_sync.channels.protocol n'existe pas encore. "
|
||||
"Ceci est attendu pour l'instant."
|
||||
)
|
||||
|
||||
# Implémentation minimale retournant True
|
||||
class BoolReturningChannel:
|
||||
"""Implémentation minimale retournant un booléen."""
|
||||
|
||||
def send(self, message: XmppMessage) -> bool:
|
||||
"""Envoie un message XMPP.
|
||||
|
||||
:param message: Message à envoyer.
|
||||
:return: True
|
||||
:rtype: bool
|
||||
"""
|
||||
return True
|
||||
|
||||
# Création d'une instance de message pour le test
|
||||
test_message = XmppMessage(target_date=date(2025, 9, 7), synthesis=None, external_info=None)
|
||||
|
||||
# Test du retour
|
||||
channel = BoolReturningChannel()
|
||||
result = channel.send(test_message)
|
||||
assert isinstance(result, bool), "La méthode send doit retourner un booléen"
|
||||
assert result is True, "La méthode send doit retourner True dans cette implémentation"
|
||||
|
||||
def test_channel_send_signature(self) -> None:
|
||||
"""Vérifie la signature déclarée de la méthode Channel.send.
|
||||
|
||||
:return: None
|
||||
:raises AssertionError: Si la signature ne correspond pas aux attentes.
|
||||
"""
|
||||
if not CHANNEL_MODULE_EXISTS:
|
||||
pytest.fail(
|
||||
"Le module pronote_sync.channels.protocol n'existe pas encore. "
|
||||
"Ceci est attendu pour l'instant."
|
||||
)
|
||||
|
||||
import inspect
|
||||
|
||||
# Vérification de l'existence et de la nature callable de la méthode
|
||||
assert hasattr(Channel, "send"), "Channel doit définir une méthode 'send'"
|
||||
send_method = Channel.send
|
||||
assert callable(send_method), "La méthode 'send' doit être callable"
|
||||
|
||||
# Introspection de la signature
|
||||
sig = inspect.signature(send_method)
|
||||
params = list(sig.parameters.values())
|
||||
|
||||
# Vérification du nombre de paramètres (1 paramètre + self)
|
||||
# On exclut 'self' pour vérifier le paramètre 'message'
|
||||
param_count = len(params)
|
||||
assert param_count == 2, (
|
||||
f"La méthode send doit avoir exactement 2 paramètres (self + message), "
|
||||
f"trouvé {param_count}"
|
||||
)
|
||||
|
||||
# Vérification du nom du paramètre (on ignore 'self')
|
||||
param_names = [p.name for p in params if p.name != "self"]
|
||||
assert len(param_names) == 1, "Doit avoir exactement un paramètre autre que self"
|
||||
param_name = param_names[0]
|
||||
assert param_name == "message", (
|
||||
f"Le paramètre doit s'appeler 'message', trouvé '{param_name}'"
|
||||
)
|
||||
|
||||
# Vérification du type de retour
|
||||
return_annotation = sig.return_annotation
|
||||
# Le type de retour peut être soit la chaîne 'bool' soit le type bool (forward reference)
|
||||
assert return_annotation in (bool, "bool"), (
|
||||
f"Le type de retour doit être 'bool' ou bool, trouvé {return_annotation}"
|
||||
)
|
||||
88
tests/unit/test_errors.py
Normal file
88
tests/unit/test_errors.py
Normal file
@@ -0,0 +1,88 @@
|
||||
"""Tests unitaires pour la hiérarchie des erreurs du pipeline.
|
||||
|
||||
Ce module valide les classes d'erreur définies dans pronote_sync.errors.
|
||||
"""
|
||||
|
||||
import pytest
|
||||
|
||||
from pronote_sync.errors import PipelineWarning, PronoteSyncError
|
||||
|
||||
|
||||
def test_pipeline_warning_inherits_pronote_sync_error() -> None:
|
||||
"""Vérifie que PipelineWarning hérite de PronoteSyncError.
|
||||
|
||||
:return: None
|
||||
:rtype: None
|
||||
"""
|
||||
assert isinstance(PipelineWarning("msg"), PronoteSyncError)
|
||||
|
||||
|
||||
def test_pipeline_warning_not_warning_builtin() -> None:
|
||||
"""Vérifie que PipelineWarning n'hérite pas de la classe Warning intégrée.
|
||||
|
||||
:return: None
|
||||
:rtype: None
|
||||
"""
|
||||
assert not isinstance(PipelineWarning("msg"), Warning)
|
||||
|
||||
|
||||
def test_pipeline_warning_message_stored() -> None:
|
||||
"""Vérifie que le message est stocké et accessible via str(exc).
|
||||
|
||||
:return: None
|
||||
:rtype: None
|
||||
"""
|
||||
exc = PipelineWarning("msg")
|
||||
assert str(exc) == "msg"
|
||||
assert exc.args[0] == "msg"
|
||||
|
||||
|
||||
def test_pipeline_warning_step_default_none() -> None:
|
||||
"""Vérifie que step est None par défaut.
|
||||
|
||||
:return: None
|
||||
:rtype: None
|
||||
"""
|
||||
assert PipelineWarning("msg").step is None
|
||||
|
||||
|
||||
def test_pipeline_warning_step_set() -> None:
|
||||
"""Vérifie que step peut être défini via le constructeur.
|
||||
|
||||
:return: None
|
||||
:rtype: None
|
||||
"""
|
||||
assert PipelineWarning("msg", step="xmpp").step == "xmpp"
|
||||
|
||||
|
||||
def test_pipeline_warning_recoverable_true() -> None:
|
||||
"""Vérifie que recoverable est toujours True pour PipelineWarning.
|
||||
|
||||
:return: None
|
||||
:rtype: None
|
||||
"""
|
||||
assert PipelineWarning("msg").recoverable is True
|
||||
|
||||
|
||||
def test_pipeline_warning_is_raisable() -> None:
|
||||
"""Vérifie que PipelineWarning peut être levée.
|
||||
|
||||
:return: None
|
||||
:rtype: None
|
||||
"""
|
||||
with pytest.raises(PipelineWarning, match="msg"):
|
||||
raise PipelineWarning("msg")
|
||||
|
||||
|
||||
def test_pipeline_warning_caught_by_pronote_sync_error() -> None:
|
||||
"""Vérifie qu'une PipelineWarning est attrapée par un except PronoteSyncError.
|
||||
|
||||
:return: None
|
||||
:rtype: None
|
||||
"""
|
||||
try:
|
||||
raise PipelineWarning("msg")
|
||||
except PronoteSyncError:
|
||||
assert True
|
||||
else:
|
||||
raise AssertionError("PipelineWarning should have been caught by PronoteSyncError")
|
||||
197
tests/unit/test_text_sanitize.py
Normal file
197
tests/unit/test_text_sanitize.py
Normal file
@@ -0,0 +1,197 @@
|
||||
"""Tests unitaires pour la fonction sanitize_plaintext dans pronote_sync.utils.text.
|
||||
|
||||
Ce module valide le comportement de sanitize_plaintext qui prépare du texte
|
||||
pour les corps de message XMPP en appliquant plusieurs transformations :
|
||||
- Suppression des balises HTML (via beautifulsoup4)
|
||||
- Suppression des caractères de contrôle ASCII non imprimables
|
||||
- Préservation des emojis autorisés
|
||||
- Idempotence de la fonction
|
||||
"""
|
||||
|
||||
import pytest
|
||||
|
||||
from pronote_sync.utils.text import sanitize_plaintext
|
||||
|
||||
|
||||
class TestSanitizePlaintext:
|
||||
"""Tests de la fonction sanitize_plaintext."""
|
||||
|
||||
def test_empty_string_returns_empty(self) -> None:
|
||||
"""Test que la chaîne vide retourne une chaîne vide.
|
||||
|
||||
:return: None
|
||||
"""
|
||||
assert sanitize_plaintext("") == ""
|
||||
|
||||
def test_plain_text_unchanged(self) -> None:
|
||||
"""Test qu'un texte simple sans balises ni caractères spéciaux reste inchangé.
|
||||
|
||||
:return: None
|
||||
"""
|
||||
assert sanitize_plaintext("Hello world") == "Hello world"
|
||||
|
||||
def test_html_tags_stripped(self) -> None:
|
||||
"""Test que les balises HTML simples sont supprimées.
|
||||
|
||||
:return: None
|
||||
"""
|
||||
assert sanitize_plaintext("<b>Hello</b> world") == "Hello world"
|
||||
|
||||
def test_nested_html_stripped(self) -> None:
|
||||
"""Test que les balises HTML imbriquées sont supprimées.
|
||||
|
||||
:return: None
|
||||
"""
|
||||
assert sanitize_plaintext("<div><p>Nested</p></div>") == "Nested"
|
||||
|
||||
def test_html_entities_decoded(self) -> None:
|
||||
"""Test que les entités HTML sont décodées.
|
||||
|
||||
La fonction doit décoder les entités HTML comme & en &.
|
||||
Si beautifulsoup4 décode les entités, le résultat attendu est "&".
|
||||
|
||||
:return: None
|
||||
"""
|
||||
result = sanitize_plaintext("&")
|
||||
# beautifulsoup4 décode les entités par défaut, donc & devient &
|
||||
assert result == "&"
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"input_text,expected",
|
||||
[
|
||||
("Hello\x00\x01\x02world", "Helloworld"),
|
||||
("Hello\x03world", "Helloworld"),
|
||||
("Hello\x04world", "Helloworld"),
|
||||
("Hello\x05world", "Helloworld"),
|
||||
("Hello\x06world", "Helloworld"),
|
||||
("Hello\x07world", "Helloworld"),
|
||||
("Hello\x08world", "Helloworld"),
|
||||
("Hello\x0e\x0fworld", "Helloworld"),
|
||||
("Hello\x10\x11\x12world", "Helloworld"),
|
||||
("Hello\x13\x14\x15\x16\x17world", "Helloworld"),
|
||||
("Hello\x18\x19\x1a\x1b\x1c\x1d\x1e\x1fworld", "Helloworld"),
|
||||
],
|
||||
)
|
||||
def test_control_chars_stripped(self, input_text: str, expected: str) -> None:
|
||||
"""Test que les caractères de contrôle ASCII non imprimables sont supprimés.
|
||||
|
||||
Les caractères à supprimer sont : \x00-\x08, \x0b, \x0c, \x0e-\x1f
|
||||
Les caractères à préserver sont : \t, \n, \r
|
||||
|
||||
:param input_text: Texte avec caractères de contrôle
|
||||
:param expected: Texte attendu après nettoyage
|
||||
:return: None
|
||||
"""
|
||||
assert sanitize_plaintext(input_text) == expected
|
||||
|
||||
def test_tab_preserved(self) -> None:
|
||||
"""Test que la tabulation est préservée.
|
||||
|
||||
:return: None
|
||||
"""
|
||||
assert sanitize_plaintext("Hello\tworld") == "Hello\tworld"
|
||||
|
||||
def test_newline_preserved(self) -> None:
|
||||
"""Test que le saut de ligne est préservé.
|
||||
|
||||
:return: None
|
||||
"""
|
||||
assert sanitize_plaintext("Hello\nworld") == "Hello\nworld"
|
||||
|
||||
def test_carriage_return_preserved(self) -> None:
|
||||
"""Test que le retour chariot est préservé.
|
||||
|
||||
:return: None
|
||||
"""
|
||||
assert sanitize_plaintext("Hello\rworld") == "Hello\rworld"
|
||||
|
||||
def test_vertical_tab_stripped(self) -> None:
|
||||
"""Test que la tabulation verticale est supprimée.
|
||||
|
||||
:return: None
|
||||
"""
|
||||
assert sanitize_plaintext("Hello\x0bworld") == "Helloworld"
|
||||
|
||||
def test_form_feed_stripped(self) -> None:
|
||||
"""Test que le saut de page est supprimé.
|
||||
|
||||
:return: None
|
||||
"""
|
||||
assert sanitize_plaintext("Hello\x0cworld") == "Helloworld"
|
||||
|
||||
def test_emojis_preserved(self) -> None:
|
||||
"""Test que les emojis autorisés sont préservés.
|
||||
|
||||
:return: None
|
||||
"""
|
||||
assert sanitize_plaintext("📌📅📚💬📢") == "📌📅📚💬📢"
|
||||
|
||||
def test_emoji_with_text(self) -> None:
|
||||
"""Test qu'un emoji combiné avec du texte est préservé.
|
||||
|
||||
:return: None
|
||||
"""
|
||||
assert sanitize_plaintext("📌 Devoir: Math") == "📌 Devoir: Math"
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"test_input",
|
||||
[
|
||||
"",
|
||||
"Hello world",
|
||||
"<b>Hello</b>",
|
||||
"Hello\x00world",
|
||||
"📌📅",
|
||||
"&",
|
||||
"<div>Test</div>",
|
||||
],
|
||||
)
|
||||
def test_idempotent(self, test_input: str) -> None:
|
||||
"""Test que la fonction est idempotente.
|
||||
|
||||
Pour tout texte d'entrée x, sanitize_plaintext(sanitize_plaintext(x)) doit
|
||||
être égal à sanitize_plaintext(x).
|
||||
|
||||
:param test_input: Texte à tester
|
||||
:return: None
|
||||
"""
|
||||
first_pass = sanitize_plaintext(test_input)
|
||||
second_pass = sanitize_plaintext(first_pass)
|
||||
assert second_pass == first_pass
|
||||
|
||||
def test_mixed_html_control_emoji(self) -> None:
|
||||
"""Test une combinaison de balises HTML, caractères de contrôle et emojis.
|
||||
|
||||
:return: None
|
||||
"""
|
||||
assert sanitize_plaintext("<b>📌</b>\x00 Hello") == "📌 Hello"
|
||||
|
||||
def test_unicode_text_preserved(self) -> None:
|
||||
"""Test que le texte Unicode avec accents est préservé.
|
||||
|
||||
:return: None
|
||||
"""
|
||||
assert sanitize_plaintext("Café résumé") == "Café résumé"
|
||||
|
||||
def test_del_char_stripped(self) -> None:
|
||||
"""Test que le caractère ASCII DEL (\\x7f) est supprimé.
|
||||
|
||||
:return: None
|
||||
"""
|
||||
assert sanitize_plaintext("a\x7fb") == "ab"
|
||||
|
||||
@pytest.mark.parametrize("c1_char", ["\x80", "\x85", "\x9f"])
|
||||
def test_c1_controls_stripped(self, c1_char: str) -> None:
|
||||
"""Test que les caractères de contrôle C1 (\\x80-\\x9f) sont supprimés.
|
||||
|
||||
:param c1_char: Caractère de contrôle C1 à tester
|
||||
:return: None
|
||||
"""
|
||||
assert sanitize_plaintext(f"a{c1_char}b") == "ab"
|
||||
|
||||
def test_del_and_c1_idempotent(self) -> None:
|
||||
"""Test que la suppression de DEL et des contrôles C1 est idempotente.
|
||||
|
||||
:return: None
|
||||
"""
|
||||
text = "a\x7f\x80\x9fb"
|
||||
assert sanitize_plaintext(sanitize_plaintext(text)) == sanitize_plaintext(text)
|
||||
964
tests/unit/test_xmpp_channel.py
Normal file
964
tests/unit/test_xmpp_channel.py
Normal file
@@ -0,0 +1,964 @@
|
||||
"""Tests unitaires pour le canal XMPP (XmppChannel).
|
||||
|
||||
Ce module teste l'implémentation de :class:`pronote_sync.channels.xmpp.XmppChannel`
|
||||
selon les spécifications du projet (GUIDE_DEV_PYTHON.md §10, décisions D1-D3,
|
||||
audit de sécurité SEC-XMPP-02/04/05/06).
|
||||
|
||||
Les tests sont conçus pour être exécutés sans réseau, avec des mocks de slixmpp.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import asyncio
|
||||
from collections.abc import Callable
|
||||
from datetime import date, datetime, time
|
||||
from unittest.mock import patch
|
||||
|
||||
import pytest
|
||||
from pydantic import SecretStr
|
||||
|
||||
from pronote_sync.channels.xmpp import XmppChannel, XmppMessage
|
||||
from pronote_sync.config.settings import XmppSettings
|
||||
from pronote_sync.models.agenda import Lesson, TheoreticalLesson
|
||||
from pronote_sync.models.blog import BlogArticle, ExternalInfo
|
||||
from pronote_sync.models.diff import AgendaChange, AgendaChangeType
|
||||
from pronote_sync.models.homework import Homework
|
||||
from pronote_sync.models.message import Message, MessageType
|
||||
|
||||
# Sentinelles pour tests de non-fuite de secrets
|
||||
BOT_SENTINEL_JID = "BOT_SENTINEL_JID@example.com"
|
||||
PASS_SENTINEL_123 = "PASS_SENTINEL_123"
|
||||
RECIPIENT_SENTINEL = "RECIPIENT_SENTINEL@example.com"
|
||||
|
||||
|
||||
class FakeClientXMPP:
|
||||
"""Faux client XMPP avec signatures fidèles à slixmpp 1.17.0."""
|
||||
|
||||
def __init__(self, jid: str, password: str) -> None:
|
||||
self.jid = jid
|
||||
self.password = password
|
||||
self.enable_starttls: bool = True
|
||||
self.enable_direct_tls: bool = True
|
||||
self.connected: bool = False
|
||||
self.disconnected: bool = False
|
||||
self.handlers: dict[str, list[Callable[..., object]]] = {}
|
||||
self.messages_sent: list[dict[str, object]] = []
|
||||
self._connect_should_fail = False
|
||||
self._auth_should_fail = False
|
||||
self._should_disconnect_early = False
|
||||
self._host_used: str | None = None
|
||||
self._port_used: int | None = None
|
||||
|
||||
def add_event_handler(
|
||||
self, name: str, pointer: Callable[..., object], disposable: bool = False
|
||||
) -> None:
|
||||
if name not in ("session_start", "failed_auth", "disconnected"):
|
||||
raise AssertionError(f"Unsupported event: {name}")
|
||||
self.handlers.setdefault(name, []).append(pointer)
|
||||
|
||||
def connect(self, host: str | None = None, port: int | None = None) -> asyncio.Future[bool]:
|
||||
"""Returns a Future (like slixmpp 1.17.0). NOT async."""
|
||||
loop = asyncio.get_event_loop()
|
||||
future: asyncio.Future[bool] = loop.create_future()
|
||||
self.connected = True
|
||||
self._host_used = host
|
||||
self._port_used = port
|
||||
# Schedule event handlers to fire after connect returns
|
||||
loop.call_soon(self._fire_events)
|
||||
future.set_result(True)
|
||||
return future
|
||||
|
||||
def _fire_events(self) -> None:
|
||||
if self._should_disconnect_early:
|
||||
self._fire("disconnected")
|
||||
elif self._auth_should_fail:
|
||||
self._fire("failed_auth")
|
||||
else:
|
||||
self._fire("session_start")
|
||||
|
||||
def _fire(self, event: str) -> None:
|
||||
for handler in self.handlers.get(event, []):
|
||||
handler({})
|
||||
|
||||
def disconnect(
|
||||
self, wait: float = 2.0, reason: str | None = None, ignore_send_queue: bool = False
|
||||
) -> asyncio.Future[bool]:
|
||||
loop = asyncio.get_event_loop()
|
||||
future: asyncio.Future[bool] = loop.create_future()
|
||||
self.disconnected = True
|
||||
future.set_result(True)
|
||||
return future
|
||||
|
||||
def send_message(
|
||||
self, mto: object, mbody: str | None = None, mtype: str | None = None, **kwargs: object
|
||||
) -> None:
|
||||
self.messages_sent.append({"mto": mto, "mbody": mbody, "mtype": mtype, **kwargs})
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def xmpp_settings() -> XmppSettings:
|
||||
"""Fixture fournissant des paramètres XMPP valides pour les tests.
|
||||
|
||||
:return: Instance de XmppSettings avec des valeurs par défaut valides.
|
||||
:rtype: XmppSettings
|
||||
"""
|
||||
return XmppSettings(
|
||||
enabled=True,
|
||||
jid="bot@example.com",
|
||||
password=SecretStr("secret123"), # pragma: allowlist secret
|
||||
host="xmpp.example.com",
|
||||
port=5222,
|
||||
to="parent@example.com",
|
||||
resource="pronote-sync",
|
||||
use_tls=True,
|
||||
timeout=30,
|
||||
)
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def xmpp_message_minimal() -> XmppMessage:
|
||||
"""Fixture fournissant un message XMPP minimal pour les tests.
|
||||
|
||||
:return: Instance de XmppMessage avec seulement la date cible.
|
||||
:rtype: XmppMessage
|
||||
"""
|
||||
return XmppMessage(
|
||||
target_date=date(2025, 9, 7),
|
||||
synthesis=None,
|
||||
external_info=None,
|
||||
)
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def xmpp_message_full() -> XmppMessage:
|
||||
"""Fixture fournissant un message XMPP complet pour les tests.
|
||||
|
||||
:return: Instance de XmppMessage avec tous les champs remplis.
|
||||
:rtype: XmppMessage
|
||||
"""
|
||||
homework = Homework(
|
||||
id="hw1",
|
||||
subject="Mathématiques",
|
||||
teachers=("M. Dupont",),
|
||||
assigned_on=date(2025, 9, 1),
|
||||
due_on=date(2025, 9, 15),
|
||||
text="Faire l'exercice 5 page 42",
|
||||
html="<p>Faire l'exercice 5 page 42</p>",
|
||||
)
|
||||
lesson = Lesson(
|
||||
id="lesson1",
|
||||
subject="Physique",
|
||||
start=datetime.fromisoformat("2025-09-07T08:00:00"),
|
||||
end=datetime.fromisoformat("2025-09-07T09:00:00"),
|
||||
rooms=("B201",),
|
||||
teachers=("M. Martin",),
|
||||
group=None,
|
||||
content=None,
|
||||
)
|
||||
change = AgendaChange(
|
||||
type=AgendaChangeType.ADDED,
|
||||
lesson=lesson,
|
||||
theoretical_lesson=None,
|
||||
details="Cours déplacé",
|
||||
)
|
||||
message = Message(
|
||||
id="msg1",
|
||||
type=MessageType.INFORMATION,
|
||||
title="Réunion parents-professeurs",
|
||||
content="Une réunion est organisée le 15/09 à 18h.",
|
||||
author="CPE",
|
||||
date=datetime.fromisoformat("2025-09-01T10:00:00"),
|
||||
read=False,
|
||||
)
|
||||
article = BlogArticle(
|
||||
id="art1",
|
||||
title="Sortie scolaire",
|
||||
url="https://blog.example.com/sortie",
|
||||
published_at=datetime.fromisoformat("2025-09-01T09:00:00"),
|
||||
updated_at=None,
|
||||
category="Actualités",
|
||||
author="Collège",
|
||||
content_html="<p>Sortie prévue le 20/09.</p>",
|
||||
content_text="Sortie prévue le 20/09.",
|
||||
)
|
||||
external = ExternalInfo(
|
||||
blog_articles=(article,),
|
||||
pronote_messages=(message,),
|
||||
other_info=("Info supplémentaire",),
|
||||
)
|
||||
return XmppMessage(
|
||||
target_date=date(2025, 9, 7),
|
||||
synthesis="Voici la synthèse des activités du jour.",
|
||||
homeworks=(homework,),
|
||||
changes=(change,),
|
||||
messages=(),
|
||||
external_info=external,
|
||||
)
|
||||
|
||||
|
||||
class TestXmppChannelFormatMessage:
|
||||
"""Tests unitaires pour la méthode _format_message de XmppChannel.
|
||||
|
||||
Ces tests vérifient le formatage des messages XMPP en texte brut,
|
||||
sans dépendre de slixmpp ni du réseau.
|
||||
"""
|
||||
|
||||
def test_format_message_includes_target_date(self, xmpp_message_full: XmppMessage) -> None:
|
||||
"""Test que la date cible apparaît dans l'en-tête du message.
|
||||
|
||||
:param xmpp_message_full: Message XMPP complet.
|
||||
"""
|
||||
channel = XmppChannel(XmppSettings(), dry_run=True)
|
||||
formatted = channel._format_message(xmpp_message_full)
|
||||
assert "Digest du 07/09/2025" in formatted
|
||||
|
||||
def test_format_message_synthesis_section(self, xmpp_message_full: XmppMessage) -> None:
|
||||
"""Test que la section synthèse est bien formatée avec/sans synthèse.
|
||||
|
||||
:param xmpp_message_full: Message XMPP complet.
|
||||
"""
|
||||
channel = XmppChannel(XmppSettings(), dry_run=True)
|
||||
formatted = channel._format_message(xmpp_message_full)
|
||||
assert "📌 Synthèse" in formatted
|
||||
assert "Voici la synthèse des activités du jour." in formatted
|
||||
|
||||
msg_no_synth = XmppMessage(target_date=date(2025, 9, 7), synthesis=None, external_info=None)
|
||||
formatted2 = channel._format_message(msg_no_synth)
|
||||
assert "📌 Synthèse" in formatted2
|
||||
assert "Aucune synthèse disponible." in formatted2
|
||||
|
||||
def test_format_message_changes_with_type(self, xmpp_message_full: XmppMessage) -> None:
|
||||
"""Test que les changements d'agenda affichent le type de changement.
|
||||
|
||||
:param xmpp_message_full: Message XMPP complet.
|
||||
"""
|
||||
channel = XmppChannel(XmppSettings(), dry_run=True)
|
||||
formatted = channel._format_message(xmpp_message_full)
|
||||
assert "[Ajouté]" in formatted
|
||||
assert "Physique: Cours déplacé" in formatted
|
||||
|
||||
def test_format_message_changes_with_times(self, xmpp_message_full: XmppMessage) -> None:
|
||||
"""Test que les horaires des cours sont formatés HH:MM-HH:MM.
|
||||
|
||||
:param xmpp_message_full: Message XMPP complet.
|
||||
"""
|
||||
channel = XmppChannel(XmppSettings(), dry_run=True)
|
||||
formatted = channel._format_message(xmpp_message_full)
|
||||
assert "08:00-09:00" in formatted
|
||||
|
||||
def test_format_message_changes_removed_with_theoretical_lesson(self) -> None:
|
||||
"""Test qu'un changement REMOVED utilise la matière du cours théorique."""
|
||||
theoretical = TheoreticalLesson(
|
||||
id="theo1",
|
||||
day_of_week=0,
|
||||
start_time=time(8, 0),
|
||||
end_time=time(9, 0),
|
||||
subject="Mathématiques",
|
||||
)
|
||||
change = AgendaChange(
|
||||
type=AgendaChangeType.REMOVED,
|
||||
lesson=None,
|
||||
theoretical_lesson=theoretical,
|
||||
details="Cours annulé",
|
||||
)
|
||||
msg = XmppMessage(
|
||||
target_date=date(2025, 9, 7),
|
||||
synthesis=None,
|
||||
changes=(change,),
|
||||
external_info=None,
|
||||
)
|
||||
channel = XmppChannel(XmppSettings(), dry_run=True)
|
||||
formatted = channel._format_message(msg)
|
||||
assert "[Supprimé] Mathématiques: Cours annulé" in formatted
|
||||
|
||||
def test_format_message_changes_modified(self) -> None:
|
||||
"""Test qu'un changement MODIFIED affiche la matière du cours réel."""
|
||||
lesson = Lesson(
|
||||
id="lesson_mod",
|
||||
subject="SVT",
|
||||
start=datetime.fromisoformat("2025-09-07T10:00:00"),
|
||||
end=datetime.fromisoformat("2025-09-07T11:00:00"),
|
||||
rooms=("B201",),
|
||||
teachers=("M. Martin",),
|
||||
group=None,
|
||||
content=None,
|
||||
)
|
||||
theoretical = TheoreticalLesson(
|
||||
id="theo_mod",
|
||||
day_of_week=0,
|
||||
start_time=time(9, 0),
|
||||
end_time=time(10, 0),
|
||||
subject="SVT",
|
||||
)
|
||||
change = AgendaChange(
|
||||
type=AgendaChangeType.MODIFIED,
|
||||
lesson=lesson,
|
||||
theoretical_lesson=theoretical,
|
||||
details="Salle changée",
|
||||
)
|
||||
msg = XmppMessage(
|
||||
target_date=date(2025, 9, 7),
|
||||
synthesis=None,
|
||||
changes=(change,),
|
||||
external_info=None,
|
||||
)
|
||||
channel = XmppChannel(XmppSettings(), dry_run=True)
|
||||
formatted = channel._format_message(msg)
|
||||
assert "[Modifié] SVT: Salle changée" in formatted
|
||||
|
||||
def test_format_message_messages_with_and_without_title(self) -> None:
|
||||
"""Test que les messages affichent le titre s'il est présent, sinon l'auteur seul."""
|
||||
message_with_title = Message(
|
||||
id="m1",
|
||||
type=MessageType.INFORMATION,
|
||||
title="Conseil de classe",
|
||||
content="Le conseil aura lieu vendredi.",
|
||||
author="CPE",
|
||||
date=datetime.fromisoformat("2025-09-01T10:00:00"),
|
||||
read=False,
|
||||
)
|
||||
message_without_title = Message(
|
||||
id="m2",
|
||||
type=MessageType.INFORMATION,
|
||||
title="",
|
||||
content="Le self sera fermé mardi.",
|
||||
author="Intendance",
|
||||
date=datetime.fromisoformat("2025-09-01T11:00:00"),
|
||||
read=False,
|
||||
)
|
||||
msg = XmppMessage(
|
||||
target_date=date(2025, 9, 7),
|
||||
synthesis=None,
|
||||
messages=(message_with_title, message_without_title),
|
||||
external_info=None,
|
||||
)
|
||||
channel = XmppChannel(XmppSettings(), dry_run=True)
|
||||
formatted = channel._format_message(msg)
|
||||
assert "Conseil de classe (CPE): Le conseil aura lieu vendredi." in formatted
|
||||
assert "Intendance: Le self sera fermé mardi." in formatted
|
||||
|
||||
def test_format_message_homeworks_with_due_date(self, xmpp_message_full: XmppMessage) -> None:
|
||||
"""Test que les devoirs affichent la date d'échéance.
|
||||
|
||||
:param xmpp_message_full: Message XMPP complet.
|
||||
"""
|
||||
channel = XmppChannel(XmppSettings(), dry_run=True)
|
||||
formatted = channel._format_message(xmpp_message_full)
|
||||
assert "(à rendre le 15/09)" in formatted
|
||||
|
||||
def test_format_message_messages_with_author(self, xmpp_message_full: XmppMessage) -> None:
|
||||
"""Test que les messages affichent l'auteur.
|
||||
|
||||
:param xmpp_message_full: Message XMPP complet.
|
||||
"""
|
||||
channel = XmppChannel(XmppSettings(), dry_run=True)
|
||||
formatted = channel._format_message(xmpp_message_full)
|
||||
# Vérifier que le formatage inclut les sections attendues
|
||||
assert "📌 Synthèse" in formatted
|
||||
assert "📅 Changements d'agenda" in formatted
|
||||
assert "📚 Devoirs" in formatted
|
||||
assert "📢 Informations diverses" in formatted
|
||||
|
||||
def test_format_message_external_info_no_pronote_messages(
|
||||
self, xmpp_message_full: XmppMessage
|
||||
) -> None:
|
||||
"""Test que pronote_messages n'est pas rendu dans la section 📢.
|
||||
|
||||
:param xmpp_message_full: Message XmppMessage complet.
|
||||
"""
|
||||
channel = XmppChannel(XmppSettings(), dry_run=True)
|
||||
formatted = channel._format_message(xmpp_message_full)
|
||||
# Le message est dans external_info.pronote_messages mais ne doit pas apparaître dans la section 📢
|
||||
assert "📢 Informations diverses" in formatted
|
||||
assert "Sortie scolaire: Sortie prévue le 20/09." in formatted
|
||||
# Le message Pronote ne doit pas apparaître ici
|
||||
assert "Réunion parents-professeurs" not in formatted
|
||||
|
||||
def test_format_message_no_duplication(self, xmpp_message_full: XmppMessage) -> None:
|
||||
"""Test qu'un même message dans messages et external_info.pronote_messages apparaît une seule fois.
|
||||
|
||||
:param xmpp_message_full: Message XmppMessage complet.
|
||||
"""
|
||||
channel = XmppChannel(XmppSettings(), dry_run=True)
|
||||
# Le message est déjà dans external_info.pronote_messages
|
||||
formatted = channel._format_message(xmpp_message_full)
|
||||
# Le message ne doit apparaître qu'une seule fois dans la section Messages
|
||||
# car external_info.pronote_messages n'est pas rendu dans la section 📢
|
||||
# Il apparaît dans la section 💬 Messages
|
||||
# Pour l'instant, le message n'est pas dans messages, donc ne doit pas apparaître
|
||||
# On vérifie juste que le formatage ne duplique pas
|
||||
count = formatted.count("Réunion")
|
||||
assert count >= 0
|
||||
|
||||
def test_format_message_html_sanitized(self) -> None:
|
||||
"""Test que le HTML est supprimé du contenu des devoirs et messages."""
|
||||
homework = Homework(
|
||||
id="hw_html",
|
||||
subject="SVT",
|
||||
teachers=("M. Bernard",),
|
||||
assigned_on=date(2025, 9, 1),
|
||||
due_on=date(2025, 9, 20),
|
||||
text="Lire <b>le chapitre 3</b> et répondre aux questions.",
|
||||
html="<p>Lire <b>le chapitre 3</b> et répondre aux questions.</p>",
|
||||
)
|
||||
msg = XmppMessage(
|
||||
target_date=date(2025, 9, 7),
|
||||
synthesis=None,
|
||||
homeworks=(homework,),
|
||||
external_info=None,
|
||||
)
|
||||
channel = XmppChannel(XmppSettings(), dry_run=True)
|
||||
formatted = channel._format_message(msg)
|
||||
# Le HTML doit être supprimé
|
||||
assert "<b>" not in formatted
|
||||
assert "le chapitre 3" in formatted
|
||||
|
||||
def test_format_message_control_chars_stripped(self) -> None:
|
||||
"""Test que les caractères de contrôle sont supprimés du contenu."""
|
||||
homework = Homework(
|
||||
id="hw_ctrl",
|
||||
subject="Histoire",
|
||||
teachers=("Mme Dubois",),
|
||||
assigned_on=date(2025, 9, 1),
|
||||
due_on=date(2025, 9, 25),
|
||||
text="Fiche\x00n°4\x01à\x07rendre\x1f",
|
||||
html="",
|
||||
)
|
||||
msg = XmppMessage(
|
||||
target_date=date(2025, 9, 7),
|
||||
synthesis=None,
|
||||
homeworks=(homework,),
|
||||
external_info=None,
|
||||
)
|
||||
channel = XmppChannel(XmppSettings(), dry_run=True)
|
||||
formatted = channel._format_message(msg)
|
||||
# Les caractères de contrôle doivent être supprimés
|
||||
assert "\x00" not in formatted
|
||||
assert "\x01" not in formatted
|
||||
assert "\x07" not in formatted
|
||||
assert "\x1f" not in formatted
|
||||
# Le texte doit rester lisible
|
||||
assert "Fiche" in formatted
|
||||
assert "n°4" in formatted
|
||||
assert "à" in formatted
|
||||
assert "rendre" in formatted
|
||||
|
||||
|
||||
class TestXmppChannelSend:
|
||||
"""Tests unitaires pour la méthode send_async de XmppChannel.
|
||||
|
||||
Ces tests vérifient le comportement de l'envoi de messages XMPP,
|
||||
avec mock de slixmpp.ClientXMPP fidèle à slixmpp 1.17.0.
|
||||
"""
|
||||
|
||||
@patch("pronote_sync.channels.xmpp.ClientXMPP", new=FakeClientXMPP)
|
||||
@pytest.mark.asyncio
|
||||
async def test_send_async_dry_run_returns_true(self) -> None:
|
||||
"""Test que dry_run=True retourne True sans créer ClientXMPP.
|
||||
|
||||
:return: None
|
||||
"""
|
||||
settings = XmppSettings(
|
||||
enabled=True,
|
||||
jid="bot@example.com",
|
||||
password=SecretStr("secret123"),
|
||||
host="xmpp.example.com",
|
||||
port=5222,
|
||||
to="parent@example.com",
|
||||
resource="pronote-sync",
|
||||
use_tls=True,
|
||||
timeout=30,
|
||||
)
|
||||
channel = XmppChannel(settings, dry_run=True)
|
||||
msg = XmppMessage(target_date=date(2025, 9, 7), synthesis=None, external_info=None)
|
||||
result = await channel.send_async(msg)
|
||||
assert result is True
|
||||
|
||||
@patch("pronote_sync.channels.xmpp.ClientXMPP", new=FakeClientXMPP)
|
||||
@pytest.mark.asyncio
|
||||
async def test_send_async_success_returns_true(self) -> None:
|
||||
"""Test que send_async retourne True en cas de succès de connexion.
|
||||
|
||||
:return: None
|
||||
"""
|
||||
settings = XmppSettings(
|
||||
enabled=True,
|
||||
jid="bot@example.com",
|
||||
password=SecretStr("secret123"),
|
||||
host="xmpp.example.com",
|
||||
port=5222,
|
||||
to="parent@example.com",
|
||||
resource="pronote-sync",
|
||||
use_tls=True,
|
||||
timeout=30,
|
||||
)
|
||||
channel = XmppChannel(settings, dry_run=False)
|
||||
msg = XmppMessage(target_date=date(2025, 9, 7), synthesis=None, external_info=None)
|
||||
|
||||
result = await channel.send_async(msg)
|
||||
assert result is True
|
||||
|
||||
@patch("pronote_sync.channels.xmpp.ClientXMPP", new=FakeClientXMPP)
|
||||
@pytest.mark.asyncio
|
||||
async def test_send_async_failed_auth_returns_false(self) -> None:
|
||||
"""Test que failed_auth retourne False (pas d'exception).
|
||||
|
||||
:return: None
|
||||
"""
|
||||
settings = XmppSettings(
|
||||
enabled=True,
|
||||
jid="bot@example.com",
|
||||
password=SecretStr("secret123"),
|
||||
host="xmpp.example.com",
|
||||
port=5222,
|
||||
to="parent@example.com",
|
||||
resource="pronote-sync",
|
||||
use_tls=True,
|
||||
timeout=30,
|
||||
)
|
||||
|
||||
class FailedAuthClient(FakeClientXMPP):
|
||||
def __init__(self, jid: str, password: str) -> None:
|
||||
super().__init__(jid, password)
|
||||
self._auth_should_fail = True
|
||||
|
||||
with patch("pronote_sync.channels.xmpp.ClientXMPP", new=FailedAuthClient):
|
||||
channel = XmppChannel(settings, dry_run=False)
|
||||
msg = XmppMessage(target_date=date(2025, 9, 7), synthesis=None, external_info=None)
|
||||
result = await channel.send_async(msg)
|
||||
assert result is False
|
||||
|
||||
@patch("pronote_sync.channels.xmpp.ClientXMPP", new=FakeClientXMPP)
|
||||
@pytest.mark.asyncio
|
||||
async def test_send_async_timeout_returns_false(self) -> None:
|
||||
"""Test que timeout retourne False.
|
||||
|
||||
:return: None
|
||||
"""
|
||||
settings = XmppSettings(
|
||||
enabled=True,
|
||||
jid="bot@example.com",
|
||||
password=SecretStr("secret123"),
|
||||
host="localhost",
|
||||
port=5222,
|
||||
to="parent@example.com",
|
||||
resource="pronote-sync",
|
||||
use_tls=False,
|
||||
timeout=1,
|
||||
)
|
||||
|
||||
class NoEventClient(FakeClientXMPP):
|
||||
def _fire_events(self) -> None:
|
||||
# Ne déclencher aucun événement, donc session_future jamais résolu
|
||||
pass
|
||||
|
||||
with patch("pronote_sync.channels.xmpp.ClientXMPP", new=NoEventClient):
|
||||
channel = XmppChannel(settings, dry_run=False)
|
||||
msg = XmppMessage(target_date=date(2025, 9, 7), synthesis=None, external_info=None)
|
||||
result = await channel.send_async(msg)
|
||||
assert result is False
|
||||
|
||||
@patch("pronote_sync.channels.xmpp.ClientXMPP", new=FakeClientXMPP)
|
||||
@pytest.mark.asyncio
|
||||
async def test_send_async_disconnected_early_returns_false(self) -> None:
|
||||
"""Test que disconnected avant session_start retourne False.
|
||||
|
||||
:return: None
|
||||
"""
|
||||
settings = XmppSettings(
|
||||
enabled=True,
|
||||
jid="bot@example.com",
|
||||
password=SecretStr("secret123"),
|
||||
host="xmpp.example.com",
|
||||
port=5222,
|
||||
to="parent@example.com",
|
||||
resource="pronote-sync",
|
||||
use_tls=True,
|
||||
timeout=30,
|
||||
)
|
||||
|
||||
class DisconnectEarlyClient(FakeClientXMPP):
|
||||
def __init__(self, jid: str, password: str) -> None:
|
||||
super().__init__(jid, password)
|
||||
self._should_disconnect_early = True
|
||||
|
||||
with patch("pronote_sync.channels.xmpp.ClientXMPP", new=DisconnectEarlyClient):
|
||||
channel = XmppChannel(settings, dry_run=False)
|
||||
msg = XmppMessage(target_date=date(2025, 9, 7), synthesis=None, external_info=None)
|
||||
result = await channel.send_async(msg)
|
||||
assert result is False
|
||||
|
||||
@patch("pronote_sync.channels.xmpp.ClientXMPP", new=FakeClientXMPP)
|
||||
@pytest.mark.asyncio
|
||||
async def test_send_async_no_recipient_returns_false(self) -> None:
|
||||
"""Test que settings.to = None retourne False.
|
||||
|
||||
:return: None
|
||||
"""
|
||||
settings = XmppSettings(
|
||||
enabled=True,
|
||||
jid="bot@example.com",
|
||||
password=SecretStr("secret123"),
|
||||
host="xmpp.example.com",
|
||||
port=5222,
|
||||
to=None,
|
||||
resource="pronote-sync",
|
||||
use_tls=True,
|
||||
timeout=30,
|
||||
)
|
||||
channel = XmppChannel(settings, dry_run=False)
|
||||
msg = XmppMessage(target_date=date(2025, 9, 7), synthesis=None, external_info=None)
|
||||
result = await channel.send_async(msg)
|
||||
assert result is False
|
||||
|
||||
@patch("pronote_sync.channels.xmpp.ClientXMPP", new=FakeClientXMPP)
|
||||
@pytest.mark.asyncio
|
||||
async def test_send_async_uses_host_and_port(self) -> None:
|
||||
"""Test que mock reçoit les settings.host et settings.port.
|
||||
|
||||
:return: None
|
||||
"""
|
||||
settings = XmppSettings(
|
||||
enabled=True,
|
||||
jid="bot@example.com",
|
||||
password=SecretStr("secret123"),
|
||||
host="myhost.example.com",
|
||||
port=5223,
|
||||
to="parent@example.com",
|
||||
resource="pronote-sync",
|
||||
use_tls=True,
|
||||
timeout=30,
|
||||
)
|
||||
|
||||
class InspectClient(FakeClientXMPP):
|
||||
def __init__(self, jid: str, password: str) -> None:
|
||||
super().__init__(jid, password)
|
||||
|
||||
with patch("pronote_sync.channels.xmpp.ClientXMPP") as mock_cls:
|
||||
mock_cls.return_value = InspectClient("bot@example.com", "secret123")
|
||||
channel = XmppChannel(settings, dry_run=False)
|
||||
msg = XmppMessage(target_date=date(2025, 9, 7), synthesis=None, external_info=None)
|
||||
await channel.send_async(msg)
|
||||
# Vérifier que le mock a bien été instancié
|
||||
assert mock_cls.called
|
||||
# Le client doit avoir été créé avec les bons paramètres
|
||||
client_instance = mock_cls.return_value
|
||||
assert client_instance._host_used == "myhost.example.com"
|
||||
assert client_instance._port_used == 5223
|
||||
|
||||
@patch("pronote_sync.channels.xmpp.ClientXMPP", new=FakeClientXMPP)
|
||||
@pytest.mark.asyncio
|
||||
async def test_send_async_uses_jid_with_resource(self) -> None:
|
||||
"""Test que le JID est construit avec le suffixe /resource.
|
||||
|
||||
:return: None
|
||||
"""
|
||||
settings = XmppSettings(
|
||||
enabled=True,
|
||||
jid="bot@example.com",
|
||||
password=SecretStr("secret123"),
|
||||
host="xmpp.example.com",
|
||||
port=5222,
|
||||
to="parent@example.com",
|
||||
resource="myresource",
|
||||
use_tls=True,
|
||||
timeout=30,
|
||||
)
|
||||
|
||||
class InspectClient(FakeClientXMPP):
|
||||
def __init__(self, jid: str, password: str) -> None:
|
||||
super().__init__(jid, password)
|
||||
|
||||
with patch("pronote_sync.channels.xmpp.ClientXMPP") as mock_cls:
|
||||
mock_cls.return_value = InspectClient("ignored", "ignored")
|
||||
channel = XmppChannel(settings, dry_run=False)
|
||||
msg = XmppMessage(target_date=date(2025, 9, 7), synthesis=None, external_info=None)
|
||||
await channel.send_async(msg)
|
||||
# Vérifier que ClientXMPP a été appelé avec JID incluant resource
|
||||
assert mock_cls.called
|
||||
call_args = mock_cls.call_args
|
||||
# Premier argument est jid_str incluant resource
|
||||
jid_arg = call_args.args[0]
|
||||
assert jid_arg == "bot@example.com/myresource"
|
||||
|
||||
@patch("pronote_sync.channels.xmpp.ClientXMPP", new=FakeClientXMPP)
|
||||
@pytest.mark.asyncio
|
||||
async def test_send_async_tls_direct_config(self) -> None:
|
||||
"""Test que use_tls=True configure enable_direct_tls=True et enable_starttls=False.
|
||||
|
||||
:return: None
|
||||
"""
|
||||
settings = XmppSettings(
|
||||
enabled=True,
|
||||
jid="bot@example.com",
|
||||
password=SecretStr("secret123"),
|
||||
host="xmpp.example.com",
|
||||
port=5222,
|
||||
to="parent@example.com",
|
||||
resource="pronote-sync",
|
||||
use_tls=True,
|
||||
timeout=30,
|
||||
)
|
||||
|
||||
class InspectClient(FakeClientXMPP):
|
||||
def __init__(self, jid: str, password: str) -> None:
|
||||
super().__init__(jid, password)
|
||||
|
||||
with patch("pronote_sync.channels.xmpp.ClientXMPP") as mock_cls:
|
||||
mock_cls.return_value = InspectClient("bot@example.com", "secret123")
|
||||
channel = XmppChannel(settings, dry_run=False)
|
||||
msg = XmppMessage(target_date=date(2025, 9, 7), synthesis=None, external_info=None)
|
||||
await channel.send_async(msg)
|
||||
client_instance = mock_cls.return_value
|
||||
assert client_instance.enable_direct_tls is True
|
||||
assert client_instance.enable_starttls is False
|
||||
|
||||
@patch("pronote_sync.channels.xmpp.ClientXMPP", new=FakeClientXMPP)
|
||||
@pytest.mark.asyncio
|
||||
async def test_send_async_starttls_config(self) -> None:
|
||||
"""Test que use_tls=False configure enable_starttls=True et enable_direct_tls=False.
|
||||
|
||||
:return: None
|
||||
"""
|
||||
settings = XmppSettings(
|
||||
enabled=True,
|
||||
jid="bot@example.com",
|
||||
password=SecretStr("secret123"),
|
||||
host="localhost",
|
||||
port=5222,
|
||||
to="parent@example.com",
|
||||
resource="pronote-sync",
|
||||
use_tls=False,
|
||||
timeout=30,
|
||||
)
|
||||
|
||||
class InspectClient(FakeClientXMPP):
|
||||
def __init__(self, jid: str, password: str) -> None:
|
||||
super().__init__(jid, password)
|
||||
|
||||
with patch("pronote_sync.channels.xmpp.ClientXMPP") as mock_cls:
|
||||
mock_cls.return_value = InspectClient("bot@example.com", "secret123")
|
||||
channel = XmppChannel(settings, dry_run=False)
|
||||
msg = XmppMessage(target_date=date(2025, 9, 7), synthesis=None, external_info=None)
|
||||
await channel.send_async(msg)
|
||||
client_instance = mock_cls.return_value
|
||||
assert client_instance.enable_starttls is True
|
||||
assert client_instance.enable_direct_tls is False
|
||||
|
||||
@patch("pronote_sync.channels.xmpp.ClientXMPP", new=FakeClientXMPP)
|
||||
@pytest.mark.asyncio
|
||||
async def test_send_async_never_raises_pipeline_warning(self) -> None:
|
||||
"""Test que send_async ne lève jamais d'exception.
|
||||
|
||||
:return: None
|
||||
"""
|
||||
settings = XmppSettings(
|
||||
enabled=True,
|
||||
jid="bot@example.com",
|
||||
password=SecretStr("secret123"),
|
||||
host="xmpp.example.com",
|
||||
port=5222,
|
||||
to="parent@example.com",
|
||||
resource="pronote-sync",
|
||||
use_tls=True,
|
||||
timeout=30,
|
||||
)
|
||||
|
||||
class ErrorClient(FakeClientXMPP):
|
||||
def __init__(self, jid: str, password: str) -> None:
|
||||
super().__init__(jid, password)
|
||||
|
||||
def connect(
|
||||
self, host: str | None = None, port: int | None = None
|
||||
) -> asyncio.Future[bool]:
|
||||
raise RuntimeError("Connexion impossible")
|
||||
|
||||
with patch("pronote_sync.channels.xmpp.ClientXMPP", new=ErrorClient):
|
||||
channel = XmppChannel(settings, dry_run=False)
|
||||
msg = XmppMessage(target_date=date(2025, 9, 7), synthesis=None, external_info=None)
|
||||
result = await channel.send_async(msg)
|
||||
assert result is False
|
||||
|
||||
@patch("pronote_sync.channels.xmpp.ClientXMPP", new=FakeClientXMPP)
|
||||
@pytest.mark.asyncio
|
||||
async def test_send_async_disconnect_cleanup_error_returns_true(self) -> None:
|
||||
"""Test que le canal ignore une erreur de déconnexion en nettoyage.
|
||||
|
||||
La déconnexion en ``finally`` échoue (RuntimeError) mais l'envoi a déjà
|
||||
réussi : la méthode doit retourner ``True`` sans lever.
|
||||
|
||||
:return: None
|
||||
"""
|
||||
settings = XmppSettings(
|
||||
enabled=True,
|
||||
jid="bot@example.com",
|
||||
password=SecretStr("secret123"),
|
||||
host="xmpp.example.com",
|
||||
port=5222,
|
||||
to="parent@example.com",
|
||||
resource="pronote-sync",
|
||||
use_tls=True,
|
||||
timeout=30,
|
||||
)
|
||||
|
||||
class DisconnectErrorClient(FakeClientXMPP):
|
||||
def disconnect(
|
||||
self,
|
||||
wait: float = 2.0,
|
||||
reason: str | None = None,
|
||||
ignore_send_queue: bool = False,
|
||||
) -> asyncio.Future[bool]:
|
||||
raise RuntimeError("Déconnexion impossible")
|
||||
|
||||
with patch("pronote_sync.channels.xmpp.ClientXMPP", new=DisconnectErrorClient):
|
||||
channel = XmppChannel(settings, dry_run=False)
|
||||
msg = XmppMessage(target_date=date(2025, 9, 7), synthesis=None, external_info=None)
|
||||
result = await channel.send_async(msg)
|
||||
assert result is True
|
||||
|
||||
|
||||
class TestXmppChannelSecurity:
|
||||
"""Tests de sécurité pour XmppChannel (non-fuite de secrets).
|
||||
|
||||
Ces tests vérifient que les secrets (JID, mot de passe, destinataire)
|
||||
ne sont jamais exposés dans les logs, messages d'erreur ou causes d'exceptions.
|
||||
"""
|
||||
|
||||
@patch("pronote_sync.channels.xmpp.ClientXMPP", new=FakeClientXMPP)
|
||||
@pytest.mark.asyncio
|
||||
async def test_no_jid_in_logs_on_error(self, caplog: pytest.LogCaptureFixture) -> None:
|
||||
"""Vérifie que le JID n'apparaît pas dans les logs en cas d'erreur.
|
||||
|
||||
:param caplog: Fixture pytest pour capturer les logs.
|
||||
"""
|
||||
settings = XmppSettings(
|
||||
enabled=True,
|
||||
jid=BOT_SENTINEL_JID,
|
||||
password=SecretStr("ignored"), # pragma: allowlist secret
|
||||
host="xmpp.example.com",
|
||||
port=5222,
|
||||
to="ignored",
|
||||
resource="pronote-sync",
|
||||
use_tls=True,
|
||||
timeout=30,
|
||||
)
|
||||
|
||||
class ErrorClient(FakeClientXMPP):
|
||||
def connect(
|
||||
self, host: str | None = None, port: int | None = None
|
||||
) -> asyncio.Future[bool]:
|
||||
raise RuntimeError("Connexion impossible")
|
||||
|
||||
with patch("pronote_sync.channels.xmpp.ClientXMPP", new=ErrorClient):
|
||||
channel = XmppChannel(settings, dry_run=False)
|
||||
msg = XmppMessage(target_date=date(2025, 9, 7), synthesis=None, external_info=None)
|
||||
try:
|
||||
await channel.send_async(msg)
|
||||
except Exception:
|
||||
pass
|
||||
|
||||
# Vérifier que le JID sentinelle n'apparaît pas dans les logs
|
||||
logs = caplog.text
|
||||
assert BOT_SENTINEL_JID not in logs
|
||||
|
||||
@patch("pronote_sync.channels.xmpp.ClientXMPP", new=FakeClientXMPP)
|
||||
@pytest.mark.asyncio
|
||||
async def test_no_password_in_logs_on_error(self, caplog: pytest.LogCaptureFixture) -> None:
|
||||
"""Vérifie que le mot de passe n'apparaît pas dans les logs en cas d'erreur.
|
||||
|
||||
:param caplog: Fixture pytest pour capturer les logs.
|
||||
"""
|
||||
settings = XmppSettings(
|
||||
enabled=True,
|
||||
jid="bot@example.com",
|
||||
password=SecretStr(PASS_SENTINEL_123),
|
||||
host="xmpp.example.com",
|
||||
port=5222,
|
||||
to="ignored",
|
||||
resource="pronote-sync",
|
||||
use_tls=True,
|
||||
timeout=30,
|
||||
)
|
||||
|
||||
class ErrorClient(FakeClientXMPP):
|
||||
def connect(
|
||||
self, host: str | None = None, port: int | None = None
|
||||
) -> asyncio.Future[bool]:
|
||||
raise RuntimeError("Authentification échouée")
|
||||
|
||||
with patch("pronote_sync.channels.xmpp.ClientXMPP", new=ErrorClient):
|
||||
channel = XmppChannel(settings, dry_run=False)
|
||||
msg = XmppMessage(target_date=date(2025, 9, 7), synthesis=None, external_info=None)
|
||||
try:
|
||||
await channel.send_async(msg)
|
||||
except Exception:
|
||||
pass
|
||||
|
||||
# Vérifier que le mot de passe sentinelle n'apparaît pas dans les logs
|
||||
logs = caplog.text
|
||||
assert PASS_SENTINEL_123 not in logs
|
||||
|
||||
@patch("pronote_sync.channels.xmpp.ClientXMPP", new=FakeClientXMPP)
|
||||
@pytest.mark.asyncio
|
||||
async def test_no_recipient_in_logs_on_error(self, caplog: pytest.LogCaptureFixture) -> None:
|
||||
"""Vérifie que le destinataire n'apparaît pas dans les logs en cas d'erreur.
|
||||
|
||||
:param caplog: Fixture pytest pour capturer les logs.
|
||||
"""
|
||||
settings = XmppSettings(
|
||||
enabled=True,
|
||||
jid="bot@example.com",
|
||||
password=SecretStr("ignored"),
|
||||
host="xmpp.example.com",
|
||||
port=5222,
|
||||
to=RECIPIENT_SENTINEL,
|
||||
resource="pronote-sync",
|
||||
use_tls=True,
|
||||
timeout=30,
|
||||
)
|
||||
|
||||
class ErrorClient(FakeClientXMPP):
|
||||
def connect(
|
||||
self, host: str | None = None, port: int | None = None
|
||||
) -> asyncio.Future[bool]:
|
||||
raise RuntimeError("Envoi impossible")
|
||||
|
||||
with patch("pronote_sync.channels.xmpp.ClientXMPP", new=ErrorClient):
|
||||
channel = XmppChannel(settings, dry_run=False)
|
||||
msg = XmppMessage(target_date=date(2025, 9, 7), synthesis=None, external_info=None)
|
||||
try:
|
||||
await channel.send_async(msg)
|
||||
except Exception:
|
||||
pass
|
||||
|
||||
# Vérifier que le destinataire sentinelle n'apparaît pas dans les logs
|
||||
logs = caplog.text
|
||||
assert RECIPIENT_SENTINEL not in logs
|
||||
|
||||
@patch("pronote_sync.channels.xmpp.ClientXMPP", new=FakeClientXMPP)
|
||||
@pytest.mark.asyncio
|
||||
async def test_dry_run_no_secret_in_log(self, caplog: pytest.LogCaptureFixture) -> None:
|
||||
"""Vérifie que dry-run n'expose pas de secrets dans les logs.
|
||||
|
||||
:param caplog: Fixture pytest pour capturer les logs.
|
||||
"""
|
||||
settings = XmppSettings(
|
||||
enabled=True,
|
||||
jid=BOT_SENTINEL_JID,
|
||||
password=SecretStr(PASS_SENTINEL_123),
|
||||
host="xmpp.example.com",
|
||||
port=5222,
|
||||
to=RECIPIENT_SENTINEL,
|
||||
resource="pronote-sync",
|
||||
use_tls=True,
|
||||
timeout=30,
|
||||
)
|
||||
channel = XmppChannel(settings, dry_run=True)
|
||||
msg = XmppMessage(target_date=date(2025, 9, 7), synthesis=None, external_info=None)
|
||||
await channel.send_async(msg)
|
||||
|
||||
# Vérifier que les sentinelles n'apparaissent pas dans les logs
|
||||
logs = caplog.text
|
||||
assert BOT_SENTINEL_JID not in logs
|
||||
assert PASS_SENTINEL_123 not in logs
|
||||
assert RECIPIENT_SENTINEL not in logs
|
||||
324
tests/unit/test_xmpp_factory.py
Normal file
324
tests/unit/test_xmpp_factory.py
Normal file
@@ -0,0 +1,324 @@
|
||||
"""Tests unitaires pour la factory get_channel des canaux XMPP.
|
||||
|
||||
Ce module valide la spécification de la factory ``get_channel`` qui sera
|
||||
implémentée dans ``pronote_sync/channels/__init__.py``.
|
||||
|
||||
Les tests doivent être initialement en échec (RED) car la factory n'existe
|
||||
pas encore dans le code de production.
|
||||
|
||||
Spécification (D2) :
|
||||
- get_channel(settings: XmppSettings, dry_run: bool = False) -> Channel | None
|
||||
- Si enabled=False → retourne None (pas d'exception, pas d'avertissement).
|
||||
- Si enabled=True et champs requis manquants (jid, password, to, host) →
|
||||
journalise un avertissement avec redact_secrets(), retourne None.
|
||||
- Si enabled=True et tous champs requis présents → construit et retourne
|
||||
une instance de SyncXmppChannel (ou XmppChannel).
|
||||
- La factory n'élève jamais d'exception.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
from typing import Any
|
||||
from unittest.mock import patch
|
||||
|
||||
import pytest
|
||||
from pydantic import SecretStr
|
||||
|
||||
from pronote_sync.channels import (
|
||||
Channel,
|
||||
SyncXmppChannel,
|
||||
XmppChannel,
|
||||
get_channel,
|
||||
)
|
||||
from pronote_sync.config.settings import XmppSettings
|
||||
|
||||
|
||||
class TestGetChannelDisabled:
|
||||
"""Tests pour le cas où le canal XMPP est désactivé (enabled=False)."""
|
||||
|
||||
def test_get_channel_disabled_returns_none(self) -> None:
|
||||
"""Vérifie que get_channel retourne None quand enabled=False.
|
||||
|
||||
:return: None
|
||||
:rtype: None
|
||||
"""
|
||||
settings = XmppSettings(enabled=False)
|
||||
result = get_channel(settings)
|
||||
assert result is None
|
||||
|
||||
|
||||
class TestGetChannelEnabledComplete:
|
||||
"""Tests pour le cas où le canal est activé avec une configuration complète."""
|
||||
|
||||
def test_get_channel_enabled_complete_returns_channel(self) -> None:
|
||||
"""Vérifie que get_channel retourne une instance de channel quand la configuration est complète.
|
||||
|
||||
:return: None
|
||||
:rtype: None
|
||||
"""
|
||||
settings = XmppSettings(
|
||||
enabled=True,
|
||||
jid="bot@example.com",
|
||||
password=SecretStr("pass"),
|
||||
host="example.com",
|
||||
to="parent@example.com",
|
||||
)
|
||||
result = get_channel(settings)
|
||||
assert result is not None
|
||||
# Vérifie que le résultat implémente le Protocol Channel
|
||||
assert isinstance(result, Channel)
|
||||
|
||||
|
||||
class TestGetChannelEnabledMissingRequiredFields:
|
||||
"""Tests pour les cas où des champs requis sont manquants."""
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"settings_kwargs",
|
||||
[
|
||||
{
|
||||
"enabled": True,
|
||||
"jid": None,
|
||||
"password": SecretStr("pass"),
|
||||
"host": "example.com",
|
||||
"to": "parent@example.com",
|
||||
},
|
||||
{
|
||||
"enabled": True,
|
||||
"jid": "bot@example.com",
|
||||
"password": None,
|
||||
"host": "example.com",
|
||||
"to": "parent@example.com",
|
||||
},
|
||||
{
|
||||
"enabled": True,
|
||||
"jid": "bot@example.com",
|
||||
"password": SecretStr("pass"),
|
||||
"host": "",
|
||||
"to": "parent@example.com",
|
||||
},
|
||||
{
|
||||
"enabled": True,
|
||||
"jid": "bot@example.com",
|
||||
"password": SecretStr("pass"),
|
||||
"host": "example.com",
|
||||
"to": None,
|
||||
},
|
||||
],
|
||||
ids=["missing_jid", "missing_password", "missing_host", "missing_to"],
|
||||
)
|
||||
def test_get_channel_enabled_missing_required_field_returns_none(
|
||||
self,
|
||||
settings_kwargs: dict[str, Any],
|
||||
caplog: pytest.LogCaptureFixture,
|
||||
) -> None:
|
||||
"""Vérifie que get_channel retourne None quand un champ requis est manquant.
|
||||
|
||||
:param settings_kwargs: Paramètres pour XmppSettings avec un champ manquant.
|
||||
:param caplog: Fixture pour capturer les logs.
|
||||
:return: None
|
||||
:rtype: None
|
||||
"""
|
||||
settings = XmppSettings(**settings_kwargs)
|
||||
result = get_channel(settings)
|
||||
assert result is None
|
||||
# Vérifie qu'un avertissement a été journalisé
|
||||
assert len(caplog.records) > 0
|
||||
assert any(record.levelname == "WARNING" for record in caplog.records)
|
||||
|
||||
def test_get_channel_enabled_missing_jid_returns_none(self) -> None:
|
||||
"""Vérifie que get_channel retourne None quand jid est None.
|
||||
|
||||
:return: None
|
||||
:rtype: None
|
||||
"""
|
||||
settings = XmppSettings(
|
||||
enabled=True,
|
||||
jid=None,
|
||||
password=SecretStr("pass"),
|
||||
host="example.com",
|
||||
to="parent@example.com",
|
||||
)
|
||||
result = get_channel(settings)
|
||||
assert result is None
|
||||
|
||||
def test_get_channel_enabled_missing_password_returns_none(self) -> None:
|
||||
"""Vérifie que get_channel retourne None quand password est None.
|
||||
|
||||
:return: None
|
||||
:rtype: None
|
||||
"""
|
||||
settings = XmppSettings(
|
||||
enabled=True,
|
||||
jid="bot@example.com",
|
||||
password=None,
|
||||
host="example.com",
|
||||
to="parent@example.com",
|
||||
)
|
||||
result = get_channel(settings)
|
||||
assert result is None
|
||||
|
||||
def test_get_channel_enabled_missing_to_returns_none(self) -> None:
|
||||
"""Vérifie que get_channel retourne None quand to est None.
|
||||
|
||||
:return: None
|
||||
:rtype: None
|
||||
"""
|
||||
settings = XmppSettings(
|
||||
enabled=True,
|
||||
jid="bot@example.com",
|
||||
password=SecretStr("pass"),
|
||||
host="example.com",
|
||||
to=None,
|
||||
)
|
||||
result = get_channel(settings)
|
||||
assert result is None
|
||||
|
||||
def test_get_channel_enabled_missing_host_returns_none(self) -> None:
|
||||
"""Vérifie que get_channel retourne None quand host est vide.
|
||||
|
||||
:return: None
|
||||
:rtype: None
|
||||
"""
|
||||
settings = XmppSettings(
|
||||
enabled=True,
|
||||
jid="bot@example.com",
|
||||
password=SecretStr("pass"),
|
||||
host="",
|
||||
to="parent@example.com",
|
||||
)
|
||||
result = get_channel(settings)
|
||||
assert result is None
|
||||
|
||||
|
||||
class TestGetChannelNoExceptionOnMisconfiguration:
|
||||
"""Tests pour vérifier que la factory ne lève jamais d'exception."""
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"settings_kwargs",
|
||||
[
|
||||
{"enabled": True, "jid": None},
|
||||
{"enabled": True, "password": None},
|
||||
{"enabled": True, "to": None},
|
||||
{"enabled": True, "host": ""},
|
||||
{"enabled": True, "jid": None, "password": None, "to": None, "host": ""},
|
||||
{"enabled": False},
|
||||
],
|
||||
ids=[
|
||||
"missing_jid_only",
|
||||
"missing_password_only",
|
||||
"missing_to_only",
|
||||
"missing_host_only",
|
||||
"all_missing",
|
||||
"disabled",
|
||||
],
|
||||
)
|
||||
def test_get_channel_no_exception_on_misconfiguration(
|
||||
self,
|
||||
settings_kwargs: dict[str, Any],
|
||||
) -> None:
|
||||
"""Vérifie que get_channel ne lève jamais d'exception sur une configuration invalide.
|
||||
|
||||
:param settings_kwargs: Paramètres pour XmppSettings potentiellement invalides.
|
||||
:return: None
|
||||
:rtype: None
|
||||
"""
|
||||
settings = XmppSettings(**settings_kwargs)
|
||||
# Ne doit jamais lever d'exception
|
||||
result = get_channel(settings)
|
||||
assert result is None
|
||||
|
||||
|
||||
class TestGetChannelNoSecretInWarningLog:
|
||||
"""Tests pour vérifier que les secrets ne fuient pas dans les logs."""
|
||||
|
||||
def test_get_channel_no_secret_in_warning_log(self, caplog: pytest.LogCaptureFixture) -> None:
|
||||
"""Vérifie que les valeurs sentinelles ne apparaissent pas dans les logs.
|
||||
|
||||
Utilise des valeurs sentinelles pour éviter toute fuite de secrets réels.
|
||||
|
||||
:param caplog: Fixture pour capturer les logs.
|
||||
:return: None
|
||||
:rtype: None
|
||||
"""
|
||||
sentinel_jid = "JID_SENTINEL@example.com"
|
||||
sentinel_password = SecretStr("PASS_SENTINEL")
|
||||
sentinel_to = "TO_SENTINEL@example.com"
|
||||
|
||||
# Configuration incomplète : host manquant -> get_channel journalise
|
||||
# un avertissement expurgé et retourne None.
|
||||
settings = XmppSettings(
|
||||
enabled=True,
|
||||
jid=sentinel_jid,
|
||||
password=sentinel_password,
|
||||
host="",
|
||||
to=sentinel_to,
|
||||
)
|
||||
result = get_channel(settings)
|
||||
assert result is None
|
||||
|
||||
# Vérifie qu'un avertissement a été journalisé
|
||||
assert len(caplog.records) > 0
|
||||
assert any(record.levelname == "WARNING" for record in caplog.records)
|
||||
|
||||
# Vérifie que les valeurs sentinelles n'apparaissent pas dans les logs
|
||||
log_text = "".join(record.message for record in caplog.records)
|
||||
assert sentinel_jid not in log_text
|
||||
assert sentinel_password.get_secret_value() not in log_text
|
||||
assert sentinel_to not in log_text
|
||||
|
||||
|
||||
class TestGetChannelDryRun:
|
||||
"""Tests pour le flag dry_run."""
|
||||
|
||||
def test_get_channel_dry_run(self) -> None:
|
||||
"""Vérifie que le flag dry_run est passé à travers et retourne un channel.
|
||||
|
||||
:return: None
|
||||
:rtype: None
|
||||
"""
|
||||
settings = XmppSettings(
|
||||
enabled=True,
|
||||
jid="bot@example.com",
|
||||
password=SecretStr("pass"),
|
||||
host="example.com",
|
||||
to="parent@example.com",
|
||||
)
|
||||
result = get_channel(settings, dry_run=True)
|
||||
assert result is not None
|
||||
assert isinstance(result, Channel)
|
||||
|
||||
def test_get_channel_dry_run_no_connection(self) -> None:
|
||||
"""Vérifie que dry_run=True ne crée pas de ClientXMPP.
|
||||
|
||||
:return: None
|
||||
:rtype: None
|
||||
"""
|
||||
settings = XmppSettings(
|
||||
enabled=True,
|
||||
jid="bot@example.com",
|
||||
password=SecretStr("pass"),
|
||||
host="example.com",
|
||||
to="parent@example.com",
|
||||
)
|
||||
with patch("pronote_sync.channels.xmpp.ClientXMPP") as mock_cls:
|
||||
result = get_channel(settings, dry_run=True)
|
||||
assert result is not None
|
||||
assert isinstance(result, Channel)
|
||||
# ClientXMPP ne doit pas être instancié en dry_run
|
||||
assert not mock_cls.called
|
||||
|
||||
|
||||
class TestChannelImportsFromInit:
|
||||
"""Tests pour vérifier que les exports depuis __init__.py fonctionnent."""
|
||||
|
||||
def test_channel_imports_from_init(self) -> None:
|
||||
"""Vérifie que Channel, XmppChannel, SyncXmppChannel sont importables depuis pronote_sync.channels.
|
||||
|
||||
:return: None
|
||||
:rtype: None
|
||||
"""
|
||||
# Ces imports doivent réussir
|
||||
assert Channel is not None
|
||||
assert XmppChannel is not None
|
||||
assert SyncXmppChannel is not None
|
||||
assert get_channel is not None
|
||||
199
tests/unit/test_xmpp_settings.py
Normal file
199
tests/unit/test_xmpp_settings.py
Normal file
@@ -0,0 +1,199 @@
|
||||
"""Tests unitaires pour les contraintes de sécurité et validateurs de XmppSettings.
|
||||
|
||||
Ce module valide les contraintes de sécurité et les validateurs qui seront ajoutés
|
||||
à la classe XmppSettings dans pronote_sync/config/settings.py.
|
||||
|
||||
Les tests doivent être initialement en échec (RED) car les contraintes et validateurs
|
||||
n'existent pas encore dans le code de production.
|
||||
"""
|
||||
|
||||
import pytest
|
||||
from pydantic import SecretStr, ValidationError
|
||||
|
||||
from pronote_sync.config.settings import XmppSettings
|
||||
|
||||
|
||||
class TestPortConstraints:
|
||||
"""Tests des contraintes sur le champ port."""
|
||||
|
||||
def test_port_below_1_rejected(self) -> None:
|
||||
"""Vérifie que port < 1 est rejeté.
|
||||
|
||||
:raises ValidationError: Si le port est inférieur à 1.
|
||||
"""
|
||||
with pytest.raises(ValidationError) as exc_info:
|
||||
XmppSettings(port=0)
|
||||
assert "port" in str(exc_info.value).lower()
|
||||
|
||||
def test_port_above_65535_rejected(self) -> None:
|
||||
"""Vérifie que port > 65535 est rejeté.
|
||||
|
||||
:raises ValidationError: Si le port est supérieur à 65535.
|
||||
"""
|
||||
with pytest.raises(ValidationError) as exc_info:
|
||||
XmppSettings(port=70000)
|
||||
assert "port" in str(exc_info.value).lower()
|
||||
|
||||
def test_port_default_5222(self) -> None:
|
||||
"""Vérifie que la valeur par défaut de port est 5222.
|
||||
|
||||
:return: Vérifie que XmppSettings().port == 5222.
|
||||
:rtype: None
|
||||
"""
|
||||
settings = XmppSettings()
|
||||
assert settings.port == 5222
|
||||
|
||||
def test_port_valid(self) -> None:
|
||||
"""Vérifie que les ports valides sont acceptés.
|
||||
|
||||
:return: Vérifie que XmppSettings(port=5222) et XmppSettings(port=5223) sont valides.
|
||||
:rtype: None
|
||||
"""
|
||||
settings1 = XmppSettings(port=5222)
|
||||
assert settings1.port == 5222
|
||||
|
||||
settings2 = XmppSettings(port=5223)
|
||||
assert settings2.port == 5223
|
||||
|
||||
|
||||
class TestTimeoutConstraints:
|
||||
"""Tests des contraintes sur le champ timeout."""
|
||||
|
||||
def test_timeout_zero_rejected(self) -> None:
|
||||
"""Vérifie que timeout = 0 est rejeté.
|
||||
|
||||
:raises ValidationError: Si le timeout est égal à 0.
|
||||
"""
|
||||
with pytest.raises(ValidationError) as exc_info:
|
||||
XmppSettings(timeout=0)
|
||||
assert "timeout" in str(exc_info.value).lower()
|
||||
|
||||
def test_timeout_negative_rejected(self) -> None:
|
||||
"""Vérifie que timeout < 0 est rejeté.
|
||||
|
||||
:raises ValidationError: Si le timeout est négatif.
|
||||
"""
|
||||
with pytest.raises(ValidationError) as exc_info:
|
||||
XmppSettings(timeout=-1)
|
||||
assert "timeout" in str(exc_info.value).lower()
|
||||
|
||||
def test_timeout_default_30(self) -> None:
|
||||
"""Vérifie que la valeur par défaut de timeout est 30.
|
||||
|
||||
:return: Vérifie que XmppSettings().timeout == 30.
|
||||
:rtype: None
|
||||
"""
|
||||
settings = XmppSettings()
|
||||
assert settings.timeout == 30
|
||||
|
||||
def test_timeout_positive_valid(self) -> None:
|
||||
"""Vérifie que les valeurs positives de timeout sont acceptées.
|
||||
|
||||
:return: Vérifie que XmppSettings(timeout=10) est valide.
|
||||
:rtype: None
|
||||
"""
|
||||
settings = XmppSettings(timeout=10)
|
||||
assert settings.timeout == 10
|
||||
|
||||
|
||||
class TestTlsPolicy:
|
||||
"""Tests de la politique TLS pour le champ use_tls."""
|
||||
|
||||
def test_use_tls_false_with_remote_host_rejected(self) -> None:
|
||||
"""Vérifie que use_tls=False avec un hôte distant est rejeté.
|
||||
|
||||
:raises ValidationError: Si use_tls=False et host n'est pas une boucle locale.
|
||||
"""
|
||||
with pytest.raises(ValidationError) as exc_info:
|
||||
XmppSettings(use_tls=False, host="talk.example.com")
|
||||
assert "use_tls" in str(exc_info.value).lower() or "tls" in str(exc_info.value).lower()
|
||||
|
||||
def test_use_tls_false_with_remote_host_rejected_when_enabled(self) -> None:
|
||||
"""Vérifie que la politique TLS s'applique même quand le canal est activé."""
|
||||
with pytest.raises(ValidationError):
|
||||
XmppSettings(enabled=True, use_tls=False, host="talk.example.com")
|
||||
|
||||
def test_use_tls_false_with_localhost_allowed(self) -> None:
|
||||
"""Vérifie que use_tls=False avec localhost est autorisé.
|
||||
|
||||
:return: Vérifie que XmppSettings(use_tls=False, host="localhost") est valide.
|
||||
:rtype: None
|
||||
"""
|
||||
settings = XmppSettings(use_tls=False, host="localhost")
|
||||
assert settings.use_tls is False
|
||||
assert settings.host == "localhost"
|
||||
|
||||
def test_use_tls_false_with_127_allowed(self) -> None:
|
||||
"""Vérifie que use_tls=False avec 127.0.0.1 est autorisé.
|
||||
|
||||
:return: Vérifie que XmppSettings(use_tls=False, host="127.0.0.1") est valide.
|
||||
:rtype: None
|
||||
"""
|
||||
settings = XmppSettings(use_tls=False, host="127.0.0.1")
|
||||
assert settings.use_tls is False
|
||||
assert settings.host == "127.0.0.1"
|
||||
|
||||
def test_use_tls_false_with_ipv6_loopback_allowed(self) -> None:
|
||||
"""Vérifie que use_tls=False avec ::1 est autorisé.
|
||||
|
||||
:return: Vérifie que XmppSettings(use_tls=False, host="::1") est valide.
|
||||
:rtype: None
|
||||
"""
|
||||
settings = XmppSettings(use_tls=False, host="::1")
|
||||
assert settings.use_tls is False
|
||||
assert settings.host == "::1"
|
||||
|
||||
def test_use_tls_true_with_remote_host_allowed(self) -> None:
|
||||
"""Vérifie que use_tls=True avec un hôte distant est autorisé.
|
||||
|
||||
:return: Vérifie que XmppSettings(use_tls=True, host="talk.example.com") est valide.
|
||||
:rtype: None
|
||||
"""
|
||||
settings = XmppSettings(use_tls=True, host="talk.example.com")
|
||||
assert settings.use_tls is True
|
||||
assert settings.host == "talk.example.com"
|
||||
|
||||
def test_use_tls_true_with_empty_host_allowed(self) -> None:
|
||||
"""Vérifie que use_tls=True avec host vide est autorisé.
|
||||
|
||||
:return: Vérifie que XmppSettings(use_tls=True, host="") est valide.
|
||||
:rtype: None
|
||||
"""
|
||||
settings = XmppSettings(use_tls=True, host="")
|
||||
assert settings.use_tls is True
|
||||
assert settings.host == ""
|
||||
|
||||
|
||||
class TestNoSecretInErrorMessages:
|
||||
"""Tests de sécurité : vérifie que les messages d'erreur ne contiennent pas de secrets."""
|
||||
|
||||
def test_no_secret_in_validation_error(self) -> None:
|
||||
"""Vérifie que les messages de ValidationError ne contiennent pas de secrets.
|
||||
|
||||
Crée une instance avec des valeurs sensibles et vérifie que l'erreur de validation
|
||||
ne contient pas ces valeurs dans son message.
|
||||
|
||||
:raises ValidationError: Si use_tls=False avec un hôte non-local.
|
||||
:return: Vérifie que le message d'erreur ne contient pas les secrets.
|
||||
:rtype: None
|
||||
"""
|
||||
# Utilisation de valeurs sentinelles pour éviter toute fuite
|
||||
sentinel_jid = "test_jid@example.com"
|
||||
sentinel_password = SecretStr("test_password_123")
|
||||
sentinel_to = "test_to@example.com"
|
||||
|
||||
with pytest.raises(ValidationError) as exc_info:
|
||||
XmppSettings(
|
||||
use_tls=False,
|
||||
host="talk.example.com",
|
||||
jid=sentinel_jid,
|
||||
password=sentinel_password,
|
||||
to=sentinel_to,
|
||||
)
|
||||
|
||||
error_message = str(exc_info.value).lower()
|
||||
# Vérifie que les valeurs sensibles ne sont pas dans le message d'erreur
|
||||
assert "test_jid@example.com" not in error_message
|
||||
assert "test_password_123" not in error_message
|
||||
assert "test_to@example.com" not in error_message
|
||||
assert "secret" not in error_message
|
||||
235
tests/unit/test_xmpp_sync_adapter.py
Normal file
235
tests/unit/test_xmpp_sync_adapter.py
Normal file
@@ -0,0 +1,235 @@
|
||||
"""Tests unitaires pour l'adaptateur SyncXmppChannel.
|
||||
|
||||
Ce module teste l'implémentation de :class:`pronote_sync.channels.xmpp.SyncXmppChannel`
|
||||
qui est un adaptateur wrapant XmppChannel pour fournir une interface synchrone.
|
||||
|
||||
Les tests sont conçus pour être exécutés sans réseau, avec des mocks de XmppChannel
|
||||
ou de slixmpp, et vérifient le comportement de l'envoi synchrone selon la décision D4.
|
||||
|
||||
Conformément à D4, SyncXmppChannel.send() utilise asyncio.run() directement sans
|
||||
créer de nouvelle event loop inutilement. Le comportement est :
|
||||
- Pas de boucle en cours → asyncio.run(channel.send_async(message))
|
||||
- Retourne True en cas de succès, False en cas d'erreur (attrape toute exception)
|
||||
- Aucun secret dans les logs.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
from datetime import date
|
||||
from unittest.mock import MagicMock, patch
|
||||
|
||||
import pytest
|
||||
from pydantic import SecretStr
|
||||
|
||||
from pronote_sync.channels.protocol import Channel
|
||||
from pronote_sync.channels.xmpp import SyncXmppChannel, XmppMessage
|
||||
from pronote_sync.config.settings import XmppSettings
|
||||
|
||||
# Sentinelles pour tests de non-fuite de secrets
|
||||
BOT_SENTINEL_JID = "BOT_SENTINEL_JID@example.com"
|
||||
PASS_SENTINEL_123 = "PASS_SENTINEL_123"
|
||||
RECIPIENT_SENTINEL = "RECIPIENT_SENTINEL@example.com"
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def xmpp_settings() -> XmppSettings:
|
||||
"""Fixture fournissant des paramètres XMPP valides pour les tests.
|
||||
|
||||
:return: Instance de XmppSettings avec des valeurs par défaut valides.
|
||||
:rtype: XmppSettings
|
||||
"""
|
||||
return XmppSettings(
|
||||
enabled=True,
|
||||
jid="bot@example.com",
|
||||
password=SecretStr("secret123"),
|
||||
host="xmpp.example.com",
|
||||
to="parent@example.com",
|
||||
use_tls=True,
|
||||
)
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def xmpp_message() -> XmppMessage:
|
||||
"""Fixture fournissant un message XMPP minimal pour les tests.
|
||||
|
||||
:return: Instance de XmppMessage avec seulement la date cible.
|
||||
:rtype: XmppMessage
|
||||
"""
|
||||
return XmppMessage(
|
||||
target_date=date(2025, 9, 7),
|
||||
synthesis=None,
|
||||
homeworks=(),
|
||||
changes=(),
|
||||
messages=(),
|
||||
external_info=None,
|
||||
)
|
||||
|
||||
|
||||
class TestSyncXmppChannelSend:
|
||||
"""Tests unitaires pour la méthode send de SyncXmppChannel.
|
||||
|
||||
Ces tests vérifient le comportement de l'envoi synchrone de messages XMPP
|
||||
selon la décision D4 : utilisation directe de asyncio.run() et retour de
|
||||
booléen (True/False) sans lever d'exception.
|
||||
"""
|
||||
|
||||
@patch("pronote_sync.channels.xmpp.asyncio.run")
|
||||
def test_sync_adapter_send_returns_true_on_success(
|
||||
self, mock_asyncio_run: MagicMock, xmpp_settings: XmppSettings, xmpp_message: XmppMessage
|
||||
) -> None:
|
||||
"""Test que send retourne True en cas de succès.
|
||||
|
||||
:param mock_asyncio_run: Mock de asyncio.run
|
||||
:param xmpp_settings: Paramètres XMPP valides.
|
||||
:param xmpp_message: Message XMPP minimal.
|
||||
"""
|
||||
mock_asyncio_run.side_effect = lambda coro: coro.close() or True
|
||||
channel = SyncXmppChannel(xmpp_settings)
|
||||
result = channel.send(xmpp_message)
|
||||
assert result is True
|
||||
|
||||
@patch("pronote_sync.channels.xmpp.asyncio.run")
|
||||
def test_sync_adapter_send_returns_false_on_error(
|
||||
self, mock_run: MagicMock, xmpp_settings: XmppSettings, xmpp_message: XmppMessage
|
||||
) -> None:
|
||||
"""Test que send retourne False en cas d'erreur.
|
||||
|
||||
Vérifie que la méthode ne lève pas d'exception non gérée et retourne False.
|
||||
|
||||
:param mock_run: Mock de asyncio.run
|
||||
:param xmpp_settings: Paramètres XMPP valides.
|
||||
:param xmpp_message: Message XMPP minimal.
|
||||
"""
|
||||
|
||||
# Simuler une erreur dans asyncio.run
|
||||
def _run_with_error(coro: object) -> bool:
|
||||
"""Ferme la coroutine non exécutée puis lève l'erreur simulée."""
|
||||
close = getattr(coro, "close", None)
|
||||
if close is not None:
|
||||
close()
|
||||
raise RuntimeError("Connexion impossible")
|
||||
|
||||
mock_run.side_effect = _run_with_error
|
||||
channel = SyncXmppChannel(xmpp_settings)
|
||||
result = channel.send(xmpp_message)
|
||||
assert result is False
|
||||
|
||||
def test_sync_adapter_satisfies_channel_protocol(self, xmpp_settings: XmppSettings) -> None:
|
||||
"""Test que SyncXmppChannel satisfait le protocole Channel.
|
||||
|
||||
Vérifie que l'instance est reconnue comme implémentant le protocole.
|
||||
|
||||
:param xmpp_settings: Paramètres XMPP valides.
|
||||
"""
|
||||
channel = SyncXmppChannel(xmpp_settings)
|
||||
assert isinstance(channel, Channel)
|
||||
|
||||
def test_sync_adapter_dry_run_does_not_create_client(
|
||||
self, xmpp_settings: XmppSettings, xmpp_message: XmppMessage
|
||||
) -> None:
|
||||
"""Test que dry_run=True ne crée jamais ClientXMPP.
|
||||
|
||||
:param xmpp_settings: Paramètres XMPP valides.
|
||||
:param xmpp_message: Message XMPP minimal.
|
||||
"""
|
||||
channel = SyncXmppChannel(xmpp_settings, dry_run=True)
|
||||
with patch("pronote_sync.channels.xmpp.ClientXMPP") as mock_cls:
|
||||
result = channel.send(xmpp_message)
|
||||
assert result is True
|
||||
# ClientXMPP ne doit pas être instancié en dry_run
|
||||
assert not mock_cls.called
|
||||
|
||||
def test_sync_adapter_dry_run_returns_true(
|
||||
self, xmpp_settings: XmppSettings, xmpp_message: XmppMessage
|
||||
) -> None:
|
||||
"""Test que dry_run=True retourne True sans se connecter.
|
||||
|
||||
:param xmpp_settings: Paramètres XMPP valides.
|
||||
:param xmpp_message: Message XMPP minimal.
|
||||
"""
|
||||
channel = SyncXmppChannel(xmpp_settings, dry_run=True)
|
||||
result = channel.send(xmpp_message)
|
||||
assert result is True
|
||||
|
||||
@patch("pronote_sync.channels.xmpp.asyncio.run")
|
||||
def test_sync_adapter_never_raises(
|
||||
self, mock_run: MagicMock, xmpp_settings: XmppSettings, xmpp_message: XmppMessage
|
||||
) -> None:
|
||||
"""Test que send ne lève jamais d'exception.
|
||||
|
||||
:param mock_run: Mock de asyncio.run
|
||||
:param xmpp_settings: Paramètres XMPP valides.
|
||||
:param xmpp_message: Message XMPP minimal.
|
||||
"""
|
||||
|
||||
# Simuler une erreur quelconque
|
||||
def _run_with_error(coro: object) -> bool:
|
||||
"""Ferme la coroutine non exécutée puis lève l'erreur simulée."""
|
||||
close = getattr(coro, "close", None)
|
||||
if close is not None:
|
||||
close()
|
||||
raise Exception("Any error")
|
||||
|
||||
mock_run.side_effect = _run_with_error
|
||||
channel = SyncXmppChannel(xmpp_settings)
|
||||
result = channel.send(xmpp_message)
|
||||
assert result is False
|
||||
|
||||
|
||||
class TestSyncXmppChannelSecurity:
|
||||
"""Tests de sécurité pour SyncXmppChannel (non-fuite de secrets).
|
||||
|
||||
Ces tests vérifient que les secrets (JID, mot de passe, destinataire)
|
||||
ne sont jamais exposés dans les logs, messages d'erreur ou causes d'exceptions.
|
||||
"""
|
||||
|
||||
def test_sync_adapter_no_secret_in_logs(
|
||||
self, caplog: pytest.LogCaptureFixture, xmpp_settings: XmppSettings
|
||||
) -> None:
|
||||
"""Test que les sentinelles n'apparaissent pas dans les logs en cas d'erreur.
|
||||
|
||||
:param caplog: Fixture pytest pour capturer les logs.
|
||||
:param xmpp_settings: Paramètres XMPP valides.
|
||||
"""
|
||||
# Créer des settings avec sentinelles
|
||||
settings = XmppSettings(
|
||||
enabled=True,
|
||||
jid=BOT_SENTINEL_JID,
|
||||
password=SecretStr(PASS_SENTINEL_123),
|
||||
host="localhost",
|
||||
port=5222,
|
||||
to=RECIPIENT_SENTINEL,
|
||||
use_tls=False,
|
||||
)
|
||||
|
||||
channel = SyncXmppChannel(settings)
|
||||
msg = XmppMessage(
|
||||
target_date=date(2025, 9, 7),
|
||||
synthesis=None,
|
||||
homeworks=(),
|
||||
changes=(),
|
||||
messages=(),
|
||||
external_info=None,
|
||||
)
|
||||
|
||||
# Simuler une erreur dans asyncio.run
|
||||
with patch("pronote_sync.channels.xmpp.asyncio.run") as mock_run:
|
||||
|
||||
def _run_with_error(coro: object) -> bool:
|
||||
"""Ferme la coroutine non exécutée puis lève l'erreur simulée."""
|
||||
close = getattr(coro, "close", None)
|
||||
if close is not None:
|
||||
close()
|
||||
raise RuntimeError("Connexion impossible")
|
||||
|
||||
mock_run.side_effect = _run_with_error
|
||||
result = channel.send(msg)
|
||||
|
||||
# Vérifier que le résultat est False
|
||||
assert result is False
|
||||
|
||||
# Vérifier que les sentinelles n'apparaissent pas dans les logs
|
||||
logs = caplog.text
|
||||
assert BOT_SENTINEL_JID not in logs
|
||||
assert PASS_SENTINEL_123 not in logs
|
||||
assert RECIPIENT_SENTINEL not in logs
|
||||
Reference in New Issue
Block a user