bond-spy 0.1.0

data/tutorials/binary_search_tree/run_tests.sh

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+this_dir=`dirname $0`
+this_dir=`cd $this_dir && pwd`
+BOND_MERGE=console RUBYLIB="$this_dir/../../lib" rspec bst_spec.rb

data/tutorials/binary_search_tree/test_observations/.gitignore

@@ -0,0 +1,2 @@
+*_now.json
+*.diff

data/tutorials/binary_search_tree/test_observations/bst_spec/Node_should_add_nodes_to_the_BST_correctly__testing_with_Bond.json

@@ -0,0 +1,20 @@
+[
+{
+  "__spy_point__": "test_add_1",
+  "tree": {
+    "data": 8,
+    "left": {
+      "data": 3,
+      "right": {
+        "data": 4,
+        "right": {
+          "data": 6
+        }
+      }
+    },
+    "right": {
+      "data": 12
+    }
+  }
+}
+]

data/tutorials/binary_search_tree/test_observations/bst_spec/Node_should_add_nodes_to_the_BST_correctly__testing_without_Bond.json

@@ -0,0 +1,3 @@
+[
+
+]

data/tutorials/binary_search_tree/test_observations/bst_spec/Node_should_correctly_delete_nodes_from_the_BST.json

@@ -0,0 +1,29 @@
+[
+{
+  "__spy_point__": "test_delete_1",
+  "tree": {
+    "data": 8,
+    "left": {
+      "data": 3,
+      "right": {
+        "data": 6
+      }
+    },
+    "right": {
+      "data": 12
+    }
+  }
+},
+{
+  "__spy_point__": "test_delete_2",
+  "tree": {
+    "data": 12,
+    "left": {
+      "data": 3,
+      "right": {
+        "data": 6
+      }
+    }
+  }
+}
+]

data/tutorials/heat_watcher/heat_watcher.rb

@@ -0,0 +1,107 @@
+#
+# A simple demonstration of using Bond for spying and mocking
+# an application for monitoring temperature and sending alerts
+#
+# See a full explanation of this example at
+# http://necula01.github.io/bond/example_heat.html
+#
+# rst_Start
+
+require 'bond'
+
+# Monitor temperature rise over time.
+# See description in the Bond documentation.
+class HeatWatcher
+  # Marks this class as being able to be spied on. Exports `bond` method
+  # to use as e.g. bond.spy and bond.spy_point.
+  extend BondTargetable
+
+  def initialize
+    @last_temp = nil # The last temp measurement
+    @last_time = nil  # The time when we took the last measurement
+    @last_alert_state = 'Ok'   # Ok, Warning, Critical
+    @last_alert_time = -Float::INFINITY # The time when we sent the last alert
+  end
+
+  # Monitor the temperature and send alerts
+  # @param exit_time the time when to exit the monitor loop.
+  def monitor_loop(exit_time = nil)
+    loop do
+      temp = get_temperature
+      now = get_current_time
+      return if !exit_time.nil? && now >= exit_time
+
+      if @last_temp.nil?
+        # First reading
+        @last_temp = temp
+        @last_time = now
+        interval = 60
+      else
+        change_rate = (temp - @last_temp) / (now - @last_time) * 60
+        if change_rate < 1
+            interval = 60
+            alert_state = 'Ok'
+        elsif change_rate < 2
+            interval = 10
+            alert_state = 'Warning'
+        else
+            interval = 10
+            alert_state = 'Critical'
+        end
+
+        @last_temp = temp
+        @last_time = now
+
+        if alert_state != @last_alert_state ||
+                        (alert_state != 'Ok' && now >= 600 + @last_alert_time)
+          # Send an alert
+          send_alert("#{alert_state}: Temperature is rising at #{change_rate.round(1)} deg/min")
+          @last_alert_time = now
+        end
+
+        @last_alert_state = alert_state
+      end
+
+      sleep(interval)
+    end
+  end
+
+  # Spy this function, want to spy the result
+  bond.spy_point(spy_result: true)
+  # Read the temperature from a sensor
+  def get_temperature
+    resp_code, temp_data =
+        make_request('http://system.server.com/temperature')
+    raise 'Error while retrieving temperature!' unless resp_code == 200
+    match = /<temperature>([0-9.]+)<\/temperature>/.match(temp_data)
+    raise "Error while parsing temperature from: #{temp_data}" if match.nil?
+    match[1].to_f
+  end
+
+  bond.spy_point
+  # Read the current time
+  def get_current_time
+      Time.now.to_i
+  end
+
+
+  bond.spy_point
+  # Sleep a few seconds
+  def sleep(seconds)
+    sleep(seconds)
+  end
+
+  bond.spy_point
+  # Send an alert
+  def send_alert(message)
+    make_request('http://backend.server.com/messages', {message: message})
+  end
+
+  bond.spy_point(require_agent_result: true)
+  # HTTP request (GET, or POST if the data is provided)
+  def make_request(url, data = nil)
+    full_url = "#{url}?#{URI.encode_www_form(data)}"
+    resp = Net::HTTP.get_response(URI(full_url))
+    [resp.code.to_i, resp.body]
+  end
+end

