BLADEBURNER: Test cover action completion #1695

Alpheus · 2024-10-17T12:41:01Z

BLADEBURNER: Test cover action completion

Things covered

main effect of general actions
stat exp, int exp, money and rank rewards for contracts, operations, black ops
simulacrum effect on work
scaling and proportion of reward vs risk (ie. black ops give more rank than ops, stages of scaling of charisma with diplomacy and incite violence depending on chaos levels)

Not covered in this PR

the process loop. Has a dependency to the React router. It's a minor refactor but I was avoiding all source code changes in this stage
random city events
stat rewards on failure. Without explicitly measuring exact formulas and random rolls, the detection between low and high reward is very flaky
precise measurements of stat gain and modifiers, can test that separately through skills
player and sleeve damage—that's mostly already covered by casualties tests
sleeve complete action—sadly a bit more involved to control and simulate due to the process loops overlapping. Requires a minor refactor. Next round.
skill rankups and various scaling

Outcomes

Bladeburner line coverage is now up to 60%. Branch cover is slightly lower than that due to the branches produced by overlaps with data and react components.

This PR makes it easier to perform changes in the following areas:

Stat XP distribution for actions
Chaos changes and stat scaling for things like Diplomacy and Incite Violence
Larger refactors in the action scheduling area
Adding new missions without requiring involved balance simulations

Linked issues

related to PR-1586 BLADE: Adjust IV action to current-city affect rather than global #1586
related to PR-1664 BLADEBURNER: test cover console commands #1664

Documentation

No NS api changes or source changes in any production-facing code.

.eslintignore

Alpheus · 2024-10-17T12:43:04Z

test/jest/Bladeburner/Actions.test.ts

+   *
+   * Example: 1e14 strength exp gives ~~831 strength skill without augs/modifiers
+   */
+  const HIGH_STAT_EXP = 1e14;


Where necessary to guarantee 100% success rate giving the player high combat stats through EXP.

Alpheus · 2024-10-17T12:44:14Z

test/jest/Bladeburner/Actions.test.ts

