feat(featureFlag): Enhance feature flag management and configuration

Test/include/callPrivateContext.ps1

@@ -14,10 +14,14 @@ if(-not $MODULE_PATH){ throw "Missing MODULE_PATH variable initialization. Check
 function Invoke-PrivateContext {
     param (
         [Parameter(Mandatory, Position = 0)]
-        [scriptblock]$ScriptBlock
+        [scriptblock]$ScriptBlock,
+        [string]$ModulePath
     )
 
-    $modulePath = $MODULE_PATH | Split-Path -Parent
+    if ([string]::IsNullOrEmpty($ModulePath)) {
+        $modulePath = $MODULE_PATH | Split-Path -Parent
+    }
+
     $module = Import-Module -Name $modulePath -PassThru
 
     if ($null -eq $module) {

Test/include/config.mock.ps1

@@ -9,29 +9,40 @@
 if(-not $MODULE_NAME){ throw "Missing MODULE_NAME varaible initialization. Check for module.helerp.ps1 file." }
 
 $MOCK_CONFIG_PATH = "test_config_path"
-$CONFIG_INVOKE_GET_ROOT_PATH_CMD = "Invoke-$($MODULE_NAME)GetConfigRootPath"
+$CONFIG_INVOKE_GET_ROOT_PATH_CMD = "Invoke-{modulename}GetConfigRootPath"
 
 function Mock_Config{
     param(
         [Parameter(Position=0)][string] $key = "config",
-        [Parameter(Position=1)][object] $Config
+        [Parameter(Position=1)][object] $Config,
+        [Parameter(Position=2)][string] $ModuleName,
+        [Parameter(Position=3)][string] $MockPath = $MOCK_CONFIG_PATH
     )
 
     # Remove mock config path if exists
-    if(Test-Path $MOCK_CONFIG_PATH){
-        Remove-Item -Path $MOCK_CONFIG_PATH -ErrorAction SilentlyContinue -Recurse -Force
+    if(Test-Path $MockPath){
+        Remove-Item -Path $fullpath -ErrorAction SilentlyContinue -Recurse -Force
     }
 
     # create mock config path
-    New-Item -Path $MOCK_CONFIG_PATH -ItemType Directory -Force
+    New-Item -Path $MockPath -ItemType Directory -Force
+
+    # make full and not relative path
+    $fullpath = $MockPath | Resolve-Path
 
     # if $config is not null save it to a file
     if($null -ne $Config){
-        $configfile = Join-Path -Path $MOCK_CONFIG_PATH -ChildPath "$key.json"
+        $configfile = Join-Path -Path $fullpath -ChildPath "$key.json"
         $Config | ConvertTo-Json -Depth 10 | Set-Content $configfile
     }
 
+    if([string]::IsNullOrWhiteSpace($ModuleName)){
+        $moduleName = $MODULE_NAME
+    } 
+
+    $invokefunction = $CONFIG_INVOKE_GET_ROOT_PATH_CMD -replace "{modulename}", $moduleName
+
     # Mock invoke call
-    MockCallToString $CONFIG_INVOKE_GET_ROOT_PATH_CMD -OutString $MOCK_CONFIG_PATH
+    MockCallToString $invokefunction -OutString $fullpath
 
 }

Test/public/addIncludeToWorkspace.test.ps1

@@ -233,37 +233,44 @@ $targetPS1 = $moduleRootPath | Join-Path -ChildPath "public\addIncludeToWorkspac
 
 function Test_ResolveSourceDestinationPath{
 
-    $DestinationModuleName = "TargetModule"
-    $SourceModuleName = "SourceModule"
-    $LocalModuleName = "LocalModule"
-
-    $IncludeHelperModulePath = (Get-Module -name Includehelper).Path | Split-Path -parent
-
-    New-ModuleV3 -Name $DestinationModuleName ; $DestinationModulePath = $DestinationModuleName | Convert-Path
-    New-ModuleV3 -Name $SourceModuleName ; $SourceModulePath = $SourceModuleName | Convert-Path
-    New-ModuleV3 -Name $LocalModuleName ; $LocalModulePath = $LocalModuleName | Convert-Path
-
-    $LocalModuleName | Set-Location
-
-    # Act Null / Null - Soruce:Include to Destination:local
-    $resultsource,$resultdestination = Resolve-SourceDestinationPath
-    Assert-AreEqualPath -Presented $resultsource -Expected $IncludeHelperModulePath
-    Assert-AreEqualPath -Presented $resultdestination -Expected $LocalModulePath
-
-    # Act Source / Null - Source: Path to Destination: local
-    $resultsource,$resultdestination = Resolve-SourceDestinationPath -SourceModulePath $SourceModulePath
-    Assert-AreEqualPath -Presented $resultsource -Expected $SourceModulePath
-    Assert-AreEqualPath -Presented $resultdestination -Expected $LocalModulePath
-
-    # Act Null / Destination sourceI:Include to Destination: Path
-    $resultsource,$resultdestination = Resolve-SourceDestinationPath -DestinationModulePath $DestinationModulePath
-    Assert-AreEqualPath -Presented $resultsource -Expected $IncludeHelperModulePath
-    Assert-AreEqualPath -Presented $resultdestination -Expected $DestinationModulePath
-
-    # Act Sorce / Destination - Source: Path to Destination: Path
-    $resultsource,$resultdestination = Resolve-SourceDestinationPath -SourceModulePath $SourceModulePath -DestinationModulePath $DestinationModulePath
-    Assert-AreEqualPath -Presented $resultsource -Expected $SourceModulePath
-    Assert-AreEqualPath -Presented $resultdestination -Expected $DestinationModulePath
+    Invoke-PrivateContext {
+
+        $DestinationModuleName = "TargetModule"
+        $SourceModuleName = "SourceModule"
+        $LocalModuleName = "LocalModule"
+
+        # Includehelper root folder
+        $local = $PSScriptRoot
+        $IncludeHelperModulePath = $local | Split-Path -Parent | Split-Path -Parent
+
+        # TEsting modules
+        New-ModuleV3 -Name $DestinationModuleName ; $DestinationModulePath = $DestinationModuleName | Convert-Path
+        New-ModuleV3 -Name $SourceModuleName ; $SourceModulePath = $SourceModuleName | Convert-Path
+        New-ModuleV3 -Name $LocalModuleName ; $LocalModulePath = $LocalModuleName | Convert-Path
+
+        # Set location to test module
+        $LocalModuleName | Set-Location
+
+        # Act Null / Null - Soruce:Include to Destination:local
+        $resultsource,$resultdestination = Resolve-SourceDestinationPath
+        Assert-AreEqualPath -Presented $resultsource -Expected $IncludeHelperModulePath
+        Assert-AreEqualPath -Presented $resultdestination -Expected $LocalModulePath
+
+        # Act Source / Null - Source: Path to Destination: local
+        $resultsource,$resultdestination = Resolve-SourceDestinationPath -SourceModulePath $SourceModulePath
+        Assert-AreEqualPath -Presented $resultsource -Expected $SourceModulePath
+        Assert-AreEqualPath -Presented $resultdestination -Expected $LocalModulePath
+
+        # Act Null / Destination sourceI:Include to Destination: Path
+        $resultsource,$resultdestination = Resolve-SourceDestinationPath -DestinationModulePath $DestinationModulePath
+        Assert-AreEqualPath -Presented $resultsource -Expected $IncludeHelperModulePath
+        Assert-AreEqualPath -Presented $resultdestination -Expected $DestinationModulePath
+
+        # Act Sorce / Destination - Source: Path to Destination: Path
+        $resultsource,$resultdestination = Resolve-SourceDestinationPath -SourceModulePath $SourceModulePath -DestinationModulePath $DestinationModulePath
+        Assert-AreEqualPath -Presented $resultsource -Expected $SourceModulePath
+        Assert-AreEqualPath -Presented $resultdestination -Expected $DestinationModulePath
+    }
 
 }
 

Test/public/config.test.ps1

@@ -4,9 +4,21 @@ function Test_ConfigInclude{
 
     Set-IncludeHelperConfigValue -Name "config_name" -Value "test_config_value"
 
+    # Add Value String
+    $value = "Some value"
+    Set-IncludeHelperConfigValue -Name "TestKey" -Value $value
     $result = Get-IncludeHelperConfig
+    Assert-AreEqual -Expected $value -Presented $result.TestKey
 
-    Assert-AreEqual -Expected "test_config_value" -Presented $result.config_name
+    # Add Value Hashtable
+    $htable = @{ Key1 = "Value1"; Key2 = "Value2" }
+    Set-IncludeHelperConfigValue -Name "TestHashtable" -Value $htable
+    $result = Get-IncludeHelperConfig
+    Assert-AreEqual -Expected $htable.Key1 -Presented $result.TestHashtable.Key1
+    Assert-AreEqual -Expected $htable.Key2 -Presented $result.TestHashtable.Key2
+
+    # Previuse value still there
+    Assert-AreEqual -Expected $value -Presented $result.TestKey
 
 }
 

Test/public/dependencies.test.ps1

@@ -13,11 +13,11 @@ function Test_ImportDepepency_Already_loaded{
     Mock_ImportModule -Name $name -Folder $modulesFolder
 
     #Act
-    Set-IncludeHelperVerbose
+    Enable-IncludeHelperVerbose
     Start-MyTranscript
     $result = Import-Dependency -Name $name -Verbose -Confirm:$false
     $tt = Stop-MyTranscript
-    Clear-IncludeHelperVerbose
+    Disable-IncludeHelperVerbose
 
     #Assert verbose message
     Assert-AreEqual -Expected $name -Presented $result.Name
@@ -42,11 +42,11 @@ function Test_ImportDepepency_SideBySide{
     Mock_ImportModule -Name $name -Folder $modulesFolder
 
     # Act
-    Set-IncludeHelperVerbose
+    Enable-IncludeHelperVerbose
     Start-MyTranscript
     $result = Import-Dependency -Name $name -Verbose -Confirm:$false
     $tt = Stop-MyTranscript
-    Clear-IncludeHelperVerbose
+    Disable-IncludeHelperVerbose
 
     # Assert module output
     Assert-AreEqual -Expected $name -Presented $result.Name
@@ -77,11 +77,11 @@ function Test_ImportDepepency_Import_From_Module_Manager{
 
 
     #Act
-    Set-IncludeHelperVerbose
+    Enable-IncludeHelperVerbose
     Start-MyTranscript
     $output = Import-Dependency -Name $name -Verbose -Confirm:$false
     $result = Stop-MyTranscript
-    Clear-IncludeHelperVerbose
+    Disable-IncludeHelperVerbose
 
     #Assert verbose message
     Assert-AreEqual -Expected $name -Presented $output.Name
@@ -119,11 +119,11 @@ function Test_ImportDepepency_Install_From_Gallery{
     MockCallExpression -Command "Install-Module -Name $name -AllowPrerelease -Force" -Expression $expression
 
     #Act
-    Set-IncludeHelperVerbose
+    Enable-IncludeHelperVerbose
     Start-MyTranscript
     $output = Import-Dependency -Name $name -Verbose -Confirm:$false
     $result = Stop-MyTranscript
-    Clear-IncludeHelperVerbose
+    Disable-IncludeHelperVerbose
 
     #Assert verbose message
     Assert-AreEqual -Expected $name -Presented $output.Name
@@ -154,11 +154,11 @@ function Test_ImportDependency_Clone_From_GitHub{
     Mock_ImportModule -Name $name -Folder $modulesFolder
 
 
-    Set-IncludeHelperVerbose
+    Enable-IncludeHelperVerbose
     Start-MyTranscript
     $output = Import-Dependency -Name $name -Verbose -Confirm:$false
     $result = Stop-MyTranscript
-    Clear-IncludeHelperVerbose
+    Disable-IncludeHelperVerbose
 
     #Assert verbose message
     Assert-AreEqual -Expected $name -Presented $output.Name

Test/public/featureflag.test.ps1

@@ -0,0 +1,140 @@
+function Test_FeatureFlag_Success{
+    Mock_Config
+
+    Invoke-PrivateContext{
+
+        $ffName = "ff1"
+        $configFilePath = Invoke-MyCommand -Command "Invoke-IncludeHelperGetConfigRootPath" | Join-Path -ChildPath "config.json"
+
+        $result = Test-FeatureFlag -Key $ffName
+        Assert-IsFalse -Condition $result
+
+        # Calling Test-FeatureFlag will create entry on config.FeatureFlags
+        $config = Get-Content $configFilePath | ConvertFrom-Json -AsHashtable
+        Assert-IsFalse -Condition $config.FeatureFlags.$ffName
+
+        Set-FeatureFlag $ffName
+        $result = Test-FeatureFlag -Key $ffName
+        Assert-IsTrue -Condition $result
+
+        # Set flag adds $true to the config.FeatureFlags
+        $config = Get-Content $configFilePath| ConvertFrom-Json -AsHashtable
+        Assert-IsTrue -Condition $config.FeatureFlags.$ffName
+
+        Clear-FeatureFlag $ffName
+        $result = tff $ffName
+        Assert-IsFalse -Condition $result
+
+        # Clear flag sets the flag to $false in config.FeatureFlags
+        $config = Get-Content $configFilePath| ConvertFrom-Json -AsHashtable
+        Assert-IsFalse -Condition $config.FeatureFlags.$ffName
+    }
+}
+
+function Test_RegisteredFeatureFlags_Success{
+
+    $modulename = "kk"
+
+    # Create Module
+    New-ModuleV3 -Name $modulename
+    $fullpath = $modulename | Resolve-Path
+
+    # update module with required code to run featureflags in it
+    Sync-IncludeWithModule -DestinationModulePath $fullpath
+    Get-IncludeFile invokeCommand.helper.ps1 | Add-IncludeToWorkspace -DestinationModulePath $fullpath
+    Get-IncludeFile MyWrite.ps1 | Add-IncludeToWorkspace -DestinationModulePath $fullpath
+    Get-IncludeFile config.ps1 | Add-IncludeToWorkspace -DestinationModulePath $fullpath
+    Get-IncludeFile featureflag.ps1 | Add-IncludeToWorkspace -DestinationModulePath $fullpath
+    Get-IncludeFile module.helper.ps1 | Add-IncludeToWorkspace -DestinationModulePath $fullpath
+
+    # Add a fake Registered featureflags configuration
+    $reg = @{
+        deprecated = @(
+            'ff1'
+            'ff2'
+        )
+    }
+    $reg | ConvertTo-Json | Out-File -FilePath $fullPath/featureflags.json
+
+    # Import module
+    Import-Module -Name $fullpath
+    # Mock config for module kk
+    Mock_Config -ModuleName $modulename -MockPath "kk_config"
+
+    # Set feature flags in the kk config
+    Set-kkFeatureFlag ff1
+    Set-kkFeatureFlag ff2 -Value $false
+    Set-kkFeatureFlag ff3
+
+    # Assert confirm that all 3 flags are set
+    $result = Get-kkFeatureFlags
+    Assert-Count -Expected 3 -Presented $result.Keys
+    Assert-Contains -Expected "ff1" -Presented $result.Keys
+    Assert-Contains -Expected "ff2" -Presented $result.Keys
+    Assert-Contains -Expected "ff3" -Presented $result.Keys
+
+    # Act - Clear registered deprecated featureflags from config
+    Invoke-PrivateContext -ModulePath $fullpath {
+        Clear-FeatureFlagsRegistered
+    }
+
+    # Assert confirm that deprecated flags are removed and ff3 remains
+    $result = Get-kkFeatureFlags
+
+    Assert-Count -Expected 1 -Presented $result.Keys
+    Assert-Contains -Expected "ff3" -Presented $result.Keys
+
+    # Not sure why but if we leave kk loaded it may interfere with other tests
+    # In particular when calling Resolve-SourceDestinationPath, that calls Get-ModuleRootPath, it will resolve to kk module.helper.ps1 code and not IncludeHelper module one
+    # resolving to the kk module path and not IncludeHelper module path.
+    Remove-Module -Name $modulename -Force
+}
+
+function Test_RegisteredFeatureFlags__FFFunction_Success{
+
+    $modulename = "kk"
+
+    # Mock config for module kk
+    Mock_Config -ModuleName $modulename -MockPath "kk_config"
+
+    # Create Module
+    New-ModuleV3 -Name $modulename
+    $fullpath = $modulename | Resolve-Path
+
+    # update module with required code to run featureflags in it
+    Sync-IncludeWithModule -DestinationModulePath $fullpath
+    Get-IncludeFile invokeCommand.helper.ps1 | Add-IncludeToWorkspace -DestinationModulePath $fullpath
+    Get-IncludeFile MyWrite.ps1 | Add-IncludeToWorkspace -DestinationModulePath $fullpath
+    Get-IncludeFile config.ps1 | Add-IncludeToWorkspace -DestinationModulePath $fullpath
+    Get-IncludeFile featureflag.ps1 | Add-IncludeToWorkspace -DestinationModulePath $fullpath
+    Get-IncludeFile module.helper.ps1 | Add-IncludeToWorkspace -DestinationModulePath $fullpath
+
+    $functioncode = @"
+
+function Get-kkString {
+    if(TFF ff){
+        return "ff"
+    } else {
+        return "kk"
+    }
+} Export-ModuleMember -Function Get-kkString
+
+"@
+
+    $functioncode | Out-File -FilePath ./kk/public/getString.ps1
+
+    # Import module
+    Import-Module -Name $fullpath
+
+    Set-kkFeatureFlag ff
+    $result = Get-kkFeatureFlags
+    Assert-IsTrue -Condition $result.ff
+
+    $result = Get-kkString
+    Assert-AreEqual -Expected "ff" -Presented $result
+
+    # Not sure why but if we leave kk loaded it may interfere with other tests
+    # In particular when calling Resolve-SourceDestinationPath, that calls Get-ModuleRootPath, it will resolve to kk module.helper.ps1 code and not IncludeHelper module one
+    # resolving to the kk module path and not IncludeHelper module path.
+    Remove-Module -Name $modulename -Force
+}