text: # 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.
  
  import contextlib
  import json
  import re
  import sys
  import os
  from os.path import join, dirname, abspath
  import tempfile
  import textwrap
  import unittest
  
  import six
  
  from pylint.lint import Run
  from pylint import __pkginfo__
  from pylint.reporters import BaseReporter
  from pylint.reporters.text import *
  from pylint.reporters.html import HTMLReporter
  from pylint.reporters.json import JSONReporter
  
  HERE = abspath(dirname(__file__))
  
  
  
  @contextlib.contextmanager
  def _patch_streams(out):
      sys.stderr = sys.stdout = out
      try:
          yield
      finally:
          sys.stderr = sys.__stderr__
          sys.stdout = sys.__stdout__
  
  
  class MultiReporter(BaseReporter):
      def __init__(self, reporters):
          self._reporters = reporters
          self.path_strip_prefix = os.getcwd() + os.sep
  
      def on_set_current_module(self, *args, **kwargs):
          for rep in self._reporters:
              rep.on_set_current_module(*args, **kwargs)
  
      def handle_message(self, msg):
          for rep in self._reporters:
              rep.handle_message(msg)
  
      def display_reports(self, layout):
          pass
  
      @property
      def out(self):
          return self._reporters[0].out
  
      @property
      def linter(self):
          return self._linter
  
      @linter.setter
      def linter(self, value):
          self._linter = value
          for rep in self._reporters:
              rep.linter = value
  
  
  class RunTC(unittest.TestCase):
  
      def _runtest(self, args, reporter=None, out=None, code=28):
          if out is None:
              out = six.StringIO()
          pylint_code = self._run_pylint(args, reporter=reporter, out=out)
          if reporter:
              output = reporter.out.getvalue()
          elif hasattr(out, 'getvalue'):
              output = out.getvalue()
          else:
              output = None
          msg = 'expected output status %s, got %s' % (code, pylint_code)
          if output is not None:
              msg = '%s. Below pylint output: \n%s' % (msg, output)
          self.assertEqual(pylint_code, code, msg)
  
      def _run_pylint(self, args, out, reporter=None):
          args = args + ['--persistent=no']
          with _patch_streams(out):
              with self.assertRaises(SystemExit) as cm:
                  with warnings.catch_warnings():
                      warnings.simplefilter("ignore")
                      Run(args, reporter=reporter)
              return cm.exception.code
  
      def _test_output(self, args, expected_output):
          out = six.StringIO()
          self._run_pylint(args, out=out)
          actual_output = out.getvalue()
          self.assertIn(expected_output.strip(), actual_output.strip())
  
      def test_pkginfo(self):
          """Make pylint check itself."""
          self._runtest(['pylint.__pkginfo__'], reporter=TextReporter(six.StringIO()),
                        code=0)
  
      def test_all(self):
          """Make pylint check itself."""
          reporters = [
              TextReporter(six.StringIO()),
              HTMLReporter(six.StringIO()),
              ColorizedTextReporter(six.StringIO()),
              JSONReporter(six.StringIO())
          ]
          self._runtest(['pylint/test/functional/arguments.py'],
                        reporter=MultiReporter(reporters), code=1)
  
      def test_no_ext_file(self):
          self._runtest([join(HERE, 'input', 'noext')], code=0)
  
      def test_w0704_ignored(self):
          self._runtest([join(HERE, 'input', 'ignore_except_pass_by_default.py')], code=0)
  
      def test_generate_config_option(self):
          self._runtest(['--generate-rcfile'], code=0)
  
      def test_generate_config_disable_symbolic_names(self):
          # Test that --generate-rcfile puts symbolic names in the --disable
          # option.
  
          out = six.StringIO()
          self._run_pylint(["--generate-rcfile", "--rcfile="], out=out)
  
          output = out.getvalue()
          # Get rid of the pesky messages that pylint emits if the
          # configuration file is not found.
          master = re.search("\[MASTER", output)        
          out = six.StringIO(output[master.start():])
          parser = six.moves.configparser.RawConfigParser()
          parser.readfp(out)
          messages = parser.get('MESSAGES CONTROL', 'disable').split(",")
          self.assertIn('suppressed-message', messages)
  
      def test_generate_rcfile_no_obsolete_methods(self):
          out = six.StringIO()
          self._run_pylint(["--generate-rcfile"], out=out)
          output = out.getvalue()
          self.assertNotIn("profile", output)
  
      def _test_deprecated_options(self, option, expected):
          out = six.StringIO()
          self._run_pylint([option, "--rcfile=", "pylint.config"], out=out)
          output = out.getvalue()
          if __pkginfo__.numversion >= (1, 6, 0):
              self.assertIn("no such option", output)
          else:
              self.assertIn(expected, output)
  
      def test_deprecated_options_zope(self):
          expected = ("option --zope is obsolete and it is "
                      "slated for removal in Pylint 1.6")
          self._test_deprecated_options("--zope=y", expected)
  
      def test_deprecated_options_symbols(self):
          expected = ("option --symbols is obsolete and it is "
                      "slated for removal in Pylint 1.6")
          self._test_deprecated_options("--symbols=y", expected)
  
      def test_deprecated_options_include_ids(self):
          expected = ("option --include-ids is obsolete and it is "
                      "slated for removal in Pylint 1.6")
          self._test_deprecated_options("--include-ids=y", expected)
  
      def test_deprecated_options_profile(self):
          expected = ("option --profile is obsolete and it is "
                      "slated for removal in Pylint 1.6")
          self._test_deprecated_options("--profile=y", expected)
  
      def test_help_message_option(self):
          self._runtest(['--help-msg', 'W0101'], code=0)
  
      def test_error_help_message_option(self):
          self._runtest(['--help-msg', 'WX101'], code=0)
  
      def test_error_missing_arguments(self):
          self._runtest([], code=32)
  
      def test_no_out_encoding(self):
          """test redirection of stdout with non ascii caracters
          """
          #This test reproduces bug #48066 ; it happens when stdout is redirected
          # through '>' : the sys.stdout.encoding becomes then None, and if the
          # output contains non ascii, pylint will crash
          if sys.version_info < (3, 0):
              strio = tempfile.TemporaryFile()
          else:
              strio = six.StringIO()
          assert strio.encoding is None
          self._runtest([join(HERE, 'regrtest_data/no_stdout_encoding.py')],
                        out=strio)
  
      def test_parallel_execution(self):
          self._runtest(['-j 2', 'pylint/test/functional/arguments.py',
                         'pylint/test/functional/bad_continuation.py'], code=1)
  
      def test_parallel_execution_missing_arguments(self):
          self._runtest(['-j 2', 'not_here', 'not_here_too'], code=1)
  
      def test_py3k_option(self):
          # Test that --py3k flag works.
          rc_code = 2 if six.PY2 else 0
          self._runtest([join(HERE, 'functional', 'unpacked_exceptions.py'),
                         '--py3k'],
                        code=rc_code)
  
      def test_py3k_jobs_option(self):
          rc_code = 2 if six.PY2 else 0
          self._runtest([join(HERE, 'functional', 'unpacked_exceptions.py'),
                         '--py3k', '-j 2'],
                        code=rc_code)
  
      @unittest.skipIf(sys.version_info[0] > 2, "Requires the --py3k flag.")
      def test_py3k_commutative_with_errors_only(self):
  
          # Test what gets emitted with -E only
          module = join(HERE, 'regrtest_data', 'py3k_error_flag.py')
          expected = textwrap.dedent("""
          No config file found, using default configuration
          ************* Module py3k_error_flag
          Explicit return in __init__
          """)
          self._test_output([module, "-E", "--msg-template='{msg}'"],
                            expected_output=expected)
  
          # Test what gets emitted with -E --py3k
          expected = textwrap.dedent("""
          No config file found, using default configuration
          ************* Module py3k_error_flag
          Use raise ErrorClass(args) instead of raise ErrorClass, args.
          """)
          self._test_output([module, "-E", "--py3k", "--msg-template='{msg}'"],
                            expected_output=expected)
  
          # Test what gets emitted with --py3k -E
          self._test_output([module, "--py3k", "-E", "--msg-template='{msg}'"],
                            expected_output=expected)
  
      def test_abbreviations_are_not_supported(self):
          expected = "no such option: --load-plugin"
          self._test_output([".", "--load-plugin"], expected_output=expected)
  
      def test_enable_all_works(self):
          module = join(HERE, 'data', 'clientmodule_test.py')
          expected = textwrap.dedent("""
          No config file found, using default configuration
          ************* Module data.clientmodule_test
          W: 10, 8: Unused variable 'local_variable' (unused-variable)
          C: 18, 4: Missing method docstring (missing-docstring)
          C: 22, 0: Missing class docstring (missing-docstring)
          """)
          self._test_output([module, "--disable=all", "--enable=all", "-rn"],
                            expected_output=expected)
  
      def test_html_crash_report(self):
          out = six.StringIO()
          module = join(HERE, 'regrtest_data', 'html_crash_420.py')
          self._runtest([module], code=16, reporter=HTMLReporter(out))
  
      def test_wrong_import_position_when_others_disabled(self):
          expected_output = textwrap.dedent('''
          No config file found, using default configuration
          ************* Module wrong_import_position
          C: 11, 0: Import "import os" should be placed at the top of the module (wrong-import-position)
          ''')
          module1 = join(HERE, 'regrtest_data', 'import_something.py')
          module2 = join(HERE, 'regrtest_data', 'wrong_import_position.py')
          args = [module2, module1,
                  "--disable=all", "--enable=wrong-import-position",
                  "-rn"]
          out = six.StringIO()
          self._run_pylint(args, out=out)
          actual_output = out.getvalue()
          self.assertEqual(expected_output.strip(), actual_output.strip())
  
      def test_import_itself_not_accounted_for_relative_imports(self):
          expected = 'No config file found, using default configuration'
          package = join(HERE, 'regrtest_data', 'dummy')
          self._test_output([package, '--disable=locally-disabled', '-rn'],
                            expected_output=expected)
                             
  
      def test_json_report_when_file_has_syntax_error(self):
          out = six.StringIO()
          module = join(HERE, 'regrtest_data', 'syntax_error.py')
          self._runtest([module], code=2, reporter=JSONReporter(out))
          output = json.loads(out.getvalue())
          self.assertIsInstance(output, list)
          self.assertEqual(len(output), 1)
          self.assertIsInstance(output[0], dict)
          expected = {
              "obj": "",
              "column": 0,
              "line": 1,
              "type": "error",
              "symbol": "syntax-error",
              "module": "syntax_error"
          }
          message = output[0]
          for key, value in expected.items():
              self.assertIn(key, message)
              self.assertEqual(message[key], value)
          self.assertIn("invalid syntax", message["message"].lower())
  
      def test_json_report_when_file_is_missing(self):
          out = six.StringIO()
          module = join(HERE, 'regrtest_data', 'totally_missing.py')
          self._runtest([module], code=1, reporter=JSONReporter(out))
          output = json.loads(out.getvalue())
          self.assertIsInstance(output, list)
          self.assertEqual(len(output), 1)
          self.assertIsInstance(output[0], dict)
          expected = {
              "obj": "",
              "column": 0,
              "line": 1,
              "type": "fatal",
              "symbol": "fatal",
              "module": module
          }
          message = output[0]
          for key, value in expected.items():
              self.assertIn(key, message)
              self.assertEqual(message[key], value)
          self.assertTrue(message['message'].startswith("No module named"))
  
  
  
  if __name__ == '__main__':
      unittest.main()
  