ModelBuilderTest.scala

package com.typesafe.slick.testkit.tests

import com.typesafe.slick.testkit.util.{AsyncTest, JdbcTestDB}

import org.junit.Assert._


import slick.ast.ColumnOption
import slick.model._
import slick.jdbc.SQLiteProfile
import slick.jdbc.meta.MTable
import slick.relational.RelationalProfile
import slick.sql.SqlProfile

@deprecated("Using deprecated .simple API", "3.0")
class ModelBuilderTest extends AsyncTest[JdbcTestDB] {
  import tdb.profile.api._

  class Categories(tag: Tag) extends Table[(Int, String)](tag, "categories") {
    def id = column[Int]("id", O.PrimaryKey, O.AutoInc)
    def name = column[String]("name", O.SqlType("VARCHAR(123)"))
    def * = (id, name)
    def idx = index("IDX_NAME",name)
  }
  val categories = TableQuery[Categories]

  class Posts(tag: Tag) extends Table[(Int, String, Option[Int], Boolean, String)](tag, "posts") {
    def id = column[Int]("id")
    def title = column[String]("title",O.Length(99,varying=false)) // tests Length produces valid SQL
    def category = column[Option[Int]]("category",O.Default(Some(531)))
    def someBool = column[Boolean]("some_bool",O.Default(true)) // tests boolean default values parsing
    def someString = column[String]("some_string",O.Length(111,varying=true)) // tests Length produces valid SQL
    def * = (id, title, category, someBool, someString)
    def pk = primaryKey("posts_pk", (id,title))
    def categoryFK = foreignKey("category_fk", category, categories)(_.id.?)
  }
  val posts = TableQuery[Posts]

  class DefaultTest(tag: Tag) extends Table[(Boolean, Boolean, Boolean, Option[Boolean], Option[Boolean], Option[Boolean], String, String, String, Option[String], Option[String], Option[String], Option[String])](tag, "default_test") {
    def someBool = column[Boolean]("some_bool")
    def someBoolDefaultTrue = column[Boolean]("some_bool_default_true",O.Default(true))
    def someBoolDefaultFalse = column[Boolean]("some_bool_default_false",O.Default(false))
    def someBoolOption = column[Option[Boolean]]("some_bool_option")
    def someBoolOptionDefaultSome = column[Option[Boolean]]("some_bool_option_default_some",O.Default(Some(true)))
    def someBoolOptionDefaultNone = column[Option[Boolean]]("some_bool_option_default_none",O.Default(None))
    def someString = column[String]("some_string")
    def someStringDefaultNonEmpty = column[String]("some_string_default_non_empty",O.Default("bar"),O.Length(254))
    def someStringDefaultEmpty = column[String]("some_string_default_empty",O.Default(""),O.Length(254))
    def someStringOption = column[Option[String]]("some_string_option")
    def someStringOptionDefaultEmpty = column[Option[String]]("str_option_default_empty",O.Default(Some("")),O.Length(254))
    def someStringOptionDefaultNone = column[Option[String]]("str_option_default_none",O.Default(None))
    def someStringOptionDefaultNonEmpty = column[Option[String]]("str_option_default_non_empty",O.Default(Some("foo")),O.Length(254))
    def * = (someBool,someBoolDefaultTrue,someBoolDefaultFalse,someBoolOption,someBoolOptionDefaultSome,someBoolOptionDefaultNone,someString,someStringDefaultNonEmpty,someStringDefaultEmpty,someStringOption,someStringOptionDefaultEmpty,someStringOptionDefaultNonEmpty,someStringOptionDefaultNone)
  }
  val defaultTest = TableQuery[DefaultTest]
  class NoDefaultTest(tag: Tag) extends Table[(Int,Option[String],Option[String])](tag, "no_default_test") {
    def int = column[Int]("int")
    def stringOption = column[Option[String]]("stringOption")
    def stringOptionDefaultNone = column[Option[String]]("stringOptionDefaultNone",O.Default(None))
    def * = (int,stringOption,stringOptionDefaultNone)
  }
  val noDefaultTest = TableQuery[NoDefaultTest]

