comfy 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1a00d600ac242d01ee397d5e77b0740cc3a9361b
+  data.tar.gz: 21f394dae54301c46756ca44e45f68fb02713ab0
+SHA512:
+  metadata.gz: d45c8ea2ba75e6801a0dfc4f8487976ad34c04508d73ff479d7cd823697d84d48d647c6e501527c2e5911f44d8ff4b634bbb0122219264599022a4a142ad19d3
+  data.tar.gz: 4b0bf525e8079fff89367ea160c09cb26ea9451b1c2fee1ac1e9723a30594059ff84d45c96535b4a79083331285c398ac849ef8602c7b188209371c230ae5307

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+/.idea/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,46 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - 2.2.1
+  - ruby-head
+  - jruby-19mode
+  - jruby-head
+
+jdk:
+  - openjdk7
+  - oraclejdk7
+  - openjdk6
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+  exclude:
+    - rvm: 1.9.3
+      jdk: openjdk7
+    - rvm: 1.9.3
+      jdk: oraclejdk7
+    - rvm: 2.0.0
+      jdk: openjdk7
+    - rvm: 2.0.0
+      jdk: oraclejdk7
+    - rvm: 2.1
+      jdk: openjdk7
+    - rvm: 2.1
+      jdk: oraclejdk7
+    - rvm: 2.2.1
+      jdk: openjdk7
+    - rvm: 2.2.1
+      jdk: oraclejdk7
+    - rvm: ruby-head
+      jdk: openjdk7
+    - rvm: ruby-head
+      jdk: oraclejdk7
+  fast_finish: true
+  
+branches:
+  only:
+    - master

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2015 Michal Kimle and Lubomir Kosaristan
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,131 @@
+# COMFY - ClOud iMage FactorY
+COMFY is a tool for building virtual machine images from scratch.
+
+[![Build Status](https://secure.travis-ci.org/CESNET/comfy.png)](http://travis-ci.org/CESNET/comfy)
+[![Dependency Status](https://gemnasium.com/CESNET/comfy.png)](https://gemnasium.com/CESNET/comfy)
+[![Gem Version](https://fury-badge.herokuapp.com/rb/comfy.png)](https://badge.fury.io/rb/comfy)
+[![Code Climate](https://codeclimate.com/github/CESNET/comfy.png)](https://codeclimate.com/github/CESNET/comfy)
+
+##Requirements
+* Ruby >= 1.9.3
+* Rubygems
+* [Packer] >= 0.8.6 (https://www.packer.io/) (used for the image creation process)
+* VirtualBox (if you want to create `ova` images)
+* QEMU/KVM (if you want to create `qcow2` images)
+
+## Installation
+**Unfortunately, neither gem nor packages are available for COMFY right now. To try COMFY, please use the [From source](#from-source-dev) guide below.**
+
+###From source (dev)
+**Installation from source should never be your first choice! Especially, if you are not
+familiar with RVM, Bundler, Rake and other dev tools for Ruby!**
+
+**However, if you wish to contribute to our project, this is the right way to start.**
+
+To build and install the bleeding edge version from master
+
+```bash
+git clone git://github.com/CESNET/comfy.git
+cd comfy
+gem install bundler
+bundle install
+bundle exec rake spec
+```
+
+##Configuration
+###Create a configuration file for COMFY
+Configuration file can be read by COMFY from these
+three locations:
+
+* `~/.comfy/comfy.yml`
+* `/etc/comfy/comfy.yml`
+* `PATH_TO_GEM_DIR/config/comfy.yml`
+
+The example configuration file can be found at the last location
+`PATH_TO_GEM_DIR/config/comfy.yml`. When editing a configuration
+file you have to follow the division into three environments: `production`,
+`development` and `test`. All the configuration options are described
+in the example configuration file.
+
+##Usage
+COMFY is run with executable `comfy`. For further assistance run `comfy help`:
+```bash
+$ comfy help
+
+Commands:
+  comfy DISTRIBUTION                            # Builds VM with selected distribution
+  comfy <DISTRIBUTION>-versions                 # Lists available versions for selected destribution
+  comfy clean-cache -c, --cache-dir=CACHE-DIR   # Cleans packer's cache containing distributions' installation media
+  comfy distributions                           # Lists all available distributions and their versions
+  comfy export -d, --destination=DESTINATION    # Exports files for building virtual machines. Helps with the customization of the build process.
+  comfy help [COMMAND]                          # Describe available commands or one specific command
+  comfy version                                 # Prints COMFY's version
+
+Options:
+  --logging-level=LOGGING-LEVEL
+                                 # Possible values: DEBUG, INFO, WARN, ERROR, FATAL, UNKNOWN
+  [--logging-file=LOGGING-FILE]  # File to write log to
+  [--debug], [--no-debug]        # Runs COMFY in debug mode
+```
+
+Building process of selected VM can be customized. To list all the options for one of the distributions run `comfy help DISTRIBUTION`:
+```bash
+$ comfy help ubuntu
+
+Usage:
+  comfy ubuntu -c, --cache-dir=CACHE-DIR -f, --formats=one two three -o, --output-dir=OUTPUT-DIR -s, --size=N -v, --version=VERSION
+
+Options:
+  -v, --version=VERSION                    # Version of distribution to build
+  -f, --formats=one two three              # Output format of the virtual machine image (qemu - qcow2, virtualbox - ova)
+                                           # Possible values: qemu, virtualbox
+  -s, --size=N                             # Disk size for created virtual machines (in MB)
+  -o, --output-dir=OUTPUT-DIR              # Directory to which COMFY will produce virtual machine files
+  -c, --cache-dir=CACHE-DIR                # Directory for packer's cache e.g. distribution installation images
+  -g, [--groups=one two three]             # Groups VM belongs to. For automatic processing purposes
+  -i, [--identifier=IDENTIFIER]            # VM identifier. For automatic processing purposes
+  -d, [--description], [--no-description]  # Generates VM description file. For automatic processing purposes
+  -t, [--template-dir=TEMPLATE-DIR]        # Directory COMFY uses templates from to build a VM
+      --logging-level=LOGGING-LEVEL
+                                           # Possible values: DEBUG, INFO, WARN, ERROR, FATAL, UNKNOWN
+      [--logging-file=LOGGING-FILE]        # File to write log to
+      [--debug], [--no-debug]              # Runs COMFY in debug mode
+
+Builds VM with distribution Ubuntu
+```
+
+COMFY currently supports building of these distributions:
+* CentOS 7.1.1503
+* Debian 7.9.0
+* Debian 8.2.0
+* ScientificLinux 7.1
+* Ubuntu 14.04
+
+##Example
+To start a building process for example for debian simply run:
+```bash
+$ comfy debian
+```
+When not specified, COMFY will build the newest version of selected distribution. If you want to select a specific version run:
+```bash
+$ comfy debian -v 7.9.0
+```
+COMFY uses by default a QEMU supervisor for image creation. If you want to use VirtualBox you can do it with:
+```bash
+$ comfy debian -f virtualbox
+```
+Or if you want to use both:
+```bash
+$ comfy debian -f qemu virtualbox
+```
+This will create virtual machine images in both `qcow2` and `ovf` formats. Since QEMU and VirtualBox can't run simultaneously, images are created in two sequential runs.
+
+##Continuous integration
+[Continuous integration for COMFY by Travis-CI](http://travis-ci.org/CESNET/comfy/)
+
+## Contributing
+1. Fork it ( https://github.com/CESNET/comfy/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,18 @@
+require 'bundler/gem_tasks'
+require 'rubygems/tasks'
+
+task default: 'test'
+
+desc 'Run all tests; includes rspec and coverage reports'
+task test: 'rcov:rspec'
+
+desc 'Run all tests; includes rspec and coverage reports'
+task spec: 'test'
+
+Gem::Tasks.new(build: { tar: true, zip: true }, sign: { checksum: true, pgp: false })
+
+namespace :rcov do
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:rspec)
+end

data/bin/comfy

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'comfy'
+
+Comfy::CommandExecutioner.start(ARGV)

data/comfy.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'comfy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'comfy'
+  spec.version       = Comfy::VERSION
+  spec.authors       = ['Michal Kimle', 'Ľubomír Košarišťan']
+  spec.email         = ['kimle.michal@gmail.com', 'kosoburak@gmail.com']
+
+  spec.summary       = 'Tool for building virtual machine images from scratch.'
+  spec.description   = 'Tool for building virtual machine images from scratch.'
+  spec.homepage      = 'https://github.com/Misenko/comfy'
+  spec.license       = 'Apache License 2.0'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0.0'
+  spec.add_development_dependency 'simplecov', '~> 0.9.0'
+  spec.add_development_dependency 'rubygems-tasks', '~> 0.2.4'
+  spec.add_development_dependency 'rubocop', '~> 0.32'
+
+  spec.add_runtime_dependency 'syslogger', '~> 1.6.0'
+  spec.add_runtime_dependency 'settingslogic', '~> 2.0.9'
+  spec.add_runtime_dependency 'mixlib-shellout', '~> 2.0.1'
+  spec.add_runtime_dependency 'json-schema', '~> 2.5'
+  spec.add_runtime_dependency 'activesupport', '~> 4.2'
+  spec.add_runtime_dependency 'cloud-appliance-descriptor', '~> 0.2'
+  spec.add_runtime_dependency 'thor', '~> 0.19'
+  spec.add_runtime_dependency 'yell', '~> 2.0'
+end

data/config/comfy.yml

@@ -0,0 +1,20 @@
+---
+production:
+  output-dir: /opt/comfy/virtualmachines/ # Directory to which COMFY will produce virtual machine files
+  cache-dir: /opt/comfy/packer_cache/ # Directory for packer's cache e.g. distribution installation images
+  #template-dir: /opt/comfy/templates/ # When used COMFY uses templates from this directory to create virtual machines
+  formats:
+    - qemu
+  size: 10000
+  description: true
+  groups: # groups VM belongs to, used when creating cloud-appliance-descriptor
+    - comfy
+# $t - timestamp
+# $v - distribution version, consisting of major, minor, and patch version if possible
+# $n - distribution name
+# $g - groups the VM belongs to, separated by commas
+  identifier: METACLOUD-$n-$v # vm identifier, used in multiple places
+  logging:
+    level: ERROR
+    file: /var/log/comfy/comfy.log # File to write log to
+  debug: false

data/lib/comfy/command_executioner.rb

@@ -0,0 +1,225 @@
+require 'thor'
+require 'yell'
+require 'json-schema'
+require 'fileutils'
+
+class Comfy::CommandExecutioner < Thor
+  class << self
+    
+    # Method listing available distributions from template directory.
+    #
+    # @return [Hash] distributions structure containing info about them
+    def available_distributions
+      dir = Comfy::TEMPLATE_DIR
+      return {} unless File.exist? dir
+
+      description_files = Dir.glob(File.join(dir, '*', '*.description')).sort
+      distributions  = {}
+      description_files.each do |description_file|
+        unless JSON::Validator.validate(Comfy::DESCRIPTION_SCHEMA_FILE, description_file)
+          puts "Invalid distribution description #{description_file.inspect}, skipping."
+          next
+        end
+
+        description = File.read(description_file)
+        json = JSON.parse(description)
+        name = json['name']
+        distributions[name] = []
+        json['versions'].each do |version|
+          version_string = []
+          version_string << version['major_version']
+          version_string << version['minor_version']
+          version_string << version['patch_version']
+
+          distributions[name] << version_string.compact.join('.')
+          distributions[name].sort!
+        end
+      end
+
+      distributions
+    end
+  end
+
+  class_option :"logging-level",
+                :required => true,
+                :default => Comfy::Settings['logging']['level'],
+                :type => :string,
+                :enum => Yell::Severities
+  class_option :"logging-file",
+                :default => Comfy::Settings['logging']['file'],
+                :type => :string,
+                :desc => 'File to write log to'
+  class_option :debug,
+                :default => Comfy::Settings['debug'],
+                :type => :boolean,
+                :desc => 'Runs COMFY in debug mode'
+
+  desc 'version', 'Prints COMFY\'s version'
+  def version
+    $stdout.puts Comfy::VERSION
+  end
+
+  desc 'distributions', 'Lists all available distributions and their versions'
+  def distributions
+    self.class.available_distributions.each do |distribution, versions|
+      versions.each { |version| $stdout.puts "#{distribution} #{version}" }
+    end
+  end
+
+  method_option :destination,
+                type: :string,
+                required: true,
+                aliases: '-d',
+                desc: 'Destination of exported files'
+  desc 'export', 'Exports files for building virtual machines. Helps with the customization of the build process.'
+  def export
+    dir = options['destination']
+    FileUtils.mkdir_p dir unless File.exist?(dir) && File.directory?(dir)
+
+    FileUtils.cp_r(File.join(Comfy::Settings['template-dir'], '.'), dir)
+    $stdout.puts 'Template files copied successfully.'
+    $stdout.puts "In order to use the new template directory change setting 'vm_templates_dir' in your configuration file to:"
+    $stdout.puts "template-dir: #{dir}"
+  end
+
+  method_option :"cache-dir",
+                type: :string,
+                required: true,
+                default: Comfy::Settings['cache-dir'],
+                aliases: '-c',
+                desc: 'Directory for packer\'s cache e.g. distribution installation images'
+  desc 'clean-cache', 'Cleans packer\'s cache containing distributions\' installation media'
+  def clean_cache
+    dir = options['cache-dir']
+    FileUtils.rm_r Dir.glob(File.join(dir, '*'))
+    puts 'Cache cleaned successfully.'
+  end
+
+  available_distributions.each do |name, versions|
+    plain_name = name.downcase
+    method_option :version,
+                  type: :string,
+                  aliases: '-v',
+                  default: versions.first,
+                  required: true,
+                  desc: 'Version of distribution to build'
+    method_option :formats,
+                  type: :array,
+                  aliases: '-f',
+                  default: Comfy::Settings['formats'],
+                  enum: ['qemu', 'virtualbox'],
+                  required: true,
+                  desc: 'Output format of the virtual machine image (qemu - qcow2, virtualbox - ova)'
+    method_option :size,
+                  type: :numeric,
+                  aliases: '-s',
+                  default: Comfy::Settings['size'],
+                  required: true,
+                  desc: 'Disk size for created virtual machines (in MB)'
+    method_option :"output-dir",
+                  type: :string,
+                  required: true,
+                  default: Comfy::Settings['output-dir'],
+                  aliases: '-o',
+                  desc: 'Directory to which COMFY will produce virtual machine files'
+    method_option :"cache-dir",
+                  type: :string,
+                  required: true,
+                  default: Comfy::Settings['cache-dir'],
+                  aliases: '-c',
+                  desc: 'Directory for packer\'s cache e.g. distribution installation images'
+    method_option :groups,
+                  type: :array,
+                  aliases: '-g',
+                  default: Comfy::Settings['groups'],
+                  desc: 'Groups VM belongs to. For automatic processing purposes'
+    method_option :identifier,
+                  type: :string,
+                  aliases: '-i',
+                  default: Comfy::Settings['identifier'],
+                  desc: 'VM identifier. For automatic processing purposes'
+    method_option :description,
+                  type: :boolean,
+                  aliases: '-d',
+                  default: Comfy::Settings['description'],
+                  desc: 'Generates VM description file. For automatic processing purposes'
+    method_option :'template-dir',
+                  type: :string,
+                  aliases: '-t',
+                  default: Comfy::TEMPLATE_DIR,
+                  desc: 'Directory COMFY uses templates from to build a VM'
+
+    class_eval %Q^
+desc '#{plain_name}', 'Builds VM with distribution #{name}'
+def #{plain_name}
+  start('#{plain_name}', options)
+end
+
+desc '#{plain_name}-versions', 'Lists all available versions of #{name}'
+def #{plain_name}_versions
+  #{versions}.each { |version| $stdout.puts version }
+end
+^
+  end
+
+  private
+
+  def start(distribution_name, options)
+    parameters = options.to_hash.deep_symbolize_keys
+    parameters[:distribution] = distribution_name
+    parameters[:headless] = !parameters[:debug]
+    ENV['PACKER_CACHE_DIR'] = parameters[:'cache-dir']
+
+    init_log parameters
+    check_distribution_files distribution_name
+
+    logger.debug "Parameters: #{parameters}"
+
+    begin
+      creator = Comfy::Creator.new(parameters)
+      creator.create
+    ensure
+      creator.clean
+    end
+  end
+
+  # Inits logging according to the settings
+  #
+  # @param [Hash] parameters
+  # @option parameters [String] logging-level
+  # @option parameters [String] logging-file file to log to
+  # @option parameters [TrueClass, FalseClass] debug debug mode
+  # @return [Type] description of returned object
+  def init_log(parameters)
+    if parameters[:debug]
+      parameters[:'logging-level'] = 'DEBUG'
+      ENV['PACKER_LOG'] = '1'
+    end
+
+    Yell.new :stdout, :name => Object, :level => parameters[:'logging-level'].downcase, :format => Yell::DefaultFormat
+    Object.send :include, Yell::Loggable
+
+    if parameters[:'logging-file']
+      unless (File.exist?(parameters[:'logging-file']) && File.writable?(parameters[:'logging-file'])) || (File.writable?(File.dirname(parameters[:'logging-file'])))
+        logger.error "File #{parameters[:'logging-file']} isn't writable"
+        return
+      end
+
+      logger.adapter :file, parameters[:'logging-file']
+    end
+  end
+
+  def check_distribution_files(distribution_name)
+    distribution_cfg = File.join(Comfy::TEMPLATE_DIR, distribution_name, "#{distribution_name}.cfg.erb")
+    unless File.exist?(distribution_cfg)
+      logger.error "Missing distribution configuration #{distribution_cfg.inspect}, cannot build VM"
+      exit
+    end
+
+    distribution_desc = File.join(Comfy::TEMPLATE_DIR, distribution_name, "#{distribution_name}.description")
+    unless File.exist?(distribution_desc)
+      logger.error "Missing distribution description #{distribution_desc.inspect}, cannot build VM"
+      exit
+    end
+  end
+end