TESTING_COMMANDS.md

Testing Commands Guide

This document describes how to test all commands of the AnonymizeBundle in the demo applications.

Table of contents

• Available Commands
• Testing Script
  • Usage
  • What It Tests
  • Prerequisites
  • Output
  • Example Output
  • Customizing Tests
• Manual Testing
  • 1. nowo:anonymize:info
  • 2. nowo:anonymize:run
  • 3. nowo:anonymize:history
  • 4. nowo:anonymize:export-db
  • 5. nowo:anonymize:generate-column-migration
  • 6. nowo:anonymize:generate-mongo-field
• Testing Checklist
• Common Issues
  • Containers not running
  • Database not initialized
  • Permission issues
• Notes

Available Commands

The bundle provides 6 console commands:

1. nowo:anonymize:info - Display information about anonymizers defined in the application
2. nowo:anonymize:run - Execute anonymization of database records
3. nowo:anonymize:history - View and manage anonymization history
4. nowo:anonymize:export-db - Export databases to files with optional compression
5. nowo:anonymize:generate-column-migration - Generate Doctrine migration for anonymized column
6. nowo:anonymize:generate-mongo-field - Generate MongoDB field for anonymized tracking

Testing Script

A comprehensive testing script is available in the scripts/ directory: scripts/test-commands.sh

This script automatically tests all bundle commands with their main options across all demo projects, ensuring compatibility and functionality.

Usage

# Test all commands in all demos (recommended)
./.scripts/test-commands.sh all

# Test in a specific demo
./.scripts/test-commands.sh symfony7
./.scripts/test-commands.sh symfony8

What It Tests

The script tests 26 command combinations (26 entries in the COMMANDS array in scripts/test-commands.sh):

1. nowo:anonymize:info (6 tests)

• Without options (all connections)
• With --connection default, postgres, and sqlite
• With --locale es_ES on the default connection
• With --verbose on the default connection

2. nowo:anonymize:run (6 tests)

• --dry-run with connections default, postgres, and sqlite
• --dry-run with --batch-size 50 and --locale es_ES
• --dry-run with --verbose

Note: All nowo:anonymize:run tests use --dry-run to avoid modifying data during testing.

3. nowo:anonymize:history (4 tests)

• Without options
• With --limit 5
• With --connection default
• Combined --limit 10 --connection default

4. nowo:anonymize:export-db (4 tests)

• One run per connection: default, postgres, sqlite, mongodb

Note: The export command does not define a --dry-run flag in this bundle. These tests run the real export flow (files may be produced under the demo’s configured export paths). Use only in environments where that is acceptable.

5. nowo:anonymize:generate-column-migration (4 tests)

• Without options
• With --connection default, postgres, and sqlite

6. nowo:anonymize:generate-mongo-field (2 tests)

• With --scan-documents
• With --collection user_activities

Prerequisites

1. Docker and Docker Compose must be installed
2. Demo containers must be running:

   cd demo/symfony7 && docker-compose up -d
   cd demo/symfony8 && docker-compose up -d

Output

The script provides:

• ✅ Success indicators for passing tests
• ❌ Error messages with details for failing tests
• ⚠️ Skipped status for containers that aren't running
• 📊 Summary statistics for each demo:
  • Number of successful tests
  • Number of failed tests
  • Number of skipped tests

Example Output

🚀 Starting AnonymizeBundle command tests

==========================================
🧪 Testing: symfony7
==========================================

Testing: nowo:anonymize:info
✅ Success
   Output (first 5 lines):
   
   Anonymizer Information
   ======================
   
   Entity Manager: default

Testing: nowo:anonymize:info --connection default
✅ Success
...

==========================================
📊 Summary for symfony7:
   ✅ Successful: 26
   ❌ Failed: 2
   ⚠️  Skipped: 1
==========================================

Customizing Tests

To modify which commands are tested, edit the COMMANDS array in scripts/test-commands.sh:

# Commands to test - covering all commands with their main options
COMMANDS=(
    "nowo:anonymize:info"
    "nowo:anonymize:info --connection default"
    # Add more commands here...
)

