#!/usr/bin/env pytest
###############################################################################
# $Id$
#
# Project:  GDAL/OGR Test Suite
# Purpose:  ogrmerge.py testing
# Author:   Even Rouault <even dot rouault at spatialys dot com>
#
###############################################################################
# Copyright (c) 2017, Even Rouault <even dot rouault at spatialys dot 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 pytest
import test_py_scripts

from osgeo import gdal, ogr

###############################################################################
# Test -single


def test_ogrmerge_1():
    script_path = test_py_scripts.get_py_script("ogrmerge")
    if script_path is None:
        pytest.skip()

    test_py_scripts.run_py_script(
        script_path,
        "ogrmerge",
        "-single -o tmp/out.shp "
        + test_py_scripts.get_data_path("ogr")
        + "poly.shp "
        + test_py_scripts.get_data_path("ogr")
        + "poly.shp",
    )

    ds = ogr.Open("tmp/out.shp")
    lyr = ds.GetLayer(0)
    assert lyr.GetFeatureCount() == 20
    ds = None

    ogr.GetDriverByName("ESRI Shapefile").DeleteDataSource("tmp/out.shp")


###############################################################################
# Test -append and glob


def test_ogrmerge_2():
    script_path = test_py_scripts.get_py_script("ogrmerge")
    if script_path is None:
        pytest.skip()

    test_py_scripts.run_py_script(
        script_path,
        "ogrmerge",
        "-single -o tmp/out.shp " + test_py_scripts.get_data_path("ogr") + "poly.shp",
    )
    test_py_scripts.run_py_script(
        script_path,
        "ogrmerge",
        '-append -single -o tmp/out.shp "'
        + test_py_scripts.get_data_path("ogr")
        + 'p*ly.shp"',
    )

    ds = ogr.Open("tmp/out.shp")
    lyr = ds.GetLayer(0)
    assert lyr.GetFeatureCount() == 20
    ds = None

    ogr.GetDriverByName("ESRI Shapefile").DeleteDataSource("tmp/out.shp")


###############################################################################
# Test -overwrite_ds


def test_ogrmerge_3():
    script_path = test_py_scripts.get_py_script("ogrmerge")
    if script_path is None:
        pytest.skip()

    test_py_scripts.run_py_script(
        script_path,
        "ogrmerge",
        "-overwrite_ds -o tmp/out.shp "
        + test_py_scripts.get_data_path("ogr")
        + "poly.shp",
    )
    test_py_scripts.run_py_script(
        script_path,
        "ogrmerge",
        "-overwrite_ds -single -o tmp/out.shp "
        + test_py_scripts.get_data_path("ogr")
        + "poly.shp",
    )

    ds = ogr.Open("tmp/out.shp")
    lyr = ds.GetLayer(0)
    assert lyr.GetFeatureCount() == 10
    ds = None

    ogr.GetDriverByName("ESRI Shapefile").DeleteDataSource("tmp/out.shp")


###############################################################################
# Test -f VRT


def test_ogrmerge_4():
    script_path = test_py_scripts.get_py_script("ogrmerge")
    if script_path is None:
        pytest.skip()

    test_py_scripts.run_py_script(
        script_path,
        "ogrmerge",
        "-f VRT -o tmp/out.vrt " + test_py_scripts.get_data_path("ogr") + "poly.shp",
    )

    ds = ogr.Open("tmp/out.vrt")
    lyr = ds.GetLayer(0)
    assert lyr.GetName() == "poly"
    assert lyr.GetFeatureCount() == 10
    ds = None

    gdal.Unlink("tmp/out.vrt")


###############################################################################
# Test -nln


