aws-bootstrap-g4dn 0.6.0__py3-none-any.whl → 0.7.0__py3-none-any.whl

aws_bootstrap/tests/test_output.py

@@ -0,0 +1,192 @@
+"""Tests for the output formatting module."""
+
+from __future__ import annotations
+import json
+from datetime import UTC, datetime
+from pathlib import Path
+
+import click
+import yaml
+from click.testing import CliRunner
+
+from aws_bootstrap.output import OutputFormat, echo, emit, is_text
+
+
+def test_output_format_enum_values():
+    assert OutputFormat.TEXT.value == "text"
+    assert OutputFormat.JSON.value == "json"
+    assert OutputFormat.YAML.value == "yaml"
+    assert OutputFormat.TABLE.value == "table"
+
+
+def test_serialize_datetime():
+    """datetime objects should serialize to ISO format strings."""
+    dt = datetime(2025, 6, 15, 12, 30, 0, tzinfo=UTC)
+
+    @click.command()
+    @click.pass_context
+    def cli(ctx):
+        ctx.ensure_object(dict)
+        ctx.obj["output_format"] = OutputFormat.JSON
+        emit({"timestamp": dt}, ctx=ctx)
+
+    runner = CliRunner()
+    result = runner.invoke(cli, [])
+    assert result.exit_code == 0
+    data = json.loads(result.output)
+    assert data["timestamp"] == "2025-06-15T12:30:00+00:00"
+
+
+def test_serialize_path():
+    """Path objects should serialize to strings."""
+    p = Path("/home/user/.ssh/id_ed25519")
+
+    @click.command()
+    @click.pass_context
+    def cli(ctx):
+        ctx.ensure_object(dict)
+        ctx.obj["output_format"] = OutputFormat.JSON
+        emit({"path": p}, ctx=ctx)
+
+    runner = CliRunner()
+    result = runner.invoke(cli, [])
+    assert result.exit_code == 0
+    data = json.loads(result.output)
+    assert data["path"] == "/home/user/.ssh/id_ed25519"
+
+
+def test_emit_json():
+    """emit() should produce valid JSON in JSON mode."""
+
+    @click.command()
+    @click.pass_context
+    def cli(ctx):
+        ctx.ensure_object(dict)
+        ctx.obj["output_format"] = OutputFormat.JSON
+        emit({"key": "value", "count": 42}, ctx=ctx)
+
+    runner = CliRunner()
+    result = runner.invoke(cli, [])
+    assert result.exit_code == 0
+    data = json.loads(result.output)
+    assert data == {"key": "value", "count": 42}
+
+
+def test_emit_yaml():
+    """emit() should produce valid YAML in YAML mode."""
+
+    @click.command()
+    @click.pass_context
+    def cli(ctx):
+        ctx.ensure_object(dict)
+        ctx.obj["output_format"] = OutputFormat.YAML
+        emit({"key": "value", "count": 42}, ctx=ctx)
+
+    runner = CliRunner()
+    result = runner.invoke(cli, [])
+    assert result.exit_code == 0
+    data = yaml.safe_load(result.output)
+    assert data == {"key": "value", "count": 42}
+
+
+def test_emit_table_list():
+    """emit() should render a list of dicts as a table with headers."""
+
+    @click.command()
+    @click.pass_context
+    def cli(ctx):
+        ctx.ensure_object(dict)
+        ctx.obj["output_format"] = OutputFormat.TABLE
+        emit(
+            [{"name": "Alice", "age": 30}, {"name": "Bob", "age": 25}],
+            headers={"name": "Name", "age": "Age"},
+            ctx=ctx,
+        )
+
+    runner = CliRunner()
+    result = runner.invoke(cli, [])
+    assert result.exit_code == 0
+    assert "Name" in result.output
+    assert "Age" in result.output
+    assert "Alice" in result.output
+    assert "Bob" in result.output
+
+
+def test_emit_table_dict():
+    """emit() should render a single dict as key-value pairs."""
+
+    @click.command()
+    @click.pass_context
+    def cli(ctx):
+        ctx.ensure_object(dict)
+        ctx.obj["output_format"] = OutputFormat.TABLE
+        emit({"instance_id": "i-abc123", "state": "running"}, ctx=ctx)
+
+    runner = CliRunner()
+    result = runner.invoke(cli, [])
+    assert result.exit_code == 0
+    assert "instance_id" in result.output
+    assert "i-abc123" in result.output
+    assert "running" in result.output
+
+
+def test_echo_suppressed_in_json_mode():
+    """echo() should produce no output when format is JSON."""
+
+    @click.command()
+    @click.pass_context
+    def cli(ctx):
+        ctx.ensure_object(dict)
+        ctx.obj["output_format"] = OutputFormat.JSON
+        echo("This should not appear")
+
+    runner = CliRunner()
+    result = runner.invoke(cli, [])
+    assert result.exit_code == 0
+    assert result.output == ""
+
+
+def test_echo_emits_in_text_mode():
+    """echo() should work normally in text mode."""
+
+    @click.command()
+    @click.pass_context
+    def cli(ctx):
+        ctx.ensure_object(dict)
+        ctx.obj["output_format"] = OutputFormat.TEXT
+        echo("Hello world")
+
+    runner = CliRunner()
+    result = runner.invoke(cli, [])
+    assert result.exit_code == 0
+    assert "Hello world" in result.output
+
+
+def test_is_text_default():
+    """is_text() should return True when no context is set (default behavior)."""
+
+    @click.command()
+    @click.pass_context
+    def cli(ctx):
+        ctx.ensure_object(dict)
+        ctx.obj["output_format"] = OutputFormat.TEXT
+        assert is_text(ctx) is True
+
+    runner = CliRunner()
+    result = runner.invoke(cli, [])
+    assert result.exit_code == 0
+
+
+def test_is_text_false_for_json():
+    """is_text() should return False when format is JSON."""
+
+    @click.command()
+    @click.pass_context
+    def cli(ctx):
+        ctx.ensure_object(dict)
+        ctx.obj["output_format"] = OutputFormat.JSON
+        assert is_text(ctx) is False
+
+    runner = CliRunner()
+    result = runner.invoke(cli, [])
+    assert result.exit_code == 0

