Inf101 Lab 1

Læringsmål

Bli kjent med GitLab
Klone, committe og pushe med Git
Enkel bruk av branching og merging
Håndtere en merge-konflikt
Bruke JUnit-tester

I denne oppgaven har vi laget til et git repositorium basert på stabel-eksempelet fra forelesningen i forrige uke. Du har fått din egen private kopi av dette repositoriet på GitLab, og skal laste ned, redigere og laste opp kode.

Frist: 12. februar 2016

Oppgave 0: Installasjon / Oppsett

Pass på at du allerede har gjort ferdig:

Installasjon av Java 8 og Eclipse
Ekstra innstillinger for https og tegnsett som beskrevet her – viktig: hvis du ikke gjør https-innstillingen (setter http.sslVerify til false) vil du ikke komme videre i oppgaven

I tillegg, hvis du ikke bruker Eclipse, eller om du vil trene på å bruke git direkte og ikke gjennom Eclipse, må du ha installert Git.

Om du ikke alt har gjort det, må du aktivere din GitLab-bruker. Klikk på "Sign In" øverst til høyre her på siden eller på inf101.ii.uib.no, og velg så Forgot your password?. Som epostadresse fyller du inn brukernavnet ditt (abc123) eller brukernavn+@student.uib.no eller UiB epostadressen din (som regel fornavn.etternavn@student.uib.no) – det er litt forskjellig hva hver enkelt av dere er satt opp med. Du skal så få en epost med en link hvor du kan sette et passord for GitLab. Pass på at du bruker et annet passord enn du bruker ellers på UiB / andre steder.

Oppgave 1: Kloning

Du finner oppgavekoden i repositoriet med URIen:

  https://inf101.ii.uib.no/<brukernavn>/inf101.v16.lab1.git

Hvor <brukernavn> skal byttes ut med brukernavnet ditt på UiB. Merk at det er nødvendig å bruke https (ssh vil ikke fungere).

