Merge branch 'develop' into 'master'

Develop

See merge request !3

.gitignore

+.cpython-36.pyc
 .idea/
+*weather_raw_data.json
+weather_data_init.json
+scripts/weather_raw_last_data.json
 wms-example/__pycache__/

README.md

@@ -114,10 +114,18 @@ UPDATE|
 cd naiades-platform-poc
 docker-compose up -d
 ```
+
+## Put platform down
+
+```bash
+cd naiades-platform-poc
+docker-compose down
+```
+
 ## Check services' status
 
 ```bash
->>> docker-compose ps
+docker-compose ps
 
        Name                     Command                       State                              Ports
 -------------------------------------------------------------------------------------------------------------------------
@@ -133,61 +141,6 @@ mongo-express        tini -- /docker-entrypoint ...   Up                      0.
 
 ## Run demo using shell scripts in `scripts` folder
 
-Let's start by looking at the type of REST requests used in the scripts:
-
-```bash
-cat 01_create_entity.sh
-curl --location --request POST 'http://localhost:1026/v2/entities/' \
---header 'Content-Type: application/json' \
---data-raw '{
-    "id": "urn:ngsi-ld:FlowerBed:FlowerBed-345",
-    "type": "FlowerBed",
-    "category": {
-        "type": "Property",
-        "value": ["urbanTreeSpot"]
-    },
-    "soilMoistureVwc": {
-        "type": "Property",
-        "value": 0.85
-    },
-    "dateLastWatering": {
-        "type": "DateTime",
-        "value": "2020-02-11T08:00:00Z"
-    },
-    "soilTemperature": {
-        "type": "Property",
-        "value": 17
-    },
-    "address": {
-        "type": "Property",
-        "value": {
-            "addressCountry": "Switzerland",
-            "streetAddress": "Place de Sardaigne",
-            "adressLocality": "Carouge",
-            "type": "PostalAddress"
-        }
-    },
-    "location": {
-        "type": "GeoProperty",
-        "value": {
-            "type": "Point",
-            "coordinates": [46.184255,6.1378375]
-        }
-    }
-}'
-```
-
-Now, let's run the script:
-
-```bash
-cd scripts
-./01_create_entity.sh
-```
-
+Please see `getting started` documentation at this [link](https://gitlab.distantaccess.com/naiades/naiades-platform-poc/-/wikis/API-client-examples-(curl-and-python-scripts))
 
-## Put platform down
 
-``` bash
-cd naiades-platform-poc
-docker-compose down
-```

docker-compose.yml

@@ -30,6 +30,10 @@ services:
     command: -dbhost mongo-db -logLevel INFO
     healthcheck:
       test: curl --fail -s http://orion:${ORION_PORT}/version || exit 1
+      start_period: 40s
+      interval: 15m00s
+      timeout: 10s
+      retries: 3
 
   # Keyrock is an Identity Management Front-End
   keyrock:
@@ -58,6 +62,10 @@ services:
       - my_secret_data
     healthcheck:
       test: curl --fail -s http://localhost:${KEYROCK_PORT}/version || exit 1
+      start_period: 40s
+      interval: 15m00s
+      timeout: 10s
+      retries: 3
 
   # PEP Proxy for Orion
   orion-proxy:
@@ -89,6 +97,10 @@ services:
       - PEP_PROXY_PUBLIC_PATHS=/version
     healthcheck:
       test: curl --fail -s http://orion-proxy:${ORION_PROXY_PORT}/version || exit 1
+      start_period: 40s
+      interval: 15m00s
+      timeout: 10s
+      retries: 3
 
   # Databases
   mongo-db:
@@ -179,10 +191,13 @@ services:
     healthcheck:
       test: curl --fail -s http://fiware-quantumleap:${QUANTUMLEAP_PORT}/v2/version || exit 1
       start_period: 40s
-      interval: 1m30s
+      interval: 15m00s
       timeout: 10s
       retries: 3
 
+
+# - - - services which act as clients of the NAIADES platform
+
   wms-app-example:
     build:
       context: ./wms-example
@@ -204,6 +219,62 @@ services:
         ipv4_address: 172.18.1.11
     healthcheck:
       test: curl --fail -s http://wms-app-example:${WMS_MODULE_PORT}/healthcheck || exit 1
+      start_period: 40s
+      interval: 15m00s
+      timeout: 10s
+      retries: 3
+
+
+  weather-data-collection-carouge-raw:
+    build:
+      context: ./weather-data-collection-carouge
+      dockerfile: Dockerfile
+    image: weather-data-collection-carouge:latest
+    container_name: weather-data-collection-carouge-raw
+    environment:
+      - LC_ALL=C.UTF-8
+      - LANG=C.UTF-8
+      - POST_DATA_PERIOD=3600 #3600sec = 1hour
+      - ORION_HOST=orion
+      - COLLECTION_DIR=/code/raw_data
+    volumes:
+      - ./weather-data-collection-carouge:/code:rw
+    networks:
+      default:
+        ipv4_address: 172.18.1.13
+    command: ./weather_00_collect_raw_weather_data_carouge.py
+
+#    healthcheck:
+#      test: curl --fail -s http://wms-app-example:${WMS_MODULE_PORT}/healthcheck || exit 1
+#      start_period: 40s
+#      interval: 15m00s
+#      timeout: 10s
+#      retries: 3
+
+#  weather-data-collection-carouge:
+#    build:
+#      context: ./weather-data-collection-carouge
+#      dockerfile: Dockerfile
+#    image: weather-data-collection-carouge:latest
+#    container_name: weather-data-collection-carouge
+#    environment:
+#      - LC_ALL=C.UTF-8
+#      - LANG=C.UTF-8
+#      - POST_DATA_PERIOD=15
+#      - ORION_HOST=orion
+#    volumes:
+#      - ./weather-data-collection-carouge:/code:rw
+#    networks:
+#      default:
+#        ipv4_address: 172.18.1.14
+#    command: ./weather_01_collect_and_post_weather_data_carouge.py
+##    healthcheck:
+##      test: curl --fail -s http://wms-app-example:${WMS_MODULE_PORT}/healthcheck || exit 1
+##      start_period: 40s
+##      interval: 15m00s
+##      timeout: 10s
+##      retries: 3
+
 
 networks:
   default:

scripts/Dockerfile

+# This is for building docker images for running the scripts
+
+FROM python:3.8-slim-buster
+MAINTAINER Federico Sismondi <fsismondi@udgalliance.org>
+
+RUN apt-get update
+
+RUN mkdir /scripts
+WORKDIR /scripts
+
+COPY requirements.txt requirements.txt
+RUN pip install --timeout 300 -r requirements.txt
+
+COPY . /scripts
+CMD ["echo", "please override this CMD with some .sh or .py script call"]
+

scripts/admin_get_all_orion_susbcriptions.sh

@@ -6,6 +6,5 @@ echo "Querying context broker at: ${ORION_HOST}"
 curl --location --request GET \
     "http://$ORION_HOST:1026/v2/subscriptions/" \
     --header "Fiware-Service: carouge" \
-    --header "Fiware-ServicePath: /watering" \
     | python -mjson.tool
 

scripts/admin_historic_get_tables.sh

+#!/usr/bin/env bash
+
+[[ -z "$CRATE_HOST" ]] && echo "Please set CRATE_HOST env var. E.g. export CRATE_HOST=127.0.0.1" && exit
+echo "Querying historical data at: ${CRATE_HOST}"
+
+curl --location --request POST \
+    "http://CRATE_HOST:4200/_sql" \
+    --header "Fiware-Service: carouge" \
+    --header "Fiware-ServicePath: /Watering" \
+    --header "Content-Type: application/json" \
+    --header "Accept: application/json" \
+    --data '{
+        "stmt":"SHOW TABLES"
+        }'
\ No newline at end of file

