Skip to content

Commit

Permalink
[load] add project structure to README (#8387)
Browse files Browse the repository at this point in the history
  • Loading branch information
mbhardwaj-msft authored Dec 31, 2024
1 parent 113870c commit 9cbac44
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions src/load/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,3 +130,36 @@ az load delete \
```
---
<br/>

## Project Structure ##

### Root Directory: `src/load/azext_load/` ###

- **_help.py**: Imports and updates help documentation for the extension commands both control and data plane.
- **commands.py**: Registers the control plane commands for the extension, `az load`.
- **data_plane/**: Contains the data plane commands and utilities.

### Data Plane Directory: `src/load/azext_load/data_plane/` ###

- **\_\_init\_\_.py**: Initializes the respective modules and sets up the command loader.
- **client_factory.py**: Provides factory methods to create instances of data plane clients, such as `LoadTestRunClient` and `LoadTestAdministrationClient`.
- **help.py**: Provides help documentation for the data plane commands.
- **params.py**: Defines the common parameters for the `az load test` and `az load test-run` commands.
- **load_test/**: Contains commands and utilities specific to load tests.
- **commands.py**: Registers the sub command groups for `az load test`.
- **custom.py**: Implements the logic for load test commands, such as creating, updating, and deleting load tests.
- **help.py**: Provides help documentation with samples for load test commands.
- **params.py**: Defines parameters for load test commands.
- **load_test_run/**: Contains commands and utilities specific to load test runs.
- **commands.py**: Registers the sub command groups for `az load test-run`.
- **custom.py**: Implements the logic for load test run commands, such as creating, updating, and deleting load test runs.
- **help.py**: Provides help documentation with samples for load test run commands.
- **params.py**: Defines parameters for load test run commands.
- **utils/**: Contains utility functions and constants.
- **constants.py**: Defines constants used across the extension.
- **utils.py**: Provides utility functions for common operations, such as uploading files, parsing YAML configurations, and handling errors.
- **utils_yaml_config.py**: Provides functions to parse and validate YAML configuration data to be used for request payload for load tests.
- **validators.py**: Implements validation functions to ensure that command parameters meet the required criteria.
- **argtypes.py**: Creates custom argument types to handle specific input formats or validation rules required by the data plane commands. Also provides concise help texts to be displayed in CLI against each argument.
- **completers.py**: Defines functions that provide dynamic completion suggestions for specific command-line arguments. We have these implemented for test id and test run id so far. *Note: Completers are not supported in powershell.*
- **models.py**: Stores data models.

0 comments on commit 9cbac44

Please sign in to comment.