Middleware.Tests.ps1

$path = $MyInvocation.MyCommand.Path
$src = (Split-Path -Parent -Path $path) -ireplace '[\\/]tests[\\/]unit[\\/]', '/src/'
Get-ChildItem "$($src)/*.ps1" | Resolve-Path | ForEach-Object { . $_ }

Describe 'Get-PodeInbuiltMiddleware' {
    Context 'Invalid parameters supplied' {
        It 'Throws null name parameter error' {
            { Get-PodeInbuiltMiddleware -Name $null -ScriptBlock {} } | Should Throw 'null or empty'
        }

        It 'Throws empty name parameter error' {
            { Get-PodeInbuiltMiddleware -Name ([string]::Empty) -ScriptBlock {} } | Should Throw 'null or empty'
        }

        It 'Throws null logic error' {
            { Get-PodeInbuiltMiddleware -Name 'test' -ScriptBlock $null } | Should Throw 'argument is null'
        }
    }

    Context 'Valid parameters' {
        It 'using default inbuilt logic' {
            $PodeContext = @{ 'Server' = @{ 'Middleware' = @(
                @{ 'Name' = $null; 'Logic' = { write-host 'pre1' } }
            ); }; }

            $logic = Get-PodeInbuiltMiddleware -Name '@access' -ScriptBlock { write-host 'in1' }

            $logic | Should Not Be $null
            $logic.Name | Should Be '@access'
            $logic.Logic.ToString() | Should Be ({ write-host 'in1' }).ToString()

            $PodeContext.Server.Middleware.Length | Should Be 1
            $PodeContext.Server.Middleware[0].Logic | Should Be ({ write-host 'pre1' }).ToString()
        }

        It 'using default override logic' {
            $PodeContext = @{ 'Server' = @{ 'Middleware' = @(
                @{ 'Name' = $null; 'Logic' = { write-host 'pre1' } };
                @{ 'Name' = '@access'; 'Logic' = { write-host 'over1' } }
            ); }; }

            $logic = Get-PodeInbuiltMiddleware -Name '@access' -ScriptBlock { write-host 'in1' }

            $logic | Should Not Be $null
            $logic.Name | Should Be '@access'
            $logic.Logic.ToString() | Should Be ({ write-host 'over1' }).ToString()

            $PodeContext.Server.Middleware.Length | Should Be 1
            $PodeContext.Server.Middleware[0].Logic | Should Be ({ write-host 'pre1' }).ToString()
        }
    }
}

