rscm-accurev 0.0

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

@@ -0,0 +1,393 @@
+# -*- 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
+
+    def ac_files( relative_path )
+      cmd = Command.instance
+      ret = []
+      with_working_dir( @checkout_dir ) do
+        acresponse = cmd.accurev( "files", relative_path )
+        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>
+#

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

@@ -0,0 +1,151 @@
+# -*- ruby -*-
+
+module RSCM
+  module Accurev
+
+    #
+    # Executes accurev commands and deals with the output.
+    # This class is a thread local singleton: each thread
+    # calling +Command.instance+ gets a different instance.
+    #
+    class Command
+
+      attr_accessor :debug, :debug_to, :accurev_bin
+
+      # If you need to swap out the mapper class
+      attr_accessor :xmlmapper
+
+      def initialize()
+        @xmlmapper = XMLMapper
+        @debug = false
+        @debug_to = STDOUT
+        @accurev_bin = "accurev"
+      end
+
+      #
+      # Returns a command line string for executing the given
+      # accurev subcomment +cmd+ with arguments +opts+.
+      #
+      def accurev_cmdline( cmd, *opts )
+        return "#{@accurev_bin} #{cmd} #{opts.join(' ')}";
+      end
+     
+      #
+      # Executes the given accurev subcommand +cmd+ with the
+      # given arguments +opts+.  The command will be executed with
+      # standard (non-xml) output format. This method returns
+      # the stdout from the command execution.
+      #
+      # (Not all accurev subcommands (eg, `accurev info`) support 
+      # `-fx` for xml output.)
+      #
+      def accurev_nofx( cmd, *opts )
+##        # nativepath_to_filepath is actually generic to native
+##        dir = PathConverter.nativepath_to_filepath( @working_dir )
+##        dir = File.expand_path( dir )
+##        with_working_dir( dir ) do
+          cmdline = self.accurev_cmdline( cmd, opts )
+          if @debug
+            @debug_to.puts("ac> #{cmdline}")
+          end
+          Better.popen( cmdline ) do |stdout|
+            return stdout.read()
+          end
+##        end
+      end
+
+      #
+      # Executes the given accurev subcommand +cmd+ with the 
+      # given arguments +opts+ in XML mode.  The output of the command
+      # will be converted to an REXML document and returned.
+      # The command's options list will have `-fx` appended, 
+      # to specify xml output format.
+      # 
+      # Certain quirks in <AcResponse>-type documents will be 
+      # corrected (see Accurev::AcXMLScrubIO).  Note that not all 
+      # accurev subcommands support the "-fx" option.
+      #
+      def accurev_xml( cmd, *opts )
+        opts << "-fx"
+##        # nativepath_to_filepath is actually generic to native
+##        dir = PathConverter.nativepath_to_filepath( @working_dir )
+##        dir = File.expand_path( dir )
+##        with_working_dir( dir ) do
+          cmdline = self.accurev_cmdline( cmd, opts )
+          if @debug
+            @debug_to.puts("ac> #{cmdline}")
+          end
+          Better.popen( cmdline ) do |stdout|
+            output = stdout.read()
+            if @debug
+              @debug_to.puts( "raw>" )
+              @debug_to.puts( output )
+            end
+            begin
+              return REXML::Document.new( AcXMLScrubIO.new( output ) )
+            rescue Exception => e
+              raise "Unexpected output from #{cmdline}: #{e}"
+            end
+          end
+##        end
+      end
+      
+      #
+      # Execute the given accurev subcommand using +accurev_xml+,
+      # and return an object tree mirroring the structure of the 
+      # XML output.
+      #
+      # This uses +XMLMapper+ to build the object tree.
+      #
+      def accurev( cmd, *opts )
+        doc = self.accurev_xml( cmd, opts )
+        if @debug
+          @debug_to.puts( "doc>" )
+          @debug_to.puts( doc )
+        end
+        if doc.elements.size==0
+          raise "Unexpected output from #{cmd}: #{doc}"
+        end
+        mapper = @xmlmapper.new()
+        return mapper.map( doc.root )
+      end
+
+  # static methods
+
+      # Retrieve this thread's +Command+ instance.
+      #
+      # eg:
+      #    cmd = Command.instance
+      # eg:
+      #    Command.instance do |cmd|
+      #      cmd.workspace_dir = "/var/tmp"
+      #    end
+      #
+      def Command.instance()
+        if Thread.current[ :RSCM_ACCUREV_COMMAND ].nil?
+          Thread.current[ :RSCM_ACCUREV_COMMAND ] = Command.new
+        end
+        yield Thread.current[ :RSCM_ACCUREV_COMMAND ] if block_given?
+        return Thread.current[ :RSCM_ACCUREV_COMMAND ]
+      end
+
+      # Discard the current thread's Command object.
+      # The next call to +Command.instance+ in this thread will
+      # return a new instance configured with the defaults.
+      def Command.discard()
+        Thread.current[ :RSCM_ACCUREV_COMMAND ] = nil
+      end
+
+    private
+
+      # new() is marked private, use Command.instance().
+      def new( *args )
+        super(args)
+      end
+
+    end # class Command
+    
+  end
+end
+
+