/
AbstractGitSCMSource.java
1702 lines (1618 loc) · 78.1 KB
/
AbstractGitSCMSource.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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* The MIT License
*
* Copyright (c) 2013-2017, CloudBees, Inc., Stephen Connolly, Amadeus IT Group.
*
* 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 com.cloudbees.plugins.credentials.CredentialsMatchers;
import com.cloudbees.plugins.credentials.CredentialsNameProvider;
import com.cloudbees.plugins.credentials.CredentialsProvider;
import com.cloudbees.plugins.credentials.common.StandardCredentials;
import com.cloudbees.plugins.credentials.common.StandardUsernameCredentials;
import com.cloudbees.plugins.credentials.domains.URIRequirementBuilder;
import edu.umd.cs.findbugs.annotations.CheckForNull;
import edu.umd.cs.findbugs.annotations.NonNull;
import edu.umd.cs.findbugs.annotations.Nullable;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import hudson.EnvVars;
import hudson.RestrictedSince;
import hudson.Util;
import hudson.model.Action;
import hudson.model.Actionable;
import hudson.model.Item;
import hudson.model.TaskListener;
import hudson.plugins.git.Branch;
import hudson.plugins.git.GitException;
import hudson.plugins.git.GitSCM;
import hudson.plugins.git.GitTool;
import hudson.plugins.git.Revision;
import hudson.plugins.git.UserRemoteConfig;
import hudson.plugins.git.browser.GitRepositoryBrowser;
import hudson.plugins.git.extensions.GitSCMExtension;
import hudson.plugins.git.util.Build;
import hudson.plugins.git.util.BuildChooser;
import hudson.plugins.git.util.BuildChooserContext;
import hudson.plugins.git.util.BuildData;
import hudson.plugins.git.util.GitUtils;
import hudson.scm.SCM;
import hudson.security.ACL;
import java.io.File;
import java.io.IOException;
import java.net.URISyntaxException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
import java.util.TreeSet;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.locks.Lock;
import java.util.concurrent.locks.ReentrantLock;
import java.util.logging.Level;
import java.util.logging.Logger;
import java.util.regex.Pattern;
import jenkins.model.Jenkins;
import jenkins.plugins.git.traits.GitBrowserSCMSourceTrait;
import jenkins.plugins.git.traits.GitSCMExtensionTrait;
import jenkins.plugins.git.traits.GitToolSCMSourceTrait;
import jenkins.plugins.git.traits.RefSpecsSCMSourceTrait;
import jenkins.plugins.git.traits.RemoteNameSCMSourceTrait;
import jenkins.scm.api.SCMFile;
import jenkins.scm.api.SCMFileSystem;
import jenkins.scm.api.SCMHead;
import jenkins.scm.api.SCMHeadCategory;
import jenkins.scm.api.SCMHeadEvent;
import jenkins.scm.api.SCMHeadObserver;
import jenkins.scm.api.SCMProbe;
import jenkins.scm.api.SCMProbeStat;
import jenkins.scm.api.SCMRevision;
import jenkins.scm.api.SCMSource;
import jenkins.scm.api.SCMSourceCriteria;
import jenkins.scm.api.SCMSourceEvent;
import jenkins.scm.api.SCMSourceOwner;
import jenkins.scm.api.metadata.PrimaryInstanceMetadataAction;
import jenkins.scm.api.trait.SCMSourceRequest;
import jenkins.scm.api.trait.SCMSourceTrait;
import jenkins.scm.api.trait.SCMTrait;
import jenkins.scm.impl.trait.WildcardSCMHeadFilterTrait;
import jenkins.scm.impl.trait.WildcardSCMSourceFilterTrait;
import net.jcip.annotations.GuardedBy;
import org.apache.commons.lang.StringUtils;
import org.eclipse.jgit.lib.Constants;
import org.eclipse.jgit.lib.FileMode;
import org.eclipse.jgit.lib.ObjectId;
import org.eclipse.jgit.lib.Repository;
import org.eclipse.jgit.revwalk.RevCommit;
import org.eclipse.jgit.revwalk.RevTree;
import org.eclipse.jgit.revwalk.RevWalk;
import org.eclipse.jgit.transport.RefSpec;
import org.eclipse.jgit.transport.URIish;
import org.eclipse.jgit.treewalk.TreeWalk;
import org.jenkinsci.plugins.gitclient.FetchCommand;
import org.jenkinsci.plugins.gitclient.Git;
import org.jenkinsci.plugins.gitclient.GitClient;
import org.kohsuke.accmod.Restricted;
import org.kohsuke.accmod.restrictions.DoNotUse;
import org.kohsuke.accmod.restrictions.NoExternalUse;
import org.kohsuke.stapler.export.Exported;
/**
* Base class for {@link SCMSource} implementations that produce {@link GitSCM} implementations.
*
* @since 2.0
*/
public abstract class AbstractGitSCMSource extends SCMSource {
/**
* The default remote name to use when configuring the ref specs to use with fetch operations.
*
* @since 3.4.0
*/
public static final String DEFAULT_REMOTE_NAME = "origin";
/**
* The placeholder to use in ref spec templates in order to correctly ensure that the ref spec remote name
* matches the remote name.
* <p>
* The template uses {@code @{...}} as that is an illegal sequence in a remote name
*
* @see <a href="https://github.com/git/git/blob/027a3b943b444a3e3a76f9a89803fc10245b858f/refs.c#L61-L68">git
* source code rules on ref spec names</a>
* @since 3.4.0
*/
public static final String REF_SPEC_REMOTE_NAME_PLACEHOLDER_STR = "@{remote}";
/**
* The regex for {@link #REF_SPEC_REMOTE_NAME_PLACEHOLDER_STR}.
*
* @since 3.4.0
*/
public static final String REF_SPEC_REMOTE_NAME_PLACEHOLDER = "(?i)"+Pattern.quote(REF_SPEC_REMOTE_NAME_PLACEHOLDER_STR);
/**
* The default ref spec template.
*
* @since 3.4.0
*/
public static final String REF_SPEC_DEFAULT =
"+refs/heads/*:refs/remotes/" + REF_SPEC_REMOTE_NAME_PLACEHOLDER_STR + "/*";
/**
* Keep one lock per cache directory. Lazy populated, but never purge, except on restart.
*/
private static final ConcurrentMap<String, Lock> cacheLocks = new ConcurrentHashMap<>();
private static final Logger LOGGER = Logger.getLogger(AbstractGitSCMSource.class.getName());
public AbstractGitSCMSource() {
}
@Deprecated
public AbstractGitSCMSource(String id) {
setId(id);
}
@CheckForNull
public abstract String getCredentialsId();
/**
* @return Git remote URL
*/
public abstract String getRemote();
/**
* @deprecated use {@link WildcardSCMSourceFilterTrait}
* @return the includes.
*/
@Deprecated
@Restricted(NoExternalUse.class)
@RestrictedSince("3.4.0")
public String getIncludes() {
WildcardSCMHeadFilterTrait trait = SCMTrait.find(getTraits(), WildcardSCMHeadFilterTrait.class);
return trait != null ? trait.getIncludes() : "*";
}
/**
* @return the excludes.
* @deprecated use {@link WildcardSCMSourceFilterTrait}
*/
@Deprecated
@Restricted(NoExternalUse.class)
@RestrictedSince("3.4.0")
public String getExcludes() {
WildcardSCMHeadFilterTrait trait = SCMTrait.find(getTraits(), WildcardSCMHeadFilterTrait.class);
return trait != null ? trait.getExcludes() : "";
}
/**
* Gets {@link GitRepositoryBrowser} to be used with this SCMSource.
* @return Repository browser or {@code null} if the default tool should be used.
* @since 2.5.1
* @deprecated use {@link GitBrowserSCMSourceTrait}
*/
@CheckForNull
@Deprecated
@Restricted(NoExternalUse.class)
@RestrictedSince("3.4.0")
public GitRepositoryBrowser getBrowser() {
GitBrowserSCMSourceTrait trait = SCMTrait.find(getTraits(), GitBrowserSCMSourceTrait.class);
return trait != null ? trait.getBrowser() : null;
}
/**
* Gets Git tool to be used for this SCM Source.
* @return Git Tool or {@code null} if the default tool should be used.
* @since 2.5.1
* @deprecated use {@link GitToolSCMSourceTrait}
*/
@CheckForNull
@Deprecated
@Restricted(NoExternalUse.class)
@RestrictedSince("3.4.0")
public String getGitTool() {
GitToolSCMSourceTrait trait = SCMTrait.find(getTraits(), GitToolSCMSourceTrait.class);
return trait != null ? trait.getGitTool() : null;
}
/**
* Gets list of extensions, which should be used with this branch source.
* @return List of Extensions to be used. May be empty
* @since 2.5.1
* @deprecated use corresponding {@link GitSCMExtensionTrait} (and if there isn't one then likely the
* {@link GitSCMExtension} is not appropriate to use in the context of a {@link SCMSource})
*/
@NonNull
@Deprecated
@Restricted(NoExternalUse.class)
@RestrictedSince("3.4.0")
public List<GitSCMExtension> getExtensions() {
List<GitSCMExtension> extensions = new ArrayList<>();
for (SCMSourceTrait t : getTraits()) {
if (t instanceof GitSCMExtensionTrait) {
extensions.add(((GitSCMExtensionTrait) t).getExtension());
}
}
return Collections.unmodifiableList(extensions);
}
/**
* Returns the {@link SCMSourceTrait} instances for this {@link AbstractGitSCMSource}.
* @return the {@link SCMSourceTrait} instances
* @since 3.4.0
*/
@NonNull
public List<SCMSourceTrait> getTraits() {
// Always return empty list (we expect subclasses to override)
return Collections.emptyList();
}
/**
* @deprecated use {@link RemoteNameSCMSourceTrait}
* @return the remote name.
*/
@Deprecated
@Restricted(NoExternalUse.class)
@RestrictedSince("3.4.0")
public String getRemoteName() {
RemoteNameSCMSourceTrait trait = SCMTrait.find(getTraits(), RemoteNameSCMSourceTrait.class);
return trait != null ? trait.getRemoteName() : DEFAULT_REMOTE_NAME;
}
/**
* Resolves the {@link GitTool}.
* @return the {@link GitTool}.
* @deprecated use {@link #resolveGitTool(String)}.
*/
@CheckForNull
@Deprecated
@Restricted(DoNotUse.class)
@RestrictedSince("3.4.0")
protected GitTool resolveGitTool() {
return resolveGitTool(getGitTool());
}
/**
* Resolves the {@link GitTool}.
* @param gitTool the {@link GitTool#getName()} to resolve.
* @return the {@link GitTool}
* @since 3.4.0
* @deprecated Use {@link #resolveGitTool(String, TaskListener)} instead
*/
@CheckForNull
@Deprecated
protected GitTool resolveGitTool(String gitTool) {
return resolveGitTool(gitTool, TaskListener.NULL);
}
protected GitTool resolveGitTool(String gitTool, TaskListener listener) {
final Jenkins jenkins = Jenkins.get();
return GitUtils.resolveGitTool(gitTool, jenkins, null, TaskListener.NULL);
}
private interface Retriever<T> {
default T run(GitClient client, String remoteName) throws IOException, InterruptedException {
throw new AbstractMethodError("Not implemented");
}
}
private interface Retriever2<T> extends Retriever<T> {
T run(GitClient client, String remoteName, FetchCommand fetch) throws IOException, InterruptedException;
}
@NonNull
private <T, C extends GitSCMSourceContext<C, R>, R extends GitSCMSourceRequest> T doRetrieve(Retriever<T> retriever,
@NonNull C context,
@NonNull TaskListener listener,
boolean prune)
throws IOException, InterruptedException {
return doRetrieve(retriever, context, listener, prune, getOwner(), false);
}
@NonNull
private <T, C extends GitSCMSourceContext<C, R>, R extends GitSCMSourceRequest> T doRetrieve(Retriever<T> retriever,
@NonNull C context,
@NonNull TaskListener listener,
boolean prune,
@CheckForNull Item retrieveContext)
throws IOException, InterruptedException {
return doRetrieve(retriever, context, listener, prune, retrieveContext, false);
}
@NonNull
private <T, C extends GitSCMSourceContext<C, R>, R extends GitSCMSourceRequest> T doRetrieve(Retriever<T> retriever,
@NonNull C context,
@NonNull TaskListener listener,
boolean prune,
boolean delayFetch)
throws IOException, InterruptedException {
return doRetrieve(retriever, context, listener, prune, getOwner(), delayFetch);
}
@NonNull
private <T, C extends GitSCMSourceContext<C, R>, R extends GitSCMSourceRequest> T doRetrieve(Retriever<T> retriever,
@NonNull C context,
@NonNull TaskListener listener,
boolean prune,
@CheckForNull Item retrieveContext,
boolean delayFetch)
throws IOException, InterruptedException {
String cacheEntry = getCacheEntry();
Lock cacheLock = getCacheLock(cacheEntry);
cacheLock.lock();
try {
File cacheDir = getCacheDir(cacheEntry);
Git git = Git.with(listener, new EnvVars(EnvVars.masterEnvVars)).in(cacheDir);
GitTool tool = resolveGitTool(context.gitTool(), listener);
if (tool != null) {
git.using(tool.getGitExe());
}
GitClient client = git.getClient();
client.addDefaultCredentials(getCredentials(retrieveContext));
if (!client.hasGitRepo(false)) {
listener.getLogger().println("Creating git repository in " + cacheDir);
client.init();
}
String remoteName = context.remoteName();
listener.getLogger().println("Setting " + remoteName + " to " + getRemote());
client.setRemoteUrl(remoteName, getRemote());
listener.getLogger().println((prune ? "Fetching & pruning " : "Fetching ") + remoteName + "...");
FetchCommand fetch = client.fetch_();
fetch = fetch.prune(prune);
URIish remoteURI = null;
try {
remoteURI = new URIish(remoteName);
} catch (URISyntaxException ex) {
listener.getLogger().println("URI syntax exception for '" + remoteName + "' " + ex);
}
final FetchCommand fetchCommand = fetch.from(remoteURI, context.asRefSpecs());
if (!delayFetch) {
fetchCommand.execute();
} else if (retriever instanceof Retriever2) {
return ((Retriever2<T>)retriever).run(client, remoteName, fetchCommand);
}
return retriever.run(client, remoteName);
} finally {
cacheLock.unlock();
}
}
/**
* {@inheritDoc}
*/
@CheckForNull
@Override
protected SCMRevision retrieve(@NonNull final SCMHead head, @NonNull final TaskListener listener)
throws IOException, InterruptedException {
GitSCMSourceContext context = new GitSCMSourceContext<>(null, SCMHeadObserver.none()).withTraits(getTraits());
GitSCMTelescope telescope = GitSCMTelescope.of(this);
if (telescope != null) {
String remote = getRemote();
StandardUsernameCredentials credentials = getCredentials();
telescope.validate(remote, credentials);
return telescope.getRevision(remote, credentials, head);
}
//TODO write test using GitRefSCMHead
return doRetrieve(new Retriever<SCMRevision>() {
@Override
public SCMRevision run(GitClient client, String remoteName) throws IOException, InterruptedException {
if (head instanceof GitTagSCMHead) {
try {
ObjectId objectId = client.revParse(Constants.R_TAGS + head.getName());
return new GitTagSCMRevision((GitTagSCMHead) head, objectId.name());
} catch (GitException e) {
// tag does not exist
return null;
}
} else if (head instanceof GitBranchSCMHead) {
for (Branch b : client.getRemoteBranches()) {
String branchName = StringUtils.removeStart(b.getName(), remoteName + "/");
if (branchName.equals(head.getName())) {
return new GitBranchSCMRevision((GitBranchSCMHead)head, b.getSHA1String());
}
}
} else if (head instanceof GitRefSCMHead) {
try {
ObjectId objectId = client.revParse(((GitRefSCMHead) head).getRef());
return new GitRefSCMRevision((GitRefSCMHead)head, objectId.name());
} catch (GitException e) {
// ref could not be found
return null;
}
} else {
//Entering default/legacy git retrieve code path
for (Branch b : client.getRemoteBranches()) {
String branchName = StringUtils.removeStart(b.getName(), remoteName + "/");
if (branchName.equals(head.getName())) {
return new SCMRevisionImpl(head, b.getSHA1String());
}
}
}
return null;
}
},
context,
listener, /* we don't prune remotes here, as we just want one head's revision */false);
}
/**
* {@inheritDoc}
*/
@Override
@SuppressFBWarnings(value="SE_BAD_FIELD", justification="Known non-serializable this")
protected void retrieve(@CheckForNull SCMSourceCriteria criteria,
@NonNull SCMHeadObserver observer,
@CheckForNull SCMHeadEvent<?> event,
@NonNull final TaskListener listener)
throws IOException, InterruptedException {
final GitSCMSourceContext context =
new GitSCMSourceContext<>(criteria, observer).withTraits(getTraits());
final GitSCMTelescope telescope = GitSCMTelescope.of(this);
if (telescope != null) {
final String remote = getRemote();
final StandardUsernameCredentials credentials = getCredentials();
telescope.validate(remote, credentials);
Set<GitSCMTelescope.ReferenceType> referenceTypes = new HashSet<>();
if (context.wantBranches()) {
referenceTypes.add(GitSCMTelescope.ReferenceType.HEAD);
}
if (context.wantTags()) {
referenceTypes.add(GitSCMTelescope.ReferenceType.TAG);
}
//TODO JENKINS-51134 DiscoverOtherRefsTrait
if (!referenceTypes.isEmpty()) {
try (GitSCMSourceRequest request = context.newRequest(AbstractGitSCMSource.this, listener)) {
listener.getLogger().println("Listing remote references...");
Iterable<SCMRevision> revisions = telescope.getRevisions(remote, credentials, referenceTypes);
if (context.wantBranches()) {
listener.getLogger().println("Checking branches...");
int count = 0;
for (final SCMRevision revision : revisions) {
if (!(revision instanceof SCMRevisionImpl) || (revision instanceof GitTagSCMRevision)) {
continue;
}
count++;
if (request.process(revision.getHead(),
new SCMSourceRequest.RevisionLambda<SCMHead, SCMRevisionImpl>() {
@NonNull
@Override
public SCMRevisionImpl create(@NonNull SCMHead head)
throws IOException, InterruptedException {
listener.getLogger()
.println(" Checking branch " + revision.getHead().getName());
return (SCMRevisionImpl) revision;
}
},
new SCMSourceRequest.ProbeLambda<SCMHead, SCMRevisionImpl>() {
@NonNull
@Override
public SCMSourceCriteria.Probe create(@NonNull SCMHead head,
@NonNull SCMRevisionImpl revision)
throws IOException, InterruptedException {
return new TelescopingSCMProbe(telescope, remote, credentials, revision);
}
}, new SCMSourceRequest.Witness() {
@Override
public void record(@NonNull SCMHead head, SCMRevision revision,
boolean isMatch) {
if (isMatch) {
listener.getLogger().println(" Met criteria");
} else {
listener.getLogger().println(" Does not meet criteria");
}
}
}
)) {
listener.getLogger().format("Processed %d branches (query complete)%n", count);
return;
}
}
listener.getLogger().format("Processed %d branches%n", count);
}
if (context.wantTags()) {
listener.getLogger().println("Checking tags...");
int count = 0;
for (final SCMRevision revision : revisions) {
if (!(revision instanceof GitTagSCMRevision)) {
continue;
}
count++;
SCMHead scmHead = revision.getHead();
if (!(scmHead instanceof GitTagSCMHead)) {
continue;
}
GitTagSCMHead gitTagHead = (GitTagSCMHead) scmHead;
if (request.process(gitTagHead,
new SCMSourceRequest.RevisionLambda<GitTagSCMHead, GitTagSCMRevision>() {
@NonNull
@Override
public GitTagSCMRevision create(@NonNull GitTagSCMHead head)
throws IOException, InterruptedException {
listener.getLogger()
.println(" Checking tag " + revision.getHead().getName());
return (GitTagSCMRevision) revision;
}
},
new SCMSourceRequest.ProbeLambda<GitTagSCMHead, GitTagSCMRevision>() {
@NonNull
@Override
public SCMSourceCriteria.Probe create(@NonNull final GitTagSCMHead head,
@NonNull GitTagSCMRevision revision)
throws IOException, InterruptedException {
return new TelescopingSCMProbe(telescope, remote, credentials, revision);
}
}, new SCMSourceRequest.Witness() {
@Override
public void record(@NonNull SCMHead head, SCMRevision revision,
boolean isMatch) {
if (isMatch) {
listener.getLogger().println(" Met criteria");
} else {
listener.getLogger().println(" Does not meet criteria");
}
}
}
)) {
listener.getLogger().format("Processed %d tags (query complete)%n", count);
return;
}
}
listener.getLogger().format("Processed %d tags%n", count);
}
}
return;
}
}
doRetrieve(new Retriever2<Void>() {
@Override
public Void run(GitClient client, String remoteName, FetchCommand fetch) throws IOException, InterruptedException {
final Map<String, ObjectId> remoteReferences;
if (context.wantBranches() || context.wantTags() || context.wantOtherRefs()) {
listener.getLogger().println("Listing remote references...");
boolean headsOnly = !context.wantOtherRefs() && context.wantBranches();
boolean tagsOnly = !context.wantOtherRefs() && context.wantTags();
remoteReferences = client.getRemoteReferences(
client.getRemoteUrl(remoteName), null, headsOnly, tagsOnly
);
} else {
remoteReferences = Collections.emptyMap();
}
fetch.execute();
try (@SuppressWarnings("deprecation") // Local repository reference
Repository repository = client.getRepository();
RevWalk walk = new RevWalk(repository);
GitSCMSourceRequest request = context.newRequest(AbstractGitSCMSource.this, listener)) {
if (context.wantBranches()) {
discoverBranches(repository, walk, request, remoteReferences);
}
if (context.wantTags()) {
discoverTags(repository, walk, request, remoteReferences);
}
if (context.wantOtherRefs()) {
discoverOtherRefs(repository, walk, request, remoteReferences,
(Collection<GitSCMSourceContext.RefNameMapping>)context.getRefNameMappings());
}
}
return null;
}
private void discoverOtherRefs(final Repository repository,
final RevWalk walk, GitSCMSourceRequest request,
Map<String, ObjectId> remoteReferences,
Collection<GitSCMSourceContext.RefNameMapping> wantedRefs)
throws IOException, InterruptedException {
listener.getLogger().println("Checking other refs...");
walk.setRetainBody(false);
int count = 0;
for (final Map.Entry<String, ObjectId> ref : remoteReferences.entrySet()) {
if (ref.getKey().startsWith(Constants.R_HEADS) || ref.getKey().startsWith(Constants.R_TAGS)) {
continue;
}
for (GitSCMSourceContext.RefNameMapping otherRef : wantedRefs) {
if (!otherRef.matches(ref.getKey())) {
continue;
}
final String refName = otherRef.getName(ref.getKey());
if (refName == null) {
listener.getLogger().println(" Possible badly configured name mapping (" + otherRef.getName() + ") (for " + ref.getKey() + ") ignoring.");
continue;
}
count++;
if (request.process(new GitRefSCMHead(refName, ref.getKey()),
new SCMSourceRequest.IntermediateLambda<ObjectId>() {
@Nullable
@Override
public ObjectId create() throws IOException, InterruptedException {
listener.getLogger().println(" Checking ref " + refName + " (" + ref.getKey() + ")");
return ref.getValue();
}
},
new SCMSourceRequest.ProbeLambda<GitRefSCMHead, ObjectId>() {
@NonNull
@Override
public SCMSourceCriteria.Probe create(@NonNull GitRefSCMHead head,
@Nullable ObjectId revisionInfo)
throws IOException, InterruptedException {
RevCommit commit = walk.parseCommit(revisionInfo);
final long lastModified = TimeUnit.SECONDS.toMillis(commit.getCommitTime());
final RevTree tree = commit.getTree();
return new TreeWalkingSCMProbe(refName, lastModified, repository, tree);
}
}, new SCMSourceRequest.LazyRevisionLambda<GitRefSCMHead, SCMRevision, ObjectId>() {
@NonNull
@Override
public SCMRevision create(@NonNull GitRefSCMHead head, @Nullable ObjectId intermediate)
throws IOException, InterruptedException {
return new GitRefSCMRevision(head, ref.getValue().name());
}
}, new SCMSourceRequest.Witness() {
@Override
public void record(@NonNull SCMHead head, SCMRevision revision, boolean isMatch) {
if (isMatch) {
listener.getLogger().println(" Met criteria");
} else {
listener.getLogger().println(" Does not meet criteria");
}
}
}
)) {
listener.getLogger().format("Processed %d refs (query complete)%n", count);
return;
}
break;
}
}
listener.getLogger().format("Processed %d refs%n", count);
}
private void discoverBranches(final Repository repository,
final RevWalk walk, GitSCMSourceRequest request,
Map<String, ObjectId> remoteReferences)
throws IOException, InterruptedException {
listener.getLogger().println("Checking branches...");
walk.setRetainBody(false);
int count = 0;
for (final Map.Entry<String, ObjectId> ref : remoteReferences.entrySet()) {
if (!ref.getKey().startsWith(Constants.R_HEADS)) {
continue;
}
count++;
final String branchName = StringUtils.removeStart(ref.getKey(), Constants.R_HEADS);
if (request.process(new GitBranchSCMHead(branchName),
new SCMSourceRequest.IntermediateLambda<ObjectId>() {
@Nullable
@Override
public ObjectId create() throws IOException, InterruptedException {
listener.getLogger().println(" Checking branch " + branchName);
return ref.getValue();
}
},
new SCMSourceRequest.ProbeLambda<GitBranchSCMHead, ObjectId>() {
@NonNull
@Override
public SCMSourceCriteria.Probe create(@NonNull GitBranchSCMHead head,
@Nullable ObjectId revisionInfo)
throws IOException, InterruptedException {
RevCommit commit = walk.parseCommit(revisionInfo);
final long lastModified = TimeUnit.SECONDS.toMillis(commit.getCommitTime());
final RevTree tree = commit.getTree();
return new TreeWalkingSCMProbe(branchName, lastModified, repository, tree);
}
}, new SCMSourceRequest.LazyRevisionLambda<GitBranchSCMHead, SCMRevision, ObjectId>() {
@NonNull
@Override
public SCMRevision create(@NonNull GitBranchSCMHead head, @Nullable ObjectId intermediate)
throws IOException, InterruptedException {
return new GitBranchSCMRevision(head, ref.getValue().name());
}
}, new SCMSourceRequest.Witness() {
@Override
public void record(@NonNull SCMHead head, SCMRevision revision, boolean isMatch) {
if (isMatch) {
listener.getLogger().println(" Met criteria");
} else {
listener.getLogger().println(" Does not meet criteria");
}
}
}
)) {
listener.getLogger().format("Processed %d branches (query complete)%n", count);
return;
}
}
listener.getLogger().format("Processed %d branches%n", count);
}
private void discoverTags(final Repository repository,
final RevWalk walk, GitSCMSourceRequest request,
Map<String, ObjectId> remoteReferences)
throws IOException, InterruptedException {
listener.getLogger().println("Checking tags...");
walk.setRetainBody(false);
int count = 0;
for (final Map.Entry<String, ObjectId> ref : remoteReferences.entrySet()) {
if (!ref.getKey().startsWith(Constants.R_TAGS)) {
continue;
}
count++;
final String tagName = StringUtils.removeStart(ref.getKey(), Constants.R_TAGS);
RevCommit commit = walk.parseCommit(ref.getValue());
final long lastModified = TimeUnit.SECONDS.toMillis(commit.getCommitTime());
if (request.process(new GitTagSCMHead(tagName, lastModified),
new SCMSourceRequest.IntermediateLambda<ObjectId>() {
@Nullable
@Override
public ObjectId create() throws IOException, InterruptedException {
listener.getLogger().println(" Checking tag " + tagName);
return ref.getValue();
}
},
new SCMSourceRequest.ProbeLambda<GitTagSCMHead, ObjectId>() {
@NonNull
@Override
public SCMSourceCriteria.Probe create(@NonNull GitTagSCMHead head,
@Nullable ObjectId revisionInfo)
throws IOException, InterruptedException {
RevCommit commit = walk.parseCommit(revisionInfo);
final long lastModified = TimeUnit.SECONDS.toMillis(commit.getCommitTime());
final RevTree tree = commit.getTree();
return new TreeWalkingSCMProbe(tagName, lastModified, repository, tree);
}
}, new SCMSourceRequest.LazyRevisionLambda<GitTagSCMHead, GitTagSCMRevision, ObjectId>() {
@NonNull
@Override
public GitTagSCMRevision create(@NonNull GitTagSCMHead head, @Nullable ObjectId intermediate)
throws IOException, InterruptedException {
return new GitTagSCMRevision(head, ref.getValue().name());
}
}, new SCMSourceRequest.Witness() {
@Override
public void record(@NonNull SCMHead head, SCMRevision revision, boolean isMatch) {
if (isMatch) {
listener.getLogger().println(" Met criteria");
} else {
listener.getLogger().println(" Does not meet criteria");
}
}
}
)) {
listener.getLogger().format("Processed %d tags (query complete)%n", count);
return;
}
}
listener.getLogger().format("Processed %d tags%n", count);
}
}, context, listener, true, true);
}
/**
* {@inheritDoc}
*/
@CheckForNull
@Override
protected SCMRevision retrieve(@NonNull final String revision, @NonNull final TaskListener listener, @CheckForNull Item retrieveContext) throws IOException, InterruptedException {
final GitSCMSourceContext context =
new GitSCMSourceContext<>(null, SCMHeadObserver.none()).withTraits(getTraits());
final GitSCMTelescope telescope = GitSCMTelescope.of(this);
if (telescope != null) {
final String remote = getRemote();
final StandardUsernameCredentials credentials = getCredentials(retrieveContext);
telescope.validate(remote, credentials);
SCMRevision result = telescope.getRevision(remote, credentials, revision);
if (result != null) {
return result;
}
result = telescope.getRevision(remote, credentials, Constants.R_HEADS + revision);
if (result != null) {
return result;
}
result = telescope.getRevision(remote, credentials, Constants.R_TAGS + revision);
if (result != null) {
return result;
}
return null;
}
// first we need to figure out what the revision is. There are six possibilities:
// 1. A branch name (if we have that we can return quickly)
// 2. A tag name (if we have that we will need to fetch the tag to resolve the tag date)
// 3. A short/full revision hash that is the head revision of a branch (if we have that we can return quickly)
// 4. A remote refspec for example pull-requests/1/from
// 5. A short/full revision hash of a non default ref (non branch or tag but somewhere else under refs/)
// 6. A short revision hash that is the head revision of a branch (if we have that we can return quickly)
// 7. A short/full revision hash for a tag (we'll need to fetch the tag to resolve the tag date)
// 8. A short/full revision hash that is not the head revision of a branch (we'll need to fetch everything to
// try and resolve the hash from the history of one of the heads)
Git git = Git.with(listener, new EnvVars(EnvVars.masterEnvVars));
GitTool tool = resolveGitTool(context.gitTool(), listener);
if (tool != null) {
git.using(tool.getGitExe());
}
final GitClient client = git.getClient();
client.addDefaultCredentials(getCredentials(retrieveContext));
listener.getLogger().printf("Attempting to resolve %s from remote references...%n", revision);
boolean headsOnly = !context.wantOtherRefs() && context.wantBranches();
boolean tagsOnly = !context.wantOtherRefs() && context.wantTags();
Map<String, ObjectId> remoteReferences = client.getRemoteReferences(
getRemote(), null, headsOnly, tagsOnly
);
String tagName = null;
Set<String> shortNameMatches = new TreeSet<>();
String shortHashMatch = null;
Set<String> fullTagMatches = new TreeSet<>();
Set<String> fullHashMatches = new TreeSet<>();
String fullHashMatch = null;
GitRefSCMRevision candidateOtherRef = null;
for (Map.Entry<String,ObjectId> entry: remoteReferences.entrySet()) {
String name = entry.getKey();
String rev = entry.getValue().name();
if ("HEAD".equals(name)) {
//Skip HEAD as it should only appear during testing, not for standard bare repos iirc
continue;
}
if (name.equals(Constants.R_HEADS + revision)) {
listener.getLogger().printf("Found match: %s revision %s%n", name, rev);
// WIN!
return new GitBranchSCMRevision(new GitBranchSCMHead(revision), rev);
}
if (name.equals(Constants.R_TAGS+revision)) {
listener.getLogger().printf("Found match: %s revision %s%n", name, rev);
// WIN but not the good kind
tagName = revision;
context.wantBranches(false);
context.wantTags(true);
context.withoutRefSpecs();
break;
}
if (name.startsWith(Constants.R_HEADS) && revision.equalsIgnoreCase(rev)) {
listener.getLogger().printf("Found match: %s revision %s%n", name, rev);
// WIN!
return new GitBranchSCMRevision(new GitBranchSCMHead(StringUtils.removeStart(name, Constants.R_HEADS)), rev);
}
if (name.startsWith(Constants.R_TAGS) && revision.equalsIgnoreCase(rev)) {
listener.getLogger().printf("Candidate match: %s revision %s%n", name, rev);
// WIN but let's see if a branch also matches as that would save a fetch
fullTagMatches.add(name);
continue;
}
if((Constants.R_REFS + revision.toLowerCase(Locale.ENGLISH)).equals(name.toLowerCase(Locale.ENGLISH))) {
fullHashMatches.add(name);
if (fullHashMatch == null) {
fullHashMatch = rev;
}
continue;
}
if (rev.toLowerCase(Locale.ENGLISH).equals(revision.toLowerCase(Locale.ENGLISH))) {
fullHashMatches.add(name);
if (fullHashMatch == null) {
fullHashMatch = rev;
}
//Since it was a full match then the shortMatch below will also match, so just skip it
continue;
}
for (GitSCMSourceContext.RefNameMapping o : (Collection<GitSCMSourceContext.RefNameMapping>)context.getRefNameMappings()) {
if (o.matches(revision, name, rev)) {
candidateOtherRef = new GitRefSCMRevision(new GitRefSCMHead(revision, name), rev);
break;
}
}
if (rev.toLowerCase(Locale.ENGLISH).startsWith(revision.toLowerCase(Locale.ENGLISH))) {
shortNameMatches.add(name);
if (shortHashMatch == null) {
listener.getLogger().printf("Candidate partial match: %s revision %s%n", name, rev);
shortHashMatch = rev;
} else {
listener.getLogger().printf("Candidate partial match: %s revision %s%n", name, rev);
listener.getLogger().printf("Cannot resolve ambiguous short revision %s%n", revision);
return null;
}
}
}
if (!fullTagMatches.isEmpty()) {
// we just want a tag so we can do a minimal fetch
String name = StringUtils.removeStart(fullTagMatches.iterator().next(), Constants.R_TAGS);
listener.getLogger().printf("Selected match: %s revision %s%n", name, shortHashMatch);
tagName = name;
context.wantBranches(false);
context.wantTags(true);
context.withoutRefSpecs();
}
if (fullHashMatch != null) {
//since this would have been skipped if this was a head or a tag we can just return whatever
return new GitRefSCMRevision(new GitRefSCMHead(fullHashMatch, fullHashMatches.iterator().next()), fullHashMatch);
}
if (shortHashMatch != null) {
// woot this seems unambiguous
for (String name: shortNameMatches) {
if (name.startsWith(Constants.R_HEADS)) {
listener.getLogger().printf("Selected match: %s revision %s%n", name, shortHashMatch);
// WIN it's also a branch
return new GitBranchSCMRevision(new GitBranchSCMHead(StringUtils.removeStart(name, Constants.R_HEADS)),
shortHashMatch);
} else if (name.startsWith(Constants.R_TAGS)) {
tagName = StringUtils.removeStart(name, Constants.R_TAGS);
context.wantBranches(false);
context.wantTags(true);
context.withoutRefSpecs();
}
}
if (tagName != null) {
listener.getLogger().printf("Selected match: %s revision %s%n", tagName, shortHashMatch);
} else {
return new GitRefSCMRevision(new GitRefSCMHead(shortHashMatch, shortNameMatches.iterator().next()), shortHashMatch);
}
}
if (candidateOtherRef != null) {
return candidateOtherRef;
}
//if PruneStaleBranches it should take affect on the following retrievals
boolean pruneRefs = context.pruneRefs();
if (tagName != null) {
listener.getLogger().println(
"Resolving tag commit... (remote references may be a lightweight tag or an annotated tag)");
final String tagRef = Constants.R_TAGS+tagName;
return doRetrieve(new Retriever<SCMRevision>() {
@Override
public SCMRevision run(GitClient client, String remoteName) throws IOException,
InterruptedException {
try (@SuppressWarnings("deprecation") // Local repo reference
final Repository repository = client.getRepository();
RevWalk walk = new RevWalk(repository)) {
ObjectId ref = client.revParse(tagRef);
RevCommit commit = walk.parseCommit(ref);
long lastModified = TimeUnit.SECONDS.toMillis(commit.getCommitTime());
listener.getLogger().printf("Resolved tag %s revision %s%n", revision,
ref.getName());
return new GitTagSCMRevision(new GitTagSCMHead(revision, lastModified),
ref.name());
}
}
},
context,
listener, pruneRefs, retrieveContext);
}
// Pokémon!... Got to catch them all
listener.getLogger().printf("Could not find %s in remote references. "
+ "Pulling heads to local for deep search...%n", revision);