dtf 0.2.2 → 0.2.3

data/dtf.gemspec

@@ -27,10 +27,12 @@ Gem::Specification.new do |gem|
   gem.add_dependency "json"
   gem.add_dependency "json_pure"
   gem.add_dependency "standalone_migrations"
+  gem.add_dependency "trollop" # This implements the help system
 
   gem.add_development_dependency "turnip"
   gem.add_development_dependency "rspec", [">=2.10.0"]
   gem.add_development_dependency "fabrication"
   gem.add_development_dependency "vcr"
-
+  gem.add_development_dependency "yard"      # For generating documentation
+  gem.add_development_dependency "redcarpet" # For generating YARD docs
 end

data/lib/config/environment.rb

@@ -1,4 +1,4 @@
-# -*- coding: UTF-8 -*-
+# encoding: UTF-8
 
 # Application wide requirements
 require 'active_record'

data/lib/dtf.rb

@@ -1,7 +1,90 @@
-# -*- coding: UTF-8 -*-
+# encoding: UTF-8
 
 require "dtf/version"
 
 module Dtf
   load "#{File.join(File.dirname(__FILE__), "/config/environment.rb")}"
-end
+
+  class DtfCommands
+    def self.create_user(cmd_opts)
+      if [:user_name_given, :full_name_given, :email_address_given].all? { |sym| cmd_opts.key?(sym) } then
+        user = User.where(user_name:     cmd_opts[:user_name],
+                           full_name:     cmd_opts[:full_name],
+                           email_address: cmd_opts[:email_address]).first_or_create
+
+        # Check to make sure user was actually saved to the db
+        if user.persisted? then
+          puts "Created user \'#{cmd_opts[:user_name]}\' for \'#{cmd_opts[:full_name]}\'"
+        else
+          # Oops, it wasn't! Notify user and display any error message(s)
+          $stderr.puts "ERROR: #{cmd_opts[:user_name].to_s} was NOT created! Please fix the following errors and try again:"
+          user.errors.messages.keys.each do |key|
+            $stderr.puts "#{key.to_s.capitalize.gsub('_', ' ').to_s} #{user.errors.messages[key][0].to_s}!"
+          end
+          # Now throw a proper error code to the system, while exiting the script
+          abort()
+        end
+      else
+        raise_error # This error here is thrown when not all params are provided
+      end
+    end
+    
+    def self.delete_user(cmd, cmd_opts)
+      if [:user_name_given, :delete_all].all? { |sym| cmd_opts.key?(sym) } then
+        # NOTE: :delete_all is 'true' by default. passing '--no-delete-all' sets it to false,
+        # and adds the :delete_all_given key to the cmd_opts hash, set to true.
+        # This means NOT to delete all VSs associated with this user. We delete them by default.
+        if cmd_opts[:delete_all] == false && cmd_opts[:delete_all_given] == true
+          puts "#{cmd} called with '--no-delete-all' set! NOT deleting all owned VSs!"
+          puts "Reassigning VSs to Library. New owner will be \'Library Owner\'"
+          user      = User.find_by_user_name(cmd_opts[:user_name])
+          lib_owner = User.find_by_user_name("library_owner")
+          user.verification_suites.all.each do |vs|
+            vs.user_id = lib_owner.id
+            vs.save
+          end
+          User.delete(user)
+        else
+          puts "#{cmd} called with '--delete-all' set or on by default! Deleting all VSs owned by #{cmd_opts[:user_name]}"
+          user = User.find_by_user_name(cmd_opts[:user_name])
+          user.verification_suites.all.each do |vs|
+            VerificationSuite.delete(vs)
+          end
+          if user.verification_suites.empty? then
+            User.delete(user)
+          end
+        end
+      else
+        raise_error
+      end
+    end
+    
+    def self.create_vs(cmd_opts)
+      if [:user_name_given, :name_given].all? { |sym| cmd_opts.key?(sym) } then
+        user = User.find_by_user_name(cmd_opts[:user_name])
+        vs   = user.verification_suites.create(name: cmd_opts[:name], description: cmd_opts[:description])
+        if vs.persisted? then
+          puts "VS named \'#{cmd_opts[:name]}\' allocated to user \'#{cmd_opts[:user_name]}\'"
+        else
+          $stderr.puts "ERROR: Failed to save Verification Suite. Check DB logfile for errors"
+          abort()
+        end
+      else
+        raise_error
+      end
+    end
+    
+    def self.delete_vs(cmd, cmd_opts)
+      if [:user_name_given, :id_given].all? { |sym| cmd_opts.key?(sym) } then
+        puts "#{cmd} called! Deleting #{cmd_opts[:user_name]}\'s VS with ID \'#{cmd_opts[:id]}\'"
+        user = User.find_by_user_name(cmd_opts[:user_name])
+        vs   = user.verification_suites.find(cmd_opts[:id])
+        VerificationSuite.delete(vs)
+      else
+        raise_error
+      end
+    end    
+
+  end # End of class
+
+end # End of module

