Extension Features

The Quadrastack VS Code extension provides tools for running API tests and managing mock servers directly from your editor.

---

Running Requests

Execute HTTP requests directly from your YAML files without leaving VS Code.

1. Open a YAML file containing requests
2. Click the Run button that appears above each request
3. View the response in the panel on the right

The response panel shows:

• Status code - HTTP status (200, 404, etc.)
• Headers - Response headers
• Body - Response body with syntax highlighting
• Time - Request duration

---

Running Scenarios

Execute test scenarios that run multiple requests with label-based filtering.

1. Open a YAML file containing scenarios
2. Click the Run button above the scenario definition
3. View results showing pass/fail status for each request

The results panel displays:

• Overall pass/fail status
• Individual request outcomes
• Assertion results
• Error messages for failed tests

---

Mock Servers

Manage mock servers from the VS Code sidebar without using the command line.

The Mock Servers panel in the Activity Bar shows:

• List of configured mock servers
• Current status (running/stopped)
• Quick actions for each server

For each mock server, you can:

Action	Description
Start	Start the mock server
Stop	Stop a running server
Restart	Stop and start the server

You can also start/stop mock servers directly from YAML files by clicking the Start/Stop button above mockServer definitions.

---

Playbook Configuration

Configure the playbook directory and CLI settings for your workspace.

Set Playbook Directory: Right-click any folder in Explorer → Set as Playbook Directory

Configure CLI Path: Add to .vscode/settings.json:

{
  "quadrastack.playbookRoot": "./playbooks",
  "quadrastack.cliPath": "/usr/local/bin/quadrastack"
}

Setting	Description	Default
quadrastack.playbookRoot	Path to playbook directory	Workspace root
quadrastack.cliPath	Path to CLI executable	quadrastack

---

Syntax Highlighting

The extension provides syntax highlighting for Quadrastack playbook files:

• Object types: requests, workflows, scenarios, vars, mocks, mockServer
• HTTP methods: GET, POST, PUT, PATCH, DELETE
• Template syntax: {{.vars.baseUrl}}, {{.session.login.body.token}}
• Assertion keywords: expect, status, body, headers

---

Schema Validation

Real-time validation catches errors as you type:

• YAML syntax errors
• Missing required properties (like url for requests)
• Invalid HTTP methods
• Type mismatches

Open the Problems panel (Ctrl+Shift+M or Cmd+Shift+M) to see all validation errors.

---

IntelliSense

Get autocomplete suggestions while writing playbooks.

• Automatic: Appears as you type
• Manual: Press Ctrl+Space (or Cmd+Space on macOS)

Suggests:

• Object types at root level (requests, workflows, scenarios)
• Request properties (method, url, headers, body, expect)
• HTTP methods (GET, POST, PUT, etc.)
• Template functions

---

Code Snippets

Quick templates for common patterns. Type the prefix and press Tab.

Prefix	Description
req	Basic request template
reqpost	POST request with body
wf	Workflow with steps
scn	Scenario template
mock	Mock server and endpoint
vars	Variables with profiles

---

Next Steps

• Installation - Setup and configuration
• Playbook Guide - Writing playbooks