✨ Added isLocal() method to AemInstance

This will come in handy when handling things like file paths for PDF
rendering.

Author: rmcdouga

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

@@ -16,7 +16,9 @@
 import org.testcontainers.utility.DockerImageName;
 
 public enum AemInstance {
-	AEM_1(TestUtils.USE_TESTCONTAINERS);	// Change parameter to false to disable TestContainers and use local AEM instance..
+	AEM_1(TestUtils.USE_TESTCONTAINERS); // 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
@@ -76,7 +78,7 @@ private static void startAem(Integer mappedPort) {
 	public static void deploySampleFiles(Integer mappedPort) {
 		System.out.println("Deploying sample files...");
 
-		SamplesDeployer deployer = new SamplesDeployer("localhost", mappedPort, TestUtils.TEST_USER, TestUtils.TEST_USER_PASSWORD);
+		SamplesDeployer deployer = new SamplesDeployer(LOCALHOST, mappedPort, TestUtils.TEST_USER, TestUtils.TEST_USER_PASSWORD);
 
 		deployer.deployXdp(Paths.get("src", "test", "resources", "SampleForm.xdp"), "sample-forms");
 		deployer.deployAf(Paths.get("src", "test", "resources", "sample00002test.zip"));
@@ -85,12 +87,25 @@ public static void deploySampleFiles(Integer mappedPort) {
 	}
 
 	public String aemHost() {
-		return aemContainer != null ? "localhost" : TestUtils.TEST_MACHINE_NAME;
+		return aemContainer != null ? LOCALHOST : TestUtils.TEST_MACHINE_NAME;
 	}
+
 	public Integer aemPort() {
 		return aemContainer != null ? aemContainer.getMappedPort(4502) : Integer.parseInt(TestUtils.TEST_MACHINE_PORT_STR) ;
 	}
 
+	/**
+	 * Is AEM running locally or remotely? 
+	 * 
+	 * If is is running in a container, then it is considered remote (because it does not have access to the local file system).
+	 * If AEM is running locally, then local file paths can be used, otherwise remote file paths will need to be used for some tests.
+	 * 
+	 * @return
+	 */
+	public boolean isLocal() {
+		return aemContainer == null && aemHost().equalsIgnoreCase(LOCALHOST);
+	}
+
 	private static boolean aemIsUp(HttpClient restClient, HttpRequest request) {
 		try {
 			HttpResponse<Void> result = restClient.send(request, BodyHandlers.discarding());

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

@@ -6,6 +6,15 @@
 import com._4point.aem.package_manager.FormsAndDocumentsClient;
 import com._4point.aem.package_manager.FormsAndDocumentsClientEx;
 
+/**
+ * Used for deploying sample files to AEM for testing purposes.  This includes the following files:
+ *  - SampleForm.xdp (deployed to remote file system for testing PDF rendering using a file reference)
+ *  - SampleForm.xdp (deployed to /content/dam/formsanddocuments/sample-forms for CRX testing0
+ *  - Sample0002test.zip (deployed to /content/dam/formsanddocuments for adaptive forms testing)
+ *  
+ *  Possible future things:
+ *  - Deploy ReaderExtensions credentials
+ */
 public class SamplesDeployer {
 	private final FormsAndDocumentsClientEx client;