data/lib/dtf/dtf_error_system.rb

@@ -0,0 +1,16 @@
+# encoding: UTF-8
+# Reusable error response method
+def raise_error
+  raise ArgumentError
+rescue
+  $stderr.puts "ERROR! #{@cmd} did not receive all required options."
+  $stderr.puts "See 'dtf #{@cmd} -h' for help with this sub-command"
+
+  # Set non-zero exit value on error, for scripting use.
+  abort()
+end
+
+def display_errors()
+  # TODO: Refactor error display to take sub-command as an arg
+  # and display obj.errors.messages.each properly for each arg type.
+end

data/lib/dtf/dtf_help_system.rb

@@ -0,0 +1,55 @@
+# encoding: UTF-8
+# DTF Help System
+require 'trollop' # Used to implement help system
+
+SUB_COMMANDS = %w(create_user delete_user create_vs delete_vs)
+
+# Global options default to '--version|-v' and '--help|-h'
+global_opts = Trollop::options do
+  version "DTF v#{Dtf::VERSION}"
+  banner <<-EOS
+  #{version}
+  (c) Copyright 2012 David Deryl Downey / Deryl R. Doucette. All Rights Reserved.
+  This is free software; see the LICENSE file for copying conditions.
+  There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+
+  Usage:
+        dtf -v|--version -h|--help [[sub_cmds <options>] -h|--help]
+  
+  Valid [sub_cmds] are: create_(user|vs), delete_(user|vs)
+  See 'dtf [sub_cmd] -h' for each sub_cmd's details and options
+    
+EOS
+  stop_on SUB_COMMANDS
+end
+
+# Sub-commands go here
+@cmd = ARGV.shift
+@cmd_opts = case @cmd
+  when "create_user"
+    Trollop::options do
+      opt(:user_name, desc="Username for new TF user - REQUIRED", opts={:type => :string, :short => '-u'})
+      opt(:full_name, desc="Real name for new TF user - REQUIRED", opts={:type => :string, :short => '-n'})
+      opt(:email_address, desc="Email address for new TF user - REQUIRED", opts={:type => :string, :short => '-e'})
+    end
+  when "create_vs"
+    Trollop::options do
+      opt(:user_name, desc="TF user to associate this VS with - REQUIRED", opts={:type => :string, :short => '-u'})
+      opt(:name, desc="Name for new VS - REQUIRED", opts={:type => :string, :short => '-n'})
+      opt(:description, desc="Description of VS's intended use - OPTIONAL", opts={:type => :string, :short => '-d', :default => ''})
+    end
+  when "delete_user"
+    Trollop::options do
+      opt(:user_name, desc="Username of TF user to delete - REQUIRED", opts={:type => :string, :short => '-u'})
+      opt(:delete_all, desc="Delete _all_ VSs this user owns", :type => :flag, :default => true)
+    end
+  when "delete_vs"
+    Trollop::options do
+      opt(:user_name, desc="Username of VS owner - REQUIRED", opts={:type => :string, :short => '-u'})
+      opt(:id, desc="ID of VS to be deleted - REQUIRED", opts={:type => :int, :short => '-i'})
+    end
+  when nil
+    Trollop::die "No command specified! Please specify an applicable command"
+  else
+    Trollop::die "Unknown DTF sub-command: #{cmd.inspect}"
+  end

data/lib/dtf/version.rb

@@ -1,5 +1,5 @@
-# -*- coding: UTF-8 -*-
+# encoding: UTF-8
 
 module Dtf
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

data/lib/tasks/setup.thor

@@ -1,9 +1,11 @@
+# encoding: UTF-8
+
 class DtfSetup < Thor
 
-  desc "install", "installs database schemas and control scripts"
+  desc "install", "Installs database migrations, the main schema, and configuration files"
   method_options :force => :boolean
   def install(name= "*")
-    puts "installing db schemas and control scripts"
+    puts "Installing db migrations, main schema, and config files"
 
     # The gem is installed elsewhere so the copy path needs to be
     # relative to the gem, not the user.
@@ -25,7 +27,7 @@ class DtfSetup < Thor
     end
   end
 
-  desc "config [NAME]", "copy db configuration file(s)"
+  desc "config [NAME]", "Copy db configuration file(s)"
   method_options :force => :boolean
   def config(name = "*")
 

data/spec/acceptance/create_basic_associations.feature

