Use ntdll instead of sqldk for ordinal tests (#96)

Author: arvindsh

.github/workflows/build.yml

@@ -30,7 +30,7 @@ jobs:
           !Target/Release/*.xml
           !Target/Release/Tests
     - name: Prep for running tests
-      run: ./downloadsyms.ps1 '${{ secrets.SQLDKDLL_URL }}' '${{ secrets.XESPINS_ZIP_URL }}' '${{ secrets.XEWAIT_URL }}'
+      run: ./downloadsyms.ps1
       working-directory: Tests/TestCases
       shell: powershell
     - name: Run tests

.gitignore

@@ -85,8 +85,8 @@ $tf/
 UpgradeLog*.XML
 UpgradeLog*.htm
 Target
-/Tests/TestCases/TestOrdinal/sqldk.dll
-/Tests/TestCases/TestOrdinal/sqldk.zip
+/Tests/TestCases/TestOrdinal/ntdll.dll
+/Tests/TestCases/TestOrdinal/ntdll.pdb
 /Tests/TestCases/ImportXEL/*.xel
 /Tests/TestCases/ImportXEL/*.zip
 /Tests/TestCases/SourceInformation/*.zip

README.md

@@ -47,7 +47,14 @@ When you submit a pull request, a CLA bot will automatically determine whether y
 * If needed, you may also need to manually obtain the current versions of the following files:
     * symsrv.dll and dbghelp.dll (from the x64 / AMD64 Windows Debugger package, part of Windows SDK and many other tools) are used under the terms published [here](https://docs.microsoft.com/en-us/legal/windows-sdk/redist#debugging-tools-for-windows).
     * msdia140.dll and msdia140.dll.manifest are components of Visual Studio 2022 used under the terms as published [here](https://docs.microsoft.com/en-us/visualstudio/releases/2022/redistribution).
-* Tests are implemented using [MSTest v2](https://docs.microsoft.com/en-us/visualstudio/test/mstest-update-to-mstestv2?view=vs-2022#why-upgrade-to-mstestv2). Please try to ensure that tests are passing before submitting a PR. In order to run tests, you will need to run the Tests\TestCases\downloadsyms.ps1 file to gather pre-requisites. Watch for warnings from the script - there are typically 3 files you will need to gather manually (instructions provided in the PowerShell script).
+* Tests are implemented using [MSTest v2](https://docs.microsoft.com/en-us/visualstudio/test/mstest-update-to-mstestv2?view=vs-2022#why-upgrade-to-mstestv2). Please try to ensure that tests are passing before submitting a PR.
+* Prior to running tests, you need to execute the [downloadsyms.ps1](./Tests/TestCases/downloadsyms.ps1) file once as shown below:
+``` cmd
+cd .\SQLCallStackResolver\Tests\TestCases
+powershell < .\downloadsyms.ps1
+```
+  Monitor for any warnings shown by the script and address them if needed.
+
 * When a PR is submitted, there is a GitHub Actions workflow which will build the project and run tests. PRs cannot merge till the workflow succeeds.
 
 # Notes

Tests/TestCases/downloadsyms.ps1

@@ -1,7 +1,6 @@
 # Copyright (c) Microsoft Corporation.
 # Licensed under the MIT License - see LICENSE file in this repo.
 
-param ($sqldkDownloadURL, $spinsXelZipDownloadURL, $waitCompletedXelDownloadUrl)
 $msdlurl = "https://msdl.microsoft.com/download/symbols/"
 $ProgressPreference = "SilentlyContinue"
 
@@ -46,26 +45,24 @@ if (-not (test-path $localpath)) {
     dir $localpath
 }
 
-$localpath = "./TestOrdinal/sqldk.zip"
+$localpath = "./TestOrdinal/ntdll.pdb"
 if (-not (test-path $localpath)) {
-    try {
-        Invoke-WebRequest -UseBasicParsing -uri $sqldkDownloadURL -OutFile $localpath -ErrorAction Ignore
-        Expand-Archive -Path $localpath -DestinationPath "./TestOrdinal"
-        dir "./TestOrdinal"
-    } catch {}
+    Invoke-WebRequest -UseBasicParsing -uri ($msdlurl + "ntdll.pdb/309B7D2A275C49A1917EC6033A73D0ED1/ntdll.pdb") -OutFile $localpath
+    dir $localpath
 }
 
-$localpath = "./TestOrdinal/sqldk.dll"
-if (-not (test-path $localpath))    {
-    Write-Warning "You must manually download CU14 for SQL 2016 SP1 (KB 4488535) and extract the sqldk.dll from that install to TestOrdinal/sqldk.dll"
+$localpath = "./TestOrdinal/ntdll.dll"
+if (-not (test-path $localpath)) {
+    Invoke-WebRequest -UseBasicParsing -uri ($msdlurl + "ntdll.dll/57AE642E1ad000/ntdll.dll") -OutFile $localpath
+    dir "./TestOrdinal"
 }
 
 ### ImportXEL
 mkdir -Force "./ImportXEL" -ErrorAction Ignore
 $localpath = "./ImportXEL/XESpins_0_131627061603030000.xel"
 if (-not (test-path $localpath)) {
     try {
-        Invoke-WebRequest -UseBasicParsing -uri $spinsXelZipDownloadURL -OutFile ($localpath + ".zip") -ErrorAction Ignore
+        Invoke-WebRequest -UseBasicParsing -uri "https://github.com/arvindshmicrosoft/SQLCallStackResolver/raw/main/docs/SQLSat696/Demos/LOCK_HASH/XESpins_0_131627061603030000.zip" -OutFile ($localpath + ".zip") -ErrorAction Ignore
         Expand-Archive -Path ($localpath + ".zip") -DestinationPath "./ImportXEL"
     }
     catch{    }
@@ -79,7 +76,7 @@ if (-not (test-path $localpath)) {
 $localpath = "./ImportXEL/xe_wait_completed_0_132353446563350000.xel"
 if (-not (test-path $localpath)){
     try{
-        Invoke-WebRequest -UseBasicParsing -uri $waitCompletedXelDownloadUrl -OutFile $localpath -ErrorAction Ignore
+        Invoke-WebRequest -UseBasicParsing -uri "https://github.com/arvindshmicrosoft/SQLCallStackResolver/raw/main/docs/SQLSat696/Demos/xe_wait_completed_0_132353446563350000.xel" -OutFile $localpath -ErrorAction Ignore
     }
     catch {}
 

Tests/Tests.cs

@@ -62,8 +62,8 @@ public class Tests {
             using var csr = new StackResolver();
             using var cts = new CancellationTokenSource();
             var dllPaths = new List<string> { Path.GetTempPath(), @"..\..\..\Tests\TestCases\TestOrdinal", Path.GetTempPath() };    // use different paths to validate the multi-path handling
-            var ret = await csr.ResolveCallstacksAsync(await csr.GetListofCallStacksAsync("sqldk!Ordinal298+00000000000004A5\r\n00007FF818405E70      Module(sqldk+0000000000003505) (Ordinal298 + 00000000000004A5)", false, cts), @"..\..\..\Tests\TestCases\TestOrdinal", false, dllPaths, false, false, false, true, false, false, null, cts);
-            Assert.AreEqual("sqldk!SOS_Scheduler::SwitchContext+941\r\nsqldk!SOS_Scheduler::SwitchContext+941", ret.Trim());
+            var ret = await csr.ResolveCallstacksAsync(await csr.GetListofCallStacksAsync("ntdll!Ordinal298+00000000000004A5\r\n00007FF818405E70      Module(ntdll+0000000000091735) (Ordinal298 + 00000000000004A5)", false, cts), @"..\..\..\Tests\TestCases\TestOrdinal", false, dllPaths, false, false, false, true, false, false, null, cts);
+            Assert.AreEqual("ntdll!NtOpenKeyEx+5\r\nntdll!NtOpenKeyEx+5", ret.Trim());
         }
 
         /// Test the resolution of a "regular" symbol with input specifying a hex offset into module.
@@ -720,12 +720,12 @@ private string PrepareLargeXEventInput() {
 
         /// Test for exported symbols
         [TestMethod][TestCategory("Unit")] public void ExportedSymbols() {
-            var ret = ExportedSymbol.GetExports(@"..\..\..\Tests\TestCases\TestOrdinal\sqldk.dll");
-            Assert.AreEqual(931, ret.Count);
-            Assert.AreEqual((uint)1095072, ret[15].Address);
-            Assert.AreEqual((uint)897568, ret[259].Address);
-            Assert.AreEqual((uint)58752, ret[684].Address);
-            Assert.AreEqual((uint)1447120, ret[1161].Address);
+            var ret = ExportedSymbol.GetExports(@"..\..\..\Tests\TestCases\TestOrdinal\ntdll.dll");
+            Assert.AreEqual(2183, ret.Count);
+            Assert.AreEqual((uint)0xd14c0, ret[15].Address);
+            Assert.AreEqual((uint)0x90b30, ret[259].Address);
+            Assert.AreEqual((uint)0x74110, ret[684].Address);
+            Assert.AreEqual((uint)0x19db0, ret[1161].Address);
         }
 
         [TestMethod][TestCategory("Unit")] public async Task IsUrlValid() {