[E2E Testing] 如何從 cypress 9 升級 10

使用 cypress 進行 E2e Testing，針對比較常用的部分整理從 Cypress 9 升級到 10 一些異動，最大的差別是不再支援 cypress.json，並移除了 plugins 目錄。

安裝 cypress 10

npm install --save-dev cypress@10

如何升級至 cypress 10

主要針對 e2e 調整的部分進行說明，啟動 cypress 時，原本會讀取根目錄建立 cypress.json的設定，cypress 10不再支援。檔案格式可以支援 js/ts，底下範例以cypress.config.js為主，另外參數的設定也做出調整：

baseUrl

從設定在最上層，改成專屬 e2e 測試的設定，若只做 component testing 就不需要設定這個參數，讓 e2e / component testing 的設定更一目瞭然。

Before cypress.json

{
  'baseUrl': 'http://localhost:1234'
}

After cypress.config.js

const { defineConfig } = require('cypress');

module.exports = defineConfig({
  e2e: {
    baseUrl: 'http://localhost:1234'
  }
});

pluginsFile

這個設定不需要，直接移除即可。

Before cypress.json

{
  'pluginsFile': 'cypress/plugins/index.js'
}

setupNodeEvents

移除 pluginsFile 的設定後，原本的內容也直接移到 cypress.config.js 進行設定，過去版本9若同時使用 component / e2e testing，可以將設定直接分開來寫。

Before cypress/plugins/index.js

module.exports = (on, config) => {
  if (config.testingType === 'component') {
    // component testing dev server setup code
    // component testing node events setup code
  } else {
    // e2e testing node events setup code
  }
};

After cypress.config.js

const { defineConfig } = require('cypress');

module.exports = defineConfig({
  component: {
    devServer(cypressConfig) {
      // component testing dev server setup code
    },
    setupNodeEvents(on, config) {
      // component testing node events setup code
    },
  },
  e2e: {
    setupNodeEvents(on, config) {
      // e2e testing node events setup code
    },
  },
});

完整內容請參考官網升級指引

相關文章：

• e2e 測試工具 Cypress 安裝及介紹
• Cypress+Vue 元件測試 (component testing)

Vue3.2 <script setup> 實作 TodoMVC