data/tutorials/heat_watcher/heat_watcher_spec.rb

@@ -0,0 +1,116 @@
+#
+# Tests using Bond for the heat_watcher.py app
+#
+# See a full explanation of this example at
+# http://necula01.github.io/bond/example_heat.html
+#
+
+require 'bond/spec_helper'
+require_relative 'heat_watcher'
+
+describe HeatWatcher do
+  # Sets up the testing environment to use Bond. Exports bond as a variable
+  # to use as e.g. bond.deploy_agent.
+  include_context :bond
+
+  # Helper function to setup the time mocks and agents
+  def deploy_time_mock
+    @time_mocker = TimeMocker.new
+
+    bond.deploy_agent('HeatWatcher#get_current_time',
+                      result: lambda { |_| @time_mocker.time })
+    bond.deploy_agent('HeatWatcher#sleep',
+                      result: lambda { |obs| @time_mocker.sleep(obs[:seconds]) })
+  end
+
+  it 'should properly report warnings and switch back to OK status' do
+    # A test where the higher-level functions get_temperature and send_alert
+    # are mocked out to return specified temperatures and do nothing, respectively.
+    deploy_time_mock
+    @temp_mocker = TemperatureMocker.new(time_mocker: @time_mocker,
+                                         temp_start: 70,
+                                         temp_rates: [[0, 0.5], [60, 1.3], [110, 0.1]])
+
+    bond.deploy_agent('HeatWatcher#get_temperature',
+                      result: lambda { |_| @temp_mocker.temperature })
+    bond.deploy_agent('HeatWatcher#send_alert',
+                      result: nil)
+
+    HeatWatcher.new.monitor_loop(@time_mocker.time + 400)
+  end
+
+  it 'should properly report critical errors' do
+    # A test where make_request is mocked out, and returns different responses
+    # depending on the URL that is passed in. This can allow you to test that the
+    # parsing logic in get_temperature is working correctly.
+    deploy_time_mock
+    @temp_mocker = TemperatureMocker.new(time_mocker: @time_mocker,
+                                         temp_start: 70,
+                                         temp_rates: [[0, 0.5], [60, 2.5], [120, 3], [140, 0.5]])
+
+    bond.deploy_agent('HeatWatcher#make_request',
+                      url__contains: 'messages',
+                      result: nil)
+    bond.deploy_agent('HeatWatcher#make_request',
+                      url__contains: 'temperature',
+                      result: lambda do |_|
+                        [200, "<temperature>#{@temp_mocker.temperature}</temperature>"]
+                      end)
+
+    HeatWatcher.new.monitor_loop(@time_mocker.time + 210)
+  end
+end
+
+# rst_TimeMocker
+# A class to mock time
+class TimeMocker
+  def initialize(current_time = 1445567700)
+    # Default 10/23/2015 @ 2:35am (UTC)
+    @current_time = current_time
+  end
+
+  def time
+    @current_time
+  end
+
+  def sleep(seconds)
+    @current_time += seconds
+  end
+end
+
+# rst_TemperatureMocker
+# A class to mock temperature
+class TemperatureMocker
+
+  # @param time_mocker a reference to the current time mocker
+  # @param temp_start the starting temperature
+  # @param temp_rates a list of pairs (time_since_start,
+  #     temperature_increase_rate_per_min) ordered by time_since_start
+  def initialize(time_mocker:, temp_start:, temp_rates: [])
+    @time_mocker = time_mocker
+    @start_time = time_mocker.time
+    @last_temp = temp_start       # last temp read
+    @last_temp_time = @start_time  # last temp read time
+    @temp_rates = temp_rates
+  end
+
+  def temperature
+    now = @time_mocker.time
+    time_since_start = now - @start_time
+    # See if we need to advance to the next temperature rate
+    if @temp_rates.length > 1 && time_since_start >= @temp_rates[1][0]
+
+      old_rate = @temp_rates.shift[1]
+
+      old_rate_time = @temp_rates[0][0]
+      @last_temp += (old_rate_time + @start_time - @last_temp_time) / 60.0 * old_rate
+      @last_temp_time = old_rate_time + @start_time
+    end
+
+    # The first pair is the one we use to get the rate
+    rate = @temp_rates.length > 0 ? @temp_rates[0][1] : 0
+    @last_temp += (now - @last_temp_time) / 60.0 * rate
+    @last_temp_time = now
+    @last_temp
+  end
+end

