001: /********************************************************************************
002: * CruiseControl, a Continuous Integration Toolkit
003: * Copyright (c) 2001, ThoughtWorks, Inc.
004: * 200 E. Randolph, 25th Floor
005: * Chicago, IL 60601 USA
006: * All rights reserved.
007: *
008: * Redistribution and use in source and binary forms, with or without
009: * modification, are permitted provided that the following conditions
010: * are met:
011: *
012: * + Redistributions of source code must retain the above copyright
013: * notice, this list of conditions and the following disclaimer.
014: *
015: * + Redistributions in binary form must reproduce the above
016: * copyright notice, this list of conditions and the following
017: * disclaimer in the documentation and/or other materials provided
018: * with the distribution.
019: *
020: * + Neither the name of ThoughtWorks, Inc., CruiseControl, nor the
021: * names of its contributors may be used to endorse or promote
022: * products derived from this software without specific prior
023: * written permission.
024: *
025: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
026: * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
027: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
028: * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR
029: * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
030: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
031: * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
032: * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
033: * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
034: * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
035: * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
036: ********************************************************************************/package net.sourceforge.cruisecontrol.sourcecontrols;
037:
038: import net.sourceforge.cruisecontrol.CruiseControlException;
039: import net.sourceforge.cruisecontrol.util.Commandline;
040: import net.sourceforge.cruisecontrol.util.ManagedCommandline;
041:
042: import org.apache.log4j.Logger;
043:
044: import java.io.IOException;
045:
046: /**
047: * This class implements the SourceControl methods for an AlienBrain
048: * repository. It does this by taking advantage of the AlienBrain command-
049: * line utility. Obviously, the command line utility must be installed
050: * and working in order for this class to work.
051: *
052: * This class is based very heavily on P4.java.
053: *
054: * @author <a href="mailto:scottj+cc@escherichia.net">Scott Jacobs</a>
055: */
056: public class AlienBrainCore {
057:
058: private static final Logger LOG = Logger
059: .getLogger(AlienBrainCore.class);
060:
061: protected static final String AB_NO_SESSION = "Invalid session please logon!";
062:
063: private String server;
064: private String database;
065: private String user;
066: private String password;
067: private String path;
068: private String branch;
069:
070: /**
071: * Sets the hostname of the server hosting the AlienBrain repository.
072: *
073: *@param server The AlienBrain server's hostname.
074: */
075: public void setServer(String server) {
076: this .server = server;
077: }
078:
079: public String getServer() {
080: return server;
081: }
082:
083: /**
084: * Sets the name of the project database.
085: *
086: *@param database The name of the project database.
087: */
088: public void setDatabase(String database) {
089: this .database = database;
090: }
091:
092: public String getDatabase() {
093: return database;
094: }
095:
096: /**
097: * Sets the name of the AlienBrain user account used to connect.
098: *
099: *@param user The name of the AlienBrin user account.
100: */
101: public void setUser(String user) {
102: this .user = user;
103: }
104:
105: public String getUser() {
106: return user;
107: }
108:
109: /**
110: * Sets the password of the AlienBrain user account used to connect.
111: *
112: *@param password The password of the AlienBrin user account.
113: */
114: public void setPassword(String password) {
115: this .password = password;
116: }
117:
118: public String getPassword() {
119: return password;
120: }
121:
122: /**
123: * Sets the path to the project within the AlienBrain repository.
124: *
125: * @param path The path within the project database to check for
126: * modifications. Typically something like alienbrain://path/to/project
127: */
128: public void setPath(String path) {
129: this .path = path;
130: }
131:
132: public String getPath() {
133: return path;
134: }
135:
136: /**
137: * Sets the path to the project within the AlienBrain repository.
138: *
139: *@param branch The branch within the AlienBrain project.
140: */
141: public void setBranch(String branch) {
142: this .branch = branch;
143: }
144:
145: public String getBranch() {
146: return branch;
147: }
148:
149: /**
150: * Try to add a flag to a Commandline
151: *
152: *@param cmdLine The Commandline object to possibly add arguments
153: *@param flagValue Whether or not to add the flag.
154: *@param flagName The flag to use if the argument is added.
155: */
156: protected void addFlagIfSet(Commandline cmdLine, boolean flagValue,
157: String flagName) {
158: if (flagValue) {
159: cmdLine.createArgument(flagName);
160: }
161: }
162:
163: /**
164: * Try to add flagged argument to a Commandline
165: *
166: *@param cmdLine The Commandline object to possibly add arguments
167: *@param argument The argument to possibly add.
168: *@param flag The flag to use if the argument is added.
169: */
170: protected void addArgumentIfSet(Commandline cmdLine,
171: String argument, String flag) {
172: if (argument != null) {
173: cmdLine.createArguments(flag, argument);
174: }
175: }
176:
177: /**
178: * Construct a ManagedCommandline preset with arguments applicable to
179: * any AlienBrain command that we wish to run.
180: */
181: protected ManagedCommandline buildCommonCommand() {
182: ManagedCommandline cmdLine = new ManagedCommandline();
183: cmdLine.setExecutable("ab");
184: addArgumentIfSet(cmdLine, user, "-u");
185: addArgumentIfSet(cmdLine, password, "-p");
186: addArgumentIfSet(cmdLine, server, "-s");
187: addArgumentIfSet(cmdLine, database, "-d");
188:
189: return cmdLine;
190: }
191:
192: /**
193: * Sets the active branch to the provided branch name.
194: *
195: *@param branch The branch name.
196: * @throws CruiseControlException
197: */
198: protected void setActiveBranch(String branch) throws IOException,
199: CruiseControlException {
200: ManagedCommandline cmdLine = buildCommonCommand();
201: cmdLine.createArguments("setactivebranch", branch);
202: LOG.debug("Executing: " + cmdLine.toString());
203: cmdLine.execute();
204: cmdLine.assertExitCode(0);
205: }
206: }
|