class RSCM::Cvs

RSCM implementation for CVS.

You need a cvs executable on the PATH in order for it to work.

NOTE: On Cygwin this has to be the win32 build of cvs and not the Cygwin one.

Attributes

branch[RW]
mod[RW]
password[RW]
root[RW]

Public Class Methods

new(root=nil, mod=nil, branch=nil, password=nil) click to toggle source
# File lib/rscm/scm/cvs.rb, line 29
def initialize(root=nil, mod=nil, branch=nil, password=nil)
  @root, @mod, @branch, @password = root, mod, branch, password
end

Public Instance Methods

add(relative_filename, options={}) click to toggle source
# File lib/rscm/scm/cvs.rb, line 40
def add(relative_filename, options={})
  cvs("add #{relative_filename}", options)
end
apply_label(label) click to toggle source
# File lib/rscm/scm/cvs.rb, line 98
def apply_label(label)
  cvs("tag -c #{label}")
end
can_create_central?() click to toggle source
# File lib/rscm/scm/cvs.rb, line 191
def can_create_central?
  begin
    local?
  rescue
    false
  end
end
central_exists?() click to toggle source
# File lib/rscm/scm/cvs.rb, line 182
def central_exists?
  if(local?)
    File.exists?("#{path}/CVSROOT/loginfo")
  else
    # don't know. assume yes.

    true
  end
end
checked_out?() click to toggle source
# File lib/rscm/scm/cvs.rb, line 203
def checked_out?
  rootcvs = File.expand_path("#{checkout_dir}/CVS/Root")
  File.exists?(rootcvs)
end
commit(message, options={}) click to toggle source
# File lib/rscm/scm/cvs.rb, line 51
def commit(message, options={})
  cvs(commit_command(message), options)
end
create_central(options={}) click to toggle source
# File lib/rscm/scm/cvs.rb, line 167
def create_central(options={})
  options = options.dup.merge({:dir => path})
  raise "Can't create central CVS repository for #{root}" unless can_create_central?
  File.mkpath(path)
  cvs("init", options)
end
destroy_central() click to toggle source
# File lib/rscm/scm/cvs.rb, line 174
def destroy_central
  if(File.exist?(path) && local?)
    FileUtils.rm_rf(path)
  else
    raise "Cannot destroy central repository. '#{path}' doesn't exist or central repo isn't local to this machine"
  end
end
diff(path, from, to, options={}, &block) click to toggle source
# File lib/rscm/scm/cvs.rb, line 80
def diff(path, from, to, options={}, &block)
  # IMPORTANT! CVS NT has a bug in the -N diff option

  # http://www.cvsnt.org/pipermail/cvsnt-bugs/2004-November/000786.html

  from ||= Time.epoch
  cmd = command_line("diff -Nu #{revision_option(from)} #{revision_option(to)} #{path}")
  execute(cmd, options.dup.merge({:exitstatus => 1})) do |io|
    block.call io
  end
end
import_central(dir, options={}) click to toggle source
# File lib/rscm/scm/cvs.rb, line 33
def import_central(dir, options={})
  modname = File.basename(dir)
  FileUtils.mkdir_p(@checkout_dir) unless File.exist?(@checkout_dir)
  options = options.dup.merge :dir => dir
  cvs("import -m \"#{options[:message]}\" #{modname} VENDOR START", options)
end
install_trigger(trigger_command, trigger_files_checkout_dir, options={}) click to toggle source
# File lib/rscm/scm/cvs.rb, line 131
def install_trigger(trigger_command, trigger_files_checkout_dir, options={})
  raise "mod can't be null or empty" if (mod.nil? || mod == "")
  trigger_command = fix_trigger_command(trigger_command)

  root_cvs = create_root_cvs(trigger_files_checkout_dir)
  root_cvs.checkout(nil, options)
  Dir.chdir(trigger_files_checkout_dir) do
    trigger_line = "#{mod} #{trigger_command}\n"
    File.open("loginfo", File::WRONLY | File::APPEND) do |file|
      file.puts(trigger_line)
    end
  end

  begin
    root_cvs.commit("Installed trigger for CVS module '#{mod}'", options)
  rescue Errno::EACCES
    raise ["Didn't have permission to commit CVSROOT/loginfo.",
          "Try to manually add the following line:",
          trigger_command,
          "Finally make commit the file to the repository"].join("\n")
  end
end
installed?() click to toggle source
# File lib/rscm/scm/cvs.rb, line 20
def installed?
  begin
    cvs("--version", {}) 
    true
  rescue
    false
  end
end
move(relative_src, relative_dest, options={}) click to toggle source
# File lib/rscm/scm/cvs.rb, line 44
def move(relative_src, relative_dest, options={})
  FileUtils.mv(@checkout_dir + '/' + relative_src, @checkout_dir + '/' + relative_dest, :force=>true)
  cvs("rm #{relative_src}", options)
  # This will fail if the directories are new. More advanced support for adding can be added if needed.

  cvs("add #{relative_dest}", options)
end
open(path, native_revision_identifier, options={}, &block) click to toggle source
# File lib/rscm/scm/cvs.rb, line 90
def open(path, native_revision_identifier, options={}, &block)
  raise "native_revision_identifier cannot be nil" if native_revision_identifier.nil?
  cmd = "cvs -Q update -p -r #{native_revision_identifier} #{path}"
  execute(cmd, options) do |io|
    block.call io
  end
end
revisions(from_identifier=Time.new.utc, options={}) click to toggle source
# File lib/rscm/scm/cvs.rb, line 69
def revisions(from_identifier=Time.new.utc, options={})
  raise "from_identifer cannot be nil" if from_identifier.nil?
  options = {
    :from_identifier => from_identifier,
    :to_identifier => Time.infinity, 
    :relative_path => nil
  }.merge(options)
  checkout(options[:to_identifier], options) unless checked_out? # must checkout to get revisions

  parse_log(changes_command(options), options)
end
supports_trigger?() click to toggle source
# File lib/rscm/scm/cvs.rb, line 199
def supports_trigger?
  true
end
trigger_installed?(trigger_command, trigger_files_checkout_dir, options={}) click to toggle source
# File lib/rscm/scm/cvs.rb, line 106
def trigger_installed?(trigger_command, trigger_files_checkout_dir, options={})
  trigger_command = fix_trigger_command(trigger_command)
  loginfo_line = "#{mod} #{trigger_command}"
  regex = Regexp.new(Regexp.escape(loginfo_line))

  root_cvs = create_root_cvs(trigger_files_checkout_dir)
  begin
    root_cvs.checkout(nil, options)
    loginfo = File.join(trigger_files_checkout_dir, "loginfo")
    return false if !File.exist?(loginfo)

    # returns true if commented out. doesn't modify the file.

    in_local_copy = LineEditor.comment_out(File.new(loginfo), regex, "# ", "")
    # Also verify that loginfo has been committed back to the repo

    entries = File.join(trigger_files_checkout_dir, "CVS", "Entries")
    committed = File.mtime(entries) >= File.mtime(loginfo)

    in_local_copy && committed
  rescue Exception => e
    $stderr.puts(e.message)
    $stderr.puts(e.backtrace.join("\n"))
    false
  end
end
trigger_mechanism() click to toggle source
# File lib/rscm/scm/cvs.rb, line 102
def trigger_mechanism
  "CVSROOT/loginfo"
