Diferență între revizuiri ale paginii „PC Laborator 2.1 (opțional)”

De la WikiLabs
Jump to navigationJump to search
 
(Nu s-au afișat 181 de versiuni intermediare efectuate de același utilizator)
Linia 1: Linia 1:
 
= Obiective =
 
= Obiective =
  
În urma parcurgerii acestui laborator studentul va fi capabil:
+
* definirea noțiunii de Version Control System;
* să înțeleagă funcționalitatea preprocesorului și să folosească directive de preprocesare;
+
* utilizarea unui sistem de Version Control: [https://git-scm.com/ Git].
* să utilizeze stream-urile standard ale unui proces în Linux și în programe C;
 
* să utilizeze funcționalitatea de bază a unui sistem de revision control - Git.
 
  
= Preprocesorul C =
+
= Sisteme de control al versiunii =
  
Preprocesarea unui fișier cu cod C este prima etapă din lanțul de ''build'', și reprezintă, așa cum îi spune și numele, o etapă de dinainte de procesarea (compilarea) efectivă. Motivul pentru care se realizează această etapă inițială este faptul că prin preprocesarea codului se pot elimina secțiuni din program care ori nu sunt necesare, ori nu sunt compilabile pe un anumit procesor sau sistem de operare. Spre exemplu, pentru a folosi o interfață serială, în sistemul de operare Windows, și compilatorul Visual Studio, există un tip de date care se numește <code style="color: green">HANDLE</code>. Acest tip de date nu există în Linux, aici fiind înlocuit simplu cu <code style="color: green">int</code>. În acest caz, compilarea unui program care folosește <code style="color: green">HANDLE</code> pe Linux va eșua cu eroare. Aici intervin directivele de preprocesare, după cum vom vedea în continuare.
+
Gândiți-vă la următorul scenariu: lucrați la un proiect într-un limbaj de programare sau de descriere hardware; acest proiect este mare și nu poate fi terminat într-o zi, prin urmare vă faceți timp și lucrați cate o oră în fiecare zi. Apar următoarele situații:
 +
* peste două săptămâni vă dați seama că unele lucruri pe care le-ați adăugat în program nu sunt necesare, deci ați vrea să vă întoarceți la o versiune mai veche - este nevoie de un sistem care să țină o istorie a modificărilor și să permită oricând întoarcerea la o versiune anterioară;
 +
* proiectul e pe echipe, deci la el lucrează trei persoane; fiecare editează unul sau mai multe fișiere, fiind posibil ca doi membri ai echipei să editeze același fișier - e nevoie de un sistem care să poată să centralizeze modificările și să trateze situația în care același fișier e modificat de doi ingineri;
 +
* unul din membrii echipei găsește o problemă și dorește să vadă cine și ce a modificat în zona respectivă de cod și care a fost scopul modificării - este deci nevoie de un sistem care să permită documentarea fiecărei modificări pe perioada dezvoltării proiectului și vizualizarea acestor modificări;
 +
* după documentare, tester-ul dorește să poată nota problema, atribuind-o unui membru al echipei pentru rezolvare - este nevoie de un sistem care să permită înregistrarea și documentarea erorilor în scopul rezolvării;
  
În acest laborator se va discuta despre:
+
Toate aceste cerințe sunt adresate de sistemele de [https://en.wikipedia.org/wiki/Version_contro control al versiunii], acestea pot:
* <code style="color: green">#include</code>
+
* ține evidența modificărilor și permite întoarcerea la o versiune mai veche;
* <code style="color: green">#define</code>
+
* permite ramificarea dezvoltării în mai multe direcții și unificarea ulterioară a acestor ramuri;
* <code style="color: green">#undef</code>
+
* sincroniza modificările fiecărui utilizator cu un depozit central pentru a putea fi accesate de ceilalți membri ai proiectului;
* <code style="color: green">#ifdef</code>
 
* <code style="color: green">#ifndef</code>
 
* <code style="color: green">#else</code>
 
* <code style="color: green">#endif</code>
 
  
== Directiva <code style="color: green">#include</code> ==
+
Există [https://en.wikipedia.org/wiki/List_of_version_control_software mai multe sisteme] de control al versiunii:
 +
* Pe model client - server:
 +
** Concurrent Versions System (CVS) - open Source
 +
** Subversion (SVN) - open source
 +
** Perforce – nu este open source, dar poate fi folosit gratis în proiecte open-source
 +
* Pe model distribuit:
 +
** Git - creat de Linus Torvalds pentru dezvoltarea kernel-ului de Linux - open source
 +
** BitKeeper – folosit pentru dezvoltarea kernel-ului de Linux între 2002 și aprilie 2005.
  
Probabil #include este cea mai frecvent utilizată directivă de preprocesare, dar și cea mai ușor de înțeles. Efectiv, preprocesorul caută fișierul specificat între paranteze unghiulare sau ghilimele în lista de directoare dintr-o listă cunoscută și apoi înlocuiește directiva #include cu conținutul fișierului respectiv.
+
În continuare vom prezenta conceptele cele mai importante și funcționarea sistemului Git.
  
=== Exemplu ===
+
= [https://www.atlassian.com/git/tutorials/ Git] =
  
* Scrieți un fișier nou într-un editor de text care să conțină următorul cod:
+
Git este un sistem de control de versiune distribuit. Asta înseamnă că poate fi folosit de către un utilizator fără a fi conectat la un depozit central, copia locală de pe calculatorul utilizatorului ținând în baza ei de date toate informațiile legate de conținutul curent și de modificările anterioare.
<syntaxhighlight lang="C">
+
 
int main(){
+
  Odată instalat Git, fiecare utilizator trebuie să-și configureze adresa de e-mail și numele:
    return 0;
+
  <syntaxhighlight lang="bash">
}
+
  git config --global user.name "Ion Vasile"
 +
  git config --global user.email ion.vasile@gmail.com
 +
  </syntaxhighlight>
 +
 
 +
== Git - ''repository'' local ==
 +
 
 +
Fiecare proiect este stocat în Git într-un "depozit" numit ''repository''.
 +
 
 +
Un repository se crează cu comanda <code style="color: green">git init</code>.
 +
 
 +
Odată un ''repository'' creat, se pot adăuga apoi șterge sau modifica fișiere. Aceste modificări se adaugă în repository prin operații specifice inițiate de utilizator, numite ''commit''.
 +
 
 +
Starea curentă a repository-ului se poate vedea în orice moment cu comanda <code style="color: green">git status</code>.
 +
 
 +
=== Pregătirea unui nou commit - ''staged files'' ===
 +
 
 +
Un nou ''commit'' se pregătește selectând fișierele dorite și punându-le într-o stare numită "staged for commit" adică pregătite pentru ''commit''. Fișierele care pot fi pregătite pentru ''commit'' sunt:
 +
* fișiere noi, care vor fi adăugate în repository - prin comanda <code style="color: green">git add ''fișier''</code>;
 +
* fișiere existente în repository, dar care au fost modificate - prin comanda <code style="color: green">git add ''fișier''</code>;
 +
* fișiere existente care se vor șterge din repository - prin comanda <code style="color: green">git rm ''fișier''</code>;
 +
* fișiere care există în repository, dar iși schimbă locația - prin comanda <code style="color: green">git mv ''fișier_sursă'' ''fișier_destinație''</code>;
 +
 
 +
Mai multe fișiere pot fi pregătite pentru un ''commit'', apoi toate odată se actualizează într-un singur ''commit''.
 +
 
 +
Un fișier pregătit pentru ''commit'' se poate șterge din lista de fișiere pregătite, păstrând modificările, cu comanda <code style="color: green">git reset ''fișier''</code>
 +
 
 +
=== Adăugarea de fișiere în repository - ''commit'' ===
 +
 
 +
Fiecare nou ''commit'', care poate conține modificări pentru unul sau mai multe fișiere, se adaugă întotdeauna peste ultimul ''commit'', și conține informații despre:
 +
* utilizatorul care făcut modificările;
 +
* data și ora când s-au realizat modificările respective;
 +
* mesajul adăugat de utilizator în momentul ''commit''-ului;
 +
* un număr de identificare, generat din celelalte informații;
 +
* modificările efective.
 +
 
 +
Un ''commit'' nou se realizează cu comanda <code style="color: green">git commit -m "mesaj"</code>.
 +
 
 +
Ultimul ''commit'' se numește HEAD. Orice nou commit se poate pune doar peste HEAD-ul curent și va deveni noul HEAD.
 +
 
 +
[[Fișier:git_commit_stack.svg]]
 +
 
 +
Un fișier modificat dar care nu este pregătit pentru ''commit'', poate fi readus în stadiul din HEAD prin comanda <code style="color: green">git checkout ''fișier''</code>
 +
 
 +
=== Revenire la versiuni anterioare - ''detached state'' ===
 +
 
 +
Lista ''commit''-urilor existente se poate inspecta folosind comanda <code style="color: green">git log</code>.
 +
 
 +
Dacă se dorește revenirea la un commit anterior, acest lucru se poate face în trei feluri, specificând ID-ul commit-ului la care se dorește revenirea:
 +
* revenire fără pierderea ''commit''-urilor ulterioare; în acest caz, starea devine ''detached'' și se creează automat o ramură nouă de dezvoltare (branch) - prin comanda <code style="color: green">git checkout ''commit_id''</code>
 +
* revenire cu pierderea ''commit''-urilor ulterioare dar fără pierderea modificărilor fișierelor; în acest caz, ''commit''-ul la care se revine devine HEAD - prin comanda <code style="color: green">git reset ''commit_id''</code>
 +
* revenire cu pierderea ''commit''-urilor ulterioare și a modificărilor fișierelor; și în acest caz, ''commit''-ul la care se revine devine HEAD - - prin comanda <code style="color: green">git reset --hard ''commit_id''</code>
 +
 
 +
În '''detached state''' nu se șterge nimic din repository, iar ''commit''-urile noi se adaugă branch-ului nou creat temporar. Pentru a reveni din '''detached state''', trebuie revenit la ramura principală de dezvoltare.
 +
 
 +
[[Fișier:git_detached_state.svg|none|frame|Revenire fără pierdere de ''commit''-uri - '''detached state''']]
 +
 
 +
[[Fișier:git_reset.svg|none|frame|Revenire cu pierdere de ''commit''-uri]]
 +
 
 +
=== Ramuri de dezvoltare - ''branch'' ===
 +
 
 +
Ramurile de dezvoltare (branches) sunt o componentă foarte importantă a sistemelor de control al versiunii care permit dezvoltarea simultană a mai multor ''feature''-uri sau componente pentru același sistem, precum și posibilitatea de a avea în lucru mai multe versiuni ale aceleiași aplicații. Ideea de '''branch''' este aceea că dintr-un anumit punct al dezvoltării programului (adică de la un '''commit'''), stiva de ''commit''-uri se poate ramifica și apoi direcțiile de dezvoltare vor diverge:
 +
 
 +
[[Fișier:branches.svg|none|frame|Schema bloc a unui ''repository'' cu două ''branch''-uri]]
 +
 
 +
''Branch''-ul implicit care se creează inițial se numește '''master'''.
 +
 
 +
Pentru a vedea lista ''branch''-urilor dintr-un ''repository'' (inclusiv care este cel curent), se folosește comanda <code style="color: green">git branch</code>.
 +
 
 +
Pentru a crea un nou ''branch'', se folosește comanda <code style="color: green">git branch ''nume_branch_nou''</code>.
 +
 
 +
Pentru a schimba ''branch''-ul curent, se folosește comanda <code style="color: green">git checkout ''nume_branch''</code>.
 +
 
 +
Pentru a șterge un ''branch'', se folosește comanda <code style="color: green">git branch -d ''nume_branch''</code>.
 +
<div class="regula">În anumite situații, dacă ''branch''-ul conține modificări care nu au fost portate pe ''branch''-ul părinte, veți primi o eroare. În acest caz, se poate șterge forțat un ''branch'' cu comanda <code style="color: green">git branch -D ''nume_branch''</code>. Atenție, nu puteți șterge ''branch''-ul curent.</div>
 +
 
 +
=== ''Merges'' și rezolvarea conflictelor ===
 +
 
 +
Dacă un ''branch'' a fost utilizat pentru dezvoltarea unei componente a unui sistem, modificările din acest ''branch'' trebui aduse înapoi (merged) pe ''branch''-ul părinte.
 +
 
 +
[[Fișier:merge.svg|none|frame|''Merge'' între un ''branch'' oarecare și '''master'''.]]
 +
 
 +
Pentru a realiza o operație de ''merge'' se folosește comanda <code style="color: green">git merge ''branch_modificari'' -m "Mesaj pentru commit."</code>.
 +
 
 +
Înainte de a face o operație de ''merge'', ''branch''-ul curent trebuie să fie acela unde se doresc aduse modificările. Pentru schema de mai sus, secvența corectă de comenzi ar fi:
 +
<syntaxhighlight lang="bash">
 +
git checkout master
 +
git merge branch_pentru_scriere_in_fisier -m "Am facut merge la functionalitatea de scriere in fisier"
 
</syntaxhighlight>
 
</syntaxhighlight>
* Salvați fișierul cu numele <code style="color: blue">test_preprocessor.c</code> în directorul <code style="color: blue">~/work/''prenume_nume''</code>
 
* Scrieți un fișier <code style="color: blue">Makefile</code> cu o singură rețetă care să producă un fișier numit <code style="color: blue">processed.c</code> din fișierul de mai sus, apelând compilatorul C (gcc) cu fanionul corespunzător pentru a face doar preprocesare (vezi [[PC Laborator 1#Generarea fișierului executabil|PC Laborator 1]]).
 
* Ce diferențe există între fișierul original și fișierul preprocesat?
 
* Scrieți un nou fișier numit <code style="color: blue">header_file.h</code>, care să conțină următorul text:
 
<syntaxhighlight lang="C">
 
// This is the start of the header file
 
int variable;
 
// This is the end of the header file
 
</syntaxhighlight>
 
* Modificați fișierul <code style="color: blue">test_preprocesor.c</code> prin înserția pe prima linie a unei directive '''include''':
 
<syntaxhighlight lang="C">
 
#include "header_file.h"
 
int main(){
 
    return 0;
 
}
 
</syntaxhighlight>
 
* Rulați din nou comanda <code style="color: green">make</code>. Observați mesajul de eroare: fișierul <code style="color: blue">header_file.h</code> nu este găsit de preprocesor, cu toate că este în directorul curent.
 
<div class="regula">'''<font color="red">Atenție:</font>''' Fișierele antet (header) sunt căutate doar în anumite căi predefinite în compilator (de exemplu <code style="color: blue">/usr/include</code>). Pentru a face preprocesorul să caute și în alte directoare, calea până la acestea trebuie specificată la compilare, folosind fanionul <code style="color: green">-I</code></div>
 
* Adăugați comenzii de compilare din <code style="color: blue">Makefile</code> următorul fanion: <code style="color: green">-I.</code> Asta va spune compilatorului (care mai departe va spune preprocesorului) să caută fișiere antet și în directorul curent (.)
 
* Rulați din nou comanda <code style="color: green">make</code>.
 
* Afișați conținutul celor două fișiere C. Ce diferențe observați?
 
  
== Directivele <code style="color: green">#define</code> și <code style="color: green">#undef</code> ==
+
Dacă modificările de pe branch-ul componentei sunt complet disjuncte față de modificările de pe branch-ul sistemului, atunci operația de ''merge'' se poate face automat. Dacă în schimb aceleași fișiere au fost modificate pe aceleași linii, atunci fișierele respective se marchează ca fiind în conflict, operația de ''merge'' se oprește, iar utilizatorul trebuie să rezolve conflictele editând fișierele cu probleme, în care va găsi marcate variantele din cele două branch-uri. După ce fișierele sunt salvate cu modificările dorite, acestea trebuie pregătite pentru ''commit'', iar apoi trebuie realizat ''commit''-ul care va aduce modificările pe branch-ul curent.
 +
 
 +
=== Exemple ===
 +
 
 +
* Prima oară după instalarea Git, trebuie configurat numele și adresa de e-mail a utilizatorului:
 +
  '''<span style="color: green">student@pracsis01</span> <span style="color: blue">~ $</span> git config --global user.name "Ion Vasile"'''
 +
  '''<span style="color: green">student@pracsis01</span> <span style="color: blue">~ $</span> git config --global user.email ion.vasile@gmail.com'''
 +
 
 +
* Creați un director numit <code style="color: blue">gitroot</code> în directorul personal al userului '''student'''.
 +
* În directorul <code style="color: blue">gitroot</code> creați un alt director numit <code style="color: blue">pc_lab</code>.
 +
* În directorul <code style="color: blue">~/gitroot/pc_lab</code> inițializați un repository '''Git''':
 +
  '''<span style="color: green">student@pracsis01</span> <span style="color: blue">~/gitroot/pc_lab $</span> git init'''
 +
  Initialized empty Git repository in /home/student/gitroot/pc_lab/.git/
 +
* În directorul <code style="color: blue">~/gitroot/pc_lab</code> creați un fișier text numit <code style="color: blue">README.md</code> care să conțină:
 +
Acesta este primul meu repository Git
 +
=====================================
 +
* Pregătiți fișierul pentru ''commit'':
 +
  '''<span style="color: green">student@pracsis01</span> <span style="color: blue">~/gitroot/pc_lab $</span> git add README.md'''
 +
  '''<span style="color: green">student@pracsis01</span> <span style="color: blue">~/gitroot/pc_lab $</span> '''
 +
* Vizualizați starea curentă a ''repository''-ului:
 +
  '''<span style="color: green">student@pracsis01</span> <span style="color: blue">~/gitroot/pc_lab $</span> git status'''
 +
    On branch master
 +
   
 +
    Initial commit
 +
   
 +
    Changes to be committed:
 +
      (use "git rm --cached <file>..." to unstage)
 +
   
 +
            new file:  README.md
 +
* Realizați primul ''commit'':
 +
  '''<span style="color: green">student@pracsis01</span> <span style="color: blue">~/gitroot/pc_lab $</span> git commit -m "Primul commit - fisierul README.md"'''
 +
  [master (root-commit) 75f2cfb] Primul commit - fisierul README.md
 +
    1 file changed, 0 insertions(+), 0 deletions(-)
 +
    create mode 100644 README.md
 +
* Vizualizați din nou starea curentă a ''repository''-ului.
 +
* Vizualizați lista ultimelor ''commit''-uri.
 +
  '''<span style="color: green">student@pracsis01</span> <span style="color: blue">~/gitroot/pc_lab $</span> git log'''
 +
  ...
 +
 
 +
* Creați in directorul <code style="color: blue">~/gitroot/pc_lab</code> un director numit <code style="color: blue">lab2</code>. În acest director creați un fișier cod sursă C care să afișeze pe ecran textul "Hello Git!". Creați și un Makefile care să compileze sursa C și să genereze un executabil.
 +
* Pregătiți cele două fișiere pentru ''commit''.
 +
* Realizați al doilea ''commit'' cu mesajul "Am adaugat fisierele sursa pentru laboratorul 2.".
 +
* Vizualizați lista ultimelor ''commit''-uri.
 +
* Identificați ID-ul primului ''commit''. Întoarceți-vă la starea de după primul commit (atenție, ID-ul de mai jos este doar un exemplu):
 +
  '''<span style="color: green">student@pracsis01</span> <span style="color: blue">~/gitroot/pc_lab $</span> git checkout 75f2cfb'''
 +
 
 +
* Vizualizați conținutul directorului curent.
 +
* Vizualizați starea curentă a ''repository''-ului.
 +
* Vizualizați ''branch''-ul curent.
 +
* Reveniți la HEAD pe ''branch''-ul master.
 +
* Creați un ''branch'' nou numit '''lab2'''.
 +
* Fiind în continuare pe '''master''', editați fișierul sursă C astfel încât să afișeze "Hello Master!".
 +
* Faceți ''commit'' la noua modificare.
 +
* Mutați-vă pe ''branch''-ul '''lab2'''.
 +
* Vizualizați conținutul fișierului sursă C.
 +
* Editați fișierul sursă C astfel încât să afișeze "Hello new branch!".
 +
* Faceți ''commit'' la noua modificare.
 +
* Mutați-vă pe ''branch''-ul '''master'''.
 +
* Vizualizați conținutul fișierului C.
 +
* Faceți '''merge''' ''branch''-ului '''lab2'''.
 +
* Observați mesajul de eroare. Rezolvați conflictul și finalizați operația de ''merge''.
 +
 
 +
== Git Remote ==
 +
 
 +
Puterea platformei Git nu vine doar din faptul că se poate folosi ''offline'' de către un utilziator, pe propriul calculator, dar și pentru că oferă posibilitatea de a sincroniza ''repository''-uri pentru același proiect. În fiecare ''repository'' se poate defini un număr de adrese URL pentru alte ''repository''-uri, aceste adrese se numesc <code style="color: green">remote</code>.
 +
 
 +
Pentru a vedea lista de adrese ''remote'' configurate pentru un ''repository'', se folosește comanda  <code style="color: green">git remote -v</code>.
 +
 
 +
Cu toate că Git nu are nici o restricție legată de modul de organizare a acestor ''repository''-uri (adică oricare două se pot sincroniza între ele, făcând Git un sistem cu adevărat distribuit), modelul cel mai des întâlnit este acela de a avea un ''repository'' central, pe un server accesibil global, iar fiecare programator/ membru al echipei se sincronizează cu acest server central, care se numește popular '''origin'''.
 +
 
 +
[[Fișier:remote.svg]]
 +
 
 +
Pentru a adăuga un ''remote'' pentru un ''repository'', se folosește comanda <code style="color: green">git remote add ''nume_remote'' ''url_remote''</code>, unde numele este în general (dar nu obligatoriu) '''origin'''.
 +
 
 +
În momentul în care un ''repository'' are configurat un ''remote'', ''commit''-urile de toate ''branch'-urile locale și din ''remote'' se pot sincroniza.
 +
 
 +
Pentru a aduce modificările de pe ''remote'' a branch-ului curent, se folosește comanda <code style="color: green">git pull ''nume_remote''</code>.
 +
Pentru a actualiza fișierele din ''remote'' cu modificările locale de pe ''branch''-ul curent, se folosește comanda <code style="color: green">git push ''nume_remote''</code>.
 +
 
 +
<div class="regula">Atenție, dacă pe ''remote'' există ''commit''-uri adăugate de alți utilizatori, pe care nu le aveți local, sunteți obligați să faceți <code style="color: green">pull</code> înainte de <code style="color: green">push</code>. Acest <code style="color: green">pull</code> poate produce conflicte care se rezolvă identic cu cele apărute la operațiile de ''merge''.</div>
 +
 
 +
Adăugarea unui ''remote'' manual se face în general când proiectul a fost creat local și se dorește a fi publicat pe ''remote''. În cazul în care proiectul (și implict repository-ul) există la o adresă, acesta poate fi copiat într-un ''repository'' local.
 +
 
 +
Pentru a copia un ''repository'' de la o adresă într-un ''repository'' local se folosește comanda <code style="color: green">git clone ''url_remote''</code>.
 +
 
 +
După clonare, ''repository''-ul local este sincronziat cu '''origin''' și ''remote''-ul este configurat cu adresa de unde a fost clonat.
  
Directiva #define este utilizată pentru a defini '''macro'''-uri de preprocesor. Acestea se folosesc în trei feluri distincte:
+
== Platforma Gitlab ==
* <code style="color: green">#define ''token'' ''value''</code> - este definit '''macro'''-ul ''token'' existența acestuia putând fi testată cu directivele <code style="color: green">#ifdef</code> și <code style="color: green">#ifndef</code>; dacă ''token'' este utilizat în program, după definirea lui, el va fi înlocuit cu ''value'' (efectiv, această operație este identică cu un "Search and Replace" dintr-un editor de text, unde ''token'' este înlocuit cu ''value''. 
 
<syntaxhighlight lang="C">
 
#define PI 3.1415
 
  
float a = 2 * PI;
+
[http://gitlab.com Gitlab] este o platformă online ce găzduiește ''reposity''-uri de Git. Pe lângă rolul de ''remote'' pentru sincronizare, Gitlab mai oferă următoarele funcționalități:
</syntaxhighlight>
+
* modificarea tipului de acces la ''repository'' pentru fiecare utilizator (access control);
* <code style="color: green">#define ''token''</code> - este definit '''macro'''-ul ''token'', existența acestuia putând fi testată cu directivele <code style="color: green">#ifdef</code> și <code style="color: green">#ifndef</code>; dacă ''token'' este utilizat în program, după definirea lui, va fi șters de peste tot unde apare (este de fapt cazul de mai sus unde ''value'' este de fapt un string de lungime zero).
+
* adăugarea de etape de dezvoltare și asocierea de bug-uri acestor etape (milestones);
<syntaxhighlight lang="C">
+
* posibilitatea de a înregistra bug-uri, precum și a comenta și nota evoluția lor evoluția lor (issues - bug tracking);
#include <stdio.h>
+
* ''merge'' automat din interfața web între ''branch''-urile aceluiași ''repository'' precum și între copii ale aceluiași ''repository'' (merge requests);
#define DEBUG
+
* posibilitatea de a vizualiza modificările codului în cadrul unui ''merge request'' și a adăuga comentarii la orice linie de cod (code review);
 +
* posibilitatea de a crea un Wiki pentru fiecare proiect;
 +
* un sistem de integrare continuă (continuous integration) care permite adăugarea de scripturi care să compileze, testeze și implementeze aplicația la fiecare nou ''commit'';
 +
* ... și altele.
  
int main(){
+
Toate aceste servicii sunt oferite gratuit utilizatorilor, dar fără suport.
#ifdef DEBUG
 
    printf("Debug is ON!\n");
 
#endif
 
    return 0;
 
}
 
  
</syntaxhighlight>
+
=== Exemple ===
  
<code style="color: green">#define ''token(arg1,arg2,..) expression''</code> - este definit '''macro'''-ul ''token'', existența acestuia putând fi testată cu directivele <code style="color: green">#ifdef</code> și <code style="color: green">#ifndef</code>; ''token'' este utilizat în program ca o funcție, iar el va fi înlocuit de ''expression'', în care ''arg1,arg2,...'' vor fi înlocuite cu valorile din program.
+
* Înregistrați-vă un cont pe platforma Gitlab.
 +
* Creați un proiect nou în platforma Gitlab, numit '''pc_lab'''.
 +
* Observați instrucțiunile pentru realizarea legăturii între ''repository''-ul local și cel de pe Gitlab.
 +
* În ''repository''-ul local de Git, adăugați, ca ''remote'' numit '''origin''', ''repository''-ul nou creat de pe Gitlab (ca URL folositi varianta ''https'' și înlocuiți adresa corectă în sintaxa de mai jos):
 +
'''<span style="color: green">student@pracsis01</span> <span style="color: blue">~/gitroot/pc_lab $</span> git remote add origin <nowiki>https://gitlab.com/.../....git</nowiki>'''
 +
* Sincronizați modificările locale cu '''origin''':
 +
'''<span style="color: green">student@pracsis01</span> <span style="color: blue">~/gitroot/pc_lab $</span> git push origin'''
 +
* Reîncărcați pagina proiectului și observați modificările.
 +
* Faceți echipe de câte două pesoane. În setările proiectului din Gitlab, dați acces de dezvoltator (developer) celuilalt membru al echipei.
 +
* Reîncărcați lista proiectelor în Gitlab și observați că acum aveți acces la încă un proiect, pe lângă cel al vostru.
 +
* Navigați în directorul <code style="color: blue">~/gitroot</code> și clonați ''repository''-ul colegului/ colegei (pentru că ambele proiecte au același nume, la clonare trebuie specificat un alt nume de director în care să fie copiat noul ''repository'', pentru a evita suprapunerea cu proiectul vostru):
 +
'''<span style="color: green">student@pracsis01</span> <span style="color: blue">~/gitroot $</span> git clone <nowiki>https://gitlab.com/.../....git</nowiki> pc_lab_temp'''
 +
* Adăugați o modificare unuia din fișierele din <code style="color: blue">pc_lab_temp</code> sau adăugați un fișier nou.
 +
* Pregătiți fișierul și apoi realizați ''commit''-ul.
 +
* Sincronizați ''repository''-ul cu '''origin''', branch-ul '''master''':
 +
'''<span style="color: green">student@pracsis01</span> <span style="color: blue">~/gitroot/pc_lab_temp $</span> git push origin master'''
 +
* Reveniți în ''repository''-ul personal și sincronizați-l aducând modificările din '''origin'''.
 +
* Listați '''commit'''-urile din ''branch''-ul curent.
 +
* Observați aceleași modificări și în interfața web a platformei Gitlab.

Versiunea curentă din 29 octombrie 2017 21:08

Obiective

  • definirea noțiunii de Version Control System;
  • utilizarea unui sistem de Version Control: Git.

Sisteme de control al versiunii

Gândiți-vă la următorul scenariu: lucrați la un proiect într-un limbaj de programare sau de descriere hardware; acest proiect este mare și nu poate fi terminat într-o zi, prin urmare vă faceți timp și lucrați cate o oră în fiecare zi. Apar următoarele situații:

  • peste două săptămâni vă dați seama că unele lucruri pe care le-ați adăugat în program nu sunt necesare, deci ați vrea să vă întoarceți la o versiune mai veche - este nevoie de un sistem care să țină o istorie a modificărilor și să permită oricând întoarcerea la o versiune anterioară;
  • proiectul e pe echipe, deci la el lucrează trei persoane; fiecare editează unul sau mai multe fișiere, fiind posibil ca doi membri ai echipei să editeze același fișier - e nevoie de un sistem care să poată să centralizeze modificările și să trateze situația în care același fișier e modificat de doi ingineri;
  • unul din membrii echipei găsește o problemă și dorește să vadă cine și ce a modificat în zona respectivă de cod și care a fost scopul modificării - este deci nevoie de un sistem care să permită documentarea fiecărei modificări pe perioada dezvoltării proiectului și vizualizarea acestor modificări;
  • după documentare, tester-ul dorește să poată nota problema, atribuind-o unui membru al echipei pentru rezolvare - este nevoie de un sistem care să permită înregistrarea și documentarea erorilor în scopul rezolvării;

Toate aceste cerințe sunt adresate de sistemele de control al versiunii, acestea pot:

  • ține evidența modificărilor și permite întoarcerea la o versiune mai veche;
  • permite ramificarea dezvoltării în mai multe direcții și unificarea ulterioară a acestor ramuri;
  • sincroniza modificările fiecărui utilizator cu un depozit central pentru a putea fi accesate de ceilalți membri ai proiectului;

Există mai multe sisteme de control al versiunii:

  • Pe model client - server:
    • Concurrent Versions System (CVS) - open Source
    • Subversion (SVN) - open source
    • Perforce – nu este open source, dar poate fi folosit gratis în proiecte open-source
  • Pe model distribuit:
    • Git - creat de Linus Torvalds pentru dezvoltarea kernel-ului de Linux - open source
    • BitKeeper – folosit pentru dezvoltarea kernel-ului de Linux între 2002 și aprilie 2005.

În continuare vom prezenta conceptele cele mai importante și funcționarea sistemului Git.

Git

Git este un sistem de control de versiune distribuit. Asta înseamnă că poate fi folosit de către un utilizator fără a fi conectat la un depozit central, copia locală de pe calculatorul utilizatorului ținând în baza ei de date toate informațiile legate de conținutul curent și de modificările anterioare.

 Odată instalat Git, fiecare utilizator trebuie să-și configureze adresa de e-mail și numele:
  git config --global user.name "Ion Vasile"
  git config --global user.email ion.vasile@gmail.com

Git - repository local

Fiecare proiect este stocat în Git într-un "depozit" numit repository.

Un repository se crează cu comanda git init.

Odată un repository creat, se pot adăuga apoi șterge sau modifica fișiere. Aceste modificări se adaugă în repository prin operații specifice inițiate de utilizator, numite commit.

Starea curentă a repository-ului se poate vedea în orice moment cu comanda git status.

Pregătirea unui nou commit - staged files

Un nou commit se pregătește selectând fișierele dorite și punându-le într-o stare numită "staged for commit" adică pregătite pentru commit. Fișierele care pot fi pregătite pentru commit sunt:

  • fișiere noi, care vor fi adăugate în repository - prin comanda git add fișier;
  • fișiere existente în repository, dar care au fost modificate - prin comanda git add fișier;
  • fișiere existente care se vor șterge din repository - prin comanda git rm fișier;
  • fișiere care există în repository, dar iși schimbă locația - prin comanda git mv fișier_sursă fișier_destinație;

Mai multe fișiere pot fi pregătite pentru un commit, apoi toate odată se actualizează într-un singur commit.

Un fișier pregătit pentru commit se poate șterge din lista de fișiere pregătite, păstrând modificările, cu comanda git reset fișier

Adăugarea de fișiere în repository - commit

Fiecare nou commit, care poate conține modificări pentru unul sau mai multe fișiere, se adaugă întotdeauna peste ultimul commit, și conține informații despre:

  • utilizatorul care făcut modificările;
  • data și ora când s-au realizat modificările respective;
  • mesajul adăugat de utilizator în momentul commit-ului;
  • un număr de identificare, generat din celelalte informații;
  • modificările efective.
Un commit nou se realizează cu comanda git commit -m "mesaj".

Ultimul commit se numește HEAD. Orice nou commit se poate pune doar peste HEAD-ul curent și va deveni noul HEAD.

Git commit stack.svg

Un fișier modificat dar care nu este pregătit pentru commit, poate fi readus în stadiul din HEAD prin comanda git checkout fișier

Revenire la versiuni anterioare - detached state

Lista commit-urilor existente se poate inspecta folosind comanda git log.

Dacă se dorește revenirea la un commit anterior, acest lucru se poate face în trei feluri, specificând ID-ul commit-ului la care se dorește revenirea:

  • revenire fără pierderea commit-urilor ulterioare; în acest caz, starea devine detached și se creează automat o ramură nouă de dezvoltare (branch) - prin comanda git checkout commit_id
  • revenire cu pierderea commit-urilor ulterioare dar fără pierderea modificărilor fișierelor; în acest caz, commit-ul la care se revine devine HEAD - prin comanda git reset commit_id
  • revenire cu pierderea commit-urilor ulterioare și a modificărilor fișierelor; și în acest caz, commit-ul la care se revine devine HEAD - - prin comanda git reset --hard commit_id

În detached state nu se șterge nimic din repository, iar commit-urile noi se adaugă branch-ului nou creat temporar. Pentru a reveni din detached state, trebuie revenit la ramura principală de dezvoltare.

Revenire fără pierdere de commit-uri - detached state
Revenire cu pierdere de commit-uri

Ramuri de dezvoltare - branch

Ramurile de dezvoltare (branches) sunt o componentă foarte importantă a sistemelor de control al versiunii care permit dezvoltarea simultană a mai multor feature-uri sau componente pentru același sistem, precum și posibilitatea de a avea în lucru mai multe versiuni ale aceleiași aplicații. Ideea de branch este aceea că dintr-un anumit punct al dezvoltării programului (adică de la un commit), stiva de commit-uri se poate ramifica și apoi direcțiile de dezvoltare vor diverge:

Schema bloc a unui repository cu două branch-uri

Branch-ul implicit care se creează inițial se numește master.

Pentru a vedea lista branch-urilor dintr-un repository (inclusiv care este cel curent), se folosește comanda git branch.
Pentru a crea un nou branch, se folosește comanda git branch nume_branch_nou.
Pentru a schimba branch-ul curent, se folosește comanda git checkout nume_branch.
Pentru a șterge un branch, se folosește comanda git branch -d nume_branch. 
În anumite situații, dacă branch-ul conține modificări care nu au fost portate pe branch-ul părinte, veți primi o eroare. În acest caz, se poate șterge forțat un branch cu comanda git branch -D nume_branch. Atenție, nu puteți șterge branch-ul curent.

Merges și rezolvarea conflictelor

Dacă un branch a fost utilizat pentru dezvoltarea unei componente a unui sistem, modificările din acest branch trebui aduse înapoi (merged) pe branch-ul părinte.

Merge între un branch oarecare și master.
Pentru a realiza o operație de merge se folosește comanda git merge branch_modificari -m "Mesaj pentru commit.".

Înainte de a face o operație de merge, branch-ul curent trebuie să fie acela unde se doresc aduse modificările. Pentru schema de mai sus, secvența corectă de comenzi ar fi:

git checkout master
git merge branch_pentru_scriere_in_fisier -m "Am facut merge la functionalitatea de scriere in fisier"

Dacă modificările de pe branch-ul componentei sunt complet disjuncte față de modificările de pe branch-ul sistemului, atunci operația de merge se poate face automat. Dacă în schimb aceleași fișiere au fost modificate pe aceleași linii, atunci fișierele respective se marchează ca fiind în conflict, operația de merge se oprește, iar utilizatorul trebuie să rezolve conflictele editând fișierele cu probleme, în care va găsi marcate variantele din cele două branch-uri. După ce fișierele sunt salvate cu modificările dorite, acestea trebuie pregătite pentru commit, iar apoi trebuie realizat commit-ul care va aduce modificările pe branch-ul curent.

Exemple

  • Prima oară după instalarea Git, trebuie configurat numele și adresa de e-mail a utilizatorului:
  student@pracsis01 ~ $ git config --global user.name "Ion Vasile"
  student@pracsis01 ~ $ git config --global user.email ion.vasile@gmail.com
  • Creați un director numit gitroot în directorul personal al userului student.
  • În directorul gitroot creați un alt director numit pc_lab.
  • În directorul ~/gitroot/pc_lab inițializați un repository Git:
  student@pracsis01 ~/gitroot/pc_lab $ git init
  Initialized empty Git repository in /home/student/gitroot/pc_lab/.git/
  • În directorul ~/gitroot/pc_lab creați un fișier text numit README.md care să conțină:
Acesta este primul meu repository Git
=====================================
  • Pregătiți fișierul pentru commit:
  student@pracsis01 ~/gitroot/pc_lab $ git add README.md
  student@pracsis01 ~/gitroot/pc_lab $ 
  • Vizualizați starea curentă a repository-ului:
  student@pracsis01 ~/gitroot/pc_lab $ git status
   On branch master
   
   Initial commit
   
   Changes to be committed:
     (use "git rm --cached <file>..." to unstage)
   
           new file:   README.md
  • Realizați primul commit:
  student@pracsis01 ~/gitroot/pc_lab $ git commit -m "Primul commit - fisierul README.md"
  [master (root-commit) 75f2cfb] Primul commit - fisierul README.md
   1 file changed, 0 insertions(+), 0 deletions(-)
   create mode 100644 README.md
  • Vizualizați din nou starea curentă a repository-ului.
  • Vizualizați lista ultimelor commit-uri.
  student@pracsis01 ~/gitroot/pc_lab $ git log
  ...
  • Creați in directorul ~/gitroot/pc_lab un director numit lab2. În acest director creați un fișier cod sursă C care să afișeze pe ecran textul "Hello Git!". Creați și un Makefile care să compileze sursa C și să genereze un executabil.
  • Pregătiți cele două fișiere pentru commit.
  • Realizați al doilea commit cu mesajul "Am adaugat fisierele sursa pentru laboratorul 2.".
  • Vizualizați lista ultimelor commit-uri.
  • Identificați ID-ul primului commit. Întoarceți-vă la starea de după primul commit (atenție, ID-ul de mai jos este doar un exemplu):
  student@pracsis01 ~/gitroot/pc_lab $ git checkout 75f2cfb
  • Vizualizați conținutul directorului curent.
  • Vizualizați starea curentă a repository-ului.
  • Vizualizați branch-ul curent.
  • Reveniți la HEAD pe branch-ul master.
  • Creați un branch nou numit lab2.
  • Fiind în continuare pe master, editați fișierul sursă C astfel încât să afișeze "Hello Master!".
  • Faceți commit la noua modificare.
  • Mutați-vă pe branch-ul lab2.
  • Vizualizați conținutul fișierului sursă C.
  • Editați fișierul sursă C astfel încât să afișeze "Hello new branch!".
  • Faceți commit la noua modificare.
  • Mutați-vă pe branch-ul master.
  • Vizualizați conținutul fișierului C.
  • Faceți merge branch-ului lab2.
  • Observați mesajul de eroare. Rezolvați conflictul și finalizați operația de merge.

Git Remote

Puterea platformei Git nu vine doar din faptul că se poate folosi offline de către un utilziator, pe propriul calculator, dar și pentru că oferă posibilitatea de a sincroniza repository-uri pentru același proiect. În fiecare repository se poate defini un număr de adrese URL pentru alte repository-uri, aceste adrese se numesc remote.

Pentru a vedea lista de adrese remote configurate pentru un repository, se folosește comanda  git remote -v.

Cu toate că Git nu are nici o restricție legată de modul de organizare a acestor repository-uri (adică oricare două se pot sincroniza între ele, făcând Git un sistem cu adevărat distribuit), modelul cel mai des întâlnit este acela de a avea un repository central, pe un server accesibil global, iar fiecare programator/ membru al echipei se sincronizează cu acest server central, care se numește popular origin.

Remote.svg

Pentru a adăuga un remote pentru un repository, se folosește comanda git remote add nume_remote url_remote, unde numele este în general (dar nu obligatoriu) origin.

În momentul în care un repository are configurat un remote, commit-urile de toate branch'-urile locale și din remote se pot sincroniza.

Pentru a aduce modificările de pe remote a branch-ului curent, se folosește comanda git pull nume_remote.
Pentru a actualiza fișierele din remote cu modificările locale de pe branch-ul curent, se folosește comanda git push nume_remote.
Atenție, dacă pe remote există commit-uri adăugate de alți utilizatori, pe care nu le aveți local, sunteți obligați să faceți pull înainte de push. Acest pull poate produce conflicte care se rezolvă identic cu cele apărute la operațiile de merge.

Adăugarea unui remote manual se face în general când proiectul a fost creat local și se dorește a fi publicat pe remote. În cazul în care proiectul (și implict repository-ul) există la o adresă, acesta poate fi copiat într-un repository local.

Pentru a copia un repository de la o adresă într-un repository local se folosește comanda git clone url_remote.

După clonare, repository-ul local este sincronziat cu origin și remote-ul este configurat cu adresa de unde a fost clonat.

Platforma Gitlab

Gitlab este o platformă online ce găzduiește reposity-uri de Git. Pe lângă rolul de remote pentru sincronizare, Gitlab mai oferă următoarele funcționalități:

  • modificarea tipului de acces la repository pentru fiecare utilizator (access control);
  • adăugarea de etape de dezvoltare și asocierea de bug-uri acestor etape (milestones);
  • posibilitatea de a înregistra bug-uri, precum și a comenta și nota evoluția lor evoluția lor (issues - bug tracking);
  • merge automat din interfața web între branch-urile aceluiași repository precum și între copii ale aceluiași repository (merge requests);
  • posibilitatea de a vizualiza modificările codului în cadrul unui merge request și a adăuga comentarii la orice linie de cod (code review);
  • posibilitatea de a crea un Wiki pentru fiecare proiect;
  • un sistem de integrare continuă (continuous integration) care permite adăugarea de scripturi care să compileze, testeze și implementeze aplicația la fiecare nou commit;
  • ... și altele.

Toate aceste servicii sunt oferite gratuit utilizatorilor, dar fără suport.

Exemple

  • Înregistrați-vă un cont pe platforma Gitlab.
  • Creați un proiect nou în platforma Gitlab, numit pc_lab.
  • Observați instrucțiunile pentru realizarea legăturii între repository-ul local și cel de pe Gitlab.
  • În repository-ul local de Git, adăugați, ca remote numit origin, repository-ul nou creat de pe Gitlab (ca URL folositi varianta https și înlocuiți adresa corectă în sintaxa de mai jos):
student@pracsis01 ~/gitroot/pc_lab $ git remote add origin https://gitlab.com/.../....git
  • Sincronizați modificările locale cu origin:
student@pracsis01 ~/gitroot/pc_lab $ git push origin
  • Reîncărcați pagina proiectului și observați modificările.
  • Faceți echipe de câte două pesoane. În setările proiectului din Gitlab, dați acces de dezvoltator (developer) celuilalt membru al echipei.
  • Reîncărcați lista proiectelor în Gitlab și observați că acum aveți acces la încă un proiect, pe lângă cel al vostru.
  • Navigați în directorul ~/gitroot și clonați repository-ul colegului/ colegei (pentru că ambele proiecte au același nume, la clonare trebuie specificat un alt nume de director în care să fie copiat noul repository, pentru a evita suprapunerea cu proiectul vostru):
student@pracsis01 ~/gitroot $ git clone https://gitlab.com/.../....git pc_lab_temp
  • Adăugați o modificare unuia din fișierele din pc_lab_temp sau adăugați un fișier nou.
  • Pregătiți fișierul și apoi realizați commit-ul.
  • Sincronizați repository-ul cu origin, branch-ul master:
student@pracsis01 ~/gitroot/pc_lab_temp $ git push origin master
  • Reveniți în repository-ul personal și sincronizați-l aducând modificările din origin.
  • Listați commit-urile din branch-ul curent.
  • Observați aceleași modificări și în interfața web a platformei Gitlab.