Skip to content

[quality] add BATS tests for ublue-motd double-execution guard (PR #795 coverage) #846

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
clubanderson wants to merge 1 commit into
base: main
Choose a base branch
from
+119 −0
Open

[quality] add BATS tests for ublue-motd double-execution guard (PR #795 coverage) #846

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
119 changes: 119 additions & 0 deletions tests/test_ublue_motd_guard.bats
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,119 @@
#!/usr/bin/env bats
# Tests for the double-execution guard in system_files/shared/etc/profile.d/ublue-motd.sh
# and the env.sh existence guard in system_files/shared/usr/bin/ublue-motd.
#
# These tests validate the changes introduced by PR #795 (fix(motd): prevent
# double-execution and missing env.sh errors).
#
# Run: bats tests/test_ublue_motd_guard.bats

bats_require_minimum_version 1.5.0

Comment on lines +1 to +11

@coderabbitai coderabbitai Bot Jul 21, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Description: Execute all tests using `just test` as instructed by coding guidelines.
just test

Repository: projectbluefin/common

Length of output: 201

🏁 Script executed:

#!/bin/bash
set -euo pipefail

printf '\n== files ==\n'
git ls-files 'tests/test_ublue_motd_guard.bats' 'Justfile' 'AGENTS.md' | cat

printf '\n== test file ==\n'
cat -n tests/test_ublue_motd_guard.bats

printf '\n== just-related targets ==\n'
rg -n '^\s*(test|tests|bats|pytest)\b|just test|bats ' Justfile tests -S || true

Repository: projectbluefin/common

Length of output: 7765

🏁 Script executed:

#!/bin/bash
set -euo pipefail

printf '\n== just test references ==\n'
rg -n '\bjust test\b|\btests/test_ublue_motd_guard\.bats\b|\btest_ublue_motd_guard\b' .github/workflows docs Justfile tests -S || true

printf '\n== workflow files ==\n'
git ls-files '.github/workflows/*' | cat

Repository: projectbluefin/common

Length of output: 1196

🏁 Script executed:

#!/bin/bash
set -euo pipefail

printf '\n== unit-tests workflow ==\n'
sed -n '1,220p' .github/workflows/unit-tests.yml

printf '\n== run-testsuite workflow ==\n'
sed -n '1,220p' .github/workflows/run-testsuite.yml

printf '\n== testing docs ==\n'
sed -n '1,120p' docs/TESTING.md

Repository: projectbluefin/common

Length of output: 9694

Add this Bats test to the main test target
tests/test_ublue_motd_guard.bats isn’t wired into Justfile or .github/workflows/unit-tests.yml, so it won’t run through the repo’s standard just test/CI path yet.

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@tests/test_ublue_motd_guard.bats` around lines 1 - 11, Wire
tests/test_ublue_motd_guard.bats into the repository’s standard test execution
by adding it to the appropriate test target in Justfile and the unit-test
workflow in .github/workflows/unit-tests.yml. Ensure both local just test runs
and CI execute this Bats test.

Source: Coding guidelines

MOTD_PROFILE="${BATS_TEST_DIRNAME}/../system_files/shared/etc/profile.d/ublue-motd.sh"
UBLUE_MOTD_BIN="${BATS_TEST_DIRNAME}/../system_files/shared/usr/bin/ublue-motd"
FISH_GREETING="${BATS_TEST_DIRNAME}/../system_files/shared/usr/share/fish/vendor_conf.d/fish_greeting.fish"

WORKDIR=""

setup() {
WORKDIR="$(mktemp -d)"
mkdir -p "${WORKDIR}/bin" "${WORKDIR}/home/.config" "${WORKDIR}/motd"

# Mock ublue-motd — records invocations
printf '#!/usr/bin/env bash\necho "ublue-motd" >> "%s/motd.log"\n' \
"${WORKDIR}" > "${WORKDIR}/bin/ublue-motd"
chmod +x "${WORKDIR}/bin/ublue-motd"

export HOME="${WORKDIR}/home"
export PATH="${WORKDIR}/bin:${PATH}"
unset UBLUE_MOTD_SHOWN
}

teardown() {
rm -rf "${WORKDIR}"
}

# ---------------------------------------------------------------------------
# ublue-motd.sh — double-execution guard
# ---------------------------------------------------------------------------

@test "ublue-motd.sh: first invocation runs ublue-motd" {
run bash "${MOTD_PROFILE}"
[ "${status}" -eq 0 ]
[ -f "${WORKDIR}/motd.log" ]
grep -q "ublue-motd" "${WORKDIR}/motd.log"
}

@test "ublue-motd.sh: first invocation exports UBLUE_MOTD_SHOWN=1" {
run bash -c "source '${MOTD_PROFILE}'; echo \${UBLUE_MOTD_SHOWN:-unset}"
[ "${status}" -eq 0 ]
[[ "${output}" == *"1"* ]]
}

@test "ublue-motd.sh: second invocation with UBLUE_MOTD_SHOWN=1 skips ublue-motd" {
# Simulate what happens when profile.d is sourced twice in the same shell session
run bash -c "
export UBLUE_MOTD_SHOWN=1
source '${MOTD_PROFILE}'
"
[ "${status}" -eq 0 ]
[ ! -f "${WORKDIR}/motd.log" ]
}

@test "ublue-motd.sh: invocation skipped when no-show-user-motd exists" {
touch "${HOME}/.config/no-show-user-motd"
run bash "${MOTD_PROFILE}"
[ "${status}" -eq 0 ]
[ ! -f "${WORKDIR}/motd.log" ]
}

@test "ublue-motd.sh: contains UBLUE_MOTD_SHOWN guard" {
grep -q 'UBLUE_MOTD_SHOWN' "${MOTD_PROFILE}"
}

@test "ublue-motd.sh: contains no-show-user-motd opt-out check" {
grep -q 'no-show-user-motd' "${MOTD_PROFILE}"
}

# ---------------------------------------------------------------------------
# usr/bin/ublue-motd — env.sh existence guard
# ---------------------------------------------------------------------------

@test "ublue-motd bin: exits 0 when env.sh is missing" {
# Without the guard (old code), sourcing a missing file would abort with exit 1
run env \
MOTD_ENV_SCRIPT="${WORKDIR}/nonexistent-env.sh" \
MOTD_TEMPLATE_FILE="${WORKDIR}/motd/template.md" \
sh "${UBLUE_MOTD_BIN}"
[ "${status}" -eq 0 ]
}

@test "ublue-motd bin: sources env.sh when it exists" {
printf '#!/usr/bin/env sh\nTEST_ENV_LOADED=1\n' > "${WORKDIR}/env.sh"
run env \
MOTD_ENV_SCRIPT="${WORKDIR}/env.sh" \
MOTD_TEMPLATE_FILE="${WORKDIR}/motd/template.md" \
sh "${UBLUE_MOTD_BIN}"
[ "${status}" -eq 0 ]
}

@test "ublue-motd bin: contains [ -f ...] guard for env.sh" {
grep -q '\[ -f' "${UBLUE_MOTD_BIN}"
}

# ---------------------------------------------------------------------------
# fish_greeting.fish — UBLUE_MOTD_SHOWN guard (static assertions)
# Fish is not required in CI; these are grep-based structural checks.
# ---------------------------------------------------------------------------

@test "fish_greeting: contains UBLUE_MOTD_SHOWN guard" {
grep -q 'UBLUE_MOTD_SHOWN' "${FISH_GREETING}"
}

@test "fish_greeting: sets UBLUE_MOTD_SHOWN after invoking ublue-motd" {
grep -q 'set -gx UBLUE_MOTD_SHOWN 1' "${FISH_GREETING}"
}

@test "fish_greeting: still checks no-show-user-motd opt-out" {
grep -q 'no-show-user-motd' "${FISH_GREETING}"
}