wip: add integration testing guidelines #6
Closed
Conversation
This file contains 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
Reorganize documentation structure Signed-off-by: Geoffrey Biggs <gbiggs@killbots.net> Squashed 'src/external/mpc/' changes from 8fc7cfdd..eaa5908b eaa5908b Merge branch 'input-weight-modify' into 'master' b9ee8e4f Update default mpc_controller_node parameters 8d15f49d Add weights to acceleration and steer controls; loosen simulation test case: git-subtree-dir: src/external/mpc git-subtree-split: eaa5908bdd987051a9dcd9c505f99bfd7f028547 [!821] Fix numerours code highlighting and markup issues, add TOCs - TOC still missing on design docs [!835] Add AVP instructions to docs Other improvements of the docs include - table-of-contents generation fixed - replace links to external markdown files with HTML. Not sure why doxygen doesn't complain in CI, it failed with version 1.8.13 in my ADE - spell checking of numerous documents - remove subtree doc [#912] Make code snippet blocks consistent in documentation [#949] Update docs on integration testing Fix command for running the launch test in integration-testing.md [#1224] Port other packages with smoke tests to use autoware_testing
Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp>
Signed-off-by: Keisuke Shima <19993104+KeisukeShima@users.noreply.github.com>
KeisukeShima
changed the title
KeisukeShima
commented
Mar 4, 2022
|
|
||
| This API is not suitable for all smoke test cases. For example, it can not be used when some specific file location, like map, is required to be passed to the node or some preparation need to be conducted before node launch. In such cases use manual solution from [section below](#integration-test-with-a-single-node-component-test). | ||
|
|
||
| ### Interface tests |
There was a problem hiding this comment.
それは良さそうですが、テストの全体像を先に書く必要がありそうです。
別のPRにありましたっけ？
There was a problem hiding this comment.
（これか https://github.com/autowarefoundation/autoware.universe/pull/391）
こちらもautoware-documentationに持ってきた方が良さそうです。
kenji-miyake
reviewed
Mar 8, 2022
| self.msgs.append(msg) | ||
|
|
||
| def get_message(self): | ||
| startlen = len(self.msgs) |
There was a problem hiding this comment.
Suggested change
| startlen = len(self.msgs) | |
| start_len = len(self.msgs) |
|
|
||
| - Incompatible interaction between nodes, such as non-matching topics, different message types, or incompatible QoS settings | ||
| - Reveal edge cases that were not touched with unit tests, such as a critical timing issue, network communication delay, disk I/O failure, and many other problems that can occur in production environments | ||
| - Using tools like `stress` and `udpreplay`, performance of nodes is tested with real data or while the system is under high CPU/memory load, where situations such as `malloc` failures can be detected |
There was a problem hiding this comment.
| @@ -0,0 +1,293 @@ | |||
| # Integration Testing | |||
|
|
|||
| ## Introduction | |||
There was a problem hiding this comment.
I think you can write an overview right below the title.
Suggested change
| ## Introduction |
|
|
||
| ## Introduction | ||
|
|
||
| This article motivates developers to adopt integration testing by explaining how to write, run, and evaluate the results of integration tests. |
There was a problem hiding this comment.
Let's read and follow the Google developer documentation style guide as much as possible. 👍
https://developers.google.com/style/translation?hl=en#write-short,-clear,-and-precise-sentences
In this case, I think we can write like this:
Suggested change
| This article motivates developers to adopt integration testing by explaining how to write, run, and evaluate the results of integration tests. | |
| This article explains how to write integration tests. |
There was a problem hiding this comment.
See also: autowarefoundation/autoware#14
|
|
||
| This API is not suitable for all smoke test cases. For example, it can not be used when some specific file location, like map, is required to be passed to the node or some preparation need to be conducted before node launch. In such cases use manual solution from [section below](#integration-test-with-a-single-node-component-test). | ||
|
|
||
| ### Interface tests |
There was a problem hiding this comment.
それは良さそうですが、テストの全体像を先に書く必要がありそうです。
別のPRにありましたっけ？
| launch_testing.asserts.assertExitCodes(proc_info, process=ndt_mapper) | ||
| ``` | ||
|
|
||
| ## Running the test |
There was a problem hiding this comment.
Let's move the descriptions about how to run tests to another page.
We need to keep pages short and simple.
Signed-off-by: Keisuke Shima <19993104+KeisukeShima@users.noreply.github.com>
…keShima/autoware-documentation into add-integration-testing-guidelines
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
[upstreamへのPR作成前のディスカッション用です]
今度こそT4へPRを作成したはず！
変更内容
{}を削除