Not-Enough-Crashes/TESTING.md

Testing Not Enough Crashes

This documents details how to test Not Enough Crashes after making changes.

• To test Fabric in dev, uncomment runtimeOnly project(path: ":TestFabricMod", configuration: "namedElements") in fabric/build.gradle
• To test Forge in dev, uncomment runtimeOnly project(path: ":TestFabricMod", configuration: "namedElements") in forge/build.gradle

To test in production, build the test Fabric/Forge mod and add them alongside NEC.

Crash Handling

Client Initialization Crashes [Fabric-Only]

• In the game config folder, have a file named nec_test_mode.txt with the content init_crash.

  • Start the game

  • Verify:

    • The game crashes.
    • The crash screen appears.
    • 'Not Enough Crashes Test Mod' is blamed.
    • In the terminal, no information is repeated.
    • Click 'Get link' and verify in the log:
      • No information is repeated.
      • System details are present.
      • Suspected Mods: Not Enough Crashes Test Mod (nec_testmod) (may contain ignored mods)

  • Click 'Quit Game' and verify the game closes without any exceptions being logged.

Initialization Suppressed Exception [Fabric-Only]

• In the game config folder, have a file named nec_test_mode.txt with the content suppressed_crash.

  • Start the game

  • Verify:

    • The 'Test Main Exception' exception is present in the log as a normal exception.
    • The 'Test Suppressed Exception' exception is present in the log as a suppressed exception.

  • Click 'Quit Game' and verify the game closes without any exceptions being logged.

Integrated Server Crashes

• In the game config folder, have a file named nec_test_mode.txt with the content server_crash. - Open a Minecraft World. - Verify:

  • The game crashes.

  • The crash screen appears.

  • No mods are blamed.

  • In the terminal, no information is repeated.

  • Verify in the Log, TXT File, and Get Link Site:

    • No information is repeated.
    • System details are present.
    • Suspected Mods: Not Enough Crashes Test Mod (nec_testmod) (may contain ignored mods)
    • Client Crashes Since Restart: 0
    • Integrated Server Crashes Since Restart: 1

  • Verify the txt file has a -server ending

  • Click 'Back to title screen' and re-enter the world.

  • Verify the game is working fine.

Dedicated Server Crashes [Can be tested in dev only]

• In the game config folder, have a file named nec_test_mode.txt with the content server_crash.
  • Start the server
  • Verify:
    • The game crashes.
    • In the terminal, no information is repeated.
    • Verify a -server crash report is generated with:
      • Suspected mods: Not Enough Crashes Test Mod (nec_testmod) (may contain ignored mods)
      • No information is repeated.
      • System details are present.

Client Reported Crashes

• In the game config folder, have the file named nec_test_mode.txt be empty or non-existent.
• Open a Minecraft world.
• Press the left square bracket key.
• Verify:
  • The game crashes.
  • The crash screen appears.
  • 'Not Enough Crashes Test Mod' is blamed (and maybe fabric lifecycle events).
  • Click 'Get link' and verify in the log:
    • No information is repeated.
    • System details are present.
    • Suspected Mods: Not Enough Crashes Test Mod (nec_testmod) (may contain ignored mods)
    • Client Crashes Since Restart: 1
    • Integrated Server Crashes Since Restart: 0
• Click 'Back to title screen' and re-enter the world.
• Verify the game is working fine.

Client Unreported Crashes