Command Line Interface | IntelliJ Plugin
Ci Assistant for Efficient (Build Failure) Summarization And Resolution
Helps fixing broken builds by downloading and summarizing build logs.
CAESAR connects to a build server and shows all executed builds to the user. By selecting one of the builds the corresponding build log is downloaded, parsed, and summarized. The user then gets a summary of the build's execution like information about it's status (successful or not) or possible errors. Every failed build gets classified (e.g. dependency, compilation, or test issues) and occurred errors are listed with information about their location (file and line/column). If the user decides to fix the build failure, uncommitted changes get saved automatically and the code base causing the build failure is downloaded and checked out. The user may now debug and fix the errors, merge the applied changes to whatever branch he wants, push the changes to the remote repository the build server monitors, reapply the previously saved changes, and continue working where he stopped.
Currently CAESAR supports projects developed with Git and Maven using TeamCity as a build server. Although the classification of build failures works for numerous types of errors, the error detection and localization is only implemented for basic errors concerning dependency issues, compilation errors, and failing tests.
To better understand how CAESAR is built, take a look at the architecture image and the modules table below and explore the different modules in the order they are listed in the table.
Built on top of this project there is a IntelliJ Plugin.
The following visualization shows how the different modules of this project and externally provided sources interact. A more detailed overview on how CAESAR operates is given here.
This project contains the following modules:
| Module | Purpose |
|---|---|
| Build Server Type | Represents different types of build servers (e.g. TEAM_CITY). Needed to set the api used to access the information on the build server and to set the parser for parsing the build log. |
| Build Server Model | Represents the data of a build server. This includes information about projects, build configurations, and executed builds. Needed to map the data from any build server to a common model to later present it to the user which then selects an executed build to get a summarization. |
| Build Model | Represents the data of a build of a build server. Needed to map all information out of a build log to a common model to later extract specific information about the build and the maven build log. |
| Maven Model | Represents the data of a maven build. Needed to map all information out of a maven build log to a common model to later extract specific information about the build and certain parts of the build log to locate and classify the error caused a possible build failure. |
| Error Model | Represents an error occurred in a particular file. Needed to map information about the location of an error (file, line, column) to a common model and present it to the user. |
| Build Server API | Maps data from the build server to the Build Server Model and downloads build logs. |
| Git API | Connects to a local git repository and offers basic git commands to save the current state of work before starting to fix the build failure and access the code base caused the build failure. |
| Build Server Build Log Parser | Parses a build log of a build server and maps the data to the Build Model. |
| Maven Build Log Parser | Parses a maven build log and maps the data to the Maven Model. |
| Maven Goal Log Parser | Parses the log of a Maven goal execution and maps information about errors and in which file and on which line and column they happened to the error-model. |
| Maven Goal Classifier | Classifies a maven goal into one of 13 categories. |
| CAESAR | Assists in fixing build failures by downloading a build log, parsing and summarizing it, reporting its status and possible errors, stashing open local changes, checking out the failed version, providing hints on where possible errors happened, and let the user fix the error. |
This projects contains the following projects either developed by others or just managed in a separate repository:
| Project | Purpose |
|---|---|
| RegEx Matcher | Used to check whether a String matches a regular expression and to extract defined components of the String. |
| Java Stack Trace Parser | Used to parse a java stack trace and map every line to a java.lang.StackTraceElement to access information about where a error happened (e.g. method name and line number). |
| JGit | Used to access and modify git repositories. |
| TeamCity Rest Client | Used to retrieve data from a TeamCity build server. |
- Alex Scheitlin - Initial work - alexscheitlin
This project is licensed under the MIT License.