Output interactive mode env to a file

README.md

@@ -85,14 +85,18 @@ python -m goth start your/output/dir/goth-config.yml
 
 If everything went well you should see the following output:
 ```
-Now run your requestor agent as follows:
+Local goth network ready!
 
-$ PATH=/tmp/...:$PATH YAGNA_APPKEY=3438...7901 YAGNA_API_URL=http://172.19.0.6:6000 GSB_URL=tcp://172.19.0.6:6010 examples/blender/blender.py --subnet goth
+You can now load the requestor configuration variables to your shell:
 
-Press Ctrl+C at any moment to stop the test harness.
+source /tmp/goth_interactive.env
+
+And then run your requestor agent from that same shell.
+
+Press Ctrl+C at any moment to stop the local network.
 ```
 
-This is a special case of `goth`'s usage. Running this command does not execute a test, but rather sets up a local Golem network which can be used for debugging purposes. Therefore, you are presented with the parameters required to connect to the `yagna` requestor running inside of this network.
+This is a special case of `goth`'s usage. Running this command does not execute a test, but rather sets up a local Golem network which can be used for debugging purposes. The parameters required to connect to the requestor `yagna` node running in this network are output to the file `/tmp/goth_interactive.env` and can be `source`d from your shell.
 
 ### Creating and running test cases
 Take a look at the `yagna` integration tests [`README`](https://github.com/golemfactory/yagna/blob/master/goth_tests/README.md) to learn more about writing and launching your own test cases.

goth/interactive.py

@@ -2,7 +2,8 @@
 import asyncio
 import logging
 from pathlib import Path
-from typing import Optional
+import tempfile
+from typing import Dict, Optional
 
 from goth.configuration import Configuration
 from goth.runner import Runner
@@ -11,6 +12,14 @@
 
 logger = logging.getLogger(__name__)
 
+env_file = Path(tempfile.gettempdir()) / "goth_interactive.env"
+
+
+def _write_env_file(env: Dict[str, str]) -> None:
+    with env_file.open("w") as f:
+        for key, val in env.items():
+            f.write(f"export {key}={val}\n")
+
 
 async def start_network(
     configuration: Configuration,
@@ -36,14 +45,16 @@ async def start_network(
         for provider in providers:
             await provider.provider_agent.wait_for_log("Subscribed offer")
 
-        print("\n\033[33;1mNow run your requestor agent as follows:\n")
-        env = {"PATH": "$PATH"}
-        requestor.set_agent_env_vars(env)
-        env_vars = " ".join([f"{key}={val}" for key, val in env.items()])
+        requestor_env = requestor.get_agent_env_vars()
         subnet = providers[0].provider_agent.subnet
-        print(f"$ {env_vars} examples/blender/blender.py --subnet {subnet}")
-
-        print("\nPress Ctrl+C at any moment to stop the test harness.\033[0m\n")
+        requestor_env["YAGNA_SUBNET"] = subnet
+        _write_env_file(requestor_env)
+
+        print("\n\033[33;1mLocal goth network ready!\n")
+        print("You can now load the requestor configuration variables to your shell:\n")
+        print(f"source {str(env_file)}\n")
+        print("And then run your requestor agent from that same shell.\n")
+        print("Press Ctrl+C at any moment to stop the local network.\033[0m\n")
 
         while True:
             await asyncio.sleep(5)

goth/runner/probe/__init__.py

@@ -261,20 +261,24 @@ async def create_app_key(self, key_name: str = "test_key") -> str:
             key = app_key.key
         return key
 
-    def set_agent_env_vars(self, env: Dict[str, str]) -> None:
-        """Add vars needed to talk to the daemon in this probe's container to `env`."""
+    def get_agent_env_vars(self, path_var: str = "$PATH") -> Dict[str, str]:
+        """Get env vars needed to talk to the daemon in this probe's container.
+
+        The returned vars include the `PATH` variable as it needs to include the
+        directory which contains the gftp proxy script.
+        By default, the `PATH` value is: `{gftp_script_dir}:$PATH`, allowing for shell
+        substitution of `$PATH`. This part can be overridden by setting the `path_var`
+        argument.
+        """
 
         if not self.app_key:
             raise AttributeError("Yagna application key is not set yet")
-        path_var = env.get("PATH")
-        env.update(
-            {
-                "YAGNA_APPKEY": self.app_key,
-                "YAGNA_API_URL": YAGNA_REST_URL.substitute(host=self.ip_address),
-                "GSB_URL": YAGNA_BUS_URL.substitute(host=self.ip_address),
-                "PATH": f"{self._gftp_script_dir}:{path_var}",
-            }
-        )
+        return {
+            "YAGNA_APPKEY": self.app_key,
+            "YAGNA_API_URL": YAGNA_REST_URL.substitute(host=self.ip_address),
+            "GSB_URL": YAGNA_BUS_URL.substitute(host=self.ip_address),
+            "PATH": f"{self._gftp_script_dir}:{path_var}",
+        }
 
     @contextlib.asynccontextmanager
     async def run_command_on_host(
@@ -299,7 +303,7 @@ async def run_command_on_host(
         The monitor can be used for asserting properties of the command's output.
         """
         cmd_env = {**env} if env is not None else {}
-        self.set_agent_env_vars(cmd_env)
+        cmd_env.update(self.get_agent_env_vars())
 
         cmd_monitor = PatternMatchingEventMonitor(name="command output")
         cmd_monitor.start()