Add unit test workflow with coverage reporting (opensearch-project#346)

Signed-off-by: xil <fridalu66@gmail.com>

Author: lucy66hw

.github/workflows/test-tools.yml

@@ -0,0 +1,39 @@
+name: Test Tools
+
+on:
+  push:
+    branches: ['**']
+    paths:
+      - '.github/workflows/test*.yml'
+      - 'package*.json'
+      - 'tools/**'
+  pull_request:
+    branches: ['**']
+    paths:
+      - '.github/workflows/test*.yml'
+      - 'package*.json'
+      - 'tools/**'
+
+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 ci
+
+      - name: Run Tests
+        run: npm test -- --coverage
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          fail_ci_if_error: false

CHANGELOG.md

@@ -4,6 +4,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 
 ## [Unreleased]
 ### Added
+- Add unit test workflow with coverage reporting ([#346](https://github.com/opensearch-project/opensearch-protobufs/pull/346))
 
 ### Changed
 

jest.config.js

@@ -3,6 +3,10 @@
 module.exports = {
   preset: 'ts-jest',
   testEnvironment: 'node',
-  moduleDirectories: ['node_modules', './tools/src'],
-  collectCoverageFrom: ['tools/src/**']
+  moduleDirectories: ['node_modules', './tools/proto-convert/src'],
+  collectCoverageFrom: [
+    'tools/proto-convert/src/**/*.ts',
+    '!tools/proto-convert/src/**/*.d.ts'
+  ],
+  testMatch: ['**/test/**/*.test.ts']
 }

package.json

@@ -9,7 +9,7 @@
     "backward-compat": "ts-node tools/proto-convert/src/postprocessing/BackwardCompatibleWriter.ts",
     "cleanup-common": "ts-node tools/proto-convert/src/postprocessing/CleanupUnusedMessages.ts -i protos/schemas/common.proto",
     "postprocessing": "npm run backward-compat && npm run cleanup-common",
-    "test": "npx jest --testMatch='**/*.test.ts' --no-watchman"
+    "test": "npx jest --no-watchman"
   },
   "dependencies": {
     "@apidevtools/swagger-parser": "^12.1.0",

tools/proto-convert/test/fixtures/spec/expected.yaml

@@ -95,9 +95,9 @@ components:
       properties:
         id:
           type: integer
-        underscore_name:
+        x_name:
           type: string
-        underscore_type:
+        x_type:
           type: string
           enum:
             - dog
@@ -110,7 +110,7 @@ components:
       properties:
         isTrained:
           type: boolean
-        underscore_breed:
+        x_breed:
           type: string
     Cat:
       type: object
@@ -136,11 +136,11 @@ components:
           required:
             - canFly
           properties:
-            underscore_canFly:
+            x_canFly:
               type: boolean
         - type: object
           required:
             - canTalk
           properties:
-            underscore_canTalk:
+            x_canTalk:
               type: boolean