stig-gradle-plugin/com.stigway.gradle.tasks.validation/StigCheckModelTask

StigCheckModelTask

@DisableCachingByDefault(because = "Model checks instantiate current compiled model classes.")

abstract class StigCheckModelTask : DefaultTask

Runs model checks (consistency rules) on compiled viewpoint classes.

Up-to-date capable: declares @OutputDirectory outputs (SARIF + HTML reports). If compiled model classes and check configuration are unchanged, Gradle skips re-execution.

Model objects are instantiated from current compiled outputs; the task's outputs and configuration still participate in Gradle up-to-date checks.

Inheritors

StigCheckModuleModelTask

Constructors

StigCheckModelTask

constructor()

Properties

open var actions: List<Action<in Task?>?>?

open val ant: AntBuilder?

asDynamicObject

@get:Internal

open val asDynamicObject: DynamicObject

abstract val checkedModules: ListProperty<ModelCheckModule>

Root checks evaluate these modules against one complete inventory. Local checks leave this empty.

@get:Input

abstract val checks: Property<ModelCheckMode>

completeModelScope

@get:Input

abstract val completeModelScope: Property<Boolean>

Complete project model scope supplied by the plugin, never inferred from an empty child list.

configuredElementId

@get:Input

@get:Optional

abstract val configuredElementId: Property<String>

Optional canonical Highway model element ID configured in stig { element { id = "..." } }. When a context model element is present, model check reports HIGH if the configured ID and computed context model ID differ.

open val dependsOn: Set<Any?>?

open var description: @Nullable String?

open val destroyables: TaskDestroyables?

open var didWork: Boolean

@get:Internal

abstract val elementDir: DirectoryProperty

open var enabled: Boolean

enabledViewpoints

@get:Input

abstract val enabledViewpoints: ListProperty<String>

Viewpoints enabled by the DSL modelCheck { viewpoint { enabled = ... } } cascade. Disabled viewpoints remain available as context but are not checked.

explicitContextModules

@get:Input

abstract val explicitContextModules: ListProperty<String>

open val extensions: ExtensionContainer?

@get:Input

abstract val failAt: Property<ProblemSeverity>

open val finalizedBy: TaskDependency?

open var group: @Nullable String?

open val identityPath: Path?

impliesSubProjects

open var impliesSubProjects: Boolean

open val inputs: TaskInputsInternal?

isCompatibleWithConfigurationCache

open val isCompatibleWithConfigurationCache: Boolean

@get:Internal

open var isEnabled: Boolean

isHasCustomActions

open val isHasCustomActions: Boolean

lifecycleDependencies

@get:Internal

open val lifecycleDependencies: TaskDependencyInternal?

open val localState: TaskLocalState?

open val logger: Logger?

open val logging: LoggingManager?

open val loggingManager: @Nullable LoggingManagerInternal?

logicalOwnerProjects

@get:Input

abstract val logicalOwnerProjects: MapProperty<String, String>

Element ID to report-owning Gradle project; declaration location remains separate.

@get:Classpath

abstract val modelClasspath: ConfigurableFileCollection

Classpath containing the compiled model classes and their dependencies. Set by the plugin to include the module's runtime classpath.

modelModuleDependencies

@get:Input

abstract val modelModuleDependencies: MapProperty<String, List<String>>

Ordinary Kotlin module dependencies, shared with the core's module scope planner.

modelModuleDirectories

@get:Input

abstract val modelModuleDirectories: MapProperty<String, String>

Registered model module roots used to identify declaration ownership.

modelOutputClasspath

@get:Classpath

abstract val modelOutputClasspath: ConfigurableFileCollection

Current-build model outputs that may contain declarations to bind. Unlike modelClasspath, this deliberately excludes external dependency-cache JARs.

modelSourceFiles

@get:InputFiles

@get:PathSensitive(value = PathSensitivity.RELATIVE)

abstract val modelSourceFiles: ConfigurableFileCollection

Source-only layout and naming edits must invalidate cached checks as well as compiled model changes.

open val mustRunAfter: TaskDependency?

open val name: String?

open val onlyIf: Spec<in TaskInternal?>?

open val outputs: TaskOutputsInternal?

open val path: String?

preparedResultsDirectory

@get:InputDirectory

@get:Optional

@get:PathSensitive(value = PathSensitivity.RELATIVE)

abstract val preparedResultsDirectory: DirectoryProperty

Results prepared by the report's shared model session, consumed without loading Kotlin again.

@get:OutputFile

abstract val problemsFile: RegularFileProperty

Canonical model and execution problems emitted by this task.

open val project: Project?

@get:Input

abstract val projectPath: Property<String>

Gradle project path captured during configuration for canonical problem provenance.

projectReportEnabled

@get:Internal

abstract val projectReportEnabled: Property<Boolean>

@get:Internal

abstract val projectRoot: DirectoryProperty

publishedReportTableFile

@get:Internal

abstract val publishedReportTableFile: RegularFileProperty

