jazzy: Setup fix and version-up (#131) (#133)

* Setup fix and version-up (#131) * model antlr4 dependency correctly (#134) * Doc and format fixes (#135) * add missing libs and correct dead links in overview table in libraries.rst * format fixes * repo link fix * disable unstable tests --------- Co-authored-by: Florian Mirus <[email protected]>
IntelLabs · Jul 31, 2024 · 1338ff9 · 1338ff9
1 parent 2ddfede
commit 1338ff9
Show file tree

Hide file tree

Showing 48 changed files with 72 additions and 62 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -21,7 +21,7 @@ If applicable, add screenshots to help explain your problem.
 
 **Version information (please complete the following information):**
 - OS: [e.g. Ubuntu 22.04]
-- Version [e.g. 1.1.0]
+- Version [e.g. 1.2.0]
 - ROS version: [e.g. humble]
 
 **Additional context**

diff --git a/deb_requirements.txt b/deb_requirements.txt
@@ -1,5 +1,4 @@
 python3-autopep8
 clang-format
 pylint
-python3-antlr4
 cppzmq-dev
diff --git a/docs/conf.py b/docs/conf.py
@@ -14,8 +14,8 @@
 copyright = f"{datetime.datetime.now()}, Intel"
 author = "Intel"
 
-version = '1.1.0'
-release = '1.1.0'
+version = '1.2.0'
+release = '1.2.0'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

diff --git a/docs/libraries.rst b/docs/libraries.rst
@@ -16,16 +16,20 @@ Beside ``osc.standard`` provided by OpenSCENARIO 2 (which we divide into ``osc.s
      - Robotics Library (provided with :repo_link:`scenario_execution`)
    * - ``osc.ros``
      - ROS Library (provided with :repo_link:`scenario_execution_ros`)
+   * - ``osc.nav2``
+     - ROS Nav2 navigation stack Library (provided with :repo_link:`libs/scenario_execution_nav2`)
+   * - ``osc.os``
+     - Library to interact with the operating system (provided with :repo_link:`libs/scenario_execution_os`)
    * - ``osc.gazebo``
-     - Gazebo Library (provided with :repo_link:`scenario_execution_gazebo`)
+     - Gazebo Library (provided with :repo_link:`libs/scenario_execution_gazebo`)
 
 Additional features can be implemented by defining your own library.
 
 
 Gazebo
 ------
 
-The library contains actions to interact with the `Gazebo Simulation <https://gazebosim.org/>`_. Import it with ``import osc.gazebo``. It's provided by the package :repo_link:`scenario_execution_gazebo`.
+The library contains actions to interact with the `Gazebo Simulation <https://gazebosim.org/>`_. Import it with ``import osc.gazebo``. It's provided by the package :repo_link:`libs/scenario_execution_gazebo`.
 
 Actions
 ^^^^^^^

diff --git a/examples/example_external_method/setup.py b/examples/example_external_method/setup.py
@@ -22,7 +22,7 @@
 
 setup(
     name=PACKAGE_NAME,
-    version='1.1.0',
+    version='1.2.0',
     packages=find_namespace_packages(),
     data_files=[
         ('share/ament_index/resource_index/packages',

diff --git a/examples/example_library/setup.py b/examples/example_library/setup.py
@@ -22,7 +22,7 @@
 
 setup(
     name=PACKAGE_NAME,
-    version='1.1.0',
+    version='1.2.0',
     packages=find_namespace_packages(),
     data_files=[
         ('share/ament_index/resource_index/packages',

diff --git a/examples/example_multi_robot/package.xml b/examples/example_multi_robot/package.xml
@@ -2,7 +2,7 @@
 <?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
 <package format="3">
   <name>example_multi_robot</name>
-  <version>1.1.0</version>
+  <version>1.2.0</version>
   <description>Example Multi Robot</description>
   <author email="[email protected]">Intel Labs</author>
   <maintainer email="[email protected]">Intel Labs</maintainer>

diff --git a/examples/example_multi_robot/setup.py b/examples/example_multi_robot/setup.py
@@ -22,7 +22,7 @@
 
 setup(
     name=PACKAGE_NAME,
-    version='1.1.0',
+    version='1.2.0',
     packages=find_namespace_packages(),
     data_files=[
         ('share/ament_index/resource_index/packages',

diff --git a/examples/example_scenario_control/package.xml b/examples/example_scenario_control/package.xml
@@ -2,7 +2,7 @@
 <?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
 <package format="3">
   <name>example_scenario_control</name>
-  <version>1.1.0</version>
+  <version>1.2.0</version>
   <description>Scenario Execution Example for Scenario Control using RVIZ</description>
   <author email="[email protected]">Intel Labs</author>
   <maintainer email="[email protected]">Intel Labs</maintainer>

diff --git a/examples/example_scenario_control/setup.py b/examples/example_scenario_control/setup.py
@@ -23,7 +23,7 @@
 
 setup(
     name=PACKAGE_NAME,
-    version='1.1.0',
+    version='1.2.0',
     packages=[PACKAGE_NAME],
     data_files=[
         ('share/ament_index/resource_index/packages',

diff --git a/examples/example_simulation/package.xml b/examples/example_simulation/package.xml
@@ -2,7 +2,7 @@
 <?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
 <package format="3">
   <name>example_simulation</name>
-  <version>1.1.0</version>
+  <version>1.2.0</version>
   <description>Scenario Execution Example for Simulation</description>
   <author email="[email protected]">Intel Labs</author>
   <maintainer email="[email protected]">Intel Labs</maintainer>

diff --git a/examples/example_simulation/setup.py b/examples/example_simulation/setup.py
@@ -22,7 +22,7 @@
 
 setup(
     name=PACKAGE_NAME,
-    version='1.1.0',
+    version='1.2.0',
     packages=[PACKAGE_NAME],
     data_files=[
         ('share/ament_index/resource_index/packages',

diff --git a/libs/scenario_execution_floorplan_dsl/package.xml b/libs/scenario_execution_floorplan_dsl/package.xml
@@ -2,7 +2,7 @@
 <?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
 <package format="3">
   <name>scenario_execution_floorplan_dsl</name>
-  <version>1.1.0</version>
+  <version>1.2.0</version>
   <description>Scenario Execution library for Floorplan DSL</description>
   <author email="[email protected]">Intel Labs</author>
   <maintainer email="[email protected]">Intel Labs</maintainer>

diff --git a/libs/scenario_execution_floorplan_dsl/setup.py b/libs/scenario_execution_floorplan_dsl/setup.py
@@ -21,7 +21,7 @@
 
 setup(
     name=PACKAGE_NAME,
-    version='1.1.0',
+    version='1.2.0',
     packages=find_namespace_packages(),
     data_files=[
         ('share/ament_index/resource_index/packages',

diff --git a/libs/scenario_execution_gazebo/package.xml b/libs/scenario_execution_gazebo/package.xml
@@ -2,7 +2,7 @@
 <?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
 <package format="3">
   <name>scenario_execution_gazebo</name>
-  <version>1.1.0</version>
+  <version>1.2.0</version>
   <description>Scenario Execution library for Gazebo</description>
   <author email="[email protected]">Intel Labs</author>
   <maintainer email="[email protected]">Intel Labs</maintainer>

diff --git a/libs/scenario_execution_gazebo/setup.py b/libs/scenario_execution_gazebo/setup.py
@@ -21,7 +21,7 @@
 
 setup(
     name=PACKAGE_NAME,
-    version='1.1.0',
+    version='1.2.0',
     packages=find_namespace_packages(),
     data_files=[
         ('share/ament_index/resource_index/packages',

diff --git a/libs/scenario_execution_nav2/package.xml b/libs/scenario_execution_nav2/package.xml
@@ -2,7 +2,7 @@
 <?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
 <package format="3">
   <name>scenario_execution_nav2</name>
-  <version>1.1.0</version>
+  <version>1.2.0</version>
   <description>Scenario Execution library for Nav2</description>
   <author email="[email protected]">Intel Labs</author>
   <maintainer email="[email protected]">Intel Labs</maintainer>

diff --git a/libs/scenario_execution_nav2/setup.py b/libs/scenario_execution_nav2/setup.py
@@ -20,7 +20,7 @@
 
 setup(
     name=PACKAGE_NAME,
-    version='1.1.0',
+    version='1.2.0',
     packages=find_namespace_packages(),
     data_files=[
         ('share/ament_index/resource_index/packages',

diff --git a/libs/scenario_execution_os/package.xml b/libs/scenario_execution_os/package.xml
@@ -2,7 +2,7 @@
 <?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
 <package format="3">
   <name>scenario_execution_os</name>
-  <version>1.1.0</version>
+  <version>1.2.0</version>
   <description>Scenario Execution library for OS interactions</description>
   <author email="[email protected]">Intel Labs</author>
   <maintainer email="[email protected]">Intel Labs</maintainer>

diff --git a/libs/scenario_execution_os/setup.py b/libs/scenario_execution_os/setup.py
@@ -21,7 +21,7 @@
 
 setup(
     name=PACKAGE_NAME,
-    version='1.1.0',
+    version='1.2.0',
     packages=find_namespace_packages(),
     data_files=[
         ('share/ament_index/resource_index/packages',

diff --git a/libs/scenario_execution_pybullet/package.xml b/libs/scenario_execution_pybullet/package.xml
@@ -2,7 +2,7 @@
 <?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
 <package format="3">
   <name>scenario_execution_pybullet</name>
-  <version>1.1.0</version>
+  <version>1.2.0</version>
   <description>Scenario Execution library for PyBullet</description>
   <author email="[email protected]">Intel Labs</author>
   <maintainer email="[email protected]">Intel Labs</maintainer>

diff --git a/libs/scenario_execution_pybullet/setup.py b/libs/scenario_execution_pybullet/setup.py
@@ -21,7 +21,7 @@
 
 setup(
     name=PACKAGE_NAME,
-    version='1.1.0',
+    version='1.2.0',
     packages=find_namespace_packages(),
     data_files=[
         ('share/ament_index/resource_index/packages',

diff --git a/scenario_coverage/package.xml b/scenario_coverage/package.xml
@@ -2,7 +2,7 @@
 <?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
 <package format="3">
   <name>scenario_coverage</name>
-  <version>1.1.0</version>
+  <version>1.2.0</version>
   <description>Robotics Scenario Execution Coverage Tools</description>
   <author email="[email protected]">Intel Labs</author>
   <maintainer email="[email protected]">Intel Labs</maintainer>

diff --git a/scenario_coverage/setup.py b/scenario_coverage/setup.py
@@ -22,7 +22,7 @@
 
 setup(
     name=PACKAGE_NAME,
-    version='1.1.0',
+    version='1.2.0',
     packages=find_packages(),
     data_files=[
         ('share/ament_index/resource_index/packages',

diff --git a/scenario_execution/package.xml b/scenario_execution/package.xml
@@ -2,14 +2,15 @@
 <?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
 <package format="3">
   <name>scenario_execution</name>
-  <version>1.1.0</version>
+  <version>1.2.0</version>
   <description>Scenario Execution</description>
   <author email="[email protected]">Intel Labs</author>
   <maintainer email="[email protected]">Intel Labs</maintainer>
   <license file="../LICENSE">Apache-2.0</license>
 
   <exec_depend>py_trees</exec_depend>
   <exec_depend>python3-yaml</exec_depend>
+  <exec_depend>python3-antlr4</exec_depend>
 
   <test_depend>ament_copyright</test_depend>
   <test_depend>ament_flake8</test_depend>

diff --git a/scenario_execution/scenario_execution/osc2_parsing/OpenSCENARIO2Parser.py b/scenario_execution/scenario_execution/osc2_parsing/OpenSCENARIO2Parser.py
@@ -2179,7 +2179,7 @@ def siBaseUnitName(self):
             self.enterOuterAlt(localctx, 1)
             self.state = 397
             _la = self._input.LA(1)
-            if not((((_la) & ~0x3f) == 0 and ((1 << _la) & ((1 << OpenSCENARIO2Parser.T__11) | (1 << OpenSCENARIO2Parser.T__12) | (1 << OpenSCENARIO2Parser.T__13) | (1 << OpenSCENARIO2Parser.T__14) | (1 << OpenSCENARIO2Parser.T__15) | (1 << OpenSCENARIO2Parser.T__16) | (1 << OpenSCENARIO2Parser.T__17) | (1 << OpenSCENARIO2Parser.T__18))) != 0)):
+            if not ((((_la) & ~0x3f) == 0 and ((1 << _la) & ((1 << OpenSCENARIO2Parser.T__11) | (1 << OpenSCENARIO2Parser.T__12) | (1 << OpenSCENARIO2Parser.T__13) | (1 << OpenSCENARIO2Parser.T__14) | (1 << OpenSCENARIO2Parser.T__15) | (1 << OpenSCENARIO2Parser.T__16) | (1 << OpenSCENARIO2Parser.T__17) | (1 << OpenSCENARIO2Parser.T__18))) != 0)):
                 self._errHandler.recoverInline(self)
             else:
                 self._errHandler.reportMatch(self)
@@ -2370,7 +2370,7 @@ def enumMemberValue(self):
             self.enterOuterAlt(localctx, 1)
             self.state = 419
             _la = self._input.LA(1)
-            if not(_la == OpenSCENARIO2Parser.UintLiteral or _la == OpenSCENARIO2Parser.HexUintLiteral):
+            if not (_la == OpenSCENARIO2Parser.UintLiteral or _la == OpenSCENARIO2Parser.HexUintLiteral):
                 self._errHandler.recoverInline(self)
             else:
                 self._errHandler.reportMatch(self)
@@ -4618,7 +4618,7 @@ def primitiveType(self):
             self.enterOuterAlt(localctx, 1)
             self.state = 670
             _la = self._input.LA(1)
-            if not((((_la) & ~0x3f) == 0 and ((1 << _la) & ((1 << OpenSCENARIO2Parser.T__32) | (1 << OpenSCENARIO2Parser.T__33) | (1 << OpenSCENARIO2Parser.T__34) | (1 << OpenSCENARIO2Parser.T__35) | (1 << OpenSCENARIO2Parser.T__36))) != 0)):
+            if not ((((_la) & ~0x3f) == 0 and ((1 << _la) & ((1 << OpenSCENARIO2Parser.T__32) | (1 << OpenSCENARIO2Parser.T__33) | (1 << OpenSCENARIO2Parser.T__34) | (1 << OpenSCENARIO2Parser.T__35) | (1 << OpenSCENARIO2Parser.T__36))) != 0)):
                 self._errHandler.recoverInline(self)
             else:
                 self._errHandler.reportMatch(self)
@@ -5378,7 +5378,7 @@ def everyExpression(self):
                 localctx._Identifier = self.match(OpenSCENARIO2Parser.Identifier)
 
                 offsetName = (None if localctx._Identifier is None else localctx._Identifier.text)
-                if(not (offsetName == "offset")):
+                if (not (offsetName == "offset")):
                     print("%s must be offset" % offsetName)
                     raise NoViableAltException(self)
 
@@ -6155,7 +6155,7 @@ def constraintQualifier(self):
             self.enterOuterAlt(localctx, 1)
             self.state = 837
             _la = self._input.LA(1)
-            if not(_la == OpenSCENARIO2Parser.T__49 or _la == OpenSCENARIO2Parser.T__50):
+            if not (_la == OpenSCENARIO2Parser.T__49 or _la == OpenSCENARIO2Parser.T__50):
                 self._errHandler.recoverInline(self)
             else:
                 self._errHandler.reportMatch(self)
@@ -6956,7 +6956,7 @@ def compositionOperator(self):
             self.enterOuterAlt(localctx, 1)
             self.state = 927
             _la = self._input.LA(1)
-            if not((((_la) & ~0x3f) == 0 and ((1 << _la) & ((1 << OpenSCENARIO2Parser.T__54) | (1 << OpenSCENARIO2Parser.T__55) | (1 << OpenSCENARIO2Parser.T__56))) != 0)):
+            if not ((((_la) & ~0x3f) == 0 and ((1 << _la) & ((1 << OpenSCENARIO2Parser.T__54) | (1 << OpenSCENARIO2Parser.T__55) | (1 << OpenSCENARIO2Parser.T__56))) != 0)):
                 self._errHandler.recoverInline(self)
             else:
                 self._errHandler.reportMatch(self)
@@ -8897,7 +8897,7 @@ def relationalOp(self):
             self.enterOuterAlt(localctx, 1)
             self.state = 1139
             _la = self._input.LA(1)
-            if not(((((_la - 23)) & ~0x3f) == 0 and ((1 << (_la - 23)) & ((1 << (OpenSCENARIO2Parser.T__22 - 23)) | (1 << (OpenSCENARIO2Parser.T__75 - 23)) | (1 << (OpenSCENARIO2Parser.T__76 - 23)) | (1 << (OpenSCENARIO2Parser.T__77 - 23)) | (1 << (OpenSCENARIO2Parser.T__78 - 23)) | (1 << (OpenSCENARIO2Parser.T__79 - 23)) | (1 << (OpenSCENARIO2Parser.T__80 - 23)))) != 0)):
+            if not (((((_la - 23)) & ~0x3f) == 0 and ((1 << (_la - 23)) & ((1 << (OpenSCENARIO2Parser.T__22 - 23)) | (1 << (OpenSCENARIO2Parser.T__75 - 23)) | (1 << (OpenSCENARIO2Parser.T__76 - 23)) | (1 << (OpenSCENARIO2Parser.T__77 - 23)) | (1 << (OpenSCENARIO2Parser.T__78 - 23)) | (1 << (OpenSCENARIO2Parser.T__79 - 23)) | (1 << (OpenSCENARIO2Parser.T__80 - 23)))) != 0)):
                 self._errHandler.recoverInline(self)
             else:
                 self._errHandler.reportMatch(self)
@@ -9055,7 +9055,7 @@ def additiveOp(self):
             self.enterOuterAlt(localctx, 1)
             self.state = 1153
             _la = self._input.LA(1)
-            if not(_la == OpenSCENARIO2Parser.T__81 or _la == OpenSCENARIO2Parser.T__82):
+            if not (_la == OpenSCENARIO2Parser.T__81 or _la == OpenSCENARIO2Parser.T__82):
                 self._errHandler.recoverInline(self)
             else:
                 self._errHandler.reportMatch(self)
@@ -9213,7 +9213,7 @@ def multiplicativeOp(self):
             self.enterOuterAlt(localctx, 1)
             self.state = 1167
             _la = self._input.LA(1)
-            if not(((((_la - 84)) & ~0x3f) == 0 and ((1 << (_la - 84)) & ((1 << (OpenSCENARIO2Parser.T__83 - 84)) | (1 << (OpenSCENARIO2Parser.T__84 - 84)) | (1 << (OpenSCENARIO2Parser.T__85 - 84)))) != 0)):
+            if not (((((_la - 84)) & ~0x3f) == 0 and ((1 << (_la - 84)) & ((1 << (OpenSCENARIO2Parser.T__83 - 84)) | (1 << (OpenSCENARIO2Parser.T__84 - 84)) | (1 << (OpenSCENARIO2Parser.T__85 - 84)))) != 0)):
                 self._errHandler.recoverInline(self)
             else:
                 self._errHandler.reportMatch(self)
@@ -10544,7 +10544,7 @@ def integerLiteral(self):
             self.enterOuterAlt(localctx, 1)
             self.state = 1324
             _la = self._input.LA(1)
-            if not(((((_la - 99)) & ~0x3f) == 0 and ((1 << (_la - 99)) & ((1 << (OpenSCENARIO2Parser.UintLiteral - 99)) | (1 << (OpenSCENARIO2Parser.HexUintLiteral - 99)) | (1 << (OpenSCENARIO2Parser.IntLiteral - 99)))) != 0)):
+            if not (((((_la - 99)) & ~0x3f) == 0 and ((1 << (_la - 99)) & ((1 << (OpenSCENARIO2Parser.UintLiteral - 99)) | (1 << (OpenSCENARIO2Parser.HexUintLiteral - 99)) | (1 << (OpenSCENARIO2Parser.IntLiteral - 99)))) != 0)):
                 self._errHandler.recoverInline(self)
             else:
                 self._errHandler.reportMatch(self)

diff --git a/scenario_execution/setup.py b/scenario_execution/setup.py
@@ -23,13 +23,17 @@
 PACKAGE_NAME = 'scenario_execution'
 
 # read the contents of the README file
-this_directory = Path(__file__).resolve()
-root_directory = [p for p in this_directory.parents if p.parts[-1] == PACKAGE_NAME][0]
-long_description = Path.joinpath(root_directory, "README.md").read_text()
+this_directory = Path(__file__).parent
+try:
+    LONG_DESCRIPTION = (this_directory / "README.md").read_text()
+except:  # pylint: disable=W0702
+    # in case we do colcon build --symlink-install, wo do not need the
+    # description
+    LONG_DESCRIPTION = ''
 
 setup(
     name=PACKAGE_NAME,
-    version='1.1.0',
+    version='1.2.0',
     packages=find_namespace_packages(exclude=['test*']),
     data_files=[
         ('share/ament_index/resource_index/packages',
@@ -54,7 +58,7 @@
         "Issues": "https://github.com/IntelLabs/scenario_execution/issues",
     },
     description='Scenario Execution for Robotics',
-    long_description=long_description,
+    long_description=LONG_DESCRIPTION,
     long_description_content_type='text/markdown',
     license='Apache License 2.0',
     classifiers=[

diff --git a/scenario_execution_control/package.xml b/scenario_execution_control/package.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0"?>
 <package format="3">
   <name>scenario_execution_control</name>
-  <version>1.1.0</version>
+  <version>1.2.0</version>
   <description>Scenario Execution Control</description>
   <author email="[email protected]">Intel Labs</author>
   <maintainer email="[email protected]">Intel Labs</maintainer>

diff --git a/scenario_execution_control/setup.py b/scenario_execution_control/setup.py
@@ -25,7 +25,7 @@
 PACKAGE_NAME = 'scenario_execution_control'
 setup(
     name=PACKAGE_NAME,
-    version='1.1.0',
+    version='1.2.0',
     packages=[PACKAGE_NAME],
     data_files=[
         ('share/ament_index/resource_index/packages',

diff --git a/scenario_execution_interfaces/package.xml b/scenario_execution_interfaces/package.xml
@@ -2,7 +2,7 @@
 <?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
 <package format="3">
   <name>scenario_execution_interfaces</name>
-  <version>1.1.0</version>
+  <version>1.2.0</version>
   <description>ROS2 Interfaces for Scenario Execution</description>
   <author email="[email protected]">Intel Labs</author>
   <maintainer email="[email protected]">Intel Labs</maintainer>