fm-weck 1.1.2__py3-none-any.whl → 1.2.0__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.1.2"
+__version__ = "1.2.0"

fm_weck/engine.py

@@ -6,10 +6,12 @@
 # SPDX-License-Identifier: Apache-2.0
 
 import logging
+import shutil
 import subprocess
 from abc import ABC, abstractmethod
 from functools import cached_property, singledispatchmethod
 from pathlib import Path
+from tempfile import mkdtemp
 from typing import List, Optional, Union
 
 from fm_tools.fmdata import FmData, FmImageConfig
@@ -33,10 +35,24 @@ class Engine(ABC):
         self.image = self._initialize_image(image)
         self.extra_args = {}
         self._engine = None
+        self._tmp_output_dir = Path(mkdtemp("fm_weck_output")).resolve()
+
+        self.output_dir = Path.cwd() / "output"
+        self.log_file = None
+
+    def __del__(self):
+        if self._tmp_output_dir.exists():
+            shutil.rmtree(self._tmp_output_dir)
 
     def get_workdir(self):
         return Path("/home/cwd")
 
+    def set_output_log(self, output_log: Path):
+        self.log_file = output_log
+
+    def set_output_files_dir(self, output_log: Path):
+        self.output_dir = output_log
+
     def mount(self, source: str, target: str):
         self.extra_args["mounts"] = self.extra_args.get("mounts", []) + [
             "-v",
@@ -63,11 +79,22 @@ class Engine(ABC):
             f"{Path.cwd().absolute()}:/home/cwd",
             "-v",
             f"{Config().cache_location}:/home/weck_cache",
+            "-v",
+            f"{self._tmp_output_dir}:/home/output",
             "--workdir",
             str(self.get_workdir()),
             "--rm",
         ]
 
+    def _move_output(self):
+        if not self.output_dir.exists():
+            self.output_dir.mkdir()
+        for file in self._tmp_output_dir.iterdir():
+            if file.is_file():
+                shutil.copy(file, self.output_dir / file.name)
+            elif file.is_dir():
+                shutil.copytree(file, self.output_dir, dirs_exist_ok=True)
+
     def assemble_command(self, command: tuple[str, ...]) -> list[str]:
         base = self.base_command()
         if self.add_benchexec_capabilities:
@@ -219,10 +246,16 @@ class Engine(ABC):
 
             return tag
 
-    @staticmethod
-    def _run_process(command: tuple[str, ...] | list[str]):
-        process = subprocess.Popen(command)
-        process.wait()
+    def _run_process(self, command: tuple[str, ...] | list[str]):
+        if self.log_file is None:
+            process = subprocess.Popen(command)
+            process.wait()
+            return
+
+        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()
 
     def run(self, *command: str) -> None:
         if self.image is None:
@@ -231,6 +264,7 @@ class Engine(ABC):
         command = self.assemble_command(command)
         logger.info("Running: %s", command)
         self._run_process(command)
+        self._move_output()
 
 
 class Podman(Engine):
@@ -305,6 +339,8 @@ class Docker(Engine):
             f"{Path.cwd().absolute()}:/home/cwd",
             "-v",
             f"{Config().cache_location}:/home/weck_cache",
+            "-v",
+            f"{self._tmp_output_dir}:/home/output",
             "--workdir",
             str(self.get_workdir()),
             "--rm",

fm_weck/resources/run_with_overlay.sh

@@ -22,10 +22,8 @@ cp -r "/home/weck_cache/$TOOL_DIR" /tmp/overlay/
 mount -t overlay overlay -o lowerdir=/home/cwd:/tmp/overlay/"$TOOL_DIR",upperdir=/tmp/overlay/upper,workdir=/tmp/overlay/work /home/_cwd
 cd /home/_cwd && "$@"
 
-# Copy the output from the tool back to the users cwd
-[ ! -d /home/cwd/output ] && mkdir /home/cwd/output
-
+# Fm-Weck mounts a tempdir to /home/output
 # Test if upper is empty
 if [ ! -z "$(ls -A /tmp/overlay/upper)" ]; then