@@ -0,0 +1,13 @@
+# encoding: UTF-8
+
+Feature: Verification of User associations
+  Background:
+    Given a User
+
+  Scenario: User should own Verification Suites
+    When I create a Verification Suite
+    Then I should own a Verification Suite
+
+  Scenario: User should own Analysis Cases
+    When I create an Analysis Case
+    Then I should own an Analysis Case

data/spec/acceptance/implement_help_system.feature

@@ -0,0 +1,16 @@
+# encoding: UTF-8
+
+Feature: DTF Help System is correctly implemented
+  Background:
+    Given I have dtf installed
+
+    Scenario Outline: Sub-command specific help is received
+		Given I request help for sub-command <sub_cmd>
+		Then I should see <help_response> in the response
+
+		Examples:
+		| sub_cmd     | help_response |
+        | create_user | --email       |
+        | delete_user | --delete-all  |
+        | create_vs   | --name        |
+        | delete_vs   | --id          |

data/spec/fabricators/analysis_case_fabricator.rb

@@ -1,4 +1,4 @@
-# -*- coding: UTF-8 -*-
+# encoding: UTF-8
 
 Fabricator(:analysis_case) do
   name "DTF Analysis Case"

data/spec/fabricators/case_test_fabricator.rb

@@ -1,4 +1,4 @@
-# -*- coding: UTF-8 -*-
+# encoding: UTF-8
 
 Fabricator(:case_test) do
   description "Fabricated CT for DTF testing"

data/spec/fabricators/user_fabricator.rb

@@ -1,8 +1,8 @@
-# -*- coding: UTF-8 -*-
+# encoding: UTF-8
 
 Fabricator(:user) do
-  full_name "John Q Public"
-  email_address "jqp@public.com"
-  user_name "johnpublic"
+  full_name { sequence(:num, 5 ) { |num| "John Q Public #{num}" } }
+  email_address { sequence(:email_address, 5) { |num| "jqp#{num}@public.com" } }
+  user_name  { sequence(:user_name, 5) { |num| "johnpublic#{num}" } }
 end
 

data/spec/fabricators/verification_suite_fabricator.rb

@@ -1,4 +1,4 @@
-# -*- coding: UTF-8 -*-
+# encoding: UTF-8
 
 Fabricator(:verification_suite) do
   name "DTF Verification Suite"

data/spec/models/analysis_case_spec.rb

@@ -1,21 +1,63 @@
-# -*- coding: UTF-8 -*-
+# encoding: UTF-8
 
 require 'spec_helper'
 
-describe "Analysis Case" do
+describe "AnalysisCase" do
 
-  puts "Analysis Case Benchmark"
-  puts Benchmark.measure { let (:analysis_case) { Fabricate(:analysis_case) } }
+  context "when instantiated" do
 
+    let(:analysis_case) { AnalysisCase.new }
+    
+    it "should be the proper class" do
+      analysis_case.should be_a(AnalysisCase)      
+    end
+    
+    it "should be invalid without being assigned to a verification suite" do    
+      analysis_case.should_not be_valid
+      analysis_case[:verification_suite_id].should be_nil
+      analysis_case.new_record?.should be_true
+    end  
+  
+    it "should be invalid without a name" do    
+      analysis_case.should_not be_valid
+      analysis_case.errors.messages[:name].should eq(["can't be blank"])
+      analysis_case.new_record?.should be_true
+    end
+    
+    it "should be invalid without a description" do    
+      analysis_case.should_not be_valid
+      analysis_case.errors.messages[:description].should eq(["can't be blank"])
+      analysis_case.new_record?.should be_true
+    end
 
-  let(:analysis_case) { Fabricate(:analysis_case) }
+    it "should not be saved" do
+      analysis_case.new_record?.should be_true
+      analysis_case.persisted?.should_not be_true
+    end
 
-  it "should be created/fabricated" do
-    analysis_case.should be_a(AnalysisCase)
-  end
+  end  
+  
+  context "when created" do
+    user = Fabricate(:user)
+    vs = user.verification_suites.create(name: "RSpec Test VS", description: "Bogus VS for RSpec")
+    analysis_case = vs.analysis_cases.create(name: "RSpec Test AC", description: "Bogus AC for RSpec")
+      
+    it "should be owned by a verification suite" do    
+      analysis_case.should be_valid
+      analysis_case.verification_suite_id.should_not be_nil
+    end  
 
-  it "should be persisted" do
-    analysis_case.save
-    analysis_case.persisted?
+    it "should have a valid name and description" do    
+      analysis_case.should be_valid
+      analysis_case.errors.messages.should be_empty
+      analysis_case.name.should_not be_nil
+      analysis_case.description.should_not be_nil
+    end  
+  
+    it "should be saved" do
+      analysis_case.should be_valid
+      analysis_case.new_record?.should_not be_true
+      analysis_case.persisted?.should be_true
+    end
   end
 end

