org.opencypher.okapi.neo4j.io.testing.Neo4jHarnessUtils.scala Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2016-2019 "Neo4j Sweden, AB" [https://neo4j.com]
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * Attribution Notice under the terms of the Apache License 2.0
 *
 * This work was created by the collective efforts of the openCypher community.
 * Without limiting the terms of Section 6, any Derivative Work that is not
 * approved by the public consensus process of the openCypher Implementers Group
 * should not be described as “Cypher” (and Cypher® is a registered trademark of
 * Neo4j Inc.) or as "openCypher". Extensions by implementers or prototypes or
 * proposals for change that have been documented or implemented should only be
 * described as "implementation extensions to Cypher" or as "proposed changes to
 * Cypher that are not yet approved by the openCypher community".
 */
package org.opencypher.okapi.neo4j.io.testing

import org.neo4j.graphdb.Result
import org.neo4j.harness.{ServerControls, TestServerBuilders}
import org.neo4j.kernel.impl.proc.Procedures
import org.neo4j.kernel.internal.GraphDatabaseAPI
import org.opencypher.okapi.neo4j.io.Neo4jConfig

object Neo4jHarnessUtils {

  implicit class RichServerControls(val neo4j: ServerControls) extends AnyVal {

    def dataSourceConfig =
      Neo4jConfig(neo4j.boltURI(), user = "anonymous", password = Some("password"), encrypted = false)

    def uri: String = {
      val scheme = neo4j.boltURI().getScheme
      val userInfo = s"anonymous:password@"
      val host = neo4j.boltURI().getAuthority
      s"$scheme://$userInfo$host"
    }

    def stop(): Unit = {
      neo4j.close()
    }

    def execute(cypher: String): Result =
      neo4j.graph().execute(cypher)

    def withProcedure(procedures: Class[_]*): ServerControls = {
      val proceduresService = neo4j.graph()
        .asInstanceOf[GraphDatabaseAPI]
        .getDependencyResolver.
        resolveDependency(classOf[Procedures])

      for (procedure <- procedures) {
        proceduresService.registerProcedure(procedure, true)
        proceduresService.registerFunction(procedure, true)
        proceduresService.registerAggregationFunction(procedure, true)
      }
      neo4j
    }
  }

  def startNeo4j(dataFixture: String): ServerControls = {
    TestServerBuilders
      .newInProcessBuilder()
      .withConfig("dbms.security.auth_enabled", "true")
      .withFixture("CALL dbms.security.createUser('anonymous', 'password', false)")
      .withFixture(dataFixture)
      .newServer()
  }
}