cloud_cost_tracker 0.1.0

data/spec/lib/cloud_cost_tracker/models/billing_code_spec.rb

@@ -0,0 +1,35 @@
+module CloudCostTracker
+  module Billing
+    describe BillingCode do
+      before(:each) do
+        @existing_code = BillingCode.create!(
+          :key => 'fake key', :value => 'fake value'
+        )
+      end
+
+      after(:each) do
+        @existing_code.destroy
+      end
+
+      it "is valid with valid attributes" do
+        @existing_code.should be_valid
+      end
+
+      it "is not valid without a key" do
+        @existing_code.key = nil
+        @existing_code.should_not be_valid
+      end
+      it "is valid without a value" do
+        @existing_code.value = nil
+        @existing_code.should be_valid
+      end
+
+      #it "is not valid if an identical code is already saved" do
+      #  BillingCode.new(
+      #    :key => 'fake key', :value => 'fake value'
+      #  ).should_not be_valid
+      #end
+
+    end
+  end
+end

data/spec/lib/cloud_cost_tracker/models/billing_record_spec.rb

@@ -0,0 +1,206 @@
+module CloudCostTracker
+module Billing
+describe BillingRecord do
+
+  # some constants for a generic BillingRecord
+  @stop_time  = Time.now
+  @start_time = Time.now - FogTracker::DEFAULT_POLLING_TIME
+  @hourly_rate = 5.0
+  RECORD_PARAMETERS = {
+    :provider       => "fake_provider_name",
+    :service        => "fake_service_name",
+    :account        => "fake_account_ID",
+    :resource_id    => "fake_resource_ID",
+    :resource_type  => "fake_resource_type",
+    :billing_type   => "fake_billing_type",
+    :start_time     => @start_time,
+    :stop_time      => @stop_time,
+    :cost_per_hour  => @hourly_rate,
+    :total_cost     => ((@stop_time - @start_time) * @hourly_rate) / 3600,
+  }
+  # A day in the distant future
+  NEW_YEARS_DAY_3000 = Time.gm(3000, 1, 1, 0, 0, 0)
+
+  before(:each) do
+    BillingRecord.delete_all ; BillingCode.delete_all   # clean database
+    # Make a "current" billing record
+    @existing_bill = BillingRecord.create!(RECORD_PARAMETERS)
+    # Make a billing record that follows the existing one in time
+    @next_bill = BillingRecord.new(RECORD_PARAMETERS.merge(
+            :start_time => RECORD_PARAMETERS[:stop_time],
+            :stop_time  => RECORD_PARAMETERS[:stop_time] + 3600
+          ))
+  end
+
+  after(:each) do
+    BillingRecord.delete_all ; BillingCode.delete_all   # clean database
+  end
+
+  it "is valid with valid attributes" do
+    @existing_bill.should be_valid
+  end
+
+  it "is not valid without a provider name" do
+    @existing_bill.provider = nil
+    @existing_bill.should_not be_valid
+  end
+  it "is not valid without a service name" do
+    @existing_bill.service = nil
+    @existing_bill.should_not be_valid
+  end
+  it "is not valid without an account name" do
+    @existing_bill.account = nil
+    @existing_bill.should_not be_valid
+  end
+  it "is not valid without a resource ID" do
+    @existing_bill.resource_id = nil
+    @existing_bill.should_not be_valid
+  end
+  it "is not valid without a resource type" do
+    @existing_bill.resource_type = nil
+    @existing_bill.should_not be_valid
+  end
+  it "is not valid without a billing type" do
+    @existing_bill.billing_type = nil
+    @existing_bill.should_not be_valid
+  end
+  it "is not valid without a start time" do
+    @existing_bill.start_time = nil
+    @existing_bill.should_not be_valid
+  end
+  it "is not valid without a stop time" do
+    @existing_bill.stop_time = nil
+    @existing_bill.should_not be_valid
+  end
+  it "is not valid without an hourly cost" do
+    @existing_bill.cost_per_hour = nil
+    @existing_bill.should_not be_valid
+  end
+  it "is not valid without a total cost" do
+    @existing_bill.total_cost = nil
+    @existing_bill.should_not be_valid
+  end
+  it "validates its associated billing codes" do
+    new_record = BillingRecord.new(RECORD_PARAMETERS)
+    new_record.billing_codes = [BillingCode.new]
+    new_record.should_not be_valid
+  end
+
+  describe '#most_recent_like' do
+    context "when invoked with a BillingRecord" do
+      context "and a record for the same resource / billing type exists" do
+        it 'returns the most recent BillingRecord for the same resource' do
+          BillingRecord.most_recent_like(@next_bill).should == @existing_bill
+        end
+      end
+      context "and no record for the same resource / billing type exists" do
+        it 'returns nil' do
+          BillingRecord.delete_all
+          BillingRecord.most_recent_like(@next_bill).should == nil
+        end
+      end
+    end
+  end
+
+  describe '#overlaps_with' do
+    context "when invoked with a BillingRecord far away in time" do
+      it "returns false" do
+        @next_bill.start_time = NEW_YEARS_DAY_3000
+        @next_bill.stop_time  = NEW_YEARS_DAY_3000 + 3600
+        @existing_bill.overlaps_with(@next_bill).should == false
+      end
+
+    end
+    context "when invoked with a BillingRecord adjacent in time" do
+      it "returns true" do
+        @existing_bill.overlaps_with(@next_bill).should == true
+      end
+    end
+    context "when invoked with a BillingRecord overlapping in time" do
+      it "returns true" do
+        @next_bill.start_time = RECORD_PARAMETERS[:stop_time] - 1
+        @next_bill.stop_time  = RECORD_PARAMETERS[:stop_time] + 3600
+        @existing_bill.overlaps_with(@next_bill).should == true
+      end
+    end
+  end
+
+  describe '#merge_with with an existing BillingRecord' do
+    it "copies the stop time of the current record onto the existing record" do
+      @next_bill.stop_time = NEW_YEARS_DAY_3000
+      @existing_bill.merge_with @next_bill
+      @existing_bill.stop_time.should == NEW_YEARS_DAY_3000
+    end
+    it "updates the total for the existing record" do
+      # Run an update that causes the @existing_bill's total to double
+      duration = (@existing_bill.stop_time - @existing_bill.start_time)
+      @next_bill.stop_time = @existing_bill.stop_time + duration
+      @existing_bill.merge_with @next_bill
+      @existing_bill.total_cost.should == 2 * RECORD_PARAMETERS[:total_cost]
+    end
+  end
+
+  describe '#set_codes' do
+    context 'when invoked on a saved (existing) BillingRecord' do
+      before(:each) {@existing_code = BillingCode.create!(:key=>'k', :value=>'v')}
+      context "with a key, value pair that matches an existing BillingCode" do
+        it "associates with the existing BillingCode" do
+          @existing_bill.set_codes [['k', 'v']]
+          @existing_bill.billing_codes.should == [@existing_code]
+          @existing_bill.should be_valid
+        end
+      end
+      context "with a key, value pair that matches no existing BillingCode" do
+        it "creates a new BillingCode and associates with it" do
+          @existing_bill.billing_codes.should == Array.new
+          @existing_bill.set_codes [['k', 'v']]
+          @existing_bill.billing_codes.should == [@existing_code]
+          @existing_bill.should be_valid
+        end
+      end
+    end
+    context 'when invoked on a new, unsaved BillingRecord' do
+      before(:each) { @new_bill = BillingRecord.new(RECORD_PARAMETERS) }
+      context "with a key, value pair that matches an existing BillingCode" do
+        it "associates with the existing BillingCode" do
+          BillingCode.all.should == Array.new
+          existing_code = BillingCode.create!(:key => 'k', :value => 'v')
+          @new_bill.set_codes [['k', 'v']]
+          @new_bill.billing_codes.should == [existing_code]
+          @new_bill.should be_valid
+        end
+      end
+      context "with a key, value pair that matches no existing BillingCode" do
+        it "creates a new BillingCode and associates with it" do
+          BillingCode.all.should == Array.new
+          @new_bill.billing_codes.should == Array.new
+          @new_bill.set_codes [['k', 'v']]
+          @new_bill.billing_codes.size.should == 1
+          @new_bill.billing_codes.first.key.should == 'k'
+          @new_bill.billing_codes.first.value.should == 'v'
+          @new_bill.should be_valid
+        end
+      end
+    end
+  end
+
+  describe '#to_hash' do
+    it "returns a Hash of the record's attributes" do
+      @existing_bill.billing_codes = [
+        BillingCode.new(:key => 'key1', :value => 'val1'),
+        BillingCode.new(:key => 'key2', :value => 'val2'),
+      ]
+      @existing_bill.to_hash['provider'].should == "fake_provider_name"
+      @existing_bill.to_hash['service'].should == "fake_service_name"
+      @existing_bill.to_hash['account'].should == "fake_account_ID"
+      @existing_bill.to_hash['resource_id'].should == "fake_resource_ID"
+      @existing_bill.to_hash['resource_type'].should == "fake_resource_type"
+      @existing_bill.to_hash['billing_type'].should == "fake_billing_type"
+      @existing_bill.to_hash['billing_codes'].should ==
+        [['key1', 'val1'], ['key2', 'val2']]
+    end
+  end
+
+end
+end
+end

