Andreas Hilbig b84e4c0734 feat: implement comprehensive testing framework and regression suite

- Established a centralized test specification in docs/tests.md that defines test categories, cases, and a coverage checklist to ensure consistent quality and maintainability across the project.

- Implemented RegressionTestExecutor for managing automated regression tests on a live Zabbix system.

- Updated GraphQL schema and resolvers with a generic runAllRegressionTests mutation.

- Enhanced MCP integration with new operation files and detailed documentation for AI-driven automation.

- Updated README.md and How-To guides (Cookbook, Maintenance, MCP) to reflect the new testing framework and MCP capabilities.

- Verified all changes with a full Jest suite (74 tests) and live end-to-end smoketests.

2026-02-01 05:05:55 +01:00

2.1 KiB

Raw Blame History

Technical Maintenance Guide

This guide covers the technical aspects of maintaining and developing the Zabbix GraphQL API.

🛠️ Development & Maintenance Tasks

Code Generation

The project uses GraphQL Codegen to generate TypeScript types from the GraphQL schema. This ensures type safety and consistency between the schema and the implementation.

Configuration: codegen.ts
Generated Output: src/schema/generated/graphql.ts

How to Regenerate Types

Whenever you modify any .graphql files in the schema/ directory, you must regenerate the TypeScript types.

For a one-off update (e.g. in a script or before commit):

npx graphql-codegen --config codegen.ts

If you are a developer and want to watch for schema changes continuously:

npm run codegen

Testing

We use Jest for unit and integration testing.

Test Directory: src/test/
Execution:
```
npm run test
```

Adding New Tests

Location: Place new test files in src/test/ with the .test.ts extension.
Coverage: Ensure you cover both successful operations and error scenarios.
Test Specification: Every new test must be documented in the Test Specification.
Best Practice: If you find a bug, first create a reproduction test in src/test/ to verify the fix.

🔄 Updating Dependencies

To keep the project secure and up-to-date:

Check for updates: npm outdated
Update packages: npm update
Verify with tests: npm run test

🐳 Docker Image Maintenance

The Dockerfile uses a multi-stage build to keep the production image small and secure.

Base Image: Node 24 (LTS)
Build Argument: API_VERSION (used to embed the version into the image)

To build a fresh image locally:

docker build -t zabbix-graphql-api --build-arg API_VERSION=$(git describe --tags --always) .

Related Reference: Project Configuration Reference Related Cookbook: Extending the Schema

2.1 KiB Raw Blame History