# Copyright 2013 Google Inc. All Rights Reserved.
#
# 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.,
# 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
"""
Tests for the misc checker.
"""
import sys
import tempfile
import os
import contextlib

from logilab.common.testlib import unittest_main
from astroid import test_utils
from pylint.checkers import misc, variables
from pylint.testutils import CheckerTestCase, Message, linter

REGR_DATA = os.path.join(os.path.dirname(os.path.abspath(__file__)),
                         'regrtest_data')
sys.path.insert(1, REGR_DATA)

@contextlib.contextmanager
def create_file_backed_module(code):
    # Can't use tempfile.NamedTemporaryFile here
    # because on Windows the file must be closed before writing to it,
    # see http://bugs.python.org/issue14243
    fd, tmp = tempfile.mkstemp()
    if sys.version_info >= (3, 0):
        # erff
        os.write(fd, bytes(code, 'ascii'))
    else:
        os.write(fd, code)

    try:
        module = test_utils.build_module(code)
        module.file = tmp
        yield module
    finally:
        os.close(fd)
        os.remove(tmp)


class FixmeTest(CheckerTestCase):
    CHECKER_CLASS = misc.EncodingChecker

    def test_fixme(self):
        with create_file_backed_module(
            """a = 1
            # FIXME """) as module:
            with self.assertAddsMessages(
                Message(msg_id='W0511', line=2, args=u'FIXME')):
                self.checker.process_module(module)

    def test_empty_fixme_regex(self):
        self.checker.config.notes = []
        with create_file_backed_module(
            """a = 1
            # fixme
            """) as module:
            with self.assertNoMessages():
                self.checker.process_module(module)

class MissingSubmoduleTest(CheckerTestCase):
    CHECKER_CLASS = variables.VariablesChecker

    def test_package_all(self):
        linter.check(os.path.join(REGR_DATA, 'package_all'))
        got = linter.reporter.finalize().strip()
        self.assertEqual(got, 'W:  3: Missing submodule: missing')

if __name__ == '__main__':
    unittest_main()