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

"""Tests for certbot.log.""" 

import logging 

import logging.handlers 

import os 

import sys 

import time 

import unittest 

 

import mock 

import six 

 

from acme import messages 

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

 

from certbot import compat 

from certbot import constants 

from certbot import errors 

from certbot import util 

from certbot.tests import util as test_util 

 

 

class PreArgParseSetupTest(unittest.TestCase): 

"""Tests for certbot.log.pre_arg_parse_setup.""" 

 

@classmethod 

def _call(cls, *args, **kwargs): # pylint: disable=unused-argument 

from certbot.log import pre_arg_parse_setup 

return pre_arg_parse_setup() 

 

@mock.patch('certbot.log.sys') 

@mock.patch('certbot.log.pre_arg_parse_except_hook') 

@mock.patch('certbot.log.logging.getLogger') 

@mock.patch('certbot.log.util.atexit_register') 

def test_it(self, mock_register, mock_get, mock_except_hook, mock_sys): 

mock_sys.argv = ['--debug'] 

mock_sys.version_info = sys.version_info 

self._call() 

 

mock_root_logger = mock_get() 

mock_root_logger.setLevel.assert_called_once_with(logging.DEBUG) 

self.assertEqual(mock_root_logger.addHandler.call_count, 2) 

 

memory_handler = None # type: Optional[logging.handlers.MemoryHandler] 

for call in mock_root_logger.addHandler.call_args_list: 

handler = call[0][0] 

if memory_handler is None and isinstance(handler, logging.handlers.MemoryHandler): 

memory_handler = handler 

target = memory_handler.target # type: ignore 

else: 

self.assertTrue(isinstance(handler, logging.StreamHandler)) 

self.assertTrue( 

isinstance(target, logging.StreamHandler)) 

 

mock_register.assert_called_once_with(logging.shutdown) 

mock_sys.excepthook(1, 2, 3) 

mock_except_hook.assert_called_once_with( 

memory_handler, 1, 2, 3, debug=True, log_path=mock.ANY) 

 

 

class PostArgParseSetupTest(test_util.ConfigTestCase): 

"""Tests for certbot.log.post_arg_parse_setup.""" 

 

@classmethod 

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

from certbot.log import post_arg_parse_setup 

return post_arg_parse_setup(*args, **kwargs) 

 

def setUp(self): 

super(PostArgParseSetupTest, self).setUp() 

self.config.debug = False 

self.config.max_log_backups = 1000 

self.config.quiet = False 

self.config.verbose_count = constants.CLI_DEFAULTS['verbose_count'] 

self.devnull = open(os.devnull, 'w') 

 

from certbot.log import ColoredStreamHandler 

self.stream_handler = ColoredStreamHandler(six.StringIO()) 

from certbot.log import MemoryHandler, TempHandler 

self.temp_handler = TempHandler() 

self.temp_path = self.temp_handler.path 

self.memory_handler = MemoryHandler(self.temp_handler) 

self.root_logger = mock.MagicMock( 

handlers=[self.memory_handler, self.stream_handler]) 

 

def tearDown(self): 

self.memory_handler.close() 

self.stream_handler.close() 

self.temp_handler.close() 

self.devnull.close() 

super(PostArgParseSetupTest, self).tearDown() 

 

def test_common(self): 

with mock.patch('certbot.log.logging.getLogger') as mock_get_logger: 

mock_get_logger.return_value = self.root_logger 

except_hook_path = 'certbot.log.post_arg_parse_except_hook' 

with mock.patch(except_hook_path) as mock_except_hook: 

with mock.patch('certbot.log.sys') as mock_sys: 

mock_sys.version_info = sys.version_info 

self._call(self.config) 

 

self.root_logger.removeHandler.assert_called_once_with( 

self.memory_handler) 

self.assertTrue(self.root_logger.addHandler.called) 

self.assertTrue(os.path.exists(os.path.join( 

self.config.logs_dir, 'letsencrypt.log'))) 

self.assertFalse(os.path.exists(self.temp_path)) 

mock_sys.excepthook(1, 2, 3) 

mock_except_hook.assert_called_once_with( 

1, 2, 3, debug=self.config.debug, log_path=self.config.logs_dir) 

 

level = self.stream_handler.level 

if self.config.quiet: 

self.assertEqual(level, constants.QUIET_LOGGING_LEVEL) 

else: 

self.assertEqual(level, -self.config.verbose_count * 10) 

 

def test_debug(self): 

self.config.debug = True 

self.test_common() 

 

def test_quiet(self): 

self.config.quiet = True 

self.test_common() 

 

 

class SetupLogFileHandlerTest(test_util.ConfigTestCase): 

"""Tests for certbot.log.setup_log_file_handler.""" 

 

@classmethod 

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

from certbot.log import setup_log_file_handler 

return setup_log_file_handler(*args, **kwargs) 

 

def setUp(self): 

super(SetupLogFileHandlerTest, self).setUp() 

self.config.max_log_backups = 42 

 

@mock.patch('certbot.main.logging.handlers.RotatingFileHandler') 

