zabbix-graphql-api/src/test/template_query.test.ts
Andreas Hilbig fb5e9cbe81 feat: improve Zabbix multi-version compatibility and introduce local development environment
This update enhances compatibility across multiple Zabbix versions and introduces tools for easier local development and testing.

Key improvements and verified version support:
- Verified Zabbix version support: 6.2, 6.4, 7.0, and 7.4.
- Version-specific feature handling:
  - `history.push` is enabled only for Zabbix 7.0+; older versions skip it with a clear error or notice.
  - Conditional JSON-RPC authentication: the `auth` field is automatically added to the request body for versions older than 6.4.
  - Implemented static Zabbix version caching in the datasource to minimize redundant API calls.
- Query optimization refinements:
  - Added mapping for implied fields (e.g., `state` -> `items`, `deviceType` -> `tags`).
  - Automatically prune unnecessary Zabbix parameters (like `selectItems` or `selectTags`) when not requested.
- Local development environment:
  - Added a new `zabbix-local` Docker Compose profile that includes PostgreSQL, Zabbix Server, and Zabbix Web.
  - Supports testing different versions by passing the `ZABBIX_VERSION` environment variable (e.g., 6.2, 6.4, 7.0, 7.4).
  - Provided a sample environment file at `samples/zabbix-local.env`.
- Documentation and Roadmap:
  - Updated README with a comprehensive version compatibility matrix and local environment instructions.
  - Created a new guide: `docs/howtos/local_development.md`.
  - Updated maintenance guides and added "Local Development Environment" as an achieved milestone in the roadmap.
- Test suite enhancements:
  - Improved Smoketest and RegressionTest executors with more reliable resource cleanup and error reporting.
  - Made tests version-aware to prevent failures on older Zabbix instances.

BREAKING CHANGE: Dropped Zabbix 6.0 specific workarounds; the minimum supported version is now 6.2.
2026-02-04 14:01:53 +01:00

121 lines
4.2 KiB
TypeScript

import {createResolvers} from "../api/resolvers.js";
import {zabbixAPI} from "../datasources/zabbix-api.js";
import {QueryTemplatesArgs} from "../schema/generated/graphql.js";
// Mocking ZabbixAPI
jest.mock("../datasources/zabbix-api.js", () => ({
zabbixAPI: {
executeRequest: jest.fn(),
post: jest.fn(),
getVersion: jest.fn().mockResolvedValue("7.0.0"),
baseURL: "http://mock-zabbix"
},
ZABBIX_EDGE_DEVICE_BASE_GROUP: "Roadwork"
}));
describe("Template Resolver", () => {
let resolvers: any;
beforeEach(() => {
jest.clearAllMocks();
resolvers = createResolvers();
});
test("templates query - returns all templates", async () => {
const mockTemplates = [
{ templateid: "1", name: "Template 1", uuid: "uuid1" },
{ templateid: "2", name: "Template 2", uuid: "uuid2" }
];
(zabbixAPI.post as jest.Mock).mockResolvedValueOnce(mockTemplates);
const args: QueryTemplatesArgs = {};
const context = { zabbixAuthToken: "test-token" };
const result = await resolvers.Query.templates(null, args, context);
expect(result).toEqual(mockTemplates);
expect(zabbixAPI.post).toHaveBeenCalledWith("template.get", expect.objectContaining({
body: expect.objectContaining({
method: "template.get",
params: expect.objectContaining({
output: "extend",
selectItems: "extend"
})
})
}));
});
test("templates query - filters by hostids", async () => {
const mockTemplates = [{ templateid: "1", name: "Template 1" }];
(zabbixAPI.post as jest.Mock).mockResolvedValueOnce(mockTemplates);
const args: QueryTemplatesArgs = { hostids: [1] };
const context = { zabbixAuthToken: "test-token" };
const result = await resolvers.Query.templates(null, args, context);
expect(result).toEqual(mockTemplates);
expect(zabbixAPI.post).toHaveBeenCalledWith("template.get", expect.objectContaining({
body: expect.objectContaining({
method: "template.get",
params: expect.objectContaining({
templateids: [1]
})
})
}));
});
test("templates query - filters by name_pattern", async () => {
const mockTemplates = [{ templateid: "1", name: "Template 1" }];
(zabbixAPI.post as jest.Mock).mockResolvedValueOnce(mockTemplates);
const args: QueryTemplatesArgs = { name_pattern: "Template" };
const context = { zabbixAuthToken: "test-token" };
const result = await resolvers.Query.templates(null, args, context);
expect(result).toEqual(mockTemplates);
expect(zabbixAPI.post).toHaveBeenCalledWith("template.get", expect.objectContaining({
body: expect.objectContaining({
method: "template.get",
params: expect.objectContaining({
search: {
name: "Template",
host: "Template"
},
searchByAny: true,
searchWildcardsEnabled: true
})
})
}));
});
test("templates query - filters by name_pattern with % wildcard", async () => {
const mockTemplates = [{ templateid: "1", name: "Template 1" }];
(zabbixAPI.post as jest.Mock).mockResolvedValueOnce(mockTemplates);
const args: QueryTemplatesArgs = { name_pattern: "Temp%1" };
const context = { zabbixAuthToken: "test-token" };
const result = await resolvers.Query.templates(null, args, context);
expect(result).toEqual(mockTemplates);
expect(zabbixAPI.post).toHaveBeenCalledWith("template.get", expect.objectContaining({
body: expect.objectContaining({
method: "template.get",
params: expect.objectContaining({
search: {
name: "Temp%1",
host: "Temp%1"
},
searchByAny: true,
searchWildcardsEnabled: true
})
})
}));
});
});