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 <zx@twitter.com>
This commit is contained in:
Kevin Sawicki 2012-03-19 22:00:49 -07:00 committed by Chris Aniszczyk
parent 7aeea3b27c
commit bbfa4c9b2c
4 changed files with 130 additions and 2 deletions

View File

@ -0,0 +1,7 @@
# Comment at beginning
org.eclipse.jgit.transport.SpiTransport # spi
# Comment after just whitespace
org.eclipse.jgit.transport.MissingTransport

View File

@ -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<String> 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
}
}

View File

@ -45,6 +45,7 @@
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.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 void testFindRemoteRefUpdatesTrackingRef() throws IOException {
assertEquals(db.resolve("refs/heads/a"), tru.getNewObjectId());
assertNull(tru.getOldObjectId());
}
@Test
public void testSpi() {
List<TransportProtocol> 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);
}
}

View File

@ -149,8 +149,15 @@ private static void scan(ClassLoader ldr, URL url) {
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.