File: MgmtTestLib.ps1

package info (click to toggle)
golang-github-azure-azure-sdk-for-go 68.0.0-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 556,256 kB
  • sloc: javascript: 196; sh: 96; makefile: 7
file content (345 lines) | stat: -rw-r--r-- 11,748 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
#Requires -Version 7.0

$MOCK_SERVER_NAME = "mock-server"
$MOCK_SERVER_DIR = "mock-service-host"
$MOCK_SERVER_READY = "validator initialized"
$MOCK_SERVER_WAIT_TIME = 600
function Invoke-MgmtTestgen ()
{
    param (
        [string]$sdkDirectory = "",
        [switch]$clean,
        [switch]$vet,
        [switch]$generateExample,
        [switch]$generateMockTest,
        [switch]$skipBuild,
        [switch]$cleanGenerated,
        [switch]$format,
        [switch]$tidy,
        [string]$autorestPath = "",
        [string]$config = "autorest.md",
        [string]$autorestVersion = "3.8.2",
        [string]$goExtension = "@autorest/go@4.0.0-preview.41",
        [string]$testExtension = "@autorest/gotest@4.0.1",
        [string]$outputFolder
    )
    if ($clean)
    {
        Write-Host "##[command]Executing go clean -v ./... in " $sdkDirectory
        go clean -v ./...
        if ($LASTEXITCODE) { exit $LASTEXITCODE }
    }

    if ($cleanGenerated)
    {
        Write-Host "##[command]Cleaning auto-generated files in" $sdkDirectory
        Remove-Item "ze_generated_*"
        Remove-Item "zt_generated_*"
    }

    if ($generateExample -or $generateMockTest)
    {
        Write-Host "##[command]Executing autorest.gotest in " $sdkDirectory

        if ($autorestPath -eq "") {
            $autorestPath = "./" + $config
        }
        
        
        if ($outputFolder -eq '')
        {
            $outputFolder = $sdkDirectory
        }
        $exampleFlag = "false"
        if ($generateExample)
        {
            $exampleFlag = "true"
        }
        $mockTestFlag = "true"
        if (-not $generateMockTest)
        {
            $mockTestFlag = "false"
        }
        Write-Host "autorest --version=$autorestVersion --use=$goExtension --use=$testExtension --go --track2 --output-folder=$outputFolder --clear-output-folder=false --go.clear-output-folder=false --generate-sdk=false --testmodeler.generate-mock-test=$mockTestFlag --testmodeler.generate-sdk-example=$exampleFlag $autorestPath"
        npx autorest --version=$autorestVersion --use=$goExtension --use=$testExtension --go --track2 --output-folder=$outputFolder --clear-output-folder=false --go.clear-output-folder=false --generate-sdk=false --testmodeler.generate-mock-test=$mockTestFlag --testmodeler.generate-sdk-example=$exampleFlag $autorestPath
        if ($LASTEXITCODE)
        {
            Write-Host "##[error]Error running autorest.gotest"
            exit $LASTEXITCODE
        }
    }

    if ($format)
    {
        Write-Host "##[command]Executing gofmt -s -w . in " $sdkDirectory
        gofmt -s -w .
        if ($LASTEXITCODE) { exit $LASTEXITCODE }
    }

    if ($tidy)
    {
        Write-Host "##[command]Executing go mod tidy in " $sdkDirectory
        go mod tidy
        if ($LASTEXITCODE) { exit $LASTEXITCODE }
    }

    if (!$skipBuild)
    {
        Write-Host "##[command]Executing go build -x -v ./... in " $sdkDirectory
        go build -x -v ./...
        Write-Host "##[command]Build Complete!"
        if ($LASTEXITCODE) { exit $LASTEXITCODE }
    }

    if ($vet)
    {
        Write-Host "##[command]Executing go vet ./... in " $sdkDirectory
        go vet ./...
    }
}

. (Join-Path $PSScriptRoot .. common scripts common.ps1)

function PrepareMockServer()
{
    # install mock server
    $folder = Join-Path $env:TEMP "$MOCK_SERVER_DIR"
    StopMockServer
    try
    {
        Remove-Item -Recurse -Force -Path $folder
    }
    catch
    {
        Write-Host "Mock service host folder: $folder not existed"
    }
    New-Item -ItemType Directory -Force -Path $folder
    Set-Location $folder
    npm install @azure-tools/mock-service-host
}

function StartMockServer()
{
    param(
        [string]$specDir = "",
        [string]$rpSDKFolder,
        [string]$autorestConfigFile = "autorest.md"
    )
    $folder = Join-Path $env:TEMP  "$MOCK_SERVER_DIR"
    Set-Location $folder

    # change .env file to use the specific swagger file
    $envFile = Join-Path $folder .env
    $swaggerInfo = GetSwaggerInfo -specDir $specDir -rpSDKFolder $rpSDKFolder -autorestConfigFile $autorestConfigFile
    New-Item -Path $envFile -ItemType File -Value '' -Force

    $swaggerPath = $swaggerInfo.path
    $specName = $swaggerInfo.specName
    if ($swaggerInfo.isRepoUrl -eq $true) {
        Add-Content $envFile "specRetrievalGitUrl=$swaggerPath"
        if ([string]::IsNullOrEmpty($swaggerInfo.branch) -eq $false) {
            Add-Content $envFile "specRetrievalGitBranch=$($swaggerInfo.branch)"
        }
        if ([string]::IsNullOrEmpty($swaggerInfo.commitID) -eq $false) {
            Add-Content $envFile "specRetrievalGitCommitID=$($swaggerInfo.commitID)"
        }
        Add-Content $envFile "validationPathsPattern=specification/$specName/resource-manager/**/*.json"
    } else {
        Write-Host "start Mock Test from local swagger"
        Add-Content $envFile "specRetrievalMethod=filesystem
specRetrievalLocalRelativePath=$swaggerPath
validationPathsPattern=$swaggerPath/*/resource-manager/**/*.json"
    }

    # start mock server and check status
    Start-Job -Name $MOCK_SERVER_NAME -ScriptBlock { node node_modules/@azure-tools/mock-service-host/dist/src/main.js 2>&1 }
    $output = Receive-Job $MOCK_SERVER_NAME
    Write-Host "Mock sever status: `n $("$output")"
    $time = 0
    try
    {
        while ("$output" -notmatch $MOCK_SERVER_READY)
        {
            if ($time -gt $MOCK_SERVER_WAIT_TIME)
            {
                Write-Host "##[error] mock server start timeout"
                StopMockServer
                exit 1
            }
            Write-Host "Server not ready, wait for annother 10 seconds"
            $time += 10
            Start-Sleep -Seconds 10
            $output = Receive-Job $MOCK_SERVER_NAME
            Write-Host "Mock sever status: `n $("$output")"
        }
    }
    catch
    {
        Write-Host "##[error]wait for mock server start:`n$_"
        exit 1
    }
}

function StopMockServer()
{
    try
    {
        Stop-Job -Name $MOCK_SERVER_NAME
    }
    catch
    {
        Write-Host "##[error]can not stop mock server:`n$_"
    }
}

function GetSwaggerInfo() {
    param(
        [string]$specDir = "",
        [string]$rpSDKFolder,
        [string]$autorestConfigFile = "autorest.md"
    )

    if ([string]::IsNullOrEmpty($rpSDKFolder))
    {
        if ([string]::IsNullOrEmpty($specDir)) {
            $swaggerInfo = [PSCustomObject]@{
                isRepoUrl = $true
                path = "https://github.com/Azure/azure-rest-api-specs"
                specName = "*"
                org = "Azure"
                branch = "main"
                commitID = ""
            }
        } else {
            $swaggerInfo = [PSCustomObject]@{
                isRepoUrl = $false
                path = $specDir
                specName = "*"
                org = ""
                branch = ""
                commitID = ""
            }
        }
    } else {
        $file="$rpSDKFolder/$autorestConfigFile"
        $readmefile = (Select-String -Path $file -Pattern ".*readme.md" | ForEach-Object {$_.Matches.Value}) -replace "require *:|- ", ""
        if ([string]::IsNullOrEmpty($readmefile)) {
            Write-Host "Cannot get swagger info"
            exit 1
        }
        $readmefile = $readmefile -replace "\\", "/"
        
        $isRepoUrl = $false
        $path = ""
        $specName = ""
        $org = ""
        $branch = ""
        $commitID = ""
        $readmefile = $readmefile.Trim()

        if ($readmefile.StartsWith("http")) {
            $isRepoUrl = $true
        }
        if ($isRepoUrl -eq $true) {
            $swaggerInfoRegex = ".*github.*.com\/(?<org>.*)\/azure-rest-api-specs\/blob\/(?<commitID>[0-9a-f]{40})\/specification\/(?<specName>.*)\/resource-manager\/readme.md"
            $rawSwaggerInfoRegex = ".*github.*.com\/(?<org>.*)\/azure-rest-api-specs\/(?<commitID>[0-9a-f]{40})\/specification\/(?<specName>.*)\/resource-manager\/readme.md"
            $swaggerNoCommitRegex = ".*github.*.com\/(?<org>.*)\/azure-rest-api-specs\/(blob\/)?(?<branch>.*)\/specification\/(?<specName>.*)\/resource-manager\/readme.md"
            try
            {
                if ($readmefile -match $swaggerInfoRegex)
                {
                    $org = $matches["org"]
                    $specName = $matches["specName"]
                    $commitID = $matches["commitID"]
                    $path = "https://github.com/$org/azure-rest-api-specs"
                } elseif ($readmefile -match $rawSwaggerInfoRegex)
                {
                    $org = $matches["org"]
                    $specName = $matches["specName"]
                    $commitID = $matches["commitID"]
                    $path = "https://github.com/$org/azure-rest-api-specs"
                }elseif ($readmefile -match $swaggerNoCommitRegex)
                {
                    $org = $matches["org"]
                    $specName = $matches["specName"]
                    $branch = $matches["branch"]
                    $path = "https://github.com/$org/azure-rest-api-specs"
                }
            }
            catch
            {
                Write-Error "Error parsing swagger info"
                Write-Error $_
            }
        } else {
            $paths = $readmefile.split("/");
            $len = $paths.count
            if ($len -gt 2) {
                $specName = $paths[$len - 3]
                $path = ($paths[0..($len - 4)]) -join "/"
            }
        }
        
        $swaggerInfo = [PSCustomObject]@{
            isRepoUrl = $isRepoUrl
            path = $path
            specName = $specName
            org = $org
            branch = $branch
            commitID = $commitID
        }
    }

    return $swaggerInfo
}

function TestAndGenerateReport($dir)
{
    Set-Location $dir
    # dependencies for go coverage report generation
    go install github.com/jstemmer/go-junit-report@v0.9.1
    go install github.com/axw/gocov/gocov@v1.1.0
    go install github.com/AlekSi/gocov-xml@v1.0.0
    go install github.com/matm/gocov-html@v0.0.0-20200509184451-71874e2e203b

    # set azidentity env for mock test
    $Env:AZURE_TENANT_ID = "mock-test"
    $Env:AZURE_CLIENT_ID = "mock-test"
    $Env:AZURE_USERNAME = "mock-test"
    $Env:AZURE_PASSWORD = "mock-test"

    # do test with corage report and convert to cobertura format
    Write-Host "go cmd: go test -v -coverprofile coverage.txt | Tee-Object -FilePath outfile.txt"
    go test -v -coverprofile coverage.txt -run TestMockTest | Tee-Object -FilePath outfile.txt
    Write-Host "report.xml: Get-Content outfile.txt | go-junit-report > report.xml"
    Get-Content outfile.txt | go-junit-report > report.xml
    Write-Host "coverage.json: gocov convert ./coverage.txt > ./coverage.json"
    gocov convert ./coverage.txt > ./coverage.json
    Write-Host "coverage.xml: Get-Content ./coverage.json | gocov-xml > ./coverage.xml"
    Get-Content ./coverage.json | gocov-xml > ./coverage.xml
    Write-Host "coverage.html: Get-Content ./coverage.json | gocov-html > ./coverage.html"
    Get-Content ./coverage.json | gocov-html > ./coverage.html
}

function JudgeExitCode($errorMsg = "execution error")
{
    if (!$?)
    {
        Write-Host "##[error] $errorMsg"
        exit $LASTEXITCODE
    }
}

function ExecuteSingleTest($sdk, $needRunMockServer=$true)
{
    Write-Host "Start mock server"
    if ($needRunMockServer -eq $true) {
        StartMockServer -rpSDKFolder $sdk.DirectoryPath
    }
    Write-Host "Execute mock test for $($sdk.Name)"
    TestAndGenerateReport $sdk.DirectoryPath
    Write-Host "Stop mock server"
    if ($needRunMockServer -eq $true) {
        StopMockServer
    }
}