o3de/Code/Framework/AzTest/AzTest/Utils.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 "Utils.h"
#include <algorithm>
#include <cstring>
#include <AzCore/base.h>
#include <AzCore/std/functional.h>
#include <AzCore/IO/Path/Path.h>
#include <AzCore/IO/SystemFile.h>
#include <AzCore/Settings/SettingsRegistryImpl.h>
#include <AzCore/Settings/SettingsRegistryMergeUtils.h>
#include <AzCore/StringFunc/StringFunc.h>
#include <AzCore/Utils/Utils.h>

namespace AZ
{
    namespace Test
    {
        bool ContainsParameter(int argc, char** argv, const std::string& param)
        {
            int index = GetParameterIndex(argc, argv, param);
            return index < 0 ? false : true;
        }

        void CopyParameters(int argc, char** target, char** source)
        {
            for (int i = 0; i < argc; i++)
            {
                const size_t dstSize = std::strlen(source[i]) + 1;
                target[i] = new char[dstSize];
                azstrcpy(target[i], dstSize, source[i]);
            }
        }

        int GetParameterIndex(int argc, char** argv, const std::string& param)
        {
            for (int i = 0; i < argc; i++)
            {
                if (param == argv[i])
                {
                    return i;
                }
            }
            return -1;
        }

        std::vector<std::string> GetParameterList(int& argc, char** argv, const std::string& param, bool removeOnReturn)
        {
            std::vector<std::string> parameters;
            int paramIndex = GetParameterIndex(argc, argv, param);
            if (paramIndex > 0)
            {
                int index = paramIndex + 1;
                while (index < argc && !StartsWith(argv[index], "-"))
                {
                    parameters.push_back(std::string(argv[index]));
                    index++;
                }
            }
            if (removeOnReturn)
            {
                RemoveParameters(argc, argv, paramIndex, paramIndex + (int)parameters.size());
            }
            return parameters;
        }

        std::string GetParameterValue(int& argc, char** argv, const std::string& param, bool removeOnReturn)
        {
            std::string value("");
            int index = GetParameterIndex(argc, argv, param);
            // Make sure we have a valid parameter index and value after the parameter index
            if (index > 0 && index < (argc - 1))
            {
                value = argv[index + 1];
                if (removeOnReturn)
                {
                    RemoveParameters(argc, argv, index, index + 1);
                }
            }
            return value;
        }

        void RemoveParameters(int& argc, char** argv, int startIndex, int endIndex)
        {
            // protect against invalid order of parameters
            if (startIndex > endIndex)
            {
                return;
            }

            // constraint to valid range
            endIndex = std::min(endIndex, argc - 1);
            startIndex = std::max(startIndex, 0);

            int numRemoved = 0;
            int i = startIndex;
            int j = endIndex + 1;

            // copy all existing paramters
            while (j < argc)
            {
                argv[i++] = argv[j++];
            }

            // null out all the remaining parameters and count how many
            // were removed simultaneously
            while (i < argc)
            {
                argv[i++] = nullptr;
                ++numRemoved;
            }

            argc -= numRemoved;
        }

        char** SplitCommandLine(int& size, char* const cmdLine)
        {
            std::vector<char*> tokens;
            [[maybe_unused]] char* next_token = nullptr;
            char* tok = azstrtok(cmdLine, 0, " ", &next_token);
            while (tok != nullptr)
            {
                tokens.push_back(tok);
                tok = azstrtok(nullptr, 0, " ", &next_token);
            }
            size = (int)tokens.size();
            char** token_array = new char*[size];
            for (size_t i = 0; i < size; i++)
            {
                const size_t dstSize = std::strlen(tokens[i]) + 1;
                token_array[i] = new char[dstSize];
                azstrcpy(token_array[i], dstSize, tokens[i]);
            }
            return token_array;
        }

        bool EndsWith(const std::string& s, const std::string& ending)
        {
            if (ending.length() > s.length())
            {
                return false;
            }
            return std::equal(ending.rbegin(), ending.rend(), s.rbegin());
        }

        bool StartsWith(const std::string& s, const std::string& beginning)
        {
            if (beginning.length() > s.length())
            {
                return false;
            }
            return std::equal(beginning.begin(), beginning.end(), s.begin());
        }

        AZStd::string GetCurrentExecutablePath()
        {
            char exeDirectory[AZ_MAX_PATH_LEN];
            AZ::Utils::GetExecutableDirectory(exeDirectory, AZ_ARRAY_SIZE(exeDirectory));

            AZStd::string executablePath = exeDirectory;
            return executablePath;
        }

        AZStd::string GetEngineRootPath()
        {
            if (auto registry = AZ::SettingsRegistry::Get(); registry != nullptr)
            {
                return AZ::SettingsRegistryMergeUtils::FindEngineRoot(*registry).String();
            }
            else
            {
                AZ::SettingsRegistryImpl localRegistry;
                return AZ::SettingsRegistryMergeUtils::FindEngineRoot(localRegistry).String();
            }
        }

        AZStd::string ScopedAutoTempDirectory::Resolve(const char* path) const
        {
            AZStd::string resolved = AZStd::string::format("%s" AZ_CORRECT_FILESYSTEM_SEPARATOR_STRING "%s", m_tempDirectory, path);
            return resolved;
        }
        
        const char* ScopedAutoTempDirectory::GetDirectory() const
        {
            return m_tempDirectory;
        }

        // Method to delete a folder recursively
        static void DeleteFolderRecursive(const AZ::IO::PathView& path)
        {
            auto callback = [&path](AZStd::string_view filename, bool isFile) -> bool {
                if (isFile)
                {
                    auto filePath = AZ::IO::FixedMaxPath(path) / filename;
                    AZ::IO::SystemFile::Delete(filePath.c_str());
                }
                else
                {
                    if (filename != "." && filename != "..")
                    {
                        auto folderPath = AZ::IO::FixedMaxPath(path) / filename;
                        DeleteFolderRecursive(folderPath);
                    }
                }
                return true;
            };
            auto searchPath = AZ::IO::FixedMaxPath(path) / "*";
            AZ::IO::SystemFile::FindFiles(searchPath.c_str(), callback);
            AZ::IO::SystemFile::DeleteDir(AZ::IO::FixedMaxPathString(path.Native()).c_str());
        }

        ScopedAutoTempDirectory::~ScopedAutoTempDirectory()
        {
            if (m_tempDirectory[0] != '\0')
            {
                // Delete the directory and its contents if a temp directory was created
                AZ::IO::PathView pathView(m_tempDirectory);
                DeleteFolderRecursive(pathView);
            }
        }
    }
}