Skip to content
Snippets Groups Projects

Compare revisions

Changes are shown as if the source revision was being merged into the target revision. Learn more about comparing revisions.

Source

Select target project
No results found

Target

Select target project
  • akselsa/course-material
  • it1901/course-material
2 results
Show changes
Showing
with 1568 additions and 585 deletions
This diff is collapsed.
= Gitpod
link:slides/gitpod.html[Lysark]
== Problemet som gitpod løser
Rigging av alt som trengs for utvikling tar mye tid. En skal installere _språket_ (*python*, *java*, ...) og en trenger diverse _rammeverk_ (*junit*, *javafx*, ...). Kanskje skal en bruke såkalte _byggeverktøy_ (*maven*, *gradle*, ...) og det må installeres og konfigureres. På toppen av dette kommer selve _IDE-en_ (*VSCode*, *IntelliJ*, *Eclipse*, ...), som må passe til og være konfigurert for det en har installert forøvrig.
En kompliserende faktor er _versjoner_, en må ha versjoner av alt som passer sammen og ofte trenger en ulike versjoner for ulike prosjekter. Selv om det finnes verktøy som *sdkman* som hjelper en å installere og veksle mellom ulike versjoner, så er det en del manuelt arbeid.
For større prosjekter er kanskje ikke dette merarbeidet så problematisk, det må jo ikke gjøres så ofte. Men hvis en veksler mellom flere mindre prosjekter eller bare skal jobbe med små eksempler og øvinger, så kan det bli veldig tungvint.
== Gitpod = VSCode + git + Docker
Gitpod prøver å løse dette problemet ved å tilby en nettleserbasert IDE (*VSCode*), som er ferdigkonfigurert for spesifikke prosjekt. En slipper dermed å installere IDE-en. Konfigurasjonen av både IDE-en og den underliggende _virtuelle maskina_ (*Linux* i *Docker*) ligger i *git*-kodelageret sammen med prosjektfilene forøvrig. Når kodelageret med konfigurasjon og prosjekfiler først er satt opp, så slipper en dermed også å installere språk, rammeverk og verktøy, det er bare å åpne IDE-en med utgangspunkt i kodelageret.
Jobben med oppsett må jo fortsatt gjøres, men en trenger bare å gjøre det én gang. Alle som siden skal jobbe med samme prosjekt, kan bare åpne IDE-en på et kodelager og gå i gang. Dersom det er snakk om et kode-eksempel, en øving eller et standardisert prosjekt, så kan det gjøres på forhånd av fagstaben, så i hvert fall studenten slipper styret med å sette alt opp. Og for nye prosjekt kan en ofte ta utgangspunkt i tidligere prosjekter eller eksempler basert på samme språk og rammeverk.
== Gitpod @ NTNU
Gitpod har integrasjoner med skytjenester som *gitlab* og *github*, så en kan logge inn på og administrere kodelagre der. Gitpod kan også settes opp internt, og NTNU har sin egen gitpod-installasjon tilgjengelig på http://gitpod.stud.ntnu.no, som er integrert med IDI sin *gitlab*-tjeneste på http://gitlab.stud.idi.ntnu.no, så emner som bruker gitlab kan automatisk tilby gitpod som plattform for utvikling.
Alle kodelagre i IT1901 med eksempler og maler er ferdig _gitpodifisert_, se f.eks. https://gitlab.stud.idi.ntnu.no/it1901/javafx-templates[javafx-templates]. Dermed er de lette å bygge videre på, det er bare å trykke på *Gitpod*-knappen. Faktisk kan alle kodelagre på vår gitlab åpnes i gitpod for redigering av filer. Men for å kunne utvikle ordentlig, så må de altså gitpodifiseres vha. konfigurasjonsfilen *.gitpod.yml* og evt. en tilhørende *docker*-fil.
En alternativ måte å åpne gitpod på er å skrive inn nettadressen til gitpod-tjeneren (http://gitpod.stud.ntnu.no) etterfulgt av *#* og så adressen til gitlab-kodelageret som skal åpnes, f.eks. `http://gitpod.stud.ntnu.no#https://gitlab.stud.idi.ntnu.no/it1901/javafx-templates`.
== Gitpod-arkitektur
VSCode i nettleseren fungerer nokså likt VSCode lokalt, den har tilgang til et filsystem med kjørebare programmer, og en del av filsystemet utgjør arbeidsområdet til VSCode. Forskjellen er at filsystemet og programmene er inni en virtuell maskin i skyen, og maskina startes opp kun for å kjøre VSCode i nettleseren. Ved oppstart _klones_ kodelageret inn i maskina, og innholdet utgjør altså arbeidsområdet til VSCode. Konfigurasjonen av maskina og evt. oppstartsinstruksjoner leses ut av *.gitpod.yml* på toppnivå i det samme kodelageret.
image::images/gitpod-arch.png[width=800]
Den virtuelle maskina er _flyktig_, i den forstand at den forsvinner av seg selv hvis en lukker VSCode (eller fanen) eller lar være å bruke den en periode. Arbeidsområdet (og noen andre viktige filer) arkiveres imidlertid, slik at den kan startes opp igjen med i praksis samme innhold. Det blir som om en legger en bærbar i dvale og så vekker den til live igjen. Vanligvis vil en derfor fortsette med et eksisterende arbeidsområde fra hovedsiden til gitpod-tjenesten, i stedet for å starte en ny virtuell maskin med et nytt arbeidsområde fra (gitlab-nettsida for) kodelageret. Det er bare når en endrer oppsettet etter å ha redigert *.gitpod.yml* eller *docker*-fila at en må starte en helt ny maskin.
Hvis den virtuelle maskina er riktig satt opp (se under om konfigurering med *.gitpod.yml*), så kan en faktisk kjøre grafiske apper (f.eks. skrevet i JavaFX) og få dem vist inni gitpod eller i et separat nettleservindu. Dette krever at en "slår på" en virtuell grafisk skjerm som er en del av den virtuelle maskina. Se etter tallet 6080 i statuslinja nederst og trykk på det. Da spretter det opp et panel og en kan angi at 6080 (som representerer den virtuelle grafiske skjermen) skal vises i *Preview*-panelet eller i et eget nettleser-vindu.
== Gitpod-bruk i emner
Gitpod kan brukes i emner på ulike måter. Emner som i dag distribuerer og deler innhold vha. git-kodelagre, kan gitpodifisere og få ekstra fordeler. Vi har identifisert en del scenarier for bruk av gitpod i emner, som en bør være fortrolig med.
=== Kode-eksempler
Fagstaben rigger et kode-eksempel i et prosjektoppsett som lar en kompilere og kjøre (generelt bygge). Prosjektet kan kreve verktøy og rammeverk som studentene ikke (ennå) har installert på egne maskiner. Studentene åpner kodelageret i gitpod og kan umiddelbart prøve det ut, endre på det og lære av det. Dersom en vil ta vare på eksemplet, må en opprette et eget kodelager og lagre (det endrede) innholdet der vha. *git remote* og *git push*.
=== Få veiledning
Studenten jobber med et prosjekt i et kodelager og trenger veiledning og sender lenke til en læringsassistent, som kan åpne gitpod og jobbe i samme oppsett som studenten. Hvis læringsassistenten har rettigheter til kodelageret (f.eks. fordi det ligger i en gitlab-gruppe satt opp av fagstaben), så kan hen legge tilbake endringer evt. lage et endringsforslag.
En annen mulighet er å ta et såkalt øyeblikksbilde (snapshot) som lagrer innholdet i arbeidsområdet og knytter det til en lenke. Læringsassistenten kan åpne denne lenka i gitpod og får samme innhold i sin gitpod som studenten hadde da øyeblikksbildet ble tatt. Fordelen er at en får delt innhold som det ikke naturlig å dele vha. selve kodelageret, f.eks. byggeresultater.
=== Øvingsopplegg
Fagstaben i et emne lager en gitlab-gruppe for emnet og semesteret, f.eks. *tdt4100/v2022* og inni denne opprettes et gitpodifisert kodelager for hver student som både fagstaben og studenten har tilgang til. Hver uke publiseres nye øvingsoppgaver (tekster, startpakke med kode og evt. tester) som kopieres inn i hvert slikt kodelager, slik at studentene kan jobbe med dem og (implisitt) levere i sitt eget emne-kodelager.
=== Eksamen (!)
Eksamen kan rigges omtrent som et øvingsopplegg, med et personlig kodelager pr. student, med både oppgave og (etterhvert) besvarelse i.
== Gitpod og bruk av git
Som nevnt klones kodelageret inn i den virtuelle maskina, og håndtering av kodelageret blir som ved kjøring på egen maskin, en bruker de vanlige *git*-kommandoene for å synkronisere med gitlab-tjeneren. En er ikke nødt til å lagre unna endringer i arbeidsområdet til tjeneren før den virtuelle maskina legges i dvale, hele arbeidsområdet arkiveres jo, men dersom en jobber med andre eller bruker VSCode i både gitpod og lokalt, så må en jo synkronisere filer via gitlab. Merk også at arkiverte arbeidsområder lagres ikke evig, de kastes etter noen uker uten bruk, så en må bruke git innimellom.
Å komme i gang er i grunnen mest komplisert, fordi utgangspunktet for kodelageret kan være så forskjellig.
=== Jobbe videre med andres kodelager
Hvis en skal jobbe videre med et kodelager som eies av andre, så må en lage en kopi (med eller uten kobling til originalen, med kobling så kalles det gjerne en "gaffel"). En oppretter da et nytt kodelager på gitlab f.eks. på egen bruker eller under en emne-gruppe. Navigér til egen bruker eller gruppa og velge *New project* under *+*-menyen øverst.
image::images/gitlab-new-project.png[width=800]
Lag et tomt/blankt kodelager uten README, fordi hele innholdet skal overføres fra originalen. Hvert kodelager har sin egen adresse som brukes av git. Velg *Clone*-nedtrekksmenyen og kopier *HTTPS*-adressen (se under). Den skal brukes i en git-kommando for oppsett av git inni gitpod.
image::images/gitlab-repo-url.png[width=300]
For å knytte kodelageret inni gitpod til det nye kodelageret på gitlab, skriv inn `git remote set-url origin` etterfulgt av kodelager-adressen fra forrige steg. Dermed vil alle kommandoer som opererer på git-tjeneren (en såkalt _remote_)gå mot det nye kodelageret. Kommandoen `git push -u origin master` brukes først for å overføre alt git-innhold m/historikk til det nye kodelageret sin *master*-grein, og siden kan en bare bruke `git push` for å oppdatere, evt. `git pull` for å hente ned endringer fra tjeneren.
Dersom en vil beholde knytningen til original-kodelageret, så endrer en først navnet
på den opprinnelige kobling til f.eks. upstream med `git remote rename origin upstream`. Så opprettes det en ny kobling til det nye kodelageret med `git remote add origin` etterfulgt av kodelager-adressen fra forrige steg. Da vil vanlig bruk av *git push* og *git pull* gå mot det nye kodelageret, men en kan hente ned endringer fra original-kodelageret med *git fetch upstream* og innlemme dem med *git merge upstream/master* (og være beredt til å håndtere konflikter).
=== Opprette nytt kodelager på gitlab
Dette er i grunnen det enkleste. En bruker samme skjema som over, men velger å lage en README med det samme (om en glemmer det, så kan en lage en README på nettsiden til det nye kodelageret), og etter at kodelageret er opprettet, så åpner man bare gitpod på det nye kodelageret. Merk at selv om en kan åpne gitpod, så er ikke kodelageret automatisk gitpodifisert. Det gjør en ved å opprette *.gitpod.yml* og evt. en *docker*-fil med passende innhold, overføre disse tilbake med *git push*. For at det nye gitpod-oppsettet skal få effekt må en starte gitpod på nytt fra nettsida til kodelageret.
=== Overføre lokalt kodelager til gitlab (og gitpod)
Dersom du sitter med et kodelager lokalt på maskina di (som ikke finnes på gitlab), så kan det åpnes i gitpod ved å først overføre det til et kodelager på gitlab, for så å åpne det i gitpod. Prosessen blir litt som den første varianten over, en oppretter et kodelager på gitlab og angir så at det lokale kodelageret skal knyttes til det nye på gitlab (som en _remote_). Skriv inn `git remote add origin` etterfulgt av kodelager-adressen for det nye kodelageret (tilsvarende varianten over). Dette gjøres selvsagt i terminalen lokalt, evt. inni terminal-panelet i VSCode lokalt.
Til slutt åpnes det nye kodelageret på gitlab i gitpod.
== Gitpod-konfigurasjon med .gitpod.yml og gitpod.Dockerfile (for den dristige)
Den virtuelle maskina konfigures vha. en spesiell fil med navn *.gitpod.yml* og en tilhørende *docker*-fil. Førstnevnte angir bl.a. hvilken *docker*-fil som beskriver alt som skal være ferdig installert i den virtuelle maskina. Det enkleste er å referere til en standard *docker*-fil laget for formålet f.eks. *gitpod/workspace-full-vnc*. Da får en en støtte for en rekke vanlige programmeringsspråk og kan kjøre grafiske apper på en slags virtuell skjerm som vises i gitpod eller et eget nettleser-vindu. Dersom en trenger noe ut over dette, kan en lage sin egen *docker*-fil som angir det som trengs ekstra på toppen av en standard en. Det er litt mye å dekke her, men under vises et enkelt oppsett for å bruke en nyere Java-versjon enn det som er standard i gitpod.
*.gitpod.yml* (styrer oppsettet):
....
image:
file: .gitpod.Dockerfile
tasks:
- init: sdk use java 16.0.1.hs-adpt
....
*.gitpod.Dockerfile* (angir innhold i virtuell maskin):
....
FROM gitpod/workspace-full-vnc
USER gitpod
RUN bash -c ". /home/gitpod/.sdkman/bin/sdkman-init.sh \
&& sdk install java 16.0.1.hs-adpt \
&& sdk default java 16.0.1.hs-adpt"
....
Det viktige her er at
- *.gitpod.yml* refererer til *.gitpod.Dockerfile*
- *.gitpod.Dockerfile* bygger på (ved å referere til) *gitpod/workspace-full-vnc*
- *.gitpod.Dockerfile* kjører en ekstra kommando(linje) som installerer java-distribusjonen *16.0.1.hs-adpt* vha. *sdk*-programmet
- *.gitpod.yml* kjører en kommando for å ta i bruk *16.0.1.hs-adpt* i gitpod-terminal
En kan installere nær sagt hva som helst ved å skrive de riktige installasjonskommandoene inn i *.gitpod.Dockerfile* og ytterligere instruksjoner i *.gitpod.yml*. Det er litt fikkel, men en kommer langt ved å søke etter relevant *docker*-filer på https://hub.docker.com/search?q=&type=image[Dockerhub] og kopiere innhold derfra.
lectures/asciidoc/images/gitlab-new-project.png

216 KiB

lectures/asciidoc/images/gitlab-repo-url.png

13 KiB

lectures/asciidoc/images/gitpod-arch.png

896 KiB

lectures/asciidoc/images/javafx-template-structure.png

68 KiB

:sourcedir: .
:toclevels: 3
= Forelesninger
== 2021
=== Introduksjon til emnet
link:slides/01-course-intro.html[Lysarkene] gir en oversikt over organiseringen av emnet
link:slides/02-git-plus-plus.html[Lysarkene] gir en oversikt over git, gitlab og gitpod
include::{sourcedir}/gitpod.adoc[leveloffset=+2]
include::{sourcedir}/ci.adoc[leveloffset=+2]
=== 4. Forelesning
link:slides/04-lecture.html[Lysarkene] gir en oversikt over SCRUM og Gitlab elementer som kan brukes i prosjektet.
=== 5. Forelesning
link:slides/05-lecture.html[Lysarkene] Q&A.
=== 6. Forelesning
link:slides/06-lecture.html[Lysarkene] Pair programming + more on Git.
=== 7. Forelesning
==== Oppsummering av øving 1
link:slides/individuell-oblig.html[Lysarkene] oppsummerer den individuelle, obligatoriske øving 1
==== Kodestank
link:slides/kodestank.html[Lysark] om såkalt "kodestank" (code smell)
== 8. Forelesning
link:slides/08-lecture.html[Lysarkene] Unit testing.
== 9. Forelesning
link:slides/09-lecture.html[Lysarkene] Documentation.
== 10. Forelesning
link:slides/12-modular.html[Lysarkene] 2nd Group assignment + Modularization.
link:slides/10-lecture-code-quality.html[Lysarkene] Code quality.
== 2020
=== Programvareutvikling
link:slides/02-software-development.html[Lysarkene]
=== Utvikling og kildekodehåndtering
link:slides/03-dev-and-scm.html[Lysarkene]
=== Git-demonstrasjon
link:slides/04-git-demo.html[Lysarkene]
=== Byggeverktøy og (litt om) testing
link:slides/06-build-tools-and-some-testing.html[Lysarkene]
=== Gitlab
link:slides/07-gitlab.html[Lysarkene]
=== Eksempel på arbeidsfly
link:slides/08-workflow-example.html[Lysarkene]
=== Dokumentasjon
link:slides/09-documentation.html[Lysarkene]
=== Enhetstesting
link:slides/10-unit-testing.html[Lysarkene]
=== Kodekvalitet
link:slides/11-code-quality.html[Lysarkene]
=== Moduler og modularitet
link:slides/12-modular.html[Lysarkene]
=== Designprinsipper og UML
link:slides/13-solid-uml.html[Lysarkene]
=== Git og gitlab
link:slides/14-git-gitlab.html[Lysarkene]
=== REST API
link:slides/17-rest-api.html[Lysarkene]
=== Generelle/felles problemer
link:slides/19-common-issues.html[Lysarkene]
=== Smidige verktøy
link:slides/agiletools.html[Lysarkene]
=== Kontinuerlig integrasjon
link:slides/ci.html[Lysarkene]
=== Kildekodehåndtering
link:slides/scm.html[Lysarkene]
plugins {
id 'org.asciidoctor.jvm.convert' version '3.0.0-alpha.3'
id 'org.asciidoctor.jvm.revealjs' version '3.0.0-alpha.3'
}
repositories {
jcenter()
maven {
url "https://plugins.gradle.org/m2/"
}
maven {
url 'http://rubygems-proxy.torquebox.org/releases'
}
}
dependencies {
asciidoctorGems 'rubygems:asciidoctor-revealjs:2.0.0'
}
asciidoctor {
sourceDir 'asciidoc'
sources {
include '*.adoc'
}
outputDir file('build/docs/asciidoc')
resources {
from('asciidoc') {
include '**/*.png'
}
into '.'
}
logDocuments = true
}
asciidoctorj {
modules {
// diagram.use()
diagram.version '1.5.16'
}
// useIntermediateWorkDir = true
attributes toc: 'left',
'source-highlighter': 'highlight.js'
/*
extensions {
block_macro (name: 'tweet') { parent, target, attributes ->
String content = """<div class="tweet" data-src="https://twitter.com/${target}/status/${attributes.get('1')}"></div>"""
config.remove 'content_model'
createBlock(parent, "pass", [content], [:], config)
}
}
*/
}
asciidoctorRevealJs {
sourceDir 'revealjs'
sources {
include '*.adoc'
}
outputDir file('build/docs/revealjs')
resources {
from('revealjs') {
include 'images/**'
include '**/*.css'
}
into '.'
}
attributes 'sourceDir': 'revealjs',
'imagesDir': 'revealjs',
'icons':'font',
'iconfont-name': 'fontawesome-4.5.0'
revealjsOptions {
controls = true
slideNumber = true
progressBar = true
pushToHistory = true
overviewMode = true
touchMode = true
backgroundTransition = 'convex' //none , fade, slide, convex, concave, zoom
theme = 'white' //'black', 'beige' , 'league', 'night', 'serif', 'simple', 'sky', 'solarized'
}
plugins 'rajgoel/chart/Chart.min.js'
//plugins 'IainAndrew/footer-reveal/footer-reveal.min.js'
}
revealjs {
version '2.0.0' // why not '3.8.0'
templateGitHub {
organisation = 'hakimel'
repository = 'reveal.js'
tag = '3.8.0'
}
}
revealjsPlugins {
github 'rajgoel', {
organisation = 'rajgoel'
repository = 'reveal.js-plugins'
branch = 'master'
}
/*github 'IainAndrew', {
organisation = 'IainAndrew'
repository = 'footer-reveal'
branch = 'master'
}*/
}
build.dependsOn 'asciidoctorRevealJs'
File deleted
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-5.4-bin.zip
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
#!/usr/bin/env sh
#
# Copyright 2015 the original author or authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
##############################################################################
##
## Gradle start up script for UN*X
##
##############################################################################
# Attempt to set APP_HOME
# Resolve links: $0 may be a link
PRG="$0"
# Need this for relative symlinks.
while [ -h "$PRG" ] ; do
ls=`ls -ld "$PRG"`
link=`expr "$ls" : '.*-> \(.*\)$'`
if expr "$link" : '/.*' > /dev/null; then
PRG="$link"
else
PRG=`dirname "$PRG"`"/$link"
fi
done
SAVED="`pwd`"
cd "`dirname \"$PRG\"`/" >/dev/null
APP_HOME="`pwd -P`"
cd "$SAVED" >/dev/null
APP_NAME="Gradle"
APP_BASE_NAME=`basename "$0"`
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
# Use the maximum available, or set MAX_FD != -1 to use that value.
MAX_FD="maximum"
warn () {
echo "$*"
}
die () {
echo
echo "$*"
echo
exit 1
}
# OS specific support (must be 'true' or 'false').
cygwin=false
msys=false
darwin=false
nonstop=false
case "`uname`" in
CYGWIN* )
cygwin=true
;;
Darwin* )
darwin=true
;;
MINGW* )
msys=true
;;
NONSTOP* )
nonstop=true
;;
esac
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
# Determine the Java command to use to start the JVM.
if [ -n "$JAVA_HOME" ] ; then
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
# IBM's JDK on AIX uses strange locations for the executables
JAVACMD="$JAVA_HOME/jre/sh/java"
else
JAVACMD="$JAVA_HOME/bin/java"
fi
if [ ! -x "$JAVACMD" ] ; then
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
else
JAVACMD="java"
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
# Increase the maximum file descriptors if we can.
if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
MAX_FD_LIMIT=`ulimit -H -n`
if [ $? -eq 0 ] ; then
if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
MAX_FD="$MAX_FD_LIMIT"
fi
ulimit -n $MAX_FD
if [ $? -ne 0 ] ; then
warn "Could not set maximum file descriptor limit: $MAX_FD"
fi
else
warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
fi
fi
# For Darwin, add options to specify how the application appears in the dock
if $darwin; then
GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
fi
# For Cygwin, switch paths to Windows format before running java
if $cygwin ; then
APP_HOME=`cygpath --path --mixed "$APP_HOME"`
CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
JAVACMD=`cygpath --unix "$JAVACMD"`
# We build the pattern for arguments to be converted via cygpath
ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
SEP=""
for dir in $ROOTDIRSRAW ; do
ROOTDIRS="$ROOTDIRS$SEP$dir"
SEP="|"
done
OURCYGPATTERN="(^($ROOTDIRS))"
# Add a user-defined pattern to the cygpath arguments
if [ "$GRADLE_CYGPATTERN" != "" ] ; then
OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
fi
# Now convert the arguments - kludge to limit ourselves to /bin/sh
i=0
for arg in "$@" ; do
CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
else
eval `echo args$i`="\"$arg\""
fi
i=$((i+1))
done
case $i in
(0) set -- ;;
(1) set -- "$args0" ;;
(2) set -- "$args0" "$args1" ;;
(3) set -- "$args0" "$args1" "$args2" ;;
(4) set -- "$args0" "$args1" "$args2" "$args3" ;;
(5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
(6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
(7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
(8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
(9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
esac
fi
# Escape application args
save () {
for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
echo " "
}
APP_ARGS=$(save "$@")
# Collect all arguments for the java command, following the shell quoting and substitution rules
eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
cd "$(dirname "$0")"
fi
exec "$JAVACMD" "$@"
@rem
@rem Copyright 2015 the original author or authors.
@rem
@rem Licensed under the Apache License, Version 2.0 (the "License");
@rem you may not use this file except in compliance with the License.
@rem You may obtain a copy of the License at
@rem
@rem http://www.apache.org/licenses/LICENSE-2.0
@rem
@rem Unless required by applicable law or agreed to in writing, software
@rem distributed under the License is distributed on an "AS IS" BASIS,
@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@rem See the License for the specific language governing permissions and
@rem limitations under the License.
@rem
@if "%DEBUG%" == "" @echo off
@rem ##########################################################################
@rem
@rem Gradle startup script for Windows
@rem
@rem ##########################################################################
@rem Set local scope for the variables with windows NT shell
if "%OS%"=="Windows_NT" setlocal
set DIRNAME=%~dp0
if "%DIRNAME%" == "" set DIRNAME=.
set APP_BASE_NAME=%~n0
set APP_HOME=%DIRNAME%
@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
@rem Find java.exe
if defined JAVA_HOME goto findJavaFromJavaHome
set JAVA_EXE=java.exe
%JAVA_EXE% -version >NUL 2>&1
if "%ERRORLEVEL%" == "0" goto init
echo.
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
echo.
echo Please set the JAVA_HOME variable in your environment to match the
echo location of your Java installation.
goto fail
:findJavaFromJavaHome
set JAVA_HOME=%JAVA_HOME:"=%
set JAVA_EXE=%JAVA_HOME%/bin/java.exe
if exist "%JAVA_EXE%" goto init
echo.
echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
echo.
echo Please set the JAVA_HOME variable in your environment to match the
echo location of your Java installation.
goto fail
:init
@rem Get command-line arguments, handling Windows variants
if not "%OS%" == "Windows_NT" goto win9xME_args
:win9xME_args
@rem Slurp the command line arguments.
set CMD_LINE_ARGS=
set _SKIP=2
:win9xME_args_slurp
if "x%~1" == "x" goto execute
set CMD_LINE_ARGS=%*
:execute
@rem Setup the command line
set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
@rem Execute Gradle
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
:end
@rem End local scope for the variables with windows NT shell
if "%ERRORLEVEL%"=="0" goto mainEnd
:fail
rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
rem the _cmd.exe /c_ return code!
if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
exit /b 1
:mainEnd
if "%OS%"=="Windows_NT" endlocal
:omega
= IT1901 = IT1901
:customcss: slides.css :customcss: slides.css
:icons: font :icons: font
:includedir: includes/
:LECTURE_TOPIC: Course Introduction
:LECTURE_NO: 1st lecture
include::{includedir}header.adoc[]
++++
<img id="main-logo" class="main-logo" src="images/template/main_logo_eng_no_text.png" width="300" alt="ntnu logo"/>
++++
[.smaller-80] [.smaller-80]
- Velkommen til IT1901 Informatikk prosjektarbeid 1 - Velkommen til IT1901 Informatikk prosjektarbeid 1
- Welcome to IT1901 Informatics, Project 1 - Welcome to IT1901 Informatics, Project 1
Høst 2019 / Fall 2019 Høst 2024 / Fall 2024
== Agenda == Agenda
...@@ -41,6 +43,7 @@ Smidig og moderne praksis og konstruksjon ...@@ -41,6 +43,7 @@ Smidig og moderne praksis og konstruksjon
** mobil ** mobil
** web ** web
== IT1901 Goals == IT1901 Goals
[.smaller-80] [.smaller-80]
...@@ -56,34 +59,53 @@ Smidig og moderne praksis og konstruksjon ...@@ -56,34 +59,53 @@ Smidig og moderne praksis og konstruksjon
** documentation ** documentation
** code quality ** code quality
== Group work == Tools used in IT1901
In the course we will use several tools:
[.smaller-80]
[%step]
** Git for source code management
** GitLab for collaboration: repository sharing, issue tracking, issue boards, code review ...
** Eclipse Che - automatically spin a workspace that is accessible via a browser to work, collaborate, evaluate ...
** VSCode - recommended IDE to use as it is the same as the gitpod environment
** sdkman - recommended tool to manage JDK and Maven
== Individual and Group work
- there are 3 group deliverables and one individual deliverable - there is one individual development assignment (mandatory to pass to get a grade)
- there are 3 group deliverables
- one individual report
- students will work in groups of 4 - students will work in groups of 4
- fill in the form that will be announced shortly on Blackboard to be assigned to a group - fill in the form announced on Blackboard to be assigned to a group
== Deliverables and tasks == Deliverables and tasks
- go through the available materials
- work on individual assignments
- until you are assigned to a group you must - until you are assigned to a group you must
** set up your development environment ** set up your development environment
** checkout, build and run the simple example ** checkout, build and run the todo list example
https://gitlab.stud.idi.ntnu.no/it1901/course-material/tree/master/simpleexample https://gitlab.stud.idi.ntnu.no/it1901/todo-list
The first task for the group is to select the domain. The first task for the group is to select the domain.
== Timeline == Timeline
[.smaller-80] [.smaller-60]
[%step] [%step]
- week 2 - domain description, first user stories - week 34 - start on individual assignment, intro
- week 3 - Deliverable 1 (10% / group) (Desktop JavaFX application) - week 35 - establish groups and start group work, git++
- week 4 - week 7 - move to REST API backend, modularization, additional feature, ci - week 36 - deliver individual assignment
- week 8 - Deliverable 2 (10% / group) (modular application, REST based backend) - week 38 - Deliverable 1 (10% / group) (basic modular JavaFX application)
- week 9 - week 11 - choose between web client or Android client and implement the new architecture for same domain - week 41 - Deliverable 2 (10% / group) (improved modular application)
- week 12 - Deliverable 3 (50% / group) (final technical) - week 46 - Deliverable 3 (50% / group) (final technical)
- week 13 - Deliverable 4 (30% / individual) Reflection - week 47 - Deliverable 4 (30% / individual) Reflection report
== Deadlines
- the deliverables are due on Thursdays at midnight in the week indicated
- if you are late you need to inform the TA
== Evaluation and feedback == Evaluation and feedback
...@@ -92,18 +114,35 @@ The first task for the group is to select the domain. ...@@ -92,18 +114,35 @@ The first task for the group is to select the domain.
- deliverables 1-3 will be basically snapshots of the repository at given times - deliverables 1-3 will be basically snapshots of the repository at given times
- we will strive to provide quick feedback based on the repo activity - we will strive to provide quick feedback based on the repo activity
== Using AI tools and other resources
- Each group will have to document:
[.smaller-80]
** what tools are used and for what purpose (document)
** snipets of code generated need to reference properly the source (use comments)
** snipets of code copied from stackoverflow or similar need to reference properly the source (use comments)
== About domain selection == About domain selection
- choose an app / service that you know well and select a couple of features to implement during the semester - choose an app / service that you know well and select a couple of features to implement during the semester
- point is to learn by implementing these using the required architectures - point is to learn by implementing these using the required architectures
- we are not looking for quantity but for quality, so just few core features will suffice - we are not looking for quantity but for quality, so just few core features will suffice
== About domain selection (2)
- the chosen app needs to be suitable for a cloud based service
- there must therefore be some dynamic data per user managed by the server.
- eg. a (currency) calculation will NOT fit such a project.
- one good starting point are the cases from the HCI course (MMI)
== Referansegruppe == Referansegruppe
- Trenger 3-5 medlemmer til referansegruppe i faget - Trenger 3-5 medlemmer til referansegruppe i faget
- Mulighet til å påvirke kurset og forbedre kurset for de som skal ta det senere år - Mulighet til å påvirke kurset og forbedre kurset for de som skal ta det senere år
- 3 møter; uke 5, uke 9 og etter kursslutt - 3 møter; uke 5, uke 9 og etter kursslutt
- Ca. en time per møte - over lunch i kantina - Ca. en time per møte
- Meld deg i pausen om du er interessert! - Meld deg i pausen om du er interessert!
- If until next week there are no volunteers we will randomly select 5 students - If until next week there are no volunteers we will randomly select 5 students
...@@ -120,53 +159,32 @@ The first task for the group is to select the domain. ...@@ -120,53 +159,32 @@ The first task for the group is to select the domain.
** Forventninger til den enkeltes bidrag ** Forventninger til den enkeltes bidrag
** Hva som skjer ved avvik eller uenigheter ** Hva som skjer ved avvik eller uenigheter
Gruppekontrakt skal godkjennes av studentassistent, signeres av alle gruppemedlemmer - og leveres sammen med første innlevering Gruppekontrakt skal godkjennes av studentassistent, signeres av alle gruppemedlemmer - og leveres på Blackboard
== Group registration form == Group registration form
[.left] - The form link is on Blackboard
https://bit.ly/2HdMRQi - https://s.ntnu.no/it1901groups
- deadline for answering is on September 1st, 23:59
- in the group form you are expressing preferences
- course staff will make any changes necessary to get the best group composition possible
== Tasks for this week
[.smaller-60]
- fill in the form for group formation
- brush up and revisit Java and JavaFX (useful links on BlackBoard)
- prepare ideas for the project - so you are ready when the groups are done
- prepare your development environment - git, sdkman, vscode, maven etc
- log in to https://gitlab.stud.idi.ntnu.no/
- ask access to https://gitlab.stud.idi.ntnu.no/it1901/students-2024/sandbox and create a test repo
- start with the individual mandatory assignment as soon as it is available (probably tomorrow, latest on Monday morning)
- follow BlackBoard for updates
[.right]
image::../images/lecture01/qrcode-group-registration.svg[width=400]
== ! == !
image::../images/lecture01/teamwork.png[canvas, size=contain] image::../images/lecture01/teamwork.png[canvas, size=contain]
++++
<div id="footer" class="footer"> include::{includedir}footer.adoc[]
<div style="display:table-row;"> \ No newline at end of file
<span class="element" style="width:150px;">
<a href="https://www.ntnu.no" target="_blank">
<img id="footer-logo" class="footer-logo"
src="images/template/logo_ntnu.png"
alt="ntnu logo" height="28"/>
</a>
</span>
<span class="element" style="width:300px;">| IT1901 </span>
<span class="element">| Course Introduction </span>
<span class="element">&nbsp;&nbsp;&nbsp;&nbsp;</span>
</div>
</div>
<div id="vertical-ntnu-name" class="vertical-ntnu-name">
<span class="helper"></span>
<img src="images/template/vertical-ntnu-name.jpg" alt="Norwegian University of Science and Technology" />
</div>
<script type="text/javascript">
window.addEventListener("load", function() {
revealDiv = document.querySelector("body div.reveal")
footer = document.getElementById("footer");
revealDiv.appendChild(footer);
titleSlideDiv = document.querySelector("div.slides section.title")
mainLogo = document.getElementById("main-logo");
titleSlideDiv.prepend(mainLogo);
vertName = document.getElementById("vertical-ntnu-name");
revealDiv.appendChild(vertName);
} );
</script>
++++
\ No newline at end of file
= Git Basics
:customcss: slides.css
:icons: font
:includedir: includes/
:LECTURE_TOPIC: Git Basics
:LECTURE_NO: 2nd lecture
include::{includedir}header.adoc[]
[.smaller-80][.center-paragraph]
IT1901 Fall 2024 - {LECTURE_NO}
== Agenda
[%step]
- Administrative issues
- 1st individual deliverable
- Why Java
- Git
- Summary
[background-color = "#124990"]
[color = "#fff6d5"]
== Administrative issues
== Groups
- fill the form to be assigned to a group
- https://s.ntnu.no/it1901groups
- deadline for answering is on September 1st, 23:59
- will announce the groups in week 36
- 70 % of grade is given by groupwork
== Referansegruppe
- Trenger 3-5 medlemmer til referansegruppe i faget
- Mulighet til å påvirke kurset og forbedre kurset for de som skal ta det senere år
- 3 møter; uke 5, uke 9 og etter kursslutt
- Ca. en time per møte
- Meld deg i pausen om du er interessert!
- If until next week there are no volunteers we will randomly select 5 students
== Getting help
- check BlackBoard
- ask your group TA - list coming soon
== Approaching Deadlines
- Søndag, 1. september / 23:59
** Fill the group form
- Torsdag, 12. september / 23:59
** 1st individual deliverable
** pushed later to week 37
[background-color = "#124990"]
[color = "#fff6d5"]
== 1st individual deliverable
== Læringsmål for øvingen
* grunnleggende git-ferdigheter
* oppsett av java-prosjekt med maven
* sammenheng mellom navn, struktur og innhold
* oppfriskning om javafx og fxml
* generell feilfinning
== Hensikt
Alle skal kunne bidra til prosjektet!!!
== Grunnleggende git-ferdigheter
* opprett kodelager på gitlab - ( use fork )
* klone mal-kodelager (`git clone`)
* lage nye versjoner (`git add` og `git commit`)
* overføre til fjernlager (`git push`)
== Java-prosjektoppsett m/maven
* kildekodemapper og pakkehierarki
** **src/main/java** og **src/main/resources**
** **src/test/java** (og **src/test/resources**)
* pakkehierarki og mappestruktur
** pakkenavn(segmenter) tilsvarer mappestruktur
** både kode og ressurser hører til pakker
** `getClass().getResource(...)`
== Navn, struktur og innhold
* klasser og filer, pakker og mapper
* konfigurasjon i pom.xml
** klassenavn (og modulnavn)
** kommandolinje-argumenter
* **module-info.java**
** modulnavn i deklarasjon og `requires`
** pakkenavn i `exports` og `opens`
== Navn, struktur og innhold
* **pom.xml**
** konfigurasjon av maven-tillegg
** inkl. kjøring av tester og app
** klassenavn (og modulnavn)
** kommandolinje-argumenter
== Oppfriskning om javafx og fxml
[.smaller-80]
* rollefordeling mellom domene- og kontroller-klasse(r)
* kobling mellom fxml og kontroller-klasse
** **fx:id** og **onXyz**-attributter i fxml-fil
** felt og metoder i kontroller-klasse
* programflyt i kontroller
** initiell visning av tilstand
** reaksjon på hendelser
** oppdatering av visning
== Generell feilfinning
[.smaller-80]
* tolke symptomer
** hvorfor reagerer ikke appen?
** hvordan finne ledetråder i "stacktracen"?
** hvorfor kalles ikke metoden?
* løse problemet
** utvikle hypoteser om årsaker
** validere (eller falsifiere) hypoteser
** prøve ut løsninger
== Main steps
[.smaller-80]
- set up the repo in gitlab
** create a project under students-2024
** use the javafx-template as a starting point
- change the template
** project name
** packages
- implement the missing logic
** check by running the tests
[background-color = "#124990"]
[color = "#fff6d5"]
== Why Java
== Java
[.smaller-80]
- in top languages for many years
- general purpose
- "the COBOL of the 21st century"
- great community and tooling
- actively developed
- good job opportunities
- Scala, Kotlin, Groovy, Clojure run on JVM
[background-color = "#124990"]
[color = "#fff6d5"]
== Git
== What is git
Git is a source code management system that is lightweight, reliable, fast and fully distributed.
On top of that it is free and open source. Git was initially authored by Linus Torwalds and emerged from his troubles encountered while trying to manage the contributions to Linux kernel.
include::{includedir}scm_content.adoc[]
== Quizz
- Join at menti.com
- use code 3440 3064
[background-color = "#124990"]
[color = "#fff6d5"]
== Summary
include::{includedir}footer.adoc[]
\ No newline at end of file
= Git++
:customcss: slides.css
:icons: font
:includedir: includes/
:LECTURE_TOPIC: git++
:LECTURE_NO: 2nd lecture
include::{includedir}header.adoc[]
[.smaller-80][.center-paragraph]
IT1901 Fall 2023 - {LECTURE_NO}
== Agenda
[%step]
- Administrative issues
- Git
- Gitlab
- Demo
- 1st individual deliverable
- Summary
[background-color = "#124990"]
[color = "#fff6d5"]
== Administrative issues
== Groups
- fill the form to be assigned to a group
- https://s.ntnu.no/it1901groups
- deadline: Torsdag, 31. august 16:00
- will announce the groups in week 36
- 70 % of grade is given by groupwork
== Referansegruppe
- Trenger 3-5 medlemmer til referansegruppe i faget
- Mulighet til å påvirke kurset og forbedre kurset for de som skal ta det senere år
- 3 møter; uke 5, uke 9 og etter kursslutt
- Ca. en time per møte
- Meld deg i pausen om du er interessert!
- If until next week there are no volunteers we will randomly select 5 students
== Approaching Deadlines
- Torsdag , 31. august 16:00
** Fill the group form
- Torsdag 7. september / 18:00
** 1st individual deliverable
== Getting help
- ask your group TA
- piazza channel - coming up next week
- technical helpdesk - coming up next week
[background-color = "#124990"]
[color = "#fff6d5"]
== Git
== What is git
Git is a source code management system that is lightweight, reliable, fast and fully distributed.
On top of that it is free and open source. Git was initially authored by Linus Torwalds and emerged from his troubles encountered while trying to manage the contributions to Linux kernel.
include::{includedir}scm_content.adoc[]
[background-color = "#124990"]
[color = "#fff6d5"]
== Gitlab
== What is GitLab
Is a complete devops solution that does repository hosting, issue tracking, agile planning, code review, ci/cd and more. It started as an open source project and it still has a community edition which is free and open source
[background-color = "#124990"]
[color = "#fff6d5"]
== Demo
[background-color = "#124990"]
[color = "#fff6d5"]
== Summary
== Next week
- more on git and gitlab
- talk about containers for development
include::{includedir}footer.adoc[]
\ No newline at end of file
= Software Development = Software Development
:customcss: slides.css :customcss: slides.css
:icons: font :icons: font
:includedir: includes/
:LECTURE_TOPIC: Software Development
:LECTURE_NO: 3rd Lecture
include::{includedir}header.adoc[]
++++
<img id="main-logo" class="main-logo" src="images/template/main_logo_eng_no_text.png" width="300" alt="ntnu logo"/>
++++
[.smaller-80][.center-paragraph] [.smaller-80][.center-paragraph]
IT1901 Fall 2019 - 2nd Lecture IT1901 Fall 2020 - 3rd Lecture
[background-color = "#124990"] [background-color = "#124990"]
[color = "#fff6d5"] [color = "#fff6d5"]
...@@ -23,62 +25,44 @@ IT1901 Fall 2019 - 2nd Lecture ...@@ -23,62 +25,44 @@ IT1901 Fall 2019 - 2nd Lecture
[color = "#fff6d5"] [color = "#fff6d5"]
== Administrative issues == Administrative issues
== Feedback == Group registration form
[.left]
Go to: +
app.one2act.no +
Session: +
RIBOO +
[.right]
image::../images/lecture02/qr-app-one2act-no.svg[width=400]
== Example code on gitlab
Have you managed to build and run the example?
- A) Yes
- B) No
- About half of you filled in the form
- deadline to fill in the form is Wednesday, August 26
== Example code on gitlab (2) https://s.ntnu.no/it1901groups
What IDE are you using ? == Individual Assignment 1
- A) Eclipse - Requires that you get access to the it1901/studenter-2020 group
- B) IntelliJ ** in gitlab (request access)
** gets approved within the day / next day
** only about half of you did that
- the exercise is mandatory to get a grade in the course
== Individual Assignment 1 (cont.)
== Example code on gitlab (3) - deadline August 27th
- on BB post the link to the repo
- the main deliverable is the repo itself
Are there any issues encountered ? == Provided materials
- A) no issues - very few students did watch the materials
- B) could not clone the project - they contain important information for assignments
- C) could not build the project - relevant materials for 1st assignment
- D) could not run the project ** gitpod episodes
- E) other issue ** git course
** introduction to gitlab
== !
image::../images/lecture02/groups-padding.png[canvas, size=contain]
== Reference Group == Reference Group
- Tommy Chan - Trenger 3-5 medlemmer til referansegruppe i faget
- Vivi Cecilie Galschiødt Svendsen - Mulighet til å påvirke kurset og forbedre kurset for de som skal ta det senere år
- Johan Ludvig Holst - 3 møter / Ca. en time per møte
- Aksel Kirknes - Meld deg om du er interessert! (email / chat / group registration form)
- Aksel Saugestad - If there are not enough volunteers we will randomly select the rest
- Lars-Olav Vågene
== Deliverable 1
- each student group has assigned a group (folder) in gitlab gr19xx
- in the folder there is a repository with name gr19xx which will be used for delivering the code
- deadline September 9th, 2019
- group contract has deadline on September 3rd, 2019
[background-color = "#124990"] [background-color = "#124990"]
...@@ -109,15 +93,6 @@ Engineering refers to the practice of organizing the design and construction of ...@@ -109,15 +93,6 @@ Engineering refers to the practice of organizing the design and construction of
[.smaller-60] [.smaller-60]
Rogers, G.F.C. (1983) Rogers, G.F.C. (1983)
== Exercise
[.smaller-60]
Engineering refers to the practice of organizing the design and construction of any artifice which transforms the physical world around us to meet some recognized need. Rogers, G.F.C. (1983)
- Discuss with a colleague sitting next to you. Look at Rogers’ definition of engineering. How would you relate elements of that definition to your understanding of software development?
[.smaller-40]
Adapted from _An introduction to software development (Open University)_
[background-color = "#124990"] [background-color = "#124990"]
...@@ -181,20 +156,6 @@ https://www.visual-paradigm.com/scrum/what-is-sprint-in-scrum/ ...@@ -181,20 +156,6 @@ https://www.visual-paradigm.com/scrum/what-is-sprint-in-scrum/
Software quality is the degree to which a software solution meets the design requirements and the user needs and expectations. Software quality is the degree to which a software solution meets the design requirements and the user needs and expectations.
== Feedback
[.left]
Go to: +
app.one2act.no +
Session: +
RIBOO +
[.right]
image::../images/lecture02/qr-app-one2act-no.svg[width=400]
== Exercise
- Discuss with the colleague next to you about what properties influence software quality.
- Type 3-5 keywords that you consider to be most important.
== Quality attributes == Quality attributes
...@@ -226,9 +187,9 @@ image::../images/lecture02/qr-app-one2act-no.svg[width=400] ...@@ -226,9 +187,9 @@ image::../images/lecture02/qr-app-one2act-no.svg[width=400]
== SCM Tools == SCM Tools
- CVS - CVS (Concurrent Versioning System, released 1990)
- SVN - SVN (Apache Subversion, released 2000)
- Git - Git (created by Linus Torvalds , released 2005)
- Mercurial - Mercurial
...@@ -283,13 +244,6 @@ image::../images/git-repo-commands.png[width="500px"] ...@@ -283,13 +244,6 @@ image::../images/git-repo-commands.png[width="500px"]
* `git pull` - henter andres endringer, i tilfelle konflikt * `git pull` - henter andres endringer, i tilfelle konflikt
* `git push` - deler endringer med andre via serveren * `git push` - deler endringer med andre via serveren
== Exercise
- Go to your group repository
- https://gitlab.stud.idi.ntnu.no/it1901/gr19xx
- add any members that might not have access
- modify the readme and add your name in a list
== Forgreining (branching) == Forgreining (branching)
[.smaller-60] [.smaller-60]
...@@ -441,39 +395,5 @@ Automatisering av alt som fremmer kvalitet, men som tar tid, f.eks. ...@@ -441,39 +395,5 @@ Automatisering av alt som fremmer kvalitet, men som tar tid, f.eks.
image::../images/lecture02/doad.jpg[canvas, size=contain] image::../images/lecture02/doad.jpg[canvas, size=contain]
++++
<div id="footer" class="footer"> include::{includedir}footer.adoc[]
<div style="display:table-row;"> \ No newline at end of file
<span class="element" style="width:150px;">
<a href="https://www.ntnu.no" target="_blank">
<img id="footer-logo" class="footer-logo"
src="images/template/logo_ntnu.png"
alt="ntnu logo" height="28"/>
</a>
</span>
<span class="element" style="width:300px;">| IT1901 - 2nd lecture </span>
<span class="element">| Software Development </span>
<span class="element">&nbsp;&nbsp;&nbsp;&nbsp;</span>
</div>
</div>
<div id="vertical-ntnu-name" class="vertical-ntnu-name">
<span class="helper"></span>
<img src="images/template/vertical-ntnu-name.png" alt="Norwegian University of Science and Technology" />
</div>
<script type="text/javascript">
window.addEventListener("load", function() {
revealDiv = document.querySelector("body div.reveal")
footer = document.getElementById("footer");
revealDiv.appendChild(footer);
titleSlideDiv = document.querySelector("div.slides section.title")
mainLogo = document.getElementById("main-logo");
titleSlideDiv.prepend(mainLogo);
vertName = document.getElementById("vertical-ntnu-name");
revealDiv.appendChild(vertName);
} );
</script>
++++
\ No newline at end of file
= Software Development
:customcss: slides.css
:icons: font
:includedir: includes/
:LECTURE_TOPIC: Software development
:LECTURE_NO: 3rd lecture
include::{includedir}header.adoc[]
[.smaller-80][.center-paragraph]
IT1901 Fall 2020 - 3rd Lecture
include::{includedir}dev_content.adoc[]
include::{includedir}footer.adoc[]
\ No newline at end of file
= Git, GitLab and development environment
:customcss: slides.css
:icons: font
:includedir: includes/
:LECTURE_TOPIC: Git, GitLab and development environment
:LECTURE_NO: 3rd lecture
include::{includedir}header.adoc[]
[.smaller-80][.center-paragraph]
IT1901 Fall 2024 - {LECTURE_NO}
== Agenda
[%step]
- Administrative issues
- Git
- Gitlab
- Developmennt environment
- Summary
[background-color = "#124990"]
[color = "#fff6d5"]
== Administrative issues
== Groups
- groups will be finalized this week
- there will be a BlackBoard group and a GitLab group assigned for each team of students
- issues - contact Talha Mahboob Alam talha.m.alam@ntnu.no
== Referansegruppe
[.smaller-60]
- established - 1st meeting next week
- members
** Vebjørn Liland Drefvelin vebjorld@stud.ntnu.no Informatikk
** Jessica Shuyue Liu jessicsl@stud.ntnu.no Datateknologi
** Kristoffer Welle kristwel@stud.ntnu.no Datateknologi
** Erling Kvalvik Eriksen erlingke@stud.ntnu.no Lektorutdanning i realfag
== 1st Group deliverable
- start working on selecting the project as soon as your group is ready
- prepare group contract
- read carefully the instructions
== Approaching Deadlines
- Torsdag, 12. september / 23:59
** 1st individual deliverable
- Torsdag, 19. september / 23:59
** 1st group deliverable
- Torsdag, 19. september / 23:59
** group contract
== Getting help
- ask your group TA
- Q and A sessions every Thursday starting week 37
- some lectures will also Q and A sections
- technical help - more info coming soon
[background-color = "#124990"]
[color = "#fff6d5"]
== Git
== What is git
Git is a source code management system that is lightweight, reliable, fast and fully distributed.
On top of that it is free and open source. Git was initially authored by Linus Torwalds and emerged from his troubles encountered while trying to manage the contributions to Linux kernel.
[.grid-left-right-50-50]
== Typical sequence (share project)
[.area-left][.smaller-60]
- starting a project and sharing it on Gitlab for team collaboration
** `git init`
** `git status`
[.area-right][.smaller-60]
** `git add ...`
** `git commit ...`
** `git remote ...`
** `git push`
== Commit messages
image::../images/git_commit_2x.png[size=75%]
[.smaller-40]
https://xkcd.com/1296/
== Commit messages (seriously)
- Separate subject from body with a blank line
- Limit the subject line to 50 characters
- Capitalize the subject line
- Do not end the subject line with a period
- Use the imperative mood in the subject line
- Wrap the body at 72 characters
- Use the body to explain what and why vs. how
[.grid-left-right-50-50]
== Typical sequence (simple collaboration)
[.area-left][.smaller-60]
- working with a shared project
** `git clone`
** `git pull`
[.area-right][.smaller-60]
** `git status`
** `git add ...`
** `git commit ...`
** `git push`
== Typical sequence (with branching)
- working with branches
** `git pull`
** `git checkout -b <branch_name>`
** `git status` + `git add ...` + `git commit ...`
** `git checkout master`
** `git merge <branch_name>`
[background-color = "#124990"]
[color = "#fff6d5"]
== Gitlab
== What is GitLab
Is a complete devops solution that does repository hosting, issue tracking, agile planning, code review, ci/cd and more. It started as an open source project and it still has a community edition which is free and open source
[background-color = "#124990"]
[color = "#fff6d5"]
== Development environment
== Sdkman
- tool allowing managing several versions of frameworks and development kits
- works on linux, mac and windows (with some convincing)
- manage several Java versions and or Maven versions
- easily install different flavours and releases
== Typical development environment for the course
- VSCode + relevant extensions
- git
- sdkman - get Java 17.0.xx-tem and Maven 3.9
== Services used
- GitLab - https://gitlab.stud.idi.ntnu.no/
- Eclipse Che - https://che.stud.ntnu.no/
== Levels and approaches to the development environment for the course
- use the local machine - install on your OS
- use a virtual machine (e.g. VirtualBox)
- use a container (Docker Desktop + VSCode)
- use the cloud IDE (Eclipse Che + browser)
[background-color = "#124990"]
[color = "#fff6d5"]
== Summary
include::{includedir}footer.adoc[]
\ No newline at end of file
= Build tools
:customcss: slides.css
:icons: font
:includedir: includes/
:LECTURE_TOPIC: Build tools
:LECTURE_NO: 4th lecture
include::{includedir}header.adoc[]
[.smaller-80][.center-paragraph]
IT1901 Fall 2024 - {LECTURE_NO}
== Agenda
[%step]
- Administrative issues
- 1st Group Exercise
- Build tools
- More on development environment
** VSCode extensions
** Eclipse Che
- Agile Practices
- Summary
[background-color = "#124990"]
[color = "#fff6d5"]
== Administrative issues
== Groups
- groups have been established
- each student team got a BlackBoard group and a GitLab group
- the GitLab group contains the "standard" repository
- check if you are properly assigned to your group
== Approaching Deadlines
- Torsdag, 12. september / 23:59
** 1st individual deliverable
- Torsdag, 19. september / 23:59
** 1st group deliverable
- Torsdag, 19. september / 23:59
** group contract
== Getting help
- ask your group TA
- Q and A sessions every Thursday starting week 37
- some lectures will also Q and A sections
- technical help - helpdesk on teams starting next week
== !
image::../images/lecture04/overview.png[canvas, size=contain]
[background-color = "#124990"]
[color = "#fff6d5"]
== 1st Group Exercise
== Start group work
- finish and deliver the group contract
- discuss and select domain / aplication for group project
- discuss and agree on workflow, meetings etc
- set up your gitlab workspace and repository
- plan the sprint / iteration for the first deliverable
== About domain selection
- choose an app / service that you know well and select a couple of features to implement during the semester
- point is to learn by implementing these using the required architectures
- we are not looking for quantity but for quality, so just few core features will suffice
== About domain selection (2)
- the chosen app needs to be suitable for a cloud based service
- there must therefore be some dynamic data per user managed by the server.
- eg. a (currency) calculation will NOT fit such a project.
- one good starting point are the cases from the HCI course (MMI)
== 3 step release plan
- Minimal application
- Application with more features / improved quality
- Final technical – client server / REST API / more features / alternative client
== Minimal application
- a simple app is created with JavaFX and FXML, with relatively minimal functionality
- can save data to a file and start up again where it left off
- divided into separate modules
- good point to start could be the modules-template (from the individual exercise)
** one can also use the todo list example as inspiration
== Requirements (1)
- project must be in the group repo in gitlab
- documentation for each release is placed in a separate folder
** 1st deliverable (release)- `...groups-2024/gr24nn/gr24nn/docs/release1`
- a milestone in Gitlab should refer to the corresponding documentation and issues
== Requirements (2)
- project must build with Maven
- one root level README.md in the repo to describe the content
- another README.md file (use links) must describe expected application functionality (use at least a screen mockup / screenshot)
- there must also be at least one user story
- there must be corresponding issues in Gitlab
== Requirements (3)
- you must reference the issues in the commits
- configure Maven so that
** application runs with `mvn javafx:run`
** test can run using `mvn test`
- the build must report test coverage ( > 0% )
== Requirements (4)
- there must be at least something in each of the three architecture layers
** domain logic, user interface (JavaFX-GUI) and persistence
- project should be configured to open and run in eclipse che (link in README.md)
== Requirements (5)
- Readme.md file should include a section where requirements are specified - versions for Java, Maven, dependencies etc.
- Document usage of AI-tools. Why and what / why not
** (...groups-2024/gr24nn/gr24nn/docs/release1/ai-tools.md).
- any code taken / generated needs to reference the source in a comment
== Application description
- General description included in readme.md file
- user stories supported by additional design documents such as:
** conceptual model,
** personas,
** scenarios,
** UI mockups,
** UI protoypes
- User stories get broken down into issues and tasks
- Lead to a functional application
[background-color = "#124990"]
[color = "#fff6d5"]
== Build Tools
== Build tools (1)
[%step]
- Automate the process of building executable programs from source files
- Packaging binaries required for deployment / distribution
- Run automated tests
== Build tools (2)
[%step]
- Build automation is a necessity to enable CI/CD
- Remove the need to do redundant tasks
- Improve quality of the software
** the software builds are prepared in a consistent and predictable manner
** possible to have data to analyze issues and improve
== Make (1)
[%step]
- Designed by Stuart Feldman
- Released in 1976
- Uses makefiles to describe the actions required to produce the build
- Manages dependencies
[.smaller-40]
https://en.wikipedia.org/wiki/Make_(software)
== Make (2)
[%step]
- Has been rewriten a number of times
- Standard modern implementation is GNU Make
- Used in Linux and Mac OS
== Java world build tools
- Ant with Ivy
- Maven
- Gradle
== Apache ANT
[%step]
- modern build system
- released in 2000
- build files use XML
** tends to get unmanageable even for small projects
- Apache Ivy for managing dependencies (added later)
** download over network
[.smaller-40]
http://ant.apache.org
== Apache Maven (1)
[%step]
- released in 2004
- improves on ANT
- build files use also XML but the structure is radically different
- dependency management with automatic downloading over the network is available from release
[.smaller-40]
http://maven.apache.org
== Apache Maven (2)
[%step]
- hides complexity in build files through plugins
- customizing is hard
- dependency management has issues with conflicting versions of same library
[background-color = "#124990"]
[color = "#fff6d5"]
== Gradle
== Gradle (1)
[%step]
- released in 2012
- build scripts are written in a domain specific language based on Groovy
** Groovy ( http://www.groovy-lang.org/ )
- the build script is named `build.gradle`
- build steps are called "tasks"
[.smaller-40]
https://gradle.org
== Gradle (2)
[%step]
- easy to create own tasks
- uses plugins to hide complexity
- applying plugins allows access to additional tasks
== Gradle (3)
[.center-paragraph]
image::../images/lecture03/gradle-tree.png[width=700]
[.smaller-40]
https://guides.gradle.org/creating-new-gradle-builds/
[background-color = "#124990"]
[color = "#fff6d5"]
== More on Maven
== Maven (3)
* manages builds, dependencies, versions
* configuration file is `pom.xml`
* has good IDE support
* central repository(ies) for dependencies
== Maven - pom.xml
* modelVersion (4.0.0) config file format version
* groupId - ID of group owning the project
* artifactId - name of the final output
* version - version of the created artifact
== Maven - pom.xml (cont.)
* dependencies - list of artifacts we depend upon
* packaging - e.g. .jar (Java archive)
* description
https://maven.apache.org/pom.html#Quick_Overview
== Maven dependencies
* list of dependencies
* each dependecy has specified
** groupId
** artifactId
** version (optional, good to have)
** scope (default is `compile`)
== Maven build lifecycles
[.smaller-60]
* clean
* site
* default
** validate
** compile
** test
** package
** verify
** install
** deploy
== Maven plugins
* add functionality
* connected to a certain lifecycle phase
* provide additional goals
[background-color = "#124990"]
[color = "#fff6d5"]
== More on development environment
[background-color = "#124990"]
[color = "#fff6d5"]
== VSCode extensions
[background-color = "#124990"]
[color = "#fff6d5"]
== Eclipse Che
[background-color = "#124990"]
[color = "#fff6d5"]
== Agile Practices - Scrum
== User stories
[.smaller-80]
- short, simple descriptions for application features
- formulated from the stand point of the user / customer
- template:
** As a **< type of user >**, I want **< some goal >** so that **< some reason >**.
- they are not replacing design documents / requirements specification
- they need to be developed into specific tasks and connected to constraints and other meaningful documentation.
== Sprints
- meaningful iterations of comparable length
- they should have a clear goal
== Planning releases
- 3 deliverables - map to releases
- a release should produce a minimum viable product (MVP)
** a MVP is a version of an application with just enough features to be usable in getting feedback to guide the development process
== Meetings
- regular stand-up meetings (synchronize and commit, remove hindrances)
- retrospectives (reflect on your group work)
- sprint reviews / demos (invite TA, prepare deliverables)
[background-color = "#124990"]
[color = "#fff6d5"]
== Summary
include::{includedir}footer.adoc[]
\ No newline at end of file
= SCM - Git demo
:customcss: slides.css
:icons: font
:includedir: includes/
:LECTURE_TOPIC: Git demo
:LECTURE_NO: 4th lecture
include::{includedir}header.adoc[]
[.smaller-80][.center-paragraph]
IT1901 Fall 2020 - {LECTURE_NO}
[background-color = "#124990"]
[color = "#fff6d5"]
== Git demo
== Installing and setting up git
- Go to https://git-scm.com/downloads
- Download and install the right version for your OS
- git commands are now available
[.grid-left-right-50-50]
== Typical sequence (share project)
[.area-left]
- starting a project and sharing it on Gitlab for team collaboration
** `git init`
** `git status`
[.area-right]
** `git add ...`
** `git commit ...`
** `git remote ...`
** `git push`
== Commit messages
image::../images/git_commit_2x.png[size=75%]
[.smaller-40]
https://xkcd.com/1296/
== Commit messages (seriously)
- Separate subject from body with a blank line
- Limit the subject line to 50 characters
- Capitalize the subject line
- Do not end the subject line with a period
- Use the imperative mood in the subject line
- Wrap the body at 72 characters
- Use the body to explain what and why vs. how
[.grid-left-right-50-50]
== Typical sequence (simple collaboration)
[.area-left]
- working with a shared project
** `git clone`
** `git pull`
[.area-right]
** `git status`
** `git add ...`
** `git commit ...`
** `git push`
== Conflicts (1)
** when same files (lines) are changed by different devs
** automatic merge is not possible
** we need to solve that to be able to push our changes
== Conflicts (2) - Setup
- `git config merge.tool vimdiff`
- `git config merge.conflictstyle diff3`
- `git config mergetool.prompt false`
== Conflicts (3) - Solving
- `git mergetool`
- `:wqa` save and exit from vi
- `git commit -m "message"`
- `git clean` remove file (might remove other untracked files)
== Typical sequence (with branching)
- working with branches
** `git pull`
** `git checkout -b <branch_name>`
** `git status` + `git add ...` + `git commit ...`
** `git checkout master`
** `git merge <branch_name>`
include::{includedir}footer.adoc[]
\ No newline at end of file