TopLevelToolTests.java

/*
 * Copyright Red Hat Inc. and/or its affiliates and other contributors
 * as indicated by the authors tag. All rights reserved.
 *
 * This copyrighted material is made available to anyone wishing to use,
 * modify, copy, or redistribute it subject to the terms and conditions
 * of the GNU General Public License version 2.
 * 
 * This particular file is subject to the "Classpath" exception as provided in the 
 * LICENSE file that accompanied this code.
 * 
 * This program is distributed in the hope that it will be useful, but WITHOUT A
 * 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 distribution; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA  02110-1301, USA.
 */
package com.redhat.ceylon.tools;

import java.io.ByteArrayOutputStream;
import java.io.PrintStream;
import java.io.StringWriter;

import junit.framework.Assert;

import org.junit.Before;
import org.junit.Test;

import com.redhat.ceylon.common.Constants;
import com.redhat.ceylon.common.tool.ToolFactory;
import com.redhat.ceylon.common.tool.ToolLoader;
import com.redhat.ceylon.common.tools.CeylonTool;
import com.redhat.ceylon.common.tools.help.CeylonHelpTool;

public class TopLevelToolTests {

    protected final ToolFactory toolFactory = new ToolFactory();
    protected final ToolLoader toolLoader = new TestingToolLoader(null, true);
    
    private CeylonTool tool;
    
    @Before
    public void setup() {
        tool = new CeylonTool();
        tool.setToolLoader(toolLoader);
    }
    
    private String[] args(String...args) {
        return args;
    }
    
    class CapturingStdOut implements AutoCloseable {
        private PrintStream savedOut;
        private PrintStream savedErr;
        private ByteArrayOutputStream redirectedOut;
        private ByteArrayOutputStream redirectedErr;

        public CapturingStdOut() {
            open();
        }

        private void open() {
            this.redirectedOut = new ByteArrayOutputStream();
            this.redirectedErr= new ByteArrayOutputStream();
            this.savedOut = System.out;
            this.savedErr = System.err;
            System.setOut(new PrintStream(redirectedOut));
            System.setErr(new PrintStream(redirectedErr));
        }

        @Override
        public void close() throws Exception {
            System.out.flush();
            System.err.flush();
            System.setOut(savedOut);
            System.setErr(savedErr);
        }
        
        public String getOut() {
            return new String(redirectedOut.toByteArray());
        }
        
        public String getErr() {
            return new String(redirectedErr.toByteArray());
        }
    }
    
    private String getHelpOutput(String toolName) {
        StringWriter sw = new StringWriter();
        CeylonHelpTool helpTool = new CeylonHelpTool();
        helpTool.setToolLoader(toolLoader);
        if (toolName != null
                && !toolName.isEmpty()) {
            helpTool.setTool(toolLoader.loadToolModel(toolName));
        }
        helpTool.setOut(sw);
        helpTool.run();
        return sw.toString();
    }
    
    @Test
    public void testNoArgs()  throws Exception {
        try (CapturingStdOut out = new CapturingStdOut()) {
            Assert.assertEquals(CeylonTool.SC_OK, tool.bootstrap(args()));
            Assert.assertEquals(getHelpOutput(""), out.getOut());
            Assert.assertTrue(out.getErr().isEmpty());
        } 
        Assert.assertEquals("help", tool.getToolName());
    }

    @Test
    public void testVersionOption()  throws Exception {
        try (CapturingStdOut out = new CapturingStdOut()) {
            Assert.assertEquals(CeylonTool.SC_OK, tool.bootstrap(args("--version")));
            Assert.assertTrue(out.getOut(), out.getOut().startsWith("ceylon version "));
            Assert.assertTrue(out.getErr().isEmpty());
        }
        Assert.assertEquals(null, tool.getToolName());
    }
    
    @Test
    public void testVersionOptionHelp()  throws Exception {
        // --version beats everything
        try (CapturingStdOut out = new CapturingStdOut()) {
            Assert.assertEquals(CeylonTool.SC_OK, tool.bootstrap(args("--version", "help")));
            Assert.assertTrue(out.getOut(), out.getOut().startsWith("ceylon version "));
            Assert.assertTrue(out.getErr().isEmpty());
        }
        Assert.assertEquals(null, tool.getToolName());
    }
    
