12367 GitHub actions workflow for jenkins redundancy by srmanda-cs · Pull Request #12368 · IQSS/dataverse

srmanda-cs · 2026-04-29T14:45:46Z

What this PR does / why we need it:
Add a GitHub Actions Workflow that replicates the exact same tests that Jenkins run with the same configurations, but with containers instead

Which issue(s) this PR closes:

Special notes for your reviewer:
All your suggestions and criticism are deeply welcome, and since it is a major workflow I'm willing to work on it again and again until it meets Dataverse's needs accurately and addresses any concerns the team has. There will probably be a lot, since this is a prototype workflow that I quickly hacked together in a few weeks.

Suggestions on how to test this:
Clicking run workflow should do it.

Does this PR introduce a user interface change? If mockups are available, please link/include them here:
N/A

Is there a release notes update needed for this change?:
N/A

Additional documentation:
Depends on where and how you would want me to document it.

Copilot

Pull request overview

Adds a new GitHub Actions workflow intended to run the same API/integration test suite as Jenkins, but against a Dataverse stack started via the Maven container tooling, improving CI redundancy and visibility of failures.

Changes:

Added .github/workflows/container_integration_tests.yml to build/start the container stack, run tests/integration-tests.txt, and publish test artifacts/results.
Updated SearchIT to search for the dataset via the id:dataset_<id> query pattern.
Disabled testRetrieveMyDataCollections in DataRetrieverApiIT.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 8 comments.

File	Description
`src/test/java/edu/harvard/iq/dataverse/api/SearchIT.java`	Adjusts dataset search query to use `id:dataset_<id>` format.
`src/test/java/edu/harvard/iq/dataverse/api/DataRetrieverApiIT.java`	Disables a failing/unstable test method.
`.github/workflows/container_integration_tests.yml`	Introduces a new container-based integration test workflow, including reporting and artifacts.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

srmanda-cs · 2026-04-29T15:31:37Z

+          # The pom.xml automatically merged the files and put them here:
+          mvn coveralls:report \
+            -P all-unit-tests \
+            -DrepoToken=$COVERALLS_REPO_TOKEN \
+            -DjacocoReports=target/site/jacoco-merged-test-coverage-report/jacoco.xml


This is probably wrong, but let me verify just in case.

This is right, JaCoCo reporting is failing

Is this related to why I don't see this branch over at https://coveralls.io/github/IQSS/dataverse ? Check this out:

pdurbin

This is fantastic! Thanks, @srmanda-cs! ❤️

I'm leaving a few comments and will co-assign you.

pdurbin · 2026-05-02T17:45:08Z

+      - ".github/*.md"
+  pull_request:
+    branches:
+      - develop


Should we add "master" here? That way the tests will run when we release, I would think, after this step: https://guides.dataverse.org/en/6.10.1/developers/making-releases.html#merge-develop-into-master-non-hotfix-only

Here's an example of where we merged develop into master:

merge develop into master for 6.10.1 #12259

Absolutely, I'll add master in there. (I actually didn't know y'all used master)

pdurbin · 2026-05-02T17:46:31Z

+  push:
+    branches:
+      - develop
+    paths-ignore:
+      - "doc/**"
+      - "**/*.md"
+      - ".github/ISSUE_TEMPLATE/**"
+      - ".github/*.md"


Do we need "push" at all? We have branch protection turned on for both "develop" and "master".

We don't "need" push strictly speaking, but its a bit of defensive programming. Just in case. It doesn't hurt to be there, and lets the team know if something is broken in case of emergencies if anyone decides to disable branch protection for a "quick fix".

pdurbin · 2026-05-02T17:50:01Z

+          DVAPIKEY: "burrito"
+          DV_APIKEY: "burrito"
+          DV_API_KEY: "burrito"


Do we need all three of these? 🌯 🌯 🌯

and how on earth did we get three of them? 😇

The tests start randomly crying when I remove any one of these, so I'm too afraid to touch them at this point. I imported it directly from Jenkins ;)

pdurbin · 2026-05-02T17:51:24Z

+        run: |
+          set -euo pipefail
+          # Fixes MakeDataCountApiIT
+          docker exec dev_dataverse sh -c 'curl https://raw.githubusercontent.com/IQSS/dataverse/develop/src/test/java/edu/harvard/iq/dataverse/makedatacount/sushi_sample_logs.json > /tmp/sushi_sample_logs.json && head /tmp/sushi_sample_logs.json'


I guess this will work but would it make more sense to copy the sushi_sample_logs.json file locally rather than downloading it from GitHub?

That's actually a really good idea! I'll implement this.

Done, this should be implemented now!

pdurbin · 2026-05-02T17:52:25Z

+          # The pom.xml automatically merged the files and put them here:
+          mvn coveralls:report \
+            -P all-unit-tests \
+            -DrepoToken=$COVERALLS_REPO_TOKEN \
+            -DjacocoReports=target/site/jacoco-merged-test-coverage-report/jacoco.xml


Is this related to why I don't see this branch over at https://coveralls.io/github/IQSS/dataverse ? Check this out:

pdurbin · 2026-05-02T17:57:01Z

    }

    // Test getting a list of collections that the user can add datasets to
+    @Disabled("Temporarily disabled because this integration test is not reliable in CI; re-enable once stabilized. All assertions return one extra dataset than expected.")


Once we merge this PR, we plan to re-enable this test. See the following:

Fix DataRetrieverApiIT.testRetrieveMyDataCollections() on Github actions #12371

