uberinstaller 1.0.0

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.ruby-gemset
+.ruby-version
+.rspec

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in uberinstaller.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Edoardo Tenani
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,66 @@
+# Uberinstaller
+
+Uberinstaller is a ruby gem that make easy to install system packages from a JSON configuration file.
+Thinked for Ubuntu, can handle pre and post installation commands, repositories and PPA, package installation from system repositories, git repositories or local files.
+
+Has support for different Package Managers as the one in use now can be modified and extended as needed.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'uberinstaller'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install uberinstaller
+
+Also, you need to have `sudo` installed and working on your machine to execute the uberinstaller executable and for every command launched from uberinstaller.
+
+## Usage
+
+duplicates are overridden!
+order is respected!
+
+Architecture verification:
+ - system => leave to the system to handle architecture package version resolution
+ - i386 => can be run only on 32 bit systems
+ - x86_64 => can be run only on 64 bit systems
+
+Version verification:
+ - codename of OS ( precise on ubuntu )
+
+Installation type:
+ - system
+ - git
+ - local
+ - json ( no extension )
+
+Command before/after:
+ - in the right folder: cmds/after/ cmds/before/, so specify only the filename, with extension
+ - array of commands
+ - a single command in a string
+
+before all => cmds/before/all.sh
+after all => cmds/after/all.sh
+
+Blocking package configuration as Debconf in Debian system must be properly avoided ( APT Package Manager use gnome DEBIAN_FRONTEND to avoid apt-get hangs)
+
+## Docs
+
+http://rubydoc.info/docs/yard/file/docs/GettingStarted.md
+http://rubydoc.info/docs/yard/file/docs/Tags.md
+
+http://gorails.com/setup/ubuntu
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/TODO

@@ -0,0 +1,14 @@
+ ☐ add JSON schema validation https://github.com/hoxworth/json-schema
+ ☐ installation advanced option ( install with dpkg for local install, --force-architecture )
+ ☐ README need refactoring
+ ☐ support {version} and {arch} in ppa/pkg strings
+ ☐ add repository support, not only ppa
+ ☐ check for superuser!
+ ☐ add progress bar for multiple packages installation
+
+
+＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿＿
+Archive:
+ ✔ multiple "recipe" inclusion in recipe @done (13-07-17 02:44)
+ ✘ preseeding @cancelled (13-07-17 01:43)
+ ✔ use proper debian frontend to avoid hangs @done (13-07-17 01:43)

data/bin/uberinstaller

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'uberinstaller'
+require 'uberinstaller/cli'
+
+Uberinstaller::Cli.start(ARGV)

data/lib/uberinstaller.rb

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+
+require 'uberinstaller/version'
+require 'uberinstaller/config'
+
+require 'uberinstaller/commander'
+require 'uberinstaller/exception'
+require 'uberinstaller/installer'
+require 'uberinstaller/platform'
+require 'uberinstaller/package_manager'
+require 'uberinstaller/parser'
+require 'uberinstaller/runner'
+
+
+module Uberinstaller
+  # Create a new instance of the Runner class in an easy way
+  #
+  # @param [String] file
+  #  the path of the JSON configuration file
+  def self.new(file)
+    puts "#{Config.app_name} - v#{Config.app_version}"
+    Uberinstaller::Runner.new file
+  end
+end

data/lib/uberinstaller/cli.rb

