onlyoffice_documentserver_testing_framework 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 941e375b508dde231ae51e9f00824a5485de8b29fc8ed9bf6c552f3e40a08b51
-  data.tar.gz: 5e246acbb1d6e0eac6c9f2fe6812eb5d6f2429ee40cde9d8d500f9082d1d0f59
+  metadata.gz: b6272fb5c8b263cd7df59357b5b53f3a2282e2f21373d052ef054edb26b4a3bf
+  data.tar.gz: 34ebc6388986663a06496b198f95fd1c4dbc5932e6ac00b6c5e0e7ecae433f39
 SHA512:
-  metadata.gz: fbcec58347a88accef63c913ff1d148709eb8cd6f489d4ef93ae197399ac3f5eb34960bece2a9b9bd4af5dd41b263be45d50ebdb6b6b3de5268c3d77b178684d
-  data.tar.gz: 8f4c7c79964f964f2c84febca81fb484d40592961339b5c512dc5405b7d56e23774070ea0eaf1d3373ed660bb7b6d2f5761fef6eeefef572e54cd272b6fde4df
+  metadata.gz: 34cf7eb38515440464ff549f1890d7fef47c485289107c7f9444c79eb0e382f07e4da5fef97591712476813002e89c1fc9b36f3e0595661c18b67023aae96096
+  data.tar.gz: cf8cf9bc77b1120f768863e86cddfbbdb4513c729637a6db3b901c1c4dc919dfacda13472894635212ead1d7c15714b409d104efb217d04b8d86975fd3727378

data/lib/onlyoffice_documentserver_testing_framework.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative 'onlyoffice_documentserver_testing_framework/document_server_version'
 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/document_server_version.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module OnlyofficeDocumentserverTestingFramework
+  # Class for working with DocumentServer version
+  class DocumentServerVersion
+    include Comparable
+
+    # @return [Integer] Major version
+    attr_reader :major
+    # @return [Integer] Minor version
+    attr_reader :minor
+    # @return [Integer] Patch version
+    attr_reader :patch
+    # @return [Integer] Build version
+    attr_reader :build
+
+    # rubocop:disable Metrics/ParameterLists
+    def initialize(major = 0, minor = 0, patch = 0, build = 0)
+      @major = major
+      @minor = minor
+      @patch = patch
+      @build = build
+    end
+    # rubocop:enable Metrics/ParameterLists
+
+    # @param string [String] string value of build to parse
+    # @return [DocumentServerVersion] result of parsing
+    def parse(string)
+      return self if string == 'Unknown'
+
+      split_by_dot = string.split('.')
+      split_by_space = split_by_dot[2].split
+      @major = split_by_dot[0].to_i
+      @minor = split_by_dot[1].to_i
+      @patch = split_by_space[0].to_i
+      @build = split_by_space[1].scan(/\d/).join.to_i
+      self
+    end
+
+    # @return [String] string value
+    def to_s
+      "#{@major}.#{@minor}.#{@patch} (build:#{@build})"
+    end
+
+    # @return [String] sting with all digits separted by dots
+    def to_dotted_string
+      "#{@major}.#{@minor}.#{@patch}.#{@build}"
+    end
+
+    # Compare two DocumentServerVersion
+    # @param [DocumentServerVersion] other to compare
+    # @return [Integer] result of compare
+    def <=>(other)
+      Gem::Version.new(to_dotted_string) <=>
+        Gem::Version.new(other.to_dotted_string)
+    end
+  end
+end

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

@@ -27,3 +27,5 @@ Blocked autofocusing on a <input> element in a cross-origin subframe.
 /embed
 ResponsiveVoice missing API key
 /libfont/wasm/
+UserControls/Management
+clientscript/

data/lib/onlyoffice_documentserver_testing_framework/test_instance_docs.rb

@@ -5,6 +5,7 @@ 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/integration_example_api'
 require_relative 'test_instance_docs/presentation_editor'
 require_relative 'test_instance_docs/spreadsheet_editor'
 require_relative 'test_instance_docs/management'
@@ -13,10 +14,21 @@ module OnlyofficeDocumentserverTestingFramework
   # Main class for browser instance
   class TestInstanceDocs
     attr_accessor :selenium
