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

532

533

"""Tests for certbot.cli.""" 

import argparse 

import unittest 

import os 

import tempfile 

import copy 

import sys 

 

import mock 

import six 

from six.moves import reload_module # pylint: disable=import-error 

 

from acme import challenges 

 

from certbot import cli 

from certbot import constants 

from certbot import errors 

from certbot.plugins import disco 

 

import certbot.tests.util as test_util 

 

from certbot.tests.util import TempDirTestCase 

 

PLUGINS = disco.PluginsRegistry.find_all() 

 

 

class TestReadFile(TempDirTestCase): 

'''Test cli.read_file''' 

 

 

def test_read_file(self): 

rel_test_path = os.path.relpath(os.path.join(self.tempdir, 'foo')) 

self.assertRaises( 

argparse.ArgumentTypeError, cli.read_file, rel_test_path) 

 

test_contents = b'bar\n' 

with open(rel_test_path, 'wb') as f: 

f.write(test_contents) 

 

path, contents = cli.read_file(rel_test_path) 

self.assertEqual(path, os.path.abspath(path)) 

self.assertEqual(contents, test_contents) 

 

 

class FlagDefaultTest(unittest.TestCase): 

"""Tests cli.flag_default""" 

 

def test_linux_directories(self): 

if 'fcntl' in sys.modules: 

self.assertEqual(cli.flag_default('config_dir'), '/etc/letsencrypt') 

self.assertEqual(cli.flag_default('work_dir'), '/var/lib/letsencrypt') 

self.assertEqual(cli.flag_default('logs_dir'), '/var/log/letsencrypt') 

 

 

class ParseTest(unittest.TestCase): # pylint: disable=too-many-public-methods 

'''Test the cli args entrypoint''' 

 

 

def setUp(self): 

reload_module(cli) 

 

@staticmethod 

def _unmocked_parse(*args, **kwargs): 

"""Get result of cli.prepare_and_parse_args.""" 

return cli.prepare_and_parse_args(PLUGINS, *args, **kwargs) 

 

@staticmethod 

def parse(*args, **kwargs): 

"""Mocks zope.component.getUtility and calls _unmocked_parse.""" 

with test_util.patch_get_utility(): 

return ParseTest._unmocked_parse(*args, **kwargs) 

 

def _help_output(self, args): 

"Run a command, and return the output string for scrutiny" 

 

output = six.StringIO() 

 

def write_msg(message, *args, **kwargs): # pylint: disable=missing-docstring,unused-argument 

output.write(message) 

 

with mock.patch('certbot.main.sys.stdout', new=output): 

with test_util.patch_get_utility() as mock_get_utility: 

mock_get_utility().notification.side_effect = write_msg 

with mock.patch('certbot.main.sys.stderr'): 

self.assertRaises(SystemExit, self._unmocked_parse, args, output) 

 

return output.getvalue() 

 

@test_util.broken_on_windows 

@mock.patch("certbot.cli.flag_default") 

def test_cli_ini_domains(self, mock_flag_default): 

tmp_config = tempfile.NamedTemporaryFile() 

# use a shim to get ConfigArgParse to pick up tmp_config 

shim = ( 

lambda v: copy.deepcopy(constants.CLI_DEFAULTS[v]) 

if v != "config_files" 

else [tmp_config.name] 

) 

mock_flag_default.side_effect = shim 

 

namespace = self.parse(["certonly"]) 

self.assertEqual(namespace.domains, []) 

tmp_config.write(b"domains = example.com") 

tmp_config.flush() 

namespace = self.parse(["certonly"]) 

self.assertEqual(namespace.domains, ["example.com"]) 

namespace = self.parse(["renew"]) 

self.assertEqual(namespace.domains, []) 

 

def test_no_args(self): 

namespace = self.parse([]) 

for d in ('config_dir', 'logs_dir', 'work_dir'): 

self.assertEqual(getattr(namespace, d), cli.flag_default(d)) 

 

def test_install_abspath(self): 

cert = 'cert' 

key = 'key' 

chain = 'chain' 

fullchain = 'fullchain' 

 

with mock.patch('certbot.main.install'): 

