[DO NOT MERGE] Regression testing + screenshot fix

.github/workflows/builds.yml

@@ -31,12 +31,16 @@ jobs:
   builds-and-tests:
     strategy:
       matrix:
+        os: [ubuntu-20.04, macos-10.15]
+        target: [debug, optim]
+        mpi: [sequential]
+        build-system: [cmake]
         include:
-          - os: ubuntu-18.04
+          - os: ubuntu-20.04
             target: optim
             mpi: sequential
             build-system: make
-          - os: ubuntu-18.04
+          - os: ubuntu-20.04
             target: debug
             mpi: parallel
             build-system: make
@@ -48,17 +52,13 @@ jobs:
             target: debug
             mpi: parallel
             build-system: make
-          - os: ubuntu-18.04
-            target: optim
-            mpi: sequential
-            build-system: cmake
     name: ${{ matrix.os }}-${{ matrix.target }}-${{ matrix.mpi }}-${{ matrix.build-system }}
 
     runs-on: ${{ matrix.os }}
 
     steps:
     - name: get MPI (Linux)
-      if: matrix.os == 'ubuntu-18.04'
+      if: matrix.os == 'ubuntu-20.04'
       run: |
         sudo apt-get update
         sudo apt-get install mpich libmpich-dev
@@ -147,10 +147,13 @@ jobs:
         build-system: ${{ matrix.build-system }}
         mpi: ${{ matrix.mpi }}
 
-    # Install GlVis dependencies with package manager
+    # Install GLVis dependencies with package manager
     - name: get deps (Linux)
-      if: matrix.os == 'ubuntu-18.04'
+      if: matrix.os == 'ubuntu-20.04'
       run: |
+        # We need to add a PPA for SDL 2.0.14 - fixes some initialization
+        # errors for X11
+        sudo add-apt-repository -y ppa:savoury1/multimedia
         sudo apt-get update
         sudo apt-get install libfontconfig1-dev libfreetype6-dev libsdl2-dev libglew-dev libglm-dev libpng-dev
 
@@ -168,6 +171,7 @@ jobs:
       uses: actions/checkout@v2
       with:
         path: glvis
+        submodules: recursive
 
     - name: build GLVis (make)
       if: matrix.build-system == 'make'
@@ -179,12 +183,51 @@ jobs:
     - name: build GLVis (cmake)
       if: matrix.build-system == 'cmake'
       run: |
-        build_type="Release"
+        build_type="RelWithDebInfo"
         [[ ${{ matrix.target }} == "debug" ]] && build_type="Debug";
         cd glvis && mkdir build && cd build
         cmake \
           -D CMAKE_BUILD_TYPE:STRING=${build_type} \
+          -D ENABLE_TESTS:BOOL=TRUE \
           -D mfem_DIR:PATH=${GITHUB_WORKSPACE}/${MFEM_TOP_DIR}/build \
+          -D GLVIS_BASELINE_SYS=${{ matrix.os }} \
           ..
         make -j3
 
+    - name: setup Python
+      if: matrix.build-system == 'cmake'
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.9
+
+    - name: setup Python packages for testing
+      if: matrix.build-system == 'cmake'
+      run: |
+        python -m pip install --upgrade pip
+        pip install scikit-image
+
+    - name: setup Linux testing dependencies
+      if: matrix.build-system == 'cmake' && matrix.os == 'ubuntu-20.04'
+      run: |
+        sudo apt-get install xvfb
+
+    - name: test GLVis (cmake/linux)
+      if: matrix.build-system == 'cmake' && matrix.os == 'ubuntu-20.04'
+      run: |
+        cd glvis && cd build
+        xvfb-run -a ctest --verbose
+        tar czvf test_screenshots.tar.gz tests/test.*.png
+
+    - name: test GLVis (cmake/mac)
+      if: matrix.build-system == 'cmake' && matrix.os == 'macos-10.15'
+      run: |
+        cd glvis && cd build
+        ctest --verbose
+        tar czvf test_screenshots.tar.gz tests/test.*.png
+
+    - name: upload test screenshots
+      if: matrix.build-system == 'cmake'
+      uses: actions/upload-artifact@v2
+      with:
+        name: test-screenshots-${{ matrix.os }}-${{ matrix.target }}-${{ matrix.mpi }}
+        path: glvis/build/test_screenshots.tar.gz

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "test/data"]
+	path = tests/data
+	url = https://github.com/GLVis/data.git

