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

"""Tests for certbot.hooks.""" 

import os 

import stat 

import unittest 

 

import mock 

 

from acme.magic_typing import List # pylint: disable=unused-import, no-name-in-module 

from certbot import errors 

from certbot.tests import util 

 

 

class ValidateHooksTest(unittest.TestCase): 

"""Tests for certbot.hooks.validate_hooks.""" 

 

@classmethod 

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

from certbot.hooks import validate_hooks 

return validate_hooks(*args, **kwargs) 

 

@mock.patch("certbot.hooks.validate_hook") 

def test_it(self, mock_validate_hook): 

config = mock.MagicMock() 

self._call(config) 

 

types = [call[0][1] for call in mock_validate_hook.call_args_list] 

self.assertEqual(set(("pre", "post", "deploy",)), set(types[:-1])) 

# This ensures error messages are about deploy hooks when appropriate 

self.assertEqual("renew", types[-1]) 

 

 

class ValidateHookTest(util.TempDirTestCase): 

"""Tests for certbot.hooks.validate_hook.""" 

 

@classmethod 

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

from certbot.hooks import validate_hook 

return validate_hook(*args, **kwargs) 

 

@util.broken_on_windows 

def test_not_executable(self): 

file_path = os.path.join(self.tempdir, "foo") 

# create a non-executable file 

os.close(os.open(file_path, os.O_CREAT | os.O_WRONLY, 0o666)) 

# prevent unnecessary modifications to PATH 

with mock.patch("certbot.hooks.plug_util.path_surgery"): 

self.assertRaises(errors.HookCommandNotFound, 

self._call, file_path, "foo") 

 

@mock.patch("certbot.hooks.util.exe_exists") 

def test_not_found(self, mock_exe_exists): 

mock_exe_exists.return_value = False 

with mock.patch("certbot.hooks.plug_util.path_surgery") as mock_ps: 

self.assertRaises(errors.HookCommandNotFound, 

self._call, "foo", "bar") 

self.assertTrue(mock_ps.called) 

 

@mock.patch("certbot.hooks._prog") 

def test_unset(self, mock_prog): 

self._call(None, "foo") 

self.assertFalse(mock_prog.called) 

 

 

class HookTest(util.ConfigTestCase): 

"""Common base class for hook tests.""" 

 

@classmethod 

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

"""Calls the method being tested with the given arguments.""" 

raise NotImplementedError 

 

@classmethod 

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

"""Calls self._call after mocking out certbot.hooks.execute. 

 

The mock execute object is returned rather than the return value 

of self._call. 

 

""" 

with mock.patch("certbot.hooks.execute") as mock_execute: 

mock_execute.return_value = ("", "") 

cls._call(*args, **kwargs) 

return mock_execute 

 

 

class PreHookTest(HookTest): 

"""Tests for certbot.hooks.pre_hook.""" 

 

@classmethod 

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

from certbot.hooks import pre_hook 

return pre_hook(*args, **kwargs) 

 

def setUp(self): 

super(PreHookTest, self).setUp() 

self.config.pre_hook = "foo" 

 

os.makedirs(self.config.renewal_pre_hooks_dir) 

self.dir_hook = os.path.join(self.config.renewal_pre_hooks_dir, "bar") 

create_hook(self.dir_hook) 

 

# Reset this value as it may have been modified by past tests 

self._reset_pre_hook_already() 

 

def tearDown(self): 

# Reset this value so it's unmodified for future tests 

self._reset_pre_hook_already() 

super(PreHookTest, self).tearDown() 

 

def _reset_pre_hook_already(self): 

from certbot.hooks import executed_pre_hooks 

executed_pre_hooks.clear() 

 

def test_certonly(self): 

self.config.verb = "certonly" 

self._test_nonrenew_common() 

 

def test_run(self): 

self.config.verb = "run" 

self._test_nonrenew_common() 

 

def _test_nonrenew_common(self): 

mock_execute = self._call_with_mock_execute(self.config) 

mock_execute.assert_called_once_with(self.config.pre_hook) 

self._test_no_executions_common() 

 

def test_no_hooks(self): 

self.config.pre_hook = None 

