redmine-installer 1.0.7 → 2.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c8e6a6e259f87926c7534b63c8bc6219878c441d
-  data.tar.gz: 31079d8b9948fe9623254a566f3569ef1170b616
+  metadata.gz: 22ee60b5ea969b4287d629fd536e57d59ef15674
+  data.tar.gz: aa29dc2561c8f9feaecd3ca005c443dbe4f32b10
 SHA512:
-  metadata.gz: bca25f6166145d3424b376b927c8b4b2267954fde33772963c7e7326ea19939c44c85695a6c25be81ef0ed030049411f6773bb917a85126db37d44021f9983b2
-  data.tar.gz: ce9962bdad632a74d36421d3f1e14e0f64d5d3862343035306d2d2bbe5d459fb8428b99b738212396acba550c97f133cdafc7e032655a2ebc4e16cdc8aff7a48
+  metadata.gz: 833e0b691d62ac3c0016d41958247ee1a58995fc8ee720cf8d1cfa31d6bfba3a6f6b75032bb51cb8bb5df1a6e73117f94e837a11bd8e8067401a36fd048d6464
+  data.tar.gz: 5e10b97774c463b927f87230fedfaa10070392cfccc8661f520563e3ba8af364d81f911258a9add411354046abc16b4c3b1d748762b2ef439a16538cab5653ad

data/.gitignore

