workflow: test migrator / vue 3 scenarios with verdaccio (#6071)

haoqunjiang · web-flow · commit f5359bdf3671 · 2020-11-19T11:12:48.000+08:00
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -1,9 +1,19 @@
-version: 2
+version: 2.1
 
 defaults: &defaults
   working_directory: ~/project/vue
   docker:
-    - image: vuejs/ci
+    - image: circleci/node:lts-browsers
+
+aliases:
+  - &restore-yarn-cache
+    key: v2-vue-cli-{{ checksum "yarn.lock" }}
+
+  - &save-yarn-cache
+    key: v2-vue-cli-{{ checksum "yarn.lock" }}
+    paths:
+      - node_modules/
+      - ~/.cache
 
 workflow_filters: &filters
   filters:
@@ -16,21 +26,22 @@ jobs:
     <<: *defaults
     steps:
       - checkout
-      - restore_cache:
-          keys:
-            - v2-vue-cli-{{ checksum "yarn.lock" }}
+      - restore_cache: *restore-yarn-cache
       - run: yarn --network-timeout 600000
-      - save_cache:
-          key: v2-vue-cli-{{ checksum "yarn.lock" }}
-          paths:
-            - node_modules/
-            - ~/.cache
+      - save_cache: *save-yarn-cache
       - persist_to_workspace:
           root: ~/
           paths:
             - project/vue
             - .cache/Cypress
 
+  e2e:
+    <<: *defaults
+    steps:
+      - attach_workspace:
+          at: ~/
+      - run: ./scripts/e2e-test/run-e2e-test.sh
+
   group-1:
     <<: *defaults
     steps:
@@ -52,16 +63,9 @@ jobs:
           at: ~/
       - run: yarn lint-without-fix
       - run: yarn check-links
-      - restore_cache:
-          keys:
-            # TODO: should use a more accurate cache key
-            - v2-vue-cli-offline-{{ checksum "yarn.lock" }}
-      - run: yarn config set yarn-offline-mirror ~/npm-packages-offline-cache
+      - restore_cache: *restore-yarn-cache
       - run: yarn test -p cli-service-global,eslint,pwa,babel,babel-preset-app,vuex,router
-      - save_cache:
-          key: v2-vue-cli-offline-{{ checksum "yarn.lock" }}
-          paths:
-            - ~/npm-packages-offline-cache
+      - save_cache: *save-yarn-cache
 
   group-4:
     <<: *defaults
@@ -109,3 +113,7 @@ workflows:
           <<: *filters
           requires:
             - install
+      - e2e:
+          <<: *filters
+          requires:
+            - install
diff --git a/appveyor.yml b/appveyor.yml
@@ -10,15 +10,13 @@ test_script:
   - git --version
   - node --version
   - yarn --version
-  - yarn config set yarn-offline-mirror ./npm-packages-offline-cache
   - yarn test
   # ui tests temporarily disabled due to Cypress 3.0 issue on windows
   # - cd "packages/@vue/cli-ui" && yarn test
 
 cache:
   - node_modules -> appveyor.yml, **\package.json, yarn.lock
   - '%LOCALAPPDATA%\Yarn -> appveyor.yml, **\package.json, yarn.lock'
-  - npm-packages-offline-cache -> appveyor.yml, **\package.json, yarn.lock
 
 build: off
 
diff --git a/package.json b/package.json
@@ -12,6 +12,7 @@
     "lint-without-fix": "eslint packages/**/*.js packages/**/bin/*",
     "check-links": "node scripts/checkLinks.js",
     "clean": "rimraf packages/test/* packages/**/temp/*",
+    "clean-e2e": "rimraf /tmp/verdaccio-workspace",
     "sync": "node scripts/syncDeps.js",
     "boot": "node scripts/bootstrap.js",
     "release": "yarn --pure-lockfile && yarn clean && node scripts/release.js",
@@ -56,7 +57,7 @@
     "babel-core": "7.0.0-bridge.0",
     "babel-eslint": "^10.1.0",
     "babel-jest": "^24.9.0",
-    "chromedriver": "^85.0.0",
+    "chromedriver": "^87.0.0",
     "debug": "^4.1.0",
     "eslint": "^6.7.2",
     "eslint-plugin-graphql": "^3.1.0",
@@ -84,6 +85,7 @@
     "rimraf": "^3.0.2",
     "semver": "^7.3.2",
     "typescript": "~3.9.3",
+    "verdaccio": "^4.8.1",
     "vuepress": "^1.6.0",
     "webpack": "^4.0.0",
     "yorkie": "^2.0.0"
diff --git a/packages/@vue/cli-plugin-e2e-nightwatch/package.json b/packages/@vue/cli-plugin-e2e-nightwatch/package.json
@@ -28,7 +28,7 @@
     "nightwatch": "^1.4.1"
   },
   "devDependencies": {
-    "chromedriver": "^85.0.0",
+    "chromedriver": "^87.0.0",
     "geckodriver": "^1.20.0",
     "selenium-server": "^3.141.59"
   },
