From 94bc00b71480c1c892713fde6b7c6d5180e2b02b Mon Sep 17 00:00:00 2001 From: Zhongwei Li Date: Sun, 30 Nov 2025 08:23:46 +0800 Subject: [PATCH] Initial commit --- .claude-plugin/plugin.json | 15 +++ README.md | 3 + commands/generate-tests.md | 92 +++++++++++++++++++ plugin.lock.json | 61 ++++++++++++ skills/unit-test-generator/SKILL.md | 57 ++++++++++++ skills/unit-test-generator/assets/README.md | 6 ++ .../unit-test-generator/references/README.md | 7 ++ skills/unit-test-generator/scripts/README.md | 7 ++ 8 files changed, 248 insertions(+) create mode 100644 .claude-plugin/plugin.json create mode 100644 README.md create mode 100644 commands/generate-tests.md create mode 100644 plugin.lock.json create mode 100644 skills/unit-test-generator/SKILL.md create mode 100644 skills/unit-test-generator/assets/README.md create mode 100644 skills/unit-test-generator/references/README.md create mode 100644 skills/unit-test-generator/scripts/README.md diff --git a/.claude-plugin/plugin.json b/.claude-plugin/plugin.json new file mode 100644 index 0000000..8dd0c00 --- /dev/null +++ b/.claude-plugin/plugin.json @@ -0,0 +1,15 @@ +{ + "name": "unit-test-generator", + "description": "Automatically generate comprehensive unit tests from source code with multiple testing framework support", + "version": "1.0.0", + "author": { + "name": "Claude Code Plugins", + "email": "[email protected]" + }, + "skills": [ + "./skills" + ], + "commands": [ + "./commands" + ] +} \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..756bb61 --- /dev/null +++ b/README.md @@ -0,0 +1,3 @@ +# unit-test-generator + +Automatically generate comprehensive unit tests from source code with multiple testing framework support diff --git a/commands/generate-tests.md b/commands/generate-tests.md new file mode 100644 index 0000000..fe24c7f --- /dev/null +++ b/commands/generate-tests.md @@ -0,0 +1,92 @@ +--- +description: Generate comprehensive unit tests for source code files +shortcut: gut +--- + +# Unit Test Generator + +Generate comprehensive, production-ready unit tests for source code files. + +## Capabilities + +You are a unit testing specialist that generates high-quality test cases covering: +- **Happy paths** - Normal execution scenarios +- **Edge cases** - Boundary conditions, limits, empty inputs +- **Error handling** - Exceptions, invalid inputs, failures +- **Mock dependencies** - External services, databases, APIs +- **Assertions** - Proper validation of expected outcomes + +## Supported Frameworks + +Auto-detect and use the appropriate framework: +- **JavaScript/TypeScript**: Jest, Mocha, Vitest, Jasmine +- **Python**: pytest, unittest, nose2 +- **Java**: JUnit 5, TestNG +- **Go**: testing package +- **Ruby**: RSpec, Minitest +- **C#**: xUnit, NUnit, MSTest +- **PHP**: PHPUnit +- **Rust**: cargo test + +## Process + +When invoked with a file path or code snippet: + +1. **Analyze the code** to understand: + - Functions/methods to test + - Dependencies and external calls + - Input/output types + - Error conditions + +2. **Detect testing framework** from: + - Existing test files in project + - package.json, requirements.txt, etc. + - Ask user if unclear + +3. **Generate test file** with: + - Proper imports and setup + - Test suite organization + - Descriptive test names + - Arrange-Act-Assert pattern + - Mocks for external dependencies + - Code coverage considerations + +4. **Include test cases for**: + - Valid inputs (typical use cases) + - Invalid inputs (null, undefined, wrong types) + - Boundary conditions (min/max values, empty arrays) + - Error scenarios (exceptions, rejections) + - State changes (if applicable) + +5. **Add helpful comments** explaining: + - What each test validates + - Why certain mocks are needed + - Any setup/teardown requirements + +## Output Format + +Create the test file with: +- File naming convention (e.g., `foo.test.js`, `test_foo.py`) +- Proper test structure and organization +- Clear test descriptions +- Mock setup and cleanup +- Assertion explanations + +## Example Usage + +``` +/generate-tests src/utils/validator.js +/generate-tests --framework pytest src/api/users.py +/gut models/UserModel.ts +``` + +## Best Practices Applied + +- Use descriptive test names (what is being tested + expected outcome) +- One assertion per test when possible +- Test isolation (no shared state between tests) +- Proper setup/teardown +- Mock external dependencies +- Test both success and failure paths +- Include edge cases and boundary conditions +- Add comments for complex test scenarios diff --git a/plugin.lock.json b/plugin.lock.json new file mode 100644 index 0000000..22fe0c9 --- /dev/null +++ b/plugin.lock.json @@ -0,0 +1,61 @@ +{ + "$schema": "internal://schemas/plugin.lock.v1.json", + "pluginId": "gh:jeremylongshore/claude-code-plugins-plus:plugins/testing/unit-test-generator", + "normalized": { + "repo": null, + "ref": "refs/tags/v20251128.0", + "commit": "fd48512728e89c03c4b937dcd40df915facb8dd3", + "treeHash": "9093bb2043ace3ce4831c221aa544581fc0e140bd5d299b10b01a2154c01a760", + "generatedAt": "2025-11-28T10:18:51.284289Z", + "toolVersion": "publish_plugins.py@0.2.0" + }, + "origin": { + "remote": "git@github.com:zhongweili/42plugin-data.git", + "branch": "master", + "commit": "aa1497ed0949fd50e99e70d6324a29c5b34f9390", + "repoRoot": "/Users/zhongweili/projects/openmind/42plugin-data" + }, + "manifest": { + "name": "unit-test-generator", + "description": "Automatically generate comprehensive unit tests from source code with multiple testing framework support", + "version": "1.0.0" + }, + "content": { + "files": [ + { + "path": "README.md", + "sha256": "322493201aae3bd25b41ea77b16a54a13b9d9878dbeba413f76c2d2621fe6e02" + }, + { + "path": ".claude-plugin/plugin.json", + "sha256": "d95ec90093487915b3d860df863b7f7f0b5db16ee6025cd634d2d5ed0a9d562c" + }, + { + "path": "commands/generate-tests.md", + "sha256": "1e1d50ca5991d63e07bfe3576d5a66c002deb2003dd9c92f283a71c797f3b4e1" + }, + { + "path": "skills/unit-test-generator/SKILL.md", + "sha256": "5a73730eb2cf7564acbccd1093ca866cd9682dd11f4f78300ef366e3a6e4accb" + }, + { + "path": "skills/unit-test-generator/references/README.md", + "sha256": "74a0ffae88e28fa23b39737b29ec23c7b4453a34079ef97ab5dbfa28fb1a1f1c" + }, + { + "path": "skills/unit-test-generator/scripts/README.md", + "sha256": "3af9a9bffd05ceac03c4ce3f07c1c633d974c498ab465a34f8b131939cad1abc" + }, + { + "path": "skills/unit-test-generator/assets/README.md", + "sha256": "3682af78ca4802bbd66f5669664c0b1fe0cf10ce2f92225ccdd5a97e0b3de187" + } + ], + "dirSha256": "9093bb2043ace3ce4831c221aa544581fc0e140bd5d299b10b01a2154c01a760" + }, + "security": { + "scannedAt": null, + "scannerVersion": null, + "flags": [] + } +} \ No newline at end of file diff --git a/skills/unit-test-generator/SKILL.md b/skills/unit-test-generator/SKILL.md new file mode 100644 index 0000000..e1e2a41 --- /dev/null +++ b/skills/unit-test-generator/SKILL.md @@ -0,0 +1,57 @@ +--- +name: generating-unit-tests +description: | + This skill enables Claude to automatically generate comprehensive unit tests from source code. It is triggered when the user requests unit tests, test cases, or test suites for specific files or code snippets. The skill supports multiple testing frameworks including Jest, pytest, JUnit, and others, intelligently detecting the appropriate framework or using one specified by the user. Use this skill when the user asks to "generate tests", "create unit tests", or uses the shortcut "gut" followed by a file path. +allowed-tools: Read, Write, Edit, Grep, Glob, Bash +version: 1.0.0 +--- + +## Overview + +This skill empowers Claude to rapidly create robust unit tests, saving developers time and ensuring code quality. It analyzes source code, identifies key functionalities, and generates test cases covering various scenarios, including happy paths, edge cases, and error conditions. + +## How It Works + +1. **Analyze Source Code**: The skill analyzes the provided source code file to understand its functionality, inputs, and outputs. +2. **Determine Testing Framework**: The skill either detects the appropriate testing framework based on the file type and project structure or uses the framework specified by the user. +3. **Generate Test Cases**: The skill generates comprehensive test cases, including tests for valid inputs, invalid inputs, boundary conditions, and error scenarios. +4. **Create Mock Dependencies**: The skill automatically creates mocks and stubs for external dependencies to isolate the code being tested. +5. **Output Test File**: The skill outputs a new test file containing the generated test cases, imports, setup, and assertions. + +## When to Use This Skill + +This skill activates when you need to: +- Create unit tests for a specific file or code snippet. +- Generate test cases for a function, class, or module. +- Quickly add test coverage to existing code. +- Ensure code quality and prevent regressions. + +## Examples + +### Example 1: Generating Tests for a JavaScript Utility Function + +User request: "generate tests src/utils/validator.js" + +The skill will: +1. Analyze the `validator.js` file to understand its functions and dependencies. +2. Detect that the file is JavaScript and default to Jest. +3. Generate a `validator.test.js` file with test cases covering various validation scenarios. + +### Example 2: Generating Tests for a Python API Endpoint using pytest + +User request: "generate tests --framework pytest src/api/users.py" + +The skill will: +1. Analyze the `users.py` file to understand its API endpoints and dependencies. +2. Use pytest as the testing framework, as specified by the user. +3. Generate a `test_users.py` file with test cases covering various API scenarios, including successful requests, error handling, and authentication. + +## Best Practices + +- **Framework Specification**: Explicitly specify the testing framework when the default is not desired or ambiguous. +- **File Granularity**: Generate tests for individual files or modules to maintain focus and testability. +- **Review and Refine**: Always review and refine the generated tests to ensure they accurately reflect the desired behavior and coverage. + +## Integration + +This skill can be used in conjunction with other code analysis and refactoring tools to improve code quality and maintainability. It also integrates with CI/CD pipelines to automatically run tests and prevent regressions. \ No newline at end of file diff --git a/skills/unit-test-generator/assets/README.md b/skills/unit-test-generator/assets/README.md new file mode 100644 index 0000000..dd86d21 --- /dev/null +++ b/skills/unit-test-generator/assets/README.md @@ -0,0 +1,6 @@ +# Assets + +Bundled resources for unit-test-generator skill + +- [ ] test_template.js A template for generating test files. +- [ ] example_code.zip A zip file containing example code snippets and their corresponding unit tests. diff --git a/skills/unit-test-generator/references/README.md b/skills/unit-test-generator/references/README.md new file mode 100644 index 0000000..ddbd5d6 --- /dev/null +++ b/skills/unit-test-generator/references/README.md @@ -0,0 +1,7 @@ +# References + +Bundled resources for unit-test-generator skill + +- [ ] testing_best_practices.md A guide to writing effective unit tests. +- [ ] framework_apis.md API documentation for supported testing frameworks (Jest, pytest, JUnit, etc.). +- [ ] code_analysis_techniques.md Explains how the plugin analyzes code to generate tests. diff --git a/skills/unit-test-generator/scripts/README.md b/skills/unit-test-generator/scripts/README.md new file mode 100644 index 0000000..be2bee0 --- /dev/null +++ b/skills/unit-test-generator/scripts/README.md @@ -0,0 +1,7 @@ +# Scripts + +Bundled resources for unit-test-generator skill + +- [ ] detect_framework.py Detects the testing framework used in a project. +- [ ] generate_mocks.py Generates mock objects for dependencies. +- [ ] test_runner.sh Executes the generated tests and reports results.