Merge pull request #168 from canonical/agent-identifier-field

Add an identifier field for associating devices based on CID

agent/README.rst

@@ -45,6 +45,10 @@ The following configuration options are supported:
 
   - Unique identifier for this agent
 
+- **identifier**:
+
+  - Additional identifier such as a serial number that will be sent to the server and can be used for cross-referencing with other systems
+
 - **polling_interval**:
 
   - Time to sleep between polling for new tests (default: 10s)

agent/testflinger_agent/agent.py

@@ -37,7 +37,12 @@ def _post_initial_agent_data(self):
         self._post_advertised_images()
 
         queues = self.client.config.get("job_queues", [])
-        self.client.post_agent_data({"queues": queues, "location": location})
+        identifier = self.client.config.get("identifier")
+        agent_data = {"queues": queues, "location": location}
+        if identifier:
+            agent_data["identifier"] = identifier
+
+        self.client.post_agent_data(agent_data)
 
     def _post_advertised_queues(self):
         """

agent/testflinger_agent/schema.py

@@ -17,6 +17,8 @@
 
 SCHEMA_V1 = {
     voluptuous.Required("agent_id"): str,
+    voluptuous.Optional("identifier"): str,
+    voluptuous.Optional("location"): str,
     voluptuous.Required("polling_interval", default=10): int,
     voluptuous.Required("server_address"): str,
     voluptuous.Required(

agent/testflinger_agent/tests/test_agent.py

@@ -20,6 +20,7 @@ def agent(self, requests_mock):
         self.tmpdir = tempfile.mkdtemp()
         self.config = {
             "agent_id": "test01",
+            "identifier": "12345-123456",
             "polling_interval": "2",
             "server_address": "127.0.0.1:8000",
             "job_queues": ["test"],
@@ -215,6 +216,7 @@ def test_post_agent_data(self, agent):
             agent._post_initial_agent_data()
             mock_post_agent_data.assert_called_with(
                 {
+                    "identifier": self.config["identifier"],
                     "queues": self.config["job_queues"],
                     "location": self.config["location"],
                 }

agent/testflinger_agent/tests/test_config.py

@@ -21,8 +21,10 @@
 
 GOOD_CONFIG = """
 agent_id: test01
+identifier: 12345-123456
 polling_interval: 10
 server_address: 127.0.0.1:8000
+location: earth
 job_queues:
     - test
 """

docs/reference/testflinger-agent-conf.rst

@@ -12,6 +12,8 @@ The following configuration options are supported by the Testflinger Agent:
       - Description  
     * - ``agent_id``
       - Unique identifier for this agent
+    * - ``identifier``
+      - Additional identifier such as a serial number that will be sent to the server and can be used for cross-referencing with other systems
     * - ``polling_interval``
       - Time to sleep between polling for new tests (default: 10s)
     * - ``server_address``