Skip to content

feat: Add new edit secret command. #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mikaeld merged 1 commit into from
May 5, 2025
Merged

feat: Add new edit secret command. #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
251 changes: 129 additions & 122 deletions app.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,22 @@
import json
import os
import pathlib
import tempfile
from json import JSONDecodeError

from google.api_core.exceptions import GoogleAPICallError
from google.cloud import secretmanager
from textual import work
from textual.app import App, ComposeResult
from textual.binding import Binding
from textual.containers import Horizontal, Vertical
from textual.markup import escape
from textual.reactive import reactive
from textual.screen import ModalScreen
from textual.widgets import Footer, Header, Input, Pretty, Static, Tree
from textual.widgets import Footer, Header, Input, Tree

from secrets_manager.models.gcp_projects import GCPProject
from secrets_manager.preview import SecretPreview
from secrets_manager.utils.gcp import (
add_secret_version,
get_secret_version_value,
get_secret_versions,
list_secrets,
Expand All @@ -19,26 +25,32 @@
from secrets_manager.utils.helpers import (
format_error_message,
sanitize_project_id_search,
sanitize_secrets,
shasum,
validate_json_content,
)


class SecretsManager(App):
"""Main application class for the Secrets Manager TUI."""

CSS_PATH = "secrets_manager.tcss"
BINDINGS = [
Binding("ctrl+q", "quit", "Quit"),
Binding("p", "secret_preview", "Secret Preview"),
Binding("e", "edit_secret", "Edit Secret"),
]
EDITOR = os.getenv("EDITOR", "vi")

search_query = reactive("")
current_project = reactive(None)
current_project: reactive[GCPProject | None] = reactive(None)

def __init__(self):
def __init__(self) -> None:
"""Initialize the SecretsManager application."""
super().__init__()
self.client = secretmanager.SecretManagerServiceClient()

def compose(self) -> ComposeResult:
"""Create child widgets."""
"""Create and arrange the application widgets."""
yield Header()
yield Input(
placeholder="Search by project ID or display name...",
Expand All @@ -52,53 +64,51 @@ def compose(self) -> ComposeResult:

yield Footer()

def _get_secret_name(self, node_data: dict) -> str:
"""Construct the full secret name from node data."""
base_name = node_data["secret_name"]
version = node_data["version"] if "version" in node_data else "latest"
return f"{base_name}/versions/{version}"

def on_input_changed(self, event: Input.Changed) -> None:
"""Update the search query reactive property."""
"""Handle changes in the search input field."""
if event.input.id == "project-input-search":
sanitized = sanitize_project_id_search(event.input.value)
if sanitized != event.input.value:
event.input.value = sanitized
self.search_query = sanitized

def watch_search_query(self, search_query: str) -> None:
"""React to changes in a search query."""
"""React to changes in the search query."""
self._do_search(search_query)

def watch_current_project(self, project: "GCPProject") -> None:
"""React to changes in a selected project."""
def watch_current_project(self, project: GCPProject | None) -> None:
"""React to changes in the selected project."""
if project is not None:
self._list_secrets()

@work(thread=True)
def _do_search(self, search_term: str) -> None:
"""
Perform project search and update the tree view.
Running in a separate thread to keep UI responsive.
"""
"""Perform project search and update the tree view."""
tree = self.query_one("#projects-tree", Tree)
root = tree.root
root.expand()
root.label = "Projects"

if not search_term:
return

try:
if search_term:
projects = search_gcp_projects(search_term)
tree.reset("Projects")
for project in projects:
leaf_label = f"{project.display_name} ({project.project_id})"
project_node = tree.root.add_leaf(leaf_label)
project_node.data = project
projects = search_gcp_projects(search_term)
tree.reset("Projects")
for project in projects:
leaf_label = f"{project.display_name} ({project.project_id})"
project_node = tree.root.add_leaf(leaf_label)
project_node.data = project
except GoogleAPICallError as e:
self.notify(
f"Failed to search projects: [b]{e.code}[/b]: {format_error_message(str(e.message))}",
severity="error",
)
self._notify_gcp_api_error("search projects", e)
except Exception as e:
self.notify(
f"Failed to search projects: {format_error_message(str(e), 200)}",
severity="error",
markup=False,
)
return None
self._notify_general_error("search projects", e)

def on_tree_node_selected(self, event: Tree.NodeSelected) -> None:
"""Handle project selection in the tree."""
Expand All @@ -112,109 +122,106 @@ def _list_secrets(self) -> None:
tree.clear()
tree.root.label = "Secrets"

if self.current_project:
try:
secrets = list_secrets(gcp_project=self.current_project)

for secret in secrets:
secret_name = secret.name.split("/")[-1]

# Create a node for each secret
secret_node = tree.root.add(secret_name, data={"secret_name": secret.name})

# Add versions as children
secret_versions = get_secret_versions(secret)
for version in secret_versions:
version_number = version.name.split("/")[-1]
secret_node.add_leaf(
f"Version {version_number} - {version.state.name}",
data={
"secret_name": secret.name,
"version": version_number,
"state": version.state.name,
},
)
if not self.current_project:
return

tree.root.expand()

except GoogleAPICallError as e:
self.notify(
f"[b]Failed to load secrets: {e.code} {e.reason}[/b]\n[d]{format_error_message(str(e.message))}[/d]",
severity="error",
)
except Exception as e:
self.notify(
f"Failed to load secrets: {format_error_message(str(e), 200)}",
severity="error",
markup=False,
)
try:
secrets = list_secrets(gcp_project=self.current_project)
for secret in secrets:
secret_name = secret.name.split("/")[-1]
secret_node = tree.root.add(secret_name, data={"secret_name": secret.name})

# Add versions as children
for version in get_secret_versions(secret):
version_number = version.name.split("/")[-1]
secret_node.add_leaf(
f"Version {version_number} - {version.state.name}",
data={
"secret_name": secret.name,
"version": version_number,
"state": version.state.name,
},
)

tree.root.expand()
except GoogleAPICallError as e:
self._notify_gcp_api_error("load secrets", e)
except Exception as e:
self._notify_general_error("load secrets", e)

def action_secret_preview(self):
def action_secret_preview(self) -> None:
"""Show preview of the selected secret."""
tree = self.query_one("#secrets-tree", Tree)
if tree.cursor_node:
data = tree.cursor_node.data
if tree.cursor_node.parent == tree.root:
# Get latest version if the cursor is on a secret node
secret_name = f"{data['secret_name']}/versions/latest"
else:
# Get specific version if the cursor is on a version node
secret_name = f"{data['secret_name']}/versions/{data['version']}"
if tree.cursor_node and tree.cursor_node.data:
secret_name = self._get_secret_name(tree.cursor_node.data)
self.push_screen(SecretPreview(secret_name))

def action_edit_secret(self) -> None:
"""Handle the edit secret action."""
tree = self.query_one("#secrets-tree", Tree)
if tree.cursor_node and tree.cursor_node.data:
secret_name = self._get_secret_name(tree.cursor_node.data)
self._edit_secret(secret_name)

def _notify_gcp_api_error(self, action: str, error: GoogleAPICallError) -> None:
"""Display formatted API error notification."""
self.notify(
f"[b]Failed to {action}: {error.code} {error.reason}[/b]\n"
f"[d]{format_error_message(str(error.message))}[/d]",
severity="error",
)

class SecretPreview(ModalScreen):
def __init__(self, secret_name: str) -> None:
"""Initialize the modal screen with the secret value.
def _notify_general_error(self, action: str, error: Exception) -> None:
"""Display formatted general error notification."""
self.notify(
f"Failed to {action}: {format_error_message(str(error), 200)}",
severity="error",
markup=False,
)

Args:
secret_name: The secret value to display
"""
super().__init__()
self.secret_name = secret_name
def _update_secret(self, secret_name: str, new_content: dict) -> None:
"""Update the secret with new content."""
try:
secret_parent = "/".join(secret_name.split("/")[:-2])
add_secret_version(secret_parent, new_content)
self.notify("Secret updated successfully", severity="information")
except GoogleAPICallError as e:
self._notify_gcp_api_error("update secret", e)
except Exception as e:
self._notify_general_error("update secret", e)

BINDINGS = [
Binding("escape", "dismiss", "Close"),
]
def _edit_secret(self, secret_name: str) -> None:
"""Edit a secret using an external editor."""
with tempfile.NamedTemporaryFile(suffix=".json", mode="w+") as temp_file:
try:
secret_value = get_secret_version_value(secret_name)
except GoogleAPICallError as e:
self._notify_gcp_api_error("load secret", e)
return
except Exception as e:
self._notify_general_error("load secret", e)
return

def compose(self) -> ComposeResult:
"""Compose the modal with a Pretty widget to display the secret."""
with Vertical(classes="preview-container"):
# Extract the actual secret name and version from the full path
parts = self.secret_name.split("/")
secret_name = parts[-3]
version = parts[-1]
json.dump(secret_value, temp_file, indent=2)
temp_file.flush()
original_hash = shasum(pathlib.Path(temp_file.name))

yield Static(
f"Secret: [b]{secret_name}[/b]\nVersion: [b]{version}[/b]", classes="secret-header"
)
yield Pretty({}, id="pretty-preview")
with self.app.suspend():
os.system(f"{self.EDITOR} {temp_file.name}")
Copy link

Copilot AI May 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] Consider quoting the file path in the os.system call to correctly handle paths with spaces. For example, wrap temp_file.name in quotes.

Suggested change
os.system(f"{self.EDITOR} {temp_file.name}")
os.system(f'{self.EDITOR} "{temp_file.name}"')

Copilot uses AI. Check for mistakes.

def on_mount(self) -> None:
self._get_secret(self.secret_name)
try:
new_content = validate_json_content(temp_file)
except JSONDecodeError as e:
self.notify(f"JSON decoding error: {str(e)}", severity="error")
return

def action_dismiss(self) -> None:
"""Handle the dismiss action to close the modal."""
self.app.pop_screen()
new_hash = shasum(pathlib.Path(temp_file.name))
if new_hash == original_hash:
self.notify("No changes detected", severity="information")
return

@work(thread=True)
def _get_secret(self, secret_name) -> None:
try:
secret_value = get_secret_version_value(secret_name)
secret_to_preview = sanitize_secrets(secret_value)
self.query_one(Pretty).update(secret_to_preview)
except GoogleAPICallError as e:
self.notify(
f"[b]Failed to preview secret: {e.code} {e.reason}[/b]\n[d]{escape(format_error_message(str(e.message)))}[/d]",
severity="error",
)
self.action_dismiss()
except Exception as e:
self.notify(
f"Failed to preview secret: {format_error_message(str(e), 200)}",
severity="error",
markup=False,
)
self.action_dismiss()
self._update_secret(secret_name, new_content)
self._list_secrets()


if __name__ == "__main__":
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ dev = [
"pytest>=8.3.5",
"pytest-cov>=6.1.1",
"ruff>=0.11.7",
"textual-dev>=1.7.0",
]

[tool.pytest]
Expand Down
Loading