Merge pull request #105 from return42/yaml

[enh] add test.yamllint - lint yaml files

.dir-locals.el

@@ -50,37 +50,41 @@
 ((nil
   . ((fill-column . 80)
      (indent-tabs-mode . nil)
-     ))
- (makefile-gmake-mode
-  . ((indent-tabs-mode . t)
-     ))
- (python-mode
-  . ((indent-tabs-mode . nil)
-
      ;; project root folder is where the `.dir-locals.el' is located
      (eval . (setq-local
 	      prj-root (locate-dominating-file  default-directory ".dir-locals.el")))
-
      (eval . (setq-local
 	      python-environment-directory (expand-file-name "./local" prj-root)))
-
      ;; use 'py3' enviroment as default
      (eval . (setq-local
 	      python-environment-default-root-name "py3"))
-
      (eval . (setq-local
 	      python-shell-virtualenv-root
-	      (concat python-environment-directory
+              (expand-file-name python-environment-default-root-name python-environment-directory)
-		      "/"
+              ))
-		      python-environment-default-root-name)))
-
-     ;; python-shell-virtualenv-path is obsolete, use python-shell-virtualenv-root!
-     ;; (eval . (setq-local
-     ;; 	 python-shell-virtualenv-path python-shell-virtualenv-root))
-
      (eval . (setq-local
 	      python-shell-interpreter
 	      (expand-file-name "bin/python" python-shell-virtualenv-root)))
+     ))
+
+ (makefile-gmake-mode
+  . ((indent-tabs-mode . t)
+     ))
+
+ (yaml-mode
+  . (
+     ;; flycheck should use the local py3 environment
+     (eval . (setq-local
+	      flycheck-yaml-yamllint-executable
+	      (expand-file-name "bin/yamllint" python-shell-virtualenv-root)))
+     (eval . (setq-local
+              flycheck-yamllintrc
+              (expand-file-name  ".yamllint.yml" prj-root)))
+     (flycheck-checker . yaml-yamllint)
+     ))
+
+ (python-mode
+  . ((indent-tabs-mode . nil)
 
      (eval . (setq-local
 	      python-environment-virtualenv

.yamllint.yml

@@ -0,0 +1,16 @@
+extends: default
+
+rules:
+
+  indentation:
+    spaces: 2
+
+  # 120 chars should be enough, but don't fail if a line is longer
+  line-length:
+    max: 120
+    level: warning
+    allow-non-breakable-words: true
+
+  # we don't have multiple document per file
+  document-start: disable
+  document-end: disable

Makefile

@@ -51,8 +51,8 @@ search.checker.%: install
 	$(Q)./manage pyenv.cmd searx-checker -v "$(subst _, ,$(patsubst search.checker.%,%,$@))"
 
 PHONY += test ci.test test.shell
-ci.test: test.pep8 test.pylint test.unit test.robot
+ci.test: test.yamllint test.pep8 test.pylint test.unit test.robot
-test:    test.pep8 test.pylint test.unit test.robot test.shell
+test:    test.yamllint test.pep8 test.pylint test.unit test.robot test.shell
 test.shell:
 	$(Q)shellcheck -x -s dash \
 		dockerfiles/docker-entrypoint.sh
@@ -81,7 +81,7 @@ MANAGE += node.env node.clean
 MANAGE += py.build py.clean
 MANAGE += pyenv pyenv.install pyenv.uninstall
 MANAGE += pypi.upload pypi.upload.test
-MANAGE += test.pylint test.pep8 test.unit test.coverage test.robot test.clean
+MANAGE += test.yamllint test.pylint test.pep8 test.unit test.coverage test.robot test.clean
 MANAGE += themes.all themes.oscar themes.simple themes.bootstrap
 
 PHONY += $(MANAGE)

manage

@@ -29,6 +29,11 @@ pylint.FILES() {
     grep -l -r --include \*.py '^#[[:blank:]]*lint:[[:blank:]]*pylint' searx searx_extra tests
 }
 
+YAMLLINT_FILES=()
+while IFS= read -r line; do
+   YAMLLINT_FILES+=("$line")
+done <<< "$(git ls-files './tests/*.yml' './searx/*.yml')"
+
 PYLINT_SEARX_DISABLE_OPTION="\
 I,C,R,\
 W0105,W0212,W0511,W0603,W0613,W0621,W0702,W0703,W1401,\
@@ -391,6 +396,11 @@ pypi.upload.test() {
     pyenv.cmd twine upload -r testpypi "${PYDIST}"/*
 }
 
+test.yamllint() {
+    build_msg TEST "[pylint] \$PYLINT_FILES"
+    pyenv.cmd yamllint --format parsable "${YAMLLINT_FILES[@]}"
+}
+
 test.pylint() {
     # shellcheck disable=SC2086
     (   set -e

requirements-dev.txt

@@ -16,3 +16,4 @@ sphinxcontrib-programoutput==0.17
 sphinx-autobuild==2021.3.14
 linuxdoc==20210324
 aiounittest==1.4.0
+yamllint==1.26.1

searx/settings_robot.yml

@@ -1,5 +1,5 @@
 general:
-    debug : False
+  debug: false
   instance_name: "searx_test"
 
 search:
@@ -9,7 +9,7 @@ server:
   port: 11111
   bind_address: 127.0.0.1
   secret_key: "changedultrasecretkey"
-    base_url : False
+  base_url: false
   http_protocol_version: "1.0"
 
 ui:

tests/unit/settings/syntaxerror_settings.yml

@@ -1,2 +1,2 @@
 Test:
-  **********
+  "**********"

tests/unit/settings/user_settings.yml

@@ -1,5 +1,5 @@
 general:
-    debug : False
+  debug: false
   instance_name: "searx"
 
 search:
@@ -13,8 +13,8 @@ server:
   port: 9000
   bind_address: "0.0.0.0"
   secret_key: "user_settings_secret"
-    base_url : False
+  base_url: false
-    image_proxy : False
+  image_proxy: false
   http_protocol_version: "1.0"
   method: "POST"
   default_http_headers:

tests/unit/settings/user_settings_simple.yml

@@ -1,4 +1,4 @@
-use_default_settings: True
+use_default_settings: true
 server:
   secret_key: "user_secret_key"
   bind_address: "0.0.0.0"