Merge pull request #923 from Green-Software-Foundation/mapping-feature

Add `mapping` feature

src/__tests__/common/util/helpers.test.ts

@@ -2,7 +2,11 @@ jest.mock('node:readline/promises', () =>
   require('../../../__mocks__/readline')
 );
 
-import {parseManifestFromStdin} from '../../../common/util/helpers';
+import {
+  parseManifestFromStdin,
+  mapInputIfNeeded,
+  mapConfigIfNeeded,
+} from '../../../common/util/helpers';
 
 describe('common/util/helpers: ', () => {
   describe('parseManifestFromStdin(): ', () => {
@@ -37,8 +41,103 @@ describe('common/util/helpers: ', () => {
       const response = await parseManifestFromStdin();
       const expectedMessage =
         '\nname: mock-name\ndescription: mock-description\n';
-
+      expect.assertions(1);
       expect(response).toEqual(expectedMessage);
     });
   });
+
+  describe('mapInputIfNeeded(): ', () => {
+    it('returns a new object with no changes when mapping is empty.', () => {
+      const input = {
+        timestamp: '2021-01-01T00:00:00Z',
+        duration: 60 * 60 * 24 * 30,
+        'device/carbon-footprint': 200,
+        'device/expected-lifespan': 60 * 60 * 24 * 365 * 4,
+        'resources-reserved': 1,
+        'resources-total': 1,
+      };
+      const mapping = {};
+
+      const result = mapInputIfNeeded(input, mapping);
+
+      expect(result).toEqual(input);
+    });
+
+    it('returns a new object with keys remapped according to the mapping.', () => {
+      const input = {
+        timestamp: '2021-01-01T00:00:00Z',
+        duration: 60 * 60 * 24 * 30,
+        'device/carbon-footprint': 200,
+        'device/expected-lifespan': 60 * 60 * 24 * 365 * 4,
+        'resources-reserved': 1,
+        'resources-total': 1,
+      };
+      const mapping = {'device/emissions-embodied': 'device/carbon-footprint'};
+
+      const expectedOutput = {
+        timestamp: '2021-01-01T00:00:00Z',
+        duration: 60 * 60 * 24 * 30,
+        'device/emissions-embodied': 200,
+        'device/expected-lifespan': 60 * 60 * 24 * 365 * 4,
+        'resources-reserved': 1,
+        'resources-total': 1,
+      };
+
+      const result = mapInputIfNeeded(input, mapping);
+
+      expect(result).toEqual(expectedOutput);
+      expect(result).not.toHaveProperty('device/carbon-footprint');
+    });
+  });
+
+  describe('mapConfigIfNeeded', () => {
+    it('returns the config as is if no mapping is provided.', () => {
+      const config = {
+        filepath: './file.csv',
+        query: {
+          'cpu-cores-available': 'cpu/available',
+          'cpu-cores-utilized': 'cpu/utilized',
+          'cpu-manufacturer': 'cpu/manufacturer',
+        },
+        output: ['cpu-tdp', 'tdp'],
+      };
+
+      const nullMapping = null;
+      expect(mapConfigIfNeeded(config, nullMapping!)).toEqual(config);
+
+      const undefinedMapping = undefined;
+      expect(mapConfigIfNeeded(config, undefinedMapping!)).toEqual(config);
+    });
+
+    it('recursively maps config keys and values according to the mapping.', () => {
+      const config = {
+        filepath: './file.csv',
+        query: {
+          'cpu-cores-available': 'cpu/available',
+          'cpu-cores-utilized': 'cpu/utilized',
+          'cpu-manufacturer': 'cpu/manufacturer',
+        },
+        output: ['cpu-tdp', 'tdp'],
+      };
+      const mapping = {
+        'cpu/utilized': 'cpu/util',
+      };
+
+      const expected = {
+        filepath: './file.csv',
+        query: {
+          'cpu-cores-available': 'cpu/available',
+          'cpu-cores-utilized': 'cpu/util',
+          'cpu-manufacturer': 'cpu/manufacturer',
+        },
+        output: ['cpu-tdp', 'tdp'],
+      };
+      expect(mapConfigIfNeeded(config, mapping)).toEqual(expected);
+    });
+
+    it('returns an empty object or array when config is an empty object or array.', () => {
+      expect(mapConfigIfNeeded({}, {})).toEqual({});
+      expect(mapConfigIfNeeded([], {})).toEqual([]);
+    });
+  });
 });

