fm-weck 1.4.7__py3-none-any.whl → 1.4.8__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.4.7"
+__version__ = "1.4.8"

fm_weck/cli.py

@@ -470,12 +470,7 @@ def main_install(args: argparse.Namespace):
             logger.error("Unknown tool %s. Skipping installation...", tool)
             continue
 
-        install_fm_tool(
-            fm_tool=fm_data,
-            version=tool.version,
-            configuration=Config(),
-            install_path=args.destination
-        )
+        install_fm_tool(fm_tool=fm_data, version=tool.version, configuration=Config(), install_path=args.destination)
 
     return 0
 

fm_weck/config.py

@@ -8,7 +8,6 @@
 import importlib.resources as pkg_resources
 import logging
 import os
-import shutil
 import stat
 import sys
 from functools import cache
@@ -40,6 +39,8 @@ except ImportError:
 
 from fm_weck.resources import RUN_WITH_OVERLAY, RUNEXEC_SCRIPT
 
+from .file_util import copy_ensuring_unix_line_endings
+
 try:
     import tomllib as toml
 except ImportError:
@@ -206,7 +207,7 @@ class Config(object):
             # Try to copy from package resources
             try:
                 with pkg_resources.path("fm_weck.resources", target_name) as source_path:
-                    shutil.copy(source_path, target)
+                    copy_ensuring_unix_line_endings(source_path, target)
             except FileNotFoundError:
                 logging.error(f"Resource {target_name} not found in package.")
                 return None
@@ -214,7 +215,7 @@ class Config(object):
             # 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)
+                    copy_ensuring_unix_line_endings(source_path, target)
                 else:
                     logging.debug(f"Using existing {target_name} script")
                     return target

fm_weck/engine.py

@@ -7,6 +7,7 @@
 
 import io
 import logging
+import platform
 import shutil
 import signal
 import subprocess
@@ -73,8 +74,8 @@ class Engine(ABC):
         if self._tmp_output_dir.exists():
             shutil.rmtree(self._tmp_output_dir)
 
-    def get_workdir(self):
-        return Path(CWD_MOUNT_LOCATION)
+    def get_workdir(self) -> str:
+        return Path(CWD_MOUNT_LOCATION).as_posix()
 
     def set_output_log(self, output_log: Path):
         self.log_file = output_log
@@ -126,7 +127,7 @@ class Engine(ABC):
             "--entrypoint",
             '[""]',
             "-v",
-            f"{Path.cwd().absolute()}:{CWD_MOUNT_LOCATION}",
+            f"{Path.cwd().absolute()}:{self.get_workdir()}",
             "-v",
             f"{Config().cache_location}:{CACHE_MOUNT_LOCATION}",
             "-v",
@@ -203,9 +204,9 @@ class Engine(ABC):
                     return p
             mapped = _map_path(Path(p))
             if Path(p) == mapped:
-                return p
+                return Path(p).as_posix()
             else:
-                return mapped
+                return Path(mapped).as_posix()
 
         return tuple(map(_map_path, command))
 
@@ -227,7 +228,7 @@ class Engine(ABC):
 
     @staticmethod
     def _base_engine_class(config: Config):
-        engine = config.defaults().get("engine", "podman").lower()
+        engine = "docker" if platform.system() != "Linux" else config.defaults().get("engine", "podman").lower()
 
         if engine == "docker":
             return Docker

fm_weck/file_util.py

@@ -0,0 +1,23 @@
+# This file is part of fm-weck: executing fm-tools in containerized environments.
+# https://gitlab.com/sosy-lab/software/fm-weck
+#
+# SPDX-FileCopyrightText: 2024 Dirk Beyer <https://www.sosy-lab.org>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from pathlib import Path
+
+# replacement strings
+WINDOWS_LINE_ENDING = b"\r\n"
+UNIX_LINE_ENDING = b"\n"
+
+
+def copy_ensuring_unix_line_endings(src: Path, dst: Path) -> None:
+    with open(src, "rb") as src_file:
+        content = src_file.read()
+
+    # Windows ➡ Unix
+    content = content.replace(WINDOWS_LINE_ENDING, UNIX_LINE_ENDING)
+
+    with open(dst, "wb") as dst_file:
+        dst_file.write(content)

