tests/typescript: Add end-to-end tests

mozilla · Oct 1, 2019 · 40b3e7b · 40b3e7b
1 parent 886a5fd
commit 40b3e7b
Show file tree

Hide file tree

Showing 26 changed files with 50 additions and 14 deletions.
diff --git a/tests/typescript/class.ts → tests/test_typescript/source/class.ts b/tests/typescript/class.ts → tests/test_typescript/source/class.ts
diff --git a/tests/typescript/class.ts.jsdoc → tests/test_typescript/source/class.ts.jsdoc b/tests/typescript/class.ts.jsdoc → tests/test_typescript/source/class.ts.jsdoc
diff --git a/tests/test_typescript/source/docs/conf.py b/tests/test_typescript/source/docs/conf.py
@@ -0,0 +1,12 @@
+# -*- coding: utf-8 -*-
+extensions = [
+    'sphinx_js'
+]
+
+# Minimal stuff needed for Sphinx to work:
+js_language = 'typescript'
+jsdoc_config_path = '../tsconfig.json'
+source_suffix = '.rst'
+master_doc = 'index'
+author = u'Tavian Barnes'
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
diff --git a/tests/test_typescript/source/docs/index.rst b/tests/test_typescript/source/docs/index.rst
diff --git a/tests/test_typescript/source/docs/overload.rst b/tests/test_typescript/source/docs/overload.rst
@@ -0,0 +1 @@
+.. js:autofunction:: overloaded
diff --git a/tests/typescript/docstring-alias.ts → ...test_typescript/source/docstring-alias.ts b/tests/typescript/docstring-alias.ts → ...test_typescript/source/docstring-alias.ts
diff --git a/tests/typescript/docstring-alias.ts.jsdoc → ...ypescript/source/docstring-alias.ts.jsdoc b/tests/typescript/docstring-alias.ts.jsdoc → ...ypescript/source/docstring-alias.ts.jsdoc
diff --git a/tests/typescript/extends.ts → tests/test_typescript/source/extends.ts b/tests/typescript/extends.ts → tests/test_typescript/source/extends.ts
diff --git a/tests/typescript/extends.ts.jsdoc → ...s/test_typescript/source/extends.ts.jsdoc b/tests/typescript/extends.ts.jsdoc → ...s/test_typescript/source/extends.ts.jsdoc
diff --git a/tests/typescript/generic-class.ts → ...s/test_typescript/source/generic-class.ts b/tests/typescript/generic-class.ts → ...s/test_typescript/source/generic-class.ts
diff --git a/tests/typescript/generic-class.ts.jsdoc → ..._typescript/source/generic-class.ts.jsdoc b/tests/typescript/generic-class.ts.jsdoc → ..._typescript/source/generic-class.ts.jsdoc
diff --git a/tests/typescript/generic-interface.ts → ...st_typescript/source/generic-interface.ts b/tests/typescript/generic-interface.ts → ...st_typescript/source/generic-interface.ts
diff --git a/tests/typescript/generic-interface.ts.jsdoc → ...escript/source/generic-interface.ts.jsdoc b/tests/typescript/generic-interface.ts.jsdoc → ...escript/source/generic-interface.ts.jsdoc
diff --git a/tests/typescript/generic-method.ts → .../test_typescript/source/generic-method.ts b/tests/typescript/generic-method.ts → .../test_typescript/source/generic-method.ts
diff --git a/tests/typescript/generic-method.ts.jsdoc → ...typescript/source/generic-method.ts.jsdoc b/tests/typescript/generic-method.ts.jsdoc → ...typescript/source/generic-method.ts.jsdoc
diff --git a/tests/typescript/generic.ts → tests/test_typescript/source/generic.ts b/tests/typescript/generic.ts → tests/test_typescript/source/generic.ts
diff --git a/tests/typescript/generic.ts.jsdoc → ...s/test_typescript/source/generic.ts.jsdoc b/tests/typescript/generic.ts.jsdoc → ...s/test_typescript/source/generic.ts.jsdoc
diff --git a/tests/typescript/implements.ts → tests/test_typescript/source/implements.ts b/tests/typescript/implements.ts → tests/test_typescript/source/implements.ts
diff --git a/tests/typescript/implements.ts.jsdoc → ...est_typescript/source/implements.ts.jsdoc b/tests/typescript/implements.ts.jsdoc → ...est_typescript/source/implements.ts.jsdoc
diff --git a/tests/typescript/interface.ts → tests/test_typescript/source/interface.ts b/tests/typescript/interface.ts → tests/test_typescript/source/interface.ts
diff --git a/tests/typescript/interface.ts.jsdoc → ...test_typescript/source/interface.ts.jsdoc b/tests/typescript/interface.ts.jsdoc → ...test_typescript/source/interface.ts.jsdoc
diff --git a/tests/test_typescript/source/overload.ts b/tests/test_typescript/source/overload.ts
@@ -0,0 +1,13 @@
+/**
+ * An overloaded function (1).
+ */
+function overloaded(arg: number): number;
+
+/**
+ * An overloaded function (2).
+ */
+function overloaded(arg: string): string;
+
+function overloaded(arg: number | string): number | string {
+    return arg;
+}
diff --git a/tests/typescript/overload.ts.jsdoc → .../test_typescript/source/overload.ts.jsdoc b/tests/typescript/overload.ts.jsdoc → .../test_typescript/source/overload.ts.jsdoc
diff --git a/tests/test_typescript/source/tsconfig.json b/tests/test_typescript/source/tsconfig.json
@@ -0,0 +1,8 @@
+{
+    "compilerOptions": {
+        "target": "es5"
+    },
+    "include": [
+        "*.ts"
+    ]
+}
diff --git a/tests/test_typedoc.py → tests/test_typescript/test_typescript.py b/tests/test_typedoc.py → tests/test_typescript/test_typescript.py
@@ -10,13 +10,15 @@
 from sphinx_js.doclets import program_name_on_this_platform
 from sphinx_js.typedoc import TypeDoc, parse_typedoc
 
+from tests.testing import SphinxBuildTestCase
+
 
 class Tests(TestCase):
     """Test typedoc to jsdoc conversion on typescript/*.ts
     """
     @classmethod
     def setup_class(cls):
-        cls.source_dir = os.path.join(os.path.dirname(__file__), 'typescript')
+        cls.source_dir = os.path.join(os.path.dirname(__file__), 'source')
         cls.tmpdir = mkdtemp()
 
     @classmethod
@@ -63,3 +65,16 @@ def test_references(self):
                     with open(jsdoc_ref_file, 'r') as jsdocfile:
                         jsdoc_ref = json.load(jsdocfile)
                     eq_(jsdoc, jsdoc_ref)
+
+
+class BuildTests(SphinxBuildTestCase):
+    def test_overloads(self):
+        """Make sure we correctly render overloaded typescript functions."""
+        self._file_contents_eq(
+            'overload',
+            'overloaded(arg)\n\n'
+            '   An overloaded function (1).\n\n'
+            '   Arguments:\n'
+            '      * **arg** (*number*) --\n\n'
+            '   Returns:\n'
+            '      **number** --\n')
diff --git a/tests/typescript/overload.ts b/tests/typescript/overload.ts