#!/usr/bin/env pytest
###############################################################################
# $Id$
#
# Project:  GDAL/OGR Test Suite
# Purpose:  Test RFC35 for SQLite driver
# Author:   Even Rouault <even dot rouault at spatialys.com>
#
###############################################################################
# Copyright (c) 2011, Even Rouault <even dot rouault at spatialys.com>
#
# Permission is hereby granted, free of charge, to any person obtaining a
# copy of this software and associated documentation files (the "Software"),
# to deal in the Software without restriction, including without limitation
# the rights to use, copy, modify, merge, publish, distribute, sublicense,
# and/or sell copies of the Software, and to permit persons to whom the
# Software is furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included
# in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
# DEALINGS IN THE SOFTWARE.
###############################################################################


import gdaltest
import pytest

from osgeo import gdal, ogr


###############################################################################
@pytest.fixture(autouse=True, scope="module")
def module_disable_exceptions():
    with gdaltest.disable_exceptions():
        yield


###############################################################################
@pytest.fixture(autouse=True, scope="module")
def setup_and_cleanup():
    # This is to speed-up the runtime of tests on EXT4 filesystems
    # Do not use this for production environment if you care about data safety
    # w.r.t system/OS crashes, unless you know what you are doing.
    with gdal.config_option("OGR_SQLITE_SYNCHRONOUS", "OFF"):
        yield


###############################################################################
# Initiate the test file


def test_ogr_rfc35_sqlite_1():

    gdaltest.rfc35_sqlite_ds = None
    gdaltest.rfc35_sqlite_ds_name = None
    sqlite_dr = ogr.GetDriverByName("SQLite")
    if sqlite_dr is None:
        pytest.skip()

    gdal.Unlink("tmp/rfc35_test.sqlite")

    gdaltest.rfc35_sqlite_ds_name = "/vsimem/rfc35_test.sqlite"
    with gdaltest.error_handler():
        gdaltest.rfc35_sqlite_ds = ogr.GetDriverByName("SQLite").CreateDataSource(
            gdaltest.rfc35_sqlite_ds_name
        )
    if gdaltest.rfc35_sqlite_ds is None:
        gdaltest.rfc35_sqlite_ds_name = "tmp/rfc35_test.sqlite"
        gdaltest.rfc35_sqlite_ds = ogr.GetDriverByName("SQLite").CreateDataSource(
            gdaltest.rfc35_sqlite_ds_name
        )
    lyr = gdaltest.rfc35_sqlite_ds.CreateLayer("rfc35_test")

    lyr.ReorderFields([])

    fd = ogr.FieldDefn("foo5", ogr.OFTString)
    fd.SetWidth(5)
    lyr.CreateField(fd)

    feat = ogr.Feature(lyr.GetLayerDefn())
    feat.SetField(0, "foo0")
    lyr.CreateFeature(feat)
    feat = None

    fd = ogr.FieldDefn("bar10", ogr.OFTString)
    fd.SetWidth(10)
    lyr.CreateField(fd)

    feat = ogr.Feature(lyr.GetLayerDefn())
    feat.SetField(0, "foo1")
    feat.SetField(1, "bar1")
    lyr.CreateFeature(feat)
    feat = None

    fd = ogr.FieldDefn("baz15", ogr.OFTString)
    fd.SetWidth(15)
    lyr.CreateField(fd)

    feat = ogr.Feature(lyr.GetLayerDefn())
    feat.SetField(0, "foo2")
    feat.SetField(1, "bar2_01234")
    feat.SetField(2, "baz2_0123456789")
    lyr.CreateFeature(feat)
    feat = None

    fd = ogr.FieldDefn("baw20", ogr.OFTString)
    fd.SetWidth(20)
    lyr.CreateField(fd)


###############################################################################
# Test ReorderField()


def Truncate(val, lyr_defn, fieldname):
    # pylint: disable=unused-argument
    # Mem driver doesn't actually truncate
    return val


def CheckFeatures(lyr, field1="foo5", field2="bar10", field3="baz15", field4="baw20"):

    expected_values = [
        ["foo0", None, None, None],
        ["foo1", "bar1", None, None],
        ["foo2", "bar2_01234", "baz2_0123456789", None],
        ["foo3", "bar3_01234", "baz3_0123456789", "baw3_012345678901234"],
    ]

    lyr_defn = lyr.GetLayerDefn()

    lyr.ResetReading()
    feat = lyr.GetNextFeature()
    i = 0
    while feat is not None:
        if (
            (
                field1 is not None
                and feat.GetField(field1)
                != Truncate(expected_values[i][0], lyr_defn, field1)
            )
            or (
                field2 is not None
                and feat.GetField(field2)
                != Truncate(expected_values[i][1], lyr_defn, field2)
            )
            or (
                field3 is not None
                and feat.GetField(field3)
                != Truncate(expected_values[i][2], lyr_defn, field3)
            )
            or (
                field4 is not None
                and feat.GetField(field4)
                != Truncate(expected_values[i][3], lyr_defn, field4)
            )
        ):
            feat.DumpReadable()
            pytest.fail()
        feat = lyr.GetNextFeature()
        i = i + 1


