squidient 1.2.2__tar.gz → 1.3.0__tar.gz

{squidient-1.2.2 → squidient-1.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: squidient
-Version: 1.2.2
+Version: 1.3.0
 Summary: CI/CD framework for alya
 Project-URL: Homepage, https://alya.gitlab.bsc.es/alya/ci-cd/squidient
 Project-URL: Bug Tracker, https://alya.gitlab.bsc.es/alya/ci-cd/squidient/issues

{squidient-1.2.2 → squidient-1.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "squidient"
-version = "1.2.2"
+version = "1.3.0"
 authors = [
   { name="Damien Dosimont", email="damien.dosimont@gmail.com" },
 ]
@@ -29,7 +29,7 @@ Homepage = "https://alya.gitlab.bsc.es/alya/ci-cd/squidient"
 
 [project.scripts]
 squidient = "squidient.cli:main"
-sqreport = "squidient.sqreport.squidientfilereport:main"
+sqreport = "squidient.sqreport.squidientcasereport:main"
 sqdetails = "squidient.sqreport.squidientdetailedreport:main"
 
 [tool.hatch.build.targets.wheel]

{squidient-1.2.2 → squidient-1.3.0}/src/squidient/data/web/files.html

@@ -36,7 +36,7 @@
         <th>Tolerance</th>
         <th>maxAbs</th>
         <th>maxRel</th>
-        <th>maxPower</th>
+        <th>minPower</th>
         <th>Differences</th>
         <th>Total</th>
         <th>Error</th>

squidient-1.3.0/src/squidient/sqreport/squidientbasereport.py

@@ -0,0 +1,198 @@
+#########################################################################
+#                                                                       #
+#  This file is part of squidient.                                      #
+#                                                                       #
+#  squidient is free software: you can redistribute it and/or modify    #
+#  it under the terms of the GNU General Public License as published by #
+#  the Free Software Foundation, either version 3 of the License, or    #
+#  (at your option) any later version.                                  #
+#                                                                       #
+#  squidient is distributed in the hope that it will be useful,         #
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of       #
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                 #
+#                                                                       #
+#########################################################################
+
+import os
+
+try:
+    from utils.compare import *
+except:
+    from ..utils.compare import *
+
+
+class SquidientBaseReport:
+
+    # _____________________________________
+    def __init__(self, case):
+
+        self._case = case
+        self._file = case + ".json"
+
+        self._json = None
+        self._test = {}
+
+        self._status = True
+        self._error = "OK"
+
+        self._cwd = os.getcwd()
+        self._base_dir = os.path.join("base", "1p")
+
+    # _____________________________________
+    def open_json(self):
+
+        self._json = open_json(self._file)
+
+    # _____________________________________
+    def init_test(self):
+        """
+        Implemented in subclasses.
+        """
+        raise NotImplementedError
+
+    # _____________________________________
+    def save_json(self):
+
+        save_json(self._test, "report.json")
+
+    # _____________________________________
+    def present_file(self, file_path):
+
+        return os.path.isfile(file_path)
+
+    # _____________________________________
+    def compare(self, base, test, method, tolerance, rows=None, cols=None):
+
+        c = Compare(base, test, method, tolerance, rows, cols)
+
+        return c.compare()
+
+    # _____________________________________
+    def update_error(self, status, error):
+
+        if status:
+            return
+
+        previous_error = self._error
+        self._status = False
+
+        if previous_error == "OK":
+            self._error = error
+            return
+
+        if previous_error == error:
+            return
+
+        if "tolerance" in previous_error:
+            self._error = error
+            return
+
+        if "tolerance" in error:
+            return
+
+        self._error = "mixed"
+
+    # _____________________________________
+    def _get_rows_cols_tolerance(self, file_cfg):
+
+        rows = file_cfg.get("rows")
+        cols = file_cfg.get("cols")
+        tolerance = file_cfg.get("tolerance", 0)
+
+        return rows, cols, tolerance
+
+    # _____________________________________
+    def _get_paths(self, file_cfg):
+
+        relative_path = file_cfg["file"]
+        base_path = os.path.join(self._base_dir, relative_path)
+        test_path = relative_path
+
+        return base_path, test_path
+
+    # _____________________________________
+    def _empty_file_test(self, file_cfg):
+
+        return {
+            "file": file_cfg["file"],
+            "status": True,
+            "error": "OK",
+            "maxAbs": 0,
+            "maxRel": 0,
+            "minPower": 0,
+            "differences": 0,
+            "total": 0,
+            "method": file_cfg["method"],
+            "tolerance": file_cfg.get("tolerance", 0),
+        }
+
+    # _____________________________________
+    def _apply_compare_result(self, test, result):
+
+        test["maxAbs"] = result["maxAbs"]
+        test["maxRel"] = result["maxRel"]
+        test["minPower"] = result["minPower"]
+        test["differences"] = result["differences"]
+        test["total"] = result["total"]
+        test["status"] = result["status"]
+        test["error"] = result["error"]
+        test["tolerance"] = result["tolerance"]
+
+        return test
+
+    # _____________________________________
+    def _validate_one_file(self, file_cfg):
+
+        test = self._empty_file_test(file_cfg)
+        rows, cols, tolerance = self._get_rows_cols_tolerance(file_cfg)
+        base_path, test_path = self._get_paths(file_cfg)
+
+        if not self.present_file(base_path):
+            test["status"] = False
+            test["error"] = "missing base"
+            return test
+
+        if not self.present_file(test_path):
+            test["status"] = False
+            test["error"] = "missing test file"
+            return test
+
+        try:
+            result = self.compare(
+                base_path,
+                test_path,
+                test["method"],
+                tolerance,
+                rows,
+                cols,
+            )
+        except Exception as e:
+            test["status"] = False
+            test["error"] = "comparison"
+            print(e)
+            return test
+
+        return self._apply_compare_result(test, result)
+
+    # _____________________________________
+    def validate_files(self):
+
+        for file_cfg in self._json.get("comparisons", []):
+
+            test = self._validate_one_file(file_cfg)
+
+            self.update_error(test["status"], test["error"])
+
+            self._test["files"].append(test)
+
+        self._test["status"] = self._status
+        self._test["error"] = self._error
+
+    # _____________________________________
+    def find_file_config(self, test_file):
+
+        for file_cfg in self._json.get("comparisons", []):
+            if file_cfg.get("file") == test_file:
+                return file_cfg
+
+        return None

squidient-1.3.0/src/squidient/sqreport/squidientcasereport.py

@@ -0,0 +1,135 @@
+#########################################################################
+#                                                                       #
+#  This file is part of squidient.                                      #
+#                                                                       #
+#  squidient is free software: you can redistribute it and/or modify    #
+#  it under the terms of the GNU General Public License as published by #
+#  the Free Software Foundation, either version 3 of the License, or    #
+#  (at your option) any later version.                                  #
+#                                                                       #
+#  squidient is distributed in the hope that it will be useful,         #
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of       #
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                 #
+#                                                                       #
+#########################################################################
+
+import sys
+
+try:
+    from squidientbasereport import SquidientBaseReport
+except:
+    from .squidientbasereport import SquidientBaseReport
+
+
+class SquidientCaseReport(SquidientBaseReport):
+
+    # _____________________________________
+    def __init__(self, case):
+
+        super().__init__(case)
+
+    # _____________________________________
+    def init_test(self):
+
+        self._test = {
+            "name": self._json["name"],
+            "files": [],
+            "hostname": "unknown",
+            "env": {},
+        }
+
+    # _____________________________________
+    def _stringify_status(self, value):
+
+        if isinstance(value, bool):
+            return "OK" if value else "FAIL"
+
+        return str(value)
+
+    # _____________________________________
+    def _build_table(self, title, headers, rows):
+
+        widths = []
+
+        for index, header in enumerate(headers):
+            column_values = [header] + [row[index] for row in rows]
+            widths.append(max(len(value) for value in column_values))
+
+        def sep():
+            return "+-" + "-+-".join("-" * width for width in widths) + "-+"
+
+        def fmt(row):
+            return "| " + " | ".join(
+                row[index].ljust(widths[index]) for index in range(len(headers))
+            ) + " |"
+
+        lines = [title, "=" * len(title), sep(), fmt(headers), sep()]
+
+        for row in rows:
+            lines.append(fmt(row))
+
+        lines.append(sep())
+
+        return "\n".join(lines)
+
+    # _____________________________________
+    def files_report_console(self):
+
+        headers = [
+            "file",
+            "method",
+            "tolerance",
+            "maxAbs",
+            "maxRel",
+            "minPower",
+            "differences",
+            "total",
+            "error",
+            "status",
+        ]
+
+        rows = []
+
+        for file_test in self._test.get("files", []):
+            rows.append([
+                str(file_test.get("file", "")),
+                str(file_test.get("method", "")),
+                str(file_test.get("tolerance", "")),
+                str(file_test.get("maxAbs", "")),
+                str(file_test.get("maxRel", "")),
+                str(file_test.get("minPower", "")),
+                str(file_test.get("differences", "")),
+                str(file_test.get("total", "")),
+                str(file_test.get("error", "")),
+                self._stringify_status(file_test.get("status", "")),
+            ])
+
+        return self._build_table(str(self._test.get("name", "?")), headers, rows)
+
+    # _____________________________________
+    def run(self):
+
+        self.open_json()
+        self.init_test()
+        self.validate_files()
+        self.save_json()
+
+        print(self.files_report_console())
+
+
+def main(argv=None):
+
+    if argv is None:
+        argv = sys.argv
+
+    if len(argv) < 2:
+        print("Usage: sqreport [case]")
+        return 1
+
+    report = SquidientCaseReport(argv[1])
+    report.run()
+    return 0
+
+
+if __name__ == '__main__':
+    raise SystemExit(main())

squidient-1.3.0/src/squidient/sqreport/squidientdetailedreport.py

@@ -0,0 +1,101 @@
+#########################################################################
+#                                                                       #
+#  This file is part of squidient.                                      #
+#                                                                       #
+#  squidient is free software: you can redistribute it and/or modify    #
+#  it under the terms of the GNU General Public License as published by #
+#  the Free Software Foundation, either version 3 of the License, or    #
+#  (at your option) any later version.                                  #
+#                                                                       #
+#  squidient is distributed in the hope that it will be useful,         #
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of       #
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                 #
+#                                                                       #
+#########################################################################
+
+
+import sys
+
+try:
+    from squidientcasereport import SquidientCaseReport
+except:
+    from .squidientcasereport import SquidientCaseReport
+
+try:
+    from utils.comparewithdifftable import print_diff_table_for_file
+except:
+    from ..utils.comparewithdifftable import print_diff_table_for_file
+
+
+class SquidientDetailedReport(SquidientCaseReport):
+
+    # _____________________________________
+    def __init__(self, case, test_file):
+
+        super().__init__(case)
+        self._test_file = test_file
+
+    # _____________________________________
+    def _find_file_config(self):
+
+        for file_cfg in self._json["comparisons"]:
+            if file_cfg["file"] == self._test_file:
+                return file_cfg
+
+        return None
+
+    # _____________________________________
+    def run(self):
+
+        self.open_json()
+
+        file_cfg = self._find_file_config()
+
+        if file_cfg is None:
+            print(f"[ERROR] File not found in comparisons: {self._test_file}")
+            exit(1)
+
+        method = file_cfg["method"]
+        tolerance = file_cfg.get("tolerance", 0)
+        rows = file_cfg.get("rows")
+        cols = file_cfg.get("cols")
+
+        base_path = self._base_dir + "/" + self._test_file
+        test_path = self._test_file
+
+        if not self.present_file(base_path):
+            print(f"[ERROR] Base file missing: {base_path}")
+            exit(1)
+
+        if not self.present_file(test_path):
+            print(f"[ERROR] Test file missing: {test_path}")
+            exit(1)
+
+        print(
+            print_diff_table_for_file(
+                base_path=base_path,
+                test_path=test_path,
+                method=method,
+                tolerance=tolerance,
+                rows=rows,
+                cols=cols,
+            )
+        )
+
+
+def main(argv=None):
+
+    if argv is None:
+        argv = sys.argv
+
+    if len(argv) < 3:
+        print("Usage: sqdetails [case] [file]")
+        return 1
+
+    report = SquidientDetailedReport(argv[1], argv[2])
+    report.run()
+    return 0
+
+
+if __name__ == '__main__':
+    raise SystemExit(main())

squidient-1.3.0/src/squidient/sqreport/squidientfullreport.py

@@ -0,0 +1,134 @@
+#########################################################################
+#                                                                       #
+#  This file is part of squidient.                                      #
+#                                                                       #
+#  squidient is free software: you can redistribute it and/or modify    #
+#  it under the terms of the GNU General Public License as published by #
+#  the Free Software Foundation, either version 3 of the License, or    #
+#  (at your option) any later version.                                  #
+#                                                                       #
+#  squidient is distributed in the hope that it will be useful,         #
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of       #
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                 #
+#                                                                       #
+#########################################################################
+
+import os
+import re
+import sys
+
+try:
+    from squidientcasereport import SquidientCaseReport
+except:
+    from .squidientcasereport import SquidientCaseReport
+
+try:
+    from utils.compare import command
+except:
+    from ..utils.compare import command
+
+
+class SquidientFullReport(SquidientCaseReport):
+
+    # _____________________________________
+    def __init__(self, case):
+
+        super().__init__(case)
+
+        self._mpi = 0
+        self._openmp = 0
+        self._build = "unknown"
+
+        self._init_execution_context()
+
+    # _____________________________________
+    def _init_execution_context(self):
+
+        cwd = os.getcwd()
+        current_dir = os.path.basename(cwd)
+        parent_dir = os.path.basename(os.path.dirname(cwd))
+
+        self._build = parent_dir or "unknown"
+
+        parts = current_dir.split("_")
+        if len(parts) >= 2:
+            try:
+                self._mpi = int(parts[0])
+                self._openmp = int(parts[1])
+            except ValueError:
+                self._mpi = 0
+                self._openmp = 0
+
+    # _____________________________________
+    def init_test(self):
+
+        self._test = {
+            "name": self._json["name"],
+            "mpi": self._mpi,
+            "openmp": self._openmp,
+            "build": self._build,
+            "files": [],
+            "hostname": "unknown",
+            "env": {},
+        }
+
+    # _____________________________________
+    def env(self):
+
+        env = command('printenv', output=True)
+        env = re.sub("\\{.*?^\\}", "", env, flags=re.DOTALL | re.MULTILINE)
+        env = env.split("\n")
+        env_dict = {}
+        for i in env:
+            try:
+                d = i.split('=', 1)
+                env_dict[d[0]] = d[1]
+            except:
+                continue
+
+        self._test["env"] = env_dict
+        self._test["hostname"] = env_dict.get("HOSTNAME", "unknown")
+
+    # _____________________________________
+    def validate_execution(self):
+
+        self._status = bool(
+            command('grep "\\-\\-| ALYA  CALCULATIONS CORRECT" alya.out')
+        )
+
+        self._error = "OK" if self._status else "execution"
+
+        self._test["status"] = self._status
+        self._test["error"] = self._error
+
+        return self._status
+
+    # _____________________________________
+    def run(self):
+
+        self.open_json()
+        self.init_test()
+        self.env()
+
+        if self.validate_execution():
+            self.validate_files()
+
+        self.save_json()
+
+
+def main(argv=None):
+
+    if argv is None:
+        argv = sys.argv
+
+    if len(argv) < 2:
+        print("Usage: sqvalidate [case]")
+        return 1
+
+    report = SquidientFullReport(argv[1])
+    report.run()
+    return 0
+
+
+if __name__ == '__main__':
+    raise SystemExit(main())