data/spec/models/case_test_spec.rb

@@ -1,20 +1,66 @@
-# -*- coding: UTF-8 -*-
+# encoding: UTF-8
 
 require 'spec_helper'
 
-describe "Case Test" do
+describe "CaseTest" do
 
-  puts "Case Test Benchmark"
-  puts Benchmark.measure { let (:case_test) { Fabricate(:case_test) } }
+  context "when instantiated" do
 
- let(:case_test) { Fabricate(:case_test) }
+    let(:case_test) { CaseTest.new }
+    
+    it "should be the proper class" do
+      case_test.should be_a(CaseTest)      
+    end
+    
+    it "should be invalid without being assigned to a analysis case" do
+      case_test.should_not be_valid
+      case_test[:analysis_case_id].should be_nil
+      case_test.new_record?.should be_true
+    end  
+  
+    it "should be invalid without a cmd" do    
+      case_test.should_not be_valid
+      case_test.errors.messages[:cmd].should eq(["can't be blank"])
+      case_test.new_record?.should be_true
+    end
+    
+    it "should be invalid without a description" do    
+      case_test.should_not be_valid
+      case_test.errors.messages[:description].should eq(["can't be blank"])
+      case_test.new_record?.should be_true
+    end
 
-  it "should be created/fabricated" do
-    case_test.should be_a(CaseTest)
-  end
+    it "should not be saved" do
+      case_test.new_record?.should be_true
+      case_test.persisted?.should_not be_true
+    end
+
+  end  
+  
+  context "when created" do
+    user = Fabricate(:user)
+    vs = user.verification_suites.create(name: "RSpec Test VS", description: "Bogus VS for RSpec")
+    analysis_case = vs.analysis_cases.create(name: "RSpec Test AC", description: "Bogus AC for RSpec")
+    case_test = analysis_case.case_tests.create(cmd: "bundle exec rspec spec", 
+                                                description: "Bogus CT for RSpec"
+                                                )
+    
+    it "should be owned by an analysis case" do    
+      case_test.should be_valid
+      case_test.analysis_case_id.should_not be_nil
+    end  
 
-  it "should be persisted" do
-    case_test.save
-    case_test.persisted?
+    it "should have a valid cmd and description" do    
+      case_test.should be_valid
+      case_test.errors.messages.should be_empty
+      case_test.cmd.should_not be_nil
+      case_test.description.should_not be_nil
+    end  
+  
+    it "should be saved" do
+      case_test.should be_valid
+      case_test.new_record?.should_not be_true
+      case_test.persisted?.should be_true
+    end
   end
 end

data/spec/models/user_spec.rb

@@ -1,21 +1,56 @@
-# -*- coding: UTF-8 -*-
+# encoding: UTF-8
 
 require 'spec_helper'
-require 'benchmark'
 
 describe "User" do
 
-  puts "User Benchmark"
-  puts Benchmark.measure { let (:user) { Fabricate(:user) } }
+  context "when instantiated" do
 
-  let (:user) { Fabricate(:user) }
+    let(:user) { User.new }
+    
+    it "should be the proper class" do
+      user.should be_a(User)      
+    end
 
-  it "should be created/fabricated" do
-    user.should be_a(User)
-  end
+    it "should be invalid without a user_name" do    
+      user.should_not be_valid
+      user.errors.messages[:user_name].should eq(["can't be blank"])
+      user.new_record?.should be_true
+    end  
+  
+    it "should be invalid without an email_address" do    
+      user.should_not be_valid
+      user.errors.messages[:email_address].should eq(["can't be blank"])
+      user.new_record?.should be_true
+    end
+    
+    it "should be invalid without a full_name" do    
+      user.should_not be_valid
+      user.errors.messages[:full_name].should eq(["can't be blank"])
+      user.new_record?.should be_true
+    end
+
+    it "should not be saved" do
+      user.new_record?.should be_true
+      user.persisted?.should_not be_true
+    end
 
-  it "should be persisted" do
-    user.save
-    user.persisted?
+  end  
+  
+  context "when created" do
+    let(:user) { Fabricate(:user)}
+    
+    it "should have a valid user_name, full_name, and email_address" do    
+      user.should be_valid
+      user.errors.messages.should be_empty
+      user.user_name.should_not be_nil
+      user.full_name.should_not be_nil
+      user.email_address.should_not be_nil
+    end  
+  
+    it "should be saved" do
+      user.new_record?.should_not be_true
+      user.persisted?.should be_true
+    end
   end
 end