Merging groot changes to master branch

sunbird-analytics/device-register/README.md

@@ -0,0 +1 @@
+run scenario: 

sunbird-platform/README.md

@@ -1,8 +1,66 @@
-The purpose of this document is to describe the steps required to perform a sunbird platform (learner service) load test.
+The purpose of this document is to describe the steps required to perform a sunbird platform load test.
+This folder consists of following APIs loadtest scripts.
+
+
+|         Folder Name        |             API End Point                    | 
+|----------------------------|----------------------------------------------|
+|     account-merge          |  /api/user/v1/account/merge                  |  
+|     assign-role            |  /api/user/v1/role/assign                    |
+|     auth-token             | /auth/realms/sunbird/protocol/openid-connect/token|
+|  cert-service-pdf-download | /api/certreg/v1/certs/download               |
+|  cert-service-svg          | /api/cert/v2/certs/generate                  |
+|  cert-service              | /api/cert/v1/certs/generate                  |
+| channel-read               | /api/channel/v1/read                         |
+|composite-search            | /api/composite/v1/search                     |
+|  content-hierarchy         |   /api/course/v1/hierarchy                   |
+| content-read               | /api/content/v1/read                         |
+|content-search              |  /api/content/v1/search                      |
+|course-batch-enrol          | /api/course/v1/enrol                         |
+| device-profile             |/api/v3/device/profile                        |
+| device-register            |/api/v3/device/register                       |
+| dial-assemble              |/api/data/v1/dial/assemble                    |
+|email-notification          |/api/user/v1/notification/email               |
+|ext-user-create             | /api/user/v3/create                          |
+| ext-user-read              |/private/user/v1/read                         |
+| framework-read             |/api/framework/v1/read                        |
+| group-create               |/api/group/v1/create                          |
+| group-delete               |/api/group/v1/delete                          |
+| group-list                 | /api/group/v1/list                           |
+|group-membership-update     |/api/group/membership/v1/update               |
+|group-read                  |  /api/group/v1/read                          |
+| group-update-activity      |/api/group/v1/update                          |
+| group-update-member        |/api/group/v1/update                          |
+| learner-state-read         |/api/course/v1/content/state/read             |
+|learner-state-update        |/api/course/v1/content/state/update           |
+|location-search-district    |/api/data/v1/location/search                  |
+|location-search             |/api/data/v1/location/search                  |
+|login                       | 4 APIs calls                                 |
+|org-search                  |/api/org/v1/search                            |
+|page-assemble               |/api/data/v1/page/assemble                    |
+|read-child-user             |/api/user/v2/read/${userId}?withTokens=true   |
+|send-telemetry              |/api/data/v1/telemetry                        |
+|system-settings             |/api/data/v1/system/settings/get              |
+|   tnc-accept               |/api/user/v1/tnc/accept                       |
+|user-bmgs-update            |/api/user/v1/update                           |
+|user-create-with-course-batch-enrol|/api/user/v1/create, /api/course/v1/enrol|
+| user-create                |/api/user/v1/create                           |
+| user-enrollment-list       |/api/course/v1/user/enrollment/list           |
+| user-existence             | /api/user/v1/exists/email                    |
+| user-get                   | /api/user/v1/get/email                       |
+| user-identifier-freeup     |/private/user/v1/identifier/freeup            |
+| user-migrate               |/private/user/v1/migrate                      |
+| user-notification          |/api/user/v2/notification                     |
+| user-read                  |/api/user/v3/read                             |
+|user-search-email           |/api/user/v1/search                           |
+|user-self-declaration        |/api/user/v1/declarations                    |
+
+
+
+
 
 ### Pre-requisites
 * Clone this repo (`sunbird-perf-tests`) in home directory
