IntelliJPlatformGradlePlugin/org.jetbrains.intellij.platform.gradle.tasks/TestIdeUiTask

TestIdeUiTask

@Incubating
@UntrackedTask(because = "Should always run")
abstract class TestIdeUiTask : Test, TestableAware

Runs the IDE instance with the developed plugin and Starter framework for UI testing.

Constructors

Link copied to clipboard
constructor()

Types

Link copied to clipboard
object Companion : Registrable

Properties

Link copied to clipboard
open var actions: List<Action<in Task?>?>?
Link copied to clipboard
open var allJvmArgs: List<String>
Link copied to clipboard
open val ant: AntBuilder?
Link copied to clipboard
@get:InputFile
@get:PathSensitive(value = PathSensitivity.RELATIVE)
abstract val archiveFile: RegularFileProperty

Specifies the archive file representing the input file to be tested.

Link copied to clipboard
@get:Internal
open val asDynamicObject: DynamicObject
Link copied to clipboard
@get:OutputDirectory
abstract val binaryResultsDirectory: DirectoryProperty?
Link copied to clipboard
open var bootstrapClasspath: FileCollection
Link copied to clipboard
@get:InputFiles
@get:SkipWhenEmpty
@get:IgnoreEmptyDirectories
@get:PathSensitive(value = PathSensitivity.RELATIVE)
open val candidateClassFiles: FileTree
Link copied to clipboard
@get:Internal(value = "captured by stableClasspath")
open var classpath: FileCollection
Link copied to clipboard
@get:Internal
open val conventionMapping: ConventionMapping?
Link copied to clipboard
@get:Internal
@get:Optional
abstract val coroutinesJavaAgentFile: RegularFileProperty

The path to the coroutines Java Agent file.

Link copied to clipboard
open var debug: Boolean
Link copied to clipboard
open val debugOptions: JavaDebugOptions
Link copied to clipboard
open var defaultCharacterEncoding: @Nullable String?
Link copied to clipboard
open val dependsOn: Set<Any?>?
Link copied to clipboard
open var description: @Nullable String?
Link copied to clipboard
open val destroyables: TaskDestroyables?
Link copied to clipboard
open var didWork: Boolean
Link copied to clipboard
@get:Incubating
@get:Input
abstract val dryRun: Property<Boolean>
Link copied to clipboard
Link copied to clipboard
open var enabled: Boolean
Link copied to clipboard
@get:Internal
open var environment: Map<String, Any>
Link copied to clipboard
@get:Internal
open val excludes: Set<String>
Link copied to clipboard
@get:Internal
open var executable: String
Link copied to clipboard
open val extensions: ExtensionContainer?
Link copied to clipboard
open var failFast: Boolean
Link copied to clipboard
@get:Input
abstract val failOnNoDiscoveredTests: Property<Boolean?>?
Link copied to clipboard
open val filter: TestFilter?
Link copied to clipboard
open val finalizedBy: TaskDependency?
Link copied to clipboard
@get:Internal
open var forkEvery: Long
Link copied to clipboard
open var group: @Nullable String?
Link copied to clipboard
open val identityPath: Path?
Link copied to clipboard
@get:Internal
open var ignoreFailures: Boolean
Link copied to clipboard
Link copied to clipboard
@get:Internal
open val includes: Set<String>
Link copied to clipboard
open val inputs: TaskInputsInternal?
Link copied to clipboard
@get:InputFiles
@get:PathSensitive(value = PathSensitivity.RELATIVE)
abstract val intellijPlatformClasspathConfiguration: ConfigurableFileCollection

Holds the Configurations.INTELLIJ_PLATFORM_CLASSPATH configuration.

Link copied to clipboard
@get:InputFiles
@get:PathSensitive(value = PathSensitivity.RELATIVE)
abstract val intelliJPlatformConfiguration: ConfigurableFileCollection

Holds the Configurations.INTELLIJ_PLATFORM_DEPENDENCY configuration with the IntelliJ Platform dependency added. It should not be directly accessed.

Link copied to clipboard
@get:InputFiles
@get:PathSensitive(value = PathSensitivity.RELATIVE)
abstract val intelliJPlatformPluginConfiguration: ConfigurableFileCollection

Holds the Configurations.INTELLIJ_PLATFORM_PLUGIN_DEPENDENCY configuration with the optional custom IntelliJ Platform plugins dependencies added. It should not be directly accessed.

@get:InputFiles
@get:PathSensitive(value = PathSensitivity.RELATIVE)
abstract val intellijPlatformTestClasspathConfiguration: ConfigurableFileCollection

