3 | When the check box is on, AccuRev POP Command is not Populating the elements. If check box is
4 | off then AccuRev
5 | POP Command is Populating the elements.
6 |
3 | When this check box is marked, AccuRev Plug-In for Jenkins deletes any external files (that is,
4 | files that are
5 | not under source control) in the reference tree.
6 |
3 | AccuRev SCM provider. This plugin allows Jenkins jobs to pull data from AccuRev streams and enables build automation with the AccuRev SCM server.
4 |
3 | The relative directory path from the default Jenkins workspace location where the files from the
4 | stream,
5 | workspace, or reftree should be retrieved from. Leave this field
6 | blank if you want to continue using the Jenkins default workspace location.
7 |
3 | When this check box is marked, AccuRev Plug-In for Jenkins creates a snapshot of the target
4 | stream, then
5 | populates and builds from that snapshot.
6 |
7 |
8 | NOTE: If the snapshot name already exists, the process fails and the build stops.
9 |
3 | Select the Server field and choose the AccuRev server whose depots and streams you are
4 | using for your
5 | builds. The available AccuRev servers are those that have been
6 | configured in the Jenkins (Manage Jenkins > Configure Systems > AccuRev > Servers)
7 | settings.
8 |
3 | option allows you to specify whether or not a failed build will result in the next subsequent
4 | build purging and
5 | re-populating
6 | the workspace. this used to be the default behavior however in some instances it is not wanted.
7 |
8 |
9 | Disabling this option may result in subsequent builds continuing to fail where they would
10 | normally have
11 | succeeded after a purge/populate.
12 |
3 | If checked, the plugin will add the '-n' flag to the 'accurev login'
4 | command when logging in.
5 |
6 | This flag requests a login session that will not expire after
7 | an arbitrary time period has elapsed.
8 | This is rarely an issue when using "traditional" authentication, but
9 | can be useful when using "accurev_login" or "custom" authentication
10 | on the server as these default to making login sessions time out and
11 | expire after 240 minutes.
12 |
21 |
22 |
23 |
24 |
25 |
26 |
--------------------------------------------------------------------------------
/.github/workflows/jenkins-security-scan.yml:
--------------------------------------------------------------------------------
1 | name: Jenkins Security Scan
2 |
3 | on:
4 | push:
5 | branches:
6 | - master
7 | pull_request:
8 | types: [ opened, synchronize, reopened ]
9 | workflow_dispatch:
10 |
11 | permissions:
12 | security-events: write
13 | contents: read
14 | actions: read
15 |
16 | jobs:
17 | security-scan:
18 | uses: jenkins-infra/jenkins-security-scan/.github/workflows/jenkins-security-scan.yaml@v2
19 | with:
20 | java-cache: 'maven' # Optionally enable use of a build dependency cache. Specify 'maven' or 'gradle' as appropriate.
21 | # java-version: 21 # Optionally specify what version of Java to set up for the build, or remove to use a recent default.
22 |
--------------------------------------------------------------------------------
/src/main/webapp/help/project/ignore-stream-parent.html:
--------------------------------------------------------------------------------
1 |
2 |
3 | If checked then, when checking for changes etc, the plugin will ignore
4 | the possibility that there have been changes in the parent stream that
5 | affect the contents of the stream being polled.
6 |
7 |
8 | This is purely a runtime optimisation for when AccuRev is being used
9 | as a normal VCS and not taking advantage of its stream inheritance.
10 |
11 | When used with reftree or workspaces this will be used to limit
12 | the number of hist commands issued to calculate the changelog.
13 | Upstream changes would be considered since we use update to determine
14 | actual changes.
15 |
3 | By default, this plugin purges the workspace for every build. There are a number of operations
4 | which when performed in AccuRev, can make it impossible for a client to successfully complete
5 | an accurev update operation with the workspace populated. The sequence of purge,
6 | update, populate has not failed. The down side is that it is slower.
7 |
8 |
9 | Selecting this option will enable the plugin to skip the purge step and just use update
10 | (followed by a populate just in case any files went missing). NOTE: however, in order to
11 | allow Jenkins to recover from the "cannot complete update" situation a purge will always
12 | be performed if the last build failed.
13 |
14 |
15 |
--------------------------------------------------------------------------------
/src/main/java/hudson/plugins/accurev/RefTreeExternalFile.java:
--------------------------------------------------------------------------------
1 | package hudson.plugins.accurev;
2 |
3 | import java.io.Serializable;
4 |
5 | public class RefTreeExternalFile implements Serializable {
6 |
7 | private final String location;
8 | private final String status;
9 | private static final long serialVersionUID = 1L;
10 |
11 | public RefTreeExternalFile(String location, String status) {
12 | this.location = location;
13 | this.status = status;
14 | }
15 |
16 | /**
17 | * Getter for property 'location'.
18 | *
19 | * @return Value for property 'location'.
20 | */
21 | public String getLocation() {
22 | return location;
23 | }
24 |
25 | /**
26 | * Getter for property 'status'.
27 | *
28 | * @return Value for property 'status'.
29 | */
30 | public String getStatus() {
31 | return status;
32 | }
33 | }
34 |
--------------------------------------------------------------------------------
/src/main/java/hudson/plugins/accurev/cmd/Command.java:
--------------------------------------------------------------------------------
1 | package hudson.plugins.accurev.cmd;
2 |
3 | import hudson.plugins.accurev.AccurevSCM.AccurevServer;
4 | import hudson.util.ArgumentListBuilder;
5 | import org.apache.commons.lang.StringUtils;
6 |
7 | public class Command {
8 |
9 | /**
10 | * Adds the server reference to the Arguments list.
11 | *
12 | * @param cmd The accurev command line.
13 | * @param server The Accurev server details.
14 | */
15 | public static void addServer(ArgumentListBuilder cmd, AccurevServer server) {
16 | if (null != server && null != server.getHost() && StringUtils.isNotBlank(server.getHost())) {
17 | cmd.add("-H");
18 | if (server.getPort() != 0) {
19 | cmd.add(server.getHost() + ":" + server.getPort());
20 | } else {
21 | cmd.add(server.getHost());
22 | }
23 | }
24 | }
25 | }
26 |
--------------------------------------------------------------------------------
/src/main/webapp/help/project/revert.html:
--------------------------------------------------------------------------------
1 |
2 |
3 | This option causes the AccuRev plugin to revert any overlapped entries in the workspace prior to
4 | performing an
5 | update of the workspace. Overlapped entries cause the update step to fail, which in turn causes
6 | the build to be
7 | marked
8 | as failed. (which in turn causes the next build to purge the workspace and therefore negate any
9 | purpose in using
10 | workspaces)
11 |
12 |
13 | this option is primarily useful in cases where you are using an AccuRev workspace and when
14 | performing a build on
15 | that workspace
16 | would cause artifacts to overlap in the parent stream. If you keep getting warnings and failed
17 | builds due to
18 | overlaps, and you don't
19 | want to purge the entire workspace on each build then you need this option.
20 |
3 | If checked then, before issuing an "accurev login" command, the plugin will
4 | first issue an "accurev info" command to see if it is already logged in
5 | and then only issue the "accurev login" command if it is not already logged
6 | in as the desired user.
7 | If not checked, an "accurev login" command will be issued before each attempt
8 | to poll for changes and at the start of each build.
9 |
10 | This was introduced to work around the AccuRev client bug whereby a
11 | login will first log out all active logins on that host before logging
12 | in again, causing any other AccuRev commands running in other processes
13 | to fail due to the client (temporarily) not being logged in.
14 | For best effect, combine with the "-n" flag to ensure that, once logged in,
15 | the client stays logged in permanently.
16 |
3 | Some projects only use a portion of the workspace and, in such cases, it is not necessary to
4 | check out the
5 | entire workspace. For example, when accessing a large remote
6 | repository to build a sub-module.
7 |
8 |
9 |
10 | If you specify a sub-path, the plugin makes a "best effort" to ensure that only the sub-path is
11 | populated. This
12 | means that the files within the sub-path will be fetched, at
13 | least, but side-effects may result in files from other paths being fetched as well.
14 |
15 |
16 |
17 | Note that the changelog does not filter by sub-path. Thus, any change in the repository will
18 | trigger a build.
19 |
20 |
21 |
22 | When using a workspace, you must update the workspace which populates any changed files and not
23 | just the files
24 | in the sub-path. The subsequent populate ensures that all the
25 | files in the sub-path are fetched, at least.
26 |
3 | If checked then, when issuing an "accurev show ... streams"
4 | command, the plugin will use the "-s streamname" option to
5 | restrict the output to just the stream in question, look at the result
6 | to determine the basis stream and then repeat for that
7 | stream's parent etc until the full ancestry is obtained. If not checked,
8 | when the plugin needs to know about the stream it is using, it'll simply
9 | get all of the streams from the server (which can involve a lot of
10 | data).
11 |
12 | This is best enabled on AccuRev servers with a lot of streams,
13 | snapshots, workspaces etc.
14 | When there are relatively few streams and snapshots aren't used, it is
15 | typically quicker to get all the streams that the server knows about in
16 | one single command. When there are a lot of them, it's often faster to
17 | send multiple commands that get the stream you want, and then its parent,
18 | and its parent etc until you reach the top of the chain.
19 |
20 |
21 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2017 Jenkins
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
--------------------------------------------------------------------------------
/src/main/java/hudson/plugins/accurev/parsers/xml/ParseShowDepots.java:
--------------------------------------------------------------------------------
1 | package hudson.plugins.accurev.parsers.xml;
2 |
3 | import hudson.plugins.accurev.AccurevLauncher.ICmdOutputXmlParser;
4 | import hudson.plugins.accurev.AccurevLauncher.UnhandledAccurevCommandOutput;
5 | import java.io.IOException;
6 | import java.util.ArrayList;
7 | import java.util.List;
8 | import org.xmlpull.v1.XmlPullParser;
9 | import org.xmlpull.v1.XmlPullParserException;
10 |
11 | public final class ParseShowDepots implements ICmdOutputXmlParser, Void> {
12 |
13 | public List parse(XmlPullParser parser, Void context)
14 | throws UnhandledAccurevCommandOutput, IOException, XmlPullParserException {
15 | final List depots = new ArrayList<>();
16 | while (parser.next() != XmlPullParser.END_DOCUMENT) {
17 | if (parser.getEventType() == XmlPullParser.START_TAG
18 | && "element".equalsIgnoreCase(parser.getName())) {
19 | final String name = parser.getAttributeValue("", "Name");
20 | if (name != null) {
21 | depots.add(name);
22 | }
23 | }
24 | }
25 | return depots;
26 | }
27 | }
28 |
--------------------------------------------------------------------------------
/src/main/java/hudson/plugins/accurev/parsers/output/ParseAccuRevVersion.java:
--------------------------------------------------------------------------------
1 | package hudson.plugins.accurev.parsers.output;
2 |
3 | import hudson.plugins.accurev.AccurevLauncher.ICmdOutputParser;
4 | import hudson.plugins.accurev.AccurevLauncher.UnhandledAccurevCommandOutput;
5 | import java.io.BufferedReader;
6 | import java.io.IOException;
7 | import java.io.InputStream;
8 | import java.io.InputStreamReader;
9 | import java.io.Reader;
10 | import java.nio.charset.Charset;
11 |
12 | public final class ParseAccuRevVersion implements ICmdOutputParser {
13 |
14 | @Override
15 | public String parse(InputStream cmdOutput, Void context)
16 | throws UnhandledAccurevCommandOutput, IOException {
17 | final Reader stringReader = new InputStreamReader(cmdOutput, Charset.defaultCharset());
18 | try (BufferedReader reader = new BufferedReader(stringReader)) {
19 | String line;
20 | while ((line = reader.readLine()) != null) {
21 | if (line.contains("AccuRev")) {
22 | return line.split("\\s+")[1];
23 | }
24 | }
25 | }
26 | // TODO Auto-generated method stub
27 | return null;
28 | }
29 | }
30 |
--------------------------------------------------------------------------------
/src/main/webapp/help/sync-operations.html:
--------------------------------------------------------------------------------
1 |
2 |
3 | If checked, all calls to the AccuRev CLI on a particular node will be
4 | synchronized. That is to say, only one CLI operation can be going on at
5 | any time, across all jobs on a given node. The default is synchronized,
6 | which is the plugin's original behavior.
7 |
8 | Note that login operations are always synchronized.
9 |
10 | This sync was supposedly for problems with older versions of the AccuRev
11 | CLI. If you have a recent version of AccuRev (4.7+, possibly earlier),
12 | but are using "traditional" authentication,
13 | it should be ok to turn off synchronization. This can speed up operations
14 | significantly in some scenarios, such as with multiple jobs with large
15 | checkouts.
16 | If you are using "accurev_login" or "custom" authentication, even on recent
17 | versions of AccuRev (e.g. 4.7.4 suffers from this), you need to ensure
18 | that you never run a "login" unless no other AccuRev operations are ongoing,
19 | otherwise those other AccuRev operations are likely to fail.
20 |
WARNING: By changing the valid types of transactions you can miss
3 | vital changes made to your source code.
4 |
5 | By default, the AccuRev plugin will allow any type of transaction to trigger a build.
6 | This behavior is not always wanted, resulting in issue-triggered builds.
7 |
8 |
9 | To solve this you specify the types of transactions that you want to use.
10 | You enter the transaction types separated by commas like this:
29 | Note that if you are only ever building the contents of streams, then
30 | polling for "promote" transactions is likely to suffice on its own.
31 |
32 |
33 |
--------------------------------------------------------------------------------
/src/main/java/hudson/plugins/accurev/parsers/output/ParseLastFewLines.java:
--------------------------------------------------------------------------------
1 | package hudson.plugins.accurev.parsers.output;
2 |
3 | import hudson.plugins.accurev.AccurevLauncher.ICmdOutputParser;
4 | import java.io.BufferedReader;
5 | import java.io.IOException;
6 | import java.io.InputStream;
7 | import java.io.InputStreamReader;
8 | import java.io.Reader;
9 | import java.nio.charset.Charset;
10 | import java.util.LinkedList;
11 | import java.util.List;
12 |
13 | /** Filters the output of any command and just returns the last few lines. */
14 | public final class ParseLastFewLines implements ICmdOutputParser, Integer> {
15 |
16 | public List parse(InputStream cmdOutput, Integer numberOfLines) throws IOException {
17 | final LinkedList result = new LinkedList<>();
18 | final Reader stringReader = new InputStreamReader(cmdOutput, Charset.defaultCharset());
19 | int linesRemainingBeforeWeAreFull = numberOfLines;
20 |
21 | try (BufferedReader reader = new BufferedReader(stringReader)) {
22 | String line;
23 | while ((line = reader.readLine()) != null) {
24 | result.add(line);
25 | if (linesRemainingBeforeWeAreFull > 0) {
26 | linesRemainingBeforeWeAreFull--;
27 | } else {
28 | result.removeFirst();
29 | }
30 | }
31 | }
32 | return result;
33 | }
34 | }
35 |
--------------------------------------------------------------------------------
/src/main/webapp/help/project/filterforpollscm.html:
--------------------------------------------------------------------------------
1 |
2 |
3 | If the Poll SCM check box under the Build Triggers section is selected, you can
4 | use the Filter
5 | for Poll SCM field to specify the directories or files
6 | you want Jenkins to check before starting a build. Any changes made to the files or directories
7 | that you specify
8 | in the Filter for Poll SCM field will trigger a
9 | build in Jenkins.
10 |
11 |
12 |
13 | Directories and files must be specified in a comma-separated list and can use relative
14 | pathnames. For example,
15 | you could use:
16 |
23 | where "src" is the immediate sub-folder under your stream or reference tree.
24 |
25 |
26 |
27 |
NOTE: If you select Poll SCM in the Build Triggers section of the Jenkins
28 | configuration page, but
29 | you do not specify any Filter for Poll SCM files or
30 | directories, then any files or directories you have specified in the Sub-path field are
31 | used as the
32 | filter for polling. In this case, changes made to elements in the
33 | sub-path will trigger a build in Jenkins.
34 |
3 | If the Create and build from snapshot check box is marked, you can specify the naming
4 | conventions for the
5 | snapshot in this field. The format you specify configures
6 | the manner in which the snapshot is named and it allows the use of environment variables using
7 | the same syntax
8 | as Apache Ant uses for property expansion. For example, a
9 | literal $ must be escaped by using $$, and
10 | ${name}
11 | resolves to the value of environment variable "name".
12 |
13 |
14 |
15 | The Snapshot Name Format can be set to any combination of literal text and environment
16 | variables, subject
17 | to naming restrictions for AccuRev snapshots. Specifically,
18 | the snapshot name must begin with a non-digit other than dot (.), and must not include either a
19 | slash (/) or a
20 | backslash (\). For example, "${ACCUREV_STREAM}_${BUILD_NUMBER}_Snapshot"
21 | would take the name of the stream being built, append an underscore, append the build number
22 | and, finally,
23 | append "_Snapshot", which would result in a snapshot name of the
24 | form "MyStreamName_1234_Snapshot".
25 |
26 |
27 |
28 | If this option is not set, the snapshot name defaults to
29 | "${JOB_NAME}_${BUILD_NUMBER}".
30 |
31 |
32 |
--------------------------------------------------------------------------------
/src/main/java/hudson/plugins/accurev/parsers/xml/ParseGetConfig.java:
--------------------------------------------------------------------------------
1 | package hudson.plugins.accurev.parsers.xml;
2 |
3 | import hudson.plugins.accurev.AccurevLauncher.ICmdOutputXmlParser;
4 | import hudson.plugins.accurev.AccurevLauncher.UnhandledAccurevCommandOutput;
5 | import hudson.plugins.accurev.GetConfigWebURL;
6 | import java.io.EOFException;
7 | import java.io.IOException;
8 | import java.util.HashMap;
9 | import java.util.Map;
10 | import org.xmlpull.v1.XmlPullParser;
11 | import org.xmlpull.v1.XmlPullParserException;
12 |
13 | public class ParseGetConfig implements ICmdOutputXmlParser, Void> {
14 |
15 | public Map parse(XmlPullParser parser, Void context)
16 | throws UnhandledAccurevCommandOutput, IOException, XmlPullParserException {
17 | final Map getConfig = new HashMap<>();
18 | getConfig.put("webuiURL", new GetConfigWebURL(""));
19 | try {
20 | while (parser.next() != XmlPullParser.END_DOCUMENT) {
21 | if (parser.getEventType() == XmlPullParser.START_TAG
22 | && "webui".equalsIgnoreCase(parser.getName())) {
23 | final String webURL = parser.getAttributeValue("", "url");
24 | if (webURL != null) {
25 | getConfig.put("webuiURL", new GetConfigWebURL(webURL));
26 | }
27 | }
28 | }
29 | } catch (EOFException ignored) {
30 | // file not found
31 | }
32 | return getConfig;
33 | }
34 | }
35 |
--------------------------------------------------------------------------------
/src/main/java/hudson/plugins/accurev/parsers/xml/ParseRefTreeExternalFile.java:
--------------------------------------------------------------------------------
1 | package hudson.plugins.accurev.parsers.xml;
2 |
3 | import hudson.plugins.accurev.AccurevLauncher.ICmdOutputXmlParser;
4 | import hudson.plugins.accurev.AccurevLauncher.UnhandledAccurevCommandOutput;
5 | import hudson.plugins.accurev.RefTreeExternalFile;
6 | import java.io.IOException;
7 | import java.util.HashMap;
8 | import java.util.Map;
9 | import org.xmlpull.v1.XmlPullParser;
10 | import org.xmlpull.v1.XmlPullParserException;
11 |
12 | public class ParseRefTreeExternalFile
13 | implements ICmdOutputXmlParser, Void> {
14 |
15 | public Map parse(XmlPullParser parser, Void context)
16 | throws UnhandledAccurevCommandOutput, IOException, XmlPullParserException {
17 | final Map externalFiles = new HashMap<>();
18 | while (parser.next() != XmlPullParser.END_DOCUMENT) {
19 | if (parser.getEventType() == XmlPullParser.START_TAG
20 | && "Element".equalsIgnoreCase(parser.getName())) {
21 | final String location = parser.getAttributeValue("", "location");
22 | final String status = parser.getAttributeValue("", "status");
23 | try {
24 | externalFiles.put(location, new RefTreeExternalFile(location, status));
25 | } catch (NumberFormatException e) {
26 | throw new UnhandledAccurevCommandOutput(e);
27 | }
28 | }
29 | }
30 | return externalFiles;
31 | }
32 | }
33 |
--------------------------------------------------------------------------------
/src/main/java/hudson/plugins/accurev/ByteArrayStream.java:
--------------------------------------------------------------------------------
1 | package hudson.plugins.accurev;
2 |
3 | import java.io.ByteArrayInputStream;
4 | import java.io.ByteArrayOutputStream;
5 | import java.io.Closeable;
6 | import java.io.IOException;
7 | import java.io.InputStream;
8 |
9 | /** Simple class to capture the output of something, and then allow that output to be read. */
10 | public class ByteArrayStream implements Closeable {
11 |
12 | private final Output mOutputStream = new Output();
13 |
14 | /**
15 | * Gets the {@link ByteArrayOutputStream} to which data can be written.
16 | *
17 | * @return See above.
18 | */
19 | public ByteArrayOutputStream getOutput() {
20 | return mOutputStream;
21 | }
22 |
23 | /**
24 | * Gets an {@link InputStream} that'll contain all the data that was written to {@link
25 | * #getOutput()} thus far.
26 | *
27 | *
3 | Some projects only use a portion of the stream or reference tree and, in these instances, it is
4 | not necessary to
5 | check out the entire contents of the repository, such as
6 | when you are accessing, for example, a large remote repository to build a sub-module. In such
7 | cases, it may be
8 | useful to set up a sub-path. If you specify a sub-path, the
9 | plugin makes a "best effort" to ensure that only the sub-path is populated. This means that the
10 | files within the
11 | sub-path will be fetched, at least, although side-effects
12 | may result in files from other locations being fetched as well.
13 |
14 |
15 |
16 | Directories and files must be specified in a comma-separated list and can use relative
17 | pathnames. For example,
18 | you could use:
19 |
25 | where "src" is the immediate sub-folder under your stream or reference tree.
26 |
27 |
28 | NOTES:
29 |
30 |
31 |
The Sub-path option only works if you configure it before the first build is
32 | triggered.
33 |
34 |
If you specify a sub-path and you also select Poll SCM in the Build Triggers
35 | section of the
36 | Jenkins configuration page, but you do not specify any Filter
37 | for Poll SCM files or directories, then the sub-path files and directories are used as
38 | the filter
39 | for polling. In this case, changes made to elements in the
40 | sub-path will trigger a build in Jenkins.
41 |
3 | By default, AccuRev Plug-in for Jenkins checks out the latest changes without using a reference
4 | tree. When not
5 | using a reference tree, AccuRev Plug-in for Jenkins uses the
6 | accurev pop -R command to extract all the files. However, there may be situations
7 | when the use of a
8 | reference tree is preferred, such as when you want to use
9 | the latest versions of files that you do not intend to modify. You can think of a reference tree
10 | as a read-only
11 | portal to the AccuRev data repository.
12 |
13 |
14 |
If the Use Reference Tree check box is marked, AccuRev Plug-in for Jenkins attempts to
15 | use the reference
16 | tree specified in the Reference Tree text box. (You
17 | must create a reference tree in AccuRev before you can specify it here.) AccuRev Plug-in for
18 | Jenkins manages the
19 | process of migrating the reference tree to the appropriate
20 | build machine and relocating the reference tree to use the correct location. Note that these
21 | changes are
22 | recorded in the AccuRev repository.
23 |
24 | When using a reference tree, the following AccuRev commands are used:
25 |
26 |
27 |
28 |
accurev show refs confirms that the reference tree is valid and has the correct
29 | parent stream.
30 |
31 |
accurev chref is run if the reference tree is in the wrong directory or on the
32 | wrong machine.
33 | (Optional)
34 |
35 |
accurev update refreshes the reference tree. If the update fails, AccuRev
36 | Plug-in for Jenkins
37 | uses the accurev update -9 command to update the
38 | reference tree.
39 |
40 |
accurev pop -O -R ensures that all files are populated and that the reference
41 | tree always
42 | contains the fresh update.
43 |
44 |
45 |
46 |
--------------------------------------------------------------------------------
/src/main/java/hudson/plugins/accurev/AccurevReferenceTree.java:
--------------------------------------------------------------------------------
1 | package hudson.plugins.accurev;
2 |
3 | import java.io.Serializable;
4 |
5 | public class AccurevReferenceTree implements Serializable {
6 |
7 | private final String depot;
8 | private final Long streamNumber;
9 | private final String name;
10 | private final String host;
11 | private final String storage;
12 | private AccurevStream stream = null;
13 | private static final long serialVersionUID = 1L;
14 |
15 | public AccurevReferenceTree(
16 | String depot, Long streamNumber, String name, String host, String storage) {
17 | this.depot = depot;
18 | this.streamNumber = streamNumber;
19 | this.name = name;
20 | this.host = host;
21 | this.storage = storage;
22 | }
23 |
24 | /**
25 | * Getter for property 'depot'.
26 | *
27 | * @return Value for property 'depot'.
28 | */
29 | public String getDepot() {
30 | return depot;
31 | }
32 |
33 | /**
34 | * Getter for property 'streamNumber'.
35 | *
36 | * @return Value for property 'streamNumber'.
37 | */
38 | public Long getStreamNumber() {
39 | return streamNumber;
40 | }
41 |
42 | /**
43 | * Getter for property 'name'.
44 | *
45 | * @return Value for property 'name'.
46 | */
47 | public String getName() {
48 | return name;
49 | }
50 |
51 | /**
52 | * Getter for property 'host'.
53 | *
54 | * @return Value for property 'host'.
55 | */
56 | public String getHost() {
57 | return host;
58 | }
59 |
60 | /**
61 | * Getter for property 'storage'.
62 | *
63 | * @return Value for property 'storage'.
64 | */
65 | public String getStorage() {
66 | return storage;
67 | }
68 |
69 | /**
70 | * Getter for property 'stream'.
71 | *
72 | * @return Value for property 'stream'.
73 | */
74 | public AccurevStream getStream() {
75 | return stream;
76 | }
77 |
78 | /**
79 | * Setter for property 'stream'.
80 | *
81 | * @param stream Value to set for property 'stream'.
82 | */
83 | public void setStream(AccurevStream stream) {
84 | this.stream = stream;
85 | }
86 | }
87 |
--------------------------------------------------------------------------------
/src/main/java/hudson/plugins/accurev/AccurevWorkspace.java:
--------------------------------------------------------------------------------
1 | package hudson.plugins.accurev;
2 |
3 | import java.io.Serializable;
4 |
5 | /**
6 | * Created by IntelliJ IDEA.
7 | *
8 | * @author connollys
9 | * @since 03-Dec-2007 13:17:39
10 | */
11 | public class AccurevWorkspace implements Serializable {
12 |
13 | private final String depot;
14 | private final Long streamNumber;
15 | private final String name;
16 | private final String host;
17 | private final String storage;
18 | private AccurevStream stream = null;
19 | private static final long serialVersionUID = 1L;
20 |
21 | public AccurevWorkspace(
22 | String depot, Long streamNumber, String name, String host, String storage) {
23 | this.depot = depot;
24 | this.streamNumber = streamNumber;
25 | this.name = name;
26 | this.host = host;
27 | this.storage = storage;
28 | }
29 |
30 | /**
31 | * Getter for property 'depot'.
32 | *
33 | * @return Value for property 'depot'.
34 | */
35 | public String getDepot() {
36 | return depot;
37 | }
38 |
39 | /**
40 | * Getter for property 'streamNumber'.
41 | *
42 | * @return Value for property 'streamNumber'.
43 | */
44 | public Long getStreamNumber() {
45 | return streamNumber;
46 | }
47 |
48 | /**
49 | * Getter for property 'name'.
50 | *
51 | * @return Value for property 'name'.
52 | */
53 | public String getName() {
54 | return name;
55 | }
56 |
57 | /**
58 | * Getter for property 'host'.
59 | *
60 | * @return Value for property 'host'.
61 | */
62 | public String getHost() {
63 | return host;
64 | }
65 |
66 | /**
67 | * Getter for property 'storage'.
68 | *
69 | * @return Value for property 'storage'.
70 | */
71 | public String getStorage() {
72 | return storage;
73 | }
74 |
75 | /**
76 | * Getter for property 'stream'.
77 | *
78 | * @return Value for property 'stream'.
79 | */
80 | public AccurevStream getStream() {
81 | return stream;
82 | }
83 |
84 | /**
85 | * Setter for property 'stream'.
86 | *
87 | * @param stream Value to set for property 'stream'.
88 | */
89 | public void setStream(AccurevStream stream) {
90 | this.stream = stream;
91 | }
92 | }
93 |
--------------------------------------------------------------------------------
/src/main/java/hudson/plugins/accurev/parsers/output/ParsePopulate.java:
--------------------------------------------------------------------------------
1 | package hudson.plugins.accurev.parsers.output;
2 |
3 | import hudson.plugins.accurev.AccurevLauncher.ICmdOutputParser;
4 | import hudson.plugins.accurev.AccurevLauncher.UnhandledAccurevCommandOutput;
5 | import java.io.BufferedReader;
6 | import java.io.BufferedWriter;
7 | import java.io.IOException;
8 | import java.io.InputStream;
9 | import java.io.InputStreamReader;
10 | import java.io.OutputStream;
11 | import java.io.OutputStreamWriter;
12 | import java.io.Reader;
13 | import java.io.Writer;
14 | import java.nio.charset.Charset;
15 |
16 | /**
17 | * Filters the output of the populate command and just shows a summary of the output. Helps prevent
18 | * build logs being clogged up with the checkout.
19 | */
20 | public final class ParsePopulate implements ICmdOutputParser {
21 |
22 | public Boolean parse(InputStream cmdOutput, OutputStream streamToCopyOutputTo)
23 | throws UnhandledAccurevCommandOutput, IOException {
24 | final String lineStartDirectory = "Creating dir:";
25 | final String lineStartElement = "Populating element";
26 | int countOfDirectories = 0;
27 | int countOfElements = 0;
28 | final Reader stringReader = new InputStreamReader(cmdOutput, Charset.defaultCharset());
29 | final Writer stringWriter =
30 | new OutputStreamWriter(streamToCopyOutputTo, Charset.defaultCharset());
31 | final BufferedWriter lineWriter = new BufferedWriter(stringWriter);
32 | try (BufferedReader reader = new BufferedReader(stringReader)) {
33 | String line;
34 | while ((line = reader.readLine()) != null) {
35 | if (line.startsWith(lineStartElement)) {
36 | countOfElements++;
37 | } else if (line.startsWith(lineStartDirectory)) {
38 | countOfDirectories++;
39 | } else {
40 | lineWriter.write(line);
41 | lineWriter.newLine();
42 | }
43 | }
44 | final String msg =
45 | "Populated " + countOfElements + " elements and " + countOfDirectories + " directories.";
46 | streamToCopyOutputTo.write(msg.getBytes(Charset.defaultCharset()));
47 | } finally {
48 | lineWriter.flush();
49 | }
50 | return Boolean.TRUE;
51 | }
52 | }
53 |
--------------------------------------------------------------------------------
/src/main/java/hudson/plugins/accurev/cmd/FilesCmd.java:
--------------------------------------------------------------------------------
1 | package hudson.plugins.accurev.cmd;
2 |
3 | import hudson.EnvVars;
4 | import hudson.FilePath;
5 | import hudson.Launcher;
6 | import hudson.model.TaskListener;
7 | import hudson.plugins.accurev.AccurevElement;
8 | import hudson.plugins.accurev.AccurevLauncher;
9 | import hudson.plugins.accurev.AccurevSCM;
10 | import hudson.plugins.accurev.XmlParserFactory;
11 | import hudson.plugins.accurev.parsers.xml.ParseFiles;
12 | import hudson.util.ArgumentListBuilder;
13 | import java.io.IOException;
14 | import java.util.ArrayList;
15 | import java.util.List;
16 | import java.util.logging.Logger;
17 | import org.xmlpull.v1.XmlPullParserFactory;
18 |
19 | public class FilesCmd extends Command {
20 |
21 | private static final Logger logger = Logger.getLogger(Login.class.getName());
22 |
23 | public static List checkFiles(
24 | final AccurevSCM scm,
25 | final AccurevSCM.AccurevServer server,
26 | final EnvVars accurevEnv,
27 | final FilePath workspace,
28 | final TaskListener listener,
29 | final Launcher launcher,
30 | FilePath file)
31 | throws IOException {
32 | final String commandDescription = "files command";
33 | final ArgumentListBuilder cmd = new ArgumentListBuilder();
34 | cmd.add("files");
35 | addServer(cmd, server);
36 | cmd.add("-fx");
37 | cmd.add("-s", scm.getStream());
38 | cmd.add("-l", file.getRemote());
39 |
40 | // returns username
41 | final ArrayList list = new ArrayList<>(1);
42 | XmlPullParserFactory parser = XmlParserFactory.getFactory();
43 | if (parser == null) {
44 | throw new IOException("No XML Parser");
45 | }
46 | final Boolean filesFound =
47 | AccurevLauncher.runCommand(
48 | commandDescription,
49 | scm.getAccurevTool(),
50 | launcher,
51 | cmd,
52 | scm.getOptionalLock(workspace),
53 | accurevEnv,
54 | workspace,
55 | listener,
56 | logger,
57 | parser,
58 | new ParseFiles(),
59 | list);
60 | if (filesFound == null) {
61 | throw new IOException("FilesCmd command failed.");
62 | }
63 | return list;
64 | }
65 | }
66 |
--------------------------------------------------------------------------------
/src/main/webapp/help/project/workspace.html:
--------------------------------------------------------------------------------
1 |
2 |
3 | By default, this plugin checks out the latest changes without using a workspace. This removes
4 | the need to
5 | manually create a workspace for each project, and removes the need for the plugin to make
6 | transactions
7 | while moving the workspace from slave to slave as the build migrates from slave to slave.
8 |
9 |
10 |
11 | However, there may be situations when the use of a workspace is preferred. If you want to use a
12 | workspace,
13 | select this option and enter the name of an existing workspace in the Workspace field.
14 | The plugin can
15 | manage
16 | migrating the workspace to the appropriate build machine and re-parenting the workspace to use
17 | the correct
18 | parent
19 | stream (Jenkins considers the Stream field value as the parent stream). Note that
20 | workspace changes
21 | (accurev chws) are logged as AccuRev transactions.
22 |
23 |
24 |
When not using a workspace, the following AccuRev commands will be used:
25 |
26 |
accurev pop -O -R . to extract all the files. Note: this command will not work
27 | if the
28 | directory that the files are being extracted to is the child of an active AccuRev workspace.
29 |
30 |
31 |
When using a workspace, the following AccuRev commands are used:
32 |
33 |
accurev show wspaces to validate that the workspace is valid and has the
34 | correct parent stream
35 |
36 |
37 |
If the workspace needs to be relocated or if the host machine needs to be updated, the
38 | following AccuRev commands
39 | are also used:
40 |
41 |
accurev chws
42 |
accurev update -9
43 |
accurev pop -O -R .
44 |
45 |
Otherwise, the following commands are run:
46 |
47 |
accurev chws (if re-parenting is required)
48 |
accurev update
49 |
50 |
Note: If you decide to stop using an AccuRev workspace after having run a build, you
51 | must manually move
52 | the AccuRev workspace directory.
53 |
54 |
--------------------------------------------------------------------------------
/src/main/java/hudson/plugins/accurev/XmlParserFactory.java:
--------------------------------------------------------------------------------
1 | package hudson.plugins.accurev;
2 |
3 | import java.io.IOException;
4 | import java.util.Map;
5 | import java.util.WeakHashMap;
6 | import java.util.logging.Logger;
7 | import org.xmlpull.v1.XmlPullParser;
8 | import org.xmlpull.v1.XmlPullParserException;
9 | import org.xmlpull.v1.XmlPullParserFactory;
10 |
11 | /** Utility class that provides {@link XmlPullParserFactory}s. */
12 | public class XmlParserFactory {
13 |
14 | private static final Logger logger = Logger.getLogger(AccurevSCM.class.getName());
15 | private static final Map PARSER_FACTORY_CACHE =
16 | new WeakHashMap<>(1);
17 |
18 | /**
19 | * Gets a new {@link XmlPullParser} configured for parsing Accurev XML files.
20 | *
21 | * @return a new {@link XmlPullParser} configured for parsing Accurev XML files.
22 | * @throws XmlPullParserException when things go wrong/
23 | * @throws IOException Handle it above
24 | */
25 | static XmlPullParser newParser() throws XmlPullParserException, IOException {
26 | XmlPullParserFactory factory = null;
27 | XmlPullParser parser = null;
28 | if (null != getFactory()) {
29 | factory = getFactory();
30 | }
31 | if (null != factory) {
32 | parser = factory.newPullParser();
33 | }
34 | return parser;
35 | }
36 |
37 | /**
38 | * Gets a new {@link XmlPullParserFactory} configured for parsing Accurev XML files.
39 | *
40 | * @return a new {@link XmlPullParserFactory} configured for parsing Accurev XML files, or
41 | * null if things go wrong.
42 | * @throws IOException Handle it above
43 | */
44 | public static XmlPullParserFactory getFactory() throws IOException {
45 | synchronized (PARSER_FACTORY_CACHE) {
46 | final XmlPullParserFactory existingFactory =
47 | PARSER_FACTORY_CACHE.get(XmlPullParserFactory.class);
48 | if (existingFactory != null) {
49 | return existingFactory;
50 | }
51 | XmlPullParserFactory newFactory;
52 | try {
53 | newFactory = XmlPullParserFactory.newInstance();
54 | } catch (XmlPullParserException ex) {
55 | AccurevLauncher.logException(
56 | "Unable to create new " + XmlPullParserFactory.class.getSimpleName(), ex, logger, null);
57 | return null;
58 | }
59 | newFactory.setNamespaceAware(false);
60 | newFactory.setValidating(false);
61 | PARSER_FACTORY_CACHE.put(XmlPullParserFactory.class, newFactory);
62 | return newFactory;
63 | }
64 | }
65 | }
66 |
--------------------------------------------------------------------------------
/src/main/resources/hudson/plugins/accurev/AccurevChangeLogSet/index.jelly:
--------------------------------------------------------------------------------
1 |
4 |
5 |
7 |
8 |
9 |