public inbox for passt-dev@passt.top
 help / color / mirror / code / Atom feed
From: David Gibson <david@gibson.dropbear.id.au>
To: passt-dev@passt.top, Stefano Brivio <sbrivio@redhat.com>
Cc: crosa@redhat.com, jarichte@redhat.com,
	David Gibson <david@gibson.dropbear.id.au>
Subject: [PATCH 05/27] avocado, test: Add static checkers for Python code
Date: Tue, 27 Jun 2023 12:54:06 +1000	[thread overview]
Message-ID: <20230627025429.2209702-6-david@gibson.dropbear.id.au> (raw)
In-Reply-To: <20230627025429.2209702-1-david@gibson.dropbear.id.au>

We use both cppcheck and clang-tidy to lint our C code.  Now that we're
introducing Python code in the tests, use static checkers flake8 and pylint
for it too.  Run them from our testsuite.

Signed-off-by: David Gibson <david@gibson.dropbear.id.au>
---
 test/Makefile                          | 16 ++++++++++++++++
 test/avocado/static_checkers/flake8.sh |  3 +++
 test/avocado/static_checkers/pylint.sh |  3 +++
 3 files changed, 22 insertions(+)
 create mode 100755 test/avocado/static_checkers/flake8.sh
 create mode 100755 test/avocado/static_checkers/pylint.sh

diff --git a/test/Makefile b/test/Makefile
index 9b3af410..00b84856 100644
--- a/test/Makefile
+++ b/test/Makefile
@@ -209,6 +209,7 @@ jammy-server-cloudimg-s390x.img:
 PYTHON = python3
 VENV = venv
 PLUGIN = avocado_classless
+PYPKGS = $(PLUGIN)/$(PLUGIN) $(wildcard $(PLUGIN)/*.py)
 
 # Put this back if/when the plugin becomes available in upstream/system avocado
 #AVOCADO := $(shell which avocado)
@@ -219,6 +220,8 @@ endif
 $(VENV):
 	$(PYTHON) -m venv $(VENV)
 	$(VENV)/bin/pip install avocado-framework
+	$(VENV)/bin/pip install flake8
+	$(VENV)/bin/pip install pylint
 	$(VENV)/bin/pip install -e ./$(PLUGIN)
 
 .PHONY: avocado-assets
@@ -228,6 +231,19 @@ avocado-assets:
 avocado: avocado-assets $(VENV)
 	$(AVOCADO) run avocado
 
+flake8: $(VENV)
+	$(VENV)/bin/flake8 $(PYPKGS)
+
+# pylint suppressions:
+#
+# C0116 missing-function-docstring
+#    We have a bunch of trivial functions for which docstrings would be overkill
+# 
+pylint: $(VENV)
+	$(VENV)/bin/pylint \
+                --disable=C0116 \
+	    $(PYPKGS)
+
 .PHONY: check
 check: avocado check-legacy
 
diff --git a/test/avocado/static_checkers/flake8.sh b/test/avocado/static_checkers/flake8.sh
new file mode 100755
index 00000000..66f59fb0
--- /dev/null
+++ b/test/avocado/static_checkers/flake8.sh
@@ -0,0 +1,3 @@
+#! /bin/sh
+
+make flake8
diff --git a/test/avocado/static_checkers/pylint.sh b/test/avocado/static_checkers/pylint.sh
new file mode 100755
index 00000000..a52f19f8
--- /dev/null
+++ b/test/avocado/static_checkers/pylint.sh
@@ -0,0 +1,3 @@
+#! /bin/sh
+
+make pylint
-- 
@@ -0,0 +1,3 @@
+#! /bin/sh
+
+make pylint
-- 
2.41.0


  parent reply	other threads:[~2023-06-27  2:54 UTC|newest]

Thread overview: 32+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-06-27  2:54 [PATCH 00/27] RFC: Start converting passt & pasta tests to Avocado using special plugin David Gibson
2023-06-27  2:54 ` [PATCH 01/27] avocado: Make a duplicate copy of testsuite for comparison purposes David Gibson
2023-06-27  2:54 ` [PATCH 02/27] avocado: Don't double download assets for test/ and oldtest/ David Gibson
2023-06-27  2:54 ` [PATCH 03/27] avocado: Move static checkers to avocado David Gibson
2023-06-27  2:54 ` [PATCH 04/27] avocado: Introduce "avocado-classless" plugin, runner and outline David Gibson
2023-06-27  2:54 ` David Gibson [this message]
2023-06-27  2:54 ` [PATCH 06/27] avocado: Resolver implementation for avocado-classless plugin David Gibson
2023-06-27  2:54 ` [PATCH 07/27] avocado: Add basic assertion helpers to " David Gibson
2023-06-27  2:54 ` [PATCH 08/27] tasst, avocado: Introduce library of common test helpers David Gibson
2023-06-27  2:54 ` [PATCH 09/27] avocado-classless: Test matrices by composition David Gibson
2023-06-27  2:54 ` [PATCH 10/27] tasst: Helper functions for executing commands in different places David Gibson
2023-06-27  2:54 ` [PATCH 11/27] avocado-classless: Allow overriding default timeout David Gibson
2023-06-27  2:54 ` [PATCH 12/27] avocado: Convert build tests to avocado David Gibson
2023-06-27  2:54 ` [PATCH 13/27] tasst: Add helpers for running background commands on sites David Gibson
2023-06-27  2:54 ` [PATCH 14/27] tasst: Add helper to get network interface names for a site David Gibson
2023-06-27  2:54 ` [PATCH 15/27] tasst: Add helpers to run commands with nstool David Gibson
2023-06-27  2:54 ` [PATCH 16/27] tasst: Add ifup and network address helpers to Site David Gibson
2023-06-27  2:54 ` [PATCH 17/27] tasst: Helper for creating veth devices between namespaces David Gibson
2023-06-27  2:54 ` [PATCH 18/27] tasst: Add helper for getting MTU of a network interface David Gibson
2023-06-27  2:54 ` [PATCH 19/27] tasst: Add helper to wait for IP address to appear David Gibson
2023-06-27  2:54 ` [PATCH 20/27] tasst: Add helpers for getting a site's routes David Gibson
2023-06-27  2:54 ` [PATCH 21/27] tasst: Helpers to test transferring data between sites David Gibson
2023-06-27  2:54 ` [PATCH 22/27] tasst: IP address allocation helpers David Gibson
2023-06-27  2:54 ` [PATCH 23/27] tasst: Helpers for running daemons with a pidfile David Gibson
2023-06-27  2:54 ` [PATCH 24/27] tasst: Helpers for testing NDP behaviour David Gibson
2023-06-27  2:54 ` [PATCH 25/27] tasst: Helpers for testing DHCP & DHCPv6 behaviour David Gibson
2023-06-27  2:54 ` [PATCH 26/27] tasst: Helpers to construct a simple network environment for tests David Gibson
2023-06-27  2:54 ` [PATCH 27/27] avocado: Convert basic pasta tests David Gibson
2023-07-05  0:30   ` Stefano Brivio
2023-07-05  3:27     ` David Gibson
2023-07-07 17:42       ` Stefano Brivio
2023-07-10  7:45         ` David Gibson

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230627025429.2209702-6-david@gibson.dropbear.id.au \
    --to=david@gibson.dropbear.id.au \
    --cc=crosa@redhat.com \
    --cc=jarichte@redhat.com \
    --cc=passt-dev@passt.top \
    --cc=sbrivio@redhat.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://passt.top/passt

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for IMAP folder(s).