sf-agent-framework

# Pipeline Validator Utility - Agent Instructions ## Purpose This utility provides instructions for AI agents to generate comprehensive CI/CD pipeline validation solutions for Salesforce DevOps implementations, ensuring quality gates and deployment standards are met. ## Agent Instructions ### When to Generate Pipeline Validation Generate pipeline validation components when: - CI/CD pipelines need quality checks - Deployment standards require enforcement - Build validation is needed - Code quality gates are required - Security scanning needs integration - Compliance checks must be automated - Release criteria need validation ### Core Components to Generate #### 1. Pipeline Validation Framework Generate validation components that: - Validate build artifacts - Check code quality metrics - Verify test coverage - Validate security compliance - Check deployment readiness - Enforce governance rules Key validation stages: - Pre-commit validation - Build validation - Test validation - Security validation - Deployment validation - Post-deployment validation #### 2. Quality Gate Engine Create quality gates for: - Minimum test coverage - Code quality thresholds - Security vulnerability limits - Performance benchmarks - Documentation requirements - Compliance standards #### 3. Validation Report Generator Implement reporting for: - Validation results summary - Failed check details - Quality metrics - Trend analysis - Recommendations - Approval tracking ### Configuration Requirements #### Pipeline Configuration ```yaml Pipeline_Config__c: - Name (Text) - Environment__c (Picklist) - Active__c (Checkbox) - Quality_Gates__c (Long Text Area) - Validation_Rules__c (Long Text Area) - Notification_Settings__c (Text) Quality_Gate__c: - Name (Text) - Gate_Type__c (Picklist) - Threshold_Value__c (Number) - Is_Mandatory__c (Checkbox) - Failure_Action__c (Picklist) - Description__c (Text Area) Validation_Result__c: - Pipeline_Run_Id__c (Text) - Stage__c (Picklist) - Status__c (Picklist) - Start_Time__c (DateTime) - End_Time__c (DateTime) - Details__c (Long Text Area) - Error_Count__c (Number) ``` ### Validation Stages to Implement #### Pre-Commit Validation ``` 1. Code formatting check 2. Linting validation 3. Unit test execution 4. SOQL/DML analysis 5. Security scan 6. Documentation check ``` #### Build Validation ``` 1. Compilation success 2. Dependency resolution 3. Package structure 4. Metadata validation 5. API version compatibility 6. Component naming ``` #### Test Validation ``` 1. Test coverage percentage 2. Test execution success 3. Test performance 4. Test data validation 5. Integration test results 6. User acceptance criteria ``` #### Security Validation ``` 1. CRUD/FLS checks 2. Sharing rule compliance 3. Authentication validation 4. Encryption requirements 5. Data privacy compliance 6. Vulnerability scanning ``` ### Implementation Patterns #### Pipeline Integration Pattern 1. Hook into pipeline stages 2. Execute validation checks 3. Collect results 4. Apply quality gates 5. Generate reports 6. Control flow decisions #### Parallel Validation Pattern 1. Identify independent checks 2. Execute in parallel 3. Aggregate results 4. Evaluate overall status 5. Optimize performance 6. Reduce pipeline time #### Progressive Validation Pattern 1. Quick checks first 2. Fail fast approach 3. Resource-intensive later 4. Incremental feedback 5. Efficient resource use 6. Better developer experience ### Quality Gate Definitions #### Code Quality Gates - Test Coverage: ≥ 80% - Code Complexity: < 10 - Technical Debt: < 2 hours - Duplication: < 5% - Maintainability: Grade A/B #### Security Gates - Critical Vulnerabilities: 0 - High Vulnerabilities: ≤ 2 - CRUD/FLS Coverage: 100% - Encryption Compliance: Yes - Auth Requirements: Met #### Performance Gates - Build Time: < 15 minutes - Deploy Time: < 30 minutes - Test Execution: < 20 minutes - API Response: < 2 seconds - Page Load: < 3 seconds ### Validation Rules Engine #### Rule Definition Structure ```yaml Rule: name: 'Apex Test Coverage' type: 'threshold' target: 'apex_coverage' operator: 'greater_than_equal' value: 80 severity: 'blocking' message: 'Apex test coverage must be at least 80%' ``` #### Custom Validation Rules ```yaml CustomRule: name: 'Custom Object Naming' type: 'pattern' target: 'custom_objects' pattern: '^[A-Z][a-zA-Z0-9_]*__c$' severity: 'warning' message: 'Custom objects must follow naming convention' ``` ### Dashboard Components to Generate #### Pipeline Overview Dashboard Display: - Pipeline success rate - Average build time - Quality gate status - Failed validations - Trend analysis - Team performance #### Validation Details Dashboard Show: - Stage-wise results - Error distribution - Quality metrics - Time analysis - Resource usage - Bottleneck identification ### Integration Requirements #### CI/CD Tool Integration - Jenkins pipeline - Azure DevOps - GitHub Actions - GitLab CI - CircleCI - Bitbucket Pipelines #### Salesforce DX Integration - SFDX CLI commands - Source tracking - Org authentication - Package management - Scratch org creation #### Monitoring Integration - Slack notifications - Email alerts - JIRA updates - Teams messages - Dashboard updates ### Best Practices to Implement 1. **Validation Strategy** - Define clear standards - Automate all checks - Fail fast approach - Provide clear feedback - Enable local validation 2. **Performance Optimization** - Parallel execution - Caching strategies - Selective validation - Resource management - Time optimization 3. **Developer Experience** - Clear error messages - Quick feedback loops - Local validation tools - Documentation links - Fix suggestions 4. **Governance** - Mandatory gates - Override policies - Audit trails - Compliance tracking - Regular reviews ### Advanced Features to Consider 1. **AI-Enhanced Validation** - Pattern learning - Anomaly detection - Smart suggestions - Predictive analysis - Auto-remediation 2. **Dynamic Gate Adjustment** - Context-aware thresholds - Risk-based validation - Progressive standards - Team maturity levels - Project phase gates 3. **Integration Testing** - End-to-end validation - Cross-system checks - Data integrity - Performance testing - Security validation ### Error Handling Instructions Handle these scenarios: 1. Validation timeouts 2. External service failures 3. Resource limitations 4. Configuration errors 5. Network issues Recovery strategies: - Retry mechanisms - Fallback options - Partial validation - Manual overrides - Error escalation ### Testing Requirements Generate test classes for: 1. Validation logic 2. Quality gate evaluation 3. Report generation 4. Integration points 5. Error scenarios ### Success Metrics Track and measure: - Pipeline success rate - Mean time to feedback - Quality improvement - Defect reduction - Developer satisfaction - Deployment frequency