Release 1.6.27

.flake8

@@ -1,6 +1,6 @@
 [flake8]
 select = B,B9,BLK,C,D,DAR,E,F,I,W,C4,N
-ignore = E203,E501,W503,WPS111,WPS201,WPS202,WPS210,WPS211,WPS213,WPS219,WPS220,WPS221,WPS216,WPS226,WPS231,WPS232,WPS305,WPS336,WPS432,I001,I003,I004,I005
+ignore = E203,E501,W503,WPS111,WPS201,WPS202,WPS210,WPS211,WPS213,WPS219,WPS220,WPS221,WPS216,WPS226,WPS231,WPS232,WPS305,WPS336,WPS432,I001,I003,I004,I005,BLK100
 max-line-length = 120
 application-import-names = canu,tests
 import-order-style = google

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,26 @@
+### Summary and Scope
+
+Description:
+
+<!-- What does this change do? Use examples of new options and output changes when possible. If other changes were made list these as well in a list. --->
+
+PR checklist (you may replace this section):
+
+- [ ] I have run `nox` locally and all tests, linting, and code coverage pass
+- [ ] I have added new tests to cover the new code
+- [ ] My code follows the style guidelines of this project
+- [ ] If adding a new file, I have updated `pyinstaller.py`
+- [ ] I have updated the appropriate Changelog entries in `README.md`
+- [ ] I have incremented the version in the `README.md`
+
+### Issues and Related PRs
+
+* Resolves: `Issue`
+* Relates to: `Issue`
+* Requires: `Issue`
+
+### Testing
+
+Tested on:
+
+<!-- List of virtual or physical systems used. --->

.github/dependabot.yml

@@ -0,0 +1,13 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    labels:
+      - "dependencies"

.github/workflows/unittests.yml → .github/workflows/docs.yml

@@ -1,13 +1,15 @@
-name: Python package
+name: Python
 
 on: [push]
 
 jobs:
   nox:
-    name: Coverage, Docs, Lint, and Unit Tests
+    name: Docs
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v3
+      with:
+        fetch-depth: 0 # Also fetch git-tags
     - name: Set up Python
       uses: actions/setup-python@v3
       with:
@@ -16,4 +18,5 @@ jobs:
       env:
         GIT_REPO_NAME: "${GITHUB_REPOSITORY#*/}"
       run: |
-        make test
+        pip install .[ci]
+        nox -e docs

.github/workflows/lint.yml

@@ -0,0 +1,22 @@
+name: Python
+
+on: [push]
+
+jobs:
+  nox:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        fetch-depth: 0 # Also fetch git-tags
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: '3.10'
+    - name: nox
+      env:
+        GIT_REPO_NAME: "${GITHUB_REPOSITORY#*/}"
+      run: |
+        pip install .[ci]
+        nox -e lint

.github/workflows/tests.yml

@@ -0,0 +1,23 @@
+name: Python
+
+on: [push]
+
+jobs:
+  nox:
+    name: Tests and Coverage
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        fetch-depth: 0 # Also fetch git-tags
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: '3.10'
+    - name: nox
+      env:
+        GIT_REPO_NAME: "${GITHUB_REPOSITORY#*/}"
+      run: |
+        pip install .[ci]
+        nox -e tests
+        nox -e cover

.gitignore

