org.neo4j.harness.internal.Fixtures Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of neo4j-harness Show documentation
Components for writing integration tests with Neo4j.
There is a newer version: 5.24.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.harness.internal;

import java.io.IOException;
import java.nio.file.DirectoryStream;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.List;
import java.util.function.Function;

import org.neo4j.graphdb.GraphDatabaseService;
import org.neo4j.graphdb.Transaction;

/**
 * Manages user-defined cypher fixtures that can be exercised against the server.
 */
public class Fixtures
{
    private final List fixtureStatements = new ArrayList<>();
    private final List> fixtureFunctions = new ArrayList<>();

    private static final String cypherSuffix = "cyp";

    private final DirectoryStream.Filter cypherFileOrDirectoryFilter = file ->
    {
        if ( Files.isDirectory( file ) )
        {
            return true;
        }
        String[] split = file.getFileName().toString().split( "\\." );
        String suffix = split[split.length - 1];
        return suffix.equals( cypherSuffix );
    };

    public void add( Path fixturePath )
    {
        try
        {
            if ( Files.isDirectory( fixturePath ) )
            {
                try ( DirectoryStream paths = Files.newDirectoryStream( fixturePath, cypherFileOrDirectoryFilter ) )
                {
                    paths.forEach( this::add );
                }
                return;
            }
            add( Files.readString( fixturePath ) );
        }
        catch ( IOException e )
        {
            throw new RuntimeException( "Unable to read fixture file '" + fixturePath.toAbsolutePath() + "': " + e.getMessage(), e );
        }
    }

    public void add( String statement )
    {
        if ( !statement.isBlank() )
        {
            fixtureStatements.add( statement );
        }
    }

    public void add( Function fixtureFunction )
    {
        fixtureFunctions.add( fixtureFunction );
    }

    void applyTo( InProcessNeo4j controls )
    {
        GraphDatabaseService db = controls.defaultDatabaseService();
        for ( String fixtureStatement : fixtureStatements )
        {
            try ( Transaction tx = db.beginTx() )
            {
                tx.execute( fixtureStatement );
                tx.commit();
            }
        }
        for ( Function fixtureFunction : fixtureFunctions )
        {
            fixtureFunction.apply( db );
        }
    }
}