@@ -0,0 +1,51 @@
+# -*- encoding: utf-8 -*-
+
+require 'logger'
+require 'thor'
+
+module Uberinstaller
+  class Cli < Thor
+    default_task :help
+
+    # Main Uberinstaller installation command.
+    #
+    # @param file [String] the JSON file with package informations
+    #
+    # Exit status:
+    #  -   0 => Execution has been done as expected
+    #  - 127 => An error stopped execution
+    desc "install FILE", "Install packages from the specified JSON FILE"
+    method_option :verbose,
+                  :type => :boolean,
+                  :default => false, 
+                  :aliases => "-v", 
+                  :desc => "Enable verbose output"
+    method_option :debug, 
+                  :type => :boolean, 
+                  :default => false, 
+                  :aliases => "-d", 
+                  :desc => "Enable debug output, include verbose option"
+    method_option :dry_run,
+                  :type => :boolean,
+                  :default => false, 
+                  :desc => "Enable dry run, no modification to the system will be made during this execution"
+    def install(file)
+      Uberinstaller::Loggable.level = Logger::WARN
+      Uberinstaller::Loggable.level = Logger::INFO  if options[:verbose]
+      Uberinstaller::Loggable.level = Logger::DEBUG if options[:debug]
+
+      Uberinstaller::Loggable.log_path = File.join(File.dirname(file), 'log', "#{Time.now}.log") unless options[:debug]
+
+      Uberinstaller::Config.uberdirectory = File.dirname file
+      Uberinstaller::Config.dry_run = options[:dry_run]
+      
+      begin
+        runner = Uberinstaller.new file
+        runner.preprocess
+        runner.install
+      rescue Uberinstaller::Exception::WrongVersion, Uberinstaller::Exception::WrongArchitecture => e
+        exit(127)
+      end
+    end
+  end
+end

data/lib/uberinstaller/commander.rb

@@ -0,0 +1,112 @@
+# -*- encoding: utf-8 -*-
+
+require 'uberinstaller/config'
+require 'uberinstaller/exception'
+require 'uberinstaller/logger'
+
+module Uberinstaller
+
+  # Execute user defined command before and after installation
+  class Commander
+    include Loggable
+
+    # @!attribute [String] pkg_name
+    #   The name of the package being processed
+    # @!attribute [Hash] pkg
+    #   an Hash rapresenting a package to be installed
+    attr_reader :pkg_name, :pkg
+    
+    # Initialize the Commander class with the package information
+    #
+    # @param pkg_name [String] the name of the package
+    # @param pkg [Hash] the content of the package
+    def initialize(pkg_name, pkg)
+      @pkg_name = pkg_name
+      @pkg = pkg
+
+      @after_cmd_path = File.join Config.command_path, 'after'
+      @before_cmd_path = File.join Config.command_path, 'before'
+    end
+
+    # Execute after installation command
+    def after
+      if @pkg.has_key? :cmd and @pkg[:cmd].has_key? :after
+        logger.info "Executing after commands..."
+        run :after
+      end
+    end
+
+    # Execute after installation command
+    def before
+      if @pkg.has_key? :cmd and @pkg[:cmd].has_key? :before
+        logger.info "Executing before commands..."
+        run :before
+      end
+    end
+
+    private
+
+      # Execute a command in a subprocess
+      #
+      # All commands will be executed using `sudo`
+      #
+      # @param command [String] the command to be executed
+      def exec(command)
+        command = "sudo #{command}"
+        logger.debug "Executing command: #{command}"
+
+        unless Config.dry_run
+          Open3.popen3(command) { |stdin, stdout, stderr, wait_thr|
+            pid = wait_thr.pid # pid of the started process.
+            logger.debug "Running pid: #{pid}"
+
+            logger.debug stdout.readlines
+
+            exit_status = wait_thr.value.to_i # Process::Status object returned.
+            logger.debug "Exit status: #{exit_status}"
+            unless exit_status == 0
+              logger.error 'Some error happended during execution:' 
+              logger.error stderr.readlines
+            end
+          }
+        end
+      end
+
+      # Execute the specified file
+      #
+      # Passes the file to the `exec` function
+      #
+      # @param file [String] the path to the file to be executed
+      def exec_file(file)
+        exec "#{file}"
+      end
+
+      # Execute the specified action
+      #
+      # Currently available actions are: :after, :before
+      #
+      # @param type [Symbol] a symbol rapresenting an action to be performed
+      def run(type)
+        file = (type == :after) ? File.join(@after_cmd_path, @pkg[:cmd][type]) : File.join(@before_cmd_path, @pkg[:cmd][type])
+
+        logger.debug @pkg[:cmd][type]
+        logger.debug 'is array    : ' + (@pkg[:cmd][type].kind_of? Array).to_s
+        logger.debug 'is string   : ' + (@pkg[:cmd][type].kind_of? String).to_s
+        logger.debug 'file exists : ' + (File.exists? file).to_s if @pkg[:cmd][type].kind_of? String
+
+        if @pkg[:cmd][type].kind_of? Array
+          @pkg[:cmd][type].each do |cmd|
+            exec cmd
+          end
+        elsif @pkg[:cmd][type].kind_of? String
+          if File.exists? file
+            exec_file file
+          else
+            exec @pkg[:cmd][type]
+          end
+        else
+          raise Exception::CommandNotProcessable, @pkg_name, type
+        end
+      end
+  end
+end

data/lib/uberinstaller/config.rb

@@ -0,0 +1,55 @@
+# -*- encoding: utf-8 -*-
+
+require 'uberinstaller/version'
+
+module Uberinstaller
+
+  # Shared configuration for Uberinstaller
+  module Config
+    class << self
+      attr_accessor :dry_run, :local_package_manager, :remote_package_manager, :uberdirectory
+
+      attr_reader :app_name, :app_version
+
+      def command_path
+        @command_path ||= File.join @uberdirectory, 'cmds'
+      end
+      def local_pkg_path
+        @local_pkg_path ||= File.join @uberdirectory, 'pkgs' 
+      end
+      def json_path
+        @json_path ||= File.join @uberdirectory, 'json'
+      end
+    end
+
+    # @!attribute [rw] uberdirectory
+    #   absolute path to the folder in which the JSON file is located and in which every other installation script must be located
+    @uberdirectory = nil
+    # @!attribute [r] command_path
+    @command_path = nil
+    # @!attribute [r] local_pkg_path
+    #   absolute path in which local package for the configuration file are found
+    @local_pkg_path = nil
+    # @!attribute [r] json_path
+    #   absolute path in which locate json file to be imported in configuration
+    @local_pkg_path = nil
+    
+    # @!attribute [rw] remote_package_manager
+    #   the package manager used to install system type packages
+    @remote_package_manager = 'Apt'
+    # @!attribute [rw] local_package_manager
+    #   the package manager used to install local type packages
+    @local_package_manager = 'Dpkg'
+
+    # @!attribute [rw] dry_run
+    #   prevent real execution of commands enabling a dummy execution for test and debug purposes
+    @dry_run = false
+
+    # @!attribute [r] app_name
+    #   Application name
+    @app_name = "UberInstaller"
+    # @!attribute [r] app_version
+    #   Application version
+    @app_version = VERSION
+  end
+end

data/lib/uberinstaller/exception.rb

@@ -0,0 +1,40 @@
+# -*- encoding: utf-8 -*-
+
+require 'uberinstaller/logger'
+
+module Uberinstaller
+  module Exception
+    class Exception < StandardError
+      include Loggable
+
+      attr :parent
+      
+      def initialize(parent, print = true)
+        @parent = parent
+        logger.fatal parent if print
+        super parent
+      end
+    end
+
+    # When :pkg for a :type => :local package is not a String
+    class MultipleLocalFileNotSupported < Exception; end
+  end
+end
+
+require 'uberinstaller/exceptions/command_not_processable'
+require 'uberinstaller/exceptions/invalid_folder'
+require 'uberinstaller/exceptions/invalid_json'
+require 'uberinstaller/exceptions/invalid_local_package'
+require 'uberinstaller/exceptions/invalid_package'
+require 'uberinstaller/exceptions/invalid_ppa'
+require 'uberinstaller/exceptions/invalid_url'
+require 'uberinstaller/exceptions/json_file_not_found'
+require 'uberinstaller/exceptions/json_parse_error'
+require 'uberinstaller/exceptions/missing_local_package'
+require 'uberinstaller/exceptions/multiple_local_files_not_supported'
+require 'uberinstaller/exceptions/multiple_repositories_not_supported'
+require 'uberinstaller/exceptions/missing_url'
+require 'uberinstaller/exceptions/no_preprocessor_exception'
+require 'uberinstaller/exceptions/parser_argument_error'
+require 'uberinstaller/exceptions/wrong_architecture'
+require 'uberinstaller/exceptions/wrong_version'

data/lib/uberinstaller/exceptions/command_not_processable.rb

@@ -0,0 +1,13 @@
+# -*- encoding: utf-8 -*-
+
+module Uberinstaller
+  module Exception
+
+    # When a package as an unknown command ( is not a string nor an array )
+    class CommandNotProcessable < Exception
+      def initialize(name, type)
+        super "#{name}'s #{type} command is not proccessable, as it is of unknown type"
+      end
+    end
+  end
+end