Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow plugin/controller/src/webotsFolder/dist to be usable by Webots by copying DeepBlueSim.jar into that folder so it can be used as a controller. #86

Merged
merged 7 commits into from
Jul 4, 2024

Conversation

brettle
Copy link
Member

@brettle brettle commented Jul 2, 2024

This is used by the new tests project. See tests/README.md for more info.

brettle added 2 commits July 2, 2024 07:12
…by copying DeepBlueSim.jar into that folder so it can be used as a controller.

This is used by the new tests project. See tests/README.md for more info.
@brettle brettle mentioned this pull request Jul 2, 2024
@brettle brettle marked this pull request as ready for review July 4, 2024 04:15
@brettle brettle requested a review from a team as a code owner July 4, 2024 04:15
tests/logging.properties Outdated Show resolved Hide resolved
tests/README.md Outdated Show resolved Hide resolved
tests/README.md Outdated
Comment on lines 1 to 4
This project tests DeepBlueSim. It uses the DeepBlueSim plugin and contains tests that refer to
Webots worlds in `../plugin/controller/src/webotFolder/dist/worlds`. That makes it easier to debug
those worlds and the various DeepBlueSim Webots PROTOs. Note: the contents of *this* project's
`Webots` folder are ignored.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two questions:

  1. Why are we including the test worlds in controller? Given that this plugin extracts controller/webotsFolder/dist to whatever project its installed to, wouldn't this unnecessarily clutter users' worlds folder when they may only need one or two worlds (especially if this project grows to have a lot of tests).
  2. Is this project going to replace example or :example:systemTest? If not, what distinguishes the tests that will go in each of them?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. I'm planning to either put the more test-oriented worlds in a subdir or only include the example-oriented worlds in the zip file that is used to create the Webots folder. Do you have a preference?
  2. The tests project is for maintainers to create system level tests of DeepBlueSim, including the various protos, mediators, etc. The example project (and possibly a future lib199example project) is for users to refer to or use as a starting point for their own projects. We don't need DBSExampleTest in the tests project since it is identical to SystemTest in the example project. I only put it in tests because I wanted to make sure that the tests project worked properly with multiple test classes loading multiple worlds.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. What I might do is separate the worlds into a worlds/examples directory and a worlds/tests directory. That way it's more explicit what the purpose of each is (and Webots/worlds can stay fairly clean).
  2. Sounds good! Does that also mean that tests will ultimately end up including lib199 as well in order to test lib199 integration in-depth, or will that remain confined to lib199example?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. Just created issue plugin/controller/src/webotsFolder/dist/worlds needs to be reorganized #87 to cover the proposed reorg.
  2. tests would include tests that use lib199 as well as tests that don't. lib199example would contain only a test of a lib199 example world.

brettle and others added 2 commits July 3, 2024 23:12
@brettle brettle merged commit 48b9a73 into master Jul 4, 2024
4 checks passed
@brettle brettle deleted the add-support-for-using-src-webotsFolder branch July 4, 2024 13:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants