cppreference-doc/tests/test_preprocess.py at master · refack/cppreference-doc

History

489 lines (399 loc) · 18.5 KB

Raw

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

#!/usr/bin/env python3

# -*- coding: utf-8 -*-

# This file is part of cppreference-doc

# This program is free software: you can redistribute it and/or modify

# it under the terms of the GNU General Public License as published by

# the Free Software Foundation, either version 3 of the License, or

# (at your option) any later version.

# This program is distributed in the hope that it will be useful,

# but WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

# GNU General Public License for more details.

# You should have received a copy of the GNU General Public License

# along with this program. If not, see http://www.gnu.org/licenses/.

import contextlib

import io

import os

import sys

import unittest

import unittest.mock

from lxml import etree

from commands.preprocess import build_rename_map

from commands.preprocess import convert_loader_name

from commands.preprocess import has_class

from commands.preprocess import is_external_link

from commands.preprocess import is_ranges_placeholder

from commands.preprocess import remove_ads

from commands.preprocess import remove_fileinfo

from commands.preprocess import remove_google_analytics

from commands.preprocess import remove_noprint

from commands.preprocess import remove_see_also

from commands.preprocess import remove_unused_external

from commands.preprocess import rename_files

from commands.preprocess import transform_ranges_placeholder

from commands.preprocess import trasform_relative_link

class DummyFile(object):

def write(self, x):

pass

# From https://stackoverflow.com/a/2829036/1849769

@contextlib.contextmanager

def nostdout():

save_stdout = sys.stdout

sys.stdout = DummyFile()

yield

sys.stdout = save_stdout

class TestConvertLoaderName(unittest.TestCase):

def test_convert_loader_name(self):

url = 'http://en.cppreference.com/mwiki/load.php?debug=false&lang=en&modules=site&only=scripts&skin=cppreference2&*' # noqa

self.assertEqual('site_scripts.js', convert_loader_name(url))

url = 'http://en.cppreference.com/mwiki/load.php?debug=false&lang=en&modules=site&only=styles&skin=cppreference2&*' # noqa

self.assertEqual('site_modules.css', convert_loader_name(url))

url = 'http://en.cppreference.com/mwiki/load.php?debug=false&lang=en&modules=skins.cppreference2&only=scripts&skin=cppreference2&*' # noqa

self.assertEqual('skin_scripts.js', convert_loader_name(url))

url = 'http://en.cppreference.com/mwiki/load.php?debug=false&lang=en&modules=startup&only=scripts&skin=cppreference2&*' # noqa

self.assertEqual('startup_scripts.js', convert_loader_name(url))

url = 'http://en.cppreference.com/mwiki/load.php?debug=false&lang=en&modules=ext.gadget.ColiruCompiler%2CMathJax%7Cext.rtlcite%7Cmediawiki.legacy.commonPrint%2Cshared%7Cskins.cppreference2&only=styles&skin=cppreference2&*' # noqa

self.assertEqual('ext.css', convert_loader_name(url))

with self.assertRaises(Exception):

convert_loader_name('')

class TestHasClass(unittest.TestCase):

def test_has_class(self):

el = etree.Element('tag')

self.assertEqual(False, has_class(el))

self.assertEqual(False, has_class(el, ''))

self.assertEqual(False, has_class(el, 'a'))

self.assertEqual(False, has_class(el, 'tag'))

el.set('class', '')

self.assertEqual(False, has_class(el, ))

self.assertEqual(False, has_class(el, ''))

self.assertEqual(False, has_class(el, 'a'))

self.assertEqual(False, has_class(el, 'tag'))

el.set('class', 'a')

self.assertEqual(False, has_class(el, ))

self.assertEqual(False, has_class(el, ''))

self.assertEqual(True, has_class(el, 'a'))

self.assertEqual(False, has_class(el, 'b'))

self.assertEqual(False, has_class(el, 'tag'))

self.assertEqual(True, has_class(el, 'a', 'b'))

self.assertEqual(True, has_class(el, 'b', 'a'))

self.assertEqual(False, has_class(el, 'b', 'c'))

el.set('class', 'a b')

self.assertEqual(False, has_class(el, ))

self.assertEqual(False, has_class(el, ''))

self.assertEqual(True, has_class(el, 'a'))

self.assertEqual(True, has_class(el, 'b'))

self.assertEqual(False, has_class(el, 'tag'))

self.assertEqual(True, has_class(el, 'a', 'b'))

self.assertEqual(True, has_class(el, 'b', 'a'))

self.assertEqual(True, has_class(el, 'b', 'c'))

el.set('class', 'a b')

self.assertEqual(False, has_class(el, ))

self.assertEqual(False, has_class(el, ''))

self.assertEqual(True, has_class(el, 'a'))

self.assertEqual(True, has_class(el, 'b'))

self.assertEqual(False, has_class(el, 'tag'))

self.assertEqual(True, has_class(el, 'a', 'b'))

self.assertEqual(True, has_class(el, 'b', 'a'))

self.assertEqual(True, has_class(el, 'b', 'c'))

class TestIsExternalLink(unittest.TestCase):

def test_is_external_link(self):

external = [

'http://example.com',

'https://example.com',

'ftp://example.com',

'ftps://example.com',

'slack://example.com',

'https:///foo.html', # Not technically external,

# but we say so anyway

'//example.com'

]

for link in external:

self.assertTrue(is_external_link(link),

msg="Should be external: {}".format(link))

relative = [

'/example.com',

'../foo.html',

'foo.html',

'foo'

]

for link in relative:

self.assertFalse(is_external_link(link),

msg="Should not be external: {}".format(link))

class TestPlaceholderLinks(unittest.TestCase):

# Placeholder link replacement is implemented in the MediaWiki site JS at

# https://en.cppreference.com/w/MediaWiki:Common.js

def test_is_ranges_placeholder(self):

match = [

'http://en.cppreference.com/w/cpp/ranges-placeholder/concepts/Assignable', # noqa

'http://en.cppreference.com/w/cpp/ranges-placeholder/iterator/Incrementable', # noqa

'http://en.cppreference.com/w/cpp/ranges-algorithm-placeholder/all_any_none_of', # noqa

'http://en.cppreference.com/w/cpp/ranges-iterator-placeholder/dangling', # noqa

'http://en.cppreference.com/w/cpp/ranges-utility-placeholder/swap', # noqa

]

for target in match:

self.assertTrue(is_ranges_placeholder(target),

msg="Should match '{}'".format(target))

target = target.replace("http://", "https://")

self.assertTrue(is_ranges_placeholder(target),

msg="Should match '{}'".format(target))

nomatch = [

'http://en.cppreference.com/w/cpp/ranges--placeholder/swap',

'https://en.cppreference.com/w/cpp/ranges--placeholder/swap',

'http://www.mediawiki.org/',

'http://en.cppreference.com/w/Cppreference:About',

'http://en.wikipedia.org/wiki/Normal_distribution',

'https://www.mediawiki.org/',

'https://en.cppreference.com/w/Cppreference:About',

'https://en.wikipedia.org/wiki/Normal_distribution',

'w/cpp.html',

'w/cpp/language/expressions.html',

'../utility/functional/is_placeholder.html',

'utility/functional/placeholders.html',

'w/cpp/experimental/ranges.html',

]

for target in nomatch:

self.assertFalse(is_ranges_placeholder(target),

msg="Should not match '{}'".format(target))

def test_transform_ranges_placeholder(self):

