Hide keyboard shortcuts

Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

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

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

"""Test :mod:`certbot.display.util`.""" 

import inspect 

import socket 

import tempfile 

import unittest 

 

import six 

import mock 

 

from certbot import errors 

from certbot import interfaces 

from certbot.display import util as display_util 

 

 

CHOICES = [("First", "Description1"), ("Second", "Description2")] 

TAGS = ["tag1", "tag2", "tag3"] 

TAGS_CHOICES = [("1", "tag1"), ("2", "tag2"), ("3", "tag3")] 

 

 

class InputWithTimeoutTest(unittest.TestCase): 

"""Tests for certbot.display.util.input_with_timeout.""" 

@classmethod 

def _call(cls, *args, **kwargs): 

from certbot.display.util import input_with_timeout 

return input_with_timeout(*args, **kwargs) 

 

def test_eof(self): 

with tempfile.TemporaryFile("r+") as f: 

with mock.patch("certbot.display.util.sys.stdin", new=f): 

self.assertRaises(EOFError, self._call) 

 

def test_input(self, prompt=None): 

expected = "foo bar" 

stdin = six.StringIO(expected + "\n") 

with mock.patch("certbot.compat.select.select") as mock_select: 

mock_select.return_value = ([stdin], [], [],) 

self.assertEqual(self._call(prompt), expected) 

 

@mock.patch("certbot.display.util.sys.stdout") 

def test_input_with_prompt(self, mock_stdout): 

prompt = "test prompt: " 

self.test_input(prompt) 

mock_stdout.write.assert_called_once_with(prompt) 

mock_stdout.flush.assert_called_once_with() 

 

def test_timeout(self): 

stdin = socket.socket(socket.AF_INET, socket.SOCK_STREAM) 

stdin.bind(('', 0)) 

stdin.listen(1) 

with mock.patch("certbot.display.util.sys.stdin", stdin): 

self.assertRaises(errors.Error, self._call, timeout=0.001) 

stdin.close() 

 

 

class FileOutputDisplayTest(unittest.TestCase): 

"""Test stdout display. 

 

Most of this class has to deal with visual output. In order to test how the 

functions look to a user, uncomment the test_visual function. 

 

""" 

# pylint:disable=too-many-public-methods 

def setUp(self): 

super(FileOutputDisplayTest, self).setUp() 

self.mock_stdout = mock.MagicMock() 

self.displayer = display_util.FileDisplay(self.mock_stdout, False) 

 

def test_notification_no_pause(self): 

self.displayer.notification("message", False) 

string = self.mock_stdout.write.call_args[0][0] 

 

self.assertTrue("message" in string) 

 

def test_notification_pause(self): 

input_with_timeout = "certbot.display.util.input_with_timeout" 

with mock.patch(input_with_timeout, return_value="enter"): 

self.displayer.notification("message", force_interactive=True) 

 

self.assertTrue("message" in self.mock_stdout.write.call_args[0][0]) 

 

def test_notification_noninteractive(self): 

self._force_noninteractive(self.displayer.notification, "message") 

string = self.mock_stdout.write.call_args[0][0] 

self.assertTrue("message" in string) 

 

def test_notification_noninteractive2(self): 

# The main purpose of this test is to make sure we only call 

# logger.warning once which _force_noninteractive checks internally 

self._force_noninteractive(self.displayer.notification, "message") 

string = self.mock_stdout.write.call_args[0][0] 

self.assertTrue("message" in string) 

 

self.assertTrue(self.displayer.skipped_interaction) 

 

self._force_noninteractive(self.displayer.notification, "message2") 

string = self.mock_stdout.write.call_args[0][0] 

self.assertTrue("message2" in string) 

 

@mock.patch("certbot.display.util." 

"FileDisplay._get_valid_int_ans") 

def test_menu(self, mock_ans): 

mock_ans.return_value = (display_util.OK, 1) 

ret = self.displayer.menu("message", CHOICES, force_interactive=True) 

self.assertEqual(ret, (display_util.OK, 0)) 

 

def test_menu_noninteractive(self): 

default = 0 

result = self._force_noninteractive( 

self.displayer.menu, "msg", CHOICES, default=default) 

