Added unit-tests and fixversion tools

Author: iandstanley

.gitignore

@@ -1,4 +1,5 @@
 tmp/**
+tests/**
 !tmp/README
 *.bak
 

docs/FIXVERSION.md

@@ -0,0 +1,20 @@
+# fixversion command
+
+I have included a build tool that will compate versions and dates of the 
+various files in this application.
+
+## Checking versions and dates
+
+```shell
+$ fixversion
+```
+
+## Fix dates and versions
+
+To change all the version numbers in the various scripts and man pages 
+to the latest git tag version and current date run the following 
+command:
+
+```shell
+$ fixversion fix
+```

docs/UNIT-TESTS.md

@@ -0,0 +1,38 @@
+
+# UNIT TESTING NOTES DEVELOPMENT
+
+The shell script 'unit-tests' runs a series of tests on the notes(1), 
+notebook(1) and journal(1) scripts.
+
+Each function is tested for the appropriate output (directories created, 
+files encrypted etc) and any errors output to tests/error_log_for_unit_tests.
+
+The shell script places an appropriate framework around each script and 
+runs through a series of test use cases checking what is output compared 
+to what is expected.
+
+
+## RUNNING UNIT TESTS 
+
+To run the unit tests you need to set the environment variable $TESTKEY 
+to the GPG Key you wish to use and then run the 'unit-tests' shell script.
+
+
+```shell
+$ export TESTKEY="E33A79B685AA......325F41243EDA850A"
+$ ./unit-tests
+```
+
+The script edits the notes(1) config file after creation to point to the 
+GPG key $TESTKEY. this allows the user to guarantee which GPG key is 
+used in the unit-tests script if the developer has more than one private key.
+
+### Testing "notes newkey newGPGkey"
+
+If the user also sets $ALTGPGKEY before running the test then the 
+notes(1) command 'newkey' will decrypt from $TESTKEY and then encrypt to 
+$ALTGPGKEY.
+
+If no $ALTGPGKEY is found in the environment the unit-tests script will 
+set $ALTGPGKEY = $TESTKEY to test notes newkey command.
+

docs/journal.1

@@ -1,7 +1,7 @@
 .\" Manpage for Standard (?) Unix Notes
 .\" aka notes
 .\" See https://github.com/Standard-Unix-Notes/unix-notes
-.TH journal 1 "24 June 2021" "2.2" "Journal man page"
+.TH journal 1 "06 July 2021" "2.5" "Journal man page"
 .SH NAME
 Journal \-  GPG encrypted journal
 .SH SYNOPSIS

docs/notebook.1

@@ -1,7 +1,7 @@
 .\" Manpage for Standard (?) Unix Notes
 .\" aka notes
 .\" See https://github.com/Standard-Unix-Notes/unix-notes
-.TH notebook 1 "24 June 2021" "2.2" "Notes man page"
+.TH notebook 1 "06 July 2021" "2.5" "Notes man page"
 .SH NAME
 Notes \-  GPG encrypted notes
 .SH SYNOPSIS

docs/notes.1

@@ -1,7 +1,7 @@
 .\" Manpage for Standard (?) Unix Notes
 .\" aka notes
 .\" See https://github.com/Standard-Unix-Notes/unix-notes
-.TH notes 1 "24 June 2021" "2.2" "Notes man page"
+.TH notes 1 "06 July 2021" "2.5" "Notes man page"
 .SH NAME
 Notes \-  GPG encrypted notes
 .SH SYNOPSIS

fixversion

@@ -0,0 +1,78 @@
+#!/bin/sh 
+TESTDIR="`pwd`/tests"
+ERRORLOG="${TESTDIR}/error_log_for_unit_tests"
+rm -f $ERRORLOG
+log () {
+	echo $@ >>  $ERRORLOG
+}
+FIXUP=0
+test "$1" = "fix" 	&& FIXUP=1
+
+display () {
+
+	cat << EOF
+
+	==== VERSIONS & DATES IN FILES ====
+
+	TODAY = $TODAY
+
+	SCRIPTS:
+	        notes		$NOTESVER
+		notebook	$NOTEBOOKVER
+		journal		$JOURNALVER
+
+	MAN PAGES:
+		notes(1)	$NOTESMAN		$NOTESMANDATE
+		notebook(1)	$NOTEBOOKMAN		$NOTEBOOKMANDATE
+		journal(1)	$JOURNALMAN		$JOURNALMANDATE
+
+	GIT TAGS:
+		git		$GITVER
+
+EOF
+
+}
+
+get_versions () {
+# get versions and dates
+	NOTESVER="`grep -m 1 VERSION notes | cut -d '=' -f 2 `"
+	NOTEBOOKVER="`grep -m 1 VERSION notebook | cut -d '=' -f 2 `"
+	JOURNALVER="`grep -m 1 VERSION journal | cut -d '=' -f 2 `"
+	GITVER="`make ver`"
+	NOTESMAN="`grep .TH docs/notes.1 | cut -d ' ' -f 7 | cut -d '\"' -f 2 `"
+	NOTESMANDATE="`grep .TH docs/notes.1 | cut -d ' ' -f 4-6 | cut -d '\"' -f 2 `"
+	NOTEBOOKMAN="`grep .TH docs/notebook.1 | cut -d ' ' -f 7 | cut -d '\"' -f 2 `"
+	NOTEBOOKMANDATE="`grep .TH docs/notebook.1 | cut -d ' ' -f 4-6 | cut -d '\"' -f 2 `"
+	JOURNALMAN="`grep .TH docs/journal.1 | cut -d ' ' -f 7 | cut -d '\"' -f 2 `"
+	JOURNALMANDATE="`grep .TH docs/journal.1 | cut -d ' ' -f 4-6 | cut -d '\"' -f 2 `"
+	TODAY="`date +\"%d %B %Y\"`"
+}
+
+get_versions
+
+if [ $FIXUP -eq 1 ] ; then
+	echo fixing up version and dates
+
+	sed -i "s/^VERSION=.*/VERSION=${GITVER}/" notes
+	# no need to edit notebook(1) as is link to notes
+	sed -i "s/^VERSION=.*/VERSION=${GITVER}/" journal
+	sed -i "/^.TH/s/\"${NOTESMAN}\"/\"${GITVER}\"/" docs/notes.1
+	sed -i "/^.TH/s/\"${NOTEBOOKMAN}\"/\"${GITVER}\"/" docs/notebook.1
+	sed -i "/^.TH/s/\"${JOURNALMAN}\"/\"${GITVER}\"/" docs/journal.1
+	# and the dates ...
+	sed -i "/^.TH/s/\"${NOTESMANDATE}\"/\"${TODAY}\"/" docs/notes.1
+	sed -i "/^.TH/s/\"${NOTEBOOKMANDATE}\"/\"${TODAY}\"/" docs/notebook.1
+	sed -i "/^.TH/s/\"${JOURNALMANDATE}\"/\"${TODAY}\"/" docs/journal.1
+else
+	# just log to errorlog 
+	test "$GITVER" != "$NOTESVER" 		&& log  GITVER not equal to NOTESVER
+	test "$GITVER" != "$NOTEBOOKVER" 	&& log  GITVER not equal to NOTEBOOKVER
+	test "$GITVER" != "$JOURNALVER" 	&& log  GITVER not equal to  JOURNALVER
+	test "$GITVER" != "$NOTESMAN" 		&& log  GITVER not equal to NOTESMAN
+	test "$GITVER" != "$NOTEBOOKMAN" 	&& log  GITVER not equal to NOTEBOOKMAN
+	test "$GITVER" != "$JOURNALMAN" 	&& log  GITVER not equal to JOURNALMAN
+fi
+
+get_versions
+
+display

journal

@@ -9,7 +9,7 @@
 # The idea came from 'pass' the standard Unix password manager
 
 # VARIABLES
-VERSION=2.1
+VERSION=2.5
 #NOTES_UMASK='077'
 # Handle $XDG_DATA_DIR -or- NOTESDIR being set in environment
 if [ -n "$XDG_DATA_DIR"  -a  -z "$NOTESDIR" ] ; then

makefile

@@ -17,10 +17,22 @@ help:
 	@echo ""
 	@sed -n s/^##//p makefile
 
+## make unit                     Run Unit Tests
+unit:
+	./unit-tests
+
+## make ver                      Show version  tag
+ver:
+	@echo $(VER)
+
+## make fix                      Create a fix versions and date in files c.f. git tag 
+fix:
+	@echo run \"fixversion fix\" to fix versions and dates to $(VER)
+
 ## make var                      Show makefile variables
 var:
-	@echo Operating System = $(OS)
 	@echo Latest Git tag {Version} = $(VER)
+	@echo Operating System = $(OS)
 	@echo Tarball Location = $(TARBALLLOC)
 	@echo Package Name = $(PKGNAME)
 	@echo Tarball Name = $(TARBALL)
@@ -50,9 +62,8 @@ manpages:
 
 clean: 
 	@echo clean up after build
