Maintainer Validation Checklist - Uninstall Cleanup Fix

This document provides step-by-step validation procedures for maintainers to confirm the uninstall cleanup improvements work correctly.

Summary of Changes

Files Modified

  1. debian/postrm - Complete rewrite with proper cleanup logic
  2. uninstall.sh - Consolidated script with user-local, system-wide, and verification modes
  3. tests/test_uninstall.sh - Enhanced test coverage including all modes

Consolidation

The functionality of three separate scripts has been consolidated into a single uninstall.sh:

  • Default behavior: User-local uninstall
  • --system flag: System-wide cleanup
  • --all flag: Both user-local and system-wide
  • --verify flag: Verification of complete removal

Quick Validation

Run all tests to ensure everything works:

# Install BATS if not already installed
sudo apt-get install -y bats

# Run all uninstall-related tests
bats tests/test_uninstall.sh

Expected result: All 19 tests should pass.

Detailed Validation Procedures

Test 1: User-Local Installation and Removal

Purpose: Verify user-local install/uninstall cycle works correctly.

Steps:

# 1. Install to user home directory
./install.sh

# 2. Verify files are installed
ls ~/.local/share/nemo/actions/git*.nemo_action
ls ~/.local/share/nemo/nemo-git-integration/
ls ~/.local/share/nemo-python/extensions/nemo_git_status.py
ls ~/.config/nemo/actions/actions-tree.json

# 3. Uninstall
./uninstall.sh

# 4. Verify complete removal
./uninstall.sh --verify

Expected Result:

  • Step 2: All files should exist
  • Step 4: Output should show “All nemo-git-integration files successfully removed!”

Test 2: Debian Package Installation and Removal

Purpose: Verify system-wide package install/uninstall works correctly.

Prerequisites: Must have built the .deb package first.

Steps:

# 1. Build the package
make deb

# 2. Install the package
sudo dpkg -i ../nemo-git-integration_*.deb

# 3. Verify system-wide installation
ls /usr/share/nemo/actions/git*.nemo_action
ls /usr/share/nemo-git-integration/
ls /usr/share/nemo-python/extensions/nemo_git_status.py
ls /etc/xdg/nemo/actions/actions-tree.json

# 4. Purge the package
sudo dpkg --purge nemo-git-integration

# 5. Verify complete removal
sudo ./uninstall.sh --verify

Expected Result:

  • Step 3: All system files should exist
  • Step 5: Output should show “All nemo-git-integration files successfully removed!”

Test 3: Cleanup Script Functionality

Purpose: Verify comprehensive cleanup script handles both installations.

Steps:

# 1. Install user-local
./install.sh

# 2. Run cleanup
./uninstall.sh --all

# 3. Verify removal
./uninstall.sh --verify

Expected Result:

  • Step 3: Should report complete removal

Test 4: Idempotency

Purpose: Verify scripts can be run multiple times safely.

Steps:

# Run uninstall multiple times
./uninstall.sh
./uninstall.sh
./uninstall.sh

# Run cleanup multiple times
./uninstall.sh --all
./uninstall.sh --all
./uninstall.sh --all

# Verify no errors and clean state
./uninstall.sh --verify

Expected Result:

  • No errors from any script
  • Final verification shows clean state

Test 5: Nemo Context Menu Check

Purpose: Verify Git menu items disappear after uninstall (manual test).

Prerequisites:

  • Nemo file manager installed
  • Desktop environment running

Steps:

# 1. Install
./install.sh

# 2. Open Nemo and right-click a folder
# Verify: Git submenu appears with actions

# 3. Uninstall
./uninstall.sh

# 4. Clear Nemo cache and restart
rm -rf ~/.cache/nemo
nemo -q
sleep 2
nemo &

# 5. Open Nemo and right-click a folder again
# Verify: Git submenu no longer appears

Expected Result:

  • After step 2: Git menu items visible
  • After step 5: Git menu items NOT visible

Test 6: Selective File Removal

Purpose: Verify uninstall doesn’t delete unrelated user files.

Steps:

# 1. Create unrelated files in same directories
mkdir -p ~/.local/share/icons
touch ~/.local/share/icons/my-custom-icon.png
touch ~/.local/share/nemo/actions/my-custom-action.nemo_action

