com.helger.scope.mock.ScopeAwareTestSetup Maven / Gradle / Ivy

Go to download
/*
 * 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.scope.mock;

import java.io.File;

import javax.annotation.concurrent.Immutable;

import com.helger.commons.annotation.PresentForCodeCoverage;
import com.helger.commons.cleanup.CommonsCleanup;
import com.helger.scope.mgr.ScopeManager;

/**
 * This class provides the initialization handling for scopes in unit tests. It
 * is independent of JUnit and can be used with any unit testing framework.
 *
 * @author Philip Helger
 */
@Immutable
public final class ScopeAwareTestSetup
{
  public static final String MOCK_GLOBAL_SCOPE_ID = "mock.global";
  public static final String MOCK_REQUEST_SCOPE_ID = "mock.request";
  public static final String MOCK_SESSION_SCOPE_ID = "mock.session";

  public static final File STORAGE_PATH = new File ("target/junittest").getAbsoluteFile ();

  @PresentForCodeCoverage
  private static final ScopeAwareTestSetup INSTANCE = new ScopeAwareTestSetup ();

  private ScopeAwareTestSetup ()
  {}

  /**
   * Run this before tests are executed to initialize a global scope and a
   * request.
   */
  public static void setupScopeTests ()
  {
    // begin request
    ScopeManager.onGlobalBegin (MOCK_GLOBAL_SCOPE_ID);

    // begin request
    ScopeManager.onRequestBegin (MOCK_REQUEST_SCOPE_ID, MOCK_SESSION_SCOPE_ID);
  }

  /**
   * Run this after your tests to shutdown the request and the global scope.
   */
  public static void shutdownScopeTests ()
  {
    // end request
    ScopeManager.onRequestEnd ();

    // shutdown global context
    ScopeManager.onGlobalEnd ();

    // Clean all ph-commons stuff
    CommonsCleanup.cleanup ();
  }
}