Merge branch 'master' into expand_collapse_Bar_in_UI

Author: elsazac

.github/copilot-instructions.md

@@ -0,0 +1,115 @@
+# Eclipse PDE - Copilot Coding Agent Instructions
+
+## Repository Overview
+
+**Eclipse PDE** provides Eclipse tooling for developing OSGi bundles and RCP applications. ~150MB, 384 bundles, 8 modules.
+
+**Stack:** Maven 3.3.1+ with Tycho 4.0.13, Java 17+ (CI: JDK 21), OSGi/Eclipse RCP, Tycho Surefire tests.
+
+**Critical:** Requires `eclipse-platform-parent` POM from Eclipse Platform aggregator. Standalone `mvn clean verify` will fail with parent resolution errors - this is expected.
+
+## Build & Test
+
+**Prerequisites:** Maven 3.3.1+, JDK 17+ (CI: JDK 21), display server for UI tests (xvnc/Xvfb)
+
+**CI Build (from Jenkinsfile):**
+```bash
+mvn clean verify -Dmaven.repo.local=$WORKSPACE/.m2/repository \
+    --fail-at-end --batch-mode --no-transfer-progress \
+    -Pbree-libs -Papi-check -Pjavadoc -Ptck \
+    -Dmaven.test.failure.ignore=true \
+    -Dcompare-version-with-baselines.skip=false
+```
+
+**Profiles:** `-Pbree-libs` (BREE check), `-Papi-check` (API baseline), `-Pjavadoc` (docs), `-Ptck` (TCK tests)
+
+**Maven Config (`.mvn/`):** Tycho 4.0.13 extension, `-Pbuild-individual-bundles`, `-DtrimStackTrace=false`
+
+**Tests:** ~1,045 test files. Results: `**/target/surefire-reports/*.xml`. UI tests need display server.
+
+**Artifacts:** `repository/target/repository/` (P2 site), `**/target/compilelogs/` (compile), `**/target/apianalysis/*.xml` (API)
+
+**Timeout:** CI build limit is 60 minutes.
+
+## Project Structure
+
+**8 Top-Level Modules (pom.xml):**
+- `apitools/` - API analysis, baseline checking (4 bundles including tests)
+- `ui/` - Main PDE UI (26 bundles: core, editors, launching, tests, spy tools)
+- `build/` - PDE Build (legacy, maintenance mode - use Tycho instead)
+- `ds/` - Declarative Services tooling
+- `e4tools/` - Eclipse 4 tools  
+- `ua/` - User Assistance
+- `features/` - 6 feature definitions
+- `org.eclipse.pde.doc.user/` - Documentation
+- `repository/` - P2 repository (not in default build)
+
+**Root Files:** `pom.xml` (parent: eclipse-platform-parent:4.38.0-SNAPSHOT), `Jenkinsfile`, `.mvn/` config, `prepareNextDevCycle.sh`
+
+**Bundle Structure:** `META-INF/MANIFEST.MF`, `build.properties`, `plugin.xml`, `src/`, `.project`, `pom.xml`
+
+## CI/CD & Quality Gates
+
+**GitHub Workflows (.github/workflows/):**
+- `ci.yml` - Main build (triggers: push/PR to master): license check + `mvn clean verify -Ptck`
+- `pr-checks.yml` - PR validations: freeze period, no merge commits, version increments (bot: "Eclipse PDE Bot")
+- `unit-tests.yml` - Publishes test results
+- `version-increments.yml` - Publishes version check results
+- `checkDependencies.yml` - Daily dependency range validation
+- `codeql.yml`, `htmlvalidator.yml`, `licensecheck.yml`, `doCleanCode.yml` - Additional checks
+
+**Quality Gates (Jenkinsfile):** Compiler warnings (`**/target/compilelogs/*.xml`), API issues (`**/target/apianalysis/*.xml`), Maven console, Javadoc errors. Threshold: 1 NEW issue → unstable.
+
+**Pre-commit Validation:** Run `mvn clean verify -Ptck`, check version increments, review `**/target/compilelogs/` and `**/target/apianalysis/`
+
+## Common Issues & Solutions
+
+**Parent POM not found:** Expected - requires eclipse-platform-parent from Eclipse Platform aggregator.
+
+**API baseline violations:** Update bundle version per Eclipse API rules. See `docs/API_Tools.md`.
+
+**Test failures (headless):** Use `xvfb-run mvn clean verify` or set DISPLAY.
+
+**Build timeout >60 min:** Review added tests/code for performance impact.
+
+## API Tools & Versioning
+
+**API Baseline:** Verifies binary compatibility. Critical for CI.
+
+**Javadoc Tags:** `@noimplement`, `@noextend`, `@noreference`, `@noinstantiate`, `@nooverride`, `@category`
+
+**Version Rules:** Service (compatible fixes), Minor (API additions), Major (breaking changes). Missing `@since` = error.
+
+**Docs:** `docs/API_Tools.md` for comprehensive API Tools documentation.
+
+## OSGi Semantic Versioning
+
+**PDE follows OSGi semantic versioning principles** (https://docs.osgi.org/whitepaper/semantic-versioning/):
+
+**Version Format:** `major.minor.micro.qualifier`
+- **Major:** Breaking changes (incompatible API changes)
+- **Minor:** Backward-compatible API additions
+- **Micro:** Backward-compatible bug fixes
+- **Qualifier:** Build metadata (e.g., timestamps, commit hashes)
+
+**Version Ranges for Dependencies:**
+- Use version ranges to specify compatible dependency versions
+- **Inclusive lower bound:** `[1.2.3,2.0.0)` includes 1.2.3
+- **Exclusive upper bound:** `[1.2.3,2.0.0)` excludes 2.0.0
+- **Best practice:** Lower bound inclusive, upper bound at next major (exclusive)
+  - Example: For version `1.2.3`, use `[1.2.3,2.0.0)` to accept any 1.x version
+  - Example: For version `2.5.0`, use `[2.5.0,3.0.0)` to accept any 2.x version
+
+**Why exclude next major?** Major version changes indicate breaking changes, so dependencies should not automatically upgrade across major versions.
+
+**PDE Support:** PDE manifest editor and dialogs should help users create proper version ranges following these principles when adding or updating bundle/package dependencies.
+
+## Key Notes
+
+**Tycho:** Eclipse-specific Maven extension managing OSGi dependencies, P2 repos, Eclipse metadata (MANIFEST.MF, plugin.xml, feature.xml).
+
+**PDE Build (`build/`):** Maintenance mode. Use Tycho for new projects. Only IDE export bugs fixed.
+
+**Development:** Use Oomph for IDE setup: `https://raw.githubusercontent.com/eclipse-pde/eclipse.pde/master/releng/org.eclipse.pde.setup/PDEConfiguration.setup`
+
+**Trust These Instructions:** Only search if incomplete, encountering undocumented errors, or instructions appear outdated. Consult: `Jenkinsfile` (CI config), `README.md`, `docs/` (API Tools, FAQ, User Guide), `.github/workflows/` (pipelines).

.github/workflows/doCleanCode.yml

@@ -14,6 +14,6 @@ jobs:
       author: Eclipse PDE Bot <pde-bot@eclipse.org>
       do-quickfix: false
       do-cleanups: true
-      bundle-folders: ui/*/ ua/*/ ds/*/ build/*/ apitools/*/ e4tools/*/
+      bundle-folders: ui/*/ ua/*/ ds/*/ build/*/ apitools/*/ e4tools/bundles/*/
     secrets:
       token: ${{ secrets.PDE_BOT_PAT }}

.github/workflows/htmlvalidator.yml

@@ -0,0 +1,17 @@
+name: HTML Check
+
+on:
+  pull_request:
+    paths:
+      - '**.htm*'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v5 # Requried will all actions
+    - name: Checks HTML5
+      uses: Cyb3r-Jak3/html5validator-action@v8.0.0
+      with:
+        root: /github/workspace/org.eclipse.pde.doc.user
+        blacklist: about.html notices.html

apitools/org.eclipse.pde.api.tools.tests/META-INF/MANIFEST.MF

@@ -2,7 +2,7 @@ Manifest-Version: 1.0
 Bundle-ManifestVersion: 2
 Bundle-Name: %Bundle-Name
 Bundle-SymbolicName: org.eclipse.pde.api.tools.tests
-Bundle-Version: 1.4.200.qualifier
+Bundle-Version: 1.4.300.qualifier
 Bundle-Vendor: %Bundle-Vendor
 Require-Bundle: org.eclipse.core.runtime,
  org.eclipse.pde.api.tools;bundle-version="1.0.600",

apitools/org.eclipse.pde.api.tools.tests/pom.xml

@@ -14,11 +14,11 @@
 	<parent>
 		<groupId>org.eclipse.pde</groupId>
 		<artifactId>eclipse.pde</artifactId>
-		<version>4.37.0-SNAPSHOT</version>
+		<version>4.38.0-SNAPSHOT</version>
 		<relativePath>../../</relativePath>
 	</parent>
 	<artifactId>org.eclipse.pde.api.tools.tests</artifactId>
-	<version>1.4.200-SNAPSHOT</version>
+	<version>1.4.300-SNAPSHOT</version>
 	<packaging>eclipse-test-plugin</packaging>
 	<properties>
 		<defaultSigning-excludeInnerJars>true</defaultSigning-excludeInnerJars>

apitools/org.eclipse.pde.api.tools.tests/src/org/eclipse/pde/api/tools/builder/tests/compatibility/ProjectTypeContainerTests.java

@@ -250,4 +250,36 @@ public void visit(String packageName, IApiTypeRoot typeroot) {
 		assertThat(pkgNames).containsAll(getAllPackageNames());
 	}
 
+	/**
+	 * Tests that packages are correctly discovered in projects with multiple
+	 * source folders that share the same output folder. This is a regression
+	 * test for issue #2096 where packages were missing when multiple source
+	 * folders output to the same location.
+	 */
+	public void testMultipleSourceFoldersWithSharedOutput() throws CoreException {
+		IApiComponent component = getComponent("bundle.multisource"); //$NON-NLS-1$
+		IApiTypeContainer[] containers = component.getApiTypeContainers();
+		assertEquals("Wrong number of API type containers", 1, containers.length); //$NON-NLS-1$
+		IApiTypeContainer container = containers[0];
+		assertEquals("Should be a composite type container", IApiTypeContainer.COMPOSITE, //$NON-NLS-1$
+				container.getContainerType());
+
+		String[] packageNames = container.getPackageNames();
+		Set<String> pkgSet = new HashSet<>();
+		for (String pkg : packageNames) {
+			pkgSet.add(pkg);
+		}
+
+		// Both packages from different source folders should be found
+		assertTrue("Missing package test.pkg1 from src1 folder", pkgSet.contains("test.pkg1")); //$NON-NLS-1$ //$NON-NLS-2$
+		assertTrue("Missing package test.pkg2 from src2 folder", pkgSet.contains("test.pkg2")); //$NON-NLS-1$ //$NON-NLS-2$
+
+		// Verify we can find types from both source folders
+		IApiTypeRoot type1 = container.findTypeRoot("test.pkg1.TestClass1"); //$NON-NLS-1$
+		assertNotNull("Should find TestClass1 from src1", type1); //$NON-NLS-1$
+
+		IApiTypeRoot type2 = container.findTypeRoot("test.pkg2.TestClass2"); //$NON-NLS-1$
+		assertNotNull("Should find TestClass2 from src2", type2); //$NON-NLS-1$
+	}
+
 }

