15637403ad* standardize component name style and links pt 1 * component name standardization pt 2 * standardization pt 3 * standardize component names pt 4 * peer review * fix lnk * update edit tool actions section * standardize Agent, agent, agentic * more style auditing * missing imports
114 lines
No EOL
4.9 KiB
Text
114 lines
No EOL
4.9 KiB
Text
---
|
|
title: Contribute component tests
|
|
slug: /contributing-component-tests
|
|
---
|
|
|
|
This guide outlines how to structure and implement tests for application components to ensure consistency and adequate coverage.
|
|
|
|
## File naming
|
|
|
|
* The test file should follow the same directory structure as the component being tested, but should be placed in the corresponding unit tests folder.
|
|
|
|
For example, if the file path for the component is `src/backend/base/langflow/components/prompts/`, then the test file should be located at `src/backend/tests/unit/components/prompts`.
|
|
|
|
* The test file name should use snake case and follow the pattern `test_<file_name>.py`.
|
|
|
|
For example, if the file to be tested is `PromptComponent.py`, then the test file should be named `test_prompt_component.py`.
|
|
|
|
## File structure
|
|
|
|
* Each test file should group tests into classes by component. There should be no standalone test functions in the file— only test methods within classes.
|
|
* Class names should follow the pattern `Test<ClassName>`.
|
|
For example, if the component being tested is `PromptComponent`, then the test class should be named `TestPromptComponent`.
|
|
|
|
## Imports, inheritance, and mandatory methods
|
|
|
|
To standardize component tests, base test classes have been created and should be imported and inherited by all component test classes. These base classes are located in the file `src/backend/tests/unit/base.py`.
|
|
|
|
To import the base test classes:
|
|
|
|
```python
|
|
from tests.base import ComponentTestBaseWithClient
|
|
from tests.base import ComponentTestBaseWithoutClient
|
|
```
|
|
|
|
These base classes enforce mandatory methods that the component test classes must implement. The base classes ensure that components built in previous versions continues to work in the current version. By inheriting from one of these base classes, the developer must define the following methods decorated with `@pytest.fixture`:
|
|
|
|
* `component_class:` Returns the class of the component to be tested. For example:
|
|
|
|
```python
|
|
@pytest.fixture
|
|
def component_class(self):
|
|
return PromptComponent
|
|
```
|
|
|
|
* `default_kwargs:` Returns a dictionary with the default arguments required to instantiate the component. For example:
|
|
|
|
```python
|
|
@pytest.fixture
|
|
def default_kwargs(self):
|
|
return {"template": "Hello {name}!", "name": "John", "_session_id": "123"}
|
|
```
|
|
|
|
* `file_names_mapping:` Returns a list of dictionaries representing the relationship between `version`, `module`, and `file_name` that the tested component has had over time. This can be left empty if it is an unreleased component. For example:
|
|
|
|
```python
|
|
@pytest.fixture
|
|
def file_names_mapping(self):
|
|
return [
|
|
{"version": "1.0.15", "module": "prompts", "file_name": "Prompt"},
|
|
{"version": "1.0.16", "module": "prompts", "file_name": "Prompt"},
|
|
{"version": "1.0.17", "module": "prompts", "file_name": "Prompt"},
|
|
{"version": "1.0.18", "module": "prompts", "file_name": "Prompt"},
|
|
{"version": "1.0.19", "module": "prompts", "file_name": "Prompt"},
|
|
]
|
|
```
|
|
|
|
## Testing component functionalities
|
|
|
|
Once the basic structure of the test file is defined, implement test methods for the component's functionalities. The following guidelines must be followed:
|
|
|
|
1. Test method names should be descriptive, use snake case, and follow the pattern `test_<case_name>`.
|
|
2. Each test should follow the **Arrange, Act, Assert** pattern:
|
|
1. **Arrange**: Prepare the data.
|
|
2. **Act**: Execute the component.
|
|
3. **Assert**: Verify the result.
|
|
|
|
### Example
|
|
|
|
1. **Arrange**: Prepare the data.
|
|
|
|
It is recommended, but not mandatory, that you use the fixtures defined in the basic structure.
|
|
|
|
```python
|
|
def test_post_code_processing(self, component_class, default_kwargs):
|
|
component = component_class(**default_kwargs)
|
|
```
|
|
|
|
2. **Act**: Execute the component.
|
|
|
|
Call the `.to_frontend_node()` method of the component prepared during the **Arrange** step.
|
|
|
|
```python
|
|
def test_post_code_processing(self, component_class, default_kwargs):
|
|
component = component_class(**default_kwargs)
|
|
|
|
frontend_node = component.to_frontend_node()
|
|
```
|
|
|
|
3. **Assert**: Verify the result.
|
|
|
|
After executing the `.to_frontend_node()` method, the resulting data is available for verification in the dictionary `frontend_node["data"]["node"]`. Assertions should be clear and cover the expected outcomes.
|
|
|
|
```python
|
|
def test_post_code_processing(self, component_class, default_kwargs):
|
|
component = component_class(**default_kwargs)
|
|
|
|
frontend_node = component.to_frontend_node()
|
|
|
|
node_data = frontend_node["data"]["node"]
|
|
assert node_data["template"]["template"]["value"] == "Hello {name}!"
|
|
assert "name" in node_data["custom_fields"]["template"]
|
|
assert "name" in node_data["template"]
|
|
assert node_data["template"]["name"]["value"] == "John"
|
|
``` |