Fix DataRetrieverApiIT.testRetrieveMyDataCollections() for github mig… #12372

Noted. Thank you!

… test

… integration tests

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Updated concurrency group name to include branch reference and removed .txt files from paths-ignore.

Removed .txt files from paths-ignore in workflow.

Temporarily disable unreliable integration test for retrieving data collections.

Removed force_run input from workflow dispatch.

Replace curl command with docker cp for SUSHI config file.

Replaced local file copy with curl command to fetch SUSHI config.

Added master branch to push and pull_request triggers.

Updated the method of placing the SUSHI config file in the container by copying it directly from the repository instead of using curl.

Updated the workflow to check for the existence of the source file before copying it to the container.

Replace file existence check and copy method with direct injection into container.

…ec search

…EY and update jacoco step

…jacoco overwrites

…jacoco fix

Added JaCoCo agent configuration for code coverage.

Added JaCoCo agent download step and updated report generation to include XML output.

Reduced timeout for integration tests and cleaned up comments.

Copilot AI review requested due to automatic review settings April 29, 2026 14:45

srmanda-cs requested review from pdurbin and poikilotherm as code owners April 29, 2026 14:45

Copilot started reviewing on behalf of srmanda-cs April 29, 2026 14:46 View session

Copilot AI reviewed Apr 29, 2026

View reviewed changes

pdurbin added this to IQSS Dataverse Project Apr 29, 2026

pdurbin moved this to In Review 🔎 in IQSS Dataverse Project Apr 29, 2026

pdurbin self-assigned this Apr 29, 2026

This was referenced Apr 29, 2026

Let contributors know why tests are failing #9916

Open

feat(.github/workflows): add container testing workflow #12352

Closed

This was referenced Apr 30, 2026

Fix DataRetrieverApiIT.testRetrieveMyDataCollections() on Github actions #12371

Open

Fix DataRetrieverApiIT.testRetrieveMyDataCollections() for github mig… #12372

Open

pdurbin reviewed May 2, 2026

View reviewed changes

pdurbin assigned srmanda-cs May 2, 2026

srmanda-cs and others added 15 commits May 6, 2026 09:11

feat(api/SearchIT.java): make search more precise and disable failing…

3b177d7

… test

feat(.github/workflows/container_integration_test.yml): add container…

b3581fd

… integration tests

Potential fix for pull request finding

17fe44a

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Modify integration test workflow configuration

c4fecf2

Updated concurrency group name to include branch reference and removed .txt files from paths-ignore.

Update paths-ignore to exclude .txt files

9e803f8

Removed .txt files from paths-ignore in workflow.

Disable unreliable testRetrieveMyDataCollections

bfeaa1e

Temporarily disable unreliable integration test for retrieving data collections.

Update container integration tests workflow

0a6e06f

Removed force_run input from workflow dispatch.

Update SUSHI config file handling in workflow

4732c9d

Replace curl command with docker cp for SUSHI config file.

Enhance curl command with error handling

422ad95

Update jacoco path in integration tests workflow

1021f76

Update SUSHI config file retrieval method

81b1d36

Replaced local file copy with curl command to fetch SUSHI config.

Include master branch in CI workflow triggers

f1c4626

Added master branch to push and pull_request triggers.

Refactor SUSHI config file injection method

007bff9

Updated the method of placing the SUSHI config file in the container by copying it directly from the repository instead of using curl.

Add file existence check before docker cp

42f9539

Updated the workflow to check for the existence of the source file before copying it to the container.

Refactor file injection method for integration tests

4a20d46

Replace file existence check and copy method with direct injection into container.

srmanda-cs force-pushed the 12367-github-actions-workflow-for-jenkins-redundancy branch from c2e72c5 to 4a20d46 Compare May 6, 2026 13:11

srmanda-cs added 5 commits May 6, 2026 09:39

feat(.github/workflows/container_integration_test.yml): test jacoco fix

5a36be3

feat(.github/workflows/container_integration_test.yml): fix sloppy ex…

332197e

…ec search

feat(.github/workflows/container_integration_test.yml): enable DVAPIK…

50b0b6a

…EY and update jacoco step

feat(.github/workflows/container_integration_test.yml): failsafe for …

87b439a

…jacoco overwrites

feat(.github/workflows/container_integration_test.yml): just another …

8729dee

…jacoco fix

cmbz added the FY26 Sprint 22 FY26 Sprint 22 (2026-04-22 - 2026-05-06) label May 6, 2026

srmanda-cs added 4 commits May 6, 2026 12:17

Configure JaCoCo agent in docker-compose for testing

9d896a4

Added JaCoCo agent configuration for code coverage.

Enhance JaCoCo integration in CI workflow

36d86aa

Added JaCoCo agent download step and updated report generation to include XML output.

Reduce timeout and clean up workflow comments

36f9202

Reduced timeout for integration tests and cleaned up comments.

Reorder stopping Dataverse stack in workflow

5c838a1

cmbz added the FY26 Sprint 23 FY26 Sprint 23 (2026-05-06 - 2026-05-20) label May 6, 2026

srmanda-cs added 2 commits May 6, 2026 17:20

Update JaCoCo agent configuration in docker-compose

4d4455e

Update environment variable and JaCoCo execution process

6e25981

Conversation

srmanda-cs commented Apr 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pdurbin left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

srmanda-cs May 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

srmanda-cs commented Apr 29, 2026 •

edited

Loading

srmanda-cs May 4, 2026 •

edited

Loading