review and implement tests for ${p_* macros

Signed-off-by: Christoph Rueger <chrisrueger@gmail.com>

Author: chrisrueger

biz.aQute.bndlib.tests/test/test/MacroTestsForDocsExamples.java

@@ -2,22 +2,26 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 import static org.junit.jupiter.api.condition.OS.WINDOWS;
 
 import java.io.File;
 import java.io.IOException;
+import java.util.function.Consumer;
 
 import org.junit.jupiter.api.Disabled;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.condition.DisabledOnOs;
 import org.junit.jupiter.api.condition.EnabledOnOs;
 
+import aQute.bnd.build.Project;
 import aQute.bnd.build.Workspace;
 import aQute.bnd.header.Attrs;
 import aQute.bnd.osgi.Analyzer;
 import aQute.bnd.osgi.Builder;
 import aQute.bnd.osgi.Processor;
 import aQute.bnd.test.jupiter.InjectTemporaryDirectory;
+import aQute.lib.hex.Hex;
 import aQute.lib.io.IO;
 
 /**
@@ -750,11 +754,9 @@ public void testDecorated() throws IOException {
 	// ===== driver.md =====
 	@Test
 	public void testDriver() throws IOException {
-		try (Processor p = new Processor()) {
-			String result = p.getReplacer().process("${driver}");
-			// Should return gradle, maven, or bnd depending on environment, or not expand
-			assertThat(result).isNotNull();
-		}
+		// see test test.WorkspaceTest.testDriver()
+		// we just keep it here so that we know there are tests for the examples
+		// in the docs
 	}
 
 	// ===== ee.md =====
@@ -929,11 +931,11 @@ public void testGestalt(@InjectTemporaryDirectory
 	// ===== githead.md =====
 	@Test
 	public void testGithead() throws IOException {
-		try (Processor p = new Processor()) {
-			String result = p.getReplacer().process("${githead}");
-			// May return empty if not in git repo, or a SHA if in git repo
-			// Just check it doesn't throw
-			assertThat(result).isNotNull();
+
+		try (Builder b = new Builder();) {
+			String s = b.getReplacer()
+				.process("${githead}");
+			assertTrue(Hex.isHex(s));
 		}
 	}
 
@@ -961,7 +963,7 @@ public void testGlobal() throws IOException {
 			// global requires workspace context
 			String result = p.getReplacer().process("${global;key}");
 			// May not expand in test context
-			assertThat(result).isNotNull();
+			ensureDoesNotContainMacroLiteral(result);
 		}
 	}
 
@@ -974,7 +976,7 @@ public void testIde() throws IOException {
 		try (Processor p = new Processor()) {
 			String result = p.getReplacer().process("${ide}");
 			// Returns current IDE or empty
-			assertThat(result).isNotNull();
+			ensureDoesNotContainMacroLiteral(result);
 		}
 	}
 
@@ -1129,72 +1131,85 @@ public void testNow() throws IOException {
 
 	// ===== p_allsourcepath.md =====
 	@Test
-	public void testPAllsourcepath() throws IOException {
-		try (Processor p = new Processor()) {
-			String result = p.getReplacer().process("${p_allsourcepath}");
-			// Returns project source paths - may be empty in test context
-			assertThat(result).isNotNull();
-		}
+	public void testPAllsourcepath(@InjectTemporaryDirectory
+	File tempDir) throws Exception {
+		assertWorkspaceAndProject(tempDir, "testresources/ws", "p-stale", p -> {
+			assertThat(IO.normalizePath(p.getReplacer()
+				.process("${p_allsourcepath}"))).containsAnyOf("p-stale/src", "p-stale-dep/src");
+		});
 	}
 
 	// ===== p_bootclasspath.md =====
-	@Test
-	public void testPBootclasspath() throws IOException {
-		try (Processor p = new Processor()) {
-			String result = p.getReplacer().process("${p_bootclasspath}");
-			// Returns project boot classpath - may be empty in test context
-			assertThat(result).isNotNull();
-		}
+	/**
+	 * Don't know how to test this.
+	 */
+	@Disabled
+	public void testPBootclasspath() throws Exception {
+		// TODO don't know how to test setting the bootclasspath
 	}
 
 	// ===== p_buildpath.md =====
 	@Test
-	public void testPBuildpath() throws IOException {
-		try (Processor p = new Processor()) {
-			String result = p.getReplacer().process("${p_buildpath}");
-			// Returns project build path - may be empty in test context
-			assertThat(result).isNotNull();
-		}
+	public void testPBuildpath(@InjectTemporaryDirectory
+	File tempDir) throws Exception {
+		assertWorkspaceAndProject(tempDir, "testresources/ws", "p3", p -> {
+			assertThat(p.getReplacer()
+				.process("${p_buildpath}")).containsAnyOf("org.apache.felix.configadmin-1.0.1.jar");
+		});
+
 	}
 
 	// ===== p_dependson.md =====
 	@Test
-	public void testPDependson() throws IOException {
-		try (Processor p = new Processor()) {
-			String result = p.getReplacer().process("${p_dependson}");
-			// Returns projects this depends on - may be empty in test context
-			assertThat(result).isNotNull();
-		}
+	public void testPDependson(@InjectTemporaryDirectory
+	File tempDir) throws Exception {
+		assertWorkspaceAndProject(tempDir, "testresources/ws", "p-stale", p -> {
+			assertThat(p.getReplacer()
+				.process("${p_dependson}")).endsWith("p-stale-dep");
+		});
+
 	}
 
 	// ===== p_output.md =====
 	@Test
-	public void testPOutput() throws IOException {
-		try (Processor p = new Processor()) {
-			String result = p.getReplacer().process("${p_output}");
-			// Returns project output directory - may be empty in test context
-			assertThat(result).isNotNull();
+	public void tetstPOutput(@InjectTemporaryDirectory
+	File tempDir) throws Exception {
+		assertWorkspaceAndProject(tempDir, "testresources/ws-repo-test", "p1", p -> {
+			assertThat(p.getReplacer().process("${p_output}")).endsWith("p1/bin");
+		});
+
+	}
+
+	private void assertWorkspaceAndProject(File tempDir, String wspath, String project, Consumer<Project> s)
+		throws Exception {
+
+		IO.copy(IO.getFile(wspath), tempDir);
+		try (Workspace ws = new Workspace(tempDir)) {
+			Project p = ws.getProject(project);
+			s.accept(p);
 		}
 	}
 
 	// ===== p_sourcepath.md =====
 	@Test
-	public void testPSourcepath() throws IOException {
-		try (Processor p = new Processor()) {
-			String result = p.getReplacer().process("${p_sourcepath}");
-			// Returns project source path - may be empty in test context
-			assertThat(result).isNotNull();
-		}
+	public void testPSourcepath(@InjectTemporaryDirectory
+	File tempDir) throws Exception {
+		assertWorkspaceAndProject(tempDir, "testresources/ws-repo-test", "p1", p -> {
+			assertThat(IO.normalizePath(p.getReplacer()
+				.process("${p_sourcepath}"))).endsWith("p1/src");
+		});
 	}
 
 	// ===== p_testpath.md =====
 	@Test
-	public void testPTestpath() throws IOException {
-		try (Processor p = new Processor()) {
-			String result = p.getReplacer().process("${p_testpath}");
-			// Returns project test path - may be empty in test context
-			assertThat(result).isNotNull();
-		}
+	public void testPTestpath(@InjectTemporaryDirectory
+	File tempDir) throws Exception {
+		assertWorkspaceAndProject(tempDir, "testresources/ws", "multipath", p -> {
+			// just test for some jars
+			assertThat(p.getReplacer()
+				.process("${p_testpath}")).containsAnyOf("org.apache.felix.configadmin-1.8.8.jar",
+					"org.apache.felix.ipojo-1.0.0.jar");
+		});
 	}
 
 	// ===== path.md =====
@@ -1230,12 +1245,9 @@ public void testPathseparatorUnix() throws IOException {
 	// ===== permissions.md =====
 	@Test
 	public void testPermissions() throws IOException {
-		try (Processor p = new Processor()) {
-			p.setProperty("Import-Package", "org.osgi.framework");
-			String result = p.getReplacer().process("${permissions}");
-			// Returns permission declarations
-			assertThat(result).isNotNull();
-		}
+		// see tests in PermissionGeneratorTest
+		// we just keep it here so that we know there are tests for the examples
+		// in the docs
 	}
 
 	// ===== propertiesdir.md =====
@@ -1244,7 +1256,7 @@ public void testPropertiesdir() throws IOException {
 		try (Processor p = new Processor()) {
 			String result = p.getReplacer().process("${propertiesdir}");
 			// Returns directory containing bnd properties file
-			assertThat(result).isNotNull();
+			ensureDoesNotContainMacroLiteral(result);
 		}
 	}
 
@@ -1254,7 +1266,7 @@ public void testPropertiesname() throws IOException {
 		try (Processor p = new Processor()) {
 			String result = p.getReplacer().process("${propertiesname}");
 			// Returns name of bnd properties file
-			assertThat(result).isNotNull();
+			ensureDoesNotContainMacroLiteral(result);
 		}
 	}
 
@@ -1289,22 +1301,29 @@ public void testRemoveall() throws IOException {
 	}
 
 	// ===== repodigests.md =====
-	@Test
-	public void testRepodigests() throws IOException {
-		try (Processor p = new Processor()) {
-			String result = p.getReplacer().process("${repodigests}");
-			// Returns repository content digests - may be empty in test context
-			assertThat(result).isNotNull();
-		}
+	/**
+	 * Don't know how to test this.
+	 */
+	@Disabled
+	public void testRepodigests(@InjectTemporaryDirectory
+	File tempDir) throws Exception {
+		// TODO come up with a test, but have not found no class implementing
+		// RepositoryDigest interface
+
 	}
 
 	// ===== repos.md =====
 	@Test
-	public void testRepos() throws IOException {
-		try (Processor p = new Processor()) {
-			String result = p.getReplacer().process("${repos}");
+	public void testRepos(@InjectTemporaryDirectory
+	File tempDir) throws Exception {
+		IO.copy(IO.getFile("testresources/ws-repo-test"), tempDir);
+		try (Workspace ws = new Workspace(tempDir)) {
+			Project p = ws.getProject("p1");
+			String result = p.getReplacer()
+				.process("${repos}");
 			// Returns list of repositories - may be empty in test context
-			assertThat(result).isNotNull();
+			ensureDoesNotContainMacroLiteral(result);
+			assertThat(result).containsAnyOf("bnd-cache", "Release", "Repo");
 		}
 	}
 
@@ -1408,7 +1427,7 @@ public void testSystemAllowFail() throws IOException {
 
 			// Execute command that fails - should not throw
 			result = p.getReplacer().process("${system_allow_fail;false}");
-			assertThat(result).isNotNull();
+			ensureDoesNotContainMacroLiteral(result);
 		}
 	}
 
@@ -1518,5 +1537,10 @@ public void testWorkspace(@InjectTemporaryDirectory
 
 	}
 
+	private void ensureDoesNotContainMacroLiteral(String result) {
+		assertThat(result).isNotNull()
+			.doesNotContain("${");
+	}
+
 	// Additional tests can be added here for other macros
 }

docs/_macros/p_allsourcepath.md

@@ -47,8 +47,7 @@ All-Sources: ${p_allsourcepath}
 - Returns absolute paths
 - See also: `${p_sourcepath}` for project sources only
 
-<hr />
-TODO Needs review - AI Generated content
+
 
 ---
 

docs/_macros/p_bootclasspath.md

@@ -48,8 +48,7 @@ Boot-Classpath: ${p_bootclasspath}
 - See also: `${p_buildpath}` for project dependencies
 
 
-<hr />
-TODO Needs review - AI Generated content
+
 
 ---
 

docs/_macros/p_buildpath.md

@@ -53,8 +53,7 @@ dependency.count=${size;${split;,;${p_buildpath}}}
 - See also: `${p_testpath}` for test dependencies
 - See also: `${p_dependson}` for project dependencies
 
-<hr />
-TODO Needs review - AI Generated content
+
 
 ---
 

docs/_macros/p_dependson.md

@@ -47,8 +47,7 @@ Depends-On: ${p_dependson}
 - See also: `${p_buildpath}` for JAR dependencies
 
 
-<hr />
-TODO Needs review - AI Generated content
+
 
 ---
 

docs/_macros/p_output.md

@@ -52,8 +52,7 @@ classes.location=${p_output}/classes
 - See also: `${p_sourcepath}` for source directories
 - See also: `${basedir}` for project root
 
-<hr />
-TODO Needs review - AI Generated content
+
 
 ---
 

docs/_macros/p_sourcepath.md

@@ -48,8 +48,7 @@ Source-Directories: ${p_sourcepath}
 - See also: `${p_output}` for output directory
 
 
-<hr />
-TODO Needs review - AI Generated content
+
 
 ---
 

docs/_macros/p_testpath.md

@@ -48,8 +48,7 @@ Test-Dependencies: ${p_testpath}
 - See also: `${p_buildpath}` for compile dependencies
 
 
-<hr />
-TODO Needs review - AI Generated content
+
 
 ---