Uruchamianie usług z parametrami wywołania

Ostatnio podczas konfiguracji kontenera Dockera natrafiłem na problem z instalacją i uruchamianiem własnych usług Windows. Próbowałem między innymi zainstalować Remote Debugger, aby ułatwić sobie wykorzystanie kontenerów jako środowiska developerskiego. Niestety okazało się, że parametry wywołania (np. /noauth), które działają przy ręcznym uruchomieniu aplikacji nie są akceptowane.

W związku z wspomnianym problemem postanowiłem napisać mały program, który będzie działał jako usługa i umożliwiał uruchamianie aplikacji z dowolnymi parametrami. Przy okazji przypomniałem w jaki sposób się to robi. Szczegóły poniżej.

 

Program będzie miał za zadanie uruchamiać i zamykać aplikacje, które zostaną podane w jego pliku konfiguracyjnym.

Jak w przypadku każdego nowego projektu musimy go najpierw utworzyć. W MS Visual Studio tworzymy aplikację konsolową (Console Application).

Modyfikujemy plik Program.cs tak, by znajdująca się w nim klasa dziedziczyła po klasie ServiceBase. Wymagane będzie dodanie referencji do biblioteki System.ServiceProcess oraz dopisanie linijki:

Następnie dodajemy klasy, które będą tworzyły sekcję konfiguracyjną przechowującą listę programów z parametrami, przeznaczonymi do uruchomienia podczas startu naszej usługi:

  • ServiceEntry -> pojedynczy wpis w konfiguracji

  • ServiceEntryCollection -> kolekcja wpisów konfiguracyjnych

  • ServicesToRunSection -> sekcja konfiguracyjna

Po dodaniu zmodyfikujmy plik konfiguracyjny zgodnie ze schematem z klas.

Dodajemy informację o wykorzystywanej sekcji do pliku App.config do tagu <configSections>:

oraz samą sekcję:

Zakończyliśmy właśnie wstępną konfigurację aplikacji do uruchomienia.

Skoro mamy już konfigurację wrócimy teraz do samej usługi.

Otwieramy plik z klasą dziedziczącą po ServiceBase.

W konstruktorze ustawiamy nazwę usługi i jej inne parametry. Dodajemy także statyczną listę otwartych procesów.

Przeciążamy metody OnStart oraz OnStop.

W OnStart będziemy wczytywali z pliku konfiguracyjnego listę aplikacji do uruchomienia oraz je startowali.

OnStop wykorzystamy do zatrzymania uruchomionych procesów oraz posprzątania po sobie.

W metodzie Main wskazujemy, że chcemy uruchomić naszą klasę:

Pozostało nam tylko zainstalować nową usługę. Potrzebny będzie nam do tego instalator, czyli klasa dziedzicząca po klasie Installer. Aby wykorzystać ten instalator musimy go oznaczyć atrybutem [RunInstaller(true)].

 

Po skompilowaniu usługę instalujemy przy pomocy narzędzia InstallUtil.exe. Opis narzędzie i jego użycia znajdziecie pod poniższymi linkami:

Pełen kod znajdziecie po kliknięciu w odnośnik.

TFS – walidacja komentarzy do commitów gita

Ostatnio natrafiłem na ciekawy problem związany z obsługą gita przez Team Foundation Server. W związku z zapominaniem o  wpisywaniu numeru zadania z TFS chciałem to wymusić. Po zapytaniu Wujka Google okazało się, że o ile git sam w sobie wspiera walidację komentarzy do commitów, to TFS niestety takiej funkcjonalności nie udostępnia.

Nie pozostawało mi nic innego niż napisać własny plugin, który by na to pozwalał. W trakcie poszukiwań informacji na ten temat natrafiłem na post Karstena Kemple (link), który rozwiązywał problem dla TFS 2013. Podczas testów rozwiązania na maszynie wirtualnej wyszło na jaw, że tekst, który przypiszemy do parametru out string statusMessage nie zostaje przekazany do klienta gita, który wysyłał kod na serwer. Powodowało to, że użytkownik niestety nie otrzymywał dokładnej informacji zwrotnej czemu jego commit zostawał odrzucony przez zdalną maszynę.

Postanowiłem, więc zaktualizować TFS do wersji 2015 Update 3 aby sprawdzić zachowanie pluginu. Po podmianie bibliotek podanych przez Karstena na nowsze okazało się, że zmieniła się definicja metody ProcessEvent interfejsu ISubscriber. W związku z tym czekało mnie napisanie pluginu właściwie od nowa. Poniżej przedstawiam ten proces.

1. Utwórz nowy projekt typu Class Library

 

2. Następnie dodaj do niego następujace biblioteki

 

3. Dodaj klasę, która implementuje interfejs ISubscriber

Deklaracja:

  • Name – nazwa subskrybenta, powinna być unikatowa
  • Priority – priorytet wykonania
  • SubscribedTypes – typy powiadomień, które subskrybent ma obsługiwać
  • ProcessEvent – metoda wywoływana gdy obsługiwane powiadomienie jest publikowane

4. Zaimplementuj metodę ProcessEvent

5. Gdy commit nie spełni wymagań walidacji zwróć EventNotificationStatus.ActionDenied

Jeśli przypiszesz do pola statusMessage jakiś tekst, zostanie on wyświetlony użytkownikowi, który wrzuca kod na zdalne repozytorium

6. Aby zainstalować plugin skopiuj plik .dll będący wynikiem kompilacji projektu do katalogu (katalog główny serwera TFS)\Application Tier\Web Services\bin\Plugins 

TFS powinien wykryć skopiowaną dllkę i automatycznie ją wczytać, ale dla pewności możesz zrestartować pulę aplikacji do niego przypisaną, ewentualnie cały serwer IIS.