Skip to content

Conversation

gabsuren
Copy link
Collaborator

@gabsuren gabsuren commented Oct 6, 2025

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.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@gabsuren gabsuren changed the title docs(websocket): add pytest dependencies and execution instructions [websocket]: add pytest dependencies and execution instructions Oct 6, 2025
@gabsuren gabsuren force-pushed the docs/readme_update branch from 2ef1538 to 8e0f8b0 Compare October 6, 2025 10:56
@github-actions github-actions bot changed the title [websocket]: add pytest dependencies and execution instructions [websocket]: add pytest dependencies and execution instructions (IDFGH-16585) Oct 6, 2025
@espressif-bot espressif-bot added the Status: Opened Issue is new label Oct 6, 2025
@gabsuren gabsuren changed the title [websocket]: add pytest dependencies and execution instructions (IDFGH-16585) [websocket]: add pytest dependencies and execution instructions Oct 6, 2025
@gabsuren gabsuren force-pushed the docs/readme_update branch from 8e0f8b0 to 43ae4c5 Compare October 6, 2025 17:13
@gabsuren gabsuren marked this pull request as ready for review October 6, 2025 17:23
@gabsuren gabsuren force-pushed the docs/readme_update branch from 43ae4c5 to e21d306 Compare October 7, 2025 06:46
@gabsuren gabsuren force-pushed the docs/readme_update branch from e21d306 to d2e1994 Compare October 7, 2025 09:31
cursor[bot]

This comment was marked as outdated.

@gabsuren gabsuren force-pushed the docs/readme_update branch from d2e1994 to 0df1f91 Compare October 7, 2025 10:05
@gabsuren gabsuren changed the title [websocket]: add pytest dependencies and execution instructions feat(websocket): improve example with docs, testing tools, and automation Oct 7, 2025
@gabsuren gabsuren force-pushed the docs/readme_update branch 2 times, most recently from 85da078 to 38e70fb Compare October 7, 2025 10:26
cursor[bot]

This comment was marked as outdated.

@gabsuren gabsuren force-pushed the docs/readme_update branch from 38e70fb to a8e33b1 Compare October 7, 2025 10:55
cursor[bot]

This comment was marked as outdated.

@gabsuren gabsuren force-pushed the docs/readme_update branch from a8e33b1 to 9da66bf Compare October 7, 2025 12:09
cursor[bot]

This comment was marked as outdated.

@gabsuren gabsuren force-pushed the docs/readme_update branch from 9da66bf to 00e0305 Compare October 8, 2025 08:05
@gabsuren gabsuren changed the title feat(websocket): improve example with docs, testing tools, and automation [examples]: enhance example with docs, pytest setup, and standalone test server Oct 8, 2025
cursor[bot]

This comment was marked as outdated.

cursor[bot]

This comment was marked as outdated.

@gabsuren gabsuren force-pushed the docs/readme_update branch from 4d4d4ed to 439f139 Compare October 8, 2025 09:22
…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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants