created new parameterized unit tests

src/main/java/io/github/astrapi69/mystic/crypt/decorator/CryptObjectDecoratorExtensions.java

@@ -36,12 +36,26 @@
 import io.github.astrapi69.crypt.data.model.CryptObjectDecorator;
 import io.github.astrapi69.file.read.ReadFileExtensions;
 
+/**
+ * Utility class for decorating and undecorating cryptographic objects.
+ */
 public final class CryptObjectDecoratorExtensions
 {
 	private CryptObjectDecoratorExtensions()
 	{
 	}
 
+	/**
+	 * Decorates the content of the given file using the specified decorator.
+	 *
+	 * @param toEncrypt
+	 *            the file to be encrypted
+	 * @param decorator
+	 *            the decorator to be used
+	 * @return the decorated string
+	 * @throws IOException
+	 *             if an I/O error occurs
+	 */
 	public static String decorateFile(final File toEncrypt,
 		final CryptObjectDecorator<String> decorator) throws IOException
 	{
@@ -50,6 +64,17 @@ public static String decorateFile(final File toEncrypt,
 		return decorateWithStringDecorator(ReadFileExtensions.fromFile(toEncrypt), decorator);
 	}
 
+	/**
+	 * Decorates the given string using a byte array decorator.
+	 *
+	 * @param toEncrypt
+	 *            the string to be encrypted
+	 * @param decorator
+	 *            the decorator to be used
+	 * @param charset
+	 *            the charset to be used for encoding
+	 * @return the decorated string
+	 */
 	public static String decorateWithBytearrayDecorator(final String toEncrypt,
 		final CryptObjectDecorator<byte[]> decorator, final Charset charset)
 	{
@@ -58,13 +83,20 @@ public static String decorateWithBytearrayDecorator(final String toEncrypt,
 		Objects.requireNonNull(charset);
 		StringBuilder sb = new StringBuilder();
 		sb.append(new String(decorator.getPrefix(), charset));
-
 		sb.append(toEncrypt);
-
 		sb.append(new String(decorator.getSuffix(), charset));
 		return sb.toString();
 	}
 
+	/**
+	 * Decorates the given string using a character decorator.
+	 *
+	 * @param toEncrypt
+	 *            the string to be encrypted
+	 * @param decorator
+	 *            the decorator to be used
+	 * @return the decorated string
+	 */
 	public static String decorateWithCharacterDecorator(final String toEncrypt,
 		final CryptObjectDecorator<Character> decorator)
 	{
@@ -77,6 +109,15 @@ public static String decorateWithCharacterDecorator(final String toEncrypt,
 		return sb.toString();
 	}
 
+	/**
+	 * Decorates the given string using a string decorator.
+	 *
+	 * @param toEncrypt
+	 *            the string to be encrypted
+	 * @param decorator
+	 *            the decorator to be used
+	 * @return the decorated string
+	 */
 	public static String decorateWithStringDecorator(final String toEncrypt,
 		final CryptObjectDecorator<String> decorator)
 	{
@@ -141,6 +182,17 @@ private static boolean startsWith(final byte[] array, byte[] prefix)
 		return true;
 	}
 
+	/**
+	 * Undecorates the content of the given file using the specified decorator.
+	 *
+	 * @param decrypted
+	 *            the file to be decrypted
+	 * @param decorator
+	 *            the decorator to be used
+	 * @return the undecorated string
+	 * @throws IOException
+	 *             if an I/O error occurs
+	 */
 	public static String undecorateFile(final File decrypted,
 		final CryptObjectDecorator<String> decorator) throws IOException
 	{
@@ -149,6 +201,15 @@ public static String undecorateFile(final File decrypted,
 		return undecorateWithStringDecorator(ReadFileExtensions.fromFile(decrypted), decorator);
 	}
 
+	/**
+	 * Undecorates the given string using a byte array decorator.
+	 *
+	 * @param toEncrypt
+	 *            the string to be decrypted
+	 * @param decorator
+	 *            the decorator to be used
+	 * @return the undecorated string
+	 */
 	public static String undecorateWithBytearrayDecorator(final String toEncrypt,
 		final CryptObjectDecorator<byte[]> decorator)
 	{
@@ -171,6 +232,15 @@ public static String undecorateWithBytearrayDecorator(final String toEncrypt,
 		return new String(result);
 	}
 
+	/**
+	 * Undecorates the given string using a character decorator.
+	 *
+	 * @param toEncrypt
+	 *            the string to be decrypted
+	 * @param decorator
+	 *            the decorator to be used
+	 * @return the undecorated string
+	 */
 	public static String undecorateWithCharacterDecorator(final String toEncrypt,
 		final CryptObjectDecorator<Character> decorator)
 	{
@@ -193,11 +263,19 @@ public static String undecorateWithCharacterDecorator(final String toEncrypt,
 			{
 				sb.deleteCharAt(toEncrypt.length() - 1);
 			}
-
 		}
 		return sb.toString();
 	}
 
+	/**
+	 * Undecorates the given string using a string decorator.
+	 *
+	 * @param decrypted
+	 *            the string to be decrypted
+	 * @param decorator
+	 *            the decorator to be used
+	 * @return the undecorated string
+	 */
 	public static String undecorateWithStringDecorator(final String decrypted,
 		final CryptObjectDecorator<String> decorator)
 	{
@@ -211,7 +289,6 @@ public static String undecorateWithStringDecorator(final String decrypted,
 		if (decrypted.endsWith(decorator.getSuffix()))
 		{
 			result = StringUtils.removeEnd(result, decorator.getSuffix());
-
 		}
 		return result;
 	}

src/main/java/io/github/astrapi69/mystic/crypt/decorator/package-info.java

@@ -1,4 +1,4 @@
 /**
- * This package provides classes for decorate crypt objects
+ * This package provides classes for decorating and undecorating cryptographic objects.
  */
 package io.github.astrapi69.mystic.crypt.decorator;

src/main/java/io/github/astrapi69/mystic/crypt/gm/package-info.java

@@ -1,7 +1,6 @@
 /**
- * This package provides a utility class that can sign urls for google maps with the private key.  
-    This class is inspired
-  from this
-  <a href= "https://github.com/googlemaps/url-signing/blob/gh-pages/UrlSigner.java">class</a>
+ * This package provides a utility class that can sign urls for google maps with the private key.
+ * This class is inspired from this
+ * <a href= "https://github.com/googlemaps/url-signing/blob/gh-pages/UrlSigner.java">class</a>
  */
 package io.github.astrapi69.mystic.crypt.gm;

src/main/java/io/github/astrapi69/mystic/crypt/obfuscation/character/package-info.java

@@ -1,5 +1,6 @@
 /**
- * This package provides classes that obfuscate text. The disentangle process is still experimental. <br>
-    Note: use the disentangle process at your own risk.
+ * This package provides classes that obfuscate text. The disentangle process is still experimental.
+ * <br>
+ * Note: use the disentangle process at your own risk.
  */
 package io.github.astrapi69.mystic.crypt.obfuscation.character;

src/main/java/io/github/astrapi69/mystic/crypt/ssl/package-info.java

@@ -1,4 +1,5 @@
 /**
- * This package provides a class with factory methods for create TrustManager array objects and KeyManager array objects.
+ * This package provides a class with factory methods for create TrustManager array objects and
+ * KeyManager array objects.
  */
 package io.github.astrapi69.mystic.crypt.ssl;

src/test/java/io/github/astrapi69/mystic/crypt/decorator/CryptObjectDecoratorExtensionsTest.java

@@ -27,8 +27,11 @@
 import static org.junit.jupiter.api.Assertions.assertEquals;
 
 import java.nio.charset.Charset;
+import java.nio.charset.StandardCharsets;
 
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.CsvFileSource;
 
 import io.github.astrapi69.crypt.data.model.CryptObjectDecorator;
 
@@ -38,6 +41,115 @@
 public class CryptObjectDecoratorExtensionsTest
 {
 
+	/**
+	 * Test method for
+	 * {@link CryptObjectDecoratorExtensions#decorateWithStringDecorator(String, CryptObjectDecorator)}.
+	 *
+	 * @param input
+	 *            the input string to be decorated
+	 * @param prefix
+	 *            the prefix for decoration
+	 * @param suffix
+	 *            the suffix for decoration
+	 * @param expected
+	 *            the expected result after decoration
+	 */
+	@ParameterizedTest
+	@CsvFileSource(resources = "/decorateStringTest.csv", numLinesToSkip = 1)
+	void testDecorateWithStringDecorator(String input, String prefix, String suffix,
+		String expected)
+	{
+		CryptObjectDecorator<String> decorator;
+
+		decorator = CryptObjectDecorator.<String> builder().prefix(prefix).suffix(suffix).build();
+		String result = CryptObjectDecoratorExtensions.decorateWithStringDecorator(input,
+			decorator);
+		assertEquals(expected, result);
+	}
+
+	/**
+	 * Test method for
+	 * {@link CryptObjectDecoratorExtensions#undecorateWithStringDecorator(String, CryptObjectDecorator)}.
+	 *
+	 * @param input
+	 *            the input string to be undecorated
+	 * @param prefix
+	 *            the prefix for undecoration
+	 * @param suffix
+	 *            the suffix for undecoration
+	 * @param expected
+	 *            the expected result after undecoration
+	 */
+	@ParameterizedTest
+	@CsvFileSource(resources = "/undecorateStringTest.csv", numLinesToSkip = 1)
+	void testUndecorateWithStringDecorator(String input, String prefix, String suffix,
+		String expected)
+	{
+		CryptObjectDecorator<String> decorator;
+
+		decorator = CryptObjectDecorator.<String> builder().prefix(prefix).suffix(suffix).build();
+		String result = CryptObjectDecoratorExtensions.undecorateWithStringDecorator(input,
+			decorator);
+		assertEquals(expected, result);
+	}
+
+	/**
+	 * Test method for
+	 * {@link CryptObjectDecoratorExtensions#decorateWithBytearrayDecorator(String, CryptObjectDecorator, Charset)}.
+	 *
+	 * @param input
+	 *            the input string to be decorated
+	 * @param prefix
+	 *            the prefix for decoration
+	 * @param suffix
+	 *            the suffix for decoration
+	 * @param expected
+	 *            the expected result after decoration
+	 */
+	@ParameterizedTest
+	@CsvFileSource(resources = "/decorateBytearrayTest.csv", numLinesToSkip = 1)
+	void testDecorateWithBytearrayDecorator(String input, String prefix, String suffix,
+		String expected)
+	{
+
+		CryptObjectDecorator<byte[]> decorator;
+
+		decorator = CryptObjectDecorator.<byte[]> builder()
+			.prefix(prefix.getBytes(StandardCharsets.UTF_8))
+			.suffix(suffix.getBytes(StandardCharsets.UTF_8)).build();
+		String result = CryptObjectDecoratorExtensions.decorateWithBytearrayDecorator(input,
+			decorator, StandardCharsets.UTF_8);
+		assertEquals(expected, result);
+	}
+
+	/**
+	 * Test method for
+	 * {@link CryptObjectDecoratorExtensions#undecorateWithBytearrayDecorator(String, CryptObjectDecorator)}.
+	 *
+	 * @param input
+	 *            the input string to be undecorated
+	 * @param prefix
+	 *            the prefix for undecoration
+	 * @param suffix
+	 *            the suffix for undecoration
+	 * @param expected
+	 *            the expected result after undecoration
+	 */
+	@ParameterizedTest
+	@CsvFileSource(resources = "/undecorateBytearrayTest.csv", numLinesToSkip = 1)
+	void testUndecorateWithBytearrayDecorator(String input, String prefix, String suffix,
+		String expected)
+	{
+		CryptObjectDecorator<byte[]> decorator;
+
+		decorator = CryptObjectDecorator.<byte[]> builder()
+			.prefix(prefix.getBytes(StandardCharsets.UTF_8))
+			.suffix(suffix.getBytes(StandardCharsets.UTF_8)).build();
+		String result = CryptObjectDecoratorExtensions.undecorateWithBytearrayDecorator(input,
+			decorator);
+		assertEquals(expected, result);
+	}
+
 	/**
 	 * Test method for the decoration of an crypt object with {@link CryptObjectDecorator} with byte
 	 * array as prefix and suffix

src/test/resources/decorateBytearrayTest.csv

@@ -0,0 +1,3 @@
+input,prefix,suffix,expected
+Hello,<<,>>,<<Hello>>
+World,[[,]],[[World]]

src/test/resources/decorateStringTest.csv

@@ -0,0 +1,3 @@
+input,prefix,suffix,expected
+Hello,<<,>>,<<Hello>>
+World,[[,]],[[World]]

src/test/resources/undecorateBytearrayTest.csv

@@ -0,0 +1,3 @@
+input,prefix,suffix,expected
+<<Hello>>,<<,>>,Hello
+[[World]],[[,]],World

src/test/resources/undecorateStringTest.csv

@@ -0,0 +1,3 @@
+input,prefix,suffix,expected
+<<Hello>>,<<,>>,Hello
+[[World]],[[,]],World