add tests

Author: agaengel

.github/workflows/docker-image.yml

@@ -3,7 +3,8 @@ name: Create and publish a Docker image
 on:
   push:
     branches:
-      - 'main'
+      - main
+      - feature/*
     tags:
       - 'v*'
 
@@ -28,8 +29,8 @@ jobs:
 
       - run: |
           bundle install
+          bundle exec rake spec
           bundle exec rake build
-
       - name: Log in to the Container registry
         uses: docker/login-action@v1
         with:

.rspec

@@ -0,0 +1 @@
+--require spec_helper

Gemfile.lock

@@ -10,6 +10,8 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    diff-lcs (1.4.4)
+    docile (1.4.0)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
     http-accept (1.7.0)
@@ -27,18 +29,41 @@ GEM
       http-cookie (>= 1.0.2, < 2.0)
       mime-types (>= 1.16, < 4.0)
       netrc (~> 0.8)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.8)
     version (1.1.1)
 
 PLATFORMS
+  ruby
+  x86_64-darwin-20
   x86_64-linux
 
 DEPENDENCIES
   bundler (~> 2.0)
   deploy-to-ionos!
   rake (~> 13.0)
+  rspec (= 3.10.0)
+  simplecov (= 0.21.2)
 
 BUNDLED WITH
    2.2.16

Rakefile

@@ -2,6 +2,9 @@
 
 require 'bundler/gem_tasks'
 require 'rake/version_task'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
 
 task default: :build
 

deploy-to-ionos.gemspec

@@ -21,6 +21,8 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '3.10.0'
+  spec.add_development_dependency 'simplecov', '0.21.2'
 
   spec.add_runtime_dependency 'net-ssh', '6.1.0'
   spec.add_runtime_dependency 'passgen', '1.2.0'

exe/deploy-to-ionos

@@ -8,7 +8,7 @@ require 'size_checker'
 require 'remote_host'
 
 config = ConfigurationParser.parse(dist_folder: ENV['DIST_FOLDER'], bootstrap: ENV['BOOTSTRAP'] == 'true')
-common_excludes = %w[.deploy-now .git .github]
+common_excludes = %w[logs .deploy-now .git .github]
 deploy_now = DeployNowApi.new(endpoint: ENV['SERVICE_HOST'],
                               api_key: ENV['API_KEY'],
                               project_id: ENV['PROJECT_ID'],

lib/configuration_parser.rb

@@ -7,9 +7,13 @@ class << self
     def parse(options)
       return Configuration.new(options[:dist_folder]) unless File.exist? '.deploy-now/config.yaml'
 
-      config = YAML.safe_load(File.read('.deploy-now/config.yaml'))
+      begin
+        config = YAML.safe_load(File.read('.deploy-now/config.yaml'))
+      rescue Exception => e
+        abort "unable to pare the .deploy-now/config.yaml config file\n#{e}"
+      end
 
-      abort 'version must be specified' unless config.include? 'version'
+      abort 'version must be specified in .deploy-now/config.yaml config file' unless config.include? 'version'
 
       version = config['version'].to_s
       abort "unknown version: #{version}" unless version == '1.0'
@@ -21,13 +25,18 @@ def parse(options)
 
     def parse_1_0(config, dist_folder, bootstrap)
       if config.include? 'deploy'
+        abort "only 'bootstrap' or 'recurring are allowed for deploy.force in .deploy-now/config.yaml" unless config['deploy']['force'].eql?('bootstrap') || config['deploy']['force'].eql?('recurring') || config['deploy']['force'].nil?
         deploy_config = config['deploy']['force'] || (bootstrap ? 'bootstrap' : 'recurring')
 
-        abort "deploy configuration '#{deploy_config}' is missing" unless config['deploy'].include? deploy_config
-
-        Configuration.new(dist_folder,
-                          config['deploy'][deploy_config]['excludes'] || [],
-                          config['deploy'][deploy_config]['remote-commands'])
+        if config['deploy'].include? deploy_config
+          Configuration.new(dist_folder,
+                            config['deploy'][deploy_config]['excludes'] || [],
+                            config['deploy'][deploy_config]['remote-commands'])
+        else
+          Configuration.new(dist_folder,
+                            [],
+                            nil)
+        end
       else
         Configuration.new(dist_folder)
       end
@@ -43,4 +52,14 @@ def initialize(dist_folder, excludes = [], remote_commands = nil)
     @excludes = excludes
     @remote_commands = remote_commands
   end
+
+  def eql(other)
+    self.dist_folder == other.dist_folder &&
+      self.excludes == other.excludes &&
+      self.remote_commands == other.remote_commands
+  end
+
+  def to_s
+    "{dist: \"#{self.dist_folder}\", excludes: #{self .excludes.to_s}, remote_commands:#{self.remote_commands.to_s}}"
+  end
 end

lib/remote_host.rb

@@ -10,7 +10,7 @@ def initialize(options)
   end
 
   def deploy(options)
-    exclude_options = (options[:excludes] + ['logs']).map { |exclude| "--exclude=#{exclude}" }.join(' ')
+    exclude_options = (options[:excludes]).map { |exclude| "--exclude=#{exclude}" }.join(' ')
     cmd = "rsync -av --delete --rsh=\"/usr/bin/sshpass -e ssh -o StrictHostKeyChecking=no\" #{exclude_options} #{options[:dist_folder]} #{@user[:username]}@#{@host}:"
     puts cmd
     IO.popen(ENV.merge!({ 'SSHPASS' => @user[:password] }), cmd) do |io|

lib/size_checker.rb

@@ -9,6 +9,7 @@ def check(options)
       remote_excludes_size = calculate_remote_excludes_size(options[:user],
                                                             options[:host],
                                                             options[:excludes])
+
       size = deployment_size + remote_excludes_size
 
       if size > options[:allowed_size]
@@ -20,37 +21,37 @@ def check(options)
 
     def calculate_local_size(dist_folder, excludes)
       get_entries(dist_folder).reject { |entry| excludes.include? entry }
-                              .map { |entry| File.directory?(entry) ? calculate_dir_size(entry) : File.size(entry) }
+                              .map { |entry| File.directory?(dist_folder + File::SEPARATOR + entry) ?
+                                               calculate_dir_size(dist_folder + File::SEPARATOR + entry) :
+                                               File.size(dist_folder + File::SEPARATOR + entry) }
                               .sum
     end
 
     def calculate_dir_size(dir)
-      size = File.size(dir)
+      size = 0
       get_entries(dir).each do |entry|
-        path = "#{dir}/#{entry}"
+        path = "#{dir}#{File::SEPARATOR}#{entry}"
+
         size += if File.directory? path
                   calculate_dir_size(path)
                 else
                   File.size(path)
                 end
       end
-
       size
     end
 
     def get_entries(dir)
       Dir.entries(dir).select { |value| value != '.' && value != '..' }
     end
 
-    def calculate_remote_excludes_size(user, host, dirs)
-      return 0 if dirs.empty?
+    def calculate_remote_excludes_size(user, host, excludes)
+      return 0 if excludes.empty?
+
+      exclude_options = (excludes).map { |exclude| "--exclude=#{exclude}" }.join(' ')
 
       Net::SSH.start(host, user[:username], password: user[:password], verify_host_key: :never) do |ssh|
-        ssh.exec!('shopt -s dotglob; du -sb *')
-           .scan(/(\d+)\s+(\S+)/)
-           .select { |_, path| dirs.include? path }
-           .map { |size, _| size.to_i }
-           .sum
+        ssh.exec!("expr $(du -sb . | cut -f1 ) - $(du -sb . #{exclude_options} | cut -f1)").to_i
       end
     end
   end

spec/configTest/bootstrapCommands/.deploy-now/config.yaml

@@ -0,0 +1,6 @@
+version: 1.0
+deploy:
+  bootstrap:
+    remote-commands:
+      - ls -al
+      - echo "test"

spec/configTest/bootstrapExcludes/.deploy-now/config.yaml

@@ -0,0 +1,6 @@
+version: 1.0
+deploy:
+  bootstrap:
+    excludes:
+      - var
+      - storage/database.sqlite

spec/configTest/bootstrapForce/.deploy-now/config.yaml

@@ -0,0 +1,13 @@
+version: 1.0
+deploy:
+  force: bootstrap
+  bootstrap:
+    excludes:
+      - var/bootstrap
+    remote-commands:
+      - echo "bootstrap"
+  recurring:
+    excludes:
+      - var/recurring
+    remote-commands:
+      - echo "recurring"

spec/configTest/bootstrapNothing/.deploy-now/config.yaml

@@ -0,0 +1,6 @@
+version: 1.0
+deploy:
+  recurring:
+    excludes:
+      - var
+      - storage/database.sqlite

spec/configTest/invalidYaml/.deploy-now/config.yaml

@@ -0,0 +1 @@
+test: 'Some other Text File

spec/configTest/missingDeploy/.deploy-now/config.yaml

@@ -0,0 +1 @@
+version: 1.0

spec/configTest/missingVersion/.deploy-now/config.yaml

@@ -0,0 +1,2 @@
+deploy:
+  force: true

spec/configTest/noConfig/.empty

@@ -0,0 +1,6 @@
+version: 1.0
+deploy:
+  recurring:
+    remote-commands:
+      - ls -al
+      - echo "test"

spec/configTest/recurringCommands/.deploy-now/config.yaml

@@ -0,0 +1,6 @@
+version: 1.0
+deploy:
+  recurring:
+    excludes:
+      - var
+      - storage/database.sqlite

spec/configTest/recurringExcludes/.deploy-now/config.yaml

@@ -0,0 +1,13 @@
+version: 1.0
+deploy:
+  force: recurring
+  bootstrap:
+    excludes:
+      - var/bootstrap
+    remote-commands:
+      - echo "bootstrap"
+  recurring:
+    excludes:
+      - var/recurring
+    remote-commands:
+      - echo "recurring"

spec/configTest/recurringForce/.deploy-now/config.yaml

@@ -0,0 +1,6 @@
+version: 1.0
+deploy:
+  bootstrap:
+    excludes:
+      - var
+      - storage/database.sqlite

spec/configTest/recurringNothing/.deploy-now/config.yaml

@@ -0,0 +1,3 @@
+version: 1.0
+deploy:
+  force: true

spec/configTest/wrongForce/.deploy-now/config.yaml

@@ -0,0 +1 @@
+version: 0.1