ebean-orm.github.io/docs/setup/testing.html at master · hexagonframework/ebean-orm.github.io

History

276 lines (240 loc) · 14.4 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

<!DOCTYPE html>

<head>

<title>Ebean ORM Setup</title>

<!--[if lt IE 9]>

<![endif]-->

</head>

<body>

Toggle navigation

</button>

<a class="navbar-brand" href="/"><img src="/images/logo-black-3.png" width="32" style="display: inline;">Ebean ORM</a>

</div>

<li ><a href="/videos">Videos</a></li>

<li ><a href="/quickstart">Quick Start</a></li>

<li ><a href="/support">Support</a></li>

<li ><a target="_blank" href="/apidoc/10">ApiDocs</a></li>

<li ><a href="/releases">Releases</a></li>

<li ><a target="_blank" href="https://github.com/ebean-orm/ebean"> Github</a></li>

</ul> </div>

<li ><a href="/videos">Videos</a></li>

<li ><a href="/quickstart">Quick Start</a></li>

<li ><a href="/support">Support</a></li>

<li ><a target="_blank" href="/apidoc/10">ApiDocs</a></li>

<li ><a href="/releases">Releases</a></li>

<li ><a target="_blank" href="https://github.com/ebean-orm/ebean"> Github</a></li>

</ul> </div>

</div>

<h1><a href="/docs">Documentation</a> / <a href="/docs/setup">Setup</a> / Testing </h1>

</div>

<h2 id="test-properties">test-ebean.properties</h2>

When you want to run all tests against <code>H2</code> in memory database a simple way to do this is to add a

<code>src/test/resources/test-ebean.properties</code> to your project. In the <code>test-ebean.properties</code>

you can effectively override the properties of the datasource and specify to use <code>H2</code>.

When an EbeanServer is created automatically via <code>Ebean.getDefaultServer()</code> or <code>Ebean.getServer(name)</code>

then Ebean will look for the existence of test-ebean.properties in the classpath. If found this then typically

specifies to use an in memory <code>H2</code> datasource.

When programmatically creating an EbeanServer using <code>ServerConfig</code> and <code>EbeanServerFactory</code>

there is a method <code>serverConfig.loadTestProperties()</code> which will similarly look for a test-ebean.properties

file if present.

<div class="syntax java"><div class="highlight"><pre>@Override

public EbeanServer getObject() throws Exception {

ServerConfig config = new ServerConfig();

config.setName("db");

config.loadFromProperties(properties);

...

// load test-ebean.properties if present for running tests

// typically using H2 in memory database

config.loadTestProperties();

// set as default and register so that Model can be

// used if desired for save() and update() etc

config.setDefaultServer(true);

config.setRegister(true);

return EbeanServerFactory.create(config);

}

</pre></div>

</div>

<h3>Example test-ebean.properties</h3>

<div class="syntax properties"><div class="highlight"><pre>ebean.db.ddl.generate=true

ebean.db.ddl.run=true

datasource.db.username=sa

datasource.db.password=

datasource.db.databaseUrl=jdbc:h2:mem:tests

datasource.db.databaseDriver=org.h2.Driver

</pre></div>

</div>

<h2 id="mockibean">MockiEbean</h2>

<code>MockiEbean</code> from <code>ebean-mocker</code> project provides a helper object to support mocking the EbeanServer using tools like

<a href="http://code.google.com/p/mockito/">Mockito</a>. If you like the Play/Active record style or Ebean singleton style you can add a test

dependency on ebean-mocker and use MockiEbean to enable use of Mockito and similar tools.

Mocking with Ebean singleton

<code>MockiEbean</code> from ebean-mocker provides a mechanism for using a tool like Mockito and

replacing the default EbeanServer instance with a mock.

<div class="syntax java"><div class="highlight"><pre>...

import io.ebeaninternal.server.core.DefaultServer;

...

@Test

public void testWithMockito() {

EbeanServer defaultServer = Ebean.getServer(null);

assertTrue("is a real EbeanServer", defaultServer instanceof DefaultServer);

Long someBeanId = Long.valueOf(47L);

// Use Mockito to create a mock for the EbeanServer interface

EbeanServer mock = Mockito.mock(EbeanServer.class);

// setup some required behaviour

when(mock.getBeanId(null)).thenReturn(someBeanId);

// ---------------

// 'register' the mock instance into Ebean

// this becomes the 'default EbeanServer' until

// mockiEbean.restoreOriginal() is called

// ---------------

MockiEbean mockiEbean = MockiEbean.start(mock);

try {

// Ebean singleton 'default server' now returns the mock instance

EbeanServer server = Ebean.getDefaultServer();

// always returns the someBeanId setup by Mockito

Object beanId = server.getBeanId(null);

assertEquals(someBeanId, beanId);

} finally {

// ---------------

// restore the original defaultServer instance

// ---------------

mockiEbean.restoreOriginal();

}

EbeanServer restoredServer = Ebean.getDefaultServer();

assertTrue("is a real EbeanServer", restoredServer instanceof DefaultServer);

}

</pre></div>

</div>

<h4>MoickiEbean Maven dependency</h4>

<groupId>io.ebean</groupId>

<artifactId>ebean-mocker</artifactId>

</dependency>

</pre></div>

</div>

<li >

<a href="/docs/setup/enhancement">Enhancement</a>

</li>

<li >

<a href="/docs/setup/eclipse-apt">Eclipse IDE - APT</a>

</li>

<li >

<a href="/docs/setup/logging">Logging</a>

</li>

<li >

<a href="/docs/setup/serverconfig">ServerConfig</a>

</li>

<li >

<a href="/docs/setup/guice">Guice</a>

</li>

<li >

<a href="/docs/setup/spring">Spring</a>

</li>

<li >

<a href="/docs/setup/activerecord">Active Record</a>

</li>

<li >

<a href="/docs/setup/ddl-create-all">DDL - Create All</a>

</li>

<li >

<a href="/docs/setup/dbmigration">DDL - DB Migration</a>

</li>

<li >

<a href="/docs/setup/test-properties"> Test properties</a>

</li>

<a href="/docs/setup/testing">Testing</a>

<li><a href="#mockibean">MockiEbean</a></li>

</ul>

</li>

</ul>

</nav>

</div>

</div>

</div>

<li><a href="/">Ebean ORM</a></li>

<li><a href="http://avaje-metric.github.io">Metrics</a></li>

</ul>

</div>

</footer>

(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){

(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),

m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)

})(window,document,'script','//www.google-analytics.com/analytics.js','ga');

ga('create', 'UA-75181644-1', 'auto');

ga('send', 'pageview');

</script> </body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

testing.html

Latest commit

History

testing.html

File metadata and controls