- /**
- * Test of parsing default parameters from URI request.
- */
- @Test
- public void parseUriParametersDefaultTest() {
- final UriInfo uriInfo = mock(UriInfo.class);
- final MultivaluedHashMap<String, String> parameters = new MultivaluedHashMap<>();
-
- // no parameters, default values should be used
- when(uriInfo.getQueryParameters()).thenReturn(parameters);
-
- final QueryParameters parsedParameters = QueryParams.newReadDataParams(context, uriInfo);
-
- assertEquals(ContentParameter.ALL, parsedParameters.getContent());
- assertNull(parsedParameters.getDepth());
- assertNull(parsedParameters.getFields());
- }
-
- /**
- * Test of parsing user defined parameters from URI request.
- */
- @Test
- public void parseUriParametersUserDefinedTest() {
- final UriInfo uriInfo = mock(UriInfo.class);
- final MultivaluedHashMap<String, String> parameters = new MultivaluedHashMap<>();
- parameters.putSingle("content", "config");
- parameters.putSingle("depth", "10");
- parameters.putSingle("fields", containerChildQName.getLocalName());
-
- when(uriInfo.getQueryParameters()).thenReturn(parameters);
-
- final QueryParameters parsedParameters = QueryParams.newReadDataParams(context, uriInfo);
-
- // content
- assertEquals(ContentParameter.CONFIG, parsedParameters.getContent());
-
- // depth
- final DepthParameter depth = parsedParameters.getDepth();
- assertNotNull(depth);
- assertEquals(10, depth.value());
-
- // fields
- assertNotNull(parsedParameters.getFields());
- assertEquals(1, parsedParameters.getFields().size());
- assertEquals(1, parsedParameters.getFields().get(0).size());
- assertEquals(containerChildQName, parsedParameters.getFields().get(0).iterator().next());
- }
-
- /**
- * Negative test of parsing request URI parameters when content parameter has not allowed value.
- */
- @Test
- public void parseUriParametersContentParameterNegativeTest() {
- final UriInfo uriInfo = mock(UriInfo.class);
- final MultivaluedHashMap<String, String> parameters = new MultivaluedHashMap<>();
- parameters.putSingle("content", "not-allowed-parameter-value");
- when(uriInfo.getQueryParameters()).thenReturn(parameters);
-
- final RestconfDocumentedException ex = assertThrows(RestconfDocumentedException.class,
- () -> QueryParams.newReadDataParams(context, uriInfo));
- // Bad request
- assertEquals("Error type is not correct", ErrorType.PROTOCOL, ex.getErrors().get(0).getErrorType());
- assertEquals("Error tag is not correct", ErrorTag.INVALID_VALUE, ex.getErrors().get(0).getErrorTag());
- }
-
- /**
- * Negative test of parsing request URI parameters when depth parameter has not allowed value.
- */
- @Test
- public void parseUriParametersDepthParameterNegativeTest() {
- final UriInfo uriInfo = mock(UriInfo.class);
- final MultivaluedHashMap<String, String> parameters = new MultivaluedHashMap<>();
-
- // inserted value is not allowed
- parameters.putSingle("depth", "bounded");
- when(uriInfo.getQueryParameters()).thenReturn(parameters);
-
- RestconfDocumentedException ex = assertThrows(RestconfDocumentedException.class,
- () -> QueryParams.newReadDataParams(context, uriInfo));
- // Bad request
- assertEquals("Error type is not correct", ErrorType.PROTOCOL, ex.getErrors().get(0).getErrorType());
- assertEquals("Error tag is not correct", ErrorTag.INVALID_VALUE, ex.getErrors().get(0).getErrorTag());
- }
-
- /**
- * Negative test of parsing request URI parameters when depth parameter has not allowed value (less than minimum).
- */
- @Test
- public void parseUriParametersDepthMinimalParameterNegativeTest() {
- final UriInfo uriInfo = mock(UriInfo.class);
- final MultivaluedHashMap<String, String> parameters = new MultivaluedHashMap<>();
-
- // inserted value is too low
- parameters.putSingle("depth", "0");
- when(uriInfo.getQueryParameters()).thenReturn(parameters);
-
- RestconfDocumentedException ex = assertThrows(RestconfDocumentedException.class,
- () -> QueryParams.newReadDataParams(context, uriInfo));
- // Bad request
- assertEquals("Error type is not correct", ErrorType.PROTOCOL, ex.getErrors().get(0).getErrorType());
- assertEquals("Error tag is not correct", ErrorTag.INVALID_VALUE, ex.getErrors().get(0).getErrorTag());
- }
-
- /**
- * Negative test of parsing request URI parameters when depth parameter has not allowed value (more than maximum).
- */
- @Test
- public void parseUriParametersDepthMaximalParameterNegativeTest() {
- final UriInfo uriInfo = mock(UriInfo.class);
- final MultivaluedHashMap<String, String> parameters = new MultivaluedHashMap<>();
-
- // inserted value is too high
- parameters.putSingle("depth", "65536");
- when(uriInfo.getQueryParameters()).thenReturn(parameters);
-
- RestconfDocumentedException ex = assertThrows(RestconfDocumentedException.class,
- () -> QueryParams.newReadDataParams(context, uriInfo));
- // Bad request
- assertEquals("Error type is not correct", ErrorType.PROTOCOL, ex.getErrors().get(0).getErrorType());
- assertEquals("Error tag is not correct", ErrorTag.INVALID_VALUE, ex.getErrors().get(0).getErrorTag());
- }
-
- /**
- * Testing parsing of with-defaults parameter which value doesn't match report-all or report-all-tagged patterns
- * - non-reporting setting.
- */
- @Test
- public void parseUriParametersWithDefaultAndNonTaggedTest() {
- // preparation of input data
- final UriInfo uriInfo = mock(UriInfo.class);
- final MultivaluedHashMap<String, String> parameters = new MultivaluedHashMap<>();
- parameters.putSingle("with-defaults", "explicit");
- when(uriInfo.getQueryParameters()).thenReturn(parameters);
-
- final QueryParameters writerParameters = QueryParams.newReadDataParams(context, uriInfo);
- assertSame(WithDefaultsParameter.EXPLICIT, writerParameters.getWithDefault());
- assertFalse(writerParameters.isTagged());
- }
-
- /**
- * Testing parsing of with-defaults parameter which value which is not supported.
- */
- @Test
- public void parseUriParametersWithDefaultInvalidTest() {
- // preparation of input data
- final UriInfo uriInfo = mock(UriInfo.class);
- final MultivaluedHashMap<String, String> parameters = new MultivaluedHashMap<>();
- parameters.putSingle("with-defaults", "invalid");
- when(uriInfo.getQueryParameters()).thenReturn(parameters);
-
- final RestconfDocumentedException ex = assertThrows(RestconfDocumentedException.class,
- () -> QueryParams.newReadDataParams(context, uriInfo));
- final List<RestconfError> errors = ex.getErrors();
- assertEquals(1, errors.size());
- assertEquals(ErrorTag.INVALID_VALUE, errors.get(0).getErrorTag());
- }
-
- /**
- * Testing parsing of with-defaults parameter which value matches 'report-all-tagged' setting - default value should
- * be set to {@code null} and tagged flag should be set to {@code true}.
- */
- @Test
- public void parseUriParametersWithDefaultAndTaggedTest() {
- // preparation of input data
- final UriInfo uriInfo = mock(UriInfo.class);
- final MultivaluedHashMap<String, String> parameters = new MultivaluedHashMap<>();
- parameters.putSingle("with-defaults", "report-all-tagged");
- when(uriInfo.getQueryParameters()).thenReturn(parameters);
-
- final QueryParameters writerParameters = QueryParams.newReadDataParams(context, uriInfo);
- assertNull(writerParameters.getWithDefault());
- assertTrue(writerParameters.isTagged());
- }
-
- /**
- * Testing parsing of with-defaults parameter which value matches 'report-all' setting - default value should
- * be set to {@code null} and tagged flag should be set to {@code false}.
- */
- @Test
- public void parseUriParametersWithDefaultAndReportAllTest() {
- // preparation of input data
- final UriInfo uriInfo = mock(UriInfo.class);
- final MultivaluedHashMap<String, String> parameters = new MultivaluedHashMap<>();
- parameters.putSingle("with-defaults", "report-all");
- when(uriInfo.getQueryParameters()).thenReturn(parameters);
-
- final QueryParameters writerParameters = QueryParams.newReadDataParams(context, uriInfo);
- assertNull(writerParameters.getWithDefault());
- assertFalse(writerParameters.isTagged());
- }
-