Fix issues in the specification doc for test framework

Dilhasha commented 6 months ago

Purpose

Fixes the issues in the existing spec document as the phase 01. The document needs to be improved to include more information.

Partially fixes https://github.com/ballerina-platform/ballerina-spec/issues/1290

Goals

Addresses the gaps in the specification doc for the test framework

Approach

Describe how you are implementing the solutions. Include an animated GIF or screenshot if the change affects the UI (email documentation@wso2.com to review all UI text). Include a link to a Markdown file or Google doc if the feature write-up is too long to paste here.

User stories

Summary of user stories addressed by this change>

Release note

Brief description of the new feature or bug fix as it will appear in the release notes

Documentation

Link(s) to product documentation that addresses the changes of this PR. If no doc impact, enter “N/A” plus brief explanation of why there’s no doc impact

Training

Link to the PR for changes to the training content in https://github.com/wso2/WSO2-Training, if applicable

Certification

Type “Sent” when you have provided new/updated certification questions, plus four answers for each question (correct answer highlighted in bold), based on this change. Certification questions/answers should be sent to certification@wso2.com and NOT pasted in this PR. If there is no impact on certification exams, type “N/A” and explain why.

Marketing

Link to drafts of marketing content that will describe and promote this feature, including product page changes, technical articles, blog posts, videos, etc., if applicable

Automation tests

Unit tests

Code coverage information
Integration tests

Details about the test cases and coverage

Security checks

Followed secure coding standards in http://wso2.com/technical-reports/wso2-secure-engineering-guidelines? yes/no
Ran FindSecurityBugs plugin and verified report? yes/no
Confirmed that this PR doesn't commit any keys, passwords, tokens, usernames, or other secrets? yes/no

Samples

Provide high-level details about the samples related to this feature

Related PRs

List any other related PRs

Migrations (if applicable)

Describe migration steps and platforms on which migration has been tested

Test environment

List all JDK versions, operating systems, databases, and browser/versions on which this feature/fix was tested

Learning

Describe the research phase and any blog posts, patterns, libraries, or add-ons you used to solve the problem.

Thevakumar-Luheerathan commented 6 months ago

Shall we include --parallel, --exclude flags as well while briefing the functionalities of those flags? There might be other flags missed from spec. And What about including resource mocking in the spec? Or are we going to introduce it once it the rest parameter syntax is finalised.

Dilhasha commented 6 months ago

Shall we include --parallel, --exclude flags as well while briefing the functionalities of those flags? There might be other flags missed from spec. And What about including resource mocking in the spec? Or are we going to introduce it once it the rest parameter syntax is finalised.

yes there are missing flags and functionalities which I'd address in another PR.

ballerina-platform / ballerina-spec