versioning: add utilities for versioning

src/versioning.py

+## This file is part of the simulative evaluation for the qronos observer abstractions.
+## Copyright (C) 2022-2023  Tim Rheinfels  <tim.rheinfels@fau.de>
+## See https://gitlab.cs.fau.de/qronos-state-abstractions/simulation
+##
+## Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+##
+## 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+##
+## 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+##
+## 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+##
+## THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+###
+###  @file  versioning.py
+###
+###  @brief  Provides functionality for versioning
+###
+###  @author  Tim Rheinfels  <tim.rheinfels@fau.de>
+###
+
+import copy
+from datetime import datetime
+import logging
+import os
+import pickle
+import subprocess
+import sys
+
+###
+###  @brief  Queries the current datetime in the version.h format
+###
+###  @returns  Current date and time in the version.h format
+###
+def get_date_time():
+    return datetime.now().strftime('%Y-%m-%d  %H:%M:%S')
+
+###
+###  @brief  Queries the git revision
+###
+###  @returns  Either
+###      - Tuple containing
+###        - git revision of the current head
+###        - and dirty flag
+###      - or None if getting git revision failed
+###
+def get_git_revision():
+    proc = subprocess.run(
+        ['git', 'describe', '--always', '--abbrev=40', '--dirty'],
+        capture_output = True,
+    )
+
+    if proc.returncode != 0: #pragma: no cover
+        return 'N/A', True
+
+    commit = proc.stdout.decode('UTF-8').strip()
+    dirty = commit.endswith('-dirty')
+
+    return commit, dirty