Add getBuildStages API

related: #777

Signed-off-by: Lan Xia <Lan_Xia@ca.ibm.com>

TestResultSummaryService/JenkinsApiQuery.js

@@ -0,0 +1,36 @@
+const got = require('got');
+const url = require('url');
+const { logger, addCredential } = require('./Utils');
+const ArgParser = require('./ArgParser');
+
+class JenkinsApiQuery {
+    constructor(options) {
+        this.credentails = ArgParser.getConfig();
+        const build = options.build || 'lastBuild';
+        this.url =
+            addCredential(this.credentails, options.baseUrl) +
+            '/job/' +
+            options.job +
+            '/' +
+            build +
+            '/';
+    }
+
+    async getBuildStages() {
+        const wfapi = this.url + 'wfapi/describe';
+        logger.debug(
+            `JenkinsApiQuery: getStages(): [CIServerRequest] url: ${wfapi}`
+        );
+        const response = await got.get(wfapi, {
+            followRedirect: true,
+            timeout: 1 * 60 * 1000,
+        });
+        if (response.body.length === 0) {
+            return '';
+        } else {
+            return response.body;
+        }
+    }
+}
+
+module.exports = JenkinsApiQuery;

TestResultSummaryService/routes/getBuildStages.js

@@ -0,0 +1,25 @@
+const JenkinsApiQuery = require('../JenkinsApiQuery');
+
+/**
+ * getBuildStages query Jenkins via REST API
+ *
+ * @route GET /api/getBuildStages
+ * @param {string} url Required. Jenkins server url (it is used to identify the build).
+ * @param {string} buildName Required.
+ * @param {string} buildNum Required.
+ */
+
+module.exports = async (req, res) => {
+    const { url, buildName, buildNum } = req.query;
+    try {
+        const jenkinsApiQuery = new JenkinsApiQuery({
+            baseUrl: url,
+            job: buildName,
+            build: parseInt(buildNum, 10),
+        });
+        const output = await jenkinsApiQuery.getBuildStages();
+        res.send(output);
+    } catch (e) {
+        res.send({ result: e.toString() });
+    }
+};

TestResultSummaryService/routes/index.js

@@ -19,6 +19,7 @@ app.get('/getAuditLogs', wrap(require('./getAuditLogs')));
 app.get('/getBenchmarkMetricProps', wrap(require('./getBenchmarkMetricProps')));
 app.get('/getBuildHistory', wrap(require('./getBuildHistory')));
 app.get('/getBuildList', wrap(require('./getBuildList')));
+app.get('/getBuildStages', wrap(require('./getBuildStages')));
 app.get('/getChildBuilds', wrap(require('./getChildBuilds')));
 app.get('/getDashboardBuildInfo', wrap(require('./getDashboardBuildInfo')));
 app.get('/getData', wrap(require('./getData')));