Introduction to Software Engineering: Tools and Environments. Session 9. Oded Lachish

Transcription

1 Introduction to Software Engineering: Tools and Environments Session 9 Oded Lachish Room: Mal 405 Visiting Hours: Wednesday 17:00 to 20:00 oded@dcs.bbk.ac.uk Module URL: 1

2 Previously Introduction to Build Tools (Ant) Today s session Introduction to Documentation Tools Doxygen euml2 Build Tools revisited Introduction to Integration Tools 2

3 Documentation Tools 3

4 Documentation Tools Extreme programmers believe that code is self documenting Maintenance is usually the longest part of a software products life Regretfully there is a rumour that a large portion of the Hi-Tech jobs require the ability to do so. Now imagine that you have to do the job without any documentation Solution: Automation dedicated tools 4

5 Documentation Tools What can documentation tools do for us? Generate class diagrams (UML) depicts the static relations between classes Collaboration diagrams (UML) depicts classes and their interactions Search engine to code and much more When are these tools used? As soon as possible (definitely before you need reverse engineering). 5

6 6 Doxygen

7 Doxygen A documentation system for C++, C, Java, Objective C, Fortran, VHDL, PHP, C#. What can it do for us? Generate on-line documents in HTML Generate an off-line manual latex, RTF (MS-Windows) What does that include? Dependency graphs Inheritance diagrams Collaboration diagrams 7 User specified information

8 Doxygen How does Doxygen generate all this information? 1. Doxygen can extract the code structure from the source files. 2. The user specified information is also generated from the source files, specifically from comments. The underlying approach is to minimize the documents you need to create and simplify the process of updating them. If you update the comments when you update the code then the documentations also get updated. 8

9 Doxygen Installation Regretfully Doxygen is not an Eclipse plug-in 1. Download from: 2. Double click the downloaded file 3. The rest of the installation is standard 9

10 Doxygen preparing example code Lets start a new project 1. Project name: Example10 2. Create one package named: allmyclasses 3. Create a Junit test: TutorTest 4. TutorTest should instantiate a class named Tutor with a constructor that accepts a string as a parameter and then call its method whatyourname() Snippets of the resulting code appear in the following slides 10

11 Code for demonstration 11 Tutor.java package allmyclasses; /** oded * */ public class Tutor { private String name; public Tutor(String string) { super(); name = string; } public void whatisyourname() { System.out.println(name); } } package allmyclasses; import org.junit.test; TutorTest.java /** oded * */ public class TutorTest public void test() { Tutor t= new Tutor("Oded"); t.whatisyourname(); } }

12 12 Doxygen GUI front end

13 Doxygen- Selecting Directories Press 13

14 Doxygen- Mode Options Press 14

15 Doxygen- Output Options Press 15

16 16 Doxygen- Diagram option

17 17 Doxygen- Expert (maybe later)

18 Doxygen- Run menu Press 18

19 19 Doxygen- directory before and after

20 Doxygen- the index.html file 20

21 Doxygen- allmyclasses.tutor From comment 21

22 Doxygen- allmyclasses.tutor changed comment The comment 22 Now: save file and rerun Doxygen

23 Doxygen- allmyclasses.tutor changed name From comment 23

24 24 Doxygen- class members

25 25 Doxygen- packages

26 26 Doxygen- file list

27 Adding code to example Use refactoring to extract interface from class tutor Person.java package allmyclasses; public interface Person { public abstract void whatisyourname(); } Now: save file and rerun Doxygen 27

28 28 Doxygen class hierarchy

29 29 Doxygen inheritance diagram

30 Doxygen Create a new class that implements Person Teacher.java 30 package allmyclasses; /** oded * */ public class Teacher implements Person { private String name; public Teacher(String name) { super(); this.name = name; } /* (non-javadoc) allmyclasses.person#whatisyourname() public void whatisyourname() { System.out.println(name); } }

31 Doxygen Create a new class that implements Person TutorTest.java package allmyclasses; import org.junit.test; /** ooded * */ public class TutorTest public void test() { Person classundertest= new Tutor("Oded"); Person classundertest2= new Teacher("Lance"); classundertest.whatisyourname(); classundertest2.whatisyourname(); } } 31 Now: save file and rerun Doxygen

32 32 Doxygen with new class