end
uninstall_trigger(trigger_command, trigger_files_checkout_dir, options={}) click to toggle source
# File lib/rscm/scm/cvs.rb, line 154
def uninstall_trigger(trigger_command, trigger_files_checkout_dir, options={})
  trigger_command = fix_trigger_command(trigger_command)
  loginfo_line = "#{mod} #{trigger_command}"
  regex = Regexp.new(Regexp.escape(loginfo_line))

  root_cvs = create_root_cvs(trigger_files_checkout_dir)
  root_cvs.checkout nil, options
  loginfo_path = File.join(trigger_files_checkout_dir, "loginfo")
  File.comment_out(loginfo_path, regex, "# ")
  root_cvs.commit("Uninstalled trigger for CVS mod '#{mod}'", options)
  raise "Couldn't uninstall/commit trigger to loginfo" if trigger_installed?(trigger_command, trigger_files_checkout_dir, options)
end
uptodate?(identifier, options={}) click to toggle source
# File lib/rscm/scm/cvs.rb, line 55
def uptodate?(identifier, options={})
  if(!checked_out?)
    return false
  end

  checkout_silent(identifier, options.dup.merge({:simulate => true})) do |io|
    path_regex = /^[U|P|C] (.*)/
    io.each_line do |line|
      return false if(line =~ path_regex)
    end
  end
  return true
end

Protected Instance Methods

checkout_silent(to_identifier, options={}, &proc) click to toggle source
# File lib/rscm/scm/cvs.rb, line 214
def checkout_silent(to_identifier, options={}, &proc)
  to_identifier = nil if to_identifier == Time.infinity
  if(checked_out?)
    options = options.dup.merge({
      :dir => @checkout_dir
    })
    cvs(update_command(to_identifier), options, &proc)
  else
    # This is a workaround for the fact that -d . doesn't work - must be an existing sub folder.

    FileUtils.mkdir_p(@checkout_dir) unless File.exist?(@checkout_dir)
    target_dir = File.basename(@checkout_dir)
    # -D is sticky, but subsequent updates will reset stickiness with -A

    options = options.dup.merge({
      :dir => File.dirname(@checkout_dir)
    })
    cvs(checkout_command(target_dir, to_identifier), options, &proc)
  end
end
cmd_dir() click to toggle source
# File lib/rscm/scm/cvs.rb, line 210
def cmd_dir
  @checkout_dir
end
ignore_paths() click to toggle source
# File lib/rscm/scm/cvs.rb, line 233
def ignore_paths
  [/CVS\/.*/]
end

Private Instance Methods

branch_option() click to toggle source
# File lib/rscm/scm/cvs.rb, line 280
def branch_option
  branch_specified? ? "-r#{branch}" : ""
end
branch_specified?() click to toggle source
# File lib/rscm/scm/cvs.rb, line 276
def branch_specified?
  branch && branch.strip != ""
end
changes_command(options) click to toggle source
# File lib/rscm/scm/cvs.rb, line 270
def changes_command(options)
  # https://www.cvshome.org/docs/manual/cvs-1.11.17/cvs_16.html#SEC144

  # -N => Suppress the header if no RevisionFiles are selected.

  "log #{branch_option} -N #{period_option(options[:from_identifier], options[:to_identifier])} #{options[:relative_path]}"
end
checkout_command(target_dir, to_identifier) click to toggle source
# File lib/rscm/scm/cvs.rb, line 288
def checkout_command(target_dir, to_identifier)
  "checkout #{branch_option} -d #{target_dir} #{revision_option(to_identifier)} #{mod}"
end
command_line(cmd, password=nil, simulate=false) click to toggle source
# File lib/rscm/scm/cvs.rb, line 318
def command_line(cmd, password=nil, simulate=false)
  cvs_options = simulate ? "-n" : ""
  "cvs -f \"-d#{root_with_password(password)}\" #{cvs_options} -q #{cmd}"
end
commit_command(message) click to toggle source
# File lib/rscm/scm/cvs.rb, line 341
def commit_command(message)
  "commit -m \"#{message}\""
end
create_root_cvs(checkout_dir) click to toggle source
# File lib/rscm/scm/cvs.rb, line 323
def create_root_cvs(checkout_dir)
  cvs = Cvs.new(self.root, "CVSROOT", nil, self.password)
  cvs.checkout_dir = checkout_dir
  cvs.default_options = default_options
  cvs
end
cvs(cmd, options={}, &proc) click to toggle source
# File lib/rscm/scm/cvs.rb, line 245
def cvs(cmd, options={}, &proc)
  options = {
    :simulate => false,
    :dir => @checkout_dir
  }.merge(options)

  options[:dir] = PathConverter.nativepath_to_filepath(options[:dir])
  execed_command_line = command_line(cmd, password, options[:simulate])
  execute(execed_command_line, options, &proc)
end
cvsdate(time) click to toggle source
# File lib/rscm/scm/cvs.rb, line 300
def cvsdate(time)
  return "" unless time
  # CVS wants all dates as UTC.

  time.utc.strftime("%Y-%m-%d %H:%M:%S UTC")
end
fix_trigger_command(cmd) click to toggle source

Prepends a cat that will slurp stdin. Needed for triggers that don't read all of stdin passed from CVS to avoid broken pipe.

# File lib/rscm/scm/cvs.rb, line 241
def fix_trigger_command(cmd)
  "cat && #{cmd}"
end
local?() click to toggle source
# File lib/rscm/scm/cvs.rb, line 345
def local?
  protocol == "local"
end
parse_cvs_root() click to toggle source

parses the root into tokens

protocol, user, host, path
# File lib/rscm/scm/cvs.rb, line 360
def parse_cvs_root
  md = case
    when root =~ /^:local:/   then /^:(local):(.*)/.match(root)
    when root =~ /^:ext:/     then /^:(ext):(.*)@(.*):(.*)/.match(root)
    when root =~ /^:pserver:/ then /^:(pserver):(.*)@(.*):(.*)/.match(root)
  end
  result = case
    when root =~ /^:local:/   then [md[1], nil, nil, md[2]]
    when root =~ /^:ext:/     then md[1..4]
    when root =~ /^:pserver:/ then md[1..4]
    else ["local", nil, nil, root]
  end
end
parse_log(cmd, options, &proc) click to toggle source
# File lib/rscm/scm/cvs.rb, line 256
def parse_log(cmd, options, &proc)
  execed_command_line = command_line(cmd, password)
  revisions = nil

  execute(execed_command_line, options) do |io|
    parser = CvsLogParser.new(io)
    parser.cvspath = path
    parser.cvsmodule = mod
    revisions = parser.parse_revisions
  end
  revisions.cmd = execed_command_line if store_revisions_command?
  revisions
end
path() click to toggle source
# File lib/rscm/scm/cvs.rb, line 349
def path
  parse_cvs_root[3]
end
period_option(from_identifier, to_identifier) click to toggle source
# File lib/rscm/scm/cvs.rb, line 292
def period_option(from_identifier, to_identifier)
  if(from_identifier.nil? && to_identifier.nil?)
    ""
  else
    "-d\"#{cvsdate(from_identifier)}<#{cvsdate(to_identifier)}\" " 
  end
end
protocol() click to toggle source
# File lib/rscm/scm/cvs.rb, line 353
def protocol
  parse_cvs_root[0]
end
revision_option(identifier) click to toggle source
# File lib/rscm/scm/cvs.rb, line 330
def revision_option(identifier)
  option = nil
  if(identifier.is_a?(Time))
    option = "-D\"#{cvsdate(identifier)}\""
  elsif(identifier.is_a?(String))
    option = "-r#{identifier}"
  else
    ""
  end
end
root_with_password(password) click to toggle source
# File lib/rscm/scm/cvs.rb, line 306
def root_with_password(password)
  result = nil
  if local?
    result = root
  elsif password && password != ""
    protocol, user, host, path = parse_cvs_root
    result = ":#{protocol}:#{user}:#{password}@#{host}:#{path}"
  else
    result = root
  end
end
update_command(to_identifier) click to toggle source
# File lib/rscm/scm/cvs.rb, line 284
def update_command(to_identifier)
  "update #{branch_option} -d -P -A #{revision_option(to_identifier)}"
end