src/__tests__/if-run/builtins/coefficient.test.ts

@@ -18,7 +18,7 @@ describe('builtins/coefficient: ', () => {
       inputs: {},
       outputs: {},
     };
-    const coefficient = Coefficient(config, parametersMetadata);
+    const coefficient = Coefficient(config, parametersMetadata, {});
 
     describe('init: ', () => {
       it('successfully initalized.', () => {
@@ -53,9 +53,39 @@ describe('builtins/coefficient: ', () => {
         expect(result).toStrictEqual(expectedResult);
       });
 
-      it('throws an error when config is not provided.', () => {
+      it('succcessfully executes when the mapping has data.', () => {
+        const mapping = {
+          carbon: 'carbon-for-production',
+        };
+
+        const coefficient = Coefficient(config, parametersMetadata, mapping);
+        expect.assertions(1);
+
+        const expectedResult = [
+          {
+            duration: 3600,
+            'carbon-for-production': 3,
+            'carbon-product': 9,
+            timestamp: '2021-01-01T00:00:00Z',
+          },
+        ];
+
+        const result = coefficient.execute([
+          {
+            duration: 3600,
+            'carbon-for-production': 3,
+            timestamp: '2021-01-01T00:00:00Z',
+          },
+        ]);
+
+        expect.assertions(1);
+
+        expect(result).toStrictEqual(expectedResult);
+      });
+
+      it('throws an error when global config is not provided.', () => {
         const config = undefined;
-        const coefficient = Coefficient(config!, parametersMetadata);
+        const coefficient = Coefficient(config!, parametersMetadata, {});
 
         expect.assertions(1);
 
@@ -78,7 +108,7 @@ describe('builtins/coefficient: ', () => {
           coefficient: 3,
           'output-parameter': 'carbon-product',
         };
-        const coefficient = Coefficient(invalidConfig, parametersMetadata);
+        const coefficient = Coefficient(invalidConfig, parametersMetadata, {});
         const expectedMessage =
           '"input-parameter" parameter is string must contain at least 1 character(s). Error code: too_small.';
 
@@ -105,7 +135,7 @@ describe('builtins/coefficient: ', () => {
           coefficient: 10,
           'output-parameter': '',
         };
-        const coefficient = Coefficient(invalidConfig, parametersMetadata);
+        const coefficient = Coefficient(invalidConfig, parametersMetadata, {});
         const expectedMessage =
           '"output-parameter" parameter is string must contain at least 1 character(s). Error code: too_small.';
 

src/__tests__/if-run/builtins/copy-param.test.ts

@@ -18,7 +18,7 @@ describe('builtins/copy: ', () => {
       inputs: {},
       outputs: {},
     };
-    const copy = Copy(config, parametersMetadata);
+    const copy = Copy(config, parametersMetadata, {});
 
     describe('init: ', () => {
       it('successfully initalized.', () => {
@@ -51,9 +51,37 @@ describe('builtins/copy: ', () => {
         expect(result).toStrictEqual(expectedResult);
       });
 
+      it('successfully executed when `mapping` has valid data.', () => {
+        expect.assertions(1);
+
+        const mapping = {
+          original: 'from',
+        };
+
+        const copy = Copy(config, parametersMetadata, mapping);
+        const expectedResult = [
+          {
+            duration: 3600,
+            from: 'hello',
+            copy: 'hello',
+            timestamp: '2021-01-01T00:00:00Z',
+          },
+        ];
+
+        const result = copy.execute([
+          {
+            timestamp: '2021-01-01T00:00:00Z',
+            duration: 3600,
+            from: 'hello',
+          },
+        ]);
+
+        expect(result).toStrictEqual(expectedResult);
+      });
+
       it('throws an error when config is not provided.', () => {
         const config = undefined;
-        const copy = Copy(config!, parametersMetadata);
+        const copy = Copy(config!, parametersMetadata, {});
 
         expect.assertions(1);
 
@@ -76,7 +104,7 @@ describe('builtins/copy: ', () => {
           from: 'original',
           to: 'copy',
         };
-        const copy = Copy(config, parametersMetadata);
+        const copy = Copy(config, parametersMetadata, {});
         expect.assertions(1);
 
         try {
@@ -101,8 +129,8 @@ describe('builtins/copy: ', () => {
           from: 'original',
           to: 'copy',
         };
-        const copy = Copy(config, parametersMetadata);
 
+        const copy = Copy(config, parametersMetadata, {});
         const expectedResult = [
           {
             duration: 3600,