Skip to main content

A tool for cloning and testing repositories (docker or local, interface is the same).

Project description

repotest

A library for automating test execution and repository operations.

It simplifies working with Docker and local repositories and provides utilities for managing patches and tests.

Originally built to facilitate LLM generation testing at the repository level, aimed at easing workflows for data scientists.


Installation

  1. Install the latest version using pip:
pip install repositorytest
  1. To run the project in debug mode, add the current folder to the Python path:
import sys
sys.path.append("/path/to/repotest")
  1. Check which modes work on your current machine:
from repotest.scripts import check_perfomance

Design

The following diagram shows the architecture of the project and how different components interact:


How to Clean All Caches

from repotest.utils.clean import remove_all_containers, remove_all_images, clean_all, ...

Example Usage

The project supports two execution modes: Docker-based and local.

Using Docker:

from repotest.core.docker.java import JavaDockerRepo 

repo = JavaDockerRepo(
    repo="Osiris-Team/SPPU",
    base_commit="1a86a84e3c2dd7446b4778db8bb5dbaf44944f1c",
    image_name="maven:3.9.9-eclipse-temurin-23-alpine"
)

repo.clean()  # Reset the repo folder to the base commit state
# repo.build_env("", timeout=60*5)  # Set up the environment
# repo.apply_patch(patch)  # Apply a patch to the repo
repo.run_test("mvn test", timeout=60*5)  # Run tests with a 5-min timeout

Using Local Filesystem:

from repotest.core.local.java import JavaLocalRepo

repo = JavaLocalRepo(
    repo="Osiris-Team/SPPU",
    base_commit="1a86a84e3c2dd7446b4778db8bb5dbaf44944f1c",
)

repo.clean()  # Reset the repo folder to the base commit state
# repo.build_env("", timeout=60*5)
# repo.apply_patch(patch)
repo.run_test("mvn test", timeout=60*5)

The interface for *Repo classes is the same across modes.

The only difference is that JavaDockerRepo allows specifying an image and cache volumes. By default, Maven cache is stored in a Docker volume.


Creating Git Patches for Java Projects

The following code generates a git patch from changes in the repository:

from repotest.utils.git.git_diff_wrapper import GitDiffWrapper

changer = GitDiffWrapper(
    repo=task['repo_name'], 
    base_commit=task['base_commit']
)

changer.change_test(
    fn_test=task['test_file'], 
    str_test=task['output'], 
    str_source=task['source_code']
)

changer.fix_pom_file()
patch = changer.git_diff()

Logs

All logs are saved to: repotest/logs/%Y-%m-%d.log Only critical logs are printed to stdout by default.

To increase verbosity and print logs to stdout:

from repotest.logger import change_console_logger_level
from logging import DEBUG

change_console_logger_level(DEBUG)

Build the Package from Source

To build the package from source:

python -m build

Run Tests

Tests follow the same file structure as the main library. To run them (takes ~1–2 minutes):

pytest tests

Dataset Overview

All datasets used for testing the library are stored in ../datasets/*.json. Example of how to load one:

from datasets import load_dataset
ds = load_dataset('json', data_files="../datasets/java_from_1_2k_from_parser.jsonl")

Enable/Disable Stdout Logs

By default, logs are stored in ~/.cache/repotest/logs/{date}.log.

To toggle stdout logging:

from repotest.constants import enable_stdout_logs, disable_stdout_logs

enable_stdout_logs()
disable_stdout_logs()

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

repositorytest-0.5.0.tar.gz (47.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

repositorytest-0.5.0-py3-none-any.whl (66.6 kB view details)

Uploaded Python 3

File details

Details for the file repositorytest-0.5.0.tar.gz.

File metadata

  • Download URL: repositorytest-0.5.0.tar.gz
  • Upload date:
  • Size: 47.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.5

File hashes

Hashes for repositorytest-0.5.0.tar.gz
Algorithm Hash digest
SHA256 861cbdf9a23bda1acf39c0c8256b5ebd893103f71aaa08225437ed6e1816dca0
MD5 d7929d7531f890789f2092acac2d97f2
BLAKE2b-256 fae5f25905c39244334ea79abddddc9921a666e5b654508989a900b7d9cbf1ec

See more details on using hashes here.

File details

Details for the file repositorytest-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: repositorytest-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 66.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.5

File hashes

Hashes for repositorytest-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1083a61c50afa30bbd501fd65caf0d6e5ce6873d55eac8ddb5d90a04f50dc46d
MD5 af9501564622989e6d46925baa5accfd
BLAKE2b-256 c73d17533a623af8390c2b91fa7a510af985251398eb7ed8d4f0f8fa834b25da

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page