org.opencms.main.TestCmsShellInline Maven / Gradle / Ivy
Show all versions of opencms-test Show documentation
/*
* This library is part of OpenCms -
* the Open Source Content Management System
*
* Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* For further information about Alkacon Software GmbH & Co. KG, please see the
* company website: http://www.alkacon.com
*
* For further information about OpenCms, please see the
* project website: http://www.opencms.org
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.opencms.main;
import org.opencms.file.CmsGroup;
import org.opencms.file.CmsObject;
import org.opencms.i18n.CmsMessages;
import org.opencms.security.CmsRole;
import org.opencms.test.OpenCmsTestCase;
import org.opencms.test.OpenCmsTestProperties;
import java.awt.event.KeyEvent;
import java.io.ByteArrayOutputStream;
import java.io.PrintStream;
import java.util.List;
import junit.extensions.TestSetup;
import junit.framework.Test;
import junit.framework.TestSuite;
/**
* Test cases for the OpenCms shell when used "inline".
*
* @since 9.5.0
*/
public class TestCmsShellInline extends OpenCmsTestCase {
/** Default inline shell prompt for most test cases. */
private static final String PROMPT = "Inline shell: ${user}@${siteroot}${uri}> ";
/** Default escape sequence in linux for the arrow up key. */
final private String ARROW_UP = new String(new byte[]{KeyEvent.VK_ESCAPE, KeyEvent.VK_OPEN_BRACKET, 'A'});
/**
* Default JUnit constructor.
*
* @param arg0 JUnit parameters
*/
public TestCmsShellInline(String arg0) {
super(arg0);
}
/**
* Test suite for this test class.
*
* @return the test suite
*/
public static Test suite() {
OpenCmsTestProperties.initialize(org.opencms.test.AllTests.TEST_PROPERTIES_PATH);
TestSuite suite = new TestSuite();
suite.setName(TestCmsShellInline.class.getName());
suite.addTest(new TestCmsShellInline("testShellInline"));
suite.addTest(new TestCmsShellInline("testShellSetProperties"));
suite.addTest(new TestCmsShellInline("testShellCreateUser"));
suite.addTest(new TestCmsShellInline("testShellEchoOff"));
suite.addTest(new TestCmsShellInline("testShellLineParsing"));
TestSetup wrapper = new TestSetup(suite) {
@Override
protected void setUp() {
setupOpenCms(null, "/sites/default/");
}
@Override
protected void tearDown() {
removeOpenCms();
}
};
return wrapper;
}
/**
* Tests creation of users using the shell.
*
* @throws Exception in case something goes wrong
*/
public void testShellCreateUser() throws Exception {
CmsObject cms = getCmsObject();
CmsShell shell = new CmsShell(cms, PROMPT, null, System.out, System.err);
shell.execute("echo on");
shell.execute("createUser 'Editor' 'password' 'Sample editor user'");
shell.execute("addUserToGroup 'Editor' 'Users'");
shell.execute("addUserToRole 'Editor' 'EDITOR'");
assertTrue(
"Editor does not have EDITOR role",
OpenCms.getRoleManager().hasRole(cms, "Editor", CmsRole.EDITOR));
List groups = cms.getGroupsOfUser("Editor", true);
boolean found = false;
for (CmsGroup g : groups) {
if (g.getName().equals("Users")) {
found = true;
break;
}
}
assertTrue("Editor not a member of the Users group", found);
}
/**
* Tests the shell without 'echo on'.
*
* @throws Exception in case something goes wrong
*/
public void testShellEchoOff() throws Exception {
ByteArrayOutputStream bytes = new ByteArrayOutputStream();
PrintStream out = new PrintStream(bytes);
CmsObject cms = getCmsObject();
CmsShell shell = new CmsShell(cms, PROMPT, null, out, out);
shell.execute("pwd \n userName \n version");
// some variables in the String so that we don't have to change the test case every version / year
String expected = "\n"
+ "Welcome to the OpenCms shell!\n"
+ "\n"
+ "\n"
+ "This is OpenCms "
+ OpenCms.getSystemInfo().getVersionNumber()
+ ".\n"
+ "\n"
+ Messages.COPYRIGHT_BY_ALKACON[1]
+ "\n"
+ "OpenCms comes with ABSOLUTELY NO WARRANTY\n"
+ "This is free software, and you are welcome to\n"
+ "redistribute it under certain conditions.\n"
+ "Please see the GNU Lesser General Public Licence for\n"
+ "further details.\n"
+ "\n"
+ "/\n"
+ "Admin\n"
+ "\n"
+ "This is OpenCms "
+ OpenCms.getSystemInfo().getVersionNumber()
+ ".\n";
String result = bytes.toString();
assertEquals("Shell did not produce expected output", expected, result);
}
/**
* Tests basic inline shell invocation.
*
* @throws Exception in case something goes wrong
*/
public void testShellInline() throws Exception {
ByteArrayOutputStream bytes = new ByteArrayOutputStream();
PrintStream out = new PrintStream(bytes);
CmsObject cms = getCmsObject();
CmsShell shell = new CmsShell(cms, PROMPT, null, out, out);
shell.execute("echo on\n pwd \n userName \n exit");
// some variables in the String so that we don't have to change the test case every version / year
String expected = "\nWelcome to the OpenCms shell!\n"
+ "\n"
+ "\n"
+ "This is OpenCms "
+ OpenCms.getSystemInfo().getVersionNumber()
+ ".\n"
+ "\n"
+ Messages.COPYRIGHT_BY_ALKACON[1]
+ "\n"
+ "OpenCms comes with ABSOLUTELY NO WARRANTY\n"
+ "This is free software, and you are welcome to\n"
+ "redistribute it under certain conditions.\n"
+ "Please see the GNU Lesser General Public Licence for\n"
+ "further details.\n"
+ "\n"
+ "Echo is now on.\n"
+ "Inline shell: Admin@/sites/default/> pwd\n"
+ "/\n"
+ "Inline shell: Admin@/sites/default/> userName\n"
+ "Admin\n"
+ "Inline shell: Admin@/sites/default/> exit\n"
+ "\n"
+ "Goodbye!\n";
String result = bytes.toString();
assertEquals("Shell did not produce expected output", expected, result);
}
/**
* Tests that the shell properly ignores escape sequences.
*
* @throws Exception in case something goes wrong
*/
public void testShellLineParsing() throws Exception {
ByteArrayOutputStream bOut = new ByteArrayOutputStream();
ByteArrayOutputStream bErr = new ByteArrayOutputStream();
PrintStream out = new PrintStream(bOut);
PrintStream err = new PrintStream(bErr);
CmsObject cms = getCmsObject();
CmsShell shell = new CmsShell(cms, PROMPT, null, out, err);
String commands = "echo on\n" // This should be processed
+ ARROW_UP + "echo off\n" // The shell should detect the escape sequence and ignore the rest
+ "\n"
+ ".\n" // This should be ignored and shouldn't break the shell
+ "/\n" // Same here -- Parsed as StreamTokenizer.TT_NUMBER
+ "*\n" // Same here -- Parsed as StreamTokenizer.TT_NUMBER
+ "(\n" // Same here -- Parsed as NOT StreamTokenizer.TT_NUMBER
+ "-\n" // Same here -- Parsed as NOT StreamTokenizer.TT_NUMBER
+ "( ( (\n" // Same here -- Parsed as NOT StreamTokenizer.TT_NUMBER
+ "setRequestTime(11)\n" // Test parsing of numerical parameters
+ "setRequestTime 12\n" // Test parsing of numerical parameters
+ "setRequestTime /\n" // Test parsing of numerical parameters
+ "setRequestTime / 13\n" // Test parsing of numerical parameters
+ "setRequestTime /14\n" // Test parsing of numerical parameters
+ "exit\n"; // Should exit gracefully
shell.execute(commands);
String resultOut = bOut.toString();
String resultErr = bErr.toString();
System.out.println(resultOut);
System.err.println(resultErr);
CmsMessages messages = Messages.get().getBundle(shell.getLocale());
assertTrue("Escape sequence not detected", resultOut.contains(messages.key(Messages.GUI_SHELL_ESCAPE_SEQUENCES_NOT_SUPPORTED_0)));
assertTrue("Command 'echo on' skipped", resultOut.contains("Echo is now on"));
assertTrue("Shell didn't exit gracefully.", resultOut.contains("Goodbye!"));
}
/**
* Tests setting some properties using the shell.
*
* @throws Exception in case something goes wrong
*/
public void testShellSetProperties() throws Exception {
CmsObject cms = getCmsObject();
CmsShell shell = new CmsShell(cms, PROMPT, null, System.out, System.err);
String read, value;
value = "This is a test";
shell.execute("echo on\n help * \n writeProperty '/' 'Title' '" + value + "'");
read = cms.readPropertyObject("/", "Title", false).getValue();
assertEquals("Title property not set as expected", value, read);
value = "This is on the sites folder";
shell.execute("setSiteRoot '/' \n writeProperty '/sites/' 'Title' '" + value + "'");
read = cms.readPropertyObject("/sites/", "Title", false).getValue();
assertEquals("Title property not set as expected", value, read);
}
}