onlyoffice_documentserver_testing_framework 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 44618864c88fe2bd26cbf33d3aec94e873a87e43b75c8d7d88af26747b3f0be1
+  data.tar.gz: c78a22c6e512edee73094216b6837cf72956a0ca2bd9cbea0c08258114543224
+SHA512:
+  metadata.gz: fd93f2d21ed7bfe436c9f3772fe84da2c0563fa6d042d410415da4871a138e7db44d0e3038e1900ebb46578d92fbbc77fd2b16a7e86e93f30fa1b16e3add057c
+  data.tar.gz: d432c1af8e8481f48933dc114baabbd030427ff6f275b28aebffcac239690c02eae82b34ed5ad0f40a4a4b6d5e1c3200e096d63be204ed0617682f7541543701

data/lib/onlyoffice_documentserver_testing_framework.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative 'onlyoffice_documentserver_testing_framework/selenium_wrapper'
+require_relative 'onlyoffice_documentserver_testing_framework/test_instance_docs'
+require_relative 'onlyoffice_documentserver_testing_framework/version'

data/lib/onlyoffice_documentserver_testing_framework/name.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# Namespace of project
+module OnlyofficeDocumentserverTestingFramework
+  # Module to store gem name
+  module Name
+    # [String] name of gem
+    STRING = 'onlyoffice_documentserver_testing_framework'
+  end
+end

data/lib/onlyoffice_documentserver_testing_framework/selenium_wrapper.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+require_relative 'selenium_wrapper/selenium_wrapper_exceptions'
+require_relative 'selenium_wrapper/selenium_wrapper_js_errors'
+module OnlyofficeDocumentserverTestingFramework
+  # Module for handle selenium with frames and some other methods
+  module SeleniumWrapper
+    include SeleniumWrapperJsErrors
+
+    # Main wrapper function
+    # @param name [Symbol] function to call
+    # @param arguments [Hash] list of arguments
+    # @return [Object] result of method
+    def selenium_functions(name, *arguments)
+      select_frame do
+        @instance.selenium.send name, *arguments
+      end
+    end
+
+    # Select actual frame of Editor
+    def select_frame
+      count_of_frame = @count_of_frame ? frame_count_addition : @instance.management.xpath_iframe_count
+      xpath_of_frame = @xpath_of_frame || @instance.management.xpath_iframe
+      @instance.selenium.select_frame xpath_of_frame, count_of_frame
+      value = yield
+      fail_if_console_error
+      @instance.selenium.select_top_frame
+      value
+    end
+
+    # @return [Integer] frame count with addition
+    def frame_count_addition
+      @count_of_frame + @instance.management.xpath_iframe_count - 1
+    end
+
+    # This method return true if xpath visible on the web page
+    # @param[String] xpath
+    # @return [Boolean]
+    def visible?(xpath)
+      selenium_functions :element_visible?, xpath
+    end
+
+    alias element_visible? visible?
+    alias element_present_and_visible? visible?
+
+    # This method click over button by xpath
+    # @param[String] xpath
+    def click_on_button(xpath)
+      selenium_functions :click_on_locator, xpath
+    end
+
+    # This method return true if button pressed
+    # @param[String] xpath
+    # @return [Boolean]
+    def button_pressed?(xpath)
+      selenium_functions(:get_attribute, xpath, 'class').include?('active')
+    end
+
+    alias button_active? button_pressed?
+
+    # This method return true if button disabled
+    # @param[String] xpath
+    # @return [Boolean]
+    def button_disabled?(xpath)
+      selenium_functions(:get_attribute, xpath, 'class').include?('disabled')
+    end
+
+    # @param xpath [String] xpath of menu
+    # @return [True, False] if menu active
+    def button_menu_active?(xpath)
+      selenium_functions(:get_attribute, xpath, 'class').include?('menu-active')
+    end
+
+    # This method return true if button menu open
+    # @param[String] xpath
+    # @return [Boolean]
+    def button_menu_open?(xpath)
+      element_visible = visible?(xpath)
+      element_visible = selenium_functions(:get_attribute, xpath, 'class').include?('open') if element_visible
+      element_visible
+    end
+
+    # Click on one of several displayed
+    # @param xpath [String] xpath to click
+    # @return [nil]
+    def click_on_of_several_by_display_button(xpath)
+      selenium_functions :click_on_one_of_several_by_display, xpath
+    end
+
+    # Wait to element to appear and click
+    # @param xpath [String] xpath to click
+    # @return [nil]
+    def click_on_displayed_button(xpath)
+      selenium_functions :wait_element, xpath
+      selenium_functions :click_on_displayed, xpath
+    end
+
+    # Is line enabled
+    # @param xpath [String] xpath to check
+    # @return [True, False]
+    def line_enabled?(xpath)
+      selenium_functions :element_visible?, xpath
+    end
+
+    # Is line checked
+    # @param xpath [String] xpath to check
+    # @return [True, False]
+    def line_checked?(xpath)
+      selenium_functions(:get_attribute, xpath, 'class').include?('checked')
+    end
+
+    # Is menu disabled
+    # @param xpath [String] xpath to check
+    # @return [True, False]
+    def menu_disabled?(xpath)
+      selenium_functions(:get_attribute, xpath, 'class').include?('disabled')
+    end
+
+    # Move to element
+    # @param xpath [String] xpath to move
+    # @return [nil]
+    def move_to_element(xpath)
+      selenium_functions :move_to_element_by_locator, xpath
+    end
+
+    # Remove element
+    # @param xpath [String] xpath to remove
+    # @return [nil]
+    def remove_element(xpath)
+      selenium_functions :remove_element, xpath
+    end
+
+    # Get attribute
+    # @param xpath [String] xpath to get attribute
+    # @param attribute [String] attribute to get
+    # @return [String] result of get attribute
+    def get_attribute(xpath, attribute)
+      selenium_functions :get_attribute, xpath, attribute
+    end
+  end
+end

