geode-core/src/test/java/org/apache/geode/management/internal/cli/shell/GfshAbstractUnitTest.java

/*
 * 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 org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Mockito.spy;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;

import java.util.Enumeration;
import java.util.logging.LogManager;
import java.util.logging.Logger;

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

import org.apache.geode.management.internal.cli.result.CommandResult;


public class GfshAbstractUnitTest {
  protected Gfsh gfsh;
  protected String testString;

  @Before
  public void before() {
    testString = "This is a test string.";
  }

  @After
  public void after() {
    // This removes and cleans up the LogWrapper instance so that subsequent tests don't fail.
    removeLogWrapper();
  }

  void removeLogWrapper() {
    Logger rootLogger = LogManager.getLogManager().getLogger("");

    for (Enumeration<String> enumeration = LogManager.getLogManager().getLoggerNames(); enumeration
        .hasMoreElements();) {
      String loggerName = enumeration.nextElement();
      Logger logger = Logger.getLogger(loggerName);
      if (logger.getParent() != null && logger.getParent().getName().endsWith(".LogWrapper")) {
        logger.setParent(rootLogger);
      }
    }
  }

  @Test
  public void testWrapTest() {
    assertThat(Gfsh.wrapText(testString, 0, -1)).isEqualTo(testString);
    assertThat(Gfsh.wrapText(testString, 0, 0)).isEqualTo(testString);
    assertThat(Gfsh.wrapText(testString, 0, 1)).isEqualTo(testString);
    assertThat(Gfsh.wrapText(testString, 0, 10))
        .isEqualTo("This is a" + Gfsh.LINE_SEPARATOR + "test" + Gfsh.LINE_SEPARATOR + "string.");
    assertThat(Gfsh.wrapText(testString, 1, 100)).isEqualTo(Gfsh.LINE_INDENT + testString);
    assertThat(Gfsh.wrapText(testString, 2, 100))
        .isEqualTo(Gfsh.LINE_INDENT + Gfsh.LINE_INDENT + testString);
  }

  @Test
  public void wrapTextWithNoSpace() {
    assertThat(Gfsh.wrapText("for datasource", 0, 6))
        .isEqualTo("for" + Gfsh.LINE_SEPARATOR + "datas" + Gfsh.LINE_SEPARATOR + "ource");
    assertThat(Gfsh.wrapText("for data sour ", 0, 6))
        .isEqualTo("for" + Gfsh.LINE_SEPARATOR + "data" + Gfsh.LINE_SEPARATOR + "sour ");
    assertThat(Gfsh.wrapText("for data sour ", 0, 5)).isEqualTo(
        "for" + Gfsh.LINE_SEPARATOR + "data" + Gfsh.LINE_SEPARATOR + "sour" + Gfsh.LINE_SEPARATOR);
  }

  @Test
  public void getAppContextPath() {
    gfsh = new Gfsh();
    assertThat(gfsh.getEnvAppContextPath()).isEqualTo("");
    gfsh.setEnvProperty(Gfsh.ENV_APP_CONTEXT_PATH, "test");
    assertThat(gfsh.getEnvAppContextPath()).isEqualTo("test");
  }

  @Test
  public void executeCommandShouldSubstituteVariablesWhenNeededAndDelegateToDefaultImplementation() {
    gfsh = spy(Gfsh.class);
    org.springframework.shell.core.CommandResult commandResult;

    // No '$' character, should only delegate to default implementation.
    commandResult = gfsh.executeCommand("echo --string=ApacheGeode!");
    assertThat(commandResult.isSuccess()).isTrue();
    verify(gfsh, times(0)).expandProperties("echo --string=ApacheGeode!");
    assertThat(((CommandResult) commandResult.getResult()).asString().trim())
        .isEqualTo("ApacheGeode!");

    // '$' character present, should expand properties and delegate to default implementation.
    commandResult = gfsh.executeCommand("echo --string=SYS_USER:${SYS_USER}");
    assertThat(commandResult.isSuccess()).isTrue();
    verify(gfsh, times(1)).expandProperties("echo --string=SYS_USER:${SYS_USER}");
    assertThat(((CommandResult) commandResult.getResult()).asString().trim())
        .isEqualTo("SYS_USER:" + System.getProperty("user.name"));

    // '$' character present but not variable referenced, should try to expand, find nothing (no
    // replacement) and delegate to default implementation.
    commandResult = gfsh.executeCommand("echo --string=MyNameIs:$USER_NAME");
    assertThat(commandResult.isSuccess()).isTrue();
    verify(gfsh, times(1)).expandProperties("echo --string=MyNameIs:$USER_NAME");
    assertThat(((CommandResult) commandResult.getResult()).asString().trim())
        .isEqualTo("MyNameIs:$USER_NAME");
  }
}