infer_clone/infer/tests/utils/matchers/ResultContainsLineNumbers.java

/*
 * Copyright (c) 2015 - present Facebook, Inc.
 * All rights reserved.
 *
 * This source code is licensed under the BSD style license found in the
 * LICENSE file in the root directory of this source tree. An additional grant
 * of patent rights can be found in the PATENTS file in the same directory.
 */

package utils.matchers;

import org.hamcrest.BaseMatcher;
import org.hamcrest.Description;
import org.hamcrest.Matcher;

import java.util.Arrays;
import java.util.Optional;
import java.util.Vector;

import utils.InferError;
import utils.InferResults;

public class ResultContainsLineNumbers extends BaseMatcher<InferResults> {

  private int[] lines;
  private boolean strict;
  private Optional<String> bugType;

  public ResultContainsLineNumbers(
      int[] lines,
      boolean strict,
      String bugType) {
    this.lines = lines;
    this.strict = strict;
    this.bugType = Optional.ofNullable(bugType);
  }

  @Override
  public boolean matches(Object o) {
    Vector<InferError> errors = ((InferResults) o).getErrors();
    if (strict && lines.length != errors.size()) {
      return false;
    }
    boolean allContained = true;
    for (int line : lines) {
      boolean isContained = false;
      for (InferError error : errors) {
        String bugType = this.bugType.orElse(error.getErrorType());
        boolean isSameErrType = bugType.equals(error.getErrorType());
        isContained = isContained || (line == error.getErrorLine() && isSameErrType);
      }
      allContained = allContained && isContained;
    }
    return allContained;
  }

  @Override
  public void describeTo(Description description) {
    description.appendText("Correct line numbers in the error report.");
  }

  @Override
  public void describeMismatch(Object item, Description description) {
    InferResults results = (InferResults) item;
    String linesString = Arrays.toString(lines);
    String reportedLinesString = Arrays.toString(findLineNumbersInReport(results));
    description.appendText(
        "Infer did not report an error in the following lines: " + linesString +
            ". \n \t  Reported lines are: " + reportedLinesString +
            "\n" + results.inferCmdToString());
  }

  public static <T> Matcher<InferResults> containsLines(int[] lines) {
    return new ResultContainsLineNumbers(lines, false, null);
  }

  public static <T> Matcher<InferResults> containsOnlyLines(int[] lines) {
    return new ResultContainsLineNumbers(lines, true, null);
  }

  public static <T> Matcher<InferResults> containsLinesOfError(int[] lines, String bugType) {
    return new ResultContainsLineNumbers(lines, false, bugType);
  }

  public static <T> Matcher<InferResults> containsOnlyLinesOfError(int[] lines, String bugType) {
    return new ResultContainsLineNumbers(lines, true, bugType);
  }

  private int[] findLineNumbersInReport(InferResults results) {
    Vector<InferError> errors = results.getErrors();
    int nErrors = errors.size();
    int[] lines = new int[nErrors];
    for (int i = 0; i < nErrors; i++) {
      lines[i] = errors.get(i).getErrorLine();
    }
    return lines;
  }
}