onlyoffice_documentserver_testing_framework 0.1.0

data/lib/onlyoffice_documentserver_testing_framework/test_instance_docs/management.rb

@@ -0,0 +1,206 @@
+# frozen_string_literal: true
+
+require_relative 'management/loader_helper'
+module OnlyofficeDocumentserverTestingFramework
+  # Class for management main methods
+  class Management
+    include SeleniumWrapper
+    include LoaderHelper
+
+    # @return [Integer] count of iframes to go into
+    attr_accessor :xpath_iframe_count
+    # @return [String] xpath to single iframe
+    attr_accessor :xpath_iframe
+
+    def initialize(instance)
+      @instance = instance
+      @xpath_iframe_count = 1
+      # Don't mixup iframe with help
+      @xpath_iframe = '//iframe[not(contains(@src, "help")) and '\
+                               'not(contains(@id, "fileFrame"))]'
+      @alert_dialog_xpath = '//div[@role="alertdialog"]'
+      @alert_dialog_span_xpath = "#{@alert_dialog_xpath}/div/div/div/span"
+    end
+
+    # @return [Boolean] check if loader present
+    def loading_present?
+      if @instance.webdriver.alert_exists?
+        raise 'Service Unavailable. There is alert while loading docs: '\
+              "\"#{@instance.webdriver.alert_text}\""
+      end
+
+      @instance.selenium.select_frame(@xpath_iframe, @xpath_iframe_count)
+      mobile_loader = false
+      loader1 = @instance.selenium.element_visible?('//div[contains(@id,"cmdloadmask")]')
+      loader2 = @instance.selenium.element_visible?('//*[contains(@class,"loadmask")]')
+      loader3 = @instance.selenium.element_visible?('//*[@class="asc-loadmask-body "]')
+      loader4 = @instance.selenium.element_present?('//*[@id="loading-text"]')
+      loader5 = @instance.selenium.element_visible?('//*[@id="loading-mask"]')
+      loader6 = @instance.selenium.element_visible?('//*[@class="modals-mask"]')
+      loader7 = @instance.selenium.element_visible?('//*[@class="asc-loadmask"]')
+      loader8 = @instance.selenium.element_visible?(@xpath_window_modal)
+      mobile_loader = wait_for_mobile_loading if main_frame_mobile_element_visible?
+      @instance.selenium.select_top_frame
+      loading = loader1 || loader2 || loader3 ||
+                loader4 || loader5 || loader6 || loader7 ||
+                loader8 || mobile_loader
+      OnlyofficeLoggerHelper.log("Loading Present: #{loading}")
+      loading
+    end
+
+    def main_frame_mobile_element_visible?
+      @instance.selenium.element_visible?('//*[contains(@class,"framework7-root")]')
+    end
+
+    # Check if mobile loading is in progress
+    # @return [True, False] is loading in progress
+    def wait_for_mobile_loading
+      @instance.selenium.element_visible?('//*[contains(@class,"modal-preloader")]') ||
+        @instance.selenium.element_visible?('//*[contains(@class,"loader-page")]') ||
+        @instance.selenium.get_element('//*[contains(@class,"iScrollVerticalScrollbar")]').nil?
+    end
+
+    # Wait until loader is present
+    # @param timeout [Integer] wait for loading to be present
+    def wait_loading_present(timeout = 15)
+      timer = 0
+      while timer < timeout && !loading_present?
+        sleep 1
+        timer += 1
+        OnlyofficeLoggerHelper.log('Waiting for start loading of documents. '\
+                                   "Waiting for #{timer} seconds of #{timeout}")
+      end
+      return unless timer == timeout
+
+      @instance.webdriver.webdriver_error("Waiting for start loading failed for #{timeout} seconds")
+    end
+
+    # Wait for operation with round status in canvas editor
+    # @param [Integer] timeout_in_seconds count of seconds to wait
+    def wait_for_operation_with_round_status_canvas(timeout_in_seconds = 300, options = {})
+      result = true
+      OnlyofficeLoggerHelper.log('Start waiting for Round Status')
+
+      current_wait_time = 0
+      wait_until_frame_loaded
+      wait_for_round_loading_to_start
+      while loading_present?
+        sleep(1)
+        current_wait_time += 1
+        OnlyofficeLoggerHelper.log('Waiting for Round Status for '\
+                                    "#{current_wait_time} of "\
+                                    "#{timeout_in_seconds} timeout")
+        @instance.doc_editor.windows.txt_options.txt_options = 'Unicode (UTF-8)'
+        @instance.spreadsheet_editor.windows.csv_option.csv_options = options
+
+        check_2_5_version_error
+        handle_error
+
+        # Close 'Select Encoding' dialog if present
+        if current_wait_time > timeout_in_seconds
+          @instance.selenium.select_top_frame
+          @instance.selenium.webdriver_error('Timeout for render file')
+        end
+        handle_alert_dialog
+        @instance.selenium.select_top_frame
+        if permission_denied_message?
+          @instance.selenium.webdriver_error('There is not enough access rights for document')
+        end
+        @instance.selenium.webdriver_error('The required file was not found') if file_not_found_message?
+      end
+
+      @instance.selenium.select_frame(@xpath_iframe, @xpath_iframe_count)
+      if @instance.selenium.element_visible?(@alert_dialog_span_xpath)
+        alert_text = @instance.selenium.get_text(@alert_dialog_span_xpath).tr("\n", ' ')
+        result = "Server Alert: #{alert_text}"
+        if result.include?('charts and images will be lost')
+          style_left = @instance.selenium.get_style_parameter(@alert_dialog_xpath,
+                                                              'left')
+                                .gsub!('px', '').to_i
+          result = true if style_left.negative?
+        end
+        @instance.selenium.select_top_frame
+        return result
+      elsif @instance.selenium.element_visible?(@xpath_error_window)
+        result = "Server Error: #{@instance.selenium.get_text(@xpath_error_window_text).tr("\n", ' ')}"
+        @instance.selenium.select_top_frame
+        @instance.selenium.webdriver_error(result)
+      end
+
+      @instance.selenium.execute_javascript('window.onbeforeunload = null') # OFF POPUP WINDOW
+      @instance.selenium.select_top_frame
+      add_error_handler
+      result
+    end
+
+    # Since v6.0.0 of DocumentServer
+    # round loading mask start to appear not instantly
+    # but after some timeout specified in
+    # https://github.com/ONLYOFFICE/web-apps/commit/a7988dc7ec1f1151ef2c204677d1746a65e39132#diff-eee9ef38f1b712adf8bcc94c29de431aR127
+    def wait_for_round_loading_to_start
+      appear_timeout = 0.5
+      sleep(appear_timeout * 4) # quad just in case, double is not enough
+    end
+
+    # @return [Boolean] check if frame with editor is loaded
+    def frame_loaded?
+      @instance.selenium.select_frame(@xpath_iframe, @xpath_iframe_count)
+      loaded = @instance.selenium.element_visible?('//*[@id="viewport"]') ||
+               @instance.selenium.element_visible?('//*[@id="editor_sdk"]')
+      @instance.selenium.select_top_frame
+      loaded
+    end
+
+    # @return [Void] wait until iframe have some content
+    def wait_until_frame_loaded
+      @instance.webdriver.wait_until do
+        frame_loaded?
+      end
+    end
+
+    def permission_denied_message?
+      denied_xpath = '//div[contains(text(),"You don\'t have enough permission to view the file")]'
+      @instance.selenium.select_frame
+      error_on_loading = @instance.selenium.element_present?(denied_xpath)
+      @instance.selenium.select_top_frame
+      error_on_loading
+    end
+
+    def file_not_found_message?
+      message_xpath = '//div[contains(@class, "tooltip-inner") and '\
+                      'contains(text(),"The required file was not found")]'
+      @instance.selenium.select_frame
+      error_on_loading = @instance.selenium.element_visible?(message_xpath)
+      @instance.selenium.select_top_frame
+      OnlyofficeLoggerHelper.log("file_not_found_message is shown: #{error_on_loading}")
+      error_on_loading
+    end
+
+    # Add js code to handle JS errors
+    # @return [nil]
+    def add_error_handler
+      js_handler = 'window.jsErrors = [];'\
+                   'window.onerror = function(errorMessage) '\
+                   '{window.jsErrors[window.jsErrors.length] = errorMessage;}'
+      @instance.selenium.select_frame @instance.management.xpath_iframe
+      @instance.selenium.execute_javascript(js_handler)
+      @instance.selenium.select_top_frame
+    end
+
+    # @return [Symbol] editor typo of opened document
+    def editor_type
+      @instance.selenium.select_top_frame
+      url = selenium_functions(:get_url)
+      case url
+      when /documenteditor/
+        :document
+      when /spreadsheeteditor/
+        :spreadsheet
+      when /presentationeditor/
+        :presentation
+      else
+        @instance.selenium.webdriver_error "Unknown editor type for url: #{url}"
+      end
+    end
+  end
+end

