Diff class not mockable

Offen

#1,856 erstellt am 25.11.2020 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 4/5
Geschätzter Aufwand: 3-5 Tage
Anfängerfreundlichkeit: 35/100

Issue-Typ: Refactoring
Klarheit: Größtenteils klar
Aktivitätsstatus: Veraltet
Tech-Stack: csharp
Bereich: devtools

Rechercherichtung

Beginne mit LibGit2Sharp/Diff.cs, insbesondere mit dem internen Konstruktor, Compare und WorkdirToIndex, und verfolge dann den Aufruf aus LibGit2Sharp/Commands/Stage.cs. Reproduziere das im Issue beschriebene Commands.Stage-Szenario mit einem gemockten Repository. Fertig ist die Änderung, wenn der Pfad nicht mehr von Reflection abhängt, um ein verwendbares Diff zu erstellen, und nicht fehlschlägt, weil sein Repository null ist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

The Diff class is not very mockable due to its dependency on a private Repository field that is only set from an internal constructor. I encountered this when attempting to mock a repository and its related object graph and then invoking Commands.Stage with that mocked repository. It resulted in a null ref because the Diff.repo field wasn't set.

Commands.Stage ends up calling the internal Diff.Compare method:
https://github.com/libgit2/libgit2sharp/blob/3d7276275e8ea9dce324e437760c31e69b5ec10c/LibGit2Sharp/Commands/Stage.cs#L77

Compare ends up passing the Diff.repo field to WorkdirToIndex:
https://github.com/libgit2/libgit2sharp/blob/3d7276275e8ea9dce324e437760c31e69b5ec10c/LibGit2Sharp/Diff.cs#L472

Which then blows up because repo is null:
https://github.com/libgit2/libgit2sharp/blob/3d7276275e8ea9dce324e437760c31e69b5ec10c/LibGit2Sharp/Diff.cs#L506

The repo field is null because it only gets set by an internal constructor:
https://github.com/libgit2/libgit2sharp/blob/3d7276275e8ea9dce324e437760c31e69b5ec10c/LibGit2Sharp/Diff.cs#L90

This prevents a good mocking solution because the internal constructor can't be called without reflection.