Panel informacyjno-kontrolny #6: Puszczanie testów

Brakującym elementem tego panelu jest to, że tak naprawdę nim nie sterujesz. A więc wprowadźmy możliwość sterowania. W tym artykule wykorzystamy wiedzę ze wszystkich części tej serii i będziesz mógł uruchomić testy z wybranego pliku.

Pobieranie informacji o plikach z testami

Do wylistowania nazw plików z testami użyjemy biblioteki os. Podając ścieżkę do folderu z testami metodzie os.walk(),uzyskamy listę znajdujących się w niej plików. Stwórzmy więc klasę w pliku app.py, która będzie obsługiwała tworzenie listy testów:

class ListTest:
    def __init__(self):
        self.test_list = self.__get_tests()
 
    @staticmethod
    def __get_tests():
        import os
 
        path = os.path.abspath(os.getcwd())
 
        files = []
        for _, _, f in os.walk(path):
            for file in f:
                if '.py' in file and '.pyc' not in file and 'test_' in file:
                    files.append(file)
        return files
 
    def update_list(self):
        self.test_list = self.__get_tests()

Jako ścieżkę (path) używam miejsca, gdzie znajduje się plik startowy (app.py) mojego Flask’a. Jednak wystarczy, że zamienisz ją, na dowolną ścieżkę, gdzie znajdują się pliki z twoimi testami, a klasa będzie dalej działała poprawnie. Aby być pewnym, że znajdziemy tylko pliki, które nas interesują, przyjąłem, że muszą mieć rozszerzenie .py — wykluczając pliki .pyc. Dodatkowo moje testy posiadają w nazwie słowo test_. Jeśli posiadasz inną konwencję nazewnictwa, wystarczy, że wyedytujesz linijkę 14 powyższego kodu. Można użyć tu oczywiście wyrażeń regularnych aby sam warunek był dużo krótszy. Więcej na temat wyrażeń regularnych znajdziesz na poniższej stronie:

Tak przygotowana klasa musi być w jakiś sposób przekazana. Tu wykorzystam sposób z części trzeciej serii Panel informacyjno-kontrolny, czyli przekazanie zmiennych już podczas generowania template

Jeszcze przed wywołaniem metody służącej do generowania strony głównej, inicjalizujemy klasę ListTest(). Nie ma potrzeby tworzyć tego obiektu na nowo przy każdym odświeżaniu strony. W samej metodzie używam list_of_tests.update_list(), który uaktualnia listę plików znajdujących się w danym folderze. Na koniec przekazujemy dane w formie dwóch zmiennych file_list (lista plików) i len (ile plików znajduje się na tej liście):

list_of_tests = ListTest()
 
 
@app.route("/")
def hello():
    list_of_tests.update_list()
    return render_template('index.html', file_list=list_of_tests.test_list, len=len(list_of_tests.test_list))

Obsługa przesłanej listy w panelu

Teraz stwórzmy rozwijaną listę w naszym template’cie index.html. Zacznijmy może od tego, czego potrzebujemy na naszej stronie. Będzie to formularz, który w HTML’u jest obsługiwany za pomocą form. Spięta z nim za pomocą id, rozwijana lista – obsługiwana w HTML’u przez select. A także przycisk wywołujący testy – wykorzystamy tu input:

<select name="name" form="start_test">
    {%for i in range(0, len)%}
    <option>{{file_list[i]}}</option>
    {%endfor%}
</select>
<form action="/" id="start_test">
        <input type="submit" value="Start test" />
</form>

Jak widzisz powyżej, generacja listy została obsłużona językiem Jinja. Każda z opcji musi znajdować się pomiędzy <option> a </option>. W momencie przyciśnięcia przycisku formularz wywołuje akcje znajdującą się w argumencie action. Przekazuje w ten sposób wybrane dane z części <select> z kluczem name, gdyż taka została w nim przyjęta nazwa. Jednak nasz kod z perspektywy Flask’a nie jest jeszcze na to gotowy. Musimy wrócić do kodu app.py i obsłużyć dane wysłane z formularza. Poniżej pełen kod pliku index.html:

<html>
<head></head>
<script type=text/javascript src="{{url_for('static', filename='jquery.js') }}"></script>
<body>
<select name="name" form="start_test">
    {%for i in range(0, len)%}
    <option>{{file_list[i]}}</option>
    {%endfor%}
</select>
<form action="/" id="start_test">
        <input type="submit" value="Start test" />
 
</form>
<div id="test_info"> </div>
<script>
 
setInterval(
function update_values() {
            $SCRIPT_ROOT = {{ request.script_root|tojson|safe }};
            $.getJSON($SCRIPT_ROOT+"/sys_info.json",
            function(data) {
                var i;
                var text = "";
                for (i = 0; i < data.len; i++) {
                    text += data.variable[i] + "<br>";
                }
                $("#test_info").html(text)
		    });
},1000)
 
</script>
</body>
</html>

Uruchamianie testów

Nie będziemy potrzebowali nowej funkcji do obsługi danych z formularza. Wykorzystamy główną metodę, w której generujemy stronę startową. Poniżej pełen kod pliku app.py

import os
import json
 
from flask import Flask, render_template, request
 
 
class TestLogger:
    def __init__(self):
        self.info_list = self.get_info()
 
    @staticmethod
    def get_info():
        return os.popen('cat logs/pytest.logs').read()
 
    def list_of_lines(self):
        return self.info_list.splitlines()
 
 
class ListTest:
    def __init__(self):
        self.test_list = self.__get_tests()
 
    @staticmethod
    def __get_tests():
        import os
 
 
        path = os.path.abspath(os.getcwd())
 
        files = []
        for _, _, f in os.walk(path):
            for file in f:
                if '.py' in file and '.pyc' not in file and 'test_' in file:
                    files.append(file)
 
        return files
 
    def update_list(self):
        self.test_list = self.__get_tests()
 
 
app = Flask(__name__)
list_of_tests = ListTest()
 
 
@app.route("/", methods=['GET', 'POST'])
 
def hello():
    list_of_tests.update_list()
    if request.args.get("name"):
        os.popen('pytest ' + request.args.get("name") + ' > logs/pytest.logs')
    return render_template('index.html', file_list=list_of_tests.test_list, len=len(list_of_tests.test_list))
 
@app.route('/sys_info.json')
 
def sys_info():
    test_logger = TestLogger()
    list_of_lines = test_logger.list_of_lines()
    return json.dumps({"len": len(test_logger.list_of_lines()), "variable": list_of_lines})
 
 
if __name__ == "__main__":
 
    app.run(host='0.0.0.0', port=5000)

Jak widzimy wystarczy wyedytować tylko trzy linijki, aby obsłużyć puszczanie testów w naszym panelu. W linijce 43 – dekorator odpowiedzialny za nakierowanie na stronę główną dodajemy argument, który pozwoli na obsługę przysyłanych danych np. z formularzy methods=[‚GET’, ‚POST’]. Kolejno w linijkach 46 i 47 – sprawdzam, czy istnieje przysłany argument z nazwą name. Jeżeli tak to uruchamiam wybrany z listy test używając pyTest’a.

Panel informacyjno kontrolny (#6) – Puszczanie testów

Tak przygotowany możesz tworzyć bardziej lub mniej rozbudowane panele dla swojego środowiska testowego. Z mojej perspektywy wyczerpałem temat najbardziej podstawowych funkcjonalności takiego panelu. Nie wykluczam powrotu do serii, gdy wpadnę na jakiś pomysł rozwoju tego temu lub na prośbę czytelników.