xref: /aosp_15_r20/external/cronet/net/data/websocket/README (revision 6777b5387eb2ff775bb5750e3f5d96f37fb7352b)
1This directory contains resources used by WebSocket server for testing.
2Multiple tests may share one resource, or URI handler.
3
4- connect_check.html : A page provides simple WebSocket connectivity check.
5     This page changes page title to "PASS" to notify content::TitleWatcher.
6     Used by ProxyBrowserTest.BasicAuthWSConnect,
7     SSLUITest.TestWSSInvalidCertAndGoForward, SSLUITest.TestWSSClientCert,
8     and SSLUITestIgnoreCertErrors.TestWSS.
9
10- split_packet_check.html : A page for testing split packet handling. Here,
11     packets mean TCP segments for WebSocket, or SSL records for secure
12     WebSocket. This page changes the title to "PASS" to notify
13     content::TitleWatcher.
14     Used by WebSocketBrowserTest.WebSocketSplitSegments and
15     WebSocketBrowserTest.SecureWebSocketSplitRecords.
16
17- websocket_shared_worker.html :  A page provides simple WebSocket test in
18     shared worker. This page changes page title to "PASS" to notify
19     content::TitleWatcher.
20     Used by WorkerTest.WebSocketSharedWorker.
21
22- close_observer.html : A page that creates a WebSocket connection to
23     close-observer_wsh.py with role=observer and checks the contents of the
24     message that is returned.
25     Used by the SendCloseFrameWhenTabIsClosed browser test.
26
27- connect_and_be_observed.html : A page that creates a WebSocket connection to
28     close-observer_wsh.py with role=observed.
29     This file does NOT close the established connection.
30     Used by the SendCloseFrameWhenTabIsClosed browser test.
31
32- connect_to.html : A page which makes a connection to the WebSocket server
33     specified in the "url" parameter,
34     eg. connect_to.html?url=ws://localhost/echo Sets the title to "PASS" if
35     connection succeeds and "FAIL" otherwise.
36
37- check-origin.html : A page which checks the origin header of the WebSocket
38     opening handshake with check-origin_wsh.py. The page is expected to be
39     accessed via a file:// URL.
40
41- multiple-connections.html : Verify that HTTP connection limits are not applied
42     to WebSockets. Used by WebSocketBrowserTest.SSLConnectionLimit.
43
44- websocket_worker_simple.js : A JavaScript runs on Workers created from the
45     websocket_shared_worker.html.
46     Used by WorkerTest.WebSocketSharedWorker.
47
48- echo-with-no-extension_wsh.py : A WebSocket URL handler for echo testing.
49     This handler disables all WebSocket extension so that we can perform
50     frame data dependent tests.
51     Used by kinds of PPAPI tests for WebSocket, ExtensionApiTest.WebSocket,
52     and WorkerTest.WebSocketSharedWorker.
53
54- close-immediately_wsh.py : A WebSocket URL handler that performs an immediate
55     clean close as soon as the connection is established.
56
57- close_wsh.py : A WebSocket URL handler for testing outgoing close code and
58     reason.
59     Used by kinds of PPAPI tests for WebSocket.
60
61- close-code-and-reason_wsh.py : A WebSocket URL handler for testing server
62     initiated closing handshake. A client can ask server to close the
63     connection with arbitrary code and reason.
64     Used by kinds of PPAPI tests for WebSocket.
65
66- close-with-split-packet_wsh.py : A WebSocket URL handler for testing split
67     packet handling. Here, packets mean TCP segments for WebSocket, or SSL
68     records for secure WebSocket.
69     Used by WebSocketBrowserTest.WebSocketSplitSegments and
70     WebSocketBrowserTest.SecureWebSocketSplitRecords.
71
72- close-observer_wsh.py : enables observing the close of one WebSocket due to
73     the tab being closed from another page.
74     Used by the SendCloseFrameWhenTabIsClosed browser test.
75
76- protocol-test_wsh.py : A WebSocket URL handler for testing outgoing opening
77     handshake protocol.
78     Used by kinds of PPAPI tests for WebSocket.
79
80- check-origin_wsh.py : A WebSocket URL handler to echo back the origin header
81     used in the opening handshake.
82
83- send-message-every-quarter-second_wsh.py : A WebSocket URL handler to send
84     a caller-specified number of messages through the port, each a quarter
85     second apart. Useful when testing sustained web socket connections without
86     continued client-side interaction. Used in ExtensionWebSocketApiTests.
87