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

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

# coding=utf-8 

"""Test certbot.display.ops.""" 

import os 

import sys 

import unittest 

 

import josepy as jose 

import mock 

import zope.component 

 

from acme import messages 

 

from certbot import account 

from certbot import errors 

 

from certbot.display import util as display_util 

from certbot.display import ops 

 

import certbot.tests.util as test_util 

 

 

KEY = jose.JWKRSA.load(test_util.load_vector("rsa512_key.pem")) 

 

 

class GetEmailTest(unittest.TestCase): 

"""Tests for certbot.display.ops.get_email.""" 

 

@classmethod 

def _call(cls, **kwargs): 

from certbot.display.ops import get_email 

return get_email(**kwargs) 

 

@test_util.patch_get_utility("certbot.display.ops.z_util") 

def test_cancel_none(self, mock_get_utility): 

mock_input = mock_get_utility().input 

mock_input.return_value = (display_util.CANCEL, "foo@bar.baz") 

self.assertRaises(errors.Error, self._call) 

self.assertRaises(errors.Error, self._call, optional=False) 

 

@test_util.patch_get_utility("certbot.display.ops.z_util") 

def test_ok_safe(self, mock_get_utility): 

mock_input = mock_get_utility().input 

mock_input.return_value = (display_util.OK, "foo@bar.baz") 

with mock.patch("certbot.display.ops.util.safe_email") as mock_safe_email: 

mock_safe_email.return_value = True 

self.assertTrue(self._call() is "foo@bar.baz") 

 

@test_util.patch_get_utility("certbot.display.ops.z_util") 

def test_ok_not_safe(self, mock_get_utility): 

mock_input = mock_get_utility().input 

mock_input.return_value = (display_util.OK, "foo@bar.baz") 

with mock.patch("certbot.display.ops.util.safe_email") as mock_safe_email: 

mock_safe_email.side_effect = [False, True] 

self.assertTrue(self._call() is "foo@bar.baz") 

 

@test_util.patch_get_utility("certbot.display.ops.z_util") 

def test_invalid_flag(self, mock_get_utility): 

invalid_txt = "There seem to be problems" 

mock_input = mock_get_utility().input 

mock_input.return_value = (display_util.OK, "foo@bar.baz") 

with mock.patch("certbot.display.ops.util.safe_email") as mock_safe_email: 

mock_safe_email.return_value = True 

self._call() 

self.assertTrue(invalid_txt not in mock_input.call_args[0][0]) 

self._call(invalid=True) 

self.assertTrue(invalid_txt in mock_input.call_args[0][0]) 

 

@test_util.patch_get_utility("certbot.display.ops.z_util") 

def test_optional_flag(self, mock_get_utility): 

mock_input = mock_get_utility().input 

mock_input.return_value = (display_util.OK, "foo@bar.baz") 

with mock.patch("certbot.display.ops.util.safe_email") as mock_safe_email: 

mock_safe_email.side_effect = [False, True] 

self._call(optional=False) 

for call in mock_input.call_args_list: 

self.assertTrue( 

"--register-unsafely-without-email" not in call[0][0]) 

 

@test_util.patch_get_utility("certbot.display.ops.z_util") 

def test_optional_invalid_unsafe(self, mock_get_utility): 

invalid_txt = "There seem to be problems" 

mock_input = mock_get_utility().input 

mock_input.return_value = (display_util.OK, "foo@bar.baz") 

with mock.patch("certbot.display.ops.util.safe_email") as mock_safe_email: 

mock_safe_email.side_effect = [False, True] 

self._call(invalid=True) 

self.assertTrue(invalid_txt in mock_input.call_args[0][0]) 

 

 

class ChooseAccountTest(test_util.TempDirTestCase): 

"""Tests for certbot.display.ops.choose_account.""" 

def setUp(self): 

super(ChooseAccountTest, self).setUp() 

 

zope.component.provideUtility(display_util.FileDisplay(sys.stdout, 

False)) 

 

self.account_keys_dir = os.path.join(self.tempdir, "keys") 

os.makedirs(self.account_keys_dir, 0o700) 

 

