[backport] Refactor some usages of TychoProjectUtils

.github/workflows/maven.yml

@@ -23,9 +23,9 @@ jobs:
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
     steps:
-    - uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # v3.5.3
+    - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
     - name: Set up Java
-      uses: actions/setup-java@5ffc13f4174014e2d4d4572b3d74c3fa61aeb2c2 # v3.11.0
+      uses: actions/setup-java@387ac29b308b003ca37ba93a6cab5eb57c8f5f93 # v4.0.0
       with:
         java-version: |
             8
@@ -34,7 +34,7 @@ jobs:
             17
         distribution: 'temurin'
     - name: Cache local Maven repository
-      uses: actions/cache@88522ab9f39a2ea568f7027eddc7d8d8bc9d59c8 # v3.3.1
+      uses: actions/cache@704facf57e6136b1bc63b828d79edcd491f0ee84 # v3.3.2
       with:
         path: ~/.m2/repository
         key: ${{ runner.os }}-tycho4m39-${{ matrix.os }}-${{ hashFiles('**/pom.xml', '**/*.target') }}
@@ -51,7 +51,7 @@ jobs:
         cp .github/toolchains.xml ~/.m2/toolchains.xml
         mvn -U -V -e -B -ntp clean install --file pom.xml -DtrimStackTrace=false -Pits -fae
     - name: Upload Test Results
-      uses: actions/upload-artifact@0b7f8abb1508181956e8e162db84b466c27e18ce # v3.1.2
+      uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 # v3.1.3
       if: always()
       with:
         name: test-results-${{ matrix.os }}
@@ -63,7 +63,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Upload
-      uses: actions/upload-artifact@0b7f8abb1508181956e8e162db84b466c27e18ce # v3.1.2
+      uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 # v3.1.3
       with:
         name: Event File
         path: ${{ github.event_path }}

p2-maven-plugin/src/main/java/org/eclipse/tycho/p2maven/transport/URLHttpTransportFactory.java

