summaryrefslogtreecommitdiff
path: root/tests/test-gptel-tools-git-diff.el
diff options
context:
space:
mode:
authorCraig Jennings <c@cjennings.net>2026-05-16 04:26:20 -0500
committerCraig Jennings <c@cjennings.net>2026-05-16 04:26:20 -0500
commitceeae9b5e2625e23e6e3792d06a6c8122a36d18b (patch)
tree236a650ab1f044a2cac9556f9a8d312bd85adb1d /tests/test-gptel-tools-git-diff.el
parentcce6e8265db0eea8af192b3737b50b81c39a9c0b (diff)
downloaddotemacs-ceeae9b5e2625e23e6e3792d06a6c8122a36d18b.tar.gz
dotemacs-ceeae9b5e2625e23e6e3792d06a6c8122a36d18b.zip
feat(gptel-tools): wire git_status / git_log / git_diff as local tools
Three read-only git context tools so gptel can see what's changed without me pasting `git status` / `git log` / `git diff` output into every chat turn. Builds the first batch from the ADOPT bucket in `docs/design/gptel-tools-shortlist.org`. Shape per tool: - `gptel-tools/git_status.el` — `git status --short --branch` for a directory inside a git working tree under HOME. Returns the porcelain output, or a "Clean working tree" marker when only the branch line is present. - `gptel-tools/git_log.el` — `git log --oneline -nN` with an optional `--since` filter. N defaults to 20, capped at 100; nil / non- integer / out-of-range N falls back to the default. - `gptel-tools/git_diff.el` — `git diff [REF1 [REF2]] [-- FILE]`. Output capped at ~500KB so a runaway diff can't blow up context; truncation is reported inline. Validation is uniform: path must resolve under HOME, must be a directory, must be inside a git working tree (verified via `git rev-parse --is-inside-work-tree`). Color is disabled via `-c color.ui=false` at the git level (`git status` doesn't accept `--no-color` directly). Tests run against real temp git repos created via `process-file`, not mocked — there's nothing in gptel-tools/git_*.el that's process-mockable in a meaningful way, and a real `git init` + a couple of commits is cheaper than building a fake. 31 tests total: 7 for git_status, 11 for git_log, 13 for git_diff. Wired into `cj/gptel-local-tool-features` so gptel exposes the three tools on next restart.
Diffstat (limited to 'tests/test-gptel-tools-git-diff.el')
-rw-r--r--tests/test-gptel-tools-git-diff.el137
1 files changed, 137 insertions, 0 deletions
diff --git a/tests/test-gptel-tools-git-diff.el b/tests/test-gptel-tools-git-diff.el
new file mode 100644
index 00000000..59666a32
--- /dev/null
+++ b/tests/test-gptel-tools-git-diff.el
@@ -0,0 +1,137 @@
+;;; test-gptel-tools-git-diff.el --- Tests for git_diff gptel tool -*- lexical-binding: t; -*-
+
+;;; Commentary:
+;; Tests run against real temp git repos under HOME via `process-file'.
+
+;;; Code:
+
+(require 'ert)
+(require 'cl-lib)
+
+(eval-and-compile
+ (add-to-list 'load-path (expand-file-name "tests" user-emacs-directory))
+ (add-to-list 'load-path (expand-file-name "gptel-tools" user-emacs-directory))
+ (setq load-prefer-newer t)
+ (unless (featurep 'gptel)
+ (defvar gptel-tools nil)
+ (defun gptel-make-tool (&rest _args) nil)
+ (defun gptel-get-tool (&rest _args) nil)
+ (provide 'gptel)))
+
+(require 'git_diff)
+
+;; ---------- helpers
+
+(defun test-gptel-tools-git-diff--with-repo (fn)
+ "Create a temp git repo under HOME with one committed file, call FN."
+ (let* ((name (format ".test-gptel-tools-git-diff-%s"
+ (format-time-string "%s%N")))
+ (dir (expand-file-name name "~")))
+ (unwind-protect
+ (progn
+ (make-directory dir)
+ (let ((default-directory dir))
+ (call-process "git" nil nil nil "init" "--quiet")
+ (call-process "git" nil nil nil "config" "user.email" "test@x")
+ (call-process "git" nil nil nil "config" "user.name" "Test")
+ (with-temp-file (expand-file-name "f.txt" dir)
+ (insert "original\n"))
+ (call-process "git" nil nil nil "add" "f.txt")
+ (call-process "git" nil nil nil "commit" "--quiet" "-m" "initial"))
+ (funcall fn dir))
+ (when (file-exists-p dir) (delete-directory dir t)))))
+
+;; ---------- build-args
+
+(ert-deftest test-gptel-tools-git-diff-build-args-no-refs ()
+ "Normal: no refs / no file → bare diff args."
+ (should (equal (cj/gptel-git-diff--build-args nil nil nil)
+ '("-c" "color.ui=false" "diff"))))
+
+(ert-deftest test-gptel-tools-git-diff-build-args-with-ref1 ()
+ "Normal: REF1 appended."
+ (should (equal (cj/gptel-git-diff--build-args "HEAD~1" nil nil)
+ '("-c" "color.ui=false" "diff" "HEAD~1"))))
+
+(ert-deftest test-gptel-tools-git-diff-build-args-with-both-refs ()
+ "Normal: REF1 and REF2 both appended."
+ (should (equal (cj/gptel-git-diff--build-args "HEAD~1" "HEAD" nil)
+ '("-c" "color.ui=false" "diff" "HEAD~1" "HEAD"))))
+
+(ert-deftest test-gptel-tools-git-diff-build-args-with-file ()
+ "Normal: FILE appended after `--'."
+ (should (equal (cj/gptel-git-diff--build-args nil nil "foo.txt")
+ '("-c" "color.ui=false" "diff" "--" "foo.txt"))))
+
+(ert-deftest test-gptel-tools-git-diff-build-args-boundary-empty-strings ()
+ "Boundary: empty-string REF/FILE values are ignored."
+ (should (equal (cj/gptel-git-diff--build-args "" "" "")
+ '("-c" "color.ui=false" "diff"))))
+
+;; ---------- truncate
+
+(ert-deftest test-gptel-tools-git-diff-truncate-under-cap ()
+ "Normal: short input returns unchanged."
+ (should (equal (cj/gptel-git-diff--truncate "small diff") "small diff")))
+
+(ert-deftest test-gptel-tools-git-diff-truncate-over-cap ()
+ "Boundary: output exceeding the cap is truncated with a marker."
+ (let* ((cap cj/gptel-git-diff--max-output-bytes)
+ (huge (make-string (+ cap 1000) ?x))
+ (out (cj/gptel-git-diff--truncate huge)))
+ (should (string-match-p "\\[truncated:" out))
+ (should (> (length huge) (length out)))))
+
+;; ---------- validate-path
+
+(ert-deftest test-gptel-tools-git-diff-validate-path-normal ()
+ "Normal: validator accepts a git working tree."
+ (test-gptel-tools-git-diff--with-repo
+ (lambda (dir)
+ (should (equal (cj/gptel-git-diff--validate-path dir) dir)))))
+
+(ert-deftest test-gptel-tools-git-diff-validate-path-error-outside-home ()
+ "Error: path outside HOME signals."
+ (should-error (cj/gptel-git-diff--validate-path "/etc")))
+
+(ert-deftest test-gptel-tools-git-diff-validate-path-error-not-a-repo ()
+ "Error: non-git directory signals."
+ (let ((dir (make-temp-file
+ (expand-file-name ".test-gptel-tools-git-diff-" "~") t)))
+ (unwind-protect
+ (should-error (cj/gptel-git-diff--validate-path dir))
+ (when (file-exists-p dir) (delete-directory dir t)))))
+
+;; ---------- run
+
+(ert-deftest test-gptel-tools-git-diff-run-no-changes ()
+ "Boundary: a clean tree with no refs returns the no-diff marker."
+ (test-gptel-tools-git-diff--with-repo
+ (lambda (dir)
+ (let ((out (cj/gptel-git-diff--run dir)))
+ (should (string-match-p "No diff" out))))))
+
+(ert-deftest test-gptel-tools-git-diff-run-unstaged-change ()
+ "Normal: an unstaged edit appears as a real diff."
+ (test-gptel-tools-git-diff--with-repo
+ (lambda (dir)
+ (with-temp-file (expand-file-name "f.txt" dir)
+ (insert "changed\n"))
+ (let ((out (cj/gptel-git-diff--run dir)))
+ (should (string-match-p "^-original" out))
+ (should (string-match-p "^\\+changed" out))))))
+
+(ert-deftest test-gptel-tools-git-diff-run-narrow-to-file ()
+ "Normal: FILE argument narrows the diff."
+ (test-gptel-tools-git-diff--with-repo
+ (lambda (dir)
+ (with-temp-file (expand-file-name "f.txt" dir)
+ (insert "changed\n"))
+ (with-temp-file (expand-file-name "g.txt" dir)
+ (insert "second file\n"))
+ (let ((out (cj/gptel-git-diff--run dir nil nil "f.txt")))
+ (should (string-match-p "f.txt" out))
+ (should-not (string-match-p "g.txt" out))))))
+
+(provide 'test-gptel-tools-git-diff)
+;;; test-gptel-tools-git-diff.el ends here