namespace = self.parse(['install', '--cert-path', cert, 

'--key-path', 'key', '--chain-path', 

'chain', '--fullchain-path', 'fullchain']) 

 

self.assertEqual(namespace.cert_path, os.path.abspath(cert)) 

self.assertEqual(namespace.key_path, os.path.abspath(key)) 

self.assertEqual(namespace.chain_path, os.path.abspath(chain)) 

self.assertEqual(namespace.fullchain_path, os.path.abspath(fullchain)) 

 

def test_help(self): 

self._help_output(['--help']) # assert SystemExit is raised here 

out = self._help_output(['--help', 'all']) 

self.assertTrue("--configurator" in out) 

self.assertTrue("how a certificate is deployed" in out) 

self.assertTrue("--webroot-path" in out) 

self.assertTrue("--text" not in out) 

self.assertTrue("--dialog" not in out) 

self.assertTrue("%s" not in out) 

self.assertTrue("{0}" not in out) 

self.assertTrue("--renew-hook" not in out) 

 

out = self._help_output(['-h', 'nginx']) 

if "nginx" in PLUGINS: 

# may be false while building distributions without plugins 

self.assertTrue("--nginx-ctl" in out) 

self.assertTrue("--webroot-path" not in out) 

self.assertTrue("--checkpoints" not in out) 

 

out = self._help_output(['-h']) 

self.assertTrue("letsencrypt-auto" not in out) # test cli.cli_command 

if "nginx" in PLUGINS: 

self.assertTrue("Use the Nginx plugin" in out) 

else: 

self.assertTrue("(the certbot nginx plugin is not" in out) 

 

out = self._help_output(['--help', 'plugins']) 

self.assertTrue("--webroot-path" not in out) 

self.assertTrue("--prepare" in out) 

self.assertTrue('"plugins" subcommand' in out) 

 

# test multiple topics 

out = self._help_output(['-h', 'renew']) 

self.assertTrue("--keep" in out) 

out = self._help_output(['-h', 'automation']) 

self.assertTrue("--keep" in out) 

out = self._help_output(['-h', 'revoke']) 

self.assertTrue("--keep" not in out) 

 

out = self._help_output(['--help', 'install']) 

self.assertTrue("--cert-path" in out) 

self.assertTrue("--key-path" in out) 

 

out = self._help_output(['--help', 'revoke']) 

self.assertTrue("--cert-path" in out) 

self.assertTrue("--key-path" in out) 

self.assertTrue("--reason" in out) 

self.assertTrue("--delete-after-revoke" in out) 

self.assertTrue("--no-delete-after-revoke" in out) 

 

out = self._help_output(['-h', 'config_changes']) 

self.assertTrue("--cert-path" not in out) 

self.assertTrue("--key-path" not in out) 

 

out = self._help_output(['-h']) 

self.assertTrue(cli.SHORT_USAGE in out) 

self.assertTrue(cli.COMMAND_OVERVIEW[:100] in out) 

self.assertTrue("%s" not in out) 

self.assertTrue("{0}" not in out) 

 

def test_help_no_dashes(self): 

self._help_output(['help']) # assert SystemExit is raised here 

 

out = self._help_output(['help', 'all']) 

self.assertTrue("--configurator" in out) 

self.assertTrue("how a certificate is deployed" in out) 

self.assertTrue("--webroot-path" in out) 

self.assertTrue("--text" not in out) 

self.assertTrue("--dialog" not in out) 

self.assertTrue("%s" not in out) 

self.assertTrue("{0}" not in out) 

 

out = self._help_output(['help', 'install']) 

self.assertTrue("--cert-path" in out) 

self.assertTrue("--key-path" in out) 

 

out = self._help_output(['help', 'revoke']) 

self.assertTrue("--cert-path" in out) 

self.assertTrue("--key-path" in out) 

 

def test_parse_domains(self): 

short_args = ['-d', 'example.com'] 

namespace = self.parse(short_args) 

self.assertEqual(namespace.domains, ['example.com']) 

 

short_args = ['-d', 'trailing.period.com.'] 

namespace = self.parse(short_args) 

self.assertEqual(namespace.domains, ['trailing.period.com']) 

 

