test(ui): add UI snapshot tests for the TUI components

Author: JayanAXHF

Cargo.lock

@@ -75,6 +75,7 @@ vergen-gix = { version = "9.1.0", features = ["build", "cargo"] }
 [dev-dependencies]
 criterion = { version = "0.5.1", features = ["html_reports"] }
 fake = "4.4.0"
+insta = "1.40"
 
 [[bench]]
 name = "ui_hotspots"

Cargo.toml

@@ -99,7 +99,7 @@ pub struct PrSummary {
 }
 
 pub struct IssuePreview {
-    current: Option<IssuePreviewSeed>,
+    pub current: Option<IssuePreviewSeed>,
     action_tx: Option<tokio::sync::mpsc::Sender<Action>>,
     area: Rect,
 }

src/ui/components/issue_detail.rs

@@ -1262,3 +1262,4 @@ impl HasFocus for LabelList {
         self.state.focus()
     }
 }
+

src/ui/components/label_list.rs

@@ -41,8 +41,8 @@ pub const HELP: &[HelpElementKind] = &[
 ];
 
 pub struct TextSearch {
-    search_state: rat_widget::text_input::TextInputState,
-    label_state: rat_widget::text_input::TextInputState,
+    pub search_state: rat_widget::text_input::TextInputState,
+    pub label_state: rat_widget::text_input::TextInputState,
     cstate: ChoiceState,
     state: State,
     action_tx: Option<tokio::sync::mpsc::Sender<Action>>,

src/ui/components/search_bar.rs

@@ -5,9 +5,9 @@ use ratatui::widgets::Widget;
 use ratatui_macros::{line, span};
 use std::sync::atomic::Ordering;
 
-use crate::ui::components::DumbComponent;
 use crate::ui::components::issue_list::LOADED_ISSUE_COUNT;
-use crate::ui::{AppState, layout::Layout};
+use crate::ui::components::DumbComponent;
+use crate::ui::{layout::Layout, AppState};
 
 pub struct StatusBar {
     repo_label: String,

src/ui/components/status_bar.rs

@@ -10,15 +10,29 @@ use fake::{
 };
 use octocrab::models::{Event as IssueEvent, IssueState};
 
-use crate::{
-    bench_support::{issue_body_fixture, markdown_fixture},
-    ui::{
-        components::{
-            issue_conversation::{CommentView, IssueConversationSeed, TimelineEventView},
-            issue_detail::IssuePreviewSeed,
-        },
-        issue_data::{AuthorId, IssueId, UiIssue, UiIssuePool},
+#[cfg(feature = "benches")]
+use crate::bench_support::{issue_body_fixture, markdown_fixture};
+
+#[cfg(not(feature = "benches"))]
+mod bench_support {
+    pub fn issue_body_fixture(_seed: u64) -> String {
+        String::new()
+    }
+    pub fn markdown_fixture(_seed: u64) -> String {
+        String::new()
+    }
+}
+
+#[allow(unused_imports)]
+#[cfg(not(feature = "benches"))]
+use bench_support::{issue_body_fixture, markdown_fixture};
+
+use crate::ui::{
+    components::{
+        issue_conversation::{CommentView, IssueConversationSeed, TimelineEventView},
+        issue_detail::IssuePreviewSeed,
     },
+    issue_data::{AuthorId, IssueId, UiIssue, UiIssuePool},
 };
 
 #[derive(Debug, Clone, Copy)]

src/ui/testing.rs

@@ -0,0 +1,60 @@
+mod support;
+use crate::support::buffer_to_string;
+use gitv_tui::ui::components::help::{HelpComponent, HelpElementKind};
+use insta::assert_snapshot;
+use ratatui::buffer::Buffer;
+use ratatui::layout::Rect;
+use ratatui::widgets::{Block, Widget};
+
+fn render_help_component(elements: &[HelpElementKind], width: u16, height: u16) -> String {
+    let area = Rect::new(0, 0, width, height);
+    let mut buf = Buffer::empty(area);
+    let component = HelpComponent::new(elements).set_constraint(50).block(
+        Block::bordered()
+            .title("Help")
+            .padding(ratatui::widgets::Padding::horizontal(2))
+            .border_type(ratatui::widgets::BorderType::Rounded),
+    );
+    component.render(area, &mut buf);
+    buffer_to_string(&buf)
+}
+
+#[test]
+fn help_elements_keybinds_only() {
+    let elements = &[
+        HelpElementKind::Keybind("Up", "navigate up"),
+        HelpElementKind::Keybind("Down", "navigate down"),
+        HelpElementKind::Keybind("Enter", "select item"),
+    ];
+    let result = render_help_component(elements, 60, 20);
+    assert_snapshot!(result);
+}
+
+#[test]
+fn help_elements_text_wrapping() {
+    let elements = &[HelpElementKind::Text(
+        "This is a very long description that should wrap properly across multiple lines when rendered in the help component.",
+    )];
+    let result = render_help_component(elements, 50, 15);
+    assert_snapshot!(result);
+}
+
+#[test]
+fn help_elements_mixed_content() {
+    let elements = &[
+        HelpElementKind::Text("Global Help"),
+        HelpElementKind::Keybind("q", "quit application"),
+        HelpElementKind::Text(""),
+        HelpElementKind::Keybind("?", "toggle this help"),
+        HelpElementKind::Keybind("Esc", "close dialog"),
+    ];
+    let result = render_help_component(elements, 55, 20);
+    assert_snapshot!(result);
+}
+
+#[test]
+fn help_component_empty() {
+    let elements: &[HelpElementKind] = &[];
+    let result = render_help_component(elements, 40, 10);
+    assert_snapshot!(result);
+}

tests/help.rs

@@ -0,0 +1,115 @@
+use std::sync::Arc;
+
+mod support;
+
+use crate::support::buffer_to_string;
+use gitv_tui::ui::AppState;
+use gitv_tui::ui::components::issue_detail::{IssuePreview, IssuePreviewSeed};
+use gitv_tui::ui::layout::Layout;
+use insta::assert_snapshot;
+use octocrab::models::IssueState;
+use ratatui::buffer::Buffer;
+use ratatui::layout::Rect;
+
+fn render_issue_preview(seed: Option<IssuePreviewSeed>) -> String {
+    let area = Rect::new(0, 0, 40, 20);
+    let layout = Layout::new(area);
+    let mut buf = Buffer::empty(area);
+
+    let mut preview = IssuePreview::new(AppState::new(
+        "owner".to_string(),
+        "repo".to_string(),
+        "user".to_string(),
+    ));
+
+    if let Some(s) = seed {
+        preview.current = Some(s);
+    }
+
+    preview.render(layout, &mut buf);
+    buffer_to_string(&buf)
+}
+
+#[test]
+fn issue_preview_open_issue() {
+    let seed = IssuePreviewSeed {
+        number: 42,
+        state: IssueState::Open,
+        author: Arc::from("johndoe"),
+        created_at: Arc::from("2024-01-15 10:30"),
+        updated_at: Arc::from("2024-01-16 14:45"),
+        comments: 5,
+        assignees: vec![Arc::from("alice"), Arc::from("bob")],
+        milestone: Some(Arc::from("v1.0")),
+        is_pull_request: false,
+        pull_request_url: None,
+    };
+    let result = render_issue_preview(Some(seed));
+    assert_snapshot!(result);
+}
+
+#[test]
+fn issue_preview_closed_issue() {
+    let seed = IssuePreviewSeed {
+        number: 123,
+        state: IssueState::Closed,
+        author: Arc::from("janedoe"),
+        created_at: Arc::from("2023-12-01 09:00"),
+        updated_at: Arc::from("2023-12-05 16:30"),
+        comments: 12,
+        assignees: vec![Arc::from("charlie")],
+        milestone: None,
+        is_pull_request: false,
+        pull_request_url: None,
+    };
+    let result = render_issue_preview(Some(seed));
+    assert_snapshot!(result);
+}
+
+#[test]
+fn issue_preview_pull_request() {
+    let seed = IssuePreviewSeed {
+        number: 456,
+        state: IssueState::Open,
+        author: Arc::from("devuser"),
+        created_at: Arc::from("2024-02-01 11:00"),
+        updated_at: Arc::from("2024-02-02 09:15"),
+        comments: 8,
+        assignees: vec![Arc::from("reviewer1"), Arc::from("reviewer2")],
+        milestone: Some(Arc::from("Sprint 5")),
+        is_pull_request: true,
+        pull_request_url: Some(Arc::from("https://github.com/owner/repo/pull/456")),
+    };
+    let result = render_issue_preview(Some(seed));
+    assert_snapshot!(result);
+}
+
+#[test]
+fn issue_preview_no_selection() {
+    let result = render_issue_preview(None);
+    assert_snapshot!(result);
+}
+
+#[test]
+fn issue_preview_many_assignees() {
+    let seed = IssuePreviewSeed {
+        number: 789,
+        state: IssueState::Open,
+        author: Arc::from("teamlead"),
+        created_at: Arc::from("2024-03-01 08:00"),
+        updated_at: Arc::from("2024-03-02 10:00"),
+        comments: 3,
+        assignees: vec![
+            Arc::from("dev1"),
+            Arc::from("dev2"),
+            Arc::from("dev3"),
+            Arc::from("dev4"),
+            Arc::from("dev5"),
+        ],
+        milestone: Some(Arc::from("v2.0")),
+        is_pull_request: false,
+        pull_request_url: None,
+    };
+    let result = render_issue_preview(Some(seed));
+    assert_snapshot!(result);
+}

tests/issue_preview.rs

@@ -0,0 +1,11 @@
+---
+source: tests/help.rs
+expression: result
+---
+                                        
+                                        
+                                        
+                                        
+                                        
+          ╭Help──────────────╮          
+          ╰──────────────────╯