vrchat-community / ClientSim

Client Simulator for World Building
https://clientsim.docs.vrchat.com
Other
238 stars 24 forks source link

'Tests' folder missing when added via VCC #55

Open sam-ln opened 1 year ago

sam-ln commented 1 year ago

When installing ClientSim into a VRC World Project via the Creator Companion, it is missing the 'Tests' folder, making it impossible to follow the Instructions for Automated Testing. A workaround is to manually install ClientSim from git by opening Unity Package Manager -> Add package from git URL.. -> enter https://github.com/vrchat-community/ClientSim.git?path=Packages/com.vrchat.ClientSim

momo-the-monster commented 1 year ago

Thanks for pointing this out, @sam-ln. Unfortunately, Unity does not properly ignore the test assemblies for embedded packages, so we had to strip out these files from the general releases to avoid adding the test assemblies to everyone's projects (verified by Unity Support). We'll need to update the documentation with the info you have above or a similar workaround.

sam-ln commented 1 year ago

@momo-the-monster Thanks for your answer! I think it would be more intuitive for creators to simply remove the TestAssembly themselves (if they are even bothered by it showing up in the Test Runner), than having to pull the ClientSim from a different source just to get the Test features. That being said, the Test Runner currently gets populated by Udon Graph Editor Tests in every fresh project anyways.

Happyrobot33 commented 1 year ago

this is unfortunate, was just starting to look into unit tests :/

sam-ln commented 1 year ago

@Happyrobot33 Using the work-around in my first message, unit testing with Edit-Mode tests works quite well. Unfortunately Play-Mode tests do not (see #63).