Merge pull request #3 from vuejs-jp/feat/cypress

Feat/cypress

apps/web/package.json

@@ -9,12 +9,14 @@
     "preview": "nuxt preview",
     "lint": "eslint . --ext js,jsx,ts,tsx,vue --ignore-path .eslintignore",
     "lint-fix": "eslint . --ext js,jsx,ts,tsx,vue --ignore-path .eslintignore --fix",
+    "cypress:open": "cypress open --config-file tests/cypress.config.ts",
     "postinstall": "nuxt prepare"
   },
   "devDependencies": {
     "@vuejs-jp/eslint-config": "workspace:*",
     "@vuejs-jp/typescript-config": "workspace:*",
     "@vuejs-jp/vuefes-ui": "workspace:*",
+    "cypress": "13.6.4",
     "nuxt": "3.10.0"
   }
 }

apps/web/tests/README.md

@@ -0,0 +1,26 @@
+# Cypress
+
+アプリをビルドしてからローカルのサーバ上で実行し挙動をチェックします。
+
+つまり統合テストなのでユニット単位で行うunit testとは別物です。
+
+- コンポーネントごとにテストすることも可能です
+
+基本的にページごとテストを作成していきます。
+
+- シナリオテストのようなものも書けます。
+
+## 方針
+
+- 必要に応じて各ページの以下の挙動をチェックし、デグレードが発生していないかを確認することで思い切ったリファクタリングなどができるようになります。
+  - **レンダリング**
+    - しかるべきパーツがレンダーされているか
+    - 特定のボタンを押したあとちゃんとダイアログが出力されているか、または閉じられているか
+    - 特定のアクション後に期待どおりの項目を出力しているか（成功または失敗）
+  - **バリデーション**
+    - フォームのバリデーションが機能しているか
+  - **リクエスト**
+    - 期待どおりのパラメータを送信しているか
+- ローカルやCIで動作チェックをするため、apiなどのデータ取得やデータ送信についてはすべてモックします。
+- ただし、CIの実行時間を食いつぶさないようにミニマムなテストにしていきたいと思います。
+  - もしくは開発branchとmain branchにて実行内容を変えるなどの工夫をするかもしれません。

apps/web/tests/cypress.config.ts

@@ -0,0 +1,15 @@
+import { defineConfig } from 'cypress';
+
+export default defineConfig({
+  e2e: {
+    setupNodeEvents(on, config) {
+      // implement node event listeners here
+    },
+    supportFile: 'tests/cypress/support/e2e.ts',
+    specPattern: 'tests/cypress/e2e/*.cy.ts',
+  },
+  downloadsFolder: 'tests/cypress/downloads',
+  fixturesFolder: 'tests/cypress/fixtures',
+  screenshotsFolder: 'tests/cypress/screenshots',
+  videosFolder: 'tests/cypress/videos',
+});

apps/web/tests/cypress/e2e/spec.cy.ts

@@ -0,0 +1,5 @@
+describe('template spec', () => {
+  it('passes', () => {
+    cy.visit('https://example.cypress.io')
+  })
+})

apps/web/tests/cypress/fixtures/example.json

@@ -0,0 +1,5 @@
+{
+  "name": "Using fixtures to represent data",
+  "email": "[email protected]",
+  "body": "Fixtures are a great way to mock data for responses to routes"
+}

apps/web/tests/cypress/support/commands.ts

@@ -0,0 +1,37 @@
+/// <reference types="cypress" />
+// ***********************************************
+// This example commands.ts shows you how to
+// create various custom commands and overwrite
+// existing commands.
+//
+// For more comprehensive examples of custom
+// commands please read more here:
+// https://on.cypress.io/custom-commands
+// ***********************************************
+//
+//
+// -- This is a parent command --
+// Cypress.Commands.add('login', (email, password) => { ... })
+//
+//
+// -- This is a child command --
+// Cypress.Commands.add('drag', { prevSubject: 'element'}, (subject, options) => { ... })
+//
+//
+// -- This is a dual command --
+// Cypress.Commands.add('dismiss', { prevSubject: 'optional'}, (subject, options) => { ... })
+//
+//
+// -- This will overwrite an existing command --
+// Cypress.Commands.overwrite('visit', (originalFn, url, options) => { ... })
+//
+// declare global {
+//   namespace Cypress {
+//     interface Chainable {
+//       login(email: string, password: string): Chainable<void>
+//       drag(subject: string, options?: Partial<TypeOptions>): Chainable<Element>
+//       dismiss(subject: string, options?: Partial<TypeOptions>): Chainable<Element>
+//       visit(originalFn: CommandOriginalFn, url: string, options: Partial<VisitOptions>): Chainable<Element>
+//     }
+//   }
+// }

apps/web/tests/cypress/support/e2e.ts

@@ -0,0 +1,20 @@
+// ***********************************************************
+// This example support/e2e.ts is processed and
+// loaded automatically before your test files.
+//
+// This is a great place to put global configuration and
+// behavior that modifies Cypress.
+//
+// You can change the location of this file or turn off
+// automatically serving support files with the
+// 'supportFile' configuration option.
+//
+// You can read more here:
+// https://on.cypress.io/configuration
+// ***********************************************************
+
+// Import commands.js using ES2015 syntax:
+import './commands'
+
+// Alternatively you can use CommonJS syntax:
+// require('./commands')

apps/web/tests/cypress/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  // https://nuxt.com/docs/guide/concepts/typescript
+  "extends": "@vuejs-jp/typescript-config/vue-library.json"
+}