JIMRI/java/test/jmri/server/json/reporter/JsonReporterHttpServiceTest.java

package jmri.server.json.reporter;

import static jmri.server.json.reporter.JsonReporter.REPORTER;

import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;
import javax.annotation.Nonnull;

import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.node.NullNode;
import com.fasterxml.jackson.databind.node.ObjectNode;

import jmri.InstanceManager;
import jmri.JmriException;
import jmri.Reporter;
import jmri.ReporterManager;
import jmri.jmrit.operations.locations.Location;
import jmri.jmrit.operations.locations.LocationManager;
import jmri.jmrix.internal.InternalReporterManager;
import jmri.jmrix.internal.InternalSystemConnectionMemo;
import jmri.server.json.JSON;
import jmri.server.json.JsonException;
import jmri.server.json.JsonNamedBeanHttpServiceTestBase;
import jmri.server.json.JsonRequest;
import jmri.util.JUnitAppender;
import jmri.util.JUnitUtil;

import org.junit.jupiter.api.*;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertThrows;

/**
 *
 * @author Paul Bender
 * @author Randall Wood
 */
public class JsonReporterHttpServiceTest extends JsonNamedBeanHttpServiceTestBase<Reporter, JsonReporterHttpService> {

    @Test
    @Override
    public void testDoGet() throws JmriException, JsonException {
        ReporterManager manager = InstanceManager.getDefault(ReporterManager.class);
        Reporter reporter1 = manager.provideReporter("IR1"); // no value
        JsonNode result;
        result = service.doGet(REPORTER, "IR1", NullNode.getInstance(), new JsonRequest(locale, JSON.V5, JSON.GET, 42));
        validate(result);
        assertEquals(REPORTER, result.path(JSON.TYPE).asText());
        assertEquals("IR1", result.path(JSON.DATA).path(JSON.NAME).asText());
        // JSON node has the text "null" if reporter is null
        assertEquals("null", result.path(JSON.DATA).path(JsonReporter.REPORT).asText());
        reporter1.setReport("throw");
        result = service.doGet(REPORTER, "IR1", service.getObjectMapper().createObjectNode(), new JsonRequest(locale, JSON.V5, JSON.GET, 42));
        validate(result);
        assertEquals("throw", result.path(JSON.DATA).path(JsonReporter.REPORT).asText());
        reporter1.setReport("close");
        result = service.doGet(REPORTER, "IR1", service.getObjectMapper().createObjectNode(), new JsonRequest(locale, JSON.V5, JSON.GET, 42));
        validate(result);
        assertEquals("close", result.path(JSON.DATA).path(JsonReporter.REPORT).asText());
        // Request a non-existent reporter
        JsonException ex = assertThrows( JsonException.class, () ->
            service.doGet(REPORTER, "IR2", service.getObjectMapper().createObjectNode(),
                new JsonRequest(locale, JSON.V5, JSON.GET, 42)),
            "Expected exception not thrown.");
        assertEquals(404, ex.getCode());
    }

    @Test
    public void testDoPost() throws JmriException, JsonException {
        ReporterManager manager = InstanceManager.getDefault(ReporterManager.class);
        Reporter reporter1 = manager.provideReporter("IR1");
        reporter1.setUserName("test reporter");
        JsonNode result;
        JsonNode message;
        // set non-null report
        message = mapper.createObjectNode().put(JSON.NAME, "IR1").put(JsonReporter.REPORT, "close");
        result = service.doPost(REPORTER, "IR1", message, new JsonRequest(locale, JSON.V5, JSON.GET, 42));
        assertEquals("close", reporter1.getCurrentReport());
        validate(result);
        assertEquals("close", result.path(JSON.DATA).path(JsonReporter.REPORT).asText());
        // set different non-null report 
        message = mapper.createObjectNode().put(JSON.NAME, "IR1").put(JsonReporter.REPORT, "throw");
        result = service.doPost(REPORTER, "IR1", message, new JsonRequest(locale, JSON.V5, JSON.GET, 42));
        assertEquals("throw", reporter1.getCurrentReport());
        validate(result);
        assertEquals("throw", result.path(JSON.DATA).path(JsonReporter.REPORT).asText());
        // set null report
        message = mapper.createObjectNode().put(JSON.NAME, "IR1").putNull(JsonReporter.REPORT);
        result = service.doPost(REPORTER, "IR1", message, new JsonRequest(locale, JSON.V5, JSON.GET, 42));
        assertNull(reporter1.getCurrentReport());
        assertEquals("null", result.path(JSON.DATA).path(JsonReporter.REPORT).asText());
        // set new user name
        message = mapper.createObjectNode().put(JSON.NAME, "IR1").put(JSON.USERNAME, "TEST REPORTER");
        assertEquals( "test reporter", reporter1.getUserName(), "expected name");
        result = service.doPost(REPORTER, "IR1", message, new JsonRequest(locale, JSON.V5, JSON.GET, 42));
        assertEquals( "TEST REPORTER", reporter1.getUserName(), "new name");
        validate(result);
        assertEquals( "TEST REPORTER", result.path(JSON.DATA).path(JSON.USERNAME).asText(),
            "new name in JSON");
        // set comment
        message = mapper.createObjectNode().put(JSON.NAME, "IR1").put(JSON.COMMENT, "a comment");
        assertNull( reporter1.getComment(), "null comment");
        result = service.doPost(REPORTER, "IR1", message, new JsonRequest(locale, JSON.V5, JSON.GET, 42));
        assertEquals( "a comment", reporter1.getComment(), "new comment");
        validate(result);
        assertEquals( "a comment", result.path(JSON.DATA).path(JSON.COMMENT).asText(),
            "new comment in JSON");
        // post non-existent reporter
        JsonException ex = assertThrows( JsonException.class, () -> {
            // set off
            JsonNode messageEx = mapper.createObjectNode().put(JSON.NAME, "JR1").put(JsonReporter.REPORT, "close");
            service.doPost(REPORTER, "JR1", messageEx, new JsonRequest(locale, JSON.V5, JSON.GET, 42));
        }, "Expected exception not thrown ");
        assertEquals( 404, ex.getCode(), "Not found thrown");
    }

