redmine-installer 1.0.7 → 2.0.0.rc1

data/lib/redmine-installer/version.rb

@@ -1,5 +1,3 @@
-module Redmine
-  module Installer
-    VERSION = '1.0.7'
-  end
+module RedmineInstaller
+  VERSION = '2.0.0.rc1'
 end

data/lib/redmine-installer.rb

@@ -1,62 +1,75 @@
-module Redmine
-  module Installer
-    autoload :CLI,          'redmine-installer/cli'
-    autoload :Task,         'redmine-installer/task'
-    autoload :Utils,        'redmine-installer/utils'
-    autoload :Step,         'redmine-installer/step'
-    autoload :ConfigParams, 'redmine-installer/config_param'
-    autoload :Plugin,       'redmine-installer/plugin'
-    autoload :Helper,       'redmine-installer/helper'
-    autoload :Command,      'redmine-installer/command'
-    autoload :Exec,         'redmine-installer/exec'
-    autoload :Profile,      'redmine-installer/profile'
-    autoload :Git,          'redmine-installer/git'
-
-    # Root of the gem
-    def self.root_path
-      @root_path ||= File.expand_path('..', File.dirname(__FILE__))
-    end
-
-    # Path to locales dir
-    def self.locales_path
-      @locales_path ||= File.join(root_path, 'lib', 'redmine-installer', 'locales')
-    end
-
-    # Locales for I18n
-    def self.locales
-      @locales ||= Dir.glob(File.join(locales_path, '*.yml'))
-    end
-
-    # Default configurations fo I18n gem
-    def self.set_i18n
-      I18n.enforce_available_locales = false
-      I18n.load_path = Redmine::Installer.locales
-      I18n.locale = :en
-      I18n.default_locale = :en
-    end
-
-    def self.print_logo
-      $stdout.puts <<-PRINT
-                  __      _
-      _______ ___/ /_ _  (_)__  ___
-     / __/ -_) _  /  ' \\/ / _ \\/ -_)
-    /_/  \\__/\\_,_/_/_/_/_/_//_/\\__/
-
-
-    #{I18n.translate(:powered_by)}
-
-      PRINT
-    end
+require 'fileutils'
+require 'tempfile'
+require 'bundler'
+require 'ostruct'
+require 'tmpdir'
+require 'pastel'
+require 'yaml'
+require 'zip'
 
+require 'tty-progressbar'
+require 'tty-spinner'
+require 'tty-prompt'
+
+module RedmineInstaller
+  autoload :CLI,           'redmine-installer/cli'
+  autoload :Task,          'redmine-installer/task'
+  autoload :Install,       'redmine-installer/install'
+  autoload :Utils,         'redmine-installer/utils'
+  autoload :Logger,        'redmine-installer/logger'
+  autoload :TaskModule,    'redmine-installer/task_module'
+  autoload :Environment,   'redmine-installer/environment'
+  autoload :Redmine,       'redmine-installer/redmine'
+  autoload :Package,       'redmine-installer/package'
+  autoload :Database,      'redmine-installer/database'
+  autoload :Configuration, 'redmine-installer/configuration'
+  autoload :Upgrade,       'redmine-installer/upgrade'
+  autoload :Command,       'redmine-installer/command'
+  autoload :Profile,       'redmine-installer/profile'
+  autoload :Backup,        'redmine-installer/backup'
+
+  # Settings
+  MIN_SUPPORTED_RUBY = '2.1.0'
+
+  def self.logger
+    @logger ||= RedmineInstaller::Logger.new
+  end
+
+  def self.prompt
+    @prompt ||= TTY::Prompt.new
+  end
+
+  def self.pastel
+    @pastel ||= Pastel.new
+  end
+
+  def self.print_logo
+    puts <<-PRINT
+                __      _
+    _______ ___/ /_ _  (_)__  ___
+   / __/ -_) _  /  ' \\/ / _ \\/ -_)
+  /_/  \\__/\\_,_/_/_/_/_/_//_/\\__/
+
+
+  Powered by EasyRedmine
+
+    PRINT
   end
 end
 
+
 # Requirements
-require 'i18n'
 require 'redmine-installer/version'
-require 'redmine-installer/error'
-require 'redmine-installer/ext/string'
-require 'redmine-installer/ext/module'
-require 'redmine-installer/install'
-require 'redmine-installer/upgrade'
-require 'redmine-installer/backup'
+require 'redmine-installer/errors'
+
+# Patches
+require 'redmine-installer/patches/ruby'
+require 'redmine-installer/patches/tty'
+
+if ENV['REDMINE_INSTALLER_SPEC']
+  require 'redmine-installer/spec/spec'
+end
+
+Kernel.at_exit do
+  RedmineInstaller.logger.finish
+end

data/redmine-installer.gemspec

@@ -1,32 +1,33 @@
 # coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'redmine-installer/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "redmine-installer"
