io.cloudshiftdev.awscdk.cloud_assembly_schema.IntegManifest.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kotlin-cdk-wrapper Show documentation
Kotlin DSL for AWS CDK
There is a newer version: 0.10.0
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")

package io.cloudshiftdev.awscdk.cloud_assembly_schema

import io.cloudshiftdev.awscdk.common.CdkDslMarker
import io.cloudshiftdev.awscdk.common.CdkObject
import io.cloudshiftdev.awscdk.common.CdkObjectWrappers
import kotlin.Boolean
import kotlin.String
import kotlin.Unit
import kotlin.collections.Map

/**
 * Definitions for the integration testing manifest.
 *
 * Example:
 *
 * ```
 * // The code below shows an example of how to instantiate this type.
 * // The values are placeholders you should change.
 * import io.cloudshiftdev.awscdk.cloud_assembly_schema.*;
 * IntegManifest integManifest = IntegManifest.builder()
 * .testCases(Map.of(
 * "testCasesKey", TestCase.builder()
 * .stacks(List.of("stacks"))
 * // the properties below are optional
 * .allowDestroy(List.of("allowDestroy"))
 * .assertionStack("assertionStack")
 * .assertionStackName("assertionStackName")
 * .cdkCommandOptions(CdkCommands.builder()
 * .deploy(DeployCommand.builder()
 * .args(DeployOptions.builder()
 * .all(false)
 * .app("app")
 * .assetMetadata(false)
 * .caBundlePath("caBundlePath")
 * .changeSetName("changeSetName")
 * .ci(false)
 * .color(false)
 * .concurrency(123)
 * .context(Map.of(
 * "contextKey", "context"))
 * .debug(false)
 * .ec2Creds(false)
 * .exclusively(false)
 * .execute(false)
 * .force(false)
 * .ignoreErrors(false)
 * .json(false)
 * .lookups(false)
 * .notices(false)
 * .notificationArns(List.of("notificationArns"))
 * .output("output")
 * .outputsFile("outputsFile")
 * .parameters(Map.of(
 * "parametersKey", "parameters"))
 * .pathMetadata(false)
 * .profile("profile")
 * .proxy("proxy")
 * .requireApproval(RequireApproval.NEVER)
 * .reuseAssets(List.of("reuseAssets"))
 * .roleArn("roleArn")
 * .rollback(false)
 * .stacks(List.of("stacks"))
 * .staging(false)
 * .strict(false)
 * .toolkitStackName("toolkitStackName")
 * .trace(false)
 * .usePreviousParameters(false)
 * .verbose(false)
 * .versionReporting(false)
 * .build())
 * .enabled(false)
 * .expectedMessage("expectedMessage")
 * .expectError(false)
 * .build())
 * .destroy(DestroyCommand.builder()
 * .args(DestroyOptions.builder()
 * .all(false)
 * .app("app")
 * .assetMetadata(false)
 * .caBundlePath("caBundlePath")
 * .color(false)
 * .context(Map.of(
 * "contextKey", "context"))
 * .debug(false)
 * .ec2Creds(false)
 * .exclusively(false)
 * .force(false)
 * .ignoreErrors(false)
 * .json(false)
 * .lookups(false)
 * .notices(false)
 * .output("output")
 * .pathMetadata(false)
 * .profile("profile")
 * .proxy("proxy")
 * .roleArn("roleArn")
 * .stacks(List.of("stacks"))
 * .staging(false)
 * .strict(false)
 * .trace(false)
 * .verbose(false)
 * .versionReporting(false)
 * .build())
 * .enabled(false)
 * .expectedMessage("expectedMessage")
 * .expectError(false)
 * .build())
 * .build())
 * .diffAssets(false)
 * .hooks(Hooks.builder()
 * .postDeploy(List.of("postDeploy"))
 * .postDestroy(List.of("postDestroy"))
 * .preDeploy(List.of("preDeploy"))
 * .preDestroy(List.of("preDestroy"))
 * .build())
 * .regions(List.of("regions"))
 * .stackUpdateWorkflow(false)
 * .build()))
 * .version("version")
 * // the properties below are optional
 * .enableLookups(false)
 * .synthContext(Map.of(
 * "synthContextKey", "synthContext"))
 * .build();
 * ```
 */
