You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jspwiki.apache.org by ju...@apache.org on 2022/03/11 13:43:29 UTC
[jspwiki] 13/15: change calls to Engine#initialize and Engine#shutdown to Engine#start and Engine#stop respectively
This is an automated email from the ASF dual-hosted git repository.
juanpablo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/jspwiki.git
commit 6772e5d017c86a8897ab1f3bc67869446ffb5016
Author: Juan Pablo Santos RodrÃguez <ju...@gmail.com>
AuthorDate: Fri Mar 11 14:41:50 2022 +0100
change calls to Engine#initialize and Engine#shutdown to Engine#start and Engine#stop respectively
---
.../src/main/java/org/apache/wiki/WikiServlet.java | 7 ++-
.../src/test/java/org/apache/wiki/TestEngine.java | 66 ++++++++--------------
.../test/java/org/apache/wiki/WikiEngineTest.java | 2 +-
.../wiki/attachment/AttachmentManagerTest.java | 2 +-
.../org/apache/wiki/content/PageRenamerTest.java | 2 +-
.../apache/wiki/pages/DefaultPageManagerTest.java | 2 +-
.../wiki/parser/JSPWikiMarkupParserTest.java | 2 +-
.../wiki/providers/VersioningFileProviderTest.java | 2 +-
.../wiki/references/ReferenceManagerTest.java | 2 +-
.../apache/wiki/render/RenderingManagerTest.java | 2 +-
.../org/apache/wiki/search/SearchManagerTest.java | 2 +-
.../apache/wiki/stress/MassiveRepositoryTest.java | 2 +-
.../apache/wiki/workflow/WorkflowManagerTest.java | 2 +-
.../org/apache/wiki/xmlrpc/RPCHandlerTest.java | 4 +-
.../wiki/render/markdown/MarkdownRendererTest.java | 2 +-
15 files changed, 43 insertions(+), 58 deletions(-)
diff --git a/jspwiki-main/src/main/java/org/apache/wiki/WikiServlet.java b/jspwiki-main/src/main/java/org/apache/wiki/WikiServlet.java
index 8d8f83f..24793dd 100644
--- a/jspwiki-main/src/main/java/org/apache/wiki/WikiServlet.java
+++ b/jspwiki-main/src/main/java/org/apache/wiki/WikiServlet.java
@@ -21,6 +21,7 @@ package org.apache.wiki;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.apache.wiki.api.core.Engine;
+import org.apache.wiki.api.engine.EngineLifecycleExtension;
import org.apache.wiki.api.spi.Wiki;
import org.apache.wiki.url.URLConstructor;
@@ -57,15 +58,15 @@ public class WikiServlet extends HttpServlet {
/**
* Destroys the WikiServlet; called by the servlet container when shutting down the webapp. This method calls the
- * protected method {@link WikiEngine#shutdown()}, which sends {@link org.apache.wiki.event.WikiEngineEvent#SHUTDOWN}
- * events to registered listeners.
+ * protected method {@link WikiEngine#stop()}, which sends {@link org.apache.wiki.event.WikiEngineEvent#SHUTDOWN}
+ * events to registered listeners, as well as notifying available {@link EngineLifecycleExtension EngineLifecycleExtension}s.
*
* @see javax.servlet.GenericServlet#destroy()
*/
@Override
public void destroy() {
log.info( "WikiServlet shutdown." );
- m_engine.shutdown();
+ m_engine.stop();
super.destroy();
}
diff --git a/jspwiki-main/src/test/java/org/apache/wiki/TestEngine.java b/jspwiki-main/src/test/java/org/apache/wiki/TestEngine.java
index dec2f99..1ccf1ef 100644
--- a/jspwiki-main/src/test/java/org/apache/wiki/TestEngine.java
+++ b/jspwiki-main/src/test/java/org/apache/wiki/TestEngine.java
@@ -25,6 +25,7 @@ import net.sourceforge.stripes.mock.MockServletContext;
import org.apache.commons.lang3.StringUtils;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
+import org.apache.wiki.api.Release;
import org.apache.wiki.api.core.Attachment;
import org.apache.wiki.api.core.Context;
import org.apache.wiki.api.core.ContextEnum;
@@ -175,11 +176,16 @@ public class TestEngine extends WikiEngine {
}
public TestEngine( final Properties props ) throws WikiException {
- super( createServletContext( "test" ), "test", cleanTestProps( props ) );
+ super( createServletContext( "test" ), "test" );
+ try {
+ start( cleanTestProps( props ) );
+ } catch( final Exception e ) {
+ throw new WikiException( Release.APPNAME + ": Unable to load and setup properties from jspwiki.properties. " + e.getMessage(), e );
+ }
// Stash the WikiEngine in the servlet context
final ServletContext servletContext = this.getServletContext();
- servletContext.setAttribute("org.apache.wiki.WikiEngine", this);
+ servletContext.setAttribute( "org.apache.wiki.WikiEngine", this );
}
public static MockServletContext createServletContext( final String contextName ) {
@@ -229,15 +235,15 @@ public class TestEngine extends WikiEngine {
}
public static void emptyWorkDir(Properties properties) {
- if (properties == null) {
+ if( properties == null ) {
properties = getTestProperties();
}
final String workdir = properties.getProperty( WikiEngine.PROP_WORKDIR );
- if ( workdir != null ) {
+ if( workdir != null ) {
final File f = new File( workdir );
- if (f.exists() && f.isDirectory() && new File( f, "refmgr.ser" ).exists()) {
+ if( f.exists() && f.isDirectory() && new File( f, "refmgr.ser" ).exists() ) {
// System.out.println( "Deleting " + f.getAbsolutePath() );
deleteAll( f );
}
@@ -248,67 +254,45 @@ public class TestEngine extends WikiEngine {
emptyWikiDir( null );
}
- public static void emptyWikiDir(Properties properties) {
- if (properties == null) {
+ public static void emptyWikiDir( Properties properties ) {
+ if( properties == null ) {
properties = getTestProperties();
}
-
final String wikidir = properties.getProperty( AbstractFileProvider.PROP_PAGEDIR );
if ( wikidir != null ) {
final File f = new File( wikidir );
-
- if (f.exists() && f.isDirectory()) {
+ if( f.exists() && f.isDirectory() ) {
deleteAll( f );
}
}
}
public static Properties getTestProperties() {
- if (combinedProperties == null) {
+ if( combinedProperties == null ) {
combinedProperties = PropertyReader.getCombinedProperties(PropertyReader.CUSTOM_JSPWIKI_CONFIG);
}
// better to make a copy via putAll instead of Properties(properties)
// constructor, see http://stackoverflow.com/a/2004900
final Properties propCopy = new Properties();
- propCopy.putAll(combinedProperties);
+ propCopy.putAll( combinedProperties );
return propCopy;
}
- public static Properties getTestProperties( final String customPropFile) {
- return PropertyReader.getCombinedProperties(customPropFile);
+ public static Properties getTestProperties( final String customPropFile ) {
+ return PropertyReader.getCombinedProperties( customPropFile );
}
-/*
- public static final InputStream findTestProperties()
- {
- return findTestProperties( "/jspwiki.properties" );
- }
-
- public static final InputStream findTestProperties( String properties )
- {
- InputStream in = TestEngine.class.getResourceAsStream( properties );
-
- if( in == null ) throw new InternalWikiException("Unable to locate test property resource: "+properties);
- return in;
- }
-*/
/**
* Deletes all files under this directory, and does them recursively.
*/
- public static void deleteAll( final File file )
- {
- if( file != null )
- {
- if( file.isDirectory() )
- {
+ public static void deleteAll( final File file ) {
+ if( file != null ) {
+ if( file.isDirectory() ) {
final File[] files = file.listFiles();
-
- if( files != null )
- {
- for ( final File file2 : files) {
- if( file2.isDirectory() )
- {
- deleteAll(file2);
+ if( files != null ) {
+ for( final File file2 : files ) {
+ if( file2.isDirectory() ) {
+ deleteAll( file2 );
}
file2.delete();
diff --git a/jspwiki-main/src/test/java/org/apache/wiki/WikiEngineTest.java b/jspwiki-main/src/test/java/org/apache/wiki/WikiEngineTest.java
index cbe0a14..4a6dc03 100644
--- a/jspwiki-main/src/test/java/org/apache/wiki/WikiEngineTest.java
+++ b/jspwiki-main/src/test/java/org/apache/wiki/WikiEngineTest.java
@@ -66,7 +66,7 @@ public class WikiEngineTest {
}
TestEngine.emptyWorkDir();
- m_engine.shutdown();
+ m_engine.stop();
}
@Test
diff --git a/jspwiki-main/src/test/java/org/apache/wiki/attachment/AttachmentManagerTest.java b/jspwiki-main/src/test/java/org/apache/wiki/attachment/AttachmentManagerTest.java
index 7e4fda2..3021d5c 100644
--- a/jspwiki-main/src/test/java/org/apache/wiki/attachment/AttachmentManagerTest.java
+++ b/jspwiki-main/src/test/java/org/apache/wiki/attachment/AttachmentManagerTest.java
@@ -67,7 +67,7 @@ public class AttachmentManagerTest {
public void tearDown() {
m_engine.deleteTestPage( NAME1 );
m_engine.deleteTestPage( NAMEU );
- m_engine.shutdown();
+ m_engine.stop();
TestEngine.deleteAttachments(NAME1);
TestEngine.deleteAttachments(NAMEU);
diff --git a/jspwiki-main/src/test/java/org/apache/wiki/content/PageRenamerTest.java b/jspwiki-main/src/test/java/org/apache/wiki/content/PageRenamerTest.java
index 24237d6..492e951 100644
--- a/jspwiki-main/src/test/java/org/apache/wiki/content/PageRenamerTest.java
+++ b/jspwiki-main/src/test/java/org/apache/wiki/content/PageRenamerTest.java
@@ -62,7 +62,7 @@ public class PageRenamerTest {
m_engine.deleteTestPage("Link two");
TestEngine.emptyWorkDir();
- m_engine.shutdown();
+ m_engine.stop();
}
@Test
diff --git a/jspwiki-main/src/test/java/org/apache/wiki/pages/DefaultPageManagerTest.java b/jspwiki-main/src/test/java/org/apache/wiki/pages/DefaultPageManagerTest.java
index e6763f1..f794b4c 100644
--- a/jspwiki-main/src/test/java/org/apache/wiki/pages/DefaultPageManagerTest.java
+++ b/jspwiki-main/src/test/java/org/apache/wiki/pages/DefaultPageManagerTest.java
@@ -56,7 +56,7 @@ public class DefaultPageManagerTest {
}
TestEngine.emptyWorkDir();
- engine.shutdown();
+ engine.stop();
}
/**
diff --git a/jspwiki-main/src/test/java/org/apache/wiki/parser/JSPWikiMarkupParserTest.java b/jspwiki-main/src/test/java/org/apache/wiki/parser/JSPWikiMarkupParserTest.java
index 6c517da..10de078 100644
--- a/jspwiki-main/src/test/java/org/apache/wiki/parser/JSPWikiMarkupParserTest.java
+++ b/jspwiki-main/src/test/java/org/apache/wiki/parser/JSPWikiMarkupParserTest.java
@@ -60,7 +60,7 @@ public class JSPWikiMarkupParserTest {
@AfterEach
public void tearDown() {
deleteCreatedPages();
- testEngine.shutdown();
+ testEngine.stop();
}
private void newPage( final String name ) throws WikiException {
diff --git a/jspwiki-main/src/test/java/org/apache/wiki/providers/VersioningFileProviderTest.java b/jspwiki-main/src/test/java/org/apache/wiki/providers/VersioningFileProviderTest.java
index 72e54d9..65c38dd 100644
--- a/jspwiki-main/src/test/java/org/apache/wiki/providers/VersioningFileProviderTest.java
+++ b/jspwiki-main/src/test/java/org/apache/wiki/providers/VersioningFileProviderTest.java
@@ -66,7 +66,7 @@ public class VersioningFileProviderTest {
TestEngine.deleteAll( new File(files) );
// clear the cache at the end of every test case to avoid polluting another test case
- engine.shutdown();
+ engine.stop();
// make sure that the reference manager cache is cleaned first
TestEngine.emptyWorkDir(null);
diff --git a/jspwiki-main/src/test/java/org/apache/wiki/references/ReferenceManagerTest.java b/jspwiki-main/src/test/java/org/apache/wiki/references/ReferenceManagerTest.java
index e04ef22..f344b43 100644
--- a/jspwiki-main/src/test/java/org/apache/wiki/references/ReferenceManagerTest.java
+++ b/jspwiki-main/src/test/java/org/apache/wiki/references/ReferenceManagerTest.java
@@ -50,7 +50,7 @@ public class ReferenceManagerTest {
TestEngine.emptyWikiDir();
// jspwiki always uses a singleton CacheManager, so clear the cache at the end of every test case to avoid polluting another test case
- engine.shutdown();
+ engine.stop();
// make sure that the reference manager cache is cleaned
TestEngine.emptyWorkDir( null );
diff --git a/jspwiki-main/src/test/java/org/apache/wiki/render/RenderingManagerTest.java b/jspwiki-main/src/test/java/org/apache/wiki/render/RenderingManagerTest.java
index 4aed439..9e3bed7 100644
--- a/jspwiki-main/src/test/java/org/apache/wiki/render/RenderingManagerTest.java
+++ b/jspwiki-main/src/test/java/org/apache/wiki/render/RenderingManagerTest.java
@@ -38,7 +38,7 @@ public class RenderingManagerTest {
@AfterEach
public void tearDown() throws Exception {
m_engine.getManager( PageManager.class ).deletePage( "TestPage" );
- m_engine.shutdown();
+ m_engine.stop();
}
@Test
diff --git a/jspwiki-main/src/test/java/org/apache/wiki/search/SearchManagerTest.java b/jspwiki-main/src/test/java/org/apache/wiki/search/SearchManagerTest.java
index f023f06..7eda07d 100644
--- a/jspwiki-main/src/test/java/org/apache/wiki/search/SearchManagerTest.java
+++ b/jspwiki-main/src/test/java/org/apache/wiki/search/SearchManagerTest.java
@@ -61,7 +61,7 @@ public class SearchManagerTest {
@AfterEach
public void tearDown() {
- m_engine.shutdown();
+ m_engine.stop();
TestEngine.emptyWorkDir( props );
}
diff --git a/jspwiki-main/src/test/java/org/apache/wiki/stress/MassiveRepositoryTest.java b/jspwiki-main/src/test/java/org/apache/wiki/stress/MassiveRepositoryTest.java
index a3c2c94..332b9dc 100644
--- a/jspwiki-main/src/test/java/org/apache/wiki/stress/MassiveRepositoryTest.java
+++ b/jspwiki-main/src/test/java/org/apache/wiki/stress/MassiveRepositoryTest.java
@@ -43,7 +43,7 @@ public class MassiveRepositoryTest {
final String files = props.getProperty( FileSystemProvider.PROP_PAGEDIR );
final File f = new File( files );
TestEngine.deleteAll( f );
- engine.shutdown();
+ engine.stop();
}
private String getName( final int i ) {
diff --git a/jspwiki-main/src/test/java/org/apache/wiki/workflow/WorkflowManagerTest.java b/jspwiki-main/src/test/java/org/apache/wiki/workflow/WorkflowManagerTest.java
index 1f76f54..620bc70 100644
--- a/jspwiki-main/src/test/java/org/apache/wiki/workflow/WorkflowManagerTest.java
+++ b/jspwiki-main/src/test/java/org/apache/wiki/workflow/WorkflowManagerTest.java
@@ -58,7 +58,7 @@ public class WorkflowManagerTest {
@AfterEach
public void tearDown() {
- m_engine.shutdown();
+ m_engine.stop();
}
@Test
diff --git a/jspwiki-main/src/test/java/org/apache/wiki/xmlrpc/RPCHandlerTest.java b/jspwiki-main/src/test/java/org/apache/wiki/xmlrpc/RPCHandlerTest.java
index 5bfce65..5f09e61 100644
--- a/jspwiki-main/src/test/java/org/apache/wiki/xmlrpc/RPCHandlerTest.java
+++ b/jspwiki-main/src/test/java/org/apache/wiki/xmlrpc/RPCHandlerTest.java
@@ -54,7 +54,7 @@ public class RPCHandlerTest {
@AfterEach
public void tearDown() {
m_engine.deleteTestPage( NAME1 );
- m_engine.shutdown();
+ m_engine.stop();
TestEngine.deleteAttachments( NAME1 );
TestEngine.emptyWorkDir();
}
@@ -107,7 +107,7 @@ public class RPCHandlerTest {
final Page directInfo = m_engine.getManager( PageManager.class ).getPage( NAME1 );
final Hashtable ht = m_handler.getPageInfo( NAME1 );
- Assertions.assertEquals( ( String ) ht.get( "name" ), NAME1, "name" );
+ Assertions.assertEquals( ht.get( "name" ), NAME1, "name" );
final Date d = ( Date ) ht.get( "lastModified" );
diff --git a/jspwiki-markdown/src/test/java/org/apache/wiki/render/markdown/MarkdownRendererTest.java b/jspwiki-markdown/src/test/java/org/apache/wiki/render/markdown/MarkdownRendererTest.java
index 76070ab..f93caed 100644
--- a/jspwiki-markdown/src/test/java/org/apache/wiki/render/markdown/MarkdownRendererTest.java
+++ b/jspwiki-markdown/src/test/java/org/apache/wiki/render/markdown/MarkdownRendererTest.java
@@ -326,7 +326,7 @@ public class MarkdownRendererTest {
}
created.clear();
- testEngine.shutdown();
+ testEngine.stop();
}
String translate( final String src ) throws Exception {