#849: Integration of gcviewer

CHANGELOG.asciidoc

@@ -25,6 +25,7 @@ New release with various improvements and bugfixes:
 * https://github.com/devonfw/ide/issues/800[#800]: Nightly test with additional tests
 * https://github.com/devonfw/ide/issues/767[#767]: Fix AsciiDoc issues
 * https://github.com/devonfw/ide/issues/774[#774]: Create Getting-Started-For-Developers Documentation
+* https://github.com/devonfw/ide/issues/849[#849]: Integration of GCViewer
 
 The full list of changes for this release can be found in https://github.com/devonfw/ide/milestone/31?closed=1[milestone 2022.08.001].
 

documentation/cli.asciidoc

@@ -57,6 +57,7 @@ The following commandlets are currently available:
 * link:docker.asciidoc[docker]
 * link:dotnet.asciidoc[dotnet]
 * link:eclipse.asciidoc[eclipse]
+* link:gcviewer.asciidoc[gcviewer]
 * link:graalvm.asciidoc[graalvm]
 * link:gradle.asciidoc[gradle]
 * link:helm.asciidoc[helm]

documentation/devonfw-ide-usage.asciidoc

@@ -28,6 +28,8 @@ include::dotnet.asciidoc[leveloffset=3]
 
 include::eclipse.asciidoc[leveloffset=3]
 
+include::gcviewer.asciidoc[leveloffset=3]
+
 include::graalvm.asciidoc[leveloffset=3]
 
 include::gradle.asciidoc[leveloffset=3]

documentation/gcviewer.asciidoc

@@ -0,0 +1,25 @@
+:toc:
+toc::[]
+
+= GCViewer
+
+The `gcviewer` commandlet is used to install the GCViewer App if not already installed or launch the App if already installed.
+GCViewer is a little tool that visualizes verbose GC (Garbage Collection) output generated by Java Virtual Machines.
+To learn more about GC Loggings, please refer to https://sematext.com/blog/java-garbage-collection-logs/ or https://www.baeldung.com/java-gc-logging-to-file.
+
+*ATTENTION:*
+Currently this feature is new and therefore experimental.
+It may change in incompatible ways in the next releases until we reach a stable state.
+We hope that all is working fine for you.
+However, do not expect everything to work out of the box.
+
+
+The arguments (`devon gcviewer «args»`) are explained in the following table:
+
+.Usage of `devon gcviewer`
+[options="header"]
+|=======================
+|*Argument(s)*    |*Meaning*
+|`setup`          |install the latest version of GCViewer on your machine.
+|`start`          |launch the GCViewer App.
+|=======================

documentation/scripts.asciidoc

@@ -15,6 +15,7 @@ This directory is the heart of the `devonfw-ide` and contains the required link:
 │  ├── link:docker.asciidoc[docker]
 │  ├── link:dotnet.asciidoc[dotnet]
 │  ├── link:eclipse.asciidoc[eclipse]
+│  ├── link:gcviewer.asciidoc[gcviewer]
 │  ├── link:graalvm.asciidoc[graalvm]
 │  ├── link:gradle.asciidoc[gradle]
 |  ├── link:helm.asciidoc[helm]

scripts/src/main/resources/scripts/command/gcviewer

