From bbfa4c9b2c1df1471b48bed5a130d1d97aecb82e Mon Sep 17 00:00:00 2001 From: Kevin Sawicki Date: Mon, 19 Mar 2012 22:00:49 -0700 Subject: [PATCH] Ignore trailing comments in transport SPI parsing Check for a '#' character in each line read and parse the leading characters as the class name of a TransportProtocol being registered via SPI. Bug: 373439 Change-Id: If36cb62c07ecea78ba0f326a87edf1d80b7b42b6 Signed-off-by: Chris Aniszczyk --- .../org.eclipse.jgit.transport.Transport | 7 ++ .../eclipse/jgit/transport/SpiTransport.java | 98 +++++++++++++++++++ .../eclipse/jgit/transport/TransportTest.java | 16 +++ .../org/eclipse/jgit/transport/Transport.java | 11 ++- 4 files changed, 130 insertions(+), 2 deletions(-) create mode 100644 org.eclipse.jgit.test/tst-rsrc/META-INF/services/org.eclipse.jgit.transport.Transport create mode 100644 org.eclipse.jgit.test/tst/org/eclipse/jgit/transport/SpiTransport.java diff --git a/org.eclipse.jgit.test/tst-rsrc/META-INF/services/org.eclipse.jgit.transport.Transport b/org.eclipse.jgit.test/tst-rsrc/META-INF/services/org.eclipse.jgit.transport.Transport new file mode 100644 index 000000000..6019ac6e3 --- /dev/null +++ b/org.eclipse.jgit.test/tst-rsrc/META-INF/services/org.eclipse.jgit.transport.Transport @@ -0,0 +1,7 @@ +# Comment at beginning +org.eclipse.jgit.transport.SpiTransport # spi + # Comment after just whitespace +org.eclipse.jgit.transport.MissingTransport + + + \ No newline at end of file diff --git a/org.eclipse.jgit.test/tst/org/eclipse/jgit/transport/SpiTransport.java b/org.eclipse.jgit.test/tst/org/eclipse/jgit/transport/SpiTransport.java new file mode 100644 index 000000000..bb6c73809 --- /dev/null +++ b/org.eclipse.jgit.test/tst/org/eclipse/jgit/transport/SpiTransport.java @@ -0,0 +1,98 @@ +/* + * Copyright (C) 2012, GitHub Inc. + * and other copyright owners as documented in the project's IP log. + * + * This program and the accompanying materials are made available + * under the terms of the Eclipse Distribution License v1.0 which + * accompanies this distribution, is reproduced below, and is + * available at http://www.eclipse.org/org/documents/edl-v10.php + * + * 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. + * + * - Neither the name of the Eclipse Foundation, Inc. nor the + * names of its contributors may be used to endorse or promote + * products derived from this software without specific prior + * written permission. + * + * 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. + */ +package org.eclipse.jgit.transport; + +import java.util.Collections; +import java.util.Set; + +import org.eclipse.jgit.errors.NotSupportedException; +import org.eclipse.jgit.errors.TransportException; +import org.eclipse.jgit.lib.Repository; + +/** + * Transport protocol contributed via service provider + */ +public class SpiTransport extends Transport { + + /** + * Transport protocol scheme + */ + public static final String SCHEME = "testspi"; + + /** + * Instance + */ + public static final TransportProtocol PROTO = new TransportProtocol() { + + public String getName() { + return "Test SPI Transport Protocol"; + } + + public Set getSchemes() { + return Collections.singleton(SCHEME); + } + + public Transport open(URIish uri, Repository local, String remoteName) + throws NotSupportedException, TransportException { + throw new NotSupportedException("not supported"); + } + }; + + private SpiTransport(Repository local, URIish uri) { + super(local, uri); + } + + public FetchConnection openFetch() throws NotSupportedException, + TransportException { + throw new NotSupportedException("not supported"); + } + + public PushConnection openPush() throws NotSupportedException, + TransportException { + throw new NotSupportedException("not supported"); + } + + public void close() { + // Intentionally left blank + } +} diff --git a/org.eclipse.jgit.test/tst/org/eclipse/jgit/transport/TransportTest.java b/org.eclipse.jgit.test/tst/org/eclipse/jgit/transport/TransportTest.java index 1233d699f..07ef39dc7 100644 --- a/org.eclipse.jgit.test/tst/org/eclipse/jgit/transport/TransportTest.java +++ b/org.eclipse.jgit.test/tst/org/eclipse/jgit/transport/TransportTest.java @@ -45,6 +45,7 @@ package org.eclipse.jgit.transport; import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertNotNull; import static org.junit.Assert.assertNull; import static org.junit.Assert.assertTrue; @@ -52,6 +53,7 @@ import java.io.IOException; import java.util.Arrays; import java.util.Collection; import java.util.Collections; +import java.util.List; import org.eclipse.jgit.lib.Config; import org.eclipse.jgit.lib.SampleDataRepositoryTestCase; @@ -209,4 +211,18 @@ public class TransportTest extends SampleDataRepositoryTestCase { assertEquals(db.resolve("refs/heads/a"), tru.getNewObjectId()); assertNull(tru.getOldObjectId()); } + + @Test + public void testSpi() { + List protocols = Transport.getTransportProtocols(); + assertNotNull(protocols); + assertFalse(protocols.isEmpty()); + TransportProtocol found = null; + for (TransportProtocol protocol : protocols) + if (protocol.getSchemes().contains(SpiTransport.SCHEME)) { + found = protocol; + break; + } + assertEquals(SpiTransport.PROTO, found); + } } diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/transport/Transport.java b/org.eclipse.jgit/src/org/eclipse/jgit/transport/Transport.java index 0fa6724bc..90fdf4d9d 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/transport/Transport.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/transport/Transport.java @@ -149,8 +149,15 @@ public abstract class Transport { try { String line; while ((line = br.readLine()) != null) { - if (line.length() > 0 && !line.startsWith("#")) - load(ldr, line); + line = line.trim(); + if (line.length() == 0) + continue; + int comment = line.indexOf('#'); + if (comment == 0) + continue; + if (comment != -1) + line = line.substring(0, comment).trim(); + load(ldr, line); } } catch (IOException err) { // If we failed during a read, ignore the error.