Holds the Configurations.INTELLIJ_PLATFORM_TEST_CLASSPATH configuration, which by default contains Configurations.INTELLIJ_PLATFORM_DEPENDENCY, Configurations.INTELLIJ_PLATFORM_DEPENDENCIES, and Configurations.INTELLIJ_PLATFORM_TEST_DEPENDENCIES configurations.

@get:InputFiles
@get:PathSensitive(value = PathSensitivity.RELATIVE)
abstract val intellijPlatformTestRuntimeClasspathConfiguration: ConfigurableFileCollection

Holds the Configurations.INTELLIJ_PLATFORM_TEST_RUNTIME_CLASSPATH configuration.

@get:InputFiles
@get:PathSensitive(value = PathSensitivity.RELATIVE)
abstract val intelliJPlatformTestRuntimeFixClasspathConfiguration: ConfigurableFileCollection

Holds the Configurations.INTELLIJ_PLATFORM_TEST_RUNTIME_FIX_CLASSPATH configuration with the custom IntelliJ Platform core dependency required for running tests. It should not be directly accessed.

Link copied to clipboard
Link copied to clipboard
@get:Internal
open var isEnabled: Boolean
Link copied to clipboard
Link copied to clipboard
@get:Input
open var isScanForTestClasses: Boolean
Link copied to clipboard
abstract val javaLauncher: Property<JavaLauncher>
Link copied to clipboard
@get:Input
open val javaVersion: JavaVersion
Link copied to clipboard
@get:Internal
abstract val jetbrainsRuntimeConfiguration: ConfigurableFileCollection

Holds the Configurations.JETBRAINS_RUNTIME configuration with the JetBrains Runtime dependency added. It should not be directly accessed.

Link copied to clipboard
open var jvmArgs: List<String>
Link copied to clipboard
open val jvmArgumentProviders: List<CommandLineArgumentProvider>
Link copied to clipboard
@get:Internal
open val lifecycleDependencies: TaskDependencyInternal?
Link copied to clipboard
open val localState: TaskLocalState?
Link copied to clipboard
open val logger: Logger?
Link copied to clipboard
open val logging: LoggingManager?
Link copied to clipboard
open var maxHeapSize: @Nullable String?
Link copied to clipboard
@get:Internal
open var maxParallelForks: Int
Link copied to clipboard
open var minHeapSize: @Nullable String?
Link copied to clipboard
open val modularity: ModularitySpec
Link copied to clipboard
open val mustRunAfter: TaskDependency?
Link copied to clipboard
open val name: String?
Link copied to clipboard
open val onlyIf: Spec<in TaskInternal?>?
Link copied to clipboard
open val options: TestFrameworkOptions
Link copied to clipboard
open val outputs: TaskOutputsInternal?
Link copied to clipboard
open val path: String?
Link copied to clipboard
@get:Internal
open val platformPath: Path

Provides access to the IntelliJ Platform dependency artifact path.

Link copied to clipboard
@get:Internal
abstract val pluginDirectory: DirectoryProperty

Specifies the directory where the plugin artifacts are to be placed.

Link copied to clipboard
@get:Internal
open val productInfo: ProductInfo

Provides information about the IntelliJ Platform product. The information is retrieved from the product-info.json file in the IntelliJ Platform directory.

Link copied to clipboard
open val project: Project?
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open val reports: TestTaskReports?
Link copied to clipboard
open val requiredServices: TaskRequiredServices?
Link copied to clipboard
@get:Internal
abstract val runtimeArchitecture: Property<String>

An architecture of the Java Runtime currently used for running Gradle.

Link copied to clipboard
@get:Internal
abstract val runtimeDirectory: DirectoryProperty

Java Runtime parent directory.

Link copied to clipboard
@get:Internal
abstract val runtimeLauncher: Property<JavaLauncher>

A custom JavaLauncher instance configured with the resolved runtimeDirectory.

Link copied to clipboard
@get:Internal
abstract val runtimeMetadata: MapProperty<String, String>

Metadata object of the Java Runtime currently used for running Gradle.

Link copied to clipboard
@get:Internal
abstract val sandboxConfigDirectory: DirectoryProperty

A configuration directory located within the sandboxDirectory.

Link copied to clipboard
@get:Internal
abstract val sandboxDirectory: DirectoryProperty

The directory containing content read and produced by the running IDE.

Link copied to clipboard
@get:Internal
abstract val sandboxLogDirectory: DirectoryProperty

A log directory located within the sandboxDirectory.

Link copied to clipboard
@get:Internal
abstract val sandboxPluginsDirectory: DirectoryProperty

A plugins directory located within the sandboxDirectory.

Link copied to clipboard
@get:Internal
abstract val sandboxSystemDirectory: DirectoryProperty

A system directory located within the sandboxDirectory.

