summaryrefslogtreecommitdiff
path: root/tests/test_build_htmlhelp.py
blob: 5a47ca580f58c2b55a67eb39a85a90aea7cf7dc6 (plain)
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
"""
    test_build_htmlhelp
    ~~~~~~~~~~~~~~~~~~~
    Test the HTML Help builder and check output against XPath.
    :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
    :license: BSD, see LICENSE for details.
"""

import os.path
import re
import sys
from subprocess import Popen, PIPE

import pytest

from sphinx.util.osutil import cd


@pytest.mark.skipif(sys.platform != "win32",
                    reason="hhc.exe only available on Windows.")
@pytest.mark.sphinx('htmlhelp', testroot='build-htmlhelp')
def test_chm():
    # run make.bat
    with cd(r".\roots\test-build-htmlhelp"):
        try:
            p = Popen(['make.bat'],
                      stdout=PIPE, stderr=PIPE)
        except:
            raise
        else:
            p.communicate()

    # check .hhk file
    this_path = os.path.dirname(os.path.abspath(__file__))
    hhk_file = os.path.join(this_path, 'roots', 'test-build-htmlhelp',
                            'build', 'htmlhelp', 'test.hhk')
    if not os.path.isfile(hhk_file):
        print(".chm build failed, please install HTML Help Workshop.")
        return

    with open(hhk_file, 'rb') as f:
        data = f.read()
    m = re.search(br'&#[xX][0-9a-fA-F]+;', data)
    assert m == None, 'Hex escaping exists in .hhk file: ' + str(m.group(0))