adding test bmtTest function

Author: gavinlyonsrepo

README.md

@@ -100,6 +100,7 @@ A script to print library meta data is also installed.
 |  bmtData | btmDataFunc | 601-607 | Data related | [bmtData help file](documentation/bmtData.md)|
 |  bmtTime | btmTimeFunc | 701-709 | Time related | [bmtTime help file](documentation/bmtTime.md)|
 |  bmtMisc  | bmtMiscFunc  | 801-804 | Miscellaneous | [bmtMisc help file](documentation/bmtMisc.md)|
+|  bmtTest  | bmtTestFunc  | 901 |  Test the library | [bmtTest help file](documentation/bmtTest.md)|
 
 The library contains eight section's, Each section has one file with one function. 
 Which contains 50 sub-sections in total.
@@ -116,3 +117,7 @@ Example
 Output of basic example file in example folder, showing basic usage.
 
 ![ScreenShot](https://raw.githubusercontent.com/gavinlyonsrepo/bashmultitool/master/documentation/screenshot/example.png)
+
+Output report of test section.
+
+![ScreenShot](https://raw.githubusercontent.com/gavinlyonsrepo/bashmultitool/master/documentation/screenshot/test.png)

documentation/bmtFiles.md

@@ -4,8 +4,8 @@
 
 **Section Five,  File**
 
-* 501 Make and enter a formatted directory
-* 502 Check if directory exists and empty
+* 501 Check if directory exists and empty
+* 502 Make and enter a formatted directory
 * 503 Directory exists
 * 504 File exists
 * 505 Device exists
@@ -86,9 +86,9 @@ bmtFilesFunc getfilesizebytes "/foo/foo.txt"
 
 509) Display mime type of input file
 Returns 4 If file/directory does not exist. , 3 If file or mimetype command not found in system.
-2 if missing arguments.
+2 if missing arguments, 0 for success. 
 
 ```sh
-echo "$(bmtFilesFunc getmimetype "$TESTOBJECTS/full.txt")" >> /tmp/mytempfile123.txt
+bmtFilesFunc getmimetype "$TESTOBJECTS/full.txt" >> /tmp/mytempfile123.txt
 echo $?
 ```

documentation/bmtPrompt.md

@@ -49,7 +49,7 @@ bmtPromptFunc yesno yes
 ```
 Returns 0 for yes , 2 for no , 50 for bad user option
 
-204) Yes-no prompt [Y/n] where no is default
+204) Yes-no prompt [Y/n] where yes is default
 
 Keyword is yesno , returns codes based on user input
 second option is no 

documentation/bmtTest.md

@@ -0,0 +1,8 @@
+| Library file | Function | Sections | Content | help file |
+| ---- | ---- | ---- | ---- | ---- |
+|  bmtTest  | bmtTestFunc  | 901 | Test | bmtTest.md |
+
+**Section nine, Time**
+
+Used to conduct semi-automated testing and test report of library function.
+

documentation/screenshot/test.png

@@ -0,0 +1,78 @@
+#!/bin/bash
+
+# === HEADER ===
+#FileName: bmtTest
+#Function: Contains a test function for automated testing library
+#library name: bashmultitool
+#URL: https://github.com/gavinlyonsrepo/BashMultiTool
+
+# === FUNCTIONS ===
+
+function bmtTestFunc
+{
+
+local urlTestDir="$HOME/Documents/Tech/Scripts/BashMultiTool/test/testlog/"
+mkdir -p "$urlTestDir"  
+local TestFile="test"
+
+case "$3" in
+	START)  # Start message
+			bmtPrintFunc norm "Delete log file if exists"
+			rm -iv "$urlTestDir""$TestFile.log" 
+			bmtLinuxFunc log "NOTICE" "Run Start"  "$TestFile" "$urlTestDir" ;;
+	END)
+		# End message
+		if [ "$3" == "END"  ] 
+		then
+			bmtLinuxFunc log "NOTICE" "Run Over"  "$TestFile" "$urlTestDir"
+			bmtPrintFunc norm  "=== End Automatic Tests ==="
+			bmtPromptFunc anykey " " norm
+			clear
+			bmtMiscFunc title 14 226  "#" "             BashMultiTool library :: Test Results :: $TestFile.log              " 
+			bmtPromptFunc eventstatus "Test Total" "$(grep -c "Test" "$urlTestDir""$TestFile.log"   )"  b_white
+			bmtPromptFunc eventstatus "Test Passed" "$(grep -c "PASSED" "$urlTestDir""$TestFile.log" )"  b_green
+			bmtPromptFunc eventstatus "Test Failed" "$(grep -c "FAILED" "$urlTestDir""$TestFile.log" )"  b_red
+			bmtPromptFunc eventstatus "Test Errors" "$(grep -c "ERROR" "$urlTestDir""$TestFile.log" )"  b_yellow
+			bmtPromptFunc line  "="
+			
+			# View File
+			bmtPromptFunc anykey "and view test log file." norm
+			cat "$urlTestDir""$TestFile.log"
+			bmtPromptFunc line  "="
+			bmtPromptFunc anykey "and delete test log file." norm
+			#remove file?
+			rm -iv "$urlTestDir""$TestFile.log"
+			bmtPromptFunc line  "="
+		fi
+		;;
+	*)
+	if [ "$4" == "NOAUTO" ] # non -automatic test 
+	then
+		local yesnoVar=""
+		while true; do
+			bmtPrintFunc norm "Did Test $3 pass? [y/n/q]"
+			read -r yesnoVar
+			case $yesnoVar in
+				[Yy]*) bmtLinuxFunc log "PASSED" "Test $3 Result :: User Check"  "$TestFile" "$urlTestDir"  && return 0;;
+				[Nn]*) bmtLinuxFunc log "FAILED" "Test $3 Result :: User Check"  "$TestFile"  "$urlTestDir"	&& return 2;;
+				[Qq]*) 
+					bmtLinuxFunc log "ERROR" "User aborted Test at $3"  "$TestFile"  "$urlTestDir"
+					return 3
+				;;
+				*) bmtPrintFunc b_yellow "Please answer: (y/Y for yes) OR (n/N for no) OR (q/Q to quit)!";;
+			esac
+		done
+	else
+		if  [ "$1" -eq "$2" ] # Automatic test 
+		then 
+			bmtLinuxFunc log "PASSED" "Test $3 Result :: $1 $2"  "$TestFile" "$urlTestDir" 
+			return 0
+		else
+			bmtLinuxFunc log "FAILED" "Test $3 Result :: $1 $2"  "$TestFile"  "$urlTestDir" 
+			return 2
+		fi
+	fi
+	;;
+esac
+}
+

lib/bmtTest

@@ -0,0 +1 @@
+test

test/testObjects/dummyfile.foofoo

@@ -0,0 +1,29 @@
+#!/bin/bash
+
+# === HEADER ===
+
+#Name: testTest.sh
+#Description: File to run Automatic tests on library bashmultitool
+#URL: https://github.com/gavinlyonsrepo/BashMultiTool
+
+# === MAIN CODE ===
+clear
+printf "%s\n" "=== Start Automatic Tests === "
+printf "%s\n"  "=== Start Print Tests === "  # Section 1
+./testprint.sh
+printf "%s\n"  "=== Start Prompt Tests === "  # Section 2
+./testprompt.sh
+printf "|\n%s\n"  "=== Start Network Tests === " # Section 3
+./testnetwork.sh
+printf  "\n%s\n"  "=== Start Linux  Tests === " # Section 4
+./testlinux.sh
+printf "\n%s\n"  "=== Start Files  Tests === " # Section 5
+./testfile.sh
+printf "\n%s\n"  "=== Start Data Tests === " # Section 6
+./testdata.sh
+printf "\n%s\n"  "=== Start Time Tests === " # Section 7
+./testtime.sh
+printf "\n%s\n"  "=== Start Misc Tests === " # Section 8
+./testmisc.sh
+printf "\n" 
+# === EOF ===

test/testTest.sh

@@ -20,63 +20,69 @@ done
 function Test_Func
 {
 	echo "Error handling check"
-	bmtDataFunc foo
-	echo " "
+	bmtDataFunc foofoo
+	bmtTestFunc "$?" 255 "60E-a"
+	bmtDataFunc 
+	bmtTestFunc "$?" 255 "60E-b"
 
-	# intcheck
-	echo "601"
-	echo "Enter an integer"
+	# intcheck 601
+	printf  "\n%s\n"  "601-a Enter an integer"
 	read -r ID
 	bmtDataFunc intcheck "$ID"
-	echo "$?"
-	echo " "
+	bmtTestFunc "$?" 0 "601-a"
+
+	printf  "\n%s\n"  "601-b Enter a NON integer"
+	read -r ID
+	bmtDataFunc intcheck "$ID"
+	bmtTestFunc "$?" 2 "601-b"
+
+	## alphanumeric 602
+	printf  "\n%s\n" "602-a Enter an alpha numeric string"
+	read -r ID1
+	bmtDataFunc alphanumcheck "$ID1"
+	bmtTestFunc "$?" 0 "602-a"
 
-	## alphanumeric check 2
-	echo "602"
-	echo "Enter an alpha numeric string"
+	printf  "\n%s\n" "602-b Enter a NON alpha numeric string"
 	read -r ID1
 	bmtDataFunc alphanumcheck "$ID1"
-	echo "$?"
-	echo " "
+	bmtTestFunc "$?" 2 "602-b"
 
-	## alphanuc check 3
-	echo "603"
-	echo "Enter an alpha string"
+	## alpha check 603
+	printf  "\n%s\n" "603-a Enter an alphabetical string"
+	read -r ID2
+	bmtDataFunc alphacheck "$ID2"
+	bmtTestFunc "$?" 0 "603-a"
+
+	printf  "\n%s\n" "603-b Enter an NON alphabetical string"
 	read -r ID2
 	bmtDataFunc alphacheck "$ID2"
-	echo "$?"
-	echo " "
+	bmtTestFunc "$?" 2 "603-b"
 
-	## lowercase 4
-	echo "604"
-	echo "lowercasetest"
+	# lowercase 
+	printf  "\n%s\n" "604 lowercase test"
 	result=$(bmtDataFunc lowercase "TEST")   # or result=`myfunc`
-	echo "$result"
-	echo " "
+	printf  "%s\n" "$result"
+	bmtTestFunc 1 1 "604-a"  "NOAUTO"
 
-	##uppercase 5
-	echo "605"
-	echo "uppercasetest"
+	#uppercase 
+	printf  "\n%s\n" "605 uppercase test"
 	result1=$(bmtDataFunc uppercase "test")
-	echo "$result1"
-	echo " "
+	printf  "%s\n" "$result1"
+	bmtTestFunc 1 1 "605-a"  "NOAUTO"
 
-	## trim 6
-	echo "606"
-	echo "trim test"
+	# trim 
+	printf  "\n%s\n" "606 trim test"
 	mytrim="       test   "
 	result2=$(bmtDataFunc trim "$mytrim")
-	echo "$result2"
-	echo " "
+	printf  "%s\n" "$result2"
+	bmtTestFunc 1 1 "606-a"  "NOAUTO"
 
-	## string length 7
-	echo "607 string length test"
+	# string length 
+	printf  "\n%s\n" "607 string length test"
 	bmtDataFunc strlen "test string 123" # 15
-	echo $?
-	echo " "
+	bmtTestFunc "$?" 15 "607-a"
 	bmtDataFunc strlen "" #report 250 error
-	echo $?
-	echo " "
+	bmtTestFunc "$?" 250 "607-b"
 }
 
 Test_Func