[ISSUE #137][UML_VIEW] Symbol "-" is not allowed to appear in client …

…and service names 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: - Addition of the wrapping up of the UCL & US UML content with quotes - Switch of the CI/CD builds to the usage of dlt-viewer version 2.21.0 - Update of the README in order to reflect that we support building against the dlt-viewer's version 2.21.0 - Removal of the compiler-flags workaround for windows build. Already properly supported in the dlt-viewer - Update of the "Filters view" README - Update of the installation guide to include part regarding the msvc redist dependency for Windows - Update of the "third-party dependencies" README section. Addition of the link to Github and the license type for each dependency - Tracing of UML content to debug console is now done ONLY in case of the diagram's generation error >>> Verification criteria: - Manually checked on the Windows platform - All sanity checks on Git Hub were passed FIX
svlad-90 · Dec 23, 2020 · 98e8522 · 98e8522
1 parent 14e8b49
commit 98e8522
Show file tree

Hide file tree

Showing 10 changed files with 164 additions and 125 deletions.
diff --git a/.github/workflows/build_clang_tidy.yml b/.github/workflows/build_clang_tidy.yml
@@ -43,12 +43,12 @@ jobs:
          dir: ../Qt 
          cached: ${{ steps.cache-qt.outputs.cache-hit }}
 
-    # Checkout dlt-viewer's revision 2.20.1
+    # Checkout dlt-viewer's revision v2.21.0
     - name: Checkout of the dlt-viewer
       uses: actions/checkout@v2
       with:
         repository: GENIVI/dlt-viewer
-        ref: v2.20.1
+        ref: v2.21.0
 
     # Checkout project's revision, which is pushed
     - name: Checkout of the project

diff --git a/.github/workflows/build_linux.yml b/.github/workflows/build_linux.yml
@@ -38,12 +38,12 @@ jobs:
          dir: ../Qt 
          cached: ${{ steps.cache-qt.outputs.cache-hit }}
 
-    # Checkout dlt-viewer's revision 2.20.1
+    # Checkout dlt-viewer's revision v2.21.0
     - name: Checkout of the dlt-viewer
       uses: actions/checkout@v2
       with:
         repository: GENIVI/dlt-viewer
-        ref: v2.20.1
+        ref: v2.21.0
 
     # Checkout project's revision, which is pushed
     - name: Checkout of the ${{ github.event.repository.name }}

diff --git a/.github/workflows/build_windows.yml b/.github/workflows/build_windows.yml
@@ -56,12 +56,12 @@ jobs:
            echo "D:/a/${{ github.event.repository.name }}/tools/jom/" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append
       shell: powershell
 
-    # Checkout dlt-viewer's revision 2.20.1
+    # Checkout dlt-viewer's revision v2.21.0
     - name: Checkout of the dlt-viewer
       uses: actions/checkout@v2
       with:
         repository: GENIVI/dlt-viewer
-        ref: v2.20.1
+        ref: v2.21.0
 
     # Checkout project's revision, which is pushed
     - name: Checkout of the project
@@ -71,18 +71,6 @@ jobs:
         path: .\plugin\${{ github.event.repository.name }}
         ref: ${{ github.ref }}
 
-    # Adjust dlt-viewer's  main CMakeLists.txt in order to avoid setting gcc specific compiler flags
-    - name: Patch dlt-viewer's CMakeLists.txt
-      run: |
-         $filePath = ".\CMakeLists.txt"
-         $find_1 = "SET(CMAKE_C_FLAGS  ""`${CMAKE_C_FLAGS} -std=gnu99"")"
-         $replace_1 = "{0}if(NOT CMAKE_CXX_COMPILER_ID MATCHES ""MSVC""){1}{2}" -f [environment]::NewLine, [environment]::NewLine, $find_1
-         (Get-Content $filePath).Replace( $find_1 , $replace_1 ) | Set-Content $filePath
-         $find_2 = "add_definitions( ""-Wno-strict-aliasing"" )"
-         $replace_2 = "{0}{1}endif()" -f $find_2, [environment]::NewLine
-         (Get-Content $filePath).Replace( $find_2 , $replace_2 ) | Set-Content $filePath
-      shell: powershell
-
     # Adjust dlt-viewer's plugin CMakeLists.txt file to sub-include the plugin
     - name: Patch dlt-viewer's plugin CMakeLists.txt
       run: Add-Content .\CMakeLists.txt "`nadd_subdirectory(${{ github.event.repository.name }}/dltmessageanalyzerplugin/src)"

diff --git a/dltmessageanalyzerplugin/src/components/searchView/src/CSearchResultModel.cpp b/dltmessageanalyzerplugin/src/components/searchView/src/CSearchResultModel.cpp
@@ -421,14 +421,16 @@ std::pair<int /*rowNumber*/, QString /*diagramContent*/> CSearchResultModel::get
                                         case eUML_ID::UML_SERVICE:
                                         {
                                             QString str;
+                                            str.append("\"");
                                             str.append(message.mid(range.from, range.to - range.from + 1));
 
                                             if(true == stringCoverageMapItem.second.bAddSeparator)
                                             {
                                                 str.append(" ");
                                             }
 
-                                            str.replace(" ", "_");
+                                            str.append("\"");
+
                                             UMLRepresentationResult.second.append(str);
                                         }
                                             break;
@@ -565,8 +567,6 @@ std::pair<int /*rowNumber*/, QString /*diagramContent*/> CSearchResultModel::get
 
     outputString.append("@enduml");
 
-    SEND_MSG(result.second);
-
     return result;
 }
 

