aboutsummaryrefslogtreecommitdiffstats
path: root/ms/blueprintsprocessor/application/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/uat/utils/UatServices.kt
blob: d233b8be32af08961fb17c1b6abe2b543c019c07 (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
/*-
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2019 Nordix Foundation.
 *  Modifications Copyright © 2023 Deutche Telekom AG
 * ================================================================================
 * 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.
 *
 * SPDX-License-Identifier: Apache-2.0
 * ============LICENSE_END=========================================================
 */
package org.onap.ccsdk.cds.blueprintsprocessor.uat.utils

import com.fasterxml.jackson.databind.ObjectMapper
import kotlinx.coroutines.reactor.awaitSingle
import kotlinx.coroutines.runBlocking
import org.onap.ccsdk.cds.blueprintsprocessor.uat.logging.LogColor.COLOR_SERVICES
import org.onap.ccsdk.cds.blueprintsprocessor.uat.logging.LogColor.resetContextColor
import org.onap.ccsdk.cds.blueprintsprocessor.uat.logging.LogColor.setContextColor
import org.onap.ccsdk.cds.controllerblueprints.core.BluePrintConstants.UAT_SPECIFICATION_FILE
import org.springframework.context.annotation.Profile
import org.springframework.http.HttpStatus
import org.springframework.http.MediaType
import org.springframework.http.codec.multipart.FilePart
import org.springframework.security.access.prepost.PreAuthorize
import org.springframework.web.bind.annotation.PostMapping
import org.springframework.web.bind.annotation.RequestMapping
import org.springframework.web.bind.annotation.RequestPart
import org.springframework.web.bind.annotation.RestController
import org.springframework.web.server.ResponseStatusException
import java.io.File
import java.util.zip.ZipFile

/**
 * Supporting services to help creating UAT specifications.
 *
 * @author Eliezio Oliveira
 */
@RestController
@RequestMapping("/api/v1/uat")
@Profile("uat")
open class UatServices(private val uatExecutor: UatExecutor, private val mapper: ObjectMapper) {

    @PostMapping("/verify", consumes = [MediaType.MULTIPART_FORM_DATA_VALUE])
    @PreAuthorize("hasRole('USER')")
    @Suppress("BlockingMethodInNonBlockingContext")
    open fun verify(@RequestPart("cba") cbaFile: FilePart) = runBlocking {
        setContextColor(COLOR_SERVICES)
        val tempFile = createTempFile()
        try {
            cbaFile.transferTo(tempFile)
                .doOnSuccess {
                    val uatSpec = readZipEntryAsText(tempFile, UAT_SPECIFICATION_FILE)
                    val cbaBytes = tempFile.readBytes()
                    uatExecutor.execute(uatSpec, cbaBytes)
                }.subscribe()
        } catch (e: AssertionError) {
            throw ResponseStatusException(HttpStatus.BAD_REQUEST, e.message)
        } catch (t: Throwable) {
            throw ResponseStatusException(HttpStatus.INTERNAL_SERVER_ERROR, t.message, t)
        } finally {
            tempFile.delete()
            resetContextColor()
        }
    }

    @PostMapping("/spy", consumes = [MediaType.MULTIPART_FORM_DATA_VALUE], produces = ["text/vnd.yaml"])
    @PreAuthorize("hasRole('USER')")
    @Suppress("BlockingMethodInNonBlockingContext")
    open fun spy(
        @RequestPart("cba") cbaFile: FilePart,
        @RequestPart("uat", required = false) uatFile: FilePart?
    ): String = runBlocking {
        val tempFile = createTempFile()
        val tempCbaFile = createTempFile()
        setContextColor(COLOR_SERVICES)
        try {
            val uatSpec = when {
                uatFile != null -> {
                    uatFile.transferTo(tempFile).thenReturn(tempFile).awaitSingle()
                    tempFile.readText()
                }
                else -> readZipEntryAsText(tempFile, UAT_SPECIFICATION_FILE)
            }
            val uat = UatDefinition.load(mapper, uatSpec)
            cbaFile.transferTo(tempCbaFile).thenReturn(tempCbaFile).awaitSingle()
            val cbaBytes = tempCbaFile.readBytes()
            val updatedUat = uatExecutor.execute(uat, cbaBytes)
            return@runBlocking updatedUat.dump(
                mapper,
                FIELDS_TO_EXCLUDE
            )
        } catch (t: Throwable) {
            throw ResponseStatusException(HttpStatus.INTERNAL_SERVER_ERROR, t.message, t)
        } finally {
            tempFile.delete()
            tempCbaFile.delete()
            resetContextColor()
        }
    }

    @Suppress("SameParameterValue")
    private fun readZipEntryAsText(file: File, entryName: String): String {
        return ZipFile(file).use { zipFile -> zipFile.readEntryAsText(entryName) }
    }

    private fun ZipFile.readEntryAsText(entryName: String): String {
        val zipEntry = getEntry(entryName)
        return getInputStream(zipEntry).readBytes().toString(Charsets.UTF_8)
    }

    companion object {

        // Fields that can be safely ignored from BPP response, and can be omitted on the UAT specification.
        private val FIELDS_TO_EXCLUDE = listOf("timestamp")
    }
}