Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: e5c4cb5fe1cc80e6c6c01c83502947c529797143 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
/*******************************************************************************
 * Copyright (c) 2010, 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.managedbuilder.language.settings.providers.tests;

import java.util.ArrayList;
import java.util.List;

import org.eclipse.cdt.core.language.settings.providers.ILanguageSettingsProvider;
import org.eclipse.cdt.core.language.settings.providers.ILanguageSettingsProvidersKeeper;
import org.eclipse.cdt.core.language.settings.providers.LanguageSettingsManager;
import org.eclipse.cdt.core.language.settings.providers.LanguageSettingsPersistenceProjectTests;
import org.eclipse.cdt.core.language.settings.providers.ScannerDiscoveryLegacySupport;
import org.eclipse.cdt.core.model.CoreModel;
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.testplugin.util.BaseTestCase;
import org.eclipse.cdt.internal.core.language.settings.providers.ReferencedProjectsLanguageSettingsProvider;
import org.eclipse.cdt.managedbuilder.testplugin.ManagedBuildTestHelper;
import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IProject;

/**
 * Test creation of a new project in respect with language settings providers.
 */
public class LanguageSettingsProvidersMBSTest extends BaseTestCase {
	private static final String MBS_LANGUAGE_SETTINGS_PROVIDER_ID = ScannerDiscoveryLegacySupport.MBS_LANGUAGE_SETTINGS_PROVIDER_ID;
	private static final String REFERENCED_PROJECTS_PROVIDER_ID = ReferencedProjectsLanguageSettingsProvider.ID;
	/* This extension comes from org.eclipse.cdt.ui which is why this test plug-in depends on it */
	private static final String USER_LANGUAGE_SETTINGS_PROVIDER_ID = ScannerDiscoveryLegacySupport.USER_LANGUAGE_SETTINGS_PROVIDER_ID;
	private static final String GCC_SPECS_DETECTOR_ID = "org.eclipse.cdt.managedbuilder.core.GCCBuiltinSpecsDetector";
	private static final String PROJECT_TYPE_EXECUTABLE_GNU = "cdt.managedbuild.target.gnu.exe";
	private static final String LANGUAGE_SETTINGS_PROJECT_XML = LanguageSettingsPersistenceProjectTests.LANGUAGE_SETTINGS_PROJECT_XML;
	private static final String LANGUAGE_SETTINGS_WORKSPACE_XML = LanguageSettingsPersistenceProjectTests.LANGUAGE_SETTINGS_WORKSPACE_XML;

	@Override
	protected void setUp() throws Exception {
		super.setUp();
	}

	@Override
	protected void tearDown() throws Exception {
		ManagedBuildTestHelper.removeProject(this.getName());
		super.tearDown();
	}

	/**
	 * Test that null arguments don't crash the provider.
	 */
	public void testNulls() throws Exception {
		ILanguageSettingsProvider provider = LanguageSettingsManager.getWorkspaceProvider(MBS_LANGUAGE_SETTINGS_PROVIDER_ID);
		assertNotNull(provider);
		List<ICLanguageSettingEntry> entries = provider.getSettingEntries(null, null, null);
		assertEquals(null, entries);
	}

	/**
	 * Test new GNU Executable project.
	 */
	public void testGnuToolchainProviders() throws Exception {
		// create a new project
		IProject project = ManagedBuildTestHelper.createProject(this.getName(), PROJECT_TYPE_EXECUTABLE_GNU);

		// check that the language settings providers are in place.
		ICProjectDescription prjDescription = CoreModel.getDefault().getProjectDescription(project, false);
		assertNotNull(prjDescription);
		ICConfigurationDescription[] cfgDescriptions = prjDescription.getConfigurations();
		for (ICConfigurationDescription cfgDescription : cfgDescriptions) {
			assertNotNull(cfgDescription);
			assertTrue(cfgDescription instanceof ILanguageSettingsProvidersKeeper);

			List<ILanguageSettingsProvider> providers = ((ILanguageSettingsProvidersKeeper) cfgDescription).getLanguageSettingProviders();
			{
				ILanguageSettingsProvider provider = providers.get(0);
				String id = provider.getId();
				assertEquals(USER_LANGUAGE_SETTINGS_PROVIDER_ID, id);
				assertEquals(false, LanguageSettingsManager.isPreferShared(id));
				assertEquals(false, LanguageSettingsManager.isWorkspaceProvider(provider));
			}
			{
				ILanguageSettingsProvider provider = providers.get(1);
				String id = provider.getId();
				assertEquals(REFERENCED_PROJECTS_PROVIDER_ID, id);
				assertEquals(true, LanguageSettingsManager.isPreferShared(id));
				assertEquals(true, LanguageSettingsManager.isWorkspaceProvider(provider));
			}
			{
				ILanguageSettingsProvider provider = providers.get(2);
				String id = provider.getId();
				assertEquals(MBS_LANGUAGE_SETTINGS_PROVIDER_ID, id);
				assertEquals(true, LanguageSettingsManager.isPreferShared(id));
				assertEquals(true, LanguageSettingsManager.isWorkspaceProvider(provider));
			}
			{
				ILanguageSettingsProvider provider = providers.get(3);
				String id = provider.getId();
				assertEquals(GCC_SPECS_DETECTOR_ID, id);
				assertEquals(false, LanguageSettingsManager.isPreferShared(id));
				assertEquals(false, LanguageSettingsManager.isWorkspaceProvider(provider));
			}
			assertEquals(4, providers.size());
		}
	}

	/**
	 * Test that no unnecessary storage file is created for language settings for default set
	 * of language settings providers.
	 */
	public void testProjectPersistence_Defaults() throws Exception {
		// create a new project
		IProject project = ManagedBuildTestHelper.createProject(this.getName(), PROJECT_TYPE_EXECUTABLE_GNU);

		// double-check that the project contains language settings providers
		ICProjectDescription prjDescription = CoreModel.getDefault().getProjectDescription(project, false);
		assertNotNull(prjDescription);
		ICConfigurationDescription[] cfgDescriptions = prjDescription.getConfigurations();
		for (ICConfigurationDescription cfgDescription : cfgDescriptions) {
			assertNotNull(cfgDescription);
			assertTrue(cfgDescription instanceof ILanguageSettingsProvidersKeeper);

			String[] defaultIds = ((ILanguageSettingsProvidersKeeper) cfgDescription).getDefaultLanguageSettingsProvidersIds();
			List<ILanguageSettingsProvider> providers = ((ILanguageSettingsProvidersKeeper) cfgDescription).getLanguageSettingProviders();
			assertEquals(defaultIds.length, providers.size());
			for (int i = 0; i < defaultIds.length; i++) {
				assertEquals(providers.get(i).getId(), defaultIds[i]);
			}
			assertTrue(defaultIds.length > 0);
		}

		// settings file in project area
		IFile xmlStorageFile = project.getFile(LANGUAGE_SETTINGS_PROJECT_XML);
		assertEquals(true, xmlStorageFile.exists());
		assertEquals(true, xmlStorageFile.getParent().exists()); // .settings folder

		// settings file in workspace area
		String xmlPrjWspStorageFileLocation = LanguageSettingsPersistenceProjectTests.getStoreLocationInWorkspaceArea(project.getName()+'.'+LANGUAGE_SETTINGS_WORKSPACE_XML);
		java.io.File xmlStorageFilePrjWsp = new java.io.File(xmlPrjWspStorageFileLocation);
		assertEquals(true, xmlStorageFilePrjWsp.exists());
	}

	/**
	 * Test that storage file is created for language settings for empty set of language settings providers.
	 */
	public void testProjectPersistence_NoProviders() throws Exception {
		// create a new project
		IProject project = ManagedBuildTestHelper.createProject(this.getName(), PROJECT_TYPE_EXECUTABLE_GNU);

		// remove language settings providers from the project
		ICProjectDescription prjDescription = CoreModel.getDefault().getProjectDescription(project, true);
		assertNotNull(prjDescription);
		ICConfigurationDescription[] cfgDescriptions = prjDescription.getConfigurations();
		for (ICConfigurationDescription cfgDescription : cfgDescriptions) {
			assertNotNull(cfgDescription);
			assertTrue(cfgDescription instanceof ILanguageSettingsProvidersKeeper);

			((ILanguageSettingsProvidersKeeper) cfgDescription).setLanguageSettingProviders(new ArrayList<ILanguageSettingsProvider>());
			assertTrue(((ILanguageSettingsProvidersKeeper) cfgDescription).getLanguageSettingProviders().size() == 0);
		}

		CoreModel.getDefault().setProjectDescription(project, prjDescription);

		// settings file appears in project area
		IFile xmlStorageFile = project.getFile(LANGUAGE_SETTINGS_PROJECT_XML);
		assertEquals(true, xmlStorageFile.exists());

		// no settings file in workspace area
		String xmlPrjWspStorageFileLocation = LanguageSettingsPersistenceProjectTests.getStoreLocationInWorkspaceArea(project.getName()+'.'+LANGUAGE_SETTINGS_WORKSPACE_XML);
		java.io.File xmlStorageFilePrjWsp = new java.io.File(xmlPrjWspStorageFileLocation);
		assertEquals(false, xmlStorageFilePrjWsp.exists());

	}

}

Back to the top