From nobody Fri May 3 10:55:29 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) client-ip=209.132.183.28; envelope-from=libvir-list-bounces@redhat.com; helo=mx1.redhat.com; Authentication-Results: mx.zohomail.com; spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com Return-Path: Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) by mx.zohomail.com with SMTPS id 1534417000194255.35254577734383; Thu, 16 Aug 2018 03:56:40 -0700 (PDT) Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 0C81D30E684D; Thu, 16 Aug 2018 10:56:38 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.21]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 9C16760F89; Thu, 16 Aug 2018 10:56:37 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id 6C6BB4A460; Thu, 16 Aug 2018 10:56:36 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.rdu2.redhat.com [10.11.54.6]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id w7GAuXE0014171 for ; Thu, 16 Aug 2018 06:56:33 -0400 Received: by smtp.corp.redhat.com (Postfix) id 4F9912166BA5; Thu, 16 Aug 2018 10:56:33 +0000 (UTC) Received: from localhost.localdomain.com (unknown [10.43.2.88]) by smtp.corp.redhat.com (Postfix) with ESMTP id BFF052166BA0; Thu, 16 Aug 2018 10:56:32 +0000 (UTC) From: Simon Kobyda To: libvir-list@redhat.com Date: Thu, 16 Aug 2018 12:56:24 +0200 Message-Id: <20180816105626.22399-2-skobyda@redhat.com> In-Reply-To: <20180816105626.22399-1-skobyda@redhat.com> References: <20180816105626.22399-1-skobyda@redhat.com> X-Scanned-By: MIMEDefang 2.78 on 10.11.54.6 X-loop: libvir-list@redhat.com Cc: Simon Kobyda Subject: [libvirt] [PATCH v3 1/3] vsh: Add API for printing tables. X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.46]); Thu, 16 Aug 2018 10:56:38 +0000 (UTC) X-ZohoMail: RDMRC_0 RSF_0 Z_629925259 SPT_0 Content-Type: text/plain; charset="utf-8" It solves problems with alignment of columns. Width of each column is calculated by its biggest cell. Should solve unicode bug. In future, it may be implemented in virsh, virt-admin... This API has 5 public functions: - vshTableNew - adds new table and defines its header - vshTableRowAppend - appends new row (for same number of columns as in header) - vshTablePrintToStdout - vshTablePrintToString - vshTableFree https://bugzilla.redhat.com/show_bug.cgi?id=3D1574624 https://bugzilla.redhat.com/show_bug.cgi?id=3D1584630 Signed-off-by: Simon Kobyda --- tools/Makefile.am | 4 +- tools/vsh-table.c | 413 ++++++++++++++++++++++++++++++++++++++++++++++ tools/vsh-table.h | 42 +++++ 3 files changed, 458 insertions(+), 1 deletion(-) create mode 100644 tools/vsh-table.c create mode 100644 tools/vsh-table.h diff --git a/tools/Makefile.am b/tools/Makefile.am index 1452d984a0..f069167acc 100644 --- a/tools/Makefile.am +++ b/tools/Makefile.am @@ -144,7 +144,9 @@ libvirt_shell_la_LIBADD =3D \ $(READLINE_LIBS) \ ../gnulib/lib/libgnu.la \ $(NULL) -libvirt_shell_la_SOURCES =3D vsh.c vsh.h +libvirt_shell_la_SOURCES =3D \ + vsh.c vsh.h \ + vsh-table.c vsh-table.h =20 virt_host_validate_SOURCES =3D \ virt-host-validate.c \ diff --git a/tools/vsh-table.c b/tools/vsh-table.c new file mode 100644 index 0000000000..8842e4e4fd --- /dev/null +++ b/tools/vsh-table.c @@ -0,0 +1,413 @@ +/* + * vsh-table.c: table printing helper + * + * 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 + * . + * + * Authors: + * Simon Kobyda + * + */ + +#include +#include "vsh-table.h" + +#include +#include +#include +#include +#include + +#include "viralloc.h" +#include "virbuffer.h" +#include "virstring.h" +#include "virsh-util.h" + +typedef void (*vshPrintCB)(vshControl *ctl, const char *fmt, ...); + +struct _vshTableRow { + char **cells; + size_t ncells; +}; + +struct _vshTable { + vshTableRowPtr *rows; + size_t nrows; +}; + +static void +vshTableRowFree(vshTableRowPtr row) +{ + size_t i; + + if (!row) + return; + + for (i =3D 0; i < row->ncells; i++) + VIR_FREE(row->cells[i]); + + VIR_FREE(row->cells); + VIR_FREE(row); +} + +void +vshTableFree(vshTablePtr table) +{ + size_t i; + + if (!table) + return; + + for (i =3D 0; i < table->nrows; i++) + vshTableRowFree(table->rows[i]); + VIR_FREE(table->rows); + VIR_FREE(table); +} + +/** + * vshTableRowNew: + * @arg: the first argument. + * @ap: list of variadic arguments + * + * Create a new row in the table. Each argument passed + * represents a cell in the row. + * Return: pointer to vshTableRowPtr row or NULL. + */ +static vshTableRowPtr +vshTableRowNew(const char *arg, va_list ap) +{ + vshTableRowPtr row =3D NULL; + char *tmp =3D NULL; + + if (!arg) { + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", + _("Table row cannot be empty")); + goto error; + } + + if (VIR_ALLOC(row) < 0) + goto error; + + while (arg) { + if (VIR_STRDUP(tmp, arg) < 0) + goto error; + + if (VIR_APPEND_ELEMENT(row->cells, row->ncells, tmp) < 0) + goto error; + + arg =3D va_arg(ap, const char *); + } + + return row; + + error: + vshTableRowFree(row); + return NULL; +} + +/** + * vshTableNew: + * @arg: List of column names (NULL terminated) + * + * Create a new table. + * + * Returns: pointer to table or NULL. + */ +vshTablePtr +vshTableNew(const char *arg, ...) +{ + vshTablePtr table; + vshTableRowPtr header =3D NULL; + va_list ap; + + if (VIR_ALLOC(table) < 0) + goto error; + + va_start(ap, arg); + header =3D vshTableRowNew(arg, ap); + va_end(ap); + + if (!header) + goto error; + + if (VIR_APPEND_ELEMENT(table->rows, table->nrows, header) < 0) + goto error; + + return table; + error: + vshTableRowFree(header); + vshTableFree(table); + return NULL; +} + +/** + * vshTableRowAppend: + * @table: table to append to + * @arg: cells of the row (NULL terminated) + * + * Append new row into the @table. The number of cells in the row has + * to be equal to the number of cells in the table header. + * + * Returns: 0 if succeeded, -1 if failed. + */ +int +vshTableRowAppend(vshTablePtr table, const char *arg, ...) +{ + vshTableRowPtr row =3D NULL; + size_t ncolumns =3D table->rows[0]->ncells; + va_list ap; + int ret =3D -1; + + va_start(ap, arg); + row =3D vshTableRowNew(arg, ap); + va_end(ap); + + if (!row) + goto cleanup; + + if (ncolumns !=3D row->ncells) { + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", + _("Incorrect number of cells in a table row")); + goto cleanup; + } + + if (VIR_APPEND_ELEMENT(table->rows, table->nrows, row) < 0) + goto cleanup; + + ret =3D 0; + cleanup: + vshTableRowFree(row); + return ret; +} + +/** + * vshTableGetColumnsWidths: + * @table: table + * @maxwidths: maximum count of characters for each columns + * @widths: count of characters for each cell in the table + * + * Fill passed @maxwidths and @widths arrays with maximum number + * of characters for columns and number of character per each + * table cell, respectively. + * + * Handle unicode strings (user must have multibyte locale) + */ +static int +vshTableGetColumnsWidths(vshTablePtr table, + size_t *maxwidths, + size_t **widths, + bool header) +{ + int ret =3D -1; + size_t i =3D 1; + size_t j; + size_t len; + int tmp; + wchar_t *wstr =3D NULL; + size_t wstrlen; + + if (header) + i =3D 0; + else + i =3D 1; + for (; i < table->nrows; i++) { + vshTableRowPtr row =3D table->rows[i]; + + for (j =3D 0; j < row->ncells; j++) { + /* strlen should return maximum possible length needed */ + wstrlen =3D strlen(row->cells[j]); + VIR_FREE(wstr); + if (VIR_ALLOC_N(wstr, wstrlen) < 0) + goto cleanup; + /* mbstowcs fails if machine is using singlebyte locale + * and user tries to convert unicode(multibyte) + * */ + if (mbstowcs(wstr, row->cells[j], wstrlen) =3D=3D + (size_t) -1) { + len =3D wstrlen; + } else { + tmp =3D wcswidth(wstr, wstrlen); + if (tmp < 0) + goto cleanup; + len =3D (size_t)((unsigned)tmp); + } + widths[i][j] =3D len; + if (len > maxwidths[j]) + maxwidths[j] =3D len; + } + } + + ret =3D 0; + cleanup: + VIR_FREE(wstr); + return ret; +} + +/** + * vshTableRowPrint: + * @ctl virtshell control structure + * @row: table to append to + * @maxwidths: maximum count of characters for each columns + * @widths: count of character for each cell in this row + * @printCB function for priting table + * @buf: buffer to store table (only if @toStdout =3D=3D true) + * @toStdout: whetever print table to Stdout or return in buffer + */ +static void +vshTableRowPrint(vshControl *ctl, + vshTableRowPtr row, + size_t *maxwidths, + size_t *widths, + vshPrintCB printCB, + virBufferPtr buf, + bool toStdout) +{ + size_t i; + size_t j; + + for (i =3D 0; i < row->ncells; i++) { + if (toStdout) + printCB(ctl, " %s", row->cells[i]); + else + virBufferAsprintf(buf, " %s", row->cells[i]); + + for (j =3D 0; j < maxwidths[i] - widths[i] + 2; j++) { + if (toStdout) + printCB(ctl, " "); + else + virBufferAddStr(buf, " "); + } + } + if (toStdout) + printCB(ctl, "\n"); + else + virBufferAddStr(buf, "\n"); +} + +/** + * vshTablePrint: + * @ctl virtshell control structure + * @table: table to print + * @header: whetever to print to header (true) or not (false) + * this argument is relevant only if @ctl =3D=3D NULL + * @toStdout: whetever to print to stdout (true) or return in string + * + * Print table. To get an alignment of columns right, function + * fills 2d array @widths with count of characters in each cell and + * array @maxwidths maximum count of character in each column. + * Function then prints tables header and content. + * + * Return string containing table, or NULL if table was printed to + * stdout + */ +static char * +vshTablePrint(vshControl *ctl, vshTablePtr table, bool header, bool toStdo= ut) +{ + size_t i; + size_t j; + size_t *maxwidths; + size_t **widths; + virBuffer buf =3D VIR_BUFFER_INITIALIZER; + char *ret =3D NULL; + + if (VIR_ALLOC_N(maxwidths, table->rows[0]->ncells)) + goto cleanup; + + if (VIR_ALLOC_N(widths, table->nrows)) + goto cleanup; + + /* retrieve widths of columns */ + for (i =3D 0; i < table->nrows; i++) { + if (VIR_ALLOC_N(widths[i], table->rows[0]->ncells)) + goto cleanup; + } + + if (vshTableGetColumnsWidths(table, maxwidths, widths, header) < 0) + goto cleanup; + + if (header) { + /* print header */ + VIR_WARNINGS_NO_PRINTF + vshTableRowPrint(ctl, table->rows[0], maxwidths, widths[0], + vshPrintExtra, &buf, toStdout); + VIR_WARNINGS_RESET + + /* print dividing line */ + for (i =3D 0; i < table->rows[0]->ncells; i++) { + for (j =3D 0; j < maxwidths[i] + 3; j++) { + if (toStdout) + vshPrintExtra(ctl, "-"); + else + virBufferAddStr(&buf, "-"); + } + } + if (toStdout) + vshPrintExtra(ctl, "\n"); + else + virBufferAddStr(&buf, "\n"); + } + /* print content */ + for (i =3D 1; i < table->nrows; i++) { + VIR_WARNINGS_NO_PRINTF + vshTableRowPrint(ctl, table->rows[i], maxwidths, widths[i], + vshPrint, &buf, toStdout); + VIR_WARNINGS_RESET + } + + if (!toStdout) + ret =3D virBufferContentAndReset(&buf); + + cleanup: + VIR_FREE(maxwidths); + for (i =3D 0; i < table->nrows; i++) + VIR_FREE(widths[i]); + VIR_FREE(widths); + return ret; +} + + +/** + * vshTablePrintToStdout: + * @table: table to print + * @ctl virtshell control structure + * + * Print table to stdout. + * + */ +void +vshTablePrintToStdout(vshTablePtr table, vshControl *ctl) +{ + bool header; + if (ctl) + header =3D !ctl->quiet; + else + header =3D true; + vshTablePrint(ctl, table, header, true); +} + +/** + * vshTablePrintToString: + * @table: table to print + * @header: whetever to print to header (true) or not (false) + * + * Return string containing table, or NULL if table was printed to + * stdout. User will have to free returned string. + */ +char * +vshTablePrintToString(vshTablePtr table, bool header) +{ + return vshTablePrint(NULL, table, header, false); +} diff --git a/tools/vsh-table.h b/tools/vsh-table.h new file mode 100644 index 0000000000..e4e9582b9f --- /dev/null +++ b/tools/vsh-table.h @@ -0,0 +1,42 @@ +/* + * vsh-table.h: table printing helper + * + * 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 + * . + * + * Authors: + * Simon Kobyda + * + */ + +#ifndef VSH_TABLE_H +# define VSH_TABLE_H + +# include "vsh.h" + +/* forward declarations */ +typedef struct _vshTable vshTable; +typedef struct _vshTableRow vshTableRow; +typedef vshTable *vshTablePtr; +typedef vshTableRow *vshTableRowPtr; + +void vshTableFree(vshTablePtr table); +vshTablePtr vshTableNew(const char *format, ...); +int vshTableRowAppend(vshTablePtr table, const char *arg, ...); +void vshTablePrintToStdout(vshTablePtr table, vshControl *ctl); +char *vshTablePrintToString(vshTablePtr table, bool header); + +#endif /* VSH_TABLE_H */ --=20 2.17.1 -- libvir-list mailing list libvir-list@redhat.com https://www.redhat.com/mailman/listinfo/libvir-list From nobody Fri May 3 10:55:29 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) client-ip=209.132.183.28; envelope-from=libvir-list-bounces@redhat.com; helo=mx1.redhat.com; Authentication-Results: mx.zohomail.com; spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com Return-Path: Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) by mx.zohomail.com with SMTPS id 1534417007421161.37379220975117; Thu, 16 Aug 2018 03:56:47 -0700 (PDT) Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.phx2.redhat.com [10.5.11.16]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 3F0CB32B667; Thu, 16 Aug 2018 10:56:45 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.20]) by smtp.corp.redhat.com (Postfix) with ESMTPS id DDA935E1A4; Thu, 16 Aug 2018 10:56:44 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id 8C1AF18037F1; Thu, 16 Aug 2018 10:56:44 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.rdu2.redhat.com [10.11.54.6]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id w7GAuYuL014180 for ; Thu, 16 Aug 2018 06:56:34 -0400 Received: by smtp.corp.redhat.com (Postfix) id 1EA822166BA5; Thu, 16 Aug 2018 10:56:34 +0000 (UTC) Received: from localhost.localdomain.com (unknown [10.43.2.88]) by smtp.corp.redhat.com (Postfix) with ESMTP id 9039D2166BA0; Thu, 16 Aug 2018 10:56:33 +0000 (UTC) From: Simon Kobyda To: libvir-list@redhat.com Date: Thu, 16 Aug 2018 12:56:25 +0200 Message-Id: <20180816105626.22399-3-skobyda@redhat.com> In-Reply-To: <20180816105626.22399-1-skobyda@redhat.com> References: <20180816105626.22399-1-skobyda@redhat.com> X-Scanned-By: MIMEDefang 2.78 on 10.11.54.6 X-loop: libvir-list@redhat.com Cc: Simon Kobyda Subject: [libvirt] [PATCH v3 2/3] virsh: Implement new table API for virsh list X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.38]); Thu, 16 Aug 2018 10:56:45 +0000 (UTC) X-ZohoMail: RDMRC_0 RSF_0 Z_629925259 SPT_0 Content-Type: text/plain; charset="utf-8" Instead of printing it straight in virsh, it creates table struct which is filled with header and rows(domains). It allows us to know more about table before printing to calculate alignment right. Signed-off-by: Simon Kobyda --- tests/virshtest.c | 14 ++++++------ tools/virsh-domain-monitor.c | 43 ++++++++++++++++++++---------------- 2 files changed, 31 insertions(+), 26 deletions(-) diff --git a/tests/virshtest.c b/tests/virshtest.c index 94548a82d1..10cd0d356b 100644 --- a/tests/virshtest.c +++ b/tests/virshtest.c @@ -98,9 +98,9 @@ static int testCompareListDefault(const void *data ATTRIB= UTE_UNUSED) { const char *const argv[] =3D { VIRSH_DEFAULT, "list", NULL }; const char *exp =3D "\ - Id Name State\n\ -----------------------------------------------------\n\ - 1 test running\n\ + Id Name State \n\ +----------------------\n\ + 1 test running \n\ \n"; return testCompareOutputLit(exp, NULL, argv); } @@ -109,10 +109,10 @@ static int testCompareListCustom(const void *data ATT= RIBUTE_UNUSED) { const char *const argv[] =3D { VIRSH_CUSTOM, "list", NULL }; const char *exp =3D "\ - Id Name State\n\ -----------------------------------------------------\n\ - 1 fv0 running\n\ - 2 fc4 running\n\ + Id Name State \n\ +----------------------\n\ + 1 fv0 running \n\ + 2 fc4 running \n\ \n"; return testCompareOutputLit(exp, NULL, argv); } diff --git a/tools/virsh-domain-monitor.c b/tools/virsh-domain-monitor.c index b9b4f9739b..adc5bb1a7a 100644 --- a/tools/virsh-domain-monitor.c +++ b/tools/virsh-domain-monitor.c @@ -39,6 +39,7 @@ #include "virmacaddr.h" #include "virxml.h" #include "virstring.h" +#include "vsh-table.h" =20 VIR_ENUM_DECL(virshDomainIOError) VIR_ENUM_IMPL(virshDomainIOError, @@ -1901,6 +1902,7 @@ cmdList(vshControl *ctl, const vshCmd *cmd) char id_buf[INT_BUFSIZE_BOUND(unsigned int)]; unsigned int id; unsigned int flags =3D VIR_CONNECT_LIST_DOMAINS_ACTIVE; + vshTablePtr table =3D NULL; =20 /* construct filter flags */ if (vshCommandOptBool(cmd, "inactive") || @@ -1940,15 +1942,12 @@ cmdList(vshControl *ctl, const vshCmd *cmd) /* print table header in legacy mode */ if (optTable) { if (optTitle) - vshPrintExtra(ctl, " %-5s %-30s %-10s %-20s\n%s\n", - _("Id"), _("Name"), _("State"), _("Title"), - "-----------------------------------------" - "-----------------------------------------"); + table =3D vshTableNew("Id", "Name", "State", "Title", NULL); else - vshPrintExtra(ctl, " %-5s %-30s %s\n%s\n", - _("Id"), _("Name"), _("State"), - "-----------------------------------------" - "-----------"); + table =3D vshTableNew("Id", "Name", "State", NULL); + + if (!table) + goto cleanup; } =20 for (i =3D 0; i < list->ndomains; i++) { @@ -1973,20 +1972,22 @@ cmdList(vshControl *ctl, const vshCmd *cmd) if (optTitle) { if (!(title =3D virshGetDomainDescription(ctl, dom, true, = 0))) goto cleanup; - - vshPrint(ctl, " %-5s %-30s %-10s %-20s\n", id_buf, - virDomainGetName(dom), - state =3D=3D -2 ? _("saved") - : virshDomainStateToString(state), - title); - + if (vshTableRowAppend(table, id_buf, + virDomainGetName(dom), + state =3D=3D -2 ? _("saved") + : virshDomainStateToString(state), + title, NULL) < 0) + goto cleanup; VIR_FREE(title); } else { - vshPrint(ctl, " %-5s %-30s %s\n", id_buf, - virDomainGetName(dom), - state =3D=3D -2 ? _("saved") - : virshDomainStateToString(state)); + if (vshTableRowAppend(table, id_buf, + virDomainGetName(dom), + state =3D=3D -2 ? _("saved") + : virshDomainStateToString(state), + NULL) < 0) + goto cleanup; } + } else if (optUUID && optName) { if (virDomainGetUUIDString(dom, uuid) < 0) { vshError(ctl, "%s", _("Failed to get domain's UUID")); @@ -2004,8 +2005,12 @@ cmdList(vshControl *ctl, const vshCmd *cmd) } } =20 + if (optTable) + vshTablePrintToStdout(table, ctl); + ret =3D true; cleanup: + vshTableFree(table); virshDomainListFree(list); return ret; } --=20 2.17.1 -- libvir-list mailing list libvir-list@redhat.com https://www.redhat.com/mailman/listinfo/libvir-list From nobody Fri May 3 10:55:29 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) client-ip=209.132.183.28; envelope-from=libvir-list-bounces@redhat.com; helo=mx1.redhat.com; Authentication-Results: mx.zohomail.com; spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com Return-Path: Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) by mx.zohomail.com with SMTPS id 1534416999636212.80896263394732; Thu, 16 Aug 2018 03:56:39 -0700 (PDT) Received: from smtp.corp.redhat.com (int-mx12.intmail.prod.int.phx2.redhat.com [10.5.11.27]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 25CAC308625E; Thu, 16 Aug 2018 10:56:37 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.21]) by smtp.corp.redhat.com (Postfix) with ESMTPS id DC73B8BE3C; Thu, 16 Aug 2018 10:56:36 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id 0C7EA4A465; Thu, 16 Aug 2018 10:56:36 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.rdu2.redhat.com [10.11.54.6]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id w7GAuZvB014190 for ; Thu, 16 Aug 2018 06:56:35 -0400 Received: by smtp.corp.redhat.com (Postfix) id 0F8E72166BB1; Thu, 16 Aug 2018 10:56:35 +0000 (UTC) Received: from localhost.localdomain.com (unknown [10.43.2.88]) by smtp.corp.redhat.com (Postfix) with ESMTP id 816802166BA0; Thu, 16 Aug 2018 10:56:34 +0000 (UTC) From: Simon Kobyda To: libvir-list@redhat.com Date: Thu, 16 Aug 2018 12:56:26 +0200 Message-Id: <20180816105626.22399-4-skobyda@redhat.com> In-Reply-To: <20180816105626.22399-1-skobyda@redhat.com> References: <20180816105626.22399-1-skobyda@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.78 on 10.11.54.6 X-loop: libvir-list@redhat.com Cc: Simon Kobyda Subject: [libvirt] [PATCH v3 3/3] vsh: Added tests X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.84 on 10.5.11.27 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.49]); Thu, 16 Aug 2018 10:56:37 +0000 (UTC) X-ZohoMail: RDMRC_0 RSF_0 Z_629925259 SPT_0 For now, there are 5 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. - testVshTableNewUnicode: Printing table with unicode characters. Checking correct alignment. - testNTables: Create and print various types of tables - one column, one row table, table without content, standard table... Signed-off-by: Simon Kobyda --- tests/Makefile.am | 8 ++ tests/vshtabletest.c | 247 +++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 255 insertions(+) create mode 100644 tests/vshtabletest.c diff --git a/tests/Makefile.am b/tests/Makefile.am index 21a6c823d9..136fe16f71 100644 --- a/tests/Makefile.am +++ b/tests/Makefile.am @@ -206,6 +206,7 @@ test_programs =3D virshtest sockettest \ virhostdevtest \ virnetdevtest \ virtypedparamtest \ + vshtabletest \ $(NULL) =20 test_libraries =3D libshunload.la \ @@ -938,6 +939,13 @@ metadatatest_SOURCES =3D \ testutils.c testutils.h metadatatest_LDADD =3D $(LDADDS) $(LIBXML_LIBS) =20 +vshtabletest_SOURCES =3D \ + vshtabletest.c \ + testutils.c testutils.h +vshtabletest_LDADD =3D \ + $(LDADDS) \ + ../tools/libvirt_shell.la + virshtest_SOURCES =3D \ virshtest.c \ testutils.c testutils.h diff --git a/tests/vshtabletest.c b/tests/vshtabletest.c new file mode 100644 index 0000000000..b41a205761 --- /dev/null +++ b/tests/vshtabletest.c @@ -0,0 +1,247 @@ +/* + * 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 + * . + */ + +#include + +#include +#include +#include + +#include "internal.h" +#include "testutils.h" +#include "viralloc.h" +#include "../tools/vsh-table.h" + +static int +testVshTableNew(const void *opaque ATTRIBUTE_UNUSED) +{ + int ret =3D 0; + + if (vshTableNew(NULL)) { + fprintf(stderr, "expected failure when passing null to" + "vshtablenew\n"); + ret =3D -1; + } + + return ret; +} + +static int +testVshTableHeader(const void *opaque ATTRIBUTE_UNUSED) +{ + int ret =3D 0; + char *out; + const char *exp =3D "\ + 1 fedora28 running \n\ + 2 rhel7.5 running \n"; + const char *exp2 =3D "\ + Id Name State \n\ +--------------------------\n\ + 1 fedora28 running \n\ + 2 rhel7.5 running \n"; + + vshTablePtr table =3D 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); + + out =3D vshTablePrintToString(table, false); + if (virTestCompareToString(exp, out) < 0) + ret =3D -1; + + VIR_FREE(out); + out =3D vshTablePrintToString(table, true); + if (virTestCompareToString(exp2, out) < 0) + ret =3D -1; + + cleanup: + VIR_FREE(out); + vshTableFree(table); + return ret; +} + +static int +testVshTableNewUnicode(const void *opaque ATTRIBUTE_UNUSED) +{ + + int ret =3D 0; + char *out; + + char *locale =3D setlocale(LC_CTYPE, NULL); + if (!setlocale(LC_CTYPE, "en_US.UTF-8")) + return EXIT_AM_SKIP; + + const char *exp =3D "\ + Id =E5=90=8D=E7=A8=B1 =D0=B3=D0=BE=D1=81=D1=83=D0=B4= =D0=B0=D1=80=D1=81=D1=82=D0=B2=D0=BE \n\ +-----------------------------------------\n\ + 1 fedora28 running \n\ + 2 =F0=9F=99=8A=F0=9F=99=89=F0=9F=99=88rhel7.5=F0=9F=99=86=F0=9F=99=86= =F0=9F=99=85 running \n"; + vshTablePtr table; + + table =3D vshTableNew("Id", "=E5=90=8D=E7=A8=B1", "=D0=B3=D0=BE=D1=81= =D1=83=D0=B4=D0=B0=D1=80=D1=81=D1=82=D0=B2=D0=BE", NULL); + if (!table) + goto cleanup; + + vshTableRowAppend(table, "1", "fedora28", "running", NULL); + vshTableRowAppend(table, "2", "=F0=9F=99=8A=F0=9F=99=89=F0=9F=99=88rhe= l7.5=F0=9F=99=86=F0=9F=99=86=F0=9F=99=85", "running", + NULL); + + out =3D vshTablePrintToString(table, true); + if (virTestCompareToString(exp, out) < 0) + ret =3D -1; + + cleanup: + setlocale(LC_CTYPE, locale); + VIR_FREE(out); + vshTableFree(table); + return ret; +} + +static int +testVshTableRowAppend(const void *opaque ATTRIBUTE_UNUSED) +{ + int ret =3D 0; + + vshTablePtr table =3D vshTableNew("Id", "Name", NULL); + if (!table) + goto cleanup; + + if (vshTableRowAppend(table, NULL) >=3D 0) { + fprintf(stderr, "Appending NULL shouldn't work\n"); + ret =3D -1; + } + + if (vshTableRowAppend(table, "2", NULL) >=3D 0) { + fprintf(stderr, "Appending less items than in header\n"); + ret =3D -1; + } + + if (vshTableRowAppend(table, "2", "rhel7.5", "running", + NULL) >=3D 0) { + fprintf(stderr, "Appending more items than in header\n"); + ret =3D -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 =3D -1; + } + + cleanup: + vshTableFree(table); + return ret; +} + +static int +testNTables(const void *opaque ATTRIBUTE_UNUSED) +{ + int ret =3D 0; + vshTablePtr table1; + vshTablePtr table2; + vshTablePtr table3; + const char *exp1 =3D "\ + Id Name Status \n\ +--------------------------\n\ + 1 fedora28 running \n\ + 2 rhel7.5 running \n"; + const char *exp2 =3D "\ + Id Name Status \n\ +---------------------\n"; + const char *exp3 =3D "\ + Id \n\ +-----\n\ + 1 \n\ + 2 \n\ + 3 \n\ + 4 \n"; + char *out1; + char *out2; + char *out3; + + table1 =3D vshTableNew("Id", "Name", "Status", NULL); + if (!table1) + goto cleanup; + vshTableRowAppend(table1, "1", "fedora28", "running", NULL); + vshTableRowAppend(table1, "2", "rhel7.5", "running", NULL); + out1 =3D vshTablePrintToString(table1, true); + + table2 =3D vshTableNew("Id", "Name", "Status", NULL); + if (!table2) + goto cleanup; + out2 =3D vshTablePrintToString(table2, true); + + table3 =3D vshTableNew("Id", NULL); + if (!table3) + goto cleanup; + vshTableRowAppend(table3, "1", NULL); + vshTableRowAppend(table3, "2", NULL); + vshTableRowAppend(table3, "3", NULL); + vshTableRowAppend(table3, "4", NULL); + out3 =3D vshTablePrintToString(table3, true); + + if (virTestCompareToString(exp1, out1) < 0) + ret =3D -1; + if (virTestCompareToString(exp2, out2) < 0) + ret =3D -1; + if (virTestCompareToString(exp3, out3) < 0) + ret =3D -1; + + cleanup: + VIR_FREE(out1); + VIR_FREE(out2); + VIR_FREE(out3); + vshTableFree(table1); + vshTableFree(table2); + vshTableFree(table3); + return ret; +} + +static int +mymain(void) +{ + int ret =3D 0; + + if (virTestRun("testVshTableNew", testVshTableNew, + NULL) < 0) + ret =3D -1; + + if (virTestRun("testVshTableHeader", testVshTableHeader, + NULL) < 0) + ret =3D -1; + + if (virTestRun("testVshTableRowAppend", testVshTableRowAppend, + NULL) < 0) + ret =3D -1; + + if (virTestRun("testVshTableWithUnicode", testVshTableNewUnicode, + NULL) < 0) + ret =3D -1; + + if (virTestRun("testNTables", testNTables, + NULL) < 0) + ret =3D -1; + + return ret =3D=3D 0 ? EXIT_SUCCESS : EXIT_FAILURE; +} + +VIR_TEST_MAIN(mymain) --=20 2.17.1 -- libvir-list mailing list libvir-list@redhat.com https://www.redhat.com/mailman/listinfo/libvir-list