TIE Ohjelmistojen suunnittelu

Transkriptio

1 TIE Ohjelmistojen suunnittelu Luento 3: Git & Gitlab Samuel Lahtinen 1

2 Ajankohtaista Harkkatyöhön ilmoittautumisdedis tänään Git ja ryhmäkutsut Versiohallinnan kutsut lähdössä matkaan huomenna

3 Ohjelmassa tänään Git ja jotain komennoista jne. Haarat ja niiden käyttö Gitlab Erilaisia tapoja käyttää versiohallintaa (haarat jne.)

4 Versiohallinnan käytöstä

5 Versiohallinta vs. Dropbox jne. Monet työkalut sisältävät sisäisesti versiohallinan kaltaista toimintaa (esim Word) Esim Dropbox toimii osin versiohallinnan tapaan, tekee uusia versioita, mahdollisuus palata vanhaankin Samanaikaisen tiedoston muokkailun sallivat työkalut (Google Docs, Overleaf, jne.)

6 Paikallinen versiohallinta Versiohallintatietokanta samalla koneella, muokattavana uusin versio tiedostosta, mahdollisuus palata vanhempiin jne. checkout tiedosto tietokone versiohallintatietokanta Versio 3 Versio 2 Versio 1

7 Keskitetty versiohallinta Kuten SVN, versiohallintapalvelin, josta käyttäjät noutavat koneelleen (uusimman) version Commitin jälkeen palvelimella uusin versio, jos palvelin katoaa, jäljelle jää käyttäjiltä löytyvät versio, ei versiohistoriaa tms. Tietokone, käyttäjä 2 commit Tiedostot checkout palvelin versiohallintatietokanta Versio 3 Versio 2 Versio 1 Tietokone, käyttäjä 1 checkout Tiedostot

8 Hajautettu versiohallinta Distributed Version Control System, esim. Bazaar, Git, Mercurial Koko versiohallintatietokannan peilaaminen, ei pelkästään tietyn version hakeminen, tiedon palautus Mahdollisuus käyttää yhdistää eri palvelimia tiedosto Tietokone A versiohallintatietokanta Versio 3 Versio 2 Versio 1 palvelin versiohallintatietokanta Versio 3 Versio 2 Versio 1 Tietokone B versiohallintatietokanta tiedosto Versio 3 Versio 2 Versio 1

9 Harkkatyön kanssa: Gitlab ja repot

10 Git yleisesti Ei tallenna tiedostojen eroja, vaan aina snapshotin tiedostotoista, uudet versiot tai muuttumattomissa linkki edelliseen Lähes kaikki toiminnot ovat lokaaleja, historia jne. löytyy paikallisesti ilman verkkoyhteyttä Yleisin versiohallintaohjelmisto

11 Git ja peruskomennot Add, lisätään tiedosto Log, revisiohistoria Rm, poistetaan tiedosto Commit, muutosten vieminen eteenpäin Revert, undo muutoksille Checkout, tietyn haaran ottaminen työhaaraksi tai tietyn version hakeminen historiasta (git checkout revision_id) Branch, haaran luominen (työhaarasta) branch d, poistaa haaran Merge, yhdistetään nykyiseen haaraan annettu haara

12 Git ja peruskomennot Clone, kopioi olemassa olevan repon, tämän tekeminen kurssilla aivan alkuun saatte kopioitua itsellenne ryhmänne repositoryn (osoite Gitlabista) Push, työnnetään nykyisen työhaaran (commitoitu) tilanne palvelimelle (kurssilla gitlab.rd.tut.fi ) Fetch, haetaan toisesta repositoriosta tavaraa Pull, fetch + merge nykyiselle työhaaralle, clonen jälkeen tekee automaattisesti clone-osoitteesta pull rebase, hae uusimmat palvelimelta, tee rebase (lokaalisti) Remote, yhteistyön määrittelyä ja kyselyä origin, paikka mistä kloonattu remote v, lista osoitteista ja lyhenteistä remote a shortname url, lisätään uusi osoite (esim. git a test a.test.fi) git fetch shortname, saadaan haettua kyseinen repo (esim. tietyn käyttäjän)

13 Git ja haarat Haarat, päähaara master, muut haarat, branches Mihin voidaan käyttää? Bugikorjaukset Uusien ominaisuuksien toteuttaminen, yleinen tapa, uusi ominaisuus, uusi feature branch. Kun homma on toteutettu loppuun ja testattu, merge masterin kanssa (tai jonkun versiohaaran kanssa) Tietty versio ulos, tämän jälkeen tarvittavat päivitykset tämän haaran alle tai siitä lisähaarauttamalla

