健全性チェック¶

QuantumLeap のデプロイが完全で機能していることを確認するために、これらの健全性チェック (Sanity Check) に従うことができます。

この手順では、localhost にマップされたポートを使用して、ローカルの Docker ベースのデプロイを想定しています。もちろん、デプロイに合わせてサービスの IP アドレスを更新する必要があります。

手動の健全性チェック¶

プロセスを手動で実行すると、フローに精通するのに役立ちます。お手伝いするために、この postman collection で Orion と QuantumLeap のリクエストを使用することができます。 Postman を使用しない場合は、以下の同等の curl コマンドを使用できます。

Orion のバージョンを確認できますか?

$ curl -X GET http://0.0.0.0:1026/version -H 'Accept: application/json'

200 OK の返信ステータスを取得する必要があります。

QuantumLeap のバージョンを確認できますか？

$ curl -X GET http://0.0.0.0:8668/version -H 'Accept: application/json'

200 OK の返信ステータスを取得する必要があります。

"QuantumLeap Subscribe" を通して、Orion のサブスクリプションを作成

$ curl -X POST \
'http://0.0.0.0:8668/v2/subscribe?orionUrl=http://orion:1026/v2&quantumleapUrl=http://quantumleap:8668/v2&entityType=AirQualityObserved' \
-H 'Accept: application/json'

AirQualityObserved 型のエンティティの任意の属性の変更についてサブスクリプションを作成したばかりです。201 Created の返信ステータスを取得する必要があります。

Orion から次のようなサブスクリプションを取得を確認できますか？

$ curl -X GET http://0.0.0.0:1026/v2/subscriptions \
-H 'Accept: application/json'

200 OK の返信ステータスを取得する必要があります。

Orion に AirQualityObserved のエンティティを挿入します。

$ curl -X POST \
'http://0.0.0.0:1026/v2/entities?options=keyValues' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"id": "air_quality_observer_be_001",
"type": "AirQualityObserved",
"address": {
"streetAddress": "IJzerlaan",
"postOfficeBoxNumber": "18",
"addressLocality": "Antwerpen",
"addressCountry": "BE"
},
"dateObserved": "2017-11-03T12:37:23.734827",
"source": "http://testing.data.from.smartsdk",
"precipitation": 0,
"relativeHumidity": 0.54,
"temperature": 12.2,
"windDirection": 186,
"windSpeed": 0.64,
"airQualityLevel": "moderate",
"airQualityIndex": 65,
"reliability": 0.7,
"CO": 500,
"NO": 45,
"NO2": 69,
"NOx": 139,
"SO2": 11,
"CO_Level": "moderate",
"refPointOfInterest": "null"
}'

201 Created の返信ステータスを取得する必要があります。

これはサニティチェックであるため、簡略化のために options=keyValues を使用しています。実際にこのようなオプションを使用すると、ユーザ・ガイドで説明されているように変換機能が失われる可能性があります。

Orion の同じエンティティの降水値を更新します。

$ curl -X PATCH \
http://0.0.0.0:1026/v2/entities/air_quality_observer_be_001/attrs \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"precipitation": {
"value": 100,
"type": "Number"
}
}'

204 No Content の返信ステータスを取得する必要があります。

同じエンティティ (1T1E1A) の降水量の履歴記録を再度クエリします。

$ curl -X GET \
'http://0.0.0.0:8668/v2/entities/air_quality_observer_be_001/attrs/precipitation?type=AirQualityObserved' \
-H 'Accept: application/json'

200 OK の返信ステータスとレスポンス・ボディの履歴レコードを取得する必要があります。

最後に、整理するために、作成したすべてのレコードを削除することができます。

QuantumLeap からレコードを削除します

$ curl -X DELETE http://0.0.0.0:8668/v2/types/AirQualityObserved

Orion からエンティティを削除します

$ curl -X DELETE \
http://0.0.0.0:1026/v2/entities/air_quality_observer_be_001 \
-H 'Accept: application/json'

Orion からのサブスクリプションを削除します。id があなたのものに置き換えられます

$ curl -X DELETE \
http://0.0.0.0:1026/v2/subscriptions/5b3df2ae940fcc446763ef90 \
-H 'Accept: application/json'

自動の健全性チェック¶

フローに精通していて、重要なサービスが正しく展開されているかどうかを素早くチェックしたい場合は、コア・コンポーネント間の接続を正確にチェックする統合テストを利用できます。

重要 : 貴重なデータを含む実稼働環境でこのスクリプトを実行することは推奨されていません。テストで問題が起これば、ゴミ・データが残ったり、データが失われたりする可能性があります。常にそうであるように、自動化は慎重に使用してください。

ここにテストスクリプトがあります。デプロイに応じて、設定する必要のある入力変数に注意してください。これらは、コア・サービスを見つけるための URL を示します。デフォルトでは、すべてのサービスはローカルの Docker ベースのデプロイで実行されているものとみなされます。

次のように、コンテナ内でテストをすばやく実行できます。もちろん、デプロイされたサービスを指すように、URLを調整する必要があります。次の例では、Orion と QuantumLeap にテスト・コンテナによって、192.0.0.1 に到達可能であり、Orion と QuantumLeap は、デフォルトで、orion と quantumleap エンドポイントで検索されます。なぜなら両方が同じ Docker ネットワークにデプロイされているからです。

$ docker run -ti --rm -e ORION_URL="http://192.0.0.1:1026" -e QL_URL="http://192.0.0.1:8668" quantumleap pytest tests/test_integration.py

または、すべてのサービスが同じ Docker デプロイメントにあり、そのサービスにアクセスできると仮定すると、同じネットワーク内でテスト・コンテナを実行して、URL 内のサービス名を使用することができます。

$ docker run -ti --rm --network docker_default -e ORION_URL="http://orion:1026" -e QL_URL="http://quantumleap:8668" quantumleap pytest tests/test_integration.py