    @Test
    public void testHelpVersionOption()  throws Exception {
        // We expect NO_SUCH_TOOL in this case because the HelpTool 
        // isn't loadable by the toolLoader we're using
        try (CapturingStdOut out = new CapturingStdOut()) {
            Assert.assertEquals(CeylonTool.SC_ARGS, tool.bootstrap(args("help", "--version")));
            Assert.assertTrue(out.getOut().isEmpty());
            Assert.assertTrue(out.getErr(), out.getErr().contains("ceylon help: Unrecognised long option '--version'"));
        }
        Assert.assertEquals("help", tool.getToolName());
    }
    
    @Test
    public void testEmptyArg()  throws Exception {
        try (CapturingStdOut out = new CapturingStdOut()) {
            Assert.assertEquals(CeylonTool.SC_OK, tool.bootstrap(args("")));
            Assert.assertEquals(getHelpOutput(""), out.getOut());
        }
        Assert.assertEquals("help", tool.getToolName());
    }
    
    @Test
    public void testHelp()  throws Exception {
        try (CapturingStdOut out = new CapturingStdOut()) {
            Assert.assertEquals(CeylonTool.SC_OK, tool.bootstrap(args("help")));
            Assert.assertEquals(getHelpOutput(""), out.getOut());
        }
        Assert.assertEquals("help", tool.getToolName());
    }
    
    @Test
    public void testHelpOption()  throws Exception {
        try (CapturingStdOut out = new CapturingStdOut()) {
            Assert.assertEquals(CeylonTool.SC_OK, tool.bootstrap(args("--help")));
            Assert.assertEquals(getHelpOutput(""), out.getOut());
        }
        Assert.assertEquals("help", tool.getToolName());
    }

    @Test
    public void testExample()  throws Exception {
        try (CapturingStdOut out = new CapturingStdOut()) {
            Assert.assertEquals(CeylonTool.SC_OK, tool.bootstrap(args("example")));
            Assert.assertTrue(out.getErr(), out.getErr().isEmpty());
            Assert.assertTrue(out.getOut(), out.getOut().isEmpty());
        }
        Assert.assertEquals("example", tool.getToolName());
    }
    
    @Test
    public void testStacktracesOptionExample()  throws Exception {
        try (CapturingStdOut out = new CapturingStdOut()) {
            Assert.assertEquals(CeylonTool.SC_OK, tool.bootstrap(args("--stacktraces", "example")));
            Assert.assertTrue(out.getErr(), out.getErr().isEmpty());
            Assert.assertTrue(out.getOut(), out.getOut().isEmpty());
        }
        Assert.assertEquals("example", tool.getToolName());
        Assert.assertTrue(tool.getStacktraces());
    }
    
    @Test
    public void testFileOptionExample()  throws Exception {
        // the top level tool doesn't take a --file option
        try (CapturingStdOut out = new CapturingStdOut()) {
            Assert.assertEquals(CeylonTool.SC_ARGS, tool.bootstrap(args("--file=.", "example")));
            Assert.assertEquals(
"ceylon example: Unrecognised long option '--file=.' to command 'ceylon'\n"+
"\n"+
"Usage:\n"+
"ceylon [--no-pager] [--paginate] [--stacktraces] [--version] [--] [<tool-\n       arguments...>]\n"+
"\n"+
"Run 'ceylon help example' for more help",
                    out.getErr().trim().replace("\r", ""));
            Assert.assertTrue(out.getOut(), out.getOut().isEmpty());
        }
    }
    
    @Test
    public void testExampleFileOption()  throws Exception {
        try (CapturingStdOut out = new CapturingStdOut()) {
            Assert.assertEquals(CeylonTool.SC_OK, tool.bootstrap(args("example", "--file=.")));
            Assert.assertTrue(out.getOut(), out.getOut().isEmpty());
            Assert.assertTrue(out.getErr(), out.getErr().isEmpty());
        }
    }
    
    @Test
    public void testOptionExampleFil()  throws Exception {
        // the top level tool doesn't take a --file option
        try (CapturingStdOut out = new CapturingStdOut()) {
            Assert.assertEquals(CeylonTool.SC_ARGS, tool.bootstrap(args("example", "--fil=.")));
            Assert.assertEquals(
"ceylon example: Unrecognised long option '--fil=.' to command 'example'\n"+
"\n" +
"Usage:\n" +
"ceylon example [--file=<value>] [--list-option=<bars>...] [--long-name] [--pure-\n"+
"               option] [--short-name=<value>] [--thread-state=<value>] [--] [\n"+
"               <args...>]\n"+
"\n" +
"Did you mean?\n"+
"    --file\n"+
"\n"+
"Run 'ceylon help example' for more help",
                    out.getErr().trim().replace("\r", ""));
            Assert.assertTrue(out.getOut(), out.getOut().isEmpty());
        }
    }
    
    @Test
    public void testBug820()  throws Exception {
        // the top level tool doesn't take a --file option
        try (CapturingStdOut out = new CapturingStdOut()) {
            Assert.assertEquals(CeylonTool.SC_ARGS, tool.bootstrap(args("-rep", "http://something", "compile")));
            Assert.assertEquals(
                    "ceylon: 'http://something' is not a ceylon command\n" +
                    "Run 'ceylon help' for more help", out.getErr().trim().replace("\r", ""));
            Assert.assertTrue(out.getOut(), out.getOut().isEmpty());
        }
    }
    
    @Test
    public void testTopLevelUnknownTool()  throws Exception {
        try (CapturingStdOut out = new CapturingStdOut()) {
            Assert.assertEquals(CeylonTool.SC_NO_SUCH_TOOL, tool.bootstrap(args("comple", "foo/bar")));
            Assert.assertEquals(
                    "ceylon: 'comple' is not a ceylon command\n"+
"Did you mean?\n"+
"    compile\n"+
"    copy\n"+
"    example\n"+
"\n"+
"Run 'ceylon help' for more help", 
		out.getErr().trim().replace("\r", ""));
            Assert.assertTrue(out.getOut(), out.getOut().isEmpty());
        }
    }
    
    @Test
    public void testSubtoolMissingArg()  throws Exception {
        try (CapturingStdOut out = new CapturingStdOut()) {
            Assert.assertEquals(CeylonTool.SC_ARGS, tool.bootstrap(args("new", "hello-world")));
            Assert.assertEquals(
"ceylon new: Argument 'dir' to command 'hello-world' should appear at least 1\n"+
"time(s)\n"+
"\n"+
"Usage:\n"+
"ceylon new hello-world [--ant=<value>] [--eclipse=<value>] [--eclipse-project-\n"+
"           name=<value>] [--module-name=<value>] [--module-version=<value>] [--\n"+
"           ] <dir>\n"+
"\n"+
"Run 'ceylon help new' for more help", 
        out.getErr().trim().replace("\r", ""));
            Assert.assertTrue(out.getOut(), out.getOut().isEmpty());
        }
    }
    
    @Test
    public void testBashCompletion()  throws Exception {
        Assert.assertEquals(CeylonTool.SC_OK, tool.bootstrap(
                args("bash-completion", "--cword=1", "--", "./cey")));
    }
    
    @Test
    public void testOptionException()  throws Exception {
        try (CapturingStdOut out = new CapturingStdOut()) {
            Assert.assertEquals(CeylonTool.SC_ARGS, tool.bootstrap(args("doc", "--link=ceylon.math=foobar://baz", "ceylon.math")));
            Assert.assertEquals(
                    "ceylon doc: Invalid value '[ceylon.math=foobar://baz]' given for option 'link'\n"+
"to command 'doc': Unexpected link protocol: ceylon.math=foobar://baz (allowed\n"+
"are: http://, https://, file://)\n"+
"\n"+
"Usage:\n"+
"ceylon doc [--link=<url>...] [--non-shared] [--out=<dir-or-url>] [--pass=\n"+
"           <secret>] [--rep=<dir-or-url>...] [--source-code] [--src=<dir>...] [\n"+
"           --sysrep=<dir-or-url>] [--user=<name>] [--] <modules...>\n"+
"\n"+
"--link=<url>\n"+
"            The URL of a module repository containing documentation for\n"+
"            external dependencies.\n"+
"\n"+
"            Parameter url must be one of supported protocols (http://, https://\n"+
"            or file://). Parameter url can be prefixed with module name\n"+
"            pattern, separated by a '=' character, determine for which external\n"+
"            modules will be use.\n"+
"\n"+
"            Examples:\n"+
"\n"+
"            --link "+Constants.REPO_URL_CEYLON+"\n"+
"            --link ceylon.math="+Constants.REPO_URL_CEYLON+"\n"+
"\n"+
"Run 'ceylon help doc' for more help", 
        out.getErr().trim().replace("\r", ""));
            Assert.assertTrue(out.getOut(), out.getOut().isEmpty());
        }
    }
    
}