14 Esimerkki versiohallinan käytöstä teollisuudessa (feature-haara, jossa refaktorointeja) Created branch 'feature/lpk- 174_cookie-sessionstore Use encrypted cookie as the cookie store Refactored hashbang to use pure ring session Move session key from JSON to response level Moved session handling logic to sade.session Session ID must be generated manually Handle nil response correctly Refactored hashbang to use pure ring session Merge with develop Load current user data from db Read session id from session data web/sessionid was only logged redundantly Pass session to actions Renamed logging context key Moved user from noir session to pure ring session company info is needed in session fixed impersonation special case for oir-authority user Load current user attachment list from db architect flag is needed in a pre-check Merge with develop impersonator is also a virtual user Drop person id from public data No default key Check user data expiration at authorization middleware Merge with develop Set user data ttl to 5 minutes exclude virtual users Separated start function, added stop function Read session encryption key from file Added endpoint for restarting Jetty Set graceful shutdown timeout to 10 seconds Allow access only from localhost Merge with develop Added script for deploying keys Legend: Major refactoring Refactoring within feature dev reload api Reconnect to MongoDB Feture branch Creation / closing flow: Closed <feature> 'LPK- 174_cookie-sessionstore' Merge with dev. branch Review request flag flow: Merged <feature> 'LPK-174_cookie-sessionstore' to <develop> ('develop')

15 Esimerkki haarasta Alkutilanne: Issue tracker, issue 53 työn alle $ git checkout -b iss53 Switched to a new branch "iss53" Tai kahden komennon kera: $ git branch iss53 $ git checkout iss53

16 Jatkokehitystä Alkutilanne: Issue tracker, issue 53 työn alle git commit -a -m 'lisättiin puolustuskyky uudelle hahmotyypille'

17 Kriittinen bugikorjauspyyntö Alkutilanne: Palataan takaisin master-haaran tilanteeseen, luodaan sen pohjalta uusi haara hotfix, muokkaillaan ja commit $ git checkout master Switched to branch 'master' $ git checkout -b hotfix Switched to a new branch 'hotfix' $ git commit -a -m 'fixed the broken address' [hotfix 1fb7853] fixed the broken address 1 file changed, 2 insertions(+)

18 Bugikorjaus mukaan masteriin Alkutilanne: Hotfix toimii testien perusteella, hyvä homma, korjaus masteriin $ git checkout master $ git merge hotfix Hotfix-haara tehnyt tehtävänsä, voidaan poistaa $ git branch -d hotfix

19 Palataan kehittämään issue 53:a $ git checkout iss53 Switched to branch "iss53" $ vim index.html $ git commit -a -m 'uusi taistelija valmis [issue 53]'

20 Liitetään työn tulos päähaaraan $ git checkout master Switched to branch 'master' $ git merge iss53 Merge made by the 'recursive' strategy.

21 Konflikteja? $ git merge iss53 Auto-merging kokopelisamassatiedostossa.cc CONFLICT (content): Merge conflict in kokopelisamassatiedostossa.cc $ git status On branch master You have unmerged paths. (fix conflicts and run "git commit") Unmerged paths: (use "git add <file>..." to mark resolution) both modified: kokopelisamassatiedostossa.cc no changes added to commit (use "git add" and/or "git commit -a") $ git mergetool

22 Rebase ja haarat Mergen avulla $ git checkout experiment $ git rebase master First, rewinding head to replay your work on top of it... Applying: added staged command $ git checkout master $ git merge experiment

23 Rebase ja update haluan, että omat muutokseni pistetään muiden tekemien muutosten päälle git pull --rebase origin master Origin/master Local master Local master (after rebase)

24 Gitlab? Git version control, versiohallinta Issue tracker, tikettien hallintaa Code snippets, jako versiohallinnan ulkopuolelle Yksinkertainen wiki Merge Requests, pyyntöjä, joilla voidaan pyytää henkilöä tekemään kahden haarojen yhditäminen (esim. Feature-haara päädevaushaaraan)

25 Pull & merge requests Pull request, yleinen tapa kommunikoida ja varmentaa ohjelman uusia osia, ominaisuuksia jne. Koodari saa homman valmiiksi, pull/merge request, työkaverit/intergraatiovastaava käy kurkaamassa koodin Tämän jälkeen masteriin merge Pull request, onko kunnossa Oon jämähtänyt, voiko joku jeesata Fork ja siellä puuhastelu Ei tarvi välttämättä Gitlabin työkalua, kevytversiona esim. Slack tai IRC ja siellä huutelu

26 Työkaluja Perussetti: Git asiakasohjelmia, Graafista tiedostojen hallintaan integroitua Windowsille: Linux, Windows, Mac ja graafinen: Komentorivi (Linux, Lintulan git), Windowsille vastaava: SSH-avaimet ja niiden tuottaminen:

