bookie_accounting 0.0.1

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.sqlite
+snapshot/*_generated
+

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Ben Merritt
+
+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,29 @@
+# Bookie
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'bookie'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bookie
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,15 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+task :default => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts =%w{--color --format progress}
+  task.pattern = 'spec/*_spec.rb'
+end
+
+task :docs do
+  system("rdoc rdoc lib")
+end

data/bin/bookie-create-tables

@@ -0,0 +1,52 @@
+#!/usr/bin/env ruby
+
+#For development
+#$LOAD_PATH << 'lib'
+
+require 'optparse'
+
+require 'bookie/database'
+
+config_file = '/etc/bookie/config.json'
+drop = false
+
+opts = OptionParser.new do |opts|
+  opts.banner = "bookie-create-tables [options]"
+  
+  opts.on('-c', '--config FILE', String, "use the given configuration file") do |file|
+    config_file = file
+  end
+  
+  opts.on("--drop", "drop all tables") do
+    drop = true
+  end
+end
+begin
+  opts.parse!(ARGV)
+rescue OptionParser::ParseError => e
+  puts e.message
+  puts opts
+  exit 1
+end
+
+config = Bookie::Config.new(config_file)
+config.connect
+
+if drop
+  STDOUT.write "Are you sure? This will destroy all tables in the database. "
+  response = nil
+  until response
+    response = STDIN.gets.chomp
+    case response
+    when "YES"
+      Bookie::Database::Migration.down
+    when /^NO$/i
+      exit 0
+    else
+      $stdout.write "Please answer 'YES' or 'NO'. "
+      response = nil
+    end
+  end
+else
+  Bookie::Database::Migration.up
+end

data/bin/bookie-data

@@ -0,0 +1,102 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+
+#For development
+#$LOAD_PATH << 'lib'
+
+require 'bookie/formatter'
+
+jobs = Bookie::Database::Job
+systems = Bookie::Database::System
+
+config_filename = '/etc/bookie/config.json'
+include_details = false
+
+output_type = :stdout
+filename = nil
+
+t_min = nil
+t_max = nil
+
+#Process arguments
+
+#The first run only gets the configuration filename
+ARGV.each_with_index do |value, i|
+  if value == '-c' || value == '--config'
+    v = ARGV[i + 1]
+    #If the argument is missing, ignore it; OptionParser will catch it later.
+    config_filename = v if v
+  end
+end
+
+config = Bookie::Config.new(config_filename)
+config.connect
+
+opts = OptionParser.new do |opts|
+  opts.banner = "Usage: bookie-data [options]"
+  
+  opts.on('-c', '--config FILE', String, "use the given configuration file") do |file|
+    #This is just here so it shows up in the message.
+  end
+  
+  opts.on('-d', '--details', "include full details") do
+    include_details = true
+  end
+  
+  opts.on('-u', '--user NAME', "filter by username") do |name|
+    jobs = jobs.by_user_name(name)
+  end
+  
+  opts.on('-g', '--group NAME' "filter by group") do |name|
+    jobs = jobs.by_group_name(name)
+  end
+  
+  opts.on('-s', '--system HOSTNAME', "filter by system") do |hostname|
+    jobs = jobs.by_system_name(hostname)
+    systems = systems.by_name(hostname)
+  end
+  
+  opts.on('-t', '--type TYPE', "filter by system type") do |type|
+    t = Bookie::Database::SystemType.find_by_name(type)
+    unless t
+      STDERR.puts "Unknown system type '#{type}'"
+      exit 1
+    end
+    jobs = jobs.by_system_type(t)
+    systems = systems.by_system_type(t)
+  end
+  
+  opts.on('-r', '--time BEGIN,END', Array, "filter by a time range") do |t|
+    t_min = Time.parse(t[0])
+    t_max = Time.parse(t[1])
+  end
+  
+  opts.on('-o', '--output-file FILENAME', "send formatted output to FILENAME",
+    "Output format is inferred from the filename extension.") do |output_filename|
+    filename = output_filename
+    case filename
+    when /\.xls$/
+      output_type = :spreadsheet
+    when /\.csv$/
+      output_type = :comma_dump
+    else
+      $stderr.puts "Unrecognized output file extension"
+      exit 1
+    end
+  end
+end
+begin
+  opts.parse!(ARGV)
+rescue OptionParser::ParseError => e
+  STDERR.puts e.message
+  STDERR.puts opts
+  exit 1
+end
+
+formatter = Bookie::Formatter.new(output_type, filename)
+
+jobs_summary, systems_summary = formatter.print_summary(jobs, systems, t_min, t_max)
+jobs = jobs.by_time_range_inclusive(t_min, t_max) if t_min
+formatter.print_jobs(jobs_summary[:jobs]) if include_details
+formatter.flush

data/bin/bookie-send

@@ -0,0 +1,110 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+
+#For development:
+#$LOAD_PATH << 'lib'
+
+#To consider: restore for production?
+=begin
+unless Process.uid == 0
+  $stderr.puts "This command must be run as root."
+  exit 1
+end
+=end
+
+require 'bookie/sender'
+
+config_file = '/etc/bookie/config.json'
+will_create = false
+will_decommission = false
+system_start_time = nil
+system_hostname = nil
+system_end_time = nil
+
+opts = OptionParser.new do |opts|
+  opts.banner = "Usage: bookie-send [data-file] [options]"
+  
+  opts.on('-c', '--config FILE', String, "use the given configuration file") do |file|
+    config_file = file
+  end
+  
+  opts.on("--create [TIME]",
+  "Create an entry for this system, recording the given time as its start time") do |time|
+    will_create = true
+    system_start_time = Time.parse(time) if time
+  end
+  
+  opts.on("--decommission [HOSTNAME [TIME]]",
+  String, String,
+  "Decommission the system with the given hostname, recording the given time as its end time") do |hostname, time|
+    will_decommission = true
+    system_hostname = hostname if hostname
+    system_end_time = Time.parse(time) if time
+  end
+end
+begin
+  opts.parse!(ARGV)
+rescue OptionParser::ParseError => e
+  puts e.message
+  puts opts
+  exit 1
+end
+
+config = Bookie::Config.new(config_file)
+config.connect
+
+filename = ARGV[0]
+fail("No operation specified") unless filename || will_create || will_decommission
+
+if filename
+  sender = Bookie::Sender.new(config)
+  sender.send_data(filename)
+end
+
+if will_decommission
+  system_hostname ||= config.hostname
+  system_end_time ||= Time.now
+  Bookie::Database::Lock[:systems].synchronize do
+    system = Bookie::Database::System.active_systems.find_by_name(system_hostname)
+    if system
+      puts "Note: make sure that all of this system's jobs have been recorded in the database before decommissioning it."
+      STDOUT.write "Decommission this system? "
+      response = nil
+      until response
+        response = STDIN.gets.chomp.downcase
+        case response
+        when "yes"
+          system.decommission(system_end_time)
+        when "no"
+          exit 0
+        else
+          STDOUT.write("Please answer 'yes' or 'no'.")
+          response = nil
+        end
+      end
+    else
+      stderr.puts "No active system with hostname #{system_hostname}"
+      exit 1
+    end
+  end
+end
+
+if will_create
+  system_start_time ||= Time.now
+  Bookie::Database::Lock[:systems].synchronize do
+    system = Bookie::Database::System.active_systems.find_by_name(config.hostname)
+    if system
+      stderr.puts "An active system is already in the database with hostname '#{config.hostname}'."
+      exit 1
+    end
+  end
+  Bookie::Database::System.create!(
+    :name => config.hostname,
+    :system_type => Bookie::Sender.new(config).system_type,
+    :start_time => system_start_time,
+    :end_time => nil,
+    :cores => config.cores,
+    :memory => config.memory
+  )
+end

data/bookie_accounting.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/bookie/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Ben Merritt"]
+  gem.email         = ["blm768@gmail.com"]
+  gem.description   = %q{A simple system to record and query process accounting records}
+  gem.summary       = %q{A simple system to record and query process accounting records}
+  gem.homepage      = "https://github.com/blm768/bookie/"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(spec)/})
+  gem.name          = "bookie_accounting"
+  gem.require_paths = ["lib"]
+  gem.version       = Bookie::VERSION
+  
+  gem.add_dependency('json')
+  gem.add_dependency('activerecord')
+  #For some reason, this is needed for Ruby 1.8.7 using RVM on CentOS.
+  #To do: remove when no longer needed
+  gem.add_dependency('mysql2')
+  gem.add_dependency('pacct')
+  gem.add_dependency('spreadsheet')
+  gem.add_development_dependency('mocha')
+  gem.add_development_dependency('rspec')
+  gem.add_development_dependency('sqlite3')
+end

data/lib/bookie.rb

@@ -0,0 +1,11 @@
+require "bookie/version"
+
+require "bookie/config"
+require "bookie/database"
+require "bookie/formatter"
+require "bookie/sender"
+
+#The Bookie root module
+module Bookie
+  # Your code goes here...
+end

data/lib/bookie/config.rb

@@ -0,0 +1,101 @@
+require 'active_record'
+require 'json'
+require 'logger'
+require 'set'
+
+module Bookie
+  ##
+  #Holds database configuration, etc. for Bookie components
+  class Config
+    #The database type
+    #
+    #Corresponds to ActiveRecord database adapter name
+    attr_accessor :db_type
+    #The database server's hostname
+    attr_accessor :server
+    #The database server's port
+    #
+    #If nil, use the default port.
+    attr_accessor :port
+    #The name of the database to use
+    attr_accessor :database
+    #The username for the database
+    attr_accessor :username
+    #The password for the database
+    attr_accessor :password
+    #A set containing the names of users to be excluded
+    attr_accessor :excluded_users
+    #The system type
+    attr_accessor :system_type
+    #The system's hostname
+    attr_accessor :hostname
+    #The number of cores on the system
+    attr_accessor :cores
+    #The RAM (in KB) in the system
+    attr_accessor :memory
+       
+    ##
+    #Creates a new Config object using values from the provided JSON file
+    def initialize(filename)
+      file = File.open(filename)
+      data = JSON::parse(file.read)
+      file.close
+      
+      @db_type = data['Database type']
+      verify_type(@db_type, 'Database type', String)
+      
+      @server = data['Server']
+      verify_type(@server, 'Server', String)
+      @port = data['Port']
+      verify_type(@port, 'Port', Integer) unless @port == nil
+      
+      @database = data['Database']
+      verify_type(@database, 'Database', String)
+      @username = data['Username']
+      verify_type(@username, 'Username', String)
+      @password = data['Password']
+      verify_type(@password, 'Password', String)
+      
+      excluded_users_array = data['Excluded users'] || []
+      verify_type(excluded_users_array, 'Excluded users', Array)
+      @excluded_users = Set.new(excluded_users_array)
+      
+      @system_type = data['System type']
+      verify_type(@system_type, 'System type', String)
+      
+      @hostname = data['Hostname']
+      verify_type(@hostname, 'Hostname', String)
+      
+      @cores = data['Cores']
+      verify_type(@cores, 'Cores', Integer)
+      
+      @memory = data['Memory']
+      verify_type(@memory, 'Memory', Integer)
+    end
+    
+    #Verifies that a field is of the correct type, raising an error if the type does not match
+    def verify_type(value, name, type)
+      if value == nil
+        raise "Field \"#{name}\" must have a non-null value."
+      end
+      raise TypeError.new("Invalid data type #{value.class} for JSON field \"#{name}\": #{type} expected") unless value.class <= type
+    end
+    
+    #Connects to the database specified in the configuration file
+    def connect()
+      #To consider: disable colorized logging?
+      #To consider: create config option for this?
+      #ActiveRecord::Base.logger = Logger.new(STDERR)
+      #ActiveRecord::Base.logger.level = Logger::WARN
+      ActiveRecord::Base.time_zone_aware_attributes = true
+      ActiveRecord::Base.default_timezone = :utc
+      ActiveRecord::Base.establish_connection(
+        :adapter  => self.db_type,
+        :database => self.database,
+        :username => self.username,
+        :password => self.password,
+        :host     => self.server,
+        :port     => self.port)
+    end
+  end
+end