-    cp -r /tmp/overlay/upper/* /home/cwd/output
+    cp -r /tmp/overlay/upper/* /home/output
 fi

fm_weck/serve.py

@@ -11,7 +11,7 @@ import os
 import shutil
 import sys
 from pathlib import Path
-from typing import Optional, Tuple
+from typing import Optional, Tuple, Union
 
 from fm_tools import FmData
 from fm_tools.benchexec_helper import DataModel
@@ -55,9 +55,11 @@ def update_checksum(shelve_space: Path, checksum: str, config: Config):
 
 
 def setup_fm_tool(
-    fm_tool: Path, version: Optional[str], configuration: Config, skip_download: bool = False
+    fm_tool: Union[Path, FmData], version: Optional[str], configuration: Config, skip_download: bool = False
 ) -> Tuple[FmData, Path]:
-    fm_data = parse_fm_data(fm_tool, version)
+    # Don't explicitly disallow non-FmData here; Pythonic Users might want to exchange the FmData 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
 
     shelve_space = configuration.get_shelve_space_for(fm_data)
     logger.debug("Using shelve space %s", shelve_space)
@@ -78,7 +80,7 @@ def setup_fm_tool(
 
 
 def run_guided(
-    fm_tool: Path,
+    fm_tool: Union[Path, FmData],
     version: Optional[str],
     configuration: Config,
     prop: Optional[Path],
@@ -86,6 +88,8 @@ def run_guided(
     additional_args: list[str],
     data_model: Optional[DataModel] = None,
     skip_download: bool = False,
+    log_output_to: Optional[Path] = None,
+    output_files_to: Optional[Path] = None,
 ):
     property_path = None
     if prop is not None:
@@ -104,6 +108,12 @@ def run_guided(
     fm_data, shelve_space = setup_fm_tool(fm_tool, version, configuration, skip_download)
     engine = Engine.from_config(fm_data, configuration)
 
+    if log_output_to is not None:
+        engine.set_output_log(log_output_to)
+
+    if output_files_to is not None:
+        engine.set_output_files_dir(output_files_to)
+
     current_dir = Path.cwd().resolve()
     os.chdir(shelve_space)
     command = fm_data.command_line(
@@ -123,7 +133,11 @@ def run_guided(
 
 
 def run_manual(
-    fm_tool: Path, version: Optional[str], configuration: Config, command: list[str], skip_download: bool = False
+    fm_tool: Union[Path, FmData],
+    version: Optional[str],
+    configuration: Config,
+    command: list[str],
+    skip_download: bool = False,
 ):
     fm_data, shelve_space = setup_fm_tool(fm_tool, version, configuration, skip_download)
     engine = Engine.from_config(fm_data, configuration)

{fm_weck-1.1.2.dist-info → fm_weck-1.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: fm-weck
-Version: 1.1.2
+Version: 1.2.0
 Author-email: Henrik Wachowitz <henrik.wachowitz@ifi.lmu.de>
 Maintainer-email: Henrik Wachowitz <henrik.wachowitz@ifi.lmu.de>
 Classifier: Development Status :: 4 - Beta

{fm_weck-1.1.2.dist-info → fm_weck-1.2.0.dist-info}/RECORD

@@ -1,13 +1,13 @@
-fm_weck/__init__.py,sha256=1E-Lg-govulF5LWnCDMllOTz1s69LYKB4s0zfiimigk,351
+fm_weck/__init__.py,sha256=GbTdG1r5vnEJc4b9I0Xwyxgg70ktYxl8SzTrO61ssgM,351
 fm_weck/__main__.py,sha256=E7z4-9t6To3hbIPjRPu6iW17YCrtqpDSbFSpd9pX4NA,350
 fm_weck/cli.py,sha256=eeL3GbYO6W5af47ZgIR0mKYug0OrFsJn0Md1aVLDITI,10582
 fm_weck/config.py,sha256=6f4R-iWmWehHghuhoU-UyCpNotYFec_oDelJB4A15BQ,4861
-fm_weck/engine.py,sha256=nstV_H_vhBbBUik95mUotcaPQLsRiTu92YgrWmKJgeM,10102
+fm_weck/engine.py,sha256=OTTP3r-2xQx1GHpcepbVwR8iJuYK-cqux6cXCF9P_aU,11366
 fm_weck/image_mgr.py,sha256=kZxcZaMiv5orWO7bLsN7xaQRXjof8uOGud7sb57ZvRo,1655
-fm_weck/serve.py,sha256=DpeAbq1A2mV7uuKZnPOUF4hjbilxaLAJtnLiz_Q0Erw,4646
+fm_weck/serve.py,sha256=hZc30B7EO0agetEHlKnRdNoMsK_FXuzvdIS6hhhzJgM,5166
 fm_weck/resources/Containerfile,sha256=MltxP1of9klsQFNR8WyngRTJrPwxQTF4C9ennRxVqSo,391
 fm_weck/resources/__init__.py,sha256=ewuOXBraX5Tb8XkWE6xrv0cwrxG4r5Ckj5n_tRjeRf4,946
-fm_weck/resources/run_with_overlay.sh,sha256=IOonRSjdoNoMj0tcrdZvqO-x6WZldjpOetvssP6qbSM,872
+fm_weck/resources/run_with_overlay.sh,sha256=IHuxwx5Ri32oGGxku4etcg0kIu2N8BvTpOB6q4MaErM,804
 fm_weck/resources/properties/coverage-branches.prp,sha256=Gl2r1cgBFoh4M2laa8dVGhteHkL04oiBRLzxz_hbkEU,56
 fm_weck/resources/properties/coverage-branches.prp.license,sha256=KzWZF1bpljIbdvwfzfWoP4DLMq6W1jXNN6WXWF0fxY0,214
 fm_weck/resources/properties/coverage-conditions.prp,sha256=tj307UJBhj-PZqRxjijeNb0foWe2hWIc8CQP54gIUao,57
@@ -124,7 +124,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=5d5aYmkrlG78M-RLdDbdi6EJWOfD0CskWtJWGXtwEyI,1152
 fm_weck/resources/fm_tools/witnesslint.yml,sha256=Y6A2TXPyjVxZ9Fhmyd7GOKY7x1_jXjshvmrIM4uW96A,3085
-fm_weck-1.1.2.dist-info/METADATA,sha256=yR302Kub6tHGgbImtPQaOupb1zCRy2HTF5Nme-GH09I,2771
-fm_weck-1.1.2.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-fm_weck-1.1.2.dist-info/entry_points.txt,sha256=toWpKCSY1u593MPnI_xW5gnwlnkerP4AvmPQ1s2nPgY,50
-fm_weck-1.1.2.dist-info/RECORD,,
+fm_weck-1.2.0.dist-info/METADATA,sha256=GWtHnf8JK9-H-JDjn4Obp0ui_R3w5HODiZyJDT-7v6E,2771
+fm_weck-1.2.0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+fm_weck-1.2.0.dist-info/entry_points.txt,sha256=toWpKCSY1u593MPnI_xW5gnwlnkerP4AvmPQ1s2nPgY,50
+fm_weck-1.2.0.dist-info/RECORD,,