Skip to content

Commit

Permalink
484349 - Promote WebSocket PathMappings / PathSpec to Jetty Http
Browse files Browse the repository at this point in the history 
+ More testing, more improvements
  • Loading branch information
@joakime
joakime committed Dec 16, 2015
1 parent 4f9d785 commit e6901b2
Show file tree
Hide file tree
Showing 7 changed files with 57 additions and 82 deletions.
20 changes: 17 additions & 3 deletions jetty-http/src/main/java/org/eclipse/jetty/http/pathmap/PathMappings.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ public class PathMappings<E> implements Iterable<MappedResource<E>>, Dumpable
private static final Logger LOG = Log.getLogger(PathMappings.class);
private List<MappedResource<E>> mappings = new ArrayList<MappedResource<E>>();
private MappedResource<E> defaultResource = null;
private MappedResource<E> rootResource = null;

@Override
public String dump()
Expand Down Expand Up @@ -105,6 +106,11 @@ public List<MappedResource<E>> getMatches(String path)

public MappedResource<E> getMatch(String path)
{
if (path.equals("/") && rootResource != null)
{
return rootResource;
}

int len = mappings.size();
for (int i = 0; i < len; i++)
{
Expand All @@ -123,14 +129,22 @@ public Iterator<MappedResource<E>> iterator()
return mappings.iterator();
}

@SuppressWarnings("incomplete-switch")
public void put(PathSpec pathSpec, E resource)
{
MappedResource<E> entry = new MappedResource<>(pathSpec,resource);
if (pathSpec.group == PathSpecGroup.DEFAULT)
switch (pathSpec.group)
{
defaultResource = entry;
case DEFAULT:
defaultResource = entry;
break;
case ROOT:
rootResource = entry;
break;
}
// TODO: warning on replacement of existing mapping?

// TODO: add warning when replacing an existing pathspec?

mappings.add(entry);
if (LOG.isDebugEnabled())
LOG.debug("Added {} to {}",entry,this);
Expand Down
2 changes: 1 addition & 1 deletion jetty-http/src/main/java/org/eclipse/jetty/http/pathmap/PathSpec.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ public int getPathDepth()
*
* @return the as-provided path spec
*/
public String getPathSpec()
public String getDeclaration()
{
return pathSpec;
}
Expand Down
2 changes: 1 addition & 1 deletion jetty-http/src/main/java/org/eclipse/jetty/http/pathmap/ServletPathSpec.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,7 @@ public boolean matches(String path)
case EXACT:
return pathSpec.equals(path);
case PREFIX_GLOB:
return (!"/".equals(path) && isWildcardMatch(path));
return isWildcardMatch(path);
case SUFFIX_GLOB:
return path.regionMatches((path.length() - specLength) + 1,pathSpec,1,specLength - 1);
case ROOT:
Expand Down
57 changes: 9 additions & 48 deletions jetty-http/src/test/java/org/eclipse/jetty/http/pathmap/PathMappingsTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,61 +77,22 @@ public void testMixedMatchOrder()
assertMatch(p,"/animal/fish/trout/cam","animalCam");
assertMatch(p,"/entrance/cam","entranceCam");
}

/**
* Test the match order rules imposed by the Servlet API.
* <p>
* <ul>
* <li>Exact match</li>
* <li>Longest prefix match</li>
* <li>Longest suffix match</li>
* <li>default</li>
* </ul>
* Test the match order rules imposed by the Servlet API (default vs any)
*/
@Test
public void testServletMatchOrder()
public void testServletMatchDefault()
{
PathMappings<String> p = new PathMappings<>();

p.put(new ServletPathSpec("/abs/path"),"abspath"); // 1
p.put(new ServletPathSpec("/abs/path/longer"),"longpath"); // 2
p.put(new ServletPathSpec("/animal/bird/*"),"birds"); // 3
p.put(new ServletPathSpec("/animal/fish/*"),"fishes"); // 4
p.put(new ServletPathSpec("/animal/*"),"animals"); // 5
p.put(new ServletPathSpec("*.tar.gz"),"tarball"); // 6
p.put(new ServletPathSpec("*.gz"),"gzipped"); // 7
p.put(new ServletPathSpec("/"),"default"); // 8
// 9 was the old Jetty ":" spec delimited case (no longer valid)
p.put(new ServletPathSpec(""),"root"); // 10
p.put(new ServletPathSpec("/\u20ACuro/*"),"money"); // 11

// dumpMappings(p);
p.put(new ServletPathSpec("/"),"default");
p.put(new ServletPathSpec("/*"),"any");

// From old PathMapTest
assertMatch(p,"/abs/path","abspath");
assertMatch(p,"/abs/path/xxx","default");
assertMatch(p,"/abs/pith","default");
assertMatch(p,"/abs/path/longer","longpath");
assertMatch(p,"/abs/path/","default");
assertMatch(p,"/abs/path/foo","default");
assertMatch(p,"/animal/bird/eagle/bald","birds");
assertMatch(p,"/animal/fish/shark/hammerhead","fishes");
assertMatch(p,"/animal/insect/ladybug","animals");
assertMatch(p,"/animal","animals");
assertMatch(p,"/animal/","animals");
assertMatch(p,"/animal/other","animals");
assertMatch(p,"/animal/*","animals");
assertMatch(p,"/downloads/distribution.tar.gz","tarball");
assertMatch(p,"/downloads/script.gz","gzipped");
assertMatch(p,"/animal/arhive.gz","animals");
assertMatch(p,"/Other/path","default");
assertMatch(p,"/\u20ACuro/path","money");
assertMatch(p,"/","root");

// Extra tests
assertMatch(p,"/downloads/readme.txt","default");
assertMatch(p,"/downloads/logs.tgz","default");
assertMatch(p,"/main.css","default");
assertMatch(p,"/abs/path","any");
assertMatch(p,"/abs/path/xxx","any");
assertMatch(p,"/animal/bird/eagle/bald","any");
assertMatch(p,"/","any");
}

/**
Expand Down
14 changes: 7 additions & 7 deletions jetty-http/src/test/java/org/eclipse/jetty/http/pathmap/RegexPathSpecTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,21 +28,21 @@ public class RegexPathSpecTest
{
public static void assertMatches(PathSpec spec, String path)
{
String msg = String.format("Spec(\"%s\").matches(\"%s\")",spec.getPathSpec(),path);
String msg = String.format("Spec(\"%s\").matches(\"%s\")",spec.getDeclaration(),path);
assertThat(msg,spec.matches(path),is(true));
}

public static void assertNotMatches(PathSpec spec, String path)
{
String msg = String.format("!Spec(\"%s\").matches(\"%s\")",spec.getPathSpec(),path);
String msg = String.format("!Spec(\"%s\").matches(\"%s\")",spec.getDeclaration(),path);
assertThat(msg,spec.matches(path),is(false));
}

@Test
public void testExactSpec()
{
RegexPathSpec spec = new RegexPathSpec("^/a$");
assertEquals("Spec.pathSpec","^/a$",spec.getPathSpec());
assertEquals("Spec.pathSpec","^/a$",spec.getDeclaration());
assertEquals("Spec.pattern","^/a$",spec.getPattern().pattern());
assertEquals("Spec.pathDepth",1,spec.getPathDepth());
assertEquals("Spec.group",PathSpecGroup.EXACT,spec.group);
Expand All @@ -57,7 +57,7 @@ public void testExactSpec()
public void testMiddleSpec()
{
RegexPathSpec spec = new RegexPathSpec("^/rest/([^/]*)/list$");
assertEquals("Spec.pathSpec","^/rest/([^/]*)/list$",spec.getPathSpec());
assertEquals("Spec.pathSpec","^/rest/([^/]*)/list$",spec.getDeclaration());
assertEquals("Spec.pattern","^/rest/([^/]*)/list$",spec.getPattern().pattern());
assertEquals("Spec.pathDepth",3,spec.getPathDepth());
assertEquals("Spec.group",PathSpecGroup.MIDDLE_GLOB,spec.group);
Expand All @@ -78,7 +78,7 @@ public void testMiddleSpec()
public void testMiddleSpecNoGrouping()
{
RegexPathSpec spec = new RegexPathSpec("^/rest/[^/]+/list$");
assertEquals("Spec.pathSpec","^/rest/[^/]+/list$",spec.getPathSpec());
assertEquals("Spec.pathSpec","^/rest/[^/]+/list$",spec.getDeclaration());
assertEquals("Spec.pattern","^/rest/[^/]+/list$",spec.getPattern().pattern());
assertEquals("Spec.pathDepth",3,spec.getPathDepth());
assertEquals("Spec.group",PathSpecGroup.MIDDLE_GLOB,spec.group);
Expand All @@ -99,7 +99,7 @@ public void testMiddleSpecNoGrouping()
public void testPrefixSpec()
{
RegexPathSpec spec = new RegexPathSpec("^/a/(.*)$");
assertEquals("Spec.pathSpec","^/a/(.*)$",spec.getPathSpec());
assertEquals("Spec.pathSpec","^/a/(.*)$",spec.getDeclaration());
assertEquals("Spec.pattern","^/a/(.*)$",spec.getPattern().pattern());
assertEquals("Spec.pathDepth",2,spec.getPathDepth());
assertEquals("Spec.group",PathSpecGroup.PREFIX_GLOB,spec.group);
Expand All @@ -117,7 +117,7 @@ public void testPrefixSpec()
public void testSuffixSpec()
{
RegexPathSpec spec = new RegexPathSpec("^(.*).do$");
assertEquals("Spec.pathSpec","^(.*).do$",spec.getPathSpec());
assertEquals("Spec.pathSpec","^(.*).do$",spec.getDeclaration());
assertEquals("Spec.pattern","^(.*).do$",spec.getPattern().pattern());
assertEquals("Spec.pathDepth",0,spec.getPathDepth());
assertEquals("Spec.group",PathSpecGroup.SUFFIX_GLOB,spec.group);
Expand Down
16 changes: 8 additions & 8 deletions jetty-http/src/test/java/org/eclipse/jetty/http/pathmap/ServletPathSpecTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,13 @@ private void assertBadServletPathSpec(String pathSpec)

private void assertMatches(ServletPathSpec spec, String path)
{
String msg = String.format("Spec(\"%s\").matches(\"%s\")",spec.getPathSpec(),path);
String msg = String.format("Spec(\"%s\").matches(\"%s\")",spec.getDeclaration(),path);
assertThat(msg,spec.matches(path),is(true));
}

private void assertNotMatches(ServletPathSpec spec, String path)
{
String msg = String.format("!Spec(\"%s\").matches(\"%s\")",spec.getPathSpec(),path);
String msg = String.format("!Spec(\"%s\").matches(\"%s\")",spec.getDeclaration(),path);
assertThat(msg,spec.matches(path),is(false));
}

Expand Down Expand Up @@ -87,15 +87,15 @@ public void testBadServletPathSpecE()
public void testDefaultPathSpec()
{
ServletPathSpec spec = new ServletPathSpec("/");
assertEquals("Spec.pathSpec","/",spec.getPathSpec());
assertEquals("Spec.pathSpec","/",spec.getDeclaration());
assertEquals("Spec.pathDepth",-1,spec.getPathDepth());
}

@Test
public void testExactPathSpec()
{
ServletPathSpec spec = new ServletPathSpec("/abs/path");
assertEquals("Spec.pathSpec","/abs/path",spec.getPathSpec());
assertEquals("Spec.pathSpec","/abs/path",spec.getDeclaration());
assertEquals("Spec.pathDepth",2,spec.getPathDepth());

assertMatches(spec,"/abs/path");
Expand Down Expand Up @@ -125,15 +125,15 @@ public void testGetPathInfo()
public void testNullPathSpec()
{
ServletPathSpec spec = new ServletPathSpec(null);
assertEquals("Spec.pathSpec","",spec.getPathSpec());
assertEquals("Spec.pathSpec","",spec.getDeclaration());
assertEquals("Spec.pathDepth",-1,spec.getPathDepth());
}

@Test
public void testRootPathSpec()
{
ServletPathSpec spec = new ServletPathSpec("");
assertEquals("Spec.pathSpec","",spec.getPathSpec());
assertEquals("Spec.pathSpec","",spec.getDeclaration());
assertEquals("Spec.pathDepth",-1,spec.getPathDepth());
}

Expand All @@ -154,7 +154,7 @@ public void testPathMatch()
public void testPrefixPathSpec()
{
ServletPathSpec spec = new ServletPathSpec("/downloads/*");
assertEquals("Spec.pathSpec","/downloads/*",spec.getPathSpec());
assertEquals("Spec.pathSpec","/downloads/*",spec.getDeclaration());
assertEquals("Spec.pathDepth",2,spec.getPathDepth());

assertMatches(spec,"/downloads/logo.jpg");
Expand All @@ -173,7 +173,7 @@ public void testPrefixPathSpec()
public void testSuffixPathSpec()
{
ServletPathSpec spec = new ServletPathSpec("*.gz");
assertEquals("Spec.pathSpec","*.gz",spec.getPathSpec());
assertEquals("Spec.pathSpec","*.gz",spec.getDeclaration());
assertEquals("Spec.pathDepth",0,spec.getPathDepth());

assertMatches(spec,"/downloads/distribution.tar.gz");
Expand Down
28 changes: 14 additions & 14 deletions jetty-http/src/test/java/org/eclipse/jetty/http/pathmap/UriTemplatePathSpecTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ public class UriTemplatePathSpecTest
{
private void assertDetectedVars(UriTemplatePathSpec spec, String... expectedVars)
{
String prefix = String.format("Spec(\"%s\")",spec.getPathSpec());
String prefix = String.format("Spec(\"%s\")",spec.getDeclaration());
assertEquals(prefix + ".variableCount",expectedVars.length,spec.getVariableCount());
assertEquals(prefix + ".variable.length",expectedVars.length,spec.getVariables().length);
for (int i = 0; i < expectedVars.length; i++)
Expand All @@ -45,21 +45,21 @@ private void assertDetectedVars(UriTemplatePathSpec spec, String... expectedVars

private void assertMatches(PathSpec spec, String path)
{
String msg = String.format("Spec(\"%s\").matches(\"%s\")",spec.getPathSpec(),path);
String msg = String.format("Spec(\"%s\").matches(\"%s\")",spec.getDeclaration(),path);
assertThat(msg,spec.matches(path),is(true));
}

private void assertNotMatches(PathSpec spec, String path)
{
String msg = String.format("!Spec(\"%s\").matches(\"%s\")",spec.getPathSpec(),path);
String msg = String.format("!Spec(\"%s\").matches(\"%s\")",spec.getDeclaration(),path);
assertThat(msg,spec.matches(path),is(false));
}

@Test
public void testDefaultPathSpec()
{
UriTemplatePathSpec spec = new UriTemplatePathSpec("/");
assertEquals("Spec.pathSpec","/",spec.getPathSpec());
assertEquals("Spec.pathSpec","/",spec.getDeclaration());
assertEquals("Spec.pattern","^/$",spec.getPattern().pattern());
assertEquals("Spec.pathDepth",1,spec.getPathDepth());
assertEquals("Spec.group",PathSpecGroup.EXACT,spec.getGroup());
Expand All @@ -72,7 +72,7 @@ public void testDefaultPathSpec()
public void testExactOnePathSpec()
{
UriTemplatePathSpec spec = new UriTemplatePathSpec("/a");
assertEquals("Spec.pathSpec","/a",spec.getPathSpec());
assertEquals("Spec.pathSpec","/a",spec.getDeclaration());
assertEquals("Spec.pattern","^/a$",spec.getPattern().pattern());
assertEquals("Spec.pathDepth",1,spec.getPathDepth());
assertEquals("Spec.group",PathSpecGroup.EXACT,spec.getGroup());
Expand All @@ -90,7 +90,7 @@ public void testExactOnePathSpec()
public void testExactPathSpec_TestWebapp()
{
UriTemplatePathSpec spec = new UriTemplatePathSpec("/deep.thought/");
assertEquals("Spec.pathSpec","/deep.thought/",spec.getPathSpec());
assertEquals("Spec.pathSpec","/deep.thought/",spec.getDeclaration());
assertEquals("Spec.pattern","^/deep\\.thought/$",spec.getPattern().pattern());
assertEquals("Spec.pathDepth",1,spec.getPathDepth());
assertEquals("Spec.group",PathSpecGroup.EXACT,spec.getGroup());
Expand All @@ -106,7 +106,7 @@ public void testExactPathSpec_TestWebapp()
public void testExactTwoPathSpec()
{
UriTemplatePathSpec spec = new UriTemplatePathSpec("/a/b");
assertEquals("Spec.pathSpec","/a/b",spec.getPathSpec());
assertEquals("Spec.pathSpec","/a/b",spec.getDeclaration());
assertEquals("Spec.pattern","^/a/b$",spec.getPattern().pattern());
assertEquals("Spec.pathDepth",2,spec.getPathDepth());
assertEquals("Spec.group",PathSpecGroup.EXACT,spec.getGroup());
Expand All @@ -125,7 +125,7 @@ public void testExactTwoPathSpec()
public void testMiddleVarPathSpec()
{
UriTemplatePathSpec spec = new UriTemplatePathSpec("/a/{var}/c");
assertEquals("Spec.pathSpec","/a/{var}/c",spec.getPathSpec());
assertEquals("Spec.pathSpec","/a/{var}/c",spec.getDeclaration());
assertEquals("Spec.pattern","^/a/([^/]+)/c$",spec.getPattern().pattern());
assertEquals("Spec.pathDepth",3,spec.getPathDepth());
assertEquals("Spec.group",PathSpecGroup.MIDDLE_GLOB,spec.getGroup());
Expand All @@ -149,7 +149,7 @@ public void testMiddleVarPathSpec()
public void testOneVarPathSpec()
{
UriTemplatePathSpec spec = new UriTemplatePathSpec("/a/{foo}");
assertEquals("Spec.pathSpec","/a/{foo}",spec.getPathSpec());
assertEquals("Spec.pathSpec","/a/{foo}",spec.getDeclaration());
assertEquals("Spec.pattern","^/a/([^/]+)$",spec.getPattern().pattern());
assertEquals("Spec.pathDepth",2,spec.getPathDepth());
assertEquals("Spec.group",PathSpecGroup.PREFIX_GLOB,spec.getGroup());
Expand All @@ -170,7 +170,7 @@ public void testOneVarPathSpec()
public void testOneVarSuffixPathSpec()
{
UriTemplatePathSpec spec = new UriTemplatePathSpec("/{var}/b/c");
assertEquals("Spec.pathSpec","/{var}/b/c",spec.getPathSpec());
assertEquals("Spec.pathSpec","/{var}/b/c",spec.getDeclaration());
assertEquals("Spec.pattern","^/([^/]+)/b/c$",spec.getPattern().pattern());
assertEquals("Spec.pathDepth",3,spec.getPathDepth());
assertEquals("Spec.group",PathSpecGroup.SUFFIX_GLOB,spec.getGroup());
Expand All @@ -194,7 +194,7 @@ public void testOneVarSuffixPathSpec()
public void testTwoVarComplexInnerPathSpec()
{
UriTemplatePathSpec spec = new UriTemplatePathSpec("/a/{var1}/c/{var2}/e");
assertEquals("Spec.pathSpec","/a/{var1}/c/{var2}/e",spec.getPathSpec());
assertEquals("Spec.pathSpec","/a/{var1}/c/{var2}/e",spec.getDeclaration());
assertEquals("Spec.pattern","^/a/([^/]+)/c/([^/]+)/e$",spec.getPattern().pattern());
assertEquals("Spec.pathDepth",5,spec.getPathDepth());
assertEquals("Spec.group",PathSpecGroup.MIDDLE_GLOB,spec.getGroup());
Expand All @@ -217,7 +217,7 @@ public void testTwoVarComplexInnerPathSpec()
public void testTwoVarComplexOuterPathSpec()
{
UriTemplatePathSpec spec = new UriTemplatePathSpec("/{var1}/b/{var2}/{var3}");
assertEquals("Spec.pathSpec","/{var1}/b/{var2}/{var3}",spec.getPathSpec());
assertEquals("Spec.pathSpec","/{var1}/b/{var2}/{var3}",spec.getDeclaration());
assertEquals("Spec.pattern","^/([^/]+)/b/([^/]+)/([^/]+)$",spec.getPattern().pattern());
assertEquals("Spec.pathDepth",4,spec.getPathDepth());
assertEquals("Spec.group",PathSpecGroup.MIDDLE_GLOB,spec.getGroup());
Expand All @@ -241,7 +241,7 @@ public void testTwoVarComplexOuterPathSpec()
public void testTwoVarPrefixPathSpec()
{
UriTemplatePathSpec spec = new UriTemplatePathSpec("/a/{var1}/{var2}");
assertEquals("Spec.pathSpec","/a/{var1}/{var2}",spec.getPathSpec());
assertEquals("Spec.pathSpec","/a/{var1}/{var2}",spec.getDeclaration());
assertEquals("Spec.pattern","^/a/([^/]+)/([^/]+)$",spec.getPattern().pattern());
assertEquals("Spec.pathDepth",3,spec.getPathDepth());
assertEquals("Spec.group",PathSpecGroup.PREFIX_GLOB,spec.getGroup());
Expand All @@ -264,7 +264,7 @@ public void testTwoVarPrefixPathSpec()
public void testVarOnlyPathSpec()
{
UriTemplatePathSpec spec = new UriTemplatePathSpec("/{var1}");
assertEquals("Spec.pathSpec","/{var1}",spec.getPathSpec());
assertEquals("Spec.pathSpec","/{var1}",spec.getDeclaration());
assertEquals("Spec.pattern","^/([^/]+)$",spec.getPattern().pattern());
assertEquals("Spec.pathDepth",1,spec.getPathDepth());
assertEquals("Spec.group",PathSpecGroup.PREFIX_GLOB,spec.getGroup());
Expand Down

0 comments on commit e6901b2

Please sign in to comment.