onlyoffice_digitalocean_wrapper 0.4.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0756716e26a6789e98ffc4a22d58cb04587a93536680b183e600c233ae313dc8
-  data.tar.gz: de4e2ef86ffac922ad2c44d65e8034320db3f18137d2a64d491e7314cdcb9413
+  metadata.gz: 0b5f288d8ace3eb4b4233a65a15ad7205c993361a5218939ecae254902e57d39
+  data.tar.gz: 987062f1ec25e58d45c5c0fadfdd672ac7f4a9908a4b0563be2e000051dca0d2
 SHA512:
-  metadata.gz: 2d9c8941038d5e597f50fdce3d210f52d1902377b02e6c37c7b3f7fc6ac177de27d000f6da7edb28548d41029347694ada56467412746ac41a16368d1c892894
-  data.tar.gz: 101b02d252365ea34d1888e0452c7ce49bdf0e3f640e4566d322a52c28fe463b4af3e9b277a8266d7e111cc2c39dd7f4887c3b045b896f35c19ed1d579c2025b
+  metadata.gz: 8780c445ee63541b12093435e816a555c05e6d9afeac0244cbb95d88b73b8d5a41b3c4567645ffee12340cfad00ddd1f8a7b2c0c85bfecb7500a292080c0e5e8
+  data.tar.gz: a73c0ce3bfde1c16ad9b96b90ec2cf6a5f4b53dc573ff228930d8f680309a0801c008cb26e473eb4cad194730757a5055ec93a3043137070813b8ec3bd671bdf

data/lib/onlyoffice_digitalocean_wrapper/digitalocean_wrapper/exceptions_retryer.rb

@@ -15,8 +15,8 @@ module OnlyofficeDigitaloceanWrapper
         yield
       rescue exception => e
         try += 1
-        OnlyofficeLoggerHelper.log("Error '#{exception}, #{e}' happened during "\
-                                   "operation. Retrying #{try} of #{retries}")
+        logger.error("Error '#{exception}, #{e}' happened during "\
+                     "operation. Retrying #{try} of #{retries}")
         sleep timeout # Time to cooldown error
         try <= retries ? retry : raise
       end

data/lib/onlyoffice_digitalocean_wrapper/digitalocean_wrapper/getters.rb

@@ -8,7 +8,7 @@ module OnlyofficeDigitaloceanWrapper
       image = all_droplets.find { |x| x.name == image_name }
       raise DigitalOceanImageNotFound, image_name if image.nil?
 
-      OnlyofficeLoggerHelper.log("get_image_id_by_name(#{image_name}): #{image.id}")
+      logger.info("get_image_id_by_name(#{image_name}): #{image.id}")
       image.id
     end
 
@@ -22,40 +22,73 @@ module OnlyofficeDigitaloceanWrapper
       end
     end
 
+    # Get project by name
+    # @param [String] project_name
+    # @return [DropletKit::Project] object representing a project
+    def project_by_name(project_name)
+      retry_exception do
+        projects = @client.projects.all
+        projects.find { |x| x.name == project_name }
+      end
+    end
+
+    # Get project id by name
+    # @param [String] project_name
+    # @return [nil, String] id of current project or nil is no project found
+    def get_project_id_by_name(project_name)
+      project = project_by_name(project_name)
+      if project.nil?
+        logger.info("get_project_id_by_name(#{project_name}): not found any projects")
+        nil
+      else
+        logger.info("get_project_id_by_name(#{project_name}): #{project.id}")
+        project.id
+      end
+    end
+
+    # Return droplet id by it's name
+    # @param droplet_name [String] name of droplet
+    # @return [nil, Integer] id of droplet or nil is no one droplet found
     def get_droplet_id_by_name(droplet_name)
       droplet = droplet_by_name(droplet_name)
       if droplet.nil?
-        OnlyofficeLoggerHelper.log("get_droplet_id_by_name(#{droplet_name}): not found any droplets")
+        logger.info("get_droplet_id_by_name(#{droplet_name}): not found any droplets")
         nil
       else
-        OnlyofficeLoggerHelper.log("get_droplet_id_by_name(#{droplet_name}): #{droplet.id}")
+        logger.info("get_droplet_id_by_name(#{droplet_name}): #{droplet.id}")
         droplet.id
       end
     end
 
+    # Return droplet ip by it's name
+    # @param droplet_name [String] name of droplet
+    # @return [String] ip of droplet
     def get_droplet_ip_by_name(droplet_name)
       droplet = droplet_by_name(droplet_name)
       if droplet.nil?
