dtf 0.2.1 → 0.2.2

data/app/models/user.rb

@@ -0,0 +1,12 @@
+# -*- coding: UTF-8 -*-
+
+class User < ActiveRecord::Base
+
+  attr_accessible :full_name, :email_address, :user_name
+  validates_presence_of :full_name, :email_address, :user_name
+
+  has_many :verification_suites, :dependent => :destroy
+  has_many :analysis_cases, :through => :verification_suites, :dependent => :destroy
+  has_many :case_tests, :through => :verification_suites, :dependent => :destroy
+
+end

data/app/models/verification_suite.rb

@@ -0,0 +1,22 @@
+# -*- coding: UTF-8 -*-
+
+class VerificationSuite < ActiveRecord::Base
+
+  attr_accessible :name, :description
+  validates_presence_of :name, :description
+
+  belongs_to :user, :autosave => :true
+  has_many :analysis_cases, :dependent => :destroy
+  has_many :case_tests, :through => :analysis_cases, :dependent => :destroy
+
+  # ASSOCIATIONS BREAKDOWN
+  # ----------------------
+  # Each VerificationSuite is comprised of many AnalysisCases, Each AnalysisCase
+  # contain multiple case_tests, owned by both the User and the AnalysisCase.
+  # The goal is to make 'packs' of tests which Users can share between Suites,
+  # grouped by Cases, and even share those Tests between Cases. Also, Users
+  # should be able to share their individual Test(s), AnalysisCase(s), and
+  # VerificationSuite(s) with other Users for inclusion in their own
+  # AnalysisCase(s) and Suite(s) allowing for mix-and-match batching.
+
+end

data/bin/dtf

@@ -1,7 +1,28 @@
 #!/usr/bin/env ruby
+#
+# This is the master script to be used to manage the various Verification Suites,
+# Analysis Cases, and Case Tests
+#
+# Ex: dtf create_user -u|--user @user_name -n|--name "John Public" -e|--email
+# "j@public.com"
+#
+# -u -n and -e are _required_ parameters
+#
+# Accessing the help system
+# Ex: dtf help create_user
 
-program_root = File.dirname( File.dirname( __FILE__ ) )
+require 'dtf'
+require 'optparse'
 
-require "#{program_root}/lib/dtf"
+options = {}
 
-exit DTF.new.run_tests ARGV
+OptionParser.new do |opts|
+  opts.banner = "Usage: dtf <cmd> [options]"
+  
+  opts.on("-h", "--help",
+          "Show this message") do |h|
+    options[:help] = h
+    puts opts
+  end
+
+end.parse!

data/bin/dtf-create_user

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+#
+# This script is used to create User entries in the db for owning the various
+# Verification Suites, Analysis Cases, and Case Tests
+#
+# Ex: dtf-create_user -u|--user @user_name -n|--name "John Public" -e|--email
+# "j@public.com"
+#
+# -u -n and -e are _required_ parameters
+#
+

data/bin/dtf-create_vs

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+#
+# This file is used to create a Verification Suite from the commandline.
+# A owning User, which must already exist, must be passed for ownership.
+# At minimum, the name of the suite must also be passed.
+#
+# Ex: dtf-create_vs -u|--user @user_name -n|--name "DTF Testing Suite"
+# -u and -n are _required_ parameters
+#
+

data/bin/dtf-delete_user

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+#
+# This script is used to delete existing User entries in the db
+# This script will also need to reassign any existing entries such as for their
+# Verification Suites, Analysis Cases, and Case Tests to the Public user
+# The Public user is a generic user that needs to be created initially so that
+# when a user is deleted, their suites are assigned to Public if they wish to
+# be kept. The deletion should ask if the suites should be permanently deleted
+# or reassigned to Public.
+#
+# Ex: dtf-delete_user -u|--user @user_name [--all] [--reassign]
+# --all means to delete all the user test suites permenantly
+# --reassign means reassign test suites to the Public user for reuse by others
+#   first, and then delete the specified user.
+#
+# -u and EITHER --all OR --reassign are _required_ parameters
+#
+

data/bin/dtf-delete_vs

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+#
+# This script is used to delete existing Verification Suite entries in the db
+# The Public user is a generic user that needs to be created initially so that
+# when a user is deleted, their suites are assigned to Public if they wish to
+# be kept. The deletion should ask if the suites should be permanently deleted
+# or reassigned to Public. This applies to all Analysis Cases, and Case Tests
+# as well
+#
+# Ex dtf-delete_vs -u|--user @user_name -n|--name "DTF Testing Suite"
+#
+# -u and -n are _required_ parameters
+#
+

data/bin/dtf-setup

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'dtf'
+require 'thor'
+
+%x[thor dtf_setup:install]
+

