Merge pull request #91 from ku-selene/master

Add Docker Support for BugsInPy

Author: ratnadiraw

Dockerfile

@@ -0,0 +1,21 @@
+FROM python:3.12-slim-trixie
+
+# The installer requires curl (and certificates) to download the release archive
+RUN apt-get update && apt-get install -y --no-install-recommends curl ca-certificates git dos2unix vim
+
+# Download the latest installer
+ADD https://astral.sh/uv/install.sh /uv-installer.sh
+
+# Run the installer then remove it
+RUN sh /uv-installer.sh && rm /uv-installer.sh
+
+# Ensure the installed binary is on the `PATH`
+ENV PATH="/root/.local/bin/:$PATH"
+ENV BUGSINPY_HOME="/home/bugsinpy/"
+ENV PATH="$BUGSINPY_HOME/framework/bin:$PATH"
+
+# Set working directory
+WORKDIR /home
+
+# Default command
+CMD ["bash"]

README.md

@@ -8,6 +8,27 @@ The objective of this work is to support reproducible research on real-world Pyt
 2. Add BugsInPy executables path:
     - `export PATH=$PATH:<bugsinpy_path>/framework/bin`
 
+# Use Docker
+Clone the repository, build the Docker image, and start a container:
+
+```shell
+docker build -t bugsinpy .
+docker run -dt \
+    -v ./framework:/home/bugsinpy/framework \
+    -v ./projects:/home/bugsinpy/projects \
+    -v ./workspace:/home/workspace
+    --name {your_container_name} bugsinpy
+docker exec -it {your_container_name} bash
+```
+Replace `{your_container_name}` with your preferred container name.
+When working inside the container, if you checkout source code to `/home/workspace/`, it will be accessible on your host machine at `./workspace` due to the mounted volume. For example:
+
+```shell
+bugsinpy-checkout -p youtube-dl -v 0 -i 2 -w /home/workspace
+```
+
+This command checks out the specified bug to `/home/workspace` in the container, which corresponds to `./workspace` on your host.
+
 # BugsInPy Command
 Command | Description
 --- | ---