How should one implement a Scaldi Module in regards to testing and mocks (un familiar to that module)?

Question

I have an implicit scaldi Module in my root package object so that any component can use the injector implicitly.

This module looks like this:

val additionalModule = new AtomicReference[Module](new Module {})

lazy val applicationModule = additionalModule.get ++ new Module {
  bind[Trait1] to new Impl1
  bind[Trait2] to new Impl2
}

The Scaldi documentation says it is not recommended to bind on an already initialised module so I added the additionalModule for testing/module reuse purposes and aggregated it with the predefined one. Did I get it right?

Why did you put the module in an atomic reference? Do you want to add bindings dynamically ("bind on an already initialized module")? When doing module composition, right-handed modules have priority ( http://scaldi.org/learn/#testing-of-play-application ) so if you are using `additionalModule` for testing, it should be appended to the other module to overwrite the bindings. — Mironor, Feb 21 '16 at 15:24

score 0 · Answer 1 · answered Feb 23 '16 at 15:14

I wouldn't recommend making injector globally accessible. If you would like to use it in particular class, I would recommend you to introduce an implicit parameter with Injector for this class. Something like this:

class UserService(implicit inj: Injector) extends Injectable {
  // ...
}

(more info)

Alternatively you can use a constructor injection in combination with injected macro:

class TokenRepo(db: Database, metrics: Metrics) extends Tokens {
  // ...
}

now you can bind it like this:

class MyModule extends Module {
  bind [Tokens] to injected [TokenRepo]
}

(more info)

When you are testing, it is important not to reuse instances of modules if you are composing them in different ways inside of the tests. This means in your case you need to instantiate not only the test module, but also an application module as well. For instance:

implicit injector = new TestModuleWithMocks ++ new Appmodule

As @Mironor mentioned, you need to be careful with order of the modules in the composition.

How should one implement a Scaldi Module in regards to testing and mocks (un familiar to that module)?

1 Answers1