fm-weck 0.2.1__py3-none-any.whl → 1.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__ = "0.2.1"
+__version__ = "1.1"

fm_weck/cli.py

@@ -12,7 +12,7 @@ from argparse import Namespace
 from dataclasses import dataclass
 from functools import cache
 from pathlib import Path
-from typing import Any, Callable, Optional, Tuple, Union, cast
+from typing import Any, Callable, Optional, Tuple, Union
 
 from fm_tools.benchexec_helper import DataModel
 
@@ -22,7 +22,7 @@ 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
+from .serve import run_guided, run_manual, setup_fm_tool
 
 
 @dataclass
@@ -45,9 +45,30 @@ class ToolQualifier:
             return
 
 
-def add_shared_arguments(
-        parser: argparse.ArgumentParser, require_manual=False
-) -> Tuple[argparse.ArgumentParser, argparse.ArgumentParser, Any]:
+def add_tool_arg(parser, nargs="?"):
+    parser.add_argument(
+        "TOOL",
+        help="The tool to obtain the container from. Can be the form <tool>:<version>. "
+        "The TOOL is either the name of a bundled tool (c.f. fm-weck --list) or "
+        "the path to a fm-tools yaml file.",
+        type=ToolQualifier,
+        nargs=nargs,
+    )
+
+
+def add_shared_args_for_run_modes(parser):
+    parser.add_argument(
+        "--skip-download",
+        action="store_true",
+        help="Do not download the fm-tool, even if it is not available in the cache.",
+    )
+
+    add_tool_arg(parser, nargs=None)
+
+
+def parse(raw_args: list[str]) -> Tuple[Callable[[], None], Namespace]:
+    parser = argparse.ArgumentParser(description="fm-weck")
+
     parser.add_argument(
         "--version",
         action="version",
@@ -78,55 +99,8 @@ def add_shared_arguments(
     )
 
     subparsers = parser.add_subparsers()
-    run = subparsers.add_parser("run", help="Run a verifier inside a container.")
-
-    run.add_argument(
-        "-m",
-        "--manual",
-        action="store_true",
-        required=require_manual,
-        help="Enable manual mode. All args past <tool>:<version> are passed verbatim to the tool.",
-    )
-
-    run.add_argument(
-        "--skip-download",
-        action="store_true",
-        help="Do not download the fm-tool, even if it is not available in the cache.",
-    )
-
-    run.add_argument(
-        "TOOL",
-        help="The tool to use. Can be the form <tool>:<version>. "
-             "The TOOL is either the name of a bundled tool (c.f. fm-weck --list) or "
-             "the path to a fm-tools yaml file.",
-        type=ToolQualifier,
-    )
 
-    return parser, run, subparsers
-
-
-class MayFailParserError(Exception):
-    pass
-
-
-class MayFailParser(argparse.ArgumentParser):
-    def error(self, message):
-        raise MayFailParserError
-
-    def format_help(self):
-        raise MayFailParserError
-
-
-def parse(raw_args: list[str]) -> tuple[Callable[[], None], Namespace]:
-    manual_parser = MayFailParser(description="fm-weck", exit_on_error=False)
-    normal_parser = argparse.ArgumentParser(description="fm-weck")
-
-    manual_parser, run, _ = add_shared_arguments(manual_parser, require_manual=True)
-    # manual mode
-    run.add_argument("argument_list", metavar="args", nargs="*", help="Arguments for the fm-tool")
-    run.set_defaults(main=main_manual)
-
-    normal_parser, run, subparsers = add_shared_arguments(normal_parser)
+    run = subparsers.add_parser("run", aliases=["r"], help="Run a verifier inside a container.")
 
     # guided mode
     run.add_argument(
@@ -163,6 +137,8 @@ def parse(raw_args: list[str]) -> tuple[Callable[[], None], Namespace]:
         default=None,
     )
 
+    add_shared_args_for_run_modes(run)
+
     run.add_argument("files", metavar="FILES", nargs="+", help="Files to pass to the tool")
     run.add_argument(
         "argument_list",
@@ -172,40 +148,48 @@ def parse(raw_args: list[str]) -> tuple[Callable[[], None], Namespace]:
     )
     run.set_defaults(main=main_run)
 
+    expert = subparsers.add_parser(
+        "expert",
+        aliases=["e", "m"],
+        help="Manually run a verifier inside a container."
+        "Arguments are passed verbatim to the tool, so expert-ise about it's command line is required.",
+    )
+
+    add_shared_args_for_run_modes(expert)
+
+    expert.add_argument("argument_list", metavar="args", nargs="*", help="Arguments for the fm-tool")
+    expert.set_defaults(main=main_manual)
+
     shell = subparsers.add_parser("shell", help="Start an interactive shell inside the container.")
-    shell = cast(argparse.ArgumentParser, shell)
+
     shell.add_argument("--entry", action="store", help="The entry point of the shell.", default="/bin/bash")
-    shell.add_argument(
-        "TOOL",
-        help="The tool to obtain the container from. Can be the form <tool>:<version>. "
-             "The TOOL is either the name of a bundled tool (c.f. fm-weck --list) or "
-             "the path to a fm-tools yaml file.",
-        type=ToolQualifier,
-        nargs="?",
-    )
+
+    add_tool_arg(shell)
     shell.set_defaults(main=main_shell)
 
+    install = subparsers.add_parser("install", aliases=["i"], help="Download and unpack a TOOL for later use.")
+    add_tool_arg(install, nargs="+")
+    install.set_defaults(main=main_install)
+
     def help_callback():
-        normal_parser.print_help()
+        parser.print_help()
 
     try:
-        first_pass, remain = manual_parser.parse_known_args(raw_args)
-        if remain:
-            i = raw_args.index(remain[0])
-            args = raw_args.copy()
-            args.insert(i, "--")
-            # retry parsing
-            args = manual_parser.parse_args(args)
-        else:
-            args = first_pass
-    except MayFailParserError:
-        args = normal_parser.parse_args(raw_args)
-    except argparse.ArgumentError:
-        # Either: Parse faulty args again to display nice help message
-        # Or: shell was called: proceed normally
-        args = normal_parser.parse_args(raw_args)
+        parser.parse_args(raw_args)
+    except SystemExit as e:
+        _, left_over = parser.parse_known_args(raw_args)
+
+        if not left_over:
+            # Some unrecoverable error occurred
+            raise e
+
+        # Find the first offending argument and insert "--" before it
+        # We do this to allow the user to pass arguments to the fm-tool without
+        # having to specify the pseudo argument "--"
+        idx = raw_args.index(left_over[0])
+        raw_args.insert(idx, "--")
 
-    return help_callback, args
+    return help_callback, parser.parse_args(raw_args)
 
 
 @cache
@@ -300,6 +284,21 @@ def main_manual(args: argparse.Namespace):
     )
 
 
