GUS Test Suite Automation Extension

A VS Code extension for automating GUS Test Suite tasks, including GitHub PR management and GUS authentication.

Installation

1. Copy the gustestsuiteautomation-1.0.0.vsix file to your local machine
2. Open Cursor
3. Open the Command Palette (Cmd+Shift+P or Ctrl+Shift+P)
4. Type "Extensions: Install from VSIX" and select it
5. Navigate to and select the gustestsuiteautomation-1.0.0.vsix file

Uninstallation

To uninstall the extension, run the following command in your terminal:

code --uninstall-extension gustestsuite.gustestsuiteautomation

After uninstalling, you'll need to reload the Cursor window for the changes to take effect. You can do this by:

• Using the keyboard shortcut: Cmd+Shift+P (Mac) or Ctrl+Shift+P (Windows/Linux), then type "Reload Window"
• Or using the keyboard shortcut: Cmd+R (Mac) or Ctrl+R (Windows/Linux)

Available Commands

Let's Gusify Tests

• Command: gustestsuiteautomation.letsGusifyTests
• Description: Open the test gusification interface
• Usage: Open Command Palette and type "Let's Gusify Tests"
• Features:
  • PR link parsing for GitCore, GitSoma, and GitHub
  • Automatic repository type detection
  • Token management for each repository type
  • Work item extraction from PR description
  • Theme retrieval from GUS
  • Test suite generation
  • Interactive test scenario management

Gusify My Work Items

• Command: gustestsuiteautomation.gusifyMyWork
• Description: Gusify work items based on Epic and Release filters
• Usage: Open Command Palette and type "Gusify My Work Items"
• Features:
  • Epic Filter: Filter work items by specific Epic (name or ID)
  • Release Filter: Filter work items by specific Release/Build
  • Date Range: Optional date range filtering for work items
  • Automatic PR Discovery: Finds all PRs associated with filtered work items
  • Multi-Repository Support: Works with GitCore, GitSoma, and GitHub PRs
  • Bulk Processing: Process multiple work items and their PRs simultaneously
  • Test Suite Generation: Automatically generates test suites for all discovered PRs
• Workflow:
  1. Select Epic (optional): Choose a specific Epic to filter work items
  2. Select Release (optional): Choose a specific Release/Build to filter work items
  3. Set Date Range (optional): Define a date range for work item filtering
  4. Click "Fetch my work Items": The extension will:
     • Fetch work items matching your criteria
     • Discover all associated PRs across repositories
     • Generate test suites for each PR
     • Display results in organized test scenario panels
• Use Cases:
  • Generate test suites for all PRs in a specific Epic
  • Process work items for a particular release
  • Bulk test generation for multiple related work items
  • Historical analysis of work items within a date range

Set Git Core Token

• Command: gustestsuiteautomation.setGitHubToken
• Description: Securely store your Git Core token for authentication
• Usage: Open Command Palette and type "Set Git Core Token"
• Note: The token is stored securely in VS Code's secret storage
• How to obtain token:
  1. Go to GitCore
  2. Click on your profile picture in the top right
  3. Select "Settings"
  4. In the left sidebar, click on "Access Tokens"
  5. Click "Generate New Token"
  6. Give your token a descriptive name
  7. Select the required scopes:
     • repo (Full control of private repositories)
     • read:org (Read organization data)
  8. Click "Generate Token"
  9. Copy the token immediately - you won't be able to see it again!

Clear Git Core Token

• Command: gustestsuiteautomation.clearGitHubToken
• Description: Remove the stored Git Core token
• Usage: Open Command Palette and type "Clear Git Core Token"

Set Git Soma Token

• Command: gustestsuiteautomation.setGitSomaToken
• Description: Securely store your Git Soma token for authentication
• Usage: Open Command Palette and type "Set Git Soma Token"
• Note: The token is stored securely in VS Code's secret storage
• How to obtain token:
  1. Go to GitSoma
  2. Click on your profile picture in the top right
  3. Select "Settings"
  4. In the left sidebar, click on "Access Tokens"
  5. Click "Generate New Token"
  6. Give your token a descriptive name
  7. Select the required scopes:
     • repo (Full control of private repositories)
     • read:org (Read organization data)
  8. Click "Generate Token"
  9. Copy the token immediately - you won't be able to see it again!