Describe 'Middleware' {
    Context 'Invalid parameters supplied' {
        It 'Throws null script logic error' {
            { Middleware -ScriptBlock $null } | Should Throw 'argument is null'
        }

        It 'Throws null hash logic error' {
            { Middleware -HashTable $null } | Should Throw 'because it is null'
        }
    }

    Context 'Valid parameters' {
        It 'Adds single middleware script to list' {
            $PodeContext = @{ 'Server' = @{ 'Middleware' = @(); }; }

            Middleware -ScriptBlock { write-host 'middle1' }

            $PodeContext.Server.Middleware.Length | Should Be 1
            $PodeContext.Server.Middleware[0].Logic.ToString() | Should Be ({ Write-Host 'middle1' }).ToString()
        }

        It 'Adds single middleware script to list with route' {
            $PodeContext = @{ 'Server' = @{ 'Middleware' = @(); }; }

            Middleware -Route '/api' -ScriptBlock { write-host 'middle1' }

            $PodeContext.Server.Middleware.Length | Should Be 1
            $PodeContext.Server.Middleware[0].Logic.ToString() | Should Be ({ Write-Host 'middle1' }).ToString()
            $PodeContext.Server.Middleware[0].Route | Should Be '/api'
        }

        It 'Adds single middleware script to list with route and return' {
            $PodeContext = @{ 'Server' = @{ 'Middleware' = @(); }; }

            $result = (Middleware -Route '/api' -ScriptBlock { write-host 'middle1' } -Return)

            $PodeContext.Server.Middleware.Length | Should Be 0
            $result.Logic.ToString() | Should Be ({ Write-Host 'middle1' }).ToString()
            $result.Route | Should Be '/api'
        }

        It 'Adds two middleware scripts to list' {
            $PodeContext = @{ 'Server' = @{ 'Middleware' = @(); }; }

            Middleware -ScriptBlock { write-host 'middle1' }
            Middleware -ScriptBlock { write-host 'middle2' }

            $PodeContext.Server.Middleware.Length | Should Be 2
            $PodeContext.Server.Middleware[0].Logic.ToString() | Should Be ({ Write-Host 'middle1' }).ToString()
            $PodeContext.Server.Middleware[1].Logic.ToString() | Should Be ({ Write-Host 'middle2' }).ToString()
        }

        It 'Adds middleware script to override inbuilt ones' {
            $PodeContext = @{ 'Server' = @{ 'Middleware' = @(); }; }

            Middleware -ScriptBlock { write-host 'middle1' } -Name '@access'

            $PodeContext.Server.Middleware.Length | Should Be 1
            $PodeContext.Server.Middleware[0].Logic.ToString() | Should Be ({ Write-Host 'middle1' }).ToString()
            $PodeContext.Server.Middleware[0].Name | Should Be '@access'
        }

        It 'Throws error when adding middleware script with duplicate name' {
            $PodeContext = @{ 'Server' = @{ 'Middleware' = @(); }; }

            Middleware -ScriptBlock { write-host 'middle1' } -Name '@access'
            { Middleware -ScriptBlock { write-host 'middle2' } -Name '@access' } | Should Throw 'already exists'
        }

        It 'Throws error when adding middleware hash with no logic' {
            { Middleware -HashTable @{ 'Rand' = { write-host 'middle1' } } } | Should Throw 'has no logic'
        }

        It 'Adds single middleware hash to list' {
            $PodeContext = @{ 'Server' = @{ 'Middleware' = @(); }; }

            Middleware -HashTable @{ 'Logic' = { write-host 'middle1' } }

            $PodeContext.Server.Middleware.Length | Should Be 1
            $PodeContext.Server.Middleware[0].Logic.ToString() | Should Be ({ Write-Host 'middle1' }).ToString()
        }

        It 'Adds single middleware hash to list with route' {
            $PodeContext = @{ 'Server' = @{ 'Middleware' = @(); }; }

            Middleware -Route '/api' -HashTable @{ 'Logic' = { write-host 'middle1' } }

            $PodeContext.Server.Middleware.Length | Should Be 1
            $PodeContext.Server.Middleware[0].Logic.ToString() | Should Be ({ Write-Host 'middle1' }).ToString()
            $PodeContext.Server.Middleware[0].Route | Should Be '/api'
        }

        It 'Adds single middleware hash to list with route and return' {
            $PodeContext = @{ 'Server' = @{ 'Middleware' = @(); }; }

            $result = (Middleware -Route '/api' -HashTable @{ 'Logic' = { write-host 'middle1' } } -Return)

            $PodeContext.Server.Middleware.Length | Should Be 0
            $result.Logic.ToString() | Should Be ({ Write-Host 'middle1' }).ToString()
            $result.Route | Should Be '/api'
        }

        It 'Adds two middleware hashs to list' {
            $PodeContext = @{ 'Server' = @{ 'Middleware' = @(); }; }

            Middleware -HashTable @{ 'Logic' = { write-host 'middle1' } }
            Middleware -HashTable @{ 'Logic' = { write-host 'middle2' } }

            $PodeContext.Server.Middleware.Length | Should Be 2
            $PodeContext.Server.Middleware[0].Logic.ToString() | Should Be ({ Write-Host 'middle1' }).ToString()
            $PodeContext.Server.Middleware[1].Logic.ToString() | Should Be ({ Write-Host 'middle2' }).ToString()
        }

        It 'Adds middleware hash to override inbuilt ones' {
            $PodeContext = @{ 'Server' = @{ 'Middleware' = @(); }; }

            Middleware -HashTable @{ 'Logic' = { write-host 'middle1' } } -Name '@access'

            $PodeContext.Server.Middleware.Length | Should Be 1
            $PodeContext.Server.Middleware[0].Logic.ToString() | Should Be ({ Write-Host 'middle1' }).ToString()
            $PodeContext.Server.Middleware[0].Name | Should Be '@access'
        }

        It 'Throws error when adding middleware hash with duplicate name' {
            $PodeContext = @{ 'Server' = @{ 'Middleware' = @(); }; }

            Middleware -HashTable @{ 'Logic' = { write-host 'middle1' } } -Name '@access'
            { Middleware -HashTable @{ 'Logic' = { write-host 'middle2' } } -Name '@access' } | Should Throw 'already exists'
        }
    }
}

