javatests/org/eclipse/lsp4j/jsonrpc/test/validation/ReflectiveMessageValidatorTest.java

/******************************************************************************
 * Copyright (c) 2016 TypeFox and others.
 * 
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0,
 * or the Eclipse Distribution License v. 1.0 which is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 * 
 * SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
 ******************************************************************************/
package org.eclipse.lsp4j.jsonrpc.test.validation;

import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.atomic.AtomicBoolean;

import org.eclipse.lsp4j.jsonrpc.MessageIssueException;
import org.eclipse.lsp4j.jsonrpc.messages.NotificationMessage;
import org.eclipse.lsp4j.jsonrpc.messages.RequestMessage;
import org.eclipse.lsp4j.jsonrpc.validation.NonNull;
import org.eclipse.lsp4j.jsonrpc.validation.ReflectiveMessageValidator;
import org.junit.Assert;
import org.junit.Test;

import com.google.gson.JsonObject;

public class ReflectiveMessageValidatorTest {
	
	public static class Foo {
		// a non exposed self reference
		Foo self = this;
		
		Foo nested;
		@NonNull String nonNullString;
		String nullableString;
		List<Foo> foos;
		
		public Foo getNested() {
			return nested;
		}
		 
		public @NonNull String getNonNullString() {
			return nonNullString;
		}
		
		public String getNullableString() {
			return nullableString;
		}
		
		public List<Foo> getFoos() {
			return foos;
		}
	}
	
	@Test public void testNonNullViolated() {
		ReflectiveMessageValidator validator = new ReflectiveMessageValidator();
		
		NotificationMessage message = new NotificationMessage();
		message.setMethod("foo");
		message.setParams(new Foo());
		try {
			validator.consume(message);
			Assert.fail();
		} catch (MessageIssueException e) {
			Assert.assertEquals("The accessor 'Foo.getNonNullString()' must return a non-null value. Path: $.params.nonNullString", e.getMessage());
		}
	}
	
	@Test public void testNonNullViolated_nested() {
		ReflectiveMessageValidator validator = new ReflectiveMessageValidator();
		
		NotificationMessage message = new NotificationMessage();
		message.setMethod("foo");
		Foo foo = new Foo();
		foo.nonNullString = "test";
		foo.nested = new Foo();
		message.setParams(foo);
		try {
			validator.consume(message);
			Assert.fail();
		} catch (MessageIssueException e) {
			Assert.assertEquals("The accessor 'Foo.getNonNullString()' must return a non-null value. Path: $.params.nested.nonNullString", e.getMessage());
		}
	}
	
	@Test public void testNoViolation() {
		ReflectiveMessageValidator validator = new ReflectiveMessageValidator();
		
		NotificationMessage message = new NotificationMessage();
		message.setMethod("foo");
		Foo foo = new Foo();
		foo.nonNullString = "test";
		foo.nested = new Foo() {{
			nonNullString = "something";
		}};
		message.setParams(foo);
		validator.consume(message);
	}
	
	@Test public void testRecursionViolation() {
		ReflectiveMessageValidator validator = new ReflectiveMessageValidator();
		
		NotificationMessage message = new NotificationMessage();
		message.setMethod("foo");
		Foo foo = new Foo();
		foo.nonNullString = "test";
		foo.nested = foo;
		message.setParams(foo);
		try {
			validator.consume(message);
			Assert.fail();
		} catch (MessageIssueException e) {
			Assert.assertEquals("An element of the message has a direct or indirect reference to itself. Path: $.params.nested", e.getMessage());
		}
	}
	
	@Test public void testReflectionOnPropertiesOnly() {
		ReflectiveMessageValidator validator = new ReflectiveMessageValidator();
		
		NotificationMessage message = new NotificationMessage();
		message.setMethod("foo");
		Foo foo = new Foo();
		foo.nonNullString = "test";
		foo.nested = new Foo() {{
			nonNullString = "something";
		}};
		foo.foos = new ArrayList<>();
		foo.foos.add(new Foo());
		message.setParams(foo);
		try {
			validator.consume(message);
			Assert.fail();
		} catch (MessageIssueException e) {
			Assert.assertEquals("The accessor 'Foo.getNonNullString()' must return a non-null value. Path: $.params.foos[0].nonNullString", e.getMessage());
		}
	}

	@Test public void testSkipJsonElement() {
		final AtomicBoolean result = new AtomicBoolean(false);
		ReflectiveMessageValidator validator = new ReflectiveMessageValidator((message) -> {
			result.set(true);
		});
		NotificationMessage message = new NotificationMessage();
		message.setMethod("foo");
		message.setParams(new JsonObject());
		validator.consume(message);
		Assert.assertTrue(result.get());
	}
	
	@Test public void testRequestValidation() {
		ReflectiveMessageValidator validator = new ReflectiveMessageValidator();
		
		RequestMessage message = new RequestMessage();
		message.setId("1");
		message.setParams(new Object());
		try {
			validator.consume(message);
			Assert.fail();
		} catch (MessageIssueException e) {
			Assert.assertEquals("The accessor 'RequestMessage.getMethod()' must return a non-null value. Path: $.method", e.getMessage());
		}
	}
	
}