Jako Akwizytor zbieram z repozytorium GIT informacje o historii projektu

Transkrypt

1 Jako Akwizytor zbieram z repozytorium GIT informacje o historii projektu Cel PU: Celem przypadku użycia jest zebranie danych o historii zmian dokonanych w projekcie. Opis PU: Zadaniem przypadku użycia jest pobranie kopii repozytorium z serwera Gita, a później uzyskanie informacji o historii projektu z lokalnej kopii repozytorium. W tym celu napisaliśmy klasę GitWrapperImpl, dziedziczącą po klasie AbstractRepoWrapperImpl. Napisaliśmy też klasę pomocniczą GitDiffService. Warunki początkowe: Przekazanie przez GUI nazwy repozytorium oraz adresu repozytorium, które będziemy chcieli ściągnąć na nasz dysk w celu zebrania danych o cyklu życia projektu. Podstawowy ciąg zdarzeń: (cały poniższy ciąg zdarzeń zawiera się w metodzie fetchprojecthistory, która zwraca obiekt klasy ProjectHistory) 1. Tworząc obiekt naszej nowej klasy za pomocą konstruktora ustawiamy adres URI repouri, w tym przypadku jest adresem, który wskazuje adres, z którego pobierzemy repozytorium. Przypisujemy także katalog, w którym chcemy zapisać interesujące nas repozytorium, mianowicie repodir. Te dane zapisywane są jako pola obiektu config, klasy Properties. 2. Jeżeli repozytorium nie istnieje wywołujemy metodę fetchrepository. 3. W metodzie fetchrepository usuwamy dotychczasowy katalog metodą deletedirectory w celu uniknięcia błedów. 4. W celu pobrania repozytorium w metodzie fetchrepository wywołujemy metodę CloneRepository(config data) z klasy Git, gdzie data to ustawione przez nas w podpunkcie pierwszym repouri i repodir. Metoda zwraca pobrane repozytorium. 5. Ustalamy start rewizji metodą getstartrevision(), następnie koniec rewizji za pomocą getendrevision(). Metody te zwrócą pola klasy RevCommit, których użyjemy jako argumenty metody getrevcommitset. 6. Tworzy następnie kolekcję commitów Set<RevCommit> za pomocą metody getrevcommitset, posiadającej 3 argumenty, 2 to uzyskane przez nas w poprzednim punkcie (wartości zwrócone przez getstartrevision i getendrevision), trzecim argumentem jest zaś config, klasy Properties, uzyskany przez nas w 1 punkcie. 7. Później tworzymy kolekcję rewizji Set<Revision>, za pomocą metody getrevisionset. Argumentem tej metody jest kolekcja commitów Set<RevCommit> z punktu Zapisujemy do obiektu ProjectHistory dane uzyskane wcześniej, za pomocą metody setrevisions(revisions), gdzie revisions to kolekcja Set<Revision> z punktu 7.

2 Założenie dodatkowe: Korzystamy z biblioteki Jgit, posiadającej klasy Git i RevCommit, które są przez nas wykorzystywane. Różnica między RevCommit, a Revision: Obie klasy opisują Commit, jednakże obiekty RevCommit to obiekty klasy pochodzącej z biblioteki Jgit, a Revision to obiekty klasy pochodzącej z tego projektu. W metodzie dodiff, mapujemy obiekt RevCommit na obiekt Revision. Alternatywny ciąg zdarzeń 1: Kiedy główny ciąg zdarzeń zostanie wykonany, użytkownik za pomocą GUI będzie mógł zobaczyć historię zmian w repozytorium. Ażeby to zrobić będzie musiał nacisnąc button dodany przez naszych kolegów do GUI, który wywoła za pomocą zdarzeń metodę dodiff napisanej przez nas klasy DiffService. Przycisk powinien być aktywny tylko wtedy, gdy zaznaczone będzie ściągnięte wcześniej istniejące repozytorium, którego zawartość będziemy chcieli przeglądnąć. Argumenty metody dodiff: obiekt klasy Git oraz obiekt klasy Repository niezbędny do połączenia się z repozytorium ( w sumie 2 różne argumenty ) kolekcja commitów Set<RevCommit> Metoda ta zwróci kolekcję rewizji Set<Revision>, którą za pomocą GUI wyświetlimy w kontrolce graficznej. Ciąg zdarzeń metody dodiff: 1. W pętli while sprawdzającej czy kolekcja Set<RevCommit> posiada następny element, sprawdzamy czy taki element występuje. Jeśli tak zapisujemy do obiektu String tekst, który uzyskamy za pomocą metody getdiff, posiadającej 2 argumenty, jeden to poprzedni element kolekcji Set<RevCommit>, a drugi to aktualny. 2. Później wywołujemy funkcję getrevision, posiadającą w argumencie Stringa uzyskanego w punkcie 1 oraz nasz aktualny element kolekcji Set<RevCommit>. Funkcja getrevision zwraca obiekt klasy Revision, który dodajemy do kolekcji Set<Revision>. 3. Metoda dodiff wykonuje się do momentu wystąpienia ostatniego elementu kolekcji Set<RevCommit> i metoda zwraca kolekcję Set<Revision>, której elementy powinniśmy wyświetlić w GUI.

