@fromeroc9/testform 1.0.16 → 1.1.0-beta.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,4 +1,14 @@
1
- # Testform
1
+ <p align="center">
2
+ <img src="docs/public/testform-logo.svg" alt="Testform Logo" width="80" height="80" />
3
+ </p>
4
+
5
+ <h1 align="center">Testform</h1>
6
+
7
+ <p align="center">
8
+ <strong>Declarative Test-as-Code Framework for Git & Testing Platforms</strong>
9
+ </p>
10
+
11
+ ---
2
12
 
3
13
  **Testform** brings the **Test-as-Code** paradigm to your version control platforms. It transforms standard issue trackers (like GitHub) into full-fledged Test Management ecosystems. By treating your QA processes as code, it codifies issue APIs into declarative Gherkin (`.feature`) configurations that can be shared amongst team members, edited, reviewed in Pull Requests, and strictly versioned.
4
14
 
@@ -10,16 +20,6 @@ We have completely overhauled our documentation to be as intuitive and comprehen
10
20
 
11
21
  **Start here:** 👉 **[Testform Documentation Portal (docs/index.md)](docs/index.md)** 👈
12
22
 
13
- ### Quick Links
14
- - **[Getting Started](docs/getting-started.md)**: Installation, authentication, and your first `apply`.
15
- - **[Writing Tests (The DSL)](docs/writing-tests-dsl.md)**: Master the Gherkin syntax, tags, and custom fields (like `assignees` and `milestone`).
16
- - **[Configuration Guide](docs/configuration.md)**: Deep dive into the `testform.json` rules.
17
- - **[CLI Reference](docs/cli-reference.md)**: Cheat sheet for all commands (`plan`, `apply`, `import`, etc.).
18
- - **[Reporting & Analytics](docs/reporting-and-analytics.md)**: Generate execution matrices and coverage reports locally.
19
- - **[Architecture](docs/architecture.md)**: How the AST parser, state management, and GraphQL adapters work.
20
-
21
- ---
22
-
23
23
  ## Prerequisites
24
24
 
25
25
  To use Testform, it is a requirement to have an existing GitHub Project properly configured with the necessary labels and status fields.
@@ -46,45 +46,71 @@ npm install -g testform
46
46
 
47
47
  ## Quickstart (TL;DR)
48
48
 
49
- 1. Create a `testform.json` configuration file at the root of your project:
50
- ```json
51
- {
52
- "github": {
53
- "owner": "MyOrg",
54
- "repository": "MyRepo",
55
- "tokenEnv": "GITHUB_TOKEN"
56
- },
57
- "scope": {
58
- "testcase": {
59
- "fields": [
60
- { "name": "assignees", "type": "keywords" },
61
- { "name": "priority", "type": "tags", "values": ["@high", "@medium", "@low"] }
62
- ]
63
- }
64
- }
65
- }
49
+ 1. Create a `testform.yml` configuration file at the root of your project:
50
+ ```yaml
51
+ version: "1.0"
52
+ provider: local
53
+ backend: local
54
+
55
+ variable:
56
+ app_url:
57
+ type: string
58
+ default: "https://www.saucedemo.com"
59
+ environment:
60
+ type: string
61
+ default: "dev"
62
+
63
+ local:
64
+ base_url: "${var.app_url}"
65
+ login_url: "${local.base_url}"
66
+
67
+ scopes:
68
+ testcase:
69
+ match: "*.case.feature"
66
70
  ```
67
71
 
68
- 2. Initialize your workspace:
72
+ 2. Initialize your workspace (backend ledger and providers):
69
73
  ```bash
70
74
  testform init
71
75
  ```
72
76
 
73
- 3. Write a Gherkin file (e.g., `login.case.feature`):
77
+ 3. Write your Gherkin tests with variables and locals (e.g., `login.case.feature`):
74
78
  ```gherkin
75
79
  @testcase
76
80
  Feature: User Login
77
81
 
78
- @high
79
- Scenario: Valid Login
80
- * field assignees = @octocat
81
- Given the user is on the login page
82
+ @tc-1 @smoke @auth
83
+ Scenario: Valid Standard Login
84
+ Given the user navigates to "${local.login_url}"
85
+ When the user enters credentials "standard_user" / "secret_sauce"
86
+ Then the system redirects to "${var.app_url}/inventory.html"
82
87
  ```
83
88
 
84
- 4. Preview the changes and apply them to GitHub:
89
+ 4. Validate, preview, and apply your test infrastructure:
85
90
  ```bash
86
- testform plan
87
- testform apply
91
+ # Validate syntax and configuration
92
+ testform validate
93
+
94
+ # Plan execution with variable overrides (optional)
95
+ testform plan -var-file=staging.yml
96
+
97
+ # Apply to local state or remote provider
98
+ testform apply -auto-approve
99
+
100
+ # Inspect state resources using dot notation
101
+ testform state list
102
+ testform state show local_testcase.login.case.feature.@tc-1
88
103
  ```
89
104
 
90
- For full details, please visit our **[Documentation Portal](docs/index.md)**.
105
+ ---
106
+
107
+ ## 🚀 Key Features
108
+
109
+ - **Test-as-Code Engine:** Declarative management for Testcases, Testruns, and Testplans using Gherkin.
110
+ - **5-Tier Variables Precedence:** Hierarchy spanning base `main.yml`, `variable.yml`/`local.yml`, domain modules, `-var-file`, and `-var` flags with multi-pass recursive interpolation.
111
+ - **100% Offline Capability:** Full local backend (`backend: local`) and mock provider (`provider: local`) for deterministic testing without external dependencies or tokens.
112
+ - **Terraform-grade State Management:** State locking, drift detection (`diff`), manual taint/untaint lifecycle, HCL resource display (`state show`), and dependency DAG rendering (`graph`).
113
+ - **Global Flags:** `-chdir=<path>`, `-no-color`, and `-compact-warnings` supported universally across commands.
114
+
115
+ For full details, please visit our **[Documentation Portal (docs/)](docs/)**.
116
+