Som vist i forelesningene, for å få dette prosjektet inn i eclipse, velg import fra fil menyen. Velg så Git -> Projects from git -> Clone URI. Fyll in URIen som du finner over. (Eclipse fyller så ut host og repository path med inf101.ii.uib.no og /<brukernavn>/inf101.v16.lab1.git.

Skriv inn ditt brukernavnet og GitLab-passord, og trykk next. Nå velger du hvilken branch du skal ha (master og clear). Trykk på next. Neste ting er å velge en mappe å putte repositoriet under Directory, og la resten være slik det er (initial branch: master, Remote name: origin), next -> import existing project -> next -> finish.

Nå skal du ha et prosjekt i eclipse som heter inf101.v16.lab1.

Oppgave 2: Implementering

2.1: Kjør test

Aller først kan du prøve å kjøre testen som er lagt ved, og se at den feiler. Høyreklikk på StackTest i Project Explorer, og velg Run as → JUnit test

2.2: Implementere MyStack

Du finner interfacet IStack akkurat slik som på forelesning 2. Det ligger også en klasse der, MyStack, der koden for metodene er fjernet.
Lag feltvariable i klassen og fyll inn metodene. Prøv helst å få det til på egen hånd – les gjerne om stabler om du er usikker på hvordan de skal virke.
Hvis du står fast, kan du se på implementasjonen vi laget på forelesningen

2.3: Kjør test igjen

Høyreklikk på StackTest, velg Run as → JUnit test. Hvis du har implementert MyStack riktig, skal testresultatet nå være grønt og ikke rødt.
(Merk at foreløpig er StackTest veldig enkel, så det er mange mulige feil i MyStack som den ikke vil være i stand til å finne – vi skal lage bedre tester senere.)

Oppgave 3: Committe endringene

Høyreklikk på prosjektet i Project Explorer, velg Team → Commit...
Skriv inne en passende commit-melding (f.eks. "implementert MyStack"), sjekk listen over filer (antakelig er det bare MyStack.java som er endret) og trykk "Commit".
Du har nå lagret endringene dine på din egen maskin.
Høyreklikk på prosjektet og velg Team → Show in History. Du skal nå kunne se endringen du gjorde, med meldingen du la inn. Den vil være merket med master (grenen du er på) og HEAD (betyr at dette er den nyeste versjonen). Du vil også kunne se en tidligere versjon som er merket med origin/master – dette er den versjonen som du lastet ned i deloppgave 1.

Oppgave 4: Pushe til GitLab

Høyreklikk på prosjektet i Project Explorer, velg Team → Push to Upstream
Du må kanskje fylle inn brukernavn og passord
Du vil få opp en kvitteringsside med en liste over endringene som ble sendt til GitLab. Hvis du får en feilmelding bør du spørre om hjelp.
Hvis du ser på prosjektet ditt på GitLab siden, vil du kunne se listen over endringer. URLen til ditt eget prosjekt er https://inf101.ii.uib.no/<brukernavn>/inf101.v16.lab1/commits/master

Oppgave 5: Flere endringer – legg til clear()

I interfacet IStack, legg til en deklarasjon for en metode void clear(); som er ment å tømme hele stabelen. Husk å også legge til JavaDoc-dokumentasjon.
Du vil nå få opp feil i MyStack – Eclipse vil klage over at den ikke implementerer clear(). Hvis du lar muspekeren hvile over feilmeldingen, vil du få opp forslag til hvordan problemet skal fikses. Du kan her velge "Add unimplemented methods"
Commit og push det du har gjort på samme måte som over

Oppgave 6: Legge til en ny fil

Velg File → New → Java Class. Pass på at Package er satt til inf101.v16.lab1.
Fyll ut et navn, f.eks. YourStack.
På Interfaces trykk Add... og legg til IStack.
Trykk Finish.
Legg merke til det lille spørsmålstegnet ved siden av filen i Project Explorer – det betyr at Git ikke kjenner til filen.
Du kan fylle ut klassen med en ny implementasjon av stabel, eller evt lime inn kode fra MyStack (eller rett og slett bare la metodene være uimplementerte – poenget er bare å legge til en ny fil i Git).
Velg Team → Commit – du vil nå se at den nye klassefilen dukker opp blant filene, med et lite spørsmålstegn ved siden av. Det betyr at den så langt er ukjent for Git. Huk av i boksen ved siden av, og klassefilen vil bli lagt til i endringen du committer.
Push igjen.
Sjekk GitLab-websiden, og se at den nye filen er med (https://inf101.ii.uib.no/<brukernavn>/inf101.v16.lab1/tree/master/src/inf101/v16/lab1)

Oppgave 7: Rot med merge

Vi skal nå prøve å hente inn mer kode som er laget på forhånd, og som antakeligvis vil være i konflikt med det du har laget. Anya har nemlig også lagt til clear()-metoden. Koden for dette ligger på en egen gren som heter origin/clear. Vi skal nå flette (merge) disse endringene med endringene du har gjort – og antakeligvis vil det resultere i trøbbel.

Først, pass på at du har committet og pushet alt du har gjort.
Så, høyreklikk på prosjektet, og velg Team → Merge...
I vinduet som kommer opp, velger du "origin/clear" under "Remote Tracking" (se screenshot under) (Tilsvarende git-kommando er git merge origin/clear)

Trykk Merge
Du vil så få opp et vindu med resultatet.
- Om du får Result: Failed, så har du antakelig gjort ting som du ikke har committet ennå. Commit og prøv igjen.
- Om du får Result: Conflicts, så er det som forventet, og du må følge instruksene videre.
- Om du ikke får feil, har du antakelig ikke gjort deloppgave 5, eller du har gjort den helt likt til det Anya har gjort. Du kan i såfall ta helg.
For å sortere ut konfliktene, må du fikse filene som er markert med rødt. Hver av disse vil typisk inneholde linjer fra forskjellige versjoner av koden. For eksempel:

<<<<<<< HEAD
=======
	/**
	 * Fjern alle elementer fra stabelen
	 */
>>>>>>> origin/clear
	void clear();

Det som er mellom <<<<<<< og ======== er koden du har laget (i dette tilfellet ingenting – her har man altså glemt å legge til dokumentasjon), og det som er mellom ======= og >>>>>>> er koden vi prøvde å flette inn. Vanligvis bør du slette den ene og beholde den andre – som regel vil du beholde det du har laget selv.

Ordne konfliktene slik at koden virker og testene er grønne.
For hver av filene som hadde konflikt (merket med rødt i utforskeren), velg Team → Add to Index. Du forteller da Git at du har ordnet opp i konflikten.

Gjør så en commit (typisk med en melding som "Merged branch origin/clear"). Hvis du har utestående konflikter vil du få beskjed om å fikse de først (husk Add to Index for å si at alt er i orden).
Push.

Generelt – Innlevering av laboppgaver

Merk at innlevering skal skje til GitLab. For å levere bruker du Team -> push (husk at du må bruke commit først), eventuelt Team -> Commit og så Commit and Push. Husk at hvis du har opprettet nye klasser/filer, må du krysse av for disse i commit-dialogen for at de skal bli med i opplastingen.

Vi anbefaler at du gjør commit hver dag, eller hver gang du er ferdig med en større endring. Da går det alltid an å lete seg tilbake i historien til en tidligere versjon hvis du har havnet på villspor (commit-dialogen inneholder også en praktisk "Commit and push"-knapp, som pusher endringene til GitLab med en gang).

lab 1