PLVGen Setup Guide v1.0

Size: px

Start display at page:

Download "PLVGen Setup Guide v1.0"

Alexandra Posy Shelton
5 years ago
Views:

TECHNICAL REPORT Report No. UI-SE-MDSERG-2016-08 Date: April 30, 2017 PLVGen Setup Guide v1.

1 TECHNICAL REPORT Report No. UI-SE-MDSERG Date: April 30, 2017 PLVGen Setup Guide v1.0 Alireza Rouhi Bahman Zamani Department of Software Engineering University of Isfahan Hezar-Jerib Ave. Isfahan Tel: Fax: ,

3 PLVGen Setup Guide v1.0 Alireza Rouhi and Bahman Zamani Department of Software Engineering University of Isfahan Isfahan, Iran. {rouhi, Abstract: This report provides the required steps to setup the Pattern Language Verifier Generator (PLVGen). PLVGen is a framework which has been developed by Alireza Rouhi and Bahman Zamani. Given a PL and its patterns which are specified using the Pattern Language Specification Language (PLSL) and Pattern Specification Language (PSL), respectively, this framework is able to automatically generate an Epsilon Validation Language (EVL) module which plays the role of a Pattern Language Verifier (PLV) for the PL. To clarify the application of PLVGen in practice, here the usage of automatically generated three PLVs by PLVGen, i.e., Broker PLV, Patterns of Enterprise Application Architecture (PofEAA), and a security PLV are described step by step.

5 PLVGen Setup Guide v1.0 Alireza Rouhi and Bahman Zamani Department of Software Engineering University of Isfahan Isfahan, Iran. {rouhi, Abstract: This report provides the required steps to setup the Pattern Language Verifier Generator (PLVGen). PLVGen is a framework which has been developed by Alireza Rouhi and Bahman Zamani. Given a PL and its patterns which are specified using the Pattern Language Specification Language (PLSL) and Pattern Specification Language (PSL), respectively, this framework is able to automatically generate an Epsilon Validation Language (EVL) module which plays the role of a Pattern Language Verifier (PLV) for the PL. To clarify the application of PLVGen in practice, here the usage of automatically generated three PLVs by PLVGen, i.e., Broker PLV, Patterns of Enterprise Application Architecture (PofEAA), and a security PLV are described step by step. Contents 1 Introduction 2 2 Install Eclipse and Epsilon 2 3 Download and setup PLVGen 2 A Broker PLV v1.0 setup guide 18 B PofEAA PLV v1.0 setup guide 26 C Security PLV v1.0 setup guide 36 1

6 1 Introduction This report helps you to setup, configure and run the PLV Generator (PLVGen) framework in order to generate a Pattern Language Verifier (PLV) for a given Pattern Language (PL) automatically. This framework has been developed based-on the presented formalism of patterns and PLs in [RZ16]. Given a PL in Pattern Language Specification Language (PLSL) and its patterns in Pattern Specification Language (PSL), PLVGen generates an Epsilon Validation Language (EVL) module which plays the role of a PLV for the given PL. To show the applicability and usage of the generated PLVs of PLVGen, the following directions will help you to configure and run the generated three PLVs for the Broker PL [SC99], Patterns of Enterprise Application Architecture (PofEAA) PL [Fow02], and a security PL [FP01] in Appendix A, Appendix B, and Appendix C, respectively. 2 Install Eclipse and Epsilon Download and install Epsilon [KRGDP16] by following the directions from its supporting web page 1 (see Figure 1 and Figure 2). Check the Epsilon installation details from the menu Help>About Eclipse>Installation Details (see Figure 3). It must be mentioned that the used Epsilon tool suite version is 1.3 here. 3 Download and setup PLVGen This section provides the required steps to download and setup the PLVGen framework: 1. Download the PLVGen s resources from ir.ui.se.mdserg.plvgen.rar. Unzip the archive file. Copy and install the plug-ins from the "plugins" subfolder to your Eclipse plugins/dropins folder. By utilizing these plug-ins, you can write your patterns, PLs, and the Unified Modeling Language (UML) semantic constraints in our developed PSL, PLSL, and UML Semantic Constraints Specification (USCS) languages, respectively. Also, these plug-ins are required to load and explore the Eclipse Modeling Framework (EMF) models of the presented example of Broker PL and its patterns. In addition, the provided USCS plug-ins is required to configure and generate the EVL constraints corresponding to the UML semantic constraints

7 Figure 1: Eclipse and Epsilon download web page Figure 2: Epsilon update web page 3

8 Figure 3: Epsilon installation details 4

9 2. Run your Eclipse. Create an empty project and name it. Copy the plvgen.egl, lib.egl, and umlsemconsgen.egl Epsilon Generation Language (EGL) templates from the "EGL templates-plvgen" folder into the created project (see Figure 4). Figure 4: The EGL templates in an empty project 3. Copy the "Broker PL" subfolder in the "Pattern Languages and their Patterns in PLSL and PSL" folder into the created project. This folder includes the specifications of the Broker PL [SC99] and its patterns in PLSL and PSL, respectively (see Figure 5). Copy the UML semantic constraints, i.e., umlsemanticcons.uscs file, which is specified using the USCS language. See Figure Create a UML profile and name it "PatternLanguage". Then, first create two subprofiles in the PatternLanguage named "Operations" and "Attributes"; and second, import three metaclasses, in order, into the created profiles from a Classifier, Operation, and Property metaclasses. Here, we use the UML Designer 6.0 tool 2 to create the profile model (see Figure 7). You can use the provided UML profile too (import the UML project "ir.ui.se.mdserg.your pl name.profile.gen" to your Eclipse workspace)

10 Figure 5: The Broker PL [SC99] and its patterns in PSL and PLSL, respectively Figure 6: The UML semantic constraints in the USCS language 6

11 Figure 7: The PatternLanguage UML profile which includes two subprofiles, i.e., Operations and Attributes, and three metaclass import 5. Open the plvgen.egl template then right-click on it (in the Project Explorer view) and select Run As>Run Configurations... from the pop-up menu. Select the EGL Template category on the list of the left and click on the New launch configuration (see Figure 8). Name the configuration, here we named it "BrokerPLVGen" (see Figure 9). Let s choose the target which the generated text will be directed. The default is the Console view. We selected a file path in the current project as the target of the generated text and named it "brokerplv.evl" (see Figure 9). Open the Models tab and then add the EMF models of the Broker PL, i.e., broker.plsl, and its patterns.psl model files. Do not forget to add the created empty UML profile too. Also, remove the metamodel from the UML profile model s metamodels list (see Figure 11 and Figure 12). You can enable the timing options from the Profiling tab to record the generation time as well. Now, click on the Apply button and then Run. 6. Figure 13 displays the process of generating an EVL module which plays the role of the PLV for the Broker [SC99]. Figure 14 demonstrates (see the Console and Explorer views) the EVL module named brokerplv.evl which is generated automatically. As Figure 15 displays, there are two errors regarding the 7

12 Figure 8: The plvgen.egl configuration to generate the Broker PLV (I) 8

13 Figure 9: The plvgen.egl configuration to generate the Broker PLV (II) 9

14 Figure 10: The plvgen.egl configuration to generate the Broker PLV (III) 10

15 Figure 11: The plvgen.egl configuration to generate the Broker PLV (IV) imported EVL modules. Of course, we need to copy the lib.evl module which includes the library operations and functions that are called from the generated EVL module s invariants/operations. Copy the lib.evl module from the "PLVs-EVL modules" folder into the created project s folder. The next step is to generate the invariants representing the UML semantic constraints [RZ16]. 7. The umlsemantics.evl which represents the UML semantic constraints is generated automatically similar to the generation of the brokerplv.evl. However, to generate the umlsemantics.evl module, it is required to configure and run the umlsemconsgen.egl template. Figure 16 displays the new launch configuration as well as choosing the destination of the text generation, here the umlsemantics.evl file in the current project. Now, add the UML semantic constraints s EMF model, i.e., umlsemanticcons.uscs, which includes the specification of the constraints. See Figure 17. Click on the OK, Apply and then Run buttons. The umlsemantics.evl module is automatically generated as well (see Figure 18). You can copy the provided umlsemantics.evl module which is located in the "PLVs-EVL modules" folder too. 8. Finally, in the last step, open the empty UML profile which we created in 11

16 Figure 12: The plvgen.egl configuration to generate the Broker PLV (V) 12

17 Figure 13: The plvgen.egl is generating the Broker EVL module of the PLV (I) Figure 14: The plvgen.egl is generating the Broker EVL module of the PLV (II) 13

18 Figure 15: The generated Broker s EVL module of the PLV the earlier steps. Figure 19 displays the updated profile model after running the plvgen.egl template. This profile will be used by the designer to apply the patterns of the Broker PL by selecting the appropriate stereotypes of patterns and their components. So, the next step is to export the generated UML profile as an Eclipse plug-in. The generated plug-in must be copied and installed into the designer s Eclipse plugins/dropins subfolder. This task is very simple in the UML Designer 6.0 tool. Just click on the Define Profile option on the right Palette and select the profile from the profile diagram editor. Then, click on the Export Profile on the Palette and follow the wizards to create the profile plug-in. You can copy and install the provided profile plugins ir.ui.se.mdserg.brokerpl.profile.plugin jar, ir.ui.se.mdserg.pofeaapl.profile.plugin jar for the Broker PL and PofEAA, respectively, from the "plugins" folder to your Eclipse plugins/dropins subfolder. 9. Now, you can run and apply the generated PLV to validate the Broker PL [SC99] application on a design model (as Figure 20 displays, the raised errors have been resolved). See Appendix A for more information about how to run and apply the Broker PLV in practice. It must be mentioned that the presented configuration process is applicable to other PLs such as the PofEAA PL [Fow02] as well. The PofEAA PL and its patterns in PLSL and PSL are pro- 14

19 Figure 16: The umlsemconsgen.egl configuration to generate the UML semantic invariants (I) 15

20 Figure 17: The umlsemconsgen.egl configuration to generate the UML semantic invariants (II) 16

21 Figure 18: The umlsemconsgen.egl configuration to generate the UML semantic invariants (III) Figure 19: The generated UML profile of the given PL 17

vided in the "Pattern Languages and their Patterns in PLSL and PSL" folder. Also, the automatically generated EVL module of the PofEAA PLV, i.e., pofeaaplv.

22 vided in the "Pattern Languages and their Patterns in PLSL and PSL" folder. Also, the automatically generated EVL module of the PofEAA PLV, i.e., pofeaaplv.evl, is located in the "PLVs-EVL modules" folder. See Appendix B for more information about how to run and apply the PofEAA PLV in practice. Good-luck. Figure 20: The generated Broker s EVL module of the PLV A Broker PLV v1.0 setup guide This section provides the required steps to setup the Broker PLV: 1. Copy the Broker PL s UML profile plug-in (see the downloaded unzipped folder of PLVGen in Section 3), i.e., ir.ui.se.mdserg.brokerpl.profile.plugin jar, from the "plugins" folder to your Eclipse plugins/dropins subfolder. 2. Run your Eclipse. Open your existing design model or create a new UML project with a new model (name your project and model). Here, we use UML Designer 6.0 tool 3 to apply PLV. Right-click on the created model and create a class diagram (see Figure 21 and Figure 22)

23 Figure 21: Create a UML model with a class diagram (I) Figure 22: Create a UML model with a class diagram (II) 19

24 3. Check the Stereotypes option on the class diagram Editor s toolbar (see Figure 23). Figure 23: Check the Stereotypes option on the class diagram Editor s toolbar 4. Copy the brokerplv.evl, lib.evl, and umlsemantics.evl modules from the "PLVs-EVL modules" folder into the created project s folder (see Figure 24). 5. Open the brokerplv.evl module then right-click on it (in the Project Explorer View) and select Run As> Run Configurations To create a new configuration to launch the PLV s EVL Validation, click on the EVL Validation category on the left and then click on the New launch configuration icon on the top-left (see Figure 25). You can rename the configuration name. Of course, its default name will be the same as the PLV s module name, here, brokerplv. 7. Click on the Models tab and then click on the Add button to load your UML model file (see Figure 26): (Hint: If your installed Epsilon version is 1.5, select the EMF model in Figure 26) (a) Click on the Browse Workspace... button and then select your model.uml file (b) Click on Ok (see Figure 27) 20

25 Figure 24: Copy the EVL modules into the project s folder 8. Now, click on the Apply and then Run buttons. An error message is displayed which asks you to create a classifier stereotyped with the initial pattern, i.e., <<BrokerPattern>>, of the Broker PL (see Figure 28). Create a class in the design model and apply the requested stereotype on it (see Figure 29 and Figure 30). Save the model. 9. Open again the launch configuration of the brokerplv.evl module, click on the Models tab and then select the previously added UML model and click on the Edit button. Now, click on the Clear button and then click on the Browse Workspace... and select your target model.uml file again (see Figure 31). Select and remove the metamodel from the list. Click on the Ok and then Apply and Run buttons, in order. 10. Examine the Validation/Console views which display the unsatisfied constraints regarding the applied patterns, their required components and their inter-relationships (see Figure 32). Additionally, the report regarding the satisfied interrelationships of patterns are displayed in the Console view too. Follow the messages, apply the auto fixes (if provided) by right-clicking on the messages and applying the proposed fixes. Run the PLV again. To quick launch, copy the brokerplv.launch file from youreclipseworkspace/.metadata/.plugins/org.eclipse.debug.core/.launches 21

26 Figure 25: The Broker PLV s launch configuration (I) 22

27 Figure 26: The Broker PLV s launch configuration (II) 23

28 Figure 27: The Broker PLV s launch configuration (III) 24

29 Figure 28: Error description: there is no classifier stereotyped with the patterns of the Broker PL s profile Figure 29: Application of the initial pattern of the Broker PL (I) 25

30 Figure 30: Application of the initial pattern of the Broker PL (II) into the UML project s folder. Then, right-click on the launch file and click Run As> brokerplv to run PLV (see Figure 33). Good-luck. B PofEAA PLV v1.0 setup guide This section provides the required steps to setup the PofEAA PLV: 1. Copy the PofEAA PL s UML profile plug-in (see the downloaded unzipped folder of PLVGen in Section 3), i.e., ir.ui.se.mdserg.pofeaapl.profile.plugin jar, from the "plugins" folder to your Eclipse plugins/dropins subfolder. 2. Run your Eclipse. Open your existing design model or create a new UML project with a new model (name your project and model). Here, we use UML Designer 6.0 tool 4 to apply PLV. Right-click on the created model and create a class diagram (see Figure 34 and Figure 35). 3. Check the Stereotypes option class diagram Editor s toolbar (see Figure 36)

31 Figure 31: The Broker PLV s launch configuration (IV) 27

32 Figure 32: Broker PLV in action Figure 33: Broker PLV s quick launch 28

33 Figure 34: Create a UML model with a class diagram (I) Figure 35: Create a UML model with a class diagram (II) 29

34 Figure 36: Check the Stereotypes option on the class diagram Editor s toolbar 4. Copy the pofeaaplv.evl, lib.evl, and umlsemantics.evl modules from the "PLVs-EVL modules" folder into the created project s folder (see Figure 37). Figure 37: Copy the EVL modules into the project s folder 30

35 5. Open the pofeaaplv.evl module then right-click on it (in the Project Explorer View) and select Run As> Run Configurations To create a new configuration to launch the PLV s EVL Validation, click on the EVL Validation category on the left and then click on the New launch configuration icon on the top-left (see Figure 38). You can rename the configuration name. Of course, its default name will be the same as the PLV s module name, here, pofeaaplv. Figure 38: The PofEAA PLV s launch configuration (I) 7. Click on the Models tab and then click on the Add button to load your UML model file (see Figure 39): (Hint: If your installed Epsilon version is 1.5, select the EMF model in Figure 39) (a) Click on the Browse Workspace... button and then select your model.uml file (b) Click on Ok (see Figure 40) 31

36 Figure 39: The PofEAA PLV s launch configuration (II) 32

37 Figure 40: The PofEAA PLV s launch configuration (III) 33

38 8. Now, click on the Apply and then Run buttons. An error message is displayed which asks you to create a classifier stereotyped with the initial pattern, i.e., <<PresentationLayerPattern>>, of the PofEAA PL (see Figure 41). Create a class in the design model and apply the requested stereotype on it (see Figure 42 and Figure 43). Save the model. Figure 41: Error description: there is no classifier stereotyped with the patterns of the PofEAA PL s profile 9. Open again the launch configuration of the pofeaaplv.evl module, click on the Models tab and then select the previously added UML model and click on the Edit button. Now, click on the Clear button and then click on the Browse Workspace... and select your target model.uml file again (see Figure 44). Select and remove the metamodel from the list. Click on the Ok and then Apply and Run buttons, in order. 10. Examine the Validation/Console views which display the unsatisfied constraints regarding the applied patterns, their required components and their inter-relationships (see Figure 45). Additionally, the report regarding the satisfied interrelationships of patterns are displayed in the Console view too. Follow the messages, apply the auto fixes (if provided) by right-clicking on the messages and applying the proposed fixes. Run the PLV again. To quick launch, copy the 34

39 Figure 42: Application of the initial pattern of the PofEAA PL (I) Figure 43: Application of the initial pattern of the PofEAA PL (II) 35

Figure 44: The PofEAA PLV s launch configuration (IV) pofeaaplv.launch file from youreclipseworkspace/.metadata/.plugins/org.eclipse.debug.core/.launches into the UML project s folder.

40 Figure 44: The PofEAA PLV s launch configuration (IV) pofeaaplv.launch file from youreclipseworkspace/.metadata/.plugins/org.eclipse.debug.core/.launches into the UML project s folder. Then, right-click on the launch file and click Run As> pofeaaplv to run PLV (see Figure 46). Good-luck. C Security PLV v1.0 setup guide This section provides the required steps to setup the Security PLV: 1. Copy the Security PL s UML profile plug-in (see the downloaded unzipped folder of PLVGen in Section 3), i.e., ir.ui.se.mdserg.securitypl.profile.plugin jar, from the "plugins" folder to your Eclipse plugins/dropins subfolder. 2. Run your Eclipse. Open your existing design model or create a new UML project with a new model (name your project and model). Here, we use UML Designer 6.0 tool 5 to apply PLV. Right-click on the created model and create a class diagram (see Figure 47 and Figure 48)

41 Figure 45: PofEAA PLV in action Figure 46: PofEAA PLV s quick launch 37

42 Figure 47: Create a UML model with a class diagram (I) Figure 48: Create a UML model with a class diagram (II) 38

3. Check the Stereotypes option class diagram Editor s toolbar (see Figure 49). Figure 49: Check the Stereotypes option on the class diagram Editor s toolbar 4. Copy the securityplv.evl, lib.

43 3. Check the Stereotypes option class diagram Editor s toolbar (see Figure 49). Figure 49: Check the Stereotypes option on the class diagram Editor s toolbar 4. Copy the securityplv.evl, lib.evl, and umlsemantics.evl modules from the "PLVs-EVL modules" folder into the created project s folder (see Figure 50). 5. Open the securityplv.evl module then right-click on it (in the Project Explorer View) and select Run As> Run Configurations To create a new configuration to launch the PLV s EVL Validation, click on the EVL Validation category on the left and then click on the New launch configuration icon on the top-left (see Figure 51). You can rename the configuration name. Of course, its default name will be the same as the PLV s module name, here, securityplv. 7. Click on the Models tab and then click on the Add button to load your UML model file (see Figure 52): (Hint: If your installed Epsilon version is 1.5, select the EMF model in Figure 52) (a) Click on the Browse Workspace... button and then select your model.uml file (b) Click on Ok (see Figure 53) 39

44 Figure 50: Copy the EVL modules into the project s folder Figure 51: The Security PLV s launch configuration (I) 40

45 Figure 52: The Security PLV s launch configuration (II) 41

46 Figure 53: The Security PLV s launch configuration (III) 42

8. Now, click on the Apply and then Run buttons. An error message is displayed which asks you to create a classifier stereotyped with the initial pattern, i.e., <<LayersPattern>>, of the Security PL (see Figure 54).

47 8. Now, click on the Apply and then Run buttons. An error message is displayed which asks you to create a classifier stereotyped with the initial pattern, i.e., <<LayersPattern>>, of the Security PL (see Figure 54). Create a class in the design model and apply the requested stereotype on it (see Figure 55 and Figure 56). Save the model. Figure 54: Error description: there is no classifier stereotyped with the patterns of the Security PL s profile 9. In Epsilon 1.5 (current release), there is no need to manually add the metamodels used in the model, specifically the profile model representing the given PL, here security PL. In other words, the metamodels are detected automatically. 10. Examine the Validation/Console views which display the unsatisfied constraints regarding the applied patterns, their required components and their inter-relationships. Additionally, the report regarding the satisfied interrelationships of patterns are displayed in the Console view too. Follow the messages, apply the auto fixes (if provided) by right-clicking on the messages and applying the proposed fixes. Run the PLV again. To quick launch, copy the securityplv.launch file from youreclipseworkspace/.metadata/.plugins/org.eclipse.debug.core/.launches into the UML project s folder. Then, right-click on the launch file and click Run As> securityplv to run PLV. The steps to follow are just like the former two PLVs. Good-luck. 43

48 Figure 55: Application of the initial pattern of the Security PL (I) Figure 56: Application of the initial pattern of the Security PL (II) 44

49 References [Fow02] Martin Fowler. Patterns of enterprise application architecture. Addison- Wesley Longman Publishing Co., Inc., , 14 [FP01] Eduardo B Fernandez and Rouyi Pan. A pattern language for security models. In Proceedings of PLoP, volume 1, [KRGDP16] Dimitris Kolovos, Louis Rose, Antonio García-Domínguez, and Richard Paige. The Epsilon Book. The Epsilon Project, [RZ16] Alireza Rouhi and Bahman Zamani. Towards a formal model of patterns and pattern languages. Information and Software Technology, 79:1 16, , 11 [SC99] Douglas C Schmidt and Chris Cleeland. Applying patterns to develop an extensible ORB middleware. Communications Magazine, IEEE, 37(4):54 63, , 5, 6, 7, 14 45

1 Overview. 1 Overview. Contents. 1.1 Table of Contents Table of Contents

1 Overview. 1 Overview. Contents. 1.1 Table of Contents Table of Contents 1 Overview Contents 1. 1.1 Table of Contents 1 Overview Papyrus is an environment for editing any kind of EMF model, particularly supporting UML 2 ( Unified Modeling Language (UML) version 2.4.1 ) and