/
GitSCMSourceDefaults.java
128 lines (116 loc) · 4.03 KB
/
GitSCMSourceDefaults.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
/*
* The MIT License
*
* Copyright (c) 2017 CloudBees, Inc.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*
*/
package jenkins.plugins.git;
import hudson.model.Run;
import hudson.model.TaskListener;
import hudson.plugins.git.GitException;
import hudson.plugins.git.GitSCM;
import hudson.plugins.git.extensions.GitSCMExtension;
import java.io.IOException;
import java.util.List;
import jenkins.scm.api.mixin.TagSCMHead;
import org.eclipse.jgit.transport.RefSpec;
import org.eclipse.jgit.transport.RemoteConfig;
import org.jenkinsci.plugins.gitclient.CloneCommand;
import org.jenkinsci.plugins.gitclient.FetchCommand;
import org.jenkinsci.plugins.gitclient.GitClient;
/**
* Used to reset the default clone behaviour for {@link GitSCM} instances created by {@link GitSCMBuilder}.
* Does not have a descriptor as we do not expect this extension to be user-visible.
* With this extension, we anticipate:
* <ul>
* <li>tags will not be cloned or fetched</li>
* <li>refspecs will be honoured on clone</li>
* </ul>
*
* @since 3.4.0
*/
public class GitSCMSourceDefaults extends GitSCMExtension {
/**
* Determines whether tags should be fetched... only relevant if we implement support for {@link TagSCMHead}.
*/
private final boolean includeTags;
/**
* Constructor.
*
* @param includeTags
*/
public GitSCMSourceDefaults(boolean includeTags) {
this.includeTags = includeTags;
}
/**
* {@inheritDoc}
*/
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
GitSCMSourceDefaults that = (GitSCMSourceDefaults) o;
return includeTags == that.includeTags;
}
/**
* {@inheritDoc}
*/
@Override
public int hashCode() {
return (includeTags ? 1 : 0);
}
/**
* {@inheritDoc}
*/
@Override
public String toString() {
return "GitSCMSourceDefaults{" +
"includeTags=" + includeTags +
'}';
}
/**
* {@inheritDoc}
*/
@Override
public void decorateCloneCommand(GitSCM scm, Run<?, ?> build, GitClient git, TaskListener listener,
CloneCommand cmd) throws IOException, InterruptedException, GitException {
listener.getLogger()
.printf("Cloning with configured refspecs honoured and %s tags%n", includeTags ? "with" : "without");
RemoteConfig rc = scm.getRepositories().get(0);
List<RefSpec> refspecs = rc.getFetchRefSpecs();
cmd.refspecs(refspecs);
cmd.tags(includeTags);
}
/**
* {@inheritDoc}
*/
@Override
public void decorateFetchCommand(GitSCM scm, GitClient git, TaskListener listener, FetchCommand cmd)
throws IOException, InterruptedException, GitException {
listener.getLogger()
.printf("Fetching %s tags%n", includeTags ? "with" : "without");
cmd.tags(includeTags);
}
}