socx-cli 0.1.0__py3-none-any.whl

src/socx/regression/regression.py

@@ -0,0 +1,129 @@
+from __future__ import annotations
+
+from typing import TextIO
+from pathlib import Path
+from subprocess import Popen
+from dataclasses import dataclass
+
+from dynaconf.utils.boxing import DynaBox
+
+# from .. import visitor
+from ..config import settings
+from .test import Test
+
+
+__all__ = ("Status", "Regression")
+
+
+from .test import Status as Status
+
+
+@dataclass(init=False)
+class Regression:
+    uid: int
+    name: str
+    log: Path
+    tests: list[Test]
+    status: list[Status]
+    options: DynaBox
+    test_logs: list[Path]
+
+    def start(self) -> None:
+        """Start a test in a subprocess."""
+        pass
+
+    def stop(self) -> None:
+        """Send a keyboard interrupt (SIGINT) to stop a running test."""
+        pass
+
+    def pause(self) -> None:
+        """Pause the process if it is running."""
+        pass
+
+    def resume(self) -> None:
+        """Resume the process if it is paused."""
+        pass
+
+    def wait(self, timeout: float | None = None) -> None:
+        """Wait for a test to terminate if it is running."""
+        pass
+
+    def kill(self) -> None:
+        """See `subprocess.Popen.kill`."""
+        pass
+
+    def export(self, fmt: str = "csv") -> None:
+        """Export regression sessions to the specified format `fmt`."""
+        pass
+
+    def terminate(self) -> None:
+        """See `subprocess.Popen.terminate`."""
+        pass
+
+    @property
+    def log(self) -> Path:
+        pass
+
+    @property
+    def options(self) -> DynaBox:
+        return settings.regression
+
+    @property
+    def process(self) -> Popen | None:
+        """The active process of the running test or None if not running."""
+        pass
+
+    @property
+    def stdin(self) -> TextIO | None:
+        """The standard input of the test's process or None if not running."""
+        pass
+
+    @property
+    def stdout(self) -> TextIO | None:
+        """The standard output of the test's process or None if not running."""
+        pass
+
+    @property
+    def stderr(self) -> TextIO | None:
+        """The standard error of the test's process or None if not running."""
+        pass
+
+    @property
+    def status(self) -> Status:
+        """A `TestStatus` representing the state/status of the test."""
+        pass
+
+    @property
+    def test_logs(self) -> dict[str, Path]:
+        """Return a mapping between test names and their log paths."""
+        pass
+
+    @property
+    def idle(self) -> bool:
+        """True if test has no active process and has not yet started."""
+        pass
+
+    @property
+    def passed(self) -> bool:
+        """True if test has finished running and no errors occured."""
+        pass
+
+    @property
+    def failed(self) -> bool:
+        """True if test finished running and at least one error occured."""
+        pass
+
+    @property
+    def running(self) -> bool:
+        """True if test is currently running in a dedicated process."""
+        pass
+
+    @property
+    def finished(self) -> bool:
+        """True if test finished running without normally interruption."""
+        pass
+
+    @property
+    def returncode(self) -> int | None:
+        """The return code from the test process or None if running or idle."""
+        pass

src/socx/regression/test.py

@@ -0,0 +1,244 @@
+from __future__ import annotations
+
+import signal
+from contextlib import suppress
+from typing import TextIO
+from enum import auto
+from enum import IntEnum
+from subprocess import Popen
+from subprocess import PIPE
+from dataclasses import field
+from dataclasses import dataclass
+
+
+class Status(IntEnum):
+    """
+    Status representation of a test process as an `IntEnum`.
+
+    Members
+    -------
+    Idle: IntEnum
+        Idle state, awaiting to be started.
+
+    Running: IntEnum
+        Test is currently running on a seperate process.
+
+    Passed: IntEnum
+        Test has ended with no errors and a clean exit code.
+
+    Failed: IntEnum
+        Test had failed due to an error or an invalid exit code.
+
+    Killed: IntEnum
+        Test was intentionally killed by a signal.
+    """
+
+    Idle = auto(0)
+    Running = auto()
+    Passed = auto()
+    Failed = auto()
+    Killed = auto()
+
+
+@dataclass
+class Command:
+    """
+    Representation of a 'run test' command-line as an object.
+
+    Members
+    -------
+    line: str
+        Full commandline string of the command represented by this object.
+
+    name: str
+        Name of the command represented by this object, i.e. sys.argv[0].
+
+    args: list[str]
+        Arguments of the command represented by this object split by
+        whitespace.
+    """
+
+    name: str = field(init=False)
+    args: list[str] = field(init=False)
+    line: str
+
+    def __getattr__(self, attr: str) -> str:
+        v = self.extract_argv(f"--{attr}")
+        if v:
+            return v
+        else:
+            raise AttributeError
+
+    def extract_argv(self, arg: str) -> str:
+        with suppress(ValueError):
+            index = self.args.index(f"{arg}")
+            return self.args[index + 1] if index + 1 < len(self.args) else ""
+        return ""
+
+    def __post_init__(self) -> None:
+        self.line = self.line.strip()
+        self.args = [arg.strip() for arg in self.line.split()]
+        self.name = self.args[0] if self.args else ""
+
+    def __hash__(self) -> int:
+        return hash(self.line)
+
+
+@dataclass(init=False)
+class Test:
+    """Representation of a test as a python object."""
+
+    name: str
+    flow: str
+    seed: int
+    status: Status
+    command: Command
+    process: Popen | None
+
+    def __init__(self, command: str | Command) -> None:
+        self._proc = None
+        self._command = (
+            command
+            if isinstance(command, Command)
+            else Command(command)
+        )
+
+    @property
+    def pid(self) -> int | None:
+        """Process id of the test's active process or None if inactive."""
+        return self.process.pid if self.process else None
+
+    @property
+    def name(self) -> str:
+        """The test name or empty string if command does not specify a test."""
+        test = self.command.test
+        if "/" in test:
+            test = test.partition("/")[-1]
+        return test
+
+    @property
+    def flow(self):
+        """The flow specified in the test command."""
+        return self.command.flow
+
+    @property
+    def seed(self):
+        """The test seed."""
+        with suppress(AttributeError):
+            rv = int(self.command.seed)
+            return rv
+        return 0
+
+    def start(self) -> None:
+        """Start a test in a subprocess."""
+        if self.idle:
+            self._proc = Popen(
+                args=self.command.args,
+                text=True,
+                stdout=PIPE,
+                stderr=PIPE,
+                shell=True,
+            )
+        else:
+            err = "Test is already running."
+            raise OSError(err)
+
+    def stop(self) -> None:
+        """Send a keyboard interrupt (SIGINT) to stop a running test."""
+        if self.running:
+            self.process.send_signal(signal.SIGINT)
+
+    def pause(self) -> None:
+        """Pause the process if it is running."""
+        if self.running:
+            self.process.send_signal(signal.SIGSTOP)
+
+    def resume(self) -> None:
+        """Resume the process if it is paused."""
+        if self.running:
+            self.process.send_signal(signal.SIGCONT)
+
+    def wait(self, timeout: float | None = None) -> None:
+        """Wait for a test to terminate if it is running."""
+        if self.running:
+            self.process.wait()
+
+    def kill(self) -> None:
+        """See `subprocess.Popen.kill`."""
+        if self.running:
+            self.process.kill()
+
+    def terminate(self) -> None:
+        """See `subprocess.Popen.terminate`."""
+        if self.running:
+            self.process.terminate()
+
+    @property
+    def process(self) -> Popen | None:
+        """The active process of the running test or None if not running."""
+        return self._proc
+
+    @property
+    def stdin(self) -> TextIO | None:
+        """The standard input of the test's process or None if not running."""
+        return self.process.stdin if self.process else None
+
+    @property
+    def stdout(self) -> TextIO | None:
+        """The standard output of the test's process or None if not running."""
+        return self.process.stdout if self.process else None
+
+    @property
+    def stderr(self) -> TextIO | None:
+        """The standard error of the test's process or None if not running."""
+        return self.process.stderr if self.process else None
+
+    @property
+    def status(self) -> Status:
+        """A `TestStatus` representing the state/status of the test."""
+        return self._status()
+
+    @property
+    def command(self) -> Command:
+        """A `TestCommand` represeinting the test's command line invocation."""
+        return self._command
+
+    @property
+    def returncode(self) -> int | None:
+        """The return code from the test process or None if running or idle."""
+        return self.process.returncode if self.finished else None
+
+    @property
+    def idle(self) -> bool:
+        """True if test has no active process and has not yet started."""
+        return self.status is Status.Idle
+
+    @property
+    def passed(self) -> bool:
+        """True if test has finished running and no errors occured."""
+        return not self.finished and self.status is Status.Passed
+
+    @property
+    def failed(self) -> bool:
+        """True if test finished running and at least one error occured."""
+        return self.finished and self.status is Status.Failed
+
+    @property
+    def running(self) -> bool:
+        """True if test is currently running in a dedicated process."""
+        return self.process is not None and self.process.poll() is None
+
+    @property
+    def finished(self) -> bool:
+        """True if test finished running without normally interruption."""
+        return self.process is not None and self.process.poll() is not None
+
+    def _status(self) -> Status:
+        if self.process is None:
+            return Status.Idle
+        elif self.stdout.strip().startswith("PPPP"):
+            return Status.Passed
+        elif self.stdout.strip().startswith("FFFF"):
+            return Status.Running
+        else:
+            return Status.Failed

src/socx/static/toml/convert.local.toml

@@ -0,0 +1,2 @@
+# convert__lst__source = "@path @format {env[TOP_VERIF]}/assets/inputs"
+convert__lst__target = "@path @format {env[TOP_VERIF]}/scripts/socx/assets/lst/outputs"

src/socx/static/toml/converter.toml

@@ -0,0 +1,119 @@
+[convert]
+
+
+[convert.lst]
+
+# Argument: type
+#
+# Typename of the convert class for performing the conversion.
+#
+type = "LstParser"
+
+# Argument: source
+#
+# source directory from which names and patterns defined in include will 
+# be searched.
+#
+source = """
+@path @format {env[WAREA]}/Pixie_ROM_FW/PixieROMApp/TapeOutRelease/PIXIE_E4/PxieParserOut
+"""
+
+# Argument: target
+#
+# target directory to which generated outputs will be written.
+#
+target = """
+@path @format {env[TOP_VERIF]}/scripts/socx/assets/lst/outputs
+"""
+
+# Argument: base_addr_map
+#
+# Name of the json adress map file of ROM base addresses.
+#
+base_addr_map = "memLd.json"
+
+# Argument: base_addr_base
+#
+# The address value's numeric base (hex/octal/decimal/etc.)
+#
+base_addr_base = 16
+
+# Argument: include
+#
+# Specifies file names to include in the convert's list of sources to 
+# convert.
+#
+# Values can either be an exact filename, a glob pattern, or a 
+# combination of both.
+#
+includes = [ "*.lst", "SPUList.list" ]
+
+# Argument: exclude
+#
+# Same as include, but excludes files from the list of sources.
+#
+excludes = []
+
+# Argument: mappings
+#
+# Mappings between source file names to target file names.
+#
+# Both source and target can either be an exact file name or a 
+# 'match' pattern specified by the character %.
+#
+# A match pattern will simply match the missing part of the target's name with 
+# the matching missing part in the source name.
+#
+mappings = [
+    {input="%.lst", output="%.svh"},
+    {input="%.list", output="%.sv"},
+    {input="hwsList.lst", output="pixie_hws_cgs.svh"},
+]
+
+# -----------------------------------------------------------------------------
+# Path Options
+# -----------------------------------------------------------------------------
+#
+[convert.lst.options]
+
+# Option: collision
+#
+# How name collisions should be handled. In other words, what should the 
+# convert do when an older version of the output file already exists 
+# in the target directory.
+#
+# Options
+# -------
+#   skip:
+#       filename collisions will be skipped, and the original file is 
+#       kept.
+#
+#   backup:
+#       same as overwrite, but creates a copy of the original file with 
+#       with a '.backup.<timestamp>' file where <timestamp> is replaced 
+#       with the date and time of when the back up was created.
+#
+#   overwrite:
+#       filename collisions are handled by overwriting any existing file 
+#       with the new one upon name collision.
+#
+collision = "overwrite"
+
+
+# -------------------------------------------------
+# Uncomment below to add another path configuration
+# -------------------------------------------------
+#
+# [[convert]]
+# source = """
+# """
+# target = """
+# """
+# include = []
+# exclude = []
+# mappings = [{}]
+#
+# [convert.options]
+#      
+#      ...
+#

src/socx/static/toml/filetypes.toml

@@ -0,0 +1,104 @@
+[lang]
+
+# -----------------------------------------------------------------------------
+# Category: Filetype
+# -----------------------------------------------------------------------------
+#
+# An array of language element tables where each table specifies a small
+# subset of language features.
+# 
+# Each language is identified by name, and is linked by the configured set of 
+# possible filetype extensions.
+#
+[lang.systemverilog]
+name = "systemverilog"
+extensions = [".sv", ".svh"]
+
+
+# -----------------------------------------------------------------------------
+# Group: Syntax
+# -----------------------------------------------------------------------------
+#
+# Provides example definitions of various lexical language options 
+# supported through configuration.
+#
+[lang.systemverilog.syntax]
+
+# Option: filetype.indent
+#
+# 4 or 2, these are your options.
+#
+# It has to be a multiple of 2. always has been. enough with the 3 
+# spaces madness.
+#
+# 3 doesnt even make any sense! "meh.. but UVM is so big and it also uses 3 
+# spaces and i read online tha.." NOOOOO! Shut up! I dont care! 
+#
+# 4 or 2! thse are your only options! from now on the mad 3 people get 
+# an angry Exception with a recommendation to see a psychologist.
+#
+indent = 4
+
+
+[lang.systemverilog.syntax.comments]
+
+# Option: filetype.syntax.comments.line
+#
+# Line comment tokens
+#
+line = "//"
+
+# Option: filetype.syntax.comments.block
+#
+# Block comment token specification.
+#
+# Attributes
+# ----------
+#   begin:
+#       The token that starts the block comment.
+#
+#   end:
+#       The token that ends the block comment.
+#
+block = {begin="/*", end="*/"}
+
+
+[lang.lst]
+name = "lst"
+extensions = [".lst", ".list"]
+
+
+[[lang.lst.tokens]]
+name = 'comment'
+expr = '([#])(?!([A-Z]{2,}))(?P<content>.*)'
+subst = '''@format {this.lang.systemverilog.syntax.comments.line} \g<content>
+'''
+starts_scope = false
+
+
+[[lang.lst.tokens]]
+name = 'group'
+expr = '([#])(?P<mem>NVM|ROM)(\W+)(?P<device>[A-Z]{2,})'
+subst = '''
+covergroup cg__\g<device>_\g<mem>_access;
+
+    cp__\g<device>_\g<mem>_func: coverpoint { vif.\g<device>_\g<mem>_addr }
+    {
+'''
+starts_scope = true
+scope_ender = '''
+        bins NoFunc = default; 
+    }
+endgroup: cg__\g<device>_\g<mem>_access
+
+'''
+
+
+[[lang.lst.tokens]]
+name = 'statement'
+expr='0x(?P<addr>[0-9a-fA-F]+)\W+(?P<func>\w+)\W+(?P<len>\d+)(?P<other>.*)'
+subst = '''
+        bins \g<func> = { [ (('h\g<addr> - 'h{{ base }}) >> 1) : ((('h\g<addr> - 'h{{base}} + 'd\g<len>) >> 1) - 1) ] };
+'''
+starts_scope = false
+

src/socx/static/toml/plugins.toml

@@ -0,0 +1,5 @@
+[plugins]
+rgr = "@path @format src/plugins/rgr.py"
+config = "@path @format src/plugins/config.py"
+example = "@path @format src/plugins/example.py"
+convert = "@path @format src/plugins/convert/lst.py"

src/socx/static/toml/regression.toml

@@ -0,0 +1,47 @@
+[regression]
+root = "@path @format /space/users/ci_wiliot/vw_e0_nightly_regression/regressions"
+
+[regression.user.options]
+test_timeout = 7200
+max_runs_in_parallel = 10
+
+[regression.user.options.logs]
+path = "@format {env[RAREA]}/regressions"
+enabled = true
+
+[regression.logs]
+path = "@path @format {this.regression.root}/logs"
+prev = "@path @format {this.regression.logs.path}/prev"
+latest = "@path @format {this.regression.logs.path}/latest"
+
+[regression.nightly]
+path = "@path @format {this.regression.root}/nightly"
+
+[regression.files.socrgr_db]
+name = "socRgrDB.pyclass"
+parent = "@path @format {this.regression.nightly}"
+
+[regression.files.rerun_cfg]
+name = "rerun_list.cfg"
+parent = "@path @format {this.regression.logs.latest}"
+
+[regression.files.test_summary]
+name =  "regression_summary.log"
+parent = "@path @format {this.regression.logs.latest}"
+columns = [
+    {name="test_name", index=0, type="path"},
+    {name="Iter_num", index=1, type="int"},
+    {name="testStaus", index=2, type="str"},
+    {name="NumErrors", index=3, type="int"},
+    {name="SimTime[ns]", index=4, type="time"},
+    {name="seed", index=5, type="int"},
+]
+
+[regression.files.error_summary]
+name = "errors_summary.log"
+parent = "@path @format {this.regression.logs.latest}"
+
+[regression.files.failure_history]
+name = "failed_tests_history.log"
+parent = "@path @format {this.regression.logs.latest}"
+

src/socx/static/toml/settings.toml

@@ -0,0 +1,6 @@
+dynaconf_include = [
+    "plugins.toml",
+    "filetypes.toml",
+    "converter.toml",
+    "regression.toml",
+]

src/socx/static/toml/test.toml

@@ -0,0 +1,9 @@
+[test]
+key = ''
+index = ''
+
+[[tests]]
+name = ''
+seed = ''
+time = {start = '', stop = ''}
+status = ''