feat: add Zabbix 7.4 documentation samples and importHostGroups MCP tool
This commit introduces a comprehensive set of GraphQL query and mutation samples based on the official Zabbix 7.4 API documentation, along with testing and automation improvements. Changes: - Documentation: - Added 21 GraphQL sample files in docs/queries/from_zabbix_docs/ covering various Zabbix API operations. - Updated docs/howtos/cookbook.md with a new recipe for executing these documentation samples. - AI & MCP: - Added mcp/operations/importHostGroups.graphql to enable host group import via MCP tools. - Testing: - Added src/test/zabbix_docs_samples.test.ts to automatically validate all documentation samples against the GraphQL schema.
This commit is contained in:
parent
9a79fc8e4c
commit
b56255ffaa
24 changed files with 626 additions and 0 deletions
81
src/test/zabbix_docs_samples.test.ts
Normal file
81
src/test/zabbix_docs_samples.test.ts
Normal file
|
|
@ -0,0 +1,81 @@
|
|||
import {ApolloServer} from '@apollo/server';
|
||||
import {schema_loader} from '../api/schema.js';
|
||||
import {readdirSync, 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(),
|
||||
executeRequest: jest.fn(),
|
||||
baseURL: 'http://localhost/zabbix',
|
||||
getLocations: jest.fn(),
|
||||
requestByPath: jest.fn()
|
||||
}
|
||||
}));
|
||||
|
||||
describe("Zabbix Docs Samples Integration Tests", () => {
|
||||
let server: ApolloServer;
|
||||
|
||||
beforeAll(async () => {
|
||||
const schema = await schema_loader();
|
||||
server = new ApolloServer({
|
||||
schema,
|
||||
});
|
||||
});
|
||||
|
||||
const samplesDir = join(process.cwd(), 'docs', 'queries', 'from_zabbix_docs');
|
||||
const files = readdirSync(samplesDir).filter(f => f.endsWith('.graphql'));
|
||||
|
||||
test.each(files)("Sample %s should execute successfully", async (file) => {
|
||||
const filePath = join(samplesDir, file);
|
||||
const content = readFileSync(filePath, 'utf-8').replace(/\r\n/g, '\n');
|
||||
|
||||
const queryMatch = content.match(/```graphql\n([\s\S]*?)\n```/);
|
||||
const variablesMatch = content.match(/```json\n([\s\S]*?)\n```/);
|
||||
|
||||
if (!queryMatch) {
|
||||
throw new Error(`No graphql block found in ${file}`);
|
||||
}
|
||||
|
||||
const query = queryMatch[1];
|
||||
const variables = variablesMatch ? JSON.parse(variablesMatch[1]) : {};
|
||||
|
||||
// Setup a generic mock response based on the operation
|
||||
(zabbixAPI.post as jest.Mock).mockImplementation((method: string) => {
|
||||
if (method.includes('login')) return Promise.resolve("test-token");
|
||||
if (method.includes('logout')) return Promise.resolve(true);
|
||||
if (method.includes('get')) return Promise.resolve([]);
|
||||
if (method.includes('create')) {
|
||||
if (method.includes('host')) return Promise.resolve({hostids: ["10001"]});
|
||||
if (method.includes('group')) return Promise.resolve({groupids: ["50"]});
|
||||
if (method.includes('template')) return Promise.resolve({templateids: ["20001"]});
|
||||
return Promise.resolve({ids: ["1"]});
|
||||
}
|
||||
if (method.includes('delete')) return Promise.resolve({ids: ["1"]});
|
||||
if (method.includes('version')) return Promise.resolve("7.4.0");
|
||||
return Promise.resolve({});
|
||||
});
|
||||
|
||||
// Some operations use requestByPath or other methods
|
||||
(zabbixAPI.requestByPath as jest.Mock).mockResolvedValue({ hostids: ["10001"], groupid: "50", templateid: "20001" });
|
||||
|
||||
const response = await server.executeOperation({
|
||||
query: query,
|
||||
variables: variables,
|
||||
}, {
|
||||
contextValue: { zabbixAuthToken: 'test-token', dataSources: { zabbixAPI: zabbixAPI } }
|
||||
});
|
||||
|
||||
if (response.body.kind === 'single') {
|
||||
const result = response.body.singleResult;
|
||||
if (result.errors) {
|
||||
console.error(`Errors in ${file}:`, JSON.stringify(result.errors, null, 2));
|
||||
}
|
||||
expect(result.errors).toBeUndefined();
|
||||
} else {
|
||||
throw new Error(`Unexpected response kind: ${response.body.kind}`);
|
||||
}
|
||||
});
|
||||
});
|
||||
Loading…
Add table
Add a link
Reference in a new issue