tools: bootconfig: Add bootconfig test script

Add a bootconfig test script to ensure the tool and
boot config parser are working correctly.

Link: http://lkml.kernel.org/r/157867224728.17873.18114241801246589416.stgit@devnote2

Signed-off-by: Masami Hiramatsu <[e-mail]>
Signed-off-by: Steven Rostedt (VMware) <[e-mail]>

tools/bootconfig/Makefile

···
 install: $(PROGS)
 	install bootconfig $(DESTDIR)$(bindir)
 
+test: bootconfig
+	./test-bootconfig.sh
+
 clean:
 	$(RM) -f *.o bootconfig

tools/bootconfig/samples/bad-array-space-comment.bconf

···
+key =	# comment
+	"value1",	  # comment1
+	"value2" 	  # comment2
+,
+	"value3"

tools/bootconfig/samples/bad-array.bconf

···
+# Array must be comma separated.
+key = "value1" "value2"

tools/bootconfig/samples/bad-dotword.bconf

···
+# do not start keyword with .
+key {
+  .word = 1
+}

tools/bootconfig/samples/bad-empty.bconf

···
+# Wrong boot config: comment only

tools/bootconfig/samples/bad-keyerror.bconf

···
+# key word can not contain ","
+key,word

tools/bootconfig/samples/bad-longkey.bconf

···
+key_word_is_too_long01234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345

tools/bootconfig/samples/bad-manywords.bconf

···
+key1.is2.too3.long4.5.6.7.8.9.10.11.12.13.14.15.16.17

tools/bootconfig/samples/bad-no-keyword.bconf

···
+# No keyword
+{}

tools/bootconfig/samples/bad-nonprintable.bconf

···
+# Non printable
+key = ""

tools/bootconfig/samples/bad-spaceword.bconf

···
+# No space between words
+key . word

tools/bootconfig/samples/bad-tree.bconf

···
+# brace is not closing
+tree {
+  node {
+    value = 1
+}

tools/bootconfig/samples/bad-value.bconf

···
+# Quotes error
+value = "data
+

tools/bootconfig/samples/escaped.bconf

···
+key1 = "A\B\C"
+key2 = '\'\''
+key3 = "\\"

tools/bootconfig/samples/good-array-space-comment.bconf

···
+key =	# comment
+	"value1",	  # comment1
+	"value2"	 , # comment2
+	"value3"

tools/bootconfig/samples/good-comment-after-value.bconf

···
+key = "value"  # comment

tools/bootconfig/samples/good-printables.bconf

···
+key = "	
+ !#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~"

tools/bootconfig/samples/good-simple.bconf

···
+# A good simple bootconfig
+
+key.word1 = 1
+key.word2=2
+key.word3 = 3;
+
+key {
+word4 = 4 }
+
+key { word5 = 5; word6 = 6 }
+

tools/bootconfig/samples/good-single.bconf

···
+# single key style
+key = 1
+key2 = 2
+key3 = "alpha", "beta"

tools/bootconfig/samples/good-space-after-value.bconf

···
+key = "value"   

tools/bootconfig/samples/good-tree.bconf

···
+key {
+  word {
+    tree {
+      value = "0"}
+  }
+  word2 {
+    tree {
+      value = 1,2 }
+  }
+}
+other.tree {
+  value = 2; value2 = 3;}

tools/bootconfig/test-bootconfig.sh

···
+#!/bin/sh
+# SPDX-License-Identifier: GPL-2.0-only
+
+echo "Boot config test script"
+
+BOOTCONF=./bootconfig
+INITRD=`mktemp initrd-XXXX`
+TEMPCONF=`mktemp temp-XXXX.bconf`
+NG=0
+
+cleanup() {
+  rm -f $INITRD $TEMPCONF
+  exit $NG
+}
+
+trap cleanup EXIT TERM
+
+NO=1
+
+xpass() { # pass test command
+  echo "test case $NO ($3)... "
+  if ! ($@ && echo "\t\t[OK]"); then
+     echo "\t\t[NG]"; NG=$((NG + 1))
+  fi
+  NO=$((NO + 1))
+}
+
+xfail() { # fail test command
+  echo "test case $NO ($3)... "
+  if ! (! $@ && echo "\t\t[OK]"); then
+     echo "\t\t[NG]"; NG=$((NG + 1))
+  fi
+  NO=$((NO + 1))
+}
+
+echo "Basic command test"
+xpass $BOOTCONF $INITRD
+
+echo "Delete command should success without bootconfig"
+xpass $BOOTCONF -d $INITRD
+
+dd if=/dev/zero of=$INITRD bs=4096 count=1
+echo "key = value;" > $TEMPCONF
+bconf_size=$(stat -c %s $TEMPCONF)
+initrd_size=$(stat -c %s $INITRD)
+
+echo "Apply command test"
+xpass $BOOTCONF -a $TEMPCONF $INITRD
+new_size=$(stat -c %s $INITRD)
+
+echo "File size check"
+xpass test $new_size -eq $(expr $bconf_size + $initrd_size + 9)
+
+echo "Apply command repeat test"
+xpass $BOOTCONF -a $TEMPCONF $INITRD
+
+echo "File size check"
+xpass test $new_size -eq $(stat -c %s $INITRD)
+
+echo "Delete command check"
+xpass $BOOTCONF -d $INITRD
+
+echo "File size check"
+new_size=$(stat -c %s $INITRD)
+xpass test $new_size -eq $initrd_size
+
+echo "Max node number check"
+
+echo -n > $TEMPCONF
+for i in `seq 1 1024` ; do
+   echo "node$i" >> $TEMPCONF
+done
+xpass $BOOTCONF -a $TEMPCONF $INITRD
+
+echo "badnode" >> $TEMPCONF
+xfail $BOOTCONF -a $TEMPCONF $INITRD
+
+echo "Max filesize check"
+
+# Max size is 32767 (including terminal byte)
+echo -n "data = \"" > $TEMPCONF
+dd if=/dev/urandom bs=768 count=32 | base64 -w0 >> $TEMPCONF
+echo "\"" >> $TEMPCONF
+xfail $BOOTCONF -a $TEMPCONF $INITRD
+
+truncate -s 32764 $TEMPCONF
+echo "\"" >> $TEMPCONF	# add 2 bytes + terminal ('\"\n\0')
+xpass $BOOTCONF -a $TEMPCONF $INITRD
+
+echo "=== expected failure cases ==="
+for i in samples/bad-* ; do
+  xfail $BOOTCONF -a $i $INITRD
+done
+
+echo "=== expected success cases ==="
+for i in samples/good-* ; do
+  xpass $BOOTCONF -a $i $INITRD
+done
+
+echo
+if [ $NG -eq 0 ]; then
+	echo "All tests passed"
+else
+	echo "$NG tests failed"
+fi