Search code examples
scalaplayframework-2.2spec2

In Play 2.2, Spec2 tests, I get Configuration error[Cannot connect to database [default]]


I am using Scala Spec2 in Play Framework version 2.2 application. When I run the tests, I get following errors:

$ test-only ApplicationSpec
Mode is Test, Loading: application.test.conf
Create schema
Populate the application schema...
Stopping the application...
Stopping the application...
Stopping the application...
[info] ApplicationSpec
[info] Application should
[info] + send 404 on a bad request
[info] ! render the login page
[error]     anon$1: Configuration error[Cannot connect to database [default]] (Configuration.scala:92)
[error] play.api.Configuration$.play$api$Configuration$$configError(Configuration.scala:92)
[error] play.api.Configuration.reportError(Configuration.scala:570)
[error] play.api.db.BoneCPPlugin$$anonfun$onStart$1.apply(DB.scala:252)
[error] play.api.db.BoneCPPlugin$$anonfun$onStart$1.apply(DB.scala:243)
[error] play.api.db.BoneCPPlugin.onStart(DB.scala:243)
[error] play.api.Play$$anonfun$start$1$$anonfun$apply$mcV$sp$1.apply(Play.scala:88)
[error] play.api.Play$$anonfun$start$1$$anonfun$apply$mcV$sp$1.apply(Play.scala:88)
[error] play.api.Play$$anonfun$start$1.apply$mcV$sp(Play.scala:88)
[error] play.api.Play$$anonfun$start$1.apply(Play.scala:88)
[error] play.api.Play$$anonfun$start$1.apply(Play.scala:88)
[error] play.utils.Threads$.withContextClassLoader(Threads.scala:18)
[error] play.api.Play$.start(Play.scala:87)
[error] play.api.test.PlayRunners$class.running(Helpers.scala:44)
[error] play.api.test.Helpers$.running(Helpers.scala:364)
[error] ApplicationSpec$$anonfun$1$$anonfun$apply$12.apply(ApplicationSpec.scala:25)
[error] ApplicationSpec$$anonfun$1$$anonfun$apply$12.apply(ApplicationSpec.scala:25)

MockGlobal.scala contains following code:

object MockGlobal extends GlobalSettings {

  override def onStart(app: Application) {
    super.onStart(app)
    // check if the database is already setup
    implicit val a = app

    if (isDatabaseEmpty(app)) {
      println("Create schema")
      FixtureUtils.populateSchema
      println("Pouplate fixtures ")
      FixtureUtils.GoldData.populateFixtures
    }
  }

  def isDatabaseEmpty(app: Application) = {

    implicit val a = app

    DB.withSession { implicit session =>
      val lst = MTable.getTables("users").list()
      lst.isEmpty
    }
  }

  override def onLoadConfig(config: Configuration,
    path: File, classloader: ClassLoader,
    mode: Mode.Mode): Configuration = {

    val configfile = s"application.${mode.toString.toLowerCase}.conf"
    println(s"Mode is ${mode.toString}, Loading: ${configfile}")
    val modeSpecificConfig = config ++ Configuration(
      ConfigFactory.load(configfile))
    super.onLoadConfig(modeSpecificConfig, path, classloader, mode)
  }

  override def onStop(app: Application) {
    println("Stopping the application...")
  }
}

TestApplication.scala contains following code:

object TestApplication {
  val log = play.Logger.of("application")
  lazy val app = FakeApplication(withGlobal = Some(MockGlobal))
}

ApplicationSpec.scala contains following code:

import org.specs2.mutable._
import org.specs2.runner._
import org.junit.runner._
import play.api.test._
import play.api.test.Helpers._
import models.User
import models.Users
import fixtures.TestApplication
import fixtures.FixtureUtils

/**
 * Add your spec here.
 * You can mock out a whole application including requests, plugins etc.
 * For more information, consult the wiki.
 */
@RunWith(classOf[JUnitRunner])
class ApplicationSpec extends Specification {

  "Application" should {

    "send 404 on a bad request" in new WithApplication(TestApplication.app) {
      route(FakeRequest(GET, "/boum")) must beNone
    }

    "render the login page" in running(TestApplication.app) {
      val home = route(FakeRequest(GET, "/")).get
      // must redirect to login page
      status(home) must equalTo(SEE_OTHER)
      val x = redirectLocation(home).map { location =>
        location must equalTo("/login")
        val loginpage = route(FakeRequest(GET, "/login")) map { result =>
          status(result) must equalTo(OK)
          contentType(result) must beSome.which(_ == "text/html")
          contentAsString(result) must contain("Apps: Login")
        }
      }

      x must beSome
    }
  }
}

I have seen similar error reported here:

I tried adding following line to build.sbt to not fork for each test. This didn't help either:

Keys.fork in (Test) := false

Note two things:

  • Actual error: Configuration error[Cannot connect to database [default]] (Configuration.scala:92)
  • This appears three times Stopping the application...

What can I do to solve this issue ?


Solution

  • I was trying to avoid creating a new application each time a test is run, so I used:

    lazy val app = FakeApplication(withGlobal = Some(MockGlobal))
    

    However this is the wrong approach. For a forked test, once it has finished, the application is stopped, thereby making it unavailable for other tests. This is the reason I was getting database connection errors in all but the first test that executed.

    I changed the spec test definition

    • from this: in new WithApplication(TestApplication.app)
    • to this: in running(FakeApplication(withGlobal = Some(MockGlobal)))

    Here is how it looks now:

    "render the login page" in running(FakeApplication(withGlobal = Some(MockGlobal))) {
      val home = route(FakeRequest(GET, "/")).get
      // must redirect to login page
      status(home) must equalTo(SEE_OTHER)
      val x = redirectLocation(home).map { location =>
        location must equalTo("/login")
        val loginpage = route(FakeRequest(GET, "/login")) map { result =>
          status(result) must equalTo(OK)
          contentType(result) must beSome.which(_ == "text/html")
          contentAsString(result) must contain("Apps: Login")
        }
      }
    
      x must beSome
    }
    

    Now all the testcases are working fine. I am not seeing any error Configuration error[Cannot connect to database [default]].