Implementation of a bot that performs automatic refactorings based on the results of static code analysis. The changes are made available to the developers as pull requests for easy review. It is possible to interact with the bot through natural language line comments in the proposed pull requests.
- Refactoring-Bot/Refactoring-Bot contains the backend functionality for the interaction between bot, web-based hosting service for version control and static analysis tools, as well as the technical implementation of the automatic refactoring of code smells. It is a Spring Boot application providing a Swagger UI to interact with its REST API resources.
- Refactoring-Bot/Refactoring-Bot-UI is a web frontend (under development) to conveniently configure and manage the Refactoring-Bot.
- Refactoring-Bot/Bot-Playground contains exactly one example per code smell that the bot can (soon) automatically fix. At present, these are exclusively findings of SonarQube.
- Refactoring-Bot/Docker contains everything for installing the Refactoring-Bot via Docker.
Before you can use the bot locally, the following steps need to be executed.
- The bot needs access to a MySQL DB instance to save its data. Use an existing one, download MySQL for your OS, or create a docker container via
docker run --name refactoring-bot-db -p 3306:3306 -e MYSQL_ROOT_PASSWORD=root -d mysql:latest. - In this MySQL instance, you need to create a schema with the name
refactoringbot_dband make sure the user for the bot has access rights to this schema. - Copy the configuration file
src/main/resources/application_example.ymland rename it tosrc/main/resources/application.yml. In this new file, potentially change thedatasourceattributes depending on your MySQL instance. - Execute the command
mvn installto create the executable JAR file for the bot. - Run the created JAR file via
java -jar ./target/RefactoringBot-0.0.1-SNAPSHOT.jar. The API should now be available athttp://localhost:8808and the SwaggerUI will open in the browser.
Docker Support: Please refer to our Docker Repository for detailed usage instructions with docker or docker-compose.
We are happy about any kind of contribution which can improve the Refactoring-Bot. Feature requests, bug reports and questions can be created informally via Issues. To contribute a change to the source code, just have a look at our contributing guidelines. Please make sure you have created an issue on your change beforehand. This way, we try to avoid unnecessary effort or multiple people doing the same revision at the same time.