#!/usr/bin/env python
#
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this file,
# You can obtain one at http://mozilla.org/MPL/2.0/.

from __future__ import absolute_import

import json
import mock
import os
import shutil
import sys
import tempfile
import unittest
import mozinfo

import mozunit

PY3 = sys.version_info[0] == 3

if PY3:
    # reload() has been moved to importlib in Python 3
    # see https://docs.python.org/3.5/library/importlib.html#importlib.reload
    from importlib import reload


class TestMozinfo(unittest.TestCase):
    def setUp(self):
        reload(mozinfo)
        self.tempdir = os.path.abspath(tempfile.mkdtemp())

        # When running from an objdir mozinfo will use a build generated json file
        # instead of the ones created for testing. Prevent that from happening.
        # See bug 896038 for details.
        sys.modules["mozbuild"] = None

    def tearDown(self):
        shutil.rmtree(self.tempdir)
        del sys.modules["mozbuild"]

    def test_basic(self):
        """Test that mozinfo has a few attributes."""
        self.assertNotEqual(mozinfo.os, None)
        # should have isFoo == True where os == "foo"
        self.assertTrue(getattr(mozinfo, "is" + mozinfo.os[0].upper() + mozinfo.os[1:]))

    def test_update(self):
        """Test that mozinfo.update works."""
        mozinfo.update({"foo": 123})
        self.assertEqual(mozinfo.info["foo"], 123)

    def test_update_file(self):
        """Test that mozinfo.update can load a JSON file."""
        j = os.path.join(self.tempdir, "mozinfo.json")
        with open(j, "w") as f:
            f.write(json.dumps({"foo": "xyz"}))
        mozinfo.update(j)
        self.assertEqual(mozinfo.info["foo"], "xyz")

    def test_update_file_invalid_json(self):
        """Test that mozinfo.update handles invalid JSON correctly"""
        j = os.path.join(self.tempdir, "test.json")
        with open(j, "w") as f:
            f.write('invalid{"json":')
        self.assertRaises(ValueError, mozinfo.update, [j])

    def test_find_and_update_file(self):
        """Test that mozinfo.find_and_update_from_json can
        find mozinfo.json in a directory passed to it."""
        j = os.path.join(self.tempdir, "mozinfo.json")
        with open(j, "w") as f:
            f.write(json.dumps({"foo": "abcdefg"}))
        self.assertEqual(mozinfo.find_and_update_from_json(self.tempdir), j)
        self.assertEqual(mozinfo.info["foo"], "abcdefg")

    def test_find_and_update_file_no_argument(self):
        """Test that mozinfo.find_and_update_from_json no-ops on not being
        given any arguments.
        """
        self.assertEqual(mozinfo.find_and_update_from_json(), None)

    def test_find_and_update_file_invalid_json(self):
        """Test that mozinfo.find_and_update_from_json can
        handle invalid JSON"""
        j = os.path.join(self.tempdir, "mozinfo.json")
        with open(j, "w") as f:
            f.write('invalid{"json":')
        self.assertRaises(ValueError, mozinfo.find_and_update_from_json, self.tempdir)

    def test_find_and_update_file_raise_exception(self):
        """Test that mozinfo.find_and_update_from_json raises
        an IOError when exceptions are unsuppressed.
        """
        with self.assertRaises(IOError):
            mozinfo.find_and_update_from_json(raise_exception=True)

    def test_find_and_update_file_suppress_exception(self):
        """Test that mozinfo.find_and_update_from_json suppresses
        an IOError exception if a False boolean value is
        provided as the only argument.
        """
        self.assertEqual(mozinfo.find_and_update_from_json(raise_exception=False), None)

    def test_find_and_update_file_mozbuild(self):
        """Test that mozinfo.find_and_update_from_json can
        find mozinfo.json using the mozbuild module."""
        j = os.path.join(self.tempdir, "mozinfo.json")
        with open(j, "w") as f:
            f.write(json.dumps({"foo": "123456"}))
        m = mock.MagicMock()
        # Mock the value of MozbuildObject.from_environment().topobjdir.
        m.MozbuildObject.from_environment.return_value.topobjdir = self.tempdir

        mocked_modules = {
            "mozbuild": m,
            "mozbuild.base": m,
            "mozbuild.mozconfig": m,
        }
        with mock.patch.dict(sys.modules, mocked_modules):
            self.assertEqual(mozinfo.find_and_update_from_json(), j)
        self.assertEqual(mozinfo.info["foo"], "123456")

    def test_output_to_file(self):
        """Test that mozinfo.output_to_file works."""
        path = os.path.join(self.tempdir, "mozinfo.json")
        mozinfo.output_to_file(path)
        self.assertEqual(open(path).read(), json.dumps(mozinfo.info))


class TestStringVersion(unittest.TestCase):
    def test_os_version_is_a_StringVersion(self):
        self.assertIsInstance(mozinfo.os_version, mozinfo.StringVersion)

    def test_compare_to_string(self):
        version = mozinfo.StringVersion("10.10")

        self.assertGreater(version, "10.2")
        self.assertGreater("11", version)
        self.assertGreaterEqual(version, "10.10")
        self.assertGreaterEqual("10.11", version)
        self.assertEqual(version, "10.10")
        self.assertEqual("10.10", version)
        self.assertNotEqual(version, "10.2")
        self.assertNotEqual("11", version)
        self.assertLess(version, "11.8.5")
        self.assertLess("10.2", version)
        self.assertLessEqual(version, "11")
        self.assertLessEqual("10.10", version)

        # Can have non-numeric versions (Bug 1654915)
        self.assertNotEqual(version, mozinfo.StringVersion("Testing"))
        self.assertNotEqual(mozinfo.StringVersion("Testing"), version)
        self.assertEqual(mozinfo.StringVersion(""), "")
        self.assertEqual("", mozinfo.StringVersion(""))

        a = mozinfo.StringVersion("1.2.5a")
        b = mozinfo.StringVersion("1.2.5b")
        self.assertLess(a, b)
        self.assertGreater(b, a)

        # Make sure we can compare against unicode (for python 2).
        self.assertEqual(a, u"1.2.5a")
        self.assertEqual(u"1.2.5a", a)

    def test_to_string(self):
        self.assertEqual("10.10", str(mozinfo.StringVersion("10.10")))


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