Additional unit tests and coverage. (#661)

Author: shimkiv

.github/actions/e2e-shared/action.yml

@@ -11,6 +11,10 @@ inputs:
     description: "Shell to use"
     required: true
     default: "bash"
+  mina-branch:
+    description: "Mina repository branch in use"
+    required: true
+    default: "master"
   test-script:
     description: "Test script to run"
     required: false
@@ -51,7 +55,7 @@ runs:
       if: always()
       with:
         if-no-files-found: ignore
-        name: mina-logs-${{ inputs.artifacts-prefix }}-node${{ inputs.node-version }}-${{ inputs.os-type }}
+        name: mina-logs-${{ inputs.artifacts-prefix }}-${{ inputs.mina-branch }}-node${{ inputs.node-version }}-${{ inputs.os-type }}
         path: /tmp/*.log
         retention-days: 5
     - name: Upload E2E test artifacts
@@ -60,6 +64,6 @@ runs:
       if: always()
       with:
         if-no-files-found: ignore
-        name: ${{ inputs.artifacts-prefix }}-report-node${{ inputs.node-version }}-${{ inputs.os-type }}
+        name: ${{ inputs.artifacts-prefix }}-${{ inputs.mina-branch }}-report-node${{ inputs.node-version }}-${{ inputs.os-type }}
         path: reports/html-report/
         retention-days: 30

.github/workflows/nightly-e2e-ci-tests.yml

@@ -45,6 +45,7 @@ jobs:
           node-version: ${{ matrix.node }}
           os-type: ${{ matrix.os }}
           shell: bash
+          mina-branch: 'compatible'
   against-master-real-network-on-linux:
     timeout-minutes: 185
     runs-on: ${{ matrix.os }}
@@ -81,6 +82,7 @@ jobs:
           node-version: ${{ matrix.node }}
           os-type: ${{ matrix.os }}
           shell: bash
+          mina-branch: 'master'
   against-mocked-network-on-macos:
     timeout-minutes: 185
     runs-on: ${{ matrix.os }}
@@ -97,6 +99,7 @@ jobs:
           node-version: ${{ matrix.node }}
           os-type: ${{ matrix.os }}
           shell: bash
+          mina-branch: 'mocked-macos'
   against-mocked-network-on-windows:
     timeout-minutes: 185
     runs-on: ${{ matrix.os }}
@@ -113,3 +116,4 @@ jobs:
           node-version: ${{ matrix.node }}
           os-type: ${{ matrix.os }}
           shell: powershell
+          mina-branch: 'mocked-windows'

.github/workflows/publish.yml

@@ -0,0 +1,36 @@
+#
+# This workflow will publish the package to NPM when the following conditions are met:
+#  - The workflow run was triggered by the successful completion of the 'Smoke E2E tests' workflow
+#  - The target branch is 'origin/main'
+#
+
+name: Publish to NPM
+on:
+  workflow_run:
+    workflows: ['Smoke E2E tests']
+    types: [completed]
+jobs:
+  publish:
+    if: ${{ github.event.workflow_run.conclusion == 'success' }} && github.ref == 'refs/heads/main'
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node: [20]
+    steps:
+      - name: Set up NodeJS
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node }}
+      - name: Git checkout
+        uses: actions/checkout@v4
+      - name: NPM ci & build
+        run: |
+          npm ci
+          npm run build --if-present
+      - name: Publish to NPM if version has changed
+        uses: JS-DevTools/npm-publish@v3
+        with:
+          token: ${{ secrets.NPM_TOKEN }}
+          strategy: upgrade
+        env:
+          INPUT_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/release.yml

@@ -1,3 +1,4 @@
+#
 # Purpose:
 # Automatically bumps the project's patch version bi-weekly on Tuesdays.
 #
@@ -7,8 +8,9 @@
 # - Bumps patch version using `npm version patch`, then creates a new branch 'release/x.x.x'.
 # - Pushes changes and creates a PR to `main` using GitHub CLI.
 # - Can also be triggered manually via `workflow_dispatch`.
-name: Version Bump
+#
 
+name: Version Bump
 on:
   workflow_dispatch: # Allow to manually trigger the workflow
   schedule:

.github/workflows/smoke-e2e-ci-tests.yml

@@ -1,10 +1,16 @@
+#
+# This workflow will run the 'Smoke E2E tests' only when the 'Unit tests' workflow completes successfully.
+#
+
 name: Smoke E2E tests
 on:
-  push:
-  pull_request:
+  workflow_run:
+    workflows: ['Unit tests']
+    types: [completed]
   workflow_dispatch: {}
 jobs:
   against-compatible-real-network-on-linux:
+    if: ${{ (github.event_name == 'workflow_run' && github.event.workflow_run.conclusion == 'success') || github.event_name == 'workflow_dispatch' }}
     timeout-minutes: 30
     runs-on: ${{ matrix.os }}
     strategy:
@@ -40,9 +46,11 @@ jobs:
           node-version: ${{ matrix.node }}
           os-type: ${{ matrix.os }}
           shell: bash
+          mina-branch: 'compatible'
           test-script: 'npm run e2e:test:smoke'
           artifacts-prefix: 'smoke-e2e-tests'
   against-master-real-network-on-linux:
+    if: ${{ (github.event_name == 'workflow_run' && github.event.workflow_run.conclusion == 'success') || github.event_name == 'workflow_dispatch' }}
     timeout-minutes: 30
     runs-on: ${{ matrix.os }}
     strategy:
@@ -78,5 +86,6 @@ jobs:
           node-version: ${{ matrix.node }}
           os-type: ${{ matrix.os }}
           shell: bash
+          mina-branch: 'master'
           test-script: 'npm run e2e:test:smoke'
           artifacts-prefix: 'smoke-e2e-tests'

.github/workflows/ci.yml renamed to .github/workflows/unit-tests.yml

@@ -1,13 +1,14 @@
 #
-# ci.yml
-#
-# Run tests for all pushed commits and opened pull requests on Github.
+# This workflow will run common unit tests, and then run the Sudoku and TicTacToe examples unit tests if the common unit tests pass.
 #
 
-name: CI
-on: [push, pull_request]
+name: Unit tests
+on:
+  push: {}
+  pull_request: {}
+  workflow_dispatch: {}
 jobs:
-  ci:
+  common:
     runs-on: ubuntu-latest
     timeout-minutes: 10
     strategy:
@@ -24,14 +25,25 @@ jobs:
         run: |
           npm ci
           npm run build --if-present
-          npm run test
+          npm run coverage
           cd templates/project-ts
           npm install || true
           npm run test
         env:
           CI: true
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: ./coverage/lcov.info
+          flags: unittests
+          name: zkapp-cli
+          verbose: true
+          handle_no_reports_found: true
+          fail_ci_if_error: false
   sudoku-example:
     runs-on: ubuntu-latest
+    needs: [common]
     strategy:
       matrix:
         node: [18]
@@ -42,6 +54,10 @@ jobs:
           node-version: ${{ matrix.node }}
       - name: Git checkout
         uses: actions/checkout@v4
+      - name: Configure Git
+        run: |
+          git config --global user.email "[email protected]"
+          git config --global user.name "Unit Tests"
       - name: NPM ci, build, & test
         run: |
           npm ci
@@ -56,6 +72,7 @@ jobs:
           CI: true
   tictactoe-example:
     runs-on: ubuntu-latest
+    needs: [common]
     strategy:
       matrix:
         node: [18]
@@ -66,6 +83,10 @@ jobs:
           node-version: ${{ matrix.node }}
       - name: Git checkout
         uses: actions/checkout@v4
+      - name: Configure Git
+        run: |
+          git config --global user.email "[email protected]"
+          git config --global user.name "Unit Tests"
       - name: NPM ci, build, & test
         run: |
           npm ci
@@ -78,28 +99,3 @@ jobs:
           npm run start
         env:
           CI: true
-  publish:
-    if: github.ref == 'refs/heads/main'
-    runs-on: ubuntu-latest
-    # TODO: Add successful e2e smoke testing to preconditions after the https://github.com/o1-labs/zkapp-cli/issues/615 is resolved
-    needs: [ci, sudoku-example, tictactoe-example]
-    strategy:
-      matrix:
-        node: [18]
-    steps:
-      - name: Set up NodeJS
-        uses: actions/setup-node@v4
-        with:
-          node-version: ${{ matrix.node }}
-      - name: Git checkout
-        uses: actions/checkout@v4
-      - name: NPM ci & build
-        run: |
-          npm ci
-          npm run build --if-present
-      - name: Publish to NPM if version has changed
-        uses: JS-DevTools/npm-publish@v1
-        with:
-          token: ${{ secrets.NPM_TOKEN }}
-        env:
-          INPUT_TOKEN: ${{ secrets.NPM_TOKEN }}

README.md

@@ -1,5 +1,7 @@
 # zkApp CLI
 
+[![codecov](https://codecov.io/gh/o1-labs/zkapp-cli/graph/badge.svg?token=3ZKW76ISDB)](https://codecov.io/gh/o1-labs/zkapp-cli)
+
 The zkApp CLI allows you to scaffold, write, test, and deploy zkApps (zero knowledge apps) for [Mina Protocol](https://minaprotocol.com/) using recommended best practices.
 
 Apps are written using [o1js](https://docs.minaprotocol.com/en/zkapps/o1js-reference), a TypeScript framework for writing zero knowledge proof-based smart contracts. o1js is automatically included when you create a project using the zkApp CLI.

jest.config.js

@@ -1,3 +1,21 @@
 export default {
-  testMatch: ['<rootDir>/src/**/*.test.js'],
+  transform: {},
+  testMatch: ['**/src/**/*.test.js'],
+  collectCoverage: true,
+  coverageDirectory: 'coverage',
+  coverageReporters: ['json', 'lcov', 'text', 'clover'],
+  collectCoverageFrom: [
+    '**/src/lib/**/*.js',
+    '!**/src/lib/ui/**',
+    '!**/src/**/*.test.js',
+  ],
+  coveragePathIgnorePatterns: ['/node_modules/'],
+  coverageThreshold: {
+    global: {
+      branches: 90,
+      functions: 90,
+      lines: 90,
+      statements: 90,
+    },
+  },
 };