Skip to content

Latest commit

 

History

History
259 lines (219 loc) · 7.49 KB

Customizations.md

File metadata and controls

259 lines (219 loc) · 7.49 KB
Raw

Customizations

Customize Server Port

Warning: maybe not as stable, as expected.

... by hand

int port = Network.getFreeServerPort();

... or with fixed value

Mongod mongod = Mongod.builder()
  .net(Start.to(Net.class).initializedWith(Net.defaults()
    .withPort(12345)))
  .build();

Customize StartTimeout

Mongod mongod = Mongod.builder()
  .startTimeout(Start.to(StartTimeout.class)
    .initializedWith(StartTimeout.of(30000L)))
  .build();

Customize Download URL

Mongod mongod = new Mongod() {
  @Override
  public Transition<DistributionBaseUrl> distributionBaseUrl() {
    return Start.to(DistributionBaseUrl.class)
      .initializedWith(DistributionBaseUrl.of("http://my.custom.download.domain"));
  }
};

... or just by setting system property 'de.flapdoodle.embed.mongo.baseUrl'.

You can provide basic auth information if needed:

Mongod mongod = new Mongod() {
  @Override
  public Transition<DistributionBaseUrl> distributionBaseUrl() {
    return Start.to(DistributionBaseUrl.class)
      .initializedWith(DistributionBaseUrl.of("http://user:[email protected]"));
  }
};

Customize Proxy for Download

Mongod mongod = new Mongod() {
  @Override
  public DownloadPackage downloadPackage() {
    return DownloadPackage.withDefaults()
      .withDownloadConfig(DownloadConfig.defaults()
        .withProxyFactory(() -> Proxys.httpProxy("fooo", 1234)));
  }
};

... or use system properties as described in JDK Networking Properties. There is also an experimental environment variable support.

Customize Downloader Implementation

DownloadToPath custom = new DownloadToPath() {
  @Override
  public void download(URL url, Path destination,
    Optional<Proxy> proxy, String userAgent, TimeoutConfig timeoutConfig,
    DownloadCopyListener copyListener) throws IOException {
    // download url to destination
  }
};

Mongod mongod = Mongod.instance()
  .withDownloadPackage(DownloadPackage.withDefaults()
    .withDownloadToPath(custom));

Customize Artifact Storage

Mongod mongod = new Mongod() {
  @Override
  public Transition<PersistentDir> persistentBaseDir() {
    return Start.to(PersistentDir.class)
      .providedBy(PersistentDir.inUserHome(".embeddedMongodbCustomPath")
        .mapToUncheckedException(RuntimeException::new));
  }
};

... or just by setting system env variable 'EMBEDDED_MONGO_ARTIFACTS' or system property 'de.flapdoodle.embed.mongo.artifacts'.

Custom database directory

If you set a custom database directory, it will not be deleted after shutdown

Mongod mongod = new Mongod() {
  @Override public Transition<DatabaseDir> databaseDir() {
    return Start.to(DatabaseDir.class).initializedWith(DatabaseDir.of(customDatabaseDir));
  }
};

Usage - custom mongod process output

... to console with line prefix

Mongod mongod = new Mongod() {
  @Override
  public Transition<ProcessOutput> processOutput() {
    return Start.to(ProcessOutput.class)
      .initializedWith(ProcessOutput.builder()
        .output(Processors.namedConsole("[mongod>]"))
        .error(Processors.namedConsole("[MONGOD>]"))
        .commands(Processors.namedConsole("[console>]"))
        .build()
      )
      .withTransitionLabel("create named console");
  }
};

... to file

...
Mongod mongod = new Mongod() {
  @Override
  public Transition<ProcessOutput> processOutput() {
    return Start.to(ProcessOutput.class)
      .providedBy(Try.<ProcessOutput, IOException>supplier(() -> ProcessOutput.builder()
          .output(Processors.named("[mongod>]",
            new FileStreamProcessor(File.createTempFile("mongod", "log"))))
          .error(new FileStreamProcessor(File.createTempFile("mongod-error", "log")))
          .commands(Processors.namedConsole("[console>]"))
          .build())
        .mapToUncheckedException(RuntimeException::new))
      .withTransitionLabel("create named console");
  }
};
...
// ...
public class FileStreamProcessor implements StreamProcessor {

  private final FileOutputStream outputStream;

  public FileStreamProcessor(File file) throws FileNotFoundException {
    outputStream = new FileOutputStream(file);
  }

  @Override
  public void process(String block) {
    try {
      outputStream.write(block.getBytes());
    } catch (IOException e) {
      e.printStackTrace();
    }
  }

  @Override
  public void onProcessed() {
    try {
      outputStream.close();
    } catch (IOException e) {
      e.printStackTrace();
    }
  }

}
// ...
// <-

... to null device

Mongod mongod = new Mongod() {
  @Override public Transition<ProcessOutput> processOutput() {
    return Start.to(ProcessOutput.class)
      .initializedWith(ProcessOutput.silent())
      .withTransitionLabel("no output");
  }
};

try (TransitionWalker.ReachedState<RunningMongodProcess> running = mongod.start(Version.Main.PRODUCTION)) {
  ServerAddress serverAddress = serverAddress(running.current().getServerAddress());
  try (MongoClient mongo = MongoClients.create("mongodb://" + serverAddress)) {
    MongoDatabase db = mongo.getDatabase("test");
    MongoCollection<Document> col = db.getCollection("testCol");
    col.insertOne(new Document("testDoc", new Date()));
...

  }
}

customize package resolver

You can just create your own way to provide a mongodb package...

Mongod customizedInstance = Mongod.instance()
  .withPackageOfDistribution(Start.to(Package.class).providedBy(() -> Package.builder()
    .fileSet(FileSet.builder()
      .addEntry(FileType.Executable, "mongod")
      .build())
    .archiveType(ArchiveType.TGZ)
    .url("http://some-local-server/mongod-to-download")
    .build()));

... or you use some utility classes to create a more complex ruleset for different versions and platforms:

PackageFinderRules mongodPackageRules = PackageFinderRules.builder()
  .addRules(PackageFinderRule.builder()
    .match(PlatformMatch.withOs(CommonOS.Linux).withBitSize(BitSize.B64).withCpuType(CPUType.X86).withVersion(UbuntuVersion.Ubuntu_22_04)
      .andThen(DistributionMatch.any(VersionRange.of("8.0.0", "8.1.0"))
      ))
    .finder(UrlTemplatePackageFinder.builder()
      .fileSet(FileSet.builder()
        .addEntry(FileType.Executable, "mongod")
        .build())
      .archiveType(ArchiveType.TGZ)
      .urlTemplate("/relativePath-{version}.tgz")
      .build())
    .build())
  .addRules(PackageFinderRule.builder()
    .match(PlatformMatch.withOs(CommonOS.Windows)
      .andThen(DistributionMatch.any(VersionRange.of("5.0.0", "10.0.0"))))
    .finder(PackageFinder.failWithMessage(distribution -> "not supported: " + distribution))
    .build())
  .build();

Mongod customizedInstance = Mongod.instance()
  .withDistributionBaseUrl(Start.to(DistributionBaseUrl.class)
    .initializedWith(DistributionBaseUrl.of("http://some-local-server")))
  .withPackageOfDistribution(PackageOfCommandDistribution.withDefaults()
    .withCommandPackageResolver(command -> distribution -> {
      switch (command) {
        case MongoD:
          return mongodPackageRules.packageFor(distribution)
            .orElseThrow(() -> new IllegalArgumentException("could not find package for " + distribution));
        default:
          throw new IllegalArgumentException("not implemented");
      }
    }));