wip - Added initial configurations

Robotic-Decision-Making-Lab · Jan 9, 2024 · a845082 · a845082
1 parent bb5f6e4
commit a845082
Show file tree

Hide file tree

Showing 22 changed files with 995 additions and 0 deletions.
diff --git a/.clang-format b/.clang-format
@@ -0,0 +1,27 @@
+---
+Language: Cpp
+BasedOnStyle: Google
+ColumnLimit: 100
+MaxEmptyLinesToKeep: 1
+
+IndentWidth: 2
+TabWidth: 2
+UseTab: Never
+AccessModifierOffset: -2
+AlignAfterOpenBracket: AlwaysBreak
+ConstructorInitializerIndentWidth: 0
+ContinuationIndentWidth: 2
+DerivePointerAlignment: false
+PointerAlignment: Middle
+PackConstructorInitializers: Never
+
+# Configure brace wrapping cases
+BreakBeforeBraces: Custom
+BraceWrapping:
+  AfterClass: true
+  AfterEnum: true
+  AfterFunction: true
+  AfterNamespace: true
+  AfterStruct: true
+  AfterUnion: true
+  BeforeCatch: true
diff --git a/.clang-tidy b/.clang-tidy
@@ -0,0 +1,80 @@
+---
+Checks: >
+  -*,
+  abseil-*,
+  bugprone-*,
+  google-*,
+  misc-*,
+  modernize-*,
+  performance-*,
+  portability-*,
+  readability-*,
+  -google-readability-braces-around-statements,
+  -google-readability-namespace-comments,
+  -google-runtime-references,
+  -misc-non-private-member-variables-in-classes,
+  -modernize-return-braced-init-list,
+  -modernize-use-trailing-return-type,
+  -readability-braces-around-statements,
+  -readability-identifier-length,
+  -readability-magic-numbers,
+  -readability-named-parameter,
+  -readability-redundant-declaration,
+  -readability-function-cognitive-complexity,
+  -bugprone-narrowing-conversions,
+  -bugprone-easily-swappable-parameters,
+  -bugprone-implicit-widening-of-multiplication-result,
+  -clang-diagnostic-error,
+  -bugprone-exception-escape
+WarningsAsErrors: "*"
+CheckOptions:
+  - key: readability-braces-around-statements.ShortStatementLines
+    value: "2"
+  - key: readability-identifier-naming.NamespaceCase
+    value: lower_case
+  - key: readability-identifier-naming.ClassCase
+    value: CamelCase
+  - key: readability-identifier-naming.StructCase
+    value: CamelCase
+  - key: readability-identifier-naming.TemplateParameterCase,
+    value: CamelCase,
+  - key: readability-identifier-naming.FunctionCase
+    value: camelBack
+  - key: readability-identifier-naming.MethodCase
+    value: camelBack
+  - key: readability-identifier-naming.VariableCase
+    value: lower_case
+  - key: readability-identifier-naming.ClassMemberCase
+    value: lower_case
+  - key: readability-identifier-naming.ClassMemberSuffix
+    value: _
+  - key: readability-identifier-naming.PrivateMemberSuffix
+    value: _
+  - key: readability-identifier-naming.ProtectedMemberSuffix
+    value: _
+  - key: readability-identifier-naming.EnumConstantCase
+    value: CamelCase
+  - key: readability-identifier-naming.EnumConstantPrefix
+    value: k
+  - key: readability-identifier-naming.ConstexprVariableCase
+    value: CamelCase
+  - key: readability-identifier-naming.ConstexprVariablePrefix
+    value: k
+  - key: readability-identifier-naming.GlobalConstantCase
+    value: CamelCase
+  - key: readability-identifier-naming.GlobalConstantPrefix
+    value: k
+  - key: readability-identifier-naming.MemberConstantCase
+    value: CamelCase
+  - key: readability-identifier-naming.MemberConstantPrefix
+    value: k
+  - key: readability-identifier-naming.StaticConstantCase
+    value: CamelCase
+  - key: readability-identifier-naming.StaticConstantPrefix
+    value: k
+  - key: readability-implicit-bool-conversion.AllowIntegerConditions
+    value: 1
+  - key: readability-implicit-bool-conversion.AllowPointerConditions
+    value: 1
+  - key: readability-function-cognitive-complexity.IgnoreMacros
+    value: 1
diff --git a/.devcontainer/nouveau/Dockerfile b/.devcontainer/nouveau/Dockerfile
@@ -0,0 +1,27 @@
+FROM ghcr.io/robotic-decision-making-lab/ros2-template:desktop
+
+# Install ROS dependencies
+# This is done in a previous stage, but we include it again here in case anyone wants to
+# add new dependencies during development
+ENV USERNAME=ros
+ENV USER_WORKSPACE=/home/$USERNAME/ws_ros
+WORKDIR $USER_WORKSPACE
+
+COPY --chown=$USER_UID:$USER_GID . src/$PROJECT_NAME
+
+RUN sudo apt-get -q update \
+    && sudo apt-get -q -y upgrade \
+    && rosdep update \
+    && rosdep install -y --from-paths . --ignore-src -r --rosdistro ${ROS_DISTRO} \
+    && sudo apt-get autoremove -y \
+    && sudo apt-get clean -y \
+    && sudo rm -rf /var/lib/apt/lists/*
+
+# Install debugging/linting Python packages
+COPY --chown=$USER_UID:$USER_GID requirements-dev.txt .
+RUN python3 -m pip install -r requirements-dev.txt \
+    && rm -rf requirements-dev.txt
+
+# Disable the setuputils installation warning
+# This prevents us from needing to pin the setuputils version (which doesn't always work)
+ENV PYTHONWARNINGS="ignore"
diff --git a/.devcontainer/nouveau/devcontainer.json b/.devcontainer/nouveau/devcontainer.json
@@ -0,0 +1,110 @@
+{
+  "name": "ROS 2 Dev Container",
+  "dockerFile": "Dockerfile",
+  "context": "../..",
+  "workspaceMount": "source=${localWorkspaceFolder},target=/home/ros/ws_ros/src/blue,type=bind",
+  "workspaceFolder": "/home/ros/ws_ros/src/ros2-template",
+  "remoteUser": "ros",
+  "runArgs": [
+    "--network=host",
+    "--cap-add=SYS_PTRACE",
+    "--security-opt=seccomp:unconfined",
+    "--security-opt=apparmor:unconfined",
+    "--volume=/dev:/dev",
+    "--privileged",
+    "--volume=/run/user/1000:/run/user/1000"
+  ],
+  "containerEnv": {
+    "DISPLAY": "${localEnv:DISPLAY}",
+    "WAYLAND_DISPLAY": "${localEnv:WAYLAND_DISPLAY}",
+    "XDG_RUNTIME_DIR": "${localEnv:XDG_RUNTIME_DIR}",
+    "PULSE_SERVER": "${localEnv:PULSE_SERVER}"
+  },
+  "customizations": {
+    "vscode": {
+      "settings": {
+        "files.associations": {
+          "*.repos": "yaml",
+          "*.world": "xml",
+          "*.xacro": "xml",
+          "*.srdf": "xml",
+          "*.rviz": "yaml",
+          "*.config": "xml",
+          "*.sdf": "xml"
+        },
+        "terminal.integrated.defaultProfile.linux": "bash",
+        "files.insertFinalNewline": true,
+        "files.trimTrailingWhitespace": true,
+        "editor.formatOnSave": true,
+        "editor.tabSize": 2,
+        "autoDocstring.startOnNewLine": false,
+        "autoDocstring.docstringFormat": "google-notypes",
+        "python.autoComplete.extraPaths": [
+          "/opt/ros/rolling/lib/python3.10/site-packages/",
+          "/opt/ros/rolling/local/lib/python3.10/dist-packages/",
+          "${workspaceFolder}/install/"
+        ],
+        "python.analysis.extraPaths": [
+          "/opt/ros/rolling/lib/python3.10/site-packages/",
+          "/opt/ros/rolling/local/lib/python3.10/dist-packages/",
+          "${workspaceFolder}/install/"
+        ],
+        "C_Cpp.default.intelliSenseMode": "linux-gcc-x86",
+        "C_Cpp.clang_format_fallbackStyle": "Google",
+        "C_Cpp.codeAnalysis.clangTidy.enabled": true,
+        "C_Cpp.codeAnalysis.clangTidy.runAutomatically": true,
+        "clang-format.executable": "/usr/bin/clang-format-18",
+        "[cpp]": {
+          "editor.rulers": [100],
+          "editor.tabSize": 2,
+          "editor.defaultFormatter": "xaver.clang-format"
+        },
+        "[python]": {
+          "editor.tabSize": 4,
+          "editor.rulers": [90],
+          "editor.formatOnSave": true,
+          "editor.codeActionsOnSave": {
+            "source.fixAll": true
+          },
+          "editor.defaultFormatter": "ms-python.black-formatter"
+        },
+        "[dockerfile]": {
+          "editor.quickSuggestions": {
+            "strings": true
+          },
+          "editor.defaultFormatter": "ms-azuretools.vscode-docker",
+          "editor.tabSize": 4
+        },
+        "[json]": {
+          "editor.defaultFormatter": "esbenp.prettier-vscode"
+        },
+        "[xml]": {
+          "editor.defaultFormatter": "redhat.vscode-xml"
+        },
+        "[markdown]": {
+          "editor.rulers": [80],
+          "editor.defaultFormatter": "DavidAnson.vscode-markdownlint"
+        },
+        "search.exclude": {
+          "**/build": true,
+          "**/install": true,
+          "**/log": true
+        }
+      },
+      "extensions": [
+        "ms-azuretools.vscode-docker",
+        "ms-python.python",
+        "njpwerner.autodocstring",
+        "ms-vscode.cpptools",
+        "redhat.vscode-xml",
+        "redhat.vscode-yaml",
+        "smilerobotics.urdf",
+        "DavidAnson.vscode-markdownlint",
+        "esbenp.prettier-vscode",
+        "xaver.clang-format",
+        "charliermarsh.ruff",
+        "ms-python.black-formatter"
+      ]
+    }
+  }
+}
diff --git a/.devcontainer/nvidia/Dockerfile b/.devcontainer/nvidia/Dockerfile
@@ -0,0 +1,27 @@
+FROM ghcr.io/robotic-decision-making-lab/ros2-template:desktop-nvidia
+
+# Install ROS dependencies
+# This is done in a previous stage, but we include it again here in case anyone wants to
+# add new dependencies during development
+ENV USERNAME=ros
+ENV USER_WORKSPACE=/home/$USERNAME/ws_ros
+WORKDIR $USER_WORKSPACE
+
+COPY --chown=$USER_UID:$USER_GID . src/$PROJECT_NAME
+
+RUN sudo apt-get -q update \
+    && sudo apt-get -q -y upgrade \
+    && rosdep update \
+    && rosdep install -y --from-paths . --ignore-src -r --rosdistro ${ROS_DISTRO} \
+    && sudo apt-get autoremove -y \
+    && sudo apt-get clean -y \
+    && sudo rm -rf /var/lib/apt/lists/*
+
+# Install debugging/linting Python packages
+COPY --chown=$USER_UID:$USER_GID requirements-dev.txt .
+RUN python3 -m pip install -r requirements-dev.txt \
+    && rm -rf requirements-dev.txt
+
+# Disable the setuputils installation warning
+# This prevents us from needing to pin the setuputils version (which doesn't always work)
+ENV PYTHONWARNINGS="ignore"
diff --git a/.devcontainer/nvidia/devcontainer.json b/.devcontainer/nvidia/devcontainer.json
@@ -0,0 +1,114 @@
+{
+  "name": "ROS 2 NVIDIA Dev Container",
+  "dockerFile": "Dockerfile",
+  "context": "../..",
+  "workspaceMount": "source=${localWorkspaceFolder},target=/home/ros/ws_ros/src/blue,type=bind",
+  "workspaceFolder": "/home/ros/ws_ros/src/ros2-template",
+  "remoteUser": "ros",
+  "runArgs": [
+    "--network=host",
+    "--cap-add=SYS_PTRACE",
+    "--security-opt=seccomp:unconfined",
+    "--security-opt=apparmor:unconfined",
+    "--volume=/dev:/dev",
+    "--privileged",
+    "--volume=/tmp/.X11-unix:/tmp/.X11-unix",
+    "--volume=/mnt/wslg:/mnt/wslg",
+    "--gpus=all"
+  ],
+  "containerEnv": {
+    "DISPLAY": "${localEnv:DISPLAY}",
+    "WAYLAND_DISPLAY": "${localEnv:WAYLAND_DISPLAY}",
+    "XDG_RUNTIME_DIR": "${localEnv:XDG_RUNTIME_DIR}",
+    "PULSE_SERVER": "${localEnv:PULSE_SERVER}",
+    "LIBGL_ALWAYS_SOFTWARE": "1",
+    "QT_X11_NO_MITSHM": "1"
+  },
+  "customizations": {
+    "vscode": {
+      "settings": {
+        "files.associations": {
+          "*.repos": "yaml",
+          "*.world": "xml",
+          "*.xacro": "xml",
+          "*.srdf": "xml",
+          "*.rviz": "yaml",
+          "*.config": "xml",
+          "*.sdf": "xml"
+        },
+        "terminal.integrated.defaultProfile.linux": "bash",
+        "files.insertFinalNewline": true,
+        "files.trimTrailingWhitespace": true,
+        "editor.formatOnSave": true,
+        "editor.tabSize": 2,
+        "autoDocstring.startOnNewLine": false,
+        "autoDocstring.docstringFormat": "google-notypes",
+        "python.autoComplete.extraPaths": [
+          "/opt/ros/rolling/lib/python3.10/site-packages/",
+          "/opt/ros/rolling/local/lib/python3.10/dist-packages/",
+          "${workspaceFolder}/install/"
+        ],
+        "python.analysis.extraPaths": [
+          "/opt/ros/rolling/lib/python3.10/site-packages/",
+          "/opt/ros/rolling/local/lib/python3.10/dist-packages/",
+          "${workspaceFolder}/install/"
+        ],
+        "C_Cpp.default.intelliSenseMode": "linux-gcc-x86",
+        "C_Cpp.clang_format_fallbackStyle": "Google",
+        "C_Cpp.codeAnalysis.clangTidy.enabled": true,
+        "C_Cpp.codeAnalysis.clangTidy.runAutomatically": true,
+        "clang-format.executable": "/usr/bin/clang-format-18",
+        "[cpp]": {
+          "editor.rulers": [100],
+          "editor.tabSize": 2,
+          "editor.defaultFormatter": "xaver.clang-format"
+        },
+        "[python]": {
+          "editor.tabSize": 4,
+          "editor.rulers": [90],
+          "editor.formatOnSave": true,
+          "editor.codeActionsOnSave": {
+            "source.fixAll": true
+          },
+          "editor.defaultFormatter": "ms-python.black-formatter"
+        },
+        "[dockerfile]": {
+          "editor.quickSuggestions": {
+            "strings": true
+          },
+          "editor.defaultFormatter": "ms-azuretools.vscode-docker",
+          "editor.tabSize": 4
+        },
+        "[json]": {
+          "editor.defaultFormatter": "esbenp.prettier-vscode"
+        },
+        "[xml]": {
+          "editor.defaultFormatter": "redhat.vscode-xml"
+        },
+        "[markdown]": {
+          "editor.rulers": [80],
+          "editor.defaultFormatter": "DavidAnson.vscode-markdownlint"
+        },
+        "search.exclude": {
+          "**/build": true,
+          "**/install": true,
+          "**/log": true
+        }
+      },
+      "extensions": [
+        "ms-azuretools.vscode-docker",
+        "ms-python.python",
+        "njpwerner.autodocstring",
+        "ms-vscode.cpptools",
+        "redhat.vscode-xml",
+        "redhat.vscode-yaml",
+        "smilerobotics.urdf",
+        "DavidAnson.vscode-markdownlint",
+        "esbenp.prettier-vscode",
+        "xaver.clang-format",
+        "charliermarsh.ruff",
+        "ms-python.black-formatter"
+      ]
+    }
+  }
+}