From 7db495075033f450ee29f8164c5922ae138e2ca6 Mon Sep 17 00:00:00 2001 From: Vaclav Demcak Date: Fri, 24 Apr 2015 15:14:27 +0200 Subject: [PATCH] Bug 2981 - POST mismatching IDs data vs URI possibility fix forgotten validation for check IDs from data and Uri Change-Id: I465a3550399c5d2d4fcb546b608a9b47e3d97e63 Signed-off-by: Vaclav Demcak --- .../sal/restconf/impl/RestconfImpl.java | 60 +++++----- .../restconf/impl/test/RestPutConfigTest.java | 113 ++++++++++++++++++ 2 files changed, 144 insertions(+), 29 deletions(-) create mode 100644 opendaylight/md-sal/sal-rest-connector/src/test/java/org/opendaylight/controller/sal/restconf/impl/test/RestPutConfigTest.java diff --git a/opendaylight/md-sal/sal-rest-connector/src/main/java/org/opendaylight/controller/sal/restconf/impl/RestconfImpl.java b/opendaylight/md-sal/sal-rest-connector/src/main/java/org/opendaylight/controller/sal/restconf/impl/RestconfImpl.java index 5e9ab7b9d0..9f3a83eafc 100644 --- a/opendaylight/md-sal/sal-rest-connector/src/main/java/org/opendaylight/controller/sal/restconf/impl/RestconfImpl.java +++ b/opendaylight/md-sal/sal-rest-connector/src/main/java/org/opendaylight/controller/sal/restconf/impl/RestconfImpl.java @@ -16,6 +16,7 @@ import com.google.common.base.Strings; import com.google.common.base.Throwables; import com.google.common.collect.Iterables; import com.google.common.collect.Lists; +import com.google.common.collect.Maps; import com.google.common.collect.Sets; import com.google.common.util.concurrent.CheckedFuture; import com.google.common.util.concurrent.Futures; @@ -48,6 +49,7 @@ import org.opendaylight.controller.md.sal.dom.api.DOMRpcException; import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult; import org.opendaylight.controller.md.sal.dom.api.DOMRpcService; import org.opendaylight.controller.md.sal.dom.spi.DefaultDOMRpcResult; +import org.opendaylight.controller.md.sal.rest.common.RestconfValidationUtils; import org.opendaylight.controller.sal.rest.api.Draft02; import org.opendaylight.controller.sal.rest.api.RestconfService; import org.opendaylight.controller.sal.restconf.impl.RestconfError.ErrorTag; @@ -671,7 +673,7 @@ public class RestconfImpl implements RestconfService { validateInput(iiWithData.getSchemaNode(), payload); validateTopLevelNodeName(payload, iiWithData.getInstanceIdentifier()); - validateListKeysEqualityInPayloadAndUri(iiWithData, payload.getData()); + validateListKeysEqualityInPayloadAndUri(payload); final DOMMountPoint mountPoint = iiWithData.getMountPoint(); final YangInstanceIdentifier normalizedII = iiWithData.getInstanceIdentifier(); @@ -747,41 +749,41 @@ public class RestconfImpl implements RestconfService { * if key values or key count in payload and URI isn't equal * */ - private void validateListKeysEqualityInPayloadAndUri(final InstanceIdentifierContext iiWithData, - final NormalizedNode payload) { - if (iiWithData.getSchemaNode() instanceof ListSchemaNode) { - final List keyDefinitions = ((ListSchemaNode) iiWithData.getSchemaNode()).getKeyDefinition(); - final PathArgument lastPathArgument = iiWithData.getInstanceIdentifier().getLastPathArgument(); - if (lastPathArgument instanceof NodeIdentifierWithPredicates) { - final Map uriKeyValues = ((NodeIdentifierWithPredicates) lastPathArgument) - .getKeyValues(); - isEqualUriAndPayloadKeyValues(uriKeyValues, payload, keyDefinitions); + private static void validateListKeysEqualityInPayloadAndUri(final NormalizedNodeContext payload) { + Preconditions.checkArgument(payload != null); + final InstanceIdentifierContext iiWithData = payload.getInstanceIdentifierContext(); + final PathArgument lastPathArgument = iiWithData.getInstanceIdentifier().getLastPathArgument(); + final SchemaNode schemaNode = iiWithData.getSchemaNode(); + final NormalizedNode data = payload.getData(); + if (schemaNode instanceof ListSchemaNode) { + final List keyDefinitions = ((ListSchemaNode) schemaNode).getKeyDefinition(); + if (lastPathArgument instanceof NodeIdentifierWithPredicates && data instanceof MapEntryNode) { + final Map uriKeyValues = ((NodeIdentifierWithPredicates) lastPathArgument).getKeyValues(); + isEqualUriAndPayloadKeyValues(uriKeyValues, (MapEntryNode) data, keyDefinitions); } } } - private void isEqualUriAndPayloadKeyValues(final Map uriKeyValues, final NormalizedNode payload, - final List keyDefinitions) { + private static void isEqualUriAndPayloadKeyValues(final Map uriKeyValues, + final MapEntryNode payload, final List keyDefinitions) { + + final Map mutableCopyUriKeyValues = Maps.newHashMap(uriKeyValues); for (final QName keyDefinition : keyDefinitions) { - final Object uriKeyValue = uriKeyValues.get(keyDefinition); + final Object uriKeyValue = mutableCopyUriKeyValues.remove(keyDefinition); // should be caught during parsing URI to InstanceIdentifier - if (uriKeyValue == null) { - final String errMsg = "Missing key " + keyDefinition + " in URI."; - throw new RestconfDocumentedException(errMsg, ErrorType.PROTOCOL, ErrorTag.DATA_MISSING); + RestconfValidationUtils.checkDocumentedError(uriKeyValue != null, ErrorType.PROTOCOL, ErrorTag.DATA_MISSING, + "Missing key " + keyDefinition + " in URI."); + + final Object dataKeyValue = payload.getAttributeValue(keyDefinition); + RestconfValidationUtils.checkDocumentedError(dataKeyValue != null, ErrorType.PROTOCOL, ErrorTag.DATA_MISSING, + "Missing key " + keyDefinition.getLocalName() + " in the message body."); + + + if ( ! uriKeyValue.equals(dataKeyValue)) { + final String errMsg = "The value '" + uriKeyValue + "' for key '" + keyDefinition.getLocalName() + + "' specified in the URI doesn't match the value '" + dataKeyValue + "' specified in the message body. "; + throw new RestconfDocumentedException(errMsg, ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE); } - // TODO thing about the possibility to fix -// final List> payloadKeyValues = payload.getSimpleNodesByName(keyDefinition.getLocalName()); -// if (payloadKeyValues.isEmpty()) { -// final String errMsg = "Missing key " + keyDefinition.getLocalName() + " in the message body."; -// throw new RestconfDocumentedException(errMsg, ErrorType.PROTOCOL, ErrorTag.DATA_MISSING); -// } -// -// final Object payloadKeyValue = payloadKeyValues.iterator().next().getValue(); -// if (!uriKeyValue.equals(payloadKeyValue)) { -// final String errMsg = "The value '" + uriKeyValue + "' for key '" + keyDefinition.getLocalName() + -// "' specified in the URI doesn't match the value '" + payloadKeyValue + "' specified in the message body. "; -// throw new RestconfDocumentedException(errMsg, ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE); -// } } } diff --git a/opendaylight/md-sal/sal-rest-connector/src/test/java/org/opendaylight/controller/sal/restconf/impl/test/RestPutConfigTest.java b/opendaylight/md-sal/sal-rest-connector/src/test/java/org/opendaylight/controller/sal/restconf/impl/test/RestPutConfigTest.java new file mode 100644 index 0000000000..0df6a46311 --- /dev/null +++ b/opendaylight/md-sal/sal-rest-connector/src/test/java/org/opendaylight/controller/sal/restconf/impl/test/RestPutConfigTest.java @@ -0,0 +1,113 @@ +/** + * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved. + * + * This program and the accompanying materials are made available under the + * terms of the Eclipse Public License v1.0 which accompanies this distribution, + * and is available at http://www.eclipse.org/legal/epl-v10.html + */ + +package org.opendaylight.controller.sal.restconf.impl.test; + +import com.google.common.util.concurrent.CheckedFuture; +import com.google.common.util.concurrent.Futures; +import org.junit.Before; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.mockito.Matchers; +import org.mockito.Mock; +import org.mockito.Mockito; +import org.mockito.runners.MockitoJUnitRunner; +import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException; +import org.opendaylight.controller.md.sal.rest.common.TestRestconfUtils; +import org.opendaylight.controller.sal.restconf.impl.BrokerFacade; +import org.opendaylight.controller.sal.restconf.impl.ControllerContext; +import org.opendaylight.controller.sal.restconf.impl.InstanceIdentifierContext; +import org.opendaylight.controller.sal.restconf.impl.NormalizedNodeContext; +import org.opendaylight.controller.sal.restconf.impl.RestconfDocumentedException; +import org.opendaylight.controller.sal.restconf.impl.RestconfImpl; +import org.opendaylight.yangtools.yang.common.QName; +import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier; +import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode; +import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode; +import org.opendaylight.yangtools.yang.model.api.SchemaContext; + +/** + * sal-rest-connector + * org.opendaylight.controller.sal.restconf.impl.test + * + * + * + * @author Vaclav Demcak + * + * Created: May 14, 2015 + */ +@RunWith(MockitoJUnitRunner.class) +public class RestPutConfigTest { + + private RestconfImpl restconfService; + private ControllerContext controllerCx; + private SchemaContext schemaCx; + + @Mock + private BrokerFacade brokerFacade; + + @Before + public void init() { + restconfService = RestconfImpl.getInstance(); + controllerCx = ControllerContext.getInstance(); + schemaCx = TestRestconfUtils.loadSchemaContext("/test-config-data/yang1/", null); + controllerCx.setSchemas(schemaCx); + restconfService.setControllerContext(controllerCx); + } + + @Test + public void testPutConfigData() { + final String identifier = "test-interface:interfaces/interface/key"; + final InstanceIdentifierContext iiCx = controllerCx.toInstanceIdentifier(identifier); + final MapEntryNode data = Mockito.mock(MapEntryNode.class); + final QName qName = QName.create("urn:ietf:params:xml:ns:yang:test-interface", "2014-07-01", "interface"); + Mockito.when(data.getNodeType()).thenReturn(qName); + Mockito.when(data.getAttributeValue(Matchers.any(QName.class))).thenReturn("key"); + final NormalizedNodeContext payload = new NormalizedNodeContext(iiCx, data); + + mockingBrokerPut(iiCx.getInstanceIdentifier(), data); + + restconfService.updateConfigurationData(identifier, payload); + } + + @Test(expected=RestconfDocumentedException.class) + public void testPutConfigDataNull() { + final String identifier = "test-interface:interfaces/interface/key"; + final InstanceIdentifierContext iiCx = controllerCx.toInstanceIdentifier(identifier); + final MapEntryNode data = Mockito.mock(MapEntryNode.class); + final QName qName = QName.create("urn:ietf:params:xml:ns:yang:test-interface", "2014-07-01", "interface"); + Mockito.when(data.getNodeType()).thenReturn(qName); + Mockito.when(data.getAttributeValue(Matchers.any(QName.class))).thenReturn(null); + final NormalizedNodeContext payload = new NormalizedNodeContext(iiCx, data); + + mockingBrokerPut(iiCx.getInstanceIdentifier(), data); + + restconfService.updateConfigurationData(identifier, payload); + } + + @Test(expected=RestconfDocumentedException.class) + public void testPutConfigDataDiferentKey() { + final String identifier = "test-interface:interfaces/interface/key"; + final InstanceIdentifierContext iiCx = controllerCx.toInstanceIdentifier(identifier); + final MapEntryNode data = Mockito.mock(MapEntryNode.class); + final QName qName = QName.create("urn:ietf:params:xml:ns:yang:test-interface", "2014-07-01", "interface"); + Mockito.when(data.getNodeType()).thenReturn(qName); + Mockito.when(data.getAttributeValue(Matchers.any(QName.class))).thenReturn("notSameKey"); + final NormalizedNodeContext payload = new NormalizedNodeContext(iiCx, data); + + mockingBrokerPut(iiCx.getInstanceIdentifier(), data); + + restconfService.updateConfigurationData(identifier, payload); + } + + private void mockingBrokerPut(final YangInstanceIdentifier yii, final NormalizedNode data) { + final CheckedFuture checkedFuture = Futures.immediateCheckedFuture(null); + Mockito.when(brokerFacade.commitConfigurationDataPut(schemaCx, yii, data)).thenReturn(checkedFuture); + restconfService.setBroker(brokerFacade); + } +} -- 2.36.6