From c7bd6d9ba7d93ddf0437644855ecd8d96a058da4 Mon Sep 17 00:00:00 2001
From: Max Carrara <m.carrara@proxmox.com>
Date: Fri, 22 Mar 2024 19:06:24 +0100
Subject: [PATCH] use mypy for automatic type checks in Python

This commit adds mypy [0] as build dependency and ensures it is
invoked during the package build process.

mypy can also be manually invoked via `make lint`.

A mypy.ini file [1] is also added to disable errors regarding missing
type stubs for pyVmomi and pyVim.

[0]: https://www.mypy-lang.org/
[1]: https://mypy.readthedocs.io/en/stable/config_file.html

Signed-off-by: Max Carrara <m.carrara@proxmox.com>
---
 Makefile       | 13 ++++++++++++-
 debian/control |  1 +
 mypy.ini       |  8 ++++++++
 3 files changed, 21 insertions(+), 1 deletion(-)
 create mode 100644 mypy.ini

diff --git a/Makefile b/Makefile
index 73e7c5e..cc70305 100644
--- a/Makefile
+++ b/Makefile
@@ -28,6 +28,7 @@ BINARY = $(COMPILEDIR)/esxi-folder-fuse
 SCRIPT = listvms.py
 
 CARGO ?= cargo
+MYPY ?= mypy
 
 .PHONY: all
 all: $(BINARY)
@@ -40,8 +41,17 @@ check: test
 test:
 	$(CARGO) test $(CARGO_BUILD_ARGS)
 
+.lint-incremental: $(SCRIPT)
+	$(MYPY) $?
+	touch "$@"
+
+.PHONY: lint
+lint: $(SCRIPT)
+	$(MYPY) $(SCRIPT)
+	touch ".lint-incremental"
+
 .PHONY: install
-install: $(BINARY) $(SCRIPT)
+install: $(BINARY) $(SCRIPT) .lint-incremental
 	install -m755 -d $(DESTDIR)$(LIBEXECDIR)/pve-esxi-import-tools
 	install -m755 -t $(DESTDIR)$(LIBEXECDIR)/pve-esxi-import-tools $(BINARY)
 	install -m755 -t $(DESTDIR)$(LIBEXECDIR)/pve-esxi-import-tools $(SCRIPT)
@@ -55,6 +65,7 @@ $(BUILD_DIR):
 	cp -t $@.tmp -a \
 	  debian \
 	  Makefile \
+	  mypy.ini \
 	  listvms.py \
 	  Cargo.toml \
 	  src
diff --git a/debian/control b/debian/control
index 3c12f29..8687d6d 100644
--- a/debian/control
+++ b/debian/control
@@ -30,6 +30,7 @@ Build-Depends: cargo:native (>= 0.65.0~),
                librust-tokio-1+rt-multi-thread-dev,
                librust-tokio-1+time-dev,
                libstd-rust-dev,
+               mypy,
                rustc:native,
 Maintainer: Proxmox Support Team <support@proxmox.com>
 Standards-Version: 4.6.2
diff --git a/mypy.ini b/mypy.ini
new file mode 100644
index 0000000..e6724c8
--- /dev/null
+++ b/mypy.ini
@@ -0,0 +1,8 @@
+[mypy]
+
+[mypy-pyVmomi]
+ignore_missing_imports = True
+
+[mypy-pyVim.*]
+ignore_missing_imports = True
+