Fix the .ycm_extra_conf.py and SublimeText documentation.

tools/vim/tests/chromium.ycm_extra_conf_unittest.py

 #!/usr/bin/env python
 
 # Copyright 2015 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 """Tests for chromium.ycm_extra_conf.
 
 These tests should be getting picked up by the PRESUBMIT.py in /tools/vim.
 Currently the tests only run on Linux and require 'ninja' to be available on
@@ skipping 35 matching lines @@
       with open(copy_from, 'r') as source:
         contents = source.read()
         if format_with:
           formatter = string.Formatter()
           contents = formatter.vformat(contents, None, format_with)
         f.write(contents)
   if make_executable:
     statinfo = os.stat(path)
     os.chmod(path, statinfo.st_mode | stat.S_IXUSR)
 
-@unittest.skipIf(sys.platform.startswith('linux'),
-                 'Tests are only valid on Linux.')
-class Chromium_ycmExtraConfTest_NotOnLinux(unittest.TestCase):
-  def testAlwaysFailsIfNotRunningOnLinux(self):
-    self.fail('Changes to chromium.ycm_extra_conf.py currently need to be ' \
-              'uploaded from Linux since the tests only run on Linux.')
-
-@unittest.skipUnless(sys.platform.startswith('linux'),
-                     'Tests are only valid on Linux.')
 class Chromium_ycmExtraConfTest(unittest.TestCase):
 
   def SetUpFakeChromeTreeBelowPath(self):
     """Create fake Chromium source tree under self.test_root.
 
     The fake source tree has the following contents:
 
     <self.test_root>
       |  .gclient
       |
@@ skipping 22 matching lines @@
 
     # Fake ninja build file. Applications of 'cxx' rule are tagged by which
     # source file was used as input so that the test can verify that the correct
     # build dependency was used.
     CreateFile(os.path.join(self.out_dir, 'build.ninja'),
                copy_from=os.path.join(self.test_data_path,
                                       'fake_build_ninja.txt'))
 
   def NormalizeString(self, string):
     return string.replace(self.out_dir, '[OUT]').\
-        replace(self.chrome_root, '[SRC]')
+        replace(self.chrome_root, '[SRC]').replace('\\', '/')
 
   def NormalizeStringsInList(self, list_of_strings):
     return [self.NormalizeString(s) for s in list_of_strings]
 
   def setUp(self):
     self.actual_chrome_root = os.path.normpath(
         os.path.join(os.path.dirname(os.path.abspath(__file__)), '../../..'))
     sys.path.append(os.path.join(self.actual_chrome_root, 'tools', 'vim'))
     self.test_data_path = os.path.join(self.actual_chrome_root, 'tools', 'vim',
                                        'tests', 'data')
     self.ycm_extra_conf = imp.load_source('ycm_extra_conf',
                                           'chromium.ycm_extra_conf.py')
     self.test_root = tempfile.mkdtemp()
     self.SetUpFakeChromeTreeBelowPath()
 
   def tearDown(self):
-    if self.test_root:
+    if False and self.test_root:

[scottmg, 2016/06/06 16:32:11]

?

[pastarmovj, 2016/06/07 08:52:29]

Sorry I needed to preserve the test files while fixing the test. I reverted
this. :)

       shutil.rmtree(self.test_root)
 
   def testNinjaIsAvailable(self):
     p = subprocess.Popen(['ninja', '--version'], stdout=subprocess.PIPE)
     _, _ = p.communicate()
     self.assertFalse(p.returncode)
 
   def testFindChromeSrc(self):
     chrome_source = self.ycm_extra_conf.FindChromeSrcFromFilename(
         os.path.join(self.chrome_root, 'chrome', 'one.cpp'))
@@ skipping 30 matching lines @@
 
   def testOutDirNames(self):
     out_root = os.path.join(self.chrome_root, 'out_with_underscore')
     out_dir = os.path.join(out_root, 'gn')
     shutil.move(os.path.join(self.chrome_root, 'out'),
         out_root)
 
     clang_options = \
         self.ycm_extra_conf.GetClangOptionsFromNinjaForFilename(
             self.chrome_root, os.path.join(self.chrome_root, 'one.cpp'))
-    self.assertIn('-I%s/a' % out_dir, clang_options)
-    self.assertIn('-I%s/tag-one' % out_dir, clang_options)
+    self.assertIn('-I%s/a' % self.NormalizeString(out_dir),
+        self.NormalizeStringsInList(clang_options))
+    self.assertIn('-I%s/tag-one' % self.NormalizeString(out_dir),
+        self.NormalizeStringsInList(clang_options))
 
   def testGetFlagsForFileForKnownCppFile(self):
     result = self.ycm_extra_conf.FlagsForFile(
         os.path.join(self.chrome_root, 'one.cpp'))
     self.assertTrue(result)
     self.assertTrue('do_cache' in result)
     self.assertTrue(result['do_cache'])
     self.assertTrue('flags' in result)
     self.assertEquals(self.NormalizeStringsInList(result['flags']), [
         '-DUSE_CLANG_COMPLETER',
@@ skipping 119 matching lines @@
         '-isysroot',
         '/mac.sdk',
         '-I[OUT]/tag-three'
         ])
 
   def testSourceFileWithNonClangOutputs(self):
     # Verify assumption that four.cc has non-compiler-output listed as the first
     # output.
     p = subprocess.Popen(['ninja', '-C', self.out_dir, '-t',
                           'query', '../../four.cc'],
-                         stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
+                         stdout=subprocess.PIPE, stderr=subprocess.STDOUT,
+                         universal_newlines=True)
     stdout, _ = p.communicate()
     self.assertFalse(p.returncode)
     self.assertEquals(stdout,
                       '../../four.cc:\n'
                       '  outputs:\n'
                       '    obj/linker-output.o\n'
                       '    obj/four.o\n')
 
     result = self.ycm_extra_conf.FlagsForFile(
         os.path.join(self.chrome_root, 'four.cc'))
@@ skipping 64 matching lines @@
         '-Wno-unknown-warning-option',
         '-I[OUT]/a',
         '--sysroot=[SRC]/build/sysroot-image',
         ])
 
 if __name__ == '__main__':
   if not os.path.isfile('chromium.ycm_extra_conf.py'):
     print('The test must be run from src/tools/vim/ directory')
     sys.exit(1)
   unittest.main()