self.config.verb = "renew" 

os.remove(self.dir_hook) 

 

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

mock_execute = self._call_with_mock_execute(self.config) 

self.assertFalse(mock_execute.called) 

self.assertFalse(mock_logger.info.called) 

 

def test_renew_disabled_dir_hooks(self): 

self.config.directory_hooks = False 

mock_execute = self._call_with_mock_execute(self.config) 

mock_execute.assert_called_once_with(self.config.pre_hook) 

self._test_no_executions_common() 

 

def test_renew_no_overlap(self): 

self.config.verb = "renew" 

mock_execute = self._call_with_mock_execute(self.config) 

mock_execute.assert_any_call(self.dir_hook) 

mock_execute.assert_called_with(self.config.pre_hook) 

self._test_no_executions_common() 

 

def test_renew_with_overlap(self): 

self.config.pre_hook = self.dir_hook 

self.config.verb = "renew" 

mock_execute = self._call_with_mock_execute(self.config) 

mock_execute.assert_called_once_with(self.dir_hook) 

self._test_no_executions_common() 

 

def _test_no_executions_common(self): 

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

mock_execute = self._call_with_mock_execute(self.config) 

self.assertFalse(mock_execute.called) 

self.assertTrue(mock_logger.info.called) 

 

 

class PostHookTest(HookTest): 

"""Tests for certbot.hooks.post_hook.""" 

 

@classmethod 

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

from certbot.hooks import post_hook 

return post_hook(*args, **kwargs) 

 

def setUp(self): 

super(PostHookTest, self).setUp() 

 

self.config.post_hook = "bar" 

os.makedirs(self.config.renewal_post_hooks_dir) 

self.dir_hook = os.path.join(self.config.renewal_post_hooks_dir, "foo") 

create_hook(self.dir_hook) 

 

# Reset this value as it may have been modified by past tests 

self._reset_post_hook_eventually() 

 

def tearDown(self): 

# Reset this value so it's unmodified for future tests 

self._reset_post_hook_eventually() 

super(PostHookTest, self).tearDown() 

 

def _reset_post_hook_eventually(self): 

from certbot.hooks import post_hooks 

del post_hooks[:] 

 

def test_certonly_and_run_with_hook(self): 

for verb in ("certonly", "run",): 

self.config.verb = verb 

mock_execute = self._call_with_mock_execute(self.config) 

mock_execute.assert_called_once_with(self.config.post_hook) 

self.assertFalse(self._get_eventually()) 

 

def test_cert_only_and_run_without_hook(self): 

self.config.post_hook = None 

for verb in ("certonly", "run",): 

self.config.verb = verb 

self.assertFalse(self._call_with_mock_execute(self.config).called) 

self.assertFalse(self._get_eventually()) 

 

def test_renew_disabled_dir_hooks(self): 

self.config.directory_hooks = False 

self._test_renew_common([self.config.post_hook]) 

 

def test_renew_no_config_hook(self): 

self.config.post_hook = None 

self._test_renew_common([self.dir_hook]) 

 

def test_renew_no_dir_hook(self): 

os.remove(self.dir_hook) 

self._test_renew_common([self.config.post_hook]) 

 

def test_renew_no_hooks(self): 

self.config.post_hook = None 

os.remove(self.dir_hook) 

self._test_renew_common([]) 

 

def test_renew_no_overlap(self): 

expected = [self.dir_hook, self.config.post_hook] 

self._test_renew_common(expected) 

 

self.config.post_hook = "baz" 

expected.append(self.config.post_hook) 

self._test_renew_common(expected) 

 

def test_renew_with_overlap(self): 

self.config.post_hook = self.dir_hook 

self._test_renew_common([self.dir_hook]) 

 

def _test_renew_common(self, expected): 

self.config.verb = "renew" 

 

for _ in range(2): 

self._call(self.config) 

self.assertEqual(self._get_eventually(), expected) 

 

def _get_eventually(self): 

from certbot.hooks import post_hooks 

return post_hooks 

 

 

class RunSavedPostHooksTest(HookTest): 

"""Tests for certbot.hooks.run_saved_post_hooks.""" 

 

@classmethod 

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