self.config = mock.MagicMock( 

accounts_dir=self.tempdir, 

account_keys_dir=self.account_keys_dir, 

server="certbot-demo.org") 

self.key = KEY 

 

self.acc1 = account.Account(messages.RegistrationResource( 

uri=None, body=messages.Registration.from_data( 

email="email1@g.com")), self.key) 

self.acc2 = account.Account(messages.RegistrationResource( 

uri=None, body=messages.Registration.from_data( 

email="email2@g.com", phone="phone")), self.key) 

 

@classmethod 

def _call(cls, accounts): 

return ops.choose_account(accounts) 

 

@test_util.patch_get_utility("certbot.display.ops.z_util") 

def test_one(self, mock_util): 

mock_util().menu.return_value = (display_util.OK, 0) 

self.assertEqual(self._call([self.acc1]), self.acc1) 

 

@test_util.patch_get_utility("certbot.display.ops.z_util") 

def test_two(self, mock_util): 

mock_util().menu.return_value = (display_util.OK, 1) 

self.assertEqual(self._call([self.acc1, self.acc2]), self.acc2) 

 

@test_util.patch_get_utility("certbot.display.ops.z_util") 

def test_cancel(self, mock_util): 

mock_util().menu.return_value = (display_util.CANCEL, 1) 

self.assertTrue(self._call([self.acc1, self.acc2]) is None) 

 

 

class GenSSLLabURLs(unittest.TestCase): 

"""Loose test of _gen_ssl_lab_urls. URL can change easily in the future.""" 

def setUp(self): 

zope.component.provideUtility(display_util.FileDisplay(sys.stdout, 

False)) 

 

@classmethod 

def _call(cls, domains): 

from certbot.display.ops import _gen_ssl_lab_urls 

return _gen_ssl_lab_urls(domains) 

 

def test_zero(self): 

self.assertEqual(self._call([]), []) 

 

def test_two(self): 

urls = self._call(["eff.org", "umich.edu"]) 

self.assertTrue("eff.org" in urls[0]) 

self.assertTrue("umich.edu" in urls[1]) 

 

 

class GenHttpsNamesTest(unittest.TestCase): 

"""Test _gen_https_names.""" 

def setUp(self): 

zope.component.provideUtility(display_util.FileDisplay(sys.stdout, 

False)) 

 

@classmethod 

def _call(cls, domains): 

from certbot.display.ops import _gen_https_names 

return _gen_https_names(domains) 

 

def test_zero(self): 

self.assertEqual(self._call([]), "") 

 

def test_one(self): 

doms = [ 

"example.com", 

"asllkjsadfljasdf.c", 

] 

for dom in doms: 

self.assertEqual(self._call([dom]), "https://%s" % dom) 

 

def test_two(self): 

domains_list = [ 

["foo.bar.org", "bar.org"], 

["paypal.google.facebook.live.com", "*.zombo.example.com"], 

] 

for doms in domains_list: 

self.assertEqual( 

self._call(doms), 

"https://{dom[0]} and https://{dom[1]}".format(dom=doms)) 

 

def test_three(self): 

doms = ["a.org", "b.org", "c.org"] 

# We use an oxford comma 

self.assertEqual( 

self._call(doms), 

"https://{dom[0]}, https://{dom[1]}, and https://{dom[2]}".format( 

dom=doms)) 

 

def test_four(self): 

doms = ["a.org", "b.org", "c.org", "d.org"] 

exp = ("https://{dom[0]}, https://{dom[1]}, https://{dom[2]}, " 

"and https://{dom[3]}".format(dom=doms)) 

 

self.assertEqual(self._call(doms), exp) 

 

 

class ChooseNamesTest(unittest.TestCase): 

"""Test choose names.""" 

def setUp(self): 

zope.component.provideUtility(display_util.FileDisplay(sys.stdout, 

False)) 

self.mock_install = mock.MagicMock() 

 

@classmethod 

def _call(cls, installer, question=None): 

from certbot.display.ops import choose_names 

return choose_names(installer, question) 

 

@mock.patch("certbot.display.ops._choose_names_manually") 

def test_no_installer(self, mock_manual): 

self._call(None) 

self.assertEqual(mock_manual.call_count, 1) 

 

