E2E test: generalize code suggestions webIDE test

qa/qa/page/project/web_ide/vscode.rb

@@ -32,7 +32,7 @@ def click_inside_editor_frame
           end
 
           def within_file_editor(&block)
-            within_element('.monaco-editor', &block)
+            within_element('.monaco-editor .monaco-scrollable-element', &block)
           end
 
           def has_right_click_menu_item?
@@ -262,25 +262,43 @@ def wait_until_code_suggestions_enabled
 
           def has_code_suggestions_status?(status)
             page.document.has_css?(
-              "#GitLab\\.gitlab-workflow\\.gl\\.status\\.code_suggestions[aria-label~=#{status.downcase}]"
+              "#GitLab\\.gitlab-workflow\\.gl\\.status\\.code_suggestions[aria-label*=#{status.downcase}]"
             )
           end
 
-          def verify_prompt_appears_and_accept(pattern)
+          def wait_for_code_suggestion
             within_vscode_editor do
               within_file_editor do
-                Support::Waiter.wait_until(max_duration: 60, message: 'Wait for suggestion to appear') do
-                  page.text.match?(pattern)
+                wait_until(max_duration: 30, message: 'Waiting for Code Suggestion to start loading') do
+                  has_code_suggestions_status?('loading')
                 end
+
+                # Wait for code suggestion to finish loading
+                wait_until_code_suggestions_enabled
+              end
+            end
+          end
+
+          def accept_code_suggestion
+            within_vscode_editor do
+              within_file_editor do
                 send_keys(:tab)
               end
             end
           end
 
-          def validate_prompt(pattern)
+          def editor_content_length
+            within_vscode_editor do
+              within_file_editor do
+                page.text.length
+              end
+            end
+          end
+
+          def editor_content_lines
             within_vscode_editor do
               within_file_editor do
-                page.text.match?(pattern)
+                page.text.lines.count
               end
             end
           end

qa/qa/specs/features/ee/browser_ui/3_create/web_ide/code_suggestions_in_web_ide_spec.rb

@@ -10,17 +10,6 @@ module QA
       let(:project) { create(:project, :with_readme, name: 'webide-code-suggestions-project') }
       let(:file_name) { 'new_file.rb' }
 
-      shared_examples 'code suggestions in the Web IDE' do |testcase|
-        it 'returns a suggestion which can be accepted', testcase: testcase do
-          Page::Project::WebIDE::VSCode.perform do |ide|
-            ide.add_prompt_into_a_file(file_name, prompt_data)
-            ide.verify_prompt_appears_and_accept(prompt_regex)
-
-            expect(ide.validate_prompt(prompt_regex)).to eq true
-          end
-        end
-      end
-
       before do
         Flow::Login.sign_in
 
@@ -35,19 +24,46 @@ module QA
 
       context 'when requesting code generation' do
         let(:prompt_data) { 'def reverse_string' }
-        let(:prompt_regex) { /\.reverse/ }
 
-        it_behaves_like 'code suggestions in the Web IDE', 'https://gitlab.com/gitlab-org/gitlab/-/quality/test_cases/425756'
+        it 'returns a suggestion which can be accepted',
+          testcase: 'https://gitlab.com/gitlab-org/gitlab/-/quality/test_cases/425756' do
+          Page::Project::WebIDE::VSCode.perform do |ide|
+            ide.add_prompt_into_a_file(file_name, prompt_data)
+            previous_content_length = ide.editor_content_length
+            previous_content_lines = ide.editor_content_lines
+
+            # code generation will put suggestion on the next line
+            ide.wait_for_code_suggestion
+            expect(ide.editor_content_length).to be > previous_content_length, "Expected a suggestion"
+            expect(ide.editor_content_lines).to be > previous_content_lines, "Expected additional lines in suggestion"
+
+            ide.accept_code_suggestion
+            expect(ide.editor_content_length).to be > previous_content_length, "Expected accepted suggestion in file"
+            expect(ide.editor_content_lines).to be > previous_content_lines, "Expected additional lines in file"
+          end
+        end
       end
 
       context 'when requesting code completion' do
         let(:prompt_data) { "def set_name(whitespace_name)\n    this.name = whitespace_name." }
 
-        # We check that any character is suggested after the prompt,
-        # except a new line, as code completions appear on the same line
-        let(:prompt_regex) { /whitespace_name\.[^\n]/ }
+        it 'returns a suggestion which can be accepted',
+          testcase: 'https://gitlab.com/gitlab-org/gitlab/-/quality/test_cases/437111' do
+          Page::Project::WebIDE::VSCode.perform do |ide|
+            ide.add_prompt_into_a_file(file_name, prompt_data)
+            previous_content_length = ide.editor_content_length
+            previous_content_lines = ide.editor_content_lines
+
+            # code completion will put suggestion on the same line
+            ide.wait_for_code_suggestion
+            expect(ide.editor_content_length).to be > previous_content_length, 'Expected a suggestion'
+            expect(ide.editor_content_lines).to eq(previous_content_lines), 'Expected suggestion on same line'
 
-        it_behaves_like 'code suggestions in the Web IDE', 'https://gitlab.com/gitlab-org/gitlab/-/quality/test_cases/437111'
+            ide.accept_code_suggestion
+            expect(ide.editor_content_length).to be > previous_content_length, 'Expected accepted suggestion in file'
+            expect(ide.editor_content_lines).to eq(previous_content_lines), 'Expected suggestion on same line'
+          end
+        end
       end
     end
   end