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