data/tutorials/heat_watcher/run_tests.sh

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+this_dir=`dirname $0`
+this_dir=`cd $this_dir && pwd`
+BOND_MERGE=console RUBYLIB="$this_dir/../../lib" rspec heat_watcher_spec.rb

data/tutorials/heat_watcher/test_observations/.gitignore

@@ -0,0 +1,2 @@
+*_now.json
+*.diff

data/tutorials/heat_watcher/test_observations/heat_watcher_spec/HeatWatcher_should_properly_report_critical_errors.json

@@ -0,0 +1,142 @@
+[
+{
+    "__spy_point__": "HeatWatcher#get_temperature"
+},
+{
+    "__spy_point__": "HeatWatcher#make_request",
+    "url": "http://system.server.com/temperature"
+},
+{
+    "__spy_point__": "HeatWatcher#get_temperature.result",
+    "result": 70.0
+},
+{
+    "__spy_point__": "HeatWatcher#get_current_time"
+},
+{
+    "__spy_point__": "HeatWatcher#sleep",
+    "seconds": 60
+},
+{
+    "__spy_point__": "HeatWatcher#get_temperature"
+},
+{
+    "__spy_point__": "HeatWatcher#make_request",
+    "url": "http://system.server.com/temperature"
+},
+{
+    "__spy_point__": "HeatWatcher#get_temperature.result",
+    "result": 70.5
+},
+{
+    "__spy_point__": "HeatWatcher#get_current_time"
+},
+{
+    "__spy_point__": "HeatWatcher#sleep",
+    "seconds": 60
+},
+{
+    "__spy_point__": "HeatWatcher#get_temperature"
+},
+{
+    "__spy_point__": "HeatWatcher#make_request",
+    "url": "http://system.server.com/temperature"
+},
+{
+    "__spy_point__": "HeatWatcher#get_temperature.result",
+    "result": 73.0
+},
+{
+    "__spy_point__": "HeatWatcher#get_current_time"
+},
+{
+    "__spy_point__": "HeatWatcher#send_alert",
+    "message": "Critical: Temperature is rising at 2.5 deg/min"
+},
+{
+    "__spy_point__": "HeatWatcher#make_request",
+    "message": "Critical: Temperature is rising at 2.5 deg/min",
+    "url": "http://backend.server.com/messages"
+},
+{
+    "__spy_point__": "HeatWatcher#sleep",
+    "seconds": 10
+},
+{
+    "__spy_point__": "HeatWatcher#get_temperature"
+},
+{
+    "__spy_point__": "HeatWatcher#make_request",
+    "url": "http://system.server.com/temperature"
+},
+{
+    "__spy_point__": "HeatWatcher#get_temperature.result",
+    "result": 73.5
+},
+{
+    "__spy_point__": "HeatWatcher#get_current_time"
+},
+{
+    "__spy_point__": "HeatWatcher#sleep",
+    "seconds": 10
+},
+{
+    "__spy_point__": "HeatWatcher#get_temperature"
+},
+{
+    "__spy_point__": "HeatWatcher#make_request",
+    "url": "http://system.server.com/temperature"
+},
+{
+    "__spy_point__": "HeatWatcher#get_temperature.result",
+    "result": 74.0
+},
+{
+    "__spy_point__": "HeatWatcher#get_current_time"
+},
+{
+    "__spy_point__": "HeatWatcher#sleep",
+    "seconds": 10
+},
+{
+    "__spy_point__": "HeatWatcher#get_temperature"
+},
+{
+    "__spy_point__": "HeatWatcher#make_request",
+    "url": "http://system.server.com/temperature"
+},
+{
+    "__spy_point__": "HeatWatcher#get_temperature.result",
+    "result": 74.08333333333333
+},
+{
+    "__spy_point__": "HeatWatcher#get_current_time"
+},
+{
+    "__spy_point__": "HeatWatcher#send_alert",
+    "message": "Ok: Temperature is rising at 0.5 deg/min"
+},
+{
+    "__spy_point__": "HeatWatcher#make_request",
+    "message": "Ok: Temperature is rising at 0.5 deg/min",
+    "url": "http://backend.server.com/messages"
+},
+{
+    "__spy_point__": "HeatWatcher#sleep",
+    "seconds": 60
+},
+{
+    "__spy_point__": "HeatWatcher#get_temperature"
+},
+{
+    "__spy_point__": "HeatWatcher#make_request",
+    "url": "http://system.server.com/temperature"
+},
+{
+    "__spy_point__": "HeatWatcher#get_temperature.result",
+    "result": 74.58333333333333
+},
+{
+    "__spy_point__": "HeatWatcher#get_current_time"
+}
+]

