Restructure errors in IF

src/__mocks__/fs/index.ts

@@ -28,6 +28,13 @@ export const readFile = async (filePath: string) => {
     throw new Error('file not found');
   }
 
+  if (filePath.includes('fail-csv-reader.csv')) {
+    return `
+cpu-cores-available,≈ç≈¬˚∆∑∂´®øˆ´cpu-cores-utilized,     ---- cpu-manufacturer,cpu-model-name,cpu-tdp,gpu-count,gpu-model-name,Hardware Information on AWS Documentation & Comments,instance-class,instance-storage,memory-available,platform-memory,release-date,storage-drives
+16,8,AWS,AWS Graviton
+16,16,AWS,AWS Graviton,150.00,N/A,N/A,AWS Graviton (ARM),a1.4xlarge,EBS-Only,32,32,November 2018,`;
+  }
+
   /**
    * Used for csv lookup plugin.
    */

src/__tests__/unit/builtins/CommonGenerator.test.ts

@@ -1,12 +1,12 @@
-import {KeyValuePair} from '../../../types/common';
-
 import {ERRORS} from '../../../util/errors';
 
 import {CommonGenerator} from '../../../builtins/mock-observations/helpers/common-generator';
+import {STRINGS} from '../../../config';
 
-const {InputValidationError} = ERRORS;
+const {GlobalConfigError} = ERRORS;
+const {MISSING_GLOBAL_CONFIG} = STRINGS;
 
