rscm-accurev 0.0

data/LICENSE

@@ -0,0 +1,25 @@
+Copyright (c) 2005, Gregory D. Fast
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+
+    * 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 THE COPYRIGHT
+OWNER OR CONTRIBUTORS 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.

data/README

@@ -0,0 +1,9 @@
+RSCM::Accurev
+=============
+
+This is an api for interacting with the SCM tool accurev
+(http://accurev.com).
+
+NOTE: This is a early pre-alpha quality release, and is currently
+unsuitable for use.
+

data/Rakefile

@@ -0,0 +1,137 @@
+# -*- ruby -*-
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'tracer'
+
+# this rakefile originally borrowed shamelessly from rscm
+
+PKG_NAME = 'rscm-accurev'
+PKG_BUILD = ENV['PKG_BUILD'] ? '.'+ENV['PKG_BUILD'] : ''
+PKG_VERSION = '0.0' + PKG_BUILD
+PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
+PKG_SUMMARY = 'RSCM::Accurev - RSCM API for Accurev'
+
+desc "Default Task"
+task :default => [ :test, :gem ]
+
+RAKEVERSION =~ /^(\d+)\.(\d+).(.*)/
+rake_maj,rake_min,rake_patch = $1,$2,$3
+if rake_maj.to_f < 1 and rake_min.to_f <= 5 and rake_patch.to_f <= 4
+  # use this for rake <= 0.5.4:
+  task :test => [ :plaintest ]
+  HAVEXMLTEST = false
+else
+  # rake 0.5.4.6+ (0.5.5)
+  task :test => [ :backup_testresults, :xmltest ]
+  HAVEXMLTEST = true
+end
+
+# define a task(s) to run tests
+
+test_files = FileList.new( "test/**/t_*.rb" )
+TEST_OUTPUT = "html/test"
+
+Rake::TestTask.new( :plaintest ) do |t|
+  t.libs << "test"
+  t.test_files = test_files
+  t.verbose = true
+end
+
+if HAVEXMLTEST
+# rake<0.5.5 requires a patch to rake_test_loader.rb to exclude options
+# rake<0.5.5 requires a patch to rake/testtask.rb to support ruby_opts
+# (see doc/patches)
+Rake::TestTask.new( :xmltest ) do |t|
+  t.libs << "test"
+  t.test_files = test_files
+  t.verbose = true
+  t.ruby_opts << '-rtest/unit/ui/xml/testrunner'
+  ENV['XMLTEST_OUTPUT'] = "#{TEST_OUTPUT}/testresults.xml"
+  t.options = "--runner=xml"
+end
+end # !HAVEXMLTEST
+
+
+# backs up existing testresults.xml files in test target dir
+task :backup_testresults do
+  unless File.exist?( TEST_OUTPUT )
+    mkdir_p( TEST_OUTPUT )
+  end
+  old = "#{TEST_OUTPUT}/testresults.xml"
+  if File.exist?( old )
+    stat = File.stat( old )
+    bak = stat.ctime.strftime('testresults-%Y%m%d-%H%M.xml')
+    new = "#{TEST_OUTPUT}/#{bak}"
+    #puts "...Backing up previous test results to #{new}"
+    mv( old, new )
+  end
+end
+
+# define a task to create rdocs
+# keep a reference to it so we can reuse it in the gempkg task
+rd_task = Rake::RDocTask.new( :rdoc ) do |rdoc|
+  rdoc.title = PKG_SUMMARY
+  rdoc.template = "doc/jamis.rb" # so nice
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include( 'STATUS' )
+  rdoc.rdoc_files.include( 'lib/**/*.rb' )
+  rdoc.rdoc_files.include( 'doc/*.rd' )
+end
+
+PKG_FILES = FileList[
+  '*',
+  'lib/**/*',
+  'test/**/*' 
+]
+
+if ! defined?(Gem)
+  puts "Target 'package' requires RubyGems"
+else
+  spec = Gem::Specification.new do |s|
+    s.name = PKG_NAME
+    s.version = PKG_VERSION
+    s.summary = PKG_SUMMARY
+    s.description = "RSCM::Accurev is an RSCM API for the SCM tool Accurev (http://www.accurev.com/)."
+    s.files = PKG_FILES.to_a
+    s.require_path = 'lib'
+    s.autorequire = 'rscm/scm/accurev'
+    s.has_rdoc = true
+    rd_task.options.each {|opt|  s.rdoc_options << opt }
+    s.author = "Greg Fast"
+    s.email = "gdf@speakeasy.net"
+    s.homepage = "http://rscm-accurev.rubyforge.org"
+  end
+
+  # define a gem package task
+  Rake::GemPackageTask.new( spec ) do |pkg|
+    pkg.need_zip = true
+    pkg.need_tar = true
+  end
+end
+
+desc "Delete all generated files (includes built packages)"
+task :realclean do
+  f = FileList[ 'pkg', 'html', 'doc/test*.xml' ]
+  rm_rf f
+end
+
+desc "Coverage! (still a big hack)"
+task :coverage => [ :test_coverage, :coverage_summary ]
+
+Rake::TestTask.new( :test_coverage ) do |t|
+  t.libs << "test"
+  t.test_files = test_files
+  t.verbose = true
+  def t.rake_loader
+    'test/coverage/c_loader.rb'
+  end
+end
+
+task :coverage_summary do
+   # too many options!@
+  ruby "test/coverage/analyzer.rb xxx.trace html/coverage test/coverage/template.html test/coverage/index_tmpl.html"
+end

data/STATUS

@@ -0,0 +1,63 @@
+
+= RSCM::Accurev Status
+
+------------------------
+
+== Core RSCM API (RSCM::Accurev::API)
+
+[checkout()]  supported
+
+    - basic checkouts should work
+
+    - time-based checkouts do not work
+
+[update()]  basic updates work
+
+    - time-based updates ("update( yesterday )") not working
+
+    - elements list returned currently includes directories and removed files
+
+[add()]  unsupported, todo(?)
+
+[edit()]  supported (no-op)
+
+[revisions()]  supported
+
+    - time-based limits do not work
+
+    - should be history-based
+
+-------------------------------------------
+
+== Accurev-specific API (RSCM::Accurev::API)
+
+[ac_update()]  unsupported, todo
+
+[ac_files()]  supported
+
+[ac_info()]  supported
+
+[ac_stat()]  unsupported, use ac_files().
+
+[ac_move()]  unsupported, todo
+
+[ac_pop()]  unsupported, todo
+
+[ac_purge()]  unsupported, todo
+
+[ac_hist()]  unsupported, todo
+
+[ac_keep()]  unsupported, todo
+
+[ac_promote()]  unsupported, todo
+
+-------------------------------------------
+
+== Other Items
+
+[code docs]  woefully incomplete
+
+[usage docs]  virtually nonexistant
+
+[test coverage]  truly pitiful
+

data/TODO

@@ -0,0 +1,43 @@
+# todo for rscm/scm/accurev.rb
+
+api - checkout
+ - there is no rscm-api update() (only checkout-to-existing-ws)
+ - `pop`, `update`
+
+**api - revisions
+ - `hist` (others?)
+
+api - diff
+ - `diff` (yukx)
+
+api - import_central, create_central
+ - munge depots - probably skip these, or use acxmlparser
+
+api - api-specific commands to manage streams
+ - use acxmlparser
+
+api - triggers?
+
+**api - identifiers (Time or revision) to ac format
+ - is this even always applicable?  does stat/update take limits?
+
+# xml - s/FileStatus/FileData/
+
+api - checkout(Time.infinite) just does update
+      checkout(x) only works if ws not exist
+        unless it implies nuke-and-re-checkout (slow)
+
+api - need ac_update which returns an acresponse
+
+api - update: elements list should not contain directories
+
+api - update: elements list should probably not include removed files
+
+# command - Command.working_dir is bad: should use with_working_dir()
+
+*** api - checkout() should use `pop` instead of `mkws`, unless
+	  user *really* wants it
+ - yeargh...  how does update work with pop?  just nuke and/or overwrite?
+
+ac pop -R -v orbitz-host-gt3-0-rc -L . . > ~/cheese/rscm-accurev/test/eg/ac-pop.txt
+

data/apitest.rb

@@ -0,0 +1,21 @@
+#!/opt/ruby/bin/ruby
+require 'rubygems'
+
+$:<<"lib"
+require 'rscm/scm/accurev'
+
+#files; ac = RSCM::Accurev.new( '/home/gfast/dev/orbitz-host-gt3-0-impl' )
+#files; ac.ac_files(".").each do |f|
+#files;   puts "#{f.location}\t\t#{f.status}"
+#files; end
+
+# yes, i cannot spell, the dir is "hirdcar":
+ac = RSCM::Accurev.new( '/home/gfast/dev/orbitz-api-hirdcar-0-rc' )
+ac.backing_stream = "orbitz-api-hiredcar-0-rc"
+ac.workspace_stream = "orbitz-api-hiredcar-0-rc-testing_gfast"
+ac.checkout() do |l|
+  puts l
+end
+
+
+

data/bumprelease.sh

@@ -0,0 +1,13 @@
+#!/bin/sh
+
+# gee, i bet you could stick this in the rakefile...
+
+LAST=`cat .version.minor`
+MINOR=$(( $LAST + 1 ))
+
+perl -i~~ -pe "s/VERSION = '0.0.\d+'/VERSION = '0.0.$MINOR'/" \
+  lib/rscm/accurev.rb
+
+PKG_BUILD=$MINOR rake package gem && \
+    echo $MINOR > .version.minor
+

data/lib/rscm/accurev.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+require 'rscm/scm/accurev/api'
+require 'rscm/scm/accurev/command'
+require 'rscm/scm/accurev/xml'
+require 'rscm/scm/accurev/filterio'
+
+module RSCM
+  #
+  # == module RSCM::Accurev
+  #
+  # Namespace for accurev api classes and utils.
+  #
+  # See RSCM::Accurev::API.
+  #
+  module Accurev
+    VERSION = '0.0.5'
+  end
+end

data/lib/rscm/scm/accurev/api.rb

@@ -0,0 +1,411 @@
+# -*- ruby -*-
+#
+# = api.rb
+#
+# API for interacting with accurev workspaces.
+#
+# Includes:
+#
+# * API
+#
+require 'stringio'
+require 'rscm/base'
+require 'rscm/path_converter'
+require 'rexml/document'
+require 'rscm/scm/accurev/xml'
+require 'rscm/scm/accurev/filterio'
+require 'rscm/scm/accurev/command'
+require 'rscm/scm/accurev/exception'
+
+# need to define module within module before you can use module X::Y
+module RSCM; module Accurev; end; end
+
+module RSCM::Accurev
+
+  #
+  # RSCM implementation for Accurev (http://www.accurev.com).
+  #
+  # Requires an accurev cli executable on the path (see also
+  # RSCM::Accurev::Command), and the correct environment
+  # configuration for ac server/principal/password.
+  #
+  # ---
+  #
+  # === Example
+  #
+  #   api = RSCM::Accurev::API.new( "./ws/proj-1", "proj", "proj-1" )
+  #   api.checkout() each do |file|
+  #     puts "Updated #{file}..."
+  #   end
+  #
+  class API < RSCM::Base
+    register self
+
+    ann :description => "Accurev Depot"
+    attr_accessor :depot
+
+    ann :description => "Backing Stream (autodetected)"
+    attr_accessor :backing_stream
+    
+    # If workspace stream is nil (the default), checkout/update will be
+    # done using `accurev pop`.  This is faster and more appropriate for 
+    # read-only use; however a workspace is required for commits.
+    ann :description => "Workspace Stream"
+    attr_accessor :workspace_stream
+
+    # [defined in Base]
+    # ann :description => "Filesystem Path to Workspace"
+    # attr_accessor :checkout_dir
+
+    ann :description => "Overwrite Mode: if true, co overwrites existing"
+    attr_accessor :overwrite
+    
+    def initialize(checkout_dir=nil, backing_stream=nil, workspace_stream=nil)
+      @depot = nil # will be pulled from files cmd output
+      @workspace_stream = workspace_stream
+      @backing_stream = backing_stream
+      @checkout_dir = checkout_dir
+      @overwrite = false
+    end
+
+    def name()
+      return "Accurev"
+    end
+
+    # Accurev operations are atomic: returns true.
+    def transactional?
+      return true
+    end
+
+    # "Adds +relative_filename+ to the working copy."
+    def add( relative_filename )
+      raise "XXX implement me"
+    end
+
+    def edit( relative_filename )
+      # NOP - not required for ac
+    end
+
+    # "Returns a Revisions object for the period specified ... (inclusive)."
+    #
+    # list txns (promotes to bs) from hist within the period
+    #
+    def revisions( from_identifier, to_identifier=Time.infinity )
+      raise "XXX implement me"
+    end
+
+    # default impl depends on a correct impl of revisions()
+#     def uptodate?( identifier=nil )
+#       
+#     end   
+
+    # def checked_out? - base
+
+    # accurev actually does have triggers, but I haven't implemented that yet
+    def supports_trigger?
+      false
+    end
+
+    # def diff() XXX
+
+
+    # --- ac specific
+
+    # remember: ac_files is non-recursive
+    def ac_files( relative_path )
+      cmd = Command.instance
+      ret = []
+      with_working_dir( co_filepath ) do
+        acresponse = cmd.accurev( "files", relative_path )
+        if acresponse['element'].nil?
+          return []
+        end
+        acresponse['element'].each do |fd|
+          yield fd if block_given?
+          ret << fd
+        end
+      end
+      return ret
+    end
+
+    def ac_stat( flag="-a" )
+      cmd = Command.instance
+      ret = []
+      with_working_dir( co_filepath ) do
+        acresponse = cmd.accurev( "stat", flag )
+        return [] if acresponse['element'].nil?
+        acresponse['element'].each do |fd|
+          yield fd if block_given?
+          ret << fd
+        end
+      end
+      return ret
+    end
+
+    # yeilds the TransactionData objects for the given time period
+    # (promotes only)
+    def ac_hist( from, to=Time.infinite )
+      cmd = Command.instance
+      lower = from.to_accurev
+      upper = "now"
+      unless to == Time.infinite
+        upper = to.to_accurev
+      end
+      with_working_dir( self.co_filepath ) do
+        acresponse = cmd.accurev( "hist",
+                                  "-t", "'#{upper}-#{lower}'",
+                                  "-k", "promote"
+                                 )
+        ret = []
+        acresponse['transaction'].each do |txn|
+          ret << txn
+          yield txn if block_given?
+        end
+        return ret
+      end
+    end
+
+    def ac_keep( files=[], message="" )
+      raise "XXX implement me"
+    end
+
+    def ac_promote( files=[], message="" )
+      raise "XXX implement me"
+    end
+    
+    def ac_update( relative_path="." )
+      d = accurev( "update", relative_path )
+      if xxx_error_stale
+        raise StaleWorkspaceError.new( "#{relative_path} is stale -- keep/anchor all changes and re-update" )
+      end
+    end
+
+    def ac_purge( files=[] )
+      raise "XXX implement me"
+    end
+
+    def ac_revert( files=[] )
+      raise "XXX implement me"
+    end
+
+    def ac_move( current_file, new_file )
+      raise "XXX implement me"
+    end
+
+    #
+    # Performs an "accurev info" command in the workspace.
+    # Returns a map of 
+    #
+    # ac info: shows eg, backing stream
+    # but doesn't support -fx!    
+    #
+    def ac_info()
+      co = RSCM::PathConverter.nativepath_to_filepath( @checkout_dir )
+      unless File.exists?( co )
+        raise AccurevException.new( "Checkout dir #{co} does not exist" )
+      end
+      info = {}
+      with_working_dir( co ) do
+        cmd = Command.instance
+        io = StringIO.new( cmd.accurev_nofx( "info" ) )
+        io.each_line do |line|
+          next unless line =~ /\S/
+          if line =~ /^(.*?):\s+(.*)$/
+            info[$1] = $2
+          end
+        end
+      end
+      return info
+    end
+
+    # ac mkws 
+    #   -b orbitz-host-gt3-0-impl 
+    #   -w orbitz-host-gt3-0-impl-test2_gfast
+    #   -l `pwd`    
+    # - does not support fx (argh!@)
+    # - does not pop
+    # 
+
+    # diff: /usr/local/bin/acdiff (!) --fx
+    # (after an ac cat on the backed file)
+    # (eg, no in-process diffing ala cvs diff)
+    # lists modified lines in xml
+
+    #
+    # "Checks out or updates[!] contents from a central SCM 
+    # to +checkout_dir+ - a local working copy."
+    #
+    # "The +to_identifier+ parameter may be optionally specified to
+    # obtain files up to a particular time or label."
+    #
+    # For accurev, this:
+    # * checks to see if +@checkout_dir+ exists and appears checked out.
+    #   If it's already checked out, this calls +update()+.  If
+    #   +@checkout_dir+ exists and +to_identifier+ is given, an
+    #   exception is raised.
+    # * otherwise, this creates a new workspace stream and populates it
+    #   at +@checkout_dir+.
+    #
+    # This both returns and yields a list of updated files.
+    # Only updated files are returned, not directories.
+    #
+    # Current, ac_update returns both files and directories, including
+    # deleted files.
+    #
+    def checkout( to_identifier=Time.infinite )
+      co = RSCM::PathConverter.nativepath_to_filepath( @checkout_dir )
+      if @backing_stream.nil?
+        self.attempt_init_from_info()
+      end
+      if @workspace_stream.nil?
+        self.checkout_pop()
+      else
+        unless File.exists?( co )
+          # create new workspace
+          self.checkout_workspace()
+        end
+        # update workspace
+        self.update( to_identifier )
+      end
+    end
+
+    def checkout_pop()
+      co = RSCM::PathConverter.nativepath_to_filepath( @checkout_dir )
+      raise "A backing stream is required" if @backing_stream.nil?
+      raise "A working stream may not be given" unless @working_stream.nil?
+      # for `accurev pop`: remove and re-pop the checkout copy
+      if File.exists?( co )
+        unless @overwrite
+          raise "Checkout dir #{co} already exists (@overwrite=#@overwrite)"
+        end
+        rm_rf( co )
+      end
+      mkdir(co)
+      with_working_dir( co ) do
+        cmd = Command.instance
+        pop_out = cmd.accurev_nofx("pop",
+                                   "-R",
+                                   "-v", @backing_stream,
+                                   "-L", ".", ".")
+        elems = []
+        popio = StringIO.new( pop_out )
+        popio.each_line do |line|
+          if line =~ /^Populating element \/.\/(.*)$/
+            loc = $1
+            elems << loc
+            yield loc if block_given?
+          end
+        end
+        return elems
+      end
+    end
+
+    def checkout_workspace()
+      co = RSCM::PathConverter.nativepath_to_filepath( @checkout_dir )
+      raise "A backing stream is required" if @backing_stream.nil?
+      raise "A workspace is required" if @working_stream.nil?
+      if File.exist?( co ) and !@overwrite
+        raise "Checkout dir #{co} already exists (@overwrite=#@overwrite)"
+      end
+      cmd = Command.instance
+      mkws_out = cmd.accurev_nofx( "mkws", 
+                                  "-b", @backing_stream,
+                                  "-w", @workspace_stream,
+                                  "-l", co )
+      # kinda sucks:
+      if ( mkws_out =~ /already exists/ )
+        raise AccurevException.new( "Failed to checkout", mkws_out )
+      end
+    end
+
+    def update( to_identifier=Time.infinite )
+      co = RSCM::PathConverter.nativepath_to_filepath( @checkout_dir )
+      unless File.exists?( co )
+        raise AccurevException.new( "Workspace does not exist!" )
+      end
+      updated = []
+      with_working_dir( co ) do
+        cmd = Command.instance
+        acresponse = cmd.accurev( "update" )
+        if acresponse.error
+          if acresponse.error =~ /workspace have been modified/
+            raise StaleWorkspaceException.new( "Workspace stale",
+                                               acresponse.error )
+          else
+            # some other update problem
+            raise AccurevException.new( "Error on update", acresponse.error )
+          end
+        end
+        if acresponse['element']
+          acresponse['element'].each do |up|
+            # "ac update" on a new workspace yields element locations
+            # with leading "/"s, which should be removed to get a proper
+            # relative path:
+            loc = up.location.sub( /^\//, "" )
+            yield loc if block_given?
+            updated << loc
+          end
+        end
+      end
+      return updated
+    end
+
+    # --- internals
+
+    # status flag mappings for "stat", "file" commands
+    STATUSES = {
+      '(backed)'   => :backed,
+      '(external)' => :external,
+      '(modified)' => :modified,
+      '(kept)'     => :kept,
+      '(defunct)'  => :defunct,
+      '(missing)'  => :missing,
+      '(stranded)' => :stranded,
+      '(overlap)'  => :overlap
+    }
+
+#  private
+      
+    # psuedo-accessor (cached)
+    def co_filepath
+      if @co_filepath.nil?
+        @co_filepath = RSCM::PathConverter.nativepath_to_filepath( @checkout_dir )
+      end
+      return @co_filepath
+    end
+
+    #
+    # Runs an `ac info` command in +@checkout_dir+, and tries to
+    # set +@backing_stream+ and +@workspace_stream+ from the output.
+    #
+    def attempt_init_from_info()
+      if File.exists?( self.co_filepath )
+        info = self.ac_info
+        if info.has_key?( "Basis" )
+          @backing_stream = info["Basis"]
+        end
+        if info.has_key?( "ws/ref" )
+          @workspace_stream = info["ws/ref"]
+        end
+      end
+    end
+    
+    # Takes a status flags line (eg, "(modified)(kept)")
+    # and returns a list of status flags.
+    def map_status( status_line )
+      l = status_line.split( " " ).map {|x| x.trim}
+    end
+
+  end
+
+end
+
+class Time
+  def to_accurev
+    self.strftime( "%Y/%m/%d %H:%M:%S" )
+  end
+end
+
+#
+# Copyright (c) 2005 Gregory D. Fast <gdf@speakeasy.net>
+#