data/lib/onlyoffice_documentserver_testing_framework/test_instance_docs/management/loader_helper.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module OnlyofficeDocumentserverTestingFramework
+  # Module for methods with loader of document
+  module LoaderHelper
+    # Check if any error from DocumentServer v2.5
+    def check_2_5_version_error
+      @instance.selenium.select_frame(@xpath_iframe, @xpath_iframe_count)
+      base_error_message_xpath = '//div[contains(@class,"x-message-box")]'
+      error_box_xpath = "#{base_error_message_xpath}/div[2]/div[1]/div[2]/span"
+      if @instance.selenium.element_visible?(error_box_xpath) &&
+         @instance.selenium.get_style_parameter(base_error_message_xpath, 'left')
+                  .gsub('px', '').to_i.positive?
+        error_text = @instance.selenium.get_text(error_box_xpath).tr("\n", ' ')
+        @instance.selenium.webdriver_error("Server Error: #{error_text}")
+      end
+    end
+
+    # Handle default error in alert
+    def handle_error
+      @instance.selenium.select_top_frame
+      error = error_message_alert
+      @instance.selenium.webdriver_error(error) unless error.nil?
+      @instance.selenium.select_frame(@xpath_iframe, @xpath_iframe_count)
+    end
+
+    # Check for error message 3.0 version
+    def error_message_alert
+      alert_xpath = "//div[contains(@class,'asc-window modal alert')]"
+      return unless visible?("#{alert_xpath}/div[2]/div[1]/div[2]/span") &&
+                    selenium_functions(:get_style_parameter, alert_xpath, 'left')
+                    .gsub('px', '').to_i.positive?
+
+      error = selenium_functions(:get_text, "#{alert_xpath}/div[2]/div[1]/div[2]/span").tr("\n", ' ')
+      "Server Error: #{error}"
+    end
+
+    alias get_error_message_alert error_message_alert
+    extend Gem::Deprecate
+    deprecate :get_error_message_alert, :error_message_alert, 2025, 1
+
+    # Handle some more alert dialogs
+    def handle_alert_dialog
+      return unless @instance.selenium.element_visible?(@alert_dialog_span_xpath)
+
+      error = @instance.selenium.get_text(@alert_dialog_span_xpath).tr("\n", ' ')
+      @instance.selenium.webdriver_error("Server Error: #{error}")
+    end
+  end
+end