{aws_bootstrap_g4dn-0.6.0.dist-info → aws_bootstrap_g4dn-0.7.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aws-bootstrap-g4dn
-Version: 0.6.0
+Version: 0.7.0
 Summary: Bootstrap AWS EC2 GPU instances for hybrid local-remote development
 Author: Adam Ever-Hadani
 License-Expression: MIT
@@ -15,6 +15,8 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: boto3>=1.35
 Requires-Dist: click>=8.1
+Requires-Dist: pyyaml>=6.0.3
+Requires-Dist: tabulate>=0.9.0
 Dynamic: license-file
 
 # aws-bootstrap-g4dn
@@ -232,6 +234,30 @@ Then install the [Nsight VSCE extension](https://marketplace.visualstudio.com/it
 
 See [Nsight remote profiling guide](docs/nsight-remote-profiling.md) for more details on CUDA debugging and profiling workflows.
 
+### 📤 Structured Output
+
+All commands support `--output` / `-o` for machine-readable output — useful for scripting, piping to `jq`, or LLM tool-use:
+
+```bash
+# JSON output (pipe to jq)
+aws-bootstrap -o json status
+aws-bootstrap -o json status | jq '.instances[0].instance_id'
+
+# YAML output
+aws-bootstrap -o yaml status
+
+# Table output
+aws-bootstrap -o table status
+
+# Works with all commands
+aws-bootstrap -o json list instance-types | jq '.[].instance_type'
+aws-bootstrap -o json launch --dry-run
+aws-bootstrap -o json terminate --yes
+aws-bootstrap -o json cleanup --dry-run
+```
+
+Supported formats: `text` (default, human-readable with color), `json`, `yaml`, `table`. Commands that require confirmation (`terminate`, `cleanup`) require `--yes` in structured output modes.
+
 ### 📋 Listing Resources
 
 ```bash

{aws_bootstrap_g4dn-0.6.0.dist-info → aws_bootstrap_g4dn-0.7.0.dist-info}/RECORD

@@ -1,9 +1,10 @@
 aws_bootstrap/__init__.py,sha256=kl_jvrunGyIyizdRqAP6ROb5P1BBrXX5PTq5gq1ipU0,82
-aws_bootstrap/cli.py,sha256=n3Ep_7zhBiRSU4ZUeGVqTRb81nzo98mxzQSKdAuiopY,27788
+aws_bootstrap/cli.py,sha256=R9w_sTBQwM0JqGTx4-THNe_x7iN-LlX4lE0kD55rytg,36173
 aws_bootstrap/config.py,sha256=p770XgjfuK1-wVkAEeBdtJSVkc58DKFHgaJlZ-zbGmk,967
-aws_bootstrap/ec2.py,sha256=uNqxWWfPfGCbujQ3eonvqjjxLE76fsEyNchPS6byR6c,16719
+aws_bootstrap/ec2.py,sha256=giyfRdrriqvC_jPvGmtbEv2LKkGG3Qa9-uTpD7UFzzs,16735
 aws_bootstrap/gpu.py,sha256=WTnHR0s3mQHDlnzqRgqAC6omWz7nT5YtGpcs0Bf88jk,692
-aws_bootstrap/ssh.py,sha256=xY0Yn5q4aA0Xb3ejNY-KCbooZArXRGpimSnbJiBLI_w,24059
+aws_bootstrap/output.py,sha256=3NKIcRiYbS66ZWllpj7tkB_UlnFMHqtgE9ixY8Vhmrc,3753
+aws_bootstrap/ssh.py,sha256=0R1o3aUXxdYWqJ-uvYZZY8rnZO7mfc30PwjCJs_0Qow,23971
 aws_bootstrap/resources/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 aws_bootstrap/resources/gpu_benchmark.py,sha256=1eFt_3MXvoLhs9HahrRPhbxvtdjFaXG2Ty3GEg7Gud0,29366
 aws_bootstrap/resources/gpu_smoke_test.ipynb,sha256=XvAOEIPa5H9ri5mRZqOdknmwOwKNvCME6DzBGuhRYfg,10698
@@ -13,17 +14,18 @@ aws_bootstrap/resources/requirements.txt,sha256=gpYl1MFCfWXiAhbIUgAjuTHONz3MKci2
 aws_bootstrap/resources/saxpy.cu,sha256=1BSESEwGGCx3KWx9ZJ8jiPHQ42KzQN6i2aP0I28bPsA,1178
 aws_bootstrap/resources/tasks.json,sha256=6U8pB1N8YIWgUCfFet4ne3nYnI92tWv5D5kPiQG3Zlg,1576
 aws_bootstrap/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-aws_bootstrap/tests/test_cli.py,sha256=OOYzopo8gkp6fO1MT10fsqAhIs5pN9cCpJyOzWNXHCg,48638
+aws_bootstrap/tests/test_cli.py,sha256=QHn7OY7QAlbV4Flm4bwB496la3Z5BhX-msBWikeUAUE,59382
 aws_bootstrap/tests/test_config.py,sha256=vspSGoben_i7m4Fh6UGSes6Fkr789Y1eaOLe54fRSGc,1524
 aws_bootstrap/tests/test_ebs.py,sha256=B2HrgSmS7yroz6zzRuPxKIXmQGlWesuGqOtybyZmHJQ,7582
 aws_bootstrap/tests/test_ec2.py,sha256=Jmqsjv973hxXbZWfGgECtm6aa2156Lzji227sYMBuMg,10547
 aws_bootstrap/tests/test_gpu.py,sha256=rbMuda_sIVbaCzkWXoLv9YIfnWztgRoP7NuVL8XHrUY,3871
+aws_bootstrap/tests/test_output.py,sha256=RRSbxtGqi7jfC9i4CR4EZXP56SmdsYUZDpT5uj8DWKQ,5250
 aws_bootstrap/tests/test_ssh_config.py,sha256=qy3UDdvkTfrALiF-W3m8aKvnQj3BeCrZdLjG75tcVJU,17131
 aws_bootstrap/tests/test_ssh_ebs.py,sha256=ipt0xOzdf3kfkVt42Dgr_z7D6JDIMuRi3DqX0OP8sm0,2342
 aws_bootstrap/tests/test_ssh_gpu.py,sha256=dRp86Og-8GqiATSff3rxhu83mBZdGgqI4UOnoC00Ln0,1454
-aws_bootstrap_g4dn-0.6.0.dist-info/licenses/LICENSE,sha256=Hen77Mt8sazSQJ9DgrmZuAvDwo2vc5JAkR_avuFV-CM,1067
-aws_bootstrap_g4dn-0.6.0.dist-info/METADATA,sha256=Ot9yCJfJup1ZzW-0cq99zT9bbswHnRJ4SWxEsJ-pK58,15859
-aws_bootstrap_g4dn-0.6.0.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
-aws_bootstrap_g4dn-0.6.0.dist-info/entry_points.txt,sha256=T8FXfOgmLEvFi8DHaFJ3tCzId9J3_d2Y6qT98OXxCjA,57
-aws_bootstrap_g4dn-0.6.0.dist-info/top_level.txt,sha256=mix9gZRs8JUv0OMSB_rwdGcRnTKzsKgHrE5fyAn5zJw,14
-aws_bootstrap_g4dn-0.6.0.dist-info/RECORD,,
+aws_bootstrap_g4dn-0.7.0.dist-info/licenses/LICENSE,sha256=Hen77Mt8sazSQJ9DgrmZuAvDwo2vc5JAkR_avuFV-CM,1067
+aws_bootstrap_g4dn-0.7.0.dist-info/METADATA,sha256=qTRVXvMZwgcepn6IAhhFzoCk3YCIhkTUzzDCAfDtYJ4,16700
+aws_bootstrap_g4dn-0.7.0.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+aws_bootstrap_g4dn-0.7.0.dist-info/entry_points.txt,sha256=T8FXfOgmLEvFi8DHaFJ3tCzId9J3_d2Y6qT98OXxCjA,57
+aws_bootstrap_g4dn-0.7.0.dist-info/top_level.txt,sha256=mix9gZRs8JUv0OMSB_rwdGcRnTKzsKgHrE5fyAn5zJw,14
+aws_bootstrap_g4dn-0.7.0.dist-info/RECORD,,