summaryrefslogtreecommitdiffstats
path: root/cps-rest/src/test/groovy/org/onap/cps/rest/controller/DataRestControllerSpec.groovy
blob: 727a16e958e418d3fa31300773037461e7a60ae1 (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
/*
 *  ============LICENSE_START=======================================================
 *  Copyright (C) 2021 Nordix Foundation
 *  Modifications Copyright (C) 2021 Pantheon.tech
 *  ================================================================================
 *  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.cps.rest.controller

import static org.onap.cps.spi.FetchDescendantsOption.INCLUDE_ALL_DESCENDANTS
import static org.onap.cps.spi.FetchDescendantsOption.OMIT_DESCENDANTS
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post

import com.google.common.collect.ImmutableMap
import org.modelmapper.ModelMapper
import org.onap.cps.api.CpsAdminService
import org.onap.cps.api.CpsDataService
import org.onap.cps.api.CpsModuleService
import org.onap.cps.spi.exceptions.AnchorNotFoundException
import org.onap.cps.spi.exceptions.DataNodeNotFoundException
import org.onap.cps.spi.exceptions.DataspaceNotFoundException
import org.onap.cps.spi.model.DataNode
import org.onap.cps.spi.model.DataNodeBuilder
import org.spockframework.spring.SpringBean
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.beans.factory.annotation.Value
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest
import org.springframework.http.HttpStatus
import org.springframework.http.MediaType
import org.springframework.test.web.servlet.MockMvc
import spock.lang.Shared
import spock.lang.Specification
import spock.lang.Unroll

import javax.annotation.PostConstruct

@WebMvcTest
class DataRestControllerSpec extends Specification {

    @SpringBean
    CpsDataService mockCpsDataService = Mock()

    @SpringBean
    CpsModuleService mockCpsModuleService = Mock()

    @SpringBean
    CpsAdminService mockCpsAdminService = Mock()

    @SpringBean
    ModelMapper modelMapper = Mock()

    @Autowired
    MockMvc mvc

    @Value('${rest.api.cps-base-path}')
    def basePath

    String dataNodeEndpoint
    def dataspaceName = 'my_dataspace'
    def anchorName = 'my_anchor'

    @Shared
    static DataNode dataNodeNoChildren = new DataNodeBuilder().withXpath("/xpath")
            .withLeaves(ImmutableMap.of("leaf", "value")).build()

    @Shared
    static DataNode dataNodeWithChild = new DataNodeBuilder().withXpath("/parent")
            .withChildDataNodes(Arrays.asList(
                    new DataNodeBuilder().withXpath("/parent/child").build()
            )).build()

    @PostConstruct
    def initEndpoints() {
        dataNodeEndpoint = "$basePath/v1/dataspaces/$dataspaceName/anchors/$anchorName/nodes"
    }

    def 'Create a node.'() {
        given: 'an endpoint'
            def json = 'some json (this is not validated)'
        when: 'post is invoked'
            def response = mvc.perform(
                    post(dataNodeEndpoint).contentType(MediaType.APPLICATION_JSON).content(json)
            ).andReturn().response
        then: 'the java API is called with the correct parameters'
            1 * mockCpsDataService.saveData(dataspaceName, anchorName, json)
            response.status == HttpStatus.CREATED.value()
    }

    @Unroll
    def 'Get data node with #scenario.'() {
        given: 'the service returns data node #scenario'
            mockCpsDataService.getDataNode(dataspaceName, anchorName, xpath, fetchDescendantsOption) >> dataNode
        when: 'get request is performed through REST API'
            def response = mvc.perform(
                    get(dataNodeEndpoint)
                            .param('cps-path', xpath)
                            .param('include-descendants', includeDescendants)
            ).andReturn().response
        then: 'assert the success response returned'
            response.status == HttpStatus.OK.value()
        and: 'response contains expected value'
            response.contentAsString.contains(checkString)
        where:
            scenario                    | dataNode           | xpath     | includeDescendants | fetchDescendantsOption  || checkString
            'no descendants by default' | dataNodeNoChildren | '/xpath'  | ''                 | OMIT_DESCENDANTS        || '"leaf"'
            'no descendant explicitly'  | dataNodeNoChildren | '/xpath'  | 'false'            | OMIT_DESCENDANTS        || '"leaf"'
            'with descendants'          | dataNodeWithChild  | '/parent' | 'true'             | INCLUDE_ALL_DESCENDANTS || '"child"'
    }

    @Unroll
    def 'Get data node error scenario: #scenario.'() {
        given: 'the service returns throws an exception'
            mockCpsDataService.getDataNode(dataspaceName, anchorName, xpath, _) >> { throw exception }
        when: 'get request is performed through REST API'
            def response = mvc.perform(
                    get(dataNodeEndpoint).param("cps-path", xpath)
            ).andReturn().response
        then: 'assert the success response returned'
            response.status == httpStatus.value()
        where:
            scenario       | xpath     | exception                                 || httpStatus
            'no dataspace' | '/x-path' | new DataspaceNotFoundException('')        || HttpStatus.BAD_REQUEST
            'no anchor'    | '/x-path' | new AnchorNotFoundException('', '')       || HttpStatus.BAD_REQUEST
            'no data'      | '/x-path' | new DataNodeNotFoundException('', '', '') || HttpStatus.NOT_FOUND
            'empty path'   | ''        | new IllegalStateException()               || HttpStatus.NOT_IMPLEMENTED
    }
}