com.dimajix.flowman.spec.assertion.AssertionSpec.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of flowman-spec Show documentation
A Spark based ETL tool
There is a newer version: 1.2.0-synapse3.3-spark3.3-hadoop3.3
/*
 * Copyright (C) 2021 The Flowman Authors
 *
 * 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.
 */

package com.dimajix.flowman.spec.assertion

import com.fasterxml.jackson.annotation.JsonProperty
import com.fasterxml.jackson.annotation.JsonProperty.Access
import com.fasterxml.jackson.annotation.JsonSubTypes
import com.fasterxml.jackson.annotation.JsonTypeInfo
import com.fasterxml.jackson.databind.annotation.JsonTypeResolver

import com.dimajix.common.TypeRegistry
import com.dimajix.flowman.execution.Context
import com.dimajix.flowman.model.Assertion
import com.dimajix.flowman.model.Category
import com.dimajix.flowman.model.Metadata
import com.dimajix.flowman.spec.NamedSpec
import com.dimajix.flowman.spec.annotation.AssertionType
import com.dimajix.flowman.spec.template.CustomTypeResolverBuilder
import com.dimajix.flowman.spi.ClassAnnotationHandler


object AssertionSpec extends TypeRegistry[AssertionSpec] {
    final class NameResolver extends NamedSpec.NameResolver[AssertionSpec]
}


@JsonTypeResolver(classOf[CustomTypeResolverBuilder])
@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, property = "kind", visible = true)
@JsonSubTypes(value = Array(
    new JsonSubTypes.Type(name = "expression", value = classOf[ExpressionAssertionSpec]),
    new JsonSubTypes.Type(name = "columns", value = classOf[ColumnsAssertionSpec]),
    new JsonSubTypes.Type(name = "schema", value = classOf[SchemaAssertionSpec]),
    new JsonSubTypes.Type(name = "sql", value = classOf[SqlAssertionSpec]),
    new JsonSubTypes.Type(name = "uniqueKey", value = classOf[UniqueKeyAssertionSpec])
))
abstract class AssertionSpec  extends NamedSpec[Assertion] {
    @JsonProperty(value="kind", access=Access.WRITE_ONLY, required = true) protected var kind: String = _
    @JsonProperty(value="description", required = false) private var description: Option[String] = None

    override def instantiate(context: Context, properties:Option[Assertion.Properties] = None): Assertion

    override protected def instanceProperties(context:Context, properties:Option[Assertion.Properties]) : Assertion.Properties = {
        require(context != null)
        val name = context.evaluate(this.name)
        val props = Assertion.Properties(
            context,
            metadata.map(_.instantiate(context, name, Category.ASSERTION, kind)).getOrElse(Metadata(context, name, Category.ASSERTION, kind)),
            context.evaluate(description)
        )
        properties.map(p => props.merge(p)).getOrElse(props)
    }
}


class AssertionSpecAnnotationHandler extends ClassAnnotationHandler {
    override def annotation: Class[_] = classOf[AssertionType]

    override def register(clazz: Class[_]): Unit =
        AssertionSpec.register(clazz.getAnnotation(classOf[AssertionType]).kind(), clazz.asInstanceOf[Class[_ <: AssertionSpec]])
}