Test annotation PR merge

.codespellignore → .codespellignorelines

@@ -8,13 +8,15 @@
  * Renamed protocol convertor(sic) to protocol converter in the RDM code (C++
  * Renamed valiator(sic) to validator, incomming(sic) to incoming, mimimun(sic)
    to minimum and overiding(sic) to overriding, all of which may or may not
+ * Renamed RESONSE_INVALID_DESTINATION(sic) to RESPONSE_INVALID_DESTINATION in
+ * Rename CircularDepdendancyException(sic) to CircularDependencyException in
+ * Rename AppendMultipler(sic) to AppendMultiplier in the RDM messaging code
         /^(?:([0-9]{1,3})(?:\s(THRU)\s(?:([0-9]{1,3}))?)?(?:\s(@)\s(?:([0-9]{1,3}|FULL))?)?)/;
  *   channel_range ::= "ALL" | "*" | channel "THRU" channel | channel > channel
       /(?:([0-9]{1,3})(?:\s+THRU\s+([0-9]{0,3}))?)\s+@\s+([0-9]{0,3})$/);
      /(?:([0-9]{1,3})(?:\s+THRU\s+([0-9]{0,3}))?)(?:\s+@\s+([0-9]{0,3}))?$/);
   str = str.replace('>', 'THRU');
                     ' THRU ' + ola.common.DmxConstants.MAX_CHANNEL_NUMBER);