fm_weck/resources/fm_tools/ltsmin.yml

@@ -6,7 +6,16 @@ description: |
   It features modular architecture, symbolic/distributed/multi-core reachability,
   and easy extensibility for new languages.
 input_languages:
+  - B
+  - DVE
+  - ETF
+  - Event-B
+  - MCRL
+  - MCRL2
   - PNML
+  - Promela
+  - TLA+
+  - Z
 project_url: https://ltsmin.utwente.nl/
 repository_url: https://github.com/utwente-fmt/ltsmin
 spdx_license_identifier: BSD-3-Clause
@@ -28,7 +37,7 @@ versions:
     url: "https://github.com/utwente-fmt/ltsmin/releases/download/v3.0.2/ltsmin-v3.0.2-linux.tgz"
     benchexec_toolinfo_options: ["pnml2lts-sym"]
     required_ubuntu_packages: []
-    base_container_image: ["ubuntu:24.04"]
+    base_container_images: ["ubuntu:24.04"]
 
 competition_participations: []
 
@@ -36,5 +45,14 @@ techniques: []
 
 frameworks_solvers: []
 
-literature: []
+literature:
+  - doi: 10.1007/978-3-662-46681-0_61
+    title: "LTSmin: High-Performance Language-Independent Model Checking"
+    year: 2015
+  - doi: 10.1007/978-3-642-20398-5_40
+    title: "Multi-Core LTSmin: Marrying Modularity and Scalability"
+    year: 2011
+  - doi: 10.1007/978-3-642-14295-6_31
+    title: "LTSmin: Distributed and Symbolic Reachability"
+    year: 2010
 

fm_weck/serve.py

@@ -9,18 +9,20 @@ import dbm
 import json
 import logging
 import os
-import shutil
 import sys
 from pathlib import Path
-from typing import Optional, Tuple, Union
+from typing import Optional, Tuple, Union, cast
 
 from fm_tools.benchexec_helper import DataModel
+from fm_tools.files import unzip
 from fm_tools.fmtoolversion import FmToolVersion
 
 from fm_weck.run_result import RunResult
+from fm_weck.tmp_file import NTempFile
 
 from .config import Config, parse_fm_data
 from .engine import CACHE_MOUNT_LOCATION, Engine
+from .file_util import copy_ensuring_unix_line_endings
 
 logger = logging.getLogger(__name__)
 
