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

[UML_VIEW] Add possibility to specify values for absent parts of UML sequence #85

Closed
svlad-90 opened this issue Aug 6, 2020 · 1 comment · Fixed by #86
Closed

[UML_VIEW] Add possibility to specify values for absent parts of UML sequence #85

svlad-90 opened this issue Aug 6, 2020 · 1 comment · Fixed by #86
Assignees
Labels
enhancement New feature or request uml_view Issues related to the uml view
Milestone

Comments

@svlad-90
Copy link
Owner

svlad-90 commented Aug 6, 2020

It might happen, that formatting of existing messages in the project does not fit constraint to have all mandatory UML groups. Thus the creation of a sequence diagram is not possible. Still, the client might understand that specific formatting of the message is representing communication with a specific interface and method, and wants to provide this information as part of the regex. We should allow the client to do this.


Let's consider the following example:

2206 2020/08/06 15:27:04.204000 276163.1118 ECU1 SYS JOUR 2020/08/06 15:27:03.556033 cat[49294]: Informational: CAlice: sentName(name: "Alice")
2207 2020/08/06 15:27:04.703000 276163.5468 ECU1 SYS JOUR 2020/08/06 15:27:03.991085 cat[49299]: Informational: CAlice: response(success: 1)

What would I expect to do with the above messages?

  • Specify Alex as a CLIENT, despite that string has CAlice
  • Specify Bob as a SERVICE, despite it is not presented in the message
  • Specify sayMyName as a method, despite it is not presented in the message
  • Specify request, response, event, despite they are not presented in the message directly

I want to use the following regex in order to achieve the above mentioned points:
^(SYS).?: Informational: (?<UCL_Alex>CAlice):.?(?<US_Bob>(?<UM_sayMyName>(?sentName)|(?response))).*((?[\w]+))

New parts of behavior:

  • UCL_Alex will replace CAlice to Alex in the diagram content ( not supported yet )
  • US_Bob will add Bob service, despite, that it is not presented in the message ( not supported yet )
  • UM_sayMyName will add sayMyName method, despite that it is not presented in the message ( not supported yet )
  • URT & URP are stick to the parts of the message, which only indirectly show whether it is request or response ( supported already )

If supported, above will allow creating sequence diagrams even from non-perfectly formatted messages,
expanding the number of covered use-cases.

P.S. Together with that, it would be good to remove the 32 characters limitation on size of the regex group names. It should be possible to do that via internal mapping of provided group names to some shorter identifiers, e.g. counter-based ones - 1, 2, 3, 4, etc. Short identifiers would be actually used within the regex, while long names would be still known to the plugin's implementation.

@svlad-90 svlad-90 added enhancement New feature or request uml_view Issues related to the uml view labels Aug 6, 2020
@svlad-90 svlad-90 added this to the v.1.0.24 milestone Aug 6, 2020
svlad-90 added a commit that referenced this issue Aug 9, 2020
…rts of UML sequence

1. [x] Have you followed the guidelines in our [Contributing document](../blob/master/CONTRIBUTING.md)?
2. [x] Have you checked to ensure there aren't other open [Pull Requests](../pulls) for the same update/change?
3. [x] Have you built the project, and performed manual testing of your functionality for all supported platforms - Linux and Windows?
4. [x] Is your change backward-compatible with the previous version of the plugin?

>>> Change description:

- Extension of UML view functionality, as requested in issue #85
- Extension of the README to cover the implemented feature-extension
- Fix bug with wrong highlighting within the "Search view", in cases with heavy usage of nested groups
- Addition of representation of the non-variable group names to the "Filters view"

>>> Verification criteria:

- Manually tested on Windows and Linux
- All sanity checks on Git hub passed
svlad-90 added a commit that referenced this issue Aug 9, 2020
[ISSUE #85][UML_VIEW] Add possibility to specify values for absent parts of UML sequence
@svlad-90
Copy link
Owner Author

svlad-90 commented Aug 9, 2020

It was decided, that we will deal with removal of 32 chars regex group name limitation using a separate task:
#87

@svlad-90 svlad-90 self-assigned this Aug 14, 2020
@svlad-90 svlad-90 moved this to Done in DLTMessageAnalyzer Jul 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request uml_view Issues related to the uml view
Projects
1 participant