Pieter van den Hombergh. September 9, 2015

Transcription

1 Pieter van den Hombergh Fontys Hogeschool voor Techniek en Logistiek September 9, 2015 /FHTenL September 9, /27

2 My Helpers, Tobias Derksen (DE) and me, Pieter van den Hombergh You will see the students as student helpers during practicum hours on some subject. /FHTenL September 9, /27

3 Table of contents fontys venlo(.org) /FHTenL September 9, /27

4 Playing in a sandbox /FHTenL September 9, /27

5 Subversion is a version control system Version control is: Managing different versions of (source code) documents without keeping multiple copies or using silly names. Being able to choose any earlier version. Pick a set of files with the same version. Select versions by date-time stamp. Keep development and production properly separated. Share documents (source code) with team members (and teachers). Peaceful cooperation; working in a sandbox. History cannot be changed. Backup. Logging of actions and authorship. /FHTenL September 9, /27

6 Subversion is the tool of choice to Hand in work during exams. (USB stick). Hand work in practicum with e.g. Java, DBS1. Share work with peer students in project, e.g. Project 1. /FHTenL September 9, /27

7 Subversion is not the only version control system around and not even the best, if there is such thing. However: It is (relatively) easy to use, both for students and teachers. Supports partial checkout (as in part of the project to a web dir). Is well supported with tools: analysis of contribution of members (student projects!). The teachers at SEBI Venlo manage and control it which is important for validity. It is easy to get your own personal repo, to play with or other study related work. Google Drive, Sky Drive, One Drive, DropBox and alike are not Systems 1. They are useful for sharing but not for serious software development work. 1 They do some limited versioning, but e.g. no tagging or branching. /FHTenL September 9, /27

8 Creating your repository Know your host, e.g. Can be localhost too. We use the ssl/https protocol to access the server. The url has the form You can create your personal using peerweb. Visit isubversionrepos.php demo /FHTenL September 9, /27

9 SVN Urls When using svn on fontys venlo you will use several repositories, each with their won url. project or module The url start with as in personal The url starts with as in /FHTenL September 9, /27

10 Configure your repository Know your host url: plus url-tail. Have a plan 2 : Your project needs documents for analysis, design a directory for source code and for the user documentation. doc/analysis Here you would store all analysis artefacts doc/design Here you would store all your design stuff sources Sources code (.java), html, pictures etc. all used in the software product. doc/usermanual The documentation that goes with the software to the user. How to install and use your wonderful product. 2 The proposed subdirs are for a tiny project only. /FHTenL September 9, /27

11 Checking your repository Check if things are there: svn ls htps:// You could now delete your temp directory that you used for the import. Now make a first checkout of your repository: Change to a working directory (your sandbox): cd /home/username/work Command: svn co htps:// sen1 /FHTenL September 9, /27

12 Using your repository Use a nice text editor to edit a new file e.g. uc1-ts1.txt. Add this file to the scenarios directory. File could have the following content: Use Case 1: Add new customer 1. Employee enters following data : 2. Name : " Eric Idle " 3. Address : " Python close 13" 4. City : " Fawlty Towers " 5. Employee submits data. 5. System replies : " New customer added " /FHTenL September 9, /27

13 Using your repository First tell subversion to add this file: svn add uc1-ts1.txt Put the file in your repository: svn commit -m testscenario 1 for use case 1 added Subversion will respond with a message: Adding scenarios/uc1-ts1.txt Transmitting file data. Committed revision 2. Make changes to your file. Commit the new version: svn commit -m your comment on this change Anybody with sufficient rights can now obtain the files from the repository /FHTenL September 9, /27

14 It is quite all right to Create repositories. One for each project/module is best. Share repositories with fellow students in a project group. Put (as in add and commit) text files (HTML, CSS, Java Code L A TEX files, SQL scripts) etc in a repository. Commit often. Put in files that you created and find precious. Peerweb and the peerweb created repositories provide a shared service, used by all Fontys Venlo Informatics students. Sharing means being polite in usage and claiming. /FHTenL September 9, /27

