Difference between revisions of "Getting Started with PlayGo"

Revision as of 07:26, 28 December 2010

Install PlayGo

PlayGo is based on Eclipse and is packaged and provided as Eclipse Product. In addition to the product itself we provide a workspace with few examples.

To install PlayGo, create a new directory and extract the PlayGo.zip file to that newly created directory. Throughout this document we will refer to this directory as <PlayGo>.

Once extracted, your <PlayGo> directory should have the following content:

Run PlayGo with the Provided Workspace

Startup PlayGo

To start PlayGo, go to your <PlayGo>/playgo/ directory and double click the PlayGo.exe file. As it is in Eclipse, PlayGo will ask you for the workspace to start with. Choose the workspace provided with the installation (i.e. <PlayGo>/workspace/).

The <PlayGo>/workspace/ contains 4 projects:

• ATM – example for ATM System. The ATM GUI side is based on GWT. ATM behavior was modeled by Playing in a set of scenarios. S2A is used for generating aspects, which are used to monitor and run the system (Play-Out).
• GWTMemoryGame – Another example system. The Memory Game GUI side is based on GWT. Its behavior was modeled by Playing in a set of scenarios. S2A is used for generating aspects, which are used to monitor and run the system (Play-Out).
• il.ac.wis.cs.common – a library which contains few examples for creating LSC models by coding in Java.
• il.ac.wis.cs.playgo.guitoolkit – a platform library used by the ATM and GWTMemoryGame. This is integral part of PlayGo and in the future will be provided as a jar file only.

We will refer to these projects in the following sections.

Once PlayGo is open, note that the PlayGo perspective is selected. It is recommended to use this perspective, as it provides some shortcuts.

Configure the Examples

Before you can compile and run the examples, you need to configure them:

1. From Window menu, choose Preferences->Google->Web Toolkit. Configure it to point to your <PlayGo>\plugins\com.google.gwt.eclipse.sdkbundle.2.0.0_2.0.0.v200912062003\gwt-2.0.0 directory:

2. From Window menu, choose Preferences->Google->App Engine. Configure it to point to your <PlayGo>\plugins\com.google.appengine.eclipse.sdkbundle.1.3.0_1.3.0.v200912141120\appengine-java-sdk-1.3.0 directory:

3. From Window menu, choose Preferences->Java->Build PathClasspath Variables. Edit the PLAYGO_PLUGINS variable to point to your <PlayGo>/plugins/ directory:

4. Basically the examples provided are configured with relative paths and should work well in your environment, but this is a good opportunity to introduce some parts of the configuration you can control. Right click the GWTMemoryGame project->Properties->S2A Builder:

As shown in the screenshot above, there are 3 tabs in which you can configure properties related to S2A:

      A. S2A Compilation

     i.	Here you can add and remove models which you want to compile with S2A.

For those models you add, you may choose which LSCs should be compiled by S2A. In other words, for which Interactions S2A will generate aspects.

    ii.	Target Folder: here you specify the directory in which the generated aspects will be located.
   iii.	Clear Automatically – if on, cleans the aspects directory before generating new aspects.
    iv.	Polymorphism – enable or disable polymorphism.

B. Imports

     i.	Here you may specify packages that will be imported in the generated aspects.
    ii.	Output package name – the package of the generated aspects.

   C. General – currently used only for specifying the log4j configuration location.

5. S2A preferences – Advanced From the Windows menu, select Preferences->PlayGo->S2A Builder

Here you can choose the strategy you want to activate. Currently the only strategy implemented is the Naive strategy and this is the one being used.

What You Can Do with the Provided Workspace

Run the Examples - Play-out

The provided examples are configured and ready to be Played-out. Aspects are already generated and Java-compiled. To Play-out, select an example project (e.g. GWTMemoryGame) and click the 'Play-out' button on the toolbar. As a result the Play-out server will start, the corresponding GWT application will start and its URL will be copied to the Eclipse Internal Web Browser.

To Stop Play-out click the 'Stop' button on the toolbar, next to the 'Play-out' and 'Play-in' buttons.

Troubleshoot

If the example doesn’t seem to work, it is recommended to compile it and then re-try. For compiling it, select the example project and click the 'GWT Compile Project' button on the toolbar.

• If the problem persists, you can select the example project --> right click it and choose 'Debug as LSC'. This has the same effect as clicking the 'Play-out' button on the toolbar, but it sometimes works better…

• If the problem persists, make sure aspects were generated. To generate aspects, you should follow these steps (these steps should be done automatically by the 'Play-out' action when clicking 'Play-out' button on the toolbar):
  • Select the project you want to play-out.
  • Press the 'Build with S2A' icon in the toolbar or right click and chose 'Build with S2A'.
  • Refresh the project directory, to make sure Eclipse loaded the newly generated aspects.

Enrich the Examples with More Scenarios - Play-in

For playing-in, select an example project (e.g. ATM) and click the 'Play-in' button on the toolbar. As a result the play-in server starts, the corresponding GWT application starts and its URL is copied to the Eclipse Internal Web Browser.

You can now start playing-in.

Note: For adding new LSC(s) to existing specification, open the specification file (the .umlseq file) prior to starting the play-in process.

