#!/usr/bin/env python
# -*- coding: utf-8 -*-
#
# Gramps - a GTK+/GNOME based genealogy program
#
# Copyright (C) 2007-2009  B. Malengier
# Copyright (C) 2009  Swoon on bug tracker
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#

"""
File tests.
"""

# -------------------------------------------------------------------------
#
# Standard python modules
#
# -------------------------------------------------------------------------
import os
import tempfile
import unittest

# -------------------------------------------------------------------------
#
# Gramps modules
#
# -------------------------------------------------------------------------
from ...const import USER_HOME, USER_PICTURES, USER_PLUGINS, VERSION
from ...utils.file import media_path
from ...db.utils import make_database


# -------------------------------------------------------------------------
#
# FileTest class
#
# -------------------------------------------------------------------------
class FileTest(unittest.TestCase):
    """
    File tests.
    """

    def test_mediapath(self):
        """
        Test media path variables.
        """
        with tempfile.TemporaryDirectory() as tmpdirname:
            # Create database
            db = make_database("sqlite")
            path = os.path.join(tmpdirname, "utils_file_test")
            os.makedirs(path)
            db.load(path)

            # Test without db.mediapath set
            self.assertEqual(
                media_path(db),
                os.path.normcase(os.path.normpath(os.path.abspath(USER_PICTURES))),
            )
            self.assertTrue(os.path.exists(media_path(db)))

            # Test with absolute db.mediapath
            db.set_mediapath(os.path.abspath(USER_HOME) + "/test_abs")
            self.assertEqual(
                media_path(db),
                os.path.normcase(
                    os.path.normpath(os.path.abspath(USER_HOME + "/test_abs"))
                ),
            )

            # Test with relative db.mediapath
            db.set_mediapath("test_rel")
            self.assertEqual(
                media_path(db),
                os.path.normcase(
                    os.path.normpath(
                        os.path.abspath(tmpdirname + "/utils_file_test/test_rel")
                    )
                ),
            )

            # Test with environment variable
            db.set_mediapath("/test/{VERSION}/test_var")
            self.assertEqual(
                media_path(db),
                os.path.normcase(
                    os.path.normpath(os.path.abspath("/test/" + VERSION + "/test_var"))
                ),
            )
            db.set_mediapath("{USER_PLUGINS}/test_var")
            self.assertEqual(
                media_path(db),
                os.path.normcase(
                    os.path.normpath(os.path.abspath(USER_PLUGINS + "/test_var"))
                ),
            )
            db.set_mediapath("{VERSION}/test_var")
            self.assertEqual(
                media_path(db),
                os.path.normcase(
                    os.path.normpath(
                        os.path.abspath(
                            tmpdirname + "/utils_file_test/" + VERSION + "/test_var"
                        )
                    )
                ),
            )

            # Test with $GRAMPSHOME environment variable not set
            old_env = os.environ.copy()
            if "GRAMPSHOME" in os.environ:
                del os.environ["GRAMPSHOME"]
            db.set_mediapath("{GRAMPSHOME}/test_var")
            self.assertEqual(
                media_path(db),
                os.path.normcase(
                    os.path.normpath(os.path.abspath(USER_HOME + "/test_var"))
                ),
            )

            # Test with $GRAMPSHOME environment variable set
            os.environ["GRAMPSHOME"] = "/this/is/a/test"
            db.set_mediapath("{GRAMPSHOME}/test_var")
            self.assertEqual(
                media_path(db),
                os.path.normcase(
                    os.path.normpath(os.path.abspath("/this/is/a/test/test_var"))
                ),
            )

            # Restore environment
            os.environ = old_env


# -------------------------------------------------------------------------
#
# main
#
# -------------------------------------------------------------------------

if __name__ == "__main__":
    unittest.main()
