com.phloc.webscopes.mock.WebScopeTestInit Maven / Gradle / Ivy

Go to download
/**
 * Copyright (C) 2006-2014 phloc systems
 * http://www.phloc.com
 * office[at]phloc[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.phloc.webscopes.mock;

import java.util.Map;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;

import com.phloc.commons.annotations.PresentForCodeCoverage;
import com.phloc.commons.cleanup.CommonsCleanup;
import com.phloc.web.http.EHTTPMethod;
import com.phloc.web.mock.MockHttpListener;
import com.phloc.web.mock.MockHttpServletRequest;
import com.phloc.web.mock.MockServletContext;
import com.phloc.webscopes.servlet.WebScopeListener;

/**
 * Contains static initialization methods for web scope tests, that makes it a
 * bit easier to use them without JUnit.

 * Deprecated in favor of {@link WebScopeAwareTestSetup} to that the name is
 * similar to the one from phloc-scopes (ScopeAwareTestSetup).
 * 
 * @author Philip Helger
 */
@Deprecated
@Immutable
public final class WebScopeTestInit
{
  /** Mock servlet context name */
  public static final String MOCK_CONTEXT_PATH = WebScopeAwareTestSetup.MOCK_CONTEXT_PATH;

  @PresentForCodeCoverage
  @SuppressWarnings ("unused")
  private static final WebScopeTestInit s_aInstance = new WebScopeTestInit ();

  private WebScopeTestInit ()
  {}

  /**
   * Create a new mock servlet context using the context path
   * {@link #MOCK_CONTEXT_PATH} and no context init parameters.
   * 
   * @return Never null.
   */
  @Nonnull
  public static MockServletContext createDefaultMockServletContext ()
  {
    return createDefaultMockServletContext (MOCK_CONTEXT_PATH, null);
  }

  /**
   * Create a new mock servlet context.
   * 
   * @param sContextPath
   *        The context path to use. May be null.
   * @param aInitParams
   *        The initialization context parameters to use. May be
   *        null.
   * @return Never null.
   */
  @Nonnull
  public static MockServletContext createDefaultMockServletContext (@Nullable final String sContextPath,
                                                                    @Nullable final Map  aInitParams)
  {
    return new MockServletContext (sContextPath, aInitParams);
  }

  /**
   * Create a new mock request.
   * 
   * @param aServletContext
   *        The servlet context to use. May be null but not
   *        recommended.
   * @return Never null.
   */
  @Nonnull
  public static MockHttpServletRequest createDefaultMockRequest (@Nonnull final MockServletContext aServletContext)
  {
    return new MockHttpServletRequest (aServletContext, EHTTPMethod.GET);
  }

  /**
   * So that the mock HTTP listeners are available outside of this class
   */
  public static void setCoreMockHttpListeners ()
  {
    // Web listeners
    MockHttpListener.removeAllDefaultListeners ();
    MockHttpListener.addDefaultListener (new WebScopeListener ());
    MockHttpListener.addDefaultListener (new MockServletRequestListenerScopeAware ());
    MockHttpListener.setToDefault ();
  }

  /**
   * Invalidate the passed request and the passed servlet context after the
   * test.
   * 
   * @param aRequest
   *        The request to invalidate. May be null.
   * @param aServletContext
   *        The servlet context to invalidate. May be null.
   */
  public static void shutdownWebScopeTests (@Nullable final MockHttpServletRequest aRequest,
                                            @Nullable final MockServletContext aServletContext)
  {
    if (aRequest != null)
    {
      // end request -> triggers HTTP events
      aRequest.invalidate ();
    }

    if (aServletContext != null)
    {
      // shutdown global context -> triggers HTTP events
      aServletContext.invalidate ();
    }

    // Cleanup all phloc-commons stuff
    CommonsCleanup.cleanup ();
  }
}