add tests

tests/test_specsscan_metadata.py

@@ -0,0 +1,112 @@
+"""Tests specific for metadata retrieval"""
+from __future__ import annotations
+
+import datetime
+import json
+from unittest.mock import MagicMock
+from unittest.mock import patch
+
+import numpy as np
+import pytest
+
+from specsscan.metadata import get_archiver_data
+from specsscan.metadata import MetadataRetriever
+
+
+@pytest.fixture
+def metadata_config():
+    return {
+        "elab_url": "http://example.com",
+        "epics_channels": {"channel1": "channel1"},
+        "archiver_url": "http://archiver.example.com",
+        "aperture_config": {
+            datetime.datetime.fromisoformat("2023-01-01T00:00:00"): {
+                "fa_size": {"1.0": [(0, 1), (0, 1)]},
+                "ca_size": {"1.0": (0, 1)},
+            },
+        },
+        "lens_mode_config": {"mode1": {"lens1": 1.0, "lens2": 2.0}},
+        "fa_in_channel": "fa_in",
+        "fa_hor_channel": "fa_hor",
+        "ca_in_channel": "ca_in",
+    }
+
+
+@pytest.fixture
+def metadata_retriever(metadata_config):
+    return MetadataRetriever(metadata_config, "dummy_token")
+
+
+def test_metadata_retriever_init(metadata_retriever):
+    assert metadata_retriever.token == "dummy_token"
+    assert metadata_retriever.url == "http://example.com"
+
+
+@patch("specsscan.metadata.urlopen")
+def test_get_archiver_data(mock_urlopen):
+    """Test get_archiver_data using a mock of urlopen."""
+    mock_response = MagicMock()
+    mock_response.read.return_value = json.dumps(
+        [{"data": [{"secs": 1, "nanos": 500000000, "val": 10}]}],
+    )
+    mock_urlopen.return_value.__enter__.return_value = mock_response
+
+    ts_from = datetime.datetime(2023, 1, 1).timestamp()
+    ts_to = datetime.datetime(2023, 1, 2).timestamp()
+    archiver_url = "http://archiver.example.com"
+    archiver_channel = "channel1"
+
+    secs, vals = get_archiver_data(archiver_url, archiver_channel, ts_from, ts_to)
+
+    assert np.array_equal(secs, np.array([1.5]))
+    assert np.array_equal(vals, np.array([10]))
+
+
+@patch("specsscan.metadata.get_archiver_data")
+def test_fetch_epics_metadata(mock_get_archiver_data, metadata_retriever):
+    """Test fetch_epics_metadata using a mock of get_archiver_data."""
+    mock_get_archiver_data.return_value = (np.array([1.5]), np.array([10]))
+    metadata = {"scan_info": {}}
+    ts_from = datetime.datetime(2023, 1, 1).timestamp()
+    ts_to = datetime.datetime(2023, 1, 2).timestamp()
+
+    updated_metadata = metadata_retriever.fetch_epics_metadata(ts_from, ts_to, metadata)
+
+    assert updated_metadata["scan_info"]["channel1"] == 10
+
+
+@patch("specsscan.metadata.elabapi_python")
+def test_fetch_elab_metadata(mock_elabapi_python, metadata_config):
+    """Test fetch_elab_metadata using a mock of elabapi_python."""
+    mock_experiment = MagicMock()
+    mock_experiment.id = 1
+    mock_experiment.userid = 1
+    mock_experiment.title = "Test Experiment"
+    mock_experiment.body = "Test Body"
+    mock_experiment.metadata = json.dumps({"extra_fields": {"key": {"value": "value"}}})
+    mock_elabapi_python.ExperimentsApi.return_value.read_experiments.return_value = [
+        mock_experiment,
+    ]
+    mock_user = MagicMock()
+    mock_user.fullname = "Test User"
+    mock_user.email = "[email protected]"
+    mock_user.userid = 1
+    mock_user.orcid = "0000-0000-0000-0000"
+    mock_elabapi_python.UsersApi.return_value.read_user.return_value = mock_user
+    mock_elabapi_python.LinksToItemsApi.return_value.read_entity_items_links.return_value = []
+
+    metadata_retriever = MetadataRetriever(metadata_config, "dummy_token")
+
+    metadata = {}
+    runs = ["run1"]
+
+    updated_metadata = metadata_retriever.fetch_elab_metadata(runs, metadata)
+
+    assert updated_metadata["elabFTW"]["user"]["name"] == "Test User"
+    assert updated_metadata["elabFTW"]["user"]["email"] == "[email protected]"
+    assert updated_metadata["elabFTW"]["user"]["id"] == 1
+    assert updated_metadata["elabFTW"]["user"]["orcid"] == "0000-0000-0000-0000"
+    assert updated_metadata["elabFTW"]["scan"]["title"] == "Test Experiment"
+    assert updated_metadata["elabFTW"]["scan"]["summary"] == "Test Body"
+    assert updated_metadata["elabFTW"]["scan"]["id"] == 1
+    assert updated_metadata["elabFTW"]["scan"]["key"] == "value"