Report coverage from cypress tests (#92)

.github/workflows/build.yml

@@ -192,13 +192,19 @@ jobs:
         run: |
           make build-dependencies
           make yarn-install
+          make test-instrument
           make build-ui-prod
       - name: Install
         run: |
           make install-server
           make install-examples
       - name: Cypress
         run: make test-integration
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: ./coverage/cobertura-coverage.xml
       - name: Collect logs
         uses: actions/upload-artifact@v4
         if: failure()

.gitignore

@@ -63,6 +63,7 @@ nosetests.xml
 coverage.xml
 *,cover
 **/coverage/
+.nyc_output/
 
 # Translations
 *.mo

.nycrc

@@ -0,0 +1,12 @@
+{
+  "extends": "nyc-config-tsx",
+  "all": true,
+  "include": ["**/src/**/*.{ts,tsx}"],
+  "exclude": ["**/*.spec.ts", "tests/**/*"],
+  "reporter": ["text-summary", "cobertura"],
+  "check-coverage": true,
+  "lines": 72,
+  "functions": 68,
+  "branches": 53,
+  "statements": 72
+}

Makefile

@@ -219,6 +219,9 @@ test-server: test-dependencies pytest # Run python unit tests
 test-ui-unit: # Run frontend jest unit tests
 	yarn test:unit
 
+test-instrument: # Prepare code coverage instrumentation
+	yarn lerna run cy:instrument --stream
+
 test-integration: # Run frontend cypress integration tests
 	yarn test:integration
 

package.json

@@ -13,7 +13,7 @@
   "scripts": {
     "graph": "ts-node etc/scripts/generate-make-graph.ts",
     "cy:open": "npx cypress open",
-    "cy:run": "npx cypress run",
+    "cy:run": "npx nyc npx cypress run",
     "eslint": "eslint . --fix --ignore-path .gitignore --ext .ts,.tsx,.js",
     "eslint:check": "eslint . --ignore-path .gitignore --ext .ts,.tsx,.js",
     "prettier": "prettier --ignore-path .gitignore --write \"**/*{.ts,.tsx,.js,.jsx,.css,.json}\"",
@@ -45,6 +45,7 @@
     "yjs": "^13.5.40"
   },
   "devDependencies": {
+    "@cypress/code-coverage": "^3.13.8",
     "@cypress/webpack-preprocessor": "^5.5.0",
     "@glen/jest-raw-loader": "^2.0.0",
     "@jupyterlab/testutils": "^4.2.5",
@@ -73,6 +74,8 @@
     "lerna": "^8.0.1",
     "lint-staged": "^15.2.0",
     "npm-run-all": "^4.1.5",
+    "nyc": "^17.1.0",
+    "nyc-config-tsx": "^0.1.0",
     "prettier": "^3.1.1",
     "rimraf": "~5.0.5",
     "start-server-and-test": "^2.0.3",

packages/code-snippet/package.json

@@ -36,6 +36,7 @@
     "clean:lintcache": "rimraf .eslintcache .stylelintcache",
     "clean:labextension": "rimraf ../../../../labextensions/elyra_code_snippet_extension/labextension ../../../../labextensions/elyra_code_snippet_extension/_version.py",
     "clean:all": "jlpm clean:lib && jlpm clean:labextension && jlpm clean:lintcache",
+    "cy:instrument": "npx nyc instrument --compact=false --in-place src/ src/",
     "eslint": "jlpm eslint:check --fix",
     "eslint:check": "eslint . --cache --ext .ts,.tsx",
     "install:extension": "jlpm build",

packages/metadata-common/package.json

@@ -35,6 +35,7 @@
     "clean:lintcache": "rimraf .eslintcache .stylelintcache",
     "clean:labextension": "rimraf ../../../../labextensions/elyra_metadata_common/labextension ../../../../labextensions/elyra_metadata_common/_version.py",
     "clean:all": "jlpm clean:lib && jlpm clean:labextension && jlpm clean:lintcache",
+    "cy:instrument": "npx nyc instrument --compact=false --in-place src/ src/",
     "eslint": "jlpm eslint:check --fix",
     "eslint:check": "eslint . --cache --ext .ts,.tsx",
     "install:extension": "jlpm build",

packages/metadata/package.json

@@ -36,6 +36,7 @@
     "clean:lintcache": "rimraf .eslintcache .stylelintcache",
     "clean:labextension": "rimraf ../../../../labextensions/elyra_metadata_extension/labextension ../../../../labextensions/elyra_metadata_extension/_version.py",
     "clean:all": "jlpm clean:lib && jlpm clean:labextension && jlpm clean:lintcache",
+    "cy:instrument": "npx nyc instrument --compact=false --in-place src/ src/",
     "eslint": "jlpm eslint:check --fix",
     "eslint:check": "eslint . --cache --ext .ts,.tsx",
     "install:extension": "jlpm build",

packages/pipeline-editor/package.json

@@ -37,6 +37,7 @@
     "clean:lintcache": "rimraf .eslintcache .stylelintcache",
     "clean:labextension": "rimraf ../../../../labextensions/elyra_pipeline_editor_extension/labextension ../../../../labextensions/elyra_pipeline_editor_extension/_version.py",
     "clean:all": "jlpm clean:lib && jlpm clean:labextension && jlpm clean:lintcache",
+    "cy:instrument": "npx nyc instrument --compact=false --in-place src/ src/",
     "eslint": "jlpm eslint:check --fix",
     "eslint:check": "eslint . --cache --ext .ts,.tsx",
     "install:extension": "jlpm build",

packages/pipeline-editor/src/PipelineEditorWidget.tsx

@@ -142,7 +142,7 @@ const getAllPaletteNodes = (
     return [];
   }
 
-  const nodes = [];
+  const nodes: IRuntimeComponentNodeType[] = [];
   for (const c of palette.categories) {
     if (c.node_types) {
       nodes.push(...c.node_types);
@@ -282,7 +282,7 @@ const PipelineWrapper: React.FC<
   const runtimeDisplayName = getDisplayName(runtimesSchema, type) ?? 'Generic';
 
   const filePersistedRuntimeImages = useMemo(() => {
-    const images = [];
+    const images: string[] = [];
     const pipelineDefaultRuntimeImage =
       pipeline?.pipelines?.[0]?.app_data?.properties?.pipeline_defaults
         ?.runtime_image;
@@ -665,7 +665,7 @@ const PipelineWrapper: React.FC<
     (componentId: string, componentSource: string) => {
       // Show error dialog if the component does not exist
       if (!componentId) {
-        const dialogBody = [];
+        const dialogBody: string[] = [];
         try {
           const componentSourceJson = JSON.parse(componentSource);
           dialogBody.push(`catalog_type: ${componentSourceJson.catalog_type}`);

packages/pipeline-editor/src/RuntimesWidget.tsx

@@ -83,8 +83,8 @@ class RuntimesDisplay extends MetadataDisplay<IRuntimesDisplayProps> {
       metadata.metadata.cos_endpoint as string
     );
 
-    let githubRepoElement = null;
-    let metadata_props = null;
+    let githubRepoElement: JSX.Element | null = null;
+    let metadata_props: GenericObjectType | null = null;
 
     for (const schema of this.props.schemas ?? []) {
       if (schema.name === metadata.schema_name) {

packages/pipeline-editor/src/test/pipeline-hooks.spec.ts

@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 import {
   IRuntimeComponent,
   GENERIC_CATEGORY_ID,

packages/python-editor/package.json

@@ -36,6 +36,7 @@
     "clean:lintcache": "rimraf .eslintcache .stylelintcache",
     "clean:labextension": "rimraf ../../../../labextensions/elyra_python_editor_extension/labextension ../../../../labextensions/elyra_python_editor_extension/_version.py",
     "clean:all": "jlpm clean:lib && jlpm clean:labextension && jlpm clean:lintcache",
+    "cy:instrument": "npx nyc instrument --compact=false --in-place src/ src/",
     "eslint": "jlpm eslint:check --fix",
     "eslint:check": "eslint . --cache --ext .ts,.tsx",
     "install:extension": "jlpm build",

packages/script-debugger/package.json

@@ -36,6 +36,7 @@
     "clean:lintcache": "rimraf .eslintcache .stylelintcache",
     "clean:labextension": "rimraf ../../../../labextensions/elyra_script_debugger_extension/labextension ../../../../labextensions/elyra_script_debugger_extension/_version.py",
     "clean:all": "jlpm clean:lib && jlpm clean:labextension && jlpm clean:lintcache",
+    "cy:instrument": "npx nyc instrument --compact=false --in-place src/ src/",
     "eslint": "jlpm eslint:check --fix",
     "eslint:check": "eslint . --cache --ext .ts,.tsx",
     "install:extension": "jlpm build",

packages/script-debugger/src/index.ts

@@ -149,7 +149,7 @@ const scriptEditorDebuggerExtension: JupyterFrontEndPlugin<void> = {
         type: 'file',
         name: path
       };
-      let sessionConnection = null;
+      let sessionConnection: Session.ISessionConnection | null = null;
       try {
         if (kernelSelection) {
           sessionConnection = await sessionManager.startNew(options);

packages/script-editor/package.json

@@ -35,6 +35,7 @@
     "clean:lintcache": "rimraf .eslintcache .stylelintcache",
     "clean:labextension": "rimraf ../../../../labextensions/elyra_script_editor/labextension ../../../../labextensions/elyra_script_editor/_version.py",
     "clean:all": "jlpm clean:lib && jlpm clean:labextension && jlpm clean:lintcache",
+    "cy:instrument": "npx nyc instrument --compact=false --in-place src/ src/",
     "eslint": "jlpm eslint:check --fix",
     "eslint:check": "eslint . --cache --ext .ts,.tsx",
     "install:extension": "jlpm build",

packages/services/package.json

@@ -35,6 +35,7 @@
     "clean:lintcache": "rimraf .eslintcache .stylelintcache",
     "clean:labextension": "rimraf ../../../../labextensions/elyra_services/labextension ../../../../labextensions/elyra_services/_version.py",
     "clean:all": "jlpm clean:lib && jlpm clean:labextension && jlpm clean:lintcache",
+    "cy:instrument": "npx nyc instrument --compact=false --in-place src/ src/",
     "eslint": "jlpm eslint:check --fix",
     "eslint:check": "eslint . --cache --ext .ts,.tsx",
     "install:extension": "jlpm build",

packages/theme/package.json

@@ -36,6 +36,7 @@
     "clean:lintcache": "rimraf .eslintcache .stylelintcache",
     "clean:labextension": "rimraf ../../../../labextensionselyra_theme_extension/labextension ../../../../labextensionselyra_theme_extension/_version.py",
     "clean:all": "jlpm clean:lib && jlpm clean:labextension && jlpm clean:lintcache",
+    "cy:instrument": "npx nyc instrument --compact=false --in-place src/ src/",
     "eslint": "jlpm eslint:check --fix",
     "eslint:check": "eslint . --cache --ext .ts,.tsx",
     "install:extension": "jlpm build",

packages/ui-components/package.json

@@ -35,6 +35,7 @@
     "clean:lintcache": "rimraf .eslintcache .stylelintcache",
     "clean:labextension": "rimraf ../../../../labextensions/elyra_ui_components/labextension ../../../../labextensions/elyra_ui_components/_version.py",
     "clean:all": "jlpm clean:lib && jlpm clean:labextension && jlpm clean:lintcache",
+    "cy:instrument": "npx nyc instrument --compact=false --in-place src/ src/",
     "eslint": "jlpm eslint:check --fix",
     "eslint:check": "eslint . --cache --ext .ts,.tsx",
     "install:extension": "jlpm build",

packages/ui-components/src/FormComponents/Tags.tsx

@@ -206,7 +206,7 @@ export const Tags: React.FC<ITagProps> = ({
 };
 
 export const TagsField: React.FC<FieldProps> = (props: FieldProps) => {
-  const errors = [];
+  const errors: JSX.Element[] = [];
   const errorSchema = props.errorSchema ?? {};
   if (Object.keys(errorSchema).length > 0) {
     for (const i in props.errorSchema) {

tests/plugins/index.ts

@@ -14,9 +14,13 @@
  * limitations under the License.
  */
 
+import codeCoverage from '@cypress/code-coverage/task';
+
 import { register } from './../utils/snapshots/plugin';
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any -- workaround for snapshot plugin
 export default (on: any, config: any): void => {
   register(on, config);
+  codeCoverage(on, config);
+  return config;
 };

tests/support/commands.ts

@@ -14,6 +14,8 @@
  * limitations under the License.
  */
 
+import '@cypress/code-coverage/support';
+
 import '@testing-library/cypress/add-commands';
 
 import 'cypress-real-events/support';

tests/support/index.d.ts

@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 declare namespace Cypress {
   // eslint-disable-next-line @typescript-eslint/naming-convention
   interface Chainable {

tests/tsconfig.json

@@ -2,12 +2,7 @@
   "extends": "../tsconfig.base.json",
   "compilerOptions": {
     "isolatedModules": false,
-    "types": [
-      "@types/jest",
-      "cypress",
-      "@testing-library/cypress",
-      "cypress-real-events"
-    ],
+    "types": ["cypress", "@testing-library/cypress", "cypress-real-events"],
     "sourceMap": false
   },
   "include": ["**/*.ts"]

testutils/jest.config.js

@@ -39,7 +39,7 @@ module.exports = {
     '^.+\\.(j|t)sx?$': [
       'ts-jest',
       {
-        tsConfig: '../../tests/tsconfig.json'
+        tsConfig: '../../testutils/tsconfig.jest.json'
       }
     ],
     '\\.svg$': '@glen/jest-raw-loader'

testutils/tsconfig.jest.json

@@ -0,0 +1,7 @@
+{
+  "extends": "../tsconfig.base.json",
+  "compilerOptions": {
+    "types": ["@types/jest"]
+  },
+  "include": ["**/*.ts"]
+}

tsconfig.base.json

@@ -16,7 +16,7 @@
 
     /* Additional Checks */
     "noImplicitReturns": true,
-    "noFallthroughCasesInSwitch": true,
+    "noFallthroughCasesInSwitch": false,
     "forceConsistentCasingInFileNames": true,
     "isolatedModules": true,