Leases! #7043

savanik · 2025-05-18T03:16:13Z

Needs heavy review. Would like assistance writing units tests for (at least some) parts of it.

Design document can be found here: https://tinyurl.com/4erz5r9y

…ore consistent behavior.

…n in shopping list left to do.

…ess sane.

…priately and add leased units to your hanger.

…c from Lease logic.

…n in shopping list left to do.

…ess sane.

…priately and add leased units to your hanger.

…c from Lease logic.

MekHQ/src/mekhq/campaign/Quartermaster.java

MekHQ/src/mekhq/campaign/market/ShoppingList.java

MekHQ/src/mekhq/campaign/unit/Unit.java

Copilot

Pull Request Overview

This PR adds leasing support for large craft (dropships and jumpships), integrating lease creation in the UI and handling monthly lease payments in the campaign’s finance system.

Introduces Lease and LeaseOrder to represent and serialize leases.
Adds UI controls for leasing in UnitViewPanel and the unit selector dialog, plus cancel-lease in the right-click menu.
Updates Finances, Accountant, and Quartermaster to charge, record, and cancel lease payments, and adds the campaign option to track leases.

Reviewed Changes

Copilot reviewed 18 out of 18 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
gui/view/UnitViewPanel.java	Show monthly lease cost when a unit has an active lease
gui/dialog/MekHQUnitSelectorDialog.java	Add Lease/LeaseGM buttons and handler
gui/campaignOptions/contents/FinancesTab.java	Add “Track Leases” checkbox in Finance options tab
gui/adapter/UnitTableMouseAdapter.java	Add “Cancel Lease” popup-menu command
campaign/finances/Lease.java & LeaseOrder.java	Implement lease cost calculations and XML I/O
campaign/Quartermaster.java	Provide `leaseUnit` and `cancelUnitLease` operations
campaign/finances/Finances.java & Accountant.java	Charge monthly lease payments during finance cycle
campaign/CampaignOptions.java	Add `trackLeases` option with XML persistence
resources/*.properties	Add localization strings for lease transactions

Comments suppressed due to low confidence (1)

MekHQ/src/mekhq/gui/dialog/MekHQUnitSelectorDialog.java:113

If selectedUnit is null, this call can NPE. It would be safer to check selectedUnit before dereferencing or use the already-checked getSelectedEntity().

Entity entity = selectedUnit.getEntity();

MekHQ/src/mekhq/gui/campaignOptions/contents/FinancesTab.java

MekHQ/src/mekhq/gui/adapter/UnitTableMouseAdapter.java

MekHQ/src/mekhq/campaign/Quartermaster.java

MekHQ/src/mekhq/campaign/finances/LeaseOrder.java

MekHQ/resources/mekhq/resources/Finances.properties

codecov · 2025-05-18T03:23:45Z

Codecov Report

❌ Patch coverage is 21.71582% with 292 lines in your changes missing coverage. Please review.
⚠️ Please upload report for BASE (main@4bfdf5b). Learn more about missing BASE report.

Files with missing lines	Patch %	Lines
MekHQ/src/mekhq/campaign/unit/UnitOrder.java	0.00%	49 Missing ⚠️
.../src/mekhq/gui/dialog/MekHQUnitSelectorDialog.java	0.00%	45 Missing ⚠️
MekHQ/src/mekhq/campaign/finances/LeaseOrder.java	0.00%	32 Missing ⚠️
MekHQ/src/mekhq/campaign/finances/Lease.java	50.90%	23 Missing and 4 partials ⚠️
MekHQ/src/mekhq/campaign/Quartermaster.java	63.88%	25 Missing and 1 partial ⚠️
MekHQ/src/mekhq/campaign/market/ShoppingList.java	0.00%	21 Missing ⚠️
MekHQ/src/mekhq/campaign/Campaign.java	5.00%	18 Missing and 1 partial ⚠️
...Q/src/mekhq/gui/adapter/UnitTableMouseAdapter.java	0.00%	16 Missing ⚠️
MekHQ/src/mekhq/campaign/unit/Unit.java	23.07%	10 Missing ⚠️
MekHQ/src/mekhq/campaign/finances/Finances.java	0.00%	9 Missing ⚠️
... and 6 more

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #7043   +/-   ##
=======================================
  Coverage        ?   12.49%           
  Complexity      ?     7390           
=======================================
  Files           ?     1140           
  Lines           ?   146648           
  Branches        ?    22489           
=======================================
  Hits            ?    18328           
  Misses          ?   126435           
  Partials        ?     1885

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Scoppio

I have not finished reviewing, but there are lots of stuff to fix, others to change, and alot of redundancy you add.

MekHQ/campaigns/The Learning Ropes.cpnx.gz

MekHQ/mmconf/megameklab.properties.bak

MekHQ/resources/mekhq/resources/Finances.properties

MekHQ/src/mekhq/campaign/CampaignOptions.java

MekHQ/src/mekhq/campaign/Quartermaster.java

MekHQ/src/mekhq/campaign/finances/LeaseOrder.java

MekHQ/src/mekhq/campaign/market/ShoppingList.java

MekHQ/src/mekhq/campaign/unit/Unit.java

IllianiBird

So I know this is still WIP but I thought I'd take a nosey around. I'm going to leave quite a bit of feedback, some minor some not so minor. I am fully onboard with this feature, but we need to be making sure we're doing it right.

MekHQ/resources/mekhq/resources/Finances.properties

MekHQ/mmconf/megameklab.properties.bak

MekHQ/campaigns/The Learning Ropes.cpnx.gz

MekHQ/resources/mekhq/resources/Finances.properties

MekHQ/src/mekhq/campaign/Quartermaster.java

MekHQ/src/mekhq/campaign/unit/UnitOrder.java

MekHQ/src/mekhq/gui/adapter/UnitTableMouseAdapter.java

MekHQ/src/mekhq/gui/campaignOptions/contents/FinancesTab.java

MekHQ/unittests/mekhq/campaign/finances/LeaseTest.java

…rder as well, XML cleanup in ShoppingList, and marking nullable functions as nullable

# Conflicts: # MekHQ/src/mekhq/campaign/CampaignOptions.java # MekHQ/src/mekhq/campaign/finances/Finances.java # MekHQ/src/mekhq/campaign/unit/Unit.java # MekHQ/src/mekhq/campaign/unit/UnitOrder.java # MekHQ/src/mekhq/gui/adapter/ProcurementTableMouseAdapter.java # MekHQ/src/mekhq/gui/adapter/UnitTableMouseAdapter.java # MekHQ/src/mekhq/gui/dialog/MekHQUnitSelectorDialog.java # MekHQ/src/mekhq/gui/view/UnitViewPanel.java

MekHQ/src/mekhq/campaign/CampaignOptions.java

MekHQ/src/mekhq/campaign/Quartermaster.java

MekHQ/src/mekhq/campaign/finances/LeaseOrder.java

MekHQ/src/mekhq/gui/view/UnitViewPanel.java

MekHQ/unittests/mekhq/campaign/finances/LeaseTest.java

Scoppio · 2025-06-01T02:19:25Z

MekHQ/unittests/mekhq/campaign/finances/LeaseTest.java

+        //Act
+        Money testCost = mockUnit.getUnitLease().getLeaseCost();
+
+        //Assert
+        assertEquals(Money.of(3000), testCost);
+    }
+
+    @Test
+    void getLeaseCostNow_WhenFullMonthCost_CalculatesBaseLeaseCostCorrectly() {
+        //Arrange
+        LocalDate testDate = LocalDate.parse("3025-05-01");
+
+        //Act
+        Money testCost = mockUnit.getUnitLease().getLeaseCostNow(testDate);
+
+        //Assert
+        assertEquals(Money.of(3000), testCost);


remove the comments

I think the comments are fine. They're helpful in making tests clearer and also encouraging developers to write well constructed tests.

MekHQ/unittests/mekhq/campaign/finances/LeaseTest.java

…lls properly if you have leased units and disable new lease acquisitions

…othballed.

MekHQ/src/mekhq/campaign/finances/Lease.java

…ds in UnitOrder for dropship TNs.

IllianiBird · 2025-06-18T19:26:16Z

This has been in development for a while and I don't want it to die on the vine. What still needs to be done to bring it across the finish line? :)

savanik added 19 commits May 14, 2025 16:39

Fixes issue MegaMek#7004. Gives buttons in the Purchase Unit dialog m…

65db58b

…ore consistent behavior.

Implements first part of lease object. Leases work, but implementatio…

0f7527e

…n in shopping list left to do.

Implements first part of lease object. Leases work, but implementatio…

6e2dbd7

…n in shopping list left to do.

Implements second part of leases, acquisition rolls are now more or l…

1e7923e

…ess sane.

Implements third part of leases, acquisition rolls now function appro…

1532687

…priately and add leased units to your hanger.

Implements third part of leases, acquisition rolls now function appro…

7eaf7b9

…priately and add leased units to your hanger.

Quick fix for Lease names in acquisition list.

53eaed5

Breaking Lease into Lease and LeaseOrder to separate procurement logi…

28983d7

…c from Lease logic.

Adding functionality for unleasing units to right-click context menu.

fd02de2

Implements first part of lease object. Leases work, but implementatio…

4f1d45d

…n in shopping list left to do.

Implements second part of leases, acquisition rolls are now more or l…

7f3206c

…ess sane.

Implements third part of leases, acquisition rolls now function appro…

a3502ca

…priately and add leased units to your hanger.

Implements third part of leases, acquisition rolls now function appro…

8b8dbb3

…priately and add leased units to your hanger.

Quick fix for Lease names in acquisition list.

e2bbd4b

Breaking Lease into Lease and LeaseOrder to separate procurement logi…

8594271

…c from Lease logic.

Adding functionality for unleasing units to right-click context menu.

3a8075a

Merge remote-tracking branch 'origin/Leases' into Leases

b498eb0

Disambiguating functions.

b8fefd2

Engineering LeaseOrder to work correctly, cleanly, and with less code.

4cb7394

savanik requested a review from a team as a code owner May 18, 2025 03:16

HammerGS requested a review from Copilot May 18, 2025 03:21

github-advanced-security bot found potential problems May 18, 2025

View reviewed changes

HammerGS added the For New Dev Cycle label May 18, 2025

Copilot AI reviewed May 18, 2025

View reviewed changes

Merge branch 'master' into Leases

28b2f75

savanik marked this pull request as draft May 18, 2025 04:14

Scoppio requested changes May 18, 2025

View reviewed changes

Corrected bugs, added documentation, added a unit test.

4c17059

IllianiBird requested changes May 18, 2025

View reviewed changes

savanik added 3 commits May 18, 2025 01:01

Merge remote-tracking branch 'origin/Leases' into Leases

c5fb01d

Code cleanup and proper copyrights.

b83126a

Removing unwanted file inclusions

52735b3

psikomonkie reviewed May 18, 2025

View reviewed changes

MekHQ/unittests/mekhq/campaign/finances/LeaseTest.java Outdated Show resolved Hide resolved

savanik added 2 commits May 18, 2025 23:31

Corrections across many components to correct errors and bugs.

edeab25

Fixing GM Shopping list procure/add functions.

a8282dd

IllianiBird removed the For New Dev Cycle label May 19, 2025

savanik added 7 commits May 19, 2025 23:15

Lease cleanup and some updates to function names for understandability

c070a91

More descriptive variables names in generateInstanceFromXML

6ba628d

More descriptive variables names in generateInstanceFromXML in LeaseO…

3331ad0

…rder as well, XML cleanup in ShoppingList, and marking nullable functions as nullable

Update to latest, cleanup of button handling

17775db

Rewrote all unit tests and updated function permissions

56247dc

Updated LeaseTest with copyright notice

2d8bf57

savanik marked this pull request as ready for review June 1, 2025 00:27

Scoppio requested changes Jun 1, 2025

View reviewed changes

savanik added 3 commits May 31, 2025 23:08

Unit tests for more branches, and finance / accountants now handle bi…

dd42c36

…lls properly if you have leased units and disable new lease acquisitions

Updates from review, internationalization, leased units don't start m…

4bf4518

…othballed.

Magic number update

3d23cd2

github-advanced-security bot found potential problems Jun 1, 2025

View reviewed changes

MekHQ/src/mekhq/campaign/finances/Lease.java Fixed Show fixed Hide fixed

savanik added 4 commits June 1, 2025 02:23

Magic number update (MegaMek#2)

edbaf90

Logger update.

9f21d2e

Updating Lease cost multiplier to divisor for accuracy, updated metho…

e254644

…ds in UnitOrder for dropship TNs.

Merge remote-tracking branch 'upstream/master' into Leases

4b5f34e

HammerGS marked this pull request as draft October 12, 2025 17:35

HammerGS added Unofficial Anything that is not an official BT rule, outside of AtB Draft Work in Progress labels Oct 12, 2025

Leases! #7043

Are you sure you want to change the base?

Leases! #7043

Uh oh!

Conversation

savanik commented May 18, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov bot commented May 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Scoppio left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

IllianiBird left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Scoppio Jun 1, 2025

Choose a reason for hiding this comment

Uh oh!

IllianiBird Jun 18, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

IllianiBird commented Jun 18, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

codecov bot commented May 18, 2025 •

edited

Loading