scripts/admin_susbcription_for_historic_data_weather.sh

+#!/usr/bin/env bash
+
+[[ -z "$ORION_HOST" ]] && echo "Please set ORION_HOST env var. E.g. export ORION_HOST=127.0.0.1" && exit
+echo "Querying context broker at: ${ORION_HOST}"
+
+# API NOTES:
+# "condition": { "attrs": [] } -> means monitor all the attributes in the entity
+
+curl --location --request POST \
+    "http://$ORION_HOST:1026/v2/subscriptions/" \
+    --header "Fiware-Service: carouge" \
+    --header "Content-Type: application/json" \
+    --header "Accept: application/json" \
+    --data '{
+      "description": "Notify QuantumLeap, the historic API, of all WeatherObservedRaw changes",
+      "subject": {
+        "entities": [
+          {
+            "idPattern": ".*",
+            "type": "WeatherObservedRaw"
+          }
+        ],
+        "condition": {
+          "attrs": []
+        }
+      },
+      "notification": {
+        "http": {
+          "url": "http://172.18.1.7:8668/v2/notify"
+        },
+        "attrs": [],
+        "attrsFormat" : "keyValues",
+        "metadata": ["dateCreated", "dateModified"]
+      }
+}'

scripts/historic_01_set_up.sh

+#!/usr/bin/env bash
+
+[[ -z "$ORION_HOST" ]] && echo "Please set ORION_HOST env var. E.g. export ORION_HOST=127.0.0.1" && exit
+echo "Querying context broker at: ${ORION_HOST}"
+
+# API NOTES:
+# "condition": { "attrs": [] } -> means monitor all the attributes in the entity
+
+curl --location --request POST \
+    "http://$ORION_HOST:1026/v2/subscriptions/" \
+    --header "Fiware-Service: carouge" \
+    --header "Fiware-ServicePath: /Watering" \
+    --header "Content-Type: application/json" \
+    --header "Accept: application/json" \
+    --data '{
+      "description": "Notify QuantumLeap, the historic API, of all FlowerBed changes",
+      "subject": {
+        "entities": [
+          {
+            "idPattern": ".*",
+            "type": "FlowerBed"
+          }
+        ],
+        "condition": {
+          "attrs": []
+        }
+      },
+      "notification": {
+        "http": {
+          "url": "http://172.18.1.7:8668/v2/notify"
+        },
+        "attrs": [],
+        "metadata": ["dateCreated", "dateModified"]
+      }
+}'

