dtf 0.2.9 → 0.3.0

data/.gitignore

@@ -27,6 +27,7 @@ lib/bundler/man
 .bundle
 ~*
 coverage
+coverage.data
 .*proj
 *.iml
 .idea/
@@ -41,4 +42,4 @@ target/
 test/version_tmp
 *.diff
 .ipr
-test/tmp
+test/tmp

data/Gemfile

@@ -24,4 +24,8 @@ group :development, :test do
   gem 'database_cleaner'
 end
 
+group :test do
+  gem 'cover_me'
+end
+
 gemspec

data/Rakefile

@@ -4,8 +4,25 @@
 require "bundler/gem_tasks"
 
 begin
-    require 'tasks/standalone_migrations'
+  require 'tasks/standalone_migrations'
 rescue LoadError => e
-    puts "gem install standalone_migrations to get db:migrate:* tasks! (Error: #{e})"
+  puts "gem install standalone_migrations to get db:migrate:* tasks! (Error: #{e})"
 end
 
+namespace :cover_me do
+
+  desc "Generates and opens code coverage report."
+  task :report do
+    require 'cover_me'
+    CoverMe.complete!
+  end
+
+end
+
+task :test do
+  Rake::Task['cover_me:report'].invoke
+end
+
+task :spec do
+  Rake::Task['cover_me:report'].invoke
+end

data/TODO

@@ -23,3 +23,14 @@ dtf-session becomes a dependency of dtf-shell which will be written to support
 specific Shells
 
 dtf-rvm will have a dependency on both dtf-session, and rvm gems
+
+wrap the trollop use of ARGV in a method that takes an argument, 
+call the argument 'argv' and then pass in ARGV in your bin-script
+and then in a test, pass in a different array. In the trollop code,
+adjust any reference to ARGV to point to argv.
+
+the trollop parse method (from my quick google) is defined with 
+'def parse cmdline=ARGV', you could follow a similar idea
+(same with options -  def options args=ARGV, *a, &b)
+Also, check out 'ri CLI'
+Rework dtf module to apply Command design pattern to Dtf::Command and clean up case statements.

data/bin/dtf

@@ -6,5 +6,8 @@
 
 require 'dtf'
 
-@cmd, @cmd_opts = Dtf::OptionsParser.parse_cmds # Parse the command-line, and return the cmd & its specific cmd_opts
-Dtf::Command.process(@cmd, @cmd_opts) # Now process that cmd & its cmd_opts
+@parser = Dtf::OptionsParser.new
+@cmd, @cmd_opts = @parser.parse_cmds # Parse the command-line, and return the cmd & its specific cmd_opts
+
+@new_cmd = Dtf::Command.create_cmd(@cmd) # Create a command named after contents of @cmd var
+@new_cmd.execute(@cmd_opts) # Pass @cmd_opts to that command's execute method

data/lib/dtf.rb

@@ -1,18 +1,167 @@
 # encoding: UTF-8
 
-require "dtf/version"
+require 'dtf/version'
 require 'trollop'
 
 module Dtf
   load "#{File.join(File.dirname(__FILE__), "/config/environment.rb")}"