-	-rm tmp/notes.1.gz
-	-rm tmp/notebook.1.gz
-	-rm tmp/journal.1.gz
+	-rm -rf tmp/*
+	-rm -rf tests/*
 
 ## make uninstall                Uninstall the application
 uninstall:

notes

@@ -7,7 +7,7 @@
 # The idea came from 'pass' the standard Unix password manager
 
 # VARIABLES
-VERSION=2.1
+VERSION=2.5
 #NOTES_UMASK='077'
 # Handle $XDG_DATA_DIR -or- NOTESDIR being set in environment
 if [ -n "$XDG_DATA_DIR"  -a  -z "$NOTESDIR" ] ; then
@@ -43,23 +43,17 @@ else
     SHREDCMD="rm"
 fi
 
-USEGIT=`grep git ${CONFIGFILE}| cut -d'=' -f 2`
+USEGIT="`grep git ${CONFIGFILE}| cut -d'=' -f 2`"
 
-SPELLCHECK=`grep spelling $CONFIGFILE | cut -d'=' -f 2`
-spellcheck () {
+spell_check () {
+    SPELLCHECK="`grep spelling ${CONFIGFILE} | cut -d '=' -f 2`"
     case ${SPELLCHECK} in 
         aspell) 
-            SPELLINGCMD="aspell -x -c " 
-            ${SPELLINGCMD} ${notefile}
+            aspell -x -c  ${notefile}
             ;;
         ispell) 
-            SPELLINGCMD="ispell -x " 
-            ${SPELLINGCMD} ${notefile}
+            ispell -x  ${notefile}
             ;;
-        none) 
-            ;;
-        *) 
-            echo Invalid config option `grep "spellcheck" ${CONFIGFILE}`
     esac
 }
 
@@ -93,10 +87,6 @@ cmd_init (){		# setup directories and GPG key  to be used
 
 	echo "Creating Journal directory ${JOURNALDIR} "
 	mkdir -p $JOURNALDIR
-
-    echo params $1
-    
-    
 }
 
 create_config () {
@@ -124,7 +114,7 @@ create_config () {
     echo Do you want spellchecking enabled?
     echo "1) Use aspell"
     echo "2) Use ispell"
-    echo "3) Do not spellcheck"
+    echo "3) Do not spell check"
     read -p "Choose 1,2,or 3: " choosespell
     case $choosespell in
         1)
@@ -209,7 +199,12 @@ note_add () {
     filen="$@"
     notefile="${USE_POINTER}/`echo ${filen} | tr ' ' '_'`"
 
-	if [ -f "$notefile.asc" ] ; then
+    if [ "$filen" = "" ] ; then 
+        echo No notefile name given ... exiting
+        exit 1
+    fi
+
+	if [ -f "${notefile}.asc" ] ; then
 		echo File exists ... cannot create. Try 'notes edit' instead.
         exit 1
 	else
@@ -220,7 +215,7 @@ note_add () {
 		# create temporary note file
 		$EDITOR "$notefile"
 
-		spellcheck
+		spell_check
 
 		# encrypt note file
 		$GPG -ear $KEY $GPG_OPTS  "$notefile"
@@ -278,13 +273,13 @@ note_edit () {
 	if [ -f "$notefile" ]; then 
 		gpg -d -o "${decrypted}" "${notefile}" 
 		${EDITOR} "${decrypted}" 
-        spellcheck
+        spell_check
 		$GPG -ear $KEY $GPG_OPTS  "${decrypted}"
 		${SHREDCMD} ${decrypted}
 	elif [ -f "${notefile}.asc" ]; then 
 		gpg -d -o "${decrypted}"  "${notefile}.asc" 
 		${EDITOR} "${decrypted}" 
-        spellcheck
+        spell_check
 		$GPG -ear $KEY $GPG_OPTS  "${decrypted}"
 		${SHREDCMD} ${decrypted}
 	else 
@@ -390,15 +385,7 @@ notebook_delete () {
 		echo Error: Notebook \'$notebook\' does not exist
 		exit 1
 	else
-		echo Deleting files from $notebook
-		${SHREDCMD} ${notebook}/*.asc
-		
-		if [ $? = 0 ] ; then 
-			rmdir "$notebook"
-		else
-			echo Deleting files aborted ... aborting deleting notebook $notebook
-            exit 1
-		fi
+        rm -rf $notebook
 	fi
 
 	if [ "$USEGIT" = "y" ]; then
@@ -468,7 +455,7 @@ GPG encrypted notes system for BSD and Linux systems
 
 	notes init          initialise notes system
 	notes config        display config file
-	notes backup        backup $NOTESDIR to GPG encrypted tar file
+	notes backup        backup NOTESDIR to GPG encrypted tar file
 	notes newkey email  change GPG key 
 	notes help          show help
 	notes version       show version
@@ -638,7 +625,7 @@ cmd_default () {
 
     if [ "$nb" = "" ]  ;then
         echo Default notebook = "`readlink -f $DEFAULT_POINTER`"
-        exit 0
+        return 0
     fi
     if [ -d "$notebook" ] ; then
         unlink  "$DEFAULT_POINTER" 
@@ -664,7 +651,7 @@ cmd_use () {
         echo no notebook specified using default notebook
         unlink "$USE_POINTER"
         ln -s "`basename $defaultnbval`" "$USE_POINTER"
-        exit 0 
+        return 0 
     fi
     if [ -d "$notebook" ] ; then
         unlink  "$USE_POINTER" 
@@ -779,6 +766,5 @@ case "$1" in
         git) shift;                     cmd_git "$@" ;;
         *)                              cmd_extension_or_show "$@" ;;
 esac
-exit 0