From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 8F144A0508; Wed, 6 Apr 2022 17:14:52 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id BD704428BD; Wed, 6 Apr 2022 17:13:02 +0200 (CEST) Received: from lb.pantheon.sk (lb.pantheon.sk [46.229.239.20]) by mails.dpdk.org (Postfix) with ESMTP id 50B324285E for ; Wed, 6 Apr 2022 17:12:59 +0200 (CEST) Received: from localhost (localhost [127.0.0.1]) by lb.pantheon.sk (Postfix) with ESMTP id A625B184FE9; Wed, 6 Apr 2022 17:12:58 +0200 (CEST) X-Virus-Scanned: amavisd-new at siecit.sk Received: from lb.pantheon.sk ([127.0.0.1]) by localhost (lb.pantheon.sk [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id 2Knq1rATWYpM; Wed, 6 Apr 2022 17:12:57 +0200 (CEST) Received: from entguard.lab.pantheon.local (unknown [46.229.239.141]) by lb.pantheon.sk (Postfix) with ESMTP id 2677B184FEE; Wed, 6 Apr 2022 17:12:56 +0200 (CEST) From: =?UTF-8?q?Juraj=20Linke=C5=A1?= To: thomas@monjalon.net, david.marchand@redhat.com, Honnappa.Nagarahalli@arm.com, ohilyard@iol.unh.edu, lijuan.tu@intel.com Cc: dev@dpdk.org, =?UTF-8?q?Juraj=20Linke=C5=A1?= Subject: [RFC PATCH v1 3/6] dts: merge DTS framework/rst.py to DPDK Date: Wed, 6 Apr 2022 15:12:51 +0000 Message-Id: <20220406151254.2915709-4-juraj.linkes@pantheon.tech> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20220406151254.2915709-1-juraj.linkes@pantheon.tech> References: <20220406151254.2915709-1-juraj.linkes@pantheon.tech> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org --- dts/framework/rst.py | 168 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 168 insertions(+) create mode 100644 dts/framework/rst.py diff --git a/dts/framework/rst.py b/dts/framework/rst.py new file mode 100644 index 0000000000..18d7ccea39 --- /dev/null +++ b/dts/framework/rst.py @@ -0,0 +1,168 @@ +# BSD LICENSE +# +# Copyright(c) 2010-2014 Intel Corporation. All rights reserved. +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions +# are met: +# +# * Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# * Redistributions in binary form must reproduce the above copyright +# notice, this list of conditions and the following disclaimer in +# the documentation and/or other materials provided with the +# distribution. +# * Neither the name of Intel Corporation nor the names of its +# contributors may be used to endorse or promote products derived +# from this software without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +import os +import re +import shutil + +from .exception import VerifyFailure + +""" +Generate Rst Test Result Report + +Example: + import framework.rst as rst + rst.write_title("Test Case: " + test_case.__name__) + out = table.draw() + rst.write_text('\n' + out + '\n\n') + rst.write_result("PASS") + +Result: + + + Test Case: CASE + --------------- + Result: PASS +""" + +path2Plan = "test_plans" +path2Result = "output" + + +class RstReport(object): + def __init__(self, crbName, target, nic, suite, perf=False): + """ + copy desc from #Name#_test_plan.rst to TestResult_#Name#.rst + """ + try: + path = [path2Result, crbName, target, nic] + # ensure the level folder exist + for node in range(0, len(path)): + if not os.path.exists("/".join(path[: node + 1])): + for level in range(node, len(path)): + os.mkdir("/".join(path[: level + 1])) + break + + self.rstName = "%s/TestResult_%s.rst" % ("/".join(path), suite) + rstReport = open(self.rstName, "w") + + if perf is True: + self.rstAnnexName = "%s/TestResult_%s_Annex.rst" % ( + "/".join(path), + suite, + ) + rstAnnexReport = open(self.rstAnnexName, "w") + + f = open("%s/%s_test_plan.rst" % (path2Plan, suite), "r") + for line in f: + if line[:13] == "Prerequisites": + break + rstReport.write(line) + if perf is True: + rstAnnexReport.write(line) + f.close() + + rstReport.close() + + except Exception as e: + raise VerifyFailure("RST Error: " + str(e)) + + def clear_all_rst(self, crbName, target): + path = [path2Result, crbName, target] + shutil.rmtree("/".join(path), True) + + def write_title(self, text): + """ + write case title Test Case: #Name# + ----------------- + """ + line = "\n%s\n" % text + with open(self.rstName, "a") as f: + f.write(line) + f.write("-" * len(line) + "\n") + + def write_subtitle(self): + if self._subtitle is not None: + with open(self.rstName, "a") as f: + f.write("%s\n" % self._subtitle) + + def write_annex_title(self, text): + """ + write annex to test case title Annex to #Name# + ----------------- + """ + line = "\n%s\n" % text + with open(self.rstAnnexName, "a") as f: + f.write(line) + f.write("-" * len(line) + "\n") + + def write_text(self, text, annex=False): + rstFile = self.rstAnnexName if annex else self.rstName + + with open(rstFile, "a") as f: + f.write(text) + + def write_frame(self, text, annex=False): + self.write_text("\n::\n\n", annex) + parts = re.findall(r"\S+", text) + text = "" + length = 0 + + for part in parts: + if length + len(part) > 75: + text = text + "\n" + " " + part + length = len(part) + else: + length = length + len(part) + text = text + " " + part + self.write_text(text, annex) + self.write_text("\n\n", annex) + + def write_result(self, result): + with open(self.rstName, "a") as f: + f.write("\nResult: " + result + "\n") + + def include_image(self, image, width=90): + """ + Includes an image in the RST file. + The argument must include path, name and extension. + """ + with open(self.rstName, "a") as f: + f.write(".. image:: %s\n :width: %d%%\n\n" % (image, width)) + + def report(self, text, frame=False, annex=False): + """ + Save report text into rst file. + """ + if frame: + self.write_frame(text, annex) + else: + self.write_text(text, annex) -- 2.20.1