vsh: Added tests

For now, there are 9 test cases
- testVshTableNew: Creating table with empty header
- testVshTableHeader: Printing table with/without header
- testVshTableRowAppend: Appending row with various number of cells.
  Only row with same number of cells as in header is accepted.
- testUnicode: Printing table with unicode characters.
  Checking correct alignment.
- testUnicodeArabic: test opposite (right to left) writing
- testUnicodeZeroWidthChar
- testUnicodeCombiningChar
- testUnicodeNonPrintableChar,
- testNTables: Create and print varios types of tables - one column,
  one row table, table without content, standart table...

Signed-off-by: Simon Kobyda <skobyda@redhat.com>

tests/Makefile.am

@@ -206,6 +206,7 @@ test_programs = virshtest sockettest \
 	virhostdevtest \
 	virnetdevtest \
 	virtypedparamtest \
+	vshtabletest \
 	$(NULL)
 
 test_libraries = libshunload.la \
@@ -938,6 +939,13 @@ metadatatest_SOURCES = \
 	testutils.c testutils.h
 metadatatest_LDADD = $(LDADDS) $(LIBXML_LIBS)
 
+vshtabletest_SOURCES = \
+	vshtabletest.c \
+	testutils.c testutils.h
+vshtabletest_LDADD = \
+	$(LDADDS) \
+	../tools/libvirt_shell.la
+
 virshtest_SOURCES = \
 	virshtest.c \
 	testutils.c testutils.h

tests/vshtabletest.c

