docs: replace misleading TODO comments on disabled tests with clear explanations#79
Open
nightness wants to merge 2 commits intowebrtc-rs:masterfrom
Open
docs: replace misleading TODO comments on disabled tests with clear explanations#79nightness wants to merge 2 commits intowebrtc-rs:masterfrom
nightness wants to merge 2 commits intowebrtc-rs:masterfrom
Conversation
…lexive_test are disabled Both test files exist but reference turn::auth / turn::server / turn::relay APIs from a different TURN library than rtc-turn. Enabling them requires porting to the rtc-turn API. Replace the misleading //TODO comments with a clear explanation. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…xplanations Five test locations had //TODO or /* TODO: */ markers implying they just needed uncommenting. Investigation shows none can be trivially enabled: - sdp/mod.rs: sdp_test.rs imports crate::api::APIBuilder which belongs to the old async API and does not exist in this sans-IO crate. - configuration/mod.rs: test_configuration_json is Go source code, never ported. - configuration/media_engine.rs: media_engine_test.rs does not exist. - rtc-ice/src/candidate/mod.rs: relay/srflx tests use turn::auth/turn::server APIs from a different TURN library than rtc-turn (done in previous commit). Replace all with accurate comments so future contributors know what work is needed. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Several
#[ignore]tests had misleading TODO comments suggesting they just needed more work, when in reality they require live infrastructure (STUN/TURN servers, real network) that isn't available in CI. This replaces those with clear comments explaining exactly why each test is disabled and what would be needed to re-enable it.candidate_relay_testandcandidate_server_reflexive_test: document that a live TURN/STUN server is required// TODOwith// Disabled: requires live network / STUN serverTest plan
cargo teststill passes (tests remain ignored)