OpenTofuModel (opentofu-base-plugin 2.0.2 API)

org.ysb33r.gradle.opentofu.internal.OpenTofuModel

@SuppressWarnings(value: MethodCount)
@groovy.transform.CompileStatic
class OpenTofuModel
extends Object

Utilities for building the tasks around a named OpenTofu source set.

Authors:: Schalk W. Cronjé

Since:: 2.0

Nested Class Summary

Nested classes
Modifiers	Name	Description
`static class`	`OpenTofuModel.WorkspaceGenerator`	Used by source set to create workspace tasks

Field Summary

Fields
Modifiers	Name	Description
`static String`	`CUSTOM_FMT_APPLY`
`static String`	`CUSTOM_FMT_CHECK`
`static String`	`DEFAULT_SOURCESET_NAME`
`static String`	`DEFAULT_WORKSPACE`
`static String`	`EXE_BASE_NAME`
`static String`	`EXTENSION_NAME`
`static String`	`FORMAT_ALL`
`static java.util.Set<String>`	`PLATFORMS`
`static String`	`PREFIX`
`static String`	`PROVIDER_LOCK_FILENAME`
`static String`	`TASK_GROUP`
`static String`	`TOOL_NAME`

Constructor Summary

Constructors
Constructor and description
`OpenTofuModel ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`static String`	`backendTaskName(String sourceSetName)` The name of the backend configuration task.
	`static void`	`configureApply(TaskConfiguration cfg)`
	`static void`	`configureCacheOutputVariables(TaskConfiguration cfg)`
	`static void`	`configureCleanupWorkspaces(TaskConfiguration cfg)`
	`static void`	`configureDestroy(TaskConfiguration cfg)`
	`static void`	`configureDestroyPlan(TaskConfiguration cfg)`
	`static void`	`configureFormatApply(TaskConfiguration cfg)`
	`static void`	`configureFormatCheck(TaskConfiguration cfg)`
	`static void`	`configureImport(TaskConfiguration cfg)`
	`static void`	`configureInit(TaskConfiguration cfg)`
	`static void`	`configureOutput(TaskConfiguration cfg)`
	`static void`	`configurePlan(TaskConfiguration cfg)`
	`static void`	`configureProvidersLock(TaskConfiguration cfg)`
	`static void`	`configureProvidersSchema(TaskConfiguration cfg)`
	`static void`	`configureProvidersShow(TaskConfiguration cfg)`
	`static void`	`configureShowState(TaskConfiguration cfg)`
	`static void`	`configureStateMv(TaskConfiguration cfg)`
	`static void`	`configureStatePull(TaskConfiguration cfg)`
	`static void`	`configureStatePush(TaskConfiguration cfg)`
	`static void`	`configureStateRm(TaskConfiguration cfg)`
	`static void`	`configureTaint(TaskConfiguration cfg)`
	`static void`	`configureUntaint(TaskConfiguration cfg)`
	`static void`	`configureValidate(TaskConfiguration cfg)`
	`static void`	`createCustomFormatTasks(Project project)` Create format tasks that are not related to specific source sets.
	`static void`	`createTasksFromModel(OpenTofuSourceSet sourceSet, String workspaceName, Project project)` Creates all of the required tasks for a source set
	`static String`	`pluginCacheDirTaskName()` The name of the plugin dir configuration task.
	`static String`	`taskName(String sourceSetName, String commandType, String workspaceName)` Provides a task name

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`equals, toString, hashCode, getClass, notify, notifyAll, wait, wait, wait`

- Field Detail
  - public static final String CUSTOM_FMT_APPLY
  - public static final String CUSTOM_FMT_CHECK
  - public static final String DEFAULT_SOURCESET_NAME
  - public static final String DEFAULT_WORKSPACE
  - public static final String EXE_BASE_NAME
  - public static final String EXTENSION_NAME
  - public static final String FORMAT_ALL
  - public static final java.util.Set<String> PLATFORMS
  - public static final String PREFIX
  - public static final String PROVIDER_LOCK_FILENAME
  - public static final String TASK_GROUP
  - public static final String TOOL_NAME
- Constructor Detail
  - OpenTofuModel()
- Method Detail
  - static String backendTaskName(String sourceSetName)
    
    The name of the backend configuration task.
    Parameters:
    sourceSetName - Name of source set.
    Returns:
    Name of task
  - static void configureApply(TaskConfiguration cfg)
  - static void configureCacheOutputVariables(TaskConfiguration cfg)
  - static void configureCleanupWorkspaces(TaskConfiguration cfg)
  - static void configureDestroy(TaskConfiguration cfg)
  - static void configureDestroyPlan(TaskConfiguration cfg)
  - static void configureFormatApply(TaskConfiguration cfg)
  - static void configureFormatCheck(TaskConfiguration cfg)
  - static void configureImport(TaskConfiguration cfg)
  - static void configureInit(TaskConfiguration cfg)
  - static void configureOutput(TaskConfiguration cfg)
  - static void configurePlan(TaskConfiguration cfg)
  - static void configureProvidersLock(TaskConfiguration cfg)
  - static void configureProvidersSchema(TaskConfiguration cfg)
  - static void configureProvidersShow(TaskConfiguration cfg)
  - static void configureShowState(TaskConfiguration cfg)
  - static void configureStateMv(TaskConfiguration cfg)
  - static void configureStatePull(TaskConfiguration cfg)
  - static void configureStatePush(TaskConfiguration cfg)
  - static void configureStateRm(TaskConfiguration cfg)
  - static void configureTaint(TaskConfiguration cfg)
  - static void configureUntaint(TaskConfiguration cfg)
  - static void configureValidate(TaskConfiguration cfg)
  - static void createCustomFormatTasks(Project project)
    
    Create format tasks that are not related to specific source sets.
    Parameters:
    project - Contextual project
  - static void createTasksFromModel(OpenTofuSourceSet sourceSet, String workspaceName, Project project)
    
    Creates all of the required tasks for a source set
    Parameters:
    sourceSet - OpenTofu sourceset
    workspaceName - Name of the workspace. Use DEFAULT_WORKSPACE for the default workspace.
    project - Associated project.
  - static String pluginCacheDirTaskName()
    
    The name of the plugin dir configuration task.
    Returns:
    Name of task
  - static String taskName(String sourceSetName, String commandType, String workspaceName)
    
    Provides a task name
    Parameters:
    sourceSetName - Name of source set the task will be associated with.
    commandType - The OpenTofu command that this task will wrap.
    workspaceName - Name of workspace. if null will act as if workspace-agnostic
    Returns:
    Name of task

| Detail:
Field
Constructor
Method

Groovy Documentation

[Groovy] Class OpenTofuModel

Nested Class Summary

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final String CUSTOM_FMT_APPLY

public static final String CUSTOM_FMT_CHECK

public static final String DEFAULT_SOURCESET_NAME

public static final String DEFAULT_WORKSPACE

public static final String EXE_BASE_NAME

public static final String EXTENSION_NAME

public static final String FORMAT_ALL

public static final java.util.Set<String> PLATFORMS

public static final String PREFIX

public static final String PROVIDER_LOCK_FILENAME

public static final String TASK_GROUP

public static final String TOOL_NAME

Constructor Detail

OpenTofuModel()

Method Detail

static String backendTaskName(String sourceSetName)

static void configureApply(TaskConfiguration cfg)

static void configureCacheOutputVariables(TaskConfiguration cfg)

static void configureCleanupWorkspaces(TaskConfiguration cfg)

static void configureDestroy(TaskConfiguration cfg)

static void configureDestroyPlan(TaskConfiguration cfg)

static void configureFormatApply(TaskConfiguration cfg)

static void configureFormatCheck(TaskConfiguration cfg)

static void configureImport(TaskConfiguration cfg)

static void configureInit(TaskConfiguration cfg)

static void configureOutput(TaskConfiguration cfg)

static void configurePlan(TaskConfiguration cfg)

static void configureProvidersLock(TaskConfiguration cfg)

static void configureProvidersSchema(TaskConfiguration cfg)

static void configureProvidersShow(TaskConfiguration cfg)

static void configureShowState(TaskConfiguration cfg)

static void configureStateMv(TaskConfiguration cfg)

static void configureStatePull(TaskConfiguration cfg)

static void configureStatePush(TaskConfiguration cfg)

static void configureStateRm(TaskConfiguration cfg)

static void configureTaint(TaskConfiguration cfg)

static void configureUntaint(TaskConfiguration cfg)

static void configureValidate(TaskConfiguration cfg)

static void createCustomFormatTasks(Project project)

static void createTasksFromModel(OpenTofuSourceSet sourceSet, String workspaceName, Project project)

static String pluginCacheDirTaskName()

static String taskName(String sourceSetName, String commandType, String workspaceName)