Clean up the CMake build system a bit

Most porting to use ecm_add_test and target_include_directories,
couple fixes of include paths and linking libraries. We try to make
sure that libs and apps don't have any other include paths other than
their own and those provided by their dependencies.

This will be useful in future if we try to split the kdepim repo.