1. Subject7
  2. Community
  3. General Discussion
Planned

Some Questions about Subject 7 REST API

Avatar
Saxon Si (US - ADVS)
Follow

Hello Subject-7 Development Team,

I'm currently reading the spec of Subject7 REST API (<Base URL>/api/v2), and I got some questions on the current provided Subject 7 REST API. Would you please feel free to have a check and give the feedback?

 

  • Cloud Run Category:
     
    • POST: /executions - By the description it is to send Execution Set to Cloud Run.
      My Question: Is there any way to use REST API to run the Test Case Independent Run? (Open a Test Case in Subject 7, then Set the Date Set, click the Cloud Run -> View Results in the Test Case Independent Results tab. In this case there will be no Execution Set defined and run a single test case in Cloud Run with only one Data Set selected.)
    • POST: /load-plan-executions 
      My Question: What is the Plan Execution? (Currently I didn't see any Plan related hyperlink or menu in the Subject7 instance bar. Is this functionality current supported or not? - If supported, how is the manual step to run it in Subject 7 online page?)

 

  • Executions Category
     
    • GET: All the Method Resource URI (/executions, /executions/xxx, /test-case-executions, /step-executions, etc.)
      My Question: I did some tests, it looks like it will only be able to retrieve the Execution Set run results. If we have a single cloud run direct from the Test Case (Open Test Case in Subject 7, then Select Data Set and Click Cloud Run to view the Results in Test Case Independent Results tab), is there any way that REST API can be utilized to get the Test Case Independent Results?
    • GET: /test-case-executions/{testCaseExecutionId}
      JSON Results: for "dataSets" the json value is like: "dataSets": [{"XXXX-A", "XXXX-B"]
      My Question: The results only show the Data Set Name, but there is no mapping for the Data Set Name is under which Data Template ID or Name. If we want to utilize the REST API, how can we identify which Data Set is for which Data Template if there will be multiple Data Templates to be used in a single Test Case definition in Subject 7?
    • GET: /step-executions
      My Question: Only the Failed Step will be returned, is this correct? (It looks like if it is an Archived Instance, it ONLY gave the Failed Step. In case if the Instance Run is NOT Archived, will the PASS or SKIP Step returned or not?)

 

  • Load Testing Category
     
    • This category looks related to the Plan Executions term
      My Question: I'm not seeing any Plan related hyperlink or menu item in Current Subject 7 page. Is this functionality current supported or not? (If yes, please help to give some more detailed information on this.)

 

  • Data Set Category
     
    • GET: /data-sets
      Current looks like this method will get all the Data Set for a given Data Template. There is NO other filter option or method that can only get the information by a given Data Set Name to reduce the return json data, is this correct?
    • My Question: Is there any supported REST API that can do the Data Set Data import/update based on the defined Data Template fields?

 

The Main Purpose is that I would like to utilize the Subject-7's provided REST API to create Test Cloud Run and Get the Test Run Results.
  • Create Cloud Run Execution
    • Execution Set run: based on REST API Description, it should be currently supported.
    • Test Case Independent Cloud Run: Based on my test, It is NOT working by REST API. Is there any workaround for this if it can submit execution without the execution set defined?
    • Plan Execution: Not Clear on this.
    • Any other approach for submit run: TBD based on Subject 7 Development Design

  • Get Test Cloud Run Results
    • Get Results for Execution Set Run: It should be currently supported.
    • Get Results for Test Case Independent Run: Based on my test, It is NOT working by REST API. Is there any workaround for this if we can use some REST API to get run results if it is submitted without an execution set defined?
    • Plan Execution: Not Clear on this.

  • Additional Functionalities if possible to support:
    • Is that possible to import or update Data Set data content via REST API?
    • Is that possible to define the Execution Set details via REST API?
    • Is that possible to get the lists of Test Run instances or Execution Set Run instances (containing the given Data Set Name) by the only provided the given Data Set Name as JSON request or input query parameter? (or by a Search of Data Set Name (not Data Template Id or Name) to return the related information where the Data Set Name is associated such as Data Template Id, Test Run Instance Lists, etc.)

 

BTW, is there any integration sample or solution if Subject-7 has built-in options or supported integration with other Test Management Tools, such as JIRA/TestFLO, etc?

It would be very appreciated if any of the Subject-7 Development Team can provide some feedback on the above questions. I'm looking forward to your reply.

 

Have a good day!

 

Thanks,

Saxon SI

0
6 comments
Sort by Date Votes
Avatar
Joseph Hamdan

Hi Saxon,

Here are the answers to your questions:

  1. Right now API doesn’t allow to work with independent test cases.  We will add it in one of next releases.
  2. Test plans are for load testing. It’s visible only for customers who requested this feature.
  3. Right now API doesn’t allow to work with independent test cases. We will add it in one of next releases.
  4. Thanks for question. We think it’s good enhancement to provide mapping template name <-> data set name in execution reports. Unfortunately, right now you can understand what template data set belongs to only if you do manual search.
  5. Step executions: it’s a mistake in description. Thanks for response. You can get any step executions you want, not only failed. Again yes, right now it doesn’t work for independent cloud runs.
  6. Test plans are for load testing. It’s visible only for customers who requested this feature.
  7. Yes, unfortunately there is no REST API calls to modify data sets and there is no call to get data set info by it’s name at this moment.
We are working on Jira plugin. It was already demonstrated to PWC team on one of the demo systems.
 
Regards,
Subject7 Team
0
Comment actions Permalink
Avatar
Saxon Si (US - ADVS)

Hello Joseph,

 

Thank you for your reply.

I'm looking forward for the next release for REST API support for Test Independent Run Results. Is there any estimation or expected release date defined as of now for the next release?

 

Thanks,

Saxon SI

 

 

0
Comment actions Permalink
Avatar
Joseph Hamdan

Hi Saxon,

The REST API enhancements are expected to be available by release 8.14.0. We will keep you posted with updates as soon as they are available.

Thank you for your patience.

Regards,

Subject7 Team

0
Comment actions Permalink
Avatar
Rex Feizi

Saxon, 

Would you please state what you intend to do or solve by the requested functionalities? For example, why is that you need "Is that possible to import or update Data Set data content via REST API?"  What is the underlying problem that you are trying to solve? 

 

--Rex

0
Comment actions Permalink
Avatar
Rex Feizi

Saxon, 

 

I would appreciate an answer when you get a chance, as it will greatly help us prioritize the enhancement requests or maybe we can provide a solution with the existing functionality of the platform. 

 

Thanks,

--Rex

0
Comment actions Permalink
Avatar
Saxon Si (US - ADVS)

Hello Rex,

 

Currently I was internally doing some research on the Subject 7 Integration Solution with JIRA (Actually to find out some solution to automatically sync the Test Results status back to JIRA system.).

Regarding your question for import or update data set via REST API, I was just thinking that is there a way that can do the Data Set updates via API that later if needed we may do the testing data updates in a more integrated & automatically way. For now I think it is fine if currently not supported based on my current perspective.

 

I am under researching to find some way that can automatically analyze the Testing Results details and following some validation rule to automatically update the JIRA status (Sometime the Testing Cloud Run results status of Complete or Failed is not enough to identify a testing is actually passed or not on a business perspective.), during some of my research & understanding, each Test Case Instance Run for a given Test Script in Subject 7 the only difference is for the Data Set ID (assume one data set object per test run), the same test case script will run multiple times for different Data Set under different testing scenarios, I am considering if there will be some search API or Filter Function just like JQL in JIRA, which can allow the REST API returns the Execution Set Instance Run List (including Re-Test) or Test Case Independent Instance Run List (including Re-Test) in a more flexible way, such as if I request to REST API for a given Data Set Name without knowing what Test Case script it associated, then REST API can given the related information including Data Template Name, Test Case Execution Instance ID List is using that Data Set and Execution Set Instance Run List containing the Test Case Instance, etc. (At this point, the Only Solution is to Looping the All the Test Case Execution API return results, to check which instance JSON dataSets list contain the Data Set or not)

 

I got two more questions on the Test Case Trigger functionality (I am not sure if the Trigger Functionalities can be utilized or not for my current researching solution)

1. If the Test Instance Run failed and we configured a Trigger, is that the Variables define in the Test Script can be accessible in the Trigger process or not? (For example, if i defined some variables in Test Script, with different value on different Test Steps, later once the Test Instance failed, does those Variables Values can be accessed in Trigger Process or not?

 

2. Is that possible to define a common Trigger that can be assigned to different Test Cases?

 

Thanks,

Saxon SI

 

0
Comment actions Permalink

Please sign in to leave a comment.