+    # @return [String] base url of DocumentServer
+    attr_reader :doc_server_base_url
     alias webdriver selenium
 
-    def initialize(webdriver: OnlyofficeWebdriverWrapper::WebDriver.new(:chrome))
+    # Initialize new instance
+    # @param [OnlyofficeWebdriverWrapper::WebDriver] webdriver for test instance
+    # @param [String] doc_server_base_url base url of DocumentServer
+    def initialize(webdriver: OnlyofficeWebdriverWrapper::WebDriver.new(:chrome), doc_server_base_url: nil)
       @selenium = webdriver
+      @doc_server_base_url = doc_server_base_url
+    end
+
+    # Open DocServer base url page
+    def go_to_base_url
+      webdriver.open(doc_server_base_url)
     end
 
     # @return [DocServiceWelcome] welcome page of DocumentServer
@@ -31,6 +43,11 @@ module OnlyofficeDocumentserverTestingFramework
       DocTestSiteFunctions.new(self)
     end
 
+    # @return [IntegrationExampleApi] for methods
+    def integration_example_api
+      @integration_example_api ||= IntegrationExampleApi.new(self)
+    end
+
     # @return [DocEditor] Document Editor instance
     def doc_editor
       @doc_editor ||= DocEditor.new(self)

data/lib/onlyoffice_documentserver_testing_framework/test_instance_docs/doc_test_site_functions.rb

@@ -8,28 +8,6 @@ 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"]')
 
@@ -41,6 +19,12 @@ class DocTestSiteFunctions
     @xpath_conversion_step = '//*[@id="step2"]'
     @xpath_editor_scripts_step = '//*[@id="step3"]'
     @xpath_file_entry = '//*[@class="stored-list"]/table/tbody/tr'
+    @xpath_create_doc = '//*[contains(@class, "try-editor document")]|'\
+                        '//*[contains(@class, "try-editor word")]'
+    @xpath_create_workbook = '//*[contains(@class, "try-editor spreadsheet")]|'\
+                             '//*[contains(@class, "try-editor cell")]'
+    @xpath_create_presentation = '//*[contains(@class, "try-editor presentation")]|'\
+                                 '//*[contains(@class, "try-editor slide")]'
   end
 
   # Waiting for load of page
@@ -170,7 +154,7 @@ class DocTestSiteFunctions
 
   # @return [True, False] is on file list page now?
   def file_list_opened?
-    @instance.selenium.element_visible?('//*[contains(@class, "try-editor document")]')
+    @instance.selenium.element_visible?(@xpath_create_doc)
   end
 
   # @return [Integer] count of uploaded files
@@ -208,11 +192,11 @@ class DocTestSiteFunctions
   def open_sample_document(format = :document, wait_to_load: true)
     case format
     when :document
-      @instance.selenium.click_on_locator('//*[contains(@class, "try-editor document")]')
+      @instance.selenium.click_on_locator(@xpath_create_doc)
     when :spreadsheet
-      @instance.selenium.click_on_locator('//*[contains(@class, "try-editor spreadsheet")]')
+      @instance.selenium.click_on_locator(@xpath_create_workbook)
     when :presentation
-      @instance.selenium.click_on_locator('//*[contains(@class, "try-editor presentation")]')
+      @instance.selenium.click_on_locator(@xpath_create_presentation)
     else
       @instance.webdriver.webdriver_error("Unknown file type for open_sample_document(#{format})")
     end
@@ -232,4 +216,27 @@ class DocTestSiteFunctions
   def healthcheck
     @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))
+    file = if version >= OnlyofficeDocumentserverTestingFramework::DocumentServerVersion.new(6, 2)
+             'doc_test_site_languages_after_6_2.list'
+           else
+             'doc_test_site_languages_before_6_2.list'
+           end
+    File.readlines("#{File.expand_path('..', __dir__)}"\
+                                     '/test_instance_docs/doc_test_site_functions/'\
+                                     "#{file}")
+        .map(&:strip)
+  end
 end

data/lib/onlyoffice_documentserver_testing_framework/test_instance_docs/doc_test_site_functions/doc_test_site_languages_after_6_2.list