@test_util.patch_get_utility("certbot.display.ops.z_util") 

def test_no_installer_cancel(self, mock_util): 

mock_util().input.return_value = (display_util.CANCEL, []) 

self.assertEqual(self._call(None), []) 

 

@test_util.patch_get_utility("certbot.display.ops.z_util") 

def test_no_names_choose(self, mock_util): 

self.mock_install().get_all_names.return_value = set() 

domain = "example.com" 

mock_util().input.return_value = (display_util.OK, domain) 

 

actual_doms = self._call(self.mock_install) 

self.assertEqual(mock_util().input.call_count, 1) 

self.assertEqual(actual_doms, [domain]) 

self.assertTrue( 

"configuration files" in mock_util().input.call_args[0][0]) 

 

def test_sort_names_trivial(self): 

from certbot.display.ops import _sort_names 

 

#sort an empty list 

self.assertEqual(_sort_names([]), []) 

 

#sort simple domains 

some_domains = ["ex.com", "zx.com", "ax.com"] 

self.assertEqual(_sort_names(some_domains), ["ax.com", "ex.com", "zx.com"]) 

 

#Sort subdomains of a single domain 

domain = ".ex.com" 

unsorted_short = ["e", "a", "z", "y"] 

unsorted_long = [us + domain for us in unsorted_short] 

 

sorted_short = sorted(unsorted_short) 

sorted_long = [us + domain for us in sorted_short] 

 

self.assertEqual(_sort_names(unsorted_long), sorted_long) 

 

def test_sort_names_many(self): 

from certbot.display.ops import _sort_names 

 

unsorted_domains = [".cx.com", ".bx.com", ".ax.com", ".dx.com"] 

unsorted_short = ["www", "bnother.long.subdomain", "a", "a.long.subdomain", "z", "b"] 

#Of course sorted doesn't work here ;-) 

sorted_short = ["a", "b", "a.long.subdomain", "bnother.long.subdomain", "www", "z"] 

 

to_sort = [] 

for short in unsorted_short: 

for domain in unsorted_domains: 

to_sort.append(short+domain) 

sortd = [] 

for domain in sorted(unsorted_domains): 

for short in sorted_short: 

sortd.append(short+domain) 

self.assertEqual(_sort_names(to_sort), sortd) 

 

 

@test_util.patch_get_utility("certbot.display.ops.z_util") 

def test_filter_names_valid_return(self, mock_util): 

self.mock_install.get_all_names.return_value = set(["example.com"]) 

mock_util().checklist.return_value = (display_util.OK, ["example.com"]) 

 

names = self._call(self.mock_install) 

self.assertEqual(names, ["example.com"]) 

self.assertEqual(mock_util().checklist.call_count, 1) 

 

@test_util.patch_get_utility("certbot.display.ops.z_util") 

def test_filter_namees_override_question(self, mock_util): 

self.mock_install.get_all_names.return_value = set(["example.com"]) 

mock_util().checklist.return_value = (display_util.OK, ["example.com"]) 

names = self._call(self.mock_install, "Custom") 

self.assertEqual(names, ["example.com"]) 

self.assertEqual(mock_util().checklist.call_count, 1) 

self.assertEqual(mock_util().checklist.call_args[0][0], "Custom") 

 

@test_util.patch_get_utility("certbot.display.ops.z_util") 

def test_filter_names_nothing_selected(self, mock_util): 

self.mock_install.get_all_names.return_value = set(["example.com"]) 

mock_util().checklist.return_value = (display_util.OK, []) 

 

self.assertEqual(self._call(self.mock_install), []) 

 

@test_util.patch_get_utility("certbot.display.ops.z_util") 

def test_filter_names_cancel(self, mock_util): 

self.mock_install.get_all_names.return_value = set(["example.com"]) 

mock_util().checklist.return_value = ( 

display_util.CANCEL, ["example.com"]) 

 

self.assertEqual(self._call(self.mock_install), []) 

 

def test_get_valid_domains(self): 

from certbot.display.ops import get_valid_domains 

all_valid = ["example.com", "second.example.com", 

"also.example.com", "under_score.example.com", 

"justtld", "*.wildcard.com"] 

