SCM-Manager/scm-webapp/src/main/java/sonia/scm/repository/HealthChecker.java

/**
 * Copyright (c) 2010, Sebastian Sdorra All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer. 2. Redistributions in
 * binary form must reproduce the above copyright notice, this list of
 * conditions and the following disclaimer in the documentation and/or other
 * materials provided with the distribution. 3. Neither the name of SCM-Manager;
 * nor the names of its contributors may be used to endorse or promote products
 * derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * http://bitbucket.org/sdorra/scm-manager
 *
 */



package sonia.scm.repository;

//~--- non-JDK imports --------------------------------------------------------

import com.google.common.collect.ImmutableList;
import com.google.inject.Inject;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
//~--- JDK imports ------------------------------------------------------------

import java.io.IOException;

import java.util.Set;
import sonia.scm.security.PermissionActionCheck;

/**
 *
 * @author Sebastian Sdorra
 */
public final class HealthChecker
{

  /**
   * the logger for HealthChecker
   */
  private static final Logger logger =
    LoggerFactory.getLogger(HealthChecker.class);

  //~--- constructors ---------------------------------------------------------

  /**
   * Constructs ...
   *
   *
   * @param checks
   * @param repositoryManager
   */
  @Inject
  public HealthChecker(Set<HealthCheck> checks,
    RepositoryManager repositoryManager)
  {
    this.checks = checks;
    this.repositoryManager = repositoryManager;
  }

  //~--- methods --------------------------------------------------------------

  /**
   * Method description
   *
   *
   * @param id
   *
   *
   * @throws IOException
   * @throws RepositoryException
   * @throws RepositoryNotFoundException
   */
  public void check(String id)
    throws RepositoryNotFoundException, RepositoryException, IOException
  {
    RepositoryPermissions.healthCheck(id);

    Repository repository = repositoryManager.get(id);

    if (repository == null)
    {
      throw new RepositoryNotFoundException(
        "could not find repository with id ".concat(id));
    }

    doCheck(repository);
  }

  /**
   * Method description
   *
   *
   * @param repository
   *
   * @throws IOException
   * @throws RepositoryException
   */
  public void check(Repository repository)
    throws RepositoryException, IOException
  {
    RepositoryPermissions.healthCheck(repository);

    doCheck(repository);
  }

  /**
   * Method description
   *
   *
   */
  public void checkAll()
  {
    logger.debug("check health of all repositories");

    PermissionActionCheck<Repository> check = RepositoryPermissions.healthCheck();

    for (Repository repository : repositoryManager.getAll())
    {
      if (check.isPermitted(repository))
      {
        try
        {
          check(repository);
        }
        catch (RepositoryException | IOException ex)
        {
          logger.error("health check ends with exception", ex);
        }
      }
      else
      {
        logger.debug(
          "no permissions to execute health check for repository {}",
          repository.getId());
      }
    }
  }

  private void doCheck(Repository repository)
    throws RepositoryException, IOException
  {
    logger.info("start health check for repository {}", repository.getName());

    HealthCheckResult result = HealthCheckResult.healthy();

    for (HealthCheck check : checks)
    {
      logger.trace("execute health check {} for repository {}",
        check.getClass(), repository.getName());
      result = result.merge(check.check(repository));
    }

    if (result.isUnhealthy())
    {
      logger.warn("repository {} is unhealthy: {}", repository.getName(),
        result);
    }
    else
    {
      logger.info("repository {} is healthy", repository.getName());
    }

    if (!(repository.isHealthy() && result.isHealthy()))
    {
      logger.trace("store health check results for repository {}",
        repository.getName());
      repository.setHealthCheckFailures(
        ImmutableList.copyOf(result.getFailures()));
      repositoryManager.modify(repository);
    }
  }

  //~--- fields ---------------------------------------------------------------

  /** Field description */
  private final Set<HealthCheck> checks;

  /** Field description */
  private final RepositoryManager repositoryManager;
}