oneacct-export 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 670e8800aaf7a64b5f75d0f6d930e0d9be4d96fb
-  data.tar.gz: e6545c409b1c10e466a927833d3ffcde5b0c9c19
+  metadata.gz: e251289fc61da90a2cd802b46c6a9bb432a267b4
+  data.tar.gz: 1ee83f262bdf1234ce6e9c90665a8b4716293651
 SHA512:
-  metadata.gz: 79f668da9123a2b2d83eb3131062494614ce605132b394921b0867faeb72c53c7a16649095e31928f6e59eb0163b4e78574670515cd928dfbaf75914bdf708bc
-  data.tar.gz: fe9e971c3b06d3f7717e24feca0379206f4e8123276d01815618c475b331fbcf2e30db1bad2cbfa19b0190615ff3d759950d2f097c25bd9e913596f15c822fa2
+  metadata.gz: 4fb58b1c9b0c824a1a1dbc3aecc6e43fcc96de03dc915235a09d6b36d7a44ddf6a7dbaf92724afbfadfeec47229bb78c060233389f5dc298450f098b59d0637f
+  data.tar.gz: b505e55867d9defd5682e9ea50a2a12ee8f5609ade511122d21bccca7b0abf14e07c92b7a59c2bb19982cd6c627dfdb6ccd4640f6cab65ddb2800001b2582715

data/.travis.yml

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

data/.yardopts

@@ -0,0 +1 @@
+--title "Documentation of the OneacctExport gem" --markup markdown --private

data/README.md

@@ -1,9 +1,126 @@
 # OneacctExport
-
 Exporting OpenNebula accounting data.
 
-## Contributing
+[![Build Status](https://secure.travis-ci.org/Misenko/oneacct_export.png)](http://travis-ci.org/Misenko/oneacct_export)
+[![Dependency Status](https://gemnasium.com/Misenko/oneacct_export.png)](https://gemnasium.com/Misenko/oneacct_export)
+[![Gem Version](https://fury-badge.herokuapp.com/rb/oneacct-export.png)](https://badge.fury.io/rb/oneacct-export)
+[![Code Climate](https://codeclimate.com/github/Misenko/oneacct_export.png)](https://codeclimate.com/github/Misenko/oneacct_export)
+
+
+##Requirements
+* Ruby >= 2.0
+* Rubygems
+* Redis server (doesn't have to be present on the same machine)
+* OpenNebula >= 4.4 (doesn't have to be present on the same machine)
+
+##Installation
+###From distribution specific packages
+Distribution specific packages can be created with [omnibus packaging for OneacctExport](https://github.com/Misenko/omnibus-oneacct-export). When installing via packages you don't have to install neither ruby nor 
+rubygems. Packages contain embedded ruby and all the necessary gems and libraries witch will not effect your system ruby, gems and libraries. 
+
+Currently supported distributions:
+
+* Ubuntu 10.04
+* Ubuntu 12.04
+* Ubuntu 14.04
+* Debian 6.0.10
+* Debian 7.6
+* CentOS 5.10
+* CentOS 6.5
+
+###From RubyGems.org
+To install the most recent stable version
+```bash
+gem install oneacct-export
+```
+
+###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/Misenko/oneacct_export.git
+cd oneacct_export
+gem install bundler
+bundle install
+bundle exec rake spec
+rake install
+```
+##Configuration
+###Create a configuration file for OneacctExport
+Configuration file can be read by OneacctExport from these three locations:
+
+* ~/.oneacct-export/conf.yml
+* /etc/oneacct-export/conf.yml
+* <PATH_TO_GEM_DIR>/config/conf.yml
+ 
+The example configuration file can be found at the last location <PATH_TO_GEM_DIR>/config/conf.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.
+ 
+###Create a configuration file for Sidekiq
+Sidekiq configuration file can be placed anywhere you want since you will provide path to the configuration later during the Sidekiq start. How the Sidekiq configuration should look like and what options you can use 
+can be found on its [wiki page](https://github.com/mperham/sidekiq/wiki/Advanced-Options).
+ 
+The important thing is to set the same queue name in both OneacctExport and Sidekiq configuration files. OneacctExport is currently supporting adding jobs to only one queue.
+ 
+###Configure RPC connection
+RPC connection for OpenNebula can be configured in two ways:
 
+* Via OneacctExport configuration file, option xml_rpc and its suboptions
+* Via Opennebula configuration mechanism:
+ 
+ System environment variable ONE_AUTH contains path to the file containing string in format username:password to authenticate against OpenNebula. If the variable is empty, default file location is ~/.one/one_auth.
+ 
+ System environment variable ONE_XMLRPC contains URL of OpenNebula RPC gate. If empty, the same information can be stored in ~/.one/one_endpoint
+ 
+###Set Rails environment variable according to your environment
+You have to set system environment variable RAILS_ENV to one of the values production, development or test. OneacctExport is not a Rails application but we chose the Rails variable for easier possible integration in 
+the future.
+
+##Usage
+
+**Both Opennebula and Redis server must be running prior the next steps.**
+
+###Start sidekiq
+First you have to start Sidekiq so it can run the jobs from the queue. Since OneacctExport is not a Rails application Sidekiq has to be started with OneacctExport's worker class as an argument. For example:
+
+```bash
+sidekiq -r <PATH_TO_GEM_DIR>/lib/one_worker.rb -C <PATH_TO_SIDEKIQ_CONF>/sidekiq.yml
+```
+
+###Start OneacctExport
+
+OneacctExport is run with executable `oneacct-export`. For a list of all available options run `oneacct-export -h`:
+
+```
+$ oneacct-export -h
+
+Usage oneacct-export [options]
+
+        --records-from TIME          Retrieves only records newer than TIME
+        --records-to TIME            Retrieves only records older than TIME
+        --include-groups GROUP1[,GROUP2,...]
+                                     Retrieves only records of virtual machines which belong to the specified groups
+        --exclude-groups GROUP1[,GROUP2,...]
+                                     Retrieves only records of virtual machines which don't belong to the specified groups
+        --group-file FILE            If --include-groups or --exclude-groups specified, loads groups from file FILE
+    -b, --[no-]blocking              Run in a blocking mode - wait until all submitted jobs are processed
+    -t, --timeout N                  Timeout for blocking mode in seconds. Default is 1 hour.
+    -c, --[no-]compatibility-mode    Run in compatibility mode - supports OpenNebula 4.4.x
+    -h, --help                       Shows this message
+    -v, --version                    Shows version
+```
+
+##Code Documentation
+[Code Documentation for OneacctExport by YARD](http://rubydoc.info/github/Misenko/oneacct_export/)
+
+##Continuous integration
+[Continuous integration for OneacctExport by Travis-CI](http://travis-ci.org/Misenko/oneacct_export/)
+
+## Contributing
 1. Fork it ( https://github.com/Misenko/oneacct_export/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)

data/bin/oneacct-export

@@ -8,16 +8,19 @@ require 'settings'
 require 'fileutils'
 require 'oneacct_opts'
 
+#parse options from command line
 options = OneacctOpts.parse(ARGV)
 
+#initialize default logger
 log = Logger.new(STDOUT)
 
+#initialize specific logger according to the configuration
 if Settings['logging'] && Settings['logging']['log_type'] == 'file'
   begin
     log_file = File.open(Settings['logging']['log_file'], File::WRONLY | File::CREAT | File::APPEND)
     log = Logger.new(log_file)
   rescue => e
-    OneacctExporter::Log.setup_logging(log)
+    OneacctExporter::Log.setup_log_level(log)
     log.warn("Unable to create log file #{Settings['logging']['log_file']}: #{e.message}.\
            Falling back to STDOUT.")
   end
@@ -35,6 +38,7 @@ groups = {}
 groups[:include] = options.include_groups if options.include_groups
 groups[:exclude] = options.exclude_groups if options.exclude_groups
 
+#read groups restriction from file if chosen
 if options.groups_file
   log.debug('Reading groups from file...')
   if File.exist?(options.groups_file) && File.readable?(options.groups_file)
@@ -50,6 +54,7 @@ if options.groups_file
   end
 end
 
+#create output directory
 begin
   FileUtils.mkdir_p Settings.output['output_dir']
 rescue SystemCallError => e
@@ -68,5 +73,6 @@ opts[:compatibility] = options.compatibility
 
 log.debug(opts)
 
+#run the export
 oneacct_exporter = OneacctExporter.new(opts, log)
 oneacct_exporter.export

data/config/conf.yml

@@ -1,30 +1,31 @@
-#Five mandatory parameters: 
+#There are six mandatory parameters: 
 # site_name
 # cloud_type
 # endpoint
 # output -> output_dir
 # output -> output_type
+# sidekiq -> queue
 defaults: &defaults
-  site_name: <fill in> 
-  cloud_type: <fill in>
-  endpoint: <fill in>
+  site_name: <fill in> #Usually a shor provider name, e.g. CESNET 
+  cloud_type: OpenNebula
+  endpoint: <fill in> #URL of your OCCI endpoint, e.g. https://fqdn.example.com:80
   output:
-    output_dir: <fill in>
-    output_type: apel-0.2 #currently only option
-# num_of_vms_per_file: 500
+    output_dir: <fill in> #Directory for outgoing messages
+    output_type: apel-0.2 #Format of outgoing messages. apel-0.2 is currently the only option.
+#   num_of_vms_per_file: 500 #Maximum number of virtual machine records per one output file.
 #
-#logging:
-# log_type: file #Two options: file, syslog. Defaults to stdout
-# log_file: /var/log/oneacct-export.log #Used when type file selected
+# logging:
+#   log_type: file #Two options: file, syslog. Defaults to stdout
+#   log_file: /var/log/oneacct-export.log #Used when type file selected
 #
-#xml_rpc:
-# secret: username:password #If not specified looking for secret in ONE_AUTH and ~/.one/one_auth
-# endpoint: http://localhost:2633/RPC2 #Defaults to content of ONE_XMLRPC or content of ~/.one/one_endpoint or http://localhost:2633/RPC2
+# xml_rpc:
+#   secret: username:password #If not specified looking for secret in ONE_AUTH and ~/.one/one_auth.
+#   endpoint: http://localhost:2633/RPC2 #Defaults to content of ONE_XMLRPC or content of ~/.one/one_endpoint or http://localhost:2633/RPC2.
 #
-#redis:
-# namespace: oneacct_export
-# url: redis://localhost:6379
-# password: password
+# redis:
+#   namespace: oneacct_export
+#   url: redis://localhost:6379 #URL of redis server, defaults to redis://localhost:6379.
+#   password: password #Password to access redis server if needed.
   sidekiq:
     queue: oneacct_export
 production:

data/lib/input_validator.rb

@@ -1,5 +1,6 @@
 require 'uri'
 
+# Simple helper module for input validation
 module InputValidator
   URI_RE = /\A#{URI.regexp}\z/
   NUMBER_RE = /\A[[:digit:]]+\z/

data/lib/one_data_accessor.rb

@@ -4,6 +4,12 @@ require 'errors'
 require 'logger'
 require 'input_validator'
 
+# Class for accessing OpenNebula via XML RPC and requesting accounting data
+#
+# @attr_reader [any logger] logger
+# @attr_reader [Integer] batch_size number of vm records to request
+# @attr_reader [OpenNebula::Client] client client for communicaton with OpenNebula
+# @attr_reader [TrueClass, FalseClass] compatibility whether or not communicate in compatibility mode (omit some newer API functions)
 class OneDataAccessor
   include Errors
   include InputValidator
@@ -24,6 +30,7 @@ class OneDataAccessor
     initialize_client
   end
 
+  # Initialize OpenNebula client for further connection
   def initialize_client
     secret = Settings['xml_rpc'] ? Settings.xml_rpc['secret'] : nil
     endpoint = Settings['xml_rpc'] ? Settings.xml_rpc['endpoint'] : nil
@@ -32,9 +39,16 @@ class OneDataAccessor
     @client = OpenNebula::Client.new(secret, endpoint)
   end
 
+  # Create mapping from element's ID to its xpath value
+  #
+  # @param [one of OpenNebula pool classes] pool_class pool to read elements from
+  # @param [String] xpath xpath pointing to value within the element
+  #
+  # @return [Hash] generated map
   def mapping(pool_class, xpath)
     @log.debug("Generating mapping for class: #{pool_class} and xpath: '#{xpath}'.")
     pool = pool_class.new(@client)
+    #call info_all method instead of info on pools that support it
     if pool.respond_to? 'info_all'
       rc = pool.info_all
       check_retval(rc, Errors::ResourceRetrievalError)
@@ -43,6 +57,7 @@ class OneDataAccessor
       check_retval(rc, Errors::ResourceRetrievalError)
     end
 
+    #generate mapping
     map = {}
     pool.each do |item|
       unless item['ID']
@@ -55,6 +70,11 @@ class OneDataAccessor
     map
   end
 
+  # Retrieve virtual machine
+  #
+  # @param [Integer] vm_id ID of vm to retrieve
+  #
+  # @return [OpenNebula::VirtualMachine] virtual machine
   def vm(vm_id)
     fail ArgumentError, "#{vm_id} is not a valid id." unless is_number?(vm_id)
     @log.debug("Retrieving virtual machine with id: #{vm_id}.")
@@ -64,8 +84,16 @@ class OneDataAccessor
     vm
   end
 
+  # Retriev IDs of specified virtual machines
+  #
+  # @param [Integer] batch_number
+  # @param [Hash] range date range into which virtual machine has to belong
+  # @param [Hash] groups groups into one of which owner of the virtual machine has to belong
+  #
+  # @return [Array] array with virtual machines' IDs
   def vms(batch_number, range, groups)
     vms = []
+    #load specific batch
     vm_pool = load_vm_pool(batch_number)
     return nil if vm_pool.count == 0
 
@@ -76,6 +104,7 @@ class OneDataAccessor
         next
       end
 
+      #skip unsuitable virtual machines
       next unless want?(vm, range, groups)
 
       vms << vm['ID'].to_i
@@ -85,6 +114,13 @@ class OneDataAccessor
     vms
   end
 
+  # Check whether obtained vm meets requierements
+  #
+  # @param [OpenNebula::VirtualMachine] vm virtual machine instance to check
+  # @param [Hash] range date range into which virtual machine has to belong
+  # @param [Hash] groups groups into one of which owner of the virtual machine has to belong
+  #
+  # @return [TrueClass, FalseClass] true if virtual machine meets requirements, false otherwise
   def want?(vm, range, groups)
     if vm.nil?
       @log.warn('Obtained nil vm from vm pool.')
@@ -105,12 +141,16 @@ class OneDataAccessor
     true
   end
 
+  # Load part of virtual machine pool
+  #
+  # @param [Integer] batch_number
   def load_vm_pool(batch_number)
     fail ArgumentError, "#{batch_number} is not a valid number" unless is_number?(batch_number)
     @log.debug("Loading vm pool with batch number: #{batch_number}.")
     from = batch_number * @batch_size
     to = (batch_number + 1) * @batch_size - 1
 
+    #if in compatibility mode, whole virtual machine pool has to be loaded for the first time
     if @compatibility
       unless @compatibility_vm_pool
         vm_pool = OpenNebula::VirtualMachinePool.new(@client)
@@ -129,6 +169,7 @@ class OneDataAccessor
     end
   end
 
+  # Check OpenNebula return codes
   def check_retval(rc, e_klass)
     return true unless OpenNebula.is_error?(rc)
     case rc.errno

data/lib/one_worker.rb

@@ -8,6 +8,7 @@ require 'sidekiq_conf'
 require 'oneacct_exporter/log'
 require 'settings'
 
+# Sidekiq worker class
 class OneWorker
   include Sidekiq::Worker
 
@@ -21,6 +22,7 @@ class OneWorker
   NON_ZERO = /[1-9][[:digit:]]*/
   STATES = %w(started started suspended started suspended suspended completed completed suspended)
 
+  # Prepare data that are common for every virtual machine
   def common_data
     common_data = {}
     common_data['endpoint'] = Settings['endpoint']
@@ -30,25 +32,35 @@ class OneWorker
     common_data
   end
 
+  # Create mapping of user ID and specified element
+  #
+  # @return [Hash] created map
   def create_user_map(oda)
     logger.debug('Creating user map.')
     create_map(OpenNebula::UserPool, 'TEMPLATE/X509_DN', oda)
   end
 
+  # Create mapping of image ID and specified element
+  #
+  # @return [Hash] created map
   def create_image_map(oda)
     logger.debug('Creating image map.')
-    create_map(OpenNebula::ImagePool, 'NAME', oda)
+    create_map(OpenNebula::ImagePool, 'TEMPLATE/VMCATCHER_EVENT_AD_MPURI', oda)
   end
 
+  # Generic method for mapping creation
   def create_map(pool_type, mapping, oda)
     oda.mapping(pool_type, mapping)
   rescue => e
     msg = "Couldn't create map: #{e.message}. "\
-      'Stopping to avoid malformed records.'
+          'Stopping to avoid malformed records.'
     logger.error(msg)
     raise msg
   end
 
+  # Load virtual machine with specified ID
+  #
+  # @return [OpenNebula::VirtualMachine] virtual machine
   def load_vm(vm_id, oda)
     oda.vm(vm_id)
   rescue => e
@@ -56,6 +68,9 @@ class OneWorker
     return nil
   end
 
+  # Obtain and parse required data from vm 
+  #
+  # @return [Hash] required data from virtual machine
   def process_vm(vm, user_map, image_map)
     data = common_data.clone
 
@@ -66,16 +81,16 @@ class OneWorker
       return nil
     end
 
-    data['start_time'] = parse(vm['STIME'], NUMBER)
+    data['start_time'] = Time.at(parse(vm['STIME'], NUMBER).to_i)
     start_time = data['start_time'].to_i
     if start_time == 0
       logger.error('Skipping a malformed record. '\
                    "VM with id #{data['vm_uuid']} has malformed StartTime.")
       return nil
     end
-    data['start_time_readable'] = parse(Time.at(start_time).strftime('%F %T%:z'), STRING)
     data['end_time'] = parse(vm['ETIME'], NON_ZERO)
     end_time = data['end_time'].to_i
+    data['end_time'] = Time.at(end_time) if end_time != 0
 
     if end_time != 0 && start_time > end_time
       logger.error('Skipping malformed record. '\
@@ -86,7 +101,8 @@ class OneWorker
     data['machine_name'] = parse(vm['DEPLOY_ID'], STRING, "one-#{data['vm_uuid']}")
     data['user_id'] = parse(vm['UID'], STRING)
     data['group_id'] = parse(vm['GID'], STRING)
-    data['user_name'] = parse(user_map[data['user_id']], STRING)
+    data['user_name'] = parse(vm['USER_TEMPLATE/USER_X509_DN'], STRING, nil)
+    data['user_name'] = parse(user_map[data['user_id']], STRING) unless data['user_name']
     data['fqan'] = parse(vm['GNAME'], STRING, nil)
 
     if vm['STATE']
@@ -118,11 +134,37 @@ class OneWorker
     data['network_outbound'] = (net_rx.to_i / B_IN_GB).round
 
     data['memory'] = parse(vm['MEMORY'], NUMBER, '0')
-    data['image_name'] = parse(image_map[vm['TEMPLATE/DISK[1]/IMAGE_ID']], STRING)
+
+    data['image_name'] = parse(image_map[vm['TEMPLATE/DISK[1]/IMAGE_ID']], STRING, nil)
+    data['image_name'] = parse(mixin(vm), STRING) unless data['image_name']
 
     data
   end
 
+  # Look for 'os_tpl' OCCI mixin to better identifie virtual machine's image
+  #
+  # @param [OpenNebula::VirtualMachine] vm virtual machine
+  #
+  # @return [NilClass, String] if found, mixin identifying string, nil otherwise
+  def mixin(vm)
+    mixin_locations = %w(USER_TEMPLATE/OCCI_COMPUTE_MIXINS USER_TEMPLATE/OCCI_MIXIN TEMPLATE/OCCI_MIXIN)
+
+    mixin_locations.each do |mixin_location|
+      vm.each mixin_location do |mixin|
+        mixin = mixin.text.split
+        mixin.select! { |line| line.include? '/occi/infrastructure/os_tpl#' }
+        return mixin.first unless mixin.empty?
+      end
+    end
+
+    nil # nothing found
+  end
+
+  # Sums RSTIME (time when virtual machine was actually running)
+  #
+  # @param [OpenNebula::VirtualMachine] vm virtual machine
+  #
+  # @return [Integer] RSTIME
   def sum_rstime(vm)
     rstime = 0
     vm.each 'HISTORY_RECORDS/HISTORY' do |h|
@@ -139,6 +181,10 @@ class OneWorker
     rstime
   end
 
+  # Sidekiq specific method, specifies the purpose of the worker
+  #
+  # @param [String] vms IDs of virtual machines to process in form of numbers separated by '|' (easier for cooperation with redis)
+  # @param [String] output output directory
   def perform(vms, output)
     OneacctExporter::Log.setup_log_level(logger)
 
@@ -165,12 +211,13 @@ class OneWorker
     write_data(data, output)
   end
 
+  # Write processed data into output directory
   def write_data(data, output)
     logger.debug('Creating writer...')
     ow = OneWriter.new(data, output, logger)
     ow.write
   rescue => e
-    msg = "Canno't write result to #{output}: #{e.message}"
+    msg = "Cannot write result to #{output}: #{e.message}"
     logger.error(msg)
     raise msg
   end

data/lib/one_writer.rb

@@ -4,8 +4,15 @@ require 'fileutils'
 require 'settings'
 require 'logger'
 
+# Class responsible for writing data into files in specific format
+#
+# @attr_reader [Hash] data vm data
+# @attr_reader [String] output path to the output directory
+# @attr_reader [any logger] logger
 class OneWriter
+
   attr_reader :data, :output, :log
+
   def initialize(data, output, log = Logger.new(STDOUT))
     fail ArgumentError, 'Data and output cannot be nil' if data.nil? || output.nil?
 
@@ -17,6 +24,7 @@ class OneWriter
     @log = log
   end
 
+  # Write data to file in output directory
   def write
     @log.debug('Creating temporary file...')
     tmp = Tempfile.new('oneacct_export')
@@ -38,6 +46,9 @@ class OneWriter
     FileUtils.cp(from, to)
   end
 
+  # Prepare file content according to ERB template
+  #
+  # @return [String] transformed content
   def fill_template
     @log.debug("Reading erb template from file: '#{@template}'.")
     erb = ERB.new(File.read(@template), nil, '-')
@@ -45,6 +56,9 @@ class OneWriter
     erb.result(binding)
   end
 
+  # Load template for data conversion
+  #
+  # @param [String] template_name name of the template to look for
   def self.template_filename(template_name)
     "#{File.dirname(__FILE__)}/templates/#{template_name}.erb"
   end

data/lib/oneacct_exporter.rb

@@ -4,6 +4,14 @@ require 'one_worker'
 require 'settings'
 require 'sidekiq/api'
 
+# Class managing the export
+#
+# @attr_reader [any logger] log logger for the class
+# @attr_reader [Hash] range range of dates, requesting only virtual machines within the range
+# @attr_reader [Hash] groups user groups, requesting only virtual machines with owners that belong to one of the group
+# @attr_reader [TrueClass, FalseClass] blocking says whether to run export in blocking mode or not
+# @attr_reader [Integer] timeout timeout for blocking mode
+# @attr_reader [TrueClass, FalseClass] compatibility says whether to run export in compatibility mode or not 
 class OneacctExporter
   CONVERT_FORMAT = '%014d'
 
@@ -18,6 +26,7 @@ class OneacctExporter
     @compatibility = options[:compatibility]
   end
 
+  # Start export the records
   def export
     @log.debug('Starting export...')
 
@@ -28,10 +37,12 @@ class OneacctExporter
     oda = OneDataAccessor.new(@compatibility, @log)
 
     vms = []
+    #load records of virtual machines in batches
     while vms = oda.vms(batch_number, @range, @groups)
       output_file = CONVERT_FORMAT % new_file_number
       @log.info("Starting worker with batch number: #{batch_number}.")
       unless vms.empty?
+        #add a new job for every batch to the Sidekiq's queue
         OneWorker.perform_async(vms.join('|'), "#{Settings.output['output_dir']}/#{output_file}")
         new_file_number += 1
       end
@@ -50,6 +61,7 @@ class OneacctExporter
                "failed with error: #{e.message}. Exiting.")
   end
 
+  # When in blocking mode, wait for processing of records to finish
   def wait_for_processing
     @log.info('Processing...')
 
@@ -66,6 +78,7 @@ class OneacctExporter
     @log.info('All processing ended.')
   end
 
+  # Check whether Sidekiq's queue is empty
   def queue_empty?
     queue = (Settings['sidekiq'] && Settings.sidekiq['queue']) ? Settings.sidekiq['queue'] : 'default'
     Sidekiq::Stats.new.queues.each_pair do |queue_name, items_in_queue|
@@ -75,10 +88,12 @@ class OneacctExporter
     true
   end
 
+  # Check whether all Sidekiq workers have finished thair work
   def all_workers_done?
     Sidekiq::Workers.new.size == 0
   end
 
+  # Clean output directory of previous entries
   def clean_output_dir
     output_dir = Dir.new(Settings.output['output_dir'])
     output_dir.entries.each do |entry|

data/lib/oneacct_exporter/version.rb

@@ -1,3 +1,3 @@
 class OneacctExporter
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/oneacct_opts.rb

@@ -4,6 +4,7 @@ require 'ostruct'
 require 'oneacct_exporter'
 require 'settings'
 
+# Class for parsing command line arguments
 class OneacctOpts
   BLOCKING_DEFAULT = false
   TIMEOUT_DEFAULT = 60 * 60
@@ -78,6 +79,7 @@ class OneacctOpts
     options
   end
 
+  # Set default values for not specified options
   def self.set_defaults(options)
     options.blocking = BLOCKING_DEFAULT unless options.blocking
     unless options.timeout
@@ -91,38 +93,47 @@ class OneacctOpts
     check_settings_restrictions
   end
 
+  # Make sure command line parameters are sane
   def self.check_options_restrictions(options)
+    #make sure date range make sense
     if options.records_from && options.records_to && options.records_from >= options.records_to
       fail ArgumentError, 'Wrong time range for records retrieval.'
     end
 
+    #make sure only one group restriction is used
     if options.include_groups && options.exclude_groups
       fail ArgumentError, 'Mixing of group options is not possible.'
     end
 
+    #make sure group file option is not used without specifying group restriction type
     unless options.include_groups || options.exclude_groups
       if options.groups_file
         fail ArgumentError, 'Cannot use group file without specifying group restriction type.'
       end
     end
 
+    #make sure that timeout option is not used without blocking option
     if options.timeout && !options.blocking
       fail ArgumentError, 'Cannot set timeout without a blocking mode.'
     end
   end
 
+  # Make sure configuration is sane
   def self.check_settings_restrictions
+    #make sure all mandatory parameters are set
     unless Settings['site_name'] && Settings['cloud_type'] && Settings['endpoint'] &&
         Settings['output'] && Settings.output['output_dir'] && Settings.output['output_type']
       fail ArgumentError, 'Missing some mandatory parameters. Check your configuration file.'
     end
     Settings['endpoint'].chop! if Settings['endpoint'].end_with?('/')
 
+    #make sure log file is specified while loggin to file
     if Settings['logging'] && Settings.logging['log_type'] == 'file' &&
         !Settings.logging['log_file']
       fail ArgumentError, 'Missing file for logging. Check your configuration file.'
     end
 
+    #make sure specified template really exists
     template_filename = OneWriter.template_filename(Settings.output['output_type'])
     unless File.exist?(template_filename)
       fail ArgumentError, "Non-existing template #{Settings.output['output_type']}."

data/lib/redis_conf.rb

@@ -2,9 +2,13 @@ require 'settings'
 require 'uri'
 require 'input_validator'
 
+# Class that deals with Redis server configuration options
 class RedisConf
   extend InputValidator
 
+  # Read and parse Redis server configuration options
+  #
+  # @return [Hash] redis server options ready for use 
   def self.options
     options = {}
     if Settings['redis']

data/lib/settings.rb

@@ -1,8 +1,11 @@
 require 'settingslogic'
 
+# Class representing OneacctExport settings 
 class Settings < Settingslogic
   CONF_NAME = 'conf.yml'
 
+  #three possible configuration file locations in order by preference
+  #if configuration file is found rest of the locations are ignored
   source "#{ENV['HOME']}/.oneacct-export/#{CONF_NAME}"\
     if File.exist?("#{ENV['HOME']}/.oneacct-export/#{CONF_NAME}")
   source "/etc/oneacct-export/#{CONF_NAME}"\

data/lib/sidekiq_conf.rb

@@ -1,6 +1,7 @@
 require 'sidekiq'
 require 'redis_conf'
 
+# Class representing Sidekiq configuration
 Sidekiq.configure_client do |config|
   options = RedisConf.options
   options[:size] = 1

data/lib/templates/apel-0.2.erb

@@ -1,6 +1,6 @@
 APEL-cloud-message: v0.2
 <% for vm in @data -%>
-VMUUID: <%= vm['endpoint'] %>/compute/<%= vm['vm_uuid'] %> <%= vm['start_time_readable']%>
+VMUUID: <%= vm['endpoint'] %>/compute/<%= vm['vm_uuid'] %> <%= vm['start_time'].strftime('%F %T%:z') %>
 SiteName: <%= vm['site_name']%>
 MachineName: <%= vm['machine_name']%>
 LocalUserId: <%= vm['user_id']%>
@@ -12,8 +12,8 @@ FQAN: /<%= vm['fqan']%>/Role=NULL/Capability=NULL
 FQAN: NULL
 <% end -%>
 Status: <%= vm['status']%>
-StartTime: <%= vm['start_time']%>
-EndTime: <%= vm['end_time']%>
+StartTime: <%= vm['start_time'].to_i%>
+EndTime: <%= vm['end_time'].to_i%>
 SuspendDuration: <%= vm['suspend']%>
 WallDuration: <%= vm['duration']%>
 CpuDuration: <%= vm['duration']%>

data/mock/one_worker_vm4.xml

@@ -0,0 +1,106 @@
+<VM>
+    <ID>46083</ID>
+    <UID>120</UID>
+    <GID>103</GID>
+    <UNAME>local_ops</UNAME>
+    <GNAME>ops</GNAME>
+    <NAME>EGI-SAM</NAME>
+    <PERMISSIONS>
+      <OWNER_U>1</OWNER_U>
+      <OWNER_M>1</OWNER_M>
+      <OWNER_A>0</OWNER_A>
+      <GROUP_U>0</GROUP_U>
+      <GROUP_M>0</GROUP_M>
+      <GROUP_A>0</GROUP_A>
+      <OTHER_U>0</OTHER_U>
+      <OTHER_M>0</OTHER_M>
+      <OTHER_A>0</OTHER_A>
+    </PERMISSIONS>
+    <LAST_POLL>1414588018</LAST_POLL>
+    <STATE>3</STATE>
+    <LCM_STATE>12</LCM_STATE>
+    <RESCHED>0</RESCHED>
+    <STIME>1414587675</STIME>
+    <ETIME>0</ETIME>
+    <DEPLOY_ID>one-46083</DEPLOY_ID>
+    <MEMORY>2097152</MEMORY>
+    <CPU>0</CPU>
+    <NET_TX>3072</NET_TX>
+    <NET_RX>0</NET_RX>
+    <TEMPLATE>
+      <AUTOMATIC_REQUIREMENTS><![CDATA[CLUSTER_ID = 100 & !(PUBLIC_CLOUD = YES)]]></AUTOMATIC_REQUIREMENTS>
+      <CPU><![CDATA[1]]></CPU>
+      <DISK>
+        <BUS><![CDATA[ide]]></BUS>
+        <CLONE><![CDATA[YES]]></CLONE>
+        <CLONE_TARGET><![CDATA[SYSTEM]]></CLONE_TARGET>
+        <CLUSTER_ID><![CDATA[100]]></CLUSTER_ID>
+        <DATASTORE><![CDATA[default]]></DATASTORE>
+        <DATASTORE_ID><![CDATA[1]]></DATASTORE_ID>
+        <DEV_PREFIX><![CDATA[xvd]]></DEV_PREFIX>
+        <DISK_ID><![CDATA[0]]></DISK_ID>
+        <DRIVER><![CDATA[tap2:tapdisk:aio:]]></DRIVER>
+        <IMAGE><![CDATA[monitoring]]></IMAGE>
+        <IMAGE_ID><![CDATA[31]]></IMAGE_ID>
+        <LN_TARGET><![CDATA[SYSTEM]]></LN_TARGET>
+        <READONLY><![CDATA[NO]]></READONLY>
+        <SAVE><![CDATA[NO]]></SAVE>
+        <SIZE><![CDATA[106]]></SIZE>
+        <SOURCE><![CDATA[/opt/opennebula/var/datastores/1/a8e87be2fdafadadd5575d73d4946d47]]></SOURCE>
+        <TARGET><![CDATA[xvda]]></TARGET>
+        <TM_MAD><![CDATA[ssh]]></TM_MAD>
+        <TYPE><![CDATA[FILE]]></TYPE>
+      </DISK>
+      <MEMORY><![CDATA[2048]]></MEMORY>
+      <NAME><![CDATA[one-46083]]></NAME>
+      <NIC>
+        <BRIDGE><![CDATA[xenbr0]]></BRIDGE>
+        <CLUSTER_ID><![CDATA[100]]></CLUSTER_ID>
+        <IP><![CDATA[192.168.254.26]]></IP>
+        <IP6_LINK><![CDATA[fe80::400:c0ff:fea8:fe1a]]></IP6_LINK>
+        <MAC><![CDATA[02:00:c0:a8:fe:1a]]></MAC>
+        <NETWORK><![CDATA[monitoring]]></NETWORK>
+        <NETWORK_ID><![CDATA[6]]></NETWORK_ID>
+        <NIC_ID><![CDATA[0]]></NIC_ID>
+        <VLAN><![CDATA[NO]]></VLAN>
+      </NIC>
+      <OS>
+        <BOOTLOADER><![CDATA[pygrub]]></BOOTLOADER>
+      </OS>
+      <RAW>
+        <TYPE><![CDATA[xen]]></TYPE>
+      </RAW>
+      <VCPU><![CDATA[1]]></VCPU>
+      <VMID><![CDATA[46083]]></VMID>
+    </TEMPLATE>
+    <USER_TEMPLATE>
+      <ARCHITECTURE><![CDATA[x86]]></ARCHITECTURE>
+      <DESCRIPTION><![CDATA[Instantiated with rOCCI-server on Wed, 29 Oct 2014 14:01:15 +0100.]]></DESCRIPTION>
+      <OCCI_COMPUTE_MIXINS><![CDATA[http://occi.localhost/occi/infrastructure/os_tpl#uuid_monitoring_20 http://schema.fedcloud.egi.eu/occi/infrastructure/resource_tpl#small http://opennebula.org/occi/infrastructure#compute]]></OCCI_COMPUTE_MIXINS>
+      <OCCI_ID><![CDATA[46083]]></OCCI_ID>
+    </USER_TEMPLATE>
+    <HISTORY_RECORDS>
+      <HISTORY>
+        <OID>46083</OID>
+        <SEQ>0</SEQ>
+        <HOSTNAME>localhost</HOSTNAME>
+        <HID>17</HID>
+        <CID>100</CID>
+        <STIME>1414587683</STIME>
+        <ETIME>0</ETIME>
+        <VMMMAD>xen</VMMMAD>
+        <VNMMAD>802.1Q</VNMMAD>
+        <TMMAD>ssh</TMMAD>
+        <DS_LOCATION>/opt/opennebula/var/datastores</DS_LOCATION>
+        <DS_ID>0</DS_ID>
+        <PSTIME>1414587683</PSTIME>
+        <PETIME>1414587685</PETIME>
+        <RSTIME>1414587685</RSTIME>
+        <RETIME>0</RETIME>
+        <ESTIME>0</ESTIME>
+        <EETIME>0</EETIME>
+        <REASON>0</REASON>
+        <ACTION>3</ACTION>
+      </HISTORY>
+    </HISTORY_RECORDS>
+  </VM>

data/mock/one_worker_vm5.xml

@@ -0,0 +1,106 @@
+<VM>
+    <ID>46083</ID>
+    <UID>120</UID>
+    <GID>103</GID>
+    <UNAME>local_ops</UNAME>
+    <GNAME>ops</GNAME>
+    <NAME>EGI-SAM</NAME>
+    <PERMISSIONS>
+      <OWNER_U>1</OWNER_U>
+      <OWNER_M>1</OWNER_M>
+      <OWNER_A>0</OWNER_A>
+      <GROUP_U>0</GROUP_U>
+      <GROUP_M>0</GROUP_M>
+      <GROUP_A>0</GROUP_A>
+      <OTHER_U>0</OTHER_U>
+      <OTHER_M>0</OTHER_M>
+      <OTHER_A>0</OTHER_A>
+    </PERMISSIONS>
+    <LAST_POLL>1414588018</LAST_POLL>
+    <STATE>3</STATE>
+    <LCM_STATE>12</LCM_STATE>
+    <RESCHED>0</RESCHED>
+    <STIME>1414587675</STIME>
+    <ETIME>0</ETIME>
+    <DEPLOY_ID>one-46083</DEPLOY_ID>
+    <MEMORY>2097152</MEMORY>
+    <CPU>0</CPU>
+    <NET_TX>3072</NET_TX>
+    <NET_RX>0</NET_RX>
+    <TEMPLATE>
+      <AUTOMATIC_REQUIREMENTS><![CDATA[CLUSTER_ID = 100 & !(PUBLIC_CLOUD = YES)]]></AUTOMATIC_REQUIREMENTS>
+      <CPU><![CDATA[1]]></CPU>
+      <DISK>
+        <BUS><![CDATA[ide]]></BUS>
+        <CLONE><![CDATA[YES]]></CLONE>
+        <CLONE_TARGET><![CDATA[SYSTEM]]></CLONE_TARGET>
+        <CLUSTER_ID><![CDATA[100]]></CLUSTER_ID>
+        <DATASTORE><![CDATA[default]]></DATASTORE>
+        <DATASTORE_ID><![CDATA[1]]></DATASTORE_ID>
+        <DEV_PREFIX><![CDATA[xvd]]></DEV_PREFIX>
+        <DISK_ID><![CDATA[0]]></DISK_ID>
+        <DRIVER><![CDATA[tap2:tapdisk:aio:]]></DRIVER>
+        <IMAGE><![CDATA[monitoring]]></IMAGE>
+        <IMAGE_ID><![CDATA[31]]></IMAGE_ID>
+        <LN_TARGET><![CDATA[SYSTEM]]></LN_TARGET>
+        <READONLY><![CDATA[NO]]></READONLY>
+        <SAVE><![CDATA[NO]]></SAVE>
+        <SIZE><![CDATA[106]]></SIZE>
+        <SOURCE><![CDATA[/opt/opennebula/var/datastores/1/a8e87be2fdafadadd5575d73d4946d47]]></SOURCE>
+        <TARGET><![CDATA[xvda]]></TARGET>
+        <TM_MAD><![CDATA[ssh]]></TM_MAD>
+        <TYPE><![CDATA[FILE]]></TYPE>
+      </DISK>
+      <MEMORY><![CDATA[2048]]></MEMORY>
+      <NAME><![CDATA[one-46083]]></NAME>
+      <NIC>
+        <BRIDGE><![CDATA[xenbr0]]></BRIDGE>
+        <CLUSTER_ID><![CDATA[100]]></CLUSTER_ID>
+        <IP><![CDATA[192.168.254.26]]></IP>
+        <IP6_LINK><![CDATA[fe80::400:c0ff:fea8:fe1a]]></IP6_LINK>
+        <MAC><![CDATA[02:00:c0:a8:fe:1a]]></MAC>
+        <NETWORK><![CDATA[monitoring]]></NETWORK>
+        <NETWORK_ID><![CDATA[6]]></NETWORK_ID>
+        <NIC_ID><![CDATA[0]]></NIC_ID>
+        <VLAN><![CDATA[NO]]></VLAN>
+      </NIC>
+      <OS>
+        <BOOTLOADER><![CDATA[pygrub]]></BOOTLOADER>
+      </OS>
+      <RAW>
+        <TYPE><![CDATA[xen]]></TYPE>
+      </RAW>
+      <VCPU><![CDATA[1]]></VCPU>
+      <VMID><![CDATA[46083]]></VMID>
+    </TEMPLATE>
+    <USER_TEMPLATE>
+      <ARCHITECTURE><![CDATA[x86]]></ARCHITECTURE>
+      <OCCI_ID><![CDATA[4040029c-9c13-4b29-9d01-1deb179ee925]]></OCCI_ID>
+      <OCCI_MIXIN><![CDATA[https://occi.localhost/occi/infrastructure/resource_tpl#small]]></OCCI_MIXIN>
+      <OCCI_MIXIN><![CDATA[https://occi.localhost/occi/infrastructure/os_tpl#omr_worker_x86_64_ide_1_0]]></OCCI_MIXIN>
+    </USER_TEMPLATE>
+    <HISTORY_RECORDS>
+      <HISTORY>
+        <OID>46083</OID>
+        <SEQ>0</SEQ>
+        <HOSTNAME>localhost</HOSTNAME>
+        <HID>17</HID>
+        <CID>100</CID>
+        <STIME>1414587683</STIME>
+        <ETIME>0</ETIME>
+        <VMMMAD>xen</VMMMAD>
+        <VNMMAD>802.1Q</VNMMAD>
+        <TMMAD>ssh</TMMAD>
+        <DS_LOCATION>/opt/opennebula/var/datastores</DS_LOCATION>
+        <DS_ID>0</DS_ID>
+        <PSTIME>1414587683</PSTIME>
+        <PETIME>1414587685</PETIME>
+        <RSTIME>1414587685</RSTIME>
+        <RETIME>0</RETIME>
+        <ESTIME>0</ESTIME>
+        <EETIME>0</EETIME>
+        <REASON>0</REASON>
+        <ACTION>3</ACTION>
+      </HISTORY>
+    </HISTORY_RECORDS>
+  </VM>

data/mock/one_worker_vm6.xml

@@ -0,0 +1,107 @@
+<VM>
+    <ID>46083</ID>
+    <UID>120</UID>
+    <GID>103</GID>
+    <UNAME>local_ops</UNAME>
+    <GNAME>ops</GNAME>
+    <NAME>EGI-SAM</NAME>
+    <PERMISSIONS>
+      <OWNER_U>1</OWNER_U>
+      <OWNER_M>1</OWNER_M>
+      <OWNER_A>0</OWNER_A>
+      <GROUP_U>0</GROUP_U>
+      <GROUP_M>0</GROUP_M>
+      <GROUP_A>0</GROUP_A>
+      <OTHER_U>0</OTHER_U>
+      <OTHER_M>0</OTHER_M>
+      <OTHER_A>0</OTHER_A>
+    </PERMISSIONS>
+    <LAST_POLL>1414588018</LAST_POLL>
+    <STATE>3</STATE>
+    <LCM_STATE>12</LCM_STATE>
+    <RESCHED>0</RESCHED>
+    <STIME>1414587675</STIME>
+    <ETIME>0</ETIME>
+    <DEPLOY_ID>one-46083</DEPLOY_ID>
+    <MEMORY>2097152</MEMORY>
+    <CPU>0</CPU>
+    <NET_TX>3072</NET_TX>
+    <NET_RX>0</NET_RX>
+    <TEMPLATE>
+      <AUTOMATIC_REQUIREMENTS><![CDATA[CLUSTER_ID = 100 & !(PUBLIC_CLOUD = YES)]]></AUTOMATIC_REQUIREMENTS>
+      <CPU><![CDATA[1]]></CPU>
+      <DISK>
+        <BUS><![CDATA[ide]]></BUS>
+        <CLONE><![CDATA[YES]]></CLONE>
+        <CLONE_TARGET><![CDATA[SYSTEM]]></CLONE_TARGET>
+        <CLUSTER_ID><![CDATA[100]]></CLUSTER_ID>
+        <DATASTORE><![CDATA[default]]></DATASTORE>
+        <DATASTORE_ID><![CDATA[1]]></DATASTORE_ID>
+        <DEV_PREFIX><![CDATA[xvd]]></DEV_PREFIX>
+        <DISK_ID><![CDATA[0]]></DISK_ID>
+        <DRIVER><![CDATA[tap2:tapdisk:aio:]]></DRIVER>
+        <IMAGE><![CDATA[monitoring]]></IMAGE>
+        <IMAGE_ID><![CDATA[31]]></IMAGE_ID>
+        <LN_TARGET><![CDATA[SYSTEM]]></LN_TARGET>
+        <READONLY><![CDATA[NO]]></READONLY>
+        <SAVE><![CDATA[NO]]></SAVE>
+        <SIZE><![CDATA[106]]></SIZE>
+        <SOURCE><![CDATA[/opt/opennebula/var/datastores/1/a8e87be2fdafadadd5575d73d4946d47]]></SOURCE>
+        <TARGET><![CDATA[xvda]]></TARGET>
+        <TM_MAD><![CDATA[ssh]]></TM_MAD>
+        <TYPE><![CDATA[FILE]]></TYPE>
+      </DISK>
+      <MEMORY><![CDATA[2048]]></MEMORY>
+      <NAME><![CDATA[one-46083]]></NAME>
+      <NIC>
+        <BRIDGE><![CDATA[xenbr0]]></BRIDGE>
+        <CLUSTER_ID><![CDATA[100]]></CLUSTER_ID>
+        <IP><![CDATA[192.168.254.26]]></IP>
+        <IP6_LINK><![CDATA[fe80::400:c0ff:fea8:fe1a]]></IP6_LINK>
+        <MAC><![CDATA[02:00:c0:a8:fe:1a]]></MAC>
+        <NETWORK><![CDATA[monitoring]]></NETWORK>
+        <NETWORK_ID><![CDATA[6]]></NETWORK_ID>
+        <NIC_ID><![CDATA[0]]></NIC_ID>
+        <VLAN><![CDATA[NO]]></VLAN>
+      </NIC>
+      <OS>
+        <BOOTLOADER><![CDATA[pygrub]]></BOOTLOADER>
+      </OS>
+      <RAW>
+        <TYPE><![CDATA[xen]]></TYPE>
+      </RAW>
+      <VCPU><![CDATA[1]]></VCPU>
+      <VMID><![CDATA[46083]]></VMID>
+    </TEMPLATE>
+    <USER_TEMPLATE>
+      <ARCHITECTURE><![CDATA[x86]]></ARCHITECTURE>
+      <DESCRIPTION><![CDATA[Instantiated with rOCCI-server on Wed, 29 Oct 2014 14:01:15 +0100.]]></DESCRIPTION>
+      <OCCI_COMPUTE_MIXINS><![CDATA[http://occi.localhost/occi/infrastructure/os_tpl#uuid_monitoring_20 http://schema.fedcloud.egi.eu/occi/infrastructure/resource_tpl#small http://opennebula.org/occi/infrastructure#compute]]></OCCI_COMPUTE_MIXINS>
+      <OCCI_ID><![CDATA[46083]]></OCCI_ID>
+      <USER_X509_DN><![CDATA[/MY=STuPID/CN=DN/CN=HERE]]></USER_X509_DN>
+    </USER_TEMPLATE>
+    <HISTORY_RECORDS>
+      <HISTORY>
+        <OID>46083</OID>
+        <SEQ>0</SEQ>
+        <HOSTNAME>localhost</HOSTNAME>
+        <HID>17</HID>
+        <CID>100</CID>
+        <STIME>1414587683</STIME>
+        <ETIME>0</ETIME>
+        <VMMMAD>xen</VMMMAD>
+        <VNMMAD>802.1Q</VNMMAD>
+        <TMMAD>ssh</TMMAD>
+        <DS_LOCATION>/opt/opennebula/var/datastores</DS_LOCATION>
+        <DS_ID>0</DS_ID>
+        <PSTIME>1414587683</PSTIME>
+        <PETIME>1414587685</PETIME>
+        <RSTIME>1414587685</RSTIME>
+        <RETIME>0</RETIME>
+        <ESTIME>0</ESTIME>
+        <EETIME>0</EETIME>
+        <REASON>0</REASON>
+        <ACTION>3</ACTION>
+      </HISTORY>
+    </HISTORY_RECORDS>
+  </VM>

data/oneacct-export.gemspec

@@ -13,10 +13,11 @@ Gem::Specification.new do |spec|
   spec.homepage      = ''
   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.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.required_ruby_version = '>= 2.0.0'
 
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rake', '~> 10.0'
@@ -26,6 +27,6 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'opennebula', '~> 4.6.0'
   spec.add_runtime_dependency 'syslogger', '~> 1.6.0'
-  spec.add_runtime_dependency 'sidekiq', '= 3.2.0'
+  spec.add_runtime_dependency 'sidekiq', '~> 3.2.6'
   spec.add_runtime_dependency 'settingslogic', '~> 2.0.9'
 end

data/spec/one_worker_spec.rb

@@ -163,9 +163,8 @@ describe OneWorker do
       data['site_name'] = 'Hogwarts'
       data['cloud_type'] = 'OpenNebula'
       data['vm_uuid'] = '36551'
-      data['start_time'] = '1383741160'
-      data['start_time_readable'] = '2013-11-06 13:32:40+01:00'
-      data['end_time'] = '1383742270'
+      data['start_time'] = Time.at(1383741160)
+      data['end_time'] = Time.at(1383742270)
       data['machine_name'] = 'one-36551'
       data['user_id'] = '120'
       data['group_id'] = '0'
@@ -535,6 +534,45 @@ describe OneWorker do
         expect(subject.process_vm(vm, user_map, image_map)).to eq(data)
       end
     end
+
+    context 'vm with USER_TEMPLATE/OCCI_COMPUTE_MIXINS' do
+      let(:filename) { 'one_worker_vm4.xml' }
+      let(:image_name) { 'http://occi.localhost/occi/infrastructure/os_tpl#uuid_monitoring_20' }
+
+      it 'w/o map info uses os_tpl mixin' do
+        expect(subject.process_vm(vm, user_map, {})['image_name']).to eq(image_name)
+      end
+
+      it 'w/ map info uses map info' do
+        expect(subject.process_vm(vm, user_map, image_map)['image_name']).to eq(data['image_name'])
+      end
+    end
+
+    context 'vm with USER_TEMPLATE/OCCI_MIXIN' do
+      let(:filename) { 'one_worker_vm5.xml' }
+      let(:image_name) { 'https://occi.localhost/occi/infrastructure/os_tpl#omr_worker_x86_64_ide_1_0' }
+
+      it 'w/o map info uses os_tpl mixin' do
+        expect(subject.process_vm(vm, user_map, {})['image_name']).to eq(image_name)
+      end
+
+      it 'w/ map info uses map info' do
+        expect(subject.process_vm(vm, user_map, image_map)['image_name']).to eq(data['image_name'])
+      end
+    end
+
+    context 'vm with USER_TEMPLATE/USER_X509_DN' do
+      let(:filename) { 'one_worker_vm6.xml' }
+      let(:user_name) { '/MY=STuPID/CN=DN/CN=HERE' }
+
+      it 'w/o map info uses USER_X509_DN' do
+        expect(subject.process_vm(vm, user_map, {})['user_name']).to eq(user_name)
+      end
+
+      it 'w/ map info uses USER_X509_DN' do
+        expect(subject.process_vm(vm, user_map, image_map)['user_name']).to eq(user_name)
+      end
+    end
   end
 
   describe '.sum_rstime' do
@@ -617,9 +655,8 @@ describe OneWorker do
       data['site_name'] = 'Hogwarts'
       data['cloud_type'] = 'OpenNebula'
       data['vm_uuid'] = '36551'
-      data['start_time'] = '1383741160'
-      data['start_time_readable'] = '2013-11-06 13:32:40+01:00'
-      data['end_time'] = '1383742270'
+      data['start_time'] = Time.at(1383741160)
+      data['end_time'] = Time.at(1383742270)
       data['machine_name'] = 'one-36551'
       data['user_id'] = '120'
       data['group_id'] = '0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oneacct-export
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Michal Kimle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-07 00:00:00.000000000 Z
+date: 2014-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -112,16 +112,16 @@ dependencies:
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 3.2.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 3.2.6
 - !ruby/object:Gem::Dependency
   name: settingslogic
   requirement: !ruby/object:Gem::Requirement
@@ -145,6 +145,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
+- ".yardopts"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -211,6 +213,9 @@ files:
 - mock/one_worker_vm1.xml
 - mock/one_worker_vm2.xml
 - mock/one_worker_vm3.xml
+- mock/one_worker_vm4.xml
+- mock/one_worker_vm5.xml
+- mock/one_worker_vm6.xml
 - mock/one_writer_testfile
 - oneacct-export.gemspec
 - spec/one_data_accessor_spec.rb
@@ -232,7 +237,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -252,3 +257,4 @@ test_files:
 - spec/oneacct_opts_spec.rb
 - spec/redis_conf_spec.rb
 - spec/spec_helper.rb
+has_rdoc: