ewoksdrac 0.1.0__tar.gz

ewoksdrac-0.1.0/LICENSE.md

@@ -0,0 +1,20 @@
+# MIT License
+
+**Copyright (c) 2026 European Synchrotron Radiation Facility**
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

ewoksdrac-0.1.0/PKG-INFO

@@ -0,0 +1,64 @@
+Metadata-Version: 2.4
+Name: ewoksdrac
+Version: 0.1.0
+Summary: Ewoks tasks for the Data Portal
+Author-email: ESRF <dau-pydev@esrf.fr>
+License: # MIT License
+        
+        **Copyright (c) 2026 European Synchrotron Radiation Facility**
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy of
+        this software and associated documentation files (the "Software"), to deal in
+        the Software without restriction, including without limitation the rights to
+        use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+        the Software, and to permit persons to whom the Software is furnished to do so,
+        subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+        FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+        COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+        IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+        CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+        
+Project-URL: Homepage, https://gitlab.esrf.fr/workflow/ewoksapps/ewoksdrac/
+Project-URL: Documentation, https://ewoksdrac.readthedocs.io/
+Project-URL: Repository, https://gitlab.esrf.fr/workflow/ewoksapps/ewoksdrac/
+Project-URL: Issues, https://gitlab.esrf.fr/workflow/ewoksapps/ewoksdrac/issues
+Project-URL: Changelog, https://gitlab.esrf.fr/workflow/ewoksapps/ewoksdrac/-/blob/main/CHANGELOG.md
+Keywords: ewoks
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: ewokscore
+Requires-Dist: requests
+Requires-Dist: pydantic
+Requires-Dist: jinja2
+Requires-Dist: minedrac>=1.1.0
+Provides-Extra: test
+Requires-Dist: pytest>=7; extra == "test"
+Provides-Extra: dev
+Requires-Dist: ewoksdrac[test]; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Provides-Extra: doc
+Requires-Dist: ewoksdrac[test]; extra == "doc"
+Requires-Dist: sphinx>=4.5; extra == "doc"
+Requires-Dist: sphinx-autodoc-typehints>=1.16; extra == "doc"
+Requires-Dist: pydata-sphinx-theme; extra == "doc"
+Requires-Dist: sphinx-copybutton; extra == "doc"
+Requires-Dist: ewokssphinx>=2.0; extra == "doc"
+Dynamic: license-file
+
+# ewoksdrac
+
+Ewoks tasks for the Data Portal
+
+## Documentation
+
+https://ewoksdrac.readthedocs.io/

ewoksdrac-0.1.0/README.md

@@ -0,0 +1,7 @@
+# ewoksdrac
+
+Ewoks tasks for the Data Portal
+
+## Documentation
+
+https://ewoksdrac.readthedocs.io/

ewoksdrac-0.1.0/pyproject.toml

