AMiRo-OS

#!/usr/bin/python

# -*- coding: utf-8; -*-

#

# Copyright (c) 2009 Google Inc. All rights reserved.

#

# Redistribution and use in source and binary forms, with or without

# modification, are permitted provided that the following conditions are

# met:

#

#    * Redistributions of source code must retain the above copyright

# notice, this list of conditions and the following disclaimer.

#    * Redistributions in binary form must reproduce the above

# copyright notice, this list of conditions and the following disclaimer

# in the documentation and/or other materials provided with the

# distribution.

#    * Neither the name of Google Inc. nor the names of its

# contributors may be used to endorse or promote products derived from

# this software without specific prior written permission.

#

# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT

# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,

# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY

# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

"""Unit test for cpplint.py."""

# TODO(unknown): Add a good test that tests UpdateIncludeState.

import codecs

import os

import random

import re

import sys

import unittest

import cpplint

# This class works as an error collector and replaces cpplint.Error

# function for the unit tests.  We also verify each category we see

# is in cpplint._ERROR_CATEGORIES, to help keep that list up to date.

class ErrorCollector(object):

  # These are a global list, covering all categories seen ever.

  _ERROR_CATEGORIES = cpplint._ERROR_CATEGORIES

  _SEEN_ERROR_CATEGORIES = {}

  def __init__(self, assert_fn):

    """assert_fn: a function to call when we notice a problem."""

    self._assert_fn = assert_fn

    self._errors = []

    cpplint.ResetNolintSuppressions()

  def __call__(self, unused_filename, linenum,

               category, confidence, message):

    self._assert_fn(category in self._ERROR_CATEGORIES,

                    'Message "%s" has category "%s",'

                    ' which is not in _ERROR_CATEGORIES' % (message, category))

    self._SEEN_ERROR_CATEGORIES[category] = 1

    if cpplint._ShouldPrintError(category, confidence, linenum):

      self._errors.append('%s  [%s] [%d]' % (message, category, confidence))

  def Results(self):

    if len(self._errors) < 2:

      return ''.join(self._errors)  # Most tests expect to have a string.

    else:

      return self._errors  # Let's give a list if there is more than one.

  def ResultList(self):

    return self._errors

  def VerifyAllCategoriesAreSeen(self):

    """Fails if there's a category in _ERROR_CATEGORIES~_SEEN_ERROR_CATEGORIES.

    This should only be called after all tests are run, so

    _SEEN_ERROR_CATEGORIES has had a chance to fully populate.  Since

    this isn't called from within the normal unittest framework, we

    can't use the normal unittest assert macros.  Instead we just exit

    when we see an error.  Good thing this test is always run last!

    """

    for category in self._ERROR_CATEGORIES:

      if category not in self._SEEN_ERROR_CATEGORIES:

        sys.exit('FATAL ERROR: There are no tests for category "%s"' % category)

  def RemoveIfPresent(self, substr):

    for (index, error) in enumerate(self._errors):

      if error.find(substr) != -1:

        self._errors = self._errors[0:index] + self._errors[(index + 1):]

        break

# This class is a lame mock of codecs. We do not verify filename, mode, or

# encoding, but for the current use case it is not needed.

class MockIo(object):

  def __init__(self, mock_file):

    self.mock_file = mock_file

  def open(self,  # pylint: disable-msg=C6409

           unused_filename, unused_mode, unused_encoding, _):

    return self.mock_file