@@ -63,7 +63,7 @@ public void setHeader(String key, String value) {
 		public Response<InputStream> get() throws IOException {
 			HttpURLConnection connection = createConnection();
 			connection.connect();
-			return new HttpResponse<InputStream>(connection) {
+			return new HttpResponse<>(connection) {
 
 				@Override
 				public void close() {
@@ -111,7 +111,7 @@ public Response<Void> head() throws IOException {
 			HttpURLConnection connection = createConnection();
 			connection.setRequestMethod("HEAD");
 			connection.connect();
-			return new HttpResponse<Void>(connection) {
+			return new HttpResponse<>(connection) {
 
 				@Override
 				public void close() {

sisu-osgi/sisu-osgi-connect/pom.xml

@@ -35,6 +35,11 @@
 			<groupId>commons-io</groupId>
 			<artifactId>commons-io</artifactId>
 		</dependency>
+		<dependency>
+			<groupId>org.eclipse.platform</groupId>
+			<artifactId>org.eclipse.equinox.registry</artifactId>
+			<version>3.11.400</version>
+		</dependency>
   </dependencies>
 
   <build>

sisu-osgi/sisu-osgi-connect/src/main/java/org/eclipse/sisu/osgi/connect/PlexusFrameworkConnectServiceFactory.java

@@ -45,6 +45,10 @@
 import org.codehaus.plexus.personality.plexus.lifecycle.phase.Initializable;
 import org.codehaus.plexus.personality.plexus.lifecycle.phase.InitializationException;
 import org.codehaus.plexus.util.StringUtils;
+import org.eclipse.core.runtime.IConfigurationElement;
+import org.eclipse.core.runtime.IExtension;
+import org.eclipse.core.runtime.IExtensionPoint;
+import org.eclipse.core.runtime.IExtensionRegistry;
 import org.eclipse.sisu.equinox.EquinoxServiceFactory;
 import org.eclipse.sisu.equinox.embedder.EquinoxLifecycleListener;
 import org.osgi.framework.Bundle;
@@ -152,8 +156,8 @@ synchronized PlexusConnectFramework getFramework(ClassRealm realm) throws Bundle
 		for (EquinoxLifecycleListener listener : lifecycleListeners.values()) {
 			connectFramework.debug("Calling " + listener);
 			try {
-			listener.afterFrameworkStarted(connectFramework);
-			} catch(RuntimeException e) {
+				listener.afterFrameworkStarted(connectFramework);
+			} catch (RuntimeException e) {
 				log.warn("Internal error in EquinoxLifecycleListener " + listener, e);
 			}
 		}
@@ -238,6 +242,62 @@ private static Map<String, String> readProperties(ClassLoader classloader, Logge
 
 	private static void printFrameworkState(Framework framework, Logger log) {
 		Bundle[] bundles = printBundles(framework, log);
+		printComponents(framework, log);
+		printExtensions(framework, log);
+		printServices(log, bundles);
+	}
+
+	private static void printExtensions(Framework framework, Logger log) {
+		log.info("============ Extension Registry ==================");
+		ServiceTracker<IExtensionRegistry, IExtensionRegistry> st = new ServiceTracker<>(framework.getBundleContext(),
+				IExtensionRegistry.class, null);
+		st.open(true);
+		try {
+			IExtensionRegistry registry = st.getService();
+			if (registry == null) {
+				log.info("No IExtensionRegistry installed (or started) in this framework");
+				return;
+			}
+			IExtensionPoint[] extensionPoints = registry.getExtensionPoints();
+			for (IExtensionPoint point : extensionPoints) {
+				log.info(point.getUniqueIdentifier() + " [contributed by " + point.getContributor() + "]");
+				for (IExtension extention : point.getExtensions()) {
+					log.info("\t" + extention.getUniqueIdentifier() + " [from " + extention.getContributor().getName()
+							+ "]");
+					for (IConfigurationElement element : extention.getConfigurationElements()) {
+						printConfigElement(element, 2, log);
+					}
+				}
+			}
+		} finally {
+			st.close();
+		}
+	}
+
+
+
+	private static void printConfigElement(IConfigurationElement element, int level, Logger log) {
+		StringBuilder sb = new StringBuilder();
+		sb.append("\t".repeat(level));
+		sb.append(element.getName());
+		for (String attr : element.getAttributeNames()) {
+			sb.append(' ');
+			sb.append(attr);
+			sb.append('=');
+			sb.append(element.getAttribute(attr));
+		}
+		String value = element.getValue();
+		if (value != null) {
+			sb.append(" @value = ");
+			sb.append(value);
+		}
+		log.info(sb.toString());
+		for (IConfigurationElement child : element.getChildren()) {
+			printConfigElement(child, level + 1, log);
+		}
+	}
+
+	private static void printComponents(Framework framework, Logger log) {
 		ServiceTracker<ServiceComponentRuntime, ServiceComponentRuntime> st = new ServiceTracker<>(
 				framework.getBundleContext(), ServiceComponentRuntime.class, null);
 		st.open();
@@ -268,6 +328,9 @@ private static void printFrameworkState(Framework framework, Logger log) {
 		} finally {
 			st.close();
 		}
+	}
+
+	private static void printServices(Logger log, Bundle[] bundles) {
 		log.info("============ Registered Services ==================");
 		Arrays.stream(bundles).map(Bundle::getRegisteredServices).filter(Objects::nonNull).flatMap(Arrays::stream)
 				.forEach(reference -> {

tycho-api/src/main/java/org/eclipse/tycho/FileLockService.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2011 SAP AG and others.
+ * Copyright (c) 2011, 2023 SAP AG and others.
  * This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License 2.0
  * which accompanies this distribution, and is available at
@@ -13,6 +13,7 @@
 
 package org.eclipse.tycho;
 
+import java.io.Closeable;
 import java.io.File;
 
 /**
@@ -21,10 +22,25 @@
 public interface FileLockService {
 
     /**
-     * Get a locker object which can be used to protect read/write access from multiple processes on
-     * the given file. Locking is advisory only, i.e. all processes must use the same locking
-     * mechanism.
+     * Locks the given file to protect read/write access from multiple processes on it. Locking is
+     * advisory only, i.e. all processes must use the same locking mechanism.
+     * <p>
+     * This is equivalent to {@link #lock(File, long)} with a timeout argument of 10 seconds.
+     * </p>
      */
-    public FileLocker getFileLocker(File file);
+    default Closeable lock(File file) {
+        return lock(file, 10000L);
+    }
 
+    /**
+     * Locks the given file to protect read/write access from multiple processes on it. Locking is
+     * advisory only, i.e. all processes must use the same locking mechanism.
+     */
+    Closeable lock(File file, long timeout);
+
+    /**
+     * Locks the given file for this JVM to protect read/write access from multiple threads in this
+     * JVM on it.
+     */
+    Closeable lockVirtually(File file);
 }

tycho-api/src/main/java/org/eclipse/tycho/TychoConstants.java

@@ -20,6 +20,8 @@ public interface TychoConstants {
 
     public static final String ECLIPSE_LATEST = "https://download.eclipse.org/releases/2023-12/";
 
+    public static final String TYCHO_NOT_CONFIGURED = "Tycho build extension not configured for ";
+
     static final String ANY_QUALIFIER = "qualifier";
 
     static final boolean USE_SMART_BUILDER = Boolean

tycho-bnd-plugin/src/main/java/org/eclipse/tycho/bnd/maven/BndMavenLifecycleParticipant.java

@@ -71,7 +71,7 @@ public void afterProjectsRead(MavenSession session) throws MavenExecutionExcepti
 		Map<MavenProject, Project> bndProjects = getProjects(session);
 		Map<String, MavenProject> manifestFirstProjects = getManifestFirstProjects(session, bndProjects.keySet());
 		Map<String, MavenProject> bndWorkspaceProjects = bndProjects.entrySet().stream()
-				.collect(Collectors.toMap(e -> e.getValue().getName(), e -> e.getKey(), (a, b) -> {
+				.collect(Collectors.toMap(e -> e.getValue().getName(), Entry<MavenProject, Project>::getKey, (a, b) -> {
 					logger.warn(
 							"Your reactor build contains duplicate BND projects from different workspace, build order might be insufficient!");
 					logger.warn("\tProject 1 (selected): " + a.getBasedir());
@@ -166,8 +166,8 @@ private Map<String, MavenProject> getManifestFirstProjects(MavenSession session,
 	}
 
 	private Map<MavenProject, Project> getProjects(MavenSession session) {
-		Set<Workspace> workspaces = new HashSet<Workspace>();
-		HashMap<MavenProject, Project> result = new HashMap<MavenProject, Project>();
+		Set<Workspace> workspaces = new HashSet<>();
+		HashMap<MavenProject, Project> result = new HashMap<>();
 		for (MavenProject mavenProject : session.getProjects()) {
 			if (isBNDProject(mavenProject)) {
 				try {
@@ -203,13 +203,6 @@ static boolean isBNDProject(MavenProject mavenProject) {
 		}
 	}
 
-	private void setProperty(Project project, String key, String value) {
-		String property = project.getProperty(key);
-		if (property == null || property.isBlank()) {
-			project.setProperty(key, value);
-		}
-	}
-
 	private void logError(String msg, Exception e) {
 		if (logger.isDebugEnabled()) {
 			logger.error(msg, e);

tycho-compiler-plugin/src/main/java/org/eclipse/tycho/compiler/AbstractOsgiCompilerMojo.java

@@ -330,7 +330,6 @@ public abstract class AbstractOsgiCompilerMojo extends AbstractCompilerMojo impl
      * And a configuration:
      * 
      * <configuration>
-     *   <logEnabled>true</logEnabled>
      *   <logDirectory>${project.build.directory}/logfiles</logDirectory>
      *   <log>xml</log> 
      * </configuration>
@@ -883,12 +882,12 @@ private ExecutionEnvironment getTargetExecutionEnvironment() {
 
     @Override
     public List<ClasspathEntry> getClasspath() throws MojoExecutionException {
-        ReactorProject reactorProject = DefaultReactorProject.adapt(project);
         List<ClasspathEntry> classpath;
         String dependencyScope = getDependencyScope();
         if (Artifact.SCOPE_TEST.equals(dependencyScope)) {
             classpath = new ArrayList<>(getBundleProject().getTestClasspath(DefaultReactorProject.adapt(project)));
         } else {
+            ReactorProject reactorProject = DefaultReactorProject.adapt(project);
             classpath = new ArrayList<>(getBundleProject().getClasspath(reactorProject));
         }
         if (extraClasspathElements != null) {
@@ -940,7 +939,7 @@ public List<ClasspathEntry> getClasspath() throws MojoExecutionException {
                 }
             }
         }
-        List<ClasspathEntry> uniqueClasspath = classpathMap.entrySet().stream().flatMap(entry -> {
+        return classpathMap.entrySet().stream().flatMap(entry -> {
             List<ClasspathEntry> list = entry.getValue();
             if (list.isEmpty()) {
                 return Stream.empty();
@@ -949,7 +948,7 @@ public List<ClasspathEntry> getClasspath() throws MojoExecutionException {
                 return list.stream();
             }
             ArtifactKey key = entry.getKey();
-            ReactorProject compositeProject = findProjectForKey(reactorProject, key);
+            ReactorProject compositeProject = findProjectForKey(key);
             List<File> compositeFiles = list.stream().flatMap(cpe -> cpe.getLocations().stream()).toList();
             Collection<AccessRule> compositeRules = mergeRules(list);
             return Stream.of(new ClasspathEntry() {
@@ -984,7 +983,6 @@ public String toString() {
 
             });
         }).toList();
-        return uniqueClasspath;
     }
 
     private ArtifactKey normalizedKey(ArtifactKey key) {
@@ -1014,7 +1012,7 @@ private Collection<AccessRule> mergeRules(List<ClasspathEntry> list) {
         return joinedRules;
     }
 
-    private ReactorProject findProjectForKey(ReactorProject root, ArtifactKey key) {
+    private ReactorProject findProjectForKey(ArtifactKey key) {
         for (MavenProject p : session.getProjects()) {
             ReactorProject rp = DefaultReactorProject.adapt(p);
             try {

tycho-compiler-plugin/src/main/java/org/eclipse/tycho/compiler/ValidateClassPathMojo.java

@@ -24,10 +24,10 @@
 import org.apache.maven.plugins.annotations.ResolutionScope;
 import org.apache.maven.project.MavenProject;
 import org.eclipse.tycho.ReactorProject;
+import org.eclipse.tycho.TychoConstants;
 import org.eclipse.tycho.core.TychoProject;
 import org.eclipse.tycho.core.osgitools.DefaultReactorProject;
 import org.eclipse.tycho.core.osgitools.OsgiBundleProject;
-import org.eclipse.tycho.core.utils.TychoProjectUtils;
 
 /**
  * This mojo could be added to a build if validation of the classpath is desired before the
@@ -48,7 +48,7 @@ public void execute() throws MojoExecutionException, MojoFailureException {
         TychoProject projectType = projectTypes.get(project.getPackaging());
         if (projectType instanceof OsgiBundleProject bundleProject) {
             ReactorProject reactorProject = DefaultReactorProject.adapt(project);
-            if (TychoProjectUtils.getOptionalDependencyArtifacts(reactorProject).isPresent()) {
+            if (reactorProject.getContextValue(TychoConstants.CTX_DEPENDENCY_ARTIFACTS) != null) {
                 bundleProject.getClasspath(reactorProject);
             } else {
                 getLog().info("Skipped classpath validation as project is currently not resolved");

tycho-core/src/main/java/org/eclipse/tycho/core/bnd/PdeInstallableUnitProvider.java

@@ -97,8 +97,7 @@ public Collection<IInstallableUnit> getInstallableUnits(MavenProject project, Ma
                             Version version = new MavenVersion(project.getVersion()).getOSGiVersion();
                             pr.setProperty(Constants.BUNDLE_VERSION, version.toString());
                         }
-                        Collection<Dependency> dependencies = collectInitial(project, new HashMap<String, Dependency>())
-                                .values();
+                        Collection<Dependency> dependencies = collectInitial(project, new HashMap<>()).values();
                         return generateWithProcessor(project, pr, mavenDependenciesResolver.resolve(project,
                                 dependencies, Set.of(Artifact.SCOPE_COMPILE, Artifact.SCOPE_TEST), session));
                     } catch (Exception e) {