SaveTest TMS Plugin for VS Code

A VS Code extension for working with test cases in SaveTest TMS format. Provides convenient creation, editing, and validation of YAML test case files with a visual editor.

This plugin is part of the SaveTest platform - a comprehensive test management system for creating, organizing, and executing test cases.

Features

Creation and Editing

• Creation Commands - Quick creation of test suites and test cases
• Snippets - Premade templates for all structural elements
• Hotkeys - Quick work with frequently used commands
• UUID Auto-generation - Automatic creation of unique identifiers

Validation and Hints

• YAML Schema Validation - Structure and data type checking
• Auto-completion - Hints for fields and values
• Hover Tooltips - Field descriptions on hover
• Diagnostics - Error display in the Problems panel
• Quick Fix - Automatic correction of common errors

Visual Editor

• Split Mode - Test case list and details side by side
• Tree Mode - Test case list only
• Details Mode - Details of selected test case only
• Search and Filter - Quick search through test cases
• Drag & Drop - Change element order

Templates

• Custom Templates - Configuration via .save-test config file

Getting Started

Project Initialization

1. Open the project folder in VS Code
2. Open Command Palette (Ctrl+Shift+P / Cmd+Shift+P)
3. Run the command SaveTest: Initialize Project

This will create the following structure:

tests/
├── test-case/
│   ├── cases/          # Project test cases
│   ├── common-case/    # Common cases
│   └── attach/         # Attachments
.save-test              # Project configuration

Creating a Test Suite

1. Right-click on a directory in the explorer
2. Run SaveTest: Create Test Suite
3. The test-suite.yaml file will be created automatically

Working with Test Cases

Via Visual Editor

1. Open the test-suite.yaml file
2. Click on the editor icon in the top right

Via YAML Editor

1. Use snippets (start typing test-case and press Tab)
2. Use hotkeys:
   • Ctrl+Shift+T/Cmd+Shift+T - Insert short test case
   • Ctrl+Shift+Alt+T/Cmd+Shift+Alt+T - Insert full test case
   • Ctrl+Shift+S/Cmd+Shift+S - Insert step

Commands

Main Commands

• SaveTest: Initialize Project - Create project structure
• SaveTest: Create Test Suite - Create a new test suite
• SaveTest: Add Test Case - Add a test case to the open suite
• SaveTest: Generate UUID - Generate UUID
• SaveTest: Validate IDs - Check identifier uniqueness
• SaveTest: Refresh Tree - Refresh Tree View

Insert Commands

• SaveTest: Insert Test Case (Short) - Short template
• SaveTest: Insert Test Case (Full) - Full template with all fields
• SaveTest: Insert Step - Test case step
• SaveTest: Insert Precondition - Precondition
• SaveTest: Insert Postcondition - Postcondition
• SaveTest: Insert Iteration - Iteration with parameters
• SaveTest: Insert Common Case - Reference to a common case
• SaveTest: Insert Attachment - Attachment

Template Commands

• SaveTest: Open Configuration File - Open .save-test
• SaveTest: Reload Templates - Re-read configuration
• SaveTest: Reset Templates to Default - Remove custom templates

Test Suite Structure

suite_id: "uuid"                    # Required, UUID format
suite_name: "Name"                  # Required
description: "Description"          # Optional
status: "new|in progress|done|archived"  # Optional
created_at: "2024-01-01T00:00:00Z"  # Optional, ISO 8601
created_by: "author"                # Optional
test_cases:                         # Required, array
  - case_id: "uuid"                 # Required, UUID format
    title: "Title"                  # Required
    description: "Description"      # Optional
    estimatedTime: "2m"             # Optional
    priority: "high|medium|low"     # Optional
    tags:                           # Optional
      - "tag1"
      - "tag2"
    environment:                    # Optional
      - name: "Browser"
        value: "Chrome"
    pre-conditions:                 # Optional
      - action: "Action"
        expected_result: "Result"
    steps:                          # Optional
      - action: "Action"
        expected_result: "Result"
    post-conditions:                # Optional
      - action: "Action"
        expected_result: "Result"

Made by team SaveLink (save-link.ru)