all_invalid = ["öóòps.net", "uniçodé.com"] 

two_valid = ["example.com", "úniçøde.com", "also.example.com"] 

self.assertEqual(get_valid_domains(all_valid), all_valid) 

self.assertEqual(get_valid_domains(all_invalid), []) 

self.assertEqual(len(get_valid_domains(two_valid)), 2) 

 

@test_util.patch_get_utility("certbot.display.ops.z_util") 

def test_choose_manually(self, mock_util): 

from certbot.display.ops import _choose_names_manually 

utility_mock = mock_util() 

# No retry 

utility_mock.yesno.return_value = False 

# IDN and no retry 

utility_mock.input.return_value = (display_util.OK, 

"uniçodé.com") 

self.assertEqual(_choose_names_manually(), []) 

# IDN exception with previous mocks 

with mock.patch( 

"certbot.display.ops.display_util.separate_list_input" 

) as mock_sli: 

unicode_error = UnicodeEncodeError('mock', u'', 0, 1, 'mock') 

mock_sli.side_effect = unicode_error 

self.assertEqual(_choose_names_manually(), []) 

# Valid domains 

utility_mock.input.return_value = (display_util.OK, 

("example.com," 

"under_score.example.com," 

"justtld," 

"valid.example.com")) 

self.assertEqual(_choose_names_manually(), 

["example.com", "under_score.example.com", 

"justtld", "valid.example.com"]) 

 

@test_util.patch_get_utility("certbot.display.ops.z_util") 

def test_choose_manually_retry(self, mock_util): 

from certbot.display.ops import _choose_names_manually 

utility_mock = mock_util() 

# Three iterations 

utility_mock.input.return_value = (display_util.OK, 

"uniçodé.com") 

utility_mock.yesno.side_effect = [True, True, False] 

_choose_names_manually() 

self.assertEqual(utility_mock.yesno.call_count, 3) 

 

 

class SuccessInstallationTest(unittest.TestCase): 

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

"""Test the success installation message.""" 

@classmethod 

def _call(cls, names): 

from certbot.display.ops import success_installation 

success_installation(names) 

 

@test_util.patch_get_utility("certbot.display.ops.z_util") 

def test_success_installation(self, mock_util): 

mock_util().notification.return_value = None 

names = ["example.com", "abc.com"] 

 

self._call(names) 

 

self.assertEqual(mock_util().notification.call_count, 1) 

arg = mock_util().notification.call_args_list[0][0][0] 

 

for name in names: 

self.assertTrue(name in arg) 

 

 

class SuccessRenewalTest(unittest.TestCase): 

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

"""Test the success renewal message.""" 

@classmethod 

def _call(cls, names): 

from certbot.display.ops import success_renewal 

success_renewal(names) 

 

@test_util.patch_get_utility("certbot.display.ops.z_util") 

def test_success_renewal(self, mock_util): 

mock_util().notification.return_value = None 

names = ["example.com", "abc.com"] 

 

self._call(names) 

 

self.assertEqual(mock_util().notification.call_count, 1) 

arg = mock_util().notification.call_args_list[0][0][0] 

 

for name in names: 

self.assertTrue(name in arg) 

 

class SuccessRevocationTest(unittest.TestCase): 

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

"""Test the success revocation message.""" 

@classmethod 

def _call(cls, path): 

from certbot.display.ops import success_revocation 

success_revocation(path) 

 

@test_util.patch_get_utility("certbot.display.ops.z_util") 

def test_success_revocation(self, mock_util): 

mock_util().notification.return_value = None 

path = "/path/to/cert.pem" 

self._call(path) 

mock_util().notification.assert_called_once_with( 

"Congratulations! You have successfully revoked the certificate " 

"that was located at {0}{1}{1}".format( 

path, 

os.linesep), pause=False) 

self.assertTrue(path in mock_util().notification.call_args[0][0]) 

 

 

class ValidatorTests(unittest.TestCase): 

"""Tests for `validated_input` and `validated_directory`.""" 

 

__ERROR = "Must be non-empty" 

 

valid_input = "asdf" 