data/lib/onlyoffice_documentserver_testing_framework/test_instance_docs/presentation_editor.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module OnlyofficeDocumentserverTestingFramework
+  # Class for all Presentation Editor actions
+  class PresentationEditor < DocEditor
+  end
+end

data/lib/onlyoffice_documentserver_testing_framework/test_instance_docs/spreadsheet_editor.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative 'spreadsheet_editor/spreadsheet_windows'
+
+module OnlyofficeDocumentserverTestingFramework
+  # Class for all Spreadsheet Editor actions
+  class SpreadsheetEditor < DocEditor
+    # @return [SpreadsheetEditorWindows] windows of spreadsheet editor
+    def windows
+      @windows ||= SpreadsheetEditorWindows.new(@instance)
+    end
+  end
+end

data/lib/onlyoffice_documentserver_testing_framework/test_instance_docs/spreadsheet_editor/spreadsheet_windows.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative 'spreadsheet_windows/csv_option'
+
+module OnlyofficeDocumentserverTestingFramework
+  # Windows of Spreadsheet Editor
+  class SpreadsheetEditorWindows < EditorWindows
+    def initialize(instance)
+      @instance = instance
+      super()
+    end
+
+    # @return [CsvOption] csv windows
+    def csv_option
+      @csv_option ||= CsvOption.new(@instance)
+    end
+  end
+end

