Tutorials

Learn FailExtract step-by-step through hands-on examples

These tutorials guide you through learning FailExtract by doing. Each tutorial builds on the previous one, taking you from basic usage to advanced customization. Follow them in order for the best learning experience.

• 1. Getting Started with FailExtract
  • 1.1. What You’ll Learn
  • 1.2. Prerequisites
  • 1.3. Installation
  • 1.4. Your First Failure Extraction
  • 1.5. Running and Capturing Failures
  • 1.6. Understanding the Generated Reports
  • 1.7. What Just Happened?
  • 1.8. Key Concepts
  • 1.9. Next Steps
  • 1.10. Troubleshooting
  • 1.11. Success Checklist
• 2. Working with Multiple Output Formats
  • 2.1. What You’ll Learn
  • 2.2. Prerequisites
  • 2.3. Format Overview
  • 2.4. Setting Up Example Failures
  • 2.5. Generate Reports in All Formats
  • 2.6. Complete Working Example
  • 2.7. Understanding Each Format
  • 2.8. Adding YAML Support
  • 2.9. Workflow-Specific Format Recommendations
  • 2.10. Handling Format Errors Gracefully
  • 2.11. Automating Multi-Format Reports
  • 2.12. Next Steps
  • 2.13. Key Takeaways
• 3. Configuring FailExtract
  • 3.1. What You’ll Learn
  • 3.2. Prerequisites
  • 3.3. Configuration Overview
  • 3.4. Decorator Configuration
  • 3.5. Output Configuration
  • 3.6. Format Detection and Override
  • 3.7. Memory Management Configuration
  • 3.8. Session-Level Reporting
  • 3.9. Performance Configuration Patterns
  • 3.10. Error Handling and Validation
  • 3.11. Complete Configuration Example
  • 3.12. Environment-Specific Configuration
  • 3.13. Next Steps
  • 3.14. Key Configuration Takeaways
• 4. Integrating FailExtract with pytest
  • 4.1. What You’ll Learn
  • 4.2. Prerequisites
  • 4.3. Integration Overview
  • 4.4. Quick Start: Basic conftest.py Setup
  • 4.5. Approach 1: Direct Decorator Usage
  • 4.6. Approach 2: Selective Capture with Markers
  • 4.7. Approach 3: Automatic Capture for All Failures
  • 4.8. Approach 4: Custom Plugin with Advanced Features
  • 4.9. Handling Complex Test Scenarios
  • 4.10. CI/CD Integration Patterns
  • 4.11. Complete Integration Example
  • 4.12. Troubleshooting Integration Issues
  • 4.13. Next Steps
  • 4.14. Key Integration Takeaways
• 5. Creating Custom Formatters
  • 5.1. What You’ll Learn
  • 5.2. Prerequisites
  • 5.3. Custom Formatter Architecture
  • 5.4. Your First Custom Formatter
  • 5.5. Real-World Example: Slack Formatter
  • 5.6. Advanced Example: JUnit XML Formatter
  • 5.7. Handling Edge Cases and Errors
  • 5.8. Using Custom Formatters
  • 5.9. Complete Custom Formatter Example
  • 5.10. Formatter Best Practices
  • 5.11. Next Steps
  • 5.12. Key Custom Formatter Takeaways

Learning Path

New to FailExtract? Start here and work through each tutorial:

1. Getting Started (5 minutes) Your first failure extraction - learn the core concepts and get immediate results.

2. Multiple Formats (10 minutes) Generate reports in JSON, Markdown, XML, CSV, and YAML for different workflows.

3. Configuration (15 minutes) Customize FailExtract behavior for your specific needs and performance requirements.

4. pytest Integration (20 minutes) Set up automatic failure capture for your entire test suite.

5. Custom Formatters (25 minutes) Create specialized output formats for your tools and platforms.

What You’ll Learn

By completing these tutorials, you’ll understand:

✅ Core Concepts - How FailExtract captures and stores failure data

✅ Multiple Workflows - Different ways to generate and use reports

✅ Performance Optimization - How to configure for different environments

✅ Integration Patterns - Seamless integration with pytest and CI/CD

✅ Extension Points - How to customize and extend FailExtract

Tutorial Approach

Each tutorial follows a consistent structure:

• Purpose - What you’ll accomplish

• Prerequisites - What you need to know first

• Step-by-step instructions - Hands-on examples you can run

• Working code examples - Copy-paste ready snippets

• Troubleshooting - Common issues and solutions

• Next steps - Where to go after completing the tutorial

Time Investment

• Quick Start: Complete tutorials 1-2 (15 minutes) for basic usage

• Full Proficiency: Complete all tutorials (75 minutes) for mastery

• Reference Use: Jump to specific tutorials as needed

Getting Help

If you get stuck during any tutorial:

1. Check the Troubleshooting section in each tutorial

2. Review How to Troubleshoot Issues for common problems

3. Ensure you have the correct How to Install FailExtract setup

4. Try the examples exactly as written before adapting them

Ready to Start?

Jump into Getting Started with FailExtract to begin your FailExtract journey!

Next: Getting Started with FailExtract - Capture your first test failure in 5 minutes