from certbot.hooks import run_saved_post_hooks 

return run_saved_post_hooks() 

 

def _call_with_mock_execute_and_eventually(self, *args, **kwargs): 

"""Call run_saved_post_hooks but mock out execute and eventually 

 

certbot.hooks.post_hooks is replaced with 

self.eventually. The mock execute object is returned rather than 

the return value of run_saved_post_hooks. 

 

""" 

eventually_path = "certbot.hooks.post_hooks" 

with mock.patch(eventually_path, new=self.eventually): 

return self._call_with_mock_execute(*args, **kwargs) 

 

def setUp(self): 

super(RunSavedPostHooksTest, self).setUp() 

self.eventually = [] # type: List[str] 

 

def test_empty(self): 

self.assertFalse(self._call_with_mock_execute_and_eventually().called) 

 

def test_multiple(self): 

self.eventually = ["foo", "bar", "baz", "qux"] 

mock_execute = self._call_with_mock_execute_and_eventually() 

 

calls = mock_execute.call_args_list 

for actual_call, expected_arg in zip(calls, self.eventually): 

self.assertEqual(actual_call[0][0], expected_arg) 

 

def test_single(self): 

self.eventually = ["foo"] 

mock_execute = self._call_with_mock_execute_and_eventually() 

mock_execute.assert_called_once_with(self.eventually[0]) 

 

 

class RenewalHookTest(HookTest): 

"""Common base class for testing deploy/renew hooks.""" 

# Needed for https://github.com/PyCQA/pylint/issues/179 

# pylint: disable=abstract-method 

 

def _call_with_mock_execute(self, *args, **kwargs): 

"""Calls self._call after mocking out certbot.hooks.execute. 

 

The mock execute object is returned rather than the return value 

of self._call. The mock execute object asserts that environment 

variables were properly set. 

 

""" 

domains = kwargs["domains"] if "domains" in kwargs else args[1] 

lineage = kwargs["lineage"] if "lineage" in kwargs else args[2] 

 

def execute_side_effect(*unused_args, **unused_kwargs): 

"""Assert environment variables are properly set. 

 

:returns: two strings imitating no output from the hook 

:rtype: `tuple` of `str` 

 

""" 

self.assertEqual(os.environ["RENEWED_DOMAINS"], " ".join(domains)) 

self.assertEqual(os.environ["RENEWED_LINEAGE"], lineage) 

return ("", "") 

 

with mock.patch("certbot.hooks.execute") as mock_execute: 

mock_execute.side_effect = execute_side_effect 

self._call(*args, **kwargs) 

return mock_execute 

 

def setUp(self): 

super(RenewalHookTest, self).setUp() 

self.vars_to_clear = set( 

var for var in ("RENEWED_DOMAINS", "RENEWED_LINEAGE",) 

if var not in os.environ) 

 

def tearDown(self): 

for var in self.vars_to_clear: 

os.environ.pop(var, None) 

super(RenewalHookTest, self).tearDown() 

 

 

class DeployHookTest(RenewalHookTest): 

"""Tests for certbot.hooks.deploy_hook.""" 

 

@classmethod 

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

from certbot.hooks import deploy_hook 

return deploy_hook(*args, **kwargs) 

 

@mock.patch("certbot.hooks.logger") 

def test_dry_run(self, mock_logger): 

self.config.deploy_hook = "foo" 

self.config.dry_run = True 

mock_execute = self._call_with_mock_execute( 

self.config, ["example.org"], "/foo/bar") 

self.assertFalse(mock_execute.called) 

self.assertTrue(mock_logger.warning.called) 

 

@mock.patch("certbot.hooks.logger") 

def test_no_hook(self, mock_logger): 

self.config.deploy_hook = None 

mock_execute = self._call_with_mock_execute( 

self.config, ["example.org"], "/foo/bar") 

self.assertFalse(mock_execute.called) 

self.assertFalse(mock_logger.info.called) 

 

def test_success(self): 

domains = ["example.org", "example.net"] 

lineage = "/foo/bar" 

self.config.deploy_hook = "foo" 

mock_execute = self._call_with_mock_execute( 

self.config, domains, lineage) 