Describe 'Invoke-PodeMiddleware' {
    It 'Returns true for no middleware' {
        (Invoke-PodeMiddleware -WebEvent @{} -Middleware @()) | Should Be $true
    }

    It 'Runs the logic for a single middleware and returns true' {
        Mock Invoke-ScriptBlock { return $true }
        $WebEvent = @{ 'Middleware' = @{} }
        $midware = @{
            'Options' = @{};
            'Logic' = { 'test' | Out-Null };
        }

        Invoke-PodeMiddleware -WebEvent $WebEvent -Middleware @($midware) | Should Be $true

        Assert-MockCalled Invoke-ScriptBlock -Times 1 -Scope It
    }

    It 'Runs the logic for a single middleware mapped to a route' {
        Mock Invoke-ScriptBlock { return $true }
        $WebEvent = @{ 'Middleware' = @{} }
        $midware = @{
            'Options' = @{};
            'Route' = '/';
            'Logic' = { 'test' | Out-Null };
        }

        Invoke-PodeMiddleware -WebEvent $WebEvent -Middleware @($midware) -Route '/' | Should Be $true

        Assert-MockCalled Invoke-ScriptBlock -Times 1 -Scope It
    }

    It 'Runs the logic for two middlewares and returns true' {
        Mock Invoke-ScriptBlock { return $true }
        $WebEvent = @{ 'Middleware' = @{} }

        $midware1 = @{
            'Options' = @{};
            'Logic' = { 'test' | Out-Null };
        }

        $midware2 = @{
            'Options' = @{};
            'Logic' = { 'test2' | Out-Null };
        }

        Invoke-PodeMiddleware -WebEvent $WebEvent -Middleware @($midware1, $midware2) | Should Be $true

        Assert-MockCalled Invoke-ScriptBlock -Times 2 -Scope It
    }

    It 'Runs the logic for a single middleware and returns false' {
        Mock Invoke-ScriptBlock { return $false }
        $WebEvent = @{ 'Middleware' = @{} }
        $midware = @{
            'Options' = @{};
            'Logic' = { 'test' | Out-Null };
        }

        Invoke-PodeMiddleware -WebEvent $WebEvent -Middleware @($midware) | Should Be $false

        Assert-MockCalled Invoke-ScriptBlock -Times 1 -Scope It
    }

    It 'Runs the logic for a single middleware and returns false after erroring' {
        Mock Invoke-ScriptBlock { throw 'some error' }
        Mock Out-Default { }
        Mock Status { }

        $WebEvent = @{ 'Middleware' = @{} }
        $midware = @{
            'Options' = @{};
            'Logic' = { 'test' | Out-Null };
        }

        Invoke-PodeMiddleware -WebEvent $WebEvent -Middleware @($midware) | Should Be $false

        Assert-MockCalled Invoke-ScriptBlock -Times 1 -Scope It
        Assert-MockCalled Status -Times 1 -Scope It
    }
}

Describe 'Get-PodeAccessMiddleware' {
    Mock Get-PodeInbuiltMiddleware { return @{
        'Name' = $Name;
        'Logic' = $ScriptBlock;
    } }

    It 'Returns a ScriptBlock and invokes it as true' {
        $r = Get-PodeAccessMiddleware
        $r.Name | Should Be '@access'
        $r.Logic | Should Not Be $null

        Mock Test-PodeIPAccess { return $true }
        (. $r.Logic @{
            'Request' = @{ 'RemoteEndPoint' = @{ 'Address' = 'localhost' } }
        }) | Should Be $true
    }

    It 'Returns a ScriptBlock and invokes it as false' {
        $r = Get-PodeAccessMiddleware
        $r.Name | Should Be '@access'
        $r.Logic | Should Not Be $null

        Mock Test-PodeIPAccess { return $false }
        Mock Status { }
        (. $r.Logic @{
            'Request' = @{ 'RemoteEndPoint' = @{ 'Address' = 'localhost' } }
        }) | Should Be $false
    }
}

