Skip to content

docs: reorganize examples directory and fix test issues#453

Merged
gibiw merged 3 commits intomainfrom
docs/reorganize-examples-documentation
Feb 9, 2026
Merged

docs: reorganize examples directory and fix test issues#453
gibiw merged 3 commits intomainfrom
docs/reorganize-examples-documentation

Conversation

@gibiw
Copy link
Contributor

@gibiw gibiw commented Feb 9, 2026

Summary

  • Reorganize examples/ directory with unified structure (single/ and multiproject/)
  • Unify README format across all frameworks with consistent sections
  • Improve test examples with realistic scenarios
  • Fix various issues found during testing

Changes

Documentation

  • Unified README format across pytest, behave, robotframework, and tavern examples
  • Each README now includes: Features, Quick Start, Running Tests, Examples, and Advanced sections
  • Consistent structure between single-project and multi-project examples

Test Examples Improvements

  • Rewritten pytest examples with realistic scenarios (login, checkout, validation)
  • Rewritten behave feature files with proper step definitions
  • Robot Framework tests with data-driven examples
  • Tavern tests demonstrating API testing patterns

Bug Fixes

  • Fixed duplicate QaseIDs in Behave features (assigned unique ranges per file)
  • Fixed @qase.fields syntax in Behave (replaced spaces with underscores)
  • Fixed @qase.ignore() to include parentheses in pytest
  • Fixed @qase.suite() to use dot notation for nested suites
  • Added missing step definitions for all Behave scenarios
  • Updated .gitignore with qase.lock and Robot Framework outputs

Test plan

  • Pytest: 40 tests passed
  • Behave: 50 scenarios passed
  • Robot Framework: 16 tests passed (dry-run)
  • Tavern: 15 tests collected

gibiw added 3 commits February 9, 2026 20:58
- Add examples/single/README.md with single-project mode overview
- Unify README format across all framework examples (pytest, behave, robot, tavern)
- Rename pytest test files to follow test_*.py naming convention
- Update multiproject README with DEMO1/DEMO2 project codes
- Add comprehensive code examples and documentation links
Rewrite all example tests across frameworks to demonstrate practical
usage patterns with meaningful test scenarios:

Pytest:
- test_basic.py: Auth, shopping cart, password validation, severity levels
- test_steps.py: Login flows, checkout, nested steps, data validation
- test_attachments.py: JSON/CSV/HTML reports, performance metrics, API logs

Behave:
- simple.feature: Login, payment, password reset scenarios
- suites.feature: OAuth, security, session management with nested suites
- parametrized.feature: Role access, email validation, discount calculations
- steps.py: Comprehensive step definitions for all scenarios

Robot Framework:
- simple.robot: E2E flows, API validation, checkout with keyword steps
- parametrized.robot: Data-driven tests with templates for validation

Tavern:
- test_simple.tavern.yaml: CRUD operations, error handling
- test_with_id.tavern.yaml: Multi-step flows with data passing

All tests now demonstrate:
- Realistic business scenarios (e-commerce, auth, API)
- Proper use of each framework's Qase annotations
- Step tracking and attachment usage
- Metadata fields (severity, priority, layer)
- Fix duplicate QaseIDs in Behave features (unique ranges per file):
  - simple.feature: 1-6
  - suites.feature: 100-107
  - parametrized.feature: 200-204
  - attachments.feature: 300-305
- Fix @Qase.fields syntax: replace spaces with underscores in values
- Fix @qase.ignore() to include parentheses (pytest)
- Fix @qase.suite() to use dot notation for nested suites
- Add missing Behave step definitions for all scenarios
- Update .gitignore with qase.lock and Robot Framework outputs
@gibiw gibiw changed the base branch from master to main February 9, 2026 18:44
@gibiw gibiw merged commit c516587 into main Feb 9, 2026
36 checks passed
@gibiw gibiw deleted the docs/reorganize-examples-documentation branch February 9, 2026 19:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

Comments