Introduction

CodePolicy is a general code quality checker that can also make changes to the code. You can use it to check your code against the OTOBO code style guide.

How it can be used

on the command line

Call /path/to/CodePolicy/bin/otobo.CodePolicy.pl from the toplevel of your repository. Available options are:

• Checks changed files when no argument is given
• --all: Checks all files
• --directory: Checks a directory
• --file: Checks a file

pre commit hook

Call /path/to/CodePolicy/scripts/install-git-hooks.pl in every local repository that you want to have the pre commit hook. It will automatically be run by "git commit" and reject your commit if a problem was found. Skip with "git commit --no-verify".

unit test

Install package into OTOBO, then run bin/otobo.Console.pl Dev::UnitTest::Run.

Testing the CodePolicy itself

Run the test suite

The test suite does not require an installed OTOBO:

prove -r -v --merge -I Kernel/cpan-lib/ -I Kernel -I . 2>&1 | tee prove.out

Run the CodePolicy on itself

./bin/otobo.CodePolicy.pl -a 2>&1 | tee pol.out