rutema_elements 0.1.2 → 0.1.3

data/History.txt

@@ -1,3 +1,6 @@
+=== 0.1.3 / 2008-12-04
+	* vsdbcmd added to SQLServer module (uses the new VS Database GDR tool)
+	* refactored code that handles sqlcmd and mstest
 === 0.1.2 / 2008-11-04
 	* shared_path handling in mstest fixed
 === 0.1.1 / 2008-11-03

data/lib/rutema/elements/general.rb

@@ -9,7 +9,7 @@ module Rutema
     module Version
       MAJOR=0
       MINOR=1
-      TINY=2
+      TINY=3
       STRING=[ MAJOR, MINOR, TINY ].join( "." )
     end
     module Web

data/lib/rutema/elements/win32.rb

@@ -38,19 +38,8 @@ module Rutema
         raise Rutema::ParserError,"Missing required script attribute in sqlcmd step" unless step.has_script?
         cfg=@configuration.tools.sqlcmd[:configuration].dup if @configuration.tools.sqlcmd && @configuration.tools.sqlcmd[:configuration]
         cfg||=Hash.new
-        if step.has_script_root?
-          cfg[:script_root]=step.script_root
-        end
-        #see if there is a script root directory
-        if cfg[:script_root]
-          raise Rutema::ParserError,"Script root directory '#{cfg[:script_root]}' does not exist. Error in the configuration for sqlcmd steps" unless File.exists?(cfg[:script_root])
-          script_path=File.expand_path(File.join(cfg[:script_root],step.script))
-        else
-           script_path=File.expand_path(step.script)
-        end
-        #we want a specific DB script to run
-        step.script=script_path
-        raise Rutema::ParserError,"Cannot find script file '#{step.script}' for sqlcmd step" unless File.exists?(step.script)
+        root_path=script_root_path(cfg,step)
+        cfg[:script]=adjust_with_root_path(step.script,root_path,step)
         #check for overrides
         cfg[:host] = step.host if step.has_host?
         cfg[:server] = step.host if step.has_server?
@@ -59,13 +48,81 @@ module Rutema
         #add the optional attributes
         cfg[:database] = step.database if step.has_database?
         cfg[:level] = step.level if step.has_level?
-        #add the script
-        cfg[:script]=step.script
         #get the command object
         step.cmd=sqlcmd_command(cfg)
         return step
       end
+      
+      #Calls vsdbcmd to deploy a database schema
+      #
+      #Requires the dbschema attribute pointing to the dbschema file to deploy. 
+      #
+      #Paths can be relative to the specification file
+      #===Configuration
+      #Requires a configuration.tool entry with :name=>"vsdbcmd" 
+      #and a :configuration entry pointing to a hash containing the configuration parameters.
+      #Configuration parameters are:
+      # :path - the path to the vsdbcmd.exe
+      # :cs - the connection string to use
+      # :manifest - path to the depploymanifest file to use. If not present then a manifest attribute is expected. 
+      # :overrides - Optional. Should be a string containing parameters that override vsdbcmd parameters in the format expected by vsdbcmd
+      # :script_root - The path relative to which pathnames for scripts are calculated. If it's missing, paths are relative to the specification file. Optional
+      #all configuration options apart from :path can be overriden in the element
+      #===Example Configuration Entry
+      # configuration.tool={:name=>"vsdbcmd",:configuration=>{:path=>"c:/tools/db/vsdbcmd.exe",:cs=>"Data Source=(local);;Initial Catalog=YourDB;Integrated Security=True":overrides=>"/p:AlwaysCreateNewDatabase=True"}}
+      #===Extras
+      #When overriding the :manifest configuration the path to the file can be relative to the specification file or the :script_root path if defined
+      #
+      #A .deploymanifest is required because of the number of possible parameters that can be defined in it and it's dependent files. Making every parameter available in the configuration will result in nothing but a mess. In every case a database project in Visual Studio will create a manifest file.
+      #
+      #Use the :overrides key to override parameter values and provide extra command line parameters. The :overrides value must be in valid vsdbcmd format (see examples)
+      #
+      #Defining paths in :overrides and handling paths defined in the .deploymanifest can be tricky: All paths will be relative to the specification file.
+      #===Example Elements
+      # <vsdbcmd dbschema="../yourdb.dbschema"/>
+      # <vsdbcmd dbschema="../yourdb.dbschema" overrides="/p:AlwaysCreateNewDatabase=False /p:BlockIncrementalDeploymentIfDataLoss=True"/>
+      # <vsdbcmd dbschema="../yourdb.dbschema" overrides="/p:AlwaysCreateNewDatabase=False /DeploymentScriptFile:\"somefile.sql\""/>
+      def element_vsdbcmd step
+        raise Rutema::ParserError,"Missing tool configuration for vsdbcmd (no configuration.tool entry)" unless @configuration.tools.vsdbcmd && @configuration.tools.vsdbcmd[:configuration]
+        raise Rutema::ParserError,"Missing required dbschema attribute in vsdbcmd step" unless step.has_dbschema?
+        cfg=@configuration.tools.vsdbcmd[:configuration].dup
+        path_to_util=File.expand_path(cfg[:path])
+        raise Rutema::ParserError,"Cannot find vsdbcmd in '#{path_to_util}'" unless File.exists?(path_to_util)
+        cfg[:dsp]||="sql"
+        root_path=script_root_path(cfg,step)
+        cfg[:dbschema]=adjust_with_root_path(step.dbschema,root_path,step)
+        manifest=cfg[:manifest]
+        manifest=step.manifest if step.has_manifest?
+        raise Rutema::ParserError,"No manifest file defined for #{step.step_type}" unless manifest
+        cfg[:manifest]=adjust_with_root_path(manifest,root_path,step)
+        if step.has_overrides?
+          cfg[:overrides]=step.overrides
+        end
+        step.cmd=vsdbcmd_command(cfg)
+        return step
+      end
       private
+      def script_root_path cfg,step
+        root_path=cfg[:script_root]
+        if step.has_script_root?
+          root_path=step.script_root
+        else
+          root_path||=Dir.pwd
+        end
+        return root_path
+      end
+      #checks the path to use as script root
+      def adjust_with_root_path filename,root_path,step
+        if File.exists?(filename)
+          return File.expand_path(filename)
+        else
+          #see if there is a script root directory
+          raise Rutema::ParserError,"Root directory '#{root_path}' for #{step.step_type} does not exist. Check the configuration or the override in the affected scenario" unless File.exists?(root_path)
+          script_path=File.expand_path(File.join(root_path,filename))
+          raise Rutema::ParserError,"Cannot find file '#{script_path}' specified in #{step.step_type}" unless File.exists?(script_path)
+          return script_path
+        end
+      end
       #Returns the Patir::ShellCommand with the correct commandline
       def sqlcmd_command cfg
         cmdline="sqlcmd -i \"#{File.expand_path(cfg[:script]).gsub("/","\\\\")}\" -b "
@@ -78,6 +135,16 @@ module Rutema
         #make sure the script executes at the directory where it is.
         return Patir::ShellCommand.new(:cmd=>cmdline,:working_directory=>File.dirname(File.expand_path(cfg[:script])))
       end
+      #Returns the Patir::ShellCommand with the correct commandline
+      def vsdbcmd_command cfg
+        path_to_util=File.expand_path(cfg[:path])
+        dbschema=File.expand_path(cfg[:dbschema]).gsub("/","\\\\")
+        manifest=File.expand_path(cfg[:manifest]).gsub("/","\\\\")
+        cmdline="#{path_to_util} /a:Deploy /dsp:#{cfg[:dsp]}  /dd /model:\"#{dbschema}\" /manifest:\"#{manifest}\" #{cfg[:overrides]}"
+        @logger.debug("Parsed vsdbcmd call as '#{cmdline}'")
+        #make sure the script executes at the specification directory.
+        return Patir::ShellCommand.new(:cmd=>cmdline)
+      end
     end
     #Elements to drive MSTest
     module MSTest
@@ -111,22 +178,18 @@ module Rutema
         raise Rutema::ParserError,"Missing required attribute 'assembly'" unless step.has_assembly?
         raise Rutema::ParserError,"Missing tool configuration for mstest (no configuration.tool entry)" unless @configuration.tools.mstest && @configuration.tools.mstest[:configuration]
         cfg=@configuration.tools.mstest[:configuration].dup
-        raise Rutema::ParserError,"Cannot find mstest in '#{@configuration.tools.mstest[:path]}'" unless File.exists?(cfg[:path])
+        path_to_util=cfg[:path]
+        raise Rutema::ParserError,"Cannot find mstest in '#{path_to_util}'" unless File.exists?(path_to_util)
         if step.has_assembly_root?
           cfg[:assembly_root]=step.assembly_root
-        end
-        #if there is an assembly root defined than calculate the paths relative to that
-        if cfg[:assembly_root]
-          raise Rutema::ParserError, "assembly_root entry '#{cfg[:assembly_root]}' defined for mstest does not exist. Error in the configuration for mstest steps" unless File.exists?(cfg[:assembly_root])
-          assembly_path=File.expand_path(File.join(cfg[:assembly_root],step.assembly))
         else
-          assembly_path=File.expand_path(step.assembly)
+          cfg[:assembly_root]=Dir.pwd
         end
-        #check that the assembly exists first
-        raise Rutema::ParserError,"Cannot find assembly file '#{assembly_path}' in mstest step" unless File.exists?(assembly_path)
+        #icalculate the paths relative to the assembly_root
+        assembly_path=adjust_with_root_path(step.assembly,cfg[:assembly_root],step)
         #check to see if we apply the workaround
