omf_web 1.2.8 → 1.2.9

data/.gitignore

@@ -2,6 +2,7 @@
 *.rbc
 .bundle
 .config
+.idea
 coverage
 InstalledFiles
 lib/bundler/man

data/README.md

@@ -1,12 +1,20 @@
 # OMF Web
 
-This Ruby 1.9 gem provides the components for building a web-based data visualization service. 
+This Ruby gem provides the components for building a web-based data visualization service.
 The typical use case is to allow a user to investigate a data set stored in one or more databases
 as well as life data streams.
 
 Installation
 ------------
 
+    gem install omf_web
+
+or if you want to create a standalone visualisation solution you may want to
+add the following to a local 'Gemfile':
+
+    source 'https://rubygems.org'
+    gem 'omf_web'
+
 At this stage the best course of action is to clone the repository
 
     % git clone https://github.com/mytestbed/omf_web.git
@@ -14,12 +22,16 @@ At this stage the best course of action is to clone the repository
     % export OMF_WEB=`pwd`
     % bundle install
     
-On some systems you will need to install 'libicu'
+On some systems you will need to install 'libicu'.
+
+    sudo apt-get install libicu-dev
+
+On Debian (Ubuntu)
 
 On Mac with Ports
 
-    % sudo port install icu
-    % bundle config build.charlock_holmes --with-icu-dir=/opt/local
+    sudo port install icu
+    bundle config build.charlock_holmes --with-icu-dir=/opt/local
 
 Getting Started
 ---------------
@@ -27,16 +39,20 @@ Getting Started
 There are a few example sites in the 'example' directory. They have been developed in the context of various demos and 
 may not always be kept up to date. The one which should always work is 'example/simple'. Try it out.
 
-    % $OMF_WEB/bin/omf_web_server.rb --config $OMF_WEB/example/simple/simple.yaml start
+    omf_web_server --example simple start
     
-This starts a webserver which can be accessed locally via 'http:localhost:4050'. Connecting to it through your favorite 
+This starts a webserver which can be accessed locally via 'http:localhost:4010'. Connecting to it through your favorite
 web browser should display a web page approx. looking like:
 
 ![Screenshot of starting page](https://raw.github.com/mytestbed/omf_web/master/doc/screenshot2.png "Screenshot")
 
 Don't forget to press the icon buttons 
 ![icon buttons](https://raw.github.com/mytestbed/omf_web/master/doc/widget_detail.png "icon buttons")
-on the left widget header.
+on the right widget header.
+
+A list of all the available examples can be obtained through:
+
+    omf_web_server --example
 
 Overview
 --------

data/example/bridge/bridge.yaml

@@ -2,6 +2,17 @@
 server:
   page_title: Bridge Monitoring
   port: 4020
+  options:
+    - separator: "BRIDGE options:"
+    - name: fake-events
+      var_name: oml_database
+      description: If set, create fake sensor events
+      var_name: fake_bridge_events
+    - name: oml-database
+      param: DATABASE
+      var_name: oml_database
+      default: sqlite://example/bridge/data_sources/test3.sq3
+      description: "Database containing bridge data"
 
 include: tabs/*.yaml
 

data/example/bridge/data_sources/sensor-sqlite.rb

@@ -98,4 +98,4 @@ class BridgeSensor < OMF::Base::LObject
     end
   end
 end
-wv = BridgeSensor.new($oml_database, $fake_bridge_events).run()
+wv = BridgeSensor.new($oml_database || 'sqlite://example/bridge/data_sources/test3.sq3', $fake_bridge_events).run()

data/example/topo_discovery/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gem 'omf_web'

data/example/topo_discovery/data_sources/links_full.csv

@@ -0,0 +1,43 @@
+id:int,from_id:string,to_id:string,zone:int
+3,10:10:10:10:10:fe,rf2,0
+11,rf2,10:10:10:10:10:fe,0
+21,00:00:00:00:c1:00,sw1,0
+22,sw1,rf1,0
+23,00:00:00:00:c1:00,sw2,0
+24,sw2,rf1,0
+25,00:00:00:00:c2:00,sw2,0
+26,sw2,rf1,0
+27,rf1,sw1,0
+28,sw1,00:00:00:00:c1:00,0
+29,rf1,sw2,0
+30,sw2,00:00:00:00:c1:00,0
+31,rf1,sw2,0
+32,sw2,00:00:00:00:c2:00,0
+33,rf1,sw3,0
+34,sw3,rf2,0
+35,rf1,sw3,0
+36,sw3,ba:5e:ba:11:00:00,0
+37,rf2,sw3,0
+38,sw3,rf1,0
+39,rf2,sw3,0
+40,sw3,ba:5e:ba:11:00:00,0
+41,rf2,sw5,0
+42,sw5,ba:5e:ba:11:ad:00,0
+43,rf3,sw4,0
+44,sw4,ba:5e:ba:11:db:00,0
+45,rf3,sw5,0
+46,sw5,ba:5e:ba:11:ad:00,0
+47,ba:5e:ba:11:00:00,sw3,0
+48,sw3,rf1,0
+49,ba:5e:ba:11:00:00,sw3,0
+50,sw3,rf2,0
+51,ba:5e:ba:11:00:01,sw4,0
+52,sw4,ba:5e:ba:11:db:00,0
+53,ba:5e:ba:11:ad:00,sw5,0
+54,sw5,rf2,0
+55,ba:5e:ba:11:ad:00,sw5,0
+56,sw5,rf3,0
+57,ba:5e:ba:11:db:00,sw4,0
+58,sw4,rf3,0
+59,ba:5e:ba:11:db:00,sw4,0
+60,sw4,ba:5e:ba:11:00:01,0

data/example/topo_discovery/data_sources/links_groundtruth.csv

@@ -0,0 +1,39 @@
+id:int,from_id:string,to_id:string,zone:int
+3,Internet,rf2,0
+21,client1,sw1,0
+23,sw1,sw2,0
+24,sw2,rf1,0
+25,client2,sw2,0
+26,sw2,rf1,0
+28,sw1,client1,0
+29,rf1,sw2,0
+31,rf1,sw2,0
+32,sw2,client2,0
+33,rf1,sw3,0
+34,sw3,rf2,0
+35,rf1,sw3,0
+36,sw3,WWWServer,0
+37,rf2,sw3,0
+38,sw3,rf1,0
+39,rf2,sw3,0
+40,sw3,WWWServer,0
+41,rf2,sw5,0
+42,sw5,admin,0
+43,rf3,sw4,0
+44,sw4,PsqlServer,0
+45,rf3,sw5,0
+46,sw5,admin,0
+47,WWWServer,sw3,0
+48,sw3,rf1,0
+49,WWWServer,sw3,0
+50,sw3,rf2,0
+51,WWWServer,sw4,0
+52,sw4,PsqlServer,0
+53,admin,sw5,0
+54,sw5,rf2,0
+55,admin,sw5,0
+56,sw5,rf3,0
+57,PsqlServer,sw4,0
+58,sw4,rf3,0
+59,PsqlServer,sw4,0
+60,sw4,WWWServer,0

data/example/topo_discovery/data_sources/links_incomplete.csv

@@ -0,0 +1,41 @@
+id:int,from_id:string,to_id:string,zone:int
+19,00:00:00:00:c1:00,sw1,0
+20,sw1,30:00:00:00:01:00,0
+21,00:00:00:00:c1:00,sw2,0
+22,sw2,30:00:00:00:01:00,0
+23,00:00:00:00:c2:00,sw2,0
+24,sw2,30:00:00:00:01:00,0
+25,30:00:00:00:01:00,sw1,0
+26,sw1,00:00:00:00:c1:00,0
+27,30:00:00:00:01:00,sw2,0
+28,sw2,00:00:00:00:c1:00,0
+29,30:00:00:00:01:00,sw2,0
+30,sw2,00:00:00:00:c2:00,0
+31,30:00:00:00:01:01,sw3,0
+32,sw3,rf2,0
+33,30:00:00:00:01:01,sw3,0
+34,sw3,ba:5e:ba:11:00:00,0
+35,rf2,sw3,0
+36,sw3,30:00:00:00:01:01,0
+37,rf2,sw3,0
+38,sw3,ba:5e:ba:11:00:00,0
+39,rf2,sw5,0
+40,sw5,ba:5e:ba:11:ad:00,0
+41,rf3,sw4,0
+42,sw4,ba:5e:ba:11:db:00,0
+43,rf3,sw5,0
+44,sw5,ba:5e:ba:11:ad:00,0
+45,ba:5e:ba:11:00:00,sw3,0
+46,sw3,30:00:00:00:01:01,0
+47,ba:5e:ba:11:00:00,sw3,0
+48,sw3,rf2,0
+49,ba:5e:ba:11:00:01,sw4,0
+50,sw4,ba:5e:ba:11:db:00,0
+51,ba:5e:ba:11:ad:00,sw5,0
+52,sw5,rf2,0
+53,ba:5e:ba:11:ad:00,sw5,0
+54,sw5,rf3,0
+55,ba:5e:ba:11:db:00,sw4,0
+56,sw4,rf3,0
+57,ba:5e:ba:11:db:00,sw4,0
+58,sw4,ba:5e:ba:11:00:01,0

data/example/topo_discovery/data_sources/node_info_full.csv

@@ -0,0 +1,55 @@
+nodeID, property, value
+rf1,name,rf1
+rf1,type,router
+rf1,intf,MAC 30:00:00:00:01:00 with IP 192.168.1.254
+rf1,intf,MAC 30:00:00:00:01:01 with IP 192.168.2.1
+rf2,name,rf2
+rf2,type,router
+rf2,intf,MAC 30:00:00:00:02:00 with IP 192.168.2.254
+rf2,intf,MAC 30:00:00:00:02:01 with IP 192.168.4.1
+rf2,intf,MAC 30:00:00:00:02:02 with IP 192.168.10.1
+rf3,name,rf3
+rf3,type,router
+rf3,intf,MAC 30:00:00:00:03:00 with IP 192.168.3.254
+rf3,intf,MAC 30:00:00:00:03:01 with IP 192.168.4.2
+sw1,name,sw1
+sw1,type,sw1
+sw1,intf,MAC 20:00:00:00:01:00
+sw1,intf,MAC 20:00:00:00:01:01
+sw2,name,sw2
+sw2,type,sw2
+sw2,intf,MAC 20:00:00:00:02:01
+sw2,intf,MAC 20:00:00:00:02:01
+sw3,name,sw3
+sw3,type,sw3
+sw3,intf,MAC 20:00:00:00:03:00
+sw3,intf,MAC 20:00:00:00:03:01
+sw4,name,sw4
+sw4,type,sw4
+sw4,intf,MAC 20:00:00:00:04:00
+sw4,intf,MAC 20:00:00:00:04:01
+sw5,name,sw5
+sw5,type,sw5
+sw5,intf,MAC 20:00:00:00:05:00
+sw5,intf,MAC 20:00:00:00:05:01
+00:00:00:00:c1:00,name,device1
+00:00:00:00:c1:00,type,WWW client
+00:00:00:00:c1:00,intf,MAC 192.168.1.22 with IP 192.168.1.22
+00:00:00:00:c2:00,name,device2
+00:00:00:00:c2:00,type,WWW client
+00:00:00:00:c2:00,intf,MAC 192.168.1.23 with IP 192.168.1.23
+ba:5e:ba:11:00:00,name,device3
+ba:5e:ba:11:00:00,type,WWW server
+ba:5e:ba:11:00:00,intf,MAC 192.168.2.22 with IP 192.168.2.22
+ba:5e:ba:11:00:01,name,device4
+ba:5e:ba:11:00:01,type,DB client
+ba:5e:ba:11:00:01,intf,MAC 192.168.3.22 with IP 192.168.3.22
+ba:5e:ba:11:ad:00,name,device5
+ba:5e:ba:11:ad:00,type,admin
+ba:5e:ba:11:ad:00,intf,MAC 192.168.4.22 with IP 192.168.4.22
+ba:5e:ba:11:db:00,name,device6
+ba:5e:ba:11:db:00,type,DB
+ba:5e:ba:11:db:00,intf,MAC 192.168.3.23 with IP 192.168.3.23
+10:10:10:10:10:fe,name,device1
+10:10:10:10:10:fe,type,unknown
+10:10:10:10:10:fe,intf,MAC 10:10:10:10:10:fe with IP 192.168.10.22

data/example/topo_discovery/data_sources/node_info_groundtruth.csv

@@ -0,0 +1,53 @@
+nodeID, property, value
+rf1,name,rf1
+rf1,type,router
+rf1,intf,MAC 30:00:00:00:01:00 with IP 192.168.1.254
+rf1,intf,MAC 30:00:00:00:01:01 with IP 192.168.2.1
+rf2,name,rf2
+rf2,type,router
+rf2,intf,MAC 30:00:00:00:02:00 with IP 192.168.2.254
+rf2,intf,MAC 30:00:00:00:02:01 with IP 192.168.4.1
+rf2,intf,MAC 30:00:00:00:02:02 with IP 192.168.10.1
+rf3,name,rf3
+rf3,type,router
+rf3,intf,MAC 30:00:00:00:03:00 with IP 192.168.3.254
+rf3,intf,MAC 30:00:00:00:03:01 with IP 192.168.4.2
+sw1,name,sw1
+sw1,type,switch
+sw1,intf,MAC 20:00:00:00:01:00
+sw1,intf,MAC 20:00:00:00:01:01
+sw2,name,sw2
+sw2,type,switch
+sw2,intf,MAC 20:00:00:00:02:01
+sw2,intf,MAC 20:00:00:00:02:01
+sw3,name,sw3
+sw3,type,switch
+sw3,intf,MAC 20:00:00:00:03:00
+sw3,intf,MAC 20:00:00:00:03:01
+sw4,name,sw4
+sw4,type,switch
+sw4,intf,MAC 20:00:00:00:04:00
+sw4,intf,MAC 20:00:00:00:04:01
+sw5,name,sw5
+sw5,type,switch
+sw5,intf,MAC 20:00:00:00:05:00
+sw5,intf,MAC 20:00:00:00:05:01
+client1,name,client1
+client1,type,WWW client
+client1,intf,MAC 00:00:00:00:c1:00 with IP 192.168.1.22
+client2,name,client2
+client2,type,WWW client
+client2,intf,MAC 00:00:00:00:c2:00 with IP 192.168.1.23
+WWWServer,name,WWWServer
+WWWServer,type,WWW server
+WWWServer,intf,MAC ba:5e:ba:11:00:00 with IP 192.168.2.22
+WWWServer,intf,MAC ba:5e:ba:11:00:01 with IP 192.168.3.22
+admin,name,admin
+admin,type,admin
+admin,intf,MAC ba:5e:ba:11:ad:00 with IP 192.168.4.22
+Internet,name,Internet
+Internet,type,Internet
+Internet,intf,MAC 10:10:10:10:10:fe with IP 192.168.10.22
+PsqlServer,name,PsqlServer
+PsqlServer,type,DB
+PsqlServer,intf,MAC ba:5e:ba:11:db:00 with IP 192.168.3.23

data/example/topo_discovery/data_sources/node_info_incomplete.csv

@@ -0,0 +1,54 @@
+nodeID, property, value
+rf2,name,rf2
+rf2,type,router
+rf2,intf,MAC 30:00:00:00:02:00 with IP 192.168.2.254
+rf2,intf,MAC 30:00:00:00:02:01 with IP 192.168.4.1
+rf2,intf,MAC 30:00:00:00:02:02 with IP 192.168.10.1
+rf3,name,rf3
+rf3,type,router
+rf3,intf,MAC 30:00:00:00:03:00 with IP 192.168.3.254
+rf3,intf,MAC 30:00:00:00:03:01 with IP 192.168.4.2
+sw1,name,sw1
+sw1,type,sw1
+sw1,intf,MAC 20:00:00:00:01:00
+sw1,intf,MAC 20:00:00:00:01:01
+sw2,name,sw2
+sw2,type,sw2
+sw2,intf,MAC 20:00:00:00:02:01
+sw2,intf,MAC 20:00:00:00:02:01
+sw3,name,sw3
+sw3,type,sw3
+sw3,intf,MAC 20:00:00:00:03:00
+sw3,intf,MAC 20:00:00:00:03:01
+sw4,name,sw4
+sw4,type,sw4
+sw4,intf,MAC 20:00:00:00:04:00
+sw4,intf,MAC 20:00:00:00:04:01
+sw5,name,sw5
+sw5,type,sw5
+sw5,intf,MAC 20:00:00:00:05:00
+sw5,intf,MAC 20:00:00:00:05:01
+00:00:00:00:c1:00,name,device1
+00:00:00:00:c1:00,type,WWW client
+00:00:00:00:c1:00,intf,MAC 192.168.1.22 with IP 192.168.1.22
+30:00:00:00:01:00,name,device2
+30:00:00:00:01:00,type,MANUAL INSPECT
+30:00:00:00:01:00,intf,MAC 192.168.2.22 with IP 192.168.2.22
+30:00:00:00:01:01,name,device3
+30:00:00:00:01:01,type,MANUAL INSPECT
+30:00:00:00:01:01,intf,MAC 192.168.1.22 with IP 192.168.1.22
+ba:5e:ba:11:00:00,name,device4
+ba:5e:ba:11:00:00,type,WWW server
+ba:5e:ba:11:00:00,intf,MAC 192.168.2.22 with IP 192.168.2.22
+ba:5e:ba:11:00:01,name,device5
+ba:5e:ba:11:00:01,type,DB client
+ba:5e:ba:11:00:01,intf,MAC 192.168.3.22 with IP 192.168.3.22
+ba:5e:ba:11:db:00,name,device6
+ba:5e:ba:11:db:00,type,DB
+ba:5e:ba:11:db:00,intf,MAC 192.168.3.23 with IP 192.168.3.23
+00:00:00:00:c2:00,name,device1
+00:00:00:00:c2:00,type,unknown
+00:00:00:00:c2:00,intf,MAC 00:00:00:00:c2:00 with IP 192.168.1.23
+ba:5e:ba:11:ad:00,name,device2
+ba:5e:ba:11:ad:00,type,unknown
+ba:5e:ba:11:ad:00,intf,MAC ba:5e:ba:11:ad:00 with IP None

data/example/topo_discovery/data_sources/nodes_full.csv

@@ -0,0 +1,16 @@
+id:string,name,type
+00:00:00:00:c1:00,00:00:00:00:c1:00,genericclient
+00:00:00:00:c2:00,00:00:00:00:c2:00,genericclient
+10:10:10:10:10:fe,10:10:10:10:10:fe,unknown
+sw1,sw1,switch
+sw2,sw2,switch
+sw3,sw3,switch
+sw4,sw4,switch
+sw5,sw5,switch
+rf1,rf1,router
+rf2,rf2,router
+rf3,rf3,router
+ba:5e:ba:11:00:00,ba:5e:ba:11:00:00,wwwserver
+ba:5e:ba:11:00:01,ba:5e:ba:11:00:01,dbclient
+ba:5e:ba:11:ad:00,ba:5e:ba:11:ad:00,admin
+ba:5e:ba:11:db:00,ba:5e:ba:11:db:00,dbserver

data/example/topo_discovery/data_sources/nodes_groundtruth.csv

@@ -0,0 +1,15 @@
+id:string,name,type
+client1,client1,client
+client2,client2,client
+Internet,Internet,Internet
+sw1,sw1,switch
+sw2,sw2,switch
+sw3,sw3,switch
+sw4,sw4,switch
+sw5,sw5,switch
+rf1,rf1,router
+rf2,rf2,router
+rf3,rf3,router
+WWWServer,WWWServer,WWWServer
+admin,admin,admin
+PsqlServer,PsqlServer,PsqlServer

data/example/topo_discovery/data_sources/nodes_incomplete.csv

@@ -0,0 +1,16 @@
+id:string,name,type
+00:00:00:00:c1:00,00:00:00:00:c1:00,genericclient
+00:00:00:00:c2:00,00:00:00:00:c2:00,unknown
+sw1,sw1,switch
+sw2,sw2,switch
+sw3,sw3,switch
+sw4,sw4,switch
+sw5,sw5,switch
+30:00:00:00:01:00,30:00:00:00:01:00,special
+30:00:00:00:01:01,30:00:00:00:01:01,special
+rf2,rf2,router
+rf3,rf3,router
+ba:5e:ba:11:00:00,ba:5e:ba:11:00:00,wwwserver
+ba:5e:ba:11:00:01,ba:5e:ba:11:00:01,dbclient
+ba:5e:ba:11:ad:00,ba:5e:ba:11:ad:00,unknown
+ba:5e:ba:11:db:00,ba:5e:ba:11:db:00,dbserver

data/example/topo_discovery/data_sources/truth.sh

@@ -0,0 +1,16 @@
+#!/bin/bash
+sed -i 's/00:00:00:00:c1:00/client1/g' nodes_groundtruth.csv
+sed -i 's/00:00:00:00:c2:00/client2/g' nodes_groundtruth.csv
+sed -i 's/10:10:10:10:10:fe/Internet/g' nodes_groundtruth.csv
+sed -i 's/ba:5e:ba:11:00:00/WWWServer/g' nodes_groundtruth.csv
+sed -i 's/ba:5e:ba:11:00:01/WWWServer/g' nodes_groundtruth.csv
+sed -i 's/ba:5e:ba:11:ad:00/admin/g' nodes_groundtruth.csv
+sed -i 's/ba:5e:ba:11:db:00/PsqlServer/g' nodes_groundtruth.csv
+
+sed -i 's/00:00:00:00:c1:00/client1/g' links_groundtruth.csv
+sed -i 's/00:00:00:00:c2:00/client2/g' links_groundtruth.csv
+sed -i 's/10:10:10:10:10:fe/Internet/g' links_groundtruth.csv
+sed -i 's/ba:5e:ba:11:00:00/WWWServer/g' links_groundtruth.csv
+sed -i 's/ba:5e:ba:11:00:01/WWWServer/g' links_groundtruth.csv
+sed -i 's/ba:5e:ba:11:ad:00/admin/g' links_groundtruth.csv
+sed -i 's/ba:5e:ba:11:db:00/PsqlServer/g' links_groundtruth.csv

data/example/topo_discovery/docs/full_network.md

@@ -0,0 +1,6 @@
+title: Fully Instrumented Network
+
+In this scenario we have probes on every ???
+
+
+

data/example/topo_discovery/docs/incomplete_network.md

@@ -0,0 +1,6 @@
+title: Partially Instrumented Network
+
+In this scenario we have probes on every ???
+
+
+

data/example/topo_discovery/topo_discovery.yaml

@@ -0,0 +1,25 @@
+
+
+
+# Simple tab showing a line chart with supporting table
+#
+
+server:
+  name: 'Topology Discovery'
+  page_title: 'Topology Discovery'
+  port: 4020
+  footer_left: NICTA
+  footer_right: V1.2
+
+
+
+repositories:
+  - id: content
+    type: file
+    top_dir: ./docs
+
+include: widgets_combined/*.yaml
+
+
+
+

data/example/topo_discovery/widgets_combined/network_full.yaml

@@ -0,0 +1,57 @@
+
+data_sources:
+  - id: network/nodes
+    file: data_sources/nodes_full.csv  # checking that node ids can be anything
+  - id: network/links
+    file: data_sources/links_full.csv
+
+widgets:
+  - id: network_full
+    name: Discovered Network
+    type: data/network2
+    height: 1.0
+    #data_source: network
+    data_sources:
+      - name: nodes
+        stream: network/nodes
+      - name: links
+        stream: network/links
+
+    mapping:
+      nodes:
+        x: auto
+        y: auto
+        radius: 15
+          # property: capacity
+          # scale: 20
+          # min: 4
+        fill_color: #white
+          property: type
+          color:
+            router: orange
+            switch: '#FFDD00' 
+            genericclient: lightskyblue 
+            unknown: white 
+            dbserver: '#D473D4' #Mauve is the best colour for a DB: http://search.dilbert.com/comic/Database%20Color
+            dbclient: '#915F6D' # clients have similar colour
+            wwwserver: darkgreen
+            admin: '#0000FF' # deep blue for admin
+            internet: '#eeeeee'
+          # property: capacity
+          # color: red_yellow20_green()
+        stroke_width: 2
+        label_color: black
+        label_size: 14
+      links:
+        stroke_width: 8
+        stroke_color:
+          property: zone
+          color: category10()
+
+    force:
+      link_distance: 50
+      charge: -1000
+
+    line_mode: straight
+    interaction_mode: click
+

data/example/topo_discovery/widgets_combined/network_groundtruth.yaml

@@ -0,0 +1,57 @@
+
+data_sources:
+  - id: network_gt/nodes
+    file: data_sources/nodes_groundtruth.csv  # checking that node ids can be anything
+  - id: network_gt/links
+    file: data_sources/links_groundtruth.csv
+
+widgets:
+  - id: network_groundtruth
+    name: Network (Ground truth)
+    type: data/network2
+    height: 1.0
+    #data_source: network
+    data_sources:
+      - name: nodes
+        stream: network_gt/nodes
+      - name: links
+        stream: network_gt/links
+
+    mapping:
+      nodes:
+        x: auto
+        y: auto
+        radius: 15
+          # property: capacity
+          # scale: 20
+          # min: 4
+        fill_color: #white
+          property: type
+          color:
+            router: orange
+            switch: '#FFDD00' 
+            client: lightskyblue 
+            unknown: white 
+            PsqlServer: '#D473D4' #Mauve is the best colour for a DB: http://search.dilbert.com/comic/Database%20Color
+            PsqlClient: '#915F6D' # clients have similar colour
+            WWWServer: darkgreen
+            admin: '#0000FF' # deep blue for admin
+            Internet: '#eeeeee'
+          # property: capacity
+          # color: red_yellow20_green()
+        stroke_width: 2
+        label_color: black
+        label_size: 14
+      links:
+        stroke_width: 8
+        stroke_color:
+          property: zone
+          color: category10()
+
+    force:
+      link_distance: 50
+      charge: -1000
+
+    line_mode: straight
+    interaction_mode: click
+

data/example/topo_discovery/widgets_combined/network_groundtruth_small.yaml

@@ -0,0 +1,59 @@
+
+
+
+widgets:
+  - id: network_groundtruth_small
+    name: Ground Truth
+    type: data/network2
+    height: 1.0
+    #data_source: network
+    data_sources:
+      - name: nodes
+        stream: network_gt/nodes
+      - name: links
+        stream: network_gt/links
+
+    mapping:
+      nodes:
+        x: auto
+        y: auto
+        radius: 10
+          # property: capacity
+          # scale: 20
+          # min: 4
+        fill_color: #white
+          property: type
+          color:
+            router: orange
+            switch: '#FFDD00' 
+            client: lightskyblue 
+            unknown: white 
+            PsqlServer: '#D473D4' #Mauve is the best colour for a DB: http://search.dilbert.com/comic/Database%20Color
+            PsqlClient: '#915F6D' # clients have similar colour
+            WWWServer: darkgreen
+            admin: '#0000FF' # deep blue for admin
+            Internet: '#eeeeee'
+          # property: capacity
+          # color: red_yellow20_green()
+        stroke_width: 2
+        label_color: black
+        label_size: 8
+      links:
+        stroke_width: 2
+        stroke_color:
+          property: zone
+          color: category10()
+
+    force:
+      link_distance: 15
+      charge: -300
+
+    line_mode: straight
+    interaction_mode: none
+
+    margin:
+      left: 20
+      top:  20
+      right: 20
+      bottom: 20
+

data/example/topo_discovery/widgets_combined/network_incomplete.yaml

@@ -0,0 +1,58 @@
+
+data_sources:
+  - id: network_ic/nodes
+    file: data_sources/nodes_incomplete.csv  # checking that node ids can be anything
+  - id: network_ic/links
+    file: data_sources/links_incomplete.csv
+
+widgets:
+  - id: network_incomplete
+    name: Discovered Network
+    type: data/network2
+    height: 1.0
+    #data_source: network
+    data_sources:
+      - name: nodes
+        stream: network_ic/nodes
+      - name: links
+        stream: network_ic/links
+
+    mapping:
+      nodes:
+        x: auto
+        y: auto
+        radius: 15
+          # property: capacity
+          # scale: 20
+          # min: 4
+        fill_color: #white
+          property: type
+          color:
+            router: orange
+            switch: '#FFDD00' 
+            genericclient: lightskyblue 
+            unknown: white
+            special: red 
+            dbserver: '#D473D4' #Mauve is the best colour for a DB: http://search.dilbert.com/comic/Database%20Color
+            dbclient: '#915F6D' # clients have similar colour
+            wwwserver: darkgreen
+            admin: '#0000FF' # deep blue for admin
+            internet: '#eeeeee'
+          # property: capacity
+          # color: red_yellow20_green()
+        stroke_width: 2
+        label_color: black
+        label_size: 14
+      links:
+        stroke_width: 8
+        stroke_color:
+          property: zone
+          color: category10()
+
+    force:
+      link_distance: 50
+      charge: -1000
+
+    line_mode: straight
+    interaction_mode: click
+

data/example/topo_discovery/widgets_combined/node_info_full.yaml

@@ -0,0 +1,23 @@
+data_sources:
+  - id: node_info_fl
+    file: data_sources/node_info_full.csv
+
+widgets:
+  - id: node_info_full
+    type: data/table2
+    title: Node Info
+    data_source:
+      name: node_info_fl
+      slice:
+        slice_column: nodeID
+        event:
+          name: "graph.network/nodes.selected"
+          key: id
+    columns:
+      - field: property
+        #name: Name
+      - field: value
+        #name: Value
+
+    margin:
+      left: 5

data/example/topo_discovery/widgets_combined/node_info_groundtruth.yaml

@@ -0,0 +1,23 @@
+data_sources:
+  - id: node_info_gt
+    file: data_sources/node_info_groundtruth.csv
+
+widgets:
+  - id: node_info_groundtruth
+    type: data/table2
+    title: Node Info
+    data_source:
+      name: node_info_gt
+      slice:
+        slice_column: nodeID
+        event:
+          name: "graph.network/nodes.selected"
+          key: id
+    columns:
+      - field: property
+        #name: Name
+      - field: value
+        #name: Value
+
+    margin:
+      left: 5

data/example/topo_discovery/widgets_combined/node_info_incomplete.yaml

@@ -0,0 +1,23 @@
+data_sources:
+  - id: node_info_ic
+    file: data_sources/node_info_incomplete.csv
+
+widgets:
+  - id: node_info_incomplete
+    type: data/table2
+    title: Node Info
+    data_source:
+      name: node_info_ic
+      slice:
+        slice_column: nodeID
+        event:
+          name: "graph.network_ic/nodes.selected"
+          key: id
+    columns:
+      - field: property
+        #name: Name
+      - field: value
+        #name: Value
+
+    margin:
+      left: 5

data/example/topo_discovery/widgets_combined/tabs.yaml

@@ -0,0 +1,49 @@
+
+widgets:
+  - id: main
+    name: Home
+    top_level: true
+    priority: 900
+    type: layout/two_columns/50_50
+    left:
+      - name: Introduction
+        type: text
+        content:
+          url: file:content:introduction.md
+    right:
+      - network_groundtruth
+
+  - id: full
+    name: Full
+    top_level: true
+    priority: 800
+    type: layout/two_columns/66_33
+    left:
+      - network_full
+    right:
+      - type: layout/one_column
+        widgets:
+          - name: Introduction
+            type: text
+            content:
+              url: file:content:full_network.md
+          - node_info_full
+          - network_groundtruth_small
+
+  - id: incomplete
+    name: Incomplete
+    top_level: true
+    priority: 700
+    type: layout/two_columns/66_33
+    left:
+      - network_incomplete
+    right:
+      - type: layout/one_column
+        widgets:
+          - name: Introduction
+            type: text
+            content:
+              url: file:content:incomplete_network.md
+          - node_info_incomplete
+          - network_groundtruth_small
+

data/example/topo_discovery2/introduction.md

@@ -0,0 +1,17 @@
+title: Introduction
+
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin
+sollicitudin nibh eu ligula lobortis ornare. Sed nibh nibh,
+ullamcorper at vehicula ac, molestie ac nunc. Duis sodales, nisi vel
+pellentesque imperdiet, nisi massa accumsan lorem, gravida scelerisque
+velit est vitae eros. Suspendisse eu lacinia elit.  
+
+
+Suspendisse laoreet, lacus quis dignissim volutpat, dolor augue convallis lectus,
+ac consectetur yyyy sem iaculis diam. Donec iaculis mattis iaculis.
+Curabitur ut nisl in sapien semper ullamcorper in id turpis. Vivamus
+sed sapien justo, ac scelerisque nibh. Sed eget quam velit.  Lorem
+ipsum dolor sit amet, consectetur adipiscing elit. 
+
+

data/lib/omf-web/thin/server.rb

@@ -23,6 +23,13 @@ module OMF::Web
           pre_parse: lambda do |p, runner|
             p.on("--config CONF_FILE", "File holding description of web site") {|f| runner.options[:omf_config_file] = f}
             p.on("--top-dir DIR", "Directory to start from for relative data paths [directory of config file]") {|td| @top_dir = td }
+            p.on("--example [EXAMPLE]", "Run an example [#{list_of_examples.join(', ')}]")  do |e|
+              unless e
+                puts "Available examples: #{list_of_examples.join(', ')}"
+                exit 0
+              end
+              runner.options[:omf_config_file] = "example:#{e}"
+            end
           end
         },
         authentication: {
@@ -44,13 +51,16 @@ module OMF::Web
 
     def load_environment(opts)
       unless cf = opts[:omf_config_file]
-        fatal "Missing config file"
+        fatal "Missing config file '--config'"
         abort
       end
 
       unless File.readable? cf
-        fatal "Can't read config file '#{cf}'"
-        abort
+        unless cf2 = check_for_builtin(cf, opts)
+          fatal "Can't read config file '#{cf}'"
+          abort
+        end
+        cf = cf2 # found a builtin config file
       end
 
       @cfg_dir = File.dirname(cf)
@@ -59,12 +69,43 @@ module OMF::Web
       load_config_file(cf, opts)
     end
 
-    def load_config_file(cf, opts)
-      unless File.readable? cf
-        fatal "Can't read config file '#{cf}'"
+    def check_for_builtin(cf, opts)
+      pa = cf.split(':')
+      unless pa.length == 2 && pa[0] == 'example'
+        return nil
+      end
+      path = File.join(@top_dir, 'example', pa[1])
+      if File.directory? path
+        dir = path
+        path = File.join(dir, "#{pa[1]}.yaml")
+        unless File.readable? path
+          # check .yml
+          path = File.join(dir, "#{pa[1]}.yml")
+        end
+      end
+      unless File.readable?(path)
+        da = list_of_examples
+        ex = pa[1].split('/')[0]
+        if da.include? ex
+          ya = Dir.glob(File.join(@top_dir, 'example', ex, '*.yaml')).map do |fn|
+            File.basename(fn)
+          end
+          fatal "Unknown config file. Did you mean '#{ya.join(', ')}'?"
+        else
+          fatal "Unknown example '#{}'. Did you mean '#{da.join(', ')}'?"
+        end
         abort
       end
+      return path
+    end
 
+    def list_of_examples()
+      Dir.entries(File.join(@top_dir, 'example')).select do |n|
+        !(n == 'NOT_WORKING' || n.start_with?('.'))
+      end
+    end
+
+    def load_config_file(cf, opts)
       debug "Loading config file '#{cf}'"
       cfg = _rec_sym_keys(YAML.load_file(cf))
 

data/lib/omf-web/version.rb

@@ -1,7 +1,7 @@
 
 module OMF
   module Web
-    VERSION = '1.2.8'
+    VERSION = '1.2.9'
     # Used for finding the example directory
     TOP_DIR = File.dirname(File.dirname(File.dirname(__FILE__)))
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omf_web
 version: !ruby/object:Gem::Version
-  version: 1.2.8
+  version: 1.2.9
   prerelease: 
 platform: ruby
 authors:
@@ -417,16 +417,39 @@ files:
 - example/simple/sample.sql
 - example/simple/simple.yaml
 - example/simple/simple_dynamic.yaml
-- example/topo_discovery/data_sources/links.csv
-- example/topo_discovery/data_sources/links2.csv
-- example/topo_discovery/data_sources/node_info.csv
-- example/topo_discovery/data_sources/nodes.csv
-- example/topo_discovery/data_sources/nodes2.csv
-- example/topo_discovery/introduction.md
-- example/topo_discovery/topo_discovery_simple.yaml
-- example/topo_discovery/topo_discovery_simple2.yaml
-- example/topo_discovery/widgets/network.yaml
-- example/topo_discovery/widgets/node_info.yaml
+- example/topo_discovery/Gemfile
+- example/topo_discovery/data_sources/links_full.csv
+- example/topo_discovery/data_sources/links_groundtruth.csv
+- example/topo_discovery/data_sources/links_incomplete.csv
+- example/topo_discovery/data_sources/node_info_full.csv
+- example/topo_discovery/data_sources/node_info_groundtruth.csv
+- example/topo_discovery/data_sources/node_info_incomplete.csv
+- example/topo_discovery/data_sources/nodes_full.csv
+- example/topo_discovery/data_sources/nodes_groundtruth.csv
+- example/topo_discovery/data_sources/nodes_incomplete.csv
+- example/topo_discovery/data_sources/truth.sh
+- example/topo_discovery/docs/full_network.md
+- example/topo_discovery/docs/incomplete_network.md
+- example/topo_discovery/docs/introduction.md
+- example/topo_discovery/topo_discovery.yaml
+- example/topo_discovery/widgets_combined/network_full.yaml
+- example/topo_discovery/widgets_combined/network_groundtruth.yaml
+- example/topo_discovery/widgets_combined/network_groundtruth_small.yaml
+- example/topo_discovery/widgets_combined/network_incomplete.yaml
+- example/topo_discovery/widgets_combined/node_info_full.yaml
+- example/topo_discovery/widgets_combined/node_info_groundtruth.yaml
+- example/topo_discovery/widgets_combined/node_info_incomplete.yaml
+- example/topo_discovery/widgets_combined/tabs.yaml
+- example/topo_discovery2/data_sources/links.csv
+- example/topo_discovery2/data_sources/links2.csv
+- example/topo_discovery2/data_sources/node_info.csv
+- example/topo_discovery2/data_sources/nodes.csv
+- example/topo_discovery2/data_sources/nodes2.csv
+- example/topo_discovery2/introduction.md
+- example/topo_discovery2/topo_discovery_simple.yaml
+- example/topo_discovery2/topo_discovery_simple2.yaml
+- example/topo_discovery2/widgets/network.yaml
+- example/topo_discovery2/widgets/node_info.yaml
 - lib/irods4r.rb
 - lib/irods4r/directory.rb
 - lib/irods4r/file.rb