Version checking #232
Merged
Version checking #232
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
steven11sjf
commented
Oct 14, 2024
steven11sjf
commented
- added a new GameVersion enum that tracks game, version, and md5 checksums
- added functions to identify version, verify files and verify data for a FileTreeEditor
- MSR and Dread now only load files that exist for your version
- resource json's store dicts instead of values, with a crc field and an optional versions field of which versions the file is for
- updated the binary format to include a 2byte bitfield for which versions each file is in
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #232 +/- ##
==========================================
+ Coverage 75.53% 75.54% +0.01%
==========================================
Files 77 78 +1
Lines 3670 3766 +96
==========================================
+ Hits 2772 2845 +73
- Misses 898 921 +23 ☔ View full report in Codecov by Sentry. |
henriquegemignani
requested changes
Oct 14, 2024
|
|
||
| def identify_version(editor: FileTreeEditor) -> GameVersion: | ||
| romfs = editor.romfs | ||
| print(romfs) |
|
|
||
| MSR = (0, "1.0.0", Game.SAMUS_RETURNS, 1, "E9F1963CCCD5002CF6DE6E844528DF46", "83E382FB3E95061185184CE7FCB45AF8") | ||
| DREAD_1_0_0 = (1, "1.0.0", Game.DREAD, 1, "8DEC0C18622C6DAC370F84CF3A3AC0B4", "862EB0111C28082F5730FACF583CEF7B") | ||
| DREAD_1_0_1 = (2, "1.0.1", Game.DREAD, 2, "35309081AF05C60CEBC476F78F3609B6", "00") |
There was a problem hiding this comment.
I'd rather these two versions have all_files_hash be None instead.
| DREAD_1_0_1 = (2, "1.0.1", Game.DREAD, 2, "35309081AF05C60CEBC476F78F3609B6", "00") | ||
| DREAD_2_0_0 = (3, "2.0.0", Game.DREAD, 4, "B36FB05261F2E4EAF0408760E1B983FD", "00") | ||
| DREAD_2_1_0 = (4, "2.1.0", Game.DREAD, 8, "782820635AC434A18DF11DE3D4052DD1", "F1A3ABE49305A16F4671E9E64EBCA119") | ||
| UNDEFINED = (-1, "UNDEFINED", None, 2**15, "", "") |
There was a problem hiding this comment.
Remove this entry. Anywhere that'd use it should use None
| return member | ||
|
|
||
| @classmethod | ||
| def get_value(cls, game: Game, version: str): |
There was a problem hiding this comment.
Function is unused and seems weird overall. I'd say remove it
- added a new GameVersion enum that tracks game, version, and md5 checksums - added functions to identify version, verify files and verify data for a FileTreeEditor - MSR and Dread now only load files that exist for your version - resource json's store dicts instead of values, with a crc field and an optional versions field of which versions the file is for - updated the binary format to include a 2byte bitfield for which versions each file is in
for more information, see https://pre-commit.ci
- added generator method to iterate over all asset names in folder - replaced all_asset_names with a generator comprehension
steven11sjf
force-pushed
the
version-checking-2
branch
from
59794c6
to
023dfaf
Compare
for more information, see https://pre-commit.ci
henriquegemignani
requested changes
Oct 16, 2024
| """ | ||
| returns an iterator of all known asset names in a folder | ||
| """ | ||
| return ( |
There was a problem hiding this comment.
Can you add a test for this?
henriquegemignani
requested changes
Oct 16, 2024
| raise ValueError("Not a valid version!") | ||
|
|
||
|
|
||
| def verify_file_structure(editor: FileTreeEditor) -> GameVersion: |
There was a problem hiding this comment.
Can you remove this function and verify_file_integrity? I'm not happy with how they work and I'd rather have not block this PR because of these.
| return md5(data, usedforsecurity=False).digest() | ||
|
|
||
|
|
||
| def identify_version(editor: FileTreeEditor) -> GameVersion: |
There was a problem hiding this comment.
This function should receive the RomFS directly, to not receive a FileTreeEditor in mid-constructor (a thing you should avoid!)
henriquegemignani
approved these changes
Oct 16, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.