Merge pull request #3 from ISISComputingGroup/Ticket8399_Refactor_of_hotfix_status_checker

Ticket8399_refactor_of_hotfix_status_checker

Author: rerpha

.env.example

@@ -0,0 +1,12 @@
+REPO_DIR=C:\\Instrument\\Apps\\EPICS\\
+UPSTREAM_BRANCH_CONFIG=epics
+
+WORKSPACE=temporary_workspace
+
+SSH_CREDENTIALS_USR=username
+SSH_CREDENTIALS_PSW=password
+
+USE_TEST_INSTRUMENT_LIST=false
+TEST_INSTRUMENT_LIST=NDXSCIDEMO
+
+DEBUG_MODE=false

.gitignore

@@ -0,0 +1,169 @@
+
+/temporary_workspace 
+
+# files to be ignored from this particular project
+.ruff_cache
+
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

Jenkinsfile

@@ -17,6 +17,9 @@ pipeline {
         TEST_INSTRUMENT_LIST = "${TEST_INSTRUMENT_LIST}"
         USE_TEST_INSTRUMENT_LIST = "${USE_TEST_INSTRUMENT_LIST}"
         DEBUG_MODE = "${DEBUG_MODE}"
+        REPO_DIR = "C:\\Instrument\\Apps\\EPICS\\"
+        UPSTREAM_BRANCH_CONFIG = "epics"
+        SHOW_UNCOMMITTED_CHANGES_MESSAGES="false"
     }
 
     stages {
@@ -35,7 +38,7 @@ pipeline {
                 echo 'Check Instrument has any Hotfixes and then any uncommitteed changes'
                 timeout(time: 1, unit: 'HOURS') {
                     bat '''
-                        call hotfix_checker.bat
+                        call utils/jenkins_utils/hotfix_checker.bat
                     '''
                 }
             }

README.md

@@ -1,3 +1,27 @@
 # HotfixStatusChecker Jenkins Pipeline
-This is a Jenkins pipeline to check the status of the EPICS repositories on instrument machines.
-It fails when there are uncommitted changes or an instrument is unreachable either via branch or hotfix.
+This program is designed to check the status of repositories on instrument machines, controlled by environment variables. It identifies issues such as uncommitted changes, local commits not present on the upstream branch, and vice versa, as well as instrument inaccessibility.
+
+## Usage
+To use this program, you can create a Jenkinsfile for the repository you want to check, set the appropriate environment variables, and create a pipeline for this on the Jenkins dashboard. Additionally, the program can be run locally using a local .env file. If running locally or on the machine executing the Jenkins check, remember to run pip install -r requirements.txt. Include this installation in the Jenkinsfile or any .bat files as necessary.
+
+## Important Notes
+- Set workspace to temporary dir when running locally.
+- Environment Variables: Ensure all required environment variables are correctly set.
+- Install Dependencies: Run pip install -r requirements.txt on both the local machine and the Jenkins machine.
+- You can run just on a set few inst machines using test env vars.
+
+## Example Usage
+1. Jenkins Integration:
+- Create a Jenkinsfile for the repository you want to check.
+- Set the appropriate environment variables.
+- Create a pipeline on the Jenkins dashboard using the Jenkinsfile.
+2. Local Execution:
+- Use a local .env file to set environment variables.
+- In an EPICS terminal run %PYTHON3% pip install -r requirements.txt to install dependencies.
+- Run %PYTHON3% hotfix_checker.py.
+ 
+## Purpose
+1. Check EPICS Directory:
+Focuses on detecting commits and/or uncommitted changes that could indicate a HOTFIX.
+2. Check Config Common Directory:
+Focuses on detecting commits and/or uncommitted changes that may have been made by scientists or others.

__init__.py

@@ -4,4 +4,4 @@ if exist "C:\HotfixStatusChecker\Python3" rd /s /q C:\HotfixStatusChecker\Python
 call %LATEST_PYTHON_DIR%..\genie_python_install.bat C:\HotfixStatusChecker\Python3
 
 set "LATEST_PYTHON3=C:\HotfixStatusChecker\Python3\python3.exe"
-%LATEST_PYTHON3% -m pip install python-ssh
+%LATEST_PYTHON3% -m pip install -r requirements.txt