From patchwork Mon Jul 15 21:15:01 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Vasu Dasari X-Patchwork-Id: 1132312 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: ozlabs.org; spf=pass (mailfrom) smtp.mailfrom=openvswitch.org (client-ip=140.211.169.12; helo=mail.linuxfoundation.org; envelope-from=ovs-dev-bounces@openvswitch.org; receiver=) Authentication-Results: ozlabs.org; dmarc=fail (p=none dis=none) header.from=gmail.com Authentication-Results: ozlabs.org; dkim=fail reason="signature verification failed" (2048-bit key; unprotected) header.d=gmail.com header.i=@gmail.com header.b="JZYYjYYr"; dkim-atps=neutral Received: from mail.linuxfoundation.org (mail.linuxfoundation.org [140.211.169.12]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 45nbsL75S0z9sBt for ; Tue, 16 Jul 2019 07:15:18 +1000 (AEST) Received: from mail.linux-foundation.org (localhost [127.0.0.1]) by mail.linuxfoundation.org (Postfix) with ESMTP id EE3CED4F; Mon, 15 Jul 2019 21:15:15 +0000 (UTC) X-Original-To: dev@openvswitch.org Delivered-To: ovs-dev@mail.linuxfoundation.org Received: from smtp1.linuxfoundation.org (smtp1.linux-foundation.org [172.17.192.35]) by mail.linuxfoundation.org (Postfix) with ESMTPS id A10FCB9E for ; Mon, 15 Jul 2019 21:15:14 +0000 (UTC) X-Greylist: whitelisted by SQLgrey-1.7.6 Received: from mail-qt1-f193.google.com (mail-qt1-f193.google.com [209.85.160.193]) by smtp1.linuxfoundation.org (Postfix) with ESMTPS id BC1BB878 for ; Mon, 15 Jul 2019 21:15:13 +0000 (UTC) Received: by mail-qt1-f193.google.com with SMTP id w17so17223916qto.10 for ; Mon, 15 Jul 2019 14:15:13 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id; bh=j9T0XlulUdyp0+k6KxH4iSSnZPXQc77SphIsQVu34Qo=; b=JZYYjYYrF/AmSIauQ5LR22M+jv3a7Aw0xOATqQOtYNmWL2bhy5Akkz7T3fgqyyk7Kq KixDmAQqouf6/bLGWc/djZm2UlE1+J0FQQUB9qdE3Mj57kIMBrBLC3fLLD3zTxmglW4H tV5myyuYUF6uRisJZbEtCgRs7gS50BbHegxvLdSW2tBMQPbu5lHBysAHRXn/1TVFoLXZ TcChsMmN2FtzOid7DLL1XpeiRr2RMnrgXL7H8g73AgVJUbZWxMC6LVuU983SAgJR1/mQ JpXw8rgibtCfefoFa1atAwfZSRZcdkxNUw4gxaEtvtUmQ0NyqlH0IPa0c4mh5KIp67wa mGbA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id; bh=j9T0XlulUdyp0+k6KxH4iSSnZPXQc77SphIsQVu34Qo=; b=OU0wvAGJYkly4naFkKqV9Y4MO0DWtCRWVeh7DsezyLCt2k5jruDC+Xu5WK7vPQMyG/ uxbrOteiGN2jHXrbPgNz/i7q1lXEOg6GriiWZwLD+SXVykXZdkuGdof3io0go3uEEzyN Vx+YKzdBuuQgtn9RE5Ig3+ks6mWtHQUby186S2xTSO3mNsWbPGGhbNHAFXuV7UiKU339 QQuBOa0AtSjC8C7D1qq0YO7srhe5HQ1nW1gpVp4VWzuBx+/+VchWh7l8TyVPIrfNa81c 2VofO1puJsYwOPj8fBeVxkXUKQf/6QA4gaxF5lT1kya2AWuUWCc6Z7pUYmQ0BPIfwPf3 jhug== X-Gm-Message-State: APjAAAU69xjRop2Qt0QaStNS6XVnuXfR17HPfZyhjQx8Mr/LGI2Tx6qs 0CeKdzXyTyuyPFCyxpYUymx0xyOs7e8= X-Google-Smtp-Source: APXvYqxw0b8E7OjOaIftL1osHt5cb17m6k4cXsQCNDMXPX4OOSO+Ytw6huRfwut9daKArB1tUHqujw== X-Received: by 2002:a0c:b897:: with SMTP id y23mr20703427qvf.44.1563225312433; Mon, 15 Jul 2019 14:15:12 -0700 (PDT) Received: from localhost.localdomain ([73.61.23.248]) by smtp.gmail.com with ESMTPSA id p3sm12920858qta.12.2019.07.15.14.15.11 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Mon, 15 Jul 2019 14:15:11 -0700 (PDT) From: Vasu Dasari To: dev@openvswitch.org Date: Mon, 15 Jul 2019 17:15:01 -0400 Message-Id: <20190715211501.88213-1-vdasari@gmail.com> X-Mailer: git-send-email 2.17.2 (Apple Git-113) X-Spam-Status: No, score=-2.0 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, FREEMAIL_FROM, RCVD_IN_DNSWL_NONE autolearn=ham version=3.3.1 X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on smtp1.linux-foundation.org Subject: [ovs-dev] [PATCH v2] ovs-macros: An option to suspend test execution on error X-BeenThere: ovs-dev@openvswitch.org X-Mailman-Version: 2.1.12 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Sender: ovs-dev-bounces@openvswitch.org Errors-To: ovs-dev-bounces@openvswitch.org Origins for this patch are captured at https://mail.openvswitch.org/pipermail/ovs-discuss/2019-June/048923.html. Summarizing here, when a test fails, it would be good to pause test execution and let the developer poke around the system to see current status of system. As part of this patch, made a small tweaks to ovs-macros.at, so that when test suite fails, ovs_on_exit() function will be called. And in this function, a check is made to see if an environment variable to OVS_PAUSE_TEST is set. If it is set, then test suite is paused and will continue to wait for user input Ctrl-D. Meanwhile user can poke around the system to see why test case has failed. Once done with investigation, user can press ctrl-d to cleanup the test suite. For example, to re-run test case 139: export OVS_PAUSE_TEST=1 cd tests/system-userspace-testsuite.dir/139 sudo -E ./run When error occurs, above command would display something like this: ===================================================== Set environment variable to use various ovs utilities export OVS_RUNDIR=/opt/vdasari/Developer/ovs/_build-gcc/tests/system-userspace-testsuite.dir/139 Press ENTER to continue: ===================================================== And from another window, one can execute ovs-xxx commands like: export OVS_RUNDIR=/opt/vdasari/Developer/ovs/_build-gcc/tests/system-userspace-testsuite.dir/139 $ ovs-ofctl dump-ports br0 . . To be able to pause while performing `make check`, one can do: $ OVS_PAUSE_TEST=1 make check TESTSUITEFLAGS='-v' Signed-off-by: Vasu Dasari Reviewed-by: Ben Pfaff Reviewed-by: Aaron Conole Acked-by: Aaron Conole --- v0 -> v1: Discussion at: https://mail.openvswitch.org/pipermail/ovs-dev/2019-July/360589.html 1. Incorporated review commanets from Ben. 2. Changed topics/testing.rst to document this trick 3. Made this trick work via "make check" as well, by issuing command: "OVS_PAUSE_TEST=1 make check TESTSUITEFLAGS='-v'" v1 -> v2: Discussion at: https://mail.openvswitch.org/pipermail/ovs-dev/2019-July/360705.html 1. Added a subsection, "Debugging unit tests" 2. Renamed $as_echo to just echo. AS_ECHO is not suported in autoconf 2.69.11. And, we are not gainin g anything from AS_ECHO in this code, just using echo. --- Documentation/topics/testing.rst | 31 +++++++++++++++++++++++++++++++ tests/ovs-macros.at | 24 +++++++++++++++++++++++- 2 files changed, 54 insertions(+), 1 deletion(-) diff --git a/Documentation/topics/testing.rst b/Documentation/topics/testing.rst index a8892e1c1..73077042c 100644 --- a/Documentation/topics/testing.rst +++ b/Documentation/topics/testing.rst @@ -81,6 +81,37 @@ To see a complete list of test options, run:: The results of a testing run are reported in ``tests/testsuite.log``. Report report test failures as bugs and include the ``testsuite.log`` in your report. +Debugging unit tests +++++++++++++++++++++ + +To initiate debugging from artifacts generated from `make check` run, use +following instructions. For example, to re-run test case 139:: + + export OVS_PAUSE_TEST=1 + cd tests/system-userspace-testsuite.dir/139 + sudo -E ./run + +When error occurs, above command would display something like this:: + + Set environment variable to use various ovs utilities + export OVS_RUNDIR=/ovs/_build-gcc/tests/system-userspace-testsuite.dir/139 + Press ENTER to continue: + +And from another window, one can execute ovs-xxx commands like:: + + export OVS_RUNDIR=/opt/vdasari/Developer/ovs/_build-gcc/tests/system-userspace-testsuite.dir/139 + $ ovs-ofctl dump-ports br0 + . + . + +Once done with investigation, press ENTER to perform cleanup operation. + +To be able to pause on error while performing `make check`, one can do:: + + $ OVS_PAUSE_TEST=1 make check TESTSUITEFLAGS='-v' + +and then follow similar on screen instructions + .. note:: Sometimes a few tests may fail on some runs but not others. This is usually a bug in the testsuite, not a bug in Open vSwitch itself. If you find that a diff --git a/tests/ovs-macros.at b/tests/ovs-macros.at index 10593429d..b6add7fda 100644 --- a/tests/ovs-macros.at +++ b/tests/ovs-macros.at @@ -35,11 +35,33 @@ m4_divert_push([PREPARE_TESTS]) # directory. ovs_init() { ovs_base=`pwd` - trap '. "$ovs_base/cleanup"' 0 + trap ovs_on_exit 0 : > cleanup ovs_setenv } +# Catch testsuite error condition and cleanup test environment by tearing down +# all interfaces and processes spawned. +# User has an option to leave the test environment in error state so that system +# can be poked around to get more information. User can enable this option by setting +# environment variable OVS_PAUSE_TEST=1. User needs to press CTRL-D to resume the +# cleanup operation. +ovs_pause() { + echo "=====================================================" + echo "Set following environment variable to use various ovs utilities" + echo "export OVS_RUNDIR=$ovs_base" + echo "Press ENTER to continue: " + read +} + +ovs_on_exit () { + if [ ! -z "${OVS_PAUSE_TEST}" ] && [ -z $at_verbose ]; then + trap '' INT + ovs_pause + fi + . "$ovs_base/cleanup" +} + # With no parameter or an empty parameter, sets the OVS_*DIR # environment variables to point to $ovs_base, the base directory in # which the test is running.