On createBuildConfiguration, reset project's ScannerInfoProvider

core/org.eclipse.cdt.core.tests/META-INF/MANIFEST.MF

@@ -45,12 +45,17 @@ Require-Bundle: org.eclipse.core.resources,
  org.eclipse.ltk.core.refactoring;bundle-version="3.4.0",
  org.hamcrest.core,
  org.hamcrest.library,
- com.google.gson;bundle-version="[2.8.6,3.0.0)"
+ com.google.gson;bundle-version="[2.8.6,3.0.0)",
+ org.eclipse.cdt.debug.core,
+ org.eclipse.cdt.cmake.core,
+ org.eclipse.debug.core
 Bundle-ActivationPolicy: lazy
 Bundle-Vendor: %providerName
 Bundle-RequiredExecutionEnvironment: JavaSE-17
 Automatic-Module-Name: org.eclipse.cdt.core.tests
 Bundle-Localization: plugin
 Import-Package: org.junit.jupiter.api;version="5.9.0",
  org.junit.jupiter.params;version="5.9.0",
- org.junit.jupiter.params.provider;version="5.9.0"
+ org.junit.jupiter.params.provider;version="5.9.0",
+ org.mockito;version="[5.12.0,6.0.0]",
+ org.mockito.stubbing;version="[5.12.0,6.0.0]"

core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/build/CBuildConfigurationManagerTests.java

@@ -0,0 +1,131 @@
+/*******************************************************************************
+ * Copyright (c) 2024 Renesas Electronics Europe.
+ *
+ * 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
+ * https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *******************************************************************************/
+package org.eclipse.cdt.core.build;
+
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+import org.eclipse.cdt.cmake.core.CMakeNature;
+import org.eclipse.cdt.cmake.core.internal.CMakeBuildConfigurationProvider;
+import org.eclipse.cdt.core.CCProjectNature;
+import org.eclipse.cdt.core.CCorePlugin;
+import org.eclipse.cdt.core.CProjectNature;
+import org.eclipse.cdt.core.parser.IScannerInfoProvider;
+import org.eclipse.cdt.core.testplugin.ResourceHelper;
+import org.eclipse.cdt.core.testplugin.util.BaseTestCase5;
+import org.eclipse.cdt.debug.core.CDebugCorePlugin;
+import org.eclipse.cdt.internal.core.language.settings.providers.LanguageSettingsScannerInfoProvider;
+import org.eclipse.core.resources.IBuildConfiguration;
+import org.eclipse.core.resources.IProject;
+import org.eclipse.core.resources.IProjectDescription;
+import org.eclipse.core.runtime.NullProgressMonitor;
+import org.eclipse.debug.core.ILaunchManager;
+import org.junit.jupiter.api.Test;
+
+public class CBuildConfigurationManagerTests extends BaseTestCase5 {
+	protected ICBuildConfigurationManager configManager = CDebugCorePlugin
+			.getService(ICBuildConfigurationManager.class);
+
+	/**
+	 * Tests that CBuildConfigurationManager.getBuildConfiguration(IProject, IToolChain, String, IProgressMonitor)
+	 * calls CCorePlugin.resetCachedScannerInfoProvider(IProject) after creating a new ICBuildConfiguration.
+	 *
+	 * Tests the following failure mode.
+	 * When the project's active IBuildConfiguration has the default name and the chosen ICBuildConfigurationProvider.
+	 * getCBuildConfiguration does not support the IBuildConfiguration.DEFAULT_CONFIG_NAME and returns null, this can
+	 * cause the project's ScannerInfoProvider to become "stuck"
+	 * (https://bugs.eclipse.org/bugs/show_bug.cgi?id=413357) on the wrong setting (eg
+	 * LanguageSettingsScannerInfoProvider instead of ICBuildConfiguration) until Eclipse is restarted or the project
+	 * is closed and reopened. When this happens, the indexer does not function.
+	 *
+	 * This problem may arise if an ISV contributes a ICBuildConfigurationProvider which has very specific naming
+	 * conventions for it's build configurations.
+	 *
+	 * Test approach:
+	 * The test requires that a faulty build configuration is setup for the project to trick the getScannerInfoProvider
+	 * into thinking it's not a core build project. Typically ContainerGCCToolChainProvider may find a valid gcc toolchain
+	 * and then the provider's getCBuildConfiguration will return a valid ICBuildConfiguration. So need to set the active
+	 * build configuration to one which does not use the default name.
+	 *
+	 * (1)
+	 * In a CMake project, add a new build configuration which doesn't use the default name and add this to the project
+	 * using an invalid ICBuildConfiguration and set this as the active build configuration.
+	 *
+	 * (2)
+	 * Later, when the indexer gets the project's active build configuration it is null and so the project's
+	 * IScannerInfoProvider is set to the wrong type and is cached.
+	 *
+	 * (3)
+	 * Later still, a new build configuration is created, this time with a valid ICBuildConfiguration, which is set as the
+	 * project's active build configuration.
+	 *
+	 * (4)
+	 * With the fix in place (resetCachedScannerInfoProvider), the next time the indexer gets the project's
+	 * IScannerInfoProvider it will be recomputed and return the project's expected IScannerInfoProvider
+	 * (ie: ICBuildConfiguration).
+	 */
+	@Test
+	public void testResetCachedScannerInfoProvider() throws Exception {
+		// (1) create a CMake project
+		IProject project = createCMakeProject();
+
+		CMakeBuildConfigurationProvider provider = new CMakeBuildConfigurationProvider();
+		String buildConfigBaseName = "notDefaultName";
+		// Create a new IBuildConfiguration with a name that is not the default name.
+		IBuildConfiguration buildConfiguration = configManager.createBuildConfiguration(provider, project,
+				buildConfigBaseName, new NullProgressMonitor());
+		// Add the IBuildConfiguration/ICBuildConfiguration combo using an invalid ICBuildConfiguration
+		configManager.addBuildConfiguration(buildConfiguration, null);
+		// Set the IBuildConfiguration, with this name, as the active build config
+		IProjectDescription description = project.getDescription();
+		String buildConfigName = provider.getId() + "/" + buildConfigBaseName;
+		description.setActiveBuildConfig(buildConfigName);
+		project.setDescription(description, new NullProgressMonitor());
+
+		// (2) The project's scannerInfoProvider is expected to be the wrong type here
+		IScannerInfoProvider scannerInfoProvider = CCorePlugin.getDefault().getScannerInfoProvider(project);
+		assertThat("scannerInfoProvider expected to be LanguageSettingsScannerInfoProvider",
+				scannerInfoProvider instanceof LanguageSettingsScannerInfoProvider);
+
+		// (3) Setup a toolchain ready to use for creating the valid ICBuildConfiguration
+		IToolChain mockToolchain = mock(IToolChain.class);
+		when(mockToolchain.getProperty(IToolChain.ATTR_OS)).thenReturn("osDummy");
+		when(mockToolchain.getProperty(IToolChain.ATTR_ARCH)).thenReturn("archDummy");
+		when(mockToolchain.getTypeId()).thenReturn("tc_typeId");
+		when(mockToolchain.getId()).thenReturn("tcId");
+		when(mockToolchain.getBuildConfigNameFragment()).thenReturn("buildConfigName");
+
+		ICBuildConfiguration cBuildConfiguration = configManager.getBuildConfiguration(project, mockToolchain,
+				ILaunchManager.RUN_MODE, new NullProgressMonitor());
+		assertThat("The cBuildConfiguration should of type CBuildConfiguration",
+				cBuildConfiguration instanceof CBuildConfiguration);
+		CBuildConfiguration cbc = (CBuildConfiguration) cBuildConfiguration;
+		// Set this ICBuildConfiguration as the active build configuration
+		cbc.setActive(new NullProgressMonitor());
+
+		// (4) The project's scannerInfoProvider is expected to be the correct type here
+		scannerInfoProvider = CCorePlugin.getDefault().getScannerInfoProvider(project);
+		assertThat("scannerInfoProvider expected to be ICBuildConfiguration",
+				scannerInfoProvider instanceof ICBuildConfiguration);
+	}
+
+	private IProject createCMakeProject() throws Exception {
+		// Create a  plain Eclipse project
+		IProject project = ResourceHelper.createProject(this.getName());
+		// Add C/C++ and CMake natures to make it a CMake project
+		IProjectDescription description = project.getDescription();
+		description.setNatureIds(
+				new String[] { CProjectNature.C_NATURE_ID, CCProjectNature.CC_NATURE_ID, CMakeNature.ID });
+		project.setDescription(description, null);
+		return project;
+	}
+}

