From 1c46636b7e810ab00727901e6e7f9adbf6b496b9 Mon Sep 17 00:00:00 2001
From: Alexandre Aubin <alex.aubin@mailoo.org>
Date: Fri, 17 Sep 2021 18:27:16 +0200
Subject: [PATCH] tests: add mypy + misc fixes to make test pass

---
 .gitlab/ci/lint.gitlab-ci.yml | 7 +++++++
 src/yunohost/domain.py        | 3 ++-
 src/yunohost/log.py           | 3 ++-
 src/yunohost/tools.py         | 3 ++-
 src/yunohost/utils/config.py  | 5 +++--
 src/yunohost/utils/dns.py     | 4 +++-
 tox.ini                       | 2 ++
 7 files changed, 21 insertions(+), 6 deletions(-)

diff --git a/.gitlab/ci/lint.gitlab-ci.yml b/.gitlab/ci/lint.gitlab-ci.yml
index 9c48bd912..aaddb5a0a 100644
--- a/.gitlab/ci/lint.gitlab-ci.yml
+++ b/.gitlab/ci/lint.gitlab-ci.yml
@@ -19,6 +19,13 @@ invalidcode37:
   script:
     - tox -e py37-invalidcode
 
+mypy:
+  stage: lint
+  image: "before-install"
+  needs: []
+  script:
+    - tox -e py37-mypy
+
 format-check:
   stage: lint
   image: "before-install"
diff --git a/src/yunohost/domain.py b/src/yunohost/domain.py
index 5c67fce1a..1f96ced8a 100644
--- a/src/yunohost/domain.py
+++ b/src/yunohost/domain.py
@@ -24,6 +24,7 @@
     Manage domains
 """
 import os
+from typing import Dict, Any
 
 from moulinette import m18n, Moulinette
 from moulinette.core import MoulinetteError
@@ -47,7 +48,7 @@ DOMAIN_CONFIG_PATH = "/usr/share/yunohost/other/config_domain.toml"
 DOMAIN_SETTINGS_DIR = "/etc/yunohost/domains"
 
 # Lazy dev caching to avoid re-query ldap every time we need the domain list
-domain_list_cache = {}
+domain_list_cache: Dict[str, Any] = {}
 
 
 def domain_list(exclude_subdomains=False):
diff --git a/src/yunohost/log.py b/src/yunohost/log.py
index f40470063..c99c1bbc9 100644
--- a/src/yunohost/log.py
+++ b/src/yunohost/log.py
@@ -29,6 +29,7 @@ import re
 import yaml
 import glob
 import psutil
+from typing import List
 
 from datetime import datetime, timedelta
 from logging import FileHandler, getLogger, Formatter
@@ -478,7 +479,7 @@ class OperationLogger(object):
     This class record logs and metadata like context or start time/end time.
     """
 
-    _instances = []
+    _instances: List[object] = []
 
     def __init__(self, operation, related_to=None, **kwargs):
         # TODO add a way to not save password on app installation
diff --git a/src/yunohost/tools.py b/src/yunohost/tools.py
index 4190e7614..bd256ff2b 100644
--- a/src/yunohost/tools.py
+++ b/src/yunohost/tools.py
@@ -29,6 +29,7 @@ import subprocess
 import time
 from importlib import import_module
 from packaging import version
+from typing import List
 
 from moulinette import Moulinette, m18n
 from moulinette.utils.log import getActionLogger
@@ -1113,7 +1114,7 @@ class Migration(object):
     # Those are to be implemented by daughter classes
 
     mode = "auto"
-    dependencies = []  # List of migration ids required before running this migration
+    dependencies: List[str] = []  # List of migration ids required before running this migration
 
     @property
     def disclaimer(self):
diff --git a/src/yunohost/utils/config.py b/src/yunohost/utils/config.py
index a6c3b299e..99c898d15 100644
--- a/src/yunohost/utils/config.py
+++ b/src/yunohost/utils/config.py
@@ -25,6 +25,7 @@ import urllib.parse
 import tempfile
 import shutil
 from collections import OrderedDict
+from typing import Optional, Dict, List
 
 from moulinette.interfaces.cli import colorize
 from moulinette import Moulinette, m18n
@@ -454,7 +455,7 @@ class ConfigPanel:
 
 class Question(object):
     hide_user_input_in_prompt = False
-    pattern = None
+    pattern: Optional[Dict] = None
 
     def __init__(self, question, user_answers):
         self.name = question["name"]
@@ -940,7 +941,7 @@ class DisplayTextQuestion(Question):
 
 class FileQuestion(Question):
     argument_type = "file"
-    upload_dirs = []
+    upload_dirs: List[str] = []
 
     @classmethod
     def clean_upload_dirs(cls):
diff --git a/src/yunohost/utils/dns.py b/src/yunohost/utils/dns.py
index 095e5000a..3db75f949 100644
--- a/src/yunohost/utils/dns.py
+++ b/src/yunohost/utils/dns.py
@@ -19,13 +19,15 @@
 
 """
 import dns.resolver
+from typing import List
+
 from moulinette.utils.filesystem import read_file
 
 YNH_DYNDNS_DOMAINS = ["nohost.me", "noho.st", "ynh.fr"]
 
 # Lazy dev caching to avoid re-reading the file multiple time when calling
 # dig() often during same yunohost operation
-external_resolvers_ = []
+external_resolvers_: List[str] = []
 
 
 def external_resolvers():
diff --git a/tox.ini b/tox.ini
index c25d8bf8f..e79c70fec 100644
--- a/tox.ini
+++ b/tox.ini
@@ -6,8 +6,10 @@ skip_install=True
 deps =
   py37-{lint,invalidcode}: flake8
   py37-black-{run,check}: black
+  py37-mypy: mypy >= 0.900
 commands =
         py37-lint: flake8 src doc data tests --ignore E402,E501,E203,W503 --exclude src/yunohost/vendor
         py37-invalidcode: flake8 src data --exclude src/yunohost/tests,src/yunohost/vendor --select F
         py37-black-check: black --check --diff src doc data tests
         py37-black-run: black src doc data tests
+        py37-mypy: mypy  --ignore-missing-import --install-types --non-interactive --follow-imports silent src/yunohost/ --exclude (acme_tiny|data_migrations)