#!/usr/bin/env python
###############################################################################
# $Id: ntv2.py 2fefa1605a7f7a9bd8638d4bfab5087368a5596a 2018-04-16 09:29:57 +1000 Ben Elliston $
#
# Project:  GDAL/OGR Test Suite
# Purpose:  NTv2 Testing.
# Author:   Even Rouault <even dot rouault at mines dash paris dot org>
#
###############################################################################
# Copyright (c) 2010, Even Rouault <even dot rouault at mines-paris dot org>
#
# 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 os
import sys

sys.path.append('../pymod')

from osgeo import gdal
import gdaltest

###############################################################################
# Open a little-endian NTv2 grid


def ntv2_1():

    tst = gdaltest.GDALTest('NTV2', 'test_ntv2_le.gsb', 2, 10)
    gt = (-5.52, 7.8, 0.0, 52.05, 0.0, -5.55)
    return tst.testOpen(check_gt=gt, check_prj='WGS84')

###############################################################################
# Open a big-endian NTv2 grid


def ntv2_2():

    tst = gdaltest.GDALTest('NTV2', 'test_ntv2_be.gsb', 2, 10)
    gt = (-5.52, 7.8, 0.0, 52.05, 0.0, -5.55)
    return tst.testOpen(check_gt=gt, check_prj='WGS84')

###############################################################################
# Test creating a little-endian NTv2 grid


def ntv2_3():

    tst = gdaltest.GDALTest('NTV2', 'test_ntv2_le.gsb', 2, 10, options=['ENDIANNESS=LE'])
    return tst.testCreateCopy(vsimem=1)

###############################################################################
# Test creating a big-endian NTv2 grid


def ntv2_4():

    tst = gdaltest.GDALTest('NTV2', 'test_ntv2_le.gsb', 2, 10, options=['ENDIANNESS=BE'])
    return tst.testCreateCopy(vsimem=1)

###############################################################################
# Test appending to a little-endian NTv2 grid


def ntv2_5():

    src_ds = gdal.Open('data/test_ntv2_le.gsb')
    gdal.GetDriverByName('NTv2').Create('/vsimem/ntv2_5.gsb', 1, 1, 4, gdal.GDT_Float32, options=['ENDIANNESS=LE'])
    ds = gdal.GetDriverByName('NTv2').CreateCopy('/vsimem/ntv2_5.gsb', src_ds, options=['APPEND_SUBDATASET=YES'])
    if ds.GetRasterBand(2).Checksum() != 10:
        gdaltest.post_reason('fail')
        print(ds.GetRasterBand(2).Checksum())
        return 'fail'
    ds = None
    ds = gdal.Open('NTv2:1:/vsimem/ntv2_5.gsb')
    if ds.GetRasterBand(2).Checksum() != 10:
        gdaltest.post_reason('fail')
        print(ds.GetRasterBand(2).Checksum())
        return 'fail'
    ds = None
    gdal.GetDriverByName('NTv2').Delete('/vsimem/ntv2_5.gsb')

    return 'success'

###############################################################################
# Test appending to a big-endian NTv2 grid


def ntv2_6():

    src_ds = gdal.Open('data/test_ntv2_le.gsb')
    gdal.GetDriverByName('NTv2').Create('/vsimem/ntv2_6.gsb', 1, 1, 4, gdal.GDT_Float32, options=['ENDIANNESS=BE'])
    ds = gdal.GetDriverByName('NTv2').CreateCopy('/vsimem/ntv2_6.gsb', src_ds, options=['APPEND_SUBDATASET=YES'])
    if ds.GetRasterBand(2).Checksum() != 10:
        gdaltest.post_reason('fail')
        print(ds.GetRasterBand(2).Checksum())
        return 'fail'
    ds = None
    ds = gdal.Open('NTv2:1:/vsimem/ntv2_6.gsb')
    if ds.GetRasterBand(2).Checksum() != 10:
        gdaltest.post_reason('fail')
        print(ds.GetRasterBand(2).Checksum())
        return 'fail'
    ds = None
    gdal.GetDriverByName('NTv2').Delete('/vsimem/ntv2_6.gsb')

    return 'success'

###############################################################################
# Test creating a file with invalid filename


def ntv2_7():

    with gdaltest.error_handler():
        ds = gdal.GetDriverByName('NTv2').Create('/does/not/exist.gsb', 1, 1, 4, gdal.GDT_Float32)
    if ds is not None:
        return 'fail'

    with gdaltest.error_handler():
        ds = gdal.GetDriverByName('NTv2').Create('/does/not/exist.gsb', 1, 1, 4, gdal.GDT_Float32, options=['APPEND_SUBDATASET=YES'])
    if ds is not None:
        return 'fail'

    return 'success'

###############################################################################


def ntv2_online_1():

    if not gdaltest.download_file('http://download.osgeo.org/proj/nzgd2kgrid0005.gsb', 'nzgd2kgrid0005.gsb'):
        return 'skip'

    try:
        os.stat('tmp/cache/nzgd2kgrid0005.gsb')
    except OSError:
        return 'skip'

    tst = gdaltest.GDALTest('NTV2', 'tmp/cache/nzgd2kgrid0005.gsb', 1, 54971, filename_absolute=1)
    gt = (165.95, 0.1, 0.0, -33.95, 0.0, -0.1)
    return tst.testOpen(check_gt=gt, check_prj='WGS84')

###############################################################################


def ntv2_online_2():

    try:
        os.stat('tmp/cache/nzgd2kgrid0005.gsb')
    except OSError:
        return 'skip'

    tst = gdaltest.GDALTest('NTV2', 'tmp/cache/nzgd2kgrid0005.gsb', 1, 54971, filename_absolute=1)
    return tst.testCreateCopy(vsimem=1)

###############################################################################


def ntv2_online_3():

    try:
        os.stat('tmp/cache/nzgd2kgrid0005.gsb')
    except OSError:
        return 'skip'

    tst = gdaltest.GDALTest('NTV2', 'tmp/cache/nzgd2kgrid0005.gsb', 1, 54971, filename_absolute=1)
    return tst.testCreate(vsimem=1, out_bands=4)


gdaltest_list = [
    ntv2_1,
    ntv2_2,
    ntv2_3,
    ntv2_4,
    ntv2_5,
    ntv2_6,
    ntv2_7,
    ntv2_online_1,
    ntv2_online_2,
    ntv2_online_3,
]


if __name__ == '__main__':

    gdaltest.setup_run('NTV2')

    gdaltest.run_tests(gdaltest_list)

    gdaltest.summarize()
