mirror of
https://github.com/vanitasvitae/Smack.git
synced 2025-09-15 03:59:38 +02:00
Support for XEP-0141: Data Forms Layout.
Data Forms layouts are a part of Data Forms and implemented as extensions, added to a Dataform. Fixes issue SMACK-612.
This commit is contained in:
Anno
Florian Schmaus
parent
6e569701b3
commit
ff977825da
8 changed files with 726 additions and 0 deletions
|
|
@ -0,0 +1,146 @@
|
|||
/**
|
||||
*
|
||||
* Copyright 2014 Anno van Vliet
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
package org.jivesoftware.smackx.xdata.packet;
|
||||
|
||||
import static org.junit.Assert.assertEquals;
|
||||
import static org.junit.Assert.assertNotNull;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.io.StringReader;
|
||||
import java.util.logging.Logger;
|
||||
|
||||
import org.jivesoftware.smack.SmackException;
|
||||
import org.jivesoftware.smack.packet.Element;
|
||||
import org.jivesoftware.smack.util.PacketParserUtils;
|
||||
import org.jivesoftware.smackx.xdata.FormField;
|
||||
import org.jivesoftware.smackx.xdata.provider.DataFormProvider;
|
||||
import org.jivesoftware.smackx.xdatalayout.packet.DataLayout;
|
||||
import org.jivesoftware.smackx.xdatalayout.packet.DataLayout.Fieldref;
|
||||
import org.jivesoftware.smackx.xdatalayout.packet.DataLayout.Section;
|
||||
import org.jivesoftware.smackx.xdatalayout.packet.DataLayout.Text;
|
||||
import org.junit.Test;
|
||||
import org.xmlpull.v1.XmlPullParser;
|
||||
import org.xmlpull.v1.XmlPullParserException;
|
||||
|
||||
/**
|
||||
* Unit tests for DataForm reading and parsing.
|
||||
*
|
||||
* @author Anno van Vliet
|
||||
*
|
||||
*/
|
||||
public class DataFormTest {
|
||||
private static final String TEST_OUTPUT_1 = "<x xmlns='jabber:x:data' type='SUBMIT'><instructions>InstructionTest1</instructions><field var='testField1'></field></x>";
|
||||
private static final String TEST_OUTPUT_2 = "<x xmlns='jabber:x:data' type='SUBMIT'><instructions>InstructionTest1</instructions><field var='testField1'></field><page xmlns='http://jabber.org/protocol/xdata-layout' label='Label'><fieldref var='testField1'/><section label='section Label'><text>SectionText</text></section><text>PageText</text></page></x>";
|
||||
private static Logger logger = Logger.getLogger(DataFormTest.class.getName());
|
||||
|
||||
@Test
|
||||
public void test() throws XmlPullParserException, IOException, SmackException {
|
||||
|
||||
//Build a Form
|
||||
DataForm df = new DataForm("SUBMIT");
|
||||
String instruction = "InstructionTest1";
|
||||
df.addInstruction(instruction);
|
||||
FormField field = new FormField("testField1");
|
||||
df.addField(field);
|
||||
|
||||
assertNotNull( df.toXML());
|
||||
String output = df.toXML().toString();
|
||||
logger.finest(output);
|
||||
assertEquals(TEST_OUTPUT_1, output);
|
||||
|
||||
DataFormProvider pr = new DataFormProvider();
|
||||
|
||||
XmlPullParser parser = getParser(output);
|
||||
|
||||
df = pr.parse(parser);
|
||||
|
||||
assertNotNull(df);
|
||||
assertNotNull(df.getFields());
|
||||
assertEquals(1 , df.getFields().size() );
|
||||
assertEquals(1 , df.getInstructions().size());
|
||||
|
||||
assertNotNull( df.toXML());
|
||||
output = df.toXML().toString();
|
||||
logger.finest(output);
|
||||
assertEquals(TEST_OUTPUT_1, output);
|
||||
|
||||
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testLayout() throws XmlPullParserException, IOException, SmackException {
|
||||
|
||||
//Build a Form
|
||||
DataForm df = new DataForm("SUBMIT");
|
||||
String instruction = "InstructionTest1";
|
||||
df.addInstruction(instruction);
|
||||
FormField field = new FormField("testField1");
|
||||
df.addField(field);
|
||||
|
||||
DataLayout layout = new DataLayout("Label");
|
||||
Fieldref reffield = new Fieldref("testField1");
|
||||
layout.getPageLayout().add(reffield);
|
||||
Section section = new Section("section Label");
|
||||
section.getSectionLayout().add(new Text("SectionText"));
|
||||
layout.getPageLayout().add(section);
|
||||
layout.getPageLayout().add(new Text("PageText"));
|
||||
|
||||
df.addExtensionElement(layout);
|
||||
|
||||
|
||||
assertNotNull( df.toXML());
|
||||
String output = df.toXML().toString();
|
||||
logger.finest(output);
|
||||
assertEquals(TEST_OUTPUT_2, output);
|
||||
|
||||
DataFormProvider pr = new DataFormProvider();
|
||||
|
||||
XmlPullParser parser = getParser(output);
|
||||
|
||||
df = pr.parse(parser);
|
||||
|
||||
assertNotNull(df);
|
||||
assertNotNull(df.getExtensionElements());
|
||||
assertEquals(1 , df.getExtensionElements().size() );
|
||||
Element element = df.getExtensionElements().get(0);
|
||||
assertNotNull(element);
|
||||
layout = (DataLayout) element;
|
||||
|
||||
assertEquals(3 , layout.getPageLayout().size());
|
||||
|
||||
assertNotNull( df.toXML());
|
||||
output = df.toXML().toString();
|
||||
logger.finest(output);
|
||||
assertEquals(TEST_OUTPUT_2, output);
|
||||
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* @param output
|
||||
* @return
|
||||
* @throws XmlPullParserException
|
||||
* @throws IOException
|
||||
*/
|
||||
private XmlPullParser getParser(String output) throws XmlPullParserException, IOException {
|
||||
logger.finest("getParser");
|
||||
XmlPullParser parser = PacketParserUtils.newXmppParser();
|
||||
parser.setInput(new StringReader(output));
|
||||
parser.next();
|
||||
return parser;
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,185 @@
|
|||
/**
|
||||
*
|
||||
* Copyright 2014 Anno van Vliet, All rights reserved.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
package org.jivesoftware.smackx.xdatalayout.packet;
|
||||
|
||||
import static org.junit.Assert.assertEquals;
|
||||
import static org.junit.Assert.assertNotNull;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.io.InputStreamReader;
|
||||
import java.io.StringReader;
|
||||
import java.util.logging.Logger;
|
||||
|
||||
import org.jivesoftware.smack.SmackException;
|
||||
import org.jivesoftware.smack.util.PacketParserUtils;
|
||||
import org.jivesoftware.smackx.xdata.packet.DataForm;
|
||||
import org.jivesoftware.smackx.xdata.provider.DataFormProvider;
|
||||
import org.jivesoftware.smackx.xdatalayout.packet.DataLayout.Fieldref;
|
||||
import org.jivesoftware.smackx.xdatalayout.packet.DataLayout.Reportedref;
|
||||
import org.jivesoftware.smackx.xdatalayout.packet.DataLayout.Section;
|
||||
import org.jivesoftware.smackx.xdatalayout.packet.DataLayout.Text;
|
||||
import org.jivesoftware.smackx.xdatalayout.provider.DataLayoutProvider;
|
||||
import org.junit.Test;
|
||||
import org.xmlpull.v1.XmlPullParser;
|
||||
import org.xmlpull.v1.XmlPullParserException;
|
||||
|
||||
/**
|
||||
* Unit tests for DataForm reading and parsing.
|
||||
*
|
||||
* @author Anno van Vliet
|
||||
*
|
||||
*/
|
||||
public class DataLayoutTest {
|
||||
private static final String TEST_OUTPUT_2 = "<page xmlns='http://jabber.org/protocol/xdata-layout' label='Label'><fieldref var='testField1'/><section label='section Label'><text>SectionText</text></section><text>PageText</text></page>";
|
||||
private static final String TEST_OUTPUT_SPECIAL = "<page xmlns='http://jabber.org/protocol/xdata-layout' label='Label - & \u00E9 \u00E1 '><fieldref var='testField1'/><section label='section Label - & \u00E9 \u00E1 '><text>SectionText - & \u00E9 \u00E1 </text></section><text>PageText - & \u00E9 \u00E1 </text><section label='<html>Number of Persons by<br/> Nationality and Status</html>'><reportedref/></section><text><html><font color='red'><em>DO NOT DELAY</em></font><br/>supply further information</html></text></page>";
|
||||
private static final String TEST_INPUT_1 = "xdata-layout-sample.xml";
|
||||
private static Logger logger = Logger.getLogger(DataLayoutTest.class.getName());
|
||||
|
||||
|
||||
@Test
|
||||
public void testLayout() throws XmlPullParserException, IOException, SmackException {
|
||||
|
||||
DataLayout layout = new DataLayout("Label");
|
||||
Fieldref reffield = new Fieldref("testField1");
|
||||
layout.getPageLayout().add(reffield);
|
||||
Section section = new Section("section Label");
|
||||
section.getSectionLayout().add(new Text("SectionText"));
|
||||
layout.getPageLayout().add(section);
|
||||
layout.getPageLayout().add(new Text( "PageText"));
|
||||
|
||||
assertNotNull( layout.toXML());
|
||||
String output = layout.toXML().toString();
|
||||
logger.finest(output);
|
||||
assertEquals(TEST_OUTPUT_2, output);
|
||||
|
||||
DataLayoutProvider pr = DataLayoutProvider.INSTANCE;
|
||||
|
||||
XmlPullParser parser = getParser(output);
|
||||
|
||||
layout = pr.parse(parser);
|
||||
|
||||
assertEquals(3 , layout.getPageLayout().size());
|
||||
assertEquals("Label", layout.getLabel());
|
||||
|
||||
assertNotNull( layout.toXML());
|
||||
output = layout.toXML().toString();
|
||||
logger.finest(output);
|
||||
assertEquals(TEST_OUTPUT_2, output);
|
||||
|
||||
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testLayoutSpecialCharacters() throws XmlPullParserException, IOException, SmackException {
|
||||
|
||||
DataLayout layout = new DataLayout("Label - & \u00E9 \u00E1 ");
|
||||
Fieldref reffield = new Fieldref("testField1");
|
||||
layout.getPageLayout().add(reffield);
|
||||
Section section = new Section("section Label - & \u00E9 \u00E1 ");
|
||||
section.getSectionLayout().add(new Text( "SectionText - & \u00E9 \u00E1 "));
|
||||
layout.getPageLayout().add(section);
|
||||
layout.getPageLayout().add(new Text( "PageText - & \u00E9 \u00E1 "));
|
||||
|
||||
section = new Section("<html>Number of Persons by<br/> Nationality and Status</html>");
|
||||
section.getSectionLayout().add(new Reportedref());
|
||||
layout.getPageLayout().add(section);
|
||||
|
||||
layout.getPageLayout().add(new Text( "<html><font color='red'><em>DO NOT DELAY</em></font><br/>supply further information</html>"));
|
||||
|
||||
|
||||
assertNotNull( layout.toXML());
|
||||
String output = layout.toXML().toString();
|
||||
logger.finest(output);
|
||||
assertEquals(TEST_OUTPUT_SPECIAL, output);
|
||||
|
||||
DataLayoutProvider pr = DataLayoutProvider.INSTANCE;
|
||||
|
||||
XmlPullParser parser = getParser(output);
|
||||
|
||||
layout = pr.parse(parser);
|
||||
|
||||
assertEquals(5 , layout.getPageLayout().size());
|
||||
assertEquals("Label - & \u00E9 \u00E1 ", layout.getLabel());
|
||||
section = (Section) layout.getPageLayout().get(1);
|
||||
assertEquals("section Label - & \u00E9 \u00E1 ", section.getLabel());
|
||||
Text text = (Text)layout.getPageLayout().get(2);
|
||||
assertEquals("PageText - & \u00E9 \u00E1 ", text.getText());
|
||||
section = (Section) layout.getPageLayout().get(3);
|
||||
assertEquals("<html>Number of Persons by<br/> Nationality and Status</html>", section.getLabel());
|
||||
text = (Text) layout.getPageLayout().get(4);
|
||||
assertEquals("<html><font color='red'><em>DO NOT DELAY</em></font><br/>supply further information</html>", text.getText());
|
||||
|
||||
|
||||
assertNotNull( layout.toXML());
|
||||
output = layout.toXML().toString();
|
||||
logger.finest(output);
|
||||
assertEquals(TEST_OUTPUT_SPECIAL, output);
|
||||
|
||||
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testLayoutFromFile() throws XmlPullParserException, IOException, SmackException {
|
||||
|
||||
|
||||
DataFormProvider pr = new DataFormProvider();
|
||||
|
||||
XmlPullParser parser = PacketParserUtils.newXmppParser();
|
||||
parser.setInput(new InputStreamReader(this.getClass().getResourceAsStream(TEST_INPUT_1), "UTF-8"));
|
||||
parser.next();
|
||||
|
||||
DataForm form = pr.parse(parser);
|
||||
assertNotNull( form);
|
||||
assertEquals(1 , form.getExtensionElements().size());
|
||||
|
||||
DataLayout layout = (DataLayout) form.getExtensionElements().get(0);
|
||||
|
||||
assertEquals(5 , layout.getPageLayout().size());
|
||||
assertEquals("Label - & \u00E9 \u00E1 ", layout.getLabel());
|
||||
Section section = (Section) layout.getPageLayout().get(1);
|
||||
assertEquals("section Label - & \u00E9 \u00E1 ", section.getLabel());
|
||||
Text text = (Text)layout.getPageLayout().get(2);
|
||||
assertEquals("PageText - & \u00E9 \u00E1 ", text.getText());
|
||||
section = (Section) layout.getPageLayout().get(3);
|
||||
assertEquals("<html>Number of Persons by<br/> Nationality and Status</html>", section.getLabel());
|
||||
text = (Text) layout.getPageLayout().get(4);
|
||||
assertEquals("<html><font color='red'><em>DO NOT DELAY</em></font><br/>supply further information</html>", text.getText());
|
||||
|
||||
|
||||
assertNotNull( layout.toXML());
|
||||
String output = layout.toXML().toString();
|
||||
logger.finest(output);
|
||||
assertEquals(TEST_OUTPUT_SPECIAL, output);
|
||||
|
||||
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* @param output
|
||||
* @return
|
||||
* @throws XmlPullParserException
|
||||
* @throws IOException
|
||||
*/
|
||||
private XmlPullParser getParser(String output) throws XmlPullParserException, IOException {
|
||||
logger.finest("getParser");
|
||||
XmlPullParser parser = PacketParserUtils.newXmppParser();
|
||||
parser.setInput(new StringReader(output));
|
||||
parser.next();
|
||||
return parser;
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<x xmlns='jabber:x:data' type='form'>
|
||||
<page xmlns='http://jabber.org/protocol/xdata-layout' label='Label - & é á '>
|
||||
<fieldref var='testField1' />
|
||||
<section label='section Label - & é á '>
|
||||
<text>SectionText - & é á </text>
|
||||
</section>
|
||||
<text>PageText - & é á </text>
|
||||
<section
|
||||
label='<html>Number of Persons by<br/> Nationality and Status</html>'>
|
||||
<reportedref />
|
||||
</section>
|
||||
<text><![CDATA[<html><font color='red'><em>DO NOT DELAY</em></font><br/>supply further information</html>]]></text>
|
||||
</page>
|
||||
</x>
|
||||
Loading…
Add table
Add a link
Reference in a new issue