redmine-installer 2.3.2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 562050e0ea7eb2b7d4539fd4e19ee1691de18e861a07ce25e052ef98eee70f1f
-  data.tar.gz: e5932bf820f693d20ed1987434b63d9d85a7d32b4e7ded16d03d880e0ef46b87
+  metadata.gz: 99303f819bcacb4a242b3a5020028845867655202a15cb3299b3253a9efdbcd0
+  data.tar.gz: 4cc1c31ec92f8bdb812af49b1d47744fc079ca91252f7acfa4c3dd35a2b61471
 SHA512:
-  metadata.gz: b6064513f5c53b327985ac76fa23fc764fe2fdde289c6cc4cfd8355947d48085d1c6a029ec800b164581c4f022e9e0daf6985da31846c0c28006c114ebdec0ad
-  data.tar.gz: 28fec9b468aeb51ac9ab52ee237f2e25e63a9c9f70dd1ef5ca77f15a4adf118c773a8d0e3115db905d175b1ff386f8527dc654146229ec046674b40877feb13a
+  metadata.gz: '09961ded47146661478d1263192c2c3ff0d72f1bfbdbb320ac4b3b77a6c41e63b586cf750faa2be4b38774f339c1691dc1ca7e902a91ba73770aed6cfe012102'
+  data.tar.gz: dee77d5369431c9df0d0425ba078e266cc5826c8ed101ca36711c05ae09c333088fe621acf48043bbf0e4bd93504966e2b2d17e9ac30c5b706b17709ea34b413

data/.dockerignore

@@ -0,0 +1,8 @@
+/.idea
+/vendor
+/.bundle
+/tmp
+/log.log
+/redmine-installer-err
+/redmine-installer-out
+/redmine

data/.gitignore

@@ -1,11 +1,11 @@
 /.gemtags
 /.tags
+/.idea
 *.gem
 *.rbc
 .bundle
 .config
 .yardoc
-Gemfile.lock
 InstalledFiles
 _yardoc
 coverage