-describe('lib/mock-observations/CommonGenerator: ', () => {
+describe('builtins/mock-observations/CommonGenerator: ', () => {
   describe('initialize: ', () => {
     it('throws an error when config is not empty object.', async () => {
       const commonGenerator = CommonGenerator({});
@@ -16,26 +16,22 @@ describe('lib/mock-observations/CommonGenerator: ', () => {
       try {
         commonGenerator.next([]);
       } catch (error) {
-        expect(error).toEqual(
-          new InputValidationError(
-            'CommonGenerator: Config must not be null or empty.'
-          )
-        );
+        expect(error).toEqual(new GlobalConfigError(MISSING_GLOBAL_CONFIG));
       }
     });
   });
 
   describe('next(): ', () => {
     it('returns a result with valid data.', async () => {
-      const config: KeyValuePair = {
+      const config: Record<string, any> = {
         key1: 'value1',
         key2: 'value2',
       };
       const commonGenerator = CommonGenerator(config);
 
       expect.assertions(1);
 
-      expect(commonGenerator.next([])).toStrictEqual({
+      expect(commonGenerator.next([])).toEqual({
         key1: 'value1',
         key2: 'value2',
       });

src/__tests__/unit/builtins/RandIntGenerator.test.ts

@@ -4,20 +4,19 @@ import {ERRORS} from '../../../util/errors';
 
 import {RandIntGenerator} from '../../../builtins/mock-observations/helpers/rand-int-generator';
 
-const {InputValidationError} = ERRORS;
+import {STRINGS} from '../../../config';
 
-describe('lib/mock-observations/RandIntGenerator: ', () => {
+const {GlobalConfigError} = ERRORS;
+const {INVALID_NAME, MISSING_MIN_MAX, MISSING_GLOBAL_CONFIG} = STRINGS;
+
+describe('builtins/mock-observations/RandIntGenerator: ', () => {
   describe('initialize', () => {
     it('throws an error when the generator name is empty string.', async () => {
       expect.assertions(1);
       try {
         RandIntGenerator('', {});
       } catch (error) {
-        expect(error).toEqual(
-          new InputValidationError(
-            'RandIntGenerator: `name` is empty or all spaces.'
-          )
-        );
+        expect(error).toEqual(new GlobalConfigError(INVALID_NAME));
       }
     });
 
@@ -26,11 +25,7 @@ describe('lib/mock-observations/RandIntGenerator: ', () => {
       try {
         RandIntGenerator('generator-name', {});
       } catch (error) {
-        expect(error).toEqual(
-          new InputValidationError(
-            'RandIntGenerator: Config must not be null or empty.'
-          )
-        );
+        expect(error).toEqual(new GlobalConfigError(MISSING_GLOBAL_CONFIG));
       }
     });
 
@@ -42,11 +37,7 @@ describe('lib/mock-observations/RandIntGenerator: ', () => {
       try {
         RandIntGenerator('random', config);
       } catch (error) {
-        expect(error).toEqual(
-          new InputValidationError(
-            'RandIntGenerator: Config is missing min or max.'
-          )
-        );
+        expect(error).toEqual(new GlobalConfigError(MISSING_MIN_MAX));
       }
     });
   });

src/__tests__/unit/builtins/coefficient.test.ts

@@ -2,7 +2,10 @@ import {Coefficient} from '../../../builtins/coefficient';
 
 import {ERRORS} from '../../../util/errors';
 
-const {InputValidationError, ConfigNotFoundError} = ERRORS;
+import {STRINGS} from '../../../config';
+
+const {InputValidationError, GlobalConfigError} = ERRORS;
+const {MISSING_GLOBAL_CONFIG} = STRINGS;
 
 describe('builtins/coefficient: ', () => {
   describe('Coefficient: ', () => {
@@ -49,7 +52,6 @@ describe('builtins/coefficient: ', () => {
       it('throws an error when global config is not provided.', () => {
         const config = undefined;
         const coefficient = Coefficient(config!);
-        const expectedMessage = 'Global config is not provided.';
 
         expect.assertions(1);
 
@@ -62,7 +64,9 @@ describe('builtins/coefficient: ', () => {
             },
           ]);
         } catch (error) {
-          expect(error).toStrictEqual(new ConfigNotFoundError(expectedMessage));
+          expect(error).toStrictEqual(
+            new GlobalConfigError(MISSING_GLOBAL_CONFIG)
+          );
         }
       });
 

src/__tests__/unit/builtins/csv-lookup.test.ts

@@ -5,9 +5,19 @@ import AxiosMockAdapter from 'axios-mock-adapter';
 
 import {CSVLookup} from '../../../builtins';
 
+import {STRINGS} from '../../../config';
+
 import {ERRORS} from '../../../util/errors';
 
-const {FileNotFoundError, InputValidationError, ConfigNotFoundError} = ERRORS;
+const {
+  GlobalConfigError,
+  ReadFileError,
+  FetchingFileError,
+  QueryDataNotFoundError,
+  MissingCSVColumnError,
+  CSVParseError,
+} = ERRORS;
+const {MISSING_GLOBAL_CONFIG, MISSING_CSV_COLUMN, NO_QUERY_DATA} = STRINGS;
 
 describe('builtins/CSVLookup: ', () => {
   const mock = new AxiosMockAdapter(axios);
@@ -131,7 +141,7 @@ describe('builtins/CSVLookup: ', () => {
           await csvLookup.execute(input);
         } catch (error) {
           if (error instanceof Error) {
-            expect(error).toBeInstanceOf(FileNotFoundError);
+            expect(error).toBeInstanceOf(ReadFileError);
           }
         }
       });
@@ -160,7 +170,7 @@ describe('builtins/CSVLookup: ', () => {
           await csvLookup.execute(input);
         } catch (error) {
           if (error instanceof Error) {
-            expect(error).toBeInstanceOf(FileNotFoundError);
+            expect(error).toBeInstanceOf(ReadFileError);
           }
         }
       });
@@ -192,7 +202,7 @@ describe('builtins/CSVLookup: ', () => {
           await csvLookup.execute(input);
         } catch (error) {
           if (error instanceof Error) {
-            expect(error).toBeInstanceOf(FileNotFoundError);
+            expect(error).toBeInstanceOf(FetchingFileError);
           }
         }
       });
@@ -340,11 +350,8 @@ describe('builtins/CSVLookup: ', () => {
           await csvLookup.execute(input);
         } catch (error) {
           if (error instanceof Error) {
-            expect(error).toBeInstanceOf(InputValidationError);
-            expect(error.message).toEqual(
-              `Error happened while parsing given CSV file: ./file.csv
-InputValidationError: One or more of the given query parameters are not found in the target CSV file column headers.`
-            );
+            expect(error).toBeInstanceOf(QueryDataNotFoundError);
+            expect(error.message).toEqual(NO_QUERY_DATA);
           }
         }
       });
@@ -368,8 +375,8 @@ InputValidationError: One or more of the given query parameters are not found in
           await csvLookup.execute(input);
         } catch (error) {
           if (error instanceof Error) {
-            expect(error).toBeInstanceOf(ConfigNotFoundError);
-            expect(error.message).toEqual('Global config is not provided.');
+            expect(error).toBeInstanceOf(GlobalConfigError);
+            expect(error.message).toEqual(MISSING_GLOBAL_CONFIG);
           }
         }
       });
@@ -400,10 +407,9 @@ InputValidationError: One or more of the given query parameters are not found in
           await csvLookup.execute(input);
         } catch (error) {
           if (error instanceof Error) {
-            expect(error).toBeInstanceOf(InputValidationError);
+            expect(error).toBeInstanceOf(MissingCSVColumnError);
             expect(error.message).toEqual(
-              `Error happened while parsing given CSV file: ./file.csv
-InputValidationError: There is no column with name: mock.`
+              MISSING_CSV_COLUMN(globalConfig.output)
             );
           }
         }
@@ -477,5 +483,33 @@ InputValidationError: There is no column with name: mock.`
         expect(result).toStrictEqual(expectedResult);
       });
     });
+
+    it('rejects with CSV parse error', async () => {
+      process.env.csv = 'fail';
+      expect.assertions(1);
+      const globalConfig = {
+        filepath: './fail-csv-reader.csv',
+        query: {
+          'cpu-cores-available': 'cpu/available',
+          'cpu-cores-utilized': 'cpu/utilized',
+          'cpu-manufacturer': 'cpu/manufacturer',
+        },
+        output: [['gpu-count']],
+      };
+      const csvLookup = CSVLookup(globalConfig);
+
+      try {
+        await csvLookup.execute([
+          {
+            timestamp: '2024-03-01',
+            'cpu/available': 16,
+            'cpu/utilized': 16,
+            'cpu/manufacturer': 'AWS',
+          },
+        ]);
+      } catch (error) {
+        expect(error).toBeInstanceOf(CSVParseError);
+      }
+    });
   });
 });

src/__tests__/unit/builtins/divide.test.ts

@@ -1,8 +1,10 @@
 import {Divide} from '../../../builtins';
 
 import {ERRORS} from '../../../util/errors';
+import {STRINGS} from '../../../config';
 
-const {InputValidationError, ConfigNotFoundError} = ERRORS;
+const {InputValidationError, GlobalConfigError, MissingInputDataError} = ERRORS;
+const {MISSING_GLOBAL_CONFIG, MISSING_INPUT_DATA} = STRINGS;
 
 describe('builtins/divide: ', () => {
   describe('Divide: ', () => {
@@ -103,7 +105,6 @@ describe('builtins/divide: ', () => {
     });
 
     it('throws an error on missing global config.', async () => {
-      const expectedMessage = 'Global config is not provided.';
       const config = undefined;
       const divide = Divide(config!);
 
@@ -117,7 +118,9 @@ describe('builtins/divide: ', () => {
           },
         ]);
       } catch (error) {
-        expect(error).toStrictEqual(new ConfigNotFoundError(expectedMessage));
+        expect(error).toStrictEqual(
+          new GlobalConfigError(MISSING_GLOBAL_CONFIG)
+        );
       }
     });
 
@@ -148,8 +151,6 @@ describe('builtins/divide: ', () => {
     });
 
     it('throws an error when `denominator` is string.', async () => {
-      const expectedMessage = '`10` is missing from the input.';
-
       const globalConfig = {
         numerator: 'vcpus-allocated',
         denominator: '10',
@@ -168,7 +169,11 @@ describe('builtins/divide: ', () => {
           },
         ]);
       } catch (error) {
-        expect(error).toStrictEqual(new InputValidationError(expectedMessage));
+        expect(error).toStrictEqual(
+          new MissingInputDataError(
+            MISSING_INPUT_DATA(globalConfig.denominator)
+          )
+        );
       }
     });
   });

src/__tests__/unit/builtins/exponent.test.ts

@@ -1,10 +1,12 @@
 import {Exponent} from '../../../builtins/exponent';
 
 import {ERRORS} from '../../../util/errors';
+import {STRINGS} from '../../../config';
 
-const {InputValidationError} = ERRORS;
+const {InputValidationError, MissingInputDataError} = ERRORS;
+const {NOT_NUMERIC_VALUE, MISSING_INPUT_DATA} = STRINGS;
 
-describe('lib/exponent: ', () => {
+describe('builtins/exponent: ', () => {
   describe('Exponent: ', () => {
     const globalConfig = {
       'input-parameter': 'energy/base',
@@ -45,9 +47,6 @@ describe('lib/exponent: ', () => {
       });
 
       it('throws an error on missing params in input.', async () => {
-        const expectedMessage =
-          'Exponent: energy/base is missing from the input array.';
-
         expect.assertions(1);
 
         try {
@@ -59,27 +58,26 @@ describe('lib/exponent: ', () => {
           ]);
         } catch (error) {
           expect(error).toStrictEqual(
-            new InputValidationError(expectedMessage)
+            new MissingInputDataError(MISSING_INPUT_DATA('energy/base'))
           );
         }
       });
 
       it('throws an error on input param value not numeric.', async () => {
-        const expectedMessage = 'Exponent: i-am-not-a-number is not numeric.';
-
         expect.assertions(1);
+        const input = [
+          {
+            duration: 3600,
+            'energy/base': 'i-am-not-a-number',
+            timestamp: '2021-01-01T00:00:00Z',
+          },
+        ];
 
         try {
-          await exponent.execute([
-            {
-              duration: 3600,
-              'energy/base': 'i-am-not-a-number',
-              timestamp: '2021-01-01T00:00:00Z',
-            },
-          ]);
+          await exponent.execute(input);
         } catch (error) {
           expect(error).toStrictEqual(
-            new InputValidationError(expectedMessage)
+            new InputValidationError(NOT_NUMERIC_VALUE(input[0]['energy/base']))
           );
         }
       });