def test_failure(self, mock_handler): 

mock_handler.side_effect = IOError 

 

try: 

self._call(self.config, 'test.log', '%(message)s') 

except errors.Error as err: 

self.assertTrue('--logs-dir' in str(err)) 

else: # pragma: no cover 

self.fail('Error not raised.') 

 

def test_success_with_rollover(self): 

self._test_success_common(should_rollover=True) 

 

def test_success_without_rollover(self): 

self.config.max_log_backups = 0 

self._test_success_common(should_rollover=False) 

 

def _test_success_common(self, should_rollover): 

log_file = 'test.log' 

handler, log_path = self._call(self.config, log_file, '%(message)s') 

handler.close() 

 

self.assertEqual(handler.level, logging.DEBUG) 

self.assertEqual(handler.formatter.converter, time.localtime) 

 

expected_path = os.path.join(self.config.logs_dir, log_file) 

self.assertEqual(log_path, expected_path) 

 

backup_path = os.path.join(self.config.logs_dir, log_file + '.1') 

self.assertEqual(os.path.exists(backup_path), should_rollover) 

 

@mock.patch('certbot.log.logging.handlers.RotatingFileHandler') 

def test_max_log_backups_used(self, mock_handler): 

self._call(self.config, 'test.log', '%(message)s') 

backup_count = mock_handler.call_args[1]['backupCount'] 

self.assertEqual(self.config.max_log_backups, backup_count) 

 

 

class ColoredStreamHandlerTest(unittest.TestCase): 

"""Tests for certbot.log.ColoredStreamHandler""" 

 

def setUp(self): 

self.stream = six.StringIO() 

self.stream.isatty = lambda: True 

self.logger = logging.getLogger() 

self.logger.setLevel(logging.DEBUG) 

 

from certbot.log import ColoredStreamHandler 

self.handler = ColoredStreamHandler(self.stream) 

self.logger.addHandler(self.handler) 

 

def tearDown(self): 

self.handler.close() 

 

def test_format(self): 

msg = 'I did a thing' 

self.logger.debug(msg) 

self.assertEqual(self.stream.getvalue(), '{0}\n'.format(msg)) 

 

def test_format_and_red_level(self): 

msg = 'I did another thing' 

self.handler.red_level = logging.DEBUG 

self.logger.debug(msg) 

 

self.assertEqual(self.stream.getvalue(), 

'{0}{1}{2}\n'.format(util.ANSI_SGR_RED, 

msg, 

util.ANSI_SGR_RESET)) 

 

 

class MemoryHandlerTest(unittest.TestCase): 

"""Tests for certbot.log.MemoryHandler""" 

def setUp(self): 

self.logger = logging.getLogger(__name__) 

self.logger.setLevel(logging.DEBUG) 

self.msg = 'hi there' 

self.stream = six.StringIO() 

 

self.stream_handler = logging.StreamHandler(self.stream) 

from certbot.log import MemoryHandler 

self.handler = MemoryHandler(self.stream_handler) 

self.logger.addHandler(self.handler) 

 

def tearDown(self): 

self.handler.close() 

self.stream_handler.close() 

 

def test_flush(self): 

self._test_log_debug() 

self.handler.flush(force=True) 

self.assertEqual(self.stream.getvalue(), self.msg + '\n') 

 

def test_not_flushed(self): 

# By default, logging.ERROR messages and higher are flushed 

self.logger.critical(self.msg) 

self.handler.flush() 

self.assertEqual(self.stream.getvalue(), '') 

 

def test_target_reset(self): 

self._test_log_debug() 

 

new_stream = six.StringIO() 

new_stream_handler = logging.StreamHandler(new_stream) 

self.handler.setTarget(new_stream_handler) 

self.handler.flush(force=True) 

self.assertEqual(self.stream.getvalue(), '') 

self.assertEqual(new_stream.getvalue(), self.msg + '\n') 

new_stream_handler.close() 

 

def _test_log_debug(self): 

self.logger.debug(self.msg) 

 

 

class TempHandlerTest(unittest.TestCase): 

"""Tests for certbot.log.TempHandler.""" 

def setUp(self): 

self.closed = False 

from certbot.log import TempHandler 

self.handler = TempHandler() 

 

def tearDown(self): 

self.handler.close() 

 

def test_permissions(self): 

self.assertTrue( 

util.check_permissions(self.handler.path, 0o600, compat.os_geteuid())) 

 

def test_delete(self): 

self.handler.close() 

self.assertFalse(os.path.exists(self.handler.path)) 

 

def test_no_delete(self): 

self.handler.emit(mock.MagicMock()) 

self.handler.close() 

self.assertTrue(os.path.exists(self.handler.path)) 

os.remove(self.handler.path) 

 

 

class PreArgParseExceptHookTest(unittest.TestCase): 

"""Tests for certbot.log.pre_arg_parse_except_hook.""" 

@classmethod 

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

from certbot.log import pre_arg_parse_except_hook 

return pre_arg_parse_except_hook(*args, **kwargs) 

 

