Merge pull request #365 from hs2361/test-emission-factor-year

sichen1234 · web-flow · commit 1873f59e8fc4 · 2021-11-22T08:57:58.000-08:00
feat (test): Test if emission factors for the correct year are used
diff --git a/utility-emissions-channel/typescript_app/tests/blockchain-gateway/datalock.test.ts b/utility-emissions-channel/typescript_app/tests/blockchain-gateway/datalock.test.ts
@@ -41,7 +41,7 @@ describe('DataLockGateway', () => {
                 fabricConnector: org.connector,
                 signer: signer,
             }).recordEmissions(adminCaller, {
-                utilityId: 'USA_EIA_252522444142552441242521',
+                utilityId: 'USA_EIA_11208',
                 partyId: uuid4(),
                 fromDate: '2020-05-07T10:10:09Z',
                 thruDate: '2021-05-07T10:10:09Z',
diff --git a/utility-emissions-channel/typescript_app/tests/blockchain-gateway/utilityEmissionsChannel.test.ts b/utility-emissions-channel/typescript_app/tests/blockchain-gateway/utilityEmissionsChannel.test.ts
@@ -1,4 +1,5 @@
 import chai from 'chai';
+import chaiHttp from 'chai-http';
 import { SHA256 } from 'crypto-js';
 import { config } from 'dotenv';
 import { v4 as uuid4 } from 'uuid';
@@ -13,12 +14,13 @@ import ClientError from '../../src/errors/clientError';
 import { setupWebSocket } from '../setup-ws';
 /* eslint-disable-next-line @typescript-eslint/no-unused-vars */
 const should = chai.should();
+chai.use(chaiHttp);
 
 setup('DEBUG', 'DEBUG');
 // env
 config();
 
-const mockUtilityID = 'USA_EIA_252522444142552441242521';
+const mockUtilityID = 'USA_EIA_11208';
 
 describe('UtilityemissionchannelGateway', () => {
     const bcConfig = new BCGatewayConfig();
@@ -94,6 +96,102 @@ describe('UtilityemissionchannelGateway', () => {
             }
         });
 
+        it('should use emissions factors for the correct year', async () => {
+            const mockPartyID2 = uuid4();
+            const usage = 100;
+            const usage_uom_conversion = 1 / 1000;
+            const emissions_uom_conversion = 1;
+            const agent = chai.request.agent('http://127.0.0.1:5984');
+
+            const emission2018 = await utilityEmissionsGateway.recordEmissions(adminCaller, {
+                utilityId: mockUtilityID,
+                partyId: mockPartyID2,
+                fromDate: '2018-01-01T00:00:00Z',
+                thruDate: '2018-01-31T00:00:00Z',
+                energyUseAmount: usage,
+                energyUseUom: 'kWh',
+                url: '',
+                md5: '',
+            });
+
+            const emission2019 = await utilityEmissionsGateway.recordEmissions(adminCaller, {
+                utilityId: mockUtilityID,
+                partyId: mockPartyID2,
+                fromDate: '2019-01-01T00:00:00Z',
+                thruDate: '2019-01-31T00:00:00Z',
+                energyUseAmount: usage,
+                energyUseUom: 'kWh',
+                url: '',
+                md5: '',
+            });
+
+            emission2018.emissionsAmount.should.not.eq(emission2019.emissionsAmount);
+
+            await agent.post('/_session').set('content-type', 'application/json').send({
+                name: 'admin',
+                password: 'adminpw',
+            });
+
+            const emissionSelector = (year: string) => ({
+                selector: {
+                    class: {
+                        $eq: 'org.hyperledger.blockchain-carbon-accounting.utilityemissionsfactoritem',
+                    },
+                    division_id: {
+                        $eq: 'WECC',
+                    },
+                    division_type: {
+                        $eq: 'NERC_REGION',
+                    },
+                    year: {
+                        $eq: year,
+                    },
+                },
+                execution_stats: false,
+            });
+
+            await agent
+                .post('/utilityemissionchannel_utilityemissions/_find')
+                .set('content-type', 'application/json')
+                .send(emissionSelector('2018'))
+                .then((response) => {
+                    response.status.should.be.eq(200);
+                    const data = response.body;
+
+                    const utilityFactor = data.docs[0];
+
+                    const emissions_value =
+                        (Number(utilityFactor.co2_equivalent_emissions) /
+                            Number(utilityFactor.net_generation)) *
+                        usage *
+                        usage_uom_conversion *
+                        emissions_uom_conversion;
+
+                    emission2018.emissionsAmount.should.be.eq(emissions_value);
+                });
+
+            await agent
+                .post('/utilityemissionchannel_utilityemissions/_find')
+                .set('content-type', 'application/json')
+                .send(emissionSelector('2019'))
+                .then((response) => {
+                    response.status.should.be.eq(200);
+                    const data = response.body;
+
+                    const utilityFactor = data.docs[0];
+
+                    const emissions_value =
+                        (Number(utilityFactor.co2_equivalent_emissions) /
+                            Number(utilityFactor.net_generation)) *
+                        usage *
+                        usage_uom_conversion *
+                        emissions_uom_conversion;
+
+                    emission2019.emissionsAmount.should.be.eq(emissions_value);
+                });
+            agent.close();
+        });
+
         const mockTokenId = '0xMockToken';
         it('should update token if for minted records', async () => {
             await utilityEmissionsGateway.updateEmissionsMintedToken(adminCaller, {
diff --git a/utility-emissions-channel/typescript_app/tests/e2e.test.ts b/utility-emissions-channel/typescript_app/tests/e2e.test.ts
@@ -26,7 +26,7 @@ const apiEndpoints = {
 
 const adminVaultToken = 'tokenId';
 const userId = 'admin';
-const mockUtilityID = 'USA_EIA_252522444142552441242521';
+const mockUtilityID = 'USA_EIA_11208';
 
 describe('E2E-vault', () => {
     tests('vault_token', adminVaultToken);
@@ -111,7 +111,7 @@ function tests(headerKey, headerValue) {
     });
     const partyId = uuid4();
     let uuid: string;
-    it('should record a emissions', (done) => {
+    it('should record an emission', (done) => {
         chai.request(v1Base)
             .post(apiEndpoints.recordEmissions)
             .set('content-type', 'application/x-www-form-urlencoded')
diff --git a/utility-emissions-channel/typescript_app/tests/setup.ts b/utility-emissions-channel/typescript_app/tests/setup.ts
@@ -4,14 +4,14 @@ import {
     FabricContractInvocationType,
     FabricSigningCredential,
 } from '@hyperledger/cactus-plugin-ledger-connector-fabric';
+// import { execSync } from 'child_process';
 import { config } from 'dotenv';
 import axios from 'axios';
 config();
 
 const bcConfig = new BCGatewayConfig();
 
 // insert mock utility identifier and factors
-const mockUtilityID = 'USA_EIA_252522444142552441242521';
 async function mockEmissionsRecord() {
     const signer: FabricSigningCredential = {
         keychainId: 'inMemoryKeychain',
@@ -27,9 +27,12 @@ async function mockEmissionsRecord() {
         caId: org.caID,
         mspId: org.orgMSP,
     });
+
     const channelName = 'utilityemissionchannel';
     const ccName = 'utilityemissions';
     // import utility identifier
+    const mockUtilityID = 'USA_EIA_11208';
+
     const p1 = hlfConnector.transact({
         signingCredential: signer,
         channelName: channelName,
@@ -39,13 +42,13 @@ async function mockEmissionsRecord() {
         params: [
             mockUtilityID,
             '2019',
-            '252522444142552441242521',
-            'test-utility-name',
+            '11208',
+            'Los Angeles Department of Water & Power',
             'USA',
             '',
             JSON.stringify({
                 division_type: 'NERC_REGION',
-                division_id: 'MRO',
+                division_id: 'WECC',
             }),
         ],
     });
@@ -58,24 +61,48 @@ async function mockEmissionsRecord() {
         invocationType: FabricContractInvocationType.Send,
         methodName: 'importUtilityFactor',
         params: [
-            'mock-utility-factor',
-            '2019',
+            'USA_2018_NERC_REGION_WECC',
+            '2018',
             'USA',
             'NERC_REGION',
-            'MRO',
-            'SERC_Reliability_Corporation',
-            '46112136.165',
+            'WECC',
+            'Western_Electricity_Coordinating_Council',
+            '743291275',
             'MWH',
-            '47582155.875',
+            '288021204',
             'tons',
             'https://www.epa.gov/sites/production/files/2020-01/egrid2018_all_files.zip',
-            '41078452.268',
-            '5033683.71',
+            '443147683',
+            '300143593',
+            '',
+        ],
+    });
+
+    const p3 = hlfConnector.transact({
+        signingCredential: signer,
+        channelName: channelName,
+        contractName: ccName,
+        invocationType: FabricContractInvocationType.Send,
+        methodName: 'importUtilityFactor',
+        params: [
+            'USA_2019_NERC_REGION_WECC',
+            '2019',
+            'USA',
+            'NERC_REGION',
+            'WECC',
+            'Western_Electricity_Coordinating_Council',
+            '738835346',
+            'MWH',
+            '285747759',
+            'tons',
+            'https://www.epa.gov/sites/production/files/2021-02/egrid2019_data.xlsx',
+            '447805417',
+            '291029929',
             '',
         ],
     });
 
-    await Promise.all([p1, p2]);
+    await Promise.all([p1, p2, p3]);
 }
 
 async function setupVault() {
