👕 refactor: unit tests

kazupon · kazupon · commit f399e950dd0b · 2019-07-16T02:50:17.000+09:00
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -41,7 +41,6 @@ jobs:
       # run tests!
       - run: yarn lint
       - run: yarn test
-      - run: yarn ci:coverage
 
       - codecov/upload:
-          file: ./coverage.lcov
+          file: ./coverage/lcov.info
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -3,7 +3,8 @@
 module.exports = {
   root: true,
   env: {
-    node: true
+    node: true,
+    jest: true
   },
   extends: [
     'plugin:vue-libs/recommended'
diff --git a/.gitignore b/.gitignore
@@ -1,7 +1,7 @@
 coverage
-coverage.lcov
 node_modules
 .DS_Store
+__snapshots__
 *.log
 *.swp
 *~
diff --git a/.nyc_output/.gitkeep b/.nyc_output/.gitkeep
diff --git a/jest.config.js b/jest.config.js
@@ -0,0 +1,8 @@
+'use strict'
+
+module.exports = {
+  coveragePathIgnorePatterns: [
+    'node_modules',
+    '<rootDir>/test/*.*'
+  ]
+}
diff --git a/package.json b/package.json
@@ -6,29 +6,28 @@
     "name": "kazuya kawaguchi",
     "email": "kawakazu80@gmail.com"
   },
-  "ava": {
-    "require": [
-      "@babel/register"
-    ]
-  },
   "bugs": {
     "url": "https://github.com/kazupon/vue-i18n-loader/issues"
   },
   "devDependencies": {
     "@babel/cli": "^7.5.0",
     "@babel/core": "^7.5.4",
-    "@babel/register": "^7.4.4",
-    "ava": "^1.1.0",
     "babel-eslint": "^10.0.2",
+    "babel-jest": "^24.8.0",
     "babel-preset-env": "^1.7.0",
     "conventional-changelog-cli": "^2.0.12",
     "conventional-github-releaser": "^3.1.2",
     "cross-env": "^5.2.0",
     "eslint": "^6.0.0",
     "eslint-plugin-vue-libs": "^4.0.0",
     "git-commit-message-convention": "git://github.com/kazupon/git-commit-message-convention.git",
-    "nyc": "^13.3.0",
-    "opener": "^1.5.1"
+    "jest": "^24.8.0",
+    "jsdom": "^15.1.1",
+    "memory-fs": "^0.4.1",
+    "opener": "^1.5.1",
+    "vue-loader": "^15.7.0",
+    "vue-template-compiler": "^2.6.10",
+    "webpack": "^4.35.3"
   },
   "engines": {
     "node": ">= 8"
@@ -53,14 +52,13 @@
   "scripts": {
     "build": "cross-env BABEL_ENV=production babel ./src --out-dir ./lib",
     "changelog": "conventional-changelog -i CHANGELOG.md -s -n ./node_modules/git-commit-message-convention/convention.js",
-    "ci:coverage": "nyc report --reporter=text-lcov > coverage.lcov",
     "clean": "rm -rf ./coverage && rm -rf ./lib/*.js*",
-    "coverage": "nyc report --reporter lcov && opener coverage/lcov-report/index.html",
+    "coverage": "opener coverage/lcov-report/index.html",
     "lint": "eslint ./src ./test",
     "release": "conventional-github-releaser -n ./node_modules/git-commit-message-convention/convention.js",
     "test": "npm run lint && npm run test:cover",
-    "test:cover": "cross-env BABEL_ENV=test nyc ava",
-    "test:unit": "cross-env BABEL_ENV=test ava",
+    "test:cover": "npm run test:unit -- --coverage",
+    "test:unit": "cross-env BABEL_ENV=test jest --env node",
     "watch": "cross-env BABEL_ENV=development babel ./src --out-dir ./lib --watch"
   }
 }
diff --git a/test/fixtures/basic.vue b/test/fixtures/basic.vue
@@ -0,0 +1,7 @@
+<i18n>
+{
+  "en": {
+    "hello": "hello world!"
+  }
+}
+</i18n>
diff --git a/test/fixtures/entry.js b/test/fixtures/entry.js
@@ -0,0 +1,9 @@
+import Component from '~target'
+import * as exports from '~target'
+
+if (typeof window !== 'undefined') {
+  window.module = Component
+  window.exports = exports
+}
+
+export default Component
diff --git a/test/fixtures/import.vue b/test/fixtures/import.vue
@@ -0,0 +1,2 @@
+<i18n src="./message.json">
+</i18n>
diff --git a/test/fixtures/message.json b/test/fixtures/message.json
@@ -0,0 +1,5 @@
+{
+  "en": {
+    "hello": "hello world!"
+  }
+}
diff --git a/test/fixtures/multiple.vue b/test/fixtures/multiple.vue
@@ -0,0 +1,15 @@
+<i18n>
+{
+  "en": {
+    "hello": "hello world!"
+  }
+}
+</i18n>
+
+<i18n>
+{
+  "ja": {
+    "hello": "こんにちは、世界！"
+  }
+}
+</i18n>
diff --git a/test/fixtures/special-char.vue b/test/fixtures/special-char.vue
@@ -0,0 +1,7 @@
+<i18n>
+{
+  "en": {
+    "hello": "hello\ngreat\t\"world\""
+  }
+}
+</i18n>
diff --git a/test/index.test.js b/test/index.test.js
@@ -1,87 +1,21 @@
-import test from 'ava'
-import VueI18nLoader from '../src/index'
+import { bundleAndRun } from './utils'
 
-function Loader (content, version) {
-  this.version = version
-  VueI18nLoader.call(this, content)
-}
-Loader.prototype = Object.create(Loader.prototype)
-Loader.prototype.constructor = Loader
-Loader.prototype.cacheable = function () {}
-Loader.prototype.callback = function (err, content) {
-  this._callback = { err, content }
-}
-Loader.prototype.emitError = function (message) {
-  this._emitError = message
-}
-
-function assert (t, content) {
-  const loader = new Loader(content, 2)
-  t.deepEqual(
-    loader._callback.content, `module.exports = function (Component) {
-  Component.options.__i18n = Component.options.__i18n || []
-  Component.options.__i18n.push('{\"en\":{\"hello\":\"hello world!\"}}')
-  delete Component.options._Ctor
-}\n`
-  )
-}
-
-function assertSpecial (t, content) {
-  const loader = new Loader(content, 2)
-  t.deepEqual(
-    loader._callback.content, `module.exports = function (Component) {
-  Component.options.__i18n = Component.options.__i18n || []
-  Component.options.__i18n.push('{\"en\":{\"hello\":\"hello\\\\ngreat\\\\t\\\\\"world\\\\\"\"}}')
-  delete Component.options._Ctor
-}\n`
-  )
-}
-
-test('string', t => {
-  const json = JSON.stringify({
-    en: {
-      'hello': 'hello world!'
-    }
-  })
-
-  assert(t, json)
+test('basic', async () => {
+  const { module } = await bundleAndRun('basic.vue')
+  expect(module.__i18n).toMatchSnapshot()
 })
 
-test('object', t => {
-  const json = {
-    en: {
-      'hello': 'hello world!'
-    }
-  }
-
-  assert(t, json)
+test('special characters', async () => {
+  const { module } = await bundleAndRun('special-char.vue')
+  expect(module.__i18n).toMatchSnapshot()
 })
 
-test('string with special characters', t => {
-  const json = JSON.stringify({
-    en: {
-      'hello': 'hello\ngreat\t"world"'
-    }
-  })
-
-  assertSpecial(t, json)
-})
-
-test('object with special characters', t => {
-  const json = {
-    en: {
-      'hello': 'hello\ngreat\t"world"'
-    }
-  }
-
-  assertSpecial(t, json)
+test('multiple', async () => {
+  const { module } = await bundleAndRun('multiple.vue')
+  expect(module.__i18n).toMatchSnapshot()
 })
 
-test('version 2 less', t => {
-  const loader = new Loader({})
-  t.deepEqual(loader._emitError, 'support webpack 2 later')
-  t.deepEqual(
-    loader._callback.err.message,
-    'support webpack 2 later'
-  )
+test('import', async () => {
+  const { module } = await bundleAndRun('import.vue')
+  expect(module.__i18n).toMatchSnapshot()
 })
diff --git a/test/utils.js b/test/utils.js
@@ -0,0 +1,71 @@
+import path from 'path'
+import webpack from 'webpack'
+import memoryfs from 'memory-fs'
+import { JSDOM, VirtualConsole } from 'jsdom'
+import VueLoaderPlugin from 'vue-loader/lib/plugin'
+
+export function bundle (fixture, options = {}) {
+  const compiler = webpack({
+    mode: 'development',
+    devtool: false,
+    entry: path.resolve(__dirname, './fixtures/entry.js'),
+    resolve: {
+      alias: {
+        '~target': path.resolve(__dirname, './fixtures', fixture)
+      }
+    },
+    output: {
+      path: '/',
+      filename: 'bundle.js'
+    },
+    module: {
+      rules: [{
+        test: /\.vue$/,
+        loader: 'vue-loader'
+      }, {
+        resourceQuery: /blockType=i18n/,
+        type: 'javascript/auto',
+        loader: path.resolve(__dirname, '../src/index.js')
+      }]
+    },
+    plugins: [
+      new VueLoaderPlugin()
+    ]
+  })
+
+  const mfs = new memoryfs() // eslint-disable-line
+  compiler.outputFileSystem = mfs
+
+  return new Promise((resolve, reject) => {
+    compiler.run((err, stats) => {
+      if (err) reject(err)
+      if (stats.hasErrors()) reject(new Error(stats.toJson().errors))
+      resolve({ code: mfs.readFileSync('/bundle.js').toString(), stats })
+    })
+  })
+}
+
+export async function bundleAndRun (fixture, options = {}) {
+  const { code, stats } = await bundle(fixture, options)
+
+  let dom, jsdomError
+  try {
+    dom = new JSDOM(`<!DOCTYPE html><html><head></head><body></body></html>`, {
+      runScripts: 'outside-only',
+      virtualConsole: new VirtualConsole()
+    })
+    dom.window.eval(code)
+  } catch (e) {
+    console.error(`JSDOM error:\n${e.stack}`)
+    jsdomError = e
+  }
+
+  const { window } = dom
+  const { module, exports } = window
+  const instance = {}
+  if (module && module.beforeCreate) {
+    module.beforeCreate.forEach(hook => hook.call(instance))
+  }
+
+  return Promise.resolve({ window, module, exports, instance, code, jsdomError, stats })
+}
diff --git a/yarn.lock b/yarn.lock

-Original file line number
+Diff line change
@@ @@ -0,0 +1,7 @@ @@
 +<i18n>
 +{
 +  "en": {
 +    "hello": "hello world!"
 +  }
 +}
 +</i18n>
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+<i18n src="./message.json">`
	`2`	`+</i18n>`