metadata api integration test

Author: douglowe

requirements.testing.txt

@@ -0,0 +1,10 @@
+celery~=5.4.0
+minio~=7.2.10
+requests~=2.32.3
+Flask~=3.0.3
+Werkzeug~=3.0.4
+redis~=5.2.0
+python-dotenv~=1.0.1
+apiflask~=2.4.0
+roc-validator~=0.6.5
+pytest~=8.4.1

tests/data/ro-crate-metadata.json

@@ -0,0 +1,101 @@
+{
+    "@context": "https://w3id.org/ro/crate/1.1/context",
+    "@graph": [
+        {
+            "@id": "./",
+            "@type": "Dataset",
+            "name": "example dataset",
+            "description": "crate that should conform with validator requirements",
+            "datePublished": "2024-03-17T15:55:54+00:00",
+            "license": {
+                "@id": "http://spdx.org/licenses/MIT"
+            },
+            "hasPart": [
+                {
+                    "@id": "paper.pdf"
+                },
+                {
+                    "@id": "results.csv"
+                },
+                {
+                    "@id": "images/figure.svg"
+                },
+                {
+                    "@id": "logs/"
+                }
+            ]
+        },
+        {
+            "@id": "ro-crate-metadata.json",
+            "@type": "CreativeWork",
+            "about": {
+                "@id": "./"
+            },
+            "conformsTo": {
+                "@id": "https://w3id.org/ro/crate/1.1"
+            }
+        },
+        {
+            "@id": "paper.pdf",
+            "@type": "File",
+            "author": [
+                {
+                    "@id": "https://orcid.org/0000-0000-0000-0000"
+                },
+                {
+                    "@id": "https://orcid.org/0000-0000-0000-0001"
+                }
+            ],
+            "encodingFormat": "application/pdf",
+            "name": "manuscript"
+        },
+        {
+            "@id": "results.csv",
+            "@type": "File",
+            "author": {
+                "@id": "https://orcid.org/0000-0000-0000-0000"
+            },
+            "encodingFormat": "text/csv",
+            "name": "experimental data"
+        },
+        {
+            "@id": "images/figure.svg",
+            "@type": "File",
+            "author": {
+                "@id": "https://orcid.org/0000-0000-0000-0001"
+            },
+            "encodingFormat": "image/svg+xml",
+            "name": "bar chart"
+        },
+        {
+            "@id": "logs/",
+            "@type": "Dataset"
+        },
+        {
+            "@id": "https://orcid.org/0000-0000-0000-0000",
+            "@type": "Person",
+            "affiliation": "University of Flatland",
+            "name": "Alice Doe"
+        },
+        {
+            "@id": "https://orcid.org/0000-0000-0000-0001",
+            "@type": "Person",
+            "affiliation": "University of Flatland",
+            "name": "Bob Doe"
+        },
+        {
+            "@id": "#hdr2024",
+            "@type": "Project Meeting",
+            "endDate": "2024-04-16",
+            "location": "Swansea, UK",
+            "name": "HDR-UK 2024",
+            "startDate": "2024-04-15"
+        },
+        {
+            "@id": "https://spdx.org/licenses/MIT",
+            "@type": "CreativeWork",
+            "name": "MIT Licence",
+            "identifier": "MIT"
+        }
+    ]
+}

tests/metadata_integration.py

@@ -0,0 +1,53 @@
+import pytest
+import subprocess
+import time
+import requests
+import json
+import os
+
+
+@pytest.fixture(scope="session", autouse=True)
+def docker_compose():
+    """Start Docker Compose before tests, shut down after."""
+    print("Starting Docker Compose...")
+    subprocess.run(
+        ["docker", "compose", "-f", "docker-compose-develop.yml", "up", "-d"],
+        check=True
+    )
+    time.sleep(10)  # Wait for services to start — adjust as needed
+
+    yield  # Run the tests
+
+    print("Stopping Docker Compose...")
+    subprocess.run(["docker", "compose", "down"], check=True)
+
+
+
+def test_validate_metadata():
+    url = "http://localhost:5001/ro_crates/validate_metadata"
+    headers = {
+        "accept": "application/json",
+        "Content-Type": "application/json"
+    }
+
+    # Load the JSON from file
+    filepath = os.path.join("tests/data", "ro-crate-metadata.json")
+    with open(filepath, "r", encoding="utf-8") as f:
+        crate_json_data = json.load(f)
+
+    # The API expects the JSON to be passed as a string
+    payload = {
+        "crate_json": json.dumps(crate_json_data)
+    }
+
+    response = requests.post(url, json=payload, headers=headers)
+
+    response_result = json.loads(response.json()['result'])
+
+    # Print response for debugging
+    print("Status Code:", response.status_code)
+    print("Response JSON:", response_result)
+
+    # Assertions — update based on expected API behavior
+    assert response.status_code == 200
+    assert response_result['passed'] == True