[Major update] Refactor JSL

.github/workflows/build.yml

@@ -0,0 +1,66 @@
+name: Build
+
+on:
+  push:
+    branches:
+      - master
+      - refactor-2
+  pull_request:
+    branches:
+      - master
+      - refactor-2
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v3
+
+    - name: Set up JDK 17
+      uses: actions/setup-java@v3
+      with:
+        distribution: 'temurin'
+        java-version: '17'
+
+    - name: Cache Gradle packages
+      uses: actions/cache@v3
+      with:
+        path: |
+          ~/.gradle/caches
+          ~/.gradle/wrapper
+        key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
+        restore-keys: |
+          ${{ runner.os }}-gradle-
+
+    # Use system Gradle to regenerate wrapper with correct version (e.g., Gradle 9)
+    - name: Create gradle wrapper
+      run: gradle wrapper --gradle-version 9.0.0 --distribution-type all
+
+    - name: Grant execute permission for Gradle wrapper
+      run: chmod +x ./gradlew
+
+    - name: Run tests with coverage
+      run: ./gradlew test jacocoTestReport
+
+    - name: Upload test results
+      uses: actions/upload-artifact@v4
+      with:
+        name: test-results
+        path: build/reports/tests
+
+    - name: Upload code coverage report
+      uses: actions/upload-artifact@v4
+      with:
+        name: code-coverage-report
+        path: build/reports/jacoco/test/html
+
+    - name: Generate docs
+      run: ./gradlew groovydoc
+
+    - name: Upload GroovyDoc
+      uses: actions/upload-artifact@v4
+      with:
+        name: groovydoc
+        path: build/docs/groovydoc

.github/workflows/doc.yml

@@ -0,0 +1,180 @@
+name: Documentation Tests
+
+on: [push, pull_request]
+
+jobs:
+  Doc:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python 3.8
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.8
+
+      - name: Install Graphviz
+        run: sudo apt-get install graphviz
+
+      - name: Install dependencies
+        run: |
+          pip install -r requirements_doc.txt
+
+      - name: Download PlantUML jar
+        run: curl -L -o plantuml.jar https://github.com/plantuml/plantuml/releases/download/v1.2024.7/plantuml-1.2024.7.jar
+
+      - name: Build doc
+        run: |
+          cd doc && rm -rf build && make html
+          cd ..
+
+  CheckDocs:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python 3.8
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.8
+
+      - name: Install Graphviz
+        run: sudo apt-get install graphviz
+
+      - name: Install dependencies
+        run: |
+          pip install -r requirements_doc.txt
+
+      - name: Download PlantUML jar
+        run: curl -L -o plantuml.jar https://github.com/plantuml/plantuml/releases/download/v1.2024.7/plantuml-1.2024.7.jar
+
+      - name: Check doc build
+        run: |
+          cd doc
+          rm -rf build
+          make html SPHINXOPTS="-W"
+          cd ..
+
+      - name: Check doc coverage
+        run: |
+          cd doc
+          make coverage
+          cat build/coverage/python.txt
+          cat build/coverage/python.txt | wc -l | xargs -I % test % -eq 2
+          cd ..
+
+      # To add when the doc links are fixed
+      # - name: Check doc links
+      #   run: |
+      #     cd doc
+      #     make linkcheck
+      #     cd ..
+
+  DeployMainDoc:
+    runs-on: ubuntu-latest
+    needs: [CheckDocs, Doc]
+    if: github.ref == 'refs/heads/refactor-2'
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python 3.8
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.8
+
+      - name: Install Graphviz
+        run: sudo apt-get install graphviz
+
+      - name: Install dependencies
+        run: |
+          pip install -r requirements_doc.txt
+
+      - name: Download PlantUML jar
+        run: curl -L -o plantuml.jar https://github.com/plantuml/plantuml/releases/download/v1.2024.7/plantuml-1.2024.7.jar
+
+      - name: Build doc and release
+        run: |
+          cd doc && rm -rf build && make html
+          cd ..
+
+      - name: Publish doc
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./doc/build/html
+          publish_branch: refactor-2
+          destination_dir: docs
+
+  DeployDevelopmentDoc:
+    runs-on: ubuntu-latest
+    needs: [CheckDocs, Doc]
+    # Only run on pull requests to refactor-2 and non-forks
+    if: github.event_name == 'pull_request' && github.base_ref == 'refactor-2' && ! github.event.pull_request.head.repo.fork
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python 3.8
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.8
+
+      - name: Install Graphviz
+        run: sudo apt-get install graphviz
+
+      - name: Install dependencies
+        run: |
+          pip install -r requirements_doc.txt
+
+      - name: Download PlantUML jar
+        run: curl -L -o plantuml.jar https://github.com/plantuml/plantuml/releases/download/v1.2024.7/plantuml-1.2024.7.jar
+
+      - name: Build doc and release
+        run: |
+          export GIT_BRANCH=${{ github.head_ref }}
+          export DEV_BUILD=1
+          cd doc && rm -rf build && make html
+          cd ..
+
+      - name: Publish doc
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./doc/build/html
+          publish_branch: refactor-2
+          destination_dir: prs/${{ github.head_ref }}
+
+  Deploy:
+    runs-on: ubuntu-latest
+    needs: [Doc]
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python 3.8
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.8
+
+      - name: Install Graphviz
+        run: sudo apt-get install graphviz
+
+      - name: Install dependencies
+        run: |
+          pip install -r requirements_doc.txt
+          pip install setuptools wheel twine build
+
+      - name: Download PlantUML jar
+        run: curl -L -o plantuml.jar https://github.com/plantuml/plantuml/releases/download/v1.2024.7/plantuml-1.2024.7.jar
+
+      - name: Build doc and release
+        run: |
+          cd doc && rm -rf build && make html
+          cd ..
+          python -m build
+
+      - name: Publish doc
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./doc/build/html
+          publish_branch: refactor-2
+          destination_dir: docs

