-
Notifications
You must be signed in to change notification settings - Fork 117
[doc] Document the test dependency feature #1084
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
Conversation
|
Hello @vkarak, Thank you for updating!
Do see the ReFrame Coding Style Guide Comment last updated at 2019-12-17 14:16:32 UTC |
Codecov Report
@@ Coverage Diff @@
## master #1084 +/- ##
======================================
Coverage 91.7% 91.7%
======================================
Files 81 81
Lines 11121 11121
======================================
Hits 10199 10199
Misses 922 922
Continue to review full report at Codecov.
|
docs/dependencies.rst
Outdated
| The dependency graph construction and the subsequent dependency analysis happens also at the level of the test cases. | ||
|
|
||
| Let's assume that test :class:`T1` depends in :class:`T0`. | ||
| This can be expressed inside :class:`T1` using the :func:`depends_on` function: |
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.
| This can be expressed inside :class:`T1` using the :func:`depends_on` function: | |
| This can be expressed inside :class:`T1` using the :func:`depends_on` method: |
docs/dependencies.rst
Outdated
| For most of the cases, this is sufficient to reason about test dependencies. | ||
| In reality, as mentioned above, dependencies are handled at the level of test cases. | ||
| Test cases on different partitions are always independent. | ||
| If not specified differently, test cases with using programming environments are also independent. |
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.
| If not specified differently, test cases with using programming environments are also independent. | |
| If not specified differently, test cases using programming environments are also independent. |
docs/dependencies.rst
Outdated
| :align: center | ||
| :alt: Any cyclic dependencies between tests are not allowed, even if the underlying test case dependencies are not forming a cycle. | ||
|
|
||
| The test case dependencies here are clearly not forming a cycle, but the edge from ``(T0, E0)`` to ``(T1, E1)`` introduces a dependency from ``T0`` to ``T1`` forming a cycle at the test level. |
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.
| The test case dependencies here are clearly not forming a cycle, but the edge from ``(T0, E0)`` to ``(T1, E1)`` introduces a dependency from ``T0`` to ``T1`` forming a cycle at the test level. | |
| The test case dependencies here are clearly don't form a cycle, but the edge from ``(T0, E0)`` to ``(T1, E1)`` introduces a dependency from ``T0`` to ``T1`` forming a cycle at the test level. |
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.
If you change this as Theo suggests, remove the are from here are clearly don't form a cycle.
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.
You probably mean to remove "are" here, too.
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.
teojgo
left a comment
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.
Some minor comments as indicated above.
docs/dependencies.rst
Outdated
| :align: center | ||
| :alt: Any cyclic dependencies between tests are not allowed, even if the underlying test case dependencies are not forming a cycle. | ||
|
|
||
| The test case dependencies here are clearly not forming a cycle, but the edge from ``(T0, E0)`` to ``(T1, E1)`` introduces a dependency from ``T0`` to ``T1`` forming a cycle at the test level. |
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.
If you change this as Theo suggests, remove the are from here are clearly don't form a cycle.
I'll try using a mono font. |
Now it works fine. |
|
@jenkins-cscs retry none |

TODOS:
Fixes UES-318.
@boegel You can use this as an example to start playing with the feature. We can talk offline for the details until I finish the documentation.