open-horizon · bmpotter · Feb 1, 2021 · Feb 1, 2021
diff --git a/README.md b/README.md
@@ -256,9 +256,14 @@ Now you can disable root by setting `api.root.enabled` to `false` in `/etc/horiz
     - detect if a pattern is updated with service that has userInput w/o default values, and give warning
     - Consider changing all creates to POST, and update (via put/patch) return codes to 200
 
+## Changes in 2.58.0
+
+- Issue 445: Add the configState field to the node status API
+- Remove `bluehorizon` from the swagger info. (We've decommissioned that site.)
+
 ## Changes in 2.57.0
 
-- 
+- Issue 435: Add label and description fields to node and service policy objects
 
 ## Changes in 2.56.0
 

diff --git a/doc/openapi-3-developer.json b/doc/openapi-3-developer.json
@@ -2370,7 +2370,7 @@
                     "$ref" : "#/components/schemas/NodeDetails"
                   }
                 },
-                "example" : "[\n  {\n    \"arch\": \"string\",\n    \"connectivity\": {\n      \"string\": boolean,\n      \"string\": boolean\n    },\n    \"constraints\": [\n      \"string\",\n      \"string\",\n      \"string\"\n    ],\n    \"errors\": [\n      {\n        \"event_code\": \"string\",\n        \"hidden\": boolean,\n        \"message\": \"string\",\n        \"record_id\": \"string\"\n      }\n    ],\n    \"heartbeatIntervals\": {\n      \"intervalAdjustment\": 0,\n      \"minInterval\": 0,\n      \"maxInterval\": 0\n    },\n    \"id\": \"string\",\n    \"lastHeartbeat\": \"string\",\n    \"lastUpdatedNode\": \"string\",\n    \"lastUpdatedNodeError\": \"string\",\n    \"lastUpdatedNodePolicy\": \"string\",\n    \"lastUpdatedNodeStatus\": \"string\",\n    \"msgEndPoint\": \"\",\n    \"name\": \"string\",\n    \"nodeType\": \"device\",\n    \"owner\": \"string\",\n    \"orgid\": \"string\",\n    \"pattern\": \"\",\n    \"properties\": [\n      \"string\": \"string\",\n      \"string\": \"string\",\n      \"string\": \"string\"\n    ],\n    \"publicKey\": \"string\",\n    \"registeredServices\": [\n      {\n        \"configState\": \"active\",\n        \"numAgreements\": 0,\n        \"policy\": \"\",\n        \"properties\": [],\n        \"url\": \"string\"\n      },\n      {\n        \"configState\": \"active\",\n        \"numAgreements\": 0,\n        \"policy\": \"\",\n        \"properties\": [],\n        \"url\": \"string\"\n      },\n      {\n        \"configState\": \"active\",\n        \"numAgreements\": 0,\n        \"policy\": \"\",\n        \"properties\": [],\n        \"url\": \"string\",\n      }\n    ],\n    \"runningServices\": \"|orgid/serviceid|\",\n    \"services\": [\n      {\n        \"agreementId\": \"string\",\n        \"arch\": \"string\",\n        \"containerStatus\": [],\n        \"operatorStatus\": {},\n        \"orgid\": \"string\",\n        \"serviceUrl\": \"string\",\n        \"version\": \"string\"\n      }\n    ],\n    \"softwareVersions\": {},\n    \"token\": \"string\",\n    \"userInput\": [\n      {\n        \"inputs\": [\n          {\n            \"name\": \"var1\",\n            \"value\": \"someString\"\n          },\n          {\n            \"name\": \"var2\",\n            \"value\": 5\n          },\n          {\n            \"name\": \"var3\",\n            \"value\": 22.2\n          }\n        ],\n        \"serviceArch\": \"string\",\n        \"serviceOrgid\": \"string\",\n        \"serviceUrl\": \"string\",\n        \"serviceVersionRange\": \"string\"\n      }\n    ],\n  }\n]"
+                "example" : "[\n  {\n    \"arch\": \"string\",\n    \"connectivity\": {\n      \"string\": boolean,\n      \"string\": boolean\n    },\n    \"constraints\": [\n      \"string\",\n      \"string\",\n      \"string\"\n    ],\n    \"errors\": [\n      {\n        \"event_code\": \"string\",\n        \"hidden\": boolean,\n        \"message\": \"string\",\n        \"record_id\": \"string\"\n      }\n    ],\n    \"heartbeatIntervals\": {\n      \"intervalAdjustment\": 0,\n      \"minInterval\": 0,\n      \"maxInterval\": 0\n    },\n    \"id\": \"string\",\n    \"lastHeartbeat\": \"string\",\n    \"lastUpdatedNode\": \"string\",\n    \"lastUpdatedNodeError\": \"string\",\n    \"lastUpdatedNodePolicy\": \"string\",\n    \"lastUpdatedNodeStatus\": \"string\",\n    \"msgEndPoint\": \"\",\n    \"name\": \"string\",\n    \"nodeType\": \"device\",\n    \"owner\": \"string\",\n    \"orgid\": \"string\",\n    \"pattern\": \"\",\n    \"properties\": [\n      \"string\": \"string\",\n      \"string\": \"string\",\n      \"string\": \"string\"\n    ],\n    \"publicKey\": \"string\",\n    \"registeredServices\": [\n      {\n        \"configState\": \"active\",\n        \"numAgreements\": 0,\n        \"policy\": \"\",\n        \"properties\": [],\n        \"url\": \"string\"\n      },\n      {\n        \"configState\": \"active\",\n        \"numAgreements\": 0,\n        \"policy\": \"\",\n        \"properties\": [],\n        \"url\": \"string\"\n      },\n      {\n        \"configState\": \"active\",\n        \"numAgreements\": 0,\n        \"policy\": \"\",\n        \"properties\": [],\n        \"url\": \"string\",\n      }\n    ],\n    \"runningServices\": \"|orgid/serviceid|\",\n    \"services\": [\n      {\n        \"agreementId\": \"string\",\n        \"arch\": \"string\",\n        \"containerStatus\": [],\n        \"operatorStatus\": {},\n        \"orgid\": \"string\",\n        \"serviceUrl\": \"string\",\n        \"version\": \"string\",\n        \"configState\": \"string\"\n      }\n    ],\n    \"softwareVersions\": {},\n    \"token\": \"string\",\n    \"userInput\": [\n      {\n        \"inputs\": [\n          {\n            \"name\": \"var1\",\n            \"value\": \"someString\"\n          },\n          {\n            \"name\": \"var2\",\n            \"value\": 5\n          },\n          {\n            \"name\": \"var3\",\n            \"value\": 22.2\n          }\n        ],\n        \"serviceArch\": \"string\",\n        \"serviceOrgid\": \"string\",\n        \"serviceUrl\": \"string\",\n        \"serviceVersionRange\": \"string\"\n      }\n    ],\n  }\n]"
               }
             }
           },
@@ -3030,7 +3030,8 @@
                     "version" : "string",
                     "arch" : "string",
                     "containerStatus" : [ ],
-                    "operatorStatus" : { }
+                    "operatorStatus" : { },
+                    "configState" : "string"
                   } ],
                   "runningServices" : "|orgid/serviceid|",
                   "lastUpdated" : "string"
@@ -3080,7 +3081,7 @@
               "schema" : {
                 "$ref" : "#/components/schemas/PutNodeStatusRequest"
               },
-              "example" : "{\n  \"connectivity\": {   // (optional)\n    \"firmware.bluehorizon.network\": true,\n    \"images.bluehorizon.network\": true\n  },\n  \"services\": [\n    {\n      \"agreementId\": \"78d7912aafb6c11b7a776f77d958519a6dc718b9bd3da36a1442ebb18fe9da30\",\n      \"serviceUrl\":\"mydomain.com.location\",\n      \"orgid\":\"ling.com\",\n      \"version\":\"1.2\",\n      \"arch\":\"amd64\",\n      \"containerStatus\": [\n        {\n          \"name\": \"/dc23c045eb64e1637d027c4b0236512e89b2fddd3f06290c7b2354421d9d8e0d-location\",\n          \"image\": \"summit.hovitos.engineering/x86/location:v1.2\",\n          \"created\": 1506086099,\n          \"state\": \"running\"\n        }\n      ],\n      \"operatorStatus\": {} // (optional)\n    }\n  ]\n}\n"
+              "example" : "{\n  \"connectivity\": {   // (optional)\n    \"something.network\": true,\n    \"something-else.network\": true\n  },\n  \"services\": [\n    {\n      \"agreementId\": \"78d7912aafb6c11b7a776f77d958519a6dc718b9bd3da36a1442ebb18fe9da30\",\n      \"serviceUrl\":\"mydomain.com.location\",\n      \"orgid\":\"ling.com\",\n      \"version\":\"1.2\",\n      \"arch\":\"amd64\",\n      \"containerStatus\": [\n        {\n          \"name\": \"/dc23c045eb64e1637d027c4b0236512e89b2fddd3f06290c7b2354421d9d8e0d-location\",\n          \"image\": \"summit.hovitos.engineering/x86/location:v1.2\",\n          \"created\": 1506086099,\n          \"state\": \"running\"\n        }\n      ],\n      \"operatorStatus\": {}, // (optional)\n      \"configState\": \"active\" // (optional)\n    }\n  ]\n}\n"
             }
           },
           "required" : true
@@ -8468,7 +8469,8 @@
           },
           "operatorStatus" : {
             "type" : "object"
-          }
+          },
+          "configState" : "string"
         }
       },
       "ListNodeErrorsResp" : {

diff --git a/doc/openapi-3-user.json b/doc/openapi-3-user.json
@@ -1701,7 +1701,7 @@
                     "$ref" : "#/components/schemas/NodeDetails"
                   }
                 },
-                "example" : "[\n  {\n    \"arch\": \"string\",\n    \"connectivity\": {\n      \"string\": boolean,\n      \"string\": boolean\n    },\n    \"constraints\": [\n      \"string\",\n      \"string\",\n      \"string\"\n    ],\n    \"errors\": [\n      {\n        \"event_code\": \"string\",\n        \"hidden\": boolean,\n        \"message\": \"string\",\n        \"record_id\": \"string\"\n      }\n    ],\n    \"heartbeatIntervals\": {\n      \"intervalAdjustment\": 0,\n      \"minInterval\": 0,\n      \"maxInterval\": 0\n    },\n    \"id\": \"string\",\n    \"lastHeartbeat\": \"string\",\n    \"lastUpdatedNode\": \"string\",\n    \"lastUpdatedNodeError\": \"string\",\n    \"lastUpdatedNodePolicy\": \"string\",\n    \"lastUpdatedNodeStatus\": \"string\",\n    \"msgEndPoint\": \"\",\n    \"name\": \"string\",\n    \"nodeType\": \"device\",\n    \"owner\": \"string\",\n    \"orgid\": \"string\",\n    \"pattern\": \"\",\n    \"properties\": [\n      \"string\": \"string\",\n      \"string\": \"string\",\n      \"string\": \"string\"\n    ],\n    \"publicKey\": \"string\",\n    \"registeredServices\": [\n      {\n        \"configState\": \"active\",\n        \"numAgreements\": 0,\n        \"policy\": \"\",\n        \"properties\": [],\n        \"url\": \"string\"\n      },\n      {\n        \"configState\": \"active\",\n        \"numAgreements\": 0,\n        \"policy\": \"\",\n        \"properties\": [],\n        \"url\": \"string\"\n      },\n      {\n        \"configState\": \"active\",\n        \"numAgreements\": 0,\n        \"policy\": \"\",\n        \"properties\": [],\n        \"url\": \"string\",\n      }\n    ],\n    \"runningServices\": \"|orgid/serviceid|\",\n    \"services\": [\n      {\n        \"agreementId\": \"string\",\n        \"arch\": \"string\",\n        \"containerStatus\": [],\n        \"operatorStatus\": {},\n        \"orgid\": \"string\",\n        \"serviceUrl\": \"string\",\n        \"version\": \"string\"\n      }\n    ],\n    \"softwareVersions\": {},\n    \"token\": \"string\",\n    \"userInput\": [\n      {\n        \"inputs\": [\n          {\n            \"name\": \"var1\",\n            \"value\": \"someString\"\n          },\n          {\n            \"name\": \"var2\",\n            \"value\": 5\n          },\n          {\n            \"name\": \"var3\",\n            \"value\": 22.2\n          }\n        ],\n        \"serviceArch\": \"string\",\n        \"serviceOrgid\": \"string\",\n        \"serviceUrl\": \"string\",\n        \"serviceVersionRange\": \"string\"\n      }\n    ],\n  }\n]"
+                "example" : "[\n  {\n    \"arch\": \"string\",\n    \"connectivity\": {\n      \"string\": boolean,\n      \"string\": boolean\n    },\n    \"constraints\": [\n      \"string\",\n      \"string\",\n      \"string\"\n    ],\n    \"errors\": [\n      {\n        \"event_code\": \"string\",\n        \"hidden\": boolean,\n        \"message\": \"string\",\n        \"record_id\": \"string\"\n      }\n    ],\n    \"heartbeatIntervals\": {\n      \"intervalAdjustment\": 0,\n      \"minInterval\": 0,\n      \"maxInterval\": 0\n    },\n    \"id\": \"string\",\n    \"lastHeartbeat\": \"string\",\n    \"lastUpdatedNode\": \"string\",\n    \"lastUpdatedNodeError\": \"string\",\n    \"lastUpdatedNodePolicy\": \"string\",\n    \"lastUpdatedNodeStatus\": \"string\",\n    \"msgEndPoint\": \"\",\n    \"name\": \"string\",\n    \"nodeType\": \"device\",\n    \"owner\": \"string\",\n    \"orgid\": \"string\",\n    \"pattern\": \"\",\n    \"properties\": [\n      \"string\": \"string\",\n      \"string\": \"string\",\n      \"string\": \"string\"\n    ],\n    \"publicKey\": \"string\",\n    \"registeredServices\": [\n      {\n        \"configState\": \"active\",\n        \"numAgreements\": 0,\n        \"policy\": \"\",\n        \"properties\": [],\n        \"url\": \"string\"\n      },\n      {\n        \"configState\": \"active\",\n        \"numAgreements\": 0,\n        \"policy\": \"\",\n        \"properties\": [],\n        \"url\": \"string\"\n      },\n      {\n        \"configState\": \"active\",\n        \"numAgreements\": 0,\n        \"policy\": \"\",\n        \"properties\": [],\n        \"url\": \"string\",\n      }\n    ],\n    \"runningServices\": \"|orgid/serviceid|\",\n    \"services\": [\n      {\n        \"agreementId\": \"string\",\n        \"arch\": \"string\",\n        \"containerStatus\": [],\n        \"operatorStatus\": {},\n        \"orgid\": \"string\",\n        \"serviceUrl\": \"string\",\n        \"version\": \"string\",\n        \"configState\": \"string\"\n      }\n    ],\n    \"softwareVersions\": {},\n    \"token\": \"string\",\n    \"userInput\": [\n      {\n        \"inputs\": [\n          {\n            \"name\": \"var1\",\n            \"value\": \"someString\"\n          },\n          {\n            \"name\": \"var2\",\n            \"value\": 5\n          },\n          {\n            \"name\": \"var3\",\n            \"value\": 22.2\n          }\n        ],\n        \"serviceArch\": \"string\",\n        \"serviceOrgid\": \"string\",\n        \"serviceUrl\": \"string\",\n        \"serviceVersionRange\": \"string\"\n      }\n    ],\n  }\n]"
               }
             }
           },
@@ -2008,7 +2008,8 @@
                     "version" : "string",
                     "arch" : "string",
                     "containerStatus" : [ ],
-                    "operatorStatus" : { }
+                    "operatorStatus" : { },
+                    "configState" : "string"
                   } ],
                   "runningServices" : "|orgid/serviceid|",
                   "lastUpdated" : "string"
@@ -2058,7 +2059,7 @@
               "schema" : {
                 "$ref" : "#/components/schemas/PutNodeStatusRequest"
               },
-              "example" : "{\n  \"connectivity\": {   // (optional)\n    \"firmware.bluehorizon.network\": true,\n    \"images.bluehorizon.network\": true\n  },\n  \"services\": [\n    {\n      \"agreementId\": \"78d7912aafb6c11b7a776f77d958519a6dc718b9bd3da36a1442ebb18fe9da30\",\n      \"serviceUrl\":\"mydomain.com.location\",\n      \"orgid\":\"ling.com\",\n      \"version\":\"1.2\",\n      \"arch\":\"amd64\",\n      \"containerStatus\": [\n        {\n          \"name\": \"/dc23c045eb64e1637d027c4b0236512e89b2fddd3f06290c7b2354421d9d8e0d-location\",\n          \"image\": \"summit.hovitos.engineering/x86/location:v1.2\",\n          \"created\": 1506086099,\n          \"state\": \"running\"\n        }\n      ],\n      \"operatorStatus\": {} // (optional)\n    }\n  ]\n}\n"
+              "example" : "{\n  \"connectivity\": {   // (optional)\n    \"something.network\": true,\n    \"something-else.network\": true\n  },\n  \"services\": [\n    {\n      \"agreementId\": \"78d7912aafb6c11b7a776f77d958519a6dc718b9bd3da36a1442ebb18fe9da30\",\n      \"serviceUrl\":\"mydomain.com.location\",\n      \"orgid\":\"ling.com\",\n      \"version\":\"1.2\",\n      \"arch\":\"amd64\",\n      \"containerStatus\": [\n        {\n          \"name\": \"/dc23c045eb64e1637d027c4b0236512e89b2fddd3f06290c7b2354421d9d8e0d-location\",\n          \"image\": \"summit.hovitos.engineering/x86/location:v1.2\",\n          \"created\": 1506086099,\n          \"state\": \"running\"\n        }\n      ],\n      \"operatorStatus\": {}, // (optional)\n      \"configState\": \"active\" // (optional)\n    }\n  ]\n}\n"
             }
           },
           "required" : true
@@ -7033,7 +7034,8 @@
           },
           "operatorStatus" : {
             "type" : "object"
-          }
+          },
+          "configState" : "string"
         }
       },
       "GetAdminStatusResponse" : {

diff --git a/src/main/resources/version.txt b/src/main/resources/version.txt
@@ -1 +1 @@
-2.57.0
+2.58.0
diff --git a/src/main/scala/com/horizon/exchangeapi/NodesRoutes.scala b/src/main/scala/com/horizon/exchangeapi/NodesRoutes.scala
@@ -1389,7 +1389,8 @@ trait NodesRoutes extends JacksonSupport with AuthenticationSupport {
       "version": "string",
       "arch": "string",
       "containerStatus": [],
-      "operatorStatus": {}
+      "operatorStatus": {},
+      "configState": "string"
     }
   ],
   "runningServices": "|orgid/serviceid|",
@@ -1445,8 +1446,7 @@ trait NodesRoutes extends JacksonSupport with AuthenticationSupport {
             new ExampleObject(
               value = """{
   "connectivity": {   // (optional)
-    "firmware.bluehorizon.network": true,
-    "images.bluehorizon.network": true
+    "string": true
   },
   "services": [
     {
@@ -1463,7 +1463,8 @@ trait NodesRoutes extends JacksonSupport with AuthenticationSupport {
           "state": "running"
         }
       ],
-      "operatorStatus": {} // (optional)
+      "operatorStatus": {}, // (optional)
+      "configState": "active" // (optional)
     }
   ]
 }
@@ -2458,7 +2459,8 @@ trait NodesRoutes extends JacksonSupport with AuthenticationSupport {
         "operatorStatus": {},
         "orgid": "string",
         "serviceUrl": "string",
-        "version": "string"
+        "version": "string",
+        "configState": "string"
       }
     ],
     "softwareVersions": {},

diff --git a/src/main/scala/com/horizon/exchangeapi/tables/Nodes.scala b/src/main/scala/com/horizon/exchangeapi/tables/Nodes.scala
@@ -242,7 +242,7 @@ object NodesTQ {
 
 // Status is a sub-resource of node
 final case class ContainerStatus(name: String, image: String, created: Int, state: String)
-final case class OneService(agreementId: String, serviceUrl: String, orgid: String, version: String, arch: String, containerStatus: List[ContainerStatus], operatorStatus: Option[Any])
+final case class OneService(agreementId: String, serviceUrl: String, orgid: String, version: String, arch: String, containerStatus: List[ContainerStatus], operatorStatus: Option[Any], configState: Option[String])
 
 final case class NodeStatusRow(nodeId: String, connectivity: String, services: String, runningServices: String, lastUpdated: String) {
   protected implicit val jsonFormats: Formats = DefaultFormats

diff --git a/src/test/bash/primedb.sh b/src/test/bash/primedb.sh
@@ -509,7 +509,7 @@ fi
 rc=$(curlfind $userauth "orgs/$orgid/nodes/$nodeid/status")
 checkrc "$rc" 200 404
 if [[ $rc != 200 ]]; then
-    curlcreate "PUT" $nodeauth "orgs/$orgid/nodes/$nodeid/status" '{ "connectivity": {"firmware.bluehorizon.network": true}, "services": [] }'
+    curlcreate "PUT" $nodeauth "orgs/$orgid/nodes/$nodeid/status" '{ "connectivity": {"something.network": true}, "services": [{"agreementId": "abc","arch": "'$svcarch'","containerStatus": [],"orgid": "'$orgid'","serviceUrl": "'$svcurl'","version": "'$svcversion'","configState":"active"}] }'
 else
     echo "orgs/$orgid/nodes/$nodeid/status exists"
 fi

diff --git a/src/test/go/node/node.go b/src/test/go/node/node.go
@@ -291,7 +291,7 @@ func main() {
 		mynodeauth := org + "/" + mynodeid + ":" + nodetoken
 
 		// Update node status when the services stop running
-		perfutils.ExchangeP(http.MethodPut, "orgs/"+org+"/nodes/"+mynodeid+"/status", mynodeauth, nil, `{ "connectivity": {"firmware.bluehorizon.network": true}, "services": [] }`, nil, true)
+		perfutils.ExchangeP(http.MethodPut, "orgs/"+org+"/nodes/"+mynodeid+"/status", mynodeauth, nil, `{ "connectivity": {"something.network": true}, "services": [] }`, nil, true)
 	}
 
 	// Don't need to delete the msgs, they'll get deleted with the node

diff --git a/src/test/scala/com/horizon/exchangeapi/AgbotsSuite.scala b/src/test/scala/com/horizon/exchangeapi/AgbotsSuite.scala
@@ -70,8 +70,8 @@ class AgbotsSuite extends AnyFunSuite {
   val busPolId = orgid + "_" + businessPol + "_" + orgid
   val businessPol2 = "*"
   val busPolId2 = orgid2 + "_" + businessPol2 + "_" + orgid2
-  val svcid = "bluehorizon.network-services-netspeed_1.0.0_amd64"
-  val svcurl = "https://bluehorizon.network/services/netspeed"
+  val svcid = "horizon-services-netspeed_1.0.0_amd64"
+  val svcurl = "https://horizon/services/netspeed"
   val svcarch = "amd64"
   val svcversion = "1.0.0"
   val nodeId = "mynode"