io.camunda.zeebe.process.test.engine.db.InMemoryDbTransaction Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of zeebe-process-test-engine Show documentation

Test engine for running process tests. This a minimized version of the real Zeebe engine and should be used for testing purposes only.

There is a newer version: 8.7.0-alpha1

Show newest version

/*
 * Copyright Camunda Services GmbH and/or licensed to Camunda Services GmbH under
 * one or more contributor license agreements. See the NOTICE file distributed
 * with this work for additional information regarding copyright ownership.
 * Licensed under the Zeebe Community License 1.1. You may not use this file
 * except in compliance with the Zeebe Community License 1.1.
 */
package io.camunda.zeebe.process.test.engine.db;

import io.camunda.zeebe.db.DbValue;
import io.camunda.zeebe.db.TransactionOperation;
import io.camunda.zeebe.db.ZeebeDbTransaction;
import java.util.HashSet;
import java.util.TreeMap;

/**
 * In memory implementation of {@code ZeebeDbTransaction}
 *
 * This implementation maintains a transaction cache and a list of deleted keys to capture the
 * changes performed during the transaction. Upon commit, the changes of this transaction are
 * written into the database, This transaction reads with "read committed" isolation level.
 *
 * There is no locking mechanism between transactions.
 */
final class InMemoryDbTransaction implements ZeebeDbTransaction, InMemoryDbState {

  private final TreeMap database;
  private final TreeMap transactionCache = new TreeMap<>();
  private final HashSet deletedKeys = new HashSet<>();
  private boolean inCurrentTransaction = false;

  InMemoryDbTransaction(final TreeMap database) {
    this.database = database;
  }

  void resetTransaction() {
    rollback();
    inCurrentTransaction = true;
  }

  public boolean isInCurrentTransaction() {
    return inCurrentTransaction;
  }

  @Override
  public void run(final TransactionOperation operations) throws Exception {
    operations.run();
  }

  @Override
  public void commit() {
    inCurrentTransaction = false;
    database.putAll(transactionCache);
    deletedKeys.forEach(database::remove);
    deletedKeys.clear();
    transactionCache.clear();
  }

  @Override
  public void rollback() {
    inCurrentTransaction = false;
    deletedKeys.clear();
    transactionCache.clear();
  }

  @Override
  public void put(final FullyQualifiedKey fullyQualifiedKey, final DbValue value) {
    deletedKeys.remove(fullyQualifiedKey.getKeyBytes());
    transactionCache.put(fullyQualifiedKey.getKeyBytes(), Bytes.fromDbValue(value));
  }

  @Override
  public byte[] get(final FullyQualifiedKey fullyQualifiedKey) {
    final Bytes key = fullyQualifiedKey.getKeyBytes();

    if (deletedKeys.contains(key)) {
      return null;
    }

    final Bytes valueInCache = transactionCache.get(key);

    if (valueInCache != null) {
      return valueInCache.toBytes();
    }

    final Bytes valueInDatabase = database.get(key);

    if (valueInDatabase != null) {
      return valueInDatabase.toBytes();
    } else {
      return null;
    }
  }

  @Override
  public void delete(final FullyQualifiedKey fullyQualifiedKey) {
    final Bytes keyBytes = fullyQualifiedKey.getKeyBytes();
    transactionCache.remove(keyBytes);
    deletedKeys.add(keyBytes);
  }

  @Override
  public InMemoryDbIterator newIterator() {
    final TreeMap snapshot = new TreeMap<>();
    snapshot.putAll(database);
    snapshot.putAll(transactionCache);
    deletedKeys.forEach(snapshot::remove);

    return new InMemoryDbIterator(snapshot);
  }

  @Override
  public boolean contains(final FullyQualifiedKey fullyQualifiedKey) {
    final Bytes keyBytes = fullyQualifiedKey.getKeyBytes();
    return !deletedKeys.contains(keyBytes)
        && (transactionCache.containsKey(keyBytes) || database.containsKey(keyBytes));
  }
}