repo info end point

Author: weswc

openapi/openapi.yml

@@ -334,6 +334,25 @@ paths:
                 items:
                   $ref: '#/components/schemas/Assignee'
 
+  /repo:
+    get:
+      summary: Get repository information
+      operationId: getRepoInfo
+      tags: [status]
+      description: |
+        Returns information about the current repository including local and remote commits.
+        The remote_commit represents:
+        - When Clean: Same as local_commit (repository is up to date)
+        - When Ahead: The last common ancestor before local commits
+        - When Behind/Diverged: The latest remote commit
+      responses:
+        '200':
+          description: Repository information
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/RepoInfo'
+
   /configuration/checklists:
     get:
       summary: List available checklists
@@ -784,6 +803,38 @@ components:
           type: string
           nullable: true
 
+    RepoInfo:
+      type: object
+      required:
+        - owner
+        - repo
+        - branch
+        - local_commit
+        - remote_commit
+        - git_status
+        - git_status_detail
+      properties:
+        owner:
+          type: string
+          description: Repository owner/organization
+        repo:
+          type: string
+          description: Repository name
+        branch:
+          type: string
+          description: Current branch name
+        local_commit:
+          type: string
+          description: Current local commit hash
+        remote_commit:
+          type: string
+          description: Remote tracking commit hash (base ancestor when ahead, latest remote when behind)
+        git_status:
+          $ref: '#/components/schemas/GitStatusEnum'
+        git_status_detail:
+          type: string
+          description: Human-readable git status description
+
     Checklist:
       type: object
       properties:

src/api/routes/status.rs

@@ -2,7 +2,7 @@
 
 use crate::api::error::ApiError;
 use crate::api::state::AppState;
-use crate::api::types::Assignee;
+use crate::api::types::{Assignee, RepoInfoResponse};
 use crate::{GitProvider, get_repo_users};
 use axum::{Json, extract::State};
 
@@ -22,3 +22,9 @@ pub async fn list_assignees<G: GitProvider + 'static>(
 
     Ok(Json(response))
 }
+
+pub async fn repo_info<G: GitProvider + 'static>(
+    State(state): State<AppState<G>>,
+) -> Result<Json<RepoInfoResponse>, ApiError> {
+    RepoInfoResponse::new(state.git_info()).map(Json)
+}

src/api/server.rs

@@ -50,6 +50,7 @@ pub fn create_router<G: GitProvider + 'static>(state: AppState<G>) -> Router {
         .route("/api/issues/{number}/review", post(comments::review_issue))
         // Supporting Data
         .route("/api/assignees", get(status::list_assignees))
