1 // Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).

     2 // All rights reserved.

     3 // This component and the accompanying materials are made available

     4 // under the terms of "Eclipse Public License v1.0"

     5 // which accompanies this distribution, and is available

     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".

     7 //

     8 // Initial Contributors:

     9 // Nokia Corporation - initial contribution.

    10 //

    11 // Contributors:

    12 //

    13 // Description:

    14 //

    15 package com.symbian.smt.gui.wizard;

    16 

    17 import java.util.ArrayList;

    18 import java.util.Iterator;

    19 import java.util.List;

    20 

    21 import junit.framework.TestCase;

    22 

    23 import org.eclipse.core.resources.IWorkspace;

    24 import org.eclipse.core.resources.ResourcesPlugin;

    25 import org.eclipse.jface.dialogs.DialogPage;

    26 import org.eclipse.jface.viewers.IStructuredSelection;

    27 import org.eclipse.jface.viewers.StructuredSelection;

    28 import org.eclipse.jface.wizard.IWizardPage;

    29 import org.eclipse.jface.wizard.WizardDialog;

    30 import org.eclipse.swt.widgets.Shell;

    31 import org.eclipse.swt.widgets.TabFolder;

    32 import org.eclipse.swt.widgets.TabItem;

    33 import org.eclipse.ui.IWorkbench;

    34 import org.eclipse.ui.PlatformUI;

    35 

    36 import com.symbian.smt.gui.Helper;

    37 import com.symbian.smt.gui.TestConstants;

    38 import com.symbian.smt.gui.preferences.SmmPreferencesInitializer;

    39 import com.symbian.smt.gui.smtwidgets.AdvancedOptionsWidget;

    40 import com.symbian.smt.gui.smtwidgets.BuildControlWidget;

    41 import com.symbian.smt.gui.smtwidgets.FilterWidget;

    42 import com.symbian.smt.gui.smtwidgets.IgnoreWidget;

    43 import com.symbian.smt.gui.smtwidgets.ModelControlWidget;

    44 import com.symbian.smt.gui.smtwidgets.ModelLabelsWidget;

    45 import com.symbian.smt.gui.smtwidgets.ValidModelDefinedListener;

    46 import com.symbian.smt.gui.smtwidgets.ValidModelEvent;

    47 import com.symbian.smt.gui.smtwidgets.ValidModelEvent.Type;

    48 import com.symbian.smt.gui.smtwidgets.resources.ResourcesWidget;

    49 

    50 public class NewProjectWizardTabbedPropertiesPageTest extends TestCase {

    51 

    52 	private static final String SEPARATOR = "|";

    53 

    54 	private IStructuredSelection selection;

    55 	private Shell shell;

    56 	private String smgFolder;

    57 	private NewSMTProjectWizard wizard;

    58 	private WizardDialog wizardDialog;

    59 	private IWorkbench workbench;

    60 

    61 	private String[] convertFilenamesToAbsolute(String[] relativeFilenames) {

    62 		String[] absoluteFilenames = new String[relativeFilenames.length];

    63 

    64 		for (int i = 0; i < relativeFilenames.length; i++) {

    65 			String relativeFilename = relativeFilenames[i];

    66 

    67 			if (relativeFilename.equals("Auto")) {

    68 				absoluteFilenames[i] = relativeFilename;

    69 			} else {

    70 				String absoluteFilename = Helper.relative2AbsolutePaths(

    71 						relativeFilename, smgFolder, SEPARATOR);

    72 				absoluteFilenames[i] = absoluteFilename;

    73 			}

    74 		}

    75 

    76 		return absoluteFilenames;

    77 	}

    78 

    79 	protected void setUp() throws Exception {

    80 		// Initialise the default values

    81 		SmmPreferencesInitializer initialiser = new SmmPreferencesInitializer();

    82 

    83 		initialiser.initializeDefaultPreferences();

    84 

    85 		smgFolder = initialiser.getSmgFolder();

    86 		wizard = new NewSMTProjectWizard();

    87 		selection = new StructuredSelection(StructuredSelection.EMPTY);

    88 		workbench = PlatformUI.getWorkbench();

    89 		shell = workbench.getActiveWorkbenchWindow().getShell();

    90 

    91 		wizard.init(workbench, selection);

    92 

    93 		wizardDialog = new WizardDialog(shell, wizard);

    94 

    95 		wizardDialog.setBlockOnOpen(false);

    96 		wizardDialog.open();

    97 	}

    98 

    99 	protected void tearDown() throws Exception {

   100 		IWorkspace ws = ResourcesPlugin.getWorkspace();

   101 

   102 		ws.getRoot().delete(true, true, null);

   103 		wizardDialog.close();

   104 		wizard.dispose();

   105 

   106 		wizard = null;

   107 		wizardDialog = null;

   108 		selection = null;

   109 		shell = null;

   110 		smgFolder = null;

   111 		workbench = null;

   112 	}

   113 

   114 	private void testAdvancedOptionsWidgetInitialised(

   115 			AdvancedOptionsWidget widget) {

   116 		String message = "Error in widget's advanced options.";

   117 		Object[] expectedValues = new String[] {};

   118 		Object[] actualValues = widget.getAdvancedOptions();

   119 		testWidgetValues(message, expectedValues, actualValues);

   120 	}

   121 

   122 	private void testBuildControlWidgetInitialised(BuildControlWidget widget) {

   123 		String message = "Error in widget's output filename.";

   124 		String expectedValue = "Model.svg";

   125 		String actualValue = widget.getOutputFilename();

   126 		testWidgetValue(message, expectedValue, actualValue);

   127 

   128 		// We do not test for the warning level here because it is not

   129 		// initialised in the BuildControlWidget when the container

   130 		// is either the wizard or the properties page (this happens

   131 		// only in preferences)

   132 	}

   133 

   134 	public void testCreateControl() {

   135 		IWizardPage[] pages = wizard.getPages();

   136 		NewProjectWizardTabbedPropertiesPage page = (NewProjectWizardTabbedPropertiesPage) pages[2];

   137 		TabFolder tf = page.getTabFolder();

   138 

   139 		assertNotNull(tf);

   140 		TabItem[] items = tf.getItems();

   141 

   142 		assertEquals(7, items.length);

   143 

   144 		TabItem item = items[0];

   145 		assertTrue(item.getControl() instanceof ModelLabelsWidget);

   146 		assertEquals("Labels", item.getText());

   147 

   148 		item = items[1];

   149 		assertTrue(item.getControl() instanceof ResourcesWidget);

   150 		assertEquals("Resources", item.getText());

   151 

   152 		item = items[2];

   153 		assertTrue(item.getControl() instanceof ModelControlWidget);

   154 		assertEquals("Model Control", item.getText());

   155 

   156 		item = items[3];

   157 		assertTrue(item.getControl() instanceof FilterWidget);

   158 		assertEquals("Filters", item.getText());

   159 

   160 		item = items[4];

   161 		assertTrue(item.getControl() instanceof IgnoreWidget);

   162 		assertEquals("Ignore List", item.getText());

   163 

   164 		item = items[5];

   165 		assertTrue(item.getControl() instanceof BuildControlWidget);

   166 		assertEquals("Build Options", item.getText());

   167 

   168 		item = items[6];

   169 		assertTrue(item.getControl() instanceof AdvancedOptionsWidget);

   170 		assertEquals("Advanced Options", item.getText());

   171 	}

   172 

   173 	public void testDispose() {

   174 		IWizardPage[] pages = wizard.getPages();

   175 		NewProjectWizardTabbedPropertiesPage page = (NewProjectWizardTabbedPropertiesPage) pages[2];

   176 		TabFolder tf = page.getTabFolder();

   177 		TabItem[] items = tf.getItems();

   178 

   179 		ModelControlWidget mcw = (ModelControlWidget) items[2].getControl();

   180 

   181 		page.dispose();

   182 		List<ValidModelDefinedListener> listeners = mcw.getModelListeners();

   183 		assertFalse(listeners.contains(page));

   184 

   185 		BuildControlWidget bcw = (BuildControlWidget) items[5].getControl();

   186 

   187 		page.dispose();

   188 		listeners = bcw.getModelListeners();

   189 		assertFalse(listeners.contains(page));

   190 	}

   191 

   192 	private void testFilterWidgetInitialised(FilterWidget widget) {

   193 		String message = "Error in widget's filter items.";

   194 		String[] expectedValues = new String[] { "*" };

   195 		String[] actualValues = widget.getFilterItems();

   196 		testWidgetValues(message, expectedValues, actualValues);

   197 	}

   198 

   199 	private final void testIgnoreItemsValues(String message,

   200 			List<String[]> expected, List<String[]> actual) {

   201 		assertEquals(message, expected.size(), actual.size());

   202 

   203 		Iterator<String[]> expectedIter = expected.iterator();

   204 		Iterator<String[]> actualIter = actual.iterator();

   205 

   206 		while (expectedIter.hasNext() && actualIter.hasNext()) {

   207 			String[] expectedArray = expectedIter.next();

   208 			String[] actualArray = actualIter.next();

   209 

   210 			for (int i = 0; i < expectedArray.length; i++) {

   211 				String expectedValue = expectedArray[i];

   212 				String actualValue = actualArray[i];

   213 

   214 				assertEquals(message, expectedValue, actualValue);

   215 			}

   216 		}

   217 	}

   218 

   219 	private void testIgnoreWidgetInitialised(IgnoreWidget widget) {

   220 		String message = "Error in widget's ignored items.";

   221 		List<String[]> expectedIgnoredItems = new ArrayList<String[]>();

   222 		expectedIgnoredItems.add(new String[] { "layer",

   223 				"Tools and Utils and SDKENG" });

   224 		expectedIgnoredItems.add(new String[] { "layer", "MISC" });

   225 		expectedIgnoredItems.add(new String[] { "block", "Techview" });

   226 

   227 		List<String[]> actualIgnoredItems = widget.getIgnoreItems();

   228 		testIgnoreItemsValues(message, expectedIgnoredItems, actualIgnoredItems);

   229 	}

   230 

   231 	public void testInitialize() {

   232 		IWizardPage[] pages = wizard.getPages();

   233 		NewProjectWizardTabbedPropertiesPage page = (NewProjectWizardTabbedPropertiesPage) pages[2];

   234 		TabFolder tf = page.getTabFolder();

   235 

   236 		assertNotNull(tf);

   237 		TabItem[] items = tf.getItems();

   238 

   239 		assertEquals(7, items.length);

   240 

   241 		TabItem item = items[0];

   242 		assertTrue(item.getControl() instanceof ModelLabelsWidget);

   243 		testModelLabelsWidgetInitialised((ModelLabelsWidget) item.getControl());

   244 

   245 		item = items[1];

   246 		assertTrue(item.getControl() instanceof ResourcesWidget);

   247 		testResourcesWidgetInitialised((ResourcesWidget) item.getControl());

   248 

   249 		item = items[2];

   250 		assertTrue(item.getControl() instanceof ModelControlWidget);

   251 		testModelControlWidgetInitialised((ModelControlWidget) item

   252 				.getControl());

   253 		ModelControlWidget mcw = (ModelControlWidget) item.getControl();

   254 		List<ValidModelDefinedListener> listeners = mcw.getModelListeners();

   255 		assertTrue(listeners.contains(page));

   256 

   257 		item = items[3];

   258 		assertTrue(item.getControl() instanceof FilterWidget);

   259 		testFilterWidgetInitialised((FilterWidget) item.getControl());

   260 

   261 		item = items[4];

   262 		assertTrue(item.getControl() instanceof IgnoreWidget);

   263 		testIgnoreWidgetInitialised((IgnoreWidget) item.getControl());

   264 

   265 		item = items[5];

   266 		assertTrue(item.getControl() instanceof BuildControlWidget);

   267 		testBuildControlWidgetInitialised((BuildControlWidget) item

   268 				.getControl());

   269 		BuildControlWidget bcw = (BuildControlWidget) item.getControl();

   270 		listeners = bcw.getModelListeners();

   271 		assertTrue(listeners.contains(page));

   272 

   273 		item = items[6];

   274 		assertTrue(item.getControl() instanceof AdvancedOptionsWidget);

   275 		testAdvancedOptionsWidgetInitialised((AdvancedOptionsWidget) item

   276 				.getControl());

   277 	}

   278 

   279 	private void testModelControlWidgetInitialised(ModelControlWidget widget) {

   280 		String message = "Error in widget's fix item size.";

   281 		Boolean expectedValueB = false;

   282 		Boolean actualValueB = widget.getFixItemSize();

   283 		testWidgetValue(message, expectedValueB, actualValueB);

   284 

   285 		message = "Error in widget's highlight core OS.";

   286 		expectedValueB = true;

   287 		actualValueB = widget.getHighlightCoreOS();

   288 		testWidgetValue(message, expectedValueB, actualValueB);

   289 

   290 		message = "Error in widget's level of detail.";

   291 		String expectedValue = "component";

   292 		String actualValue = widget.getLevelOfDetail();

   293 		testWidgetValue(message, expectedValue, actualValue);

   294 

   295 		message = "Error in widget's printed dpi values.";

   296 		String[] expectedValues = new String[] { "300", "600" };

   297 		String[] actualValues = widget.getPrintedDpis();

   298 		testWidgetValues(message, expectedValues, actualValues);

   299 

   300 		message = "Error in widget's selected printed dpi.";

   301 		expectedValue = "600";

   302 		actualValue = widget.getSelectedPrintedDpi();

   303 		testWidgetValue(message, expectedValue, actualValue);

   304 

   305 		message = "Error in widget's suppress mouse over effect.";

   306 		expectedValueB = true;

   307 		actualValueB = widget.getSuppressMouseOverEffect();

   308 		testWidgetValue(message, expectedValueB, actualValueB);

   309 	}

   310 

   311 	private void testModelLabelsWidgetInitialised(ModelLabelsWidget widget) {

   312 		String message = "Error in widget's copyright text.";

   313 		String expectedValue = "Symbian Software Ltd.";

   314 		String actualValue = widget.getCopyrightText();

   315 		testWidgetValue(message, expectedValue, actualValue);

   316 

   317 		message = "Error in widget's distribution text values.";

   318 		String[] expectedValues = new String[] { "secret", "confidential",

   319 				"internal", "unrestricted" };

   320 		String[] actualValues = widget.getDistributionTexts();

   321 		testWidgetValues(message, expectedValues, actualValues);

   322 

   323 		message = "Error in widget's model name.";

   324 		expectedValue = "System Model";

   325 		actualValue = widget.getModelName();

   326 		testWidgetValue(message, expectedValue, actualValue);

   327 

   328 		message = "Error in widget's model version.";

   329 		expectedValue = "1";

   330 		actualValue = widget.getModelVersion();

   331 		testWidgetValue(message, expectedValue, actualValue);

   332 

   333 		message = "Error in widget's model version text values.";

   334 		expectedValues = new String[] { "draft", "build", "issued" };

   335 		actualValues = widget.getModelVersionTexts();

   336 		testWidgetValues(message, expectedValues, actualValues);

   337 

   338 		message = "Error in widget's selected distribution text.";

   339 		expectedValue = "secret";

   340 		actualValue = widget.getSelectedDistributionText();

   341 		testWidgetValue(message, expectedValue, actualValue);

   342 

   343 		message = "Error in widget's selected model version text.";

   344 		expectedValue = "draft";

   345 		actualValue = widget.getSelectedModelVersionText();

   346 		testWidgetValue(message, expectedValue, actualValue);

   347 

   348 		message = "Error in widget's system name.";

   349 		expectedValue = "Symbian OS";

   350 		actualValue = widget.getSystemName();

   351 		testWidgetValue(message, expectedValue, actualValue);

   352 

   353 		message = "Error in widget's system version.";

   354 		expectedValue = "Future";

   355 		actualValue = widget.getSystemVersion();

   356 		testWidgetValue(message, expectedValue, actualValue);

   357 	}

   358 

   359 	private void testPageMessageAndState1(

   360 			NewProjectWizardTabbedPropertiesPage page) {

   361 		String errorMessage = page.getErrorMessage();

   362 		assertTrue(errorMessage == null);

   363 

   364 		String message = page.getMessage();

   365 		assertTrue(message == null);

   366 

   367 		int messageType = page.getMessageType();

   368 		assertEquals(DialogPage.NONE, messageType);

   369 

   370 		boolean isPageComplete = page.isPageComplete();

   371 		assertTrue(isPageComplete);

   372 	}

   373 

   374 	private void testPageMessageAndState2(

   375 			NewProjectWizardTabbedPropertiesPage page) {

   376 		String errorMessage = page.getErrorMessage();

   377 		assertEquals("Error message one.", errorMessage);

   378 

   379 		String message = page.getMessage();

   380 		assertTrue(message == null);

   381 

   382 		int messageType = page.getMessageType();

   383 		assertEquals(DialogPage.NONE, messageType);

   384 

   385 		boolean isPageComplete = page.isPageComplete();

   386 		assertFalse(isPageComplete);

   387 	}

   388 

   389 	private void testResourcesWidgetInitialised(ResourcesWidget widget) {

   390 		String message = "Error in widget's border shapes files.";

   391 		String[] expectedValues = new String[] {};

   392 		String[] actualValues = widget.getBorderShapesFiles();

   393 		testWidgetValues(message, expectedValues, actualValues);

   394 

   395 		message = "Error in widget's border styles files.";

   396 		expectedValues = new String[] {};

   397 		actualValues = widget.getBorderStylesFiles();

   398 		testWidgetValues(message, expectedValues, actualValues);

   399 

   400 		message = "Error in widget's colour files.";

   401 		expectedValues = convertFilenamesToAbsolute(new String[] { TestConstants.COLOUR_RESOURCE_FILE_PATH });

   402 		actualValues = widget.getColoursFiles();

   403 		testWidgetValues(message, expectedValues, actualValues);

   404 

   405 		message = "Error in widget's dependencies files.";

   406 		expectedValues = new String[] {};

   407 		actualValues = widget.getDependenciesFiles();

   408 		testWidgetValues(message, expectedValues, actualValues);

   409 

   410 		message = "Error in widget's level files.";

   411 		expectedValues = convertFilenamesToAbsolute(new String[] { "Auto",

   412 				"./../SystemModelGenerator/resources/auxiliary/Levels.xml",

   413 				"./../SystemModelGenerator/resources/auxiliary/Levels91.xml" });

   414 		actualValues = widget.getLevelsFiles();

   415 		testWidgetValues(message, expectedValues, actualValues);

   416 

   417 		message = "Error in widget's localisation files.";

   418 		expectedValues = convertFilenamesToAbsolute(new String[] { TestConstants.LOCALISATION_RESOURCE_FILE_PATH });

   419 		actualValues = widget.getLocalisationFiles();

   420 		testWidgetValues(message, expectedValues, actualValues);

   421 

   422 		message = "Error in widget's pattern files.";

   423 		expectedValues = new String[] {};

   424 		actualValues = widget.getPatternsFiles();

   425 		testWidgetValues(message, expectedValues, actualValues);

   426 

   427 		message = "Error in widget's S12 XML files.";

   428 		expectedValues = new String[] {};

   429 		actualValues = widget.getS12XmlFiles();

   430 		testWidgetValues(message, expectedValues, actualValues);

   431 

   432 		message = "Error in widget's selected border shapes files.";

   433 		expectedValues = new String[] {};

   434 		actualValues = widget.getSelectedBorderShapesFiles();

   435 		testWidgetValues(message, expectedValues, actualValues);

   436 

   437 		message = "Error in widget's selected border styles files.";

   438 		expectedValues = new String[] {};

   439 		actualValues = widget.getSelectedBorderStylesFiles();

   440 		testWidgetValues(message, expectedValues, actualValues);

   441 

   442 		message = "Error in widget's selected colour files.";

   443 		expectedValues = new String[] {};

   444 		actualValues = widget.getSelectedColoursFiles();

   445 		testWidgetValues(message, expectedValues, actualValues);

   446 

   447 		message = "Error in widget's selected dependencies files.";

   448 		expectedValues = new String[] {};

   449 		actualValues = widget.getSelectedDependenciesFiles();

   450 		testWidgetValues(message, expectedValues, actualValues);

   451 

   452 		message = "Error in widget's selected levels files.";

   453 		expectedValues = new String[] { "Auto" };

   454 		actualValues = widget.getSelectedLevelsFiles();

   455 		testWidgetValues(message, expectedValues, actualValues);

   456 

   457 		message = "Error in widget's selected localisation files.";

   458 		expectedValues = convertFilenamesToAbsolute(new String[] { TestConstants.LOCALISATION_RESOURCE_FILE_PATH });

   459 		actualValues = widget.getSelectedLocalisationFiles();

   460 		testWidgetValues(message, expectedValues, actualValues);

   461 

   462 		message = "Error in widget's selected pattern files.";

   463 		expectedValues = new String[] {};

   464 		actualValues = widget.getSelectedPatternsFiles();

   465 		testWidgetValues(message, expectedValues, actualValues);

   466 

   467 		message = "Error in widget's selected S12 XML files.";

   468 		expectedValues = new String[] {};

   469 		actualValues = widget.getSelectedS12XmlFiles();

   470 		testWidgetValues(message, expectedValues, actualValues);

   471 

   472 		message = "Error in widget's selected shapes files.";

   473 		expectedValues = convertFilenamesToAbsolute(new String[] { TestConstants.SHAPES_RESOURCE_FILE_PATH });

   474 		actualValues = widget.getSelectedShapesFiles();

   475 		testWidgetValues(message, expectedValues, actualValues);

   476 

   477 		message = "Error in widget's selected system info files.";

   478 		expectedValues = new String[] {};

   479 		actualValues = widget.getSelectedSystemInfoFiles();

   480 		testWidgetValues(message, expectedValues, actualValues);

   481 

   482 		message = "Error in widget's shapes files.";

   483 		expectedValues = convertFilenamesToAbsolute(new String[] {

   484 				"./../SystemModelGenerator/resources/auxiliary/Shapes.xml",

   485 				"./../SystemModelGenerator/resources/auxiliary/Example-shapes.xml" });

   486 		actualValues = widget.getShapesFiles();

   487 		testWidgetValues(message, expectedValues, actualValues);

   488 

   489 		message = "Error in widget's system info files.";

   490 		expectedValues = convertFilenamesToAbsolute(new String[] { TestConstants.SYSTEM_INFO_RESOURCE_FILE_PATH });

   491 		actualValues = widget.getSystemInfoFiles();

   492 		testWidgetValues(message, expectedValues, actualValues);

   493 	}

   494 

   495 	public void testValidModelDefined() {

   496 		IWizardPage[] pages = wizard.getPages();

   497 		NewProjectWizardTabbedPropertiesPage page = (NewProjectWizardTabbedPropertiesPage) pages[2];

   498 

   499 		wizardDialog.showPage(page);

   500 

   501 		Boolean isValid = true;

   502 		String eventMessage = "";

   503 		Type type = Type.SUCCESS;

   504 		ValidModelEvent event = new ValidModelEvent(isValid, eventMessage, type);

   505 

   506 		page.validModelDefined(event);

   507 		testPageMessageAndState1(page);

   508 

   509 		isValid = false;

   510 		eventMessage = "Error message one.";

   511 		type = Type.ERROR;

   512 		event = new ValidModelEvent(isValid, eventMessage, type);

   513 

   514 		page.validModelDefined(event);

   515 		testPageMessageAndState2(page);

   516 

   517 		isValid = true;

   518 		eventMessage = "";

   519 		type = Type.SUCCESS;

   520 		event = new ValidModelEvent(isValid, eventMessage, type);

   521 

   522 		page.validModelDefined(event);

   523 		testPageMessageAndState1(page);

   524 	}

   525 

   526 	private final void testWidgetValue(String message, Object expected,

   527 			Object actual) {

   528 		assertEquals(message, expected, actual);

   529 	}

   530 

   531 	private final void testWidgetValues(String message, Object[] expected,

   532 			Object[] actual) {

   533 		assertEquals(message, expected.length, actual.length);

   534 

   535 		for (int i = 0; i < expected.length; i++) {

   536 			assertEquals(message, expected[i], actual[i]);

   537 		}

   538 	}

   539 

   540 }