|
| 1 | +module ClientQueryParameterTests |
| 2 | + |
| 3 | +open System |
| 4 | +open System.Collections.Generic |
| 5 | +open System.Threading |
| 6 | +open System.Threading.Tasks |
| 7 | +open Expecto |
| 8 | +open Fossa.Bridge.Models.ApiModels |
| 9 | +open Fossa.Bridge.Services |
| 10 | +open Fossa.Bridge.Services.Clients |
| 11 | + |
| 12 | +type private CapturingTransport() = |
| 13 | + let mutable lastUrl: string | null = null |
| 14 | + |
| 15 | + member _.LastUrl = lastUrl |
| 16 | + |
| 17 | + interface IHttpTransport with |
| 18 | + member _.GetAsync<'TResponse when 'TResponse: not struct and 'TResponse: not null> |
| 19 | + (endpointUrl: string, _endpointSecurity: EndpointSecurity, _cancellationToken: CancellationToken) |
| 20 | + : Task<ClientResult<'TResponse>> = |
| 21 | + lastUrl <- endpointUrl |
| 22 | + |
| 23 | + Task.FromResult( |
| 24 | + { Succeeded = true |
| 25 | + Value = Unchecked.defaultof<'TResponse> |
| 26 | + Problem = null } |
| 27 | + ) |
| 28 | + |
| 29 | + member _.PostAsync<'TRequest when 'TRequest: not null> |
| 30 | + ( |
| 31 | + endpointUrl: string, |
| 32 | + _endpointSecurity: EndpointSecurity, |
| 33 | + _request: 'TRequest, |
| 34 | + _cancellationToken: CancellationToken |
| 35 | + ) : Task<ClientUnitResult> = |
| 36 | + lastUrl <- endpointUrl |
| 37 | + Task.FromResult({ Succeeded = true; Problem = null }) |
| 38 | + |
| 39 | + member _.PutAsync<'TRequest when 'TRequest: not null> |
| 40 | + ( |
| 41 | + endpointUrl: string, |
| 42 | + _endpointSecurity: EndpointSecurity, |
| 43 | + _request: 'TRequest, |
| 44 | + _cancellationToken: CancellationToken |
| 45 | + ) : Task<ClientUnitResult> = |
| 46 | + lastUrl <- endpointUrl |
| 47 | + Task.FromResult({ Succeeded = true; Problem = null }) |
| 48 | + |
| 49 | + member _.PatchAsync<'TRequest when 'TRequest: not null> |
| 50 | + ( |
| 51 | + endpointUrl: string, |
| 52 | + _endpointSecurity: EndpointSecurity, |
| 53 | + _request: 'TRequest, |
| 54 | + _cancellationToken: CancellationToken |
| 55 | + ) : Task<ClientUnitResult> = |
| 56 | + lastUrl <- endpointUrl |
| 57 | + Task.FromResult({ Succeeded = true; Problem = null }) |
| 58 | + |
| 59 | + member _.DeleteAsync |
| 60 | + (endpointUrl: string, _endpointSecurity: EndpointSecurity, _cancellationToken: CancellationToken) |
| 61 | + : Task<ClientUnitResult> = |
| 62 | + lastUrl <- endpointUrl |
| 63 | + Task.FromResult({ Succeeded = true; Problem = null }) |
| 64 | + |
| 65 | +let private idList (values: int64 seq) = |
| 66 | + ResizeArray<int64>(values) :> IReadOnlyList<int64> |
| 67 | + |
| 68 | +let private capturedUrl (transport: CapturingTransport) = |
| 69 | + match transport.LastUrl with |
| 70 | + | null -> failtest "Client should send a request through the transport" |
| 71 | + | url -> url |
| 72 | + |
| 73 | +let private queryPart (url: string) = |
| 74 | + let queryStart = url.IndexOf("?") |
| 75 | + Expect.isGreaterThanOrEqual queryStart 0 "URL should include query parameters" |
| 76 | + url.Substring(queryStart + 1) |
| 77 | + |
| 78 | +let private expectNoPascalCaseQueryNames (url: string) = |
| 79 | + let queryKeys = |
| 80 | + (queryPart url).Split('&') |
| 81 | + |> Array.map (fun parameter -> parameter.Split('=')[0]) |
| 82 | + |
| 83 | + [ "Id"; "Search"; "PageNumber"; "PageSize"; "ReportsToId"; "TopLevelOnly" ] |
| 84 | + |> List.iter (fun key -> Expect.isFalse (Array.contains key queryKeys) $"Query should not contain {key}") |
| 85 | + |
| 86 | +[<Tests>] |
| 87 | +let tests = |
| 88 | + testList |
| 89 | + "ClientQueryParameterTests" |
| 90 | + [ testCase "Branch query uses camelCase query parameter names" |
| 91 | + <| fun _ -> |
| 92 | + let transport = CapturingTransport() |
| 93 | + let client = BranchClient(transport) |
| 94 | + |
| 95 | + client |
| 96 | + .GetBranchesAsync( |
| 97 | + { Id = idList [ 1L; 2L ] |
| 98 | + Search = "north" |
| 99 | + PageNumber = Nullable 3 |
| 100 | + PageSize = Nullable 25 }, |
| 101 | + CancellationToken.None |
| 102 | + ) |
| 103 | + .GetAwaiter() |
| 104 | + .GetResult() |
| 105 | + |> ignore |
| 106 | + |
| 107 | + let url = capturedUrl transport |
| 108 | + |
| 109 | + Expect.equal |
| 110 | + url |
| 111 | + "api/1.0/Branches?id=1&id=2&search=north&pageNumber=3&pageSize=25" |
| 112 | + "Branch query should use camelCase wire names" |
| 113 | + |
| 114 | + expectNoPascalCaseQueryNames url |
| 115 | + |
| 116 | + testCase "Department query uses camelCase query parameter names" |
| 117 | + <| fun _ -> |
| 118 | + let transport = CapturingTransport() |
| 119 | + let client = DepartmentClient(transport) |
| 120 | + |
| 121 | + client |
| 122 | + .GetDepartmentsAsync( |
| 123 | + { Id = idList [ 10L; 20L ] |
| 124 | + Search = "ops" |
| 125 | + PageNumber = Nullable 2 |
| 126 | + PageSize = Nullable 50 }, |
| 127 | + CancellationToken.None |
| 128 | + ) |
| 129 | + .GetAwaiter() |
| 130 | + .GetResult() |
| 131 | + |> ignore |
| 132 | + |
| 133 | + let url = capturedUrl transport |
| 134 | + |
| 135 | + Expect.equal |
| 136 | + url |
| 137 | + "api/1.0/Departments?id=10&id=20&search=ops&pageNumber=2&pageSize=50" |
| 138 | + "Department query should use camelCase wire names" |
| 139 | + |
| 140 | + expectNoPascalCaseQueryNames url |
| 141 | + |
| 142 | + testCase "Employee query uses camelCase query parameter names" |
| 143 | + <| fun _ -> |
| 144 | + let transport = CapturingTransport() |
| 145 | + let client = EmployeeClient(transport) |
| 146 | + |
| 147 | + client |
| 148 | + .GetEmployeesAsync( |
| 149 | + { Id = idList [ 99L ] |
| 150 | + Search = "casey" |
| 151 | + PageNumber = Nullable 4 |
| 152 | + PageSize = Nullable 15 |
| 153 | + ReportsToId = Nullable 7L |
| 154 | + TopLevelOnly = Nullable true }, |
| 155 | + CancellationToken.None |
| 156 | + ) |
| 157 | + .GetAwaiter() |
| 158 | + .GetResult() |
| 159 | + |> ignore |
| 160 | + |
| 161 | + let url = capturedUrl transport |
| 162 | + |
| 163 | + Expect.equal |
| 164 | + url |
| 165 | + "api/1.0/Employees?id=99&search=casey&pageNumber=4&pageSize=15&reportsToId=7&topLevelOnly=true" |
| 166 | + "Employee query should use camelCase wire names" |
| 167 | + |
| 168 | + expectNoPascalCaseQueryNames url |
| 169 | + |
| 170 | + testCase "Employee paging query uses camelCase query parameter names" |
| 171 | + <| fun _ -> |
| 172 | + let transport = CapturingTransport() |
| 173 | + let client = EmployeeClient(transport) |
| 174 | + |
| 175 | + client |
| 176 | + .GetEmployeesPagingAsync( |
| 177 | + { Search = "casey" |
| 178 | + PageNumber = Nullable 5 |
| 179 | + PageSize = Nullable 30 }, |
| 180 | + CancellationToken.None |
| 181 | + ) |
| 182 | + .GetAwaiter() |
| 183 | + .GetResult() |
| 184 | + |> ignore |
| 185 | + |
| 186 | + let url = capturedUrl transport |
| 187 | + |
| 188 | + Expect.equal |
| 189 | + url |
| 190 | + "api/1.0/Employees?search=casey&pageNumber=5&pageSize=30" |
| 191 | + "Employee paging query should use camelCase wire names" |
| 192 | + |
| 193 | + expectNoPascalCaseQueryNames url ] |
0 commit comments