testql 0.1.1__tar.gz

testql-0.1.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

testql-0.1.1/PKG-INFO

@@ -0,0 +1,273 @@
+Metadata-Version: 2.4
+Name: testql
+Version: 0.1.1
+Summary: TestQL — Interface Query Language for GUI/API/encoder testing
+License-Expression: Apache-2.0
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx>=0.27
+Requires-Dist: click>=8.0
+Requires-Dist: rich>=13.0
+Requires-Dist: goal>=2.1.0
+Requires-Dist: costs>=0.1.20
+Requires-Dist: pfix>=0.1.60
+Provides-Extra: playwright
+Requires-Dist: playwright>=1.40; extra == "playwright"
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-asyncio; extra == "dev"
+Requires-Dist: goal>=2.1.0; extra == "dev"
+Requires-Dist: costs>=0.1.20; extra == "dev"
+Requires-Dist: pfix>=0.1.60; extra == "dev"
+Dynamic: license-file
+
+# TestQL — Interface Query Language for Testing
+
+
+## AI Cost Tracking
+
+![PyPI](https://img.shields.io/badge/pypi-costs-blue) ![Version](https://img.shields.io/badge/version-0.1.1-blue) ![Python](https://img.shields.io/badge/python-3.9+-blue) ![License](https://img.shields.io/badge/license-Apache--2.0-green)
+![AI Cost](https://img.shields.io/badge/AI%20Cost-$0.45-orange) ![Human Time](https://img.shields.io/badge/Human%20Time-4.0h-blue) ![Model](https://img.shields.io/badge/Model-openrouter%2Fqwen%2Fqwen3--coder--next-lightgrey)
+
+- 🤖 **LLM usage:** $0.4500 (3 commits)
+- 👤 **Human dev:** ~$400 (4.0h @ $100/h, 30min dedup)
+
+Generated on 2026-04-15 using [openrouter/qwen/qwen3-coder-next](https://openrouter.ai/qwen/qwen3-coder-next)
+
+---
+
+
+
+TestQL is a declarative DSL (Domain Specific Language) for testing GUI, REST API, and hardware encoder interfaces. It provides a simple, readable syntax for writing automated tests without programming overhead.
+
+## Installation
+
+```bash
+# Install from source
+pip install -e .
+
+# Install with development dependencies
+pip install -e ".[dev]"
+```
+
+## Requirements
+
+- Python 3.10+
+- HTTPX for API testing
+- Playwright for GUI testing (optional)
+
+## Quick Start
+
+```bash
+# Run a test scenario
+testql scenarios/tests/test-api.tql --url http://localhost:8101
+
+# Dry-run (parse + validate only)
+testql scenarios/views/connect-id-barcode.tql --dry-run
+
+# JSON output for CI integration
+testql scenarios/tests/test-api.tql --output json
+
+# Run with verbose logging
+testql scenarios/tests/test-api.tql --verbose
+```
+
+## Language Reference
+
+### Variables
+
+```testql
+SET api_url "http://localhost:8101"
+SET timeout 5000
+GET api_url              # Prints variable value
+```
+
+Variables support `${var}` and `$var` interpolation:
+
+```testql
+SET base_url "http://localhost:8101"
+API GET "${base_url}/api/devices"
+```
+
+### Logging
+
+```testql
+LOG "Starting test suite"
+LOG "Current value: ${var}"
+```
+
+### API Commands
+
+```testql
+# HTTP methods
+API GET "/api/v3/data/devices"
+API POST "/api/v3/scenarios" {"id": "ts1", "name": "Test"}
+API PUT "/api/v3/devices/123" {"status": "active"}
+API DELETE "/api/v3/scenarios/old"
+```
+
+### Assertions
+
+```testql
+# Status code assertions
+ASSERT_STATUS 200
+ASSERT_OK                  # Shorthand for 2xx status
+
+# Content assertions
+ASSERT_CONTAINS "device"
+ASSERT_CONTAINS "status": "ok"
+
+# JSON path assertions
+ASSERT_JSON data.length > 0
+ASSERT_JSON devices[0].id == "dev-001"
+ASSERT_JSON status != "error"
+```
+
+**Operators:** `==`, `!=`, `>`, `>=`, `<`, `<=`
+
+### GUI Navigation (Playwright)
+
+```testql
+# Navigation
+NAVIGATE "/connect-workshop"
+NAVIGATE "${base_url}/devices"
+
+# Interaction
+WAIT 500
+CLICK "[data-action='search']"
+INPUT "#search-input" "drager"
+CLICK "button[type='submit']"
+
+# Assertions
+ASSERT_VISIBLE "[data-testid='results']"
+ASSERT_TEXT "#status" "Connected"
+```
+
+### Hardware Encoder Commands
+
+```testql
+ENCODER_ON                    # Activate encoder mode
+ENCODER_FOCUS column1         # Focus specific column
+ENCODER_SCROLL 3              # Scroll 3 steps
+ENCODER_CLICK                 # Confirm (single click)
+ENCODER_DBLCLICK              # Cancel (double click)
+ENCODER_PAGE_NEXT             # Next page
+ENCODER_PAGE_PREV             # Previous page
+ENCODER_STATUS                # Print current encoder state
+ENCODER_OFF                   # Deactivate encoder mode
+```
+
+### Script Composition
+
+```testql
+# Include common setup
+INCLUDE "common-setup.tql"
+
+# Include relative paths
+INCLUDE "../helpers/auth.tql"
+```
+
+### Control Flow (Planned)
+
+```testql
+IF status == "ready"
+  LOG "System ready"
+ELSE ERROR "System not ready"
+
+LABEL start
+REPEAT 3 {
+  API GET "/api/ping"
+}
+GOTO start
+```
+
+## Project Structure
+
+```
+testql/
+├── testql/
+│   ├── cli.py           # Command-line interface
+│   ├── base.py          # Base test runner
+│   ├── commands/        # Command implementations
+│   ├── runners/         # Test execution runners
+│   └── reporters/       # Output formatters
+├── scenarios/           # Sample test scenarios
+│   ├── tests/          # Automated test suites
+│   ├── views/          # GUI view tests
+│   ├── diagnostics/    # System diagnostic scripts
+│   ├── examples/       # Usage examples
+│   └── recordings/     # Recorded test sessions
+├── docs/
+│   ├── testql-spec.md  # Full language specification
+│   └── recipes/        # Common testing patterns
+└── tests/              # Unit tests
+```
+
+## Scenario Organization
+
+TestQL scenarios are `.tql` files organized by category:
+
+| Directory | Purpose | Example |
+|-----------|---------|---------|
+| `scenarios/tests/` | API/integration tests | `test-api.tql` |
+| `scenarios/views/` | GUI view tests | `connect-id-barcode.tql` |
+| `scenarios/diagnostics/` | System checks | `health-check.tql` |
+| `scenarios/examples/` | Learning samples | `hello-world.tql` |
+| `scenarios/recordings/` | Recorded sessions | `user-flow-1.tql` |
+
+## CLI Options
+
+```bash
+testql <file> [options]
+
+Options:
+  --url <url>         Base URL for API tests (default: http://localhost:8101)
+  --dry-run           Parse and validate only, don't execute
+  --output <format>   Output format: text (default), json, junit
+  --verbose           Enable verbose logging
+  --timeout <ms>      Default timeout for operations
+```
+
+## Testing
+
+```bash
+# Run all tests
+pytest
+
+# Run with coverage
+pytest --cov=testql
+
+# Run specific test file
+pytest tests/test_runner.py -v
+```
+
+## Example Scenario
+
+```testql
+# scenarios/tests/test-api.tql
+
+SET base_url "http://localhost:8101"
+LOG "Testing device API"
+
+# Test GET endpoint
+API GET "${base_url}/api/v3/data/devices"
+ASSERT_OK
+ASSERT_JSON data.length > 0
+
+# Test POST endpoint
+API POST "${base_url}/api/v3/scenarios" {"name": "Test Scenario"}
+ASSERT_STATUS 201
+ASSERT_JSON data.id != null
+
+LOG "All tests passed!"
+```
+
+## Documentation
+
+- [TestQL Specification](docs/testql-spec.md) — Complete language reference
+- [Recipes](docs/recipes/) — Common testing patterns and examples
+
+## License
+
+Licensed under Apache-2.0.