rspec2db 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 46aed6e716b94e2dffdba843c02777e90583f97e
+  data.tar.gz: c75c5d8efa246d8b7c6f8878087df2c8397e6a61
+SHA512:
+  metadata.gz: b5cc9b7c8f0ce9c459375c55d6ecc5c88a25b492c023158838e071e00b580bec846b694f38a6b3eb8438ee54f7676cf4692405ab09c66db150203351a08ff262
+  data.tar.gz: af16bda7290716021632416ab48cda8eef50a09176575d539b0ea4d35a91ab332e13f27f0cf6716f8e9736fa5b6748247c1d267b8ed72159b2c5ede5c51b8139

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.project

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>rspec2db git</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+	</buildSpec>
+	<natures>
+		<nature>com.aptana.ruby.core.rubynature</nature>
+	</natures>
+</projectDescription>

data/.rspec

@@ -0,0 +1,2 @@
+--format Rspec2db
+--options ./config/rspec2db.yml

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    rspec2db (1.2.0)
+      activerecord (~> 5.1)
+      activerecord-postgresql-adapter
+      pg (~> 0.21)
+      rspec (>= 3.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (5.2.0)
+      activesupport (= 5.2.0)
+    activerecord (5.2.0)
+      activemodel (= 5.2.0)
+      activesupport (= 5.2.0)
+      arel (>= 9.0)
+    activerecord-postgresql-adapter (0.0.1)
+      pg
+    activesupport (5.2.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    i18n (1.0.1)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    pg (0.21.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec2db!
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -0,0 +1,139 @@
+rspec2db: RSpec DB Formatter
+============================
+
+
+## Description
+rspec2db is a Ruby gem used for storing rspec test execution results to a database. This gem extends RSpec formatter and has to be required in `.rspec` (which is done by rspec2db init command described below). Once added, the gem will handle storing all test related informations (test suites, test cases, test steps) into the database. By default, rspec2db supports writing to postgresql database but can be easily adjusted to write results into other relational databases as well since it uses ActiveRecord for persisting data.
+
+The gem also provides a CLI tool meant for bootstrapping rspec2db configuration files.
+
+
+## Rspec2DB CLI
+
+Rspec2db provides a CLI tool that helps users with bootstraping by generating configuration files. 
+
+```
+$ rspec2db
+Loading default rspec2db configuration.
+Using project config file
+No command provided
+Usage: rspec2db [options] <command>
+
+init    - initialize rspec2db config file (~/rspec2db.yaml)
+create  - creates rspec2db database
+migrate - migrates rspec2db database
+build-stats - extracts test run execution based on test run id
+
+Options:
+    -H, --host=h                     rspec2db database host
+    -p, --port=port                  rspec2db database port
+    -d, --database=db                rspec2db database name
+    -u, --username=u                 rspec2db database username
+    -w, --password=pw                rspec2db database user password
+    -a, --adapter=ad                 rspec2db database adapter
+    -h, --help                       rspec2db help
+```
+### Usage
+The tool provides number of options for onboarding:
+1. `init` - Initialization of a global configuration file (stored in the home directory) with predefined configuration that can be modified (ie. values in `~/rspec2db.yaml` should be changed to appropriate values). This will also add Rspec2db formater to your spec `.rspec` file.
+2. `create` - Rake-like task that will create and seed the db.
+3. `migrate` - Rake-like task that will migrate latest changes to the db
+3. `build-stats` - Export of Test execution results and statistics for a Test build
+
+### Example
+
+```
+$ rspec2db init
+Loading default rspec2db configuration.
+Using project config file
+No rspec2db config specified in .rspec
+Loading default rspec2db options (/Users/user/rspec2db.yaml)
+Creating default rspec2db config file (/Users/user/rspec2db.yaml)
+Adding rspec2db options and formatter to .rspec
+```
+
+```
+# Edit ~/rspec2db.yaml to use your PG database. Database has to exist before running create task.
+$ rspec2db create
+Loading default rspec2db configuration.
+No project file detected. Looking for local config file
+-- create_table(:test_suites, {:force=>:cascade})
+   -> 0.1380s
+-- create_table(:test_runs, {:force=>:cascade})
+   -> 0.0513s
+-- create_table(:test_cases, {:force=>:cascade})
+   -> 0.0425s
+```
+
+```
+# Migrate changes
+$ rspec2db migrate
+Loading default rspec2db configuration.
+No project file detected. Looking for local config file
+```
+
+This flow will result in a configured PG Database and a configuration file that can be used among different projects.
+
+
+To reuse the existing configuration file in a separate rspec spec project, simply run `rspec init`. This will configure your `.rspec` file:
+`
+```$ rspec2db init
+bundle exec rspec2db init
+Loading default rspec2db configuration.
+No project file detected. Looking for local config file
+No rspec2db config specified in .rspec
+Loading default rspec2db options (/Users/user/rspec2db.yaml)
+Default config file exists, override with default? (Y/N)
+N
+Adding rspec2db options and formatter to .rspec
+```
+
+## Other
+Rspec2DB CLI commands load the rspec2db configuration file that is either defined in the `.rspec` file in your spec directory, or loads the default configuration file in your home directory.
+Default configuration (from the `rspec2db.yaml`) can be overriden using the provided CLI options for targeting a specific DB (ie. by providing host, port, db credentials and similar).
+
+### Using the formatter
+`rspec2db init` will add `rspec2db` formatter to `.rspec` file, resulting in every spec that is ran by `rspec spec/*` to be written to the database (in the format of test suites, test cases and test steps). 
+
+#### Retrieve results from database
+
+To retrieve test results from the database, you can use RSpec2DB CLI command `build-stats`.
+To execute the script, run the following command:
+```
+$ rspec2db build-stats --help
+Loading default rspec2db configuration.
+No project file detected. Looking for local config file
+Usage: rspec2db [options]
+    -i, --id=id                      rspec2db test build id
+    -o, --output file                rspec2db extract output file
+    -l, --limit [LIMIT]              rspec2db number of extracted test runs
+    -s, --suite suite                rspec2db test suite
+    -U [url]--URL [url]              Test Reporter (www.github.com/ATLANTBH/owl) url link
+
+```
+
+
+To execute the script with all optional parameters, run the following command:
+
+```
+rspec2db build-stats -i <build_number> -l <limit> -o <output_file> -s <test_suite> -U <reporter_url>
+```
+
+- build_number is a user specified value which needs to be the same like the one found in rspec2db.yml configuration file
+- output_file is name of the file in which results are written
+- limit (optional) determines if the statistics will be calculated for a single run with same build_number or for all runs with same build_number: 
+    - not specified - results for only one run (the first one) will be in the results file
+    - all - results for all runs will be in the results file
+- test_suite is the name of the suite from which we want to query results
+- reporter_url (optional) is the url of the Test Reporter tool which can be used in conjunction with rspec2db gem. If you use this parameter, you need to specify base url of your Test Reporter instance (for example: http://testreporter:8080). Based on this url, script will generate exact url path to this specific run which contains list of tests that have been executed
+- suite_name - name of the test suite that was specified in `rspec2db.yml` file and for which the stats are calculated
+
+
+### Updating Rspec2DB gem version
+
+If you are updating Rspec2DB gem from a to a newer version, running `rspec2db migrate` is required. This command will migrate the database so that it satisfies the Rspec2DB model, if it was changed.
+
+```
+$ bundle update rspec2db
+$ bundle exec rspec2db migrate
+```

data/bin/rspec2db

@@ -0,0 +1,118 @@
+#!/usr/bin/env ruby
+require 'optparse'
+require 'yaml'
+require 'fileutils'
+require_relative '../lib/rspec2db/utils/db_utils'
+require_relative '../lib/rspec2db/utils/rspec_configuration_helper'
+
+def check_required_options(required_options, options)
+  missing_options = required_options - options.keys.map { |k| k.to_s }
+  abort 'Missing required options: ' + missing_options.reduce { |m, k| m + ', ' + k } unless missing_options.empty?
+end
+
+def parse_extract_command
+  options = {}
+  required_options = ['id', 'file', 'suite']
+  extract_options = OptionParser.new do |opts|
+    opts.on('-i id', '--id=id', 'rspec2db test build id') do |id|
+      options[:id] = id
+    end
+
+    opts.on('-o file', '--output file', 'rspec2db extract output file') do |f|
+      options[:file] = f
+    end
+
+    opts.on('-l [LIMIT]', '--limit [LIMIT]', 'rspec2db number of extracted test runs') do |l|
+      options[:limit] = l || nil
+    end
+
+    opts.on('-s suite', '--suite suite', 'rspec2db test suite') do |suite|
+      options[:suite] = suite
+    end
+
+    opts.on('-U [url]' '--URL [url]', 'Test Reporter (www.github.com/ATLANTBH/owl) url link') do |url|
+      options[:url] = url
+    end
+  end
+  extract_options.parse!
+  check_required_options(required_options, options)
+  [options, extract_options]
+end
+
+def parse_options(load_local = true)
+  options = {}
+  required_options = ['username', 'password', 'host', 'port', 'database']
+
+  option_parser = OptionParser.new do |opts|
+    opts.banner = "Usage: rspec2db [options] <command>\n" + \
+                  "\ninit    - initialize rspec2db config file (" + ENV['PWD'] + "/rspec2db.yaml)" \
+                  "\ncreate  - creates rspec2db database" + \
+                  "\nmigrate - migrates rspec2db database" + \
+                  "\nbuild-stats - extracts test run execution based on test run id" + \
+                  "\n\nOptions:"
+
+    opts.on('-H h', '--host=h', 'rspec2db database host') do |h|
+      options[:host] = h
+    end
+
+    opts.on('-p port', '--port=port', 'rspec2db database port') do |port|
+      options[:port] = port
+    end
+
+    opts.on('-d db', '--database=db', 'rspec2db database name') do |db|
+      options[:database] = db
+    end
+
+    opts.on('-u u', '--username=u', 'rspec2db database username') do |u|
+      options[:username] = u
+    end
+
+    opts.on('-w pw', '--password=pw', 'rspec2db database user password') do |pw|
+      options[:password] = pw
+    end
+
+    opts.on('-a ad', '--adapter=ad', 'rspec2db database adapter') do |ad|
+      options[:adapter] = ad
+    end
+
+    opts.on('-h', '--help', 'rspec2db help') do |h|
+      options[:help] = h
+    end
+  end
+  option_parser.order!
+  return [options, option_parser] unless options.empty?
+
+  if options.empty?
+    puts 'Loading rspec2db configuration.'
+    options = RSpecConfigurationHelper.load_local_config
+  end
+
+  check_required_options(required_options, options)
+  options[:adapter] = 'postgresql' if options[:adapter].nil?
+
+  [options, option_parser]
+end
+
+options, option_parser = parse_options
+command = ARGV[0]
+case command
+when 'init'
+  puts 'No .rspec file found in working directory' if options.nil?
+when 'create'
+  DBUtils.create_rspec_db options
+when 'migrate'
+  DBUtils.migrate_rspec_db options
+when 'build-stats'
+  build_options, extract_option_parser = parse_extract_command
+  if build_options.empty?
+    puts extract_option_parser
+  else
+    DBUtils.build_stats build_options[:id], build_options[:file], build_options[:limit], build_options[:suite], options, build_options[:url]
+  end
+when nil
+  puts 'No command provided'
+  puts option_parser
+else
+  puts 'Command unknown.'
+  puts option_parser
+end

data/config/rspec2db.yml

@@ -0,0 +1,13 @@
+options:
+  suite: 'suite name'
+  build: '1' #
+  backtrace: false
+  git_commit:
+  git_branch:
+dbconnection:
+  adapter: postgresql
+  database:  rspec
+  username: postgres
+  password: test123!
+  host: localhost
+  port: 5432

data/config/rspec_db.rb

@@ -0,0 +1,44 @@
+require 'rubygems'
+require 'yaml'
+require 'active_record'
+
+dbconfig = YAML::load(File.open('./rspec2db.yml'))
+ActiveRecord::Base.establish_connection(dbconfig["dbconnection"])
+
+ActiveRecord::Base.transaction do
+
+  ActiveRecord::Migration.create_table :test_suites do |t|
+    t.string :suite
+    t.timestamps
+  end  
+    
+  ActiveRecord::Migration.create_table :test_runs do |t|
+    t.float :duration
+    t.integer :example_count
+    t.integer :failure_count
+    t.integer :pending_count
+    t.string :build
+    t.string :computer_name
+    t.string :environment
+    t.string :git_hash
+    t.string :git_branch
+    t.timestamps
+	t.references :test_suites
+  end
+  
+  ActiveRecord::Migration.create_table :test_cases do |t|
+    t.string :test_group
+    t.string :context
+    t.string :description
+    t.string :execution_result
+    t.string :screenshot_path
+    t.string :screenshot_url
+    t.text :exception
+    t.string :pending_message
+    t.float :duration
+    t.text :backtrace
+    t.text :metadata
+    t.timestamps
+	t.references :test_runs
+  end
+end

data/lib/rspec2db/db/build_execution_stats.rb

@@ -0,0 +1,60 @@
+require 'rubygems'
+require 'yaml'
+require 'active_record'
+
+module DBUtils
+  def self.build_stats(build_id, file_name, limit, suite, config, reporter_url = 'http://localhost/')
+    ActiveRecord::Base.establish_connection(config)
+    if limit == nil
+      @query = "select tr.* from test_runs tr, test_suites ts where ts.id = tr.test_suites_id and tr.build LIKE '#{build_id}' and ts.suite LIKE '#{suite}' order by tr.created_at desc limit 1"
+    elsif limit == 'all'
+      @query = "select tr.* from test_runs tr, test_suites ts where ts.id = tr.test_suites_id and tr.build LIKE '#{build_id}' and ts.suite LIKE '#{suite}' order by tr.created_at desc"
+    else
+      raise Exception, 'Invalid parameter value.'
+    end
+
+    report = "Execution stats:\n"
+    report << "----------------\n"
+
+    @build = ""
+    @success_rate = []
+    @test_steps_count = 0
+    @test_steps_pass_count = 0
+    @test_steps_failed_count = 0
+    @duration = 0
+    @test_run_id = 0
+
+    @test_runs = TestRun.find_by_sql(@query)
+    @test_runs.each do |test_run|
+      @success_rate << ((test_run.example_count.to_i - test_run.failure_count.to_i).to_f / test_run.example_count.to_f) * 100
+      @test_steps_count = @test_steps_count + test_run.example_count
+      @test_steps_pass_count = @test_steps_pass_count + (test_run.example_count.to_i - test_run.failure_count.to_i)
+      @test_steps_failed_count = @test_steps_failed_count + test_run.failure_count
+      if test_run.duration>@duration
+        @duration = test_run.duration
+      end
+      @build = test_run.build
+      @test_run_id = test_run.id
+    end
+
+    @rate = ( @test_steps_pass_count.to_f / @test_steps_count.to_f ) * 100
+    @formatted_rate = sprintf('%.2f', @rate.to_f)
+    @formatted_duration = sprintf('%.2f', @duration.to_f)
+
+    if reporter_url == nil
+      File.open(file_name, 'w') { |f| f.write("#{report}Build name: #{@build}\nDuration: #{@formatted_duration}s\nSuccess rate: #{@formatted_rate}%\nTest steps count: #{@test_steps_count}\nTest steps passed: #{@test_steps_pass_count}\nTest steps failed: #{@test_steps_failed_count}\n") }
+    else
+      File.open(file_name, 'w') { |f| f.write("#{report}Build name: #{@build}\nDuration: #{@formatted_duration}s\nSuccess rate: #{@formatted_rate}%\nTest steps count: #{@test_steps_count}\nTest steps passed: #{@test_steps_pass_count}\nTest steps failed: #{@test_steps_failed_count}\nTest reporter page: #{reporter_url}/test-runs/#{@test_run_id}/test-cases\n") }
+    end
+
+    sql = "select count(tc.test_group) from test_suites ts, test_runs tr, test_cases tc where ts.id=tr.test_suites_id and tr.id=tc.test_runs_id and tr.build='#{build_id}' and ts.suite='#{suite}' group by tc.test_group"
+    number_of_scripts = TestRun.find_by_sql(sql)
+
+    File.open(file_name, 'a') { |f| f.puts "Number of test scripts: #{number_of_scripts.count}"}
+
+    sql_failed="select count(tc.test_group) from test_suites ts, test_runs tr, test_cases tc where ts.id=tr.test_suites_id and tr.id=tc.test_runs_id and tr.build='#{build_id}' and ts.suite='#{suite}' and tc.execution_result='failed' group by tc.test_group"
+
+    number_of_failed_scripts=TestRun.find_by_sql(sql_failed)
+    File.open(file_name, 'a') { |f| f.puts "Number of failed scripts: #{number_of_failed_scripts.count}"}
+  end
+end

data/lib/rspec2db/db/migrations/2_add_test_case_screenshots.rb

@@ -0,0 +1,10 @@
+require 'yaml'
+require "active_record"
+
+class AddTestCaseScreenshots < ActiveRecord::Migration[5.2]
+  def self.up
+    add_column :test_cases, :screenshot_path, :string
+    add_column :test_cases, :screenshot_url, :string
+    add_column :test_runs, :environment, :string
+  end
+end

data/lib/rspec2db/db/schema.rb

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'yaml'
+require 'active_record'
+
+module DBUtils
+  def self.create_rspec_db(dbconfig)
+    ActiveRecord::Base.establish_connection(dbconfig)
+
+    ActiveRecord::Schema.define(version: 1) do
+      create_table :test_suites, force: :cascade do |t|
+        t.string :suite
+        t.timestamps
+      end
+
+      create_table :test_runs, force: :cascade do |t|
+        t.float :duration
+        t.integer :example_count
+        t.integer :failure_count
+        t.integer :pending_count
+        t.string :build
+        t.string :computer_name
+        t.string :environment
+        t.string :git_hash
+        t.string :git_branch
+        t.timestamps
+        t.references :test_suites
+      end
+
+      create_table :test_cases, force: :cascade do |t|
+        t.string :test_group
+        t.string :context
+        t.string :description
+        t.string :execution_result
+        t.string :screenshot_path
+        t.string :screenshot_url
+        t.text :exception
+        t.string :pending_message
+        t.float :duration
+        t.text :backtrace
+        t.text :metadata
+        t.timestamps
+        t.references :test_runs
+      end
+    end
+  end
+
+  def self.migrate_rspec_db(dbconfig)
+    ActiveRecord::Base.establish_connection(dbconfig)
+    migrations_path = Bundler.rubygems.find_name('rspec2db').first.full_gem_path + '/lib/rspec2db/db/migrations'
+    migration_context = ActiveRecord::MigrationContext.new(migrations_path)
+    migration_context.migrate
+  end
+end

data/lib/rspec2db/models/test_case.rb

@@ -0,0 +1,3 @@
+class TestCase < ActiveRecord::Base
+  belongs_to :testrun
+end

data/lib/rspec2db/models/test_run.rb

@@ -0,0 +1,4 @@
+class TestRun < ActiveRecord::Base
+  has_many :testcases
+  belongs_to :testsuite
+end

data/lib/rspec2db/models/test_suite.rb

@@ -0,0 +1,3 @@
+class TestSuite < ActiveRecord::Base
+  has_many :testruns
+end

data/lib/rspec2db/utils/db_utils.rb

@@ -0,0 +1,99 @@
+require 'active_record'
+require_relative 'rspec_configuration_helper'
+require_relative '../db/schema.rb'
+require_relative '../db/build_execution_stats'
+require_relative '../models/test_case'
+require_relative '../models/test_run'
+require_relative '../models/test_suite'
+
+module DBUtils
+  include RSpecConfigurationHelper
+
+  def connect_to_db(config)
+    ActiveRecord::Base.establish_connection(config['dbconnection'])
+    ActiveRecord::Base.default_timezone = :local
+  end
+
+  def create_test_suite(config)
+    begin
+      test_suite = TestSuite.find_or_create_by(suite: config['options']['suite'])
+    rescue ActiveRecord::RecordNotUnique => active_record_error
+      puts active_record_error
+      test_suite = TestSuite.find_by(suite: config['options']['suite'])
+    end
+  end
+
+  def create_test_run(test_suite, config, global_file_lock = '/tmp/.rspec2db.yaml')
+    test_run_hash = {
+      build: config['options']['build'],
+      test_suites_id: test_suite.id,
+      git_hash: config['options']['git_commit'],
+      git_branch: config['options']['git_branch'],
+      environment: config['options']['environment']
+    }
+    global_lock = File.new(global_file_lock, File::CREAT | File::TRUNC)
+
+    begin
+      global_lock.flock(File::LOCK_EX)
+      test_run = TestRun.where(test_run_hash).first || TestRun.create(test_run_hash)
+      global_lock.flock(File::LOCK_UN)
+    rescue Exception => e
+      puts e.message
+      puts e.backtrace
+    ensure
+      global_lock.flock(File::LOCK_UN)
+    end
+    test_run
+  end
+
+  def create_test_case(test_run, example_group, example, backtrace = nil, screenshot_event = nil)
+    example
+    test_case = TestCase.create(
+      test_runs_id: test_run.id,
+      test_group: example_group.top_level_description,
+      description: example.description,
+      execution_result: example.execution_result.status,
+      duration: example.execution_result.run_time,
+      pending_message: example.execution_result.pending_message.to_s,
+      exception: example.execution_result.exception.to_s)
+
+    if backtrace && !example.execution_result.exception.nil?  && !example.execution_result.exception.backtrace.nil?
+       File.open('/tmp/output', 'w'){ |w| w.write(example.execution_result.exception.backtrace) }
+       test_case.update_attributes(
+         backtrace: example.execution_result.exception.backtrace.join('\n'),
+         metadata: print_example_failed_content(example)
+       )
+    end
+
+    if !example_group.top_level? # check for detecting Context (as opposed to Describe group)
+      test_case.update_attributes(
+        context: example_group.description
+      )
+    end
+    if screenshot_event[:example] && screenshot_event[:example] == example.description
+      screenshot_event.delete :example
+      test_case.update_attributes screenshot_event
+      screenshot_event = {}
+    end
+    test_case
+  end
+
+  def update_test_run(test_run, summary, global_file_lock = nil)
+    global_lock = File.new(global_file_lock, File::CREAT | File::TRUNC)
+    begin
+      global_lock.flock(File::LOCK_EX)
+      test_run.reload
+      test_run.increment(:example_count, summary.example_count)
+             .increment(:failure_count, summary.failure_count)
+             .increment(:pending_count, summary.pending_count)
+             .increment(:duration, summary.duration)
+             .save!
+      global_lock.flock(File::LOCK_UN)
+    rescue Exception => e
+      puts e.message
+      puts e.backtrace
+    ensure
+      global_lock.flock(File::LOCK_UN)
+    end
+  end
+end

data/lib/rspec2db/utils/rspec_configuration_helper.rb

@@ -0,0 +1,127 @@
+module RSpecConfigurationHelper
+  def self.load_config(failsafe = true)
+    rspec_file = '.rspec'
+    file_path = nil
+    File.open(rspec_file).each do |line|
+      file_path = line.split('--options ').last.strip if line.match '--options\s?.+ya?ml'
+    end
+
+    if file_path.nil?
+      puts 'No rspec2db config specified in .rspec'
+      return nil
+    elsif !File.exists?(file_path)
+      puts 'could not find the config file at the following location: ' + file_path
+      abort 'exiting... please check your config file' if failsafe
+      nil
+    else
+      config = YAML::load(File.open(file_path))
+      config['file_path'] = file_path
+      config
+    end
+    # Bakir: disabled override by environment variables because it can cause unwanted side-effects 
+    #(for example: env variable defined by specific name like BUILD can override what user defined in rspec2db.yaml)
+    #override_default_config config
+  end
+
+  def self.generate_local_config(rspec2db_config_file)
+    if File.exist?(rspec2db_config_file)
+      puts 'Default config file exists, override with default? (Y/N)'
+      override = STDIN.gets.chomp
+      return if override == 'N' || override == 'n'
+    end
+
+    puts 'Creating default rspec2db config file (' + rspec2db_config_file + ')'
+    rspec2db_bundler_path = Bundler.rubygems.find_name('rspec2db').first.full_gem_path
+    rspec2db_config_src = rspec2db_bundler_path + '/config/rspec2db.yml'
+    FileUtils.cp rspec2db_config_src, rspec2db_config_file
+  end
+
+  def self.load_local_config
+    rspec2db_default_config_file = './rspec2db.yaml'
+    rspec2db_project_config = RSpecConfigurationHelper.load_config
+    rspec_options_file = '.rspec'
+    unless rspec2db_project_config.nil?
+      puts 'Using project config file'
+    else
+      puts 'No project file specified in .rspec. Looking for default rspec2db.yaml file'
+      if File.exists? rspec2db_default_config_file
+        rspec2db_project_config = YAML::load(File.open(rspec2db_default_config_file))
+      else
+        puts 'File not found, generating a default rpsec2db.yaml'
+        RSpecConfigurationHelper.generate_local_config(rspec2db_default_config_file)
+        rspec2db_project_config = YAML::load(File.open(rspec2db_default_config_file))
+      end
+      RSpecConfigurationHelper.insert_rspec2db_formatter rspec_options_file, rspec2db_default_config_file
+    end
+
+    Hash[rspec2db_project_config['dbconnection'].map { |k, v| [k.to_sym, v] }]
+  end
+
+  def self.insert_rspec2db_formatter(rspec_file, rspec2db_config_file)
+    rspec2db_formatter = "--format Rspec2db\n--options #{rspec2db_config_file}"
+    puts 'Adding rspec2db options and formatter to ' + rspec_file
+    File.open(rspec_file, 'a') do |f|
+      f.puts rspec2db_formatter
+      f.flush
+    end
+  end
+
+  def self.override_default_config(config)
+    config["options"].each do |key, value|
+      config["options"][key] = ENV[key.upcase] unless ENV[key.upcase].nil?
+    end
+
+    config["dbconnection"].each do |key, value|
+      config["dbconnection"][key] = ENV[key.upcase] unless ENV[key.upcase].nil?
+    end
+    config
+  end
+
+  def self.check_rspec_options
+    rspec_options_file = '.rspec'
+    rspec2db_config_file = './rspec2db.yaml'
+
+    return nil unless File.exist?(rspec_options_file)
+    config = RSpecConfigurationHelper.load_config(false)
+    if config.nil?
+      puts 'Creating rspec2db config file (' + rspec2db_config_file + ')'
+      RSpecConfigurationHelper.generate_local_config rspec2db_config_file
+      RSpecConfigurationHelper.insert_rspec2db_formatter rspec_options_file, rspec2db_config_file
+      return RSpecConfigurationHelper.load_config
+    end
+    puts 'rspec2db config file already exists (' + config['file_path'] + ')'
+    config['dbconnection']
+  end
+
+
+  def extract_rspec_core_version
+    Gem.loaded_specs['rspec-core'].version.to_s.split('.').map { |v| v.to_i }
+  end
+
+  def load_snippet_extractor
+    major_version, minor_version = @rspec_core_version
+
+    if major_version == 3 && minor_version < 4
+      require 'rspec/core/formatters/snippet_extractor'
+      RSpec::Core::Formatters::SnippetExtractor.new
+    elsif major_version == 3 && minor_version >= 4
+      require 'rspec/core/formatters/html_snippet_extractor'
+      RSpec::Core::Formatters::HtmlSnippetExtractor.new
+    end
+  end
+
+  def print_example_failed_content(example)
+    print_content = ''
+    exception = example.execution_result.exception
+    return print_content if exception.backtrace.nil?
+
+    backtrace_content = exception.backtrace.map { |line| RSpec::Core::BacktraceFormatter.new.backtrace_line(line) }
+    backtrace_content.compact!
+    snippet_extractor ||= load_snippet_extractor
+
+    snippet_content = snippet_extractor.snippet(backtrace_content)
+    snippet_content = snippet_content.sub( "class=\"offending\"", "class=\"offending\" style=\"background-color: red;\"" )
+    print_content = "    <pre class=\"ruby\" style=\"background-color: #E6E6E6; border: 1px solid;\"><code>#{snippet_content}</code></pre>"
+    print_content
+  end
+end

data/lib/rspec2db.rb

@@ -0,0 +1,106 @@
+require 'rspec/core/formatters/base_text_formatter'
+require 'active_record'
+require 'yaml'
+require_relative './rspec2db/utils/db_utils'
+require_relative './rspec2db/utils/rspec_configuration_helper'
+
+
+class Rspec2db < RSpec::Core::Formatters::BaseTextFormatter
+  include DBUtils
+  include RSpecConfigurationHelper
+
+  RSpec::Core::Formatters.register self, :start,
+                                         :example_group_started,
+                                         :example_started,
+                                         :example_passed,
+                                         :example_pending,
+                                         :example_failed,
+                                         :dump_failures,
+                                         :dump_pending,
+                                         :dump_summary,
+                                         :dump_profile,
+                                         :screenshot_saved,
+                                         :screenshot_uploaded
+
+  attr_reader :output,
+              :results,
+              :config,
+              :example_group,
+              :global_file_lock,
+              :test_run,
+              :test_suite
+
+
+  def initialize(output)
+    @output = output || StringIO.new
+    @global_file_lock = '/tmp/rspec2db.lock'
+    @config = RSpecConfigurationHelper.load_config
+    connect_to_db @config
+    @test_suite = create_test_suite(@config)
+    @test_run = create_test_run(@test_suite, @config)
+    @screenshot_event = {}
+  end
+
+  def start(notification)
+  end
+
+  def example_group_started(notification)
+    @example_group = notification.group
+  end
+
+  def example_group_finished(notification)
+  end
+
+  def example_started(example)
+  end
+
+  def example_passed(notification)
+    
+    @current_test_case = create_test_case(@test_run, @example_group, notification.example, @config['options']['backtrace'], @screenshot_event)
+  end
+
+  def example_pending(notification)
+    @current_test_case = create_test_case(@test_run, @example_group, notification.example, @config['options']['backtrace'], @screenshot_event)
+  end
+
+  def example_failed(notification)
+    @current_test_case = create_test_case(@test_run, @example_group, notification.example, @config['options']['backtrace'], @screenshot_event)
+  end
+
+  def message(notification)
+  end
+
+  def start_dump(notification)
+  end
+
+  def dump_pending(notification)
+  end
+
+  def dump_profile(notification)
+  end
+
+  def dump_failures(notification)
+  end
+
+  def screenshot_saved(notification)
+    @screenshot_event.merge!(
+      screenshot_path: notification[:screenshot_path],
+      example: notification[:example]
+    )
+  end
+
+  def screenshot_uploaded(notification)
+    @screenshot_event.merge!(
+      screenshot_url: notification[:screenshot_url],
+      example: notification[:example]
+    )
+  end
+
+  def dump_summary(notification)
+    update_test_run(@test_run, notification, @global_file_lock)
+  end
+
+  def seed(seed)
+  end
+
+end

data/rspec2db.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |s|
+  s.name          = 'rspec2db'
+  s.version       = '1.2.0'
+  s.date          = '2018-01-01'
+  s.summary       = 'Save your RSpec test results to a database'
+  s.description   = 'A simple RSpec formatter to enable writing RSpec test results to any database using ActiveRecord. Specify DB connection in a yml file and put path to that file as --options PATH in your .rspec file'
+  s.authors       = ['Nermin Caluk', 'Bakir Jusufbegovic', 'Adnan Muslija']
+  s.email         = ['bakir@atlantbh.com', 'adnan.muslija@atlantbh.com']
+  s.files         = ['lib/rspec2db.rb', 'bin/rspec2db', 'config/rspec2db.yml']
+  s.executables   = ['rspec2db']
+  s.files =  `git ls-files`.split("\n")
+  s.homepage      = 'https://github.com/ATLANTBH/rspec'
+
+  s.add_dependency 'activerecord', '~>5.1'
+  s.add_dependency 'pg', '~>0.21'
+  s.add_dependency 'activerecord-postgresql-adapter'
+  s.add_dependency 'rspec', '>= 3.0'
+end

data/spec/spec_spec.rb

@@ -0,0 +1,19 @@
+describe "Dummy describe" do # this spec file is just for test / demo purposes
+  context "CoNtExT" do
+    it "does nothing, within context" do
+      1.should eql(1)
+    end
+  end 
+  
+  it "does nothing again" do
+    1.should eql(1)
+  end
+  
+  it "raises" do
+    raise "oh no"
+  end
+  
+  it "pends" do pending
+  end
+  
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: rspec2db
+version: !ruby/object:Gem::Version
+  version: 1.2.0
+platform: ruby
+authors:
+- Nermin Caluk
+- Bakir Jusufbegovic
+- Adnan Muslija
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: activerecord-postgresql-adapter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A simple RSpec formatter to enable writing RSpec test results to any
+  database using ActiveRecord. Specify DB connection in a yml file and put path to
+  that file as --options PATH in your .rspec file
+email:
+- bakir@atlantbh.com
+- adnan.muslija@atlantbh.com
+executables:
+- rspec2db
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".project"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- README.md
+- bin/rspec2db
+- config/rspec2db.yml
+- config/rspec_db.rb
+- lib/rspec2db.rb
+- lib/rspec2db/db/build_execution_stats.rb
+- lib/rspec2db/db/migrations/2_add_test_case_screenshots.rb
+- lib/rspec2db/db/schema.rb
+- lib/rspec2db/models/test_case.rb
+- lib/rspec2db/models/test_run.rb
+- lib/rspec2db/models/test_suite.rb
+- lib/rspec2db/utils/db_utils.rb
+- lib/rspec2db/utils/rspec_configuration_helper.rb
+- rspec2db.gemspec
+- spec/spec_spec.rb
+homepage: https://github.com/ATLANTBH/rspec
+licenses: []
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Save your RSpec test results to a database
+test_files: []