@@ -23,3 +23,7 @@ tmp
 *.a
 mkmf.log
 test/*
+/log.log
+/redmine-installer-err
+/redmine-installer-out
+/redmine

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.2
+services:
+  - postgresql
+before_install:
+  - gem install bundler

data/Gemfile

@@ -3,18 +3,6 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in redmine-installer.gemspec
 gemspec
 
-gem 'ansi'
-gem 'gli'
-gem 'i18n'
-gem 'notifier'
-gem 'ruby-progressbar'
-gem 'rubyzip'
-
-group :development do
-  gem 'pry'
-  gem 'rspec'
-  gem 'rspec-mocks'
-  gem 'guard'
-  gem 'guard-rspec'
-  gem 'rest_client'
-end
+gem 'pry'
+gem 'rspec'
+gem 'childprocess'

data/README.md

@@ -1,6 +1,10 @@
-# Redmine::Installer
+**This is a documentation for new unreleased version. For current version [go there](https://github.com/easyredmine/redmine-installer/tree/v1.0.7).**
 
-Easy way how to install/upgrade Redmine or plugin
+# Redmine installer
+
+Easy way hot to install/upgrade Redmine, EasyRedmine or EasyProject.
+
+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
 
@@ -24,218 +28,86 @@ $ gem install redmine-installer
 
 ## Examples
 
-Simple install and ugrade
+To display global documentation for installer.
 
 ```
-# From archive
-$ wget http://www.redmine.org/releases/redmine-2.3.0.zip
-$ wget http://www.redmine.org/releases/redmine-2.5.0.zip
-
-$ redmine install redmine-2.3.0.zip
-$ redmine upgrade redmine-2.5.0.zip
-
-# From website
-$ redmine install v2.3.0
-$ redmine upgrade v2.5.0
+redmine help
 ```
 
-Set languages
+You can also check more detailed documentation for each command.
 
 ```
-$ redmine --locale cs install redmine-2.3.0.zip
+redmine help [COMMAND]
 ```
 
-## Usage
-
-```
-redmine GLOBAL_FLAGS ACTION ARGUMENTS FLAGS
-```
+### Installing
 
-See help for more details
+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.
 
 ```
-redmine help
+redmine help install
+redmine install [PACKAGE] [REDMINE_ROOT] [options]
 ```
 
-#### Global flags
-
-<table>
-  <thead>
-    <tr>
-      <th>arguments</th>
-      <th>default value</th>
-      <th>description</th>
-    </tr>
-  </thead>
-  <tbody>
-    <tr>
-      <td>--verbose / -v</td>
-      <td>false</td>
-      <td>show verbosed output</td>
-    </tr>
-    <tr>
-      <td>--locale / -l</td>
-      <td>en</td>
-      <td>language for application</td>
-    </tr>
-  </tbody>
-</table>
-
-
-#### Shortcut
-
-Some commands have defined shortcut for quicker access. Fox example:
-
 ```
-redmine install package
-# is equal as
-redmine i package
+--bundle-options OPTIONS   Options for bundle install
+--silent                   Less verbose installation
 ```
 
-Commands shortcut.
+Examples:
 
-```
-i -> install
-u -> upgrade
-b -> backup
-```
+Install Redmine. Installer will ask for every required parameters.
+- `redmine install`
 
-#### Common flags for all command
+Install Redmine from redmine.zip package into /srv/redmine folder.
+- `redmine install redmine.zip /srv/redmine`
 
-<table>
-  <thead>
-    <tr>
-      <th>arguments</th>
-      <th>default</th>
-      <th>description</th>
-    </tr>
-  </thead>
-  <tbody>
-    <tr>
-      <td>--environment / --env / -e</td>
-      <td>production</td>
-      <td>
-        environment for redmine<br>
-        you can set more environment like: <br>
-        &nbsp;&nbsp;&nbsp;<i>--env env1,env2,env3</i>
-      </td>
-    </tr>
-  </tbody>
-</table>
+Install Redmine without rmgaick dependencies.
+- `redmine install redmine.zip /srv/redmine --bundle-options "--without rmagick"`
 
-## Install
+### Upgrading
 
-Install new redmine instance from archive or website.
+Upgrade existing project with new package. Full and correct upgrading is ensured by these steps:
+1. project is build on temporary directory
+2. previous root is deleted
+3. projects is moved to target location
 
-#### Steps:
+Since current root is deleted you should use option `--keep` if you want preserved some files.
 
-- **1. Redmine root** - insert _path_ where redmine will be installed
-	- _path_ must point to the folder
-	- target folder must be writable
-- **2. Load package** - loading package to temporary folder
-- **3. Database configuration** - you can choose type of DB which you want to use
-	- currently: MySQL or PostgreSQL
-	- you can also skip this step and run migration manually
-- **4. Email sending configuration** - you can set email configuration
-- **5. Install** - install commands are executed
-- **6. Moving redmine** - redmine is moved from temporarily folder to given _redmine\_root_
-- **7. Webserve configuration** - you can generate setting from selected webserver
-
-#### From archive
-
-Supported archives are **.zip** and **.tar.gz**.
 
 ```
-redmine install PATH_TO_PACKAGE
-
-# with environment
-redmine install PATH_TO_PACKAGE --env environment
+redmine help upgrade
+redmine upgrade [PACKAGE] [REDMINE_ROOT] [options]
 ```
 
-## Upgrade
-
-Upgrading existing instance of redmine with archive or defined version. If your redmine contain plugins which are not part of new package - all these plugins will be kept otherwise are replaced with those from package.
-
-Final step will ask you if you want save steps configuration. If you say _YES_, configuration will be stored as profile so next time you can upgrade redmine faster.
-
 ```
-redmine upgrade PACKAGE --profile PROFILE_ID
+--bundle-options OPTIONS   Options for bundle install
+--silent                   Less verbose upgrading
+--profile PROFILE_ID       Using saved profile
+--keep PATH(s)             Keep selected files or directories
 ```
 
-Profiles are stored on *HOME_FOLDER/.redmine-installer-profiles.yml*.
+Examples:
 
-#### Steps:
+Upgrade Redmine located on /srv/redmine with package redmine2.zip
+- `redmine upgrade redmine2.zip /srv/redmine`
 
-- **1. Redmine root** - where is redmine located
-- **2. Load package** -  loading package to temporary folder
-- **3. Validation** - validation of current redmine
-- **4. Backup** - backup current instance
-	- **full backup**: complete _redmine\_root_ with database
-	- **backup** (default): only configuration file with database
-	- **database**: only database
-- **5. Upgrading** - upgrade commands are executed
-- **6. Moving redmine** - current redmine is upgraded by new files
-- **7. Profile saving** - generating profile (see profile section)
+Upgrade Redmine and keep directory.
+- `redmine upgrade redmine2.zip /srv/redmine --keep directory_i_want_keep`
 
+Once you've saved profile you can use previouse "answer" again.
+- `redmine upgrade redmine2.zip /srv/redmine --profile 1`
 
-#### From archive
+### Backuping
 
-```
-redmine upgrade PATH_TO_PACKAGE
+Backup existing project. You can backup full redmine with database or just database.
 
-# with environment
-redmine upgrade PATH_TO_PACKAGE --env environment
 ```
-
-### Easyproject
-
-If you are using easyproject plugin and you dont want copy client modifications from old instance use switch `--skip-old-modifications`.
-
-
-## Backup
-
+redmine help backup
+redmine backup [REDMINE_ROOT]
 ```
-redmine backup
-```
-
-#### Steps:
-
-- **1. Redmine root** - where is redmine located
-- **2. Validation** - validation of current redmine
-- **3. Backup** - backup current instance
-	- **full backup**: complete _redmine\_root_ with database
-	- **backup** (default): only configuration file with database
-	- **database**: only database
-- **4. Profile saving** - generating profile (see profile section)
 
-You can choose one of 3 types.
+Examples:
 
-<table>
-  <thead>
-    <tr>
-      <th>Type</th>
-      <th>Description</th>
-    </tr>
-  </thead>
-  <tbody>
-    <tr>
-      <td><b>Full backup</b></td>
-      <td>archive full redmine_root folder with all you databases defined at config/database.yml</td>
-    </tr>
-    <tr>
-      <td><b>Backup</b></td>
-      <td>
-        archive
-        <ul>
-          <li>files folder</li>
-          <li>config/database.yml, config/configuration.yml</li>
-          <li>databases</li>
-        </ul>
-      </td>
-    </tr>
-    <tr>
-      <td><b>Only database</b></td>
-      <td>archive only databases</td>
-    </tr>
-  </tbody>
-</table>
+Backup project located on /srv/redmine
+- `redmine upgrade /srv/redmine`

data/bin/redmine

@@ -1,10 +1,9 @@
 #!/usr/bin/env ruby
 
-lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
-$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+lib = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(lib) if !$LOAD_PATH.include?(lib)
 
 require 'redmine-installer'
 
-Redmine::Installer.set_i18n
-Redmine::Installer.print_logo
-Redmine::Installer::CLI.start(ARGV)
+RedmineInstaller.print_logo
+RedmineInstaller::CLI.new.run

data/lib/redmine-installer/backup.rb

@@ -1,47 +1,20 @@
-##
-# Backup redmine
-#
-# Usage: `redmine backup`
-#
-# == Steps:
-# 1. Redmine root - where should be new redmine located
-# 2. Validation - current redmine should be valid
-# 3. Backup - backup current redmine (see backup section)
-# 4. Profile saving - generating profile (see profile section)
-#
-# == Types:
-#
-# Full backup::
-#   archive full redmine_root folder with all you databases defined at config/database.yml
-#
-# Backup  archive::
-#   - files folder
-#   - config/database.yml, config/configuration.yml
-#   - databases
-#
-# Only database::
-#   archive only databases
-#
-module Redmine::Installer
+module RedmineInstaller
   class Backup < Task
 
-    STEPS = [
-      step::RedmineRoot,
-      step::Validation,
-      step::Backup
-    ]
-
-    attr_accessor :redmine_root
-
-    def initialize(redmine_root, options={})
-      self.redmine_root = redmine_root
-      super(options)
+    def initialize(redmine_root)
+      super()
+      @target_redmine = Redmine.new(self, redmine_root)
     end
 
-    def run
-      Redmine::Installer::Profile.load(self, options[:profile])
-      super
-      Redmine::Installer::Profile.save(self) if options[:profile].nil?
+    def up
+      @target_redmine.ensure_and_valid_root
+      @target_redmine.validate
+      @target_redmine.check_running_state
+      @target_redmine.make_backup
+
+      puts
+      puts pastel.bold('Redmine was backuped')
+      logger.info('Redmine was backuped')
     end
 
   end

data/lib/redmine-installer/cli.rb

@@ -1,91 +1,122 @@
-require 'gli'
+require 'commander'
 
-module Redmine::Installer
+module Commander
+  module UI
+    # Disable paging for 'classic' help
+    def self.enable_paging
+    end
+  end
+end
+
+module RedmineInstaller
   class CLI
-    extend GLI::App
+    include Commander::Methods
 
-    def self.spec
-      @spec ||= Gem::Specification::load('redmine-installer.gemspec')
-    end
+    def run
+      program :name, 'Ruby installer'
+      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('-s', '--silent', 'Be less version in output') { $SILENT_MODE = true }
+      global_option('-e', '--env', 'For backward compatibility. Production is now always use.')
+      global_option('--skip-old-modifications', 'For backward compatibility. Missing modifications are now always copied.')
+      default_command :help
 
-    def self.start(argv)
-      # Program settings
-      program_desc I18n.translate(:redmine_installer_summary)
-      version Redmine::Installer::VERSION
 
-      # Global options
+      # --- Install -----------------------------------------------------------
+      command :install do |c|
+        c.syntax = 'install [PACKAGE] [REDMINE_ROOT] [options]'
+        c.description = 'Install redmine or easyredmine'
 
-      # Verbose
-      desc I18n.translate(:cli_show_verbose_output)
-      default_value false
-      switch [:d, :v, :debug, :verbose], negatable: false
+        c.example 'Install from archive',
+                  'redmine install ~/REDMINE_PACKAGE.zip'
+        c.example 'Install specific version from internet',
+                  'redmine install v3.1.0'
+        c.example 'Install package to new dir',
+                  'redmine install ~/REDMINE_PACKAGE.zip redmine_root'
 
-      # Locale
-      default_value 'en'
-      flag [:l, :locale]
+        c.option '--enable-user-root', 'Skip root as root validation'
+        c.option '--bundle-options OPTIONS', String, 'Add options to bundle command'
+        c.option '--database-dump DUMP', String, 'Load dump before migration (experimental function)'
 
-      # Before all action
-      pre do |global_options, command, options, args|
-        $verbose = global_options[:debug]
-        I18n.locale = global_options[:locale]
-        true
+        c.action do |args, options|
+          options.default(enable_user_root: false)
+
+          RedmineInstaller::Install.new(args[0], args[1], options.__hash__).run
+        end
       end
+      alias_command :i, :install
 
-      # Install command
-      desc I18n.translate(:cli_install_desc)
-      arg :package
-      command [:i, :install] do |c|
-        c.flag [:s, :source], default_value: 'file',
-                              must_match: ['file', 'git'],
-                              desc: I18n.translate(:cli_flag_source)
 
-        c.flag [:b, :branch], default_value: 'master',
-                              desc: I18n.translate(:cli_flag_branch)
+      # --- Upgrade -----------------------------------------------------------
+      command :upgrade do |c|
+        c.syntax = 'upgrade [PACKAGE] [REDMINE_ROOT] [options]'
+        c.description = 'Upgrade redmine or easyredmine'
 
-        c.flag [:e, :env, :environment], default_value: ['production'],
-                                         desc: I18n.translate(:cli_flag_environment),
-                                         type: Array
+        c.example 'Upgrade with new package',
+                  'redmine upgrade ~/REDMINE_PACKAGE.zip'
+        c.example 'Upgrade',
+                  'redmine upgrade ~/REDMINE_PACKAGE.zip redmine_root'
+        c.example 'Upgrade and keep directory',
+                  'redmine upgrade --keep git_repositories'
 
-        c.action do |global_options, options, args|
-          run_action('install', args.first, options)
+        c.option '--enable-user-root', 'Skip root as root validation'
+        c.option '--bundle-options', String, 'Add options to bundle command'
+        c.option '-p', '--profile PROFILE_ID', Integer, 'Use saved profile'
+        c.option '--keep PATH(s)', Array, 'Keep paths, use multiple options or separate values by comma (paths must be relative)', &method(:parse_keep_options)
+
+        c.action do |args, options|
+          options.default(enable_user_root: false)
+
+          RedmineInstaller::Upgrade.new(args[0], args[1], options.__hash__).run
         end
       end
+      alias_command :u, :upgrade
 
-      # Upgrade command
-      desc I18n.translate(:cli_upgrade_desc)
-      arg :package
-      command [:u, :upgrade] do |c|
-        c.flag [:p, :profile]
-        c.flag [:s, :source], default_value: 'file',
-                              must_match: ['file', 'git'],
-                              desc: I18n.translate(:cli_flag_source)
 
-        c.flag [:e, :env, :environment], default_value: ['production'],
-                                         desc: I18n.translate(:cli_flag_environment),
-                                         type: Array
+      # --- Verify log --------------------------------------------------------
+      command :'verify-log' do |c|
+        c.syntax = 'verify-log LOGFILE'
+        c.description = 'Verify redmine installer log file'
 
-        c.switch 'skip-old-modifications', default_value: false
+        c.example 'Verify log',
+                  'redmine verify-log LOGFILE'
 
-        c.action do |global_options, options, args|
-          run_action('upgrade', args.first, options)
+        c.action do |args, _|
+          RedmineInstaller::Logger.verify(args[0])
         end
       end
 
-      # Backup command
-      desc I18n.translate(:cli_backup_desc)
-      arg :redmine_root
-      command [:b, :backup] do |c|
-        c.flag [:p, :profile]
-        c.action do |global_options, options, args|
-          run_action('backup', args.first, options)
+
+      # --- Backup ------------------------------------------------------------
+      command :'backup' do |c|
+        c.syntax = 'backup [REDMINE_ROOT]'
+        c.description = 'Backup redmine'
+
+        c.example 'Backup',
+                  'redmine backup /srv/redmine'
+
+        c.action do |args, _|
+          RedmineInstaller::Backup.new(args[0]).run
         end
       end
+      alias_command :b, :backup
+
 
-      run(argv)
+      run!
     end
 
-    def self.run_action(action, *args)
-      Redmine::Installer.const_get(action.capitalize).new(*args).run
+    # For multiple user --keep option
+    def parse_keep_options(values)
+      proxy_options = Commander::Runner.instance.active_command.proxy_options
+
+      saved = proxy_options.find{|switch, _| switch == :keep }
+      if saved
+        saved[1].concat(values)
+      else
+        proxy_options << [:keep, values]
+      end
     end
 
   end