✨ Updated tests to provide easier test configuration based on AEM target

Some tests only work in certain scenarios, so the mecahnism I have added
should make it easier to exclude tests that are just going to fail
because of how AEM is configured.

Author: rmcdouga

rest-services/it.tests/src/test/java/com/_4point/aem/docservices/rest_services/it_tests/AemInstance.java

@@ -15,30 +15,39 @@
 import org.testcontainers.containers.GenericContainer;
 import org.testcontainers.utility.DockerImageName;
 
+import com._4point.aem.docservices.rest_services.it_tests.TestUtils.AemTargetType;
+
+/**
+ * This singleton defines the AEM instance that is being used for the integration tests.
+ * 
+ * Change the value of TestUtils.AEM_TARGET_TYPE in the TestUtils class to tell the tests what type of AEM instance we're testing against.
+ */
 public enum AemInstance {
-	AEM_1(TestUtils.USE_TESTCONTAINERS); // Change parameter to false to disable TestContainers and use local AEM instance..,
+	AEM_1(TestUtils.AEM_TARGET_TYPE); // Change parameter to false to disable TestContainers and use local AEM instance..,
 
 	private static final String LOCALHOST = "localhost";
 
 	// These tests require an AEM container image with AEM forms installed.  Since AEM is proprietary, it is not possible to obtain this
 	// through public images.  By default, this uses a private image hosted in the 4PointSolutions-PS GitHub organization.  If you are not
 	// part of that prg, you will have to supply your own image.
 	private static final String AEM_IMAGE_NAME = "ghcr.io/4pointsolutions-ps/aem:aem65sp21";
+	private final TestUtils.AemTargetType targetType;
 	private final GenericContainer<?> aemContainer;
 	private final AtomicBoolean preparedForTests = new AtomicBoolean(false);
 
-	private AemInstance(boolean useTestContainers) {
-		this(useTestContainers ? new GenericContainer<>(DockerImageName.parse(AEM_IMAGE_NAME))
+	@SuppressWarnings("resource")
+	private AemInstance(TestUtils.AemTargetType targetType) {
+		this(targetType, targetType == AemTargetType.TESTCONTAINERS ? new GenericContainer<>(DockerImageName.parse(AEM_IMAGE_NAME))
 																	   .withReuse(true)
 																	   .withExposedPorts(4502)
 							   : null);
 	}
 
-	private AemInstance(GenericContainer<?> aemContainer) {
+	private AemInstance(TestUtils.AemTargetType targetType, GenericContainer<?> aemContainer) {
+		this.targetType = targetType;
 		this.aemContainer = aemContainer;
 		if (aemContainer != null) {
 			aemContainer.start();
-
 		}
 	}
 
@@ -86,14 +95,37 @@ public static void deploySampleFiles(Integer mappedPort) {
 		System.out.println("Sample files deployed.");
 	}
 
+	/**
+	 * Host name where AEM is running
+	 * 
+	 * @return
+	 */
 	public String aemHost() {
-		return aemContainer != null ? LOCALHOST : TestUtils.TEST_MACHINE_NAME;
+		return switch (targetType) {
+		case LOCAL, TESTCONTAINERS -> LOCALHOST;
+		case REMOTE_WINDOWS, REMOTE_LINUX -> TestUtils.TEST_MACHINE_NAME;
+		};
 	}
 
+	/**
+	 * Port where AEM is running.
+	 * 
+	 * @return
+	 */
 	public Integer aemPort() {
-		return aemContainer != null ? aemContainer.getMappedPort(4502) : Integer.parseInt(TestUtils.TEST_MACHINE_PORT_STR) ;
+		return switch (targetType) {
+		case LOCAL, REMOTE_WINDOWS, REMOTE_LINUX -> Integer.parseInt(TestUtils.TEST_MACHINE_PORT_STR);
+		case TESTCONTAINERS -> aemContainer.getMappedPort(4502);
+		};
 	}
 
+	public Boolean isLinux() {
+		return switch (targetType) {
+		case LOCAL -> !System.getProperty("os.name").toLowerCase().contains("windows");	// Treat MAC as Linux
+		case REMOTE_WINDOWS -> false;
+		case REMOTE_LINUX, TESTCONTAINERS -> true;
+		};
+	}
 	/**
 	 * Is AEM running locally or remotely? 
 	 * 

rest-services/it.tests/src/test/java/com/_4point/aem/docservices/rest_services/it_tests/TestUtils.java

@@ -31,26 +31,30 @@ public class TestUtils {
 	public static final String TEST_USER = "admin";
 	public static final String TEST_USER_PASSWORD = "admin";
 
-	// Set this to true to use TestContainers for the integration tests.
+	public enum AemTargetType {
+		LOCAL,			// Running on local machine (assumes that the port is TEST_MACHINE_PORT)	
+		REMOTE_WINDOWS, // Running on remote Windows machine (assumes that machine name is TEST_MACHINE_NAME and port is TEST_MACHINE_PORT) 
+		REMOTE_LINUX, 	// Running on remote Linux machine (assumes that machine name is TEST_MACHINE_NAME and port is TEST_MACHINE_PORT)
+		TESTCONTAINERS; // Running on local testcontainers image (gets port from TestContainers)
+	}
+	
+	// Set this to indicate the type of machine that AEM is running on:
 	//  The integration tests will run against an AEM instance running in a Docker container otherwise they will run against a local AEM instance.
-	public static final boolean USE_TESTCONTAINERS = false;
-	// Status of TestContainers support.
+	public static final AemTargetType AEM_TARGET_TYPE = AemTargetType.LOCAL; 
+	// Status of LOCAL AEM Target support.
 	//		AEM Integration test issues:
-	//		* Sample Adaptive Form not deployed - Causes AF Rendering test to fail
-	//		* JSAFE not configured - Causes Assembler test to fail
-	//		* Sample XDP not deployed - Causes HTML5, PDF and Print rendering tests to fail
-	//		* GeneratePrintedOutput test AllArgs seems to want D:\FluentForms\Forms - Need to fix tests
-	//		* Reader Extensions not configured - Causes Reader Extensions test to fail
+	//		* Sample JSON Adaptive Form not deployed - Causes JSON AF Rendering test to fail
+	//		* Sample XDP not copied to target file system - Causes GeneratePdfOututTest "For mWindows Machine" rendering test failures
+	//		* Reader Extensions not configured - Causes Reader Extensions (Secure Document) tests to fail
 	//		* OpenOffice not installed - causes GeneratePdf tests to fail
 	//
-	//		Tests that pass:
-	//		* DataCacheService Tests
-	//		* GeneratePrintedOutput Form Doc tests
-	//		* GeneratePdfOutput Form Doc tests
-	//		* Import Data tests
-	//		* RenderPdfForm Form Doc tests
-	//		* Export Data tests
-	//		* ConvertPdfToXDP tests
+	// Status of TestContainers support.
+	//		AEM Integration test issues (in addition to those above)::
+	//		* Sample Adaptive Form not deployed - Causes AF Rendering test to fail (should be fixed in latest AEM image)
+	//		* JSAFE not configured - Causes Assembler test to fail (should be fixed in latest AEM image)
+	//		* Sample XDP not deployed - Causes HTML5, PDF and Print rendering tests to fail (should be fixed in latest AEM image)
+	//		* GeneratePrintedOutput test AllArgs seems to want D:\FluentForms\Forms - Need to fix tests
+	//		* Generate HTLML5 test fails because proteted mode is on - Need to fix AEM image creation code to set this.
 
 	private static final String SAMPLE_FORM_PDF_NAME = "SampleForm.pdf";
 	private static final String SAMPLE_FORM_XDP_NAME = "SampleForm.xdp";
@@ -93,6 +97,7 @@ public static String readEntityToString(Response result) {
 		}
 	}
 
+	@SuppressWarnings("unused")
 	public static void validatePdfResult(byte[] pdfBytes, String testResultFilename, boolean dynamic, boolean interactive, boolean hasRights)
 			throws IOException, Exception, PdfException {
 		if (SAVE_RESULTS == true) {

rest-services/it.tests/src/test/java/com/_4point/aem/docservices/rest_services/it_tests/client/output/GeneratePdfOutputTest.java

@@ -12,6 +12,9 @@
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Tag;
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.condition.EnabledIf;
+import org.junit.jupiter.api.condition.EnabledOnOs;
+import org.junit.jupiter.api.condition.OS;
 
 import com._4point.aem.docservices.rest_services.client.jersey.JerseyRestClient;
 import com._4point.aem.docservices.rest_services.client.output.RestServicesOutputServiceAdapter;
@@ -121,7 +124,9 @@ void testGeneratePdfOutput_JustFormIssue15() throws Exception {
 
 
 	@Test
-	@DisplayName("Test generatePdfOutput() Just Form.  From Windows Machine")
+	@EnabledOnOs(OS.WINDOWS)
+	@EnabledIf("targetIsLinux")
+	@DisplayName("Test generatePdfOutput() Just Form with Linux Path.  From Windows Machine")
 	void testGeneratePdfOutput_JustForm() throws Exception {
 //		Path formPath = Paths.get("/home/aem_user/u000/AEM/Forms/RUNTIME/Invoices/EN/Invoice_GB_PD.xdp");
 		URL formPath = new URL("file:/home/aem_user/u000/AEM/Forms/RUNTIME/Invoices/EN/Invoice_GB_PD.xdp");
@@ -134,7 +139,9 @@ void testGeneratePdfOutput_JustForm() throws Exception {
 	}
 
 	@Test
-	@DisplayName("Test generatePdfOutput() Just Form.  From Windows Machine")
+	@EnabledOnOs(OS.WINDOWS)
+	@EnabledIf("targetIsLinux")
+	@DisplayName("Test generatePdfOutput() Just Form with Linux ContentRoot.  From Windows Machine")
 	void testGeneratePdfOutput_JustFormContentRoot() throws Exception {
 		Path contentPath = Paths.get("\\","home", "aem_user", "u000","AEM","Forms","RUNTIME","Invoices","EN");
 		Path formPath = Paths.get("Invoice_GB_PD.xdp");
@@ -146,6 +153,8 @@ void testGeneratePdfOutput_JustFormContentRoot() throws Exception {
 
 //		TestUtils.validatePdfResult(pdfResult.getInlineData(), "GeneratePdfOutput_JustFormDocIssue15.pdf", false, false, false);
 	}
-
-
+	
+	boolean targetIsLinux() {
+		return AemInstance.AEM_1.isLinux();
+	}
 }