@@ -0,0 +1,85 @@
+[build-system]
+requires = [
+    "setuptools>=61",
+]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "ewoksdrac"
+version = "0.1.0"
+keywords = [
+    "ewoks"
+]
+
+authors = [{name = "ESRF", email = "dau-pydev@esrf.fr"}]
+description = "Ewoks tasks for the Data Portal"
+readme = {file = "README.md", content-type = "text/markdown"}
+license = {file = "LICENSE.md"}
+classifiers = [
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+]
+requires-python = ">=3.11"
+dependencies = [
+    "ewokscore",
+    "requests",
+    "pydantic",
+    "jinja2",
+    "minedrac >=1.1.0",
+]
+
+[project.urls]
+Homepage = "https://gitlab.esrf.fr/workflow/ewoksapps/ewoksdrac/"
+Documentation = "https://ewoksdrac.readthedocs.io/"
+Repository = "https://gitlab.esrf.fr/workflow/ewoksapps/ewoksdrac/"
+Issues = "https://gitlab.esrf.fr/workflow/ewoksapps/ewoksdrac/issues"
+Changelog = "https://gitlab.esrf.fr/workflow/ewoksapps/ewoksdrac/-/blob/main/CHANGELOG.md"
+
+[project.optional-dependencies]
+test = [
+    "pytest >=7",
+]
+dev = [
+    "ewoksdrac[test]",
+    "ruff",
+]
+doc = [
+    "ewoksdrac[test]",
+    "sphinx >=4.5",
+    "sphinx-autodoc-typehints >=1.16",
+    "pydata-sphinx-theme",
+    "sphinx-copybutton",
+    "ewokssphinx >=2.0"
+]
+
+[tool.setuptools]
+package-dir = {""= "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+namespaces = false
+
+[tool.setuptools.package-data]
+"ewoksdrac.tests.data"= ["*/*"]
+"ewoksdrac.tasks.mail"= ["templates/*.j2"]
+
+[project.entry-points."ewoks.tasks.class"]
+"ewoksdrac.tasks.report.*" = "ewoksdrac"
+"ewoksdrac.tasks.mail.*" = "ewoksdrac"
+
+
+[tool.coverage.run]
+omit = [
+    "*/tests/*"
+]
+[tool.ruff.lint]
+select = ["E", "F", "I", "S"]
+ignore = ["E203", "E501", "E701"]
+
+[tool.ruff.lint.per-file-ignores]
+# Ignore `S101` (assert used violations) in all test files
+"*/test_*.py" = ["S101"]
+
+[tool.ruff.lint.isort]
+force-single-line = true

ewoksdrac-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

ewoksdrac-0.1.0/src/ewoksdrac/tasks/base_tasks/drac_investigation_task.py

@@ -0,0 +1,15 @@
+from .drac_investigation_task_inputs import DracInvestigationTaskInputs
+from .drac_task import DracTask
+
+
+class DracInvestigationTask(
+    DracTask,
+    input_model=DracInvestigationTaskInputs,
+):
+    """
+    A task conceived to be run for a whole investigation (experiment session).
+    """
+
+    @property
+    def investigation_id(self) -> int:
+        return self.inputs.investigation_id

ewoksdrac-0.1.0/src/ewoksdrac/tasks/base_tasks/drac_investigation_task_inputs.py

@@ -0,0 +1,10 @@
+from pydantic import Field
+
+from .drac_task_inputs import DracTaskInputs
+
+
+class DracInvestigationTaskInputs(DracTaskInputs):
+    investigation_id: int = Field(
+        description="The id of the investigation (experiment session) this task operates on",
+        examples=[12345],
+    )

ewoksdrac-0.1.0/src/ewoksdrac/tasks/base_tasks/drac_task.py

@@ -0,0 +1,74 @@
+import logging
+
+import requests
+from ewokscore import Task
+
+from .drac_task_inputs import DracTaskInputs
+
+logger = logging.getLogger(__name__)
+
+
+class DracTask(Task, input_model=DracTaskInputs):
+    """
+    Base class for a task launched from the Data Portal. It owns the run()
+    lifecycle and the status/log callback shared by every DRAC task.
+    """
+
+    @property
+    def session_id(self) -> str:
+        return self.inputs.session_id
+
+    @property
+    def callback(self) -> str | None:
+        if self.inputs.callback is None:
+            return None
+        return str(self.inputs.callback)
+
+    def pass_on_session(self) -> None:
+        """Output the session_id and callback, for a task whose output model
+        extends DracTaskOutputs."""
+        self.outputs.session_id = self.session_id
+        self.outputs.callback = self.callback
+
+    def process(self) -> None:
+        """The main processing logic."""
+        raise NotImplementedError
+
+    def finalize(self) -> None:
+        """Called after process() succeeds, e.g. to upload results to the catalogue."""
+
+    def run(self) -> None:
+        try:
+            self.set_status("STARTED")
+            self.set_status("RUNNING")
+            self.process()
+            self.finalize()
+        except Exception as ex:
+            self.log({"logs": {"error": str(ex)}})
+            self.set_status("TERMINATED", raise_on_error=True)
+            raise
+        else:
+            self.set_status("FINISHED", raise_on_error=True)
+
+    def set_status(self, status: str, raise_on_error: bool = False) -> None:
+        self.log({"status": status}, raise_on_error=raise_on_error)
+
+    def log(self, payload: dict, raise_on_error: bool = False) -> None:
+        """
+        Sends a log payload to the callback URL if provided.
+
+        Args:
+            payload (dict): The JSON payload to send.
+            raise_on_error (bool): Raise when the callback request fails instead of only logging it.
+        """
+        logger.debug(payload)
+        if not self.callback:
+            return
+
+        try:
+            response = requests.put(self.callback, json=payload, timeout=30)
+            response.raise_for_status()
+        except Exception as ex:
+            if raise_on_error:
+                raise
+            logger.error(f"Logging request failed: {ex}")

ewoksdrac-0.1.0/src/ewoksdrac/tasks/base_tasks/drac_task_inputs.py

@@ -0,0 +1,15 @@
+from ewokscore.model import BaseInputModel
+from pydantic import Field
+from pydantic import HttpUrl
+
+
+class DracTaskInputs(BaseInputModel):
+    session_id: str = Field(
+        description="A unique identifier for the ICAT session. It is used as a token to identify the user",
+        examples=["xfthscs-234234sdfsd-fsfsd21"],
+    )
+    callback: HttpUrl | None = Field(
+        default=None,
+        description="A web endpoint to be called upon task completion or status updates. Usually a call to icat+",
+        examples=["https://icatplus.esrf.fr/callback"],
+    )

ewoksdrac-0.1.0/src/ewoksdrac/tasks/base_tasks/drac_task_outputs.py

@@ -0,0 +1,20 @@
+from ewokscore.model import BaseOutputModel
+from pydantic import Field
+
+
+class DracTaskOutputs(BaseOutputModel):
+    """Outputs of a DRAC task followed by another DRAC task in the workflow.
+
+    The Data Portal only gives the session_id and callback to the first task of a
+    workflow, so this task passes them on through the workflow links.
+    """
+
+    session_id: str = Field(
+        description="The session_id input, passed on to the next task of the workflow",
+        examples=["xfthscs-234234sdfsd-fsfsd21"],
+    )
+    callback: str | None = Field(
+        default=None,
+        description="The callback input, passed on to the next task of the workflow",
+        examples=["https://icatplus.esrf.fr/callback"],
+    )

ewoksdrac-0.1.0/src/ewoksdrac/tasks/mail/render.py

@@ -0,0 +1,32 @@
+import os
+from typing import Any
+
+from jinja2 import PackageLoader
+from jinja2 import StrictUndefined
+from jinja2 import select_autoescape
+from jinja2.sandbox import SandboxedEnvironment
+
+_ENVIRONMENT = SandboxedEnvironment(
+    loader=PackageLoader("ewoksdrac.tasks.mail", "templates"),
+    undefined=StrictUndefined,
+    autoescape=select_autoescape(["html.j2"]),
+)
+
+
+def render_email(
+    subject: str, template: str, context: dict[str, Any]
+) -> tuple[str, str]:
+    """Render the subject string and the packaged HTML body template with the context.
+
+    The body template is ``templates/<template>.html.j2``. A variable missing from
+    the context raises instead of rendering as an empty string.
+    """
+    variables = {
+        "data_portal_url": os.environ.get("DATA_PORTAL_URL", "https://data.esrf.fr"),
+        "contact_email": os.environ.get("CONTACT_EMAIL", "dataportalrequests@esrf.fr"),
+        "signature": os.environ.get("EMAIL_SIGNATURE", "The ESRF Data Portal"),
+        **context,
+    }
+    rendered_subject = _ENVIRONMENT.from_string(subject).render(variables)
+    body = _ENVIRONMENT.get_template(f"{template}.html.j2").render(variables)
+    return rendered_subject, body

ewoksdrac-0.1.0/src/ewoksdrac/tasks/mail/send.py

@@ -0,0 +1,58 @@
+from pathlib import Path
+
+from minedrac.data.session import UserLookupError
+from minedrac.data.session import get_user_email
+
+from ..base_tasks.drac_task import DracTask
+from .render import render_email
+from .send_inputs import SendEmailInputs
+from .smtp import send_email
+
+
+class SendEmail(
+    DracTask,
+    input_model=SendEmailInputs,
+):
+    """Send an email, optionally with attachments, to users of the ICAT session"""
+
+    def process(self) -> None:
+        try:
+            self._send()
+        finally:
+            if self.inputs.delete_attachments:
+                _delete_files(self.inputs.attachments)
+
+    def _send(self) -> None:
+        try:
+            email = get_user_email(self.session_id)
+        except UserLookupError as ex:
+            raise RuntimeError(
+                f"Could not find the user of this session to email: {ex}"
+            ) from ex
+        if not email:
+            raise RuntimeError("No email address found for the user of this session")
+
+        subject, body = render_email(
+            self.inputs.subject, self.inputs.template, self.inputs.context
+        )
+        attachments = self.inputs.attachments
+        self.log({"logs": {"msg": "About to send the email"}})
+        # TODO send through the email REST API once it is available
+        send_email([email], subject, body, attachments)
+        self.log(
+            {
+                "logs": {
+                    "msg": "email sent",
+                    "attachments": str([f.name for f in attachments]),
+                }
+            }
+        )
+
+
+def _delete_files(files: list[Path]) -> None:
+    for file in files:
+        file.unlink(missing_ok=True)
+        try:
+            file.parent.rmdir()
+        except OSError:
+            pass

ewoksdrac-0.1.0/src/ewoksdrac/tasks/mail/send_inputs.py

@@ -0,0 +1,43 @@
+from pathlib import Path
+from typing import Any
+
+from pydantic import Field
+from pydantic import field_validator
+
+from ..base_tasks.drac_task_inputs import DracTaskInputs
+
+
+class SendEmailInputs(DracTaskInputs):
+    subject: str = Field(
+        description="Subject of the email, a Jinja2 template rendered with the context",
+        examples=["MX report of investigation {{ investigation_id }}"],
+    )
+    template: str = Field(
+        description="Name of the packaged Jinja2 template of the HTML body, without the '.html.j2' extension",
+        examples=["mx_report"],
+    )
+    context: dict[str, Any] = Field(
+        default_factory=dict,
+        description="Variables available to the subject and body templates, usually the context output of the previous task",
+        examples=[{"investigation_id": 12345, "generated_at": "2026-10-14 10:00:00"}],
+    )
+    attachments: list[Path] = Field(
+        default_factory=list,
+        description="Paths of the files to attach to the email. A single path is also accepted",
+        examples=[
+            ["/data/visitor/mx1234/reports/mx_report_12345.csv"],
+            "/data/visitor/mx1234/reports/mx_report_12345.csv",
+        ],
+    )
+    delete_attachments: bool = Field(
+        default=False,
+        description="Delete the attachments, and their directory when it is left empty, once the email is sent or failed. For temporary files such as generated reports",
+        examples=[True],
+    )
+
+    @field_validator("attachments", mode="before")
+    @classmethod
+    def single_attachment(cls, value: Any) -> Any:
+        if isinstance(value, (str, Path)):
+            return [value]
+        return value

ewoksdrac-0.1.0/src/ewoksdrac/tasks/mail/smtp.py

@@ -0,0 +1,35 @@
+import mimetypes
+import os
+import smtplib
+from collections.abc import Sequence
+from email.message import EmailMessage
+from pathlib import Path
+
+SMTP_TIMEOUT = 30  # seconds
+
+
+def send_email(
+    recipients: Sequence[str],
+    subject: str,
+    html_body: str,
+    attachments: Sequence[str | Path] = (),
+) -> None:
+    """Send an HTML email through the SMTP server configured by the environment variables."""
+    message = EmailMessage()
+    message["Subject"] = subject
+    message["From"] = os.environ.get("SMTP_FROM", "dataportal@esrf.fr")
+    message["To"] = ", ".join(recipients)
+    message.set_content(html_body, subtype="html")
+
+    for attachment in attachments:
+        path = Path(attachment)
+        mime_type, _ = mimetypes.guess_type(path)
+        maintype, subtype = (mime_type or "application/octet-stream").split("/", 1)
+        message.add_attachment(
+            path.read_bytes(), maintype=maintype, subtype=subtype, filename=path.name
+        )
+
+    host = os.environ.get("SMTP_HOST", "localhost")
+    port = int(os.environ.get("SMTP_PORT", "25"))
+    with smtplib.SMTP(host, port, timeout=SMTP_TIMEOUT) as smtp:
+        smtp.send_message(message)

ewoksdrac-0.1.0/src/ewoksdrac/tasks/mail/templates/base.html.j2

@@ -0,0 +1,17 @@
+<html>
+  <head>
+    <meta charset="utf-8" />
+    <style>
+      .text-footer {
+        font-size: 0.8em;
+        color: #666;
+      }
+    </style>
+  </head>
+  <body>
+    <p>Hello,</p>
+    {% block content %}{% endblock %}
+    <p>Best regards,<br />{{ signature }}</p>
+    <p class="text-footer"><i>This email was automatically generated by the Data Portal. If you have any questions, please contact <a href="mailto:{{ contact_email }}">{{ contact_email }}</a></i></p>
+  </body>
+</html>

ewoksdrac-0.1.0/src/ewoksdrac/tasks/mail/templates/mx_report.html.j2

@@ -0,0 +1,7 @@
+{% extends "base.html.j2" %}
+{% block content %}
+    {% set investigation_url = data_portal_url ~ "/investigation/" ~ investigation_id ~ "/datasets" %}
+    <p>Please find attached the MX report of your experiment session.</p>
+    <p>Generated on: {{ generated_at }}</p>
+    <p>The data can also be accessed online at: <a href="{{ investigation_url }}">{{ investigation_url }}</a></p>
+{% endblock %}

ewoksdrac-0.1.0/src/ewoksdrac/tasks/report/mx.py

@@ -0,0 +1,55 @@
+import datetime
+import tempfile
+from pathlib import Path
+
+from minedrac.report.mx import generate_mx_report
+
+from ..base_tasks.drac_investigation_task import DracInvestigationTask
+from .mx_inputs import MXReportInputs
+from .mx_outputs import MXReportOutputs
+
+
+class MXReport(
+    DracInvestigationTask,
+    input_model=MXReportInputs,
+    output_model=MXReportOutputs,
+):
+    """Generate the MX report for an experiment session and output its file path"""
+
+    def process(self) -> None:
+        self.log(
+            {
+                "logs": {
+                    "msg": "About to generate the report",
+                    "investigation_id": str(self.investigation_id),
+                }
+            }
+        )
+        # The report must outlive the task to be emailed: SendEmail deletes it
+        # when its delete_attachments input is set
+        output_dir = tempfile.mkdtemp(prefix="mx_report_")
+        csv_path = Path(output_dir) / f"mx_report_{self.investigation_id}.csv"
+        report_files = generate_mx_report(
+            token=self.session_id,
+            investigation_ids=str(self.investigation_id),
+            csv_file=str(csv_path),
+        )
+
+        if not report_files:
+            raise RuntimeError(
+                f"No report was generated for investigation {self.investigation_id}"
+            )
+        self.outputs.report_file = Path(report_files[0])
+        self.outputs.context = {
+            "investigation_id": self.investigation_id,
+            "generated_at": datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S"),
+        }
+        self.pass_on_session()
+        self.log(
+            {
+                "logs": {
+                    "msg": "report generated",
+                    "report_file": Path(report_files[0]).name,
+                }
+            }
+        )

ewoksdrac-0.1.0/src/ewoksdrac/tasks/report/mx_inputs.py

@@ -0,0 +1,5 @@
+from ..base_tasks.drac_investigation_task_inputs import DracInvestigationTaskInputs
+
+
+class MXReportInputs(DracInvestigationTaskInputs):
+    pass

ewoksdrac-0.1.0/src/ewoksdrac/tasks/report/mx_outputs.py

@@ -0,0 +1,17 @@
+from pathlib import Path
+from typing import Any
+
+from pydantic import Field
+
+from ..base_tasks.drac_task_outputs import DracTaskOutputs
+
+
+class MXReportOutputs(DracTaskOutputs):
+    report_file: Path = Field(
+        description="Path of the generated report",
+        examples=["/tmp/mx_report_abcd1234/mx_report_12345.csv"],  # noqa: S108
+    )
+    context: dict[str, Any] = Field(
+        description="Information about the report, for the email templates",
+        examples=[{"investigation_id": 12345, "generated_at": "2026-10-14 10:00:00"}],
+    )

ewoksdrac-0.1.0/src/ewoksdrac/tests/conftest.py

@@ -0,0 +1,9 @@
+from unittest.mock import patch
+
+import pytest
+
+
+@pytest.fixture
+def callback():
+    with patch("ewoksdrac.tasks.base_tasks.drac_task.requests.put") as put:
+        yield put

ewoksdrac-0.1.0/src/ewoksdrac/tests/test_mx_report.py

@@ -0,0 +1,100 @@
+from pathlib import Path
+from unittest.mock import patch
+
+import pytest
+
+from ewoksdrac.tasks.report.mx import MXReport
+from ewoksdrac.tests.utils import fail_on_status
+from ewoksdrac.tests.utils import messages
+from ewoksdrac.tests.utils import statuses
+
+
+@pytest.fixture
+def minedrac():
+    with patch("ewoksdrac.tasks.report.mx.generate_mx_report") as generate:
+        generate.side_effect = lambda **kwargs: [kwargs["csv_file"]]
+        yield generate
+
+
+@pytest.fixture
+def mkdtemp(tmp_path):
+    with patch("ewoksdrac.tasks.report.mx.tempfile.mkdtemp") as mkdtemp:
+        mkdtemp.return_value = str(tmp_path)
+        yield mkdtemp
+
+
+@pytest.fixture
+def inputs(mkdtemp):
+    return {
+        "investigation_id": "12345",
+        "session_id": "token",
+        "callback": "https://icatplus.esrf.fr/callback",
+    }
+
+
+def test_report(callback, minedrac, inputs, tmp_path):
+    task = MXReport(inputs=inputs)
+    task.execute()
+
+    kwargs = minedrac.call_args.kwargs
+    assert kwargs["token"] == inputs["session_id"]
+    assert kwargs["investigation_ids"] == "12345"
+    assert kwargs["csv_file"] == str(tmp_path / "mx_report_12345.csv")
+    outputs = task.get_output_values()
+    assert outputs["report_file"] == Path(kwargs["csv_file"])
+    assert outputs["context"]["investigation_id"] == 12345
+    assert "generated_at" in outputs["context"]
+    assert outputs["session_id"] == "token"
+    assert outputs["callback"] == "https://icatplus.esrf.fr/callback"
+    assert statuses(callback) == ["STARTED", "RUNNING", "FINISHED"]
+    assert messages(callback) == [
+        "About to generate the report",
+        "report generated",
+    ]
+
+
+def test_report_nothing_generated(callback, minedrac, inputs):
+    minedrac.side_effect = None
+    minedrac.return_value = []
+    with pytest.raises(Exception, match="No report was generated"):
+        MXReport(inputs=inputs).execute()
+    assert statuses(callback) == ["STARTED", "RUNNING", "TERMINATED"]
+
+
+def test_report_minedrac_fails(callback, minedrac, inputs):
+    minedrac.side_effect = ValueError("ICAT unreachable")
+    task = MXReport(inputs=inputs)
+    with pytest.raises(Exception, match="ICAT unreachable"):
+        task.execute()
+    assert statuses(callback) == ["STARTED", "RUNNING", "TERMINATED"]
+
+
+@pytest.mark.parametrize("investigation_id", [12345, "12345"])
+def test_report_investigation_id_int_or_str(
+    callback, minedrac, inputs, investigation_id
+):
+    MXReport(inputs={**inputs, "investigation_id": investigation_id}).execute()
+    assert minedrac.call_args.kwargs["investigation_ids"] == "12345"
+
+
+def test_report_invalid_callback(inputs):
+    task = MXReport(inputs={**inputs, "callback": "not a url"})
+    with pytest.raises(Exception, match="callback"):
+        task.execute()
+
+
+def test_report_finished_callback_fails(callback, minedrac, inputs):
+    callback.side_effect = fail_on_status("FINISHED")
+    task = MXReport(inputs=inputs)
+    with pytest.raises(Exception, match="portal unreachable"):
+        task.execute()
+    assert statuses(callback) == ["STARTED", "RUNNING", "FINISHED"]
+
+
+def test_report_terminated_callback_fails(callback, minedrac, inputs):
+    minedrac.side_effect = ValueError("ICAT unreachable")
+    callback.side_effect = fail_on_status("TERMINATED")
+    task = MXReport(inputs=inputs)
+    with pytest.raises(Exception, match="portal unreachable"):
+        task.execute()
+    assert statuses(callback) == ["STARTED", "RUNNING", "TERMINATED"]

ewoksdrac-0.1.0/src/ewoksdrac/tests/test_send_email.py

@@ -0,0 +1,192 @@
+from pathlib import Path
+from unittest.mock import patch
+
+import pytest
+from minedrac.data.session import UserLookupError
+
+from ewoksdrac.tasks.mail.send import SendEmail
+from ewoksdrac.tests.utils import messages
+from ewoksdrac.tests.utils import statuses
+
+INPUTS = {
+    "session_id": "token",
+    "callback": "https://icatplus.esrf.fr/callback",
+    "subject": "MX report of investigation {{ investigation_id }}",
+    "template": "mx_report",
+    "context": {"investigation_id": 12345, "generated_at": "2026-10-14 10:00:00"},
+}
+
+
+@pytest.fixture
+def user_email():
+    with patch("ewoksdrac.tasks.mail.send.get_user_email") as get:
+        get.return_value = "alice@esrf.fr"
+        yield get
+
+
+@pytest.fixture
+def send_email():
+    with patch("ewoksdrac.tasks.mail.send.send_email") as send:
+        yield send
+
+
+def test_send_email(callback, user_email, send_email):
+    SendEmail(inputs=INPUTS).execute()
+
+    user_email.assert_called_once_with("token")
+    send_email.assert_called_once()
+    recipients, subject, body, attachments = send_email.call_args.args
+    assert recipients == ["alice@esrf.fr"]
+    assert subject == "MX report of investigation 12345"
+    assert attachments == []
+    assert "<p>Hello,</p>" in body
+    assert "<p>Best regards,<br />The ESRF Data Portal</p>" in body
+    assert "Generated on: 2026-10-14 10:00:00" in body
+    assert '<a href="https://data.esrf.fr/investigation/12345/datasets">' in body
+    assert (
+        '<i>This email was automatically generated by the Data Portal. If you have any questions, please contact <a href="mailto:dataportalrequests@esrf.fr">dataportalrequests@esrf.fr</a></i>'
+        in body
+    )
+    assert statuses(callback) == ["STARTED", "RUNNING", "FINISHED"]
+    assert messages(callback) == ["About to send the email", "email sent"]
+
+
+REPORT = "/data/visitor/mx1234/reports/mx_report_12345.csv"
+IMAGE = "/data/visitor/mx1234/reports/plot.png"
+
+
+@pytest.mark.parametrize(
+    "attachments, expected",
+    [(REPORT, [REPORT]), ([REPORT], [REPORT]), ([REPORT, IMAGE], [REPORT, IMAGE])],
+)
+def test_send_email_with_attachments(
+    callback, user_email, send_email, attachments, expected
+):
+    SendEmail(inputs={**INPUTS, "attachments": attachments}).execute()
+
+    assert send_email.call_args.args[3] == [Path(f) for f in expected]
+
+
+def _report(tmp_path):
+    report_dir = tmp_path / "mx_report_abcd"
+    report_dir.mkdir()
+    report = report_dir / "mx_report_12345.csv"
+    report.write_text("a,b\n1,2\n")
+    return report
+
+
+def test_send_email_keeps_attachments(callback, user_email, send_email, tmp_path):
+    report = _report(tmp_path)
+    SendEmail(inputs={**INPUTS, "attachments": str(report)}).execute()
+
+    assert report.exists()
+
+
+def test_send_email_deletes_attachments(callback, user_email, send_email, tmp_path):
+    report = _report(tmp_path)
+    inputs = {**INPUTS, "attachments": str(report), "delete_attachments": True}
+    SendEmail(inputs=inputs).execute()
+
+    assert send_email.call_args.args[3] == [report]
+    assert not report.parent.exists()
+
+
+def test_send_email_deletes_attachments_on_failure(
+    callback, user_email, send_email, tmp_path
+):
+    report = _report(tmp_path)
+    send_email.side_effect = RuntimeError("SMTP unreachable")
+    inputs = {**INPUTS, "attachments": str(report), "delete_attachments": True}
+    with pytest.raises(Exception, match="SMTP unreachable"):
+        SendEmail(inputs=inputs).execute()
+
+    assert not report.parent.exists()
+
+
+def test_send_email_keeps_non_empty_directory(
+    callback, user_email, send_email, tmp_path
+):
+    report = _report(tmp_path)
+    other = report.parent / "other.txt"
+    other.write_text("keep me")
+    inputs = {**INPUTS, "attachments": str(report), "delete_attachments": True}
+    SendEmail(inputs=inputs).execute()
+
+    assert not report.exists()
+    assert other.exists()
+
+
+@pytest.mark.parametrize("email", [None, ""])
+def test_send_email_no_user_email(callback, user_email, send_email, email):
+    user_email.return_value = email
+    with pytest.raises(Exception, match="No email address"):
+        SendEmail(inputs=INPUTS).execute()
+    send_email.assert_not_called()
+    assert statuses(callback) == ["STARTED", "RUNNING", "TERMINATED"]
+
+
+def test_send_email_user_lookup_fails(callback, user_email, send_email):
+    user_email.side_effect = UserLookupError("Could not get session info: expired")
+    with pytest.raises(Exception, match="Could not find the user.*expired"):
+        SendEmail(inputs=INPUTS).execute()
+    send_email.assert_not_called()
+    assert statuses(callback) == ["STARTED", "RUNNING", "TERMINATED"]
+
+
+def test_send_email_fails(callback, user_email, send_email):
+    send_email.side_effect = RuntimeError("SMTP unreachable")
+    with pytest.raises(Exception, match="SMTP unreachable"):
+        SendEmail(inputs=INPUTS).execute()
+    assert statuses(callback) == ["STARTED", "RUNNING", "TERMINATED"]
+
+
+def test_send_email_data_portal_url(callback, user_email, send_email, monkeypatch):
+    monkeypatch.setenv("DATA_PORTAL_URL", "https://data.example.org")
+    SendEmail(inputs=INPUTS).execute()
+    assert (
+        "https://data.example.org/investigation/12345/datasets"
+        in send_email.call_args.args[2]
+    )
+
+
+def test_send_email_contact_email(callback, user_email, send_email, monkeypatch):
+    monkeypatch.setenv("CONTACT_EMAIL", "help@example.org")
+    SendEmail(inputs=INPUTS).execute()
+    assert 'href="mailto:help@example.org"' in send_email.call_args.args[2]
+
+
+def test_send_email_signature(callback, user_email, send_email, monkeypatch):
+    monkeypatch.setenv("EMAIL_SIGNATURE", "The Data Portal of the facility")
+    SendEmail(inputs=INPUTS).execute()
+    assert (
+        "<p>Best regards,<br />The Data Portal of the facility</p>"
+        in send_email.call_args.args[2]
+    )
+
+
+def test_send_email_escapes_context(callback, user_email, send_email):
+    context = {**INPUTS["context"], "generated_at": "<script>"}
+    SendEmail(inputs={**INPUTS, "context": context}).execute()
+    body = send_email.call_args.args[2]
+    assert "<script>" not in body
+    assert "&lt;script&gt;" in body
+
+
+def test_send_email_missing_context_variable(callback, user_email, send_email):
+    with pytest.raises(Exception, match="generated_at"):
+        SendEmail(inputs={**INPUTS, "context": {"investigation_id": 12345}}).execute()
+    send_email.assert_not_called()
+    assert statuses(callback) == ["STARTED", "RUNNING", "TERMINATED"]
+
+
+def test_send_email_unknown_template(callback, user_email, send_email):
+    with pytest.raises(Exception, match="unknown"):
+        SendEmail(inputs={**INPUTS, "template": "unknown"}).execute()
+    send_email.assert_not_called()
+
+
+@pytest.mark.parametrize("missing", ["subject", "template"])
+def test_send_email_missing_input(missing):
+    inputs = {k: v for k, v in INPUTS.items() if k != missing}
+    with pytest.raises(Exception, match=missing):
+        SendEmail(inputs=inputs).execute()

ewoksdrac-0.1.0/src/ewoksdrac/tests/test_smtp.py

@@ -0,0 +1,65 @@
+from unittest.mock import patch
+
+import pytest
+
+from ewoksdrac.tasks.mail.smtp import send_email
+
+
+@pytest.fixture
+def smtp():
+    with patch("ewoksdrac.tasks.mail.smtp.smtplib.SMTP") as smtp:
+        yield smtp
+
+
+def sent_message(smtp):
+    return smtp.return_value.__enter__.return_value.send_message.call_args.args[0]
+
+
+def test_send_email(smtp, monkeypatch):
+    monkeypatch.setenv("SMTP_HOST", "smtp.esrf.fr")
+    monkeypatch.setenv("SMTP_PORT", "587")
+    monkeypatch.setenv("SMTP_FROM", "drac@esrf.fr")
+    send_email(["alice@esrf.fr", "bob@esrf.fr"], "MX report", "<p>Hello</p>")
+
+    smtp.assert_called_once_with("smtp.esrf.fr", 587, timeout=30)
+    message = sent_message(smtp)
+    assert message["Subject"] == "MX report"
+    assert message["From"] == "drac@esrf.fr"
+    assert message["To"] == "alice@esrf.fr, bob@esrf.fr"
+    assert message.get_content_type() == "text/html"
+    assert message.get_content().strip() == "<p>Hello</p>"
+
+
+def test_send_email_defaults(smtp, monkeypatch):
+    for name in ("SMTP_HOST", "SMTP_PORT", "SMTP_FROM"):
+        monkeypatch.delenv(name, raising=False)
+    send_email(["alice@esrf.fr"], "MX report", "<p>Hello</p>")
+
+    smtp.assert_called_once_with("localhost", 25, timeout=30)
+    assert sent_message(smtp)["From"] == "dataportal@esrf.fr"
+
+
+def test_send_email_with_attachments(smtp, tmp_path):
+    report = tmp_path / "mx_report_12345.csv"
+    report.write_text("a,b\n1,2\n")
+    image = tmp_path / "plot.png"
+    image.write_bytes(b"\x89PNG")
+    send_email(
+        ["alice@esrf.fr"], "MX report", "<p>Hello</p>", [str(report), str(image)]
+    )
+
+    attachments = list(sent_message(smtp).iter_attachments())
+    assert [a.get_filename() for a in attachments] == [
+        "mx_report_12345.csv",
+        "plot.png",
+    ]
+    assert [a.get_content_type() for a in attachments] == ["text/csv", "image/png"]
+    assert attachments[0].get_content() == "a,b\n1,2\n"
+
+
+def test_send_email_missing_attachment(smtp, tmp_path):
+    with pytest.raises(FileNotFoundError):
+        send_email(
+            ["alice@esrf.fr"], "MX report", "<p>Hello</p>", [str(tmp_path / "nope")]
+        )
+    smtp.assert_not_called()

ewoksdrac-0.1.0/src/ewoksdrac/tests/utils.py

@@ -0,0 +1,26 @@
+from unittest.mock import MagicMock
+
+
+def statuses(callback):
+    return [
+        c.kwargs["json"]["status"]
+        for c in callback.call_args_list
+        if "status" in c.kwargs["json"]
+    ]
+
+
+def messages(callback):
+    return [
+        c.kwargs["json"]["logs"]["msg"]
+        for c in callback.call_args_list
+        if "msg" in c.kwargs["json"].get("logs", {})
+    ]
+
+
+def fail_on_status(status):
+    def put(url, json, timeout):
+        if json.get("status") == status:
+            raise ConnectionError("portal unreachable")
+        return MagicMock()
+
+    return put

ewoksdrac-0.1.0/src/ewoksdrac.egg-info/PKG-INFO

@@ -0,0 +1,64 @@
+Metadata-Version: 2.4
+Name: ewoksdrac
+Version: 0.1.0
+Summary: Ewoks tasks for the Data Portal
+Author-email: ESRF <dau-pydev@esrf.fr>
+License: # MIT License
+        
+        **Copyright (c) 2026 European Synchrotron Radiation Facility**
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy of
+        this software and associated documentation files (the "Software"), to deal in
+        the Software without restriction, including without limitation the rights to
+        use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+        the Software, and to permit persons to whom the Software is furnished to do so,
+        subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+        FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+        COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+        IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+        CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+        
+Project-URL: Homepage, https://gitlab.esrf.fr/workflow/ewoksapps/ewoksdrac/
+Project-URL: Documentation, https://ewoksdrac.readthedocs.io/
+Project-URL: Repository, https://gitlab.esrf.fr/workflow/ewoksapps/ewoksdrac/
+Project-URL: Issues, https://gitlab.esrf.fr/workflow/ewoksapps/ewoksdrac/issues
+Project-URL: Changelog, https://gitlab.esrf.fr/workflow/ewoksapps/ewoksdrac/-/blob/main/CHANGELOG.md
+Keywords: ewoks
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: ewokscore
+Requires-Dist: requests
+Requires-Dist: pydantic
+Requires-Dist: jinja2
+Requires-Dist: minedrac>=1.1.0
+Provides-Extra: test
+Requires-Dist: pytest>=7; extra == "test"
+Provides-Extra: dev
+Requires-Dist: ewoksdrac[test]; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Provides-Extra: doc
+Requires-Dist: ewoksdrac[test]; extra == "doc"
+Requires-Dist: sphinx>=4.5; extra == "doc"
+Requires-Dist: sphinx-autodoc-typehints>=1.16; extra == "doc"
+Requires-Dist: pydata-sphinx-theme; extra == "doc"
+Requires-Dist: sphinx-copybutton; extra == "doc"
+Requires-Dist: ewokssphinx>=2.0; extra == "doc"
+Dynamic: license-file
+
+# ewoksdrac
+
+Ewoks tasks for the Data Portal
+
+## Documentation
+
+https://ewoksdrac.readthedocs.io/

ewoksdrac-0.1.0/src/ewoksdrac.egg-info/SOURCES.txt

@@ -0,0 +1,34 @@
+LICENSE.md
+README.md
+pyproject.toml
+src/ewoksdrac/__init__.py
+src/ewoksdrac.egg-info/PKG-INFO
+src/ewoksdrac.egg-info/SOURCES.txt
+src/ewoksdrac.egg-info/dependency_links.txt
+src/ewoksdrac.egg-info/entry_points.txt
+src/ewoksdrac.egg-info/requires.txt
+src/ewoksdrac.egg-info/top_level.txt
+src/ewoksdrac/tasks/__init__.py
+src/ewoksdrac/tasks/base_tasks/__init__.py
+src/ewoksdrac/tasks/base_tasks/drac_investigation_task.py
+src/ewoksdrac/tasks/base_tasks/drac_investigation_task_inputs.py
+src/ewoksdrac/tasks/base_tasks/drac_task.py
+src/ewoksdrac/tasks/base_tasks/drac_task_inputs.py
+src/ewoksdrac/tasks/base_tasks/drac_task_outputs.py
+src/ewoksdrac/tasks/mail/__init__.py
+src/ewoksdrac/tasks/mail/render.py
+src/ewoksdrac/tasks/mail/send.py
+src/ewoksdrac/tasks/mail/send_inputs.py
+src/ewoksdrac/tasks/mail/smtp.py
+src/ewoksdrac/tasks/mail/templates/base.html.j2
+src/ewoksdrac/tasks/mail/templates/mx_report.html.j2
+src/ewoksdrac/tasks/report/__init__.py
+src/ewoksdrac/tasks/report/mx.py
+src/ewoksdrac/tasks/report/mx_inputs.py
+src/ewoksdrac/tasks/report/mx_outputs.py
+src/ewoksdrac/tests/__init__.py
+src/ewoksdrac/tests/conftest.py
+src/ewoksdrac/tests/test_mx_report.py
+src/ewoksdrac/tests/test_send_email.py
+src/ewoksdrac/tests/test_smtp.py
+src/ewoksdrac/tests/utils.py

ewoksdrac-0.1.0/src/ewoksdrac.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

ewoksdrac-0.1.0/src/ewoksdrac.egg-info/entry_points.txt

@@ -0,0 +1,3 @@
+[ewoks.tasks.class]
+ewoksdrac.tasks.mail.* = ewoksdrac
+ewoksdrac.tasks.report.* = ewoksdrac

ewoksdrac-0.1.0/src/ewoksdrac.egg-info/requires.txt

@@ -0,0 +1,20 @@
+ewokscore
+requests
+pydantic
+jinja2
+minedrac>=1.1.0
+
+[dev]
+ewoksdrac[test]
+ruff
+
+[doc]
+ewoksdrac[test]
+sphinx>=4.5
+sphinx-autodoc-typehints>=1.16
+pydata-sphinx-theme
+sphinx-copybutton
+ewokssphinx>=2.0
+
+[test]
+pytest>=7

ewoksdrac-0.1.0/src/ewoksdrac.egg-info/top_level.txt

@@ -0,0 +1 @@
+ewoksdrac