Initialize router.Routes class to set prefix in controllers.documentation.Router

Author: mkurz

test/controllers/documentation/DocumentationControllerSpec.scala

@@ -1,19 +1,24 @@
 package controllers.documentation
 
+import play.api.routing.Router
 import play.api.test._
 
 object DocumentationControllerSpec extends PlaySpecification {
 
   "DocumentationController" should {
 
     "render a page" in new WithApplication with Injecting {
+      inject[Router] // makes sure generated router.Routes class (in target folder) get initialized, which injects controllers.documentation.Router and calls its withPrefix(...)
       val reverseRouter: ReverseRouter = inject[ReverseRouter]
-      val request                      = FakeRequest("GET", reverseRouter.page(None, "2.5.x", "Home"))
-      val result                       = await(route(app, request).get)
+      private val page: String         = reverseRouter.page(None, "2.5.x", "Home")
+      page must beEqualTo("/documentation/2.5.x/Home")
+      val request = FakeRequest("GET", page)
+      val result  = await(route(app, request).get)
       result.header.status must beEqualTo(OK)
     }
 
     "add canonical header" in new WithApplication with Injecting {
+      inject[Router] // makes sure router.Routes class get initialized, which injects controllers.documentation.Router and calls its withPrefix(...)
       val reverseRouter: ReverseRouter = inject[ReverseRouter]
       val request                      = FakeRequest("GET", reverseRouter.page(None, "2.5.x", "Home"))
       val result                       = await(route(app, request).get)
@@ -22,6 +27,7 @@ object DocumentationControllerSpec extends PlaySpecification {
 
     "when switching to another version" should {
       "redirect to the selected version and page" in new WithApplication with Injecting {
+        inject[Router] // makes sure router.Routes class get initialized, which injects controllers.documentation.Router and calls its withPrefix(...)
         val reverseRouter: ReverseRouter = inject[ReverseRouter]
 
         val request = FakeRequest("GET", reverseRouter.switch(None, "2.7.x", "Home"))
@@ -32,6 +38,7 @@ object DocumentationControllerSpec extends PlaySpecification {
 
       "redirect to the selected version and home when no page is selected" in new WithApplication
       with Injecting {
+        inject[Router] // makes sure router.Routes class get initialized, which injects controllers.documentation.Router and calls its withPrefix(...)
         val reverseRouter: ReverseRouter = inject[ReverseRouter]
 
         val request = FakeRequest("GET", reverseRouter.switch(None, "2.7.x", ""))
@@ -42,6 +49,7 @@ object DocumentationControllerSpec extends PlaySpecification {
 
       "redirect to the selected version when not having a trailing slash" in new WithApplication
       with Injecting {
+        inject[Router] // makes sure router.Routes class get initialized, which injects controllers.documentation.Router and calls its withPrefix(...)
         val reverseRouter: ReverseRouter = inject[ReverseRouter]
 
         val page    = reverseRouter.switch(None, "2.7.x", "").stripSuffix("/")
@@ -54,6 +62,7 @@ object DocumentationControllerSpec extends PlaySpecification {
 
     "when page not found" should {
       "redirect page that was renamed" in new WithApplication with Injecting {
+        inject[Router] // makes sure router.Routes class get initialized, which injects controllers.documentation.Router and calls its withPrefix(...)
         val reverseRouter: ReverseRouter = inject[ReverseRouter]
         // When accessing "AkkaCore" (was renamed to "ThreadPools")
         val request = FakeRequest("GET", reverseRouter.page(None, "2.5.x", "AkkaCore"))
@@ -64,6 +73,7 @@ object DocumentationControllerSpec extends PlaySpecification {
       }
 
       "redirect page that was removed" in new WithApplication with Injecting {
+        inject[Router] // makes sure router.Routes class get initialized, which injects controllers.documentation.Router and calls its withPrefix(...)
         val reverseRouter: ReverseRouter = inject[ReverseRouter]
         val request                      = FakeRequest("GET", reverseRouter.page(None, "2.5.x", "PullRequests"))
         val result                       = route(app, request).get
@@ -72,6 +82,7 @@ object DocumentationControllerSpec extends PlaySpecification {
       }
 
       "not redirect when there is no new page" in new WithApplication with Injecting {
+        inject[Router] // makes sure router.Routes class get initialized, which injects controllers.documentation.Router and calls its withPrefix(...)
         val reverseRouter: ReverseRouter = inject[ReverseRouter]
         val request                      = FakeRequest("GET", reverseRouter.page(None, "2.5.x", "DoesNotExists"))
         val result                       = route(app, request).get
@@ -81,6 +92,7 @@ object DocumentationControllerSpec extends PlaySpecification {
       }
 
       "not redirect an existing page" in new WithApplication with Injecting {
+        inject[Router] // makes sure router.Routes class get initialized, which injects controllers.documentation.Router and calls its withPrefix(...)
         val reverseRouter: ReverseRouter = inject[ReverseRouter]
         // AkkaCore exists for version 2.0
         val request = FakeRequest("GET", reverseRouter.page(None, "2.0.x", "AkkaCore"))