def test_ogrmerge_5():
    script_path = test_py_scripts.get_py_script("ogrmerge")
    if script_path is None:
        pytest.skip()

    test_py_scripts.run_py_script(
        script_path,
        "ogrmerge",
        "-f VRT -o tmp/out.vrt "
        + test_py_scripts.get_data_path("ogr")
        + "poly.shp "
        + test_py_scripts.get_data_path("ogr")
        + "shp/testpoly.shp -nln "
        '"foo_{DS_NAME}_{DS_BASENAME}_{DS_INDEX}_{LAYER_NAME}_{LAYER_INDEX}"',
    )

    ds = ogr.Open("tmp/out.vrt")
    lyr = ds.GetLayer(0)
    assert (
        lyr.GetName()
        == "foo_" + test_py_scripts.get_data_path("ogr") + "poly.shp_poly_0_poly_0"
    )
    assert lyr.GetFeatureCount() == 10
    lyr = ds.GetLayer(1)
    assert (
        lyr.GetName()
        == "foo_"
        + test_py_scripts.get_data_path("ogr")
        + "shp/testpoly.shp_testpoly_1_testpoly_0"
    )
    assert lyr.GetFeatureCount() == 14
    ds = None

    gdal.Unlink("tmp/out.vrt")


###############################################################################
# Test -src_layer_field_name -src_layer_field_content


def test_ogrmerge_6():
    script_path = test_py_scripts.get_py_script("ogrmerge")
    if script_path is None:
        pytest.skip()

    test_py_scripts.run_py_script(
        script_path,
        "ogrmerge",
        "-single -f VRT -o tmp/out.vrt "
        + test_py_scripts.get_data_path("ogr")
        + "poly.shp "
        "-src_layer_field_name source -src_layer_field_content "
        '"foo_{DS_NAME}_{DS_BASENAME}_{DS_INDEX}_{LAYER_NAME}_{LAYER_INDEX}"',
    )

    ds = ogr.Open("tmp/out.vrt")
    lyr = ds.GetLayer(0)
    f = lyr.GetNextFeature()
    if (
        f["source"]
        != "foo_" + test_py_scripts.get_data_path("ogr") + "poly.shp_poly_0_poly_0"
    ):
        f.DumpReadable()
        pytest.fail()
    ds = None

    gdal.Unlink("tmp/out.vrt")


###############################################################################
# Test -src_geom_type


def test_ogrmerge_7():
    script_path = test_py_scripts.get_py_script("ogrmerge")
    if script_path is None:
        pytest.skip()

    # No match in -single mode
    test_py_scripts.run_py_script(
        script_path,
        "ogrmerge",
        "-single -f VRT -o tmp/out.vrt "
        + test_py_scripts.get_data_path("ogr")
        + "poly.shp "
        "-src_geom_type POINT",
    )

    ds = ogr.Open("tmp/out.vrt")
    assert ds.GetLayerCount() == 0
    ds = None

    gdal.Unlink("tmp/out.vrt")

    # Match in single mode
    test_py_scripts.run_py_script(
        script_path,
        "ogrmerge",
        "-single -f VRT -o tmp/out.vrt "
        + test_py_scripts.get_data_path("ogr")
        + "poly.shp "
        "-src_geom_type POLYGON",
    )

    ds = ogr.Open("tmp/out.vrt")
    assert ds.GetLayerCount() == 1
    ds = None

    gdal.Unlink("tmp/out.vrt")

    # No match in default mode
    test_py_scripts.run_py_script(
        script_path,
        "ogrmerge",
        "-f VRT -o tmp/out.vrt " + test_py_scripts.get_data_path("ogr") + "poly.shp "
        "-src_geom_type POINT",
    )

    ds = ogr.Open("tmp/out.vrt")
    assert ds.GetLayerCount() == 0
    ds = None

    gdal.Unlink("tmp/out.vrt")

    # Match in default mode
    test_py_scripts.run_py_script(
        script_path,
        "ogrmerge",
        "-f VRT -o tmp/out.vrt " + test_py_scripts.get_data_path("ogr") + "poly.shp "
        "-src_geom_type POLYGON",
    )

    ds = ogr.Open("tmp/out.vrt")
    assert ds.GetLayerCount() == 1
    ds = None

    gdal.Unlink("tmp/out.vrt")


###############################################################################
# Test -s_srs -t_srs in -single mode