@@ -2,6 +2,7 @@
 canu_cache.yaml
 files/*
 nornir.log
+pyinstaller.spec
 
 # Build artifacts
 *.py[cod]

Dockerfile

@@ -19,32 +19,22 @@
 # OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 # ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 # OTHER DEALINGS IN THE SOFTWARE.
-
-FROM artifactory.algol60.net/csm-docker/stable/csm-docker-sle-python:3.10
-
-# create canu user
-RUN     useradd -ms /bin/bash canu
+FROM    artifactory.algol60.net/csm-docker/stable/csm-docker-sle-python:3.10
 
 # update command prompt
 RUN     echo 'export PS1="canu \w : "' >> /etc/bash.bashrc
 
 # make files dir
 RUN     mkdir /files
 
-# prep image layer for faster builds
-COPY    requirements.txt /app/canu/
-
-RUN     pip3 install -r /app/canu/requirements.txt
+COPY    dist/rpmbuild/RPMS/x86_64/ /files
 
-# copy canu files
-COPY    . /app/canu
-
-# install canu
-RUN     pip3 install --editable /app/canu/
+RUN     ls -l /files && \
+        zypper --no-gpg-checks -n in --allow-unsigned-rpm --auto-agree-with-licenses -y /files/canu*.rpm
 
 # set file perms for canu
-RUN     chown -R canu /app/canu /files /home
-# set none root user: canu
-USER    canu
+RUN      chown -R canu /files /home
+
+USER     canu
 
 WORKDIR /files

Jenkinsfile.github

@@ -1,27 +1,37 @@
-// (C) Copyright [2022] Hewlett Packard Enterprise Development LP
-//
-// Permission is hereby granted, free of charge, to any person obtaining a
-// copy of this software and associated documentation files (the "Software"),
-// to deal in the Software without restriction, including without limitation
-// the rights to use, copy, modify, merge, publish, distribute, sublicense,
-// and/or sell copies of the Software, and to permit persons to whom the
-// Software is furnished to do so, subject to the following conditions:
-//
-// The above copyright notice and this permission notice shall be included
-// in all copies or substantial portions of the Software.
-//
-// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
-// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
-// OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
-// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
-// OTHER DEALINGS IN THE SOFTWARE.
+/*
+ *
+ *  MIT License
+ *
+ *  (C) Copyright 2021-2022 Hewlett Packard Enterprise Development LP
+ *
+ *  Permission is hereby granted, free of charge, to any person obtaining a
+ *  copy of this software and associated documentation files (the "Software"),
+ *  to deal in the Software without restriction, including without limitation
+ *  the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ *  and/or sell copies of the Software, and to permit persons to whom the
+ *  Software is furnished to do so, subject to the following conditions:
+ *
+ *  The above copyright notice and this permission notice shall be included
+ *  in all copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+ *  THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+ *  OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ *  ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ *  OTHER DEALINGS IN THE SOFTWARE.
+ *
+ */
 
 @Library('csm-shared-library') _
 
+def isStable = env.TAG_NAME != null ? true : false
+def pythonImage = 'artifactory.algol60.net/csm-docker/stable/csm-docker-sle-python'
 def pythonVersion = '3.10'
