Merge pull request #80 from Laguna1989/FEATURE_ApprovalTestsWithWav

Run Approval tests with wav files

.github/workflows/test_verification.yml

@@ -92,12 +92,20 @@ jobs:
 
       - name: Build
         working-directory: ${{github.workspace}}/build
-        run: make OpenALpp_UnitTests OpenALpp_Integration -j 4
+        run: make OpenALpp_UnitTests OpenALpp_Integration OpenALpp_ApprovalTests -j
 
-    #      - name: Test
+    #     Commented out because one does not simply acquire a sound context
     #        run: ./OpenALpp_UnitTests --order rand
     #        working-directory: ${{github.workspace}}/build/bin/
 
+# Do not run approval tests on clang as there seem to be some float inconsistencies happening
+#      - name: CopyAssets
+#        run: cp -r ${{github.workspace}}/assets ${{github.workspace}}/build/test/approval_tests
+#
+#      - name: ApprovalTest
+#        run: ./OpenALpp_ApprovalTests --order rand
+#        working-directory: ${{github.workspace}}/build/test/approval_tests
+
   Windows:
     runs-on: windows-2019
     steps:

test/approval_tests/approval_test_helpers.cpp

@@ -1,6 +1,11 @@
 #include "approval_test_helpers.hpp"
+#include <algorithm>
 
-int ApprovalTestHelpers::asInt(float number, unsigned int digits)
+std::vector<int> ApprovalTestHelpers::asInt(std::vector<float> const& numbers, unsigned int digits)
 {
-    return static_cast<int>(number * digits);
+    std::vector<int> numbersAsInts;
+    numbersAsInts.resize(numbers.size());
+    std::transform(numbers.cbegin(), numbers.cend(), numbersAsInts.begin(), [digits](float number)
+        {return static_cast<int>(number * digits);});
+    return numbersAsInts;
 }

test/approval_tests/approval_test_helpers.hpp

@@ -1,9 +1,9 @@
-
 #ifndef OPENALPP_APPROVAL_TEST_HELPERS_HPP
 #define OPENALPP_APPROVAL_TEST_HELPERS_HPP
+#include <vector>
 
 struct ApprovalTestHelpers {
-    static int asInt(float number, unsigned int digits);
+    static std::vector<int> asInt(std::vector<float> const& number, unsigned int digits);
 };
 
 #endif // OPENALPP_APPROVAL_TEST_HELPERS_HPP

test/approval_tests/effect_convolution_test.cpp

@@ -1,21 +1,17 @@
 #include "ApprovalTests/ApprovalTests.hpp"
-#include "approval_test_helpers.hpp"
 #include "catch2/catch.hpp"
 #include "oalpp/effects/utility/convolution.hpp"
 #include "oalpp/sound_data.hpp"
+#include "approval_test_helpers.hpp"
 
 TEST_CASE("convolution")
 {
-    std::string const fileName { "assets/test1.ogg" };
+    std::string const fileName { "assets/test1.wav" };
     oalpp::SoundData buffer { fileName };
     oalpp::effects::utility::Convolution convolution { buffer.getSamples() };
     oalpp::SoundDataWithEffect soundWithEffect { buffer, convolution };
 
-    std::vector<int> values;
-    values.resize(soundWithEffect.getSamples().size());
-
-    std::transform(soundWithEffect.getSamples().cbegin(), soundWithEffect.getSamples().cend(),
-        values.begin(), [](float const value) { return ApprovalTestHelpers::asInt(value, 100); });
-
-    ApprovalTests::Approvals::verifyAll(values);
+    // note: Due to platform dependent float behavior, the result needs to be converted to int for
+    // the approval tests to work.
+    ApprovalTests::Approvals::verifyAll(ApprovalTestHelpers::asInt(soundWithEffect.getSamples(), 100));
 }

test/approval_tests/effect_gain_test.cpp

@@ -1,5 +1,4 @@
 #include "ApprovalTests/ApprovalTests.hpp"
-#include "approval_test_helpers.hpp"
 #include "catch2/catch.hpp"
 #include "oalpp/effects/utility/gain.hpp"
 #include "oalpp/sound_data.hpp"
@@ -8,34 +7,20 @@ TEST_CASE("gain")
 {
     SECTION("1.0")
     {
-        std::string const fileName { "assets/test1.ogg" };
+        std::string const fileName { "assets/test1.wav" };
         oalpp::effects::utility::Gain gain { 1.0f };
         oalpp::SoundData buffer { fileName };
         oalpp::SoundDataWithEffect soundWithEffect { buffer, gain };
 
-        std::vector<int> values;
-        values.resize(soundWithEffect.getSamples().size());
-
-        std::transform(soundWithEffect.getSamples().cbegin(), soundWithEffect.getSamples().cend(),
-            values.begin(),
-            [](float const value) { return ApprovalTestHelpers::asInt(value, 1000); });
-
-        ApprovalTests::Approvals::verifyAll(values);
+        ApprovalTests::Approvals::verifyAll(soundWithEffect.getSamples());
     }
     SECTION("2.0")
     {
-        std::string const fileName { "assets/test1.ogg" };
+        std::string const fileName { "assets/test1.wav" };
         oalpp::effects::utility::Gain gain { 2.0f };
         oalpp::SoundData buffer { fileName };
         oalpp::SoundDataWithEffect soundWithEffect { buffer, gain };
 
-        std::vector<int> values;
-        values.resize(soundWithEffect.getSamples().size());
-
-        std::transform(soundWithEffect.getSamples().cbegin(), soundWithEffect.getSamples().cend(),
-            values.begin(),
-            [](float const value) { return ApprovalTestHelpers::asInt(value, 100); });
-
-        ApprovalTests::Approvals::verifyAll(values);
+        ApprovalTests::Approvals::verifyAll(soundWithEffect.getSamples());
     }
 }

test/approval_tests/effect_phase_flip_test.cpp

@@ -0,0 +1,14 @@
+#include "ApprovalTests/ApprovalTests.hpp"
+#include "catch2/catch.hpp"
+#include "oalpp/effects/utility/phase_flip.hpp"
+#include "oalpp/sound_data.hpp"
+
+TEST_CASE("phase_flip")
+{
+    std::string const fileName { "assets/test1.wav" };
+    oalpp::SoundData buffer { fileName };
+    oalpp::effects::utility::PhaseFlip phaseFlip { };
+    oalpp::SoundDataWithEffect soundWithEffect { buffer, phaseFlip };
+
+    ApprovalTests::Approvals::verifyAll(soundWithEffect.getSamples());
+}