Skip to content
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

Diagrams to illustrate the data flow #12

Closed
bytinbit opened this issue Jul 12, 2021 · 1 comment · Fixed by #54
Closed

Diagrams to illustrate the data flow #12

bytinbit opened this issue Jul 12, 2021 · 1 comment · Fixed by #54
Assignees
Milestone

Comments

@bytinbit
Copy link
Contributor

The overall data flow and when the data is what kind of result (nornir Result, MultiResult, AggregatedResult, NutsResult...) is hard to understand. We need a diagram that visualizes the overall flow of data and how it's wrapped into what kind of Result.

2 Diagrams (?):

  • Data flow (what comes into Nuts, how is it transformed (how does a yaml become a pytest test class), what is the output?
  • Nornir Result/MultiResult/AggregatedResult, NutsResult, pytest result

Raw data (nornir $result) => comes into Extractor => parses it, turns it into NutsResult => pytest tests data => outcome (pytest result)

@bytinbit
Copy link
Contributor Author

Update:

  • Class diagram (for internal use)
  • Sequence diagram
  • workflow / context diagram

bytinbit added a commit that referenced this issue Dec 7, 2021
Add some diagrams describing aspects of NUTS. Closes #12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants