testlib.rb #2

# vim:ts=2:sw=2:et:
#-------------------------------------------------------------------------------
# Copyright (c) 2001-2008, Perforce Software, Inc.  All rights reserved. 
#  
# Redistribution and use in source and binary forms, with or without 
# modification, are permitted provided that the following conditions are met: 
#  
# 1.  Redistributions of source code must retain the above copyright 
#     notice, this list of conditions and the following disclaimer. 
#  
# 2.  Redistributions in binary form must reproduce the above copyright 
#     notice, this list of conditions and the following disclaimer in the 
#     documentation and/or other materials provided with the distribution. 
#  
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS  
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS  
# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PERFORCE  
# SOFTWARE, INC. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,  
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT  
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON  
# ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR  
# TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF  
# THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH  
# DAMAGE. 
#-------------------------------------------------------------------------------

require "fileutils.rb"
require "rbconfig"
require "P4"
require "getoptlong"
require "test/unit"

#if RbConfig
#    MAJOR_VERSION = RbConfig::CONFIG[ 'MAJOR' ].to_i
#    MINOR_VERSION = RbConfig::CONFIG[ 'MINOR' ].to_i
#    if MAJOR_VERSION == 1
#	require 'test/unit'
#	if MINOR_VERSION <= 8
#	    require 'test/unit/ui/console/testrunner'
#	end
#    elsif MAJOR_VERSION == 2
#	require 'minitest/unit'
#	require 'minitest/autorun'
#    end
#end


#
# Define some common methods and attributes that can be included
# by our Test::Unit::TestCase subclasses.
#
module P4RubyTest 

  @@STARTDIR	= Dir.getwd
  @@ROOTDIR	= "testroot"
  @@P4D	= "p4d"		# Assume it's in the PATH


  attr_accessor :p4

  #
  # Common setup for tests
  #
  def setup
    super
    create_workspace_tree
    Dir.chdir( client_root )
    ENV.delete( 'PWD' )
    ENV[ 'P4ENVIRO' ] = '.p4enviro'
    init_client()
  end


  #
  # Common cleanup
  #
  def teardown
    @p4.disconnect if @p4.connected?
    @p4 = nil
    # Go back to where we started, or we can't remove the tree.
    Dir.chdir( @@STARTDIR )
    if ! ENV[ 'P4RUBY_TEST_NOCLEANUP' ]
      FileUtils.rm_rf( server_root )
      FileUtils.rm_rf( client_root )
      begin
        Dir.rmdir( test_root ) if File.directory?( test_root )
        Dir.rmdir( @@ROOTDIR ) if File.directory?( @@ROOTDIR )
      rescue Errno::ENOTEMPTY
      end
    end
    true
  end

  #
  # Set up the client workspace for the test
  #
  def create_workspace_tree
    init_client
    FileUtils.mkdir_p( server_root ) unless File.directory?( server_root )
    FileUtils.mkdir_p( client_root ) unless File.directory?( client_root )
    create_p4config_file()
    create_enviro_file()
    true
  end

  def init_client()
    # Create a P4 object for a test
    @p4 = P4.new
    @p4.charset = nil # Disable auto-detection?
    @p4.port = %Q{rsh:#{@@P4D} -r "#{server_root}" -C1 -L log -vserver=3 -i} 
    @p4.client = name.downcase.gsub( ' ', '-' )
  end

  # Create the Perforce client for a test
  def create_client
    @p4.connect unless @p4.connected?
    spec = @p4.fetch_client
    spec._root = client_root
    @p4.save_client( spec )
  end

  #
  # Return the path to this test's root
  # 
  def test_root
    [ @@STARTDIR, @@ROOTDIR, name ].join( '/' )
  end

  #
  # Return the path of the server root
  #
  def server_root
    [ test_root, "server" ].join( '/' )
  end

  # 
  # Return the client root
  #
  def client_root
    [ test_root, "workspace" ].join( '/' )
  end

  def enable_unicode
    cmd = "#{@@P4D} -r '#{server_root}' -C1 -L log -vserver=3 -xi"
    # Using IO.popen stops the output from polluting the test
    # output.
    IO.popen( cmd ) { |p| p.read }
  end

  #
  # Common method for adding some test files to work with
  #
  def add_sample_content
    Dir.mkdir( "test_files" )
    %w{ foo bar baz }.each do
      |fn|
      fn = "test_files/#{fn}.txt"
      File.open( fn, "w" ) do
        |f|
        f.puts( "This is a test file" )
      end
      p4.run_add( fn )
    end
    change = p4.fetch_change
    change._description = 'Test files'
    p4.run_submit( change )
    true
  end


  private

  def create_p4config_file
    return unless ( ENV.has_key?( 'P4CONFIG' ) )
    File.open( client_root + '/' + ENV[ 'P4CONFIG' ], "w" ) do
      |f|
      f.puts( "P4PORT=#{@p4.port}" )
    end
  end

  def create_enviro_file
    return unless ( ENV.has_key?( 'P4ENVIRO' ) )
    File.open( client_root + '/' + ENV[ 'P4ENVIRO' ], "w+" ) do
      |f|
    end
  end
end