src/test/java/com/google/devtools/build/lib/util/StringUtilTest.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 com.google.devtools.build.lib.util.StringUtil.joinEnglishList;
import static com.google.devtools.build.lib.util.StringUtil.joinEnglishListSingleQuoted;

import com.google.common.collect.ImmutableList;
import java.util.Arrays;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;

/** A test for {@link StringUtil}. */
@RunWith(JUnit4.class)
public class StringUtilTest {

  @Test
  public void testJoinEnglishList() throws Exception {
    assertThat(joinEnglishList(ImmutableList.of())).isEqualTo("nothing");
    assertThat(joinEnglishList(Arrays.asList("one"))).isEqualTo("one");
    assertThat(joinEnglishList(Arrays.asList("one", "two"))).isEqualTo("one or two");
    assertThat(joinEnglishList(Arrays.asList("one", "two"), "and")).isEqualTo("one and two");
    assertThat(joinEnglishList(Arrays.asList("one", "two", "three")))
        .isEqualTo("one, two, or three");
    assertThat(joinEnglishList(Arrays.asList("one", "two", "three"), "and"))
        .isEqualTo("one, two, and three");
    assertThat(joinEnglishList(Arrays.asList("one", "two", "three"), "or even", "\"", true))
        .isEqualTo("\"one\", \"two\", or even \"three\"");
    assertThat(joinEnglishList(Arrays.asList("one", "two", "three"), "then", "'", false))
        .isEqualTo("'one', 'two' then 'three'");
  }

  @Test
  public void testJoinEnglishListSingleQuoted() throws Exception {
    assertThat(joinEnglishListSingleQuoted(ImmutableList.of())).isEqualTo("nothing");
    assertThat(joinEnglishListSingleQuoted(Arrays.asList("one"))).isEqualTo("'one'");
    assertThat(joinEnglishListSingleQuoted(Arrays.asList("one", "two")))
        .isEqualTo("'one' or 'two'");
    assertThat(joinEnglishListSingleQuoted(Arrays.asList("one", "two", "three")))
        .isEqualTo("'one', 'two', or 'three'");
  }

  @Test
  public void listItemsWithLimit() throws Exception {
    assertThat(
            StringUtil.listItemsWithLimit(
                    new StringBuilder("begin/"), 3, ImmutableList.of("a", "b", "c"))
                .append("/end")
                .toString())
        .isEqualTo("begin/a, b, c/end");

    assertThat(
            StringUtil.listItemsWithLimit(
                    new StringBuilder("begin/"), 3, ImmutableList.of("a", "b", "c", "d", "e"))
                .append("/end")
                .toString())
        .isEqualTo("begin/a, b, c ...(omitting 2 more item(s))/end");
  }

  @Test
  public void testFormatNested_nullOrBlankChild() {
    assertThat(StringUtil.formatNested("prefix", null)).isEqualTo("prefix");
    assertThat(StringUtil.formatNested("prefix", "")).isEqualTo("prefix");
    assertThat(StringUtil.formatNested("prefix", "   ")).isEqualTo("prefix");
    assertThat(StringUtil.formatNested("prefix", "\t\n ")).isEqualTo("prefix");
  }

  @Test
  public void testFormatNested_singleLine() {
    assertThat(StringUtil.formatNested("error header", "something went wrong"))
        .isEqualTo("error header:\n  something went wrong");
  }

  @Test
  public void testFormatNested_trailingColonNormalization() {
    assertThat(StringUtil.formatNested("error header:", "something went wrong"))
        .isEqualTo("error header:\n  something went wrong");
    assertThat(StringUtil.formatNested("error header:   ", "something went wrong"))
        .isEqualTo("error header:\n  something went wrong");
  }

  @Test
  public void testFormatNested_multiLevel() {
    String leaf = "compilation failed";
    String mid = StringUtil.formatNested("at /path/b.bzl:10:5", leaf);
    String top = StringUtil.formatNested("at /path/a.bzl:20:8", mid);
    assertThat(top)
        .isEqualTo("at /path/a.bzl:20:8:\n  at /path/b.bzl:10:5:\n    compilation failed");
  }

  @Test
  public void testFormatNested_multiLineChild() {
    String multiLine = "syntax error on line 1\nsyntax error on line 2";
    assertThat(StringUtil.formatNested("error loading package 'foo'", multiLine))
        .isEqualTo(
            "error loading package 'foo':\n  syntax error on line 1\n  syntax error on line 2");
  }

  @Test
  public void testFormatNested_crlfChild() {
    String crlf = "line 1\r\nline 2\r\n";
    assertThat(StringUtil.formatNested("header", crlf)).isEqualTo("header:\n  line 1\n  line 2");
  }
}