restconf/sal-rest-connector/src/test/java/org/opendaylight/controller/sal/restconf/impl/test/RestconfErrorTest.java

   1 /*
   2  * Copyright (c) 2014 Brocade Communications 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.hamcrest.CoreMatchers.equalTo;
  11 import static org.junit.Assert.assertEquals;
  12 import static org.junit.Assert.assertNotNull;
  13 import static org.junit.Assert.assertThat;
  14
  15 import java.util.HashMap;
  16 import java.util.Map;
  17 import org.hamcrest.BaseMatcher;
  18 import org.hamcrest.Description;
  19 import org.hamcrest.Matcher;
  20 import org.junit.Test;
  21 import org.opendaylight.netconf.sal.restconf.impl.RestconfError;
  22 import org.opendaylight.netconf.sal.restconf.impl.RestconfError.ErrorTag;
  23 import org.opendaylight.netconf.sal.restconf.impl.RestconfError.ErrorType;
  24 import org.opendaylight.yangtools.yang.common.RpcError;
  25 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  26
  27 /**
  28  * Unit tests for RestconfError.
  29  *
  30  * @author Devin Avery
  31  * @author Thomas Pantelis
  32  *
  33  */
  34 public class RestconfErrorTest {
  35
  36     static class Contains extends BaseMatcher<String> {
  37
  38         private final String text;
  39
  40         public Contains(String text) {
  41             this.text = text;
  42         }
  43
  44         @Override
  45         public void describeTo(Description desc) {
  46             desc.appendText("contains ").appendValue(text);
  47         }
  48
  49         @Override
  50         public boolean matches(Object arg) {
  51             return arg != null && arg.toString().contains(text);
  52         }
  53     }
  54
  55     @Test
  56     public void testErrorTagValueOf() {
  57         assertEquals(ErrorTag.IN_USE, ErrorTag.valueOfCaseInsensitive(ErrorTag.IN_USE.getTagValue()));
  58     }
  59
  60     @Test
  61     public void testErrorTagValueOfIsLowercase() {
  62         assertEquals("in-use", ErrorTag.IN_USE.getTagValue());
  63     }
  64
  65     @Test
  66     public void testErrorTypeGetErrorTypeTagIsLowerCase() {
  67         assertEquals(ErrorType.APPLICATION.name().toLowerCase(), ErrorType.APPLICATION.getErrorTypeTag());
  68     }
  69
  70     @Test
  71     public void testErrorTypeValueOf() {
  72         assertEquals(ErrorType.APPLICATION, ErrorType.valueOfCaseInsensitive(ErrorType.APPLICATION.getErrorTypeTag()));
  73     }
  74
  75     @Test
  76     public void testErrorTagStatusCodes() {
  77         Map<String, Integer> lookUpMap = new HashMap<String, Integer>();
  78
  79         lookUpMap.put("in-use", 409);
  80         lookUpMap.put("invalid-value", 400);
  81         lookUpMap.put("too-big", 413);
  82         lookUpMap.put("missing-attribute", 400);
  83         lookUpMap.put("bad-attribute", 400);
  84         lookUpMap.put("unknown-attribute", 400);
  85         lookUpMap.put("missing-element", 400);
  86         lookUpMap.put("bad-element", 400);
  87         lookUpMap.put("unknown-element", 400);
  88         lookUpMap.put("unknown-namespace", 400);
  89         lookUpMap.put("access-denied", 403);
  90         lookUpMap.put("lock-denied", 409);
  91         lookUpMap.put("resource-denied", 409);
  92         lookUpMap.put("rollback-failed", 500);
  93         lookUpMap.put("data-exists", 409);
  94         lookUpMap.put("data-missing", 404);
  95         lookUpMap.put("operation-not-supported", 501);
  96         lookUpMap.put("operation-failed", 500);
  97         lookUpMap.put("partial-operation", 500);
  98         lookUpMap.put("malformed-message", 400);
  99
 100         for (ErrorTag tag : ErrorTag.values()) {
 101             Integer expectedStatusCode = lookUpMap.get(tag.getTagValue());
 102             assertNotNull("Failed to find " + tag.getTagValue(), expectedStatusCode);
 103             assertEquals("Status Code does not match", expectedStatusCode, Integer.valueOf(tag.getStatusCode()));
 104         }
 105     }
 106
 107     @Test
 108     public void testRestConfDocumentedException_NoCause() {
 109         String expectedMessage = "Message";
 110         ErrorType expectedErrorType = ErrorType.RPC;
 111         ErrorTag expectedErrorTag = ErrorTag.IN_USE;
 112         RestconfError e = new RestconfError(expectedErrorType, expectedErrorTag, expectedMessage);
 113
 114         validateRestConfError(expectedMessage, expectedErrorType, expectedErrorTag, null, (String) null, e);
 115     }
 116
 117     @Test
 118     public void testRestConfDocumentedException_WithAppTag() {
 119         String expectedMessage = "Message";
 120         ErrorType expectedErrorType = ErrorType.RPC;
 121         ErrorTag expectedErrorTag = ErrorTag.IN_USE;
 122         String expectedErrorAppTag = "application.tag";
 123
 124         RestconfError e = new RestconfError(expectedErrorType, expectedErrorTag, expectedMessage, expectedErrorAppTag);
 125
 126         validateRestConfError(expectedMessage, expectedErrorType, expectedErrorTag, expectedErrorAppTag, (String) null,
 127                 e);
 128     }
 129
 130     @Test
 131     public void testRestConfDocumentedException_WithAppTagErrorInfo() {
 132         String expectedMessage = "Message";
 133         ErrorType expectedErrorType = ErrorType.RPC;
 134         ErrorTag expectedErrorTag = ErrorTag.IN_USE;
 135         String expectedErrorAppTag = "application.tag";
 136         String errorInfo = "<extra><sessionid>session.id</sessionid></extra>";
 137
 138         RestconfError e = new RestconfError(expectedErrorType, expectedErrorTag, expectedMessage, expectedErrorAppTag,
 139                 errorInfo);
 140
 141         validateRestConfError(expectedMessage, expectedErrorType, expectedErrorTag, expectedErrorAppTag, errorInfo, e);
 142     }
 143
 144     @Test
 145     public void testRestConfErrorWithRpcError() {
 146
 147         // All fields set
 148         RpcError rpcError = RpcResultBuilder.newError(
 149                 RpcError.ErrorType.PROTOCOL, ErrorTag.BAD_ATTRIBUTE.getTagValue(), "mock error-message",
 150                 "mock app-tag", "mock error-info", new Exception( "mock cause" ) );
 151
 152         validateRestConfError("mock error-message", ErrorType.PROTOCOL, ErrorTag.BAD_ATTRIBUTE, "mock app-tag",
 153                 "mock error-info", new RestconfError(rpcError));
 154
 155         // All fields set except 'info' - expect error-info set to 'cause'
 156         rpcError = RpcResultBuilder.newError(
 157                 RpcError.ErrorType.PROTOCOL, ErrorTag.BAD_ATTRIBUTE.getTagValue(), "mock error-message",
 158                 "mock app-tag", null, new Exception( "mock cause" ) );
 159
 160         validateRestConfError("mock error-message", ErrorType.PROTOCOL, ErrorTag.BAD_ATTRIBUTE, "mock app-tag",
 161                 new Contains("mock cause"), new RestconfError(rpcError));
 162
 163         // Some fields set - expect error-info set to ErrorSeverity
 164         rpcError = RpcResultBuilder.newError(
 165                 RpcError.ErrorType.RPC, ErrorTag.ACCESS_DENIED.getTagValue(), null, null, null, null );
 166
 167         validateRestConfError(null, ErrorType.RPC, ErrorTag.ACCESS_DENIED, null, "<severity>error</severity>",
 168                 new RestconfError(rpcError));
 169
 170         // 'tag' field not mapped to ErrorTag - expect error-tag set to
 171         // OPERATION_FAILED
 172         rpcError = RpcResultBuilder.newWarning(
 173                 RpcError.ErrorType.TRANSPORT, "not mapped", null, null, null, null );
 174
 175         validateRestConfError(null, ErrorType.TRANSPORT, ErrorTag.OPERATION_FAILED, null,
 176                 "<severity>warning</severity>", new RestconfError(rpcError));
 177
 178         // No fields set - edge case
 179         rpcError = RpcResultBuilder.newError( null, null, null, null, null, null );
 180
 181         validateRestConfError( null, ErrorType.APPLICATION, ErrorTag.OPERATION_FAILED,
 182                                null, "<severity>error</severity>", new RestconfError( rpcError ) );
 183     }
 184
 185     private void validateRestConfError(String expectedMessage, ErrorType expectedErrorType, ErrorTag expectedErrorTag,
 186             String expectedErrorAppTag, String errorInfo, RestconfError e) {
 187
 188         validateRestConfError(expectedMessage, expectedErrorType, expectedErrorTag, expectedErrorAppTag,
 189                 equalTo(errorInfo), e);
 190     }
 191
 192     private void validateRestConfError(String expectedMessage, ErrorType expectedErrorType, ErrorTag expectedErrorTag,
 193             String expectedErrorAppTag, Matcher<String> errorInfoMatcher, RestconfError e) {
 194
 195         assertEquals("getErrorMessage", expectedMessage, e.getErrorMessage());
 196         assertEquals("getErrorType", expectedErrorType, e.getErrorType());
 197         assertEquals("getErrorTag", expectedErrorTag, e.getErrorTag());
 198         assertEquals("getErrorAppTag", expectedErrorAppTag, e.getErrorAppTag());
 199         assertThat("getErrorInfo", e.getErrorInfo(), errorInfoMatcher);
 200         e.toString(); // really just checking for NPE etc. Don't care about
 201                       // contents.
 202     }
 203 }