View Javadoc

1   /*
2    * Copyright 2005-2013 The Kuali Foundation
3    *
4    * Licensed under the Educational Community License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * http://www.opensource.org/licenses/ecl2.php
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package edu.samplu.travel.krad.test;
17  
18  import edu.samplu.common.ITUtil;
19  import edu.samplu.common.WebDriverLegacyITBase;
20  
21  import org.apache.commons.logging.Log;
22  import org.apache.commons.logging.LogFactory;
23  import org.junit.Test;
24  import org.kuali.rice.krad.uif.UifConstants;
25  
26  import java.util.HashMap;
27  import java.util.Map;
28  
29  import static org.junit.Assert.*;
30  
31  /**
32   *  Tests that the data attributes are rendered as expected for all controls
33   * 
34   * @author Kuali Rice Team (rice.collab@kuali.org)
35   */
36  public class UifDataAttributesNavIT extends WebDriverLegacyITBase {
37  
38      @Override
39      public String getTestUrl() {
40          return ITUtil.PORTAL;
41      }
42  
43      private  Log log = LogFactory.getLog(getClass());
44  
45      /**
46       * verify that a tag has simple data attributes
47       *
48       * @param tag - html tag e.g. img or a
49       * @param tagId - derived from the bean id set in the view
50       * @param tagIdSuffix - where applicable, a suffix that is appended to the control by krad e.g. _control
51       */
52      private void verifySimpleAttributes(String tag, String tagId, String tagIdSuffix) throws Exception{
53          // test the attributes that are set via the data attributes list
54          tagId = tagId + tagIdSuffix;
55          String simpleAttributesXpath="//" + tag + "[@id='" + tagId + "' and @data-iconTemplateName='cool-icon-%s.png' and @data-transitions='3']";
56          assertTrue(tagId + " does not have simple data attributes (via list) present", isElementPresentByXpath(simpleAttributesXpath));
57          verifyStaticDataAttributes(tag, tagId);
58  
59      }
60  
61      /**
62       * test the attributes that are set via the data*Attribute properties
63       *
64       * @param tag - html tag e.g. img or a
65       * @param tagId - the html tag id - a combination of bean id and any suffix
66       */
67      private void verifyStaticDataAttributes(String tag, String tagId) {
68          final String simpleAttributesXpath;
69          simpleAttributesXpath="//" + tag + "[@id='" + tagId + "'"
70                  + " and @data-dataroleattribute='role' and @data-datatypeattribute='type' and @data-datametaattribute='meta']";
71          assertTrue(tagId + " does not have simple data attributes (via data*Attribute) properties present",
72                  isElementPresentByXpath(simpleAttributesXpath));
73      }
74  
75      /**
76       * check that complex attributes exist in the script
77       *
78       * @param tagId - the expected tag id
79       * @param suffix - the expected suffix e.g. _button
80       */
81      private void verifyComplexAttributes(String tagId, String suffix)throws Exception {
82          tagId = tagId + suffix;
83          String complexAttributesXpath="//input[(@type='hidden') and (@data-role='dataScript') and (@data-for='"+ tagId +  "')]";
84          assertTrue(tagId + ": complex data attributes script not found", isElementPresentByXpath(complexAttributesXpath));
85  
86          // the message field does not support complex attributes
87          //if (!tagId.equalsIgnoreCase("messageField")) {
88              String scriptValue = getAttributeByXpath(complexAttributesXpath , "value");
89              assertNotNull("script value is null",scriptValue);
90          boolean ok = scriptValue.contains(
91                  "jQuery('#" + tagId + "').data('capitals', {kenya:'nairobi', uganda:'kampala', tanzania:'dar'});")
92                  && scriptValue.contains("jQuery('#" + tagId + "').data('intervals', {short:2, medium:5, long:13});");
93          if (!ok) {
94              log.info("scriptValue for " + tagId + " is " + scriptValue);
95          }
96          // check for complex attributes
97          assertTrue(tagId + ": complex attributes script does not contain expected code", ok);
98          //}
99      }
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 }