Commit 36b4a8bf authored by gmantele's avatar gmantele
Browse files

[TAP] Adapt the JUnit class testing getFile(...), 

apply a quick space replacement (by %20) for few URIs of the configuration file
and remove duplicated entry (encoding) from the Gradle build script.

A special test has also been added in getFile(...) in order to deliver
a clear error message for users using a former version with URIs in their
configuration file (only for file_root_path and metadata_file).
parent 16e26982

build.gradle

+5 −7
Original line number Diff line number Diff line 
apply plugin: 'java'

apply plugin: 'war'



compileJava.options.encoding = 'UTF-8'



test{

	forkEvery = 1

	include '**/Test*'

}



repositories {

    jcenter()

    mavenCentral()
@@ -32,5 +25,10 @@ compileJava { 
    options.encoding = "UTF-8"

}



test{

	forkEvery = 1

	include '**/Test*'

}



sourceSets.main.java.srcDirs = ["src"]

sourceSets.test.java.srcDirs = ["test"]

src/tap/config/ConfigurableServiceConnection.java

+81 −11
Original line number Diff line number Diff line 
package tap.config;



import static tap.config.TAPConfiguration.DEFAULT_ASYNC_FETCH_SIZE;

import static tap.config.TAPConfiguration.DEFAULT_DIRECTORY_PER_USER;

import static tap.config.TAPConfiguration.DEFAULT_EXECUTION_DURATION;

import static tap.config.TAPConfiguration.DEFAULT_GROUP_USER_DIRECTORIES;

import static tap.config.TAPConfiguration.DEFAULT_MAX_ASYNC_JOBS;

import static tap.config.TAPConfiguration.DEFAULT_RETENTION_PERIOD;

import static tap.config.TAPConfiguration.DEFAULT_SYNC_FETCH_SIZE;

import static tap.config.TAPConfiguration.DEFAULT_UPLOAD_MAX_FILE_SIZE;

import static tap.config.TAPConfiguration.KEY_ASYNC_FETCH_SIZE;

import static tap.config.TAPConfiguration.KEY_COORD_SYS;

import static tap.config.TAPConfiguration.KEY_DEFAULT_EXECUTION_DURATION;

import static tap.config.TAPConfiguration.KEY_DEFAULT_OUTPUT_LIMIT;

import static tap.config.TAPConfiguration.KEY_DEFAULT_RETENTION_PERIOD;

import static tap.config.TAPConfiguration.KEY_DEFAULT_UPLOAD_LIMIT;

import static tap.config.TAPConfiguration.KEY_DIRECTORY_PER_USER;

import static tap.config.TAPConfiguration.KEY_FILE_MANAGER;

import static tap.config.TAPConfiguration.KEY_FILE_ROOT_PATH;

import static tap.config.TAPConfiguration.KEY_GEOMETRIES;

import static tap.config.TAPConfiguration.KEY_GROUP_USER_DIRECTORIES;

import static tap.config.TAPConfiguration.KEY_LOG_ROTATION;

import static tap.config.TAPConfiguration.KEY_MAX_ASYNC_JOBS;

import static tap.config.TAPConfiguration.KEY_MAX_EXECUTION_DURATION;

import static tap.config.TAPConfiguration.KEY_MAX_OUTPUT_LIMIT;

import static tap.config.TAPConfiguration.KEY_MAX_RETENTION_PERIOD;

import static tap.config.TAPConfiguration.KEY_MAX_UPLOAD_LIMIT;

import static tap.config.TAPConfiguration.KEY_METADATA;

import static tap.config.TAPConfiguration.KEY_METADATA_FILE;

import static tap.config.TAPConfiguration.KEY_MIN_LOG_LEVEL;

import static tap.config.TAPConfiguration.KEY_OUTPUT_FORMATS;

import static tap.config.TAPConfiguration.KEY_PROVIDER_NAME;

import static tap.config.TAPConfiguration.KEY_SERVICE_DESCRIPTION;

import static tap.config.TAPConfiguration.KEY_SYNC_FETCH_SIZE;

import static tap.config.TAPConfiguration.KEY_TAP_FACTORY;

import static tap.config.TAPConfiguration.KEY_UDFS;

import static tap.config.TAPConfiguration.KEY_UPLOAD_ENABLED;

import static tap.config.TAPConfiguration.KEY_UPLOAD_MAX_FILE_SIZE;

import static tap.config.TAPConfiguration.KEY_USER_IDENTIFIER;

import static tap.config.TAPConfiguration.VALUE_ALL;

import static tap.config.TAPConfiguration.VALUE_ANY;

import static tap.config.TAPConfiguration.VALUE_CSV;

import static tap.config.TAPConfiguration.VALUE_DB;

import static tap.config.TAPConfiguration.VALUE_FITS;

import static tap.config.TAPConfiguration.VALUE_HTML;

import static tap.config.TAPConfiguration.VALUE_JSON;

import static tap.config.TAPConfiguration.VALUE_LOCAL;

import static tap.config.TAPConfiguration.VALUE_NONE;

import static tap.config.TAPConfiguration.VALUE_SV;

import static tap.config.TAPConfiguration.VALUE_TEXT;

import static tap.config.TAPConfiguration.VALUE_TSV;

import static tap.config.TAPConfiguration.VALUE_VOT;

import static tap.config.TAPConfiguration.VALUE_VOTABLE;

import static tap.config.TAPConfiguration.VALUE_XML;

import static tap.config.TAPConfiguration.fetchClass;

import static tap.config.TAPConfiguration.getProperty;

import static tap.config.TAPConfiguration.hasConstructor;

import static tap.config.TAPConfiguration.isClassName;

import static tap.config.TAPConfiguration.newInstance;

import static tap.config.TAPConfiguration.parseLimit;



import java.io.File;

import java.io.IOException;

import java.lang.reflect.Constructor;

import java.lang.reflect.InvocationTargetException;

import java.util.ArrayList;

import java.util.Collection;

import java.util.HashMap;

import java.util.Iterator;

import java.util.Properties;



/*

 * This file is part of TAPLibrary.

 *
@@ -28,7 +97,13 @@ import tap.TAPException; 
import tap.TAPFactory;

import tap.db.DBConnection;

import tap.db.JDBCConnection;

import tap.formatter.*;

import tap.formatter.FITSFormat;

import tap.formatter.HTMLFormat;

import tap.formatter.JSONFormat;

import tap.formatter.OutputFormat;

import tap.formatter.SVFormat;

import tap.formatter.TextFormat;

import tap.formatter.VOTableFormat;

import tap.log.DefaultTAPLog;

import tap.log.TAPLog;

import tap.metadata.TAPMetadata;
@@ -41,14 +116,6 @@ import uws.service.file.LocalUWSFileManager; 
import uws.service.file.UWSFileManager;

import uws.service.log.UWSLog.LogLevel;



import java.io.File;

import java.io.IOException;

import java.lang.reflect.Constructor;

import java.lang.reflect.InvocationTargetException;

import java.util.*;



import static tap.config.TAPConfiguration.*;



/**

 * <p>Concrete implementation of {@link ServiceConnection}, fully parameterized with a TAP configuration file.</p>

 *
@@ -268,10 +335,13 @@ public final class ConfigurableServiceConnection implements ServiceConnection { 
	 * 

	 * @return	The specified File instance.

	 *

	 * @throws ParseException	If the given file path is a URI/URL.

	 */

	protected static final File getFile(final String filePath, final String webAppRootPath, final String propertyName) {

	protected static final File getFile(final String filePath, final String webAppRootPath, final String propertyName) throws TAPException{

		if (filePath == null)

			return null;

		else if (filePath.matches(".*:.*"))

			throw new TAPException("Incorrect file path for the property \"" + propertyName + "\": \"" + filePath + "\"! URI/URLs are not expected here.");



		File f = new File(filePath);

		if (f.isAbsolute())

src/tap/resource/ForwardResource.java

+17 −17
Original line number Diff line number Diff line
@@ -16,7 +16,7 @@ package tap.resource; 
 * You should have received a copy of the GNU Lesser General Public License

 * along with TAPLibrary.  If not, see <http://www.gnu.org/licenses/>.

 * 

 * Copyright 2015 - Astronomisches Rechen Institut (ARI)

 * Copyright 2015-2017 - Astronomisches Rechen Institut (ARI)

 */



import java.io.BufferedReader;
@@ -51,7 +51,7 @@ import uws.service.log.UWSLog.LogLevel; 
 * <p><i>See {@link #forward(String, String, HttpServletRequest, HttpServletResponse)} for more details</i></p>

 * 

 * @author Gr&eacute;gory Mantelet (ARI)

 * @version 2.1 (11/2015)

 * @version 2.1 (03/2017)

 * @since 2.1

 */

public abstract class ForwardResource implements TAPResource {
@@ -114,16 +114,16 @@ public abstract class ForwardResource implements TAPResource { 


			URI uri = null;

			try{

				uri = new URI(file);

				uri = new URI(file.replaceAll(" ", "%20"));

				/* Note: the space replacement is just a convenient way to fix badly encoding URIs.

				 *       A proper way would be to encode all such incorrect URI characters (e.g. accents), but

				 *       the idea here is to focus on the most common mistake while writing manually 'file:' URIs. */



				/* If the servlet is set on the root Web Application path, a forward toward a WebContent resource won't work.

				 * The file then need to be copied "manually" in the HTTPServletResponse. For that, the trick consists to rewrite

				 * the given file path to a URI with the scheme "file://". */

				String tmpFile = null;

				if (request.getServletPath().length() == 0 && uri.getScheme() == null){

					tmpFile = "file://"+request.getServletContext().getRealPath(file);

					uri = new URI(tmpFile);

				}

				if (request.getServletPath().length() == 0 && uri.getScheme() == null)

					uri = new URI("file", null, request.getServletContext().getRealPath(file), null);



				/* CASE: FILE IN WebContent */

				if (uri.getScheme() == null){

test/tap/config/TestConfigurableServiceConnection.java

+6 −9
Original line number Diff line number Diff line
@@ -1124,11 +1124,8 @@ public class TestConfigurableServiceConnection { 
			// NULL test => NULL must be returned.

			assertNull(ConfigurableServiceConnection.getFile(null, rootPath, propertyName));



			// Valid file URI:

			path = "/custom/user/dir";

			assertEquals(path, ConfigurableServiceConnection.getFile("file://" + path, rootPath, propertyName).getAbsolutePath());



			// Valid absolute file path:

			path = "/custom/user/dir";

			assertEquals(path, ConfigurableServiceConnection.getFile(path, rootPath, propertyName).getAbsolutePath());



			// File name relative to the given rootPath:
@@ -1144,14 +1141,14 @@ public class TestConfigurableServiceConnection { 
			fail("None of these tests should have failed!");

		}



		// Test with a file URI having a bad syntax:

		path = "file:#toto^foo";

		// Test with a file URI:

		path = "file:/custom/user/dir";

		try{

			ConfigurableServiceConnection.getFile(path, rootPath, propertyName);

			fail("This test should have failed, because the given file URI has a bad syntax!");

			fail("This test should have failed, because URIs are no longer supported!");

		}catch(Exception ex){

			assertEquals(TAPException.class, ex.getClass());

			assertEquals("Incorrect file URI for the property \"" + propertyName + "\": \"" + path + "\"! Bad syntax for the given file URI.", ex.getMessage());

			assertEquals("Incorrect file path for the property \"" + propertyName + "\": \"" + path + "\"! URI/URLs are not expected here.", ex.getMessage());

		}



		// Test with an URL:
@@ -1161,7 +1158,7 @@ public class TestConfigurableServiceConnection { 
			fail("This test should have failed, because the given URI uses the HTTP protocol (actually, it uses a protocol different from \"file\"!");

		}catch(Exception ex){

			assertEquals(TAPException.class, ex.getClass());

			assertEquals("Incorrect file URI for the property \"" + propertyName + "\": \"" + path + "\"! Only URI with the protocol \"file:\" are allowed.", ex.getMessage());

			assertEquals("Incorrect file path for the property \"" + propertyName + "\": \"" + path + "\"! URI/URLs are not expected here.", ex.getMessage());

		}



	}