[xmlsectool] 01/02: Add useful base class for tests.

[Ian Young]

This is an automated email from the git hooks/post-receive script.

iay pushed a commit to branch master
in repository xmlsectool.

commit 3d51eff6c846cae554f89447164157525fa0fb19
Author: Ian Young <ian at iay.org.uk>
AuthorDate: Tue May 24 14:18:33 2016 +0100

    Add useful base class for tests.
---
 .../net/shibboleth/tool/xmlsectool/BaseTest.java   | 97 ++++++++++++++++++++++
 1 file changed, 97 insertions(+)

diff --git a/src/test/java/net/shibboleth/tool/xmlsectool/BaseTest.java b/src/test/java/net/shibboleth/tool/xmlsectool/BaseTest.java
new file mode 100644
index 0000000..025a99d
--- /dev/null
+++ b/src/test/java/net/shibboleth/tool/xmlsectool/BaseTest.java
@@ -0,0 +1,97 @@
+package net.shibboleth.tool.xmlsectool;
+
+import java.io.File;
+import java.net.URISyntaxException;
+import java.net.URL;
+import java.util.MissingResourceException;
+
+import org.testng.Assert;
+
+public abstract class BaseTest {
+
+    /** Class being tested. */
+    protected final Class<?> testingClass;
+    
+    /**
+     * Base path for class-relative test resource references.
+     * 
+     * Will <em>not</em> end in a '/'.
+     */
+    private final String baseClassPath;
+    
+    /** Package for the class being tested. */
+    private final Package testingPackage;
+    
+    /**
+     * Base path for package-relative test resource references.
+     * 
+     * Will always end in a '/'.
+     */
+    private final String basePackagePath;
+    
+    /** Constructor */
+    protected BaseTest(final Class<?> clazz) {
+        testingClass = clazz;
+        baseClassPath = nameToPath(testingClass.getName());
+        testingPackage = testingClass.getPackage();
+        basePackagePath = nameToPath(testingPackage.getName()) + "/";
+    }
+    
+    /**
+     * Converts the "."-separated name of a class or package into an
+     * absolute path.
+     * 
+     * @param name name to be converted
+     * @return path to resources associated with the name
+     */
+    private String nameToPath(final String name) {
+        return "/" + name.replace('.', '/');
+    }
+        
+    /**
+     * Makes a resource reference relative to the class being tested.
+     * 
+     * The convention adopted is that the class-relative name is something
+     * like "foo.pem", and that this is expanded to "/a/b/c/Bar-foo.pem".
+     * 
+     * @param which class-relative resource name
+     * @return absolute resource name
+     */
+    protected String classRelativeResource(final String which) {
+        return baseClassPath + "-" + which;
+    }
+    
+    protected String simpleClassRelativeName(final String which) {
+        return testingClass.getSimpleName() + "-" + which;
+    }
+        
+    /**
+     * Makes a resource reference relative to the package of the class being tested.
+     * 
+     * The convention adopted is that the package-relative name is something
+     * like "foo.pem", and that this is expanded to "/a/b/c/foo.pem".
+     * 
+     * @param which package-relative resource name
+     * @return absolute resource name
+     */
+    protected String packageRelativeResource(final String which) {
+        return basePackagePath + which;
+    }
+
+    /**
+     * Returns a test resource {@link File} from the package directory.
+     * 
+     * @param which package-local name of the file
+     * @return the named {@link File}, or <code>null</code>
+     */
+    protected File packageRelativeFile(final String which) {
+        final String name = packageRelativeResource(which);
+        final URL url = testingClass.getResource(name);
+        Assert.assertNotNull(url, "could not locate package resource " + name);
+        try {
+            return new File(url.toURI());
+        } catch (URISyntaxException e) {
+            throw new MissingResourceException(which, testingClass.getName(), "can't locate package-relative file");
+        }
+    }
+}

-- 
To stop receiving notification emails like this one, please contact
the administrator of this repository.