data/lib/onlyoffice_documentserver_testing_framework/selenium_wrapper/selenium_wrapper_exceptions.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module OnlyofficeDocumentserverTestingFramework
+  # Error that raised if element is not may be clicked
+  class ClickOnDisabledElement < StandardError
+  end
+end

data/lib/onlyoffice_documentserver_testing_framework/selenium_wrapper/selenium_wrapper_js_errors.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# Module for working with selenium wrapper JavaScript Errors
+module SeleniumWrapperJsErrors
+  # @return [Array<String>] list of errors should be ignored
+  def ignored_errors
+    return @ignored_errors if @ignored_errors
+
+    @ignored_errors = File.readlines("#{File.expand_path('..', __dir__)}"\
+                                     '/selenium_wrapper/selenium_wrapper_js_errors'\
+                                     '/ignored_errors.list')
+                          .map(&:strip)
+  end
+
+  # Should current error be ignored
+  # @param error_message [String] current error
+  # @return [True, False] should be ignored?
+  def error_ignored?(error_message)
+    return true if ignored_errors.any? { |word| error_message.include?(word) }
+    return true if @instance.env_options['IgnoredJSErrors'].any? { |word| error_message.include?(word) }
+
+    false
+  end
+
+  # @return [Array<String>] list of current console errors
+  def console_errors
+    severe_error = []
+    @instance.webdriver.browser_logs.each do |log|
+      severe_error << log.message if log.level.include?('SEVERE') && !error_ignored?(log.message)
+    end
+    severe_error
+  end
+
+  alias get_console_errors console_errors
+  extend Gem::Deprecate
+  deprecate :get_console_errors, :console_errors, 2025, 1
+
+  # Fail if any JS error happened
+  def fail_if_console_error
+    errors = console_errors
+    return if errors.empty?
+
+    @instance.webdriver.webdriver_error(Selenium::WebDriver::Error::JavascriptError,
+                                        "There are some errors in the Web Console: #{errors}")
+  end
+end

data/lib/onlyoffice_documentserver_testing_framework/selenium_wrapper/selenium_wrapper_js_errors/ignored_errors.list

@@ -0,0 +1,28 @@
+https://signalr.teamlab.info/signalr/negotiate
+https://signalr.onlyoffice.com/signalr/negotiate
+https://www.dropbox.com/
+/bundle/
+/socketio/
+/discbundle/
+/Contents.json
+branding
+favicon.ico
+uservoice
+js/third-party/jquery/jquery.core.js
+js/asc/plugins/
+/platform.twitter.com
+googleads
+pubmatic.com
+rubiconproject.com
+eventhandler
+require.js
+chrome-extension
+Access-Control-Allow-Origin
+SockJS has already been closed
+Failed to load resource: the server responded with a status of 404 ()
+AscFonts
+yastatic.net
+Blocked autofocusing on a form control in a cross-origin subframe.
+/embed
+ResponsiveVoice missing API key
+/libfont/wasm/