data/lib/onlyoffice_documentserver_testing_framework/test_instance_docs/spreadsheet_editor/spreadsheet_windows/csv_option.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module OnlyofficeDocumentserverTestingFramework
+  # Class for CSV window
+  class CsvOption < TxtOptions
+    include SeleniumWrapper
+
+    def initialize(instance)
+      super(instance)
+      @xpath_codepage_selector = '//*[contains(text(), "CSV")]/../..//div[@id="id-codepages-combo"]'
+    end
+
+    # @return [Array<Symbol>] list of possible csv delimiters
+    DELIMITER_TYPE = %i[comma semicolon colon tab space other].freeze
+
+    # region CVN Framework
+    def delimiter
+      BoundComboBoxUl.new(@instance, '//*[@id="id-delimiters-combo"]', nil, 'span')
+    end
+
+    # @return [TextInput] text input for enter custom delimiter
+    def other_delimiter
+      @other_delimiter ||= TextInput.new(@instance, '//*[@id="id-delimiter-other"]')
+    end
+
+    # endregion
+
+    # region Function
+
+    # @param [Symbol] delimiter_type like as :semicolon
+    def delimiter_select(delimiter_type)
+      if DELIMITER_TYPE.include?(delimiter_type)
+        delimiter.select_by_number(DELIMITER_TYPE.index(delimiter_type) + 1)
+      else
+        delimiter.select_by_number(DELIMITER_TYPE.index(:other) + 1)
+        other_delimiter.set(delimiter_type)
+      end
+    end
+
+    # Set options in csv window
+    # @param options [Hash] options to set
+    # @return [nil]
+    def csv_options=(options = {})
+      options[:encoding_to_set] ||= 'Unicode (UTF-8)'
+      options[:csv_delimiter] ||= :comma
+      return unless dialog_window_opened?
+
+      encoding_select options[:encoding_to_set]
+      delimiter_select options[:csv_delimiter]
+      click_on_ok
+    end
+
+    alias set_csv_options csv_options=
+    extend Gem::Deprecate
+    deprecate :set_csv_options, :csv_options=, 2025, 1
+    # endregion
+  end
+end

