are_we_there_yet 0.1.0 → 0.2.0

data/README.md

@@ -17,6 +17,19 @@ Usage is fairly simple:
 2. When running the specs pass the name of the class together with the location of your SQLite3 database, e.g:
   `spec -fAreWeThereYet:/path/to/db.sqlite3 spec`
 
+Only passing tests are profiled.
+
+## Data Structure
+
+The following data is stored in the database:
+
+- runs (from v0.2.0 onwards) - this is to allow conclusive tracking of metrics against a specific run. Multiple runs close to one 
+may result in guesswork when determining which metrics belong to which run. v0.1.0 does not track this data, but v0.2.0 is backwards 
+compatible and can handle the reduced fidelity when dealing with a database created by v0.1.0.
+- files - this represents the individual files containing the examples that are being run.
+- examples - the individual examples themselves (one file has many examples)
+- metrics - the run time per example (per run from v0.2.0 onwards) - one example has many metrics, one run has many metrics
+
 ## License
 
 Copyright (c) 2012 Rory McKinley

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/are_we_there_yet.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{are_we_there_yet}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Rory McKinley"]

data/lib/are_we_there_yet.rb

@@ -6,6 +6,8 @@ class AreWeThereYet < Spec::Runner::Formatter::BaseFormatter
     @db = SQLite3::Database.new(where)
 
     create_tables
+
+    log_run
   end
 
   def example_started(example)
@@ -18,16 +20,26 @@ class AreWeThereYet < Spec::Runner::Formatter::BaseFormatter
 
       example_id = persist_example(db, example, location_id)
 
-      db.execute(
-        "INSERT INTO metrics(example_id, execution_time) VALUES(:example_id, :execution_time)",
-        :example_id => db.last_insert_row_id,
-        :execution_time => Time.now - @start
-      )
+      persist_metric(db, example_id)
     end
   end
 
+  def close
+    @db.execute(
+      "UPDATE runs SET ended_at = :end_time WHERE id = :run_id",
+      :end_time => Time.now.strftime("%Y-%m-%d %H:%M:%S"), 
+      :run_id => @run_id
+    ) if tracking_runs?
+    @db.close
+  end
+
   private
 
+  def log_run
+    @db.execute("INSERT INTO runs(id) VALUES(NULL)") if tracking_runs?
+    @run_id = @db.last_insert_row_id
+  end
+
   def persist_file(db, example)
     path = example.location.split(':').first
 
@@ -58,17 +70,39 @@ class AreWeThereYet < Spec::Runner::Formatter::BaseFormatter
     end
   end
 
+  def persist_metric(db, example_id)
+    if tracking_runs?
+      db.execute(
+        "INSERT INTO metrics(example_id, execution_time, run_id) VALUES(:example_id, :execution_time, :run_id)",
+        :example_id => db.last_insert_row_id,
+        :execution_time => Time.now - @start,
+        :run_id => @run_id
+      )
+    else
+      db.execute(
+        "INSERT INTO metrics(example_id, execution_time) VALUES(:example_id, :execution_time)",
+        :example_id => db.last_insert_row_id,
+        :execution_time => Time.now - @start
+      )
+    end
+  end
+  
   def create_tables
     existing_tables = @db.execute("SELECT name FROM sqlite_master")
 
     if existing_tables.empty?
       @db.transaction do |db|
+        db.execute("CREATE TABLE runs(id INTEGER PRIMARY KEY, started_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP, ended_at TIMESTAMP)")
         db.execute("CREATE TABLE files(id INTEGER PRIMARY KEY, path VARCHAR(255))")
         db.execute("CREATE INDEX path ON files (path)")
         db.execute("CREATE TABLE examples(id INTEGER PRIMARY KEY, file_id INTEGER, description TEXT)")
         db.execute("CREATE INDEX file_description ON examples (file_id, description)")
-        db.execute("CREATE TABLE metrics(id INTEGER PRIMARY KEY, example_id INTEGER, execution_time FLOAT, created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP)")
+        db.execute("CREATE TABLE metrics(id INTEGER PRIMARY KEY, example_id INTEGER, execution_time FLOAT, created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP, run_id INTEGER )")
       end
     end
   end