Clear Git Soma Token

• Command: gustestsuiteautomation.clearGitSomaToken
• Description: Remove the stored Git Soma token
• Usage: Open Command Palette and type "Clear Git Soma Token"

Set Git Token

• Command: gustestsuiteautomation.setGitToken
• Description: Securely store your GitHub token for authentication
• Usage: Open Command Palette and type "Set Git Token"
• Note: The token is stored securely in VS Code's secret storage
• How to obtain token:
  1. Go to GitHub
  2. Click on your profile picture in the top right
  3. Select "Settings"
  4. Scroll down to "Developer settings" in the left sidebar
  5. Click on "Personal access tokens" → "Tokens (classic)"
  6. Click "Generate new token" → "Generate new token (classic)"
  7. Give your token a descriptive name
  8. Set an expiration date (recommended: 90 days)
  9. Select the required scopes:
     • repo (Full control of private repositories)
     • read:org (Read organization data)
  10. Click "Generate token"
  11. Copy the token immediately - you won't be able to see it again!

Clear Git Token

• Command: gustestsuiteautomation.clearGitToken
• Description: Remove the stored GitHub token
• Usage: Open Command Palette and type "Clear Git Token"

Authenticate with GUS

• Command: gustestsuiteautomation.authenticateGUS
• Description: Authenticate with GUS using your credentials
• Usage:
  1. Open Command Palette and type "Authenticate with GUS"
  2. Enter your username
  3. Enter your SSO password
  4. Enter your Okta 2FA token
• Features:
  • Secure credential handling
  • Token persistence for future use
  • Automatic token management
• Authentication Methods:

  1. Standard Authentication (Recommended):

     • Enter your GUS credentials:
       • Username: your.email@gus.com
       • Password: your SSO password
       • Okta 2FA Token: the 6-digit code from your Okta authenticator app
     • The extension will automatically handle the authentication process

  2. Workbench Access Token (Alternative):

     • If you're experiencing issues with the standard authentication method:
       1. Open Workbench
       2. Click "Login with Salesforce"
       3. Enter your GUS credentials
       4. After successful login, click on "Info" → "Session Information"
       5. Copy the "Session ID" value
       6. In VS Code:
          • Open Command Palette (Cmd+Shift+P or Ctrl+Shift+P)
          • Type "Set GUS Token" and select it
          • Paste the Session ID when prompted

Clear GUS Token

• Command: gustestsuiteautomation.clearGUSToken
• Description: Remove the stored GUS authentication token
• Usage: Open Command Palette and type "Clear GUS Token"
• Note: This will require re-authentication for future GUS operations

Features

• Support for multiple Git repositories:
  • GitCore (gitcore.soma.salesforce.com)
  • GitSoma (git.soma.salesforce.com)
  • GitHub (github.com)
• PR link parsing and automatic repository detection
• Secure token management for each repository type
• Work item extraction from PR descriptions
• Theme retrieval from GUS
• Test suite generation and management
• Interactive test scenario editing
• GUS authentication and integration
• Token persistence for all operations
• Modern and responsive UI
• Real-time loading indicators
• Error handling and user feedback
• Work Item Management:
  • Epic and Release-based work item filtering
  • Date range filtering for work items
  • Automatic PR discovery across repositories
  • Bulk processing of multiple work items
  • Separate full-screen panels for test scenarios
  • Work item context in test panel titles

Development

To modify or extend this extension:

1. Clone the repository
2. Run npm install
3. Make your changes
4. Press F5 to start debugging
5. Use vsce package to create a new VSIX file

Building the Extension

To build the extension, run:

npm run compile

To package the extension into a VSIX file, run:

npx vsce package

Extension Settings