short_args = ['-d', 'example.com,another.net,third.org,example.com'] 

namespace = self.parse(short_args) 

self.assertEqual(namespace.domains, ['example.com', 'another.net', 

'third.org']) 

 

long_args = ['--domains', 'example.com'] 

namespace = self.parse(long_args) 

self.assertEqual(namespace.domains, ['example.com']) 

 

long_args = ['--domains', 'trailing.period.com.'] 

namespace = self.parse(long_args) 

self.assertEqual(namespace.domains, ['trailing.period.com']) 

 

long_args = ['--domains', 'example.com,another.net,example.com'] 

namespace = self.parse(long_args) 

self.assertEqual(namespace.domains, ['example.com', 'another.net']) 

 

def test_preferred_challenges(self): 

short_args = ['--preferred-challenges', 'http, tls-sni-01, dns'] 

namespace = self.parse(short_args) 

 

expected = [challenges.HTTP01.typ, 

challenges.TLSSNI01.typ, challenges.DNS01.typ] 

self.assertEqual(namespace.pref_challs, expected) 

 

short_args = ['--preferred-challenges', 'jumping-over-the-moon'] 

# argparse.ArgumentError makes argparse print more information 

# to stderr and call sys.exit() 

with mock.patch('sys.stderr'): 

self.assertRaises(SystemExit, self.parse, short_args) 

 

def test_server_flag(self): 

namespace = self.parse('--server example.com'.split()) 

self.assertEqual(namespace.server, 'example.com') 

 

def test_must_staple_flag(self): 

short_args = ['--must-staple'] 

namespace = self.parse(short_args) 

self.assertTrue(namespace.must_staple) 

self.assertTrue(namespace.staple) 

 

def test_no_gui(self): 

args = ['renew', '--dialog'] 

stderr = six.StringIO() 

with mock.patch('certbot.main.sys.stderr', new=stderr): 

namespace = self.parse(args) 

 

self.assertTrue(namespace.noninteractive_mode) 

self.assertTrue("--dialog is deprecated" in stderr.getvalue()) 

 

def _check_server_conflict_message(self, parser_args, conflicting_args): 

try: 

self.parse(parser_args) 

self.fail( # pragma: no cover 

"The following flags didn't conflict with " 

'--server: {0}'.format(', '.join(conflicting_args))) 

except errors.Error as error: 

self.assertTrue('--server' in str(error)) 

for arg in conflicting_args: 

self.assertTrue(arg in str(error)) 

 

def test_staging_flag(self): 

short_args = ['--staging'] 

namespace = self.parse(short_args) 

self.assertTrue(namespace.staging) 

self.assertEqual(namespace.server, constants.STAGING_URI) 

 

short_args += '--server example.com'.split() 

self._check_server_conflict_message(short_args, '--staging') 

 

def _assert_dry_run_flag_worked(self, namespace, existing_account): 

self.assertTrue(namespace.dry_run) 

self.assertTrue(namespace.break_my_certs) 

self.assertTrue(namespace.staging) 

self.assertEqual(namespace.server, constants.STAGING_URI) 

 

if existing_account: 

self.assertTrue(namespace.tos) 

self.assertTrue(namespace.register_unsafely_without_email) 

else: 

self.assertFalse(namespace.tos) 

self.assertFalse(namespace.register_unsafely_without_email) 

 

def test_dry_run_flag(self): 

config_dir = tempfile.mkdtemp() 

short_args = '--dry-run --config-dir {0}'.format(config_dir).split() 

self.assertRaises(errors.Error, self.parse, short_args) 

 

self._assert_dry_run_flag_worked( 

self.parse(short_args + ['auth']), False) 

self._assert_dry_run_flag_worked( 

self.parse(short_args + ['certonly']), False) 

self._assert_dry_run_flag_worked( 

self.parse(short_args + ['renew']), False) 

 

account_dir = os.path.join(config_dir, constants.ACCOUNTS_DIR) 

os.mkdir(account_dir) 

os.mkdir(os.path.join(account_dir, 'fake_account_dir')) 

 

self._assert_dry_run_flag_worked(self.parse(short_args + ['auth']), True) 

