Merge pull request #1013 from slaclab/pre-release

Release Candidate v6.4.0
slaclab · Jul 23, 2024 · 50f80b4 · 50f80b4
2 parents 49886b5 + ab08b96
commit 50f80b4
Show file tree

Hide file tree

Showing 269 changed files with 1,416 additions and 1,636 deletions.
diff --git a/.github/workflows/rogue_ci.yml b/.github/workflows/rogue_ci.yml
@@ -34,20 +34,26 @@ jobs:
           cache: 'pip'
           cache-dependency-path: 'pip_requirements.txt'
 
+      # Install dependencies
       - name: Install dependencies
         run: |
           sudo apt-get update
           sudo apt-get install doxygen doxygen-doc libzmq3-dev libboost-all-dev
           pip install -r pip_requirements.txt
 
-      # Flake 8 check
-      - name: Flake8 Tests
+      # Python Linter
+      - name: Python Linter
         run: |
           python -m compileall -f ./python/
           flake8 --count ./python/
           python -m compileall -f ./tests
           flake8 --count ./tests/
 
+      # C++ Linter
+      - name: C++ Linter
+        run: |
+          find . -name '*.h' -o -name '*.cpp' | xargs cpplint
+
       # Rogue
       - name: Build Rogue
         run: |
@@ -136,95 +142,22 @@ jobs:
 
 # ----------------------------------------------------------------------------
 
-  conda_build:
-    name: Anaconda Build
+  conda_build_lib:
     needs: [full_build_test, small_build_test]
-    if: startsWith(github.ref, 'refs/tags/')
-    runs-on: ubuntu-20.04
-    steps:
-
-      # This step checks out a copy of your repository.
-      - uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-
-      - uses: actions/setup-python@v4
-        with:
-          python-version: 3.8
-
-      - name: Setup anaconda
-        run: |
-          cd ${HOME}
-          wget -O miniconda.sh https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh
-          bash miniconda.sh -b -p ${HOME}/miniconda
-          export PATH="${HOME}/miniconda/bin:$PATH"
-          source ${HOME}/miniconda/etc/profile.d/conda.sh
-          conda config --set always_yes yes
-          conda config --set channel_priority strict
-          conda install -n base conda-libmamba-solver
-          conda config --set solver libmamba
-          conda install conda-build anaconda-client conda-verify
-          conda update -q conda conda-build
-          conda update --all
-
-      - name: Get Image Information
-        id: get_image_info
-        env:
-          CONDA_UPLOAD_TOKEN_TAG: ${{ secrets.CONDA_UPLOAD_TOKEN_TAG }}
-        run: |
-          echo token=${CONDA_UPLOAD_TOKEN_TAG} >> ${GITHUB_OUTPUT}
-
-      - name: Build
-        run: |
-          export PATH="${HOME}/miniconda/bin:$PATH"
-          source ${HOME}/miniconda/etc/profile.d/conda.sh
-          conda build conda-recipe --output-folder bld-dir -c conda-forge
-
-      - name: Upload
-        run: |
-          export PATH="${HOME}/miniconda/bin:$PATH"
-          source ${HOME}/miniconda/etc/profile.d/conda.sh
-          anaconda -t ${{ steps.get_image_info.outputs.token }} upload --force bld-dir/*/*.tar.bz2
+    uses: slaclab/ruckus/.github/workflows/conda_build_lib.yml@main
+    with:
+      version: '1.0.0'
+    secrets:
+      CONDA_UPLOAD_TOKEN_TAG: ${{ secrets.CONDA_UPLOAD_TOKEN_TAG }}
 
 # ----------------------------------------------------------------------------
 
-  docker_build:
-    name: Docker Build
-    runs-on: ubuntu-20.04
+  docker_build_lib:
     needs: [full_build_test, small_build_test]
-    if: startsWith(github.ref, 'refs/tags/')
-    steps:
-
-      # This step checks out a copy of your repository.
-      - uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-
-      - name: Get Image Information
-        id: get_image_info
-        run: |
-          echo tag=`git describe --tags` >> ${GITHUB_OUTPUT}
-          echo branch=`echo ${GITHUB_REF} | awk 'BEGIN { FS = "/" } ; { print $3 }'` >> ${GITHUB_OUTPUT}
-
-      # Setup docker build environment
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v1
-
-      # Login to Dockerhub
-      - name: Login to Dockerhub
-        uses: docker/login-action@v1
-        with:
-          username: tidair
-          password: ${{ secrets.DOCKERHUB_TOKEN }}
-
-      # Build and push the docker image
-      - name: Build and push image to Dockerhub
-        uses: docker/build-push-action@v2
-        with:
-          context: .
-          file: ./docker/rogue/Dockerfile
-          push: true
-          tags: tidair/rogue:${{ steps.get_image_info.outputs.tag }}, tidair/rogue:latest
-          build-args: branch=${{ steps.get_image_info.outputs.branch }}
+    uses: slaclab/ruckus/.github/workflows/docker_build_lib.yml@main
+    with:
+      version: '1.0.0'
+    secrets:
+      DOCKERHUB_TOKEN: ${{ secrets.DOCKERHUB_TOKEN }}
 
 # ----------------------------------------------------------------------------
diff --git a/CPPLINT.cfg b/CPPLINT.cfg
@@ -0,0 +1,34 @@
+#######################################################
+# CPPLINT.cfg
+#######################################################
+
+# Increase the max number of characters on a given line
+linelength=250
+
+# List of filters to apply
+filter=-legal/copyright
+
+# Suppress the warning for unapproved C++11 headers
+# Required for "<thread> is an unapproved C++11 header"
+filter=-build/c++11
+
+# Disable the build/include_order check
+# Required for #include "rogue/Directives.h" to be at start
+filter=-build/include_order
+
+# Disable the build/header_guard check
+# Note changing header guard has wrong style
+# E.g. from __ROGUE_UTILITIES_FILEIO_MODULE_H__ to INCLUDE_ROGUE_UTILITIES_MODULE_H_
+filter=-build/header_guard
+
+# Disable whitespace/indent check
+# private/public: indent will be based on .clang-format format"
+filter=-whitespace/indent
+
+# Disable runtime/arrays
+# TODO: We should fix in the future
+filter=-runtime/arrays
+
+# Disable runtime/references
+# TODO: We should fix in the future
+filter=-runtime/references
diff --git a/include/rogue/Directives.h b/include/rogue/Directives.h
@@ -1,9 +1,6 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : Common Directives
  * ----------------------------------------------------------------------------
- * File       : Directives.h
- * Created    : 2023-02-13
+ * Company    : SLAC National Accelerator Laboratory
  * ----------------------------------------------------------------------------
  * Description:
  * Common Directives For Rogue

diff --git a/include/rogue/EnableSharedFromThis.h b/include/rogue/EnableSharedFromThis.h
@@ -1,9 +1,6 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : Common virtual class to enable shared_from_this() calls.
  * ----------------------------------------------------------------------------
- * File       : EnableSharedFromThis.h
- * Created    : 2019-11-15
+ * Company    : SLAC National Accelerator Laboratory
  * ----------------------------------------------------------------------------
  * Description:
  * This is a common parent class that must be used instead of std::enable_shared_from_this

diff --git a/include/rogue/GeneralError.h b/include/rogue/GeneralError.h
@@ -1,9 +1,6 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : General Error
  * ----------------------------------------------------------------------------
- * File       : GeneralError.h
- * Created    : 2017-12-05
+ * Company    : SLAC National Accelerator Laboratory
  * ----------------------------------------------------------------------------
  * Description:
  * General exception for Rogue

diff --git a/include/rogue/GilRelease.h b/include/rogue/GilRelease.h
@@ -1,9 +1,6 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : Release GIL within scope.
  * ----------------------------------------------------------------------------
- * File       : GilRelease.h
- * Created    : 2017-02-28
+ * Company    : SLAC National Accelerator Laboratory
  * ----------------------------------------------------------------------------
  * Description:
  * Release GIL for the scope of this class.

diff --git a/include/rogue/Helpers.h b/include/rogue/Helpers.h
@@ -1,9 +1,6 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : Helpful Functions
  * ----------------------------------------------------------------------------
- * File       : Helpers.h
- * Created    : 2018-11-28
+ * Company    : SLAC National Accelerator Laboratory
  * ----------------------------------------------------------------------------
  * Description:
  * Helper functions for Rogue

diff --git a/include/rogue/Logging.h b/include/rogue/Logging.h
@@ -1,9 +1,6 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : Logging interface
  * ----------------------------------------------------------------------------
- * File       : Logging.h
- * Created    : 2017-02-28
+ * Company    : SLAC National Accelerator Laboratory
  * ----------------------------------------------------------------------------
  * Description:
  * Logging interface for pyrogue
@@ -73,7 +70,7 @@ class Logging {
 
     static std::shared_ptr<rogue::Logging> create(std::string name, bool quiet = false);
 
-    Logging(std::string name, bool quiet = false);
+    explicit Logging(std::string name, bool quiet = false);
     ~Logging();
 
     static void setLevel(uint32_t level);

diff --git a/include/rogue/Queue.h b/include/rogue/Queue.h
@@ -1,9 +1,6 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : General Queue
  * ----------------------------------------------------------------------------
- * File       : Queue.h
- * Created    : 2017-01-18
+ * Company    : SLAC National Accelerator Laboratory
  * ----------------------------------------------------------------------------
  * Description:
  * General queue for Rogue

diff --git a/include/rogue/ScopedGil.h b/include/rogue/ScopedGil.h
@@ -1,9 +1,6 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : Scoped GIL
  * ----------------------------------------------------------------------------
- * File       : ScopedGil.h
- * Created    : 2017-02-28
+ * Company    : SLAC National Accelerator Laboratory
  * ----------------------------------------------------------------------------
  * Description:
  * Acquire the GIL for the scope of this class.

diff --git a/include/rogue/Version.h b/include/rogue/Version.h
@@ -1,9 +1,6 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : Rogue Version
  * ----------------------------------------------------------------------------
- * File       : Version.h
- * Created    : 2017-05-17
+ * Company    : SLAC National Accelerator Laboratory
  * ----------------------------------------------------------------------------
  * Description:
  * Version helpers for Rogue

diff --git a/include/rogue/hardware/MemMap.h b/include/rogue/hardware/MemMap.h
@@ -1,9 +1,9 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : Raw Memory Mapped Access
  * ----------------------------------------------------------------------------
- * File       : MemMap.h
- * Created    : 2019-11-18
+ * Company    : SLAC National Accelerator Laboratory
+ * ----------------------------------------------------------------------------
+ * Description:
+ *      Raw Memory Mapped Access
  * ----------------------------------------------------------------------------
  * This file is part of the rogue software platform. It is subject to
  * the license terms in the LICENSE.txt file found in the top-level directory

diff --git a/include/rogue/hardware/axi/AxiMemMap.h b/include/rogue/hardware/axi/AxiMemMap.h
@@ -1,9 +1,9 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : AXI Memory Mapped Access
  * ----------------------------------------------------------------------------
- * File       : AxiMemMap.h
- * Created    : 2017-03-21
+ * Company    : SLAC National Accelerator Laboratory
+ * ----------------------------------------------------------------------------
+ * Description:
+ *      AXI Memory Mapped Access
  * ----------------------------------------------------------------------------
  * This file is part of the rogue software platform. It is subject to
  * the license terms in the LICENSE.txt file found in the top-level directory
@@ -22,6 +22,7 @@
 
 #include <memory>
 #include <mutex>
+#include <string>
 #include <thread>
 
 #include "rogue/Logging.h"
@@ -69,7 +70,7 @@ class AxiMemMap : public rogue::interfaces::memory::Slave {
     static void setup_python();
 
     // Class Creator
-    AxiMemMap(std::string path);
+    explicit AxiMemMap(std::string path);
 
     // Destructor
     ~AxiMemMap();

diff --git a/include/rogue/hardware/axi/AxiStreamDma.h b/include/rogue/hardware/axi/AxiStreamDma.h
@@ -1,6 +1,9 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : AxiStreamDma Interface Class
+ * ----------------------------------------------------------------------------
+ * Company    : SLAC National Accelerator Laboratory
+ * ----------------------------------------------------------------------------
+ * Description:
+ *      AxiStreamDma Interface Class
  * ----------------------------------------------------------------------------
  * This file is part of the rogue software platform. It is subject to
  * the license terms in the LICENSE.txt file found in the top-level directory
@@ -19,6 +22,7 @@
 
 #include <map>
 #include <memory>
+#include <string>
 #include <thread>
 
 #include "rogue/Logging.h"
@@ -32,7 +36,7 @@ namespace axi {
 //! Storage class for shared memory buffers
 class AxiStreamDmaShared {
   public:
-    AxiStreamDmaShared(std::string path);
+    explicit AxiStreamDmaShared(std::string path);
 
     //! Shared FD
     int32_t fd;

diff --git a/include/rogue/hardware/axi/module.h b/include/rogue/hardware/axi/module.h
@@ -1,9 +1,6 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : Python Module
  * ----------------------------------------------------------------------------
- * File       : module.h
- * Created    : 2017-03-21
+ * Company    : SLAC National Accelerator Laboratory
  * ----------------------------------------------------------------------------
  * Description:
  * Python module setup