@@ -0,0 +1,91 @@
+#!/usr/bin/env bash
+
+# autocompletion list
+if [ "${1}" = "shortlist" ]
+then
+  if [ -z "${2}" ]
+  then
+    echo "setup start help"
+  fi
+  exit
+fi
+
+if [ -n "${DEVON_IDE_TRACE}" ]; then set -vx; fi
+# shellcheck source=scripts/functions
+source "$(dirname "${0}")"/../functions
+
+GCVIEWER_HOME="${DEVON_IDE_HOME}/software/gcviewer"
+
+# gcviewer installation
+function doSetup(){
+
+  if [ "${1}" != "silent" ]
+  then
+    if [ -z "${GCVIEWER_VERSION}" ]
+    then
+      doEcho "Getting the latest release of GCViewer..."
+      GCVIEWER_VERSION=$(curl "https://github.com/chewiebug/GCViewer/tags" | awk -F "/tag/" '/GCViewer/ {print $2}' | sort -r | head -1 | awk -F "\">" '{print $1}')
+    fi 
+    do_not_extract="Not Empty"
+    doInstall "-" "${GCVIEWER_HOME}" "gcviewer" "${GCVIEWER_VERSION}" "" "" "" "" "" "" "${do_not_extract}"
+    doCreateGCViewerScript
+  fi
+
+}
+
+function doStart(){
+
+  if [ ! -d "${GCVIEWER_HOME}" ]
+  then
+    doSetup
+  else
+    cd "${GCVIEWER_HOME}" || exit
+    doDevonCommand java setup silent
+    doEcho "Starting GCViewer..."
+    doRunGCViewer
+  fi
+
+}
+
+doCreateGCViewerScript(){
+
+  cd "${GCVIEWER_HOME}" || exit
+  touch gcviewer-script
+  echo -e "#!/usr/bin/env bash\n\njava -jar gcviewer*.jar&" >> gcviewer-script
+  chmod +x gcviewer-script
+
+}
+
+doRunGCViewer(){
+
+  cd "${GCVIEWER_HOME}" || exit
+  gcviewer-script
+
+}
+
+
+# CLI
+case ${1} in 
+"help" | "-h")
+  echo "Setup or run gcviewer"
+  echo
+  echo "Arguments:"
+  echo " setup                    install the latest version GCViewer on your machine."
+  echo " start                    launch GCViewer App."
+  echo
+;;
+"setup" | "s")
+  if [ "${2}" == "silent" ]
+  then
+    doSetup silent
+  else
+    doSetup
+  fi
+;;
+"start" | "")
+  doStart
+;;
+*)
+  doError "Unkown command!"
+;;
+esac

scripts/src/main/resources/scripts/functions

@@ -1146,6 +1146,7 @@ function doGitPullOrClone() {
 # $8: optional architecture (e.g. x86_64)
 # $9: optional extension (e.g. 'tar.gz' or 'zip')
 # $10: optional software repo
+# $11: optional to ignore extracting downloaded files (must not be empty to ignore extracting!)
 function doInstall() {
   local url="${1}"
   local target_path="${2}"
@@ -1157,6 +1158,7 @@ function doInstall() {
   local arch="${8}"
   local ext="${9}"
   local repository="${10}"
+  local ignore_extract="${11}"
   local download_dir="${DEVON_DOWNLOAD_DIR}"
   if [ -z "${target_path}" ] || [ -z "${url}" ] || [ -z "${software}" ]
   then
@@ -1233,10 +1235,16 @@ function doInstall() {
   fi
   if [ ! -d "${install_path}" ] || [ "${install_path}" == "${target_path}" ]
   then
-    doDownload "${url}" "${download_dir}" "${software}" "${version}" "${edition}" "${code}" "${os}" "${arch}" "${ext}"
-    doDebug "Received download file ${DOWNLOAD_FILENAME}"
-    doExtract "${download_dir}/${DOWNLOAD_FILENAME}" "${dir}"
-    doReplaceExtracted "${DEVON_IDE_HOME}/updates/extracted/${dir}" "${install_path}"
+    if [ -n "${ignore_extract}" ]
+    then
+      doDownload "${url}" "${target_path}" "${software}" "${version}" "${edition}" "${code}" "${os}" "${arch}" "${ext}"
+      doDebug "Received download file ${DOWNLOAD_FILENAME}"
+    else
+      doDownload "${url}" "${download_dir}" "${software}" "${version}" "${edition}" "${code}" "${os}" "${arch}" "${ext}"
+      doDebug "Received download file ${DOWNLOAD_FILENAME}"
+      doExtract "${download_dir}/${DOWNLOAD_FILENAME}" "${dir}"
+      doReplaceExtracted "${DEVON_IDE_HOME}/updates/extracted/${dir}" "${install_path}"
+    fi
     if [ "${install_path}" != "${DEVON_IDE_HOME}" ]
     then
       echo "${version}" > "${version_file}"