PDB Management Operator BDD Tests - Local Testing Guide¶
This guide explains how to run the PDB Management Operator BDD tests locally before committing changes.
Prerequisites¶
Kubernetes Cluster: Access to a Kubernetes cluster (local or remote)
kubectl cluster-infoODA Canvas Deployed: The Canvas must be installed with the PDB operator
kubectl get pods -n canvas kubectl get deployment -n canvas canvas-pdb-management-operator
Node.js and npm: Required for running Cucumber tests
node --version # Should be v14 or higher npm --version # Should be v6 or higher
Setup¶
1. Install Dependencies¶
cd feature-definition-and-test-kit
npm install
2. Set Environment Variables¶
Create a .env file or export these variables:
export KEYCLOAK_USER=admin
export KEYCLOAK_PASSWORD=admin
export KEYCLOAK_BASE_URL=http://localhost:8080
export KEYCLOAK_REALM=master
Or source from the test environment file:
cp .env.test .env
source .env
3. Verify PDB Operator is Running¶
# Check operator deployment
kubectl get deployment -n canvas canvas-pdb-management-operator
# Check operator logs
kubectl logs -n canvas -l app.kubernetes.io/name=pdb-management --tail=20
# Check CRDs are installed
kubectl get crd | grep availability
Running Tests¶
Quick Test Commands¶
# Dry-run (syntax check only - no actual execution)
npm run test:pdb:dry-run
# Run all PDB tests
npm run test:pdb
# Run specific feature tests
npm run test:pdb:annotation # Annotation-based PDB management
npm run test:pdb:policy # Policy-based PDB management
npm run test:pdb:webhook # Webhook validation
npm run test:pdb:edge # Edge cases
# Run locally without publishing to Cucumber Reports
npm run test:pdb:local
Using the Test Script¶
A convenience script is provided for comprehensive testing:
# Make script executable (first time only)
chmod +x test-pdb-local.sh
# Run all tests with prerequisite checks
./test-pdb-local.sh all
# Run specific test suite
./test-pdb-local.sh annotation
./test-pdb-local.sh policy
./test-pdb-local.sh webhook
./test-pdb-local.sh edge
# Dry-run only
./test-pdb-local.sh dry-run
Test Structure¶
The PDB BDD tests are organized into four feature files:
UC017-F001-PDB-Management-Annotation-Based.feature
Tests PDB creation from deployment annotations
Component function classification
Maintenance windows
Component name tracking
UC017-F002-PDB-Management-Policy-Based.feature
AvailabilityPolicy enforcement
Priority resolution
Enforcement modes (strict, flexible, advisory)
Custom PDB configurations
UC017-F003-PDB-Management-Webhook-Validation.feature
Webhook validation for policies
Default value handling
Immutable field validation
Configuration constraints
UC017-F004-PDB-Management-Edge-Cases.feature
Scaling scenarios
Operator restart recovery
Namespace deletion
Error handling
Understanding Test Results¶
Successful Test Output¶
44 scenarios (44 passed)
378 steps (378 passed)
2m15.123s (executing steps: 2m14.892s)
Common Issues and Solutions¶
Issue: Operator Not Found¶
PDB Management Operator not deployed
Solution: Deploy the PDB operator using Helm:
helm upgrade --install canvas-oda charts/canvas-oda \
--set pdb-management-operator.enabled=true
Issue: Components Namespace Missing¶
Error: namespaces "components" not found
Solution: Create the namespace:
kubectl create namespace components
Issue: Timeout Errors¶
Error: PDB was not created within 30000ms
Solution: The operator may be slow to respond. Increase timeouts in the test configuration or check operator logs:
kubectl logs -n canvas -l app.kubernetes.io/name=pdb-management --tail=50
Issue: Undefined Steps¶
2 scenarios (2 undefined)
5 steps (5 undefined)
Solution: Some step definitions may be missing. Check the dry-run output and add missing steps to PDBManagementSteps.js.
Test Development¶
Adding New Scenarios¶
Add scenarios to the appropriate feature file in
features/Run dry-run to identify missing steps:
npm run test:pdb:dry-run
Implement missing steps in
features/step-definition/PDBManagementSteps.jsAdd utility functions to
resource-inventory-utils-kubernetes/if needed
Debugging Tests¶
Enable debug output by modifying step definitions:
// Add console.log statements for debugging
console.log("Creating deployment:", deploymentName);
console.log("PDB response:", pdb);
Check operator logs during test execution:
# In another terminal, watch operator logs
kubectl logs -n canvas -l app.kubernetes.io/name=pdb-management -f
CI/CD Integration¶
GitHub Actions¶
Add to your workflow:
- name: Run PDB BDD Tests
run: |
cd feature-definition-and-test-kit
npm install
npm run test:pdb:dry-run
# Only run full tests if cluster is available
if kubectl cluster-info > /dev/null 2>&1; then
npm run test:pdb:local
fi
Local Pre-commit Hook¶
Create .git/hooks/pre-commit:
#!/bin/bash
cd feature-definition-and-test-kit
npm run test:pdb:dry-run || {
echo "PDB BDD tests have syntax errors. Please fix before committing."
exit 1
}
Troubleshooting¶
Check Test Dependencies¶
# Verify all required modules are installed
npm ls @cucumber/cucumber
npm ls @kubernetes/client-node
# Check for missing dependencies
npm install
Verify Kubernetes Access¶
# Test kubectl access
kubectl auth can-i get pods --all-namespaces
# Check current context
kubectl config current-context
# Test API access from Node.js
node -e "
const k8s = require('@kubernetes/client-node');
const kc = new k8s.KubeConfig();
kc.loadFromDefault();
console.log('Kubernetes config loaded successfully');
"
Clean Test Environment¶
# Remove test deployments
kubectl delete deployments -n components -l test=pdb-bdd
# Remove test policies
kubectl delete availabilitypolicies -n components --all
# Clean test results
rm -rf test-results/
Additional Resources¶
Support¶
For issues or questions:
Check operator logs:
kubectl logs -n canvas -l app.kubernetes.io/name=pdb-managementReview test output carefully for specific error messages
Open an issue in the ODA Canvas repository with test logs attached