Added code coverage.

Signed-off-by: dblock <[email protected]>

.github/workflows/test-tools.yml → .github/workflows/test-tools-integ.yml

@@ -1,4 +1,4 @@
-name: Test Tools
+name: Test Tools (Integration)
 
 on:
   push:
@@ -9,6 +9,7 @@ on:
       - 'jest.config.js'
       - 'tsconfig.json'
       - 'tools/**'
+      - '.github/workflows/test-tools*.yml'
   pull_request:
     branches: ['**']
     paths:
@@ -17,6 +18,7 @@ on:
       - 'jest.config.js'
       - 'tsconfig.json'
       - 'tools/**'
+      - '.github/workflows/test-tools*.yml'
 
 jobs:
   test:
@@ -43,8 +45,9 @@ jobs:
       - name: Install Dependencies
         run: npm install
 
-      - name: Lint
-        run: npm run lint
-
       - name: Tests
-        run: npm run test
+        run: |
+          npm run test:integ -- --coverage
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v3

.github/workflows/test-tools-unit.yml

@@ -0,0 +1,46 @@
+name: Test Tools (Unit)
+
+on:
+  push:
+    branches: ['**']
+    paths:
+      - 'package*.json'
+      - 'eslint.config.mjs'
+      - 'jest.config.js'
+      - 'tsconfig.json'
+      - 'tools/**'
+      - '.github/workflows/test-tools*.yml'
+  pull_request:
+    branches: ['**']
+    paths:
+      - 'package*.json'
+      - 'eslint.config.mjs'
+      - 'jest.config.js'
+      - 'tsconfig.json'
+      - 'tools/**'
+      - '.github/workflows/test-tools*.yml'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '20'
+
+      - name: Install Dependencies
+        run: npm install
+
+      - name: Lint
+        run: npm run lint
+
+      - name: Tests
+        run: |
+          npm run test:unit -- --coverage
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v3

.gitignore

@@ -14,4 +14,8 @@ node_modules
 _site/
 
 # build output
-build/
+build/
+
+# coverage output
+coverage/
+

CHANGELOG.md

@@ -15,6 +15,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Added license headers to TypeScript code ([#311](https://github.com/opensearch-project/opensearch-api-specification/pull/311))
 - Added `npm run test:spec -- --dry-run --verbose` ([#303](https://github.com/opensearch-project/opensearch-api-specification/pull/303))
 - Added `npm run test:unit` and `test:integ` ([#320](https://github.com/opensearch-project/opensearch-api-specification/pull/320))
+- Added code coverage ([#323](https://github.com/opensearch-project/opensearch-api-specification/pull/323))
 
 ### Changed
 

DEVELOPER_GUIDE.md

@@ -417,9 +417,13 @@ This workflow performs a [Jekyll](https://jekyllrb.com/) build of the `main` bra
 
 This workflow is triggered by the completion of the workflows such as [Analyze PR Changes](#analyze-pr-changes) and downloading a JSON payload artifact which it uses to invoke a template from [.github/pr-comment-templates](.github/pr-comment-templates) to render a comment which is placed on the original triggering PR.
 
-### [Test Tools](.github/workflows/test-tools.yml)
+### [Test Tools (Unit)](.github/workflows/test-tools-unit.yml)
 
-This workflow runs on PRs to invoke the [tools' tests](tools/tests) and [TypeScript linting](#lints) to ensure there are no breakages in behavior or departures from the desired code style and cleanliness.
+This workflow runs on PRs to invoke the [tools' unit tests](tools/tests), upload test coverage to CodeCov, and run [TypeScript linting](#lints) to ensure there are no breakages in behavior or departures from the desired code style and cleanliness.
+
+### [Test Tools (Integration)](.github/workflows/test-tools-integ.yml)
+
+This workflow runs on PRs to invoke the [tools' integration tests](tools/tests) that require a running instance of OpenSearch to ensure there are no breakages in behavior.
 
 ### [Validate Spec](.github/workflows/validate-spec.yml)