/*
* See the NOTICE file distributed with this work for additional
* information regarding copyright ownership.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.xwiki.test.ui;
import java.util.HashMap;
import java.util.Map;
import org.junit.Assert;
import org.junit.Test;
import org.xwiki.administration.test.po.AdministrationPage;
import org.xwiki.administration.test.po.LocalizationAdministrationSectionPage;
import org.xwiki.test.ui.browser.IgnoreBrowser;
import org.xwiki.test.ui.browser.IgnoreBrowsers;
import org.xwiki.test.ui.po.ViewPage;
import org.xwiki.test.ui.po.editor.WYSIWYGEditPage;
import org.xwiki.test.ui.po.editor.WikiEditPage;
/**
* Test the section editing feature.
*
* @version $Id: 5c805bd3ffa2bdda4882fddb40e20e161a0188c5 $
* @since 2.6RC1
*/
public class SectionTest extends AbstractAdminAuthenticatedTest
{
private ViewPage createTestPages(String syntaxId)
{
if (syntaxId.equalsIgnoreCase("xwiki/1.0")) {
getUtil().createPage("Test", "SectionEditing", "1 Section1\nContent1\n\n"
+ "1 Section2\nContent2\n\n1.1 Section3\nContent3\n\n"
+ "1 Section4\nContent4", "section test in " + syntaxId, syntaxId);
} else if (syntaxId.startsWith("xwiki/2.")) {
getUtil().createPage("Test", "SectionEditingIncluded", "== Section4 ==\n" +
"Content4\n" +
"\n" +
"{{velocity wiki=true}}\n" +
"#foreach($h in ['5', '6'])\n" +
"== Section$h ==\n" +
"Content$h\n" +
"#end\n" +
"{{velocity}}", "section test included in " + syntaxId, syntaxId);
getUtil().createPage("Test", "SectionEditing", "= Section1 =\nContent1\n\n"
+ "= Section2 =\nContent2\n\n== Section3 ==\nContent3\n\n"
+ "{{include document='Test.SectionEditingIncluded'/}}\n\n" + "= Section7 =\nContent7",
"section test in " + syntaxId, syntaxId);
} else {
throw new RuntimeException("Unhandled syntax [" + syntaxId + "]");
}
return new ViewPage();
}
/**
* Verify edit section is working in both wiki and wysiwyg editors (xwiki/1.0).
* See XWIKI-174: Sectional editing.
*/
@Test
@IgnoreBrowsers({
@IgnoreBrowser(value = "internet.*", version = "8\\.*", reason="See http://jira.xwiki.org/browse/XE-1146"),
@IgnoreBrowser(value = "internet.*", version = "9\\.*", reason="See http://jira.xwiki.org/browse/XE-1177")
})
public void testSectionEditInEditorWhenSyntax10()
{
ViewPage vp = createTestPages("xwiki/1.0");
// Edit the second section in the wysiwyg editor
WYSIWYGEditPage wysiwygEditPage = vp.editSection(2);
Assert.assertEquals("Section2\nContent2\nSection3\nContent3", wysiwygEditPage.getContent());
// Edit the second section in the wiki editor
WikiEditPage wikiEditPage = wysiwygEditPage.editWiki();
Assert.assertEquals("1 Section2 Content2 1.1 Section3 Content3",
wikiEditPage.getContent());
wikiEditPage.clickCancel();
// Edit the third section in the wiki editor
Assert.assertEquals("1.1 Section3 Content3",
vp.editSection(3).editWiki().getContent());
wikiEditPage.clickCancel();
// Edit the fourth section in the wiki editor
Assert.assertEquals("1 Section4 Content4",
vp.editSection(4).editWiki().getContent());
}
/**
* Verify edit section is working in both wiki and wysiwyg editors (xwiki/2.0 and xwiki/2.1).
*
* Note that we currently don't support section editing for included content (it would mean navigating to the
* included page since it would change that page's content and not the currently page's content).
*
* See XWIKI-2881: Implement Section editing.
*/
@Test
@IgnoreBrowsers({
@IgnoreBrowser(value = "internet.*", version = "8\\.*", reason="See http://jira.xwiki.org/browse/XE-1146"),
@IgnoreBrowser(value = "internet.*", version = "9\\.*", reason="See http://jira.xwiki.org/browse/XE-1177")
})
public void testSectionEditInWikiEditorWhenSyntax2x()
{
testSectionEditInWikiEditorWhenSyntax2x("xwiki/2.0");
testSectionEditInWikiEditorWhenSyntax2x("xwiki/2.1");
}
private void testSectionEditInWikiEditorWhenSyntax2x(String syntaxId)
{
ViewPage vp = createTestPages(syntaxId);
// Edit the second section in the wysiwyg editor
WYSIWYGEditPage wysiwygEditPage = vp.editSection(2);
wysiwygEditPage.waitUntilPageIsLoaded();
Assert.assertEquals("Section2\nContent2\nSection3\nContent3\nSection4\nContent4\nSection5\nContent5\n"
+ "Section6\nContent6", wysiwygEditPage.getContent());
// Edit the second section in the wiki editor
WikiEditPage wikiEditPage = wysiwygEditPage.editWiki();
Assert.assertEquals("= Section2 = Content2 == Section3 == Content3 "
+ "{{include document=\"Test.SectionEditingIncluded\"/}}", wikiEditPage.getContent());
vp = wikiEditPage.clickCancel();
// Edit the third section in the wiki editor
wikiEditPage = vp.editSection(3).editWiki();
Assert.assertEquals("== Section3 == Content3 {{include document=\"Test.SectionEditingIncluded\"/}}",
wikiEditPage.getContent());
vp = wikiEditPage.clickCancel();
// Edit the fourth section in the wiki editor
// Note: we prove that included documents don't generate editable sections by checking that the fourth section
// is "Section7".
wikiEditPage = vp.editSection(4).editWiki();
Assert.assertEquals("= Section7 = Content7", wikiEditPage.getContent());
}
/**
* Verify section save does not override the whole document content (xwiki/1.0).
* See XWIKI-4033: When saving after section edit entire page is overwritten.
*/
@Test
@IgnoreBrowsers({
@IgnoreBrowser(value = "internet.*", version = "8\\.*", reason="See http://jira.xwiki.org/browse/XE-1146"),
@IgnoreBrowser(value = "internet.*", version = "9\\.*", reason="See http://jira.xwiki.org/browse/XE-1177")
})
public void testSectionSaveDoesNotOverwriteTheWholeContentWhenSyntax10()
{
ViewPage vp = createTestPages("xwiki/1.0");
vp.editSection(3).editWiki().clickSaveAndView();
WikiEditPage wep = vp.editWiki();
Assert.assertEquals("1 Section1 Content1 1 Section2 Content2 1.1 Section3 Content3 1 Section4 Content4",
wep.getContent());
}
/**
* Verify section save does not override the whole document content (xwiki/2.0).
* See XWIKI-4033: When saving after section edit entire page is overwritten.
*/
@Test
@IgnoreBrowsers({
@IgnoreBrowser(value = "internet.*", version = "8\\.*", reason="See http://jira.xwiki.org/browse/XE-1146"),
@IgnoreBrowser(value = "internet.*", version = "9\\.*", reason="See http://jira.xwiki.org/browse/XE-1177")
})
public void testSectionSaveDoesNotOverwriteTheWholeContentWhenSyntax20()
{
ViewPage vp = createTestPages("xwiki/2.0");
vp.editSection(4).editWiki().clickSaveAndView();
WikiEditPage wep = vp.editWiki();
Assert.assertEquals("= Section1 = Content1 = Section2 = Content2 == Section3 == Content3 "
+ "{{include document=\"Test.SectionEditingIncluded\"/}} = Section7 = Content7", wep.getContent());
}
/**
* Verify that the document title is not overwritten when saving a section.
*
* @see <a href="http://jira.xwiki.org/browse/XWIKI-8938">XWIKI-8938: Translated title is overwritten by the default
* translation title when editing a document section</a>
*/
@Test
public void testSectionSaveDoesNotOverwriteTheTitle()
{
// Create the English version.
setLanguageSettings(false, "en", "en");
getUtil().deletePage(getTestClassName(), getTestMethodName());
getUtil().createPage(getTestClassName(), getTestMethodName(), "Original content", "Original title");
try {
// Create the French version.
setLanguageSettings(true, "en", "en,fr");
Map<String, String> parameters = new HashMap<String, String>();
parameters.put("language", "fr");
parameters.put("title", "Translated title");
parameters.put("content", "= Chapter 1 =\n\n Once upon a time ...");
getUtil().gotoPage(getTestClassName(), getTestMethodName(), "save", parameters);
// Switch back to monolingual with French as default language.
setLanguageSettings(false, "fr", "fr");
// Edit and save a document section and check if the document title was overwritten.
getUtil().gotoPage(getTestClassName(), getTestMethodName(), "edit", "editor=wiki§ion=1");
Assert.assertEquals("Translated title", new WikiEditPage().clickSaveAndView().getDocumentTitle());
} finally {
// Restore language settings.
setLanguageSettings(false, "en", "en");
}
}
private void setLanguageSettings(boolean isMultiLingual, String defaultLanguage, String supportedLanguages)
{
AdministrationPage adminPage = AdministrationPage.gotoPage();
LocalizationAdministrationSectionPage localizationSection = adminPage.clickLocalizationSection();
localizationSection.setMultiLingual(isMultiLingual);
localizationSection.setDefaultLanguage(defaultLanguage);
localizationSection.setSupportedLanguages(supportedLanguages);
localizationSection.clickSave();
}
}