io.vertx.ext.embeddedmongo.EmbeddedMongoVerticle Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vertx-mongo-embedded-db Show documentation
There is a newer version: 3.9.16
Show newest version
/*
 * Copyright 2014 Red Hat, Inc.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * and Apache License v2.0 which accompanies this distribution.
 *
 * The Eclipse Public License is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * The Apache License v2.0 is available at
 * http://www.opensource.org/licenses/apache2.0.php
 *
 * You may elect to redistribute this code under either of these licenses.
 */

package io.vertx.ext.embeddedmongo;

import de.flapdoodle.embed.mongo.Command;
import de.flapdoodle.embed.mongo.MongodExecutable;
import de.flapdoodle.embed.mongo.MongodStarter;
import de.flapdoodle.embed.mongo.config.IMongodConfig;
import de.flapdoodle.embed.mongo.config.MongodConfigBuilder;
import de.flapdoodle.embed.mongo.config.Net;
import de.flapdoodle.embed.mongo.config.RuntimeConfigBuilder;
import de.flapdoodle.embed.mongo.distribution.Version;
import de.flapdoodle.embed.process.config.IRuntimeConfig;
import de.flapdoodle.embed.process.runtime.Network;
import io.vertx.core.AbstractVerticle;
import io.vertx.core.Context;
import io.vertx.core.json.JsonObject;
import io.vertx.core.logging.SLF4JLogDelegateFactory;
import org.slf4j.Logger;

/**
 * This verticle wraps an embedded MongoDB instance.
 * 
 * The following {@link Context#config()} options are supported:
 * 

 *     "port" (int, default 0): The port to host Mongo on, or 0 for any port.
 *     "version" (String, default "3.4.3"): The Mongo version, up to 3.6.2. Note 3.4.3 is the last version to work
 *         correctly on Windows.
 * 
 * 
 * It's useful if you have an application that uses MongoDB and you want to write unit tests for it
 * that run without having to manually set-up a MongoDB.
 * 
 * Just deploy the verticle before your test.
 *
 * @author Tim Fox
 */
public class EmbeddedMongoVerticle extends AbstractVerticle {

  private MongodExecutable exe;
  private int actualPort;

  @Override
  public void start() throws Exception {

    if (vertx != null && !context.isWorkerContext()) {
      throw new IllegalStateException("Must be started as worker verticle!");
    }

    JsonObject config = context.config();

    int port = config.getInteger("port", 0);
    // mongod version 3.4.3 is the last to work properly on Windows 10, so this is the default version for this package
    // See https://jira.mongodb.org/browse/SERVER-26028
    String version = config.getString("version", "3.4.3");
    // The flapdoodle enum names are unconventional
    version = "V" + version.replace('.', '_');
    final Version versionEnum = Version.valueOf(version);

    IMongodConfig embeddedConfig = new MongodConfigBuilder().
      version(versionEnum).
      net(port == 0 ? new Net() : new Net(port, Network.localhostIsIPv6())).
      build();

    Logger logger = (Logger) new SLF4JLogDelegateFactory()
      .createDelegate(EmbeddedMongoVerticle.class.getCanonicalName()).unwrap();

    IRuntimeConfig runtimeConfig = new RuntimeConfigBuilder()
      .defaultsWithLogger(Command.MongoD, logger)
      .build();

    exe = MongodStarter.getInstance(runtimeConfig).prepare(embeddedConfig);
    exe.start();

    actualPort = embeddedConfig.net().getPort();
  }

  public int actualPort() {
    return actualPort;
  }

  @Override
  public void stop() {
    exe.stop();
  }
}