qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: John Snow <jsnow@redhat.com>
To: qemu-devel@nongnu.org
Cc: Kevin Wolf <kwolf@redhat.com>,
	Eduardo Habkost <ehabkost@redhat.com>,
	qemu-block@nongnu.org, Hanna Reitz <hreitz@redhat.com>,
	Cleber Rosa <crosa@redhat.com>, John Snow <jsnow@redhat.com>
Subject: [PATCH 10/13] iotests/linters: Add entry point for linting via Python CI
Date: Mon,  4 Oct 2021 17:05:00 -0400	[thread overview]
Message-ID: <20211004210503.1455391-11-jsnow@redhat.com> (raw)
In-Reply-To: <20211004210503.1455391-1-jsnow@redhat.com>

We need at least a tiny little shim here to join test file discovery
with test invocation. This logic could conceivably be hosted somewhere
in python/, but I felt it was strictly the least-rude thing to keep the
test logic here in iotests/, even if this small function isn't itself an
iotest.

Note that we don't actually even need the executable bit here, we'll be
relying on the ability to run this module as a script using Python CLI
arguments. No chance it gets misunderstood as an actual iotest that way.

(It's named, not in tests/, doesn't have the execute bit, and doesn't
have an execution shebang.)

Signed-off-by: John Snow <jsnow@redhat.com>

---

(1) I think that the test file discovery logic and skip list belong together,
    and that those items belong in iotests/. I think they also belong in
    whichever directory pylintrc and mypy.ini are in, also in iotests/.

(2) Moving this logic into python/tests/ is challenging because I'd have
    to import iotests code from elsewhere in the source tree, which just
    inverts an existing problem I have been trying to rid us of --
    needing to muck around with PYTHONPATH or sys.path hacking in python
    scripts. I'm keen to avoid this.

(3) If we moved all python tests into tests/ and gave them *.py
    extensions, we wouldn't even need the test discovery functions
    anymore, and all of linters.py could be removed entirely, including
    this execution shim. We could rely on mypy/pylint's own file
    discovery mechanisms at that point. More work than I'm up for with
    just this series, but I could be coaxed into doing it if there was
    some promise of not rejecting all that busywork ;)

Signed-off-by: John Snow <jsnow@redhat.com>
---
 tests/qemu-iotests/linters.py | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/tests/qemu-iotests/linters.py b/tests/qemu-iotests/linters.py
index f6a2dc139fd..191df173064 100644
--- a/tests/qemu-iotests/linters.py
+++ b/tests/qemu-iotests/linters.py
@@ -16,6 +16,7 @@
 import os
 import re
 import subprocess
+import sys
 from typing import List, Mapping, Optional
 
 
@@ -81,3 +82,20 @@ def run_linter(
 
     return p.returncode
 
+
+def main() -> int:
+    """
+    Used by the Python CI system as an entry point to run these linters.
+    """
+    files = get_test_files()
+
+    if sys.argv[1] == '--pylint':
+        return run_linter('pylint', files)
+    elif sys.argv[1] == '--mypy':
+        return run_linter('mypy', files)
+
+    raise ValueError(f"Unrecognized argument(s): '{sys.argv[1:]}'")
+
+
+if __name__ == '__main__':
+    sys.exit(main())
-- 
2.31.1



  parent reply	other threads:[~2021-10-04 21:22 UTC|newest]

Thread overview: 31+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-10-04 21:04 [PATCH 00/13] python/iotests: Run iotest linters during Python CI John Snow
2021-10-04 21:04 ` [PATCH 01/13] iotests/297: Move pylint config into pylintrc John Snow
2021-10-13 10:49   ` Hanna Reitz
2021-10-04 21:04 ` [PATCH 02/13] iotests/297: Split mypy configuration out into mypy.ini John Snow
2021-10-13 10:53   ` Hanna Reitz
2021-10-13 14:37     ` John Snow
2021-10-04 21:04 ` [PATCH 03/13] iotests/297: Add get_files() function John Snow
2021-10-13 10:58   ` Hanna Reitz
2021-10-04 21:04 ` [PATCH 04/13] iotests/297: Don't rely on distro-specific linter binaries John Snow
2021-10-04 21:04 ` [PATCH 05/13] iotests/297: Create main() function John Snow
2021-10-13 11:03   ` Hanna Reitz
2021-10-13 14:41     ` John Snow
2021-10-04 21:04 ` [PATCH 06/13] iotests/297: Separate environment setup from test execution John Snow
2021-10-13 11:07   ` Hanna Reitz
2021-10-04 21:04 ` [PATCH 07/13] iotests/297: Split run_linters apart into run_pylint and run_mypy John Snow
2021-10-13 11:18   ` Hanna Reitz
2021-10-04 21:04 ` [PATCH 08/13] iotests/297: refactor run_[mypy|pylint] as generic execution shim John Snow
2021-10-13 11:26   ` Hanna Reitz
2021-10-04 21:04 ` [PATCH 09/13] iotests: split linters.py out from 297 John Snow
2021-10-13 11:50   ` Hanna Reitz
2021-10-13 15:07     ` John Snow
2021-10-13 16:28       ` Hanna Reitz
2021-10-04 21:05 ` John Snow [this message]
2021-10-13 12:11   ` [PATCH 10/13] iotests/linters: Add entry point for linting via Python CI Hanna Reitz
2021-10-13 15:11     ` John Snow
2021-10-04 21:05 ` [PATCH 11/13] iotests/linters: Add workaround for mypy bug #9852 John Snow
2021-10-13 12:15   ` Hanna Reitz
2021-10-04 21:05 ` [PATCH 12/13] python: Add iotest linters to test suite John Snow
2021-10-13 12:21   ` Hanna Reitz
2021-10-04 21:05 ` [PATCH 13/13] iotests: [RFC] drop iotest 297 John Snow
2021-10-13 12:23   ` Hanna Reitz

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=20211004210503.1455391-11-jsnow@redhat.com \
    --to=jsnow@redhat.com \
    --cc=crosa@redhat.com \
    --cc=ehabkost@redhat.com \
    --cc=hreitz@redhat.com \
    --cc=kwolf@redhat.com \
    --cc=qemu-block@nongnu.org \
    --cc=qemu-devel@nongnu.org \
    /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.
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 NNTP newsgroup(s).