feat: adding ci for simulator testing

[abanuelo]

Description

Adding CI in place to be able to test dynamic scenarios for CARLA and Webots. This CI has been tested privately! In subsequent PRs, dynamic scenarios for CARLA will be built using PyTest. Documentation has also been updated internally for how to get access to the instance running simulator-based tests.

End to End Test Passing with Webots and CARLA dynamic tests changes present on the main branch (ie #227 #231)

Issue Link

Checklist

• I have tested the changes locally via pytest and/or other means
• I have added or updated relevant documentation
• I have autoformatted the code with black and isort
• I have added test cases (if applicable)

Additional Notes

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.12%. Comparing base (d5a21fc) to head (320b8ef).
Report is 5 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #226      +/-   ##
==========================================
+ Coverage   85.89%   86.12%   +0.23%     
==========================================
  Files         144      144              
  Lines       24767    24938     +171     
==========================================
+ Hits        21274    21479     +205     
+ Misses       3493     3459      -34     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[abanuelo]

Note: in order for this workflow to become active in our Scenic repo we need to add all secrets to our repository! I do not have privileges to do so, but happy to collaborate with others to make sure this happens!

[dfremont]

Looks good! As we discussed earlier, if it looks like creating a fresh virtual environment and installing everything into it takes significant time, we could cache one, but let's not worry about that for now.