TestGenie VS Code Extension Documentation

1. Overview

Extension Name: Test Genie
Publisher: Genworx.ai
Version: 1.0.0
License: MIT (or your chosen license)

Description:
TestGenie is an intelligent unit testing tool that automates the generation, execution, and validation of unit tests. The VS Code extension integrates seamlessly into your development environment, offering real-time test case generation, feedback, and in-depth reports. This extension leverages AI to enhance your testing process, making it faster, more accurate, and easier to integrate with CI/CD pipelines.

2. Features

• Automated Test Case Generation: Automatically generates unit test cases based on your code.
• Real-Time Test Execution & Validation: Executes tests instantly and provides real-time feedback on pass/fail results.
• Smart Test Refinement: AI and ML-driven test case refinement for better test accuracy.
• Seamless CI/CD Integration: Works with CI/CD tools like GitLab CI.
• Detailed Insights & Reports: Offers detailed reports on test coverage, failure analysis, and performance metrics.

3. Installation

Pre-Requisites:

• Visual Studio Code (VS Code) installed.
• Node.js (version 12.x or higher).
• GitLab (for repository integration).

Steps to Install:

1. Open VS Code.
2. Go to the Extensions view by clicking the Extensions icon on the sidebar or using the Ctrl+Shift+X shortcut.
3. In the search bar, type "TestGenie" and click on the result that matches this extension.
4. Click Install.
5. Once installed, restart VS Code for full functionality.

4. Configuration

After installation, you need to configure the extension to suit your project.

1. Open VS Code and go to the Command Palette (Ctrl+Shift+P).
2. Type TestGenie: Configure and press enter.
3. Choose your Programming Language (Python, JavaScript, TypeScript) and Test Framework (UnitTest, PyTest, Mocha, etc.).
4. Connect your source control (GitLab) to allow TestGenie to access your repository.

5. Usage

Step 1: Upload Your Code

After installation, click on the TestGenie icon in the sidebar.
Click Upload Code to link your project directory or Git repository.
TestGenie will automatically detect the programming language and test framework.

Step 2: Generate Test Cases

Click the Generate Tests button. TestGenie will analyze your code and generate unit tests for any untested or under-tested code paths.
Generated tests will appear in the TestGenie panel.

Step 3: Run Tests

After generating tests, click the Run Tests button to execute them.
Test results will be shown in real-time in the TestGenie panel, with details about passing and failing tests.

Step 4: Review Reports

TestGenie provides detailed feedback and reports.
Navigate to the Reports tab to view test coverage, failure logs, and execution metrics.

Step 5: Integrate with CI/CD

To enable continuous testing, integrate TestGenie with your CI/CD tools like Jenkins, GitHub Actions, or GitLab CI. You will receive test results and feedback automatically for every code commit.

6. Key Commands

Here are some key commands available through the Command Palette:

• TestGenie: Generate Tests: Automatically generates unit test cases for your project.
• TestGenie: Run Tests: Executes generated tests.
• TestGenie: View Reports: Opens detailed test execution reports.
• TestGenie: Configure: Configure TestGenie for your project.

7. TestGenie Dashboard

The TestGenie Dashboard in VS Code provides an overview of your test results, including:

• Test Execution Logs: See which tests passed, failed, or were skipped.
• Coverage Reports: View coverage for each file and function.
• Failure Analysis: Inspect failing tests with detailed logs, showing root causes.
• Performance Metrics: Track test execution times and efficiency for optimization.

8. Troubleshooting

Q1: Tests aren’t being generated. What should I do?

• Ensure your code is correctly linked to the project in VS Code.
• Double-check that your repository is properly integrated with GitHub, GitLab, or Bitbucket.

Q2: TestGenie is not showing test results.

• Confirm that you have selected the appropriate test framework in the settings.
• Check if the generated tests have been executed by reviewing the Run Tests command.

Q3: How do I integrate TestGenie with my CI/CD pipeline?

• Follow the integration guide on our official website for detailed instructions on how to set up TestGenie with Jenkins, GitHub Actions, or GitLab CI.

9. Future Updates

• Expanded Language Support: More programming languages will be supported in upcoming releases.
• Improved AI Test Prediction: Further enhancements to AI-driven test generation and refinement.
• Deeper CI/CD Integration: Additional automation features for smoother CI/CD workflows.

10. Contributing

We welcome contributions from the community! If you'd like to contribute to the TestGenie VS Code extension, please fork the repository, make your changes, and submit a pull request. Follow our contribution guidelines for more details.

11. License

TestGenie is licensed under the MIT License. See the LICENSE file for more details.

12. Contact & Support

For support or feedback, you can contact us through:

• Email: support@testgenie.com

TestGenie Extension Changelog

