Files
gitea-axi/test/pr-view.test.ts
alexion 237c10e38b
All checks were successful
CI / test (pull_request) Successful in 53s
feat: surface inline-comment anchor fields on pr view --reviews (task 0034)
Each inline review comment under `pr view <n> --reviews` now renders its
`id` (the handle a reply targets), `resolved` (`yes`/`no`, from whether
Gitea populated the comment's `resolver`), and `diff_hunk`. The hunk is
structurally trimmed to its `@@` header line plus its last two lines by
default (hunks of three lines or fewer are left whole) and emitted
verbatim under `--full`, so the trim never touches the char-based body
truncation path. The raw `position`/`original_position` diff offsets stay
unsurfaced. The fields ride the existing reviews-plus-per-review-comments
fetch — no extra API calls.
2026-07-18 15:46:30 -04:00

588 lines
17 KiB
TypeScript

import { afterEach, describe, expect, it } from "vitest";
import { startFixtureServer, type FixtureServer } from "./fixture-server.js";
import { runCliTest, testModeEnv } from "./harness.js";
const PULL_PATH = "/api/v1/repos/testowner/testrepo/pulls/5";
const REVIEWS_PATH = "/api/v1/repos/testowner/testrepo/pulls/5/reviews";
const STATUS_PATH = "/api/v1/repos/testowner/testrepo/commits/abc123/status";
let server: FixtureServer;
afterEach(async () => {
await server.close();
});
describe("pr view", () => {
it("renders the default fields from the PR, its reviews, and the head commit status", async () => {
server = await startFixtureServer([
{
method: "GET",
path: PULL_PATH,
body: {
number: 5,
title: "Add feature",
state: "open",
user: { login: "alexion" },
draft: false,
merged: false,
comments: 2,
body: "Some body text.",
head: { sha: "abc123", ref: "feature" },
},
},
{
method: "GET",
path: REVIEWS_PATH,
body: [
{
id: 1,
state: "APPROVED",
official: false,
stale: false,
dismissed: false,
user: { login: "reviewer" },
},
],
},
{
method: "GET",
path: STATUS_PATH,
body: {
sha: "abc123",
total_count: 1,
statuses: [{ context: "build", status: "success" }],
},
},
]);
const { stdout, exitCode } = await runCliTest(["pr", "view", "5"], {
env: testModeEnv(server.url),
});
expect(exitCode).toBe(0);
expect(stdout).toContain("pull_request:");
expect(stdout).toContain("number: 5");
expect(stdout).toContain("title: Add feature");
expect(stdout).toContain("state: open");
expect(stdout).toContain("author: alexion");
expect(stdout).toContain("draft: no");
expect(stdout).toContain("merged: no");
expect(stdout).toContain('checks: "1 passed, 0 failed, 1 total"');
expect(stdout).toContain("body: Some body text.");
expect(stdout).toContain("comment_count: 2 — use --comments to see full comments");
expect(stdout).toContain("review_count: 1 — use --reviews to see full reviews");
expect(stdout).toMatch(/^help\[\d+\]:/m);
});
it("renders every comment with --comments, dropping comment_count and truncating at 800 chars", async () => {
const longComment = "f".repeat(1000);
server = await startFixtureServer([
{
method: "GET",
path: PULL_PATH,
body: {
number: 5,
title: "Add feature",
state: "open",
user: { login: "alexion" },
draft: false,
merged: false,
comments: 2,
body: "Body.",
head: { sha: "abc123", ref: "feature" },
},
},
{ method: "GET", path: REVIEWS_PATH, body: [] },
{
method: "GET",
path: STATUS_PATH,
body: {
sha: "abc123",
total_count: 1,
statuses: [{ context: "build", status: "success" }],
},
},
{
method: "GET",
path: "/api/v1/repos/testowner/testrepo/issues/5/comments",
body: [
{ user: { login: "bob" }, created_at: "2026-07-02T00:00:00Z", body: "short reply" },
{ user: { login: "sue" }, created_at: "2026-07-03T00:00:00Z", body: longComment },
],
},
]);
const { stdout, exitCode } = await runCliTest(["pr", "view", "5", "--comments"], {
env: testModeEnv(server.url),
});
expect(exitCode).toBe(0);
expect(stdout).toContain("comments[2]{author,created,body}:");
expect(stdout).toContain("bob");
expect(stdout).toContain("short reply");
expect(stdout).toContain(
"... (truncated, 1000 chars total - use --full to see complete body)",
);
expect(stdout).not.toContain("comment_count");
expect(stdout).toContain("review_count: 0");
});
it("renders every review with official/stale and inline comments with --reviews, dropping review_count", async () => {
server = await startFixtureServer([
{
method: "GET",
path: "/api/v1/repos/testowner/testrepo/pulls/7",
body: {
number: 7,
title: "Feature",
state: "open",
user: { login: "alexion" },
draft: false,
merged: false,
comments: 0,
body: "Body.",
head: { sha: "sha7", ref: "feature" },
},
},
{
method: "GET",
path: "/api/v1/repos/testowner/testrepo/pulls/7/reviews",
body: [
{
id: 11,
state: "APPROVED",
official: true,
stale: false,
dismissed: false,
user: { login: "reviewer" },
body: "looks good",
},
{
id: 12,
state: "REQUEST_CHANGES",
official: false,
stale: true,
dismissed: false,
user: { login: "carol" },
body: "please fix",
},
],
},
{
method: "GET",
path: "/api/v1/repos/testowner/testrepo/pulls/7/reviews/11/comments",
body: [
{
id: 501,
user: { login: "alice" },
path: "src/x.ts",
body: "nit here",
diff_hunk: "@@ -10,6 +10,7 @@ func main\n a := 1\n b := 2\n c := 3\n d := 4\n+e := 5",
position: 7,
original_position: 4,
},
],
},
{
method: "GET",
path: "/api/v1/repos/testowner/testrepo/pulls/7/reviews/12/comments",
body: [],
},
{
method: "GET",
path: "/api/v1/repos/testowner/testrepo/commits/sha7/status",
body: { sha: "sha7", total_count: 0, statuses: [] },
},
]);
const { stdout, exitCode } = await runCliTest(["pr", "view", "7", "--reviews"], {
env: testModeEnv(server.url),
});
expect(exitCode).toBe(0);
expect(stdout).toContain("reviews[2]:");
expect(stdout).toContain(" state: approved");
expect(stdout).toContain(" state: request_changes");
expect(stdout).toContain(" official: yes");
expect(stdout).toContain(" official: no");
expect(stdout).toContain(" stale: no");
expect(stdout).toContain(" stale: yes");
expect(stdout).toContain(" comments[1]{id,author,path,resolved,diff_hunk,body}:");
expect(stdout).toContain(
' 501,alice,src/x.ts,no,"@@ -10,6 +10,7 @@ func main\\n d := 4\\n+e := 5",nit here',
);
expect(stdout).not.toContain("original_position");
expect(stdout).not.toContain("position:");
expect(stdout).not.toContain("review_count");
expect(stdout).toContain("comment_count");
});
it("renders resolved as yes when an inline comment's resolver is populated", async () => {
server = await startFixtureServer([
{
method: "GET",
path: "/api/v1/repos/testowner/testrepo/pulls/8",
body: {
number: 8,
title: "T",
state: "open",
user: { login: "alexion" },
draft: false,
merged: false,
comments: 0,
body: "b",
head: { sha: "sha8", ref: "f" },
},
},
{
method: "GET",
path: "/api/v1/repos/testowner/testrepo/pulls/8/reviews",
body: [
{
id: 21,
state: "COMMENT",
official: false,
stale: false,
dismissed: false,
user: { login: "dave" },
body: "",
},
],
},
{
method: "GET",
path: "/api/v1/repos/testowner/testrepo/pulls/8/reviews/21/comments",
body: [
{
id: 777,
user: { login: "dave" },
path: "a.ts",
resolver: { login: "carol" },
diff_hunk: "@@ -1,4 +1,5 @@\n a\n b\n c\n+d",
body: "ok",
},
],
},
{
method: "GET",
path: "/api/v1/repos/testowner/testrepo/commits/sha8/status",
body: { sha: "sha8", total_count: 0, statuses: [] },
},
]);
const { stdout, exitCode } = await runCliTest(["pr", "view", "8", "--reviews"], {
env: testModeEnv(server.url),
});
expect(exitCode).toBe(0);
expect(stdout).toContain('777,dave,a.ts,yes,"@@ -1,4 +1,5 @@\\n c\\n+d",ok');
});
it("emits each inline comment's diff_hunk verbatim under --full, with no trimming", async () => {
server = await startFixtureServer([
{
method: "GET",
path: "/api/v1/repos/testowner/testrepo/pulls/10",
body: {
number: 10,
title: "T",
state: "open",
user: { login: "alexion" },
draft: false,
merged: false,
comments: 0,
body: "b",
head: { sha: "sha10", ref: "f" },
},
},
{
method: "GET",
path: "/api/v1/repos/testowner/testrepo/pulls/10/reviews",
body: [
{
id: 41,
state: "COMMENT",
official: false,
stale: false,
dismissed: false,
user: { login: "frank" },
body: "",
},
],
},
{
method: "GET",
path: "/api/v1/repos/testowner/testrepo/pulls/10/reviews/41/comments",
body: [
{
id: 999,
user: { login: "frank" },
path: "big.ts",
diff_hunk: "@@ -1,4 +1,5 @@\n a\n b\n c\n+d",
body: "hi",
},
],
},
{
method: "GET",
path: "/api/v1/repos/testowner/testrepo/commits/sha10/status",
body: { sha: "sha10", total_count: 0, statuses: [] },
},
]);
const { stdout, exitCode } = await runCliTest(["pr", "view", "10", "--reviews", "--full"], {
env: testModeEnv(server.url),
});
expect(exitCode).toBe(0);
expect(stdout).toContain('999,frank,big.ts,no,"@@ -1,4 +1,5 @@\\n a\\n b\\n c\\n+d",hi');
});
it("renders a diff_hunk of three lines or fewer in full by default, leaving short hunks untrimmed", async () => {
server = await startFixtureServer([
{
method: "GET",
path: "/api/v1/repos/testowner/testrepo/pulls/9",
body: {
number: 9,
title: "T",
state: "open",
user: { login: "alexion" },
draft: false,
merged: false,
comments: 0,
body: "b",
head: { sha: "sha9", ref: "f" },
},
},
{
method: "GET",
path: "/api/v1/repos/testowner/testrepo/pulls/9/reviews",
body: [
{
id: 31,
state: "COMMENT",
official: false,
stale: false,
dismissed: false,
user: { login: "eve" },
body: "",
},
],
},
{
method: "GET",
path: "/api/v1/repos/testowner/testrepo/pulls/9/reviews/31/comments",
body: [
{
id: 888,
user: { login: "eve" },
path: "b.ts",
diff_hunk: "@@ -5 +5 @@\n-x\n+y",
body: "short",
},
],
},
{
method: "GET",
path: "/api/v1/repos/testowner/testrepo/commits/sha9/status",
body: { sha: "sha9", total_count: 0, statuses: [] },
},
]);
const { stdout, exitCode } = await runCliTest(["pr", "view", "9", "--reviews"], {
env: testModeEnv(server.url),
});
expect(exitCode).toBe(0);
expect(stdout).toContain('888,eve,b.ts,no,"@@ -5 +5 @@\\n-x\\n+y",short');
});
it("trims a 4-line diff_hunk to its header plus last two lines by default, dropping the one middle line", async () => {
server = await startFixtureServer([
{
method: "GET",
path: "/api/v1/repos/testowner/testrepo/pulls/11",
body: {
number: 11,
title: "T",
state: "open",
user: { login: "alexion" },
draft: false,
merged: false,
comments: 0,
body: "b",
head: { sha: "sha11", ref: "f" },
},
},
{
method: "GET",
path: "/api/v1/repos/testowner/testrepo/pulls/11/reviews",
body: [
{
id: 51,
state: "COMMENT",
official: false,
stale: false,
dismissed: false,
user: { login: "grace" },
body: "",
},
],
},
{
method: "GET",
path: "/api/v1/repos/testowner/testrepo/pulls/11/reviews/51/comments",
body: [
{
id: 1010,
user: { login: "grace" },
path: "c.ts",
diff_hunk: "@@ -2,3 +2,3 @@\n keep1\n drop_me\n+keep2",
body: "boundary",
},
],
},
{
method: "GET",
path: "/api/v1/repos/testowner/testrepo/commits/sha11/status",
body: { sha: "sha11", total_count: 0, statuses: [] },
},
]);
const { stdout, exitCode } = await runCliTest(["pr", "view", "11", "--reviews"], {
env: testModeEnv(server.url),
});
expect(exitCode).toBe(0);
expect(stdout).toContain('1010,grace,c.ts,no,"@@ -2,3 +2,3 @@\\n drop_me\\n+keep2",boundary');
});
it("reports a nonexistent PR as PR_NOT_FOUND with exit 1", async () => {
server = await startFixtureServer([
{
method: "GET",
path: "/api/v1/repos/testowner/testrepo/pulls/999",
status: 404,
body: { message: "Not Found" },
},
{
method: "GET",
path: "/api/v1/repos/testowner/testrepo/pulls/999/reviews",
status: 404,
body: { message: "Not Found" },
},
]);
const { stdout, exitCode } = await runCliTest(["pr", "view", "999"], {
env: testModeEnv(server.url),
});
expect(exitCode).toBe(1);
expect(stdout).toContain("code: PR_NOT_FOUND");
});
it("suppresses PR body and comment truncation with --full --comments", async () => {
const body = "e".repeat(900);
const longComment = "g".repeat(1000);
server = await startFixtureServer([
{
method: "GET",
path: "/api/v1/repos/testowner/testrepo/pulls/8",
body: {
number: 8,
title: "T",
state: "open",
user: { login: "alexion" },
draft: false,
merged: false,
comments: 1,
body,
head: { sha: "sha8", ref: "f" },
},
},
{ method: "GET", path: "/api/v1/repos/testowner/testrepo/pulls/8/reviews", body: [] },
{
method: "GET",
path: "/api/v1/repos/testowner/testrepo/commits/sha8/status",
body: { sha: "sha8", total_count: 0, statuses: [] },
},
{
method: "GET",
path: "/api/v1/repos/testowner/testrepo/issues/8/comments",
body: [{ user: { login: "sue" }, created_at: "2026-07-03T00:00:00Z", body: longComment }],
},
]);
const { stdout, exitCode } = await runCliTest(["pr", "view", "8", "--comments", "--full"], {
env: testModeEnv(server.url),
});
expect(exitCode).toBe(0);
expect(stdout).toContain(body);
expect(stdout).toContain(longComment);
expect(stdout).not.toContain("truncated");
});
it("renders the no-CI-checks message in the checks field when no statuses exist", async () => {
server = await startFixtureServer([
{
method: "GET",
path: "/api/v1/repos/testowner/testrepo/pulls/9",
body: {
number: 9,
title: "T",
state: "open",
user: { login: "alexion" },
draft: false,
merged: false,
comments: 0,
body: "Body.",
head: { sha: "sha9", ref: "f" },
},
},
{ method: "GET", path: "/api/v1/repos/testowner/testrepo/pulls/9/reviews", body: [] },
{
method: "GET",
path: "/api/v1/repos/testowner/testrepo/commits/sha9/status",
body: { sha: "sha9", total_count: 0, statuses: [] },
},
]);
const { stdout, exitCode } = await runCliTest(["pr", "view", "9"], {
env: testModeEnv(server.url),
});
expect(exitCode).toBe(0);
expect(stdout).toContain(
'checks: "0 passed, 0 failed — this PR has no CI checks configured"',
);
});
it("truncates a PR body over 500 chars with the inline hint and a --full suggestion", async () => {
const body = "z".repeat(600);
server = await startFixtureServer([
{
method: "GET",
path: PULL_PATH,
body: {
number: 5,
title: "T",
state: "open",
user: { login: "alexion" },
draft: false,
merged: false,
comments: 0,
body,
head: { sha: "abc123", ref: "f" },
},
},
{ method: "GET", path: REVIEWS_PATH, body: [] },
{
method: "GET",
path: STATUS_PATH,
body: { sha: "abc123", total_count: 0, statuses: [] },
},
]);
const { stdout, exitCode } = await runCliTest(["pr", "view", "5"], {
env: testModeEnv(server.url),
});
expect(exitCode).toBe(0);
expect(stdout).toContain(
"... (truncated, 600 chars total - use --full to see complete body)",
);
expect(stdout).toContain("pr view 5 --full");
});
});