/*
 * The Alluxio Open Foundation licenses this work under the Apache License, version 2.0
 * (the "License"). You may not use this work except in compliance with the License, which is
 * available at www.apache.org/licenses/LICENSE-2.0
 *
 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied, as more fully set forth in the License.
 *
 * See the NOTICE file distributed with this work for information regarding copyright ownership.
 */

package alluxio.client.cli.fs.command;

import alluxio.annotation.dora.DoraTestTodoItem;
import alluxio.cli.Command;
import alluxio.cli.fs.FileSystemShellUtils;
import alluxio.cli.fs.command.HelpCommand;
import alluxio.client.cli.fs.AbstractFileSystemShellTest;
import alluxio.client.file.FileSystemContext;
import alluxio.conf.Configuration;

import org.junit.Assert;
import org.junit.Ignore;
import org.junit.Test;

import java.io.IOException;
import java.io.PrintWriter;
import java.io.StringWriter;
import java.util.Map;
import java.util.SortedSet;
import java.util.TreeSet;

/**
 * Integration tests for help command.
 */
@DoraTestTodoItem(action = DoraTestTodoItem.Action.REMOVE, owner = "jiacheng",
    comment = "fix or remove this test")
@Ignore
public final class HelpCommandIntegrationTest extends AbstractFileSystemShellTest {

  /**
   * Tests help which given command doesn't exist.
   */
  @Test
  public void helpNotExist() throws IOException {
    Assert.assertEquals(-1, sFsShell.run("help", "notExistTestCommand"));
    String expected = "notExistTestCommand is an unknown command.\n";
    Assert.assertEquals(expected, mOutput.toString());
  }

  /**
   * Tests help command with given command which exists.
   */
  @Test
  public void help() throws IOException {
    Assert.assertEquals(0, sFsShell.run("help", "help"));
    HelpCommand cmd = new HelpCommand(FileSystemContext.create(Configuration.global()));
    StringWriter stringWriter = new StringWriter();
    PrintWriter printWriter = new PrintWriter(stringWriter);
    HelpCommand.printCommandInfo(cmd, printWriter);
    printWriter.close();
    String expected = stringWriter.toString();
    Assert.assertEquals(expected, mOutput.toString());
  }

  /**
   * Tests help command without given command.
   */
  @Test
  public void helpAllCommand() throws IOException {
    Assert.assertEquals(0, sFsShell.run("help"));
    final Map<String, Command> commands =
        FileSystemShellUtils.loadCommands(FileSystemContext.create(Configuration.global()));
    String expected = "";
    SortedSet<String> sortedCmds = new TreeSet<>(commands.keySet());
    for (String cmd : sortedCmds) {
      Command command = commands.get(cmd);
      StringWriter stringWriter = new StringWriter();
      PrintWriter printWriter = new PrintWriter(stringWriter);
      HelpCommand.printCommandInfo(command, printWriter);
      printWriter.close();
      expected += stringWriter.toString() + "\n";
    }
    Assert.assertEquals(expected, mOutput.toString());
  }

  /**
   * Tests help command with redundant args.
   */
  @Test
  public void helpRedundantArgs() throws IOException {
    Assert.assertEquals(-1, sFsShell.run("help", "Cat", "Chmod"));
  }
}
