fm-weck 1.3.0__py3-none-any.whl → 1.4.1__py3-none-any.whl

fm_weck/__init__.py

@@ -8,4 +8,4 @@
 from .config import Config  # noqa: F401
 from .image_mgr import ImageMgr  # noqa: F401
 
-__version__ = "1.3.0"
+__version__ = "1.4.1"

fm_weck/cli.py

@@ -14,15 +14,29 @@ from functools import cache
 from pathlib import Path
 from typing import Any, Callable, Optional, Tuple, Union
 
-from fm_tools.benchexec_helper import DataModel
+try:
+    from fm_tools.benchexec_helper import DataModel
+except ImportError:
+    from enum import Enum
+
+    class DataModel(Enum):
+        """
+        Enum representing the data model of the tool.
+        """
+
+        LP64 = "LP64"
+        ILP32 = "ILP32"
+
+        def __str__(self):
+            return self.value
+
 
 from fm_weck import Config
 from fm_weck.config import _SEARCH_ORDER
 from fm_weck.resources import iter_fm_data, iter_properties
 
 from . import __version__
-from .engine import Engine, NoImageError
-from .serve import run_guided, run_manual, run_runexec, setup_fm_tool
+from .exceptions import NoImageError
 
 logger = logging.getLogger(__name__)
 
@@ -84,12 +98,22 @@ def parse(raw_args: list[str]) -> Tuple[Callable[[], None], Namespace]:
         default=None,
     )
 
+    loglevels_lower = ["debug", "info", "warning", "error", "critical"]
+    loglevels = loglevels_lower + [level.upper() for level in loglevels_lower]
     parser.add_argument(
         "--loglevel",
-        choices=["debug", "info", "warning", "error", "critical"],
+        choices=loglevels,
+        metavar="LEVEL",
+        action="store",
+        default=None,
+        help="Set the log level. Valid values are: " + ", ".join(loglevels_lower),
+    )
+
+    parser.add_argument(
+        "--logfile",
         action="store",
+        help="Path to the log file.",
         default=None,
-        help="Set the log level.",
     )
 
     parser.add_argument(
@@ -181,7 +205,11 @@ def parse(raw_args: list[str]) -> Tuple[Callable[[], None], Namespace]:
     add_tool_arg(install, nargs="+")
     install.set_defaults(main=main_install)
 
-    runexec = subparsers.add_parser("runexec", help="Run runexec on a command inside a container.")
+    runexec = subparsers.add_parser(
+        "runexec",
+        help="Run runexec on a command inside a container.",
+        allow_abbrev=False,
+    )
     runexec.add_argument(
         "--image",
         dest="use_image",
@@ -204,6 +232,16 @@ def parse(raw_args: list[str]) -> Tuple[Callable[[], None], Namespace]:
         default=None,
     )
 
+    # Arguments passed though to the container manager (i.e., docker or podman)
+    runexec.add_argument(
+        "--container-long-opt",
+        dest="container_long_opts",
+        help="Arguments passed as long options (prepending --) directly to the container manager "
+        "(e.g., docker or podman). Each usage passes additional arguments to the container manager.",
+        action="append",
+        nargs="+",
+    )
+
     runexec.add_argument("argument_list", metavar="args", nargs="*", help="Arguments for runexec.")
     runexec.set_defaults(main=main_runexec)
 
@@ -264,14 +302,19 @@ def resolve_property(prop_name: str) -> Path:
     return property_choice_map()[prop_name]
 
 
-def set_log_level(loglevel: Optional[str], config: dict[str, Any]):
+def set_log_options(loglevel: Optional[str], logfile: Optional[str], config: dict[str, Any]):
     level = "WARNING"
     level = loglevel.upper() if loglevel else config.get("logging", {}).get("level", level)
-    logging.basicConfig(level=level)
+    if logfile:
+        logging.basicConfig(level=level, filename=logfile)
+    else:
+        logging.basicConfig(level=level)
     logging.getLogger("httpcore").setLevel("WARNING")
 
 
 def main_run(args: argparse.Namespace):
+    from .serve import run_guided
+
     if not args.TOOL:
         logger.error("No fm-tool given. Aborting...")
         return 1
@@ -300,15 +343,20 @@ def main_run(args: argparse.Namespace):
 
 
 def main_runexec(args: argparse.Namespace):
+    from .runexec_mode import run_runexec
+
     run_runexec(
         benchexec_package=args.benchexec_package,
         use_image=args.use_image,
         configuration=Config(),
+        extra_container_args=args.container_long_opts or [],
         command=args.argument_list,
     )
 
 
 def main_manual(args: argparse.Namespace):
+    from .serve import run_manual
+
     if not args.TOOL:
         logger.error("No fm-tool given. Aborting...")
         return 1
@@ -328,6 +376,8 @@ def main_manual(args: argparse.Namespace):
 
 
 def main_install(args: argparse.Namespace):
+    from .serve import setup_fm_tool
+
     for tool in args.TOOL:
         try:
             fm_data = resolve_tool(tool)
@@ -343,6 +393,8 @@ def main_install(args: argparse.Namespace):
 
 
 def main_shell(args: argparse.Namespace):
+    from .engine import Engine
+
     if not args.TOOL:
         engine = Engine.from_config(Config())
     else:
@@ -378,7 +430,7 @@ Please specify an image in the fm-tool yml file or add a configuration.
 
 To add a configuration you can do the following (on POSIX Terminals):
 
-printf '[defaults]\\nimage = "<your_image>"' > .weck
+printf '[defaults]\\nimage = "<your_image>"' > .fm-weck
 
 Replace <your_image> with the image you want to use.
         """
@@ -393,7 +445,7 @@ To specify an image add
 [defaults]
 image = "your_image"
 
-to your .weck file.
+to your .fm-weck file.
     """
 
     logger.error(text, tool, config)
@@ -402,7 +454,7 @@ to your .weck file.
 def cli(raw_args: list[str]):
     help_callback, args = parse(raw_args)
     configuration = Config().load(args.config)
-    set_log_level(args.loglevel, configuration)
+    set_log_options(args.loglevel, args.logfile, configuration)
     if args.dry_run:
         Config().set_dry_run(True)
 

fm_weck/config.py

@@ -5,6 +5,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+import importlib.resources as pkg_resources
 import logging
 import os
 import shutil
@@ -14,8 +15,20 @@ from functools import cache
 from pathlib import Path
 from typing import Any, Callable, Iterable, Optional, Tuple, TypeVar
 
-import yaml
-from fm_tools.fmdata import FmData
+try:
+    from fm_tools.fmdata import FmData
+except ImportError:
+
+    class FmData:
+        def __init__(self, data, version):
+            raise ImportError("fm_tools is not imported.")
+
+        def get_actor_name(self):
+            raise ImportError("fm_tools is not imported.")
+
+        def get_version(self):
+            raise ImportError("fm_tools is not imported.")
+
 
 from fm_weck.resources import RUN_WITH_OVERLAY, RUNEXEC_SCRIPT
 
@@ -167,21 +180,30 @@ class Config(object):
         return not (sys.platform.startswith("linux") or sys.platform == "darwin")
 
     def make_runexec_script_available(self) -> Path:
-        return self.make_script_available(RUNEXEC_SCRIPT, "runexec")
+        return self.make_script_available(RUNEXEC_SCRIPT)
 
-    def make_script_available(self, source: Path = RUN_WITH_OVERLAY, target_name: str = "run_with_overlay.sh") -> Path:
+    def make_script_available(self, target_name: str = RUN_WITH_OVERLAY) -> Path:
         script_dir = self.cache_location / ".scripts"
         target = script_dir / target_name
+
         if not (target.exists() and target.is_file()):
             script_dir.mkdir(parents=True, exist_ok=True)
-            shutil.copy(source, target)
+
+            # Try to copy from package resources
+            try:
+                with pkg_resources.path("fm_weck.resources", target_name) as source_path:
+                    shutil.copy(source_path, target)
+            except FileNotFoundError:
+                logging.error(f"Resource {target_name} not found in package.")
+                return None
         else:
-            # Compare if the RUN_WITH_OVERLAY script is newer than the existing one
-            if source.stat().st_mtime > target.stat().st_mtime:
-                shutil.copy(source, target)
-            else:
-                logging.debug("Using existing run_with_overlay.sh script")
-                return target
+            # Compare modification time if the file exists
+            with pkg_resources.path("fm_weck.resources", target_name) as source_path:
+                if source_path.stat().st_mtime > target.stat().st_mtime:
+                    shutil.copy(source_path, target)
+                else:
+                    logging.debug(f"Using existing {target_name} script")
+                    return target
 
         if Config._system_is_not_posix():
             return target
@@ -195,13 +217,16 @@ class Config(object):
         except OSError as e:
             logging.error(
                 f"Failed to set executable bit: {e}. "
-                "In some cases this can lead to permission errors when "
-                "running the script inside of the container."
+                "This may lead to permission errors when running the script in the container."
             )
 
+        return target
+
 
 @cache
 def parse_fm_data(fm_data: Path, version: Optional[str]) -> FmData:
+    import yaml
+
     if not fm_data.exists() or not fm_data.is_file():
         raise FileNotFoundError(f"fm data file {fm_data} does not exist")
 

fm_weck/engine.py

@@ -7,6 +7,7 @@
 
 import logging
 import shutil
+import signal
 import subprocess
 from abc import ABC, abstractmethod
 from functools import cached_property, singledispatchmethod
@@ -14,7 +15,17 @@ from pathlib import Path
 from tempfile import mkdtemp
 from typing import List, Optional, Union
 
-from fm_tools.fmdata import FmData, FmImageConfig
+try:
+    from fm_tools.fmdata import FmData, FmImageConfig
+except ImportError:
+    # Mock the FmData and FmImageConfig class for type checking
+    class FmData:
+        def get_images(self):
+            pass
+
+    class FmImageConfig:
+        pass
+
 
 from fm_weck.config import Config, parse_fm_data
 from fm_weck.exceptions import NoImageError
@@ -66,6 +77,24 @@ class Engine(ABC):
             f"{source}:{target}",
         ]
 
+    def add_container_long_opt(self, arg: list[str]):
+        """
+        Add a long option to the container command.
+        If the first element of the list does not start with "--", it will be prepended.
+        Example:
+        add_container_long_opt(["--option", "value"]) -> --option value
+        add_container_long_opt(["option", "value"]) -> --option value
+        """
+
+        if not arg:
+            raise ValueError("Argument must not be empty.")
+
+        base = arg[0]
+        if not base.startswith("--"):
+            base = f"--{base}"
+
+        self.extra_args["container_args"] = self.extra_args.get("container_args", []) + [base] + arg[1:]
+
     @abstractmethod
     def benchexec_capabilities(self):
         raise NotImplementedError
@@ -261,15 +290,27 @@ class Engine(ABC):
             return tag
 
     def _run_process(self, command: tuple[str, ...] | list[str]):
+        process = None  # To make sure process is defined if a signal is caught early
+
+        def terminate_process_group(signal_received, frame):
+            if process:
+                logging.info("Received signal %s. Terminating container process.", signal_received)
+                process.send_signal(signal.SIGTERM)
+
+        # Register signal handler
+        signal.signal(signal.SIGINT, terminate_process_group)
+        signal.signal(signal.SIGTERM, terminate_process_group)
+
+        logger.debug("\n\nRunning command:\n%s\n\n", " ".join(map(str, command)))
         if self.log_file is None:
             process = subprocess.Popen(command)
-            process.wait()
-            return
+        else:
+            self.log_file.parent.mkdir(parents=True, exist_ok=True)
+            with self.log_file.open("wb") as f:
+                process = subprocess.Popen(command, stdout=f, stderr=f)
 
-        self.log_file.parent.mkdir(parents=True, exist_ok=True)
-        with self.log_file.open("wb") as f:
-            process = subprocess.Popen(command, stdout=f, stderr=f)
-            process.wait()
+        assert process is not None, "Process should be defined at this point."
+        process.wait()
 
     def run(self, *command: str) -> None:
         if self.image is None:
@@ -279,7 +320,7 @@ class Engine(ABC):
         logger.debug("Running: %s", command)
         if self.dry_run:
             print("Command to be executed:")
-            print(" ".join(command))
+            print(" ".join(map(str, command)))
             return
 
         self._run_process(command)
@@ -303,15 +344,15 @@ class Podman(Engine):
         return [
             "--annotation",
             "run.oci.keep_original_groups=1",
-            #  "--cgroups=split",
+            "--cgroups=split",
             "--security-opt",
             "unmask=/sys/fs/cgroup",
             "--security-opt",
             "unmask=/proc/*",
             "--security-opt",
             "seccomp=unconfined",
-            "-v",
-            "/sys/fs/cgroup:/sys/fs/cgroup:rw",
+            # "-v",
+            # "/sys/fs/cgroup:/sys/fs/cgroup:rw",
         ]
 
 

fm_weck/image_mgr.py

@@ -9,8 +9,14 @@ import logging
 from pathlib import Path
 from typing import TYPE_CHECKING
 
-from fm_tools.fmdata import FmImageConfig
-from yaspin import yaspin
+try:
+    from fm_tools.fmdata import FmImageConfig
+except ImportError:
+
+    class FmImageConfig:
+        def __init__(self, full_images, base_images, required_packages):
+            raise ImportError("fm_tools is not imported.")
+
 
 from fm_weck.exceptions import NoImageError
 
@@ -48,6 +54,7 @@ class ImageMgr(object):
         image_cmd = engine.image_from(CONTAINERFILE)
         image_cmd.base_image(image.base_images[0])
         image_cmd.packages(image.required_packages)
+        from yaspin import yaspin
 
         with yaspin(text="Building image", color="cyan") as spinner:
             tag = image_cmd.build()

fm_weck/resources/__init__.py

@@ -15,9 +15,9 @@ CONTAINERFILE = resource_dir / "Containerfile"
 # to the wheel file under fm_weck/resources/fm_tools
 FM_DATA_LOCATION = resource_dir / "fm_tools"
 PROPERTY_LOCATION = resource_dir / "properties"
-RUN_WITH_OVERLAY = resource_dir / "run_with_overlay.sh"
+RUN_WITH_OVERLAY = "run_with_overlay.sh"
 BENCHEXEC_WHL = resource_dir / "BenchExec-3.25-py3-none-any.whl"
-RUNEXEC_SCRIPT = resource_dir / "runexec"
+RUNEXEC_SCRIPT = "runexec"
 
 
 def iter_fm_data():

fm_weck/resources/fm_tools/2ls.yml

@@ -9,6 +9,7 @@ fmtools_format_version: "2.0"
 fmtools_entry_maintainers:
   - viktor.malik
   - FrNecas
+  - peterschrammel
 
 maintainers:
   - orcid: 0000-0002-0608-0748
@@ -18,6 +19,10 @@ maintainers:
     url: https://www.fit.vut.cz/person/imalik/.en
 
 versions:
+  - version: "svcomp25"
+    doi: "10.5281/zenodo.10184626"
+    benchexec_toolinfo_options: ['--graphml-witness', 'witness.graphml']
+    required_ubuntu_packages: []
   - version: "svcomp24"
     doi: "10.5281/zenodo.10184626"
     benchexec_toolinfo_options: ['--graphml-witness', 'witness.graphml']
@@ -28,6 +33,15 @@ versions:
     required_ubuntu_packages: []
 
 competition_participations:
+  - competition: "SV-COMP 2025"
+    track: "Verification"
+    tool_version: "svcomp25"
+    jury_member:
+      orcid: 0000-0002-0608-0748
+      name: Viktor Malík
+      institution: Brno University of Technology
+      country: Czechia
+      url: https://www.fit.vut.cz/person/imalik/.en
   - competition: "SV-COMP 2024"
     track: "Verification"
     tool_version: "svcomp24"

fm_weck/resources/fm_tools/aise.yml

@@ -1,13 +1,13 @@
 name: aise
 input_languages:
   - C
-project_url: https://github.com/ZhenWang233/AISE
-repository_url: https://github.com/ZhenWang233/AISE
+project_url: https://github.com/zbchen/aise-verifier
+repository_url: https://github.com/zbchen/aise-verifier
 spdx_license_identifier: GPL-3.0-or-later
 benchexec_toolinfo_module: "https://gitlab.com/sosy-lab/software/benchexec/-/raw/main/benchexec/tools/aise.py"
 fmtools_format_version: "2.0"
 fmtools_entry_maintainers:
-  - ZhenWang233
+  - liar1007
 
 maintainers:
   - orcid: 0000-0002-4066-7892
@@ -17,12 +17,25 @@ maintainers:
     url: https://zbchen.github.io/
 
 versions:
+  - version: "svcomp25"
+    doi: "10.5281/zenodo.14162938"
+    benchexec_toolinfo_options: []
+    required_ubuntu_packages: []
   - version: "svcomp24"
     doi: "10.5281/zenodo.10201159"
     benchexec_toolinfo_options: []
     required_ubuntu_packages: []
 
 competition_participations:
+  - competition: "SV-COMP 2025"
+    track: "Verification"
+    tool_version: "svcomp25"
+    jury_member:
+      orcid: 0000-0002-4066-7892
+      name: Zhenbang Chen
+      institution: National University of Defense Technology
+      country: China
+      url: https://zbchen.github.io/
   - competition: "SV-COMP 2024"
     track: "Verification"
     tool_version: "svcomp24"

fm_weck/resources/fm_tools/aprove.yml

@@ -1,4 +1,4 @@
-name: AProVE
+name: AProVE (KoAT + LoAT)
 input_languages:
   - C
 project_url: https://aprove.informatik.rwth-aachen.de/
@@ -6,9 +6,15 @@ spdx_license_identifier: AProVE license
 benchexec_toolinfo_module: benchexec.tools.aprove
 fmtools_format_version: "2.0"
 fmtools_entry_maintainers:
+  - nilslommen
   - JCKassing
 
 maintainers:
+  - orcid: 0000-0003-3187-9217
+    name: Nils Lommen
+    institution: RWTH Aachen
+    country: Germany
+    url: https://verify.rwth-aachen.de/nlommen/
   - orcid: 0009-0001-9972-2470
     name: Jan-Christoph Kassing
     institution: RWTH Aachen
@@ -16,6 +22,15 @@ maintainers:
     url: https://verify.rwth-aachen.de/jckassing/
 
 versions:
+  - version: "svcomp25"
+    doi: "10.5281/zenodo.14168633"
+    benchexec_toolinfo_options: []
+    required_ubuntu_packages:
+      - openjdk-17-jre-headless
+    base_container_images:
+      - docker.io/ubuntu:20.04
+    full_container_images:
+      - registry.gitlab.com/sosy-lab/benchmarking/competition-scripts/user:2022
   - version: "svcomp22"
     url: "https://gitlab.com/sosy-lab/sv-comp/archives-2022/raw/svcomp22/2022/aprove.zip"
     benchexec_toolinfo_options: []
@@ -26,6 +41,15 @@ versions:
       - registry.gitlab.com/sosy-lab/benchmarking/competition-scripts/user:2022
 
 competition_participations:
+  - competition: "SV-COMP 2025"
+    track: "Verification"
+    tool_version: "svcomp25"
+    jury_member:
+      orcid: 0000-0003-3187-9217
+      name: Nils Lommen
+      institution: RWTH Aachen
+      country: Germany
+      url: https://verify.rwth-aachen.de/nlommen/
   - competition: "SV-COMP 2022"
     track: "Verification"
     tool_version: "svcomp22"

fm_weck/resources/fm_tools/brick.yml

@@ -17,6 +17,10 @@ maintainers:
     url: null
 
 versions:
+  - version: "svcomp25"
+    doi: "10.5281/zenodo.13961249"
+    benchexec_toolinfo_options: []
+    required_ubuntu_packages: []
   - version: "svcomp24"
     doi: "10.5281/zenodo.10202700"
     benchexec_toolinfo_options: []