CHANGELOG

@@ -32,6 +32,11 @@ Version 4.0.1 (development)
 - Added build target ("make app") to build a native Mac OS application bundle
   that can be double-clicked, added to the Dock, etc.
 
+- Added a new regression test suite based on generated screenshots of stream
+  files. See the README in the tests directory for more details.
+
+- Fixed an issue with black screenshots on certain OpenGL implementations.
+
 
 Version 4.0, released on Dec 11, 2020
 =====================================

CMakeLists.txt

@@ -328,3 +328,8 @@ add_custom_target(app
         GLVis.app/Contents/Resources/GLVis.icns
         GLVis.app/Contents/Resources/Credits.rtf
     VERBATIM)
+
+if(ENABLE_TESTS)
+  enable_testing()
+  add_subdirectory(tests)
+endif(ENABLE_TESTS)

glvis.cpp

@@ -1140,6 +1140,7 @@ int main (int argc, char *argv[])
    double      ms_line_width = gl3::LINE_WIDTH_AA;
    int         geom_ref_type = Quadrature1D::ClosedUniform;
    bool        legacy_gl_ctx = false;
+   bool        enable_hidpi  = true;
 
    OptionsParser args(argc, argv);
 
@@ -1206,6 +1207,9 @@ int main (int argc, char *argv[])
    args.AddOption(&legacy_gl_ctx, "-oldgl", "--legacy-gl",
                   "-anygl", "--any-gl",
                   "Only try to create a legacy OpenGL (< 2.1) context.");
+   args.AddOption(&enable_hidpi, "-hidpi", "--high-dpi",
+                  "-nohidpi", "--no-high-dpi",
+                  "Enable/disable support for HiDPI at runtime, if supported.");
 
    cout << endl
         << "       _/_/_/  _/      _/      _/  _/"          << endl
@@ -1279,6 +1283,7 @@ int main (int argc, char *argv[])
    {
       SetLegacyGLOnly(legacy_gl_ctx);
    }
+   SetUseHiDPI(enable_hidpi);
 
    GLVisGeometryRefiner.SetType(geom_ref_type);
 

lib/aux_vis.cpp

@@ -48,6 +48,7 @@ float line_w_aa = gl3::LINE_WIDTH_AA;
 
 thread_local SdlWindow * wnd = nullptr;
 bool wndLegacyGl = false;
+bool wndUseHiDPI = false;
 void SDLMainLoop(bool server_mode)
 {
    SdlWindow::StartSDL(server_mode);
@@ -68,6 +69,11 @@ void SetLegacyGLOnly(bool status)
    wndLegacyGl = true;
 }
 
+void SetUseHiDPI(bool status)
+{
+   wndUseHiDPI = status;
+}
+
 void MyExpose(GLsizei w, GLsizei h);
 void MyExpose();
 
@@ -319,8 +325,7 @@ void SetVisualizationScene(VisualizationScene * scene, int view,
 
    if (keys)
    {
-      // SendKeySequence(keys);
-      CallKeySequence(keys);
+      SendKeySequence(keys);
    }
    wnd->getRenderer().setPalette(&locscene->palette);
 }
@@ -933,6 +938,8 @@ int Screenshot(const char *fname, bool convert)
 #if GLVIS_DEBUG
       cerr << "Screenshot: reading image data from front buffer..." << endl;
 #endif
+      MFEM_WARNING("Screenshot: Reading from the front buffer is unreliable. "
+                   << " Resulting screenshots may be incorrect." << endl);
       glReadBuffer(GL_FRONT);
    }
 #if defined(GLVIS_USE_LIBTIFF)
@@ -1113,6 +1120,7 @@ void KeyS()
       wnd->screenshot(fname);
       cout << "done" << endl;
    }