• 1.0.0: Initial release: Automated test case generation, test execution, and reporting features.

General Questions

1. What is the TestGenie VS Code Extension?
   The TestGenie VS Code Extension is an AI-powered unit testing tool that automates test case generation, execution, and validation directly within VS Code. It streamlines testing, provides real-time feedback, and integrates with CI/CD pipelines.

2. What are the key features of TestGenie?

   • Automated Test Case Generation: AI-driven test generation based on your source code.
   • Real-Time Test Execution & Validation: Instantly runs and validates tests.
   • Smart Test Refinement: Uses AI and ML to optimize test cases over time.
   • Seamless CI/CD Integration: Works with Jenkins, GitHub Actions, and GitLab CI.
   • Detailed Insights & Reports: Provides test coverage, failure logs, and performance metrics.

3. Which programming languages and test frameworks does TestGenie support?
   TestGenie currently supports:

   • Languages: Java, Python, JavaScript, and more in future updates.
   • Test Frameworks: JUnit, PyTest, Mocha, NUnit, PHPUnit, and others.

Installation & Setup

4. What are the prerequisites for installing TestGenie?
   You need:

   • Visual Studio Code (VS Code) installed.
   • Node.js (version 12.x or higher).
   • A GitHub, GitLab, or Bitbucket account (for repository integration).

5. How do I install TestGenie in VS Code?

   • Open VS Code.
   • Go to the Extensions view (Ctrl+Shift+X).
   • Search for "TestGenie" and click Install.
   • Restart VS Code to activate the extension.

6. How do I configure TestGenie after installation?

   • Open the Command Palette (Ctrl+Shift+P).
   • Type TestGenie: Configure and press Enter.
   • Select your programming language and test framework.
   • Connect your source control (GitHub, GitLab, or Bitbucket).

Using TestGenie

7. How do I upload my code to TestGenie?
   Click on the TestGenie icon in the sidebar and select Upload Code to link your project directory or Git repository. TestGenie will detect the language and test framework automatically.

8. How do I generate test cases with TestGenie?
   Click the Generate Tests button in the TestGenie panel. The extension will analyze your code and create test cases for untested code paths.

9. How do I run tests in TestGenie?
   Click the Run Tests button after generating test cases. Test results will appear in real-time in the TestGenie panel.

10. Where can I find test reports and logs?
    Go to the Reports tab in the TestGenie panel to view:

• Test Execution Logs – Details on passed/failed tests.
• Coverage Reports – Code coverage percentage per file.
• Failure Analysis – Logs explaining test failures.
• Performance Metrics – Execution time and efficiency insights.

11. Can I integrate TestGenie with my CI/CD pipeline?
    Yes. TestGenie works with CI/CD tools like Jenkins, GitHub Actions, and GitLab CI. Check the integration guide on our official website for setup instructions.

Commands & Dashboard

12. What are the key TestGenie commands?
    You can access TestGenie through the Command Palette (Ctrl+Shift+P) and use:

• TestGenie: Generate Tests – Creates test cases.
• TestGenie: Run Tests – Executes tests.
• TestGenie: View Reports – Opens test execution reports.
• TestGenie: Configure – Configures settings.

13. What does the TestGenie Dashboard display?
    The TestGenie Dashboard provides:

• Test Execution Logs: Passed, failed, and skipped tests.
• Coverage Reports: Coverage percentage for each file.
• Failure Analysis: Logs with root causes of failed tests.
• Performance Metrics: Test execution times and efficiency.

Troubleshooting

14. Why aren’t my tests being generated?
    Ensure your project is correctly linked in VS Code.
    Verify that your repository is integrated with GitHub, GitLab, or Bitbucket.

15. TestGenie is not showing test results. What should I do?
    Confirm that you have selected the correct test framework in settings.
    Check if tests have been executed via the Run Tests command.

16. How do I integrate TestGenie with CI/CD?
    Refer to the official integration guide for step-by-step instructions on setting up TestGenie with Jenkins, GitHub Actions, or GitLab CI.

Future Updates

17. What features will be added in future updates?

• Expanded Language Support: More programming languages will be supported.
• Improved AI Test Prediction: Smarter AI-driven test case refinement.
• Deeper CI/CD Integration: More automation capabilities for smoother workflows.

Contributing & Licensing

18. Can I contribute to the TestGenie VS Code extension?
    Yes! You can contribute by forking the repository, making changes, and submitting a pull request. Check our contribution guidelines for more details.

19. What is the license for TestGenie?
    TestGenie is licensed under the MIT License. See the LICENSE file for more details.

Contact & Support

20. Where can I get support for TestGenie?
    For support, you can reach out through:

• Email: santhosh@genworx.ai

13. Demo Video

Here’s a quick demo video showing TestGenie in action: