Merge branch 'DaAwesomeP-GitHubActionsLint' into DaAwesomeP-GitHubActionsLint2

Author: DaAwesomeP

.github/workflows/annotation.yml

@@ -0,0 +1,14 @@
+# GitHub Action to annotate some of our test tool results
+name: annotation
+on: [push, pull_request]
+jobs:
+  flake8-annotation-python2:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+      - uses: actions/setup-python@v2
+        with:
+          python-version: '2.7'
+      - name: Flake8 with annotations - Python 2
+        # Using the flake8 options in the .flake8 file
+        uses: TrueBrain/actions-flake8@main

.github/workflows/lint.yaml

@@ -1,37 +1,15 @@
 name: lint
 on: [push, pull_request]
 jobs:
-  check-licences:
-    name: Check Licences
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-python@v4
-        with:
-          python-version: '3.10'
-      - name: Enable Problem Matcher for GitHub annotations
-        run: echo "::add-matcher::.github/problem-matcher-lint-check-licences.json"
-      - name: Check licenses
-        shell: bash
-        run: ./scripts/enforce_licence.py
-  generic-nolints:
-    name: Count generic NOLINTs
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - name: Enable Problem Matcher for GitHub annotations
-        run: echo "::add-matcher::.github/problem-matcher-lint-generic-nolints.json"
-      - name: Count the number of generic NOLINTs
-        shell: bash
-        run: ./scripts/count_generic_nolints.sh
   build:
     name: Build for Lint Tasks
     runs-on: ubuntu-latest
     container: debian:stable
     steps:
       - name: Update package database
         run: apt-get update -y
-      # See comments beginning at https://github.com/actions/runner/issues/763#issuecomment-1435474884
+      # See comments beginning at
+      # https://github.com/actions/runner/issues/763#issuecomment-1435474884
       # Without Git, actions/checkout@v3 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
@@ -58,10 +36,15 @@ jobs:
         run: autoreconf -i
       - name: Configure
         run: ./configure --enable-rdm-tests --enable-ja-rule --enable-e133
-      - name: Build
+      - name: Build builtfiles
         run: make builtfiles VERBOSE=1
+      - name: Display structure of the built files
+        if: env.ACTIONS_STEP_DEBUG == 'true'
+        run: ls -alR
       - name: Archive artifacts to speed up slow GH Actions upload/download
         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-debian-stable-built-source-tree.tar.gz
           tar --exclude=ola-debian-stable-built-source-tree.tar.gz -cvzf ola-debian-stable-built-source-tree.tar.gz .
@@ -71,6 +54,62 @@ jobs:
         with:
           name: ola-debian-stable-built-source-tree
           path: ola-debian-stable-built-source-tree.tar.gz
+  check-licences:
+    name: Check Licences
+    runs-on: ubuntu-latest
+    container: debian:stable
+    needs: build
+    steps:
+      - name: Download built source tree archive
+        uses: actions/download-artifact@v3
+        with:
+          name: ola-debian-stable-built-source-tree
+          path: .
+      - name: SHA256 artifact archive
+        run: sha256sum ola-debian-stable-built-source-tree.tar.gz
+      - name: Unarchive artifacts and delete archive
+        shell: bash
+        run: |
+          tar -xvzf ola-debian-stable-built-source-tree.tar.gz .
+          rm ola-debian-stable-built-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
+      - name: Enable Problem Matcher for GitHub annotations
+        run: echo "::add-matcher::.github/problem-matcher-lint-check-licences.json"
+      - name: Check licenses
+        shell: bash
+        run: ./scripts/enforce_licence.py
+  generic-nolints:
+    name: Count generic NOLINTs
+    runs-on: ubuntu-latest
+    container: debian:stable
+    needs: build
+    steps:
+      - name: Download built source tree archive
+        uses: actions/download-artifact@v3
+        with:
+          name: ola-debian-stable-built-source-tree
+          path: .
+      - name: SHA256 artifact archive
+        run: sha256sum ola-debian-stable-built-source-tree.tar.gz
+      - name: Unarchive artifacts and delete archive
+        shell: bash
+        run: |
+          tar -xvzf ola-debian-stable-built-source-tree.tar.gz .
+          rm ola-debian-stable-built-source-tree.tar.gz
+      - name: Display structure of extracted files
+        if: env.ACTIONS_STEP_DEBUG == 'true'
+        run: ls -alR
+      - name: Enable Problem Matcher for GitHub annotations
+        run: echo "::add-matcher::.github/problem-matcher-lint-generic-nolints.json"
+      - name: Count the number of generic NOLINTs
+        shell: bash
+        run: ./scripts/count_generic_nolints.sh
   cpplint:
     name: cpplint
     runs-on: ubuntu-latest
@@ -90,6 +129,7 @@ jobs:
           tar -xvzf ola-debian-stable-built-source-tree.tar.gz .
           rm ola-debian-stable-built-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
@@ -131,6 +171,7 @@ jobs:
           tar -xvzf ola-debian-stable-built-source-tree.tar.gz .
           rm ola-debian-stable-built-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

Makefile.am

