ConvertUBOToPushConstantPass: fail if the UBO is not found

Author: TheMostDiligent

Graphics/ShaderTools/src/ConvertUBOToPushConstant.cpp

@@ -74,6 +74,12 @@ class ConvertUBOToPushConstantPass : public spvtools::opt::Pass
         m_BlockName{block_name}
     {}
 
+    static spvtools::Optimizer::PassToken Create(std::string BlockName)
+    {
+        return spvtools::Optimizer::PassToken{
+            std::make_unique<ConvertUBOToPushConstantPass>(BlockName)};
+    }
+
     const char* name() const override { return "convert-ubo-to-push-constant"; }
 
     Status Process() override
@@ -95,8 +101,8 @@ class ConvertUBOToPushConstantPass : public spvtools::opt::Pass
 
         if (candidate_ids.empty())
         {
-            // Block name not found
-            return Status::SuccessWithoutChange;
+            LOG_ERROR_MESSAGE("Failed to convert UBO block '", m_BlockName, "': no OpName found.");
+            return Status::Failure;
         }
 
         // Try each candidate ID to find a UniformBuffer
@@ -190,8 +196,8 @@ class ConvertUBOToPushConstantPass : public spvtools::opt::Pass
 
         if (target_var == nullptr)
         {
-            // No UniformBuffer found with the given block name
-            return Status::SuccessWithoutChange;
+            LOG_ERROR_MESSAGE("Failed to convert UBO block '", m_BlockName, "': no matching UniformBuffer found.");
+            return Status::Failure;
         }
 
         uint32_t target_var_id = target_var->result_id();
@@ -444,8 +450,7 @@ std::vector<uint32_t> ConvertUBOToPushConstants(
     optimizer.SetMessageConsumer(SPIRVToolsInternal::SpvOptimizerMessageConsumer);
 
     // Register the pass to convert UBO to push constant using custom out-of-tree pass
-    optimizer.RegisterPass(spvtools::Optimizer::PassToken(
-        std::make_unique<ConvertUBOToPushConstantPass>(BlockName)));
+    optimizer.RegisterPass(ConvertUBOToPushConstantPass::Create(BlockName));
 
     spvtools::OptimizerOptions options;
 #ifdef DILIGENT_DEVELOPMENT

Tests/DiligentCoreTest/src/ShaderTools/SPIRVShaderResourcesTest.cpp

@@ -345,8 +345,12 @@ void TestConvertUBOToPushConstant_InvalidBlockName(SHADER_COMPILER Compiler)
     if (::testing::Test::IsSkipped())
         return;
 
-    std::vector<unsigned int> PatchedSPIRV = ConvertUBOToPushConstants(SPIRV, PatchedAttribName);
-    EXPECT_EQ(SPIRV, PatchedSPIRV);
+    TestingEnvironment* pEnv = TestingEnvironment::GetInstance();
+    pEnv->SetErrorAllowance(1, "No worries, errors are expected: testing invalid input\n");
+    pEnv->PushExpectedErrorSubstring("Failed to convert UBO block 'CB5': no OpName found.");
+
+    SPIRV = ConvertUBOToPushConstants(SPIRV, PatchedAttribName);
+    EXPECT_TRUE(SPIRV.empty());
 }
 
 TEST_F(SPIRVShaderResourcesTest, ConvertUBOToPushConstant_InvalidBlockName_GLSLang)
@@ -369,8 +373,12 @@ void TestConvertUBOToPushConstant_InvalidResourceType(SHADER_COMPILER Compiler)
     if (::testing::Test::IsSkipped())
         return;
 
-    std::vector<unsigned int> PatchedSPIRV = ConvertUBOToPushConstants(SPIRV, PatchedAttribName);
-    EXPECT_EQ(SPIRV, PatchedSPIRV);
+    TestingEnvironment* pEnv = TestingEnvironment::GetInstance();
+    pEnv->SetErrorAllowance(1, "No worries, errors are expected: testing invalid input\n");
+    pEnv->PushExpectedErrorSubstring("Failed to convert UBO block 'g_ROBuffer': no matching UniformBuffer found.");
+
+    SPIRV = ConvertUBOToPushConstants(SPIRV, PatchedAttribName);
+    EXPECT_TRUE(SPIRV.empty());
 }
 
 TEST_F(SPIRVShaderResourcesTest, ConvertUBOToPushConstant_InvalidResourceType_GLSLang)