src/test/java/com/google/devtools/build/lib/util/CommandUtilsTest.java

// Copyright 2014 The Bazel Authors. All rights reserved.
//
// Licensed 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 com.google.devtools.build.lib.util;

import static com.google.common.truth.Truth.assertThat;
import static org.junit.Assert.assertThrows;

import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Maps;
import com.google.devtools.build.lib.shell.Command;
import com.google.devtools.build.lib.shell.CommandException;
import java.util.Map;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;

@RunWith(JUnit4.class)
public class CommandUtilsTest {

  @Test
  public void longCommand() throws Exception {
    DescribableExecutionUnit unit = unitWithLongCommandLine();
    String message =
        CommandFailureUtils.describeCommandFailure(
            /* verboseFailures= */ false, /* expandParamFiles= */ false, "/path/to/cwd", unit);
    assertThat(message)
        .isEqualTo(
            "this_command_will_not_be_found failed: "
                + "error executing Mnemonic command this_command_will_not_be_found arg1 "
                + "arg2 arg3 arg4 arg5 arg6 arg7 arg8 arg9 arg10 "
                + "arg11 arg12 arg13 arg14 arg15 arg16 arg17 arg18 "
                + "arg19 arg20 arg21 arg22 arg23 arg24 arg25 arg26 "
                + "arg27 arg28 arg29 arg30 "
                + "... (remaining 9 arguments skipped)");
  }

  @Test
  public void longCommand_verbose() throws Exception {
    DescribableExecutionUnit command = unitWithLongCommandLine();
    String verboseMessage =
        CommandFailureUtils.describeCommandFailure(
            /* verboseFailures= */ true, /* expandParamFiles= */ false, "/path/to/cwd", command);
    assertThat(verboseMessage)
        .isEqualTo(
            "this_command_will_not_be_found failed: error executing Mnemonic command \n"
                + "  (cd /path/to/cwd && \\\n"
                + "  exec env - \\\n"
                + "    FOO=foo \\\n"
                + "    PATH=/usr/bin:/bin:/sbin \\\n"
                + "  this_command_will_not_be_found arg1 "
                + "arg2 arg3 arg4 arg5 arg6 arg7 arg8 arg9 arg10 "
                + "arg11 arg12 arg13 arg14 arg15 arg16 arg17 arg18 "
                + "arg19 arg20 arg21 arg22 arg23 arg24 arg25 arg26 "
                + "arg27 arg28 arg29 arg30 arg31 arg32 arg33 arg34 "
                + "arg35 arg36 arg37 arg38 arg39)");
  }

  @Test
  public void failingCommand() throws Exception {
    var args =
        ImmutableList.of("/bin/sh", "-c", "echo Some errors 1>&2; echo Some output; exit 42");
    Map<String, String> env = Maps.newTreeMap();
    env.put("FOO", "foo");
    env.put("PATH", "/usr/bin:/bin:/sbin");
    CommandException exception =
        assertThrows(
            CommandException.class, () -> new Command(args, env, null, System.getenv()).execute());
    String message =
        CommandUtils.describeCommandFailure(
            /* verbose= */ false, /* expandParamFiles= */ false, exception);
    String verboseMessage =
        CommandUtils.describeCommandFailure(
            /* verbose= */ true, /* expandParamFiles= */ false, exception);
    assertThat(message)
        .isEqualTo(
            "sh failed: error executing <shell command> command "
                + "/bin/sh -c 'echo Some errors 1>&2; echo Some output; exit 42': "
                + "Process exited with status 42\n"
                + "Some output\n"
                + "Some errors\n");
    assertThat(verboseMessage)
        .isEqualTo(
            "sh failed: error executing <shell command> command \n"
                + "  (exec env - \\\n"
                + "    FOO=foo \\\n"
                + "    PATH=/usr/bin:/bin:/sbin \\\n"
                + "  /bin/sh -c 'echo Some errors 1>&2; echo Some output; exit 42'): "
                + "Process exited with status 42\n"
                + "Some output\n"
                + "Some errors\n");
  }

  @Test
  public void describeCommandFailure_expandParamFiles() throws Exception {
    DescribableExecutionUnit unit =
        unit(
            ImmutableList.of("this_command_will_not_be_found", "@argfile"),
            ImmutableList.of("this_command_will_not_be_found", "arg1", "arg2"),
            ImmutableMap.of(),
            "Mnemonic");
    String message =
        CommandFailureUtils.describeCommandFailure(
            /* verboseFailures= */ false, /* expandParamFiles= */ true, /* cwd= */ null, unit);
    assertThat(message)
        .isEqualTo(
            "this_command_will_not_be_found failed: error executing Mnemonic command"
                + " this_command_will_not_be_found arg1 arg2");
  }

  private static DescribableExecutionUnit unitWithLongCommandLine() {
    ImmutableList.Builder<String> args = ImmutableList.builder();
    args.add("this_command_will_not_be_found");
    for (int i = 1; i < 40; i++) {
      args.add("arg" + i);
    }
    ImmutableMap<String, String> env =
        ImmutableMap.of(
            "PATH", "/usr/bin:/bin:/sbin",
            "FOO", "foo");
    return unit(args.build(), args.build(), env, "Mnemonic");
  }

  private static DescribableExecutionUnit unit(
      ImmutableList<String> args,
      ImmutableList<String> argsWithExpandedParamFiles,
      ImmutableMap<String, String> env,
      String mnemonic) {
    return new DescribableExecutionUnit() {
      @Override
      public ImmutableList<String> getArguments() {
        return args;
      }

      @Override
      public ImmutableList<String> getArgumentsWithExpandedParamFiles() {
        return argsWithExpandedParamFiles;
      }

      @Override
      public ImmutableMap<String, String> getEnvironment() {
        return env;
      }

      @Override
      public String getMnemonic() {
        return mnemonic;
      }
    };
  }
}