FilesExpand file tree

main

/

test_ui_elicitation_e2e.py

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

216 lines (165 loc) · 7.75 KB

main

/

test_ui_elicitation_e2e.py

Copy path

Top

File metadata and controls

• Code
• Blame

216 lines (165 loc) · 7.75 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

208

209

210

211

212

213

214

215

216

"""E2E UI Elicitation Tests (single-client)

Mirrors nodejs/test/e2e/ui_elicitation.test.ts — single-client scenarios.

Uses the shared ``ctx`` fixture from conftest.py.

"""

import pytest

from copilot.session import (

ElicitationContext,

ElicitationParams,

ElicitationResult,

PermissionHandler,

)

from .testharness import E2ETestContext

pytestmark = pytest.mark.asyncio(loop_scope="module")

class TestUiElicitation:

async def test_elicitation_methods_throw_in_headless_mode(self, ctx: E2ETestContext):

"""Elicitation methods throw when running in headless mode."""

session = await ctx.client.create_session(

on_permission_request=PermissionHandler.approve_all,

)

# The SDK spawns the CLI headless — no TUI means no elicitation support.

ui_caps = session.capabilities.get("ui", {})

assert not ui_caps.get("elicitation")

with pytest.raises(RuntimeError, match="not supported"):

await session.ui.confirm("test")

with pytest.raises(RuntimeError, match="not supported"):

await session.ui.select("test", ["a", "b"])

with pytest.raises(RuntimeError, match="not supported"):

await session.ui.input("test")

with pytest.raises(RuntimeError, match="not supported"):

await session.ui.elicitation(

{

"message": "Enter name",

"requestedSchema": {

"type": "object",

"properties": {"name": {"type": "string"}},

"required": ["name"],

},

}

)

await session.disconnect()

async def test_session_with_elicitation_handler_reports_capability(self, ctx: E2ETestContext):

"""Session created with onElicitationContext reports elicitation capability."""

async def handler(

context: ElicitationContext,

) -> ElicitationResult:

return {"action": "accept", "content": {}}

session = await ctx.client.create_session(

on_permission_request=PermissionHandler.approve_all,

on_elicitation_request=handler,

)

assert session.capabilities.get("ui", {}).get("elicitation") is True

await session.disconnect()

async def test_session_without_elicitation_handler_reports_no_capability(

self, ctx: E2ETestContext

):

"""Session created without onElicitationContext reports no elicitation capability."""

session = await ctx.client.create_session(

on_permission_request=PermissionHandler.approve_all,

)

assert session.capabilities.get("ui", {}).get("elicitation") in (False, None)

await session.disconnect()

async def test_sends_request_elicitation_when_handler_provided(self, ctx: E2ETestContext):

"""Session is created successfully with requestElicitation=true when handler is provided."""

async def handler(_: ElicitationContext) -> ElicitationResult:

return {"action": "accept", "content": {}}

session = await ctx.client.create_session(

on_permission_request=PermissionHandler.approve_all,

on_elicitation_request=handler,

)

assert session.session_id is not None

await session.disconnect()

async def test_session_without_elicitation_handler_creates_successfully(

self, ctx: E2ETestContext

):

"""Session without an elicitation handler still creates successfully."""

session = await ctx.client.create_session(

on_permission_request=PermissionHandler.approve_all,

)

assert session.session_id is not None

await session.disconnect()

async def test_confirm_returns_true_when_handler_accepts(self, ctx: E2ETestContext):

async def handler(context: ElicitationContext) -> ElicitationResult:

assert context["message"] == "Confirm?"

schema = context.get("requestedSchema") or {}

assert "confirmed" in (schema.get("properties") or {})

return {"action": "accept", "content": {"confirmed": True}}

session = await ctx.client.create_session(

on_permission_request=PermissionHandler.approve_all,

on_elicitation_request=handler,

)

assert session.capabilities.get("ui", {}).get("elicitation") is True

assert (await session.ui.confirm("Confirm?")) is True

await session.disconnect()

async def test_confirm_returns_false_when_handler_declines(self, ctx: E2ETestContext):

async def handler(_: ElicitationContext) -> ElicitationResult:

return {"action": "decline"}

session = await ctx.client.create_session(

on_permission_request=PermissionHandler.approve_all,

on_elicitation_request=handler,

)

assert (await session.ui.confirm("Confirm?")) is False

await session.disconnect()

async def test_select_returns_selected_option(self, ctx: E2ETestContext):

async def handler(context: ElicitationContext) -> ElicitationResult:

assert context["message"] == "Choose"

schema = context.get("requestedSchema") or {}

assert "selection" in (schema.get("properties") or {})

return {"action": "accept", "content": {"selection": "beta"}}

session = await ctx.client.create_session(

on_permission_request=PermissionHandler.approve_all,

on_elicitation_request=handler,

)

assert (await session.ui.select("Choose", ["alpha", "beta"])) == "beta"

await session.disconnect()

async def test_input_returns_freeform_value(self, ctx: E2ETestContext):

async def handler(context: ElicitationContext) -> ElicitationResult:

assert context["message"] == "Enter value"

schema = context.get("requestedSchema") or {}

assert "value" in (schema.get("properties") or {})

return {"action": "accept", "content": {"value": "typed value"}}

session = await ctx.client.create_session(

on_permission_request=PermissionHandler.approve_all,

on_elicitation_request=handler,

)

result = await session.ui.input(

"Enter value",

{

"title": "Value",

"description": "A value to test",

"minLength": 1,

"maxLength": 20,

"default": "default",

},

)

assert result == "typed value"

await session.disconnect()

async def test_elicitation_returns_all_action_shapes(self, ctx: E2ETestContext):

responses: list[ElicitationResult] = [

{"action": "accept", "content": {"name": "Mona"}},

{"action": "decline"},

{"action": "cancel"},

]

async def handler(context: ElicitationContext) -> ElicitationResult:

assert context["message"] == "Name?"

return responses.pop(0)

session = await ctx.client.create_session(

on_permission_request=PermissionHandler.approve_all,

on_elicitation_request=handler,

)

params: ElicitationParams = {

"message": "Name?",

"requestedSchema": {

"type": "object",

"properties": {"name": {"type": "string"}},

"required": ["name"],

},

}

accept = await session.ui.elicitation(params)

decline = await session.ui.elicitation(params)

cancel = await session.ui.elicitation(params)

assert accept["action"] == "accept"

assert (accept.get("content") or {}).get("name") == "Mona"

assert decline["action"] == "decline"

assert cancel["action"] == "cancel"

await session.disconnect()