Sustainable Software Development in an Academic Setting€¦ · 2 Hartwig Anzt: Sustainable...

KIT – The Research University in the Helmholtz Association

Hartwig Anzt, Terry Cojean, Thomas Grűtzmacher, Pratik Nayak, Mike TsaiSteinbuch Centre for Computing (SCC)

www.kit.edu

SustainableSoftwareDevelopmentinanAcademicSetting4thInternationalSymposium onResearchandEducationofComputational Science(RECS)University ofTokyo,October1st,2019

Theseslidesareavailableunder:https://hartwiganzt.github.io/slides/SustainableSoftwareDevelopment.pdf

2 10/01/2019Hartwig Anzt:SustainableSoftwareDevelopmentinanAcademicSetting

What we cover today

• Versioningsystems

• Git workflow

• Git hostingsites

• Continuous Integration(CI)

• GitLab runners

• AutomatedTesting

• UnitTestingwithGoogletest

• SoftwareDocumentationwithDoxygen

Tointeractivelyparticipate inthiscourse,youneedaGitLab account.

• Pleasecreateanaccount(chooseyournamecarefully!)• Pleaselogin• https://gitlab.com/

PratikNayakTerryCojean ThomasGrützmacher

TobiasRibizel

Interactivewebinarwiththehelpof

Forcompleteinteractiveparticipation(onLinuxSystems):

apt-get install git cmake g++ gcovr

MikeTsai

What is a version control system?

Versioncontrolsystemfortrackingchangesincomputerfiles.

What is a version control system?

• Distributedversioncontrol

• Coordinatesworkbetweenmultipledevelopers

• Whomadewhatchangesandwhen

• Revertbackatanytime

• Localandremoterepos

Versioncontrolsystemfortrackingchangesincomputerfiles.

ü Keepstrackofcodehistory

ü Takes“snapshots”ofyourfiles

ü Youdecidewhentotakeasnapshot bymakinga”commit”

ü Youcanvisitanysnapshotatanytime

Git Versioning System

Ø git init //Initializelocalgit repository

Ø git add*files //Addfile(s)tosnapshot

Ø git status //Checkchangesnotyetinthesnapshot

Ø git commit*files //Takesnapshot (commitchanges)Ø git commit–m‘putacommentonthiscommit’*files

Git CheatSheet:https://www.git-tower.com/blog/git-cheat-sheet/

LocalRepository

Ø git push //Pushlocalsnapshotstoremoterepo

Ø git pull //Getlatestsnapshot fromremoterepo

Ø git clone*path/to/repo //CloneanexistingremoterepositoryRemoteRepository

LocalRepository

Git Hosting Sites

• GitHub

• GitLab

• Bitbucket

• … https://en.wikipedia.org/wiki/Comparison_of_source-code-hosting_facilities

WemayjustchooseGitLab forthiscourse• Pleasecreateanaccount(chooseyournamecarefully!)• Pleaselogin• https://gitlab.com/

Theyoffertheenvironmentfortheremoterepository.

Git Hands-On

1. WecreateanAccountatGitLab andlogin.

2. IcreateaprojectonGitLab (\git@gitlab.com:hanzt/recs)

3. Iaddafirstsourcefileandmakeitapublicrepository

4. Youallcloneortheproject:

git clone git@gitlab.com:hanzt/recs

5. Youaddyournametothelocalversionofcontributors.txt

6. Youcheckyourchanges:

git diff

7. Youcommityour localchanges:

git commit –m ‘add my name’ contributors.txt

8. Youpushyourlocalchangestotheremoterepository:

git push origin master

9. Youfix”mergeconflicts”….

Continuous Integration (CI)

• Howdoyoufindoutthecodeisbroken?• Howdowefindoutwhowhichcode

integration introducedthebug?• Howcanwemakesureeverythingworks

atanypointintime?

Sometimes,someoneintroducesabugthatbreaksthecode…

Continuous Integration (CI)

Weneedamechanismthatconstantlychecksthefunctionalityofthemaster“branch”.

ContinuousIntegration

• Howdoyoufindoutthecodeisbroken?• Howdowefindoutwhowhichcode

integration introducedthebug?• Howcanwemakesureeverythingworks

atanypointintime?

Sometimes,someoneintroducesabugthatbreaksthecode…

• Setsupapre-definedenvironment;

• Clonestheremoterepositoryonaserver;

• Triestocompileandrunallpre-definedtests;

• Reportstheoutcome;

Continuous Integration on GitLab

• GitLab supportsGitLab runnersasCIfeature.

• Theycanbeconfiguredviaaddingthefile.gitlab-ci.yml

https://docs.gitlab.com/ee/ci/yaml/

• GitLab runneraresetupviawebinterface.