@@ -0,0 +1,31 @@
+English
+Belarusian
+Bulgarian
+Catalan
+Chinese
+Czech
+Danish
+Dutch
+Finnish
+French
+German
+Greek
+Hungarian
+Indonesian
+Italian
+Japanese
+Korean
+Latvian
+Lao
+Norwegian
+Polish
+Portuguese
+Romanian
+Russian
+Slovak
+Slovenian
+Swedish
+Spanish
+Turkish
+Ukrainian
+Vietnamese

data/lib/onlyoffice_documentserver_testing_framework/test_instance_docs/doc_test_site_functions/doc_test_site_languages_before_6_2.list

@@ -0,0 +1,21 @@
+English
+Bulgarian
+Chinese
+Czech
+Dutch
+French
+German
+Hungarian
+Italian
+Japanese
+Korean
+Latvian
+Polish
+Portuguese
+Russian
+Slovak
+Slovenian
+Spanish
+Turkish
+Ukrainian
+Vietnamese

data/lib/onlyoffice_documentserver_testing_framework/test_instance_docs/integration_example_api.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'uri'
+require 'net/http'
+
+module OnlyofficeDocumentserverTestingFramework
+  # Class for working with integration example api
+  class IntegrationExampleApi
+    def initialize(instance)
+      @instance = instance
+      @api_endpoint = "#{@instance.doc_server_base_url}/example"
+    end
+
+    # @return [Array<Hash>] list of file on example
+    def files
+      url = "#{@api_endpoint}/files/"
+      request = Net::HTTP::Get.new(url)
+      response = http_from_url(url).request(request)
+      JSON.parse(response.read_body)
+    end
+
+    # Upload file by it's path
+    # @param [String] file_path
+    # @return [String] name of uploaded file
+    def upload_file(file_path)
+      url = URI("#{@api_endpoint}/upload/")
+
+      request = Net::HTTP::Post.new(url)
+      form_data = [['uploadedFile', File.open(file_path)]]
+      request.set_form(form_data, 'multipart/form-data')
+      response = http_from_url(url).request(request)
+      JSON.parse(response.read_body)['filename']
+    end
+
+    # Delete file on server by name
+    # @param [String] file_name
+    # @return [nil]
+    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}")
+      request = Net::HTTP::Delete.new(url)
+      response = http_from_url(url).request(request)
+      JSON.parse(response.read_body)
+    end
+
+    # Get file data by it's name
+    # @param [String] name
+    # @return [String, nil] id
+    def file_data(name)
+      files.each do |file|
+        return file if file['title'] == name
+      end
+      nil
+    end
+
+    private
+
+    def http_from_url(url)
+      uri = URI(url)
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true if uri.scheme == 'https'
+      http
+    end
+  end
+end

data/lib/onlyoffice_documentserver_testing_framework/test_instance_docs/management.rb

@@ -16,7 +16,7 @@ module OnlyofficeDocumentserverTestingFramework
       @instance = instance
       @xpath_iframe_count = 1
       # Don't mixup iframe with help
-      @xpath_iframe = '//iframe[not(contains(@src, "help")) and '\
+      @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"

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 = '0.2.0'
+    STRING = '0.3.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: onlyoffice_documentserver_testing_framework
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - ONLYOFFICE
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-13 00:00:00.000000000 Z
+date: 2021-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: onlyoffice_logger_helper
@@ -43,128 +43,134 @@ dependencies:
   name: overcommit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.55.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.55.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.1
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.1
+        version: '13'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.9.0
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.9.0
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.90.0
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.90.0
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.43.2
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.43.2
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.5
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.5
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.25
+        version: 0.9.20
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.25
+        version: 0.9.20
 description: ONLYOFFICE DocumentServer testing framework, used in QA
 email:
 - shockwavenn@gmail.com
@@ -173,6 +179,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/onlyoffice_documentserver_testing_framework.rb
+- lib/onlyoffice_documentserver_testing_framework/document_server_version.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
@@ -189,8 +196,11 @@ files:
 - 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_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/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/presentation_editor.rb
@@ -222,7 +232,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.14
 signing_key: 
 specification_version: 4
 summary: ONLYOFFICE DocumentServer testing framework