1 /**
2 * This file Copyright (c) 2003-2013 Magnolia International
3 * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4 *
5 *
6 * This file is dual-licensed under both the Magnolia
7 * Network Agreement and the GNU General Public License.
8 * You may elect to use one or the other of these licenses.
9 *
10 * This file is distributed in the hope that it will be
11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12 * implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14 * Redistribution, except as permitted by whichever of the GPL
15 * or MNA you select, is prohibited.
16 *
17 * 1. For the GPL license (GPL), you can redistribute and/or
18 * modify this file under the terms of the GNU General
19 * Public License, Version 3, as published by the Free Software
20 * Foundation. You should have received a copy of the GNU
21 * General Public License, Version 3 along with this program;
22 * if not, write to the Free Software Foundation, Inc., 51
23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24 *
25 * 2. For the Magnolia Network Agreement (MNA), this file
26 * and the accompanying materials are made available under the
27 * terms of the MNA which accompanies this distribution, and
28 * is available at http://www.magnolia-cms.com/mna.html
29 *
30 * Any modifications to this file must keep this entire header
31 * intact.
32 *
33 */
34 package info.magnolia.testframework;
35
36 import org.apache.commons.lang.StringUtils;
37
38 /**
39 * A base class for Magnolia integration tests. Allows to overwrite context paths and domain via system properties in case
40 * you want to run them e.g. against webapps served from your IDE.
41 */
42 public abstract class AbstractMagnoliaIntegrationTest {
43
44 /**
45 * Name of the property that can be used to overwrite the context path for the author instance.
46 */
47 public static final String AUTHOR_CONTEXT_PATH_PROPERTY = "authorContextPath";
48
49 /**
50 * Name of the property that can be used to overwrite the context path for the public instance.
51 */
52 public static final String PUBLIC_CONTEXT_PATH_PROPERTY = "publicContextPath";
53
54 /**
55 * Name of the property that can be used to overwrite the domain for the webapps.
56 */
57 public static final String DOMAIN_PROPERTY = "containerRootURL";
58
59 /**
60 * Default domain, should never be used.
61 */
62 public static final String DEFAULT_DOMAIN = "http://localhost:8299/";
63
64 /**
65 * A simple way of referring to one of the two test instances deployed during ITs.
66 */
67 public enum Instance implements InstanceProperties {
68 AUTHOR {
69 @Override
70 public String getContextPath() {
71 final String authorContextPath = System.getProperty(AUTHOR_CONTEXT_PATH_PROPERTY);
72 return StringUtils.isEmpty(authorContextPath) ? "magnoliaTest/" : authorContextPath;
73 }
74 },
75 PUBLIC {
76 @Override
77 public String getContextPath() {
78 final String authorContextPath = System.getProperty(PUBLIC_CONTEXT_PATH_PROPERTY);
79 return StringUtils.isEmpty(authorContextPath) ? "magnoliaTestPublic/" : authorContextPath;
80 }
81 };
82
83 @Override
84 public String getURL() {
85 final String domainFromProperty = System.getProperty(DOMAIN_PROPERTY);
86 final String domain = StringUtils.isEmpty(domainFromProperty) ? DEFAULT_DOMAIN : domainFromProperty;
87 return domain + getContextPath();
88 }
89
90 @Override
91 public String getURL(String path) {
92 if (path.startsWith("/")) {
93 path = path.substring(1);
94 }
95 return getURL() + path;
96 }
97 }
98
99 private interface InstanceProperties {
100 String getContextPath();
101
102 String getURL();
103
104 String getURL(String path);
105 }
106
107 /**
108 * Pre-configured users available for tests.
109 */
110 public enum User {
111 superuser,
112 eric,
113 peter
114 }
115
116 }