Allow Games to define arbitrary GameFolderTypes (game path Ids)

[Al12rs]

fixes #492

TODO:

• Change GameFolderType to ValueObject
  • Fix Serialization/deserialization
• Add a LocationsManager
  • Detect nested locations and allow easy query
  • Properly initialize LocationsManager on setup
  • Add XML doc comments
  • Add Tests
• Update AGame.GetLocations() to return dictionary to ensure unique GameFolderTypes
• [ ] How to handle nested GamePaths moved to Properly support Game Locations with same or nested AbsolutePaths  #658
• Fix tests (They work locally on both Linux and Windows)
• Remove IGameLocator parameter from AGame.GetLocations()
• Handle Location Ids that point to the same path ? Added to Properly support Game Locations with same or nested AbsolutePaths  #658 as well.
• Rename GameFolderType to either LocationId
• Investigate why CI is failing (CI was choking on the implicit conversion of paramerters to LocationId in the [Theory] tests)

[Al12rs]

Removed draft to let tests run

[Al12rs]

Tests are failing strangely in the Advanced Installer project, but I can't reproduce locally. Any clues what is happening there?

[Sewer56]

After latest commit (f445583) , seems good to merge

[Sewer56]

Tests are failing strangely in the Advanced Installer project, but I can't reproduce locally. Any clues what is happening there?

No idea, but no issues on Linux locally either.

The code in this PR shouldn't affect current Advanced Installer code on Main branch (only Suggestions/Common Folders, which is a future PR). Advanced Installer code doesn't have anything special; no shared, state, concurrency, etc. so if it failed, that would have been weird.

[Sewer56]

CI failure seems to be caused by a lot of:

2023-09-21T13:05:45.1337779Z [xUnit.net 00:00:01.20] Catastrophic failure: System.ArgumentException : There is at least one object in this array that cannot be serialized (Parameter 'array')
2023-09-21T13:05:45.1344628Z [xUnit.net 00:00:01.20]     [FATAL ERROR] System.ArgumentException
2023-09-21T13:05:45.1408381Z [xUnit.net 00:00:01.21]       System.ArgumentException : There is at least one object in this array that cannot be serialized (Parameter 'array')
2023-09-21T13:05:45.1412170Z [xUnit.net 00:00:01.21]       Stack Trace:
2023-09-21T13:05:45.1416019Z [xUnit.net 00:00:01.21]         /_/src/xunit.runner.utility/Extensions/MessageSinkMessageExtensions.cs(39,0): at MessageSinkMessageExtensions.Dispatch[TMessage](IMessageSinkMessage message, HashSet`1 messageTypes, MessageHandler`1 callback)

Something fails to log in CI, unclear if caused by chances to main, or changes to branch.

Not related to AdvancedInstaller

[Sewer56]

I can't repro it locally either. Not in release or debug mode.

We've been updating a lot of dependencies in main lately. Maybe something we use broke specifically in CI under some weird circumstance.

[codecov]

Codecov Report

Merging #656 (2893e89) into main (68544d9) will increase coverage by 0.03%.
The diff coverage is 76.05%.

@@            Coverage Diff             @@
##             main     #656      +/-   ##
==========================================
+ Coverage   64.12%   64.16%   +0.03%     
==========================================
  Files         622      624       +2     
  Lines       17472    17569      +97     
  Branches     1120     1131      +11     
==========================================
+ Hits        11204    11273      +69     
- Misses       5992     6016      +24     
- Partials      276      280       +4     

Flag	Coverage Δ
Linux	63.50% <76.05%> (+0.05%)	⬆️
Windows	63.36% <76.05%> (+0.14%)	⬆️
clean_environment_tests	64.15% <76.05%> (+0.03%)	⬆️
network_tests	?

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Changed	Coverage
...LegendaryEdition/SkyrimLegendaryEditionGameTool.cs	0.00%
...yrimSpecialEdition/SkyrimSpecialEditionGameTool.cs	0.00%
...ames/NexusMods.Games.RedEngine/RedModDeployTool.cs	0.00%
.../NexusMods.Games.Reshade/ReshadePresetInstaller.cs	0.00%
...s.Games.StardewValley/Installers/SMAPIInstaller.cs	0.00%
src/NexusMods.DataModel/Games/RunGameTool.cs	0.00%
...c/NexusMods.DataModel/Games/Unknown/UnknownGame.cs	0.00%
...NexusMods.StandardGameLocators.Tests/BasicTests.cs	0.00%
...meLocators.TestHelpers/StubbedGames/StubbedGame.cs	37.50%
...s/NexusMods.Games.DarkestDungeon/DarkestDungeon.cs	46.66%
... and 32 more