trait StubControllerComponentsFactory extends StubPlayBodyParsersFactory with StubBodyParserFactory with StubMessagesFactory
- Alphabetic
- By Inheritance
- StubControllerComponentsFactory
- StubMessagesFactory
- StubBodyParserFactory
- StubPlayBodyParsersFactory
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- def stubBodyParser[T](content: T = AnyContentAsEmpty): BodyParser[T]
Stub method that returns the content immediately.
Stub method that returns the content immediately. Useful for unit testing.
val stubParser = bodyParser(AnyContent("hello"))
- content
the content to return, AnyContentAsEmpty by default
- returns
a BodyParser for type T that returns Accumulator.done(Right(content))
- Definition Classes
- StubBodyParserFactory
- def stubControllerComponents(bodyParser: BodyParser[AnyContent] = stubBodyParser(AnyContentAsEmpty), playBodyParsers: PlayBodyParsers = stubPlayBodyParsers(NoMaterializer), messagesApi: MessagesApi = stubMessagesApi(), langs: Langs = stubLangs(), fileMimeTypes: FileMimeTypes = new DefaultFileMimeTypes(FileMimeTypesConfiguration()), executionContext: ExecutionContext = ExecutionContext.global): ControllerComponents
Create a minimal controller components, useful for unit testing.
Create a minimal controller components, useful for unit testing.
In most cases, you'll want the standard defaults:
val controller = new MyController(stubControllerComponents())
A custom body parser can be used with bodyParser() to provide a request body to the controller:
val cc = stubControllerComponents(bodyParser(AnyContent("request body text")))
- bodyParser
the body parser used to parse any content, stubBodyParser(AnyContentAsEmpty) by default.
- playBodyParsers
the playbodyparsers, defaults to stubPlayBodyParsers(NoMaterializer)
- messagesApi
the messages api, new DefaultMessagesApi() by default.
- langs
the langs instance for messaging, new DefaultLangs() by default.
- fileMimeTypes
the mime type associated with file extensions, new DefaultFileMimeTypes(FileMimeTypesConfiguration() by default.
- executionContext
an execution context, defaults to ExecutionContext.global
- returns
a fully configured ControllerComponents instance.
- def stubLangs(availables: Seq[Lang] = Seq(Lang.defaultLang)): Langs
- availables
default as Seq(Lang.defaultLang).
- returns
a stub Langs
- Definition Classes
- StubMessagesFactory
- def stubMessages(messagesApi: MessagesApi = stubMessagesApi(), requestHeader: RequestHeader = FakeRequest()): Messages
Stub method that returns a play.api.i18n.Messages instance.
Stub method that returns a play.api.i18n.Messages instance.
- messagesApi
the messagesApi to use, uses stubMessagesApi by default.
- requestHeader
the request to use, FakeRequest by default.
- returns
the Messages instance
- Definition Classes
- StubMessagesFactory
- def stubMessagesApi(messages: Map[String, Map[String, String]] = Map.empty, langs: Langs = stubLangs(), langCookieName: String = "PLAY_LANG", langCookieSecure: Boolean = false, langCookieHttpOnly: Boolean = false, langCookieSameSite: Option[SameSite] = None, httpConfiguration: HttpConfiguration = HttpConfiguration(), langCookieMaxAge: Option[Int] = None): MessagesApi
Returns a stub DefaultMessagesApi with default values and an empty map.
Returns a stub DefaultMessagesApi with default values and an empty map.
- messages
map of languages to map of messages, empty by default.
- langs
stubLangs() by default
- langCookieName
"PLAY_LANG" by default
- langCookieSecure
false by default
- langCookieHttpOnly
false by default
- langCookieSameSite
None by default
- httpConfiguration
configuration, HttpConfiguration() by default.
- langCookieMaxAge
None by default
- returns
the messagesApi with minimal configuration.
- Definition Classes
- StubMessagesFactory
- def stubMessagesControllerComponents(): MessagesControllerComponents
- def stubMessagesRequest(messagesApi: MessagesApi = stubMessagesApi(), request: Request[AnyContentAsEmpty.type] = FakeRequest()): MessagesRequest[AnyContentAsEmpty.type]
Stub method that returns a play.api.mvc.MessagesRequest instance.
Stub method that returns a play.api.mvc.MessagesRequest instance.
- messagesApi
the messagesApi to use, uses stubMessagesApi by default.
- request
the request to use, FakeRequest by default.
- returns
the Messages instance
- Definition Classes
- StubMessagesFactory
- def stubPlayBodyParsers(implicit mat: Materializer): PlayBodyParsers
Stub method for unit testing, using NoTemporaryFileCreator.
Stub method for unit testing, using NoTemporaryFileCreator.
- mat
the input materializer.
- returns
a minimal PlayBodyParsers for unit testing.
- Definition Classes
- StubPlayBodyParsersFactory