aboutsummaryrefslogtreecommitdiffstats
path: root/ms/blueprintsprocessor/modules/inbounds/designer-api/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/designer/api/BlueprintManagementGRPCHandler.kt
blob: 97e43ec89e42f37e6d8872fc94a2feec8cf89082 (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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
/*
 * Copyright © 2017-2018 AT&T Intellectual Property.
 * Modifications Copyright © 2019 Bell Canada.
 * Modifications Copyright © 2019 IBM.
 *
 * 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.designer.api

import com.google.protobuf.ByteString
import com.google.protobuf.util.JsonFormat
import io.grpc.stub.StreamObserver
import kotlinx.coroutines.runBlocking
import org.onap.ccsdk.cds.blueprintsprocessor.designer.api.handler.BlueprintModelHandler
import org.onap.ccsdk.cds.controllerblueprints.common.api.CommonHeader
import org.onap.ccsdk.cds.controllerblueprints.common.api.EventType
import org.onap.ccsdk.cds.controllerblueprints.common.api.Status
import org.onap.ccsdk.cds.controllerblueprints.core.BlueprintConstants
import org.onap.ccsdk.cds.controllerblueprints.core.BlueprintProcessorException
import org.onap.ccsdk.cds.controllerblueprints.core.asJsonString
import org.onap.ccsdk.cds.controllerblueprints.core.emptyTONull
import org.onap.ccsdk.cds.controllerblueprints.core.utils.currentTimestamp
import org.onap.ccsdk.cds.controllerblueprints.management.api.BlueprintBootstrapInput
import org.onap.ccsdk.cds.controllerblueprints.management.api.BlueprintDownloadInput
import org.onap.ccsdk.cds.controllerblueprints.management.api.BlueprintManagementOutput
import org.onap.ccsdk.cds.controllerblueprints.management.api.BlueprintManagementServiceGrpc
import org.onap.ccsdk.cds.controllerblueprints.management.api.BlueprintRemoveInput
import org.onap.ccsdk.cds.controllerblueprints.management.api.BlueprintUploadInput
import org.onap.ccsdk.cds.controllerblueprints.management.api.DownloadAction
import org.onap.ccsdk.cds.controllerblueprints.management.api.FileChunk
import org.onap.ccsdk.cds.controllerblueprints.management.api.RemoveAction
import org.onap.ccsdk.cds.controllerblueprints.management.api.UploadAction
import org.onap.ccsdk.cds.error.catalog.core.ErrorCatalogCodes
import org.onap.ccsdk.cds.error.catalog.core.GrpcErrorCodes
import org.onap.ccsdk.cds.error.catalog.core.utils.errorMessageOrDefault
import org.onap.ccsdk.cds.error.catalog.services.ErrorCatalogService
import org.slf4j.LoggerFactory
import org.springframework.security.access.prepost.PreAuthorize
import org.springframework.stereotype.Service

// TODO("Convert to coroutines handler")
@Service
open class BlueprintManagementGRPCHandler(
    private val bluePrintModelHandler: BlueprintModelHandler,
    private val errorCatalogService: ErrorCatalogService
) :
    BlueprintManagementServiceGrpc.BlueprintManagementServiceImplBase() {

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

    @PreAuthorize("hasRole('USER')")
    override fun uploadBlueprint(
        request: BlueprintUploadInput,
        responseObserver: StreamObserver<BlueprintManagementOutput>
    ) {

        runBlocking {
            // TODO("catch if request id is missing")
            log.info("request(${request.commonHeader.requestId})")
            try {
                /** Get the file byte array */
                val byteArray = request.fileChunk.chunk.toByteArray()

                /** Get the Upload Action */
                val uploadAction = request.actionIdentifiers?.actionName.emptyTONull()
                    ?: UploadAction.DRAFT.toString()

                when (uploadAction) {
                    UploadAction.DRAFT.toString() -> {
                        val blueprintModel = bluePrintModelHandler.upload(byteArray, false)
                        responseObserver.onNext(successStatus(request.commonHeader, blueprintModel.asJsonString()))
                    }
                    UploadAction.PUBLISH.toString() -> {
                        val blueprintModel = bluePrintModelHandler.upload(byteArray, true)
                        responseObserver.onNext(successStatus(request.commonHeader, blueprintModel.asJsonString()))
                    }
                    UploadAction.VALIDATE.toString() -> {
                        // TODO("Not Implemented")
                        responseObserver.onNext(
                            failStatus(
                                request.commonHeader,
                                "Upload action($uploadAction) not implemented",
                                BlueprintProcessorException("Not Implemented")
                            )
                        )
                    }
                    UploadAction.ENRICH.toString() -> {
                        val enrichedByteArray = bluePrintModelHandler.enrichBlueprintFileSource(byteArray)
                        responseObserver.onNext(outputWithFileBytes(request.commonHeader, enrichedByteArray))
                    }
                    else -> {
                        responseObserver.onNext(
                            failStatus(
                                request.commonHeader,
                                "Upload action($uploadAction) not implemented",
                                BlueprintProcessorException("Not implemented")
                            )
                        )
                    }
                }
            } catch (e: Exception) {
                responseObserver.onNext(
                    failStatus(
                        request.commonHeader,
                        "request(${request.commonHeader.requestId}): Failed to upload CBA", e
                    )
                )
            } finally {
                responseObserver.onCompleted()
            }
        }
    }

    @PreAuthorize("hasRole('USER')")
    override fun downloadBlueprint(
        request: BlueprintDownloadInput,
        responseObserver: StreamObserver<BlueprintManagementOutput>
    ) {
        runBlocking {
            val blueprintName = request.actionIdentifiers.blueprintName
            val blueprintVersion = request.actionIdentifiers.blueprintVersion
            val blueprint = "blueprint $blueprintName:$blueprintVersion"

            /** Get the Search Action */
            val searchAction = request.actionIdentifiers?.actionName.emptyTONull()
                ?: DownloadAction.SEARCH.toString()

            log.info("request(${request.commonHeader.requestId}): Received download $blueprint")
            try {
                when (searchAction) {
                    DownloadAction.SEARCH.toString() -> {
                        val downloadByteArray = bluePrintModelHandler.download(blueprintName, blueprintVersion)
                        responseObserver.onNext(outputWithFileBytes(request.commonHeader, downloadByteArray))
                    }
                    else -> {
                        responseObserver.onNext(
                            failStatus(
                                request.commonHeader,
                                "Search action($searchAction) not implemented",
                                BlueprintProcessorException("Not implemented")
                            )
                        )
                    }
                }
            } catch (e: Exception) {
                responseObserver.onNext(
                    failStatus(
                        request.commonHeader,
                        "request(${request.commonHeader.requestId}): Failed to delete $blueprint", e
                    )
                )
            } finally {
                responseObserver.onCompleted()
            }
        }
    }

    @PreAuthorize("hasRole('USER')")
    override fun removeBlueprint(
        request: BlueprintRemoveInput,
        responseObserver:
            StreamObserver<BlueprintManagementOutput>
    ) {

        runBlocking {
            val blueprintName = request.actionIdentifiers.blueprintName
            val blueprintVersion = request.actionIdentifiers.blueprintVersion
            val blueprint = "blueprint $blueprintName:$blueprintVersion"

            log.info("request(${request.commonHeader.requestId}): Received delete $blueprint")

            /** Get the Remove Action */
            val removeAction = request.actionIdentifiers?.actionName.emptyTONull()
                ?: RemoveAction.DEFAULT.toString()

            try {
                when (removeAction) {
                    RemoveAction.DEFAULT.toString() -> {
                        bluePrintModelHandler.deleteBlueprintModel(blueprintName, blueprintVersion)
                        responseObserver.onNext(successStatus(request.commonHeader))
                    }
                    else -> {
                        responseObserver.onNext(
                            failStatus(
                                request.commonHeader,
                                "Remove action($removeAction) not implemented",
                                BlueprintProcessorException("Not implemented")
                            )
                        )
                    }
                }
            } catch (e: Exception) {
                responseObserver.onNext(
                    failStatus(
                        request.commonHeader,
                        "request(${request.commonHeader.requestId}): Failed to delete $blueprint", e
                    )
                )
            } finally {
                responseObserver.onCompleted()
            }
        }
    }

    override fun bootstrapBlueprint(
        request: BlueprintBootstrapInput,
        responseObserver: StreamObserver<BlueprintManagementOutput>
    ) {
        runBlocking {
            try {
                log.info("request(${request.commonHeader.requestId}): Received bootstrap request")
                val bootstrapRequest = BootstrapRequest().apply {
                    loadModelType = request.loadModelType
                    loadResourceDictionary = request.loadResourceDictionary
                    loadCBA = request.loadCBA
                }
                /** Perform bootstrap of Model Types, Resource Definitions and CBA */
                bluePrintModelHandler.bootstrapBlueprint(bootstrapRequest)
                responseObserver.onNext(successStatus(request.commonHeader))
            } catch (e: Exception) {
                responseObserver.onNext(
                    failStatus(
                        request.commonHeader,
                        "request(${request.commonHeader.requestId}): Failed to bootstrap", e
                    )
                )
            } finally {
                responseObserver.onCompleted()
            }
        }
    }

    private fun outputWithFileBytes(header: CommonHeader, byteArray: ByteArray): BlueprintManagementOutput =
        BlueprintManagementOutput.newBuilder()
            .setCommonHeader(header)
            .setFileChunk(FileChunk.newBuilder().setChunk(ByteString.copyFrom(byteArray)))
            .setStatus(
                Status.newBuilder()
                    .setTimestamp(currentTimestamp())
                    .setEventType(EventType.EVENT_COMPONENT_EXECUTED)
                    .setMessage(BlueprintConstants.STATUS_SUCCESS)
                    .setCode(200)
                    .build()
            )
            .build()

    private fun successStatus(header: CommonHeader, propertyContent: String? = null): BlueprintManagementOutput {
        // Populate Response Payload
        val propertiesBuilder = BlueprintManagementOutput.newBuilder().propertiesBuilder
        propertyContent?.let {
            JsonFormat.parser().merge(propertyContent, propertiesBuilder)
        }
        return BlueprintManagementOutput.newBuilder()
            .setCommonHeader(header)
            .setProperties(propertiesBuilder.build())
            .setStatus(
                Status.newBuilder()
                    .setTimestamp(currentTimestamp())
                    .setMessage(BlueprintConstants.STATUS_SUCCESS)
                    .setEventType(EventType.EVENT_COMPONENT_EXECUTED)
                    .setCode(200)
                    .build()
            )
            .build()
    }

    private fun failStatus(header: CommonHeader, message: String, e: Exception): BlueprintManagementOutput {
        log.error(message, e)
        return if (e is BlueprintProcessorException) onErrorCatalog(header, message, e) else onError(header, message, e)
    }

    private fun onError(header: CommonHeader, message: String, error: Exception): BlueprintManagementOutput {
        val code = GrpcErrorCodes.code(ErrorCatalogCodes.GENERIC_FAILURE)
        return BlueprintManagementOutput.newBuilder()
            .setCommonHeader(header)
            .setStatus(
                Status.newBuilder()
                    .setTimestamp(currentTimestamp())
                    .setMessage(BlueprintConstants.STATUS_FAILURE)
                    .setEventType(EventType.EVENT_COMPONENT_FAILURE)
                    .setErrorMessage("Error : $message \n Details: ${error.errorMessageOrDefault()}")
                    .setCode(code)
                    .build()
            )
            .build()
    }

    private fun onErrorCatalog(header: CommonHeader, message: String, error: BlueprintProcessorException):
        BlueprintManagementOutput {
            val err = if (error.protocol == "") {
                error.grpc(ErrorCatalogCodes.GENERIC_FAILURE)
            } else {
                error.convertToGrpc()
            }
            val errorPayload = errorCatalogService.errorPayload(err.addErrorPayloadMessage(message))
            return BlueprintManagementOutput.newBuilder()
                .setCommonHeader(header)
                .setStatus(
                    Status.newBuilder()
                        .setTimestamp(currentTimestamp())
                        .setMessage(BlueprintConstants.STATUS_FAILURE)
                        .setEventType(EventType.EVENT_COMPONENT_FAILURE)
                        .setErrorMessage("Error : ${errorPayload.message}")
                        .setCode(errorPayload.code)
                        .build()
                )
                .build()
        }
}