class CpplintTestBase(unittest.TestCase):

  """Provides some useful helper functions for cpplint tests."""

  def setUp(self):

    # Allow subclasses to cheat os.path.abspath called in FileInfo class.

    self.os_path_abspath_orig = os.path.abspath

  def tearDown(self):

    os.path.abspath = self.os_path_abspath_orig

  # Perform lint on single line of input and return the error message.

  def PerformSingleLineLint(self, code):

    error_collector = ErrorCollector(self.assert_)

    lines = code.split('\n')

    cpplint.RemoveMultiLineComments('foo.h', lines, error_collector)

    clean_lines = cpplint.CleansedLines(lines)

    include_state = cpplint._IncludeState()

    function_state = cpplint._FunctionState()

    nesting_state = cpplint.NestingState()

    cpplint.ProcessLine('foo.cc', 'cc', clean_lines, 0,

                        include_state, function_state,

                        nesting_state, error_collector)

    # Single-line lint tests are allowed to fail the 'unlintable function'

    # check.

    error_collector.RemoveIfPresent(

        'Lint failed to find start of function body.')

    return error_collector.Results()

  # Perform lint over multiple lines and return the error message.

  def PerformMultiLineLint(self, code):

    error_collector = ErrorCollector(self.assert_)

    lines = code.split('\n')

    cpplint.RemoveMultiLineComments('foo.h', lines, error_collector)

    lines = cpplint.CleansedLines(lines)

    nesting_state = cpplint.NestingState()

    for i in xrange(lines.NumLines()):

      nesting_state.Update('foo.h', lines, i, error_collector)

      cpplint.CheckStyle('foo.h', lines, i, 'h', nesting_state,

                         error_collector)

      cpplint.CheckForNonStandardConstructs('foo.h', lines, i,

                                            nesting_state, error_collector)

    nesting_state.CheckCompletedBlocks('foo.h', error_collector)

    return error_collector.Results()

  # Similar to PerformMultiLineLint, but calls CheckLanguage instead of

  # CheckForNonStandardConstructs

  def PerformLanguageRulesCheck(self, file_name, code):

    error_collector = ErrorCollector(self.assert_)

    include_state = cpplint._IncludeState()

    nesting_state = cpplint.NestingState()

    lines = code.split('\n')

    cpplint.RemoveMultiLineComments(file_name, lines, error_collector)

    lines = cpplint.CleansedLines(lines)

    ext = file_name[file_name.rfind('.') + 1:]

    for i in xrange(lines.NumLines()):

      cpplint.CheckLanguage(file_name, lines, i, ext, include_state,

                            nesting_state, error_collector)

    return error_collector.Results()

  def PerformFunctionLengthsCheck(self, code):

    """Perform Lint function length check on block of code and return warnings.

    Builds up an array of lines corresponding to the code and strips comments

    using cpplint functions.

    Establishes an error collector and invokes the function length checking

    function following cpplint's pattern.

    Args:

      code: C++ source code expected to generate a warning message.

    Returns:

      The accumulated errors.

    """

    file_name = 'foo.cc'

    error_collector = ErrorCollector(self.assert_)

    function_state = cpplint._FunctionState()

    lines = code.split('\n')

    cpplint.RemoveMultiLineComments(file_name, lines, error_collector)

    lines = cpplint.CleansedLines(lines)

    for i in xrange(lines.NumLines()):

      cpplint.CheckForFunctionLengths(file_name, lines, i,

                                      function_state, error_collector)

    return error_collector.Results()

  def PerformIncludeWhatYouUse(self, code, filename='foo.h', io=codecs):

    # First, build up the include state.

    error_collector = ErrorCollector(self.assert_)

    include_state = cpplint._IncludeState()

    nesting_state = cpplint.NestingState()

    lines = code.split('\n')

    cpplint.RemoveMultiLineComments(filename, lines, error_collector)

    lines = cpplint.CleansedLines(lines)

    for i in xrange(lines.NumLines()):

      cpplint.CheckLanguage(filename, lines, i, '.h', include_state,

                            nesting_state, error_collector)

    # We could clear the error_collector here, but this should

    # also be fine, since our IncludeWhatYouUse unittests do not

    # have language problems.

    # Second, look for missing includes.

    cpplint.CheckForIncludeWhatYouUse(filename, lines, include_state,

                                      error_collector, io)

    return error_collector.Results()

  # Perform lint and compare the error message with "expected_message".

  def TestLint(self, code, expected_message):

    self.assertEquals(expected_message, self.PerformSingleLineLint(code))

  def TestMultiLineLint(self, code, expected_message):

    self.assertEquals(expected_message, self.PerformMultiLineLint(code))

  def TestMultiLineLintRE(self, code, expected_message_re):

    message =