Update Testing confg and add search sub-dir testcases

.github/workflows/docker_build.yaml

@@ -0,0 +1,28 @@
+name: Build Docker Image
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  docker_build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Build docker image
+      run: docker build -f Dockerfile.minimal -t acr .
+
+    - name: Start docker image (background)
+      run: docker run --name acr-pytest -t -d acr 
+
+    # Due to diffuculties with `conda activate` in docker, we do `conda run` while specifying the environment
+    # setting cov-report to term and xml -> outputs coverage report to terminal, and an xml file inside the container
+    - name: Run PyTest with Coverage (inside docker)
+      run: docker exec acr-pytest conda run --no-capture-output -n auto-code-rover pytest --cov=app test/ --cov-report=term --cov-report=xml

.github/workflows/pytest.yml

@@ -41,7 +41,7 @@ jobs:
         run: conda install -y tox
 
       - name: Run tox tests
-        run: tox -e py
+        run: tox
 
       - name: Check Coverage Report Exists
         run: |

README.md

@@ -338,6 +338,10 @@ The current list of supported models:
 
 Please refer to [EXPERIMENT.md](EXPERIMENT.md) for information on experiment replication.
 
+## Testing
+
+Please refer to [TESTING.md](TESTING.md) for information on setting up and running tests.
+
 ## ✉️ Contacts
 
 For any queries, you are welcome to open an issue.

TESTING.md

@@ -11,16 +11,34 @@ The testing suite uses the following libraries and tools:
 - Pytest, to execute the tests
 - Coverage, (the Coverage.py tool) to measure the code coverage
 
-In the `auto-code-rover` environment, install the required libraries by running the following command:
+In the `auto-code-rover` environment, add `conda-forge` as a channel, then install the required libraries by running the following command:
 
 ```bash
+conda config --add channels conda-forge
 conda install -y tox
 ```
 
-and execute the tox commands (configured in `tox.ini`) to run the tests:
+## Running the tests locally
+
+To run the tests, execute the `tox` command (you can view the configurations in `tox.ini`) to run the tests:
+
+```bash
+tox
+```
+
+Alternatively, command to activate the `auto-code-rover` environment and run the tests:
 
 ```bash
-tox -e py
+conda activate auto-code-rover && tox
 ```
 
-The test results and the test coverage report will be displayed in the terminal, with a `coverage.xml` file in the Cobertura format generated in the project's root directory.
+The test results and the test coverage report will be displayed in the terminal, with a `coverage.xml` file in the Cobertura format generated in the project's root directory.
+
+## Modifying the `tox.ini` file
+
+To enable missing statement coverage, add the following section the `tox.ini` file:
+
+```ini
+[coverage:report]
+show_missing = True
+```

app/data_structures.py

@@ -51,7 +51,7 @@ def __init__(
         )
 
     def __str__(self):
-        return f"Call function `{self.func_name}` with arguments {self.arg_values}."
+        return f"FunctionCallIntent(func_name={self.func_name}, arguments={self.arg_values})"
 
     def to_dict(self):
         return {"func_name": self.func_name, "arguments": self.arg_values}

app/search/search_utils.py

@@ -340,11 +340,11 @@ def get_code_region_around_line(
 
     # start and end should also be 1-based valid line numbers
     start = max(1, line_no - window_size)
-    end = min(len(file_content), line_no + window_size)
+    end = min(len(file_content) + 1, line_no + window_size)
     snippet = ""
     for i in range(start, end):
         if with_lineno:
             snippet += f"{i} {file_content[i - 1]}"
         else:
-            snippet += file_content[i]
+            snippet += file_content[i - 1]
     return snippet

test/app/agents/test_agent_common.py

@@ -1,4 +1,3 @@
-import pytest
 from app.data_structures import MessageThread
 from app.agents.agent_common import replace_system_prompt, InvalidLLMResponse
 

test/app/agents/test_agent_search.py

@@ -1,5 +1,4 @@
 from unittest.mock import patch, MagicMock
-import pytest
 from collections.abc import Generator
 
 from app.agents.agent_search import (