-        OnlyofficeLoggerHelper.log("There is no created droplet with name: #{droplet_name}")
+        logger.info("There is no created droplet with name: #{droplet_name}")
         return
       end
       retry_exception do
         ip = public_ip(droplet)
-        OnlyofficeLoggerHelper.log("get_droplet_ip_by_name(#{droplet_name}): #{ip}")
+        logger.info("get_droplet_ip_by_name(#{droplet_name}): #{ip}")
         ip
       end
     end
 
+    # Return droplet status by it's name
+    # @param droplet_name [String] name of droplet
+    # @return [Symbol] droplet status
     def get_droplet_status_by_name(droplet_name)
       droplet = droplet_by_name(droplet_name)
       if droplet.nil?
-        OnlyofficeLoggerHelper.log("get_droplet_status_by_name(#{droplet_name}): not found any droplets")
+        logger.info("get_droplet_status_by_name(#{droplet_name}): not found any droplets")
         nil
       else
         retry_exception do
           status = droplet.status
           status = :locked if droplet.locked
-          OnlyofficeLoggerHelper.log("get_droplet_status_by_name(#{droplet_name}): #{status}")
+          logger.info("get_droplet_status_by_name(#{droplet_name}): #{status}")
           status
         end
       end
@@ -66,7 +99,7 @@ module OnlyofficeDigitaloceanWrapper
     # @return [String] public ip
     def public_ip(droplet)
       networks = droplet.networks.to_a.first
-      public_network = networks.find { |net| net.type == 'public'}
+      public_network = networks.find { |net| net.type == 'public' }
       public_network.ip_address
     end
   end

data/lib/onlyoffice_digitalocean_wrapper/digitalocean_wrapper/logger_wrapper.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module OnlyofficeDigitaloceanWrapper
+  # Logger module for logging stuff
+  module LoggerWrapper
+    # @return [Logger] default logger
+    def logger
+      @logger ||= Logger.new($stdout)
+    end
+  end
+end

data/lib/onlyoffice_digitalocean_wrapper/digitalocean_wrapper/power_actions.rb

@@ -3,18 +3,27 @@
 module OnlyofficeDigitaloceanWrapper
   # Actions with power (turn on/off, reboot)
   module PowerActions
+    # Turn off droplet
+    # @param droplet_name [String] droplet to turn off
+    # @return [Symbol] droplet result status
     def power_off_droplet(droplet_name)
       droplet_id = get_droplet_id_by_name(droplet_name)
       client.droplet_actions.power_off(droplet_id: droplet_id)
       wait_until_droplet_have_status(droplet_name, 'off')
     end
 
+    # Turn on droplet
+    # @param droplet_name [String] droplet to turn on
+    # @return [Symbol] droplet result status
     def power_on_droplet(droplet_name)
       droplet_id = get_droplet_id_by_name(droplet_name)
       client.droplet_actions.power_on(droplet_id: droplet_id)
       wait_until_droplet_have_status(droplet_name)
     end
 
+    # Reboot droplet
+    # @param droplet_name [String] droplet to reboot
+    # @return [Symbol] droplet result status
     def reboot_droplet(droplet_name)
       droplet_id = get_droplet_id_by_name(droplet_name)
       client.droplet_actions.reboot(droplet_id: droplet_id)

data/lib/onlyoffice_digitalocean_wrapper/digitalocean_wrapper/token_methods.rb

@@ -15,14 +15,17 @@ module OnlyofficeDigitaloceanWrapper
     end
 
     # Read access token from file system
+    # @param token_file_path [String] path to token
+    # @param force_file_read [True, False] should read from file be forced
     # @return [String] token
-    def read_token
-      return ENV['DO_ACCESS_TOKEN'] if ENV['DO_ACCESS_TOKEN']
+    def read_token(token_file_path: "#{Dir.home}/.do/access_token",
+                   force_file_read: false)
+      return ENV['DO_ACCESS_TOKEN'] if ENV['DO_ACCESS_TOKEN'] && !force_file_read
 
-      File.read(Dir.home + '/.do/access_token').delete("\n")
+      File.read(token_file_path).delete("\n")
     rescue Errno::ENOENT
-      raise Errno::ENOENT, "No access token found in #{Dir.home}/.do/ directory." \
-      "Please create files #{Dir.home}/.do/access_token"
+      raise Errno::ENOENT, "No access token found in #{token_file_path}. " \
+                           "Please create file #{token_file_path} with token"
     end
   end
 end

data/lib/onlyoffice_digitalocean_wrapper/digitalocean_wrapper.rb

@@ -1,21 +1,24 @@
 # frozen_string_literal: true
 
 require 'droplet_kit'
