Implement a simple synchroneous wast harness;

Author: bnjbvr

test/README.md

@@ -1,6 +1,50 @@
-This directory contains the WebAssembly test suite. It is split into two directories:
+This directory contains the WebAssembly test suite. It is split into two
+directories:
 
 * [`core/`](core/), tests for the core semantics
-* [`js-api/`](js-api/), tests for the JavaScript API
+* [`js-api/`](js-api/), tests for the JavaScript API. These tests can be run in
+  a pure JavaScript environment, that is, a JS shell (like v8 or spidermonkey's
+  shells). A small [harness](js-api/README.md) is needed, but it is very easy
+  to implement.
+* [`html/`](html/), tests for the JavaScript API necessitating a DOM
+  environment (a full browser).
 
-A list of to-do's can be found [here](Todo.md).
+A [landing page](out/index.html) contains a condensed version made of all
+these tests, converted to HTML.
+
+A list of to-do's can be found [here](Todo.md).
+
+## Multi-stage testing
+
+The wast tests can be converted to JavaScript, and the JavaScript tests
+to HTML tests, using the `build.py` script. It will create a `out/` directory
+(checked in in this repository, to be able to use it from github pages),
+containing subdirectories with expanded tests, as well as a landing page for
+runnning all of them in HTML.
+
+The HTML tests are just [Web Platform Tests](http://testthewebforward.org)
+using the
+[testharness.js](http://testthewebforward.org/docs/testharness-library.html)
+library.
+
+Each wast test gets its equivalent JS test, and each JS test (including wast
+test) gets its equivalent WPT, to be easily run in browser vendors' automation.
+
+## Procedure for adding a new test
+
+- put the test in the right directory according to the above (top) description.
+- ideally, commit here so the actual content commit and build commit are
+  separated.
+- re-run `build.py` so that the landing page is updated and all the cascading
+  happens.
+- re-commit here, if necessary.
+
+## Local HTTP serving of the repository
+
+From the root of your clone of this repository:
+
+```
+python -m SimpleHTTPServer 8000
+```
+
+Then open your favorite browser and browse to `http://localhost:8000/test/out`.

test/build.py

@@ -51,47 +51,15 @@ def ensure_clean_initial_state():
 
 # JS harness.
 def replace_js_harness(js_file):
-    """
-    Hack: remove the harness lines generated by the spec interpreter, to later
-    replace them by our own harness.
-
-    As an alternative, the spec interpreter could take an option that the
-    harness needs or needs not be generated, which would be cleaner.
-    """
     test_func_name = os.path.basename(js_file).replace('.', '_').replace('-', '_')
 
-    lines = """(function {}() {{
-
-var $$;""".format(test_func_name).split('\n')
-
-    LAST_IGNORED_FUNCTION = 'function assert_return_nan(action) {'
-
-    ignoring = True
-    reached_end = False
-
-    # Three states machine:
-    # - ignoring = True and reached_end = False: ignore the line
-    # - ignoring = True and reached_end = True: last line to be ignored
-    # - ignoring = False: include the line
-
+    content = ["(function {}() {{".format(test_func_name)]
     with open(js_file, 'r') as f:
-        for l in f.readlines():
-            l = l.rstrip()
-            if ignoring:
-                if reached_end:
-                    if l == '}':
-                        ignoring = False
-                else:
-                    if l == LAST_IGNORED_FUNCTION:
-                        reached_end = True
-            else:
-                lines.append(l)
-
-    lines.append('')
-    lines.append('})();')
+        content += f.readlines()
+    content.append('})();')
 
     with open(js_file, 'w') as f:
-        f.write('\n'.join(lines))
+        f.write('\n'.join(content))
 
 def convert_wast_to_js():
     """Compile all the wast files to JS and store the results in the JS dir."""
@@ -103,7 +71,7 @@ def convert_wast_to_js():
         print('Compiling {} to JS...'.format(wast_file))
         js_filename = os.path.basename(wast_file) + '.js'
         js_file = os.path.join(OUT_JS_DIR, js_filename)
-        result = run(WASM_EXEC, wast_file, '-o', js_file)
+        result = run(WASM_EXEC, wast_file, '-h', '-o', js_file)
         if result.returncode != 0:
             print('Error when compiling {} to JS: {}', wast_file, result.stdout)
 
@@ -117,17 +85,27 @@ def build_js():
     for js_file in glob.glob(os.path.join(JS_DIR, '*.js')):
         shutil.copy(js_file, OUT_JS_DIR)
 
-HTML_HEADER = """
-<!doctype html>
-<title>WebAssembly Web Platform Test</title>
-<link rel=author href=mailto:bbouvier@mozilla.com title=bnjbvr>
-<script src={PREFIX}lib/testharness.js></script>
-<script src={PREFIX}lib/testharnessreport.js></script>
-<script src={PREFIX}lib/index.js></script>
-<script src={PREFIX}lib/wasm-constants.js></script>
-<script src={PREFIX}lib/wasm-module-builder.js></script>
-
-<div id=log></div>
+HTML_HEADER = """<!doctype html>
+<html>
+    <head>
+        <meta charset="UTF-8">
+        <title>WebAssembly Web Platform Test</title>
+        <link rel=author href=mailto:bbouvier@mozilla.com title=bnjbvr>
+    </head>
+    <body>
+
+        <script src={PREFIX}lib/testharness.js></script>
+        <script src={PREFIX}lib/testharnessreport.js></script>
+        <script src={PREFIX}lib/index.js></script>
+        <script src={PREFIX}lib/wasm-constants.js></script>
+        <script src={PREFIX}lib/wasm-module-builder.js></script>
+
+        <div id=log></div>
+"""
+
+HTML_BOTTOM = """
+    </body>
+</html>
 """
 
 def build_html_from_js(src_dir):
@@ -142,22 +120,28 @@ def build_html_from_js(src_dir):
         html_file = os.path.join(OUT_HTML_DIR, html_filename)
         with open(html_file, 'w+') as f:
             content = HTML_HEADER.replace('{PREFIX}', '../../')
-            content += "<script src=../js/{SCRIPT}></script>".replace('{SCRIPT}', js_filename)
+            content += "        <script src=../js/{SCRIPT}></script>".replace('{SCRIPT}', js_filename)
+            content += HTML_BOTTOM
             f.write(content)
     return files
 
 def build_html():
     print("Building HTML tests...")
 
     print('Building WPT tests from pure JS tests...')
-    js_files = build_html_from_js(OUT_JS_DIR) + build_html_from_js(HTML_DIR)
+    js_files = build_html_from_js(OUT_JS_DIR)
+
+    print('Building WPT tests from HTML JS tests...')
+    js_files += build_html_from_js(HTML_DIR)
 
     print('Building front page containing all the HTML tests...')
     front_page = os.path.join(OUT_DIR, 'index.html')
     with open(front_page, 'w+') as f:
         content = HTML_HEADER.replace('{PREFIX}', '../')
         for filename in js_files:
-            content += "<script src=./js/{SCRIPT}></script>\n".replace('{SCRIPT}', filename)
+            content += "        <script src=./js/{SCRIPT}></script>\n".replace('{SCRIPT}', filename)
+            content += "        <script>reinitializeRegistry();</script>\n"
+        content += HTML_BOTTOM
         f.write(content)
 
 if __name__ == '__main__':

test/js-api/README.md

@@ -1 +1,18 @@
-This directory contains tests specific to the JavaScript API to WebAssembly, as described in [JS.md](https://github.com/WebAssembly/design/blob/master/JS.md).
+This directory contains tests specific to the JavaScript API to WebAssembly, as
+described in [JS.md](https://github.com/WebAssembly/design/blob/master/JS.md).
+
+## Harness
+
+These tests can be run in a pure JS environment (JS shell), provided a few
+libraries and functions emulating the
+[testharness.js](http://testthewebforward.org/docs/testharness-library.html)
+library.
+
+- The `../lib/index.js`, `../lib/wasm-constants.js` and
+  `../lib/wasm-module-builder.js` must be imported first.
+- A function `test(function, description)` that tries to run the function under
+  a try/catch and maybe asserts in case of failure.
+- A function `promise_test(function, description)` where `function` returns a
+  `Promise` run by `promise_test`; a rejection means a failure here.
+- Assertion functions: `assert_equals(x, y)`, `assert_true(x)`,
+  `assert_false(x)`, `assert_unreached()`.