data/db/migrate/20120503050925_create_users.rb

@@ -0,0 +1,15 @@
+class CreateUsers < ActiveRecord::Migration
+  def self.up
+    create_table :users do |t|
+      t.string  :full_name
+      t.string  :user_name
+      t.string  :email_address
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :users
+  end
+end

data/db/migrate/20120508000959_create_verification_suites.rb

@@ -0,0 +1,14 @@
+class CreateVerificationSuites < ActiveRecord::Migration
+  def self.up
+    create_table :verification_suites do |t|
+      t.string      :name
+      t.text        :description
+      t.references  :user
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :verification_suites
+  end
+end

data/db/migrate/20120616203047_create_analysis_cases.rb

@@ -0,0 +1,15 @@
+class CreateAnalysisCases < ActiveRecord::Migration
+  def self.up
+    create_table :analysis_cases do |t|
+      t.string      :name
+      t.string      :description
+      t.references  :verification_suite
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :analysis_cases
+  end
+end

data/db/migrate/20120616203436_create_case_tests.rb

@@ -0,0 +1,15 @@
+class CreateCaseTests < ActiveRecord::Migration
+  def self.up
+    create_table :case_tests do |t|
+      t.string      :description
+      t.text        :cmd
+      t.references  :analysis_case
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :case_tests
+  end
+end

data/db/schema.rb

@@ -0,0 +1,48 @@
+# encoding: UTF-8
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended to check this file into your version control system.
+
+ActiveRecord::Schema.define(:version => 20120616203436) do
+
+  create_table "analysis_cases", :force => true do |t|
+    t.string   "name"
+    t.string   "description"
+    t.integer  "verification_suite_id"
+    t.datetime "created_at",            :null => false
+    t.datetime "updated_at",            :null => false
+  end
+
+  create_table "case_tests", :force => true do |t|
+    t.string   "description"
+    t.text     "cmd"
+    t.integer  "analysis_case_id"
+    t.datetime "created_at",       :null => false
+    t.datetime "updated_at",       :null => false
+  end
+
+  create_table "users", :force => true do |t|
+    t.string   "full_name"
+    t.string   "user_name"
+    t.string   "email_address"
+    t.datetime "created_at",    :null => false
+    t.datetime "updated_at",    :null => false
+  end
+
+  create_table "verification_suites", :force => true do |t|
+    t.string   "name"
+    t.text     "description"
+    t.integer  "user_id"
+    t.datetime "created_at",  :null => false
+    t.datetime "updated_at",  :null => false
+  end
+
+end

