zabbix-graphql-api/src/test/template_integration.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

258 lines
12 KiB
TypeScript

import {ApolloServer} from '@apollo/server';
import {schema_loader} from '../api/schema.js';
import {readFileSync} from 'fs';
import {join} from 'path';
import {zabbixAPI} from '../datasources/zabbix-api.js';
// Mocking ZabbixAPI.post
jest.mock("../datasources/zabbix-api.js", () => ({
zabbixAPI: {
post: jest.fn(),
getVersion: jest.fn().mockResolvedValue("7.0.0"),
executeRequest: jest.fn(),
baseURL: 'http://localhost/zabbix'
}
}));
describe("Template Integration Tests", () => {
let server: ApolloServer;
beforeAll(async () => {
const schema = await schema_loader();
server = new ApolloServer({
schema,
});
});
test("Import templates using sample query and variables", async () => {
const sampleFile = readFileSync(join(process.cwd(), 'docs', 'queries', 'sample_import_templates_mutation.graphql'), 'utf-8').replace(/\r\n/g, '\n');
// Extract mutation and variables from the doc file
const mutationMatch = sampleFile.match(/```graphql\n([\s\S]*?)\n```/);
const variablesMatch = sampleFile.match(/```json\n([\s\S]*?)\n```/);
const mutation = mutationMatch![1];
const variables = JSON.parse(variablesMatch![1]);
// Mock Zabbix API calls
// 1. Group lookup
(zabbixAPI.post as jest.Mock).mockResolvedValueOnce([{ groupid: "201", name: "Templates/Roadwork/Devices" }]);
// 2. Linked template lookup
(zabbixAPI.post as jest.Mock).mockResolvedValueOnce([{ templateid: "401", host: "ROADWORK_DEVICE" }]);
// 3. Template creation
(zabbixAPI.post as jest.Mock).mockResolvedValueOnce({ templateids: ["501"] });
// 4. Item creation (location)
(zabbixAPI.post as jest.Mock).mockResolvedValueOnce({ itemids: ["601"] });
// 5. Item creation (MQTT_LOCATION)
(zabbixAPI.post as jest.Mock).mockResolvedValueOnce({ itemids: ["602"] });
const response = await server.executeOperation({
query: mutation,
variables: variables,
}, {
contextValue: {
zabbixAuthToken: 'test-token'
}
});
expect(response.body.kind).toBe('single');
// @ts-ignore
const result = response.body.singleResult;
expect(result.errors).toBeUndefined();
expect(result.data.importTemplates).toHaveLength(1);
expect(result.data.importTemplates[0].host).toBe("BT_DEVICE_TRACKER");
expect(result.data.importTemplates[0].templateid).toBe("501");
});
test("Import and Export templates comparison", async () => {
// 1. Import
const importSample = readFileSync(join(process.cwd(), 'docs', 'queries', 'sample_import_templates_mutation.graphql'), 'utf-8').replace(/\r\n/g, '\n');
const importMutation = importSample.match(/```graphql\n([\s\S]*?)\n```/)![1];
const importVariables = JSON.parse(importSample.match(/```json\n([\s\S]*?)\n```/)![1]);
// Mock for import
(zabbixAPI.post as jest.Mock).mockResolvedValueOnce([{ groupid: "201", name: "Templates/Roadwork/Devices" }]);
(zabbixAPI.post as jest.Mock).mockResolvedValueOnce([{ templateid: "401", host: "ROADWORK_DEVICE" }]);
(zabbixAPI.post as jest.Mock).mockResolvedValueOnce({ templateids: ["501"] });
(zabbixAPI.post as jest.Mock).mockResolvedValueOnce({ itemids: ["601"] });
(zabbixAPI.post as jest.Mock).mockResolvedValueOnce({ itemids: ["602"] });
await server.executeOperation({
query: importMutation,
variables: importVariables,
}, {
contextValue: { zabbixAuthToken: 'test-token' }
});
// 2. Export (Query)
const querySample = readFileSync(join(process.cwd(), 'docs', 'queries', 'sample_templates_query.graphql'), 'utf-8').replace(/\r\n/g, '\n');
const query = querySample.match(/```graphql\n([\s\S]*?)\n```/)![1];
const queryVariables = JSON.parse(querySample.match(/```json\n([\s\S]*?)\n```/)![1]);
// Mock for query
(zabbixAPI.post as jest.Mock).mockResolvedValueOnce([{ templateid: "501", host: "BT_DEVICE_TRACKER", name: "BT_DEVICE_TRACKER" }]);
const queryResponse = await server.executeOperation({
query: query,
variables: queryVariables,
}, {
contextValue: { zabbixAuthToken: 'test-token' }
});
expect(queryResponse.body.kind).toBe('single');
// @ts-ignore
const queryResult = queryResponse.body.singleResult;
expect(queryResult.errors).toBeUndefined();
expect(queryResult.data.templates).toHaveLength(1);
expect(queryResult.data.templates[0].name).toBe(importVariables.templates[0].name);
expect(queryResult.data.templates[0].templateid).toBe("501");
// 3. Delete
const deleteMutation = `
mutation DeleteTemplates($templateids: [Int!], $name_pattern: String) {
deleteTemplates(templateids: $templateids, name_pattern: $name_pattern) {
id
message
}
}
`;
// Mock for query (to find ID for name_pattern deletion)
(zabbixAPI.post as jest.Mock).mockResolvedValueOnce([{ templateid: "501", host: "BT_DEVICE_TRACKER" }]);
// Mock for delete
(zabbixAPI.post as jest.Mock).mockResolvedValueOnce({ templateids: ["501"] });
const deleteResponse = await server.executeOperation({
query: deleteMutation,
variables: { name_pattern: "BT_DEVICE_TRACKER" },
}, {
contextValue: { zabbixAuthToken: 'test-token' }
});
expect(deleteResponse.body.kind).toBe('single');
// @ts-ignore
const deleteResult = deleteResponse.body.singleResult;
expect(deleteResult.errors).toBeUndefined();
expect(deleteResult.data.deleteTemplates).toHaveLength(1);
expect(deleteResult.data.deleteTemplates[0].message).toContain("deleted successfully");
});
test("Import and Export template groups comparison", async () => {
// 1. Import (Host Template Groups)
const importSample = readFileSync(join(process.cwd(), 'docs', 'queries', 'sample_import_host_template_groups_mutation.graphql'), 'utf-8').replace(/\r\n/g, '\n');
const importMutation = importSample.match(/```graphql\n([\s\S]*?)\n```/)![1];
const importVariables = JSON.parse(importSample.match(/```json\n([\s\S]*?)\n```/)![1]);
// Mock for import
for (const group of importVariables.templateGroups) {
// Mock lookup (not found)
(zabbixAPI.post as jest.Mock).mockResolvedValueOnce([]);
// Mock creation
const mockGroupId = Math.floor(Math.random() * 1000).toString();
(zabbixAPI.post as jest.Mock).mockResolvedValueOnce({ groupids: [mockGroupId] });
}
const importResponse = await server.executeOperation({
query: importMutation,
variables: importVariables,
}, {
contextValue: { zabbixAuthToken: 'test-token' }
});
expect(importResponse.body.kind).toBe('single');
// @ts-ignore
const importResult = importResponse.body.singleResult;
expect(importResult.errors).toBeUndefined();
expect(importResult.data.importTemplateGroups).toHaveLength(importVariables.templateGroups.length);
// 2. Import (Permissions Template Groups)
const permImportSample = readFileSync(join(process.cwd(), 'docs', 'queries', 'sample_import_permissions_template_groups_mutation.graphql'), 'utf-8').replace(/\r\n/g, '\n');
const permImportMutation = permImportSample.match(/```graphql\n([\s\S]*?)\n```/)![1];
const permImportVariables = JSON.parse(permImportSample.match(/```json\n([\s\S]*?)\n```/)![1]);
// Mock for import
for (const group of permImportVariables.templateGroups) {
(zabbixAPI.post as jest.Mock).mockResolvedValueOnce([]);
const mockGroupId = Math.floor(Math.random() * 1000).toString();
(zabbixAPI.post as jest.Mock).mockResolvedValueOnce({ groupids: [mockGroupId] });
}
const permImportResponse = await server.executeOperation({
query: permImportMutation,
variables: permImportVariables,
}, {
contextValue: { zabbixAuthToken: 'test-token' }
});
expect(permImportResponse.body.kind).toBe('single');
// @ts-ignore
const permImportResult = permImportResponse.body.singleResult;
expect(permImportResult.errors).toBeUndefined();
expect(permImportResult.data.importTemplateGroups).toHaveLength(permImportVariables.templateGroups.length);
// 3. Export (Query)
const querySample = readFileSync(join(process.cwd(), 'docs', 'queries', 'sample_all_template_groups_query.graphql'), 'utf-8').replace(/\r\n/g, '\n');
const query = querySample.match(/```graphql\n([\s\S]*?)\n```/)![1];
const queryVariables = JSON.parse(querySample.match(/```json\n([\s\S]*?)\n```/)![1]);
// Combine all groups for mock query response
const allGroups = [...importVariables.templateGroups, ...permImportVariables.templateGroups];
// Mock for query
const mockGroupsResponse = allGroups.map((g: any, index: number) => ({
groupid: (index + 1000).toString(),
name: g.groupName
}));
(zabbixAPI.post as jest.Mock).mockResolvedValueOnce(mockGroupsResponse);
const queryResponse = await server.executeOperation({
query: query,
variables: queryVariables,
}, {
contextValue: { zabbixAuthToken: 'test-token' }
});
expect(queryResponse.body.kind).toBe('single');
// @ts-ignore
const queryResult = queryResponse.body.singleResult;
expect(queryResult.errors).toBeUndefined();
expect(queryResult.data.allTemplateGroups).toHaveLength(allGroups.length);
// Verify names match
const importedNames = allGroups.map((g: any) => g.groupName).sort();
const exportedNames = queryResult.data.allTemplateGroups.map((g: any) => g.name).sort();
expect(exportedNames).toEqual(importedNames);
// 4. Delete Template Groups
const groupidsToDelete = queryResult.data.allTemplateGroups.map((g: any) => parseInt(g.groupid));
// Mock for query (for name_pattern)
(zabbixAPI.post as jest.Mock).mockResolvedValueOnce(queryResult.data.allTemplateGroups.map((g: any) => ({ groupid: g.groupid, name: g.name })));
// Mock for delete
(zabbixAPI.post as jest.Mock).mockResolvedValueOnce({ groupids: groupidsToDelete.map((id: number) => id.toString()) });
const deleteMutation = `
mutation DeleteTemplateGroups($groupids: [Int!], $name_pattern: String) {
deleteTemplateGroups(groupids: $groupids, name_pattern: $name_pattern) {
id
message
error {
message
}
}
}
`;
const deleteResponse = await server.executeOperation({
query: deleteMutation,
variables: { name_pattern: "%" },
}, {
contextValue: { zabbixAuthToken: 'test-token' }
});
expect(deleteResponse.body.kind).toBe('single');
// @ts-ignore
const deleteResult = deleteResponse.body.singleResult;
expect(deleteResult.errors).toBeUndefined();
expect(deleteResult.data.deleteTemplateGroups).toHaveLength(groupidsToDelete.length);
expect(deleteResult.data.deleteTemplateGroups[0].message).toContain("deleted successfully");
});
});