E2e/feature/ri 5707 add sso support for linux (#4075)

* RI-5707_add-sso-support-for-linux

* add installing xdotool

* fixes for linux

* test run

* add installing chrome to config.yml

* run only desktop tests

* update for .sh

* add desktop file utils

* fix

* add install xvfb

* fixes

* change getOpenedChromeTab

* fix

* delete logs file after test run

* e2e/bugfix/fix-tsconfig

* change method to get chrome tab url

* fix for deps

* add more logs

* make chrome as default browser

* change port for cdp

* change port for CDP

* fix for local deeplink and new log

* add configs for chrome

* modifications

* add chrome arguments

* return back opening tab

* check if chrome is visible

* change config

* add timeout

* add logs

* add timeout before pgrep chrome

* change ordering

* check

* increase timeout

* remove duplicated method to open chrome

* change exec

* change for execSync

* change rte

* return back rte

* add timeout

* increase timeout

* increase open chrome tab url timeout

* add runExecutionTimeout

* add testExecutionTimeout

* add attempts++ after new tab found

* change sync methods to async

* change getOpenedChromeTab

* change chrome tags

* remove waiters

* fix

* fix for writefile

* add log

* add waiter

* add screenshot for selenium

* change path

* change screenshots path

* add condition to click google btn

* try playwright for google auth

* dep fix

* deps fix 2

* add playwright install

* change command

* add puppeteer stealth

* add puppeteer

* improvements for stealth plugin

* check puppeteer real browser

* add screenshots for pass

* add waiter before password

* remove csp

* check with proxy

* change turnstile

* add scrapeops proxy

* add args for chrome

* check without args

* add chrome data dir

* fix for tar export

* fix for path

* fix path

* update user data dir path

* update data dir

* fix path for userDataDir

* save chrome data dir to artifacts

* save data after tests

* comment download chrome profile

* fix active save google data step

* return back using user data dir

* add timeout

* add userdatadir to chrome

* sign in with github

* check saml

* fixes for sso saml flow

* fix for user name

* updates for structure

* add submitGithubForm()

* remove playwright

* return back long string

* check with reopening chrome

* add timeout for waiter

* add wait to test

* fixes

* move get platform()

* change waiters

* add more attempts

* run chrome in background

* change timeout

* change retries

* check with closed chrome

* check with closing chrome

* increase timeout

* add small timeout

* updates for syntax

* check without user data dir

* unskip test

* remote some waiters

* return back all tests

* add changes for github actions

* remove display:99

Author: vlad-dargel

.circleci/config.yml.backup

@@ -396,15 +396,36 @@ jobs:
       - attach_workspace:
           at: .
       - run: sudo apt-get install net-tools
+      - run: sudo apt-get install xdotool
+      - run: sudo apt-get install -y desktop-file-utils
+      - run:
+          name: Install Google Chrome
+          command: |
+            wget -q -O - https://dl.google.com/linux/linux_signing_key.pub | sudo apt-key add -
+            sudo sh -c 'echo "deb [arch=amd64] http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google-chrome.list'
+            sudo apt-get update
+            sudo apt-get install -y google-chrome-stable
+            sudo apt-get install -y \
+            libnss3 \
+            libgconf-2-4 \
+            libxss1 \
+            libasound2
+            xdg-settings set default-web-browser google-chrome.desktop
       - run:
           name: Install WM
           command: sudo apt install fluxbox
       - run:
-          name: Run X11
+          name: Install Xvfb
+          command: sudo apt-get install -y xvfb
+      - run:
+          name: Start Xvfb
           command: |
-            Xvfb :99 -screen 0 1920x1080x24 &
+            if [ -f /tmp/.X99-lock ]; then rm /tmp/.X99-lock; fi
+            Xvfb :99 -ac -screen 0 1920x1080x24 &
             sleep 3
             fluxbox &
+            export DISPLAY=:99
+            echo $DISPLAY
       # - run:
       #     name: Clone mocked RDI server
       #     command: |

.circleci/e2e/test.app-image.sh

@@ -3,20 +3,52 @@ set -e
 
 yarn --cwd tests/e2e install
 
-# mount app resources
-./release/*.AppImage --appimage-mount >> apppath &
+# Create the ri-test directory if it doesn't exist
+mkdir -p ri-test
+
+# Extract the AppImage
+chmod +x ./release/*.AppImage
+./release/*.AppImage --appimage-extract
+
+# Move contents of squashfs-root to ri-test and remove squashfs-root folder
+mv squashfs-root/* ri-test/
+rm -rf squashfs-root
+
+# Export custom XDG_DATA_DIRS with ri-test
+export XDG_DATA_DIRS="$(pwd)/ri-test:$XDG_DATA_DIRS"
 
 # create folder before tests run to prevent permissions issue
 mkdir -p tests/e2e/remote
 mkdir -p tests/e2e/rdi
 
-# run rte
+# Create a custom .desktop file for RedisInsight
+cat > ri-test/redisinsight.desktop <<EOL
+[Desktop Entry]
+Version=1.0
+Name=RedisInsight
+Exec=$(pwd)/ri-test/redisinsight %u
+Icon=$(pwd)/ri-test/resources/app.asar/img/icon.png
+Type=Application
+Terminal=false
+MimeType=x-scheme-handler/redisinsight;
+EOL
+
+# Copy the .desktop file to the local applications directory
+cp ri-test/redisinsight.desktop "$HOME/.local/share/applications"
+
+# Update the desktop database with custom directory
+update-desktop-database "$(pwd)/ri-test/"
+
+# Register the RedisInsight deeplink protocol
+xdg-mime default redisinsight.desktop x-scheme-handler/redisinsight
+
+# Run rte
 docker-compose -f tests/e2e/rte.docker-compose.yml build
 docker-compose -f tests/e2e/rte.docker-compose.yml up --force-recreate -d -V
 ./tests/e2e/wait-for-redis.sh localhost 12000 && \
 
-# run tests
-COMMON_URL=$(tail -n 1 apppath)/resources/app.asar/dist/renderer/index.html \
-ELECTRON_PATH=$(tail -n 1 apppath)/redisinsight \
+# Run tests
+COMMON_URL=$(pwd)/ri-test/resources/app.asar/dist/renderer/index.html \
+ELECTRON_PATH=$(pwd)/ri-test/redisinsight \
 RI_SOCKETS_CORS=true \
 yarn --cwd tests/e2e dotenv -e .desktop.env yarn --cwd tests/e2e test:desktop:ci

.github/e2e/test.app-image.sh

@@ -3,21 +3,52 @@ set -e
 
 yarn --cwd tests/e2e install
 
-# mount app resources
+# Create the ri-test directory if it doesn't exist
+mkdir -p ri-test
+
+# Extract the AppImage
 chmod +x ./release/*.AppImage
-./release/*.AppImage --appimage-mount >> apppath &
+./release/*.AppImage --appimage-extract
+
+# Move contents of squashfs-root to ri-test and remove squashfs-root folder
+mv squashfs-root/* ri-test/
+rm -rf squashfs-root
+
+# Export custom XDG_DATA_DIRS with ri-test
+export XDG_DATA_DIRS="$(pwd)/ri-test:$XDG_DATA_DIRS"
 
 # create folder before tests run to prevent permissions issue
 mkdir -p tests/e2e/remote
 mkdir -p tests/e2e/rdi
 
-# run rte
-docker compose -f tests/e2e/rte.docker-compose.yml build
-docker compose -f tests/e2e/rte.docker-compose.yml up --force-recreate -d -V
+# Create a custom .desktop file for RedisInsight
+cat > ri-test/redisinsight.desktop <<EOL
+[Desktop Entry]
+Version=1.0
+Name=RedisInsight
+Exec=$(pwd)/ri-test/redisinsight %u
+Icon=$(pwd)/ri-test/resources/app.asar/img/icon.png
+Type=Application
+Terminal=false
+MimeType=x-scheme-handler/redisinsight;
+EOL
+
+# Copy the .desktop file to the local applications directory
+cp ri-test/redisinsight.desktop "$HOME/.local/share/applications"
+
+# Update the desktop database with custom directory
+update-desktop-database "$(pwd)/ri-test/"
+
+# Register the RedisInsight deeplink protocol
+xdg-mime default redisinsight.desktop x-scheme-handler/redisinsight
+
+# Run rte
+docker-compose -f tests/e2e/rte.docker-compose.yml build
+docker-compose -f tests/e2e/rte.docker-compose.yml up --force-recreate -d -V
 ./tests/e2e/wait-for-redis.sh localhost 12000 && \
 
-# run tests
-COMMON_URL=$(tail -n 1 apppath)/resources/app.asar/dist/renderer/index.html \
-ELECTRON_PATH=$(tail -n 1 apppath)/redisinsight \
+# Run tests
+COMMON_URL=$(pwd)/ri-test/resources/app.asar/dist/renderer/index.html \
+ELECTRON_PATH=$(pwd)/ri-test/redisinsight \
 RI_SOCKETS_CORS=true \
 yarn --cwd tests/e2e dotenv -e .desktop.env yarn --cwd tests/e2e test:desktop:ci

.github/workflows/tests-e2e-appimage.yml

@@ -49,20 +49,29 @@ jobs:
       with:
         detached: true
 
-    - name: Install WM
+    - name: Install necessary packages
       run: |
         sudo apt-get update -y
-        sudo apt-get install kmod libfuse2 xvfb net-tools fluxbox netcat -y
+        sudo apt-get install kmod libfuse2 xvfb net-tools xdotool desktop-file-utils fluxbox netcat -y
+
+    - name: Install Google Chrome
+      run: |
+        wget -q -O - https://dl.google.com/linux/linux_signing_key.pub | sudo apt-key add -
+        sudo sh -c 'echo "deb [arch=amd64] http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google-chrome.list'
+        sudo apt-get update
+        sudo apt-get install -y google-chrome-stable libnss3 libgconf-2-4 libxss1 libasound2
+        xdg-settings set default-web-browser google-chrome.desktop
 
     - name: Download AppImage Artifacts
       uses: actions/download-artifact@v4
       with:
         name: linux-builds
         path: ./release
 
-    - name: Run X11
+    - name: Start Xvfb
       run: |
-        Xvfb :99 -screen 0 1920x1080x24 &
+        if [ -f /tmp/.X99-lock ]; then rm /tmp/.X99-lock; fi
+        Xvfb :99 -ac -screen 0 1920x1080x24 &
         sleep 3
         fluxbox &
 

tests/e2e/.gitignore

@@ -9,3 +9,4 @@ remote
 rihomedir
 rdi
 rte/rdi
+chrome_logs.txt

tests/e2e/desktop.runner.ci.ts

@@ -34,13 +34,15 @@ import testcafe from 'testcafe';
                 ])
                 .run({
                     skipJsErrors: true,
-                    browserInitTimeout: 60000,
-                    selectorTimeout: 5000,
-                    assertionTimeout: 5000,
+                    browserInitTimeout: 120000,
+                    selectorTimeout: 10000,
+                    assertionTimeout: 10000,
                     speed: 1,
                     quarantineMode: { successThreshold: 1, attemptLimit: 3 },
-                    pageRequestTimeout: 8000,
-                    disableMultipleWindows: true
+                    pageRequestTimeout: 20000,
+                    disableMultipleWindows: true,
+                    runExecutionTimeout: 280000,
+                    testExecutionTimeout: 280000
                 });
         })
         .then((failedCount) => {

tests/e2e/helpers/common.ts

@@ -9,9 +9,9 @@ const chance = new Chance();
 
 declare global {
     interface Window {
-      windowId?: string
+        windowId?: string
     }
-  }
+}
 
 const settingsApiUrl = `${apiUrl}/settings`;
 process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0'; // lgtm[js/disabling-certificate-validation]
@@ -180,17 +180,17 @@ export class Common {
      * @param expectedUrl Expected link that is compared with actual
      */
     static async checkURL(expectedUrl: string): Promise<void> {
-        const getPageUrl = ClientFunction(() => window.location.href);
-        await t.expect(getPageUrl()).eql(expectedUrl, 'Opened URL is not correct');
+        const getPageUrl = await this.getPageUrl();
+        await t.expect(getPageUrl).eql(expectedUrl, 'Opened URL is not correct');
     }
 
     /**
      * Check opened URL contains text
      * @param expectedText Expected link that is compared with actual
      */
     static async checkURLContainsText(expectedText: string): Promise<void> {
-        const getPageUrl = ClientFunction(() => window.location.href);
-        await t.expect(getPageUrl()).contains(expectedText, `Opened URL not contains text ${expectedText}`);
+        const getPageUrl = await this.getPageUrl();
+        await t.expect(getPageUrl).contains(expectedText, `Opened URL not contains text ${expectedText}`);
     }
 
     /**
@@ -207,7 +207,7 @@ export class Common {
      * Get current page url
      */
     static async getPageUrl(): Promise<string> {
-        return (await ClientFunction(() => window.location.href))();
+        return (ClientFunction(() => window.location.href))();
     }
 
     /**
@@ -247,19 +247,37 @@ export class Common {
 
     /**
       * Delete file from folder
-      * @param folderPath Path to file
+      * @param filePath Path to file
      */
     static async deleteFileFromFolder(filePath: string): Promise<void> {
         fs.unlinkSync(path.join(__dirname, filePath));
     }
 
     /**
       * Delete file from folder if exists
-      * @param folderPath Path to file
+      * @param filePath Path to file
      */
     static async deleteFileFromFolderIfExists(filePath: string): Promise<void> {
         if (fs.existsSync(filePath)) {
             fs.unlinkSync(filePath);
         }
     }
+
+    /**
+      * Read file from folder
+      * @param filePath Path to file
+     */
+    static async readFileFromFolder(filePath: string): Promise<string> {
+        return fs.readFileSync(filePath, 'utf8');
+    }
+
+    /**
+      * Get current machine platform
+     */
+    static getPlatform(): { isMac: boolean, isLinux: boolean } {
+        return {
+            isMac: process.platform === 'darwin',
+            isLinux: process.platform === 'linux'
+        };
+    }
 }

tests/e2e/helpers/conf.ts

@@ -9,6 +9,8 @@ export const commonUrl = process.env.COMMON_URL || 'https://localhost:5540';
 export const apiUrl = process.env.API_URL || 'https://localhost:5540/api';
 export const googleUser = process.env.GOOGLE_USER || '';
 export const googleUserPassword = process.env.GOOGLE_USER_PASSWORD || '';
+export const samlUser = process.env.E2E_SSO_EMAIL || '';
+export const samlUserPassword = process.env.E2E_SSO_PASSWORD || '';
 
 export const workingDirectory = process.env.RI_APP_FOLDER_ABSOLUTE_PATH
     || (joinPath(os.homedir(), process.env.RI_APP_FOLDER_NAME || '.redis-insight'));

tests/e2e/helpers/google-authorization.ts

@@ -1,12 +1,14 @@
 import { DatabaseScripts, DbTableParameters } from './database-scripts';
 import { Common } from './common';
 import { DatabaseHelper } from './database';
+import { SsoAuthorization } from './sso-authorization';
 import { Telemetry } from './telemetry';
 
 export {
     DatabaseScripts,
     DbTableParameters,
     Common,
     DatabaseHelper,
+    SsoAuthorization,
     Telemetry
 };