test(views): use stricter data fixture for retirements

Author: aolieman

tests/data_fixtures/retirements.py

@@ -2,7 +2,7 @@
 
 from sc_audit.db_schema.retirement import Retirement
 
-def get_retirements():
+def get_retirements_whole_and_round_up():
     retirements = [
         Retirement(certificate_id=143471, vcu_amount=1, serial_number='8040-449402275-449402275-VCU-042-MER-PE-14-1360-01072013-30062014-1', retirement_date=datetime.date(2021, 11, 21), retirement_beneficiary='GAVF6ZB7Z7FKCWM5HEY2OV4ENPK3OSSHMFTVR4HHSBFHKW36U3FUH2CB', retirement_details='stellarcarbon.io 61d4ff5516b7098bbc2219d244e7f29a039c32735e1c16d1c05d66a0739727d9', vcs_project_id=1360, issuance_date=datetime.date(2020, 3, 20), instrument_type='VCU', vintage_start=datetime.date(2013, 7, 1), vintage_end=datetime.date(2014, 6, 30), total_vintage_quantity=97259), 
         Retirement(certificate_id=152309, vcu_amount=1, serial_number='8040-449402276-449402276-VCU-042-MER-PE-14-1360-01072013-30062014-1', retirement_date=datetime.date(2022, 9, 18), retirement_beneficiary='GC53JCXZHW3SVNRE4CT6XFP46WX4ACFQU32P4PR3CU43OB7AKKMFXZ6Y via stellarcarbon.io', retirement_details='stellarcarbon.io 63f55c3ff92b239ecdb774c336cb91e896a3e4906a81cbeb23a60f20563c198f', vcs_project_id=1360, issuance_date=datetime.date(2020, 3, 20), instrument_type='VCU', vintage_start=datetime.date(2013, 7, 1), vintage_end=datetime.date(2014, 6, 30), total_vintage_quantity=97259), 
@@ -18,6 +18,15 @@ def get_retirements():
     ]
     return retirements
 
