import { beforeAll, describe, expect, it } from "vitest";
import * as ynab from "ynab";
import { handleGetMonth, handleListMonths } from "../monthTools.js";
/**
* Integration tests for month tools using real YNAB API
* Skips if YNAB_ACCESS_TOKEN is not set or if SKIP_E2E_TESTS is true
*/
const hasToken = !!process.env.YNAB_ACCESS_TOKEN;
const shouldSkip = process.env.SKIP_E2E_TESTS === "true" || !hasToken;
const describeIntegration = shouldSkip ? describe.skip : describe;
describeIntegration("Month Tools Integration", () => {
let ynabAPI: ynab.API;
let testBudgetId: string;
let testMonth: string;
beforeAll(async () => {
const accessToken = process.env.YNAB_ACCESS_TOKEN!;
ynabAPI = new ynab.API(accessToken);
// Get a test budget ID
const budgetsResponse = await ynabAPI.budgets.getBudgets();
if (budgetsResponse.data.budgets.length === 0) {
throw new Error("No budgets found for testing");
}
testBudgetId = budgetsResponse.data.budgets[0].id;
// Get a test month from the existing months in the budget
const monthsResponse = await ynabAPI.months.getBudgetMonths(testBudgetId);
if (monthsResponse.data.months.length === 0) {
throw new Error("No months found for testing");
}
testMonth = monthsResponse.data.months[0].month;
});
describe("handleListMonths", () => {
it(
"should successfully list months from real API",
{ meta: { tier: "domain", domain: "months" } },
async () => {
const result = await handleListMonths(ynabAPI, {
budget_id: testBudgetId,
});
expect(result.content).toHaveLength(1);
expect(result.content[0].type).toBe("text");
const parsedContent = JSON.parse(result.content[0].text);
expect(parsedContent.months).toBeDefined();
expect(Array.isArray(parsedContent.months)).toBe(true);
expect(parsedContent.months.length).toBeGreaterThan(0);
// Verify month structure
const firstMonth = parsedContent.months[0];
expect(firstMonth.month).toBeDefined();
expect(typeof firstMonth.income).toBe("number");
expect(typeof firstMonth.budgeted).toBe("number");
expect(typeof firstMonth.activity).toBe("number");
expect(typeof firstMonth.to_be_budgeted).toBe("number");
expect(typeof firstMonth.deleted).toBe("boolean");
console.warn(
`✅ Successfully listed ${parsedContent.months.length} months`,
);
console.warn(` - First month: ${firstMonth.month}`);
console.warn(` - Income: ${firstMonth.income} milliunits`);
console.warn(` - Budgeted: ${firstMonth.budgeted} milliunits`);
},
);
it(
"should handle invalid budget ID gracefully",
{ meta: { tier: "domain", domain: "months" } },
async () => {
const result = await handleListMonths(ynabAPI, {
budget_id: "invalid-budget-id",
});
expect(result.content).toHaveLength(1);
expect(result.content[0].type).toBe("text");
const parsedContent = JSON.parse(result.content[0].text);
expect(parsedContent.error).toBeDefined();
expect(parsedContent.error.message).toBeDefined();
console.warn(
`✅ Correctly handled invalid budget ID: ${parsedContent.error.message}`,
);
},
);
});
describe("handleGetMonth", () => {
it(
"should successfully get month details from real API",
{ meta: { tier: "domain", domain: "months" } },
async () => {
const result = await handleGetMonth(ynabAPI, {
budget_id: testBudgetId,
month: testMonth,
});
expect(result.content).toHaveLength(1);
expect(result.content[0].type).toBe("text");
const parsedContent = JSON.parse(result.content[0].text);
expect(parsedContent.month).toBeDefined();
const month = parsedContent.month;
expect(month.month).toBe(testMonth);
expect(typeof month.income).toBe("number");
expect(typeof month.budgeted).toBe("number");
expect(typeof month.activity).toBe("number");
expect(typeof month.to_be_budgeted).toBe("number");
expect(typeof month.deleted).toBe("boolean");
// Categories should be present
expect(month.categories).toBeDefined();
expect(Array.isArray(month.categories)).toBe(true);
if (month.categories.length > 0) {
const firstCategory = month.categories[0];
expect(firstCategory.id).toBeDefined();
expect(firstCategory.name).toBeDefined();
expect(typeof firstCategory.budgeted).toBe("number");
expect(typeof firstCategory.activity).toBe("number");
expect(typeof firstCategory.balance).toBe("number");
expect(typeof firstCategory.hidden).toBe("boolean");
expect(typeof firstCategory.deleted).toBe("boolean");
}
console.warn(`✅ Successfully retrieved month: ${month.month}`);
console.warn(` - Income: ${month.income} milliunits`);
console.warn(` - Budgeted: ${month.budgeted} milliunits`);
console.warn(` - Activity: ${month.activity} milliunits`);
console.warn(` - To be budgeted: ${month.to_be_budgeted} milliunits`);
console.warn(` - Categories: ${month.categories.length}`);
},
);
it(
"should handle invalid budget ID gracefully",
{ meta: { tier: "domain", domain: "months" } },
async () => {
const result = await handleGetMonth(ynabAPI, {
budget_id: "invalid-budget-id",
month: testMonth,
});
expect(result.content).toHaveLength(1);
expect(result.content[0].type).toBe("text");
const parsedContent = JSON.parse(result.content[0].text);
expect(parsedContent.error).toBeDefined();
expect(parsedContent.error.message).toBeDefined();
console.warn(
`✅ Correctly handled invalid budget ID: ${parsedContent.error.message}`,
);
},
);
it(
"should handle invalid month format gracefully",
{ meta: { tier: "domain", domain: "months" } },
async () => {
const result = await handleGetMonth(ynabAPI, {
budget_id: testBudgetId,
month: "2024-13-01", // Invalid month
});
expect(result.content).toHaveLength(1);
expect(result.content[0].type).toBe("text");
const parsedContent = JSON.parse(result.content[0].text);
expect(parsedContent.error).toBeDefined();
expect(parsedContent.error.message).toBeDefined();
console.warn(
`✅ Correctly handled invalid month: ${parsedContent.error.message}`,
);
},
);
});
});