27 Erilaisia työskentelytapoja Kaikki masteriin Sopimukset, remoteen puskettava kama ei saa rikkoa mitään Vain testattua, toimivaa koodia Esim. Uudet commit masteriin, liittyy joko ominaisuuteen (feature) tai bugipäivitykseen Commitit ja tyypittäminen, bugikorjaus, feature, refaktorointi, jne. Pieniä inkrementtejä, työ ei voi olla auki pitkään (yhteistyö haastavaa) Masterin koodi usein rikki Feature branch workflow, ominaisuuspohjainen Kaikki tiettyyn ominaisuuteen liittyvä työ samassa haarassa, yhteistyö, samaan ominaisuuteen liittyvän työn jakaminen Master aina ehjänä Pull requestien käyttö kommunikaatiossa, oon saanut valmiiksi, tarkastakaa, oon jämähtänyt, jne. (pull request, review, merge to main)

28 Feature branch workflow Uusien ominaisuuksien/asioiden kehittämiseen liittyvä Kaikki tiettyyn ominaisuuteen liittyvä työ samassa haarassa, yhteistyö, samaan ominaisuuteen liittyvän työn jakaminen Master aina ehjänä Pull/merge requestien käyttö kommunikaatiossa, oon saanut valmiiksi, tarkastakaa, oon jämähtänyt, jne. (pull request, review, merge to main)

29 Gitflow Projektien julkaisut tärkeässä roolissa, isompiin projekteihin toimiva Featuret liittyvät devaushaaraan, masterissa vain julkaisuversiot Erilliset release-haarat (dedis tai tarpeeksi ominaisuuksia), valmistuessaan masteriin uutena version & dev-haaraan merge mahdollista tehdä samaan aikaan jatkokehitystä ja julkaisun valmistelua

30 GitLab Flow / Github flow Yksinkertaistusta GitFlowsta Masteriin menevät featuret valmiita tuotantoon, eli feature branch merge suoraan käyttöön Continuous deliveryt sun muut käytössä Oikealla, useita eri ympäristöjä, pre-productionin kautta productioniin

31 Forking workflow Yhden serveripuolen repon sijaan jokaisella oma serveripuolen repo Erillinen projektin hallinnoija hyväksyy ja tekee yhdistämiset viralliseen repositoryyn, joka sitten on muiden saatavilla (kloonattavissa ja synkronoitavissa) Erityisen toimiva nopeasti muuttuvien ryhmien kanssa, open source projektit ja enemmän tai vähemmän luotettavat devaajat Kaikki voivat työntää tuotoksiaan muiden saataville, pull request, tarkistaminen, hallinnoija vastaa hyväksynnästä

32 Dictator and Lieutenants workflow Iiisoihin projekteihin, joissa hierarkiaa & paljon tekijöitä Yksi virallinen repo, josta uusin virallinen versio (blessed) Devaajat tekevät töitä tietyn alueen parissa, näillä oma luutnantti joka vastaa tästä vastuualueesta, tekevät omaan masteriinsa yhditelyn, integraatiomanagerina näille luutnanteille diktaattori, joka vastaa blessed reposta, tekee merget siihen suuntaan Blessed referenssinä kehittäjille, (kehittäjät rebase blessedistä aina kun päivittyy) Kevyempi yleinen versio, integration manager workflow

33 Suosituksia Sopikaa yhtenäinen tapa käyttää gittiä, jonkinlainen workflow, jotain periaatteita jne. Rebase ennen pushia Pull requests ja niiden hyödyntäminen, kommunikointi ja varmistus

34 Aloittaminen Gitlabiin sisään, siellä repositoryn URL selville SSH-avaimen luominen ohjeiden avulla Sen jälkeen komentorivillä kloonaus Kokeile kaikenlaista paikallisesti, (add, commit, branch, merge ) Kokeile tunkea oma testihaara muiden saataville jne.

35 Asetuksia Editorin vaihtaminen toiseksi (Windows, jos on vim-allergia), esimerkkinä Notepad++ Notepad++ avautumaan gitbashissä, lisätään asennushakemisto pathiin Git ja editorin asettaminen (vaihda notepad++:n tilalle oma suosikkisi) git config --global core.editor \ "'C:/Program Files (x86)/notepad++/notepad++.exe' -multiinst -notabbar -nosession -noplugin Linux jne. Asenna mieliohjelma ja käytä, git configilla editorin vaihtaminen onnistuu

36 Yhteenveto Opittiin gitin peruskomentoja ja ideaa haarojen käytöstä jne. Opittiin hieman erilaisista versiohallinnan käyttötavoista (workflowt) Myöhemin kurssilla vähän lisää asiaa koodista ajoon tyyppisestä asiasta Osoiteita: Materiaalia & ohjeistusta: