test: run renderToString tests in node environment (#542)

Author: eddyerburgh

package.json

@@ -19,12 +19,13 @@
     "lint:fix": "npm run lint -- --fix",
     "prepublish": "npm run build && npm run test:unit:only",
     "publish": "lerna publish --conventional-commits -m \"chore(release): publish %s\"",
-    "test": "npm run lint && npm run lint:docs && npm run flow && npm run test:types && npm run test:unit && npm run test:unit:karma",
+    "test": "npm run lint && npm run lint:docs && npm run flow && npm run test:types && npm run test:unit && npm run test:unit:karma npm run test:unit:node",
     "test:compat": "scripts/test-compat.sh",
     "test:unit": "npm run build:test && npm run test:unit:only",
-    "test:unit:only": "cross-env BABEL_ENV=test && mocha-webpack --webpack-config test/setup/webpack.test.config.js test/specs --recursive --require test/setup/mocha.setup.js",
-    "test:unit:debug": "npm run build:test && cross-env BABEL_ENV=test && node --inspect-brk node_modules/.bin/mocha-webpack --webpack-config test/setup/webpack.test.config.js test/specs --recursive --require test/setup/mocha.setup.js",
-    "test:unit:karma": "npm run build:test && cross-env BABEL_ENV=test TARGET=browser karma start test/setup/karma.conf.js --single-run",
+    "test:unit:only": "mocha-webpack --webpack-config test/setup/webpack.test.config.js test/specs --recursive --require test/setup/mocha.setup.js",
+    "test:unit:debug": "npm run build:test && node --inspect-brk node_modules/.bin/mocha-webpack --webpack-config test/setup/webpack.test.config.js test/specs --recursive --require test/setup/mocha.setup.js",
+    "test:unit:karma": "npm run build:test TARGET=browser karma start test/setup/karma.conf.js --single-run",
+    "test:unit:node": "npm run build:test && npm run test:unit:node:only",
     "test:types": "tsc -p packages/test-utils/types && tsc -p packages/server-test-utils/types"
   },
   "devDependencies": {
@@ -37,6 +38,7 @@
     "babel-preset-flow-vue": "^1.0.0",
     "babel-preset-stage-2": "^6.24.1",
     "chai": "^4.0.0",
+    "cheerio": "^1.0.0-rc.2",
     "cross-env": "^5.0.0",
     "css-loader": "^0.28.4",
     "eslint": "^4.18.1",

packages/create-instance/add-slots.js

@@ -10,6 +10,9 @@ function addSlotToVm (vm: Component, slotName: string, slotValue: Component | st
     if (!compileToFunctions) {
       throwError('vueTemplateCompiler is undefined, you must pass components explicitly if vue-template-compiler is undefined')
     }
+    if (typeof window === 'undefined') {
+      throwError('the slots string option does not support strings in server-test-uitls.')
+    }
     if (window.navigator.userAgent.match(/PhantomJS/i)) {
       throwError('the slots option does not support strings in PhantomJS. Please use Puppeteer, or pass a component.')
     }

packages/server-test-utils/dist/vue-server-test-utils.js

@@ -37,6 +37,9 @@
     "rollup-plugin-node-resolve": "^3.0.3",
     "typescript": "^2.6.2"
   },
+  "dependencies": {
+    "@vue/test-utils": "1.0.0-beta.14"
+  },
   "peerDependencies": {
     "vue": "2.x",
     "vue-server-renderer": "2.x",

packages/server-test-utils/package.json

@@ -35,7 +35,13 @@ const rollupOptions = process.env.NODE_ENV === 'test' ? rollupOptionsTest : roll
 rollupOptions.forEach(options => {
   rollup({
     input: resolve('src/index.js'),
-    external: ['vue', 'vue-template-compiler', 'vue-server-renderer', 'cheerio'],
+    external: [
+      'vue',
+      'vue-template-compiler',
+      'vue-server-renderer',
+      'cheerio',
+      '@vue/test-utils'
+    ],
     plugins: [
       flow(),
       json(),

packages/server-test-utils/scripts/build.js

@@ -1,4 +1,4 @@
-if (!Element.prototype.matches) {
+if (typeof Element !== 'undefined' && !Element.prototype.matches) {
   Element.prototype.matches =
         Element.prototype.matchesSelector ||
         Element.prototype.mozMatchesSelector ||

packages/test-utils/dist/vue-test-utils.js

@@ -1,6 +1,5 @@
 // @flow
 
-import './warn-if-no-window'
 import './matches-polyfill'
 import './object-assign-polyfill'
 import Vue from 'vue'
@@ -12,12 +11,14 @@ import errorHandler from './error-handler'
 import { findAllVueComponentsFromVm } from './find-vue-components'
 import { mergeOptions } from 'shared/merge-options'
 import config from './config'
+import warnIfNoWindow from './warn-if-no-window'
 
 Vue.config.productionTip = false
 Vue.config.devtools = false
 Vue.config.errorHandler = errorHandler
 
 export default function mount (component: Component, options: Options = {}): VueWrapper {
+  warnIfNoWindow()
   // Remove cached constructor
   delete component._Ctor
   const vueClass = options.localVue || createLocalVue()

packages/test-utils/src/matches-polyfill.js

@@ -1,9 +1,11 @@
 import { throwError } from 'shared/util'
 
-if (typeof window === 'undefined') {
-  throwError(
-    'window is undefined, vue-test-utils needs to be run in a browser environment.\n' +
-    'You can run the tests in node using jsdom + jsdom-global.\n' +
-    'See https://vue-test-utils.vuejs.org/en/guides/common-tips.html for more details.'
-  )
+export default function warnIfNoWindow () {
+  if (typeof window === 'undefined') {
+    throwError(
+      'window is undefined, vue-test-utils needs to be run in a browser environment.\n' +
+      'You can run the tests in node using jsdom + jsdom-global.\n' +
+      'See https://vue-test-utils.vuejs.org/en/guides/common-tips.html for more details.'
+    )
+  }
 }

packages/test-utils/src/mount.js

@@ -6,7 +6,10 @@ import { renderToString } from '~vue/server-test-utils'
 
 export const vueVersion = Number(`${Vue.version.split('.')[0]}.${Vue.version.split('.')[1]}`)
 
-export const isRunningJSDOM = navigator.userAgent.includes && navigator.userAgent.includes('jsdom')
+export const isRunningJSDOM =
+  typeof navigator !== 'undefined' &&
+  navigator.userAgent.includes &&
+  navigator.userAgent.includes('jsdom')
 
 export function injectSupported () {
   return vueVersion > 2.2
@@ -24,15 +27,20 @@ export function functionalSFCsSupported () {
   return vueVersion >= 2.5
 }
 
-const shallowAndMount = [mount, shallow]
-const shallowMountAndRender = isRunningJSDOM
-  ? [mount, shallow, renderToString]
+const shallowAndMount = process.env.TEST_ENV === 'node'
+  ? []
+  : [mount, shallow]
+console.log(shallowAndMount)
+const shallowMountAndRender = process.env.TEST_ENV === 'node'
+  ? [renderToString]
   : [mount, shallow]
 
 export function describeWithShallowAndMount (spec, cb) {
-  shallowAndMount.forEach(method => {
-    describe(`${spec} with ${method.name}`, () => cb(method))
-  })
+  if (shallowAndMount.length > 0) {
+    shallowAndMount.forEach(method => {
+      describe(`${spec} with ${method.name}`, () => cb(method))
+    })
+  }
 }
 
 describeWithShallowAndMount.skip = function (spec, cb) {
@@ -80,3 +88,9 @@ export function itDoNotRunIf (predicate, spec, cb) {
     it(spec, cb)
   }
 }
+
+export function describeIf (predicate, spec, cb) {
+  if (predicate) {
+    describe(spec, cb)
+  }
+}