+        .route("/api/repo", get(status::repo_info))
         // Configuration
         .route(
             "/api/configuration/checklists",

src/api/tests/cases/status/get_repo_info_ahead.yaml

@@ -0,0 +1,34 @@
+name: "GET /api/repo - ahead status"
+description: "Repository is ahead, remote_commit is the base commit (last in ahead list)"
+
+fixtures:
+  milestones:
+    - v1.0.json
+
+git_state:
+  commit: "abc1234567890abcdef1234567890abcdef1234"
+  branch: "main"
+  status:
+    type: ahead
+    commits:
+      - "def5678901234567890abcdef1234567890abcdef"
+      - "9012345678901234567890abcdef1234567890ab"
+
+request:
+  method: GET
+  path: "/api/repo"
+
+response:
+  status: 200
+  body:
+    match_type: exact
+    value:
+      owner: "test-owner"
+      repo: "test-repo"
+      branch: "main"
+      local_commit: "abc1234567890abcdef1234567890abcdef1234"
+      remote_commit: "9012345678901234567890abcdef1234567890ab"
+      git_status: "ahead"
+      git_status_detail: "Repository is ahead by 2 commits"
+
+assert_write_calls: []

src/api/tests/cases/status/get_repo_info_behind.yaml

@@ -0,0 +1,34 @@
+name: "GET /api/repo - behind status"
+description: "Repository is behind, remote_commit is the latest remote commit (first in behind list)"
+
+fixtures:
+  milestones:
+    - v1.0.json
+
+git_state:
+  commit: "abc1234567890abcdef1234567890abcdef1234"
+  branch: "main"
+  status:
+    type: behind
+    commits:
+      - "3456789012345678901234567890abcdef123456"
+      - "7890123456789012345678901234567890abcdef"
+
+request:
+  method: GET
+  path: "/api/repo"
+
+response:
+  status: 200
+  body:
+    match_type: exact
+    value:
+      owner: "test-owner"
+      repo: "test-repo"
+      branch: "main"
+      local_commit: "abc1234567890abcdef1234567890abcdef1234"
+      remote_commit: "3456789012345678901234567890abcdef123456"
+      git_status: "behind"
+      git_status_detail: "Repository is behind by 2 commits"
+
+assert_write_calls: []

src/api/tests/cases/status/get_repo_info_clean.yaml

@@ -0,0 +1,31 @@
+name: "GET /api/repo - clean status"
+description: "Repository is up to date, remote_commit equals local_commit"
+
+fixtures:
+  milestones:
+    - v1.0.json
+
+git_state:
+  commit: "abc1234567890abcdef1234567890abcdef1234"
+  branch: "main"
+  status:
+    type: clean
+
+request:
+  method: GET
+  path: "/api/repo"
+
+response:
+  status: 200
+  body:
+    match_type: exact
+    value:
+      owner: "test-owner"
+      repo: "test-repo"
+      branch: "main"
+      local_commit: "abc1234567890abcdef1234567890abcdef1234"
+      remote_commit: "abc1234567890abcdef1234567890abcdef1234"
+      git_status: "clean"
+      git_status_detail: "Repository is up to date!"
+
+assert_write_calls: []

src/api/tests/cases/status/get_repo_info_diverged.yaml

@@ -0,0 +1,37 @@
+name: "GET /api/repo - diverged status"
+description: "Repository is diverged, remote_commit is the latest remote commit (first in behind list)"
+
+fixtures:
+  milestones:
+    - v1.0.json
+
+git_state:
+  commit: "abc1234567890abcdef1234567890abcdef1234"
+  branch: "main"
+  status:
+    type: diverged
+    ahead:
+      - "def5678901234567890abcdef1234567890abcdef"
+      - "9012345678901234567890abcdef1234567890ab"
+    behind:
+      - "4567890123456789012345678901234567890abc"
+      - "8901234567890123456789012345678901234567"
+
+request:
+  method: GET
+  path: "/api/repo"
+
+response:
+  status: 200
+  body:
+    match_type: exact
+    value:
+      owner: "test-owner"
+      repo: "test-repo"
+      branch: "main"
+      local_commit: "abc1234567890abcdef1234567890abcdef1234"
+      remote_commit: "4567890123456789012345678901234567890abc"
+      git_status: "diverged"
+      git_status_detail: "Repository is ahead by 2 and behind by 2 commits"
+
+assert_write_calls: []

src/api/tests/harness/mock_builder.rs

@@ -1,8 +1,11 @@
 use std::path::PathBuf;
+use std::str::FromStr;
 
 use super::loader::LoadedFixtures;
-use super::types::GitState;
+use super::types::{GitState, GitStatusSpec};
 use crate::api::tests::helpers::MockGitInfo;
+use crate::GitStatus;
+use gix::ObjectId;
 
 /// Builds MockGitInfo from test specification
 pub struct MockBuilder;
@@ -46,6 +49,39 @@ impl MockBuilder {
             builder = builder.with_dirty_file(PathBuf::from(file));
         }
 
+        // Set git status
+        if let Some(status_spec) = &git_state.status {
+            builder = builder.with_status(Self::convert_status(status_spec));
+        }
+
         builder.build()
     }
