Add competition template

Author: tamarinvs19

.gitignore

@@ -0,0 +1,2 @@
+__pycache__/
+/results/

README.md

@@ -1,2 +1,41 @@
-# UTBotPythonSBFT2024
-UTBot-Python-SBFT-Competitions-2024
+# Python Tool Competition Implementation Using UTBotPython
+
+Uses the python-tool-competition-2024 to generate tests using the UTBotPython.
+
+For more information see
+<https://github.com/ThunderKey/python-tool-competition-2024/>.
+
+## Requirements
+
+* Python 3.11, implementation: CPython
+* poetry
+* OS: Linux
+* Java 17, accessible in command line under name `java`
+* glibc>=2.31
+
+## Installation
+
+* Install [poetry](https://python-poetry.org/)
+* Run `poetry install`
+
+### Check the installation success
+* Run `poetry check`, this command runs simple test generation and shows error messages
+* Successful logger messages should end with the following lines:
+```
+Exit status: 0
+............ | INFO  | GlobalPythonEngine | Symbolic: stop receiver
+............ | INFO  | PythonTestCaseGenerator | Collect all test executions for some_method
+............ | INFO  | SbftGenerateTestsCommand | Saving tests...
+```
+
+## Development
+
+The entry point called by `python-tool-competition-2024` is the `build_test`
+method in `utbot_python_sbft_2024/generator.py`.
+
+## Calculating Metrics
+
+Run `poetry run python-tool-competition-2024 run utbot-python`.
+
+With `poetry run python-tool-competition-2024 run -h` you can find out what
+generators were detected.

poetry.lock

@@ -0,0 +1,27 @@
+[tool.poetry]
+name = "python-tool-competition-2024-utbot_python"
+version = "0.1.0"
+description = "Python Tool Competition 2024 implementation using UTBotPython"
+authors = ["Vyacheslav Tamarin, Ekaterina Tochilina"]
+license = "Apache 2.0"
+readme = "README.md"
+packages = [{include = "python_tool_competition_2024_utbot_python"}]
+
+[tool.poetry.dependencies]
+python = "^3.11"
+python-tool-competition-2024 = "^0.2.0"
+utbot-executor = "1.9.2"
+utbot-mypy-runner = "0.2.15"
+utbot_dist = [
+    { url = "https://github.com/UnitTestBot/UTBotPythonSBFT2024/releases/download/v1/utbot_dist-0.1.0-py3-none-manylinux_2_31_x86_64.whl", platform = "linux" }
+]
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry.plugins."python_tool_competition_2024.test_generators"]
+utbot-python = "python_tool_competition_2024_utbot_python.generator:UTBotPythonTestGenerator"
+
+[tool.poetry.scripts]
+check = "python_tool_competition_2024_utbot_python.check_usvm:main"

pyproject.toml

@@ -0,0 +1,5 @@
+from python_tool_competition_2024_utbot_python.generator import UTBotPythonTestGenerator
+
+
+def check_usvm():
+    UTBotPythonTestGenerator.check_run()

python_tool_competition_2024_utbot_python/__init__.py

@@ -0,0 +1,12 @@
+import pathlib
+import site
+import sys
+
+
+class UTBotPythonConfig:
+    JAVA_PATH = "java"
+    SITE_DIR = pathlib.Path(site.getsitepackages()[0])
+    JAR_FILE = SITE_DIR / "utbot_dist" / "utbot-cli-python-2023.11-SNAPSHOT.jar"
+    USVM_PATH = SITE_DIR / "utbot_dist" / "usvm-python"
+    PYTHON_PATH = sys.executable
+    TIMEOUT = 90_000

python_tool_competition_2024_utbot_python/check_usvm.py