+  const CITIES = <CityName[]>Object.keys(instanceUsedForTestGeneration.cities);
+
+  /** All the tests depend on this assumption */
+  it("always succeeds with optimal stats, rank, stamina and city chaos levels", () => {


This is not a test directly, but rather a shared assumption that breaks all reliability should this one not pass.

Expect this to change only if we significantly alter balance in favor of making BB harder on combat stats, which I deemed unlikely.

Alpheus · 2024-10-17T12:48:05Z

test/jest/Bladeburner/Actions.test.ts

+    });
+  });
+
+  describe("Upon successful completion", () => {


There's plenty of orthogonal concepts:

the type of action: general, op, black op, contract

failure vs success

custom behavior

black ops need setup

contracts award money

To make test organization easier, I am using the Operation name where applicable to keep the tests in source code separate, but in the test runner they will merge according to the common describe block headers.

Ie. 2 separate tests for

describe Recruitment behavior

describe Recruitment stat gain

Will merge as such:

Alpheus · 2024-10-17T12:50:29Z

test/jest/Bladeburner/Actions.test.ts

+
+    /** Stat EXP check for all actions */
+    /** Checking all of them to avoid regressions */
+    describe.each([...actionIdWithIndividualStat(nonGeneralActions())])("$id.name", ({ id, stat }) => {


This is the most complex bit. It generates pairs of Action + Stat depending on which stat weights are non-zero for each given action. This allows for a quick rundown of all possible combos to make sure we're not missing awards for things like hacking exp and int exp.

These are not hardcoded to the Actions per se, but using the data files through the static Bladeburner instance. It is somewhat coupled to implementation detail but I figured it was the lesser of two evils rather than writing a test suite of all the combinations manually.

Alpheus · 2024-10-17T12:51:25Z

test/jest/Bladeburner/Actions.test.ts

+  function basicStats() {
+    inst.rank = 1;
+    inst.changeRank(Player, 10);
+    Player.gainStrengthExp(LOW_STAT_EXP);
+    Player.gainDefenseExp(LOW_STAT_EXP);
+    Player.gainAgilityExp(LOW_STAT_EXP);
+    Player.gainDexterityExp(LOW_STAT_EXP);
+
+    inst.calculateMaxStamina();
+    inst.stamina = inst.maxStamina;
+
+    resetCity();
+  }


Player setup where we want to keep numbers small in order to more precisely measure floating point operations (usually exp rewards).

Alpheus · 2024-10-17T12:51:52Z

test/jest/Bladeburner/Actions.test.ts

+  function guaranteeSuccess() {
+    inst.rank = 1;
+    inst.changeRank(Player, 1e10);
+
+    Player.gainStrengthExp(HIGH_STAT_EXP);
+    Player.gainDefenseExp(HIGH_STAT_EXP);
+    Player.gainAgilityExp(HIGH_STAT_EXP);
+    Player.gainDexterityExp(HIGH_STAT_EXP);
+    inst.setSkillLevel(BladeburnerSkillName.BladesIntuition, 1e12);
+    inst.setSkillLevel(BladeburnerSkillName.Cloak, 1e12);
+    inst.setSkillLevel(BladeburnerSkillName.DigitalObserver, 1e12);
+    inst.setSkillLevel(BladeburnerSkillName.Reaper, 1e12);
+
+    inst.calculateMaxStamina();
+    inst.stamina = inst.maxStamina;
+
+    resetCity();
+  }


Player setup where we want actions to run as fast as possible (in simulated time) with 100% success chance

Most of these PR comments should probably be code comments, if they're worth noting.

Alpheus · 2024-10-17T12:52:15Z

test/jest/Bladeburner/Actions.test.ts

+  function guaranteeFailure() {
+    inst.rank = 1;
+    inst.changeRank(Player, 400e3); // Minimum to attempt to fail hardest op
+    Player.gainAgilityExp(1e50);
+    inst.calculateMaxStamina();
+    inst.stamina = 0;
+
+    resetCity();
+  }


Guarantee failure on non-general actions by dropping stamina to zero.

Alpheus · 2024-10-17T12:52:59Z

test/jest/Bladeburner/Actions.test.ts

+    inst.cities[inst.city].pop = 1e9;
+
+    /** Disable random event */
+    inst.randomEventCounter = Infinity;


Random events trigger when the counter is <= zero
Don't want random events to interfere with checks for chaos, communities, pops or estimation figures

test/jest/Bladeburner/Actions.test.ts

Alpheus · 2024-10-17T12:55:15Z

New testing PR up @d0sboots. Did a quick self-review. No code changes or early refactor this time. This relates to a few outstanding BB PRs where changes where deemed risky or need further testing. Hoping to get this merged sooner rather than later.

To my knowledge, none of the tests are flaky.

d0sboots

Good tests. Some coding/style stuff, but largely LGTM.

test/jest/Bladeburner/Actions.test.ts

…success

Alpheus · 2024-10-20T10:14:19Z

e8afd19 — covers all review feedback I believe.

Alpheus · 2024-10-20T10:16:18Z

Good tests. Some coding/style stuff, but largely LGTM.

Cheers for going over it so thoroughly!

test/jest/Bladeburner/Actions.test.ts

d0sboots · 2024-10-21T03:46:29Z

test/jest/Bladeburner/Actions.test.ts

      });
    });
  });

  it("have a minimum duration of 1 second", () => {
    complete(SampleContract);
-    expect(inst.actionTimeToComplete).toBeGreaterThanOrEqual(1);
+    expect(bb.actionTimeToComplete).toBeGreaterThanOrEqual(1);
  });

  beforeAll(() => {


Optional: IMO it flows better if your setup code is moved to before the test code, but up to you.

Alpheus added 5 commits October 12, 2024 17:25

test: actions have duration

5ee7863

test: Action stat gain

4f35af6

test: Action stat gain based on weights

ba2b868

test: bladeburner coverage for complete action

6bda3e2

ignore coverage folder (jest+WebStorm)~

06b2238

Alpheus commented Oct 17, 2024

View reviewed changes

.eslintignore Show resolved Hide resolved

Alpheus commented Oct 17, 2024

View reviewed changes

test/jest/Bladeburner/Actions.test.ts Outdated Show resolved Hide resolved

d0sboots reviewed Oct 20, 2024

View reviewed changes

Alpheus added 3 commits October 20, 2024 11:42

misc: use mocked success chance instead of stat EXP for guaranteeing …

14bdfce

…success

review feedback, no nore generators, naming

0c33b41

review feedback: capitalization

e8afd19

Merge branch 'bitburner-official:dev' into BB-test-complete-action

4c04a0d

d0sboots reviewed Oct 21, 2024

View reviewed changes

review feedback: ungolf test setup

c2afb5b

d0sboots merged commit 8d1cfb2 into bitburner-official:dev Oct 22, 2024
5 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

BLADEBURNER: Test cover action completion #1695

BLADEBURNER: Test cover action completion #1695

Alpheus commented Oct 17, 2024

Alpheus Oct 17, 2024

Alpheus Oct 17, 2024

Alpheus Oct 17, 2024

Alpheus Oct 17, 2024

Alpheus Oct 17, 2024

Alpheus Oct 17, 2024

d0sboots Oct 21, 2024

Alpheus Oct 17, 2024

Alpheus Oct 17, 2024

Alpheus commented Oct 17, 2024

d0sboots left a comment

Alpheus commented Oct 20, 2024

Alpheus commented Oct 20, 2024

d0sboots Oct 21, 2024

BLADEBURNER: Test cover action completion #1695

BLADEBURNER: Test cover action completion #1695

Conversation

Alpheus commented Oct 17, 2024

BLADEBURNER: Test cover action completion

Things covered

Not covered in this PR

Outcomes

Linked issues

Documentation

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Alpheus commented Oct 17, 2024

d0sboots left a comment

Choose a reason for hiding this comment

Alpheus commented Oct 20, 2024

Alpheus commented Oct 20, 2024

Choose a reason for hiding this comment