apitools/org.eclipse.pde.api.tools.tests/src/org/eclipse/pde/api/tools/builder/tests/leak/InterfaceExtendsLeak.java

@@ -371,4 +371,28 @@ private void x14(boolean inc) {
 		String typename = "Etest14"; //$NON-NLS-1$
 		deployLeakTest(typename + ".java", inc);//$NON-NLS-1$
 	}
+
+	/**
+	 * Tests that a static inner class implementing its parent interface does NOT produce
+	 * a leak warning (inner class referencing enclosing type should be excluded)
+	 * using a full build
+	 */
+	public void testStaticInnerClassImplementsParent15F() {
+		x15(false);
+	}
+
+	/**
+	 * Tests that a static inner class implementing its parent interface does NOT produce
+	 * a leak warning (inner class referencing enclosing type should be excluded)
+	 * using an incremental build
+	 */
+	public void testStaticInnerClassImplementsParent15I() {
+		x15(true);
+	}
+
+	private void x15(boolean inc) {
+		expectingNoProblems();
+		String typename = "Etest15"; //$NON-NLS-1$
+		deployLeakTest(typename + ".java", inc);//$NON-NLS-1$
+	}
 }

apitools/org.eclipse.pde.api.tools.tests/src/org/eclipse/pde/api/tools/model/tests/ApiDescriptionTests.java