data/dtf.gemspec

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/dtf/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors           = ["Deryl R. Doucette"]
+  gem.email             = ["me@deryldoucette.com"]
+  gem.description       = %q{DTF is a modular testing framework skeleton. This is the control gem which contains the Suite's db schema(s) and control/management scripts.}
+  gem.summary           = %q{DTF is a modular testing framework. This is the control gem.}
+  gem.homepage          = "https://github.com/dtf-gems/dtf"
+  gem.license           = 'MIT'
+  gem.platform          = Gem::Platform::RUBY
+  gem.files             = `git ls-files`.split($\)
+  gem.executables       = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files        = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name              = "dtf"
+  gem.require_paths     = ["lib"]
+  gem.version           = Dtf::VERSION
+  gem.rubyforge_project = "dtf"
+  gem.required_ruby_version = ">= 1.9.3"
+
+  gem.add_dependency "thor"
+  gem.add_dependency "rake"
+  gem.add_dependency "activerecord"
+  gem.add_dependency "activemodel"
+  gem.add_dependency "activesupport"
+  gem.add_dependency "sqlite3"
+  gem.add_dependency "json"
+  gem.add_dependency "json_pure"
+  gem.add_dependency "standalone_migrations"
+
+  gem.add_development_dependency "turnip"
+  gem.add_development_dependency "rspec", [">=2.10.0"]
+  gem.add_development_dependency "fabrication"
+  gem.add_development_dependency "vcr"
+
+end

data/examples/db/config.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: sqlite3
+  database: db/dtf_development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/dtf_test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/dtf_production.sqlite3
+  pool: 5
+  timeout: 5000

data/lib/config/environment.rb

@@ -0,0 +1,49 @@
+# -*- coding: UTF-8 -*-
+
+# Application wide requirements
+require 'active_record'
+require 'active_model'
+require 'active_support'
+require 'multi_json'
+require 'sqlite3'
+require 'yaml'
+require 'logger'
+require 'thor'
+
+# NOTE: Set RAILS_ENV to 'production' for ActiveRecord. Affects the database to use.
+# Change this to 'development' while working on the gem itself, or set it in the
+# environment prefixed to commands, in order to gain access to testing gems.
+ENV['RAILS_ENV'] ||= 'development'
+
+# This section is for development and testing. Load your testing framework(s) require's here
+case ENV['RAILS_ENV']
+when 'development', 'test'
+  require 'rspec'
+  require 'turnip'
+  require 'pry'
+  require 'pry-debugger'
+  require 'pry-doc'
+  require 'pry-stack_explorer'
+  require 'pry-exception_explorer'
+  require 'pry-git'
+  require 'pry-editline'
+  require 'pry-highlight'
+  require 'pry-buffers'
+  require 'pry-developer_tools'
+  require 'pry-syntax-hacks'
+  require 'fabrication'
+else
+  true
+end
+
+# Load the db config and create a connectoid. Make an ivar so its shared throughout the application
+@dbconfig = YAML::load(File.open(File.join(File.dirname(__FILE__), '../../db/config.yml')))[ENV['RAILS_ENV']]
+
+# Establish the database connection
+ActiveRecord::Base.establish_connection(@dbconfig) # Line that actually connects the db.
+
+# Load all the models
+Dir["#{File.join(File.dirname(__FILE__), '../../app/models/*.rb')}"].each do |model|
+  load "#{model}"
+end
+

data/lib/dtf.rb

@@ -1,94 +1,7 @@
-require 'rubygems'
-require 'singleton'
-require 'yaml'
-require 'session'
+# -*- coding: UTF-8 -*-
 
-lib_root = File.dirname( __FILE__ )
+require "dtf/version"
 
-# include lib in path so plugins get found with Gem.find_files
-$:.unshift "#{lib_root}"
-
-class DTF; end
-# load dtf/*.rb
-Dir["#{lib_root}/dtf/*.rb"].each{|lib| require lib }
-
-class DTF
-  def initialize
-    @ruby = File.join(RbConfig::CONFIG["bindir"],RbConfig::CONFIG["ruby_install_name"])
-    @plugins = DTF::Plugins.instance
-    @failures = 0
-  end
-
-  def run_tests args
-    @plugins.load(%w( all_test ))
-    input_files, not_processed = @plugins.parse_args(args)
-    if not_processed.size > 0
-      $stderr.puts "No plugin recognized this option '#{not_processed*" "}'."
-      exit 1
-    end
-    @plugins.load(%w( ErrorSummaryOutput )) if @plugins.output_plugins.empty?
-    process(input_files)
-    @failures == 0
-  end
-
-  def process input_files
-    @plugins.output_plugins(:start_processing)
-    input_files.each do |plugin,file|
-      process_test( plugin.load(file) )
-    end
-    @plugins.output_plugins(:end_processing)
-  end
-
-  def env shell
-    Hash[ shell.execute(
-      @ruby + ' -e \'ENV.each{|k,v| printf "#{k}=#{v}\0"}\''
-    )[0].split("\0").map{|var| var.split('=', 2) } ]
-  end
-
-  def process_test test
-    name, commands = test[:name], test[:commands]
-    shell = Session::Bash.new
-    _env = env(shell)
-    @plugins.output_plugins(:start_test, test, _env)
-    commands.each do |line|
-      command, tests = line[:cmd], line[:tests]
-      @plugins.output_plugins(:start_command, line)
-      _stdout  = StringIO.new
-      _stderr  = StringIO.new
-      _stdboth = StringIO.new
-      shell.execute "#{command}" do |out, err|
-        if out
-          @plugins.output_plugins(:command_out, out)
-          _stdout  << out
-          _stdboth << out
-        end
-        if err
-          @plugins.output_plugins(:command_err, err)
-          _stderr  << err
-          _stdboth << err
-        end
-      end
-      _status = shell.status
-      _env = env(shell)
-      @plugins.output_plugins(:end_command, line, _status, _env)
-      process_command_tests _stdout.string, _stderr.string, _stdboth.string, _status, _env, tests
-    end
-    @plugins.output_plugins(:end_test, test)
-  end
-
-  def process_command_tests _stdout, _stderr, _stdboth, _status, env, tests
-    tests.each do |test|
-      plugin = @plugins.test_plugins.find{|_plugin| _plugin.matches? test }
-      if plugin.nil?
-        status, msg = false, "Could not find plugin for test '#{test}'."
-      else
-        status, msg = plugin.execute(test, _stdout, _stderr, _stdboth, _status, env)
-      end
-      @failures+=1 unless status
-      @plugins.output_plugins(:test_processed, test, status, msg)
-    end
-  end
-
-  class << self
-  end
+module Dtf
+  load "#{File.join(File.dirname(__FILE__), "/config/environment.rb")}"
 end