+
+def get_retirements_with_round_down_and_community():
+    retirements = get_retirements_whole_and_round_up()[:-1]
+    assert len(retirements) == 10, "need to update slice on the preceding line"
+    round_down = Retirement(certificate_id=203704, vcu_amount=3, serial_number='8040-449402293-449402295-VCU-042-MER-PE-14-1360-01072013-30062014-1', retirement_date=datetime.date(2023, 6, 14), retirement_beneficiary='GAXLLGNPEMRUMSLHO3QLYDWZCNPQMBDCWYNLVDPR32ABYWDWQO6YXHSL via stellarcarbon.io', retirement_details='stellarcarbon.io 20dbafdc604fc1a48eafc4ce0df2b6151dfa5a5241c307f811a99ce4ddf2fb7f', vcs_project_id=1360, issuance_date=datetime.date(2020, 3, 20), instrument_type='VCU', vintage_start=datetime.date(2013, 7, 1), vintage_end=datetime.date(2014, 6, 30), total_vintage_quantity=97259)
+    community = Retirement(certificate_id=203705, vcu_amount=2, serial_number='8040-449402296-449402297-VCU-042-MER-PE-14-1360-01072013-30062014-1', retirement_date=datetime.date(2023, 6, 14), retirement_beneficiary='The Stellarcarbon Community', retirement_details='stellarcarbon.io 20dbafdc604fc1a48eafc4ce0df2b6151dfa5a5241c307f811a99ce4ddf2fb7f f4bdee046a289d32933a8bae36fa272bfde3acce6d0c68c412be1534249c9134', vcs_project_id=1360, issuance_date=datetime.date(2020, 3, 20), instrument_type='VCU', vintage_start=datetime.date(2013, 7, 1), vintage_end=datetime.date(2014, 6, 30), total_vintage_quantity=97259)
+    return retirements + [round_down, community]
+
+
 search_response = """
     {
         "totalCount": 11,

tests/test_association.py

@@ -8,15 +8,15 @@
 from sc_audit.loader import impact_projects, minted_blocks, retirement_from_block, sink_status
 from sc_audit.loader import sinking_txs as sink_loader
 from sc_audit.loader.utils import VcsSerialNumber
-from tests.data_fixtures.retirements import get_retirements
+from tests.data_fixtures.retirements import get_retirements_whole_and_round_up
 from tests.db_fixtures import new_session
 from tests.test_mint import mock_http as mock_mint_http
 from tests.test_sink import mock_http as mock_sink_http
 
 
 class TestRetirementFromBlock:
     def test_cover_retirement_block_start(self, mock_session_with_blocks):
-        retirement = get_retirements()[0]
+        retirement = get_retirements_whole_and_round_up()[0]
         serial_number = VcsSerialNumber.from_str(retirement.serial_number)
         retirement.vcu_amount = 1
         serial_number.block_start = 449402277
@@ -35,7 +35,7 @@ def test_cover_retirement_block_start(self, mock_session_with_blocks):
             assert rfb.block.block_end != serial_number.block_end
 
     def test_cover_retirement_block_end(self, mock_session_with_blocks):
-        retirement = get_retirements()[0]
+        retirement = get_retirements_whole_and_round_up()[0]
         serial_number = VcsSerialNumber.from_str(retirement.serial_number)
         retirement.vcu_amount = 2
         serial_number.block_start = 449402299
@@ -54,7 +54,7 @@ def test_cover_retirement_block_end(self, mock_session_with_blocks):
             assert rfb.block.block_end == serial_number.block_end
 
     def test_cover_retirement_block_middle(self, mock_session_with_blocks):
-        retirement = get_retirements()[0]
+        retirement = get_retirements_whole_and_round_up()[0]
         serial_number = VcsSerialNumber.from_str(retirement.serial_number)
         retirement.vcu_amount = 3
         serial_number.block_start = 449402280
@@ -73,7 +73,7 @@ def test_cover_retirement_block_middle(self, mock_session_with_blocks):
             assert rfb.block.block_end != serial_number.block_end
 
     def test_cover_retirement_spans_two(self, mock_session_with_blocks):
-        retirement = get_retirements()[0]
+        retirement = get_retirements_whole_and_round_up()[0]
         serial_number = VcsSerialNumber.from_str(retirement.serial_number)
         retirement.vcu_amount = 24
         serial_number.block_start = 449402280
@@ -95,7 +95,7 @@ def test_cover_retirement_spans_two(self, mock_session_with_blocks):
             assert rfb_two.block.block_start < serial_number.block_end < rfb_two.block.block_end
 
     def test_cover_retirement_spans_three(self, mock_session_with_blocks):
-        retirement = get_retirements()[0]
+        retirement = get_retirements_whole_and_round_up()[0]
         serial_number = VcsSerialNumber.from_str(retirement.serial_number)
         retirement.vcu_amount = 32
         serial_number.block_start = 449402289
@@ -119,7 +119,7 @@ def test_cover_retirement_spans_three(self, mock_session_with_blocks):
             assert rfb_three.block.block_start < serial_number.block_end < rfb_three.block.block_end
 
     def test_cover_retirement_overspent(self, mock_session_with_blocks):
-        retirements = get_retirements()
+        retirements = get_retirements_whole_and_round_up()
         with mock_session_with_blocks.begin() as session:
             session.add_all(retirement_from_block.cover_retirement(session, retirements[0]))
             session.add_all(retirement_from_block.cover_retirement(session, retirements[1]))
@@ -129,7 +129,7 @@ def test_cover_retirement_overspent(self, mock_session_with_blocks):
 
     def test_cover_retirement_uncovered(self, mock_session_with_blocks):
         # craft a retirement that extends beyond a known block range
-        retirement = get_retirements()[0]
+        retirement = get_retirements_whole_and_round_up()[0]
         serial_number = VcsSerialNumber.from_str(retirement.serial_number)
         retirement.vcu_amount = 7
         serial_number.block_start = 449402320
@@ -147,11 +147,11 @@ def test_load_retirement_from_block(self, mock_session_with_blocks):
             rfbs = session.scalars(select(RetirementFromBlock)).all()
             assert len(rfbs) == 11
             rfb_total_amount = sum(rfb.vcu_amount for rfb in rfbs)
-            retirement_total_amount = sum(ret.vcu_amount for ret in get_retirements())
+            retirement_total_amount = sum(ret.vcu_amount for ret in get_retirements_whole_and_round_up())
             assert rfb_total_amount == retirement_total_amount
 
     def test_load_rfb_overspent(self, mock_session_with_blocks):
-        duplicate_retirement = get_retirements()[0]
+        duplicate_retirement = get_retirements_whole_and_round_up()[0]
         duplicate_retirement.certificate_id = 0
         with mock_session_with_blocks.begin() as session:
             session.add(duplicate_retirement)
@@ -162,7 +162,7 @@ def test_load_rfb_overspent(self, mock_session_with_blocks):
 
 class TestSinkStatus:
     def test_create_sink_status_one(self, mock_session_with_sink_txs):
-        retirement = get_retirements()[0]
+        retirement = get_retirements_whole_and_round_up()[0]
         with mock_session_with_sink_txs.begin() as session:
             sink_statuses = sink_status.create_sink_statuses(session, retirement)
             assert len(sink_statuses) == 1
@@ -173,7 +173,7 @@ def test_create_sink_status_one(self, mock_session_with_sink_txs):
             assert status.finalized is True
 
     def test_create_sink_status_two(self, mock_session_with_sink_txs):
-        retirement = get_retirements()[10]
+        retirement = get_retirements_whole_and_round_up()[10]
         with mock_session_with_sink_txs.begin() as session:
             sink_statuses = sink_status.create_sink_statuses(session, retirement)
             assert len(sink_statuses) == 2
@@ -185,7 +185,7 @@ def test_create_sink_status_two(self, mock_session_with_sink_txs):
                 assert status.finalized is True
 
     def test_create_sink_status_more(self, mock_session_with_sink_txs):
-        retirement = get_retirements()[8]
+        retirement = get_retirements_whole_and_round_up()[8]
         with mock_session_with_sink_txs.begin() as session:
             sink_statuses = sink_status.create_sink_statuses(session, retirement)
             assert len(sink_statuses) == 7
@@ -196,7 +196,7 @@ def test_create_sink_status_more(self, mock_session_with_sink_txs):
                 assert status.finalized is True
 
     def test_create_sink_status_split_tx(self, mock_session_with_sink_txs):
-        retirements = get_retirements()
+        retirements = get_retirements_whole_and_round_up()
         # construct a retirement that partially fills a sink tx (filling in minimal fields)
         retirement_one = retirements[0]
         retirement_one.retirement_details = "stellarcarbon.io 20dbafdc604fc1a48eafc4ce0df2b6151dfa5a5241c307f811a99ce4ddf2fb7f"
@@ -241,8 +241,8 @@ def test_create_sink_status_split_tx(self, mock_session_with_sink_txs):
             assert sink_tx_two.carbon_amount - sink_tx_two.total_filled == Decimal("0.015")
 
     def test_create_sink_status_empty(self, mock_session_with_sink_txs):
-        retirement_one = get_retirements()[0]
-        retirement_two = get_retirements()[1]
+        retirement_one = get_retirements_whole_and_round_up()[0]
+        retirement_two = get_retirements_whole_and_round_up()[1]
         retirement_two.retirement_details = retirement_one.retirement_details
         with mock_session_with_sink_txs.begin() as session:
             sink_statuses = sink_status.create_sink_statuses(session, retirement_one)
@@ -261,7 +261,7 @@ def test_load_sink_statuses(self, mock_session_with_sink_txs):
             sss = session.scalars(select(SinkStatus)).all()
             assert len(sss) == 18
             ss_total_amount = sum(ss.amount_filled for ss in sss)
-            retirement_total_amount = sum(ret.vcu_amount for ret in get_retirements())
+            retirement_total_amount = sum(ret.vcu_amount for ret in get_retirements_whole_and_round_up())
             assert ss_total_amount == retirement_total_amount
 
             q_finalized_txs = (
@@ -295,7 +295,7 @@ def mock_session(monkeypatch, new_session):
 @pytest.fixture
 def mock_session_with_blocks(mock_mint_http, mock_session):
     with mock_session.begin() as session:
-        session.add_all(get_retirements())
+        session.add_all(get_retirements_whole_and_round_up())
 
     minted_blocks.load_minted_blocks()
     return mock_session

tests/test_mint.py

@@ -24,7 +24,7 @@
 from tests.data_fixtures.minting_transactions import distribution_records as outflows_fix
 from tests.data_fixtures.minting_transactions import minting_transactions as mint_tx_fix
 from tests.data_fixtures.minting_transactions import payment_records as payments_fix
-from tests.data_fixtures.retirements import get_retirements
+from tests.data_fixtures.retirements import get_retirements_whole_and_round_up
 
 
 class TestMintDb:
@@ -129,7 +129,7 @@ def mock_dist_txs(cursor):
 class TestMintLoader:
     def test_reconstructed_from_retirement(self):
         blocks = reconstruct_blocks(
-            mint_txs=mint_tx_fix[:3], latest_block=None, retirements=get_retirements()[:1]
+            mint_txs=mint_tx_fix[:3], latest_block=None, retirements=get_retirements_whole_and_round_up()[:1]
         )
         assert len(blocks) == 3
         assert blocks[0].serial_hash == decode_hash_memo(mint_tx_fix[0]['transaction']['memo'])
@@ -156,7 +156,7 @@ def test_load_minted_blocks_retirements_missing(self, mock_session, mock_http):
 
     def test_load_minted_blocks_verify(self, mock_session, mock_http):
         with mock_session.begin() as session:
-            session.add_all(get_retirements())
+            session.add_all(get_retirements_whole_and_round_up())
 
         load_minted_blocks()
 

tests/test_retirement.py

@@ -12,7 +12,7 @@
 from sc_audit.loader.utils import VcsSerialNumber
 from sc_audit.sources.retirements import format_verra_retirements, get_retirements_list
 from tests.db_fixtures import new_session
-from tests.data_fixtures.retirements import search_response, get_retirements
+from tests.data_fixtures.retirements import search_response, get_retirements_whole_and_round_up
 
 
 class MockClient(Client):
@@ -44,7 +44,7 @@ class TestRetirementSources:
     def test_format_retirements(self):
         retirements_data = format_verra_retirements(search_response)
         assert retirements_data['total_count'] == 11
-        retirements_fix = get_retirements()
+        retirements_fix = get_retirements_whole_and_round_up()
         for i, retirement in enumerate(retirements_data['retirements']):
             assert int(retirement['certificate_id']) == retirements_fix[i].certificate_id
 

tests/test_views.py

@@ -9,7 +9,7 @@
 from sc_audit.loader import sinking_txs as sink_loader
 from sc_audit.loader import sink_status as sink_status_loader
 from sc_audit.views import inventory, retirement, sink_status as sink_status_view, stats
-from tests.data_fixtures.retirements import get_retirements
+from tests.data_fixtures.retirements import get_retirements_with_round_down_and_community
 from tests.db_fixtures import new_session
 from tests.test_mint import mock_http as mock_mint_http
 from tests.test_sink import mock_http as mock_sink_http
@@ -274,7 +274,7 @@ def test_construct_query_project(self):
 class TestRetirementView:
     def test_retirements_full(self, mock_session_with_associations):
         rtdf = retirement.view_retirements()
-        assert len(rtdf) == 11
+        assert len(rtdf) == 12
         assert rtdf.vcu_amount.sum() == 23
         assert rtdf.vcs_project_id.min() == 1360
         assert rtdf.vcs_project_id.max() == 1360
@@ -319,7 +319,7 @@ def test_retirements_pagination_asc(self, mock_session_with_associations):
 
         combined_pages = pd.concat(pages)
         assert combined_pages.certificate_id.is_unique
-        assert len(combined_pages) == 11
+        assert len(combined_pages) == 12
 
     def test_retirements_pagination_desc(self, mock_session_with_associations):
         rtdf = retirement.view_retirements(limit=3, order='desc')
@@ -332,7 +332,7 @@ def test_retirements_pagination_desc(self, mock_session_with_associations):
 
         combined_pages = pd.concat(pages)
         assert combined_pages.certificate_id.is_unique
-        assert len(combined_pages) == 11
+        assert len(combined_pages) == 12
 
 
 class TestStatsView:
@@ -348,8 +348,8 @@ def test_stats_recipient(self, mock_session_with_associations):
             recipient="GAXLLGNPEMRUMSLHO3QLYDWZCNPQMBDCWYNLVDPR32ABYWDWQO6YXHSL"
         )
         assert r1_stats["carbon_sunk"] == Decimal('3.015')
-        assert r1_stats["carbon_retired"] == Decimal('0')
-        assert r1_stats["carbon_pending"] == Decimal('3.015')
+        assert r1_stats["carbon_retired"] == Decimal('3.015')
+        assert r1_stats["carbon_pending"] == Decimal('0')
         assert "carbon_stored" not in r1_stats
 
         r2_stats = stats.get_carbon_stats(
@@ -360,6 +360,14 @@ def test_stats_recipient(self, mock_session_with_associations):
         assert r2_stats["carbon_pending"] == Decimal('0')
         assert "carbon_stored" not in r2_stats
 
+        r3_stats = stats.get_carbon_stats(
+            recipient="GDZTF5ELO5GIJVYYJS4QDN5UMTROJFLYQIG4ACPXWYGLC7VMHCEGIXKX"
+        )
+        assert r3_stats["carbon_sunk"] == Decimal('5')
+        assert r3_stats["carbon_retired"] == Decimal('1.985')
+        assert r3_stats["carbon_pending"] == Decimal('3.015')
+        assert "carbon_stored" not in r3_stats
+
 
 @pytest.fixture
 def mock_session(monkeypatch, new_session):
@@ -378,7 +386,7 @@ def mock_session(monkeypatch, new_session):
 @pytest.fixture
 def mock_session_with_associations(mock_mint_http, mock_sink_http, mock_session):
     with mock_session.begin() as session:
-        session.add_all(get_retirements())
+        session.add_all(get_retirements_with_round_down_and_community())
 
     minted_blocks.load_minted_blocks()
     sink_loader.load_sinking_txs(cursor=999)