systelab / allure-reporter

Printable report generation for Allure
4 stars 2 forks source link

Update Test Case in Jama: Steps and Description #40

Closed danipiques closed 4 years ago

danipiques commented 5 years ago

Currently, when we execute a test case and report to JAMA via allure, there is a field "Actual Result" which contains a table with the Java Function and the Test Description.

Different people has reported that this is not clear because is not the typicall test case format. The interestant thing should be store the test case executed. Options:

1) Store in the Actual Results the Test Description and the Expected Results (Easier) 2) Store in the Steps table of the Test Run AND the Test Case the Description and the Expected Results (Preferred).

NOTE: With the second option we should consider projects that are writing the steps manually because an automatic execution could modify the steps introduced manually

ManelMoreno commented 5 years ago

Dani, the Test Run upload can not modify the Steps table, as Test Runs are a snapshot of the TC in the moment of creating/editing a Cycle

ManelMoreno commented 4 years ago

This issue refers to the synchroniztion between steps in allure reporter and JAMA. We have created a new issue referred to the content of 'Actual Results' See https://github.com/systelab/allure-reporter/issues/46.

olgapuig commented 4 years ago

The Test Case can be updated using the Jama Api as follows:

  1. GET /abstractitems Use the filter "contains" with the Test Case Name Get the id from the data ("data": [{"id": 509244,)

  2. GET /items/{id}

  3. PUT /items/{id} Update the steps in the Test Case though the field "testCaseSteps" Example: "fields": { ... "testCaseSteps": [ { "action": "Execute TBD1", "expectedResult": "Each step meets the expected result", "notes": "" }, { "action": "Step 2 ", "expectedResult": "Expected result 2", "notes": "" } ... }

ManelMoreno commented 4 years ago

We need to evaluate the impact of this request. Changes in TCs (or steps in TCs) from Allure, could affect existing approved reviews of the TC or pending updates of the design. Apart from that, we will have an extra need: upload the results by step and not by Run as is now (we just upload the Test Run Status and all the steps inherit it; in case of failure, all steps are set to Failed. This will be a new request, if steps are being synchronized for each run.)

olgapuig commented 4 years ago

Proposed solution:

olgapuig commented 4 years ago

Solution:

ManelMoreno commented 4 years ago

The implemented solution allows the update of TC definition in an action independent from the Report of results. This will allow to update TCs, perform actions like review and approval, and then Report the results un a subsequent action. @olgapuig take also into account the TC item type that Snow is being using on the Snow-JAMA instance, that is different from the CSW one.

ehilinger commented 4 years ago

Tested against FactorXIV JAMA project.

1 - Upload test and results It is possible to update test and upload results but there is a consideration. Once test is updated, as it is already in a cycle it is needed to "Make test case as current" to update test case in the cycle before uploading the results.

2 - Update test: Multi line description: It is possible to upload a multi line description Update test case removing steps: Test case is updated successfully with less steps Update test case adding steps: Test case is updated successfully with more steps Update step description: It is possible to update step description