aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/test/java/com/google/devtools/build/lib/worker/ErrorMessageTest.java
blob: 4607b22e740a2c68c7e6255f1c5a3d5d3ceee27f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
// Copyright 2017 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.worker;

import static com.google.common.truth.Truth.assertThat;
import static java.nio.charset.StandardCharsets.UTF_8;

import com.google.devtools.build.lib.util.OS;
import com.google.devtools.build.lib.vfs.FileSystemUtils;
import com.google.devtools.build.lib.vfs.Path;
import com.google.devtools.build.lib.vfs.inmemoryfs.InMemoryFileSystem;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;

/** Tests for {@link ErrorMessage}. */
@RunWith(JUnit4.class)
public class ErrorMessageTest {
  String logText = "\n\nabcdefghijklmnopqrstuvwxyz\n\n";

  @Test
  public void testEmptyErrorMessage() {
    ErrorMessage errorMessage = ErrorMessage.builder().build();
    assertThat(errorMessage.toString()).isEqualTo("Unknown error");
  }

  @Test
  public void testSimpleErrorMessage() {
    ErrorMessage errorMessage = ErrorMessage.builder().message("Error").build();
    assertThat(errorMessage.toString()).isEqualTo("Error");
  }

  @Test
  public void testErrorMessageWithLogText() {
    ErrorMessage errorMessage =
        ErrorMessage.builder().message("Error with log text").logText(logText).build();
    assertThat(errorMessage.toString())
        .isEqualTo(
            "Error with log text\n\n"
                + "---8<---8<--- Start of log ---8<---8<---\n"
                + "abcdefghijklmnopqrstuvwxyz\n"
                + "---8<---8<--- End of log ---8<---8<---");
  }

  @Test
  public void testErrorMessageWithEmptyLogText() {
    ErrorMessage errorMessage =
        ErrorMessage.builder().message("Error with log text").logText("").build();
    assertThat(errorMessage.toString())
        .isEqualTo(
            "Error with log text\n\n"
                + "---8<---8<--- Start of log ---8<---8<---\n"
                + "(empty)\n"
                + "---8<---8<--- End of log ---8<---8<---");
  }

  @Test
  public void testErrorMessageWithTruncatedLogText() {
    ErrorMessage errorMessage =
        ErrorMessage.builder()
            .message("Error with log text")
            .logText(logText)
            .logSizeLimit(13)
            .build();
    assertThat(errorMessage.toString())
        .isEqualTo(
            "Error with log text\n\n"
                + "---8<---8<--- Start of log snippet ---8<---8<---\n"
                + "[... truncated ...]\n"
                + "nopqrstuvwxyz\n"
                + "---8<---8<--- End of log snippet, 13 chars omitted ---8<---8<---");
  }

  @Test
  public void testErrorMessageWithLogFile() throws Exception {
    InMemoryFileSystem fs = new InMemoryFileSystem();
    Path logFile = fs.getPath("/log.txt");
    FileSystemUtils.writeContent(logFile, UTF_8, logText);
    ErrorMessage errorMessage =
        ErrorMessage.builder().message("Error with log file").logFile(logFile).build();
    assertThat(errorMessage.toString())
        .isEqualTo(
            "Error with log file\n\n"
                + "---8<---8<--- Start of log, file at /log.txt ---8<---8<---\n"
                + "abcdefghijklmnopqrstuvwxyz\n"
                + "---8<---8<--- End of log ---8<---8<---");
  }

  @Test
  public void testErrorMessageWithUnreadableLogFile() {
    if (OS.getCurrent() == OS.WINDOWS) {
      // TODO(#3536): This test is failing on Windows, probably due to line breaks. Fix it!
      return;
    }
    InMemoryFileSystem fs = new InMemoryFileSystem();
    // This file does not exist.
    Path logFile = fs.getPath("/nope.txt");
    ErrorMessage errorMessage =
        ErrorMessage.builder().message("Error with log file").logFile(logFile).build();
    assertThat(errorMessage.toString())
        .startsWith(
            "Error with log file\n\n"
                + "---8<---8<--- Start of log, file at /nope.txt ---8<---8<---\n"
                + "ERROR: IOException while trying to read log file:\n"
                + "java.io.FileNotFoundException: /nope.txt (No such file or directory)\n");
    assertThat(errorMessage.toString()).endsWith("---8<---8<--- End of log ---8<---8<---");
  }

  @Test
  public void testErrorMessageWithException() {
    ErrorMessage errorMessage =
        ErrorMessage.builder()
            .message("An exception occurred.")
            .exception(new IllegalStateException("Hello World"))
            .build();
    assertThat(errorMessage.toString())
        .startsWith(
            "An exception occurred.\n\n"
                + "---8<---8<--- Exception details ---8<---8<---\n"
                + "java.lang.IllegalStateException: Hello World");
  }
}