001 /*
002 * Copyright 2006-2012 The Kuali Foundation
003 *
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.opensource.org/licenses/ecl2.php
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016 package edu.samplu.travel.krad.test;
017
018 import edu.samplu.common.ITUtil;
019 import edu.samplu.common.WebDriverLegacyITBase;
020
021 import org.apache.commons.logging.Log;
022 import org.apache.commons.logging.LogFactory;
023 import org.junit.Test;
024 import org.kuali.rice.krad.uif.UifConstants;
025
026 import java.util.HashMap;
027 import java.util.Map;
028
029 import static org.junit.Assert.*;
030
031 /**
032 * Tests that the data attributes are rendered as expected for all controls
033 *
034 * @author Kuali Rice Team (rice.collab@kuali.org)
035 */
036 public class UifDataAttributesLegacyIT extends WebDriverLegacyITBase {
037 @Override
038 public String getTestUrl() {
039 return ITUtil.PORTAL;
040 }
041
042 private Log log = LogFactory.getLog(getClass());
043
044 /**
045 * verify that a tag has simple data attributes
046 *
047 * @param tag - html tag e.g. img or a
048 * @param tagId - derived from the bean id set in the view
049 * @param tagIdSuffix - where applicable, a suffix that is appended to the control by krad e.g. _control
050 */
051 private void verifySimpleAttributes(String tag, String tagId, String tagIdSuffix) throws Exception{
052 // test the attributes that are set via the data attributes list
053 tagId = tagId + tagIdSuffix;
054 String simpleAttributesXpath="//" + tag + "[@id='" + tagId + "' and @data-iconTemplateName='cool-icon-%s.png' and @data-transitions='3']";
055 assertTrue(tagId + " does not have simple data attributes (via list) present", isElementPresentByXpath(simpleAttributesXpath));
056 verifyStaticDataAttributes(tag, tagId);
057
058 }
059
060 /**
061 * test the attributes that are set via the data*Attribute properties
062 *
063 * @param tag - html tag e.g. img or a
064 * @param tagId - the html tag id - a combination of bean id and any suffix
065 */
066 private void verifyStaticDataAttributes(String tag, String tagId) {
067 final String simpleAttributesXpath;
068 simpleAttributesXpath="//" + tag + "[@id='" + tagId + "'"
069 + " and @data-dataroleattribute='role' and @data-datatypeattribute='type' and @data-datametaattribute='meta']";
070 assertTrue(tagId + " does not have simple data attributes (via data*Attribute) properties present",
071 isElementPresentByXpath(simpleAttributesXpath));
072 }
073
074 /**
075 * check that complex attributes exist in the script
076 *
077 * @param tagId - the expected tag id
078 * @param suffix - the expected suffix e.g. _button
079 */
080 private void verifyComplexAttributes(String tagId, String suffix)throws Exception {
081 tagId = tagId + suffix;
082 String complexAttributesXpath="//input[(@type='hidden') and (@data-role='dataScript') and (@data-for='"+ tagId + "')]";
083 assertTrue(tagId + ": complex data attributes script not found", isElementPresentByXpath(complexAttributesXpath));
084
085 // the message field does not support complex attributes
086 //if (!tagId.equalsIgnoreCase("messageField")) {
087 String scriptValue = getAttributeByXpath(complexAttributesXpath , "value");
088 assertNotNull("script value is null",scriptValue);
089 boolean ok = scriptValue.contains(
090 "jQuery('#" + tagId + "').data('capitals', {kenya:'nairobi', uganda:'kampala', tanzania:'dar'});")
091 && scriptValue.contains("jQuery('#" + tagId + "').data('intervals', {short:2, medium:5, long:13});");
092 if (!ok) {
093 log.info("scriptValue for " + tagId + " is " + scriptValue);
094 }
095 // check for complex attributes
096 assertTrue(tagId + ": complex attributes script does not contain expected code", ok);
097 //}
098 }
099
100 /**
101 * check that all attributes exist in the script
102 *
103 * @param tagId - the expected tag id
104 * @param suffix - the expected suffix e.g. _control
105 * @return true if all attributes were found in script, false otherwise
106 */
107 private boolean verifyAllAttributesInScript(String tagId, String suffix)throws Exception {
108 tagId = tagId + suffix;
109 String complexAttributesXpath="//input[@type='hidden' and @data-for='"+ tagId + "']";
110 assertTrue(tagId + ": complex data attributes script not found see https://jira.kuali.org/browse/KULRICE-7752", isElementPresentByXpath(complexAttributesXpath));
111
112 // the message field does not support complex attributes
113 String scriptValue = getAttributeByXpath(complexAttributesXpath , "value");
114 assertNotNull("script value is null",scriptValue);
115 // log.info("scriptValue for " + tagId + " is " + scriptValue);
116 return scriptValue.contains("jQuery('#" + tagId + "').data('transitions', 3);") &&
117 scriptValue.contains("jQuery('#" + tagId + "').data('iconTemplateName', 'cool-icon-%s.png');") &&
118 scriptValue.contains("jQuery('#" + tagId + "').data('capitals', {kenya:'nairobi', uganda:'kampala', tanzania:'dar'});") &&
119 scriptValue.contains("jQuery('#" + tagId + "').data('intervals', {short:2, medium:5, long:13});");
120 }
121
122
123 /**
124 * Tests that the data attributes are rendered as expected for all controls
125 */
126 @Test
127 public void testDataAttributesPresentInControls () throws Exception{
128 assertEquals("Kuali Portal Index", getTitle());
129 open(getBaseUrlString()+ "/kr-krad/data-attributes-test-uif-controller?viewId=dataAttributesView_selenium&methodToCall=start");
130 waitForPageToLoad(); // if this times out make a special one that 50000
131
132 // custom suffix to mark test bean ids
133 String testIdSuffix = "_attrs";
134 // input fields, whose controls are implemented as spring form tags, will have both simple and complex attributes set via a script
135 String[] inputControls = {"textInputField", "textAreaInputField", "dropDown", "datePicker", "fileUpload", "userControl",
136 "spinnerControl", "hiddenControl", "checkBox"};//, "radioButton",
137 for (int i=0; i<inputControls.length; i++) {
138 assertTrue(inputControls[i] + ": script does not contain expected code",
139 verifyAllAttributesInScript(inputControls[i], testIdSuffix + UifConstants.IdSuffixes.CONTROL));
140 String tag = "input";
141 if (inputControls[i].equalsIgnoreCase("textAreaInputField")) {
142 tag = "textarea";
143 } else if (inputControls[i].equalsIgnoreCase("dropDown")) {
144 tag = "select";
145 }
146 try {
147 verifyStaticDataAttributes(tag, inputControls[i] + testIdSuffix + UifConstants.IdSuffixes.CONTROL);
148 } catch (AssertionError ae) {
149 assertTrue("KULRICE-7752 : UifDataAttributesIT testDataAttributesPresentInControls textInputField_attrs_control: complex data attributes script not found", false);
150 }
151 }
152 // these controls allow for simple attributes on the tag and complex attributes via js
153 Map<String, String[]> otherControlsMap = new HashMap<String, String[]>();
154 // controls whose simple attributes are set in an img tag
155 String[] imgControls = {"imageField_image"};
156 // fields whose simple attributes are set in an anchor tag
157 String[] anchorFields = {"navigationLink", "actionLink-noImage", "actionLink-imageRight", "actionLink-imageLeft", "linkElement"};
158 // fields whose simple attributes are set in a span tag
159 String[] spanFields = {"messageField"};
160 // fields whose simple attributes are set in an input tag
161 String[] inputFields = {"imageAction"};
162 // fields whose simple attributes are set in button tag
163 String[] buttonElements = {"buttonTextOnly", "buttonImageBottom", "buttonImageLeft", "buttonImageTop", "buttonImageRight"};
164 // iframe field
165 String[] iframeField = {"iframe"};
166 String[] divField={"spaceField","linkField"};
167
168 otherControlsMap.put("img", imgControls);
169 otherControlsMap.put("a", anchorFields);
170 otherControlsMap.put("span", spanFields);
171 otherControlsMap.put("input", inputFields);
172 otherControlsMap.put("button", buttonElements);
173 otherControlsMap.put("iframe", iframeField);
174 otherControlsMap.put("div", divField);
175
176 // a map to hold the tags where the simple attributes are affixed
177 // if a tag is not here, a empty string will be used for the suffix
178 Map<String, String> simpleTagIdSuffix = new HashMap<String, String>();
179 simpleTagIdSuffix.put("span", "_span");
180
181
182 for (String tag: otherControlsMap.keySet()) {
183 String[] controlIds = otherControlsMap.get(tag);
184 for (int i=0; i<controlIds.length; i++) {
185 String tagId = controlIds[i];
186
187 // check for complex attributes
188 verifyComplexAttributes(tagId, testIdSuffix);
189
190 // determine whether we are using a tag id suffix for the simple attributes
191 String tagIdSuffix = testIdSuffix;
192 if (simpleTagIdSuffix.containsKey(tag)) {
193 tagIdSuffix = tagIdSuffix + simpleTagIdSuffix.get(tag);
194 }
195
196 // check for simple attributes
197 verifySimpleAttributes(tag, tagId, tagIdSuffix);
198 }
199
200 // test label field - which uses the tagId suffix for both the simple attributes and complex
201 String tagId = "textInputField";
202 String tagIdSuffix = testIdSuffix + "_label";
203 // check for complex attributes
204 verifyComplexAttributes(tagId, tagIdSuffix);
205 // check for simple attributes
206 verifySimpleAttributes("label", tagId, tagIdSuffix);
207
208 //test that the radio buttons have the 3 data attributes that can appear in the tag
209 tagId = "radioButton" + testIdSuffix + UifConstants.IdSuffixes.CONTROL;
210 String[] radioButtonIds = {tagId + "_0", tagId + "_1"};
211 for (String id: radioButtonIds) {
212 verifyStaticDataAttributes("input", id);
213 }
214 //test that all complex and simple attributes set via the list are in a script
215 verifyAllAttributesInScript(tagId, "");
216 }
217 passed();
218 }
219 }