def CheckColumnOrder(lyr, expected_order):

    lyr_defn = lyr.GetLayerDefn()
    for i, exp_order in enumerate(expected_order):
        assert lyr_defn.GetFieldDefn(i).GetName() == exp_order


def Check(lyr, expected_order):
    CheckColumnOrder(lyr, expected_order)
    CheckFeatures(lyr)


def test_ogr_rfc35_sqlite_2():

    if gdaltest.rfc35_sqlite_ds is None:
        pytest.skip()

    lyr = gdaltest.rfc35_sqlite_ds.GetLayer(0)

    assert lyr.TestCapability(ogr.OLCReorderFields) == 1

    feat = ogr.Feature(lyr.GetLayerDefn())
    feat.SetField(0, "foo3")
    feat.SetField(1, "bar3_01234")
    feat.SetField(2, "baz3_0123456789")
    feat.SetField(3, "baw3_012345678901234")
    lyr.CreateFeature(feat)
    feat = None

    assert lyr.ReorderField(1, 3) == 0

    Check(lyr, ["foo5", "baz15", "baw20", "bar10"])

    lyr.ReorderField(3, 1)
    Check(lyr, ["foo5", "bar10", "baz15", "baw20"])

    lyr.ReorderField(0, 2)
    Check(lyr, ["bar10", "baz15", "foo5", "baw20"])

    lyr.ReorderField(2, 0)
    Check(lyr, ["foo5", "bar10", "baz15", "baw20"])

    lyr.ReorderField(0, 1)
    Check(lyr, ["bar10", "foo5", "baz15", "baw20"])

    lyr.ReorderField(1, 0)
    Check(lyr, ["foo5", "bar10", "baz15", "baw20"])

    lyr.ReorderFields([3, 2, 1, 0])
    Check(lyr, ["baw20", "baz15", "bar10", "foo5"])

    lyr.ReorderFields([3, 2, 1, 0])
    Check(lyr, ["foo5", "bar10", "baz15", "baw20"])

    with gdaltest.error_handler():
        ret = lyr.ReorderFields([0, 0, 0, 0])
    assert ret != 0


###############################################################################
# Test AlterFieldDefn() for change of name and width


def test_ogr_rfc35_sqlite_3():

    if gdaltest.rfc35_sqlite_ds is None:
        pytest.skip()

    lyr = gdaltest.rfc35_sqlite_ds.GetLayer(0)

    fd = ogr.FieldDefn("baz25", ogr.OFTString)
    fd.SetWidth(25)

    lyr_defn = lyr.GetLayerDefn()

    with gdaltest.error_handler():
        ret = lyr.AlterFieldDefn(-1, fd, ogr.ALTER_ALL_FLAG)
    assert ret != 0

    with gdaltest.error_handler():
        ret = lyr.AlterFieldDefn(lyr_defn.GetFieldCount(), fd, ogr.ALTER_ALL_FLAG)
    assert ret != 0

    lyr.AlterFieldDefn(lyr_defn.GetFieldIndex("baz15"), fd, ogr.ALTER_ALL_FLAG)

    CheckFeatures(lyr, field3="baz25")

    fd = ogr.FieldDefn("baz5_tmp", ogr.OFTString)
    fd.SetWidth(5)

    lyr_defn = lyr.GetLayerDefn()
    lyr.AlterFieldDefn(lyr_defn.GetFieldIndex("baz25"), fd, ogr.ALTER_ALL_FLAG)

    CheckFeatures(lyr, field3="baz5_tmp")

    lyr_defn = lyr.GetLayerDefn()
    fld_defn = lyr_defn.GetFieldDefn(lyr_defn.GetFieldIndex("baz5_tmp"))
    assert fld_defn.GetWidth() == 5

    CheckFeatures(lyr, field3="baz5_tmp")

    # Change only name
    fd = ogr.FieldDefn("baz5", ogr.OFTString)
    fd.SetWidth(5)
    lyr.AlterFieldDefn(lyr_defn.GetFieldIndex("baz5_tmp"), fd, ogr.ALTER_ALL_FLAG)

    fld_defn = lyr_defn.GetFieldDefn(lyr_defn.GetFieldIndex("baz5"))
    assert fld_defn.GetWidth() == 5


###############################################################################
# Test AlterFieldDefn() for change of type


def test_ogr_rfc35_sqlite_4():

    if gdaltest.rfc35_sqlite_ds is None:
        pytest.skip()

    lyr = gdaltest.rfc35_sqlite_ds.GetLayer(0)
    lyr_defn = lyr.GetLayerDefn()

    assert lyr.TestCapability(ogr.OLCAlterFieldDefn) == 1

    fd = ogr.FieldDefn("intfield", ogr.OFTInteger)
    lyr.CreateField(fd)

    lyr.ReorderField(lyr_defn.GetFieldIndex("intfield"), 0)

    lyr.ResetReading()
    feat = lyr.GetNextFeature()
    feat.SetField("intfield", 12345)
    lyr.SetFeature(feat)
    feat = None

    fd.SetWidth(10)
    lyr.AlterFieldDefn(lyr_defn.GetFieldIndex("intfield"), fd, ogr.ALTER_ALL_FLAG)

    lyr.ResetReading()
    feat = lyr.GetNextFeature()
    assert feat.GetField("intfield") == 12345
    feat = None

    CheckFeatures(lyr, field3="baz5")

    fd.SetWidth(5)
    lyr.AlterFieldDefn(lyr_defn.GetFieldIndex("intfield"), fd, ogr.ALTER_ALL_FLAG)

    lyr.ResetReading()
    feat = lyr.GetNextFeature()
    assert feat.GetField("intfield") == 12345
    feat = None

    CheckFeatures(lyr, field3="baz5")

    fd.SetWidth(4)
    lyr.AlterFieldDefn(lyr_defn.GetFieldIndex("intfield"), fd, ogr.ALTER_ALL_FLAG)

    lyr.ResetReading()
    feat = lyr.GetNextFeature()
    # if feat.GetField("intfield") != 1234:
    assert feat.GetField("intfield") == 12345
    feat = None

    CheckFeatures(lyr, field3="baz5")

    fd = ogr.FieldDefn("oldintfld", ogr.OFTString)
    fd.SetWidth(15)
    lyr.AlterFieldDefn(lyr_defn.GetFieldIndex("intfield"), fd, ogr.ALTER_ALL_FLAG)

    lyr.ResetReading()
    feat = lyr.GetNextFeature()
    # if feat.GetField("oldintfld") != '1234':
    assert feat.GetField("oldintfld") == "12345"
    feat = None

    CheckFeatures(lyr, field3="baz5")

    lyr.DeleteField(lyr_defn.GetFieldIndex("oldintfld"))

    fd = ogr.FieldDefn("intfield", ogr.OFTInteger)
    fd.SetWidth(10)
    assert lyr.CreateField(fd) == 0

    assert lyr.ReorderField(lyr_defn.GetFieldIndex("intfield"), 0) == 0

    lyr.ResetReading()
    feat = lyr.GetNextFeature()
    feat.SetField("intfield", 98765)
    assert lyr.SetFeature(feat) == 0
    feat = None

    fd = ogr.FieldDefn("oldintfld", ogr.OFTString)
    fd.SetWidth(6)
    lyr.AlterFieldDefn(lyr_defn.GetFieldIndex("intfield"), fd, ogr.ALTER_ALL_FLAG)

    lyr.ResetReading()
    feat = lyr.GetNextFeature()
    assert feat.GetField("oldintfld") == "98765"
    feat = None

    CheckFeatures(lyr, field3="baz5")


###############################################################################
# Test DeleteField()


def test_ogr_rfc35_sqlite_5():

    if gdaltest.rfc35_sqlite_ds is None:
        pytest.skip()

    lyr = gdaltest.rfc35_sqlite_ds.GetLayer(0)
    lyr_defn = lyr.GetLayerDefn()

    assert lyr.TestCapability(ogr.OLCDeleteField) == 1

    with gdaltest.error_handler():
        ret = lyr.DeleteField(-1)
    assert ret != 0

    with gdaltest.error_handler():
        ret = lyr.DeleteField(lyr.GetLayerDefn().GetFieldCount())
    assert ret != 0

    assert lyr.DeleteField(0) == 0

    CheckFeatures(lyr, field3="baz5")

    assert lyr.DeleteField(lyr_defn.GetFieldIndex("baw20")) == 0

    CheckFeatures(lyr, field3="baz5", field4=None)

    assert lyr.DeleteField(lyr_defn.GetFieldIndex("baz5")) == 0

    CheckFeatures(lyr, field3=None, field4=None)

    assert lyr.DeleteField(lyr_defn.GetFieldIndex("foo5")) == 0

    assert lyr.DeleteField(lyr_defn.GetFieldIndex("bar10")) == 0

    CheckFeatures(lyr, field1=None, field2=None, field3=None, field4=None)


###############################################################################
# Initiate the test file


def test_ogr_rfc35_sqlite_cleanup():

    if gdaltest.rfc35_sqlite_ds_name is None:
        pytest.skip()

    gdaltest.rfc35_sqlite_ds = None
    ogr.GetDriverByName("SQLite").DeleteDataSource(gdaltest.rfc35_sqlite_ds_name)
