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