Merge pull request #1997 from RubioJr9/bug_report

Closes #1989

Author: dcwhite

Diff for: src/Interface/Modules/Render/Screenshot.cc

@@ -52,6 +52,10 @@ void Screenshot::takeScreenshot()
   screenshot_ = viewport_->grabFramebuffer();
 }
 
+QImage Screenshot::getScreenshot() {
+  return viewport_->grabFramebuffer();
+}
+
 void Screenshot::saveScreenshot()
 {
   index_++;

Diff for: src/Interface/Modules/Render/Screenshot.h

@@ -46,11 +46,11 @@ namespace SCIRun
     public:
       explicit Screenshot(QOpenGLWidget *glwidget, QObject *parent = nullptr);
       void takeScreenshot();
+      QImage getScreenshot();
       void saveScreenshot();
       QString screenshotFile() const;
-
-
       Modules::Render::RGBMatrices toMatrix() const;
+
     private:
       QOpenGLWidget* viewport_;
       QImage screenshot_;

Diff for: src/Interface/Modules/Render/ViewScene.cc

@@ -29,17 +29,18 @@ DEALINGS IN THE SOFTWARE.
 #include <es-log/trace-log.h>
 #include <gl-platform/GLPlatform.hpp>
 
-#include <Interface/Modules/Render/ViewScenePlatformCompatibility.h>
-#include <Interface/Modules/Render/ES/SRInterface.h>
-#include <Interface/Modules/Render/GLWidget.h>
 #include <Core/Application/Application.h>
 #include <Core/Application/Preferences/Preferences.h>
+#include <Core/Application/Version.h>
+#include <Core/GeometryPrimitives/Transform.h>
 #include <Core/Logging/Log.h>
-#include <Modules/Render/ViewScene.h>
-#include <Interface/Modules/Render/Screenshot.h>
-#include <Graphics/Glyphs/GlyphGeom.h>
 #include <Graphics/Datatypes/GeometryImpl.h>
-#include <Core/GeometryPrimitives/Transform.h>
+#include <Graphics/Glyphs/GlyphGeom.h>
+#include <Interface/Modules/Render/ES/SRInterface.h>
+#include <Interface/Modules/Render/GLWidget.h>
+#include <Interface/Modules/Render/Screenshot.h>
+#include <Interface/Modules/Render/ViewScenePlatformCompatibility.h>
+#include <Modules/Render/ViewScene.h>
 #include <boost/timer.hpp>
 
 using namespace SCIRun::Gui;
@@ -2139,6 +2140,55 @@ void ViewSceneDialog::screenshotClicked()
   screenshotTaker_->saveScreenshot();
 }
 
