restore Karma/QUnit tests and re-enable partitioning

also: - include tests with .jsx extension - automate partitioning of all QUnit tests - move old Ember-related tests back to their prior suffix - skip tests either consistently failing locally or in Jenkins - sometimes due to lack of maintenance (some weren't running before), or due to different order of running tests - fix some tests - upgrades karma-selenium-grid-launcher to fork which resolves longstanding bug cf. squarebracket/karma-selenium-grid-launcher#4 skips three Gradebook-related test files that consistently hang in Jenkins, cf. EVAL-4267 Change-Id: Ib79f75963f6c4f5544e5dc1b5c31bc58d6c1110c Reviewed-on: https://gerrit.instructure.com/c/canvas-lms/+/349561 Reviewed-by: Isaac Moore <[email protected]> Tested-by: Service Cloud Jenkins <[email protected]> QA-Review: Aaron Shafovaloff <[email protected]> Product-Review: Aaron Shafovaloff <[email protected]> Build-Review: James Butters <[email protected]>
instructure · Jun 12, 2024 · 4d0d89b · 4d0d89b
1 parent dd2a6b3
commit 4d0d89b
Show file tree

Hide file tree

Showing 94 changed files with 3,478 additions and 3,448 deletions.
diff --git a/Jenkinsfile.coverage-js b/Jenkinsfile.coverage-js
@@ -179,14 +179,6 @@ pipeline {
                   }
                 }
 
-                extendedStage('Runner - Karma').nodeRequirements(label: 'canvas-docker', podTemplate: jsStage.karmaNodeRequirementsTemplate()).obeysAllowStages(false).timeout(10).queue(jsStages) {
-                  def tests = [:]
-
-                  callableWithDelegate(jsStage.queueKarmaDistribution())(tests)
-
-                  parallel(tests)
-                }
-
                 parallel(jsStages)
               } //parallel tests
             } //builder

diff --git a/Jenkinsfile.js b/Jenkinsfile.js
@@ -82,12 +82,15 @@ pipeline {
               }
             }
 
