Add resource filtering functionality

.gitignore

@@ -37,3 +37,6 @@ CMakeUserPresets.json
 ### VCPKG ###
 # Temporary measure which fixes build agent issue
 vcpkg_registry_cache/
+
+### Ignored Test Run Files ###
+/tests/testData/IgnoredTestOutputFiles/

CMakeLists.txt

@@ -9,6 +9,7 @@ include(cmake/CcpPackageConfigHelpers.cmake)
 include(cmake/CcpBuildConfigurations.cmake)
 
 find_package(yaml-cpp CONFIG REQUIRED)
+find_package(unofficial-inih CONFIG REQUIRED)
 
 # Add subdirectory for resource tools static library
 add_subdirectory(tools)
@@ -66,7 +67,7 @@ endif ()
 
 target_compile_definitions(resources PUBLIC CARBON_RESOURCES_STATIC)
 
-target_link_libraries(resources PRIVATE $<BUILD_LOCAL_INTERFACE:resources-tools> yaml-cpp::yaml-cpp)
+target_link_libraries(resources PRIVATE $<BUILD_LOCAL_INTERFACE:resources-tools> yaml-cpp::yaml-cpp unofficial::inih::inireader)
 
 target_include_directories(resources
         PUBLIC

cli/src/CreateResourceGroupCliOperation.cpp

@@ -15,7 +15,8 @@ CreateResourceGroupCliOperation::CreateResourceGroupCliOperation() :
 	m_createResourceGroupSkipCompressionCalculationId( "--skip-compression" ),
 	m_createResourceGroupExportResourcesId( "--export-resources" ),
 	m_createResourceGroupExportResourcesDestinationTypeId( "--export-resources-destination-type" ),
-	m_createResourceGroupExportResourcesDestinationPathId( "--export-resources-destination-path" )
+	m_createResourceGroupExportResourcesDestinationPathId( "--export-resources-destination-path" ),
+	m_createResourceGroupIniFilterFilesArgumentId( "--filter-file" )
 {
 
 	AddRequiredPositionalArgument( m_createResourceGroupPathArgumentId, "Base directory to create resource group from." );
@@ -32,25 +33,27 @@ CreateResourceGroupCliOperation::CreateResourceGroupCliOperation() :
 	AddArgument( m_createResourceGroupDocumentVersionArgumentId, "Document version for created resource group.", false, false, VersionToString( defaultImportParams.outputDocumentVersion ) );
 
 	AddArgument( m_createResourceGroupResourcePrefixArgumentId, R"(Optional resource path prefix, such as "res" or "app")", false, false, "" );
-
-    AddArgumentFlag( m_createResourceGroupSkipCompressionCalculationId, "Set skip compression calculations on resources." );
 
-    AddArgumentFlag( m_createResourceGroupExportResourcesId, "Export resources after processing. see --export-resources-destination-type and --export-resources-destination-path" );
+	AddArgumentFlag( m_createResourceGroupSkipCompressionCalculationId, "Set skip compression calculations on resources." );
 
-    AddArgument( m_createResourceGroupExportResourcesDestinationTypeId, "Represents the type of repository where exported resources will be saved. Requires --export-resources", false, false, DestinationTypeToString( defaultImportParams.exportResourcesDestinationSettings.destinationType ), ResourceDestinationTypeChoicesAsString() );
+	AddArgumentFlag( m_createResourceGroupExportResourcesId, "Export resources after processing. see --export-resources-destination-type and --export-resources-destination-path" );
+
+	AddArgument( m_createResourceGroupExportResourcesDestinationTypeId, "Represents the type of repository where exported resources will be saved. Requires --export-resources", false, false, DestinationTypeToString( defaultImportParams.exportResourcesDestinationSettings.destinationType ), ResourceDestinationTypeChoicesAsString() );
 
 	AddArgument( m_createResourceGroupExportResourcesDestinationPathId, "Represents the base path where the exported resources will be saved. Requires --export-resources", false, false, defaultImportParams.exportResourcesDestinationSettings.basePath.string() );
+
+	AddArgument( m_createResourceGroupIniFilterFilesArgumentId, "Path to INI file(s) for resource filtering.", false, true, "" );
 }
 
 bool CreateResourceGroupCliOperation::Execute( std::string& returnErrorMessage ) const
 {
 	CarbonResources::CreateResourceGroupFromDirectoryParams createResourceGroupParams;
 
-    CarbonResources::ResourceGroupExportToFileParams exportParams;
+	CarbonResources::ResourceGroupExportToFileParams exportParams;
 
-    createResourceGroupParams.directory = m_argumentParser->get<std::string>( m_createResourceGroupPathArgumentId );
+	createResourceGroupParams.directory = m_argumentParser->get<std::string>( m_createResourceGroupPathArgumentId );
 
-    bool versionIsValid = ParseDocumentVersion( m_argumentParser->get( m_createResourceGroupDocumentVersionArgumentId ), createResourceGroupParams.outputDocumentVersion );
+	bool versionIsValid = ParseDocumentVersion( m_argumentParser->get( m_createResourceGroupDocumentVersionArgumentId ), createResourceGroupParams.outputDocumentVersion );
 
 	if( !versionIsValid )
 	{
@@ -63,7 +66,7 @@ bool CreateResourceGroupCliOperation::Execute( std::string& returnErrorMessage )
 
 	createResourceGroupParams.calculateCompressions = !m_argumentParser->get<bool>( m_createResourceGroupSkipCompressionCalculationId );
 
-    createResourceGroupParams.exportResources = m_argumentParser->get<bool>( m_createResourceGroupExportResourcesId );
+	createResourceGroupParams.exportResources = m_argumentParser->get<bool>( m_createResourceGroupExportResourcesId );
 
 	if( createResourceGroupParams.exportResources )
 	{
@@ -79,17 +82,36 @@ bool CreateResourceGroupCliOperation::Execute( std::string& returnErrorMessage )
 		createResourceGroupParams.exportResourcesDestinationSettings.basePath = m_argumentParser->get<std::string>( m_createResourceGroupExportResourcesDestinationPathId );
 	}
 
+	exportParams.filename = m_argumentParser->get<std::string>( m_createResourceGroupOutputFileArgumentId );
 
-    exportParams.filename = m_argumentParser->get<std::string>( m_createResourceGroupOutputFileArgumentId );
+	exportParams.outputDocumentVersion = createResourceGroupParams.outputDocumentVersion;
 
-    exportParams.outputDocumentVersion = createResourceGroupParams.outputDocumentVersion;
+	if( m_argumentParser->is_used( m_createResourceGroupIniFilterFilesArgumentId ))
+	{
+		std::vector<std::filesystem::path> filterIniFilePaths;
+		auto iniFileStringVector = m_argumentParser->get<std::vector<std::string>>( m_createResourceGroupIniFilterFilesArgumentId );
+
+		for( const auto& iniPathStr : iniFileStringVector )
+		{
+			if( !iniPathStr.empty() )
+			{
+				filterIniFilePaths.push_back( iniPathStr );
+			}
+		}
+		if ( !filterIniFilePaths.empty() )
+		{
+			createResourceGroupParams.resourceFilterIniFiles = filterIniFilePaths;
+		}
+	}
 
 	PrintStartBanner( createResourceGroupParams, exportParams );
 
 	return CreateResourceGroup( createResourceGroupParams, exportParams );
 }
 
-void CreateResourceGroupCliOperation::PrintStartBanner( CarbonResources::CreateResourceGroupFromDirectoryParams& createResourceGroupFromDirectoryParams, CarbonResources::ResourceGroupExportToFileParams& ResourceGroupExportToFileParams ) const
+void CreateResourceGroupCliOperation::PrintStartBanner(
+	CarbonResources::CreateResourceGroupFromDirectoryParams& createResourceGroupFromDirectoryParams,
+	CarbonResources::ResourceGroupExportToFileParams& ResourceGroupExportToFileParams ) const
 {
 	if( s_verbosityLevel == CarbonResources::StatusLevel::OFF )
 	{
@@ -104,41 +126,57 @@ void CreateResourceGroupCliOperation::PrintStartBanner( CarbonResources::CreateR
 
 	std::cout << "Output File: " << ResourceGroupExportToFileParams.filename << std::endl;
 
-	std::cout << "Output Document Version: " << VersionToString(ResourceGroupExportToFileParams.outputDocumentVersion) << std::endl;
+	std::cout << "Output Document Version: " << VersionToString( ResourceGroupExportToFileParams.outputDocumentVersion ) << std::endl;
 
 	std::cout << "Resource Prefix: " << createResourceGroupFromDirectoryParams.resourcePrefix << std::endl;
 
-    if( createResourceGroupFromDirectoryParams.calculateCompressions)
-    {
+	if( createResourceGroupFromDirectoryParams.calculateCompressions )
+	{
 		std::cout << "Calculate Compression: On" << std::endl;
-    }
+	}
 	else
 	{
 		std::cout << "Calculate Compression: Off" << std::endl;
 	}
 
-    if( createResourceGroupFromDirectoryParams.exportResources )
+	if( createResourceGroupFromDirectoryParams.exportResources )
 	{
 		std::cout << "Export Resources: On" << std::endl;
 
-        std::cout << "Export Resources Type: " << DestinationTypeToString( createResourceGroupFromDirectoryParams.exportResourcesDestinationSettings.destinationType ) << std::endl;
+		std::cout << "Export Resources Type: " << DestinationTypeToString( createResourceGroupFromDirectoryParams.exportResourcesDestinationSettings.destinationType ) << std::endl;
 
-        std::cout << "Export Resources Base Path: " << createResourceGroupFromDirectoryParams.exportResourcesDestinationSettings.basePath << std::endl;
+		std::cout << "Export Resources Base Path: " << createResourceGroupFromDirectoryParams.exportResourcesDestinationSettings.basePath << std::endl;
 	}
 	else
 	{
 		std::cout << "Export Resources: Off" << std::endl;
 	}
 
+	if( createResourceGroupFromDirectoryParams.resourceFilterIniFiles.size() > 0 )
+	{
+		std::cout << "Resource Filter INI File(s) used: " << std::endl;
+
+		for( const auto& iniPath : createResourceGroupFromDirectoryParams.resourceFilterIniFiles )
+		{
+			std::cout << " - " << iniPath.generic_string() << std::endl;
+		}
+	}
+	else
+	{
+		std::cout << "Resource Filter INI File(s) used: None" << std::endl;
+	}
+
 	std::cout << "----------------------------\n"
 			  << std::endl;
 }
 
-bool CreateResourceGroupCliOperation::CreateResourceGroup( CarbonResources::CreateResourceGroupFromDirectoryParams& createResourceGroupFromDirectoryParams, CarbonResources::ResourceGroupExportToFileParams& ResourceGroupExportToFileParams ) const
+bool CreateResourceGroupCliOperation::CreateResourceGroup(
+	CarbonResources::CreateResourceGroupFromDirectoryParams& createResourceGroupFromDirectoryParams,
+	CarbonResources::ResourceGroupExportToFileParams& ResourceGroupExportToFileParams ) const
 {
 	CarbonResources::ResourceGroup resourceGroup;
 
-    createResourceGroupFromDirectoryParams.statusCallback = GetStatusCallback();
+	createResourceGroupFromDirectoryParams.statusCallback = GetStatusCallback();
 
 	if( createResourceGroupFromDirectoryParams.statusCallback )
 	{

cli/src/CreateResourceGroupCliOperation.h

@@ -18,9 +18,13 @@ class CreateResourceGroupCliOperation : public CliOperation
 	virtual bool Execute( std::string& returnErrorMessage ) const final;
 
 private:
-	void PrintStartBanner( CarbonResources::CreateResourceGroupFromDirectoryParams& createResourceGroupFromDirectoryParams, CarbonResources::ResourceGroupExportToFileParams& ResourceGroupExportToFileParams ) const;
+	void PrintStartBanner(
+		CarbonResources::CreateResourceGroupFromDirectoryParams& createResourceGroupFromDirectoryParams,
+		CarbonResources::ResourceGroupExportToFileParams& ResourceGroupExportToFileParams ) const;
 
-    bool CreateResourceGroup( CarbonResources::CreateResourceGroupFromDirectoryParams& createResourceGroupFromDirectoryParams, CarbonResources::ResourceGroupExportToFileParams& ResourceGroupExportToFileParams ) const;
+	bool CreateResourceGroup(
+		CarbonResources::CreateResourceGroupFromDirectoryParams& createResourceGroupFromDirectoryParams,
+		CarbonResources::ResourceGroupExportToFileParams& ResourceGroupExportToFileParams ) const;
 
 private:
 	std::string m_createResourceGroupPathArgumentId;
@@ -30,14 +34,16 @@ class CreateResourceGroupCliOperation : public CliOperation
 	std::string m_createResourceGroupDocumentVersionArgumentId;
 
 	std::string m_createResourceGroupResourcePrefixArgumentId;
-
-    std::string m_createResourceGroupSkipCompressionCalculationId;
 
-    std::string m_createResourceGroupExportResourcesId;
+	std::string m_createResourceGroupSkipCompressionCalculationId;
 
-    std::string m_createResourceGroupExportResourcesDestinationTypeId;
-
-    std::string m_createResourceGroupExportResourcesDestinationPathId;
+	std::string m_createResourceGroupExportResourcesId;
+
+	std::string m_createResourceGroupExportResourcesDestinationTypeId;
+
+	std::string m_createResourceGroupExportResourcesDestinationPathId;
+
+	std::string m_createResourceGroupIniFilterFilesArgumentId;
 };
 
 #endif // CreateResourceGroupCliOperation_H

include/Enums.h

@@ -135,6 +135,10 @@ using StatusCallback = std::function<void( StatusLevel statusLevel, StatusProgre
     * Required resource not found
     * @var REQUIRED_INPUT_PARAMETER_NOT_SET
     * A required input parameter was not set
+    * @var FAILED_TO_INITIALIZE_RESOURCE_FILTER
+    * Failed to initialize ResourceFilter from .ini file
+    * @var FAILED_TO_APPLY_RESOURCE_FILTER_RULES
+    * Unable to decide on include/exclude filtering rules for resource
     */
 enum class ResultType
 {
@@ -175,6 +179,8 @@ enum class ResultType
 	RESOURCE_LIST_NOT_SET,
 	RESOURCE_NOT_FOUND,
 	REQUIRED_INPUT_PARAMETER_NOT_SET,
+	FAILED_TO_INITIALIZE_RESOURCE_FILTER,
+	FAILED_TO_APPLY_RESOURCE_FILTER_RULES,
 	//NOTE: if adding to this enum, a complimentary entry must be added to resultToString.
 };
 

include/ResourceGroup.h

@@ -204,6 +204,8 @@ struct ResourceGroupExportToFileParams
     *  @var CreateResourceGroupFromDirectoryParams::exportResourcesDestinationSettings
     *  If export resources is set, specifies where the produced PatchResourceGroup will be saved.
     *  @see CreateResourceGroupFromDirectoryParams::exportResources
+    *  @var CreateResourceGroupFromDirectoryParams::resourceFilterIniFiles
+	*  List of INI file(s) containing include/exclude rules for resource filtering
     */
 struct CreateResourceGroupFromDirectoryParams
 {
@@ -222,6 +224,8 @@ struct CreateResourceGroupFromDirectoryParams
     bool exportResources = false;
 
     ResourceDestinationSettings exportResourcesDestinationSettings = { CarbonResources::ResourceDestinationType::LOCAL_CDN, "ExportedResources" };
+
+	std::vector<std::filesystem::path> resourceFilterIniFiles = {};
 };
 
 /** @struct ResourceGroupMergeParams

src/Enums.cpp

@@ -156,6 +156,14 @@ bool ResultTypeToString( ResultType resultType, std::string& output )
 	case ResultType::REQUIRED_INPUT_PARAMETER_NOT_SET:
 		output = "A required parameter was not set";
 		return true;
+
+	case ResultType::FAILED_TO_INITIALIZE_RESOURCE_FILTER:
+		output = "Failed to initialize ResourceFilter from .ini file";
+		return true;
+
+	case ResultType::FAILED_TO_APPLY_RESOURCE_FILTER_RULES:
+		output = "Unable to decide on include/exclude filtering rules for resource";
+		return true;
 	}
 
 	output = "Error code unrecognised. This is an internal library error which shouldn't be encountered. If you encounter this error contact API addministrators.";