From 5dc6a39652c56b7a047d6fe0d718395ee87fa229 Mon Sep 17 00:00:00 2001 From: Alan Ren Date: Mon, 8 Apr 2019 16:25:53 -0700 Subject: [PATCH] Update readme.md (#4907) --- extensions/integration-tests/readme.md | 44 ++++++++++++-------------- 1 file changed, 21 insertions(+), 23 deletions(-) diff --git a/extensions/integration-tests/readme.md b/extensions/integration-tests/readme.md index aef2f04895..9299a6812c 100644 --- a/extensions/integration-tests/readme.md +++ b/extensions/integration-tests/readme.md @@ -1,36 +1,34 @@ -#Integration tests -This integration-tests suite is based on the extension testing feature provided by VS Code, We can use this for: -a. Commands for setting up the environment for feature testing. -b. Adding test cases that do not need UI interaction or the test scenarios not supported by the UI automation framework (e.g. object explorer context menu – not html based) +## Integration tests +The integration-tests suite is based on the extension testing feature provided by VS Code, We can use this for: +* Commands for setting up the environment for feature testing. +* Adding test cases that do not need UI interaction or the test scenarios not supported by the UI automation framework (e.g. object explorer context menu – not html based) -extensionInstallers folder: copy the VISX installers for the extensions we would like to run the tests with. -src folder: this is where the test file for features should be added, name the file like this: feature.test.ts. e.g. objectExplorer.test.ts +##### Folders +* extensionInstallers folder: Copy the VISX installers for the extensions we would like to run the tests with. +* src folder: This is where the test file for features should be added, name the file like this: feature.test.ts. e.g. objectExplorer.test.ts ADS will be launched using new temp folders: extension folder and data folder so that your local dev environment won't be changed. -##How to run the test: -1. In the build pipeline: +## How to run the test +1. In the build pipeline: The integration test suite has been added to ADS windows pipeline to run the test and report the results, you can find the test results under the test tab. -2. Local environment: -a. open a terminal window/command line window.(When testing on Mac we found some issue with VSCode scenario, you might have to close VSCode before running the command) -b. navigate to this folder and then run 'node setEnvironmentVariables.js' - there are different options, by default VSCode will be opened. - 1. Terminal(Mac)/CMD(Windows): node setEnvironmentVariables.js Terminal - 2. Git-Bash on Windows: node setEnvironmentVariables.js BashWin -c. follow the instructions in the window: you will be prompted to login to azure portal. -d. a new window will be opened based on your selection and the new window will have the required environment variables set. -e. in the new window navigate to the scripts folder and run sql-test-integration.bat or sql-test-integration.sh based on your environment. +2. Local environment: + 1. open a terminal window/command line window. (When testing on Mac we found some issue with VSCode scenario, you might have to close VSCode before running the command) + 2. navigate to this folder and then run 'node setEnvironmentVariables.js', there are different options, by default VSCode will be opened. + 1. Terminal(Mac)/CMD(Windows): node setEnvironmentVariables.js Terminal + 2. Git-Bash on Windows: node setEnvironmentVariables.js BashWin + 3. Follow the instructions in the window: you will be prompted to login to azure portal. + 4. A new window will be opened based on your selection and the new window will have the required environment variables set. + 5. In the new window navigate to the scripts folder and run sql-test-integration.bat or sql-test-integration.sh based on your environment. +## UI automation testing +The UI automation test cases should be added under $root/test/smoke/src/sql folder. Each feature should create its own folder and add 2 files, one for accessing the feature and the other for the test cases. For example: objectExplorer.ts and objectExplorer.test.ts. only tested on Windows for now. -#UI automation testing: -the ADS UI automation test cases should be added under $root/test/smoke/src/sql folder. Each feature should create its own folder and add 2 files, one for accessing the feature and the other for the test cases. For example: objectExplorer.ts and objectExplorer.test.ts. only tested on Windows for now. - -##How to run the test: - +## How to run the test 1. In the build pipeline: The smoke test suite has been added to ADS windows pipeline to run the test and report the results, you can find the test results under the test tab. 2. Local environment navigate to test/smoke folder and run: node test/index.js -You can also run UI automation from VSCode by selecting the launch option: Launch Smoke Test. \ No newline at end of file +You can also run UI automation from VSCode by selecting the launch option: Launch Smoke Test.