@@ -800,4 +800,38 @@ public void testBinaryHasApiDescription() throws CoreException {
 		IApiComponent componentA = profile.getApiComponent("component.a"); //$NON-NLS-1$
 		assertTrue("Should have an .api_description file", componentA.hasApiDescription()); //$NON-NLS-1$
 	}
+
+	/**
+	 * Tests that nested types with restrictions are persisted in XML.
+	 * This is a regression test for issue #1949 where nested classes marked
+	 * with @noreference were not being included in the .api_description file.
+	 */
+	@Test
+	public void testNestedTypesWithRestrictionsPersisted() throws CoreException {
+		// Create an API description with an outer class and a nested class with restrictions
+		IApiDescription description = newDescription();
+
+		// Set package visibility to API
+		description.setVisibility(Factory.packageDescriptor("test.pkg"), VisibilityModifiers.API); //$NON-NLS-1$
+
+		// Nested class with @noreference restriction
+		IReferenceTypeDescriptor nestedType = Factory.typeDescriptor("test.pkg.OuterClass$NestedClass"); //$NON-NLS-1$
+		description.setRestrictions(nestedType, RestrictionModifiers.NO_REFERENCE);
+
+		// Create component and generate XML
+		IApiComponent component = TestSuiteHelper.createTestingApiComponent("test", "test", description); //$NON-NLS-1$ //$NON-NLS-2$
+		Document xml = getApiDescriptionXML(component);
+		String xmlString = Util.serializeDocument(xml);
+
+		// Verify the XML contains the nested type
+		assertTrue("XML should contain nested type", xmlString.contains("OuterClass$NestedClass")); //$NON-NLS-1$ //$NON-NLS-2$
+
+		// Restore from XML and verify the restriction is preserved
+		IApiDescription restored = new ApiDescription(null);
+		ApiDescriptionProcessor.annotateApiSettings(null, restored, xmlString);
+
+		IApiAnnotations annotations = restored.resolveAnnotations(nestedType);
+		assertEquals("Nested type should have NO_REFERENCE restriction", //$NON-NLS-1$
+				RestrictionModifiers.NO_REFERENCE, annotations.getRestrictions());
+	}
 }

