aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/test/java/com/google/devtools/build/lib/analysis/actions/LauncherFileWriteActionTest.java
blob: e71a3952f46488f37ab5aa2ab84917de799e3a51 (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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
// 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.analysis.actions;

import static com.google.common.truth.Truth.assertThat;

import com.google.common.collect.ImmutableList;
import com.google.common.testing.NullPointerTester;
import com.google.devtools.build.lib.analysis.actions.LauncherFileWriteAction.LaunchInfo;
import java.io.ByteArrayOutputStream;
import java.nio.charset.StandardCharsets;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;

/** Unit tests for {@link LauncherFileWriteAction}. */
@RunWith(JUnit4.class)
public class LauncherFileWriteActionTest {

  @Test
  public void testAddKeyValuePair() throws Exception {
    LaunchInfo actual =
        LaunchInfo.builder()
            .addKeyValuePair("", "won't show up")
            .addKeyValuePair("foo", "bar")
            .addKeyValuePair("baz", null)
            .build();
    ByteArrayOutputStream expected = new ByteArrayOutputStream();
    expected.write("foo=bar\0".getBytes(StandardCharsets.UTF_8));
    expected.write("baz=\0".getBytes(StandardCharsets.UTF_8));
    assertOutput(actual, expected.toByteArray());
  }

  @Test
  public void testKeyValueFingerprint() throws Exception {
    // LaunchInfos with different entries should have different fingerprints.
    assertThat(LaunchInfo.builder().addKeyValuePair("foo", "bar").build().fingerPrint)
        .isNotEqualTo(LaunchInfo.builder().addKeyValuePair("bar", "foo").build().fingerPrint);

    // LaunchInfos with the same entries but in different order should have different fingerprints.
    assertThat(
            LaunchInfo.builder()
                .addKeyValuePair("foo", "bar")
                .addKeyValuePair("bar", "foo")
                .build()
                .fingerPrint)
        .isNotEqualTo(
            LaunchInfo.builder()
                .addKeyValuePair("bar", "foo")
                .addKeyValuePair("foo", "bar")
                .build()
                .fingerPrint);

    // Two identically-constructed LaunchInfos should have the same fingerprint.
    assertThat(
            LaunchInfo.builder()
                .addKeyValuePair("foo", "bar")
                .addKeyValuePair("bar", "foo")
                .build()
                .fingerPrint)
        .isEqualTo(
            LaunchInfo.builder()
                .addKeyValuePair("foo", "bar")
                .addKeyValuePair("bar", "foo")
                .build()
                .fingerPrint);
  }

  @Test
  public void testAddJoinedValues() throws Exception {
    LaunchInfo actual =
        LaunchInfo.builder()
            .addJoinedValues("foo", "", ImmutableList.of())
            .addJoinedValues("bar", "x", ImmutableList.of())
            .addJoinedValues("baz", ";", ImmutableList.of("aa"))
            .addJoinedValues("qux", ":", ImmutableList.of("aa", "bb", "cc"))
            .addJoinedValues("mex", "--", ImmutableList.of("aa", "bb", "cc"))
            .build();
    ByteArrayOutputStream expected = new ByteArrayOutputStream();
    expected.write("foo=\0".getBytes(StandardCharsets.UTF_8));
    expected.write("bar=\0".getBytes(StandardCharsets.UTF_8));
    expected.write("baz=aa\0".getBytes(StandardCharsets.UTF_8));
    expected.write("qux=aa:bb:cc\0".getBytes(StandardCharsets.UTF_8));
    expected.write("mex=aa--bb--cc\0".getBytes(StandardCharsets.UTF_8));
    assertOutput(actual, expected.toByteArray());
  }

  @Test
  public void testJoinedValuesFingerprint() throws Exception {
    // LaunchInfos with different entries should have different fingerprints.
    assertThat(
            LaunchInfo.builder()
                .addJoinedValues("foo", ";", ImmutableList.of("aa", "bb"))
                .build()
                .fingerPrint)
        .isNotEqualTo(
            LaunchInfo.builder()
                .addJoinedValues("bar", ";", ImmutableList.of("aa", "bb"))
                .build()
                .fingerPrint);

    // LaunchInfos with the same entries but in different order should have different fingerprints.
    assertThat(
            LaunchInfo.builder()
                .addJoinedValues("foo", ";", ImmutableList.of("aa", "bb"))
                .addJoinedValues("bar", ";", ImmutableList.of("aa", "bb"))
                .build()
                .fingerPrint)
        .isNotEqualTo(
            LaunchInfo.builder()
                .addJoinedValues("bar", ";", ImmutableList.of("aa", "bb"))
                .addJoinedValues("foo", ";", ImmutableList.of("aa", "bb"))
                .build()
                .fingerPrint);

    // Two identically-constructed LaunchInfos should have the same fingerprint.
    assertThat(
            LaunchInfo.builder()
                .addJoinedValues("foo", ";", ImmutableList.of("aa", "bb"))
                .addJoinedValues("bar", ";", ImmutableList.of("aa", "bb"))
                .build()
                .fingerPrint)
        .isEqualTo(
            LaunchInfo.builder()
                .addJoinedValues("foo", ";", ImmutableList.of("aa", "bb"))
                .addJoinedValues("bar", ";", ImmutableList.of("aa", "bb"))
                .build()
                .fingerPrint);
  }

  @Test
  public void testFingerprintDependsOnEntryType() throws Exception {
    // Although these LaunchInfo objects render to the same octet stream, their fingerprint is
    // different because we construct them differently.
    LaunchInfo actual1 = LaunchInfo.builder().addKeyValuePair("foo", "bar;baz").build();
    LaunchInfo actual2 =
        LaunchInfo.builder().addJoinedValues("foo", ";", ImmutableList.of("bar", "baz")).build();
    try (ByteArrayOutputStream out1 = new ByteArrayOutputStream();
        ByteArrayOutputStream out2 = new ByteArrayOutputStream()) {
      actual1.write(out1);
      actual2.write(out2);
      assertThat(out1.toByteArray()).isEqualTo(out2.toByteArray());
    }
    assertThat(actual1.fingerPrint).isNotEqualTo(actual2.fingerPrint);
  }

  @Test
  public void testNulls() throws Exception {
    assertOutput(LaunchInfo.builder().build(), new byte[0]);

    assertOutput(
        LaunchInfo.builder().addKeyValuePair("", null).addKeyValuePair("", "").build(),
        new byte[0]);

    assertOutput(
        LaunchInfo.builder()
            .addJoinedValues("", "", null)
            .addJoinedValues("", "delimiter", null)
            .addJoinedValues("", "", ImmutableList.of())
            .addJoinedValues("", "delimiter", ImmutableList.of())
            .build(),
        new byte[0]);

    LaunchInfo.Builder obj = LaunchInfo.builder();
    Class<LaunchInfo.Builder> clazz = LaunchInfo.Builder.class;
    NullPointerTester npt = new NullPointerTester().setDefault(String.class, "foo");

    npt.testMethod(obj, clazz.getMethod("addKeyValuePair", String.class, String.class));
    npt.testMethod(
        obj, clazz.getMethod("addJoinedValues", String.class, String.class, Iterable.class));
  }

  private static void assertOutput(LaunchInfo actual, byte[] expected) throws Exception {
    try (ByteArrayOutputStream out = new ByteArrayOutputStream()) {
      assertThat(actual.write(out)).isEqualTo(expected.length);
      assertThat(out.toByteArray()).isEqualTo(expected);
    }
  }
}