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.admin.test;
17  
18  import edu.samplu.common.ITUtil;
19  
20  import freemarker.cache.ClassTemplateLoader;
21  import freemarker.template.Configuration;
22  import freemarker.template.Template;
23  import freemarker.template.TemplateException;
24  import org.apache.commons.io.FileUtils;
25  import org.apache.log4j.Logger;
26  import org.junit.Ignore;
27  import org.junit.Rule;
28  import org.junit.Test;
29  import org.junit.rules.TemporaryFolder;
30  import org.openqa.selenium.By;
31  import org.springframework.ui.freemarker.FreeMarkerTemplateUtils;
32  
33  import java.io.File;
34  import java.io.FileInputStream;
35  import java.io.IOException;
36  import java.io.InputStream;
37  import java.util.ArrayList;
38  import java.util.Enumeration;
39  import java.util.List;
40  import java.util.Properties;
41  
42  /**
43   * tests uploads of new users and group
44   *
45   * <pre>mvn -f rice-middleware/sampleapp/pom.xml -Pstests failsafe:integration-test -Dremote.public.url=env7.rice.kuali.org -Dit.test=XMLIngesterNavIT -DXMLIngester.groupId=2008 -DXMLIngester.userIncludeDTSinPrefix=false -DXMLIngester.userCntBegin=0 -DXMLIngester.userCnt=600  -DXMLIngester.userPrefix=loadtester -Dremote.driver.dontTearDown=y</pre>
46   *
47   * @deprecated XMLIngesterSTJUnitNavGen
48   * @author Kuali Rice Team (rice.collab@kuali.org)
49   */
50  public class XMLIngesterNavIT extends AdminTmplMthdSTNavBase {
51  
52      protected final Logger LOG = Logger.getLogger(getClass());
53  
54      // File generation
55      private Configuration cfg;
56      private String PROPS_LOCATION = System.getProperty("xmlingester.props.location", null);
57      private String DEFAULT_PROPS_LOCATION = "XML/xmlingester.properties";
58  
59      // Templates for File Generation
60      private static final String DIR_TMPL = "/XML/";
61      private static final String TMPL_USER_CONTENT = "SimpleUserContent.ftl";
62      private static final String TMPL_GROUP_CONTENT = "SimpleGroupContent.ftl";
63  
64      @Rule
65      public TemporaryFolder folder= new TemporaryFolder();
66  
67      @Ignore
68      @Override
69      public void testCreateNewCancel() throws Exception {}
70  
71      @Ignore
72      @Override
73      public void testEditCancel() throws Exception {}
74  
75  
76      @Override
77      protected String getLinkLocator() {
78          return "XML Ingester";
79      }
80  
81      @Override
82      public String getUserName() {
83          return "admin"; // xml ingestion requires admin permissions
84      }
85  
86      @Override
87      public void setUp() throws Exception {
88          super.setUp();
89          // generated load users and group resources
90          cfg = new Configuration();
91          cfg.setTemplateLoader(new ClassTemplateLoader(getClass().getClassLoader().getClass(), DIR_TMPL));
92      }
93  
94      private List<File> buildFileUploadList() throws Exception {
95          List<File> fileUploadList = new ArrayList<File>();
96          try {
97              // update properties with timestamp value if includeDTSinPrefix is true
98              Properties props = loadProperties(PROPS_LOCATION, DEFAULT_PROPS_LOCATION);
99              if(props.get("userIncludeDTSinPrefix") != null
100                     && "true".equalsIgnoreCase((String) props.get("userIncludeDTSinPrefix"))) {
101                 props.setProperty("userPrefix", "" + props.get("userPrefix") + ITUtil.DTS);
102             }
103             systemPropertiesOverride(props);
104 
105             // build files and add to array
106             fileUploadList.add(
107                     writeTemplateToFile(
108                             folder.newFile("loadtest-users.xml"), cfg.getTemplate(TMPL_USER_CONTENT), props));
109             fileUploadList.add(
110                     writeTemplateToFile(
111                             folder.newFile("loadtest-group.xml"), cfg.getTemplate(TMPL_GROUP_CONTENT), props));
112         } catch( Exception e) {
113             throw new Exception("Unable to generate files for upload", e);
114         }
115         return fileUploadList;
116     }
117 
118     /**
119      * -DXMLIngester.userCnt=176 will override the userCnt in property files.
120      * @param props
121      */
122     private void systemPropertiesOverride(Properties props) {
123         Enumeration<?> names = props.propertyNames();
124         Object nameObject;
125         String name;
126         while (names.hasMoreElements()) {
127             nameObject = names.nextElement();
128             if (nameObject instanceof String) {
129                 name = (String)nameObject;
130                 props.setProperty(name, System.getProperty("XMLIngester." + name, props.getProperty(name)));
131             }
132         }
133     }
134 
135     /**
136      * Based on load user and groups manual tests; dynamically generates user and group file
137      * and loads into the xml ingester screen
138      *
139      */
140     @Test
141     public void testXMLIngesterSuccessfulFileUpload() throws Exception {
142         List<File> fileUploadList = buildFileUploadList();
143         gotoMenuLinkLocator();
144         int cnt = 0;
145         for(File file : fileUploadList) {
146             String path = file.getAbsolutePath().toString();
147             driver.findElement(By.name("file[" + cnt + "]")).sendKeys(path);
148             cnt++;
149         }
150         waitAndClickByXpath("//*[@id='imageField']");
151 
152         // confirm all files were uploaded successfully
153         for(File file: fileUploadList) {
154             assertTextPresent("Ingested xml doc: " + file.getName());
155         }
156         passed();
157     }
158 
159     /**
160      * Loads properties from user defined properties file, if not available uses resource file
161      *
162      * @return
163      * @throws IOException
164      */
165     private Properties loadProperties(String fileLocation, String resourceLocation) throws IOException {
166         Properties props = new Properties();
167         InputStream in = null;
168         if(fileLocation != null) {
169             in = new FileInputStream(fileLocation);
170         } else {
171             in = getClass().getClassLoader().getResourceAsStream(resourceLocation);
172         }
173         if(in != null) {
174             props.load(in);
175             in.close();
176         }
177         return props;
178     }
179 
180     /**
181      * writes processed template  to file
182      *
183      * @param file
184      * @param template
185      * @param props
186      * @return
187      * @throws IOException
188      * @throws TemplateException
189      */
190     private File writeTemplateToFile(File file, Template template, Properties props) throws IOException, TemplateException {
191         String output = FreeMarkerTemplateUtils.processTemplateIntoString(template, props);
192         LOG.debug("Generated File Output: " + output);
193         FileUtils.writeStringToFile(file, output);
194         return file;
195     }
196 }