Skip to content

feat: Add optional regex engine #110

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
KlfJoat wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: Add optional regex engine #110

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -754,9 +754,11 @@ On failure, the path and expected regex are displayed.
Fail if the given file contains the regex or if the file does not exist.
```bash
@test 'assert_file_not_contains() {
assert_file_not_contains /path/to/non-empty-file regex
assert_file_not_contains /path/to/non-empty-file regex engine
}
```
`engine` is optional and can be one of `grep`, `egrep` or `pcregrep`. The specified engine must be available on the system running the tests.

On failure, the path and regex are displayed.

[Back to index](#Index-of-all-functions)
Expand Down
36 changes: 26 additions & 10 deletions src/file.bash
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -542,7 +542,7 @@ assert_file_contains() {
local -r file="$1"
local -r regex="$2"
local -r cmd="${3:-grep}"

case "$cmd" in
grep|egrep|pcregrep)
if ! type "${cmd}" &>/dev/null; then
Expand All @@ -552,7 +552,7 @@ assert_file_contains() {
;;
*)
batslib_decorate "Regex engine \"${cmd}\" not in allow list" \
| fail
| fail
;;
esac
if ! "$cmd" -q "$regex" "$file"; then
Expand All @@ -563,7 +563,8 @@ assert_file_contains() {
| fail
fi
}
# Fail and display path of the file (or directory) if it does contain a string.
# Fail and display path of the file (or directory) if it does contain a string
# or if the file does not exist.
# This function is the logical complement of `assert_file_contains'.
#
# Globals:
Expand All @@ -572,6 +573,7 @@ assert_file_contains() {
# Arguments:
# $1 - path
# $2 - regex
# $3 - grep engine to use (grep, egrep, pcregrep) - optional
# Returns:
# 0 - file does not contain regex
# 1 - otherwise
Expand All @@ -580,21 +582,35 @@ assert_file_contains() {
assert_file_not_contains() {
local -r file="$1"
local -r regex="$2"
local -r cmd="${3:-grep}"

if [[ ! -f "$file" ]]; then
local -r rem="${BATSLIB_FILE_PATH_REM-}"
local -r add="${BATSLIB_FILE_PATH_ADD-}"
batslib_print_kv_single 4 'path' "${file/$rem/$add}" 'regex' "$regex" \
| batslib_decorate 'file does not exist' \
| fail

elif grep -q "$regex" "$file"; then
local -r rem="${BATSLIB_FILE_PATH_REM-}"
local -r add="${BATSLIB_FILE_PATH_ADD-}"
batslib_print_kv_single 4 'path' "${file/$rem/$add}" 'regex' "$regex" \
| batslib_decorate 'file contains regex' \
| fail

else
case "$cmd" in
grep|egrep|pcregrep)
if ! type "${cmd}" &>/dev/null; then
batslib_decorate "Regex engine \"${cmd}\" not available on this system" \
| fail
fi
;;
*)
batslib_decorate "Regex engine \"${cmd}\" not in allow list" \
| fail
;;
esac
if "$cmd" -q "$regex" "$file"; then
local -r rem="${BATSLIB_FILE_PATH_REM-}"
local -r add="${BATSLIB_FILE_PATH_ADD-}"
batslib_print_kv_single 4 'path' "${file/$rem/$add}" 'regex' "$regex" \
| batslib_decorate 'file contains regex' \
| fail
fi
fi
}
# Fail and display path of the file (or directory) if it is not empty.
Expand Down