+  
+  module Command
+    def self.create_cmd(cmd)
+      puts "#{@cmd}"
+      begin
+        new_cmd = Dtf::Command.const_get(cmd.camelize).new    
+      rescue NameError  
+        puts "DTF has no registered command by that name."
+        puts "Please see 'dtf -h' for the list of recognized commands."
+      else
+        return new_cmd
+      end
+    end
+
+    # This sub-command is used to add a User to the Test Framework system
+    #
+    # Required Parameters are:
+    #  --user-name [String], --full-name [String], --email-address [String]
+    #
+    # '--user-name' is used to specify the user_name of the created User, and *must* be unique in the system.
+    # '--full-name' is the Real Name of the created User.
+    # '--email-address' is the email address of the created User, and *must* be unique in the system.
+    class CreateUser
+      def execute(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]).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.full_messages.each do |msg|
+              $stderr.puts "#{msg}"
+            end
+            # Now throw a proper error code to the system, while exiting the script
+            abort()
+          end
+        else
+          Dtf::ErrorSystem.raise_error(@cmd) # This error here is thrown when not all params are provided
+        end
+      end
+    end
+
+    # This sub-command generates, adds, and associates a Verification Suite in the Testing Framework system.
+    #
+    # Required Parameters are:
+    #  --user-name [String], --name [String]
+    #
+    # '--user-name' is the user_name of the User that should own this Verification Suite.
+    # '--name' is the descriptive name of the Verification Suite.
+    #
+    # Options are:
+    #  --description [String]
+    #
+    # This *optional* parameter is for providing a description of the Verification Suite's use.
+    # e.g. --description "RSpec Verification"
+    class CreateVs
+      def execute(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
+          Dtf::ErrorSystem.raise_error(@cmd)
+        end
+      end
+    end
 
+    # This sub-command removes a User from the Testing Framework system
+    #
+    # Required Parameters are:
+    #  --user-name [String]
+    #
+    # '--user-name' is the assigned user_name of the User you wish to delete.
+    #
+    # Optional Flags are:
+    #  --delete-all|--no-delete-all
+    #
+    # By default this command will delete *all* Verification Suites owned by the deleted user.
+    # The default behaviour is as if the sub-command had been invoked passing the '--delete-all' flag explicitly.
+    #
+    # To delete the user, but *keep* their VS, pass the '--no-delete-all' flag.
+    # This flag will find all Verification Suites owned by the user being deleted, and reassign them
+    # to 'Library Owner' (user_name: library_owner) which is the generic in-house User shipped with DTF.
+    class DeleteUser
+      def execute(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 "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 "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])
+            if ! user.nil? then
+              user.verification_suites.all.each do |vs|
+                VerificationSuite.delete(vs)
+              end
+              if user.verification_suites.empty? then
+                User.delete(user)
+              end
+            else
+              $stderr.puts "ERROR: No user named \'#{cmd_opts[:user_name].to_s}\' found!"
+              abort()
+            end
+          end
+        else
+          Dtf::ErrorSystem.raise_error(@cmd)
+        end
+      end
+    end
+
+    # This sub-command removes a Verification Suite from the Testing Framework system
+    #
+    # Required Parameters are:
+    #  --user-name [String], --id [Integer]
+    #
+    # The '--user-name' parameter is the user_name of the User that owns the Verification Suite you wish to delete
+    # The '--id' parameter is the ID # of the Verification Suite you wish to delete, as provided by @vs.id
+    class DeleteVs
+      def execute(cmd_opts)
+        if [:user_name_given, :id_given].all? { |sym| cmd_opts.key?(sym) } then
+          puts "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
+          Dtf::ErrorSystem.raise_error(@cmd)
+        end
+      end
+    end
+
+  end # End of Dtf::Command module
+  
   # Dtf::ErrorSystem is DTF's custom error management class
   class ErrorSystem
     # Reusable error raising and response method.
     # Returns exit status code of '1' via abort().
     def self.raise_error(cmd)
-      raise ArgumentError
-    rescue
       $stderr.puts "ERROR! #{cmd} did not receive all required options."
       $stderr.puts "Please execute \'dtf #{cmd} -h\' for more information."
       abort()
@@ -30,8 +179,7 @@ module Dtf
       obj.errors.full_messages.all.each do |msg|
         $stderr.puts "#{msg}"
       end
-    end
-    
+    end    
   end
 
   # Dtf::OptionsParser is DTF's command/options/parameters parsing class.
@@ -46,7 +194,7 @@ module Dtf
     # and provides the help system for options/parameters.
     #
     # Returned Values: @cmd [Type: String] and @cmd_opts [Type: Hash]
-    def self.parse_cmds
+    def parse_cmds(arg=ARGV)
       # Global options default to '--version|-v' and '--help|-h'
       global_opts = Trollop::options do
         version "DTF v#{Dtf::VERSION}"
@@ -66,7 +214,7 @@ module Dtf
         stop_on SUB_COMMANDS
       end
 
-      @cmd = ARGV.shift
+      @cmd = arg.shift
       @cmd_opts = case @cmd
       when "create_user"
         Trollop::options do
@@ -99,168 +247,5 @@ module Dtf
       return @cmd, @cmd_opts # Explicitly return @cmd and its @cmd_opts 
     end
   end