@@ -27,4 +27,4 @@ test/*
 /redmine-installer-err
 /redmine-installer-out
 /redmine
-/gems.locked
+/vendor/*

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+
+## [3.0.0] - 2022-12-13
+### Added
+- docker-compose for testing [#37](https://github.com/easyredmine/redmine-installer/pull/37)
+- .github workflow for CI
+- `env_check` for test server environment
+### Fixed
+- ruby 3.x support [#35](https://github.com/easyredmine/redmine-installer/pull/35)
+- Psych aliases while parsing `database.yml`
+### Changed
+- required ruby version = 3.1.2 [#36](https://github.com/easyredmine/redmine-installer/pull/36)
+- required redmine version = 5.0.4+ [#36](https://github.com/easyredmine/redmine-installer/pull/36)
+
+## [2.4.0] - 2022-09-07
+### Added
+- allow the administrator to manually empty the root directory [#33](https://github.com/easyredmine/redmine-installer/pull/33)
+
 ## [2.3.0.beta] - 2019-06-10
 
 ### Added

data/Dockerfile

@@ -0,0 +1,13 @@
+FROM ruby:3.1.2-bullseye
+LABEL org.opencontainers.image.authors="support@easysoftware.com"
+RUN apt-get update && apt-get -y install lsb-release wget curl vim
+RUN wget https://repo.percona.com/apt/percona-release_latest.$(lsb_release -sc)_all.deb -O percona-release_latest_all.deb &&\
+    dpkg -i percona-release_latest_all.deb &&\
+    percona-release setup ps80 &&\
+    apt-get update && apt-get install -y libperconaserverclient21-dev percona-server-client
+WORKDIR /gem
+VOLUME ["/gem/vendor/"]
+COPY . ./
+RUN bundle config set deployment 'true'
+RUN bundle install
+CMD ["bundle", "exec", "rspec"]

data/README.md

@@ -1,48 +1,46 @@
 # Redmine installer
 
-Easy way hot to install/upgrade Redmine, EasyRedmine or EasyProject.
+Easy way hot to install/upgrade Redmine, Easy Redmine or Easy Project.
 
 Please do not run installer on background. It may happen that process will be paused by some event. For example database may require enter password during backuping database.
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-```
-gem 'redmine-installer'
-```
+> ⚠️ Current version support only **ruby 3.1.2**, **Percona 8** as DB server and **redmine 5.0.3+**
 
-And then execute:
+Version **v3.x** is designed primarily for work with Easy Redmine / Easy Project **v12.x**.
 
-```
-$ bundle
-```
-
-Or install it yourself as:
+## Installation
 
-```
-$ gem install redmine-installer
+Install tool into your server environment by:
+```bash
+gem install redmine-installer
 ```
 
+> ⚠️ Version `v3.0.0` and higher require ruby 3.1.2 and its designed for Easy Redmine / Easy Project v12 and Redmine 5.0.3+ respectively.
 ## Examples
 
 To display global documentation for installer.
 
-```
+```bash
 redmine help
 ```
 
 You can also check more detailed documentation for each command.
 
-```
+```bash
 redmine help [COMMAND]
 ```
 
+### Environment checker
+Check your server environment if it meets our requirements for best Easy Redmine experience.
+```bash
+redmine env_check
+```
+
 ### Installing
 
 Create new project on empty directory. All argument are optional. Directory should be empty because installer delete all content for ensuring correct installation. If directory does not exist, current user must have privileges to create it.
 
-```
+```bash
 redmine help install
 redmine install [PACKAGE PATH or URL] [REDMINE_ROOT] [options]
 ```
@@ -129,3 +127,13 @@ Examples:
 
 Restore database db.dump for redmine in /srv/redmine
 - `redmine restore-db db.dump /srv/redmine`
+
+## Testing
+
+Just run:
+```bash
+docker compose up --build --exit-code-from redmine_installer
+```
+This will build docker image from current code and run tests against _percona8_.
+
+note: Require Docker of course.

data/gems.locked

@@ -0,0 +1,76 @@
+PATH
+  remote: .
+  specs:
+    redmine-installer (3.0.0)
+      bundler (>= 2.3.7)
+      commander
+      pastel (~> 0.8.0)
+      rubyzip
+      tty-progressbar (~> 0.18.2)
+      tty-prompt (~> 0.23.1)
+      tty-spinner (~> 0.8.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    childprocess (4.1.0)
+    coderay (1.1.3)
+    commander (4.6.0)
+      highline (~> 2.0.0)
+    diff-lcs (1.5.0)
+    highline (2.0.3)
+    method_source (1.0.0)
+    pastel (0.8.0)
+      tty-color (~> 0.5)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (13.0.6)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.1)
+    rubyzip (2.3.2)
+    strings-ansi (0.2.0)
+    tty-color (0.6.0)
+    tty-cursor (0.7.1)
+    tty-progressbar (0.18.2)
+      strings-ansi (~> 0.2)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.8)
+      unicode-display_width (>= 1.6, < 3.0)
+    tty-prompt (0.23.1)
+      pastel (~> 0.8)
+      tty-reader (~> 0.8)
+    tty-reader (0.9.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.8)
+      wisper (~> 2.0)
+    tty-screen (0.8.1)
+    tty-spinner (0.8.0)
+      tty-cursor (>= 0.5.0)
+    unicode-display_width (2.3.0)
+    wisper (2.0.1)
+
+PLATFORMS
+  x86_64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  childprocess (~> 4.1.0)
+  pry
+  rake
+  redmine-installer!
+  rspec (~> 3.11.0)
+
+BUNDLED WITH
+   2.3.22

data/gems.rb

@@ -10,3 +10,4 @@ gemspec
 #     gem 'childprocess'
 #   end
 # end
+gem "pry", group: [:development, :test]

data/lib/redmine-installer/cli.rb

@@ -17,7 +17,7 @@ module RedmineInstaller
       program :version, RedmineInstaller::VERSION
       program :description, 'Easy way how install/upgrade redmine or plugin.'
 
-      global_option('-d', '--debug', 'Logging message to stdout'){ $DEBUG = true }
+      global_option('-d', '--debug', 'Logging message to stdout') { $DEBUG = true }
       global_option('-s', '--silent', 'Be less version in output') { $SILENT_MODE = true }
       global_option('-e', '--env', 'For backward compatibility. Production is now always use.')
       global_option('--run-easycheck', 'Run easycheck.sh from https://github.com/easyredmine/easy_server_requirements_check') do
@@ -26,6 +26,27 @@ module RedmineInstaller
 
       default_command :help
 
+      # --- Environment checker -----------------------------------------------
+      # This command is very specify to Easy Redmine
+      command :env_check do |c|
+        c.syntax = 'env_check'
+        c.description = <<~DESC
+          Check current environment if it meet requirements for Easy Redmine / Easy Project.
+
+          See: https://www.easyredmine.com/documentation-of-easy-redmine/article/hardware-and-software-requirements-for-the-server-solution
+        DESC
+        c.action do |_args|
+          task = RedmineInstaller::Task.new
+          RedmineInstaller::Environment.new(task).check
+          puts task.pastel.green "OK"
+        rescue StandardError => e
+          puts task.pastel.red e.message
+
+          puts "\n\nCheck: https://www.easyredmine.com/documentation-of-easy-redmine/article/hardware-and-software-requirements-for-the-server-solution#Software%20requirements for more info."
+        end
+      end
+
+      alias_command :check, :env_check
 
       # --- Install -----------------------------------------------------------
       command :install do |c|
@@ -48,12 +69,11 @@ module RedmineInstaller
         c.action do |args, options|
           options.default(enable_user_root: false)
 
-          RedmineInstaller::Install.new(args[0], args[1], options.__hash__).run
+          RedmineInstaller::Install.new(args[0], args[1], **options.__hash__).run
         end
       end
       alias_command :i, :install
 
-
       # --- Upgrade -----------------------------------------------------------
       command :upgrade do |c|
         c.syntax = 'upgrade [PACKAGE] [REDMINE_ROOT] [options]'
@@ -77,12 +97,11 @@ module RedmineInstaller
         c.action do |args, options|
           options.default(enable_user_root: false, copy_files_with_symlink: false)
 
-          RedmineInstaller::Upgrade.new(args[0], args[1], options.__hash__).run
+          RedmineInstaller::Upgrade.new(args[0], args[1], **options.__hash__).run
         end
       end
       alias_command :u, :upgrade
 
-
       # --- Verify log --------------------------------------------------------
       command :'verify-log' do |c|
         c.syntax = 'verify-log LOGFILE'
@@ -96,7 +115,6 @@ module RedmineInstaller
         end
       end
 
-
       # --- Backup ------------------------------------------------------------
       command :backup do |c|
         c.syntax = 'backup [REDMINE_ROOT]'
@@ -105,13 +123,16 @@ module RedmineInstaller
         c.example 'Backup',
                   'redmine backup /srv/redmine'
 
-        c.action do |args, _|
+        c.option '--enable-user-root', 'Skip root as root validation' # just for consistency
+
+        c.action do |args, options|
+          options.default(enable_user_root: false)
+
           RedmineInstaller::Backup.new(args[0]).run
         end
       end
       alias_command :b, :backup
 
-
       # --- Restore db --------------------------------------------------------
       command :'restore-db' do |c|
         c.syntax = 'restore-db DATABASE_DUMP [REDMINE_ROOT] [options]'
@@ -129,7 +150,6 @@ module RedmineInstaller
         end
       end
 
-
       run!
     end
 
@@ -137,7 +157,7 @@ module RedmineInstaller
     def parse_keep_options(values)
       proxy_options = Commander::Runner.instance.active_command.proxy_options
 
-      saved = proxy_options.find{|switch, _| switch == :keep }
+      saved = proxy_options.find { |switch, _| switch == :keep }
       if saved
         saved[1].concat(values)
       else

data/lib/redmine-installer/command.rb

@@ -13,7 +13,7 @@ module RedmineInstaller
     end
 
     def run
-      Bundler.with_clean_env do
+      Bundler.with_unbundled_env do
         run!
       end
     end

data/lib/redmine-installer/database.rb

@@ -21,7 +21,7 @@ module RedmineInstaller
         error "Database configuration files does not exist on #{redmine.root}."
       end
 
-      definitions = YAML.load_file(redmine.database_yml_path)
+      definitions = YAML.load_file(redmine.database_yml_path, aliases: true)
       definition = definitions['production']
 
       unless definition.is_a?(Hash)
@@ -60,7 +60,7 @@ module RedmineInstaller
         @host = prompt.ask('Host:', default: 'localhost', required: true)
         @username = prompt.ask('Username:', default: '')
         @password = prompt.mask('Password:', default: '')
-        @encoding = prompt.ask('Encoding:', default: 'utf8', required: true)
+        @encoding = prompt.ask('Encoding:', default: 'utf8mb4', required: true)
         @port = prompt.ask('Port:', default: default_port, convert: lambda(&:to_i), required: true)
       end
 

data/lib/redmine-installer/easycheck.rb

@@ -7,7 +7,7 @@ module RedmineInstaller
     EASYCHECK_SH = 'https://raw.githubusercontent.com/easyredmine/easy_server_requirements_check/master/easycheck.sh'
 
     def self.run
-      Bundler.with_clean_env do
+      Bundler.with_unbundled_env do
         if Kernel.system('which', 'wget')
           Open3.pipeline(['wget', EASYCHECK_SH, '-O', '-', '--quiet'], 'bash')
 

data/lib/redmine-installer/environment.rb

@@ -7,15 +7,27 @@ module RedmineInstaller
       end
 
       if Gem::Version.new(RUBY_VERSION) < Gem::Version.new(RedmineInstaller::MIN_SUPPORTED_RUBY)
-        error "You are using unsupported ruby. Please install at least #{RedmineInstaller::MIN_SUPPORTED_RUBY}."
+        error "You are using unsupported ruby. Please install ruby v#{RedmineInstaller::MIN_SUPPORTED_RUBY}."
       end
 
-      logger.info 'Environemnt checked'
+      if mysql_version =~ /^mysql\s+Ver\s(8\.\d)/
+        puts pastel.on_red 'WARNING: It seems you are using MySQL 8.x, but ER / EP supported only Percona 8 db.'
+      else
+        error 'Only Percona 8.x db server is supported!.'
+      end
+
+      logger.info 'Environment checked'
     end
 
     def user_is_root?
       Process.euid == 0
     end
 
+    def mysql_version
+      `mysql --version`
+    rescue StandardError
+      ""
+    end
+
   end
 end

data/lib/redmine-installer/package.rb

@@ -86,23 +86,23 @@ module RedmineInstaller
 
       def valid_url?(string)
         uri = URI.parse(string)
-        ['http', 'https'].include?(uri.scheme)
+        %w[http https].include?(uri.scheme)
       rescue URI::BadURIError, URI::InvalidURIError
         false
       end
 
       def download_redmine_version(version)
-        url = "http://www.redmine.org/releases/redmine-#{version}.zip"
+        url = "https://www.redmine.org/releases/redmine-#{version}.zip"
         download_from_url(url)
       end
 
       def download_from_url(url)
         uri = URI.parse(url)
 
-        @temp_file = Tempfile.new(['redmine', '.zip'])
+        @temp_file = Tempfile.new(%w[redmine .zip])
         @temp_file.binmode
 
-        Net::HTTP.start(uri.host, uri.port) do |http|
+        Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
           head = http.request_head(uri)
 
           unless head.is_a?(Net::HTTPSuccess)

data/lib/redmine-installer/package_config.rb

@@ -66,7 +66,7 @@ module RedmineInstaller
         config_file = File.join(@redmine.root, CONFIG_DIR, 'redmine-installer.yaml')
 
         if File.exist?(config_file)
-          YAML.load_file(config_file)
+          YAML.load_file(config_file, aliases: true)
         else
           {}
         end

data/lib/redmine-installer/profile.rb

@@ -6,7 +6,7 @@ module RedmineInstaller
     PROFILES_FILE = File.join(Dir.home, '.redmine-installer-profiles.yml')
 
     def self.get!(profile_id)
-      data = YAML.load_file(PROFILES_FILE) rescue nil
+      data = YAML.load_file(PROFILES_FILE, aliases: true) rescue nil
 
       if data.is_a?(Hash) && data.has_key?(profile_id)
         Profile.new(profile_id, data[profile_id])
@@ -25,7 +25,7 @@ module RedmineInstaller
     def save
       FileUtils.touch(PROFILES_FILE)
 
-      all_data = YAML.load_file(PROFILES_FILE)
+      all_data = YAML.load_file(PROFILES_FILE, aliases: true)
       all_data = {} unless all_data.is_a?(Hash)
 
       @id ||= all_data.keys.last.to_i + 1

data/lib/redmine-installer/redmine.rb

@@ -1,4 +1,5 @@
 require 'find'
+require 'io/console'
 
 module RedmineInstaller
   class Redmine < TaskModule
@@ -279,7 +280,17 @@ module RedmineInstaller
           next if entry == '.' || entry == '..'
           next if entry == FILES_DIR && task.options.copy_files_with_symlink
 
-          FileUtils.remove_entry_secure(entry)
+          begin
+            FileUtils.remove_entry_secure(entry)
+          rescue
+            if task.options.copy_files_with_symlink
+              print_title('Cannot automatically empty ' + root + '. Please manually empty this directory (except for ' + root + '/' + FILES_DIR + ') and then hit any key to continue...')
+            else
+              print_title('Cannot automatically empty ' + root + '. Please manually empty this directory and then hit any key to continue...')
+            end
+            STDIN.getch
+            break
+          end
         end
       end
 
@@ -294,7 +305,7 @@ module RedmineInstaller
         bundle_index = File.join(Dir.pwd, '.bundle/plugin/index')
 
         if File.exist?(bundle_index)
-          index = YAML.load_file(bundle_index)
+          index = YAML.load_file(bundle_index, aliases: true)
 
           # { load_paths: { PLUGIN_NAME: *PATHS } }
           #

data/lib/redmine-installer/version.rb

@@ -1,3 +1,5 @@
 module RedmineInstaller
-  VERSION = '2.3.2'
+
+  VERSION = '3.0.0'
+
 end

data/lib/redmine-installer.rb

@@ -32,7 +32,7 @@ module RedmineInstaller
   autoload :Easycheck,     'redmine-installer/easycheck'
 
   # Settings
-  MIN_SUPPORTED_RUBY = '2.3.0'
+  MIN_SUPPORTED_RUBY = '3.1.2'
 
   def self.logger
     @logger ||= RedmineInstaller::Logger.new

data/redmine-installer.gemspec

@@ -1,37 +1,35 @@
-# coding: utf-8
-
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require 'redmine-installer/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = 'redmine-installer'
-  spec.version       = RedmineInstaller::VERSION
-  spec.authors       = ['Ondřej Moravčík']
-  spec.email         = ['moravcik.ondrej@gmail.com']
-  spec.summary       = %q{Easy way how install/upgrade Redmine, EasyRedmine or EasyProject.}
-  spec.description   = %q{}
-  spec.homepage      = 'https://github.com/easyredmine/redmine-installer'
-  spec.license       = 'MIT'
-
-  files = `git ls-files -z`.split("\x0")
-  files.delete_if {|f| f.start_with?('spec/packages/') }
-
-  spec.files         = files
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.name = 'redmine-installer'
+  spec.version = RedmineInstaller::VERSION
+  spec.authors = ['Ondřej Moravčík', 'Easy Software Ltd.']
+  spec.email = ['developers@easysoftware.com']
+  spec.summary = %q{Easy way how install/upgrade Redmine, EasyRedmine or EasyProject.}
+  spec.description = %q{}
+  spec.homepage = 'https://github.com/easyredmine/redmine-installer'
+  spec.license = 'MIT'
+
+  files = `git ls-files -z`.split("\x0") - Dir.glob("{spec/**/*,docker-compose.yml,.github/**/*}")
+  spec.files = files
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.3.0'
+  spec.required_ruby_version = '3.1.2'
 
+  spec.add_runtime_dependency 'bundler', '>= 2.3.7'
   spec.add_runtime_dependency 'commander'
+  spec.add_runtime_dependency 'pastel', '~> 0.8.0'
   spec.add_runtime_dependency 'rubyzip'
-  spec.add_runtime_dependency 'bundler', '>= 1.16'
-  spec.add_runtime_dependency 'pastel', '~> 0.7.2'
-  spec.add_runtime_dependency 'tty-prompt', '~> 0.16.1'
+  spec.add_runtime_dependency 'tty-progressbar', '~> 0.18.2'
+  spec.add_runtime_dependency 'tty-prompt', '~> 0.23.1'
   spec.add_runtime_dependency 'tty-spinner', '~> 0.8.0'
-  spec.add_runtime_dependency 'tty-progressbar', '~> 0.15.0'
 
+  spec.add_development_dependency 'childprocess', '~> 4.1.0'
   spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3.11.0'
 end