Merge pull request #776 from docsifyjs/improve-test-setup

Improve test setup
5 years ago · c1d4961a64
parent d5910bd1f9 2039e0dd1c
commit c1d4961a64
9 changed files with 135 additions and 61 deletions
--- a/package-lock.json
+++ b/package-lock.json
@ -8791,12 +8791,6 @@
        "async-limiter": "~1.0.0"
      }
    },
-    "xhr2": {
-      "version": "0.1.4",
-      "resolved": "https://registry.npmjs.org/xhr2/-/xhr2-0.1.4.tgz",
-      "integrity": "sha1-f4dliEdxbbUCYyOBL4GMras4el8=",
-      "dev": true
-    },
    "xml-name-validator": {
      "version": "3.0.0",
      "resolved": "https://registry.npmjs.org/xml-name-validator/-/xml-name-validator-3.0.0.tgz",
--- a/package.json
+++ b/package.json
@ -27,7 +27,7 @@
    "dev": "run-p serve watch:*",
    "dev:ssr": "run-p serve:ssr watch:*",
    "lint": "eslint {src,packages} --fix",
-    "test": "mocha",
+    "test": "mocha test/*/**",
    "css": "stylus src/themes/*.styl -u autoprefixer-stylus",
    "watch:css": "run-p 'css -- -o themes -w'",
    "watch:js": "node build/build.js",
@ -72,8 +72,7 @@
    "rollup-plugin-node-resolve": "^3.0.0",
    "rollup-plugin-replace": "^2.0.0",
    "rollup-plugin-uglify": "^2.0.1",
-    "stylus": "^0.54.5",
-    "xhr2": "^0.1.4"
+    "stylus": "^0.54.5"
  },
  "keywords": [
    "doc",
--- a/test/_helper.js
+++ b/test/_helper.js
@ -1,45 +1,10 @@
 // load ES6 modules in Node.js on the fly
 require = require('esm')(module/*, options*/)

+const path = require('path')
 const {expect} = require('chai')

 const {JSDOM} = require('jsdom')
-const XMLHttpRequest = require('xhr2') // JSDOM doesn't support XMLHttpRequest
-// TODO: try to fix tests when using `<div id="app"></div>` in body
-const markup = `<!DOCTYPE html>
-<html>
-  <head></head>
-  <body></body>
-</html>`
-// TODO: this may not work if tests are mutate the DOM, instead a new instance needs to be created
-// for every test case but that will slow down the tests
-const dom = new JSDOM(markup) 
-
-global.window = dom.window
-global.document = dom.window.document
-global.navigator = dom.window.navigator
-global.location = dom.window.location
-global.XMLHttpRequest = XMLHttpRequest
-
-const {initMixin} = require('../src/core/init')
-const {routerMixin} = require('../src/core//router')
-const {renderMixin} = require('../src/core//render')
-const {fetchMixin} = require('../src/core/fetch')
-const {eventMixin} = require('../src/core//event')
-
-// mimic src/core/index.js but for Node.js
-
-function Docsify() {
-  this._init()
-}
-
-const proto = Docsify.prototype
-
-initMixin(proto)
-routerMixin(proto)
-renderMixin(proto)
-fetchMixin(proto)
-eventMixin(proto)

 function ready(callback) {
  const state = document.readyState
@ -50,16 +15,64 @@ function ready(callback) {

  document.addEventListener('DOMContentLoaded', callback)
 }
-let docsify = null
-module.exports.init = function(callback) {
+module.exports.init = function(fixture = 'default', config = {}, markup) {
+	if (markup == null) {
+		markup = `<!DOCTYPE html>
+		<html>
+		  <head></head>
+		  <body>
+		  	<div id="app"></div>
+		  	<script>
+		  		window.$docsify = ${JSON.stringify(config, null, 2)}
+		  	</script>
+		  </body>
+		</html>`
+	}
+	const rootPath = path.join(__dirname, 'fixtures', fixture)
+		
+	const dom = new JSDOM(markup) 
+	dom.reconfigure({ url: 'file:///' + rootPath })
+
+	global.window = dom.window
+	global.document = dom.window.document
+	global.navigator = dom.window.navigator
+	global.location = dom.window.location
+	global.XMLHttpRequest = dom.window.XMLHttpRequest
+
+	// mimic src/core/index.js but for Node.js
+	function Docsify() {
+	  this._init()
+	}
+
+	const proto = Docsify.prototype
+
+	const {initMixin} = require('../src/core/init')
+	const {routerMixin} = require('../src/core//router')
+	const {renderMixin} = require('../src/core//render')
+	const {fetchMixin} = require('../src/core/fetch')
+	const {eventMixin} = require('../src/core//event')
+
+	initMixin(proto)
+	routerMixin(proto)
+	renderMixin(proto)
+	fetchMixin(proto)
+	eventMixin(proto)
+
+	const NOT_INIT_PATTERN = '<!--main-->'
+
 	return new Promise((resolve, reject) => {
-		// return cached version / TODO: see above: this might not scale, new instance of JSDOM is reqiured
-		if (docsify != null) {
-			return resolve(docsify)
-		}
-		ready(_ => {
-			docsify = new Docsify()
-			return resolve(docsify)
+		ready(() => {
+			const docsify = new Docsify()
+			// NOTE: I was not able to get it working with a callback, but polling works usually at the first time
+			const id = setInterval(() => {
+				if (dom.window.document.body.innerHTML.indexOf(NOT_INIT_PATTERN) == -1) {
+					clearInterval(id)
+					return resolve({
+						docsify: docsify,
+						dom: dom
+					})
+				}
+			}, 10)
 		})
 		
 	})
--- a/test/fixtures/default/README.md
+++ b/test/fixtures/default/README.md
@ -0,0 +1,6 @@
+<!-- 
+
+create your own fixture directory
+if you need a custom README.md or sidebar
+
+-->
--- a/test/fixtures/simple/README.md
+++ b/test/fixtures/simple/README.md
@ -0,0 +1,18 @@
+# Heading
+
+[another page](other.md)
+
+## II 1
+
+### III 1
+
+#### IV 1
+
+##### V 1
+
+
+## II 2
+
+### III 2
+
+#### IV 2
--- a/test/fixtures/simple/other-page.md
+++ b/test/fixtures/simple/other-page.md
@ -0,0 +1,16 @@
+# Other
+
+## two 1
+
+### three 1
+
+#### four 1
+
+##### five 1 
+
+
+## two 2
+
+### three 2
+
+#### four 2
--- a/test/integration/render.js
+++ b/test/integration/render.js
@ -0,0 +1,14 @@
+const path = require('path')
+
+const {expect} = require('chai')
+
+const {init, expectSameDom} = require('../_helper')
+
+describe('full docsify initialization', function() {
+	it('TODO: check generated markup', async function() {
+		const {docsify, dom} = await init('simple', {loadSidebar: true})
+  		console.log(dom.window.document.body.innerHTML)
+  		// TODO: add some expectations
+	})
+
+})
--- a/test/integration/router.js
+++ b/test/integration/router.js
@ -0,0 +1,14 @@
+const path = require('path')
+
+const {expect} = require('chai')
+
+const {init, expectSameDom} = require('../_helper')
+
+describe('router', function() {
+	it('TODO: trigger to load another page', async function() {
+		const {docsify} = await init()
+  		window.location = '/?foo=bar'
+  		// TODO: add some expectations
+	})
+
+})
--- a/test/unit/render.js
+++ b/test/unit/render.js
@ -2,18 +2,18 @@ const path = require('path')

 const {expect} = require('chai')

-const {init, expectSameDom} = require('./_helper')
+const {init, expectSameDom} = require('../_helper')

 describe('render', function() {
 	it('important content (tips)', async function() {
-		docsify = await init()
+		const {docsify, dom} = await init()
  		const output = docsify.compiler.compile('!> **Time** is money, my friend!')
  		expect(output).equal('<p class="tip"><strong>Time</strong> is money, my friend!</p>')
 	})

 	describe('lists', function() {
 		it('as unordered task list', async function() {
-			docsify = await init()
+			const {docsify, dom} = await init()
 			const output = docsify.compiler.compile(`
 - [x] Task 1
 - [ ] Task 2
@ -26,7 +26,7 @@ describe('render', function() {
 		})

 		it('as ordered task list', async function() {
-			docsify = await init()
+			const {docsify, dom} = await init()
 			const output = docsify.compiler.compile(`
 1. [ ] Task 1
 2. [x] Task 2`)
@ -37,7 +37,7 @@ describe('render', function() {
 		})

 		it('normal unordered', async function() {
-			docsify = await init()
+			const {docsify, dom} = await init()
 			const output = docsify.compiler.compile(`
 - [linktext](link)
 - just text`)
@ -48,7 +48,7 @@ describe('render', function() {
 		})

 		it('unordered with custom start', async function() {
-			docsify = await init()
+			const {docsify, dom} = await init()
 			const output = docsify.compiler.compile(`
 1. first
 2. second
@ -67,7 +67,7 @@ text
 		})

 		it('nested', async function() {
-			docsify = await init()
+			const {docsify, dom} = await init()
 			const output = docsify.compiler.compile(`
 - 1
 - 2