Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id 60FAF200D4F for ; Wed, 6 Dec 2017 21:37:11 +0100 (CET) Received: by cust-asf.ponee.io (Postfix) id 5F66B160C1D; Wed, 6 Dec 2017 20:37:11 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id D4D9A160BF3 for ; Wed, 6 Dec 2017 21:37:09 +0100 (CET) Received: (qmail 50520 invoked by uid 500); 6 Dec 2017 20:37:09 -0000 Mailing-List: contact issues-help@geode.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@geode.apache.org Delivered-To: mailing list issues@geode.apache.org Received: (qmail 50511 invoked by uid 99); 6 Dec 2017 20:37:09 -0000 Received: from pnap-us-west-generic-nat.apache.org (HELO spamd3-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 06 Dec 2017 20:37:09 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd3-us-west.apache.org (ASF Mail Server at spamd3-us-west.apache.org) with ESMTP id 3273C18061F for ; Wed, 6 Dec 2017 20:37:08 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd3-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: -99.202 X-Spam-Level: X-Spam-Status: No, score=-99.202 tagged_above=-999 required=6.31 tests=[KAM_ASCII_DIVIDERS=0.8, RP_MATCHES_RCVD=-0.001, SPF_PASS=-0.001, USER_IN_WHITELIST=-100] autolearn=disabled Received: from mx1-lw-us.apache.org ([10.40.0.8]) by localhost (spamd3-us-west.apache.org [10.40.0.10]) (amavisd-new, port 10024) with ESMTP id J5CLbtZtGSGS for ; Wed, 6 Dec 2017 20:37:01 +0000 (UTC) Received: from mailrelay1-us-west.apache.org (mailrelay1-us-west.apache.org [209.188.14.139]) by mx1-lw-us.apache.org (ASF Mail Server at mx1-lw-us.apache.org) with ESMTP id 1B58E5F253 for ; Wed, 6 Dec 2017 20:37:01 +0000 (UTC) Received: from jira-lw-us.apache.org (unknown [207.244.88.139]) by mailrelay1-us-west.apache.org (ASF Mail Server at mailrelay1-us-west.apache.org) with ESMTP id 89BEEE0AA3 for ; Wed, 6 Dec 2017 20:37:00 +0000 (UTC) Received: from jira-lw-us.apache.org (localhost [127.0.0.1]) by jira-lw-us.apache.org (ASF Mail Server at jira-lw-us.apache.org) with ESMTP id 35E3E255BF for ; Wed, 6 Dec 2017 20:37:00 +0000 (UTC) Date: Wed, 6 Dec 2017 20:37:00 +0000 (UTC) From: "ASF GitHub Bot (JIRA)" To: issues@geode.apache.org Message-ID: In-Reply-To: References: Subject: [jira] [Commented] (GEODE-4052) Expand GfshExitCodeStatusCommandTest into multiple classes for more meaningful failure reporting MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 7bit X-JIRA-FingerPrint: 30527f35849b9dde25b450d4833f0394 archived-at: Wed, 06 Dec 2017 20:37:11 -0000 [ https://issues.apache.org/jira/browse/GEODE-4052?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16280863#comment-16280863 ] ASF GitHub Bot commented on GEODE-4052: --------------------------------------- PurelyApplied closed pull request #1125: GEODE-4052: Expand GfshExitCodeStatusCommandsTest to multiple... URL: https://github.com/apache/geode/pull/1125 This is a PR merged from a forked repository. As GitHub hides the original diff on merge, it is displayed below for the sake of provenance: As this is a foreign pull request (from a fork), the diff is supplied below (as it won't show otherwise due to GitHub magic): diff --git a/geode-assembly/src/test/java/org/apache/geode/management/internal/cli/shell/GfshExitCodeStatusCommandsTest.java b/geode-assembly/src/test/java/org/apache/geode/management/internal/cli/shell/GfshExitCodeStatusCommandsTest.java deleted file mode 100755 index e833b23c29..0000000000 --- a/geode-assembly/src/test/java/org/apache/geode/management/internal/cli/shell/GfshExitCodeStatusCommandsTest.java +++ /dev/null @@ -1,404 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more contributor license - * agreements. See the NOTICE file distributed with this work for additional information regarding - * copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the - * "License"); you may not use this file except in compliance with the License. You may obtain a - * copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software distributed under the License - * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express - * or implied. See the License for the specific language governing permissions and limitations under - * the License. - */ -package org.apache.geode.management.internal.cli.shell; - -import static java.util.concurrent.TimeUnit.MINUTES; - -import java.io.File; -import java.io.IOException; -import java.util.ArrayList; -import java.util.Arrays; -import java.util.List; - -import junitparams.JUnitParamsRunner; -import junitparams.Parameters; -import org.junit.Assume; -import org.junit.Before; -import org.junit.BeforeClass; -import org.junit.Rule; -import org.junit.Test; -import org.junit.experimental.categories.Category; -import org.junit.runner.RunWith; - -import org.apache.geode.internal.AvailablePort; -import org.apache.geode.internal.ExitCode; -import org.apache.geode.internal.process.PidFile; -import org.apache.geode.management.internal.cli.util.CommandStringBuilder; -import org.apache.geode.management.internal.cli.util.ThreePhraseGenerator; -import org.apache.geode.test.junit.categories.AcceptanceTest; -import org.apache.geode.test.junit.rules.gfsh.GfshExecution; -import org.apache.geode.test.junit.rules.gfsh.GfshRule; -import org.apache.geode.test.junit.rules.gfsh.GfshScript; - -// Originally created in response to GEODE-2971 - -@Category(AcceptanceTest.class) -@RunWith(JUnitParamsRunner.class) -public class GfshExitCodeStatusCommandsTest { - private static File toolsJar; - private static final ThreePhraseGenerator nameGenerator = new ThreePhraseGenerator(); - private static final String memberControllerName = "member-controller"; - - @Rule - public GfshRule gfsh = new GfshRule(); - private String locatorName; - private String serverName; - - private int locatorPort; - - // Some test configuration shorthands - private static final TestConfiguration LOCATOR_ONLINE_BUT_NOT_CONNECTED = - new TestConfiguration(true, false, false); - private static final TestConfiguration LOCATOR_ONLINE_AND_CONNECTED = - new TestConfiguration(true, false, true); - private static final TestConfiguration BOTH_ONLINE_BUT_NOT_CONNECTED = - new TestConfiguration(true, true, false); - private static final TestConfiguration BOTH_ONLINE_AND_CONNECTED = - new TestConfiguration(true, true, true); - - @BeforeClass - public static void classSetup() { - File javaHome = new File(System.getProperty("java.home")); - String toolsPath = - javaHome.getName().equalsIgnoreCase("jre") ? "../lib/tools.jar" : "lib/tools.jar"; - toolsJar = new File(javaHome, toolsPath); - } - - @Before - public void setup() { - locatorName = "locator-" + nameGenerator.generate('-'); - serverName = "server-" + nameGenerator.generate('-'); - locatorPort = AvailablePort.getRandomAvailablePort(AvailablePort.SOCKET); - } - - @Test - @Parameters( - value = {"status locator --port=-10", "status locator --pid=-1", "status server --pid=-1"}) - public void statusCommandWithInvalidOptionValueShouldFail(String cmd) { - GfshScript.of(cmd).withName("test-frame").awaitAtMost(1, MINUTES) - .expectExitCode(ExitCode.FATAL.getValue()).execute(gfsh); - } - - - @Test - @Parameters(value = {"status locator --host=somehostname", "status locator --port=10334", - "status locator --dir=.", "status server --dir=.", "status locator --name=some-locator-name", - "status server --name=some-server-name", "status locator --pid=100", - "status server --pid=100"}) - public void statusCommandWithValidOptionValueShouldFailWithNoMembers(String cmd) { - GfshScript.of(cmd).withName("test-frame").awaitAtMost(1, MINUTES) - .expectExitCode(ExitCode.FATAL.getValue()).execute(gfsh); - } - - - @Test - public void onlineStatusCommandShouldFailWhenNotConnected_locator_name() { - TestConfiguration config = LOCATOR_ONLINE_BUT_NOT_CONNECTED; - config.startNecessaryMembers(startLocatorCommand(), startServerCommand(), gfsh); - - String statusCommand = statusLocatorCommandByName(); - executeScriptWithExpectedExitCode(statusCommand, config, ExitCode.FATAL); - } - - - @Test - public void onlineStatusCommandShouldFailWhenNotConnected_server_name() { - TestConfiguration config = BOTH_ONLINE_BUT_NOT_CONNECTED; - config.startNecessaryMembers(startLocatorCommand(), startServerCommand(), gfsh); - - String statusCommand = statusServerCommandByName(); - executeScriptWithExpectedExitCode(statusCommand, config, ExitCode.FATAL); - } - - @Test - public void offlineStatusCommandShouldSucceedWhenNotConnected_locator_port() { - // --host defaults to localhost, so `status locator --port=xxx` should still succeed. - TestConfiguration config = LOCATOR_ONLINE_BUT_NOT_CONNECTED; - config.startNecessaryMembers(startLocatorCommand(), startServerCommand(), gfsh); - - String statusCommand = statusLocatorCommandByPort(); - executeScriptWithExpectedExitCode(statusCommand, config, ExitCode.NORMAL); - } - - @Test - public void offlineStatusCommandShouldSucceedWhenNotConnected_locator_host_and_port() { - // Since this is still local to the testing VM's machine, `status locator --host=localhost - // --port=xxx` should succeed - TestConfiguration config = LOCATOR_ONLINE_BUT_NOT_CONNECTED; - config.startNecessaryMembers(startLocatorCommand(), startServerCommand(), gfsh); - - String statusCommand = statusLocatorCommandByHostAndPort(); - executeScriptWithExpectedExitCode(statusCommand, config, ExitCode.NORMAL); - } - - - - @Test - public void onlineStatusCommandShouldSucceedWhenConnected_locator_name() { - TestConfiguration config = LOCATOR_ONLINE_AND_CONNECTED; - config.startNecessaryMembers(startLocatorCommand(), startServerCommand(), gfsh); - - String statusCommand = statusLocatorCommandByName(); - executeScriptWithExpectedExitCode(statusCommand, config, ExitCode.NORMAL); - } - - - @Test - public void onlineStatusCommandShouldSucceedWhenConnected_server_name() { - TestConfiguration config = BOTH_ONLINE_AND_CONNECTED; - config.startNecessaryMembers(startLocatorCommand(), startServerCommand(), gfsh); - - String statusCommand = statusServerCommandByName(); - executeScriptWithExpectedExitCode(statusCommand, config, ExitCode.NORMAL); - } - - @Test - public void onlineStatusCommandShouldSucceedWhenConnected_locator_port() { - TestConfiguration config = LOCATOR_ONLINE_AND_CONNECTED; - config.startNecessaryMembers(startLocatorCommand(), startServerCommand(), gfsh); - - String statusCommand = statusLocatorCommandByPort(); - executeScriptWithExpectedExitCode(statusCommand, config, ExitCode.NORMAL); - } - - @Test - public void onlineStatusCommandShouldSucceedWhenConnected_locator_host_and_port() { - TestConfiguration config = LOCATOR_ONLINE_AND_CONNECTED; - config.startNecessaryMembers(startLocatorCommand(), startServerCommand(), gfsh); - - String statusCommand = statusLocatorCommandByHostAndPort(); - executeScriptWithExpectedExitCode(statusCommand, config, ExitCode.NORMAL); - } - - @Test - public void onlineStatusCommandShouldFailWhenConnectedNonDefaultPort_locator_host() { - TestConfiguration config = LOCATOR_ONLINE_AND_CONNECTED; - config.startNecessaryMembers(startLocatorCommand(), startServerCommand(), gfsh); - - String statusCommand = statusLocatorCommandByHost(); - executeScriptWithExpectedExitCode(statusCommand, config, ExitCode.FATAL); - } - - - - @Test - public void offlineStatusCommandShouldSucceedWhenConnected_locator_dir() { - TestConfiguration config = LOCATOR_ONLINE_AND_CONNECTED; - config.startNecessaryMembers(startLocatorCommand(), startServerCommand(), gfsh); - - String statusCommand = statusLocatorCommandByDir(); - executeScriptWithExpectedExitCode(statusCommand, config, ExitCode.NORMAL); - } - - @Test - public void offlineStatusCommandShouldSucceedWhenConnected_server_dir() { - TestConfiguration config = BOTH_ONLINE_AND_CONNECTED; - config.startNecessaryMembers(startLocatorCommand(), startServerCommand(), gfsh); - - String statusCommand = statusServerCommandByDir(); - executeScriptWithExpectedExitCode(statusCommand, config, ExitCode.NORMAL); - } - - @Test - public void offlineStatusCommandShouldSucceedWhenConnected_locator_pid() throws IOException { - Assume.assumeTrue(toolsJar.exists()); - TestConfiguration config = LOCATOR_ONLINE_AND_CONNECTED; - config.startNecessaryMembers(startLocatorCommand(), startServerCommand(), gfsh); - - String statusCommand = statusLocatorCommandByPid(); - executeScriptWithExpectedExitCode(statusCommand, config, ExitCode.NORMAL); - } - - @Test - public void offlineStatusCommandShouldSucceedWhenConnected_server_pid() throws IOException { - Assume.assumeTrue(toolsJar.exists()); - TestConfiguration config = BOTH_ONLINE_AND_CONNECTED; - config.startNecessaryMembers(startLocatorCommand(), startServerCommand(), gfsh); - - String statusCommand = statusServerCommandByPid(); - executeScriptWithExpectedExitCode(statusCommand, config, ExitCode.NORMAL); - } - - - - @Test - public void offlineStatusCommandShouldSucceedEvenWhenNotConnected_locator_dir() { - TestConfiguration config = LOCATOR_ONLINE_BUT_NOT_CONNECTED; - config.startNecessaryMembers(startLocatorCommand(), startServerCommand(), gfsh); - - String statusCommand = statusLocatorCommandByDir(); - executeScriptWithExpectedExitCode(statusCommand, config, ExitCode.NORMAL); - } - - @Test - public void offlineStatusCommandShouldSucceedEvenWhenNotConnected_server_dir() { - TestConfiguration config = BOTH_ONLINE_BUT_NOT_CONNECTED; - config.startNecessaryMembers(startLocatorCommand(), startServerCommand(), gfsh); - - String statusCommand = statusServerCommandByDir(); - executeScriptWithExpectedExitCode(statusCommand, config, ExitCode.NORMAL); - } - - @Test - public void offlineStatusCommandShouldSucceedEvenWhenNotConnected_locator_pid() - throws IOException { - Assume.assumeTrue(toolsJar.exists()); - TestConfiguration config = LOCATOR_ONLINE_BUT_NOT_CONNECTED; - config.startNecessaryMembers(startLocatorCommand(), startServerCommand(), gfsh); - - String statusCommand = statusLocatorCommandByPid(); - executeScriptWithExpectedExitCode(statusCommand, config, ExitCode.NORMAL); - } - - @Test - public void offlineStatusCommandShouldSucceedEvenWhenNotConnected_server_pid() - throws IOException { - Assume.assumeTrue(toolsJar.exists()); - TestConfiguration config = BOTH_ONLINE_BUT_NOT_CONNECTED; - config.startNecessaryMembers(startLocatorCommand(), startServerCommand(), gfsh); - - String statusCommand = statusServerCommandByPid(); - executeScriptWithExpectedExitCode(statusCommand, config, ExitCode.NORMAL); - } - - - - private String startLocatorCommand() { - return new CommandStringBuilder("start locator").addOption("name", locatorName) - .addOption("port", String.valueOf(locatorPort)).toString(); - } - - - private String startServerCommand() { - return new CommandStringBuilder("start server").addOption("name", serverName).toString(); - } - - - private String connectCommand() { - return new CommandStringBuilder("connect") - .addOption("locator", String.format("localhost[%d]", locatorPort)).toString(); - } - - - private String statusServerCommandByName() { - return new CommandStringBuilder("status server").addOption("name", serverName).toString(); - } - - private String statusServerCommandByDir() { - String serverDir = gfsh.getTemporaryFolder().getRoot().toPath().resolve(memberControllerName) - .resolve(serverName).toAbsolutePath().toString(); - return new CommandStringBuilder("status server").addOption("dir", serverDir).toString(); - } - - - private String statusServerCommandByPid() throws IOException { - int serverPid = snoopMemberFile(serverName, "server.pid"); - return new CommandStringBuilder("status server").addOption("pid", String.valueOf(serverPid)) - .toString(); - } - - private String statusLocatorCommandByName() { - return new CommandStringBuilder("status locator").addOption("name", locatorName).toString(); - } - - private String statusLocatorCommandByPort() { - return new CommandStringBuilder("status locator").addOption("port", String.valueOf(locatorPort)) - .toString(); - } - - private String statusLocatorCommandByHostAndPort() { - return new CommandStringBuilder("status locator").addOption("host", "localhost") - .addOption("port", String.valueOf(locatorPort)).toString(); - } - - private String statusLocatorCommandByHost() { - return new CommandStringBuilder("status locator").addOption("host", "localhost").toString(); - } - - private String statusLocatorCommandByDir() { - String locatorDir = gfsh.getTemporaryFolder().getRoot().toPath().resolve(memberControllerName) - .resolve(locatorName).toAbsolutePath().toString(); - return new CommandStringBuilder("status locator").addOption("dir", locatorDir).toString(); - } - - - private String statusLocatorCommandByPid() throws IOException { - int locatorPid = snoopMemberFile(locatorName, "locator.pid"); - return new CommandStringBuilder("status locator").addOption("pid", String.valueOf(locatorPid)) - .toString(); - } - - private int snoopMemberFile(String memberName, String pidFileEndsWith) throws IOException { - File directory = gfsh.getTemporaryFolder().getRoot().toPath().resolve(memberControllerName) - .resolve(memberName).toFile(); - File[] files = directory.listFiles(); - if (files == null) { - throw new RuntimeException(String.format( - "Expected directory ('%s') for member '%s' either does not denote a directory, or an I/O error occurred.", - directory.toString(), memberName)); - } - File pidFile = Arrays.stream(files).filter(file -> file.getName().endsWith(pidFileEndsWith)) - .findFirst().orElseThrow(() -> new RuntimeException(String - .format("Expected member '%s' to have pid file but could not find it.", memberName))); - return new PidFile(pidFile).readPid(); - } - - private void executeScriptWithExpectedExitCode(String statusCommand, TestConfiguration config, - ExitCode expectedExit) { - - String[] gfshScriptCommands = config.connectedToLocator - ? new String[] {connectCommand(), statusCommand} : new String[] {statusCommand}; - GfshScript gfshScript = GfshScript.of(gfshScriptCommands).withName("test-frame") - .awaitAtMost(1, MINUTES).expectExitCode(expectedExit.getValue()); - if (toolsJar.exists()) { - gfshScript.addToClasspath(toolsJar.getAbsolutePath()); - } - gfshScript.execute(gfsh); - } - - - private static class TestConfiguration { - TestConfiguration(boolean locatorStarted, boolean serverStarted, boolean connectedToLocator) { - this.locatorStarted = locatorStarted; - this.serverStarted = serverStarted; - this.connectedToLocator = connectedToLocator; - } - - private boolean locatorStarted; - private boolean serverStarted; - private boolean connectedToLocator; - - void startNecessaryMembers(String startLocator, String startServer, GfshRule gfsh) { - if (!locatorStarted && !serverStarted) { - return; - } - - List commands = new ArrayList<>(); - if (locatorStarted) { - commands.add(startLocator); - } - if (serverStarted) { - commands.add(startServer); - } - - GfshExecution exec = GfshScript.of(commands.toArray(new String[] {})) - .withName(memberControllerName).awaitAtMost(1, MINUTES).execute(gfsh); - if (exec.getProcess().exitValue() != 0) { - throw new RuntimeException( - "The locator and server launcher exited with non-zero exit code. This failure is beyond the scope of this test."); - } - } - } -} diff --git a/geode-assembly/src/test/java/org/apache/geode/management/internal/cli/shell/StatusLocatorExitCodeAcceptanceTest.java b/geode-assembly/src/test/java/org/apache/geode/management/internal/cli/shell/StatusLocatorExitCodeAcceptanceTest.java new file mode 100644 index 0000000000..48ecc75d21 --- /dev/null +++ b/geode-assembly/src/test/java/org/apache/geode/management/internal/cli/shell/StatusLocatorExitCodeAcceptanceTest.java @@ -0,0 +1,267 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more contributor license + * agreements. See the NOTICE file distributed with this work for additional information regarding + * copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance with the License. You may obtain a + * copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software distributed under the License + * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express + * or implied. See the License for the specific language governing permissions and limitations under + * the License. + */ + +package org.apache.geode.management.internal.cli.shell; + +import static java.util.concurrent.TimeUnit.MINUTES; + +import java.io.File; +import java.io.IOException; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; + +import junitparams.JUnitParamsRunner; +import junitparams.Parameters; +import org.junit.Assume; +import org.junit.BeforeClass; +import org.junit.ClassRule; +import org.junit.Rule; +import org.junit.Test; +import org.junit.experimental.categories.Category; +import org.junit.runner.RunWith; + +import org.apache.geode.internal.AvailablePort; +import org.apache.geode.internal.ExitCode; +import org.apache.geode.internal.process.PidFile; +import org.apache.geode.management.internal.cli.util.CommandStringBuilder; +import org.apache.geode.management.internal.cli.util.ThreePhraseGenerator; +import org.apache.geode.test.junit.categories.AcceptanceTest; +import org.apache.geode.test.junit.rules.gfsh.GfshExecution; +import org.apache.geode.test.junit.rules.gfsh.GfshRule; +import org.apache.geode.test.junit.rules.gfsh.GfshScript; + +/** + * See also org.apache.geode.management.internal.cli.shell.StatusServerExitCodeAcceptanceTest + */ +@Category(AcceptanceTest.class) +public class StatusLocatorExitCodeAcceptanceTest { + private static File toolsJar; + private static final ThreePhraseGenerator nameGenerator = new ThreePhraseGenerator(); + private static final String memberControllerName = "member-controller"; + + @ClassRule + public static GfshRule gfsh = new GfshRule(); + private static String locatorName; + + private static int locatorPort; + + @BeforeClass + public static void classSetup() { + File javaHome = new File(System.getProperty("java.home")); + String toolsPath = + javaHome.getName().equalsIgnoreCase("jre") ? "../lib/tools.jar" : "lib/tools.jar"; + toolsJar = new File(javaHome, toolsPath); + + locatorName = "locator-" + nameGenerator.generate('-'); + locatorPort = AvailablePort.getRandomAvailablePort(AvailablePort.SOCKET); + + GfshExecution exec = GfshScript.of(startLocatorCommand()).withName(memberControllerName) + .awaitAtMost(4, MINUTES).execute(gfsh); + if (exec.getProcess().exitValue() != 0) { + throw new RuntimeException( + "The locator and server launcher exited with non-zero exit code. This failure is beyond the scope of this test."); + } + } + + @Test + public void statusCommandWithInvalidPortShouldFail() { + String commandWithBadPort = "status locator --port=-10"; + GfshScript.of(commandWithBadPort).withName("test-frame").awaitAtMost(1, MINUTES) + .expectExitCode(ExitCode.FATAL.getValue()).execute(gfsh); + } + + @Test + public void statusCommandWithInvalidOptionValueShouldFail() { + String commandWithBadPid = "status locator --pid=-1"; + GfshScript.of(commandWithBadPid).withName("test-frame").awaitAtMost(1, MINUTES) + .expectExitCode(ExitCode.FATAL.getValue()).execute(gfsh); + } + + @Test + public void statusCommandWithIncorrectHostShouldFail() { + String commandWithWrongHostname = "status locator --host=someIncorrectHostname"; + GfshScript.of(commandWithWrongHostname).withName("test-frame").awaitAtMost(1, MINUTES) + .expectExitCode(ExitCode.FATAL.getValue()).execute(gfsh); + } + + @Test + public void statusCommandWithIncorrectPortShouldFail() { + int incorrectPort = AvailablePort.getRandomAvailablePort(AvailablePort.SOCKET); + String cmd = "status locator --port=" + incorrectPort; + GfshScript.of(cmd).withName("test-frame").awaitAtMost(1, MINUTES) + .expectExitCode(ExitCode.FATAL.getValue()).execute(gfsh); + } + + @Test + public void statusCommandWithIncorrectDirShouldFail() { + String cmd = "status locator --dir=."; + GfshScript.of(cmd).withName("test-frame").awaitAtMost(1, MINUTES) + .expectExitCode(ExitCode.FATAL.getValue()).execute(gfsh); + } + + @Test + public void statusCommandWithIncorrectNameShouldFail() { + String cmd = "status locator --name=anInvalidMemberName"; + GfshScript.of(cmd).withName("test-frame").awaitAtMost(1, MINUTES) + .expectExitCode(ExitCode.FATAL.getValue()).execute(gfsh); + } + + @Test + public void onlineStatusCommandShouldSucceedWhenConnected_locator_name() { + String statusCommand = statusLocatorCommandByName(); + executeScriptWithExpectedExitCode(true, statusCommand, ExitCode.NORMAL); + } + + @Test + public void onlineStatusCommandShouldSucceedWhenConnected_locator_port() { + String statusCommand = statusLocatorCommandByPort(); + executeScriptWithExpectedExitCode(true, statusCommand, ExitCode.NORMAL); + } + + @Test + public void onlineStatusCommandShouldSucceedWhenConnected_locator_host_and_port() { + String statusCommand = statusLocatorCommandByHostAndPort(); + executeScriptWithExpectedExitCode(true, statusCommand, ExitCode.NORMAL); + } + + @Test + public void onlineStatusCommandShouldFailWhenConnectedNonDefaultPort_locator_host() { + String statusCommand = statusLocatorCommandByHost(); + executeScriptWithExpectedExitCode(true, statusCommand, ExitCode.FATAL); + } + + @Test + public void offlineStatusCommandShouldSucceedWhenConnected_locator_dir() { + String statusCommand = statusLocatorCommandByDir(); + executeScriptWithExpectedExitCode(true, statusCommand, ExitCode.NORMAL); + } + + @Test + public void onlineStatusCommandShouldFailWhenNotConnected_locator_name() { + String statusCommand = statusLocatorCommandByName(); + executeScriptWithExpectedExitCode(false, statusCommand, ExitCode.FATAL); + } + + @Test + public void offlineStatusCommandShouldSucceedWhenNotConnected_locator_port() { + // --host defaults to localhost, so `status locator --port=xxx` should still succeed. + String statusCommand = statusLocatorCommandByPort(); + executeScriptWithExpectedExitCode(false, statusCommand, ExitCode.NORMAL); + } + + @Test + public void offlineStatusCommandShouldSucceedWhenConnected_locator_pid() throws IOException { + Assume.assumeTrue(toolsJar.exists()); + String statusCommand = statusLocatorCommandByPid(); + executeScriptWithExpectedExitCode(true, statusCommand, ExitCode.NORMAL); + } + + @Test + public void offlineStatusCommandShouldSucceedWhenNotConnected_locator_host_and_port() { + // Since this is still local to the testing VM's machine, `status locator --host=localhost + // --port=xxx` should succeed + + String statusCommand = statusLocatorCommandByHostAndPort(); + executeScriptWithExpectedExitCode(false, statusCommand, ExitCode.NORMAL); + } + + + @Test + public void offlineStatusCommandShouldSucceedEvenWhenNotConnected_locator_dir() { + String statusCommand = statusLocatorCommandByDir(); + executeScriptWithExpectedExitCode(false, statusCommand, ExitCode.NORMAL); + } + + @Test + public void offlineStatusCommandShouldSucceedEvenWhenNotConnected_locator_pid() + throws IOException { + Assume.assumeTrue(toolsJar.exists()); + + String statusCommand = statusLocatorCommandByPid(); + executeScriptWithExpectedExitCode(false, statusCommand, ExitCode.NORMAL); + } + + + private static String startLocatorCommand() { + return new CommandStringBuilder("start locator").addOption("name", locatorName) + .addOption("port", String.valueOf(locatorPort)).toString(); + } + + private String statusLocatorCommandByName() { + return new CommandStringBuilder("status locator").addOption("name", locatorName).toString(); + } + + private String statusLocatorCommandByPort() { + return new CommandStringBuilder("status locator").addOption("port", String.valueOf(locatorPort)) + .toString(); + } + + private String statusLocatorCommandByHostAndPort() { + return new CommandStringBuilder("status locator").addOption("host", "localhost") + .addOption("port", String.valueOf(locatorPort)).toString(); + } + + private String statusLocatorCommandByHost() { + return new CommandStringBuilder("status locator").addOption("host", "localhost").toString(); + } + + private String statusLocatorCommandByDir() { + String locatorDir = gfsh.getTemporaryFolder().getRoot().toPath().resolve(memberControllerName) + .resolve(locatorName).toAbsolutePath().toString(); + return new CommandStringBuilder("status locator").addOption("dir", locatorDir).toString(); + } + + + private String statusLocatorCommandByPid() throws IOException { + int locatorPid = snoopMemberFile(locatorName, "locator.pid"); + return new CommandStringBuilder("status locator").addOption("pid", String.valueOf(locatorPid)) + .toString(); + } + + private String connectCommand() { + return new CommandStringBuilder("connect") + .addOption("locator", String.format("localhost[%d]", locatorPort)).toString(); + } + + private int snoopMemberFile(String memberName, String pidFileEndsWith) throws IOException { + File directory = gfsh.getTemporaryFolder().getRoot().toPath().resolve(memberControllerName) + .resolve(memberName).toFile(); + File[] files = directory.listFiles(); + if (files == null) { + throw new RuntimeException(String.format( + "Expected directory ('%s') for member '%s' either does not denote a directory, or an I/O error occurred.", + directory.toString(), memberName)); + } + File pidFile = Arrays.stream(files).filter(file -> file.getName().endsWith(pidFileEndsWith)) + .findFirst().orElseThrow(() -> new RuntimeException(String + .format("Expected member '%s' to have pid file but could not find it.", memberName))); + return new PidFile(pidFile).readPid(); + } + + private void executeScriptWithExpectedExitCode(boolean connectToLocator, String statusCommand, + ExitCode expectedExit) { + + String[] gfshScriptCommands = connectToLocator ? new String[] {connectCommand(), statusCommand} + : new String[] {statusCommand}; + GfshScript gfshScript = GfshScript.of(gfshScriptCommands).withName("test-frame") + .awaitAtMost(1, MINUTES).expectExitCode(expectedExit.getValue()); + if (toolsJar.exists()) { + gfshScript.addToClasspath(toolsJar.getAbsolutePath()); + } + gfshScript.execute(gfsh); + } + +} diff --git a/geode-assembly/src/test/java/org/apache/geode/management/internal/cli/shell/StatusServerExitCodeAcceptanceTest.java b/geode-assembly/src/test/java/org/apache/geode/management/internal/cli/shell/StatusServerExitCodeAcceptanceTest.java new file mode 100755 index 0000000000..17d75e6b9c --- /dev/null +++ b/geode-assembly/src/test/java/org/apache/geode/management/internal/cli/shell/StatusServerExitCodeAcceptanceTest.java @@ -0,0 +1,207 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more contributor license + * agreements. See the NOTICE file distributed with this work for additional information regarding + * copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance with the License. You may obtain a + * copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software distributed under the License + * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express + * or implied. See the License for the specific language governing permissions and limitations under + * the License. + */ +package org.apache.geode.management.internal.cli.shell; + +import static java.util.concurrent.TimeUnit.MINUTES; + +import java.io.File; +import java.io.IOException; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; + +import junitparams.JUnitParamsRunner; +import junitparams.Parameters; +import org.junit.Assume; +import org.junit.BeforeClass; +import org.junit.ClassRule; +import org.junit.Test; +import org.junit.experimental.categories.Category; +import org.junit.runner.RunWith; + +import org.apache.geode.internal.AvailablePort; +import org.apache.geode.internal.ExitCode; +import org.apache.geode.internal.process.PidFile; +import org.apache.geode.management.internal.cli.util.CommandStringBuilder; +import org.apache.geode.management.internal.cli.util.ThreePhraseGenerator; +import org.apache.geode.test.junit.categories.AcceptanceTest; +import org.apache.geode.test.junit.rules.gfsh.GfshExecution; +import org.apache.geode.test.junit.rules.gfsh.GfshRule; +import org.apache.geode.test.junit.rules.gfsh.GfshScript; + +// Originally created in response to GEODE-2971 + +/** + * See also org.apache.geode.management.internal.cli.shell.StatusLocatorExitCodeAcceptanceTest + */ +@Category(AcceptanceTest.class) +public class StatusServerExitCodeAcceptanceTest { + private static File toolsJar; + private static final ThreePhraseGenerator nameGenerator = new ThreePhraseGenerator(); + private static final String memberControllerName = "member-controller"; + + @ClassRule + public static GfshRule gfsh = new GfshRule(); + private static String locatorName; + private static String serverName; + + private static int locatorPort; + + @BeforeClass + public static void classSetup() { + File javaHome = new File(System.getProperty("java.home")); + String toolsPath = + javaHome.getName().equalsIgnoreCase("jre") ? "../lib/tools.jar" : "lib/tools.jar"; + toolsJar = new File(javaHome, toolsPath); + + locatorName = "locator-" + nameGenerator.generate('-'); + serverName = "server-" + nameGenerator.generate('-'); + locatorPort = AvailablePort.getRandomAvailablePort(AvailablePort.SOCKET); + + GfshExecution exec = GfshScript.of(startLocatorCommand(), startServerCommand()) + .withName(memberControllerName).awaitAtMost(2, MINUTES).execute(gfsh); + if (exec.getProcess().exitValue() != 0) { + throw new RuntimeException( + "The locator and server launcher exited with non-zero exit code. This failure is beyond the scope of this test."); + } + } + + @Test + public void statusCommandWithInvalidOptionValueShouldFail() { + String commandWithBadPid = "status server --pid=-1"; + GfshScript.of(commandWithBadPid).withName("test-frame").awaitAtMost(1, MINUTES) + .expectExitCode(ExitCode.FATAL.getValue()).execute(gfsh); + } + + + @Test + public void statusCommandWithIncorrectDirShouldFail() { + String commandWithWrongDir = "status server --dir=."; + GfshScript.of(commandWithWrongDir).withName("test-frame").awaitAtMost(1, MINUTES) + .expectExitCode(ExitCode.FATAL.getValue()).execute(gfsh); + } + + @Test + public void statusCommandWithIncorrectNameShouldFail() { + String commandWithWrongName = "status server --name=some-server-name"; + GfshScript.of(commandWithWrongName).withName("test-frame").awaitAtMost(1, MINUTES) + .expectExitCode(ExitCode.FATAL.getValue()).execute(gfsh); + } + + @Test + public void statusCommandWithIncorrectPidShouldFail() { + String commandWithWrongPid = "status server --pid=100"; + GfshScript.of(commandWithWrongPid).withName("test-frame").awaitAtMost(1, MINUTES) + .expectExitCode(ExitCode.FATAL.getValue()).execute(gfsh); + } + + @Test + public void onlineStatusCommandShouldFailWhenNotConnected_server_name() { + String statusCommand = statusServerCommandByName(); + executeScriptWithExpectedExitCode(false, statusCommand, ExitCode.FATAL); + } + + @Test + public void onlineStatusCommandShouldSucceedWhenConnected_server_name() { + String statusCommand = statusServerCommandByName(); + executeScriptWithExpectedExitCode(true, statusCommand, ExitCode.NORMAL); + } + + @Test + public void offlineStatusCommandShouldSucceedWhenConnected_server_dir() { + String statusCommand = statusServerCommandByDir(); + executeScriptWithExpectedExitCode(true, statusCommand, ExitCode.NORMAL); + } + + @Test + public void offlineStatusCommandShouldSucceedWhenConnected_server_pid() throws IOException { + Assume.assumeTrue(toolsJar.exists()); + String statusCommand = statusServerCommandByPid(); + executeScriptWithExpectedExitCode(true, statusCommand, ExitCode.NORMAL); + } + + @Test + public void offlineStatusCommandShouldSucceedEvenWhenNotConnected_server_dir() { + + String statusCommand = statusServerCommandByDir(); + executeScriptWithExpectedExitCode(false, statusCommand, ExitCode.NORMAL); + } + + @Test + public void offlineStatusCommandShouldSucceedEvenWhenNotConnected_server_pid() + throws IOException { + Assume.assumeTrue(toolsJar.exists()); + String statusCommand = statusServerCommandByPid(); + executeScriptWithExpectedExitCode(false, statusCommand, ExitCode.NORMAL); + } + + private static String startLocatorCommand() { + return new CommandStringBuilder("start locator").addOption("name", locatorName) + .addOption("port", String.valueOf(locatorPort)).toString(); + } + + private static String startServerCommand() { + return new CommandStringBuilder("start server").addOption("name", serverName).toString(); + } + + private String statusServerCommandByName() { + return new CommandStringBuilder("status server").addOption("name", serverName).toString(); + } + + private String statusServerCommandByDir() { + String serverDir = gfsh.getTemporaryFolder().getRoot().toPath().resolve(memberControllerName) + .resolve(serverName).toAbsolutePath().toString(); + return new CommandStringBuilder("status server").addOption("dir", serverDir).toString(); + } + + private String statusServerCommandByPid() throws IOException { + int serverPid = snoopMemberFile(serverName, "server.pid"); + return new CommandStringBuilder("status server").addOption("pid", String.valueOf(serverPid)) + .toString(); + } + + private String connectCommand() { + return new CommandStringBuilder("connect") + .addOption("locator", String.format("localhost[%d]", locatorPort)).toString(); + } + + private int snoopMemberFile(String memberName, String pidFileEndsWith) throws IOException { + File directory = gfsh.getTemporaryFolder().getRoot().toPath().resolve(memberControllerName) + .resolve(memberName).toFile(); + File[] files = directory.listFiles(); + if (files == null) { + throw new RuntimeException(String.format( + "Expected directory ('%s') for member '%s' either does not denote a directory, or an I/O error occurred.", + directory.toString(), memberName)); + } + File pidFile = Arrays.stream(files).filter(file -> file.getName().endsWith(pidFileEndsWith)) + .findFirst().orElseThrow(() -> new RuntimeException(String + .format("Expected member '%s' to have pid file but could not find it.", memberName))); + return new PidFile(pidFile).readPid(); + } + + private void executeScriptWithExpectedExitCode(boolean connectToLocator, String statusCommand, + ExitCode expectedExit) { + + String[] gfshScriptCommands = connectToLocator ? new String[] {connectCommand(), statusCommand} + : new String[] {statusCommand}; + GfshScript gfshScript = GfshScript.of(gfshScriptCommands).withName("test-frame") + .awaitAtMost(1, MINUTES).expectExitCode(expectedExit.getValue()); + if (toolsJar.exists()) { + gfshScript.addToClasspath(toolsJar.getAbsolutePath()); + } + gfshScript.execute(gfsh); + } +} ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: users@infra.apache.org > Expand GfshExitCodeStatusCommandTest into multiple classes for more meaningful failure reporting > ------------------------------------------------------------------------------------------------ > > Key: GEODE-4052 > URL: https://issues.apache.org/jira/browse/GEODE-4052 > Project: Geode > Issue Type: Test > Components: gfsh, tests > Reporter: Patrick Rhomberg > Assignee: Patrick Rhomberg > > Occasionally, the majority of this class's tests will fail due to being unable to start the cluster. Such a failure is beyond the scope of the test and should be reported quickly. > This class should be divided into two classes, one containing those tests that require the cluster's server to be running and one that does not. The cluster start-up in both cases should be delegated to a {{@BeforeClass}} method so that failure occurs as the class level and is quickly recognizable. -- This message was sent by Atlassian JIRA (v6.4.14#64029)