evennia.server.portal.test_wire_formats

Tests for WebSocket wire formats and subprotocol negotiation.

Tests cover:

• gmcp_utils.py: encode_gmcp / decode_gmcp

• Wire format codecs: EvenniaV1, Terminal, JsonStandard, GmcpStandard

• WebSocket subprotocol negotiation in webclient.py

class evennia.server.portal.test_wire_formats.TestGmcpEncode(methodName='runTest')

Bases: TestCase

Tests for gmcp_utils.encode_gmcp().

setUp()

Hook method for setting up the test fixture before exercising it.

test_known_mapping()

Commands in EVENNIA_TO_GMCP should use the mapped name.

test_known_mapping_with_args()

test_underscore_to_dotted()

Underscored names should become dotted with capitalization.

test_no_underscore_gets_core_prefix()

Single-word commands get Core. prefix.

test_already_title_case_preserved()

test_fully_uppercase_preserved()

Fully uppercase segments should stay uppercase.

test_no_args_no_kwargs()

test_single_arg()

test_multiple_args()

test_kwargs_only()

test_args_and_kwargs()

class evennia.server.portal.test_wire_formats.TestGmcpDecode(methodName='runTest')

Bases: TestCase

Tests for gmcp_utils.decode_gmcp().

setUp()

Hook method for setting up the test fixture before exercising it.

test_known_mapping()

Known GMCP package names should map to Evennia names.

test_package_to_underscore()

Unknown package names should become lowercase underscore.

test_core_prefix_stripped()

Core. prefix should be stripped from the command name.

test_string_arg()

test_array_arg()

test_dict_arg()

test_bytes_input()

test_empty_input()

test_non_json_structure()

Non-JSON data after command name should be treated as string.

test_falsy_scalar_zero()

GMCP payloads of 0 should not be dropped.

test_falsy_scalar_false()

GMCP payloads of false should not be dropped.

test_null_payload()

GMCP payloads of null should be passed through.

class evennia.server.portal.test_wire_formats.TestWireFormatBase(methodName='runTest')

Bases: TestCase

Tests for the WireFormat abstract base class.

test_abstract_methods_raise()

test_encode_prompt_delegates_to_encode_text()

Default encode_prompt should call encode_text with send_prompt=True.

class evennia.server.portal.test_wire_formats.TestEvenniaV1Format(methodName='runTest')

Bases: TestCase

Tests for the v1.evennia.com wire format.

setUp()

Hook method for setting up the test fixture before exercising it.

test_name()

test_supports_oob()

test_decode_text()

test_decode_oob_command()

test_decode_invalid_json()

test_decode_short_array()

test_encode_text_basic()

test_encode_text_none()

test_encode_text_no_args()

test_encode_text_prompt()

test_encode_text_nocolor()

test_encode_default()

test_encode_default_options_skipped()

The ‘options’ command should be silently dropped.

class evennia.server.portal.test_wire_formats.TestTerminalFormat(methodName='runTest')

Bases: TestCase

Tests for the terminal.mudstandards.org wire format.

setUp()

Hook method for setting up the test fixture before exercising it.

test_name()

test_no_oob()

test_decode_binary()

test_decode_strips_whitespace()

test_decode_empty()

test_decode_invalid_utf8()

test_encode_text_binary_frame()

test_encode_text_preserves_ansi()

Terminal format should output real ANSI escape sequences.

test_encode_text_none()

test_encode_default_returns_none()

OOB should be silently dropped for terminal format.

class evennia.server.portal.test_wire_formats.TestJsonStandardFormat(methodName='runTest')

Bases: TestCase

Tests for the json.mudstandards.org wire format.

setUp()

Hook method for setting up the test fixture before exercising it.

test_name()

test_supports_oob()

test_decode_binary_as_text()

BINARY frames should be treated as raw text input.

test_decode_binary_empty()

test_decode_text_envelope()

TEXT frames should be parsed as JSON envelopes.

test_decode_gmcp_envelope()

GMCP-in-JSON envelopes should be decoded.

test_decode_gmcp_envelope_with_data()

test_decode_websocket_close()

test_decode_invalid_json_text_frame()

test_decode_generic_proto()

Unknown proto should pass through as-is.

test_encode_text_binary_frame()

Text should be sent as BINARY frames with raw ANSI.

test_encode_text_preserves_ansi()

test_encode_prompt_as_json_text_frame()

Prompts should be JSON envelopes in TEXT frames.

test_encode_default_gmcp_in_json()

OOB should be encoded as GMCP-in-JSON envelope.

test_encode_default_options_skipped()

class evennia.server.portal.test_wire_formats.TestGmcpStandardFormat(methodName='runTest')

Bases: TestCase

Tests for the gmcp.mudstandards.org wire format.

setUp()

Hook method for setting up the test fixture before exercising it.

test_name()

test_supports_oob()

test_decode_binary_as_text()

test_decode_text_as_gmcp()

TEXT frames should be parsed as raw GMCP strings.

test_decode_gmcp_with_data()

test_decode_binary_invalid_utf8()

test_decode_text_invalid_utf8()

test_encode_text_binary_frame()

test_encode_prompt_binary_frame()

GMCP format sends prompts as BINARY frames like regular text.

test_encode_default_gmcp_text_frame()

OOB should be raw GMCP strings in TEXT frames.

