save_as() method for every BspClass about bsp_tool HOT 8 OPEN

Titanfall2 / Apex Legends .save_as doesn’t respect external lumps, see #12 for more

from bsp_tool.

Titanfall2 / Apex Legends .save_as doesn’t respect external lumps, see #12 for more

This has been addressed now, but we do need automated testing to ensure this remains stable.

All an automated test needs to confirm (for now) is that loading and saving a .bsp matches the source file byte-for-byte

from bsp_tool.

All base.Bsp subclasses with their unique _preload methods will need their own implementation of the save_as method
Inheritance should cover any .bsp this doesn't apply to (e.g. GoldSrcBsp inherits _preload from QuakeBsp)

from bsp_tool.

All base.Bsp subclasses with their unique _preload methods will need their own implementation of the save_as method

The top comment tracks each base.Bsp subclass this applies to, but their subclasses should also be tested to be sure
For ensuring save_as remains stable we will need enough maps for each branch_script to test the contents of every lump
Any edge cases that arise in SpecialLumpClasses etc. will also need to be permanently tracked with a map & test for that issue

During the initial development of each .save_as method we should also confirm each map against at least 1 game (test it runs)
Occasionally doing this with test maps going forward would also be useful.
Keeping a mental image of how the map should function will hopefully limit "coding in the dark"

from bsp_tool.

Automated testing for .as_bytes() methods will be a big help here
Probably something to implement in branch script testing

from bsp_tool.

#112 shows that we need to test all .as_bytes() methods, specifically for SpecialLumpClasses
Explicitly! Not just indirect testing through .save_as()

Building tests to support .save_as() is bringing out the deep code coverage
Which is great because it means assumptions are getting drawn out & confronted

from bsp_tool.

tests/test_save.py needs to be content aware, otherwise saves must be byte-for-byte

refactors to extensions.diff should now cover this
still need some specialised classes for diffing SpecialLumpClasses
but the refactor has standardised how to do that and is much more modular now

from bsp_tool.

#143 found some bugs w/ RespawnBsp.save_as()
Going to open a new Issue for testing all RespawnBsp's cases in a bit

from bsp_tool.