    @Test
    public void testDoPut() throws JsonException {
        ReporterManager manager = InstanceManager.getDefault(ReporterManager.class);
        JsonNode message;
        // add a reporter
        assertNull(manager.getReporter("IR1"));
        message = mapper.createObjectNode().put(JSON.NAME, "IR1").put(JsonReporter.REPORT, "close");
        service.doPut(REPORTER, "IR1", message, new JsonRequest(locale, JSON.V5, JSON.GET, 42));
        assertNotNull(manager.getReporter("IR1"));
        // add a reporter with invalid name
        assertNull(manager.getReporter("JR1"));
        // create a default reporter manager that overrides provide() to require valid system name
        // this allows testing that invalid names are reported to clients correctly
        InstanceManager.setDefault(ReporterManager.class, new InternalReporterManager(InstanceManager.getDefault(InternalSystemConnectionMemo.class)) {
            @Nonnull
            @Override
            public Reporter provide(@Nonnull String name) {
                return this.newReporter(name, null);
            }
        });
        JsonNode messageEx = mapper.createObjectNode().put(JSON.NAME, "JR1").put(JsonReporter.REPORT, "close");
        JsonException ex = assertThrows( JsonException.class, () ->
            service.doPut(REPORTER, "JR1", messageEx,
                new JsonRequest(locale, JSON.V5, JSON.GET, 42)),
            "JR1 should not have been created");
        JUnitAppender.assertErrorMessageStartsWith("Invalid system name for reporter");
        assertEquals( 400, ex.getCode(), "400 name was invalid");
    }

    @Test
    @Override
    public void testDoDelete() throws JsonException {
        ReporterManager manager = InstanceManager.getDefault(ReporterManager.class);
        Reporter reporter1 = manager.provide("IR1");
        Location location1 = new Location("1", "Location 1");
        location1.setReporter(reporter1);
        InstanceManager.getDefault(LocationManager.class).register(location1);
        ObjectNode message = mapper.createObjectNode();
        assertNotNull(message);
        // add a reporter
        assertNotNull(manager.getReporter("IR1"));
        service.doDelete(REPORTER, "IR1", NullNode.getInstance(), new JsonRequest(locale, JSON.V5, JSON.GET, 0));
        assertNull(manager.getReporter("IR1"));
        manager.provide("IR1").addPropertyChangeListener(new PropertyChangeListener() {

            @Override
            public void propertyChange(PropertyChangeEvent evt) {
                // do nothing
            }
        }, "IR1", "Test Listener");
        // delete an idTag with a named listener ref
        assertNotNull(manager.getReporter("IR1"));
        message = mapper.createObjectNode().put(JSON.NAME, "IR1");
        JsonException ex = assertThrows( JsonException.class, () ->
            service.doDelete(REPORTER, "IR1", NullNode.getInstance(),
                new JsonRequest(locale, JSON.V5, JSON.GET, 0)),
            "Expected exception not thrown");
        assertEquals(409, ex.getCode());
        assertEquals(1, ex.getAdditionalData().path(JSON.CONFLICT).size());
        assertEquals("Test Listener", ex.getAdditionalData().path(JSON.CONFLICT).path(0).asText());
        message = message.put(JSON.FORCE_DELETE, ex.getAdditionalData().path(JSON.FORCE_DELETE).asText());
        assertNotNull(manager.getReporter("IR1"));
        // will throw if prior catch failed
        service.doDelete(REPORTER, "IR1", message, new JsonRequest(locale, JSON.V5, JSON.GET, 0));
        assertNull(manager.getBySystemName("IR1"));
        ex = assertThrows( JsonException.class, () ->
            service.doDelete(REPORTER, "IR1", NullNode.getInstance(),
                new JsonRequest(locale, JSON.V5, JSON.GET, 0)),
            "deleting again should throw an exception.");
        assertEquals(404, ex.getCode());
    }

    @Test
    public void testDoGetList() throws JsonException {
        ReporterManager manager = InstanceManager.getDefault(ReporterManager.class);
        JsonNode result;
        result = service.doGetList(REPORTER, mapper.createObjectNode(), new JsonRequest(locale, JSON.V5, JSON.GET, 0));
        validate(result);
        assertEquals(0, result.size());
        manager.provideReporter("IR1");
        manager.provideReporter("IR2");
        result = service.doGetList(REPORTER, mapper.createObjectNode(), new JsonRequest(locale, JSON.V5, JSON.GET, 0));
        validate(result);
        assertEquals(2, result.size());
    }

    @BeforeEach
    @Override
    public void setUp() throws Exception {
        super.setUp();
        service = new JsonReporterHttpService(mapper);
        JUnitUtil.initReporterManager();
        JUnitUtil.initInternalSensorManager();
        JUnitUtil.initDebugThrottleManager();
    }

    @AfterEach
    @Override
    public void tearDown() throws Exception {
        super.tearDown();
    }

}