onlyoffice_documentserver_testing_framework 1.0.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17567e4fc1878b2daa5440e7f35dbaebfdc5d131063eb4ecfd5d59d0f0728969
-  data.tar.gz: cbc6e28420e32b836cc7519bb8b2e2f88291e1e3561f9c946377381eb7cf8bc0
+  metadata.gz: 36dbc0fe0c71ba6c46646fe89ce746a204c0ed709fd8ae41c9e838a589891fe1
+  data.tar.gz: 30ed604f753f3ba08cb439316d58889e75ab08aef0dcfc7e0aed61a9d455c5cd
 SHA512:
-  metadata.gz: 713ff6238cc2716a92380e0e62330211055b87a43d7f4dbbbbe3ad89b1a67657e5870fc6ce0298a4ecb2e29683dae1ad9ded11bc023523309f81ce89f36045cb
-  data.tar.gz: 69465a34dd3760da08f8c61c11867b4dd8a24ef72cca11a7ff89183a1d30026a5dc50e102979003b58150f68dc758dff6f0b4511788b48a51b3b9ac13a99cd51
+  metadata.gz: 53a1944e52d3eacdb27fa3fa6efbe7577e8cab07a6b848326ec41dae4f413caa9bdc5febbb323a419ac2ccc15b52bd1e7870c5e1b0f6e37aba3ab7fe1e7a20e9
+  data.tar.gz: 87889c2899bb3889056b2fc509e527c51aa2b22a2098d3afd7083729cda2323f88d1bdcf1494899608a982df4169fb4a5879b71d6d3c311bb40d11363bd8f379

data/lib/onlyoffice_documentserver_testing_framework/selenium_wrapper.rb

@@ -11,9 +11,9 @@ module OnlyofficeDocumentserverTestingFramework
     # @param name [Symbol] function to call
     # @param arguments [Hash] list of arguments
     # @return [Object] result of method
-    def selenium_functions(name, *arguments)
+    def selenium_functions(name, *arguments, **options)
       select_frame do
-        @instance.selenium.send name, *arguments
+        @instance.selenium.send name, *arguments, **options
       end
     end
 

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module OnlyofficeDocumentserverTestingFramework
+  # More methods for working with top toolbar of document
+  class TopToolbarDocument
+    include SeleniumWrapper
+
+    def initialize(instance)
+      @instance = instance
+      @xpath_document_name = '//*[(@id="rib-doc-name") or (@id="title-doc-name")]'
+    end
+
+    # @return [String] name of the document
+    def document_name
+      # TODO: use `get_text` before `get_text_by_js`
+      #   as soon as https://bugzilla.onlyoffice.com/show_bug.cgi?id=45981 resolved
+      # If top toolbar is hidden - cannot get text by WebDriver, use js instead
+      text = selenium_functions(:get_text_by_js, @xpath_document_name)
+      OnlyofficeLoggerHelper.log("Get document name from header: #{text}")
+      text
+    end
+  end
+end

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'doc_editor_top_toolbar/top_toolbar_users'
+require_relative 'doc_editor_top_toolbar/top_toolbar_document'
 require_relative 'doc_editor_top_toolbar/title_row'
 
 module OnlyofficeDocumentserverTestingFramework
@@ -19,5 +20,10 @@ module OnlyofficeDocumentserverTestingFramework
     def users
       @users ||= TopToolbarUsers.new(@instance)
     end
+
+    # @return [TopToolbarDocument] more top toolbar data of document
+    def top_toolbar
+      @top_toolbar = TopToolbarDocument.new(@instance)
+    end
   end
 end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module OnlyofficeDocumentserverTestingFramework
+  # Module for Reopen file related methods
+  module FileReopenHelper
+    # Perform reopen after autosave
+    def reopen_after_autosave
+      url = @instance.selenium.get_url
+      leave_file_and_build_it
+      @instance.webdriver.open(url)
+      @instance.management.wait_for_operation_with_round_status_canvas
+    end
+
+    private
+
+    # Leave current opened file and wait until it's builder
+    # @return [nil]
+    def leave_file_and_build_it
+      file_name = @instance.management.document_name
+      size_before = @instance.integration_example_api.file_data(file_name)['pureContentLength'].to_i
+      @instance.go_to_base_url
+      @instance.webdriver.wait_until do
+        @instance.integration_example_api.file_data(file_name)['pureContentLength'].to_i != size_before
+      end
+      OnlyofficeLoggerHelper.log("File: `#{file_name}` was built after editing")
+    end
+  end
+end

data/lib/onlyoffice_documentserver_testing_framework/test_instance_docs/doc_test_site_functions.rb

@@ -3,10 +3,12 @@
 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'
+require_relative 'doc_test_site_functions/file_reopen_helper'
 # Class to work with test examples
 class DocTestSiteFunctions
   extend DocTestSiteServerHelper
   include PageObject
+  include OnlyofficeDocumentserverTestingFramework::FileReopenHelper
 
   select_list(:user_list, xpath: '//*[@id="user"]')
   select_list(:language_list, xpath: '//*[@id="language"]')