mock_execute.assert_called_once_with(self.config.deploy_hook) 

 

 

class RenewHookTest(RenewalHookTest): 

"""Tests for certbot.hooks.renew_hook""" 

 

@classmethod 

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

from certbot.hooks import renew_hook 

return renew_hook(*args, **kwargs) 

 

def setUp(self): 

super(RenewHookTest, self).setUp() 

self.config.renew_hook = "foo" 

 

os.makedirs(self.config.renewal_deploy_hooks_dir) 

self.dir_hook = os.path.join(self.config.renewal_deploy_hooks_dir, 

"bar") 

create_hook(self.dir_hook) 

 

def test_disabled_dir_hooks(self): 

self.config.directory_hooks = False 

mock_execute = self._call_with_mock_execute( 

self.config, ["example.org"], "/foo/bar") 

mock_execute.assert_called_once_with(self.config.renew_hook) 

 

@mock.patch("certbot.hooks.logger") 

def test_dry_run(self, mock_logger): 

self.config.dry_run = True 

mock_execute = self._call_with_mock_execute( 

self.config, ["example.org"], "/foo/bar") 

self.assertFalse(mock_execute.called) 

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

 

def test_no_hooks(self): 

self.config.renew_hook = None 

os.remove(self.dir_hook) 

 

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

mock_execute = self._call_with_mock_execute( 

self.config, ["example.org"], "/foo/bar") 

self.assertFalse(mock_execute.called) 

self.assertFalse(mock_logger.info.called) 

 

def test_overlap(self): 

self.config.renew_hook = self.dir_hook 

mock_execute = self._call_with_mock_execute( 

self.config, ["example.net", "example.org"], "/foo/bar") 

mock_execute.assert_called_once_with(self.dir_hook) 

 

def test_no_overlap(self): 

mock_execute = self._call_with_mock_execute( 

self.config, ["example.org"], "/foo/bar") 

mock_execute.assert_any_call(self.dir_hook) 

mock_execute.assert_called_with(self.config.renew_hook) 

 

 

class ExecuteTest(unittest.TestCase): 

"""Tests for certbot.hooks.execute.""" 

 

@classmethod 

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

from certbot.hooks import execute 

return execute(*args, **kwargs) 

 

def test_it(self): 

for returncode in range(0, 2): 

for stdout in ("", "Hello World!",): 

for stderr in ("", "Goodbye Cruel World!"): 

self._test_common(returncode, stdout, stderr) 

 

def _test_common(self, returncode, stdout, stderr): 

given_command = "foo" 

with mock.patch("certbot.hooks.Popen") as mock_popen: 

mock_popen.return_value.communicate.return_value = (stdout, stderr) 

mock_popen.return_value.returncode = returncode 

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

self.assertEqual(self._call(given_command), (stderr, stdout)) 

 

executed_command = mock_popen.call_args[1].get( 

"args", mock_popen.call_args[0][0]) 

self.assertEqual(executed_command, given_command) 

 

if stdout: 

self.assertTrue(mock_logger.info.called) 

if stderr or returncode: 

self.assertTrue(mock_logger.error.called) 

 

 

class ListHooksTest(util.TempDirTestCase): 

"""Tests for certbot.hooks.list_hooks.""" 

 

@classmethod 

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

from certbot.hooks import list_hooks 

return list_hooks(*args, **kwargs) 

 

def test_empty(self): 

self.assertFalse(self._call(self.tempdir)) 

 

def test_multiple(self): 

names = sorted( 

os.path.join(self.tempdir, basename) 

for basename in ("foo", "bar", "baz", "qux") 

) 

for name in names: 

create_hook(name) 

 

self.assertEqual(self._call(self.tempdir), names) 

 

def test_single(self): 

name = os.path.join(self.tempdir, "foo") 

create_hook(name) 

 

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

 

 

def create_hook(file_path): 

"""Creates an executable file at the specified path. 

 

:param str file_path: path to create the file at 

 

""" 

open(file_path, "w").close() 

os.chmod(file_path, os.stat(file_path).st_mode | stat.S_IXUSR) 

 

 

if __name__ == '__main__': 

unittest.main() # pragma: no cover