Issue 510 - [Typed objects] Don`t hardcode script load order in unit tests

run_tests.py

 #!/usr/bin/env python
 # coding: utf-8
 
 # This file is part of Adblock Plus <https://adblockplus.org/>,
 # Copyright (C) 2006-2015 Eyeo GmbH
 #
 # Adblock Plus is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License version 3 as
 # published by the Free Software Foundation.
 #
 # Adblock Plus 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 Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
 
 import io
 import json
 import os
 import posixpath
 import re
 import urlparse
+
 import flask

[Felix Dahlke, 2015/02/04 04:02:35]

While we're nit picking :)

PEP-8: "You should put a blank line between each group of imports."

 
 app = flask.Flask(__name__)
 
-def get_scripts(root):
-  for dir, _, files in os.walk(root):
-    for file in files:
-      if os.path.splitext(file)[1] == ".js":
-        path = os.path.join(dir, file)

[Felix Dahlke, 2015/02/04 03:58:51]

posixpath.join?

[Wladimir Palant, 2015/02/04 15:37:14]

No, we need a proper OS-specific path here, only the relative path needs to use
forward slashes.

But now that you say it - relative path calculation below won't work correctly
on Windows, not even with posixpath. So far I've come up with the following
monster:

def split_path(path):
  path, filename = os.path.split(path)
  return (split_path(path) if path else []) + [filename]

...

        relpath = posixpath.join(*split_path(os.path.relpath(path, root)))

I think I better switch back to the original recursive approach.

[Felix Dahlke, 2015/02/04 18:20:25]

OK, fair enough. Considering that I didn't fully get the point behind relpath at
first - how about renaming that one to "webpath" or something?

[Wladimir Palant, 2015/02/04 20:46:14]

I don't think variable naming will make it any clearer. I've added a comment -
and also made sure we use posixpath rather than os.path when manipulating these
paths (for consistency).

-        relpath = posixpath.relpath(path, root)
-        yield (path, relpath)
+def get_scripts(dir, reldir=""):
+  for filename in os.listdir(dir):
+    path = os.path.join(dir, filename)
+    # "Relative path" will be the parameter passed in to require(), meaning
+    # that it always has to use forward slashes.
+    relpath = posixpath.join(reldir, filename)
+    if os.path.isdir(path):
+      for path, relpath in get_scripts(path, relpath):
+        yield path, relpath
+    elif os.path.splitext(path)[1] == ".js":
+      yield path, relpath
 
 def js_encode(str):
   return json.dumps(str)
 
 def script_as_string(path, sourceURL, backcompat):
   if backcompat:
     from jshydra.abp_rewrite import doRewrite
     data = doRewrite([os.path.abspath(path)], []).decode("utf-8")
   else:
     with io.open(path, "r", encoding="utf-8") as handle:
       data = handle.read()
   data += "\n//# sourceURL=%s" % sourceURL
   return js_encode(data)
 
 @app.route("/<path:path>", methods = ["GET"])
 @app.route("/", methods = ["GET"])
 def multiplex(path=""):
-  request_url = urlparse.urlparse(flask.request.url)
+  base_url = flask.request.url
+  request_url = urlparse.urlparse(base_url)
   request_path = request_url.path
   islib = request_path.startswith("/lib/")
   backcompat = request_url.query == "backcompat"
 
   rootdir = os.path.dirname(__file__)
   if request_path == "/lib.js":
-    data = ""
-    for path, relpath in get_scripts(os.path.join(rootdir, "lib")):
-      url = urlparse.urljoin(flask.request.url, "/lib/" + relpath)
-      data += "require.sources[%s] = %s;\n" % (
-          js_encode(os.path.splitext(relpath)[0]),
-          script_as_string(path, url, backcompat)
-      )
-    return (data, 200, {"Content-Type": "application/javascript; charset=utf-8"})
+    def generate_libs():
+      for path, relpath in get_scripts(os.path.join(rootdir, "lib")):
+        url = urlparse.urljoin(base_url, "/lib/" + relpath)
+        yield "require.sources[%s] = %s;\n" % (
+            js_encode(posixpath.splitext(relpath)[0]),
+            script_as_string(path, url, backcompat)
+        )
+    return flask.Response(generate_libs(), mimetype="application/javascript")
   elif request_path == "/tests.js":
-    data = "var tests = ["
-    for path, relpath in get_scripts(os.path.join(rootdir, "test", "tests")):
-      url = urlparse.urljoin(flask.request.url, "/tests/" + relpath)
-      data += "  %s,\n" % script_as_string(path, url, backcompat)
-    data += "];"
-    return (data, 200, {"Content-Type": "application/javascript; charset=utf-8"})
+    def generate_tests():
+      yield "var tests = ["
+      for path, relpath in get_scripts(os.path.join(rootdir, "test", "tests")):
+        url = urlparse.urljoin(base_url, "/tests/" + relpath)
+        yield "  %s,\n" % script_as_string(path, url, backcompat)
+      yield "];"
+    return flask.Response(generate_tests(), mimetype="application/javascript")
   else:
     if request_path.startswith("/lib/"):
       rootdir = os.path.join(rootdir, "lib")
     else:
       rootdir = os.path.join(rootdir, "test")
     if request_path.endswith("/"):
       request_path += "index.html"
     return flask.send_from_directory(rootdir, request_path.lstrip("/"))
 
 if __name__ == "__main__":
   app.run(debug=True)