org.opencypher.tools.tck.validateError.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tck-integrity-tests Show documentation
openCypher Technology Compatibility Kit Integrity Tests
The newest version!
/*
 * Copyright (c) 2015-2018 "Neo Technology,"
 * Network Engine for Objects in Lund AB [http://neotechnology.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.tools.tck

import org.opencypher.tools.tck.constants.{TCKErrorDetails, TCKErrorTypes}

/**
  * This function will validate a TCK error specification, which consists of three parts: type, phase and detail. Each
  * of these parts needs to be one of a pre-defined set of constants in order to be valid. If the triple is invalid, a
  * message will be returned explaining the invalid part(s), otherwise None will be returned.
  */
object validateError extends ((String, String, String) => Option[String]) {

  override def apply(typ: String, phase: String, detail: String): Option[String] = {
    val msg = s"""${checkType(typ)}
                 |${checkPhase(phase)}
                 |${checkDetail(detail)}""".stripMargin

    if (msg.trim.isEmpty) None
    else Some(msg)
  }

  def checkType(typ: String): String = {
    if (TCKErrorTypes.ALL(typ)) ""
    else s"Invalid error type: $typ"
  }

  def checkPhase(phase: String): String = {
    if (phase == "runtime" || phase == "compile time") ""
    else s"Invalid error phase: $phase"
  }

  def checkDetail(detail: String): String = {
    if (TCKErrorDetails.ALL(detail)) ""
    else s"Invalid error detail: $detail"
  }

}