diff --git a/dltmessageanalyzerplugin/src/plant_uml/CUMLView.cpp b/dltmessageanalyzerplugin/src/plant_uml/CUMLView.cpp
@@ -408,6 +408,7 @@ void CUMLView::generateUMLDiagram(const QString& diagramContent)
         else
         {
             SEND_ERR(QString("Diagram creation error. Exit code - %1. Exit status %2").arg(exitCode).arg(exitStatus));
+            SEND_ERR(mDiagramContent);
             diagramGenerationFinished(false);
         }
 

diff --git a/md/filters_view/filters_view.md b/md/filters_view/filters_view.md
@@ -15,10 +15,12 @@ To keep things easier, the "filters view" was introduced within the plugin. It d
 
 ## How to enter the "Filters view"?
 
-Currently, entering the filters view is not so transparent, thus here is a gif animation, which represents how to open it:
+Currently, entering the filters view is not so transparent. Thus, here is a gif animation, which represents how exactly to open it:
 
 ![Screenshot of entering the filters view](./var_entering_filters_view.gif)
 
+In future releases, we will think of how to make it more transparent for the user to enter it. We promise ))
+
 ----
 
 ## How does it work?

diff --git a/md/installation_guide/installation_guide.md b/md/installation_guide/installation_guide.md
@@ -12,11 +12,11 @@
 
 > **Note!**
 > 
-> Currently plugin can be built against the v2.20.1 release.
+> Currently plugin can be built against the v2.21.0 release.
 >
-> The build under the v2.19.0 is also supported. But you will need to use the compatibility mode. Such an option is described below. Search for the "PLUGIN_INTERFACE_VERSION" keyword.
+> The build under the earlier versions, down to the the v2.19.0 is also supported. But you will need to use the compatibility mode. Such an option is described below later on down this page. Search for the "PLUGIN_INTERFACE_VERSION" keyword.
 >
-> Be sure, that you've checked out the compatible base-line and used needed options. 
+> Make sure, that you've checked out the compatible base-line and used required build options. 
 
 ----
 
@@ -173,6 +173,17 @@ As of now, they are Linux and Windows.
 
 ----
 
+> **Note!** 
+> 
+> To run dlt-viewer and DLT_Message-Analyzer, which are built with msvc, you will need to install the corresponding version of the Visual C++ Redistributable package.
+> 
+> Here is a link, by which you can find such packages for 2015, 2017, 2019 versions of the msvc - https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads
+>
+> In case if the link will become irrelevant, just google for the "Visual C++ Redistributable package" keyword in your browser.
+> 
+
+----
+
 #### Build settings
 
 > **Note!** 

diff --git a/md/thirdparty_deps/thirdparty_deps.md b/md/thirdparty_deps/thirdparty_deps.md
@@ -2,6 +2,31 @@
 
 ----
 
