symian 0.1.0

data/test/symian/trace_collector_test.rb

@@ -0,0 +1,203 @@
+require 'test_helper'
+
+require 'symian/trace_collector'
+require 'symian/incident'
+require 'symian/support_group'
+require 'symian/operator'
+require 'symian/event'
+
+require 'tempfile'
+
+
+describe Symian::TraceCollector do
+
+  context 'backends' do
+
+    context 'with memory backend' do
+
+      it 'should be creatable' do
+        Symian::TraceCollector.new(:memory)
+      end
+
+      it 'should not mind attempts to save the trace' do
+        Symian::TraceCollector.new(:memory).save_and_close
+      end
+
+    end
+
+    context 'with YAML file backend' do
+
+      it 'should require a namefile for creation' do
+        lambda { Symian::TraceCollector.new(:yaml) }.must_raise ArgumentError
+      end
+
+      it 'should be creatable' do
+        tmpfile = Tempfile.new('reserved_for_testing')
+
+        Symian::TraceCollector.new(:yaml, file: tmpfile.path).save_and_close
+
+        tmpfile.close
+        tmpfile.unlink
+      end
+
+      it 'should allow to save the trace on the YAML file' do
+        tmpfile = Tempfile.new('reserved_for_testing')
+
+        Symian::TraceCollector.new(:yaml, file: tmpfile.path).save_and_close
+        File.size?(tmpfile.path).must_be :>, 0
+
+        tmpfile.close
+        tmpfile.unlink
+      end
+
+      it 'should correctly save trace information' do
+        # initialize stuff
+        now = Time.now
+        incs = [ Symian::Incident.new(1, now),
+                 Symian::Incident.new(2, now + 1.hour),
+                 Symian::Incident.new(3, now + 2.hours) ]
+        simulation = MiniTest::Mock.new
+        sgs = [ Symian::SupportGroup.new('SG1',
+                                 simulation,
+                                 { :distribution => :exponential, :mean => 5 },
+                                 { :number => 3, :workshift => :all_day_long }),
+                Symian::SupportGroup.new('SG2',
+                                 simulation,
+                                 { :distribution => :exponential, :mean => 10 },
+                                 { :number => 5, :workshift => :all_day_long }),
+                Symian::SupportGroup.new('SG3',
+                                 simulation,
+                                 { :distribution => :exponential, :mean => 15 },
+                                 { :number => 7, :workshift => :all_day_long }),
+                Symian::SupportGroup.new('SG4',
+                                 simulation,
+                                 { :distribution => :exponential, :mean => 20 },
+                                 { :number => 9, :workshift => :all_day_long }) ]
+
+        tmpfile = Tempfile.new('reserved_for_testing')
+
+        # create first trace collector
+        tc_1 = Symian::TraceCollector.new(:yaml, file: tmpfile.path)
+
+        # record trace data
+        tc_1.record_incidents(incs)
+        tc_1.record_support_groups(sgs)
+
+        # save data to file
+        tc_1.save_and_close
+
+        # load new trace collector from file
+        tc_2 = Symian::TraceCollector.new(:yaml, file: tmpfile.path)
+
+        # check loaded data
+        count = 0
+        tc_2.incidents.must_equal 3
+        tc_2.with_incidents do |i|
+          i.must_be_instance_of Symian::Incident
+          count += 1
+        end
+
+        # check loaded data
+        count = 0
+        tc_2.support_groups.must_equal 4
+        tc_2.with_support_groups do |sg|
+          sg.must_be_instance_of Symian::SupportGroup
+          count += 1
+        end
+
+        # cleanup
+        tmpfile.close
+        tmpfile.unlink
+      end
+
+    end
+
+  end
+
+
+
+  context 'operations' do
+
+    let (:now) { Time.now }
+
+    let (:incs) {
+      [ Symian::Incident.new(1, now),
+        Symian::Incident.new(2, now + 1.hour),
+        Symian::Incident.new(3, now + 2.hours) ]
+    }
+
+    let (:tc) { Symian::TraceCollector.new(:memory) }
+
+    let (:simulation) { MiniTest::Mock.new }
+
+    let (:sgs) {
+      [ Symian::SupportGroup.new('SG1',
+                         simulation,
+                         { :distribution => :exponential, :mean => 5 },
+                         { :number => 3, :workshift => :all_day_long }),
+        Symian::SupportGroup.new('SG2',
+                         simulation,
+                         { :distribution => :exponential, :mean => 10 },
+                         { :number => 5, :workshift => :all_day_long }),
+        Symian::SupportGroup.new('SG3',
+                         simulation,
+                         { :distribution => :exponential, :mean => 15 },
+                         { :number => 7, :workshift => :all_day_long }) ]
+    }
+
+    it 'should store a single incident' do
+      tc.incidents.must_equal 0
+      tc.record_incidents(incs[0])
+      tc.incidents.must_equal 1
+    end
+
+    it 'should store an array of incidents' do
+      tc.incidents.must_equal 0
+      tc.record_incidents(incs)
+      tc.incidents.must_equal 3
+    end
+
+    it 'should store a single support group' do
+      tc.support_groups.must_equal 0
+      tc.record_support_groups(sgs[0])
+      tc.support_groups.must_equal 1
+    end
+
+    it 'should store an array of support groups' do
+      tc.support_groups.must_equal 0
+      tc.record_support_groups(sgs)
+      tc.support_groups.must_equal 3
+    end
+
+    it 'should store a single event'
+
+    it 'should store an array of events'
+
+    it 'should allow evaluating a block for each stored incident' do
+      tc.record_incidents(incs)
+      tc.with_incidents do |i|
+        i.closure_time = now
+      end
+      tc.with_incidents do |i|
+        i.closure_time.must_equal now
+      end
+    end
+
+    it 'should allow considering stored incidents as an enumerable' do
+      tc.record_incidents(incs)
+      incs_arrived = tc.with_incidents.select{|i| i.arrival_time <= now }
+      incs_arrived.size.must_equal 1
+      incs_arrived.first.must_equal incs.first
+    end
+
+    it 'should allow evaluating a block for each stored support group'
+
+    it 'should allow considering stored support groups as an enumerable'
+
+    it 'should allow evaluating a block for each stored event'
+
+    it 'should allow considering stored events as an enumerable'
+
+  end
+
+end

data/test/symian/transition_matrix_test.rb

@@ -0,0 +1,88 @@
+require 'test_helper'
+
+require 'symian/transition_matrix'
+
+
+describe Symian::TransitionMatrix do
+
+  let(:test_matrix) do
+    # <<-END.gsub(/^\s+/, '') # remove leading spaces
+    #   From/To,SG01,SG02,SG03,Out
+    #   In,1,2,3,4
+    #   SG01,0,2,0,2
+    #   SG02,10,0,50,40
+    #   SG03,0,3,0,3
+    # END
+    "From/To,SG01,SG02,SG03,Out\n" \
+    "In,1,2,3,4\n"                 \
+    "SG01,0,2,0,2\n"               \
+    "SG02,10,0,50,40\n"            \
+    "SG03,0,3,0,3"
+  end
+
+  it 'should correctly load and process an escalation matrix' do
+    tm = Symian::TransitionMatrix.new(test_matrix)
+    tm.transition_probabilities.must_equal({
+      'In' => [
+        { :sg_name => 'SG01', :escalations =>  1, :probability => 0.1 },
+        { :sg_name => 'SG02', :escalations =>  2, :probability => 0.3 },
+        { :sg_name => 'SG03', :escalations =>  3, :probability => 0.6 },
+        { :sg_name =>  'Out', :escalations =>  4, :probability => 1.0 }
+      ],
+      'SG01' => [
+        { :sg_name => 'SG02', :escalations =>  2, :probability => 0.5 },
+        { :sg_name =>  'Out', :escalations =>  2, :probability => 1.0 }
+      ],
+      'SG02' => [
+        { :sg_name => 'SG01', :escalations => 10, :probability => 0.1 },
+        { :sg_name => 'SG03', :escalations => 50, :probability => 0.6 },
+        { :sg_name =>  'Out', :escalations => 40, :probability => 1.0 }
+      ],
+      'SG03' => [
+        { :sg_name => 'SG02', :escalations =>  3, :probability => 0.5 },
+        { :sg_name =>  'Out', :escalations =>  3, :probability => 1.0 }
+      ],
+    })
+  end
+
+  it 'should correctly print the matrix' do
+    tm = Symian::TransitionMatrix.new(test_matrix)
+    tm.to_s.must_equal test_matrix.chomp
+  end
+
+  it 'should correctly escalate incidents between existing and connected groups' do
+    tm = Symian::TransitionMatrix.new(test_matrix)
+    1.upto(30) do
+      [ 'SG01', 'SG03', 'Out' ].must_include tm.escalation('SG02')
+    end
+  end
+
+  it 'should not escalate incidents from unexisting groups' do
+    tm = Symian::TransitionMatrix.new(test_matrix)
+    lambda { tm.escalation('UnexistingSG') }.must_raise ArgumentError
+  end
+
+  # it 'should not escalate incidents to unconnected groups' do
+  # end
+
+  it 'should correctly merge support groups' do
+    tm = Symian::TransitionMatrix.new(test_matrix)
+    tm.merge('SG01', 'SG03')
+    tm.transition_probabilities.must_equal({
+      'In' => [
+        { :sg_name => 'SG02',                   :escalations => 2, :probability => 0.2 },
+        { :sg_name => 'Out',                    :escalations => 4, :probability => 0.6 },
+        { :sg_name => 'Merge_of_SG01_and_SG03', :escalations => 4, :probability => 1.0 }
+      ],
+      'SG02' => [
+        { :sg_name => 'Out',                    :escalations => 40, :probability => 0.4 },
+        { :sg_name => 'Merge_of_SG01_and_SG03', :escalations => 60, :probability => 1.0 }
+      ],
+      'Merge_of_SG01_and_SG03' => [
+        { :sg_name => 'SG02',                   :escalations => 5,  :probability => 0.5 },
+        { :sg_name => 'Out',                    :escalations => 5,  :probability => 1.0 }
+      ]
+    })
+  end
+
+end

data/test/symian/work_shift_test.rb

@@ -0,0 +1,68 @@
+require 'test_helper'
+
+require 'symian/work_shift'
+
+
+describe Symian::WorkShift do
+
+  # it "should require a work shift type" do
+  #   lambda { Symian::WorkShift.new }.should raise_error(ArgumentError)
+  # end
+
+  # it "should require a valid work shift type" do
+  #   lambda { Symian::WorkShift.new(:unknown_type) }.should raise_error(ArgumentError)
+  # end
+
+  describe 'a 24-hours workshift' do
+
+    let(:ws) { Symian::WorkShift.new(:all_day_long) }
+
+    it 'should be always active' do
+      # a = Symian::WorkShift.new(:all_day_long)
+      ws.active_at?(Time.now).must_equal true
+      # lambda { a.secs_to_begin_of_shift(Time.now) }.should raise_error(RuntimeError)
+    end
+
+    it 'should never finish' do
+      ws.secs_to_end_of_shift(Time.now).must_equal Symian::WorkShift::Infinity
+    end
+
+    it 'should have an infinite duration' do
+      ws.duration().must_equal Symian::WorkShift::Infinity
+    end
+
+  end
+
+  describe 'predefined workshifts' do
+  # it "should support predefined workshifts" do
+  #   a = nil
+  #   lambda { a = Symian::WorkShift.new(:predefined, :id => 1) }.should_not raise_error
+  # end
+  end
+
+  describe 'custom workshifts' do
+
+    describe 'an 8-hour custom workshift started 1 hour ago' do
+
+      let(:ws) do
+        now = Time.now
+        workshift_start = now.advance(:hours => -1)
+        workshift_end   = now.advance(:hours =>  7)
+        Symian::WorkShift.new(:custom,
+                              :start_time => workshift_start,
+                              :end_time   => workshift_end)
+      end
+
+      it 'should be active' do
+        ws.active_at?(Time.now).must_equal true
+      end
+
+      it 'should end in 7 hours' do
+        ws.secs_to_end_of_shift(Time.now).must_equal 7.hours
+      end
+
+    end
+
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'minitest-spec-context'
+
+require 'symian'

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: symian
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mauro Tortonesi
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2014-12-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  name: activesupport
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  name: awesome_print
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  name: erv
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  name: ice_nine
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.2
+  name: bundler
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.2
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.1.1
+  name: rake
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.1.1
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  name: minitest-spec-context
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+description: A Decision Support Tool for the Performance Optimization of IT Support Organizations
+email:
+- mauro.tortonesi@unife.it
+executables:
+- symian
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/symian
+- lib/symian.rb
+- lib/symian/configuration.rb
+- lib/symian/cost_analyzer.rb
+- lib/symian/event.rb
+- lib/symian/generator.rb
+- lib/symian/incident.rb
+- lib/symian/operator.rb
+- lib/symian/performance_analyzer.rb
+- lib/symian/simulation.rb
+- lib/symian/sorted_array.rb
+- lib/symian/support/dsl_helper.rb
+- lib/symian/support/yaml_io.rb
+- lib/symian/support_group.rb
+- lib/symian/trace_collector.rb
+- lib/symian/transition_matrix.rb
+- lib/symian/version.rb
+- lib/symian/work_shift.rb
+- symian.gemspec
+- test/symian/configuration_test.rb
+- test/symian/cost_analyzer_test.rb
+- test/symian/generator_test.rb
+- test/symian/incident_test.rb
+- test/symian/operator_test.rb
+- test/symian/reference_configuration.rb
+- test/symian/support_group_test.rb
+- test/symian/trace_collector_test.rb
+- test/symian/transition_matrix_test.rb
+- test/symian/work_shift_test.rb
+- test/test_helper.rb
+homepage: https://github.com/mtortonesi/symian
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.1.9
+signing_key:
+specification_version: 4
+summary: A support tool for strategic and business-driven decision making in the performance optimization of the IT incident management process
+test_files:
+- test/symian/configuration_test.rb
+- test/symian/cost_analyzer_test.rb
+- test/symian/generator_test.rb
+- test/symian/incident_test.rb
+- test/symian/operator_test.rb
+- test/symian/reference_configuration.rb
+- test/symian/support_group_test.rb
+- test/symian/trace_collector_test.rb
+- test/symian/transition_matrix_test.rb
+- test/symian/work_shift_test.rb
+- test/test_helper.rb