166a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis#!/usr/bin/env python
266a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis# Copyright (c) 2012 The Chromium Authors. All rights reserved.
366a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis# Use of this source code is governed by a BSD-style license that can be
466a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis# found in the LICENSE file.
566a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis
666a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis'''Unit test that checks some of util functions.
766a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis'''
866a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis
966a37686207944273ced825e0e8b6b6375f8c3deJamie Gennisimport os
1066a37686207944273ced825e0e8b6b6375f8c3deJamie Gennisimport sys
1166a37686207944273ced825e0e8b6b6375f8c3deJamie Gennisif __name__ == '__main__':
1266a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis  sys.path.append(os.path.join(os.path.dirname(__file__), '..'))
1366a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis
1466a37686207944273ced825e0e8b6b6375f8c3deJamie Gennisimport unittest
1566a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis
1666a37686207944273ced825e0e8b6b6375f8c3deJamie Gennisfrom grit import util
1766a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis
1866a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis
1966a37686207944273ced825e0e8b6b6375f8c3deJamie Gennisclass UtilUnittest(unittest.TestCase):
2066a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis  ''' Tests functions from util
2166a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis  '''
2266a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis
2366a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis  def testNewClassInstance(self):
2466a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis    # Test short class name with no fully qualified package name
2566a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis    # Should fail, it is not supported by the function now (as documented)
2666a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis    cls = util.NewClassInstance('grit.util.TestClassToLoad',
2766a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis                                TestBaseClassToLoad)
2866a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis    self.failUnless(cls == None)
2966a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis
3066a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis    # Test non existent class name
3166a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis    cls = util.NewClassInstance('grit.util_unittest.NotExistingClass',
3266a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis                                TestBaseClassToLoad)
3366a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis    self.failUnless(cls == None)
3466a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis
3566a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis    # Test valid class name and valid base class
3666a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis    cls = util.NewClassInstance('grit.util_unittest.TestClassToLoad',
3766a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis                                TestBaseClassToLoad)
3866a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis    self.failUnless(isinstance(cls, TestBaseClassToLoad))
3966a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis
4066a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis    # Test valid class name with wrong hierarchy
4166a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis    cls = util.NewClassInstance('grit.util_unittest.TestClassNoBase',
4266a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis                                TestBaseClassToLoad)
4366a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis    self.failUnless(cls == None)
4466a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis
4566a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis  def testCanonicalLanguage(self):
4666a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis    self.failUnless(util.CanonicalLanguage('en') == 'en')
4766a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis    self.failUnless(util.CanonicalLanguage('pt_br') == 'pt-BR')
4866a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis    self.failUnless(util.CanonicalLanguage('pt-br') == 'pt-BR')
4966a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis    self.failUnless(util.CanonicalLanguage('pt-BR') == 'pt-BR')
5066a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis    self.failUnless(util.CanonicalLanguage('pt/br') == 'pt-BR')
5166a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis    self.failUnless(util.CanonicalLanguage('pt/BR') == 'pt-BR')
5266a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis    self.failUnless(util.CanonicalLanguage('no_no_bokmal') == 'no-NO-BOKMAL')
5366a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis
5466a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis  def testUnescapeHtml(self):
5566a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis    self.failUnless(util.UnescapeHtml('ϲ') == unichr(1010))
5666a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis    self.failUnless(util.UnescapeHtml('ꯍ') == unichr(43981))
5766a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis
5866a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis  def testRelativePath(self):
5966a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis    """ Verify that MakeRelativePath works in some tricky cases."""
6066a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis
6166a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis    def TestRelativePathCombinations(base_path, other_path, expected_result):
6266a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis      """ Verify that the relative path function works for
6366a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis      the given paths regardless of whether or not they end with
6466a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis      a trailing slash."""
6566a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis      for path1 in [base_path, base_path + os.path.sep]:
6666a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis        for path2 in [other_path, other_path + os.path.sep]:
6766a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis          result = util.MakeRelativePath(path1, path2)
6866a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis          self.failUnless(result == expected_result)
6966a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis
7066a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis    # set-up variables
7166a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis    root_dir = 'c:%sa' % os.path.sep
7266a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis    result1 = '..%sabc' % os.path.sep
7366a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis    path1 = root_dir + 'bc'
7466a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis    result2 = 'bc'
7566a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis    path2 = '%s%s%s' % (root_dir, os.path.sep, result2)
7666a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis    # run the tests
7766a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis    TestRelativePathCombinations(root_dir, path1, result1)
7866a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis    TestRelativePathCombinations(root_dir, path2, result2)
7966a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis
8066a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis  def testReadFile(self):
8166a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis    def Test(data, encoding, expected_result):
8266a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis      with open('testfile', 'wb') as f:
8366a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis        f.write(data)
8466a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis      if util.ReadFile('testfile', encoding) != expected_result:
8566a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis        print (util.ReadFile('testfile', encoding), expected_result)
8666a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis      self.failUnless(util.ReadFile('testfile', encoding) == expected_result)
8766a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis
8866a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis    test_std_newline = '\xEF\xBB\xBFabc\ndef'  # EF BB BF is UTF-8 BOM
8966a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis    newlines = ['\n', '\r\n', '\r']
9066a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis
9166a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis    with util.TempDir({}) as tmp_dir:
9266a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis      with tmp_dir.AsCurrentDir():
9366a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis        for newline in newlines:
9466a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis          test = test_std_newline.replace('\n', newline)
9566a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis          Test(test, util.BINARY, test)
9666a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis          # RAW_TEXT uses universal newline mode
9766a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis          Test(test, util.RAW_TEXT, test_std_newline)
9866a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis          # utf-8 doesn't strip BOM
9966a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis          Test(test, 'utf-8', test_std_newline.decode('utf-8'))
10066a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis          # utf-8-sig strips BOM
10166a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis          Test(test, 'utf-8-sig', test_std_newline.decode('utf-8')[1:])
10266a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis          # test another encoding
10366a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis          Test(test, 'cp1252', test_std_newline.decode('cp1252'))
10466a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis        self.assertRaises(UnicodeDecodeError, Test, '\x80', 'utf-8', None)
10566a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis
10666a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis
10766a37686207944273ced825e0e8b6b6375f8c3deJamie Gennisclass TestBaseClassToLoad(object):
10866a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis  pass
10966a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis
11066a37686207944273ced825e0e8b6b6375f8c3deJamie Gennisclass TestClassToLoad(TestBaseClassToLoad):
11166a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis  pass
11266a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis
11366a37686207944273ced825e0e8b6b6375f8c3deJamie Gennisclass TestClassNoBase(object):
11466a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis  pass
11566a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis
11666a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis
11766a37686207944273ced825e0e8b6b6375f8c3deJamie Gennisif __name__ == '__main__':
11866a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis  unittest.main()
11966a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis
12066a37686207944273ced825e0e8b6b6375f8c3deJamie Gennis