forked from ztombol/bats-file
-
Notifications
You must be signed in to change notification settings - Fork 35
/
Copy pathfile.bash
1097 lines (1037 loc) · 29.6 KB
/
file.bash
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#
# bats-file - Common filesystem assertions and helpers for Bats
#
# Written in 2016 by Zoltan Tombol <zoltan dot tombol at gmail dot com>
#
# To the extent possible under law, the author(s) have dedicated all
# copyright and related and neighboring rights to this software to the
# public domain worldwide. This software is distributed without any
# warranty.
#
# You should have received a copy of the CC0 Public Domain Dedication
# along with this software. If not, see
# <http://creativecommons.org/publicdomain/zero/1.0/>.
#
#
# file.bash
# ---------
#
# Assertions are functions that perform a test and output relevant
# information on failure to help debugging. They return 1 on failure
# and 0 otherwise.
#
# All output is formatted for readability using the functions of
# `output.bash' and sent to the standard error.
#
# Fail and display path of the file or directory if it does not exist.
# This function is the logical complement of `assert_not_exists'.
#
# Globals:
# BATSLIB_FILE_PATH_REM
# BATSLIB_FILE_PATH_ADD
# Arguments:
# $1 - path
# Returns:
# 0 - file or directory exists
# 1 - otherwise
# Outputs:
# STDERR - details, on failure
assert_exists() {
local -r file="$1"
if [[ ! -e "$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}" \
| batslib_decorate 'file or directory does not exist' \
| fail
fi
}
# Fail and display path of the file if it does not exist.
# This function is the logical complement of `assert_file_not_exists'.
#
# Globals:
# BATSLIB_FILE_PATH_REM
# BATSLIB_FILE_PATH_ADD
# Arguments:
# $1 - path
# Returns:
# 0 - file exists
# 1 - otherwise
# Outputs:
# STDERR - details, on failure
assert_file_exists() {
local -r file="$1"
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}" \
| batslib_decorate 'file does not exist' \
| fail
fi
}
# Fail and display path of the directory if it does not exist.
# This function is the logical complement of `assert_dir_not_exists'.
#
# Globals:
# BATSLIB_FILE_PATH_REM
# BATSLIB_FILE_PATH_ADD
# Arguments:
# $1 - path
# Returns:
# 0 - directory exists
# 1 - otherwise
# Outputs:
# STDERR - details, on failure
assert_dir_exists() {
local -r file="$1"
if [[ ! -d "$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}" \
| batslib_decorate 'directory does not exist' \
| fail
fi
}
# Fail and display path of the block special file if it does not exist.
# This function is the logical complement of `assert_block_not_exists'.
#
# Globals:
# BATSLIB_FILE_PATH_REM
# BATSLIB_FILE_PATH_ADD
# Arguments:
# $1 - path
# Returns:
# 0 - block special file exists
# 1 - otherwise
# Outputs:
# STDERR - details, on failure
assert_block_exists() {
local -r file="$1"
if [[ ! -b "$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}" \
| batslib_decorate 'block special file does not exist' \
| fail
fi
}
# Fail and display path of the character special file if it does not exist.
# This function is the logical complement of `assert_character_not_exists'.
#
# Globals:
# BATSLIB_FILE_PATH_REM
# BATSLIB_FILE_PATH_ADD
# Arguments:
# $1 - path
# Returns:
# 0 - character special file exists
# 1 - otherwise
# Outputs:
# STDERR - details, on failure
assert_character_exists() {
local -r file="$1"
if [[ ! -c "$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}" \
| batslib_decorate 'character special file does not exist' \
| fail
fi
}
# Fail and display path of the symbolic link if it does not exist.
# This function is the logical complement of `assert_link_not_exists'.
#
# Globals:
# BATSLIB_FILE_PATH_REM
# BATSLIB_FILE_PATH_ADD
# Arguments:
# $1 - path
# Returns:
# 0 - symbolic link exists
# 1 - otherwise
# Outputs:
# STDERR - details, on failure
assert_link_exists() {
local -r file="$1"
if [[ ! -L "$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}" \
| batslib_decorate 'symbolic link does not exist' \
| fail
fi
}
# Fail and display path of the socket if it does not exist.
# This function is the logical complement of `assert_socket_not_exists'.
#
# Globals:
# BATSLIB_FILE_PATH_REM
# BATSLIB_FILE_PATH_ADD
# Arguments:
# $1 - path
# Returns:
# 0 - socket exists
# 1 - otherwise
# Outputs:
# STDERR - details, on failure
assert_socket_exists() {
local -r file="$1"
if [[ ! -S "$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}" \
| batslib_decorate 'socket does not exist' \
| fail
fi
}
# Fail and display path of the named pipe if it does not exist.
# This function is the logical complement of `assert_fifo_not_exists'.
#
# Globals:
# BATSLIB_FILE_PATH_REM
# BATSLIB_FILE_PATH_ADD
# Arguments:
# $1 - path
# Returns:
# 0 - named pipe exists
# 1 - otherwise
# Outputs:
# STDERR - details, on failure
assert_fifo_exists() {
local -r file="$1"
if [[ ! -p "$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}" \
| batslib_decorate 'fifo does not exist' \
| fail
fi
}
# Fail and display path of the named file if it is not executable.
# This function is the logical complement of `assert_file_not_executable'.
#
# Globals:
# BATSLIB_FILE_PATH_REM
# BATSLIB_FILE_PATH_ADD
# Arguments:
# $1 - path
# Returns:
# 0 - named pipe exists
# 1 - otherwise
# Outputs:
# STDERR - details, on failure
assert_file_executable() {
local -r file="$1"
if [[ ! -x "$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}" \
| batslib_decorate 'file is not executable' \
| fail
fi
}
# Fail and display path of both files if they are not equal.
# This function is the logical complement of `assert_files_not_equal'.
#
# Globals:
# BATSLIB_FILE_PATH_REM
# BATSLIB_FILE_PATH_ADD
# Arguments:
# $1 - 1st path
# $2 - 2nd path
# Returns:
# 0 - named files are the same
# 1 - otherwise
# Outputs:
# STDERR - details, on failure
assert_files_equal() {
local -r file1="$1"
local -r file2="$2"
if ! cmp -s "$file1" "$file2" >/dev/null ; then
local -r rem="${BATSLIB_FILE_PATH_REM-}"
local -r add="${BATSLIB_FILE_PATH_ADD-}"
batslib_print_kv_single 4 'path' "${file1/$rem/$add}" 'path' "${file2/$rem/$add}" \
| batslib_decorate 'files are not the same' \
| fail
fi
}
# Get the owner of a file
# Arguments:
# $1 - output variable name
# $2 - path to file
_bats_get_file_owner() {
local -r output_var=$1
local -r file=$2
if [[ "$OSTYPE" == darwin* ]]; then
local -ra cmd_params=(-f %Su)
else
local -ra cmd_params=(-c %U)
fi
printf -v "$output_var" "%s" "$(stat "${cmd_params[@]}" "$file")"
}
# Fail and display path of the user is not the owner of a file. This
# function is the logical complement of `assert_file_not_owner'.
#
# Globals:
# BATSLIB_FILE_PATH_REM
# BATSLIB_FILE_PATH_ADD
# Arguments:
# $1 - path
# Returns:
# 0 - owns file
# 1 - otherwise
# Outputs:
# STDERR - details, on failure
assert_file_owner() {
local -r owner="$1"
local -r file="$2"
local actual_owner
_bats_get_file_owner actual_owner "$file"
readonly actual_owner
if [[ "$actual_owner" != "$owner" ]]; then
local -r rem="${BATSLIB_FILE_PATH_REM-}"
local -r add="${BATSLIB_FILE_PATH_ADD-}"
batslib_print_kv_single 4 'path' "${file/$rem/$add}" \
| batslib_decorate "user $owner is not the owner of the file" \
| fail
fi
}
# Fail if file does not have given permissions. This
# function is the logical complement of `assert_file_not_permission'.
#
# Globals:
# BATSLIB_FILE_PATH_REM
# BATSLIB_FILE_PATH_ADD
# Arguments:
# $1 - permission
# $2 - path
# Returns:
# 0 - file has given permissions
# 1 - otherwise
# Outputs:
# STDERR - details, on failure
assert_file_permission() {
local -r permission="$1"
local -r file="$2"
if [[ "$OSTYPE" == darwin* ]]; then
local -r actual_permission=$(stat -f '%A' "$file")
else
local -r actual_permission=$(stat -c "%a" "$file")
fi
if [[ "$actual_permission" != "$permission" ]]; then
local -r rem="${BATSLIB_FILE_PATH_REM-}"
local -r add="${BATSLIB_FILE_PATH_ADD-}"
batslib_print_kv_single 4 'path' "${file/$rem/$add}" \
| batslib_decorate "file does not have permissions $permission" \
| fail
fi
}
# Fail if file is not zero byte. This
# function is the logical complement of `assert_size_not_zero'.
#
# Globals:
# BATSLIB_FILE_PATH_REM
# BATSLIB_FILE_PATH_ADD
# Arguments:
# $1 - path
# Returns:
# 0 - file size is zero byte
# 1 - otherwise
# Outputs:
# STDERR - details, on failure
assert_size_zero() {
local -r file="$1"
if [ -s "$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}" \
| batslib_decorate 'file is greater than 0 byte' \
| fail
fi
}
# Fail if group if is not set on file. This
# function is the logical complement of `assert_file_not_group_id_set'.
#
# Globals:
# BATSLIB_FILE_PATH_REM
# BATSLIB_FILE_PATH_ADD
# Arguments:
# $1 - path
# Returns:
# 0 - group id is set
# 1 - otherwise
# Outputs:
# STDERR - details, on failure
assert_file_group_id_set() {
local -r file="$1"
if [[ ! -g "$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}" \
| batslib_decorate 'set-group-ID is not set' \
| fail
fi
}
# Fail if user if is not set on file. This
# function is the logical complement of `assert_file_not_user_id_set'.
#
# Globals:
# BATSLIB_FILE_PATH_REM
# BATSLIB_FILE_PATH_ADD
# Arguments:
# $1 - path
# Returns:
# 0 - user id is set
# 1 - otherwise
# Outputs:
# STDERR - details, on failure
assert_file_user_id_set() {
local -r file="$1"
if [[ ! -u "$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}" \
| batslib_decorate 'set-user-ID is not set' \
| fail
fi
}
# Fail if stickybit not set on file. This
# function is the logical complement of `assert_sticky_bit'.
#
# Globals:
# BATSLIB_FILE_PATH_REM
# BATSLIB_FILE_PATH_ADD
# Arguments:
# $1 - path
# Returns:
# 0 - stickybit is set
# 1 - otherwise
# Outputs:
# STDERR - details, on failure
assert_sticky_bit() {
local -r file="$1"
if [[ ! -k "$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}" \
| batslib_decorate 'stickybit is not set' \
| fail
fi
}
_bats_file_readlinkf_macos() {
local TARGET_FILE=$1
cd "$(dirname "$TARGET_FILE")" 2>/dev/null || return
TARGET_FILE=$(basename "$TARGET_FILE")
# Iterate down a (possible) chain of symlinks
while [ -L "$TARGET_FILE" ]
do
TARGET_FILE=$(readlink "$TARGET_FILE")
cd "$(dirname "$TARGET_FILE")" 2>/dev/null || return
TARGET_FILE=$(basename "$TARGET_FILE")
done
# Compute the canonicalized name by finding the physical path
# for the directory we're in and appending the target file.
local -r PHYS_DIR=$(pwd -P)
printf "%s/%s\n" "$PHYS_DIR" "$TARGET_FILE"
}
# Fail and display path of the file (or directory) if it is not a symlink to given destination.
# function is the logical complement of `assert_not_symlink_to`
# $1 - source
# $2 - destination
# Returns:
# 0 - link to correct target
# 1 - otherwise
# Outputs:
# STDERR - details, on failure
assert_symlink_to() {
local -r sourcefile="$1"
local -r link="$2"
# If OS is OSX, emulate readlink -f
if [[ $OSTYPE == "darwin"* ]]; then
local -ra readlink_command=(_bats_file_readlinkf_macos)
else
local -ra readlink_command=(readlink -f)
fi
if [ ! -L "$link" ]; then
local -r rem="${BATSLIB_FILE_PATH_REM-}"
local -r add="${BATSLIB_FILE_PATH_ADD-}"
batslib_print_kv_single 4 'path' "${link/$rem/$add}" \
| batslib_decorate 'file is not a symbolic link' \
| fail
fi
local realsource; realsource=$( "${readlink_command[@]}" "$link" ); readonly realsource
local realexpectedsource; realexpectedsource=$( "${readlink_command[@]}" "$sourcefile" ); readonly realexpectedsource
if [ ! "${realsource}" = "${realexpectedsource}" ]; then
local -r rem="${BATSLIB_FILE_PATH_REM-}"
local -r add="${BATSLIB_FILE_PATH_ADD-}"
batslib_print_kv_single 4 'path' "${link/$rem/$add}" \
| batslib_decorate 'symbolic link does not have the correct target' \
| fail
fi
}
# Fail and display path of the file (or directory) if it does not match a size.
#
# Globals:
# BATSLIB_FILE_PATH_REM
# BATSLIB_FILE_PATH_ADD
# Arguments:
# $1 - path
# $2 - expected size (bytes)
# Returns:
# 0 - file is correct size
# 1 - otherwise
# Outputs:
# STDERR - details, on failure
assert_file_size_equals() {
local -r file="$1"
local -r expectedsize="$2"
local -r size=$( wc -c "$file" | awk '{print $1}' )
if [ ! "$expectedsize" = "$size" ]; then
local -r rem="${BATSLIB_FILE_PATH_REM-}"
local -r add="${BATSLIB_FILE_PATH_ADD-}"
batslib_print_kv_single 4 'path' "${file/$rem/$add}" \
| batslib_decorate 'file size does not match expected size' \
| fail
fi
}
# Fail and display path of the file (or directory) if it does not contain a string.
# This function is the logical complement of `assert_file_not_contains'.
#
# Globals:
# BATSLIB_FILE_PATH_REM
# BATSLIB_FILE_PATH_ADD
# Arguments:
# $1 - path
# $2 - regex
# $3 - grep engine to use (grep, egrep, pcregrep) - optional
# Returns:
# 0 - file contains regex
# 1 - otherwise
# Outputs:
# STDERR - details, on failure
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
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 does not contain regex' \
| fail
fi
}
# Fail and display path of the file (or directory) if it does contain a string.
# This function is the logical complement of `assert_file_contains'.
#
# Globals:
# BATSLIB_FILE_PATH_REM
# BATSLIB_FILE_PATH_ADD
# Arguments:
# $1 - path
# $2 - regex
# Returns:
# 0 - file does not contain regex
# 1 - otherwise
# Outputs:
# STDERR - details, on failure
assert_file_not_contains() {
local -r file="$1"
local -r regex="$2"
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
fi
}
# Fail and display path of the file (or directory) if it is not empty.
# This function is the logical complement of `assert_file_not_empty'.
#
# Globals:
# BATSLIB_FILE_PATH_REM
# BATSLIB_FILE_PATH_ADD
# Arguments:
# $1 - path
# Returns:
# 0 - file empty
# 1 - otherwise
# Outputs:
# STDERR - details, on failure
assert_file_empty() {
local -r file="$1"
if [[ -s "$file" ]]; then
local -r rem="${BATSLIB_FILE_PATH_REM-}"
local -r add="${BATSLIB_FILE_PATH_ADD-}"
{ local -ir width=8
batslib_print_kv_single "$width" 'path' "${file/$rem/$add}"
batslib_print_kv_single_or_multi "$width" \
'output' "$(cat "$file")"
} | batslib_decorate 'file is not empty' \
| fail
fi
}
# Fail and display path of the file (or directory) if it exists. This
# function is the logical complement of `assert_exists'.
#
# Globals:
# BATSLIB_FILE_PATH_REM
# BATSLIB_FILE_PATH_ADD
# Arguments:
# $1 - path
# Returns:
# 0 - file does not exist
# 1 - otherwise
# Outputs:
# STDERR - details, on failure
assert_not_exists() {
local -r file="$1"
if [[ -e "$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}" \
| batslib_decorate 'file or directory exists, but it was expected to be absent' \
| fail
fi
}
# Fail and display path of the file if it exists. This
# function is the logical complement of `assert_file_exists'.
#
# Globals:
# BATSLIB_FILE_PATH_REM
# BATSLIB_FILE_PATH_ADD
# Arguments:
# $1 - path
# Returns:
# 0 - file does not exist
# 1 - otherwise
# Outputs:
# STDERR - details, on failure
assert_file_not_exists() {
local -r file="$1"
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}" \
| batslib_decorate 'file exists, but it was expected to be absent' \
| fail
fi
}
# Fail and display path of the directory if it exists. This
# function is the logical complement of `assert_dir_exists'.
#
# Globals:
# BATSLIB_FILE_PATH_REM
# BATSLIB_FILE_PATH_ADD
# Arguments:
# $1 - path
# Returns:
# 0 - directory does not exist
# 1 - otherwise
# Outputs:
# STDERR - details, on failure
assert_dir_not_exists() {
local -r file="$1"
if [[ -d "$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}" \
| batslib_decorate 'directory exists, but it was expected to be absent' \
| fail
fi
}
# Fail and display path of the block special file if it exists. This
# function is the logical complement of `assert_block_exists'.
#
# Globals:
# BATSLIB_FILE_PATH_REM
# BATSLIB_FILE_PATH_ADD
# Arguments:
# $1 - path
# Returns:
# 0 - block special file does not exist
# 1 - otherwise
# Outputs:
# STDERR - details, on failure
assert_block_not_exists() {
local -r file="$1"
if [[ -b "$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}" \
| batslib_decorate 'block special file exists, but it was expected to be absent' \
| fail
fi
}
# Fail and display path of the character special file if it exists. This
# function is the logical complement of `assert_character_exists'.
#
# Globals:
# BATSLIB_FILE_PATH_REM
# BATSLIB_FILE_PATH_ADD
# Arguments:
# $1 - path
# Returns:
# 0 - character special file does not exist
# 1 - otherwise
# Outputs:
# STDERR - details, on failure
assert_character_not_exists() {
local -r file="$1"
if [[ -c "$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}" \
| batslib_decorate 'character special file exists, but it was expected to be absent' \
| fail
fi
}
# Fail and display path of the symbolic link if it exists. This
# function is the logical complement of `assert_link_exists'.
#
# Globals:
# BATSLIB_FILE_PATH_REM
# BATSLIB_FILE_PATH_ADD
# Arguments:
# $1 - path
# Returns:
# 0 - symbolic link does not exist
# 1 - otherwise
# Outputs:
# STDERR - details, on failure
assert_link_not_exists() {
local -r file="$1"
if [[ -L "$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}" \
| batslib_decorate 'symbolic link exists, but it was expected to be absent' \
| fail
fi
}
# Fail and display path of the socket if it exists. This
# function is the logical complement of `assert_socket_exists'.
#
# Globals:
# BATSLIB_FILE_PATH_REM
# BATSLIB_FILE_PATH_ADD
# Arguments:
# $1 - path
# Returns:
# 0 - socket does not exist
# 1 - otherwise
# Outputs:
# STDERR - details, on failure
assert_socket_not_exists() {
local -r file="$1"
if [[ -S "$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}" \
| batslib_decorate 'socket exists, but it was expected to be absent' \
| fail
fi
}
# Fail and display path of the named pipe if it exists. This
# function is the logical complement of `assert_fifo_exists'.
#
# Globals:
# BATSLIB_FILE_PATH_REM
# BATSLIB_FILE_PATH_ADD
# Arguments:
# $1 - path
# Returns:
# 0 - named pipe does not exist
# 1 - otherwise
# Outputs:
# STDERR - details, on failure
assert_fifo_not_exists() {
local -r file="$1"
if [[ -p "$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}" \
| batslib_decorate 'fifo exists, but it was expected to be absent' \
| fail
fi
}
# Fail and display path of the named file if it is executable. This
# function is the logical complement of `assert_file_executable'.
#
# Globals:
# BATSLIB_FILE_PATH_REM
# BATSLIB_FILE_PATH_ADD
# Arguments:
# $1 - path
# Returns:
# 0 - named pipe does not exist
# 1 - otherwise
# Outputs:
# STDERR - details, on failure
assert_file_not_executable() {
local -r file="$1"
if [[ -x "$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}" \
| batslib_decorate 'file is executable, but it was expected to be not executable' \
| fail
fi
}
# Fail if the user is not the owner of the given file.. This
# function is the logical complement of `assert_file_owner'.
#
# Globals:
# BATSLIB_FILE_PATH_REM
# BATSLIB_FILE_PATH_ADD
# Arguments:
# $1 - path
# Returns:
# 0 - is not an owner
# 1 - otherwise
# Outputs:
# STDERR - details, on failure
assert_not_file_owner() {
local -r expected_owner="$1"
local -r file="$2"
local actual_owner
_bats_get_file_owner actual_owner "$file"
readonly actual_owner
if [[ "$actual_owner" == "$expected_owner" ]]; then
local -r rem="${BATSLIB_FILE_PATH_REM-}"
local -r add="${BATSLIB_FILE_PATH_ADD-}"
batslib_print_kv_single 4 'path' "${file/$rem/$add}" \
| batslib_decorate "user $expected_owner is the owner of the file, but it was expected not to be" \
| fail
fi
}
# Fail if the file has given permissions. This
# function is the logical complement of `assert_file_permission'.
#
# Globals:
# BATSLIB_FILE_PATH_REM
# BATSLIB_FILE_PATH_ADD
# Arguments:
# $1 - path
# Returns:
# 0 - does not have given permissions
# 1 - otherwise
# Outputs:
# STDERR - details, on failure
assert_not_file_permission() {
local -r permission="$1"
local -r file="$2"
if [[ "$OSTYPE" == darwin* ]]; then
local -r actual_permission=$(stat -f '%A' "$file")
else
local -r actual_permission=$(stat -c "%a" "$file")
fi
if [ "$actual_permission" -eq "$permission" ]; then
local -r rem="${BATSLIB_FILE_PATH_REM-}"
local -r add="${BATSLIB_FILE_PATH_ADD-}"
batslib_print_kv_single 4 'path' "${file/$rem/$add}" \
| batslib_decorate "file has permissions $permission, but it was expected not to have" \
| fail
fi
}
# This function is the logical complement of `assert_files_equal'.
# $1 - 1st path
# $2 - 2nd path
# Returns:
# 0 - named files are the same
# 1 - otherwise
# Outputs:
# STDERR - details, on failure
assert_files_not_equal() {
local -r file1="$1"
local -r file2="$2"
if cmp -s "$file1" "$file2" >/dev/null ; then
local -r rem="${BATSLIB_FILE_PATH_REM-}"
local -r add="${BATSLIB_FILE_PATH_ADD-}"
batslib_print_kv_single 4 'path' "${file1/$rem/$add}" 'path' "${file2/$rem/$add}" \
| batslib_decorate 'files are the same' \
| fail
fi
}
# Fail if The file size is zero byte. This
# function is the logical complement of `assert_size_zero'.
#
# Globals:
# BATSLIB_FILE_PATH_REM
# BATSLIB_FILE_PATH_ADD
# Arguments:
# $1 - path
# Returns:
# 0 - size is not 0 byte
# 1 - otherwise
# Outputs:
# STDERR - details, on failure
assert_size_not_zero() {
local -r file="$1"
if [[ ! -s "$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}" \
| batslib_decorate 'file is 0 byte, but it was expected not to be' \
| fail
fi
}
# Fail if group id is set. This
# function is the logical complement of `assert_file_group_id_set'.
#
# Globals:
# BATSLIB_FILE_PATH_REM
# BATSLIB_FILE_PATH_ADD
# Arguments:
# $1 - path
# Returns:
# 0 - group id is not set
# 1 - otherwise
# Outputs:
# STDERR - details, on failure
assert_file_not_group_id_set() {
local -r file="$1"
if [ -g "$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}" \
| batslib_decorate 'group id is set, but it was expected not to be' \
| fail
fi
}
# Fail if user id is set. This
# function is the logical complement of `assert_file_user_id_set'.
#
# Globals:
# BATSLIB_FILE_PATH_REM
# BATSLIB_FILE_PATH_ADD
# Arguments:
# $1 - path
# Returns:
# 0 - user id is not set
# 1 - otherwise
# Outputs:
# STDERR - details, on failure
assert_file_not_user_id_set() {
local -r file="$1"
if [ -u "$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}" \
| batslib_decorate 'user id is set, but it was expected not to be' \
| fail
fi
}
# Fail if stickybit is set. This
# function is the logical complement of `assert_sticky_bit'.
#