From e8892813997ba494550cfa003ce60807f559bc88 Mon Sep 17 00:00:00 2001 From: Steven Knight Date: Tue, 25 Feb 2003 20:01:52 +0000 Subject: Add support for Perforce. (Charles Crain) --- doc/man/scons.1 | 41 ++++++++ src/CHANGES.txt | 4 + src/engine/MANIFEST.in | 1 + src/engine/SCons/Tool/Perforce.py | 88 ++++++++++++++++++ src/engine/SCons/Tool/__init__.py | 2 +- test/Perforce.py | 190 ++++++++++++++++++++++++++++++++++++++ 6 files changed, 325 insertions(+), 1 deletion(-) create mode 100644 src/engine/SCons/Tool/Perforce.py create mode 100644 test/Perforce.py diff --git a/doc/man/scons.1 b/doc/man/scons.1 index f76bc01..e96f150 100644 --- a/doc/man/scons.1 +++ b/doc/man/scons.1 @@ -1535,6 +1535,37 @@ env.InstallAs(target = '../lib/libfoo.a ../lib/libbar.a', .EE .TP +.RI Perforce( ) +A factory function that +returns a Builder object +to be used to fetch source files +from the Perforce source code management system. +The returned Builder +is intended to be passed to the +.B SourceCode +function: +.ES +env.SourceCode('.', env.Perforce()) +.EE +.IP +Perforce uses a number of external +environment variables for its operation. +Consequently, this function adds the +following variables from the user's external environment +to the construction environment's +ENV dictionary: +P4CHARSET, +P4CLIENT, +P4LANGUAGE, +P4PASSWD, +P4PORT, +P4USER, +SYSTEMROOT, +USER, +and +USERNAME. + +.TP .RI Precious( target ", ...)" Marks each given .I target @@ -2282,6 +2313,16 @@ The prefix used for (static) object file names. .IP OBJSUFFIX The suffix used for (static) object file names. +.IP P4 +The Perforce executable. + +.IP P4COM +The command line used to +fetch source files from Perforce. + +.IP P4FLAGS +General options that are passed to Perforce. + .IP PCH The Microsoft Visual C++ precompiled header that will be used when compiling object files. This variable is ignored by tools other than Microsoft Visual C++. diff --git a/src/CHANGES.txt b/src/CHANGES.txt index 9befe24..d83561b 100644 --- a/src/CHANGES.txt +++ b/src/CHANGES.txt @@ -10,6 +10,10 @@ RELEASE 0.12 - XXX + From Charles Crain: + + - Added support for the Perforce source code management system. + From Steven Knight: - Added an INSTALL construction variable that can be set to a function diff --git a/src/engine/MANIFEST.in b/src/engine/MANIFEST.in index 6a6cb6a..592e676 100644 --- a/src/engine/MANIFEST.in +++ b/src/engine/MANIFEST.in @@ -55,6 +55,7 @@ SCons/Tool/mslib.py SCons/Tool/mslink.py SCons/Tool/msvc.py SCons/Tool/nasm.py +SCons/Tool/Perforce.py SCons/Tool/pdflatex.py SCons/Tool/pdftex.py SCons/Tool/PharLapCommon.py diff --git a/src/engine/SCons/Tool/Perforce.py b/src/engine/SCons/Tool/Perforce.py new file mode 100644 index 0000000..7c1a2a7 --- /dev/null +++ b/src/engine/SCons/Tool/Perforce.py @@ -0,0 +1,88 @@ +"""SCons.Tool.Perforce.py + +Tool-specific initialization for Perforce Source Code Management system. + +There normally shouldn't be any need to import this module directly. +It will usually be imported through the generic SCons.Tool.Tool() +selection method. + +""" + +# +# __COPYRIGHT__ +# +# Permission is hereby granted, free of charge, to any person obtaining +# a copy of this software and associated documentation files (the +# "Software"), to deal in the Software without restriction, including +# without limitation the rights to use, copy, modify, merge, publish, +# distribute, sublicense, and/or sell copies of the Software, and to +# permit persons to whom the Software is furnished to do so, subject to +# the following conditions: +# +# The above copyright notice and this permission notice shall be included +# in all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY +# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE +# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +# + +__revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__" + +import os + +import SCons.Builder +import SCons.Util +import SCons.Node.FS + +# This function should maybe be moved to SCons.Util? +from SCons.Tool.PharLapCommon import addPathIfNotExists + +# Variables that we want to import from the base OS environment. +_import_env = [ 'P4PORT', 'P4CLIENT', 'P4USER', 'USER', 'USERNAME', 'P4PASSWD', + 'P4CHARSET', 'P4LANGUAGE', 'SYSTEMROOT' ] + +def generate(env, platform): + """Add a Builder factory function and construction variables for + Perforce to an Environment.""" + + def PerforceFactory(env=env): + """ """ + return SCons.Builder.Builder(action = '$P4COM', + env = env) + + setattr(env, 'Perforce', PerforceFactory) + + env['P4'] = 'p4' + env['P4FLAGS'] = '' + env['P4COM'] = '$P4 $P4FLAGS sync $TARGET' + try: + environ = env['ENV'] + except KeyError: + environ = {} + env['ENV'] = environ + + # Perforce seems to use the PWD environment variable rather than + # calling getcwd() for itself, which is odd. If no PWD variable + # is present, p4 WILL call getcwd, but this seems to cause problems + # with good ol' Win32's tilde-mangling for long file names. + environ['PWD'] = SCons.Node.FS.default_fs.Dir('#').abspath + + for var in _import_env: + v = os.environ.get(var) + if v: + environ[var] = v + + if SCons.Util.can_read_reg: + # If we can read the registry, add the path to Perforce to our environment. + k=SCons.Util.RegOpenKeyEx(SCons.Util.hkey_mod.HKEY_LOCAL_MACHINE, + 'Software\\Perforce\\environment') + val, tok = SCons.Util.RegQueryValueEx(k, 'P4INSTROOT') + addPathIfNotExists(environ, 'PATH', val) + +def exists(env): + return env.Detect('p4') diff --git a/src/engine/SCons/Tool/__init__.py b/src/engine/SCons/Tool/__init__.py index b367d32..b6b7f9e 100644 --- a/src/engine/SCons/Tool/__init__.py +++ b/src/engine/SCons/Tool/__init__.py @@ -202,7 +202,7 @@ def tool_list(platform, env): other_tools = FindAllTools(['BitKeeper', 'CVS', 'dvipdf', 'dvips', - 'latex', 'lex', + 'latex', 'lex', 'Perforce', 'pdflatex', 'pdftex', 'RCS', 'SCCS', 'Subversion', 'tar', 'tex', 'yacc'], env) diff --git a/test/Perforce.py b/test/Perforce.py new file mode 100644 index 0000000..5808b23 --- /dev/null +++ b/test/Perforce.py @@ -0,0 +1,190 @@ +#!/usr/bin/env python +# +# __COPYRIGHT__ +# +# Permission is hereby granted, free of charge, to any person obtaining +# a copy of this software and associated documentation files (the +# "Software"), to deal in the Software without restriction, including +# without limitation the rights to use, copy, modify, merge, publish, +# distribute, sublicense, and/or sell copies of the Software, and to +# permit persons to whom the Software is furnished to do so, subject to +# the following conditions: +# +# The above copyright notice and this permission notice shall be included +# in all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY +# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE +# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +# + +__revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__" + +""" +Test fetching source files from Perforce. + +This test requires that a Perforce server be running on the test system +on port 1666, as well as that of course a client must be present. +""" + +import os +import socket +import string + +import TestSCons + +test = TestSCons.TestSCons() + +p4 = test.where_is('p4') +if not p4: + print "Could not find Perforce, skipping test(s)." + test.pass_test(1) + +user = os.environ.get('USER') +if not user: + user = os.environ.get('USERNAME') +if not user: + user = os.environ.get('P4USER') + +host = socket.gethostname() + +# clean out everything +try: + test.run(program=p4, arguments='-p 1666 obliterate -y //testme/...') + test.run(program=p4, arguments='-p 1666 depot -d testme') +except TestSCons.TestFailed: + pass # it's okay if this fails...it will fail if the depot is clear already. + +# Set up a perforce depot for testing. +test.write("depotspec","""# A Perforce Depot Specification. +Depot: testme + +Owner: %s + +Date: 2003/02/19 17:21:41 + +Description: + A test depot. + +Type: local + +Address: subdir + +Map: testme/... +""" % user) + +test.run(program=p4, arguments='-p 1666 depot -i < depotspec') + +# Now set up 2 clients, one to check in some files, and one to +# do the building. +clientspec = """# A Perforce Client Specification. +Client: %s + +Owner: %s + +Host: %s + +Description: + Created by ccrain. + +Root: %s + +Options: noallwrite noclobber nocompress unlocked nomodtime normdir + +LineEnd: local + +View: + %s //%s/... +""" + +clientspec1 = clientspec % ("testclient1", user, host, test.workpath('import'), + "//testme/foo/...", "testclient1") +clientspec2 = clientspec % ("testclient2", user, host, test.workpath('work'), + "//testme/...", "testclient2") +test.write("testclient1", clientspec1) +test.write("testclient2", clientspec2) + +test.subdir('import', ['import', 'sub'], 'work') + +test.run(program=p4, arguments = '-p 1666 client -i < testclient1') +test.run(program=p4, arguments = '-p 1666 client -i < testclient2') + +test.write(['import', 'aaa.in'], "import/aaa.in\n") +test.write(['import', 'bbb.in'], "import/bbb.in\n") +test.write(['import', 'ccc.in'], "import/ccc.in\n") + +test.write(['import', 'sub', 'SConscript'], """ +Import("env") +env.Cat('ddd.out', 'ddd.in') +env.Cat('eee.out', 'eee.in') +env.Cat('fff.out', 'fff.in') +env.Cat('all', ['ddd.out', 'eee.out', 'fff.out']) +""") + +test.write(['import', 'sub', 'ddd.in'], "import/sub/ddd.in\n") +test.write(['import', 'sub', 'eee.in'], "import/sub/eee.in\n") +test.write(['import', 'sub', 'fff.in'], "import/sub/fff.in\n") + +# Perforce uses the PWD environment variable in preference to the actual cwd +os.environ["PWD"] = test.workpath('import') +paths = map(os.path.normpath, [ 'sub/ddd.in', 'sub/eee.in', 'sub/fff.in', 'sub/SConscript' ]) +args = '-p 1666 -c testclient1 add -t binary *.in %s' % string.join(paths) +test.run(program=p4, chdir='import', arguments=args) + +test.write('changespec', """ +Change: new + +Client: testclient1 + +User: %s + +Status: new + +Description: + A test check in + +Files: + //testme/foo/aaa.in # add + //testme/foo/bbb.in # add + //testme/foo/ccc.in # add + //testme/foo/sub/SConscript # add + //testme/foo/sub/ddd.in # add + //testme/foo/sub/eee.in # add + //testme/foo/sub/fff.in # add +""" % user) + +test.run(program=p4, arguments='-p 1666 -c testclient1 submit -i < changespec') + +test.write(['work', 'SConstruct'], """ +def cat(env, source, target): + target = str(target[0]) + source = map(str, source) + f = open(target, "wb") + for src in source: + f.write(open(src, "rb").read()) + f.close() +env = Environment(BUILDERS={'Cat':Builder(action=cat)}, + P4FLAGS='-p 1666 -c testclient2') +env.Cat('aaa.out', 'foo/aaa.in') +env.Cat('bbb.out', 'foo/bbb.in') +env.Cat('ccc.out', 'foo/ccc.in') +env.Cat('all', ['aaa.out', 'bbb.out', 'ccc.out']) +env.SourceCode('.', env.Perforce()) +SConscript('foo/sub/SConscript', 'env') +""") + +test.subdir(['work', 'foo']) +test.write(['work', 'foo', 'bbb.in'], "work/foo/bbb.in\n") + +test.subdir(['work', 'foo', 'sub']) +test.write(['work', 'foo', 'sub', 'eee.in'], "work/foo/sub/eee.in\n") + +test.run(chdir = 'work', arguments = '.') +test.fail_test(test.read(['work', 'all']) != "import/aaa.in\nwork/foo/bbb.in\nimport/ccc.in\n") +test.fail_test(test.read(['work', 'foo', 'sub', 'all']) != "import/sub/ddd.in\nwork/foo/sub/eee.in\nimport/sub/fff.in\n") + +test.pass_test() -- cgit v0.12