restconf/restconf-nb-bierman02/src/test/java/org/opendaylight/controller/sal/restconf/impl/test/RestPutOperationTest.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.controller.sal.restconf.impl.test;
   9
  10 import static org.junit.Assert.assertEquals;
  11 import static org.mockito.ArgumentMatchers.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
  17 import java.io.FileNotFoundException;
  18 import java.io.IOException;
  19 import java.io.InputStream;
  20 import java.io.UnsupportedEncodingException;
  21 import java.net.URISyntaxException;
  22 import javax.ws.rs.client.Entity;
  23 import javax.ws.rs.core.Application;
  24 import javax.ws.rs.core.MediaType;
  25 import javax.ws.rs.core.Response;
  26 import javax.ws.rs.core.Response.Status;
  27 import org.glassfish.jersey.server.ResourceConfig;
  28 import org.glassfish.jersey.test.JerseyTest;
  29 import org.junit.BeforeClass;
  30 import org.junit.Ignore;
  31 import org.junit.Test;
  32 import org.opendaylight.controller.md.sal.rest.common.TestRestconfUtils;
  33 import org.opendaylight.mdsal.common.api.CommitInfo;
  34 import org.opendaylight.mdsal.common.api.OptimisticLockFailedException;
  35 import org.opendaylight.mdsal.common.api.TransactionCommitFailedException;
  36 import org.opendaylight.mdsal.dom.api.DOMMountPoint;
  37 import org.opendaylight.netconf.sal.rest.impl.JsonNormalizedNodeBodyReader;
  38 import org.opendaylight.netconf.sal.rest.impl.NormalizedNodeJsonBodyWriter;
  39 import org.opendaylight.netconf.sal.rest.impl.NormalizedNodeXmlBodyWriter;
  40 import org.opendaylight.netconf.sal.rest.impl.RestconfDocumentedExceptionMapper;
  41 import org.opendaylight.netconf.sal.rest.impl.XmlNormalizedNodeBodyReader;
  42 import org.opendaylight.netconf.sal.restconf.impl.BrokerFacade;
  43 import org.opendaylight.netconf.sal.restconf.impl.ControllerContext;
  44 import org.opendaylight.netconf.sal.restconf.impl.PutResult;
  45 import org.opendaylight.netconf.sal.restconf.impl.RestconfImpl;
  46 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
  47 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  48 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  49 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  50 import org.opendaylight.yangtools.yang.parser.spi.meta.ReactorException;
  51
  52 //TODO UNSTABLE TESTS - FIX ME
  53 @Ignore
  54 public class RestPutOperationTest extends JerseyTest {
  55
  56     private static String xmlData;
  57     private static String xmlData2;
  58     private static String xmlData3;
  59
  60     private static SchemaContext schemaContextYangsIetf;
  61     private static SchemaContext schemaContextTestModule;
  62
  63     private BrokerFacade brokerFacade;
  64     private RestconfImpl restconfImpl;
  65     private DOMMountPoint mountInstance;
  66
  67     @BeforeClass
  68     public static void init() throws IOException, ReactorException {
  69         schemaContextYangsIetf = TestUtils.loadSchemaContext("/full-versions/yangs");
  70         schemaContextTestModule = TestUtils.loadSchemaContext("/full-versions/test-module");
  71         loadData();
  72     }
  73
  74     private static void loadData() throws IOException {
  75         final InputStream xmlStream =
  76                 RestconfImplTest.class.getResourceAsStream("/parts/ietf-interfaces_interfaces.xml");
  77         xmlData = TestUtils.getDocumentInPrintableForm(TestUtils.loadDocumentFrom(xmlStream));
  78         final InputStream xmlStream2 =
  79                 RestconfImplTest.class.getResourceAsStream("/full-versions/test-data2/data2.xml");
  80         xmlData2 = TestUtils.getDocumentInPrintableForm(TestUtils.loadDocumentFrom(xmlStream2));
  81         final InputStream xmlStream3 =
  82                 RestconfImplTest.class.getResourceAsStream("/full-versions/test-data2/data7.xml");
  83         xmlData3 = TestUtils.getDocumentInPrintableForm(TestUtils.loadDocumentFrom(xmlStream3));
  84     }
  85
  86     @Override
  87     protected Application configure() {
  88         /* enable/disable Jersey logs to console */
  89         // enable(TestProperties.LOG_TRAFFIC);
  90         // enable(TestProperties.DUMP_ENTITY);
  91         // enable(TestProperties.RECORD_LOG_LEVEL);
  92         // set(TestProperties.RECORD_LOG_LEVEL, Level.ALL.intValue());
  93
  94         mountInstance = mock(DOMMountPoint.class);
  95         final ControllerContext controllerContext =
  96                 TestRestconfUtils.newControllerContext(schemaContextYangsIetf, mountInstance);
  97         brokerFacade = mock(BrokerFacade.class);
  98         restconfImpl = RestconfImpl.newInstance(brokerFacade, controllerContext);
  99
 100         ResourceConfig resourceConfig = new ResourceConfig();
 101         resourceConfig = resourceConfig.registerInstances(restconfImpl,
 102                 new XmlNormalizedNodeBodyReader(controllerContext), new NormalizedNodeXmlBodyWriter(),
 103                 new JsonNormalizedNodeBodyReader(controllerContext), new NormalizedNodeJsonBodyWriter(),
 104                 new RestconfDocumentedExceptionMapper(controllerContext));
 105         return resourceConfig;
 106     }
 107
 108     /**
 109      * Tests of status codes for "/config/{identifier}".
 110      */
 111     @Test
 112     public void putConfigStatusCodes() throws UnsupportedEncodingException {
 113         final String uri = "/config/ietf-interfaces:interfaces/interface/eth0";
 114         mockCommitConfigurationDataPutMethod(true);
 115         assertEquals(500, put(uri, MediaType.APPLICATION_XML, xmlData));
 116
 117         mockCommitConfigurationDataPutMethod(false);
 118         assertEquals(500, put(uri, MediaType.APPLICATION_XML, xmlData));
 119
 120         assertEquals(400, put(uri, MediaType.APPLICATION_JSON, ""));
 121     }
 122
 123     @Test
 124     public void putConfigStatusCodesEmptyBody() throws UnsupportedEncodingException {
 125         final String uri = "/config/ietf-interfaces:interfaces/interface/eth0";
 126         @SuppressWarnings("unused")
 127         final Response resp = target(uri).request(MediaType.APPLICATION_JSON).put(
 128                 Entity.entity("", MediaType.APPLICATION_JSON));
 129         assertEquals(400, put(uri, MediaType.APPLICATION_JSON, ""));
 130     }
 131
 132     @Test
 133     public void testRpcResultCommitedToStatusCodesWithMountPoint() throws UnsupportedEncodingException,
 134             FileNotFoundException, URISyntaxException {
 135         final PutResult result = mock(PutResult.class);
 136         when(brokerFacade.commitMountPointDataPut(any(DOMMountPoint.class), any(YangInstanceIdentifier.class),
 137             any(NormalizedNode.class), null, null)).thenReturn(result);
 138         doReturn(CommitInfo.emptyFluentFuture()).when(result).getFutureOfPutData();
 139         when(result.getStatus()).thenReturn(Status.OK);
 140
 141         when(mountInstance.getSchemaContext()).thenReturn(schemaContextTestModule);
 142
 143         String uri = "/config/ietf-interfaces:interfaces/interface/0/yang-ext:mount/test-module:cont";
 144         assertEquals(200, put(uri, MediaType.APPLICATION_XML, xmlData2));
 145
 146         uri = "/config/ietf-interfaces:interfaces/yang-ext:mount/test-module:cont";
 147         assertEquals(200, put(uri, MediaType.APPLICATION_XML, xmlData2));
 148     }
 149
 150     @Test
 151     public void putDataMountPointIntoHighestElement() throws UnsupportedEncodingException, URISyntaxException {
 152         final PutResult result = mock(PutResult.class);
 153         doReturn(result).when(brokerFacade).commitMountPointDataPut(any(DOMMountPoint.class),
 154                 any(YangInstanceIdentifier.class), any(NormalizedNode.class), null, null);
 155         doReturn(CommitInfo.emptyFluentFuture()).when(result).getFutureOfPutData();
 156         when(result.getStatus()).thenReturn(Status.OK);
 157
 158         when(mountInstance.getSchemaContext()).thenReturn(schemaContextTestModule);
 159
 160         final String uri = "/config/ietf-interfaces:interfaces/yang-ext:mount";
 161         assertEquals(200, put(uri, MediaType.APPLICATION_XML, xmlData3));
 162     }
 163
 164     @Test
 165     public void putWithOptimisticLockFailedException() throws UnsupportedEncodingException {
 166
 167         final String uri = "/config/ietf-interfaces:interfaces/interface/eth0";
 168
 169         doThrow(OptimisticLockFailedException.class).when(brokerFacade).commitConfigurationDataPut(
 170                 any(SchemaContext.class), any(YangInstanceIdentifier.class), any(NormalizedNode.class), null, null);
 171
 172         assertEquals(500, put(uri, MediaType.APPLICATION_XML, xmlData));
 173
 174         doThrow(OptimisticLockFailedException.class).doReturn(mock(PutResult.class)).when(brokerFacade)
 175                 .commitConfigurationDataPut(any(SchemaContext.class), any(YangInstanceIdentifier.class),
 176                         any(NormalizedNode.class), null, null);
 177
 178         assertEquals(500, put(uri, MediaType.APPLICATION_XML, xmlData));
 179     }
 180
 181     @Test
 182     public void putWithTransactionCommitFailedException() throws UnsupportedEncodingException {
 183
 184         final String uri = "/config/ietf-interfaces:interfaces/interface/eth0";
 185
 186         doThrow(TransactionCommitFailedException.class)
 187                 .when(brokerFacade).commitConfigurationDataPut(
 188                 any(SchemaContext.class), any(YangInstanceIdentifier.class), any(NormalizedNode.class), null, null);
 189
 190         assertEquals(500, put(uri, MediaType.APPLICATION_XML, xmlData));
 191     }
 192
 193     private int put(final String uri, final String mediaType, final String data) throws UnsupportedEncodingException {
 194         return target(uri).request(mediaType).put(Entity.entity(data, mediaType)).getStatus();
 195     }
 196
 197     private void mockCommitConfigurationDataPutMethod(final boolean noErrors) {
 198         final PutResult putResMock = mock(PutResult.class);
 199         if (noErrors) {
 200             doReturn(putResMock).when(brokerFacade).commitConfigurationDataPut(
 201                     any(SchemaContext.class), any(YangInstanceIdentifier.class), any(NormalizedNode.class), null, null);
 202         } else {
 203             doThrow(RestconfDocumentedException.class).when(brokerFacade).commitConfigurationDataPut(
 204                     any(SchemaContext.class), any(YangInstanceIdentifier.class), any(NormalizedNode.class), null, null);
 205         }
 206     }
 207
 208 }