  class TypeTest(tag: Tag) extends Table[(
    String,Boolean,Byte,Short,Int,Long,Float,Double,String,java.sql.Date,java.sql.Time,java.sql.Timestamp,java.sql.Blob//,java.sql.Clob
      ,Option[Int]
      ,(
        Option[Boolean],Option[Byte],Option[Short],Option[Int],Option[Long],Option[Float],Option[Double],Option[String],Option[java.sql.Date],Option[java.sql.Time],Option[java.sql.Timestamp],Option[java.sql.Blob]//,Option[java.sql.Clob]
      )
    )](tag, "TYPE_TEST") {
    def `type` = column[String]("type") // <- test escaping of keywords
    def Boolean = column[Boolean]("Boolean",O.Default(true))
    def Byte = column[Byte]("Byte")
    def Short = column[Short]("Short")
    def Int = column[Int]("Int",O.Default(-5))
    def Long = column[Long]("Long",O.Default(5L))
    //def java_math_BigInteger = column[java.math.BigInteger]("java_math_BigInteger")
    def Float = column[Float]("Float",O.Default(9.999F))
    def Double = column[Double]("Double",O.Default(9.999))
    //def java_math_BigDecimal = column[java.math.BigDecimal]("java_math_BigDecimal")
    def String = column[String]("String",O.Default("someDefaultString"), O.Length(254))
    def java_sql_Date = column[java.sql.Date]("java_sql_Date")
    def java_sql_Time = column[java.sql.Time]("java_sql_Time")
    def java_sql_Timestamp = column[java.sql.Timestamp]("java_sql_Timestamp")
    def java_sql_Blob = column[java.sql.Blob]("java_sql_Blob")
    //def java_sql_Clob = column[java.sql.Clob]("java_sql_Clob")

    def None_Int = column[Option[Int]]("None_Int",O.Default(None))

    def Option_Boolean = column[Option[Boolean]]("Option_Boolean",O.Default(Some(true)))
    def Option_Byte = column[Option[Byte]]("Option_Byte")
    def Option_Short = column[Option[Short]]("Option_Short")
    def Option_Int = column[Option[Int]]("Option_Int",O.Default(Some(5)))
    def Option_Long = column[Option[Long]]("Option_Long",O.Default(Some(-5L)))
    //def java_math_BigInteger = column[Option[java.math.BigInteger]]("java_math_BigInteger")
    def Option_Float = column[Option[Float]]("Option_Float",O.Default(Some(9.999F)))
    def Option_Double = column[Option[Double]]("Option_Double",O.Default(Some(9.999)))
    //def java_math_BigDecimal = column[Option[java.math.BigDecimal]]("java_math_BigDecimal")
    def Option_String = column[Option[String]]("Option_String",O.Default(Some("someDefaultString")), O.Length(254))
    def Option_java_sql_Date = column[Option[java.sql.Date]]("Option_java_sql_Date")
    def Option_java_sql_Time = column[Option[java.sql.Time]]("Option_java_sql_Time")
    def Option_java_sql_Timestamp = column[Option[java.sql.Timestamp]]("Option_java_sql_Timestamp")
    def Option_java_sql_Blob = column[Option[java.sql.Blob]]("Option_java_sql_Blob")
    def Option_java_sql_Option_Blob = column[Option[Option[java.sql.Blob]]]("Option_java_sql_Blob")
    //def Option_java_sql_Clob = column[Option[java.sql.Clob]]("Option_java_sql_Clob")
    def * = (
      `type`,
      Boolean,Byte,Short,Int,Long,Float,Double,String,java_sql_Date,java_sql_Time,java_sql_Timestamp,java_sql_Blob//,java_sql_Clob
      ,None_Int
      ,(
        Option_Boolean,Option_Byte,Option_Short,Option_Int,Option_Long,Option_Float,Option_Double,Option_String,Option_java_sql_Date,Option_java_sql_Time,Option_java_sql_Timestamp,Option_java_sql_Blob//,Option_java_sql_Clob
      )
    )
    def pk = primaryKey("PK", (Int,Long))
  }
  val typeTest = TableQuery[TypeTest]

