Since we are not robots (yet), it is very possible to forget taking a Cppcheck before committing code to the SVN server. Organizations that uses Cppcheck (or any other code analysis tool), usually perform the code analysis once a day/week/month. Then usually the team leader assign a task to some developer to fix the issue, commit the code, wait for the next code analysis and we start this cycle once again. Sometimes, code analysis is taken after a build was already released to QA, or even worse, to customers.
So we all know that asking your developers to take a Cppcheck before every commit they take is not feasible. However, this process can be automated (and in some way also invisible) for the developers. Attached to this page a script which will automatically force a Cppcheck on all source files that are being committed when every commit is triggered (before commit is actually performed) with a zero effort from the developers. In case of issues found, the script will fail the commit so the developer can fix the issues and commit only Cppcheck-checked code (failing the commit can be bypassed if needed). The great value of this approach is that we can fix the issues before they are committed to the SVN server!
- Download the "SVN_Pre_Commit_Hook__CppCheck_Validate.bat" script to your machine and edit it:
- cppCheckPath - Full path to your CppCheck.exe (not CppCheckGui.exe).
- supportedFileTypes - Add or remove file types to check. This variable is here so the script won't check '.sln', '.vxproj' and other non-source file types.
- enableScript - '1' or '0' to enable/disable running the script.
- Right click (somewhere on desktop) --> Tortoise SVN --> Settings --> Hook Scripts --> Add...
- Configure Hook Scripts:
- Hook Type: Choose 'Pre-Commit Hook' (upper right corner).
- Working Copy Path: The directory that all of your SVN checkouts are done. Use the top most directory (or just use 'C:\' for example).
- Command Line To Execute: Full path to the attached script.
- Make sure that both 'Wait for the script to finish' and 'Hide the script while running' checkboxes are checked --> OK --> OK.
- Even if the commit failed because of the Cppcheck, SVN gives you the option to easily recommit disregarding the failure by clicking the 'Retry without hooks' button. If commit succeeded (meaning, Cppcheck did not find any issues), it will look like nothing happened (so developers will still see a commit end message just like before).
- If you want to implement this solution in your organization/team you can do it in two different approaches:
- Client side solution - Meaning, the steps above should be taken for all of your development machines. The benefit in this approach is that only relevant teams can use this solution and not all of the developers that are working on the SVN server. Besides, ignoring this Cppcheck (in case of false-positives for example) is quite easy using one button click integrated in the Tortoise Client ('Retry without hooks'). This approach means that Cppcheck must be installed on all of the relevant developers machines of course.
- Server side solution - Meaning, Cppcheck should be installed only on the SVN server and the steps above should be taken only once (server side only). So clients (developers' machines) should take no action since every commit will trigger the hook at server side. The benefit is this is taken only once, but this solution may be to restrictive for some organizations. In addition, in order to ignore the hook (once again, false-positive for example) - you need to create some 'back-door' script that will allow developers to bypass it with a specific keyword in the commit message.
- More about SVN hook scripts - Client Hook Scripts, Server Hook Scripts.
All you need to do is take the Configuration steps above just once. Afterwards, you can work with SVN the same as before, just now you get to see your failures before code is committed to the SVN server.
Please let me know with any issues or enhancements to take - Elad Erez.