com.helger.photon.app.mock.PhotonAppWebTestRule Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ph-oton-app Show documentation
ph-oton basic application stuff
The newest version!
/*
 * Copyright (C) 2014-2024 Philip Helger (www.helger.com)
 * philip[at]helger[dot]com
 *
 * 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.helger.photon.app.mock;

import java.io.File;

import javax.annotation.Nonnull;

import com.helger.commons.ValueEnforcer;
import com.helger.commons.annotation.Nonempty;
import com.helger.commons.collection.NonBlockingStack;
import com.helger.commons.io.file.FileOperationManager;
import com.helger.dao.AbstractDAO;
import com.helger.photon.io.WebFileIO;
import com.helger.scope.mock.ScopeTestRule;
import com.helger.servlet.ServletContextPathHolder;
import com.helger.web.scope.mock.WebScopeTestRule;

/**
 * Web scope aware test rule, with a defined storage root directory
 *
 * @author Philip Helger
 */
public class PhotonAppWebTestRule extends WebScopeTestRule
{
  private final File m_aDataPath;
  private final String m_sServletContextPath;
  private boolean m_bDeleteAllData = false;
  private boolean m_bOldDAOSilentMode;
  private boolean m_bOldWebFileIOSilentMode;
  private boolean m_bOldSCCtxHolderSilentMode;
  private NonBlockingStack  m_aCleansingRules;

  /**
   * Ctor using the default storage path from {@link ScopeTestRule}
   */
  public PhotonAppWebTestRule ()
  {
    this (ScopeTestRule.STORAGE_PATH);
  }

  /**
   * Ctor with an arbitrary path
   *
   * @param aPath
   *        The data AND servlet context path to be used. May not be
   *        null.
   * @since 8.0.1
   */
  public PhotonAppWebTestRule (@Nonnull final File aPath)
  {
    this (aPath, aPath.getAbsolutePath ());
  }

  /**
   * Ctor with an arbitrary path
   *
   * @param aDataPath
   *        The data path to be used. May not be null.
   * @param sServletContextPath
   *        The servlet context path to be used. May not be null.
   */
  public PhotonAppWebTestRule (@Nonnull final File aDataPath, @Nonnull @Nonempty final String sServletContextPath)
  {
    ValueEnforcer.notNull (aDataPath, "DataPath");
    ValueEnforcer.notNull (sServletContextPath, "ServletContextPath");
    m_aDataPath = aDataPath.getAbsoluteFile ();
    m_sServletContextPath = sServletContextPath;
  }

  /**
   * @return The used data path. Never null.
   */
  @Nonnull
  public final File getDataPath ()
  {
    return m_aDataPath;
  }

  /**
   * @return The used servlet context path. Never null.
   */
  @Nonnull
  @Nonempty
  public final String getServletContextPath ()
  {
    return m_sServletContextPath;
  }

  /**
   * Delete the directories with data and servlet context path before each
   * iteration?
   *
   * @param bDeleteAllData
   *        true to delete them in {@link #before()},
   *        false if not.
   * @return this for chaining
   */
  @Nonnull
  public final PhotonAppWebTestRule setDeleteAllData (final boolean bDeleteAllData)
  {
    m_bDeleteAllData = bDeleteAllData;
    return this;
  }

  @Override
  public void before ()
  {
    m_bOldDAOSilentMode = AbstractDAO.setSilentMode (true);
    m_bOldWebFileIOSilentMode = WebFileIO.setSilentMode (true);
    m_bOldSCCtxHolderSilentMode = ServletContextPathHolder.setSilentMode (true);
    super.before ();
    m_aCleansingRules = PhotonAppTestInit.init (m_aDataPath, m_sServletContextPath);

    if (m_bDeleteAllData)
    {
      // Clean all contained files
      FileOperationManager.INSTANCE.deleteDirRecursiveIfExisting (WebFileIO.getDataIO ().getBasePathFile ());
      FileOperationManager.INSTANCE.createDir (WebFileIO.getDataIO ().getBasePathFile ());
    }
  }

  @Override
  public void after ()
  {
    // Perform cleanup in the correct order
    if (m_aCleansingRules != null)
      while (m_aCleansingRules.isNotEmpty ())
      {
        final Runnable r = m_aCleansingRules.pop ();
        r.run ();
      }
    // Default shutdown
    super.after ();
    ServletContextPathHolder.setSilentMode (m_bOldSCCtxHolderSilentMode);
    WebFileIO.setSilentMode (m_bOldWebFileIOSilentMode);
    AbstractDAO.setSilentMode (m_bOldDAOSilentMode);
  }
}