2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.controller.sal.restconf.impl.test;
10 import static org.junit.Assert.assertEquals;
11 import static org.mockito.Matchers.any;
12 import static org.mockito.Mockito.doReturn;
13 import static org.mockito.Mockito.doThrow;
14 import static org.mockito.Mockito.mock;
15 import static org.mockito.Mockito.when;
16 import com.google.common.base.Optional;
17 import com.google.common.util.concurrent.CheckedFuture;
18 import java.io.FileNotFoundException;
19 import java.io.IOException;
20 import java.io.InputStream;
21 import java.io.UnsupportedEncodingException;
22 import java.net.URISyntaxException;
23 import javax.ws.rs.client.Entity;
24 import javax.ws.rs.core.Application;
25 import javax.ws.rs.core.MediaType;
26 import javax.ws.rs.core.Response;
27 import org.glassfish.jersey.server.ResourceConfig;
28 import org.glassfish.jersey.test.JerseyTest;
29 import org.junit.BeforeClass;
30 import org.junit.Test;
31 import org.opendaylight.controller.md.sal.common.api.data.OptimisticLockFailedException;
32 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
33 import org.opendaylight.controller.md.sal.dom.api.DOMMountPoint;
34 import org.opendaylight.controller.md.sal.dom.api.DOMMountPointService;
35 import org.opendaylight.controller.sal.rest.impl.JsonNormalizedNodeBodyReader;
36 import org.opendaylight.controller.sal.rest.impl.NormalizedNodeJsonBodyWriter;
37 import org.opendaylight.controller.sal.rest.impl.NormalizedNodeXmlBodyWriter;
38 import org.opendaylight.controller.sal.rest.impl.RestconfDocumentedExceptionMapper;
39 import org.opendaylight.controller.sal.rest.impl.XmlNormalizedNodeBodyReader;
40 import org.opendaylight.controller.sal.restconf.impl.BrokerFacade;
41 import org.opendaylight.controller.sal.restconf.impl.ControllerContext;
42 import org.opendaylight.controller.sal.restconf.impl.RestconfDocumentedException;
43 import org.opendaylight.controller.sal.restconf.impl.RestconfImpl;
44 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
45 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
46 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
48 public class RestPutOperationTest extends JerseyTest {
50 private static String xmlData;
51 private static String xmlData2;
52 private static String xmlData3;
54 private static BrokerFacade brokerFacade;
55 private static RestconfImpl restconfImpl;
56 private static SchemaContext schemaContextYangsIetf;
57 private static SchemaContext schemaContextTestModule;
60 public static void init() throws IOException {
61 schemaContextYangsIetf = TestUtils.loadSchemaContext("/full-versions/yangs");
62 schemaContextTestModule = TestUtils.loadSchemaContext("/full-versions/test-module");
63 final ControllerContext controllerContext = ControllerContext.getInstance();
64 controllerContext.setSchemas(schemaContextYangsIetf);
65 brokerFacade = mock(BrokerFacade.class);
66 restconfImpl = RestconfImpl.getInstance();
67 restconfImpl.setBroker(brokerFacade);
68 restconfImpl.setControllerContext(controllerContext);
72 private static void loadData() throws IOException {
73 final InputStream xmlStream = RestconfImplTest.class.getResourceAsStream("/parts/ietf-interfaces_interfaces.xml");
74 xmlData = TestUtils.getDocumentInPrintableForm(TestUtils.loadDocumentFrom(xmlStream));
75 final InputStream xmlStream2 = RestconfImplTest.class.getResourceAsStream("/full-versions/test-data2/data2.xml");
76 xmlData2 = TestUtils.getDocumentInPrintableForm(TestUtils.loadDocumentFrom(xmlStream2));
77 final InputStream xmlStream3 = RestconfImplTest.class.getResourceAsStream("/full-versions/test-data2/data7.xml");
78 xmlData3 = TestUtils.getDocumentInPrintableForm(TestUtils.loadDocumentFrom(xmlStream3));
82 protected Application configure() {
83 /* enable/disable Jersey logs to console */
84 // enable(TestProperties.LOG_TRAFFIC);
85 // enable(TestProperties.DUMP_ENTITY);
86 // enable(TestProperties.RECORD_LOG_LEVEL);
87 // set(TestProperties.RECORD_LOG_LEVEL, Level.ALL.intValue());
88 ResourceConfig resourceConfig = new ResourceConfig();
89 resourceConfig = resourceConfig.registerInstances(restconfImpl,new XmlNormalizedNodeBodyReader(),
90 new NormalizedNodeXmlBodyWriter(), new JsonNormalizedNodeBodyReader(), new NormalizedNodeJsonBodyWriter());
91 resourceConfig.registerClasses(RestconfDocumentedExceptionMapper.class);
92 return resourceConfig;
96 * Tests of status codes for "/config/{identifier}".
99 public void putConfigStatusCodes() throws UnsupportedEncodingException {
100 final String uri = "/config/ietf-interfaces:interfaces/interface/eth0";
101 mockCommitConfigurationDataPutMethod(true);
102 assertEquals(200, put(uri, MediaType.APPLICATION_XML, xmlData));
104 mockCommitConfigurationDataPutMethod(false);
105 assertEquals(500, put(uri, MediaType.APPLICATION_XML, xmlData));
107 assertEquals(400, put(uri, MediaType.APPLICATION_JSON, ""));
111 public void putConfigStatusCodesEmptyBody() throws UnsupportedEncodingException {
112 final String uri = "/config/ietf-interfaces:interfaces/interface/eth0";
113 final Response resp = target(uri).request(MediaType.APPLICATION_JSON).put(
114 Entity.entity("", MediaType.APPLICATION_JSON));
115 assertEquals(400, put(uri, MediaType.APPLICATION_JSON, ""));
119 public void testRpcResultCommitedToStatusCodesWithMountPoint() throws UnsupportedEncodingException,
120 FileNotFoundException, URISyntaxException {
122 final CheckedFuture<Void, TransactionCommitFailedException> dummyFuture = mock(CheckedFuture.class);
125 brokerFacade.commitConfigurationDataPut(any(DOMMountPoint.class), any(YangInstanceIdentifier.class),
126 any(NormalizedNode.class))).thenReturn(dummyFuture);
128 final DOMMountPoint mountInstance = mock(DOMMountPoint.class);
129 when(mountInstance.getSchemaContext()).thenReturn(schemaContextTestModule);
130 final DOMMountPointService mockMountService = mock(DOMMountPointService.class);
131 when(mockMountService.getMountPoint(any(YangInstanceIdentifier.class))).thenReturn(Optional.of(mountInstance));
133 ControllerContext.getInstance().setMountService(mockMountService);
135 String uri = "/config/ietf-interfaces:interfaces/interface/0/yang-ext:mount/test-module:cont";
136 assertEquals(200, put(uri, MediaType.APPLICATION_XML, xmlData2));
138 uri = "/config/ietf-interfaces:interfaces/yang-ext:mount/test-module:cont";
139 assertEquals(200, put(uri, MediaType.APPLICATION_XML, xmlData2));
143 public void putDataMountPointIntoHighestElement() throws UnsupportedEncodingException, URISyntaxException {
144 final CheckedFuture<Void, TransactionCommitFailedException> dummyFuture = mock(CheckedFuture.class);
146 brokerFacade.commitConfigurationDataPut(any(DOMMountPoint.class), any(YangInstanceIdentifier.class),
147 any(NormalizedNode.class))).thenReturn(dummyFuture);
149 final DOMMountPoint mountInstance = mock(DOMMountPoint.class);
150 when(mountInstance.getSchemaContext()).thenReturn(schemaContextTestModule);
151 final DOMMountPointService mockMountService = mock(DOMMountPointService.class);
152 when(mockMountService.getMountPoint(any(YangInstanceIdentifier.class))).thenReturn(Optional.of(mountInstance));
154 ControllerContext.getInstance().setMountService(mockMountService);
156 final String uri = "/config/ietf-interfaces:interfaces/yang-ext:mount";
157 assertEquals(200, put(uri, MediaType.APPLICATION_XML, xmlData3));
161 public void putWithOptimisticLockFailedException() throws UnsupportedEncodingException {
163 final String uri = "/config/ietf-interfaces:interfaces/interface/eth0";
165 doThrow(OptimisticLockFailedException.class).
166 when(brokerFacade).commitConfigurationDataPut(
167 any(YangInstanceIdentifier.class), any(NormalizedNode.class));
169 assertEquals(500, put(uri, MediaType.APPLICATION_XML, xmlData));
171 doThrow(OptimisticLockFailedException.class).doReturn(mock(CheckedFuture.class)).
172 when(brokerFacade).commitConfigurationDataPut(
173 any(YangInstanceIdentifier.class), any(NormalizedNode.class));
175 assertEquals(200, put(uri, MediaType.APPLICATION_XML, xmlData));
179 public void putWithTransactionCommitFailedException() throws UnsupportedEncodingException {
181 final String uri = "/config/ietf-interfaces:interfaces/interface/eth0";
183 doThrow(TransactionCommitFailedException.class).
184 when(brokerFacade).commitConfigurationDataPut(
185 any(YangInstanceIdentifier.class), any(NormalizedNode.class));
187 assertEquals(500, put(uri, MediaType.APPLICATION_XML, xmlData));
190 private int put(final String uri, final String mediaType, final String data) throws UnsupportedEncodingException {
191 return target(uri).request(mediaType).put(Entity.entity(data, mediaType)).getStatus();
194 private void mockCommitConfigurationDataPutMethod(final boolean noErrors) {
196 doReturn(mock(CheckedFuture.class)).when(brokerFacade).commitConfigurationDataPut(
197 any(YangInstanceIdentifier.class), any(NormalizedNode.class));
199 doThrow(RestconfDocumentedException.class).when(brokerFacade).commitConfigurationDataPut(
200 any(YangInstanceIdentifier.class), any(NormalizedNode.class));