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
|
/*
* SonarQube
* Copyright (C) 2009-2022 SonarSource SA
* mailto:info AT sonarsource DOT com
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package org.sonar.scm.git;
import java.io.File;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.LinkOption;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.nio.file.StandardOpenOption;
import java.time.Instant;
import java.util.Arrays;
import java.util.Collections;
import java.util.Date;
import java.util.HashSet;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Random;
import java.util.Set;
import java.util.TimeZone;
import java.util.concurrent.atomic.AtomicInteger;
import org.eclipse.jgit.api.DiffCommand;
import org.eclipse.jgit.api.Git;
import org.eclipse.jgit.api.errors.GitAPIException;
import org.eclipse.jgit.lib.ObjectId;
import org.eclipse.jgit.lib.PersonIdent;
import org.eclipse.jgit.lib.RefDatabase;
import org.eclipse.jgit.lib.Repository;
import org.eclipse.jgit.lib.RepositoryBuilder;
import org.eclipse.jgit.revwalk.RevCommit;
import org.eclipse.jgit.storage.file.FileRepositoryBuilder;
import org.eclipse.jgit.treewalk.AbstractTreeIterator;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.TemporaryFolder;
import org.sonar.api.notifications.AnalysisWarnings;
import org.sonar.api.scan.filesystem.PathResolver;
import org.sonar.api.utils.MessageException;
import org.sonar.api.utils.System2;
import org.sonar.api.utils.log.LogAndArguments;
import org.sonar.api.utils.log.LogTester;
import static java.util.Collections.emptySet;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatThrownBy;
import static org.assertj.core.data.MapEntry.entry;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.anyBoolean;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.verifyNoInteractions;
import static org.mockito.Mockito.when;
import static org.sonar.api.utils.log.LoggerLevel.WARN;
import static org.sonar.scm.git.GitUtils.createFile;
import static org.sonar.scm.git.GitUtils.createRepository;
import static org.sonar.scm.git.Utils.javaUnzip;
public class GitScmProviderTest {
// Sample content for unified diffs
// http://www.gnu.org/software/diffutils/manual/html_node/Example-Unified.html#Example-Unified
private static final String CONTENT_LAO = "The Way that can be told of is not the eternal Way;\n"
+ "The name that can be named is not the eternal name.\n"
+ "The Nameless is the origin of Heaven and Earth;\n"
+ "The Named is the mother of all things.\n"
+ "Therefore let there always be non-being,\n"
+ " so we may see their subtlety,\n"
+ "And let there always be being,\n"
+ " so we may see their outcome.\n"
+ "The two are the same,\n"
+ "But after they are produced,\n"
+ " they have different names.\n";
private static final String CONTENT_TZU = "The Nameless is the origin of Heaven and Earth;\n"
+ "The named is the mother of all things.\n"
+ "\n"
+ "Therefore let there always be non-being,\n"
+ " so we may see their subtlety,\n"
+ "And let there always be being,\n"
+ " so we may see their outcome.\n"
+ "The two are the same,\n"
+ "But after they are produced,\n"
+ " they have different names.\n"
+ "They both may be called deep and profound.\n"
+ "Deeper and more profound,\n"
+ "The door of all subtleties!";
private static final String BRANCH_NAME = "branch";
@Rule
public TemporaryFolder temp = new TemporaryFolder();
@Rule
public LogTester logs = new LogTester();
private final GitIgnoreCommand gitIgnoreCommand = mock(GitIgnoreCommand.class);
private static final Random random = new Random();
private static final System2 system2 = mock(System2.class);
private Path worktree;
private Git git;
private final AnalysisWarnings analysisWarnings = mock(AnalysisWarnings.class);
@Before
public void before() throws IOException, GitAPIException {
worktree = temp.newFolder().toPath();
git = createRepository(worktree);
createAndCommitFile("file-in-first-commit.xoo");
}
@Test
public void sanityCheck() {
assertThat(newGitScmProvider().key()).isEqualTo("git");
}
@Test
public void returnImplem() {
JGitBlameCommand jblameCommand = new JGitBlameCommand();
GitBlameCommand nativeBlameCommand = new GitBlameCommand();
CompositeBlameCommand compositeBlameCommand = new CompositeBlameCommand(analysisWarnings, new PathResolver(), jblameCommand, nativeBlameCommand);
GitScmProvider gitScmProvider = new GitScmProvider(compositeBlameCommand, analysisWarnings, gitIgnoreCommand, system2);
assertThat(gitScmProvider.blameCommand()).isEqualTo(compositeBlameCommand);
}
/**
* SONARSCGIT-47
*/
@Test
public void branchChangedFiles_should_not_crash_if_branches_have_no_common_ancestors() throws GitAPIException, IOException {
String fileName = "file-in-first-commit.xoo";
String renamedName = "file-renamed.xoo";
git.checkout().setOrphan(true).setName("b1").call();
Path file = worktree.resolve(fileName);
Path renamed = file.resolveSibling(renamedName);
addLineToFile(fileName, 1);
Files.move(file, renamed);
git.rm().addFilepattern(fileName).call();
commit(renamedName);
Set<Path> files = newScmProvider().branchChangedFiles("master", worktree);
// no shared history, so no diff
assertThat(files).isNull();
}
@Test
public void testAutodetection() throws IOException {
File baseDirEmpty = temp.newFolder();
assertThat(newGitScmProvider().supports(baseDirEmpty)).isFalse();
File projectDir = temp.newFolder();
javaUnzip("dummy-git.zip", projectDir);
File baseDir = new File(projectDir, "dummy-git");
assertThat(newScmProvider().supports(baseDir)).isTrue();
}
private static CompositeBlameCommand mockCommand() {
return mock(CompositeBlameCommand.class);
}
@Test
public void branchChangedFiles_from_diverged() throws IOException, GitAPIException {
createAndCommitFile("file-m1.xoo");
createAndCommitFile("file-m2.xoo");
createAndCommitFile("file-m3.xoo");
ObjectId forkPoint = git.getRepository().exactRef("HEAD").getObjectId();
appendToAndCommitFile("file-m3.xoo");
createAndCommitFile("file-m4.xoo");
git.branchCreate().setName("b1").setStartPoint(forkPoint.getName()).call();
git.checkout().setName("b1").call();
createAndCommitFile("file-b1.xoo");
appendToAndCommitFile("file-m1.xoo");
deleteAndCommitFile("file-m2.xoo");
assertThat(newScmProvider().branchChangedFiles("master", worktree))
.containsExactlyInAnyOrder(
worktree.resolve("file-b1.xoo"),
worktree.resolve("file-m1.xoo"));
}
@Test
public void branchChangedFiles_should_not_fail_with_patience_diff_algo() throws IOException {
Path gitConfig = worktree.resolve(".git").resolve("config");
Files.write(gitConfig, "[diff]\nalgorithm = patience\n".getBytes(StandardCharsets.UTF_8));
Repository repo = FileRepositoryBuilder.create(worktree.resolve(".git").toFile());
git = new Git(repo);
assertThat(newScmProvider().branchChangedFiles("master", worktree)).isNull();
}
@Test
public void branchChangedFiles_from_merged_and_diverged() throws IOException, GitAPIException {
createAndCommitFile("file-m1.xoo");
createAndCommitFile("file-m2.xoo");
createAndCommitFile("lao.txt", CONTENT_LAO);
ObjectId forkPoint = git.getRepository().exactRef("HEAD").getObjectId();
createAndCommitFile("file-m3.xoo");
ObjectId mergePoint = git.getRepository().exactRef("HEAD").getObjectId();
appendToAndCommitFile("file-m3.xoo");
createAndCommitFile("file-m4.xoo");
git.branchCreate().setName("b1").setStartPoint(forkPoint.getName()).call();
git.checkout().setName("b1").call();
createAndCommitFile("file-b1.xoo");
appendToAndCommitFile("file-m1.xoo");
deleteAndCommitFile("file-m2.xoo");
git.merge().include(mergePoint).call();
createAndCommitFile("file-b2.xoo");
createAndCommitFile("file-m5.xoo");
deleteAndCommitFile("file-m5.xoo");
Set<Path> changedFiles = newScmProvider().branchChangedFiles("master", worktree);
assertThat(changedFiles)
.containsExactlyInAnyOrder(
worktree.resolve("file-m1.xoo"),
worktree.resolve("file-b1.xoo"),
worktree.resolve("file-b2.xoo"));
// use a subset of changed files for .branchChangedLines to verify only requested files are returned
assertThat(changedFiles.remove(worktree.resolve("file-b1.xoo"))).isTrue();
// generate common sample diff
createAndCommitFile("lao.txt", CONTENT_TZU);
changedFiles.add(worktree.resolve("lao.txt"));
// a file that should not yield any results
changedFiles.add(worktree.resolve("nonexistent"));
assertThat(newScmProvider().branchChangedLines("master", worktree, changedFiles))
.containsOnly(
entry(worktree.resolve("lao.txt"), new HashSet<>(Arrays.asList(2, 3, 11, 12, 13))),
entry(worktree.resolve("file-m1.xoo"), new HashSet<>(Arrays.asList(4))),
entry(worktree.resolve("file-b2.xoo"), new HashSet<>(Arrays.asList(1, 2, 3))));
assertThat(newScmProvider().branchChangedLines("master", worktree, Collections.singleton(worktree.resolve("nonexistent"))))
.isEmpty();
}
@Test
public void branchChangedLines_given2NestedSubmodulesWithChangesInTheBottomSubmodule_detectChanges() throws IOException, GitAPIException {
Git gitForRepo2, gitForRepo3;
Path worktreeForRepo2, worktreeForRepo3;
worktreeForRepo2 = temp.newFolder().toPath();
gitForRepo2 = createRepository(worktreeForRepo2);
worktreeForRepo3 = temp.newFolder().toPath();
gitForRepo3 = createRepository(worktreeForRepo3);
createAndCommitFile("sub2.js", gitForRepo3, worktreeForRepo3);
addSubmodule(gitForRepo2, "sub2", worktreeForRepo3.toUri().toString());
addSubmodule(git, "sub1", worktreeForRepo2.toUri().toString());
File mainFolderWithAllSubmodules = temp.newFolder().toPath().toRealPath(LinkOption.NOFOLLOW_LINKS).toFile();
Git.cloneRepository()
.setURI(worktree.toUri().toString())
.setDirectory(mainFolderWithAllSubmodules)
.setCloneSubmodules(true)
.call();
Path submodule2Path = mainFolderWithAllSubmodules.toPath().resolve("sub1/sub2");
Repository submodule2 = new RepositoryBuilder().findGitDir(submodule2Path.toFile()).build();
Git gitForSubmodule2 = new Git(submodule2);
gitForSubmodule2.branchCreate().setName("develop").call();
gitForSubmodule2.checkout().setName("develop").call();
Path submodule2File = mainFolderWithAllSubmodules.toPath().resolve("sub1/sub2/sub2.js");
Files.write(submodule2File, randomizedContent("sub2.js", 3).getBytes(), StandardOpenOption.APPEND);
gitForSubmodule2.add().addFilepattern("sub2.js").call();
gitForSubmodule2.commit().setAuthor("joe", "joe@example.com").setMessage("important change").call();
Map<Path, Set<Integer>> changedLines = newScmProvider().branchChangedLines("master", submodule2Path, Set.of(submodule2File));
assertThat(changedLines).hasSize(1);
assertThat(changedLines.entrySet().iterator().next().getValue()).containsOnly(4, 5, 6);
}
private void addSubmodule(Git mainGit, String submoduleName, String uriToSubmodule) throws GitAPIException {
mainGit.submoduleAdd().setPath(submoduleName).setURI(uriToSubmodule).call();
mainGit.commit().setAuthor("joe", "joe@example.com").setMessage("adding submodule").call();
}
@Test
public void forkDate_returns_null() {
assertThat(newScmProvider().forkDate("unknown", worktree)).isNull();
}
@Test
public void branchChangedLines_should_be_correct_when_change_is_not_committed() throws GitAPIException, IOException {
String fileName = "file-in-first-commit.xoo";
git.branchCreate().setName("b1").call();
git.checkout().setName("b1").call();
// this line is committed
addLineToFile(fileName, 3);
commit(fileName);
// this line is not committed
addLineToFile(fileName, 1);
Path filePath = worktree.resolve(fileName);
Map<Path, Set<Integer>> changedLines = newScmProvider().branchChangedLines("master", worktree, Collections.singleton(filePath));
// both lines appear correctly
assertThat(changedLines).containsExactly(entry(filePath, new HashSet<>(Arrays.asList(1, 4))));
}
@Test
public void branchChangedLines_should_not_fail_if_there_is_no_merge_base() throws GitAPIException, IOException {
createAndCommitFile("file-m1.xoo");
git.checkout().setOrphan(true).setName("b1").call();
createAndCommitFile("file-b1.xoo");
Map<Path, Set<Integer>> changedLines = newScmProvider().branchChangedLines("master", worktree, Collections.singleton(Paths.get("")));
assertThat(changedLines).isNull();
}
@Test
public void branchChangedLines_returns_empty_set_for_files_with_lines_removed_only() throws GitAPIException, IOException {
String fileName = "file-in-first-commit.xoo";
git.branchCreate().setName("b1").call();
git.checkout().setName("b1").call();
removeLineInFile(fileName, 2);
commit(fileName);
Path filePath = worktree.resolve(fileName);
Map<Path, Set<Integer>> changedLines = newScmProvider().branchChangedLines("master", worktree, Collections.singleton(filePath));
// both lines appear correctly
assertThat(changedLines).containsExactly(entry(filePath, emptySet()));
}
@Test
public void branchChangedLines_uses_relative_paths_from_project_root() throws GitAPIException, IOException {
String fileName = "project1/file-in-first-commit.xoo";
createAndCommitFile(fileName);
git.branchCreate().setName("b1").call();
git.checkout().setName("b1").call();
// this line is committed
addLineToFile(fileName, 3);
commit(fileName);
// this line is not committed
addLineToFile(fileName, 1);
Path filePath = worktree.resolve(fileName);
Map<Path, Set<Integer>> changedLines = newScmProvider().branchChangedLines("master",
worktree.resolve("project1"), Collections.singleton(filePath));
// both lines appear correctly
assertThat(changedLines).containsExactly(entry(filePath, new HashSet<>(Arrays.asList(1, 4))));
}
@Test
public void branchChangedFiles_when_git_work_tree_is_above_project_basedir() throws IOException, GitAPIException {
git.branchCreate().setName("b1").call();
git.checkout().setName("b1").call();
Path projectDir = worktree.resolve("project");
Files.createDirectory(projectDir);
createAndCommitFile("project/file-b1");
assertThat(newScmProvider().branchChangedFiles("master", projectDir))
.containsOnly(projectDir.resolve("file-b1"));
}
@Test
public void branchChangedLines_should_not_fail_with_patience_diff_algo() throws IOException {
Path gitConfig = worktree.resolve(".git").resolve("config");
Files.write(gitConfig, "[diff]\nalgorithm = patience\n".getBytes(StandardCharsets.UTF_8));
Repository repo = FileRepositoryBuilder.create(worktree.resolve(".git").toFile());
git = new Git(repo);
assertThat(newScmProvider().branchChangedLines("master", worktree, Collections.singleton(Paths.get("file")))).isNull();
}
/**
* Unfortunately it looks like JGit doesn't support this setting using .gitattributes.
*/
@Test
public void branchChangedLines_should_always_ignore_different_line_endings() throws IOException, GitAPIException {
Path filePath = worktree.resolve("file-m1.xoo");
createAndCommitFile("file-m1.xoo");
ObjectId forkPoint = git.getRepository().exactRef("HEAD").getObjectId();
git.branchCreate().setName("b1").setStartPoint(forkPoint.getName()).call();
git.checkout().setName("b1").call();
String newFileContent = new String(Files.readAllBytes(filePath), StandardCharsets.UTF_8).replaceAll("\n", "\r\n");
Files.write(filePath, newFileContent.getBytes(StandardCharsets.UTF_8), StandardOpenOption.TRUNCATE_EXISTING);
commit("file-m1.xoo");
assertThat(newScmProvider().branchChangedLines("master", worktree, Collections.singleton(filePath)))
.isEmpty();
}
@Test
public void branchChangedFiles_falls_back_to_origin_when_local_branch_does_not_exist() throws IOException, GitAPIException {
git.branchCreate().setName("b1").call();
git.checkout().setName("b1").call();
createAndCommitFile("file-b1");
Path worktree2 = temp.newFolder().toPath();
Git.cloneRepository()
.setURI(worktree.toString())
.setDirectory(worktree2.toFile())
.call();
assertThat(newScmProvider().branchChangedFiles("master", worktree2))
.containsOnly(worktree2.resolve("file-b1"));
verifyNoInteractions(analysisWarnings);
}
@Test
public void branchChangedFiles_use_remote_target_ref_when_running_on_circle_ci() throws IOException, GitAPIException {
when(system2.envVariable("CIRCLECI")).thenReturn("true");
git.checkout().setName("b1").setCreateBranch(true).call();
createAndCommitFile("file-b1");
Path worktree2 = temp.newFolder().toPath();
Git local = Git.cloneRepository()
.setURI(worktree.toString())
.setDirectory(worktree2.toFile())
.call();
// Make local master match analyzed branch, so if local ref is used then change files will be empty
local.checkout().setCreateBranch(true).setName("master").setStartPoint("origin/b1").call();
local.checkout().setName("b1").call();
assertThat(newScmProvider().branchChangedFiles("master", worktree2))
.containsOnly(worktree2.resolve("file-b1"));
verifyNoInteractions(analysisWarnings);
}
@Test
public void branchChangedFiles_falls_back_to_local_ref_if_origin_branch_does_not_exist_when_running_on_circle_ci() throws IOException, GitAPIException {
when(system2.envVariable("CIRCLECI")).thenReturn("true");
git.checkout().setName("b1").setCreateBranch(true).call();
createAndCommitFile("file-b1");
Path worktree2 = temp.newFolder().toPath();
Git local = Git.cloneRepository()
.setURI(worktree.toString())
.setDirectory(worktree2.toFile())
.call();
local.checkout().setName("local-only").setCreateBranch(true).setStartPoint("origin/master").call();
local.checkout().setName("b1").call();
assertThat(newScmProvider().branchChangedFiles("local-only", worktree2))
.containsOnly(worktree2.resolve("file-b1"));
verifyNoInteractions(analysisWarnings);
}
@Test
public void branchChangedFiles_falls_back_to_upstream_ref() throws IOException, GitAPIException {
git.branchCreate().setName("b1").call();
git.checkout().setName("b1").call();
createAndCommitFile("file-b1");
Path worktree2 = temp.newFolder().toPath();
Git.cloneRepository()
.setURI(worktree.toString())
.setRemote("upstream")
.setDirectory(worktree2.toFile())
.call();
assertThat(newScmProvider().branchChangedFiles("master", worktree2))
.containsOnly(worktree2.resolve("file-b1"));
verifyNoInteractions(analysisWarnings);
}
@Test
public void branchChangedFiles_finds_branch_in_specific_origin() throws IOException, GitAPIException {
git.branchCreate().setName("b1").call();
git.checkout().setName("b1").call();
createAndCommitFile("file-b1");
Path worktree2 = temp.newFolder().toPath();
Git.cloneRepository()
.setURI(worktree.toString())
.setRemote("upstream")
.setDirectory(worktree2.toFile())
.call();
assertThat(newScmProvider().branchChangedFiles("upstream/master", worktree2))
.containsOnly(worktree2.resolve("file-b1"));
verifyNoInteractions(analysisWarnings);
}
@Test
public void branchChangedFiles_should_return_null_when_branch_nonexistent() {
assertThat(newScmProvider().branchChangedFiles("nonexistent", worktree)).isNull();
}
@Test
public void branchChangedFiles_should_throw_when_repo_nonexistent() throws IOException {
assertThatThrownBy(() -> newScmProvider().branchChangedFiles("master", temp.newFolder().toPath()))
.isInstanceOf(MessageException.class)
.hasMessageContaining("Not inside a Git work tree: ");
}
@Test
public void branchChangedFiles_should_throw_when_dir_nonexistent() {
assertThatThrownBy(() -> newScmProvider().branchChangedFiles("master", temp.getRoot().toPath().resolve("nonexistent")))
.isInstanceOf(MessageException.class)
.hasMessageContaining("Not inside a Git work tree: ");
}
@Test
public void branchChangedFiles_should_return_null_on_io_errors_of_repo_builder() {
GitScmProvider provider = new GitScmProvider(mockCommand(), analysisWarnings, gitIgnoreCommand, system2) {
@Override
Repository buildRepo(Path basedir) throws IOException {
throw new IOException();
}
};
assertThat(provider.branchChangedFiles(BRANCH_NAME, worktree)).isNull();
verifyNoInteractions(analysisWarnings);
}
@Test
public void branchChangedFiles_should_return_null_if_repo_exactref_is_null() throws IOException {
Repository repository = mock(Repository.class);
RefDatabase refDatabase = mock(RefDatabase.class);
when(repository.getRefDatabase()).thenReturn(refDatabase);
when(refDatabase.findRef(BRANCH_NAME)).thenReturn(null);
GitScmProvider provider = new GitScmProvider(mockCommand(), analysisWarnings, gitIgnoreCommand, system2) {
@Override
Repository buildRepo(Path basedir) {
return repository;
}
};
assertThat(provider.branchChangedFiles(BRANCH_NAME, worktree)).isNull();
String refNotFound = "Could not find ref 'branch' in refs/heads, refs/remotes, refs/remotes/upstream or refs/remotes/origin";
LogAndArguments warnLog = logs.getLogs(WARN).get(0);
assertThat(warnLog.getRawMsg()).isEqualTo(refNotFound);
String warning = refNotFound
+ ". You may see unexpected issues and changes. Please make sure to fetch this ref before pull request analysis"
+ " and refer to <a href=\"/documentation/analysis/scm-integration/\" target=\"_blank\">the documentation</a>.";
verify(analysisWarnings).addUnique(warning);
}
@Test
public void branchChangedFiles_should_return_null_on_errors() throws GitAPIException {
DiffCommand diffCommand = mock(DiffCommand.class);
when(diffCommand.setShowNameAndStatusOnly(anyBoolean())).thenReturn(diffCommand);
when(diffCommand.setOldTree(any())).thenReturn(diffCommand);
when(diffCommand.setNewTree(any())).thenReturn(diffCommand);
when(diffCommand.call()).thenThrow(mock(GitAPIException.class));
Git git = mock(Git.class);
when(git.diff()).thenReturn(diffCommand);
GitScmProvider provider = new GitScmProvider(mockCommand(), analysisWarnings, gitIgnoreCommand, system2) {
@Override
Git newGit(Repository repo) {
return git;
}
};
assertThat(provider.branchChangedFiles("master", worktree)).isNull();
verify(diffCommand).call();
}
@Test
public void branchChangedLines_returns_null_when_branch_doesnt_exist() {
assertThat(newScmProvider().branchChangedLines("nonexistent", worktree, emptySet())).isNull();
}
@Test
public void branchChangedLines_omits_files_with_git_api_errors() throws IOException, GitAPIException {
String f1 = "file-in-first-commit.xoo";
String f2 = "file2-in-first-commit.xoo";
createAndCommitFile(f2);
git.branchCreate().setName("b1").call();
git.checkout().setName("b1").call();
// both files modified
addLineToFile(f1, 1);
addLineToFile(f2, 2);
commit(f1);
commit(f2);
AtomicInteger callCount = new AtomicInteger(0);
GitScmProvider provider = new GitScmProvider(mockCommand(), analysisWarnings, gitIgnoreCommand, system2) {
@Override
AbstractTreeIterator prepareTreeParser(Repository repo, RevCommit commit) throws IOException {
if (callCount.getAndIncrement() == 1) {
throw new RuntimeException("error");
}
return super.prepareTreeParser(repo, commit);
}
};
Set<Path> changedFiles = new LinkedHashSet<>();
changedFiles.add(worktree.resolve(f1));
changedFiles.add(worktree.resolve(f2));
assertThat(provider.branchChangedLines("master", worktree, changedFiles))
.isEqualTo(Collections.singletonMap(worktree.resolve(f1), Collections.singleton(1)));
}
@Test
public void branchChangedLines_returns_null_on_io_errors_of_repo_builder() {
GitScmProvider provider = new GitScmProvider(mockCommand(), analysisWarnings, gitIgnoreCommand, system2) {
@Override
Repository buildRepo(Path basedir) throws IOException {
throw new IOException();
}
};
assertThat(provider.branchChangedLines(BRANCH_NAME, worktree, emptySet())).isNull();
}
@Test
public void relativePathFromScmRoot_should_return_dot_project_root() {
assertThat(newGitScmProvider().relativePathFromScmRoot(worktree)).isEqualTo(Paths.get(""));
}
private GitScmProvider newGitScmProvider() {
return new GitScmProvider(mock(CompositeBlameCommand.class), analysisWarnings, gitIgnoreCommand, system2);
}
@Test
public void relativePathFromScmRoot_should_return_filename_for_file_in_project_root() throws IOException {
Path filename = Paths.get("somefile.xoo");
Path path = worktree.resolve(filename);
Files.createFile(path);
assertThat(newGitScmProvider().relativePathFromScmRoot(path)).isEqualTo(filename);
}
@Test
public void relativePathFromScmRoot_should_return_relative_path_for_file_in_project_subdir() throws IOException {
Path relpath = Paths.get("sub/dir/to/somefile.xoo");
Path path = worktree.resolve(relpath);
Files.createDirectories(path.getParent());
Files.createFile(path);
assertThat(newGitScmProvider().relativePathFromScmRoot(path)).isEqualTo(relpath);
}
@Test
public void revisionId_should_return_different_sha1_after_commit() throws IOException, GitAPIException {
Path projectDir = worktree.resolve("project");
Files.createDirectory(projectDir);
GitScmProvider provider = newGitScmProvider();
String sha1before = provider.revisionId(projectDir);
assertThat(sha1before).hasSize(40);
createAndCommitFile("project/file1");
String sha1after = provider.revisionId(projectDir);
assertThat(sha1after)
.hasSize(40)
.isNotEqualTo(sha1before);
assertThat(provider.revisionId(projectDir)).isEqualTo(sha1after);
}
@Test
public void revisionId_should_return_null_in_empty_repo() throws IOException {
worktree = temp.newFolder().toPath();
Repository repo = FileRepositoryBuilder.create(worktree.resolve(".git").toFile());
repo.create();
git = new Git(repo);
Path projectDir = worktree.resolve("project");
Files.createDirectory(projectDir);
GitScmProvider provider = newGitScmProvider();
assertThat(provider.revisionId(projectDir)).isNull();
}
private String randomizedContent(String prefix, int numLines) {
StringBuilder sb = new StringBuilder();
for (int line = 0; line < numLines; line++) {
sb.append(randomizedLine(prefix));
sb.append("\n");
}
return sb.toString();
}
private String randomizedLine(String prefix) {
StringBuilder sb = new StringBuilder(prefix);
for (int i = 0; i < 4; i++) {
sb.append(' ');
for (int j = 0; j < prefix.length(); j++) {
sb.append((char) ('a' + random.nextInt(26)));
}
}
return sb.toString();
}
private void createAndCommitFile(String relativePath) throws IOException, GitAPIException {
createAndCommitFile(relativePath, randomizedContent(relativePath, 3), git, this.worktree);
}
private void createAndCommitFile(String relativePath, Instant commitDate) throws IOException, GitAPIException {
createFile(relativePath, randomizedContent(relativePath, 3), this.worktree);
commit(relativePath, commitDate);
}
private void createAndCommitFile(String fileName, Git git, Path worktree) throws IOException, GitAPIException {
createAndCommitFile(fileName, randomizedContent(fileName, 3), git, worktree);
}
private void createAndCommitFile(String relativePath, String content) throws IOException, GitAPIException {
createAndCommitFile(relativePath, content, this.git, this.worktree);
}
private void createAndCommitFile(String relativePath, String content, Git git, Path worktree) throws IOException, GitAPIException {
createFile(relativePath, content, worktree);
commit(git, relativePath);
}
private void addLineToFile(String relativePath, int lineNumber) throws IOException {
Path filePath = worktree.resolve(relativePath);
List<String> lines = Files.readAllLines(filePath);
lines.add(lineNumber - 1, randomizedLine(relativePath));
Files.write(filePath, lines, StandardOpenOption.TRUNCATE_EXISTING);
}
private void removeLineInFile(String relativePath, int lineNumber) throws IOException {
Path filePath = worktree.resolve(relativePath);
List<String> lines = Files.readAllLines(filePath);
lines.remove(lineNumber - 1);
Files.write(filePath, lines, StandardOpenOption.TRUNCATE_EXISTING);
}
private void appendToAndCommitFile(String relativePath) throws IOException, GitAPIException {
Files.write(worktree.resolve(relativePath), randomizedContent(relativePath, 1).getBytes(), StandardOpenOption.APPEND);
commit(this.git, relativePath);
}
private void deleteAndCommitFile(String relativePath) throws GitAPIException {
git.rm().addFilepattern(relativePath).call();
commit(this.git, relativePath);
}
private void commit(Git git, String... relativePaths) throws GitAPIException {
for (String path : relativePaths) {
git.add().addFilepattern(path).call();
}
String msg = String.join(",", relativePaths);
git.commit().setAuthor("joe", "joe@example.com").setMessage(msg).call();
}
private void commit(String... relativePaths) throws GitAPIException {
commit(this.git, relativePaths);
}
private void commit(String relativePath, Instant date) throws GitAPIException {
PersonIdent person = new PersonIdent("joe", "joe@example.com", Date.from(date), TimeZone.getDefault());
git.commit().setAuthor(person).setCommitter(person).setMessage(relativePath).call();
}
private GitScmProvider newScmProvider() {
return new GitScmProvider(mockCommand(), analysisWarnings, gitIgnoreCommand, system2);
}
}
|