-        if cfg[:shared_path]
-          shared_path=cfg[:shared_path]
+        shared_path=cfg[:shared_path]
+        if shared_path
           raise Rutema::ParserError,"Missing :share key for shared_path configuration" unless shared_path[:share]
           raise Rutema::ParserError,"Missing :local key for shared_path configuration" unless shared_path[:local]
           @logger.debug("Assembly path is '#{assembly_path}'")
@@ -137,11 +200,24 @@ module Rutema
         #make the path windows compatible
         assembly_path.gsub!('/',"\\\\")
         #create the command line and the command instance
-        cmdline="\"#{cfg[:path]}\" /testcontainer:\"#{assembly_path}\""
+        cmdline="\"#{path_to_util}\" /testcontainer:\"#{assembly_path}\""
         @logger.debug("Parsed mstest call as '#{cmdline}'")
         step.cmd=Patir::ShellCommand.new(:cmd=>cmdline,:working_directory=>File.dirname(assembly_path))
         return step
       end
+      private
+      #checks the path to use as script root
+      def adjust_with_root_path filename,root_path,step
+        if File.exists?(filename)
+          return File.expand_path(filename)
+        else
+          #see if there is a script root directory
+          raise Rutema::ParserError,"Root directory '#{root_path}' for #{step.step_type} does not exist. Check the configuration or the override in the affected scenario" unless File.exists?(root_path)
+          script_path=File.expand_path(File.join(root_path,filename))
+          raise Rutema::ParserError,"Cannot find file '#{script_path}' specified in #{step.step_type}" unless File.exists?(script_path)
+          return script_path
+        end
+      end
     end
     #Elements to drive IIS
     module IIS

data/test/test_sqlcmd.rb

@@ -26,8 +26,8 @@ class TestSqlcmd <Test::Unit::TestCase
   def mock_simple_step
     step=mock()
     step.expects(:has_script?).returns(true)
-    step.expects(:script).returns(File.join(File.dirname(__FILE__),"data","sample.sql")).times(3)
-    step.expects(:script=)
+    step.expects(:has_script_root?).returns(false)
+    step.expects(:script).returns(File.join(File.dirname(__FILE__),"data","sample.sql"))
     step.expects(:has_database?).returns(false)
     step.expects(:has_host?).returns(false)
     step.expects(:has_server?).returns(false)

data/test/test_vsdbcmd.rb

@@ -0,0 +1,46 @@
+$:.unshift File.join(File.dirname(__FILE__),"..","lib")
+require 'test/unit'
+require 'rutema/elements/win32'
+require 'rubygems'
+require 'mocha'
+
+class TestSqlcmd <Test::Unit::TestCase
+  include Rutema::Elements::SQLServer
+  def test_missing_configuration
+    cmd_conf=mock()
+    cmd_conf.expects(:vsdbcmd).returns(nil)
+    @configuration=mock()
+    @configuration.expects(:tools).returns(cmd_conf)
+    step=mock()
+    assert_raise(Rutema::ParserError) { element_vsdbcmd(step)  }
+  end
+  def test_empty_configuration
+    cmd_conf=mock()
+    cmd_conf.expects(:vsdbcmd).returns({}).times(2)
+    @configuration=mock()
+    @configuration.expects(:tools).returns(cmd_conf).times(2)
+    step=mock()
+    assert_raise(Rutema::ParserError) { element_vsdbcmd(step)  }
+  end
+  def test_normal_flow
+    cmd_conf=mock()
+    cmd_conf.expects(:vsdbcmd).returns(:configuration=>{:path=>"data/sample.dbschema"}).times(3)
+    @configuration=mock()
+    @configuration.expects(:tools).returns(cmd_conf).times(3)
+    step=mock_simple_step
+    assert_nothing_raised() { element_vsdbcmd(step)  }
+  end
+  private
+  def mock_simple_step
+    step=mock()
+    step.expects(:has_script?).returns(true)
+    step.expects(:has_script_root?).returns(false)
+    step.expects(:has_dbschema?).returns(true)
+    step.expects(:dbschema).returns(File.join(File.dirname(__FILE__),"data","sample.dbschema"))
+    step.expects(:has_manifest?).returns(true)
+    step.expects(:manifest).returns(File.join("data","sample.dbschema"))
+    step.expects(:has_overrides?).returns(false)
+    step.expects(:cmd=)
+    return step
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rutema_elements
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
 - Vassilis Rizopoulos
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-04 00:00:00 +01:00
+date: 2008-12-03 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -95,3 +95,4 @@ test_files:
 - test/test_selenium.rb
 - test/test_sqlcmd.rb
 - test/test_standard.rb
+- test/test_vsdbcmd.rb