-
-
-  # Dtf::Command contains all sub-commands availabe in the DTF master gem.
-  # All methods receive the @cmd and @cmd_opts returned by Dtf::OptionsParser.parse_cmds()
-  class Command
-
-    # Process both the requested command and all/any parameters.
-    # NOTE: This method is the 'master' method. It parses @cmd for which sub-command to execute and then hands
-    # off to the appropriate method. All methods are a 1:1 match in their name.
-    # e.g 'create_user' sub-command is matched to the 'create_user' method of this class.
-    #
-    # This method requires, and processes, 2 arguments. The first is a String, the second is a Hash.
-    # They are the 'cmd' to process and any options/parameters, stored in the 'cmd_opts' hash, of that sub-command.
-    def self.process(cmd, cmd_opts)
-      case cmd
-        when "create_user"
-          self.create_user(cmd, cmd_opts)
-
-        when "delete_user"
-          self.delete_user(cmd, cmd_opts)
-
-        when "create_vs"
-          self.create_vs(cmd, cmd_opts)
-
-        when "delete_vs"
-          self.delete_vs(cmd, cmd_opts)
-
-        else
-          $stderr.puts "Unknown DTF sub-command: #{cmd}"
-          abort()
-      end
-    end
-
-    # This sub-command is used to add a User to the Test Framework system
-    #
-    # Required Parameters are:
-    #  --user-name [String], --full-name [String], --email-address [String]
-    #
-    # '--user-name' is used to specify the user_name of the created User, and *must* be unique in the system.
-    # '--full-name' is the Real Name of the created User.
-    # '--email-address' is the email address of the created User, and *must* be unique in the system.
-    def self.create_user(cmd, 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]).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.full_messages.each do |msg|
-            $stderr.puts "#{msg}"
-          end
-          # Now throw a proper error code to the system, while exiting the script
-          abort()
-        end
-      else
-        Dtf::ErrorSystem.raise_error(cmd) # This error here is thrown when not all params are provided
-      end
-    end
-
-    # This sub-command removes a User from the Testing Framework system
-    #
-    # Required Parameters are:
-    #  --user-name [String]
-    #
-    # '--user-name' is the assigned user_name of the User you wish to delete.
-    #
-    # Optional Flags are:
-    #  --delete-all|--no-delete-all
-    #
-    # By default this command will delete *all* Verification Suites owned by the deleted user.
-    # The default behaviour is as if the sub-command had been invoked passing the '--delete-all' flag explicitly.
-    #
-    # To delete the user, but *keep* their VS, pass the '--no-delete-all' flag.
-    # This flag will find all Verification Suites owned by the user being deleted, and reassign them
-    # to 'Library Owner' (user_name: library_owner) which is the generic in-house User shipped with DTF.
-    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])
-          if ! user.nil? then
-            user.verification_suites.all.each do |vs|
-              VerificationSuite.delete(vs)
-            end
-            if user.verification_suites.empty? then
-              User.delete(user)
-            end
-          else
-            $stderr.puts "ERROR: No user named \'#{cmd_opts[:user_name].to_s}\' found!"
-            abort()
-          end
-        end
-      else
-        Dtf::ErrorSystem.raise_error(cmd)
-      end
-    end
-
-    # This sub-command generates, adds, and associates a Verification Suite in the Testing Framework system.
-    #
-    # Required Parameters are:
-    #  --user-name [String], --name [String]
-    #
-    # '--user-name' is the user_name of the User that should own this Verification Suite.
-    # '--name' is the descriptive name of the Verification Suite.
-    #
-    # Options are:
-    #  --description [String]
-    #
-    # This *optional* parameter is for providing a description of the Verification Suite's use.
-    # e.g. --description "RSpec Verification"
-    #
-    def self.create_vs(cmd, 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
-        Dtf::ErrorSystem.raise_error(cmd)
-      end
-    end
-
-    # This sub-command removes a Verification Suite from the Testing Framework system
-    #
-    # Required Parameters are:
-    #  --user-name [String], --id [Integer]
-    #
-    # The '--user-name' parameter is the user_name of the User that owns the Verification Suite you wish to delete
-    # The '--id' parameter is the ID # of the Verification Suite you wish to delete, as provided by @vs.id
-    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
-        Dtf::ErrorSystem.raise_error(cmd)
-      end
-    end
-
-  end
-
-end # End of module
+  
+end # End of Dtf module

data/lib/dtf/version.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
 
 module Dtf
-  VERSION = "0.2.9"
+  VERSION = "0.3.0"
 end

data/spec/acceptance/verify_sub_commands.feature

@@ -0,0 +1,26 @@
+Feature: Verify sub commands
+  In order to ensure each sub-command works
+  As a User
+  I want to execute each command successfully
+
+  Background:
+	Given I have dtf installed
+	
+  Scenario: Execution of create_user succeeds
+    Given I execute 'create_user'
+    Then I should find 'testuser' in the database
+
+  Scenario: Execution of delete_user succeeds
+    send "I execute 'create_user'"
+	Given I execute 'delete_user'
+	Then I should not find 'testuser' in the database
+
+  Scenario: Execution of create_vs succeeds
+    send "I create 'create_user'"
+    Given I execute 'create_vs'
+    Then I should find a VS in the database
+  
+  Scenario: Execution of delete_vs succeeds
+    send "I execute 'create_user'"
+    Given I execute 'delete_vs'
+    Then I should not find a VS in the database  

data/spec/spec_helper.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
-
+require 'cover_me'
 require 'dtf'
 require 'rspec'
 require 'turnip'

data/spec/steps/feature_steps.rb

@@ -17,4 +17,76 @@ step "I should see :help_response in the response" do |help_response|
     result = %x[bundle exec dtf #{cmd[0]} -h]
     result.should include("#{cmd[1]}")
   end
-end
+end
+
+step "I execute 'create_user'" do
+  @cmd = "create_user"
+  @cmd_opts = {user_name: "testuser", 
+              full_name: "My Test User",
+              email_address: "me@example.com",
+              user_name_given: true,
+              full_name_given: true,
+              email_address_given: true,
+              delete_all: true
+              }
+
+  @new_cmd = Dtf::Command.create_cmd(@cmd)
+  @new_cmd.execute(@cmd_opts)
+end
+
+step "I should find 'testuser' in the database" do
+  user = User.find_by_user_name('testuser')
+  user.should_not be_nil
+end
+
+step "I execute 'delete_user'" do
+  send "I execute 'create_user'"
+end
+
+step "I should not find 'testuser' in the database" do
+  @cmd = "delete_user"
+  @cmd_opts = { user_name: "testuser",
+                delete_all_given: true,
+                user_name_given: true,
+                delete_all: false
+                }
+  @new_cmd = Dtf::Command.create_cmd(@cmd)
+  @new_cmd.execute(@cmd_opts)
+end
+
+step "I execute 'create_vs'" do
+  send "I execute 'create_user'"
+  @cmd = "create_vs"
+  @cmd_opts = {user_name: "testuser",
+              name: "My Test VS",
+              description: "Bogus VS for testing",
+              user_name_given: true,
+              name_given: true,
+              description_given: true
+              }
+
+  @new_cmd = Dtf::Command.create_cmd(@cmd)
+  @new_cmd.execute(@cmd_opts)
+end
+
+step "I should find a VS in the database" do
+  user = User.find_by_user_name('testuser')
+  user.verification_suites.should_not be_empty
+end
+
+step "I execute 'delete_vs'" do
+  send "I execute 'create_vs'"
+  @cmd = "delete_vs"
+  @cmd_opts = {user_name: "testuser",
+              id: 1,
+              user_name_given: true,
+              id_given: true
+              }
+  @new_cmd = Dtf::Command.create_cmd(@cmd)
+  @new_cmd.execute(@cmd_opts)
+end
+
+step "I should not find a VS in the database" do
+  user = User.find_by_user_name('testuser')
+  user.verification_suites.should be_empty
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dtf
 version: !ruby/object:Gem::Version
-  version: 0.2.9
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-20 00:00:00.000000000 Z
+date: 2012-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -327,6 +327,7 @@ files:
 - lib/tasks/setup.thor
 - spec/acceptance/create_basic_associations.feature
 - spec/acceptance/implement_help_system.feature
+- spec/acceptance/verify_sub_commands.feature
 - spec/fabricators/analysis_case_fabricator.rb
 - spec/fabricators/case_test_fabricator.rb
 - spec/fabricators/user_fabricator.rb
@@ -367,6 +368,7 @@ summary: DTF is a modular testing framework. This is the master gem for the DTF
 test_files:
 - spec/acceptance/create_basic_associations.feature
 - spec/acceptance/implement_help_system.feature
+- spec/acceptance/verify_sub_commands.feature
 - spec/fabricators/analysis_case_fabricator.rb
 - spec/fabricators/case_test_fabricator.rb
 - spec/fabricators/user_fabricator.rb