def test_ogrmerge_8():
    script_path = test_py_scripts.get_py_script("ogrmerge")
    if script_path is None:
        pytest.skip()

    test_py_scripts.run_py_script(
        script_path,
        "ogrmerge",
        "-single -f VRT -o tmp/out.vrt "
        + test_py_scripts.get_data_path("ogr")
        + "poly.shp "
        "-s_srs EPSG:32630 -t_srs EPSG:4326",
    )

    ds = ogr.Open("tmp/out.vrt")
    assert ds is not None
    ds = None

    f = gdal.VSIFOpenL("tmp/out.vrt", "rb")
    content = ""
    if f is not None:
        content = gdal.VSIFReadL(1, 10000, f).decode("UTF-8")
        gdal.VSIFCloseL(f)
    gdal.Unlink("tmp/out.vrt")

    assert "<SrcSRS>EPSG:32630</SrcSRS>" in content

    assert "<TargetSRS>EPSG:4326</TargetSRS>" in content


###############################################################################
# Test -s_srs -t_srs in default mode


def test_ogrmerge_9():
    script_path = test_py_scripts.get_py_script("ogrmerge")
    if script_path is None:
        pytest.skip()

    test_py_scripts.run_py_script(
        script_path,
        "ogrmerge",
        "-f VRT -o tmp/out.vrt " + test_py_scripts.get_data_path("ogr") + "poly.shp "
        "-s_srs EPSG:32630 -t_srs EPSG:4326",
    )

    ds = ogr.Open("tmp/out.vrt")
    assert ds is not None
    ds = None

    f = gdal.VSIFOpenL("tmp/out.vrt", "rb")
    content = ""
    if f is not None:
        content = gdal.VSIFReadL(1, 10000, f).decode("UTF-8")
        gdal.VSIFCloseL(f)
    gdal.Unlink("tmp/out.vrt")

    assert "<SrcSRS>EPSG:32630</SrcSRS>" in content

    assert "<TargetSRS>EPSG:4326</TargetSRS>" in content


###############################################################################
# Test -a_srs in -single mode


def test_ogrmerge_10():
    script_path = test_py_scripts.get_py_script("ogrmerge")
    if script_path is None:
        pytest.skip()

    test_py_scripts.run_py_script(
        script_path,
        "ogrmerge",
        "-single -f VRT -o tmp/out.vrt "
        + test_py_scripts.get_data_path("ogr")
        + "poly.shp "
        "-a_srs EPSG:32630",
    )

    ds = ogr.Open("tmp/out.vrt")
    assert ds is not None
    ds = None

    f = gdal.VSIFOpenL("tmp/out.vrt", "rb")
    content = ""
    if f is not None:
        content = gdal.VSIFReadL(1, 10000, f).decode("UTF-8")
        gdal.VSIFCloseL(f)
    gdal.Unlink("tmp/out.vrt")

    assert "<LayerSRS>EPSG:32630</LayerSRS>" in content


###############################################################################
# Test -a_srs in default mode


def test_ogrmerge_11():
    script_path = test_py_scripts.get_py_script("ogrmerge")
    if script_path is None:
        pytest.skip()

    test_py_scripts.run_py_script(
        script_path,
        "ogrmerge",
        "-f VRT -o tmp/out.vrt " + test_py_scripts.get_data_path("ogr") + "poly.shp "
        "-a_srs EPSG:32630",
    )

    ds = ogr.Open("tmp/out.vrt")
    assert ds is not None
    ds = None

    f = gdal.VSIFOpenL("tmp/out.vrt", "rb")
    content = ""
    if f is not None:
        content = gdal.VSIFReadL(1, 10000, f).decode("UTF-8")
        gdal.VSIFCloseL(f)
    gdal.Unlink("tmp/out.vrt")

    assert "<LayerSRS>EPSG:32630</LayerSRS>" in content


###############################################################################
# Test layer names with accents


def test_ogrmerge_12():
    script_path = test_py_scripts.get_py_script("ogrmerge")
    if script_path is None:
        pytest.skip()

    with open("tmp/tmp.json", "wb") as f:
        f.write(
            b"""{ "type": "FeatureCollection", "name": "\xc3\xa9ven", "features": [ { "type": "Feature", "properties": {}, "geometry": null} ]}"""
        )

    test_py_scripts.run_py_script(
        script_path, "ogrmerge", "-f VRT -o tmp/out.vrt tmp/tmp.json"
    )

    ds = ogr.Open("tmp/out.vrt")
    assert ds is not None
    ds = None

    gdal.Unlink("tmp/tmp.json")
    gdal.Unlink("tmp/out.vrt")