self.assertEqual(result, (display_util.OK, default)) 

 

def test_input_cancel(self): 

input_with_timeout = "certbot.display.util.input_with_timeout" 

with mock.patch(input_with_timeout, return_value="c"): 

code, _ = self.displayer.input("message", force_interactive=True) 

 

self.assertTrue(code, display_util.CANCEL) 

 

def test_input_normal(self): 

input_with_timeout = "certbot.display.util.input_with_timeout" 

with mock.patch(input_with_timeout, return_value="domain.com"): 

code, input_ = self.displayer.input("message", force_interactive=True) 

 

self.assertEqual(code, display_util.OK) 

self.assertEqual(input_, "domain.com") 

 

def test_input_noninteractive(self): 

default = "foo" 

code, input_ = self._force_noninteractive( 

self.displayer.input, "message", default=default) 

 

self.assertEqual(code, display_util.OK) 

self.assertEqual(input_, default) 

 

def test_input_assertion_fail(self): 

# If the call to util.assert_valid_call is commented out, an 

# error.Error is raised, otherwise, an AssertionError is raised. 

self.assertRaises(Exception, self._force_noninteractive, 

self.displayer.input, "message", cli_flag="--flag") 

 

def test_input_assertion_fail2(self): 

with mock.patch("certbot.display.util.assert_valid_call"): 

self.assertRaises(errors.Error, self._force_noninteractive, 

self.displayer.input, "msg", cli_flag="--flag") 

 

def test_yesno(self): 

input_with_timeout = "certbot.display.util.input_with_timeout" 

with mock.patch(input_with_timeout, return_value="Yes"): 

self.assertTrue(self.displayer.yesno( 

"message", force_interactive=True)) 

with mock.patch(input_with_timeout, return_value="y"): 

self.assertTrue(self.displayer.yesno( 

"message", force_interactive=True)) 

with mock.patch(input_with_timeout, side_effect=["maybe", "y"]): 

self.assertTrue(self.displayer.yesno( 

"message", force_interactive=True)) 

with mock.patch(input_with_timeout, return_value="No"): 

self.assertFalse(self.displayer.yesno( 

"message", force_interactive=True)) 

with mock.patch(input_with_timeout, side_effect=["cancel", "n"]): 

self.assertFalse(self.displayer.yesno( 

"message", force_interactive=True)) 

 

with mock.patch(input_with_timeout, return_value="a"): 

self.assertTrue(self.displayer.yesno( 

"msg", yes_label="Agree", force_interactive=True)) 

 

def test_yesno_noninteractive(self): 

self.assertTrue(self._force_noninteractive( 

self.displayer.yesno, "message", default=True)) 

 

@mock.patch("certbot.display.util.input_with_timeout") 

def test_checklist_valid(self, mock_input): 

mock_input.return_value = "2 1" 

code, tag_list = self.displayer.checklist( 

"msg", TAGS, force_interactive=True) 

self.assertEqual( 

(code, set(tag_list)), (display_util.OK, set(["tag1", "tag2"]))) 

 

@mock.patch("certbot.display.util.input_with_timeout") 

def test_checklist_empty(self, mock_input): 

mock_input.return_value = "" 

code, tag_list = self.displayer.checklist("msg", TAGS, force_interactive=True) 

self.assertEqual( 

(code, set(tag_list)), (display_util.OK, set(["tag1", "tag2", "tag3"]))) 

 

@mock.patch("certbot.display.util.input_with_timeout") 

def test_checklist_miss_valid(self, mock_input): 

mock_input.side_effect = ["10", "tag1 please", "1"] 

 

ret = self.displayer.checklist("msg", TAGS, force_interactive=True) 

self.assertEqual(ret, (display_util.OK, ["tag1"])) 

 

@mock.patch("certbot.display.util.input_with_timeout") 

def test_checklist_miss_quit(self, mock_input): 

mock_input.side_effect = ["10", "c"] 

 

ret = self.displayer.checklist("msg", TAGS, force_interactive=True) 

self.assertEqual(ret, (display_util.CANCEL, [])) 

 

def test_checklist_noninteractive(self): 

default = TAGS 