-  spec.version       = Redmine::Installer::VERSION
-  spec.authors       = ["Ondřej Moravčík"]
-  spec.email         = ["moravcik.ondrej@gmail.com"]
-  spec.summary       = %q{Easy way how install/upgrade redmine or plugin.}
-  spec.description   = %q{Redmine-installer can fully install/upgrade redmine and will
-                       generate template for different server. All actions can be saved
-                       for further use.}
-  spec.homepage      = "https://github.com/easyredmine/redmine-installer"
-  spec.license       = "MIT"
+  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'
 
   spec.files         = `git ls-files -z`.split("\x0")
   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.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.1.0'
 
-  spec.add_runtime_dependency "ansi"
-  spec.add_runtime_dependency "gli"
-  spec.add_runtime_dependency "i18n"
-  spec.add_runtime_dependency "notifier"
-  spec.add_runtime_dependency "ruby-progressbar"
-  spec.add_runtime_dependency "rubyzip"
+  spec.add_runtime_dependency 'commander'
+  spec.add_runtime_dependency 'tty-prompt', '~> 0.10.0'
+  spec.add_runtime_dependency 'tty-spinner', '~> 0.4.1'
+  spec.add_runtime_dependency 'tty-progressbar', '~> 0.10.1'
+  spec.add_runtime_dependency 'rubyzip'
+  spec.add_runtime_dependency 'pastel'
 
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake'
 end

data/spec/custom_matchers.rb

@@ -0,0 +1,21 @@
+require 'rspec/expectations'
+
+RSpec::Matchers.define :have_output do |text|
+  match do |process|
+    expect(process.get(text)).to include(text)
+  end
+
+  failure_message do |process|
+    "expected that \"#{process.last_get_return}\" would contains: #{text}"
+  end
+end
+
+RSpec::Matchers.define :have_output_in do |text, second|
+  match do |process|
+    expect(process.get(text, max_wait: second)).to include(text)
+  end
+
+  failure_message do |process|
+    "expected that \"#{process.last_get_return}\" would contains: #{text} in #{second}s"
+  end
+end

data/spec/installer_helper.rb

@@ -0,0 +1,107 @@
+module InstallerHelper
+
+  def db_username
+    ENV['SPEC_DB_USERNAME'].to_s
+  end
+
+  def db_password
+    ENV['SPEC_DB_PASSWORD'].to_s
+  end
+
+  def expected_output(text)
+    expect(@process).to have_output(text)
+  end
+
+  def expected_output_in(text, max_wait)
+    expect(@process).to have_output_in(text, max_wait)
+  end
+
+  def write(text)
+    @process.write(text + "\n")
+  end
+
+  # Be carefull - this could have later unpredictable consequences on stdin
+  def select_choice
+    @process.write(' ')
+    # @process.write("\r")
+    # @process.write("\r\n")
+  end
+
+  def go_down
+    write(TTY::Prompt::Reader::Codes::KEY_DOWN)
+  end
+
+  def expected_successful_configuration
+    expected_output('Creating database configuration')
+    expected_output('What database do you want use?')
+    expected_output('‣ MySQL')
+
+    write(TTY::Prompt::Reader::Codes::KEY_DOWN)
+    expected_output('‣ PostgreSQL')
+    select_choice
+
+    expected_output('Database:')
+    write('test')
+
+    expected_output('Host: (localhost)')
+    write('')
+
+    expected_output('Username:')
+    write(db_username)
+
+    expected_output('Password:')
+    write(db_password)
+
+    expected_output('Encoding: (utf8)')
+    write('')
+
+    expected_output('Port: (5432)')
+    write('')
+
+    expected_output('Creating email configuration')
+    expected_output('Which service to use for email sending?')
+    expected_output('‣ Nothing')
+    select_choice
+  end
+
+  def expected_successful_installation_or_upgrade(db_creating: false)
+    expected_output_in('--> Bundle install', 50)
+    expected_output_in('--> Database creating', 50) if db_creating
+    expected_output_in('--> Database migrating', 50)
+    expected_output_in('--> Plugins migration', 50)
+    expected_output_in('--> Generating secret token', 50)
+
+    expected_output('Cleaning root ... OK')
+    expected_output('Moving redmine to target directory ... OK')
+    expected_output('Cleanning up ... OK')
+    expected_output('Moving installer log ... OK')
+  end
+
+  def expected_successful_installation
+    expected_output('Redmine installing')
+    expected_successful_installation_or_upgrade(db_creating: true)
+    expected_output('Redmine was installed')
+  end
+
+  def expected_successful_upgrade
+    expected_output('Redmine upgrading')
+    expected_successful_installation_or_upgrade
+    expected_output('Redmine was upgraded')
+
+    expected_output('Do you want save steps for further use?')
+    write('n')
+  end
+
+  def expected_redmine_version(version)
+    Dir.chdir(@redmine_root) do
+      out = `rails runner "puts Redmine::VERSION.to_s"`
+      expect($?.success?).to be_truthy
+      expect(out).to include(version)
+    end
+  end
+
+  def wait_for_stdin_buffer
+    sleep 0.5
+  end
+
+end

