onlyoffice_documentserver_testing_framework 0.1.0

data/lib/onlyoffice_documentserver_testing_framework/test_instance_docs/doc_service_welcome.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# Class for describing Welcome page of test example
+# https://cloud.githubusercontent.com/assets/668524/15577518/891848c8-2365-11e6-8a2a-af98618067b5.png
+class DocServiceWelcome
+  def initialize(instance)
+    @instance = instance
+    @xpath_test_example = '//a[contains(@href, "/example")]'
+  end
+
+  # Waiting for load of page
+  # @return [Nothing]
+  def wait_load
+    @instance.webdriver.wait_until do
+      opened?
+    end
+    sleep 1 # Additional wait for load
+  end
+
+  # @return [True, False] is welcome page opened
+  def opened?
+    result = @instance.selenium.element_present?(@xpath_test_example)
+    OnlyofficeLoggerHelper.log("Current server is a Doc Service Welcome: #{result}")
+    result
+  end
+
+  # Go to Test Example
+  # @return [Nothing]
+  def go_to_example
+    wait_load
+    @instance.selenium.click_on_locator(@xpath_test_example)
+    OnlyofficeLoggerHelper.log('Go to test example')
+    @instance.doc_test_functions.wait_load
+  end
+end

data/lib/onlyoffice_documentserver_testing_framework/test_instance_docs/doc_test_site_functions.rb

@@ -0,0 +1,235 @@
+# frozen_string_literal: true
+
+require_relative 'doc_test_site_functions/healthcheck_page'
+require_relative 'doc_test_site_functions/doc_test_file_list'
+require_relative 'doc_test_site_functions/doc_test_site_server_helper'
+# Class to work with test examples
+class DocTestSiteFunctions
+  extend DocTestSiteServerHelper
+  include PageObject
+
+  # @return [Array<String>] list of supported languages
+  SUPPORTED_LANGUAGES = %w[English
+                           Bulgarian
+                           Chinese
+                           Czech
+                           Dutch
+                           French
+                           German
+                           Hungarian
+                           Italian
+                           Japanese
+                           Korean
+                           Latvian
+                           Polish
+                           Portuguese
+                           Russian
+                           Slovak
+                           Slovenian
+                           Spanish
+                           Turkish
+                           Ukrainian
+                           Vietnamese].freeze
+  select_list(:user_list, xpath: '//*[@id="user"]')
+  select_list(:language_list, xpath: '//*[@id="language"]')
+
+  def initialize(instance)
+    super(instance.webdriver.driver)
+    @instance = instance
+    @xpath_begin_view = '//*[@id="beginView"]'
+    @xpath_file_loading_step = '//*[@id="step1"]'
+    @xpath_conversion_step = '//*[@id="step2"]'
+    @xpath_editor_scripts_step = '//*[@id="step3"]'
+    @xpath_file_entry = '//*[@class="stored-list"]/table/tbody/tr'
+  end
+
+  # Waiting for load of page
+  # @return [Nothing]
+  def wait_load
+    @instance.webdriver.wait_until do
+      doc_test_site?
+    end
+  end
+
+  # reload the page
+  # @return [Nothing]
+  def reload
+    @instance.webdriver.refresh
+    wait_load
+  end
+
+  # Check if current site is DocTestSite
+  # @return [true, false] result of checking
+  def doc_test_site?
+    sleep(1) # TODO: remove after update to Chromedriver 80
+    result = @instance.selenium.element_present?(@xpath_begin_view)
+    OnlyofficeLoggerHelper.log("Current server is a doc_test_site: #{result}")
+    result
+  end
+
+  # Upload file to portal
+  # @param [String] file_path like as '/mnt/data_share/Files/DOCX/empty.docx'
+  def upload_file(file_path)
+    file_path_absolute = file_path.gsub('~', ENV['HOME'])
+    @instance.selenium.type_to_locator('//*[@id="fileupload"]', file_path_absolute, false, false, false, true)
+    wait_loading_file
+    wait_conversion
+    wait_loading_scripts
+    true
+  end
+
+  # Check for any error in loading process and raise it
+  # @return [Nothing]
+  def check_error
+    error_message = @instance.selenium.get_text('//*[@class="error-message"]/span', false)
+
+    return if error_message.empty?
+
+    @instance.selenium.webdriver_error('Error while uploading document. '\
+                                       "Error message: #{error_message}")
+  end
+
+  # Waits until file converts
+  # @return [Nothing]
+  def wait_loading_file
+    100.times do |current_time|
+      OnlyofficeLoggerHelper.log("Waiting for file loading for #{current_time} seconds")
+      return true if @instance.selenium.get_attribute(@xpath_file_loading_step, 'class').include?('done')
+
+      sleep 1
+      check_error
+    end
+    @instance.selenium.webdriver_error('File not finished for loading scripts for 100 seconds')
+  end
+
+  # Waits until file converts
+  # @return [Nothing]
+  def wait_conversion
+    100.times do |current_time|
+      OnlyofficeLoggerHelper.log("Waiting for file conversion for #{current_time} seconds")
+      return true if @instance.selenium.get_attribute(@xpath_conversion_step, 'class').include?('done')
+
+      sleep 1
+      check_error
+    end
+    @instance.selenium.webdriver_error('File not finished for conversion for 100 seconds')
+  end
+
+  # Waits until scripts loads
+  # @return [Nothing]
+  def wait_loading_scripts
+    100.times do |current_time|
+      OnlyofficeLoggerHelper.log("Waiting for editors scripts load for #{current_time} seconds")
+      return true if @instance.selenium.get_attribute(@xpath_editor_scripts_step, 'class').include?('done')
+
+      sleep 1
+      check_error
+    end
+    @instance.selenium.webdriver_error('File not finished for loading scripts for 100 seconds')
+  end
+
+  # Check if file uploaded
+  # @return [Boolean]
+  def file_uploaded?
+    @instance.selenium.element_visible?(@xpath_begin_view)
+  end
+
+  # help-method to #open_file_in_editor and #open_file_in_viewer
+  def open_file_in
+    result = 'Unknown'
+    if file_uploaded?
+      yield
+      sleep 5
+      @instance.selenium.close_tab
+      @instance.selenium.switch_to_main_tab
+      result = @instance.management.wait_for_operation_with_round_status_canvas
+      sleep 3 # just for sure
+    end
+    result
+  end
+
+  # Click on Edit Button and wait opening Editor
+  # Return result of the opening Editor
+  def open_file_in_editor
+    open_file_in { @instance.selenium.click_on_locator('//*[@id="beginEdit"]') }
+  end
+
+  # Click on View Button and wait opening Viewer
+  # Return result of the opening Viewer
+  def open_file_in_viewer
+    open_file_in { @instance.selenium.click_on_locator(@xpath_begin_view) }
+  end
+
+  # Get url of document which opened in editor
+  # @return [String] url
+  def current_document_storage_url
+    page_source = @instance.selenium.get_page_source
+    url_line = page_source.scan(/"?url"?: ".*$/).first
+    url_line.delete('"').gsub('url: ', '').chop
+  end
+
+  # @return [True, False] is on file list page now?
+  def file_list_opened?
+    @instance.selenium.element_visible?('//*[contains(@class, "try-editor document")]')
+  end
+
+  # @return [Integer] count of uploaded files
+  def uploaded_file_count
+    @instance.selenium.get_element_count(@xpath_file_entry)
+  end
+
+  # @return [DocTestFileLIst] get file list
+  def uploaded_file_list
+    file_list = []
+    (0...uploaded_file_count).each do |current_file_number|
+      file_list << DocTestSiteFileListEntry.new(@instance, "#{@xpath_file_entry}[#{current_file_number + 1}]")
+    end
+    DocTestFileList.new(file_list)
+  end
+
+  # @return [Checkbox] save in original format checkbox
+  def save_in_original_format
+    checkbox = CheckBox.new(@instance)
+    checkbox.xpath = '//*[@id="checkOriginalFormat"]'
+    checkbox.count_of_frame = 0
+    checkbox
+  end
+
+  # @return [Checkbox] Create a file filled with sample content
+  def create_a_file_with_sample
+    checkbox = CheckBox.new(@instance)
+    checkbox.xpath = '//*[@id="createSample"]'
+    checkbox.count_of_frame = 0
+    checkbox
+  end
+
+  # Perform creating sample document
+  # @return [String] result of opening
+  def open_sample_document(format = :document, wait_to_load: true)
+    case format
+    when :document
+      @instance.selenium.click_on_locator('//*[contains(@class, "try-editor document")]')
+    when :spreadsheet
+      @instance.selenium.click_on_locator('//*[contains(@class, "try-editor spreadsheet")]')
+    when :presentation
+      @instance.selenium.click_on_locator('//*[contains(@class, "try-editor presentation")]')
+    else
+      @instance.webdriver.webdriver_error("Unknown file type for open_sample_document(#{format})")
+    end
+    return unless wait_to_load
+
+    @instance.selenium.close_tab
+    @instance.selenium.switch_to_main_tab
+    @instance.management.wait_for_operation_with_round_status_canvas
+  end
+
+  # @return [Nothing]
+  def go_to_healthcheck
+    @instance.webdriver.open("#{@instance.user_data.portal}/healthcheck")
+  end
+
+  # @return [HealthcheckPage] page of healthcheck
+  def healthcheck
+    @healthcheck = HealthcheckPage.new(@instance)
+  end
+end

data/lib/onlyoffice_documentserver_testing_framework/test_instance_docs/doc_test_site_functions/doc_test_file_list.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'doc_test_file_list/doc_test_site_file_list_entry'
+# Class for storing list of test example files
+# https://cloud.githubusercontent.com/assets/668524/13947979/935506a6-f02e-11e5-86f4-6903dfd6119e.png
+class DocTestFileList
+  attr_accessor :file_list
+
+  def initialize(file_list = [])
+    @file_list = file_list
+  end
+
+  # Access file in list like array
+  # @param key [String] name of file
+  # @return [DocTestSiteFileListEntry]
+  def [](key)
+    @file_list[key]
+  end
+
+  # Get diff between two file list
+  # @param other [DocTestFileList] diff with other list
+  # @return [Hash] diff
+  def -(other)
+    diff_items = []
+    @file_list.each do |current_item|
+      found = false
+      other.file_list.each do |other_item|
+        found = true if current_item == other_item
+      end
+      diff_items << current_item unless found
+    end
+    diff_items
+  end
+end

data/lib/onlyoffice_documentserver_testing_framework/test_instance_docs/doc_test_site_functions/doc_test_file_list/doc_test_site_file_list_entry.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+# Class for single entry of file in doc test site
+# https://cloud.githubusercontent.com/assets/668524/13947979/935506a6-f02e-11e5-86f4-6903dfd6119e.png
+class DocTestSiteFileListEntry
+  # @return [String] name of file
+  attr_accessor :file_name
+  # @return [String] url of embedded mode
+  attr_accessor :embedded_url
+  # @return [String] Review mode url
+  attr_accessor :review_mode_url
+  # @return [String] Comment mode url
+  attr_accessor :comment_mode_url
+  # @return [String] Fill forms mode url
+  attr_reader :fill_forms_mode_url
+  # @return [String] Only fill forms mode url
+  attr_reader :only_fill_forms_mode_url
+  # @return [String] View mode url
+  attr_accessor :view_mode_url
+
+  def initialize(instance, xpath)
+    @instance = instance
+    @xpath_line = xpath
+    @file_name = fetch_file_name
+    @embedded_url = fetch_embedded_url
+    @review_mode_url = fetch_review_mode_url
+    @comment_mode_url = fetch_comment_mode_url
+    @fill_forms_mode_url = fetch_fill_forms_mode_url
+    @view_mode_url = fetch_view_mode_url
+  end
+
+  # Compare two DocTestSiteFileListEntry
+  # @return [True, False] is entries are the same
+  def ==(other)
+    @file_name == other.file_name
+  end
+
+  # @return [String] name of file
+  def fetch_file_name
+    text = @instance.selenium.get_text("#{@xpath_line}/td/a[1]/span")
+    OnlyofficeLoggerHelper.log("Got filename #{@xpath_line} name: #{text}")
+    text
+  end
+
+  # @return [String] url on review mode
+  def fetch_review_mode_url
+    xpath_review = "#{@xpath_line}/td[4]/a"
+    return nil unless @instance.selenium.element_present?(xpath_review)
+
+    url = @instance.selenium.get_attribute(xpath_review, 'href')
+    OnlyofficeLoggerHelper.log("Got review mode #{@xpath_line} url: #{url}")
+    url
+  end
+
+  # @return [String] url on review mode
+  def fetch_comment_mode_url
+    xpath_comment = "#{@xpath_line}/td[5]/a"
+    return nil unless @instance.selenium.element_present?(xpath_comment)
+
+    url = @instance.selenium.get_attribute(xpath_comment, 'href')
+    OnlyofficeLoggerHelper.log("Got comment mode #{@xpath_line} url: #{url}")
+    url
+  end
+
+  # @return [String] url on fill forms mode
+  def fetch_fill_forms_mode_url
+    xpath_comment = "#{@xpath_line}/td[6]/a"
+    return nil unless @instance.selenium.element_present?(xpath_comment)
+
+    url = @instance.selenium.get_attribute(xpath_comment, 'href')
+    OnlyofficeLoggerHelper.log("Got fill forms mode #{@xpath_line} url: #{url}")
+    url
+  end
+
+  # @return [String] url on fill forms mode
+  def fetch_only_fill_forms_mode_url
+    link_xpath = "#{@xpath_line}/td[7]/a"
+    return nil unless @instance.selenium.element_present?(link_xpath)
+
+    url = @instance.selenium.get_attribute(link_xpath, 'href')
+    OnlyofficeLoggerHelper.log("Got only fill forms mode #{@xpath_line} url: #{url}")
+    url
+  end
+
+  # @return [String] url on viewer mode
+  def fetch_view_mode_url
+    xpath_comments = "#{@xpath_line}/td[8]/a"
+    return nil unless @instance.selenium.element_present?(xpath_comments)
+
+    url = @instance.selenium.get_attribute(xpath_comments, 'href')
+    OnlyofficeLoggerHelper.log("Got view mode #{@xpath_line} url: #{url}")
+    url
+  end
+
+  # @return [String] url on embedded file
+  def fetch_embedded_url
+    url = @instance.selenium.get_attribute("#{@xpath_line}/td[10]/a", 'href')
+    OnlyofficeLoggerHelper.log("Got embedded #{@xpath_line} url: #{url}")
+    url
+  end
+end

data/lib/onlyoffice_documentserver_testing_framework/test_instance_docs/doc_test_site_functions/doc_test_site_server_helper.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# Helper method to fetch server url
+module DocTestSiteServerHelper
+  # @return [String] url of docserver
+  def fetch_docserverserver_url(example_url)
+    page_data = URI.parse(example_url).open.read
+    html_doc = Nokogiri::HTML(page_data)
+    load_scripts_data = html_doc.xpath('//*[@id="loadScripts"]')
+    return nil if load_scripts_data.empty?
+
+    script_html = load_scripts_data.attr('data-docs')
+    server_from_cache_script_html(script_html)
+  rescue RuntimeError => e
+    OnlyofficeLoggerHelper.log("Failed to fetch_docserverserver_url with #{e}")
+    nil
+  end
+
+  private
+
+  def server_from_cache_script_html(url)
+    uri = URI(url)
+    "#{uri.scheme}://#{uri.host}:#{uri.port}"
+  end
+end

data/lib/onlyoffice_documentserver_testing_framework/test_instance_docs/doc_test_site_functions/healthcheck_page.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# Page for describing healthcheck page
+class HealthcheckPage
+  def initialize(instance)
+    @instance = instance
+  end
+
+  # @return [String] status of healthcheck on page
+  def status
+    current_status = @instance.webdriver.get_text('//body')
+    OnlyofficeLoggerHelper.log("Current status of healthcheck is: #{current_status}")
+    current_status
+  end
+end