Skip to content

[TESTING]: QA plan for shortlist of plugins #1419

@monshri

Description

@monshri

✅ Test Summary

Create a shortlist of security plugins and make it production ready for client adoption.

Plugins:

  • Guardrails (llmguard)
  • PII filter
  • OPA
  • RBAC plugin using Cedar
  • Secret detection
  • Auth claims extraction plugin
  • Auth delegation plugin

Things to ensure readiness

  • Documentation
  • Unit Tests
  • Error handling and logs
  • Configuration and environment variables
  • Performance and Load testing
  • Deployment, build passes in CI/CD pipeline without errors.

🧪 Test Type

Choose one or more applicable categories:

  • Unit tests (Python)
  • Integration / end-to-end tests

🧬 Scope & Affected Components

Select what this test covers or validates:

  • mcpgateway core (API logic, handlers)
  • Admin UI (HTMX / Alpine / Tailwind)
  • Tool/Resource/Prompt logic
  • Federation sync/discovery
  • Server interactions or SSE
  • Auth / JWT / security flows
  • Observability (logging, metrics)
  • Makefile, shell scripts or CLI
  • Containerized setup (Docker/Podman)
  • Other (explain below)

📋 Acceptance Criteria

What should pass or be verified?

  • All relevant assertions are covered
  • No side-effects or regressions observed
  • Confirmed in multiple environments (if needed)
  • Edge cases and error handling tested
  • Logs and output are clean and expected

📓 Notes & Steps

Include commands, expected behaviors, or test strategy.

# Example: run coverage locally
make test coverage
pytest tests/test_example.py

🧠 Environment Info (if manual testing)

Key Value
Gateway version e.g. main@a1b2c3d
Python version e.g. 3.11
Transport tested http, ws, sse, stdio
OS / Platform e.g. macOS, Ubuntu
Container e.g. Docker, Podman, none

If applicable (ex: new type of test) add information on how to set this up using CI/CD with GitHub Actions or contribute directly to the workflow in .github/workflows


📎 Related PRs / Issues (optional)

Link any relevant work.

Metadata

Metadata

Labels

SHOULDP2: Important but not vital; high-value items that are not crucial for the immediate releasepluginstestingTesting (unit, e2e, manual, automated, etc)

Type

No fields configured for Task.

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions