[Multi-Engine] Cleanup Locust flag (#103) (#104)

Harshan01 · web-flow · commit 3e6fb153051e · 2024-11-07T19:05:40.000+05:30
* Remove locust flag
* Add Locust E2E sample file
diff --git a/.github/workflows/pr_check_load_test.yml b/.github/workflows/pr_check_load_test.yml
@@ -27,7 +27,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest]
-        configFile: ['sample-test-url.yaml', 'sample-test-jmx.yaml']
+        configFile: ['sample-test-url.yaml', 'sample-test-jmx.yaml', 'sample-test-locust.yaml']
         
     runs-on: ${{ matrix.os }}
     steps:
diff --git a/SampleApp.py b/SampleApp.py
@@ -0,0 +1,15 @@
+import os
+from locust import HttpUser, constant_throughput, task
+
+protocol = os.getenv("protocol", "https")
+host = os.getenv("domain", "example.com")
+base_url = f"{protocol}://{host}"
+
+
+class WebsiteUser(HttpUser):
+    host = base_url
+    wait_time = constant_throughput(1)
+
+    @task
+    def mainPage(self):
+        self.client.get("/", name="Homepage")
diff --git a/lib/constants.js b/lib/constants.js
@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FeatureFlags = exports.defaultYaml = void 0;
+exports.defaultYaml = void 0;
 exports.defaultYaml = {
     version: 'v0.1',
     testId: 'SampleTest',
@@ -48,7 +48,3 @@ exports.defaultYaml = {
         }
     ]
 };
-var FeatureFlags;
-(function (FeatureFlags) {
-    FeatureFlags.IsLocustEnabled = false;
-})(FeatureFlags || (exports.FeatureFlags = FeatureFlags = {}));
diff --git a/lib/main.js b/lib/main.js
@@ -205,20 +205,10 @@ function uploadTestPlan() {
         let filepath = map.getTestFile();
         let filename = map.getFileName(filepath);
         var urlSuffix = "tests/" + testId + "/files/" + filename + "?api-version=" + util.apiConstants.latestVersion;
-        let fileType = FileType.JMX_FILE;
+        let fileType = FileType.TEST_SCRIPT;
         if (map.getTestKind() == TestKind_1.TestKind.URL) {
             fileType = FileType.URL_TEST_CONFIG;
         }
-        else {
-            //TODO(harshanb): Change to TEST_SCRIPT for all non-URL once Locust is GA
-            // If IsLocustEnabled is False, then kind cannot be Locust as validations would catch it
-            if (map.getTestKind() == TestKind_1.TestKind.JMX) {
-                fileType = FileType.JMX_FILE;
-            }
-            else {
-                fileType = FileType.TEST_SCRIPT;
-            }
-        }
         urlSuffix = baseURL + urlSuffix + ("&fileType=" + fileType);
         let headers = yield map.UploadAndValidateHeader();
         let uploadresult = yield util.httpClientRetries(urlSuffix, headers, 'put', 3, filepath, true);
diff --git a/lib/util.js b/lib/util.js
@@ -351,10 +351,6 @@ function checkValidityYaml(givenYaml) {
         return { valid: false, error: `The value "${givenYaml.engineInstances}" for engineInstances is invalid. The value should be an integer between 1 and 400.` };
     }
     let kind = (_a = givenYaml.testType) !== null && _a !== void 0 ? _a : TestKind_1.TestKind.JMX;
-    // TODO(harshanb): Remove this once Locust is GA.
-    if (!constants_1.FeatureFlags.IsLocustEnabled && kind === TestKind_1.TestKind.Locust) {
-        return { valid: false, error: `The value "${kind}" for testType is invalid. Acceptable values are URL and JMX.` };
-    }
     if (!isValidTestKind(kind)) {
         return { valid: false, error: `The value "${kind}" for testType is invalid. Acceptable values are ${EngineUtil.Resources.Strings.allFrameworksFriendly}.` };
     }
diff --git a/sample-test-jmx.yaml b/sample-test-jmx.yaml
@@ -2,7 +2,7 @@ version: v0.1
 testName: testId
 testPlan: SampleApp.jmx
 testType: JMX
-description: 'E2E for the build pipeline'
+description: 'E2E for the build pipeline (JMX)'
 env:
 - name: domain
   value: example.com
diff --git a/sample-test-locust.yaml b/sample-test-locust.yaml
@@ -0,0 +1,17 @@
+version: v0.1
+testName: testId
+testPlan: SampleApp.py
+testType: Locust
+description: 'E2E for the build pipeline (Locust)'
+env:
+- name: domain
+  value: example.com
+- name: protocol
+  value: https
+- name: LOCUST_USERS
+  value: 1
+- name: LOCUST_RUN_TIME
+  value: 60
+autoStop:
+  errorPercentage: 90
+  timeWindow: 60
diff --git a/sample-test-url.yaml b/sample-test-url.yaml
@@ -2,4 +2,4 @@ version: v0.1
 testName: testId
 testPlan: sample-test.json
 testType: URL
-description: 'E2E for the build pipeline'
+description: 'E2E for the build pipeline (URL)'
diff --git a/src/constants.ts b/src/constants.ts
@@ -46,7 +46,3 @@ export const defaultYaml: any =
         }
     ]
 }
