fixing up devcontainers and vscode (OpenCyphal#330)

edu-rossrobotics · Mar 22, 2024 · 1998ea1 · 1998ea1
1 parent cac61d6
commit 1998ea1
Show file tree

Hide file tree

Showing 64 changed files with 2,041 additions and 998 deletions.
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
@@ -1,6 +1,6 @@
 {
     "name": "Python dev environment",
-    "image": "ghcr.io/opencyphal/toxic:tx22.4.1",
+    "image": "ghcr.io/opencyphal/toxic:tx22.4.2",
     "workspaceFolder": "/workspace",
     "workspaceMount": "source=${localWorkspaceFolder},target=/workspace,type=bind,consistency=delegated",
     "mounts": [
@@ -13,7 +13,10 @@
                 "uavcan.dsdl",
                 "wholroyd.jinja",
                 "streetsidesoftware.code-spell-checker",
-                "ms-python.python"
+                "ms-python.python",
+                "ms-python.mypy-type-checker",
+                "ms-python.black-formatter",
+                "ms-python.pylint"
             ]
         }
     },

diff --git a/.github/verify.py b/.github/verify.py
@@ -1,8 +1,8 @@
 #!/usr/bin/env python3
 #
-# Copyright 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
-# Copyright (C) 2018-2021  OpenCyphal Development Team  <opencyphal.org>
-# This software is distributed under the terms of the MIT License.
+# Copyright (C) OpenCyphal Development Team  <opencyphal.org>
+# Copyright Amazon.com Inc. or its affiliates.
+# SPDX-License-Identifier: MIT
 #
 """
     Command-line helper for running verification builds.

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -8,7 +8,7 @@ jobs:
   release:
     if: ${{ github.event_name == 'release' && !github.event.release.prerelease }}
     runs-on: ubuntu-latest
-    container: ghcr.io/opencyphal/toxic:tx22.4.1
+    container: ghcr.io/opencyphal/toxic:tx22.4.2
     steps:
     - uses: actions/checkout@v3
       with:

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -9,7 +9,7 @@ on:
 jobs:
   test:
     runs-on: ubuntu-latest
-    container: ghcr.io/opencyphal/toxic:tx22.4.1
+    container: ghcr.io/opencyphal/toxic:tx22.4.2
     steps:
     - uses: actions/checkout@v3
       with:
@@ -75,10 +75,12 @@ jobs:
         SONAR_TOKEN: ${{ secrets.SONARQUBE_TOKEN }}
       with:
         args: >
-          -Dsonar.login=${{ env.SONAR_TOKEN }}
+          -Dsonar.token=${{ env.SONAR_TOKEN }}
           -Dsonar.buildString=${{ env.GITHUB_RUN_ID }}
           -Dsonar.projectVersion=${{ env.NUNAVUT_MAJOR_MINOR_VERSION }}
           -Dsonar.python.version=python3.10
+          -Dsonar.python.coverage.reportPaths=.tox/report/tmp/coverage.xml
+          -Dsonar.python.xunit.reportPath=.tox/py310-test/tmp/xunit-result.xml
     - name: report-pr
       if: ${{ github.event_name == 'pull_request' }}
       uses: sonarsource/sonarcloud-github-action@master
@@ -87,15 +89,17 @@ jobs:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       with:
         args: >
-          -Dsonar.login=${{ env.SONAR_TOKEN }}
+          -Dsonar.token=${{ env.SONAR_TOKEN }}
           -Dsonar.buildString=${{ env.GITHUB_RUN_ID }}
           -Dsonar.projectVersion=${{ env.NUNAVUT_MAJOR_MINOR_VERSION }}
           -Dsonar.python.version=python3.10
+          -Dsonar.python.coverage.reportPaths=.tox/report/tmp/coverage.xml
+          -Dsonar.python.xunit.reportPath=.tox/py310-test/tmp/xunit-result.xml
 
   compat-test-python3-windows-and-mac:
     strategy:
       matrix:
-        python3-version: ['10','11']
+        python3-version: ['11','12']
         python3-platform: ['windows-latest', 'macos-latest']
     runs-on: ${{ matrix.python3-platform }}
     needs: test
@@ -115,9 +119,9 @@ jobs:
   compat-test-python3-ubuntu:
     strategy:
       matrix:
-        python3-version: ['7', '8', '9', '10', '11']
+        python3-version: ['7', '8', '9', '10', '11', '12']
     runs-on: ubuntu-latest
-    container: ghcr.io/opencyphal/toxic:tx22.4.1
+    container: ghcr.io/opencyphal/toxic:tx22.4.2
     needs: test
     steps:
     - uses: actions/checkout@v3
@@ -129,7 +133,7 @@ jobs:
   language-verification-c:
     runs-on: ubuntu-latest
     needs: test
-    container: ghcr.io/opencyphal/toolshed:ts22.4.1
+    container: ghcr.io/opencyphal/toolshed:ts22.4.2
     strategy:
       matrix:
         build_type: [Debug, Release, MinSizeRel]
@@ -223,7 +227,7 @@ jobs:
   language-verification-python:
     runs-on: ubuntu-latest
     needs: test
-    container: ghcr.io/opencyphal/toxic:tx22.4.1
+    container: ghcr.io/opencyphal/toxic:tx22.4.2
     steps:
     - uses: actions/checkout@v3
       with:

diff --git a/.gitignore b/.gitignore
@@ -13,6 +13,7 @@ __pycache__
 *.egg-info
 *.patch
 .tox
+.nox
 .coverage*
 .venv
 coverage.xml
@@ -26,6 +27,7 @@ dist
 .DS_Store
 prof
 out
+venv
 
 # Eclipse
 .metadata

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -3,6 +3,8 @@ build:
   os: ubuntu-22.04
   tools:
     python: "3.11"
+sphinx:
+  configuration: conf.py
 python:
    install:
    - requirements: requirements.txt
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -5,6 +5,9 @@
         "uavcan.dsdl",
         "wholroyd.jinja",
         "streetsidesoftware.code-spell-checker",
-        "ms-python.python"
+        "ms-python.python",
+        "ms-python.mypy-type-checker",
+        "ms-python.black-formatter",
+        "ms-python.pylint"
     ]
 }
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -6,7 +6,7 @@
     "configurations": [
         {
             "name": "Python: nnvg c++",
-            "type": "python",
+            "type": "debugpy",
             "request": "launch",
             "module": "nunavut",
             "cwd": "${workspaceFolder}/src",
@@ -18,22 +18,33 @@
         },
         {
             "name": "Pytest: current test",
-            "type": "python",
+            "type": "debugpy",
             "request": "launch",
             "module": "pytest",
             "args": [
                 "--keep-generated",
+                "--rootdir=${workspaceFolder}",
                 "${file}"
             ],
-            "console": "internalConsole",
+            "cwd": "${workspaceFolder}"
+        },
+        {
+            "name": "Pytest: all doc tests",
+            "type": "debugpy",
+            "request": "launch",
+            "module": "pytest",
+            "args": [
+                "--keep-generated",
+                "--rootdir=${workspaceFolder}",
+                "${workspaceFolder}/src"
+            ],
             "cwd": "${workspaceFolder}"
         },
         {
             "name": "Pytest: all tests",
-            "type": "python",
+            "type": "debugpy",
             "request": "launch",
             "module": "pytest",
-            "console": "internalConsole",
             "cwd": "${workspaceFolder}"
         },
         {

diff --git a/.vscode/nunavut-words.txt b/.vscode/nunavut-words.txt
@@ -0,0 +1,52 @@
+addoption
+allclose
+astype
+autouse
+behaviour
+bitorder
+bools
+builtins
+Bxxx
+caplog
+CDEF
+codegen
+doctests
+dryrun
+dtype
+EDCB
+elementwise
+emptylines
+endianness
+errstate
+fillvalue
+finalizer
+fpid
+frombuffer
+functor
+functors
+htmlcov
+itemsize
+lctx
+markupsafe
+maxsplit
+nbytes
+ndarray
+ndim
+nnvg
+noxfile
+outdir
+packbits
+postprocessor
+postprocessors
+roadmap
+rtype
+Sriram
+tobytes
+transcompilation
+typecheck
+Unionant
+unpackbits
+unseparate
+unstropped
+WKCV
+Xlang