# Copyright 2013-2022 Lawrence Livermore National Security, LLC and other
# Spack Project Developers. See the top-level COPYRIGHT file for details.
#
# SPDX-License-Identifier: (Apache-2.0 OR MIT)

from spack import *


class OpenpmdApi(CMakePackage):
    """C++ & Python API for Scientific I/O"""

    homepage = "https://www.openPMD.org"
    url      = "https://github.com/openPMD/openPMD-api/archive/0.14.2.tar.gz"
    git      = "https://github.com/openPMD/openPMD-api.git"

    maintainers = ['ax3l', 'franzpoeschel']

    tags = ['e4s']

    # C++17 up until here
    version('develop', branch='dev')
    # C++14 up until here
    version('0.14.5', sha256='e3f509098e75014394877e0dc91f833e57ced5552b110c7339a69e9dbe49bf62')
    version('0.14.4', sha256='42b7bcd043e772d63f0fe0e5e70da411f001db10096d5b8be797ffc88e786379')
    version('0.14.3', sha256='57282455e0fb1873b4def1894fadadd6425dfc8349eac7fcc68daf677c48b7ce')
    version('0.14.2', sha256='25c6b4bcd0ae1ba668b633b8514e66c402da54901c26861fc754fca55717c836')
    version('0.14.1', sha256='172fd1d785627d01c77f1170adc5a18bd8a6302e804d0f271dc0d616a5156791')
    version('0.14.0', sha256='7bb561c1a6f54e9a6a1b56aaf1d4d098bbe290d204f84ebe5a6f11b3cab2be6e')
    version('0.13.4', sha256='46c013be5cda670f21969675ce839315d4f5ada0406a6546a91ec3441402cf5e')
    version('0.13.3', sha256='4b8f84bd89cd540c73ffe8c21085970453cb7f0e4f125f11a4e288433f64b58c')
    version('0.13.2', sha256='2e5170d41bb7b2c0608ec833eee7f9adf8175b46734743f6e46dcce6f6685fb0')
    version('0.13.1', sha256='81ff79419982eb1b0865d1736f73f950f5d4c356d3c78200ceeab7f54dc07fd7')
    version('0.13.0', sha256='97c2e43d80ee5c5288f278bd54f0dcb40e7f48a575b278fcef9660214b779bb0')
    # C++11 up until here
    version('0.12.0',  tag='0.12.0-alpha')
    version('0.11.1',  tag='0.11.1-alpha')

    variant('shared', default=True,
            description='Build a shared version of the library')
    variant('mpi', default=True,
            description='Enable parallel I/O')
    variant('hdf5', default=True,
            description='Enable HDF5 support')
    variant('adios1', default=False,
            description='Enable ADIOS1 support')
    variant('adios2', default=True,
            description='Enable ADIOS2 support')
    variant('python', default=False,
            description='Enable Python bindings')

    depends_on('cmake@3.15.0:', type='build')
    depends_on('catch2@2.6.1:', type='test')
    depends_on('catch2@2.13.4:', type='test', when='@0.14.0:')
    depends_on('mpi@2.3:', when='+mpi')  # might become MPI 3.0+
    depends_on('nlohmann-json@3.9.1:')
    depends_on('mpark-variant@1.4.0:', when='@:0.14.99')  # pre C++17 releases
    depends_on('toml11@3.7.1:', when='@0.15.0:')
    with when('+hdf5'):
        depends_on('hdf5@1.8.13:')
        depends_on('hdf5@1.8.13: ~mpi', when='~mpi')
        depends_on('hdf5@1.8.13: +mpi', when='+mpi')
    with when('+adios1'):
        depends_on('adios@1.13.1: ~sz')
        depends_on('adios@1.13.1: ~mpi ~sz', when='~mpi')
        depends_on('adios@1.13.1: +mpi ~sz', when='+mpi')
    with when('+adios2'):
        depends_on('adios2@2.5.0:')
        depends_on('adios2@2.6.0:', when='@0.12.0:')
        depends_on('adios2@2.7.0:', when='@0.14.0:')
        depends_on('adios2@2.5.0: ~mpi', when='~mpi')
        depends_on('adios2@2.5.0: +mpi', when='+mpi')
    with when('+python'):
        depends_on('py-pybind11@2.6.2:', type='link')
        depends_on('py-numpy@1.15.1:', type=['test', 'run'])
        depends_on('py-mpi4py@2.1.0:', when='+mpi', type=['test', 'run'])
        depends_on('python@3.6:', type=['link', 'test', 'run'])

    conflicts('^hdf5 api=v16', msg='openPMD-api requires HDF5 APIs for 1.8+')

    # Fix breaking HDF5 1.12.0 API when build with legacy api options
    # https://github.com/openPMD/openPMD-api/pull/1012
    patch('hdf5-1.12.0.patch', when='@:0.13 +hdf5')

    extends('python', when='+python')

    def cmake_args(self):
        spec = self.spec

        args = [
            self.define_from_variant('BUILD_SHARED_LIBS', 'shared'),
            # variants
            self.define_from_variant('openPMD_USE_MPI', 'mpi'),
            self.define_from_variant('openPMD_USE_HDF5', 'hdf5'),
            self.define_from_variant('openPMD_USE_ADIOS1', 'adios1'),
            self.define_from_variant('openPMD_USE_ADIOS2', 'adios2'),
            self.define_from_variant('openPMD_USE_PYTHON', 'python'),
            # tests and examples
            self.define('BUILD_TESTING', self.run_tests),
            self.define('BUILD_EXAMPLES', self.run_tests)
        ]

        # switch internally shipped third-party libraries for spack
        if spec.satisfies('+python'):
            py_exe_define = 'Python_EXECUTABLE' \
                if spec.version >= Version('0.13.0') else 'PYTHON_EXECUTABLE'
            args += [
                self.define(py_exe_define, self.spec['python'].command.path),
                self.define('openPMD_USE_INTERNAL_PYBIND11', False)
            ]

        args.append(self.define('openPMD_USE_INTERNAL_JSON', False))
        if spec.satisfies('@:0.14'):  # pre C++17 releases
            args.append(self.define('openPMD_USE_INTERNAL_VARIANT', False))
        if spec.satisfies('@0.15:'):
            args.append(self.define('openPMD_USE_INTERNAL_TOML11', False))

        if self.run_tests:
            args.append(self.define('openPMD_USE_INTERNAL_CATCH', False))

        return args

    def setup_run_environment(self, env):
        spec = self.spec
        # pre-load dependent CMake-PUBLIC header-only libs
        if spec.satisfies('@:0.14'):  # pre C++17 releases
            env.prepend_path('CMAKE_PREFIX_PATH', spec['mpark-variant'].prefix)
            env.prepend_path('CPATH', spec['mpark-variant'].prefix.include)

        # more deps searched in openPMDConfig.cmake
        if spec.satisfies("+mpi"):
            env.prepend_path('CMAKE_PREFIX_PATH', spec['mpi'].prefix)
        if spec.satisfies("+adios1"):
            env.prepend_path('CMAKE_PREFIX_PATH', spec['adios'].prefix)
            env.prepend_path('PATH', spec['adios'].prefix.bin)  # adios-config
        if spec.satisfies("+adios2"):
            env.prepend_path('CMAKE_PREFIX_PATH', spec['adios2'].prefix)
        if spec.satisfies("+hdf5"):
            env.prepend_path('CMAKE_PREFIX_PATH', spec['hdf5'].prefix)

    def setup_dependent_build_environment(self, env, dependent_spec):
        spec = self.spec
        # pre-load dependent CMake-PUBLIC header-only libs
        if spec.satisfies('@:0.14'):  # pre C++17 releases
            env.prepend_path('CMAKE_PREFIX_PATH',
                             spec['mpark-variant'].prefix)
            env.prepend_path('CPATH', spec['mpark-variant'].prefix.include)

    def check(self):
        """CTest checks after the build phase"""
        # note: for MPI-parallel tests, you can overwrite the standard CMake
        #       option -DMPIEXEC_EXECUTABLE=$(which jsrun) for jsrun or srun,
        #       etc.. Alternatively, you can also use -E <regex> to exclude
        #       parallel and MPI tests
        with working_dir(self.build_directory):
            # -j1 because individual tests create files that are read again by
            # later tests
            ctest('--output-on-failure', '-j1')

    def test(self):
        """Perform smoke tests on the installed package."""
        exes = ['openpmd-ls']  # in 0.11.1+
        for exe in exes:
            spec_vers_str = '{0}'.format(self.spec.version)
            reason = 'test version of {0} is {1}'.format(exe, spec_vers_str)
            self.run_test(exe, ['--version'], [spec_vers_str],
                          installed=True, purpose=reason, skip_missing=False)
