org.scalatestplus.play.components.WithApplicationComponents.scala Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2001-2022 Artima, Inc.
 *
 * 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 org.scalatestplus.play.components

import play.api.inject.guice.GuiceApplicationBuilder
import play.api.BuiltInComponents
import play.api._

/**
 * A trait that provides a components in scope and returns them when newApplication is called.
 *
 * Mixin one of the public traits in this package to provide the desired functionality.
 *
 * This class has several methods that can be used to customize the behavior in specific ways.
 *
 * This is targeted at functional tests requiring a running application that is bootstrapped using Macwire/Compile time DI.
 * This is provided as an alternative to the [[GuiceApplicationBuilder]] which requires guice bootstrapping.
 *
 * @see https://www.playframework.com/documentation/2.5.x/ScalaFunctionalTestingWithScalaTest#Creating-Application-instances-for-testing
 */
trait WithApplicationComponents {

  /**
   * Override this function to instantiate the components - a factory of sorts.
   *
   * @return the components to be used by the application
   */
  def components: BuiltInComponents

  /**
   * @return new application instance and set the components. This must be called for components to be properly set up.
   */
  final def newApplication: Application = components.application

  /**
   * @return a context to use to create the application.
   */
  def context: ApplicationLoader.Context = {
    val env = Environment.simple()
    ApplicationLoader.Context.create(env)
  }
}