org.sonar.javascript.checks.verifier.CheckMessagesVerifier Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of javascript-checks-testkit Show documentation
The newest version!
/*
 * SonarQube JavaScript Plugin
 * Copyright (C) 2011-2021 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.sonar.javascript.checks.verifier;

import com.google.common.base.Objects;
import com.google.common.collect.Ordering;
import java.util.Collection;
import java.util.Comparator;
import java.util.Iterator;
import javax.annotation.Nullable;
import org.hamcrest.Matcher;

import static org.junit.Assert.assertThat;

/**
 * This class was copy&pasted from sslr-squid-bridge to avoid dependency on it
 * 
 * Helper class for testing checks without having to deploy them on a Sonar instance.
 * It can be used as following:
 * 
{@code
 * CheckMessagesVerifier.verify(messages)
 *   .next().atLine(1).withMessage("foo")
 *   .next().atLine(2).withMessage("bar")
 *   .noMore();
 * }
 * Strictly speaking this is just a wrapper over collection of {@link CheckMessage},
 * which guarantees order of traversal.
 *
 * @since sslr-squid-bridge 2.1
 */
public final class CheckMessagesVerifier {

  private final Iterator iterator;
  private CheckMessage current;

  private static final Comparator ORDERING = (left, right) -> {
    if (Objects.equal(left.getLine(), right.getLine())) {
      return left.getDefaultMessage().compareTo(right.getDefaultMessage());
    } else if (left.getLine() == null) {
      return -1;
    } else if (right.getLine() == null) {
      return 1;
    } else {
      return left.getLine().compareTo(right.getLine());
    }
  };

  private CheckMessagesVerifier(Collection messages) {
    iterator = Ordering.from(ORDERING).sortedCopy(messages).iterator();
  }

  public static CheckMessagesVerifier verify(Collection messages) {
    return new CheckMessagesVerifier(messages);
  }

  public CheckMessagesVerifier next() {
    if (!iterator.hasNext()) {
      throw new AssertionError("\nExpected violation");
    }
    current = iterator.next();
    return this;
  }

  public void noMore() {
    if (iterator.hasNext()) {
      CheckMessage next = iterator.next();
      throw new AssertionError("\nNo more violations expected\ngot: at line " + next.getLine());
    }
  }

  private void checkStateOfCurrent() {
    if (current == null) {
      throw new IllegalStateException("Prior to this method you should call next()");
    }
  }

  public CheckMessagesVerifier atLine(@Nullable Integer expectedLine) {
    checkStateOfCurrent();
    if (!Objects.equal(expectedLine, current.getLine())) {
      throw assertionError(expectedLine, current.getLine());
    }
    return this;
  }

  public CheckMessagesVerifier withMessage(String expectedMessage) {
    checkStateOfCurrent();
    String actual = current.getText();
    if (!actual.equals(expectedMessage)) {
      throw assertionError("\"" + expectedMessage + "\"", "\"" + actual + "\"");
    }
    return this;
  }

  /**
   * Note that this method requires JUnit and Hamcrest.
   */
  CheckMessagesVerifier withMessageThat(Matcher matcher) {
    checkStateOfCurrent();
    String actual = current.getText();
    assertThat(actual, matcher);
    return this;
  }

  /**
   * @since sslr-squid-bridge 2.3
   */
  CheckMessagesVerifier withCost(Double expectedCost) {
    checkStateOfCurrent();
    if (!Objects.equal(expectedCost, current.getCost())) {
      throw assertionError(expectedCost, current.getCost());
    }
    return this;
  }

  private static AssertionError assertionError(@Nullable Object expected, @Nullable Object actual) {
    return new AssertionError("\nExpected: " + expected + "\ngot: " + actual);
  }

}