Vue3.2開始將 <script setup> 移除experimental status，和setup()區別在有許多 option API 有了替代方案，props, emit 也可以寫在 setup`，variable 或 function 也不需要透過 return 才能讓 <template> 使用，哇！寫法怎麼好像有點既是感呢

下面會利用 TodoMVC 的練習，比較與統整 <script setup> 和 setup() 常用的方法的差異。

TodoMVC 完整程式碼上傳至 Github (連結)。

data

setup

<script>
import { ref } from 'vue';

export default {
    setup() {
        const newTodo = ref(undefined);

        return {
            newTodo,
        };
    },
}
</script>

<script setup>

宣告 ref 沒有差異，差在需不需要 return

<script setup>
import { ref } from 'vue';

const newTodo = ref(undefined);
</script>

component

<template>
    <TodoListEditor />
</template>

setup

<script>
import TodoListEditor from 'components/TodoListEditor.vue';

export default {
    components: {
        TodoListEditor,
    },
}
</script>

<script setup>

import 之後就可以直接在 <template> 使用

<script setup>
import TodoListEditor from 'components/TodoListEditor.vue';
</script>

props

setup

<script>
export default {
    props: {
        todoList: {
            required: true,
            type: Array,
        },
    },
}
</script>

<script setup>

defineProps 裡面內容與之前 props 相同

<script setup>
const props = defineProps({
    todoList: {
        required: true,
        type: Array,
    },
});
</script>

emit

setup

<script>
export default {
    emits: ['remove:todo', 'update:todo'],
    setupt(props, {emit}) {
        function removeTodoItem(id){
            emit('remove:todo', id);
        }
    },
}
</script>

<script setup>

defineEmits 裡面內容與之前 emits 相同

<script setup>
const emit = defineEmits(['remove:todo', 'update:todo']);

function removeTodoItem(id){
    emit('remove:todo', id);
}
</script>

directive

directive是所有寫法中我最不適應的，底下是頁面載入時可以有 autofocus 的效果，可以根據不同 lifecyle 定義，利如 mouted

<input
    v-model="newTodo"
    v-focus>

setup

<script>
const focus = {
    mounted: el => el.focus(),
};

export default {
    directives: {
        focus,
    },
}
</script>

<script setup>

<script setup>
const vFocus = {
    mounted: el => el.focus(),
};
</script>

lifecycle

基本上沒有什麼區別

setup

<script>
import {onMounted} from 'vue';

export default {
    setup() {
        onMounted(() => {
            // to something
        });
    },
}
</script>

<script setup>

<script setup>
import {onMounted} from 'vue';

onMounted(() => {
    // to something
});
</script>

mocha + webpack 的 Vue3 元件單元測試

先說結論，我認為不適合用 mocha 進行 vue3 單元測試(@vue/test-utils)，反覆查了很久的資料，相關的套件支援度不足等有重重的障礙，根據 @vue/test-utils 目前提供的測試範例，選擇 Vitest 會更適合。

完整程式碼上傳至 Github (連結)。

一、安裝

首先，第一個問題就是 vue 的版本不能太新，目前只支援 3.0.7，因此對應安裝了相同版本的 @vue/server-renderer

npm install --save-dev @vue/server-renderer@3.0.7

再來請安裝 webpck 和 mocha，mochapack，mochapack 是用來讀取 webpack 設定將元件 render 出來的套件，可支援 webpack5 和 mocha 9

npm install --save-dev webpack mocha mochapack

其他有兩個類似的套件：

• mocha-webpack: mocha: '>=4 <=5', webpack: '^4.0.0'
• instant-mocha: mocha: '^6.1.4 || ^8.3.2', webpack: '^4.40.0 || ^5.0.0'

mochapack 是由 mocha-webpack 延伸而來的，三者用法都非常接近，但上述兩個對 webpack 和 mocha 版本的支援度都比 mochapack 差

再來請安裝 vue3 官方的元件測試套件 @vue/test-utils

npm install --save-dev @vue/test-utils

mocha 不像是 jest 已經內建支援 jsdom、assertion ，所以要另外安裝

npm install --save-dev webpack-node-externals jsdom-global
npm install --save-dev expect

二、設定

新增測試專用的 webpack 設定檔 webpack.config-test.js

// webpack.config-test.js

const nodeExternals = require('webpack-node-externals');
const { VueLoaderPlugin } = require('vue-loader');

module.exports = {
    mode: 'development',
    target: 'node',  // webpack should compile node compatible code
    externals: [nodeExternals()], // in order to ignore all modules in node_modules folder
    devtool: 'inline-cheap-module-source-map',
    module: {
        rules: [
            {
                test: /\.vue$/,
                loader: 'vue-loader',
            },
            {
                test: /\.css$/i,
                use: ['style-loader', 'css-loader'],
            },
        ],
    },
    plugins: [
        new VueLoaderPlugin(),
    ],
};

設定 jsdom 設定檔 src/tests/setup.js

// src/tests/setup.js

require('jsdom-global')();

最後，請到 package.json 設定 script 指令

Usage: mochapack [options] [<file|directory|glob> ...]

Options
　--webpack-config　　path to webpack-config file
　--require, -r　　　　　require the given module

{
  "scripts": {
    "test": "npx mochapack --webpack-config webpack.config-test.js --require src/tests/setup.js src/tests/**/*.spec.js",
  }
}

三、執行

新增測試(範例請參考 Counter.spec.js)後,執行指令即可

npm run test

四、限制

1. 無法支援目前 vue 最新版本 3.2.37，發現底下錯誤訊息:

ReferenceError: SVGElement is not defined

2. 無法支援 SFC ，發現底下警告訊息:

[Vue warn]: Component is missing template or render function.

參考文件:

• 用 Mocha 和 webpack 測試單文件組件
• taro新建vue3项目后，编译成小程序端报错ReferenceError: SVGElement is not defined
• mochapack 文件

【升版指南】Vue3 非兼容的特性 v-model 跟 Vue2 完全不一樣

vue2 v-model 的使用方式在這篇「[Vue.js] 如何在component自訂v-model」介紹，簡單說就是結合v-model其實綁定了名為 value 的 props 和 input 的 emit事件，因此所謂的 v-model 就是一個父子元件的雙向溝通，在 vue2 兩者是相同的：

<input v-model="username">

<input :value="username"
       @input="(value)=>(username=value)">

但是！

vue3 props 預設名稱從 value 改為 modelValue ，emit 名稱則從 input 改為 update:modelValue，如果用錯了就無法達成雙向的綁定。

<input v-model="username">

<input :model-value="username"
       @update:modelValue="(value)=>(username=value)">

在 vue2 中可以用自訂 model 來自訂 props 和 emit 名稱，在 Vue3 移除不再支援，如果不想使用 modelValue 的話，在 Vue3 可以這樣寫：

<MyComponent v-model:username="username" />

<MyComponent
       :username="username"
       @update:username="(value)=>(username=value)" />

元件本身應該增加這個 props,更新時會呼叫 update:username

// MyComponent.vue
props: {
    username: {
        type: String,
        required: true,
    },
}

跟 vue2 .sync 有點相似，vue3不再支援 .sync ，寫法會是 v-model:[NAME] 後面 Name 就是想自訂的名稱，更新時update:[NAME]，以事件名稱來看不算是完全客製，須按照規則觸發向上更新

但這個特性最棒的是支援多組 v-model ，你可以這樣寫：

<MyComponent
       v-model:username="username"
       v-model:password="password" />

總結將 vue2 升至 vue3，v-model 應該注意三個地方：

1. 不再使用 .sync

<MyComponent :username.sync="name" />

<!-- to be replaced with -->

<MyComponent v-model:username="name" />

2. 將所有的 value 和 input 和 modelValue 和 update:modelValue

<MyComponent v-model="name" />

// MyComponent.vue

export default {
  props: {
    modelValue: String, // "vaule" is replaced
  },
  emits: ['update:modelValue'],
  methods: {
    changeName(name) {
      this.$emit('update:modelValue', name);  // "input" is replaced
    },
  },
};

3. 不再使用 model

直接用 v-model ，v-model:[Name]

參考文章:https://v3-migration.vuejs.org/breaking-changes/v-model.html

Github Action 自動部署 github-pages

Github pages 適合展示靜態頁面，只要在 github 建立 gh-pages 分支，可依據用戶名稱和repo名稱來開啟頁面。

https://[USER_NAME].github.io/[REPO_NAME]/

以這個專案為例

https://github.com/chenuin/JavaScript30

路徑會是

https://chenuin.github.io/JavaScript30/

使用 JamesIves/github-pages-deploy-action@v4.3.3 有兩個必填參數：

• branch: 分支
• folder: 目錄，.代表整個repo根目錄

參數詳細說明請參考這裡，在 repo 裡新增 github action (連結):

name: Github pages

on:
  # Triggers the workflow on push events but only for the "master" branch
  push:
    branches: master

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout 🛎️
        uses: actions/checkout@v3

      - name: Deploy 🚀
        uses: JamesIves/github-pages-deploy-action@v4.3.3
        with:
          branch: gh-pages
          folder: .
          token: ${{ secrets.GH_PAT }}

GH_PAT 設定方式，請先至 Settings => Developer settings => Personal access tokens (或下方連結)，按右上角新增Token，scopes 可直接勾選 repo 並將Token複製。

https://github.com/settings/tokens

再到專案的 Settings => Secrets => Actions (或下方連結)，按右上角新增，命名 GH_PAT 並將剛剛複製的Token貼上。

https://github.com/[USER_NAME]/[REPO_NAME]/settings/secrets/actions

EASY!!

相關文章：

• Github Actions 自動 Jekyll 專案部屬 Github Pages
• [Github] 在github.io建立免費的網站

Vue3+jest 測試 composable 範例

Vue3 的 composable 乍看下和 mixin 用途很類似，可以提供各個元件共用程式碼。但與 mixin 相比，composable 主要有三個優勢：

第一，元件可以很明確的區分使用的 composable 來源，當使用的 mixin 一多時，追朔來源相對困難，無法一眼看出由哪個 mixin 實作。

第二，多個 mixin 無法確保使用了相同的名稱，可能造成覆蓋，但 composable 即使有相同的名稱，也能透過結構式賦值、重新命名。

最後，多個 mixin 需要交互作用時，通常會使用相同的參數命名來達到這個目的，隱性的耦合使得辨識和debug難度增加，composable可藉由其一的回傳值，作為其他composable輸入的參數達到共享的目的。(參考資料)

安裝 Jest 測試 vue 時，首先要注意版本，請參考下面的對照表安裝套件：

Vue version Jest Version npm Package

Vue 2 Jest 26 and below vue-jest@4

Vue 3 Jest 26 and below vue-jest@5

Vue 2 Jest 27 and above @vue/vue2-jest@27

Vue 3 Jest 27 and above @vue/vue3-jest@27

Vue 2 Jest 28 and above @vue/vue2-jest@28

Vue 3 Jest 28 and above @vue/vue3-jest@28

composable 的測試主要分成兩種，第一種元件比較無關，可以當作普通的 js code 測試。

// counter.js
import {ref} from 'vue';

export function useCounter() {
  const count = ref(0);
  const increment = () => count.value++;

  return {
    count,
    increment,
  };
};

// counter.test.js
import {useCounter} from './counter.js';

test('useCounter', () => {
  const {count, increment} = useCounter()
  expect(count.value).toBe(0);

  increment();
  expect(count.value).toBe(1);
});

如果 composable 牽涉到元件 lifecyle hooks 或是 provide/inject 時，需要依附一個元件進行測試。

// test-utils.js
import {createApp} from 'vue';

export function withSetup(composable) {
  let result;

  const app = createApp({
    setup() {
      result = composable();
      // suppress missing template warning
      return () => {};
    },
  });

  app.mount(document.createElement('div'));
  // return the result and the app instance
  // for testing provide / unmount
  return [result, app];
};

// counter.js
import {ref, onMounted} from 'vue';

export function useCounter() {
  const count = ref(0);
  const increment = () => count.value++;
  
  onMounted(() => {
    increment();
  });

  return {
    count,
    increment,
  };
};

result是 composable 的回傳值(return)，測試裡面 app.mount();，將執行 onMounted：

// counter.test.js
import {withSetup} from './test-utils';
import {useCounter} from './counter.js'

test('useCounter', () => {
  const [result, app] = withSetup(() => useCounter());

  // run assertions
  expect(result.count.value).toBe(0);

  // trigger onMounted hook if needed
  app.mount();

  expect(result.count.value).toBe(1);
});

另外還有一個常犯的錯誤，先看 composable 程式碼，有一個 computed 使用 formatFn 轉換 list：

// useListFormatter.js
import {computed, unref} from 'vue';

export function useListFormatter(list, formatFn) {
  const formattedList = computed(() => (
    unref(list).map(item => formatFn(item))
  ));

  return {
    formattedList,
  };
};

測試時需要注意回傳值被使用之前，formattedList 不會被執行。

// useListFormatter.test.js
import {useListFormatter} from './useListFormatter.js';

test('useListFormatter', () => {
  const list = ['a', 'b'];
  const formatFn = jest.fn();

  formatFn.mockImplementation(value => `new-${value}`)

  const {formattedList} = useListFormatter();
  
  // Don't do it! formatFn won't be excuted until formattedList is called.
  // expect(formatFn).toHaveBeenCalled();
  
  expect(formatFn).not.toHaveBeenCalled();

  expect(formattedList.value).toEqual(['new-a', 'new-b']);
  expect(formatFn).toHaveBeenCalledTimes(2);
  expect(formatFn).toHaveBeenNthCalledWith(1, 'a');
  expect(formatFn).toHaveBeenNthCalledWith(2, 'b');
});

參考資料：

https://vuejs.org/guide/scaling-up/testing.html#testing-composables

測試套件 Jest mock 基礎概念及 spyOn, fn 範例程式

當測試的對象有使用其他引用(import)時，我們希望能做為控制變因，設法聚焦測試的對象。Jest是常用的js單元測試套件，我們會 mock 方法spyOn、fn來達成這個目的，Jest 安裝可以參考「[JavaScript] 安裝Jest單元測試」，底下說明幾種常用的情境。

jest.spyOn(object, methodName)

1. [基本用法] 監聽

單純測試某個method被呼叫的次數，或(官方說明)，舉例下面範例是輸入兩個數字，並隨機輸出這個範圍內的數字。

// getRandonInt.js

export const getRandonInt = (min, max) => (
    Math.floor(Math.random(max) * (max - min) + min)
);

例如 Math.floor

jest.spyOn(Math, 'floor')

同理 Math.random ，所以可以將測試寫成：

import {getRandonInt} from './getRandonInt.js';

test('Should get random number between input min and max', () => {
    const spyFloor = jest.spyOn(Math, 'floor');
    const spyRandom = jest.spyOn(Math, 'random');

    const result = getRandonInt(1, 100);

    expect(result).toBeGreaterThanOrEqual(1);
    expect(result).toBeLessThanOrEqual(100);

    expect(spyFloor).toHaveBeenCalledTimes(1);

    expect(spyRandom).toHaveBeenCalledTimes(1);
    expect(spyRandom).toHaveBeenCalledWith(100);
});

因此可看到我們監聽的兩個method，第一 toHaveBeenCalledTimes 分別被呼叫的次數，及 toHaveBeenCalledWith 傳入的參數。

2. [進階] 替換回傳值

改變某個method的回傳值，以下面的範例是希望輸入一個值後，可以隨機產生一個數字並得到兩者相乘的結果

// multiplyNumber.js

export const multiplyNumber = num => (
    Math.random(10) * num
);

如果希望控制隨機產生的數字，可以使用 mockImplementation

import {multiplyNumber} from './multiplyNumber.js';

test('Should get the multiple of random number and input num', () => {
    const spyRandom = jest.spyOn(Math, 'random')
        .mockImplementation(() => 5);

    expect(Math.random(10)).toBe(5);
    expect(multiplyNumber(1000)).toBe(5000);

    spyRandom.mockRestore();

    expect(Math.random(10)).not.toBe(5);
});

可以理解成實際我們已經將 Math.random 變成:

Math['random'] = () => 5;

// you could definitely get parameter when method was called
// so implementation would be like ...
// Math['random'] = a => (a + 1);

mockRestore()可以恢復原本method的功能，因此直到我們呼叫 mockRestore()為止，無論我們呼叫幾次 Math.random ，都會按照我們的設定回傳數字 5。

假設希望這個設定是一次性的，則可以改用 mockImplementationOnce，這個寫法比較不容易出錯，是比較推薦的用法。

jest.spyOn(Math, 'random')
    .mockImplementationOnce(() => 5);
    .mockImplementationOnce(() => 20);

expect(Math.random(10)).toBe(5);
expect(Math.random(10)).toBe(20);

jest.fn(implementation)

用法和 spyOn非常類似，可以用來驗證呼叫次數及傳入參數等

const mockFn = jest.fn();

mockFn(100);

expect(mockFn).toHaveBeenCalled();
expect(mockFn).toHaveBeenCalledTimes(1);
expect(mockFn).toHaveBeenCalledWith(100);

驗證的部分，toHaveBeenCalledTimes和toHaveBeenCalledWith這兩個還有另一個寫法：

expect(mockFn).toHaveBeenCalledTimes(1);
expect(mockFn.mock.calls.length).toBe(1);

expect(mockFn).toHaveBeenCalledWith(100);
expect(mockFn.mock.calls[0][0]).toBe(100);

calls是一個陣列，長度等同於呼叫的次數，陣列內每一個位置也都是一個陣列，每個位置則對應到呼叫時的參數內容。可以實際印出得到 calls = [[100]]，所以calls[0][0]代表的是第一次呼叫時第一個參數是什麼

依照 multiplyNumber.js 的範例，可以使用fn達到同樣的效果，測試結束前也要記得呼叫mockRestore免得影響其他測試‧。

const spyRandom = jest.fn(() => 5);
Math['random'] = spyRandom;

const spyRandom = jest.fn()
    .mockImplementation(() => 5);
Math['random'] = spyRandom;

const spyRandom = jest.fn()
    .mockReturnValueOnce(5);
Math['random'] = spyRandom;

jest.mock(module)

當測試有引入(import)其他模組、函式時，可以使用mock來替換回傳內容，我們稍微改寫剛剛的 multiplyNumber：

import {getRandonInt} from './combineArray.js';

export const multiplyNumber = (min, max, num) => (
    getRandonInt(min, max) * num
);

為了清楚此時的getRandonInt已經被替換掉，我們刻意重新命名，在測試裡將回傳值設定為數字 20

import {getRandonInt as mockGetRandonInt} from './getRandonInt';
import {multiplyNumber} from './multiplyNumber';

jest.mock('./getRandonInt');

test('Should get the multiple of random number and input num', () => {
    mockGetRandonInt.mockReturnValueOnce(20);

    expect(multiplyNumber(1, 2, 3)).toBe(60);

    expect(mockGetRandonInt).toHaveBeenCalledTimes(1);
    expect(mockGetRandonInt).toHaveBeenCalledWith(1, 2);
});

另外可以利用requireActual可以取得原始的功能,當我們只需要部份取代時，可以藉此替換部分的內容，其餘皆按照原設定

const {getRandonInt} = jest.requireActual('../src/libs/combineArray');

mockGetRandonInt.mockImplementationOnce((a, b) => a + b);

expect(getRandonInt(1, 2)).toBeLessThanOrEqual(2);

expect(mockGetRandonInt(1, 2)).toBe(3);
expect(mockGetRandonInt).toHaveBeenCalledTimes(1);

最後一個重點，建立和初始化一個class的物件時，可以透過instances來得到建立的物件，它是一個陣列，會依照建立順序放在對應的位置上。

const myMock = jest.fn();

const a = new myMock();

expect(a).toBe(myMock.mock.instances[0]);

參考資料：

• https://jestjs.io/docs/mock-functions
• https://jestjs.io/docs/mock-function-api
• https://jestjs.io/docs/es6-class-mocks
• https://jestjs.io/docs/jest-object

Cypress+Vue 元件測試 (component testing)

接續「e2e 測試工具 Cypress 安裝及介紹」，除了用在實際開啟瀏覽器的測試，cypress也支援元件測試，需要安裝相關的套件將元件render出來。

安裝

npm install --save-dev cypress @cypress/vue @cypress/webpack-dev-server webpack-dev-server

如果是 Vue3 ，請記得把 @cypress/vue 換成：

npm install --save-dev @cypress/vue@next

設定

先到 cypress/plugins/index.js 的註冊 dev-server:start 事件，再來要注意 require('@vue/cli-service/webpack.config.js')這段，你的專案不見得有安裝這個套件，你可以建立自己的webpack設定，並替換上正確的路徑。

// cypress/plugins/index.js

const { startDevServer } = require('@cypress/webpack-dev-server');
// Vue's Webpack configuration
const webpackConfig = require('@vue/cli-service/webpack.config.js');

module.exports = (on, config) => {
  on('dev-server:start', options =>
    startDevServer({ options, webpackConfig });
  );
};

若我們要測試的元件內容為：

<!-- Button.vue -->
<template>
  <button>
    <slot />
  </button>
</template>

在測試時，vue2和vue3引入 mount 的寫法相同，並且將設定元件所需的輸入

import {mount} from '@cypress/vue'
import Button from './Button.vue';

it('Button', () => {
  mount(Button, {
    slots: {
      default: 'Test button',
    },
  });

  cy.get('button').contains('Test button').click();
});

執行

提供 GUI 介面操作

npx cypress open-ct

無GUI，在 Terminal 上執行

npx cypress run-ct

參考文件: https://docs.cypress.io/guides/component-testing/introduction

e2e 測試工具 Cypress 安裝及介紹

e2e測試(End-to-End testing)是模擬使用者的行為，實際打開瀏覽器操作頁面的測試方式，因此不限於vue, react的專案，e2e的測試可以反映出頁面在不同瀏覽器的執行情形。

Cypress便是其中一個常見工具，Cypress在安裝上簡單，語法採用 mocha 的句法、chai 的斷詞(expect, should, assert)，撰寫的方式跟 unit test 相似。

安裝

進到想要測試的專案目錄內，使用 npm 安裝。(官網說明)

npm install cypress --save-dev

接著在目錄裡，建立先建立一個 cypress.json，內容放一個空物件，此時你可以直接執行下面的命令(官網說明)：

npx cypress open

會發現多了一個 cypress/ 的資料夾，裡面有四個目錄：

• integration: 主要的測試檔案
• fixtures: 固定的資料
• plugins: 主要有 on 定義全局的不同時間點的執行工作，以及 config 提供全局使用的參數，如常用的 env
• support: 可提供自定義的指令、或引入擴充的指令，供撰寫測試檔案使用

Cypress.json 與環境變數(.env)

使用 cypress 都必須在專案的根目錄裡新增 cypress.json，如果直接放 {} 空物件，代表直接使用預設值。

下面是我的設定，從字面上不難理解設定的內容，第一個testFiles是測試的檔案名稱，接著各個目錄的路徑，video是 Boolean 決定是否錄製測試過程的影片，screenshotOnRunFailure也是 Boolean 是否在執行失敗時擷取畫面。

{
    "testFiles": "**/*.spec.js",
    "integrationFolder": "resources/cypress/integration",
    "componentFolder": "resources/cypress/components",
    "fixturesFolder": "resources/cypress/fixtures",
    "pluginsFile": "resources/cypress/plugins",
    "supportFile": "resources/cypress/support",
    "video": false,
    "screenshotOnRunFailure": false
}

除了cypress基本的設定，常常也需要讀取環境設定檔(.env)，假設內容如下(官方說明)：

APP_URL=https://chenuin.github.io/
USER_NAME=chenuin

在plugins/index.js可以設定：

// plugins/index.js

require('dotenv').config();

module.exports = (on, config) => {
    config.baseUrl = process.env.APP_URL;

    config.env.USER_NAME = process.env.USER_NAME;

    return config;
}

測試檔案需要使用時，可以直接呼叫：

Cypress.config('baseUrl')

Cypress.env('USER_NAME')

打開GUI，點選上方的 Settings 可以看到設定的結果，上面的顏色可以區分目前的設定是讀取哪裡，像是 baseUrl 是紫色的 plugin，

因此，可以知道下面兩種寫法都可以達到相同的效果：

// plugins/index.js
config.baseUrl = process.env.APP_URL;


// cypress.json
{
    "baseUrl": "https://chenuin.github.io/"
}

執行

提供 GUI 介面操作

npx cypress open

無GUI，在 Terminal 上執行

npx cypress run

訪問頁面 visit

測試的第一步常常是先進入某一個頁面，通常專案內都在相同的Domain下，如果有設定 baseUrl，Cypress會直接將設定作為前綴，導到相應的頁面，在寫法上簡潔許多。

// https://chenuin.github.io/webpack/2021/08/08/webpack5-getting-started.html

cy.visit('/webpack/2021/08/08/webpack5-getting-started.html')

若未設定，需要傳入完整的路徑，或者cypress會嘗試在你的web server上找到對應位置的頁面。(官方說明)

intercept與fixtures的使用

使用 intercept 來監聽由頁面上請求(request)及回應(response)，下面三者是相同的意思：

cy.intercept('/users/**')
cy.intercept('GET', '/users/**')
cy.intercept({
  method: 'GET',
  url: '/users/**',
})

你也可以為這個路由(route)新增別名(alias)，除了方便辨識外，如果需要在request後執行的工作，可以使用下面的寫法：

cy.intercept('POST', '/users').as('createUser');

// once a request to create user responds, 'cy.wait' will resolve
cy.wait('@createUser')

GUI上可以看到這個 route 表格

執行此請求時會留下Log記錄，所有被監聽的路由會列在route表格，表格上可以看到所有route被呼叫的次數(表格最右側的數字)，對應的別名(alias)是什麼。

上面 Stubbed 是代表回應(response)是否被取代了，這個是很好用的功能，例如：當我們將 users 這個請求的回應，取代為一個列表：

// requests to '/users' will be fulfilled
// with a body of list: ['John', 'Ben', 'Mary]

cy.intercept(
  '/users',
  ['John', 'Ben', 'Mary],
)

或者可以使用 fixture ，後面填寫 fixture/ 目錄裡的檔案名稱。

// requests to '/users' will be fulfilled
// with the contents of the "users.json" fixture

cy.intercept(
  '/users',
  { fixture: 'users.json' },
)

(官方說明)

ESLint設定

請在 .eslintrc.js 加上設定，不需要安裝任何套件：

module.exports = {
  extends: [
    'plugin:cypress/recommended',
  ],
};

js 單元測試套件 Macha+Chai (es6 語法 Babel 設定)

安裝

首先安裝 mocha (官網)和 chai (官網)

npm install mocha chai --save-dev

chai 是一種斷言庫(Assertion Library)，mocha 不像是jest已經內建，可以自行決定要使用哪一種套件，chai是其中最常見的一種。

在package.json加入測試指令

"scripts": {
  "test": "npx mocha"
}

設定 Babel

安裝 Babel，再來的說明都會直接使用es6的語法，如果不需要，可以略過這部分。

npm install @babel/core @babel/preset-env @babel/register --save-dev

接著在根目錄新增 babel.config.js

// babel.config.js

module.exports = {
    presets: [
        '@babel/preset-env',
    ],
};

接著在根目錄新增 .mocharc.js，spec是設定 mocha 執行測試的檔案，預設為 test/ ，這裡設定成自動讀取 src/test/ 底下所有以 spec.js 為結尾的檔案。

require可以接陣列設定所需的 module

// .mocharc.js

module.exports = {
    spec: ['src/test/*.spec.js'],
    require: ['@babel/register'],
};

.mocharc.js 是 mocha 執行時會自動讀取的設定檔，也支援json 或 yaml(說明)，可以選擇喜歡的格式新增，設定檔的內容可以參考：https://github.com/mochajs/mocha/tree/master/example/config

設定參考資料：
https://github.com/mochajs/mocha-examples/tree/master/packages/babel

建立測試

新增一個簡單的測試

// src/test/array.spec.js

import chai from 'chai';

describe('Array', () => {
  describe('#indexOf()', () => {
    it('should return -1 when the value is not present', function() {
      chai.assert.equal([1, 2, 3].indexOf(4), -1);
    });
  });
});

馬上執行試試看

npm run test

應該會看到下面的資訊，

> vue3-webpack5-template@1.0.0 test
> npx mocha


  Array
      #indexOf()
          ✔ should return -1 when the value is not present

1 passing (8ms)

完成第一個測試囉！

支援 async/await

請安裝套件

npm install @babel/plugin-transform-runtime --save-dev

把套件加到 babel.config.js的 plugin 設定

module.exports = {
    require: ['@babel/register'],
    plugins: ['@babel/plugin-transform-runtime'],
};

Root Hooks

mocha 提供的 hook 包含 before(), after(), beforeEach(), and afterEach()，從語意應該不難看出用途，前兩個只會執行一次，後兩個則是每項測試都會執行。

若要在所有的測試上加上 Hook，則是有這四種 beforeAll(), afterAll(), beforeEach(), and afterEach()，執行時機不變，請根據情境加上執行內容：

// src/test/hooks.js

export const mochaHooks = {
  beforeEach: () => {
    // do something before every test

  }
};

接著在 .mocharc.js 加上設定

module.exports = {
    spec: ['src/test/*.spec.js'],
    require: [
      '@babel/register',
      'src/test/hooks.js',
    ],
};

https://mochajs.org/#hooks
https://mochajs.org/#defining-a-root-hook-plugin

測試結果

mocha 是個可愛的名稱，測試結果也可以換成很多有趣的模式：

npx mocha --report landing

https://mochajs.org/#reporters

支援瀏覽器介面

加上指定的路徑執行下面的指令

npx mocha init [PATH]

• index.html
• mocha.css
• mocha.js
• test.spec.js

目錄底下會多了上述這些檔案，此時只要將 test.spec.js 加入你的測試，再重新整理 index.html，就能看到測試結果已經輸出在畫面上。

可以將 chai 加入 index.html

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8" />
    <title>Mocha</title>
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <link rel="stylesheet" href="mocha.css" />
    <script src="https://unpkg.com/chai/chai.js"></script>
  </head>
  <body>
    <div id="mocha"></div>
    <script src="mocha.js"></script>
    <script>
      mocha.setup('bdd');
    </script>
    <script src="tests.spec.js"></script>
    <script>
      mocha.run();
    </script>
  </body>
</html>

再來可以直接將前面新增的 src/test/array.spec.js 內容貼過去，index.html 已經載入 mocha 和 chai ，記得把第一行的 import 拿掉。

webpack 常用 plugin 介紹 - HtmlWebpackPlugin 自動產生 Html

根據「[Vue.js] 如何建立 Vue3 + webpack5 專案範例」的內容，封裝時已經先建立目錄 dist/ ，新增 index.html，預先將 main.js 加到 script 中。

接著，以下要介紹 HtmlWebpackPlugin ，這個 webpack plugin 可以自動產生 Html，並自動將所有的 js 檔加入 script 中。下面的操作會用 [vue3-webpack5-template] 這個專案操作，可以先 clone下來並 npm install。

一、安裝

npm install html-webpack-plugin --save-dev

二、新增模板

新增 index.html ，並保留一些區域方便我們可以自訂。

<!DOCTYPE html>
<html>
    <head>
        <meta charset="utf-8"/>
        <title>
            <%= htmlWebpackPlugin.options.title %>
        </title>
    </head>
    <body>
        <div id="<%= id %>"></div>
    </body>
</html>

三、新增 Webpack 設定

為了突顯 HtmlWebpackPlugin 功能的強大，首先刻意將輸出的 js 檔案名稱改為 [name].[contenthash].js，這時變得無法預期編譯後的檔案名稱。

再來將 HtmlWebpackPlugin 加入 plugin，完整檔案請點連結

// webpack.config.js
const HtmlWebpackPlugin = require('html-webpack-plugin');

module.exports = {
  output: {
    filename: '[name].[contenthash].js',
    path: path.resolve(__dirname, 'dist'),
  },

  ...

  plugins: [
    new HtmlWebpackPlugin({
      template: 'template/index.html',
      title: 'Getting Started',
      templateParameters: {
        id: 'app',
      },
    }),
  ],
};

上面共使用了三個參數：

1. template - 顧名思義是模板的路徑
2. title - html 檔案的 <title>
也說明為什麼在 index.html 有這一段

<%= htmlWebpackPlugin.options.title %>

3. templateParameters - 這裡傳入一個物件，將 id 訂為 app，因此模板這段程式碼，將會使用這裡的設定複寫

<div id="<%= id %>"></div>

若要了解更多參數的使用，可以參考文件。

四、執行

執行下面的指令開始打包

npm run build

程式碼已經 push 到分支test-webpack-plugin，或者參考變更可以按這裡。