Manual Testing

1. nowo:anonymize:info

Test information display for all connections:

# In each demo container
php bin/console nowo:anonymize:info --connection default
php bin/console nowo:anonymize:info --connection postgres
php bin/console nowo:anonymize:info --connection sqlite
php bin/console nowo:anonymize:info  # All connections

Expected: Should display information about all entities with #[Anonymize] attribute and their properties.

2. nowo:anonymize:run

Test anonymization execution (use --dry-run first):

# Dry-run mode (safe, no changes)
php bin/console nowo:anonymize:run --connection default --dry-run
php bin/console nowo:anonymize:run --connection postgres --dry-run
php bin/console nowo:anonymize:run --connection sqlite --dry-run

# Test a single entity (e.g. to verify anonymizeService or event listeners)
php bin/console nowo:anonymize:run --entity "App\Entity\SmsNotification" --dry-run

# With options
php bin/console nowo:anonymize:run --connection default --batch-size 50
php bin/console nowo:anonymize:run --connection default --locale es_ES
php bin/console nowo:anonymize:run --connection default --interactive
php bin/console nowo:anonymize:run --connection default --stats-json stats.json
php bin/console nowo:anonymize:run --connection default --stats-csv stats.csv

Expected: Should show what would be anonymized (dry-run) or actually anonymize data.

3. nowo:anonymize:history

Test history viewing:

php bin/console nowo:anonymize:history
php bin/console nowo:anonymize:history --limit 5
php bin/console nowo:anonymize:history --connection default
php bin/console nowo:anonymize:history --run-id=<run-id>
php bin/console nowo:anonymize:history --compare=<run-id-1>,<run-id-2>

Expected: Should display anonymization run history.

4. nowo:anonymize:export-db

Test database export (there is no --dry-run option; exports write real dump files):

php bin/console nowo:anonymize:export-db --connection default
php bin/console nowo:anonymize:export-db --connection postgres
php bin/console nowo:anonymize:export-db --connection sqlite
php bin/console nowo:anonymize:export-db --connection mongodb
# Omit --connection to export all configured connections (default behavior)

Expected: Should export databases to files (with compression if available).

5. nowo:anonymize:generate-column-migration

Test migration generation:

php bin/console nowo:anonymize:generate-column-migration
php bin/console nowo:anonymize:generate-column-migration --connection default
php bin/console nowo:anonymize:generate-column-migration --connection postgres

Expected: Should print or save SQL to add the anonymized column for anonymizable entities (see --output to write a file).

6. nowo:anonymize:generate-mongo-field

Test MongoDB field generation:

php bin/console nowo:anonymize:generate-mongo-field --scan-documents
php bin/console nowo:anonymize:generate-mongo-field --collection user_activities --database anonymize_demo

Expected: Should generate a MongoDB script to add the anonymized field (see command --help for all options).

Testing Checklist

For each demo (Symfony 7 and 8):

• nowo:anonymize:info works for all connections (default, postgres, sqlite)
• nowo:anonymize:run --dry-run works for all connections
• nowo:anonymize:run with various options works
• nowo:anonymize:history displays history correctly
• nowo:anonymize:export-db works for each connection you care about (exports are real, not dry-run)
• nowo:anonymize:generate-column-migration generates correct migrations
• nowo:anonymize:generate-mongo-field generates correct field code
• All commands show help text correctly (--help option)
• Error handling works (invalid connections, missing entities, etc.)

Common Issues

Containers not running

cd demo/symfony7 && docker-compose up -d
cd demo/symfony7 && docker-compose up -d
cd demo/symfony8 && docker-compose up -d

Database not initialized

# In each demo container
php bin/console doctrine:schema:create
php bin/console doctrine:fixtures:load

Permission issues

Ensure the script has execute permissions:

chmod +x scripts/test-commands.sh

Notes

• Always use --dry-run first when testing nowo:anonymize:run to avoid modifying data
• The --interactive mode is useful for testing step-by-step execution
• Statistics export (--stats-json, --stats-csv) helps verify anonymization results
• History commands require at least one anonymization run to have data