core/org.eclipse.cdt.core/META-INF/MANIFEST.MF

@@ -2,7 +2,7 @@ Manifest-Version: 1.0
 Bundle-ManifestVersion: 2
 Bundle-Name: %pluginName
 Bundle-SymbolicName: org.eclipse.cdt.core; singleton:=true
-Bundle-Version: 8.4.200.qualifier
+Bundle-Version: 8.4.300.qualifier
 Bundle-Activator: org.eclipse.cdt.core.CCorePlugin
 Bundle-Vendor: %providerName
 Bundle-Localization: plugin

core/org.eclipse.cdt.core/src/org/eclipse/cdt/internal/core/build/CBuildConfigurationManager.java

@@ -320,7 +320,16 @@ public ICBuildConfiguration getBuildConfiguration(IProject project, IToolChain t
 		ICBuildConfigurationProvider provider = getProvider(project);
 		if (provider != null) {
 			// The provider will call us back to add in the new one
-			return provider.createBuildConfiguration(project, toolChain, launchMode, monitor);
+			ICBuildConfiguration cconfig = provider.createBuildConfiguration(project, toolChain, launchMode, monitor);
+			if (cconfig != null) {
+				/*
+				 * The IScannerInfoProvider may be cached with an incorrect value if the ICBuildConfiguration is not
+				 * available at the time it is checked. Now that one has been created, the previous value should be
+				 * forgotten so the new cconfig can be used.
+				 */
+				CCorePlugin.getDefault().resetCachedScannerInfoProvider(project);
+			}
+			return cconfig;
 		} else {
 			return null;
 		}