example.gitlab-ci.yml

LoadimageofOS

UpdateOS

Installpackagesneeded:git cmake g++gcovr

Createdirectory

CallCMake

Buildlibrarygcov checksunittestcoverage

Software TestingAutomatedtesting:Thepracticeofwritingcodetotestthecode,andthenrunthosetestsinanautomatedfashion.

ProductionCode TestCode

Integrationtests:Checktheapplicationsfunctionalitywithitsexternaldependencies.

• Givemoreconfidenceincomplexapplication.• Testsunits/classesaswhole.

End-to-Endtests:Checktheapplicationsfunctionalitywithitsexternaldependenciesanduserinput.

• Testcompleteworkflowandapplicationinteraction.• Veryslowandbrittle.

Unittests:Checkthefunctionalityandvalidityofeachbuildingblockwithout itsexternaldependencies.

• Trackdownbugs

Many.Easy-to-write.ExecuteFast.

• Trackdownbugs

Fewer.Dependencies.

• Trackdownbugs

Few.Complex.

Fewer.Dependencies.

Unit tests with Googletest

• Frameworktofacilitateunittesting.

• https://github.com/google/googletest

Let’sdoanexample.

Muchofthismaterialistakenfrom NikolaosPothitoshttp://cgi.di.uoa.gr/~pothitos/https://github.com/pothitos/gtest-demo-gitlab

Software Documentation

• Automatedcodedocumentationtool.

• Convertscommentsinsourcecodeintodocumentation.

• HTML-oriented.

• http://www.doxygen.nl/

• https://github.com/doxygen/doxygen.git

Doxygen is the de facto standard tool for generatingdocumentation from annotated C++ sources, but it alsosupports other popular programming languages such as C,Objective-C, C#, PHP, Java, Python, IDL (Corba, Microsoft, andUNO/OpenOffice flavors), Fortran, VHDL, Tcl, and to someextent D.

Example:https://www.dealii.org/current/doxygen/deal.II/classTorusManifold.html

References & Further Reading

https://bssw.io/

• https://www.git-tower.com/blog/git-cheat-sheet/• https://github.com/google/googletest• https://github.com/pothitos/gtest-demo-gitlab• https://docs.gitlab.com/ee/ci/yaml/• http://www.doxygen.nl/

Theseslidesareavailableunder:https://hartwiganzt.github.io/slides/SustainableSoftwareDevelopment.pdf

Sustainable Software Development in an Academic Setting€¦ · 2 Hartwig Anzt: Sustainable...

Documents

Transcript of Sustainable Software Development in an Academic Setting€¦ · 2 Hartwig Anzt: Sustainable...

Reviewing Resumes: Ranking and Selecting Candidates in an Academic Setting,

SETTING HIGH ACADEMIC EXPECTATIONS · Lemov c01.tex V3 - 02/08/2010 12:05pm Page 29 Setting High Academic Expectations 29 Reluctant students quickly come to recognize that ‘‘I

The Development of Organizational Memory Information System in Academic Setting

Mobile Health Services in an Academic Setting

In a academic library setting, users of digital library services seeking

Too high or too low? Setting the right IELTS score for academic

LinguaFolio Goal Setting Intervention and Academic ... · 2 LINGUAFOLIO GOAL SETTING INTERVENTION AND ACADEMIC ACHIEVEMENT: INCREASING STUDENT CAPACITY FOR SELF-REGULATED LEARNING

Strategies for Setting High-Quality Academic Individualized … · 2020-07-31 · Strategies for Setting High-Quality Academic Individualized Education Program Goals Author: Tessie

Mindful Consultants Academic Setting Services Brochure

Strategies for Setting High-Quality Academic ... · Strategies for Setting High-Quality Academic Individualized Education Program Goals Tessie Rose Bailey, PhD, and Zachary Weingarten,

Setting Priorities for the 2007-08 Academic Year

Academic Planning and Goal Setting Lesson Plan€¦ · Academic Planning and Goal Setting Lesson Plan School Counselor: Susan Russo Date: May 9,16, 23, 28 (2018) Activity: Academic

Export Controls: How to stay compliant in an academic medical setting.

NEEO 16 European academic research libraries setting-up a subject-oriented portal

SETTING HIGH ACADEMIC EXPECTATIONS

Setting High Academic Expectations that Ensure Academic Achievement TEAM PLANNING STANDARDS & OBJECTIVES TEACHER CONTENT KNOWLEDGE.

Setting Priorities for the 2007-08 Academic Year Carl R. Lovitt August 2007.

Strategy and Project Management in the Academic Setting

Pinterest in an academic setting

Students with MS & the Academic Setting · Students with MS and the Academic Setting: A Handbook for School Personnel, is made possible through a ... There is only one medication