com.google.common.truth.TableSubject Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of truth Show documentation
The newest version!
/*
 * Copyright (c) 2014 Google, Inc.
 *
 * 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.common.truth;

import static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.base.Preconditions.checkNotNull;
import static com.google.common.truth.Fact.fact;
import static com.google.common.truth.Fact.simpleFact;

import com.google.common.collect.Table;
import com.google.common.collect.Table.Cell;
import com.google.common.collect.Tables;
import org.jspecify.annotations.Nullable;

/**
 * Propositions for {@link Table} subjects.
 *
 * @author Kurt Alfred Kluever
 */
public final class TableSubject extends Subject {
  private final @Nullable Table actual;

  TableSubject(FailureMetadata metadata, @Nullable Table table) {
    super(metadata, table);
    this.actual = table;
  }

  /** Fails if the table is not empty. */
  public void isEmpty() {
    if (!checkNotNull(actual).isEmpty()) {
      failWithActual(simpleFact("expected to be empty"));
    }
  }

  /** Fails if the table is empty. */
  public void isNotEmpty() {
    if (checkNotNull(actual).isEmpty()) {
      failWithoutActual(simpleFact("expected not to be empty"));
    }
  }

  /** Fails if the table does not have the given size. */
  public final void hasSize(int expectedSize) {
    checkArgument(expectedSize >= 0, "expectedSize(%s) must be >= 0", expectedSize);
    check("size()").that(checkNotNull(actual).size()).isEqualTo(expectedSize);
  }

  /** Fails if the table does not contain a mapping for the given row key and column key. */
  public void contains(@Nullable Object rowKey, @Nullable Object columnKey) {
    if (!checkNotNull(actual).contains(rowKey, columnKey)) {
      /*
       * TODO(cpovirk): Consider including information about whether any cell with the given row
       * *or* column was present.
       */
      failWithActual(
          simpleFact("expected to contain mapping for row-column key pair"),
          fact("row key", rowKey),
          fact("column key", columnKey));
    }
  }

  /** Fails if the table contains a mapping for the given row key and column key. */
  public void doesNotContain(@Nullable Object rowKey, @Nullable Object columnKey) {
    if (checkNotNull(actual).contains(rowKey, columnKey)) {
      failWithoutActual(
          simpleFact("expected not to contain mapping for row-column key pair"),
          fact("row key", rowKey),
          fact("column key", columnKey),
          fact("but contained value", actual.get(rowKey, columnKey)),
          fact("full contents", actual));
    }
  }

  /** Fails if the table does not contain the given cell. */
  public void containsCell(
      @Nullable Object rowKey, @Nullable Object colKey, @Nullable Object value) {
    containsCell(
        Tables.<@Nullable Object, @Nullable Object, @Nullable Object>immutableCell(
            rowKey, colKey, value));
  }

  /** Fails if the table does not contain the given cell. */
  public void containsCell(Cell cell) {
    checkNotNull(cell);
    checkNoNeedToDisplayBothValues("cellSet()").that(checkNotNull(actual).cellSet()).contains(cell);
  }

  /** Fails if the table contains the given cell. */
  public void doesNotContainCell(
      @Nullable Object rowKey, @Nullable Object colKey, @Nullable Object value) {
    doesNotContainCell(
        Tables.<@Nullable Object, @Nullable Object, @Nullable Object>immutableCell(
            rowKey, colKey, value));
  }

  /** Fails if the table contains the given cell. */
  public void doesNotContainCell(Cell cell) {
    checkNotNull(cell);
    checkNoNeedToDisplayBothValues("cellSet()")
        .that(checkNotNull(actual).cellSet())
        .doesNotContain(cell);
  }

  /** Fails if the table does not contain the given row key. */
  public void containsRow(@Nullable Object rowKey) {
    check("rowKeySet()").that(checkNotNull(actual).rowKeySet()).contains(rowKey);
  }

  /** Fails if the table does not contain the given column key. */
  public void containsColumn(@Nullable Object columnKey) {
    check("columnKeySet()").that(checkNotNull(actual).columnKeySet()).contains(columnKey);
  }

  /** Fails if the table does not contain the given value. */
  public void containsValue(@Nullable Object value) {
    check("values()").that(checkNotNull(actual).values()).contains(value);
  }
}