org.neo4j.shell.StartClientTest.java Source code

Java tutorial

Introduction

Here is the source code for org.neo4j.shell.StartClientTest.java

Source

/*
 * Copyright (c) 2002-2016 "Neo Technology,"
 * Network Engine for Objects in Lund AB [http://neotechnology.com]
 *
 * This file is part of Neo4j.
 *
 * Neo4j is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.neo4j.shell;

import org.apache.commons.lang3.StringUtils;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.PrintStream;
import java.io.Serializable;
import java.rmi.RemoteException;

import org.neo4j.graphdb.Transaction;
import org.neo4j.graphdb.factory.GraphDatabaseBuilder;
import org.neo4j.kernel.configuration.Settings;
import org.neo4j.shell.impl.AbstractClient;
import org.neo4j.shell.kernel.GraphDatabaseShellServer;
import org.neo4j.test.ImpermanentDatabaseRule;
import org.neo4j.test.SuppressOutput;

import static org.hamcrest.CoreMatchers.containsString;
import static org.hamcrest.CoreMatchers.equalTo;
import static org.hamcrest.CoreMatchers.startsWith;
import static org.hamcrest.Matchers.not;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertThat;
import static org.mockito.Mockito.any;
import static org.mockito.Mockito.anyMap;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
import static org.neo4j.test.SuppressOutput.suppressAll;

public class StartClientTest {
    @Rule
    public SuppressOutput mute = suppressAll();

    @Rule
    public ImpermanentDatabaseRule db = new ImpermanentDatabaseRule() {
        @Override
        protected void configure(GraphDatabaseBuilder builder) {
            builder.setConfig(ShellSettings.remote_shell_enabled, Settings.TRUE);
        }
    };

    @Before
    public void startDatabase() {
        db.getGraphDatabaseAPI();
    }

    @Test
    public void givenShellClientWhenOpenFileThenExecuteFileCommands() {
        // Given
        // an empty database

        // When
        StartClient.main(new String[] { "-file", getClass().getResource("/testshell.txt").getFile() });

        // Then
        try (Transaction tx = db.getGraphDatabaseAPI().beginTx()) {
            assertThat((String) db.getGraphDatabaseAPI().getNodeById(0).getProperty("foo"), equalTo("bar"));
            tx.success();
        }
    }

    @Test
    public void givenShellClientWhenReadFromStdinThenExecutePipedCommands() throws IOException {
        // Given
        // an empty database

        // When
        InputStream realStdin = System.in;
        try {
            System.setIn(new ByteArrayInputStream("CREATE (n {foo:'bar'});".getBytes()));
            StartClient.main(new String[] { "-file", "-" });
        } finally {
            System.setIn(realStdin);
        }

        // Then
        try (Transaction tx = db.getGraphDatabaseAPI().beginTx()) {
            assertThat((String) db.getGraphDatabaseAPI().getNodeById(0).getProperty("foo"), equalTo("bar"));
            tx.success();
        }
    }

    @Test
    public void mustWarnWhenRunningScriptWithUnterminatedMultilineCommands() {
        // Given an empty database and the unterminated-cypher-query.txt file.
        String script = getClass().getResource("/unterminated-cypher-query.txt").getFile();

        // When running the script with -file
        String output = runAndCaptureOutput(new String[] { "-file", script });

        // Then we should get a warning
        assertThat(output, containsString(AbstractClient.WARN_UNTERMINATED_INPUT));
    }

    @Test
    public void mustNotAboutExitingWithUnterminatedCommandWhenItIsNothingButComments() {
        // Given an empty database and the unterminated-comment.txt file.
        String script = getClass().getResource("/unterminated-comment.txt").getFile();

        // When running the script with -file
        String output = runAndCaptureOutput(new String[] { "-file", script });

        // Then we should get a warning
        assertThat(output, not(containsString(AbstractClient.WARN_UNTERMINATED_INPUT)));
    }

    @Test
    public void testShellCloseAfterCommandExecution() throws Exception {
        PrintStream out = mock(PrintStream.class);
        PrintStream err = mock(PrintStream.class);
        CtrlCHandler ctrlCHandler = mock(CtrlCHandler.class);
        final GraphDatabaseShellServer databaseShellServer = mock(GraphDatabaseShellServer.class);
        when(databaseShellServer.welcome(anyMap()))
                .thenReturn(new Welcome(StringUtils.EMPTY, 1, StringUtils.EMPTY));
        when(databaseShellServer.interpretLine(any(Serializable.class), any(String.class), any(Output.class)))
                .thenReturn(new Response(StringUtils.EMPTY, Continuation.INPUT_COMPLETE));
        StartClient startClient = new StartClient(out, err) {
            @Override
            protected GraphDatabaseShellServer getGraphDatabaseShellServer(File path, boolean readOnly,
                    String configFile) throws RemoteException {
                return databaseShellServer;
            }
        };

        // when
        startClient.start(
                new String[] { "-path", db.getGraphDatabaseAPI().getStoreDir(), "-c", "CREATE (n {foo:'bar'});" },
                ctrlCHandler);

        // verify
        verify(databaseShellServer).shutdown();
    }

    @Test
    public void shouldReportEditionThroughDbInfoApp() throws Exception {
        // given
        ByteArrayOutputStream out = new ByteArrayOutputStream();
        ByteArrayOutputStream err = new ByteArrayOutputStream();
        CtrlCHandler ctrlCHandler = mock(CtrlCHandler.class);
        StartClient client = new StartClient(new PrintStream(out), new PrintStream(err));

        // when
        client.start(new String[] { "-path", db.getGraphDatabaseAPI().getStoreDir(), "-c",
                "dbinfo -g Configuration unsupported.dbms.edition" }, ctrlCHandler);

        // then
        assertEquals(0, err.size());
        assertThat(out.toString(), containsString("\"unsupported.dbms.edition\": \"community\""));
    }

    @Test
    public void shouldPrintVersionAndExit() throws Exception {
        // given
        ByteArrayOutputStream out = new ByteArrayOutputStream();
        ByteArrayOutputStream err = new ByteArrayOutputStream();
        CtrlCHandler ctrlCHandler = mock(CtrlCHandler.class);
        StartClient client = new StartClient(new PrintStream(out), new PrintStream(err));

        // when
        client.start(new String[] { "-version" }, ctrlCHandler);

        // then
        assertEquals(0, err.size());
        String version = out.toString();
        assertThat(version, startsWith("Neo4j Community, version "));
    }

    private String runAndCaptureOutput(String[] arguments) {
        ByteArrayOutputStream buf = new ByteArrayOutputStream();
        PrintStream out = new PrintStream(buf);
        PrintStream oldOut = System.out;
        System.setOut(out);

        try {
            StartClient.main(arguments);
            out.close();
            return buf.toString();
        } finally {
            System.setOut(oldOut);
        }
    }

}