doc(tests): Add badges reflecting code quality + README.md dedicated …

…to tests

.gitignore

@@ -1,2 +1,3 @@
 appdaemon/compiled/*
 **/__pycache__/*
+**/.coverage

README.md

@@ -1,3 +1,5 @@
+![](images/pylint.svg) ![](images/pytest.svg) ![](images/coverage.svg)
+
 # Home Assistant Config
 
 This repository is gathering the part of home assistant configuration and appdaemon script I want to share with the community.

appdaemon/test/README.md

@@ -0,0 +1,19 @@
+# Appdaemon application tests
+
+***X@v*** : Can you explain me why tests are important in computer programming in 2 sentences?
+
+***ChatGPT***: Tests are crucial in computer programming as they help ensure the correctness and reliability of code by systematically verifying that it produces the expected outcomes. They also aid in detecting and preventing bugs early in the development process, leading to more maintainable and higher quality software.
+
+Voilà, this is why I created this directory.
+
+## Test coverage
+
+Test coverage measures the extent to which a software's source code is exercised by a set of tests, indicating the proportion of code paths that have been tested.
+
+For my Appdaemon application I try to cover the maximum of code with tests.
+
+## Test framework
+
+The test framework is a structured environment and set of tools that streamline the process of designing, executing, and managing tests, enhancing the efficiency and effectiveness of software testing endeavors.
+
+I found on the Internet several test framework for Appdaemon. The one I choose was not the most powerfull but it is easy to understand and easy to upgrade.

appdaemon/test/generate_badges.sh

@@ -0,0 +1,16 @@
+#!/bin/bash
+test_dir=$(realpath "$(dirname $0)")
+appdaemon_dir=$(realpath "${test_dir}/../")
+git_dir=$(realpath "${appdaemon_dir}/../")
+apps_dir=$(realpath "${appdaemon_dir}/apps/")
+pushd ${appdaemon_dir} > /dev/null
+export PYTHONPATH=${apps_dir}
+value=$(coverage run --source ${apps_dir} -m pytest | tee /dev/tty |  perl -ne '/\[(.*)\]/ and print "$1\n"' | tail -1)
+anybadge -l "pytest success" -v ${value} -o -f ../images/pytest.svg 70=red 80=orange 90=yellow 100=green
+value=$(coverage report -m |& tee /dev/tty | perl -ne '/TOTAL.* (\S+%)/ and print "$1"')
+anybadge -l coverage -v ${value} -o -f ../images/coverage.svg 70=red 80=orange 90=yellow 100=green
+coverage html 
+echo ${test_dir}/htmlcov/index.html
+value=$(pylint $(git ls-files '*.py' | grep -v notifier.py | grep -v hass_driver.py) --rcfile ${git_dir}/.pylintrc | tee /dev/tty | perl -ne '/at (\S+)/ and print "$1"')
+anybadge -l pylint -v "${value}" -o -f ../images/pylint.svg 70=red 80=orange 90=yellow 100=green
+popd > /dev/null

appdaemon/test/requirements.txt

@@ -1,3 +1,4 @@
+anybadge==1.14.0
 appdaemon==4.4.2
 coverage==7.2.7
 esphome==2023.8.0

appdaemon/test/run_test.sh

@@ -3,5 +3,5 @@ test_dir=$(realpath "$(dirname $0)")
 appdaemon_dir=$(realpath "${test_dir}/../")
 apps_dir=$(realpath "${appdaemon_dir}/apps/")
 pushd ${appdaemon_dir} > /dev/null
-PYTHONPATH={apps_dir} pytest-watch -- --random-order --sw -vsx $@
+PYTHONPATH="${apps_dir}" pytest-watch -- --random-order --sw -vsx $@
 popd > /dev/null