/gazebo_test_cases

Primary LanguageTypeScript

Gazebo Harmonic Tutorial Party

Welcome! The purpose of this repository is to guide the testing of various functionalities of Gazebo Harmonic prior to official release. In other words, welcome to the Tutorial Party!

Who can contribute?

Everyone, all contributions are welcome!

How to contribute?

The Issues page has several tickets each containing specific instructions to test a particular functionality of Gazebo Harmonic. Each ticket will have the following sections:

  1. Setup: Details on the desired hardware and software setup for this test. The following combinations are possible.
    1. DDS vendor: FASTDDS
    2. BuildType:
      • binary: pre-built packaged Gazebo workspace from the releases page
      • debian: pre-built debian packages from the apt repository
      • source: building your own workspace from source
    3. Os: Ubuntu Jammy, Windows and MacOS
  2. Links: Any relevant references for this test.
  3. Checks: A list of functionalities to validate.

To contribute, first ensure if you have the relevant setup as described in the ticket. If you don't have the setup, you can find the installation instructions at https://gazebosim.org/docs/harmonic/install. Next, assign the ticket to yourself via the Assignees option or comment on the ticket indicating your interest. Then follow the instructions to perform the necessary checks.

All checks passed? Great! Please tick the checkboxes if you can or else leave a comment indicating your successful testing. Attaching your terminal output (codeblock comment or gist file) as a form of verification is greatly appreciated. If you have the necessary permission, go ahead and close the ticket by clicking Close as completed.

Encountered failures? If one or more checks fail, please provide the error message in a codeblock comment or as a gist file attachment.

What to prioritize?

The goal is to close all tickets after successful validation. But we would like to prioritize the following sets in order:

Note: If you have access to a Windows machine, please prioritize testing on Windows. The next priority is MacOS followed by Ubuntu Jammy.

What if I want to test something else?

If you would like to test the functionality of any other package or extend the capabilities tested above, please open additional tickets while following the format described above.

Questions

Questions related to testing may be posted as a new Issue. Kindly ensure to link the relevant issue ticket when starting a new discussion.

Timeline

We are expecting to generate all the issues for this tutorial party in two batches to ensure that we validate the test cases with a higher priority. The batches will release in the following order:

  • First Batch: August 31st
    • All the test cases related with Ubuntu
    • Only the test cases from the docs for MacOS and Windows.
  • Second Batch: September 11th
    • The rest of the test cases for MacOS and Windows.

Tickets filtered by Setup

TODO