+
+  def tracking_runs?
+    @tracking_runs ||= @db.execute("SELECT name FROM sqlite_master WHERE type = 'table' AND name = 'runs'").any?
+  end
 end

data/spec/are_we_there_yet_spec.rb

@@ -21,6 +21,7 @@ describe AreWeThereYet do
       table_exists?(@db_name, 'files').should be_true
       table_exists?(@db_name, 'examples').should be_true
       table_exists?(@db_name, 'metrics').should be_true
+      table_exists?(@db_name, 'runs').should be_true
     end
 
     it "creates the necessary indexes" do
@@ -52,6 +53,31 @@ describe AreWeThereYet do
 
       connection.execute2("SELECT name FROM sqlite_master").size.should == 1 # Execute2 lists fields - size 1 means empty response
     end
+
+    it "logs the start of a spec run" do
+      AreWeThereYet.new({},@db_name)
+      connection = SQLite3::Database.new(@db_name)
+
+      run = connection.get_first_row("SELECT id, started_at FROM runs")
+      run.should_not be_nil
+      run[1].should_not be_nil
+    end
+
+    it "does not log the start of a spec run if there is no table in the database" do
+      # This to maintain backwards-compatibility with DBs created by v0.1.0
+      connection = SQLite3::Database.new(@db_name)
+      connection.stub(:execute) do |arg|
+        if arg =~ /CREATE TABLE runs/
+          # Do nothing
+        else
+          connection.execute2(arg)
+          []
+        end
+      end
+      SQLite3::Database.should_receive(:new).and_return(connection)
+
+      expect { AreWeThereYet.new({},@db_name) }.should_not raise_error
+    end
   end
 
   describe "logging a metric for a new file" do
@@ -94,15 +120,31 @@ describe AreWeThereYet do
       @awty.example_passed(@mock_example)
 
       connection = SQLite3::Database.new(@db_name)
+      run = connection.get_first_row("SELECT id FROM runs")
+      run_id = run.first
+
       example = connection.get_first_row("SELECT id FROM examples")
       example_id = example.first
 
       Time.stub!(:now)
-      metrics = connection.execute("SELECT id, example_id, execution_time, created_at FROM metrics")
+      metrics = connection.execute("SELECT id, example_id, execution_time, created_at, run_id FROM metrics")
       metrics.size.should == 1
       metrics.first[1].should == example_id
       metrics.first[2].should == end_time - start_time
       metrics.first[3].should_not be_nil
+      metrics.first[4].should == run_id
+    end
+
+    it "does not link the metric to a run if the run table does not exist" do
+      # To maintain compatibility with version 0.1.0
+      AreWeThereYet.any_instance.should_receive(:tracking_runs?).and_return(false)
+
+      connection = SQLite3::Database.new(@db_name)
+      connection.execute("DROP TABLE metrics")
+      connection.execute("CREATE TABLE metrics(id INTEGER PRIMARY KEY, example_id INTEGER, execution_time FLOAT, created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP)")
+
+      @awty.example_started(@mock_example)
+      expect { @awty.example_passed(@mock_example) }.should_not raise_error
     end
   end
 
@@ -170,4 +212,33 @@ describe AreWeThereYet do
       connection.execute("SELECT * FROM examples").should be_empty
     end
   end
+
+  describe "closing" do
+    before(:each) do
+      @awty = AreWeThereYet.new({}, @db_name)
+      @mock_example = mock(Spec::Example::ExampleProxy, :location => "/path/to/spec", :description => "blaah")
+      @awty.example_started(@mock_example)
+    end
+
+    it "closes the connection to the database" do
+      SQLite3::Database.any_instance.should_receive(:close)
+      @awty.close
+    end
+
+    it "updates the end time value for the relevant run" do
+      @awty.close
+
+      connection = SQLite3::Database.new(@db_name)
+      run = connection.get_first_row('SELECT ended_at FROM runs')
+      run.first.should_not be_nil
+    end
+
+    it "does not update the run if runs are not being tracked" do
+      connection = SQLite3::Database.new(@db_name)
+      connection.execute("DROP TABLE runs")
+      AreWeThereYet.any_instance.should_receive(:tracking_runs?).and_return(false)
+
+      expect { @awty.close }.should_not raise_error
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: are_we_there_yet
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
   segments_generated: true
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Rory McKinley