chore: added coverage for ts files (#2331)

* chore: added coverage for ts files * chore: code review changes * chore: code review changes * chore: step title changes
rudderlabs · Jul 19, 2023 · 6c0fed7 · 6c0fed7
1 parent a66810a
commit 6c0fed7
Show file tree

Hide file tree

Showing 5 changed files with 140 additions and 131 deletions.
diff --git a/.github/workflows/report-code-coverage.yml b/.github/workflows/report-code-coverage.yml
@@ -31,6 +31,7 @@ jobs:
       - name: Run Tests
         run: |
           npm run test:js:ci
+          npm run test:ts:ci
 
       - name: Run Lint Checks
         run: |
@@ -41,11 +42,17 @@ jobs:
         uses: codecov/[email protected]
         with:
           directory: ./reports/coverage
+
+      - name: Upload TS Coverage Reports to Codecov
+        uses: codecov/[email protected]
+        with:
+          directory: ./reports/ts-coverage
 
       - name: Fix filesystem paths in generated reports
         if: always()
         run: |
           sed -i 's+home/runner/work/rudder-transformer/rudder-transformer+/github/workspace+g' reports/coverage/lcov.info
+          sed -i 's+home/runner/work/rudder-transformer/rudder-transformer+/github/workspace+g' reports/ts-coverage/lcov.info
           sed -i 's+/home/runner/work/rudder-transformer/rudder-transformer+/github/workspace+g' reports/eslint.json
 
       - name: SonarCloud Scan

diff --git a/jest.config.typescript.js b/jest.config.typescript.js
@@ -2,185 +2,186 @@
 // https://jestjs.io/docs/en/configuration.html
 
 module.exports = {
-  // All imported modules in your tests should be mocked automatically
-  // automock: false,
+    // All imported modules in your tests should be mocked automatically
+    // automock: false,
 
-  // Stop running tests after `n` failures
-  bail: 1,
+    // Stop running tests after `n` failures
+    bail: 1,
 
-  // Respect "browser" field in package.json when resolving modules
-  // browser: false,
+    // Respect "browser" field in package.json when resolving modules
+    // browser: false,
 
-  // The directory where Jest should store its cached dependency information
-  // cacheDirectory: "/private/var/folders/bj/xt4sffgd21z57fxhvqrd30_80000gn/T/jest_dx",
+    // The directory where Jest should store its cached dependency information
+    // cacheDirectory: "/private/var/folders/bj/xt4sffgd21z57fxhvqrd30_80000gn/T/jest_dx",
 
-  // Automatically clear mock calls and instances between every test
-  // clearMocks: false,
+    // Automatically clear mock calls and instances between every test
+    // clearMocks: false,
 
-  // Indicates whether the coverage information should be collected while executing the test
-  collectCoverage: false,
+    // Indicates whether the coverage information should be collected while executing the test
+    collectCoverage: false,
 
-  // An array of glob patterns indicating a set of files for which coverage information should be collected
-  // collectCoverageFrom: null,
+    // An array of glob patterns indicating a set of files for which coverage information should be collected
+    // collectCoverageFrom: null,
 
-  // The directory where Jest should output its coverage files
-  coverageDirectory: 'reports/coverage',
+    // The directory where Jest should output its coverage files
+    coverageDirectory: 'reports/ts-coverage',
 
-  // An array of regexp pattern strings used to skip coverage collection
-  coveragePathIgnorePatterns: ['/node_modules/', '__tests__'],
+    // An array of regexp pattern strings used to skip coverage collection
+    coveragePathIgnorePatterns: ['/node_modules/', '__tests__'],
 
-  // A list of reporter names that Jest uses when writing coverage reports
-  coverageReporters: ['json', 'text', 'lcov', 'clover'],
+    // A list of reporter names that Jest uses when writing coverage reports
+    coverageReporters: ['json', 'text', 'lcov', 'clover'],
 
-  // An object that configures minimum threshold enforcement for coverage results
-  coverageThreshold: {
-    global: {
-      branches: 60,
-      functions: 80,
-      lines: 80,
+    // An object that configures minimum threshold enforcement for coverage results
+    coverageThreshold: {
+        global: {
+            branches: 30,
+            functions: 40,
+            lines: 50,
+            statements: 50,
+        },
     },
-  },
 
-  // A path to a custom dependency extractor
-  // dependencyExtractor: null,
+    // A path to a custom dependency extractor
+    // dependencyExtractor: null,
 
-  // Make calling deprecated APIs throw helpful error messages
-  errorOnDeprecated: true,
+    // Make calling deprecated APIs throw helpful error messages
+    errorOnDeprecated: true,
 
-  // Force coverage collection from ignored files using an array of glob patterns
-  // forceCoverageMatch: [],
+    // Force coverage collection from ignored files using an array of glob patterns
+    // forceCoverageMatch: [],
 
-  // A path to a module which exports an async function that is triggered once before all test suites
-  // globalSetup: null,
+    // A path to a module which exports an async function that is triggered once before all test suites
+    // globalSetup: null,
 
-  // A path to a module which exports an async function that is triggered once after all test suites
-  // globalTeardown: null,
+    // A path to a module which exports an async function that is triggered once after all test suites
+    // globalTeardown: null,
 
-  // A set of global variables that need to be available in all test environments
-  // globals: {
-  //   'ts-jest': {
-  //     tsConfigFile: 'tsconfig.json',
-  //     diagnostics: true
-  //   },
-  // },
+    // A set of global variables that need to be available in all test environments
+    // globals: {
+    //   'ts-jest': {
+    //     tsConfigFile: 'tsconfig.json',
+    //     diagnostics: true
+    //   },
+    // },
 
-  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
-  // maxWorkers: "50%",
+    // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+    // maxWorkers: "50%",
 
-  // An array of directory names to be searched recursively up from the requiring module's location
-  moduleDirectories: ['node_modules'],
+    // An array of directory names to be searched recursively up from the requiring module's location
+    moduleDirectories: ['node_modules'],
 
-  // An array of file extensions your modules use
-  moduleFileExtensions: ['js', 'json', 'ts', 'node'],
+    // An array of file extensions your modules use
+    moduleFileExtensions: ['js', 'json', 'ts', 'node'],
 
-  // A map from regular expressions to module names that allow to stub out resources with a single module
-  // moduleNameMapper: {},
+    // A map from regular expressions to module names that allow to stub out resources with a single module
+    // moduleNameMapper: {},
 
-  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
-  // modulePathIgnorePatterns: [],
+    // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+    // modulePathIgnorePatterns: [],
 
-  // Activates notifications for test results
-  notify: true,
+    // Activates notifications for test results
+    notify: true,
 
-  // An enum that specifies notification mode. Requires { notify: true }
-  notifyMode: 'failure-change',
+    // An enum that specifies notification mode. Requires { notify: true }
+    notifyMode: 'failure-change',
 
-  // A preset that is used as a base for Jest's configuration
-  preset: 'ts-jest',
+    // A preset that is used as a base for Jest's configuration
+    preset: 'ts-jest',
 
-  // Run tests from one or more projects
-  // projects: null,
+    // Run tests from one or more projects
+    // projects: null,
 
-  // Use this configuration option to add custom reporters to Jest
-  // reporters: undefined,
+    // Use this configuration option to add custom reporters to Jest
+    // reporters: undefined,
 
-  // Automatically reset mock state between every test
-  // resetMocks: false,
+    // Automatically reset mock state between every test
+    // resetMocks: false,
 
-  // Reset the module registry before running each individual test
-  // resetModules: false,
+    // Reset the module registry before running each individual test
+    // resetModules: false,
 
-  // A path to a custom resolver
-  // resolver: null,
+    // A path to a custom resolver
+    // resolver: null,
 
-  // Automatically restore mock state between every test
-  // restoreMocks: false,
+    // Automatically restore mock state between every test
+    // restoreMocks: false,
 
-  // The root directory that Jest should scan for tests and modules within
-  // rootDir: null,
+    // The root directory that Jest should scan for tests and modules within
+    // rootDir: null,
 
-  // A list of paths to directories that Jest should use to search for files in
-  // roots: [
-  //   "<rootDir>"
-  // ],
+    // A list of paths to directories that Jest should use to search for files in
+    // roots: [
+    //   "<rootDir>"
+    // ],
 
-  // Allows you to use a custom runner instead of Jest's default test runner
-  // runner: "jest-runner",
+    // Allows you to use a custom runner instead of Jest's default test runner
+    // runner: "jest-runner",
 
-  // The paths to modules that run some code to configure or set up the testing environment before each test
-  // setupFiles: [],
+    // The paths to modules that run some code to configure or set up the testing environment before each test
+    // setupFiles: [],
 
-  // A list of paths to modules that run some code to configure or set up the testing framework before each test
-  // setupFilesAfterEnv: [],
+    // A list of paths to modules that run some code to configure or set up the testing framework before each test
+    // setupFilesAfterEnv: [],
 
-  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
-  // snapshotSerializers: [],
+    // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+    // snapshotSerializers: [],
 
-  // The test environment that will be used for testing
-  testEnvironment: 'node',
+    // The test environment that will be used for testing
+    testEnvironment: 'node',
 
-  // Options that will be passed to the testEnvironment
-  // testEnvironmentOptions: {},
+    // Options that will be passed to the testEnvironment
+    // testEnvironmentOptions: {},
 
-  // Adds a location field to test results
-  // testLocationInResults: false,
+    // Adds a location field to test results
+    // testLocationInResults: false,
 
-  // The glob patterns Jest uses to detect test files
-  testMatch: ['**/*.(test).ts?(x)'],
+    // The glob patterns Jest uses to detect test files
+    testMatch: ['**/*.(test).ts?(x)'],
 
-  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
-  testPathIgnorePatterns: ['/node_modules/'],
+    // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+    testPathIgnorePatterns: ['/node_modules/'],
 
-  // The regexp pattern or array of patterns that Jest uses to detect test files
-  // testRegex: [],
+    // The regexp pattern or array of patterns that Jest uses to detect test files
+    // testRegex: [],
 
-  // This option allows the use of a custom results processor
-  // testResultsProcessor: null,
+    // This option allows the use of a custom results processor
+    // testResultsProcessor: null,
 
-  // This option allows use of a custom test runner
-  // testRunner: "jasmine2",
+    // This option allows use of a custom test runner
+    // testRunner: "jasmine2",
 
-  // This option sets the URL for the jsdom environment. It is reflected in properties such as location.href
-  // testURL: "http://localhost",
+    // This option sets the URL for the jsdom environment. It is reflected in properties such as location.href
+    // testURL: "http://localhost",
 
-  // Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout"
-  // timers: "real",
+    // Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout"
+    // timers: "real",
 
-  // A map from regular expressions to paths to transformers
-  transform: {
-    '^.+\\.tsx?$': [
-      'ts-jest',
-      {
-        tsconfig: 'tsconfig.json',
-        diagnostics: true,
-      },
-    ],
-  },
+    // A map from regular expressions to paths to transformers
+    transform: {
+        '^.+\\.tsx?$': [
+            'ts-jest',
+            {
+                tsconfig: 'tsconfig.json',
+                diagnostics: true,
+            },
+        ],
+    },
 
-  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
-  // transformIgnorePatterns: [
-  //   "/node_modules/"
-  // ],
+    // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+    // transformIgnorePatterns: [
+    //   "/node_modules/"
+    // ],
 
-  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
-  // unmockedModulePathPatterns: undefined,
+    // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+    // unmockedModulePathPatterns: undefined,
 
-  // Indicates whether each individual test should be reported during the run
-  // verbose: null,
+    // Indicates whether each individual test should be reported during the run
+    // verbose: null,
 
-  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
-  // watchPathIgnorePatterns: [],
+    // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+    // watchPathIgnorePatterns: [],
 
-  // Whether to use watchman for file crawling
-  // watchman: true,
+    // Whether to use watchman for file crawling
+    // watchman: true,
 };
diff --git a/jest.default.config.js b/jest.default.config.js
@@ -38,6 +38,7 @@ module.exports = {
       branches: 60,
       functions: 80,
       lines: 80,
+      statements: 80,
     },
   },
 

diff --git a/package.json b/package.json
@@ -37,7 +37,7 @@
     "test:js:ci": "npm run test:js -- --coverage --expand --maxWorkers=50%",
     "test:ts": "jest -c jest.config.typescript.js --detectOpenHandles",
     "test:ts:silent": "npm run test:ts -- --silent",
-    "test:ts:ci": "npm run test:ts -- --expand --maxWorkers=50%",
+    "test:ts:ci": "npm run test:ts -- --coverage --expand --maxWorkers=50%",
     "test:ut:integration": "jest \"user_transformation.integration.test.js\"  --detectOpenHandles --notify",
     "test:ut:integration:silent": "npm run test:ut:integration -- --silent",
     "test:ut:integration:ci": "npm run test:ut:integration -- --expand --maxWorkers=50%",

diff --git a/sonar-project.properties b/sonar-project.properties
@@ -13,7 +13,7 @@ sonar.links.scm=https://github.com/rudderlabs/rudder-transformer
 sonar.links.issue=https://github.com/rudderlabs/rudder-transformer/issues
 
 # Path to reports
-sonar.javascript.lcov.reportPaths=reports/coverage/lcov.info
+sonar.javascript.lcov.reportPaths=reports/coverage/lcov.info,reports/ts-coverage/lcov.info
 sonar.testExecutionReportPaths=reports/sonar/results-report.xml
 sonar.eslint.reportPaths=reports/eslint.json
 
@@ -24,7 +24,7 @@ sonar.exclusions=**/*.json,**/*.html,**/*.png,**/*.jpg,**/*.gif,**/*.svg,**/*.ym
 
 # Path to tests
 sonar.tests=test
-sonar.test.inclusions=**/*.test.js
+sonar.test.inclusions=**/*.test.js,**/*.test.ts
 sonar.test.exclusions=**/*.json,**/*.html,**/*.png,**/*.jpg,**/*.gif,**/*.svg
 sonar.coverage.exclusions=test/**/*,**/*.json,**/*.html,**/*.png,**/*.jpg,**/*.gif,**/*.svg