TeamCity
 
8.0
You are viewing the documentation for an earlier version of TeamCity.
  1. TeamCity Documentation
  2. Administrator's Guide
  3. Managing Projects and Build Configurations
  4. Creating and Editing Build Configurations
  5. Configuring Build Steps
  6. Inspections

Inspections

Last modified: 20 April 2023

The Inspections (IntelliJ IDEA) Build Runner is intended to run code analysis based on IntelliJ IDEA inspections for your project. IntelliJ IDEA's code analysis engine is capable of inspecting your Java, JavaScript, HTML, XML and other code and allows you to:

  • 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.

note

To run inspections for your project, you must have either an IntelliJ IDEA project file (.ipr) or a project directory (.idea) checked into your version control. The runner also supports Maven2 or above: to use pom.xml, you need to open it in IntelliJ IDEA and configure inspection profiles as described in the IntelliJ IDEA documentation. IntelliJ IDEA will save your inspection profiles in the corresponding folder. Make sure you have it checked into your version control. Then specify the paths to the inspection profiles while configuring this runner.

This page contains reference information about the following Inspections (IntelliJ IDEA) Build Runner fields:

IntelliJ IDEA Project Settings



Option

Description

Project file type

To be able to run IntelliJ IDEA inspections on your code, TeamCity requires either an IntelliJ IDEA project file\directory, or Maven pom.xml to be specified here.

Path to the project

Depending on the type of project selected in the Project file type, specify here:

  • For IntelliJ IDEA project: the path to the project file (.ipr) or the path to the project directory the root directory of the project containing the .idea folder).

  • For Maven project: the path to the pom.xml file. This information is required by this build runner to understand the structure of the project.

    tip

    The specified path should be relative to the checkout directory.

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.

warning

When this option is selected, the process of opening and saving the build runner settings may become time-consuming, because it involves loading and parsing all project module files.

Check/Reparse Project

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.

note

If you update your project settings in IntelliJ IDEA (e.g add new jdks, libraries), remember to update the build runner settings by clicking Check/Reparse Project.

Working directory

Enter a path to a build working directory if it differs from the build checkout directory. Optional, specify if differs from the checkout directory.

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.

Option

Description

<path_variable_name>

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.

Project SDKs



This section provides the list of SDKs detected in the project.

Option

Description

JDK Home

Use this field to specify the JDK home for the project.

note

When building with the Ipr runner, this JDK will be used to compile the sources of corresponding IDEA modules. For Inspections and Duplicate Finder builds, this JDK will be used internally to resolve the Java API used in your project. To run the build process, the JDK specified in the JAVA_HOME environment variable will be used.

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. The default value is used for Linux and Windows operating systems:

jre/lib/*.jar

For Mac OS X, use the following lines:

lib/*.jar ../Classes/*.jar

IDEA Home

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.

note

You can use references to external properties when defining the values, like %\system.idea_home% or %\env.JDK_1_3%. This will add a Agent Requirements for the corresponding property.

Java Parameters



Option

Description

JDK home path

Use this field to specify the path to your custom JDK which should be 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 the agent computer, or from the env.JAVA_HOME property specified in the build agent configuration file (buildAgent.properties). If neither of these values is specified, TeamCity uses the Java home of the build agent process itself.

JVM command line parameters

Specify the desired Java Virtual Machine parameters, for example the maximum heap size. These settings are passed to the JVM used to run your build. Example:

-Xmx512m -Xms256m

Inspection Parameters



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.

Option

Description

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.

tip

Include / exclude patterns are newline-delimited set of rules of the form:

[+:|-:]pattern

where the pattern must satisfy the following rules:

  • must end with either ** or * (this effectively limits the patterns to only the directories level, they do not support file-level patterns)

  • references to modules can be included as [module_name]/<path_within_module>

Some notes on patterns processing:

  • excludes have precedence over includes

  • if include patterns are specified, only directories matching these patterns will be included, all other directories will be excluded

  • the include pattern has a special behavior (due to underlying limitations): it includes the directory specified and all the files residing directly in the directories above the one specified.

Example:

+:testData/tables/** -:testData/** -:testdata/** -:[testData]/**

tip

For the file paths to be reported correctly, the "References to resources outside project/module file directory" option for the project and all modules should be set to "Relative" in IDEA project.