@@ -217,15 +219,6 @@ class DocTestSiteFunctions
     @healthcheck = HealthcheckPage.new(@instance)
   end
 
-  # Perform reopen after autosave
-  def reopen_after_autosave
-    url = @instance.selenium.get_url
-    @instance.go_to_base_url
-    sleep(60) # just a rough value for building document version
-    @instance.webdriver.open(url)
-    @instance.management.wait_for_operation_with_round_status_canvas
-  end
-
   # @param [DocumentServerVersion] version of server
   # @return [Array<String>] list of supported languages
   def self.supported_languages(version = OnlyofficeDocumentserverTestingFramework::DocumentServerVersion.new(6, 2, 0))

data/lib/onlyoffice_documentserver_testing_framework/test_instance_docs/integration_example_api.rb

@@ -38,7 +38,7 @@ module OnlyofficeDocumentserverTestingFramework
     def delete_file(file_name)
       raise 'File name is not found on server' unless file_data(file_name)
 
-      url = URI("#{@api_endpoint}/file?filename=#{file_name}")
+      url = URI::DEFAULT_PARSER.escape("#{@api_endpoint}/file?filename=#{file_name}")
       request = Net::HTTP::Delete.new(url)
       response = http_from_url(url).request(request)
       JSON.parse(response.read_body)

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module OnlyofficeDocumentserverTestingFramework
+  # Check different messages of document load
+  module ManagerMessagesChecker
+    # @return [Boolean] is permission denied message shown
+    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
+
+    # @return [Boolean] is `File not found` message shown
+    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
+  end
+end

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

@@ -10,7 +10,7 @@ module OnlyofficeDocumentserverTestingFramework
 
     # @return [String] xpath of ok in protected file dialog
     def xpath_ok_password
-      "#{xpath_input_password}/../../../../../..//button"
+      "#{xpath_input_password}/../../../../../..//button[@result='ok']"
     end
 
     # @return [Boolean] check if incorrect password warning is shown

data/lib/onlyoffice_documentserver_testing_framework/test_instance_docs/management.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
 require_relative 'management/loader_helper'
+require_relative 'management/manager_messages_checker'
 require_relative 'management/password_protected_helper'
 module OnlyofficeDocumentserverTestingFramework
   # Class for management main methods
   class Management
     include SeleniumWrapper
+    include ManagerMessagesChecker
     include LoaderHelper
     include PasswordProtectedHelper
 
@@ -169,24 +171,6 @@ module OnlyofficeDocumentserverTestingFramework
       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
@@ -221,5 +205,23 @@ module OnlyofficeDocumentserverTestingFramework
 
       true
     end
+
+    # Get name of currently opened document
+    # @param [Boolean] with_extension - should extension be included
+    # @return [String]
+    def document_name(with_extension: true)
+      doc_name = @instance.doc_editor.top_toolbar.top_toolbar.document_name
+      doc_name.chop! if status_save?(doc_name)
+      doc_name = File.basename(doc_name, '.*') unless with_extension
+      doc_name
+    end
+
+    # Check if document has not be saved until now
+    # @param [String] name of document
+    # @return [Boolean] result of that check
+    def status_save?(name = nil)
+      name ||= @instance.doc_editor.top_toolbar.top_toolbar.document_name
+      name[-1] == '*'
+    end
   end
 end

data/lib/onlyoffice_documentserver_testing_framework/version.rb

@@ -4,6 +4,6 @@ module OnlyofficeDocumentserverTestingFramework
   # Module to hold version of Gem
   module Version
     # [String] version of gem
-    STRING = '1.0.0'
+    STRING = '2.2.1'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: onlyoffice_documentserver_testing_framework
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.2.1
 platform: ruby
 authors:
 - ONLYOFFICE
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-21 00:00:00.000000000 Z
+date: 2022-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: onlyoffice_logger_helper
@@ -190,6 +190,7 @@ files:
 - 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/title_row.rb
+- lib/onlyoffice_documentserver_testing_framework/test_instance_docs/doc_editor/doc_editor_top_toolbar/top_toolbar_document.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
@@ -200,10 +201,12 @@ files:
 - lib/onlyoffice_documentserver_testing_framework/test_instance_docs/doc_test_site_functions/doc_test_site_languages_after_6_2.list
 - lib/onlyoffice_documentserver_testing_framework/test_instance_docs/doc_test_site_functions/doc_test_site_languages_before_6_2.list
 - 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/file_reopen_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/integration_example_api.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/management/manager_messages_checker.rb
 - lib/onlyoffice_documentserver_testing_framework/test_instance_docs/management/password_protected_helper.rb
 - lib/onlyoffice_documentserver_testing_framework/test_instance_docs/presentation_editor.rb
 - lib/onlyoffice_documentserver_testing_framework/test_instance_docs/spreadsheet_editor.rb
@@ -228,14 +231,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.4
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: ONLYOFFICE DocumentServer testing framework