-* Setup Apache JMeter 5.1.1 (`apache-jmeter-5.1.1`) in home directory
+* Setup Apache JMeter 5.3 (`apache-jmeter-5.3`) in home directory
 * Update Apache JMeter configuration properties (`jmeter.properties`)
 
 ```
@@ -12,7 +70,7 @@ jmeter.save.saveservice.requestHeaders=true
 ```
 * Run Apache JMeter
 ```
-nohup ~/apache-jmeter-5.1.1/bin/jmeter-server &
+nohup ~/apache-jmeter-5.3/bin/jmeter-server &
 ```
 * Create necessary folders for running scenario script in home directory
 ```
@@ -30,7 +88,7 @@ sh run_scenario.sh <JMETER_HOME> <JMETER_IP_LIST> <HOST> <SCENARIO_NAME> <SCENAR
 e.g.
 
 ```
-sh run_scenario.sh ~/apache-jmeter-5.1.1 "28.0.0.18,28.0.0.19,28.0.0.20" "dev.sunbirded.org" system-settings r1_system-settings_t5 5 1 1 "ABCDEFabcdef012345" "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz" "/tmp/data.csv /tmp/sunbird-perf-tests/sunbird-platform/common/config/domain-end-point.csv" "/api"
+sh run_scenario.sh ~/apache-jmeter-5.3 "28.0.0.18,28.0.0.19,28.0.0.20" "dev.sunbirded.org" system-settings r1_system-settings_t5 5 1 1 "ABCDEFabcdef012345" "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz" "/tmp/data.csv /tmp/sunbird-perf-tests/sunbird-platform/common/config/domain-end-point.csv" "/api"
 ```
 
 ### How to verify?

sunbird-platform/account-merge/README.md

@@ -0,0 +1,40 @@
+### Test Scenario:
+
+Benchmarking Merge Account API.
+
+
+### Test Environment Details:
+1. No of AKS node -24 (CPU- 8Core & Memory- 16GB)
+2. No of learner service replicas - 8 (CPU- 3Core & Memory- 5GB)
+3. ES Cluster - 3 nodes; CPU- 8core ; Memory- 32GB
+4. Cassandra Cluster- 5 Nodes; CPU- 16Core; Memory- 64GB
+5. Release version - NA
+
+
+**API End Point:** 
+`/api/user/v1/account/merge`
+
+
+**Executing the test scenario using JMeter:**
+
+```./run_scenario.sh <JMETER_HOME> <JMETER_IP_LIST> <SCENARIO_NAME> <SCENARIO_ID> <THREADS_COUNT> <RAMPUP_TIME> <CTRL_LOOPS> <API_KEY> <DOMAIN_FILE> <CSV_FILE_TO_ACCOUNT>  <CSV_FILE_FROM_ACCOUNT> <pathPrefix>```
+
+e.g.
+
+```./run_scenario.sh /mount/data/benchmark/apache-jmeter-5.3/ 'Jmeter_Slave1_IP,Jmeter_Slave2_IP,Jmeter_Slave3_IP,Jmeter_Slave4_IP' account-merge account-merge-Id1 5 1 5 "ABCDEFabcdef012345" ~/sunbird-perf-tests/sunbird-platform/testdata/host.csv ~/sunbird-perf-tests/sunbird-platform/testdata/toAccounts.csv ~/sunbird-perf-tests/sunbird-platform/testdata/fromAccounts.csv /api/user/v1/account/merge```
+
+
+**Note**
+- `toAccounts.csv` : State tenant users account details. Custodian users accounts will be merged to these accounts.
+- `fromAccounts.csv`: Custodian users account details. These are the accounts which are going to be megred with state tenant user accounts.
+- `x-authenticated-user-token` in header manager is tenant user's access token to which account of the custodian user account is going to be merged.
+- `x-source-user-token` in header manager is custodian user's access token , whose account to going to be merged.
+- Update `host.csv` file data with correct host details before running the test. It can be domain details / Kubernetes Node IPs/ LB IPs/ Direct Service IPs with port details.
+
+
+
+### Test Result
+
+| API           | Thread Count  | Samples  | Errors%   | Throughput/sec  | Avg Resp Time |   95th pct  |  99th pct   |
+| ------------- | ------------- | -------- | --------- | --------------- |---------------|-------------|-------------|
+| Account Merge | 200           | 100000   | 0 (0.00%) | 401.7           | 429           |    1040     |   1686.94   |