mrva/vscode-codeql
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

Remove some debugging code

Browse Source
This commit is contained in:
Dave Bartolomeo
2023-07-11 14:42:57 -04:00
parent e80a06c5c1
commit d93f2b67c8
10 changed files with 16 additions and 318 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
.github/workflows/main.yml vendored
View File

@@ -273,10 +273,3 @@ jobs:
if: matrix.os == 'windows-latest'
run: |
npm run test:cli-integration
- name: Upload screenshots (Windows)
if: true
uses: actions/upload-artifact@v2
with:
name: screenshots
path: extensions/ql-vscode/*.png

1
extensions/ql-vscode/package.json
View File

@@ -71,6 +71,7 @@
"contributes": {
"configurationDefaults": {
"[ql]": {
"debug.saveBeforeStart": "nonUntitledEditorsInActiveGroup",
"editor.wordBasedSuggestions": false
},
"[dbscheme]": {

275
extensions/ql-vscode/screenshot.bat
View File

@@ -1,275 +0,0 @@
// 2>nul||@goto :batch
/*
:batch
@echo off
setlocal
:: find csc.exe
set "csc="
for /r "%SystemRoot%\Microsoft.NET\Framework\" %%# in ("*csc.exe") do set "csc=%%#"
if not exist "%csc%" (
echo no .net framework installed
exit /b 10
)
if not exist "%~n0.exe" (
call %csc% /nologo /r:"Microsoft.VisualBasic.dll" /out:"%~n0.exe" "%~dpsfnx0" || (
exit /b %errorlevel%
)
)
%~n0.exe %*
endlocal & exit /b %errorlevel%
*/
// reference
// https://gallery.technet.microsoft.com/scriptcenter/eeff544a-f690-4f6b-a586-11eea6fc5eb8
using System;
using System.Runtime.InteropServices;
using System.Drawing;
using System.Drawing.Imaging;
using System.Collections.Generic;
using Microsoft.VisualBasic;
/// Provides functions to capture the entire screen, or a particular window, and save it to a file.
public class ScreenCapture
{
/// Creates an Image object containing a screen shot the active window
public Image CaptureActiveWindow()
{
return CaptureWindow(User32.GetForegroundWindow());
}
/// Creates an Image object containing a screen shot of the entire desktop
public Image CaptureScreen()
{
return CaptureWindow(User32.GetDesktopWindow());
}
/// Creates an Image object containing a screen shot of a specific window
private Image CaptureWindow(IntPtr handle)
{
// get te hDC of the target window
IntPtr hdcSrc = User32.GetWindowDC(handle);
// get the size
User32.RECT windowRect = new User32.RECT();
User32.GetWindowRect(handle, ref windowRect);
int width = windowRect.right - windowRect.left;
int height = windowRect.bottom - windowRect.top;
// create a device context we can copy to
IntPtr hdcDest = GDI32.CreateCompatibleDC(hdcSrc);
// create a bitmap we can copy it to,
// using GetDeviceCaps to get the width/height
IntPtr hBitmap = GDI32.CreateCompatibleBitmap(hdcSrc, width, height);
// select the bitmap object
IntPtr hOld = GDI32.SelectObject(hdcDest, hBitmap);
// bitblt over
GDI32.BitBlt(hdcDest, 0, 0, width, height, hdcSrc, 0, 0, GDI32.SRCCOPY);
// restore selection
GDI32.SelectObject(hdcDest, hOld);
// clean up
GDI32.DeleteDC(hdcDest);
User32.ReleaseDC(handle, hdcSrc);
// get a .NET image object for it
Image img = Image.FromHbitmap(hBitmap);
// free up the Bitmap object
GDI32.DeleteObject(hBitmap);
return img;
}
public void CaptureActiveWindowToFile(string filename, ImageFormat format)
{
Image img = CaptureActiveWindow();
img.Save(filename, format);
}
public void CaptureScreenToFile(string filename, ImageFormat format)
{
Image img = CaptureScreen();
img.Save(filename, format);
}
static bool fullscreen = true;
static String file = "screenshot.bmp";
static System.Drawing.Imaging.ImageFormat format = System.Drawing.Imaging.ImageFormat.Bmp;
static String windowTitle = "";
static void parseArguments()
{
String[] arguments = Environment.GetCommandLineArgs();
if (arguments.Length == 1)
{
printHelp();
Environment.Exit(0);
}
if (arguments[1].ToLower().Equals("/h") || arguments[1].ToLower().Equals("/help"))
{
printHelp();
Environment.Exit(0);
}
file = arguments[1];
Dictionary<String, System.Drawing.Imaging.ImageFormat> formats =
new Dictionary<String, System.Drawing.Imaging.ImageFormat>();
formats.Add("bmp", System.Drawing.Imaging.ImageFormat.Bmp);
formats.Add("emf", System.Drawing.Imaging.ImageFormat.Emf);
formats.Add("exif", System.Drawing.Imaging.ImageFormat.Exif);
formats.Add("jpg", System.Drawing.Imaging.ImageFormat.Jpeg);
formats.Add("jpeg", System.Drawing.Imaging.ImageFormat.Jpeg);
formats.Add("gif", System.Drawing.Imaging.ImageFormat.Gif);
formats.Add("png", System.Drawing.Imaging.ImageFormat.Png);
formats.Add("tiff", System.Drawing.Imaging.ImageFormat.Tiff);
formats.Add("wmf", System.Drawing.Imaging.ImageFormat.Wmf);
String ext = "";
if (file.LastIndexOf('.') > -1)
{
ext = file.ToLower().Substring(file.LastIndexOf('.') + 1, file.Length - file.LastIndexOf('.') - 1);
}
else
{
Console.WriteLine("Invalid file name - no extension");
Environment.Exit(7);
}
try
{
format = formats[ext];
}
catch (Exception e)
{
Console.WriteLine("Probably wrong file format:" + ext);
Console.WriteLine(e.ToString());
Environment.Exit(8);
}
if (arguments.Length > 2)
{
windowTitle = arguments[2];
fullscreen = false;
}
}
static void printHelp()
{
//clears the extension from the script name
String scriptName = Environment.GetCommandLineArgs()[0];
scriptName = scriptName.Substring(0, scriptName.Length);
Console.WriteLine(scriptName + " captures the screen or the active window and saves it to a file.");
Console.WriteLine("");
Console.WriteLine("Usage:");
Console.WriteLine(" " + scriptName + " filename [WindowTitle]");
Console.WriteLine("");
Console.WriteLine("filename - the file where the screen capture will be saved");
Console.WriteLine(" allowed file extensions are - Bmp,Emf,Exif,Gif,Icon,Jpeg,Png,Tiff,Wmf.");
Console.WriteLine("WindowTitle - instead of capture whole screen you can point to a window ");
Console.WriteLine(" with a title which will put on focus and captuted.");
Console.WriteLine(" For WindowTitle you can pass only the first few characters.");
Console.WriteLine(" If don't want to change the current active window pass only \"\"");
}
public static void Main()
{
User32.SetProcessDPIAware();
parseArguments();
ScreenCapture sc = new ScreenCapture();
if (!fullscreen && !windowTitle.Equals(""))
{
try
{
Interaction.AppActivate(windowTitle);
Console.WriteLine("setting " + windowTitle + " on focus");
}
catch (Exception e)
{
Console.WriteLine("Probably there's no window like " + windowTitle);
Console.WriteLine(e.ToString());
Environment.Exit(9);
}
}
try
{
if (fullscreen)
{
Console.WriteLine("Taking a capture of the whole screen to " + file);
sc.CaptureScreenToFile(file, format);
}
else
{
Console.WriteLine("Taking a capture of the active window to " + file);
sc.CaptureActiveWindowToFile(file, format);
}
}
catch (Exception e)
{
Console.WriteLine("Check if file path is valid " + file);
Console.WriteLine(e.ToString());
}
}
/// Helper class containing Gdi32 API functions
private class GDI32
{
public const int SRCCOPY = 0x00CC0020; // BitBlt dwRop parameter
[DllImport("gdi32.dll")]
public static extern bool BitBlt(IntPtr hObject, int nXDest, int nYDest,
int nWidth, int nHeight, IntPtr hObjectSource,
int nXSrc, int nYSrc, int dwRop);
[DllImport("gdi32.dll")]
public static extern IntPtr CreateCompatibleBitmap(IntPtr hDC, int nWidth,
int nHeight);
[DllImport("gdi32.dll")]
public static extern IntPtr CreateCompatibleDC(IntPtr hDC);
[DllImport("gdi32.dll")]
public static extern bool DeleteDC(IntPtr hDC);
[DllImport("gdi32.dll")]
public static extern bool DeleteObject(IntPtr hObject);
[DllImport("gdi32.dll")]
public static extern IntPtr SelectObject(IntPtr hDC, IntPtr hObject);
}
/// Helper class containing User32 API functions
private class User32
{
[StructLayout(LayoutKind.Sequential)]
public struct RECT
{
public int left;
public int top;
public int right;
public int bottom;
}
[DllImport("user32.dll")]
public static extern IntPtr GetDesktopWindow();
[DllImport("user32.dll")]
public static extern IntPtr GetWindowDC(IntPtr hWnd);
[DllImport("user32.dll")]
public static extern IntPtr ReleaseDC(IntPtr hWnd, IntPtr hDC);
[DllImport("user32.dll")]
public static extern IntPtr GetWindowRect(IntPtr hWnd, ref RECT rect);
[DllImport("user32.dll")]
public static extern IntPtr GetForegroundWindow();
[DllImport("user32.dll")]
public static extern int SetProcessDPIAware();
}
}

