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.
This commit is contained in:
parent
7c2dee2b6c
commit
fb5e9cbe81
36 changed files with 470 additions and 172 deletions
|
|
@ -1,11 +1,11 @@
|
|||
import {ZabbixHistoryPushParams, ZabbixHistoryPushRequest} from "../datasources/zabbix-history.js";
|
||||
import {zabbixAPI} from "../datasources/zabbix-api.js";
|
||||
import {GraphQLError} from "graphql";
|
||||
|
||||
// Mocking ZabbixAPI
|
||||
jest.mock("../datasources/zabbix-api.js", () => ({
|
||||
zabbixAPI: {
|
||||
post: jest.fn(),
|
||||
getVersion: jest.fn().mockResolvedValue("7.0.0")
|
||||
}
|
||||
}));
|
||||
|
||||
|
|
@ -63,4 +63,12 @@ describe("ZabbixHistoryPushRequest", () => {
|
|||
|
||||
await expect(request.prepare(zabbixAPI, params)).rejects.toThrow("if itemid is empty both key and host must be filled");
|
||||
});
|
||||
|
||||
test("prepare - throw error if Zabbix version < 7.0.0", async () => {
|
||||
(zabbixAPI.getVersion as jest.Mock).mockResolvedValue("6.2.0");
|
||||
const values = [{ timestamp: "2024-01-01T10:00:00Z", value: "val" }];
|
||||
const params = new ZabbixHistoryPushParams(values, "1");
|
||||
|
||||
await expect(request.prepare(zabbixAPI, params)).rejects.toThrow("history.push is only supported in Zabbix 7.0.0 and newer");
|
||||
});
|
||||
});
|
||||
|
|
|
|||
|
|
@ -6,6 +6,7 @@ import {zabbixAPI} from '../datasources/zabbix-api.js';
|
|||
jest.mock("../datasources/zabbix-api.js", () => ({
|
||||
zabbixAPI: {
|
||||
post: jest.fn(),
|
||||
getVersion: jest.fn().mockResolvedValue("7.0.0"),
|
||||
}
|
||||
}));
|
||||
|
||||
|
|
|
|||
|
|
@ -6,6 +6,7 @@ jest.mock("../datasources/zabbix-api.js", () => ({
|
|||
zabbixAPI: {
|
||||
executeRequest: jest.fn(),
|
||||
post: jest.fn(),
|
||||
getVersion: jest.fn().mockResolvedValue("7.0.0"),
|
||||
requestByPath: jest.fn()
|
||||
},
|
||||
ZABBIX_EDGE_DEVICE_BASE_GROUP: "Roadwork"
|
||||
|
|
|
|||
|
|
@ -8,6 +8,7 @@ import {ZABBIX_EDGE_DEVICE_BASE_GROUP, zabbixAPI} from '../datasources/zabbix-ap
|
|||
jest.mock("../datasources/zabbix-api.js", () => ({
|
||||
zabbixAPI: {
|
||||
post: jest.fn(),
|
||||
getVersion: jest.fn().mockResolvedValue("7.0.0"),
|
||||
executeRequest: jest.fn(),
|
||||
baseURL: 'http://localhost/zabbix',
|
||||
getLocations: jest.fn(),
|
||||
|
|
|
|||
|
|
@ -7,6 +7,7 @@ jest.mock("../datasources/zabbix-api.js", () => ({
|
|||
zabbixAPI: {
|
||||
executeRequest: jest.fn(),
|
||||
post: jest.fn(),
|
||||
getVersion: jest.fn().mockResolvedValue("7.0.0"),
|
||||
baseURL: "http://mock-zabbix",
|
||||
getLocations: jest.fn()
|
||||
},
|
||||
|
|
|
|||
|
|
@ -7,6 +7,7 @@ jest.mock("../datasources/zabbix-api.js", () => ({
|
|||
zabbixAPI: {
|
||||
executeRequest: jest.fn(),
|
||||
post: jest.fn(),
|
||||
getVersion: jest.fn().mockResolvedValue("7.0.0"),
|
||||
baseURL: "http://mock-zabbix",
|
||||
}
|
||||
}));
|
||||
|
|
|
|||
|
|
@ -5,7 +5,8 @@ import {zabbixAPI} from "../datasources/zabbix-api.js";
|
|||
jest.mock("../datasources/zabbix-api.js", () => ({
|
||||
zabbixAPI: {
|
||||
executeRequest: jest.fn(),
|
||||
post: jest.fn()
|
||||
post: jest.fn(),
|
||||
getVersion: jest.fn().mockResolvedValue("7.0.0"),
|
||||
}
|
||||
}));
|
||||
|
||||
|
|
|
|||
|
|
@ -7,6 +7,7 @@ jest.mock("../datasources/zabbix-api.js", () => ({
|
|||
zabbixAPI: {
|
||||
executeRequest: jest.fn(),
|
||||
post: jest.fn(),
|
||||
getVersion: jest.fn().mockResolvedValue("7.0.0"),
|
||||
baseURL: "http://mock-zabbix",
|
||||
}
|
||||
}));
|
||||
|
|
@ -90,7 +91,7 @@ describe("Query Optimization", () => {
|
|||
expect(zabbixAPI.post).toHaveBeenCalledWith(expect.any(String), expect.objectContaining({
|
||||
body: expect.objectContaining({
|
||||
params: expect.objectContaining({
|
||||
output: ["hostid"],
|
||||
output: expect.arrayContaining(["hostid", "tags"]),
|
||||
selectTags: expect.any(Array)
|
||||
})
|
||||
})
|
||||
|
|
@ -187,7 +188,7 @@ describe("Query Optimization", () => {
|
|||
expect(zabbixAPI.post).toHaveBeenCalledWith(expect.any(String), expect.objectContaining({
|
||||
body: expect.objectContaining({
|
||||
params: expect.objectContaining({
|
||||
output: ["hostid"],
|
||||
output: expect.arrayContaining(["hostid", "tags"]),
|
||||
selectTags: expect.any(Array)
|
||||
})
|
||||
})
|
||||
|
|
|
|||
|
|
@ -5,7 +5,8 @@ import {zabbixAPI} from "../datasources/zabbix-api.js";
|
|||
jest.mock("../datasources/zabbix-api.js", () => ({
|
||||
zabbixAPI: {
|
||||
executeRequest: jest.fn(),
|
||||
post: jest.fn()
|
||||
post: jest.fn(),
|
||||
getVersion: jest.fn().mockResolvedValue("7.0.0"),
|
||||
}
|
||||
}));
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,8 @@ import {zabbixAPI} from "../datasources/zabbix-api.js";
|
|||
jest.mock("../datasources/zabbix-api.js", () => ({
|
||||
zabbixAPI: {
|
||||
executeRequest: jest.fn(),
|
||||
post: jest.fn()
|
||||
post: jest.fn(),
|
||||
getVersion: jest.fn().mockResolvedValue("7.0.0"),
|
||||
}
|
||||
}));
|
||||
|
||||
|
|
|
|||
|
|
@ -8,6 +8,7 @@ import {zabbixAPI} from '../datasources/zabbix-api.js';
|
|||
jest.mock("../datasources/zabbix-api.js", () => ({
|
||||
zabbixAPI: {
|
||||
post: jest.fn(),
|
||||
getVersion: jest.fn().mockResolvedValue("7.0.0"),
|
||||
executeRequest: jest.fn(),
|
||||
baseURL: 'http://localhost/zabbix'
|
||||
}
|
||||
|
|
|
|||
|
|
@ -6,6 +6,7 @@ import {zabbixAPI} from '../datasources/zabbix-api.js';
|
|||
jest.mock("../datasources/zabbix-api.js", () => ({
|
||||
zabbixAPI: {
|
||||
post: jest.fn(),
|
||||
getVersion: jest.fn().mockResolvedValue("7.0.0"),
|
||||
executeRequest: jest.fn(),
|
||||
baseURL: 'http://localhost/zabbix',
|
||||
requestByPath: jest.fn()
|
||||
|
|
|
|||
|
|
@ -7,6 +7,7 @@ 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"
|
||||
|
|
@ -82,8 +83,11 @@ describe("Template Resolver", () => {
|
|||
method: "template.get",
|
||||
params: expect.objectContaining({
|
||||
search: {
|
||||
name: "Template"
|
||||
}
|
||||
name: "Template",
|
||||
host: "Template"
|
||||
},
|
||||
searchByAny: true,
|
||||
searchWildcardsEnabled: true
|
||||
})
|
||||
})
|
||||
}));
|
||||
|
|
@ -105,8 +109,11 @@ describe("Template Resolver", () => {
|
|||
method: "template.get",
|
||||
params: expect.objectContaining({
|
||||
search: {
|
||||
name: "Temp%1"
|
||||
}
|
||||
name: "Temp%1",
|
||||
host: "Temp%1"
|
||||
},
|
||||
searchByAny: true,
|
||||
searchWildcardsEnabled: true
|
||||
})
|
||||
})
|
||||
}));
|
||||
|
|
|
|||
|
|
@ -6,6 +6,7 @@ jest.mock("../datasources/zabbix-api.js", () => ({
|
|||
zabbixAPI: {
|
||||
executeRequest: jest.fn(),
|
||||
post: jest.fn(),
|
||||
getVersion: jest.fn().mockResolvedValue("7.0.0"),
|
||||
baseURL: "http://mock-zabbix"
|
||||
}
|
||||
}));
|
||||
|
|
|
|||
|
|
@ -8,6 +8,7 @@ import {zabbixAPI} from '../datasources/zabbix-api.js';
|
|||
jest.mock("../datasources/zabbix-api.js", () => ({
|
||||
zabbixAPI: {
|
||||
post: jest.fn(),
|
||||
getVersion: jest.fn().mockResolvedValue("7.0.0"),
|
||||
executeRequest: jest.fn(),
|
||||
baseURL: 'http://localhost/zabbix',
|
||||
getLocations: jest.fn(),
|
||||
|
|
@ -43,7 +44,8 @@ describe("User Rights Integration Tests", () => {
|
|||
.mockResolvedValueOnce([{ groupid: "101", name: "Group1", uuid: "uuid1" }]) // templategroup.get for groups (in prepare)
|
||||
.mockResolvedValueOnce([{ groupid: "201", name: "ConstructionSite/Test", uuid: "uuid2" }]) // hostgroup.get for groups (in prepare)
|
||||
.mockResolvedValueOnce([{ usrgrpid: "1", name: "Test Group" }]) // usergroup.get
|
||||
.mockResolvedValueOnce({ usrgrpids: ["1"] }); // usergroup.update
|
||||
.mockResolvedValueOnce({ usrgrpids: ["1"] }) // usergroup.update
|
||||
.mockResolvedValueOnce({ usrgrpids: [] }); // hostgroup.propagate
|
||||
|
||||
const response = await server.executeOperation({
|
||||
query: mutation,
|
||||
|
|
|
|||
|
|
@ -8,6 +8,7 @@ import {zabbixAPI} from '../datasources/zabbix-api.js';
|
|||
jest.mock("../datasources/zabbix-api.js", () => ({
|
||||
zabbixAPI: {
|
||||
post: jest.fn(),
|
||||
getVersion: jest.fn().mockResolvedValue("7.0.0"),
|
||||
executeRequest: jest.fn(),
|
||||
baseURL: 'http://localhost/zabbix',
|
||||
getLocations: jest.fn(),
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue