org.neo4j.snapshot.TestVersionContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of it-test-support Show documentation
Neo4j community edition integration tests support.
There is a newer version: 5.25.1
/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [https://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * Neo4j is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package org.neo4j.snapshot;

import java.io.PrintStream;
import org.neo4j.common.DependencyResolver;
import org.neo4j.cypher.internal.javacompat.SnapshotExecutionEngine;
import org.neo4j.dbms.api.DatabaseManagementService;
import org.neo4j.io.pagecache.context.OldestTransactionIdFactory;
import org.neo4j.io.pagecache.context.TransactionIdSnapshot;
import org.neo4j.io.pagecache.context.TransactionIdSnapshotFactory;
import org.neo4j.io.pagecache.context.VersionContext;
import org.neo4j.kernel.impl.context.TransactionVersionContext;
import org.neo4j.kernel.internal.GraphDatabaseAPI;
import org.neo4j.storageengine.api.TransactionIdStore;

/**
 * A {@link VersionContext} that can be injected in tests to verify the behavior of {@link SnapshotExecutionEngine}.
 */
public class TestVersionContext extends TransactionVersionContext {
    private boolean wrongLastClosedTxId;
    private int numIsDirtyCalls;
    private int additionalAttempts;
    private boolean stayDirty;
    private Exception lastMarkAsDirtyCall;
    private Exception additionalAttemptsCall;
    private final String databaseName;

    public TestVersionContext(TransactionIdSnapshotFactory transactionIdSnapshotFactory, String databaseName) {
        this(transactionIdSnapshotFactory, databaseName, true);
    }

    public TestVersionContext(
            TransactionIdSnapshotFactory transactionIdSnapshotFactory,
            String databaseName,
            boolean wrongLastClosedTxId) {
        super(transactionIdSnapshotFactory, OldestTransactionIdFactory.EMPTY_OLDEST_ID_FACTORY);
        this.databaseName = databaseName;
        this.wrongLastClosedTxId = wrongLastClosedTxId;
    }

    @Override
    public long lastClosedTransactionId() {
        return wrongLastClosedTxId ? TransactionIdStore.BASE_TX_ID : super.lastClosedTransactionId();
    }

    @Override
    public void markAsDirty() {
        super.markAsDirty();
        if (!stayDirty) {
            wrongLastClosedTxId = false;
        }
        lastMarkAsDirtyCall = new Exception("markAsDirty");
    }

    @Override
    public boolean isDirty() {
        numIsDirtyCalls++;
        boolean dirty = super.isDirty();
        if (dirty) {
            additionalAttempts++;
            additionalAttemptsCall = new Exception("isDirty");
        }
        return dirty;
    }

    public void printDirtyCalls(PrintStream printStream) {
        if (lastMarkAsDirtyCall != null) {
            lastMarkAsDirtyCall.printStackTrace(printStream);
        } else {
            printStream.println("No last markAsDirty call");
        }

        if (additionalAttemptsCall != null) {
            additionalAttemptsCall.printStackTrace(printStream);
        } else {
            printStream.println("No additionalAttempts call");
        }
    }

    public int getNumIsDirtyCalls() {
        return numIsDirtyCalls;
    }

    public int getAdditionalAttempts() {
        return additionalAttempts;
    }

    public String getDatabaseName() {
        return databaseName;
    }

    public void setWrongLastClosedTxId(boolean wrongLastClosedTxId) {
        this.wrongLastClosedTxId = wrongLastClosedTxId;
    }

    public void stayDirty(boolean stayDirty) {
        this.stayDirty = stayDirty;
    }

    public static TestVersionContext testCursorContext(
            TransactionIdSnapshotFactory snapshotFactory, String databaseName) {
        var context = new TestVersionContext(snapshotFactory, databaseName);
        context.initRead();
        return context;
    }

    public static TestVersionContext testCursorContext(
            DatabaseManagementService managementService, String databaseName) {
        TransactionIdStore transactionIdStore = getTransactionIdStore(managementService, databaseName);
        var context = new TestVersionContext(
                () -> new TransactionIdSnapshot(transactionIdStore.getLastClosedTransactionId()), databaseName);
        context.initRead();
        return context;
    }

    private static TransactionIdStore getTransactionIdStore(
            DatabaseManagementService managementService, String databaseName) {
        DependencyResolver dependencyResolver =
                ((GraphDatabaseAPI) managementService.database(databaseName)).getDependencyResolver();
        return dependencyResolver.resolveDependency(TransactionIdStore.class);
    }
}