org.apache.beam.it.conditions.ConditionCheck Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of beam-it-conditions Show documentation
Integration test utilities suites.
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.beam.it.conditions;

import java.util.function.Supplier;
import org.checkerframework.checker.nullness.qual.Nullable;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * The {@link ConditionCheck} class provides a base interface for reusable/common conditions that
 * can be helpful during integration testing.
 */
public abstract class ConditionCheck implements Supplier {

  private static final Logger LOG = LoggerFactory.getLogger(ConditionCheck.class);

  private @Nullable ConditionCheck prev = null;

  protected abstract String getDescription();

  protected abstract CheckResult check();

  @Override
  public Boolean get() {
    LOG.info("[?] Checking for condition '{}'...", getDescription());

    CheckResult result = check();
    if (!result.success) {
      LOG.info("[✗] Condition '{}' not met! {}", getDescription(), result.message);
      return false;
    }

    LOG.info(
        "[✓] Condition '{}' succeeded! {}",
        getDescription(),
        result.message == null ? "" : result.message);

    if (prev != null) {
      return result.success && prev.get();
    }

    return true;
  }

  public ConditionCheck and(ConditionCheck next) {
    next.prev = this;
    return next;
  }

  public static class CheckResult {
    private final boolean success;
    private final String message;

    public CheckResult(boolean success) {
      this.success = success;
      this.message = "";
    }

    public CheckResult(boolean success, String message) {
      this.success = success;
      this.message = message;
    }

    public boolean isSuccess() {
      return success;
    }

    public String getMessage() {
      return message;
    }

    @Override
    public String toString() {
      return "CheckResult{" + "success=" + success + ", message='" + message + '\'' + '}';
    }
  }
}