+# Thirdparty dependencies
+
+### List of the used dependencies
+
+| Dependency name | Repository | License type | License link |
+|---|---|---|---|
+| dma_common_deps | [Repository](https://github.com/svlad-90/DMA_CommonDeps) | Apache 2.0 | [License](https://github.com/svlad-90/DMA_CommonDeps/blob/master/LICENSE) |
+| dma_framework | [Repository](https://github.com/svlad-90/DMA_Framework) | Apache 2.0 | [License](https://github.com/svlad-90/DMA_Framework/blob/master/LICENSE) |
+| dma_plantuml | [Repository](https://github.com/svlad-90/DMA_Plantuml) | Apache 2.0 | [License](https://github.com/svlad-90/DMA_Plantuml/blob/master/LICENSE) |
+| qt5 | [Repository](https://github.com/qt/qt5) | (L)GPL | [License](https://github.com/qt/qt5/blob/dev/LICENSE.FDL) |
+| qdlt | [Repository](https://github.com/GENIVI/dlt-viewer/tree/master/qdlt) | MPL 2.0 | [License](https://github.com/GENIVI/dlt-viewer/blob/master/LICENSE.txt) |
+| plantuml | [Repository](https://github.com/plantuml/plantuml) | GPL 3.0 | [License](https://github.com/plantuml/plantuml/blob/master/license.txt) |
+| antlr4 | [Repository](https://github.com/antlr/antlr4) | MIT | [License](https://github.com/antlr/antlr4/blob/master/LICENSE.txt) |
+| pcre_parser |[Repository](https://github.com/bkiers/pcre-parser) | MIT | [License](https://github.com/bkiers/pcre-parser/blob/master/LICENSE) |
+| variant_lite |[Repository](https://github.com/martinmoene/variant-lite) | BSD 1.0 | [License](https://github.com/martinmoene/variant-lite/blob/master/LICENSE.txt) |
+| cmake |[Repository](https://gitlab.kitware.com/cmake/cmake) | BSD 3-clause | [License](https://gitlab.kitware.com/cmake/cmake/-/blob/master/Copyright.txt) |
+| actions/cache |[Repository](https://github.com/actions/cache) | MIT | [License](https://github.com/actions/cache/blob/main/LICENSE) |
+| actions/checkout |[Repository](https://github.com/actions/checkout) | MIT | [License](https://github.com/actions/checkout/blob/main/LICENSE) |
+| jurplel/install_qt_action |[Repository](https://github.com/jurplel/install-qt-action) | MIT | [License](https://github.com/jurplel/install-qt-action/blob/master/LICENSE) |
+| stefanzweifel/git_auto_commit_action |[Repository](https://github.com/stefanzweifel/git-auto-commit-action) | MIT | [License](https://github.com/stefanzweifel/git-auto-commit-action/blob/master/LICENSE) |
+
+----
+
+### Dependency diagram
+
 ![Thridparty dependencies diagram](./thirdparty_deps.svg) 
 
 ----

diff --git a/md/thirdparty_deps/thirdparty_deps.puml b/md/thirdparty_deps/thirdparty_deps.puml
@@ -2,17 +2,17 @@
 
 left to right direction
 
-package "DMA" {
-    package "DMA_Source" {
-        [dlt-message-analyzer]
+package "DLT_Message_Analyzer" {
+    package "DLT_Message_Analyzer_Source" {
+        [dlt_message_analyzer_source]
     }
 
-    package "DMA_Github" {
-        [dlt-message-analyzer-repo]
+    package "DLT_Message_Analyzer_Github" {
+        [dlt_message_analyzer_github]
     }
 }
 
-package "DMA Dependencies" {
+package "DLT_Message_Analyzer Dependencies" {
     package "DLT" {
         [qdlt]
     }
@@ -21,8 +21,10 @@ package "DMA Dependencies" {
         [qt5]
     }
 
-    package "DMA_Plantuml" {
+    package "DMA_Family" {
         [dma_plantuml]
+        [dma_framework]
+        [dma_common_deps]
     }
 
     package "Plantuml" {
@@ -34,44 +36,46 @@ package "DMA Dependencies" {
     }
 
     package "uuid" {
-        [uuid-dev]
+        [uuid_dev]
     }
 
-    package "Pcre-parser" {
-        [pcre-parser]
+    package "Pcre_parser" {
+        [pcre_parser]
     }
 
-    package "Variant-lite" {
-        [variant-lite]
+    package "Variant_lite" {
+        [variant_lite]
     }
 
-    package "Github-actions"{
+    package "Github_actions"{
         [actions/cache]
         [actions/checkout]
-        [jurplel/install-qt-action]
-        [stefanzweifel/git-auto-commit-action]
+        [jurplel/install_qt_action]
+        [stefanzweifel/git_auto_commit_action]
     }
 
     package "Build system"{
         [cmake]
     }
 }
 
-[dlt-message-analyzer] --> [qt5] : https://doc.qt.io/qt-5/reference-overview.html
-[dlt-message-analyzer] --> [qdlt] : https://github.com/GENIVI/dlt-viewer/tree/master/qdlt
-[dlt-message-analyzer] --> [plantuml] : https://plantuml.com/en/
-[dlt-message-analyzer] --> [antlr4] : https://github.com/antlr/antlr4
-[dlt-message-analyzer] --> [pcre-parser] : https://github.com/bkiers/pcre-parser
-[dlt-message-analyzer] --> [variant-lite] : https://github.com/martinmoene/variant-lite
+[dlt_message_analyzer_source] --> [dma_common_deps] : https://github.com/svlad-90/DMA_CommonDeps
+[dlt_message_analyzer_source] --> [dma_framework] : https://github.com/svlad-90/DMA_Framework
+[dlt_message_analyzer_source] --> [dma_plantuml] : https://github.com/svlad-90/DMA_Plantuml
 
-[antlr4] --> [uuid-dev]
+[dlt_message_analyzer_source] --> [qt5] : https://github.com/qt/qt5
+[dlt_message_analyzer_source] --> [qdlt] : https://github.com/GENIVI/dlt-viewer/tree/master/qdlt
+[dlt_message_analyzer_source] --> [plantuml] : https://github.com/plantuml/plantuml
+[dlt_message_analyzer_source] --> [antlr4] : https://github.com/antlr/antlr4
+[dlt_message_analyzer_source] --> [pcre_parser] : https://github.com/bkiers/pcre-parser
+[dlt_message_analyzer_source] --> [variant_lite] : https://github.com/martinmoene/variant-lite
+[dlt_message_analyzer_source] --> [cmake] : https://gitlab.kitware.com/cmake/cmake
 
-[dlt-message-analyzer-repo] --> [actions/cache] : https://github.com/actions/cache
-[dlt-message-analyzer-repo] --> [actions/checkout] : https://github.com/actions/checkout
-[dlt-message-analyzer-repo] --> [jurplel/install-qt-action] : https://github.com/jurplel/install-qt-action
-[dlt-message-analyzer-repo] --> [stefanzweifel/git-auto-commit-action] : https://github.com/stefanzweifel/git-auto-commit-action
-[dlt-message-analyzer-repo] --> [cmake] : https://gitlab.kitware.com/cmake/cmake
+[antlr4] --> [uuid_dev]
 
-[dlt-message-analyzer] --> [dma_plantuml] : https://github.com/svlad-90/DMA_Plantuml
+[dlt_message_analyzer_github] --> [actions/cache] : https://github.com/actions/cache
+[dlt_message_analyzer_github] --> [actions/checkout] : https://github.com/actions/checkout
+[dlt_message_analyzer_github] --> [jurplel/install_qt_action] : https://github.com/jurplel/install-qt-action
+[dlt_message_analyzer_github] --> [stefanzweifel/git_auto_commit_action] : https://github.com/stefanzweifel/git-auto-commit-action
 
 @enduml
-Original file line number
+Diff line change
@@ Expand Up @@
             else
             {
                 SEND_ERR(QString("Diagram creation error. Exit code - %1. Exit status %2").arg(exitCode).arg(exitStatus));
+                SEND_ERR(mDiagramContent);
                 diagramGenerationFinished(false);
             }
@@ Expand Down @@