Skip to content

CDA-75 Adds flow unit field to water user contract account object and… #98

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adamkorynta merged 2 commits into from
Feb 2, 2026
Merged

CDA-75 Adds flow unit field to water user contract account object and… #98

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0a52f15
CDA-75 fixed unit test
rma-bryson Jan 28, 2026
b14bf58
Merge branch 'main' into bugfix/CDA-75-add-pump-account-units
rma-bryson Feb 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion schema/build.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -536,7 +536,7 @@
<echo message=" Running tests" />
<exec executable="utplsql" resultproperty="utreturn">
<arg value="run"/>
<arg value="-p=${oracle.cwms.user}.test_cwms_rating,${oracle.cwms.user}.test_cwms_text,${oracle.cwms.user}.test_lrts_updates,${oracle.cwms.user}.test_probability_parameter,${oracle.cwms.user}.test_cwms_loc,${oracle.cwms.user}.test_cwms_ts,${oracle.cwms.user}.test_cwms_util,${oracle.cwms.user}.test_cwms_err,${oracle.cwms.user}.test_versioned_time_series,${oracle.cwms.user}.test_update_ts_extents,${oracle.cwms.user}.test_cwms_pool,${oracle.cwms.user}.test_timeseries_snapping,${oracle.cwms.user}.test_cwms_cat,${oracle.cwms.user}.test_cwms_msg,${oracle.cwms.user}.test_cwms_level,${oracle.cwms.user}.test_cwms_display,${oracle.cwms.user}.test_cwms_data_dissem,${oracle.cwms.user}.test_cwms_stream,${oracle.cwms.user}.test_cwms_forecast,${oracle.cwms.user}.test_cwms_xchg,${oracle.cwms.user}.test_cwms_cache"/>
<arg value="-p=${oracle.cwms.user}.test_cwms_rating,${oracle.cwms.user}.test_cwms_text,${oracle.cwms.user}.test_lrts_updates,${oracle.cwms.user}.test_probability_parameter,${oracle.cwms.user}.test_cwms_loc,${oracle.cwms.user}.test_cwms_ts,${oracle.cwms.user}.test_cwms_util,${oracle.cwms.user}.test_cwms_err,${oracle.cwms.user}.test_versioned_time_series,${oracle.cwms.user}.test_update_ts_extents,${oracle.cwms.user}.test_cwms_pool,${oracle.cwms.user}.test_timeseries_snapping,${oracle.cwms.user}.test_cwms_cat,${oracle.cwms.user}.test_cwms_msg,${oracle.cwms.user}.test_cwms_level,${oracle.cwms.user}.test_cwms_water_supply,${oracle.cwms.user}.test_cwms_display,${oracle.cwms.user}.test_cwms_data_dissem,${oracle.cwms.user}.test_cwms_stream,${oracle.cwms.user}.test_cwms_forecast,${oracle.cwms.user}.test_cwms_xchg,${oracle.cwms.user}.test_cwms_cache"/>
<arg value="-f"/><arg value="UT_COVERAGE_HTML_REPORTER"/><arg value="-o"/><arg value="${coverage.dir}/index.html" />
<arg value="-f"/><arg value="UT_COVERAGE_COBERTURA_REPORTER"/><arg value="-o"/><arg value="${coverage.dir}/coverage_pd.xml" />
<arg value="-f"/><arg value="UT_JUNIT_REPORTER"/><arg value="-o"/><arg value="build/tests_pd.xml" />
Expand Down
25 changes: 6 additions & 19 deletions schema/src/cwms/cwms_water_supply_pkg_body.sql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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,
Expand Down
2 changes: 2 additions & 0 deletions schema/src/cwms/types/wat_usr_contract_acct_obj_t.sql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand All @@ -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
);
Expand Down
233 changes: 233 additions & 0 deletions schema/src/test/test_cwms_water_supply.sql
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,233 @@
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';
-- Reuse a single water_user object across setup, test, and teardown
c_water_user water_user_obj_t;

procedure setup
is
begin
-- 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);

-- Initialize reusable water user reference
c_water_user := water_user_obj_t(
location_ref_t(c_project_loc_id, c_office_id),
c_water_user_name,
'TEST RIGHT');

-- Ensure the project exists (AT_PROJECT parent row) for the project location.
-- AT_WATER_USER.project_location_code has an FK to AT_PROJECT (AT_WATER_USER_FK1),
-- so we must create a Project prior to storing a water user/contract.
cwms_project.store_project(project_obj_t(
p_project_location => location_obj_t(location_ref_t(c_project_loc_id, c_office_id)),
p_pump_back_location => null,
p_near_gage_location => null,
p_authorizing_law => null,
p_cost_year => null,
p_federal_cost => null,
p_nonfederal_cost => null,
p_federal_om_cost => null,
p_nonfederal_om_cost => null,
p_remarks => null,
p_project_owner => null,
p_hydropower_description => null,
p_sedimentation_description => null,
p_downstream_urban_description => null,
p_bank_full_capacity_descript => null,
p_yield_time_frame_start => null,
p_yield_time_frame_end => null),
'F');

-- Pre-clean any existing artifacts for deterministic setup.
-- Intentionally continue on any exception so that one failure
-- does not prevent subsequent cleanup operations or setup.
begin
begin
cwms_water_supply.delete_contract(
p_contract_ref => water_user_contract_ref_t(
c_water_user,
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;
exception when others then null; end;

-- Create water user
cwms_water_supply.store_water_user(
p_water_user => c_water_user,
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(
c_water_user,
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
location_obj_t(location_ref_t(c_pump_loc_id, c_office_id)), -- pump_out_location must be location_obj_t
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(
c_water_user,
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
-- Remove the project created during setup to clean AT_PROJECT and children
cwms_project.delete_project(
p_project_id => c_project_loc_id,
p_delete_action => cwms_util.delete_all,
p_db_office_id => c_office_id);
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(
c_water_user,
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;
1 change: 1 addition & 0 deletions schema/src/test/test_grants.sql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ GRANT EXECUTE ON &cwms_schema..test_update_ts_extents to &1;
GRANT EXECUTE ON &cwms_schema..test_timeseries_snapping to &1;
GRANT EXECUTE ON &cwms_schema..test_cwms_cat to &1;
GRANT EXECUTE ON &cwms_schema..test_cwms_level to &1;
GRANT EXECUTE ON &cwms_schema..test_cwms_water_supply to &1;
GRANT EXECUTE ON &cwms_schema..test_cwms_display to &1;
GRANT EXECUTE ON &cwms_schema..test_cwms_stream to &1;
GRANT EXECUTE ON &cwms_schema..test_cwms_lock to &1;
Expand Down
1 change: 1 addition & 0 deletions schema/src/test/tests.sql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down