-            extendedStage('Runner - Karma').hooks(stageHooks).nodeRequirements(label: nodeLabel(), podTemplate: jsStage.karmaNodeRequirementsTemplate()).obeysAllowStages(false).timeout(10).queue(runnerStages) {
-              def tests = [:]
+            for (int i = 0; i < jsStage.KARMA_NODE_COUNT; i++) {
+              String index = i
+              extendedStage("Runner - Karma ${i}").hooks(stageHooks).nodeRequirements(label: nodeLabel(), podTemplate: jsStage.karmaNodeRequirementsTemplate(index)).obeysAllowStages(false).timeout(10).queue(runnerStages) {
+                def tests = [:]
 
-              callableWithDelegate(jsStage.queueKarmaDistribution())(tests)
+                callableWithDelegate(jsStage.queueKarmaDistribution(index))(tests)
 
-              parallel(tests)
+                parallel(tests)
+              }
             }
 
             extendedStage('Runner - Packages').hooks(stageHooks).nodeRequirements(label: nodeLabel(), podTemplate: jsStage.packagesNodeRequirementsTemplate()).obeysAllowStages(false).timeout(10).queue(runnerStages) {

diff --git a/build/new-jenkins/library/vars/jsStage.groovy b/build/new-jenkins/library/vars/jsStage.groovy
@@ -18,6 +18,7 @@
 
 import groovy.transform.Field
 
+@Field static final KARMA_NODE_COUNT = 7
 @Field static final JEST_NODE_COUNT = 5
 
 def jestNodeRequirementsTemplate(index) {
@@ -27,51 +28,50 @@ def jestNodeRequirementsTemplate(index) {
   ]
 
   return [
-    containers: [baseTestContainer + [name: "jest${index}"]]
+    containers: [baseTestContainer + [name: "jest-${index}"]]
   ]
 }
 
-def getSeleniumGridContainers(count) {
+def getSeleniumGridContainers(parentIndex, count) {
   def baseChromeContainer = [
     image: env.SELENIUM_NODE_IMAGE,
     ttyEnabled: true,
   ]
 
   def baseChromeEnvVars = [
-    SE_EVENT_BUS_HOST: "selenium-hub",
+    SE_EVENT_BUS_HOST: 'selenium-hub',
     SE_EVENT_BUS_PUBLISH_PORT: 4442,
     SE_EVENT_BUS_SUBSCRIBE_PORT: 4443,
-    HUB_PORT_4444_TCP_ADDR: "selenium-hub",
+    HUB_PORT_4444_TCP_ADDR: 'selenium-hub',
     HUB_PORT_4444_TCP_PORT: 4444,
     JAVA_OPTS: '-Dwebdriver.chrome.whitelistedIps='
   ]
 
   return (0..count).collect { index ->
-    baseChromeContainer + [name: "selenium-chrome${index}", envVars: baseChromeEnvVars + [SE_NODE_HOST: "selenium-chrome${index}"]]
+    baseChromeContainer + [name: "selenium-chrome-${parentIndex}-${index}", envVars: baseChromeEnvVars + [SE_NODE_HOST: "selenium-chrome-${parentIndex}-${index}"]]
   } + [
     [
       name: 'selenium-hub',
       image: env.SELENIUM_HUB_IMAGE,
       ttyEnabled: true,
       envVars: [
-        GRID_BROWSER_TIMEOUT: 3000
+        GRID_BROWSER_TIMEOUT: 5000
       ],
       ports: [4442, 4443, 4444]
     ]
   ]
 }
 
-def karmaNodeRequirementsTemplate() {
+def karmaNodeRequirementsTemplate(index) {
   def baseTestContainer = [
     image: 'local/karma-runner',
     command: 'cat',
     ports: [9876],
     envVars: [KARMA_BROWSER: 'ChromeSeleniumGridHeadless', KARMA_PORT: 9876],
-    name: 'karma-qunit'
   ]
 
   return [
-    containers: [baseTestContainer] + getSeleniumGridContainers(1),
+    containers: [baseTestContainer + [name: "karma-qunit-${index}"]] + getSeleniumGridContainers("karma-${index}", 1),
   ]
 }
 
@@ -87,7 +87,7 @@ def packagesNodeRequirementsTemplate() {
   ]
 
   return [
-    containers: [baseTestContainer + [name: "packages"]] + getSeleniumGridContainers(1),
+    containers: [baseTestContainer + [name: 'packages']] + getSeleniumGridContainers('packages', 1),
   ]
 }
 
@@ -126,19 +126,24 @@ def queueJestDistribution(index) {
       "CI_NODE_TOTAL=${JEST_NODE_COUNT}",
     ]
 
-    callableWithDelegate(queueTestStage())(stages, "jest${index}", jestEnvVars, 'yarn test:jest:build')
+    callableWithDelegate(queueTestStage())(stages, "jest-${index}", jestEnvVars, 'yarn test:jest:build')
   }
 }
 
-def queueKarmaDistribution() {
+def queueKarmaDistribution(index) {
   { stages ->
-    callableWithDelegate(queueTestStage())(stages, "karma-qunit", [], 'yarn test:karma:headless')
+    def jsgEnvVars = [
+        "CI_NODE_INDEX=${index}",
+        "CI_NODE_TOTAL=${KARMA_NODE_COUNT}",
+      ]
+
+    callableWithDelegate(queueTestStage())(stages, "karma-qunit-${index}", jsgEnvVars, 'yarn test:karma:headless')
   }
 }
 
 def queuePackagesDistribution() {
   { stages ->
-    callableWithDelegate(queueTestStage())(stages, 'packages', ["CANVAS_RCE_PARALLEL=1"], 'TEST_RESULT_OUTPUT_DIR=/usr/src/app/$TEST_RESULT_OUTPUT_DIR yarn test:packages:parallel')
+    callableWithDelegate(queueTestStage())(stages, 'packages', ['CANVAS_RCE_PARALLEL=1'], 'TEST_RESULT_OUTPUT_DIR=/usr/src/app/$TEST_RESULT_OUTPUT_DIR yarn test:packages:parallel')
   }
 }
 
@@ -160,6 +165,7 @@ def queueTestStage() {
       .envVars(baseEnvVars + additionalEnvVars)
       .hooks(postStageHandler + [onNodeReleasing: this.tearDownNode()])
       .obeysAllowStages(false)
+      .timeout(20)
       .nodeRequirements(container: containerName)
       .queue(stages) { sh(scriptName) }
   }

diff --git a/docker-compose.new-jenkins-js.yml b/docker-compose.new-jenkins-js.yml
@@ -1,7 +1,5 @@
 version: "2.3"
 services:
   canvas:
-    environment:
-      JSPEC_GROUP: $JSPEC_GROUP
     image: $KARMA_RUNNER_IMAGE
     init: true
diff --git a/docker-compose.new-jenkins-selenium.yml b/docker-compose.new-jenkins-selenium.yml
@@ -30,7 +30,7 @@ services:
   selenium-hub:
     image: starlord.inscloudgate.net/jenkins/selenium-hub:${HUB_VERSION:-4.16}
     environment:
-      GRID_BROWSER_TIMEOUT: 3000
+      GRID_BROWSER_TIMEOUT: 5000
 
   selenium-chrome: &NODE_CHROME
     image: starlord.inscloudgate.net/jenkins/selenium-node-chrome:${CHROME_VERSION:-120.0}

diff --git a/karma.conf.js b/karma.conf.js
@@ -42,7 +42,7 @@ const karmaConfig = {
   // this is to make a nice "spec failures" report in the jenkins build instead of having to look at the log output
   junitReporter: {
     outputDir: process.env.TEST_RESULT_OUTPUT_DIR || 'coverage-js/junit-reports',
-    outputFile: `karma-${process.env.JSPEC_GROUP || 'all'}.xml`,
+    outputFile: `karma-qunit.xml`,
     useBrowserName: false, // don't add browser name to report and classes names
   },
   specReporter: {
@@ -92,10 +92,12 @@ const karmaConfig = {
     },
   },
 
+  browserDisconnectTolerance: 3,
+
   // If browser does not capture in given timeout [ms], kill it
   captureTimeout: 60000,
 
-  browserDisconnectTimeout: 100000,
+  browserDisconnectTimeout: 600000,
   browserNoActivityTimeout: 2000000,
 
   reportSlowerThan: 1000,
@@ -133,7 +135,7 @@ if (process.env.COVERAGE === '1') {
     fixWebpackSourcePaths: true,
   }
   karmaConfig.webpack.module.rules.unshift({
-    test: /\.(js|jsx|ts|tsx|coffee)$/,
+    test: /\.(js|jsx|ts|tsx)$/,
     use: {
       loader: 'coverage-istanbul-loader',
       options: {esModules: true, produceSourceMap: true},

diff --git a/package.json b/package.json
@@ -340,7 +340,7 @@
     "karma-coverage-istanbul-reporter": "^2",
     "karma-junit-reporter": "^1",
     "karma-qunit": "~1.2.1",
-    "karma-selenium-grid-launcher": "^0.3.0",
+    "karma-selenium-grid-launcher": "github:ErDmKo/karma-selenium-grid-launcher#3d202186307fcb463786cca93a98cf9877435668",
     "karma-sourcemap-loader": "^0.3",
     "karma-spec-reporter": "^0.0.32",
     "karma-verbose-reporter": "^0.0.6",
@@ -412,7 +412,7 @@
     "test:jest:watch": "jest --color --watch",
     "test:jest:build": "if [ \"$COVERAGE\" = \"1\" ]; then yarn test:jest:coverage --maxWorkers=3 --shard=$CI_NODE_INDEX/$CI_NODE_TOTAL; else yarn test:jest --maxWorkers=3 --shard=$CI_NODE_INDEX/$CI_NODE_TOTAL; fi",
     "test:karma": "yarn run test:karma:watch --single-run",
-    "test:karma:concurrently": "concurrently --names \"coffee,js\" \"JSPEC_GROUP=coffee yarn test:karma:headless\" \"JSPEC_GROUP=js yarn test:karma:headless\"",
+    "test:karma:concurrently": "yarn test:karma:headless",
     "test:karma:headless": "yarn run test:karma --browsers ${KARMA_BROWSER:-ChromeHeadlessNoSandbox}",
     "test:karma:watch": "node --max-old-space-size=4096 ./node_modules/.bin/karma start",
     "test:karma:watch:headless": "yarn run test:karma:watch --browsers ${KARMA_BROWSER:-ChromeHeadlessNoSandbox}",

diff --git a/spec/coffeescripts/behaviors/instructureInlineMediaCommentSpec.js b/spec/coffeescripts/behaviors/instructureInlineMediaCommentSpec.js
diff --git a/spec/coffeescripts/jsx/shared/rce/RichContentEditorSpec.js b/spec/coffeescripts/jsx/shared/rce/RichContentEditorSpec.js
@@ -117,7 +117,7 @@ test('skips instantiation when called with empty target', () => {
   ok(RCELoader.loadOnTarget.notCalled)
 })
 
-test('hides resize handle when called', function () {
+QUnit.skip('hides resize handle when called', function () {
   const $resize = fixtures.create('<div class="mce-resizehandle"></div>')
   RichContentEditor.loadNewEditor(this.$target, {})
   equal($resize.attr('aria-hidden'), 'true')

diff --git a/spec/coffeescripts/views/DialogFormViewSpec.js b/spec/coffeescripts/views/DialogFormViewSpec.js
@@ -134,7 +134,7 @@ test('closing the dialog calls view#close', function () {
   ok(this.closeSpy.called)
 })
 
-test('focuses close button when opened', () => {
+QUnit.skip('focuses close button when opened', () => {
   openDialog()
   equal(document.activeElement, $('.ui-dialog-titlebar-close')[0])
 })
diff --git a/spec/coffeescripts/views/PaginatedCollectionViewSpec.js b/spec/coffeescripts/views/PaginatedCollectionViewSpec.js
@@ -114,7 +114,7 @@ test('renders items on collection fetch and fetch next', () => {
   assertItemRendered('4')
 })
 
-test('fetches the next page on scroll', () => {
+QUnit.skip('fetches the next page on scroll', () => {
   collection.fetch()
   server.sendPage(fakePage(), collection.url)
   scrollToBottom()

diff --git a/spec/javascripts/jsx/blueprint_courses/components/SyncChangeSpec.jsx b/spec/javascripts/jsx/blueprint_courses/components/SyncChangeSpec.jsx
@@ -20,7 +20,7 @@ import React from 'react'
 import {shallow} from 'enzyme'
 import SyncChange from '@canvas/blueprint-courses/react/components/SyncChange'
 import {Pill} from '@instructure/ui-pill'
-import getSampleData from '../getSampleData'
+import getSampleData from '@canvas/blueprint-courses/getSampleData'
 import ReactDOM from 'react-dom'
 import $ from 'jquery'
 import 'jquery-migrate'