data/lib/onlyoffice_documentserver_testing_framework/test_instance_docs.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'onlyoffice_webdriver_wrapper'
+require_relative 'test_instance_docs/common_editor/editor_windows'
+require_relative 'test_instance_docs/doc_editor'
+require_relative 'test_instance_docs/doc_service_welcome'
+require_relative 'test_instance_docs/doc_test_site_functions'
+require_relative 'test_instance_docs/presentation_editor'
+require_relative 'test_instance_docs/spreadsheet_editor'
+require_relative 'test_instance_docs/management'
+
+module OnlyofficeDocumentserverTestingFramework
+  # Main class for browser instance
+  class TestInstanceDocs
+    attr_accessor :selenium
+    alias webdriver selenium
+
+    def initialize(webdriver: OnlyofficeWebdriverWrapper::WebDriver.new(:chrome))
+      @selenium = webdriver
+    end
+
+    # @return [DocServiceWelcome] welcome page of DocumentServer
+    def doc_service_welcome
+      @doc_service_welcome ||= DocServiceWelcome.new(self)
+    end
+
+    # @return [DocTestSiteFunctions] methods for test site
+    def doc_test_functions
+      # Do not cache methods since they use PageObject and cause all sort of troubles
+      # if test run several times with different webdriver
+      DocTestSiteFunctions.new(self)
+    end
+
+    # @return [DocEditor] Document Editor instance
+    def doc_editor
+      @doc_editor ||= DocEditor.new(self)
+    end
+
+    # @return [SpreadsheetEditor] Spreadsheet Editor instance
+    def spreadsheet_editor
+      @spreadsheet_editor ||= SpreadsheetEditor.new(self)
+    end
+
+    # @return [PresentationEditor] editor of presentations
+    def presentation_editor
+      @presentation_editor ||= PresentationEditor.new(self)
+    end
+
+    # @return [Management] management methods
+    def management
+      @management ||= Management.new(self)
+    end
+
+    # @return [Hash] Options read from environment variable
+    def env_options
+      return @env_options if @env_options
+
+      raw_options = ENV['ONLYOFFICE_DS_TESTING_OPTIONS'] || '{}'
+      @env_options = JSON.parse(raw_options)
+      @env_options['IgnoredJSErrors'] = [] unless @env_options['IgnoredJSErrors']
+      @env_options
+    end
+  end
+end

data/lib/onlyoffice_documentserver_testing_framework/test_instance_docs/common_editor/editor_windows.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module OnlyofficeDocumentserverTestingFramework
+  # Place for storing common windows
+  class EditorWindows
+  end
+end

data/lib/onlyoffice_documentserver_testing_framework/test_instance_docs/doc_editor.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative 'doc_editor/doc_editor_top_toolbar'
+require_relative 'doc_editor/doc_editor_windows'
+
+module OnlyofficeDocumentserverTestingFramework
+  # Class for all Doc Editor actions
+  class DocEditor
+    def initialize(instance)
+      @instance = instance
+    end
+
+    # @return [DocEditorTopToolbar] top toolbar
+    def top_toolbar
+      @top_toolbar ||= DocEditorTopToolbar.new(@instance)
+    end
+
+    # @return [DocEditorWindows] windows of doc editor
+    def windows
+      @windows ||= DocEditorWindows.new(@instance)
+    end
+  end
+end

data/lib/onlyoffice_documentserver_testing_framework/test_instance_docs/doc_editor/doc_editor_top_toolbar.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative 'doc_editor_top_toolbar/top_toolbar_users'
+
+module OnlyofficeDocumentserverTestingFramework
+  # Top Toolbar of Doc Editor
+  class DocEditorTopToolbar
+    def initialize(instance)
+      @instance = instance
+    end
+
+    # @return [TopToolbarUsers] icon for top toolbar users
+    def users
+      @users ||= TopToolbarUsers.new(@instance)
+    end
+  end
+end

data/lib/onlyoffice_documentserver_testing_framework/test_instance_docs/doc_editor/doc_editor_top_toolbar/top_toolbar_users.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module OnlyofficeDocumentserverTestingFramework
+  # Class for getting info about share and users
+  # https://user-images.githubusercontent.com/668524/28920497-d444b674-785a-11e7-9254-2f46d4e95261.png
+  class TopToolbarUsers
+    include SeleniumWrapper
+
+    def initialize(instance)
+      @instance = instance
+      @xpath_button = '//*[@id="tlb-box-users"]'
+      @xpath_count = "#{@xpath_button}/div/label"
+    end
+
+    # @return [True, False] is button present
+    def present?
+      visible = visible?(@xpath_button)
+      OnlyofficeLoggerHelper.log("Button present: #{visible}")
+      visible
+    end
+
+    # @return [Integer] count of users
+    def count
+      return 1 unless present?
+
+      count = selenium_functions(:get_text, @xpath_count)
+      count = 1 if count == '+'
+      OnlyofficeLoggerHelper.log("User count: #{count}")
+      count.to_i
+    end
+  end
+end

