Mailing-List: contact dev-help@geode.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@geode.apache.org
From: kirklund <git@git.apache.org>
To: dev@geode.apache.org
Reply-To: dev@geode.apache.org
References: <git-pr-652-geode@git.apache.org>
In-Reply-To: <git-pr-652-geode@git.apache.org>
Subject: [GitHub] geode pull request #652: Geode-2971: Introduce ExitCode to resolve inconsist...
Content-Type: text/plain
Message-Id: <20170726223857.61E74DFF36@git1-us-west.apache.org>
Date: Wed, 26 Jul 2017 22:38:57 +0000 (UTC)
archived-at: Wed, 26 Jul 2017 22:39:00 -0000

Github user kirklund commented on a diff in the pull request:

    https://github.com/apache/geode/pull/652#discussion_r129713345
  
    --- Diff: geode-assembly/src/test/java/org/apache/geode/management/internal/cli/shell/GfshExitCodeStatusCommandsDUnitTest.java ---
    @@ -0,0 +1,396 @@
    +/*
    + * 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 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.dunit.rules.gfsh.GfshExecution;
    +import org.apache.geode.test.dunit.rules.gfsh.GfshRule;
    +import org.apache.geode.test.dunit.rules.gfsh.GfshScript;
    +import org.apache.geode.test.junit.categories.AcceptanceTest;
    +
    +// Originally created in response to GEODE-2971
    +
    +@Category(AcceptanceTest.class)
    +@RunWith(JUnitParamsRunner.class)
    +public class GfshExitCodeStatusCommandsDUnitTest {
    +  private static File toolsJar;
    +  private final static ThreePhraseGenerator nameGenerator = new ThreePhraseGenerator();
    +  private final static String memberControllerName = "member-controller";
    +
    +  @Rule
    +  public GfshRule gfsh = new GfshRule();
    +  private String locatorName;
    +  private String serverName;
    +
    +  private int locatorPort;
    +
    +  // Some test configuration shorthands
    +  private TestConfiguration LOCATOR_ONLINE_BUT_NOT_CONNECTED =
    +      new TestConfiguration(true, false, false);
    +  private TestConfiguration LOCATOR_ONLINE_AND_CONNECTED = new TestConfiguration(true, false, true);
    +  private TestConfiguration BOTH_ONLINE_BUT_NOT_CONNECTED =
    +      new TestConfiguration(true, true, false);
    +  private 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=-1", "status server --pid=-1"})
    +  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();
    +
    +    String statusCommand = statusLocatorCommandByName();
    +    executeScriptWithExpectedExitCode(statusCommand, config, ExitCode.FATAL);
    +  }
    +
    +
    +  @Test
    +  public void onlineStatusCommandShouldFailWhenNotConnected_server_name() {
    +    TestConfiguration config = BOTH_ONLINE_BUT_NOT_CONNECTED;
    +    config.startNecessaryMembers();
    +
    +    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();
    +
    +    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();
    +
    +    String statusCommand = statusLocatorCommandByHostAndPort();
    +    executeScriptWithExpectedExitCode(statusCommand, config, ExitCode.NORMAL);
    +  }
    +
    +
    +
    +  @Test
    +  public void onlineStatusCommandShouldSucceedWhenConnected_locator_name() {
    +    TestConfiguration config = LOCATOR_ONLINE_AND_CONNECTED;
    +    config.startNecessaryMembers();
    +
    +    String statusCommand = statusLocatorCommandByName();
    +    executeScriptWithExpectedExitCode(statusCommand, config, ExitCode.NORMAL);
    +  }
    +
    +
    +  @Test
    +  public void onlineStatusCommandShouldSucceedWhenConnected_server_name() {
    +    TestConfiguration config = BOTH_ONLINE_AND_CONNECTED;
    +    config.startNecessaryMembers();
    +
    +    String statusCommand = statusServerCommandByName();
    +    executeScriptWithExpectedExitCode(statusCommand, config, ExitCode.NORMAL);
    +  }
    +
    +  @Test
    +  public void onlineStatusCommandShouldSucceedWhenConnected_locator_port() {
    +    TestConfiguration config = LOCATOR_ONLINE_AND_CONNECTED;
    +    config.startNecessaryMembers();
    +
    +    String statusCommand = statusLocatorCommandByPort();
    +    executeScriptWithExpectedExitCode(statusCommand, config, ExitCode.NORMAL);
    +  }
    +
    +  @Test
    +  public void onlineStatusCommandShouldSucceedWhenConnected_locator_host_and_port() {
    +    TestConfiguration config = LOCATOR_ONLINE_AND_CONNECTED;
    +    config.startNecessaryMembers();
    +
    +    String statusCommand = statusLocatorCommandByHostAndPort();
    +    executeScriptWithExpectedExitCode(statusCommand, config, ExitCode.NORMAL);
    +  }
    +
    +
    +
    +  @Test
    +  public void offlineStatusCommandShouldSucceedWhenConnected_locator_dir() {
    +    TestConfiguration config = LOCATOR_ONLINE_AND_CONNECTED;
    +    config.startNecessaryMembers();
    +
    +    String statusCommand = statusLocatorCommandByDir();
    +    executeScriptWithExpectedExitCode(statusCommand, config, ExitCode.NORMAL);
    +  }
    +
    +  @Test
    +  public void offlineStatusCommandShouldSucceedWhenConnected_server_dir() {
    +    TestConfiguration config = BOTH_ONLINE_AND_CONNECTED;
    +    config.startNecessaryMembers();
    +
    +    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();
    +
    +    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();
    +
    +    String statusCommand = statusServerCommandByPid();
    +    executeScriptWithExpectedExitCode(statusCommand, config, ExitCode.NORMAL);
    +  }
    +
    +
    +
    +  @Test
    +  public void offlineStatusCommandShouldSucceedEvenWhenNotConnected_locator_dir() {
    +    TestConfiguration config = LOCATOR_ONLINE_BUT_NOT_CONNECTED;
    +    config.startNecessaryMembers();
    +
    +    String statusCommand = statusLocatorCommandByDir();
    +    executeScriptWithExpectedExitCode(statusCommand, config, ExitCode.NORMAL);
    +  }
    +
    +  @Test
    +  public void offlineStatusCommandShouldSucceedEvenWhenNotConnected_server_dir() {
    +    TestConfiguration config = BOTH_ONLINE_BUT_NOT_CONNECTED;
    +    config.startNecessaryMembers();
    +
    +    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();
    +
    +    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();
    +
    +    String statusCommand = statusServerCommandByPid();
    +    executeScriptWithExpectedExitCode(statusCommand, config, ExitCode.NORMAL);
    +  }
    +
    +
    +
    +  // TODO PSRhomberg -- Input requested: Would these read better inlined into the respective tests?
    +  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 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.addConnectCommandIfNecessary(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);
    +  }
    +
    +
    +  public class TestConfiguration {
    --- End diff --
    
    Recommend making this static unless the inner-class actually needs an instance to the outer class:
    ```java
    public static class TestConfiguration
    ```
    Non-static inner-classes have an implicit reference to the outer class instance.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---