code, input_ = self._force_noninteractive( 

self.displayer.checklist, "msg", TAGS, default=default) 

 

self.assertEqual(code, display_util.OK) 

self.assertEqual(input_, default) 

 

def test_scrub_checklist_input_valid(self): 

# pylint: disable=protected-access 

indices = [ 

["1"], 

["1", "2", "1"], 

["2", "3"], 

] 

exp = [ 

set(["tag1"]), 

set(["tag1", "tag2"]), 

set(["tag2", "tag3"]), 

] 

for i, list_ in enumerate(indices): 

set_tags = set( 

self.displayer._scrub_checklist_input(list_, TAGS)) 

self.assertEqual(set_tags, exp[i]) 

 

@mock.patch("certbot.display.util.input_with_timeout") 

def test_directory_select(self, mock_input): 

# pylint: disable=star-args 

args = ["msg", "/var/www/html", "--flag", True] 

user_input = "/var/www/html" 

mock_input.return_value = user_input 

 

returned = self.displayer.directory_select(*args) 

self.assertEqual(returned, (display_util.OK, user_input)) 

 

def test_directory_select_noninteractive(self): 

default = "/var/www/html" 

code, input_ = self._force_noninteractive( 

self.displayer.directory_select, "msg", default=default) 

 

self.assertEqual(code, display_util.OK) 

self.assertEqual(input_, default) 

 

def _force_noninteractive(self, func, *args, **kwargs): 

skipped_interaction = self.displayer.skipped_interaction 

 

with mock.patch("certbot.display.util.sys.stdin") as mock_stdin: 

mock_stdin.isatty.return_value = False 

with mock.patch("certbot.display.util.logger") as mock_logger: 

result = func(*args, **kwargs) 

 

if skipped_interaction: 

self.assertFalse(mock_logger.warning.called) 

else: 

self.assertEqual(mock_logger.warning.call_count, 1) 

 

return result 

 

def test_scrub_checklist_input_invalid(self): 

# pylint: disable=protected-access 

indices = [ 

["0"], 

["4"], 

["tag1"], 

["1", "tag1"], 

["2", "o"] 

] 

for list_ in indices: 

self.assertEqual( 

self.displayer._scrub_checklist_input(list_, TAGS), []) 

 

def test_print_menu(self): 

# pylint: disable=protected-access 

# This is purely cosmetic... just make sure there aren't any exceptions 

self.displayer._print_menu("msg", CHOICES) 

self.displayer._print_menu("msg", TAGS) 

 

def test_wrap_lines(self): 

# pylint: disable=protected-access 

msg = ("This is just a weak test{0}" 

"This function is only meant to be for easy viewing{0}" 

"Test a really really really really really really really really " 

"really really really really long line...".format('\n')) 

text = display_util._wrap_lines(msg) 

 

self.assertEqual(text.count('\n'), 3) 

 

def test_get_valid_int_ans_valid(self): 

# pylint: disable=protected-access 

input_with_timeout = "certbot.display.util.input_with_timeout" 

with mock.patch(input_with_timeout, return_value="1"): 

self.assertEqual( 

self.displayer._get_valid_int_ans(1), (display_util.OK, 1)) 

ans = "2" 

with mock.patch(input_with_timeout, return_value=ans): 

self.assertEqual( 

self.displayer._get_valid_int_ans(3), 

(display_util.OK, int(ans))) 

 

def test_get_valid_int_ans_invalid(self): 

# pylint: disable=protected-access 

answers = [ 

["0", "c"], 

["4", "one", "C"], 

["c"], 

] 

input_with_timeout = "certbot.display.util.input_with_timeout" 

for ans in answers: 

with mock.patch(input_with_timeout, side_effect=ans): 

self.assertEqual( 

self.displayer._get_valid_int_ans(3), 

(display_util.CANCEL, -1)) 

 

def test_methods_take_force_interactive(self): 

# Every IDisplay method implemented by FileDisplay must take 

# force_interactive to prevent workflow regressions. 

for name in interfaces.IDisplay.names(): # pylint: disable=no-member 

if six.PY2: 

getargspec = inspect.getargspec # pylint: disable=no-member 

else: 

