fix: edge cases for running interactive goal commands with --tty flag (…

…#589)
algorandfoundation · Oct 29, 2024 · e280a7f · e280a7f · github-actions · Oct 29, 2024
1 parent 1394416
commit e280a7f
Show file tree

Hide file tree

Showing 4 changed files with 56 additions and 12 deletions.
diff --git a/docs/cli/index.md b/docs/cli/index.md
@@ -67,6 +67,7 @@
   - [goal](#goal)
     - [Options](#options-11)
     - [--console](#--console)
+    - [--interactive](#--interactive)
     - [Arguments](#arguments-6)
     - [GOAL_ARGS](#goal_args)
   - [init](#init)
@@ -591,6 +592,10 @@ algokit goal [OPTIONS] [GOAL_ARGS]...
 ### --console
 Open a Bash console so you can execute multiple goal commands and/or interact with a filesystem.
 
+
+### --interactive
+Force running the goal command in interactive mode.
+
 ### Arguments
 
 

diff --git a/docs/features/goal.md b/docs/features/goal.md
@@ -79,16 +79,19 @@ $ ~ algokit goal
 ```
 
 ## Working with Files in the Container
+
 When interacting with the container, especially if you're using tools like goal, you might need to reference files or directories. Here's how to efficiently deal with files and directories:
 
 ### Automatic File Mounting
+
 When you specify a file or directory path in your `goal` command, the system will automatically mount that path from your local filesystem into the container. This way, you don't need to copy files manually each time.
 
 For instance, if you want to compile a `teal` file:
 
 ```
 algokit goal clerk compile /Path/to/inputfile/approval.teal -o /Path/to/outputfile/approval.compiled
 ```
+
 Here, `/Path/to/inputfile/approval.teal` and `/Path/to/outputfile/approval.compiled` are paths on your local file system, and they will be automatically accessible to the `goal` command inside the container.
 
 ### Manual Copying of Files
@@ -98,6 +101,7 @@ In case you want to manually copy files into the container, you can do so using
 ```
 docker cp foo.txt algokit_algod:/root
 ```
+
 This command copies the `foo.txt` from your local system into the root directory of the `algokit_algod` container.
 
 Note: Manual copying is optional and generally only necessary if you have specific reasons for doing so since the system will auto-mount paths specified in commands.
@@ -106,7 +110,7 @@ Note: Manual copying is optional and generally only necessary if you have specif
 
 If you want to run multiple commands or interact with the filesystem you can execute `algokit goal --console`. This will open a [Bash](https://www.gnu.org/software/bash/) shell session on the `algod` Docker container and from there you can execute goal directly, e.g.:
 
-```
+```bash
 $ algokit goal --console
 Opening Bash console on the algod node; execute `exit` to return to original console
 root@82d41336608a:~# goal account list
@@ -115,4 +119,21 @@ root@82d41336608a:~# goal account list
 [online]        4BH5IKMDDHEJEOZ7T5LLT4I7EVIH5XCOTX3TPVQB3HY5TUBVT4MYXJOZVA      4BH5IKMDDHEJEOZ7T5LLT4I7EVIH5XCOTX3TPVQB3HY5TUBVT4MYXJOZVA      2000000000000000 microAlgos
 ```
 
+## Interactive Mode
+
+Some `goal` commands require interactive input from the user. By default, AlgoKit will attempt to run commands in non-interactive mode first, and automatically switch to interactive mode if needed. You can force a command to run in interactive mode by using the `--interactive` flag:
+
+```bash
+$ algokit goal --interactive wallet new algodev
+Please choose a password for wallet 'algodev':
+Please confirm the password:
+Creating wallet...
+Created wallet 'algodev'
+Your new wallet has a backup phrase that can be used for recovery.
+Keeping this backup phrase safe is extremely important.
+Would you like to see it now? (Y/n): n
+```
+
+This is particularly useful when you know a command will require user input, such as creating new accounts, importing keys, or signing transactions.
+
 For more details about the `AlgoKit goal` command, please refer to the [AlgoKit CLI reference documentation](../cli/index.md#goal).
diff --git a/src/algokit/cli/goal.py b/src/algokit/cli/goal.py
@@ -28,8 +28,14 @@
     help="Open a Bash console so you can execute multiple goal commands and/or interact with a filesystem.",
     default=False,
 )
+@click.option(
+    "--interactive",
+    is_flag=True,
+    help="Force running the goal command in interactive mode.",
+    default=False,
+)
 @click.argument("goal_args", nargs=-1, type=click.UNPROCESSED)
-def goal_command(*, console: bool, goal_args: list[str]) -> None:
+def goal_command(*, console: bool, interactive: bool, goal_args: list[str]) -> None:  # noqa: C901, PLR0912
     """
     Run the Algorand goal CLI against the AlgoKit LocalNet.
 
@@ -80,17 +86,28 @@ def goal_command(*, console: bool, goal_args: list[str]) -> None:
         logger.info("Opening Bash console on the algod node; execute `exit` to return to original console")
         result = proc.run_interactive(f"{container_engine} exec -it -w /root algokit_{sandbox.name}_algod bash".split())
     else:
-        cmd = f"{container_engine} exec --interactive --workdir /root algokit_{sandbox.name}_algod goal".split()
+        cmd = f"{container_engine} exec {'--tty' if interactive else ''} --interactive --workdir /root algokit_{sandbox.name}_algod goal".split()  # noqa: E501
         input_files, output_files, goal_args = preprocess_command_args(
             goal_args, volume_mount_path_local, volume_mount_path_docker
         )
         cmd = cmd + goal_args
-        result = proc.run(
-            cmd,
-            stdout_log_level=logging.INFO,
-            prefix_process=False,
-            pass_stdin=True,
-        )
+
+        if interactive:
+            result = proc.run_interactive(cmd)
+        else:
+            # Try non-interactive first, fallback to interactive if it fails with input-related error
+            result = proc.run(
+                cmd,
+                stdout_log_level=logging.INFO,
+                prefix_process=False,
+                pass_stdin=True,
+            )
+            if result.exit_code != 0 and "inappropriate ioctl" in (result.output or ""):
+                # Fallback to interactive mode if we detect TTY-related errors
+                logger.debug("Command failed with TTY error, retrying in interactive mode")
+                cmd.insert(2, "--tty")
+                result = proc.run_interactive(cmd)
+
         post_process(input_files, output_files, volume_mount_path_local)
 
     if result.exit_code != 0:

diff --git a/tests/goal/test_goal.test_goal_help.approved.txt b/tests/goal/test_goal.test_goal_help.approved.txt
@@ -6,6 +6,7 @@ Usage: algokit goal [OPTIONS] [GOAL_ARGS]...
   information.
 
 Options:
-  --console   Open a Bash console so you can execute multiple goal commands
-              and/or interact with a filesystem.
-  -h, --help  Show this message and exit.
+  --console      Open a Bash console so you can execute multiple goal commands
+                 and/or interact with a filesystem.
+  --interactive  Force running the goal command in interactive mode.
+  -h, --help     Show this message and exit.
File	Stmts	Miss	Cover	Missing
src/algokit
__init__.py	15	7	53%	6–13, 17–24, 32–34
__main__.py	4	4	0%	1–7
src/algokit/cli
__init__.py	47	3	94%	31–34
codespace.py	50	9	82%	28, 114, 137, 150–155
completions.py	108	9	92%	63–64, 83, 93–99
dispenser.py	121	1	99%	77
doctor.py	53	3	94%	146–148
explore.py	63	15	76%	35–40, 42–47, 85–92, 113
generate.py	70	3	96%	76–77, 155
goal.py	54	5	91%	85, 96, 107–109
init.py	310	24	92%	491–492, 497–498, 501, 522, 525–527, 538, 542, 600, 626, 655, 688, 697–699, 702–707, 720, 739, 751–752
localnet.py	164	32	80%	67, 88–115, 164–168, 212, 233, 248–258, 271, 322, 343–344
task.py	34	3	91%	25–28
src/algokit/cli/common
utils.py	37	2	95%	137, 139
src/algokit/cli/project
bootstrap.py	32	1	97%	33
deploy.py	117	20	83%	47, 49, 102, 125, 147–149, 270, 277, 291–299, 302–311
link.py	89	16	82%	60, 65–66, 101–105, 115–120, 148–149, 218–219, 223
list.py	33	5	85%	21–23, 51–56
run.py	46	2	96%	38, 174
src/algokit/cli/tasks
analyze.py	81	1	99%	81
assets.py	82	13	84%	65–66, 72, 74–75, 105, 119, 125–126, 132, 134, 136–137
ipfs.py	51	8	84%	52, 80, 92, 94–95, 105–107
mint.py	106	15	86%	51, 73, 100–103, 108, 113, 131–132, 158, 335–339
send_transaction.py	65	10	85%	52–53, 57, 89, 158, 170–174
sign_transaction.py	59	8	86%	21, 28–30, 71–72, 109, 123
transfer.py	39	3	92%	26, 90, 117
utils.py	114	46	60%	29–37, 43–46, 78–79, 103–104, 128–136, 155–165, 212, 261–262, 282–293, 300–302, 324
vanity_address.py	56	10	82%	41, 45–48, 112, 114, 121–123
wallet.py	79	4	95%	21, 66, 136, 162
src/algokit/core
codespace.py	175	68	61%	34–37, 41–44, 48–71, 111–112, 125–133, 191, 200–202, 210, 216–217, 229–236, 251–298, 311–313, 338–344, 348, 395
conf.py	57	9	84%	12, 24, 28, 36, 38, 73–75, 80
dispenser.py	202	26	87%	92, 124–125, 142–150, 192–193, 199–201, 219–220, 260–261, 319, 333–335, 346–347, 357, 370, 385
doctor.py	65	7	89%	67–69, 92–94, 134
generate.py	50	3	94%	44, 85, 103
goal.py	65	4	94%	21, 36–37, 47
init.py	67	10	85%	53, 57–62, 70, 81, 88, 108–109
log_handlers.py	68	7	90%	50–51, 63, 112–116, 125
proc.py	45	1	98%	99
sandbox.py	276	23	92%	32, 89–92, 97, 101–103, 174, 222–229, 240, 611, 627, 652, 660
typed_client_generation.py	170	20	88%	62–64, 103–108, 132, 135–138, 156, 159–162, 229, 232–235
utils.py	150	40	73%	50–51, 57–69, 125–131, 155, 158, 164–177, 206–208, 237–240, 262
src/algokit/core/_vendor/auth0/authentication
token_verifier.py	157	111	29%	16, 45, 58, 73–85, 98–107, 119–124, 136–137, 140, 170, 178–180, 190–199, 206–213, 227–236, 258, 280–287, 314–323, 333–444
src/algokit/core/compilers
python.py	28	5	82%	19–20, 25, 49–50
src/algokit/core/config_commands
container_engine.py	41	21	49%	24, 29–31, 47–76
version_prompt.py	92	14	85%	37–38, 68, 87–90, 108, 118–125, 148
src/algokit/core/project
__init__.py	53	3	94%	50, 86, 145
bootstrap.py	120	8	93%	47, 126–127, 149, 176, 207–209
deploy.py	69	9	87%	108–111, 120–122, 126, 131
run.py	132	13	90%	83, 88, 97–98, 133–134, 138–139, 143, 147, 277–278, 293
src/algokit/core/tasks
analyze.py	93	3	97%	105–112, 187
ipfs.py	63	7	89%	58–64, 140, 144, 146, 152
nfd.py	49	13	73%	25, 31, 34–41, 70–72, 99–101
vanity_address.py	90	34	62%	49–50, 54, 59–75, 92–108, 128–131
wallet.py	71	5	93%	37, 129, 155–157
src/algokit/core/tasks/mint
mint.py	74	9	88%	123–133
models.py	92	17	82%	50, 52, 57, 71–74, 81–90
TOTAL	4945	772	84%