forked from smartdevicelink/sdl_evolution
-
Notifications
You must be signed in to change notification settings - Fork 0
Proposal "Test Reports Folder structure" #2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
GetmanetsIrina
wants to merge
4
commits into
master
Choose a base branch
from
feature/ATFtestReportsFolderStruct
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
d7fdb1b
Proposal "Test Reports Folder structure"
GetmanetsIrina 14e20e5
Update according to review comment.
GetmanetsIrina 418ed2b
Update NNNN-Change_ATF_test_reports_folder_structure.md
GetmanetsIrina 397541b
Updated Motivation section.
GetmanetsIrina File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
45 changes: 45 additions & 0 deletions
45
proposals/NNNN-Change_ATF_test_reports_folder_structure.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| # Change ATF test reports folder structure | ||
|
|
||
| * Proposal: [SDL-NNNN](NNNN-Change_ATF_test_reports_folder_structure.md) | ||
| * Author: [Irina Getmanets](https://github.com/GetmanetsIrina) | ||
| * Status: **Awaiting review** | ||
| * Impacted Platforms: ATF | ||
|
|
||
| ## Introduction | ||
|
|
||
| Main output of ATF is test reports. | ||
| ATF provide such reports: | ||
| * Console logs - name of test cases with execution status FAILED/PASSED. | ||
| * SDL logs - SDL log received by ATF via telnet logger. | ||
| * Transport logs - all received and sent data from/to SDL. Transport log can have default view - messages on protocol level (except binaries) and full view - log will be expanded with packages: streamings, service messages, heartbeat, json files. | ||
| * Detailed report - all expected and sent massages related to test cases with expected and actual result.Also contains info about test cases: name, time, sequence, status, duration. | ||
|
|
||
| This proposal is about creating clear and useful structure of test scripts reports. | ||
|
|
||
| ## Motivation | ||
|
|
||
| Create more convenient reports structure, less nested. Running multiple test scripts should not override old reports. Structure of reports should be clear, so you can easily search for a certain report. | ||
|
|
||
| ## Proposed solution | ||
|
|
||
| The solution is to create new structure: | ||
| ``` | ||
| TestingReports | ||
| -> ScriptName_YYYYMMDDHHMMSS | ||
| -> ATF | ||
| -> SDL | ||
| ``` | ||
| Subfolder ATF will contain ATF logs and report. | ||
| Subfolder SDL will contain SDL logs. | ||
|
|
||
| ## Potential downsides | ||
|
|
||
| n/a | ||
|
|
||
| ## Impact on existing code | ||
|
|
||
| Impact on ATF reporting functionality. | ||
|
|
||
| ## Alternatives considered | ||
|
|
||
| Leave as is. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@GetmanetsIrina Please note that CI jobs will require an update