netconf/mdsal-netconf-connector/src/test/java/org/opendaylight/netconf/mdsal/connector/ops/ValidateTest.java

   1 /*
   2  * Copyright (c) 2018 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.netconf.mdsal.connector.ops;
   9
  10 import static org.junit.Assert.assertEquals;
  11 import static org.junit.Assert.assertThrows;
  12 import static org.mockito.ArgumentMatchers.any;
  13 import static org.mockito.Mockito.doReturn;
  14 import static org.mockito.Mockito.verify;
  15 import static org.mockito.Mockito.verifyNoMoreInteractions;
  16 import static org.opendaylight.netconf.mdsal.connector.ops.AbstractNetconfOperationTest.RPC_REPLY_OK;
  17 import static org.opendaylight.netconf.mdsal.connector.ops.AbstractNetconfOperationTest.SESSION_ID_FOR_REPORTING;
  18 import static org.opendaylight.netconf.mdsal.connector.ops.AbstractNetconfOperationTest.executeOperation;
  19 import static org.opendaylight.netconf.mdsal.connector.ops.AbstractNetconfOperationTest.verifyResponse;
  20
  21 import com.google.common.collect.ImmutableClassToInstanceMap;
  22 import org.custommonkey.xmlunit.XMLUnit;
  23 import org.junit.Before;
  24 import org.junit.Test;
  25 import org.junit.runner.RunWith;
  26 import org.mockito.Mock;
  27 import org.mockito.junit.MockitoJUnitRunner;
  28 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
  29 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadWriteTransaction;
  30 import org.opendaylight.netconf.api.DocumentedException;
  31 import org.opendaylight.netconf.mdsal.connector.DOMDataTransactionValidator;
  32 import org.opendaylight.netconf.mdsal.connector.DOMDataTransactionValidator.ValidationFailedException;
  33 import org.opendaylight.netconf.mdsal.connector.TransactionProvider;
  34 import org.opendaylight.yangtools.util.concurrent.FluentFutures;
  35 import org.opendaylight.yangtools.yang.common.ErrorSeverity;
  36 import org.w3c.dom.Document;
  37
  38 @RunWith(MockitoJUnitRunner.StrictStubs.class)
  39 public class ValidateTest {
  40     @Mock
  41     private DOMDataTransactionValidator noopValidator;
  42     @Mock
  43     private DOMDataTransactionValidator failingValidator;
  44     @Mock
  45     private DOMDataTreeReadWriteTransaction readWriteTx;
  46     @Mock
  47     private DOMDataBroker dataBroker;
  48
  49     @Before
  50     public void setUp() {
  51         doReturn(FluentFutures.immediateNullFluentFuture()).when(noopValidator).validate(any());
  52         doReturn(FluentFutures.immediateFailedFluentFuture(new ValidationFailedException("invalid data")))
  53             .when(failingValidator).validate(any());
  54         doReturn(readWriteTx).when(dataBroker).newReadWriteTransaction();
  55         XMLUnit.setIgnoreWhitespace(true);
  56     }
  57
  58     @Test
  59     public void testValidateUnsupported() throws Exception {
  60         whenValidatorIsNotDefined();
  61         final DocumentedException e = assertThrows(DocumentedException.class,
  62             () -> validate("messages/mapping/validate/validate.xml"));
  63         assertEquals(ErrorSeverity.ERROR, e.getErrorSeverity());
  64         assertEquals(DocumentedException.ErrorTag.OPERATION_NOT_SUPPORTED, e.getErrorTag());
  65         assertEquals(DocumentedException.ErrorType.PROTOCOL, e.getErrorType());
  66     }
  67
  68     @Test
  69     public void testSourceMissing() throws Exception {
  70         whenUsingValidator(noopValidator);
  71         final DocumentedException e = assertThrows(DocumentedException.class,
  72             () -> validate("messages/mapping/validate/validate_no_source.xml"));
  73         assertEquals(ErrorSeverity.ERROR, e.getErrorSeverity());
  74         assertEquals(DocumentedException.ErrorTag.MISSING_ELEMENT, e.getErrorTag());
  75         assertEquals(DocumentedException.ErrorType.PROTOCOL, e.getErrorType());
  76     }
  77
  78     @Test
  79     public void testSourceRunning() throws Exception {
  80         whenUsingValidator(noopValidator);
  81         final DocumentedException e = assertThrows(DocumentedException.class,
  82             () -> validate("messages/mapping/validate/validate_running.xml"));
  83         assertEquals(ErrorSeverity.ERROR, e.getErrorSeverity());
  84         assertEquals(DocumentedException.ErrorTag.OPERATION_NOT_SUPPORTED, e.getErrorTag());
  85         assertEquals(DocumentedException.ErrorType.PROTOCOL, e.getErrorType());
  86     }
  87
  88     @Test
  89     public void testValidateEmptyTx() throws Exception {
  90         whenUsingValidator(noopValidator);
  91         verifyResponse(validate("messages/mapping/validate/validate.xml"), RPC_REPLY_OK);
  92         verifyNoMoreInteractions(noopValidator);
  93     }
  94
  95     @Test
  96     public void testValidate() throws Exception {
  97         whenUsingValidator(noopValidator);
  98         final TransactionProvider transactionProvider = initCandidateTransaction();
  99         verifyResponse(validate("messages/mapping/validate/validate.xml", transactionProvider), RPC_REPLY_OK);
 100         verify(noopValidator).validate(readWriteTx);
 101     }
 102
 103     @Test
 104     public void testValidateFailed() throws Exception {
 105         whenUsingValidator(failingValidator);
 106         final TransactionProvider transactionProvider = initCandidateTransaction();
 107         final DocumentedException e = assertThrows(DocumentedException.class,
 108             () -> validate("messages/mapping/validate/validate.xml", transactionProvider));
 109         assertEquals(ErrorSeverity.ERROR, e.getErrorSeverity());
 110         assertEquals(DocumentedException.ErrorTag.OPERATION_FAILED, e.getErrorTag());
 111         assertEquals(DocumentedException.ErrorType.APPLICATION, e.getErrorType());
 112     }
 113
 114     private void whenValidatorIsNotDefined() {
 115         doReturn(ImmutableClassToInstanceMap.of()).when(dataBroker).getExtensions();
 116     }
 117
 118     private void whenUsingValidator(final DOMDataTransactionValidator validator) {
 119         doReturn(ImmutableClassToInstanceMap.of(DOMDataTransactionValidator.class, validator))
 120             .when(dataBroker).getExtensions();
 121     }
 122
 123     private TransactionProvider initCandidateTransaction() {
 124         final TransactionProvider transactionProvider = new TransactionProvider(dataBroker, SESSION_ID_FOR_REPORTING);
 125         transactionProvider.getOrCreateTransaction();
 126         return transactionProvider;
 127     }
 128
 129     private static Document validate(final String resource,  final TransactionProvider transactionProvider)
 130             throws Exception {
 131         final Validate validate = new Validate(SESSION_ID_FOR_REPORTING, transactionProvider);
 132         return executeOperation(validate, resource);
 133     }
 134
 135     private Document validate(final String resource) throws Exception {
 136         return validate(resource, new TransactionProvider(dataBroker, SESSION_ID_FOR_REPORTING));
 137     }
 138 }