getargspec = inspect.getfullargspec # pylint: disable=no-member 

arg_spec = getargspec(getattr(self.displayer, name)) 

self.assertTrue("force_interactive" in arg_spec.args) 

 

 

class NoninteractiveDisplayTest(unittest.TestCase): 

"""Test non-interactive display. These tests are pretty easy!""" 

def setUp(self): 

super(NoninteractiveDisplayTest, self).setUp() 

self.mock_stdout = mock.MagicMock() 

self.displayer = display_util.NoninteractiveDisplay(self.mock_stdout) 

 

def test_notification_no_pause(self): 

self.displayer.notification("message", 10) 

string = self.mock_stdout.write.call_args[0][0] 

 

self.assertTrue("message" in string) 

 

def test_input(self): 

d = "an incomputable value" 

ret = self.displayer.input("message", default=d) 

self.assertEqual(ret, (display_util.OK, d)) 

self.assertRaises(errors.MissingCommandlineFlag, self.displayer.input, "message") 

 

def test_menu(self): 

ret = self.displayer.menu("message", CHOICES, default=1) 

self.assertEqual(ret, (display_util.OK, 1)) 

self.assertRaises(errors.MissingCommandlineFlag, self.displayer.menu, "message", CHOICES) 

 

def test_yesno(self): 

d = False 

ret = self.displayer.yesno("message", default=d) 

self.assertEqual(ret, d) 

self.assertRaises(errors.MissingCommandlineFlag, self.displayer.yesno, "message") 

 

def test_checklist(self): 

d = [1, 3] 

ret = self.displayer.checklist("message", TAGS, default=d) 

self.assertEqual(ret, (display_util.OK, d)) 

self.assertRaises(errors.MissingCommandlineFlag, self.displayer.checklist, "message", TAGS) 

 

def test_directory_select(self): 

default = "/var/www/html" 

expected = (display_util.OK, default) 

actual = self.displayer.directory_select("msg", default) 

self.assertEqual(expected, actual) 

 

self.assertRaises( 

errors.MissingCommandlineFlag, self.displayer.directory_select, "msg") 

 

def test_methods_take_kwargs(self): 

# Every IDisplay method implemented by NoninteractiveDisplay 

# should take **kwargs because every method of FileDisplay must 

# take force_interactive which doesn't apply to 

# NoninteractiveDisplay. 

for name in interfaces.IDisplay.names(): # pylint: disable=no-member 

method = getattr(self.displayer, name) 

# asserts method accepts arbitrary keyword arguments 

if six.PY2: 

result = inspect.getargspec(method).keywords # pylint: disable=no-member 

self.assertFalse(result is None) 

else: 

result = inspect.getfullargspec(method).varkw # pylint: disable=no-member 

self.assertFalse(result is None) 

 

 

class SeparateListInputTest(unittest.TestCase): 

"""Test Module functions.""" 

def setUp(self): 

self.exp = ["a", "b", "c", "test"] 

 

@classmethod 

def _call(cls, input_): 

from certbot.display.util import separate_list_input 

return separate_list_input(input_) 

 

def test_commas(self): 

self.assertEqual(self._call("a,b,c,test"), self.exp) 

 

def test_spaces(self): 

self.assertEqual(self._call("a b c test"), self.exp) 

 

def test_both(self): 

self.assertEqual(self._call("a, b, c, test"), self.exp) 

 

def test_mess(self): 

actual = [ 

self._call(" a , b c \t test"), 

self._call(",a, ,, , b c test "), 

self._call(",,,,, , a b,,, , c,test"), 

] 

 

for act in actual: 

self.assertEqual(act, self.exp) 

 

 

class PlaceParensTest(unittest.TestCase): 

@classmethod 

def _call(cls, label): # pylint: disable=protected-access 

from certbot.display.util import _parens_around_char 

return _parens_around_char(label) 

 

def test_single_letter(self): 

self.assertEqual("(a)", self._call("a")) 

 

def test_multiple(self): 

self.assertEqual("(L)abel", self._call("Label")) 

self.assertEqual("(y)es please", self._call("yes please")) 

 

 

if __name__ == "__main__": 

unittest.main() # pragma: no cover