@@ -0,0 +1,377 @@
+/*
+ * Copyright (C) 2018 Red Hat, Inc.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library.  If not, see
+ * <http://www.gnu.org/licenses/>.
+ */
+
+#include <config.h>
+
+#include <stdlib.h>
+#include <stdio.h>
+#include <locale.h>
+
+#include "internal.h"
+#include "testutils.h"
+#include "viralloc.h"
+#include "../tools/vsh-table.h"
+
+static int
+testVshTableNew(const void *opaque ATTRIBUTE_UNUSED)
+{
+    if (vshTableNew(NULL)) {
+        fprintf(stderr, "expected failure when passing null to vshTableNew\n");
+        return -1;
+    }
+
+    return 0;
+}
+
+static int
+testVshTableHeader(const void *opaque ATTRIBUTE_UNUSED)
+{
+    int ret = 0;
+    char *act = NULL;
+    const char *exp =
+" 1   fedora28   running  \n"
+" 2   rhel7.5    running  \n";
+    const char *exp2 =
+" Id   Name       State    \n"
+"--------------------------\n"
+" 1    fedora28   running  \n"
+" 2    rhel7.5    running  \n";
+
+    vshTablePtr table = vshTableNew("Id", "Name", "State",
+                                    NULL); //to ask about return
+    if (!table)
+        goto cleanup;
+
+    vshTableRowAppend(table, "1", "fedora28", "running", NULL);
+    vshTableRowAppend(table, "2", "rhel7.5", "running",
+                      NULL);
+
+    act = vshTablePrintToString(table, false);
+    if (virTestCompareToString(exp, act) < 0)
+        ret = -1;
+
+    VIR_FREE(act);
+    act = vshTablePrintToString(table, true);
+    if (virTestCompareToString(exp2, act) < 0)
+        ret = -1;
+
+ cleanup:
+    VIR_FREE(act);
+    vshTableFree(table);
+    return ret;
+}
+
+static int
+testVshTableRowAppend(const void *opaque ATTRIBUTE_UNUSED)
+{
+    int ret = 0;
+
+    vshTablePtr table = vshTableNew("Id", "Name", NULL);
+    if (!table)
+        goto cleanup;
+
+    if (vshTableRowAppend(table, NULL) >= 0) {
+        fprintf(stderr, "Appending NULL shouldn't work\n");
+        ret = -1;
+    }
+
+    if (vshTableRowAppend(table, "2", NULL) >= 0) {
+        fprintf(stderr, "Appending less items than in header\n");
+        ret = -1;
+    }
+
+    if (vshTableRowAppend(table, "2", "rhel7.5", "running",
+                      NULL) >= 0) {
+        fprintf(stderr, "Appending more items than in header\n");
+        ret = -1;
+    }
+
+    if (vshTableRowAppend(table, "2", "rhel7.5", NULL) < 0) {
+        fprintf(stderr, "Appending same number of items as in header"
+                        " should not return NULL\n");
+        ret = -1;
+    }
+
+ cleanup:
+    vshTableFree(table);
+    return ret;
+}
+
+static int
+testUnicode(const void *opaque ATTRIBUTE_UNUSED)
+{
+
+    int ret = 0;
+    char *act = NULL;
+
+    const char *exp =
+" Id   名稱                  государство  \n"
+"-----------------------------------------\n"
+" 1    fedora28              running      \n"
+" 2    🙊🙉🙈rhel7.5🙆🙆🙅   running      \n";
+    vshTablePtr table;
+
+    table = vshTableNew("Id", "名稱", "государство", NULL);
+    if (!table)
+        goto cleanup;
+
+    vshTableRowAppend(table, "1", "fedora28", "running", NULL);
+    vshTableRowAppend(table, "2", "🙊🙉🙈rhel7.5🙆🙆🙅", "running",
+                      NULL);
+
+    act = vshTablePrintToString(table, true);
+    if (virTestCompareToString(exp, act) < 0)
+        ret = -1;
+
+ cleanup:
+    VIR_FREE(act);
+    vshTableFree(table);
+    return ret;
+}
+
+/* Point of this test is to see how table behaves with right to left writing*/
+static int
+testUnicodeArabic(const void *opaque ATTRIBUTE_UNUSED)
+{
+
+    int ret = 0;
+    char *act = NULL;
+
+    const char *exp =
+" ﻡﺍ ﻢﻣﺍ ﻕﺎﺌﻣﺓ   ﺓ ﺎﻠﺼﻋ                                                 ﺍﻸﺜﻧﺎﻧ              \n"
+"-------------------------------------------------------------------------------------------\n"
+" 1              ﻉﺪﻴﻟ ﺎﻠﺜﻘﻴﻟ ﻕﺎﻣ ﻊﻧ, ٣٠ ﻎﻴﻨﻳﺍ ﻮﺘﻧﺎﻤﺗ ﺎﻠﺛﺎﻠﺛ، ﺄﺳﺭ, ﺩﻮﻟ   ﺩﻮﻟ. ﺄﻣﺎﻣ ﺍ ﺎﻧ ﻲﻜﻧ  \n"
+" ﺺﻔﺣﺓ           ﺖﻜﺘﻴﻛﺍً ﻊﻟ, ﺎﻠﺠﻧﻭﺩ ﻭﺎﻠﻌﺗﺍﺩ                              ﺵﺭ                  \n";
+    vshTablePtr table;
+
+    table = vshTableNew("ﻡﺍ ﻢﻣﺍ ﻕﺎﺌﻣﺓ", "ﺓ ﺎﻠﺼﻋ", "ﺍﻸﺜﻧﺎﻧ", NULL);
+    if (!table)
+        goto cleanup;
+    vshTableRowAppend(table,
+                      "1",
+                      "ﻉﺪﻴﻟ ﺎﻠﺜﻘﻴﻟ ﻕﺎﻣ ﻊﻧ, ٣٠ ﻎﻴﻨﻳﺍ ﻮﺘﻧﺎﻤﺗ ﺎﻠﺛﺎﻠﺛ، ﺄﺳﺭ, ﺩﻮﻟ",
+                      "ﺩﻮﻟ. ﺄﻣﺎﻣ ﺍ ﺎﻧ ﻲﻜﻧ",
+                      NULL);
+    vshTableRowAppend(table, "ﺺﻔﺣﺓ", "ﺖﻜﺘﻴﻛﺍً ﻊﻟ, ﺎﻠﺠﻧﻭﺩ ﻭﺎﻠﻌﺗﺍﺩ", "ﺵﺭ",
+                      NULL);
+    act = vshTablePrintToString(table, true);
+    if (virTestCompareToString(exp, act) < 0)
+        ret = -1;
+
+ cleanup:
+    VIR_FREE(act);
+    vshTableFree(table);
+    return ret;
+}
+
+/* Testing zero-width characters by inserting few zero-width spaces */
+static int
+testUnicodeZeroWidthChar(const void *opaque ATTRIBUTE_UNUSED)
+{
+
+    int ret = 0;
+    vshTablePtr table = NULL;
+    const char *exp =
+" I\u200Bd   Name       \u200BStatus   \n"
+"--------------------------\n"
+" 1\u200B    fedora28   run\u200Bning  \n"
+" 2    rhel7.5    running  \n";
+    char *act = NULL;
+
+    table = vshTableNew("I\u200Bd", "Name", "\u200BStatus", NULL);
+    if (!table)
+        goto cleanup;
+    vshTableRowAppend(table, "1\u200B", "fedora28", "run\u200Bning", NULL);
+    vshTableRowAppend(table, "2", "rhel7.5", "running", NULL);
+    act = vshTablePrintToString(table, true);
+
+    if (virTestCompareToString(exp, act) < 0)
+        ret = -1;
+
+ cleanup:
+    VIR_FREE(act);
+    vshTableFree(table);
+    return ret;
+}
+
+static int
+testUnicodeCombiningChar(const void *opaque ATTRIBUTE_UNUSED)
+{
+    int ret = 0;
+    vshTablePtr table = NULL;
+    const char *exp =
+" Id   Náme       Ⓢtatus   \n"
+"--------------------------\n"
+" 1    fědora28   running  \n"
+" 2    rhel       running  \n";
+    char *act = NULL;
+
+    table = vshTableNew("Id", "Náme", "Ⓢtatus", NULL);
+    if (!table)
+        goto cleanup;
+    vshTableRowAppend(table, "1", "fědora28", "running", NULL);
+    vshTableRowAppend(table, "2", "rhel", "running", NULL);
+    act = vshTablePrintToString(table, true);
+
+    if (virTestCompareToString(exp, act) < 0)
+        ret = -1;
+
+ cleanup:
+    VIR_FREE(act);
+    vshTableFree(table);
+    return ret;
+}
+
+/* Testing zero-width characters by inserting few zero-width spaces */
+static int
+testUnicodeNonPrintableChar(const void *opaque ATTRIBUTE_UNUSED)
+{
+    int ret = 0;
+    vshTablePtr table = NULL;
+    const char *exp =
+" I\\x09d   Name           Status   \n"
+"----------------------------------\n"
+" 1        f\\x07edora28   running  \n"
+" 2        rhel7.5        running  \n";
+    char *act = NULL;
+
+    table = vshTableNew("I\td", "Name", "Status", NULL);
+    if (!table)
+        goto cleanup;
+    vshTableRowAppend(table, "1", "f\aedora28", "running", NULL);
+    vshTableRowAppend(table, "2", "rhel7.5", "running", NULL);
+    act = vshTablePrintToString(table, true);
+
+    if (virTestCompareToString(exp, act) < 0)
+        ret = -1;
+
+ cleanup:
+    VIR_FREE(act);
+    vshTableFree(table);
+    return ret;
+}
+
+static int
+testNTables(const void *opaque ATTRIBUTE_UNUSED)
+{
+    int ret = 0;
+    vshTablePtr table1 = NULL;
+    vshTablePtr table2 = NULL;
+    vshTablePtr table3 = NULL;
+    const char *exp1 =
+" Id   Name       Status   \n"
+"--------------------------\n"
+" 1    fedora28   running  \n"
+" 2    rhel7.5    running  \n";
+    const char *exp2 =
+" Id   Name   Status  \n"
+"---------------------\n";
+    const char *exp3 =
+" Id  \n"
+"-----\n"
+" 1   \n"
+" 2   \n"
+" 3   \n"
+" 4   \n";
+    char *act1 = NULL;
+    char *act2 = NULL;
+    char *act3 = NULL;
+
+    table1 = vshTableNew("Id", "Name", "Status", NULL);
+    if (!table1)
+        goto cleanup;
+    vshTableRowAppend(table1, "1", "fedora28", "running", NULL);
+    vshTableRowAppend(table1, "2", "rhel7.5", "running", NULL);
+    act1 = vshTablePrintToString(table1, true);
+
+    table2 = vshTableNew("Id", "Name", "Status", NULL);
+    if (!table2)
+        goto cleanup;
+    act2 = vshTablePrintToString(table2, true);
+
+    table3 = vshTableNew("Id", NULL);
+    if (!table3)
+        goto cleanup;
+    vshTableRowAppend(table3, "1", NULL);
+    vshTableRowAppend(table3, "2", NULL);
+    vshTableRowAppend(table3, "3", NULL);
+    vshTableRowAppend(table3, "4", NULL);
+    act3 = vshTablePrintToString(table3, true);
+
+    if (virTestCompareToString(exp1, act1) < 0)
+        ret = -1;
+    if (virTestCompareToString(exp2, act2) < 0)
+        ret = -1;
+    if (virTestCompareToString(exp3, act3) < 0)
+        ret = -1;
+
+ cleanup:
+    VIR_FREE(act1);
+    VIR_FREE(act2);
+    VIR_FREE(act3);
+    vshTableFree(table1);
+    vshTableFree(table2);
+    vshTableFree(table3);
+    return ret;
+}
+
+static int
+mymain(void)
+{
+    int ret = 0;
+
+    if (!setlocale(LC_CTYPE, "en_US.UTF-8"))
+        return EXIT_AM_SKIP;
+
+    if (virTestRun("testVshTableNew", testVshTableNew, NULL) < 0)
+        ret = -1;
+
+    if (virTestRun("testVshTableHeader", testVshTableHeader, NULL) < 0)
+        ret = -1;
+
+    if (virTestRun("testVshTableRowAppend", testVshTableRowAppend, NULL) < 0)
+        ret = -1;
+
+    if (virTestRun("testUnicode", testUnicode, NULL) < 0)
+        ret = -1;
+
+    if (virTestRun("testUnicodeArabic", testUnicodeArabic, NULL) < 0)
+        ret = -1;
+
+    if (virTestRun("testUnicodeZeroWidthChar",
+                   testUnicodeZeroWidthChar,
+                   NULL) < 0)
+        ret = -1;
+
+    if (virTestRun("testUnicodeCombiningChar",
+                   testUnicodeCombiningChar,
+                   NULL) < 0)
+        ret = -1;
+
+    if (virTestRun("testUnicodeNonPrintableChar",
+                   testUnicodeNonPrintableChar,
+                   NULL) < 0)
+        ret = -1;
+
+    if (virTestRun("testNTables", testNTables, NULL) < 0)
+        ret = -1;
+
+    return ret == 0 ? EXIT_SUCCESS : EXIT_FAILURE;
+}
+
+VIR_TEST_MAIN(mymain)