@@ -259,7 +259,7 @@ CPP_LINT_FILES = $(shell find . \( -name "*.h" -or -name "*.cpp" \) -and ! \( \
 .PHONY : cpplint
 cpplint: Makefile.am
 if FOUND_CPPLINT
-	cpplint --repository=. --filter=$(CPP_LINT_FILTER) $(CPP_LINT_FILES)
+	cpplint --filter=$(CPP_LINT_FILTER) $(CPP_LINT_FILES)
 else
-  $(error cpplint not found. Install cpplint via pip and re-run configure.)
+  $(error cpplint not found. Install forked cpplint (e.g. via pip for the latest version) and re-run configure.)
 endif

NEWS

@@ -1,22 +1,43 @@
-x/y/2022 ola-0.10.9
+x/y/2023 ola-0.10.9
  Features:
- *
+ * Further improvements on Python 3 compatibility #1506
+ * Support for the JMS USB2DMX PRO V2.1 device via the FTDI plugin #1728
 
  API:
  * Python: Add a fetch current DMX example.
 
  RDM Tests:
- * 
+ * Fix a longstanding bug in the GetMaxPacketSize RDM test around timeouts
 
  Bugs:
  * Fix some tests not working on Big Endian machines because our RPC is encoded
    with native format and those tests used sample data from a Little Endian
    machine
  * Renamed EndpointNoticationEvent(sic) to EndpointNotificationEvent in the
    E1.33 EndpointManager code
+ * Check if librt exists and add it to the build if required
+ * Ensure we can build on later Protobuf and C++ and silence deprecation
+   messages where required
+ * Fix the NetBSD build
+ * Clarify the usage of some of the various Enttec Open DMX USB plugins
+ * Relax the timing on the ClientWrapperTest so it doesn't fail occasionally
+   #1714
+ * Correct the documentation of some existing limits in the E1.31 plugin
+ * Fix some undefined behaviour in TimeoutManager::ExecuteTimeouts #1726
+ * Fix UARTs on Debian Bullseye #1749
+ * Fix Python version detection for versions > 3.9 #1755, #1780
+ * Update Angular and Angular-Route versions used by the new web UI and add
+   workaround to be compatible #1782 Debian #1016447
+ * Significantly reduce the delay when using StreamingClient with EPoll and
+   multiple universes #1793
 
  Internal:
- *
+ * Add more debugging so we can tell why setting the baud rate failed
+ * Replace "currentThread" with "current_thread" in Python since the former has
+   been deprecated
+ * Fix lots more internal typos and grammar
+ * Add unit tests for more of the Python RDM Test classes
+ * Sort the Python imports with isort
 
 22/11/2020 ola-0.10.8
  Features:

olad/www/mobile.html

@@ -459,7 +459,7 @@
     </noscript>
 
     <div id='footer'>
-      OLA &copy; 2005-2020 Open Lighting Project<br/>
+      OLA &copy; 2005-2023 Open Lighting Project<br/>
       <a href="ola.html">Full Version</a> - <a href="new/">New UI (Beta)</a>
     </div>
   </body>

olad/www/ola.html

@@ -1026,7 +1026,7 @@ <h2 id="plugin_name"></h2>
     </noscript>
 
     <div id='footer'>
-      OLA &copy; 2005-2020 Open Lighting Project<br>
+      OLA &copy; 2005-2023 Open Lighting Project<br>
       <a href="mobile.html">Mobile Version</a> - <a href="new/">New UI (Beta)</a>
     </div>
   </body>

scripts/enforce_licence.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python3
+#!/usr/bin/env python
 #  This program is free software; you can redistribute it and/or modify
 #  it under the terms of the GNU General Public License as published by
 #  the Free Software Foundation; either version 2 of the License, or
@@ -237,8 +237,8 @@ def GetDirectoryLicences(root_dir):
       lines = f.readlines()
       f.close()
       licences[dir_name] = TransformLicence(lines)
-      rel_licence_path = "./" + os.path.relpath(licence_path)
-      rel_dir_path = "./" + os.path.relpath(dir_name)
+      rel_licence_path = os.path.relpath(licence_path)
+      rel_dir_path = os.path.relpath(dir_name)
       print('debug:file:%s: Found LICENCE for directory %s' %
             (rel_licence_path, rel_dir_path))
 
@@ -284,7 +284,7 @@ def CheckLicenceForFile(file_name, licence, lang, diff, fix):
     return 0
 
   f = open(file_name)
-  rel_path = "./" + os.path.relpath(file_name)
+  rel_path = os.path.relpath(file_name)
   # + 1 to include the newline to have a complete line
   header_size = len(licence) + 1
   file_name_line_count = licence.count('\n') + 2
@@ -318,8 +318,8 @@ def CheckLicenceForFile(file_name, licence, lang, diff, fix):
     ReplaceHeader(file_name, licence, lang)
     return 1
   else:
-    print("error:file:%s:lines 1-%s: File does not start with or not exact "
-          "match of \"%s...\"" %
+    print("error:file:%s:lines 1-%s: File does not start with, or not exact "
+          "match of, \"%s...\"" %
           (rel_path, file_name_line_count,
            licence.split('\n')[(0 if (lang == PYTHON) else 1)]))
     if diff: