CDA-75 adds unit test for pump flow unit conversion

CDA-75 adds new unit on retrieval of object

CDA-75 Adds flow unit field to water user contract account object and updated unit conversion on store to use that if it exists.

Author: rma-bryson

schema/src/cwms/cwms_water_supply_pkg_body.sql

@@ -1255,6 +1255,7 @@ BEGIN
           rec.phys_trans_type_tooltip,
           rec.phys_trans_type_active),
         rec.pump_flow * rec.factor + rec.offset,
+        nvl(p_units, 'cms'),
         -- rec.units_id,
         cwms_util.change_timezone(
            rec.transfer_start_datetime,
@@ -1362,24 +1363,6 @@ BEGIN
 
     -- dbms_output.put_line('wuc code: '|| l_contract_code);
 
-    --get the offset and factor
-    ----------------------------------
-    -- get the unit conversion info --
-    ----------------------------------
-    SELECT uc.factor,
-          uc.offset
-     INTO l_factor,
-          l_offset
-     from cwms_base_parameter bp,
-          cwms_unit_conversion uc,
-          cwms_unit u
-    WHERE bp.base_parameter_id = 'Flow'
-      and uc.to_unit_code = bp.unit_code
-      and uc.from_unit_code = u.unit_code
-      and u.unit_id = nvl(p_flow_unit_id,'cms');
-
-    -- dbms_output.put_line('unit conv: '|| l_factor ||', '||l_offset);
-
 --    select count(*) into l_count from at_wat_usr_contract_accounting;
 --    dbms_output.put_line('row count: '|| l_count);
     -- delete existing data
@@ -1427,7 +1410,11 @@ BEGIN
             l_contract_code contract_code,
             acct_tab.pump_location_ref.get_location_code('F') pump_code,
             ptt.phys_trans_type_code xfer_code,
-            acct_tab.pump_flow * l_factor + l_offset flow,
+               cwms_util.convert_units(
+                       acct_tab.pump_flow,
+                       nvl(acct_tab.pump_flow_unit, nvl(p_flow_unit_id,'cms')),
+                       'cms'
+               ) flow,
             cwms_util.change_timezone(
                   acct_tab.transfer_start_datetime,
                   l_time_zone,

schema/src/cwms/types/wat_usr_contract_acct_obj_t.sql

@@ -8,6 +8,7 @@ CREATE type wat_usr_contract_acct_obj_t
  * @member pump_location_ref       The location of the pump for this accounting record
  * @member physical_transfer_type  Identifies the type of water transfer for this accounting record
  * @member pump_flow               The pump flow for this accounting record
+ * @member pump_flow_unit          The unit of the pump flow for this accounting record
  * @member transfer_start_datetime The beginning time for the water transfer for this accounting record
  * @member accounting_remarks      Remarks for this accounting record
  */
@@ -18,6 +19,7 @@ AS
     pump_location_ref location_ref_t, --the contract pump that was used for this accounting.
     physical_transfer_type lookup_type_obj_t,         --The type of transfer for this water movement.  See AT_PHYSICAL_TRANSFER_TYPE_CODE.
     pump_flow binary_double,                  --Param: Flow. The flow associated with the water accounting record
+    pump_flow_unit varchar2(16),             -- The units used for pump_flow
     transfer_start_datetime date,                     --The date this water movement began, DATE includes the time zone.
     accounting_remarks varchar2(255 byte)             --Any comments regarding this water accounting movement
   );

schema/src/test/test_cwms_water_supply.sql

@@ -0,0 +1,208 @@
+set verify off
+create or replace package &&cwms_schema..test_cwms_water_supply as
+--%suite(Test cwms units conversions for water supply accounting)
+
+--%beforeall(setup)
+--%afterall(teardown)
+--%rollback(manual)
+
+procedure setup;
+procedure teardown;
+
+--%test(Roundtrip store/retrieve of pump accounting with per-record units)
+procedure test_roundtrip_pump_accounting_units;
+
+end test_cwms_water_supply;
+/
+show errors;
+
+create or replace package body &&cwms_schema..test_cwms_water_supply as
+
+   c_office_id         varchar2(16) := '&&office_id';
+   c_project_loc_id    varchar2(57) := 'WSUnitsProj';
+   c_pump_loc_id       varchar2(57) := 'WSUnitsPump';
+   c_water_user_name   varchar2(64) := 'WS Units User';
+   c_contract_name     varchar2(64) := 'WS Units Contract';
+
+procedure setup
+is
+begin
+   -- Ensure clean state
+   begin
+      cwms_water_supply.delete_contract(
+         p_contract_ref => water_user_contract_ref_t(
+            water_user_obj_t(
+               location_ref_t(c_project_loc_id, c_office_id),
+               c_water_user_name,
+               null),
+            c_contract_name),
+         p_delete_action => cwms_util.delete_all);
+   exception when others then null; end;
+   begin
+      cwms_water_supply.delete_water_user(
+         p_project_location_ref => location_ref_t(c_project_loc_id, c_office_id),
+         p_entity_name => c_water_user_name,
+         p_delete_action => cwms_util.delete_all);
+   exception when others then null; end;
+   begin
+      cwms_loc.delete_location(c_pump_loc_id, cwms_util.delete_all, c_office_id);
+   exception when others then null; end;
+   begin
+      cwms_loc.delete_location(c_project_loc_id, cwms_util.delete_all, c_office_id);
+   exception when others then null; end;
+
+   -- Create needed locations
+   cwms_loc.store_location(
+      p_location_id    => c_project_loc_id,
+      p_time_zone_id   => 'UTC',
+      p_vertical_datum => null,
+      p_db_office_id   => c_office_id);
+
+   cwms_loc.store_location(
+      p_location_id    => c_pump_loc_id,
+      p_time_zone_id   => 'UTC',
+      p_vertical_datum => null,
+      p_db_office_id   => c_office_id);
+
+   -- Create water user
+   cwms_water_supply.store_water_user(
+      p_water_user => water_user_obj_t(
+         location_ref_t(c_project_loc_id, c_office_id),
+         c_water_user_name,
+         'TEST RIGHT'),
+      p_fail_if_exists => 'F');
+
+   -- Create a simple contract
+   cwms_water_supply.store_contracts(
+      p_contracts => water_user_contract_tab_t(
+         water_user_contract_obj_t(
+            water_user_contract_ref_t(
+               water_user_obj_t(
+                  location_ref_t(c_project_loc_id, c_office_id),
+                  c_water_user_name,
+                  'TEST RIGHT'),
+               c_contract_name),
+            lookup_type_obj_t('CWMS','Storage','', 'T'),
+            null, -- effective
+            null, -- expiration
+            0,    -- contracted_storage
+            0,    -- initial_use_allocation
+            0,    -- future_use_allocation
+            'ac-ft', -- storage units
+            null, -- future_use_percent_activated
+            null, -- total_alloc_percent_activated
+            null, -- pump_out_location
+            null, -- pump_out_below_location
+            null  -- pump_in_location
+         )
+      ),
+      p_fail_if_exists => 'F');
+
+   commit;
+end setup;
+
+procedure teardown
+is
+begin
+   begin
+      cwms_water_supply.delete_contract(
+         p_contract_ref => water_user_contract_ref_t(
+            water_user_obj_t(
+               location_ref_t(c_project_loc_id, c_office_id),
+               c_water_user_name,
+               'TEST RIGHT'),
+            c_contract_name),
+         p_delete_action => cwms_util.delete_all);
+   exception when others then null; end;
+   begin
+      cwms_water_supply.delete_water_user(
+         p_project_location_ref => location_ref_t(c_project_loc_id, c_office_id),
+         p_entity_name => c_water_user_name,
+         p_delete_action => cwms_util.delete_all);
+   exception when others then null; end;
+   begin
+      cwms_loc.delete_location(c_pump_loc_id, cwms_util.delete_all, c_office_id);
+   exception when others then null; end;
+   begin
+      cwms_loc.delete_location(c_project_loc_id, cwms_util.delete_all, c_office_id);
+   exception when others then null; end;
+   commit;
+end teardown;
+
+procedure test_roundtrip_pump_accounting_units
+is
+   l_contract_ref   water_user_contract_ref_t := water_user_contract_ref_t(
+      water_user_obj_t(location_ref_t(c_project_loc_id, c_office_id), c_water_user_name, 'TEST RIGHT'),
+      c_contract_name);
+   l_tz             varchar2(28) := 'UTC';
+   l_start_time     date := to_date('2025-01-01 00:00','yyyy-mm-dd hh24:mi');
+   l_end_time       date := to_date('2025-01-01 01:00','yyyy-mm-dd hh24:mi');
+   l_flow_cfs       binary_double := 100;
+   l_expected_cms   binary_double;
+   l_set            wat_usr_contract_acct_tab_t;
+begin
+   -- Compute expected cms via database conversion logic to avoid hard-coding factors
+   l_expected_cms := cwms_util.convert_units(l_flow_cfs, 'cfs', 'cms');
+
+   -- Store one accounting record with cfs unit
+   cwms_water_supply.store_accounting_set(
+      p_accounting_tab => wat_usr_contract_acct_tab_t(
+         wat_usr_contract_acct_obj_t(
+            l_contract_ref,
+            location_ref_t(c_pump_loc_id, c_office_id),
+            lookup_type_obj_t('CWMS','Pipeline','', 'T'),
+            l_flow_cfs,
+            'cfs',
+            l_start_time,
+            'Roundtrip units test')
+      ),
+      p_contract_ref => l_contract_ref,
+      p_pump_time_window_tab => loc_ref_time_window_tab_t(
+         loc_ref_time_window_obj_t(location_ref_t(c_pump_loc_id, c_office_id), l_start_time, l_end_time)
+      ),
+      p_time_zone => l_tz,
+      p_flow_unit_id => null,
+      p_store_rule => null,
+      p_override_prot => 'F');
+
+   -- Retrieve in cfs and validate
+   cwms_water_supply.retrieve_accounting_set(
+      p_accounting_set => l_set,
+      p_contract_ref => l_contract_ref,
+      p_units => 'cfs',
+      p_start_time => l_start_time,
+      p_end_time => l_end_time,
+      p_time_zone => l_tz,
+      p_start_inclusive => 'T',
+      p_end_inclusive => 'T',
+      p_ascending_flag => 'T',
+      p_row_limit => 10,
+      p_transfer_type => null);
+
+   ut.expect(l_set.count).to_equal(1);
+   ut.expect(abs(l_set(1).pump_flow - l_flow_cfs) < 1e-6).to_be_true();
+   ut.expect(upper(l_set(1).pump_flow_unit)).to_equal('CFS');
+
+   -- Retrieve in cms and validate conversion
+   cwms_water_supply.retrieve_accounting_set(
+      p_accounting_set => l_set,
+      p_contract_ref => l_contract_ref,
+      p_units => 'cms',
+      p_start_time => l_start_time,
+      p_end_time => l_end_time,
+      p_time_zone => l_tz,
+      p_start_inclusive => 'T',
+      p_end_inclusive => 'T',
+      p_ascending_flag => 'T',
+      p_row_limit => 10,
+      p_transfer_type => null);
+
+   ut.expect(l_set.count).to_equal(1);
+   ut.expect(abs(l_set(1).pump_flow - l_expected_cms) < 1e-6).to_be_true();
+   ut.expect(upper(l_set(1).pump_flow_unit)).to_equal('CMS');
+
+end test_roundtrip_pump_accounting_units;
+
+end test_cwms_water_supply;
+/
+show errors;

schema/src/test/tests.sql

@@ -48,6 +48,7 @@ show errors;
 @test_timeseries_snapping.sql;
 @test_cwms_cat.sql;
 @test_cwms_level.sql;
+@test_cwms_water_supply.sql;
 @test_cwms_display.sql;
 @test_cwms_data_dissem.sql;
 @test_cwms_fcst.sql;