FilesExpand file tree

main

/

test_canvas.py

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

207 lines (170 loc) · 6.35 KB

main

/

test_canvas.py

Copy path

Top

File metadata and controls

• Code
• Blame

207 lines (170 loc) · 6.35 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

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

"""Unit tests for the canvas SDK surface."""

from __future__ import annotations

from typing import Any, cast

import pytest

from copilot._jsonrpc import JsonRpcError

from copilot.canvas import (

CanvasAction,

CanvasDeclaration,

CanvasError,

CanvasHandler,

ExtensionInfo,

OpenCanvasInstance,

)

from copilot.generated.rpc import (

CanvasInstanceAvailability,

CanvasProviderCloseRequest,

CanvasProviderInvokeActionRequest,

CanvasProviderOpenRequest,

CanvasProviderOpenResult,

)

from copilot.session import CopilotSession

def test_canvas_declaration_serializes_camelcase_and_drops_optional():

decl = CanvasDeclaration(

id="my-canvas",

display_name="My Canvas",

description="Does the thing",

)

assert decl.to_dict() == {

"id": "my-canvas",

"displayName": "My Canvas",

"description": "Does the thing",

}

def test_canvas_declaration_serializes_input_schema_and_actions():

action = CanvasAction(

name="refresh",

description="Refresh the canvas",

)

decl = CanvasDeclaration(

id="c",

display_name="C",

description="D",

input_schema={"type": "object"},

actions=[action],

)

payload = decl.to_dict()

assert payload["inputSchema"] == {"type": "object"}

assert payload["actions"] == [action.to_dict()]

def test_extension_info_serializes():

info = ExtensionInfo(source="github-app", name="my-ext")

assert info.to_dict() == {"source": "github-app", "name": "my-ext"}

def test_canvas_open_response_drops_none_fields():

assert CanvasProviderOpenResult().to_dict() == {}

assert CanvasProviderOpenResult(url="https://x", status="ok").to_dict() == {

"url": "https://x",

"status": "ok",

}

def test_canvas_error_envelope_and_factories():

err = CanvasError("oops", "something broke")

assert err.code == "oops"

assert err.message == "something broke"

assert err.to_envelope() == {"code": "oops", "message": "something broke"}

no_handler = CanvasError.no_handler()

assert no_handler.code == "canvas_action_no_handler"

unset = CanvasError.handler_unset()

assert unset.code == "canvas_handler_unset"

async def test_default_canvas_handler_on_action_raises_no_handler():

class StubHandler(CanvasHandler):

async def on_open(self, ctx: CanvasProviderOpenRequest) -> CanvasProviderOpenResult:

return CanvasProviderOpenResult()

handler = StubHandler()

ctx = CanvasProviderInvokeActionRequest(

session_id="s",

extension_id="e",

canvas_id="c",

instance_id="i",

action_name="any",

input=None,

)

with pytest.raises(CanvasError) as excinfo:

await handler.on_action(ctx)

assert excinfo.value.code == "canvas_action_no_handler"

async def test_register_canvas_handler_wires_generated_canvas_adapter():

class Handler(CanvasHandler):

def __init__(self) -> None:

self.open_calls: list[CanvasProviderOpenRequest] = []

self.close_calls: list[CanvasProviderCloseRequest] = []

self.action_calls: list[CanvasProviderInvokeActionRequest] = []

async def on_open(self, ctx: CanvasProviderOpenRequest) -> CanvasProviderOpenResult:

self.open_calls.append(ctx)

return CanvasProviderOpenResult(

url="https://canvas.example", title="Hi", status="ready"

)

async def on_close(self, ctx: CanvasProviderCloseRequest) -> None:

self.close_calls.append(ctx)

async def on_action(self, ctx: CanvasProviderInvokeActionRequest) -> Any:

self.action_calls.append(ctx)

return {"echo": ctx.input}

session = CopilotSession("sess-1", client=None)

handler = Handler()

session._register_canvas_handler(handler)

adapter = session._client_session_apis.canvas

assert adapter is not None

assert session._get_canvas_handler() is handler

open_request = CanvasProviderOpenRequest(

canvas_id="c",

extension_id="ext",

instance_id="i",

session_id="sess-1",

input={"q": 1},

)

open_result = await adapter.open(open_request)

assert open_result.to_dict() == {

"url": "https://canvas.example",

"title": "Hi",

"status": "ready",

}

assert handler.open_calls == [open_request]

close_request = CanvasProviderCloseRequest(

canvas_id="c",

extension_id="ext",

instance_id="i",

session_id="sess-1",

)

await adapter.close(close_request)

assert handler.close_calls == [close_request]

action_request = CanvasProviderInvokeActionRequest(

action_name="refresh",

canvas_id="c",

extension_id="ext",

instance_id="i",

session_id="sess-1",

input={"value": 1},

)

action_result = await adapter.invoke_action(action_request)

assert action_result == {"echo": {"value": 1}}

assert handler.action_calls == [action_request]

async def test_canvas_adapter_translates_canvas_error_to_jsonrpc_error():

class Handler(CanvasHandler):

async def on_open(self, ctx: CanvasProviderOpenRequest) -> CanvasProviderOpenResult:

raise CanvasError("bad", "fail")

session = CopilotSession("sess-1", client=None)

session._register_canvas_handler(Handler())

adapter = cast(Any, session._client_session_apis.canvas)

with pytest.raises(JsonRpcError) as excinfo:

await adapter.open(

CanvasProviderOpenRequest(

canvas_id="c",

extension_id="ext",

instance_id="i",

session_id="sess-1",

)

)

assert excinfo.value.code == -32603

assert excinfo.value.message == "fail"

assert excinfo.value.data == {"code": "bad", "message": "fail"}

def test_register_canvas_handler_can_clear_generated_handler():

session = CopilotSession("sess-1", client=None)

session._register_canvas_handler(None)

assert session._client_session_apis.canvas is None

def test_set_open_canvases_round_trip():

inst = OpenCanvasInstance(

availability=CanvasInstanceAvailability.READY,

canvas_id="c",

extension_id="e",

instance_id="i",

reopen=False,

)

session = CopilotSession("sess-1", client=None)

session._set_open_canvases([inst])

assert session.open_canvases == [inst]