scripts/historic_02_api_query.sh

+#!/usr/bin/env bash
+
+[[ -z "$QUANTUM_HOST" ]] && echo "Please set QUANTUM_HOST env var. E.g. export QUANTUM_HOST=127.0.0.1" && exit
+echo "Querying QuantumLeap API at: ${QUANTUM_HOST}"
+
+curl --location --request GET \
+    "http://$QUANTUM_HOST:8668/v2/entities/urn:ngsi-ld:FlowerBed:FlowerBed-1/attrs/soilMoistureVwc/value?limit=100" \
+    --header "Fiware-Service: carouge" \
+    --header "Fiware-ServicePath: /Watering" \
+    --header "Accept: application/json"
+    #| python -mjson.tool

scripts/requirements.txt

+requests
\ No newline at end of file

scripts/security_02_request_without_token.sh

@@ -8,4 +8,4 @@ echo "Querying Fiware entrypoint (PEP_PROXY) at: ${FIWARE_PROXY_HOST}"
 curl -X GET \
   "http://$FIWARE_PROXY_HOST:1027/v2/entities/urn:ngsi-ld:FlowerBed:FlowerBed-345/attrs/soilMoistureVwc/value"\
   --header "Fiware-Service: carouge" \
-  --header "Fiware-ServicePath: /watering"
+  --header "Fiware-ServicePath: /Watering"

scripts/security_03_request_with_token.sh

@@ -10,6 +10,6 @@ echo "Querying Fiware entrypoint (PEP_PROXY) at: ${FIWARE_PROXY_HOST}"
 curl -X GET \
   "http://$FIWARE_PROXY_HOST:1027/v2/entities/urn:ngsi-ld:FlowerBed:FlowerBed-345/attrs/soilMoistureVwc/value"\
   --header "Fiware-Service: carouge" \
-  --header "Fiware-ServicePath: /watering" \
+  --header "Fiware-ServicePath: /Watering" \
   --header "X-Auth-Token: $KEYROCK_TOKEN"
 

scripts/security_04_update_entity_with_token.sh

@@ -10,7 +10,7 @@ echo "Querying Fiware entrypoint (PEP_PROXY) at: ${FIWARE_PROXY_HOST}"
 curl --location --request PUT \
     "http://$FIWARE_PROXY_HOST:1027/v2/entities/urn:ngsi-ld:FlowerBed:FlowerBed-345/attrs/soilMoistureVwc/value"\
     --header "Fiware-Service: carouge" \
-    --header "Fiware-ServicePath: /watering" \
+    --header "Fiware-ServicePath: /Watering" \
     --header "X-Auth-Token: $KEYROCK_TOKEN" \
     --header "Content-Type: text/plain" \
     -d $(( RANDOM % 10 ))

scripts/security_05_subscribe_to_entity_with_token.sh

@@ -17,7 +17,7 @@ echo "Callback URL for subscriptions is: ${SUBSCRIPTION_URL}"
 curl --location --request POST \
     "http://$ORION_HOST:1026/v2/subscriptions/" \
     --header "Fiware-Service: carouge" \
-    --header "Fiware-ServicePath: /watering" \
+    --header "Fiware-ServicePath: /Watering" \
     --header "Content-Type: application/json" \
     --header "Accept: application/json" \
     --header "X-Auth-Token: $KEYROCK_TOKEN" \

scripts/watering_01_create_entity.sh

@@ -4,47 +4,23 @@
 echo "Querying context broker at: ${ORION_HOST}"
 
 curl -iX POST \
-    "http://$ORION_HOST:1026/v2/entities/" \
+    "http://$ORION_HOST:1026/v2/entities/?options=keyValues" \
     --header "Fiware-Service: carouge" \
-    --header "Fiware-ServicePath: /watering" \
+    --header "Fiware-ServicePath: /Watering" \
     --header "Content-Type: application/json" \
     --data '{
-        "id": "urn:ngsi-ld:FlowerBed:FlowerBed-345",
+        "id": "urn:ngsi-ld:FlowerBed:FlowerBed-1",
         "type": "FlowerBed",