  def test = ifCap(jcap.createModel) {
    def createModel(tables: Option[Seq[MTable]] = None, ignoreInvalidDefaults: Boolean = true) =
      tdb.profile.createModel(tables.map(DBIO.successful), ignoreInvalidDefaults)

    // postgres uses lower case and things like int4
    // seen in jtds: int identity
    // seen in oracle: VARCHAR2
    val DBTypePattern = "^[a-zA-Z][a-zA-Z0-9 ]*$".r

    for {
      _ <- (posts.schema ++ categories.schema ++ defaultTest.schema ++ noDefaultTest.schema ++ typeTest.schema).create
      _ <- createModel(ignoreInvalidDefaults=false).map(_.assertConsistency)
      tables <- tdb.profile.defaultTables
      _ <- createModel(Some(tables), ignoreInvalidDefaults = false).map(_.assertConsistency)
      // checks that createModel filters out foreign keys pointing out
      _ <- createModel(Some(tables.filter(_.name.name.toUpperCase=="POSTS")), ignoreInvalidDefaults = false).map { model =>
        model.assertConsistency
        assertEquals( 0, model.tables.map(_.foreignKeys.size).sum )
      }
      _ <- createModel(Some(tables.filter(_.name.name.toUpperCase=="CATEGORIES")), ignoreInvalidDefaults = false).map(_.assertConsistency)
      // checks that assertConsistency fails when manually feeding the model with inconsistent tables
      _ <- createModel(Some(tables), ignoreInvalidDefaults = false).map { m =>
        Model(m.tables.filter(_.name.table.toUpperCase=="POSTS")).shouldFail(_.assertConsistency)
      }
      model <- createModel(ignoreInvalidDefaults=false)
      _ = {
        // check that the model matches the table classes
        assertEquals( model.tables.toString, 5, model.tables.size )
        val categories = model.tables.filter(_.name.table.toUpperCase=="CATEGORIES").head
        assertEquals( 2, categories.columns.size )
        assertEquals( None, categories.primaryKey )
        assertEquals( 0, categories.foreignKeys.size )
        assertEquals( List("id"), categories.columns.filter(_.options.exists(_ == ColumnOption.PrimaryKey)).map(_.name).toList )
        assertEquals(
          (123,true),
          categories.columns.filter(_.name == "name").head
            .options.collect{case RelationalProfile.ColumnOption.Length(length,varying) => (length,varying)}.head
        )
        //assertEquals( categories.indices.toString, 1, categories.indices.size ) // Removed until made sure all dbs actually produce indices model
        //assertEquals( "IDX_NAME", categories.indices.head.name.get.toUpperCase )
        categories.columns.foreach{
          _.options.foreach{
            case RelationalProfile.ColumnOption.Length(length,varying) => length < 256
            case SqlProfile.ColumnOption.SqlType(DBTypePattern()) =>
            case SqlProfile.ColumnOption.SqlType(dbType) => assert(false, "invalid DBType: "+dbType)
            case _ =>
          }
        }
      }
      _ = {
        val posts = model.tables.filter(_.name.table.toUpperCase=="POSTS").head
        assertEquals( 5, posts.columns.size )
        assertEquals( posts.indices.toString, 0, posts.indices.size )
        if(tdb.profile != SQLiteProfile) {
          // Reporting of multi-column primary keys through JDBC metadata is broken in Xerial SQLite 3.8:
          // https://bitbucket.org/xerial/sqlite-jdbc/issue/107/databasemetadatagetprimarykeys-does-not
          assertEquals( Some(2), posts.primaryKey.map(_.columns.size) )
          assert( !posts.columns.exists(_.options.exists(_ == ColumnOption.PrimaryKey)) )
        }
        assertEquals( 1, posts.foreignKeys.size )
        if(tdb.profile != slick.jdbc.SQLiteProfile){
          assertEquals( "CATEGORY_FK", posts.foreignKeys.head.name.get.toUpperCase )
        }
        def tpe(col:String) = posts.columns.filter(_.name == col).head
          .options.collect{case SqlProfile.ColumnOption.SqlType(tpe) => tpe}.head
        assert(
          Seq(
            "CHAR","CHARACTER",
            "BPCHAR" // bpchar: postgres
            //"char" // jtds
          ) contains tpe("title").toUpperCase,
          tpe("title")
        )
        assert(
          Seq(
            "VARCHAR",
            "VARCHAR2" // oracle
          ) contains tpe("some_string").toUpperCase,
          tpe("title")
        )
        assertEquals(
          (99,false),
          posts.columns.filter(_.name == "title").head
            .options.collect{case RelationalProfile.ColumnOption.Length(length,varying) => (length,varying)}.head
        )
        assertEquals(
          (111,true),
          posts.columns.filter(_.name == "some_string").head
            .options.collect{case RelationalProfile.ColumnOption.Length(length,varying) => (length,varying)}.head
        )
        posts.columns.foreach{
          _.options.foreach{
            case RelationalProfile.ColumnOption.Length(length,varying) => length < 256
            case SqlProfile.ColumnOption.SqlType(DBTypePattern()) =>
            case SqlProfile.ColumnOption.SqlType(dbType) => assert(false, "invalid DBType: "+dbType)
            case _ =>
          }
        }
      }
      _ = {
        val defaultTest = model.tables.filter(_.name.table.toUpperCase=="DEFAULT_TEST").head
        assert(Some("PUBLIC") != defaultTest.name.schema.map(_.toUpperCase))
        assert(Some("PUBLIC") != defaultTest.name.catalog.map(_.toUpperCase))
        ifCapU(jcap.defaultValueMetaData){
          def column(name: String)
          = defaultTest.columns.filter(_.name == name).head
          def columnDefault(name: String)
          = column(name)
            .options.collect{case RelationalProfile.ColumnOption.Default(v) => v}
            .headOption
          assertEquals(None, columnDefault("some_bool"))
          ifCapU(jcap.booleanMetaData){
            assertEquals(Some(true), columnDefault("some_bool_default_true"))
          }
          ifNotCapU(jcap.booleanMetaData){
            assertEquals(false,column("some_bool_default_true").nullable)
            assert( Seq(Some(1),Some('1')).contains(
              columnDefault("some_bool_default_true")
            ), columnDefault("some_bool_default_true").toString )
          }
          ifCapU(jcap.booleanMetaData){
            assertEquals(Some(false), columnDefault("some_bool_default_false"))
          }
          ifNotCapU(jcap.booleanMetaData){
            assert( Seq(Some(0),Some('0')).contains(
              columnDefault("some_bool_default_false")
            ), columnDefault("some_bool_default_false").toString )
          }
          ifCapU(jcap.nullableNoDefault){
            assertEquals(None,columnDefault("some_bool_option"))
          }
          ifNotCapU(jcap.nullableNoDefault){
            assertEquals(Some(None),columnDefault("some_bool_option"))
          }
          ifCapU(jcap.booleanMetaData){
            assertEquals(Some(Some(true)), columnDefault("some_bool_option_default_some"))
          }
          ifNotCapU(jcap.booleanMetaData){
            assert( Seq(Some(Some(1)),Some(Some('1'))).contains(
              columnDefault("some_bool_option_default_some")
            ), columnDefault("some_bool_option_default_some").toString )
          }
          assertEquals(Some(None),columnDefault("some_bool_option_default_none"))
          assertEquals(None,columnDefault("some_string"))
          assertEquals(Some("bar"),columnDefault("some_string_default_non_empty"))
          assertEquals(Some(""),columnDefault("some_string_default_empty"))
          ifCapU(jcap.nullableNoDefault){
            assertEquals(None,columnDefault("some_string_option"))
          }
          ifNotCapU(jcap.nullableNoDefault){
            assertEquals(Some(None),columnDefault("some_string_option"))
          }
          assertEquals(Some(Some("")),columnDefault("str_option_default_empty"))
          assertEquals(Some(None),columnDefault("str_option_default_none"))
          assertEquals(Some(Some("foo")),columnDefault("str_option_default_non_empty"))
        }
      }
      _ = {
        val typeTest = model.tables.filter(_.name.table.toUpperCase=="TYPE_TEST").head
        def column(name: String)
        = typeTest.columns.filter(_.name.toUpperCase == name.toUpperCase).head
        def columnDefault(name: String)
        = column(name)
          .options.collect{case RelationalProfile.ColumnOption.Default(v) => v}
          .headOption

        ifCapU(jcap.booleanMetaData){
          assertEquals("Boolean",column("Boolean").tpe)
          assertEquals("Boolean",column("Option_Boolean").tpe)
        }
        assertEquals(false,column("Boolean").nullable)
        assertEquals(true,column("Option_Boolean").nullable)

        ifCapU(jcap.supportsByte){
          assertEquals("Byte",column("Byte").tpe)
          assertEquals("Byte",column("Option_Byte").tpe)
        }
        assertEquals(false,column("Byte").nullable)
        assertEquals(true,column("Option_Byte").nullable)

        ifCapU(jcap.distinguishesIntTypes){
          assertEquals("Short",column("Short").tpe)
          assertEquals("Short",column("Option_Short").tpe)
        }
        assertEquals(false,column("Short").nullable)
        assertEquals(true,column("Option_Short").nullable)

        assertEquals(false,column("Int").nullable)
        assertEquals(true,column("Option_Int").nullable)
        assertEquals(false,column("Long").nullable)
        assertEquals(true,column("Option_Long").nullable)
        if(!tdb.profile.toString.contains("OracleProfile")){// FIXME: we should probably solve this somewhat cleaner
          assertEquals("Int",column("Int").tpe)
          assertEquals("Int",column("Option_Int").tpe)
          ifCapU(jcap.defaultValueMetaData){
            assertEquals(Some(-5), columnDefault("Int"))
            assertEquals(Some(Some(5)), columnDefault("Option_Int"))
          }
          ifCapU(jcap.distinguishesIntTypes){
            assertEquals("Long",column("Long").tpe)
            assertEquals("Long",column("Option_Long").tpe)
          }
          ifCapU(jcap.defaultValueMetaData){
            assertEquals(Some(5L), columnDefault("Long"))
            assertEquals(Some(Some(-5L)), columnDefault("Option_Long"))
          }
        }
        /* h2 and hsqldb map this to Double
        assertEquals("Float",column("Float").tpe)
        assertEquals("Float",column("Option_Float").tpe)
        assertEquals(false,column("Float").nullable)
        assertEquals(true,column("Option_Float").nullable)
        */
        assertEquals("Double",column("Double").tpe)
        assertEquals("Double",column("Option_Double").tpe)
        assertEquals(false,column("Double").nullable)
        assertEquals(true,column("Option_Double").nullable)

        assertEquals("String",column("String").tpe)
        assertEquals("String",column("Option_String").tpe)
        assertEquals(false,column("String").nullable)
        assertEquals(true,column("Option_String").nullable)

        assertEquals(false,column("java_sql_Date").nullable)
        assertEquals(true,column("Option_java_sql_Date").nullable)
        assertEquals(false,column("java_sql_Time").nullable)
        assertEquals(true,column("Option_java_sql_Time").nullable)
        assertEquals(false,column("java_sql_Timestamp").nullable)
        assertEquals(true,column("Option_java_sql_Timestamp").nullable)

        if(!tdb.profile.toString.contains("OracleProfile")){// FIXME: we should probably solve this somewhat cleaner
          assertEquals("java.sql.Date",column("java_sql_Date").tpe)
          assertEquals("java.sql.Date",column("Option_java_sql_Date").tpe)
          assertEquals("java.sql.Time",column("java_sql_Time").tpe)
          assertEquals("java.sql.Time",column("Option_java_sql_Time").tpe)
          assertEquals("java.sql.Timestamp",column("java_sql_Timestamp").tpe)
          assertEquals("java.sql.Timestamp",column("Option_java_sql_Timestamp").tpe)
        }

        assertEquals("java.sql.Blob",column("java_sql_Blob").tpe)
        assertEquals("java.sql.Blob",column("Option_java_sql_Blob").tpe)
        assertEquals(false,column("java_sql_Blob").nullable)
        assertEquals(true,column("Option_java_sql_Blob").nullable)
      }
      _ <- ifCap(jcap.defaultValueMetaData) {
        val typeTest = model.tables.filter(_.name.table.toUpperCase=="NO_DEFAULT_TEST").head
        def column(name: String)
        = typeTest.columns.filter(_.name.toUpperCase == name.toUpperCase).head
        def columnDefault(name: String)
        = column(name)
          .options.collect{case RelationalProfile.ColumnOption.Default(v) => v}
          .headOption

        ifCapU(jcap.nullableNoDefault){
          assertEquals( None, columnDefault("stringOption") )
        }
        assertEquals( Some(None), columnDefault("stringOptionDefaultNone") )

        DBIO.seq(
          noDefaultTest.map(_.int) += 1,
          noDefaultTest.map(_.stringOption).result.head.map(_ shouldBe None)
        )
      }
    } yield ()
  }
}