+//--------------------------------------------------------------------------------------------------
+void ViewSceneDialog::sendBugReport()
+{
+  QString glVersion = reinterpret_cast<const char*>(glGetString(GL_VERSION));
+  QString gpuVersion = reinterpret_cast<const char *>(glGetString(GL_RENDERER));
+
+  // Temporarily save screenshot so that it can be sent over email
+  takeScreenshot();
+  QImage image = screenshotTaker_->getScreenshot();
+  QString location = QDir::homePath() % QLatin1String("/scirun5screenshots/scirun_bug.png");
+  image.save(location);
+
+  // Generate email template
+  QString askForScreenshot = "\nIMPORTANT: Make sure to attach the screenshot of the ViewScene located at "
+    % location % "\n\n\n";
+  static QString instructions = "## For bugs, follow the template below: fill out all pertinent sections,"
+    "then delete the rest of the template to reduce clutter."
+    "\n### If the prerequisite is met, just delete that text as well. "
+    "If they're not all met, the issue will be closed or assigned back to you.\n\n";
+  static QString prereqs = "**Prerequisite**\n* [ ] Did you [perform a cursory search](https://github.com/SCIInstitute/SCIRun/issues)"
+    "to see if your bug or enhancement is already reported?\n\n";
+  static QString reportGuide = "For more information on how to write a good "
+    "[bug report](https://github.com/atom/atom/blob/master/CONTRIBUTING.md#how-do-i-submit-a-good-bug-report) or"
+    "[enhancement request](https://github.com/atom/atom/blob/master/CONTRIBUTING.md#how-do-i-submit-a-good-enhancement-suggestion),"
+    "see the `CONTRIBUTING` guide. These links point to another project, but most of the advice holds in general.\n\n";
+  static QString describe = "**Describe the bug**\nA clear and concise description of what the bug is.\n\n";
+  static QString askForData = "**Providing sample network(s) along with input data is useful to solving your issue.**\n\n";
+  static QString reproduction = "**To Reproduce**\nSteps to reproduce the behavior:"
+    "\n1. Go to '...'\n2. Click on '....'\n3. Scroll down to '....'\n4. See error\n\n";
+
+  static QString expectedBehavior = "**Expected behavior**\nA clear and concise description of what you expected to happen.\n\n";
+  static QString additional = "**Additional context**\nAdd any other context about the problem here.\n\n";
+  QString desktopInfo = "Desktop: " % QSysInfo::prettyProductName() % "\n";
+  QString kernelInfo = "Kernel: " % QSysInfo::kernelVersion() % "\n";
+  QString gpuInfo = "GPU: " % gpuVersion % "\n";
+  QString qtInfo = "QT Version: " % QLibraryInfo::version().toString() % "\n";
+  QString glInfo = "GL Version: " % glVersion % "\n";
+  QString scirunVersionInfo = "SCIRun Version: " % QString::fromStdString(VersionInfo::GIT_VERSION_TAG) % "\n";
+  QString machineIdInfo = "Machine ID: " % QString(QSysInfo::machineUniqueId()) % "\n";
+
+  static QString recipient = "[email protected]";
+  static QString subject = "View%20Scene%20Bug%20Report";
+  QDesktopServices::openUrl(QUrl(QString("mailto:" % recipient % "?subject=" % subject % "&body=" %
+                                         askForScreenshot % instructions % prereqs % reportGuide %
+                                         describe % askForData % reproduction % expectedBehavior %
+                                         additional % desktopInfo % kernelInfo % gpuInfo %
+                                         qtInfo % glInfo % scirunVersionInfo % machineIdInfo)));
+}
+
 //--------------------------------------------------------------------------------------------------
 void ViewSceneDialog::takeScreenshot()
 {

Diff for: src/Interface/Modules/Render/ViewScene.h

@@ -77,6 +77,7 @@ namespace SCIRun {
 
     protected Q_SLOTS:
       void printToString() const {std::cout << toString("");}
+      void sendBugReport();
 
       //---------------- New Geometry --------------------------------------------------------------
       void updateModifiedGeometries();

Diff for: src/Interface/Modules/Render/ViewSceneControls.ui

@@ -2341,6 +2341,19 @@
         <string>Developer</string>
        </attribute>
        <layout class="QGridLayout" name="gridLayout_8">
+        <item row="0" column="0">
+         <spacer name="horizontalSpacer_17">
+          <property name="orientation">
+           <enum>Qt::Horizontal</enum>
+          </property>
+          <property name="sizeHint" stdset="0">
+           <size>
+            <width>40</width>
+            <height>20</height>
+           </size>
+          </property>
+         </spacer>
+        </item>
         <item row="0" column="1">
          <widget class="QPushButton" name="toStringButton_">
           <property name="sizePolicy">
@@ -2363,15 +2376,15 @@
           </property>
          </widget>
         </item>
-        <item row="0" column="0">
-         <spacer name="horizontalSpacer_17">
+        <item row="2" column="1">
+         <spacer name="verticalSpacer_2">
           <property name="orientation">
-           <enum>Qt::Horizontal</enum>
+           <enum>Qt::Vertical</enum>
           </property>
           <property name="sizeHint" stdset="0">
            <size>
-            <width>40</width>
-            <height>20</height>
+            <width>20</width>
+            <height>40</height>
            </size>
           </property>
          </spacer>
@@ -2390,17 +2403,11 @@
          </spacer>
         </item>
         <item row="1" column="1">
-         <spacer name="verticalSpacer_2">
-          <property name="orientation">
-           <enum>Qt::Vertical</enum>
-          </property>
-          <property name="sizeHint" stdset="0">
-           <size>
-            <width>20</width>
-            <height>40</height>
-           </size>
+         <widget class="QPushButton" name="bugReportButton_">
+          <property name="text">
+           <string>Send Bug Report</string>
           </property>
-         </spacer>
+         </widget>
         </item>
        </layout>
       </widget>
@@ -2429,7 +2436,7 @@
   </connection>
  </connections>
  <buttongroups>
-  <buttongroup name="shadingButtonGroup_"/>
   <buttongroup name="planeButtonGroup_"/>
+  <buttongroup name="shadingButtonGroup_"/>
  </buttongroups>
 </ui>

Diff for: src/Interface/Modules/Render/ViewSceneControlsDock.cc

@@ -73,6 +73,7 @@ ViewSceneControlsDock::ViewSceneControlsDock(const QString& name, ViewSceneDialo
 
   //----------- Developer Tab--------------//
   connect(toStringButton_, SIGNAL(clicked()), parent, SLOT(printToString()));
+  connect(bugReportButton_, SIGNAL(clicked()), parent, SLOT(sendBugReport()));
 
   //-----------Objects Tab-----------------//
   visibleItems_.reset(new VisibleItemManager(objectListWidget_));