bug 416628: "Export" of entries of language settings providers to referencing projects - added provider to do that

3 files changed, 215 insertions, 2 deletions

diff --git a/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/AllLanguageSettingsProvidersCoreTests.java b/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/AllLanguageSettingsProvidersCoreTests.java
index f6542d6d709..0f9d6ca7b0c 100644
--- a/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/AllLanguageSettingsProvidersCoreTests.java
+++ b/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/AllLanguageSettingsProvidersCoreTests.java
@@ -30,6 +30,7 @@ public class AllLanguageSettingsProvidersCoreTests {
 		suite.addTest(LanguageSettingsPersistenceProjectTests.suite());
 		suite.addTest(LanguageSettingsListenersTests.suite());
 		suite.addTest(LanguageSettingsScannerInfoProviderTests.suite());
+		suite.addTest(LanguageSettingsProviderReferencedProjectsTests.suite());
 		return suite;
 	}
 }
diff --git a/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsManagerTests.java b/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsManagerTests.java
index 698c32bd2f7..29e2c578818 100644
--- a/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsManagerTests.java
+++ b/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsManagerTests.java
@@ -28,6 +28,7 @@ import org.eclipse.cdt.core.testplugin.CModelMock;
 import org.eclipse.cdt.core.testplugin.ResourceHelper;
 import org.eclipse.cdt.core.testplugin.util.BaseTestCase;
 import org.eclipse.cdt.internal.core.language.settings.providers.LanguageSettingsProvidersSerializer;
+import org.eclipse.cdt.internal.core.language.settings.providers.ReferencedProjectsLanguageSettingsProvider;
 import org.eclipse.cdt.internal.core.settings.model.CConfigurationDescription;
 import org.eclipse.cdt.internal.core.settings.model.CProjectDescriptionManager;
 import org.eclipse.core.resources.IFile;
