/*******************************************************************************
* Copyright (c) 2013 Red Hat Inc. 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:
* Neil Guzman - initial API and implementation
*******************************************************************************/
package org.eclipse.linuxtools.internal.rpm.createrepo.form.tests;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.preferences.IEclipsePreferences;
import org.eclipse.jface.preference.IPreferenceStore;
import org.eclipse.linuxtools.internal.rpm.createrepo.Activator;
import org.eclipse.linuxtools.internal.rpm.createrepo.CreaterepoPreferenceConstants;
import org.eclipse.linuxtools.internal.rpm.createrepo.CreaterepoProject;
import org.eclipse.linuxtools.internal.rpm.createrepo.ICreaterepoConstants;
import org.eclipse.linuxtools.internal.rpm.createrepo.Messages;
import org.eclipse.linuxtools.internal.rpm.createrepo.tree.CreaterepoTreeCategory;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Tree;
import org.eclipse.swtbot.eclipse.finder.SWTWorkbenchBot;
import org.eclipse.swtbot.eclipse.finder.widgets.SWTBotMultiPageEditor;
import org.eclipse.swtbot.eclipse.finder.widgets.SWTBotView;
import org.eclipse.swtbot.swt.finder.SWTBot;
import org.eclipse.swtbot.swt.finder.exceptions.WidgetNotFoundException;
import org.eclipse.swtbot.swt.finder.junit.SWTBotJunit4ClassRunner;
import org.eclipse.swtbot.swt.finder.matchers.WidgetMatcherFactory;
import org.junit.After;
import org.junit.AfterClass;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.osgi.service.prefs.BackingStoreException;
/**
* SWTBot tests for MetadataPage.
*/
@RunWith(SWTBotJunit4ClassRunner.class)
public class MetadataPageTest {
private static TestCreaterepoProject testProject;
private static SWTWorkbenchBot bot;
private static SWTBotView navigator;
private CreaterepoProject project;
private SWTBot metadataPageBot;
/**
* Initialize the test project.
*
* @throws CoreException
*/
@BeforeClass
public static void setUpBeforeClass() throws CoreException {
testProject = new TestCreaterepoProject();
assertTrue(testProject.getProject().exists());
bot = new SWTWorkbenchBot();
try {
bot.shell(ICreaterepoTestConstants.MAIN_SHELL).activate();
} catch (WidgetNotFoundException e) {
// cannot activate main shell, continue anyways
}
TestUtils.openResourcePerspective(bot);
navigator = TestUtils.enterProjectFolder(bot);
}
/**
* Delete the project when tests are done.
*
* @throws CoreException
*/
@AfterClass
public static void tearDownAfterClass() throws CoreException {
TestUtils.exitProjectFolder(bot, navigator);
testProject.dispose();
assertFalse(testProject.getProject().exists());
}
/**
* Get the CreaterepoProject at the beginning of each test, as
* well as import some test RPMs.
*
* @throws CoreException
*/
@Before
public void setUp() throws CoreException {
project = testProject.getCreaterepoProject();
assertNotNull(project);
initializeMetadataPage();
}
/**
* Clear the project preferences.
*
* @throws BackingStoreException
*/
@After
public void tearDown() throws BackingStoreException {
IEclipsePreferences pref = project.getEclipsePreferences();
pref.clear();
pref.flush();
assertEquals(0, pref.keys().length);
}
/**
* Test if tags are adding properly. Tags should be unique per category.
*/
@Test
public void testAddTags() {
// run in UI thread because accessing the tree in the metadata page
Display.getDefault().syncExec(() -> {
String tagName = "testTag"; //$NON-NLS-1$
String newTagName = "newUniqueTag"; //$NON-NLS-1$
String prefValueToBe = ""; //$NON-NLS-1$
metadataPageBot.textWithLabel(Messages.MetadataPage_labelTags).setText(tagName);
Tree tree = metadataPageBot.widget(WidgetMatcherFactory.widgetOfType(Tree.class));
assertNotNull(tree);
// 0 = distro, 1 = content, 2 = repo
int category = 0;
// select the category and the test adding tags
tree.select(tree.getItem(category));
metadataPageBot.button(Messages.MetadataPage_buttonAddTag).click();
CreaterepoTreeCategory test = (CreaterepoTreeCategory) tree.getItem(category).getData();
assertEquals(1, test.getTags().size());
// it should be distro = {testTag} now
prefValueToBe = tagName;
assertTrue(isPreferencesCorrect(CreaterepoPreferenceConstants.PREF_DISTRO_TAG, prefValueToBe));
// try adding the same tag to the same category again, it should not
// work
tree.select(tree.getItem(category));
metadataPageBot.textWithLabel(Messages.MetadataPage_labelTags).setText(tagName);
metadataPageBot.button(Messages.MetadataPage_buttonAddTag).click();
assertEquals(1, test.getTags().size());
// it should still be distro = {testTag}
prefValueToBe = tagName;
assertTrue(isPreferencesCorrect(CreaterepoPreferenceConstants.PREF_DISTRO_TAG, prefValueToBe));
// try adding a new unique tag to the same category, it should work
tree.select(tree.getItem(category));
metadataPageBot.textWithLabel(Messages.MetadataPage_labelTags).setText(newTagName);
metadataPageBot.button(Messages.MetadataPage_buttonAddTag).click();
assertEquals(2, test.getTags().size());
// it should be distro = {testTag, newUniqueTag} now
prefValueToBe = tagName + ICreaterepoConstants.DELIMITER + newTagName;
assertTrue(isPreferencesCorrect(CreaterepoPreferenceConstants.PREF_DISTRO_TAG, prefValueToBe));
});
}
/**
* Test if tags can be edited correctly.
*/
@Test
public void testEditTags() {
// run in UI thread because accessing the tree in the metadata page
Display.getDefault().syncExec(() -> {
String tagName = "testTag"; //$NON-NLS-1$
String tagName2 = "testTag2"; //$NON-NLS-1$
String newTagName = "renameTag"; //$NON-NLS-1$
String prefValueToBe = ""; //$NON-NLS-1$
Tree tree = metadataPageBot.widget(WidgetMatcherFactory.widgetOfType(Tree.class));
assertNotNull(tree);
// 0 = distro, 1 = content, 2 = repo
int category = 1;
// select the category and test editing tags
tree.select(tree.getItem(category));
metadataPageBot.textWithLabel(Messages.MetadataPage_labelTags).setText(tagName);
metadataPageBot.button(Messages.MetadataPage_buttonAddTag).click();
metadataPageBot.textWithLabel(Messages.MetadataPage_labelTags).setText(tagName2);
metadataPageBot.button(Messages.MetadataPage_buttonAddTag).click();
CreaterepoTreeCategory test = (CreaterepoTreeCategory) tree.getItem(category).getData();
assertEquals(2, test.getTags().size());
// it should be content = {testTag1, testTag2} now
prefValueToBe = tagName + ICreaterepoConstants.DELIMITER + tagName2;
assertTrue(isPreferencesCorrect(CreaterepoPreferenceConstants.PREF_CONTENT_TAG, prefValueToBe));
// select the first test tag that was created and edit it with a new
// unique tag
tree.select(tree.getItem(category).getItem(0));
metadataPageBot.textWithLabel(Messages.MetadataPage_labelTags).setText(newTagName);
metadataPageBot.button(Messages.MetadataPage_buttonEditTag).click();
assertEquals(2, test.getTags().size());
assertEquals(newTagName, test.getTags().get(0));
// it should be content = {renameTag, testTag2} now
prefValueToBe = newTagName + ICreaterepoConstants.DELIMITER + tagName2;
assertTrue(isPreferencesCorrect(CreaterepoPreferenceConstants.PREF_CONTENT_TAG, prefValueToBe));
// select the second test tag and try to rename it as the same name
// as the first tag, this should not work
tree.select(tree.getItem(category).getItem(1));
metadataPageBot.textWithLabel(Messages.MetadataPage_labelTags).setText(newTagName);
metadataPageBot.button(Messages.MetadataPage_buttonEditTag).click();
assertEquals(2, test.getTags().size());
assertNotEquals(newTagName, test.getTags().get(1));
// it should still be content = {renameTag, testTag2}
prefValueToBe = newTagName + ICreaterepoConstants.DELIMITER + tagName2;
assertTrue(isPreferencesCorrect(CreaterepoPreferenceConstants.PREF_CONTENT_TAG, prefValueToBe));
});
}
/**
* Test if tags can be removed.
*/
@Test
public void testRemoveTags() {
// run in UI thread because accessing the tree in the metadata page
Display.getDefault().syncExec(() -> {
String tagName = "testTag"; //$NON-NLS-1$
String prefValueToBe = ""; //$NON-NLS-1$
Tree tree = metadataPageBot.widget(WidgetMatcherFactory.widgetOfType(Tree.class));
assertNotNull(tree);
// 0 = distro, 1 = content, 2 = repo
int category = 2;
// select the category and test removing tags
tree.select(tree.getItem(category));
metadataPageBot.textWithLabel(Messages.MetadataPage_labelTags).setText(tagName);
metadataPageBot.button(Messages.MetadataPage_buttonAddTag).click();
CreaterepoTreeCategory test = (CreaterepoTreeCategory) tree.getItem(category).getData();
assertEquals(1, test.getTags().size());
// it should be repo = {testTag} now
prefValueToBe = tagName;
assertTrue(isPreferencesCorrect(CreaterepoPreferenceConstants.PREF_REPO_TAG, prefValueToBe));
// select the first item and delete it
tree.select(tree.getItem(category).getItem(0));
metadataPageBot.button(Messages.MetadataPage_buttonRemoveTag).click();
assertEquals(0, test.getTags().size());
// it should be repo = {} now
prefValueToBe = ""; //$NON-NLS-1$
assertTrue(isPreferencesCorrect(CreaterepoPreferenceConstants.PREF_REPO_TAG, prefValueToBe));
// try to remove the category
tree.select(tree.getItem(category));
metadataPageBot.button(Messages.MetadataPage_buttonRemoveTag).click();
// it should still be there
assertNotNull(tree.getItem(category));
});
}
/**
* Get the current project preference for the category tag and check if the values
* stored are the same as the values passed in.
*
* @param category The preference category to check.
* @param value The value to check.
* @return True if the value is same as what is stored, false otherwise.
*/
private boolean isPreferencesCorrect(String category, String value) {
IEclipsePreferences pref = project.getEclipsePreferences();
IPreferenceStore prefStore = Activator.getDefault().getPreferenceStore();
String actual = pref.get(category, prefStore.getDefaultString(category));
return actual.equals(value);
}
/**
* Helper method to help setup the test by opening the .repo file.
*/
private void initializeMetadataPage() {
SWTBotMultiPageEditor editor = TestUtils.openRepoFile(bot, navigator);
// activate the metadata page
editor.activatePage(Messages.MetadataPage_title);
// make sure correct page is active
assertEquals(Messages.MetadataPage_title, editor.getActivePageTitle());
metadataPageBot = editor.bot();
}
}