java/Integrating Subversion and S 1 Prerequisites 1.1 Subversion You need - to copy __extensions/scripts/scarab-post-commit.py__ into your subversion repository's hooks directory, - python with {link:xmlrpclib|http://www.pythonware.com/products/xmlrpc/} and svn libraries (ie the swig.py bindings), If subversion and scarab will run on seperate machines, you need to: - check the firewall (outbound-traffic) is open to the machine running your scarab installation to the defined xmlrpc port (the default is 12345), 1.1 Scarab If subversion and scarab will run on seperate machines, you need to: - edit __src/conf/conf/componentConfiguration.xml__ so that in <XmlRpcComponent> the element <acceptedClients clientIP="127.0.0.1"/> allows the ipaddress of your subversion machine to connect. (This is also the file to edit if you want to change the port scarab's xmlrpc is running on). Scarab will need to be rebuilt and restarted after these changes, - check the firewall (inbound-traffic) is open from the machine running your subversion installation on the defined xmlrpc port (the default is 12345). 1 Checking Prerequisites * From your subversion repository's hooks directory running the scarab-post-commit.py script should give the output: {code:bash} user@subversion$ ./scarab-post-commit.py Publish Subversion commits into to Scarab. USAGE: ./scarab-post-commit.py REPOS-DIR REVISION {code} If this doesn't work then you need to check the python libraries are installed correctly. * After restarting Scarab, check scarab/logs/scarab.log contains: {code:bash} \[main\] INFO org.tigris.scarab.util.SimpleHandler - SimpleHandler: loading {code} If this is missing, then look closer at the turbine.log to see if the XmlRpc component is being properly initialised. It'll all look something like: {code:bash} \[main\] INFO ...DefaultXmlRpcServerComponent - Attempting to initialize the XML-RPC server. \[main\] INFO ...DefaultXmlRpcServerComponent - We have 1 handlers to configure. \[main\] INFO ...DefaultXmlRpcServerComponent - registered: simple with class: org.tigris.scarab.util.SimpleHandler \[main\] INFO ...DefaultXmlRpcServerComponent - Operating in a state of paranoia \[main\] INFO ...DefaultXmlRpcServerComponent - Accepting client -> 127.0.0.1 {code} If this doesn't help then you will atleast have useful information to post to {mailto:dev@scarab.tigris.org} to get further help with.\\ ~~Note: {note:Or should it be users@scarab.tigris.org ? I've presumed configuring Turbine/Yaafi components within scarab is more dev than user...}~~ 1 Setup The only setup needed, beyond checking the prequisites, is a few variables in the scarab-post-commit.py and finally calling this script from post-commit.sh. 1.1 scarab-post-commit.py variables There are two sections of variables in the beginning of the script, "basic configuration" and "i18n strings". We are only interested in the former, the latter is only when you want to localise the output to another language. 1. {code}VIEWCVS_URL = "http://scarab.tigris.org/source/browse/scarab/" {code} The viewcvs or websvn URL base. The comments posted to scarab contain a list of hyperlinks to the diffs committed in that subversion transaction. This is the base URL prepended to those hyperlinks. 1. {code}SCARAB_XMLRPC_URL = "http://localhost:12345"{code} The address of the scarab machine and port running the xmlrpc service. If scarab and subversion are running on the same machine it is sufficient to use the above. 1. {code}DISABLE_EMAILS = 1{code} Each time a comment is added to an issue in scarab by default an email is sent to everyone associated to the issue. The author of the integration didn't feel it was appropriate that all associated personnel were notified of every commit. Especially since the commit will often be followed by a manual change by the commitor of the status attribute to the issue in question, and associated personnel are more interested in these events. But if this is not the case for you change the variable to __0__.\\ __NOTE__ Only the global setting of email-enabled is checked (and temporarily disabled), so if your modules override this setting emails will continued to be sent. See http://scarab.tigris.org/servlets/ReadMsg?list=dev&msgNo=11971 for more... (This will be fixed in the future). 1.1 Calling scarab-post-commit.py In your subversion repository's hooks directory, append to the file post-commit {code:bash } REPO="$1" REV="$2" # Call Scarab integration cd <your-repository>/hooks/ ./scarab-post-commit.py $REPO $REV >> post-commit.log 2>&1 {code} If the file doesn't exist, create it from a copy of post-commit.tmpl, and remove the last two lines before appending the above.\\ Note: it's important to background the call to scarab-post-commit.py to prevent blocking of subversion while xmlrpc tries to connect and communicates with scarab... 1 When it's working When its working look in target/scarab/logs/scarab.log The output should be similar to {code} 2005-09-03 14:59:31,855 [Thread-9] INFO org.tigris.scarab.util.SimpleHandler - SimpleHandler: addComment: issues=SMBW1657 test commit, user=mick, comment="Subversion commit 6011: h ttp://samboweb/viewcvs/?view=rev&rev=6011 ------------------------------------------------------------------------- SMBW1657 test commit ------------------------------------------------------------------------- Modified: trunk/build.xml h ttp://samboweb/viewcvs/trunk/build.xml?view=diff&rev=6011&p1=trunk/build.xml&r1=6010&p2=trunk/build.xml&r2=6011 , disableEmails=1{code} 1 Subversion -to- Scarab Username mappings This part of the integration is still primitive. By far the best solution is to enforce subversion and scarab usernames are the same, either manually or via using a LDAP service. If this is not the case, the currently primitive solution is to enter the mapping relationships manually into scarab-post-commit.py. An example already exists commented under __"### Do any Subversion-to-Scarab author mappings here ###"__. \\ ~~!! The author would like anyone with python experience to separate this mapping into a separate python script that can be easily called if it is present, so that updating scarab-post-commit.py is less error-prone !! \\ See http://www.solitone.org/scarab/issues/id/SCB1436 for more...~~ 1 Credits The scarab subversion integration was inspired and based upon work originally done by Rob Clark.\\ Next to all of the scarab-post-commit.py was done by C.Michael Pilato, also the author of the subversion-python bindings. 2005-09-07 10:27:22.0 2005-08-30 12:31:36.0