jobProgressToken:Jira(Zephyr)Rest API

时间:2017-04-28 21:54:36

标签: rest api jira jira-zephyr

我正在使用Jira(Zephyr)休息调用创建测试周期并将测试案例添加到其中。根据提到的信息这里 1如果我使用此休息调用将测试添加到Cycle然后作为响应我将获得JobProgressToken。 JobProgressToken只是告诉测试周期中测试用例添加的进度。

现在我遇到的问题是我没有从这个JobProgressToken获得任何输出。我尝试使用提到的格式触发GET休息呼叫,但我得到空响应。

有人可以解释一下如何使用这个JobProgressToken来获取我的任务进度吗? 我想验证我添加到Cycle的测试是否成功添加?

1 个答案:

答案 0 :(得分:0)

就在ysterday,我遇到了同样的问题。 ZAPI文档真的很混乱。我找到了以下解决方案:

检索作业进度的

GET 请求具有以下格式:http://jira/rest/zapi/latest/execution/jobProgress/0001498157843923-5056b64fdb-0001 其中 0001498157843923-5056b64fdb-0001 是特定jobProgressToken的值

在作为一些异步操作的结果获得jobProgressToken之后,我的代码正在等待进度变为1(它从0开始逐渐变为1)

    //get the job progress token as a result of some async operation invocation
    String jobProgressToken = new JSONObject(zapiResponse).getString("jobProgressToken");
    waitAsyncJobToBeCompleted(jobProgressToken);


void waitAsyncJobToBeCompleted(String jobProgressToken) {
    double jobProgress;
    do {
        try {
            Thread.sleep(500);
        } catch (InterruptedException e) {
            LOG.error("Error while try to make the thread sleeping 500ms. " + e.getLocalizedMessage());
            e.printStackTrace();
        }
        jobProgress = getJobProgress(jobProgressToken);
    } while (Double.compare(jobProgress, 1) <0);

private double getJobProgress(String jobProgressToken) {
    URI uri = makeUriFromString(String.format(
            GET_GetJobProgress, //Get request pattern
            connectionParameters.getJiraUrl(),//host
            jobProgressToken)); //parameters

    HttpResponse response = executeHttpRequestWithResponse(new HttpGet(uri));
    String zapiResponse = null;
    try {
        zapiResponse = EntityUtils.toString(response.getEntity());
        LOG.trace("ZAPI RESPONSE: " + zapiResponse);
        EntityUtils.consumeQuietly(response.getEntity()); //cleanup the HTTP response
        double progress = new JSONObject(zapiResponse).getDouble("progress");
        LOG.debug("Job progress: " + progress);
        return progress;

    } catch (IOException e) {
        String err = String.format("Error while getting Zephyr API response: %s",
                e.getLocalizedMessage());
        LOG.fatal(err);
        throw new RestApiException(err, e);
    } catch (JSONException e) {
        String err = String.format("Error while retrieving the job progress from JSON: %s\n%s",
                zapiResponse, e.getLocalizedMessage());
        LOG.fatal(err);
        throw new RestApiException(err, e);
    }

}

这都是魔术:)

以下两个日志:第一个用于克隆测试周期,第二个用于删除