Describe 'Get-PodeLimitMiddleware' {
    Mock Get-PodeInbuiltMiddleware { return @{
        'Name' = $Name;
        'Logic' = $ScriptBlock;
    } }

    It 'Returns a ScriptBlock and invokes it as true' {
        $r = Get-PodeLimitMiddleware
        $r.Name | Should Be '@limit'
        $r.Logic | Should Not Be $null

        Mock Test-PodeIPLimit { return $true }
        (. $r.Logic @{
            'Request' = @{ 'RemoteEndPoint' = @{ 'Address' = 'localhost' } }
        }) | Should Be $true
    }

    It 'Returns a ScriptBlock and invokes it as false' {
        $r = Get-PodeLimitMiddleware
        $r.Name | Should Be '@limit'
        $r.Logic | Should Not Be $null

        Mock Test-PodeIPLimit { return $false }
        Mock Status { }
        (. $r.Logic @{
            'Request' = @{ 'RemoteEndPoint' = @{ 'Address' = 'localhost' } }
        }) | Should Be $false
    }
}

Describe 'Get-PodeRouteValidateMiddleware' {
    Mock Get-PodeInbuiltMiddleware { return @{
        'Name' = $Name;
        'Logic' = $ScriptBlock;
    } }

    It 'Returns a ScriptBlock and invokes it as true' {
        $WebEvent = @{ 'Parameters' = @{} }

        $r = Get-PodeRouteValidateMiddleware
        $r.Name | Should Be '@route-valid'
        $r.Logic | Should Not Be $null

        Mock Get-PodeRoute { return @{ 'Parameters' = @{}; 'Logic' = { Write-Host 'hello' }; } }
        (. $r.Logic @{
            'Method' = 'GET';
            'Path' = '/';
        }) | Should Be $true
    }

    It 'Returns a ScriptBlock and invokes it as true, overriding the content type' {
        $WebEvent = @{ 'Parameters' = @{}; 'ContentType' = 'text/plain' }

        $r = Get-PodeRouteValidateMiddleware
        $r.Name | Should Be '@route-valid'
        $r.Logic | Should Not Be $null

        Mock Get-PodeRoute { return @{
            'Parameters' = @{};
            'Logic' = { Write-Host 'hello' };
            'ContentType' = 'application/json';
        } }

        (. $r.Logic @{
            'Method' = 'GET';
            'Path' = '/';
        }) | Should Be $true

        $WebEvent.ContentType | Should Be 'application/json'
    }

    It 'Returns a ScriptBlock and invokes it as false' {
        $r = Get-PodeRouteValidateMiddleware
        $r.Name | Should Be '@route-valid'
        $r.Logic | Should Not Be $null

        Mock Get-PodeRoute { return $null }
        Mock Status { }
        (. $r.Logic @{
            'Method' = 'GET';
            'Path' = '/';
        }) | Should Be $false
    }
}

Describe 'Get-PodeBodyMiddleware' {
    Mock Get-PodeInbuiltMiddleware { return @{
        'Name' = $Name;
        'Logic' = $ScriptBlock;
    } }

    It 'Returns a ScriptBlock and invokes it as true' {
        $r = Get-PodeBodyMiddleware
        $r.Name | Should Be '@body'
        $r.Logic | Should Not Be $null

        Mock ConvertFrom-PodeRequestContent { return @{ 'Data' = @{}; 'Files' = @{}; } }
        (. $r.Logic @{
            'Request' = 'value'
        }) | Should Be $true
    }

    It 'Returns a ScriptBlock and invokes it as false' {
        $r = Get-PodeBodyMiddleware
        $r.Name | Should Be '@body'
        $r.Logic | Should Not Be $null

        Mock ConvertFrom-PodeRequestContent { throw 'error' }
        Mock Status { }
        (. $r.Logic @{
            'Request' = 'value'
        }) | Should Be $false
    }
}

