Source code
Revision control
Copy as Markdown
Other Tools
#!/usr/bin/env python3
# Usage: python3 generate.py
#
# This will remove all existing .html files in the generated directories and generate new tests.
# Notes on potential confusion with the 3 string substitution features in different layers:
#
# - In Python strings when calling .format(): {something} or {}
# To get a literal {} use {{}}.
# The template_* variables are ones below are those that will use .format().
# - JS template literals: ${something}
# - wptserve server-side substitution when generating a response: {{GET[something]}}
import os, shutil
target_dir = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) + "/generated"
delay = u'1500' # Lower value makes the test complete faster, but also higher risk of flaky results
# Test data
tentative_tests = [
# title,
# encoding,
# template_testcase_markup,
# template_nonspeculative_testcase_markup (if different from template_testcase_markup),
# expect_load,
# test_nonspeculative
(
u'script-src',
u'utf-8',
u'<script src="{}"></script>',
None,
u'true',
u'true'
),
(
u'meta-charset-script-src',
None,
u'<meta charset=windows-1254><script src="{}"></script>',
u'<!-- no meta charset --><script src="{}"></script>',
u'true',
u'true'
),
(
# This test is only valid on "mobile" where meta viewport has an effect
u'meta-viewport-link-stylesheet-media',
u'utf-8',
u'<meta name=viewport content="width=400, initial-scale=1"><link rel=stylesheet href="{}" media="(min-width: 401px)">',
None,
u'false',
u'true'
),
(
u'meta-csp-img-src-none',
u'utf-8',
u'<meta http-equiv="Content-Security-Policy" content="script-src \'self\' \'unsafe-inline\'; img-src \'none\'"><img src="{}">',
None,
u'false',
u'true'
),
(
u'meta-csp-img-src-asterisk',
u'utf-8',
u'<meta http-equiv="Content-Security-Policy" content="script-src \'self\' \'unsafe-inline\'; img-src *"><img src="{}">',
None,
u'true',
u'true'
),
(
u'meta-referrer-no-referrer-img-src',
u'utf-8',
u'<meta name=referrer content=no-referrer><img src="{}">',
None,
u'true',
u'true'
),
(
u'base-href-script-src',
u'utf-8',
u'<base href=//{{{{domains[www1]}}}}:{{{{ports[http][0]}}}}><script src="{}"></script>',
None,
u'true',
u'true'
),
(
u'script-src-unsupported-type',
u'utf-8',
u'<script src="{}" type=text/plain></script>',
None,
u'false',
u'true'
),
(
u'script-src-type-application-ecmascript',
u'utf-8',
u'<script src="{}" type=application/ecmascript></script>',
None,
u'true',
u'true'
),
(
u'script-src-nomodule',
u'utf-8',
u'<script src="{}" nomodule></script>',
None,
u'false',
u'true'
),
(
u'script-src-module',
u'utf-8',
u'<script src="{}" type=module></script>',
None,
u'true',
u'true'
),
(
u'script-src-async',
u'utf-8',
u'<script src="{}" async></script>',
None,
u'true',
u'true'
),
(
u'script-src-defer',
u'utf-8',
u'<script src="{}" defer></script>',
None,
u'true',
u'true'
),
(
u'script-src-crossorigin',
u'utf-8',
u'<script src="{}" crossorigin></script>',
None,
u'true',
u'true'
),
(
u'script-src-integrity',
u'utf-8',
u'<script src="{}" integrity="sha384-OLBgp1GsljhM2TJ+sbHjaiH9txEUvgdDTAzHv2P24donTt6/529l+9Ua0vFImLlb"></script>',
None,
u'true',
u'true'
),
(
u'script-src-referrerpolicy-no-referrer',
u'utf-8',
u'<script src="{}" referrerpolicy=no-referrer></script>',
None,
u'true',
u'true'
),
(
u'template-script-src',
u'utf-8',
u'<template><script src="{}"></script></template>',
None,
u'false',
u'true'
),
(
u'template-link-stylesheet',
u'utf-8',
u'<template><link rel=stylesheet href="{}"></template>',
None,
u'false',
u'true'
),
(
u'template-img-src',
u'utf-8',
u'<template><img src="{}"></template>',
None,
u'false',
u'true'
),
(
u'template-shadowrootmode-script-src',
u'utf-8',
u'<div><template shadowrootmode="closed"><script src="{}"></script></template></div>',
None,
u'true',
u'true'
),
(
u'template-shadowrootmode-link-stylesheet',
u'utf-8',
u'<div><template shadowrootmode="closed"><link rel=stylesheet href="{}"></template></div>',
None,
u'true',
u'true'
),
(
u'template-shadowrootmode-img-src',
u'utf-8',
u'<div><template shadowrootmode="closed"><img src="{}"></template></div>',
None,
u'true',
u'true'
),
(
u'nested-template-shadowrootmode-1',
u'utf-8',
u'<template><div><template shadowrootmode="closed"><script src="{}"></script></template></div></template>',
None,
u'false',
u'true'
),
(
u'nested-template-shadowrootmode-2',
u'utf-8',
u'<div><template shadowrootmode="closed"><template><script src="{}"></script></template></template></div>',
None,
u'false',
u'true'
),
(
u'link-no-rel',
u'utf-8',
u'<link href="{}">',
None,
u'false',
u'true'
),
(
u'link-rel-stylesheet',
u'utf-8',
u'<link rel=stylesheet href="{}">',
None,
u'true',
u'true'
),
(
u'link-rel-alternate-stylesheet',
u'utf-8',
u'<link rel="alternate stylesheet" href="{}">',
None,
u'false',
u'true'
),
(
u'link-rel-stylesheet-disabled',
u'utf-8',
u'<link rel="stylesheet" href="{}" disabled>',
None,
u'false',
u'true'
),
(
u'link-rel-stylesheet-nomatch-media',
u'utf-8',
u'<link rel=stylesheet href="{}" media="not all">',
None,
u'false',
u'true'
),
(
u'link-rel-stylesheet-unsupported-type',
u'utf-8',
u'<link rel=stylesheet href="{}" type=text/plain>',
None,
u'false',
u'true'
),
(
u'link-rel-stylesheet-type-text-css',
u'utf-8',
u'<link rel=stylesheet href="{}" type=text/css>',
None,
u'true',
u'true'
),
(
u'link-rel-stylesheet-crossorigin',
u'utf-8',
u'<link rel=stylesheet href="{}" crossorigin>',
None,
u'true',
u'true'
),
(
u'link-rel-stylesheet-integrity',
u'utf-8',
u'<link rel=stylesheet href="{}" integrity="sha384-OLBgp1GsljhM2TJ+sbHjaiH9txEUvgdDTAzHv2P24donTt6/529l+9Ua0vFImLlb">',
None,
u'true',
u'true'
),
(
u'link-rel-stylesheet-referrerpolicy-no-referrer',
u'utf-8',
u'<link rel=stylesheet href="{}" referrerpolicy=no-referrer>',
None,
u'true',
u'true'
),
(
u'link-rel-preload-as-style',
u'utf-8',
u'<link rel=preload as=style href="{}">',
None,
u'true',
u'true'
),
(
u'link-rel-preload-as-font-crossorigin',
u'utf-8',
u'<link rel=preload as=font href="{}" crossorigin>',
None,
u'true',
u'true'
),
(
u'link-rel-preload-as-script',
u'utf-8',
u'<link rel=preload as=script href="{}">',
None,
u'true',
u'true'
),
(
u'link-rel-preload-as-image',
u'utf-8',
u'<link rel=preload as=image href="{}">',
None,
u'true',
u'true'
),
(
u'img-src',
u'utf-8',
u'<img src="{}">',
None,
u'true',
u'true'
),
(
u'img-data-src',
u'utf-8',
u'<img data-src="{}">',
None,
u'false',
u'true'
),
(
# <image> is turned into <img> in the tree builder
u'image-src',
u'utf-8',
u'<image src="{}">',
None,
u'true',
u'true'
),
(
u'img-srcset',
u'utf-8',
u'<img srcset="{}">',
None,
u'true',
u'true'
),
(
u'img-src-crossorigin',
u'utf-8',
u'<img src="{}" crossorigin>',
None,
u'true',
u'true'
),
(
u'img-src-referrerpolicy-no-referrer',
u'utf-8',
u'<img src="{}" referrerpolicy=no-referrer>',
None,
u'true',
u'true'
),
(
u'img-src-loading-lazy',
u'utf-8',
u'<img src="{}" loading=lazy>',
None,
u'false',
u'false'
),
(
u'picture-source-unsupported-type',
u'utf-8',
u'<picture><source srcset="{}" type=text/plain><img></picture>',
None,
u'false',
u'true'
),
(
u'picture-source-nomatch-media',
u'utf-8',
u'<picture><source srcset="{}" media="not all"><img></picture>',
None,
u'false',
u'true'
),
(
u'picture-source-no-img',
u'utf-8',
u'<picture><source srcset="{}"></picture>',
None,
u'false',
u'true'
),
(
u'picture-source-br-img',
u'utf-8',
u'<picture><source srcset="{}"><br><img></picture>',
None,
u'true',
u'true'
),
(
u'video-poster',
u'utf-8',
u'<video poster="{}"></video>',
None,
u'true',
u'true'
),
(
u'xmp-script-src',
u'utf-8',
u'<xmp><script src="{}"></script></xmp>',
None,
u'false',
u'true'
),
(
# MathML doesn't have script
u'math-script-src',
u'utf-8',
u'<math><script src="{}"></script></math>',
None,
u'false',
u'true'
),
(
u'math-font-script-src',
u'utf-8',
u'<math><font><script src="{}"></script></font></math>',
None,
u'false',
u'true'
),
(
# This breaks out of foreign content, so the script is an HTML script
u'math-font-face-script-src',
u'utf-8',
u'<math><font face><script src="{}"></script></font></math>',
None,
u'true',
u'true'
),
(
u'svg-script-href',
u'utf-8',
u'<svg><script href="{}"></script></svg>',
None,
u'true',
u'true'
),
(
u'svg-script-xlinkhref',
u'utf-8',
u'<svg><script xlink:href="{}"></script></svg>',
None,
u'true',
u'true'
),
(
# SVG script element doesn't have a src attribute
u'svg-script-src',
u'utf-8',
u'<svg><script src="{}"></script></svg>',
None,
u'false',
u'true'
),
(
u'svg-image-href',
u'utf-8',
u'<svg><image href="{}"></image></svg>',
None,
u'true',
u'true'
),
(
u'svg-image-xlinkhref',
u'utf-8',
u'<svg><image xlink:href="{}"></image></svg>',
None,
u'true',
u'true'
),
(
# SVG image element doesn't have a src attribute
u'svg-image-src',
u'utf-8',
u'<svg><image src="{}"></image></svg>',
None,
u'false',
u'true'
),
]
tests = [
# title,
# encoding,
# template_testcase_markup,
# expect_load,
# test_nonspeculative
]
# Templates
preamble = u"""<!DOCTYPE html>
<!-- DO NOT EDIT. This file has been generated. Source:
/html/syntax/speculative-parsing/tools/generate.py
-->"""
no_meta_charset = u"""<!-- no meta charset -->
<!-- (padding to exceed 1024 bytes processed by the character encoding scanner) -->
<!-- -->
<!-- -->
<!-- -->
<!-- -->
<!-- -->
<!-- -->
<!-- -->
<!-- -->
<!-- -->"""
# Notes on `encodingcheck` in the URL below
#
# - Ğ is the HTML character reference for U+011E LATIN CAPITAL LETTER G WITH BREVE
# - In windows-1254, this character is encoded as 0xD0.
# When used in the query part of a URL, it gets percent-encoded as %D0.
# - In windows-1252 (usually the fallback encoding), that character can't be encoded, so is instead
# represented as Ğ percent-encoded, so %26%23286%3B.
# - In utf-8, it's percent-encoded as utf-8: %C4%9E
# - stash.py will store this value as "param-encodingcheck"
url_wptserve_sub = u"/html/syntax/speculative-parsing/resources/stash.py?action=put&uuid={{GET[uuid]}}&encodingcheck=Ğ"
url_js_sub = u"/html/syntax/speculative-parsing/resources/stash.py?action=put&uuid=${uuid}&encodingcheck=Ğ"
# Non-speculative (normal) case to compare results with
template_nonspeculative = u"""{preamble}
{encoding_decl}
<title>Speculative parsing, non-speculative (helper file): {title}</title>
<!-- non-speculative case -->
{nonspeculative_testcase_markup}
<!-- block the load event for a bit: -->
<script src="/common/slow.py?delay={delay}"></script>
"""
# Scenario: page load
template_pageload_toplevel = u"""{preamble}
{encoding_decl}
<title>Speculative parsing, page load: {title}</title>
<script src=/resources/testharness.js></script>
<script src=/resources/testharnessreport.js></script>
<script src=/common/utils.js></script>
<script src=/html/syntax/speculative-parsing/resources/speculative-parsing-util.js></script>
<body>
<script>
setup({{single_test: true}});
const uuid = token();
const iframe = document.createElement('iframe');
iframe.src = `resources/{title}-framed.sub.html?uuid=${{uuid}}`;
document.body.appendChild(iframe);
expect_fetched_onload(uuid, {expect_load})
.then(compare_with_nonspeculative(uuid, '{title}', {test_nonspeculative}))
.then(done);
</script>
"""
template_pageload_framed = u"""{preamble}
{encoding_decl}
<title>Speculative parsing, page load (helper file): {title}</title>
<script src="/common/slow.py?delay={delay}"></script>
<script>
document.write('<plaintext>');
</script>
<!-- speculative case -->
{testcase_markup}
"""
# Scenario: document.write()
template_docwrite = u"""{preamble}
{encoding_decl}
<title>Speculative parsing, document.write(): {title}</title>
<script src=/resources/testharness.js></script>
<script src=/resources/testharnessreport.js></script>
<script src=/common/utils.js></script>
<script src=/html/syntax/speculative-parsing/resources/speculative-parsing-util.js></script>
<script>
setup({{single_test: true}});
const uuid = token();
expect_fetched_onload(uuid, {expect_load})
.then(compare_with_nonspeculative(uuid, '{title}', {test_nonspeculative}))
.then(done);
document.write(`
<script src="/common/slow.py?delay={delay}"><\\/script>
<script>
document.write('<plaintext>');
<\\/script>
<\\!-- speculative case in document.write -->
{testcase_markup}
`);
</script>
"""
# Scenario: <link rel=prerender> - TODO(zcorpan)
template_prerender_toplevel = u"""{preamble}
{encoding_decl}
<title>Speculative parsing, prerender: {title}</title>
...
"""
template_prerender_linked = u"""{preamble}
{encoding_decl}
<title>Speculative parsing, prerender (helper file): {title}</title>
...
"""
# Generate tests
# wipe target_dir of HTML files
if os.path.isdir(target_dir):
for root, dirs, files in os.walk(target_dir):
for name in files:
if name.endswith('.html'):
path = os.path.join(root, name)
if os.path.isfile(path):
os.remove(path)
def write_file(path, content):
path = os.path.join(target_dir, path)
os.makedirs(os.path.dirname(path), exist_ok=True)
file = open(os.path.join(target_dir, path), 'w')
file.write(content)
file.close()
def generate_tests(testcase, tentative):
title, encoding, template_testcase_markup, template_nonspeculative_testcase_markup, expect_load, test_nonspeculative = testcase
if template_nonspeculative_testcase_markup == None:
template_nonspeculative_testcase_markup = template_testcase_markup
ext = u""
if tentative:
ext = u".tentative"
if encoding == None:
encoding_decl = no_meta_charset
else:
encoding_decl = f"<meta charset={encoding}>"
html_testcase_markup = template_testcase_markup.format(url_wptserve_sub)
html_nonspeculative_testcase_markup = template_nonspeculative_testcase_markup.format(url_wptserve_sub)
js_testcase_markup = template_testcase_markup.format(url_js_sub).replace(u"</script>", u"<\\/script>").replace(u"<meta charset", u"<meta\\ charset")
if test_nonspeculative == u'true':
nonspeculative = template_nonspeculative.format(preamble=preamble, encoding_decl=encoding_decl, title=title, nonspeculative_testcase_markup=html_nonspeculative_testcase_markup, delay=delay)
write_file(f"resources/{title}-nonspeculative.sub.html", nonspeculative)
pageload_toplevel = template_pageload_toplevel.format(preamble=preamble, encoding_decl=encoding_decl, title=title, expect_load=expect_load, test_nonspeculative=test_nonspeculative)
write_file(f"page-load/{title}{ext}.html", pageload_toplevel)
pageload_framed = template_pageload_framed.format(preamble=preamble, encoding_decl=encoding_decl, title=title, testcase_markup=html_testcase_markup, delay=delay)
write_file(f"page-load/resources/{title}-framed.sub.html", pageload_framed)
docwrite = template_docwrite.format(preamble=preamble, encoding_decl=encoding_decl, title=title, expect_load=expect_load, testcase_markup=js_testcase_markup, test_nonspeculative=test_nonspeculative, delay=delay)
write_file(f"document-write/{title}{ext}.sub.html", docwrite)
for testcase in tests:
generate_tests(testcase, False)
for testcase in tentative_tests:
generate_tests(testcase, True)