-require 'onlyoffice_logger_helper'
 require_relative 'digitalocean_wrapper/digitalocean_exceptions'
 require_relative 'digitalocean_wrapper/exceptions_retryer'
 require_relative 'digitalocean_wrapper/getters'
+require_relative 'digitalocean_wrapper/logger_wrapper'
 require_relative 'digitalocean_wrapper/power_actions'
 require_relative 'digitalocean_wrapper/token_methods'
 
+# Namespace for this gem
 module OnlyofficeDigitaloceanWrapper
   # Class for wrapping DigitalOcean API gem
   class DigitalOceanWrapper
     include Getters
+    include LoggerWrapper
     include ExceptionsRetryer
     include PowerActions
     include TokenMethods
 
+    # @return [Array<String>] list of allowed droplet sizes
     DROPLET_SIZES = %w[512mb 1gb 2gb 4gb 8gb 16gb 32gb 48gb 64gb].freeze
     attr_accessor :client
 
@@ -25,20 +28,32 @@ module OnlyofficeDigitaloceanWrapper
       raise ArgumentError, 'DigitalOceanWrapper: Your Access Token is Incorrect' unless correct_access_token?
     end
 
+    # Wait until droplet has status
+    # @param droplet_name [String] name of droplet
+    # @param status [String] status to wait
+    # @param params [Hash] additiona params
+    # @return [Symbol] droplet status after wait over
     def wait_until_droplet_have_status(droplet_name, status = 'active', params = {})
       timeout = params.fetch(:timeout, 300)
       counter = 0
       while get_droplet_status_by_name(droplet_name) != status && counter < timeout
         counter += 10
         sleep 10
-        OnlyofficeLoggerHelper.log("waiting for droplet (#{droplet_name}) to have "\
-                                   "status: #{status} for #{counter} seconds of #{timeout}")
+        logger.info("waiting for droplet (#{droplet_name}) to have "\
+                    "status: #{status} for #{counter} seconds of #{timeout}")
       end
       raise DropletOperationTimeout, "#{droplet_name} was not #{status} for #{timeout}s" if counter >= timeout
 
       get_droplet_status_by_name(droplet_name)
     end
 
+    # Restore droplet from image by name
+    # @param image_name [String] name of image
+    # @param droplet_name [String] name for droplet
+    # @param region [String] region to restore
+    # @param size [String] size of droplet
+    # @param tags [String, Array<String>] name of tags to apply
+    # @return [Object] object with droplet data
     def restore_image_by_name(image_name = 'nct-at-stable',
                               droplet_name = image_name,
                               region = 'nyc3',
@@ -56,7 +71,7 @@ module OnlyofficeDigitaloceanWrapper
                                         monitoring: true,
                                         size: size)
       created = @client.droplets.create(droplet)
-      OnlyofficeLoggerHelper.log("restore_image_by_name(#{image_name}, #{droplet_name})")
+      logger.info("restore_image_by_name(#{image_name}, #{droplet_name})")
       if created.is_a?(String)
         raise "Problem, while creating '#{droplet_name}' from image '#{image_name}'\n" \
               "Error: #{created}"
@@ -64,10 +79,13 @@ module OnlyofficeDigitaloceanWrapper
       created
     end
 
+    # Destroy droplet by name
+    # @param droplet_name [String] name of droplet
+    # @return [Symbol] Droplet status after destruction
     def destroy_droplet_by_name(droplet_name = 'nct-at1')
       droplet_id = get_droplet_id_by_name(droplet_name)
       client.droplets.delete(id: droplet_id)
-      OnlyofficeLoggerHelper.log("destroy_droplet_by_name(#{droplet_name})")
+      logger.info("destroy_droplet_by_name(#{droplet_name})")
       wait_until_droplet_have_status(droplet_name, nil)
     end
   end

data/lib/onlyoffice_digitalocean_wrapper/ssh_checker/ssh_checker_exceptions.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module OnlyofficeDigitaloceanWrapper
+  # Class raised if droplet ssh is not up for defined timeout
+  class SshCheckerSshUpTimeout < StandardError
+  end
+end