Describe 'Get-PodeQueryMiddleware' {
    Mock Get-PodeInbuiltMiddleware { return @{
        'Name' = $Name;
        'Logic' = $ScriptBlock;
    } }

    It 'Returns a ScriptBlock and invokes it as true' {
        $r = Get-PodeQueryMiddleware
        $r.Name | Should Be '@query'
        $r.Logic | Should Not Be $null

        Mock ConvertFrom-PodeNameValueToHashTable { return 'string' }
        (. $r.Logic @{
            'Request' = @{ 'QueryString' = 'name=bob' }
        }) | Should Be $true
    }

    It 'Returns a ScriptBlock and invokes it as false' {
        $r = Get-PodeQueryMiddleware
        $r.Name | Should Be '@query'
        $r.Logic | Should Not Be $null

        Mock ConvertFrom-PodeNameValueToHashTable { throw 'error' }
        Mock Status { }
        (. $r.Logic @{
            'Request' = @{ 'QueryString' = 'name=bob' }
        }) | Should Be $false
    }
}

Describe 'Get-PodePublicMiddleware' {
    Mock Get-PodeInbuiltMiddleware { return @{
        'Name' = $Name;
        'Logic' = $ScriptBlock;
    } }

    It 'Returns a ScriptBlock, invokes true for no static path' {
        $r = Get-PodePublicMiddleware
        $r.Name | Should Be '@public'
        $r.Logic | Should Not Be $null

        Mock Get-PodeStaticRoutePath { return @{ 'Path' = $null } }
        (. $r.Logic @{
            'Path' = '/'; 'Protocol' = 'http'; 'Endpoint' = '';
        }) | Should Be $true
    }

    It 'Returns a ScriptBlock, invokes false for static path, with no caching' {
        $r = Get-PodePublicMiddleware
        $r.Name | Should Be '@public'
        $r.Logic | Should Not Be $null

        $PodeContext = @{ 'Server' = @{
            'Web' = @{ 'Static' = @{
                'Cache' = @{
                    'Enabled' = $false
                }
            }}
        }}

        Mock Get-PodeStaticRoutePath { return @{ 'Path' = '/' } }
        Mock File { }
        (. $r.Logic @{
            'Path' = '/'; 'Protocol' = 'http'; 'Endpoint' = '';
        }) | Should Be $false
    }

    It 'Returns a ScriptBlock, invokes false for static path, with no caching from exclude' {
        $r = Get-PodePublicMiddleware
        $r.Name | Should Be '@public'
        $r.Logic | Should Not Be $null

        $PodeContext = @{ 'Server' = @{
            'Web' = @{ 'Static' = @{
                'Cache' = @{
                    'Enabled' = $true;
                    'Exclude' = '/'
                }
            }}
        }}

        Mock Get-PodeStaticRoutePath { return @{ 'Path' = '/' } }
        Mock File { }
        (. $r.Logic @{
            'Path' = '/'; 'Protocol' = 'http'; 'Endpoint' = '';
        }) | Should Be $false
    }

    It 'Returns a ScriptBlock, invokes false for static path, with no caching from include' {
        $r = Get-PodePublicMiddleware
        $r.Name | Should Be '@public'
        $r.Logic | Should Not Be $null

        $PodeContext = @{ 'Server' = @{
            'Web' = @{ 'Static' = @{
                'Cache' = @{
                    'Enabled' = $true;
                    'Include' = '/route'
                }
            }}
        }}

        Mock Get-PodeStaticRoutePath { return @{ 'Path' = '/' } }
        Mock File { }
        (. $r.Logic @{
            'Path' = '/'; 'Protocol' = 'http'; 'Endpoint' = '';
        }) | Should Be $false
    }

    It 'Returns a ScriptBlock, invokes false for static path, with caching' {
        $r = Get-PodePublicMiddleware
        $r.Name | Should Be '@public'
        $r.Logic | Should Not Be $null

        $PodeContext = @{ 'Server' = @{
            'Web' = @{ 'Static' = @{
                'Cache' = @{
                    'Enabled' = $true;
                }
            }}
        }}

        Mock Get-PodeStaticRoutePath { return @{ 'Path' = '/' } }
        Mock File { }
        (. $r.Logic @{
            'Path' = '/'; 'Protocol' = 'http'; 'Endpoint' = '';
        }) | Should Be $false
    }
}