Troubleshoot

If play-out does not execute your newly created scenarios, try to re-load your modified model. This can be done by right clicking your project and selecting Properties --> S2A Builder. Remove the existing model by choosing it and clicking the 'Remove Model' and add the modified model, by clicking the 'Add Model' button and choosing the modified model.

How To...

Playing-in in PlayGo is sometimes a cumbersome task (and we are working on improving it). Below are some instructions for playing-in:

• Clicking an object in the GUI creates a diagram snippet reflecting that operation
• Use the Play-In toolbar to control some of the Play-In operation, such as:
  • Change temperature from Cold to Hot and vice versa
  • Change Execution from Monitor to Execute and vice versa
  • Insert new LSC elements, such as new LSC, new Instance, Assertion, Assignment etc…
  • You may want to make operations on the GUI without affecting the LSC (such as for restoring the GUI to a state from which you want to play-in). For doing that change the 'Play-in Mode' to 'Ignore' and make the required operation. Once done change the 'Play-in Mode' back to 'User' or 'System':

View the Model – in UML Editor and in LSC Editor

The projects provided with the PlayGo workspace contain some UML models. You can view these models using the UML2Tools UML Editor, or using the LSC Editor.

• To view a model using the UML2Tools Editor, choose a .uml file --> right click --> Open With --> UML Model Editor.
• To view a model using LSC Editor double click a .umlseq file.

You can also generate a .umlseq file from a .uml file by right clicking a .uml file and choosing 'Initialize LSC Diagram'.

Debug Capabilities

When playing-out an example, it is executed in debug mode. Thus you see at runtime the LSC diagram with additional debugging information, such as the Cut: You can right click a message and toggle a Breakpoint. The LSC debugger will stop on breakpoint. To continue, choose Resume from the Debug View. Please be advised that the debugger is in incubation stage, and as such it has only limited capabilities.

Troubleshot

If you experience some display problems in the LSC Editor, use the 'refresh' toolbar button.

Modify using LSC Editor, Compile and Run

You can modify your model, by opening the .umlseq file and edit the model in the LSC Editor. The LSC Editor has limited functionality. At this point you can do the following:

• Add new Interaction (LSC)
• Add elements to the end of an existing interaction
• Change properties of existing elements, from the Properties View.
• Delete a message by clicking it and pressing the delete keyboard button.

Deletion of other LSC elements is not supported yet... However if you want to delete elements or change the order of elements, or do other things that are not supported in the LSC Editor, you can do it from the UML Editor. It is recommended to backup the model (.uml file) prior to making such manual changes.

You can affect the way elements are displayed by changing some values in the Preferences. From the Windows menu select Preferences --> PlayGo --> LSCEditor:

Create a New Model by Coding

You can create new LSCs by code. The il.ac.wis.cs.common project contains an example for creating LSCs by Java-coding. You can use this example as reference for creating your own new models. The process for creating the model is as follows: 1. Write the code for creating your model – refer to CreateMemoryGameModel as a reference. 2. Run your newly created code. As a result a new .uml file will be created in your <PlayGo>/workspace/il.ac.wis.cs.common/model/ directory. 3. If you wish to view the LSC diagram, right click the .uml file and choose 'Initialize LSC Diagram'. As a result a new .umlseq file will be generated and the LSC diagram will open in the LSC Editor. You can now take the model and compile it with S2A. See the section 'Create your First LSC Project' below for step-by-step instructions.

Generate Tracer Logs

In order to generate Tracer logs open the musdmonitor.properties file located under the resources/ directory inside your example project, and make sure the value of the monitorLevel property is set to 1 (if 0 no log will be generated). Next time you run your application tracing information will be collected and written into the monitor.log which is located directly under your project folder.

The generated log files can be explored using the Tracer.

Create your First LSC Project

This chapter provides instructions for creating LSC project. It does not refer to creating a GUI application (from which one can Play-in and Play-out).

• Create LSC project: From the file menu choose New --> LSC Project. Note: if you're not using the PlayGo perspective you may not see this option, in which case choose New --> Other --> PlayGo category --> LSC Project. Keep the flags checked, as follows:

• Create LSC model, by coding (preferred), or by diagramming.
  • Refer to ‘Create a New Model by Coding’ above for details
• Add the target Java UI application source files or jar file to the project
• Configure S2A builder properties
  • Specifically define the location to which aspects need to be generated.
  • You may also need to configure the Java build path – depending on the code of your application.
  • Add dependency of S2ARuntime jar file. This jar is located in the /lib folder inside your LSC project.
• Build with S2A: Right click the project and select Build with S2A. When compilation completes you may need to press F5 to refresh the aspects folder (otherwise they will be ignored).
• Build your project
• Run the application or right click it and choose 'Debug as LSC'.
• To generate Tracer logs, create a folder resources/ under your project's home folder. Create the musdmonitor.properties file and locate it under the newly created resources folder. The musdmonitor,properties file should have the following content (can be copied from one of the example projects provided with the PlayGo installation):
  • Note that if you want to monitor specific interaction(s) you should replace the interactions=* entry with an entry of the following format: interactions=<name of interaction #1>; <name of interaction #2>; …; <name of interaction #n>