Merge pull request #8 from gdcc/test-action

Added action tests

Author: poikilotherm

.github/workflows/scripts/test_dataverse.py

@@ -0,0 +1,108 @@
+import os
+from urllib.parse import urljoin
+import requests
+
+
+class TestNativeAPI:
+    """
+    This class contains test cases for the Dataverse Native API to validate
+    that the Dataverse instance constructed by the Action is working as expected.
+
+    Test cases:
+        - Test the 'info' endpoint of the API.
+        - Test the 'metadatablocks' endpoint of the API.
+        - Test creating a collection using the API.
+    """
+
+    @staticmethod
+    def construct_url(endpoint):
+        """Helper method to construct a URL from an endpoint."""
+
+        BASE_URL = os.environ["BASE_URL"]
+        return urljoin(BASE_URL, endpoint)
+
+    @staticmethod
+    def construct_header():
+        """Helper method to construct the header for the request."""
+
+        return {"X-Dataverse-key": os.environ["API_TOKEN"]}
+
+    def test_info(self):
+        """
+        Test the 'info' endpoint of the API.
+
+        This method constructs the URL for the 'api/info/version' endpoint,
+        sends a GET request to the URL, and asserts that the response status
+        code is 200 and the 'status' field in the response JSON is 'OK'.
+        """
+
+        DV_VERSION = os.getenv("DV_VERSION")
+        url = self.construct_url("api/info/version")
+        response = requests.get(url)
+
+        assert response.status_code == 200, response.text
+        assert response.json()["status"] == "OK"
+        assert response.json()["data"]["version"] == DV_VERSION
+
+    def test_metadatablocks(self):
+        """
+        Test case for the 'metadatablocks' endpoint.
+
+        This test verifies that the 'metadatablocks' endpoint returns a successful response
+        with the expected metadata block information.
+
+        It constructs the URL for the 'metadatablocks' endpoint, sends a GET request,
+        and asserts that the response status code is 200 (OK) and the response JSON
+        contains the expected metadata block information.
+
+        Expected metadata block information:
+        - displayName: "Citation Metadata"
+        - name: "citation"
+        """
+
+        url = self.construct_url("api/metadatablocks")
+        response = requests.get(url)
+
+        assert response.status_code == 200, response.text
+        assert response.json()["status"] == "OK"
+
+        expected = {
+            "displayName": "Citation Metadata",
+            "name": "citation",
+        }
+
+        assert any(
+            {
+                block["name"] == expected["name"]
+                and block["displayName"] == expected["displayName"]
+                for block in response.json()["data"]
+            }
+        )
+
+    def test_create_collection(self):
+        """
+        Test case for creating a collection.
+
+        This test sends a POST request to the specified URL with the necessary headers and payload
+        to create a collection in the dataverse. It then asserts that the response status code is 201
+        and the response JSON contains a "status" key with the value "OK".
+        """
+
+        url = self.construct_url("api/dataverses/root")
+        response = requests.post(
+            url=url,
+            headers=self.construct_header(),
+            json={
+                "name": "TestAction",
+                "alias": "test_colleczion",
+                "dataverseContacts": [
+                    {"contactEmail": "burrito@burritoplace.com"},
+                ],
+                "affiliation": "Burrito Research University",
+                "description": "We do all the (burrito) science.",
+                "dataverseType": "LABORATORY",
+            },
+        )
+
+        assert response.status_code == 201, response.text
+        assert response.json()["status"] == "OK"

.github/workflows/test-action.yml

@@ -1,3 +1,4 @@
+name: Test action
 on: [push]
 
 jobs:
@@ -17,10 +18,18 @@ jobs:
           jvm_options: |
             dataverse.api.signature-secret=eikaizieb2Oghaex
             dataverse.pid.datacite.rest-api-url=https://api.datacite.org
-          create-dv: true
+      - name: Setup Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: "3.11"
+      - name: Install Python Dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install requests pytest
       - name: Check Dataverse Setup
+        env:
+          API_TOKEN: ${{ steps.dataverse.outputs.api_token }}
+          BASE_URL: ${{ steps.dataverse.outputs.base_url }}
+          DV_VERSION: ${{ steps.dataverse.outputs.dv_version }}
         run: |
-          echo "api_token=${{ steps.dataverse.outputs.api_token }}"
-          echo "base_url=${{ steps.dataverse.outputs.base_url }}"
-          echo $(curl http://localhost:8080/api/info/version) && \
-          echo $(curl http://localhost:8080/api/metadatablocks)
+          python3 -m pytest .github/workflows/scripts/test_dataverse.py

README.md

@@ -1,16 +1,28 @@
 # Dataverse Configbaker Action
 
+![Tests](https://github.com/gdcc/dataverse-action/actions/workflows/test-action.yml/badge.svg)
+
 This GitHub Action serves as a powerful tool to effortlessly create a functional Dataverse instance, enabling developers to run comprehensive tests and perform other critical tasks within their GitHub CI workflows.
 
 ## Usage
 
-In order to use this action you need to add the following to your workflow file:
+In order to use the baseline action you need to add the following to your workflow file:
 
 ```yaml
-name: Test Dataverse
+name: Run Dataverse Action
+id: dataverse
 uses: gdcc/dataverse-action@main
-with:
-    create-dv: true
+```
+
+This will create a Dataverse instance with the default configuration. The action will output the API token and base URL of the instance, which can be used to interact with the instance. Here is an example on how to re-use the API token and base URL in a subsequent step:
+
+```yaml
+name: How to re-use outputs
+env:
+    API_TOKEN: ${{ steps.dataverse.outputs.api_token }}
+    BASE_URL: ${{ steps.dataverse.outputs.base_url }}
+run: |
+    my-app --api-token "${{ env.API_TOKEN }}" --base-url "${{ env.BASE_URL }}"
 ```
 
 ## Inputs

action.yml

@@ -23,17 +23,16 @@ inputs:
   jvm_options:
     description: "Line separated key-value pairs of JVM options to be set before startup. Example: dataverse.spi.exporters.directory=/..."
     required: false
-  create-dv:
-    description: "Whether or not to create an example Dataverse"
-    required: true
-    default: "true"
 outputs:
   api_token:
     description: "API Token of dataverseAdmin superuser"
     value: ${{ steps.bootstrap.outputs.API_TOKEN }}
   base_url:
     description: "Base URL where to reach the instance via HTTP"
     value: ${{ steps.bootstrap.outputs.base_url }}
+  dv_version:
+    description: "Dataverse version"
+    value: ${{ steps.bootstrap.outputs.dv_version }}
 runs:
   using: "composite"
   steps:
@@ -100,10 +99,8 @@ runs:
         grep "API_TOKEN" "${RUNNER_TEMP}/dv/bootstrap.exposed.env" >> "$GITHUB_OUTPUT"
         echo "base_url=http://localhost:8080/" >> "$GITHUB_OUTPUT"
         
-        echo "::endgroup::"
-    - name: Retrieve API Token
-      run: ${{ github.action_path }}/scripts/get_api_token.sh
-      shell: bash
-    - name: Create Dataverse
-      run: ${{ github.action_path }}/scripts/create_dataverse.sh
-      shell: bash
+        # Expose version
+        version=$(curl -s 'http://localhost:8080/api/info/version' | jq -r '.data.version')
+        echo "dv_version=$version" >>"$GITHUB_OUTPUT"
+        
+        echo "::endgroup::"