apitools/org.eclipse.pde.api.tools.tests/src/org/eclipse/pde/api/tools/model/tests/TestSuiteHelper.java

@@ -433,6 +433,27 @@ public static void addAllRequired(IApiBaseline baseline, Set<String> done, IApiC
 				}
 			}
 		}
+		// The org.eclipse.core.contenttype bundle has new requirement for 4.38.
+		// Require-Capability: osgi.extender;
+		// filter:="(&(osgi.extender=osgi.component)(version>=1.2)(!(version>=2.0)))"
+		// We need to manually add non-bundle requirements as a result.
+		if (component.getSymbolicName().equals("org.eclipse.core.contenttype")) { //$NON-NLS-1$
+			@SuppressWarnings("nls")
+			String[] others = new String[] { "org.apache.felix.scr", "org.osgi.service.component",
+					"org.osgi.util.promise", "org.osgi.util.function" };
+			for (String implicit : others) {
+				if (!done.contains(implicit)) {
+					File bundle = getBundle(implicit);
+					if (bundle != null) {
+						IApiComponent apiComponent = ApiModelFactory.newApiComponent(baseline,
+								bundle.getAbsolutePath());
+						collection.add(apiComponent);
+						done.add(apiComponent.getSymbolicName());
+						addAllRequired(baseline, done, apiComponent, collection);
+					}
+				}
+			}
+		}
 		if (error) {
 			throw new CoreException(Status.error("Check the property : -DrequiredBundles=...\nMissing required bundle(s): " + String.valueOf(buffer))); //$NON-NLS-1$
 		}

apitools/org.eclipse.pde.api.tools.tests/test-builder/baseline/bundle.multisource/.classpath

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<classpath>
+	<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-17"/>
+	<classpathentry kind="con" path="org.eclipse.pde.core.requiredPlugins"/>
+	<classpathentry kind="src" path="src1"/>
+	<classpathentry kind="src" path="src2"/>
+	<classpathentry kind="output" path="bin"/>
+</classpath>