com.google.javascript.jscomp.testing.JSErrorSubject Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2016 The Closure Compiler Authors.
 *
 * 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.javascript.jscomp.testing;

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

import com.google.common.truth.FailureMetadata;
import com.google.common.truth.Subject;
import com.google.javascript.jscomp.DiagnosticType;
import com.google.javascript.jscomp.JSError;
import javax.annotation.CheckReturnValue;

/**
 * A Truth Subject for the JSError class. Usage:
 *
 *  *   import static com.google.javascript.jscomp.testing.JSErrorSubject.assertNode;
 *   ...
 *   assertError(error).hasType(TypeValidator.TYPE_MISMATCH);
 * 
 *
 * TODO(tbreisacher): Add assertions on the message text, line number, etc.
 */
public final class JSErrorSubject extends Subject {
  @CheckReturnValue
  public static JSErrorSubject assertError(JSError error) {
    return assertAbout(JSErrorSubject::new).that(error);
  }

  private final JSError actual;

  public JSErrorSubject(FailureMetadata failureMetadata, JSError error) {
    super(failureMetadata, error);
    this.actual = error;
  }

  public void hasType(DiagnosticType type) {
    check("getType()").that(actual.getType()).isEqualTo(type);
  }

  public void hasMessage(String msg) {
    check("description").that(actual.getDescription()).isEqualTo(msg);
  }
}