test: setup test config and add some tests (qlik-oss#13)

.circleci/config.yml

@@ -61,7 +61,7 @@ jobs:
           at: ~/project
       - run:
           name: Unit tests
-          command: echo "No tests.."
+          command: yarn run test
 
   types:
     <<: *defaults

.eslintrc.yml

@@ -39,3 +39,10 @@ overrides:
   - files:
     - src/**/*.jsx
     - src/**/*.js
+
+  # Unit test files
+  - files:
+      - src/**/__tests__/*.test.ts
+      - src/**/__tests__/*.test.tsx
+    env:
+      jest: true

jest.config.js

@@ -0,0 +1,191 @@
+/*
+ * For a detailed explanation regarding each configuration property and type check, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+module.exports = {
+  // All imported modules in your tests should be mocked automatically
+  // automock: false,
+
+  // Stop running tests after `n` failures
+  // bail: 0,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "/private/var/folders/dc/j98t7yvj11n21psdq_xy0y8snk5538/T/jest_tq54ko",
+
+  // Automatically clear mock calls, instances and results before every test
+  // clearMocks: 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: undefined,
+
+  // The directory where Jest should output its coverage files
+  coverageDirectory: "coverage",
+
+  // An array of regexp pattern strings used to skip coverage collection
+  // coveragePathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // Indicates which provider should be used to instrument code for coverage
+  // coverageProvider: "babel",
+
+  // 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: undefined,
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: undefined,
+
+  // Make calling deprecated APIs throw helpful error messages
+  // errorOnDeprecated: false,
+
+  // 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: undefined,
+
+  // A path to a module which exports an async function that is triggered once after all test suites
+  // globalTeardown: undefined,
+
+  // A set of global variables that need to be available in all test environments
+  // globals: {},
+
+  // 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 file extensions your modules use
+  // moduleFileExtensions: [
+  //   "js",
+  //   "jsx",
+  //   "ts",
+  //   "tsx",
+  //   "json",
+  //   "node"
+  // ],
+
+  // A map from regular expressions to module names or to arrays of 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: [],
+
+  // Activates notifications for test results
+  // notify: false,
+
+  // 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: undefined,
+
+  // Run tests from one or more projects
+  // projects: undefined,
+
+  // Use this configuration option to add custom reporters to Jest
+  // reporters: undefined,
+
+  // Automatically reset mock state before every test
+  // resetMocks: false,
+
+  // Reset the module registry before running each individual test
+  // resetModules: false,
+
+  // A path to a custom resolver
+  // resolver: undefined,
+
+  // Automatically restore mock state and implementation before every test
+  // restoreMocks: false,
+
+  // The root directory that Jest should scan for tests and modules within
+  // rootDir: undefined,
+
+  // 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",
+
+  // 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: ['<rootDir>/jest/setup.js'],
+
+  // The number of seconds after which a test is considered as slow and reported as such in the results.
+  // slowTestThreshold: 5,
+
+  // 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: "jsdom",
+
+  // Options that will be passed to the testEnvironment
+  // testEnvironmentOptions: {},
+
+  // Adds a location field to test results
+  // testLocationInResults: false,
+
+  // The glob patterns Jest uses to detect test files
+  testMatch: ["**/src/**/__tests__/*.test.ts?(x)"],
+
+  // 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: [],
+
+  // This option allows the use of a custom results processor
+  // testResultsProcessor: undefined,
+
+  // This option allows use of a custom test runner
+  // testRunner: "jest-circus/runner",
+
+  // 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",
+
+  // A map from regular expressions to paths to transformers
+  // transform: undefined,
+
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  // transformIgnorePatterns: [
+  //   "/node_modules/",
+  //   "\\.pnp\\.[^\\/]+$"
+  // ],
+
+  // 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: undefined,
+
+  // 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,
+};

jest/setup.js

@@ -0,0 +1 @@
+import '@testing-library/jest-dom';

package.json

@@ -25,7 +25,8 @@
     "lint": "eslint src/",
     "start": "nebula serve",
     "sense": "nebula sense --ext src/ext.js --meta src/meta.json",
-    "types:check": "tsc --noEmit"
+    "types:check": "tsc --noEmit",
+    "test": "jest"
   },
   "devDependencies": {
     "@babel/preset-react": "7.14.5",
@@ -39,6 +40,11 @@
     "@nebula.js/cli-sense": "2.3.1",
     "@nebula.js/cli-serve": "2.3.1",
     "@rollup/plugin-typescript": "8.2.5",
+    "@testing-library/dom": "8.11.3",
+    "@testing-library/jest-dom": "5.16.1",
+    "@testing-library/react": "12.1.2",
+    "@testing-library/user-event": "13.5.0",
+    "@types/jest": "27.4.0",
     "@types/react": "17.0.24",
     "@types/react-dom": "17.0.9",
     "@types/react-window": "1.8.5",
@@ -57,6 +63,7 @@
     "eslint-plugin-prettier": "4.0.0",
     "eslint-plugin-react": "7.26.0",
     "eslint-plugin-react-hooks": "4.2.0",
+    "jest": "27.4.7",
     "prettier": "2.4.1",
     "react": "17.0.2",
     "react-dom": "17.0.2",

src/pivot-table/components/DimensionCell.tsx

@@ -39,6 +39,10 @@ const dimTextStyle: React.CSSProperties = {
   marginLeft: 4,
 };
 
+export const testId = 'dim-cell';
+export const testIdExpandIcon = 'expand-icon';
+export const testIdCollapseIcon = 'collapse-icon';
+
 const createOnExpand = ({ dataModel, isLeftColumn, rowIndex, colIndex, constraints }: OnExpandOrCollapseProps) => {
   if (constraints.active) {
     return undefined;
@@ -76,15 +80,15 @@ const DimensionCell = ({
   let cellIcon = null;
 
   if (qCanExpand) {
-    cellIcon = <AddCircleOutlineSharpIcon fontSize="small" />
+    cellIcon = <AddCircleOutlineSharpIcon fontSize="small" data-testid={testIdExpandIcon} />
     onClickHandler = createOnExpand({ dataModel, isLeftColumn, rowIndex, colIndex, constraints });
   } else if (qCanCollapse) {
-    cellIcon = <RemoveCircleOutlineSharpIcon fontSize="small" />
+    cellIcon = <RemoveCircleOutlineSharpIcon fontSize="small" data-testid={testIdCollapseIcon} />
     onClickHandler = createOnCollapse({ dataModel, isLeftColumn, rowIndex, colIndex, constraints });
   }
 
   return (
-    <div style={{ ...style, ...containerStyle}}>
+    <div style={{ ...style, ...containerStyle}} data-testid={testId}>
       <div style={{ ...cellStyle, ...borderStyle }} onClick={onClickHandler} aria-hidden="true">
         {cellIcon}
         <div style={dimTextStyle}>{qText}</div>

src/pivot-table/components/DimensionTitleCell.tsx

@@ -12,8 +12,10 @@ const labelTextStyle: React.CSSProperties = {
   fontStyle: 'italic'
 };
 
+export const testId = 'title-cell';
+
 const DimensionTitleCell = ({ cell, style }: LabelCellProps): JSX.Element => (
-  <div style={{ ...style, ...borderStyle }}>
+  <div style={{ ...style, ...borderStyle }} data-testid={testId}>
     <div style={labelTextStyle}>{cell.value}</div>
   </div>
 );

src/pivot-table/components/EmptyCell.tsx

@@ -5,8 +5,10 @@ interface EmptyCellProps {
   style: React.CSSProperties;
 }
 
+export const testId = 'empty-cell';
+
 const EmptyCell = ({ style }: EmptyCellProps): JSX.Element => (
-  <div style={{ ...style, ...borderStyle }}>
+  <div style={{ ...style, ...borderStyle }} data-testid={testId} >
     {null}
   </div>
 );

src/pivot-table/components/EmptyHeaderCell.tsx

@@ -5,8 +5,10 @@ interface EmptyHeaderCellProps {
   style: React.CSSProperties;
 }
 
+export const testId = 'empty-header-cell';
+
 const EmptyHeaderCell = ({ style }: EmptyHeaderCellProps): JSX.Element => (
-  <div style={{ ...style, ...borderStyle, ...{ borderLeftWidth: 0 } }}>
+  <div style={{ ...style, ...borderStyle, ...{ borderLeftWidth: 0 } }} data-testid={testId}>
     {null}
   </div>
 );

src/pivot-table/components/MeasureCell.tsx

@@ -31,11 +31,13 @@ const containerStyle: React.CSSProperties = {
   justifyContent: 'center',
 };
 
+export const testId = 'measure-cell';
+
 const MeasureCell = ({ cell, style }: MeasureCellProps): JSX.Element => {
   const { qNum, qText } = (cell.value as NxPivotValuePoint);
 
   return (
-    <div style={{...style, ...containerStyle}}>
+    <div style={{...style, ...containerStyle}} data-testid={testId}>
       <div style={qNum === 'NaN' ? nilStyle : numericStyle}>
         <div style={textStyle}>{qText}</div>
       </div>