NodeJS 微服务开发(四)
原文:
zh.annas-archive.org/md5/4F011ED53DB2D88764152F518B13B69D译者:飞龙
第八章:介绍 Vuex
Vuex 是一个库,我们可以与 Vue.js 一起使用来管理应用程序中的不同状态。如果您正在构建一个不需要在其组件之间进行大量数据交换的小型应用程序,则最好不要使用此库。然而,随着应用程序的增长,复杂性也随之而来。应用程序中将会有几个组件,显而易见的是,您将需要从一个组件向另一个组件交换数据,或者在多个组件之间共享相同的数据。这就是 Vuex 发挥作用的时候。
Vue.js 还提供了一个emit方法来在不同组件之间传递数据,我们在之前的章节中使用过。随着应用程序的增长,当数据更新时,您可能还希望更新多个组件中的数据。
因此,Vuex 提供了一个集中存储我们应用程序中所有数据的地方。每当数据发生变化,这组新数据将存储在这个集中的地方。此外,所有想要使用该数据的组件都将从存储中获取。这意味着我们有一个单一的源来存储所有数据,并且我们构建的所有组件都将能够访问该数据。
让我们首先了解一些随 Vuex 而来的术语:
-
状态:这是一个包含数据的对象。Vuex 使用单一状态树,这意味着它是一个包含应用程序所有数据片段的单一对象。
-
获取器:用于从状态树中获取数据。
-
变化:它们是改变状态树中数据的方法。
-
操作:它们是执行变化的函数。
我们将在本章中讨论这些内容。
传统的多网页应用程序
在传统的多网页应用程序中,当我们构建一个 Web 应用程序并通过浏览器导航打开网站时,它会请求 Web 服务器获取该页面并提供给浏览器。当我们在同一网站上单击按钮时,它再次请求 Web 服务器获取另一个页面并再次提供。这个过程对我们在网站上进行的每一次交互都会发生。因此,基本上每次交互网站都会重新加载,这需要大量时间。
以下是一个解释多页面应用程序工作原理的示例图:
当从浏览器发送请求时,请求被发送到服务器。服务器然后返回 HTML 内容并提供一个全新的页面。
多页面应用程序(MPA)也可以提供一些好处。选择 MPA 还是单页面应用程序(SPA)并不是问题,而是完全取决于您的应用程序内容。如果您的应用程序包含大量用户交互,您应该选择 SPA;然而,如果您的应用程序唯一目的是为用户提供内容,您可以选择 MPA。我们将在本章后面更多地探讨 SPA 和 MPA。
单页面应用程序的介绍
与传统 MPA 相反,SPA 专门为基于 Web 的应用程序设计。当您首次在浏览器中加载网站时,SPA 会获取所有数据。一旦所有数据都被获取,您就不需要再获取任何数据。当进行任何其他交互时,该数据通过互联网获取,无需向服务器发送请求,也无需重新加载页面。这意味着 SPA 比传统 MPA 快得多。然而,由于 SPA 在第一次加载时一次性获取所有内容,因此第一页加载时间可能会很慢。一些具有 SPA 集成的应用程序包括 Gmail、Facebook、GitHub、Trello 等。SPA 的目标是通过将内容放在一个页面上,而不是让用户等待他们想要的信息,从而提高用户体验。
以下是单页面应用程序工作原理的示例图:
网站在第一次加载时就拥有了所有所需的内容。当用户点击某些内容时,它只会获取该特定区域的信息,并刷新网页的那部分。
SPA 与 MPA
SPA 和 MPA 有不同的用途。根据您的需求,您可能希望选择其中一种。在开始应用程序之前,请确保您清楚您想要构建的应用程序类型。
使用 MPA 的优点
如果您希望使应用程序对 SEO 友好,MPA 是最佳选择。Google 可以通过搜索您在每个页面上分配的关键字来抓取应用程序的不同页面,而在 SPA 中是不可能的,因为它只有一个页面。
使用 MPA 的缺点
使用 MPA 也有一些缺点:
-
与 SPA 相比,MPA 的开发工作要大得多,因为前端和后端紧密耦合。
-
MPA 具有紧密耦合的前端和后端,这使得在前端和后端开发人员之间分离工作变得更加困难。
使用 SPA 的优点
SPA 提供了许多好处:
-
减少服务器响应时间:SPA 在网站首次加载时获取所有所需的数据。使用这样的应用程序,服务器不需要重新加载网站上的资源。如果需要获取新数据,它只会从服务器获取更新的信息片段,与多页面应用程序不同,大大减少了服务器响应时间。
-
更好的用户交互:服务器响应时间的减少最终改善了用户体验。每次交互,用户都会获得更快渲染的页面,这意味着满意的客户。
-
灵活更改 UI:SPA 没有紧密耦合的前端和后端。这意味着我们可以更改前端并完全重写它,而不必担心在服务器端破坏任何内容。
-
数据缓存:SPA 将数据缓存在本地存储中。它只在第一次请求时进行单个请求并保存数据。这使得应用程序即使在断网时也可用。
使用 SPA 的缺点
使用 SPA 也有一些缺点:
-
SPA 对 SEO 不友好。由于所有操作都在单个页面上完成,可抓取性非常低。
-
由于只有一个页面链接,您无法与其他人分享特定的信息。
-
与 MPA 相比,SPA 的安全性问题要大得多。
Vuex 简介
Vuex 是一个专门设计用于与 Vue.js 构建的应用程序一起工作的状态管理库。它是 Vuex 的集中式状态管理。
Vuex 的核心概念
在介绍中,我们对这些核心概念有了一瞥。现在,让我们更详细地了解每个概念:
上图是一个简单的图表,解释了 Vuex 的工作原理。最初,所有内容都存储在状态中,这是唯一的真相来源。每个视图组件都从这个状态中获取数据。每当需要进行更改时,动作对数据进行变化并将其存储回状态中:
当我们在浏览器中打开应用程序时,所有 Vue 组件都将被加载。当我们点击一个按钮从组件中获取特定信息时,该组件会触发一个动作,对数据进行变化。当变化成功完成时,状态对象将被更新并使用新值。然后,我们可以使用新状态来为我们的组件提供显示。
创建一个简单的 Vuex 应用程序
我们将开始一个全新的应用程序来学习 Vuex 的基础知识。让我们开始吧。
让我们首先创建一个新的应用程序:
$ vue init webpack vuex-tutorial
上述代码片段将询问您有关应用程序设置的几个问题。您可以选择要保留的内容。我将选择以下配置:
安装后,导航到项目目录:
$ cd vuex-tutorial
接下来要做的是运行以下命令:
$ npm install
之后,运行以下命令:
$ npm run dev
上述命令将启动服务器并在localhost:8080上打开一个端口。
安装 Vuex
下一步是安装vuex。要做到这一点,运行以下命令:
$ npm install --save vuex
设置 Vuex
现在,让我们创建一个store文件夹来管理我们应用中的vuex。
创建存储文件
在src目录中,创建一个store文件夹和一个store.js文件。然后,在store.js文件中添加以下内容:
import Vue from 'vue'
import Vuex from 'vuex'
Vue.use(Vuex)
在上面的代码块中,Vue.use(Vuex)一行导入了 Vuex 库。没有这个,我们将无法使用任何vuex功能。现在,让我们构建一个存储对象。
状态
在同一个store.js文件中,添加以下代码行:
import Vue from 'vue'
import Vuex from 'vuex'
Vue.use(Vuex)
const state = {
count: 0
}
export const store = new Vuex.Store({
state
})
在上面的代码中,我们将名为count的变量的默认状态设置为0,并通过存储导出了一个 Vuex 状态。
现在,我们需要修改src/main.js:
// The Vue build version to load with the `import` command
// (runtime-only or standalone) has been set in webpack.base.conf with an alias.
import Vue from 'vue'
import App from './App'
import { store } from './store/store'
Vue.config.productionTip = false
/* eslint-disable no-new */
new Vue({
el: '#app',
store,
components: { App },
template: '<App/>'
})
上面的代码导入了我们刚刚创建的存储文件,我们可以在我们的 vue 组件中访问这个变量。
让我们继续创建一个组件来获取这个存储数据。当我们使用 Vue 创建一个新应用程序时,会创建一个默认组件。如果我们查看src/components目录,我们会找到一个名为HelloWorld.vue的文件。让我们使用相同的组件HelloWorld.vue,或者你也可以创建一个新的。让我们修改这个文件来访问我们在状态中定义的count。
在src/components/HelloWorld.vue中,添加以下代码:
<template>
<div class="hello">
<h1>{{ $store.state.count }}</h1>
</div>
</template>
<script>
export default {
name: 'HelloWorld',
data () {
return {
msg: 'Welcome to Your Vue.js App'
}
}
}
</script>
<!-- Add "scoped" attribute to limit CSS to this component only -->
<style scoped>
</style>
以下是最终的文件夹结构:
上述截图应该打印HelloWorld.vue组件中 count 的默认值。如果你导航到http://localhost:8080/#/,你应该看到以下截图:
在上面的截图中,我们直接使用$运算符在存储中访问了 count 变量,这不是首选的方法。我们已经学会了使用状态的基础知识。现在,访问变量的正确方法是使用getters。
Getters
getter是用来访问存储中的对象的函数。让我们创建一个getter方法来获取存储中的 count。
在store.js中,添加以下代码:
import Vue from 'vue'
import Vuex from 'vuex'
Vue.use(Vuex)
const state = {
count: 0
}
const getters = {
fetchCount: state => state.count
}
export const store = new Vuex.Store({
state,
getters
})
在上面的代码中,我们添加了一个名为fetchCount的方法,它返回count的当前值。现在,要在我们的 vue 组件HelloWorld.vue中访问这个值,我们需要使用以下代码更新内容:
<template>
<div class="hello">
<h1>The count is: {{ fetchCount }}</h1>
</div>
</template>
<script>
import { mapGetters } from 'vuex'
export default {
name: 'HelloWorld',
computed: mapGetters([
'fetchCount'
])
}
</script>
<!-- Add "scoped" attribute to limit CSS to this component only -->
<style scoped>
</style>
我们必须从 Vuex 导入一个名为mapGetters的模块,用于导入我们在store.js中创建的fetchCount方法作为getter方法。现在,通过重新加载浏览器来检查数字;这也应该打印出0的计数:
mutations
让我们继续讨论mutations。mutations是执行对存储状态进行修改的方法。我们将定义mutations,就像我们定义getters一样。
在store.js中,添加以下行:
import Vue from 'vue'
import Vuex from 'vuex'
Vue.use(Vuex)
const state = {
count: 0
}
const getters = {
fetchCount: state => state.count
}
const mutations = {
increment: state => state.count++,
decrement: state => state.count--
}
export const store = new Vuex.Store({
state,
getters,
mutations
})
在上面的代码中,我们添加了两个不同的mutation函数。increment方法将 count 增加 1,而decrement方法将 count 减少 1。这就是我们引入 actions 的地方。
动作
动作是调度 mutation 函数的方法。动作执行mutations。由于actions是异步的,而mutations是同步的,因此最好使用actions来改变状态。现在,就像getters和mutations一样,让我们也定义actions。在同一个文件中,也就是store.js中,添加以下代码行:
import Vue from 'vue'
import Vuex from 'vuex'
Vue.use(Vuex)
const state = {
count: 0
}
const getters = {
fetchCount: state => state.count
}
const mutations = {
increment: state => state.count++,
decrement: state => state.count--
}
const actions = {
increment: ({ commit }) => commit('increment'),
decrement: ({ commit }) => commit('decrement')
}
export const store = new Vuex.Store({
state,
getters,
mutations,
actions
})
在上面的代码中,我们添加了两个不同的增加和减少函数。由于这些方法提交了mutations,我们需要传递一个参数来使commit方法可用。
现在我们需要使用之前定义的actions,并在HelloWorld.vue中使其可用:
<template>
<div class="hello">
<h1>The count is: {{ fetchCount }}</h1>
</div>
</template>
<script>
import { mapGetters, mapActions } from 'vuex'
export default {
name: 'HelloWorld',
computed: mapGetters([
'fetchCount'
]),
methods: mapActions([
'increment',
'decrement'
])
}
</script>
<!-- Add "scoped" attribute to limit CSS to this component only -->
<style scoped>
</style>
为了调用这些动作,让我们创建两个按钮。在HelloWorld.vue中,让我们添加以下代码:
<template>
<div class="hello">
<h1>The count is: {{ fetchCount }}</h1>
<button class="btn btn-primary" @click="increment">Increase</button>
<button class="btn btn-primary" @click="decrement">Decrease</button>
</div>
</template>
...
上述代码添加了两个按钮,当点击时,调用一个方法来增加或减少计数。让我们也导入 Bootstrap 用于 CSS。在index.html中,添加以下代码:
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1.0">
<!-- Latest compiled and minified CSS -->
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
<title>vuex-tutorial</title>
</head>
<body>
<div id="app"></div>
<!-- built files will be auto injected -->
</body>
</html>
就是这样。现在,如果你重新加载浏览器,你应该能够看到以下结果:
当你点击相关按钮时,计数应该增加或减少。这给了你一个关于如何在应用程序中实现 Vuex 的基本思路。
在电影应用程序中安装和使用 Vuex
我们介绍了 Vuex 的基础知识——它在应用程序中的工作原理和核心概念。我们介绍了如何创建存储和突变,以及如何使用动作来调度它们,还讨论了如何使用 getter 从存储中获取信息。
在之前的章节中,我们为电影列表页面构建了一个应用程序。我们将使用相同的应用程序来使用 Vuex。我们将执行以下操作:
-
我们将定义一个存储,其中将存储所有电影
-
当添加新电影时,我们将自动将其显示在电影列表页面上,而无需重新加载页面
让我们打开应用程序并运行前端和后端服务器:
$ cd movie_rating_app
$ npm run build
$ nodemon server.js
同时,使用以下命令运行mongo服务器:
$ mongod
电影列表页面应该是这样的:
让我们开始安装vuex:
$ npm install --save vuex
检查你的package.json文件;vuex应该在依赖项中列出:
...
"vue-router": "³.0.1",
"vue-swal": "0.0.6",
"vue-template-compiler": "².5.14",
"vuetify": "⁰.17.6",
"vuex": "³.0.1"
},
...
现在,让我们创建一个文件,我们将能够将我们定义的所有getters、mutations和actions放在一起。
定义一个存储
让我们在src目录下创建一个名为store的文件夹,并在store目录中创建一个名为store.js的新文件,并添加以下代码:
import Vue from 'vue';
import Vuex from 'vuex';
import axios from 'axios';
Vue.use(Vuex);
export const store = new Vuex.Store({
})
就像我们在前面的示例应用程序中所做的那样,让我们添加一个state变量来存储电影列表页面的应用程序的当前状态。
在store.js中,添加以下代码:
import Vue from 'vue';
import Vuex from 'vuex';
import axios from 'axios';
Vue.use(Vuex);
export const store = new Vuex.Store({
state: {
movies: []
},
})
这意味着应用程序的初始状态将有一个空的电影列表。
现在,我们需要将这个store导入main.js中,以便在整个组件中都可以访问。在src/main.js中添加以下代码:
// The Vue build version to load with the `import` command
// (runtime-only or standalone) has been set in webpack.base.conf with an alias.
import 'bootstrap/dist/css/bootstrap.min.css';
import 'bootstrap-vue/dist/bootstrap-vue.css';
import BootstrapVue from 'bootstrap-vue';
import Vue from 'vue';
import Vuetify from 'vuetify';
import VueSwal from 'vue-swal';
import App from './App';
import router from './router';
import { store } from './store/store';
Vue.use(BootstrapVue);
Vue.use(Vuetify);
Vue.use(VueSwal);
Vue.config.productionTip = false;
/* eslint-disable no-new */
new Vue({
el: '#app',
store,
router,
components: { App },
template: '<App/>',
});
现在,当我们在浏览器中打开位置http://localhost:8081/时,我们需要获取电影。这是我们将要做的:
-
修改
Home.vue以调用获取电影的动作 -
创建一个将获取所有电影的动作
-
创建一个突变来存储获取的电影在电影存储中
-
创建一个 getter 方法,从状态中获取电影以显示在主页上
修改 Home.vue
让我们从修改Home.vue组件开始。使用以下代码更新文件的script部分:
<script>
export default {
name: 'Movies',
computed: {
movies() {
return this.$store.getters.fetchMovies;
}
},
mounted() {
this.$store.dispatch("fetchMovies");
},
};
</script>
在上述代码中,在mounted()方法中,我们调度了一个名为fetchMovies的动作,我们将在我们的动作中定义。
当电影成功获取时,我们将使用computed方法,它将映射到movies变量,我们将在我们的模板中使用:
<template>
<v-layout row wrap>
<v-flex xs4 v-for="movie in movies" :key="movie._id">
<v-card>
<v-card-title primary-title>
...
创建一个动作
让我们继续在store.js文件中添加一个动作:
import Vue from 'vue';
import Vuex from 'vuex';
import axios from 'axios';
Vue.use(Vuex);
export const store = new Vuex.Store({
state: {
movies: []
},
actions: {
fetchMovies: (context, payload) => {
axios({
method: 'get',
url: '/movies',
})
.then((response) => {
context.commit("MOVIES", response.data.movies);
})
.catch(() => {
});
}
}
})
在上述代码中,我们将axios部分从组件中移动了出来。当我们得到一个成功的响应时,我们将提交一个名为MOVIES的突变,然后改变状态中movies的值。
创建一个突变
让我们继续添加一个突变。在store.js中,用以下代码替换内容:
import Vue from 'vue';
import Vuex from 'vuex';
import axios from 'axios';
Vue.use(Vuex);
export const store = new Vuex.Store({
state: {
movies: []
},
mutations: {
MOVIES: (state, payload) => {
state.movies = payload;
}
},
actions: {
fetchMovies: (context, payload) => {
axios({
method: 'get',
url: '/movies',
})
.then((response) => {
context.commit("MOVIES", response.data.movies);
})
.catch(() => {
});
}
}
})
上述mutations改变了应用程序电影状态。
现在我们有了action和mutation。现在,最后一部分是添加一个getter方法,它从状态中获取movies的值。
创建一个 getter
让我们在store.js中添加我们创建的getter方法来管理应用程序的状态:
import Vue from 'vue';
import Vuex from 'vuex';
import axios from 'axios';
Vue.use(Vuex);
export const store = new Vuex.Store({
state: {
movies: []
},
getters: {
fetchMovies: state => state.movies,
},
mutations: {
MOVIES: (state, payload) => {
state.movies = payload;
}
},
actions: {
fetchMovies: (context, payload) => {
axios({
method: 'get',
url: '/movies',
})
.then((response) => {
context.commit("MOVIES", response.data.movies);
})
.catch(() => {
});
}
}
})
就是这样。当我们导航到http://localhost:8081/movies/add时,我们应该有一个功能齐全的 Vuex 实现,可以将电影获取到主页上。
让我们继续实现当我们向应用程序中添加电影时的存储。我们将按照之前的过程进行:
-
修改
AddMovie.vue以调用创建电影的action -
创建一个调用 POST API 来创建电影的
action -
创建一个
mutation来将新添加的电影存储到movies存储中
用以下代码替换AddMovie.vue中的script内容:
<script>
export default {
data: () => ({
movie: null,
valid: true,
name: '',
description: '',
genre: '',
release_year: '',
nameRules: [
v => !!v || 'Movie name is required',
],
genreRules: [
v => !!v || 'Movie genre year is required',
v => (v && v.length <= 80) || 'Genre must be less than equal to
80 characters.',
],
releaseRules: [
v => !!v || 'Movie release year is required',
],
select: null,
years: [
'2018',
'2017',
'2016',
'2015',
],
}),
methods: {
submit() {
if (this.$refs.form.validate()) {
const movie = {
name: this.name,
description: this.description,
release_year: this.release_year,
genre: this.genre,
}
this.$store.dispatch("addMovie", movie);
this.$refs.form.reset();
this.$router.push({ name: 'Home' });
}
return true;
},
clear() {
this.$refs.form.reset();
},
},
};
</script>
然后,在store.js文件中添加action和mutations:
import Vue from 'vue';
import Vuex from 'vuex';
import axios from 'axios';
Vue.use(Vuex);
export const store = new Vuex.Store({
state: {
movies: []
},
getters: {
fetchMovies: state => state.movies,
},
mutations: {
ADD_MOVIE: (state, payload) => {
state.movies.unshift(payload);
},
MOVIES: (state, payload) => {
state.movies = payload;
}
},
actions: {
addMovie: (context, payload) => {
return axios({
method: 'post',
data: payload,
url: '/movies',
headers: {
'Content-Type': 'application/json',
},
})
.then((response) => {
context.commit("ADD_MOVIE", response.data)
this.$swal(
'Great!',
'Movie added successfully!',
'success',
);
})
.catch(() => {
this.$swal(
'Oh oo!',
'Could not add the movie!',
'error',
);
});
},
fetchMovies: (context, payload) => {
axios({
method: 'get',
url: '/movies',
})
.then((response) => {
context.commit("MOVIES", response.data.movies);
})
.catch(() => {
});
}
}
})
最后,运行以下命令来构建我们的 Vue 组件的静态文件:
$ npm run build
现在,当我们登录并使用管理员用户添加电影时,电影应该被添加到数据库中,并且也会在主页上列出。
在这样一个小型应用程序中使用 Vuex 是杀鸡用牛刀。Vuex 最好的用法是在大型应用程序中,其中数据需要在多个组件之间传输和共享。这让你了解了 Vuex 的工作原理以及如何实现它。
总结
在本章中,我们讨论了 Vuex 是什么——Vuex 的核心概念状态、获取器、突变、操作,以及如何在应用程序中使用它们。我们讨论了如何构建我们的应用程序来实现 Vuex,并且在应用程序变得更大时它所带来的好处。
在下一章中,我们将介绍如何为 Vue.js 和 Node.js 应用程序编写单元测试和集成测试。
第九章:测试 MEVN 应用程序
让我们快速回顾一下我们在之前章节中所做的工作:
-
我们为不同的页面创建了不同的 Vue 组件
-
我们实现了 Vuex——用于 Vue.js 应用程序的集中状态管理,并为组件定义了状态、获取器、变化和操作
-
我们创建了控制器和模型来与 Node.js 后端交互
在本章中,我们将讨论如何编写测试代码,以确保应用程序中的一切都能正常工作。编写测试代码是任何应用程序的重要组成部分。它有助于确保我们编写的功能不会出错,并保持代码的质量。
编写测试时可以遵循不同的实践。在编写实际代码之前,首先编写测试代码总是一个很好的实践。编写测试可以确保我们的应用不会出错,并且一切都会按预期工作。
这有助于我们编写更好的代码,也有助于在问题出现之前揭示潜在问题。
编写测试的好处
在开发应用程序时编写测试代码有很多好处。其中一些如下:
-
确保代码按预期工作:它有助于确保我们在应用程序中编写的每个功能都能按预期工作。
-
提高代码质量:它提高了代码的质量。由于编写测试代码有助于在编写实际代码之前预防可能出现的缺陷,因此它提高了代码的质量。
-
提前识别错误:它有助于在早期阶段识别错误。由于为每个功能编写了测试代码,因此可以在早期识别出错误和问题。
-
为新开发人员提供文档:测试代码就像文档。如果我们需要新的开发人员开始在同一个应用程序上工作,测试代码可以帮助他们理解应用程序的工作方式,而不必查看所有应用程序代码。
-
使用测试代码加快应用程序开发速度:如果我们不编写测试代码,编写代码会更快。然而,如果跳过这个过程,后来我们将花费大部分时间来修复可能已经出现的错误,而这些错误本可以在测试代码中提前识别出来。
-
应用程序不需要运行:编写测试代码并运行它不需要应用程序运行。它也不需要构建应用程序。这显著减少了开发时间。
因此,在本章中,我们将讨论以下主题:
-
了解为什么以及如何编写单元测试和端到端测试
-
了解为 Vue.js 和 Node.js 应用程序编写测试代码的技术
-
修改应用程序的结构以实现单元测试和端到端代码
-
为 Vue 组件编写测试代码
单元测试简介
单元测试是软件开发过程中对应用程序的最小功能进行测试和检查,以检查它是否按预期工作。一个单元是任何应用程序的最小部分。为应用程序的一个单元编写的每个测试代码都是相互独立的。单元测试本身的目标是执行单独的测试,并确保每个部分都是正确的。
编写单元测试的约定
如果在编写单元测试时遵循一定的指导方针和原则,可以使代码易于维护和可读。以下是编写任何应用程序的单元测试时可以使用的一些技术:
-
单元测试应该在小单元中进行——针对单个类或方法。
-
单元测试应该在隔离环境中进行,这意味着单元测试不应依赖于任何其他类或方法,这可以通过模拟这些依赖来实现。
-
由于单元测试是在较小的部分中进行的,因此这些部分应该非常轻量级,这样测试就可以更快地运行。
-
单元测试应该测试应用程序的一个单元的行为。它应该期望某个值并返回某个输出。
-
由于单元测试是独立进行的,不同单元的测试顺序不会造成问题。
-
遵循不要重复自己(DRY);代码不应该重复。
-
添加注释以解释在哪里可以解释测试的原因,以便能够理解。
端到端测试简介
端到端测试是从头到尾测试我们的应用程序。而单元测试测试应用程序的功能是否独立工作,端到端测试检查应用程序的流程是否按预期执行。通常,端到端测试确保所有用户交互都按预期方式进行。端到端测试确保应用程序的流程按预期工作。
编写端到端测试的约定
在编写端到端测试时,需要遵循一些特定的指导方针:
-
测试用例应该考虑最终用户和真实场景
-
应该为不同的场景创建多个测试用例。
-
应该为涉及的所有软件或应用程序收集需求
-
对于每个需求,收集尽可能多的条件或场景
-
为每个场景编写单独的测试用例
我们将使用的技术
以下是我们将使用的一些软件包,用于编写应用程序的测试:
-
Mocha:JavaScript 测试框架,用于编写单元测试(
mochajs.org/) -
Chai:Node.js 框架的断言库(
chaijs.com/) -
Sinon:
sinon用于测试间谍、存根和模拟对象(sinonjs.org/) -
Nightwatch:用于编写端到端测试的 JavaScript 库(
nightwatchjs.org/) -
Karma:
karma是 JavaScript 的测试运行器(karma-runner.github.io/2.0/index.html)
我们将在学习过程中讨论这些技术。
介绍 Mocha
让我们创建一个单独的工作目录来学习如何编写测试。创建一个名为test_js的文件夹,并切换到test_js目录:
> mkdir test_js
> cd test_js
让我们还在test_js文件夹中创建一个名为test的单独文件夹:
> mkdir test
要访问mocha,您必须全局安装它:
$ npm install mocha -g --save-dev
让我们在mocha中编写一个简单的测试代码。我们将为一个简单的函数编写一个测试,该函数接受两个参数并返回参数的总和。
让我们在test文件夹中创建一个名为add.spec.js的文件,并添加以下代码:
const addUtility = require('./../add.js');
然后,从test_js文件夹运行以下命令:
$ mocha
这个测试将失败,我们需要一个名为add.js的实用程序,但它不存在。它显示以下错误:
让我们继续并编写足够的代码来通过测试。在test_js项目的根目录中创建一个名为add.js的文件,并再次运行代码,这应该通过:
让我们继续并添加逻辑到测试代码中,以检查我们的add函数。在add.spec.js中,添加以下代码:
var addUtility = require('./../add.js');
describe('Add', function(){
describe('addUtility', function(){
it('should have a sum method', function(){
assert.equal(typeof addUtility, 'object');
assert.equal(typeof addUtility.sum, 'function');
})
})
});
现在是assert库的时间了。assert库有助于检查传递的表达式是对还是错。在这里,我们将使用 Node.js 的内置断言库。
要包含assert库,让我们在add.spec.js中添加以下代码:
var assert = require("assert")
var addUtility = require("./../add.js");
describe('Add', function(){
describe('addUtility', function(){
it('should have a sum method', function(){
assert.equal(typeof addUtility, 'object');
assert.equal(typeof addUtility.sum, 'function');
})
})
});
让我们重新运行mocha。这应该再次失败,因为我们还没有向我们的模块添加方法。所以,让我们继续做。在add.js中,添加以下代码:
var addUtility = {}
addUtility.sum = function () {
'use strict';
return true;
}
module.exports = addUtility;
让我们重新运行mocha。现在规范应该通过了:
现在,让我们为 sum 方法添加功能部分。在add_spec.js中,添加以下代码:
var assert = require("assert")
var addUtility = require("./../add.js");
describe('Add', function(){
describe('addUtility', function(){
it('should have a sum method', function(){
assert.equal(typeof addUtility, 'object');
assert.equal(typeof addUtility.sum, 'function');
})
it('addUtility.sum(5, 4) should return 9', function(){
assert.deepEqual(addUtility.sum(5, 4), 9)
})
})
});
然后,查看测试;它失败了。然后,添加逻辑到我们的模块:
var addUtility = {}
addUtility.sum = function (a, b) {
'use strict';
return a + b;
}
module.exports = addUtility;
然后,重新运行mocha,测试应该通过。就是这样!:
您可以继续添加一些更多的测试用例,以确保没有任何问题。
介绍 chai
让我们讨论chai。chai是一个断言库,与mocha一起使用。我们也可以使用原生的assertion库,但chai增加了很多灵活性。
chai使得编写测试定义变得更加容易。让我们安装chai并修改上述测试,使其看起来更简单易懂:
$ npm install chai -g
我们传递了-g选项以全局安装它,因为我们没有package.json配置。
让我们在之前的测试中使用chai。在add.spec.js中,添加以下代码行:
var expect = require('chai').expect;
var addUtility = require("./../add.js");
describe('Add', function(){
describe('addUtility', function(){
it('should have a sum method', function(){
expect(addUtility).to.be.an('object');
expect(addUtility).to.have.property('sum');
})
it('addUtility.sum(5, 4) should return 9', function(){
expect(addUtility.sum(5, 4)).to.deep.equal(9);
})
it('addUtility.sum(100, 6) should return 106', function(){
expect(addUtility.sum(100, 6)).to.deep.equal(106);
})
})
});
我们已经用chai的expect()方法替换了assertion库,这使得代码变得更简单和易懂。
介绍 sinon
sinon用于测试 JavaScript 测试的间谍、存根和模拟。要了解这些,让我们继续进行我们在controller/movies.js文件中的电影评分应用程序:
const Movie = require("../models/Movie");
const passport = require("passport");
module.exports.controller = (app) => {
// fetch all movies
app.get("/movies", function(req, res) {
Movie.find({}, 'name description release_year genre', function
(error, movies) {
if (error) { console.log(error); }
res.send({
movies: movies
})
})
})
// add a new movie
app.post('/movies', (req, res) => {
const movie = new Movie({
name: req.body.name,
description: req.body.description,
release_year: req.body.release_year,
genre: req.body.genre
})
movie.save(function (error, movie) {
if (error) { console.log(error); }
res.send(movie)
})
})
}
在上述代码中,每个 API 调用都需要一个请求和一个响应对象,我们需要对其进行模拟。为此,我们有sinon。sinon为我们提供了一个机制来stub和mock请求。
sinon提供的三种主要方法是间谍、存根和模拟:
-
间谍:间谍有助于创建虚假函数。我们可以使用间谍来跟踪函数是否被执行。
-
存根:存根帮助我们使函数返回我们想要的任何内容。当我们想要测试给定函数的不同场景时,这是很有用的。
-
模拟:模拟用于伪造网络连接。它们有助于创建一个虚拟的类实例,这有助于设置预定的期望。
让我们为movies控制器中的get调用编写一个测试:
// fetch all movies
app.get("/movies", function(req, res) {
Movie.find({}, 'name description release_year genre', function
(error, movies) {
if (error) { console.log(error); }
res.send({
movies: movies
})
})
})
让我们在test/units文件夹中创建一个名为movies.spec.js的新文件:
var movies = require("./../../../controllers/movies.js");
var expect = require('chai').expect;
describe('controllers.movies.js', function(){
it('exists', function(){
expect(movies).to.exist
})
})
这个测试代码只是检查controller是否存在,当我们运行以下命令时应该通过:
$ mocha test/unit/controllers/movies.spec.js
这个命令运行我们的controller/movies.js的测试,并应该通过以下输出:
让我们首先为一个简单的方法编写一个测试。让我们创建一个响应只包含一个名称的对象的请求。在movies.js中,让我们添加以下代码来创建一个虚拟 API:
const Movie = require("../models/Movie");
const passport = require("passport");
module.exports.controller = (app) => {
// send a dummy test
app.get("/dummy_test", function(req, res) {
res.send({
name: 'John'
})
})
在上述代码中,我们有一个返回对象的简单方法。
让我们继续添加功能测试部分。我们将为/dummy_test方法编写测试。
在movies.spec.js中,让我们添加以下代码行:
var controller = require("./../../../controllers/movies.js");
let chaiHttp = require('chai-http');
let chai = require('chai');
var expect = chai.expect;
var should = chai.should();
var express = require("express");
let server = require('./../../../server.js');
var app = express();
chai.use(chaiHttp);
function buildResponse() {
return http_mocks.createResponse({eventEmitter: require('events').EventEmitter})
}
describe('controllers.movies', function(){
it('exists', function(){
expect(controller).to.exist
})
})
describe('/GET dummy_test', () => {
it('it should respond with a name object', (done) => {
chai.request(server)
.get('/dummy_test')
.end((err, res) => {
res.should.have.status(200);
res.body.should.be.an('object');
done();
});
});
});
在上述代码中,我们添加了一个名为chai-http的新包,用于模拟请求。让我们安装这个包,如下所示:
$ npm install chai-http --save
现在让我们使用以下命令运行测试:
$ mocha test/unit/controllers/movies.spec.js
上述命令应该给我们以下输出:
为 Node.js 服务器编写测试
让我们开始为我们为node服务器的后端部分构建的应用程序编写测试。
我们将使用以下文件夹结构:
test文件夹内有两个文件夹。一个用于单元测试,名为unit,另一个用于端到端测试,名为e2e。我们将从编写单元测试开始,它们位于unit目录下。命名约定是为我们将编写测试的每个文件的文件名添加.spec部分。
为控制器编写测试
让我们开始为我们添加的控制器编写测试。在test/unit/specs内创建一个名为controllers的文件夹,并在其中创建一个名为movies.spec.js的新文件。这将是我们在为任何组件创建测试文件时遵循的命名约定:控制器、模型或 Vue 组件的实际文件名后跟.spec.js。这有助于保持代码的可读性。
让我们首先回顾一下我们的movies.js文件中有什么:
var Movie = require("../models/Movie");
module.exports.controller = (app) => {
// fetch all movies
app.get("/movies", function(req, res) {
Movie.find({}, 'name description release_year genre', function
(error, movies) {
if (error) { console.log(error); }
res.send({
movies: movies
})
})
})
// add a new movie
app.post('/movies', (req, res) => {
const movie = new Movie({
name: req.body.name,
description: req.body.description,
release_year: req.body.release_year,
genre: req.body.genre
})
movie.save(function (error, movie) {
if (error) { console.log(error); }
res.send(movie)
})
})
}
这个控制器有两个方法——一个是 GET 请求,一个是 POST 请求。GET 请求是为了从数据库中获取所有电影,而 POST 请求是将给定参数的电影保存到数据库中。
让我们继续首先为 GET 请求添加规范。将以下内容添加到我们刚刚创建的movies.spec.js文件中:
const controller = require("./../../../../controllers/movies.js");
const Movie = require("./../../../../models/Movie.js");
let server = require('./../../../../server.js');
let chai = require('chai');
let sinon = require('sinon');
const expect = chai.expect;
let chaiHttp = require('chai-http');
chai.use(chaiHttp);
const should = chai.should();
前两行需要Movie组件的相应控制器和模型,我们稍后会需要。我们还需要服务器文件。
其他包,如chai、sinon、expect和should,都是断言所需的。
我们接下来需要向服务器发出请求的是一个名为chai-http的包。这个包将用于 HTTP 请求断言。因此,让我们首先使用以下命令安装这个包:
$ npm install chai-http --save
现在,我们可以继续添加第一个测试。用以下代码替换movies.spec.js中的内容:
const controller = require("./../../../../controllers/movies.js");
const Movie = require("./../../../../models/Movie.js");
let server = require('./../../../../server.js');
let chai = require('chai');
let sinon = require('sinon');
const expect = chai.expect;
let chaiHttp = require('chai-http');
chai.use(chaiHttp);
const should = chai.should();
describe('controllers.movies', function(){
it('exists', function(){
expect(controller).to.exist
})
})
前面的方法描述了movies控制器。它只是检查我们正在描述的控制器是否存在。
为了确保我们有node服务器的连接,让我们从server.js中导出服务器。将以下代码添加到server.js中:
...
const port = process.env.API_PORT || 8081;
app.use('/', router);
var server = app.listen(port, function() {
console.log(`api running on port ${port}`);
});
module.exports = server
现在,让我们使用以下命令运行测试:
$ mocha test/unit/specs/controllers/movies.spec.js
测试应该通过。
让我们继续添加 GET 请求的测试。在movies.js中,我们有以下代码:
var Movie = require("../models/Movie");
module.exports.controller = (app) => {
// fetch all movies
app.get("/movies", function(req, res) {
Movie.find({}, 'name description release_year genre', function
(error, movies) {
if (error) { console.log(error); }
res.send({
movies: movies
})
})
}) ...
}
由于这个方法从数据库中获取所有现有的电影,我们首先需要在这里构建模拟电影来进行实际测试。让我们用以下代码替换movies.spec.js中的内容:
const controller = require("./../../../../controllers/movies.js");
const Movie = require("./../../../../models/Movie.js");
let server = require('./../../../../server.js');
let chai = require('chai');
let sinon = require('sinon');
const expect = chai.expect;
let chaiHttp = require('chai-http');
chai.use(chaiHttp);
const should = chai.should();
describe('controllers.movies', function(){
it('exists', function(){
expect(controller).to.exist
})
describe('/GET movies', () => {
it('it should send all movies', (done) => {
var movie1 = {
name: 'test1',
description: 'test1',
release_year: 2017,
genre: 'test1'
};
var movie2 = {
name: 'test2',
description: 'test2',
release_year: 2018,
genre: 'test2'
};
var expectedMovies = [movie1, movie2];
sinon.mock(Movie)
.expects('find')
.yields('', expectedMovies);
chai.request(server)
.get('/movies')
.end((err, res) => {
res.should.have.status(200);
res.body.should.be.an('object');
expect(res.body).to.eql({
movies: expectedMovies
});
done();
});
});
});
})
让我们一步一步地学习我们在这里做了什么:
-
我们使用
sinon模拟了一些电影 -
我们使用
chai创建了一个 HTTP GET 请求 -
我们有三个期望:
-
请求的状态应该是
200 -
请求响应应该是一个对象
-
响应应该包含我们使用模拟创建的电影列表
让我们使用以下命令再次运行测试:
$ mocha test/unit/specs/controllers/movies.spec.js
测试应该通过。
现在让我们继续为movies.js的 POST 请求添加测试。在movies.js中,目前我们有以下内容:
var Movie = require("../models/Movie");
module.exports.controller = (app) => {
...
// add a new movie
app.post('/movies', (req, res) => {
const movie = new Movie({
name: req.body.name,
description: req.body.description,
release_year: req.body.release_year,
genre: req.body.genre
})
movie.save(function (error, movie) {
if (error) { console.log(error); }
res.send(movie)
})
})
}
POST 方法获取电影的前四个属性,并将它们保存到数据库中。让我们为这个 POST 请求添加测试。用以下代码替换movies.spec.js中的内容:
const controller = require("./../../../../controllers/movies.js");
const Movie = require("./../../../../models/Movie.js");
let server = require('./../../../../server.js');
let chai = require('chai');
let sinon = require('sinon');
const expect = chai.expect;
let chaiHttp = require('chai-http');
chai.use(chaiHttp);
const should = chai.should();
describe('controllers.movies', function(){
it('exists', function(){
expect(controller).to.exist
})
describe('/GET movies', () => {
it('it should send all movies', (done) => {
var movie1 = {
name: 'test1',
description: 'test1',
release_year: 2017,
genre: 'test1'
};
var movie2 = {
name: 'test2',
description: 'test2',
release_year: 2018,
genre: 'test2'
};
var expectedMovies = [movie1, movie2];
sinon.mock(Movie)
.expects('find')
.yields('', expectedMovies);
chai.request(server)
.get('/movies')
.end((err, res) => {
res.should.have.status(200);
res.body.should.be.an('object');
expect(res.body).to.eql({
movies: expectedMovies
});
done();
});
});
});
describe('POST /movies', () => {
it('should respond with the movie that was added', (done) => {
chai.request(server)
.post('/movies')
.send({
name: 'test1',
description: 'test1',
release_year: 2018,
genre: 'test1'
})
.end((err, res) => {
should.not.exist(err);
res.status.should.equal(200);
res.body.should.be.an('object');
res.body.should.include.keys(
'_id', 'name', 'description', 'release_year', 'genre'
);
done();
});
});
});
})
在上面的代码块中,我们为 POST 请求做了以下操作:
-
我们正在发送带有电影参数的 POST 请求:
name、description、release_year和genre -
我们有三个期望:
-
请求的状态应该是
200 -
请求响应应该是一个对象
-
响应应该包含所有四个属性,以及电影的 ID。
现在,如果我们再次运行测试,它们应该都通过。
同样,我们也可以为其他控制器添加测试。
为模型编写测试
让我们继续添加我们定义的模型的测试。在test/unit/specs内创建一个名为models的文件夹,并为我们的Movie.js模型创建一个测试文件。因此,规范文件的名称将是Movie.spec.js。
让我们先看看我们在Movie.js中有什么:
const mongoose = require('mongoose');
const Schema = mongoose.Schema
const MovieSchema = new Schema({
name: String,
description: String,
release_year: Number,
genre: String
})
const Movie = mongoose.model('Movie', MovieSchema)
module.exports = Movie
我们在这里只定义了一个Schema,它定义了Movie集合的数据类型。
让我们为这个模型添加规范。将以下内容添加到Movie.spec.js中:
var Movie = require("./../../../../models/Movie.js");
let chai = require('chai');
var expect = chai.expect;
var should = chai.should();
我们不需要在这里添加到控制器测试的所有组件。我们只需要简单的断言测试,所以我们需要Movie模型和chai方法。
让我们像为控制器一样为Movie的存在性添加测试。用以下代码替换Movie.spec.js中的内容:
var Movie = require("./../../../../models/Movie.js");
let chai = require('chai');
var expect = chai.expect;
var should = chai.should();
describe('models.Movie', function(){
it('exists', function(){
expect(Movie).to.exist
})
})
这个测试检查我们正在描述的Model是否存在。让我们使用以下命令运行测试:
$ mocha test/unit/specs/models/Movie.spec.js
测试应该通过,并输出如下:
让我们继续添加一个测试,当我们发送Movie的release_year属性为字符串时。由于我们对release_year属性进行了验证,因此向其发送字符串值应该会引发错误。
用以下代码替换Movie.spec.js中的内容:
var Movie = require("./../../../../models/Movie.js");
let chai = require('chai');
var expect = chai.expect;
var should = chai.should();
describe('models.Movie', function(){
it('exists', function(){
expect(Movie).to.exist
})
describe('Movie', function() {
it('should be invalid if release_year is not an integer',
function(done){
var movie = new Movie({
name: 'test',
description: 'test',
release_year: 'test',
genre: 'test'
});
movie.validate(function(err){
expect(err.errors.release_year).to.exist;
done();
})
})
})
})
在这里,我们准备了一个带有无效值的release_year的电影对象。我们的期望是,在验证模型时,它应该发送一个错误。
让我们运行测试,它应该通过并输出以下内容:
同样,我们也可以为其他模型添加测试。
为 Vue.js 组件编写测试
让我们继续为我们的 Vue.js 组件编写测试规范。我们将从最简单的组件开始,即Contact.vue页面。
这是我们在Contact.vue页面中目前拥有的内容:
<template>
<v-layout>
this is contact
</v-layout>
</template>
让我们稍微修改组件,以使测试更容易理解。用以下代码替换Contact.vue中的内容:
<template>
<div class="contact">
<h1>this is contact</h1>
</div>
</template>
现在,让我们首先创建必要的文件夹和文件来编写我们的测试。在test/unit/specs目录中创建一个名为Contact.spec.js的文件,并添加以下内容:
import Vue from 'vue';
import Contact from '@/components/Contact';
describe('Contact.vue', () => {
it('should render correct contents', () => {
const Constructor = Vue.extend(Contact);
const vm = new Constructor().$mount();
expect(vm.$el.querySelector('.contact h1').textContent)
.to.equal('this is contact');
});
});
在上述代码中,我们添加了一个测试,以检查vue组件Contact.vue是否呈现了正确的内容。我们期望有一个带有contact类的div元素,并且在其中应该有一个h1标签,其中应该包含this is contact内容。
现在,为了确保我们的测试运行,让我们验证我们在package.json中设置了正确的脚本来运行单元测试:
...
"scripts": {
"dev": "webpack-dev-server --inline --progress --config build/webpack.dev.conf.js",
"start": "nodemon server.js",
"unit": "cross-env BABEL_ENV=test karma start test/unit/karma.conf.js --single-run",
"e2e": "node test/e2e/runner.js",
"test": "npm run unit && npm run e2e",
"lint": "eslint --ext .js,.vue src test/unit test/e2e/specs",
"build": "node build/build.js",
"heroku-postbuild": "npm install --only=dev --no-shrinkwrap && npm run build"
},
...
现在,让我们用以下命令运行测试:
$ npm run unit
测试应该通过并输出以下内容:
让我们继续为名为AddMovie.vue的组件添加规范。在test/unit/specs文件夹中创建一个名为AddMovie.spec.js的文件,并添加以下内容:
import Vue from 'vue';
import AddMovie from '@/components/AddMovie';
describe('AddMovie', () => {
let cmp, vm;
beforeEach(() => {
cmp = Vue.extend(AddMovie);
vm = new cmp({
data: {
years: ['2018', '2017', '2016', '2015']
}
}).$mount()
})
it('equals years to ["2018", "2017", "2016", "2015"]', () => {
console.log(vm.years);
expect(vm.years).to.eql(['2018', '2017', '2016', '2015'])
})
})
这个测试说明years变量应该具有给定的值,即['2018', '2017', '2016', '2015']。
让我们添加另一个测试,以检查我们的vue组件AddMovie.js中是否存在所需的方法。将AddMovie.spec.js中的内容替换为以下代码:
import Vue from 'vue';
import AddMovie from '@/components/AddMovie';
describe('AddMovie', () => {
let cmp, vm;
beforeEach(() => {
cmp = Vue.extend(AddMovie);
vm = new cmp({
data: {
years: ['2018', '2017', '2016', '2015']
}
}).$mount()
})
it('equals years to ["2018", "2017", "2016", "2015"]', () => {
console.log(vm.years);
expect(vm.years).to.eql(['2018', '2017', '2016', '2015'])
})
it('has a submit() method', () => {
assert.deepEqual(typeof vm.submit, 'function')
})
it('has a clear() method', () => {
assert.deepEqual(typeof vm.clear, 'function')
})
})
现在,让我们用以下命令运行测试:
$ npm run unit
测试应该通过。
最后,要运行所有测试,我们只需运行以下命令:
$ npm run test
编写端到端测试
使用vue-cli命令创建的 vue.js 应用程序包含对使用Nightwatch进行端到端测试的支持。Nightwatch是一个非常简单的编写端到端测试的框架。Nightwatch使用Selenium命令来运行 JavaScript。
安装 Nightwatch
如果您还没有为e2e设置应用程序,那么让我们首先安装运行e2e测试所需的包:
$ npm install nightwatch --save
配置 Nightwatch
现在,我们需要一个配置文件来运行测试。在test文件夹中创建一个名为e2e的文件夹。添加nightwatch.conf.js文件,并添加以下内容:
require('babel-register')
var config = require('../../config')
// http://nightwatchjs.org/gettingstarted#settings-file
module.exports = {
src_folders: ['test/e2e/specs'],
custom_assertions_path: ['test/e2e/custom-assertions'],
selenium: {
start_process: true,
server_path: require('selenium-server').path,
host: '127.0.0.1',
port: 4444,
cli_args: {
'webdriver.chrome.driver': require('chromedriver').path
}
},
test_settings: {
default: {
selenium_port: 4444,
selenium_host: 'localhost',
silent: true,
globals: {
devServerURL: 'http://localhost:' + (process.env.PORT || config.dev.port)
}
},
chrome: {
desiredCapabilities: {
browserName: 'chrome',
javascriptEnabled: true,
acceptSslCerts: true
}
},
firefox: {
desiredCapabilities: {
browserName: 'firefox',
javascriptEnabled: true,
acceptSslCerts: true
}
}
}
}
在上述代码中,在test_settings属性内的设置中,我们可以看到不同浏览器的不同设置。在这种情况下,Chrome,Firefox 以及在浏览器上运行开发环境的主机和端口设置。
此外,在上述代码中,我们指定了两个文件夹:specs和custom-assertions。
-
specs文件夹包含应用程序的主要测试代码 -
custom-assertion包含一个脚本,其中包含在命令行上运行断言测试时显示的自定义消息
让我们首先设置我们的custom-assertions。在custom-assertions文件夹中创建一个名为elementCount.js的文件,并添加以下内容:
// A custom Nightwatch assertion.
// The assertion name is the filename.
// Example usage:
//
// browser.assert.elementCount(selector, count)
//
// For more information on custom assertions see:
// http://nightwatchjs.org/guide#writing-custom-assertions
exports.assertion = function (selector, count) {
this.message = 'Testing if element <' + selector + '> has count: ' + count
this.expected = count
this.pass = function (val) {
return val === this.expected
}
this.value = function (res) {
return res.value
}
this.command = function (cb) {
var self = this
return this.api.execute(function (selector) {
return document.querySelectorAll(selector).length
}, [selector], function (res) {
cb.call(self, res)
})
}
}
如果您在创建此应用程序时选择了e2e选项,那么您还应该有test/e2e/specs/test.js文件。如果没有,请继续创建此文件并将以下内容添加到其中:
// For authoring Nightwatch tests, see
// http://nightwatchjs.org/guide#usage
module.exports = {
'default e2e tests': function test(browser) {
// automatically uses dev Server port from /config.index.js
// default: http://localhost:8080
// see nightwatch.conf.js
const devServer = browser.globals.devServerURL;
console.log(devServer);
browser
.url(devServer)
.waitForElementVisible('#app', 5000)
.assert.elementPresent('.hello')
.assert.containsText('h1', 'Welcome to Your Vue.js App')
.assert.elementCount('img', 1)
.end();
},
};
这是主文件,我们将在其中为应用程序添加测试用例。
端到端测试确保我们的应用程序的所有流程是否按预期执行。当我们运行e2e测试时,我们希望应用程序的某些部分被点击并表现出应有的行为。这可以描述为测试应用程序的行为。
为了能够运行e2e测试,我们需要启动selenium-server。如果我们查看test/e2e/nightwatch.conf.js文件,可以找到一行代码:
...
selenium: {
start_process: true,
server_path: require('selenium-server').path,
host: '127.0.0.1',
port: 4444,
cli_args: {
'webdriver.chrome.driver': require('chromedriver').path
}
},
...
这意味着当我们运行e2e测试时,selenium-server会自动启动,我们不需要运行单独的服务器。端口定义了用于selenium-server的端口。您可以将其保留不变并运行测试,或者您可以更改值并自行配置。
最后,我们需要一个runner文件来运行Nightwatch测试。在e2e文件夹中创建一个名为runner.js的文件,并添加以下内容:
// 1\. start the dev server using production config
process.env.NODE_ENV = 'testing'
const webpack = require('webpack')
const DevServer = require('webpack-dev-server')
const webpackConfig = require('../../build/webpack.prod.conf')
const devConfigPromise = require('../../build/webpack.dev.conf')
let server
devConfigPromise.then(devConfig => {
const devServerOptions = devConfig.devServer
const compiler = webpack(webpackConfig)
server = new DevServer(compiler, devServerOptions)
const port = devServerOptions.port
const host = devServerOptions.host
return server.listen(port, host)
})
.then(() => {
// 2\. run the nightwatch test suite against it
// to run in additional browsers:
// 1\. add an entry in test/e2e/nightwatch.conf.js under "test_settings"
// 2\. add it to the --env flag below
// or override the environment flag, for example: `npm run e2e -- --env chrome,firefox`
// For more information on Nightwatch's config file, see
// http://nightwatchjs.org/guide#settings-file
let opts = process.argv.slice(2)
if (opts.indexOf('--config') === -1) {
opts = opts.concat(['--config', 'test/e2e/nightwatch.conf.js'])
}
if (opts.indexOf('--env') === -1) {
opts = opts.concat(['--env', 'chrome'])
}
const spawn = require('cross-spawn')
const runner = spawn('./node_modules/.bin/nightwatch', opts, { stdio: 'inherit' })
runner.on('exit', function (code) {
server.close()
process.exit(code)
})
runner.on('error', function (err) {
server.close()
throw err
})
})
我们将为此应用使用独立的 Selenium 服务器和端口5555。为此,我们首先需要安装独立服务器:
$ npm install selenium-standalone
使用以下命令运行包:
$ npx selenium-standalone start -- -port 5555
npx是运行 npm 包的命令。
由于我们使用5555端口,因此我们还需要在nightwatch.conf.js文件中进行更新。
使用以下代码更新nightwatch.conf.js中的 Selenium 配置:
...
selenium: {
start_process: false,
server_path: require('selenium-server').path,
host: '127.0.0.1',
port: 5555,
cli_args: {
'webdriver.chrome.driver': require('chromedriver').path
}
},
test_settings: {
default: {
selenium_port: 5555,
selenium_host: 'localhost',
silent: true,
globals: {
devServerURL: 'http://localhost:8081'
}
},
...
由于我们使用8081端口运行node服务器,请确保您也更新了devServerURL属性,就像在前面的代码片段中所做的那样。
现在,我们已经准备好使用以下命令运行测试:
$ npm run e2e
测试应该失败,并显示以下输出:
测试失败是因为我们的应用程序中没有具有.hello类的元素。因此,为了使测试通过,我们首先需要为元素添加标识符,这将作为e2e测试的一部分来完成,具体步骤如下。
以下是我们希望通过e2e测试捕获的内容:
-
使用
http://localhost:8081打开浏览器 -
检查是否存在具有
#inspireID 的元素。我们在App.vue中使用以下代码定义了这一点:
<template>
<v-app id="inspire">
<v-navigation-drawer
fixed
v-model="drawer"
app
>
-
检查侧边栏是否包含
Home和Contact页面链接 -
点击
Contact页面 -
联系页面应包含文本
this is contact -
点击登录页面,确保登录正常工作
-
向我们的应用程序添加电影
-
对电影进行评分
-
最后,添加用户注销应用的功能
这些是我们应用程序的重要部分。因此,我们需要为所有先前的组件添加标识符。在构建应用程序本身时,为元素添加标识符的最佳实践是定义class或id。但是,我们将为当前分配一个标识符。
在App.vue中,使用以下代码更新高亮部分:
<template>
<v-app id="inspire">
<v-navigation-drawer
fixed
v-model="drawer"
app
>
<v-list dense>
<router-link v-bind:to="{ name: 'Home' }" class="side_bar_link">
<v-list-tile>
<v-list-tile-action>
<v-icon>home</v-icon>
</v-list-tile-action>
<v-list-tile-content id="home">Home</v-list-tile-content>
</v-list-tile>
</router-link>
<router-link v-bind:to="{ name: 'Contact' }" class="side_bar_link">
<v-list-tile>
<v-list-tile-action>
<v-icon>contact_mail</v-icon>
</v-list-tile-action>
<v-list-tile-content id="contact">Contact</v-list-tile-content>
</v-list-tile>
</router-link>
</v-list>
</v-navigation-drawer>
<v-toolbar color="indigo" dark fixed app>
<v-toolbar-side-icon id="drawer" @click.stop="drawer = !drawer"></v-toolbar-side-icon>
<v-toolbar-title>Home</v-toolbar-title>
<v-spacer></v-spacer>
<v-toolbar-items class="hidden-sm-and-down">
<v-btn id="add_movie_link" flat v-bind:to="{ name: 'AddMovie' }"
v-if="current_user && current_user.role === 'admin'">
Add Movie
</v-btn>
<v-btn id="user_email" flat v-if="current_user">{{ current_user.email }}</v-btn>
<v-btn flat v-bind:to="{ name: 'Register' }" v-if="!current_user" id="register_btn">
Register
</v-btn>
<v-btn flat v-bind:to="{ name: 'Login' }" v-if="!current_user" id="login_btn">Login</v-btn>
<v-btn id="logout_btn" flat v-if="current_user" @click="logout">Logout</v-btn>
</v-toolbar-items>
</v-toolbar>
<v-content>
<v-container fluid>
<div id="app">
<router-view/>
</div>
</v-container>
</v-content>
<v-footer color="indigo" app>
<span class="white--text">© 2017</span>
</v-footer>
</v-app>
</template>
<script>
import axios from 'axios';
import './assets/stylesheets/main.css';
import bus from './bus';
export default {
name: 'app',
data: () => ({
drawer: null,
current_user: null,
}),
props: {
source: String,
},
mounted() {
this.fetchUser();
this.listenToEvents();
},
methods: {
listenToEvents() {
bus.$on('refreshUser', () => {
this.fetchUser();
});
},
async fetchUser() {
return axios({
method: 'get',
url: '/api/current_user',
})
.then((response) => {
this.current_user = response.data.current_user;
})
.catch(() => {
});
},
logout() {
return axios({
method: 'get',
url: '/api/logout',
})
.then(() => {
bus.$emit('refreshUser');
this.$router.push({ name: 'Home' });
})
.catch(() => {
});
},
},
};
</script>
此外,让我们更新AddMovie.vue中的id:
<template>
<v-form v-model="valid" ref="form" lazy-validation>
<v-text-field
label="Movie Name"
v-model="name"
:rules="nameRules"
id="name"
required
></v-text-field>
<v-text-field
name="input-7-1"
label="Movie Description"
v-model="description"
id="description"
multi-line
></v-text-field>
<v-select
label="Movie Release Year"
v-model="release_year"
required
:rules="releaseRules"
:items="years"
id="release_year"
></v-select>
<v-text-field
label="Movie Genre"
v-model="genre"
id="genre"
required
:rules="genreRules"
></v-text-field>
<v-btn
@click="submit"
:disabled="!valid"
id="add_movie_btn"
>
submit
</v-btn>
<v-btn @click="clear">clear</v-btn>
</v-form>
</template>
此外,在Login.vue中,让我们为表单字段添加相应的id:
<template>
<div>
<div class="login">
<a href="/login/facebook">Facebook</a>
<a href="/login/twitter">Twitter</a>
<a href="/login/google">Google</a>
<a href="/login/linkedin">Linkedin</a>
</div>
<v-form v-model="valid" ref="form" lazy-validation>
<v-text-field
label="Email"
v-model="email"
:rules="emailRules"
id="email"
required
></v-text-field>
<v-text-field
label="Password"
v-model="password"
:rules="passwordRules"
id="password"
required
></v-text-field>
<v-btn
@click="submit"
:disabled="!valid"
id="login"
>
submit
</v-btn>
<v-btn @click="clear" id="clear_input">clear</v-btn><br/>
</v-form>
</div>
</template>
在Movie.vue中,使用以下代码更新Rate this Movie的id:
<template>
<v-layout row wrap>
<v-flex xs4>
<v-card>
<v-card-title primary-title>
<div>
<div class="headline">{{ movie.name }}</div>
<span class="grey--text">{{ movie.release_year }} ‧ {{ movie.genre }}</span>
</div>
</v-card-title>
<h6 class="card-title" id="rate_movie" v-if="current_user" @click="rate">
Rate this movie
</h6>
<v-card-text>
{{ movie.description }}
</v-card-text>
</v-card>
</v-flex>
</v-layout>
</template>
我们已经为所有组件添加了必要的标识符。现在,让我们为先前提到的场景添加e2e测试。
用以下代码替换test/e2e/specs/test.js的内容:
// For authoring Nightwatch tests, see
// http://nightwatchjs.org/guide#usage
module.exports = {
'default e2e tests': function test(browser) {
// automatically uses dev Server port from /config.index.js
// default: http://localhost:8080
// see nightwatch.conf.js
const devServer = browser.globals.devServerURL;
console.log(devServer)
browser
.url(devServer)
.waitForElementVisible('#inspire', 9000)
.assert.elementPresent('.list')
.assert.elementPresent('.list .side_bar_link')
.assert.elementPresent('.side_bar_link #home')
.assert.elementPresent('.side_bar_link #contact')
.click('#drawer')
.pause(1000)
.click('#contact')
.pause(1000)
.assert.elementPresent('#inspire .contact')
.assert.containsText('#inspire .contact h1', 'this is contact')
.pause(1000)
.click('#login_btn')
.pause(1000)
.assert.elementCount('input', 2)
.setValue('input#email', 'get.aneeta@gmail.com')
.setValue('input#password', 'secret')
.pause(1000)
.click('#login')
.pause(1000)
.click('.swal-button--confirm')
.pause(1000)
.assert.containsText('#user_email', 'GET.ANEETA@GMAIL.COM')
.click('#add_movie_link')
.pause(2000)
.assert.elementCount('input', 3)
.assert.elementCount('textarea', 1)
.setValue('input#name', 'Avengers: Infinity War')
.setValue('textarea#description', 'Iron Man, Thor, the Hulk and the rest of the Avengers unite
to battle their most powerful enemy yet -- the evil Thanos. On a mission to collect all six
Infinity Stones, Thanos plans to use the artifacts to inflict his twisted will on reality.')
.click('.input-group__selections')
.pause(1000)
.click('.list a ')
.setValue('input#genre', 'Fantasy/Science fiction film')
.click('#add_movie_btn')
.pause(1000)
.click('.swal-button--confirm')
.pause(1000)
.click('.headline:nth-child(1)')
.pause(1000)
.assert.containsText('#rate_movie', 'Rate this movie')
.click('#rate_movie')
.pause(1000)
.click('.vue-star-rating span:nth-child(3)')
.pause(1000)
.click('.swal-button--confirm')
.pause(1000)
.click('.swal-button--confirm')
.pause(1000)
.click('#logout_btn')
.end();
},
};
要运行e2e脚本,请确保我们在package.json中设置了正确的命令:
...
"scripts": {
"dev": "webpack-dev-server --inline --progress --config build/webpack.dev.conf.js",
"start": "nodemon server.js",
"unit": "cross-env BABEL_ENV=test karma start test/unit/karma.conf.js --single-run",
"e2e": "node test/e2e/runner.js",
"test": "npm run unit && npm run e2e",
"lint": "eslint --ext .js,.vue src test/unit test/e2e/specs",
"build": "node build/build.js",
"heroku-postbuild": "npm install --only=dev --no-shrinkwrap && npm run build"
},
...
添加e2e脚本后,我们应该能够使用以下命令运行测试:
$ npm run e2e
现在,所有测试应该通过,并且输出应如下所示:
总结
在本章中,您学习了如何编写单元测试,并讨论了可以用来编写它们的不同技术,例如chai,mocha和sinon。您还学会了为控制器、模型和 Vue 组件编写测试。
在下一章中,您将学习有关持续集成以及如何使用 GitHub 将应用程序部署到 Heroku 的内容。