FilesExpand file tree

main

/

test_force_stop.py

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

171 lines (149 loc) · 6.09 KB

main

/

test_force_stop.py

Copy path

Top

File metadata and controls

• Code
• Blame

171 lines (149 loc) · 6.09 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

# Copyright (c) Microsoft Corporation. All rights reserved.

"""Public TCP-backed tests for SDK-local force-stop retirement."""

import asyncio

import gc

import json

import weakref

from collections.abc import AsyncIterator

from datetime import UTC, datetime

import pytest

from copilot import CopilotClient, RuntimeConnection

from copilot._sdk_protocol_version import SDK_PROTOCOL_VERSION

from copilot.session import PermissionHandler

class Peer:

def __init__(self):

self.requests: list[str] = []

self.sends_received = asyncio.Event()

self.expected_sends = 1

self.send_count = 0

self.failures: list[Exception] = []

self.writers: list[asyncio.StreamWriter] = []

self.tasks: list[asyncio.Task] = []

async def serve(self, reader: asyncio.StreamReader, writer: asyncio.StreamWriter) -> None:

self.writers.append(writer)

try:

while True:

try:

header = await reader.readuntil(b"\r\n\r\n")

except asyncio.IncompleteReadError as error:

if error.partial:

raise

return

lengths = [

int(line.split(b":", 1)[1])

for line in header.split(b"\r\n")

if line.lower().startswith(b"content-length:")

]

assert len(lengths) == 1

assert 0 < lengths[0] <= 128 * 1024

request = json.loads(await reader.readexactly(lengths[0]))

method = request["method"]

self.requests.append(method)

if method == "connect":

result = {

"ok": True,

"protocolVersion": SDK_PROTOCOL_VERSION,

"version": "force-stop-test",

}

elif method == "ping":

result = {

"message": "pong",

"timestamp": datetime.now(UTC).isoformat(),

"protocolVersion": SDK_PROTOCOL_VERSION,

}

elif method == "session.create":

result = {"sessionId": request["params"]["sessionId"]}

elif method == "session.send":

self.send_count += 1

result = {"messageId": f"message-{self.send_count}"}

elif method == "session.detach":

result = {"success": True}

else:

raise AssertionError(f"Unexpected RPC: {method}")

body = json.dumps(

{"jsonrpc": "2.0", "id": request["id"], "result": result}

).encode()

writer.write(f"Content-Length: {len(body)}\r\n\r\n".encode() + body)

await writer.drain()

if self.send_count == self.expected_sends:

self.sends_received.set()

except Exception as error:

self.failures.append(error)

finally:

writer.close()

await writer.wait_closed()

@pytest.fixture

async def connected_peer() -> AsyncIterator[tuple[CopilotClient, Peer]]:

peer = Peer()

def accepted(reader: asyncio.StreamReader, writer: asyncio.StreamWriter) -> None:

peer.tasks.append(asyncio.create_task(peer.serve(reader, writer)))

server = await asyncio.start_server(accepted, "127.0.0.1", 0)

client = CopilotClient(

connection=RuntimeConnection.for_uri(f"127.0.0.1:{server.sockets[0].getsockname()[1]}"),

)

try:

await client.start()

yield client, peer

finally:

try:

await client.force_stop()

finally:

server.close()

await server.wait_closed()

for writer in peer.writers:

writer.close()

if peer.tasks:

await asyncio.gather(*peer.tasks)

assert peer.failures == []

@pytest.mark.parametrize("count", [1, 2])

async def test_force_stop_rejects_acknowledged_plain_waits(connected_peer, count):

client, peer = connected_peer

peer.expected_sends = count

session = await client.create_session(

session_id="retirement-session", on_permission_request=PermissionHandler.approve_all

)

waits = [

asyncio.create_task(session.send_and_wait("hold the response", timeout=1))

for _ in range(count)

]

try:

await asyncio.wait_for(peer.sends_received.wait(), 5)

# The later reply is a barrier for all preceding send acknowledgments.

await client.ping()

await client.force_stop()

for wait in waits:

with pytest.raises(RuntimeError, match="Session closed before response completed"):

await wait

await session.disconnect()

assert "session.detach" not in peer.requests

finally:

for wait in waits:

wait.cancel()

await asyncio.gather(*waits, return_exceptions=True)

class Capture:

def __call__(self, *_args, **_kwargs):

return None

async def captured_session(client: CopilotClient, kind: str):

capture = Capture()

reference = weakref.ref(capture)

options = {"on_permission_request": PermissionHandler.approve_all}

if kind == "permission":

options["on_permission_request"] = capture

elif kind == "user_input":

options["on_user_input_request"] = capture

elif kind == "hook":

options["hooks"] = {"on_session_end": capture}

session = await client.create_session(session_id="captured-session", **options)

if kind == "event":

session.on(capture)

return session, reference

@pytest.mark.parametrize("kind", ["event", "permission", "user_input", "hook"])

async def test_force_stop_releases_retained_session_callbacks(connected_peer, kind):

client, _peer = connected_peer

session, reference = await captured_session(client, kind)

assert reference() is not None

await client.force_stop()

gc.collect()

assert reference() is None

with pytest.raises(RuntimeError, match="Session is disconnected"):

session.on(Capture())