data/spec/lib/cloud_cost_tracker/tracker_spec.rb

@@ -0,0 +1,37 @@
+module CloudCostTracker
+  describe Tracker do
+
+    before(:each) do
+      @tracker = Tracker.new(FAKE_ACCOUNTS)
+      Billing::BillingRecord.delete_all
+    end
+
+    after(:each) do
+      Billing::BillingRecord.delete_all
+    end
+
+    describe '#update' do
+      before(:each) do
+        @resource = FAKE_AWS.servers.new
+        @resource.stub(:tracker_account).and_return(FAKE_ACCOUNT)
+        @resource.stub(:identity).and_return "fake server ID"
+        @resource.stub(:status).and_return "running"
+        FogTracker::AccountTracker.any_instance.stub(:all_resources).
+          and_return([ @resource ])
+      end
+
+      it "Generates BillingRecords for all Resources in its accounts" do
+        @tracker.update
+        Billing::BillingRecord.all.count.should == 1
+      end
+
+      it "Generates billing codes for all Resources in its accounts" do
+        @resource.stub(:tags).and_return('environment' => 'sandbox')
+        @tracker.update
+        @tracker['*::Compute::AWS::servers'].first.billing_codes.should ==
+          [['environment', 'sandbox']]
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,58 @@
+ENV['RACK_ENV'] ||= 'test'
+Bundler.require # Load all gems and libs
+
+Fog.mock!       # Don't try to connect to the network
+
+FAKE_ACCOUNT_NAME = 'Fake EC2 Account'
+FAKE_ACCOUNT = {
+  :name         => FAKE_ACCOUNT_NAME,
+  :provider     => 'AWS',
+  :service      => 'Compute',
+  :delay        => 10,
+  :credentials  => {
+    :aws_access_key_id => "fake user",
+    :aws_secret_access_key => 'fake password'
+  },
+  :exclude_resources => [
+    :spot_requests,   # No Fog mocks for this resource
+  ],
+}
+FAKE_ACCOUNTS = {FAKE_ACCOUNT_NAME => FAKE_ACCOUNT}
+FAKE_AWS = Fog::Compute.new(
+  :provider => 'AWS',
+  :aws_access_key_id => 'XXXXXXXXXXXXXXXXXXXX',
+  :aws_secret_access_key => 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX',
+)
+FAKE_RDS = Fog::AWS::RDS.new(
+  :aws_access_key_id => 'XXXXXXXXXXXXXXXXXXXX',
+  :aws_secret_access_key => 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX',
+)
+
+## Establish ActiveRecord connection and Migrate database
+# The following db config files are used, in order of preference:
+#   1. ENV['DB_CONFIG_FILE']
+#   2. ./config/database.yml
+#   3. ./config/database.example.yml
+db_conf_file = './config/database.example.yml'
+db_conf_file = './config/database.yml' if File.exists? './config/database.yml'
+if ENV['DB_CONFIG_FILE']
+  db_conf_file = ENV['DB_CONFIG_FILE']
+else
+  ENV['DB_CONFIG_FILE'] = db_conf_file
+end
+puts "Reading DB config file #{db_conf_file}..."
+db_config = YAML::load(File.open(db_conf_file))[CloudCostTracker.env]
+puts "Using DB #{db_config['database']}..."
+ActiveRecord::Base.establish_connection(db_config)
+migration_dir = File.expand_path('../../db/migrate', __FILE__)
+ActiveRecord::Migrator.migrate migration_dir
+
+# Require RSpec support files. Logging is configured there
+support_files = Dir[File.join(File.dirname(__FILE__), "support/**/*.rb")]
+support_files.sort.each {|f| require f}
+
+# RSpec configuration block
+RSpec.configure do |config|
+  config.mock_with :rspec   # == Mock Framework
+  #config.fixture_path = "#{::Rails.root}/spec/fixtures"
+end

data/spec/support/_configure_logging.rb

@@ -0,0 +1,6 @@
+# Setup a global Logger for all tests
+LOG_LEVEL = ::Logger::WARN
+LOG = FogTracker.default_logger(STDOUT)
+LOG.info "Logging configured in #{File.basename __FILE__}."
+LOG.level = LOG_LEVEL
+ActiveRecord::Base.logger = LOG  # Uncomment for ActiveRecord outputs

data/writing-billing-policies.md

@@ -0,0 +1,8 @@
+How to write a Billing Policy
+================
+
+*(coming soon)*
+
+EXAMPLE: See the source code for
+{CloudCostTracker::Billing::Compute::AWS::ServerBillingPolicy}
+  

data/writing-coding-policies.md

@@ -0,0 +1,7 @@
+How to write a Bill Coding Policy
+================
+
+*(coming soon)*
+
+EXAMPLE: See the source code for
+{CloudCostTracker::Coding::Compute::AWS::VolumeCodingPolicy}

metadata

@@ -0,0 +1,224 @@
+--- !ruby/object:Gem::Specification
+name: cloud_cost_tracker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Benton Roberts
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fog_tracker
+  requirement: &70113161132220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.9
+  type: :runtime
+  prerelease: false
+  version_requirements: *70113161132220
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &70113161130840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70113161130840
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70113161098660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70113161098660
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70113161096820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70113161096820
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &70113161095120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70113161095120
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &70113161094320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70113161094320
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &70113161092700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70113161092700
+- !ruby/object:Gem::Dependency
+  name: ruby_gntp
+  requirement: &70113160454700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70113160454700
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70113160454200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70113160454200
+description: Periodically polls one or more cloud computing accounts using the fog
+  gem, and generates ActiveRecord rows representing BillingRecords for each discovered
+  resource.
+email:
+- benton@bentonroberts.com
+executables:
+- cloud_cost_tracker
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .yardopts
+- Gemfile
+- Guardfile
+- LICENSE.TXT
+- README.md
+- Rakefile
+- billing issues.md
+- bin/cloud_cost_tracker
+- cloud_cost_tracker.gemspec
+- config/accounts.example.yml
+- config/billing/compute-aws-servers/us-east-on_demand.yml
+- config/billing/compute-aws-snapshots.yml
+- config/billing/compute-aws-volumes.yml
+- config/billing/elasticache-aws.yml
+- config/billing/rds-aws-servers/us-east-on_demand-mysql.yml
+- config/billing/rds-aws-servers/us-east-on_demand-storage.yml
+- config/billing/storage-aws-directories.yml
+- config/database.example.yml
+- db/migrate/20120118000000_create_billing_records.rb
+- db/migrate/20120119000000_create_billing_codes.rb
+- lib/cloud_cost_tracker.rb
+- lib/cloud_cost_tracker/billing/account_billing_policy.rb
+- lib/cloud_cost_tracker/billing/compute/aws/servers.rb
+- lib/cloud_cost_tracker/billing/compute/aws/snapshots.rb
+- lib/cloud_cost_tracker/billing/compute/aws/volumes.rb
+- lib/cloud_cost_tracker/billing/elasticache/clusters.rb
+- lib/cloud_cost_tracker/billing/rds/server_storage.rb
+- lib/cloud_cost_tracker/billing/rds/servers.rb
+- lib/cloud_cost_tracker/billing/resource_billing_policy.rb
+- lib/cloud_cost_tracker/billing/storage/aws/directories.rb
+- lib/cloud_cost_tracker/coding/account_coding_policy.rb
+- lib/cloud_cost_tracker/coding/compute/aws/account_coding_policy.rb
+- lib/cloud_cost_tracker/coding/compute/aws/servers.rb
+- lib/cloud_cost_tracker/coding/compute/aws/volumes.rb
+- lib/cloud_cost_tracker/coding/rds/account_coding_policy.rb
+- lib/cloud_cost_tracker/coding/rds/servers.rb
+- lib/cloud_cost_tracker/coding/resource_coding_policy.rb
+- lib/cloud_cost_tracker/extensions/fog_model.rb
+- lib/cloud_cost_tracker/models/billing_code.rb
+- lib/cloud_cost_tracker/models/billing_record.rb
+- lib/cloud_cost_tracker/tasks.rb
+- lib/cloud_cost_tracker/tracker.rb
+- lib/cloud_cost_tracker/util/module_instrospection.rb
+- lib/cloud_cost_tracker/version.rb
+- lib/tasks/database.rake
+- lib/tasks/rspec.rake
+- lib/tasks/track.rake
+- spec/lib/cloud_cost_tracker/billing/account_billing_policy_spec.rb
+- spec/lib/cloud_cost_tracker/billing/resource_billing_policy_spec.rb
+- spec/lib/cloud_cost_tracker/cloud_cost_tracker_spec.rb
+- spec/lib/cloud_cost_tracker/coding/account_coding_policy_spec.rb
+- spec/lib/cloud_cost_tracker/coding/resource_coding_policy_spec.rb
+- spec/lib/cloud_cost_tracker/models/billing_code_spec.rb
+- spec/lib/cloud_cost_tracker/models/billing_record_spec.rb
+- spec/lib/cloud_cost_tracker/tracker_spec.rb
+- spec/spec_helper.rb
+- spec/support/_configure_logging.rb
+- writing-billing-policies.md
+- writing-coding-policies.md
+homepage: http://github.com/benton/cloud_cost_tracker
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2940390420287301713
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2940390420287301713
+requirements: []
+rubyforge_project: cloud_cost_tracker
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Records expenses for cloud computing resources in an ActiveRecord database
+test_files:
+- spec/lib/cloud_cost_tracker/billing/account_billing_policy_spec.rb
+- spec/lib/cloud_cost_tracker/billing/resource_billing_policy_spec.rb
+- spec/lib/cloud_cost_tracker/cloud_cost_tracker_spec.rb
+- spec/lib/cloud_cost_tracker/coding/account_coding_policy_spec.rb
+- spec/lib/cloud_cost_tracker/coding/resource_coding_policy_spec.rb
+- spec/lib/cloud_cost_tracker/models/billing_code_spec.rb
+- spec/lib/cloud_cost_tracker/models/billing_record_spec.rb
+- spec/lib/cloud_cost_tracker/tracker_spec.rb
+- spec/spec_helper.rb
+- spec/support/_configure_logging.rb
+has_rdoc: