aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/test/java/com/google/devtools/build/android/ClassPathsSubject.java
blob: 3bc266c126d92f9c38978484c6748e950d42104a (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
// 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.android;

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

import com.google.common.base.Function;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Lists;
import com.google.common.truth.FailureStrategy;
import com.google.common.truth.Subject;
import java.io.IOException;
import java.lang.reflect.Field;
import java.lang.reflect.Modifier;
import java.net.URL;
import java.net.URLClassLoader;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.List;
import javax.annotation.Nullable;

/**
 * A testing utility that allows .java/.class related assertions against Paths.
 */
public class ClassPathsSubject extends Subject<ClassPathsSubject, Path> {

  ClassPathsSubject(FailureStrategy failureStrategy, @Nullable Path subject) {
    super(failureStrategy, subject);
  }

  void exists() {
    if (getSubject() == null) {
      fail("should not be null.");
    }
    if (!Files.exists(getSubject())) {
      fail("exists.");
    }
  }

  /**
   * Check that the contents of the java file at the current path, is equivalent to the given
   * expected contents (modulo header comments and surrounding whitespace).
   *
   * @param contents expected contents
   */
  public void javaContentsIsEqualTo(String... contents) {
    if (getSubject() == null) {
      fail("should not be null.");
    }
    exists();
    try {
      assertThat(
          trimWhitespace(
              stripJavaHeaderComments(
                  Files.readAllLines(getSubject(), StandardCharsets.UTF_8))))
          .containsExactly((Object[]) contents)
          .inOrder();
    } catch (IOException e) {
      fail(e.toString());
    }
  }

  private List<String> stripJavaHeaderComments(List<String> strings) {
    List<String> result = new ArrayList<>();
    boolean inComment = false;
    for (String string : strings) {
      if (string.trim().startsWith("/*")) {
        inComment = true;
        continue;
      }
      if (inComment) {
        if (string.trim().startsWith("*/")) {
          inComment = false;
          continue;
        }
        continue;
      }
      result.add(string);
    }
    return result;
  }

  private List<String> trimWhitespace(List<String> strings) {
    return Lists.transform(strings, new Function<String, String>() {
      @Override
      public String apply(String s) {
        return s.trim();
      }
    });
  }

  /**
   * Check the class file with the given name, assuming the current path is part of the classpath.
   *
   * @param className the fully qualified class name
   */
  public ClassNameSubject withClass(String className) {
    if (getSubject() == null) {
      fail("should not be null.");
    }
    exists();
    return new ClassNameSubject(failureStrategy, getSubject(), className);
  }

  static final class ClassNameSubject extends Subject<ClassNameSubject, String> {

    private final Path basePath;

    public ClassNameSubject(
        FailureStrategy failureStrategy, Path basePath, String subject) {
      super(failureStrategy, subject);
      this.basePath = basePath;
    }

    public void classContentsIsEqualTo(
        ImmutableMap<String, Integer> intFields,
        ImmutableMap<String, List<Integer>> intArrayFields,
        boolean areFieldsFinal) throws Exception {
      String expectedClassName = getSubject();
      URLClassLoader urlClassLoader = new URLClassLoader(new URL[]{basePath.toUri().toURL()});
      Class<?> innerClass = urlClassLoader.loadClass(expectedClassName);
      assertThat(innerClass.getSuperclass()).isEqualTo(Object.class);
      assertThat(innerClass.getEnclosingClass().toString())
          .endsWith(expectedClassName.substring(0, expectedClassName.indexOf('$')));
      ImmutableMap.Builder<String, Integer> actualIntFields = ImmutableMap.builder();
      ImmutableMap.Builder<String, List<Integer>> actualIntArrayFields = ImmutableMap.builder();
      for (Field f : innerClass.getFields()) {
        int fieldModifiers = f.getModifiers();
        assertThat(Modifier.isFinal(fieldModifiers)).isEqualTo(areFieldsFinal);
        assertThat(Modifier.isPublic(fieldModifiers)).isTrue();
        assertThat(Modifier.isStatic(fieldModifiers)).isTrue();

        Class<?> fieldType = f.getType();
        if (fieldType.isPrimitive()) {
          assertThat(fieldType).isEqualTo(Integer.TYPE);
          actualIntFields.put(f.getName(), (Integer) f.get(null));
        } else {
          assertThat(fieldType.isArray()).isTrue();
          int[] asArray = (int[]) f.get(null);
          ImmutableList.Builder<Integer> list = ImmutableList.builder();
          for (int i : asArray) {
            list.add(i);
          }
          actualIntArrayFields.put(f.getName(), list.build());
        }
      }
      assertThat(actualIntFields.build()).containsExactlyEntriesIn(intFields).inOrder();
      assertThat(actualIntArrayFields.build()).containsExactlyEntriesIn(intArrayFields).inOrder();
    }
  }
}