+def main_install(args: argparse.Namespace):
+    for tool in args.TOOL:
+        try:
+            fm_data = resolve_tool(tool)
+        except KeyError:
+            logging.error("Unknown tool %s. Skipping installation...", tool)
+            continue
+
+        setup_fm_tool(
+            fm_tool=fm_data,
+            version=tool.version,
+            configuration=Config(),
+        )
+
+
 def main_shell(args: argparse.Namespace):
     if not args.TOOL:
         engine = Engine.from_config(Config())
@@ -315,14 +314,13 @@ def main_shell(args: argparse.Namespace):
 
 
 def log_no_image_error(tool, config):
-    
     order = []
     for path in _SEARCH_ORDER:
         if path.is_relative_to(Path.cwd()):
             order.append(str(path.relative_to(Path.cwd())))
         else:
             order.append(str(path))
-    
+
     text = ""
     if tool:
         text = f"{os.linesep}No image specified in the fm-tool yml file for {tool.tool}."
@@ -372,6 +370,8 @@ def cli(raw_args: list[str]):
             print(f"  - {prop}")
         return
 
+    print(args)
+
     if not hasattr(args, "TOOL"):
         return help_callback()
 

{fm_weck-0.2.1.dist-info → fm_weck-1.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: fm-weck
-Version: 0.2.1
+Version: 1.1
 Author-email: Henrik Wachowitz <henrik.wachowitz@ifi.lmu.de>
 Maintainer-email: Henrik Wachowitz <henrik.wachowitz@ifi.lmu.de>
 Classifier: Development Status :: 4 - Beta
@@ -24,9 +24,12 @@ SPDX-FileCopyrightText: 2024 Dirk Beyer <https://www.sosy-lab.org>
 SPDX-License-Identifier: Apache-2.0
 -->
 
-# fm-weck - Warp runExec in a container and conserve fm-tools
+# fm-weck: Run formal methods tools in containerized environments
 
-This project builds on Podman. To develop, you need to install Podman.
+fm-weck is a command line tool and library that makes the execution of formal methods tools easy. fm-weck downloads the tools and caches them for later use.
+
+<!-- To get an impression check out the corresponding [FM '24 Paper](https://www.sosy-lab.org/research/pub/2024/). -->
+We provide a tutorial on how to use fm-weck [here](doc/Tutorial.md).
 
 ## Install dependencies
 
@@ -36,19 +39,19 @@ This project builds on Podman. To develop, you need to install Podman.
 sudo apt install podman
 ```
 
-## Core principal of the Project
+## Modes of Operation
 
-There are three modes of operation: `run`, `shell` and `serve`.
+There are three modes of operation: `run`, `shell` and `expert`.
 
-- `run`: executes a single command in the containerized environment of a given verifier, specified through the
-corresponding fm-data YAML file
-- `shell`: enters an interactive shell inside of the container specified by the given verifier
-- `serve`: enables plug-and-play execution of formal methods tools: it 
+- `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
 
-When using any command with the `fm-weck toolname ...` syntax, the tool name is searched in `src/fm_weck/resources/fm_tools`.
+When using any command with the `fm-weck <cmd> toolname ...` syntax, the tool name is searched in `src/fm_weck/resources/fm_tools`.
 During the build process of the `.whl` file for `fm-weck`, the `fm_tools/data` directory is copied to that location.
 When running or developing `fm-weck` from the git repository, the user must make sure that the contents of `fm_tools/data` directory are
 available in the `src/fm_weck/resources/fm_tools` directory.

{fm_weck-0.2.1.dist-info → fm_weck-1.1.dist-info}/RECORD

@@ -1,6 +1,6 @@
-fm_weck/__init__.py,sha256=m3otRQif1qQDymVSbyncWjztSFA--ZqbxOXchpro4ZA,351
+fm_weck/__init__.py,sha256=nN88NCpdZVISleeiEKZNzQIEqfhYGseFqAKRwEWWboo,349
 fm_weck/__main__.py,sha256=E7z4-9t6To3hbIPjRPu6iW17YCrtqpDSbFSpd9pX4NA,350
-fm_weck/cli.py,sha256=op4qCAIWgALLZ0V04X-2-8-zeipKDOGDP3_XmpxB2XM,10821
+fm_weck/cli.py,sha256=b0xU_GBs_7ETRzNfcFBSRfCarVT1Ix8sR0Q7LDLJ0S4,10598
 fm_weck/config.py,sha256=E3TZbUv9za6XkuLTBGeuxUjLqYKW6IIz2i_N-N47DVI,3872
 fm_weck/engine.py,sha256=TIeyCevSjB_PQ5DiYfi7xNjeIRh2CJ636EX5kAY3gKs,7507
 fm_weck/image_mgr.py,sha256=1lddYSVd4-dILfhMjDo87S5wfW7qeefInJpyV0Jao_4,1375
@@ -123,7 +123,7 @@ fm_weck/resources/fm_tools/wasp-c.yml,sha256=NWEb2vpIBu75kZJdEq0am8Mpi2HFu5nhDI1
 fm_weck/resources/fm_tools/wit4java.yml,sha256=SukwwE46DsDmZouAwHhr_aaOjxIaeOrIS7o7P4eDWX0,1243
 fm_weck/resources/fm_tools/witch.yml,sha256=1NtUf5SlXtCTqJZHjENcjqZMMqnKGlb4awSUwBDEvWw,913
 fm_weck/resources/fm_tools/witnesslint.yml,sha256=Y6A2TXPyjVxZ9Fhmyd7GOKY7x1_jXjshvmrIM4uW96A,3085
-fm_weck-0.2.1.dist-info/METADATA,sha256=qFYneg9B4vni0CujuLUsu3wh87ifM-fOItQ2mgn4RNk,2453
-fm_weck-0.2.1.dist-info/WHEEL,sha256=zEMcRr9Kr03x1ozGwg5v9NQBKn3kndp6LSoSlVg-jhU,87
-fm_weck-0.2.1.dist-info/entry_points.txt,sha256=toWpKCSY1u593MPnI_xW5gnwlnkerP4AvmPQ1s2nPgY,50
-fm_weck-0.2.1.dist-info/RECORD,,
+fm_weck-1.1.dist-info/METADATA,sha256=SRWhnPT1nNJfhZAYyv9XoI2OtRzSlUe2aNVV4P3wExY,2742
+fm_weck-1.1.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+fm_weck-1.1.dist-info/entry_points.txt,sha256=toWpKCSY1u593MPnI_xW5gnwlnkerP4AvmPQ1s2nPgY,50
+fm_weck-1.1.dist-info/RECORD,,

{fm_weck-0.2.1.dist-info → fm_weck-1.1.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.24.2
+Generator: hatchling 1.25.0
 Root-Is-Purelib: true
 Tag: py3-none-any