The Inspections (IntelliJ IDEA) Build Runner is intended to run code analysis based on IntelliJ IDEA inspections for your project. Since TeamCity 2017.1, in addition to the bundled version, it is possible to install another version of JetBrains IntelliJ Inspections and Duplicates Engine and/or change the defaults using the Administration | Tools page.
- Find probable bugs
- Locate "dead" code
- Detect performance issues
- Improve the code structure and maintainability
- Ensure the code conforms to guidelines, standards and specifications
Refer to IntelliJ IDEA documentation for more details.
This page contains reference information about the following Inspections (IntelliJ IDEA) Build Runner fields:
IntelliJ IDEA Project Settings
Project file type
To be able to run IntelliJ IDEA inspections on your code, TeamCity requires either an IntelliJ IDEA project file\directory, Maven pom.xml or Gradle build.gradle to be specified here.
Path to the project
Depending on the type of project selected in the Project file type, specify here:
Detect global libraries and module-based JDK in the *.iml files
This option is available if you use an IntelliJ IDEA project to run the inspections. In IntelliJ IDEA, the module settings are stored in *.iml files, thus, if this option is checked, all the module files will be automatically scanned for references to the global libraries and module JDKs when saved. This helps ensure that all references will be properly resolved.
This option is available if you use an IntelliJ IDEA project to run the inspections. Click this button to reparse your IntelliJ IDEA project and import the build settings right from the project, for example the list of JDKs.
Unresolved Project Modules and Path Variables
This section is displayed when an IntelliJ IDEA module file (.iml) referenced from an IntelliJ IDEA project file:
- cannot be found
- allows you to enter the values of path variables used in the IPR-file.
To refresh the values in this section, click Check/Reparse Project.
This field appears if the project file contains path macros, defined in the Path Variables dialog of IntelliJ IDEA's Settings dialog. In Set value to field, specify a path to the project resources to be used on different build agents.
This section provides the list of SDKs detected in the project.
Use this field to specify the JDK home for the project.
JDK Jar File Patterns
Click this link to open a text area where you can define templates for the jar files of the project JDK. Use Ant rules to define the jar file patterns.
For Mac OS X, use the following lines:
If your project uses the IDEA JDK, specify the location of the IDEA home directory
IDEA Jar Files Patterns
Click this link to open a text area, where you can define templates for the jar files of the IDEA JDK.
Select a JDK. This section details the available options. The default is JAVA_HOME environment variable or the agent's own Java.
JDK home path
The option is available when <Custom> is selected above. Use this field to specify the path to your custom JDK used to run the build. If the field is left blank, the path to JDK Home is read either from the JAVA_HOME environment variable on agent the computer, or from the env.JAVA_HOME property specified in the build agent configuration file (buildAgent.properties). If these values are not specified, TeamCity uses the Java home of the build agent process itself.
JVM command line parameters
You can specify such JVM command line parameters, e.g. maximum heap size or parameters enabling remote debugging. These values are passed by the JVM used to run your build.
In IntelliJ IDEA-based IDEs, the code inspections reported are configured by an inspection profile.
When running the inspections in TeamCity, you can specify the inspection profile to use: first you need to configure the inspection profile in IntelliJ IDEA-based IDE and then specify it in TeamCity.
Follow these rules when preparing inspection profiles:
- if your inspection profile uses scopes, make sure the scopes are shared;
- lock the profile (this ensures that inspections present in TeamCity but not enabled in your IDEA installation will not be run by TeamCity);
- ensure the profile does not have inspections provided by plugins not included into the default IntelliJ IDEA Ultimate distribution (otherwise they will just be ignored by TeamCity);
- for best results, edit the inspection profile in the IntelliJ IDEA of the same version as used by TeamCity (can be looked up in the inspection build log).
The logic of selecting an inspection profile is as follows:
- if the path to the inspection profile is specified, then the profile will be loaded from the file. If the loading fails, the inspection runner will fail too.
- if the name of the inspection profile is specified, the profile is searched for in the project's shared profiles. If there is no such profile, the inspection runner will fail.
- if neither the name nor path is specified, the default profile of the project is used.
Inspections profile path
Use this text field to specify the path to inspections profiles file relative to the project root directory. Use this field only if you do not want to use the shared project profile specified in "Inspections profile name".
Inspections profile name
Enter the name of the desired shared project profile. If the field is left blank and no profile path is specified, the default project profile will be used.
Include / exclude patterns:
Optional, specify to restrict the sources scope to run Inspections on.
For Maven inspections run, to ensure correct Java is used for the project JDK, define
env.JAVA_HOME configuration parameter pointing to the JDK to be used as the project JDK.
Getting the same results in IntelliJ IDEA and TeamCity Inspections Build
The code inspections reported by IntelliJ IDEA and TeamCity Java Code Inspections build depend on a number of factors. You would need to ensure equal settings in IntelliJ IDEA and the build to get the same reports.
The relevant settings include:
- inspections profile used in IntelliJ IDEA and TeamCity build;
- environment-specific project dependencies (files not in version control, etc.);
- IDE-level settings, like defined SDKs, path variables, etc.;
- generated files: should be present in the TeamCity agent if they are present when working with the project in IntelliJ IDEA;
- IntelliJ IDEA version. It is recommended to use the same IntelliJ IDEA version that is used in the TeamCity build. TeamCity bundled an installation of IntelliJ IDEA. The version is written in the Inspections build log;
- the set and versions of the IntelliJ IDEA plugins that the project relies on.