# 2. Install nemo-git-integration
./install.sh

# 3. Uninstall nemo-git-integration
./uninstall.sh

# 4. Verify custom files still exist
ls ~/.local/share/icons/my-custom-icon.png
ls ~/.local/share/nemo/actions/my-custom-action.nemo_action

# 5. Cleanup test files
rm ~/.local/share/icons/my-custom-icon.png
rm ~/.local/share/nemo/actions/my-custom-action.nemo_action

Expected Result:

  • Step 4: Custom files should still exist (not deleted)

Test 7: System-Wide Cleanup (Requires Root)

Purpose: Verify uninstall.sh can clean system-wide installation.

Steps:

# 1. Install system-wide via package
sudo dpkg -i ../nemo-git-integration_*.deb

# 2. Use cleanup script with --system flag
sudo ./uninstall.sh --all --system

# 3. Verify removal
sudo ./uninstall.sh --verify

Expected Result:

  • Step 3: Should report complete removal

Regression Testing

After changes, verify these scenarios don’t break:

Scenario 1: Normal Install/Uninstall Still Works

./install.sh && ./uninstall.sh
echo $?  # Should be 0

Scenario 2: Package Building Still Works

make deb
echo $?  # Should be 0
ls -l ../nemo-git-integration_*.deb  # Package should exist

Scenario 3: Existing Tests Still Pass

bats tests/test_*.sh
# All tests should pass

Performance Testing

Verify scripts execute in reasonable time:

# Each should complete in under 5 seconds
time ./install.sh
time ./uninstall.sh
time ./uninstall.sh --all
time ./uninstall.sh --verify

Edge Cases to Test

Edge Case 1: Partial Installation

# Create only some files
mkdir -p ~/.local/share/nemo/actions
touch ~/.local/share/nemo/actions/git01a-init.nemo_action

# Run uninstall
./uninstall.sh

# Should handle gracefully without errors
echo $?  # Should be 0

Edge Case 2: No Installation

# Run uninstall without any installation
./uninstall.sh

# Should handle gracefully
echo $?  # Should be 0

Edge Case 3: Mixed Installation

# Install user-local
./install.sh

# Also manually copy a file to system location
sudo mkdir -p /usr/share/nemo/actions
sudo touch /usr/share/nemo/actions/git01a-init.nemo_action

# Run user cleanup
./uninstall.sh --all

# Verify user files removed but system file remains
./uninstall.sh --verify  # Should detect system file

# Cleanup system file
sudo ./uninstall.sh --all --system

Documentation Validation

Verify documentation is accurate and helpful:

  1. Read through docs/UNINSTALL.md
  2. Follow each procedure listed
  3. Confirm all commands work as documented
  4. Check that troubleshooting steps resolve common issues

Sign-Off Checklist

Mark each item as complete:

  • All 19 automated tests pass
  • User-local install/uninstall cycle works
  • System-wide install/purge works
  • Cleanup script removes all files
  • Scripts are idempotent
  • Nemo menu items disappear after uninstall
  • Unrelated user files are preserved
  • No errors in any normal usage scenario
  • Documentation is accurate and complete
  • Performance is acceptable (<5s per operation)
  • Edge cases handled gracefully
  • Regression tests pass

Known Limitations

Document any known issues or limitations:

  1. Nemo Auto-restart: The scripts attempt to restart Nemo, but this may not work in all desktop environments. Users may need to manually restart or log out/in.

  2. System-Wide Cache Clearing: The debian/postrm script attempts to clear Nemo cache for logged-in users, but this is best-effort and may not work for all users.

  3. Icon Cache: Icon cache updates require gtk-update-icon-cache, which may not be available on all systems.

Troubleshooting for Maintainers

If validation fails:

  1. Check test output: bats -t tests/test_uninstall.sh for detailed output
  2. Verify dependencies: Ensure jq, zenity, git are installed
  3. Check permissions: Some operations require write access to test directories
  4. Review logs: Scripts output [INFO] and [ERROR] messages
  5. Manual inspection: Use ls -la to check directories mentioned in uninstall.sh

Reporting Issues

If you find issues during validation:

  1. Note which test/scenario failed
  2. Capture full output/error messages
  3. Document your environment (OS, Nemo version, installation method)
  4. Create a GitHub issue with this information

Additional Resources