add unit and integration tests

Author: JR-1991

tests/conftest.py

@@ -0,0 +1,69 @@
+import os
+import pytest
+import requests
+
+
+@pytest.fixture
+def credentials():
+    """Returns the credentials for the Dataverse server."""
+    BASE_URL = os.environ.get("BASE_URL")
+    API_TOKEN = os.environ.get("API_TOKEN")
+
+    assert BASE_URL, "BASE_URL environment variable must be set"
+    assert API_TOKEN, "API_TOKEN environment variable must be set"
+
+    return BASE_URL, API_TOKEN
+
+
+def create_dataset(
+    parent: str,
+    server_url: str,
+    api_token: str,
+):
+    """
+    Creates a dataset in a Dataverse.
+
+    Args:
+        parent (str): The parent Dataverse identifier.
+        server_url (str): The URL of the Dataverse server.
+        api_token (str): The API token for authentication.
+
+    Returns:
+        str: The persistent identifier of the created dataset.
+    """
+    if server_url.endswith("/"):
+        server_url = server_url[:-1]
+
+    url = f"{server_url}/api/dataverses/{parent}/datasets"
+    response = requests.post(
+        url=url,
+        headers={"X-Dataverse-key": api_token},
+        data=open("./tests/fixtures/create_dataset.json", "rb"),
+    )
+
+    response.raise_for_status()
+
+    return response.json()["data"]["persistentId"]
+
+
+def create_mock_file(
+    directory: str,
+    name: str,
+    size: int = 100,
+):
+    """Create a file with the specified size in megabytes.
+
+    Args:
+        directory (str): The directory where the file will be created.
+        name (str): The name of the file.
+        size (int, optional): Size of the file in megabytes. Defaults to 100.
+    """
+
+    path = os.path.join(directory, name)
+    size = size * 1024 * 1024
+
+    with open(path, "wb") as f:
+        f.seek(size - 1)  # 1 GB
+        f.write(b"\0")
+
+    return path

tests/fixtures/add_dir_files/.hidden

@@ -0,0 +1 @@
+This file is part of an ignored dir

tests/fixtures/add_dir_files/__to_ignore_dir__/subfile_in_ignore.txt

@@ -0,0 +1 @@
+This is another test

tests/fixtures/add_dir_files/anotherfile.txt

@@ -0,0 +1 @@
+This is a test

tests/fixtures/add_dir_files/somefile.txt

@@ -0,0 +1 @@
+This is a subfile

tests/fixtures/add_dir_files/subdir/subfile.txt

@@ -0,0 +1,7 @@
+persistent_id: doi:10.70122/XXX/XXXXX
+dataverse_url: https://demo.dataverse.org/
+api_token: XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
+files:
+    - filepath: ./tests/fixtures/add_dir_files/somefile.txt
+    - filepath: ./tests/fixtures/add_dir_files/anotherfile.txt
+      directoryLabel: some/dir

tests/fixtures/add_dir_files/to_ignore.txt

@@ -0,0 +1,76 @@
+{
+    "datasetVersion": {
+      "metadataBlocks": {
+        "citation": {
+          "fields": [
+            {
+              "multiple": false,
+              "typeClass": "primitive",
+              "typeName": "title",
+              "value": "My dataset"
+            },
+            {
+              "multiple": true,
+              "typeClass": "controlledVocabulary",
+              "typeName": "subject",
+              "value": [
+                "Other"
+              ]
+            },
+            {
+              "multiple": true,
+              "typeClass": "compound",
+              "typeName": "author",
+              "value": [
+                {
+                  "authorName": {
+                    "multiple": false,
+                    "typeClass": "primitive",
+                    "typeName": "authorName",
+                    "value": "John Doe"
+                  }
+                }
+              ]
+            },
+            {
+              "multiple": true,
+              "typeClass": "compound",
+              "typeName": "datasetContact",
+              "value": [
+                {
+                  "datasetContactName": {
+                    "multiple": false,
+                    "typeClass": "primitive",
+                    "typeName": "datasetContactName",
+                    "value": "John Doe"
+                  },
+                  "datasetContactEmail": {
+                    "multiple": false,
+                    "typeClass": "primitive",
+                    "typeName": "datasetContactEmail",
+                    "value": "john@doe.com"
+                  }
+                }
+              ]
+            },
+            {
+              "multiple": true,
+              "typeClass": "compound",
+              "typeName": "dsDescription",
+              "value": [
+                {
+                  "dsDescriptionValue": {
+                    "multiple": false,
+                    "typeClass": "primitive",
+                    "typeName": "dsDescriptionValue",
+                    "value": "This is a description of the dataset"
+                  }
+                }
+              ]
+            }
+          ]
+        }
+      }
+    }
+  }
+