@mock.patch('certbot.log.post_arg_parse_except_hook') 

def test_it(self, mock_post_arg_parse_except_hook): 

# pylint: disable=star-args 

memory_handler = mock.MagicMock() 

args = ('some', 'args',) 

kwargs = {'some': 'kwargs'} 

 

self._call(memory_handler, *args, **kwargs) 

 

mock_post_arg_parse_except_hook.assert_called_once_with( 

*args, **kwargs) 

memory_handler.flush.assert_called_once_with(force=True) 

 

 

class PostArgParseExceptHookTest(unittest.TestCase): 

"""Tests for certbot.log.post_arg_parse_except_hook.""" 

@classmethod 

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

from certbot.log import post_arg_parse_except_hook 

return post_arg_parse_except_hook(*args, **kwargs) 

 

def setUp(self): 

self.error_msg = 'test error message' 

self.log_path = 'foo.log' 

 

def test_base_exception(self): 

exc_type = KeyboardInterrupt 

mock_logger, output = self._test_common(exc_type, debug=False) 

self._assert_exception_logged(mock_logger.error, exc_type) 

self._assert_logfile_output(output) 

 

def test_debug(self): 

exc_type = ValueError 

mock_logger, output = self._test_common(exc_type, debug=True) 

self._assert_exception_logged(mock_logger.error, exc_type) 

self._assert_logfile_output(output) 

 

def test_custom_error(self): 

exc_type = errors.PluginError 

mock_logger, output = self._test_common(exc_type, debug=False) 

self._assert_exception_logged(mock_logger.debug, exc_type) 

self._assert_quiet_output(mock_logger, output) 

 

def test_acme_error(self): 

# Get an arbitrary error code 

acme_code = next(six.iterkeys(messages.ERROR_CODES)) 

 

def get_acme_error(msg): 

"""Wraps ACME errors so the constructor takes only a msg.""" 

return messages.Error.with_code(acme_code, detail=msg) 

 

mock_logger, output = self._test_common(get_acme_error, debug=False) 

self._assert_exception_logged(mock_logger.debug, messages.Error) 

self._assert_quiet_output(mock_logger, output) 

self.assertFalse(messages.ERROR_PREFIX in output) 

 

def test_other_error(self): 

exc_type = ValueError 

mock_logger, output = self._test_common(exc_type, debug=False) 

self._assert_exception_logged(mock_logger.debug, exc_type) 

self._assert_quiet_output(mock_logger, output) 

 

def _test_common(self, error_type, debug): 

"""Returns the mocked logger and stderr output.""" 

mock_err = six.StringIO() 

 

def write_err(*args, **unused_kwargs): 

"""Write error to mock_err.""" 

mock_err.write(args[0]) 

 

try: 

raise error_type(self.error_msg) 

except BaseException: 

exc_info = sys.exc_info() 

with mock.patch('certbot.log.logger') as mock_logger: 

mock_logger.error.side_effect = write_err 

with mock.patch('certbot.log.sys.stderr', mock_err): 

try: 

# pylint: disable=star-args 

self._call( 

*exc_info, debug=debug, log_path=self.log_path) 

except SystemExit as exit_err: 

mock_err.write(str(exit_err)) 

else: # pragma: no cover 

self.fail('SystemExit not raised.') 

 

output = mock_err.getvalue() 

return mock_logger, output 

 

def _assert_exception_logged(self, log_func, exc_type): 

self.assertTrue(log_func.called) 

call_kwargs = log_func.call_args[1] 

self.assertTrue('exc_info' in call_kwargs) 

 

actual_exc_info = call_kwargs['exc_info'] 

expected_exc_info = (exc_type, mock.ANY, mock.ANY) 

self.assertEqual(actual_exc_info, expected_exc_info) 

 

def _assert_logfile_output(self, output): 

self.assertTrue('Please see the logfile' in output) 

self.assertTrue(self.log_path in output) 

 

def _assert_quiet_output(self, mock_logger, output): 

self.assertFalse(mock_logger.exception.called) 

self.assertTrue(mock_logger.debug.called) 

self.assertTrue(self.error_msg in output) 

 

 

class ExitWithLogPathTest(test_util.TempDirTestCase): 

"""Tests for certbot.log.exit_with_log_path.""" 

@classmethod 

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

from certbot.log import exit_with_log_path 

return exit_with_log_path(*args, **kwargs) 

 

def test_log_file(self): 

log_file = os.path.join(self.tempdir, 'test.log') 

open(log_file, 'w').close() 

 

err_str = self._test_common(log_file) 

self.assertTrue('logfiles' not in err_str) 

self.assertTrue(log_file in err_str) 

 

def test_log_dir(self): 

err_str = self._test_common(self.tempdir) 

self.assertTrue('logfiles' in err_str) 

self.assertTrue(self.tempdir in err_str) 

 

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

try: 

self._call(*args, **kwargs) 

except SystemExit as err: 

return str(err) 

else: # pragma: no cover 

self.fail('SystemExit was not raised.') 

 

 

if __name__ == "__main__": 

unittest.main() # pragma: no cover