Tests

Functionality to modify CSL bibliography title and format #22794

Workflow file for this run

	name: Tests

	on:
	push:
	branches:
	- main
	- main-release
	pull_request:
	merge_group:
	workflow_dispatch:

	env:
	SpringerNatureAPIKey: ${{ secrets.SpringerNatureAPIKey }}
	AstrophysicsDataSystemAPIKey: ${{ secrets.AstrophysicsDataSystemAPIKey }}
	IEEEAPIKey: ${{ secrets.IEEEAPIKey }}
	BiodiversityHeritageApiKey: ${{ secrets.BiodiversityHeritageApiKey}}
	GRADLE_OPTS: -Xmx4g
	JAVA_OPTS: -Xmx4g

	concurrency:
	group: "${{ github.workflow }}-${{ github.head_ref \|\| github.ref }}"
	cancel-in-progress: true

	permissions:
	pull-requests: write

	jobs:
	checkstyle:
	name: Checkstyle
	runs-on: ubuntu-latest
	steps:
	- name: Checkout source
	uses: actions/checkout@v4
	with:
	submodules: 'true'
	show-progress: 'false'
	- name: Set up JDK
	uses: actions/setup-java@v4
	with:
	java-version: 23.0.1
	distribution: 'temurin'
	- name: Run checkstyle reporter
	uses: dbelyaev/action-checkstyle@master
	with:
	reporter: github-pr-review
	github_token: ${{ secrets.GITHUB_TOKEN }}
	checkstyle_config: 'config/checkstyle/checkstyle_reviewdog.xml'
	- name: Setup Gradle
	uses: gradle/actions/setup-gradle@v4
	- name: Run checkstyle using gradle
	run: ./gradlew checkstyleMain checkstyleTest checkstyleJmh

	openrewrite:
	name: OpenRewrite
	runs-on: ubuntu-latest
	steps:
	- name: Checkout source
	uses: actions/checkout@v4
	with:
	submodules: 'true'
	show-progress: 'false'
	- name: Set up JDK
	uses: actions/setup-java@v4
	with:
	java-version: 23.0.1
	distribution: 'temurin'
	- name: Setup Gradle
	uses: gradle/actions/setup-gradle@v4
	- name: Run OpenRewrite
	run: \|
	./gradlew rewriteDryRun

	modernizer:
	name: Modernizer
	runs-on: ubuntu-latest
	steps:
	- name: Checkout source
	uses: actions/checkout@v4
	with:
	submodules: 'true'
	show-progress: 'false'
	- name: Set up JDK
	uses: actions/setup-java@v4
	with:
	java-version: 23.0.1
	distribution: 'temurin'
	- name: Setup Gradle
	uses: gradle/actions/setup-gradle@v4
	- name: Run modernizer
	run: \|
	# enable failing of this task if modernizer complains
	sed -i "s/failOnViolations = false/failOnViolations = true/" build.gradle
	./gradlew modernizer

	markdown:
	name: Markdown
	runs-on: ubuntu-latest
	steps:
	- name: Checkout source
	uses: actions/checkout@v4
	with:
	submodules: 'false'
	show-progress: 'false'
	- name: markdownlint-cli2-action
	uses: DavidAnson/markdownlint-cli2-action@v19
	with:
	globs: \|
	*.md
	docs/*/.md

	changelog:
	name: CHANGELOG.md
	runs-on: ubuntu-latest
	steps:
	- name: Checkout source
	uses: actions/checkout@v4
	with:
	submodules: 'false'
	show-progress: 'false'
	- name: Lint CHANGELOG.md
	run: \|
	# Install jbang
	curl -Ls https://sh.jbang.dev \| bash -s - app setup
	export PATH=$PATH:$HOME/.jbang/bin

	# run heylogs verification
	jbang com.github.nbbrd.heylogs:heylogs-cli:0.9.3:bin check CHANGELOG.md > heylogs.txt \|\| true

	# improve output
	sed -i 's/all-h2-contain-a-version/all-h2-contain-a-version (ignored)/' heylogs.txt

	cat heylogs.txt

	# exit 1 in case of error
	# We have 1 "valid" issue in CHANGELOG.md
	grep -q "1 problem" heylogs.txt \|\| exit 1

	changelog-unreleased-only:
	if: github.event_name == 'pull_request'
	name: CHANGELOG.md - only unreleased touched
	runs-on: ubuntu-latest
	steps:
	- name: Checkout source
	uses: actions/checkout@v4
	with:
	submodules: 'false'
	show-progress: 'false'
	fetch-depth: 0
	- name: Cache clparse jar
	id: cache-clparse
	uses: actions/cache@v4
	with:
	path: /tmp/clparse
	key: clparse-0.9.1
	- name: unzip
	if: steps.cache-clparse.outputs.cache-hit != 'true'
	run: \|
	cd /tmp
	curl -LO https://github.com/marcaddeo/clparse/releases/download/0.9.1/clparse-0.9.1-x86_64-unknown-linux-musl.tar.gz
	tar xzvf clparse-0.9.1-x86_64-unknown-linux-musl.tar.gz
	- name: Install clparse
	run: sudo mv /tmp/clparse /usr/local/bin/clparse
	- name: Check CHANGELOG.md diff
	run: \|
	diff \
	<(git show origin/main:CHANGELOG.md \| clparse --format=json --separator=– - \| jq '.releases[] \| select(.version != null)') \
	<(git show HEAD:CHANGELOG.md \| clparse --format=json --separator=– - \| jq '.releases[] \| select(.version != null)')

	tests:
	name: Unit tests
	runs-on: ubuntu-latest
	steps:
	- name: Checkout source
	uses: actions/checkout@v4
	with:
	submodules: 'true'
	show-progress: 'false'
	- name: Set up JDK
	uses: actions/setup-java@v4
	with:
	java-version: 23.0.1
	distribution: 'temurin'
	- name: Setup Gradle
	uses: gradle/actions/setup-gradle@v4
	- name: Run tests
	run: xvfb-run --auto-servernum ./gradlew check -x checkstyleJmh -x checkstyleMain -x checkstyleTest -x modernizer
	env:
	CI: "true"
	- name: Prepare format failed test results
	if: failure()
	uses: awalsh128/cache-apt-pkgs-action@latest
	with:
	packages: xml-twig-tools xsltproc
	version: 1.0
	- name: Format failed test results
	if: failure()
	run: scripts/after-failure.sh

	databasetests:
	name: Database tests
	runs-on: ubuntu-latest
	services:
	postgres:
	image: postgres:13-alpine
	env:
	POSTGRES_USER: postgres
	POSTGRES_PASSWORD: postgres
	POSTGRES_DB: postgres
	ports:
	- 5432:5432
	# needed because the postgres container does not provide a healthcheck
	options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
	steps:
	- name: Checkout source
	uses: actions/checkout@v4
	with:
	submodules: 'true'
	show-progress: 'false'
	- name: Set up JDK
	uses: actions/setup-java@v4
	with:
	java-version: 23.0.1
	distribution: 'temurin'
	- name: Setup Gradle
	uses: gradle/actions/setup-gradle@v4
	- name: Run tests on PostgreSQL
	run: ./gradlew databaseTest --rerun-tasks
	env:
	CI: "true"
	DBMS: "postgresql"
	- name: Shutdown Ubuntu MySQL
	run: sudo service mysql stop # Shutdown the Default MySQL, "sudo" is necessary, please not remove it
	- name: Start custom MySQL
	uses: mirromutth/mysql-action@v1.1
	with:
	host port: 3800
	container port: 3307
	character set server: 'utf8'
	collation server: 'utf8_general_ci'
	mysql version: '8.0'
	mysql database: 'jabref'
	mysql root password: 'root'
	- name: Run tests on MySQL
	run: ./gradlew databaseTest --rerun-tasks
	env:
	CI: "true"
	DBMS: "mysql"

	guitests:
	name: GUI tests
	runs-on: ubuntu-latest
	steps:
	- name: Checkout source
	uses: actions/checkout@v4
	with:
	submodules: 'true'
	show-progress: 'false'
	- name: Set up JDK
	uses: actions/setup-java@v4
	with:
	java-version: 23.0.1
	distribution: 'temurin'
	- name: Setup Gradle
	uses: gradle/actions/setup-gradle@v4
	- name: Run GUI tests
	run: xvfb-run --auto-servernum ./gradlew guiTest
	env:
	CI: "true"

	codecoverage:
	name: Code coverage
	runs-on: ubuntu-latest
	services:
	postgres:
	image: postgres:10.8
	env:
	POSTGRES_USER: postgres
	POSTGRES_PASSWORD: postgres
	POSTGRES_DB: postgres
	ports:
	- 5432:5432
	# needed because the postgres container does not provide a healthcheck
	options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
	steps:
	- name: Check secrets presence
	id: checksecrets
	if: github.ref == 'refs/heads/main'
	shell: bash
	run: \|
	if [ "$CODECOV_TOKEN" == "" ]; then
	echo "secretspresent=NO" >> $GITHUB_OUTPUT
	echo "❌ Secret CODECOV_TOKEN not present"
	else
	echo "secretspresent=YES" >> $GITHUB_OUTPUT
	echo "✔️ Secret CODECOV_TOKEN present"
	fi
	env:
	CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
	- name: Checkout source
	if: github.ref == 'refs/heads/main'
	uses: actions/checkout@v4
	with:
	submodules: 'true'
	show-progress: 'false'
	- name: Set up JDK
	if: github.ref == 'refs/heads/main'
	uses: actions/setup-java@v4
	with:
	java-version: 23.0.1
	distribution: 'temurin'
	- name: Setup Gradle
	uses: gradle/actions/setup-gradle@v4
	- name: Update test coverage metrics
	if: (github.ref == 'refs/heads/main') && (steps.checksecrets.outputs.secretspresent == 'YES')
	run: xvfb-run --auto-servernum ./gradlew jacocoTestReport
	env:
	CI: "true"
	CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
	DBMS: "postgresql"
	- uses: codecov/codecov-action@v5
	if: (github.ref == 'refs/heads/main') && (steps.checksecrets.outputs.secretspresent == 'YES')
	with:
	token: ${{ secrets.CODECOV_TOKEN }}
	- name: Upload Codacy report
	if: (github.ref == 'refs/heads/main') && (steps.checksecrets.outputs.secretspresent == 'YES')
	run: bash <(curl -Ls https://coverage.codacy.com/get.sh)
	env:
	CODACY_PROJECT_TOKEN: ${{ secrets.CODACY_PROJECT_TOKEN }}

	requirements_coverage:
	name: "Validate requirement coverage"
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v4
	with:
	show-progress: 'false'
	- name: Set up JDK
	uses: actions/setup-java@v4
	with:
	java-version: 23.0.1
	distribution: 'temurin'
	- name: Setup Gradle
	uses: gradle/actions/setup-gradle@v4
	- run: ./gradlew traceRequirements
	- if: failure()
	run: cat build/reports/tracing.txt

	# This is https://github.com/marketplace/actions/gradle-wrapper-validation
	# It ensures that the jar file is from gradle and not by a strange third party.
	gradlevalidation:
	name: "Validate Gradle Wrapper"
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v4
	with:
	show-progress: 'false'
	- uses: gradle/actions/wrapper-validation@v4

	mandatory-checks-section-exists:
	if: github.actor != 'dependabot[bot]' && github.event_name == 'pull_request'
	name: Mandatory Checks present
	runs-on: ubuntu-latest
	steps:
	- name: Checkout source
	uses: actions/checkout@v4
	with:
	submodules: 'false'
	show-progress: 'false'

	- name: Check for existence of Mandatory Checks section
	id: check_mandatory_section
	run: \|
	set -e

	BODY=$(gh pr view "${{ github.event.number }}" --json body --template '{{.body}}')

	if echo "$BODY" \| grep -q "### Mandatory checks"; then
	echo "✅ '### Mandatory checks' section found."
	else
	echo "❌ '### Mandatory checks' section is missing!"
	exit 1
	fi
	env:
	GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

	checklist-checked:
	if: github.actor != 'dependabot[bot]' && github.event_name == 'pull_request'
	name: PR checklist OK
	runs-on: ubuntu-latest
	steps:
	- name: Checkout source
	uses: actions/checkout@v4
	with:
	submodules: 'false'
	show-progress: 'false'
	- name: Check for PR checklist
	id: check_changelog_modification
	run: \|
	set -e

	BODY=$(gh pr view "${{ github.event.number }}" --json body --template '{{.body}}' \| grep -A5000 '### Mandatory checks')
	echo "Found body: $BODY"

	# Ensure the section exists
	if ! printf '%s\n' "$BODY" \| grep -q "### Mandatory checks"; then
	echo "❌ '### Mandatory checks' section is missing!"
	exit 1
	fi

	BOXES=$(printf '%s\n' "$BODY" \| grep "^- \[")
	echo "Found boxes: $BOXES"

	while IFS= read -r line; do
	if ! printf '%s\n' "$line" \| grep -Eq "^- \[(x\|/\| )\] "; then
	echo "❌ Found improperly formatted checkbox: '$line'"
	exit 1
	fi
	done <<< "$BOXES"

	LINE_COUNT=$(echo "$BOXES" \| wc -l)

	if [ "$LINE_COUNT" -ne 7 ]; then
	echo "❌ Found $LINE_COUNT lines instead of 7 required lines"
	exit 1
	fi

	echo "✅ All checkboxes are present and in the correct format."
	env:
	GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

	# This ensures that no git merge conflict markers (<<<, ...) are contained
	merge_conflict_job:
	name: Find merge conflicts
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v4
	with:
	show-progress: 'false'
	- name: Merge Conflict finder
	uses: olivernybroe/action-conflict-finder@v4.0

	no-force-push:
	if: github.event_name == 'pull_request'
	runs-on: ubuntu-latest
	steps:
	- name: Checkout repository
	uses: actions/checkout@v4
	with:
	fetch-depth: 0
	- name: Check force push
	id: force_push_check
	run: \|
	if [[ -z "${{ github.event.before }}" ]]; then
	echo "✅ New PR created."
	exit 0
	fi
	if git cat-file -e ${{ github.event.before }} 2>/dev/null; then
	echo "✅ Regular push detected."
	exit 0
	else
	echo "❌ Force push detected"
	exit 1
	fi

	unmodified_submodules:
	name: Submodules not modified
	if: github.actor != 'dependabot[bot]' && github.event_name == 'pull_request'
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v4
	with:
	submodules: true
	show-progress: 'false'
	- name: Check for submodule modifications
	id: check_submodule
	run: \|
	git fetch origin ${{ github.base_ref }}

	# enable diffing of submodules
	sed -i "s/ all/ untracked/" .gitmodules

	if git diff --submodule=log origin/${{ github.base_ref }} HEAD \| grep -Eq "^Submodule .* contains modified content$"; then
	echo "Debug:"
	echo "Command: git diff --submodule=log origin/${{ github.base_ref }} HEAD"
	echo "Result:"
	git diff --submodule=log origin/${{ github.base_ref }} HEAD
	echo "--end--"
	echo "Grep result"
	git diff --submodule=log origin/${{ github.base_ref }} HEAD \| grep -E "^Submodule .* contains modified content$"
	echo "❌ Submodule modifications detected"
	exit 1
	fi
	echo "✅ No submodule modifications"

	other_than_main:
	if: github.event_name == 'pull_request'
	name: Source branch is other than "main"
	runs-on: ubuntu-latest
	steps:
	- if: github.head_ref == 'main'
	uses: actions/github-script@v7
	with:
	script: \|
	core.setFailed('Pull requests should come from a branch other than "main"\n\n👉 Please read [the CONTRIBUTING guide](https://github.com/JabRef/jabref/blob/main/CONTRIBUTING.md#contributing) carefully again. 👈')

	upload-pr-number:
	runs-on: ubuntu-latest
	steps:
	- name: Create pr_number.txt
	run: echo "${{ github.event.number }}" > pr_number.txt
	- uses: actions/upload-artifact@v4
	with:
	name: pr_number
	path: pr_number.txt

	changelog_modified:
	name: CHANGELOG.md needs to be modified
	if: github.actor != 'dependabot[bot]' && github.event_name == 'pull_request'
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v4
	with:
	fetch-depth: 0
	- name: Check PR body for changelog note
	id: changelog_check
	run: \|
	BODY=$(gh pr view "${{ github.event.number }}" --json body --template '{{.body}}')
	echo "Body: $BODY"

	if echo "$BODY" \| grep -q '\- \[x\] Change in `CHANGELOG.md`'; then
	echo "found"
	echo "found=yes" >> $GITHUB_OUTPUT
	else
	echo "not found"
	echo "found=no" >> $GITHUB_OUTPUT
	fi
	env:
	GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
	- name: Check for CHANGELOG.md modifications
	id: check_changelog_modification
	if: steps.changelog_check.outputs.found == 'yes'
	run: \|
	git fetch origin ${{ github.base_ref }}
	if git diff --name-only origin/${{ github.base_ref }}...HEAD \| grep -q '^CHANGELOG\.md$'; then
	echo "✅ CHANGELOG.md was modified"
	else
	echo "❌ CHANGELOG.md was NOT modified"
	exit 1
	fi

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Functionality to modify CSL bibliography title and format #22794

Workflow file

Functionality to modify CSL bibliography title and format #22794

Jobs

Run details

Workflow file for this run