You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/load/README.md
+33Lines changed: 33 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -130,3 +130,36 @@ az load delete \
130
130
```
131
131
---
132
132
<br/>
133
+
134
+
## Project Structure ##
135
+
136
+
### Root Directory: `src/load/azext_load/` ###
137
+
138
+
-**_help.py**: Imports and updates help documentation for the extension commands both control and data plane.
139
+
-**commands.py**: Registers the control plane commands for the extension, `az load`.
140
+
-**data_plane/**: Contains the data plane commands and utilities.
141
+
142
+
### Data Plane Directory: `src/load/azext_load/data_plane/` ###
143
+
144
+
-**\_\_init\_\_.py**: Initializes the respective modules and sets up the command loader.
145
+
-**client_factory.py**: Provides factory methods to create instances of data plane clients, such as `LoadTestRunClient` and `LoadTestAdministrationClient`.
146
+
-**help.py**: Provides help documentation for the data plane commands.
147
+
-**params.py**: Defines the common parameters for the `az load test` and `az load test-run` commands.
148
+
-**load_test/**: Contains commands and utilities specific to load tests.
149
+
-**commands.py**: Registers the sub command groups for `az load test`.
150
+
-**custom.py**: Implements the logic for load test commands, such as creating, updating, and deleting load tests.
151
+
-**help.py**: Provides help documentation with samples for load test commands.
152
+
-**params.py**: Defines parameters for load test commands.
153
+
-**load_test_run/**: Contains commands and utilities specific to load test runs.
154
+
-**commands.py**: Registers the sub command groups for `az load test-run`.
155
+
-**custom.py**: Implements the logic for load test run commands, such as creating, updating, and deleting load test runs.
156
+
-**help.py**: Provides help documentation with samples for load test run commands.
157
+
-**params.py**: Defines parameters for load test run commands.
158
+
-**utils/**: Contains utility functions and constants.
159
+
-**constants.py**: Defines constants used across the extension.
160
+
-**utils.py**: Provides utility functions for common operations, such as uploading files, parsing YAML configurations, and handling errors.
161
+
-**utils_yaml_config.py**: Provides functions to parse and validate YAML configuration data to be used for request payload for load tests.
162
+
-**validators.py**: Implements validation functions to ensure that command parameters meet the required criteria.
163
+
-**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.
164
+
-**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.*
0 commit comments