self._assert_dry_run_flag_worked(self.parse(short_args + ['renew']), True) 

short_args += ['certonly'] 

self._assert_dry_run_flag_worked(self.parse(short_args), True) 

 

short_args += '--server example.com'.split() 

conflicts = ['--dry-run'] 

self._check_server_conflict_message(short_args, '--dry-run') 

 

short_args += ['--staging'] 

conflicts += ['--staging'] 

self._check_server_conflict_message(short_args, conflicts) 

 

def test_option_was_set(self): 

key_size_option = 'rsa_key_size' 

key_size_value = cli.flag_default(key_size_option) 

self.parse('--rsa-key-size {0}'.format(key_size_value).split()) 

 

self.assertTrue(cli.option_was_set(key_size_option, key_size_value)) 

self.assertTrue(cli.option_was_set('no_verify_ssl', True)) 

 

config_dir_option = 'config_dir' 

self.assertFalse(cli.option_was_set( 

config_dir_option, cli.flag_default(config_dir_option))) 

 

def test_encode_revocation_reason(self): 

for reason, code in constants.REVOCATION_REASONS.items(): 

namespace = self.parse(['--reason', reason]) 

self.assertEqual(namespace.reason, code) 

for reason, code in constants.REVOCATION_REASONS.items(): 

namespace = self.parse(['--reason', reason.upper()]) 

self.assertEqual(namespace.reason, code) 

 

def test_force_interactive(self): 

self.assertRaises( 

errors.Error, self.parse, "renew --force-interactive".split()) 

self.assertRaises( 

errors.Error, self.parse, "-n --force-interactive".split()) 

 

def test_deploy_hook_conflict(self): 

with mock.patch("certbot.cli.sys.stderr"): 

self.assertRaises(SystemExit, self.parse, 

"--renew-hook foo --deploy-hook bar".split()) 

 

def test_deploy_hook_matches_renew_hook(self): 

value = "foo" 

namespace = self.parse(["--renew-hook", value, 

"--deploy-hook", value, 

"--disable-hook-validation"]) 

self.assertEqual(namespace.deploy_hook, value) 

self.assertEqual(namespace.renew_hook, value) 

 

def test_deploy_hook_sets_renew_hook(self): 

value = "foo" 

namespace = self.parse( 

["--deploy-hook", value, "--disable-hook-validation"]) 

self.assertEqual(namespace.deploy_hook, value) 

self.assertEqual(namespace.renew_hook, value) 

 

def test_renew_hook_conflict(self): 

with mock.patch("certbot.cli.sys.stderr"): 

self.assertRaises(SystemExit, self.parse, 

"--deploy-hook foo --renew-hook bar".split()) 

 

def test_renew_hook_matches_deploy_hook(self): 

value = "foo" 

namespace = self.parse(["--deploy-hook", value, 

"--renew-hook", value, 

"--disable-hook-validation"]) 

self.assertEqual(namespace.deploy_hook, value) 

self.assertEqual(namespace.renew_hook, value) 

 

def test_renew_hook_does_not_set_renew_hook(self): 

value = "foo" 

namespace = self.parse( 

["--renew-hook", value, "--disable-hook-validation"]) 

self.assertEqual(namespace.deploy_hook, None) 

self.assertEqual(namespace.renew_hook, value) 

 

def test_max_log_backups_error(self): 

with mock.patch('certbot.cli.sys.stderr'): 

self.assertRaises( 

SystemExit, self.parse, "--max-log-backups foo".split()) 

self.assertRaises( 

SystemExit, self.parse, "--max-log-backups -42".split()) 

 

def test_max_log_backups_success(self): 

value = "42" 

namespace = self.parse(["--max-log-backups", value]) 

self.assertEqual(namespace.max_log_backups, int(value)) 

 

def test_unchanging_defaults(self): 

namespace = self.parse([]) 

self.assertEqual(namespace.domains, []) 

self.assertEqual(namespace.pref_challs, []) 

 

namespace.pref_challs = [challenges.HTTP01.typ] 

namespace.domains = ['example.com'] 

 

namespace = self.parse([]) 

self.assertEqual(namespace.domains, []) 

self.assertEqual(namespace.pref_challs, []) 

 

def test_no_directory_hooks_set(self): 

self.assertFalse(self.parse(["--no-directory-hooks"]).directory_hooks) 

 

def test_no_directory_hooks_unset(self): 

self.assertTrue(self.parse([]).directory_hooks) 

 

def test_delete_after_revoke(self): 

namespace = self.parse(["--delete-after-revoke"]) 

self.assertTrue(namespace.delete_after_revoke) 

 

def test_delete_after_revoke_default(self): 

namespace = self.parse([]) 

self.assertEqual(namespace.delete_after_revoke, None) 

 

def test_no_delete_after_revoke(self): 

namespace = self.parse(["--no-delete-after-revoke"]) 

self.assertFalse(namespace.delete_after_revoke) 

 

def test_allow_subset_with_wildcard(self): 

self.assertRaises(errors.Error, self.parse, 

"--allow-subset-of-names -d *.example.org".split()) 

 

def test_route53_no_revert(self): 

for help_flag in ['-h', '--help']: 

for topic in ['all', 'plugins', 'dns-route53']: 

self.assertFalse('certbot-route53:auth' in self._help_output([help_flag, topic])) 

 

 

class DefaultTest(unittest.TestCase): 

"""Tests for certbot.cli._Default.""" 

 

 

def setUp(self): 

# pylint: disable=protected-access 

self.default1 = cli._Default() 

self.default2 = cli._Default() 

 

def test_boolean(self): 

self.assertFalse(self.default1) 

self.assertFalse(self.default2) 

 

def test_equality(self): 

self.assertEqual(self.default1, self.default2) 

 

def test_hash(self): 

self.assertEqual(hash(self.default1), hash(self.default2)) 

 

 

class SetByCliTest(unittest.TestCase): 

"""Tests for certbot.set_by_cli and related functions.""" 

 

 

def setUp(self): 

reload_module(cli) 

 

def test_deploy_hook(self): 

self.assertTrue(_call_set_by_cli( 

'renew_hook', '--deploy-hook foo'.split(), 'renew')) 

 

def test_webroot_map(self): 

args = '-w /var/www/html -d example.com'.split() 

verb = 'renew' 

self.assertTrue(_call_set_by_cli('webroot_map', args, verb)) 

 

def test_report_config_interaction_str(self): 

cli.report_config_interaction('manual_public_ip_logging_ok', 

'manual_auth_hook') 

cli.report_config_interaction('manual_auth_hook', 'manual') 

 

self._test_report_config_interaction_common() 

 

def test_report_config_interaction_iterable(self): 

cli.report_config_interaction(('manual_public_ip_logging_ok',), 

('manual_auth_hook',)) 

cli.report_config_interaction(('manual_auth_hook',), ('manual',)) 

 

self._test_report_config_interaction_common() 

 

def _test_report_config_interaction_common(self): 

"""Tests implied interaction between manual flags. 

 

--manual implies --manual-auth-hook which implies 

--manual-public-ip-logging-ok. These interactions don't actually 

exist in the client, but are used here for testing purposes. 

 

""" 

 

args = ['--manual'] 

verb = 'renew' 

for v in ('manual', 'manual_auth_hook', 'manual_public_ip_logging_ok'): 

self.assertTrue(_call_set_by_cli(v, args, verb)) 

 

# https://github.com/python/mypy/issues/2087 

cli.set_by_cli.detector = None # type: ignore 

 

args = ['--manual-auth-hook', 'command'] 

for v in ('manual_auth_hook', 'manual_public_ip_logging_ok'): 

self.assertTrue(_call_set_by_cli(v, args, verb)) 

 

self.assertFalse(_call_set_by_cli('manual', args, verb)) 

 

 

def _call_set_by_cli(var, args, verb): 

with mock.patch('certbot.cli.helpful_parser') as mock_parser: 

with test_util.patch_get_utility(): 

mock_parser.args = args 

mock_parser.verb = verb 

return cli.set_by_cli(var) 

 

 

if __name__ == '__main__': 

unittest.main() # pragma: no cover