[LNT] API: add Fields resource.

[marxin]

Summary

If you need to automatically generate some plots that group multiple tests, you can't do it without knowledge of fields IDs.
That's why I would like to add that. Note that the change requires documentation to be generated. Is it done automatically?

Sample output:

{"fields": [{"column_id": 0, "column_name": "execution_time"}, {"column_id": 1, "column_name": "compile_time"}, {"column_id": 2, "column_name": "score"}, {"column_id": 3, "column_name": "compilation_status"}, {"column_id": 4, "column_name": "execution_status"}, {"column_id": 5, "column_name": "size"}, {"column_id": 6, "column_name": "size_status"}, {"column_id": 7, "column_name": "md5sum"}, {"column_id": 8, "column_name": "count"}], "generated_by": "LNT Server v0.4.2.dev0"}

[cmatthews]

Could you add a test case to the api tests that make a request on this?

[marxin]

In D44007#1025802, @cmatthews wrote:

Could you add a test case to the api tests that make a request on this?

Sure, however it looks the test_api test is broken for me:
https://bugs.llvm.org/show_bug.cgi?id=36597

Can you please help me?

[marxin]

May I please remind a patch review.

[marxin]

• added new test-case

[marxin]

May I please gently ping that..

[cmatthews]

LGTM. Thanks

lnt/trunk/docs/api.rst

 | /samples?runid=1&runid=2  | Retrieve all the sample data for a list of run ids.  Run IDs should be pass as args.     |
 |                           | Will return sample data in the samples section, as a list of dicts, with a key for       |
 |                           | each metric type. Empty samples are not sent.                                            |
 +---------------------------+------------------------------------------------------------------------------------------+
 | /samples/`id`             | Get all non-empty sample info for Sample `id`.                                           |
 +---------------------------+------------------------------------------------------------------------------------------+
 | /schema                   | Return test suite schema.                                                                |
 +---------------------------+------------------------------------------------------------------------------------------+
+| /fields                   | Return all fields in this testsuite.                                                     |
++---------------------------+------------------------------------------------------------------------------------------+
 
 .. _auth_tokens:
 
 Write Operations
 ----------------
 
 The machines, orders and runs endpoints also support the DELETE http method.  The user must include a http header called
 "AuthToken" which has the API auth token set in the LNT instance configuration.

lnt/trunk/lnt/server/ui/api.py

def common_fields_factory():
     }
     return common_data
 
 
 def add_common_fields(to_update):
     """Update a dict with the common fields."""
     to_update.update(common_fields_factory())
 
+class Fields(Resource):
+    """List all the fields in the test suite."""
+    method_decorators = [in_db]
+
+    @staticmethod
+    def get():
+        ts = request.get_testsuite()
+
+        result = common_fields_factory()
+        result['fields'] = [{'column_id': i, 'column_name': f.column.name}
+                for i, f in enumerate(ts.sample_fields)]
+        return result
 
 class Machines(Resource):
     """List all the machines and give summary information."""
     method_decorators = [in_db]
 
     @staticmethod
     def get():
         ts = request.get_testsuite()
def load_api_resources(api):
     def output_json(data, code, headers=None):
         '''Override output_json() to use LNT json encoder'''
         resp = make_response(json.dumps(data), code)
         resp.headers.add('Access-Control-Allow-Origin', '*')
         if headers is not None:
             resp.headers.extend(headers)
         return resp
 
+    api.add_resource(Fields, ts_path("fields"), ts_path("fields/"))
     api.add_resource(Machines, ts_path("machines"), ts_path("machines/"))
     api.add_resource(Machine, ts_path("machines/<machine_spec>"))
     api.add_resource(Runs, ts_path("runs"), ts_path("runs/"))
     api.add_resource(Run, ts_path("runs/<int:run_id>"))
     api.add_resource(SamplesData, ts_path("samples"), ts_path("samples/"))
     api.add_resource(SampleData, ts_path("samples/<sample_id>"))
     api.add_resource(Schema, ts_path("schema"), ts_path("schema/"))
     api.add_resource(Order, ts_path("orders/<int:order_id>"))
     graph_url = "graph/<int:machine_id>/<int:test_id>/<int:field_index>"
     api.add_resource(Graph, ts_path(graph_url))
     regression_url = \
         "regression/<int:machine_id>/<int:test_id>/<int:field_index>"
     api.add_resource(Regression, ts_path(regression_url))

lnt/trunk/tests/server/ui/test_api.py

def test_samples_api(self):
         self._check_response_is_well_formed(extra_param)
         self.assertEqual(j, extra_param)
         # There is only one run in the DB.
         two_runs = check_json(client,
                               'api/db_default/v4/nts/samples?runid=1&runid=2')
         self._check_response_is_well_formed(two_runs)
         self.assertEqual(j, two_runs)
 
+    def test_fields_api(self):
+        """Fields API."""
+        client = self.client
+        j = check_json(client, 'api/db_default/v4/nts/fields')
+
+        fields = j['fields']
+
+        # check number of fields
+        self.assertEqual(9, len(fields))
+
+        # check first field
+        f0 = fields[0]
+        self.assertEqual(0, f0['column_id'])
+        self.assertEqual('compile_status', f0['column_name'])
+
     def test_schema(self):
         client = self.client
         rest_schema = check_json(client, 'api/db_default/v4/nts/schema')
 
         # The reported schema should be the same as the yaml one on the top.
         with open('%s/schemas/nts.yaml' % self.instance_path) as syaml:
             yaml_schema = yaml.load(syaml)
             # Do some massaging to make it similar to the rest API result.