glob2_test: Add tests for error callback functions and blocks

This change adds tests that check basic callback functionality for
blocks and function pointers. The tests also make sure that GLOB_ERR
overrides the callback's return value.

Sponsored by: Klara, Inc.
Differential Revision: https://reviews.freebsd.org/D50486