Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ankschoubey/template-for-tdd
Template to make TDD fast and easy
https://github.com/ankschoubey/template-for-tdd
intellij tdd tdd-java template
Last synced: about 1 month ago
JSON representation
Template to make TDD fast and easy
- Host: GitHub
- URL: https://github.com/ankschoubey/template-for-tdd
- Owner: ankschoubey
- License: mit
- Created: 2024-02-18T06:58:02.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-02-18T13:30:09.000Z (12 months ago)
- Last Synced: 2024-11-14T17:11:59.806Z (3 months ago)
- Topics: intellij, tdd, tdd-java, template
- Homepage: https://www.ankushchoubey.com/tdd
- Size: 21.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
### Streamline Your Testing Process with a Clean TDD Template For IntelliJ
Writing clean and well-structured tests is essential for ensuring the reliability and maintainability of your codebase. The Test-Driven Development (TDD) Template for IntelliJ and VS Code provides a straightforward approach to creating tests that are easy to understand, maintain, and execute efficiently.
*Note: The following ReadMe is generated with the help of ChatGPT. The examples and templates provided are my own.*
#### Example Usage
Consider the following example, which demonstrates how the TDD template enhances test clarity and readability:
**Final Output**:
```java
@Nested
@DisplayName("GET /users") // abbreviation `@api`
class GetUsersTest {
@Nested
@DisplayName("WHEN 'role' is 'user'") // abbreviation `@when`
class WHENRoleIsUserTest {
@Test
@DisplayName("THEN SHOULD return 403") // abbreviation `@then`
void THENTest() {
// given
LoggedInUser = Given.ALoggedInUserForRole("user");
// when
WebTestClient.ResponseSpec responseSpec = webTestClient.get().uri("/users").exchange();
// then
responseSpec.expectStatus().isUnauthorized();
}
}
}
```
#### Benefits of Using the Template
1. **Clarity and Readability**: By providing predefined snippets for test structure, the template ensures that your tests are easy to understand and follow, promoting clarity throughout your test suite.
2. **Efficiency**: With shortcuts for creating test classes and methods, you can speed up the process of writing tests, allowing you to focus more on testing your code's behavior rather than boilerplate setup.
3. **Consistency**: Adopting a standardized format for tests encourages consistency across your project, facilitating collaboration among team members and easing the burden of maintenance.
Start leveraging the TDD template today to streamline your testing process and elevate the quality of your software.
#### Available Abbreviations/Shortcuts:
- `@api`: Expands to a nested test class with a display name for a specific API endpoint.
- `@method`: Expands to a nested test class with a display name for a specific method.
- `@when`: Expands to a nested test class with a display name for a specific condition.
- `@then`: Expands to a test method with a display name for a specific assertion.
This template is designed to streamline Test-Driven Development (TDD) practices within IntelliJ IDEA and VS Code, making the process of writing tests and code more efficient and structured.
#### About the Template
This TDD template includes helpful shortcuts and structures to facilitate TDD practices, ensuring that your testing process is seamless and organized. The template consists of predefined snippets that can be easily expanded to create test classes and methods, following the Arrange-Act-Assert pattern commonly used in TDD.
#### How to Use
1. **Installation**: Download the `TDD-Templates-For-IntelliJ.zip` file.
2. **Import Settings in IntelliJ IDEA**:
- Open IntelliJ IDEA.
- Go to `File` > `Import Settings`.
- Select the downloaded `TDD-Templates-For-IntelliJ.zip` file.
- Follow the prompts to import the settings.
3. **Usage**: In your test classes, utilize the predefined snippets to structure your tests effectively.
- `@api`: Expands to a nested test class with a display name for a specific API endpoint.
```java
@Nested
@DisplayName("GET /users")
class GetUsersTest {
}
```
- `@method`: Expands to a nested test class with a display name for a specific method, with placeholders for method names.
```java
@Nested
@DisplayName("{userMethods} method")
class {UserMethods}MethodTest {
}
```
- `@when`: Expands to a nested test class with a display name for a specific condition, with placeholders for condition descriptions.
```java
@Nested
@DisplayName("WHEN {condition description}")
class {ConditionDescription}Tests {
}
```
- `@then`: Expands to a test method with a display name for a specific assertion, with placeholders for assertion descriptions.
```java
@Test
@DisplayName("THEN {assertion description}")
void {AssertionDescription}Test() {
// given
{code for setting conditions describe in WHEN block}
// when
{code for running actions}
// then
{code for assertions}
}
```
#### Learn More
For a deeper understanding of Test-Driven Development (TDD) and how to effectively implement it in your projects, visit [www.ankushchoubey.com/tdd](https://www.ankushchoubey.com/tdd).
To read a detailed blog post about this TDD template and its usage, check out [www.ankushchoubey.com/tdd/tdd-template](https://www.ankushchoubey.com/tdd/tdd-template).
---
Designed and maintained by **Ankush Choubey**. Visit [www.ankushchoubey.com](https://www.ankushchoubey.com) for more resources and updates.