@@ -69,6 +71,7 @@ def setup_fm_tool(
     # Don't explicitly disallow non-FmToolVersion here; Pythonic Users might want to exchange the FmToolVersion object
     # by a class with the same interface
     fm_data = parse_fm_data(fm_tool, version) if isinstance(fm_tool, (Path, str)) else fm_tool
+    fm_data = cast(FmToolVersion, fm_data)
 
     shelve_space = configuration.get_shelve_space_for(fm_data)
     logger.debug("Using shelve space %s", shelve_space)
@@ -84,7 +87,42 @@ def setup_fm_tool(
             skip_download = check_cache_entry(shelve_space, checksum, configuration)
 
     if not skip_download:
-        fm_data.download_and_install_into(shelve_space)
+        if sys.platform != "win32":
+            fm_data.download_and_install_into(shelve_space)
+            checksum = fm_data.get_archive_location().resolve().checksum
+            if checksum is None:
+                logger.warning(
+                    "No checksum available for %s, skipping checksum update", fm_data.get_tool_name_with_version()
+                )
+            else:
+                update_checksum(shelve_space, checksum, configuration)
+
+            # On Windows, we need to download the tool first and then unzip it
+            # This is because the unzip operation might fail due to a permission error
+        else:
+            dl_loc = NTempFile(f"{fm_data.get_tool_name_with_version()}-dl.zip")
+            fm_data.download_into(dl_loc.name)
+
+            success = False
+            last_error = None
+
+            logging.info("Unzipping downloaded archive...")
+
+            # On Windows, the unzip operation might fail due to a permission error.
+            # Retrying the operation a few times mitigates this issue.
+            for _ in range(100):
+                try:
+                    unzip(dl_loc.name, shelve_space)
+                    success = True
+                    break
+                except PermissionError as e:
+                    last_error = e
+                    continue
+
+            if not success:
+                logger.error("Failed to unzip downloaded archive")
+                raise last_error
+
         checksum = fm_data.get_archive_location().resolve().checksum
         if checksum is None:
             logger.warning(
@@ -93,6 +131,7 @@ def setup_fm_tool(
         else:
             update_checksum(shelve_space, checksum, configuration)
         map_doi(fm_data, shelve_space)
+
     tool_info_module = fm_data.get_toolinfo_module()
 
     if (not offline_mode) or tool_info_module._trivially_resolved():
@@ -140,7 +179,7 @@ def run_guided(
             # copy the property to the weck_cache which should be mounted
             source_property_path = prop
             property_path = configuration.get_shelve_path_for_property(source_property_path)
-            shutil.copyfile(source_property_path, property_path)
+            copy_ensuring_unix_line_endings(source_property_path, property_path)
         except KeyError:
             logger.error("Unknown property %s", prop)
             return RunResult(command=[], exit_code=1, raw_output="Unknown property")

fm_weck/tmp_file.py

@@ -0,0 +1,61 @@
+# This file is part of fm-weck: executing fm-tools in containerized environments.
+# https://gitlab.com/sosy-lab/software/fm-weck
+#
+# SPDX-FileCopyrightText: 2024 Dirk Beyer <https://www.sosy-lab.org>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+import contextlib
+import os
+from pathlib import Path
+from tempfile import mkdtemp
+
+
+class NTempFile:
+    """
+    Custom temporary file context manager.
+    It creates a temporary file and deletes it after the context manager is closed.
+    The file is not kept open in order to achieve compatibility with Windows.
+
+    Inspired by https://stackoverflow.com/a/63173312
+    """
+
+    def __init__(self, name, mode="wb"):
+        self.__tmp_dir = mkdtemp()
+        self.name = Path(self.__tmp_dir) / name
+        self._mode = mode
+        self._file = None
+
+    def __enter__(self):
+        """Enter the context manager and return the file object."""
+        self._file = open(self.name, self._mode)
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        """Exit the context manager and clean up."""
+        if self._file is not None:
+            self._file.close()
+        self._cleanup()
+
+    def write(self, data):
+        """Write data to the temporary file."""
+        if self._file is None:
+            # If not in context manager, open the file temporarily
+            with open(self.name, self._mode) as f:
+                f.write(data)
+        else:
+            self._file.write(data)
+            self._file.flush()  # Ensure data is written immediately
+
+    def _cleanup(self):
+        """Clean up the temporary file and directory."""
+        with contextlib.suppress(OSError):
+            if self.name.exists():
+                os.unlink(self.name)
+        with contextlib.suppress(OSError):
+            if Path(self.__tmp_dir).exists():
+                os.rmdir(self.__tmp_dir)
+
+    def __del__(self):
+        """Cleanup when object is garbage collected."""
+        self._cleanup()

{fm_weck-1.4.7.dist-info → fm_weck-1.4.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fm-weck
-Version: 1.4.7
+Version: 1.4.8
 Author-email: Henrik Wachowitz <henrik.wachowitz@ifi.lmu.de>
 Maintainer-email: Henrik Wachowitz <henrik.wachowitz@ifi.lmu.de>
 Classifier: Development Status :: 4 - Beta
@@ -36,7 +36,7 @@ We provide a tutorial on how to use fm-weck [here](doc/Tutorial.md).
 
 ## Install dependencies
 
-`fm-weck` requires Python 3.10 or higher. `fm-weck` relies on an available Podman installation. To install Podman on Ubuntu, run the following command:
+`fm-weck` requires Python 3.10 or higher. `fm-weck` relies on an available Podman or Docker installation. To install Podman on Ubuntu, run the following command:
 
 ```
 sudo apt install podman
@@ -46,11 +46,11 @@ sudo apt install podman
 
 There are three modes of operation: `run`, `shell` and `expert`.
 
+- `run`: (**Recommended**) enables plug-and-play execution of formal methods tools: it 
+downloads and unpacks a tool from the fm-tools metadata file into a user-specified cache directory on the host system and then runs the tool in the containerized environment
 - `expert`: executes a tool in it's containerized environment specified through the
 corresponding fm-tools YAML file: All arguments are passed verbatim to the tool.
 - `shell`: enters an interactive shell inside of the container specified by the given tool
-- `run`: enables plug-and-play execution of formal methods tools: it 
-downloads and unpacks a tool from the fm-tools metadata file into a user-specified cache directory on the host system and then runs the tool in the containerized environment
 
 ## Development and Testing
 
@@ -63,4 +63,10 @@ In Linux this can be done by running the following command in the root directory
 
 ```
 ln -s $(pwd)/fm_tools/data $(pwd)/src/fm_weck/resources/fm_tools
-```
+```
+
+## Publications
+
+A paper about fm-weck has been accepted at the FM '24 conference.
+
+- [<img src="/doc/images/pdf.png" alt="PDF icon" width="32"/> FM-Weck: Containerized Execution of Formal-Methods Tools](https://link.springer.com/content/pdf/10.1007/978-3-031-71177-0_3.pdf), by Dirk Beyer and Henrik Wachowitz. Proc. FM. Springer (2024). [doi:10.1007/978-3-031-71177-0_3](https://doi.org/10.1007/978-3-031-71177-0_3)

{fm_weck-1.4.7.dist-info → fm_weck-1.4.8.dist-info}/RECORD

@@ -1,15 +1,17 @@
-fm_weck/__init__.py,sha256=qVPurJ_oj0SwP8asFRG0x8Qh7KDzNBLJf5jHKxcyDMc,351
+fm_weck/__init__.py,sha256=hwPTOu20emETJm7zBfj7trYoLdZD-A_ZoL0mtmZcyLw,351
 fm_weck/__main__.py,sha256=IfNDAqM6MK6P7KsQoW3wOHPOscB8evdVlS9C7R4wd_0,391
 fm_weck/cache_mgr.py,sha256=3-OQFmCeswazXmX08ND4oEHFOR07ZDCwWzjmFTDkOSE,1373
-fm_weck/cli.py,sha256=k2-rHURw_w0yy5L97FofJ0jYVxqpNP79_XTtirYbyjY,17194
-fm_weck/config.py,sha256=72HfwKJlLnyrBUmLyjEebgPerGMq0CdnQnugz1SIWis,8017
-fm_weck/engine.py,sha256=1EhfL0tzgVyBNf4b40yt2w1netv2Elyop9aRpwzCvm0,17262
+fm_weck/cli.py,sha256=gWiFsbkCOWS6oXTr6srWza-qFrfpU_XR1P-MxHrCQuM,17136
+fm_weck/config.py,sha256=8XXlHbb9cW1N1jatNFY5AnaRdxsSz-ohCrqq5t90RAc,8099
+fm_weck/engine.py,sha256=zway0nC4piPohK3hoBYr9Sv3xAa32dLeuPSuOw1Wers,17376
 fm_weck/exceptions.py,sha256=xXxbYK-FZW6YksBtaN79KaA4fGnFCBO-wc0QMqtq3Og,282
+fm_weck/file_util.py,sha256=R9y6LUZCDNJR4j25_Q24lN_zhACnOjYP5BvcpYaQPiA,649
 fm_weck/image_mgr.py,sha256=mDqP-YD6AEOW2xldYJ4D-wxYKF0Ta5SgoJiX2CrhyQg,1906
 fm_weck/run_result.py,sha256=0d8G3py1VCPP4jLxPCVzL8Vljvrwt9IHlmvCkW0pwx8,1249
 fm_weck/runexec_mode.py,sha256=UamxVvYm0XErPjR2sRJaLMX8uHBzRcgCTWbQIZjdju0,2195
 fm_weck/runexec_util.py,sha256=YBvVIPpmEousZVxbZ5NS8jzpKPLyws31kIFE2z3Ki2E,1370
-fm_weck/serve.py,sha256=RL6LOnK0RMhFRWehwFdoydc0A619FqSaph7H0JFDYlo,9037
+fm_weck/serve.py,sha256=mDaZ1BUKwUh_fPgGMR4LXrJ1c5GOmwwXbHbMllmJzi8,10608
+fm_weck/tmp_file.py,sha256=oJiE8VGTPxhl-bXdtbM8eNqQ4e9ECPG1jDmiboVDo_k,1956
 fm_weck/version_listing.py,sha256=caaoC3n9R-Ao2sEQ_ngOVO3bnKr7cNVeH6EiA8jO5Sc,864
 fm_weck/resources/BenchExec-3.27-py3-none-any.whl,sha256=g-db8LM8HfqLhbnl7n5lvUbMnF2tZ4MHAVOxTGxqO8w,732849
 fm_weck/resources/BenchExec-3.27-py3-none-any.whl.license,sha256=Nq2Mwgn_pyr6ZZrTT095QPtFP3hr15ZeIRIaY0B7eC8,201
@@ -101,7 +103,7 @@ fm_weck/resources/fm_tools/legion.yml,sha256=ClD8_UEJq8wHIEp9_ifhTNKJuNmzvekaQx1
 fm_weck/resources/fm_tools/lf-checker.yml,sha256=lV4-GzzNvzWW505FFtYAUHlSG4gxOn-LL4xT8Tpyvq0,1386
 fm_weck/resources/fm_tools/liv.yml,sha256=t0-Rfs0Ot3VPn7DD_pt3VAbyfpUOP8kdYV3E7uN3qGI,3260
 fm_weck/resources/fm_tools/locksmith.yml,sha256=c3wNvIzQ_PZaYv6Mm15QH-Rm4oTuNzILNJs1fssESYQ,1397
-fm_weck/resources/fm_tools/ltsmin.yml,sha256=vpfL4mBGlnxPtqoqaqUnR-Ph0kibaOd-h6FYuWHn91M,1206
+fm_weck/resources/fm_tools/ltsmin.yml,sha256=WkQ5aP-p1yFP6XfRXJeb5ftcd7o_buvNjEKZRVr6mpM,1644
 fm_weck/resources/fm_tools/metaval++.yml,sha256=KAOcvftDNLvuHzIKaUoebekeOxBE6DVS2Acq2VbL1Dg,2006
 fm_weck/resources/fm_tools/metaval.yml,sha256=aclr5cfGDuCduSrlk9kLOcK8GaUQAzPtDAxIJHgHs44,4668
 fm_weck/resources/fm_tools/mlb.yml,sha256=S_ykc9ThLHBbMSXOgYIvk81r96cEwXbAXI5lPRDxJ4s,1907
@@ -148,7 +150,7 @@ fm_weck/resources/fm_tools/wit4java.yml,sha256=ylfze2XbV4zKkVUH57Veqn7G49gW0Byxd
 fm_weck/resources/fm_tools/witch.yml,sha256=wwe6lrI2sxGKVZbLeipa38rPhB2pcSUFi9uVngtXGUQ,1795
 fm_weck/resources/fm_tools/witnesslint.yml,sha256=EvMBcm5fx6lgSLRmHSKXSxXIJKZ-BrxLwTXI4GQ6FMs,6812
 fm_weck/resources/fm_tools/witnessmap.yml,sha256=FyZtEloxpWBBjLn9kyqoen2kPjOkH2r4fxAj5gfV8Bg,1692
-fm_weck-1.4.7.dist-info/METADATA,sha256=WnQnKmjvJ6HQouE2-s1Mil4cw9NJW0Sp3d9E43upkhk,2822
-fm_weck-1.4.7.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-fm_weck-1.4.7.dist-info/entry_points.txt,sha256=toWpKCSY1u593MPnI_xW5gnwlnkerP4AvmPQ1s2nPgY,50
-fm_weck-1.4.7.dist-info/RECORD,,
+fm_weck-1.4.8.dist-info/METADATA,sha256=gGPe1x8nywUCLB85Ldg2MTFg4j7gMU8LRPFarOjIQKo,3269
+fm_weck-1.4.8.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+fm_weck-1.4.8.dist-info/entry_points.txt,sha256=toWpKCSY1u593MPnI_xW5gnwlnkerP4AvmPQ1s2nPgY,50
+fm_weck-1.4.8.dist-info/RECORD,,