+
 pipeline {
+
     agent {
         label "metal-gcp-builder"
     }
@@ -34,49 +44,34 @@ pipeline {
     }
 
     environment {
-        DESCRIPTION = "CANU (CSM Automatic Network Utility) will float through a Shasta network and make switch setup and validation a breeze."
-        IS_STABLE = getBuildIsStable()
-        GIT_REPO_NAME = getRepoName()
-        BUILD_METADATA = getRpmRevision(isStable: env.IS_STABLE)
-        IMAGE_VERSION = getDockerBuildVersion(isStable: env.IS_STABLE)
-        DOCKER_ARGS = getDockerBuildArgs(name: "cray-${getRepoName()}", description: env.DESCRIPTION)
+        NAME = getRepoName()
+        IMAGE_VERSION = sh(returnStdout: true, script: "git describe --tags | tr -s '-' '_' | tr -d '^v'").trim()
+        VERSION = sh(returnStdout: true, script: "git describe --tags | tr -s '-' '~' | tr -d '^v'").trim()
     }
 
     stages {
 
-        stage("Prepare: RPM") {
+        stage('Prepare: RPMs') {
             agent {
                 docker {
-                    image "artifactory.algol60.net/csm-docker/stable/csm-docker-sle-python:${pythonVersion}"
+                    label 'docker'
+                    image "${pythonImage}:${pythonVersion}"
                     reuseNode true
-                    // Support docker in docker for clamav scan
-                    args "-v /var/run/docker.sock:/var/run/docker.sock -v /usr/bin/docker:/usr/bin/docker --group-add 999"
                 }
             }
             steps {
-                script {
-                    runLibraryScript("addRpmMetaData.sh", "${env.GIT_REPO_NAME}.spec")
-                    sh "make prepare"
-                }
+                runLibraryScript("addRpmMetaData.sh", "${env.NAME}.spec")
+                sh "make prepare"
+                sh "git update-index --assume-unchanged ${env.NAME}.spec"
             }
         }
 
-        stage("Build: Binary") {
-            steps {
-                script {
-                    sh "make binary"
-                }
-            }
-        }
-
-
-        stage("Build: RPMs") {
+        stage('Build: RPMs') {
             agent {
                 docker {
-                    image "artifactory.algol60.net/csm-docker/stable/csm-docker-sle-python:${pythonVersion}"
+                    label 'docker'
+                    image "${pythonImage}:${pythonVersion}"
                     reuseNode true
-                    // Support docker in docker for clamav scan
-                    args "-v /var/run/docker.sock:/var/run/docker.sock -v /usr/bin/docker:/usr/bin/docker --group-add 999"
                 }
             }
             steps {
@@ -87,10 +82,10 @@ pipeline {
         stage('Publish: RPMs') {
             steps {
                 script {
-                    publishCsmRpms(component: env.GIT_REPO_NAME, pattern: "dist/rpmbuild/RPMS/x86_64/*.rpm", os: "sle-15sp2", arch: "x86_64", isStable: env.IS_STABLE)
-                    publishCsmRpms(component: env.GIT_REPO_NAME, pattern: "dist/rpmbuild/RPMS/x86_64/*.rpm", os: "sle-15sp3", arch: "x86_64", isStable: env.IS_STABLE)
-                    publishCsmRpms(component: env.GIT_REPO_NAME, pattern: "dist/rpmbuild/SRPMS/*.rpm", os: "sle-15sp2", arch: "src", isStable: env.IS_STABLE)
-                    publishCsmRpms(component: env.GIT_REPO_NAME, pattern: "dist/rpmbuild/SRPMS/*.rpm", os: "sle-15sp3", arch: "src", isStable: env.IS_STABLE)
+                    publishCsmRpms(component: env.NAME, pattern: "dist/rpmbuild/RPMS/x86_64/*.rpm", os: "sle-15sp2", arch: "x86_64", isStable: isStable)
+                    publishCsmRpms(component: env.NAME, pattern: "dist/rpmbuild/RPMS/x86_64/*.rpm", os: "sle-15sp3", arch: "x86_64", isStable: isStable)
+                    publishCsmRpms(component: env.NAME, pattern: "dist/rpmbuild/SRPMS/*.rpm", os: "sle-15sp2", arch: "src", isStable: isStable)
+                    publishCsmRpms(component: env.NAME, pattern: "dist/rpmbuild/SRPMS/*.rpm", os: "sle-15sp3", arch: "src", isStable: isStable)
                 }
             }
         }
@@ -106,7 +101,7 @@ pipeline {
         stage('Publish: Image') {
             steps {
                 script {
-                    publishCsmDockerImage(image: "cray-${env.GIT_REPO_NAME}", tag: env.IMAGE_VERSION, isStable: env.IS_STABLE)
+                    publishCsmDockerImage(image: "cray-${env.NAME}", tag: env.IMAGE_VERSION, isStable: isStable)
                 }
             }
         }

pyinstaller.sh → MANIFEST.in

@@ -1,7 +1,7 @@
-#!/bin/bash
+#
 # MIT License
 #
-# (C) Copyright [2022] Hewlett Packard Enterprise Development LP
+# (C) Copyright 2022 Hewlett Packard Enterprise Development LP
 #
 # Permission is hereby granted, free of charge, to any person obtaining a
 # copy of this software and associated documentation files (the "Software"),
@@ -20,9 +20,7 @@
 # OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 # ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 # OTHER DEALINGS IN THE SOFTWARE.
-
-# Pyinstaller needs a .spec file but it conflicts with rpm builds
-cp pyinstaller.py pyinstaller.spec
-pyinstaller --clean -y --dist ./dist/linux --workpath /tmp pyinstaller.spec
-rm pyinstaller.spec
-chown -R --reference=. ./dist/linux
+#
+include README.md
+include LICENSE
+global-include *.yaml