reasonNotToTrackState

open val reasonNotToTrackState: Optional<String?>?

reasonsNotToTrackState

open val reasonsNotToTrackState: Set<String?>?

reasonTaskIsIncompatibleWithConfigurationCache

open val reasonTaskIsIncompatibleWithConfigurationCache: Optional<String?>?

reportClassificationDifferences

@get:Input

abstract val reportClassificationDifferences: Property<Boolean>

@get:OutputDirectory

@get:Optional

abstract val reportDir: DirectoryProperty

@get:Input

@get:Optional

abstract val reportFormat: Property<ReportFormat>

reportResultsFile

@get:Internal

abstract val reportResultsFile: RegularFileProperty

Report export destinations shown for full-model checks; this task does not produce or refresh them.

reportTableFile

@get:Internal

abstract val reportTableFile: RegularFileProperty

requiredServices

open val requiredServices: TaskRequiredServices?

ruleInventoryFile

@get:OutputFile

abstract val ruleInventoryFile: RegularFileProperty

Rule inventory used with canonical problem records by HTML and SARIF derived views.

@get:Input

@get:Optional

abstract val ruleset: Property<String>

@get:OutputDirectory

abstract val sarifOutputDir: DirectoryProperty

Output directory for the always-generated SARIF report (IDE integration). Set by the plugin to build/reports/stig/.

sharedResources

open val sharedResources: List<ResourceLock?>?

open val shouldRunAfter: TaskDependency?

standardOutputCapture

open val standardOutputCapture: StandardOutputCapture?

open val state: TaskStateInternal?

open val taskActions: List<InputChangesAwareTaskAction?>?

taskDependencies

open val taskDependencies: TaskDependencyInternal?

open val taskIdentity: TaskIdentity<*>?

open val temporaryDir: File?

temporaryDirFactory

open val temporaryDirFactory: Factory<File?>?

open val timeout: Property<Duration?>?

@get:Input

abstract val viewpoints: ListProperty<String>

@get:Input

abstract val workerCount: Property<Int>

Module checks share one loaded model and reserve one available CPU by default.

Functions

acceptServiceReferences

open fun acceptServiceReferences(serviceReferences: Set<ServiceReferenceSpec?>?)

appendParallelSafeAction

open fun appendParallelSafeAction(action: Action<in Task?>?)

open operator fun compareTo(otherTask: Task?): Int

open fun configure(closure: Closure<*>?): Task?

open fun dependsOn(vararg paths: Any?): Task?

open fun doFirst(action: Closure<*>?): Task?

open fun doFirst(action: Action<in Task?>?): Task?

open fun doFirst(actionName: String?, action: Action<in Task?>?): Task?

open fun doLast(action: Closure<*>?): Task?

open fun doLast(action: Action<in Task?>?): Task?

open fun doLast(actionName: String?, action: Action<in Task?>?): Task?

doNotTrackState

open fun doNotTrackState(reasonNotToTrackState: String?)

doNotTrackStateIf

open fun doNotTrackStateIf(reason: String?, spec: Spec<in TaskInternal?>?)

open fun finalizedBy(vararg paths: Any?): Task?

getAvailableChecks

fun getAvailableChecks(): List<String>

open fun hasProperty(propertyName: String?): Boolean

open fun hasTaskActions(): Boolean

open fun mustRunAfter(vararg paths: Any?): Task?

notCompatibleWithConfigurationCache

open fun notCompatibleWithConfigurationCache(reason: String?)

open fun onlyIf(onlyIfClosure: Closure<*>?)

open fun onlyIf(spec: Spec<in Task?>?)

open fun onlyIf(onlyIfReason: String?, spec: Spec<in Task?>?)

fun optChecks(raw: String)

fun optReportDir(path: String)

optReportFormat

fun optReportFormat(raw: String)

fun optRuleset(raw: String)

prependParallelSafeAction

open fun prependParallelSafeAction(action: Action<in Task?>?)

open fun property(propertyName: String?): Any?

open fun restoreOnlyIf(onlyIf: Spec<in TaskInternal?>?)

restoreTaskActions

open fun restoreTaskActions(taskActions: List<InputChangesAwareTaskAction?>?)

open fun setDependsOn(dependsOn: Iterable<*>?)

open fun setFinalizedBy(finalizedByTasks: Iterable<*>?)

setMustRunAfter

open fun setMustRunAfter(mustRunAfterTasks: Iterable<*>?)

open fun setOnlyIf(onlyIfClosure: Closure<*>?)

open fun setOnlyIf(spec: Spec<in Task?>?)

open fun setOnlyIf(onlyIfReason: String?, spec: Spec<in Task?>?)

open fun setProperty(name: String?, value: Any?)

setShouldRunAfter

open fun setShouldRunAfter(shouldRunAfterTasks: Iterable<*>?)

open fun shouldRunAfter(vararg paths: Any?): TaskDependency?

open fun usesService(service: Provider<out BuildService<*>?>?)