org.neo4j.gds.QueryRunner Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of test-utils Show documentation
Neo4j Graph Data Science :: Test Utils
There is a newer version: 2.11.0
/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [http://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.gds;

import org.apache.commons.lang3.mutable.MutableLong;
import org.intellij.lang.annotations.Language;
import org.jetbrains.annotations.TestOnly;
import org.neo4j.gds.compat.GraphDatabaseApiProxy;
import org.neo4j.gds.compat.Neo4jProxy;
import org.neo4j.graphdb.GraphDatabaseService;
import org.neo4j.graphdb.Result;
import org.neo4j.graphdb.Transaction;
import org.neo4j.internal.kernel.api.security.AuthSubject;

import java.util.Map;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;

import static java.util.Collections.emptyMap;
import static org.junit.jupiter.api.Assertions.fail;
import static org.neo4j.gds.compat.GraphDatabaseApiProxy.applyInFullAccessTransaction;
import static org.neo4j.gds.compat.GraphDatabaseApiProxy.runInFullAccessTransaction;
import static org.neo4j.gds.compat.GraphDatabaseApiProxy.runQueryWithoutClosingTheResult;
import static org.neo4j.gds.utils.StringFormatting.formatWithLocale;
import static org.neo4j.internal.kernel.api.security.AccessMode.Static.READ;

public final class QueryRunner {

    private static final Result.ResultVisitor CONSUME_ROWS = ignore -> true;

    private QueryRunner() {}

    @TestOnly
    public static long runQueryWithRowConsumer(
        GraphDatabaseService db,
        String username,
        @Language("Cypher") String query,
        Map params,
        BiConsumer rowConsumer
    ) {
        var rowCounter = new MutableLong();

        runWithUsername(username, db, tx -> {
            try (
                Result result = runQueryWithoutClosingTheResult(tx, query, params)
            ) {
                result.accept(row -> {
                    rowConsumer.accept(tx, row);
                    rowCounter.increment();

                    return true;
                });
            }
        });

        return rowCounter.longValue();
    }

    public static long runQueryWithRowConsumer(
        GraphDatabaseService db,
        @Language("Cypher") String query,
        Map params,
        BiConsumer rowConsumer
    ) {
        var rowCounter = new MutableLong();
        runInFullAccessTransaction(db, tx -> {
            try (Result result = runQueryWithoutClosingTheResult(tx, query, params)) {
                result.accept(row -> {
                    rowConsumer.accept(tx, row);
                    rowCounter.increment();

                    return true;
                });
            }
        });

        return rowCounter.longValue();
    }

    public static long runQueryWithRowConsumer(
        GraphDatabaseService db,
        @Language("Cypher") String query,
        Consumer rowConsumer
    ) {
        var rowCounter = new MutableLong();
        runInFullAccessTransaction(db, tx -> {
            try (Result result = runQueryWithoutClosingTheResult(tx, query, emptyMap())) {
                result.accept(row -> {
                    rowConsumer.accept(row);
                    rowCounter.increment();

                    return true;
                });
            }
        });

        return rowCounter.longValue();
    }

    public static void runQuery(GraphDatabaseService db, @Language("Cypher") String query) {
        runQuery(db, query, emptyMap());
    }

    public static void runQuery(GraphDatabaseService db, @Language("Cypher") String query, Map params) {
        runInFullAccessTransaction(db, tx -> {
            try (Result result = runQueryWithoutClosingTheResult(tx, query, params)) {
                result.accept(CONSUME_ROWS);
            }
        });
    }

    @TestOnly
    public static  T runQuery(
        GraphDatabaseService db,
        String username,
        @Language("Cypher") String query,
        Map params,
        Function resultFunction
    ) {
        return applyWithUsername(username, db, tx -> {
            try (
                Result result = runQueryWithoutClosingTheResult(tx, query, params)
            ) {
                return resultFunction.apply(result);
            }
        });
    }

    @TestOnly
    public static void runQuery(
        GraphDatabaseService db,
        String username,
        @Language("Cypher") String query,
        Map params
    ) {
        runWithUsername(username, db, tx -> {
            try (
                Result result = runQueryWithoutClosingTheResult(tx, query, params)
            ) {
                result.accept(CONSUME_ROWS);
            }
        });
    }

    public static  T runQuery(
        GraphDatabaseService db,
        @Language("Cypher") String query,
        Function resultFunction
    ) {
        return runQuery(db, query, emptyMap(), resultFunction);
    }

    public static  T runQuery(
        GraphDatabaseService db,
        @Language("Cypher") String query,
        Map params,
        Function resultFunction
    ) {
        return applyInFullAccessTransaction(db, tx -> {
            try (var result = runQueryWithoutClosingTheResult(tx, query, params)) {
                return resultFunction.apply(result);
            }
        });
    }

    public static void runQueryWithResultConsumer(
        GraphDatabaseService db,
        @Language("Cypher") String query,
        Map params,
        Consumer resultConsumer
    ) {
        runInFullAccessTransaction(db, tx -> {
            try (var result = runQueryWithoutClosingTheResult(tx, query, params)) {
                resultConsumer.accept(result);
            }
        });
    }

    @TestOnly
    public static void runQueryWithResultConsumer(
        GraphDatabaseService db,
        String username,
        @Language("Cypher") String query,
        Map params,
        Consumer resultConsumer
    ) {
        runWithUsername(username, db, tx -> {
            try (var result = runQueryWithoutClosingTheResult(tx, query, params)) {
                resultConsumer.accept(result);
            }
        });
    }

    public static void runFailingQuery(
        GraphDatabaseService db,
        String query,
        Map queryParameters,
        Consumer exceptionConsumer
    ) {
        try {
            QueryRunner.runQueryWithResultConsumer(db, query, queryParameters, Result::resultAsString);
            fail(formatWithLocale("Expected an exception to be thrown by query:\n%s", query));
        } catch (Throwable e) {
            exceptionConsumer.accept(e);
        }
    }

    @TestOnly
    private static void runWithUsername(
        String username,
        GraphDatabaseService db,
        Consumer block
    ) {
        var securityContext = Neo4jProxy.securityContext(username, AuthSubject.AUTH_DISABLED, READ, db.databaseName());
        GraphDatabaseApiProxy.runInTransaction(db, securityContext, block);
    }

    @TestOnly
    private static  T applyWithUsername(
        String username,
        GraphDatabaseService db,
        Function block
    ) {
        var securityContext = Neo4jProxy.securityContext(username, AuthSubject.AUTH_DISABLED, READ, db.databaseName());
        return GraphDatabaseApiProxy.applyInTransaction(db, securityContext, block);
    }
}