diff --git a/packages/@vue/cli-plugin-e2e-webdriverio/package.json b/packages/@vue/cli-plugin-e2e-webdriverio/package.json
@@ -57,7 +57,7 @@
     }
   },
   "devDependencies": {
-    "chromedriver": "^85.0.0",
+    "chromedriver": "^87.0.0",
     "geckodriver": "^1.20.0",
     "ts-node": "^9.0.0",
     "wdio-chromedriver-service": "^6.0.4",
diff --git a/packages/@vue/cli-plugin-unit-jest/__tests__/jestPluginVue3.spec.js b/packages/@vue/cli-plugin-unit-jest/__tests__/jestPluginVue3.spec.js
@@ -0,0 +1,16 @@
+jest.setTimeout(300000)
+
+const createOutside = require('@vue/cli-test-utils/createUpgradableProject')
+
+test('should work with Vue 3', async () => {
+  const project = await createOutside('unit-jest-vue-3', {
+    vueVersion: '3',
+    plugins: {
+      '@vue/cli-plugin-babel': {},
+      '@vue/cli-plugin-unit-jest': {}
+    }
+  })
+  const pkg = JSON.parse(await project.read('package.json'))
+  expect(pkg.devDependencies['@vue/test-utils']).toMatch('^2')
+  await project.run(`vue-cli-service test:unit`)
+})
diff --git a/packages/@vue/cli-plugin-unit-mocha/__tests__/mochaPlugin.spec.js b/packages/@vue/cli-plugin-unit-mocha/__tests__/mochaPlugin.spec.js
@@ -1,7 +1,6 @@
 jest.setTimeout(3000000)
 
 const create = require('@vue/cli-test-utils/createTestProject')
-const createOutside = require('@vue/cli-test-utils/createUpgradableProject')
 
 test('should work', async () => {
   const project = await create('unit-mocha', {
@@ -12,30 +11,3 @@ test('should work', async () => {
   })
   await project.run(`vue-cli-service test:unit`)
 })
-
-test('should work with Vue 3', async () => {
-  const project = await createOutside('unit-mocha-vue-3', {
-    vueVersion: '3',
-    plugins: {
-      '@vue/cli-plugin-babel': {},
-      '@vue/cli-plugin-unit-mocha': {}
-    }
-  })
-  const pkg = JSON.parse(await project.read('package.json'))
-  expect(pkg.devDependencies['@vue/test-utils']).toMatch('^2')
-  await project.run(`vue-cli-service test:unit`)
-})
-
-test('should work with Vue 3 + TS', async () => {
-  const project = await createOutside('unit-mocha-vue-3-ts', {
-    vueVersion: '3',
-    plugins: {
-      '@vue/cli-plugin-babel': {},
-      '@vue/cli-plugin-typescript': {},
-      '@vue/cli-plugin-unit-mocha': {}
-    }
-  })
-  const pkg = JSON.parse(await project.read('package.json'))
-  expect(pkg.devDependencies['@vue/test-utils']).toMatch('^2')
-  await project.run(`vue-cli-service test:unit`)
-})
diff --git a/packages/@vue/cli-plugin-unit-mocha/__tests__/mochaPluginVue3.spec.js b/packages/@vue/cli-plugin-unit-mocha/__tests__/mochaPluginVue3.spec.js
@@ -0,0 +1,29 @@
+jest.setTimeout(3000000)
+const createOutside = require('@vue/cli-test-utils/createUpgradableProject')
+
+test('should work with Vue 3', async () => {
+  const project = await createOutside('unit-mocha-vue-3', {
+    vueVersion: '3',
+    plugins: {
+      '@vue/cli-plugin-babel': {},
+      '@vue/cli-plugin-unit-mocha': {}
+    }
+  })
+  const pkg = JSON.parse(await project.read('package.json'))
+  expect(pkg.devDependencies['@vue/test-utils']).toMatch('^2')
+  await project.run(`vue-cli-service test:unit`)
+})
+
+test('should work with Vue 3 + TS', async () => {
+  const project = await createOutside('unit-mocha-vue-3-ts', {
+    vueVersion: '3',
+    plugins: {
+      '@vue/cli-plugin-babel': {},
+      '@vue/cli-plugin-typescript': {},
+      '@vue/cli-plugin-unit-mocha': {}
+    }
+  })
+  const pkg = JSON.parse(await project.read('package.json'))
+  expect(pkg.devDependencies['@vue/test-utils']).toMatch('^2')
+  await project.run(`vue-cli-service test:unit`)
+})
diff --git a/packages/@vue/cli/lib/util/ProjectPackageManager.js b/packages/@vue/cli/lib/util/ProjectPackageManager.js
@@ -343,18 +343,17 @@ class PackageManager {
   }
 
   async install () {
+    const args = []
+
+    if (this.needsPeerDepsFix) {
+      args.push('--legacy-peer-deps')
+    }
+
     if (process.env.VUE_CLI_TEST) {
-      try {
-        process.env.PUPPETEER_SKIP_CHROMIUM_DOWNLOAD = true
-        await this.runCommand('install', ['--offline', '--silent', '--no-progress'])
-        delete process.env.PUPPETEER_SKIP_CHROMIUM_DOWNLOAD
-      } catch (e) {
-        delete process.env.PUPPETEER_SKIP_CHROMIUM_DOWNLOAD
-        await this.runCommand('install', ['--silent', '--no-progress'])
-      }
+      args.push('--silent', '--no-progress')
     }
 
-    return await this.runCommand('install', this.needsPeerDepsFix ? ['--legacy-peer-deps'] : [])
+    return await this.runCommand('install', args)
   }
 
   async add (packageName, {
diff --git a/scripts/e2e-test/cleanup.sh b/scripts/e2e-test/cleanup.sh
@@ -0,0 +1,30 @@
+#!/bin/bash
+
+function cleanup {
+  echo "Cleaning up."
+  stopLocalRegistry
+
+  if [ -n "$GIT_E2E_SETUP" ]; then
+    cleanupE2Egit
+  fi
+}
+
+# Error messages are redirected to stderr
+function handle_error {
+  echo "$(basename $0): ERROR! An error was encountered executing line $1." 1>&2;
+  cleanup
+  echo "Exiting with error." 1>&2;
+  exit 1
+}
+
+function handle_exit {
+  cleanup
+  echo "Exiting without error." 1>&2;
+  exit
+}
+
+# Exit the script with a helpful error message when any error is encountered
+trap 'set +x; handle_error $LINENO $BASH_COMMAND' ERR
+
+# Cleanup before exit on any termination signal
+trap 'set +x; handle_exit' SIGQUIT SIGTERM SIGINT SIGKILL SIGHUP
diff --git a/scripts/e2e-test/git.sh b/scripts/e2e-test/git.sh
@@ -0,0 +1,30 @@
+
+#!/bin/bash
+
+original_git_branch=`git rev-parse --abbrev-ref HEAD`
+tmp_branch_name="integration-tests-$(date +'%F-%H-%M-%N')"
+original_user_name=`git config user.name`
+original_user_email=`git config user.email`
+
+export GIT_E2E_SETUP="true"
+
+function initializeE2Egit {
+  git checkout -b $tmp_branch_name
+
+  # This is needed by "yarn release-tool", which commits when publishing
+  git config user.name "Vue CLI E2E Test"
+  git config user.email "vue-cli-e2e@example.com"
+}
+
+function cleanupE2Egit {
+  # Delete release tags
+  git tag -d $(git tag -l "version-e2e-test-*")
+
+  # Checkout the previous branch
+  git checkout -f $original_git_branch
+  git branch -D $tmp_branch_name
+
+  # Restore git user
+  git config user.name "$original_user_name"
+  git config user.email "$original_user_email"
+}
diff --git a/scripts/e2e-test/local-registry.sh b/scripts/e2e-test/local-registry.sh
@@ -0,0 +1,31 @@
+#!/bin/bash
+
+# Copied from https://github.com/facebook/create-react-app/blob/v4.0.0/tasks/local-registry.sh
+
+custom_registry_url=http://localhost:4873
+original_npm_registry_url=`npm get registry`
+original_yarn_registry_url=`yarn config get registry`
+
+function startLocalRegistry {
+  # Start local registry
+  tmp_registry_log=`mktemp`
+  echo "Registry output file: $tmp_registry_log"
+  nohup yarn verdaccio -c $1 &>$tmp_registry_log &
+  # Wait for Verdaccio to boot
+  grep -q 'http address' <(tail -f $tmp_registry_log)
+
+  # Set registry to local registry
+  npm set registry "$custom_registry_url"
+  yarn config set registry "$custom_registry_url"
+}
+
+function stopLocalRegistry {
+  # Restore the original NPM and Yarn registry URLs and stop Verdaccio
+  npm set registry "$original_npm_registry_url"
+  yarn config set registry "$original_yarn_registry_url"
+}
+
+function publishToLocalRegistry {
+  git clean -df
+  yarn release --local-registry
+}
diff --git a/scripts/e2e-test/run-e2e-test.sh b/scripts/e2e-test/run-e2e-test.sh
@@ -0,0 +1,33 @@
+#!/bin/bash
+
+#==============================================================================#
+#                                  SETUP                                       #
+#==============================================================================#
+
+# Start in scripts/integration-tests/ even if run from root directory
+cd "$(dirname "$0")"
+
+source ./local-registry.sh
+source ./git.sh
+source ./cleanup.sh
+
+# Echo every command being executed
+set -x
+
+# Go to the root of the monorepo
+cd ../..
+
+initializeE2Egit
+
+#==============================================================================#
+#                                 PUBLISH                                      #
+#==============================================================================#
+
+yarn
+
+startLocalRegistry "$PWD"/scripts/e2e-test/verdaccio-config.yml
+publishToLocalRegistry
+
+yarn test --e2e-only
+
+cleanup
diff --git a/scripts/e2e-test/verdaccio-config.yml b/scripts/e2e-test/verdaccio-config.yml
diff --git a/scripts/genChangelog.js b/scripts/genChangelog.js
diff --git a/scripts/release.js b/scripts/release.js
diff --git a/scripts/test.js b/scripts/test.js
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@`
`57`	`57`	`}`
`58`	`58`	`},`
`59`	`59`	`"devDependencies": {`
`60`		`- "chromedriver": "^85.0.0",`
	`60`	`+ "chromedriver": "^87.0.0",`
`61`	`61`	`"geckodriver": "^1.20.0",`
`62`	`62`	`"ts-node": "^9.0.0",`
`63`	`63`	`"wdio-chromedriver-service": "^6.0.4",`