+
+    /// Convert GitStatusSpec to GitStatus
+    fn convert_status(spec: &GitStatusSpec) -> GitStatus {
+        match spec {
+            GitStatusSpec::Clean => GitStatus::Clean,
+            GitStatusSpec::Ahead { commits } => {
+                GitStatus::Ahead(Self::parse_object_ids(commits))
+            }
+            GitStatusSpec::Behind { commits } => {
+                GitStatus::Behind(Self::parse_object_ids(commits))
+            }
+            GitStatusSpec::Diverged { ahead, behind } => GitStatus::Diverged {
+                ahead: Self::parse_object_ids(ahead),
+                behind: Self::parse_object_ids(behind),
+            },
+        }
+    }
+
+    /// Parse commit hash strings into ObjectIds
+    fn parse_object_ids(hashes: &[String]) -> Vec<ObjectId> {
+        hashes
+            .iter()
+            .map(|h| {
+                ObjectId::from_str(h)
+                    .unwrap_or_else(|_| ObjectId::empty_tree(gix::hash::Kind::Sha1))
+            })
+            .collect()
+    }
 }

src/api/tests/harness/types.rs

@@ -68,6 +68,22 @@ pub struct GitState {
     /// Dirty files in working directory
     #[serde(default)]
     pub dirty_files: Vec<String>,
+    /// Git repository status (ahead/behind/diverged/clean)
+    #[serde(default)]
+    pub status: Option<GitStatusSpec>,
+}
+
+/// Git status specification for tests
+#[derive(Debug, Clone, Deserialize, Serialize)]
+#[serde(tag = "type", rename_all = "snake_case")]
+pub enum GitStatusSpec {
+    Clean,
+    Ahead { commits: Vec<String> },
+    Behind { commits: Vec<String> },
+    Diverged {
+        ahead: Vec<String>,
+        behind: Vec<String>,
+    },
 }
 
 impl Default for GitState {
@@ -78,6 +94,7 @@ impl Default for GitState {
             commit: default_commit(),
             branch: default_branch(),
             dirty_files: Vec::new(),
+            status: None,
         }
     }
 }

src/api/tests/helpers.rs

@@ -51,6 +51,7 @@ pub struct MockGitInfo {
 
     // Status
     dirty_files: Arc<Mutex<Vec<PathBuf>>>,
+    git_status: GitStatus,
 
     // Call tracking (for assertions)
     calls: Arc<Mutex<Vec<String>>>,
@@ -80,6 +81,7 @@ pub struct MockGitInfoBuilder {
     milestones: Vec<octocrab::models::Milestone>,
     users: Vec<crate::RepoUser>,
     dirty_files: Vec<PathBuf>,
+    git_status: GitStatus,
 }
 
 impl MockGitInfoBuilder {
@@ -94,6 +96,7 @@ impl MockGitInfoBuilder {
             milestones: Vec::new(),
             users: Vec::new(),
             dirty_files: Vec::new(),
+            git_status: GitStatus::Clean,
         }
     }
 
@@ -142,6 +145,11 @@ impl MockGitInfoBuilder {
         self
     }
 
+    pub fn with_status(mut self, status: GitStatus) -> Self {
+        self.git_status = status;
+        self
+    }
+
     pub fn build(self) -> MockGitInfo {
         MockGitInfo {
             owner: self.owner,
@@ -153,6 +161,7 @@ impl MockGitInfoBuilder {
             milestones: Arc::new(Mutex::new(self.milestones)),
             users: Arc::new(Mutex::new(self.users)),
             dirty_files: Arc::new(Mutex::new(self.dirty_files)),
+            git_status: self.git_status,
             calls: Arc::new(Mutex::new(Vec::new())),
             write_calls: Arc::new(Mutex::new(Vec::new())),
         }
@@ -218,7 +227,7 @@ impl GitHelpers for MockGitInfo {
 
 impl GitStatusOps for MockGitInfo {
     fn status(&self) -> Result<GitStatus, GitStatusError> {
-        Ok(GitStatus::Clean)
+        Ok(self.git_status.clone())
     }
 
     fn dirty(&self) -> Result<Vec<PathBuf>, GitStatusError> {