diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..616c0dc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,41 @@ +name: Bug report +description: Report incorrect behavior with a reproducible example. +body: + - type: markdown + attributes: + value: | + For security vulnerabilities, use [private reporting](https://github.com/batchstream/weir-tests/security/advisories/new). + Remove credentials, private endpoints and document data from logs and configuration. + - type: input + id: version + attributes: + label: Commit + description: Commit SHA of this repository. + validations: + required: true + - type: textarea + id: environment + attributes: + label: Environment + description: OS, Docker and Go versions, and the Weir revision pinned in `versions.json`. + validations: + required: true + - type: textarea + id: reproduction + attributes: + label: Steps to reproduce + description: Include the smallest request, script or test case that reproduces the problem. + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected and actual behavior + validations: + required: true + - type: textarea + id: diagnostics + attributes: + label: Logs and configuration + description: Relevant, redacted diagnostics. For performance issues, include the workload and resource limits. + render: text diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..77efea7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,11 @@ +blank_issues_enabled: true +contact_links: + - name: Documentation + url: https://github.com/batchstream/weir-tests#readme + about: Usage and development guide for this repository. + - name: Weir server issues + url: https://github.com/batchstream/weir/issues + about: Report problems specific to the Weir server. + - name: Security vulnerability + url: https://github.com/batchstream/weir-tests/security/advisories/new + about: Report a vulnerability privately. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..2bd8ebf --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,22 @@ +name: Feature request +description: Propose an improvement to the Weir system tests. +body: + - type: textarea + id: problem + attributes: + label: Problem or use case + description: What are you trying to achieve, and what is difficult today? + validations: + required: true + - type: textarea + id: proposal + attributes: + label: Proposed behavior + description: Describe the desired API or user experience, with an example if possible. + validations: + required: true + - type: textarea + id: alternatives + attributes: + label: Alternatives and constraints + description: Existing workarounds, affected backends and operational constraints. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..17c254e --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,4 @@ + + + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b057b94 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,35 @@ +# Contributing to the Weir system tests + +New scenarios, fixes, documentation improvements and proposals are welcome. Problems +in the product itself belong to the [server](https://github.com/batchstream/weir/issues) or +[Go SDK](https://github.com/batchstream/weir-go/issues) repositories. + +## Report a problem + +Use the issue forms and include the commit of this repository, the Weir revision +pinned in `versions.json`, the OS and Docker versions, the command and its output. +Remove credentials and private data from logs. + +For vulnerabilities, follow [SECURITY.md](SECURITY.md). + +## Work locally + +Install Go, Python 3, `jq` and a local Docker daemon with a Unix socket. + +```sh +git clone https://github.com/batchstream/weir-tests.git +cd weir-tests +make prepare +make test +make integration +``` + +`make test` launches no databases or Weir processes. See +[Native MongoDB fixture](README.md#native-mongodb-fixture) for the fixture option. + +## Prepare a pull request + +- Keep the change focused and explain the observed problem and resulting behavior. +- Add a regression test when fixing behavior. +- Use only the published SDK and protocol; this module imports no server packages. +- Keep generated output under the ignored `results/` directory. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..6e5a0e7 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 Randy + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 637e9c7..74198dd 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # Weir system tests +[![CI](https://github.com/batchstream/weir-tests/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/batchstream/weir-tests/actions/workflows/ci.yml) [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE) + Independent blackbox integration tests and database throughput comparisons for [Weir](https://github.com/batchstream/weir). This module uses the published Go SDK and public protocol. It imports no server packages. diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..4801da6 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,16 @@ +# Security policy + +## Report a vulnerability + +Use GitHub's private +[Report a vulnerability](https://github.com/batchstream/weir-tests/security/advisories/new) +form. Include the affected repository version or commit, reproduction steps, impact, +and relevant deployment settings with credentials and private data removed. +Please keep exploit details out of public issues while a report is being +investigated. + +## Versions + +This repository holds test tooling and has no releases; check `main`. Report +vulnerabilities in the server or SDK to [weir](https://github.com/batchstream/weir/security/advisories/new) +or [weir-go](https://github.com/batchstream/weir-go/security/advisories/new).