/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License, Version 1.0 only
* (the "License"). You may not use this file except in compliance
* with the License.
*
* You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
* or http://forgerock.org/license/CDDLv1.0.html.
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at legal-notices/CDDLv1_0.txt.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information:
* Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*
*
* Portions Copyright 2013-2015 ForgeRock AS.
*/
package org.opends.server.tools;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.PrintStream;
import java.util.Collections;
import java.util.LinkedList;
import java.util.List;
import org.assertj.core.api.Assertions;
import org.forgerock.i18n.LocalizableMessage;
import org.opends.server.TestCaseUtils;
import org.opends.server.core.DirectoryServer;
import org.opends.server.tools.upgrade.UpgradeCli;
import org.opends.server.util.StaticUtils;
import org.testng.annotations.Test;
import static org.opends.messages.ToolMessages.*;
import static com.forgerock.opendj.cli.ArgumentConstants.*;
import static org.testng.Assert.*;
/**
* A set of test cases for the Upgrade tool.
*/
@SuppressWarnings("javadoc")
public class UpgradeTestCase extends ToolsTestCase
{
private static final String configFilePath = DirectoryServer.getInstanceRoot()
+ File.separator + "config" + File.separator + "config.ldif";
/**
* Sets the args for the upgrade tools. The configFile parameter is configured
* by default.
*
* <pre>
* usage : {@code}setArgs("--force", "--no-prompt") {@code}
* corresponds to command line : ./upgrade --force -n
* </pre>
*
* @param args
* The argument you want for testing.
* @return An array of string containing the args.
*/
private String[] setArgs(String... args)
{
final List<String> argsList = new LinkedList<>();
argsList.add("--configFile");
argsList.add(configFilePath);
if (args != null)
{
Collections.addAll(argsList, args);
}
return argsList.toArray(new String[argsList.size()]);
}
/**
* Returns {@code true} if the output contain the expected message.
*
* @param output
* The upgrade's output.
* @param expectedMessage
* The expected message.
*/
private void assertContainsMessage(String output, LocalizableMessage expectedMessage)
{
String out = output.replaceAll("\n", " ").replaceAll("%s", " ");
String expected = expectedMessage.toString().replaceAll("\n", " ").replaceAll("%s", " ");
Assertions.assertThat(out).contains(expected);
}
/**
* Tests display help information.
*/
@Test
public void testUpgradeToolDisplaysHelpUsage()
{
final ByteArrayOutputStream baos = new ByteArrayOutputStream();
final PrintStream ps = new PrintStream(baos);
try
{
// The 'main' should exit with success code.
assertEquals(UpgradeCli.main(setArgs("--help"), true, ps, ps), 0);
assertContainsMessage(baos.toString(), INFO_UPGRADE_DESCRIPTION_CLI.get());
}
finally
{
StaticUtils.close(ps, baos);
}
}
/**
* Tests display help information.
*/
@Test
public void testUpgradeToolDisplaysHelpUsage2()
{
final ByteArrayOutputStream baos = new ByteArrayOutputStream();
final PrintStream ps = new PrintStream(baos);
try
{
// The 'main' should exit with success code.
assertEquals(UpgradeCli.main(setArgs("-H"), true, ps, ps), 0);
assertContainsMessage(baos.toString(), INFO_UPGRADE_DESCRIPTION_CLI.get());
}
finally
{
StaticUtils.close(ps, baos);
}
}
/**
* Tests display help information.
*/
@Test
public void testUpgradeToolDisplaysHelpUsage3()
{
final ByteArrayOutputStream baos = new ByteArrayOutputStream();
final PrintStream ps = new PrintStream(baos);
try
{
// The 'main' should exit with success code.
assertEquals(UpgradeCli.main(setArgs("-?"), true, ps, ps), 0);
assertContainsMessage(baos.toString(), INFO_UPGRADE_DESCRIPTION_CLI.get());
}
finally
{
StaticUtils.close(ps, baos);
}
}
/**
* Tests the upgrade tool with an invalid sub-command.
*/
@Test
public void testUpgradeToolDoesntAllowWrongSubcommand()
{
final ByteArrayOutputStream baos = new ByteArrayOutputStream();
final PrintStream ps = new PrintStream(baos);
try
{
// The 'main' should exit with an error code.
assertEquals(UpgradeCli.main(setArgs("-- wrong"), true, ps, ps), 1);
assertContainsMessage(baos.toString(), ERR_ERROR_PARSING_ARGS.get(""));
}
finally
{
StaticUtils.close(ps, baos);
}
}
/**
* Tests the upgrade tool with an invalid sub-command.
*/
@Test
public void testUpgradeToolDoesntAllowWrongSubcommand2()
{
final ByteArrayOutputStream baos = new ByteArrayOutputStream();
final PrintStream ps = new PrintStream(baos);
try
{
// The 'main' should exit with an error code.
assertEquals(UpgradeCli.main(setArgs("--wrong"), true, ps, ps), 1);
assertContainsMessage(baos.toString(), ERR_ERROR_PARSING_ARGS.get(""));
}
finally
{
StaticUtils.close(ps, baos);
}
}
/**
* The upgrade tool disallows the force sub-command used with 'interactive
* mode'.
*/
@Test
public void testUpgradeToolDoesntAllowInteractiveAndForce()
{
final ByteArrayOutputStream baos = new ByteArrayOutputStream();
final PrintStream ps = new PrintStream(baos);
try
{
// The 'main' should exit with an error code.
assertEquals(UpgradeCli.main(setArgs("--force"), true, ps, ps), 1);
// Because interactive mode is not compatible with force upgrade mode.
assertContainsMessage(baos.toString(), ERR_UPGRADE_INCOMPATIBLE_ARGS.get(
OPTION_LONG_FORCE_UPGRADE, "interactive mode"));
}
finally
{
StaticUtils.close(ps, baos);
}
}
/**
* Upgrade tool allows use of force and no-prompt sub-commands.
*/
@Test
public void testUpgradeToolAllowsNonInteractiveAndForce() throws Exception
{
TestCaseUtils.startServer();
final ByteArrayOutputStream baos = new ByteArrayOutputStream();
final PrintStream ps = new PrintStream(baos);
try
{
// The 'main' should exit with success code.
int rc = UpgradeCli.main(setArgs("--force", "--no-prompt"), true, ps, ps);
assertEquals(rc, 0);
// The sub-commands have been checked ok but upgrade must exist on
// version's verification.
assertContainsMessage(baos.toString(), ERR_UPGRADE_VERSION_UP_TO_DATE.get(""));
}
finally
{
StaticUtils.close(ps, baos);
}
}
}