public interface IntegManifest {
  /**
   * Enable lookups for this test.
   *
   * If lookups are enabled
   * then `stackUpdateWorkflow` must be set to false.
   * Lookups should only be enabled when you are explicitely testing
   * lookups.
   *
   * Default: false
   */
  public fun enableLookups(): Boolean? = unwrap(this).getEnableLookups()

  /**
   * Additional context to use when performing a synth.
   *
   * Any context provided here will override
   * any default context
   *
   * Default: - no additional context
   */
  public fun synthContext(): Map = unwrap(this).getSynthContext() ?: emptyMap()

  /**
   * test cases.
   */
  public fun testCases(): Map

  /**
   * Version of the manifest.
   */
  public fun version(): String

  /**
   * A builder for [IntegManifest]
   */
  @CdkDslMarker
  public interface Builder {
    /**
     * @param enableLookups Enable lookups for this test.
     * If lookups are enabled
     * then `stackUpdateWorkflow` must be set to false.
     * Lookups should only be enabled when you are explicitely testing
     * lookups.
     */
    public fun enableLookups(enableLookups: Boolean)

    /**
     * @param synthContext Additional context to use when performing a synth.
     * Any context provided here will override
     * any default context
     */
    public fun synthContext(synthContext: Map)

    /**
     * @param testCases test cases. 
     */
    public fun testCases(testCases: Map)

    /**
     * @param version Version of the manifest. 
     */
    public fun version(version: String)
  }

  private class BuilderImpl : Builder {
    private val cdkBuilder: software.amazon.awscdk.cloud_assembly_schema.IntegManifest.Builder =
        software.amazon.awscdk.cloud_assembly_schema.IntegManifest.builder()

    /**
     * @param enableLookups Enable lookups for this test.
     * If lookups are enabled
     * then `stackUpdateWorkflow` must be set to false.
     * Lookups should only be enabled when you are explicitely testing
     * lookups.
     */
    override fun enableLookups(enableLookups: Boolean) {
      cdkBuilder.enableLookups(enableLookups)
    }

    /**
     * @param synthContext Additional context to use when performing a synth.
     * Any context provided here will override
     * any default context
     */
    override fun synthContext(synthContext: Map) {
      cdkBuilder.synthContext(synthContext)
    }

    /**
     * @param testCases test cases. 
     */
    override fun testCases(testCases: Map) {
      cdkBuilder.testCases(testCases.mapValues{TestCase.unwrap(it.value)})
    }

    /**
     * @param version Version of the manifest. 
     */
    override fun version(version: String) {
      cdkBuilder.version(version)
    }

    public fun build(): software.amazon.awscdk.cloud_assembly_schema.IntegManifest =
        cdkBuilder.build()
  }

  private class Wrapper(
    cdkObject: software.amazon.awscdk.cloud_assembly_schema.IntegManifest,
  ) : CdkObject(cdkObject),
      IntegManifest {
    /**
     * Enable lookups for this test.
     *
     * If lookups are enabled
     * then `stackUpdateWorkflow` must be set to false.
     * Lookups should only be enabled when you are explicitely testing
     * lookups.
     *
     * Default: false
     */
    override fun enableLookups(): Boolean? = unwrap(this).getEnableLookups()

    /**
     * Additional context to use when performing a synth.
     *
     * Any context provided here will override
     * any default context
     *
     * Default: - no additional context
     */
    override fun synthContext(): Map = unwrap(this).getSynthContext() ?: emptyMap()

    /**
     * test cases.
     */
    override fun testCases(): Map =
        unwrap(this).getTestCases().mapValues{TestCase.wrap(it.value)}

    /**
     * Version of the manifest.
     */
    override fun version(): String = unwrap(this).getVersion()
  }

  public companion object {
    public operator fun invoke(block: Builder.() -> Unit = {}): IntegManifest {
      val builderImpl = BuilderImpl()
      return Wrapper(builderImpl.apply(block).build())
    }

    internal fun wrap(cdkObject: software.amazon.awscdk.cloud_assembly_schema.IntegManifest):
        IntegManifest = CdkObjectWrappers.wrap(cdkObject) as? IntegManifest ?: Wrapper(cdkObject)

    internal fun unwrap(wrapped: IntegManifest):
        software.amazon.awscdk.cloud_assembly_schema.IntegManifest = (wrapped as
        CdkObject).cdkObject as software.amazon.awscdk.cloud_assembly_schema.IntegManifest
  }
}