entries = [

# (target, file, expected)

('http://en.cppreference.com/w/cpp/ranges-placeholder/concepts/Assignable', # noqa

'output/reference/en/cpp/concepts/ConvertibleTo.html',

'Assignable.html'),

('http://en.cppreference.com/w/cpp/ranges-placeholder/concepts/Assignable', # noqa

'output/reference/en/cpp/concepts/long/path/ConvertibleTo.html',

'../../Assignable.html'),

('http://en.cppreference.com/w/cpp/ranges-placeholder/concepts/Assignable', # noqa

'output/reference/en/cpp/other/path/ConvertibleTo.html',

'../../concepts/Assignable.html'),

('http://en.cppreference.com/w/cpp/ranges-algorithm-placeholder/all_any_none_of', # noqa

'output/reference/en/cpp/concepts/ConvertibleTo.html',

'../algorithm/ranges/all_any_none_of.html'),

('http://en.cppreference.com/w/cpp/ranges-algorithm-placeholder/all_any_none_of', # noqa

'output/reference/en/cpp/algorithm/ConvertibleTo.html',

'ranges/all_any_none_of.html'),

('http://en.cppreference.com/w/cpp/ranges-placeholder/concepts/Assignable', # noqa

'output/reference/en/cpp/experimental/ranges/concepts/View.html',

'Assignable.html'),

('http://en.cppreference.com/w/cpp/ranges-placeholder/concepts/Assignable', # noqa

'output/reference/en/cpp/experimental/ranges/View.html',

'concepts/Assignable.html'),

('http://en.cppreference.com/w/cpp/ranges-placeholder/concepts/Assignable', # noqa

'output/reference/en/cpp/experimental/ranges/range/View.html',

'../concepts/Assignable.html'),

('http://en.cppreference.com/w/cpp/ranges-algorithm-placeholder/all_any_none_of', # noqa

'output/reference/en/cpp/experimental/ranges/View.html',

'algorithm/all_any_none_of.html'),

('http://en.cppreference.com/w/cpp/ranges-algorithm-placeholder/all_any_none_of', # noqa

'output/reference/en/cpp/experimental/ranges/range/View.html',

'../algorithm/all_any_none_of.html'),

]

def msg(target, file, root):

return "target='{}', file='{}', root='{}'".format(

target, file, root)

# transform_ranges_placeholder(target, file, root)

# target: the placeholder link

# file: path of the file that contains the link

# root: path to the site root (where '/' should link to)

root = "output/reference"

for target, file, expected in entries:

res = transform_ranges_placeholder(target, file, root)

self.assertEqual(expected, res,

msg=msg(target, file, root))

target = target.replace('http://', 'https://')

res = transform_ranges_placeholder(target, file, root)

self.assertEqual(expected, res,

msg=msg(target, file, root))

class TestPreprocessHtml(unittest.TestCase):

def setUp(self):

self.testdata = os.path.join(os.path.dirname(__file__),

'preprocess_data')

infile = os.path.join(self.testdata, "fabs.html")

self.parser = etree.HTMLParser(encoding='utf-8')

self.html = etree.parse(infile, self.parser)

# Check whether the HTML matches the contents of the specified test data

# file

def check_output(self, expected_file):

with open(os.path.join(self.testdata, expected_file), 'rb') as f:

expected = f.read()

with io.BytesIO() as buf:

self.html.write(buf, encoding='utf-8', method='html')

actual = buf.getvalue()

self.assertEqual(expected, actual)

def test_remove_noprint(self):

remove_noprint(self.html)

self.check_output("fabs_noprint.html")

def test_remove_see_also(self):

remove_see_also(self.html)

self.check_output("fabs_seealso.html")

def test_remove_google_analytics(self):

remove_google_analytics(self.html)

self.check_output("fabs_ga.html")

def test_remove_ads(self):

remove_ads(self.html)

self.check_output("fabs_ads.html")

def test_remove_fileinfo(self):

remove_fileinfo(self.html)

self.check_output("fabs_fileinfo.html")

def test_remove_unused_external(self):

remove_unused_external(self.html)

self.check_output("fabs_external.html")

class TestFileRename(unittest.TestCase):

def make_rename_map(self, root):

def p(*dirs):

return os.path.join(root, 'dir1', *dirs)