-                    ' THRU ' + ola.common.DmxConstants.MAX_CHANNEL_NUMBER);
     // If it's the T or > keys, autocomplete 'THRU'
          case 'U': // THRU
   var values = ['7', '8', '9', ' THRU ', '4', '5', '6', ' @ ', '1', '2', '3',
@@ -115,9 +117,6 @@ class AsyncronousLibUsbAdaptor : public BaseLibUsbAdaptor {
   OLA_ASSERT_EQ(expected, JsonWriter::AsString(uint_value));
  * Test the uint item
     "  \"type\": \"uint\",\n"
-    "  \"type\": \"uint\",\n"
-    "  \"type\": \"uint\",\n"
-    "  \"type\": \"uint\",\n"
   std::map<std::string, UIntMap*> m_uint_map_variables;
     if (message.uint_offset < MAX_UINT_FIELDS) {
       message.uint16_fields[message.uint_offset++] = field->Value();
@@ -128,10 +127,8 @@ class AsyncronousLibUsbAdaptor : public BaseLibUsbAdaptor {
     status_message() : uint_offset(0), int_offset(0), status_type(0),
     std::string Type() const { return "uint"; }
       if (items[i]['type'] == 'uint') {
-      if (items[i]['type'] == 'uint') {
     if (type == 'string' || type == 'uint' || type == 'hidden') {
 const char RDMHTTPModule::GENERIC_UINT_FIELD[] = "int";
-  section.AddItem(new HiddenItem("1", GENERIC_UINT_FIELD));
   section.AddItem(new HiddenItem("1", GENERIC_UINT_FIELD));
   SelectItem *item = new SelectItem("Personality", GENERIC_UINT_FIELD);
   string personality_str = request->GetParameter(GENERIC_UINT_FIELD);
@@ -182,3 +179,21 @@ function ok(a,b){for(var c=a.wa[b].data.items,d=c.length,g=N(a.wa[b].id),h="",i=
 import java.nio.ByteOrder;
         byte[] header = ByteBuffer.allocate(4).order(ByteOrder.nativeOrder()).putInt(headerContent).array();
         int headerValue = ByteBuffer.wrap(header).order(ByteOrder.nativeOrder()).getInt();
+# This is a very bodgy workaround to the fact that the pip install of the archive doesn't seem to work properly now on Travis
+    "uest\032\036.ola.rpc.STREAMING_NO_RESPONSEB\006\200\001"
+  s1 = "one\"two\\three/four\bfive\fsix\nseven\reight\tnine";
+      string("one\\\"two\\\\three\\/four\\bfive\\fsix\\nseven\\reight\\tnine"),
+  s1 = "one\"two\\three/four\bfive\fsix\nseven\reight\tnine";
+      string("one\\\"two\\\\three\\/four\\bfive\\fsix\\nseven\\reight\\tnine"),
+    self.assertEqual(rtf._EscapeData(u'caf\xe9'), "caf\\xe9")
+    self.assertEqual('%s' % rtf._EscapeData(u'caf\xe9'), "caf\\xe9")
+    self.assertEqual('%s' % rtf._EscapeData(['caf\xe9']), "['caf\\\\xe9']")
+    self.assertEqual('%s' % rtf._EscapeData({"a": "caf\xe9"}),
+                     "{'a': 'caf\\\\xe9'}")
+#    self.assertEqual('%s' % rtf._EscapeData({"caf\xe9": "bar"}),
+#                     "{'caf\xe9': 'bar'}")
+    self.assertEqual('caf\\xe9', StringEscape(u'caf\xe9'))
+    self.assertEqual('caf\\xe9', ("%s" % StringEscape(u'caf\xe9')))
+  "forin": true,
+          dcmd mv ../*ges built/
+        run: autopkgtest --output-dir=test-output built/*ges -- null

.codespellignorewords

@@ -0,0 +1,5 @@
+acn
+ACN
+inflight
+thead
+wronly

.flake8

@@ -0,0 +1,4 @@
+[flake8]
+max-line-length = 80
+exclude = .svn,CVS,.bzr,.hg,.git,__pycache__,.tox,*_pb2.py
+ignore = E111,E114,E121,E127,E129,W504

.github/dependabot.yml

@@ -0,0 +1,10 @@
+# See: https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#about-the-dependabotyml-file
+version: 2
+
+updates:
+  # Configure check for outdated GitHub Actions actions in workflows.
+  # See: https://docs.github.com/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot
+  - package-ecosystem: github-actions
+    directory: / # Check the repository's workflows under /.github/workflows/
+    schedule:
+      interval: daily

.github/problem-matcher-build-verify-trees.json

@@ -0,0 +1,15 @@
+{
+    "problemMatcher": [
+        {
+            "owner": "build-verify-trees",
+            "severity": "error",
+            "pattern": [
+                {
+                    "regexp": "^(Missing from tarball)(\\s+)(.+)$",
+                    "message": 1,
+                    "file": 3
+                }
+            ]
+        }
+    ]
+}

.github/problem-matcher-lint-check-licences.json

@@ -0,0 +1,16 @@
+{
+    "problemMatcher": [
+        {
+            "owner": "lint-check-licences",
+            "pattern": [
+                {
+                    "regexp": "^(notice|error)(:(file|dir):([^:]+)(:lines? (\\d+)(-(\\d+))?)?)?: (.+)$",
+                    "severity": 1,
+                    "file": 4,
+                    "line": 6,
+                    "message": 9
+                }
+            ]
+        }
+    ]
+}

.github/problem-matcher-lint-cpplint.json

@@ -0,0 +1,17 @@
+{
+    "problemMatcher": [
+        {
+            "owner": "lint-cpplint",
+            "severity": "error",
+            "pattern": [
+                {
+                    "regexp": "^(.+):(\\d+):\\s+((.+)\\s+\\[(.*)\\]\\s\\[(.*)\\])$",
+                    "file": 1,
+                    "line": 2,
+                    "message": 3,
+                    "code": 5
+                }
+            ]
+        }
+    ]
+}

.github/problem-matcher-lint-generic-nolints.json

@@ -0,0 +1,16 @@
+{
+    "problemMatcher": [
+        {
+            "owner": "lint-generic-nolints",
+            "pattern": [
+                {
+                    "regexp": "^(notice|error)(:(file|dir):([^:]+)(:lines? (\\d+)(-(\\d+))?)?)?: (.+)$",
+                    "severity": 1,
+                    "file": 4,
+                    "line": 6,
+                    "message": 9
+                }
+            ]
+        }
+    ]
+}

.github/problem-matcher-lint-spellintian.json

@@ -0,0 +1,15 @@
+{
+    "problemMatcher": [
+        {
+            "owner": "lint-spellintian",
+            "severity": "warning",
+            "pattern": [
+                {
+                    "regexp": "^([^:]+):(\\s+)(.+)$",
+                    "file": 1,
+                    "message": 3
+                }
+            ]
+        }
+    ]
+}

.github/workflows/build.yaml

@@ -0,0 +1,200 @@
+name: build
+on: [push, pull_request]
+jobs:
+  build:
+    name: "${{ matrix.id }}"
+    runs-on: ubuntu-latest
+    container: ${{ matrix.container }}
+    timeout-minutes: 360
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - id: "coverage-debian-stable-amd64-gcc"
+            task: "coverage"
+            configure-args: "--enable-ja-rule --enable-e133 --enable-unittests --enable-gcov"
+            # TODO(Perry): Fix Debian 12 OOM issue on GitHub Actions
+            container: "debian:stable"
+            compiler: 
+              CC: "/usr/bin/gcc"
+              CXX: "/usr/bin/g++"
+              pkg: "gcc g++"
+          - id: "distcheck-debian-stable-amd64-gcc"
+            task: "distcheck"
+            configure-args: "--enable-ja-rule --enable-e133 --enable-rdm-tests"
+            # TODO(Perry): Fix Debian 12 OOM issue on GitHub Actions
+            container: "debian:stable"
+            compiler:
+              CC: "/usr/bin/gcc"
+              CXX: "/usr/bin/g++"
+              pkg: "gcc g++"
+          - id: "distcheck-debian-stable-amd64-clang"
+            task: "distcheck"
+            configure-args: "--enable-ja-rule --enable-e133 --enable-rdm-tests"
+            # TODO(Perry): Fix Debian 12 OOM issue on GitHub Actions
+            container: "debian:stable"
+            compiler:
+              CC: "/usr/bin/clang"
+              CXX: "/usr/bin/clang++"
+              pkg: "clang"
+    env:
+      CC: "${{ matrix.compiler.CC }}"
+      CXX: "${{ matrix.compiler.CXX }}"
+    steps:
+      - name: Get number of CPU cores
+        id: num-cpu-cores
+        # TODO(Perry): Parallelization causes GH Actions to hang -j${{ steps.num-cpu-cores.outputs.NUM_CPU_CORES }}
+        # run: echo "NUM_CPU_CORES=$(grep -c processor /proc/cpuinfo)" >> $GITHUB_OUTPUT
+        run: echo "NUM_CPU_CORES=1" >> $GITHUB_OUTPUT
+      - name: Update package database
+        run: apt-get update -y
+      # See comments beginning at
+      # https://github.com/actions/runner/issues/763#issuecomment-1435474884
+      # Without Git, actions/checkout@v4 will resort to REST and will not
+      # create a .git folder or .git.config. The Problem Matcher looks for
+      # .git/config to find where the root of the repo is, so it must be
+      # present.
+      - name: Install Git
+        run: apt-get -y install git
+      - uses: actions/checkout@v4
+      - name: Install build tools
+        shell: bash
+        run: |
+          apt-get -y install adduser sudo pkg-config libtool autoconf \
+            automake g++ bison flex make bash-completion dh-autoreconf \
+            debhelper devscripts wget python3-full python3-pip
+      - name: Setup Python venv
+        shell: bash
+        run: |
+          python3 -m venv --system-site-packages ../venv
+          source ../venv/bin/activate
+          echo "PATH=$PATH" >> $GITHUB_ENV
+      - name: Install Python build tools
+        run: python3 -m pip install --no-input gcovr
+      - name: Install build dependencies
+        shell: bash
+        run: |
+          apt-get -y install libcppunit-dev uuid-dev libncurses5-dev \
+            libmicrohttpd-dev protobuf-compiler python3-protobuf \
+            libprotobuf-dev libprotoc-dev zlib1g-dev libftdi-dev \
+            libusb-1.0-0-dev liblo-dev libavahi-client-dev python3-numpy \
+            default-jdk-headless maven
+      - name: Install compiler
+        shell: bash
+        run: apt-get -y install ${{ matrix.compiler.pkg }}
+      - name: Set up build user # CredentialsTest cannot run as root
+        run: |
+          adduser --disabled-password --gecos "" builduser
+          chown -R builduser:builduser .
+          chown builduser:builduser ..
+      - name: Autoreconf
+        run: sudo --preserve-env -u builduser env "PATH=$PATH" autoreconf -i
+      - name: Set configure arguments
+        # Env var name DISTCHECK_CONFIGURE_FLAGS must be used, see #1881 and #1883
+        run: |
+          echo "DISTCHECK_CONFIGURE_FLAGS=${{ matrix.configure-args }}" >> $GITHUB_ENV
+      - name: Set additional Linux configure arguments
+        if: runner.os == 'Linux'
+        # Silence all deprecated declarations on Linux due to auto_ptr making the build log too long
+        run: |
+          echo "DISTCHECK_CONFIGURE_FLAGS=$DISTCHECK_CONFIGURE_FLAGS CPPFLAGS=-Wno-deprecated-declarations" >> $GITHUB_ENV
+      - name: Print configure command
+        run: echo "./configure $DISTCHECK_CONFIGURE_FLAGS"
+      - name: Configure
+        run: sudo --preserve-env -u builduser env "PATH=$PATH" ./configure $DISTCHECK_CONFIGURE_FLAGS
+      - name: ${{ matrix.task }}
+        run: sudo --preserve-env -u builduser env "PATH=$PATH" make ${{ matrix.task }} -j${{ steps.num-cpu-cores.outputs.NUM_CPU_CORES }} VERBOSE=1
+      - name: Display structure of the built files
+        if: always() && env.ACTIONS_STEP_DEBUG == 'true'
+        run: ls -alR
+      - name: Archive artifacts to speed up slow GH Actions upload/download
+        if: always()
+        shell: bash
+        # If the file does not exist when tar excludes it, then it will not
+        # actually exclude it, so it must first be touched
+        run: |
+          touch ola-${{ matrix.id }}-source-tree.tar.gz
+          tar --exclude=ola-${{ matrix.id }}-source-tree.tar.gz -cvzf ola-${{ matrix.id }}-source-tree.tar.gz .
+      - name: SHA256 artifact archives
+        if: always()
+        run: sha256sum ola-*.tar.gz
+      - name: Upload source tree artifact
+        uses: actions/upload-artifact@v3
+        if: always()
+        with:
+          name: ola-${{ matrix.id }}-source-tree
+          path: ola-${{ matrix.id }}-source-tree.tar.gz
+      - name: Upload built artifact
+        if: matrix.task == 'distcheck' || matrix.task == 'dist'
+        uses: actions/upload-artifact@v3
+        with:
+          name: ola-${{ matrix.id }}-dist
+          path: |
+            ola-*.tar.gz
+            !ola-${{ matrix.id }}-source-tree.tar.gz
+      - name: Install coverage tools
+        if: matrix.task == 'coverage'
+        run: apt-get -y install curl
+      - name: Upload coverage to Coveralls
+        if: matrix.task == 'coverage'
+        uses: coverallsapp/github-action@v2
+        with:
+          # Coveralls GitHub action does not support its own format
+          # see: https://github.com/coverallsapp/github-action/issues/104
+          # file: coverage/coverage.coveralls.json
+          file: coverage/coverage.cobertura.xml
+          format: cobertura
+          flag-name: ${{ matrix.id }}
+      - name: Upload coverage artifacts
+        if: always() && matrix.task == 'coverage'
+        uses: actions/upload-artifact@v3
+        with:
+          name: ola-${{ matrix.id }}-coverage
+          path: coverage/
+  verify-trees:
+    name: 'Verify trees for ${{ matrix.id }}'
+    needs: build
+    if: "always()" # Run if some builds fail but ensure they all complete first
+    container: debian:stable
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - id: "distcheck-debian-stable-amd64-gcc"
+          - id: "distcheck-debian-stable-amd64-clang"
+    steps:
+      - name: Download built source tree archive
+        uses: actions/download-artifact@v3
+        with:
+          name: ola-${{ matrix.id }}-source-tree
+          path: .
+      - name: SHA256 artifact archive
+        run: sha256sum ola-${{ matrix.id }}-source-tree.tar.gz
+      - name: Unarchive artifacts and delete archive
+        shell: bash
+        run: |
+          tar -xvzf ola-${{ matrix.id }}-source-tree.tar.gz .
+          rm ola-${{ matrix.id }}-source-tree.tar.gz
+      - name: Display structure of extracted files
+        if: env.ACTIONS_STEP_DEBUG == 'true'
+        run: ls -alR
+      - name: Update package database
+        run: apt-get update -y
+      - name: Install Python
+        run: apt-get -y install python3 python-is-python3
+      # TODO(Perry): Disable problem matcher for now until verify trees is fixed
+      # - name: Enable Problem Matcher for GitHub annotations
+      #   run: echo "::add-matcher::.github/problem-matcher-build-verify-trees.json"
+      - name: Find dist build tarball
+        run: |
+          echo "GH_OLA_VERIFY_TREES_TARBALL=$(ls -t --time=birth ola*.tar.gz| head -1)" >> $GITHUB_ENV
+      - name: Print dist build tarball name
+        run: echo "$GH_OLA_VERIFY_TREES_TARBALL"
+      - name: Extract dist build
+        run: tar -xvzf $GH_OLA_VERIFY_TREES_TARBALL
+      - name: Verify trees
+        shell: bash
+        # TODO(Perry): Always succeed for now until verify trees is fixed
+        # run: ./scripts/verify_trees.py ./ $(echo $GH_OLA_VERIFY_TREES_TARBALL | sed 's/.tar.gz$//')
+        run: "./scripts/verify_trees.py ./ $(echo $GH_OLA_VERIFY_TREES_TARBALL | sed 's/.tar.gz$//') || true"