- 
                Notifications
    
You must be signed in to change notification settings  - Fork 173
 
[examples]: enhance example with docs, pytest setup, and standalone test server(IDFGH-16585) #902
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
| 
           
  | 
    
2ef1538    to
    8e0f8b0      
    Compare
  
    8e0f8b0    to
    43ae4c5      
    Compare
  
    43ae4c5    to
    e21d306      
    Compare
  
    e21d306    to
    d2e1994      
    Compare
  
    d2e1994    to
    0df1f91      
    Compare
  
    85da078    to
    38e70fb      
    Compare
  
    38e70fb    to
    a8e33b1      
    Compare
  
    a8e33b1    to
    9da66bf      
    Compare
  
    9da66bf    to
    00e0305      
    Compare
  
    00e0305    to
    4d4d4ed      
    Compare
  
    439f139    to
    6f87c26      
    Compare
  
    There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, just few nitpicks
        
          
                components/esp_websocket_client/examples/target/generate_certs.sh
              
                Outdated
          
            Show resolved
            Hide resolved
        
      6f87c26    to
    fd8e2ae      
    Compare
  
    fd8e2ae    to
    74a63db      
    Compare
  
    
          
 @david-cermak thank you for a review!  | 
    
5c0abeb    to
    4afafd3      
    Compare
  
    …ne test server
    - Add comprehensive README with TOC and quick start
    - Add pytest setup and certificate generation scripts
    - Add standalone WebSocket test server with TLS support
    - Add troubleshooting and multiple testing approaches
    4afafd3    to
    cad527d      
    Compare
  
    
Description
This PR enhances the WebSocket client example documentation and testing infrastructure to improve user experience and development workflow.
The changes add comprehensive documentation, automated testing setup, certificate generation tools, and a standalone WebSocket test server to make the example more accessible and easier to use.
Key Improvements:
Documentation Enhancements:
Added Table of Contents for better navigation
Added Quick Start section with step-by-step instructions
Enhanced certificate generation documentation with multiple options
Improved SDK configuration explanations with pre-configured options
New Features:
Standalone WebSocket server with TLS and mutual authentication support
Automated certificate generation with proper directory structure
Multiple testing approaches (pytest, standalone server, Flask alternative)
Clear usage examples and command-line options
Testing Infrastructure:
Added pytest dependencies and execution instructions
Created standalone WebSocket test server (websocket_server.py) with CLI interface
Separated server code from pytest to eliminate duplication
Added certificate generation script (generate_certs.sh) for automated setup
Checklist
🚨 This PR does not introduce breaking changes.
✅ All CI checks (GH Actions) pass.
✅ Documentation is updated as needed.
✅ Tests are updated or added as necessary.
✅ Code is well-commented, especially in complex areas.
✅ Git history is clean — commits are squashed to the minimum necessary.