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.
223 lines
7.6 KiB
TypeScript
223 lines
7.6 KiB
TypeScript
import {createResolvers} from "../api/resolvers.js";
|
|
import {zabbixAPI} from "../datasources/zabbix-api.js";
|
|
import {QueryAllHostsArgs, 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",
|
|
}
|
|
}));
|
|
|
|
// Mocking Config
|
|
jest.mock("../common_utils.js", () => ({
|
|
Config: {
|
|
HOST_TYPE_FILTER_DEFAULT: null,
|
|
HOST_GROUP_FILTER_DEFAULT: null
|
|
}
|
|
}));
|
|
|
|
describe("Query Optimization", () => {
|
|
let resolvers: any;
|
|
|
|
beforeEach(() => {
|
|
jest.clearAllMocks();
|
|
resolvers = createResolvers();
|
|
});
|
|
|
|
test("allHosts optimization - reduce output and skip selectTags/selectItems", async () => {
|
|
(zabbixAPI.post as jest.Mock).mockResolvedValueOnce([]);
|
|
|
|
const args: QueryAllHostsArgs = {};
|
|
const context = {
|
|
zabbixAuthToken: "test-token",
|
|
dataSources: { zabbixAPI: zabbixAPI }
|
|
};
|
|
const info = {
|
|
fieldNodes: [{
|
|
selectionSet: {
|
|
selections: [
|
|
{ kind: 'Field', name: { value: 'hostid' } },
|
|
{ kind: 'Field', name: { value: 'name' } }
|
|
]
|
|
}
|
|
}]
|
|
};
|
|
|
|
await resolvers.Query.allHosts(null, args, context, info);
|
|
|
|
expect(zabbixAPI.post).toHaveBeenCalledWith(expect.any(String), expect.objectContaining({
|
|
body: expect.objectContaining({
|
|
params: expect.objectContaining({
|
|
output: ["hostid", "name"]
|
|
})
|
|
})
|
|
}));
|
|
|
|
const callParams = (zabbixAPI.post as jest.Mock).mock.calls[0][1].body.params;
|
|
expect(callParams.selectTags).toBeUndefined();
|
|
expect(callParams.selectItems).toBeUndefined();
|
|
expect(callParams.selectParentTemplates).toBeUndefined();
|
|
|
|
// Verify no follow-up item.get call
|
|
const itemGetCall = (zabbixAPI.post as jest.Mock).mock.calls.find(call => call[1].body.method === "item.get");
|
|
expect(itemGetCall).toBeUndefined();
|
|
});
|
|
|
|
test("allHosts optimization - keep selectTags when requested", async () => {
|
|
(zabbixAPI.post as jest.Mock).mockResolvedValueOnce([]);
|
|
|
|
const args: QueryAllHostsArgs = {};
|
|
const context = {
|
|
zabbixAuthToken: "test-token",
|
|
dataSources: { zabbixAPI: zabbixAPI }
|
|
};
|
|
const info = {
|
|
fieldNodes: [{
|
|
selectionSet: {
|
|
selections: [
|
|
{ kind: 'Field', name: { value: 'hostid' } },
|
|
{ kind: 'Field', name: { value: 'tags' } }
|
|
]
|
|
}
|
|
}]
|
|
};
|
|
|
|
await resolvers.Query.allHosts(null, args, context, info);
|
|
|
|
expect(zabbixAPI.post).toHaveBeenCalledWith(expect.any(String), expect.objectContaining({
|
|
body: expect.objectContaining({
|
|
params: expect.objectContaining({
|
|
output: expect.arrayContaining(["hostid", "tags"]),
|
|
selectTags: expect.any(Array)
|
|
})
|
|
})
|
|
}));
|
|
});
|
|
|
|
test("templates optimization - reduce output and skip selectItems", async () => {
|
|
(zabbixAPI.post as jest.Mock).mockResolvedValueOnce([]);
|
|
|
|
const args: QueryTemplatesArgs = {};
|
|
const context = {
|
|
zabbixAuthToken: "test-token",
|
|
dataSources: { zabbixAPI: zabbixAPI }
|
|
};
|
|
const info = {
|
|
fieldNodes: [{
|
|
selectionSet: {
|
|
selections: [
|
|
{ kind: 'Field', name: { value: 'name' } }
|
|
]
|
|
}
|
|
}]
|
|
};
|
|
|
|
await resolvers.Query.templates(null, args, context, info);
|
|
|
|
expect(zabbixAPI.post).toHaveBeenCalledWith(expect.any(String), expect.objectContaining({
|
|
body: expect.objectContaining({
|
|
params: expect.objectContaining({
|
|
output: ["name"]
|
|
})
|
|
})
|
|
}));
|
|
|
|
const callParams = (zabbixAPI.post as jest.Mock).mock.calls[0][1].body.params;
|
|
expect(callParams.selectItems).toBeUndefined();
|
|
});
|
|
|
|
test("allHosts optimization - indirect dependency via nested state field", async () => {
|
|
(zabbixAPI.post as jest.Mock).mockResolvedValueOnce([]);
|
|
|
|
const args: QueryAllHostsArgs = {};
|
|
const context = {
|
|
zabbixAuthToken: "test-token",
|
|
dataSources: { zabbixAPI: zabbixAPI }
|
|
};
|
|
const info = {
|
|
fieldNodes: [{
|
|
selectionSet: {
|
|
selections: [
|
|
{ kind: 'Field', name: { value: 'state' }, selectionSet: {
|
|
selections: [
|
|
{ kind: 'Field', name: { value: 'operational' }, selectionSet: {
|
|
selections: [
|
|
{ kind: 'Field', name: { value: 'temperature' } }
|
|
]
|
|
} }
|
|
]
|
|
} }
|
|
]
|
|
}
|
|
}]
|
|
};
|
|
|
|
await resolvers.Query.allHosts(null, args, context, info);
|
|
|
|
const callParams = (zabbixAPI.post as jest.Mock).mock.calls[0][1].body.params;
|
|
expect(callParams.selectItems).toBeDefined();
|
|
expect(Array.isArray(callParams.output)).toBe(true);
|
|
expect(callParams.output).toContain("items");
|
|
});
|
|
|
|
test("allHosts optimization - keep selectTags when deviceType requested", async () => {
|
|
(zabbixAPI.post as jest.Mock).mockResolvedValueOnce([]);
|
|
|
|
const args: QueryAllHostsArgs = {};
|
|
const context = {
|
|
zabbixAuthToken: "test-token",
|
|
dataSources: { zabbixAPI: zabbixAPI }
|
|
};
|
|
const info = {
|
|
fieldNodes: [{
|
|
selectionSet: {
|
|
selections: [
|
|
{ kind: 'Field', name: { value: 'hostid' } },
|
|
{ kind: 'Field', name: { value: 'deviceType' } }
|
|
]
|
|
}
|
|
}]
|
|
};
|
|
|
|
await resolvers.Query.allHosts(null, args, context, info);
|
|
|
|
expect(zabbixAPI.post).toHaveBeenCalledWith(expect.any(String), expect.objectContaining({
|
|
body: expect.objectContaining({
|
|
params: expect.objectContaining({
|
|
output: expect.arrayContaining(["hostid", "tags"]),
|
|
selectTags: expect.any(Array)
|
|
})
|
|
})
|
|
}));
|
|
});
|
|
|
|
test("allDevices optimization - skip items when not requested", async () => {
|
|
(zabbixAPI.post as jest.Mock).mockResolvedValueOnce([]);
|
|
|
|
const args: any = {};
|
|
const context = {
|
|
zabbixAuthToken: "test-token",
|
|
dataSources: { zabbixAPI: zabbixAPI }
|
|
};
|
|
const info = {
|
|
fieldNodes: [{
|
|
selectionSet: {
|
|
selections: [
|
|
{ kind: 'Field', name: { value: 'hostid' } },
|
|
{ kind: 'Field', name: { value: 'name' } }
|
|
]
|
|
}
|
|
}]
|
|
};
|
|
|
|
await resolvers.Query.allDevices(null, args, context, info);
|
|
|
|
const callParams = (zabbixAPI.post as jest.Mock).mock.calls[0][1].body.params;
|
|
expect(callParams.selectItems).toBeUndefined();
|
|
expect(callParams.output).not.toContain("items");
|
|
});
|
|
});
|