Skip to content

Latest commit

 

History

History
155 lines (102 loc) · 6.76 KB

collab-demo.md

File metadata and controls

155 lines (102 loc) · 6.76 KB
Raw

#Wind Turbine demonstrator for the MONDO Collaboration Framework

Overview

The MONDO Collaboration Framework, initially developed by Work Package 4 of the MONDO project (main website, source code artifacts), enables online and offline collaboration of engineers on models hosted in a repository (currently SVN), with support for seamless access control for security and property-based locking for coordination.

The Wind Turbine industrial case study features a sample modeling language aimed at the model-driven design of Wind Turbine Control Systems. The case study serves to motivate and demonstrate several MONDO results, including the collaboration capabilities described here.

Design, configuration and usage is presented in the MONDO report D4.4 "Prototype Tool for Collaborative Modeling".

Repository and dependencies

Relevant repository layout:

  • Metamodel/ holds the version of the Wind Turbine metamodel used for the demonstrators, as a standard EMF .ecore file.
  • Model/ holds corresponding sample instance models as standard EMF serialized XMI files.
  • Demo/ holds two Eclipse projects as sample repository contents:
  • demo.project is a model project that can be edited using MONDO tools
  • macl.project defines the access control and locking rules, along with associated queries.
  • MONDO-Collab contains the plugins for the MONDO Collaboration Framework that are specific to the Wind Turbine case study. These are OSGi bundle projects that need to be deployed into the collaboration server and/or the client IDE (for the offline collaboration scenario):
  • Common bundles: org.mondo.wt.cstudy.metamodel, org.mondo.wt.cstudy.metamodel.edit, org.mondo.wt.cstudy.metamodel.validation
  • Client-only bundles: org.mondo.wt.cstudy.metamodel.merge, org.mondo.wt.cstudy.metamodel.offline.editor,
  • Server-only components: org.mondo.wt.cstudy.lens, org.mondo.wt.cstudy.metamodel.online.editor, org.mondo.wt.cstudy.online.rap, and finally org.mondo.wt.cstudy.online.rap.war as a web application project.

The following external repositories are code dependencies:

Screencast

A screencast is available that showcases the capabilities of the MONDO Collaboration Framework, demonstrated on the Wind Turbine industrial case study of the MONDO project.

Demo setup

Please follow the guidelines of the MONDO report D4.4 "Prototype Tool for Collaborative Modeling".

In the following, we assume that a MONDO Server product is installed, as described in MONDO deliverables.

Installation addendum / errata

Note on UNIX users: make sure that both the MONDO Server product and the Apache webserver behind Subversion are executed in the name of the same user (www-data by default) that has RW permissions on all relevant folders (both the repositories and the collaboration framework installation).

sudo -u www-data ./run-server.sh

Quick links

SVN users for the demo

The Wind Turbine demo operates with the following users and passwords:

  • admin admin
  • alice alice
  • bob bob

Do not forget the "artificial users" to propagate commits:

  • wt-demo admin
  • wt-demo-alice alice
  • wt-demo-bob bob

Use commands similar to the following to manipulate users:

sudo htpasswd -m /etc/subversion/svn.users [username] 	     // create user
sudo echo "[username] = rw" > /etc/subversion/access.authz   // set access rules
sudo service apache2 restart 				     // required afterwards

See also /etc/subversion/svn.users and /etc/subversion/access.authz.

Script for initializing demo repositories:

(Change paths, etc. to fit your demo environment.)

#!/bin/bash

echo "Restart WT-Demo"

rm /etc/mondo/lock/.lock-gold -rf
rm /etc/mondo/lock/.lock-front -rf

cd /etc/mondo/scripts
./wipe-repositories.sh wt-demo --force
./init-repository.sh wt-demo
./add-front-repository.sh wt-demo wt-demo-alice alice
./add-front-repository.sh wt-demo wt-demo-bob bob
./add-front-repository.sh wt-demo wt-demo-cecile cecile

rm /etc/mondo/workspace/* -rf

echo "Repositories re-created"

svn co http://127.0.0.1/svn/wt-demo /home/mondo/Desktop/wt-demo-files/temp --username admin --password admin --non-interactive --quiet
cp -r /home/mondo/Desktop/wt-demo-files/demo.project /home/mondo/Desktop/wt-demo-files/temp/
cp -r /home/mondo/Desktop/wt-demo-files/macl.project /home/mondo/Desktop/wt-demo-files/temp/

echo "Projects copied to temp folder"

cd /home/mondo/Desktop/wt-demo-files/temp
svn add --force * --auto-props --parents --depth infinity -q

echo "Commit is under execution"
svn commit -m "Initial commit to wt-demo" --username admin --password admin --non-interactive --quiet

rm /home/mondo/Desktop/wt-demo-files/temp -rf
rm /etc/mondo/lock/.lock-gold -rf
rm /etc/mondo/lock/.lock-front -rf

echo "Done"

exit 0

Enabling authentication for the (optional) remote management

Connect to the MONDO Server remote management URL using the MONDO client product.
Commands that should be executed:

# phase 1: no authentication on the server

usersConnect http://127.0.0.1:8080/thrift/users

usersAdd admin Administrator true admin
# error message if the user is already added to the database: UserExists: null

usersUpdatePassword admin admin

usersAdd alice Alice false
#hit two enters to set no password -- the read from the sdtin preceeds the help text

usersAdd bob Bob false
#hit two enters to set no password -- the read from the sdtin preceeds the help text

usersAdd cecile Cecile false
usersAdd denis Denis false

usersDisconnect

# phase 2: turn on authentication on the server. Both the shiro.ini and the mondo-server.ini should enable authentication

usersConnect http://127.0.0.1:8080/thrift/users

Remote management sample commands

collabGetMyFront http://127.0.0.1:8080/thrift/offline-collaboration/ alice alice http://127.0.0.1/svn/wt-demo/
collabRegenFronts http://127.0.0.1:8080/thrift/offline-collaboration/ admin admin http://127.0.0.1/svn/wt-demo/