Merge pull request #1085 from RedisInsight/e2e/enhance-command-helper-ui

E2e/enhance command helper UI

Author: vlad-dargel

tests/e2e/common-actions/cli-actions.ts

@@ -0,0 +1,33 @@
+import { t } from 'testcafe';
+import { CliPage } from '../pageObjects';
+
+const cliPage = new CliPage();
+
+export class CliActions {
+    
+    /**
+     * Check list of commands searched
+     * @param searchedCommand Searched command in Command Helper
+     * @param listToCompare The list with commands to compare with opened in Command Helper
+     */
+     async checkSearchedCommandInCommandHelper(searchedCommand: string, listToCompare: string[]): Promise<void> {
+        await t.typeText(cliPage.cliHelperSearch, searchedCommand, { speed: 0.5 });
+        //Verify results in the output
+        const commandsCount = await cliPage.cliHelperOutputTitles.count;
+        for (let i = 0; i < commandsCount; i++) {
+            await t.expect(cliPage.cliHelperOutputTitles.nth(i).textContent).eql(listToCompare[i], 'Results in the output contains searched value');
+        }
+    }
+
+    /**
+    * Check commands list
+    * @param listToCompare The list with commands to compare with opened in Command Helper
+    */
+    async checkCommandsInCommandHelper(listToCompare: string[]): Promise<void> {
+        //Verify results in the output
+        const commandsCount = await cliPage.cliHelperOutputTitles.count;
+        for (let i = 0; i < commandsCount; i++) {
+            await t.expect(cliPage.cliHelperOutputTitles.nth(i).textContent).eql(listToCompare[i], 'Results in the output not contain searched value');
+        }
+    }
+}

tests/e2e/pageObjects/cli-page.ts

@@ -27,6 +27,7 @@ export class CliPage {
     commandHelperBadge = Selector('[data-testid=expand-command-helper] span');
     cliResizeButton = Selector('[data-test-subj=resize-btn-browser-cli]');
     workbenchLink = Selector('[data-test-subj=cli-workbench-page-btn]');
+    returnToList = Selector('[data-testid=cli-helper-back-to-list-btn]');
     //TEXT INPUTS (also referred to as 'Text fields')
     cliCommandInput = Selector('[data-testid=cli-command]');
     cliArea = Selector('[data-testid=cli');
@@ -58,7 +59,7 @@ export class CliPage {
   * Select filter group type
   * @param groupName The group name
   */
-    async selectFilterGroupType(groupName: string): Promise<void>{
+    async selectFilterGroupType(groupName: string): Promise<void> {
         await t.click(this.filterGroupTypeButton);
         await t.click(this.filterOptionGroupType.withExactText(groupName));
     }
@@ -69,7 +70,7 @@ export class CliPage {
    * @param amount The amount of the keys
    * @param keyName The name of the keys. The default value is keyName
    */
-    async addKeysFromCli(keyCommand: string, amount: number, keyName = 'keyName'): Promise<void>{
+    async addKeysFromCli(keyCommand: string, amount: number, keyName = 'keyName'): Promise<void> {
         //Open CLI
         await t.click(this.cliExpandButton);
         //Add keys
@@ -83,7 +84,7 @@ export class CliPage {
    * Send command in Cli
    * @param command The command to send
    */
-    async sendCommandInCli(command: string): Promise<void>{
+    async sendCommandInCli(command: string): Promise<void> {
         //Open CLI
         await t.click(this.cliExpandButton);
         await t.typeText(this.cliCommandInput, command, { paste: true });
@@ -95,7 +96,7 @@ export class CliPage {
    * Get command result execution
    * @param command The command for send in CLI
    */
-    async getSuccessCommandResultFromCli(command: string): Promise<string>{
+    async getSuccessCommandResultFromCli(command: string): Promise<string> {
         //Open CLI
         await t.click(this.cliExpandButton);
         //Add keys
@@ -127,18 +128,4 @@ export class CliPage {
         await t.click(this.readMoreButton);
         await t.expect(getPageUrl()).eql(url, 'The opened page');
     }
-
-    /**
-     * Check URL of command opened from command helper
-     * @param searchedCommand Searched command in Command Helper
-     * @param listToCompare The list with commands to compare with opened in Command Helper
-     */
-    async checkSearchedCommandInCommandHelper(searchedCommand: string, listToCompare: string[]): Promise<void> {
-        await t.typeText(this.cliHelperSearch, searchedCommand, { speed: 0.5 });
-        //Verify results in the output
-        const commandsCount = await this.cliHelperOutputTitles.count;
-        for (let i = 0; i < commandsCount; i++) {
-            await t.expect(this.cliHelperOutputTitles.nth(i).textContent).eql(listToCompare[i], 'Results in the output contains searched value');
-        }
-    }
 }

tests/e2e/tests/critical-path/cli/cli-command-helper.e2e.ts

@@ -3,8 +3,10 @@ import { acceptLicenseTermsAndAddDatabaseApi } from '../../../helpers/database';
 import { CliPage } from '../../../pageObjects';
 import { commonUrl, ossStandaloneConfig } from '../../../helpers/conf';
 import { deleteStandaloneDatabaseApi } from '../../../helpers/api/api-database';
+import { CliActions } from '../../../common-actions/cli-actions';
 
 const cliPage = new CliPage();
+const cliActions = new CliActions();
 
 const defaultHelperText = 'Enter any command in CLI or use search to see detailed information.';
 const COMMAND_APPEND = 'APPEND';
@@ -116,14 +118,14 @@ test
         //Select group from list and remember commands
         await cliPage.selectFilterGroupType(COMMAND_GROUP_TIMESERIES);
         const commandsFilterCount = await cliPage.cliHelperOutputTitles.count;
-        const timeSeriesCommands = [];
+        const timeSeriesCommands: string[] = [];
         for(let i = 0; i < commandsFilterCount; i++) {
             timeSeriesCommands.push(await cliPage.cliHelperOutputTitles.nth(i).textContent);
         }
         //Unselect group from list
         await cliPage.selectFilterGroupType(COMMAND_GROUP_TIMESERIES);
         //Search per part of command and check all opened commands
-        await cliPage.checkSearchedCommandInCommandHelper(commandForSearch, timeSeriesCommands);
+        await cliActions.checkSearchedCommandInCommandHelper(commandForSearch, timeSeriesCommands);
         //Check the first command documentation url
         await cliPage.checkURLCommand(timeSeriesCommands[0], `https://redis.io/commands/${timeSeriesCommands[0].toLowerCase()}/`);
         await t.switchToParentWindow();
@@ -137,14 +139,14 @@ test
         //Select group from list and remember commands
         await cliPage.selectFilterGroupType(COMMAND_GROUP_GRAPH);
         const commandsFilterCount = await cliPage.cliHelperOutputTitles.count;
-        const graphCommands = [];
+        const graphCommands: string[] = [];
         for(let i = 0; i < commandsFilterCount; i++) {
             graphCommands.push(await cliPage.cliHelperOutputTitles.nth(i).textContent);
         }
         //Unselect group from list
         await cliPage.selectFilterGroupType(COMMAND_GROUP_GRAPH);
         //Search per part of command and check all opened commands
-        await cliPage.checkSearchedCommandInCommandHelper(commandForSearch, graphCommands);
+        await cliActions.checkSearchedCommandInCommandHelper(commandForSearch, graphCommands);
         //Check the first command documentation url
         await cliPage.checkURLCommand(graphCommands[0], externalPageLink);
         await t.switchToParentWindow();

tests/e2e/tests/regression/cli/cli-command-helper.e2e.ts

@@ -8,9 +8,11 @@ import {
 } from '../../../helpers/conf';
 import { env, rte } from '../../../helpers/constants';
 import { deleteStandaloneDatabaseApi } from '../../../helpers/api/api-database';
+import { CliActions } from '../../../common-actions/cli-actions';
 
 const cliPage = new CliPage();
 const common = new Common();
+const cliActions = new CliActions();
 let filteringGroup = '';
 let filteringGroups: string[] = [];
 let commandToCheck = '';
@@ -247,3 +249,27 @@ test
             i++;
         }
     });
+test
+    .meta({ rte: rte.standalone })('Verify that user can go back to list of commands for group in Command Helper', async t => {
+        filteringGroup = 'Search';
+        commandToCheck = 'FT.EXPLAIN';
+        const commandForSearch = 'EXPLAIN';
+        //Open Command Helper
+        await t.click(cliPage.expandCommandHelperButton);
+        //Select one command from the list
+        await t.typeText(cliPage.cliHelperSearch, commandForSearch);
+        await cliPage.selectFilterGroupType(filteringGroup);
+        // Remember found commands
+        const commandsFilterCount = await cliPage.cliHelperOutputTitles.count;
+        const filteredCommands: string[] = [];
+        for (let i = 0; i < commandsFilterCount; i++) {
+            filteredCommands.push(await cliPage.cliHelperOutputTitles.nth(i).textContent);
+        }
+        // Select command
+        await t.click(cliPage.cliHelperOutputTitles.withExactText(commandToCheck));
+        // Click return button
+        await t.click(cliPage.returnToList);
+        // Check that user returned to list with filter and search applied
+        await cliActions.checkCommandsInCommandHelper(filteredCommands);
+        await t.expect(cliPage.returnToList.exists).notOk('Return to list button still displayed');
+    });