data/spec/installer_process.rb

@@ -0,0 +1,82 @@
+require 'childprocess'
+
+class InstallerProcess
+
+  attr_reader :stdout, :last_get_return
+
+  def initialize(command, *args)
+    tempfile_out = File.open('redmine-installer-out', 'w')
+    tempfile_err = File.open('redmine-installer-err', 'w')
+
+    tempfile_out.sync = true
+    tempfile_err.sync = true
+
+    @process = ChildProcess.build('bin/redmine', command, *args.flatten.compact)
+    @process.io.stdout = tempfile_out
+    @process.io.stderr = tempfile_err
+    @process.environment['REDMINE_INSTALLER_SPEC'] = '1'
+    @process.environment['REDMINE_INSTALLER_LOGFILE'] = File.expand_path(File.join(File.dirname(__FILE__), '..', 'log.log'))
+    @process.duplex = true
+    @process.detach = true
+
+    # Because of file description is shared with redmine installer
+    # so changing posiiotn has effect fot both processes
+    @stdout = File.open(tempfile_out.path)
+
+    @last_get_return = ''
+    @buffer = ''
+    @seek = 0
+  end
+
+  def run
+    start
+    yield
+  ensure
+    stop
+  end
+
+  def start
+    @process.start
+  end
+
+  def stop
+    @process.stop
+  end
+
+  def write(text)
+    @process.io.stdin << text
+
+    # @process.io.stdin.puts(text)
+    # @process.io.stdin.flush
+
+    # @process.io.stdin.syswrite(text + "\n")
+    # @process.io.stdin.flush
+
+    # @process.io.stdin.write_nonblock(text + "\n")
+  end
+
+  def get(*args)
+    @last_get_return = _get(*args)
+  end
+
+  private
+
+    # max_wait in s
+    def _get(text, max_wait: 10)
+      wait_to = Time.now + max_wait
+      while Time.now < wait_to
+        @buffer << @stdout.read
+        index = @buffer.rindex(text)
+
+        if index
+          break
+          # return @buffer.slice!(0, index+text.size)
+        else
+          sleep 0.5
+        end
+      end
+
+      @buffer
+    end
+
+end

data/spec/lib/backup_restore_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+DATABASE_DUMP = File.join(Dir.tmpdir, 'redmine_installer_database_backup.sql')
+
+RSpec.describe 'RedmineInstaller backup / restore', order: :defined do
+
+  let(:project_count) { 5 }
+
+  it 'create backup', :install_first, command: 'backup' do
+    # First ensure `project_count` project
+    Dir.chdir(@redmine_root) do
+      out = `rails runner "
+        Project.delete_all
+
+        #{project_count}.times do |i|
+          p = Project.new
+          p.name = 'Test ' + i.to_s
+          p.identifier = 'test_' + i.to_s
+          p.save(validate: false)
+        end
+
+        puts Project.count
+      "`
+
+      expect($?.success?).to be_truthy
+      expect(out.to_i).to eq(project_count)
+    end
+
+    # Backup database
+    expected_output('Path to redmine root:')
+    write(@redmine_root)
+    expected_output('Data backup')
+    go_down
+    expected_output('‣ Only database')
+    select_choice
+    expected_output('Where to save backup:')
+    write(@backup_dir)
+    expected_output('Database backuping')
+    expected_output('Database backed up')
+
+    # Ensure 0 project (database is shared with all tests)
+    Dir.chdir(@redmine_root) do
+      out = `rails runner "
+        Project.delete_all
+        puts Project.count
+      "`
+
+      expect($?.success?).to be_truthy
+      expect(out.to_i).to eq(0)
+    end
+
+    # Save backup (after test end - all backup will be deleted)
+    dump = Dir.glob(File.join(@backup_dir, '*', '*')).last
+    expect(dump).to end_with('test.sql')
+
+    FileUtils.rm_f(DATABASE_DUMP)
+    FileUtils.cp(dump, DATABASE_DUMP)
+  end
+
+  it 'restore', command: 'install', args: [package_v310, '--database-dump', DATABASE_DUMP] do
+    expected_output('Path to redmine root:')
+    write(@redmine_root)
+
+    expected_successful_configuration
+
+    expected_output('Database dump will be loaded.')
+    expected_output('‣ Skip dump loading')
+
+    go_down
+    expected_output('‣ I am aware of this.')
+    select_choice
+
+    expected_output_in('Redmine was installed', 500)
+
+    Dir.chdir(@redmine_root) do
+      out = `rails runner "puts Project.count"`
+      expect(out.to_i).to eq(project_count)
+    end
+  end
+
+end