@@ -0,0 +1,137 @@
+"""A test generator using UTBotPython."""
+import pathlib
+import site
+import subprocess
+import sys
+import tempfile
+import time
+
+import rich
+from python_tool_competition_2024.config import get_config, GeneratorName
+from python_tool_competition_2024.generation_results import (
+    TestGenerationFailure,
+    TestGenerationResult,
+    TestGenerationSuccess,
+    FailureReason,
+)
+from python_tool_competition_2024.generators import FileInfo, TestGenerator
+
+from python_tool_competition_2024_utbot_python.config import UTBotPythonConfig
+
+GENERATION_TIMES: list[float] = []
+
+
+class UTBotPythonTestGenerator(TestGenerator):
+    """A test generator using UTBotPython."""
+
+    def build_test(self, target_file_info: FileInfo) -> TestGenerationResult:
+        """
+        Generate a test for the specific target file.
+
+        Args:
+            target_file_info: The `FileInfo` of the file to generate a test for.
+
+        Returns:
+            Either a `TestGenerationSuccess` if it was successful, or a
+            `TestGenerationFailure` otherwise.
+        """
+        return _build_test(target_file_info)
+
+    @staticmethod
+    def check_run() -> None:
+        """
+        Try to run UTBotPython and shows error message.
+        """
+        target_file_info = FileInfo(
+            pathlib.Path("./targets/example1.py").resolve().absolute(),
+            "example1",
+            get_config(
+                GeneratorName("UTBotPython"),
+                pathlib.Path("./targets/").resolve().absolute(),
+                pathlib.Path("").absolute(),
+                rich.console.Console(),
+                show_commands=True,
+                show_failures=True,
+            ),
+        )
+        _build_test(target_file_info, check_usvm=True)
+
+
+def _build_test(
+    target_file_info: FileInfo, check_usvm: bool = False
+) -> TestGenerationResult:
+    if not sys.platform.startswith("linux"):
+        sys.stderr.write("ERROR: This script works only on Linux\n")
+        exit(1)
+
+    sys_paths = [target_file_info.config.targets_dir]
+
+    with tempfile.TemporaryDirectory() as tempdir:
+        output_dir = pathlib.Path(tempdir)
+        module_name = target_file_info.module_name.replace(".", "_")
+        output_file = output_dir / f"test_{module_name}.py"
+        _run_utbot(
+            target_file_info.absolute_path,
+            sys_paths,
+            output_file,
+            UTBotPythonConfig.JAR_FILE,
+            UTBotPythonConfig.USVM_PATH,
+            UTBotPythonConfig.TIMEOUT,
+            UTBotPythonConfig.PYTHON_PATH,
+            UTBotPythonConfig.JAVA_PATH,
+            check_usvm=check_usvm,
+        )
+
+        utbot_tests = _read_generated_tests(str(output_file))
+        if utbot_tests == "":
+            return TestGenerationFailure(tuple(), FailureReason.NOTHING_GENERATED)
+
+        return TestGenerationSuccess(utbot_tests)
+
+
+def _run_utbot(
+    source_file: pathlib.Path,
+    sys_paths: list[pathlib.Path],
+    output_file: pathlib.Path,
+    jar_path: pathlib.Path,
+    usvm_dir: pathlib.Path,
+    timeout: int,
+    python_path: str,
+    java_cmd: str,
+    check_usvm: bool = False,
+):
+    command = (
+        f"{java_cmd} -jar {jar_path}"
+        f" generate_python {source_file}"
+        f" -p {python_path}"
+        f" -o {output_file}"
+        f" -s {','.join(map(str, sys_paths))}"
+        f" -t {timeout}"
+        f" --java-cmd {java_cmd}"
+        f" --usvm-dir {usvm_dir}"
+        f" --runtime-exception-behaviour PASS"
+        f" --prohibited-exceptions -"
+    )
+    if check_usvm:
+        command += " --check-usvm"
+
+    print(command)
+    start = time.time()
+
+    p = subprocess.Popen(command.split(), close_fds=True)
+    while p.poll() is None:
+        time.sleep(1)
+
+    cur_time = time.time() - start
+    GENERATION_TIMES.append(cur_time)
+    print("Process finished in", cur_time)
+    print("Mean time:", sum(GENERATION_TIMES) / len(GENERATION_TIMES))
+    print("Max time:", max(GENERATION_TIMES))
+
+
+def _read_generated_tests(output_file: str) -> str:
+    try:
+        with open(output_file, "r") as f:
+            return f.read()
+    except:
+        return ""

python_tool_competition_2024_utbot_python/config.py

@@ -0,0 +1,16 @@
+"""First example file."""
+
+
+def some_method(number: int) -> str:
+    """Return a string of the manipulated number."""
+    if number > 0:
+        return f"{number * 5}"
+    return f"{number - 3}"
+
+
+def other_method(number: int) -> int:
+    """Return the number calculated by a for loop."""
+    total = 0
+    for i in range(number):
+        total += i
+    return total

python_tool_competition_2024_utbot_python/generator.py

@@ -0,0 +1,6 @@
+"""Second example file."""
+
+
+def my_method(n: int) -> int:
+    """Calculate the square."""
+    return n**2

targets/__init__.py

@@ -0,0 +1,10 @@
+"""The sub example pacakge."""
+
+from __future__ import annotations
+
+
+def helper(text: str) -> str | None:
+    """Add an exclamation mark if the text is not empty, `None` otherwise."""
+    if text:
+        return text + "!"
+    return None

targets/example1.py

@@ -0,0 +1,7 @@
+"""Third example file."""
+
+
+def example(text: str) -> str:
+    """Return an extended string."""
+    result = f"Got: {text}"
+    return result + "!"

targets/example2.py

@@ -0,0 +1,25 @@
+import gzip
+
+
+def compress_string(s):
+    """
+    Compress a string using gzip.
+
+    :param s: String to be compressed
+    :type s: str
+    :return: Compressed string
+    :rtype: bytes
+    """
+    return gzip.compress(s.encode("utf-8"))
+
+
+def decompress_string(compressed):
+    """
+    Decompress a gzipped string.
+
+    :param compressed: Compressed string
+    :type compressed: bytes
+    :return: Decompressed string
+    :rtype: str
+    """
+    return gzip.decompress(compressed).decode("utf-8")