-
-export module FeatureFlags {
-    export const IsLocustEnabled = true;
-}
diff --git a/src/main.ts b/src/main.ts
@@ -6,7 +6,6 @@ import * as Util from './engine/Util';
 import { TestKind } from "./engine/TestKind";
 import * as fs from 'fs';
 import { isNullOrUndefined } from 'util';
-import { FeatureFlags } from './constants';
 
 const resultFolder = 'loadTest';
 const reportZipFileName = 'report.zip';
@@ -167,21 +166,11 @@ async function uploadTestPlan()
     let filename = map.getFileName(filepath);
     var urlSuffix = "tests/"+testId+"/files/"+filename+"?api-version="+util.apiConstants.latestVersion;
 
-    let fileType = FileType.JMX_FILE;
-        if(map.getTestKind() == TestKind.URL){
-            fileType = FileType.URL_TEST_CONFIG;
-        }
-        else {
-            //TODO(harshanb): Change to TEST_SCRIPT for all non-URL once Locust is GA
-            // If IsLocustEnabled is False, then kind cannot be Locust as validations would catch it
-            if (map.getTestKind() == TestKind.JMX) {
-                fileType = FileType.JMX_FILE;
-            }
-            else {
-                fileType = FileType.TEST_SCRIPT;
-            }
-        }
-        urlSuffix = baseURL + urlSuffix + ("&fileType=" + fileType);
+    let fileType = FileType.TEST_SCRIPT;
+    if(map.getTestKind() == TestKind.URL){
+        fileType = FileType.URL_TEST_CONFIG;
+    }
+    urlSuffix = baseURL + urlSuffix + ("&fileType=" + fileType);
 
     let headers = await map.UploadAndValidateHeader();
     let uploadresult = await util.httpClientRetries(urlSuffix,headers,'put',3,filepath,true);
diff --git a/src/util.ts b/src/util.ts
@@ -9,7 +9,7 @@ const httpClient: httpc.HttpClient = new httpc.HttpClient('MALT-GHACTION');
 import { IHttpClientResponse, IHeaders } from 'typed-rest-client/Interfaces';
 import { Readable } from 'stream';
 import { isNull, isUndefined, isNullOrUndefined } from 'util';
-import { FeatureFlags, defaultYaml } from './constants';
+import { defaultYaml } from './constants';
 import * as EngineUtil from './engine/Util';
 import { BaseLoadTestFrameworkModel } from './engine/BaseLoadTestFrameworkModel';
 import { TestKind } from "./engine/TestKind";
@@ -304,11 +304,6 @@ export function checkValidityYaml(givenYaml : any) : {valid : boolean, error : s
 
     let kind : TestKind = givenYaml.testType ?? TestKind.JMX;
 
-    // TODO(harshanb): Remove this once Locust is GA.
-    if (!FeatureFlags.IsLocustEnabled && kind !== TestKind.JMX && kind !== TestKind.URL) {
-        return {valid : false, error : `The value "${kind}" for testType is invalid. Acceptable values are URL and JMX.`};
-    }
-
     if(!isValidTestKind(kind)){
         return {valid : false, error : `The value "${kind}" for testType is invalid. Acceptable values are ${EngineUtil.Resources.Strings.allFrameworksFriendly}.`};
     }
diff --git a/test/Utils/checkForValidationOfYaml.test.ts b/test/Utils/checkForValidationOfYaml.test.ts
@@ -1,4 +1,3 @@
-import { FeatureFlags } from '../../src/constants';
 import { checkValidityYaml } from '../../src/util'
 import * as constants from './testYamls';
 
@@ -26,10 +25,7 @@ describe('invalid Yaml tests', () =>{
       expect(checkValidityYaml(constants.invalidDescription)).toStrictEqual({valid : false, error : 'The value "Load test website home page bvfjnabgoidvcb Load test website home page bvfjnabgoidvcb Load test website home page bvfjnabgoidvcb Load test website home page bvfjnabgoidvcb" for description is invalid. Description must be a string of length less than 100.'}); 
     });
     test('invalid testType', () => {
-      if (FeatureFlags.IsLocustEnabled)
-        expect(checkValidityYaml(constants.invalidTestType)).toStrictEqual({valid : false, error : 'The value "Invalid" for testType is invalid. Acceptable values are URL, JMX and Locust.'});
-      else
-        expect(checkValidityYaml(constants.invalidTestType)).toStrictEqual({valid : false, error : 'The value "Invalid" for testType is invalid. Acceptable values are URL and JMX.'});
+      expect(checkValidityYaml(constants.invalidTestType)).toStrictEqual({valid : false, error : 'The value "Invalid" for testType is invalid. Acceptable values are URL, JMX and Locust.'});
     });
     test('invalid testPlan URL', () => {
       expect(checkValidityYaml(constants.wrongTestPlanURL)).toStrictEqual({valid : false, error : 'The testPlan for a URL test should of type "json".'});
@@ -38,9 +34,7 @@ describe('invalid Yaml tests', () =>{
       expect(checkValidityYaml(constants.wrongTestPlanJMX)).toStrictEqual({valid : false, error : 'The testPlan for a JMX test should of type "jmx".'});
     });
     test('invalid testPlan Locust', () => {
-      let expectedErr = FeatureFlags.IsLocustEnabled
-        ? 'The testPlan for a Locust test should of type "py".'
-        : 'The value "Locust" for testType is invalid. Acceptable values are URL and JMX.';
+      let expectedErr = 'The testPlan for a Locust test should of type "py".';
       expect(checkValidityYaml(constants.wrongTestPlanLocust)).toStrictEqual({valid : false, error : expectedErr});
     });
   });
@@ -103,9 +97,7 @@ describe('invalid Yaml tests', () =>{
       expect(checkValidityYaml(constants.invalidUserProp2)).toStrictEqual({valid : false, error : `The value "123" for userPropertyFile is invalid. Provide a valid file path of type ".properties". Refer to the YAML syntax at https://learn.microsoft.com/azure/load-testing/reference-test-config-yaml#properties-configuration.`});
     });
     test('user prop is invalid for Locust', () => {
-      let expectedErr = FeatureFlags.IsLocustEnabled
-        ? `The value "invalid.properties" for userPropertyFile is invalid. Provide a valid file path of type ".conf", ".toml" or ".ini". Refer to the YAML syntax at https://learn.microsoft.com/azure/load-testing/reference-test-config-yaml#properties-configuration.`
-        : 'The value "Locust" for testType is invalid. Acceptable values are URL and JMX.';
+      let expectedErr = `The value "invalid.properties" for userPropertyFile is invalid. Provide a valid file path of type ".conf", ".toml" or ".ini". Refer to the YAML syntax at https://learn.microsoft.com/azure/load-testing/reference-test-config-yaml#properties-configuration.`;
       expect(checkValidityYaml(constants.invalidUserProp3)).toStrictEqual({valid : false, error : expectedErr});
     });
   });
@@ -150,9 +142,7 @@ describe('valid yaml tests', () => {
     expect(checkValidityYaml(constants.urlYaml)).toStrictEqual({valid : true, error : ""});
   });
   test('Locust test', () => {
-    let expectedErr = FeatureFlags.IsLocustEnabled
-      ? {valid : true, error : ""}
-      : {valid : false, error : 'The value "Locust" for testType is invalid. Acceptable values are URL and JMX.'};
+    let expectedErr = {valid : true, error : ""};
     expect(checkValidityYaml(constants.locustYaml)).toStrictEqual(expectedErr);
   });
   test('subnet id and PIP is true', () => {

Original file line number	Diff line number	Diff line change
`@@ -351,10 +351,6 @@ function checkValidityYaml(givenYaml) {`
`351`	`351`	return { valid: false, error: `The value "${givenYaml.engineInstances}" for engineInstances is invalid. The value should be an integer between 1 and 400.` };
`352`	`352`	`}`
`353`	`353`	`let kind = (_a = givenYaml.testType) !== null && _a !== void 0 ? _a : TestKind_1.TestKind.JMX;`
`354`		`- // TODO(harshanb): Remove this once Locust is GA.`
`355`		`- if (!constants_1.FeatureFlags.IsLocustEnabled && kind === TestKind_1.TestKind.Locust) {`
`356`		- return { valid: false, error: `The value "${kind}" for testType is invalid. Acceptable values are URL and JMX.` };
`357`		`- }`
`358`	`354`	`if (!isValidTestKind(kind)) {`
`359`	`355`	return { valid: false, error: `The value "${kind}" for testType is invalid. Acceptable values are ${EngineUtil.Resources.Strings.allFrameworksFriendly}.` };
`360`	`356`	`}`
Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,3 @@ export const defaultYaml: any =`
`46`	`46`	`}`
`47`	`47`	`]`
`48`	`48`	`}`
`49`		`-`
`50`		`-export module FeatureFlags {`
`51`		`- export const IsLocustEnabled = true;`
`52`		`-}`