Skip to content

Commit b973461

Browse files
committed
docs: add comprehensive testing strategy guide
Add docs/testing.md covering all test layers in detail: unit tests, storage conformance, integration, concurrency, BDD (76 feature files, ~1400 scenarios), API endpoint, auth (LDAP/OIDC/Vault), migration, Confluent wire-compatibility, and OpenAPI validation. Includes test pyramid, quick reference table, pre-commit workflow, and guidance on which tests to write for each type of change. Also fix Karapace OIDC/OAuth2 in feature comparison (supports it), add Confluent trademark to legal notices, update Overview link to point AxonOps to axonops.com, and add testing doc to README table.
1 parent ea270d4 commit b973461

File tree

2 files changed

+705
-2
lines changed

2 files changed

+705
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
## Overview
1919

20-
[AxonOps Schema Registry](https://github.com/axonops/axonops-schema-registry) is a **schema registry for Apache Kafka** that manages and enforces schemas for event-driven architectures. It stores versioned Avro, Protobuf, and JSON Schema definitions, validates compatibility between schema versions, and ensures producers and consumers agree on data formats.
20+
[AxonOps](https://axonops.com) Schema Registry is a **schema registry for Apache Kafka** that manages and enforces schemas for event-driven architectures. It stores versioned Avro, Protobuf, and JSON Schema definitions, validates compatibility between schema versions, and ensures producers and consumers agree on data formats.
2121

2222
Unlike Confluent Schema Registry, which uses Kafka itself (a special `_schemas` topic) as its storage backend, AxonOps Schema Registry **does not require Kafka** for storage -- it uses standard databases (PostgreSQL, MySQL, or Cassandra) while remaining **fully API-compatible** with Confluent's REST API, serializers, and client libraries.
2323

@@ -76,7 +76,7 @@ Unlike Confluent Schema Registry, which uses Kafka itself (a special `_schemas`
7676
| **Basic Auth** |||||
7777
| **API Keys** |||||
7878
| **LDAP/AD** |||||
79-
| **OIDC/OAuth2** |||| |
79+
| **OIDC/OAuth2** |||| |
8080
| **mTLS** |||||
8181
| **RBAC** |||| ⚠️ Limited |
8282
| **Audit Logging** |||||
@@ -228,6 +228,7 @@ AxonOps Schema Registry implements the Confluent Schema Registry REST API v1:
228228
| [Deployment](docs/deployment.md) | Topologies, Docker Compose, Kubernetes manifests, systemd, and health checks |
229229
| [Monitoring](docs/monitoring.md) | Prometheus metrics, alerting rules, structured logging, and Grafana queries |
230230
| [Migration](docs/migration.md) | Migrating from Confluent Schema Registry with preserved schema IDs |
231+
| [Testing Strategy](docs/testing.md) | Testing philosophy, all test layers, how to run and write tests |
231232
| [Development](docs/development.md) | Building from source, running the test suite, and contributing |
232233
| [Troubleshooting](docs/troubleshooting.md) | Common issues, diagnostic commands, and error code reference |
233234

@@ -296,6 +297,7 @@ Apache License 2.0 -- see [LICENSE](LICENSE) for details.
296297

297298
- **AxonOps** is a registered trademark of AxonOps Limited.
298299
- **Apache**, **Apache Cassandra**, **Cassandra**, **Apache Kafka**, and **Kafka** are either registered trademarks or trademarks of the Apache Software Foundation or its subsidiaries in Canada, the United States, and/or other countries.
300+
- **Confluent** is a registered trademark of Confluent, Inc.
299301

300302
---
301303

0 commit comments

Comments
 (0)