@@ -27,6 +31,15 @@ versions:
     required_ubuntu_packages: []
 
 competition_participations:
+  - competition: "SV-COMP 2025"
+    track: "Verification"
+    tool_version: "svcomp25"
+    jury_member:
+      orcid: 0000-0003-0517-7801
+      name: Lei Bu
+      institution: Nanjing University
+      country: China
+      url: null
   - competition: "SV-COMP 2024"
     track: "Verification"
     tool_version: "svcomp24"

fm_weck/resources/fm_tools/bubaak-split.yml

@@ -18,6 +18,12 @@ maintainers:
     url: null
 
 versions:
+  - version: "svcomp25"
+    doi: "10.5281/zenodo.13958522"
+    benchexec_toolinfo_options: ["-sv-comp", "-sv-comp-witness", "witness.graphml", "-cfg", "splitting-svcomp24"]
+    required_ubuntu_packages:
+      - clang
+      - python3
   - version: "svcomp24"
     doi: "10.5281/zenodo.10202207"
     benchexec_toolinfo_options: ["-sv-comp", "-sv-comp-witness", "witness.graphml", "-cfg", "splitting-svcomp24"]
@@ -27,6 +33,15 @@ versions:
       - python3-lxml
 
 competition_participations:
+  - competition: "SV-COMP 2025"
+    track: "Verification"
+    tool_version: "svcomp25"
+    jury_member:
+      orcid: 0000-0003-1132-5516
+      name: Marek Chalupa
+      institution: ISTA
+      country: Austria
+      url: null
   - competition: "SV-COMP 2024"
     track: "Verification"
     tool_version: "svcomp24"

fm_weck/resources/fm_tools/bubaak.yml

@@ -17,6 +17,12 @@ maintainers:
     url: null
 
 versions:
+  - version: "svcomp25"
+    doi: "10.5281/zenodo.13958522"
+    benchexec_toolinfo_options: ["-sv-comp", "-sv-comp-witness", "witness.graphml", "-timeout", "900"]
+    required_ubuntu_packages:
+      - clang
+      - python3
   - version: "svcomp24"
     doi: "10.5281/zenodo.10202207"
     benchexec_toolinfo_options: ["-sv-comp", "-sv-comp-witness", "witness.graphml", "-timeout", "900"]
@@ -33,6 +39,15 @@ versions:
       - python3-lxml
 
 competition_participations:
+  - competition: "SV-COMP 2025"
+    track: "Verification"
+    tool_version: "svcomp25"
+    jury_member:
+      orcid: 0000-0003-1132-5516
+      name: Marek Chalupa
+      institution: ISTA
+      country: Austria
+      url: null
   - competition: "SV-COMP 2024"
     track: "Verification"
     tool_version: "svcomp24"

fm_weck/resources/fm_tools/cbmc.yml

@@ -25,8 +25,18 @@ versions:
       - libc6-dev-i386
 
 competition_participations:
+  - competition: "SV-COMP 2025"
+    track: "Verification"
+    hors-concours: true
+    tool_version: "svcomp23"
+    jury_member:
+      name: Hors Concours
+      institution: --
+      country: --
+      url: null
   - competition: "SV-COMP 2024"
     track: "Verification"
+    hors-concours: true
     tool_version: "svcomp23"
     jury_member:
       orcid: 0000-0002-7947-983X

fm_weck/resources/fm_tools/cetfuzz.yml

@@ -39,8 +39,19 @@ versions:
       - python3-pandas
       - python3-pycparser
       - python3-sklearn
-      
+    full_container_images:
+      - registry.gitlab.com/sosy-lab/benchmarking/competition-scripts/user:2024
+
 competition_participations:
+  - competition: "Test-Comp 2025"
+    track: "Test Generation"
+    hors-concours: true
+    tool_version: "testcomp24"
+    jury_member:
+      name: Hors Concours
+      institution: --
+      country: --
+      url: null
   - competition: "Test-Comp 2024"
     track: "Test Generation"
     tool_version: "testcomp24"