15 As in consider forbidden Forbidden Put spaces in file and directory names in the repository. Actually a real homo informaticus will never use these characters in file and directory names, not even when creating.docx files or spreadsheets. Add files or documents (as in books) that you found else where. Typically these are pdf files.. Commit compiler produced stuff. Add your Windows Desktop to a repository and then commit that.. A repository is not a backup service. Add and commit a virtual machine image to a repository. All the don ts on this page have been committed by students in earlier years. /FHTenL September 9, /27

16 If you need to share with a teacher... Personal or module bound In many modules, certainly projects and modules with a practicum, the teacher will create a repository for you. In this case it is mandatory that you use the repository provided by the teacher. In other cases it is up to you. /FHTenL September 9, /27

17 Commit often but planned Commit often. Example: 1 Implement one test + method. 2 Build and test. 3 If build and tests succeed, commit. 4 Then move to the next test+function. Never commit stuff that does not compile. Try to avoid committing code that does not meet it s tests. If you cannot avoid this, commit on a branch. /FHTenL September 9, /27

18 Commit often but planned, Cont d. your commits. See how much time you have left before you planned to stop and clean your desk. If there is enough time left to implement another function in the way shown, do it 3. Otherwise clean up your desk: Check that the repository has all that is needed to build what you produced in the previous period: 1 Make a new sandbox, e.g. mkdir /buildtest. Checkout your stuff (from the correct branch). 2 Build there. If pieces are missing, commit them in from your workspace. Cleaning your desk takes time also. for at least 5 minutes at the end of your working period/session. 3 Assume that one function+test takes at least 15 minutes /FHTenL September 9, /27

19 Commit often but planned, Cont d. your commits. See how much time you have left before you planned to stop and clean your desk. If there is enough time left to implement another function in the way shown, do it 3. Otherwise clean up your desk: Check that the repository has all that is needed to build what you produced in the previous period: 1 Make a new sandbox, e.g. mkdir /buildtest. Checkout your stuff (from the correct branch). 2 Build there. If pieces are missing, commit them in from your workspace. Cleaning your desk takes time also. for at least 5 minutes at the end of your working period/session. 3 Assume that one function+test takes at least 15 minutes /FHTenL September 9, /27

20 Commit often and planned, Cont d. Never leave before you cleaned your desk. This leaves the repository in a stable state, making it possible to continue your work from any place by any project member. /FHTenL September 9, /27

21 To lock or not to lock subversion allows you to open and edit the same file by multiple developers. /FHTenL September 9, /27

22 To lock or not to lock subversion allows you to open and edit the same file by multiple developers. For source code (java, Csharp, php etc) this is not a real problem as modern version control systems are powerful when it comes to helping with merge conflicts. /FHTenL September 9, /27

23 To lock or not to lock subversion allows you to open and edit the same file by multiple developers. For source code (java, Csharp, php etc) this is not a real problem as modern version control systems are powerful when it comes to helping with merge conflicts. In some cases (typically: binary files like.png pictures), you should not use this feature. You might step on each others hands. Note that this applies to e.g. word.doc files too! /FHTenL September 9, /27

24 To lock or not to lock subversion allows you to open and edit the same file by multiple developers. For source code (java, Csharp, php etc) this is not a real problem as modern version control systems are powerful when it comes to helping with merge conflicts. In some cases (typically: binary files like.png pictures), you should not use this feature. You might step on each others hands. Note that this applies to e.g. word.doc files too! You can announce to the subversion server that you want to change (edit) a file with the svn lock command. /FHTenL September 9, /27

25 To lock or not to lock subversion allows you to open and edit the same file by multiple developers. For source code (java, Csharp, php etc) this is not a real problem as modern version control systems are powerful when it comes to helping with merge conflicts. In some cases (typically: binary files like.png pictures), you should not use this feature. You might step on each others hands. Note that this applies to e.g. word.doc files too! You can announce to the subversion server that you want to change (edit) a file with the svn lock command. Use the svn status command to find out which files are being edited by your fellows. /FHTenL September 9, /27

26 To lock or not to lock subversion allows you to open and edit the same file by multiple developers. For source code (java, Csharp, php etc) this is not a real problem as modern version control systems are powerful when it comes to helping with merge conflicts. In some cases (typically: binary files like.png pictures), you should not use this feature. You might step on each others hands. Note that this applies to e.g. word.doc files too! You can announce to the subversion server that you want to change (edit) a file with the svn lock command. Use the svn status command to find out which files are being edited by your fellows. Only lock one or a few files at a time. This to enable other to work on other files. /FHTenL September 9, /27

27 Continued work at the same place If you start working on the project, start with a clean slate. At the start of working day or working period, do a svn update. This gets all the stuff other committers committed, and makes your repository up to date. Resolve any conflicts you created or inform the others of problems created by them. Maybe it is time to come together. /FHTenL September 9, /27

28 Get organized. Teamwork is largely organizing your selves. You want to share work 4 and not receive any mess from your fellows. So do not (make leave) a mess in the shared resource, the repository. 4 You do not want to or cannot do it on your own. 5 equivalent to bills to your customer /FHTenL September 9, /27

29 Get organized. Teamwork is largely organizing your selves. You want to share work 4 and not receive any mess from your fellows. So do not (make leave) a mess in the shared resource, the repository. Make sure your fellows can easily find all the pieces. 4 You do not want to or cannot do it on your own. 5 equivalent to bills to your customer /FHTenL September 9, /27

30 Get organized. Teamwork is largely organizing your selves. You want to share work 4 and not receive any mess from your fellows. So do not (make leave) a mess in the shared resource, the repository. Make sure your fellows can easily find all the pieces. Make sure they are in the repository, by committing all needed artifacts. 4 You do not want to or cannot do it on your own. 5 equivalent to bills to your customer /FHTenL September 9, /27

31 Get organized. Teamwork is largely organizing your selves. You want to share work 4 and not receive any mess from your fellows. So do not (make leave) a mess in the shared resource, the repository. Make sure your fellows can easily find all the pieces. Make sure they are in the repository, by committing all needed artifacts. All the work you have done on behalf of the project in one day should have produced some artifact in the repository. Otherwise, it is as if you produced nothing. And you cannot write hours 5 for unproductive time. 4 You do not want to or cannot do it on your own. 5 equivalent to bills to your customer /FHTenL September 9, /27

32 Want to share this? Figure : Who s going to find the latest and greatest version? /FHTenL September 9, /27

33 Start with a clean slate. Each working period, start with a clean desk. E.g. rm - fr / workspace mkdir / workspace cd / workspace. /FHTenL September 9, /27

34 What you can achieve as a team If all in the team are producing texts/code and using subversion as presented here, it should be quite easy to follow the project status. The shared stuff is always available to all. The shared work can be taken over by others in case of illness or unavailability. If the completeness rule is kept, handing over the keys to the project is a piece of cake. /FHTenL September 9, /27

35 What you can use as a team Sending source code by or carrying it around on an USB stick is not an alternative. There are no reasons to not use a repository. Subversion is not the most modern one, but a very good and stable basis. And it can meet most project s needs. Distributed version control systems like hg (mercurial), git, bazaar etc. are promising and expected to pick up the crown, but not just yet. Subversion is well supported in the Unix 6 world or by tools like eclipse, netbeans or jdeveloper. Tools that are available in the MS Windows world too, subversion connectivity is also available. TortoiseSVN ( is a very nice Windows tools for mouse-pushing addicts. Ankhsvn ( is very nice if you need to work in Visual Studio. 6 includes MAC OSX too /FHTenL September 9, /27

36 What else can you change as a team Next to subversion some kind of requirement/feature/bug database is very welcome. Use it. It is a wonderfull tool for the Configuration + Quality management roles. Trac is a possibility and rather easy to set up. It uses a database plus a web frontend. If you want to use it on fontysvenlo.org, coordinate it, so it can be used by more sofa s. There are similar free product/projects, also outside the opensource community, if you must spend money on it. /FHTenL September 9, /27