From cc19d12d60fbc42c2ce6616c01d9777dcec80e55 Mon Sep 17 00:00:00 2001
From: "Salvador E. Tropea" <salvador@inti.gob.ar>
Date: Thu, 4 Feb 2021 10:28:39 -0300
Subject: [PATCH] Added test for KiCad config redirection.

---
 tests/data/config_redirect/kicad_common     | 22 +++++++++++
 tests/test_plot/test_kicad_config_errors.py | 44 ++++++++++-----------
 2 files changed, 44 insertions(+), 22 deletions(-)
 create mode 100644 tests/data/config_redirect/kicad_common

diff --git a/tests/data/config_redirect/kicad_common b/tests/data/config_redirect/kicad_common
new file mode 100644
index 00000000..5e197edd
--- /dev/null
+++ b/tests/data/config_redirect/kicad_common
@@ -0,0 +1,22 @@
+UseIconsInMenus=1
+IconScale=-1
+MousewheelPAN=0
+ZoomNoCenter=0
+AutoPAN=1
+OpenGLAntialiasingMode=2
+CairoAntialiasingMode=0
+ShowEnvVarWarningDialog=1
+AutoSaveInterval=600
+FileHistorySize=9
+CanvasScale=0
+Editor=/usr/bin/setedit
+PdfBrowserName=
+UseSystemBrowser=1
+[EnvironmentVariables]
+# This shouldn't be here, but KiCad 5 doesn't complain:
+KICAD_CONFIG_HOME=/usr/share/kicad/template
+KICAD_SYMBOL_DIR=/usr/share/kicad/library
+KICAD_TEMPLATE_DIR=/usr/share/kicad/template
+KISYS3DMOD=/usr/share/kicad/modules/packages3d/
+KISYSMOD=/usr/share/kicad/modules
+
diff --git a/tests/test_plot/test_kicad_config_errors.py b/tests/test_plot/test_kicad_config_errors.py
index ff0e1c5a..1b85cea1 100644
--- a/tests/test_plot/test_kicad_config_errors.py
+++ b/tests/test_plot/test_kicad_config_errors.py
@@ -50,12 +50,9 @@ def test_kicad_conf_bad_sym_lib_table(test_dir):
 
 def test_kicad_conf_no_instance():
     """ Check we can't create a KiConf instance """
-    cov.load()
-    cov.start()
-    with pytest.raises(AssertionError) as pytest_wrapped_e:
-        o = KiConf()  # noqa: F841
-    cov.stop()
-    cov.save()
+    with context.cover_it(cov):
+        with pytest.raises(AssertionError) as pytest_wrapped_e:
+            o = KiConf()  # noqa: F841
     assert pytest_wrapped_e.type == AssertionError
     assert str(pytest_wrapped_e.value) == 'KiConf is fully static, no instances allowed'
 
@@ -74,18 +71,15 @@ def check_load_conf(caplog, dir='kicad', fail=False, catch_conf_error=False, no_
     kiconf_de_init()
     import pcbnew
     GS.kicad_conf_path = None if no_conf_path else pcbnew.GetKicadConfigPath()
-    cov.load()
-    cov.start()
-    if catch_conf_error:
-        with pytest.raises(KiConfError) as err:
+    with context.cover_it(cov):
+        if catch_conf_error:
+            with pytest.raises(KiConfError) as err:
+                KiConf.init(os.path.join(context.BOARDS_DIR, 'v5_errors/kibom-test.sch'))
+        else:
             KiConf.init(os.path.join(context.BOARDS_DIR, 'v5_errors/kibom-test.sch'))
-    else:
-        KiConf.init(os.path.join(context.BOARDS_DIR, 'v5_errors/kibom-test.sch'))
-        # Check we can call it again and nothing is done
-        KiConf.init('bogus')
-        err = None
-    cov.stop()
-    cov.save()
+            # Check we can call it again and nothing is done
+            KiConf.init('bogus')
+            err = None
     ref = 'Reading KiCad config from `tests/data/'+dir+'/kicad_common`'
     if fail:
         ref = 'Unable to find KiCad configuration file'
@@ -164,11 +158,8 @@ def test_kicad_conf_local_conf(caplog, monkeypatch):
     _real_posix_prefix = sysconfig.get_path('data', 'posix_prefix')
     with monkeypatch.context() as m:
         m.setattr("sysconfig.get_path", mocked_get_path_1)
-        cov.load()
-        cov.start()
-        assert KiConf.guess_symbol_dir() == '/usr/share/kicad/library'
-        cov.stop()
-        cov.save()
+        with context.cover_it(cov):
+            assert KiConf.guess_symbol_dir() == '/usr/share/kicad/library'
 
 
 def test_kicad_conf_no_conf(caplog, monkeypatch):
@@ -177,3 +168,12 @@ def test_kicad_conf_no_conf(caplog, monkeypatch):
         m.setattr("sysconfig.get_path", lambda a, b: '')
         check_load_conf(caplog, fail=True, no_conf_path=True)
     assert 'Unable to find KiCad libraries' in caplog.text, caplog.text
+
+
+def test_config_redirect(caplog, monkeypatch):
+    """ Test bizarre KICAD_CONFIG_HOME inside kicad_common """
+    with monkeypatch.context() as m:
+        m.setenv("KICAD_CONFIG_HOME", 'tests/data/config_redirect')
+        check_load_conf(caplog, dir='config_redirect')
+    assert 'Reading KiCad config from `tests/data/config_redirect/kicad_common`' in caplog.text, caplog.text
+    assert 'Redirecting symbols lib table to /usr/share/kicad/template' in caplog.text, caplog.text