data/lib/onlyoffice_digitalocean_wrapper/ssh_checker.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'net-telnet'
+
+require_relative 'ssh_checker/ssh_checker_exceptions'
+
+module OnlyofficeDigitaloceanWrapper
+  # Class for check if ssh can be connected
+  class SshChecker
+    include LoggerWrapper
+    # @return [String] ip of server
+    attr_reader :ip
+
+    # @param ip [String] ip of server to check
+    def initialize(ip)
+      @ip = ip
+    end
+
+    # Wait until ssh server on server is up and available for connection
+    # @param timeout [Integer] how much we should wait for connection
+    # @return [void]
+    def wait_until_ssh_up(timeout: 60)
+      wait_between_tries = 5
+      tries = timeout / wait_between_tries
+      tries.times do |try|
+        if ssh_up?
+          logger.info("SSH on `#{@ip}` is up. Waiting finished")
+          return true
+        end
+
+        logger.info("SSH on `#{@ip}` is not up. Waited for #{try * wait_between_tries} seconds of #{timeout}")
+        sleep wait_between_tries
+      end
+      raise SshCheckerSshUpTimeout, "SSH on `#{@ip}` is not up for #{timeout} seconds. Could not proceed"
+    end
+
+    # Check is ssh available for connection right now
+    # @return [Boolean]
+    def ssh_up?
+      Net::Telnet.new('Host' => @ip,
+                      'Timeout' => 1,
+                      'Port' => 22)
+      true
+    rescue StandardError
+      false
+    end
+  end
+end

data/lib/onlyoffice_digitalocean_wrapper/version.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 module OnlyofficeDigitaloceanWrapper
-  VERSION = '0.4.1'
+  # @return [String] version of gem
+  VERSION = '0.8.0'
+  # @return [String] name of gem
   NAME = 'onlyoffice_digitalocean_wrapper'
 end

data/lib/onlyoffice_digitalocean_wrapper.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
 
 require_relative 'onlyoffice_digitalocean_wrapper/digitalocean_wrapper'
+require_relative 'onlyoffice_digitalocean_wrapper/ssh_checker'
 require_relative 'onlyoffice_digitalocean_wrapper/version'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: onlyoffice_digitalocean_wrapper
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.8.0
 platform: ruby
 authors:
 - ONLYOFFICE
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-05 00:00:00.000000000 Z
+date: 2021-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: droplet_kit
@@ -27,19 +27,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
-  name: onlyoffice_logger_helper
+  name: net-telnet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -54,6 +82,90 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.49.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.49.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.20
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.20
 description: Wrapper gem for DigitalOcean. Use in testing projects
 email:
 - shockwavenn@gmail.com
@@ -67,18 +179,21 @@ files:
 - lib/onlyoffice_digitalocean_wrapper/digitalocean_wrapper/digitalocean_exceptions.rb
 - lib/onlyoffice_digitalocean_wrapper/digitalocean_wrapper/exceptions_retryer.rb
 - lib/onlyoffice_digitalocean_wrapper/digitalocean_wrapper/getters.rb
+- lib/onlyoffice_digitalocean_wrapper/digitalocean_wrapper/logger_wrapper.rb
 - lib/onlyoffice_digitalocean_wrapper/digitalocean_wrapper/power_actions.rb
 - lib/onlyoffice_digitalocean_wrapper/digitalocean_wrapper/token_methods.rb
+- lib/onlyoffice_digitalocean_wrapper/ssh_checker.rb
+- lib/onlyoffice_digitalocean_wrapper/ssh_checker/ssh_checker_exceptions.rb
 - lib/onlyoffice_digitalocean_wrapper/version.rb
-homepage: https://github.com/onlyoffice-testing-robot/onlyoffice_digitalocean_wrapper
+homepage: https://github.com/ONLYOFFICE-QA/onlyoffice_digitalocean_wrapper
 licenses:
 - AGPL-3.0
 metadata:
-  bug_tracker_uri: https://github.com/onlyoffice-testing-robot/onlyoffice_digitalocean_wrapper/issues
-  changelog_uri: https://github.com/onlyoffice-testing-robot/onlyoffice_digitalocean_wrapper/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/ONLYOFFICE-QA/onlyoffice_digitalocean_wrapper/issues
+  changelog_uri: https://github.com/ONLYOFFICE-QA/onlyoffice_digitalocean_wrapper/blob/master/CHANGELOG.md
   documentation_uri: https://www.rubydoc.info/gems/onlyoffice_digitalocean_wrapper
-  homepage_uri: https://github.com/onlyoffice-testing-robot/onlyoffice_digitalocean_wrapper
-  source_code_uri: https://github.com/onlyoffice-testing-robot/onlyoffice_digitalocean_wrapper
+  homepage_uri: https://github.com/ONLYOFFICE-QA/onlyoffice_digitalocean_wrapper
+  source_code_uri: https://github.com/ONLYOFFICE-QA/onlyoffice_digitalocean_wrapper
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -87,14 +202,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.27
 signing_key: 
 specification_version: 4
 summary: Wrapper gem for DigitalOcean