valid_directory = "/var/www/html" 

 

@staticmethod 

def __validator(m): 

if m == "": 

raise errors.PluginError(ValidatorTests.__ERROR) 

 

@test_util.patch_get_utility() 

def test_input_blank_with_validator(self, mock_util): 

mock_util().input.side_effect = [(display_util.OK, ""), 

(display_util.OK, ""), 

(display_util.OK, ""), 

(display_util.OK, self.valid_input)] 

 

returned = ops.validated_input(self.__validator, "message", force_interactive=True) 

self.assertEqual(ValidatorTests.__ERROR, mock_util().notification.call_args[0][0]) 

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

 

@test_util.patch_get_utility() 

def test_input_validation_with_default(self, mock_util): 

mock_util().input.side_effect = [(display_util.OK, self.valid_input)] 

 

returned = ops.validated_input(self.__validator, "msg", default="other") 

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

 

@test_util.patch_get_utility() 

def test_input_validation_with_bad_default(self, mock_util): 

mock_util().input.side_effect = [(display_util.OK, self.valid_input)] 

 

self.assertRaises(AssertionError, 

ops.validated_input, 

self.__validator, "msg", default="") 

 

@test_util.patch_get_utility() 

def test_input_cancel_with_validator(self, mock_util): 

mock_util().input.side_effect = [(display_util.CANCEL, "")] 

 

code, unused_raw = ops.validated_input(self.__validator, "message", force_interactive=True) 

self.assertEqual(code, display_util.CANCEL) 

 

@test_util.patch_get_utility() 

def test_directory_select_validation(self, mock_util): 

mock_util().directory_select.side_effect = [(display_util.OK, ""), 

(display_util.OK, self.valid_directory)] 

 

returned = ops.validated_directory(self.__validator, "msg", force_interactive=True) 

self.assertEqual(ValidatorTests.__ERROR, mock_util().notification.call_args[0][0]) 

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

 

@test_util.patch_get_utility() 

def test_directory_select_validation_with_default(self, mock_util): 

mock_util().directory_select.side_effect = [(display_util.OK, self.valid_directory)] 

 

returned = ops.validated_directory(self.__validator, "msg", default="other") 

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

 

@test_util.patch_get_utility() 

def test_directory_select_validation_with_bad_default(self, mock_util): 

mock_util().directory_select.side_effect = [(display_util.OK, self.valid_directory)] 

 

self.assertRaises(AssertionError, 

ops.validated_directory, 

self.__validator, "msg", default="") 

 

 

class ChooseValuesTest(unittest.TestCase): 

"""Test choose_values.""" 

@classmethod 

def _call(cls, values, question): 

from certbot.display.ops import choose_values 

return choose_values(values, question) 

 

@test_util.patch_get_utility("certbot.display.ops.z_util") 

def test_choose_names_success(self, mock_util): 

items = ["first", "second", "third"] 

mock_util().checklist.return_value = (display_util.OK, [items[2]]) 

result = self._call(items, None) 

self.assertEqual(result, [items[2]]) 

self.assertTrue(mock_util().checklist.called) 

self.assertEqual(mock_util().checklist.call_args[0][0], None) 

 

@test_util.patch_get_utility("certbot.display.ops.z_util") 

def test_choose_names_success_question(self, mock_util): 

items = ["first", "second", "third"] 

question = "Which one?" 

mock_util().checklist.return_value = (display_util.OK, [items[1]]) 

result = self._call(items, question) 

self.assertEqual(result, [items[1]]) 

self.assertTrue(mock_util().checklist.called) 

self.assertEqual(mock_util().checklist.call_args[0][0], question) 

 

@test_util.patch_get_utility("certbot.display.ops.z_util") 

def test_choose_names_user_cancel(self, mock_util): 

items = ["first", "second", "third"] 

question = "Want to cancel?" 

mock_util().checklist.return_value = (display_util.CANCEL, []) 

result = self._call(items, question) 

self.assertEqual(result, []) 

self.assertTrue(mock_util().checklist.called) 

self.assertEqual(mock_util().checklist.call_args[0][0], question) 

 

 

if __name__ == "__main__": 

unittest.main() # pragma: no cover