Ticket #333: buildbot-0.7.8-FtpTar.patch

old-buildbot/buildbot/slave/commands.py

@@ -2 +2 @@
-
-import os, re, signal, shutil, types, time
-from stat import ST_CTIME, ST_MTIME, ST_SIZE
+from ftplib import FTP
-
-from zope.interface import implements
-from twisted.internet.protocol import ProcessProtocol
@@ -1603 +1604 @@
-
-registerSlaveCommand("svn", SVN, command_version)
-
+class FtpTar(SourceBase):
+    """FTP and untar operation. In addition to the arguments
+    handled by SourceBase, this command reads the following keys:
+
+    ['ftphost'] (required): the FTP hostname
+    ['ftpfile'] (required): the FTP file to download
+    ['ftpuser'] (required): the FTP username
+    ['ftppass'] (required): the FTP password
+    ['striplevel'] (optional): the argument given to 'tar --strip %d'
+    """
+
+    header = "ftptar operation"
+
+    def setup(self, args):
+        SourceBase.setup(self, args)
+        self.tarexe = getCommand("tar")
+        self.ftphost = args['ftphost']
+        self.ftpfile = args['ftpfile']
+        self.ftpuser = args['ftpuser']
+        self.ftppass = args['ftppass']
+        self.striplevel = args['striplevel']
+        self.sourcedata = "%s\n" % self.ftpfile
+
+    def sourcedirIsUpdateable(self):
+        return False
+
+    def doVCFull(self):
+        # Delete and create ftp download directory
+        dd = os.path.join(self.builder.basedir, 'ftp')
+        if os.path.isdir(dd):
+            rmdirRecursive(dd)
+        os.mkdir(dd)
+        # Download the file
+        ftp = FTP(self.ftphost)
+        if self.ftpuser and self.ftppass:
+            ftp.login(self.ftpuser, self.ftppass)
+        f = os.path.join(dd, os.path.basename(self.ftpfile))
+        ftp.retrbinary('RETR '+self.ftpfile, open(f, 'wb').write)
+        ftp.quit()
+        # Create build directory
+        db = os.path.join(self.builder.basedir, self.srcdir)
+        os.mkdir(db)
+        # Untar source in build directory
+        striplevel = '%s' % (self.striplevel or 1)
+        command = [self.tarexe, 'axvf', f, '--strip', striplevel]
+        c = ShellCommand(self.builder, command, db,
+                         sendRC=False, timeout=self.timeout,
+                         keepStdout=True)
+        self.command = c
+        return c.start()
+
+    def parseGotRevision(self):
+        return None
+
+
+registerSlaveCommand("ftptar", FtpTar, command_version)
+
-class Darcs(SourceBase):
-    """Darcs-specific VC operation. In addition to the arguments
-    handled by SourceBase, this command reads the following keys:

old-buildbot/buildbot/steps/source.py

@@ -473 +473 @@
-        self.startCommand(cmd, warnings)
-
-
+class FtpTar(Source):
+    """I perform FTP download and decompression of a tar source archive file.
+    """
+
+    name = 'ftptar'
+
+    def __init__(self, ftphost=None, ftpuser=None, ftppass=None, ftpfile=None,
+                 striplevel=None, directory=None, **kwargs):
+        """
+        @type  ftphost: string
+        @param ftphost: hostname of the FTP server to connect to.
+
+        @type  ftpfile: string
+        @param ftpfile: full path to the file to retreive from FTP server. On
+                        slave, only the last path component of this path will
+                        be used.
+
+        @type  ftpuser: string
+        @param ftpuser: username to use for logging on the FTP server.
+
+        @type  ftphost: string
+        @param ftphost: password to use for logging on the FTP server.
+
+        @type  striplevel: integer
+        @param striplevel: Number of directories that must be removed from
+                           the filenames extracted form the archive. It
+                           defaults to 1, usually stripping the name-X.y.z/
+                           part of the files extracted, thus providing a
+                           Makefile directly in the build directory.
+
+        """
+
+        if not kwargs.has_key('workdir') and directory is not None:
+            # deal with old configs
+            warn("Please use workdir=, not directory=", DeprecationWarning)
+            kwargs['workdir'] = directory
+
+        self.ftphost = ftphost
+        self.ftpfile = ftpfile
+        self.ftpuser = ftpuser
+        self.ftppass = ftppass
+        self.striplevel = striplevel
+
+        Source.__init__(self, **kwargs)
+        self.addFactoryArguments(ftphost=ftphost,
+                                 ftpfile=ftpfile,
+                                 ftpuser=ftpuser,
+                                 ftppass=ftppass,
+                                 striplevel=striplevel,
+                                 directory=directory,
+                                 )
+
+        if not ftpfile or not ftphost:
+            raise ValueError("you must specify ftphost and ftpfile")
+
+
+    def computeSourceRevision(self, changes):
+        return None 
+
+    def startVC(self, branch, revision, patch):
+
+        warnings = []
+
+        if self.args['mode'] != "update":
+            warnings.append("WARNING: FtpTar slave can only do full retreival"
+                                ", do not specify mode other than update")
+
+        self.args['ftphost'] = self.ftphost
+        self.args['ftpfile'] = self.ftpfile
+        self.args['ftpuser'] = self.ftpuser
+        self.args['ftppass'] = self.ftppass
+        self.args['striplevel'] = self.striplevel
+        self.args['revision'] = revision
+        self.args['patch'] = patch
+
+        revstuff = []
+        if branch is not None and branch != self.branch:
+            revstuff.append("[branch]")
+        if revision is not None:
+            revstuff.append("r%s" % revision)
+        if patch is not None:
+            revstuff.append("[patch]")
+        self.description.extend(revstuff)
+        self.descriptionDone.extend(revstuff)
+
+        cmd = LoggedRemoteCommand("ftptar", self.args)
+        self.startCommand(cmd, warnings)
+
+
-class Darcs(Source):
-    """Check out a source tree from a Darcs repository at 'repourl'.
-

old-buildbot/docs/buildbot.texinfo

@@ -207 +207 @@
-* Bzr::                         
-* P4::                          
-* Git::                         
+* FtpTar::                         
-
-Simple ShellCommand Subclasses
-
@@ -4388 +4389 @@
-* Bzr::                         
-* P4::                          
-* Git::                         
+* FtpTar::
-@end menu
-
-@node CVS, SVN, Source Checkout, Source Checkout
@@ -4763 +4765 @@
-@end table
-
-
- 
+FtpTar
-@subsubsection Git
-
-@cindex Git Checkout
@@ -4789 +4791 @@
-@end table
-
-
+@node FtpTar,  , Git, Source Checkout
+@subsubsection FtpTar
+@cindex CVS Checkout
+@bsindex buildbot.steps.source.FtpTar
+
+
+The @code{FtpTar} build step performs a download of a specified file from
+an FTP server (usually a source archive), and untar it into a build
+directory, just as it could have bee got from another VCS operation.
+
+The FtpTar step does not use the mode argument. It should be left to the
+default update mode, despite it generates a new source tree at each build.
+
+The FtpTar step takes the following arguments:
+
+@table @code
+@item ftphost
+(required): The hostname of the FTP server to connect to.
+
+@item ftpfile
+(required): The full path to the file to dowload from the FTP server. The FTP
+download is done using image (binary) mode.
+
+@item ftpuser
+(optional): The username to use for logging on the FTP server.
+
+@item ftppass
+(optional): The password to use for logging on the FTP server.
+
+@item striplevel
+(optional): The number of directory names to remove from the path of the
+files extracted form the archive. It defaults to 1, which usually strips the
+name-X.y.z/ part of the files extracted, providing a Makefile directly in
+the build directory.
+
+@end table
+
+
+
-@node ShellCommand, Simple ShellCommand Subclasses, Source Checkout, Build Steps
-@subsection ShellCommand
-