return {

'invalid*.txt': 'invalid_star_.txt',

'confl"ict".html': 'confl_q_ict_q_.html',

'Confl"ict".html': 'Confl_q_ict_q_.html',

'load.php?modules=site&only=scripts': 'site_scripts.js',

'load.php?modules=someext&only=styles': 'ext.css',

p('sub2', 'Conflict.html'): 'Conflict.2.html',

p('sub3', 'Confl_q_ict_q_.html'): 'Confl_q_ict_q_.2.html',

p('sub4', 'Conflict'): 'Conflict.2',

p('sub4', 'conFlict'): 'conFlict.3',

p('sub5', 'Conflict'): 'Conflict.2'

}

def make_walk_result(self, root):

def p(*dirs):

return os.path.join(root, 'dir1', *dirs)

return [

# Nothing to do

(p(),

('sub1', 'sub2', 'sub3', 'sub4', 'sub5', 'sub6'),

('f1', 'f2')),

# Unwanted characters

(p('sub1'),

(),

('invalid*.txt', 'valid.txt')),

# Case conflict

(p('sub2'),

(),

('conflict.html', 'Conflict.html')),

# Unwanted characters + case conflict

(p('sub3'),

(),

('confl"ict".html', 'Confl"ict".html')),

# Multiple case conflicts, no extension

(p('sub4'),

(),

('conflict', 'Conflict', 'conFlict')),

# Case conflict in second directory

(p('sub5'),

(),

('conflict', 'Conflict')),

# Loader links

(p('sub6'),

(),

('load.php?modules=site&only=scripts',

'load.php?modules=someext&only=styles'))

]

def test_build_rename_map(self):

with unittest.mock.patch('os.walk') as walk:

walk.return_value = self.make_walk_result('output')

actual = build_rename_map('output')

expected = self.make_rename_map('output')

self.assertEqual(expected, actual)

def test_rename_files(self):

expected = [

(('output/dir1/sub1/invalid*.txt',

'output/dir1/sub1/invalid_star_.txt'), {}),

(('output/dir1/sub2/Conflict.html',

'output/dir1/sub2/Conflict.2.html'), {}),

(('output/dir1/sub3/confl"ict".html',

'output/dir1/sub3/confl_q_ict_q_.html'), {}),

(('output/dir1/sub3/Confl"ict".html',

'output/dir1/sub3/Confl_q_ict_q_.2.html'), {}),

(('output/dir1/sub4/Conflict',

'output/dir1/sub4/Conflict.2'), {}),

(('output/dir1/sub4/conFlict',

'output/dir1/sub4/conFlict.3'), {}),

(('output/dir1/sub5/Conflict',

'output/dir1/sub5/Conflict.2'), {}),

(('output/dir1/sub6/load.php?modules=site&only=scripts',

'output/dir1/sub6/site_scripts.js'), {}),

(('output/dir1/sub6/load.php?modules=someext&only=styles',

'output/dir1/sub6/ext.css'), {})

]

actual = []

def record_call(*args, **kwargs):

actual.append((args, kwargs))

with unittest.mock.patch('os.walk') as walk, \

unittest.mock.patch('shutil.move') as move:

walk.return_value = self.make_walk_result('output')

move.side_effect = record_call

with nostdout():

rename_files('output', self.make_rename_map('output'))

self.assertEqual(expected, actual,

msg="Unexpected sequence of calls to shutil.move")

def test_transform_relative_link(self):

entries = [

# (file, target, expected)

('output/dir1/sub2/conflict.html',

'../f1',

'../f1'),

('output/dir1/sub2/Conflict.html',

'../f1',

'../f1'),

('output/dir1/sub2/Conflict.html',

'../f1#p2',

'../f1#p2'),

('output/dir1/sub2/Conflict.html',

'../f1?some=param',

'../f1'),

('output/dir1/sub2/Conflict.html',

'../f1?some=param#p2',

'../f1#p2'),

('output/dir1/sub2/Conflict.html',

'../mwiki/site.css',

'../common/site.css'),

('output/dir1/sub2/Conflict.html',

'../../upload.cppreference.com/mwiki/site.css',

'../common/site.css'),

('output/dir1/f2',

'sub1/invalid*.txt',

'sub1/invalid_star_.txt'),

('output/dir1/sub0/other.html',

'../sub1/invalid*.txt',

'../sub1/invalid_star_.txt'),