33 Doxygen documenting code In order to know which comments are for Doxygen the comment must have some additional marking (different marking for different languages) JavaDoc Style marking, for detailed description (needs to be placed before the member) /** * This does not do much */ required JavaDoc Style marking for detailed description (needs to be placed before the member) required /**< The name of the object */ 33

34 34 Doxygen detailed description comment (before format)

35 35 Doxygen detailed description comment (after format)

36 Doxygen comment One can also specify exactly where the comment belongs \enum - to document an enumeration type \file - to document a file \package - to document a Java package. \interface - to document an IDL interface Formats /*! \file Teacher.java is a java file */ Teacher.java is a java file */ 36

37 37 Doxygen file comment

38 Doxygen not just inheritance diagrams Regretfully this requires another tool graphviz needed to generate more advanced diagrams and graphs. (open-source, cross-platform graph drawing toolkit be ) 38

39 Doxygen other important features Searching Linking to external documentation Customizing output How to add support for new languages Automatic link generation Including formulae 39

40 40 euml2

41 euml2 UML unified modeling language- Standardized general purpose modelling language for OO analysis and design. euml2 a UML2 framework for eclipse 41

42 euml2 - installation euml2 can be found at eclipse marketplace 42

43 euml2 reverse engineering Right click project 43

44 euml2 UML model Press 44

45 euml2 What Happened? Press Press 45

46 euml2 What Happened? Press Press 46

47 euml2 Diagram Options Press 47

48 euml2 Package Content Selection 48 Press

49 euml2 class diagram 49 You can actually write code by editing the diagram. TRY it OUT!

50 Build Tools Revisited 50

51 Ant revisited - depend <project name="example10" default="compile"> <target name="clean"> <delete dir="build" /> </target> <target name="compile"> <mkdir dir="build/classes" /> <javac srcdir="src" destdir="build/classes" includeantruntime="false" /> </target> </project> Now compile twice, then change (add space) Person Interface 51 and compile again

52 Ant Script Should have recompiled all the classes 52

53 Ant - depend <project name="example10" default="compile"> <target name="clean"> <delete dir="build" /> </target> <target name="remove dependencies"> <depend srcdir="src" destdir="build/classes" cache="depcache" closure="yes" /> </target> <target name="compile" depends="remove dependencies"> <mkdir dir="build/classes" /> <javac srcdir="src" destdir="build/classes" includeantruntime="false" /> </target> </project> Change (remove space) Person Interface and compile again 53

54 Ant with New Script All dependent class files were deleted, and then all files were recompiled like the should. Lets check if it doesn t just delete all 54

55 Ant doesn t just delete all Did not just delete all 55

56 How does Ant know what to delete 1. Uses information inside class files in order to determine dependencies 2. Uses file time stamp to check whether java code is newer than compiled code 56

57 Why Ant is not Good for Large Projects Scalability problems choice of XML is too restricted Maintainability Managing package dependencies 57

58 58 Next Stage

59 Until now From here on We have covered many SDLC tools from a single developer s point of view. Project point of view (large project) Local Individual Developer Integration Collected work of Individual Developers Testing QA team Environment 59

60 Single Developers Tools Project Scale Tools 1. light weight 2. Easy to learn 3. Integrated with IDE 4. Trivial to install and set 5. Massive number of available tools 1. HEAVY 2. Easy to learn? 3. Require their own server 4. Installation may require significant effort 5. Relatively small variety of tools 60

61 Continuous Integration 61

62 Integration Where all the code goes to (and also the unit tests) Here when things go wrong the price is high That is why the focus is on want to minimizing the damage when things go wrong 62

63 Continuous Integration Integrate code as soon as possible. Why? Each time only a small portion of code is added or changed. Why? Problems are detected earlier Easier to find the problem 63

64 64 Jenkins

65 What is Jenkins A crucial element in continuous integration with two main goals: 1. Continuously build and test software projects 2. Monitor externally run jobs 65

66 Work Flow with Jenkins A team member/ members commit code to source control repository Jenkins detects that new code has been committed Jenkins uses Build Tools to build the project and Test tools to test the project Jenkins uses the resulting files to generate reports Jenkins send notification if anything went wrong (build, test failed etc.) 66

67 Jenkins as Part of the Big Picture An easy to configure tool that is responsible for the following: 1. Make sure that everything that should be executed is executed when and as soon as possible 2. Collect all the information and process it into coherent reports (imagine have 10 different tools each with its own report) 67