README.md

@@ -1,5 +1,6 @@
 # jenkins-shared-library
 
-[![Documentation Status](https://readthedocs.org/projects/jenkins-shared-library/badge/?version=latest)](https://jenkins-shared-library.readthedocs.io/en/latest/?badge=latest)
+[![Documentation](https://github.com/sdgtt/jenkins-shared-library/actions/workflows/pages/pages-build-deployment/badge.svg)](https://sdgtt.github.io/jenkins-shared-library/)
+[![Build](https://github.com/sdgtt/jenkins-shared-library/actions/workflows/build.yml/badge.svg)](https://github.com/sdgtt/jenkins-shared-library/actions/workflows/build.yml)
 
 CI Shared Library

build.gradle

@@ -0,0 +1,61 @@
+plugins {
+    id 'groovy'
+    id 'java'
+    id 'jacoco'
+}
+
+repositories {
+    mavenCentral()
+    maven {
+        url 'https://repo.jenkins-ci.org/releases/'
+        url 'https://repo.jenkins-ci.org/public/'
+    }
+}
+
+dependencies {
+    implementation 'org.codehaus.groovy:groovy-all:3.0.9'
+    implementation 'com.cloudbees:groovy-cps:1.24'
+    implementation 'org.jenkins-ci.main:jenkins-core:2.121.2'
+    implementation('org.jenkinsci.plugins:pipeline-model-definition:2.2214.vb_b_34b_2ea_9b_83') {
+        artifact {
+            extension = 'jar'
+        }
+    }
+    // testImplementation 'junit:junit:4.13.2'
+    // testImplementation 'org.mockito:mockito-core:3.11.2'
+    testImplementation 'com.lesfurets:jenkins-pipeline-unit:1.9'
+    testImplementation 'org.spockframework:spock-core:2.0-groovy-3.0'
+    testImplementation 'org.spockframework:spock-junit4:2.0-groovy-3.0'
+    testImplementation 'cglib:cglib-nodep:3.3.0'
+
+
+}
+
+sourceSets {
+    main {
+        groovy {
+            srcDirs = ['src', 'vars']
+        }
+    }
+    test {
+        groovy {
+            srcDirs = ['test']
+        }
+    }
+}
+
+test {
+    useJUnitPlatform()
+    testLogging {
+        events "passed", "skipped", "failed"
+    }
+    finalizedBy jacocoTestReport
+}
+
+jacocoTestReport {
+    dependsOn test
+    reports {
+        xml.required = true
+        html.required = true
+    }
+}

doc/source/conf.py

@@ -12,6 +12,7 @@
 #
 import os
 import sys
+import sphinx_rtd_theme
 sys.path.insert(0, os.path.abspath('.'))
 
 
@@ -37,8 +38,15 @@
     "sphinx_rtd_theme",
     "sphinx.ext.graphviz",
     "sphinx.ext.autosectionlabel",
-    "sphinx_toolbox.collapse"
+    "sphinx_toolbox.collapse",
+    "sphinx.ext.coverage",
+    "myst_parser",
+    "sphinxcontrib.mermaid",
+    "sphinx_remove_toctrees",
+    "sphinx_click",
+    "sphinxcontrib.plantuml",
 ]
+plantuml = "java -jar ../../plantuml.jar"
 autosectionlabel_prefix_document = True
 
 # Add any paths that contain templates here, relative to this directory.
@@ -55,7 +63,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = "sphinx_rtd_theme"
+html_theme = "furo"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

doc/source/gauntlet.pu

@@ -0,0 +1,23 @@
+@startuml Gauntlet Hardware Pipeline
+start
+title Gauntlet Hardware Pipeline
+:START(master);
+If (Update Agents (nuc-01)) 
+  :Query Node;
+else ()
+  :Update Agents (nuc-02);
+endif  
+switch (Check Required Hardware (master))
+  case ()
+    :Setup Docker (nuc-01-pluto);
+    :Linux Tests (nuc-01-pluto);  
+  case ()
+    :Setup Docker (nuc-01-zed-fmcomms2);
+    :Linux Tests (nuc-02);  
+
+  case ()
+    :Setup Docker (nuc-02-zc706-daq2);
+    :Linux Tests (nuc-02-zc706-daq2);
+endswitch
+  :Collect Logs;
+@enduml

doc/source/index.rst

@@ -41,6 +41,7 @@ Required Packages
    nebula
    artifacts
    vagrant
+   node_setup
 
 Indices and tables
 ==================