@@ -703,8 +704,9 @@ public class LanguageSettingsManagerTests extends BaseTestCase {
 			// ensure no test provider is set yet but default providers
 			List<ILanguageSettingsProvider> providers = ((ILanguageSettingsProvidersKeeper) cfgDescription).getLanguageSettingProviders();
 			assertEquals(ScannerDiscoveryLegacySupport.USER_LANGUAGE_SETTINGS_PROVIDER_ID, providers.get(0).getId());
-			assertEquals(ScannerDiscoveryLegacySupport.MBS_LANGUAGE_SETTINGS_PROVIDER_ID, providers.get(1).getId());
-			assertEquals(2, providers.size());
+			assertEquals(ReferencedProjectsLanguageSettingsProvider.ID, providers.get(1).getId());
+			assertEquals(ScannerDiscoveryLegacySupport.MBS_LANGUAGE_SETTINGS_PROVIDER_ID, providers.get(2).getId());
+			assertEquals(3, providers.size());
 		}
 		{
 			// set test provider
diff --git a/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsProviderReferencedProjectsTests.java b/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsProviderReferencedProjectsTests.java
new file mode 100644
index 00000000000..35fdc7a1eae
--- /dev/null
+++ b/core/org.eclipse.cdt.core.tests/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsProviderReferencedProjectsTests.java
@@ -0,0 +1,210 @@
+/*******************************************************************************

+ * Copyright (c) 2013 Andrew Gvozdev and others.

+ * All rights reserved. This program and the accompanying materials

+ * are made available under the terms of the Eclipse Public License v1.0

+ * which accompanies this distribution, and is available at

+ * http://www.eclipse.org/legal/epl-v10.html

+ *

+ * Contributors:

+ *     Andrew Gvozdev - Initial API and implementation

+ *******************************************************************************/

+

+package org.eclipse.cdt.core.language.settings.providers;

+

+import java.util.ArrayList;

+import java.util.HashMap;

+import java.util.LinkedHashSet;

+import java.util.List;

+import java.util.Map;

+import java.util.Set;

+

+import junit.framework.TestSuite;

+

+import org.eclipse.cdt.core.model.CoreModel;

+import org.eclipse.cdt.core.settings.model.CIncludePathEntry;

+import org.eclipse.cdt.core.settings.model.ICConfigurationDescription;

+import org.eclipse.cdt.core.settings.model.ICLanguageSettingEntry;

+import org.eclipse.cdt.core.settings.model.ICProjectDescription;

+import org.eclipse.cdt.core.settings.model.ICProjectDescriptionManager;

+import org.eclipse.cdt.core.settings.model.ICSettingEntry;

+import org.eclipse.cdt.core.settings.model.util.CDataUtil;

+import org.eclipse.cdt.core.testplugin.ResourceHelper;

+import org.eclipse.cdt.core.testplugin.util.BaseTestCase;

+import org.eclipse.cdt.internal.core.language.settings.providers.ReferencedProjectsLanguageSettingsProvider;

+import org.eclipse.core.resources.IProject;

+import org.eclipse.core.runtime.CoreException;

+

+/**

+ * Test cases testing ReferencedProjectsLanguageSettingsProvider functionality

+ */

+public class LanguageSettingsProviderReferencedProjectsTests extends BaseTestCase {

+	/**

+	 * Constructor.

+	 * @param name - name of the test.

+	 */

+	public LanguageSettingsProviderReferencedProjectsTests(String name) {

+		super(name);

+

+	}

+

+	@Override

+	protected void setUp() throws Exception {

+		super.setUp();

+	}

+

+	@Override

+	protected void tearDown() throws Exception {

+		super.tearDown(); // includes ResourceHelper cleanup

+	}

+

+	/**

+	 * @return - new TestSuite.

+	 */

+	public static TestSuite suite() {

+		return new TestSuite(LanguageSettingsProviderReferencedProjectsTests.class);

+	}

+

+	/**

+	 * main function of the class.

+	 *

+	 * @param args - arguments

+	 */

+	public static void main(String[] args) {

+		junit.textui.TestRunner.run(suite());

+	}

+

+	/**

+	 * Helper method to fetch configuration descriptions.

+	 */

+	private ICConfigurationDescription[] getConfigurationDescriptions(IProject project) {

+		CoreModel coreModel = CoreModel.getDefault();

+		ICProjectDescriptionManager mngr = coreModel.getProjectDescriptionManager();

+		// project description

+		ICProjectDescription projectDescription = mngr.getProjectDescription(project, false);

+		assertNotNull(projectDescription);

+		assertEquals(1, projectDescription.getConfigurations().length);

+		// configuration description

+		ICConfigurationDescription[] cfgDescriptions = projectDescription.getConfigurations();

+		return cfgDescriptions;

+	}

+

+	/**

+	 * Helper method to set reference project.

+	 */

+	private void setReference(IProject project, final IProject projectReferenced) throws CoreException {

+		{

+			CoreModel coreModel = CoreModel.getDefault();

+			ICProjectDescriptionManager mngr = coreModel.getProjectDescriptionManager();

+			// project description

+			ICProjectDescription projectDescription = mngr.getProjectDescription(project);

+			assertNotNull(projectDescription);

+			assertEquals(1, projectDescription.getConfigurations().length);

+			// configuration description

+			ICConfigurationDescription[] cfgDescriptions = projectDescription.getConfigurations();

+			ICConfigurationDescription cfgDescription = cfgDescriptions[0];

+

+			final ICConfigurationDescription cfgDescriptionReferenced = getConfigurationDescriptions(projectReferenced)[0];

+			cfgDescription.setReferenceInfo(new HashMap<String, String>() {{ put(projectReferenced.getName(), cfgDescriptionReferenced.getId()); }});

+			coreModel.setProjectDescription(project, projectDescription);

+		}

+

+		{

+			// doublecheck that it's set as expected

+			ICConfigurationDescription[] cfgDescriptions = getConfigurationDescriptions(project);

+			ICConfigurationDescription cfgDescription = cfgDescriptions[0];

+			Map<String,String> refs = cfgDescription.getReferenceInfo();

+			assertEquals(1, refs.size());

+			Set<String> referencedProjectsNames = new LinkedHashSet<String>(refs.keySet());

+			assertEquals(projectReferenced.getName(), referencedProjectsNames.toArray()[0]);

+		}

+

+	}

+

+	/**

+	 * Test that null arguments don't crash the provider.

+	 */

+	public void testNulls() throws Exception {

+		ILanguageSettingsProvider provider = LanguageSettingsManager.getWorkspaceProvider(ReferencedProjectsLanguageSettingsProvider.ID);

+		assertNotNull(provider);

+		List<ICLanguageSettingEntry> entries = provider.getSettingEntries(null, null, null);

+		assertEquals(null, entries);

+	}

+

+	/**

+	 * Test main functionality of ReferencedProjectsLanguageSettingsProvider.

+	 */

+	public void testReferencedProjectProvider() throws Exception {

+		// Create model project and accompanied descriptions

+		String projectName = getName();

+		IProject project = ResourceHelper.createCDTProjectWithConfig(projectName);

+		IProject nonReferencedProject = ResourceHelper.createCDTProjectWithConfig(projectName+"-non-referenced");

+		IProject referencedProject = ResourceHelper.createCDTProjectWithConfig(projectName+"-referenced");

+		setReference(project, referencedProject);

+

+		// get cfgDescription and language to work with

+		ICConfigurationDescription[] cfgDescriptions = getConfigurationDescriptions(project);

+		ICConfigurationDescription cfgDescription = cfgDescriptions[0];

+

+		{

+			// doublecheck that provider for referenced projects is set in the configuration

+			ILanguageSettingsProvider refProjectsProvider = LanguageSettingsManager.getWorkspaceProvider(ReferencedProjectsLanguageSettingsProvider.ID);

+			assertNotNull(refProjectsProvider);

+			List<ILanguageSettingsProvider> providers = ((ILanguageSettingsProvidersKeeper) cfgDescription).getLanguageSettingProviders();

+			assertTrue(providers.contains(refProjectsProvider));

+		}

+

+		// Check that no setting entries are set initially

+		{

+			List<ICLanguageSettingEntry> entries = LanguageSettingsManager.getSettingEntriesByKind(cfgDescription, project, null, ICSettingEntry.ALL);

+			assertEquals(0, entries.size());

+		}

+

+		// Add an entry into a non-referenced project

+		CIncludePathEntry nonRefEntry = CDataUtil.createCIncludePathEntry("non-referenced-exported", ICSettingEntry.EXPORTED);

+		{

+			ICConfigurationDescription[] nonRefCfgDescriptions = getConfigurationDescriptions(nonReferencedProject);

+			ICConfigurationDescription nonRefCfgDescription = nonRefCfgDescriptions[0];

+			List<ILanguageSettingsProvider> providersNonRef = ((ILanguageSettingsProvidersKeeper) nonRefCfgDescription).getLanguageSettingProviders();

+			// get user provider which is the first one

+			ILanguageSettingsProvider userProviderNonRef = providersNonRef.get(0);

+			assertEquals(ScannerDiscoveryLegacySupport.USER_LANGUAGE_SETTINGS_PROVIDER_ID, userProviderNonRef.getId());

+			assertTrue(userProviderNonRef instanceof LanguageSettingsGenericProvider);

+			// add sample entries

+			ArrayList<ICLanguageSettingEntry> entries = new ArrayList<ICLanguageSettingEntry>();

+			entries.add(nonRefEntry);

+			((LanguageSettingsGenericProvider) userProviderNonRef).setSettingEntries(null, null, null, entries);

+		}

+		// Confirm that that does not add entries to the main project

+		{

+			List<ICLanguageSettingEntry> entries = LanguageSettingsManager.getSettingEntriesByKind(cfgDescription, project, null, ICSettingEntry.ALL);

+			assertEquals(0, entries.size());

+		}

+

+		CIncludePathEntry refEntry = CDataUtil.createCIncludePathEntry("referenced-exported", ICSettingEntry.EXPORTED);

+		// Add entries into a referenced project

+		{

+			ICConfigurationDescription[] refCfgDescriptions = getConfigurationDescriptions(referencedProject);

+			ICConfigurationDescription refCfgDescription = refCfgDescriptions[0];

+			List<ILanguageSettingsProvider> providersRef = ((ILanguageSettingsProvidersKeeper) refCfgDescription).getLanguageSettingProviders();

+			// get user provider which is the first one

+			ILanguageSettingsProvider userProviderRef = providersRef.get(0);

+			assertEquals(ScannerDiscoveryLegacySupport.USER_LANGUAGE_SETTINGS_PROVIDER_ID, userProviderRef.getId());

+			assertTrue(userProviderRef instanceof LanguageSettingsGenericProvider);

+			// add sample entries

+			ArrayList<ICLanguageSettingEntry> entries = new ArrayList<ICLanguageSettingEntry>();

+			CIncludePathEntry refEntryNotExported = CDataUtil.createCIncludePathEntry("referenced-not-exported", 0);

+			entries.add(refEntry);

+			entries.add(refEntryNotExported);

+			((LanguageSettingsGenericProvider) userProviderRef).setSettingEntries(null, null, null, entries);

+			List<ICLanguageSettingEntry> entriesActual = LanguageSettingsManager.getSettingEntriesByKind(refCfgDescription, project, null, ICSettingEntry.ALL);

+			assertEquals(entries, entriesActual);

+		}

+		// Check that the new entries from referenced project made it to the main project

+		{

+			List<ICLanguageSettingEntry> entries = LanguageSettingsManager.getSettingEntriesByKind(cfgDescription, project, null, ICSettingEntry.ALL);

+			assertEquals(CDataUtil.createCIncludePathEntry(refEntry.getName(), 0), entries.get(0));

+			assertEquals(1, entries.size());

+		}

+	}

+

+}