data/tutorials/heat_watcher/test_observations/heat_watcher_spec/HeatWatcher_should_properly_report_warnings_and_switch_back_to_OK_status.json

@@ -0,0 +1,132 @@
+[
+{
+    "__spy_point__": "HeatWatcher#get_temperature"
+},
+{
+    "__spy_point__": "HeatWatcher#get_temperature.result",
+    "result": 70.0
+},
+{
+    "__spy_point__": "HeatWatcher#get_current_time"
+},
+{
+    "__spy_point__": "HeatWatcher#sleep",
+    "seconds": 60
+},
+{
+    "__spy_point__": "HeatWatcher#get_temperature"
+},
+{
+    "__spy_point__": "HeatWatcher#get_temperature.result",
+    "result": 70.5
+},
+{
+    "__spy_point__": "HeatWatcher#get_current_time"
+},
+{
+    "__spy_point__": "HeatWatcher#sleep",
+    "seconds": 60
+},
+{
+    "__spy_point__": "HeatWatcher#get_temperature"
+},
+{
+    "__spy_point__": "HeatWatcher#get_temperature.result",
+    "result": 71.6
+},
+{
+    "__spy_point__": "HeatWatcher#get_current_time"
+},
+{
+    "__spy_point__": "HeatWatcher#send_alert",
+    "message": "Warning: Temperature is rising at 1.1 deg/min"
+},
+{
+    "__spy_point__": "HeatWatcher#sleep",
+    "seconds": 10
+},
+{
+    "__spy_point__": "HeatWatcher#get_temperature"
+},
+{
+    "__spy_point__": "HeatWatcher#get_temperature.result",
+    "result": 71.61666666666666
+},
+{
+    "__spy_point__": "HeatWatcher#get_current_time"
+},
+{
+    "__spy_point__": "HeatWatcher#send_alert",
+    "message": "Ok: Temperature is rising at 0.1 deg/min"
+},
+{
+    "__spy_point__": "HeatWatcher#sleep",
+    "seconds": 60
+},
+{
+    "__spy_point__": "HeatWatcher#get_temperature"
+},
+{
+    "__spy_point__": "HeatWatcher#get_temperature.result",
+    "result": 71.71666666666665
+},
+{
+    "__spy_point__": "HeatWatcher#get_current_time"
+},
+{
+    "__spy_point__": "HeatWatcher#sleep",
+    "seconds": 60
+},
+{
+    "__spy_point__": "HeatWatcher#get_temperature"
+},
+{
+    "__spy_point__": "HeatWatcher#get_temperature.result",
+    "result": 71.81666666666665
+},
+{
+    "__spy_point__": "HeatWatcher#get_current_time"
+},
+{
+    "__spy_point__": "HeatWatcher#sleep",
+    "seconds": 60
+},
+{
+    "__spy_point__": "HeatWatcher#get_temperature"
+},
+{
+    "__spy_point__": "HeatWatcher#get_temperature.result",
+    "result": 71.91666666666664
+},
+{
+    "__spy_point__": "HeatWatcher#get_current_time"
+},
+{
+    "__spy_point__": "HeatWatcher#sleep",
+    "seconds": 60
+},
+{
+    "__spy_point__": "HeatWatcher#get_temperature"
+},
+{
+    "__spy_point__": "HeatWatcher#get_temperature.result",
+    "result": 72.01666666666664
+},
+{
+    "__spy_point__": "HeatWatcher#get_current_time"
+},
+{
+    "__spy_point__": "HeatWatcher#sleep",
+    "seconds": 60
+},
+{
+    "__spy_point__": "HeatWatcher#get_temperature"
+},
+{
+    "__spy_point__": "HeatWatcher#get_temperature.result",
+    "result": 72.11666666666663
+},
+{
+    "__spy_point__": "HeatWatcher#get_current_time"
+}
+]