data/lib/onlyoffice_documentserver_testing_framework/test_instance_docs/doc_editor/doc_editor_windows.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative 'doc_editor_windows/txt_options'
+
+module OnlyofficeDocumentserverTestingFramework
+  # Windows of Doc Editor
+  class DocEditorWindows < EditorWindows
+    def initialize(instance)
+      @instance = instance
+      super()
+    end
+
+    # @return [TxtOptions] widnow for txt options
+    def txt_options
+      @txt_options ||= TxtOptions.new(@instance)
+    end
+  end
+end

data/lib/onlyoffice_documentserver_testing_framework/test_instance_docs/doc_editor/doc_editor_windows/txt_options.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+module OnlyofficeDocumentserverTestingFramework
+  # Class for TXT export window
+  class TxtOptions
+    include SeleniumWrapper
+
+    def initialize(instance)
+      @instance = instance
+      @xpath_codepage_selector = '//*[contains(text(), "TXT")]/../..//div[@id="id-codepages-combo"]'
+    end
+
+    # region CVN Framework
+
+    # @return [True, False] is txt options dialog opened
+    def dialog_window_opened?
+      visible = visible? @xpath_codepage_selector
+      OnlyofficeLoggerHelper.log("Codepage option window is opened: #{visible}")
+      visible
+    end
+
+    # @return [True, False] is loose data warning visible
+    def loose_data_warning_present?
+      visible = visible? '//*[contains(@class, "asc-window modal alert")]'
+      OnlyofficeLoggerHelper.log("Codepage option window is opened: #{visible}")
+      visible
+    end
+
+    # Click on ok button
+    # @return [nil]
+    def click_on_ok
+      click_on_button '//button[@result="ok"]'
+      OnlyofficeLoggerHelper.log('Click on OK button')
+    end
+
+    # Click on cancel button
+    # @return [nil]
+    def click_on_cancel
+      click_on_button '//button[@result="cancel"]'
+      OnlyofficeLoggerHelper.log('Click on CANCEL button')
+    end
+
+    # Control to set encoding
+    # @return [BoundComboBoxUl]
+    def encoding
+      BoundComboBoxUl.new(@instance, @xpath_codepage_selector, nil, 'span')
+    end
+
+    # List encoding list to item number
+    # @param list_item_number [Integer] item to scroll
+    # @return [nil]
+    def scroll_encoding_list_to(list_item_number)
+      selenium_functions(:scroll_list_by_pixels,
+                         "//*[@id='id-codepages-combo']/span/ul",
+                         (list_item_number - 1) * 25)
+      OnlyofficeLoggerHelper.log("Scroll to #{list_item_number} element")
+    end
+
+    # endregion
+
+    # region Function
+
+    # Wait for loose data warning to show
+    # @return [nil]
+    def wait_warning
+      counter = 0
+      while !loose_data_warning_present? && counter < 30
+        sleep 1
+        counter += 1
+      end
+      @instance.webdriver.webdriver_error 'Wait for TXT warning failed' if counter == 30
+    end
+
+    # Wait for csv options to show
+    # @return [nil]
+    def wait_options
+      counter = 0
+      while !dialog_window_opened? && counter < 30
+        sleep 1
+        counter += 1
+      end
+      @instance.webdriver.webdriver_error 'Wait for TXT options failed' if counter == 30
+    end
+
+    # @param [String] encoding_name like as 'French Canadian (DOS)'
+    def encoding_select(encoding_name)
+      encoding.open
+      # TODO: Replace with correct include after find out https://github.com/ONLYOFFICE/testing-documentserver/pull/2006
+      list_item_number = encoding.items_text.index { |item| item.include?(encoding_name) } + 1
+      scroll_encoding_list_to list_item_number
+      encoding.select_by_number list_item_number
+    end
+
+    # Set options in txt window
+    # @param encoding_to_set [String] encoding to set
+    # @return [nil]
+    def txt_options=(encoding_to_set = nil)
+      return unless dialog_window_opened?
+
+      encoding_to_set = encoding.items_text.last if encoding_to_set.nil?
+      encoding_select encoding_to_set
+      click_on_ok
+    end
+
+    alias set_txt_options txt_options=
+    extend Gem::Deprecate
+    deprecate :set_txt_options, :txt_options=, 2025, 1
+
+    # Close warning about loose data
+    # @return [nil]
+    def close_warning_loose_data
+      click_on_ok if loose_data_warning_present?
+    end
+    # endregion
+  end
+end