github/azure-sdk-for-cpp
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

docs for stress perf (#4269)

Browse Source 
* docs for stress perf

* dotnet contrib
This commit is contained in:
George Arama 2023-01-24 15:49:20 -08:00 committed by GitHub
parent cc09902b17
commit 58877500cd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 33 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CONTRIBUTING.md
View File

@ -65,6 +65,10 @@ Codespaces is new technology that allows you to use a container as your developm
CMake version 3.13 or higher is required to build these libraries. Download and install CMake from the project's
[website](https://cmake.org/download/).
### Dotnet
Required to get and execute test proxy(see /doc/TestProxy.md). [website](https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet)
### Third Party Dependencies
Azure SDK uses Vcpkg manifest mode to declare the [list of required 3rd party dependencies](https://github.com/Azure/azure-sdk-for-cpp/blob/main/vcpkg.json) for building the SDK service libraries. It will also get and set up Vcpkg automatically. **You can move on to [Building the project](#building-the-project)** and skip the next part if you are not interested in learning about alternatives for setting up dependencies.

29
doc/StressTest.md Normal file
View File

@ -0,0 +1,29 @@
# Stress Test
## Deps
Adding a stress test requires the following tools installed:
* Docker : https://www.docker.com/
* Helm : https://helm.sh/
Structure :
A stress tests is composes of the following components :
* Source code : represents the test that is run, there are no prerequisites as to what the code does, the outputs of the tests can be at the cosole , as file share or Application Insights.
* DockerFile : represents the docker file that will build the continer image that will be executed by the stress automation, on the stress test clusters.
* Helm Chart : represents the deployment script for the docker image built by the Dockerfile.
* stress-test-resources.bicep/json ARM template for deploying azure resources required by the
tests
* scenarios-matrix.yaml : definition of tests and which are offered in one docker image. e.g. We can have multiple tests coexisting in a single docer image, the definition conmtains a list of test names and executables (with params) that will be executed in order to run those tests.
To deploy a stress test to the playground (test) clusters, you will need to execute the following script : "eng/common/scripts/stress-testing/deploy-stress-tests.ps1 -Login -PushImages" in the folder of where the dockerfile exists.
Example : \sdk\core\azure-core\test\libcurl-stress-test
The deployment script will run the following steps :
* deploy the arm resources
* build the docker image
* read the scenarios and generate the final helm chart
* deploy the helm chart - caveat - make sure to have a .helmignore file present in which you exclude files that are not required for the deployment (e.g. test source code) . When initiating a deplyment helm zips the whole folder , in order to upload it the chart needs to be less than 1MB. Thus excluding any uneeded files is advisable.
The Dockerfile is very flexible, it can be used to include the binaries for the tests or include the code and run the config/build of the tests as part of the build , or anything in between. The only requirement is that the command lines to run the test executables are specified in the scenarios.txt

0
doc/TestProxy.md Normal file
View File