data/lib/onlyoffice_documentserver_testing_framework/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module OnlyofficeDocumentserverTestingFramework
+  # Module to hold version of Gem
+  module Version
+    # [String] version of gem
+    STRING = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,229 @@
+--- !ruby/object:Gem::Specification
+name: onlyoffice_documentserver_testing_framework
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ONLYOFFICE
+- Pavel Lobashov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: onlyoffice_logger_helper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: onlyoffice_webdriver_wrapper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: overcommit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.55.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.55.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.89.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.89.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.7.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.42.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.42.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.5
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.25
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.25
+description: ONLYOFFICE DocumentServer testing framework, used in QA
+email:
+- shockwavenn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/onlyoffice_documentserver_testing_framework.rb
+- lib/onlyoffice_documentserver_testing_framework/name.rb
+- lib/onlyoffice_documentserver_testing_framework/selenium_wrapper.rb
+- lib/onlyoffice_documentserver_testing_framework/selenium_wrapper/selenium_wrapper_exceptions.rb
+- lib/onlyoffice_documentserver_testing_framework/selenium_wrapper/selenium_wrapper_js_errors.rb
+- lib/onlyoffice_documentserver_testing_framework/selenium_wrapper/selenium_wrapper_js_errors/ignored_errors.list
+- lib/onlyoffice_documentserver_testing_framework/test_instance_docs.rb
+- lib/onlyoffice_documentserver_testing_framework/test_instance_docs/common_editor/editor_windows.rb
+- lib/onlyoffice_documentserver_testing_framework/test_instance_docs/doc_editor.rb
+- lib/onlyoffice_documentserver_testing_framework/test_instance_docs/doc_editor/doc_editor_top_toolbar.rb
+- lib/onlyoffice_documentserver_testing_framework/test_instance_docs/doc_editor/doc_editor_top_toolbar/top_toolbar_users.rb
+- lib/onlyoffice_documentserver_testing_framework/test_instance_docs/doc_editor/doc_editor_windows.rb
+- lib/onlyoffice_documentserver_testing_framework/test_instance_docs/doc_editor/doc_editor_windows/txt_options.rb
+- lib/onlyoffice_documentserver_testing_framework/test_instance_docs/doc_service_welcome.rb
+- lib/onlyoffice_documentserver_testing_framework/test_instance_docs/doc_test_site_functions.rb
+- lib/onlyoffice_documentserver_testing_framework/test_instance_docs/doc_test_site_functions/doc_test_file_list.rb
+- lib/onlyoffice_documentserver_testing_framework/test_instance_docs/doc_test_site_functions/doc_test_file_list/doc_test_site_file_list_entry.rb
+- lib/onlyoffice_documentserver_testing_framework/test_instance_docs/doc_test_site_functions/doc_test_site_server_helper.rb
+- lib/onlyoffice_documentserver_testing_framework/test_instance_docs/doc_test_site_functions/healthcheck_page.rb
+- lib/onlyoffice_documentserver_testing_framework/test_instance_docs/management.rb
+- lib/onlyoffice_documentserver_testing_framework/test_instance_docs/management/loader_helper.rb
+- lib/onlyoffice_documentserver_testing_framework/test_instance_docs/presentation_editor.rb
+- lib/onlyoffice_documentserver_testing_framework/test_instance_docs/spreadsheet_editor.rb
+- lib/onlyoffice_documentserver_testing_framework/test_instance_docs/spreadsheet_editor/spreadsheet_windows.rb
+- lib/onlyoffice_documentserver_testing_framework/test_instance_docs/spreadsheet_editor/spreadsheet_windows/csv_option.rb
+- lib/onlyoffice_documentserver_testing_framework/version.rb
+homepage: https://github.com/onlyoffice-testing-robot/onlyoffice_documentserver_testing_framework
+licenses:
+- AGPL-3.0
+metadata:
+  bug_tracker_uri: https://github.com/onlyoffice-testing-robot/onlyoffice_documentserver_testing_framework/issues
+  changelog_uri: https://github.com/onlyoffice-testing-robot/onlyoffice_documentserver_testing_framework/blob/master/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/onlyoffice_documentserver_testing_framework
+  homepage_uri: https://github.com/onlyoffice-testing-robot/onlyoffice_documentserver_testing_framework
+  source_code_uri: https://github.com/onlyoffice-testing-robot/onlyoffice_documentserver_testing_framework
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: ONLYOFFICE DocumentServer testing framework
+test_files: []