aboutsummaryrefslogtreecommitdiffstats
path: root/ms/blueprintsprocessor/functions/resource-resolution/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/functions/resource/resolution/processor/ResourceAssignmentProcessor.kt
blob: ce00ac17b928c86056e54002c8fbd1c2c1a2995a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
/*
 *  Copyright © 2018 IBM.
 *
 *  Modifications Copyright © 2017-2019 AT&T, Bell Canada
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */

package org.onap.ccsdk.cds.blueprintsprocessor.functions.resource.resolution.processor

import com.fasterxml.jackson.databind.JsonNode
import org.apache.commons.collections.MapUtils
import org.onap.ccsdk.cds.blueprintsprocessor.functions.resource.resolution.ResourceAssignmentRuntimeService
import org.onap.ccsdk.cds.blueprintsprocessor.functions.resource.resolution.utils.ResourceAssignmentUtils
import org.onap.ccsdk.cds.controllerblueprints.core.BlueprintConstants
import org.onap.ccsdk.cds.controllerblueprints.core.BlueprintException
import org.onap.ccsdk.cds.controllerblueprints.core.BlueprintProcessorException
import org.onap.ccsdk.cds.controllerblueprints.core.asJsonNode
import org.onap.ccsdk.cds.controllerblueprints.core.interfaces.BlueprintFunctionNode
import org.onap.ccsdk.cds.controllerblueprints.core.isNullOrMissing
import org.onap.ccsdk.cds.controllerblueprints.core.service.BlueprintVelocityTemplateService
import org.onap.ccsdk.cds.controllerblueprints.resource.dict.ResourceAssignment
import org.onap.ccsdk.cds.controllerblueprints.resource.dict.ResourceDefinition
import org.slf4j.LoggerFactory
import java.util.HashMap

abstract class ResourceAssignmentProcessor : BlueprintFunctionNode<ResourceAssignment, Boolean> {

    private val log = LoggerFactory.getLogger(ResourceAssignmentProcessor::class.java)

    lateinit var raRuntimeService: ResourceAssignmentRuntimeService
    var resourceDictionaries: MutableMap<String, ResourceDefinition> = hashMapOf()
    var resourceAssignments: MutableList<ResourceAssignment> = arrayListOf()

    var scriptPropertyInstances: MutableMap<String, Any> = hashMapOf()
    lateinit var scriptType: String

    /**
     * This will be called from the scripts to serve instance from runtime to scripts.
     */
    open fun <T> scriptPropertyInstanceType(name: String): T {
        return scriptPropertyInstances as? T
            ?: throw BlueprintProcessorException("couldn't get script property instance ($name)")
    }

    open fun setFromInput(resourceAssignment: ResourceAssignment): Boolean {
        try {
            val value = raRuntimeService.getInputValue(resourceAssignment.name)
            if (!value.isNullOrMissing()) {
                log.debug(
                    "For Resource:(${resourceAssignment.name}) found value:({}) in input-data.",
                    ResourceAssignmentUtils.getValueToLog(resourceAssignment.property?.metadata, value)
                )
                ResourceAssignmentUtils.setResourceDataValue(resourceAssignment, raRuntimeService, value)
                return true
            }
        } catch (e: BlueprintProcessorException) {
            // NoOp - couldn't find value from input
        }
        return false
    }

    open fun setFromInputKeyDependencies(keys: MutableList<String>, resourceAssignment: ResourceAssignment): Boolean {
        try {
            for (dependencyKey in keys) {
                var value = raRuntimeService.getInputValue(dependencyKey)
                if (!value.isNullOrMissing()) {
                    log.debug(
                        "For Resource:(${resourceAssignment.name}) found value:({}) in input-data under: ($dependencyKey).",
                        ResourceAssignmentUtils.getValueToLog(resourceAssignment.property?.metadata, value)
                    )
                    ResourceAssignmentUtils.setResourceDataValue(resourceAssignment, raRuntimeService, value)
                    return true
                }
            }
        } catch (e: BlueprintProcessorException) {
            // NoOp - couldn't find value from input
        }
        return false
    }

    open fun resourceDefinition(name: String): ResourceDefinition? {
        return if (resourceDictionaries.containsKey(name)) resourceDictionaries[name] else null
    }

