Parameter Miner

Note: The code takes time to finish running

Repos used in testing

• https://github.com/iluwatar/java-design-patterns
• https://github.com/mongodb/mongo-java-driver

Running the Tool

There are two ways to run Parameter Miner:

1. Using Docker (Recommended)
2. Running locally with Python

Method 1: Using Docker

Prerequisites

• Docker installed on your system

Steps

1. Pull the Docker image:

   docker pull marwanwalid5/parameter-miner:latest

2. Run the analysis:

   For Windows (PowerShell):

   docker run -v "${PWD}\result:/app/result" marwanwalid5/parameter-miner:latest "<repository_url>" "result/output.csv"

   For Windows (Command Prompt):

   docker run -v "%cd%\result:/app/result" marwanwalid5/parameter-miner:latest "<repository_url>" "<output_path>"

   For Linux/macOS:

   docker run -v "$(pwd)/result:/app/result" marwanwalid5/parameter-miner:latest "<repository_url>" "<output_path>"

   Replace <repository_url> with the GitHub repository URL you want to analyze.

   Replace <output_path> with the the path and file name you want to save the output to.

Example

docker run -v "${PWD}\result:/app/result" marwanwalid5/parameter-miner:latest "https://github.com/mongodb/mongo-java-driver" "result/output.csv"

Method 2: Running Locally

Prerequisites

• Python installed on your system
• Git installed on your system

Steps

1. Clone the repository:

   git clone https://github.com/MarwanWalid2/miner.git

2. Navigate to project directory:

   cd miner

3. Install dependencies:

   pip install -r requirements.txt

4. Run the code:

   python -m src.main <repository_url> <output_path>

Example

python -m src.main https://github.com/mongodb/mongo-java-driver result/output.csv

Input Parameters

• repository_url: URL of the GitHub repository to analyze
• output_path: Path where the CSV output file will be saved

Output

The tool will generate a CSV file in the specified output path.

The format will be:

Commit SHA,Java File,Old function Signature,New function Signature