2
extensions/ql-vscode/src/run-queries-shared.ts
View File

@@ -544,7 +544,7 @@ async function convertToQlPath(filePath: string): Promise<string> {
}
}
}
throw new Error(`Can't convert path to form suitable for QL:${filePath}`);
throw new Error(`Can't convert path to form suitable for QL: ${filePath}`);
} else {
return filePath;
}

5
extensions/ql-vscode/test/vscode-tests/cli-integration/debugger/debugger.test.ts
View File

@@ -153,10 +153,7 @@ describeWithCodeQL()("Debugger", () => {
it("should save dirty documents before launching a debug session", async () => {
await withDebugController(appCommands, async (controller) => {
const editor = await selectForQuickEval(quickEvalLibPath, 4, 15, 4, 32);
await editor.edit((editBuilder) => {
editBuilder.insert(new Position(0, 0), "/* comment */");
});
expect(editor.document.isDirty).toBe(true);
expect(editor.document.isDirty).toBe(false);
await controller.startDebuggingSelection({
query: quickEvalQueryPath, // The query context. This query extends the abstract class.

2
extensions/ql-vscode/test/vscode-tests/cli-integration/jest-runner-vscode.config.js
View File

@@ -7,6 +7,8 @@ const {
rootDir,
} = require("../jest-runner-vscode.config.base");
// Copy the workspace content to a temporary directory, and open it there. Some of our tests write
// to files in the workspace, so we don't want to do that in the source directory.
const tmpDataDir = path.join(tmpDir.name, "data");
fs.cpSync(path.resolve(rootDir, "test/data"), tmpDataDir, {
recursive: true,

2
extensions/ql-vscode/test/vscode-tests/cli-integration/jest.config.ts
View File

@@ -8,7 +8,7 @@ const config: Config = {
setupFilesAfterEnv: ["<rootDir>/jest.setup.ts"],
// CLI integration tests call into the CLI and execute queries, so these are expected to take a lot longer
// than the default 5 seconds.
testTimeout: 300_000, // 3 minutes
testTimeout: 180_000, // 3 minutes
};
export default config;

30
extensions/ql-vscode/test/vscode-tests/cli-integration/queries.test.ts
View File

@@ -3,6 +3,7 @@ import {
ExtensionContext,
Range,
Uri,
window,
workspace,
} from "vscode";
import { join, dirname } from "path";
@@ -46,13 +47,12 @@ import { ProgressCallback } from "../../../src/common/vscode/progress";
import { withDebugController } from "./debugger/debug-controller";
import { getDataFolderFilePath } from "./utils";
import { spawn } from "child-process-promise";
import os from "os";
const simpleQueryPath = getDataFolderFilePath("debugger/simple-query.ql");
type DebugMode = "localQueries" | "debug";
let screenshotCount = 0;
async function compileAndRunQuery(
mode: DebugMode,
appCommands: AppCommandManager,
@@ -97,42 +97,18 @@ async function compileAndRunQuery(
.getConfiguration("debug", { languageId: "codeql" })
.get<string>("saveBeforeStart", "default");
console.log(`Scopeless config: ${scopelessConfig}`);
console.log(`QL config: ${qlConfig}`);
console.log(`CodeQL config: ${codeqlConfig}`);
console.log("Starting debugging");
const start = controller.startDebugging(
await controller.startDebugging(
{
query: queryUri.fsPath,
},
true,
);
let timedOut = false;
const timeout = new Promise<void>((resolve) =>
setTimeout(() => {
timedOut = true;
resolve();
}, 10000),
);
await Promise.race([start, timeout]);
if (timedOut) {
const screenshotPath = `screenshot-${screenshotCount++}.png`;
console.log("Timed out waiting for debug session to start");
await spawn(".\\screenshot.bat", [screenshotPath], {
shell: true,
});
}
console.log("Waiting for launch");
await controller.expectLaunched();
console.log("Checking success");
const succeeded = await controller.expectSucceeded();
await controller.expectExited();
console.log("Terminating");
await controller.expectTerminated();
console.log("Closing session");
await controller.expectSessionClosed();
console.log("Done");
return succeeded.results;
});

7
extensions/ql-vscode/test/vscode-tests/jest-runner-vscode.config.base.js
View File

@@ -1,7 +1,12 @@
const path = require("path");
const os = require("os");
const tmp = require("tmp-promise");
const tmpDir = tmp.dirSync({ unsafeCleanup: true });
// Use the Actions runner temp dir if available, otherwise use the system temp dir
// On Actions runners, we can get into Windows "long path" territory if we use the
// system temp dir.
const overrideTmpDir = process.env.RUNNER_TEMP || os.tmpdir();
const tmpDir = tmp.dirSync({ unsafeCleanup: true, tmpdir: overrideTmpDir });
const rootDir = path.resolve(__dirname, "../..");

3
extensions/ql-vscode/test/vscode-tests/test-config.ts
View File

@@ -157,8 +157,7 @@ const packageConfiguration: Record<
// `debug.saveBeforeStart` is a core VS Code setting, but we depend on its value in these tests.
// We'll set it here to the value that we expect.
"debug.saveBeforeStart": {
// default: "nonUntitledEditorsInActiveGroup",
default: "none",
default: "nonUntitledEditorsInActiveGroup",
},
};
})();