Updated pyinvoke to use async feature to test the daemon

Author: Roberto Sora

test/conftest.py

@@ -15,8 +15,9 @@
 import os
 
 import pytest
-from invoke.context import Context
 import simplejson as json
+from invoke import Local
+from invoke.context import Context
 
 from .common import Board
 
@@ -57,7 +58,7 @@ def run_command(pytestconfig, data_dir, downloads_dir, working_dir):
     will work in the same temporary folder.
 
     Useful reference:
-        http://docs.pyinvoke.org/en/1.2/api/runners.html#invoke.runners.Result
+        http://docs.pyinvoke.org/en/1.4/api/runners.html#invoke.runners.Result
     """
     cli_path = os.path.join(str(pytestconfig.rootdir), "..", "arduino-cli")
     env = {
@@ -67,7 +68,7 @@ def run_command(pytestconfig, data_dir, downloads_dir, working_dir):
     }
     os.makedirs(os.path.join(data_dir, "packages"))
 
-    def _run(cmd_string):
+    def _run(cmd_string, asynchronous=False):
         cli_full_line = "{} {}".format(cli_path, cmd_string)
         run_context = Context()
         with run_context.cd(working_dir):
@@ -78,6 +79,35 @@ def _run(cmd_string):
     return _run
 
 
+@pytest.fixture(scope="function")
+def daemon_runner(pytestconfig, data_dir, downloads_dir, working_dir):
+    """
+    Provide an invoke's `Local` object that has started the arduino-cli in daemon mode.
+    This way is simple to start and kill the daemon when the test is finished
+    via the kill() function
+
+    Useful reference:
+        http://docs.pyinvoke.org/en/1.4/api/runners.html#invoke.runners.Local
+        http://docs.pyinvoke.org/en/1.4/api/runners.html
+    """
+    cli_full_line = os.path.join(str(pytestconfig.rootdir), "..", "arduino-cli daemon")
+    env = {
+        "ARDUINO_DATA_DIR": data_dir,
+        "ARDUINO_DOWNLOADS_DIR": downloads_dir,
+        "ARDUINO_SKETCHBOOK_DIR": data_dir,
+    }
+    os.makedirs(os.path.join(data_dir, "packages"))
+    run_context = Context()
+    run_context.cd(working_dir)
+    # Local Class is the implementation of a Runner abstract class
+    runner = Local(run_context)
+    runner.run(
+        cli_full_line, echo=False, hide=True, warn=True, env=env, asynchronous=True
+    )
+
+    return runner
+
+
 @pytest.fixture(scope="function")
 def detected_boards(run_command):
     """

test/requirements.in

@@ -6,5 +6,4 @@ pyyaml==5.3
 prometheus-client==0.7.1
 requests==2.22.0
 pytest-timeout==1.3.4
-# temporary, replaces invoke==1.3.0 in favour of https://github.com/pyinvoke/invoke/pull/661
-git+https://github.com/flazzarini/invoke.git
+invoke==1.4.1

test/requirements.txt

@@ -9,7 +9,7 @@ certifi==2019.11.28       # via requests
 chardet==3.0.4            # via requests
 idna==2.8                 # via requests
 importlib-metadata==1.5.0  # via pluggy, pytest
-git+https://github.com/flazzarini/invoke.git
+invoke==1.4.1
 more-itertools==7.1.0     # via pytest
 packaging==19.0           # via pytest
 pluggy==0.13.1            # via pytest

test/test_daemon.py

@@ -14,27 +14,18 @@
 # a commercial license, send an email to license@arduino.cc.
 
 import os
-import subprocess
 import time
+
 import pytest
 import requests
 import yaml
 from prometheus_client.parser import text_string_to_metric_families
 
-@pytest.mark.timeout(30)
-def test_telemetry_prometheus_endpoint(pytestconfig, data_dir, downloads_dir):
-
-    # Use raw subprocess here due to a missing functionality in pinned pyinvoke ver,
-    # in order to launch and detach the cli process in daemon mode
-    cli_path = os.path.join(str(pytestconfig.rootdir), "..", "arduino-cli")
-    env = os.environ.copy()
-    env["ARDUINO_DATA_DIR"] = data_dir
-    env["ARDUINO_DOWNLOADS_DIR"] = downloads_dir
-    env["ARDUINO_SKETCHBOOK_DIR"] = data_dir
-    daemon = subprocess.Popen([cli_path, "daemon"], env=env)
 
-
-    # wait for and then parse repertory file
+@pytest.mark.timeout(100)
+def test_telemetry_prometheus_endpoint(daemon_runner, data_dir):
+    # Wait for the repertory file to be created and then parse it
+    # in order to check the generated ids
     repertory_file = os.path.join(data_dir, "repertory.yaml")
     while not os.path.exists(repertory_file):
         time.sleep(1)
@@ -47,5 +38,6 @@ def test_telemetry_prometheus_endpoint(pytestconfig, data_dir, downloads_dir):
         family = next(text_string_to_metric_families(metrics))
         sample = family.samples[0]
         assert repertory["installation"]["id"] == sample.labels["installationID"]
-    #add a fixture here!
-    daemon.kill()
+
+    # Kill the runner's process as we finished our test
+    daemon_runner.kill()