o3de/Gems/Atom/Asset/Shader/Code/Tests/ShaderBuilderUtilityTests.cpp

/*
 * Copyright (c) Contributors to the Open 3D Engine Project.
 * For complete copyright and license terms please see the LICENSE at the root of this distribution.
 *
 * SPDX-License-Identifier: Apache-2.0 OR MIT
 *
 */

#include <AzTest/AzTest.h>
#include <AzCore/UnitTest/TestTypes.h>

#include "Common/ShaderBuilderTestFixture.h"

#include <ShaderBuilderUtility.h>

namespace UnitTest
{
    using namespace AZ;

    // The main purpose of this class is to test ShaderBuilderUtility functions
    class ShaderBuilderUtilityTests : public ShaderBuilderTestFixture
    {
    }; // class ShaderBuilderUtilityTests

    void ExpectHasIncludeFile(const AZStd::vector<AZStd::string> fileList, bool shouldExist, const char* filePath)
    {
        //We must normalize because internally AZ::ShaderBuilder::ShaderBuilderUtility::IncludedFilesParser
        // always returns normalized paths.
        AZStd::string filePathNormalized(filePath);
        AzFramework::StringFunc::Path::Normalize(filePathNormalized);
        auto it = AZStd::find(fileList.begin(), fileList.end(), filePathNormalized);
        if (shouldExist)
        {
            EXPECT_TRUE(it != fileList.end()) << "Could not find path '" << filePath << "' in the include list.";
        }
        else
        {
            EXPECT_TRUE(it == fileList.end()) << "Path '" << filePath << "' should not be in the include list.";
        }
    }

    TEST_F(ShaderBuilderUtilityTests, IncludedFilesParser_ParseStringAndGetIncludedFiles)
    {
        AZStd::string haystack(
            R"(
                Some content to parse
                #include <valid_file1.azsli>
                // #include <valid_file2.azsli>
                blah # include "valid_file3.azsli"
                bar include <a\dire-ctory\invalid-file4.azsli>
                foo #   include "a/directory/valid-file5.azsli"
                # include <a\dire-ctory\valid-file6.azsli>
                #includ "a\dire-ctory\invalid-file7.azsli"
                #include <..\Relative\Path\To\File.azsi>
                #include <C:\Absolute\Path\To\File.azsi>
            )"
        );

        AZ::ShaderBuilder::ShaderBuilderUtility::IncludedFilesParser includedFilesParser;
        auto fileList = includedFilesParser.ParseStringAndGetIncludedFiles(haystack);
        EXPECT_EQ(fileList.size(), 7);

        ExpectHasIncludeFile(fileList, true, "valid_file1.azsli");
        ExpectHasIncludeFile(fileList, true, "valid_file2.azsli");
        ExpectHasIncludeFile(fileList, true, "valid_file3.azsli");
        ExpectHasIncludeFile(fileList, false, "a\\dire-ctory\\invalid-file4.azsli");
        ExpectHasIncludeFile(fileList, true, "a\\directory\\valid-file5.azsli");
        ExpectHasIncludeFile(fileList, true, "a\\dire-ctory\\valid-file6.azsli");
        ExpectHasIncludeFile(fileList, false, "a\\dire-ctory\\invalid-file7.azsli");
        ExpectHasIncludeFile(fileList, true, "C:\\Absolute\\Path\\To\\File.azsi");
        ExpectHasIncludeFile(fileList, true, "..\\Relative\\Path\\To\\File.azsi");
    }

    TEST_F(ShaderBuilderUtilityTests, IncludedFilesParser_HandleMaterialPipelineMacro)
    {
        // This is a temporary solution to support material pipeline where the include path is specified in a #define and
        // later included like #include MATERIAL_TYPE_AZSLI_FILE_PATH

        AZStd::string haystack(
            R"(
                #define MATERIAL_TYPE_AZSLI_FILE_PATH "D:\o3de\Gems\Atom\TestData\TestData\Materials\Types\MaterialPipelineTest_Animated.azsli" 
                #include "D:\o3de\Gems\Atom\Feature\Common\Assets\Materials\Pipelines\LowEndPipeline\ForwardPass_BaseLighting.azsli" 
            )"
        );

        AZ::ShaderBuilder::ShaderBuilderUtility::IncludedFilesParser includedFilesParser;
        auto fileList = includedFilesParser.ParseStringAndGetIncludedFiles(haystack);
        EXPECT_EQ(fileList.size(), 2);

        ExpectHasIncludeFile(fileList, true, R"(D:\o3de\Gems\Atom\TestData\TestData\Materials\Types\MaterialPipelineTest_Animated.azsli)");
        ExpectHasIncludeFile(fileList, true, R"(D:\o3de\Gems\Atom\Feature\Common\Assets\Materials\Pipelines\LowEndPipeline\ForwardPass_BaseLighting.azsli)");
    }

} //namespace UnitTest

//AZ_UNIT_TEST_HOOK(DEFAULT_UNIT_TEST_ENV);