Link copied to clipboard
open val sharedResources: List<ResourceLock?>?
Link copied to clipboard
open val shouldRunAfter: TaskDependency?
Link copied to clipboard
open val standardOutputCapture: StandardOutputCapture?
Link copied to clipboard
open val state: TaskStateInternal?
Link copied to clipboard
open var systemProperties: Map<String, @Nullable Any?>
Link copied to clipboard
open val taskActions: List<InputChangesAwareTaskAction?>?
Link copied to clipboard
open val taskDependencies: TaskDependencyInternal?
Link copied to clipboard
open val taskIdentity: TaskIdentity<*>?
Link copied to clipboard
open val temporaryDir: File?
Link copied to clipboard
open val temporaryDirFactory: Factory<File?>?
Link copied to clipboard
@get:Internal
open var testClassesDirs: FileCollection
Link copied to clipboard
@get:Incubating
@get:InputFiles
@get:SkipWhenEmpty
@get:IgnoreEmptyDirectories
@get:PathSensitive(value = PathSensitivity.RELATIVE)
abstract val testDefinitionDirs: ConfigurableFileCollection
Link copied to clipboard
@get:Internal
open val testFramework: TestFramework
Link copied to clipboard
open val testFrameworkProperty: Property<TestFramework>
Link copied to clipboard
open val testLogging: TestLoggingContainer?
Link copied to clipboard
@get:Internal
abstract val testSandbox: Property<Boolean>

Defines if the current sandbox is related to testing.

Link copied to clipboard
open val timeout: Property<Duration?>?
Link copied to clipboard
@get:Internal
open var workingDir: File

Functions

Link copied to clipboard
open fun acceptServiceReferences(serviceReferences: Set<ServiceReferenceSpec?>?)
Link copied to clipboard
open fun addTestListener(listener: TestListener?)
Link copied to clipboard
@Incubating
open fun addTestMetadataListener(listener: TestMetadataListener?)
Link copied to clipboard
open fun addTestOutputListener(listener: TestOutputListener?)
Link copied to clipboard
open fun afterSuite(closure: Closure<*>?)
Link copied to clipboard
open fun afterTest(closure: Closure<*>?)
Link copied to clipboard
open fun appendParallelSafeAction(action: Action<in Task?>?)
Link copied to clipboard
open fun Task.applyFrontendSandboxFrom(sandboxProducerTaskProvider: TaskProvider<PrepareSandboxTask>)
Link copied to clipboard
open fun Task.applySandboxFrom(sandboxProducerTaskProvider: TaskProvider<PrepareSandboxTask>)
Link copied to clipboard
open fun beforeSuite(closure: Closure<*>?)
Link copied to clipboard
open fun beforeTest(closure: Closure<*>?)
Link copied to clipboard
open fun bootstrapClasspath(vararg classpath: @Nullable Any?): Test
Link copied to clipboard
open operator fun compareTo(otherTask: Task?): Int
Link copied to clipboard
open fun configure(closure: Closure<*>?): Task?
Link copied to clipboard
open fun conventionMapping(property: String?, mapping: Closure<*>?): Task?
open fun conventionMapping(property: String?, mapping: Callable<*>?): Task?
Link copied to clipboard
open fun copyTo(target: JavaForkOptions): Test
open fun copyTo(target: ProcessForkOptions): Test
Link copied to clipboard
open fun debugOptions(action: Action<JavaDebugOptions>)
Link copied to clipboard
open fun dependsOn(vararg paths: Any?): Task?
Link copied to clipboard
open fun doFirst(action: Closure<*>?): Task?
open fun doFirst(action: Action<in Task?>?): Task?
open fun doFirst(actionName: String?, action: Action<in Task?>?): Task?
Link copied to clipboard
open fun doLast(action: Closure<*>?): Task?
open fun doLast(action: Action<in Task?>?): Task?
open fun doLast(actionName: String?, action: Action<in Task?>?): Task?
Link copied to clipboard
open fun doNotTrackState(reasonNotToTrackState: String?)
Link copied to clipboard
open fun doNotTrackStateIf(reason: String?, spec: Spec<in TaskInternal?>?)
Link copied to clipboard
open fun environment(environmentVariables: Map<String, *>): Test
open fun environment(name: String, value: Any): Test
Link copied to clipboard
open fun exclude(excludeSpec: Closure<*>): Test
open fun exclude(excludes: Iterable<String>): Test
open fun exclude(excludeSpec: Spec<FileTreeElement>): Test
open fun exclude(vararg excludes: String): Test
Link copied to clipboard
open fun executable(executable: Any): Test
Link copied to clipboard
open override fun executeTests()

Executes the task, configures and runs the IDE.

Link copied to clipboard
open fun filter(action: Action<TestFilter>)
Link copied to clipboard
open fun finalizedBy(vararg paths: Any?): Task?
Link copied to clipboard
open fun hasProperty(propertyName: String?): Boolean
Link copied to clipboard
open fun hasTaskActions(): Boolean
Link copied to clipboard
open fun include(includeSpec: Closure<*>): Test
open fun include(includes: Iterable<String>): Test
open fun include(includeSpec: Spec<FileTreeElement>): Test
open fun include(vararg includes: String): Test
Link copied to clipboard
open fun jvmArgs(arguments: Iterable<*>): Test
open fun jvmArgs(vararg arguments: Any): Test
Link copied to clipboard
open fun mustRunAfter(vararg paths: Any?): Task?
Link copied to clipboard
Link copied to clipboard
open fun onlyIf(onlyIfClosure: Closure<*>?)
open fun onlyIf(spec: Spec<in Task?>?)
open fun onlyIf(onlyIfReason: String?, spec: Spec<in Task?>?)
Link copied to clipboard
open fun onOutput(closure: Closure<*>?)
Link copied to clipboard
open fun options(@DelegatesTo(value = TestFrameworkOptions::class) testFrameworkConfigure: Closure<*>): TestFrameworkOptions
open fun options(testFrameworkConfigure: Action<in TestFrameworkOptions>): TestFrameworkOptions
Link copied to clipboard
open fun prependParallelSafeAction(action: Action<in Task?>?)
Link copied to clipboard
open fun property(propertyName: String?): Any?
Link copied to clipboard
open fun removeTestListener(listener: TestListener?)
Link copied to clipboard
@Incubating
open fun removeTestMetadataListener(listener: TestMetadataListener?)
Link copied to clipboard
open fun removeTestOutputListener(listener: TestOutputListener?)
Link copied to clipboard
open fun reports(closure: Closure<*>?): TestTaskReports?
open fun reports(configureAction: Action<in TestTaskReports?>?): TestTaskReports?
Link copied to clipboard
open fun restoreOnlyIf(onlyIf: Spec<in TaskInternal?>?)
Link copied to clipboard
open fun restoreTaskActions(taskActions: List<InputChangesAwareTaskAction?>?)
Link copied to clipboard
open fun setDependsOn(dependsOn: Iterable<*>?)
Link copied to clipboard
open fun setExcludes(excludes: Iterable<String>): Test
Link copied to clipboard
open fun setFinalizedBy(finalizedByTasks: Iterable<*>?)
Link copied to clipboard
open fun setIncludes(includes: Iterable<String>): Test
Link copied to clipboard
open fun setMustRunAfter(mustRunAfterTasks: Iterable<*>?)
Link copied to clipboard
open fun setOnlyIf(onlyIfClosure: Closure<*>?)
open fun setOnlyIf(spec: Spec<in Task?>?)
open fun setOnlyIf(onlyIfReason: String?, spec: Spec<in Task?>?)
Link copied to clipboard
open fun setProperty(name: String?, value: Any?)
Link copied to clipboard
open fun setShouldRunAfter(shouldRunAfterTasks: Iterable<*>?)
Link copied to clipboard
open fun setTestNameIncludePatterns(testNamePattern: List<String>): Test
Link copied to clipboard
open fun shouldRunAfter(vararg paths: Any?): TaskDependency?
Link copied to clipboard
open fun systemProperties(properties: Map<String, out @Nullable Any?>): Test
Link copied to clipboard
open fun systemProperty(name: String, value: @Nullable Any?): Test
Link copied to clipboard
open fun testFramework(testFrameworkConfigure: @Nullable Closure<*>??): TestFramework
Link copied to clipboard
open fun testLogging(@DelegatesTo(value = TestLoggingContainer::class) closure: Closure<*>?)
open fun testLogging(action: Action<in TestLoggingContainer?>?)
Link copied to clipboard
open fun useJUnit()
open fun useJUnit(@DelegatesTo(value = JUnitOptions::class) testFrameworkConfigure: @Nullable Closure<*>??)
open fun useJUnit(testFrameworkConfigure: Action<in JUnitOptions>)
Link copied to clipboard
open fun useJUnitPlatform()
open fun useJUnitPlatform(testFrameworkConfigure: Action<in JUnitPlatformOptions>)
Link copied to clipboard
open fun usesService(service: Provider<out BuildService<*>?>?)
Link copied to clipboard
open fun useTestNG()
open fun useTestNG(@DelegatesTo(value = TestNGOptions::class) testFrameworkConfigure: Closure<*>)
open fun useTestNG(testFrameworkConfigure: Action<in TestNGOptions>)
Link copied to clipboard
open fun validateIntelliJPlatformVersion()

Validates that the resolved IntelliJ Platform is supported by checking against the minimal supported IntelliJ Platform version.

Link copied to clipboard
open fun workingDir(dir: Any): Test
Generated by Dokka
© 2026 Copyright