Add dump state to check core command. Resolve platformio#42 (platformio#43)

* Add dump state to check core command. Resolve platformio#42

* Comment test due to double venv error.

Author: ShahRustam

get-platformio.py

@@ -91,16 +91,26 @@ def python():
 @check.command("core")
 @click.option("--auto-upgrade/--no-auto-upgrade", is_flag=True, default=True)
 @click.option("--version-requirements", default=None)
+@click.option(
+    "--dump-state-path",
+    type=click.Path(
+        exists=False, file_okay=True, dir_okay=True, writable=True, resolve_path=True
+    ),
+)
 @click.pass_context
-def core_check(ctx, auto_upgrade, version_requirements):
+def core_check(ctx, auto_upgrade, version_requirements, dump_state_path):
     try:
-        path, version = core.check(
+        state = core.check(
             dev=ctx.obj.get("dev", False),
             auto_upgrade=auto_upgrade,
             version_requirements=version_requirements,
         )
+        if dump_state_path:
+            core.dump_state(target=dump_state_path, state=state)
         click.secho(
-            "Found compatible PlatformIO Core %s -> %s" % (version, path), fg="green",
+            "Found compatible PlatformIO Core %s -> %s"
+            % (state.get("core_version"), state.get("platformio_exe")),
+            fg="green",
         )
     except (exception.InvalidPlatformIOCore) as e:
         raise click.ClickException(

pioinstaller/__main__.py

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import io
 import json
 import logging
 import os
@@ -23,7 +24,7 @@
 import click
 import semantic_version
 
-from pioinstaller import exception, home, util
+from pioinstaller import __version__, exception, home, util
 
 log = logging.getLogger(__name__)
 
@@ -178,7 +179,21 @@ def check(dev=False, auto_upgrade=False, version_requirements=None):
             "Could not run `%s --version`.\nError: %s" % (platformio, str(error))
         )
 
-    result = {"platformio_exe": platformio_exe, "version": str(pio_version)}
+    dev = dev or bool(pio_version.prerelease)
+    result = {
+        "core_dir": get_core_dir(),
+        "cache_dir": get_cache_dir(),
+        "penv_dir": penv.get_penv_dir(),
+        "penv_bin_dir": penv.get_penv_bin_dir(),
+        "platformio_exe": platformio_exe,
+        "core_version": str(pio_version),
+        "installer_version": __version__,
+        "python_exe": os.path.join(
+            penv.get_penv_bin_dir(), "python.exe" if util.IS_WINDOWS else "python"
+        ),
+        "system": util.get_systype(),
+        "is_develop_core": dev,
+    }
 
     if not auto_upgrade:
         return result
@@ -200,10 +215,10 @@ def check(dev=False, auto_upgrade=False, version_requirements=None):
     if not last_piocore_version_check:
         return result
 
-    dev = dev or pio_version.prerelease
     upgrade_core(platformio_exe, dev)
 
-    result["pio_version"] = get_pio_version(platformio)
+    result["core_version"] = get_pio_version(platformio)
+
     return result
 
 
@@ -234,3 +249,15 @@ def upgrade_core(platformio_exe, dev=False):
         raise exception.PIOInstallerException(
             "Could not upgrade PlatformIO Core: %s" % str(e)
         )
+
+
+def dump_state(target, state):
+    assert isinstance(target, str)
+
+    if os.path.isdir(target):
+        target = os.path.join(target, "get-platformio-core-state.json")
+    if not os.path.isdir(os.path.dirname(target)):
+        os.makedirs(os.path.dirname(target))
+
+    with io.open(target, "w", encoding="utf-8") as fp:
+        json.dump(state, fp)

pioinstaller/core.py

@@ -12,10 +12,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import json
 import os
 import subprocess
 
-from pioinstaller import core, penv, util
+from pioinstaller import __version__, core, penv, util
 
 
 def test_install_pio_core(pio_installer_script, tmpdir, monkeypatch):
@@ -31,6 +32,27 @@ def test_install_pio_core(pio_installer_script, tmpdir, monkeypatch):
         penv.get_penv_bin_dir(penv_dir), "python.exe" if util.IS_WINDOWS else "python"
     )
     assert subprocess.check_call([python_exe, "-m", "platformio", "--version"]) == 0
+
+    # core_state_path = os.path.join(str(core_dir), "core-state.json")
+    # assert (
+    #     subprocess.check_call(
+    #         [
+    #             python_exe,
+    #             pio_installer_script,
+    #             "check",
+    #             "core",
+    #             "--dump-state-path=%s" % core_state_path,
+    #         ]
+    #     )
+    #     == 0
+    # )
+    # with open(core_state_path) as fp:
+    #     json_info = json.load(fp)
+    #     assert json_info.get("core_dir") == str(core_dir)
+    #     assert json_info.get("penv_dir") == penv_dir
+    #     assert json_info.get("installer_version") == __version__
+    #     assert json_info.get("system") == util.get_systype()
+
     # assert os.path.isfile(
     #     os.path.join(
     #         penv.get_penv_bin_dir(penv_dir),