test_encode_default_with_args()

test_encode_default_options_skipped()

class evennia.server.portal.test_wire_formats.TestWireFormatRegistry(methodName='runTest')

Bases: TestCase

Tests for the wire_formats package registry.

test_registry_has_all_formats()

test_registry_order_prefers_json()

json.mudstandards.org should be first (highest priority).

test_registry_instances_are_correct_types()

class evennia.server.portal.test_wire_formats.TestWebSocketSubprotocolNegotiation(methodName='runTest')

Bases: TestCase

Tests for the onConnect() subprotocol negotiation in WebSocketClient.

These test the negotiation logic in isolation without starting a full Twisted reactor, by directly calling onConnect() with mock request objects.

test_no_subprotocol_offered()

Client sends no Sec-WebSocket-Protocol → v1 fallback, returns None.

test_v1_subprotocol_offered()

Client offers v1.evennia.com → selected and returned.

test_json_subprotocol_offered()

test_gmcp_subprotocol_offered()

test_terminal_subprotocol_offered()

test_server_preference_wins()

When client offers multiple, server’s preference order wins.

test_unknown_subprotocol_falls_back()

Client offers only unknown protocols → v1 fallback.

test_mixed_known_and_unknown()

Client offers unknown + known → known is selected.

test_empty_subprotocols_setting()

WEBSOCKET_SUBPROTOCOLS=[] disables negotiation; clients fall back to v1.

class evennia.server.portal.test_wire_formats.TestEvenniaV1RoundTrip(methodName='runTest')

Bases: TestCase

Test encode → decode round-trip for v1.evennia.com.

setUp()

Hook method for setting up the test fixture before exercising it.

test_oob_roundtrip()

Encode an OOB command and decode the result.

class evennia.server.portal.test_wire_formats.TestGmcpRoundTrip(methodName='runTest')

Bases: TestCase

Test encode → decode round-trip for gmcp.mudstandards.org.

setUp()

Hook method for setting up the test fixture before exercising it.

test_oob_roundtrip_no_args()

Encode a command without args and decode.

test_oob_roundtrip_with_kwargs()

Encode a command with kwargs and decode.

class evennia.server.portal.test_wire_formats.TestJsonStandardRoundTrip(methodName='runTest')

Bases: TestCase

Test encode → decode round-trip for json.mudstandards.org.

setUp()

Hook method for setting up the test fixture before exercising it.

test_oob_roundtrip()

Encode an OOB command as GMCP-in-JSON and decode.

test_prompt_roundtrip()

Encode a prompt and verify the envelope.

class evennia.server.portal.test_wire_formats.TestTerminalEdgeCases(methodName='runTest')

Bases: TestCase

Edge-case tests for TerminalFormat.

setUp()

Hook method for setting up the test fixture before exercising it.

test_decode_text_frame_treated_as_text()

TEXT frames should still be decoded as text input.

test_decode_empty_bytes()

Empty bytes should return None.

test_decode_empty_bytes_text_frame()

Empty TEXT frame bytes should return None.

class evennia.server.portal.test_wire_formats.TestJsonStandardEdgeCases(methodName='runTest')

Bases: TestCase

Edge-case tests for JsonStandardFormat.

setUp()

Hook method for setting up the test fixture before exercising it.

test_decode_envelope_missing_proto()

JSON envelope with missing proto should use empty string default.

test_decode_envelope_missing_all_fields()

JSON envelope with no recognized fields returns None (empty funcname).

test_decode_envelope_missing_id_and_data()

Envelope with only proto=”text” and no data should return None.

test_decode_binary_invalid_utf8()

Invalid UTF-8 in BINARY frame should return None.

class evennia.server.portal.test_wire_formats.TestGmcpStandardEdgeCases(methodName='runTest')

Bases: TestCase

Edge-case tests for GmcpStandardFormat.

setUp()

Hook method for setting up the test fixture before exercising it.

test_decode_empty_binary()

Empty BINARY frame should return None.

test_decode_binary_whitespace_only()

Whitespace-only BINARY frame should return None.

class evennia.server.portal.test_wire_formats.TestBaseWireFormatHelpers(methodName='runTest')

Bases: TestCase

Tests for the shared helper methods on WireFormat base class.

setUp()

Hook method for setting up the test fixture before exercising it.

test_extract_text_and_flags_basic()

Basic extraction with no options or flags.

test_extract_text_and_flags_none_text()

None as text should return None.

test_extract_text_and_flags_no_args()

Empty args should return None.

test_extract_text_and_flags_options_override()

Options should override protocol_flags.

test_extract_text_and_flags_raw_option()

Raw option should be extracted into the result tuple.

test_extract_text_and_flags_raw_protocol_flag()

RAW protocol flag should be used when option is absent.

test_extract_text_and_flags_from_protocol_flags()

Protocol flags should be used when options are absent.

test_process_ansi_normal()

Normal mode should produce ANSI escape sequences.

test_process_ansi_nocolor()

Nocolor mode should strip all ANSI.

test_process_ansi_screenreader()

Screenreader mode should strip ANSI and apply regex.

test_process_ansi_raw()

Raw mode should return text unmodified.

test_process_ansi_trailing_reset()

Normal mode should append |n to prevent color bleed.

test_process_ansi_trailing_pipe_preserved()

A trailing literal pipe should be preserved, not stripped.