com.github.chriskn.structurizrextension.model.DeploymentNode.kt Maven / Gradle / Ivy

Go to download
package com.github.chriskn.structurizrextension.model

import com.structurizr.model.Container
import com.structurizr.model.DeploymentElement
import com.structurizr.model.DeploymentNode
import com.structurizr.model.InfrastructureNode
import com.structurizr.model.SoftwareSystem

/**
 * Adds a child deployment node.
 *
 * @param name              the name of the deployment node
 * @param description       the description of the deployment node
 * @param icon              the icon of the deployment node. See IconRegistry for available icons or add your own
 * @param link              the link of the deployment node
 * @param technology        the technology of the deployment node
 * @param tags              the list of tags of the deployment node
 * @param properties        the [C4Properties] of the deployment node
 * @param uses              the list of [Dependency] to a deployment node or infrastructure node the deployment node uses
 * @param usedBy            the list of [Dependency] to a deployment node or infrastructure node the deployment node is used by
 * @param hostsSystems      the list of systems the deployment node hosts
 * @param hostsContainers   the list of container the deployment node hosts
 * @return the resulting DeploymentNode
 */
@Suppress("LongParameterList")
fun DeploymentNode.deploymentNode(
    name: String,
    description: String = "",
    icon: String? = null,
    link: String? = null,
    technology: String = "",
    tags: List = listOf(),
    properties: C4Properties? = null,
    uses: List> = listOf(),
    usedBy: List> = listOf(),
    hostsSystems: List = listOf(),
    hostsContainers: List = listOf()
): DeploymentNode {
    val node = this.addDeploymentNode(name, description, technology)
    node.configure(icon, link, tags, properties, hostsSystems, hostsContainers, uses, usedBy)
    return node
}

/**
 * Adds a child infrastructure node.
 *
 * @param name              the name of the infrastructure node
 * @param description       the description of the infrastructure node
 * @param icon              the icon of the infrastructure node. See IconRegistry for available icons or add your own
 * @param link              the link of the infrastructure node
 * @param technology        the technology of the infrastructure node
 * @param tags              the list of tags of the infrastructure node
 * @param properties        [C4Properties] of the infrastructure node
 * @param uses              the list of [Dependency] to a deployment node or infrastructure node the infrastructure node uses
 * @param usedBy            the list of [Dependency] to a deployment node or infrastructure node the infrastructure node is used by
 * @return the resulting DeploymentNode
 * @throws IllegalArgumentException if an invalid element is used in dependencies
 */
@Suppress("LongParameterList")
fun DeploymentNode.infrastructureNode(
    name: String,
    description: String = "",
    icon: String? = null,
    link: String? = null,
    technology: String = "",
    tags: List = listOf(),
    properties: C4Properties? = null,
    uses: List> = listOf(),
    usedBy: List> = listOf()
): InfrastructureNode {
    val node = this.addInfrastructureNode(name, description, technology)
    node.configure(icon, link, tags, properties)
    uses.forEach { dep ->
        node.uses(dep.destination, dep.description, dep.technology, dep.interactionStyle)
            .configure(dep.icon, dep.link, dep.tags, dep.properties)
    }
    usedBy.forEach { dep ->
        dep.destination.uses(node, dep.description, dep.technology, dep.interactionStyle)
            .configure(dep.icon, dep.link, dep.tags, dep.properties)
    }
    return node
}

@Suppress("LongParameterList")
fun DeploymentNode.configure(
    icon: String?,
    link: String?,
    tags: List,
    properties: C4Properties?,
    hostsSystems: List,
    hostsContainers: List,
    uses: List>,
    usedBy: List>,
) {
    this.configure(icon, link, tags, properties)
    hostsSystems.forEach { this.add(it) }
    hostsContainers.forEach { this.add(it) }
    uses.forEach { dep ->
        when (dep.destination) {
            is DeploymentNode -> this.uses(dep.destination, dep.description, dep.technology, dep.interactionStyle)
                .configure(dep.icon, dep.link, dep.tags, dep.properties)
            is InfrastructureNode -> this.uses(dep.destination, dep.description, dep.technology, dep.interactionStyle)
                .configure(dep.icon, dep.link, dep.tags, dep.properties)
            else -> throw IllegalArgumentException("DeploymentNode cant use ${dep.destination::class.java.name}")
        }
    }
    usedBy.forEach { dep ->
        when (dep.destination) {
            is DeploymentNode -> dep.destination.uses(this, dep.description, dep.technology, dep.interactionStyle)
                .configure(dep.icon, dep.link, dep.tags, dep.properties)
            is InfrastructureNode -> dep.destination.uses(this, dep.description, dep.technology, dep.interactionStyle)
                .configure(dep.icon, dep.link, dep.tags, dep.properties)
            else -> throw IllegalArgumentException("DeploymentNode cant be use by ${dep.destination::class.java.name}")
        }
    }
}