-        "category": {
-            "type": "Property",
-            "value": ["urbanTreeSpot"]
-        },
-        "soilMoistureVwc": {
-            "type": "Property",
-            "value": 0.85
-        },
-        "dateLastWatering": {
-            "type": "Property",
-            "value": {
-                "@type": "DateTime",
-                "@value": "2020-02-11T08:00:00Z"
-            }
-        },
-        "soilTemperature": {
-            "type": "Property",
-            "value": 17
-        },
+        "dateModified":"2017-03-31T08:00",
+        "category": ["urbanTreeSpot"],
+        "dateLastWatering": "2017-03-31T08:00",
+        "nextWateringDeadline":"2017-04-31T08:00",
         "address": {
-            "type": "Property",
-            "value": {
-                "addressCountry": "Switzerland",
-                "streetAddress": "Place de Sardaigne",
-                "adressLocality": "Carouge",
-                "type": "PostalAddress"
-            }
+            "streetAddress": "Place de Sardaigne",
+            "adressLocality": "Carouge",
+            "addressCountry": "Switzerland"
         },
-        "location": {
-            "type": "GeoProperty",
-            "value": {
-                "type": "Point",
-                "coordinates": [46.184255,6.1378375]
-            }
-        }
+        "soilTemperature": 17,
+        "soilMoistureVwc": 0.85
     }
-'
+    '

scripts/watering_02_retrieve_entities.sh

@@ -6,5 +6,5 @@ echo "Querying context broker at: ${ORION_HOST}"
 curl --location --request GET \
     "http://$ORION_HOST:1026/v2/entities/" \
     --header "Fiware-Service: carouge" \
-    --header "Fiware-ServicePath: /watering" \
+    --header "Fiware-ServicePath: /Watering" \
     | python -mjson.tool

scripts/watering_03_retrieve_entity_keyValues_by_id.sh

@@ -4,7 +4,7 @@
 echo "Querying context broker at: ${ORION_HOST}"
 
 curl --location --request GET \
-    "http://$ORION_HOST:1026/v2/entities/urn:ngsi-ld:FlowerBed:FlowerBed-345?options=keyValues" \
+    "http://$ORION_HOST:1026/v2/entities/urn:ngsi-ld:FlowerBed:FlowerBed-1?options=keyValues" \
     --header "Fiware-Service: carouge" \
-    --header "Fiware-ServicePath: /watering" \
+    --header "Fiware-ServicePath: /Watering" \
     | python -mjson.tool
\ No newline at end of file

scripts/watering_04_retrieve_attribute_value.sh

@@ -4,13 +4,13 @@
 echo "Querying context broker at: ${ORION_HOST}"
 
 curl --location --request GET \
-    "http://$ORION_HOST:1026/v2/entities/urn:ngsi-ld:FlowerBed:FlowerBed-345/attrs/soilMoistureVwc/value" \
+    "http://$ORION_HOST:1026/v2/entities/urn:ngsi-ld:FlowerBed:FlowerBed-1/attrs/soilMoistureVwc/value" \
     --header "Fiware-Service: carouge" \
-    --header "Fiware-ServicePath: /watering" \
+    --header "Fiware-ServicePath: /Watering" \
     | python -mjson.tool
 
 #curl --location --request GET \
 #    "http://$ORION_HOST:1026/v2/entities/urn:ngsi-ld:FlowerBed:FlowerBed-345/attrs/location/value" \
 #    --header "Fiware-Service: carouge" \
-#    --header "Fiware-ServicePath: /watering" \
+#    --header "Fiware-ServicePath: /Watering" \
 #    | python -mjson.tool
\ No newline at end of file

scripts/watering_05_retrieve_attribute.sh

@@ -4,13 +4,8 @@
 echo "Querying context broker at: ${ORION_HOST}"
 
 curl --location --request GET \
-    "http://$ORION_HOST:1026/v2/entities/urn:ngsi-ld:FlowerBed:FlowerBed-345/attrs/soilMoistureVwc" \
+    "http://$ORION_HOST:1026/v2/entities/urn:ngsi-ld:FlowerBed:FlowerBed-1/attrs/soilMoistureVwc" \
     --header "Fiware-Service: carouge" \
-    --header "Fiware-ServicePath: /watering" \
+    --header "Fiware-ServicePath: /Watering" \
     | python -mjson.tool
 
-#curl --location --request GET \
-#    "http://$ORION_HOST:1026/v2/entities/urn:ngsi-ld:FlowerBed:FlowerBed-345/attrs/location" \
-#    --header "Fiware-Service: carouge" \
-#    --header "Fiware-ServicePath: /watering" \
-#    | python -mjson.tool
\ No newline at end of file