Add tests for bin programs (#1351)

* Add tests for bin programs Python-based tests for: - exr2aces - exrcheck - exrenvmap - exrheader - exrinfo - exrmakepreview - exrmaketiled - exrmultipart - exrmultiview - exrstdattr Also: - The tests require Python3 and are skipped if it's not available - The tests download test images at build time from https://github.com/AcademySoftwareFoundation/openexr-images - All programs capitialize "Usage" in their usage message - exrmultipart now prints its usage message to stderr rather than cout Signed-off-by: Cary Phillips <[email protected]> * More complete test for exrenvmap Signed-off-by: Cary Phillips <[email protected]> * Use OPENEXR_IMAGES_REPO and OPENEXR_IMAGES_TAG for test images And reference a tag on the openexr-images repo, for future-proofing Signed-off-by: Cary Phillips <[email protected]> * typo: remove main from OPENEXR_IMAGES_REPO Signed-off-by: Cary Phillips <[email protected]> --------- Signed-off-by: Cary Phillips <[email protected]>
AcademySoftwareFoundation · Mar 11, 2023 · 1d4366a · 1d4366a
1 parent e11eacc
commit 1d4366a
Show file tree

Hide file tree

Showing 22 changed files with 852 additions and 18 deletions.
diff --git a/src/bin/exr2aces/main.cpp b/src/bin/exr2aces/main.cpp
@@ -30,7 +30,7 @@ namespace
 void
 usageMessage (const char argv0[], bool verbose = false)
 {
-    cerr << "usage: " << argv0 << " [options] infile outfile" << endl;
+    cerr << "Usage: " << argv0 << " [options] infile outfile" << endl;
 
     if (verbose)
     {

diff --git a/src/bin/exrcheck/main.cpp b/src/bin/exrcheck/main.cpp
@@ -26,7 +26,7 @@ using std::vector;
 void
 usageMessage (const char argv0[])
 {
-    cerr << "usage: " << argv0 << " [options] imagefile [imagefile ...]\n";
+    cerr << "Usage: " << argv0 << " [options] imagefile [imagefile ...]\n";
     cerr << "options: \n";
     cerr
         << "  -m : avoid excessive memory allocation (some files will not be fully checked)\n";

diff --git a/src/bin/exrenvmap/main.cpp b/src/bin/exrenvmap/main.cpp
@@ -32,7 +32,7 @@ namespace
 void
 usageMessage (const char argv0[], bool verbose = false)
 {
-    cerr << "usage: " << argv0 << " [options] infile outfile" << endl;
+    cerr << "Usage: " << argv0 << " [options] infile outfile" << endl;
 
     if (verbose)
     {

diff --git a/src/bin/exrheader/main.cpp b/src/bin/exrheader/main.cpp
@@ -458,7 +458,7 @@ printInfo (const char fileName[])
 void
 usageMessage (const char argv0[])
 {
-    std::cerr << "usage: " << argv0 << " imagefile [imagefile ...]\n";
+    std::cerr << "Usage: " << argv0 << " imagefile [imagefile ...]\n";
 }
 
 int

diff --git a/src/bin/exrinfo/main.c b/src/bin/exrinfo/main.c
@@ -104,7 +104,7 @@ process_stdin (int verbose, int allmeta, int strict)
 static int
 process_file (const char* filename, int verbose, int allmeta, int strict)
 {
-    int                       failcount;
+    int                       failcount = 0;
     exr_result_t              rv;
     exr_context_t             e     = NULL;
     exr_context_initializer_t cinit = EXR_DEFAULT_CONTEXT_INITIALIZER;

diff --git a/src/bin/exrmakepreview/main.cpp b/src/bin/exrmakepreview/main.cpp
@@ -22,7 +22,7 @@ using namespace std;
 void
 usageMessage (const char argv0[], bool verbose = false)
 {
-    cerr << "usage: " << argv0 << " [options] infile outfile" << endl;
+    cerr << "Usage: " << argv0 << " [options] infile outfile" << endl;
 
     if (verbose)
     {

diff --git a/src/bin/exrmaketiled/main.cpp b/src/bin/exrmaketiled/main.cpp
@@ -30,7 +30,7 @@ namespace
 void
 usageMessage (const char argv0[], bool verbose = false)
 {
-    cerr << "usage: " << argv0 << " [options] infile outfile" << endl;
+    cerr << "Usage: " << argv0 << " [options] infile outfile" << endl;
 
     if (verbose)
     {

diff --git a/src/bin/exrmultipart/exrmultipart.cpp b/src/bin/exrmultipart/exrmultipart.cpp
@@ -676,19 +676,18 @@ separate (vector<const char*> in, const char* out, bool override)
 void
 usageMessage (const char argv[])
 {
-    cout << argv << " handles the combining and splitting of multipart data\n";
-    cout
-        << "\n"
-        << "Usage: "
+    cerr << "Usage: "
            "exrmultipart -combine -i input.exr[:partnum][::partname] "
            "[input2.exr[:partnum]][::partname] [...] -o outfile.exr [options]\n";
-    cout << "   or: exrmultipart -separate -i infile.exr -o outfileBaseName "
+    cerr << "   or: exrmultipart -separate -i infile.exr -o outfileBaseName "
             "[options]\n";
-    cout << "   or: exrmultipart -convert -i infile.exr -o outfile.exr "
+    cerr << "   or: exrmultipart -convert -i infile.exr -o outfile.exr "
             "[options]\n";
-    cout << "\n"
-         << "Options:\n";
-    cout << "-override [0/1]      0-do not override conflicting shared "
+    cerr << "\n";
+    cerr << argv << " handles the combining and splitting of multipart data\n";
+    cerr << "\n";
+    cerr << "Options:\n";
+    cerr << "-override [0/1]      0-do not override conflicting shared "
             "attributes [default]\n"
             "                     1-override conflicting shared attributes\n";
 

diff --git a/src/bin/exrmultiview/main.cpp b/src/bin/exrmultiview/main.cpp
@@ -29,7 +29,7 @@ namespace
 void
 usageMessage (const char argv0[], bool verbose = false)
 {
-    cerr << "usage: " << argv0
+    cerr << "Usage: " << argv0
          << " "
             "[options] viewname1 infile1 viewname2 infile2 ... outfile"
          << endl;

diff --git a/src/bin/exrstdattr/main.cpp b/src/bin/exrstdattr/main.cpp
@@ -44,7 +44,7 @@ using namespace IMATH_NAMESPACE;
 void
 usageMessage (const char argv0[], bool verbose = false)
 {
-    cerr << "usage: " << argv0 << " [commands] infile outfile" << endl;
+    cerr << "Usage: " << argv0 << " [commands] infile outfile" << endl;
 
     if (verbose)
     {

diff --git a/src/test/CMakeLists.txt b/src/test/CMakeLists.txt
@@ -9,3 +9,5 @@ add_subdirectory(OpenEXRCoreTest)
 add_subdirectory(OpenEXRTest)
 add_subdirectory(OpenEXRUtilTest)
 add_subdirectory(OpenEXRFuzzTest)
+add_subdirectory(bin)
+
diff --git a/src/test/bin/CMakeLists.txt b/src/test/bin/CMakeLists.txt
@@ -0,0 +1,79 @@
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright (c) Contributors to the OpenEXR Project.
+
+if(BUILD_TESTING)
+
+  find_package(Python3 COMPONENTS Interpreter)
+  if (NOT Python3_FOUND)
+    message(STATUS "Python3 not found: skipping bin tests")
+    return()
+  endif()
+
+  message(STATUS "adding bin tests")
+
+  set(OPENEXR_IMAGES_REPO "https://raw.githubusercontent.com/AcademySoftwareFoundation/openexr-images" CACHE STRING
+    "Bin test Image repo")
+
+  set(OPENEXR_IMAGES_TAG "v1.0" CACHE STRING "Bin test image repo tag")
+
+  set(images_url ${OPENEXR_IMAGES_REPO}/${OPENEXR_IMAGES_TAG})
+
+  set(images 
+      TestImages/GrayRampsHorizontal.exr
+      LuminanceChroma/Garden.exr
+      MultiResolution/ColorCodedLevels.exr
+      MultiResolution/WavyLinesLatLong.exr
+      LuminanceChroma/Flowers.exr
+      MultiView/Adjuster.exr
+      Chromaticities/Rec709_YC.exr
+      Chromaticities/Rec709.exr
+      Chromaticities/XYZ_YC.exr
+      Chromaticities/XYZ.exr
+      TestImages/GammaChart.exr
+      Beachball/singlepart.0001.exr
+      v2/LeftView/Balls.exr
+      v2/Stereo/Trunks.exr
+      Beachball/multipart.0001.exr
+  )
+
+  foreach(image ${images})
+      message(STATUS "Downloading ${images_url}/${image}")
+      file(DOWNLOAD ${images_url}/${image} ${CMAKE_CURRENT_BINARY_DIR}/${image})
+  endforeach()
+
+  add_test(NAME OpenEXR.bin.exrinfo
+           COMMAND ${Python3_EXECUTABLE}
+           ${CMAKE_CURRENT_SOURCE_DIR}/test_exrinfo.py $<TARGET_FILE:exrinfo> ${CMAKE_CURRENT_BINARY_DIR})
+
+  add_test(NAME OpenEXR.bin.exrheader
+           COMMAND ${Python3_EXECUTABLE}
+           ${CMAKE_CURRENT_SOURCE_DIR}/test_exrheader.py $<TARGET_FILE:exrheader> ${CMAKE_CURRENT_BINARY_DIR})
+
+  set(tests
+      exr2aces
+      exrenvmap
+      exrmakepreview
+      exrmaketiled
+      exrmultiview
+      exrmultipart
+      exrstdattr
+  )
+
+  foreach(test ${tests})
+
+    add_test(NAME OpenEXR.bin.${test}
+           COMMAND ${Python3_EXECUTABLE}
+           ${CMAKE_CURRENT_SOURCE_DIR}/test_${test}.py $<TARGET_FILE:${test}> $<TARGET_FILE:exrinfo> ${CMAKE_CURRENT_BINARY_DIR})
+  endforeach()
+
+  # run exrcheck on all images
+  add_test(NAME OpenEXR.bin.exrcheck
+           COMMAND ${Python3_EXECUTABLE}
+           ${CMAKE_CURRENT_SOURCE_DIR}/test_exrcheck.py
+           $<TARGET_FILE:exrcheck>
+           ${CMAKE_CURRENT_BINARY_DIR}
+           ${images})
+
+endif()
+
+
diff --git a/src/test/bin/test_exr2aces.py b/src/test/bin/test_exr2aces.py
@@ -0,0 +1,61 @@
+#!/usr/bin/env python
+
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright (c) Contributors to the OpenEXR Project.
+
+import sys, os, tempfile, atexit
+from subprocess import PIPE, run
+
+print(f"testing exr2aces: {sys.argv}")
+
+exr2aces = sys.argv[1]
+exrinfo = sys.argv[2]
+image_dir = sys.argv[3]
+
+# no args = usage message
+result = run ([exr2aces], stdout=PIPE, stderr=PIPE, universal_newlines=True)
+print(" ".join(result.args))
+assert(result.returncode == 1)
+assert(result.stderr.startswith ("Usage: "))
+
+# -h = usage message
+result = run ([exr2aces, "-h"], stdout=PIPE, stderr=PIPE, universal_newlines=True)
+print(" ".join(result.args))
+assert(result.returncode == 1)
+assert(result.stderr.startswith ("Usage: "))
+
+def find_line(keyword, lines):
+    for line in lines:
+        if line.startswith(keyword):
+            return line
+    return None
+
+fd, outimage = tempfile.mkstemp(".exr")
+os.close(fd)
+
+def cleanup():
+    print(f"deleting {outimage}")
+atexit.register(cleanup)
+
+image = f"{image_dir}/TestImages/GrayRampsHorizontal.exr"
+result = run ([exr2aces, "-v", image, outimage], stdout=PIPE, stderr=PIPE, universal_newlines=True)
+print(" ".join(result.args))
+assert(result.returncode == 0)
+
+result = run ([exrinfo, "-v", outimage], stdout=PIPE, stderr=PIPE, universal_newlines=True)
+print(" ".join(result.args))
+assert(result.returncode == 0)
+
+# confirm the output has the proper chromaticities
+assert("chromaticities: chromaticities r[0.7347, 0.2653] g[0, 1] b[0.0001, -0.077] w[0.32168, 0.33767]" in result.stdout)
+
+print("success")
+
+
+
+
+
+
+
+
+
diff --git a/src/test/bin/test_exrcheck.py b/src/test/bin/test_exrcheck.py
@@ -0,0 +1,22 @@
+#!/usr/bin/env python
+
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright (c) Contributors to the OpenEXR Project.
+
+import sys, os
+from subprocess import PIPE, run
+
+print(f"testing exrcheck: {sys.argv}")
+
+exrcheck = sys.argv[1]
+image_dir = sys.argv[2]
+
+for exr_file in sys.argv[3:]:
+
+    exr_path = f"{image_dir}/{exr_file}"
+
+    result = run ([exrcheck, exr_path], stdout=PIPE, stderr=PIPE, universal_newlines=True)
+    assert(result.returncode == 0)
+
+print("success.")
+
-Original file line number
+Diff line change
@@ Expand Up / @@ -458,7 +458,7 @@ printInfo (const char fileName[]) @@
     void
     usageMessage (const char argv0[])
     {
-        std::cerr << "usage: " << argv0 << " imagefile [imagefile ...]\n";
+        std::cerr << "Usage: " << argv0 << " imagefile [imagefile ...]\n";
     }
     int
@@ Expand Down @@