ZephyrClient.invokeHttpPost     - URI=http://jira/rest/zapi/latest/cycle JSON payload={"projectId": "13795","clonedCycleId": 2643,"name": "ZAPI client test","description": "Created With ZAPI client unit test","versionId": "-1"}
ZephyrClient.cloneTestCycle     - RESPONSE JSON: {"jobProgressToken":"0001498218783350-5056b64fdb-0001"}
ZephyrClient.executeHttpRequestWithResponse     - HTTP REQUEST: GET http://jira/rest/zapi/latest/execution/jobProgress/0001498218783350-5056b64fdb-0001 HTTP/1.1
ZephyrClient.executeHttpRequestWithResponse     - HTTP RESPONSE: HTTP/1.1 200 OK
ZephyrClient.getJobProgress     - ZAPI RESPONSE: {"timeTaken":"0 min, 1 sec","stepMessage":"","summaryMessage":"","errorMessage":"","progress":0.56,"message":"","stepLabel":"","stepMessages":[]}
ZephyrClient.getJobProgress     - Job progress: 0.56
ZephyrClient.executeHttpRequestWithResponse     - HTTP REQUEST: GET http://jira/rest/zapi/latest/execution/jobProgress/0001498218783350-5056b64fdb-0001 HTTP/1.1
ZephyrClient.executeHttpRequestWithResponse     - HTTP RESPONSE: HTTP/1.1 200 OK
ZephyrClient.getJobProgress     - ZAPI RESPONSE: {"timeTaken":"0 min, 1 sec","stepMessage":"","summaryMessage":"","errorMessage":"","progress":0.98,"message":"","stepLabel":"","stepMessages":[]}
ZephyrClient.getJobProgress     - Job progress: 0.98
ZephyrClient.executeHttpRequestWithResponse     - HTTP REQUEST: GET http://jira/rest/zapi/latest/execution/jobProgress/0001498218783350-5056b64fdb-0001 HTTP/1.1
ZephyrClient.executeHttpRequestWithResponse     - HTTP RESPONSE: HTTP/1.1 200 OK
ZephyrClient.getJobProgress     - ZAPI RESPONSE: {"timeTaken":"0 min, 2 sec","stepMessage":"","summaryMessage":"","errorMessage":"","progress":0.98,"message":"","stepLabel":"","stepMessages":[]}
ZephyrClient.getJobProgress     - Job progress: 0.98
ZephyrClient.executeHttpRequestWithResponse     - HTTP REQUEST: GET http://jira/rest/zapi/latest/execution/jobProgress/0001498218783350-5056b64fdb-0001 HTTP/1.1
ZephyrClient.executeHttpRequestWithResponse     - HTTP RESPONSE: HTTP/1.1 200 OK
ZephyrClient.getJobProgress     - ZAPI RESPONSE: {"timeTaken":"0 min, 3 sec","stepMessage":"","summaryMessage":"","errorMessage":"","progress":1.0,"message":"Cycle ZAPI client test created successfully.","stepLabel":"","stepMessages":[]}
ZephyrClient.getJobProgress     - Job progress: 1.0
ZephyrClient.executeHttpRequestWithResponse     - HTTP REQUEST: GET http://jira/rest/zapi/latest/cycle?projectId=13795&versionId=-1 HTTP/1.1
ZephyrClient.executeHttpRequestWithResponse     - HTTP RESPONSE: HTTP/1.1 200 OK
ZephyrClient.invokeHttpDelete   - URI=http://jira/rest/zapi/latest/cycle/2727
ZephyrClient.deleteTestCycle    - RESPONSE JSON: {"jobProgressToken":"0001498218815183-5056b64fdb-0001"}
ZephyrClient.executeHttpRequestWithResponse     - HTTP REQUEST: GET http://jira/rest/zapi/latest/execution/jobProgress/0001498218815183-5056b64fdb-0001 HTTP/1.1
ZephyrClient.executeHttpRequestWithResponse     - HTTP RESPONSE: HTTP/1.1 200 OK
ZephyrClient.getJobProgress     - ZAPI RESPONSE: {"timeTaken":"0 min, 0 sec","stepMessage":"","summaryMessage":"","errorMessage":"","progress":1.0,"message":"{\"success\":\"Cycle ZAPI client test успешно удален\"}","stepLabel":"","stepMessages":[]}
ZephyrClient.getJobProgress     - Job progress: 1.0
ZephyrClient.executeHttpRequestWithResponse     - HTTP REQUEST: GET http://jira/rest/zapi/latest/cycle?projectId=13795&versionId=-1 HTTP/1.1
ZephyrClient.executeHttpRequestWithResponse     - HTTP RESPONSE: HTTP/1.1 200 OK

P.S。这不是关于如何完成的。 这是关于它如何对我有用;)