    open fun resolveInputKeyMappingVariables(inputKeyMapping: Map<String, String>): Map<String, JsonNode> {
        val resolvedInputKeyMapping = HashMap<String, JsonNode>()
        if (MapUtils.isNotEmpty(inputKeyMapping)) {
            for ((key, value) in inputKeyMapping) {
                val resultValue = raRuntimeService.getResolutionStore(value)
                resolvedInputKeyMapping[key] = resultValue
            }
        }
        return resolvedInputKeyMapping
    }

    open suspend fun resolveFromInputKeyMapping(valueToResolve: String, keyMapping: MutableMap<String, JsonNode>):
        String {
            if (valueToResolve.isEmpty() || !valueToResolve.contains("$")) {
                return valueToResolve
            }
            // TODO("Optimize to JSON Node directly without velocity").asJsonNode().toString()
            return BlueprintVelocityTemplateService.generateContent(valueToResolve, keyMapping.asJsonNode().toString())
        }

    final override suspend fun applyNB(resourceAssignment: ResourceAssignment): Boolean {
        try {
            processNB(resourceAssignment)
        } catch (runtimeException: RuntimeException) {
            log.error("failed in ${getName()} : ${runtimeException.message}", runtimeException)
            recoverNB(runtimeException, resourceAssignment)
            return false
        }
        return true
    }

    suspend fun executeScript(resourceAssignment: ResourceAssignment) {
        return when (scriptType) {
            BlueprintConstants.SCRIPT_JYTHON -> {
                executeScriptBlocking(resourceAssignment)
            }
            else -> {
                executeScriptNB(resourceAssignment)
            }
        }
    }

    private suspend fun executeScriptNB(resourceAssignment: ResourceAssignment) {
        try {
            processNB(resourceAssignment)
        } catch (runtimeException: RuntimeException) {
            log.error("failed in ${getName()} : ${runtimeException.message}", runtimeException)
            recoverNB(runtimeException, resourceAssignment)
        }
    }

    private fun executeScriptBlocking(resourceAssignment: ResourceAssignment) {
        try {
            process(resourceAssignment)
        } catch (runtimeException: RuntimeException) {
            log.error("failed in ResourceAssignmentProcessor : ${runtimeException.message}", runtimeException)
            recover(runtimeException, resourceAssignment)
        }
    }

    /**
     * If Jython Script, Override Blocking methods(process() and recover())
     * If Kotlin or Internal Scripts, Override non blocking methods ( processNB() and recoverNB()), so default
     * blocking
     * methods will have default implementation,
     *
     * Always applyNB() method will be invoked, apply() won't be called from parent
     */

    final override fun apply(resourceAssignment: ResourceAssignment): Boolean {
        throw BlueprintException("Not Implemented, use applyNB method")
    }

    final override fun prepareRequest(resourceAssignment: ResourceAssignment): ResourceAssignment {
        throw BlueprintException("Not Implemented required")
    }

    final override fun prepareResponse(): Boolean {
        throw BlueprintException("Not Implemented required")
    }

    final override suspend fun prepareRequestNB(resourceAssignment: ResourceAssignment): ResourceAssignment {
        throw BlueprintException("Not Implemented required")
    }

    final override suspend fun prepareResponseNB(): Boolean {
        throw BlueprintException("Not Implemented required")
    }

    override fun process(resourceAssignment: ResourceAssignment) {
        throw BlueprintException("Not Implemented, child class will implement this")
    }

    override fun recover(runtimeException: RuntimeException, resourceAssignment: ResourceAssignment) {
        throw BlueprintException("Not Implemented, child class will implement this")
    }

    fun addError(type: String, name: String, error: String) {
        raRuntimeService.getBlueprintError().addError(type, name, error, getName())
    }

    fun addError(error: String) {
        raRuntimeService.getBlueprintError().addError(error, getName())
    }

    fun isTemplateKeyValueNull(resourceAssignment: ResourceAssignment): Boolean {
        val resourceProp = checkNotNull(resourceAssignment.property) {
            "Failed to populate mandatory resource resource mapping $resourceAssignment"
        }
        if (resourceProp.required != null && resourceProp.required!! &&
            resourceProp.value.isNullOrMissing()
        ) {
            return true
        }
        return false
    }
}