From 77ce77d342da02eac9e8f6232da3bcf6dafbc3f0 Mon Sep 17 00:00:00 2001 From: Lukasz Lenart Date: Tue, 31 Jul 2012 20:38:52 +0000 Subject: [PATCH] Solves problem with rest-showcase app and adds additional test to proof how excludePackages works git-svn-id: https://svn.apache.org/repos/asf/struts/struts2/trunk@1367763 13f79535-47bb-0310-9956-ffa450edef68 --- .../struts2 => demo}/rest/example/Order.java | 2 +- .../rest/example/OrdersController.java | 7 +--- .../rest/example/OrdersService.java | 2 +- .../PackageBasedActionConfigBuilder.java | 31 ++++++++++++++-- .../PackageBasedActionConfigBuilderTest.java | 29 ++++++++++++++- .../actions/exclude/ExcludeAction.java | 35 +++++++++++++++++++ 6 files changed, 94 insertions(+), 12 deletions(-) rename apps/rest-showcase/src/main/java/org/{apache/struts2 => demo}/rest/example/Order.java (97%) rename apps/rest-showcase/src/main/java/org/{apache/struts2 => demo}/rest/example/OrdersController.java (87%) rename apps/rest-showcase/src/main/java/org/{apache/struts2 => demo}/rest/example/OrdersService.java (94%) create mode 100644 plugins/convention/src/test/java/org/apache/struts2/convention/actions/exclude/ExcludeAction.java diff --git a/apps/rest-showcase/src/main/java/org/apache/struts2/rest/example/Order.java b/apps/rest-showcase/src/main/java/org/demo/rest/example/Order.java similarity index 97% rename from apps/rest-showcase/src/main/java/org/apache/struts2/rest/example/Order.java rename to apps/rest-showcase/src/main/java/org/demo/rest/example/Order.java index 9006c82d3..cc9a66410 100644 --- a/apps/rest-showcase/src/main/java/org/apache/struts2/rest/example/Order.java +++ b/apps/rest-showcase/src/main/java/org/demo/rest/example/Order.java @@ -1,4 +1,4 @@ -package org.apache.struts2.rest.example; +package org.demo.rest.example; public class Order { String id; diff --git a/apps/rest-showcase/src/main/java/org/apache/struts2/rest/example/OrdersController.java b/apps/rest-showcase/src/main/java/org/demo/rest/example/OrdersController.java similarity index 87% rename from apps/rest-showcase/src/main/java/org/apache/struts2/rest/example/OrdersController.java rename to apps/rest-showcase/src/main/java/org/demo/rest/example/OrdersController.java index 0df8494ef..07f0cd10b 100644 --- a/apps/rest-showcase/src/main/java/org/apache/struts2/rest/example/OrdersController.java +++ b/apps/rest-showcase/src/main/java/org/demo/rest/example/OrdersController.java @@ -1,16 +1,11 @@ -package org.apache.struts2.rest.example; +package org.demo.rest.example; import java.util.Collection; -import org.apache.struts2.dispatcher.ServletActionRedirectResult; import org.apache.struts2.rest.DefaultHttpHeaders; import org.apache.struts2.rest.HttpHeaders; import org.apache.struts2.convention.annotation.Results; import org.apache.struts2.convention.annotation.Result; -import org.apache.struts2.convention.annotation.ParentPackage; -import org.apache.struts2.convention.annotation.Namespaces; -import org.apache.struts2.convention.annotation.Namespace; -import org.apache.struts2.convention.annotation.InterceptorRef; import com.opensymphony.xwork2.ModelDriven; import com.opensymphony.xwork2.Validateable; diff --git a/apps/rest-showcase/src/main/java/org/apache/struts2/rest/example/OrdersService.java b/apps/rest-showcase/src/main/java/org/demo/rest/example/OrdersService.java similarity index 94% rename from apps/rest-showcase/src/main/java/org/apache/struts2/rest/example/OrdersService.java rename to apps/rest-showcase/src/main/java/org/demo/rest/example/OrdersService.java index 12bc851a2..1f36aa4e2 100644 --- a/apps/rest-showcase/src/main/java/org/apache/struts2/rest/example/OrdersService.java +++ b/apps/rest-showcase/src/main/java/org/demo/rest/example/OrdersService.java @@ -1,4 +1,4 @@ -package org.apache.struts2.rest.example; +package org.demo.rest.example; import java.util.*; diff --git a/plugins/convention/src/main/java/org/apache/struts2/convention/PackageBasedActionConfigBuilder.java b/plugins/convention/src/main/java/org/apache/struts2/convention/PackageBasedActionConfigBuilder.java index 77a75605d..a75393aff 100644 --- a/plugins/convention/src/main/java/org/apache/struts2/convention/PackageBasedActionConfigBuilder.java +++ b/plugins/convention/src/main/java/org/apache/struts2/convention/PackageBasedActionConfigBuilder.java @@ -492,9 +492,17 @@ public class PackageBasedActionConfigBuilder implements ActionConfigBuilder { * package-based action scan */ protected boolean includeClassNameInActionScan(String className) { - String classPackageName = StringUtils.substringBeforeLast(className, "."); + return (checkActionPackages(classPackageName) || checkPackageLocators(classPackageName)) && checkExcludePackages(classPackageName); + } + /** + * Checks if provided class package is on the exclude list + * + * @param classPackageName name of class package + * @return false if class package is on the {@link #excludePackages} list + */ + protected boolean checkExcludePackages(String classPackageName) { if(excludePackages != null && excludePackages.length > 0) { WildcardHelper wildcardHelper = new WildcardHelper(); @@ -508,7 +516,16 @@ public class PackageBasedActionConfigBuilder implements ActionConfigBuilder { } } } + return true; + } + /** + * Checks if class package match provided list of action packages + * + * @param classPackageName name of class package + * @return true if class package is on the {@link #actionPackages} list + */ + protected boolean checkActionPackages(String classPackageName) { if (actionPackages != null) { for (String packageName : actionPackages) { String strictPackageName = packageName + "."; @@ -517,7 +534,16 @@ public class PackageBasedActionConfigBuilder implements ActionConfigBuilder { return true; } } + return false; + } + /** + * Checks if class package match provided list of package locators + * + * @param classPackageName name of class package + * @return true if class package is on the {@link #packageLocators} list + */ + protected boolean checkPackageLocators(String classPackageName) { if (packageLocators != null && !disablePackageLocatorsScanning) { for (String packageLocator : packageLocators) { if (classPackageName.length() > 0 @@ -530,10 +556,9 @@ public class PackageBasedActionConfigBuilder implements ActionConfigBuilder { } } } - return false; } - + /** * Construct a {@link Test} object that determines if a specified class name * should be included in the package scan based on the clazz's package name. diff --git a/plugins/convention/src/test/java/org/apache/struts2/convention/PackageBasedActionConfigBuilderTest.java b/plugins/convention/src/test/java/org/apache/struts2/convention/PackageBasedActionConfigBuilderTest.java index 183daf67c..45baad20b 100644 --- a/plugins/convention/src/test/java/org/apache/struts2/convention/PackageBasedActionConfigBuilderTest.java +++ b/plugins/convention/src/test/java/org/apache/struts2/convention/PackageBasedActionConfigBuilderTest.java @@ -60,6 +60,7 @@ import org.apache.struts2.convention.actions.chain.ChainedAction; import org.apache.struts2.convention.actions.defaultinterceptor.SingleActionNameAction2; import org.apache.struts2.convention.actions.exception.ExceptionsActionLevelAction; import org.apache.struts2.convention.actions.exception.ExceptionsMethodLevelAction; +import org.apache.struts2.convention.actions.exclude.ExcludeAction; import org.apache.struts2.convention.actions.interceptor.ActionLevelInterceptor2Action; import org.apache.struts2.convention.actions.interceptor.ActionLevelInterceptor3Action; import org.apache.struts2.convention.actions.interceptor.ActionLevelInterceptorAction; @@ -133,6 +134,10 @@ public class PackageBasedActionConfigBuilderTest extends TestCase { run(null, "actions", "dontfind"); } + public void testJustExcludedPackages() throws MalformedURLException { + run("org.apache.struts2.convention.actions", null, "org.apache.struts2.convention.actions.exclude"); + } + private void run(String actionPackages, String packageLocators, String excludePackages) throws MalformedURLException { //setup interceptors List defaultInterceptors = new ArrayList(); @@ -208,6 +213,8 @@ public class PackageBasedActionConfigBuilderTest extends TestCase { "/chain", strutsDefault, null); PackageConfig transPkg = makePackageConfig("org.apache.struts2.convention.actions.transactions#struts-default#/transactions", "/transactions", strutsDefault, null); + PackageConfig excludePkg = makePackageConfig("org.apache.struts2.convention.actions.exclude#struts-default#/exclude", + "/exclude", strutsDefault, null); ResultMapBuilder resultMapBuilder = createStrictMock(ResultMapBuilder.class); checkOrder(resultMapBuilder, false); @@ -312,6 +319,12 @@ public class PackageBasedActionConfigBuilderTest extends TestCase { expect(resultMapBuilder.build(TransNameAction.class, getAnnotation(TransNameAction.class, "trans1", Action.class), "trans1", transPkg)).andReturn(results); expect(resultMapBuilder.build(TransNameAction.class, getAnnotation(TransNameAction.class, "trans2", Action.class), "trans2", transPkg)).andReturn(results); + /* org.apache.struts2.convention.actions.exclude */ + // this is only expected when excludePackages was specified with org.apache.struts2.convention.actions.exclude package + if (excludePackages == null || !excludePackages.contains("org.apache.struts2.convention.actions.exclude")) { + expect(resultMapBuilder.build(ExcludeAction.class, getAnnotation(ExcludeAction.class, "run1", Action.class), "exclude1", excludePkg)).andReturn(results); + } + EasyMock.replay(resultMapBuilder); final DummyContainer mockContainer = new DummyContainer(); @@ -567,7 +580,7 @@ public class PackageBasedActionConfigBuilderTest extends TestCase { /* org.apache.struts2.convention.actions */ pkgConfig = configuration.getPackageConfig("org.apache.struts2.convention.actions#struts-default#"); assertNotNull(pkgConfig); - System.out.println("actions " + pkgConfig.getActionConfigs()); + assertEquals(4, pkgConfig.getActionConfigs().size()); verifyActionConfig(pkgConfig, "no-annotation", NoAnnotationAction.class, "execute", pkgConfig.getName()); verifyActionConfig(pkgConfig, "default-result-path", DefaultResultPathAction.class, "execute", pkgConfig.getName()); @@ -580,6 +593,14 @@ public class PackageBasedActionConfigBuilderTest extends TestCase { verifyActionConfig(pkgConfig, "trans1", TransNameAction.class, "trans1", pkgConfig.getName()); verifyActionConfig(pkgConfig, "trans2", TransNameAction.class, "trans2", pkgConfig.getName()); + /* org.apache.struts2.convention.actions.exclude */ + pkgConfig = configuration.getPackageConfig("org.apache.struts2.convention.actions.exclude#struts-default#/exclude"); + if (excludePackages != null && excludePackages.contains("org.apache.struts2.convention.actions.exclude")) { + verifyMissingActionConfig(configuration, "exclude1", ExcludeAction.class, "run1", "org.apache.struts2.convention.actions.exclude#struts-default#/exclude"); + } else { + verifyActionConfig(pkgConfig, "exclude1", ExcludeAction.class, "run1", pkgConfig.getName()); + } + //test unknown handler automatic chaining pkgConfig = configuration.getPackageConfig("org.apache.struts2.convention.actions.chain#struts-default#/chain"); ServletContext context = EasyMock.createNiceMock(ServletContext.class); @@ -606,6 +627,12 @@ public class PackageBasedActionConfigBuilderTest extends TestCase { assertEquals(packageName, ac.getPackageName()); } + private void verifyMissingActionConfig(Configuration configuration, String actionName, Class actionClass, + String methodName, String packageName) { + assertNull(configuration.getPackageConfig(packageName)); + assertFalse(configuration.getPackageConfigNames().contains(packageName)); + } + private void verifyMissingActionConfig(PackageConfig pkgConfig, String actionName, Class actionClass, String methodName, String packageName) { ActionConfig ac = pkgConfig.getAllActionConfigs().get(actionName); diff --git a/plugins/convention/src/test/java/org/apache/struts2/convention/actions/exclude/ExcludeAction.java b/plugins/convention/src/test/java/org/apache/struts2/convention/actions/exclude/ExcludeAction.java new file mode 100644 index 000000000..f4d1607ac --- /dev/null +++ b/plugins/convention/src/test/java/org/apache/struts2/convention/actions/exclude/ExcludeAction.java @@ -0,0 +1,35 @@ +/* + * $Id$ + * + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.apache.struts2.convention.actions.exclude; + +import org.apache.struts2.convention.annotation.Action; + +/** + *

+ * This is a test action. + *

+ */ +public class ExcludeAction { + @Action("exclude1") + public String run1() { + return null; + } +} \ No newline at end of file