+   SendExposeEvent();
 }
 
 inline GL2PSvertex CreatePrintVtx(gl3::FeedbackVertex v)

lib/aux_vis.hpp

@@ -128,4 +128,6 @@ GlVisFont * GetFont();
 bool SetFont(const vector<std::string>& patterns, int height);
 void SetFont(const std::string& fn);
 
+void SetUseHiDPI(bool status);
+
 #endif

lib/sdl.cpp

@@ -102,7 +102,19 @@ bool SdlWindow::createWindow(const char* title, int x, int y, int w, int h,
       return false;
    }
 
+   window_id = SDL_GetWindowID(handle.hwnd);
+
    GLenum err = glewInit();
+#ifdef GLEW_ERROR_NO_GLX_DISPLAY
+   // NOTE: Hacky workaround for Wayland initialization failure
+   // See https://github.com/nigels-com/glew/issues/172
+   if (err == GLEW_ERROR_NO_GLX_DISPLAY)
+   {
+      cerr << "GLEW: No GLX display found. If you are using Wayland this can "
+              "be ignored." << endl;
+      err = GLEW_OK;
+   }
+#endif
    if (err != GLEW_OK)
    {
       cerr << "FATAL: Failed to initialize GLEW: "
@@ -466,6 +478,11 @@ void SdlWindow::mainLoop()
    while (running)
    {
       mainIter();
+      if (takeScreenshot)
+      {
+         Screenshot(screenshot_file.c_str(), screenshot_convert);
+         takeScreenshot = false;
+      }
       if (wnd_state == RenderState::SwapPending)
       {
 #ifdef SDL_VIDEO_DRIVER_COCOA
@@ -486,11 +503,6 @@ void SdlWindow::mainLoop()
 #endif
          wnd_state = RenderState::Updated;
       }
-      if (takeScreenshot)
-      {
-         Screenshot(screenshot_file.c_str());
-         takeScreenshot = false;
-      }
    }
 #endif
 }
@@ -583,7 +595,6 @@ void SdlWindow::setWindowSize(int w, int h)
 {
    GetMainThread().SetWindowSize(handle, pixel_scale_x*w, pixel_scale_y*h);
    update_before_expose = true;
-
 }
 
 void SdlWindow::setWindowPos(int x, int y)
@@ -604,15 +615,24 @@ void SdlWindow::signalKeyDown(SDL_Keycode k, SDL_Keymod m)
    if (k >= 32 && k < 128)
    {
       event.type = SDL_TEXTINPUT;
+      event.text.windowID = window_id;
       event.text.text[0] = k;
    }
    else
    {
       event.type = SDL_KEYDOWN;
+      event.key.windowID = window_id;
       event.key.keysym.sym = k;
       event.key.keysym.mod = m;
    }
-   SDL_PushEvent(&event);
+   {
+      lock_guard<mutex> event_lk{event_mutex};
+      waiting_events.push_back(event);
+   }
+   if (is_multithreaded)
+   {
+      events_available.notify_all();
+   }
 }
 
 void SdlWindow::swapBuffer()

lib/sdl.hpp

@@ -74,6 +74,7 @@ class SdlWindow
       }
    };
 
+   int window_id = -1;
    Handle handle;
    std::unique_ptr<gl3::MeshRenderer> renderer;
    static const int high_dpi_threshold = 144;
@@ -125,6 +126,7 @@ class SdlWindow
    //bool requiresExpose;
    bool takeScreenshot{false};
    std::string screenshot_file;
+   bool screenshot_convert;
 
    // internal event handlers
    void windowEvent(SDL_WindowEvent& ew);
@@ -234,10 +236,14 @@ class SdlWindow
    std::string getSavedKeys() const { return saved_keys; }
 
    /// Queues a screenshot to be taken.
-   void screenshot(std::string filename)
+   void screenshot(std::string filename, bool convert = false)
    {
       takeScreenshot = true;
       screenshot_file = filename;
+      screenshot_convert = convert;
+      // Queue up an expose, so Screenshot() can pull image from the back
+      // buffer
+      signalExpose();
    }
 
    void swapBuffer();