Bug 51103 – check-webkit-style should check for XML syntax errors in .vcproj/.vsprops files

• Status: RESOLVED
• Resolution: FIXED
• Component: Tools / Tests

[Adam Roben (:aroben)]

It's a pretty common mistake for people to introduce XML syntax errors into .vcproj/.vsprops when editing them by hand (see bug 51029 comment 3 for some examples). It would be great if check-webkit-style could catch these errors!

[David Levin]

Sounds like you want a new checker.

Here's how to do that:

1. Add a new checker
  a. Create a file WebKitTools/Scripts/webkitpy/style/checkers/vc_proj.py
  b. Fill in the checker to do what you want. 
     i. Use WebKitTools/Scripts/webkitpy/style/checkers/text.py as a simple example.  
    ii. Name it something like VcProjChecker
  c. Create a simple unit test for it. ?(WebKitTools/Scripts/webkitpy/style/checkers/text_unittest.py is a nice example)


2. You need to teach the style checker about the new file type:
  a. In WebKitTools/Scripts/webkitpy/style/checker.py
      Add a new file type to
         class FileType:
      Something like VCPROJ
   b. Make CheckerDispatcher._file_type return this file type for vcproj/vsprops files.
   c. Make CheckerDispatcher._create_checker return your new checker: VCProjChecker

3. Enjoy the fact that these error will be caught automatically.

[Adam Roben (:aroben)]

Created attachment 76648 [details]
Teach check-webkit-style to check .vcproj and .vsprops files for XML syntax errors

[David Levin]

Comment on attachment 76648 [details]
Teach check-webkit-style to check .vcproj and .vsprops files for XML syntax errors

Excellent!

[Adam Roben (:aroben)]

Committed r74149: <http://trac.webkit.org/changeset/74149>

[Ojan Vafai]

Committed r74158: <http://trac.webkit.org/changeset/74158>

[David Levin]

Ojan something went wrong here.... Was it the commit queue or something done by hand, etc.?

[Ojan Vafai]

(In reply to comment #6)
> Ojan something went wrong here.... Was it the commit queue or something done by hand, etc.?

It was webkit-patch. This is the age-old problem of webkit-patch doing the wrong thing if the new changelog entry is not at the top. Alterately, the bug is with resolve-ChangeLogs, which did not put the changelog entry at the top when I synced.

[Eric Seidel (no email)]

https://bugs.webkit.org/show_bug.cgi?id=28291

[Eric Seidel (no email)]

This caused a python warning when running the tests under python 2.6

Something about BaseException.message being deprecated.

[David Levin]

(In reply to comment #9)
> This caused a python warning when running the tests under python 2.6
> 
> Something about BaseException.message being deprecated.

Fix is here https://bugs.webkit.org/show_bug.cgi?id=51210