3 Diagram klas: Diagramy sekwencji:

4 metoda fetchprojecthistory:

5 Metoda fetchrepository: Metoda dodiff, z klasy gitdiffservice.

6 Testy akceptacyjne: W poniższych testach zostały przetestowane akcje użytkownika, które są wykonywane przez użytkownika, gdy korzysta z zaimplementowanego przez nas przypadku użycia. W tabelach przedstawione są dane wejściowe. Które są konieczne do przetestowania danej aktywności, cyfra 1 oznacza pomyślne przejście testu, cyfra 0 oznacza negatywne przejście testu. FetchRepository, czyli przeglądanie repozytorium. repository config fetchrepository? null [repouri: repodir: /home/pawel/repo] 1 null [repouri: NULL; repodir: /home/pawel/repo] 0 null [repouri: repodir: /home]pawel\repo] 0 GetStartRevision, czyli pobieranie początkowej rewizji z repozytorium config getstartrevision? [repouri: repodir: /home/pawel/repo] 1 [repouri: NULL; repodir: /home/pawel/repo] 0 [repouri: repodir: /home]pawel\repo] 0 getendrevision, czyli pobieranie początkowej rewizji z repozytorium config getendrevision? [repouri: repodir: /home/pawel/repo] 1 [repouri: NULL; repodir: /home/pawel/repo] 0 [repouri: repodir: /home]pawel\repo] 0

7 setcommits, akcja, która pozwala dodać do listy commity, jeżeli istnieją config start end setcommits? [repouri: repodir: /home/pawel/repo] [pawelrak; :00:02; utf8] [pawelrak; :50:42; utf8] 1 [repouri: repodir: /home/pawel/repo] [pawelrak; :00:02; utf8] [pawelrak; :50:42; utf8] 0 [repouri: blednylink.cc; repodir: /home/pawel/repo] [pawelrak; :00:02; utf8] [pawelrak; :50:42; utf8] 0 getrevcommitset, akcja, która pozwala pobrać commity z repozytorium config start end getrevcommitset? [repouri: repodir: /home/pawel/repo] [pawelrak; :00:02; utf8] pawelrak; :50:42; utf8 1 [repouri: repodir: /home/pawel/repo] [pawelrak; :00:02; utf8] pawelrak; :50:42; utf8 0 [repouri: blednylink.cc; repodir: /home/pawel/repo] [pawelrak; :00:02; utf8] pawelrak; :50:42; utf8 0 getrevisionset, akcja, która pozwala pobrać przetworzyć zbiór revcommitów na zbiór obiektów repozytorium revset { [pawelrak; :00:02; utf8], [jkowalski; :10:06; utf8], [jkowalski; :10:06; utf8] } getrevisionset? 1 { [prak; :00:02; utf8], [jkowalski; :10:06; utf8] } 0 { [jkowalski; :10:06; utf8], [prak; :00:02; utf8], [jkowalski; :10:06; utf8] } 0 getrevision, akcja zwracająca rewizję z poczynionych zmian Rev diff tree getrevision? [pawelrak; :00:02; utf8] Binary files a/index.html diff --git a/index.html index b70c d4a /home/usr/repo/.git 1 [pawelrak; :00:02; utf8] Binary files a/index.html diff --git a/index.html index b70c d4a /home\usr/.svn 0 [pawelrak; :99:99; utf8] Binary files a/index.html diff --git a/index.html index b70c d4a /home/usr/repo/.git 0

8 dodiff, zapisywanie zmian w repozytorium repository commits dodiff? /home/usr/repo/.git { [pawelrak; :00:02; utf8], [jkowalski; :10:06; utf8], [jkowalski; :10:06; utf8] } 1 /home/usr/repo/.git { [pawelrak; :00:02; utf8], [jkowalski; :10:06; utf8], [jkowalski; :10:06; utf8] } 0 null { [pawelrak; :00:02; utf8], [jkowalski; :10:06; utf8], [jkowalski; :10:06; utf8] } 0